2 Unix SMB/CIFS implementation.
3 session handling for utmp and PAM
5 Copyright (C) tridge@samba.org 2001
6 Copyright (C) abartlet@samba.org 2001
7 Copyright (C) Gerald (Jerry) Carter 2006
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 /* a "session" is claimed when we do a SessionSetupX operation
24 and is yielded when the corresponding vuid is destroyed.
26 sessions are used to populate utmp and PAM session structures
30 #include "smbd/globals.h"
32 /********************************************************************
33 ********************************************************************/
35 static struct db_context *session_db_ctx(void)
37 if (session_db_ctx_ptr)
38 return session_db_ctx_ptr;
40 session_db_ctx_ptr = db_open(NULL, lock_path("sessionid.tdb"), 0,
41 TDB_CLEAR_IF_FIRST|TDB_INCOMPATIBLE_HASH|TDB_DEFAULT,
42 O_RDWR | O_CREAT, 0644);
43 return session_db_ctx_ptr;
46 bool session_init(void)
48 if (session_db_ctx() == NULL) {
49 DEBUG(1,("session_init: failed to open sessionid tdb\n"));
56 /********************************************************************
57 called when a session is created
58 ********************************************************************/
60 bool session_claim(user_struct *vuser)
64 struct sessionid sessionid;
65 struct server_id pid = procid_self();
67 const char * hostname;
68 struct db_context *ctx;
69 struct db_record *rec;
71 char addr[INET6_ADDRSTRLEN];
73 vuser->session_keystr = NULL;
75 /* don't register sessions for the guest user - its just too
76 expensive to go through pam session code for browsing etc */
77 if (vuser->server_info->guest) {
81 if (!(ctx = session_db_ctx())) {
85 ZERO_STRUCT(sessionid);
92 for (i=1;i<MAX_SESSION_ID;i++) {
95 * This is very inefficient and needs fixing -- vl
98 struct server_id sess_pid;
100 snprintf(keystr, sizeof(keystr), "ID/%d", i);
101 key = string_term_tdb_data(keystr);
103 rec = ctx->fetch_locked(ctx, NULL, key);
106 DEBUG(1, ("Could not lock \"%s\"\n", keystr));
110 if (rec->value.dsize != sizeof(sessionid)) {
111 DEBUG(1, ("Re-using invalid record\n"));
116 ((char *)rec->value.dptr)
117 + offsetof(struct sessionid, pid),
120 if (!process_exists(sess_pid)) {
121 DEBUG(5, ("%s has died -- re-using session\n",
122 procid_str_static(&sess_pid)));
129 if (i == MAX_SESSION_ID) {
130 SMB_ASSERT(rec == NULL);
131 DEBUG(1,("session_claim: out of session IDs "
132 "(max is %d)\n", MAX_SESSION_ID));
136 snprintf(sessionid.id_str, sizeof(sessionid.id_str),
137 SESSION_UTMP_TEMPLATE, i);
140 snprintf(keystr, sizeof(keystr), "ID/%s/%u",
141 procid_str_static(&pid), vuser->vuid);
142 key = string_term_tdb_data(keystr);
144 rec = ctx->fetch_locked(ctx, NULL, key);
147 DEBUG(1, ("Could not lock \"%s\"\n", keystr));
151 snprintf(sessionid.id_str, sizeof(sessionid.id_str),
152 SESSION_TEMPLATE, (long unsigned int)sys_getpid(),
156 SMB_ASSERT(rec != NULL);
158 /* If 'hostname lookup' == yes, then do the DNS lookup. This is
159 needed because utmp and PAM both expect DNS names
161 client_name() handles this case internally.
164 hostname = client_name(get_client_fd());
165 if (strcmp(hostname, "UNKNOWN") == 0) {
166 hostname = client_addr(get_client_fd(),addr,sizeof(addr));
169 fstrcpy(sessionid.username, vuser->server_info->unix_name);
170 fstrcpy(sessionid.hostname, hostname);
171 sessionid.id_num = i; /* Only valid for utmp sessions */
173 sessionid.uid = vuser->server_info->utok.uid;
174 sessionid.gid = vuser->server_info->utok.gid;
175 fstrcpy(sessionid.remote_machine, get_remote_machine_name());
176 fstrcpy(sessionid.ip_addr_str,
177 client_addr(get_client_fd(),addr,sizeof(addr)));
178 sessionid.connect_start = time(NULL);
180 if (!smb_pam_claim_session(sessionid.username, sessionid.id_str,
181 sessionid.hostname)) {
182 DEBUG(1,("pam_session rejected the session for %s [%s]\n",
183 sessionid.username, sessionid.id_str));
189 data.dptr = (uint8 *)&sessionid;
190 data.dsize = sizeof(sessionid);
192 status = rec->store(rec, data, TDB_REPLACE);
196 if (!NT_STATUS_IS_OK(status)) {
197 DEBUG(1,("session_claim: unable to create session id "
198 "record: %s\n", nt_errstr(status)));
203 sys_utmp_claim(sessionid.username, sessionid.hostname,
204 sessionid.ip_addr_str,
205 sessionid.id_str, sessionid.id_num);
208 vuser->session_keystr = talloc_strdup(vuser, keystr);
209 if (!vuser->session_keystr) {
210 DEBUG(0, ("session_claim: talloc_strdup() failed for session_keystr\n"));
216 /********************************************************************
217 called when a session is destroyed
218 ********************************************************************/
220 void session_yield(user_struct *vuser)
223 struct sessionid sessionid;
224 struct db_context *ctx;
225 struct db_record *rec;
227 if (!(ctx = session_db_ctx())) return;
229 if (!vuser->session_keystr) {
233 key = string_term_tdb_data(vuser->session_keystr);
235 if (!(rec = ctx->fetch_locked(ctx, NULL, key))) {
239 if (rec->value.dsize != sizeof(sessionid))
242 memcpy(&sessionid, rec->value.dptr, sizeof(sessionid));
245 sys_utmp_yield(sessionid.username, sessionid.hostname,
246 sessionid.ip_addr_str,
247 sessionid.id_str, sessionid.id_num);
250 smb_pam_close_session(sessionid.username, sessionid.id_str,
253 rec->delete_rec(rec);
258 /********************************************************************
259 ********************************************************************/
261 static bool session_traverse(int (*fn)(struct db_record *db,
265 struct db_context *ctx;
267 if (!(ctx = session_db_ctx())) {
268 DEBUG(3, ("No tdb opened\n"));
272 ctx->traverse_read(ctx, fn, private_data);
276 /********************************************************************
277 ********************************************************************/
279 struct session_list {
282 struct sessionid *sessions;
285 static int gather_sessioninfo(struct db_record *rec, void *state)
287 struct session_list *sesslist = (struct session_list *) state;
288 const struct sessionid *current =
289 (const struct sessionid *) rec->value.dptr;
291 sesslist->sessions = TALLOC_REALLOC_ARRAY(
292 sesslist->mem_ctx, sesslist->sessions, struct sessionid,
295 if (!sesslist->sessions) {
300 memcpy(&sesslist->sessions[sesslist->count], current,
301 sizeof(struct sessionid));
305 DEBUG(7,("gather_sessioninfo session from %s@%s\n",
306 current->username, current->remote_machine));
311 /********************************************************************
312 ********************************************************************/
314 int list_sessions(TALLOC_CTX *mem_ctx, struct sessionid **session_list)
316 struct session_list sesslist;
318 sesslist.mem_ctx = mem_ctx;
320 sesslist.sessions = NULL;
322 if (!session_traverse(gather_sessioninfo, (void *) &sesslist)) {
323 DEBUG(3, ("Session traverse failed\n"));
324 SAFE_FREE(sesslist.sessions);
325 *session_list = NULL;
329 *session_list = sesslist.sessions;
330 return sesslist.count;