read_metadata_resource(): Check SHA-1 message digest
[wimlib] / src / metadata_resource.c
1 /*
2  * metadata_resource.c
3  */
4
5 /*
6  * Copyright (C) 2012, 2013 Eric Biggers
7  *
8  * This file is part of wimlib, a library for working with WIM files.
9  *
10  * wimlib is free software; you can redistribute it and/or modify it under the
11  * terms of the GNU General Public License as published by the Free Software
12  * Foundation; either version 3 of the License, or (at your option) any later
13  * version.
14  *
15  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17  * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along with
20  * wimlib; if not, see http://www.gnu.org/licenses/.
21  */
22
23 #ifdef HAVE_CONFIG_H
24 #  include "config.h"
25 #endif
26
27 #include "wimlib/dentry.h"
28 #include "wimlib/error.h"
29 #include "wimlib/file_io.h"
30 #include "wimlib/lookup_table.h"
31 #include "wimlib/metadata.h"
32 #include "wimlib/resource.h"
33 #include "wimlib/security.h"
34
35 /*
36  * Reads a metadata resource for an image in the WIM file.  The metadata
37  * resource consists of the security data, followed by the directory entry for
38  * the root directory, followed by all the other directory entries in the
39  * filesystem.  The subdir_offset field of each directory entry gives the start
40  * of its child entries from the beginning of the metadata resource.  An
41  * end-of-directory is signaled by a directory entry of length '0', really of
42  * length 8, because that's how long the 'length' field is.
43  *
44  * @w:          Pointer to the WIMStruct for the WIM file.
45  *
46  * @imd:        Pointer to the image metadata structure for the image whose
47  *              metadata resource we are reading.  Its `metadata_lte' member
48  *              specifies the lookup table entry for the metadata resource.  The
49  *              rest of the image metadata entry will be filled in by this
50  *              function.
51  *
52  * Returns:     Zero on success, nonzero on failure.
53  */
54 int
55 read_metadata_resource(WIMStruct *wim, struct wim_image_metadata *imd)
56 {
57         u8 *buf;
58         int ret;
59         struct wim_dentry *root;
60         const struct wim_lookup_table_entry *metadata_lte;
61         u64 metadata_len;
62         u8 hash[SHA1_HASH_SIZE];
63
64         metadata_lte = imd->metadata_lte;
65         metadata_len = wim_resource_size(metadata_lte);
66
67         DEBUG("Reading metadata resource: original_size = %"PRIu64", "
68               "size = %"PRIu64", offset = %"PRIu64"",
69               metadata_lte->resource_entry.original_size,
70               metadata_lte->resource_entry.size,
71               metadata_lte->resource_entry.offset);
72
73         /* There is no way the metadata resource could possibly be less than (8
74          * + WIM_DENTRY_DISK_SIZE) bytes, where the 8 is for security data (with
75          * no security descriptors) and WIM_DENTRY_DISK_SIZE is for the root
76          * entry. */
77         if (metadata_len < 8 + WIM_DENTRY_DISK_SIZE) {
78                 ERROR("Expected at least %u bytes for the metadata resource",
79                       8 + WIM_DENTRY_DISK_SIZE);
80                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
81         }
82
83         if (sizeof(size_t) < 8 && metadata_len > 0xffffffff) {
84                 ERROR("Metadata resource is too large (%"PRIu64" bytes",
85                       metadata_len);
86                 return WIMLIB_ERR_INVALID_RESOURCE_SIZE;
87         }
88
89         /* Allocate memory for the uncompressed metadata resource. */
90         buf = MALLOC(metadata_len);
91
92         if (!buf) {
93                 ERROR("Failed to allocate %"PRIu64" bytes for uncompressed "
94                       "metadata resource", metadata_len);
95                 return WIMLIB_ERR_NOMEM;
96         }
97
98         /* Read the metadata resource into memory.  (It may be compressed.) */
99         ret = read_full_resource_into_buf(metadata_lte, buf);
100         if (ret)
101                 goto out_free_buf;
102
103         sha1_buffer(buf, metadata_len, hash);
104         if (!hashes_equal(metadata_lte->hash, hash))
105         {
106                 ERROR("Metadata resource is corrupted (invalid SHA-1 message digest)!");
107                 ret = WIMLIB_ERR_INVALID_RESOURCE_HASH;
108                 goto out_free_buf;
109         }
110
111         DEBUG("Finished reading metadata resource into memory.");
112
113         /* The root directory entry starts after security data, aligned on an
114          * 8-byte boundary within the metadata resource.
115          *
116          * The security data starts with a 4-byte integer giving its total
117          * length, so if we round that up to an 8-byte boundary that gives us
118          * the offset of the root dentry.
119          *
120          * Here we read the security data into a wim_security_data structure,
121          * which takes case of rouding total_length.  If successful, go ahead
122          * and calculate the offset in the metadata resource of the root dentry.
123          * */
124
125         ret = read_wim_security_data(buf, metadata_len, &imd->security_data);
126         if (ret)
127                 goto out_free_buf;
128
129         DEBUG("Reading root dentry");
130
131         /* Allocate memory for the root dentry and read it into memory */
132         root = MALLOC(sizeof(struct wim_dentry));
133         if (!root) {
134                 ret = WIMLIB_ERR_NOMEM;
135                 goto out_free_security_data;
136         }
137
138         ret = read_dentry(buf, metadata_len,
139                           imd->security_data->total_length, root);
140
141         if (ret == 0 && root->length == 0) {
142                 ERROR("Metadata resource cannot begin with end-of-directory entry!");
143                 ret = WIMLIB_ERR_INVALID_DENTRY;
144         }
145
146         if (ret) {
147                 FREE(root);
148                 goto out_free_security_data;
149         }
150
151         /* This is the root dentry, so set its parent to itself. */
152         root->parent = root;
153
154         inode_add_dentry(root, root->d_inode);
155
156         /* Now read the entire directory entry tree into memory. */
157         DEBUG("Reading dentry tree");
158         ret = read_dentry_tree(buf, metadata_len, root);
159         if (ret)
160                 goto out_free_dentry_tree;
161
162         /* Build hash table that maps hard link group IDs to dentry sets */
163         ret = dentry_tree_fix_inodes(root, &imd->inode_list);
164         if (ret)
165                 goto out_free_dentry_tree;
166
167         if (!wim->all_images_verified) {
168                 /* Note: verify_dentry() expects to access imd->security_data,
169                  * so it needs to be set before here. */
170                 DEBUG("Running miscellaneous verifications on the dentry tree");
171                 for_lookup_table_entry(wim->lookup_table, lte_zero_real_refcnt, NULL);
172                 ret = for_dentry_in_tree(root, verify_dentry, wim);
173                 if (ret)
174                         goto out_free_dentry_tree;
175         }
176
177         DEBUG("Done reading image metadata");
178
179         imd->root_dentry = root;
180         INIT_LIST_HEAD(&imd->unhashed_streams);
181         goto out_free_buf;
182 out_free_dentry_tree:
183         free_dentry_tree(root, wim->lookup_table);
184 out_free_security_data:
185         free_wim_security_data(imd->security_data);
186         imd->security_data = NULL;
187 out_free_buf:
188         FREE(buf);
189         return ret;
190 }
191
192 static void
193 recalculate_security_data_length(struct wim_security_data *sd)
194 {
195         u32 total_length = sizeof(u64) * sd->num_entries + 2 * sizeof(u32);
196         for (u32 i = 0; i < sd->num_entries; i++)
197                 total_length += sd->sizes[i];
198         sd->total_length = (total_length + 7) & ~7;
199 }
200
201 /* Like write_wim_resource(), but the resource is specified by a buffer of
202  * uncompressed data rather a lookup table entry; also writes the SHA1 hash of
203  * the buffer to @hash.  */
204 static int
205 write_wim_resource_from_buffer(const void *buf, size_t buf_size,
206                                int out_fd, int out_ctype,
207                                struct resource_entry *out_res_entry,
208                                u8 hash[SHA1_HASH_SIZE])
209 {
210         /* Set up a temporary lookup table entry to provide to
211          * write_wim_resource(). */
212         struct wim_lookup_table_entry lte;
213         int ret;
214         lte.resource_location            = RESOURCE_IN_ATTACHED_BUFFER;
215         lte.attached_buffer              = (void*)buf;
216         lte.resource_entry.original_size = buf_size;
217         lte.resource_entry.flags         = 0;
218         lte.unhashed                     = 1;
219         ret = write_wim_resource(&lte, out_fd, out_ctype, out_res_entry, 0);
220         if (ret == 0)
221                 copy_hash(hash, lte.hash);
222         return ret;
223 }
224
225 /* Write the metadata resource for the current WIM image. */
226 int
227 write_metadata_resource(WIMStruct *w)
228 {
229         u8 *buf;
230         u8 *p;
231         int ret;
232         u64 subdir_offset;
233         struct wim_dentry *root;
234         struct wim_lookup_table_entry *lte;
235         u64 metadata_original_size;
236         struct wim_security_data *sd;
237         struct wim_image_metadata *imd;
238
239         wimlib_assert(w->out_fd != -1);
240         wimlib_assert(w->current_image != WIMLIB_NO_IMAGE);
241
242         DEBUG("Writing metadata resource for image %d (offset = %"PRIu64")",
243               w->current_image, filedes_offset(w->out_fd));
244
245         imd = w->image_metadata[w->current_image - 1];
246
247         root = imd->root_dentry;
248         sd = imd->security_data;
249
250         if (!root) {
251                 /* Empty image; create a dummy root. */
252                 ret = new_filler_directory(T(""), &root);
253                 if (ret)
254                         return ret;
255                 imd->root_dentry = root;
256         }
257
258         /* Offset of first child of the root dentry.  It's equal to:
259          * - The total length of the security data, rounded to the next 8-byte
260          *   boundary,
261          * - plus the total length of the root dentry,
262          * - plus 8 bytes for an end-of-directory entry following the root
263          *   dentry (shouldn't really be needed, but just in case...)
264          */
265         recalculate_security_data_length(sd);
266         subdir_offset = (((u64)sd->total_length + 7) & ~7) +
267                         dentry_correct_total_length(root) + 8;
268
269         /* Calculate the subdirectory offsets for the entire dentry tree. */
270         calculate_subdir_offsets(root, &subdir_offset);
271
272         /* Total length of the metadata resource (uncompressed) */
273         metadata_original_size = subdir_offset;
274
275         /* Allocate a buffer to contain the uncompressed metadata resource */
276         buf = MALLOC(metadata_original_size);
277         if (!buf) {
278                 ERROR("Failed to allocate %"PRIu64" bytes for "
279                       "metadata resource", metadata_original_size);
280                 return WIMLIB_ERR_NOMEM;
281         }
282
283         /* Write the security data into the resource buffer */
284         p = write_wim_security_data(sd, buf);
285
286         /* Write the dentry tree into the resource buffer */
287         p = write_dentry_tree(root, p);
288
289         /* We MUST have exactly filled the buffer; otherwise we calculated its
290          * size incorrectly or wrote the data incorrectly. */
291         wimlib_assert(p - buf == metadata_original_size);
292
293         /* Get the lookup table entry for the metadata resource so we can update
294          * it. */
295         lte = wim_get_current_image_metadata(w)->metadata_lte;
296
297         /* Write the metadata resource to the output WIM using the proper
298          * compression type.  The lookup table entry for the metadata resource
299          * is updated. */
300         ret = write_wim_resource_from_buffer(buf, metadata_original_size,
301                                              w->out_fd,
302                                              wimlib_get_compression_type(w),
303                                              &lte->output_resource_entry,
304                                              lte->hash);
305         /* Note that although the SHA1 message digest of the metadata resource
306          * is very likely to have changed, the corresponding lookup table entry
307          * is not actually located in the hash table, so it need not be
308          * re-inserted in the hash table. */
309
310         /* All the data has been written to the new WIM; no need for the buffer
311          * anymore */
312         FREE(buf);
313         return ret;
314 }