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 if (sconn->allow_smb2) {
135 while (sconn->smb1.sessions.validated_users != NULL) {
136 invalidate_vuid(sconn,
137 sconn->smb1.sessions.validated_users->vuid);
141 static void increment_next_vuid(uint16_t *vuid)
145 /* Check for vuid wrap. */
146 if (*vuid == UID_FIELD_INVALID) {
151 /****************************************************
152 Create a new partial auth user struct.
153 *****************************************************/
155 int register_initial_vuid(struct smbd_server_connection *sconn)
159 /* Paranoia check. */
160 if(lp_security() == SEC_SHARE) {
161 smb_panic("register_initial_vuid: "
162 "Tried to register uid in security=share");
165 /* Limit allowed vuids to 16bits - VUID_OFFSET. */
166 if (sconn->smb1.sessions.num_validated_vuids >= 0xFFFF-VUID_OFFSET) {
167 return UID_FIELD_INVALID;
170 if((vuser = talloc_zero(NULL, user_struct)) == NULL) {
171 DEBUG(0,("register_initial_vuid: "
172 "Failed to talloc users struct!\n"));
173 return UID_FIELD_INVALID;
176 /* Allocate a free vuid. Yes this is a linear search... */
177 while( get_valid_user_struct_internal(sconn,
178 sconn->smb1.sessions.next_vuid,
179 SERVER_ALLOCATED_REQUIRED_ANY) != NULL ) {
180 increment_next_vuid(&sconn->smb1.sessions.next_vuid);
183 DEBUG(10,("register_initial_vuid: allocated vuid = %u\n",
184 (unsigned int)sconn->smb1.sessions.next_vuid ));
186 vuser->vuid = sconn->smb1.sessions.next_vuid;
189 * This happens in an unfinished NTLMSSP session setup. We
190 * need to allocate a vuid between the first and second calls
193 increment_next_vuid(&sconn->smb1.sessions.next_vuid);
194 sconn->smb1.sessions.num_validated_vuids++;
196 DLIST_ADD(sconn->smb1.sessions.validated_users, vuser);
200 int register_homes_share(const char *username)
205 result = lp_servicenumber(username);
207 DEBUG(3, ("Using static (or previously created) service for "
208 "user '%s'; path = '%s'\n", username,
209 lp_pathname(result)));
213 pwd = getpwnam_alloc(talloc_tos(), username);
215 if ((pwd == NULL) || (pwd->pw_dir[0] == '\0')) {
216 DEBUG(3, ("No home directory defined for user '%s'\n",
222 DEBUG(3, ("Adding homes service for user '%s' using home directory: "
223 "'%s'\n", username, pwd->pw_dir));
225 result = add_home_service(username, username, pwd->pw_dir);
232 * register that a valid login has been performed, establish 'session'.
233 * @param server_info The token returned from the authentication process.
234 * (now 'owned' by register_existing_vuid)
236 * @param session_key The User session key for the login session (now also
237 * 'owned' by register_existing_vuid)
239 * @param respose_blob The NT challenge-response, if available. (May be
240 * freed after this call)
242 * @param smb_name The untranslated name of the user
244 * @return Newly allocated vuid, biased by an offset. (This allows us to
245 * tell random client vuid's (normally zero) from valid vuids.)
249 int register_existing_vuid(struct smbd_server_connection *sconn,
251 struct auth_serversupplied_info *server_info,
252 DATA_BLOB response_blob,
253 const char *smb_name)
258 vuser = get_partial_auth_user_struct(sconn, vuid);
263 /* Use this to keep tabs on all our info from the authentication */
264 vuser->server_info = talloc_move(vuser, &server_info);
266 /* This is a potentially untrusted username */
267 alpha_strcpy(tmp, smb_name, ". _-$", sizeof(tmp));
269 vuser->server_info->sanitized_username = talloc_strdup(
270 vuser->server_info, tmp);
272 DEBUG(10,("register_existing_vuid: (%u,%u) %s %s %s guest=%d\n",
273 (unsigned int)vuser->server_info->utok.uid,
274 (unsigned int)vuser->server_info->utok.gid,
275 vuser->server_info->unix_name,
276 vuser->server_info->sanitized_username,
277 vuser->server_info->info3->base.domain.string,
278 vuser->server_info->guest ));
280 DEBUG(3, ("register_existing_vuid: User name: %s\t"
281 "Real name: %s\n", vuser->server_info->unix_name,
282 vuser->server_info->info3->base.full_name.string));
284 if (!vuser->server_info->ptok) {
285 DEBUG(1, ("register_existing_vuid: server_info does not "
286 "contain a user_token - cannot continue\n"));
290 DEBUG(3,("register_existing_vuid: UNIX uid %d is UNIX user %s, "
291 "and will be vuid %u\n", (int)vuser->server_info->utok.uid,
292 vuser->server_info->unix_name, vuser->vuid));
294 if (!session_claim(vuser)) {
295 DEBUG(1, ("register_existing_vuid: Failed to claim session "
301 /* Register a home dir service for this user if
302 (a) This is not a guest connection,
303 (b) we have a home directory defined
304 (c) there s not an existing static share by that name
305 If a share exists by this name (autoloaded or not) reuse it . */
307 vuser->homes_snum = -1;
309 if (!vuser->server_info->guest) {
310 vuser->homes_snum = register_homes_share(
311 vuser->server_info->unix_name);
314 if (srv_is_signing_negotiated(smbd_server_conn) &&
315 !vuser->server_info->guest) {
316 /* Try and turn on server signing on the first non-guest
318 srv_set_signing(smbd_server_conn,
319 vuser->server_info->user_session_key,
323 /* fill in the current_user_info struct */
324 set_current_user_info(
325 vuser->server_info->sanitized_username,
326 vuser->server_info->unix_name,
327 vuser->server_info->info3->base.domain.string);
334 invalidate_vuid(sconn, vuid);
336 return UID_FIELD_INVALID;
339 /****************************************************************************
340 Add a name to the session users list.
341 ****************************************************************************/
343 void add_session_user(struct smbd_server_connection *sconn,
349 pw = Get_Pwnam_alloc(talloc_tos(), user);
355 if (sconn->smb1.sessions.session_userlist == NULL) {
356 sconn->smb1.sessions.session_userlist = SMB_STRDUP(pw->pw_name);
360 if (in_list(pw->pw_name,sconn->smb1.sessions.session_userlist,false)) {
364 if (strlen(sconn->smb1.sessions.session_userlist) > 128 * 1024) {
365 DEBUG(3,("add_session_user: session userlist already "
370 if (asprintf(&tmp, "%s %s",
371 sconn->smb1.sessions.session_userlist, pw->pw_name) == -1) {
372 DEBUG(3, ("asprintf failed\n"));
376 SAFE_FREE(sconn->smb1.sessions.session_userlist);
377 sconn->smb1.sessions.session_userlist = tmp;
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(struct smbd_server_connection *sconn,
388 const char *workgroup)
390 if (sconn->smb1.sessions.session_workgroup) {
391 SAFE_FREE(sconn->smb1.sessions.session_workgroup);
393 sconn->smb1.sessions.session_workgroup = smb_xstrdup(workgroup);
396 /****************************************************************************
397 In security=share mode we need to return the client workgroup, as that's
398 what Vista uses for the NTLMv2 calculation.
399 ****************************************************************************/
401 const char *get_session_workgroup(struct smbd_server_connection *sconn)
403 return sconn->smb1.sessions.session_workgroup;
406 /****************************************************************************
407 Check if a user is in a netgroup user list. If at first we don't succeed,
409 ****************************************************************************/
411 bool user_in_netgroup(const char *user, const char *ngname)
414 static char *my_yp_domain = NULL;
415 fstring lowercase_user;
417 if (my_yp_domain == NULL) {
418 yp_get_default_domain(&my_yp_domain);
421 if (my_yp_domain == NULL) {
422 DEBUG(5,("Unable to get default yp domain, "
423 "let's try without specifying it\n"));
426 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
427 user, my_yp_domain?my_yp_domain:"(ANY)", ngname));
429 if (innetgr(ngname, NULL, user, my_yp_domain)) {
430 DEBUG(5,("user_in_netgroup: Found\n"));
435 * Ok, innetgr is case sensitive. Try once more with lowercase
436 * just in case. Attempt to fix #703. JRA.
438 fstrcpy(lowercase_user, user);
439 strlower_m(lowercase_user);
441 if (strcmp(user,lowercase_user) == 0) {
442 /* user name was already lower case! */
446 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
447 lowercase_user, my_yp_domain?my_yp_domain:"(ANY)", ngname));
449 if (innetgr(ngname, NULL, lowercase_user, my_yp_domain)) {
450 DEBUG(5,("user_in_netgroup: Found\n"));
453 #endif /* HAVE_NETGROUP */
457 /****************************************************************************
458 Check if a user is in a user list - can check combinations of UNIX
460 ****************************************************************************/
462 bool user_in_list(const char *user,const char **list)
467 DEBUG(10,("user_in_list: checking user %s in list\n", user));
471 DEBUG(10,("user_in_list: checking user |%s| against |%s|\n",
475 * Check raw username.
477 if (strequal(user, *list))
481 * Now check to see if any combination
482 * of UNIX and netgroups has been specified.
487 * Old behaviour. Check netgroup list
488 * followed by UNIX list.
490 if(user_in_netgroup(user, *list +1))
492 if(user_in_group(user, *list +1))
494 } else if (**list == '+') {
496 if((*(*list +1)) == '&') {
498 * Search UNIX list followed by netgroup.
500 if(user_in_group(user, *list +2))
502 if(user_in_netgroup(user, *list +2))
508 * Just search UNIX list.
511 if(user_in_group(user, *list +1))
515 } else if (**list == '&') {
517 if(*(*list +1) == '+') {
519 * Search netgroup list followed by UNIX list.
521 if(user_in_netgroup(user, *list +2))
523 if(user_in_group(user, *list +2))
527 * Just search netgroup list.
529 if(user_in_netgroup(user, *list +1))
539 /****************************************************************************
540 Check if a username is valid.
541 ****************************************************************************/
543 static bool user_ok(struct smbd_server_connection *sconn,
544 const char *user, int snum)
550 if (lp_invalid_users(snum)) {
551 char **invalid = str_list_copy(talloc_tos(),
552 lp_invalid_users(snum));
554 str_list_substitute(invalid, "%S", lp_servicename(snum))) {
556 /* This is used in sec=share only, so no current user
557 * around to pass to str_list_sub_basic() */
559 if ( invalid && str_list_sub_basic(invalid, "", "") ) {
560 ret = !user_in_list(user,
561 (const char **)invalid);
564 TALLOC_FREE(invalid);
567 if (ret && lp_valid_users(snum)) {
568 char **valid = str_list_copy(talloc_tos(),
569 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,
578 (const char **)valid);
584 if (ret && lp_onlyuser(snum)) {
585 char **user_list = str_list_make_v3(
586 talloc_tos(), lp_username(snum), NULL);
588 str_list_substitute(user_list, "%S",
589 lp_servicename(snum))) {
590 ret = user_in_list(user,
591 (const char **)user_list);
593 TALLOC_FREE(user_list);
599 /****************************************************************************
600 Validate a group username entry. Return the username or NULL.
601 ****************************************************************************/
603 static char *validate_group(struct smbd_server_connection *sconn,
604 char *group, DATA_BLOB password,int snum)
608 char *host, *user, *domain;
609 struct auth_context *actx = sconn->smb1.negprot.auth_context;
610 bool enc = sconn->smb1.negprot.encrypted_passwords;
612 while (getnetgrent(&host, &user, &domain)) {
614 if (user_ok(sconn, user, snum) &&
615 password_ok(actx, enc,
616 get_session_workgroup(sconn),
630 struct auth_context *actx = sconn->smb1.negprot.auth_context;
631 bool enc = sconn->smb1.negprot.encrypted_passwords;
634 while ((gptr = (struct group *)getgrent())) {
635 if (strequal(gptr->gr_name,group))
640 * As user_ok can recurse doing a getgrent(), we must
641 * copy the member list onto the heap before
642 * use. Bug pointed out by leon@eatworms.swmed.edu.
646 char *member_list = NULL;
651 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
652 list_len += strlen(gptr->gr_mem[i])+1;
656 member_list = (char *)SMB_MALLOC(list_len);
663 member = member_list;
665 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
666 size_t member_len = strlen(gptr->gr_mem[i])+1;
668 DEBUG(10,("validate_group: = gr_mem = "
669 "%s\n", gptr->gr_mem[i]));
671 safe_strcpy(member, gptr->gr_mem[i],
672 list_len - (member-member_list));
673 member += member_len;
678 member = member_list;
680 if (user_ok(sconn, member,snum) &&
681 password_ok(actx, enc,
682 get_session_workgroup(sconn),
684 char *name = talloc_strdup(talloc_tos(),
686 SAFE_FREE(member_list);
690 DEBUG(10,("validate_group = member = %s\n",
693 member += strlen(member) + 1;
696 SAFE_FREE(member_list);
706 /****************************************************************************
707 Check for authority to login to a service with a given username/password.
708 Note this is *NOT* used when logging on using sessionsetup_and_X.
709 ****************************************************************************/
711 bool authorise_login(struct smbd_server_connection *sconn,
712 int snum, fstring user, DATA_BLOB password,
716 struct auth_context *actx = sconn->smb1.negprot.auth_context;
717 bool enc = sconn->smb1.negprot.encrypted_passwords;
719 #ifdef DEBUG_PASSWORD
720 DEBUG(100,("authorise_login: checking authorisation on "
721 "user=%s pass=%s\n", user,password.data));
726 /* there are several possibilities:
727 1) login as the given user with given password
728 2) login as a previously registered username with the given
730 3) login as a session list username with the given password
731 4) login as a previously validated user/password pair
732 5) login as the "user =" user with given password
733 6) login as the "user =" user with no password
735 7) login as guest user with no password
737 if the service is guest_only then steps 1 to 5 are skipped
740 /* now check the list of session users */
743 char *user_list = NULL;
746 if (sconn->smb1.sessions.session_userlist)
747 user_list = SMB_STRDUP(sconn->smb1.sessions.session_userlist);
749 user_list = SMB_STRDUP("");
754 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
756 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
758 fstrcpy(user2,auser);
759 if (!user_ok(sconn,user2,snum))
762 if (password_ok(actx, enc,
763 get_session_workgroup(sconn),
767 DEBUG(3,("authorise_login: ACCEPTED: session "
768 "list username (%s) and given "
769 "password ok\n", user));
773 SAFE_FREE(user_list);
776 /* check the user= fields and the given password */
777 if (!ok && lp_username(snum)) {
778 TALLOC_CTX *ctx = talloc_tos();
780 char *user_list = talloc_strdup(ctx, lp_username(snum));
787 user_list = talloc_string_sub(ctx,
790 lp_servicename(snum));
796 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
798 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
800 auser = validate_group(sconn,auser+1,
805 DEBUG(3,("authorise_login: ACCEPTED: "
806 "group username and given "
807 "password ok (%s)\n", user));
811 fstrcpy(user2,auser);
812 if (user_ok(sconn,user2,snum) &&
813 password_ok(actx, enc,
814 get_session_workgroup(sconn),
818 DEBUG(3,("authorise_login: ACCEPTED: "
819 "user list username and "
820 "given password ok (%s)\n",
829 /* check for a normal guest connection */
830 if (!ok && GUEST_OK(snum)) {
831 struct passwd *guest_pw;
833 fstrcpy(guestname,lp_guestaccount());
834 guest_pw = Get_Pwnam_alloc(talloc_tos(), guestname);
835 if (guest_pw != NULL) {
836 fstrcpy(user,guestname);
838 DEBUG(3,("authorise_login: ACCEPTED: guest account "
839 "and guest ok (%s)\n", user));
841 DEBUG(0,("authorise_login: Invalid guest account "
842 "%s??\n",guestname));
844 TALLOC_FREE(guest_pw);
848 if (ok && !user_ok(sconn, user, snum)) {
849 DEBUG(0,("authorise_login: rejected invalid user %s\n",user));