s3-registry: fix upgrade code
[Samba/gebeck_regimport.git] / libcli / security / util_sid.c
blob84ac0f1dbc4ea1013f2aadcc78ddd9dca85aebee
1 /*
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
10 Copyright (C) Andrew Bartlett 2010
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 3 of the License, or
15 (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program. If not, see <http://www.gnu.org/licenses/>.
26 #include "includes.h"
27 #include "../librpc/gen_ndr/ndr_security.h"
28 #include "../librpc/gen_ndr/netlogon.h"
29 #include "../libcli/security/security.h"
32 * Some useful sids, more well known sids can be found at
33 * http://support.microsoft.com/kb/243330/EN-US/
37 const struct dom_sid global_sid_World_Domain = /* Everyone domain */
38 { 1, 0, {0,0,0,0,0,1}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
39 const struct dom_sid global_sid_World = /* Everyone */
40 { 1, 1, {0,0,0,0,0,1}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
41 const struct dom_sid global_sid_Creator_Owner_Domain = /* Creator Owner domain */
42 { 1, 0, {0,0,0,0,0,3}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
43 const struct dom_sid global_sid_NT_Authority = /* NT Authority */
44 { 1, 0, {0,0,0,0,0,5}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
45 const struct dom_sid global_sid_System = /* System */
46 { 1, 1, {0,0,0,0,0,5}, {18,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
47 const struct dom_sid global_sid_NULL = /* NULL sid */
48 { 1, 1, {0,0,0,0,0,0}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
49 const struct dom_sid global_sid_Authenticated_Users = /* All authenticated rids */
50 { 1, 1, {0,0,0,0,0,5}, {11,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
51 #if 0
52 /* for documentation */
53 const struct dom_sid global_sid_Restriced = /* Restriced Code */
54 { 1, 1, {0,0,0,0,0,5}, {12,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
55 #endif
56 const struct dom_sid global_sid_Network = /* Network rids */
57 { 1, 1, {0,0,0,0,0,5}, {2,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
59 const struct dom_sid global_sid_Creator_Owner = /* Creator Owner */
60 { 1, 1, {0,0,0,0,0,3}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
61 const struct dom_sid global_sid_Creator_Group = /* Creator Group */
62 { 1, 1, {0,0,0,0,0,3}, {1,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
63 const struct dom_sid global_sid_Anonymous = /* Anonymous login */
64 { 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_Enterprise_DCs = /* Enterprise DCs */
66 { 1, 1, {0,0,0,0,0,5}, {9,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
67 const struct dom_sid global_sid_Builtin = /* Local well-known domain */
68 { 1, 1, {0,0,0,0,0,5}, {32,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
69 const struct dom_sid global_sid_Builtin_Administrators = /* Builtin administrators */
70 { 1, 2, {0,0,0,0,0,5}, {32,544,0,0,0,0,0,0,0,0,0,0,0,0,0}};
71 const struct dom_sid global_sid_Builtin_Users = /* Builtin users */
72 { 1, 2, {0,0,0,0,0,5}, {32,545,0,0,0,0,0,0,0,0,0,0,0,0,0}};
73 const struct dom_sid global_sid_Builtin_Guests = /* Builtin guest users */
74 { 1, 2, {0,0,0,0,0,5}, {32,546,0,0,0,0,0,0,0,0,0,0,0,0,0}};
75 const struct dom_sid global_sid_Builtin_Power_Users = /* Builtin power users */
76 { 1, 2, {0,0,0,0,0,5}, {32,547,0,0,0,0,0,0,0,0,0,0,0,0,0}};
77 const struct dom_sid global_sid_Builtin_Account_Operators = /* Builtin account operators */
78 { 1, 2, {0,0,0,0,0,5}, {32,548,0,0,0,0,0,0,0,0,0,0,0,0,0}};
79 const struct dom_sid global_sid_Builtin_Server_Operators = /* Builtin server operators */
80 { 1, 2, {0,0,0,0,0,5}, {32,549,0,0,0,0,0,0,0,0,0,0,0,0,0}};
81 const struct dom_sid global_sid_Builtin_Print_Operators = /* Builtin print operators */
82 { 1, 2, {0,0,0,0,0,5}, {32,550,0,0,0,0,0,0,0,0,0,0,0,0,0}};
83 const struct dom_sid global_sid_Builtin_Backup_Operators = /* Builtin backup operators */
84 { 1, 2, {0,0,0,0,0,5}, {32,551,0,0,0,0,0,0,0,0,0,0,0,0,0}};
85 const struct dom_sid global_sid_Builtin_Replicator = /* Builtin replicator */
86 { 1, 2, {0,0,0,0,0,5}, {32,552,0,0,0,0,0,0,0,0,0,0,0,0,0}};
87 const struct dom_sid global_sid_Builtin_PreWin2kAccess = /* Builtin pre win2k access */
88 { 1, 2, {0,0,0,0,0,5}, {32,554,0,0,0,0,0,0,0,0,0,0,0,0,0}};
90 const struct dom_sid global_sid_Unix_Users = /* Unmapped Unix users */
91 { 1, 1, {0,0,0,0,0,22}, {1,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
92 const struct dom_sid global_sid_Unix_Groups = /* Unmapped Unix groups */
93 { 1, 1, {0,0,0,0,0,22}, {2,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
95 /* Unused, left here for documentary purposes */
96 #if 0
97 #define SECURITY_NULL_SID_AUTHORITY 0
98 #define SECURITY_WORLD_SID_AUTHORITY 1
99 #define SECURITY_LOCAL_SID_AUTHORITY 2
100 #define SECURITY_CREATOR_SID_AUTHORITY 3
101 #define SECURITY_NT_AUTHORITY 5
102 #endif
104 static struct dom_sid system_sid_array[1] =
105 { { 1, 1, {0,0,0,0,0,5}, {18,0,0,0,0,0,0,0,0,0,0,0,0,0,0}} };
106 static const struct security_token system_token = {
107 .num_sids = ARRAY_SIZE(system_sid_array),
108 .sids = system_sid_array,
109 .privilege_mask = SE_ALL_PRIVS
112 /****************************************************************************
113 Lookup string names for SID types.
114 ****************************************************************************/
116 static const struct {
117 enum lsa_SidType sid_type;
118 const char *string;
119 } sid_name_type[] = {
120 {SID_NAME_USE_NONE, "None"},
121 {SID_NAME_USER, "User"},
122 {SID_NAME_DOM_GRP, "Domain Group"},
123 {SID_NAME_DOMAIN, "Domain"},
124 {SID_NAME_ALIAS, "Local Group"},
125 {SID_NAME_WKN_GRP, "Well-known Group"},
126 {SID_NAME_DELETED, "Deleted Account"},
127 {SID_NAME_INVALID, "Invalid Account"},
128 {SID_NAME_UNKNOWN, "UNKNOWN"},
129 {SID_NAME_COMPUTER, "Computer"}
132 const char *sid_type_lookup(uint32_t sid_type)
134 int i;
136 /* Look through list */
137 for (i=0; i < ARRAY_SIZE(sid_name_type); i++) {
138 if (sid_name_type[i].sid_type == sid_type) {
139 return sid_name_type[i].string;
143 /* Default return */
144 return "SID *TYPE* is INVALID";
147 /**************************************************************************
148 Create the SYSTEM token.
149 ***************************************************************************/
151 const struct security_token *get_system_token(void)
153 return &system_token;
156 bool sid_compose(struct dom_sid *dst, const struct dom_sid *domain_sid, uint32_t rid)
158 sid_copy(dst, domain_sid);
159 return sid_append_rid(dst, rid);
162 /*****************************************************************
163 Removes the last rid from the end of a sid
164 *****************************************************************/
166 bool sid_split_rid(struct dom_sid *sid, uint32_t *rid)
168 if (sid->num_auths > 0) {
169 sid->num_auths--;
170 if (rid != NULL) {
171 *rid = sid->sub_auths[sid->num_auths];
173 return true;
175 return false;
178 /*****************************************************************
179 Return the last rid from the end of a sid
180 *****************************************************************/
182 bool sid_peek_rid(const struct dom_sid *sid, uint32_t *rid)
184 if (!sid || !rid)
185 return false;
187 if (sid->num_auths > 0) {
188 *rid = sid->sub_auths[sid->num_auths - 1];
189 return true;
191 return false;
194 /*****************************************************************
195 Return the last rid from the end of a sid
196 and check the sid against the exp_dom_sid
197 *****************************************************************/
199 bool sid_peek_check_rid(const struct dom_sid *exp_dom_sid, const struct dom_sid *sid, uint32_t *rid)
201 if (!exp_dom_sid || !sid || !rid)
202 return false;
204 if (sid->num_auths != (exp_dom_sid->num_auths+1)) {
205 return false;
208 if (sid_compare_domain(exp_dom_sid, sid)!=0){
209 *rid=(-1);
210 return false;
213 return sid_peek_rid(sid, rid);
216 /*****************************************************************
217 Copies a sid
218 *****************************************************************/
220 void sid_copy(struct dom_sid *dst, const struct dom_sid *src)
222 int i;
224 ZERO_STRUCTP(dst);
226 dst->sid_rev_num = src->sid_rev_num;
227 dst->num_auths = src->num_auths;
229 memcpy(&dst->id_auth[0], &src->id_auth[0], sizeof(src->id_auth));
231 for (i = 0; i < src->num_auths; i++)
232 dst->sub_auths[i] = src->sub_auths[i];
235 /*****************************************************************
236 Parse a on-the-wire SID (in a DATA_BLOB) to a struct dom_sid.
237 *****************************************************************/
239 bool sid_blob_parse(DATA_BLOB in, struct dom_sid *sid)
241 enum ndr_err_code ndr_err;
242 ndr_err = ndr_pull_struct_blob_all(&in, NULL, sid,
243 (ndr_pull_flags_fn_t)ndr_pull_dom_sid);
244 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
245 return false;
247 return true;
250 /*****************************************************************
251 Parse a on-the-wire SID to a struct dom_sid.
252 *****************************************************************/
254 bool sid_parse(const char *inbuf, size_t len, struct dom_sid *sid)
256 DATA_BLOB in = data_blob_const(inbuf, len);
257 return sid_blob_parse(in, sid);
260 /*****************************************************************
261 See if 2 SIDs are in the same domain
262 this just compares the leading sub-auths
263 *****************************************************************/
265 int sid_compare_domain(const struct dom_sid *sid1, const struct dom_sid *sid2)
267 int n, i;
269 n = MIN(sid1->num_auths, sid2->num_auths);
271 for (i = n-1; i >= 0; --i)
272 if (sid1->sub_auths[i] != sid2->sub_auths[i])
273 return sid1->sub_auths[i] - sid2->sub_auths[i];
275 return dom_sid_compare_auth(sid1, sid2);
278 /********************************************************************
279 Add SID to an array SIDs
280 ********************************************************************/
282 NTSTATUS add_sid_to_array(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
283 struct dom_sid **sids, uint32_t *num)
285 *sids = talloc_realloc(mem_ctx, *sids, struct dom_sid,
286 (*num)+1);
287 if (*sids == NULL) {
288 *num = 0;
289 return NT_STATUS_NO_MEMORY;
292 sid_copy(&((*sids)[*num]), sid);
293 *num += 1;
295 return NT_STATUS_OK;
299 /********************************************************************
300 Add SID to an array SIDs ensuring that it is not already there
301 ********************************************************************/
303 NTSTATUS add_sid_to_array_unique(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
304 struct dom_sid **sids, uint32_t *num_sids)
306 uint32_t i;
308 for (i=0; i<(*num_sids); i++) {
309 if (dom_sid_compare(sid, &(*sids)[i]) == 0)
310 return NT_STATUS_OK;
313 return add_sid_to_array(mem_ctx, sid, sids, num_sids);
316 /********************************************************************
317 Remove SID from an array
318 ********************************************************************/
320 void del_sid_from_array(const struct dom_sid *sid, struct dom_sid **sids,
321 uint32_t *num)
323 struct dom_sid *sid_list = *sids;
324 uint32_t i;
326 for ( i=0; i<*num; i++ ) {
328 /* if we find the SID, then decrement the count
329 and break out of the loop */
331 if (dom_sid_equal(sid, &sid_list[i])) {
332 *num -= 1;
333 break;
337 /* This loop will copy the remainder of the array
338 if i < num of sids in the array */
340 for ( ; i<*num; i++ ) {
341 sid_copy( &sid_list[i], &sid_list[i+1] );
344 return;
347 bool add_rid_to_array_unique(TALLOC_CTX *mem_ctx,
348 uint32_t rid, uint32_t **pp_rids, size_t *p_num)
350 size_t i;
352 for (i=0; i<*p_num; i++) {
353 if ((*pp_rids)[i] == rid)
354 return true;
357 *pp_rids = talloc_realloc(mem_ctx, *pp_rids, uint32_t, *p_num+1);
359 if (*pp_rids == NULL) {
360 *p_num = 0;
361 return false;
364 (*pp_rids)[*p_num] = rid;
365 *p_num += 1;
366 return true;
369 bool is_null_sid(const struct dom_sid *sid)
371 static const struct dom_sid null_sid = {0};
372 return dom_sid_equal(sid, &null_sid);