s3:smbd: add basic support for durable handle v2 request and reconnect
[Samba/gebeck_regimport.git] / libcli / security / security_descriptor.c
blob574dd4e317b1aa322ed294463c157bd26708f08d
1 /*
2 Unix SMB/CIFS implementation.
4 security descriptror utility functions
6 Copyright (C) Andrew Tridgell 2004
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 3 of the License, or
11 (at your option) any later version.
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.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "includes.h"
23 #include "libcli/security/security.h"
26 return a blank security descriptor (no owners, dacl or sacl)
28 struct security_descriptor *security_descriptor_initialise(TALLOC_CTX *mem_ctx)
30 struct security_descriptor *sd;
32 sd = talloc(mem_ctx, struct security_descriptor);
33 if (!sd) {
34 return NULL;
37 sd->revision = SD_REVISION;
38 /* we mark as self relative, even though it isn't while it remains
39 a pointer in memory because this simplifies the ndr code later.
40 All SDs that we store/emit are in fact SELF_RELATIVE
42 sd->type = SEC_DESC_SELF_RELATIVE;
44 sd->owner_sid = NULL;
45 sd->group_sid = NULL;
46 sd->sacl = NULL;
47 sd->dacl = NULL;
49 return sd;
52 struct security_acl *security_acl_dup(TALLOC_CTX *mem_ctx,
53 const struct security_acl *oacl)
55 struct security_acl *nacl;
57 if (oacl == NULL) {
58 return NULL;
61 nacl = talloc (mem_ctx, struct security_acl);
62 if (nacl == NULL) {
63 return NULL;
66 nacl->aces = (struct security_ace *)talloc_memdup (nacl, oacl->aces, sizeof(struct security_ace) * oacl->num_aces);
67 if ((nacl->aces == NULL) && (oacl->num_aces > 0)) {
68 goto failed;
71 nacl->revision = oacl->revision;
72 nacl->size = oacl->size;
73 nacl->num_aces = oacl->num_aces;
75 return nacl;
77 failed:
78 talloc_free (nacl);
79 return NULL;
83 struct security_acl *security_acl_concatenate(TALLOC_CTX *mem_ctx,
84 const struct security_acl *acl1,
85 const struct security_acl *acl2)
87 struct security_acl *nacl;
88 uint32_t i;
90 if (!acl1 && !acl2)
91 return NULL;
93 if (!acl1){
94 nacl = security_acl_dup(mem_ctx, acl2);
95 return nacl;
98 if (!acl2){
99 nacl = security_acl_dup(mem_ctx, acl1);
100 return nacl;
103 nacl = talloc (mem_ctx, struct security_acl);
104 if (nacl == NULL) {
105 return NULL;
108 nacl->revision = acl1->revision;
109 nacl->size = acl1->size + acl2->size;
110 nacl->num_aces = acl1->num_aces + acl2->num_aces;
112 if (nacl->num_aces == 0)
113 return nacl;
115 nacl->aces = (struct security_ace *)talloc_array (mem_ctx, struct security_ace, acl1->num_aces+acl2->num_aces);
116 if ((nacl->aces == NULL) && (nacl->num_aces > 0)) {
117 goto failed;
120 for (i = 0; i < acl1->num_aces; i++)
121 nacl->aces[i] = acl1->aces[i];
122 for (i = 0; i < acl2->num_aces; i++)
123 nacl->aces[i + acl1->num_aces] = acl2->aces[i];
125 return nacl;
127 failed:
128 talloc_free (nacl);
129 return NULL;
134 talloc and copy a security descriptor
136 struct security_descriptor *security_descriptor_copy(TALLOC_CTX *mem_ctx,
137 const struct security_descriptor *osd)
139 struct security_descriptor *nsd;
141 nsd = talloc_zero(mem_ctx, struct security_descriptor);
142 if (!nsd) {
143 return NULL;
146 if (osd->owner_sid) {
147 nsd->owner_sid = dom_sid_dup(nsd, osd->owner_sid);
148 if (nsd->owner_sid == NULL) {
149 goto failed;
153 if (osd->group_sid) {
154 nsd->group_sid = dom_sid_dup(nsd, osd->group_sid);
155 if (nsd->group_sid == NULL) {
156 goto failed;
160 if (osd->sacl) {
161 nsd->sacl = security_acl_dup(nsd, osd->sacl);
162 if (nsd->sacl == NULL) {
163 goto failed;
167 if (osd->dacl) {
168 nsd->dacl = security_acl_dup(nsd, osd->dacl);
169 if (nsd->dacl == NULL) {
170 goto failed;
174 nsd->revision = osd->revision;
175 nsd->type = osd->type;
177 return nsd;
179 failed:
180 talloc_free(nsd);
182 return NULL;
186 add an ACE to an ACL of a security_descriptor
189 static NTSTATUS security_descriptor_acl_add(struct security_descriptor *sd,
190 bool add_to_sacl,
191 const struct security_ace *ace)
193 struct security_acl *acl = NULL;
195 if (add_to_sacl) {
196 acl = sd->sacl;
197 } else {
198 acl = sd->dacl;
201 if (acl == NULL) {
202 acl = talloc(sd, struct security_acl);
203 if (acl == NULL) {
204 return NT_STATUS_NO_MEMORY;
206 acl->revision = SECURITY_ACL_REVISION_NT4;
207 acl->size = 0;
208 acl->num_aces = 0;
209 acl->aces = NULL;
212 acl->aces = talloc_realloc(acl, acl->aces,
213 struct security_ace, acl->num_aces+1);
214 if (acl->aces == NULL) {
215 return NT_STATUS_NO_MEMORY;
218 acl->aces[acl->num_aces] = *ace;
220 switch (acl->aces[acl->num_aces].type) {
221 case SEC_ACE_TYPE_ACCESS_ALLOWED_OBJECT:
222 case SEC_ACE_TYPE_ACCESS_DENIED_OBJECT:
223 case SEC_ACE_TYPE_SYSTEM_AUDIT_OBJECT:
224 case SEC_ACE_TYPE_SYSTEM_ALARM_OBJECT:
225 acl->revision = SECURITY_ACL_REVISION_ADS;
226 break;
227 default:
228 break;
231 acl->num_aces++;
233 if (add_to_sacl) {
234 sd->sacl = acl;
235 sd->type |= SEC_DESC_SACL_PRESENT;
236 } else {
237 sd->dacl = acl;
238 sd->type |= SEC_DESC_DACL_PRESENT;
241 return NT_STATUS_OK;
245 add an ACE to the SACL of a security_descriptor
248 NTSTATUS security_descriptor_sacl_add(struct security_descriptor *sd,
249 const struct security_ace *ace)
251 return security_descriptor_acl_add(sd, true, ace);
255 add an ACE to the DACL of a security_descriptor
258 NTSTATUS security_descriptor_dacl_add(struct security_descriptor *sd,
259 const struct security_ace *ace)
261 return security_descriptor_acl_add(sd, false, ace);
265 delete the ACE corresponding to the given trustee in an ACL of a
266 security_descriptor
269 static NTSTATUS security_descriptor_acl_del(struct security_descriptor *sd,
270 bool sacl_del,
271 const struct dom_sid *trustee)
273 uint32_t i;
274 bool found = false;
275 struct security_acl *acl = NULL;
277 if (sacl_del) {
278 acl = sd->sacl;
279 } else {
280 acl = sd->dacl;
283 if (acl == NULL) {
284 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
287 /* there can be multiple ace's for one trustee */
288 for (i=0;i<acl->num_aces;i++) {
289 if (dom_sid_equal(trustee, &acl->aces[i].trustee)) {
290 memmove(&acl->aces[i], &acl->aces[i+1],
291 sizeof(acl->aces[i]) * (acl->num_aces - (i+1)));
292 acl->num_aces--;
293 if (acl->num_aces == 0) {
294 acl->aces = NULL;
296 found = true;
300 if (!found) {
301 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
304 acl->revision = SECURITY_ACL_REVISION_NT4;
306 for (i=0;i<acl->num_aces;i++) {
307 switch (acl->aces[i].type) {
308 case SEC_ACE_TYPE_ACCESS_ALLOWED_OBJECT:
309 case SEC_ACE_TYPE_ACCESS_DENIED_OBJECT:
310 case SEC_ACE_TYPE_SYSTEM_AUDIT_OBJECT:
311 case SEC_ACE_TYPE_SYSTEM_ALARM_OBJECT:
312 acl->revision = SECURITY_ACL_REVISION_ADS;
313 return NT_STATUS_OK;
314 default:
315 break; /* only for the switch statement */
319 return NT_STATUS_OK;
323 delete the ACE corresponding to the given trustee in the DACL of a
324 security_descriptor
327 NTSTATUS security_descriptor_dacl_del(struct security_descriptor *sd,
328 const struct dom_sid *trustee)
330 return security_descriptor_acl_del(sd, false, trustee);
334 delete the ACE corresponding to the given trustee in the SACL of a
335 security_descriptor
338 NTSTATUS security_descriptor_sacl_del(struct security_descriptor *sd,
339 const struct dom_sid *trustee)
341 return security_descriptor_acl_del(sd, true, trustee);
345 compare two security ace structures
347 bool security_ace_equal(const struct security_ace *ace1,
348 const struct security_ace *ace2)
350 if (ace1 == ace2) return true;
351 if (!ace1 || !ace2) return false;
352 if (ace1->type != ace2->type) return false;
353 if (ace1->flags != ace2->flags) return false;
354 if (ace1->access_mask != ace2->access_mask) return false;
355 if (!dom_sid_equal(&ace1->trustee, &ace2->trustee)) return false;
357 return true;
362 compare two security acl structures
364 bool security_acl_equal(const struct security_acl *acl1,
365 const struct security_acl *acl2)
367 uint32_t i;
369 if (acl1 == acl2) return true;
370 if (!acl1 || !acl2) return false;
371 if (acl1->revision != acl2->revision) return false;
372 if (acl1->num_aces != acl2->num_aces) return false;
374 for (i=0;i<acl1->num_aces;i++) {
375 if (!security_ace_equal(&acl1->aces[i], &acl2->aces[i])) return false;
377 return true;
381 compare two security descriptors.
383 bool security_descriptor_equal(const struct security_descriptor *sd1,
384 const struct security_descriptor *sd2)
386 if (sd1 == sd2) return true;
387 if (!sd1 || !sd2) return false;
388 if (sd1->revision != sd2->revision) return false;
389 if (sd1->type != sd2->type) return false;
391 if (!dom_sid_equal(sd1->owner_sid, sd2->owner_sid)) return false;
392 if (!dom_sid_equal(sd1->group_sid, sd2->group_sid)) return false;
393 if (!security_acl_equal(sd1->sacl, sd2->sacl)) return false;
394 if (!security_acl_equal(sd1->dacl, sd2->dacl)) return false;
396 return true;
400 compare two security descriptors, but allow certain (missing) parts
401 to be masked out of the comparison
403 bool security_descriptor_mask_equal(const struct security_descriptor *sd1,
404 const struct security_descriptor *sd2,
405 uint32_t mask)
407 if (sd1 == sd2) return true;
408 if (!sd1 || !sd2) return false;
409 if (sd1->revision != sd2->revision) return false;
410 if ((sd1->type & mask) != (sd2->type & mask)) return false;
412 if (!dom_sid_equal(sd1->owner_sid, sd2->owner_sid)) return false;
413 if (!dom_sid_equal(sd1->group_sid, sd2->group_sid)) return false;
414 if ((mask & SEC_DESC_DACL_PRESENT) && !security_acl_equal(sd1->dacl, sd2->dacl)) return false;
415 if ((mask & SEC_DESC_SACL_PRESENT) && !security_acl_equal(sd1->sacl, sd2->sacl)) return false;
417 return true;
421 static struct security_descriptor *security_descriptor_appendv(struct security_descriptor *sd,
422 bool add_ace_to_sacl,
423 va_list ap)
425 const char *sidstr;
427 while ((sidstr = va_arg(ap, const char *))) {
428 struct dom_sid *sid;
429 struct security_ace *ace = talloc_zero(sd, struct security_ace);
430 NTSTATUS status;
432 if (ace == NULL) {
433 talloc_free(sd);
434 return NULL;
436 ace->type = va_arg(ap, unsigned int);
437 ace->access_mask = va_arg(ap, unsigned int);
438 ace->flags = va_arg(ap, unsigned int);
439 sid = dom_sid_parse_talloc(ace, sidstr);
440 if (sid == NULL) {
441 talloc_free(sd);
442 return NULL;
444 ace->trustee = *sid;
445 if (add_ace_to_sacl) {
446 status = security_descriptor_sacl_add(sd, ace);
447 } else {
448 status = security_descriptor_dacl_add(sd, ace);
450 /* TODO: check: would talloc_free(ace) here be correct? */
451 if (!NT_STATUS_IS_OK(status)) {
452 talloc_free(sd);
453 return NULL;
457 return sd;
460 struct security_descriptor *security_descriptor_append(struct security_descriptor *sd,
461 ...)
463 va_list ap;
465 va_start(ap, sd);
466 sd = security_descriptor_appendv(sd, false, ap);
467 va_end(ap);
469 return sd;
472 static struct security_descriptor *security_descriptor_createv(TALLOC_CTX *mem_ctx,
473 uint16_t sd_type,
474 const char *owner_sid,
475 const char *group_sid,
476 bool add_ace_to_sacl,
477 va_list ap)
479 struct security_descriptor *sd;
481 sd = security_descriptor_initialise(mem_ctx);
482 if (sd == NULL) {
483 return NULL;
486 sd->type |= sd_type;
488 if (owner_sid) {
489 sd->owner_sid = dom_sid_parse_talloc(sd, owner_sid);
490 if (sd->owner_sid == NULL) {
491 talloc_free(sd);
492 return NULL;
495 if (group_sid) {
496 sd->group_sid = dom_sid_parse_talloc(sd, group_sid);
497 if (sd->group_sid == NULL) {
498 talloc_free(sd);
499 return NULL;
503 return security_descriptor_appendv(sd, add_ace_to_sacl, ap);
507 create a security descriptor using string SIDs. This is used by the
508 torture code to allow the easy creation of complex ACLs
509 This is a varargs function. The list of DACL ACEs ends with a NULL sid.
511 Each ACE contains a set of 4 parameters:
512 SID, ACCESS_TYPE, MASK, FLAGS
514 a typical call would be:
516 sd = security_descriptor_dacl_create(mem_ctx,
517 sd_type_flags,
518 mysid,
519 mygroup,
520 SID_NT_AUTHENTICATED_USERS,
521 SEC_ACE_TYPE_ACCESS_ALLOWED,
522 SEC_FILE_ALL,
523 SEC_ACE_FLAG_OBJECT_INHERIT,
524 NULL);
525 that would create a sd with one DACL ACE
528 struct security_descriptor *security_descriptor_dacl_create(TALLOC_CTX *mem_ctx,
529 uint16_t sd_type,
530 const char *owner_sid,
531 const char *group_sid,
532 ...)
534 struct security_descriptor *sd = NULL;
535 va_list ap;
536 va_start(ap, group_sid);
537 sd = security_descriptor_createv(mem_ctx, sd_type, owner_sid,
538 group_sid, false, ap);
539 va_end(ap);
541 return sd;
544 struct security_descriptor *security_descriptor_sacl_create(TALLOC_CTX *mem_ctx,
545 uint16_t sd_type,
546 const char *owner_sid,
547 const char *group_sid,
548 ...)
550 struct security_descriptor *sd = NULL;
551 va_list ap;
552 va_start(ap, group_sid);
553 sd = security_descriptor_createv(mem_ctx, sd_type, owner_sid,
554 group_sid, true, ap);
555 va_end(ap);
557 return sd;
560 struct security_ace *security_ace_create(TALLOC_CTX *mem_ctx,
561 const char *sid_str,
562 enum security_ace_type type,
563 uint32_t access_mask,
564 uint8_t flags)
567 struct dom_sid *sid;
568 struct security_ace *ace;
570 ace = talloc_zero(mem_ctx, struct security_ace);
571 if (ace == NULL) {
572 return NULL;
575 sid = dom_sid_parse_talloc(ace, sid_str);
576 if (sid == NULL) {
577 talloc_free(ace);
578 return NULL;
581 ace->trustee = *sid;
582 ace->type = type;
583 ace->access_mask = access_mask;
584 ace->flags = flags;
586 return ace;