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
);
205 * register that a valid login has been performed, establish 'session'.
206 * @param server_info The token returned from the authentication process.
207 * (now 'owned' by register_existing_vuid)
209 * @param session_key The User session key for the login session (now also
210 * 'owned' by register_existing_vuid)
212 * @param respose_blob The NT challenge-response, if available. (May be
213 * freed after this call)
215 * @param smb_name The untranslated name of the user
217 * @return Newly allocated vuid, biased by an offset. (This allows us to
218 * tell random client vuid's (normally zero) from valid vuids.)
222 int register_existing_vuid(uint16 vuid
,
223 auth_serversupplied_info
*server_info
,
224 DATA_BLOB session_key
,
225 DATA_BLOB response_blob
,
226 const char *smb_name
)
228 user_struct
*vuser
= get_partial_auth_user_struct(vuid
);
233 /* Use this to keep tabs on all our info from the authentication */
234 vuser
->server_info
= server_info
;
236 /* Ensure that the server_info will disappear with
237 * the vuser it is now attached to */
239 talloc_steal(vuser
, vuser
->server_info
);
241 /* the next functions should be done by a SID mapping system (SMS) as
242 * the new real sam db won't have reference to unix uids or gids
245 vuser
->uid
= server_info
->uid
;
246 vuser
->gid
= server_info
->gid
;
248 vuser
->n_groups
= server_info
->n_groups
;
249 if (vuser
->n_groups
) {
250 if (!(vuser
->groups
= (gid_t
*)talloc_memdup(vuser
,
252 sizeof(gid_t
)*vuser
->n_groups
))) {
253 DEBUG(0,("register_existing_vuid: "
254 "failed to talloc_memdup vuser->groups\n"));
259 vuser
->guest
= server_info
->guest
;
260 fstrcpy(vuser
->user
.unix_name
, server_info
->unix_name
);
262 /* This is a potentially untrusted username */
263 alpha_strcpy(vuser
->user
.smb_name
, smb_name
, ". _-$",
264 sizeof(vuser
->user
.smb_name
));
266 fstrcpy(vuser
->user
.domain
, pdb_get_domain(server_info
->sam_account
));
267 fstrcpy(vuser
->user
.full_name
,
268 pdb_get_fullname(server_info
->sam_account
));
271 /* Keep the homedir handy */
272 const char *homedir
=
273 pdb_get_homedir(server_info
->sam_account
);
274 const char *logon_script
=
275 pdb_get_logon_script(server_info
->sam_account
);
277 if (!IS_SAM_DEFAULT(server_info
->sam_account
,
279 const char *unix_homedir
=
280 pdb_get_unix_homedir(server_info
->sam_account
);
282 vuser
->unix_homedir
= unix_homedir
;
285 struct passwd
*passwd
=
286 getpwnam_alloc(vuser
, vuser
->user
.unix_name
);
288 vuser
->unix_homedir
= passwd
->pw_dir
;
289 /* Ensure that the unix_homedir now
290 * belongs to vuser, so it goes away
291 * with it, not with passwd below: */
292 talloc_steal(vuser
, vuser
->unix_homedir
);
298 vuser
->homedir
= homedir
;
301 vuser
->logon_script
= logon_script
;
304 vuser
->session_key
= session_key
;
306 DEBUG(10,("register_existing_vuid: (%u,%u) %s %s %s guest=%d\n",
307 (unsigned int)vuser
->uid
,
308 (unsigned int)vuser
->gid
,
309 vuser
->user
.unix_name
, vuser
->user
.smb_name
,
310 vuser
->user
.domain
, vuser
->guest
));
312 DEBUG(3, ("register_existing_vuid: User name: %s\t"
313 "Real name: %s\n", vuser
->user
.unix_name
,
314 vuser
->user
.full_name
));
316 if (server_info
->ptok
) {
317 vuser
->nt_user_token
= dup_nt_token(vuser
, server_info
->ptok
);
319 DEBUG(1, ("register_existing_vuid: server_info does not "
320 "contain a user_token - cannot continue\n"));
324 DEBUG(3,("register_existing_vuid: UNIX uid %d is UNIX user %s, "
325 "and will be vuid %u\n",
326 (int)vuser
->uid
,vuser
->user
.unix_name
, vuser
->vuid
));
328 if (!session_claim(vuser
)) {
329 DEBUG(1, ("register_existing_vuid: Failed to claim session "
335 /* Register a home dir service for this user if
336 (a) This is not a guest connection,
337 (b) we have a home directory defined
338 (c) there s not an existing static share by that name
339 If a share exists by this name (autoloaded or not) reuse it . */
341 vuser
->homes_snum
= -1;
342 if ( (!vuser
->guest
) && vuser
->unix_homedir
&& *(vuser
->unix_homedir
)) {
343 int servicenumber
= lp_servicenumber(vuser
->user
.unix_name
);
344 if ( servicenumber
== -1 ) {
345 DEBUG(3, ("Adding homes service for user '%s' using "
346 "home directory: '%s'\n",
347 vuser
->user
.unix_name
, vuser
->unix_homedir
));
349 add_home_service(vuser
->user
.unix_name
,
350 vuser
->user
.unix_name
,
351 vuser
->unix_homedir
);
353 DEBUG(3, ("Using static (or previously created) "
354 "service for user '%s'; path = '%s'\n",
355 vuser
->user
.unix_name
,
356 lp_pathname(servicenumber
) ));
357 vuser
->homes_snum
= servicenumber
;
361 if (srv_is_signing_negotiated() && !vuser
->guest
&&
362 !srv_signing_started()) {
363 /* Try and turn on server signing on the first non-guest
365 srv_set_signing(vuser
->session_key
, response_blob
);
368 /* fill in the current_user_info struct */
369 set_current_user_info( &vuser
->user
);
375 invalidate_vuid(vuid
);
377 return UID_FIELD_INVALID
;
380 /****************************************************************************
381 Add a name to the session users list.
382 ****************************************************************************/
384 void add_session_user(const char *user
)
389 pw
= Get_Pwnam_alloc(talloc_tos(), user
);
395 if (session_userlist
== NULL
) {
396 session_userlist
= SMB_STRDUP(pw
->pw_name
);
400 if (in_list(pw
->pw_name
,session_userlist
,False
) ) {
404 if (strlen(session_userlist
) > 128 * 1024) {
405 DEBUG(3,("add_session_user: session userlist already "
410 if (asprintf(&tmp
, "%s %s", session_userlist
, pw
->pw_name
) == -1) {
411 DEBUG(3, ("asprintf failed\n"));
415 SAFE_FREE(session_userlist
);
416 session_userlist
= tmp
;
421 /****************************************************************************
422 In security=share mode we need to store the client workgroup, as that's
423 what Vista uses for the NTLMv2 calculation.
424 ****************************************************************************/
426 void add_session_workgroup(const char *workgroup
)
428 if (session_workgroup
) {
429 SAFE_FREE(session_workgroup
);
431 session_workgroup
= smb_xstrdup(workgroup
);
434 /****************************************************************************
435 In security=share mode we need to return the client workgroup, as that's
436 what Vista uses for the NTLMv2 calculation.
437 ****************************************************************************/
439 const char *get_session_workgroup(void)
441 return session_workgroup
;
444 /****************************************************************************
445 Check if a user is in a netgroup user list. If at first we don't succeed,
447 ****************************************************************************/
449 bool user_in_netgroup(const char *user
, const char *ngname
)
452 static char *mydomain
= NULL
;
453 fstring lowercase_user
;
455 if (mydomain
== NULL
)
456 yp_get_default_domain(&mydomain
);
458 if(mydomain
== NULL
) {
459 DEBUG(5,("Unable to get default yp domain, "
460 "let's try without specifying it\n"));
463 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
464 user
, mydomain
?mydomain
:"(ANY)", ngname
));
466 if (innetgr(ngname
, NULL
, user
, mydomain
)) {
467 DEBUG(5,("user_in_netgroup: Found\n"));
472 * Ok, innetgr is case sensitive. Try once more with lowercase
473 * just in case. Attempt to fix #703. JRA.
476 fstrcpy(lowercase_user
, user
);
477 strlower_m(lowercase_user
);
479 DEBUG(5,("looking for user %s of domain %s in netgroup %s\n",
480 lowercase_user
, mydomain
?mydomain
:"(ANY)", ngname
));
482 if (innetgr(ngname
, NULL
, lowercase_user
, mydomain
)) {
483 DEBUG(5,("user_in_netgroup: Found\n"));
487 #endif /* HAVE_NETGROUP */
491 /****************************************************************************
492 Check if a user is in a user list - can check combinations of UNIX
494 ****************************************************************************/
496 bool user_in_list(const char *user
,const char **list
)
501 DEBUG(10,("user_in_list: checking user %s in list\n", user
));
505 DEBUG(10,("user_in_list: checking user |%s| against |%s|\n",
509 * Check raw username.
511 if (strequal(user
, *list
))
515 * Now check to see if any combination
516 * of UNIX and netgroups has been specified.
521 * Old behaviour. Check netgroup list
522 * followed by UNIX list.
524 if(user_in_netgroup(user
, *list
+1))
526 if(user_in_group(user
, *list
+1))
528 } else if (**list
== '+') {
530 if((*(*list
+1)) == '&') {
532 * Search UNIX list followed by netgroup.
534 if(user_in_group(user
, *list
+2))
536 if(user_in_netgroup(user
, *list
+2))
542 * Just search UNIX list.
545 if(user_in_group(user
, *list
+1))
549 } else if (**list
== '&') {
551 if(*(*list
+1) == '+') {
553 * Search netgroup list followed by UNIX list.
555 if(user_in_netgroup(user
, *list
+2))
557 if(user_in_group(user
, *list
+2))
561 * Just search netgroup list.
563 if(user_in_netgroup(user
, *list
+1))
573 /****************************************************************************
574 Check if a username is valid.
575 ****************************************************************************/
577 static bool user_ok(const char *user
, int snum
)
579 char **valid
, **invalid
;
582 valid
= invalid
= NULL
;
585 if (lp_invalid_users(snum
)) {
586 str_list_copy(talloc_tos(), &invalid
, lp_invalid_users(snum
));
588 str_list_substitute(invalid
, "%S", lp_servicename(snum
))) {
590 /* This is used in sec=share only, so no current user
591 * around to pass to str_list_sub_basic() */
593 if ( invalid
&& str_list_sub_basic(invalid
, "", "") ) {
594 ret
= !user_in_list(user
,
595 (const char **)invalid
);
599 TALLOC_FREE(invalid
);
601 if (ret
&& lp_valid_users(snum
)) {
602 str_list_copy(talloc_tos(), &valid
, lp_valid_users(snum
));
604 str_list_substitute(valid
, "%S", lp_servicename(snum
)) ) {
606 /* This is used in sec=share only, so no current user
607 * around to pass to str_list_sub_basic() */
609 if ( valid
&& str_list_sub_basic(valid
, "", "") ) {
610 ret
= user_in_list(user
, (const char **)valid
);
616 if (ret
&& lp_onlyuser(snum
)) {
617 char **user_list
= str_list_make(
618 talloc_tos(), lp_username(snum
), NULL
);
620 str_list_substitute(user_list
, "%S",
621 lp_servicename(snum
))) {
622 ret
= user_in_list(user
, (const char **)user_list
);
624 TALLOC_FREE(user_list
);
630 /****************************************************************************
631 Validate a group username entry. Return the username or NULL.
632 ****************************************************************************/
634 static char *validate_group(char *group
, DATA_BLOB password
,int snum
)
638 char *host
, *user
, *domain
;
640 while (getnetgrent(&host
, &user
, &domain
)) {
642 if (user_ok(user
, snum
) &&
643 password_ok(user
,password
)) {
657 while ((gptr
= (struct group
*)getgrent())) {
658 if (strequal(gptr
->gr_name
,group
))
663 * As user_ok can recurse doing a getgrent(), we must
664 * copy the member list onto the heap before
665 * use. Bug pointed out by leon@eatworms.swmed.edu.
669 char *member_list
= NULL
;
674 for(i
= 0; gptr
->gr_mem
&& gptr
->gr_mem
[i
]; i
++) {
675 list_len
+= strlen(gptr
->gr_mem
[i
])+1;
679 member_list
= (char *)SMB_MALLOC(list_len
);
686 member
= member_list
;
688 for(i
= 0; gptr
->gr_mem
&& gptr
->gr_mem
[i
]; i
++) {
689 size_t member_len
= strlen(gptr
->gr_mem
[i
])+1;
691 DEBUG(10,("validate_group: = gr_mem = "
692 "%s\n", gptr
->gr_mem
[i
]));
694 safe_strcpy(member
, gptr
->gr_mem
[i
],
695 list_len
- (member
-member_list
));
696 member
+= member_len
;
701 member
= member_list
;
703 if (user_ok(member
,snum
) &&
704 password_ok(member
,password
)) {
705 char *name
= talloc_strdup(talloc_tos(),
707 SAFE_FREE(member_list
);
711 DEBUG(10,("validate_group = member = %s\n",
714 member
+= strlen(member
) + 1;
717 SAFE_FREE(member_list
);
727 /****************************************************************************
728 Check for authority to login to a service with a given username/password.
729 Note this is *NOT* used when logging on using sessionsetup_and_X.
730 ****************************************************************************/
732 bool authorise_login(int snum
, fstring user
, DATA_BLOB password
,
737 #ifdef DEBUG_PASSWORD
738 DEBUG(100,("authorise_login: checking authorisation on "
739 "user=%s pass=%s\n", user
,password
.data
));
744 /* there are several possibilities:
745 1) login as the given user with given password
746 2) login as a previously registered username with the given
748 3) login as a session list username with the given password
749 4) login as a previously validated user/password pair
750 5) login as the "user =" user with given password
751 6) login as the "user =" user with no password
753 7) login as guest user with no password
755 if the service is guest_only then steps 1 to 5 are skipped
758 /* now check the list of session users */
761 char *user_list
= NULL
;
764 if ( session_userlist
)
765 user_list
= SMB_STRDUP(session_userlist
);
767 user_list
= SMB_STRDUP("");
772 for (auser
= strtok_r(user_list
, LIST_SEP
, &saveptr
);
774 auser
= strtok_r(NULL
, LIST_SEP
, &saveptr
)) {
776 fstrcpy(user2
,auser
);
777 if (!user_ok(user2
,snum
))
780 if (password_ok(user2
,password
)) {
783 DEBUG(3,("authorise_login: ACCEPTED: session "
784 "list username (%s) and given "
785 "password ok\n", user
));
789 SAFE_FREE(user_list
);
792 /* check the user= fields and the given password */
793 if (!ok
&& lp_username(snum
)) {
794 TALLOC_CTX
*ctx
= talloc_tos();
796 char *user_list
= talloc_strdup(ctx
, lp_username(snum
));
803 user_list
= talloc_string_sub(ctx
,
806 lp_servicename(snum
));
812 for (auser
= strtok_r(user_list
, LIST_SEP
, &saveptr
);
814 auser
= strtok_r(NULL
, LIST_SEP
, &saveptr
)) {
816 auser
= validate_group(auser
+1,password
,snum
);
820 DEBUG(3,("authorise_login: ACCEPTED: "
821 "group username and given "
822 "password ok (%s)\n", user
));
826 fstrcpy(user2
,auser
);
827 if (user_ok(user2
,snum
) &&
828 password_ok(user2
,password
)) {
831 DEBUG(3,("authorise_login: ACCEPTED: "
832 "user list username and "
833 "given password ok (%s)\n",
842 /* check for a normal guest connection */
843 if (!ok
&& GUEST_OK(snum
)) {
844 struct passwd
*guest_pw
;
846 fstrcpy(guestname
,lp_guestaccount());
847 guest_pw
= Get_Pwnam_alloc(talloc_tos(), guestname
);
848 if (guest_pw
!= NULL
) {
849 fstrcpy(user
,guestname
);
851 DEBUG(3,("authorise_login: ACCEPTED: guest account "
852 "and guest ok (%s)\n", user
));
854 DEBUG(0,("authorise_login: Invalid guest account "
855 "%s??\n",guestname
));
857 TALLOC_FREE(guest_pw
);
861 if (ok
&& !user_ok(user
, snum
)) {
862 DEBUG(0,("authorise_login: rejected invalid user %s\n",user
));