4 * Apply a WIM image directly to an NTFS volume using libntfs-3g. Restore as
5 * much information as possible, including security data, file attributes, DOS
6 * names, alternate data streams, and object IDs.
8 * Note: because NTFS-3G offers inode-based interfaces, we actually don't need
9 * to deal with paths at all! (Other than for error messages.)
13 * Copyright (C) 2012-2016 Eric Biggers
15 * This file is free software; you can redistribute it and/or modify it under
16 * the terms of the GNU Lesser General Public License as published by the Free
17 * Software Foundation; either version 3 of the License, or (at your option) any
20 * This file is distributed in the hope that it will be useful, but WITHOUT
21 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
22 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
25 * You should have received a copy of the GNU Lesser General Public License
26 * along with this file; if not, see http://www.gnu.org/licenses/.
37 #include <ntfs-3g/attrib.h>
38 #include <ntfs-3g/object_id.h>
39 #include <ntfs-3g/reparse.h>
40 #include <ntfs-3g/security.h>
42 #include "wimlib/assert.h"
43 #include "wimlib/apply.h"
44 #include "wimlib/blob_table.h"
45 #include "wimlib/dentry.h"
46 #include "wimlib/encoding.h"
47 #include "wimlib/error.h"
48 #include "wimlib/metadata.h"
49 #include "wimlib/ntfs_3g.h"
50 #include "wimlib/object_id.h"
51 #include "wimlib/reparse.h"
52 #include "wimlib/security.h"
53 #include "wimlib/security_descriptor.h"
56 ntfs_3g_get_supported_features(const char *target,
57 struct wim_features *supported_features)
59 supported_features->readonly_files = 1;
60 supported_features->hidden_files = 1;
61 supported_features->system_files = 1;
62 supported_features->archive_files = 1;
63 supported_features->compressed_files = 1;
64 supported_features->not_context_indexed_files = 1;
65 supported_features->named_data_streams = 1;
66 supported_features->hard_links = 1;
67 supported_features->reparse_points = 1;
68 supported_features->security_descriptors = 1;
69 supported_features->short_names = 1;
70 supported_features->object_ids = 1;
71 supported_features->timestamps = 1;
72 supported_features->case_sensitive_filenames = 1;
76 struct ntfs_3g_apply_ctx {
77 /* Extract flags, the pointer to the WIMStruct, etc. */
78 struct apply_ctx common;
80 /* Pointer to the open NTFS volume */
83 ntfs_attr *open_attrs[MAX_OPEN_FILES];
84 unsigned num_open_attrs;
85 ntfs_inode *open_inodes[MAX_OPEN_FILES];
86 unsigned num_open_inodes;
88 struct reparse_buffer_disk rpbuf;
91 /* Offset in the blob currently being read */
94 unsigned num_reparse_inodes;
95 ntfs_inode *ntfs_reparse_inodes[MAX_OPEN_FILES];
96 struct wim_inode *wim_reparse_inodes[MAX_OPEN_FILES];
100 sid_size(const wimlib_SID *sid)
102 return offsetof(wimlib_SID, sub_authority) +
103 sizeof(le32) * sid->sub_authority_count;
107 * sd_fixup - Fix up a Windows NT security descriptor for libntfs-3g.
109 * libntfs-3g validates security descriptors before setting them, but old
110 * versions contain bugs causing it to reject unusual but valid security
113 * - Versions before 2013.1.13 reject security descriptors ending with an empty
114 * SACL (System Access Control List). This bug can be worked around either by
115 * moving the empty SACL earlier in the security descriptor or by removing the
116 * SACL entirely. The latter work-around is valid because an empty SACL is
117 * equivalent to a "null", or non-existent, SACL.
118 * - Versions before 2014.2.15 reject security descriptors ending with an empty
119 * DACL (Discretionary Access Control List). This is very similar to the SACL
120 * bug. However, removing the DACL is not a valid workaround because this
121 * changes the meaning of the security descriptor--- an empty DACL allows no
122 * access, whereas a "null" DACL allows all access.
123 * - Versions before 2016.2.22 reject security descriptors containing SIDs with
124 * too many subauthorities. We do not work around this.
126 * If the security descriptor was fixed, this function returns an allocated
127 * buffer containing the fixed security descriptor, and its size is updated.
128 * Otherwise (or if no memory is available) NULL is returned.
131 sd_fixup(const void *_desc, size_t *size_p)
133 u32 owner_offset, group_offset, dacl_offset, sacl_offset;
134 bool owner_valid, group_valid;
135 size_t size = *size_p;
136 const wimlib_SECURITY_DESCRIPTOR_RELATIVE *desc = _desc;
137 wimlib_SECURITY_DESCRIPTOR_RELATIVE *desc_new;
138 const wimlib_SID *owner, *group, *sid;
140 /* Don't attempt to fix clearly invalid security descriptors. */
141 if (size < sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE))
144 if (le16_to_cpu(desc->control) & wimlib_SE_DACL_PRESENT)
145 dacl_offset = le32_to_cpu(desc->dacl_offset);
149 if (le16_to_cpu(desc->control) & wimlib_SE_SACL_PRESENT)
150 sacl_offset = le32_to_cpu(desc->sacl_offset);
154 /* Check if the security descriptor will be affected by one of the bugs.
155 * If not, do nothing and return. */
156 if (!((sacl_offset != 0 && sacl_offset == size - sizeof(wimlib_ACL)) ||
157 (dacl_offset != 0 && dacl_offset == size - sizeof(wimlib_ACL))))
160 owner_offset = le32_to_cpu(desc->owner_offset);
161 group_offset = le32_to_cpu(desc->group_offset);
162 owner = (const wimlib_SID*)((const u8*)desc + owner_offset);
163 group = (const wimlib_SID*)((const u8*)desc + group_offset);
165 /* We'll try to move the owner or group SID to the end of the security
166 * descriptor to avoid the bug. This is only possible if at least one
168 owner_valid = (owner_offset != 0) &&
169 (owner_offset % 4 == 0) &&
170 (owner_offset <= size - sizeof(SID)) &&
171 (owner_offset + sid_size(owner) <= size) &&
172 (owner_offset >= sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE));
173 group_valid = (group_offset != 0) &&
174 (group_offset % 4 == 0) &&
175 (group_offset <= size - sizeof(SID)) &&
176 (group_offset + sid_size(group) <= size) &&
177 (group_offset >= sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE));
180 } else if (group_valid) {
186 desc_new = MALLOC(size + sid_size(sid));
190 memcpy(desc_new, desc, size);
192 desc_new->owner_offset = cpu_to_le32(size);
193 else if (group_valid)
194 desc_new->group_offset = cpu_to_le32(size);
195 memcpy((u8*)desc_new + size, sid, sid_size(sid));
196 *size_p = size + sid_size(sid);
200 /* Set the security descriptor @desc of size @desc_size on the NTFS inode @ni.
203 ntfs_3g_set_security_descriptor(ntfs_inode *ni, const void *desc, size_t desc_size)
205 struct SECURITY_CONTEXT sec_ctx;
206 void *desc_fixed = NULL;
209 memset(&sec_ctx, 0, sizeof(sec_ctx));
210 sec_ctx.vol = ni->vol;
213 if (ntfs_set_ntfs_acl(&sec_ctx, ni, desc, desc_size, 0)) {
214 if (desc_fixed == NULL) {
215 desc_fixed = sd_fixup(desc, &desc_size);
216 if (desc_fixed != NULL) {
221 ret = WIMLIB_ERR_SET_SECURITY;
229 ntfs_3g_set_timestamps(ntfs_inode *ni, const struct wim_inode *inode)
232 inode->i_creation_time,
233 inode->i_last_write_time,
234 inode->i_last_access_time,
237 if (ntfs_inode_set_times(ni, (const char *)times, sizeof(times), 0))
238 return WIMLIB_ERR_SET_TIMESTAMPS;
242 /* Restore the timestamps on the NTFS inode corresponding to @inode. */
244 ntfs_3g_restore_timestamps(ntfs_volume *vol, const struct wim_inode *inode)
249 ni = ntfs_inode_open(vol, inode->i_mft_no);
253 res = ntfs_3g_set_timestamps(ni, inode);
255 if (ntfs_inode_close(ni) || res)
261 ERROR_WITH_ERRNO("Failed to update timestamps of \"%s\" in NTFS volume",
262 dentry_full_path(inode_first_extraction_dentry(inode)));
263 return WIMLIB_ERR_SET_TIMESTAMPS;
266 /* Restore the DOS name of the @dentry.
267 * This closes both @ni and @dir_ni.
268 * If either is NULL, then they are opened temporarily. */
270 ntfs_3g_restore_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni,
271 struct wim_dentry *dentry, ntfs_volume *vol)
274 const char *dos_name;
275 size_t dos_name_nbytes;
277 /* Note: ntfs_set_ntfs_dos_name() closes both inodes (even if it fails).
278 * And it takes in a multibyte string, even though it translates it to
279 * UTF-16LE internally... which is annoying because we currently have
280 * the UTF-16LE string but not the multibyte string. */
282 ret = utf16le_get_tstr(dentry->d_short_name, dentry->d_short_name_nbytes,
283 &dos_name, &dos_name_nbytes);
288 dir_ni = ntfs_inode_open(vol, dentry->d_parent->d_inode->i_mft_no);
290 ni = ntfs_inode_open(vol, dentry->d_inode->i_mft_no);
292 ret = ntfs_set_ntfs_dos_name(ni, dir_ni,
293 dos_name, dos_name_nbytes, 0);
299 utf16le_put_tstr(dos_name);
301 ERROR_WITH_ERRNO("Failed to set DOS name of \"%s\" in NTFS "
302 "volume", dentry_full_path(dentry));
303 ret = WIMLIB_ERR_SET_SHORT_NAME;
307 /* Unlike most other NTFS-3G functions, ntfs_set_ntfs_dos_name()
308 * changes the directory's last modification timestamp...
310 return ntfs_3g_restore_timestamps(vol, dentry->d_parent->d_inode);
313 /* ntfs_inode_close() can take a NULL argument, but it's probably best
314 * not to rely on this behavior. */
316 ntfs_inode_close(ni);
318 ntfs_inode_close(dir_ni);
323 ntfs_3g_restore_reparse_point(ntfs_inode *ni, const struct wim_inode *inode,
324 unsigned blob_size, struct ntfs_3g_apply_ctx *ctx)
326 complete_reparse_point(&ctx->rpbuf, inode, blob_size);
328 if (ntfs_set_ntfs_reparse_data(ni, (const char *)&ctx->rpbuf,
329 REPARSE_DATA_OFFSET + blob_size, 0))
332 ERROR_WITH_ERRNO("Failed to set reparse data on \"%s\"",
334 inode_first_extraction_dentry(inode)));
335 if (err == EINVAL && !(inode->i_reparse_tag & 0x80000000)) {
336 WARNING("This reparse point had a non-Microsoft reparse "
337 "tag. The preceding error may have been caused "
338 "by a known bug in libntfs-3g where it does not "
339 "correctly validate non-Microsoft reparse "
340 "points. This bug was fixed in NTFS-3G version "
343 return WIMLIB_ERR_SET_REPARSE_DATA;
350 ntfs_3g_has_empty_attributes(const struct wim_inode *inode)
352 for (unsigned i = 0; i < inode->i_num_streams; i++) {
353 const struct wim_inode_stream *strm = &inode->i_streams[i];
355 if (stream_blob_resolved(strm) == NULL &&
356 (strm->stream_type == STREAM_TYPE_REPARSE_POINT ||
357 stream_is_named_data_stream(strm)))
364 * Create empty attributes (named data streams and potentially a reparse point)
365 * for the specified file, if there are any.
367 * Since these won't have blob descriptors, they won't show up in the call to
368 * extract_blob_list(). Hence the need for the special case.
370 * Keep this in sync with ntfs_3g_has_empty_attributes()!
373 ntfs_3g_create_empty_attributes(ntfs_inode *ni,
374 const struct wim_inode *inode,
375 struct ntfs_3g_apply_ctx *ctx)
377 for (unsigned i = 0; i < inode->i_num_streams; i++) {
379 const struct wim_inode_stream *strm = &inode->i_streams[i];
382 if (stream_blob_resolved(strm) != NULL)
385 if (strm->stream_type == STREAM_TYPE_REPARSE_POINT) {
386 ret = ntfs_3g_restore_reparse_point(ni, inode, 0, ctx);
389 } else if (stream_is_named_data_stream(strm)) {
390 if (ntfs_attr_add(ni, AT_DATA, strm->stream_name,
391 utf16le_len_chars(strm->stream_name),
394 ERROR_WITH_ERRNO("Failed to create named data "
397 inode_first_extraction_dentry(inode)));
398 return WIMLIB_ERR_NTFS_3G;
405 /* Set attributes, security descriptor, and timestamps on the NTFS inode @ni.
408 ntfs_3g_set_metadata(ntfs_inode *ni, const struct wim_inode *inode,
409 const struct ntfs_3g_apply_ctx *ctx)
412 const struct wim_security_data *sd;
413 struct wim_dentry *one_dentry;
416 extract_flags = ctx->common.extract_flags;
417 sd = wim_get_current_security_data(ctx->common.wim);
418 one_dentry = inode_first_extraction_dentry(inode);
423 const void *object_id = inode_get_object_id(inode, &len);
424 if (unlikely(object_id != NULL) &&
425 ntfs_set_ntfs_object_id(ni, object_id, len, 0))
427 if (errno == EEXIST) {
428 WARNING("Duplicate object ID on file \"%s\"",
429 dentry_full_path(one_dentry));
431 ERROR_WITH_ERRNO("Failed to set object ID on "
432 "\"%s\" in NTFS volume",
433 dentry_full_path(one_dentry));
434 return WIMLIB_ERR_NTFS_3G;
440 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)) {
441 u32 attrib = inode->i_attributes;
443 attrib &= ~(FILE_ATTRIBUTE_SPARSE_FILE |
444 FILE_ATTRIBUTE_ENCRYPTED);
446 if (ntfs_set_ntfs_attrib(ni, (const char *)&attrib,
449 ERROR_WITH_ERRNO("Failed to set attributes on \"%s\" "
451 dentry_full_path(one_dentry));
452 return WIMLIB_ERR_SET_ATTRIBUTES;
456 /* Security descriptor */
457 if (inode_has_security_descriptor(inode)
458 && !(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
463 desc = sd->descriptors[inode->i_security_id];
464 desc_size = sd->sizes[inode->i_security_id];
466 ret = ntfs_3g_set_security_descriptor(ni, desc, desc_size);
470 ERROR_WITH_ERRNO("Failed to set security descriptor on "
471 "\"%s\" in NTFS volume",
472 dentry_full_path(one_dentry));
473 if (err == EINVAL && wimlib_print_errors) {
474 fprintf(wimlib_error_file,
475 "The security descriptor is: ");
476 print_byte_field(desc, desc_size, wimlib_error_file);
477 fprintf(wimlib_error_file, "\n");
478 fprintf(wimlib_error_file,
479 "\nThis error occurred because libntfs-3g thinks "
480 "the security descriptor is invalid. If you "
481 "are extracting a Windows 10 image, this may be "
482 "caused by a known bug in libntfs-3g. This bug "
483 "was fixed in NTFS-3G version 2016.2.22. See: "
484 "https://wimlib.net/forums/viewtopic.php?f=1&t=4 "
485 "for more information.\n\n");
492 ret = ntfs_3g_set_timestamps(ni, inode);
494 ERROR_WITH_ERRNO("Failed to set timestamps on \"%s\" "
496 dentry_full_path(one_dentry));
502 /* Recursively creates all the subdirectories of @dir, which has been created as
503 * the NTFS inode @dir_ni. */
505 ntfs_3g_create_dirs_recursive(ntfs_inode *dir_ni, struct wim_dentry *dir,
506 struct ntfs_3g_apply_ctx *ctx)
508 struct wim_dentry *child;
510 for_dentry_child(child, dir) {
514 if (!(child->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
516 if (!will_extract_dentry(child))
519 ni = ntfs_create(dir_ni, 0, child->d_extraction_name,
520 child->d_extraction_name_nchars, S_IFDIR);
522 ERROR_WITH_ERRNO("Error creating \"%s\" in NTFS volume",
523 dentry_full_path(child));
524 return WIMLIB_ERR_NTFS_3G;
527 child->d_inode->i_mft_no = ni->mft_no;
529 ret = report_file_created(&ctx->common);
531 ret = ntfs_3g_set_metadata(ni, child->d_inode, ctx);
533 ret = ntfs_3g_create_dirs_recursive(ni, child, ctx);
535 if (ntfs_inode_close_in_dir(ni, dir_ni) && !ret) {
536 ERROR_WITH_ERRNO("Error closing \"%s\" in NTFS volume",
537 dentry_full_path(child));
538 ret = WIMLIB_ERR_NTFS_3G;
546 /* For each WIM dentry in the @root tree that represents a directory, create the
547 * corresponding directory in the NTFS volume @ctx->vol. */
549 ntfs_3g_create_directories(struct wim_dentry *root,
550 struct list_head *dentry_list,
551 struct ntfs_3g_apply_ctx *ctx)
555 struct wim_dentry *dentry;
557 /* Create the directories using POSIX names. */
559 root_ni = ntfs_inode_open(ctx->vol, FILE_root);
561 ERROR_WITH_ERRNO("Can't open root of NTFS volume");
562 return WIMLIB_ERR_NTFS_3G;
565 root->d_inode->i_mft_no = FILE_root;
567 ret = ntfs_3g_set_metadata(root_ni, root->d_inode, ctx);
569 ret = ntfs_3g_create_dirs_recursive(root_ni, root, ctx);
571 if (ntfs_inode_close(root_ni) && !ret) {
572 ERROR_WITH_ERRNO("Error closing root of NTFS volume");
573 ret = WIMLIB_ERR_NTFS_3G;
578 /* Set the DOS name of any directory that has one. In addition, create
579 * empty attributes for directories that have them. Note that creating
580 * an empty reparse point attribute must happen *after* setting the DOS
581 * name in order to work around a case where ntfs_set_ntfs_dos_name()
582 * fails with EOPNOTSUPP. This bug was fixed in NTFS-3G version
584 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
585 const struct wim_inode *inode = dentry->d_inode;
587 if (!(inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
589 if (dentry_has_short_name(dentry)) {
590 ret = ntfs_3g_restore_dos_name(NULL, NULL, dentry,
594 ret = report_file_created(&ctx->common);
598 if (ntfs_3g_has_empty_attributes(inode)) {
601 ret = WIMLIB_ERR_NTFS_3G;
602 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
604 ret = ntfs_3g_create_empty_attributes(ni, inode,
606 if (ntfs_inode_close(ni) && !ret)
607 ret = WIMLIB_ERR_NTFS_3G;
610 ERROR_WITH_ERRNO("Failed to create empty "
611 "attributes of directory "
612 "\"%s\" in NTFS volume",
613 dentry_full_path(dentry));
621 /* When creating an inode that will have a short (DOS) name, we create it using
622 * the long name associated with the short name. This ensures that the short
623 * name gets associated with the correct long name. */
624 static struct wim_dentry *
625 ntfs_3g_first_extraction_alias(struct wim_inode *inode)
627 struct wim_dentry *dentry;
629 inode_for_each_extraction_alias(dentry, inode)
630 if (dentry_has_short_name(dentry))
632 return inode_first_extraction_dentry(inode);
636 * Add a hard link for the NTFS inode @ni at the location corresponding to the
637 * WIM dentry @dentry.
639 * The parent directory must have already been created on the NTFS volume.
641 * Returns 0 on success; returns WIMLIB_ERR_NTFS_3G and sets errno on failure.
644 ntfs_3g_add_link(ntfs_inode *ni, struct wim_dentry *dentry)
649 /* Open the inode of the parent directory. */
650 dir_ni = ntfs_inode_open(ni->vol, dentry->d_parent->d_inode->i_mft_no);
654 /* Create the link. */
655 res = ntfs_link(ni, dir_ni, dentry->d_extraction_name,
656 dentry->d_extraction_name_nchars);
658 /* Close the parent directory. */
659 if (ntfs_inode_close(dir_ni) || res)
665 ERROR_WITH_ERRNO("Can't create link \"%s\" in NTFS volume",
666 dentry_full_path(dentry));
667 return WIMLIB_ERR_NTFS_3G;
671 ntfs_3g_create_nondirectory(struct wim_inode *inode,
672 struct ntfs_3g_apply_ctx *ctx)
674 struct wim_dentry *first_dentry;
677 struct wim_dentry *dentry;
680 first_dentry = ntfs_3g_first_extraction_alias(inode);
682 /* Create first link. */
684 dir_ni = ntfs_inode_open(ctx->vol, first_dentry->d_parent->d_inode->i_mft_no);
686 ERROR_WITH_ERRNO("Can't open \"%s\" in NTFS volume",
687 dentry_full_path(first_dentry->d_parent));
688 return WIMLIB_ERR_NTFS_3G;
691 ni = ntfs_create(dir_ni, 0, first_dentry->d_extraction_name,
692 first_dentry->d_extraction_name_nchars, S_IFREG);
695 ERROR_WITH_ERRNO("Can't create \"%s\" in NTFS volume",
696 dentry_full_path(first_dentry));
697 ntfs_inode_close(dir_ni);
698 return WIMLIB_ERR_NTFS_3G;
701 inode->i_mft_no = ni->mft_no;
703 /* Set short name if present. */
704 if (dentry_has_short_name(first_dentry)) {
706 ret = ntfs_3g_restore_dos_name(ni, dir_ni, first_dentry, ctx->vol);
708 /* ntfs_3g_restore_dos_name() closed both 'ni' and 'dir_ni'. */
713 /* Reopen the inode. */
714 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
716 ERROR_WITH_ERRNO("Failed to reopen \"%s\" "
718 dentry_full_path(first_dentry));
719 return WIMLIB_ERR_NTFS_3G;
722 /* Close the directory in which the first link was created. */
723 if (ntfs_inode_close(dir_ni)) {
724 ERROR_WITH_ERRNO("Failed to close \"%s\" in NTFS volume",
725 dentry_full_path(first_dentry->d_parent));
726 ret = WIMLIB_ERR_NTFS_3G;
731 /* Create additional links if present. */
732 inode_for_each_extraction_alias(dentry, inode) {
733 if (dentry != first_dentry) {
734 ret = ntfs_3g_add_link(ni, dentry);
741 ret = ntfs_3g_set_metadata(ni, inode, ctx);
745 ret = ntfs_3g_create_empty_attributes(ni, inode, ctx);
748 /* Close the inode. */
749 if (ntfs_inode_close(ni) && !ret) {
750 ERROR_WITH_ERRNO("Error closing \"%s\" in NTFS volume",
751 dentry_full_path(first_dentry));
752 ret = WIMLIB_ERR_NTFS_3G;
757 /* For each WIM dentry in the @dentry_list that represents a nondirectory file,
758 * create the corresponding nondirectory file in the NTFS volume.
760 * Directories must have already been created. */
762 ntfs_3g_create_nondirectories(struct list_head *dentry_list,
763 struct ntfs_3g_apply_ctx *ctx)
765 struct wim_dentry *dentry;
766 struct wim_inode *inode;
769 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
770 inode = dentry->d_inode;
771 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
773 if (dentry == inode_first_extraction_dentry(inode)) {
774 ret = ntfs_3g_create_nondirectory(inode, ctx);
778 ret = report_file_created(&ctx->common);
786 ntfs_3g_begin_extract_blob_instance(struct blob_descriptor *blob,
788 struct wim_inode *inode,
789 const struct wim_inode_stream *strm,
790 struct ntfs_3g_apply_ctx *ctx)
792 struct wim_dentry *one_dentry = inode_first_extraction_dentry(inode);
793 ntfschar *stream_name;
794 size_t stream_name_nchars;
797 if (unlikely(strm->stream_type == STREAM_TYPE_REPARSE_POINT)) {
799 if (blob->size > REPARSE_DATA_MAX_SIZE) {
800 ERROR("Reparse data of \"%s\" has size "
801 "%"PRIu64" bytes (exceeds %u bytes)",
802 dentry_full_path(one_dentry),
803 blob->size, REPARSE_DATA_MAX_SIZE);
804 return WIMLIB_ERR_INVALID_REPARSE_DATA;
806 ctx->reparse_ptr = ctx->rpbuf.rpdata;
807 ctx->ntfs_reparse_inodes[ctx->num_reparse_inodes] = ni;
808 ctx->wim_reparse_inodes[ctx->num_reparse_inodes] = inode;
809 ctx->num_reparse_inodes++;
813 /* It's a data stream (may be unnamed or named). */
814 wimlib_assert(strm->stream_type == STREAM_TYPE_DATA);
816 if (unlikely(stream_is_named(strm))) {
817 stream_name = strm->stream_name;
818 stream_name_nchars = utf16le_len_chars(stream_name);
820 if (ntfs_attr_add(ni, AT_DATA, stream_name,
821 stream_name_nchars, NULL, 0))
823 ERROR_WITH_ERRNO("Failed to create named data stream of \"%s\"",
824 dentry_full_path(one_dentry));
825 return WIMLIB_ERR_NTFS_3G;
828 /* Don't pass an empty string other than AT_UNNAMED to
829 * ntfs_attr_open() --- it violates assumptions made by
831 stream_name = AT_UNNAMED;
832 stream_name_nchars = 0;
835 /* This should be ensured by extract_blob_list() */
836 wimlib_assert(ctx->num_open_attrs < MAX_OPEN_FILES);
838 attr = ntfs_attr_open(ni, AT_DATA, stream_name, stream_name_nchars);
840 ERROR_WITH_ERRNO("Failed to open data stream of \"%s\"",
841 dentry_full_path(one_dentry));
842 return WIMLIB_ERR_NTFS_3G;
844 ctx->open_attrs[ctx->num_open_attrs++] = attr;
845 ntfs_attr_truncate_solid(attr, blob->size);
850 ntfs_3g_cleanup_blob_extract(struct ntfs_3g_apply_ctx *ctx)
854 for (unsigned i = 0; i < ctx->num_open_attrs; i++) {
855 if (ntfs_attr_pclose(ctx->open_attrs[i]))
857 ntfs_attr_close(ctx->open_attrs[i]);
860 ctx->num_open_attrs = 0;
862 for (unsigned i = 0; i < ctx->num_open_inodes; i++) {
863 if (ntfs_inode_close(ctx->open_inodes[i]))
866 ctx->num_open_inodes = 0;
869 ctx->reparse_ptr = NULL;
870 ctx->num_reparse_inodes = 0;
875 ntfs_3g_open_inode(struct wim_inode *inode, struct ntfs_3g_apply_ctx *ctx)
879 /* If the same blob is being extracted to multiple streams of the same
880 * inode, then we must only open the inode once. */
881 if (unlikely(inode->i_num_streams > 1)) {
882 for (unsigned i = 0; i < ctx->num_open_inodes; i++) {
883 if (ctx->open_inodes[i]->mft_no == inode->i_mft_no) {
884 return ctx->open_inodes[i];
889 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
891 ERROR_WITH_ERRNO("Can't open \"%s\" in NTFS volume",
893 inode_first_extraction_dentry(inode)));
897 ctx->open_inodes[ctx->num_open_inodes++] = ni;
902 ntfs_3g_begin_extract_blob(struct blob_descriptor *blob, void *_ctx)
904 struct ntfs_3g_apply_ctx *ctx = _ctx;
905 const struct blob_extraction_target *targets = blob_extraction_targets(blob);
909 for (u32 i = 0; i < blob->out_refcnt; i++) {
910 ret = WIMLIB_ERR_NTFS_3G;
911 ni = ntfs_3g_open_inode(targets[i].inode, ctx);
915 ret = ntfs_3g_begin_extract_blob_instance(blob, ni,
917 targets[i].stream, ctx);
925 ntfs_3g_cleanup_blob_extract(ctx);
930 /* Note: contrary to its documentation, ntfs_attr_pwrite() can return a short
931 * count in non-error cases --- specifically, when writing to a compressed
932 * attribute and the requested count exceeds the size of an NTFS "compression
933 * block". Therefore, we must continue calling ntfs_attr_pwrite() until all
934 * bytes have been written or a real error has occurred. */
936 ntfs_3g_full_pwrite(ntfs_attr *na, u64 offset, size_t size, const u8 *data)
939 s64 res = ntfs_attr_pwrite(na, offset, size, data);
940 if (unlikely(res <= 0))
942 wimlib_assert(res <= size);
951 ntfs_3g_extract_chunk(const void *chunk, size_t size, void *_ctx)
953 struct ntfs_3g_apply_ctx *ctx = _ctx;
955 for (unsigned i = 0; i < ctx->num_open_attrs; i++) {
956 if (!ntfs_3g_full_pwrite(ctx->open_attrs[i],
957 ctx->offset, size, chunk))
959 ERROR_WITH_ERRNO("Error writing data to NTFS volume");
960 return WIMLIB_ERR_NTFS_3G;
963 if (ctx->reparse_ptr)
964 ctx->reparse_ptr = mempcpy(ctx->reparse_ptr, chunk, size);
970 ntfs_3g_end_extract_blob(struct blob_descriptor *blob, int status, void *_ctx)
972 struct ntfs_3g_apply_ctx *ctx = _ctx;
980 for (u32 i = 0; i < ctx->num_reparse_inodes; i++) {
981 ret = ntfs_3g_restore_reparse_point(ctx->ntfs_reparse_inodes[i],
982 ctx->wim_reparse_inodes[i],
989 if (ntfs_3g_cleanup_blob_extract(ctx) && !ret) {
990 ERROR_WITH_ERRNO("Error writing data to NTFS volume");
991 ret = WIMLIB_ERR_NTFS_3G;
997 ntfs_3g_count_dentries(const struct list_head *dentry_list)
999 const struct wim_dentry *dentry;
1002 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1004 if ((dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) &&
1005 dentry_has_short_name(dentry))
1015 ntfs_3g_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
1017 struct ntfs_3g_apply_ctx *ctx = (struct ntfs_3g_apply_ctx *)_ctx;
1019 struct wim_dentry *root;
1022 /* For NTFS-3G extraction mode we require that the dentries to extract
1023 * form a single tree. */
1024 root = list_first_entry(dentry_list, struct wim_dentry,
1025 d_extraction_list_node);
1027 /* Mount the NTFS volume. */
1028 vol = ntfs_mount(ctx->common.target, 0);
1030 ERROR_WITH_ERRNO("Failed to mount \"%s\" with NTFS-3G",
1031 ctx->common.target);
1032 return WIMLIB_ERR_NTFS_3G;
1036 /* Create all inodes and aliases, including short names, and set
1037 * metadata (attributes, security descriptors, and timestamps). */
1039 ret = start_file_structure_phase(&ctx->common,
1040 ntfs_3g_count_dentries(dentry_list));
1044 ret = ntfs_3g_create_directories(root, dentry_list, ctx);
1048 ret = ntfs_3g_create_nondirectories(dentry_list, ctx);
1052 ret = end_file_structure_phase(&ctx->common);
1056 /* Extract blobs. */
1057 struct read_blob_callbacks cbs = {
1058 .begin_blob = ntfs_3g_begin_extract_blob,
1059 .consume_chunk = ntfs_3g_extract_chunk,
1060 .end_blob = ntfs_3g_end_extract_blob,
1063 ret = extract_blob_list(&ctx->common, &cbs);
1065 /* We do not need a final pass to set timestamps because libntfs-3g does
1066 * not update timestamps automatically (exception:
1067 * ntfs_set_ntfs_dos_name() does, but we handle this elsewhere). */
1070 if (ntfs_umount(ctx->vol, FALSE) && !ret) {
1071 ERROR_WITH_ERRNO("Failed to unmount \"%s\" with NTFS-3G",
1072 ctx->common.target);
1073 ret = WIMLIB_ERR_NTFS_3G;
1078 const struct apply_operations ntfs_3g_apply_ops = {
1080 .get_supported_features = ntfs_3g_get_supported_features,
1081 .extract = ntfs_3g_extract,
1082 .context_size = sizeof(struct ntfs_3g_apply_ctx),
1083 .single_tree_only = true,