wimlib.net Git - wimlib/blob - 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, 2014 Eric Biggers
   9  *
  10  * This file is free software; you can redistribute it and/or modify it under
  11  * the terms of the GNU Lesser General Public License as published by the Free
  12  * Software Foundation; either version 3 of the License, or (at your option) any
  13  * later version.
  14  *
  15  * This file is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this file; if not, see http://www.gnu.org/licenses/.
  22  */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include "config.h"
  26 #endif
  27
  28 #include "wimlib/assert.h"
  29 #include "wimlib/avl_tree.h"
  30 #include "wimlib/endianness.h"
  31 #include "wimlib/error.h"
  32 #include "wimlib/security.h"
  33 #include "wimlib/sha1.h"
  34 #include "wimlib/util.h"
  35
  36 struct wim_security_data_disk {
  37         le32 total_length;
  38         le32 num_entries;
  39         le64 sizes[];
  40 } _packed_attribute;
  41
  42 struct wim_security_data *
  43 new_wim_security_data(void)
  44 {
  45         return CALLOC(1, sizeof(struct wim_security_data));
  46 }
  47
  48 /*
  49  * Reads the security data from the metadata resource of a WIM image.
  50  *
  51  * @buf
  52  *      Buffer containing an uncompressed WIM metadata resource.
  53  * @buf_len
  54  *      Length of the uncompressed metadata resource, in bytes.
  55  * @sd_ret
  56  *      On success, a pointer to the resulting security data structure will be
  57  *      returned here.
  58  *
  59  * Note: There is no `offset' argument because the security data is located at
  60  * the beginning of the metadata resource.
  61  *
  62  * Return values:
  63  *      WIMLIB_ERR_SUCCESS (0)
  64  *      WIMLIB_ERR_INVALID_METADATA_RESOURCE
  65  *      WIMLIB_ERR_NOMEM
  66  */
  67 int
  68 read_wim_security_data(const u8 *buf, size_t buf_len,
  69                        struct wim_security_data **sd_ret)
  70 {
  71         struct wim_security_data *sd;
  72         int ret;
  73         u64 total_len;
  74         u64 sizes_size;
  75         u64 size_no_descriptors;
  76         const struct wim_security_data_disk *sd_disk;
  77         const u8 *p;
  78
  79         if (buf_len < 8)
  80                 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
  81
  82         sd = new_wim_security_data();
  83         if (!sd)
  84                 goto out_of_memory;
  85
  86         sd_disk = (const struct wim_security_data_disk *)buf;
  87         sd->total_length = le32_to_cpu(sd_disk->total_length);
  88         sd->num_entries = le32_to_cpu(sd_disk->num_entries);
  89
  90         DEBUG("Reading security data: num_entries=%u, total_length=%u",
  91               sd->num_entries, sd->total_length);
  92
  93         /* Length field of 0 is a special case that really means length
  94          * of 8. */
  95         if (sd->total_length == 0)
  96                 sd->total_length = 8;
  97
  98         /* The security_id field of each dentry is a signed 32-bit integer, so
  99          * the possible indices into the security descriptors table are 0
 100          * through 0x7fffffff.  Which means 0x80000000 security descriptors
 101          * maximum.  Not like you should ever have anywhere close to that many
 102          * security descriptors! */
 103         if (sd->num_entries > 0x80000000)
 104                 goto out_invalid_sd;
 105
 106         /* Verify the listed total length of the security data is big enough to
 107          * include the sizes array, verify that the file data is big enough to
 108          * include it as well, then allocate the array of sizes.
 109          *
 110          * Note: The total length of the security data must fit in a 32-bit
 111          * integer, even though each security descriptor size is a 64-bit
 112          * integer.  This is stupid, and we need to be careful not to actually
 113          * let the security descriptor sizes be over 0xffffffff.  */
 114         if (sd->total_length > buf_len)
 115                 goto out_invalid_sd;
 116
 117         sizes_size = (u64)sd->num_entries * sizeof(u64);
 118         size_no_descriptors = 8 + sizes_size;
 119         if (size_no_descriptors > sd->total_length)
 120                 goto out_invalid_sd;
 121
 122         total_len = size_no_descriptors;
 123
 124         /* Return immediately if no security descriptors. */
 125         if (sd->num_entries == 0)
 126                 goto out_align_total_length;
 127
 128         /* Allocate a new buffer for the sizes array */
 129         sd->sizes = MALLOC(sizes_size);
 130         if (!sd->sizes)
 131                 goto out_of_memory;
 132
 133         /* Copy the sizes array into the new buffer */
 134         for (u32 i = 0; i < sd->num_entries; i++) {
 135                 sd->sizes[i] = le64_to_cpu(sd_disk->sizes[i]);
 136                 if (sd->sizes[i] > 0xffffffff)
 137                         goto out_invalid_sd;
 138         }
 139
 140         p = (const u8*)sd_disk + size_no_descriptors;
 141
 142         /* Allocate the array of pointers to the security descriptors, then read
 143          * them into separate buffers. */
 144         sd->descriptors = CALLOC(sd->num_entries, sizeof(sd->descriptors[0]));
 145         if (!sd->descriptors)
 146                 goto out_of_memory;
 147
 148         for (u32 i = 0; i < sd->num_entries; i++) {
 149                 if (sd->sizes[i] == 0)
 150                         continue;
 151                 total_len += sd->sizes[i];
 152                 if (total_len > (u64)sd->total_length)
 153                         goto out_invalid_sd;
 154                 sd->descriptors[i] = memdup(p, sd->sizes[i]);
 155                 if (!sd->descriptors[i])
 156                         goto out_of_memory;
 157                 p += sd->sizes[i];
 158         }
 159 out_align_total_length:
 160         total_len = (total_len + 7) & ~7;
 161         sd->total_length = (sd->total_length + 7) & ~7;
 162         if (total_len != sd->total_length) {
 163                 WARNING("Expected WIM security data total length of "
 164                         "%u bytes, but calculated %u bytes",
 165                         sd->total_length, (unsigned)total_len);
 166         }
 167         *sd_ret = sd;
 168         ret = 0;
 169         goto out;
 170 out_invalid_sd:
 171         ERROR("WIM security data is invalid!");
 172         ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
 173         goto out_free_sd;
 174 out_of_memory:
 175         ERROR("Out of memory while reading WIM security data!");
 176         ret = WIMLIB_ERR_NOMEM;
 177 out_free_sd:
 178         free_wim_security_data(sd);
 179 out:
 180         return ret;
 181 }
 182
 183 /*
 184  * Writes the security data for a WIM image to an in-memory buffer.
 185  */
 186 u8 *
 187 write_wim_security_data(const struct wim_security_data * restrict sd,
 188                         u8 * restrict p)
 189 {
 190         DEBUG("Writing security data (total_length = %"PRIu32", num_entries "
 191               "= %"PRIu32")", sd->total_length, sd->num_entries);
 192
 193         u8 *orig_p = p;
 194         struct wim_security_data_disk *sd_disk = (struct wim_security_data_disk*)p;
 195         u32 num_entries = sd->num_entries;
 196
 197         sd_disk->total_length = cpu_to_le32(sd->total_length);
 198         sd_disk->num_entries = cpu_to_le32(num_entries);
 199
 200         for (u32 i = 0; i < num_entries; i++)
 201                 sd_disk->sizes[i] = cpu_to_le64(sd->sizes[i]);
 202
 203         p = (u8*)&sd_disk->sizes[num_entries];
 204
 205         for (u32 i = 0; i < num_entries; i++)
 206                 p = mempcpy(p, sd->descriptors[i], sd->sizes[i]);
 207
 208         while ((uintptr_t)p & 7)
 209                 *p++ = 0;
 210
 211         wimlib_assert(p - orig_p == sd->total_length);
 212
 213         DEBUG("Successfully wrote security data.");
 214         return p;
 215 }
 216
 217 void
 218 free_wim_security_data(struct wim_security_data *sd)
 219 {
 220         if (sd) {
 221                 u8 **descriptors = sd->descriptors;
 222                 u32 num_entries  = sd->num_entries;
 223                 if (descriptors)
 224                         while (num_entries--)
 225                                 FREE(*descriptors++);
 226                 FREE(sd->sizes);
 227                 FREE(sd->descriptors);
 228                 FREE(sd);
 229         }
 230 }
 231
 232 struct sd_node {
 233         int32_t security_id;
 234         u8 hash[SHA1_HASH_SIZE];
 235         struct avl_tree_node index_node;
 236 };
 237
 238 #define SD_NODE(avl_node) \
 239         avl_tree_entry(avl_node, struct sd_node, index_node)
 240
 241 static void
 242 free_sd_tree(struct avl_tree_node *node)
 243 {
 244         if (node) {
 245                 free_sd_tree(node->left);
 246                 free_sd_tree(node->right);
 247                 FREE(SD_NODE(node));
 248         }
 249 }
 250
 251 void
 252 rollback_new_security_descriptors(struct wim_sd_set *sd_set)
 253 {
 254         struct wim_security_data *sd = sd_set->sd;
 255         u8 **descriptors = sd->descriptors + sd_set->orig_num_entries;
 256         u32 num_entries  = sd->num_entries - sd_set->orig_num_entries;
 257         while (num_entries--)
 258                 FREE(*descriptors++);
 259         sd->num_entries = sd_set->orig_num_entries;
 260 }
 261
 262 /* Frees a security descriptor index set. */
 263 void
 264 destroy_sd_set(struct wim_sd_set *sd_set)
 265 {
 266         free_sd_tree(sd_set->root);
 267 }
 268
 269 static int
 270 _avl_cmp_nodes_by_hash(const struct avl_tree_node *n1,
 271                        const struct avl_tree_node *n2)
 272 {
 273         return hashes_cmp(SD_NODE(n1)->hash, SD_NODE(n2)->hash);
 274 }
 275
 276 /* Inserts a new node into the security descriptor index tree.  Returns true
 277  * if successful (not a duplicate).  */
 278 static bool
 279 insert_sd_node(struct wim_sd_set *set, struct sd_node *new)
 280 {
 281         return NULL == avl_tree_insert(&set->root, &new->index_node,
 282                                        _avl_cmp_nodes_by_hash);
 283 }
 284
 285 /* Returns the index of the security descriptor having a SHA1 message digest of
 286  * @hash.  If not found, return -1. */
 287 static int32_t
 288 lookup_sd(struct wim_sd_set *set, const u8 hash[SHA1_HASH_SIZE])
 289 {
 290         struct avl_tree_node *res;
 291         struct sd_node dummy;
 292
 293         copy_hash(dummy.hash, hash);
 294         res = avl_tree_lookup_node(set->root, &dummy.index_node,
 295                                    _avl_cmp_nodes_by_hash);
 296         if (!res)
 297                 return -1;
 298         return SD_NODE(res)->security_id;
 299 }
 300
 301 /*
 302  * Adds a security descriptor to the indexed security descriptor set as well as
 303  * the corresponding `struct wim_security_data', and returns the new security
 304  * ID; or, if there is an existing security descriptor that is the same, return
 305  * the security ID for it.  If a new security descriptor cannot be allocated,
 306  * return -1.
 307  */
 308 int32_t
 309 sd_set_add_sd(struct wim_sd_set *sd_set, const char *descriptor, size_t size)
 310 {
 311         u8 hash[SHA1_HASH_SIZE];
 312         int32_t security_id;
 313         struct sd_node *new;
 314         u8 **descriptors;
 315         u64 *sizes;
 316         u8 *descr_copy;
 317         struct wim_security_data *sd;
 318         bool bret;
 319
 320         sha1_buffer(descriptor, size, hash);
 321
 322         security_id = lookup_sd(sd_set, hash);
 323         if (security_id >= 0) /* Identical descriptor already exists */
 324                 goto out;
 325
 326         /* Need to add a new security descriptor */
 327         security_id = -1;
 328
 329         new = MALLOC(sizeof(*new));
 330         if (!new)
 331                 goto out;
 332
 333         descr_copy = memdup(descriptor, size);
 334         if (!descr_copy)
 335                 goto out_free_node;
 336
 337         sd = sd_set->sd;
 338         new->security_id = sd->num_entries;
 339         copy_hash(new->hash, hash);
 340
 341         /* There typically are only a few dozen security descriptors in a
 342          * directory tree, so expanding the array of security descriptors by
 343          * only 1 extra space each time should not be a problem. */
 344         descriptors = REALLOC(sd->descriptors,
 345                               (sd->num_entries + 1) * sizeof(sd->descriptors[0]));
 346         if (!descriptors)
 347                 goto out_free_descr;
 348         sd->descriptors = descriptors;
 349         sizes = REALLOC(sd->sizes,
 350                         (sd->num_entries + 1) * sizeof(sd->sizes[0]));
 351         if (!sizes)
 352                 goto out_free_descr;
 353         sd->sizes = sizes;
 354         sd->descriptors[sd->num_entries] = descr_copy;
 355         sd->sizes[sd->num_entries] = size;
 356         sd->num_entries++;
 357         DEBUG("There are now %u security descriptors", sd->num_entries);
 358         bret = insert_sd_node(sd_set, new);
 359         wimlib_assert(bret);
 360         security_id = new->security_id;
 361         goto out;
 362 out_free_descr:
 363         FREE(descr_copy);
 364 out_free_node:
 365         FREE(new);
 366 out:
 367         return security_id;
 368 }
 369
 370 /* Initialize a `struct sd_set' mapping from SHA1 message digests of security
 371  * descriptors to indices into the security descriptors table of the WIM image
 372  * (security IDs).  */
 373 int
 374 init_sd_set(struct wim_sd_set *sd_set, struct wim_security_data *sd)
 375 {
 376         int ret;
 377
 378         sd_set->sd = sd;
 379         sd_set->root = NULL;
 380
 381         /* Remember the original number of security descriptors so that newly
 382          * added ones can be rolled back if needed. */
 383         sd_set->orig_num_entries = sd->num_entries;
 384         for (u32 i = 0; i < sd->num_entries; i++) {
 385                 struct sd_node *new;
 386
 387                 new = MALLOC(sizeof(struct sd_node));
 388                 if (!new) {
 389                         ret = WIMLIB_ERR_NOMEM;
 390                         goto out_destroy_sd_set;
 391                 }
 392                 sha1_buffer(sd->descriptors[i], sd->sizes[i], new->hash);
 393                 new->security_id = i;
 394                 if (!insert_sd_node(sd_set, new))
 395                         FREE(new); /* Ignore duplicate security descriptor */
 396         }
 397         ret = 0;
 398         goto out;
 399 out_destroy_sd_set:
 400         destroy_sd_set(sd_set);
 401 out:
 402         return ret;
 403 }