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 */
31 #include "../librpc/gen_ndr/netlogon.h"
32 #include "../libcli/security/security.h"
33 #include "../lib/util/util_pw.h"
35 #include "lib/privileges.h"
37 /****************************************************************************
38 Check for a SID in an struct security_token
39 ****************************************************************************/
41 bool nt_token_check_sid ( const struct dom_sid
*sid
, const struct security_token
*token
)
46 return security_token_has_sid(token
, sid
);
49 bool nt_token_check_domain_rid( struct security_token
*token
, uint32 rid
)
51 struct dom_sid domain_sid
;
53 /* if we are a domain member, the get the domain SID, else for
54 a DC or standalone server, use our own SID */
56 if ( lp_server_role() == ROLE_DOMAIN_MEMBER
) {
57 if ( !secrets_fetch_domain_sid( lp_workgroup(),
59 DEBUG(1,("nt_token_check_domain_rid: Cannot lookup "
60 "SID for domain [%s]\n", lp_workgroup()));
65 sid_copy( &domain_sid
, get_global_sam_sid() );
67 sid_append_rid( &domain_sid
, rid
);
69 return nt_token_check_sid( &domain_sid
, token
);\
72 /******************************************************************************
73 Create a token for the root user to be used internally by smbd.
74 This is similar to running under the context of the LOCAL_SYSTEM account
75 in Windows. This is a read-only token. Do not modify it or free() it.
76 Create a copy if you need to change it.
77 ******************************************************************************/
79 struct security_token
*get_root_nt_token( void )
81 struct security_token
*token
, *for_cache
;
82 struct dom_sid u_sid
, g_sid
;
86 cache_data
= memcache_lookup_talloc(
87 NULL
, SINGLETON_CACHE_TALLOC
,
88 data_blob_string_const_null("root_nt_token"));
90 if (cache_data
!= NULL
) {
91 return talloc_get_type_abort(
92 cache_data
, struct security_token
);
95 if ( !(pw
= sys_getpwuid(0)) ) {
96 if ( !(pw
= sys_getpwnam("root")) ) {
97 DEBUG(0,("get_root_nt_token: both sys_getpwuid(0) "
98 "and sys_getpwnam(\"root\") failed!\n"));
103 /* get the user and primary group SIDs; although the
104 BUILTIN\Administrators SId is really the one that matters here */
106 uid_to_sid(&u_sid
, pw
->pw_uid
);
107 gid_to_sid(&g_sid
, pw
->pw_gid
);
109 token
= create_local_nt_token(talloc_tos(), &u_sid
, False
,
110 1, &global_sid_Builtin_Administrators
);
112 security_token_set_privilege(token
, SEC_PRIV_DISK_OPERATOR
);
117 NULL
, SINGLETON_CACHE_TALLOC
,
118 data_blob_string_const_null("root_nt_token"), &for_cache
);
125 * Add alias SIDs from memberships within the partially created token SID list
128 NTSTATUS
add_aliases(const struct dom_sid
*domain_sid
,
129 struct security_token
*token
)
132 size_t i
, num_aliases
;
136 if (!(tmp_ctx
= talloc_init("add_aliases"))) {
137 return NT_STATUS_NO_MEMORY
;
143 status
= pdb_enum_alias_memberships(tmp_ctx
, domain_sid
,
146 &aliases
, &num_aliases
);
148 if (!NT_STATUS_IS_OK(status
)) {
149 DEBUG(10, ("pdb_enum_alias_memberships failed: %s\n",
154 for (i
=0; i
<num_aliases
; i
++) {
155 struct dom_sid alias_sid
;
156 sid_compose(&alias_sid
, domain_sid
, aliases
[i
]);
157 status
= add_sid_to_array_unique(token
, &alias_sid
,
160 if (!NT_STATUS_IS_OK(status
)) {
161 DEBUG(0, ("add_sid_to_array failed\n"));
167 TALLOC_FREE(tmp_ctx
);
171 /*******************************************************************
172 *******************************************************************/
174 static NTSTATUS
add_builtin_administrators(struct security_token
*token
,
175 const struct dom_sid
*dom_sid
)
177 struct dom_sid domadm
;
180 /* nothing to do if we aren't in a domain */
182 if ( !(IS_DC
|| lp_server_role()==ROLE_DOMAIN_MEMBER
) ) {
186 /* Find the Domain Admins SID */
189 sid_copy( &domadm
, get_global_sam_sid() );
191 sid_copy(&domadm
, dom_sid
);
193 sid_append_rid( &domadm
, DOMAIN_RID_ADMINS
);
195 /* Add Administrators if the user beloongs to Domain Admins */
197 if ( nt_token_check_sid( &domadm
, token
) ) {
198 status
= add_sid_to_array(token
,
199 &global_sid_Builtin_Administrators
,
200 &token
->sids
, &token
->num_sids
);
201 if (!NT_STATUS_IS_OK(status
)) {
209 static NTSTATUS
finalize_local_nt_token(struct security_token
*result
,
212 NTSTATUS
create_local_nt_token_from_info3(TALLOC_CTX
*mem_ctx
,
214 struct netr_SamInfo3
*info3
,
215 struct extra_auth_info
*extra
,
216 struct security_token
**ntok
)
218 struct security_token
*usrtok
= NULL
;
222 DEBUG(10, ("Create local NT token for %s\n",
223 info3
->base
.account_name
.string
));
225 usrtok
= talloc_zero(mem_ctx
, struct security_token
);
227 DEBUG(0, ("talloc failed\n"));
228 return NT_STATUS_NO_MEMORY
;
231 /* Add the user and primary group sid FIRST */
232 /* check if the user rid is the special "Domain Guests" rid.
233 * If so pick the first sid for the extra sids instead as it
234 * is a local fake account */
235 usrtok
->sids
= talloc_array(usrtok
, struct dom_sid
, 2);
238 return NT_STATUS_NO_MEMORY
;
240 usrtok
->num_sids
= 2;
243 if (info3
->base
.rid
== (uint32_t)(-1)) {
244 /* this is a signal the user was fake and generated,
245 * the actual SID we want to use is stored in the extra
247 if (is_null_sid(&extra
->user_sid
)) {
248 /* we couldn't find the user sid, bail out */
249 DEBUG(3, ("Invalid user SID\n"));
251 return NT_STATUS_UNSUCCESSFUL
;
253 sid_copy(&usrtok
->sids
[0], &extra
->user_sid
);
255 sid_copy(&usrtok
->sids
[0], info3
->base
.domain_sid
);
256 sid_append_rid(&usrtok
->sids
[0], info3
->base
.rid
);
260 if (info3
->base
.primary_gid
== (uint32_t)(-1)) {
261 /* this is a signal the user was fake and generated,
262 * the actual SID we want to use is stored in the extra
264 if (is_null_sid(&extra
->pgid_sid
)) {
265 /* we couldn't find the user sid, bail out */
266 DEBUG(3, ("Invalid group SID\n"));
268 return NT_STATUS_UNSUCCESSFUL
;
270 sid_copy(&usrtok
->sids
[1], &extra
->pgid_sid
);
272 sid_copy(&usrtok
->sids
[1], info3
->base
.domain_sid
);
273 sid_append_rid(&usrtok
->sids
[1],
274 info3
->base
.primary_gid
);
277 /* Now the SIDs we got from authentication. These are the ones from
278 * the info3 struct or from the pdb_enum_group_memberships, depending
279 * on who authenticated the user.
280 * Note that we start the for loop at "1" here, we already added the
281 * first group sid as primary above. */
283 for (i
= 0; i
< info3
->base
.groups
.count
; i
++) {
284 struct dom_sid tmp_sid
;
286 sid_copy(&tmp_sid
, info3
->base
.domain_sid
);
287 sid_append_rid(&tmp_sid
, info3
->base
.groups
.rids
[i
].rid
);
289 status
= add_sid_to_array_unique(usrtok
, &tmp_sid
,
292 if (!NT_STATUS_IS_OK(status
)) {
293 DEBUG(3, ("Failed to add SID to nt token\n"));
299 /* now also add extra sids if they are not the special user/group
301 for (i
= 0; i
< info3
->sidcount
; i
++) {
302 status
= add_sid_to_array_unique(usrtok
,
306 if (!NT_STATUS_IS_OK(status
)) {
307 DEBUG(3, ("Failed to add SID to nt token\n"));
313 status
= finalize_local_nt_token(usrtok
, is_guest
);
314 if (!NT_STATUS_IS_OK(status
)) {
315 DEBUG(3, ("Failed to finalize nt token\n"));
324 /*******************************************************************
325 Create a NT token for the user, expanding local aliases
326 *******************************************************************/
328 struct security_token
*create_local_nt_token(TALLOC_CTX
*mem_ctx
,
329 const struct dom_sid
*user_sid
,
332 const struct dom_sid
*groupsids
)
334 struct security_token
*result
= NULL
;
338 DEBUG(10, ("Create local NT token for %s\n",
339 sid_string_dbg(user_sid
)));
341 if (!(result
= TALLOC_ZERO_P(mem_ctx
, struct security_token
))) {
342 DEBUG(0, ("talloc failed\n"));
346 /* Add the user and primary group sid */
348 status
= add_sid_to_array(result
, user_sid
,
349 &result
->sids
, &result
->num_sids
);
350 if (!NT_STATUS_IS_OK(status
)) {
355 /* For guest, num_groupsids may be zero. */
357 status
= add_sid_to_array(result
, &groupsids
[0],
360 if (!NT_STATUS_IS_OK(status
)) {
366 /* Now the SIDs we got from authentication. These are the ones from
367 * the info3 struct or from the pdb_enum_group_memberships, depending
368 * on who authenticated the user.
369 * Note that we start the for loop at "1" here, we already added the
370 * first group sid as primary above. */
372 for (i
=1; i
<num_groupsids
; i
++) {
373 status
= add_sid_to_array_unique(result
, &groupsids
[i
],
376 if (!NT_STATUS_IS_OK(status
)) {
382 status
= finalize_local_nt_token(result
, is_guest
);
383 if (!NT_STATUS_IS_OK(status
)) {
391 static NTSTATUS
finalize_local_nt_token(struct security_token
*result
,
394 struct dom_sid dom_sid
;
398 /* Add in BUILTIN sids */
400 status
= add_sid_to_array(result
, &global_sid_World
,
401 &result
->sids
, &result
->num_sids
);
402 if (!NT_STATUS_IS_OK(status
)) {
405 status
= add_sid_to_array(result
, &global_sid_Network
,
406 &result
->sids
, &result
->num_sids
);
407 if (!NT_STATUS_IS_OK(status
)) {
412 status
= add_sid_to_array(result
, &global_sid_Builtin_Guests
,
415 if (!NT_STATUS_IS_OK(status
)) {
419 status
= add_sid_to_array(result
,
420 &global_sid_Authenticated_Users
,
423 if (!NT_STATUS_IS_OK(status
)) {
428 /* Deal with the BUILTIN\Administrators group. If the SID can
429 be resolved then assume that the add_aliasmem( S-1-5-32 )
432 if (!sid_to_gid(&global_sid_Builtin_Administrators
, &gid
)) {
435 if (!secrets_fetch_domain_sid(lp_workgroup(), &dom_sid
)) {
436 status
= NT_STATUS_OK
;
437 DEBUG(3, ("Failed to fetch domain sid for %s\n",
440 status
= create_builtin_administrators(&dom_sid
);
444 if (NT_STATUS_EQUAL(status
, NT_STATUS_PROTOCOL_UNREACHABLE
)) {
445 /* Add BUILTIN\Administrators directly to token. */
446 status
= add_builtin_administrators(result
, &dom_sid
);
447 if ( !NT_STATUS_IS_OK(status
) ) {
448 DEBUG(3, ("Failed to check for local "
449 "Administrators membership (%s)\n",
452 } else if (!NT_STATUS_IS_OK(status
)) {
453 DEBUG(2, ("WARNING: Failed to create "
454 "BUILTIN\\Administrators group! Can "
455 "Winbind allocate gids?\n"));
459 /* Deal with the BUILTIN\Users group. If the SID can
460 be resolved then assume that the add_aliasmem( S-1-5-32 )
463 if (!sid_to_gid(&global_sid_Builtin_Users
, &gid
)) {
466 if (!secrets_fetch_domain_sid(lp_workgroup(), &dom_sid
)) {
467 status
= NT_STATUS_OK
;
468 DEBUG(3, ("Failed to fetch domain sid for %s\n",
471 status
= create_builtin_users(&dom_sid
);
475 if (!NT_STATUS_EQUAL(status
, NT_STATUS_PROTOCOL_UNREACHABLE
) &&
476 !NT_STATUS_IS_OK(status
))
478 DEBUG(2, ("WARNING: Failed to create BUILTIN\\Users group! "
479 "Can Winbind allocate gids?\n"));
483 /* Deal with local groups */
485 if (lp_winbind_nested_groups()) {
489 /* Now add the aliases. First the one from our local SAM */
491 status
= add_aliases(get_global_sam_sid(), result
);
493 if (!NT_STATUS_IS_OK(status
)) {
498 /* Finally the builtin ones */
500 status
= add_aliases(&global_sid_Builtin
, result
);
502 if (!NT_STATUS_IS_OK(status
)) {
510 /* Add privileges based on current user sids */
512 get_privileges_for_sids(&result
->privilege_mask
, result
->sids
,
518 /****************************************************************************
519 prints a UNIX 'token' to debug output.
520 ****************************************************************************/
522 void debug_unix_user_token(int dbg_class
, int dbg_lev
, uid_t uid
, gid_t gid
,
523 int n_groups
, gid_t
*groups
)
526 DEBUGC(dbg_class
, dbg_lev
,
527 ("UNIX token of user %ld\n", (long int)uid
));
529 DEBUGADDC(dbg_class
, dbg_lev
,
530 ("Primary group is %ld and contains %i supplementary "
531 "groups\n", (long int)gid
, n_groups
));
532 for (i
= 0; i
< n_groups
; i
++)
533 DEBUGADDC(dbg_class
, dbg_lev
, ("Group[%3i]: %ld\n", i
,
534 (long int)groups
[i
]));
538 * Create an artificial NT token given just a username. (Initially intended
541 * We go through lookup_name() to avoid problems we had with 'winbind use
546 * unmapped unix users: Go directly to nss to find the user's group.
548 * A passdb user: The list of groups is provided by pdb_enum_group_memberships.
550 * If the user is provided by winbind, the primary gid is set to "domain
551 * users" of the user's domain. For an explanation why this is necessary, see
552 * the thread starting at
553 * http://lists.samba.org/archive/samba-technical/2006-January/044803.html.
556 NTSTATUS
create_token_from_username(TALLOC_CTX
*mem_ctx
, const char *username
,
558 uid_t
*uid
, gid_t
*gid
,
559 char **found_username
,
560 struct security_token
**token
)
562 NTSTATUS result
= NT_STATUS_NO_SUCH_USER
;
563 TALLOC_CTX
*tmp_ctx
= talloc_stackframe();
564 struct dom_sid user_sid
;
565 enum lsa_SidType type
;
567 struct dom_sid
*group_sids
;
568 struct dom_sid unix_group_sid
;
569 uint32_t num_group_sids
;
573 if (!lookup_name_smbconf(tmp_ctx
, username
, LOOKUP_NAME_ALL
,
574 NULL
, NULL
, &user_sid
, &type
)) {
575 DEBUG(1, ("lookup_name_smbconf for %s failed\n", username
));
579 if (type
!= SID_NAME_USER
) {
580 DEBUG(1, ("%s is a %s, not a user\n", username
,
581 sid_type_lookup(type
)));
585 if (sid_check_is_in_our_domain(&user_sid
)) {
587 uint32_t pdb_num_group_sids
;
588 /* This is a passdb user, so ask passdb */
590 struct samu
*sam_acct
= NULL
;
592 if ( !(sam_acct
= samu_new( tmp_ctx
)) ) {
593 result
= NT_STATUS_NO_MEMORY
;
598 ret
= pdb_getsampwsid(sam_acct
, &user_sid
);
602 DEBUG(1, ("pdb_getsampwsid(%s) for user %s failed\n",
603 sid_string_dbg(&user_sid
), username
));
604 DEBUGADD(1, ("Fall back to unix user %s\n", username
));
608 result
= pdb_enum_group_memberships(tmp_ctx
, sam_acct
,
610 &pdb_num_group_sids
);
611 if (!NT_STATUS_IS_OK(result
)) {
612 DEBUG(1, ("enum_group_memberships failed for %s (%s): "
613 "%s\n", username
, sid_string_dbg(&user_sid
),
615 DEBUGADD(1, ("Fall back to unix user %s\n", username
));
618 num_group_sids
= pdb_num_group_sids
;
620 /* see the smb_panic() in pdb_default_enum_group_memberships */
621 SMB_ASSERT(num_group_sids
> 0);
625 /* Ensure we're returning the found_username on the right context. */
626 *found_username
= talloc_strdup(mem_ctx
,
627 pdb_get_username(sam_acct
));
630 * If the SID from lookup_name() was the guest sid, passdb knows
631 * about the mapping of guest sid to lp_guestaccount()
632 * username and will return the unix_pw info for a guest
633 * user. Use it if it's there, else lookup the *uid details
634 * using Get_Pwnam_alloc(). See bug #6291 for details. JRA.
637 /* We must always assign the *uid. */
638 if (sam_acct
->unix_pw
== NULL
) {
639 struct passwd
*pwd
= Get_Pwnam_alloc(sam_acct
, *found_username
);
641 DEBUG(10, ("Get_Pwnam_alloc failed for %s\n",
643 result
= NT_STATUS_NO_SUCH_USER
;
646 result
= samu_set_unix(sam_acct
, pwd
);
647 if (!NT_STATUS_IS_OK(result
)) {
648 DEBUG(10, ("samu_set_unix failed for %s\n",
650 result
= NT_STATUS_NO_SUCH_USER
;
654 *uid
= sam_acct
->unix_pw
->pw_uid
;
656 } else if (sid_check_is_in_unix_users(&user_sid
)) {
657 uint32_t getgroups_num_group_sids
;
658 /* This is a unix user not in passdb. We need to ask nss
659 * directly, without consulting passdb */
664 * This goto target is used as a fallback for the passdb
665 * case. The concrete bug report is when passdb gave us an
671 if (!sid_to_uid(&user_sid
, uid
)) {
672 DEBUG(1, ("unix_user case, sid_to_uid for %s (%s) failed\n",
673 username
, sid_string_dbg(&user_sid
)));
674 result
= NT_STATUS_NO_SUCH_USER
;
678 uid_to_unix_users_sid(*uid
, &user_sid
);
680 pass
= getpwuid_alloc(tmp_ctx
, *uid
);
682 DEBUG(1, ("getpwuid(%u) for user %s failed\n",
683 (unsigned int)*uid
, username
));
687 if (!getgroups_unix_user(tmp_ctx
, username
, pass
->pw_gid
,
688 &gids
, &getgroups_num_group_sids
)) {
689 DEBUG(1, ("getgroups_unix_user for user %s failed\n",
693 num_group_sids
= getgroups_num_group_sids
;
695 if (num_group_sids
) {
696 group_sids
= TALLOC_ARRAY(tmp_ctx
, struct dom_sid
, num_group_sids
);
697 if (group_sids
== NULL
) {
698 DEBUG(1, ("TALLOC_ARRAY failed\n"));
699 result
= NT_STATUS_NO_MEMORY
;
706 for (i
=0; i
<num_group_sids
; i
++) {
707 gid_to_sid(&group_sids
[i
], gids
[i
]);
710 /* In getgroups_unix_user we always set the primary gid */
711 SMB_ASSERT(num_group_sids
> 0);
715 /* Ensure we're returning the found_username on the right context. */
716 *found_username
= talloc_strdup(mem_ctx
, pass
->pw_name
);
719 /* This user is from winbind, force the primary gid to the
720 * user's "domain users" group. Under certain circumstances
721 * (user comes from NT4), this might be a loss of
722 * information. But we can not rely on winbind getting the
723 * correct info. AD might prohibit winbind looking up that
726 /* We must always assign the *uid. */
727 if (!sid_to_uid(&user_sid
, uid
)) {
728 DEBUG(1, ("winbindd case, sid_to_uid for %s (%s) failed\n",
729 username
, sid_string_dbg(&user_sid
)));
730 result
= NT_STATUS_NO_SUCH_USER
;
735 group_sids
= TALLOC_ARRAY(tmp_ctx
, struct dom_sid
, num_group_sids
);
736 if (group_sids
== NULL
) {
737 DEBUG(1, ("TALLOC_ARRAY failed\n"));
738 result
= NT_STATUS_NO_MEMORY
;
742 sid_copy(&group_sids
[0], &user_sid
);
743 sid_split_rid(&group_sids
[0], NULL
);
744 sid_append_rid(&group_sids
[0], DOMAIN_RID_USERS
);
746 if (!sid_to_gid(&group_sids
[0], gid
)) {
747 DEBUG(1, ("sid_to_gid(%s) failed\n",
748 sid_string_dbg(&group_sids
[0])));
754 /* Ensure we're returning the found_username on the right context. */
755 *found_username
= talloc_strdup(mem_ctx
, username
);
758 /* Add the "Unix Group" SID for each gid to catch mapped groups
759 and their Unix equivalent. This is to solve the backwards
760 compatibility problem of 'valid users = +ntadmin' where
761 ntadmin has been paired with "Domain Admins" in the group
762 mapping table. Otherwise smb.conf would need to be changed
763 to 'valid user = "Domain Admins"'. --jerry */
765 num_gids
= num_group_sids
;
766 for ( i
=0; i
<num_gids
; i
++ ) {
769 /* don't pickup anything managed by Winbind */
771 if ( lp_idmap_gid(&low
, &high
) && (gids
[i
] >= low
) && (gids
[i
] <= high
) )
774 gid_to_unix_groups_sid(gids
[i
], &unix_group_sid
);
776 result
= add_sid_to_array_unique(tmp_ctx
, &unix_group_sid
,
777 &group_sids
, &num_group_sids
);
778 if (!NT_STATUS_IS_OK(result
)) {
783 /* Ensure we're creating the nt_token on the right context. */
784 *token
= create_local_nt_token(mem_ctx
, &user_sid
,
785 is_guest
, num_group_sids
, group_sids
);
787 if ((*token
== NULL
) || (*found_username
== NULL
)) {
788 result
= NT_STATUS_NO_MEMORY
;
792 result
= NT_STATUS_OK
;
794 TALLOC_FREE(tmp_ctx
);
798 /***************************************************************************
799 Build upon create_token_from_username:
801 Expensive helper function to figure out whether a user given its name is
802 member of a particular group.
803 ***************************************************************************/
805 bool user_in_group_sid(const char *username
, const struct dom_sid
*group_sid
)
810 char *found_username
;
811 struct security_token
*token
;
813 TALLOC_CTX
*mem_ctx
= talloc_stackframe();
815 status
= create_token_from_username(mem_ctx
, username
, False
,
816 &uid
, &gid
, &found_username
,
819 if (!NT_STATUS_IS_OK(status
)) {
820 DEBUG(10, ("could not create token for %s\n", username
));
821 TALLOC_FREE(mem_ctx
);
825 result
= security_token_has_sid(token
, group_sid
);
827 TALLOC_FREE(mem_ctx
);
831 bool user_in_group(const char *username
, const char *groupname
)
833 TALLOC_CTX
*mem_ctx
= talloc_stackframe();
834 struct dom_sid group_sid
;
837 ret
= lookup_name(mem_ctx
, groupname
, LOOKUP_NAME_ALL
,
838 NULL
, NULL
, &group_sid
, NULL
);
839 TALLOC_FREE(mem_ctx
);
842 DEBUG(10, ("lookup_name for (%s) failed.\n", groupname
));
846 return user_in_group_sid(username
, &group_sid
);