]> wimlib.net Git - wimlib/blobdiff - src/metadata_resource.c
read_metadata_resource(): Treat initial end-of-directory as empty image
[wimlib] / src / metadata_resource.c
index 9cebf9ebc0c1be10daa386aa0fbd16c4565d6f9c..109b0d32ca2499d308c0a68d8d13d1f1865211f8 100644 (file)
  * wimlib; if not, see http://www.gnu.org/licenses/.
  */
 
-#include "wimlib_internal.h"
-#include "dentry.h"
-#include "lookup_table.h"
+#ifdef HAVE_CONFIG_H
+#  include "config.h"
+#endif
+
+#include "wimlib/dentry.h"
+#include "wimlib/error.h"
+#include "wimlib/file_io.h"
+#include "wimlib/lookup_table.h"
+#include "wimlib/metadata.h"
+#include "wimlib/resource.h"
+#include "wimlib/security.h"
 
 /*
- * Reads the metadata metadata resource from the WIM file.  The metadata
+ * Reads a metadata resource for an image in the WIM file.  The metadata
  * resource consists of the security data, followed by the directory entry for
  * the root directory, followed by all the other directory entries in the
  * filesystem.  The subdir_offset field of each directory entry gives the start
  * end-of-directory is signaled by a directory entry of length '0', really of
  * length 8, because that's how long the 'length' field is.
  *
- * @fp:                The FILE* for the input WIM file.
- * @wim_ctype: The compression type of the WIM file.
- * @imd:       Pointer to the image metadata structure.  Its `metadata_lte'
- *             member specifies the lookup table entry for the metadata
- *             resource.  The rest of the image metadata entry will be filled
- *             in by this function.
+ * @w:         Pointer to the WIMStruct for the WIM file.
  *
- * @return:    Zero on success, nonzero on failure.
+ * @imd:       Pointer to the image metadata structure for the image whose
+ *             metadata resource we are reading.  Its `metadata_lte' member
+ *             specifies the lookup table entry for the metadata resource.  The
+ *             rest of the image metadata entry will be filled in by this
+ *             function.
+ *
+ * Returns:    Zero on success, nonzero on failure.
  */
 int
