Remove "session_key" from "struct user_struct"
[Samba/bb.git] / source / smbd / password.c
blob5e2e713d439286c2c84f159a3e3693cfee046c3a
1 /*
2 Unix SMB/CIFS implementation.
3 Password and authentication handling
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 2007.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "includes.h"
23 /* users from session setup */
24 static char *session_userlist = NULL;
25 /* workgroup from session setup. */
26 static char *session_workgroup = NULL;
28 /* this holds info on user ids that are already validated for this VC */
29 static user_struct *validated_users;
30 static int next_vuid = VUID_OFFSET;
31 static int num_validated_vuids;
33 enum server_allocated_state { SERVER_ALLOCATED_REQUIRED_YES,
34 SERVER_ALLOCATED_REQUIRED_NO,
35 SERVER_ALLOCATED_REQUIRED_ANY};
37 static user_struct *get_valid_user_struct_internal(uint16 vuid,
38 enum server_allocated_state server_allocated)
40 user_struct *usp;
41 int count=0;
43 if (vuid == UID_FIELD_INVALID)
44 return NULL;
46 for (usp=validated_users;usp;usp=usp->next,count++) {
47 if (vuid == usp->vuid) {
48 switch (server_allocated) {
49 case SERVER_ALLOCATED_REQUIRED_YES:
50 if (usp->server_info == NULL) {
51 continue;
53 break;
54 case SERVER_ALLOCATED_REQUIRED_NO:
55 if (usp->server_info != NULL) {
56 continue;
58 case SERVER_ALLOCATED_REQUIRED_ANY:
59 break;
61 if (count > 10) {
62 DLIST_PROMOTE(validated_users, usp);
64 return usp;
68 return NULL;
71 /****************************************************************************
72 Check if a uid has been validated, and return an pointer to the user_struct
73 if it has. NULL if not. vuid is biased by an offset. This allows us to
74 tell random client vuid's (normally zero) from valid vuids.
75 ****************************************************************************/
77 user_struct *get_valid_user_struct(uint16 vuid)
79 return get_valid_user_struct_internal(vuid,
80 SERVER_ALLOCATED_REQUIRED_YES);
83 bool is_partial_auth_vuid(uint16 vuid)
85 if (vuid == UID_FIELD_INVALID) {
86 return False;
88 return get_valid_user_struct_internal(vuid,
89 SERVER_ALLOCATED_REQUIRED_NO) ? True : False;
92 /****************************************************************************
93 Get the user struct of a partial NTLMSSP login
94 ****************************************************************************/
96 user_struct *get_partial_auth_user_struct(uint16 vuid)
98 return get_valid_user_struct_internal(vuid,
99 SERVER_ALLOCATED_REQUIRED_NO);
102 /****************************************************************************
103 Invalidate a uid.
104 ****************************************************************************/
106 void invalidate_vuid(uint16 vuid)
108 user_struct *vuser = NULL;
110 if (vuid == UID_FIELD_INVALID) {
111 return;
114 vuser = get_valid_user_struct_internal(vuid,
115 SERVER_ALLOCATED_REQUIRED_ANY);
116 if (vuser == NULL) {
117 return;
120 session_yield(vuser);
122 if (vuser->auth_ntlmssp_state) {
123 auth_ntlmssp_end(&vuser->auth_ntlmssp_state);
126 DLIST_REMOVE(validated_users, vuser);
128 /* clear the vuid from the 'cache' on each connection, and
129 from the vuid 'owner' of connections */
130 conn_clear_vuid_cache(vuid);
132 TALLOC_FREE(vuser);
133 num_validated_vuids--;
136 /****************************************************************************
137 Invalidate all vuid entries for this process.
138 ****************************************************************************/
140 void invalidate_all_vuids(void)
142 user_struct *usp, *next=NULL;
144 for (usp=validated_users;usp;usp=next) {
145 next = usp->next;
146 invalidate_vuid(usp->vuid);
150 /****************************************************
151 Create a new partial auth user struct.
152 *****************************************************/
154 int register_initial_vuid(void)
156 user_struct *vuser;
158 /* Paranoia check. */
159 if(lp_security() == SEC_SHARE) {
160 smb_panic("register_initial_vuid: "
161 "Tried to register uid in security=share");
164 /* Limit allowed vuids to 16bits - VUID_OFFSET. */
165 if (num_validated_vuids >= 0xFFFF-VUID_OFFSET) {
166 return UID_FIELD_INVALID;
169 if((vuser = talloc_zero(NULL, user_struct)) == NULL) {
170 DEBUG(0,("register_initial_vuid: "
171 "Failed to talloc users struct!\n"));
172 return UID_FIELD_INVALID;
175 /* Allocate a free vuid. Yes this is a linear search... */
176 while( get_valid_user_struct_internal(next_vuid,
177 SERVER_ALLOCATED_REQUIRED_ANY) != NULL ) {
178 next_vuid++;
179 /* Check for vuid wrap. */
180 if (next_vuid == UID_FIELD_INVALID) {
181 next_vuid = VUID_OFFSET;
185 DEBUG(10,("register_initial_vuid: allocated vuid = %u\n",
186 (unsigned int)next_vuid ));
188 vuser->vuid = next_vuid;
191 * This happens in an unfinished NTLMSSP session setup. We
192 * need to allocate a vuid between the first and second calls
193 * to NTLMSSP.
195 next_vuid++;
196 num_validated_vuids++;
198 DLIST_ADD(validated_users, vuser);
199 return vuser->vuid;
202 static int register_homes_share(const char *username)
204 int result;
205 struct passwd *pwd;
207 result = lp_servicenumber(username);
208 if (result != -1) {
209 DEBUG(3, ("Using static (or previously created) service for "
210 "user '%s'; path = '%s'\n", username,
211 lp_pathname(result)));
212 return result;
215 pwd = getpwnam_alloc(talloc_tos(), username);
217 if ((pwd == NULL) || (pwd->pw_dir[0] == '\0')) {
218 DEBUG(3, ("No home directory defined for user '%s'\n",
219 username));
220 TALLOC_FREE(pwd);
221 return -1;
224 DEBUG(3, ("Adding homes service for user '%s' using home directory: "
225 "'%s'\n", username, pwd->pw_dir));
227 result = add_home_service(username, username, pwd->pw_dir);
229 TALLOC_FREE(pwd);
230 return result;
234 * register that a valid login has been performed, establish 'session'.
235 * @param server_info The token returned from the authentication process.
236 * (now 'owned' by register_existing_vuid)
238 * @param session_key The User session key for the login session (now also
239 * 'owned' by register_existing_vuid)
241 * @param respose_blob The NT challenge-response, if available. (May be
242 * freed after this call)
244 * @param smb_name The untranslated name of the user
246 * @return Newly allocated vuid, biased by an offset. (This allows us to
247 * tell random client vuid's (normally zero) from valid vuids.)
251 int register_existing_vuid(uint16 vuid,
252 auth_serversupplied_info *server_info,
253 DATA_BLOB response_blob,
254 const char *smb_name)
256 user_struct *vuser = get_partial_auth_user_struct(vuid);
257 if (!vuser) {
258 goto fail;
261 /* Use this to keep tabs on all our info from the authentication */
262 vuser->server_info = server_info;
264 /* Ensure that the server_info will disappear with
265 * the vuser it is now attached to */
267 talloc_steal(vuser, vuser->server_info);
269 fstrcpy(vuser->user.unix_name, server_info->unix_name);
271 /* This is a potentially untrusted username */
272 alpha_strcpy(vuser->user.smb_name, smb_name, ". _-$",
273 sizeof(vuser->user.smb_name));
275 fstrcpy(vuser->user.domain, pdb_get_domain(server_info->sam_account));
276 fstrcpy(vuser->user.full_name,
277 pdb_get_fullname(server_info->sam_account));
279 DEBUG(10,("register_existing_vuid: (%u,%u) %s %s %s guest=%d\n",
280 (unsigned int)vuser->server_info->uid,
281 (unsigned int)vuser->server_info->gid,
282 vuser->user.unix_name, vuser->user.smb_name,
283 vuser->user.domain, vuser->server_info->guest ));
285 DEBUG(3, ("register_existing_vuid: User name: %s\t"
286 "Real name: %s\n", vuser->user.unix_name,
287 vuser->user.full_name));
289 if (!server_info->ptok) {
290 DEBUG(1, ("register_existing_vuid: server_info does not "
291 "contain a user_token - cannot continue\n"));
292 goto fail;
295 DEBUG(3,("register_existing_vuid: UNIX uid %d is UNIX user %s, "
296 "and will be vuid %u\n", (int)vuser->server_info->uid,
297 vuser->user.unix_name, vuser->vuid));
299 next_vuid++;
300 num_validated_vuids++;
302 if (!session_claim(vuser)) {
303 DEBUG(1, ("register_existing_vuid: Failed to claim session "
304 "for vuid=%d\n",
305 vuser->vuid));
306 goto fail;
309 /* Register a home dir service for this user if
310 (a) This is not a guest connection,
311 (b) we have a home directory defined
312 (c) there s not an existing static share by that name
313 If a share exists by this name (autoloaded or not) reuse it . */
315 vuser->homes_snum = -1;
317 if (!vuser->server_info->guest) {
318 vuser->homes_snum = register_homes_share(
319 vuser->user.unix_name);
322 if (srv_is_signing_negotiated() && !vuser->server_info->guest &&
323 !srv_signing_started()) {
324 /* Try and turn on server signing on the first non-guest
325 * sessionsetup. */
326 srv_set_signing(vuser->server_info->user_session_key, response_blob);
329 /* fill in the current_user_info struct */
330 set_current_user_info( &vuser->user );
331 return vuser->vuid;
333 fail:
335 if (vuser) {
336 invalidate_vuid(vuid);
338 return UID_FIELD_INVALID;
341 /****************************************************************************
342 Add a name to the session users list.
343 ****************************************************************************/
345 void add_session_user(const char *user)
347 struct passwd *pw;
348 char *tmp;
350 pw = Get_Pwnam_alloc(talloc_tos(), user);
352 if (pw == NULL) {
353 return;
356 if (session_userlist == NULL) {
357 session_userlist = SMB_STRDUP(pw->pw_name);
358 goto done;
361 if (in_list(pw->pw_name,session_userlist,False) ) {
362 goto done;
365 if (strlen(session_userlist) > 128 * 1024) {
366 DEBUG(3,("add_session_user: session userlist already "
367 "too large.\n"));
368 goto done;
371 if (asprintf(&tmp, "%s %s", session_userlist, pw->pw_name) == -1) {
372 DEBUG(3, ("asprintf failed\n"));
373 goto done;
376 SAFE_FREE(session_userlist);
377 session_userlist = tmp;
378 done:
379 TALLOC_FREE(pw);
382 /****************************************************************************
383 In security=share mode we need to store the client workgroup, as that's
384 what Vista uses for the NTLMv2 calculation.
385 ****************************************************************************/
387 void add_session_workgroup(const char *workgroup)
389 if (session_workgroup) {
390 SAFE_FREE(session_workgroup);
392 session_workgroup = smb_xstrdup(workgroup);
395 /****************************************************************************
396 In security=share mode we need to return the client workgroup, as that's
397 what Vista uses for the NTLMv2 calculation.
398 ****************************************************************************/
400 const char *get_session_workgroup(void)
402 return session_workgroup;
405 /****************************************************************************
406 Check if a user is in a netgroup user list. If at first we don't succeed,
407 try lower case.
408 ****************************************************************************/
410 bool user_in_netgroup(const char *user, const char *ngname)
412 #ifdef HAVE_NETGROUP
413 static char *mydomain = NULL;
414 fstring lowercase_user;
416 if (mydomain == NULL)
417 yp_get_default_domain(&mydomain);
419 if(mydomain == NULL) {
420 DEBUG(5,("Unable to get default yp domain, "
421 "let's try without specifying it\n"));
424 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
425 user, mydomain?mydomain:"(ANY)", ngname));
427 if (innetgr(ngname, NULL, user, mydomain)) {
428 DEBUG(5,("user_in_netgroup: Found\n"));
429 return (True);
430 } else {
433 * Ok, innetgr is case sensitive. Try once more with lowercase
434 * just in case. Attempt to fix #703. JRA.
437 fstrcpy(lowercase_user, user);
438 strlower_m(lowercase_user);
440 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
441 lowercase_user, mydomain?mydomain:"(ANY)", ngname));
443 if (innetgr(ngname, NULL, lowercase_user, mydomain)) {
444 DEBUG(5,("user_in_netgroup: Found\n"));
445 return (True);
448 #endif /* HAVE_NETGROUP */
449 return False;
452 /****************************************************************************
453 Check if a user is in a user list - can check combinations of UNIX
454 and netgroup lists.
455 ****************************************************************************/
457 bool user_in_list(const char *user,const char **list)
459 if (!list || !*list)
460 return False;
462 DEBUG(10,("user_in_list: checking user %s in list\n", user));
464 while (*list) {
466 DEBUG(10,("user_in_list: checking user |%s| against |%s|\n",
467 user, *list));
470 * Check raw username.
472 if (strequal(user, *list))
473 return(True);
476 * Now check to see if any combination
477 * of UNIX and netgroups has been specified.
480 if(**list == '@') {
482 * Old behaviour. Check netgroup list
483 * followed by UNIX list.
485 if(user_in_netgroup(user, *list +1))
486 return True;
487 if(user_in_group(user, *list +1))
488 return True;
489 } else if (**list == '+') {
491 if((*(*list +1)) == '&') {
493 * Search UNIX list followed by netgroup.
495 if(user_in_group(user, *list +2))
496 return True;
497 if(user_in_netgroup(user, *list +2))
498 return True;
500 } else {
503 * Just search UNIX list.
506 if(user_in_group(user, *list +1))
507 return True;
510 } else if (**list == '&') {
512 if(*(*list +1) == '+') {
514 * Search netgroup list followed by UNIX list.
516 if(user_in_netgroup(user, *list +2))
517 return True;
518 if(user_in_group(user, *list +2))
519 return True;
520 } else {
522 * Just search netgroup list.
524 if(user_in_netgroup(user, *list +1))
525 return True;
529 list++;
531 return(False);
534 /****************************************************************************
535 Check if a username is valid.
536 ****************************************************************************/
538 static bool user_ok(const char *user, int snum)
540 char **valid, **invalid;
541 bool ret;
543 valid = invalid = NULL;
544 ret = True;
546 if (lp_invalid_users(snum)) {
547 str_list_copy(talloc_tos(), &invalid, lp_invalid_users(snum));
548 if (invalid &&
549 str_list_substitute(invalid, "%S", lp_servicename(snum))) {
551 /* This is used in sec=share only, so no current user
552 * around to pass to str_list_sub_basic() */
554 if ( invalid && str_list_sub_basic(invalid, "", "") ) {
555 ret = !user_in_list(user,
556 (const char **)invalid);
560 TALLOC_FREE(invalid);
562 if (ret && lp_valid_users(snum)) {
563 str_list_copy(talloc_tos(), &valid, lp_valid_users(snum));
564 if ( valid &&
565 str_list_substitute(valid, "%S", lp_servicename(snum)) ) {
567 /* This is used in sec=share only, so no current user
568 * around to pass to str_list_sub_basic() */
570 if ( valid && str_list_sub_basic(valid, "", "") ) {
571 ret = user_in_list(user, (const char **)valid);
575 TALLOC_FREE(valid);
577 if (ret && lp_onlyuser(snum)) {
578 char **user_list = str_list_make(
579 talloc_tos(), lp_username(snum), NULL);
580 if (user_list &&
581 str_list_substitute(user_list, "%S",
582 lp_servicename(snum))) {
583 ret = user_in_list(user, (const char **)user_list);
585 TALLOC_FREE(user_list);
588 return(ret);
591 /****************************************************************************
592 Validate a group username entry. Return the username or NULL.
593 ****************************************************************************/
595 static char *validate_group(char *group, DATA_BLOB password,int snum)
597 #ifdef HAVE_NETGROUP
599 char *host, *user, *domain;
600 setnetgrent(group);
601 while (getnetgrent(&host, &user, &domain)) {
602 if (user) {
603 if (user_ok(user, snum) &&
604 password_ok(user,password)) {
605 endnetgrent();
606 return(user);
610 endnetgrent();
612 #endif
614 #ifdef HAVE_GETGRENT
616 struct group *gptr;
617 setgrent();
618 while ((gptr = (struct group *)getgrent())) {
619 if (strequal(gptr->gr_name,group))
620 break;
624 * As user_ok can recurse doing a getgrent(), we must
625 * copy the member list onto the heap before
626 * use. Bug pointed out by leon@eatworms.swmed.edu.
629 if (gptr) {
630 char *member_list = NULL;
631 size_t list_len = 0;
632 char *member;
633 int i;
635 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
636 list_len += strlen(gptr->gr_mem[i])+1;
638 list_len++;
640 member_list = (char *)SMB_MALLOC(list_len);
641 if (!member_list) {
642 endgrent();
643 return NULL;
646 *member_list = '\0';
647 member = member_list;
649 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
650 size_t member_len = strlen(gptr->gr_mem[i])+1;
652 DEBUG(10,("validate_group: = gr_mem = "
653 "%s\n", gptr->gr_mem[i]));
655 safe_strcpy(member, gptr->gr_mem[i],
656 list_len - (member-member_list));
657 member += member_len;
660 endgrent();
662 member = member_list;
663 while (*member) {
664 if (user_ok(member,snum) &&
665 password_ok(member,password)) {
666 char *name = talloc_strdup(talloc_tos(),
667 member);
668 SAFE_FREE(member_list);
669 return name;
672 DEBUG(10,("validate_group = member = %s\n",
673 member));
675 member += strlen(member) + 1;
678 SAFE_FREE(member_list);
679 } else {
680 endgrent();
681 return NULL;
684 #endif
685 return(NULL);
688 /****************************************************************************
689 Check for authority to login to a service with a given username/password.
690 Note this is *NOT* used when logging on using sessionsetup_and_X.
691 ****************************************************************************/
693 bool authorise_login(int snum, fstring user, DATA_BLOB password,
694 bool *guest)
696 bool ok = False;
698 #ifdef DEBUG_PASSWORD
699 DEBUG(100,("authorise_login: checking authorisation on "
700 "user=%s pass=%s\n", user,password.data));
701 #endif
703 *guest = False;
705 /* there are several possibilities:
706 1) login as the given user with given password
707 2) login as a previously registered username with the given
708 password
709 3) login as a session list username with the given password
710 4) login as a previously validated user/password pair
711 5) login as the "user =" user with given password
712 6) login as the "user =" user with no password
713 (guest connection)
714 7) login as guest user with no password
716 if the service is guest_only then steps 1 to 5 are skipped
719 /* now check the list of session users */
720 if (!ok) {
721 char *auser;
722 char *user_list = NULL;
723 char *saveptr;
725 if ( session_userlist )
726 user_list = SMB_STRDUP(session_userlist);
727 else
728 user_list = SMB_STRDUP("");
730 if (!user_list)
731 return(False);
733 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
734 !ok && auser;
735 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
736 fstring user2;
737 fstrcpy(user2,auser);
738 if (!user_ok(user2,snum))
739 continue;
741 if (password_ok(user2,password)) {
742 ok = True;
743 fstrcpy(user,user2);
744 DEBUG(3,("authorise_login: ACCEPTED: session "
745 "list username (%s) and given "
746 "password ok\n", user));
750 SAFE_FREE(user_list);
753 /* check the user= fields and the given password */
754 if (!ok && lp_username(snum)) {
755 TALLOC_CTX *ctx = talloc_tos();
756 char *auser;
757 char *user_list = talloc_strdup(ctx, lp_username(snum));
758 char *saveptr;
760 if (!user_list) {
761 goto check_guest;
764 user_list = talloc_string_sub(ctx,
765 user_list,
766 "%S",
767 lp_servicename(snum));
769 if (!user_list) {
770 goto check_guest;
773 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
774 auser && !ok;
775 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
776 if (*auser == '@') {
777 auser = validate_group(auser+1,password,snum);
778 if (auser) {
779 ok = True;
780 fstrcpy(user,auser);
781 DEBUG(3,("authorise_login: ACCEPTED: "
782 "group username and given "
783 "password ok (%s)\n", user));
785 } else {
786 fstring user2;
787 fstrcpy(user2,auser);
788 if (user_ok(user2,snum) &&
789 password_ok(user2,password)) {
790 ok = True;
791 fstrcpy(user,user2);
792 DEBUG(3,("authorise_login: ACCEPTED: "
793 "user list username and "
794 "given password ok (%s)\n",
795 user));
801 check_guest:
803 /* check for a normal guest connection */
804 if (!ok && GUEST_OK(snum)) {
805 struct passwd *guest_pw;
806 fstring guestname;
807 fstrcpy(guestname,lp_guestaccount());
808 guest_pw = Get_Pwnam_alloc(talloc_tos(), guestname);
809 if (guest_pw != NULL) {
810 fstrcpy(user,guestname);
811 ok = True;
812 DEBUG(3,("authorise_login: ACCEPTED: guest account "
813 "and guest ok (%s)\n", user));
814 } else {
815 DEBUG(0,("authorise_login: Invalid guest account "
816 "%s??\n",guestname));
818 TALLOC_FREE(guest_pw);
819 *guest = True;
822 if (ok && !user_ok(user, snum)) {
823 DEBUG(0,("authorise_login: rejected invalid user %s\n",user));
824 ok = False;
827 return(ok);