]> wimlib.net Git - wimlib/blobdiff - src/security.c
Update char encoding docs
[wimlib] / src / security.c
index dd9d1d82b9df56a1763799c9fdae2731c9a42064..7efc542b1e1de80a58dde1b8cf688cc170798782 100644 (file)
@@ -5,7 +5,7 @@
  */
 
 /*
- * Copyright (C) 2012 Eric Biggers
+ * Copyright (C) 2012, 2013 Eric Biggers
  *
  * This file is part of wimlib, a library for working with WIM files.
  *
 #include "buffer_io.h"
 #include "security.h"
 
+/* At the start of each type of access control entry.  */
+typedef struct {
+       /* enum ace_type, specifies what type of ACE this is.  */
+       u8 type;
+
+       /* bitwise OR of the inherit ACE flags #defined above */
+       u8 flags;
+
+       /* Size of the access control entry. */
+       u8 size;
+} ACEHeader;
+
+/* Grants rights to a user or group */
+typedef struct {
+       ACEHeader hdr;
+       u32 mask;
+       u32 sid_start;
+} AccessAllowedACE;
+
+/* Denies rights to a user or group */
+typedef struct {
+       ACEHeader hdr;
+       u32 mask;
+       u32 sid_start;
+} AccessDeniedACE;
+
+typedef struct {
+       ACEHeader hdr;
+       u32 mask;
+       u32 sid_start;
+} SystemAuditACE;
+
+
+/* Header of an access control list. */
+typedef struct {
+       /* ACL_REVISION or ACL_REVISION_DS */
+       u8 revision;
+
+       /* padding */
+       u8 sbz1;
+
+       /* Total size of the ACL, including all access control entries */
+       u16 acl_size;
+
+       /* Number of access control entry structures that follow the ACL
+        * structure. */
+       u16 ace_count;
+
+       /* padding */
+       u16 sbz2;
+} ACL;
+
+/* A structure used to identify users or groups. */
+typedef struct {
+
+       /* example: 0x1 */
+       u8  revision;
+       u8  sub_authority_count;
+
+       /* Identifies the authority that issued the SID.  Can be, but does not
+        * have to be, one of enum sid_authority_value */
+       u8  identifier_authority[6];
+
+       u32 sub_authority[0];
+} SID;
+
+
+typedef struct {
+       /* Example: 0x1 */
+       u8 revision;
+       /* Example: 0x0 */
+       u8 sbz1;
+       /* Example: 0x4149 */
+       u16 security_descriptor_control;
+
+       /* Offset of a SID structure in the security descriptor. */
+       /* Example: 0x14 */
+       u32 owner_offset;
+
+       /* Offset of a SID structure in the security descriptor. */
+       /* Example: 0x24 */
+       u32 group_offset;
+
+       /* Offset of an ACL structure in the security descriptor. */
+       /* System ACL. */
+       /* Example: 0x00 */
+       u32 sacl_offset;
+
+       /* Offset of an ACL structure in the security descriptor. */
+       /* Discretionary ACL. */
+       /* Example: 0x34 */
+       u32 dacl_offset;
+} SecurityDescriptor;
+
 /*
  * This is a hack to work around a problem in libntfs-3g.  libntfs-3g validates
  * security descriptors with a function named ntfs_valid_descr().
  * entries anyway; however this ensures that that the security descriptors pass
  * the validation in libntfs-3g.
  */
-static void empty_sacl_fixup(u8 *descr, u64 *size_p)
+static void
+empty_sacl_fixup(u8 *descr, u64 *size_p)
 {
+       /* No-op if no NTFS-3g support, or if NTFS-3g is version 2013 or later
+        * */
+#if defined(WITH_NTFS_3G) && !defined(HAVE_NTFS_MNT_RDONLY)
        if (*size_p >= sizeof(SecurityDescriptor)) {
                SecurityDescriptor *sd = (SecurityDescriptor*)descr;
                u32 sacl_offset = le32_to_cpu(sd->sacl_offset);
@@ -48,6 +146,7 @@ static void empty_sacl_fixup(u8 *descr, u64 *size_p)
                        *size_p -= sizeof(ACL);
                }
        }
