4 * Apply a WIM image to a NTFS volume, restoring everything we can, including
5 * security data and alternate data streams. There should be no loss of
10 * Copyright (C) 2012 Eric Biggers
12 * This file is part of wimlib, a library for working with WIM files.
14 * wimlib is free software; you can redistribute it and/or modify it under the
15 * terms of the GNU Lesser General Public License as published by the Free
16 * Software Foundation; either version 2.1 of the License, or (at your option)
19 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
20 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
21 * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
24 * You should have received a copy of the GNU Lesser General Public License
25 * along with wimlib; if not, see http://www.gnu.org/licenses/.
29 #include "wimlib_internal.h"
34 #include "lookup_table.h"
36 #include <ntfs-3g/layout.h>
37 #include <ntfs-3g/acls.h>
38 #include <ntfs-3g/attrib.h>
39 #include <ntfs-3g/misc.h>
40 #include <ntfs-3g/reparse.h>
41 #include <ntfs-3g/security.h>
42 #include <ntfs-3g/volume.h>
46 struct ntfs_apply_args {
52 extern int ntfs_inode_set_security(ntfs_inode *ni, u32 selection,
54 extern int ntfs_inode_set_attributes(ntfs_inode *ni, s32 attrib);
57 * Extracts a WIM resource to a NTFS attribute.
60 extract_wim_resource_to_ntfs_attr(const struct lookup_table_entry *lte,
63 u64 bytes_remaining = wim_resource_size(lte);
64 char buf[min(WIM_CHUNK_SIZE, bytes_remaining)];
67 u8 hash[SHA1_HASH_SIZE];
72 while (bytes_remaining) {
73 u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
74 ret = read_wim_resource(lte, buf, to_read, offset, false);
77 sha1_update(&ctx, buf, to_read);
78 if (ntfs_attr_pwrite(na, offset, to_read, buf) != to_read) {
79 ERROR_WITH_ERRNO("Error extracting WIM resource");
80 return WIMLIB_ERR_WRITE;
82 bytes_remaining -= to_read;
85 sha1_final(hash, &ctx);
86 if (!hashes_equal(hash, lte->hash)) {
87 ERROR("Invalid checksum on a WIM resource "
88 "(detected when extracting to NTFS stream)");
89 ERROR("The following WIM resource is invalid:");
90 print_lookup_table_entry(lte);
91 return WIMLIB_ERR_INVALID_RESOURCE_HASH;
96 /* Writes the data streams to a NTFS file
98 * @ni: The NTFS inode for the file.
99 * @dentry: The directory entry in the WIM file.
100 * @w: The WIMStruct for the WIM containing the image we are applying.
102 * Returns 0 on success, nonzero on failure.
104 static int write_ntfs_data_streams(ntfs_inode *ni, const struct dentry *dentry,
108 unsigned stream_idx = 0;
109 ntfschar *stream_name = AT_UNNAMED;
110 u32 stream_name_len = 0;
112 DEBUG("Writing %u NTFS data stream%s for `%s'",
114 (dentry->num_ads == 0 ? "" : "s"),
115 dentry->full_path_utf8);
118 struct lookup_table_entry *lte;
121 lte = dentry_stream_lte(dentry, stream_idx, w->lookup_table);
122 na = ntfs_attr_open(ni, AT_DATA, stream_name, stream_name_len);
124 ERROR_WITH_ERRNO("Failed to open a data stream of "
125 "extracted file `%s'",
126 dentry->full_path_utf8);
127 ret = WIMLIB_ERR_NTFS_3G;
131 ret = extract_wim_resource_to_ntfs_attr(lte, na);
135 if (stream_idx == dentry->num_ads)
137 stream_name = (ntfschar*)dentry->ads_entries[stream_idx].stream_name;
138 stream_name_len = dentry->ads_entries[stream_idx].stream_name_len / 2;
145 * Makes a NTFS hard link
147 * It is named @from_dentry->file_name and is located under the directory
148 * specified by @dir_ni, and it is made to point to the previously extracted
149 * file located at @to_dentry->extracted_file.
151 * Return 0 on success, nonzero on failure.
153 static int wim_apply_hardlink_ntfs(const struct dentry *from_dentry,
154 const struct dentry *to_dentry,
156 ntfs_inode **to_ni_ret)
161 wimlib_assert(dentry_is_regular_file(from_dentry)
162 && dentry_is_regular_file(to_dentry));
164 DEBUG("Extracting NTFS hard link `%s' => `%s'",
165 from_dentry->full_path_utf8, to_dentry->extracted_file);
167 to_ni = ntfs_pathname_to_inode(dir_ni->vol, NULL,
168 to_dentry->extracted_file);
170 ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
171 to_dentry->extracted_file);
172 return WIMLIB_ERR_NTFS_3G;
174 ret = ntfs_link(to_ni, dir_ni,
175 (ntfschar*)from_dentry->file_name,
176 from_dentry->file_name_len / 2);
178 ERROR_WITH_ERRNO("Could not create hard link `%s' => `%s'",
179 from_dentry->full_path_utf8,
180 to_dentry->extracted_file);
181 ret = WIMLIB_ERR_NTFS_3G;
188 apply_file_attributes_and_security_data(ntfs_inode *ni,
189 const struct dentry *dentry,
192 DEBUG("Setting NTFS file attributes on `%s' to %#"PRIx32,
193 dentry->full_path_utf8, dentry->attributes);
194 if (!ntfs_inode_set_attributes(ni, dentry->attributes)) {
195 ERROR("Failed to set NTFS file attributes on `%s'",
196 dentry->full_path_utf8);
197 return WIMLIB_ERR_NTFS_3G;
200 if (dentry->security_id != -1) {
201 const struct wim_security_data *sd;
203 sd = wim_const_security_data(w);
204 wimlib_assert(dentry->security_id < sd->num_entries);
205 DEBUG("Applying security descriptor %d to `%s'",
206 dentry->security_id, dentry->full_path_utf8);
207 u32 selection = OWNER_SECURITY_INFORMATION |
208 GROUP_SECURITY_INFORMATION |
209 DACL_SECURITY_INFORMATION |
210 SACL_SECURITY_INFORMATION;
212 if (!ntfs_inode_set_security(ni, selection,
213 sd->descriptors[dentry->security_id]))
215 ERROR_WITH_ERRNO("Failed to set security data on `%s'",
216 dentry->full_path_utf8);
217 return WIMLIB_ERR_NTFS_3G;
223 static int apply_reparse_data(ntfs_inode *ni, const struct dentry *dentry,
226 struct lookup_table_entry *lte;
229 wimlib_assert(dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
231 lte = dentry_first_lte(dentry, w->lookup_table);
233 DEBUG("Applying reparse data to `%s'", dentry->full_path_utf8);
236 ERROR("Could not find reparse data for `%s'",
237 dentry->full_path_utf8);
238 return WIMLIB_ERR_INVALID_DENTRY;
241 if (wim_resource_size(lte) >= 0xffff) {
242 ERROR("Reparse data of `%s' is too long (%lu bytes)",
243 dentry->full_path_utf8, wim_resource_size(lte));
244 return WIMLIB_ERR_INVALID_DENTRY;
247 char reparse_data_buf[8 + wim_resource_size(lte)];
248 char *p = reparse_data_buf;
249 p = put_u32(p, dentry->reparse_tag); /* ReparseTag */
250 p = put_u16(p, wim_resource_size(lte)); /* ReparseDataLength */
251 p = put_u16(p, 0); /* Reserved */
253 ret = read_full_wim_resource(lte, p);
257 ret = ntfs_set_ntfs_reparse_data(ni, reparse_data_buf,
258 wim_resource_size(lte) + 8, 0);
260 ERROR_WITH_ERRNO("Failed to set NTFS reparse data on `%s'",
261 dentry->full_path_utf8);
262 return WIMLIB_ERR_NTFS_3G;
267 static int do_wim_apply_dentry_ntfs(struct dentry *dentry, ntfs_inode *dir_ni,
271 * If @dentry is part of a hard link group, search for hard-linked dentries in
272 * the same directory that have a nonempty DOS (short) filename. There should
273 * be exactly 0 or 1 such dentries. If there is 1, extract that dentry first,
274 * so that the DOS name is correctly associated with the corresponding long name
275 * in the Win32 namespace, and not any of the additional names in the POSIX
276 * namespace created from hard links.
278 static int preapply_dentry_with_dos_name(struct dentry *dentry,
279 ntfs_inode **dir_ni_p,
283 struct dentry *other;
284 struct dentry *dentry_with_dos_name;
286 if (dentry->link_group_list.next == &dentry->link_group_list)
289 dentry_with_dos_name = NULL;
290 list_for_each_entry(other, &dentry->link_group_list,
293 if (dentry->parent == other->parent && other->short_name_len) {
294 if (dentry_with_dos_name) {
295 ERROR("Found multiple DOS names for file `%s' "
296 "in the same directory",
297 dentry_with_dos_name->full_path_utf8);
298 return WIMLIB_ERR_INVALID_DENTRY;
300 dentry_with_dos_name = other;
303 /* If there's a dentry with a DOS name, extract it first */
304 if (dentry_with_dos_name && !dentry_with_dos_name->extracted_file) {
306 const char *dir_name;
308 ntfs_volume *vol = (*dir_ni_p)->vol;
310 DEBUG("pre-applying DOS name `%s'",
311 dentry_with_dos_name->full_path_utf8);
312 ret = do_wim_apply_dentry_ntfs(dentry_with_dos_name,
316 p = dentry->full_path_utf8 + dentry->full_path_utf8_len;
323 dir_name = dentry->full_path_utf8;
325 *dir_ni_p = ntfs_pathname_to_inode(vol, NULL, dir_name);
328 ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
330 return WIMLIB_ERR_NTFS_3G;
337 * Applies a WIM dentry to a NTFS filesystem.
339 * @dentry: The WIM dentry to apply
340 * @dir_ni: The NTFS inode for the parent directory
341 * @w: The WIMStruct for the WIM containing the image we are applying.
343 * @return: 0 on success; nonzero on failure.
345 static int do_wim_apply_dentry_ntfs(struct dentry *dentry, ntfs_inode *dir_ni,
350 ntfs_inode *ni = NULL;
351 bool is_hardlink = false;
352 ntfs_volume *vol = dir_ni->vol;
354 if (dentry->attributes & FILE_ATTRIBUTE_DIRECTORY) {
357 struct dentry *other;
359 /* Apply hard-linked directory in same directory with DOS name
360 * (if there is one) before this dentry */
361 ret = preapply_dentry_with_dos_name(dentry, &dir_ni, w);
366 /* See if we can make a hard link */
367 list_for_each_entry(other, &dentry->link_group_list,
369 if (other->extracted_file) {
370 /* Already extracted another dentry in the hard
371 * link group. We can make a hard link instead
372 * of extracting the file data. */
373 ret = wim_apply_hardlink_ntfs(dentry, other,
377 goto out_close_dir_ni;
379 goto out_set_dos_name;
382 /* Can't make a hard link; extract the file itself */
383 FREE(dentry->extracted_file);
384 dentry->extracted_file = STRDUP(dentry->full_path_utf8);
385 if (!dentry->extracted_file) {
386 ERROR("Failed to allocate memory for filename");
387 return WIMLIB_ERR_NOMEM;
392 * Create a directory or file.
394 * Note: For symbolic links that are not directory junctions, pass
395 * S_IFREG here, since we manually set the reparse data later.
397 ni = ntfs_create(dir_ni, 0, (ntfschar*)dentry->file_name,
398 dentry->file_name_len / 2, type);
401 ERROR_WITH_ERRNO("Could not create NTFS object for `%s'",
402 dentry->full_path_utf8);
403 ret = WIMLIB_ERR_NTFS_3G;
404 goto out_close_dir_ni;
407 /* Write the data streams, unless this is a directory or reparse point
409 if (!dentry_is_directory(dentry) &&
410 !(dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT)) {
411 ret = write_ntfs_data_streams(ni, dentry, w);
413 goto out_close_dir_ni;
417 ret = apply_file_attributes_and_security_data(ni, dentry, w);
419 goto out_close_dir_ni;
421 if (dentry->attributes & FILE_ATTR_REPARSE_POINT) {
422 ret = apply_reparse_data(ni, dentry, w);
424 goto out_close_dir_ni;
428 /* Set DOS (short) name if given */
429 if (dentry->short_name_len != 0) {
431 char *short_name_utf8;
432 size_t short_name_utf8_len;
433 short_name_utf8 = utf16_to_utf8(dentry->short_name,
434 dentry->short_name_len,
435 &short_name_utf8_len);
436 if (!short_name_utf8) {
437 ERROR("Out of memory");
438 ret = WIMLIB_ERR_NOMEM;
439 goto out_close_dir_ni;
445 const char *dir_name;
447 /* ntfs_set_ntfs_dos_name() closes the inodes in the
448 * wrong order if we have applied a hard link. Close
449 * them ourselves, then re-open then. */
450 if (ntfs_inode_close(dir_ni) != 0) {
452 ret = WIMLIB_ERR_NTFS_3G;
453 ERROR_WITH_ERRNO("Failed to close directory inode");
455 if (ntfs_inode_close(ni) != 0) {
457 ret = WIMLIB_ERR_NTFS_3G;
458 ERROR_WITH_ERRNO("Failed to close hard link target inode");
460 p = dentry->full_path_utf8 + dentry->full_path_utf8_len;
467 dir_name = dentry->full_path_utf8;
469 dir_ni = ntfs_pathname_to_inode(vol, NULL, dir_name);
472 ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
474 return WIMLIB_ERR_NTFS_3G;
476 ni = ntfs_pathname_to_inode(vol, dir_ni,
477 dentry->file_name_utf8);
479 ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
481 return WIMLIB_ERR_NTFS_3G;
485 DEBUG("Setting short (DOS) name of `%s' to %s",
486 dentry->full_path_utf8, short_name_utf8);
488 ret = ntfs_set_ntfs_dos_name(ni, dir_ni, short_name_utf8,
489 short_name_utf8_len, 0);
490 FREE(short_name_utf8);
492 ERROR_WITH_ERRNO("Could not set DOS (short) name for `%s'",
493 dentry->full_path_utf8);
494 ret = WIMLIB_ERR_NTFS_3G;
496 /* inodes have been closed by ntfs_set_ntfs_dos_name(). */
501 if (ntfs_inode_close(dir_ni) != 0) {
503 ret = WIMLIB_ERR_NTFS_3G;
504 ERROR_WITH_ERRNO("Failed to close directory inode");
507 if (ni && ntfs_inode_close(ni) != 0) {
509 ret = WIMLIB_ERR_NTFS_3G;
510 ERROR_WITH_ERRNO("Failed to close inode");
515 static int wim_apply_root_dentry_ntfs(const struct dentry *dentry,
522 wimlib_assert(dentry_is_directory(dentry));
523 ni = ntfs_pathname_to_inode(vol, NULL, "/");
525 ERROR_WITH_ERRNO("Could not find root NTFS inode");
526 return WIMLIB_ERR_NTFS_3G;
528 ret = apply_file_attributes_and_security_data(ni, dentry, w);
529 if (ntfs_inode_close(ni) != 0) {
530 ERROR_WITH_ERRNO("Failed to close NTFS inode for root "
532 ret = WIMLIB_ERR_NTFS_3G;
537 /* Applies a WIM dentry to the NTFS volume */
538 static int wim_apply_dentry_ntfs(struct dentry *dentry, void *arg)
540 struct ntfs_apply_args *args = arg;
541 ntfs_volume *vol = args->vol;
542 int extract_flags = args->extract_flags;
543 WIMStruct *w = args->w;
548 ntfs_inode *close_after_dir;
549 const char *dir_name;
551 if (dentry->extracted_file)
554 wimlib_assert(dentry->full_path_utf8);
556 DEBUG("Applying dentry `%s' to NTFS", dentry->full_path_utf8);
558 if (extract_flags & WIMLIB_EXTRACT_FLAG_VERBOSE)
559 puts(dentry->full_path_utf8);
561 if (dentry_is_root(dentry))
562 return wim_apply_root_dentry_ntfs(dentry, vol, w);
564 p = dentry->full_path_utf8 + dentry->full_path_utf8_len;
571 dir_name = dentry->full_path_utf8;
573 dir_ni = ntfs_pathname_to_inode(vol, NULL, dir_name);
575 DEBUG("Found NTFS inode for `%s'", dir_name);
578 ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
580 return WIMLIB_ERR_NTFS_3G;
582 return do_wim_apply_dentry_ntfs(dentry, dir_ni, w);
585 static int wim_apply_dentry_timestamps(struct dentry *dentry, void *arg)
587 struct ntfs_apply_args *args = arg;
588 ntfs_volume *vol = args->vol;
589 int extract_flags = args->extract_flags;
590 WIMStruct *w = args->w;
597 DEBUG("Setting timestamps on `%s'", dentry->full_path_utf8);
599 ni = ntfs_pathname_to_inode(vol, NULL, dentry->full_path_utf8);
601 ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
602 dentry->full_path_utf8);
603 return WIMLIB_ERR_NTFS_3G;
607 p = put_u64(p, dentry->creation_time);
608 p = put_u64(p, dentry->last_write_time);
609 p = put_u64(p, dentry->last_access_time);
610 ret = ntfs_inode_set_times(ni, buf, 3 * sizeof(u64), 0);
612 ERROR_WITH_ERRNO("Failed to set NTFS timestamps on `%s'",
613 dentry->full_path_utf8);
614 ret = WIMLIB_ERR_NTFS_3G;
617 if (ntfs_inode_close(ni) != 0) {
619 ret = WIMLIB_ERR_NTFS_3G;
620 ERROR_WITH_ERRNO("Failed to close NTFS inode for `%s'",
621 dentry->full_path_utf8);
626 static int do_wim_apply_image_ntfs(WIMStruct *w, const char *device, int extract_flags)
631 DEBUG("Mounting NTFS volume `%s'", device);
632 vol = ntfs_mount(device, 0);
634 ERROR_WITH_ERRNO("Failed to mount NTFS volume `%s'", device);
635 return WIMLIB_ERR_NTFS_3G;
637 struct ntfs_apply_args args = {
639 .extract_flags = extract_flags,
642 ret = for_dentry_in_tree(wim_root_dentry(w), wim_apply_dentry_ntfs,
647 DEBUG("Setting NTFS timestamps");
648 ret = for_dentry_in_tree_depth(wim_root_dentry(w),
649 wim_apply_dentry_timestamps,
652 DEBUG("Unmounting NTFS volume `%s'", device);
653 if (ntfs_umount(vol, FALSE) != 0) {
654 ERROR_WITH_ERRNO("Failed to unmount NTFS volume `%s'", device);
656 ret = WIMLIB_ERR_NTFS_3G;
663 * API entry point for applying a WIM image to a NTFS volume.
665 * Please note that this is a NTFS *volume* and not a directory. The intention
666 * is that the volume contain an empty filesystem, and the WIM image contain a
667 * full filesystem to be applied to the volume.
669 WIMLIBAPI int wimlib_apply_image_to_ntfs_volume(WIMStruct *w, int image,
670 const char *device, int flags)
675 return WIMLIB_ERR_INVALID_PARAM;
676 if (image == WIM_ALL_IMAGES) {
677 ERROR("Can only apply a single image when applying "
678 "directly to a NTFS volume");
679 return WIMLIB_ERR_INVALID_PARAM;
681 if (flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK)) {
682 ERROR("Cannot specify symlink or hardlink flags when applying ");
683 ERROR("directly to a NTFS volume");
684 return WIMLIB_ERR_INVALID_PARAM;
686 ret = wimlib_select_image(w, image);
692 ERROR("We are not root, but NTFS-3g requires root privileges to set arbitrary");
693 ERROR("security data on the NTFS filesystem. Please run this program as root");
694 ERROR("if you want to extract a WIM image while preserving NTFS-specific");
695 ERROR("information.");
697 return WIMLIB_ERR_NOT_ROOT;
700 return do_wim_apply_image_ntfs(w, device, flags);
703 #else /* WITH_NTFS_3G */
704 WIMLIBAPI int wimlib_apply_image_to_ntfs_volume(WIMStruct *w, int image,
705 const char *device, int flags)
707 ERROR("wimlib was compiled without support for NTFS-3g, so");
708 ERROR("we cannot apply a WIM image directly to a NTFS volume");
709 return WIMLIB_ERR_UNSUPPORTED;
711 #endif /* WITH_NTFS_3G */