wimlib-imagex: improve error message
[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 free software; you can redistribute it and/or modify it under
9  * the terms of the GNU Lesser General Public License as published by the Free
10  * Software Foundation; either version 3 of the License, or (at your option) any
11  * later version.
12  *
13  * This file is distributed in the hope that it will be useful, but WITHOUT
14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
16  * details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this file; if not, see http://www.gnu.org/licenses/.
20  */
21
22 #ifdef HAVE_CONFIG_H
23 #  include "config.h"
24 #endif
25
26 #include "wimlib/assert.h"
27 #include "wimlib/blob_table.h"
28 #include "wimlib/dentry.h"
29 #include "wimlib/error.h"
30 #include "wimlib/metadata.h"
31 #include "wimlib/resource.h"
32 #include "wimlib/security.h"
33 #include "wimlib/write.h"
34
35 /* Fix the security ID for every inode to be either -1 or in bounds.  */
36 static void
37 fix_security_ids(struct wim_image_metadata *imd, const u32 num_entries)
38 {
39         struct wim_inode *inode;
40         unsigned long invalid_count = 0;
41
42         image_for_each_inode(inode, imd) {
43                 if ((u32)inode->i_security_id >= num_entries) {
44                         if (inode->i_security_id >= 0)
45                                 invalid_count++;
46                         inode->i_security_id = -1;
47                 }
48         }
49         if (invalid_count)
50                 WARNING("%lu inodes had invalid security IDs", invalid_count);
51 }
52
53 /*
54  * Reads and parses a metadata resource for an image in the WIM file.
55  *
56  * @imd:
57  *      Pointer to the image metadata structure for the image whose metadata
58  *      resource we are reading.  Its `metadata_blob' member specifies the blob
59  *      table entry for the metadata resource.  The rest of the image metadata
60  *      entry will be filled in by this function.
61  *
62  * Return values:
63  *      WIMLIB_ERR_SUCCESS (0)
64  *      WIMLIB_ERR_INVALID_METADATA_RESOURCE
65  *      WIMLIB_ERR_NOMEM
66  *      WIMLIB_ERR_READ
67  *      WIMLIB_ERR_UNEXPECTED_END_OF_FILE
68  *      WIMLIB_ERR_DECOMPRESSION
69  */
70 int
71 read_metadata_resource(struct wim_image_metadata *imd)
72 {
73         const struct blob_descriptor *metadata_blob;
74         void *buf;
75         int ret;
76         struct wim_security_data *sd;
77         struct wim_dentry *root;
78
79         metadata_blob = imd->metadata_blob;
80
81         /* Read the metadata resource into memory.  (It may be compressed.)  */
82         ret = read_blob_into_alloc_buf(metadata_blob, &buf);
83         if (ret)
84                 return ret;
85
86         /* Checksum the metadata resource.  */
87         if (!metadata_blob->dont_check_metadata_hash) {
88                 u8 hash[SHA1_HASH_SIZE];
89
90                 sha1_buffer(buf, metadata_blob->size, hash);
91                 if (!hashes_equal(metadata_blob->hash, hash)) {
92                         ERROR("Metadata resource is corrupted "
93                               "(invalid SHA-1 message digest)!");
94                         ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
95                         goto out_free_buf;
96                 }
97         }
98
99         /* Parse the metadata resource.
100          *
101          * Notes: The metadata resource consists of the security data, followed
102          * by the directory entry for the root directory, followed by all the
103          * other directory entries in the filesystem.  The subdir offset field
104          * of each directory entry gives the start of its child entries from the
105          * beginning of the metadata resource.  An end-of-directory is signaled
106          * by a directory entry of length '0', really of length 8, because
107          * that's how long the 'length' field is.  */
108
109         ret = read_wim_security_data(buf, metadata_blob->size, &sd);
110         if (ret)
111                 goto out_free_buf;
112
113         ret = read_dentry_tree(buf, metadata_blob->size, sd->total_length, &root);
114         if (ret)
115                 goto out_free_security_data;
116
117         /* We have everything we need from the buffer now.  */
118         FREE(buf);
119         buf = NULL;
120
121         /* Calculate and validate inodes.  */
122
123         ret = dentry_tree_fix_inodes(root, &imd->inode_list);
124         if (ret)
125                 goto out_free_dentry_tree;
126
127         fix_security_ids(imd, sd->num_entries);
128
129         /* Success; fill in the image_metadata structure.  */
130         imd->root_dentry = root;
131         imd->security_data = sd;
132         INIT_LIST_HEAD(&imd->unhashed_blobs);
133         return 0;
134
135 out_free_dentry_tree:
136         free_dentry_tree(root, NULL);
137 out_free_security_data:
138         free_wim_security_data(sd);
139 out_free_buf:
140         FREE(buf);
141         return ret;
142 }
143
144 static void
145 recalculate_security_data_length(struct wim_security_data *sd)
146 {
147         u32 total_length = sizeof(u64) * sd->num_entries + 2 * sizeof(u32);
148         for (u32 i = 0; i < sd->num_entries; i++)
149                 total_length += sd->sizes[i];
150         sd->total_length = ALIGN(total_length, 8);
151 }
152
153 static int
154 prepare_metadata_resource(WIMStruct *wim, int image,
155                           u8 **buf_ret, size_t *len_ret)
156 {
157         u8 *buf;
158         u8 *p;
159         int ret;
160         u64 subdir_offset;
161         struct wim_dentry *root;
162         size_t len;
163         struct wim_security_data *sd;
164         struct wim_image_metadata *imd;
165
166         ret = select_wim_image(wim, image);
167         if (ret)
168                 return ret;
169
170         imd = wim->image_metadata[image - 1];
171
172         root = imd->root_dentry;
173         sd = imd->security_data;
174
175         if (!root) {
176                 /* Empty image; create a dummy root.  */
177                 ret = new_filler_directory(&root);
178                 if (ret)
179                         return ret;
180                 imd->root_dentry = root;
181         }
182
183         /* The offset of the first child of the root dentry is equal to the
184          * total length of the security data, plus the total length of the root
185          * dentry, plus 8 bytes for an end-of-directory entry following the root
186          * dentry (shouldn't really be needed, but just in case...)  */
187         recalculate_security_data_length(sd);
188         subdir_offset = sd->total_length + dentry_out_total_length(root) + 8;
189
190         /* Calculate the subdirectory offsets for the entire dentry tree.  */
191         calculate_subdir_offsets(root, &subdir_offset);
192
193         /* Total length of the metadata resource (uncompressed).  */
194         len = subdir_offset;
195
196         /* Allocate a buffer to contain the uncompressed metadata resource.  */
197         buf = NULL;
198         if (likely(len == subdir_offset))
199                 buf = MALLOC(len);
200         if (!buf) {
201                 ERROR("Failed to allocate %"PRIu64" bytes for "
202                       "metadata resource", subdir_offset);
203                 return WIMLIB_ERR_NOMEM;
204         }
205
206         /* Write the security data into the resource buffer.  */
207         p = write_wim_security_data(sd, buf);
208
209         /* Write the dentry tree into the resource buffer.  */
210         p = write_dentry_tree(root, p);
211
212         /* We MUST have exactly filled the buffer; otherwise we calculated its
213          * size incorrectly or wrote the data incorrectly.  */
214         wimlib_assert(p - buf == len);
215
216         *buf_ret = buf;
217         *len_ret = len;
218         return 0;
219 }
220
221 int
222 write_metadata_resource(WIMStruct *wim, int image, int write_resource_flags)
223 {
224         int ret;
225         u8 *buf;
226         size_t len;
227         struct wim_image_metadata *imd;
228
229         ret = prepare_metadata_resource(wim, image, &buf, &len);
230         if (ret)
231                 return ret;
232
233         imd = wim->image_metadata[image - 1];
234
235         /* Write the metadata resource to the output WIM using the proper
236          * compression type, in the process updating the blob descriptor for the
237          * metadata resource.  */
238         ret = write_wim_resource_from_buffer(buf,
239                                              len,
240                                              true,
241                                              &wim->out_fd,
242                                              wim->out_compression_type,
243                                              wim->out_chunk_size,
244                                              &imd->metadata_blob->out_reshdr,
245                                              imd->metadata_blob->hash,
246                                              write_resource_flags);
247
248         /* Original checksum was overridden; set a flag so it isn't used.  */
249         imd->metadata_blob->dont_check_metadata_hash = 1;
250
251         FREE(buf);
252         return ret;
253 }