ctdb-scripts: Improve update and listing code
[samba4-gss.git] / libcli / security / create_descriptor.c
blobd8575f59b8bc0b729777212a511f174438192f9c
1 /*
2 Copyright (C) Nadezhda Ivanova 2009
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
19 * Name: create_descriptor
21 * Component: routines for calculating and creating security descriptors
22 * as described in MS-DTYP 2.5.3.x
24 * Description:
27 * Author: Nadezhda Ivanova
29 #include "replace.h"
30 #include "lib/util/debug.h"
31 #include "libcli/security/security.h"
32 #include "librpc/gen_ndr/ndr_security.h"
34 /* Todos:
35 * build the security token dacl as follows:
36 * SYSTEM: GA, OWNER: GA, LOGIN_SID:GW|GE
37 * Need session id information for the login SID. Probably
38 * the best place for this is during token creation
40 * Implement SD Invariants
41 * ACE sorting rules
42 * LDAP_SERVER_SD_FLAGS_OID control
43 * ADTS 7.1.3.3 needs to be clarified
46 /* the mapping function for generic rights for DS.(GA,GR,GW,GX)
47 * The mapping function is passed as an argument to the
48 * descriptor calculating routine and depends on the security
49 * manager that calls the calculating routine.
50 * TODO: need similar mappings for the file system and
51 * registry security managers in order to make this code
52 * generic for all security managers
55 uint32_t map_generic_rights_ds(uint32_t access_mask)
57 if (access_mask & SEC_GENERIC_ALL) {
58 access_mask |= SEC_ADS_GENERIC_ALL;
59 access_mask &= ~SEC_GENERIC_ALL;
62 if (access_mask & SEC_GENERIC_EXECUTE) {
63 access_mask |= SEC_ADS_GENERIC_EXECUTE;
64 access_mask &= ~SEC_GENERIC_EXECUTE;
67 if (access_mask & SEC_GENERIC_WRITE) {
68 access_mask |= SEC_ADS_GENERIC_WRITE;
69 access_mask &= ~SEC_GENERIC_WRITE;
72 if (access_mask & SEC_GENERIC_READ) {
73 access_mask |= SEC_ADS_GENERIC_READ;
74 access_mask &= ~SEC_GENERIC_READ;
77 return access_mask;
80 /* Not sure what this has to be,
81 * and it does not seem to have any influence */
82 static bool object_in_list(const struct GUID *object_list, const struct GUID *object)
84 size_t i;
86 if (object_list == NULL) {
87 return true;
90 if (GUID_all_zero(object)) {
91 return true;
94 for (i=0; ; i++) {
95 if (GUID_all_zero(&object_list[i])) {
96 return false;
98 if (!GUID_equal(&object_list[i], object)) {
99 continue;
102 return true;
105 return false;
108 /* returns true if the ACE contains generic information
109 * that needs to be processed additionally */
111 static bool desc_ace_has_generic(const struct security_ace *ace)
113 if (ace->access_mask & SEC_GENERIC_ALL || ace->access_mask & SEC_GENERIC_READ ||
114 ace->access_mask & SEC_GENERIC_WRITE || ace->access_mask & SEC_GENERIC_EXECUTE) {
115 return true;
117 if (dom_sid_equal(&ace->trustee, &global_sid_Creator_Owner) ||
118 dom_sid_equal(&ace->trustee, &global_sid_Creator_Group)) {
119 return true;
121 return false;
124 /* creates an ace in which the generic information is expanded */
126 static void desc_expand_generic(struct security_ace *new_ace,
127 const struct dom_sid *owner,
128 const struct dom_sid *group)
130 new_ace->access_mask = map_generic_rights_ds(new_ace->access_mask);
131 if (dom_sid_equal(&new_ace->trustee, &global_sid_Creator_Owner)) {
132 new_ace->trustee = *owner;
134 if (dom_sid_equal(&new_ace->trustee, &global_sid_Creator_Group)) {
135 new_ace->trustee = *group;
137 new_ace->flags = 0x0;
140 static struct security_acl *calculate_inherited_from_parent(
141 TALLOC_CTX *mem_ctx,
142 struct security_acl *acl,
143 bool is_container,
144 const struct dom_sid *owner,
145 const struct dom_sid *group,
146 struct GUID *object_list)
148 uint32_t i;
149 struct security_acl *tmp_acl = NULL;
151 if (!acl) {
152 return NULL;
154 tmp_acl = talloc_zero(mem_ctx, struct security_acl);
155 if (!tmp_acl) {
156 return NULL;
159 for (i=0; i < acl->num_aces; i++) {
160 const struct security_ace *ace = &acl->aces[i];
161 const struct GUID *inherited_object = NULL;
162 const struct GUID *inherited_property = NULL;
163 struct security_ace *tmp_ace = NULL;
164 bool applies = false;
165 bool inherited_only = false;
166 bool expand_ace = false;
167 bool expand_only = false;
169 if (is_container && (ace->flags & SEC_ACE_FLAG_CONTAINER_INHERIT)) {
170 applies = true;
171 } else if (!is_container && (ace->flags & SEC_ACE_FLAG_OBJECT_INHERIT)) {
172 applies = true;
175 if (!applies) {
177 * If the ace doesn't apply to the
178 * current node, we should only keep
179 * it as SEC_ACE_FLAG_OBJECT_INHERIT
180 * on a container. We'll add
181 * SEC_ACE_FLAG_INHERITED_ACE
182 * and SEC_ACE_FLAG_INHERIT_ONLY below.
184 * Otherwise we should completely ignore it.
186 if (!(ace->flags & SEC_ACE_FLAG_OBJECT_INHERIT)) {
187 continue;
191 switch (ace->type) {
192 case SEC_ACE_TYPE_ACCESS_ALLOWED:
193 case SEC_ACE_TYPE_ACCESS_DENIED:
194 case SEC_ACE_TYPE_SYSTEM_AUDIT:
195 case SEC_ACE_TYPE_SYSTEM_ALARM:
196 case SEC_ACE_TYPE_ALLOWED_COMPOUND:
197 break;
199 case SEC_ACE_TYPE_ACCESS_ALLOWED_OBJECT:
200 case SEC_ACE_TYPE_ACCESS_DENIED_OBJECT:
201 case SEC_ACE_TYPE_SYSTEM_ALARM_OBJECT:
202 case SEC_ACE_TYPE_SYSTEM_AUDIT_OBJECT:
203 case SEC_ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT:
204 case SEC_ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT:
205 case SEC_ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT:
206 if (ace->object.object.flags & SEC_ACE_OBJECT_TYPE_PRESENT) {
207 inherited_property = &ace->object.object.type.type;
209 if (ace->object.object.flags & SEC_ACE_INHERITED_OBJECT_TYPE_PRESENT) {
210 inherited_object = &ace->object.object.inherited_type.inherited_type;
213 if (inherited_object != NULL && !object_in_list(object_list, inherited_object)) {
215 * An explicit object class schemaId is given,
216 * but doesn't belong to the current object.
218 applies = false;
221 break;
223 case SEC_ACE_TYPE_ACCESS_DENIED_CALLBACK:
224 case SEC_ACE_TYPE_ACCESS_ALLOWED_CALLBACK:
225 case SEC_ACE_TYPE_SYSTEM_AUDIT_CALLBACK:
226 break;
227 case SEC_ACE_TYPE_SYSTEM_RESOURCE_ATTRIBUTE:
228 break;
229 case SEC_ACE_TYPE_SYSTEM_ALARM_CALLBACK:
230 case SEC_ACE_TYPE_SYSTEM_ALARM_CALLBACK_OBJECT:
231 case SEC_ACE_TYPE_SYSTEM_MANDATORY_LABEL:
232 case SEC_ACE_TYPE_SYSTEM_SCOPED_POLICY_ID:
233 default:
234 DBG_WARNING("ACE type %d is not handled\n", ace->type);
235 TALLOC_FREE(tmp_acl);
236 return NULL;
239 if (ace->flags & SEC_ACE_FLAG_NO_PROPAGATE_INHERIT) {
240 if (!applies) {
242 * If the ACE doesn't apply to
243 * the current object, we should
244 * ignore it as it should not be
245 * inherited any further
247 continue;
250 * We should only keep the expanded version
251 * of the ACE on the current object.
253 expand_ace = true;
254 expand_only = true;
255 } else if (applies) {
257 * We check if should also add
258 * the expanded version of the ACE
259 * in addition, in case we should
260 * expand generic access bits or
261 * special sids.
263 * In that case we need to
264 * keep the original ACE with
265 * SEC_ACE_FLAG_INHERIT_ONLY.
267 expand_ace = desc_ace_has_generic(ace);
268 if (expand_ace) {
269 inherited_only = true;
271 } else {
273 * If the ACE doesn't apply
274 * to the current object,
275 * we need to keep it with
276 * SEC_ACE_FLAG_INHERIT_ONLY
277 * in order to apply them to
278 * grandchildren
280 inherited_only = true;
283 if (expand_ace) {
284 tmp_acl->aces = talloc_realloc(tmp_acl,
285 tmp_acl->aces,
286 struct security_ace,
287 tmp_acl->num_aces+1);
288 if (tmp_acl->aces == NULL) {
289 TALLOC_FREE(tmp_acl);
290 return NULL;
293 tmp_ace = &tmp_acl->aces[tmp_acl->num_aces];
294 tmp_acl->num_aces++;
296 *tmp_ace = *ace;
299 * Expand generic access bits as well as special
300 * sids.
302 desc_expand_generic(tmp_ace, owner, group);
305 * Expanded ACEs are marked as inherited,
306 * but never inherited any further to
307 * grandchildren.
309 tmp_ace->flags |= SEC_ACE_FLAG_INHERITED_ACE;
310 tmp_ace->flags &= ~SEC_ACE_FLAG_CONTAINER_INHERIT;
311 tmp_ace->flags &= ~SEC_ACE_FLAG_OBJECT_INHERIT;
312 tmp_ace->flags &= ~SEC_ACE_FLAG_NO_PROPAGATE_INHERIT;
315 * Expanded ACEs never have an explicit
316 * object class schemaId, so clear it
317 * if present.
319 if (inherited_object != NULL) {
320 tmp_ace->object.object.flags &= ~SEC_ACE_INHERITED_OBJECT_TYPE_PRESENT;
324 * If the ACE had an explicit object class
325 * schemaId, but no attribute/propertySet
326 * we need to downgrade the _OBJECT variants
327 * to the normal ones.
329 if (inherited_property == NULL) {
330 switch (tmp_ace->type) {
331 case SEC_ACE_TYPE_ACCESS_ALLOWED:
332 case SEC_ACE_TYPE_ACCESS_DENIED:
333 case SEC_ACE_TYPE_SYSTEM_AUDIT:
334 case SEC_ACE_TYPE_SYSTEM_ALARM:
335 case SEC_ACE_TYPE_ALLOWED_COMPOUND:
336 break;
337 case SEC_ACE_TYPE_ACCESS_ALLOWED_OBJECT:
338 tmp_ace->type = SEC_ACE_TYPE_ACCESS_ALLOWED;
339 break;
340 case SEC_ACE_TYPE_ACCESS_DENIED_OBJECT:
341 tmp_ace->type = SEC_ACE_TYPE_ACCESS_DENIED;
342 break;
343 case SEC_ACE_TYPE_SYSTEM_ALARM_OBJECT:
344 tmp_ace->type = SEC_ACE_TYPE_SYSTEM_ALARM;
345 break;
346 case SEC_ACE_TYPE_SYSTEM_AUDIT_OBJECT:
347 tmp_ace->type = SEC_ACE_TYPE_SYSTEM_AUDIT;
348 break;
349 case SEC_ACE_TYPE_ACCESS_ALLOWED_CALLBACK_OBJECT:
350 tmp_ace->type = SEC_ACE_TYPE_ACCESS_ALLOWED_CALLBACK;
351 break;
352 case SEC_ACE_TYPE_ACCESS_DENIED_CALLBACK_OBJECT:
353 tmp_ace->type = SEC_ACE_TYPE_ACCESS_DENIED_CALLBACK;
354 break;
355 case SEC_ACE_TYPE_SYSTEM_AUDIT_CALLBACK_OBJECT:
356 tmp_ace->type = SEC_ACE_TYPE_SYSTEM_AUDIT_CALLBACK;
357 break;
358 default:
360 * SEC_ACE_TYPE_SYSTEM_ALARM_CALLBACK_OBJECT
361 * is reserved.
363 break;
367 if (expand_only) {
368 continue;
372 tmp_acl->aces = talloc_realloc(tmp_acl,
373 tmp_acl->aces,
374 struct security_ace,
375 tmp_acl->num_aces+1);
376 if (tmp_acl->aces == NULL) {
377 TALLOC_FREE(tmp_acl);
378 return NULL;
381 tmp_ace = &tmp_acl->aces[tmp_acl->num_aces];
382 tmp_acl->num_aces++;
384 *tmp_ace = *ace;
385 tmp_ace->flags |= SEC_ACE_FLAG_INHERITED_ACE;
387 if (inherited_only) {
388 tmp_ace->flags |= SEC_ACE_FLAG_INHERIT_ONLY;
389 } else {
390 tmp_ace->flags &= ~SEC_ACE_FLAG_INHERIT_ONLY;
393 if (ace->flags & SEC_ACE_FLAG_NO_PROPAGATE_INHERIT) {
394 tmp_ace->flags &= ~SEC_ACE_FLAG_CONTAINER_INHERIT;
395 tmp_ace->flags &= ~SEC_ACE_FLAG_OBJECT_INHERIT;
396 tmp_ace->flags &= ~SEC_ACE_FLAG_NO_PROPAGATE_INHERIT;
399 if (tmp_acl->num_aces == 0) {
400 TALLOC_FREE(tmp_acl);
401 return NULL;
403 if (acl) {
404 tmp_acl->revision = acl->revision;
406 return tmp_acl;
409 static struct security_acl *process_user_acl(TALLOC_CTX *mem_ctx,
410 struct security_acl *acl,
411 bool is_container,
412 const struct dom_sid *owner,
413 const struct dom_sid *group,
414 struct GUID *object_list,
415 bool is_protected)
417 uint32_t i;
418 TALLOC_CTX *tmp_ctx = talloc_new(mem_ctx);
419 struct security_acl *tmp_acl = talloc_zero(tmp_ctx, struct security_acl);
420 struct security_acl *new_acl;
422 if (!acl)
423 return NULL;
425 if (!tmp_acl)
426 return NULL;
428 tmp_acl->revision = acl->revision;
429 DBG_DEBUG("acl revision %d\n", acl->revision);
431 for (i=0; i < acl->num_aces; i++){
432 struct security_ace *ace = &acl->aces[i];
433 /* Remove ID flags from user-provided ACEs
434 * if we break inheritance, ignore them otherwise */
435 if (ace->flags & SEC_ACE_FLAG_INHERITED_ACE) {
436 if (is_protected) {
437 ace->flags &= ~SEC_ACE_FLAG_INHERITED_ACE;
438 } else {
439 continue;
443 if (ace->flags & SEC_ACE_FLAG_INHERIT_ONLY &&
444 !(ace->flags & SEC_ACE_FLAG_CONTAINER_INHERIT ||
445 ace->flags & SEC_ACE_FLAG_OBJECT_INHERIT))
446 continue;
448 tmp_acl->aces = talloc_realloc(tmp_acl,
449 tmp_acl->aces,
450 struct security_ace,
451 tmp_acl->num_aces+1);
452 tmp_acl->aces[tmp_acl->num_aces] = *ace;
453 tmp_acl->num_aces++;
454 if (ace->flags & SEC_ACE_FLAG_INHERIT_ONLY) {
455 continue;
457 /* if the ACE contains CO, CG, GA, GE, GR or GW, and is inheritable
458 * it has to be expanded to two aces, the original as IO,
459 * and another one where these are translated */
460 if (desc_ace_has_generic(ace)) {
461 if (!(ace->flags & SEC_ACE_FLAG_CONTAINER_INHERIT)) {
462 desc_expand_generic(&tmp_acl->aces[tmp_acl->num_aces-1],
463 owner,
464 group);
465 } else {
466 /*The original ACE becomes read only */
467 tmp_acl->aces[tmp_acl->num_aces-1].flags |= SEC_ACE_FLAG_INHERIT_ONLY;
468 tmp_acl->aces = talloc_realloc(tmp_acl, tmp_acl->aces,
469 struct security_ace,
470 tmp_acl->num_aces+1);
471 /* add a new ACE with expanded generic info */
472 tmp_acl->aces[tmp_acl->num_aces] = *ace;
473 desc_expand_generic(&tmp_acl->aces[tmp_acl->num_aces],
474 owner,
475 group);
476 tmp_acl->num_aces++;
480 new_acl = security_acl_dup(mem_ctx,tmp_acl);
482 if (new_acl)
483 new_acl->revision = acl->revision;
485 talloc_free(tmp_ctx);
486 return new_acl;
489 static void cr_descr_log_descriptor(struct security_descriptor *sd,
490 const char *message,
491 int level)
493 if (sd) {
494 DEBUG(level,("%s: %s\n", message,
495 ndr_print_struct_string(0,(ndr_print_fn_t)ndr_print_security_descriptor,
496 "", sd)));
498 else {
499 DEBUG(level,("%s: NULL\n", message));
503 #if 0
504 static void cr_descr_log_acl(struct security_acl *acl,
505 const char *message,
506 int level)
508 if (acl) {
509 DEBUG(level,("%s: %s\n", message,
510 ndr_print_struct_string(0,(ndr_print_fn_t)ndr_print_security_acl,
511 "", acl)));
513 else {
514 DEBUG(level,("%s: NULL\n", message));
517 #endif
519 static bool compute_acl(struct security_descriptor *parent_sd,
520 struct security_descriptor *creator_sd,
521 bool is_container,
522 uint32_t inherit_flags,
523 struct GUID *object_list,
524 uint32_t (*generic_map)(uint32_t access_mask),
525 struct security_token *token,
526 struct security_descriptor *new_sd) /* INOUT argument */
528 struct security_acl *user_dacl, *user_sacl, *inherited_dacl, *inherited_sacl;
529 int level = 10;
531 if (!parent_sd || !(inherit_flags & SEC_DACL_AUTO_INHERIT)) {
532 inherited_dacl = NULL;
533 } else if (creator_sd && (creator_sd->type & SEC_DESC_DACL_PROTECTED)) {
534 inherited_dacl = NULL;
535 } else {
536 inherited_dacl = calculate_inherited_from_parent(new_sd,
537 parent_sd->dacl,
538 is_container,
539 new_sd->owner_sid,
540 new_sd->group_sid,
541 object_list);
545 if (!parent_sd || !(inherit_flags & SEC_SACL_AUTO_INHERIT)) {
546 inherited_sacl = NULL;
547 } else if (creator_sd && (creator_sd->type & SEC_DESC_SACL_PROTECTED)) {
548 inherited_sacl = NULL;
549 } else {
550 inherited_sacl = calculate_inherited_from_parent(new_sd,
551 parent_sd->sacl,
552 is_container,
553 new_sd->owner_sid,
554 new_sd->group_sid,
555 object_list);
558 if (!creator_sd || (inherit_flags & SEC_DEFAULT_DESCRIPTOR)) {
559 user_dacl = NULL;
560 user_sacl = NULL;
561 } else {
562 user_dacl = process_user_acl(new_sd,
563 creator_sd->dacl,
564 is_container,
565 new_sd->owner_sid,
566 new_sd->group_sid,
567 object_list,
568 creator_sd->type & SEC_DESC_DACL_PROTECTED);
569 user_sacl = process_user_acl(new_sd,
570 creator_sd->sacl,
571 is_container,
572 new_sd->owner_sid,
573 new_sd->group_sid,
574 object_list,
575 creator_sd->type & SEC_DESC_SACL_PROTECTED);
577 cr_descr_log_descriptor(parent_sd, __location__"parent_sd", level);
578 cr_descr_log_descriptor(creator_sd,__location__ "creator_sd", level);
580 new_sd->dacl = security_acl_concatenate(new_sd, user_dacl, inherited_dacl);
581 if (new_sd->dacl) {
582 new_sd->type |= SEC_DESC_DACL_PRESENT;
584 if (inherited_dacl) {
585 new_sd->type |= SEC_DESC_DACL_AUTO_INHERITED;
588 new_sd->sacl = security_acl_concatenate(new_sd, user_sacl, inherited_sacl);
589 if (new_sd->sacl) {
590 new_sd->type |= SEC_DESC_SACL_PRESENT;
592 if (inherited_sacl) {
593 new_sd->type |= SEC_DESC_SACL_AUTO_INHERITED;
595 /* This is a hack to handle the fact that
596 * apprantly any AI flag provided by the user is preserved */
597 if (creator_sd)
598 new_sd->type |= creator_sd->type;
599 cr_descr_log_descriptor(new_sd, __location__"final sd", level);
600 return true;
603 struct security_descriptor *create_security_descriptor(
604 TALLOC_CTX *mem_ctx,
605 struct security_descriptor *parent_sd,
606 struct security_descriptor *creator_sd,
607 bool is_container,
608 struct GUID *object_list,
609 uint32_t inherit_flags,
610 struct security_token *token,
611 const struct dom_sid
612 *default_owner, /* valid only for DS, NULL for the other RSs */
613 const struct dom_sid
614 *default_group, /* valid only for DS, NULL for the other RSs */
615 uint32_t (*generic_map)(uint32_t access_mask))
617 struct security_descriptor *new_sd;
618 const struct dom_sid *new_owner = NULL;
619 const struct dom_sid *new_group = NULL;
621 new_sd = security_descriptor_initialise(mem_ctx);
622 if (!new_sd) {
623 return NULL;
626 if (!creator_sd || !creator_sd->owner_sid) {
627 if ((inherit_flags & SEC_OWNER_FROM_PARENT) && parent_sd) {
628 new_owner = parent_sd->owner_sid;
629 } else if (!default_owner) {
630 new_owner = &token->sids[PRIMARY_USER_SID_INDEX];
631 } else {
632 new_owner = default_owner;
633 new_sd->type |= SEC_DESC_OWNER_DEFAULTED;
635 } else {
636 new_owner = creator_sd->owner_sid;
639 if (!creator_sd || !creator_sd->group_sid){
640 if ((inherit_flags & SEC_GROUP_FROM_PARENT) && parent_sd) {
641 new_group = parent_sd->group_sid;
642 } else if (!default_group && token->num_sids > PRIMARY_GROUP_SID_INDEX) {
643 new_group = &token->sids[PRIMARY_GROUP_SID_INDEX];
644 } else if (!default_group) {
645 /* This will happen only for anonymous, which has no other groups */
646 new_group = &token->sids[PRIMARY_USER_SID_INDEX];
647 } else {
648 new_group = default_group;
649 new_sd->type |= SEC_DESC_GROUP_DEFAULTED;
651 } else {
652 new_group = creator_sd->group_sid;
655 new_sd->owner_sid = dom_sid_dup(new_sd, new_owner);
656 new_sd->group_sid = dom_sid_dup(new_sd, new_group);
657 if (!new_sd->owner_sid || !new_sd->group_sid){
658 talloc_free(new_sd);
659 return NULL;
662 if (!compute_acl(parent_sd, creator_sd,
663 is_container, inherit_flags, object_list,
664 generic_map,token,new_sd)){
665 talloc_free(new_sd);
666 return NULL;
669 return new_sd;