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 "system/passwd.h"
23 #include "smbd/smbd.h"
24 #include "smbd/globals.h"
25 #include "../librpc/gen_ndr/netlogon.h"
28 /* Fix up prototypes for OSX 10.4, where they're missing */
29 #ifndef HAVE_SETNETGRENT_PROTOTYPE
30 extern int setnetgrent(const char* netgroup
);
32 #ifndef HAVE_GETNETGRENT_PROTOTYPE
33 extern int getnetgrent(char **host
, char **user
, char **domain
);
35 #ifndef HAVE_ENDNETGRENT_PROTOTYPE
36 extern void endnetgrent(void);
39 enum server_allocated_state
{ SERVER_ALLOCATED_REQUIRED_YES
,
40 SERVER_ALLOCATED_REQUIRED_NO
,
41 SERVER_ALLOCATED_REQUIRED_ANY
};
43 static user_struct
*get_valid_user_struct_internal(
44 struct smbd_server_connection
*sconn
,
46 enum server_allocated_state server_allocated
)
51 if (vuid
== UID_FIELD_INVALID
)
54 usp
=sconn
->smb1
.sessions
.validated_users
;
55 for (;usp
;usp
=usp
->next
,count
++) {
56 if (vuid
== usp
->vuid
) {
57 switch (server_allocated
) {
58 case SERVER_ALLOCATED_REQUIRED_YES
:
59 if (usp
->session_info
== NULL
) {
63 case SERVER_ALLOCATED_REQUIRED_NO
:
64 if (usp
->session_info
!= NULL
) {
67 case SERVER_ALLOCATED_REQUIRED_ANY
:
71 DLIST_PROMOTE(sconn
->smb1
.sessions
.validated_users
,
81 /****************************************************************************
82 Check if a uid has been validated, and return an pointer to the user_struct
83 if it has. NULL if not. vuid is biased by an offset. This allows us to
84 tell random client vuid's (normally zero) from valid vuids.
85 ****************************************************************************/
87 user_struct
*get_valid_user_struct(struct smbd_server_connection
*sconn
,
90 return get_valid_user_struct_internal(sconn
, vuid
,
91 SERVER_ALLOCATED_REQUIRED_YES
);
94 bool is_partial_auth_vuid(struct smbd_server_connection
*sconn
, uint16 vuid
)
96 return (get_partial_auth_user_struct(sconn
, vuid
) != NULL
);
99 /****************************************************************************
100 Get the user struct of a partial NTLMSSP login
101 ****************************************************************************/
103 user_struct
*get_partial_auth_user_struct(struct smbd_server_connection
*sconn
,
106 return get_valid_user_struct_internal(sconn
, vuid
,
107 SERVER_ALLOCATED_REQUIRED_NO
);
110 /****************************************************************************
112 ****************************************************************************/
114 void invalidate_vuid(struct smbd_server_connection
*sconn
, uint16 vuid
)
116 user_struct
*vuser
= NULL
;
118 vuser
= get_valid_user_struct_internal(sconn
, vuid
,
119 SERVER_ALLOCATED_REQUIRED_ANY
);
124 session_yield(vuser
);
126 if (vuser
->auth_ntlmssp_state
) {
127 TALLOC_FREE(vuser
->auth_ntlmssp_state
);
130 DLIST_REMOVE(sconn
->smb1
.sessions
.validated_users
, vuser
);
132 /* clear the vuid from the 'cache' on each connection, and
133 from the vuid 'owner' of connections */
134 conn_clear_vuid_caches(sconn
, vuid
);
137 sconn
->smb1
.sessions
.num_validated_vuids
--;
140 /****************************************************************************
141 Invalidate all vuid entries for this process.
142 ****************************************************************************/
144 void invalidate_all_vuids(struct smbd_server_connection
*sconn
)
146 if (sconn
->using_smb2
) {
150 while (sconn
->smb1
.sessions
.validated_users
!= NULL
) {
151 invalidate_vuid(sconn
,
152 sconn
->smb1
.sessions
.validated_users
->vuid
);
156 static void increment_next_vuid(uint16_t *vuid
)
160 /* Check for vuid wrap. */
161 if (*vuid
== UID_FIELD_INVALID
) {
166 /****************************************************
167 Create a new partial auth user struct.
168 *****************************************************/
170 int register_initial_vuid(struct smbd_server_connection
*sconn
)
174 /* Paranoia check. */
175 if(lp_security() == SEC_SHARE
) {
176 smb_panic("register_initial_vuid: "
177 "Tried to register uid in security=share");
180 /* Limit allowed vuids to 16bits - VUID_OFFSET. */
181 if (sconn
->smb1
.sessions
.num_validated_vuids
>= 0xFFFF-VUID_OFFSET
) {
182 return UID_FIELD_INVALID
;
185 if((vuser
= talloc_zero(NULL
, user_struct
)) == NULL
) {
186 DEBUG(0,("register_initial_vuid: "
187 "Failed to talloc users struct!\n"));
188 return UID_FIELD_INVALID
;
191 /* Allocate a free vuid. Yes this is a linear search... */
192 while( get_valid_user_struct_internal(sconn
,
193 sconn
->smb1
.sessions
.next_vuid
,
194 SERVER_ALLOCATED_REQUIRED_ANY
) != NULL
) {
195 increment_next_vuid(&sconn
->smb1
.sessions
.next_vuid
);
198 DEBUG(10,("register_initial_vuid: allocated vuid = %u\n",
199 (unsigned int)sconn
->smb1
.sessions
.next_vuid
));
201 vuser
->vuid
= sconn
->smb1
.sessions
.next_vuid
;
204 * This happens in an unfinished NTLMSSP session setup. We
205 * need to allocate a vuid between the first and second calls
208 increment_next_vuid(&sconn
->smb1
.sessions
.next_vuid
);
209 sconn
->smb1
.sessions
.num_validated_vuids
++;
211 DLIST_ADD(sconn
->smb1
.sessions
.validated_users
, vuser
);
215 int register_homes_share(const char *username
)
220 result
= lp_servicenumber(username
);
222 DEBUG(3, ("Using static (or previously created) service for "
223 "user '%s'; path = '%s'\n", username
,
224 lp_pathname(result
)));
228 pwd
= Get_Pwnam_alloc(talloc_tos(), username
);
230 if ((pwd
== NULL
) || (pwd
->pw_dir
[0] == '\0')) {
231 DEBUG(3, ("No home directory defined for user '%s'\n",
237 DEBUG(3, ("Adding homes service for user '%s' using home directory: "
238 "'%s'\n", username
, pwd
->pw_dir
));
240 result
= add_home_service(username
, username
, pwd
->pw_dir
);
247 * register that a valid login has been performed, establish 'session'.
248 * @param session_info The token returned from the authentication process.
249 * (now 'owned' by register_existing_vuid)
251 * @param session_key The User session key for the login session (now also
252 * 'owned' by register_existing_vuid)
254 * @param respose_blob The NT challenge-response, if available. (May be
255 * freed after this call)
257 * @param smb_name The untranslated name of the user
259 * @return Newly allocated vuid, biased by an offset. (This allows us to
260 * tell random client vuid's (normally zero) from valid vuids.)
264 int register_existing_vuid(struct smbd_server_connection
*sconn
,
266 struct auth3_session_info
*session_info
,
267 DATA_BLOB response_blob
,
268 const char *smb_name
)
273 vuser
= get_partial_auth_user_struct(sconn
, vuid
);
278 /* Use this to keep tabs on all our info from the authentication */
279 vuser
->session_info
= talloc_move(vuser
, &session_info
);
281 /* This is a potentially untrusted username */
282 alpha_strcpy(tmp
, smb_name
, ". _-$", sizeof(tmp
));
284 vuser
->session_info
->sanitized_username
= talloc_strdup(
285 vuser
->session_info
, tmp
);
287 /* Make clear that we require the optional unix_token in the source3 code */
288 SMB_ASSERT(vuser
->session_info
->unix_token
);
290 DEBUG(10,("register_existing_vuid: (%u,%u) %s %s %s guest=%d\n",
291 (unsigned int)vuser
->session_info
->unix_token
->uid
,
292 (unsigned int)vuser
->session_info
->unix_token
->gid
,
293 vuser
->session_info
->unix_name
,
294 vuser
->session_info
->sanitized_username
,
295 vuser
->session_info
->info3
->base
.domain
.string
,
296 vuser
->session_info
->guest
));
298 DEBUG(3, ("register_existing_vuid: User name: %s\t"
299 "Real name: %s\n", vuser
->session_info
->unix_name
,
300 vuser
->session_info
->info3
->base
.full_name
.string
));
302 if (!vuser
->session_info
->security_token
) {
303 DEBUG(1, ("register_existing_vuid: session_info does not "
304 "contain a user_token - cannot continue\n"));
308 /* Make clear that we require the optional unix_token in the source3 code */
309 SMB_ASSERT(vuser
->session_info
->unix_token
);
311 DEBUG(3,("register_existing_vuid: UNIX uid %d is UNIX user %s, "
312 "and will be vuid %u\n", (int)vuser
->session_info
->unix_token
->uid
,
313 vuser
->session_info
->unix_name
, vuser
->vuid
));
315 if (!session_claim(sconn
, vuser
)) {
316 DEBUG(1, ("register_existing_vuid: Failed to claim session "
322 /* Register a home dir service for this user if
323 (a) This is not a guest connection,
324 (b) we have a home directory defined
325 (c) there s not an existing static share by that name
326 If a share exists by this name (autoloaded or not) reuse it . */
328 vuser
->homes_snum
= -1;
330 if (!vuser
->session_info
->guest
) {
331 vuser
->homes_snum
= register_homes_share(
332 vuser
->session_info
->unix_name
);
335 if (srv_is_signing_negotiated(sconn
) &&
336 !vuser
->session_info
->guest
) {
337 /* Try and turn on server signing on the first non-guest
339 srv_set_signing(sconn
,
340 vuser
->session_info
->session_key
,
344 /* fill in the current_user_info struct */
345 set_current_user_info(
346 vuser
->session_info
->sanitized_username
,
347 vuser
->session_info
->unix_name
,
348 vuser
->session_info
->info3
->base
.domain
.string
);
355 invalidate_vuid(sconn
, vuid
);
357 return UID_FIELD_INVALID
;
360 /****************************************************************************
361 Add a name to the session users list.
362 ****************************************************************************/
364 void add_session_user(struct smbd_server_connection
*sconn
,
370 pw
= Get_Pwnam_alloc(talloc_tos(), user
);
376 if (sconn
->smb1
.sessions
.session_userlist
== NULL
) {
377 sconn
->smb1
.sessions
.session_userlist
= SMB_STRDUP(pw
->pw_name
);
381 if (in_list(pw
->pw_name
,sconn
->smb1
.sessions
.session_userlist
,false)) {
385 if (strlen(sconn
->smb1
.sessions
.session_userlist
) > 128 * 1024) {
386 DEBUG(3,("add_session_user: session userlist already "
391 if (asprintf(&tmp
, "%s %s",
392 sconn
->smb1
.sessions
.session_userlist
, pw
->pw_name
) == -1) {
393 DEBUG(3, ("asprintf failed\n"));
397 SAFE_FREE(sconn
->smb1
.sessions
.session_userlist
);
398 sconn
->smb1
.sessions
.session_userlist
= tmp
;
403 /****************************************************************************
404 In security=share mode we need to store the client workgroup, as that's
405 what Vista uses for the NTLMv2 calculation.
406 ****************************************************************************/
408 void add_session_workgroup(struct smbd_server_connection
*sconn
,
409 const char *workgroup
)
411 if (sconn
->smb1
.sessions
.session_workgroup
) {
412 SAFE_FREE(sconn
->smb1
.sessions
.session_workgroup
);
414 sconn
->smb1
.sessions
.session_workgroup
= smb_xstrdup(workgroup
);
417 /****************************************************************************
418 In security=share mode we need to return the client workgroup, as that's
419 what Vista uses for the NTLMv2 calculation.
420 ****************************************************************************/
422 const char *get_session_workgroup(struct smbd_server_connection
*sconn
)
424 return sconn
->smb1
.sessions
.session_workgroup
;
427 /****************************************************************************
428 Check if a username is valid.
429 ****************************************************************************/
431 static bool user_ok(const char *user
, int snum
)
437 if (lp_invalid_users(snum
)) {
438 char **invalid
= str_list_copy(talloc_tos(),
439 lp_invalid_users(snum
));
441 str_list_substitute(invalid
, "%S", lp_servicename(snum
))) {
443 /* This is used in sec=share only, so no current user
444 * around to pass to str_list_sub_basic() */
446 if ( invalid
&& str_list_sub_basic(invalid
, "", "") ) {
447 ret
= !user_in_list(talloc_tos(), user
,
448 (const char **)invalid
);
451 TALLOC_FREE(invalid
);
454 if (ret
&& lp_valid_users(snum
)) {
455 char **valid
= str_list_copy(talloc_tos(),
456 lp_valid_users(snum
));
458 str_list_substitute(valid
, "%S", lp_servicename(snum
)) ) {
460 /* This is used in sec=share only, so no current user
461 * around to pass to str_list_sub_basic() */
463 if ( valid
&& str_list_sub_basic(valid
, "", "") ) {
464 ret
= user_in_list(talloc_tos(), user
,
465 (const char **)valid
);
471 if (ret
&& lp_onlyuser(snum
)) {
472 char **user_list
= str_list_make_v3(
473 talloc_tos(), lp_username(snum
), NULL
);
475 str_list_substitute(user_list
, "%S",
476 lp_servicename(snum
))) {
477 ret
= user_in_list(talloc_tos(), user
,
478 (const char **)user_list
);
480 TALLOC_FREE(user_list
);
486 /****************************************************************************
487 Validate a group username entry. Return the username or NULL.
488 ****************************************************************************/
490 static char *validate_group(struct smbd_server_connection
*sconn
,
491 char *group
, DATA_BLOB password
,int snum
)
495 char *host
, *user
, *domain
;
496 struct auth_context
*actx
= sconn
->smb1
.negprot
.auth_context
;
497 bool enc
= sconn
->smb1
.negprot
.encrypted_passwords
;
499 while (getnetgrent(&host
, &user
, &domain
)) {
501 if (user_ok(user
, snum
) &&
502 password_ok(actx
, enc
,
503 get_session_workgroup(sconn
),
505 sconn
->remote_address
,
519 struct auth_context
*actx
= sconn
->smb1
.negprot
.auth_context
;
520 bool enc
= sconn
->smb1
.negprot
.encrypted_passwords
;
523 while ((gptr
= (struct group
*)getgrent())) {
524 if (strequal(gptr
->gr_name
,group
))
529 * As user_ok can recurse doing a getgrent(), we must
530 * copy the member list onto the heap before
531 * use. Bug pointed out by leon@eatworms.swmed.edu.
535 char *member_list
= NULL
;
540 for(i
= 0; gptr
->gr_mem
&& gptr
->gr_mem
[i
]; i
++) {
541 list_len
+= strlen(gptr
->gr_mem
[i
])+1;
545 member_list
= (char *)SMB_MALLOC(list_len
);
552 member
= member_list
;
554 for(i
= 0; gptr
->gr_mem
&& gptr
->gr_mem
[i
]; i
++) {
555 size_t member_len
= strlen(gptr
->gr_mem
[i
])+1;
557 DEBUG(10,("validate_group: = gr_mem = "
558 "%s\n", gptr
->gr_mem
[i
]));
560 strlcpy(member
, gptr
->gr_mem
[i
],
561 list_len
- (member
-member_list
));
562 member
+= member_len
;
567 member
= member_list
;
569 if (user_ok(member
,snum
) &&
570 password_ok(actx
, enc
,
571 get_session_workgroup(sconn
),
573 sconn
->remote_address
,
575 char *name
= talloc_strdup(talloc_tos(),
577 SAFE_FREE(member_list
);
581 DEBUG(10,("validate_group = member = %s\n",
584 member
+= strlen(member
) + 1;
587 SAFE_FREE(member_list
);
597 /****************************************************************************
598 Check for authority to login to a service with a given username/password.
599 Note this is *NOT* used when logging on using sessionsetup_and_X.
600 ****************************************************************************/
602 bool authorise_login(struct smbd_server_connection
*sconn
,
603 int snum
, fstring user
, DATA_BLOB password
,
607 struct auth_context
*actx
= sconn
->smb1
.negprot
.auth_context
;
608 bool enc
= sconn
->smb1
.negprot
.encrypted_passwords
;
610 #ifdef DEBUG_PASSWORD
611 DEBUG(100,("authorise_login: checking authorisation on "
612 "user=%s pass=%s\n", user
,password
.data
));
617 /* there are several possibilities:
618 1) login as the given user with given password
619 2) login as a previously registered username with the given
621 3) login as a session list username with the given password
622 4) login as a previously validated user/password pair
623 5) login as the "user =" user with given password
624 6) login as the "user =" user with no password
626 7) login as guest user with no password
628 if the service is guest_only then steps 1 to 5 are skipped
631 /* now check the list of session users */
634 char *user_list
= NULL
;
637 if (sconn
->smb1
.sessions
.session_userlist
)
638 user_list
= SMB_STRDUP(sconn
->smb1
.sessions
.session_userlist
);
640 user_list
= SMB_STRDUP("");
645 for (auser
= strtok_r(user_list
, LIST_SEP
, &saveptr
);
647 auser
= strtok_r(NULL
, LIST_SEP
, &saveptr
)) {
649 fstrcpy(user2
,auser
);
650 if (!user_ok(user2
,snum
))
653 if (password_ok(actx
, enc
,
654 get_session_workgroup(sconn
),
656 sconn
->remote_address
,
659 strlcpy(user
,user2
,sizeof(fstring
));
660 DEBUG(3,("authorise_login: ACCEPTED: session "
661 "list username (%s) and given "
662 "password ok\n", user
));
666 SAFE_FREE(user_list
);
669 /* check the user= fields and the given password */
670 if (!ok
&& lp_username(snum
)) {
671 TALLOC_CTX
*ctx
= talloc_tos();
673 char *user_list
= talloc_strdup(ctx
, lp_username(snum
));
680 user_list
= talloc_string_sub(ctx
,
683 lp_servicename(snum
));
689 for (auser
= strtok_r(user_list
, LIST_SEP
, &saveptr
);
691 auser
= strtok_r(NULL
, LIST_SEP
, &saveptr
)) {
693 auser
= validate_group(sconn
,auser
+1,
698 DEBUG(3,("authorise_login: ACCEPTED: "
699 "group username and given "
700 "password ok (%s)\n", user
));
704 fstrcpy(user2
,auser
);
705 if (user_ok(user2
,snum
) &&
706 password_ok(actx
, enc
,
707 get_session_workgroup(sconn
),
709 sconn
->remote_address
,
712 strlcpy(user
,user2
,sizeof(fstring
));
713 DEBUG(3,("authorise_login: ACCEPTED: "
714 "user list username and "
715 "given password ok (%s)\n",
724 /* check for a normal guest connection */
725 if (!ok
&& GUEST_OK(snum
)) {
726 struct passwd
*guest_pw
;
728 fstrcpy(guestname
,lp_guestaccount());
729 guest_pw
= Get_Pwnam_alloc(talloc_tos(), guestname
);
730 if (guest_pw
!= NULL
) {
731 strlcpy(user
,guestname
,sizeof(fstring
));
733 DEBUG(3,("authorise_login: ACCEPTED: guest account "
734 "and guest ok (%s)\n", user
));
736 DEBUG(0,("authorise_login: Invalid guest account "
737 "%s??\n",guestname
));
739 TALLOC_FREE(guest_pw
);
743 if (ok
&& !user_ok(user
, snum
)) {
744 DEBUG(0,("authorise_login: rejected invalid user %s\n",user
));