-read_metadata_resource(WIMStruct *w, struct wim_image_metadata *imd)
+read_metadata_resource(WIMStruct *wim, struct wim_image_metadata *imd)
 {
        u8 *buf;
-       u32 dentry_offset;
        int ret;
-       struct wim_dentry *dentry;
+       struct wim_dentry *root;
        const struct wim_lookup_table_entry *metadata_lte;
        u64 metadata_len;
+       u8 hash[SHA1_HASH_SIZE];
 
        metadata_lte = imd->metadata_lte;
        metadata_len = wim_resource_size(metadata_lte);
@@ -64,7 +73,7 @@ read_metadata_resource(WIMStruct *w, struct wim_image_metadata *imd)
        /* There is no way the metadata resource could possibly be less than (8
         * + WIM_DENTRY_DISK_SIZE) bytes, where the 8 is for security data (with
         * no security descriptors) and WIM_DENTRY_DISK_SIZE is for the root
-        * dentry. */
+        * entry. */
        if (metadata_len < 8 + WIM_DENTRY_DISK_SIZE) {
                ERROR("Expected at least %u bytes for the metadata resource",
                      8 + WIM_DENTRY_DISK_SIZE);
@@ -87,10 +96,17 @@ read_metadata_resource(WIMStruct *w, struct wim_image_metadata *imd)
        }
 
        /* Read the metadata resource into memory.  (It may be compressed.) */
-       ret = read_full_resource_into_buf(metadata_lte, buf, false);
+       ret = read_full_resource_into_buf(metadata_lte, buf);
        if (ret)
                goto out_free_buf;
 
+       sha1_buffer(buf, metadata_len, hash);
+       if (!hashes_equal(metadata_lte->hash, hash)) {
+               ERROR("Metadata resource is corrupted (invalid SHA-1 message digest)!");
+               ret = WIMLIB_ERR_INVALID_RESOURCE_HASH;
+               goto out_free_buf;
+       }
+
        DEBUG("Finished reading metadata resource into memory.");
 
        /* The root directory entry starts after security data, aligned on an
@@ -101,78 +117,75 @@ read_metadata_resource(WIMStruct *w, struct wim_image_metadata *imd)
         * the offset of the root dentry.
         *
         * Here we read the security data into a wim_security_data structure,
-        * and if successful, go ahead and calculate the offset in the metadata
-        * resource of the root dentry. */
+        * which takes case of rouding total_length.  If successful, go ahead
+        * and calculate the offset in the metadata resource of the root dentry.
+        * */
 
-       wimlib_assert(imd->security_data == NULL);
-       ret = read_security_data(buf, metadata_len, &imd->security_data);
+       ret = read_wim_security_data(buf, metadata_len, &imd->security_data);
        if (ret)
                goto out_free_buf;
 
-       dentry_offset = (imd->security_data->total_length + 7) & ~7;
-
-       if (dentry_offset == 0) {
-               ERROR("Integer overflow while reading metadata resource");
-               ret = WIMLIB_ERR_INVALID_SECURITY_DATA;
-               goto out_free_security_data;
-       }
-
        DEBUG("Reading root dentry");
 
        /* Allocate memory for the root dentry and read it into memory */
-       dentry = MALLOC(sizeof(struct wim_dentry));
-       if (!dentry) {
-               ERROR("Failed to allocate %zu bytes for root dentry",
-                     sizeof(struct wim_dentry));
+       root = MALLOC(sizeof(struct wim_dentry));
+       if (!root) {
                ret = WIMLIB_ERR_NOMEM;
                goto out_free_security_data;
        }
 
-       ret = read_dentry(buf, metadata_len, dentry_offset, dentry);
-
-       /* This is the root dentry, so set its parent to itself. */
-       dentry->parent = dentry;
+       ret = read_dentry(buf, metadata_len,
+                         imd->security_data->total_length, root);
 
-       if (ret == 0 && dentry->length == 0) {
-               ERROR("Metadata resource cannot begin with end-of-directory entry!");
-               ret = WIMLIB_ERR_INVALID_DENTRY;
+       if (ret == 0 && root->length == 0) {
+               WARNING("Metadata resource begins with end-of-directory entry "
+                       "(treating as empty image)");
+               FREE(root);
+               root = NULL;
+               goto out_success;
        }
 
-       if (ret != 0) {
-               FREE(dentry);
+       if (ret) {
+               FREE(root);
                goto out_free_security_data;
        }
 
-       inode_add_dentry(dentry, dentry->d_inode);
+       /* This is the root dentry, so set its parent to itself. */
+       root->parent = root;
+
+       inode_add_dentry(root, root->d_inode);
 
        /* Now read the entire directory entry tree into memory. */
        DEBUG("Reading dentry tree");
-       ret = read_dentry_tree(buf, metadata_len, dentry);
+       ret = read_dentry_tree(buf, metadata_len, root);
        if (ret)
                goto out_free_dentry_tree;
 
        /* Build hash table that maps hard link group IDs to dentry sets */
-       ret = dentry_tree_fix_inodes(dentry, &imd->inode_list);
+       ret = dentry_tree_fix_inodes(root, &imd->inode_list);
        if (ret)
                goto out_free_dentry_tree;
 
-       if (!w->all_images_verified) {
+       if (!wim->all_images_verified) {
+               /* Note: verify_dentry() expects to access imd->security_data,
+                * so it needs to be set before here. */
                DEBUG("Running miscellaneous verifications on the dentry tree");
-               for_lookup_table_entry(w->lookup_table, lte_zero_real_refcnt, NULL);
-               ret = for_dentry_in_tree(dentry, verify_dentry, w);
+               for_lookup_table_entry(wim->lookup_table, lte_zero_real_refcnt, NULL);
+               ret = for_dentry_in_tree(root, verify_dentry, wim);
                if (ret)
                        goto out_free_dentry_tree;
        }
 
        DEBUG("Done reading image metadata");
 
-       imd->root_dentry = dentry;
+out_success:
+       imd->root_dentry = root;
        INIT_LIST_HEAD(&imd->unhashed_streams);
        goto out_free_buf;
 out_free_dentry_tree:
-       free_dentry_tree(dentry, NULL);
+       free_dentry_tree(root, wim->lookup_table);
 out_free_security_data:
-       free_security_data(imd->security_data);
+       free_wim_security_data(imd->security_data);
        imd->security_data = NULL;
 out_free_buf:
        FREE(buf);
@@ -185,15 +198,15 @@ recalculate_security_data_length(struct wim_security_data *sd)
        u32 total_length = sizeof(u64) * sd->num_entries + 2 * sizeof(u32);
        for (u32 i = 0; i < sd->num_entries; i++)
                total_length += sd->sizes[i];
-       sd->total_length = total_length;
+       sd->total_length = (total_length + 7) & ~7;
 }
 
 /* Like write_wim_resource(), but the resource is specified by a buffer of
  * uncompressed data rather a lookup table entry; also writes the SHA1 hash of
  * the buffer to @hash.  */
 static int
-write_wim_resource_from_buffer(const void *buf, u64 buf_size,
-                              FILE *out_fp, int out_ctype,
+write_wim_resource_from_buffer(const void *buf, size_t buf_size,
+                              int out_fd, int out_ctype,
                               struct resource_entry *out_res_entry,
                               u8 hash[SHA1_HASH_SIZE])
 {
@@ -206,7 +219,7 @@ write_wim_resource_from_buffer(const void *buf, u64 buf_size,
        lte.resource_entry.original_size = buf_size;
        lte.resource_entry.flags         = 0;
        lte.unhashed                     = 1;
-       ret = write_wim_resource(&lte, out_fp, out_ctype, out_res_entry, 0);
+       ret = write_wim_resource(&lte, out_fd, out_ctype, out_res_entry, 0);
        if (ret == 0)
                copy_hash(hash, lte.hash);
        return ret;
@@ -224,16 +237,26 @@ write_metadata_resource(WIMStruct *w)
        struct wim_lookup_table_entry *lte;
        u64 metadata_original_size;
        struct wim_security_data *sd;
+       struct wim_image_metadata *imd;
 
-       wimlib_assert(w->out_fp != NULL);
+       wimlib_assert(w->out_fd != -1);
        wimlib_assert(w->current_image != WIMLIB_NO_IMAGE);
 
        DEBUG("Writing metadata resource for image %d (offset = %"PRIu64")",
-             w->current_image, ftello(w->out_fp));
+             w->current_image, filedes_offset(w->out_fd));
+
+       imd = w->image_metadata[w->current_image - 1];
 
+       root = imd->root_dentry;
+       sd = imd->security_data;
 
-       root = wim_root_dentry(w);
-       sd = wim_security_data(w);
+       if (!root) {
+               /* Empty image; create a dummy root. */
+               ret = new_filler_directory(T(""), &root);
+               if (ret)
+                       return ret;
+               imd->root_dentry = root;
+       }
 
        /* Offset of first child of the root dentry.  It's equal to:
         * - The total length of the security data, rounded to the next 8-byte
@@ -261,7 +284,7 @@ write_metadata_resource(WIMStruct *w)
        }
 
        /* Write the security data into the resource buffer */
-       p = write_security_data(sd, buf);
+       p = write_wim_security_data(sd, buf);
 
        /* Write the dentry tree into the resource buffer */
        p = write_dentry_tree(root, p);
@@ -278,7 +301,7 @@ write_metadata_resource(WIMStruct *w)
         * compression type.  The lookup table entry for the metadata resource
         * is updated. */
        ret = write_wim_resource_from_buffer(buf, metadata_original_size,
-                                            w->out_fp,
+                                            w->out_fd,
                                             wimlib_get_compression_type(w),
                                             &lte->output_resource_entry,
                                             lte->hash);