r12138: added use of 2 letter SID codes in sddl_encode_sid()
[kai/samba-autobuild/.git] / source4 / libcli / security / sddl.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    security descriptor description language functions
5
6    Copyright (C) Andrew Tridgell                2005
7       
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12    
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23 #include "includes.h"
24 #include "system/iconv.h"
25 #include "librpc/gen_ndr/ndr_security.h"
26
27 struct flag_map {
28         const char *name;
29         uint32_t flag;
30 };
31
32 /*
33   map a series of letter codes into a uint32_t
34 */
35 static BOOL sddl_map_flags(const struct flag_map *map, const char *str, 
36                            uint32_t *flags, size_t *len)
37 {
38         const char *str0 = str;
39         if (len) *len = 0;
40         *flags = 0;
41         while (str[0] && isupper(str[0])) {
42                 int i;
43                 for (i=0;map[i].name;i++) {
44                         size_t l = strlen(map[i].name);
45                         if (strncmp(map[i].name, str, l) == 0) {
46                                 *flags |= map[i].flag;
47                                 str += l;
48                                 if (len) *len += l;
49                                 break;
50                         }
51                 }
52                 if (map[i].name == NULL) {
53                         DEBUG(1, ("Unknown flag - %s in %s\n", str, str0));
54                         return False;
55                 }
56         }
57         return True;
58 }
59
60 /*
61   a mapping between the 2 letter SID codes and sid strings
62 */
63 static const struct {
64         const char *code;
65         const char *sid;
66         uint32_t rid;
67 } sid_codes[] = {
68         { "AO", SID_BUILTIN_ACCOUNT_OPERATORS },
69         { "BA", SID_BUILTIN_ADMINISTRATORS },
70         { "RU", SID_BUILTIN_PREW2K },
71         { "PO", SID_BUILTIN_PRINT_OPERATORS },
72         { "RS", SID_BUILTIN_RAS_SERVERS },
73
74         { "AU", SID_NT_AUTHENTICATED_USERS },
75         { "SY", SID_NT_SYSTEM },
76         { "PS", SID_NT_SELF },
77         { "WD", SID_WORLD },
78         { "ED", SID_NT_ENTERPRISE_DCS },
79
80         { "CO", SID_CREATOR_OWNER },
81         { "CG", SID_CREATOR_GROUP },
82
83         { "DA", NULL, DOMAIN_RID_ADMINS },
84         { "EA", NULL, DOMAIN_RID_ENTERPRISE_ADMINS },
85         { "DD", NULL, DOMAIN_RID_DCS },
86         { "DU", NULL, DOMAIN_RID_USERS },
87         { "CA", NULL, DOMAIN_RID_CERT_ADMINS },
88 };
89
90 /*
91   decode a SID
92   It can either be a special 2 letter code, or in S-* format
93 */
94 static struct dom_sid *sddl_decode_sid(TALLOC_CTX *mem_ctx, const char **sddlp,
95                                        struct dom_sid *domain_sid)
96 {
97         const char *sddl = (*sddlp);
98         int i;
99
100         /* see if its in the numeric format */
101         if (strncmp(sddl, "S-", 2) == 0) {
102                 size_t len = strspn(sddl+2, "-0123456789");
103                 (*sddlp) += len+2;
104                 return dom_sid_parse_talloc(mem_ctx, sddl);
105         }
106
107         /* now check for one of the special codes */
108         for (i=0;i<ARRAY_SIZE(sid_codes);i++) {
109                 if (strncmp(sid_codes[i].code, sddl, 2) == 0) break;
110         }
111         if (i == ARRAY_SIZE(sid_codes)) {
112                 DEBUG(1,("Unknown sddl sid code '%2.2s'\n", sddl));
113                 return NULL;
114         }
115
116         (*sddlp) += 2;
117
118         if (sid_codes[i].sid == NULL) {
119                 return dom_sid_add_rid(mem_ctx, domain_sid, sid_codes[i].rid);
120         }
121
122         return dom_sid_parse_talloc(mem_ctx, sid_codes[i].sid);
123 }
124
125 static const struct flag_map ace_types[] = {
126         { "AU", SEC_ACE_TYPE_SYSTEM_AUDIT },
127         { "AL", SEC_ACE_TYPE_SYSTEM_ALARM },
128         { "OA", SEC_ACE_TYPE_ACCESS_ALLOWED_OBJECT },
129         { "OD", SEC_ACE_TYPE_ACCESS_DENIED_OBJECT },
130         { "OU", SEC_ACE_TYPE_SYSTEM_AUDIT_OBJECT },
131         { "OL", SEC_ACE_TYPE_SYSTEM_ALARM_OBJECT },
132         { "A",  SEC_ACE_TYPE_ACCESS_ALLOWED },
133         { "D",  SEC_ACE_TYPE_ACCESS_DENIED },
134         { NULL, 0 }
135 };
136
137 static const struct flag_map ace_flags[] = {
138         { "OI", SEC_ACE_FLAG_OBJECT_INHERIT },
139         { "CI", SEC_ACE_FLAG_CONTAINER_INHERIT },
140         { "NP", SEC_ACE_FLAG_NO_PROPAGATE_INHERIT },
141         { "IO", SEC_ACE_FLAG_INHERIT_ONLY },
142         { "ID", SEC_ACE_FLAG_INHERITED_ACE },
143         { "SA", SEC_ACE_FLAG_SUCCESSFUL_ACCESS },
144         { "FA", SEC_ACE_FLAG_FAILED_ACCESS },
145         { NULL, 0 },
146 };
147
148 static const struct flag_map ace_access_mask[] = {
149         { "RP", SEC_ADS_READ_PROP },
150         { "WP", SEC_ADS_WRITE_PROP },
151         { "CR", SEC_ADS_CONTROL_ACCESS },
152         { "CC", SEC_ADS_CREATE_CHILD },
153         { "DC", SEC_ADS_DELETE_CHILD },
154         { "LC", SEC_ADS_LIST },
155         { "LO", SEC_ADS_LIST_OBJECT },
156         { "RC", SEC_STD_READ_CONTROL },
157         { "WO", SEC_STD_WRITE_OWNER },
158         { "WD", SEC_STD_WRITE_DAC },
159         { "SD", SEC_STD_DELETE },
160         { "DT", SEC_ADS_DELETE_TREE },
161         { "SW", SEC_ADS_SELF_WRITE },
162         { "GA", SEC_GENERIC_ALL },
163         { "GR", SEC_GENERIC_READ },
164         { "GW", SEC_GENERIC_WRITE },
165         { "GX", SEC_GENERIC_EXECUTE },
166         { NULL, 0 }
167 };
168
169 /*
170   decode an ACE
171   return True on success, False on failure
172   note that this routine modifies the string
173 */
174 static BOOL sddl_decode_ace(TALLOC_CTX *mem_ctx, struct security_ace *ace, char *str,
175                             struct dom_sid *domain_sid)
176 {
177         const char *tok[6];
178         const char *s;
179         int i;
180         uint32_t v;
181         struct dom_sid *sid;
182
183         ZERO_STRUCTP(ace);
184
185         /* parse out the 6 tokens */
186         tok[0] = str;
187         for (i=0;i<5;i++) {
188                 char *ptr = strchr(str, ';');
189                 if (ptr == NULL) return False;
190                 *ptr = 0;
191                 str = ptr+1;
192                 tok[i+1] = str;
193         }
194
195         /* parse ace type */
196         if (!sddl_map_flags(ace_types, tok[0], &v, NULL)) {
197                 return False;
198         }
199         ace->type = v;
200
201         /* ace flags */
202         if (!sddl_map_flags(ace_flags, tok[1], &v, NULL)) {
203                 return False;
204         }
205         ace->flags = v;
206         
207         /* access mask */
208         if (strncmp(tok[2], "0x", 2) == 0) {
209                 ace->access_mask = strtol(tok[2], NULL, 16);
210         } else {
211                 if (!sddl_map_flags(ace_access_mask, tok[2], &v, NULL)) {
212                         return False;
213                 }
214                 ace->access_mask = v;
215         }
216
217         /* object */
218         if (tok[3][0] != 0) {
219                 NTSTATUS status = GUID_from_string(tok[3], 
220                                                    &ace->object.object.type.type);
221                 if (!NT_STATUS_IS_OK(status)) {
222                         return False;
223                 }
224         }
225
226         /* inherit object */
227         if (tok[4][0] != 0) {
228                 NTSTATUS status = GUID_from_string(tok[4], 
229                                                    &ace->object.object.inherited_type.inherited_type);
230                 if (!NT_STATUS_IS_OK(status)) {
231                         return False;
232                 }
233         }
234
235         /* trustee */
236         s = tok[5];
237         sid = sddl_decode_sid(mem_ctx, &s, domain_sid);
238         if (sid == NULL) {
239                 return False;
240         }
241         ace->trustee = *sid;
242         talloc_steal(mem_ctx, sid->sub_auths);
243         talloc_free(sid);
244
245         return True;
246 }
247
248 static const struct flag_map acl_flags[] = {
249         { "P", SEC_DESC_DACL_PROTECTED },
250         { "AR", SEC_DESC_DACL_AUTO_INHERIT_REQ },
251         { "AI", SEC_DESC_DACL_AUTO_INHERITED },
252         { NULL, 0 }
253 };
254
255 /*
256   decode an ACL
257 */
258 static struct security_acl *sddl_decode_acl(struct security_descriptor *sd, 
259                                             const char **sddlp, uint32_t *flags,
260                                             struct dom_sid *domain_sid)
261 {
262         const char *sddl = *sddlp;
263         struct security_acl *acl;
264         size_t len;
265
266         *flags = 0;
267
268         acl = talloc_zero(sd, struct security_acl);
269         if (acl == NULL) return NULL;
270         acl->revision = SECURITY_ACL_REVISION_NT4;
271
272         if (isupper(sddl[0]) && sddl[1] == ':') {
273                 /* its an empty ACL */
274                 return acl;
275         }
276
277         /* work out the ACL flags */
278         if (!sddl_map_flags(acl_flags, sddl, flags, &len)) {
279                 talloc_free(acl);
280                 return NULL;
281         }
282         sddl += len;
283
284         /* now the ACEs */
285         while (*sddl == '(') {
286                 char *astr;
287                 len = strcspn(sddl+1, ")");
288                 astr = talloc_strndup(acl, sddl+1, len);
289                 if (astr == NULL || sddl[len+1] != ')') {
290                         talloc_free(acl);
291                         return NULL;
292                 }
293                 acl->aces = talloc_realloc(acl, acl->aces, struct security_ace, 
294                                            acl->num_aces+1);
295                 if (acl->aces == NULL) {
296                         talloc_free(acl);
297                         return NULL;
298                 }
299                 if (!sddl_decode_ace(acl->aces, &acl->aces[acl->num_aces], 
300                                      astr, domain_sid)) {
301                         talloc_free(acl);
302                         return NULL;
303                 }
304                 talloc_free(astr);
305                 sddl += len+2;
306                 acl->num_aces++;
307         }
308
309         (*sddlp) = sddl;
310         return acl;
311 }
312
313 /*
314   decode a security descriptor in SDDL format
315 */
316 struct security_descriptor *sddl_decode(TALLOC_CTX *mem_ctx, const char *sddl,
317                                         struct dom_sid *domain_sid)
318 {
319         struct security_descriptor *sd;
320         sd = talloc_zero(mem_ctx, struct security_descriptor);
321
322         sd->revision = SECURITY_DESCRIPTOR_REVISION_1;
323         sd->type     = SEC_DESC_SELF_RELATIVE;
324         
325         while (*sddl) {
326                 uint32_t flags;
327                 char c = sddl[0];
328                 if (sddl[1] != ':') goto failed;
329
330                 sddl += 2;
331                 switch (c) {
332                 case 'D':
333                         if (sd->dacl != NULL) goto failed;
334                         sd->dacl = sddl_decode_acl(sd, &sddl, &flags, domain_sid);
335                         if (sd->dacl == NULL) goto failed;
336                         sd->type |= flags | SEC_DESC_DACL_PRESENT;
337                         break;
338                 case 'S':
339                         if (sd->sacl != NULL) goto failed;
340                         sd->sacl = sddl_decode_acl(sd, &sddl, &flags, domain_sid);
341                         if (sd->sacl == NULL) goto failed;
342                         /* this relies on the SEC_DESC_SACL_* flags being
343                            1 bit shifted from the SEC_DESC_DACL_* flags */
344                         sd->type |= (flags<<1) | SEC_DESC_SACL_PRESENT;
345                         break;
346                 case 'O':
347                         if (sd->owner_sid != NULL) goto failed;
348                         sd->owner_sid = sddl_decode_sid(sd, &sddl, domain_sid);
349                         if (sd->owner_sid == NULL) goto failed;
350                         break;
351                 case 'G':
352                         if (sd->group_sid != NULL) goto failed;
353                         sd->group_sid = sddl_decode_sid(sd, &sddl, domain_sid);
354                         if (sd->group_sid == NULL) goto failed;
355                         break;
356                 }
357         }
358
359         return sd;
360
361 failed:
362         DEBUG(2,("Badly formatted SDDL '%s'\n", sddl));
363         talloc_free(sd);
364         return NULL;
365 }
366
367 /*
368   turn a set of flags into a string
369 */
370 static char *sddl_flags_to_string(TALLOC_CTX *mem_ctx, const struct flag_map *map,
371                                   uint32_t flags, BOOL check_all)
372 {
373         int i;
374         char *s;
375
376         /* try to find an exact match */
377         for (i=0;map[i].name;i++) {
378                 if (map[i].flag == flags) {
379                         return talloc_strdup(mem_ctx, map[i].name);
380                 }
381         }
382
383         s = talloc_strdup(mem_ctx, "");
384
385         /* now by bits */
386         for (i=0;map[i].name;i++) {
387                 if ((flags & map[i].flag) != 0) {
388                         s = talloc_asprintf_append(s, "%s", map[i].name);
389                         if (s == NULL) goto failed;
390                         flags &= ~map[i].flag;
391                 }
392         }
393
394         if (check_all && flags != 0) {
395                 goto failed;
396         }
397
398         return s;
399
400 failed:
401         talloc_free(s);
402         return NULL;
403 }
404
405 /*
406   encode a sid in SDDL format
407 */
408 static char *sddl_encode_sid(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
409                              struct dom_sid *domain_sid)
410 {
411         int i;
412         char *sidstr;
413
414         sidstr = dom_sid_string(mem_ctx, sid);
415         if (sidstr == NULL) return NULL;
416
417         /* seen if its a well known sid */ 
418         for (i=0;sid_codes[i].sid;i++) {
419                 if (strcmp(sidstr, sid_codes[i].sid) == 0) {
420                         talloc_free(sidstr);
421                         return talloc_strdup(mem_ctx, sid_codes[i].code);
422                 }
423         }
424
425         /* or a well known rid in our domain */
426         if (dom_sid_in_domain(domain_sid, sid)) {
427                 uint32_t rid = sid->sub_auths[sid->num_auths-1];
428                 for (;i<ARRAY_SIZE(sid_codes);i++) {
429                         if (rid == sid_codes[i].rid) {
430                                 talloc_free(sidstr);
431                                 return talloc_strdup(mem_ctx, sid_codes[i].code);
432                         }
433                 }
434         }
435         
436         talloc_free(sidstr);
437
438         /* TODO: encode well known sids as two letter codes */
439         return dom_sid_string(mem_ctx, sid);
440 }
441
442
443 /*
444   encode an ACE in SDDL format
445 */
446 static char *sddl_encode_ace(TALLOC_CTX *mem_ctx, const struct security_ace *ace,
447                              struct dom_sid *domain_sid)
448 {
449         char *sddl;
450         TALLOC_CTX *tmp_ctx;
451         const char *s_type="", *s_flags="", *s_mask="", 
452                 *s_object="", *s_iobject="", *s_trustee="";
453
454         tmp_ctx = talloc_new(mem_ctx);
455
456         s_type = sddl_flags_to_string(tmp_ctx, ace_types, ace->type, True);
457         if (s_type == NULL) goto failed;
458
459         s_flags = sddl_flags_to_string(tmp_ctx, ace_flags, ace->flags, True);
460         if (s_flags == NULL) goto failed;
461
462         s_mask = sddl_flags_to_string(tmp_ctx, ace_access_mask, ace->access_mask, True);
463         if (s_mask == NULL) goto failed;
464
465         if (ace->type == SEC_ACE_TYPE_ACCESS_ALLOWED_OBJECT ||
466             ace->type == SEC_ACE_TYPE_ACCESS_DENIED_OBJECT ||
467             ace->type == SEC_ACE_TYPE_SYSTEM_AUDIT_OBJECT ||
468             ace->type == SEC_ACE_TYPE_SYSTEM_AUDIT_OBJECT) {
469                 if (!GUID_all_zero(&ace->object.object.type.type)) {
470                         s_object = GUID_string(tmp_ctx, &ace->object.object.type.type);
471                         if (s_object == NULL) goto failed;
472                 }
473
474                 if (!GUID_all_zero(&ace->object.object.inherited_type.inherited_type)) {
475                         s_iobject = GUID_string(tmp_ctx, &ace->object.object.inherited_type.inherited_type);
476                         if (s_iobject == NULL) goto failed;
477                 }
478         }
479         
480         s_trustee = sddl_encode_sid(tmp_ctx, &ace->trustee, domain_sid);
481         if (s_trustee == NULL) goto failed;
482
483         sddl = talloc_asprintf(mem_ctx, "%s;%s;%s;%s;%s;%s",
484                                s_type, s_flags, s_mask, s_object, s_iobject, s_trustee);
485
486 failed:
487         talloc_free(tmp_ctx);
488         return sddl;
489 }
490
491 /*
492   encode an ACL in SDDL format
493 */
494 static char *sddl_encode_acl(TALLOC_CTX *mem_ctx, const struct security_acl *acl,
495                              uint32_t flags, struct dom_sid *domain_sid)
496 {
497         char *sddl;
498         int i;
499
500         /* add any ACL flags */
501         sddl = sddl_flags_to_string(mem_ctx, acl_flags, flags, False);
502         if (sddl == NULL) goto failed;
503
504         /* now the ACEs, encoded in braces */
505         for (i=0;i<acl->num_aces;i++) {
506                 char *ace = sddl_encode_ace(sddl, &acl->aces[i], domain_sid);
507                 if (ace == NULL) goto failed;
508                 sddl = talloc_asprintf_append(sddl, "(%s)", ace);
509                 if (sddl == NULL) goto failed;
510                 talloc_free(ace);
511         }
512
513         return sddl;
514
515 failed:
516         talloc_free(sddl);
517         return NULL;
518 }
519
520
521 /*
522   encode a security descriptor to SDDL format
523 */
524 char *sddl_encode(TALLOC_CTX *mem_ctx, const struct security_descriptor *sd,
525                   struct dom_sid *domain_sid)
526 {
527         char *sddl;
528         TALLOC_CTX *tmp_ctx;
529
530         /* start with a blank string */
531         sddl = talloc_strdup(mem_ctx, "");
532         if (sddl == NULL) goto failed;
533
534         tmp_ctx = talloc_new(mem_ctx);
535
536         if (sd->owner_sid != NULL) {
537                 char *sid = sddl_encode_sid(tmp_ctx, sd->owner_sid, domain_sid);
538                 if (sid == NULL) goto failed;
539                 sddl = talloc_asprintf_append(sddl, "O:%s", sid);
540                 if (sddl == NULL) goto failed;
541         }
542
543         if (sd->group_sid != NULL) {
544                 char *sid = sddl_encode_sid(tmp_ctx, sd->group_sid, domain_sid);
545                 if (sid == NULL) goto failed;
546                 sddl = talloc_asprintf_append(sddl, "G:%s", sid);
547                 if (sddl == NULL) goto failed;
548         }
549
550         if ((sd->type & SEC_DESC_DACL_PRESENT) && sd->dacl != NULL) {
551                 char *acl = sddl_encode_acl(tmp_ctx, sd->dacl, sd->type, domain_sid);
552                 if (acl == NULL) goto failed;
553                 sddl = talloc_asprintf_append(sddl, "D:%s", acl);
554                 if (sddl == NULL) goto failed;
555         }
556
557         if ((sd->type & SEC_DESC_SACL_PRESENT) && sd->sacl != NULL) {
558                 char *acl = sddl_encode_acl(tmp_ctx, sd->sacl, sd->type>>1, domain_sid);
559                 if (acl == NULL) goto failed;
560                 sddl = talloc_asprintf_append(sddl, "S:%s", acl);
561                 if (sddl == NULL) goto failed;
562         }
563
564         talloc_free(tmp_ctx);
565         return sddl;
566
567 failed:
568         talloc_free(sddl);
569         return NULL;
570 }
571
572