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 uint16_t 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 return (get_partial_auth_user_struct(vuid) != NULL);
88 /****************************************************************************
89 Get the user struct of a partial NTLMSSP login
90 ****************************************************************************/
92 user_struct *get_partial_auth_user_struct(uint16 vuid)
94 return get_valid_user_struct_internal(vuid,
95 SERVER_ALLOCATED_REQUIRED_NO);
98 /****************************************************************************
100 ****************************************************************************/
102 void invalidate_vuid(uint16 vuid)
104 user_struct *vuser = NULL;
106 vuser = get_valid_user_struct_internal(vuid,
107 SERVER_ALLOCATED_REQUIRED_ANY);
112 session_yield(vuser);
114 if (vuser->auth_ntlmssp_state) {
115 auth_ntlmssp_end(&vuser->auth_ntlmssp_state);
118 DLIST_REMOVE(validated_users, vuser);
120 /* clear the vuid from the 'cache' on each connection, and
121 from the vuid 'owner' of connections */
122 conn_clear_vuid_caches(vuid);
125 num_validated_vuids--;
128 /****************************************************************************
129 Invalidate all vuid entries for this process.
130 ****************************************************************************/
132 void invalidate_all_vuids(void)
134 while (validated_users != NULL) {
135 invalidate_vuid(validated_users->vuid);
139 static void increment_next_vuid(uint16_t *vuid)
143 /* Check for vuid wrap. */
144 if (*vuid == UID_FIELD_INVALID) {
149 /****************************************************
150 Create a new partial auth user struct.
151 *****************************************************/
153 int register_initial_vuid(void)
157 /* Paranoia check. */
158 if(lp_security() == SEC_SHARE) {
159 smb_panic("register_initial_vuid: "
160 "Tried to register uid in security=share");
163 /* Limit allowed vuids to 16bits - VUID_OFFSET. */
164 if (num_validated_vuids >= 0xFFFF-VUID_OFFSET) {
165 return UID_FIELD_INVALID;
168 if((vuser = talloc_zero(NULL, user_struct)) == NULL) {
169 DEBUG(0,("register_initial_vuid: "
170 "Failed to talloc users struct!\n"));
171 return UID_FIELD_INVALID;
174 /* Allocate a free vuid. Yes this is a linear search... */
175 while( get_valid_user_struct_internal(next_vuid,
176 SERVER_ALLOCATED_REQUIRED_ANY) != NULL ) {
177 increment_next_vuid(&next_vuid);
180 DEBUG(10,("register_initial_vuid: allocated vuid = %u\n",
181 (unsigned int)next_vuid ));
183 vuser->vuid = next_vuid;
186 * This happens in an unfinished NTLMSSP session setup. We
187 * need to allocate a vuid between the first and second calls
190 increment_next_vuid(&next_vuid);
191 num_validated_vuids++;
193 DLIST_ADD(validated_users, vuser);
197 static int register_homes_share(const char *username)
202 result = lp_servicenumber(username);
204 DEBUG(3, ("Using static (or previously created) service for "
205 "user '%s'; path = '%s'\n", username,
206 lp_pathname(result)));
210 pwd = getpwnam_alloc(talloc_tos(), username);
212 if ((pwd == NULL) || (pwd->pw_dir[0] == '\0')) {
213 DEBUG(3, ("No home directory defined for user '%s'\n",
219 DEBUG(3, ("Adding homes service for user '%s' using home directory: "
220 "'%s'\n", username, pwd->pw_dir));
222 result = add_home_service(username, username, pwd->pw_dir);
229 * register that a valid login has been performed, establish 'session'.
230 * @param server_info The token returned from the authentication process.
231 * (now 'owned' by register_existing_vuid)
233 * @param session_key The User session key for the login session (now also
234 * 'owned' by register_existing_vuid)
236 * @param respose_blob The NT challenge-response, if available. (May be
237 * freed after this call)
239 * @param smb_name The untranslated name of the user
241 * @return Newly allocated vuid, biased by an offset. (This allows us to
242 * tell random client vuid's (normally zero) from valid vuids.)
246 int register_existing_vuid(uint16 vuid,
247 auth_serversupplied_info *server_info,
248 DATA_BLOB response_blob,
249 const char *smb_name)
254 vuser = get_partial_auth_user_struct(vuid);
259 /* Use this to keep tabs on all our info from the authentication */
260 vuser->server_info = talloc_move(vuser, &server_info);
262 /* This is a potentially untrusted username */
263 alpha_strcpy(tmp, smb_name, ". _-$", sizeof(tmp));
265 vuser->server_info->sanitized_username = talloc_strdup(
266 vuser->server_info, tmp);
268 DEBUG(10,("register_existing_vuid: (%u,%u) %s %s %s guest=%d\n",
269 (unsigned int)vuser->server_info->utok.uid,
270 (unsigned int)vuser->server_info->utok.gid,
271 vuser->server_info->unix_name,
272 vuser->server_info->sanitized_username,
273 pdb_get_domain(vuser->server_info->sam_account),
274 vuser->server_info->guest ));
276 DEBUG(3, ("register_existing_vuid: User name: %s\t"
277 "Real name: %s\n", vuser->server_info->unix_name,
278 pdb_get_fullname(vuser->server_info->sam_account)));
280 if (!vuser->server_info->ptok) {
281 DEBUG(1, ("register_existing_vuid: server_info does not "
282 "contain a user_token - cannot continue\n"));
286 DEBUG(3,("register_existing_vuid: UNIX uid %d is UNIX user %s, "
287 "and will be vuid %u\n", (int)vuser->server_info->utok.uid,
288 vuser->server_info->unix_name, vuser->vuid));
290 if (!session_claim(vuser)) {
291 DEBUG(1, ("register_existing_vuid: Failed to claim session "
297 /* Register a home dir service for this user if
298 (a) This is not a guest connection,
299 (b) we have a home directory defined
300 (c) there s not an existing static share by that name
301 If a share exists by this name (autoloaded or not) reuse it . */
303 vuser->homes_snum = -1;
305 if (!vuser->server_info->guest) {
306 vuser->homes_snum = register_homes_share(
307 vuser->server_info->unix_name);
310 if (srv_is_signing_negotiated() && !vuser->server_info->guest &&
311 !srv_signing_started()) {
312 /* Try and turn on server signing on the first non-guest
314 srv_set_signing(vuser->server_info->user_session_key, response_blob);
317 /* fill in the current_user_info struct */
318 set_current_user_info(
319 vuser->server_info->sanitized_username,
320 vuser->server_info->unix_name,
321 pdb_get_fullname(vuser->server_info->sam_account),
322 pdb_get_domain(vuser->server_info->sam_account));
329 invalidate_vuid(vuid);
331 return UID_FIELD_INVALID;
334 /****************************************************************************
335 Add a name to the session users list.
336 ****************************************************************************/
338 void add_session_user(const char *user)
343 pw = Get_Pwnam_alloc(talloc_tos(), user);
349 if (session_userlist == NULL) {
350 session_userlist = SMB_STRDUP(pw->pw_name);
354 if (in_list(pw->pw_name,session_userlist,False) ) {
358 if (strlen(session_userlist) > 128 * 1024) {
359 DEBUG(3,("add_session_user: session userlist already "
364 if (asprintf(&tmp, "%s %s", session_userlist, pw->pw_name) == -1) {
365 DEBUG(3, ("asprintf failed\n"));
369 SAFE_FREE(session_userlist);
370 session_userlist = tmp;
375 /****************************************************************************
376 In security=share mode we need to store the client workgroup, as that's
377 what Vista uses for the NTLMv2 calculation.
378 ****************************************************************************/
380 void add_session_workgroup(const char *workgroup)
382 if (session_workgroup) {
383 SAFE_FREE(session_workgroup);
385 session_workgroup = smb_xstrdup(workgroup);
388 /****************************************************************************
389 In security=share mode we need to return the client workgroup, as that's
390 what Vista uses for the NTLMv2 calculation.
391 ****************************************************************************/
393 const char *get_session_workgroup(void)
395 return session_workgroup;
398 /****************************************************************************
399 Check if a user is in a netgroup user list. If at first we don't succeed,
401 ****************************************************************************/
403 bool user_in_netgroup(const char *user, const char *ngname)
406 static char *mydomain = NULL;
407 fstring lowercase_user;
409 if (mydomain == NULL)
410 yp_get_default_domain(&mydomain);
412 if(mydomain == NULL) {
413 DEBUG(5,("Unable to get default yp domain, "
414 "let's try without specifying it\n"));
417 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
418 user, mydomain?mydomain:"(ANY)", ngname));
420 if (innetgr(ngname, NULL, user, mydomain)) {
421 DEBUG(5,("user_in_netgroup: Found\n"));
426 * Ok, innetgr is case sensitive. Try once more with lowercase
427 * just in case. Attempt to fix #703. JRA.
430 fstrcpy(lowercase_user, user);
431 strlower_m(lowercase_user);
433 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
434 lowercase_user, mydomain?mydomain:"(ANY)", ngname));
436 if (innetgr(ngname, NULL, lowercase_user, mydomain)) {
437 DEBUG(5,("user_in_netgroup: Found\n"));
441 #endif /* HAVE_NETGROUP */
445 /****************************************************************************
446 Check if a user is in a user list - can check combinations of UNIX
448 ****************************************************************************/
450 bool user_in_list(const char *user,const char **list)
455 DEBUG(10,("user_in_list: checking user %s in list\n", user));
459 DEBUG(10,("user_in_list: checking user |%s| against |%s|\n",
463 * Check raw username.
465 if (strequal(user, *list))
469 * Now check to see if any combination
470 * of UNIX and netgroups has been specified.
475 * Old behaviour. Check netgroup list
476 * followed by UNIX list.
478 if(user_in_netgroup(user, *list +1))
480 if(user_in_group(user, *list +1))
482 } else if (**list == '+') {
484 if((*(*list +1)) == '&') {
486 * Search UNIX list followed by netgroup.
488 if(user_in_group(user, *list +2))
490 if(user_in_netgroup(user, *list +2))
496 * Just search UNIX list.
499 if(user_in_group(user, *list +1))
503 } else if (**list == '&') {
505 if(*(*list +1) == '+') {
507 * Search netgroup list followed by UNIX list.
509 if(user_in_netgroup(user, *list +2))
511 if(user_in_group(user, *list +2))
515 * Just search netgroup list.
517 if(user_in_netgroup(user, *list +1))
527 /****************************************************************************
528 Check if a username is valid.
529 ****************************************************************************/
531 static bool user_ok(const char *user, int snum)
533 char **valid, **invalid;
536 valid = invalid = NULL;
539 if (lp_invalid_users(snum)) {
540 invalid = str_list_copy(talloc_tos(), lp_invalid_users(snum));
542 str_list_substitute(invalid, "%S", lp_servicename(snum))) {
544 /* This is used in sec=share only, so no current user
545 * around to pass to str_list_sub_basic() */
547 if ( invalid && str_list_sub_basic(invalid, "", "") ) {
548 ret = !user_in_list(user,
549 (const char **)invalid);
553 TALLOC_FREE(invalid);
555 if (ret && lp_valid_users(snum)) {
556 valid = str_list_copy(talloc_tos(), lp_valid_users(snum));
558 str_list_substitute(valid, "%S", lp_servicename(snum)) ) {
560 /* This is used in sec=share only, so no current user
561 * around to pass to str_list_sub_basic() */
563 if ( valid && str_list_sub_basic(valid, "", "") ) {
564 ret = user_in_list(user, (const char **)valid);
570 if (ret && lp_onlyuser(snum)) {
571 char **user_list = str_list_make_v3(
572 talloc_tos(), lp_username(snum), NULL);
574 str_list_substitute(user_list, "%S",
575 lp_servicename(snum))) {
576 ret = user_in_list(user, (const char **)user_list);
578 TALLOC_FREE(user_list);
584 /****************************************************************************
585 Validate a group username entry. Return the username or NULL.
586 ****************************************************************************/
588 static char *validate_group(char *group, DATA_BLOB password,int snum)
592 char *host, *user, *domain;
594 while (getnetgrent(&host, &user, &domain)) {
596 if (user_ok(user, snum) &&
597 password_ok(user,password)) {
611 while ((gptr = (struct group *)getgrent())) {
612 if (strequal(gptr->gr_name,group))
617 * As user_ok can recurse doing a getgrent(), we must
618 * copy the member list onto the heap before
619 * use. Bug pointed out by leon@eatworms.swmed.edu.
623 char *member_list = NULL;
628 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
629 list_len += strlen(gptr->gr_mem[i])+1;
633 member_list = (char *)SMB_MALLOC(list_len);
640 member = member_list;
642 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
643 size_t member_len = strlen(gptr->gr_mem[i])+1;
645 DEBUG(10,("validate_group: = gr_mem = "
646 "%s\n", gptr->gr_mem[i]));
648 safe_strcpy(member, gptr->gr_mem[i],
649 list_len - (member-member_list));
650 member += member_len;
655 member = member_list;
657 if (user_ok(member,snum) &&
658 password_ok(member,password)) {
659 char *name = talloc_strdup(talloc_tos(),
661 SAFE_FREE(member_list);
665 DEBUG(10,("validate_group = member = %s\n",
668 member += strlen(member) + 1;
671 SAFE_FREE(member_list);
681 /****************************************************************************
682 Check for authority to login to a service with a given username/password.
683 Note this is *NOT* used when logging on using sessionsetup_and_X.
684 ****************************************************************************/
686 bool authorise_login(int snum, fstring user, DATA_BLOB password,
691 #ifdef DEBUG_PASSWORD
692 DEBUG(100,("authorise_login: checking authorisation on "
693 "user=%s pass=%s\n", user,password.data));
698 /* there are several possibilities:
699 1) login as the given user with given password
700 2) login as a previously registered username with the given
702 3) login as a session list username with the given password
703 4) login as a previously validated user/password pair
704 5) login as the "user =" user with given password
705 6) login as the "user =" user with no password
707 7) login as guest user with no password
709 if the service is guest_only then steps 1 to 5 are skipped
712 /* now check the list of session users */
715 char *user_list = NULL;
718 if ( session_userlist )
719 user_list = SMB_STRDUP(session_userlist);
721 user_list = SMB_STRDUP("");
726 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
728 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
730 fstrcpy(user2,auser);
731 if (!user_ok(user2,snum))
734 if (password_ok(user2,password)) {
737 DEBUG(3,("authorise_login: ACCEPTED: session "
738 "list username (%s) and given "
739 "password ok\n", user));
743 SAFE_FREE(user_list);
746 /* check the user= fields and the given password */
747 if (!ok && lp_username(snum)) {
748 TALLOC_CTX *ctx = talloc_tos();
750 char *user_list = talloc_strdup(ctx, lp_username(snum));
757 user_list = talloc_string_sub(ctx,
760 lp_servicename(snum));
766 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
768 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
770 auser = validate_group(auser+1,password,snum);
774 DEBUG(3,("authorise_login: ACCEPTED: "
775 "group username and given "
776 "password ok (%s)\n", user));
780 fstrcpy(user2,auser);
781 if (user_ok(user2,snum) &&
782 password_ok(user2,password)) {
785 DEBUG(3,("authorise_login: ACCEPTED: "
786 "user list username and "
787 "given password ok (%s)\n",
796 /* check for a normal guest connection */
797 if (!ok && GUEST_OK(snum)) {
798 struct passwd *guest_pw;
800 fstrcpy(guestname,lp_guestaccount());
801 guest_pw = Get_Pwnam_alloc(talloc_tos(), guestname);
802 if (guest_pw != NULL) {
803 fstrcpy(user,guestname);
805 DEBUG(3,("authorise_login: ACCEPTED: guest account "
806 "and guest ok (%s)\n", user));
808 DEBUG(0,("authorise_login: Invalid guest account "
809 "%s??\n",guestname));
811 TALLOC_FREE(guest_pw);
815 if (ok && !user_ok(user, snum)) {
816 DEBUG(0,("authorise_login: rejected invalid user %s\n",user));