New helper macro: ALIGN()
[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         DEBUG("Reading metadata resource (size=%"PRIu64").", metadata_blob->size);
82
83         /* Read the metadata resource into memory.  (It may be compressed.)  */
84         ret = read_blob_into_alloc_buf(metadata_blob, &buf);
85         if (ret)
86                 return ret;
87
88         /* Checksum the metadata resource.  */
89         if (!metadata_blob->dont_check_metadata_hash) {
90                 u8 hash[SHA1_HASH_SIZE];
91
92                 sha1_buffer(buf, metadata_blob->size, hash);
93                 if (!hashes_equal(metadata_blob->hash, hash)) {
94                         ERROR("Metadata resource is corrupted "
95                               "(invalid SHA-1 message digest)!");
96                         ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
97                         goto out_free_buf;
98                 }
99         }
100
101         /* Parse the metadata resource.
102          *
103          * Notes: The metadata resource consists of the security data, followed
104          * by the directory entry for the root directory, followed by all the
105          * other directory entries in the filesystem.  The subdir_offset field
106          * of each directory entry gives the start of its child entries from the
107          * beginning of the metadata resource.  An end-of-directory is signaled
108          * by a directory entry of length '0', really of length 8, because
109          * that's how long the 'length' field is.  */
110
111         ret = read_wim_security_data(buf, metadata_blob->size, &sd);
112         if (ret)
113                 goto out_free_buf;
114
115         ret = read_dentry_tree(buf, metadata_blob->size, sd->total_length, &root);
116         if (ret)
117                 goto out_free_security_data;
118
119         /* We have everything we need from the buffer now.  */
120         FREE(buf);
121         buf = NULL;
122
123         /* Calculate and validate inodes.  */
124
125         ret = dentry_tree_fix_inodes(root, &imd->inode_list);
126         if (ret)
127                 goto out_free_dentry_tree;
128
129         fix_security_ids(imd, sd->num_entries);
130
131         /* Success; fill in the image_metadata structure.  */
132         imd->root_dentry = root;
133         imd->security_data = sd;
134         INIT_LIST_HEAD(&imd->unhashed_blobs);
135         DEBUG("Done parsing metadata resource.");
136         return 0;
137
138 out_free_dentry_tree:
139         free_dentry_tree(root, NULL);
140 out_free_security_data:
141         free_wim_security_data(sd);
142 out_free_buf:
143         FREE(buf);
144         return ret;
145 }
146
147 static void
148 recalculate_security_data_length(struct wim_security_data *sd)
149 {
150         u32 total_length = sizeof(u64) * sd->num_entries + 2 * sizeof(u32);
151         for (u32 i = 0; i < sd->num_entries; i++)
152                 total_length += sd->sizes[i];
153         sd->total_length = ALIGN(total_length, 8);
154 }
155
156 static int
157 prepare_metadata_resource(WIMStruct *wim, int image,
158                           u8 **buf_ret, size_t *len_ret)
159 {
160         u8 *buf;
161         u8 *p;
162         int ret;
163         u64 subdir_offset;
164         struct wim_dentry *root;
165         size_t len;
166         struct wim_security_data *sd;
167         struct wim_image_metadata *imd;
168
169         DEBUG("Preparing metadata resource for image %d", image);
170
171         ret = select_wim_image(wim, image);
172         if (ret)
173                 return ret;
174
175         imd = wim->image_metadata[image - 1];
176
177         root = imd->root_dentry;
178         sd = imd->security_data;
179
180         if (!root) {
181                 /* Empty image; create a dummy root.  */
182                 ret = new_filler_directory(&root);
183                 if (ret)
184                         return ret;
185                 imd->root_dentry = root;
186         }
187
188         /* The offset of the first child of the root dentry is equal to the
189          * total length of the security data, plus the total length of the root
190          * dentry, plus 8 bytes for an end-of-directory entry following the root
191          * dentry (shouldn't really be needed, but just in case...)  */
192         recalculate_security_data_length(sd);
193         subdir_offset = sd->total_length + dentry_out_total_length(root) + 8;
194
195         /* Calculate the subdirectory offsets for the entire dentry tree.  */
196         calculate_subdir_offsets(root, &subdir_offset);
197
198         /* Total length of the metadata resource (uncompressed).  */
199         len = subdir_offset;
200
201         /* Allocate a buffer to contain the uncompressed metadata resource.  */
202         buf = NULL;
203         if (likely(len == subdir_offset))
204                 buf = MALLOC(len);
205         if (!buf) {
206                 ERROR("Failed to allocate %"PRIu64" bytes for "
207                       "metadata resource", subdir_offset);
208                 return WIMLIB_ERR_NOMEM;
209         }
210
211         /* Write the security data into the resource buffer.  */
212         p = write_wim_security_data(sd, buf);
213
214         /* Write the dentry tree into the resource buffer.  */
215         p = write_dentry_tree(root, p);
216
217         /* We MUST have exactly filled the buffer; otherwise we calculated its
218          * size incorrectly or wrote the data incorrectly.  */
219         wimlib_assert(p - buf == len);
220
221         *buf_ret = buf;
222         *len_ret = len;
223         return 0;
224 }
225
226 int
227 write_metadata_resource(WIMStruct *wim, int image, int write_resource_flags)
228 {
229         int ret;
230         u8 *buf;
231         size_t len;
232         struct wim_image_metadata *imd;
233
234         ret = prepare_metadata_resource(wim, image, &buf, &len);
235         if (ret)
236                 return ret;
237
238         imd = wim->image_metadata[image - 1];
239
240         /* Write the metadata resource to the output WIM using the proper
241          * compression type, in the process updating the blob descriptor for the
242          * metadata resource.  */
243         ret = write_wim_resource_from_buffer(buf,
244                                              len,
245                                              true,
246                                              &wim->out_fd,
247                                              wim->out_compression_type,
248                                              wim->out_chunk_size,
249                                              &imd->metadata_blob->out_reshdr,
250                                              imd->metadata_blob->hash,
251                                              write_resource_flags);
252
253         /* Original checksum was overridden; set a flag so it isn't used.  */
254         imd->metadata_blob->dont_check_metadata_hash = 1;
255
256         FREE(buf);
257         return ret;
258 }