+#endif
 }
 
 /*
@@ -64,8 +163,9 @@ static void empty_sacl_fixup(u8 *descr, u64 *size_p)
  * Note: There is no `offset' argument because the security data is located at
  * the beginning of the metadata resource.
  */
-int read_security_data(const u8 metadata_resource[], u64 metadata_resource_len,
-                      struct wim_security_data **sd_p)
+int
+read_security_data(const u8 metadata_resource[], u64 metadata_resource_len,
+                  struct wim_security_data **sd_p)
 {
        struct wim_security_data *sd;
        const u8 *p;
@@ -214,7 +314,8 @@ out_free_sd:
 /*
  * Writes security data to an in-memory buffer.
  */
-u8 *write_security_data(const struct wim_security_data *sd, u8 *p)
+u8 *
+write_security_data(const struct wim_security_data *sd, u8 *p)
 {
        DEBUG("Writing security data (total_length = %"PRIu32", num_entries "
              "= %"PRIu32")", sd->total_length, sd->num_entries);
@@ -238,95 +339,102 @@ u8 *write_security_data(const struct wim_security_data *sd, u8 *p)
        return p;
 }
 
-static void print_acl(const u8 *p, const char *type)
+static void
+print_acl(const void *p, const tchar *type)
 {
-       const ACL *acl = (const ACL*)p;
+       const ACL *acl = p;
        u8 revision = acl->revision;
        u16 acl_size = le16_to_cpu(acl->acl_size);
        u16 ace_count = le16_to_cpu(acl->ace_count);
-       printf("    [%s ACL]\n", type);
-       printf("    Revision = %u\n", revision);
-       printf("    ACL Size = %u\n", acl_size);
-       printf("    ACE Count = %u\n", ace_count);
+       tprintf(T("    [%"TS" ACL]\n"), type);
+       tprintf(T("    Revision = %u\n"), revision);
+       tprintf(T("    ACL Size = %u\n"), acl_size);
+       tprintf(T("    ACE Count = %u\n"), ace_count);
 
        p += sizeof(ACL);
        for (u16 i = 0; i < ace_count; i++) {
-               const ACEHeader *hdr = (const ACEHeader*)p;
-               printf("        [ACE]\n");
-               printf("        ACE type  = %d\n", hdr->type);
-               printf("        ACE flags = 0x%x\n", hdr->flags);
-               printf("        ACE size  = %u\n", hdr->size);
+               const ACEHeader *hdr = p;
+               tprintf(T("        [ACE]\n"));
+               tprintf(T("        ACE type  = %d\n"), hdr->type);
+               tprintf(T("        ACE flags = 0x%x\n"), hdr->flags);
+               tprintf(T("        ACE size  = %u\n"), hdr->size);
                const AccessAllowedACE *aaa = (const AccessAllowedACE*)hdr;
-               printf("        ACE mask = %x\n", le32_to_cpu(aaa->mask));
-               printf("        SID start = %u\n", le32_to_cpu(aaa->sid_start));
+               tprintf(T("        ACE mask = %x\n"), le32_to_cpu(aaa->mask));
+               tprintf(T("        SID start = %u\n"), le32_to_cpu(aaa->sid_start));
                p += hdr->size;
        }
-       putchar('\n');
+       tputchar(T('\n'));
 }
 
-static void print_sid(const u8 *p, const char *type)
+static void
+print_sid(const void *p, const tchar *type)
 {
-       const SID *sid = (const SID*)p;
-       printf("    [%s SID]\n", type);
-       printf("    Revision = %u\n", sid->revision);
-       printf("    Subauthority count = %u\n", sid->sub_authority_count);
-       printf("    Identifier authority = ");
+       const SID *sid = p;
+       tprintf(T("    [%"TS" SID]\n"), type);
+       tprintf(T("    Revision = %u\n"), sid->revision);
+       tprintf(T("    Subauthority count = %u\n"), sid->sub_authority_count);
+       tprintf(T("    Identifier authority = "));
        print_byte_field(sid->identifier_authority,
                         sizeof(sid->identifier_authority));
-       putchar('\n');
-       for (u8 i = 0; i < sid->sub_authority_count; i++)
-               printf("    Subauthority %u = %u\n",
-                      i, le32_to_cpu(sid->sub_authority[i]));
-       putchar('\n');
+       tputchar(T('\n'));
+       for (u8 i = 0; i < sid->sub_authority_count; i++) {
+               tprintf(T("    Subauthority %u = %u\n"),
+                       i, le32_to_cpu(sid->sub_authority[i]));
+       }
+       tputchar(T('\n'));
 }
 
-static void print_security_descriptor(const u8 *p, u64 size)
+static void
+print_security_descriptor(const void *p, u64 size)
 {
-       const SecurityDescriptor *sd = (const SecurityDescriptor*)p;
+       const SecurityDescriptor *sd = p;
+
        u8 revision      = sd->revision;
        u16 control      = le16_to_cpu(sd->security_descriptor_control);
        u32 owner_offset = le32_to_cpu(sd->owner_offset);
        u32 group_offset = le32_to_cpu(sd->group_offset);
        u32 sacl_offset  = le32_to_cpu(sd->sacl_offset);
        u32 dacl_offset  = le32_to_cpu(sd->dacl_offset);
-       printf("Revision = %u\n", revision);
-       printf("Security Descriptor Control = %#x\n", control);
-       printf("Owner offset = %u\n", owner_offset);
-       printf("Group offset = %u\n", group_offset);
-       printf("System ACL offset = %u\n", sacl_offset);
-       printf("Discretionary ACL offset = %u\n", dacl_offset);
+       tprintf(T("Revision = %u\n"), revision);
+       tprintf(T("Security Descriptor Control = %#x\n"), control);
+       tprintf(T("Owner offset = %u\n"), owner_offset);
+       tprintf(T("Group offset = %u\n"), group_offset);
+       tprintf(T("System ACL offset = %u\n"), sacl_offset);
+       tprintf(T("Discretionary ACL offset = %u\n"), dacl_offset);
 
        if (sd->owner_offset != 0)
-               print_sid(p + owner_offset, "Owner");
+               print_sid(p + owner_offset, T("Owner"));
        if (sd->group_offset != 0)
-               print_sid(p + group_offset, "Group");
+               print_sid(p + group_offset, T("Group"));
        if (sd->sacl_offset != 0)
-               print_acl(p + sacl_offset, "System");
+               print_acl(p + sacl_offset, T("System"));
        if (sd->dacl_offset != 0)
-               print_acl(p + dacl_offset, "Discretionary");
+               print_acl(p + dacl_offset, T("Discretionary"));
 }
 
 /*
  * Prints the security data for a WIM file.
  */
-void print_security_data(const struct wim_security_data *sd)
+void
+print_security_data(const struct wim_security_data *sd)
 {
        wimlib_assert(sd != NULL);
 
-       puts("[SECURITY DATA]");
-       printf("Length            = %"PRIu32" bytes\n", sd->total_length);
-       printf("Number of Entries = %"PRIu32"\n", sd->num_entries);
+       tputs(T("[SECURITY DATA]"));
+       tprintf(T("Length            = %"PRIu32" bytes\n"), sd->total_length);
+       tprintf(T("Number of Entries = %"PRIu32"\n"), sd->num_entries);
 
        for (u32 i = 0; i < sd->num_entries; i++) {
-               printf("[SecurityDescriptor %"PRIu32", length = %"PRIu64"]\n",
-                      i, sd->sizes[i]);
+               tprintf(T("[SecurityDescriptor %"PRIu32", length = %"PRIu64"]\n"),
+                       i, sd->sizes[i]);
                print_security_descriptor(sd->descriptors[i], sd->sizes[i]);
-               putchar('\n');
+               tputchar(T('\n'));
        }
-       putchar('\n');
+       tputchar(T('\n'));
 }
 
-void free_security_data(struct wim_security_data *sd)
+void
+free_security_data(struct wim_security_data *sd)
 {
        if (sd) {
                wimlib_assert(sd->refcnt != 0);
@@ -342,3 +450,133 @@ void free_security_data(struct wim_security_data *sd)
                }
        }
 }
