2 * Unix SMB/CIFS implementation.
3 * Authentication utility functions
4 * Copyright (C) Andrew Tridgell 1992-1998
5 * Copyright (C) Andrew Bartlett 2001
6 * Copyright (C) Jeremy Allison 2000-2001
7 * Copyright (C) Rafal Szczesniak 2002
8 * Copyright (C) Volker Lendecke 2006
9 * Copyright (C) Michael Adam 2007
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, see <http://www.gnu.org/licenses/>.
25 /* functions moved from auth/auth_util.c to minimize linker deps */
30 #include "../librpc/gen_ndr/netlogon.h"
31 #include "../libcli/security/security.h"
32 #include "../lib/util/util_pw.h"
33 #include "lib/winbind_util.h"
36 /****************************************************************************
37 Check for a SID in an struct security_token
38 ****************************************************************************/
40 bool nt_token_check_sid ( const struct dom_sid *sid, const struct security_token *token )
45 return security_token_has_sid(token, sid);
48 bool nt_token_check_domain_rid( struct security_token *token, uint32 rid )
50 struct dom_sid domain_sid;
52 /* if we are a domain member, the get the domain SID, else for
53 a DC or standalone server, use our own SID */
55 if ( lp_server_role() == ROLE_DOMAIN_MEMBER ) {
56 if ( !secrets_fetch_domain_sid( lp_workgroup(),
58 DEBUG(1,("nt_token_check_domain_rid: Cannot lookup "
59 "SID for domain [%s]\n", lp_workgroup()));
64 sid_copy( &domain_sid, get_global_sam_sid() );
66 sid_append_rid( &domain_sid, rid );
68 return nt_token_check_sid( &domain_sid, token );\
71 /******************************************************************************
72 Create a token for the root user to be used internally by smbd.
73 This is similar to running under the context of the LOCAL_SYSTEM account
74 in Windows. This is a read-only token. Do not modify it or free() it.
75 Create a copy if you need to change it.
76 ******************************************************************************/
78 struct security_token *get_root_nt_token( void )
80 struct security_token *token, *for_cache;
81 struct dom_sid u_sid, g_sid;
85 cache_data = memcache_lookup_talloc(
86 NULL, SINGLETON_CACHE_TALLOC,
87 data_blob_string_const_null("root_nt_token"));
89 if (cache_data != NULL) {
90 return talloc_get_type_abort(
91 cache_data, struct security_token);
94 if ( !(pw = sys_getpwuid(0)) ) {
95 if ( !(pw = sys_getpwnam("root")) ) {
96 DEBUG(0,("get_root_nt_token: both sys_getpwuid(0) "
97 "and sys_getpwnam(\"root\") failed!\n"));
102 /* get the user and primary group SIDs; although the
103 BUILTIN\Administrators SId is really the one that matters here */
105 uid_to_sid(&u_sid, pw->pw_uid);
106 gid_to_sid(&g_sid, pw->pw_gid);
108 token = create_local_nt_token(talloc_tos(), &u_sid, False,
109 1, &global_sid_Builtin_Administrators);
111 security_token_set_privilege(token, SEC_PRIV_DISK_OPERATOR);
116 NULL, SINGLETON_CACHE_TALLOC,
117 data_blob_string_const_null("root_nt_token"), &for_cache);
124 * Add alias SIDs from memberships within the partially created token SID list
127 NTSTATUS add_aliases(const struct dom_sid *domain_sid,
128 struct security_token *token)
131 size_t i, num_aliases;
135 if (!(tmp_ctx = talloc_init("add_aliases"))) {
136 return NT_STATUS_NO_MEMORY;
142 status = pdb_enum_alias_memberships(tmp_ctx, domain_sid,
145 &aliases, &num_aliases);
147 if (!NT_STATUS_IS_OK(status)) {
148 DEBUG(10, ("pdb_enum_alias_memberships failed: %s\n",
153 for (i=0; i<num_aliases; i++) {
154 struct dom_sid alias_sid;
155 sid_compose(&alias_sid, domain_sid, aliases[i]);
156 status = add_sid_to_array_unique(token, &alias_sid,
159 if (!NT_STATUS_IS_OK(status)) {
160 DEBUG(0, ("add_sid_to_array failed\n"));
166 TALLOC_FREE(tmp_ctx);
170 /*******************************************************************
171 *******************************************************************/
173 static NTSTATUS add_builtin_administrators(struct security_token *token,
174 const struct dom_sid *dom_sid)
176 struct dom_sid domadm;
179 /* nothing to do if we aren't in a domain */
181 if ( !(IS_DC || lp_server_role()==ROLE_DOMAIN_MEMBER) ) {
185 /* Find the Domain Admins SID */
188 sid_copy( &domadm, get_global_sam_sid() );
190 sid_copy(&domadm, dom_sid);
192 sid_append_rid( &domadm, DOMAIN_RID_ADMINS );
194 /* Add Administrators if the user beloongs to Domain Admins */
196 if ( nt_token_check_sid( &domadm, token ) ) {
197 status = add_sid_to_array(token,
198 &global_sid_Builtin_Administrators,
199 &token->sids, &token->num_sids);
200 if (!NT_STATUS_IS_OK(status)) {
208 static NTSTATUS finalize_local_nt_token(struct security_token *result,
211 NTSTATUS create_local_nt_token_from_info3(TALLOC_CTX *mem_ctx,
213 struct netr_SamInfo3 *info3,
214 struct extra_auth_info *extra,
215 struct security_token **ntok)
217 struct security_token *usrtok = NULL;
221 DEBUG(10, ("Create local NT token for %s\n",
222 info3->base.account_name.string));
224 usrtok = talloc_zero(mem_ctx, struct security_token);
226 DEBUG(0, ("talloc failed\n"));
227 return NT_STATUS_NO_MEMORY;
230 /* Add the user and primary group sid FIRST */
231 /* check if the user rid is the special "Domain Guests" rid.
232 * If so pick the first sid for the extra sids instead as it
233 * is a local fake account */
234 usrtok->sids = talloc_array(usrtok, struct dom_sid, 2);
237 return NT_STATUS_NO_MEMORY;
239 usrtok->num_sids = 2;
242 if (info3->base.rid == (uint32_t)(-1)) {
243 /* this is a signal the user was fake and generated,
244 * the actual SID we want to use is stored in the extra
246 if (is_null_sid(&extra->user_sid)) {
247 /* we couldn't find the user sid, bail out */
248 DEBUG(3, ("Invalid user SID\n"));
250 return NT_STATUS_UNSUCCESSFUL;
252 sid_copy(&usrtok->sids[0], &extra->user_sid);
254 sid_copy(&usrtok->sids[0], info3->base.domain_sid);
255 sid_append_rid(&usrtok->sids[0], info3->base.rid);
259 if (info3->base.primary_gid == (uint32_t)(-1)) {
260 /* this is a signal the user was fake and generated,
261 * the actual SID we want to use is stored in the extra
263 if (is_null_sid(&extra->pgid_sid)) {
264 /* we couldn't find the user sid, bail out */
265 DEBUG(3, ("Invalid group SID\n"));
267 return NT_STATUS_UNSUCCESSFUL;
269 sid_copy(&usrtok->sids[1], &extra->pgid_sid);
271 sid_copy(&usrtok->sids[1], info3->base.domain_sid);
272 sid_append_rid(&usrtok->sids[1],
273 info3->base.primary_gid);
276 /* Now the SIDs we got from authentication. These are the ones from
277 * the info3 struct or from the pdb_enum_group_memberships, depending
278 * on who authenticated the user.
279 * Note that we start the for loop at "1" here, we already added the
280 * first group sid as primary above. */
282 for (i = 0; i < info3->base.groups.count; i++) {
283 struct dom_sid tmp_sid;
285 sid_copy(&tmp_sid, info3->base.domain_sid);
286 sid_append_rid(&tmp_sid, info3->base.groups.rids[i].rid);
288 status = add_sid_to_array_unique(usrtok, &tmp_sid,
291 if (!NT_STATUS_IS_OK(status)) {
292 DEBUG(3, ("Failed to add SID to nt token\n"));
298 /* now also add extra sids if they are not the special user/group
300 for (i = 0; i < info3->sidcount; i++) {
301 status = add_sid_to_array_unique(usrtok,
305 if (!NT_STATUS_IS_OK(status)) {
306 DEBUG(3, ("Failed to add SID to nt token\n"));
312 status = finalize_local_nt_token(usrtok, is_guest);
313 if (!NT_STATUS_IS_OK(status)) {
314 DEBUG(3, ("Failed to finalize nt token\n"));
323 /*******************************************************************
324 Create a NT token for the user, expanding local aliases
325 *******************************************************************/
327 struct security_token *create_local_nt_token(TALLOC_CTX *mem_ctx,
328 const struct dom_sid *user_sid,
331 const struct dom_sid *groupsids)
333 struct security_token *result = NULL;
337 DEBUG(10, ("Create local NT token for %s\n",
338 sid_string_dbg(user_sid)));
340 if (!(result = TALLOC_ZERO_P(mem_ctx, struct security_token))) {
341 DEBUG(0, ("talloc failed\n"));
345 /* Add the user and primary group sid */
347 status = add_sid_to_array(result, user_sid,
348 &result->sids, &result->num_sids);
349 if (!NT_STATUS_IS_OK(status)) {
354 /* For guest, num_groupsids may be zero. */
356 status = add_sid_to_array(result, &groupsids[0],
359 if (!NT_STATUS_IS_OK(status)) {
365 /* Now the SIDs we got from authentication. These are the ones from
366 * the info3 struct or from the pdb_enum_group_memberships, depending
367 * on who authenticated the user.
368 * Note that we start the for loop at "1" here, we already added the
369 * first group sid as primary above. */
371 for (i=1; i<num_groupsids; i++) {
372 status = add_sid_to_array_unique(result, &groupsids[i],
375 if (!NT_STATUS_IS_OK(status)) {
381 status = finalize_local_nt_token(result, is_guest);
382 if (!NT_STATUS_IS_OK(status)) {
390 static NTSTATUS finalize_local_nt_token(struct security_token *result,
393 struct dom_sid dom_sid;
397 /* Add in BUILTIN sids */
399 status = add_sid_to_array(result, &global_sid_World,
400 &result->sids, &result->num_sids);
401 if (!NT_STATUS_IS_OK(status)) {
404 status = add_sid_to_array(result, &global_sid_Network,
405 &result->sids, &result->num_sids);
406 if (!NT_STATUS_IS_OK(status)) {
411 status = add_sid_to_array(result, &global_sid_Builtin_Guests,
414 if (!NT_STATUS_IS_OK(status)) {
418 status = add_sid_to_array(result,
419 &global_sid_Authenticated_Users,
422 if (!NT_STATUS_IS_OK(status)) {
427 /* Deal with the BUILTIN\Administrators group. If the SID can
428 be resolved then assume that the add_aliasmem( S-1-5-32 )
431 if (!sid_to_gid(&global_sid_Builtin_Administrators, &gid)) {
434 if (!secrets_fetch_domain_sid(lp_workgroup(), &dom_sid)) {
435 status = NT_STATUS_OK;
436 DEBUG(3, ("Failed to fetch domain sid for %s\n",
439 status = create_builtin_administrators(&dom_sid);
443 if (NT_STATUS_EQUAL(status, NT_STATUS_PROTOCOL_UNREACHABLE)) {
444 /* Add BUILTIN\Administrators directly to token. */
445 status = add_builtin_administrators(result, &dom_sid);
446 if ( !NT_STATUS_IS_OK(status) ) {
447 DEBUG(3, ("Failed to check for local "
448 "Administrators membership (%s)\n",
451 } else if (!NT_STATUS_IS_OK(status)) {
452 DEBUG(2, ("WARNING: Failed to create "
453 "BUILTIN\\Administrators group! Can "
454 "Winbind allocate gids?\n"));
458 /* Deal with the BUILTIN\Users group. If the SID can
459 be resolved then assume that the add_aliasmem( S-1-5-32 )
462 if (!sid_to_gid(&global_sid_Builtin_Users, &gid)) {
465 if (!secrets_fetch_domain_sid(lp_workgroup(), &dom_sid)) {
466 status = NT_STATUS_OK;
467 DEBUG(3, ("Failed to fetch domain sid for %s\n",
470 status = create_builtin_users(&dom_sid);
474 if (!NT_STATUS_EQUAL(status, NT_STATUS_PROTOCOL_UNREACHABLE) &&
475 !NT_STATUS_IS_OK(status))
477 DEBUG(2, ("WARNING: Failed to create BUILTIN\\Users group! "
478 "Can Winbind allocate gids?\n"));
482 /* Deal with local groups */
484 if (lp_winbind_nested_groups()) {
488 /* Now add the aliases. First the one from our local SAM */
490 status = add_aliases(get_global_sam_sid(), result);
492 if (!NT_STATUS_IS_OK(status)) {
497 /* Finally the builtin ones */
499 status = add_aliases(&global_sid_Builtin, result);
501 if (!NT_STATUS_IS_OK(status)) {
509 /* Add privileges based on current user sids */
511 get_privileges_for_sids(&result->privilege_mask, result->sids,
517 /****************************************************************************
518 prints a UNIX 'token' to debug output.
519 ****************************************************************************/
521 void debug_unix_user_token(int dbg_class, int dbg_lev, uid_t uid, gid_t gid,
522 int n_groups, gid_t *groups)
525 DEBUGC(dbg_class, dbg_lev,
526 ("UNIX token of user %ld\n", (long int)uid));
528 DEBUGADDC(dbg_class, dbg_lev,
529 ("Primary group is %ld and contains %i supplementary "
530 "groups\n", (long int)gid, n_groups));
531 for (i = 0; i < n_groups; i++)
532 DEBUGADDC(dbg_class, dbg_lev, ("Group[%3i]: %ld\n", i,
533 (long int)groups[i]));
537 * Create an artificial NT token given just a username. (Initially intended
540 * We go through lookup_name() to avoid problems we had with 'winbind use
545 * unmapped unix users: Go directly to nss to find the user's group.
547 * A passdb user: The list of groups is provided by pdb_enum_group_memberships.
549 * If the user is provided by winbind, the primary gid is set to "domain
550 * users" of the user's domain. For an explanation why this is necessary, see
551 * the thread starting at
552 * http://lists.samba.org/archive/samba-technical/2006-January/044803.html.
555 NTSTATUS create_token_from_username(TALLOC_CTX *mem_ctx, const char *username,
557 uid_t *uid, gid_t *gid,
558 char **found_username,
559 struct security_token **token)
561 NTSTATUS result = NT_STATUS_NO_SUCH_USER;
562 TALLOC_CTX *tmp_ctx = talloc_stackframe();
563 struct dom_sid user_sid;
564 enum lsa_SidType type;
566 struct dom_sid *group_sids;
567 struct dom_sid unix_group_sid;
568 uint32_t num_group_sids;
572 if (!lookup_name_smbconf(tmp_ctx, username, LOOKUP_NAME_ALL,
573 NULL, NULL, &user_sid, &type)) {
574 DEBUG(1, ("lookup_name_smbconf for %s failed\n", username));
578 if (type != SID_NAME_USER) {
579 DEBUG(1, ("%s is a %s, not a user\n", username,
580 sid_type_lookup(type)));
584 if (sid_check_is_in_our_domain(&user_sid)) {
586 uint32_t pdb_num_group_sids;
587 /* This is a passdb user, so ask passdb */
589 struct samu *sam_acct = NULL;
591 if ( !(sam_acct = samu_new( tmp_ctx )) ) {
592 result = NT_STATUS_NO_MEMORY;
597 ret = pdb_getsampwsid(sam_acct, &user_sid);
601 DEBUG(1, ("pdb_getsampwsid(%s) for user %s failed\n",
602 sid_string_dbg(&user_sid), username));
603 DEBUGADD(1, ("Fall back to unix user %s\n", username));
607 result = pdb_enum_group_memberships(tmp_ctx, sam_acct,
609 &pdb_num_group_sids);
610 if (!NT_STATUS_IS_OK(result)) {
611 DEBUG(1, ("enum_group_memberships failed for %s (%s): "
612 "%s\n", username, sid_string_dbg(&user_sid),
614 DEBUGADD(1, ("Fall back to unix user %s\n", username));
617 num_group_sids = pdb_num_group_sids;
619 /* see the smb_panic() in pdb_default_enum_group_memberships */
620 SMB_ASSERT(num_group_sids > 0);
624 /* Ensure we're returning the found_username on the right context. */
625 *found_username = talloc_strdup(mem_ctx,
626 pdb_get_username(sam_acct));
629 * If the SID from lookup_name() was the guest sid, passdb knows
630 * about the mapping of guest sid to lp_guestaccount()
631 * username and will return the unix_pw info for a guest
632 * user. Use it if it's there, else lookup the *uid details
633 * using Get_Pwnam_alloc(). See bug #6291 for details. JRA.
636 /* We must always assign the *uid. */
637 if (sam_acct->unix_pw == NULL) {
638 struct passwd *pwd = Get_Pwnam_alloc(sam_acct, *found_username );
640 DEBUG(10, ("Get_Pwnam_alloc failed for %s\n",
642 result = NT_STATUS_NO_SUCH_USER;
645 result = samu_set_unix(sam_acct, pwd );
646 if (!NT_STATUS_IS_OK(result)) {
647 DEBUG(10, ("samu_set_unix failed for %s\n",
649 result = NT_STATUS_NO_SUCH_USER;
653 *uid = sam_acct->unix_pw->pw_uid;
655 } else if (sid_check_is_in_unix_users(&user_sid)) {
656 uint32_t getgroups_num_group_sids;
657 /* This is a unix user not in passdb. We need to ask nss
658 * directly, without consulting passdb */
663 * This goto target is used as a fallback for the passdb
664 * case. The concrete bug report is when passdb gave us an
670 if (!sid_to_uid(&user_sid, uid)) {
671 DEBUG(1, ("unix_user case, sid_to_uid for %s (%s) failed\n",
672 username, sid_string_dbg(&user_sid)));
673 result = NT_STATUS_NO_SUCH_USER;
677 uid_to_unix_users_sid(*uid, &user_sid);
679 pass = getpwuid_alloc(tmp_ctx, *uid);
681 DEBUG(1, ("getpwuid(%u) for user %s failed\n",
682 (unsigned int)*uid, username));
686 if (!getgroups_unix_user(tmp_ctx, username, pass->pw_gid,
687 &gids, &getgroups_num_group_sids)) {
688 DEBUG(1, ("getgroups_unix_user for user %s failed\n",
692 num_group_sids = getgroups_num_group_sids;
694 if (num_group_sids) {
695 group_sids = TALLOC_ARRAY(tmp_ctx, struct dom_sid, num_group_sids);
696 if (group_sids == NULL) {
697 DEBUG(1, ("TALLOC_ARRAY failed\n"));
698 result = NT_STATUS_NO_MEMORY;
705 for (i=0; i<num_group_sids; i++) {
706 gid_to_sid(&group_sids[i], gids[i]);
709 /* In getgroups_unix_user we always set the primary gid */
710 SMB_ASSERT(num_group_sids > 0);
714 /* Ensure we're returning the found_username on the right context. */
715 *found_username = talloc_strdup(mem_ctx, pass->pw_name);
718 /* This user is from winbind, force the primary gid to the
719 * user's "domain users" group. Under certain circumstances
720 * (user comes from NT4), this might be a loss of
721 * information. But we can not rely on winbind getting the
722 * correct info. AD might prohibit winbind looking up that
725 /* We must always assign the *uid. */
726 if (!sid_to_uid(&user_sid, uid)) {
727 DEBUG(1, ("winbindd case, sid_to_uid for %s (%s) failed\n",
728 username, sid_string_dbg(&user_sid)));
729 result = NT_STATUS_NO_SUCH_USER;
734 group_sids = TALLOC_ARRAY(tmp_ctx, struct dom_sid, num_group_sids);
735 if (group_sids == NULL) {
736 DEBUG(1, ("TALLOC_ARRAY failed\n"));
737 result = NT_STATUS_NO_MEMORY;
741 sid_copy(&group_sids[0], &user_sid);
742 sid_split_rid(&group_sids[0], NULL);
743 sid_append_rid(&group_sids[0], DOMAIN_RID_USERS);
745 if (!sid_to_gid(&group_sids[0], gid)) {
746 DEBUG(1, ("sid_to_gid(%s) failed\n",
747 sid_string_dbg(&group_sids[0])));
753 /* Ensure we're returning the found_username on the right context. */
754 *found_username = talloc_strdup(mem_ctx, username);
757 /* Add the "Unix Group" SID for each gid to catch mapped groups
758 and their Unix equivalent. This is to solve the backwards
759 compatibility problem of 'valid users = +ntadmin' where
760 ntadmin has been paired with "Domain Admins" in the group
761 mapping table. Otherwise smb.conf would need to be changed
762 to 'valid user = "Domain Admins"'. --jerry */
764 num_gids = num_group_sids;
765 for ( i=0; i<num_gids; i++ ) {
768 /* don't pickup anything managed by Winbind */
770 if ( lp_idmap_gid(&low, &high) && (gids[i] >= low) && (gids[i] <= high) )
773 gid_to_unix_groups_sid(gids[i], &unix_group_sid);
775 result = add_sid_to_array_unique(tmp_ctx, &unix_group_sid,
776 &group_sids, &num_group_sids);
777 if (!NT_STATUS_IS_OK(result)) {
782 /* Ensure we're creating the nt_token on the right context. */
783 *token = create_local_nt_token(mem_ctx, &user_sid,
784 is_guest, num_group_sids, group_sids);
786 if ((*token == NULL) || (*found_username == NULL)) {
787 result = NT_STATUS_NO_MEMORY;
791 result = NT_STATUS_OK;
793 TALLOC_FREE(tmp_ctx);
797 /***************************************************************************
798 Build upon create_token_from_username:
800 Expensive helper function to figure out whether a user given its name is
801 member of a particular group.
802 ***************************************************************************/
804 bool user_in_group_sid(const char *username, const struct dom_sid *group_sid)
809 char *found_username;
810 struct security_token *token;
812 TALLOC_CTX *mem_ctx = talloc_stackframe();
814 status = create_token_from_username(mem_ctx, username, False,
815 &uid, &gid, &found_username,
818 if (!NT_STATUS_IS_OK(status)) {
819 DEBUG(10, ("could not create token for %s\n", username));
820 TALLOC_FREE(mem_ctx);
824 result = security_token_has_sid(token, group_sid);
826 TALLOC_FREE(mem_ctx);
830 bool user_in_group(const char *username, const char *groupname)
832 TALLOC_CTX *mem_ctx = talloc_stackframe();
833 struct dom_sid group_sid;
836 ret = lookup_name(mem_ctx, groupname, LOOKUP_NAME_ALL,
837 NULL, NULL, &group_sid, NULL);
838 TALLOC_FREE(mem_ctx);
841 DEBUG(10, ("lookup_name for (%s) failed.\n", groupname));
845 return user_in_group_sid(username, &group_sid);