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/>.
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)
43 if (vuid == UID_FIELD_INVALID)
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) {
54 case SERVER_ALLOCATED_REQUIRED_NO:
55 if (usp->server_info != NULL) {
58 case SERVER_ALLOCATED_REQUIRED_ANY:
62 DLIST_PROMOTE(validated_users, usp);
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) {
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 /****************************************************************************
104 ****************************************************************************/
106 void invalidate_vuid(uint16 vuid)
108 user_struct *vuser = NULL;
110 if (vuid == UID_FIELD_INVALID) {
114 vuser = get_valid_user_struct_internal(vuid,
115 SERVER_ALLOCATED_REQUIRED_ANY);
120 session_yield(vuser);
122 data_blob_free(&vuser->session_key);
124 if (vuser->auth_ntlmssp_state) {
125 auth_ntlmssp_end(&vuser->auth_ntlmssp_state);
128 DLIST_REMOVE(validated_users, vuser);
130 /* clear the vuid from the 'cache' on each connection, and
131 from the vuid 'owner' of connections */
132 conn_clear_vuid_cache(vuid);
135 num_validated_vuids--;
138 /****************************************************************************
139 Invalidate all vuid entries for this process.
140 ****************************************************************************/
142 void invalidate_all_vuids(void)
144 user_struct *usp, *next=NULL;
146 for (usp=validated_users;usp;usp=next) {
148 invalidate_vuid(usp->vuid);
152 /****************************************************
153 Create a new partial auth user struct.
154 *****************************************************/
156 int register_initial_vuid(void)
160 /* Paranoia check. */
161 if(lp_security() == SEC_SHARE) {
162 smb_panic("register_initial_vuid: "
163 "Tried to register uid in security=share");
166 /* Limit allowed vuids to 16bits - VUID_OFFSET. */
167 if (num_validated_vuids >= 0xFFFF-VUID_OFFSET) {
168 return UID_FIELD_INVALID;
171 if((vuser = talloc_zero(NULL, user_struct)) == NULL) {
172 DEBUG(0,("register_initial_vuid: "
173 "Failed to talloc users struct!\n"));
174 return UID_FIELD_INVALID;
177 /* Allocate a free vuid. Yes this is a linear search... */
178 while( get_valid_user_struct_internal(next_vuid,
179 SERVER_ALLOCATED_REQUIRED_ANY) != NULL ) {
181 /* Check for vuid wrap. */
182 if (next_vuid == UID_FIELD_INVALID) {
183 next_vuid = VUID_OFFSET;
187 DEBUG(10,("register_initial_vuid: allocated vuid = %u\n",
188 (unsigned int)next_vuid ));
190 vuser->vuid = next_vuid;
193 * This happens in an unfinished NTLMSSP session setup. We
194 * need to allocate a vuid between the first and second calls
198 num_validated_vuids++;
200 DLIST_ADD(validated_users, vuser);
204 static int register_homes_share(const char *username)
209 result = lp_servicenumber(username);
211 DEBUG(3, ("Using static (or previously created) service for "
212 "user '%s'; path = '%s'\n", username,
213 lp_pathname(result)));
217 pwd = getpwnam_alloc(talloc_tos(), username);
219 if ((pwd == NULL) || (pwd->pw_dir[0] == '\0')) {
220 DEBUG(3, ("No home directory defined for user '%s'\n",
226 DEBUG(3, ("Adding homes service for user '%s' using home directory: "
227 "'%s'\n", username, pwd->pw_dir));
229 result = add_home_service(username, username, pwd->pw_dir);
236 * register that a valid login has been performed, establish 'session'.
237 * @param server_info The token returned from the authentication process.
238 * (now 'owned' by register_existing_vuid)
240 * @param session_key The User session key for the login session (now also
241 * 'owned' by register_existing_vuid)
243 * @param respose_blob The NT challenge-response, if available. (May be
244 * freed after this call)
246 * @param smb_name The untranslated name of the user
248 * @return Newly allocated vuid, biased by an offset. (This allows us to
249 * tell random client vuid's (normally zero) from valid vuids.)
253 int register_existing_vuid(uint16 vuid,
254 auth_serversupplied_info *server_info,
255 DATA_BLOB session_key,
256 DATA_BLOB response_blob,
257 const char *smb_name)
259 user_struct *vuser = get_partial_auth_user_struct(vuid);
264 /* Use this to keep tabs on all our info from the authentication */
265 vuser->server_info = server_info;
267 /* Ensure that the server_info will disappear with
268 * the vuser it is now attached to */
270 talloc_steal(vuser, vuser->server_info);
272 vuser->guest = server_info->guest;
273 fstrcpy(vuser->user.unix_name, server_info->unix_name);
275 /* This is a potentially untrusted username */
276 alpha_strcpy(vuser->user.smb_name, smb_name, ". _-$",
277 sizeof(vuser->user.smb_name));
279 fstrcpy(vuser->user.domain, pdb_get_domain(server_info->sam_account));
280 fstrcpy(vuser->user.full_name,
281 pdb_get_fullname(server_info->sam_account));
283 vuser->session_key = session_key;
285 DEBUG(10,("register_existing_vuid: (%u,%u) %s %s %s guest=%d\n",
286 (unsigned int)vuser->server_info->uid,
287 (unsigned int)vuser->server_info->gid,
288 vuser->user.unix_name, vuser->user.smb_name,
289 vuser->user.domain, vuser->guest ));
291 DEBUG(3, ("register_existing_vuid: User name: %s\t"
292 "Real name: %s\n", vuser->user.unix_name,
293 vuser->user.full_name));
295 if (!server_info->ptok) {
296 DEBUG(1, ("register_existing_vuid: server_info does not "
297 "contain a user_token - cannot continue\n"));
301 DEBUG(3,("register_existing_vuid: UNIX uid %d is UNIX user %s, "
302 "and will be vuid %u\n", (int)vuser->server_info->uid,
303 vuser->user.unix_name, vuser->vuid));
306 num_validated_vuids++;
308 if (!session_claim(vuser)) {
309 DEBUG(1, ("register_existing_vuid: Failed to claim session "
315 /* Register a home dir service for this user if
316 (a) This is not a guest connection,
317 (b) we have a home directory defined
318 (c) there s not an existing static share by that name
319 If a share exists by this name (autoloaded or not) reuse it . */
321 vuser->homes_snum = -1;
324 vuser->homes_snum = register_homes_share(
325 vuser->user.unix_name);
328 if (srv_is_signing_negotiated() && !vuser->guest &&
329 !srv_signing_started()) {
330 /* Try and turn on server signing on the first non-guest
332 srv_set_signing(vuser->session_key, response_blob);
335 /* fill in the current_user_info struct */
336 set_current_user_info( &vuser->user );
342 invalidate_vuid(vuid);
344 return UID_FIELD_INVALID;
347 /****************************************************************************
348 Add a name to the session users list.
349 ****************************************************************************/
351 void add_session_user(const char *user)
356 pw = Get_Pwnam_alloc(talloc_tos(), user);
362 if (session_userlist == NULL) {
363 session_userlist = SMB_STRDUP(pw->pw_name);
367 if (in_list(pw->pw_name,session_userlist,False) ) {
371 if (strlen(session_userlist) > 128 * 1024) {
372 DEBUG(3,("add_session_user: session userlist already "
377 if (asprintf(&tmp, "%s %s", session_userlist, pw->pw_name) == -1) {
378 DEBUG(3, ("asprintf failed\n"));
382 SAFE_FREE(session_userlist);
383 session_userlist = tmp;
388 /****************************************************************************
389 In security=share mode we need to store the client workgroup, as that's
390 what Vista uses for the NTLMv2 calculation.
391 ****************************************************************************/
393 void add_session_workgroup(const char *workgroup)
395 if (session_workgroup) {
396 SAFE_FREE(session_workgroup);
398 session_workgroup = smb_xstrdup(workgroup);
401 /****************************************************************************
402 In security=share mode we need to return the client workgroup, as that's
403 what Vista uses for the NTLMv2 calculation.
404 ****************************************************************************/
406 const char *get_session_workgroup(void)
408 return session_workgroup;
411 /****************************************************************************
412 Check if a user is in a netgroup user list. If at first we don't succeed,
414 ****************************************************************************/
416 bool user_in_netgroup(const char *user, const char *ngname)
419 static char *mydomain = NULL;
420 fstring lowercase_user;
422 if (mydomain == NULL)
423 yp_get_default_domain(&mydomain);
425 if(mydomain == NULL) {
426 DEBUG(5,("Unable to get default yp domain, "
427 "let's try without specifying it\n"));
430 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
431 user, mydomain?mydomain:"(ANY)", ngname));
433 if (innetgr(ngname, NULL, user, mydomain)) {
434 DEBUG(5,("user_in_netgroup: Found\n"));
439 * Ok, innetgr is case sensitive. Try once more with lowercase
440 * just in case. Attempt to fix #703. JRA.
443 fstrcpy(lowercase_user, user);
444 strlower_m(lowercase_user);
446 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
447 lowercase_user, mydomain?mydomain:"(ANY)", ngname));
449 if (innetgr(ngname, NULL, lowercase_user, mydomain)) {
450 DEBUG(5,("user_in_netgroup: Found\n"));
454 #endif /* HAVE_NETGROUP */
458 /****************************************************************************
459 Check if a user is in a user list - can check combinations of UNIX
461 ****************************************************************************/
463 bool user_in_list(const char *user,const char **list)
468 DEBUG(10,("user_in_list: checking user %s in list\n", user));
472 DEBUG(10,("user_in_list: checking user |%s| against |%s|\n",
476 * Check raw username.
478 if (strequal(user, *list))
482 * Now check to see if any combination
483 * of UNIX and netgroups has been specified.
488 * Old behaviour. Check netgroup list
489 * followed by UNIX list.
491 if(user_in_netgroup(user, *list +1))
493 if(user_in_group(user, *list +1))
495 } else if (**list == '+') {
497 if((*(*list +1)) == '&') {
499 * Search UNIX list followed by netgroup.
501 if(user_in_group(user, *list +2))
503 if(user_in_netgroup(user, *list +2))
509 * Just search UNIX list.
512 if(user_in_group(user, *list +1))
516 } else if (**list == '&') {
518 if(*(*list +1) == '+') {
520 * Search netgroup list followed by UNIX list.
522 if(user_in_netgroup(user, *list +2))
524 if(user_in_group(user, *list +2))
528 * Just search netgroup list.
530 if(user_in_netgroup(user, *list +1))
540 /****************************************************************************
541 Check if a username is valid.
542 ****************************************************************************/
544 static bool user_ok(const char *user, int snum)
546 char **valid, **invalid;
549 valid = invalid = NULL;
552 if (lp_invalid_users(snum)) {
553 str_list_copy(talloc_tos(), &invalid, lp_invalid_users(snum));
555 str_list_substitute(invalid, "%S", lp_servicename(snum))) {
557 /* This is used in sec=share only, so no current user
558 * around to pass to str_list_sub_basic() */
560 if ( invalid && str_list_sub_basic(invalid, "", "") ) {
561 ret = !user_in_list(user,
562 (const char **)invalid);
566 TALLOC_FREE(invalid);
568 if (ret && lp_valid_users(snum)) {
569 str_list_copy(talloc_tos(), &valid, lp_valid_users(snum));
571 str_list_substitute(valid, "%S", lp_servicename(snum)) ) {
573 /* This is used in sec=share only, so no current user
574 * around to pass to str_list_sub_basic() */
576 if ( valid && str_list_sub_basic(valid, "", "") ) {
577 ret = user_in_list(user, (const char **)valid);
583 if (ret && lp_onlyuser(snum)) {
584 char **user_list = str_list_make(
585 talloc_tos(), lp_username(snum), NULL);
587 str_list_substitute(user_list, "%S",
588 lp_servicename(snum))) {
589 ret = user_in_list(user, (const char **)user_list);
591 TALLOC_FREE(user_list);
597 /****************************************************************************
598 Validate a group username entry. Return the username or NULL.
599 ****************************************************************************/
601 static char *validate_group(char *group, DATA_BLOB password,int snum)
605 char *host, *user, *domain;
607 while (getnetgrent(&host, &user, &domain)) {
609 if (user_ok(user, snum) &&
610 password_ok(user,password)) {
624 while ((gptr = (struct group *)getgrent())) {
625 if (strequal(gptr->gr_name,group))
630 * As user_ok can recurse doing a getgrent(), we must
631 * copy the member list onto the heap before
632 * use. Bug pointed out by leon@eatworms.swmed.edu.
636 char *member_list = NULL;
641 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
642 list_len += strlen(gptr->gr_mem[i])+1;
646 member_list = (char *)SMB_MALLOC(list_len);
653 member = member_list;
655 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
656 size_t member_len = strlen(gptr->gr_mem[i])+1;
658 DEBUG(10,("validate_group: = gr_mem = "
659 "%s\n", gptr->gr_mem[i]));
661 safe_strcpy(member, gptr->gr_mem[i],
662 list_len - (member-member_list));
663 member += member_len;
668 member = member_list;
670 if (user_ok(member,snum) &&
671 password_ok(member,password)) {
672 char *name = talloc_strdup(talloc_tos(),
674 SAFE_FREE(member_list);
678 DEBUG(10,("validate_group = member = %s\n",
681 member += strlen(member) + 1;
684 SAFE_FREE(member_list);
694 /****************************************************************************
695 Check for authority to login to a service with a given username/password.
696 Note this is *NOT* used when logging on using sessionsetup_and_X.
697 ****************************************************************************/
699 bool authorise_login(int snum, fstring user, DATA_BLOB password,
704 #ifdef DEBUG_PASSWORD
705 DEBUG(100,("authorise_login: checking authorisation on "
706 "user=%s pass=%s\n", user,password.data));
711 /* there are several possibilities:
712 1) login as the given user with given password
713 2) login as a previously registered username with the given
715 3) login as a session list username with the given password
716 4) login as a previously validated user/password pair
717 5) login as the "user =" user with given password
718 6) login as the "user =" user with no password
720 7) login as guest user with no password
722 if the service is guest_only then steps 1 to 5 are skipped
725 /* now check the list of session users */
728 char *user_list = NULL;
731 if ( session_userlist )
732 user_list = SMB_STRDUP(session_userlist);
734 user_list = SMB_STRDUP("");
739 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
741 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
743 fstrcpy(user2,auser);
744 if (!user_ok(user2,snum))
747 if (password_ok(user2,password)) {
750 DEBUG(3,("authorise_login: ACCEPTED: session "
751 "list username (%s) and given "
752 "password ok\n", user));
756 SAFE_FREE(user_list);
759 /* check the user= fields and the given password */
760 if (!ok && lp_username(snum)) {
761 TALLOC_CTX *ctx = talloc_tos();
763 char *user_list = talloc_strdup(ctx, lp_username(snum));
770 user_list = talloc_string_sub(ctx,
773 lp_servicename(snum));
779 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
781 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
783 auser = validate_group(auser+1,password,snum);
787 DEBUG(3,("authorise_login: ACCEPTED: "
788 "group username and given "
789 "password ok (%s)\n", user));
793 fstrcpy(user2,auser);
794 if (user_ok(user2,snum) &&
795 password_ok(user2,password)) {
798 DEBUG(3,("authorise_login: ACCEPTED: "
799 "user list username and "
800 "given password ok (%s)\n",
809 /* check for a normal guest connection */
810 if (!ok && GUEST_OK(snum)) {
811 struct passwd *guest_pw;
813 fstrcpy(guestname,lp_guestaccount());
814 guest_pw = Get_Pwnam_alloc(talloc_tos(), guestname);
815 if (guest_pw != NULL) {
816 fstrcpy(user,guestname);
818 DEBUG(3,("authorise_login: ACCEPTED: guest account "
819 "and guest ok (%s)\n", user));
821 DEBUG(0,("authorise_login: Invalid guest account "
822 "%s??\n",guestname));
824 TALLOC_FREE(guest_pw);
828 if (ok && !user_ok(user, snum)) {
829 DEBUG(0,("authorise_login: rejected invalid user %s\n",user));