2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Luke Kenneth Caseson Leighton 1998-1999
6 Copyright (C) Jeremy Allison 1999
7 Copyright (C) Stefan (metze) Metzmacher 2002
8 Copyright (C) Simo Sorce 2002
9 Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2005
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/>.
26 #include "../librpc/gen_ndr/ndr_security.h"
27 #include "../librpc/gen_ndr/netlogon.h"
28 #include "../libcli/security/dom_sid.h"
31 * Some useful sids, more well known sids can be found at
32 * http://support.microsoft.com/kb/243330/EN-US/
36 const struct dom_sid global_sid_World_Domain = /* Everyone domain */
37 { 1, 0, {0,0,0,0,0,1}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
38 const struct dom_sid global_sid_World = /* Everyone */
39 { 1, 1, {0,0,0,0,0,1}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
40 const struct dom_sid global_sid_Creator_Owner_Domain = /* Creator Owner domain */
41 { 1, 0, {0,0,0,0,0,3}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
42 const struct dom_sid global_sid_NT_Authority = /* NT Authority */
43 { 1, 0, {0,0,0,0,0,5}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
44 const struct dom_sid global_sid_System = /* System */
45 { 1, 1, {0,0,0,0,0,5}, {18,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
46 const struct dom_sid global_sid_NULL = /* NULL sid */
47 { 1, 1, {0,0,0,0,0,0}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
48 const struct dom_sid global_sid_Authenticated_Users = /* All authenticated rids */
49 { 1, 1, {0,0,0,0,0,5}, {11,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
51 /* for documentation */
52 const struct dom_sid global_sid_Restriced = /* Restriced Code */
53 { 1, 1, {0,0,0,0,0,5}, {12,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
55 const struct dom_sid global_sid_Network = /* Network rids */
56 { 1, 1, {0,0,0,0,0,5}, {2,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
58 const struct dom_sid global_sid_Creator_Owner = /* Creator Owner */
59 { 1, 1, {0,0,0,0,0,3}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
60 const struct dom_sid global_sid_Creator_Group = /* Creator Group */
61 { 1, 1, {0,0,0,0,0,3}, {1,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
62 const struct dom_sid global_sid_Anonymous = /* Anonymous login */
63 { 1, 1, {0,0,0,0,0,5}, {7,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
65 const struct dom_sid global_sid_Builtin = /* Local well-known domain */
66 { 1, 1, {0,0,0,0,0,5}, {32,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
67 const struct dom_sid global_sid_Builtin_Administrators = /* Builtin administrators */
68 { 1, 2, {0,0,0,0,0,5}, {32,544,0,0,0,0,0,0,0,0,0,0,0,0,0}};
69 const struct dom_sid global_sid_Builtin_Users = /* Builtin users */
70 { 1, 2, {0,0,0,0,0,5}, {32,545,0,0,0,0,0,0,0,0,0,0,0,0,0}};
71 const struct dom_sid global_sid_Builtin_Guests = /* Builtin guest users */
72 { 1, 2, {0,0,0,0,0,5}, {32,546,0,0,0,0,0,0,0,0,0,0,0,0,0}};
73 const struct dom_sid global_sid_Builtin_Power_Users = /* Builtin power users */
74 { 1, 2, {0,0,0,0,0,5}, {32,547,0,0,0,0,0,0,0,0,0,0,0,0,0}};
75 const struct dom_sid global_sid_Builtin_Account_Operators = /* Builtin account operators */
76 { 1, 2, {0,0,0,0,0,5}, {32,548,0,0,0,0,0,0,0,0,0,0,0,0,0}};
77 const struct dom_sid global_sid_Builtin_Server_Operators = /* Builtin server operators */
78 { 1, 2, {0,0,0,0,0,5}, {32,549,0,0,0,0,0,0,0,0,0,0,0,0,0}};
79 const struct dom_sid global_sid_Builtin_Print_Operators = /* Builtin print operators */
80 { 1, 2, {0,0,0,0,0,5}, {32,550,0,0,0,0,0,0,0,0,0,0,0,0,0}};
81 const struct dom_sid global_sid_Builtin_Backup_Operators = /* Builtin backup operators */
82 { 1, 2, {0,0,0,0,0,5}, {32,551,0,0,0,0,0,0,0,0,0,0,0,0,0}};
83 const struct dom_sid global_sid_Builtin_Replicator = /* Builtin replicator */
84 { 1, 2, {0,0,0,0,0,5}, {32,552,0,0,0,0,0,0,0,0,0,0,0,0,0}};
85 const struct dom_sid global_sid_Builtin_PreWin2kAccess = /* Builtin pre win2k access */
86 { 1, 2, {0,0,0,0,0,5}, {32,554,0,0,0,0,0,0,0,0,0,0,0,0,0}};
88 const struct dom_sid global_sid_Unix_Users = /* Unmapped Unix users */
89 { 1, 1, {0,0,0,0,0,22}, {1,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
90 const struct dom_sid global_sid_Unix_Groups = /* Unmapped Unix groups */
91 { 1, 1, {0,0,0,0,0,22}, {2,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
93 /* Unused, left here for documentary purposes */
95 #define SECURITY_NULL_SID_AUTHORITY 0
96 #define SECURITY_WORLD_SID_AUTHORITY 1
97 #define SECURITY_LOCAL_SID_AUTHORITY 2
98 #define SECURITY_CREATOR_SID_AUTHORITY 3
99 #define SECURITY_NT_AUTHORITY 5
102 static struct dom_sid system_sid_array[1] =
103 { { 1, 1, {0,0,0,0,0,5}, {18,0,0,0,0,0,0,0,0,0,0,0,0,0,0}} };
104 static const struct security_token system_token = {
105 .num_sids = ARRAY_SIZE(system_sid_array),
106 .sids = system_sid_array,
107 .privilege_mask = SE_ALL_PRIVS
110 /****************************************************************************
111 Lookup string names for SID types.
112 ****************************************************************************/
114 static const struct {
115 enum lsa_SidType sid_type;
117 } sid_name_type[] = {
118 {SID_NAME_USER, "User"},
119 {SID_NAME_DOM_GRP, "Domain Group"},
120 {SID_NAME_DOMAIN, "Domain"},
121 {SID_NAME_ALIAS, "Local Group"},
122 {SID_NAME_WKN_GRP, "Well-known Group"},
123 {SID_NAME_DELETED, "Deleted Account"},
124 {SID_NAME_INVALID, "Invalid Account"},
125 {SID_NAME_UNKNOWN, "UNKNOWN"},
126 {SID_NAME_COMPUTER, "Computer"},
128 {(enum lsa_SidType)0, NULL}
131 const char *sid_type_lookup(uint32 sid_type)
135 /* Look through list */
136 while(sid_name_type[i].sid_type != 0) {
137 if (sid_name_type[i].sid_type == sid_type)
138 return sid_name_type[i].string;
143 return "SID *TYPE* is INVALID";
146 /**************************************************************************
147 Create the SYSTEM token.
148 ***************************************************************************/
150 const struct security_token *get_system_token(void)
152 return &system_token;
155 /*****************************************************************
156 Convert a SID to an ascii string.
157 *****************************************************************/
159 char *sid_to_fstring(fstring sidstr_out, const struct dom_sid *sid)
161 char *str = sid_string_talloc(talloc_tos(), sid);
162 fstrcpy(sidstr_out, str);
167 /*****************************************************************
168 Essentially a renamed dom_sid_string from
169 ../libcli/security/dom_sid.c with a panic if it didn't work.
170 *****************************************************************/
172 char *sid_string_talloc(TALLOC_CTX *mem_ctx, const struct dom_sid *sid)
174 char *result = dom_sid_string(mem_ctx, sid);
175 SMB_ASSERT(result != NULL);
179 /*****************************************************************
180 Useful function for debug lines.
181 *****************************************************************/
183 char *sid_string_dbg(const struct dom_sid *sid)
185 return sid_string_talloc(talloc_tos(), sid);
188 /*****************************************************************
190 *****************************************************************/
192 char *sid_string_tos(const struct dom_sid *sid)
194 return sid_string_talloc(talloc_tos(), sid);
197 bool sid_compose(struct dom_sid *dst, const struct dom_sid *domain_sid, uint32 rid)
199 sid_copy(dst, domain_sid);
200 return sid_append_rid(dst, rid);
203 /*****************************************************************
204 Removes the last rid from the end of a sid
205 *****************************************************************/
207 bool sid_split_rid(struct dom_sid *sid, uint32 *rid)
209 if (sid->num_auths > 0) {
211 *rid = sid->sub_auths[sid->num_auths];
217 /*****************************************************************
218 Return the last rid from the end of a sid
219 *****************************************************************/
221 bool sid_peek_rid(const struct dom_sid *sid, uint32 *rid)
226 if (sid->num_auths > 0) {
227 *rid = sid->sub_auths[sid->num_auths - 1];
233 /*****************************************************************
234 Return the last rid from the end of a sid
235 and check the sid against the exp_dom_sid
236 *****************************************************************/
238 bool sid_peek_check_rid(const struct dom_sid *exp_dom_sid, const struct dom_sid *sid, uint32 *rid)
240 if (!exp_dom_sid || !sid || !rid)
243 if (sid->num_auths != (exp_dom_sid->num_auths+1)) {
247 if (sid_compare_domain(exp_dom_sid, sid)!=0){
252 return sid_peek_rid(sid, rid);
255 /*****************************************************************
257 *****************************************************************/
259 void sid_copy(struct dom_sid *dst, const struct dom_sid *src)
265 dst->sid_rev_num = src->sid_rev_num;
266 dst->num_auths = src->num_auths;
268 memcpy(&dst->id_auth[0], &src->id_auth[0], sizeof(src->id_auth));
270 for (i = 0; i < src->num_auths; i++)
271 dst->sub_auths[i] = src->sub_auths[i];
274 /*****************************************************************
275 Write a sid out into on-the-wire format.
276 *****************************************************************/
278 bool sid_linearize(char *outbuf, size_t len, const struct dom_sid *sid)
282 if (len < ndr_size_dom_sid(sid, 0))
285 SCVAL(outbuf,0,sid->sid_rev_num);
286 SCVAL(outbuf,1,sid->num_auths);
287 memcpy(&outbuf[2], sid->id_auth, 6);
288 for(i = 0; i < sid->num_auths; i++)
289 SIVAL(outbuf, 8 + (i*4), sid->sub_auths[i]);
294 /*****************************************************************
295 Parse a on-the-wire SID to a struct dom_sid.
296 *****************************************************************/
298 bool sid_parse(const char *inbuf, size_t len, struct dom_sid *sid)
300 enum ndr_err_code ndr_err;
301 DATA_BLOB in = data_blob_const(inbuf, len);
302 ndr_err = ndr_pull_struct_blob_all(&in, NULL, sid,
303 (ndr_pull_flags_fn_t)ndr_pull_dom_sid);
304 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
310 /*****************************************************************
311 Compare the auth portion of two sids.
312 *****************************************************************/
314 static int sid_compare_auth(const struct dom_sid *sid1, const struct dom_sid *sid2)
325 if (sid1->sid_rev_num != sid2->sid_rev_num)
326 return sid1->sid_rev_num - sid2->sid_rev_num;
328 for (i = 0; i < 6; i++)
329 if (sid1->id_auth[i] != sid2->id_auth[i])
330 return sid1->id_auth[i] - sid2->id_auth[i];
335 /*****************************************************************
337 *****************************************************************/
339 int sid_compare(const struct dom_sid *sid1, const struct dom_sid *sid2)
350 /* Compare most likely different rids, first: i.e start at end */
351 if (sid1->num_auths != sid2->num_auths)
352 return sid1->num_auths - sid2->num_auths;
354 for (i = sid1->num_auths-1; i >= 0; --i)
355 if (sid1->sub_auths[i] != sid2->sub_auths[i])
356 return sid1->sub_auths[i] - sid2->sub_auths[i];
358 return sid_compare_auth(sid1, sid2);
361 /*****************************************************************
362 See if 2 SIDs are in the same domain
363 this just compares the leading sub-auths
364 *****************************************************************/
366 int sid_compare_domain(const struct dom_sid *sid1, const struct dom_sid *sid2)
370 n = MIN(sid1->num_auths, sid2->num_auths);
372 for (i = n-1; i >= 0; --i)
373 if (sid1->sub_auths[i] != sid2->sub_auths[i])
374 return sid1->sub_auths[i] - sid2->sub_auths[i];
376 return sid_compare_auth(sid1, sid2);
379 /*****************************************************************
381 *****************************************************************/
383 bool sid_equal(const struct dom_sid *sid1, const struct dom_sid *sid2)
385 return sid_compare(sid1, sid2) == 0;
388 /*****************************************************************
389 Returns true if SID is internal (and non-mappable).
390 *****************************************************************/
392 bool non_mappable_sid(struct dom_sid *sid)
398 sid_split_rid(&dom, &rid);
400 if (sid_equal(&dom, &global_sid_Builtin))
403 if (sid_equal(&dom, &global_sid_NT_Authority))
409 /*****************************************************************
410 Return the binary string representation of a struct dom_sid.
412 *****************************************************************/
414 char *sid_binstring(TALLOC_CTX *mem_ctx, const struct dom_sid *sid)
418 int len = ndr_size_dom_sid(sid, 0);
419 buf = talloc_array(mem_ctx, uint8_t, len);
423 sid_linearize((char *)buf, len, sid);
424 s = binary_string_rfc2254(mem_ctx, buf, len);
429 /*****************************************************************
430 Return the binary string representation of a struct dom_sid.
432 *****************************************************************/
434 char *sid_binstring_hex(const struct dom_sid *sid)
437 int len = ndr_size_dom_sid(sid, 0);
438 buf = (char *)SMB_MALLOC(len);
441 sid_linearize(buf, len, sid);
442 s = binary_string(buf, len);
447 /*******************************************************************
448 Tallocs a duplicate SID.
449 ********************************************************************/
451 struct dom_sid *sid_dup_talloc(TALLOC_CTX *ctx, const struct dom_sid *src)
458 dst = talloc_zero(ctx, struct dom_sid);
466 /********************************************************************
467 Add SID to an array SIDs
468 ********************************************************************/
470 NTSTATUS add_sid_to_array(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
471 struct dom_sid **sids, uint32_t *num)
473 *sids = TALLOC_REALLOC_ARRAY(mem_ctx, *sids, struct dom_sid,
477 return NT_STATUS_NO_MEMORY;
480 sid_copy(&((*sids)[*num]), sid);
487 /********************************************************************
488 Add SID to an array SIDs ensuring that it is not already there
489 ********************************************************************/
491 NTSTATUS add_sid_to_array_unique(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
492 struct dom_sid **sids, uint32_t *num_sids)
496 for (i=0; i<(*num_sids); i++) {
497 if (sid_compare(sid, &(*sids)[i]) == 0)
501 return add_sid_to_array(mem_ctx, sid, sids, num_sids);
504 /********************************************************************
505 Remove SID from an array
506 ********************************************************************/
508 void del_sid_from_array(const struct dom_sid *sid, struct dom_sid **sids, size_t *num)
510 struct dom_sid *sid_list = *sids;
513 for ( i=0; i<*num; i++ ) {
515 /* if we find the SID, then decrement the count
516 and break out of the loop */
518 if ( sid_equal(sid, &sid_list[i]) ) {
524 /* This loop will copy the remainder of the array
525 if i < num of sids ni the array */
527 for ( ; i<*num; i++ )
528 sid_copy( &sid_list[i], &sid_list[i+1] );
533 bool add_rid_to_array_unique(TALLOC_CTX *mem_ctx,
534 uint32 rid, uint32 **pp_rids, size_t *p_num)
538 for (i=0; i<*p_num; i++) {
539 if ((*pp_rids)[i] == rid)
543 *pp_rids = TALLOC_REALLOC_ARRAY(mem_ctx, *pp_rids, uint32, *p_num+1);
545 if (*pp_rids == NULL) {
550 (*pp_rids)[*p_num] = rid;
555 bool is_null_sid(const struct dom_sid *sid)
557 static const struct dom_sid null_sid = {0};
558 return sid_equal(sid, &null_sid);
561 bool is_sid_in_token(const struct security_token *token, const struct dom_sid *sid)
565 for (i=0; i<token->num_sids; i++) {
566 if (sid_compare(sid, &token->sids[i]) == 0)
572 NTSTATUS sid_array_from_info3(TALLOC_CTX *mem_ctx,
573 const struct netr_SamInfo3 *info3,
574 struct dom_sid **user_sids,
575 uint32_t *num_user_sids,
576 bool include_user_group_rid,
577 bool skip_ressource_groups)
581 struct dom_sid *sid_array = NULL;
582 uint32_t num_sids = 0;
585 if (include_user_group_rid) {
586 if (!sid_compose(&sid, info3->base.domain_sid, info3->base.rid)) {
587 DEBUG(3, ("could not compose user SID from rid 0x%x\n",
589 return NT_STATUS_INVALID_PARAMETER;
591 status = add_sid_to_array(mem_ctx, &sid, &sid_array, &num_sids);
592 if (!NT_STATUS_IS_OK(status)) {
593 DEBUG(3, ("could not append user SID from rid 0x%x\n",
599 if (!sid_compose(&sid, info3->base.domain_sid, info3->base.primary_gid)) {
600 DEBUG(3, ("could not compose group SID from rid 0x%x\n",
601 info3->base.primary_gid));
602 return NT_STATUS_INVALID_PARAMETER;
604 status = add_sid_to_array(mem_ctx, &sid, &sid_array, &num_sids);
605 if (!NT_STATUS_IS_OK(status)) {
606 DEBUG(3, ("could not append group SID from rid 0x%x\n",
611 for (i = 0; i < info3->base.groups.count; i++) {
612 /* Don't add the primary group sid twice. */
613 if (info3->base.primary_gid == info3->base.groups.rids[i].rid) {
616 if (!sid_compose(&sid, info3->base.domain_sid,
617 info3->base.groups.rids[i].rid)) {
618 DEBUG(3, ("could not compose SID from additional group "
619 "rid 0x%x\n", info3->base.groups.rids[i].rid));
620 return NT_STATUS_INVALID_PARAMETER;
622 status = add_sid_to_array(mem_ctx, &sid, &sid_array, &num_sids);
623 if (!NT_STATUS_IS_OK(status)) {
624 DEBUG(3, ("could not append SID from additional group "
625 "rid 0x%x\n", info3->base.groups.rids[i].rid));
630 /* Copy 'other' sids. We need to do sid filtering here to
631 prevent possible elevation of privileges. See:
633 http://www.microsoft.com/windows2000/techinfo/administration/security/sidfilter.asp
636 for (i = 0; i < info3->sidcount; i++) {
638 if (skip_ressource_groups &&
639 (info3->sids[i].attributes & SE_GROUP_RESOURCE)) {
643 status = add_sid_to_array(mem_ctx, info3->sids[i].sid,
644 &sid_array, &num_sids);
645 if (!NT_STATUS_IS_OK(status)) {
646 DEBUG(3, ("could not add SID to array: %s\n",
647 sid_string_dbg(info3->sids[i].sid)));
652 *user_sids = sid_array;
653 *num_user_sids = num_sids;