4cd898b5b4a3fa9e0cb86d3aa6f7af224f37e9fe
[wimlib] / src / security.c
1 /*
2  * security.c
3  *
4  * Read and write the per-WIM-image table of security descriptors.
5  */
6
7 /*
8  * Copyright (C) 2012, 2013 Eric Biggers
9  *
10  * This file is part of wimlib, a library for working with WIM files.
11  *
12  * wimlib is free software; you can redistribute it and/or modify it under the
13  * terms of the GNU General Public License as published by the Free
14  * Software Foundation; either version 3 of the License, or (at your option)
15  * any later version.
16  *
17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19  * A PARTICULAR PURPOSE. See the GNU General Public License for more
20  * details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
24  */
25
26 #ifdef HAVE_CONFIG_H
27 #  include "config.h"
28 #endif
29
30 #include "wimlib/assert.h"
31 #include "wimlib/buffer_io.h"
32 #include "wimlib/error.h"
33 #include "wimlib/security.h"
34 #include "wimlib/sha1.h"
35 #include "wimlib/util.h"
36
37 /* At the start of each type of access control entry.  */
38 typedef struct _ACE_HEADER {
39         /* enum ace_type, specifies what type of ACE this is.  */
40         u8 type;
41
42         /* bitwise OR of the inherit ACE flags #defined above */
43         u8 flags;
44
45         /* Size of the access control entry. */
46         le16 size;
47 } _packed_attribute ACE_HEADER;
48
49 /* Grants rights to a user or group */
50 typedef struct _ACCESS_ALLOWED_ACE {
51         ACE_HEADER hdr;
52         le32 mask;
53         le32 sid_start;
54 } _packed_attribute ACCESS_ALLOWED_ACE;
55
56 /* Denies rights to a user or group */
57 typedef struct _ACCESS_DENIED_ACE {
58         ACE_HEADER hdr;
59         le32 mask;
60         le32 sid_start;
61 } _packed_attribute ACCESS_DENIED_ACE;
62
63 typedef struct _SYSTEM_AUDIT_ACE {
64         ACE_HEADER hdr;
65         le32 mask;
66         le32 sid_start;
67 } _packed_attribute SYSTEM_AUDIT_ACE;
68
69
70 /* Header of an access control list. */
71 typedef struct _ACL {
72         /* ACL_REVISION or ACL_REVISION_DS */
73         u8 revision;
74
75         /* padding */
76         u8 sbz1;
77
78         /* Total size of the ACL, including all access control entries */
79         le16 acl_size;
80
81         /* Number of access control entry structures that follow the ACL
82          * structure. */
83         le16 ace_count;
84
85         /* padding */
86         le16 sbz2;
87 } _packed_attribute ACL;
88
89 /* A structure used to identify users or groups. */
90 typedef struct _SID {
91
92         /* example: 0x1 */
93         u8  revision;
94         u8  sub_authority_count;
95
96         /* Identifies the authority that issued the SID.  Can be, but does not
97          * have to be, one of enum sid_authority_value */
98         u8  identifier_authority[6];
99
100         le32 sub_authority[];
101 } _packed_attribute SID;
102
103 typedef struct _SECURITY_DESCRIPTOR_RELATIVE  {
104         /* Example: 0x1 */
105         u8 revision;
106         /* Example: 0x0 */
107         u8 sbz1;
108
109         /* Example: 0x4149 */
110         le16 security_descriptor_control;
111
112         /* Offset of a SID structure in the security descriptor. */
113         /* Example: 0x14 */
114         le32 owner_offset;
115
116         /* Offset of a SID structure in the security descriptor. */
117         /* Example: 0x24 */
118         le32 group_offset;
119
120         /* Offset of an ACL structure in the security descriptor. */
121         /* System ACL. */
122         /* Example: 0x00 */
123         le32 sacl_offset;
124
125         /* Offset of an ACL structure in the security descriptor. */
126         /* Discretionary ACL. */
127         /* Example: 0x34 */
128         le32 dacl_offset;
129 } _packed_attribute SECURITY_DESCRIPTOR_RELATIVE;
130
131 struct wim_security_data_disk {
132         le32 total_length;
133         le32 num_entries;
134         le64 sizes[];
135 } _packed_attribute;
136
137 /*
138  * This is a hack to work around a problem in libntfs-3g.  libntfs-3g validates
139  * security descriptors with a function named ntfs_valid_descr().
140  * ntfs_valid_descr() considers a security descriptor that ends in a SACL
141  * (Sysetm Access Control List) with no ACE's (Access Control Entries) to be
142  * invalid.  However, a security descriptor like this exists in the Windows 7
143  * install.wim.  Here, security descriptors matching this pattern are modified
144  * to have no SACL.  This should make no difference since the SACL had no
145  * entries anyway; however this ensures that that the security descriptors pass
146  * the validation in libntfs-3g.
147  */
148 static void
149 empty_sacl_fixup(SECURITY_DESCRIPTOR_RELATIVE *descr, size_t *size_p)
150 {
151         /* No-op if no NTFS-3g support, or if NTFS-3g is version 2013 or later
152          * */
153 #if defined(WITH_NTFS_3G) && !defined(HAVE_NTFS_MNT_RDONLY)
154         if (*size_p >= sizeof(SECURITY_DESCRIPTOR_RELATIVE)) {
155                 u32 sacl_offset = le32_to_cpu(descr->sacl_offset);
156                 if (sacl_offset == *size_p - sizeof(ACL)) {
157                         descr->sacl_offset = cpu_to_le32(0);
158                         *size_p -= sizeof(ACL);
159                 }
160         }
161 #endif
162 }
163
164 struct wim_security_data *
165 new_wim_security_data(void)
166 {
167         return CALLOC(1, sizeof(struct wim_security_data));
168 }
169
170 /*
171  * Reads the security data from the metadata resource of a WIM image.
172  *
173  * @metadata_resource:  An array that contains the uncompressed metadata
174  *                              resource for the WIM image.
175  * @metadata_resource_len:      The length of @metadata_resource.  It must be at
176  *                              least 8 bytes.
177  * @sd_ret:     A pointer to a pointer to a wim_security_data structure that
178  *              will be filled in with a pointer to a new wim_security_data
179  *              structure containing the security data on success.
180  *
181  * Note: There is no `offset' argument because the security data is located at
182  * the beginning of the metadata resource.
183  *
184  * Possible errors include:
185  *      WIMLIB_ERR_NOMEM
186  *      WIMLIB_ERR_INVALID_SECURITY_DATA
187  */
188 int
189 read_wim_security_data(const u8 metadata_resource[], size_t metadata_resource_len,
190                        struct wim_security_data **sd_ret)
191 {
192         struct wim_security_data *sd;
193         int ret;
194         u64 total_len;
195         u64 sizes_size;
196         u64 size_no_descriptors;
197         const struct wim_security_data_disk *sd_disk;
198         const u8 *p;
199
200         wimlib_assert(metadata_resource_len >= 8);
201
202         sd = new_wim_security_data();
203         if (!sd)
204                 goto out_of_memory;
205
206         sd_disk = (const struct wim_security_data_disk*)metadata_resource;
207         sd->total_length = le32_to_cpu(sd_disk->total_length);
208         sd->num_entries = le32_to_cpu(sd_disk->num_entries);
209
210         DEBUG("Reading security data: num_entries=%u, total_length=%u",
211               sd->num_entries, sd->total_length);
212
213         /* Length field of 0 is a special case that really means length
214          * of 8. */
215         if (sd->total_length == 0)
216                 sd->total_length = 8;
217
218         /* The security_id field of each dentry is a signed 32-bit integer, so
219          * the possible indices into the security descriptors table are 0
220          * through 0x7fffffff.  Which means 0x80000000 security descriptors
221          * maximum.  Not like you should ever have anywhere close to that many
222          * security descriptors! */
223         if (sd->num_entries > 0x80000000)
224                 goto out_invalid_sd;
225
226         /* Verify the listed total length of the security data is big enough to
227          * include the sizes array, verify that the file data is big enough to
228          * include it as well, then allocate the array of sizes.
229          *
230          * Note: The total length of the security data must fit in a 32-bit
231          * integer, even though each security descriptor size is a 64-bit
232          * integer.  This is stupid, and we need to be careful not to actually
233          * let the security descriptor sizes be over 0xffffffff.  */
234         if (sd->total_length > metadata_resource_len)
235                 goto out_invalid_sd;
236
237         sizes_size = (u64)sd->num_entries * sizeof(u64);
238         size_no_descriptors = 8 + sizes_size;
239         if (size_no_descriptors > sd->total_length)
240                 goto out_invalid_sd;
241
242         total_len = size_no_descriptors;
243
244         /* Return immediately if no security descriptors. */
245         if (sd->num_entries == 0)
246                 goto out_align_total_length;
247
248         /* Allocate a new buffer for the sizes array */
249         sd->sizes = MALLOC(sizes_size);
250         if (!sd->sizes)
251                 goto out_of_memory;
252
253         /* Copy the sizes array into the new buffer */
254         for (u32 i = 0; i < sd->num_entries; i++) {
255                 sd->sizes[i] = le64_to_cpu(sd_disk->sizes[i]);
256                 if (sd->sizes[i] > 0xffffffff)
257                         goto out_invalid_sd;
258         }
259
260         p = (const u8*)sd_disk + size_no_descriptors;
261
262         /* Allocate the array of pointers to the security descriptors, then read
263          * them into separate buffers. */
264         sd->descriptors = CALLOC(sd->num_entries, sizeof(sd->descriptors[0]));
265         if (!sd->descriptors)
266                 goto out_of_memory;
267
268         for (u32 i = 0; i < sd->num_entries; i++) {
269                 if (sd->sizes[i] == 0)
270                         continue;
271                 total_len += sd->sizes[i];
272                 if (total_len > (u64)sd->total_length)
273                         goto out_invalid_sd;
274                 sd->descriptors[i] = MALLOC(sd->sizes[i]);
275                 if (!sd->descriptors[i])
276                         goto out_of_memory;
277                 memcpy(sd->descriptors[i], p, sd->sizes[i]);
278                 p += sd->sizes[i];
279                 empty_sacl_fixup((SECURITY_DESCRIPTOR_RELATIVE*)sd->descriptors[i],
280                                  &sd->sizes[i]);
281         }
282 out_align_total_length:
283         total_len = (total_len + 7) & ~7;
284         sd->total_length = (sd->total_length + 7) & ~7;
285         if (total_len != sd->total_length) {
286                 WARNING("Expected WIM security data total length of "
287                         "%u bytes, but calculated %u bytes",
288                         sd->total_length, (unsigned)total_len);
289         }
290         *sd_ret = sd;
291         ret = 0;
292         goto out;
293 out_invalid_sd:
294         ERROR("WIM security data is invalid!");
295         ret = WIMLIB_ERR_INVALID_SECURITY_DATA;
296         goto out_free_sd;
297 out_of_memory:
298         ERROR("Out of memory while reading WIM security data!");
299         ret = WIMLIB_ERR_NOMEM;
300 out_free_sd:
301         free_wim_security_data(sd);
302 out:
303         return ret;
304 }
305
306 /*
307  * Writes the security data for a WIM image to an in-memory buffer.
308  */
309 u8 *
310 write_wim_security_data(const struct wim_security_data * restrict sd,
311                         u8 * restrict p)
312 {
313         DEBUG("Writing security data (total_length = %"PRIu32", num_entries "
314               "= %"PRIu32")", sd->total_length, sd->num_entries);
315
316         u8 *orig_p = p;
317         struct wim_security_data_disk *sd_disk = (struct wim_security_data_disk*)p;
318         u32 num_entries = sd->num_entries;
319
320         sd_disk->total_length = cpu_to_le32(sd->total_length);
321         sd_disk->num_entries = cpu_to_le32(num_entries);
322
323         for (u32 i = 0; i < num_entries; i++)
324                 sd_disk->sizes[i] = cpu_to_le64(sd->sizes[i]);
325
326         p = (u8*)&sd_disk->sizes[num_entries];
327
328         for (u32 i = 0; i < num_entries; i++)
329                 p = mempcpy(p, sd->descriptors[i], sd->sizes[i]);
330
331         while ((uintptr_t)p & 7)
332                 *p++ = 0;
333
334         wimlib_assert(p - orig_p == sd->total_length);
335
336         DEBUG("Successfully wrote security data.");
337         return p;
338 }
339
340 static void
341 print_acl(const ACL *acl, const tchar *type, size_t max_size)
342 {
343         const u8 *p;
344
345         if (max_size < sizeof(ACL))
346                 return;
347
348         u8 revision = acl->revision;
349         u16 acl_size = le16_to_cpu(acl->acl_size);
350         u16 ace_count = le16_to_cpu(acl->ace_count);
351
352         tprintf(T("    [%"TS" ACL]\n"), type);
353         tprintf(T("    Revision = %u\n"), revision);
354         tprintf(T("    ACL Size = %u\n"), acl_size);
355         tprintf(T("    ACE Count = %u\n"), ace_count);
356
357         p = (const u8*)acl + sizeof(ACL);
358         for (u16 i = 0; i < ace_count; i++) {
359                 if (max_size < p + sizeof(ACCESS_ALLOWED_ACE) - (const u8*)acl)
360                         break;
361                 const ACCESS_ALLOWED_ACE *aaa = (const ACCESS_ALLOWED_ACE*)p;
362                 tprintf(T("        [ACE]\n"));
363                 tprintf(T("        ACE type  = %d\n"), aaa->hdr.type);
364                 tprintf(T("        ACE flags = 0x%x\n"), aaa->hdr.flags);
365                 tprintf(T("        ACE size  = %u\n"), le16_to_cpu(aaa->hdr.size));
366                 tprintf(T("        ACE mask = %x\n"), le32_to_cpu(aaa->mask));
367                 tprintf(T("        SID start = %u\n"), le32_to_cpu(aaa->sid_start));
368                 p += le16_to_cpu(aaa->hdr.size);
369         }
370         tputchar(T('\n'));
371 }
372
373 static void
374 print_sid(const SID *sid, const tchar *type, size_t max_size)
375 {
376         if (max_size < sizeof(SID))
377                 return;
378
379         tprintf(T("    [%"TS" SID]\n"), type);
380         tprintf(T("    Revision = %u\n"), sid->revision);
381         tprintf(T("    Subauthority count = %u\n"), sid->sub_authority_count);
382         tprintf(T("    Identifier authority = "));
383         print_byte_field(sid->identifier_authority,
384                          sizeof(sid->identifier_authority), stdout);
385         tputchar(T('\n'));
386         if (max_size < sizeof(SID) + (size_t)sid->sub_authority_count * sizeof(u32))
387                 return;
388         for (u8 i = 0; i < sid->sub_authority_count; i++) {
389                 tprintf(T("    Subauthority %u = %u\n"),
390                         i, le32_to_cpu(sid->sub_authority[i]));
391         }
392         tputchar(T('\n'));
393 }
394
395 static void
396 print_security_descriptor(const SECURITY_DESCRIPTOR_RELATIVE *descr,
397                           size_t size)
398 {
399         u8 revision      = descr->revision;
400         u16 control      = le16_to_cpu(descr->security_descriptor_control);
401         u32 owner_offset = le32_to_cpu(descr->owner_offset);
402         u32 group_offset = le32_to_cpu(descr->group_offset);
403         u32 dacl_offset  = le32_to_cpu(descr->dacl_offset);
404         u32 sacl_offset  = le32_to_cpu(descr->sacl_offset);
405
406         tprintf(T("Revision = %u\n"), revision);
407         tprintf(T("Security Descriptor Control = %#x\n"), control);
408         tprintf(T("Owner offset = %u\n"), owner_offset);
409         tprintf(T("Group offset = %u\n"), group_offset);
410         tprintf(T("Discretionary ACL offset = %u\n"), dacl_offset);
411         tprintf(T("System ACL offset = %u\n"), sacl_offset);
412
413         if (owner_offset != 0 && owner_offset <= size)
414                 print_sid((const SID*)((const u8*)descr + owner_offset),
415                           T("Owner"), size - owner_offset);
416
417         if (group_offset != 0 && group_offset <= size)
418                 print_sid((const SID*)((const u8*)descr + group_offset),
419                           T("Group"), size - group_offset);
420
421         if (dacl_offset != 0 && dacl_offset <= size)
422                 print_acl((const ACL*)((const u8*)descr + dacl_offset),
423                           T("Discretionary"), size - dacl_offset);
424
425         if (sacl_offset != 0 && sacl_offset <= size)
426                 print_acl((const ACL*)((const u8*)descr + sacl_offset),
427                           T("System"), size - sacl_offset);
428 }
429
430 /*
431  * Prints the security data for a WIM file.
432  */
433 void
434 print_wim_security_data(const struct wim_security_data *sd)
435 {
436         tputs(T("[SECURITY DATA]"));
437         tprintf(T("Length            = %"PRIu32" bytes\n"), sd->total_length);
438         tprintf(T("Number of Entries = %"PRIu32"\n"), sd->num_entries);
439
440         for (u32 i = 0; i < sd->num_entries; i++) {
441                 tprintf(T("[SECURITY_DESCRIPTOR_RELATIVE %"PRIu32", length = %"PRIu64"]\n"),
442                         i, sd->sizes[i]);
443                 print_security_descriptor((const SECURITY_DESCRIPTOR_RELATIVE*)sd->descriptors[i],
444                                           sd->sizes[i]);
445                 tputchar(T('\n'));
446         }
447         tputchar(T('\n'));
448 }
449
450 void
451 free_wim_security_data(struct wim_security_data *sd)
452 {
453         if (sd) {
454                 u8 **descriptors = sd->descriptors;
455                 u32 num_entries  = sd->num_entries;
456                 if (descriptors)
457                         while (num_entries--)
458                                 FREE(*descriptors++);
459                 FREE(sd->sizes);
460                 FREE(sd->descriptors);
461                 FREE(sd);
462         }
463 }
464
465 struct sd_node {
466         int security_id;
467         u8 hash[SHA1_HASH_SIZE];
468         struct rb_node rb_node;
469 };
470
471 static void
472 free_sd_tree(struct rb_node *node)
473 {
474         if (node) {
475                 free_sd_tree(node->rb_left);
476                 free_sd_tree(node->rb_right);
477                 FREE(container_of(node, struct sd_node, rb_node));
478         }
479 }
480
481 /* Frees a security descriptor index set. */
482 void
483 destroy_sd_set(struct wim_sd_set *sd_set, bool rollback)
484 {
485         if (rollback) {
486                 struct wim_security_data *sd = sd_set->sd;
487                 u8 **descriptors = sd->descriptors + sd_set->orig_num_entries;
488                 u32 num_entries  = sd->num_entries - sd_set->orig_num_entries;
489                 while (num_entries--)
490                         FREE(*descriptors++);
491                 sd->num_entries = sd_set->orig_num_entries;
492         }
493         free_sd_tree(sd_set->rb_root.rb_node);
494 }
495
496 /* Inserts a a new node into the security descriptor index tree. */
497 static bool
498 insert_sd_node(struct wim_sd_set *set, struct sd_node *new)
499 {
500         struct rb_root *root = &set->rb_root;
501         struct rb_node **p = &(root->rb_node);
502         struct rb_node *rb_parent = NULL;
503
504         while (*p) {
505                 struct sd_node *this = container_of(*p, struct sd_node, rb_node);
506                 int cmp = hashes_cmp(new->hash, this->hash);
507
508                 rb_parent = *p;
509                 if (cmp < 0)
510                         p = &((*p)->rb_left);
511                 else if (cmp > 0)
512                         p = &((*p)->rb_right);
513                 else
514                         return false; /* Duplicate security descriptor */
515         }
516         rb_link_node(&new->rb_node, rb_parent, p);
517         rb_insert_color(&new->rb_node, root);
518         return true;
519 }
520
521 /* Returns the index of the security descriptor having a SHA1 message digest of
522  * @hash.  If not found, return -1. */
523 int
524 lookup_sd(struct wim_sd_set *set, const u8 hash[SHA1_HASH_SIZE])
525 {
526         struct rb_node *node = set->rb_root.rb_node;
527
528         while (node) {
529                 struct sd_node *sd_node = container_of(node, struct sd_node, rb_node);
530                 int cmp = hashes_cmp(hash, sd_node->hash);
531                 if (cmp < 0)
532                         node = node->rb_left;
533                 else if (cmp > 0)
534                         node = node->rb_right;
535                 else
536                         return sd_node->security_id;
537         }
538         return -1;
539 }
540
541 /*
542  * Adds a security descriptor to the indexed security descriptor set as well as
543  * the corresponding `struct wim_security_data', and returns the new security
544  * ID; or, if there is an existing security descriptor that is the same, return
545  * the security ID for it.  If a new security descriptor cannot be allocated,
546  * return -1.
547  */
548 int
549 sd_set_add_sd(struct wim_sd_set *sd_set, const char *descriptor, size_t size)
550 {
551         u8 hash[SHA1_HASH_SIZE];
552         int security_id;
553         struct sd_node *new;
554         u8 **descriptors;
555         u64 *sizes;
556         u8 *descr_copy;
557         struct wim_security_data *sd;
558         bool bret;
559
560         sha1_buffer(descriptor, size, hash);
561
562         security_id = lookup_sd(sd_set, hash);
563         if (security_id >= 0) /* Identical descriptor already exists */
564                 goto out;
565
566         /* Need to add a new security descriptor */
567         security_id = -1;
568
569         new = MALLOC(sizeof(*new));
570         if (!new)
571                 goto out;
572         descr_copy = MALLOC(size);
573         if (!descr_copy)
574                 goto out_free_node;
575
576         sd = sd_set->sd;
577
578         memcpy(descr_copy, descriptor, size);
579         new->security_id = sd->num_entries;
580         copy_hash(new->hash, hash);
581
582         /* There typically are only a few dozen security descriptors in a
583          * directory tree, so expanding the array of security descriptors by
584          * only 1 extra space each time should not be a problem. */
585         descriptors = REALLOC(sd->descriptors,
586                               (sd->num_entries + 1) * sizeof(sd->descriptors[0]));
587         if (!descriptors)
588                 goto out_free_descr;
589         sd->descriptors = descriptors;
590         sizes = REALLOC(sd->sizes,
591                         (sd->num_entries + 1) * sizeof(sd->sizes[0]));
592         if (!sizes)
593                 goto out_free_descr;
594         sd->sizes = sizes;
595         sd->descriptors[sd->num_entries] = descr_copy;
596         sd->sizes[sd->num_entries] = size;
597         sd->num_entries++;
598         DEBUG("There are now %u security descriptors", sd->num_entries);
599         bret = insert_sd_node(sd_set, new);
600         wimlib_assert(bret);
601         security_id = new->security_id;
602         goto out;
603 out_free_descr:
604         FREE(descr_copy);
605 out_free_node:
606         FREE(new);
607 out:
608         return security_id;
609 }
610
611 /* Initialize a `struct sd_set' mapping from SHA1 message digests of security
612  * descriptors to indices into the security descriptors table of the WIM image
613  * (security IDs).  */
614 int
615 init_sd_set(struct wim_sd_set *sd_set, struct wim_security_data *sd)
616 {
617         int ret;
618
619         sd_set->sd = sd;
620         sd_set->rb_root.rb_node = NULL;
621
622         /* Remember the original number of security descriptors so that newly
623          * added ones can be rolled back if needed. */
624         sd_set->orig_num_entries = sd->num_entries;
625         for (u32 i = 0; i < sd->num_entries; i++) {
626                 struct sd_node *new;
627
628                 new = MALLOC(sizeof(struct sd_node));
629                 if (!new) {
630                         ret = WIMLIB_ERR_NOMEM;
631                         goto out_destroy_sd_set;
632                 }
633                 sha1_buffer(sd->descriptors[i], sd->sizes[i], new->hash);
634                 new->security_id = i;
635                 if (!insert_sd_node(sd_set, new))
636                         FREE(new); /* Ignore duplicate security descriptor */
637         }
638         ret = 0;
639         goto out;
640 out_destroy_sd_set:
641         destroy_sd_set(sd_set, false);
642 out:
643         return ret;
644 }