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 /* the next functions should be done by a SID mapping system (SMS) as
273 * the new real sam db won't have reference to unix uids or gids
276 vuser->uid = server_info->uid;
277 vuser->gid = server_info->gid;
279 vuser->n_groups = server_info->n_groups;
280 if (vuser->n_groups) {
281 if (!(vuser->groups = (gid_t *)talloc_memdup(vuser,
283 sizeof(gid_t)*vuser->n_groups))) {
284 DEBUG(0,("register_existing_vuid: "
285 "failed to talloc_memdup vuser->groups\n"));
290 vuser->guest = server_info->guest;
291 fstrcpy(vuser->user.unix_name, server_info->unix_name);
293 /* This is a potentially untrusted username */
294 alpha_strcpy(vuser->user.smb_name, smb_name, ". _-$",
295 sizeof(vuser->user.smb_name));
297 fstrcpy(vuser->user.domain, pdb_get_domain(server_info->sam_account));
298 fstrcpy(vuser->user.full_name,
299 pdb_get_fullname(server_info->sam_account));
302 const char *logon_script =
303 pdb_get_logon_script(server_info->sam_account);
306 vuser->logon_script = logon_script;
309 vuser->session_key = session_key;
311 DEBUG(10,("register_existing_vuid: (%u,%u) %s %s %s guest=%d\n",
312 (unsigned int)vuser->uid,
313 (unsigned int)vuser->gid,
314 vuser->user.unix_name, vuser->user.smb_name,
315 vuser->user.domain, vuser->guest ));
317 DEBUG(3, ("register_existing_vuid: User name: %s\t"
318 "Real name: %s\n", vuser->user.unix_name,
319 vuser->user.full_name));
321 if (server_info->ptok) {
322 vuser->nt_user_token = dup_nt_token(vuser, server_info->ptok);
324 DEBUG(1, ("register_existing_vuid: server_info does not "
325 "contain a user_token - cannot continue\n"));
329 DEBUG(3,("register_existing_vuid: UNIX uid %d is UNIX user %s, "
330 "and will be vuid %u\n",
331 (int)vuser->uid,vuser->user.unix_name, vuser->vuid));
334 num_validated_vuids++;
336 if (!session_claim(vuser)) {
337 DEBUG(1, ("register_existing_vuid: Failed to claim session "
343 /* Register a home dir service for this user if
344 (a) This is not a guest connection,
345 (b) we have a home directory defined
346 (c) there s not an existing static share by that name
347 If a share exists by this name (autoloaded or not) reuse it . */
349 vuser->homes_snum = -1;
352 vuser->homes_snum = register_homes_share(
353 vuser->user.unix_name);
356 if (srv_is_signing_negotiated() && !vuser->guest &&
357 !srv_signing_started()) {
358 /* Try and turn on server signing on the first non-guest
360 srv_set_signing(vuser->session_key, response_blob);
363 /* fill in the current_user_info struct */
364 set_current_user_info( &vuser->user );
370 invalidate_vuid(vuid);
372 return UID_FIELD_INVALID;
375 /****************************************************************************
376 Add a name to the session users list.
377 ****************************************************************************/
379 void add_session_user(const char *user)
384 pw = Get_Pwnam_alloc(talloc_tos(), user);
390 if (session_userlist == NULL) {
391 session_userlist = SMB_STRDUP(pw->pw_name);
395 if (in_list(pw->pw_name,session_userlist,False) ) {
399 if (strlen(session_userlist) > 128 * 1024) {
400 DEBUG(3,("add_session_user: session userlist already "
405 if (asprintf(&tmp, "%s %s", session_userlist, pw->pw_name) == -1) {
406 DEBUG(3, ("asprintf failed\n"));
410 SAFE_FREE(session_userlist);
411 session_userlist = tmp;
416 /****************************************************************************
417 In security=share mode we need to store the client workgroup, as that's
418 what Vista uses for the NTLMv2 calculation.
419 ****************************************************************************/
421 void add_session_workgroup(const char *workgroup)
423 if (session_workgroup) {
424 SAFE_FREE(session_workgroup);
426 session_workgroup = smb_xstrdup(workgroup);
429 /****************************************************************************
430 In security=share mode we need to return the client workgroup, as that's
431 what Vista uses for the NTLMv2 calculation.
432 ****************************************************************************/
434 const char *get_session_workgroup(void)
436 return session_workgroup;
439 /****************************************************************************
440 Check if a user is in a netgroup user list. If at first we don't succeed,
442 ****************************************************************************/
444 bool user_in_netgroup(const char *user, const char *ngname)
447 static char *mydomain = NULL;
448 fstring lowercase_user;
450 if (mydomain == NULL)
451 yp_get_default_domain(&mydomain);
453 if(mydomain == NULL) {
454 DEBUG(5,("Unable to get default yp domain, "
455 "let's try without specifying it\n"));
458 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
459 user, mydomain?mydomain:"(ANY)", ngname));
461 if (innetgr(ngname, NULL, user, mydomain)) {
462 DEBUG(5,("user_in_netgroup: Found\n"));
467 * Ok, innetgr is case sensitive. Try once more with lowercase
468 * just in case. Attempt to fix #703. JRA.
471 fstrcpy(lowercase_user, user);
472 strlower_m(lowercase_user);
474 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
475 lowercase_user, mydomain?mydomain:"(ANY)", ngname));
477 if (innetgr(ngname, NULL, lowercase_user, mydomain)) {
478 DEBUG(5,("user_in_netgroup: Found\n"));
482 #endif /* HAVE_NETGROUP */
486 /****************************************************************************
487 Check if a user is in a user list - can check combinations of UNIX
489 ****************************************************************************/
491 bool user_in_list(const char *user,const char **list)
496 DEBUG(10,("user_in_list: checking user %s in list\n", user));
500 DEBUG(10,("user_in_list: checking user |%s| against |%s|\n",
504 * Check raw username.
506 if (strequal(user, *list))
510 * Now check to see if any combination
511 * of UNIX and netgroups has been specified.
516 * Old behaviour. Check netgroup list
517 * followed by UNIX list.
519 if(user_in_netgroup(user, *list +1))
521 if(user_in_group(user, *list +1))
523 } else if (**list == '+') {
525 if((*(*list +1)) == '&') {
527 * Search UNIX list followed by netgroup.
529 if(user_in_group(user, *list +2))
531 if(user_in_netgroup(user, *list +2))
537 * Just search UNIX list.
540 if(user_in_group(user, *list +1))
544 } else if (**list == '&') {
546 if(*(*list +1) == '+') {
548 * Search netgroup list followed by UNIX list.
550 if(user_in_netgroup(user, *list +2))
552 if(user_in_group(user, *list +2))
556 * Just search netgroup list.
558 if(user_in_netgroup(user, *list +1))
568 /****************************************************************************
569 Check if a username is valid.
570 ****************************************************************************/
572 static bool user_ok(const char *user, int snum)
574 char **valid, **invalid;
577 valid = invalid = NULL;
580 if (lp_invalid_users(snum)) {
581 str_list_copy(talloc_tos(), &invalid, lp_invalid_users(snum));
583 str_list_substitute(invalid, "%S", lp_servicename(snum))) {
585 /* This is used in sec=share only, so no current user
586 * around to pass to str_list_sub_basic() */
588 if ( invalid && str_list_sub_basic(invalid, "", "") ) {
589 ret = !user_in_list(user,
590 (const char **)invalid);
594 TALLOC_FREE(invalid);
596 if (ret && lp_valid_users(snum)) {
597 str_list_copy(talloc_tos(), &valid, lp_valid_users(snum));
599 str_list_substitute(valid, "%S", lp_servicename(snum)) ) {
601 /* This is used in sec=share only, so no current user
602 * around to pass to str_list_sub_basic() */
604 if ( valid && str_list_sub_basic(valid, "", "") ) {
605 ret = user_in_list(user, (const char **)valid);
611 if (ret && lp_onlyuser(snum)) {
612 char **user_list = str_list_make(
613 talloc_tos(), lp_username(snum), NULL);
615 str_list_substitute(user_list, "%S",
616 lp_servicename(snum))) {
617 ret = user_in_list(user, (const char **)user_list);
619 TALLOC_FREE(user_list);
625 /****************************************************************************
626 Validate a group username entry. Return the username or NULL.
627 ****************************************************************************/
629 static char *validate_group(char *group, DATA_BLOB password,int snum)
633 char *host, *user, *domain;
635 while (getnetgrent(&host, &user, &domain)) {
637 if (user_ok(user, snum) &&
638 password_ok(user,password)) {
652 while ((gptr = (struct group *)getgrent())) {
653 if (strequal(gptr->gr_name,group))
658 * As user_ok can recurse doing a getgrent(), we must
659 * copy the member list onto the heap before
660 * use. Bug pointed out by leon@eatworms.swmed.edu.
664 char *member_list = NULL;
669 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
670 list_len += strlen(gptr->gr_mem[i])+1;
674 member_list = (char *)SMB_MALLOC(list_len);
681 member = member_list;
683 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
684 size_t member_len = strlen(gptr->gr_mem[i])+1;
686 DEBUG(10,("validate_group: = gr_mem = "
687 "%s\n", gptr->gr_mem[i]));
689 safe_strcpy(member, gptr->gr_mem[i],
690 list_len - (member-member_list));
691 member += member_len;
696 member = member_list;
698 if (user_ok(member,snum) &&
699 password_ok(member,password)) {
700 char *name = talloc_strdup(talloc_tos(),
702 SAFE_FREE(member_list);
706 DEBUG(10,("validate_group = member = %s\n",
709 member += strlen(member) + 1;
712 SAFE_FREE(member_list);
722 /****************************************************************************
723 Check for authority to login to a service with a given username/password.
724 Note this is *NOT* used when logging on using sessionsetup_and_X.
725 ****************************************************************************/
727 bool authorise_login(int snum, fstring user, DATA_BLOB password,
732 #ifdef DEBUG_PASSWORD
733 DEBUG(100,("authorise_login: checking authorisation on "
734 "user=%s pass=%s\n", user,password.data));
739 /* there are several possibilities:
740 1) login as the given user with given password
741 2) login as a previously registered username with the given
743 3) login as a session list username with the given password
744 4) login as a previously validated user/password pair
745 5) login as the "user =" user with given password
746 6) login as the "user =" user with no password
748 7) login as guest user with no password
750 if the service is guest_only then steps 1 to 5 are skipped
753 /* now check the list of session users */
756 char *user_list = NULL;
759 if ( session_userlist )
760 user_list = SMB_STRDUP(session_userlist);
762 user_list = SMB_STRDUP("");
767 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
769 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
771 fstrcpy(user2,auser);
772 if (!user_ok(user2,snum))
775 if (password_ok(user2,password)) {
778 DEBUG(3,("authorise_login: ACCEPTED: session "
779 "list username (%s) and given "
780 "password ok\n", user));
784 SAFE_FREE(user_list);
787 /* check the user= fields and the given password */
788 if (!ok && lp_username(snum)) {
789 TALLOC_CTX *ctx = talloc_tos();
791 char *user_list = talloc_strdup(ctx, lp_username(snum));
798 user_list = talloc_string_sub(ctx,
801 lp_servicename(snum));
807 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
809 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
811 auser = validate_group(auser+1,password,snum);
815 DEBUG(3,("authorise_login: ACCEPTED: "
816 "group username and given "
817 "password ok (%s)\n", user));
821 fstrcpy(user2,auser);
822 if (user_ok(user2,snum) &&
823 password_ok(user2,password)) {
826 DEBUG(3,("authorise_login: ACCEPTED: "
827 "user list username and "
828 "given password ok (%s)\n",
837 /* check for a normal guest connection */
838 if (!ok && GUEST_OK(snum)) {
839 struct passwd *guest_pw;
841 fstrcpy(guestname,lp_guestaccount());
842 guest_pw = Get_Pwnam_alloc(talloc_tos(), guestname);
843 if (guest_pw != NULL) {
844 fstrcpy(user,guestname);
846 DEBUG(3,("authorise_login: ACCEPTED: guest account "
847 "and guest ok (%s)\n", user));
849 DEBUG(0,("authorise_login: Invalid guest account "
850 "%s??\n",guestname));
852 TALLOC_FREE(guest_pw);
856 if (ok && !user_ok(user, snum)) {
857 DEBUG(0,("authorise_login: rejected invalid user %s\n",user));