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
31 /********************************************************************
32 ********************************************************************/
34 static struct db_context *session_db_ctx(void)
36 static struct db_context *ctx;
41 ctx = db_open(NULL, lock_path("sessionid.tdb"), 0,
42 TDB_CLEAR_IF_FIRST|TDB_DEFAULT,
43 O_RDWR | O_CREAT, 0644);
47 BOOL session_init(void)
49 if (session_db_ctx() == NULL) {
50 DEBUG(1,("session_init: failed to open sessionid tdb\n"));
57 /********************************************************************
58 called when a session is created
59 ********************************************************************/
61 BOOL session_claim(user_struct *vuser)
65 struct sessionid sessionid;
66 struct server_id pid = procid_self();
69 struct db_context *ctx;
70 struct db_record *rec;
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 */
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"));
115 sess_pid = ((struct sessionid *)rec->value.dptr)->pid;
117 if (!process_exists(sess_pid)) {
118 DEBUG(5, ("%s has died -- re-using session\n",
119 procid_str_static(&sess_pid)));
126 if (i == MAX_SESSION_ID) {
127 SMB_ASSERT(rec == NULL);
128 DEBUG(1,("session_claim: out of session IDs "
129 "(max is %d)\n", MAX_SESSION_ID));
133 snprintf(sessionid.id_str, sizeof(sessionid.id_str),
134 SESSION_UTMP_TEMPLATE, i);
137 snprintf(keystr, sizeof(keystr), "ID/%s/%u",
138 procid_str_static(&pid), vuser->vuid);
139 key = string_term_tdb_data(keystr);
141 rec = ctx->fetch_locked(ctx, NULL, key);
144 DEBUG(1, ("Could not lock \"%s\"\n", keystr));
148 snprintf(sessionid.id_str, sizeof(sessionid.id_str),
149 SESSION_TEMPLATE, (long unsigned int)sys_getpid(),
153 SMB_ASSERT(rec != NULL);
155 /* If 'hostname lookup' == yes, then do the DNS lookup. This is
156 needed because utmp and PAM both expect DNS names
158 client_name() handles this case internally.
161 hostname = client_name();
162 if (strcmp(hostname, "UNKNOWN") == 0) {
163 hostname = client_addr();
166 fstrcpy(sessionid.username, vuser->user.unix_name);
167 fstrcpy(sessionid.hostname, hostname);
168 sessionid.id_num = i; /* Only valid for utmp sessions */
170 sessionid.uid = vuser->uid;
171 sessionid.gid = vuser->gid;
172 fstrcpy(sessionid.remote_machine, get_remote_machine_name());
173 fstrcpy(sessionid.ip_addr_str, client_addr());
174 sessionid.connect_start = time(NULL);
176 if (!smb_pam_claim_session(sessionid.username, sessionid.id_str,
177 sessionid.hostname)) {
178 DEBUG(1,("pam_session rejected the session for %s [%s]\n",
179 sessionid.username, sessionid.id_str));
185 data.dptr = (uint8 *)&sessionid;
186 data.dsize = sizeof(sessionid);
188 status = rec->store(rec, data, TDB_REPLACE);
192 if (!NT_STATUS_IS_OK(status)) {
193 DEBUG(1,("session_claim: unable to create session id "
194 "record: %s\n", nt_errstr(status)));
199 sys_utmp_claim(sessionid.username, sessionid.hostname,
200 sessionid.ip_addr_str,
201 sessionid.id_str, sessionid.id_num);
206 vuser->session_keystr = talloc_strdup(vuser, keystr);
207 if (!vuser->session_keystr) {
208 DEBUG(0, ("session_claim: talloc_strdup() failed for "
209 "session_keystr\n"));
215 /********************************************************************
216 called when a session is destroyed
217 ********************************************************************/
219 void session_yield(user_struct *vuser)
222 struct sessionid sessionid;
223 struct db_context *ctx;
224 struct db_record *rec;
226 if (!(ctx = session_db_ctx())) return;
228 if (!vuser->session_keystr) {
232 key = string_term_tdb_data(vuser->session_keystr);
234 if (!(rec = ctx->fetch_locked(ctx, NULL, key))) {
238 if (rec->value.dsize != sizeof(sessionid))
241 memcpy(&sessionid, rec->value.dptr, sizeof(sessionid));
244 sys_utmp_yield(sessionid.username, sessionid.hostname,
245 sessionid.ip_addr_str,
246 sessionid.id_str, sessionid.id_num);
249 smb_pam_close_session(sessionid.username, sessionid.id_str,
252 rec->delete_rec(rec);
257 /********************************************************************
258 ********************************************************************/
260 static BOOL session_traverse(int (*fn)(struct db_record *db,
264 struct db_context *ctx;
266 if (!(ctx = session_db_ctx())) {
267 DEBUG(3, ("No tdb opened\n"));
271 ctx->traverse_read(ctx, fn, private_data);
275 /********************************************************************
276 ********************************************************************/
278 struct session_list {
281 struct sessionid *sessions;
284 static int gather_sessioninfo(struct db_record *rec, void *state)
286 struct session_list *sesslist = (struct session_list *) state;
287 const struct sessionid *current =
288 (const struct sessionid *) rec->value.dptr;
290 sesslist->sessions = TALLOC_REALLOC_ARRAY(
291 sesslist->mem_ctx, sesslist->sessions, struct sessionid,
294 if (!sesslist->sessions) {
299 memcpy(&sesslist->sessions[sesslist->count], current,
300 sizeof(struct sessionid));
304 DEBUG(7,("gather_sessioninfo session from %s@%s\n",
305 current->username, current->remote_machine));
310 /********************************************************************
311 ********************************************************************/
313 int list_sessions(TALLOC_CTX *mem_ctx, struct sessionid **session_list)
315 struct session_list sesslist;
317 sesslist.mem_ctx = mem_ctx;
319 sesslist.sessions = NULL;
321 if (!session_traverse(gather_sessioninfo, (void *) &sesslist)) {
322 DEBUG(3, ("Session traverse failed\n"));
323 SAFE_FREE(sesslist.sessions);
324 *session_list = NULL;
328 *session_list = sesslist.sessions;
329 return sesslist.count;