+
+struct sd_node {
+       int security_id;
+       u8 hash[SHA1_HASH_SIZE];
+       struct rb_node rb_node;
+};
+
+static void
+free_sd_tree(struct rb_node *node)
+{
+       if (node) {
+               free_sd_tree(node->rb_left);
+               free_sd_tree(node->rb_right);
+               FREE(container_of(node, struct sd_node, rb_node));
+       }
+}
+
+/* Frees a security descriptor index set. */
+void
+destroy_sd_set(struct sd_set *sd_set)
+{
+       free_sd_tree(sd_set->rb_root.rb_node);
+}
+
+/* Inserts a a new node into the security descriptor index tree. */
+static void
+insert_sd_node(struct sd_set *set, struct sd_node *new)
+{
+       struct rb_root *root = &set->rb_root;
+       struct rb_node **p = &(root->rb_node);
+       struct rb_node *rb_parent = NULL;
+
+       while (*p) {
+               struct sd_node *this = container_of(*p, struct sd_node, rb_node);
+               int cmp = hashes_cmp(new->hash, this->hash);
+
+               rb_parent = *p;
+               if (cmp < 0)
+                       p = &((*p)->rb_left);
+               else if (cmp > 0)
+                       p = &((*p)->rb_right);
+               else
+                       wimlib_assert(0); /* Duplicate SHA1 message digest */
+       }
+       rb_link_node(&new->rb_node, rb_parent, p);
+       rb_insert_color(&new->rb_node, root);
+}
+
+/* Returns the index of the security descriptor having a SHA1 message digest of
+ * @hash.  If not found, return -1. */
+int
+lookup_sd(struct sd_set *set, const u8 hash[SHA1_HASH_SIZE])
+{
+       struct rb_node *node = set->rb_root.rb_node;
+
+       while (node) {
+               struct sd_node *sd_node = container_of(node, struct sd_node, rb_node);
+               int cmp = hashes_cmp(hash, sd_node->hash);
+               if (cmp < 0)
+                       node = node->rb_left;
+               else if (cmp > 0)
+                       node = node->rb_right;
+               else
+                       return sd_node->security_id;
+       }
+       return -1;
+}
+
+/*
+ * Adds a security descriptor to the indexed security descriptor set as well as
+ * the corresponding `struct wim_security_data', and returns the new security
+ * ID; or, if there is an existing security descriptor that is the same, return
+ * the security ID for it.  If a new security descriptor cannot be allocated,
+ * return -1.
+ */
+int
+sd_set_add_sd(struct sd_set *sd_set, const char descriptor[], size_t size)
+{
+       u8 hash[SHA1_HASH_SIZE];
+       int security_id;
+       struct sd_node *new;
+       u8 **descriptors;
+       u64 *sizes;
+       u8 *descr_copy;
+       struct wim_security_data *sd;
+
+       sha1_buffer((const u8*)descriptor, size, hash);
+
+       security_id = lookup_sd(sd_set, hash);
+       if (security_id >= 0) /* Identical descriptor already exists */
+               return security_id;
+
+       /* Need to add a new security descriptor */
+       new = MALLOC(sizeof(*new));
+       if (!new)
+               goto out;
+       descr_copy = MALLOC(size);
+       if (!descr_copy)
+               goto out_free_node;
+
+       sd = sd_set->sd;
+
+       memcpy(descr_copy, descriptor, size);
+       new->security_id = sd->num_entries;
+       copy_hash(new->hash, hash);
+
+       descriptors = REALLOC(sd->descriptors,
+                             (sd->num_entries + 1) * sizeof(sd->descriptors[0]));
+       if (!descriptors)
+               goto out_free_descr;
+       sd->descriptors = descriptors;
+       sizes = REALLOC(sd->sizes,
+                       (sd->num_entries + 1) * sizeof(sd->sizes[0]));
+       if (!sizes)
+               goto out_free_descr;
+       sd->sizes = sizes;
+       sd->descriptors[sd->num_entries] = descr_copy;
+       sd->sizes[sd->num_entries] = size;
+       sd->num_entries++;
+       DEBUG("There are now %d security descriptors", sd->num_entries);
+       sd->total_length += size + sizeof(sd->sizes[0]);
+       insert_sd_node(sd_set, new);
+       return new->security_id;
+out_free_descr:
+       FREE(descr_copy);
+out_free_node:
+       FREE(new);
+out:
+       return -1;
+}