4 * Apply a WIM image to a NTFS volume. Restore as much information as possible,
5 * including security data, file attributes, DOS names, and alternate data
10 * Copyright (C) 2012, 2013 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 General Public License as published by the Free
16 * Software Foundation; either version 3 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 General Public License for more
24 * You should have received a copy of the GNU General Public License
25 * along with wimlib; if not, see http://www.gnu.org/licenses/.
31 #include <ntfs-3g/endians.h>
32 #include <ntfs-3g/types.h>
34 #include "wimlib_internal.h"
35 #include "buffer_io.h"
37 #include "lookup_table.h"
39 #include <ntfs-3g/attrib.h>
40 #include <ntfs-3g/security.h> /* security.h before xattrs.h */
41 #include <ntfs-3g/reparse.h>
42 #include <ntfs-3g/xattrs.h>
46 struct ntfs_attr_extract_ctx {
52 extract_wim_chunk_to_ntfs_attr(const void *buf, size_t len, void *_ctx)
54 struct ntfs_attr_extract_ctx *ctx = _ctx;
55 if (ntfs_attr_pwrite(ctx->na, ctx->offset, len, buf) == len) {
59 ERROR_WITH_ERRNO("Error extracting WIM resource to NTFS attribute");
60 return WIMLIB_ERR_WRITE;
65 * Extracts a WIM resource to a NTFS attribute.
68 extract_wim_resource_to_ntfs_attr(const struct wim_lookup_table_entry *lte,
71 struct ntfs_attr_extract_ctx ctx;
74 return extract_wim_resource(lte, wim_resource_size(lte),
75 extract_wim_chunk_to_ntfs_attr, &ctx);
78 /* Writes the data streams of a WIM inode to the data attributes of a NTFS
81 * @ni: The NTFS inode to which the streams are to be extracted.
83 * @dentry: The WIM dentry being extracted. The @d_inode member points to the
84 * corresponding WIM inode that contains the streams being extracted.
85 * The WIM dentry itself is only needed to provide a file path for
86 * better error messages.
88 * @progress_info: Progress information for the image application. The number
89 * of extracted bytes will be incremented by the uncompressed
90 * size of each stream extracted.
92 * Returns 0 on success, nonzero on failure.
95 write_ntfs_data_streams(ntfs_inode *ni, struct wim_dentry *dentry,
96 union wimlib_progress_info *progress_info)
99 unsigned stream_idx = 0;
100 ntfschar *stream_name = AT_UNNAMED;
101 u32 stream_name_nbytes = 0;
102 const struct wim_inode *inode = dentry->d_inode;
103 struct wim_lookup_table_entry *lte;
105 DEBUG("Writing %u NTFS data stream%s for `%s'",
106 inode->i_num_ads + 1,
107 (inode->i_num_ads == 0 ? "" : "s"),
108 dentry_full_path(dentry));
112 if (stream_name_nbytes) {
113 /* Skip special UNIX data entries (see documentation for
114 * WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) */
115 if (stream_name_nbytes == WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES
116 && !memcmp(stream_name,
117 WIMLIB_UNIX_DATA_TAG_UTF16LE,
118 WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES))
121 /* Create an empty named stream. */
122 ret = ntfs_attr_add(ni, AT_DATA, stream_name,
123 stream_name_nbytes / 2, NULL, 0);
125 ERROR_WITH_ERRNO("Failed to create named data "
126 "stream for extracted file "
128 dentry_full_path(dentry));
129 ret = WIMLIB_ERR_NTFS_3G;
135 /* If there's no lookup table entry, it's an empty stream.
136 * Otherwise, open the attribute and extract the data. */
140 na = ntfs_attr_open(ni, AT_DATA, stream_name,
141 stream_name_nbytes / 2);
143 ERROR_WITH_ERRNO("Failed to open a data stream of "
144 "extracted file `%s'",
145 dentry_full_path(dentry));
146 ret = WIMLIB_ERR_NTFS_3G;
150 /* The WIM lookup table entry provides the stream
151 * length, so the NTFS attribute should be resized to
152 * this length before starting to extract the data. */
153 ret = ntfs_attr_truncate_solid(na, wim_resource_size(lte));
159 /* Actually extract the stream */
160 ret = extract_wim_resource_to_ntfs_attr(lte, na);
162 /* Close the attribute */
167 /* Record the number of bytes of uncompressed data that
168 * have been extracted. */
169 progress_info->extract.completed_bytes += wim_resource_size(lte);
172 if (stream_idx == inode->i_num_ads) /* Has the last stream been extracted? */
175 /* Get the name and lookup table entry for the next stream. */
176 stream_name = inode->i_ads_entries[stream_idx].stream_name;
177 stream_name_nbytes = inode->i_ads_entries[stream_idx].stream_name_nbytes;
178 lte = inode->i_ads_entries[stream_idx].lte;
184 /* Open the NTFS inode that corresponds to the parent of a WIM dentry. Returns
185 * the opened inode, or NULL on failure. */
187 dentry_open_parent_ni(struct wim_dentry *dentry, ntfs_volume *vol)
190 const char *dir_name;
194 if (!dentry_full_path(dentry))
197 p = dentry->_full_path + dentry->full_path_nbytes;
204 dir_name = dentry->_full_path;
205 dir_ni = ntfs_pathname_to_inode(vol, NULL, dir_name);
207 ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
215 * Makes a NTFS hard link.
217 * The hard link is named @from_dentry->file_name and is located under the
218 * directory specified by @dir_ni, and it is made to point to the previously
219 * extracted file located at @inode->i_extracted_file.
221 * Or, in other words, this adds a new name @from_dentry->full_path to an
222 * existing NTFS inode which already has a name @inode->i_extracted_file.
224 * The new name is made in the POSIX namespace (this is the behavior of
227 * Return 0 on success, nonzero on failure. dir_ni is closed either way.
230 apply_ntfs_hardlink(struct wim_dentry *from_dentry,
231 const struct wim_inode *inode,
239 ret = ntfs_inode_close(dir_ni);
241 ERROR_WITH_ERRNO("Error closing directory");
242 return WIMLIB_ERR_NTFS_3G;
245 DEBUG("Extracting NTFS hard link `%s' => `%s'",
246 dentry_full_path(from_dentry), inode->i_extracted_file);
248 to_ni = ntfs_pathname_to_inode(vol, NULL, inode->i_extracted_file);
250 ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
251 inode->i_extracted_file);
252 return WIMLIB_ERR_NTFS_3G;
255 dir_ni = dentry_open_parent_ni(from_dentry, vol);
257 ntfs_inode_close(to_ni);
258 return WIMLIB_ERR_NTFS_3G;
261 ret = ntfs_link(to_ni, dir_ni,
262 from_dentry->file_name,
263 from_dentry->file_name_nbytes / 2);
264 ret |= ntfs_inode_close(dir_ni);
265 ret |= ntfs_inode_close(to_ni);
267 ERROR_WITH_ERRNO("Could not create hard link `%s' => `%s'",
268 dentry_full_path(from_dentry),
269 inode->i_extracted_file);
270 ret = WIMLIB_ERR_NTFS_3G;
275 /* Transfers file attributes and possibly a security descriptor from a WIM inode
278 * @ni: The NTFS inode to apply the metadata to.
279 * @dir_ni: The NTFS inode for a directory containing @ni.
280 * @dentry: The WIM dentry whose inode contains the metadata to apply.
281 * @w: The WIMStruct for the WIM, through which the table of security
282 * descriptors can be accessed.
284 * Returns 0 on success, nonzero on failure.
287 apply_file_attributes_and_security_data(ntfs_inode *ni,
289 struct wim_dentry *dentry,
294 struct SECURITY_CONTEXT ctx;
296 const struct wim_inode *inode;
298 inode = dentry->d_inode;
300 DEBUG("Setting NTFS file attributes on `%s' to %#"PRIx32,
301 dentry_full_path(dentry), inode->i_attributes);
303 attributes_le32 = cpu_to_le32(inode->i_attributes);
304 memset(&ctx, 0, sizeof(ctx));
306 ret = ntfs_xattr_system_setxattr(&ctx, XATTR_NTFS_ATTRIB,
308 (const char*)&attributes_le32,
311 ERROR("Failed to set NTFS file attributes on `%s'",
312 dentry_full_path(dentry));
313 return WIMLIB_ERR_NTFS_3G;
315 if (inode->i_security_id != -1 &&
316 !(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
319 const struct wim_security_data *sd;
321 sd = wim_const_security_data(w);
322 wimlib_assert(inode->i_security_id < sd->num_entries);
323 desc = (const char *)sd->descriptors[inode->i_security_id];
324 DEBUG("Applying security descriptor %d to `%s'",
325 inode->i_security_id, dentry_full_path(dentry));
327 ret = ntfs_xattr_system_setxattr(&ctx, XATTR_NTFS_ACL,
329 sd->sizes[inode->i_security_id], 0);
332 ERROR_WITH_ERRNO("Failed to set security data on `%s'",
333 dentry_full_path(dentry));
334 return WIMLIB_ERR_NTFS_3G;
341 * Transfers the reparse data from a WIM inode (which must represent a reparse
342 * point) to a NTFS inode.
345 apply_reparse_data(ntfs_inode *ni, struct wim_dentry *dentry,
346 union wimlib_progress_info *progress_info)
348 struct wim_lookup_table_entry *lte;
351 lte = inode_unnamed_lte_resolved(dentry->d_inode);
353 DEBUG("Applying reparse data to `%s'", dentry_full_path(dentry));
356 ERROR("Could not find reparse data for `%s'",
357 dentry_full_path(dentry));
358 return WIMLIB_ERR_INVALID_DENTRY;
361 if (wim_resource_size(lte) >= 0xffff) {
362 ERROR("Reparse data of `%s' is too long (%"PRIu64" bytes)",
363 dentry_full_path(dentry), wim_resource_size(lte));
364 return WIMLIB_ERR_INVALID_DENTRY;
367 u8 reparse_data_buf[8 + wim_resource_size(lte)];
368 u8 *p = reparse_data_buf;
369 p = put_u32(p, dentry->d_inode->i_reparse_tag); /* ReparseTag */
370 DEBUG("ReparseTag = %#x", dentry->d_inode->i_reparse_tag);
371 p = put_u16(p, wim_resource_size(lte)); /* ReparseDataLength */
372 p = put_u16(p, 0); /* Reserved */
374 ret = read_full_resource_into_buf(lte, p, false);
378 ret = ntfs_set_ntfs_reparse_data(ni, (char*)reparse_data_buf,
379 wim_resource_size(lte) + 8, 0);
381 ERROR_WITH_ERRNO("Failed to set NTFS reparse data on `%s'",
382 dentry_full_path(dentry));
383 return WIMLIB_ERR_NTFS_3G;
385 progress_info->extract.completed_bytes += wim_resource_size(lte);
390 * Applies a WIM dentry to a NTFS filesystem.
392 * @dentry: The WIM dentry to apply
393 * @dir_ni: The NTFS inode for the parent directory
395 * @return: 0 on success; nonzero on failure.
398 do_apply_dentry_ntfs(struct wim_dentry *dentry, ntfs_inode *dir_ni,
399 struct apply_args *args)
403 ntfs_inode *ni = NULL;
404 struct wim_inode *inode = dentry->d_inode;
405 dentry->is_extracted = 1;
407 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
411 if (inode->i_nlink > 1) {
412 /* Inode has multiple dentries referencing it. */
413 if (inode->i_extracted_file) {
414 /* Already extracted another dentry in the hard
415 * link group. Make a hard link instead of
416 * extracting the file data. */
417 ret = apply_ntfs_hardlink(dentry, inode, dir_ni);
418 /* dir_ni was closed */
421 /* None of the dentries of this inode have been
422 * extracted yet, so go ahead and extract the
424 FREE(inode->i_extracted_file);
425 const tchar *full_path = dentry_full_path(dentry);
428 !(inode->i_extracted_file = STRDUP(full_path)))
430 ret = WIMLIB_ERR_NOMEM;
431 goto out_close_dir_ni;
437 /* Create a NTFS directory or file.
439 * Note: For symbolic links that are not directory junctions, S_IFREG is
440 * passed here, since the reparse data and file attributes are set
442 ni = ntfs_create(dir_ni, 0, dentry->file_name,
443 dentry->file_name_nbytes / 2, type);
446 ERROR_WITH_ERRNO("Could not create NTFS inode for `%s'",
447 dentry_full_path(dentry));
448 ret = WIMLIB_ERR_NTFS_3G;
449 goto out_close_dir_ni;
452 /* Write the data streams, unless this is a directory or reparse point
454 if (!(inode->i_attributes & (FILE_ATTRIBUTE_REPARSE_POINT |
455 FILE_ATTRIBUTE_DIRECTORY))) {
456 ret = write_ntfs_data_streams(ni, dentry, &args->progress);
458 goto out_close_dir_ni;
461 ret = apply_file_attributes_and_security_data(ni, dir_ni, dentry,
463 args->extract_flags);
465 goto out_close_dir_ni;
467 if (inode->i_attributes & FILE_ATTR_REPARSE_POINT) {
468 ret = apply_reparse_data(ni, dentry, &args->progress);
470 goto out_close_dir_ni;
473 /* Set DOS (short) name if given */
474 if (dentry_has_short_name(dentry)) {
475 char *short_name_mbs;
476 size_t short_name_mbs_nbytes;
477 ret = utf16le_to_tstr(dentry->short_name,
478 dentry->short_name_nbytes,
480 &short_name_mbs_nbytes);
482 goto out_close_dir_ni;
484 DEBUG("Setting short (DOS) name of `%s' to %s",
485 dentry_full_path(dentry), short_name_mbs);
487 ret = ntfs_set_ntfs_dos_name(ni, dir_ni, short_name_mbs,
488 short_name_mbs_nbytes, 0);
489 FREE(short_name_mbs);
491 ERROR_WITH_ERRNO("Could not set DOS (short) name for `%s'",
492 dentry_full_path(dentry));
493 ret = WIMLIB_ERR_NTFS_3G;
495 /* inodes have been closed by ntfs_set_ntfs_dos_name(). */
501 if (ntfs_inode_close_in_dir(ni, dir_ni)) {
503 ret = WIMLIB_ERR_NTFS_3G;
504 ERROR_WITH_ERRNO("Failed to close inode for `%s'",
505 dentry_full_path(dentry));
508 if (ntfs_inode_close(dir_ni)) {
510 ret = WIMLIB_ERR_NTFS_3G;
511 ERROR_WITH_ERRNO("Failed to close inode of directory "
513 dentry_full_path(dentry));
521 apply_root_dentry_ntfs(struct wim_dentry *dentry,
522 ntfs_volume *vol, const WIMStruct *w,
528 ni = ntfs_pathname_to_inode(vol, NULL, "/");
530 ERROR_WITH_ERRNO("Could not find root NTFS inode");
531 return WIMLIB_ERR_NTFS_3G;
533 ret = apply_file_attributes_and_security_data(ni, ni, dentry, w,
535 if (ntfs_inode_close(ni) != 0) {
536 ERROR_WITH_ERRNO("Failed to close NTFS inode for root "
538 ret = WIMLIB_ERR_NTFS_3G;
543 /* Applies a WIM dentry to the NTFS volume */
545 apply_dentry_ntfs(struct wim_dentry *dentry, void *arg)
547 struct apply_args *args = arg;
548 ntfs_volume *vol = args->vol;
549 WIMStruct *w = args->w;
550 struct wim_dentry *orig_dentry;
551 struct wim_dentry *other;
554 /* Treat the root dentry specially. */
555 if (dentry_is_root(dentry))
556 return apply_root_dentry_ntfs(dentry, vol, w,
557 args->extract_flags);
559 /* NTFS filename namespaces need careful consideration. A name for a
560 * NTFS file may be in either the POSIX, Win32, DOS, or Win32+DOS
561 * namespaces. A NTFS file (a.k.a. inode) may have multiple names in
562 * multiple directories (i.e. hard links); however, a NTFS file can have
563 * at most 1 DOS name total. Furthermore, a Win32 name is always
564 * associated with a DOS name (either as a Win32+DOS name, or a Win32
565 * name and a DOS name separately), which implies that a NTFS file can
566 * have at most 1 Win32 name.
568 * A WIM dentry just contains a "long name", which wimlib makes sure is
569 * non-empty, and a "short name", which may be empty. So, wimlib must
570 * map these to the correct NTFS names. wimlib collects all WIM
571 * dentries that map to the same NTFS inode and factors out the common
572 * information into a 'struct wim_inode', so this should make the
573 * mapping a little more obvious. As a NTFS file can have at most 1 DOS
574 * name, a WIM inode cannot have more than 1 dentry with a non-empty
575 * short name, and this is checked in the verify_inode() function in
576 * verify.c. Furthermore, a WIM dentry, if any, that has a DOS name
577 * must have a long name that corresponds to a Win32 name or Win32+DOS
580 * WIM dentries that have a long name but no associated short name are
581 * assumed to be in the POSIX namespace.
583 * So, given a WIM inode that is to map to a NTFS inode, we must apply
584 * the Win32 and DOS or Win32+DOS names, if they exist, then any
585 * additional (POSIX) names. A caveat when actually doing this: as
586 * confirmed by the libntfs-3g authors, ntfs_set_ntfs_dos_name() is only
587 * guaranteed to associate a DOS name with the appropriate long name if
588 * it's called when that long name is the only one in existence for that
589 * file. So, this implies that the correct ordering of function calls
590 * to extract a NTFS file are:
592 * if (file has a DOS name) {
593 * - Call ntfs_create() to create long name associated with
594 * the DOS name (this initially creates a POSIX name)
595 * - Call ntfs_set_ntfs_dos_name() to associate a DOS name
596 * with the long name just created. This either changes
597 * the POSIX name to Win32+DOS, or changes the POSIX name
598 * to Win32 and creates a separate DOS name.
600 * - Call ntfs_create() to create the first link to the
601 * file in the POSIX namespace
603 * - Call ntfs_link() to create the other names of the file, in the
608 if (!dentry->d_inode->i_dos_name_extracted &&
609 !dentry_has_short_name(dentry))
611 inode_for_each_dentry(other, dentry->d_inode) {
612 if (dentry_has_short_name(other)) {
613 orig_dentry = dentry;
619 dentry->d_inode->i_dos_name_extracted = 1;
620 ntfs_inode *dir_ni = dentry_open_parent_ni(dentry, vol);
622 ret = do_apply_dentry_ntfs(dentry, dir_ni, arg);
623 if (ret == 0 && orig_dentry != NULL) {
624 dentry = orig_dentry;
628 ret = WIMLIB_ERR_NTFS_3G;
633 /* Transfers the 100-nanosecond precision timestamps from a WIM dentry to a NTFS
636 apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg)
638 struct apply_args *args = arg;
639 ntfs_volume *vol = args->vol;
645 DEBUG("Setting timestamps on `%s'", dentry_full_path(dentry));
647 ni = ntfs_pathname_to_inode(vol, NULL, dentry_full_path(dentry));
649 ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
650 dentry_full_path(dentry));
651 return WIMLIB_ERR_NTFS_3G;
655 p = put_u64(p, dentry->d_inode->i_creation_time);
656 p = put_u64(p, dentry->d_inode->i_last_write_time);
657 p = put_u64(p, dentry->d_inode->i_last_access_time);
658 ret = ntfs_inode_set_times(ni, (const char*)buf, 3 * sizeof(u64), 0);
660 ERROR_WITH_ERRNO("Failed to set NTFS timestamps on `%s'",
661 dentry_full_path(dentry));
662 ret = WIMLIB_ERR_NTFS_3G;
665 if (ntfs_inode_close(ni) != 0) {
667 ret = WIMLIB_ERR_NTFS_3G;
668 ERROR_WITH_ERRNO("Failed to close NTFS inode for `%s'",
669 dentry_full_path(dentry));
675 libntfs3g_global_init()
677 ntfs_set_char_encoding(setlocale(LC_ALL, ""));