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/>.
22 #include "smbd/globals.h"
24 enum server_allocated_state { SERVER_ALLOCATED_REQUIRED_YES,
25 SERVER_ALLOCATED_REQUIRED_NO,
26 SERVER_ALLOCATED_REQUIRED_ANY};
28 static user_struct *get_valid_user_struct_internal(uint16 vuid,
29 enum server_allocated_state server_allocated)
34 if (vuid == UID_FIELD_INVALID)
37 for (usp=validated_users;usp;usp=usp->next,count++) {
38 if (vuid == usp->vuid) {
39 switch (server_allocated) {
40 case SERVER_ALLOCATED_REQUIRED_YES:
41 if (usp->server_info == NULL) {
45 case SERVER_ALLOCATED_REQUIRED_NO:
46 if (usp->server_info != NULL) {
49 case SERVER_ALLOCATED_REQUIRED_ANY:
53 DLIST_PROMOTE(validated_users, usp);
62 /****************************************************************************
63 Check if a uid has been validated, and return an pointer to the user_struct
64 if it has. NULL if not. vuid is biased by an offset. This allows us to
65 tell random client vuid's (normally zero) from valid vuids.
66 ****************************************************************************/
68 user_struct *get_valid_user_struct(uint16 vuid)
70 return get_valid_user_struct_internal(vuid,
71 SERVER_ALLOCATED_REQUIRED_YES);
74 bool is_partial_auth_vuid(uint16 vuid)
76 return (get_partial_auth_user_struct(vuid) != NULL);
79 /****************************************************************************
80 Get the user struct of a partial NTLMSSP login
81 ****************************************************************************/
83 user_struct *get_partial_auth_user_struct(uint16 vuid)
85 return get_valid_user_struct_internal(vuid,
86 SERVER_ALLOCATED_REQUIRED_NO);
89 /****************************************************************************
91 ****************************************************************************/
93 void invalidate_vuid(uint16 vuid)
95 user_struct *vuser = NULL;
97 vuser = get_valid_user_struct_internal(vuid,
98 SERVER_ALLOCATED_REQUIRED_ANY);
103 session_yield(vuser);
105 if (vuser->auth_ntlmssp_state) {
106 auth_ntlmssp_end(&vuser->auth_ntlmssp_state);
109 DLIST_REMOVE(validated_users, vuser);
111 /* clear the vuid from the 'cache' on each connection, and
112 from the vuid 'owner' of connections */
113 conn_clear_vuid_caches(vuid);
116 num_validated_vuids--;
119 /****************************************************************************
120 Invalidate all vuid entries for this process.
121 ****************************************************************************/
123 void invalidate_all_vuids(void)
125 while (validated_users != NULL) {
126 invalidate_vuid(validated_users->vuid);
130 static void increment_next_vuid(uint16_t *vuid)
134 /* Check for vuid wrap. */
135 if (*vuid == UID_FIELD_INVALID) {
140 /****************************************************
141 Create a new partial auth user struct.
142 *****************************************************/
144 int register_initial_vuid(void)
148 /* Paranoia check. */
149 if(lp_security() == SEC_SHARE) {
150 smb_panic("register_initial_vuid: "
151 "Tried to register uid in security=share");
154 /* Limit allowed vuids to 16bits - VUID_OFFSET. */
155 if (num_validated_vuids >= 0xFFFF-VUID_OFFSET) {
156 return UID_FIELD_INVALID;
159 if((vuser = talloc_zero(NULL, user_struct)) == NULL) {
160 DEBUG(0,("register_initial_vuid: "
161 "Failed to talloc users struct!\n"));
162 return UID_FIELD_INVALID;
165 /* Allocate a free vuid. Yes this is a linear search... */
166 while( get_valid_user_struct_internal(next_vuid,
167 SERVER_ALLOCATED_REQUIRED_ANY) != NULL ) {
168 increment_next_vuid(&next_vuid);
171 DEBUG(10,("register_initial_vuid: allocated vuid = %u\n",
172 (unsigned int)next_vuid ));
174 vuser->vuid = next_vuid;
177 * This happens in an unfinished NTLMSSP session setup. We
178 * need to allocate a vuid between the first and second calls
181 increment_next_vuid(&next_vuid);
182 num_validated_vuids++;
184 DLIST_ADD(validated_users, vuser);
188 static int register_homes_share(const char *username)
193 result = lp_servicenumber(username);
195 DEBUG(3, ("Using static (or previously created) service for "
196 "user '%s'; path = '%s'\n", username,
197 lp_pathname(result)));
201 pwd = getpwnam_alloc(talloc_tos(), username);
203 if ((pwd == NULL) || (pwd->pw_dir[0] == '\0')) {
204 DEBUG(3, ("No home directory defined for user '%s'\n",
210 DEBUG(3, ("Adding homes service for user '%s' using home directory: "
211 "'%s'\n", username, pwd->pw_dir));
213 result = add_home_service(username, username, pwd->pw_dir);
220 * register that a valid login has been performed, establish 'session'.
221 * @param server_info The token returned from the authentication process.
222 * (now 'owned' by register_existing_vuid)
224 * @param session_key The User session key for the login session (now also
225 * 'owned' by register_existing_vuid)
227 * @param respose_blob The NT challenge-response, if available. (May be
228 * freed after this call)
230 * @param smb_name The untranslated name of the user
232 * @return Newly allocated vuid, biased by an offset. (This allows us to
233 * tell random client vuid's (normally zero) from valid vuids.)
237 int register_existing_vuid(uint16 vuid,
238 auth_serversupplied_info *server_info,
239 DATA_BLOB response_blob,
240 const char *smb_name)
245 vuser = get_partial_auth_user_struct(vuid);
250 /* Use this to keep tabs on all our info from the authentication */
251 vuser->server_info = talloc_move(vuser, &server_info);
253 /* This is a potentially untrusted username */
254 alpha_strcpy(tmp, smb_name, ". _-$", sizeof(tmp));
256 vuser->server_info->sanitized_username = talloc_strdup(
257 vuser->server_info, tmp);
259 DEBUG(10,("register_existing_vuid: (%u,%u) %s %s %s guest=%d\n",
260 (unsigned int)vuser->server_info->utok.uid,
261 (unsigned int)vuser->server_info->utok.gid,
262 vuser->server_info->unix_name,
263 vuser->server_info->sanitized_username,
264 pdb_get_domain(vuser->server_info->sam_account),
265 vuser->server_info->guest ));
267 DEBUG(3, ("register_existing_vuid: User name: %s\t"
268 "Real name: %s\n", vuser->server_info->unix_name,
269 pdb_get_fullname(vuser->server_info->sam_account)));
271 if (!vuser->server_info->ptok) {
272 DEBUG(1, ("register_existing_vuid: server_info does not "
273 "contain a user_token - cannot continue\n"));
277 DEBUG(3,("register_existing_vuid: UNIX uid %d is UNIX user %s, "
278 "and will be vuid %u\n", (int)vuser->server_info->utok.uid,
279 vuser->server_info->unix_name, vuser->vuid));
281 if (!session_claim(vuser)) {
282 DEBUG(1, ("register_existing_vuid: Failed to claim session "
288 /* Register a home dir service for this user if
289 (a) This is not a guest connection,
290 (b) we have a home directory defined
291 (c) there s not an existing static share by that name
292 If a share exists by this name (autoloaded or not) reuse it . */
294 vuser->homes_snum = -1;
296 if (!vuser->server_info->guest) {
297 vuser->homes_snum = register_homes_share(
298 vuser->server_info->unix_name);
301 if (srv_is_signing_negotiated() && !vuser->server_info->guest &&
302 !srv_signing_started()) {
303 /* Try and turn on server signing on the first non-guest
305 srv_set_signing(vuser->server_info->user_session_key, response_blob);
308 /* fill in the current_user_info struct */
309 set_current_user_info(
310 vuser->server_info->sanitized_username,
311 vuser->server_info->unix_name,
312 pdb_get_domain(vuser->server_info->sam_account));
319 invalidate_vuid(vuid);
321 return UID_FIELD_INVALID;
324 /****************************************************************************
325 Add a name to the session users list.
326 ****************************************************************************/
328 void add_session_user(const char *user)
333 pw = Get_Pwnam_alloc(talloc_tos(), user);
339 if (session_userlist == NULL) {
340 session_userlist = SMB_STRDUP(pw->pw_name);
344 if (in_list(pw->pw_name,session_userlist,False) ) {
348 if (strlen(session_userlist) > 128 * 1024) {
349 DEBUG(3,("add_session_user: session userlist already "
354 if (asprintf(&tmp, "%s %s", session_userlist, pw->pw_name) == -1) {
355 DEBUG(3, ("asprintf failed\n"));
359 SAFE_FREE(session_userlist);
360 session_userlist = tmp;
365 /****************************************************************************
366 In security=share mode we need to store the client workgroup, as that's
367 what Vista uses for the NTLMv2 calculation.
368 ****************************************************************************/
370 void add_session_workgroup(const char *workgroup)
372 if (session_workgroup) {
373 SAFE_FREE(session_workgroup);
375 session_workgroup = smb_xstrdup(workgroup);
378 /****************************************************************************
379 In security=share mode we need to return the client workgroup, as that's
380 what Vista uses for the NTLMv2 calculation.
381 ****************************************************************************/
383 const char *get_session_workgroup(void)
385 return session_workgroup;
388 /****************************************************************************
389 Check if a user is in a netgroup user list. If at first we don't succeed,
391 ****************************************************************************/
393 bool user_in_netgroup(const char *user, const char *ngname)
396 fstring lowercase_user;
398 if (my_yp_domain == NULL)
399 yp_get_default_domain(&my_yp_domain);
401 if(my_yp_domain == NULL) {
402 DEBUG(5,("Unable to get default yp domain, "
403 "let's try without specifying it\n"));
406 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
407 user, my_yp_domain?my_yp_domain:"(ANY)", ngname));
409 if (innetgr(ngname, NULL, user, my_yp_domain)) {
410 DEBUG(5,("user_in_netgroup: Found\n"));
415 * Ok, innetgr is case sensitive. Try once more with lowercase
416 * just in case. Attempt to fix #703. JRA.
419 fstrcpy(lowercase_user, user);
420 strlower_m(lowercase_user);
422 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
423 lowercase_user, my_yp_domain?my_yp_domain:"(ANY)", ngname));
425 if (innetgr(ngname, NULL, lowercase_user, my_yp_domain)) {
426 DEBUG(5,("user_in_netgroup: Found\n"));
430 #endif /* HAVE_NETGROUP */
434 /****************************************************************************
435 Check if a user is in a user list - can check combinations of UNIX
437 ****************************************************************************/
439 bool user_in_list(const char *user,const char **list)
444 DEBUG(10,("user_in_list: checking user %s in list\n", user));
448 DEBUG(10,("user_in_list: checking user |%s| against |%s|\n",
452 * Check raw username.
454 if (strequal(user, *list))
458 * Now check to see if any combination
459 * of UNIX and netgroups has been specified.
464 * Old behaviour. Check netgroup list
465 * followed by UNIX list.
467 if(user_in_netgroup(user, *list +1))
469 if(user_in_group(user, *list +1))
471 } else if (**list == '+') {
473 if((*(*list +1)) == '&') {
475 * Search UNIX list followed by netgroup.
477 if(user_in_group(user, *list +2))
479 if(user_in_netgroup(user, *list +2))
485 * Just search UNIX list.
488 if(user_in_group(user, *list +1))
492 } else if (**list == '&') {
494 if(*(*list +1) == '+') {
496 * Search netgroup list followed by UNIX list.
498 if(user_in_netgroup(user, *list +2))
500 if(user_in_group(user, *list +2))
504 * Just search netgroup list.
506 if(user_in_netgroup(user, *list +1))
516 /****************************************************************************
517 Check if a username is valid.
518 ****************************************************************************/
520 static bool user_ok(const char *user, int snum)
522 char **valid, **invalid;
525 valid = invalid = NULL;
528 if (lp_invalid_users(snum)) {
529 invalid = str_list_copy(talloc_tos(), lp_invalid_users(snum));
531 str_list_substitute(invalid, "%S", lp_servicename(snum))) {
533 /* This is used in sec=share only, so no current user
534 * around to pass to str_list_sub_basic() */
536 if ( invalid && str_list_sub_basic(invalid, "", "") ) {
537 ret = !user_in_list(user,
538 (const char **)invalid);
542 TALLOC_FREE(invalid);
544 if (ret && lp_valid_users(snum)) {
545 valid = str_list_copy(talloc_tos(), lp_valid_users(snum));
547 str_list_substitute(valid, "%S", lp_servicename(snum)) ) {
549 /* This is used in sec=share only, so no current user
550 * around to pass to str_list_sub_basic() */
552 if ( valid && str_list_sub_basic(valid, "", "") ) {
553 ret = user_in_list(user, (const char **)valid);
559 if (ret && lp_onlyuser(snum)) {
560 char **user_list = str_list_make_v3(
561 talloc_tos(), lp_username(snum), NULL);
563 str_list_substitute(user_list, "%S",
564 lp_servicename(snum))) {
565 ret = user_in_list(user, (const char **)user_list);
567 TALLOC_FREE(user_list);
573 /****************************************************************************
574 Validate a group username entry. Return the username or NULL.
575 ****************************************************************************/
577 static char *validate_group(char *group, DATA_BLOB password,int snum)
581 char *host, *user, *domain;
583 while (getnetgrent(&host, &user, &domain)) {
585 if (user_ok(user, snum) &&
586 password_ok(user,password)) {
600 while ((gptr = (struct group *)getgrent())) {
601 if (strequal(gptr->gr_name,group))
606 * As user_ok can recurse doing a getgrent(), we must
607 * copy the member list onto the heap before
608 * use. Bug pointed out by leon@eatworms.swmed.edu.
612 char *member_list = NULL;
617 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
618 list_len += strlen(gptr->gr_mem[i])+1;
622 member_list = (char *)SMB_MALLOC(list_len);
629 member = member_list;
631 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
632 size_t member_len = strlen(gptr->gr_mem[i])+1;
634 DEBUG(10,("validate_group: = gr_mem = "
635 "%s\n", gptr->gr_mem[i]));
637 safe_strcpy(member, gptr->gr_mem[i],
638 list_len - (member-member_list));
639 member += member_len;
644 member = member_list;
646 if (user_ok(member,snum) &&
647 password_ok(member,password)) {
648 char *name = talloc_strdup(talloc_tos(),
650 SAFE_FREE(member_list);
654 DEBUG(10,("validate_group = member = %s\n",
657 member += strlen(member) + 1;
660 SAFE_FREE(member_list);
670 /****************************************************************************
671 Check for authority to login to a service with a given username/password.
672 Note this is *NOT* used when logging on using sessionsetup_and_X.
673 ****************************************************************************/
675 bool authorise_login(int snum, fstring user, DATA_BLOB password,
680 #ifdef DEBUG_PASSWORD
681 DEBUG(100,("authorise_login: checking authorisation on "
682 "user=%s pass=%s\n", user,password.data));
687 /* there are several possibilities:
688 1) login as the given user with given password
689 2) login as a previously registered username with the given
691 3) login as a session list username with the given password
692 4) login as a previously validated user/password pair
693 5) login as the "user =" user with given password
694 6) login as the "user =" user with no password
696 7) login as guest user with no password
698 if the service is guest_only then steps 1 to 5 are skipped
701 /* now check the list of session users */
704 char *user_list = NULL;
707 if ( session_userlist )
708 user_list = SMB_STRDUP(session_userlist);
710 user_list = SMB_STRDUP("");
715 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
717 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
719 fstrcpy(user2,auser);
720 if (!user_ok(user2,snum))
723 if (password_ok(user2,password)) {
726 DEBUG(3,("authorise_login: ACCEPTED: session "
727 "list username (%s) and given "
728 "password ok\n", user));
732 SAFE_FREE(user_list);
735 /* check the user= fields and the given password */
736 if (!ok && lp_username(snum)) {
737 TALLOC_CTX *ctx = talloc_tos();
739 char *user_list = talloc_strdup(ctx, lp_username(snum));
746 user_list = talloc_string_sub(ctx,
749 lp_servicename(snum));
755 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
757 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
759 auser = validate_group(auser+1,password,snum);
763 DEBUG(3,("authorise_login: ACCEPTED: "
764 "group username and given "
765 "password ok (%s)\n", user));
769 fstrcpy(user2,auser);
770 if (user_ok(user2,snum) &&
771 password_ok(user2,password)) {
774 DEBUG(3,("authorise_login: ACCEPTED: "
775 "user list username and "
776 "given password ok (%s)\n",
785 /* check for a normal guest connection */
786 if (!ok && GUEST_OK(snum)) {
787 struct passwd *guest_pw;
789 fstrcpy(guestname,lp_guestaccount());
790 guest_pw = Get_Pwnam_alloc(talloc_tos(), guestname);
791 if (guest_pw != NULL) {
792 fstrcpy(user,guestname);
794 DEBUG(3,("authorise_login: ACCEPTED: guest account "
795 "and guest ok (%s)\n", user));
797 DEBUG(0,("authorise_login: Invalid guest account "
798 "%s??\n",guestname));
800 TALLOC_FREE(guest_pw);
804 if (ok && !user_ok(user, snum)) {
805 DEBUG(0,("authorise_login: rejected invalid user %s\n",user));