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->unix_info->sanitized_username = talloc_strdup(
285 vuser->session_info, tmp);
287 /* Make clear that we require the optional unix_token and unix_info in the source3 code */
288 SMB_ASSERT(vuser->session_info->unix_token);
289 SMB_ASSERT(vuser->session_info->unix_info);
291 DEBUG(10,("register_existing_vuid: (%u,%u) %s %s %s guest=%d\n",
292 (unsigned int)vuser->session_info->unix_token->uid,
293 (unsigned int)vuser->session_info->unix_token->gid,
294 vuser->session_info->unix_info->unix_name,
295 vuser->session_info->unix_info->sanitized_username,
296 vuser->session_info->info->domain_name,
297 vuser->session_info->unix_info->guest ));
299 DEBUG(3, ("register_existing_vuid: User name: %s\t"
300 "Real name: %s\n", vuser->session_info->unix_info->unix_name,
301 vuser->session_info->info->full_name));
303 if (!vuser->session_info->security_token) {
304 DEBUG(1, ("register_existing_vuid: session_info does not "
305 "contain a user_token - cannot continue\n"));
309 /* Make clear that we require the optional unix_token in the source3 code */
310 SMB_ASSERT(vuser->session_info->unix_token);
312 DEBUG(3,("register_existing_vuid: UNIX uid %d is UNIX user %s, "
313 "and will be vuid %u\n", (int)vuser->session_info->unix_token->uid,
314 vuser->session_info->unix_info->unix_name, vuser->vuid));
316 if (!session_claim(sconn, vuser)) {
317 DEBUG(1, ("register_existing_vuid: Failed to claim session "
323 /* Register a home dir service for this user if
324 (a) This is not a guest connection,
325 (b) we have a home directory defined
326 (c) there s not an existing static share by that name
327 If a share exists by this name (autoloaded or not) reuse it . */
329 vuser->homes_snum = -1;
331 if (!vuser->session_info->unix_info->guest) {
332 vuser->homes_snum = register_homes_share(
333 vuser->session_info->unix_info->unix_name);
336 if (srv_is_signing_negotiated(sconn) &&
337 !vuser->session_info->unix_info->guest) {
338 /* Try and turn on server signing on the first non-guest
340 srv_set_signing(sconn,
341 vuser->session_info->session_key,
345 /* fill in the current_user_info struct */
346 set_current_user_info(
347 vuser->session_info->unix_info->sanitized_username,
348 vuser->session_info->unix_info->unix_name,
349 vuser->session_info->info->domain_name);
356 invalidate_vuid(sconn, vuid);
358 return UID_FIELD_INVALID;
361 /****************************************************************************
362 Add a name to the session users list.
363 ****************************************************************************/
365 void add_session_user(struct smbd_server_connection *sconn,
371 pw = Get_Pwnam_alloc(talloc_tos(), user);
377 if (sconn->smb1.sessions.session_userlist == NULL) {
378 sconn->smb1.sessions.session_userlist = SMB_STRDUP(pw->pw_name);
382 if (in_list(pw->pw_name,sconn->smb1.sessions.session_userlist,false)) {
386 if (strlen(sconn->smb1.sessions.session_userlist) > 128 * 1024) {
387 DEBUG(3,("add_session_user: session userlist already "
392 if (asprintf(&tmp, "%s %s",
393 sconn->smb1.sessions.session_userlist, pw->pw_name) == -1) {
394 DEBUG(3, ("asprintf failed\n"));
398 SAFE_FREE(sconn->smb1.sessions.session_userlist);
399 sconn->smb1.sessions.session_userlist = tmp;
404 /****************************************************************************
405 In security=share mode we need to store the client workgroup, as that's
406 what Vista uses for the NTLMv2 calculation.
407 ****************************************************************************/
409 void add_session_workgroup(struct smbd_server_connection *sconn,
410 const char *workgroup)
412 if (sconn->smb1.sessions.session_workgroup) {
413 SAFE_FREE(sconn->smb1.sessions.session_workgroup);
415 sconn->smb1.sessions.session_workgroup = smb_xstrdup(workgroup);
418 /****************************************************************************
419 In security=share mode we need to return the client workgroup, as that's
420 what Vista uses for the NTLMv2 calculation.
421 ****************************************************************************/
423 const char *get_session_workgroup(struct smbd_server_connection *sconn)
425 return sconn->smb1.sessions.session_workgroup;
428 /****************************************************************************
429 Check if a username is valid.
430 ****************************************************************************/
432 static bool user_ok(const char *user, int snum)
438 if (lp_invalid_users(snum)) {
439 char **invalid = str_list_copy(talloc_tos(),
440 lp_invalid_users(snum));
442 str_list_substitute(invalid, "%S", lp_servicename(snum))) {
444 /* This is used in sec=share only, so no current user
445 * around to pass to str_list_sub_basic() */
447 if ( invalid && str_list_sub_basic(invalid, "", "") ) {
448 ret = !user_in_list(talloc_tos(), user,
449 (const char **)invalid);
452 TALLOC_FREE(invalid);
455 if (ret && lp_valid_users(snum)) {
456 char **valid = str_list_copy(talloc_tos(),
457 lp_valid_users(snum));
459 str_list_substitute(valid, "%S", lp_servicename(snum)) ) {
461 /* This is used in sec=share only, so no current user
462 * around to pass to str_list_sub_basic() */
464 if ( valid && str_list_sub_basic(valid, "", "") ) {
465 ret = user_in_list(talloc_tos(), user,
466 (const char **)valid);
472 if (ret && lp_onlyuser(snum)) {
473 char **user_list = str_list_make_v3(
474 talloc_tos(), lp_username(snum), NULL);
476 str_list_substitute(user_list, "%S",
477 lp_servicename(snum))) {
478 ret = user_in_list(talloc_tos(), user,
479 (const char **)user_list);
481 TALLOC_FREE(user_list);
487 /****************************************************************************
488 Validate a group username entry. Return the username or NULL.
489 ****************************************************************************/
491 static char *validate_group(struct smbd_server_connection *sconn,
492 char *group, DATA_BLOB password,int snum)
496 char *host, *user, *domain;
497 struct auth_context *actx = sconn->smb1.negprot.auth_context;
498 bool enc = sconn->smb1.negprot.encrypted_passwords;
500 while (getnetgrent(&host, &user, &domain)) {
502 if (user_ok(user, snum) &&
503 password_ok(actx, enc,
504 get_session_workgroup(sconn),
506 sconn->remote_address,
520 struct auth_context *actx = sconn->smb1.negprot.auth_context;
521 bool enc = sconn->smb1.negprot.encrypted_passwords;
524 while ((gptr = (struct group *)getgrent())) {
525 if (strequal(gptr->gr_name,group))
530 * As user_ok can recurse doing a getgrent(), we must
531 * copy the member list onto the heap before
532 * use. Bug pointed out by leon@eatworms.swmed.edu.
536 char *member_list = NULL;
541 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
542 list_len += strlen(gptr->gr_mem[i])+1;
546 member_list = (char *)SMB_MALLOC(list_len);
553 member = member_list;
555 for(i = 0; gptr->gr_mem && gptr->gr_mem[i]; i++) {
556 size_t member_len = strlen(gptr->gr_mem[i])+1;
558 DEBUG(10,("validate_group: = gr_mem = "
559 "%s\n", gptr->gr_mem[i]));
561 strlcpy(member, gptr->gr_mem[i],
562 list_len - (member-member_list));
563 member += member_len;
568 member = member_list;
570 if (user_ok(member,snum) &&
571 password_ok(actx, enc,
572 get_session_workgroup(sconn),
574 sconn->remote_address,
576 char *name = talloc_strdup(talloc_tos(),
578 SAFE_FREE(member_list);
582 DEBUG(10,("validate_group = member = %s\n",
585 member += strlen(member) + 1;
588 SAFE_FREE(member_list);
598 /****************************************************************************
599 Check for authority to login to a service with a given username/password.
600 Note this is *NOT* used when logging on using sessionsetup_and_X.
601 ****************************************************************************/
603 bool authorise_login(struct smbd_server_connection *sconn,
604 int snum, fstring user, DATA_BLOB password,
608 struct auth_context *actx = sconn->smb1.negprot.auth_context;
609 bool enc = sconn->smb1.negprot.encrypted_passwords;
611 #ifdef DEBUG_PASSWORD
612 DEBUG(100,("authorise_login: checking authorisation on "
613 "user=%s pass=%s\n", user,password.data));
618 /* there are several possibilities:
619 1) login as the given user with given password
620 2) login as a previously registered username with the given
622 3) login as a session list username with the given password
623 4) login as a previously validated user/password pair
624 5) login as the "user =" user with given password
625 6) login as the "user =" user with no password
627 7) login as guest user with no password
629 if the service is guest_only then steps 1 to 5 are skipped
632 /* now check the list of session users */
635 char *user_list = NULL;
638 if (sconn->smb1.sessions.session_userlist)
639 user_list = SMB_STRDUP(sconn->smb1.sessions.session_userlist);
641 user_list = SMB_STRDUP("");
646 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
648 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
650 fstrcpy(user2,auser);
651 if (!user_ok(user2,snum))
654 if (password_ok(actx, enc,
655 get_session_workgroup(sconn),
657 sconn->remote_address,
660 strlcpy(user,user2,sizeof(fstring));
661 DEBUG(3,("authorise_login: ACCEPTED: session "
662 "list username (%s) and given "
663 "password ok\n", user));
667 SAFE_FREE(user_list);
670 /* check the user= fields and the given password */
671 if (!ok && lp_username(snum)) {
672 TALLOC_CTX *ctx = talloc_tos();
674 char *user_list = talloc_strdup(ctx, lp_username(snum));
681 user_list = talloc_string_sub(ctx,
684 lp_servicename(snum));
690 for (auser = strtok_r(user_list, LIST_SEP, &saveptr);
692 auser = strtok_r(NULL, LIST_SEP, &saveptr)) {
694 auser = validate_group(sconn,auser+1,
699 DEBUG(3,("authorise_login: ACCEPTED: "
700 "group username and given "
701 "password ok (%s)\n", user));
705 fstrcpy(user2,auser);
706 if (user_ok(user2,snum) &&
707 password_ok(actx, enc,
708 get_session_workgroup(sconn),
710 sconn->remote_address,
713 strlcpy(user,user2,sizeof(fstring));
714 DEBUG(3,("authorise_login: ACCEPTED: "
715 "user list username and "
716 "given password ok (%s)\n",
725 /* check for a normal guest connection */
726 if (!ok && GUEST_OK(snum)) {
727 struct passwd *guest_pw;
729 fstrcpy(guestname,lp_guestaccount());
730 guest_pw = Get_Pwnam_alloc(talloc_tos(), guestname);
731 if (guest_pw != NULL) {
732 strlcpy(user,guestname,sizeof(fstring));
734 DEBUG(3,("authorise_login: ACCEPTED: guest account "
735 "and guest ok (%s)\n", user));
737 DEBUG(0,("authorise_login: Invalid guest account "
738 "%s??\n",guestname));
740 TALLOC_FREE(guest_pw);
744 if (ok && !user_ok(user, snum)) {
745 DEBUG(0,("authorise_login: rejected invalid user %s\n",user));