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(
29 struct smbd_server_connection *sconn,
31 enum server_allocated_state server_allocated)
36 if (vuid == UID_FIELD_INVALID)
39 usp=sconn->smb1.sessions.validated_users;
40 for (;usp;usp=usp->next,count++) {
41 if (vuid == usp->vuid) {
42 switch (server_allocated) {
43 case SERVER_ALLOCATED_REQUIRED_YES:
44 if (usp->server_info == NULL) {
48 case SERVER_ALLOCATED_REQUIRED_NO:
49 if (usp->server_info != NULL) {
52 case SERVER_ALLOCATED_REQUIRED_ANY:
56 DLIST_PROMOTE(sconn->smb1.sessions.validated_users,
66 /****************************************************************************
67 Check if a uid has been validated, and return an pointer to the user_struct
68 if it has. NULL if not. vuid is biased by an offset. This allows us to
69 tell random client vuid's (normally zero) from valid vuids.
70 ****************************************************************************/
72 user_struct *get_valid_user_struct(struct smbd_server_connection *sconn,
75 return get_valid_user_struct_internal(sconn, vuid,
76 SERVER_ALLOCATED_REQUIRED_YES);
79 bool is_partial_auth_vuid(struct smbd_server_connection *sconn, uint16 vuid)
81 return (get_partial_auth_user_struct(sconn, vuid) != NULL);
84 /****************************************************************************
85 Get the user struct of a partial NTLMSSP login
86 ****************************************************************************/
88 user_struct *get_partial_auth_user_struct(struct smbd_server_connection *sconn,
91 return get_valid_user_struct_internal(sconn, vuid,
92 SERVER_ALLOCATED_REQUIRED_NO);
95 /****************************************************************************
97 ****************************************************************************/
99 void invalidate_vuid(struct smbd_server_connection *sconn, uint16 vuid)
101 user_struct *vuser = NULL;
103 vuser = get_valid_user_struct_internal(sconn, vuid,
104 SERVER_ALLOCATED_REQUIRED_ANY);
109 session_yield(vuser);
111 if (vuser->auth_ntlmssp_state) {
112 auth_ntlmssp_end(&vuser->auth_ntlmssp_state);
115 DLIST_REMOVE(sconn->smb1.sessions.validated_users, vuser);
117 /* clear the vuid from the 'cache' on each connection, and
118 from the vuid 'owner' of connections */
119 conn_clear_vuid_caches(sconn, vuid);
122 sconn->smb1.sessions.num_validated_vuids--;
125 /****************************************************************************
126 Invalidate all vuid entries for this process.
127 ****************************************************************************/
129 void invalidate_all_vuids(struct smbd_server_connection *sconn)
131 while (sconn->smb1.sessions.validated_users != NULL) {
132 invalidate_vuid(sconn,
133 sconn->smb1.sessions.validated_users->vuid);
137 static void increment_next_vuid(uint16_t *vuid)
141 /* Check for vuid wrap. */
142 if (*vuid == UID_FIELD_INVALID) {
147 /****************************************************
148 Create a new partial auth user struct.
149 *****************************************************/
151 int register_initial_vuid(struct smbd_server_connection *sconn)
155 /* Paranoia check. */
156 if(lp_security() == SEC_SHARE) {
157 smb_panic("register_initial_vuid: "
158 "Tried to register uid in security=share");
161 /* Limit allowed vuids to 16bits - VUID_OFFSET. */
162 if (sconn->smb1.sessions.num_validated_vuids >= 0xFFFF-VUID_OFFSET) {
163 return UID_FIELD_INVALID;
166 if((vuser = talloc_zero(NULL, user_struct)) == NULL) {
167 DEBUG(0,("register_initial_vuid: "
168 "Failed to talloc users struct!\n"));
169 return UID_FIELD_INVALID;
172 /* Allocate a free vuid. Yes this is a linear search... */
173 while( get_valid_user_struct_internal(sconn,
174 sconn->smb1.sessions.next_vuid,
175 SERVER_ALLOCATED_REQUIRED_ANY) != NULL ) {
176 increment_next_vuid(&sconn->smb1.sessions.next_vuid);
179 DEBUG(10,("register_initial_vuid: allocated vuid = %u\n",
180 (unsigned int)sconn->smb1.sessions.next_vuid ));
182 vuser->vuid = sconn->smb1.sessions.next_vuid;
185 * This happens in an unfinished NTLMSSP session setup. We
186 * need to allocate a vuid between the first and second calls
189 increment_next_vuid(&sconn->smb1.sessions.next_vuid);
190 sconn->smb1.sessions.num_validated_vuids++;
192 DLIST_ADD(sconn->smb1.sessions.validated_users, vuser);
196 static int register_homes_share(const char *username)
201 result = lp_servicenumber(username);
203 DEBUG(3, ("Using static (or previously created) service for "
204 "user '%s'; path = '%s'\n", username,
205 lp_pathname(result)));
209 pwd = getpwnam_alloc(talloc_tos(), username);
211 if ((pwd == NULL) || (pwd->pw_dir[0] == '\0')) {
212 DEBUG(3, ("No home directory defined for user '%s'\n",
218 DEBUG(3, ("Adding homes service for user '%s' using home directory: "
219 "'%s'\n", username, pwd->pw_dir));
221 result = add_home_service(username, username, pwd->pw_dir);
228 * register that a valid login has been performed, establish 'session'.
229 * @param server_info The token returned from the authentication process.
230 * (now 'owned' by register_existing_vuid)
232 * @param session_key The User session key for the login session (now also
233 * 'owned' by register_existing_vuid)
235 * @param respose_blob The NT challenge-response, if available. (May be
236 * freed after this call)
238 * @param smb_name The untranslated name of the user
240 * @return Newly allocated vuid, biased by an offset. (This allows us to
241 * tell random client vuid's (normally zero) from valid vuids.)
245 int register_existing_vuid(struct smbd_server_connection *sconn,
247 auth_serversupplied_info *server_info,
248 DATA_BLOB response_blob,
249 const char *smb_name)
254 vuser = get_partial_auth_user_struct(sconn, 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(smbd_server_conn) &&
311 !vuser->server_info->guest) {
312 /* Try and turn on server signing on the first non-guest
314 srv_set_signing(smbd_server_conn,
315 vuser->server_info->user_session_key,
319 /* fill in the current_user_info struct */
320 set_current_user_info(
321 vuser->server_info->sanitized_username,
322 vuser->server_info->unix_name,
323 pdb_get_domain(vuser->server_info->sam_account));
330 invalidate_vuid(sconn, vuid);
332 return UID_FIELD_INVALID;
335 /****************************************************************************
336 Add a name to the session users list.
337 ****************************************************************************/
339 void add_session_user(struct smbd_server_connection *sconn,
345 pw = Get_Pwnam_alloc(talloc_tos(), user);
351 if (sconn->smb1.sessions.session_userlist == NULL) {
352 sconn->smb1.sessions.session_userlist = SMB_STRDUP(pw->pw_name);
356 if (in_list(pw->pw_name,sconn->smb1.sessions.session_userlist,false)) {
360 if (strlen(sconn->smb1.sessions.session_userlist) > 128 * 1024) {
361 DEBUG(3,("add_session_user: session userlist already "
366 if (asprintf(&tmp, "%s %s",
367 sconn->smb1.sessions.session_userlist, pw->pw_name) == -1) {
368 DEBUG(3, ("asprintf failed\n"));
372 SAFE_FREE(sconn->smb1.sessions.session_userlist);
373 sconn->smb1.sessions.session_userlist = tmp;
378 /****************************************************************************
379 In security=share mode we need to store the client workgroup, as that's
380 what Vista uses for the NTLMv2 calculation.
381 ****************************************************************************/
383 void add_session_workgroup(struct smbd_server_connection *sconn,
384 const char *workgroup)
386 if (sconn->smb1.sessions.session_workgroup) {
387 SAFE_FREE(sconn->smb1.sessions.session_workgroup);
389 sconn->smb1.sessions.session_workgroup = smb_xstrdup(workgroup);
392 /****************************************************************************
393 In security=share mode we need to return the client workgroup, as that's
394 what Vista uses for the NTLMv2 calculation.
395 ****************************************************************************/
397 const char *get_session_workgroup(struct smbd_server_connection *sconn)
399 return sconn->smb1.sessions.session_workgroup;
402 /****************************************************************************
403 Check if a user is in a netgroup user list. If at first we don't succeed,
405 ****************************************************************************/
407 bool user_in_netgroup(struct smbd_server_connection *sconn,
408 const char *user, const char *ngname)
411 fstring lowercase_user;
413 if (sconn->smb1.sessions.my_yp_domain == NULL) {
414 yp_get_default_domain(&sconn->smb1.sessions.my_yp_domain);
417 if (sconn->smb1.sessions.my_yp_domain == NULL) {
418 DEBUG(5,("Unable to get default yp domain, "
419 "let's try without specifying it\n"));
422 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
424 sconn->smb1.sessions.my_yp_domain?
425 sconn->smb1.sessions.my_yp_domain:"(ANY)",
428 if (innetgr(ngname, NULL, user, sconn->smb1.sessions.my_yp_domain)) {
429 DEBUG(5,("user_in_netgroup: Found\n"));
434 * Ok, innetgr is case sensitive. Try once more with lowercase
435 * just in case. Attempt to fix #703. JRA.
437 fstrcpy(lowercase_user, user);
438 strlower_m(lowercase_user);
440 if (strcmp(user,lowercase_user) == 0) {
441 /* user name was already lower case! */
445 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
447 sconn->smb1.sessions.my_yp_domain?
448 sconn->smb1.sessions.my_yp_domain:"(ANY)",
451 if (innetgr(ngname, NULL, lowercase_user,
452 sconn->smb1.sessions.my_yp_domain)) {
453 DEBUG(5,("user_in_netgroup: Found\n"));
456 #endif /* HAVE_NETGROUP */
460 /****************************************************************************
461 Check if a user is in a user list - can check combinations of UNIX
463 ****************************************************************************/
465 bool user_in_list(struct smbd_server_connection *sconn,
466 const char *user,const char **list)
471 DEBUG(10,("user_in_list: checking user %s in list\n", user));
475 DEBUG(10,("user_in_list: checking user |%s| against |%s|\n",
479 * Check raw username.
481 if (strequal(user, *list))
485 * Now check to see if any combination
486 * of UNIX and netgroups has been specified.
491 * Old behaviour. Check netgroup list
492 * followed by UNIX list.
494 if(user_in_netgroup(sconn, user, *list +1))
496 if(user_in_group(user, *list +1))
498 } else if (**list == '+') {
500 if((*(*list +1)) == '&') {
502 * Search UNIX list followed by netgroup.
504 if(user_in_group(user, *list +2))
506 if(user_in_netgroup(sconn, user, *list +2))
512 * Just search UNIX list.
515 if(user_in_group(user, *list +1))
519 } else if (**list == '&') {
521 if(*(*list +1) == '+') {
523 * Search netgroup list followed by UNIX list.
525 if(user_in_netgroup(sconn, user, *list +2))
527 if(user_in_group(user, *list +2))
531 * Just search netgroup list.
533 if(user_in_netgroup(sconn, user, *list +1))
543 /****************************************************************************
544 Check if a username is valid.
545 ****************************************************************************/
547 static bool user_ok(struct smbd_server_connection *sconn,
548 const char *user, int snum)
550 char **valid, **invalid;
553 valid = invalid = NULL;
556 if (lp_invalid_users(snum)) {
557 invalid = str_list_copy(talloc_tos(), lp_invalid_users(snum));
559 str_list_substitute(invalid, "%S", lp_servicename(snum))) {
561 /* This is used in sec=share only, so no current user
562 * around to pass to str_list_sub_basic() */
564 if ( invalid && str_list_sub_basic(invalid, "", "") ) {
565 ret = !user_in_list(sconn, user,
566 (const char **)invalid);
570 TALLOC_FREE(invalid);
572 if (ret && lp_valid_users(snum)) {
573 valid = str_list_copy(talloc_tos(), lp_valid_users(snum));
575 str_list_substitute(valid, "%S", lp_servicename(snum)) ) {
577 /* This is used in sec=share only, so no current user
578 * around to pass to str_list_sub_basic() */
580 if ( valid && str_list_sub_basic(valid, "", "") ) {
581 ret = user_in_list(sconn, user,
582 (const char **)valid);
588 if (ret && lp_onlyuser(snum)) {
589 char **user_list = str_list_make_v3(
590 talloc_tos(), lp_username(snum), NULL);
592 str_list_substitute(user_list, "%S",
593 lp_servicename(snum))) {
594 ret = user_in_list(sconn, user,
595 (const char **)user_list);
597 TALLOC_FREE(user_list);
603 /****************************************************************************
604 Validate a group username entry. Return the username or NULL.
605 ****************************************************************************/
607 static char *validate_group(struct smbd_server_connection *sconn,
608 char *group, DATA_BLOB password,int snum)
612 char *host, *user, *domain;
613 struct auth_context *actx = sconn->smb1.negprot.auth_context;
614 bool enc = sconn->smb1.negprot.encrypted_passwords;
616 while (getnetgrent(&host, &user, &domain)) {
618 if (user_ok(sconn, user, snum) &&
619 password_ok(actx, enc,
620 get_session_workgroup(sconn),
634 struct auth_context *actx = sconn->smb1.negprot.auth_context;
635 bool enc = sconn->smb1.negprot.encrypted_passwords;
638 while ((gptr = (struct group *)getgrent())) {
639 if (strequal(gptr->gr_name,group))
644 * As user_ok can recurse doing a getgrent(), we must
645 * copy the member list onto the heap before
646 * use. Bug pointed out by leon@eatworms.swmed.edu.
650 char *member_list = NULL;
655 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
656 list_len += strlen(gptr->gr_mem[i])+1;
660 member_list = (char *)SMB_MALLOC(list_len);
667 member = member_list;
669 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
670 size_t member_len = strlen(gptr->gr_mem[i])+1;
672 DEBUG(10,("validate_group: = gr_mem = "
673 "%s\n", gptr->gr_mem[i]));
675 safe_strcpy(member, gptr->gr_mem[i],
676 list_len - (member-member_list));
677 member += member_len;
682 member = member_list;
684 if (user_ok(sconn, member,snum) &&
685 password_ok(actx, enc,
686 get_session_workgroup(sconn),
688 char *name = talloc_strdup(talloc_tos(),
690 SAFE_FREE(member_list);
694 DEBUG(10,("validate_group = member = %s\n",
697 member += strlen(member) + 1;
700 SAFE_FREE(member_list);
710 /****************************************************************************
711 Check for authority to login to a service with a given username/password.
712 Note this is *NOT* used when logging on using sessionsetup_and_X.
713 ****************************************************************************/
715 bool authorise_login(struct smbd_server_connection *sconn,
716 int snum, fstring user, DATA_BLOB password,
720 struct auth_context *actx = sconn->smb1.negprot.auth_context;
721 bool enc = sconn->smb1.negprot.encrypted_passwords;
723 #ifdef DEBUG_PASSWORD
724 DEBUG(100,("authorise_login: checking authorisation on "
725 "user=%s pass=%s\n", user,password.data));
730 /* there are several possibilities:
731 1) login as the given user with given password
732 2) login as a previously registered username with the given
734 3) login as a session list username with the given password
735 4) login as a previously validated user/password pair
736 5) login as the "user =" user with given password
737 6) login as the "user =" user with no password
739 7) login as guest user with no password
741 if the service is guest_only then steps 1 to 5 are skipped
744 /* now check the list of session users */
747 char *user_list = NULL;
750 if (sconn->smb1.sessions.session_userlist)
751 user_list = SMB_STRDUP(sconn->smb1.sessions.session_userlist);
753 user_list = SMB_STRDUP("");
758 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
760 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
762 fstrcpy(user2,auser);
763 if (!user_ok(sconn,user2,snum))
766 if (password_ok(actx, enc,
767 get_session_workgroup(sconn),
771 DEBUG(3,("authorise_login: ACCEPTED: session "
772 "list username (%s) and given "
773 "password ok\n", user));
777 SAFE_FREE(user_list);
780 /* check the user= fields and the given password */
781 if (!ok && lp_username(snum)) {
782 TALLOC_CTX *ctx = talloc_tos();
784 char *user_list = talloc_strdup(ctx, lp_username(snum));
791 user_list = talloc_string_sub(ctx,
794 lp_servicename(snum));
800 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
802 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
804 auser = validate_group(sconn,auser+1,
809 DEBUG(3,("authorise_login: ACCEPTED: "
810 "group username and given "
811 "password ok (%s)\n", user));
815 fstrcpy(user2,auser);
816 if (user_ok(sconn,user2,snum) &&
817 password_ok(actx, enc,
818 get_session_workgroup(sconn),
822 DEBUG(3,("authorise_login: ACCEPTED: "
823 "user list username and "
824 "given password ok (%s)\n",
833 /* check for a normal guest connection */
834 if (!ok && GUEST_OK(snum)) {
835 struct passwd *guest_pw;
837 fstrcpy(guestname,lp_guestaccount());
838 guest_pw = Get_Pwnam_alloc(talloc_tos(), guestname);
839 if (guest_pw != NULL) {
840 fstrcpy(user,guestname);
842 DEBUG(3,("authorise_login: ACCEPTED: guest account "
843 "and guest ok (%s)\n", user));
845 DEBUG(0,("authorise_login: Invalid guest account "
846 "%s??\n",guestname));
848 TALLOC_FREE(guest_pw);
852 if (ok && !user_ok(sconn, user, snum)) {
853 DEBUG(0,("authorise_login: rejected invalid user %s\n",user));