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 /* Fix up prototypes for OSX 10.4, where they're missing */
25 #ifndef HAVE_SETNETGRENT_PROTOTYPE
26 extern int setnetgrent(const char* netgroup
);
28 #ifndef HAVE_GETNETGRENT_PROTOTYPE
29 extern int getnetgrent(char **host
, char **user
, char **domain
);
31 #ifndef HAVE_ENDNETGRENT_PROTOTYPE
32 extern void endnetgrent(void);
35 enum server_allocated_state
{ SERVER_ALLOCATED_REQUIRED_YES
,
36 SERVER_ALLOCATED_REQUIRED_NO
,
37 SERVER_ALLOCATED_REQUIRED_ANY
};
39 static user_struct
*get_valid_user_struct_internal(
40 struct smbd_server_connection
*sconn
,
42 enum server_allocated_state server_allocated
)
47 if (vuid
== UID_FIELD_INVALID
)
50 usp
=sconn
->smb1
.sessions
.validated_users
;
51 for (;usp
;usp
=usp
->next
,count
++) {
52 if (vuid
== usp
->vuid
) {
53 switch (server_allocated
) {
54 case SERVER_ALLOCATED_REQUIRED_YES
:
55 if (usp
->server_info
== NULL
) {
59 case SERVER_ALLOCATED_REQUIRED_NO
:
60 if (usp
->server_info
!= NULL
) {
63 case SERVER_ALLOCATED_REQUIRED_ANY
:
67 DLIST_PROMOTE(sconn
->smb1
.sessions
.validated_users
,
77 /****************************************************************************
78 Check if a uid has been validated, and return an pointer to the user_struct
79 if it has. NULL if not. vuid is biased by an offset. This allows us to
80 tell random client vuid's (normally zero) from valid vuids.
81 ****************************************************************************/
83 user_struct
*get_valid_user_struct(struct smbd_server_connection
*sconn
,
86 return get_valid_user_struct_internal(sconn
, vuid
,
87 SERVER_ALLOCATED_REQUIRED_YES
);
90 bool is_partial_auth_vuid(struct smbd_server_connection
*sconn
, uint16 vuid
)
92 return (get_partial_auth_user_struct(sconn
, vuid
) != NULL
);
95 /****************************************************************************
96 Get the user struct of a partial NTLMSSP login
97 ****************************************************************************/
99 user_struct
*get_partial_auth_user_struct(struct smbd_server_connection
*sconn
,
102 return get_valid_user_struct_internal(sconn
, vuid
,
103 SERVER_ALLOCATED_REQUIRED_NO
);
106 /****************************************************************************
108 ****************************************************************************/
110 void invalidate_vuid(struct smbd_server_connection
*sconn
, uint16 vuid
)
112 user_struct
*vuser
= NULL
;
114 vuser
= get_valid_user_struct_internal(sconn
, vuid
,
115 SERVER_ALLOCATED_REQUIRED_ANY
);
120 session_yield(vuser
);
122 if (vuser
->auth_ntlmssp_state
) {
123 TALLOC_FREE(vuser
->auth_ntlmssp_state
);
126 DLIST_REMOVE(sconn
->smb1
.sessions
.validated_users
, vuser
);
128 /* clear the vuid from the 'cache' on each connection, and
129 from the vuid 'owner' of connections */
130 conn_clear_vuid_caches(sconn
, vuid
);
133 sconn
->smb1
.sessions
.num_validated_vuids
--;
136 /****************************************************************************
137 Invalidate all vuid entries for this process.
138 ****************************************************************************/
140 void invalidate_all_vuids(struct smbd_server_connection
*sconn
)
142 if (sconn
->using_smb2
) {
146 while (sconn
->smb1
.sessions
.validated_users
!= NULL
) {
147 invalidate_vuid(sconn
,
148 sconn
->smb1
.sessions
.validated_users
->vuid
);
152 static void increment_next_vuid(uint16_t *vuid
)
156 /* Check for vuid wrap. */
157 if (*vuid
== UID_FIELD_INVALID
) {
162 /****************************************************
163 Create a new partial auth user struct.
164 *****************************************************/
166 int register_initial_vuid(struct smbd_server_connection
*sconn
)
170 /* Paranoia check. */
171 if(lp_security() == SEC_SHARE
) {
172 smb_panic("register_initial_vuid: "
173 "Tried to register uid in security=share");
176 /* Limit allowed vuids to 16bits - VUID_OFFSET. */
177 if (sconn
->smb1
.sessions
.num_validated_vuids
>= 0xFFFF-VUID_OFFSET
) {
178 return UID_FIELD_INVALID
;
181 if((vuser
= talloc_zero(NULL
, user_struct
)) == NULL
) {
182 DEBUG(0,("register_initial_vuid: "
183 "Failed to talloc users struct!\n"));
184 return UID_FIELD_INVALID
;
187 /* Allocate a free vuid. Yes this is a linear search... */
188 while( get_valid_user_struct_internal(sconn
,
189 sconn
->smb1
.sessions
.next_vuid
,
190 SERVER_ALLOCATED_REQUIRED_ANY
) != NULL
) {
191 increment_next_vuid(&sconn
->smb1
.sessions
.next_vuid
);
194 DEBUG(10,("register_initial_vuid: allocated vuid = %u\n",
195 (unsigned int)sconn
->smb1
.sessions
.next_vuid
));
197 vuser
->vuid
= sconn
->smb1
.sessions
.next_vuid
;
200 * This happens in an unfinished NTLMSSP session setup. We
201 * need to allocate a vuid between the first and second calls
204 increment_next_vuid(&sconn
->smb1
.sessions
.next_vuid
);
205 sconn
->smb1
.sessions
.num_validated_vuids
++;
207 DLIST_ADD(sconn
->smb1
.sessions
.validated_users
, vuser
);
211 int register_homes_share(const char *username
)
216 result
= lp_servicenumber(username
);
218 DEBUG(3, ("Using static (or previously created) service for "
219 "user '%s'; path = '%s'\n", username
,
220 lp_pathname(result
)));
224 pwd
= getpwnam_alloc(talloc_tos(), username
);
226 if ((pwd
== NULL
) || (pwd
->pw_dir
[0] == '\0')) {
227 DEBUG(3, ("No home directory defined for user '%s'\n",
233 DEBUG(3, ("Adding homes service for user '%s' using home directory: "
234 "'%s'\n", username
, pwd
->pw_dir
));
236 result
= add_home_service(username
, username
, pwd
->pw_dir
);
243 * register that a valid login has been performed, establish 'session'.
244 * @param server_info The token returned from the authentication process.
245 * (now 'owned' by register_existing_vuid)
247 * @param session_key The User session key for the login session (now also
248 * 'owned' by register_existing_vuid)
250 * @param respose_blob The NT challenge-response, if available. (May be
251 * freed after this call)
253 * @param smb_name The untranslated name of the user
255 * @return Newly allocated vuid, biased by an offset. (This allows us to
256 * tell random client vuid's (normally zero) from valid vuids.)
260 int register_existing_vuid(struct smbd_server_connection
*sconn
,
262 struct auth_serversupplied_info
*server_info
,
263 DATA_BLOB response_blob
,
264 const char *smb_name
)
269 vuser
= get_partial_auth_user_struct(sconn
, vuid
);
274 /* Use this to keep tabs on all our info from the authentication */
275 vuser
->server_info
= talloc_move(vuser
, &server_info
);
277 /* This is a potentially untrusted username */
278 alpha_strcpy(tmp
, smb_name
, ". _-$", sizeof(tmp
));
280 vuser
->server_info
->sanitized_username
= talloc_strdup(
281 vuser
->server_info
, tmp
);
283 DEBUG(10,("register_existing_vuid: (%u,%u) %s %s %s guest=%d\n",
284 (unsigned int)vuser
->server_info
->utok
.uid
,
285 (unsigned int)vuser
->server_info
->utok
.gid
,
286 vuser
->server_info
->unix_name
,
287 vuser
->server_info
->sanitized_username
,
288 vuser
->server_info
->info3
->base
.domain
.string
,
289 vuser
->server_info
->guest
));
291 DEBUG(3, ("register_existing_vuid: User name: %s\t"
292 "Real name: %s\n", vuser
->server_info
->unix_name
,
293 vuser
->server_info
->info3
->base
.full_name
.string
));
295 if (!vuser
->server_info
->ptok
) {
296 DEBUG(1, ("register_existing_vuid: server_info does not "
297 "contain a user_token - cannot continue\n"));
301 DEBUG(3,("register_existing_vuid: UNIX uid %d is UNIX user %s, "
302 "and will be vuid %u\n", (int)vuser
->server_info
->utok
.uid
,
303 vuser
->server_info
->unix_name
, vuser
->vuid
));
305 if (!session_claim(sconn_server_id(sconn
), vuser
)) {
306 DEBUG(1, ("register_existing_vuid: Failed to claim session "
312 /* Register a home dir service for this user if
313 (a) This is not a guest connection,
314 (b) we have a home directory defined
315 (c) there s not an existing static share by that name
316 If a share exists by this name (autoloaded or not) reuse it . */
318 vuser
->homes_snum
= -1;
320 if (!vuser
->server_info
->guest
) {
321 vuser
->homes_snum
= register_homes_share(
322 vuser
->server_info
->unix_name
);
325 if (srv_is_signing_negotiated(sconn
) &&
326 !vuser
->server_info
->guest
) {
327 /* Try and turn on server signing on the first non-guest
329 srv_set_signing(sconn
,
330 vuser
->server_info
->user_session_key
,
334 /* fill in the current_user_info struct */
335 set_current_user_info(
336 vuser
->server_info
->sanitized_username
,
337 vuser
->server_info
->unix_name
,
338 vuser
->server_info
->info3
->base
.domain
.string
);
345 invalidate_vuid(sconn
, vuid
);
347 return UID_FIELD_INVALID
;
350 /****************************************************************************
351 Add a name to the session users list.
352 ****************************************************************************/
354 void add_session_user(struct smbd_server_connection
*sconn
,
360 pw
= Get_Pwnam_alloc(talloc_tos(), user
);
366 if (sconn
->smb1
.sessions
.session_userlist
== NULL
) {
367 sconn
->smb1
.sessions
.session_userlist
= SMB_STRDUP(pw
->pw_name
);
371 if (in_list(pw
->pw_name
,sconn
->smb1
.sessions
.session_userlist
,false)) {
375 if (strlen(sconn
->smb1
.sessions
.session_userlist
) > 128 * 1024) {
376 DEBUG(3,("add_session_user: session userlist already "
381 if (asprintf(&tmp
, "%s %s",
382 sconn
->smb1
.sessions
.session_userlist
, pw
->pw_name
) == -1) {
383 DEBUG(3, ("asprintf failed\n"));
387 SAFE_FREE(sconn
->smb1
.sessions
.session_userlist
);
388 sconn
->smb1
.sessions
.session_userlist
= tmp
;
393 /****************************************************************************
394 In security=share mode we need to store the client workgroup, as that's
395 what Vista uses for the NTLMv2 calculation.
396 ****************************************************************************/
398 void add_session_workgroup(struct smbd_server_connection
*sconn
,
399 const char *workgroup
)
401 if (sconn
->smb1
.sessions
.session_workgroup
) {
402 SAFE_FREE(sconn
->smb1
.sessions
.session_workgroup
);
404 sconn
->smb1
.sessions
.session_workgroup
= smb_xstrdup(workgroup
);
407 /****************************************************************************
408 In security=share mode we need to return the client workgroup, as that's
409 what Vista uses for the NTLMv2 calculation.
410 ****************************************************************************/
412 const char *get_session_workgroup(struct smbd_server_connection
*sconn
)
414 return sconn
->smb1
.sessions
.session_workgroup
;
417 /****************************************************************************
418 Check if a username is valid.
419 ****************************************************************************/
421 static bool user_ok(const char *user
, int snum
)
427 if (lp_invalid_users(snum
)) {
428 char **invalid
= str_list_copy(talloc_tos(),
429 lp_invalid_users(snum
));
431 str_list_substitute(invalid
, "%S", lp_servicename(snum
))) {
433 /* This is used in sec=share only, so no current user
434 * around to pass to str_list_sub_basic() */
436 if ( invalid
&& str_list_sub_basic(invalid
, "", "") ) {
437 ret
= !user_in_list(user
,
438 (const char **)invalid
);
441 TALLOC_FREE(invalid
);
444 if (ret
&& lp_valid_users(snum
)) {
445 char **valid
= str_list_copy(talloc_tos(),
446 lp_valid_users(snum
));
448 str_list_substitute(valid
, "%S", lp_servicename(snum
)) ) {
450 /* This is used in sec=share only, so no current user
451 * around to pass to str_list_sub_basic() */
453 if ( valid
&& str_list_sub_basic(valid
, "", "") ) {
454 ret
= user_in_list(user
,
455 (const char **)valid
);
461 if (ret
&& lp_onlyuser(snum
)) {
462 char **user_list
= str_list_make_v3(
463 talloc_tos(), lp_username(snum
), NULL
);
465 str_list_substitute(user_list
, "%S",
466 lp_servicename(snum
))) {
467 ret
= user_in_list(user
,
468 (const char **)user_list
);
470 TALLOC_FREE(user_list
);
476 /****************************************************************************
477 Validate a group username entry. Return the username or NULL.
478 ****************************************************************************/
480 static char *validate_group(struct smbd_server_connection
*sconn
,
481 char *group
, DATA_BLOB password
,int snum
)
485 char *host
, *user
, *domain
;
486 struct auth_context
*actx
= sconn
->smb1
.negprot
.auth_context
;
487 bool enc
= sconn
->smb1
.negprot
.encrypted_passwords
;
489 while (getnetgrent(&host
, &user
, &domain
)) {
491 if (user_ok(user
, snum
) &&
492 password_ok(actx
, enc
,
493 get_session_workgroup(sconn
),
507 struct auth_context
*actx
= sconn
->smb1
.negprot
.auth_context
;
508 bool enc
= sconn
->smb1
.negprot
.encrypted_passwords
;
511 while ((gptr
= (struct group
*)getgrent())) {
512 if (strequal(gptr
->gr_name
,group
))
517 * As user_ok can recurse doing a getgrent(), we must
518 * copy the member list onto the heap before
519 * use. Bug pointed out by leon@eatworms.swmed.edu.
523 char *member_list
= NULL
;
528 for(i
= 0; gptr
->gr_mem
&& gptr
->gr_mem
[i
]; i
++) {
529 list_len
+= strlen(gptr
->gr_mem
[i
])+1;
533 member_list
= (char *)SMB_MALLOC(list_len
);
540 member
= member_list
;
542 for(i
= 0; gptr
->gr_mem
&& gptr
->gr_mem
[i
]; i
++) {
543 size_t member_len
= strlen(gptr
->gr_mem
[i
])+1;
545 DEBUG(10,("validate_group: = gr_mem = "
546 "%s\n", gptr
->gr_mem
[i
]));
548 safe_strcpy(member
, gptr
->gr_mem
[i
],
549 list_len
- (member
-member_list
));
550 member
+= member_len
;
555 member
= member_list
;
557 if (user_ok(member
,snum
) &&
558 password_ok(actx
, enc
,
559 get_session_workgroup(sconn
),
561 char *name
= talloc_strdup(talloc_tos(),
563 SAFE_FREE(member_list
);
567 DEBUG(10,("validate_group = member = %s\n",
570 member
+= strlen(member
) + 1;
573 SAFE_FREE(member_list
);
583 /****************************************************************************
584 Check for authority to login to a service with a given username/password.
585 Note this is *NOT* used when logging on using sessionsetup_and_X.
586 ****************************************************************************/
588 bool authorise_login(struct smbd_server_connection
*sconn
,
589 int snum
, fstring user
, DATA_BLOB password
,
593 struct auth_context
*actx
= sconn
->smb1
.negprot
.auth_context
;
594 bool enc
= sconn
->smb1
.negprot
.encrypted_passwords
;
596 #ifdef DEBUG_PASSWORD
597 DEBUG(100,("authorise_login: checking authorisation on "
598 "user=%s pass=%s\n", user
,password
.data
));
603 /* there are several possibilities:
604 1) login as the given user with given password
605 2) login as a previously registered username with the given
607 3) login as a session list username with the given password
608 4) login as a previously validated user/password pair
609 5) login as the "user =" user with given password
610 6) login as the "user =" user with no password
612 7) login as guest user with no password
614 if the service is guest_only then steps 1 to 5 are skipped
617 /* now check the list of session users */
620 char *user_list
= NULL
;
623 if (sconn
->smb1
.sessions
.session_userlist
)
624 user_list
= SMB_STRDUP(sconn
->smb1
.sessions
.session_userlist
);
626 user_list
= SMB_STRDUP("");
631 for (auser
= strtok_r(user_list
, LIST_SEP
, &saveptr
);
633 auser
= strtok_r(NULL
, LIST_SEP
, &saveptr
)) {
635 fstrcpy(user2
,auser
);
636 if (!user_ok(user2
,snum
))
639 if (password_ok(actx
, enc
,
640 get_session_workgroup(sconn
),
644 DEBUG(3,("authorise_login: ACCEPTED: session "
645 "list username (%s) and given "
646 "password ok\n", user
));
650 SAFE_FREE(user_list
);
653 /* check the user= fields and the given password */
654 if (!ok
&& lp_username(snum
)) {
655 TALLOC_CTX
*ctx
= talloc_tos();
657 char *user_list
= talloc_strdup(ctx
, lp_username(snum
));
664 user_list
= talloc_string_sub(ctx
,
667 lp_servicename(snum
));
673 for (auser
= strtok_r(user_list
, LIST_SEP
, &saveptr
);
675 auser
= strtok_r(NULL
, LIST_SEP
, &saveptr
)) {
677 auser
= validate_group(sconn
,auser
+1,
682 DEBUG(3,("authorise_login: ACCEPTED: "
683 "group username and given "
684 "password ok (%s)\n", user
));
688 fstrcpy(user2
,auser
);
689 if (user_ok(user2
,snum
) &&
690 password_ok(actx
, enc
,
691 get_session_workgroup(sconn
),
695 DEBUG(3,("authorise_login: ACCEPTED: "
696 "user list username and "
697 "given password ok (%s)\n",
706 /* check for a normal guest connection */
707 if (!ok
&& GUEST_OK(snum
)) {
708 struct passwd
*guest_pw
;
710 fstrcpy(guestname
,lp_guestaccount());
711 guest_pw
= Get_Pwnam_alloc(talloc_tos(), guestname
);
712 if (guest_pw
!= NULL
) {
713 fstrcpy(user
,guestname
);
715 DEBUG(3,("authorise_login: ACCEPTED: guest account "
716 "and guest ok (%s)\n", user
));
718 DEBUG(0,("authorise_login: Invalid guest account "
719 "%s??\n",guestname
));
721 TALLOC_FREE(guest_pw
);
725 if (ok
&& !user_ok(user
, snum
)) {
726 DEBUG(0,("authorise_login: rejected invalid user %s\n",user
));