s3:services_db: change svcctl_lookup_description() to use reg_api functions
[Samba.git] / libcli / security / dom_sid.c
blob93f887134e56ce30b135826c0baa5125cf22d178
1 /*
2 Unix SMB/CIFS implementation.
3 Samba utility functions
5 Copyright (C) Stefan (metze) Metzmacher 2002-2004
6 Copyright (C) Andrew Tridgell 1992-2004
7 Copyright (C) Jeremy Allison 1999
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "includes.h"
24 #include "librpc/gen_ndr/security.h"
25 #include "dom_sid.h"
27 /*****************************************************************
28 Compare the auth portion of two sids.
29 *****************************************************************/
31 static int dom_sid_compare_auth(const struct dom_sid *sid1,
32 const struct dom_sid *sid2)
34 int i;
36 if (sid1 == sid2)
37 return 0;
38 if (!sid1)
39 return -1;
40 if (!sid2)
41 return 1;
43 if (sid1->sid_rev_num != sid2->sid_rev_num)
44 return sid1->sid_rev_num - sid2->sid_rev_num;
46 for (i = 0; i < 6; i++)
47 if (sid1->id_auth[i] != sid2->id_auth[i])
48 return sid1->id_auth[i] - sid2->id_auth[i];
50 return 0;
53 /*****************************************************************
54 Compare two sids.
55 *****************************************************************/
57 int dom_sid_compare(const struct dom_sid *sid1, const struct dom_sid *sid2)
59 int i;
61 if (sid1 == sid2)
62 return 0;
63 if (!sid1)
64 return -1;
65 if (!sid2)
66 return 1;
68 /* Compare most likely different rids, first: i.e start at end */
69 if (sid1->num_auths != sid2->num_auths)
70 return sid1->num_auths - sid2->num_auths;
72 for (i = sid1->num_auths-1; i >= 0; --i)
73 if (sid1->sub_auths[i] != sid2->sub_auths[i])
74 return sid1->sub_auths[i] - sid2->sub_auths[i];
76 return dom_sid_compare_auth(sid1, sid2);
79 /*****************************************************************
80 Compare two sids.
81 *****************************************************************/
83 bool dom_sid_equal(const struct dom_sid *sid1, const struct dom_sid *sid2)
85 return dom_sid_compare(sid1, sid2) == 0;
88 /*****************************************************************
89 Add a rid to the end of a sid
90 *****************************************************************/
92 bool sid_append_rid(struct dom_sid *sid, uint32_t rid)
94 if (sid->num_auths < ARRAY_SIZE(sid->sub_auths)) {
95 sid->sub_auths[sid->num_auths++] = rid;
96 return true;
98 return false;
101 /*****************************************************************
102 Convert a string to a SID. Returns True on success, False on fail.
103 *****************************************************************/
105 bool string_to_sid(struct dom_sid *sidout, const char *sidstr)
107 const char *p;
108 char *q;
109 /* BIG NOTE: this function only does SIDS where the identauth is not >= 2^32 */
110 uint32_t conv;
112 ZERO_STRUCTP(sidout);
114 if ((sidstr[0] != 'S' && sidstr[0] != 's') || sidstr[1] != '-') {
115 goto format_error;
118 /* Get the revision number. */
119 p = sidstr + 2;
121 if (!isdigit(*p)) {
122 goto format_error;
125 conv = (uint32_t) strtoul(p, &q, 10);
126 if (!q || (*q != '-')) {
127 goto format_error;
129 sidout->sid_rev_num = (uint8_t) conv;
130 q++;
132 if (!isdigit(*q)) {
133 goto format_error;
136 /* get identauth */
137 conv = (uint32_t) strtoul(q, &q, 10);
138 if (!q) {
139 goto format_error;
142 /* identauth in decimal should be < 2^32 */
143 /* NOTE - the conv value is in big-endian format. */
144 sidout->id_auth[0] = 0;
145 sidout->id_auth[1] = 0;
146 sidout->id_auth[2] = (conv & 0xff000000) >> 24;
147 sidout->id_auth[3] = (conv & 0x00ff0000) >> 16;
148 sidout->id_auth[4] = (conv & 0x0000ff00) >> 8;
149 sidout->id_auth[5] = (conv & 0x000000ff);
151 sidout->num_auths = 0;
152 if (*q != '-') {
153 /* Just id_auth, no subauths */
154 return true;
157 q++;
159 while (true) {
160 char *end;
162 if (!isdigit(*q)) {
163 goto format_error;
166 conv = strtoul(q, &end, 10);
167 if (end == q) {
168 goto format_error;
171 if (!sid_append_rid(sidout, conv)) {
172 DEBUG(3, ("Too many sid auths in %s\n", sidstr));
173 return false;
176 q = end;
177 if (*q != '-') {
178 break;
180 q += 1;
182 return true;
184 format_error:
185 DEBUG(3, ("string_to_sid: SID %s is not in a valid format\n", sidstr));
186 return false;
189 bool dom_sid_parse(const char *sidstr, struct dom_sid *ret)
191 return string_to_sid(ret, sidstr);
195 convert a string to a dom_sid, returning a talloc'd dom_sid
197 struct dom_sid *dom_sid_parse_talloc(TALLOC_CTX *mem_ctx, const char *sidstr)
199 struct dom_sid *ret;
200 ret = talloc(mem_ctx, struct dom_sid);
201 if (!ret) {
202 return NULL;
204 if (!dom_sid_parse(sidstr, ret)) {
205 talloc_free(ret);
206 return NULL;
209 return ret;
213 convert a string to a dom_sid, returning a talloc'd dom_sid
215 struct dom_sid *dom_sid_parse_length(TALLOC_CTX *mem_ctx, const DATA_BLOB *sid)
217 struct dom_sid *ret;
218 char *p = talloc_strndup(mem_ctx, (char *)sid->data, sid->length);
219 if (!p) {
220 return NULL;
222 ret = dom_sid_parse_talloc(mem_ctx, p);
223 talloc_free(p);
224 return ret;
228 copy a dom_sid structure
230 struct dom_sid *dom_sid_dup(TALLOC_CTX *mem_ctx, const struct dom_sid *dom_sid)
232 struct dom_sid *ret;
233 int i;
235 if (!dom_sid) {
236 return NULL;
239 ret = talloc(mem_ctx, struct dom_sid);
240 if (!ret) {
241 return NULL;
244 ret->sid_rev_num = dom_sid->sid_rev_num;
245 ret->id_auth[0] = dom_sid->id_auth[0];
246 ret->id_auth[1] = dom_sid->id_auth[1];
247 ret->id_auth[2] = dom_sid->id_auth[2];
248 ret->id_auth[3] = dom_sid->id_auth[3];
249 ret->id_auth[4] = dom_sid->id_auth[4];
250 ret->id_auth[5] = dom_sid->id_auth[5];
251 ret->num_auths = dom_sid->num_auths;
253 for (i=0;i<dom_sid->num_auths;i++) {
254 ret->sub_auths[i] = dom_sid->sub_auths[i];
257 return ret;
261 add a rid to a domain dom_sid to make a full dom_sid. This function
262 returns a new sid in the supplied memory context
264 struct dom_sid *dom_sid_add_rid(TALLOC_CTX *mem_ctx,
265 const struct dom_sid *domain_sid,
266 uint32_t rid)
268 struct dom_sid *sid;
270 sid = dom_sid_dup(mem_ctx, domain_sid);
271 if (!sid) return NULL;
273 if (!sid_append_rid(sid, rid)) {
274 talloc_free(sid);
275 return NULL;
278 return sid;
282 Split up a SID into its domain and RID part
284 NTSTATUS dom_sid_split_rid(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
285 struct dom_sid **domain, uint32_t *rid)
287 if (sid->num_auths == 0) {
288 return NT_STATUS_INVALID_PARAMETER;
291 if (domain) {
292 if (!(*domain = dom_sid_dup(mem_ctx, sid))) {
293 return NT_STATUS_NO_MEMORY;
296 (*domain)->num_auths -= 1;
299 if (rid) {
300 *rid = sid->sub_auths[sid->num_auths - 1];
303 return NT_STATUS_OK;
307 return true if the 2nd sid is in the domain given by the first sid
309 bool dom_sid_in_domain(const struct dom_sid *domain_sid,
310 const struct dom_sid *sid)
312 int i;
314 if (!domain_sid || !sid) {
315 return false;
318 if (domain_sid->num_auths > sid->num_auths) {
319 return false;
322 for (i = domain_sid->num_auths-1; i >= 0; --i) {
323 if (domain_sid->sub_auths[i] != sid->sub_auths[i]) {
324 return false;
328 return dom_sid_compare_auth(domain_sid, sid) == 0;
332 convert a dom_sid to a string
334 char *dom_sid_string(TALLOC_CTX *mem_ctx, const struct dom_sid *sid)
336 int i, ofs, maxlen;
337 uint32_t ia;
338 char *ret;
340 if (!sid) {
341 return talloc_strdup(mem_ctx, "(NULL SID)");
344 maxlen = sid->num_auths * 11 + 25;
345 ret = talloc_array(mem_ctx, char, maxlen);
346 if (!ret) return talloc_strdup(mem_ctx, "(SID ERR)");
348 ia = (sid->id_auth[5]) +
349 (sid->id_auth[4] << 8 ) +
350 (sid->id_auth[3] << 16) +
351 (sid->id_auth[2] << 24);
353 ofs = snprintf(ret, maxlen, "S-%u-%lu",
354 (unsigned int)sid->sid_rev_num, (unsigned long)ia);
356 for (i = 0; i < sid->num_auths; i++) {
357 ofs += snprintf(ret + ofs, maxlen - ofs, "-%lu",
358 (unsigned long)sid->sub_auths[i]);
361 return ret;