Make us clean under valgrind --leak-check=full by using talloc_autofree_context(...
[Samba/bb.git] / source / auth / token_util.c
blobbb8f222abf69a9d33bd802fbad117948601652fe
1 /*
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 */
27 #include "includes.h"
29 /****************************************************************************
30 Check for a SID in an NT_USER_TOKEN
31 ****************************************************************************/
33 bool nt_token_check_sid ( const DOM_SID *sid, const NT_USER_TOKEN *token )
35 int i;
37 if ( !sid || !token )
38 return False;
40 for ( i=0; i<token->num_sids; i++ ) {
41 if ( sid_equal( sid, &token->user_sids[i] ) )
42 return True;
45 return False;
48 bool nt_token_check_domain_rid( NT_USER_TOKEN *token, uint32 rid )
50 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(),
57 &domain_sid ) ) {
58 DEBUG(1,("nt_token_check_domain_rid: Cannot lookup "
59 "SID for domain [%s]\n", lp_workgroup()));
60 return False;
63 else
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 your need to change it.
76 ******************************************************************************/
78 NT_USER_TOKEN *get_root_nt_token( void )
80 struct nt_user_token *token = NULL;
81 DOM_SID u_sid, g_sid;
82 struct passwd *pw;
83 void *cache_data;
85 cache_data = memcache_lookup_talloc(
86 NULL, SINGLETON_CACHE_TALLOC,
87 data_blob_string_const("root_nt_token"));
89 if (cache_data != NULL) {
90 return talloc_get_type_abort(
91 cache_data, struct nt_user_token);
94 if ( !(pw = sys_getpwnam( "root" )) ) {
95 DEBUG(0,("get_root_nt_token: getpwnam(\"root\") failed!\n"));
96 return NULL;
99 /* get the user and primary group SIDs; although the
100 BUILTIN\Administrators SId is really the one that matters here */
102 uid_to_sid(&u_sid, pw->pw_uid);
103 gid_to_sid(&g_sid, pw->pw_gid);
105 token = create_local_nt_token(talloc_autofree_context(), &u_sid, False,
106 1, &global_sid_Builtin_Administrators);
108 token->privileges = se_disk_operators;
110 memcache_add_talloc(
111 NULL, SINGLETON_CACHE_TALLOC,
112 data_blob_string_const("root_nt_token"), token);
114 return token;
119 * Add alias SIDs from memberships within the partially created token SID list
122 NTSTATUS add_aliases(const DOM_SID *domain_sid,
123 struct nt_user_token *token)
125 uint32 *aliases;
126 size_t i, num_aliases;
127 NTSTATUS status;
128 TALLOC_CTX *tmp_ctx;
130 if (!(tmp_ctx = talloc_init("add_aliases"))) {
131 return NT_STATUS_NO_MEMORY;
134 aliases = NULL;
135 num_aliases = 0;
137 status = pdb_enum_alias_memberships(tmp_ctx, domain_sid,
138 token->user_sids,
139 token->num_sids,
140 &aliases, &num_aliases);
142 if (!NT_STATUS_IS_OK(status)) {
143 DEBUG(10, ("pdb_enum_alias_memberships failed: %s\n",
144 nt_errstr(status)));
145 goto done;
148 for (i=0; i<num_aliases; i++) {
149 DOM_SID alias_sid;
150 sid_compose(&alias_sid, domain_sid, aliases[i]);
151 status = add_sid_to_array_unique(token, &alias_sid,
152 &token->user_sids,
153 &token->num_sids);
154 if (!NT_STATUS_IS_OK(status)) {
155 DEBUG(0, ("add_sid_to_array failed\n"));
156 goto done;
160 done:
161 TALLOC_FREE(tmp_ctx);
162 return NT_STATUS_OK;
165 /*******************************************************************
166 *******************************************************************/
168 static NTSTATUS add_builtin_administrators(struct nt_user_token *token,
169 const DOM_SID *dom_sid)
171 DOM_SID domadm;
172 NTSTATUS status;
174 /* nothing to do if we aren't in a domain */
176 if ( !(IS_DC || lp_server_role()==ROLE_DOMAIN_MEMBER) ) {
177 return NT_STATUS_OK;
180 /* Find the Domain Admins SID */
182 if ( IS_DC ) {
183 sid_copy( &domadm, get_global_sam_sid() );
184 } else {
185 sid_copy(&domadm, dom_sid);
187 sid_append_rid( &domadm, DOMAIN_GROUP_RID_ADMINS );
189 /* Add Administrators if the user beloongs to Domain Admins */
191 if ( nt_token_check_sid( &domadm, token ) ) {
192 status = add_sid_to_array(token,
193 &global_sid_Builtin_Administrators,
194 &token->user_sids, &token->num_sids);
195 if (!NT_STATUS_IS_OK(status)) {
196 return status;
200 return NT_STATUS_OK;
204 * Create the requested BUILTIN if it doesn't already exist. This requires
205 * winbindd to be running.
207 * @param[in] rid BUILTIN rid to create
208 * @return Normal NTSTATUS return.
210 static NTSTATUS create_builtin(uint32 rid)
212 NTSTATUS status = NT_STATUS_OK;
213 DOM_SID sid;
214 gid_t gid;
216 if (!sid_compose(&sid, &global_sid_Builtin, rid)) {
217 return NT_STATUS_NO_SUCH_ALIAS;
220 if (!sid_to_gid(&sid, &gid)) {
221 if (!lp_winbind_nested_groups() || !winbind_ping()) {
222 return NT_STATUS_PROTOCOL_UNREACHABLE;
224 status = pdb_create_builtin_alias(rid);
226 return status;
230 * Add sid as a member of builtin_sid.
232 * @param[in] builtin_sid An existing builtin group.
233 * @param[in] dom_sid sid to add as a member of builtin_sid.
234 * @return Normal NTSTATUS return
236 static NTSTATUS add_sid_to_builtin(const DOM_SID *builtin_sid,
237 const DOM_SID *dom_sid)
239 NTSTATUS status = NT_STATUS_OK;
241 if (!dom_sid || !builtin_sid) {
242 return NT_STATUS_INVALID_PARAMETER;
245 status = pdb_add_aliasmem(builtin_sid, dom_sid);
247 if (NT_STATUS_EQUAL(status, NT_STATUS_MEMBER_IN_ALIAS)) {
248 DEBUG(5, ("add_sid_to_builtin %s is already a member of %s\n",
249 sid_string_dbg(dom_sid),
250 sid_string_dbg(builtin_sid)));
251 return NT_STATUS_OK;
254 if (!NT_STATUS_IS_OK(status)) {
255 DEBUG(4, ("add_sid_to_builtin %s could not be added to %s: "
256 "%s\n", sid_string_dbg(dom_sid),
257 sid_string_dbg(builtin_sid), nt_errstr(status)));
259 return status;
262 /*******************************************************************
263 *******************************************************************/
265 NTSTATUS create_builtin_users(const DOM_SID *dom_sid)
267 NTSTATUS status;
268 DOM_SID dom_users;
270 status = create_builtin(BUILTIN_ALIAS_RID_USERS);
271 if ( !NT_STATUS_IS_OK(status) ) {
272 DEBUG(5,("create_builtin_users: Failed to create Users\n"));
273 return status;
276 /* add domain users */
277 if ((IS_DC || (lp_server_role() == ROLE_DOMAIN_MEMBER))
278 && sid_compose(&dom_users, dom_sid, DOMAIN_GROUP_RID_USERS))
280 status = add_sid_to_builtin(&global_sid_Builtin_Users,
281 &dom_users);
284 return status;
287 /*******************************************************************
288 *******************************************************************/
290 NTSTATUS create_builtin_administrators(const DOM_SID *dom_sid)
292 NTSTATUS status;
293 DOM_SID dom_admins, root_sid;
294 fstring root_name;
295 enum lsa_SidType type;
296 TALLOC_CTX *ctx;
297 bool ret;
299 status = create_builtin(BUILTIN_ALIAS_RID_ADMINS);
300 if ( !NT_STATUS_IS_OK(status) ) {
301 DEBUG(5,("create_builtin_administrators: Failed to create Administrators\n"));
302 return status;
305 /* add domain admins */
306 if ((IS_DC || (lp_server_role() == ROLE_DOMAIN_MEMBER))
307 && sid_compose(&dom_admins, dom_sid, DOMAIN_GROUP_RID_ADMINS))
309 status = add_sid_to_builtin(&global_sid_Builtin_Administrators,
310 &dom_admins);
311 if (!NT_STATUS_IS_OK(status)) {
312 return status;
316 /* add root */
317 if ( (ctx = talloc_init("create_builtin_administrators")) == NULL ) {
318 return NT_STATUS_NO_MEMORY;
320 fstr_sprintf( root_name, "%s\\root", get_global_sam_name() );
321 ret = lookup_name(ctx, root_name, LOOKUP_NAME_DOMAIN, NULL, NULL,
322 &root_sid, &type);
323 TALLOC_FREE( ctx );
325 if ( ret ) {
326 status = add_sid_to_builtin(&global_sid_Builtin_Administrators,
327 &root_sid);
330 return status;
334 /*******************************************************************
335 Create a NT token for the user, expanding local aliases
336 *******************************************************************/
338 struct nt_user_token *create_local_nt_token(TALLOC_CTX *mem_ctx,
339 const DOM_SID *user_sid,
340 bool is_guest,
341 int num_groupsids,
342 const DOM_SID *groupsids)
344 struct nt_user_token *result = NULL;
345 int i;
346 NTSTATUS status;
347 gid_t gid;
348 DOM_SID dom_sid;
350 DEBUG(10, ("Create local NT token for %s\n",
351 sid_string_dbg(user_sid)));
353 if (!(result = TALLOC_ZERO_P(mem_ctx, struct nt_user_token))) {
354 DEBUG(0, ("talloc failed\n"));
355 return NULL;
358 /* Add the user and primary group sid */
360 status = add_sid_to_array(result, user_sid,
361 &result->user_sids, &result->num_sids);
362 if (!NT_STATUS_IS_OK(status)) {
363 return NULL;
366 /* For guest, num_groupsids may be zero. */
367 if (num_groupsids) {
368 status = add_sid_to_array(result, &groupsids[0],
369 &result->user_sids,
370 &result->num_sids);
371 if (!NT_STATUS_IS_OK(status)) {
372 return NULL;
376 /* Add in BUILTIN sids */
378 status = add_sid_to_array(result, &global_sid_World,
379 &result->user_sids, &result->num_sids);
380 if (!NT_STATUS_IS_OK(status)) {
381 return NULL;
383 status = add_sid_to_array(result, &global_sid_Network,
384 &result->user_sids, &result->num_sids);
385 if (!NT_STATUS_IS_OK(status)) {
386 return NULL;
389 if (is_guest) {
390 status = add_sid_to_array(result, &global_sid_Builtin_Guests,
391 &result->user_sids,
392 &result->num_sids);
393 if (!NT_STATUS_IS_OK(status)) {
394 return NULL;
396 } else {
397 status = add_sid_to_array(result,
398 &global_sid_Authenticated_Users,
399 &result->user_sids,
400 &result->num_sids);
401 if (!NT_STATUS_IS_OK(status)) {
402 return NULL;
406 /* Now the SIDs we got from authentication. These are the ones from
407 * the info3 struct or from the pdb_enum_group_memberships, depending
408 * on who authenticated the user.
409 * Note that we start the for loop at "1" here, we already added the
410 * first group sid as primary above. */
412 for (i=1; i<num_groupsids; i++) {
413 status = add_sid_to_array_unique(result, &groupsids[i],
414 &result->user_sids,
415 &result->num_sids);
416 if (!NT_STATUS_IS_OK(status)) {
417 return NULL;
421 /* Deal with the BUILTIN\Administrators group. If the SID can
422 be resolved then assume that the add_aliasmem( S-1-5-32 )
423 handled it. */
425 if (!sid_to_gid(&global_sid_Builtin_Administrators, &gid)) {
427 become_root();
428 if (!secrets_fetch_domain_sid(lp_workgroup(), &dom_sid)) {
429 status = NT_STATUS_OK;
430 DEBUG(3, ("Failed to fetch domain sid for %s\n",
431 lp_workgroup()));
432 } else {
433 status = create_builtin_administrators(&dom_sid);
435 unbecome_root();
437 if (NT_STATUS_EQUAL(status, NT_STATUS_PROTOCOL_UNREACHABLE)) {
438 /* Add BUILTIN\Administrators directly to token. */
439 status = add_builtin_administrators(result, &dom_sid);
440 if ( !NT_STATUS_IS_OK(status) ) {
441 DEBUG(3, ("Failed to check for local "
442 "Administrators membership (%s)\n",
443 nt_errstr(status)));
445 } else if (!NT_STATUS_IS_OK(status)) {
446 DEBUG(2, ("WARNING: Failed to create "
447 "BUILTIN\\Administrators group! Can "
448 "Winbind allocate gids?\n"));
452 /* Deal with the BUILTIN\Users group. If the SID can
453 be resolved then assume that the add_aliasmem( S-1-5-32 )
454 handled it. */
456 if (!sid_to_gid(&global_sid_Builtin_Users, &gid)) {
458 become_root();
459 if (!secrets_fetch_domain_sid(lp_workgroup(), &dom_sid)) {
460 status = NT_STATUS_OK;
461 DEBUG(3, ("Failed to fetch domain sid for %s\n",
462 lp_workgroup()));
463 } else {
464 status = create_builtin_users(&dom_sid);
466 unbecome_root();
468 if (!NT_STATUS_EQUAL(status, NT_STATUS_PROTOCOL_UNREACHABLE) &&
469 !NT_STATUS_IS_OK(status))
471 DEBUG(2, ("WARNING: Failed to create BUILTIN\\Users group! "
472 "Can Winbind allocate gids?\n"));
476 /* Deal with local groups */
478 if (lp_winbind_nested_groups()) {
480 become_root();
482 /* Now add the aliases. First the one from our local SAM */
484 status = add_aliases(get_global_sam_sid(), result);
486 if (!NT_STATUS_IS_OK(status)) {
487 unbecome_root();
488 TALLOC_FREE(result);
489 return NULL;
492 /* Finally the builtin ones */
494 status = add_aliases(&global_sid_Builtin, result);
496 if (!NT_STATUS_IS_OK(status)) {
497 unbecome_root();
498 TALLOC_FREE(result);
499 return NULL;
502 unbecome_root();
506 get_privileges_for_sids(&result->privileges, result->user_sids,
507 result->num_sids);
508 return result;
511 /****************************************************************************
512 prints a NT_USER_TOKEN to debug output.
513 ****************************************************************************/
515 void debug_nt_user_token(int dbg_class, int dbg_lev, NT_USER_TOKEN *token)
517 size_t i;
519 if (!token) {
520 DEBUGC(dbg_class, dbg_lev, ("NT user token: (NULL)\n"));
521 return;
524 DEBUGC(dbg_class, dbg_lev,
525 ("NT user token of user %s\n",
526 sid_string_dbg(&token->user_sids[0]) ));
527 DEBUGADDC(dbg_class, dbg_lev,
528 ("contains %lu SIDs\n", (unsigned long)token->num_sids));
529 for (i = 0; i < token->num_sids; i++)
530 DEBUGADDC(dbg_class, dbg_lev,
531 ("SID[%3lu]: %s\n", (unsigned long)i,
532 sid_string_dbg(&token->user_sids[i])));
534 dump_se_priv( dbg_class, dbg_lev, &token->privileges );
537 /****************************************************************************
538 prints a UNIX 'token' to debug output.
539 ****************************************************************************/
541 void debug_unix_user_token(int dbg_class, int dbg_lev, uid_t uid, gid_t gid,
542 int n_groups, gid_t *groups)
544 int i;
545 DEBUGC(dbg_class, dbg_lev,
546 ("UNIX token of user %ld\n", (long int)uid));
548 DEBUGADDC(dbg_class, dbg_lev,
549 ("Primary group is %ld and contains %i supplementary "
550 "groups\n", (long int)gid, n_groups));
551 for (i = 0; i < n_groups; i++)
552 DEBUGADDC(dbg_class, dbg_lev, ("Group[%3i]: %ld\n", i,
553 (long int)groups[i]));
556 /* END */