2 * win32_apply.c - Windows-specific code for applying files from a WIM image.
6 * Copyright (C) 2013, 2014 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
10 * wimlib is free software; you can redistribute it and/or modify it under the
11 * terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 3 of the License, or (at your option)
15 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 * A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with wimlib; if not, see http://www.gnu.org/licenses/.
30 #include "wimlib/win32_common.h"
32 #include "wimlib/apply.h"
33 #include "wimlib/capture.h" /* for mangle_pat() and match_pattern_list() */
34 #include "wimlib/dentry.h"
35 #include "wimlib/error.h"
36 #include "wimlib/lookup_table.h"
37 #include "wimlib/metadata.h"
38 #include "wimlib/reparse.h"
39 #include "wimlib/textfile.h"
40 #include "wimlib/xml.h"
41 #include "wimlib/wimboot.h"
43 /* TODO: Add workaround for when a stream needs to be extracted to more places
45 #define MAX_OPEN_HANDLES 32768
47 struct win32_apply_ctx {
49 /* Extract flags, the pointer to the WIMStruct, etc. */
50 struct apply_ctx common;
52 /* WIMBoot information, only filled in if WIMLIB_EXTRACT_FLAG_WIMBOOT
56 struct string_set *prepopulate_pats;
57 void *mem_prepopulate_pats;
58 u8 wim_lookup_table_hash[SHA1_HASH_SIZE];
62 /* Open handle to the target directory */
65 /* NT namespace path to the target directory (buffer allocated) */
66 UNICODE_STRING target_ntpath;
68 /* Temporary buffer for building paths (buffer allocated) */
69 UNICODE_STRING pathbuf;
71 /* Object attributes to reuse for opening files in the target directory.
72 * (attr.ObjectName == &pathbuf) and (attr.RootDirectory == h_target).
74 OBJECT_ATTRIBUTES attr;
76 /* Temporary I/O status block for system calls */
79 /* Allocated buffer for creating "printable" paths from our
80 * target-relative NT paths */
81 wchar_t *print_buffer;
83 /* Allocated buffer for reading stream data when it cannot be extracted
87 /* Pointer to the next byte in @data_buffer to fill */
90 /* Size allocated in @data_buffer */
91 size_t data_buffer_size;
93 /* Current offset in the raw encrypted file being written */
94 size_t encrypted_offset;
96 /* Current size of the raw encrypted file being written */
97 size_t encrypted_size;
99 /* Temporary buffer for reparse data */
100 struct reparse_buffer_disk rpbuf;
102 /* Temporary buffer for reparse data of "fixed" absolute symbolic links
104 struct reparse_buffer_disk rpfixbuf;
106 /* Array of open handles to filesystem streams currently being written
108 HANDLE open_handles[MAX_OPEN_HANDLES];
110 /* Number of handles in @open_handles currently open (filled in from the
111 * beginning of the array) */
112 unsigned num_open_handles;
114 /* List of dentries, joined by @tmp_list, that need to have reparse data
115 * extracted as soon as the whole stream has been read into
117 struct list_head reparse_dentries;
119 /* List of dentries, joined by @tmp_list, that need to have raw
120 * encrypted data extracted as soon as the whole stream has been read
121 * into @data_buffer. */
122 struct list_head encrypted_dentries;
124 /* Number of files for which we didn't have permission to set the full
125 * security descriptor. */
126 unsigned long partial_security_descriptors;
128 /* Number of files for which we didn't have permission to set any part
129 * of the security descriptor. */
130 unsigned long no_security_descriptors;
133 /* Get the drive letter from a Windows path, or return the null character if the
134 * path is relative. */
136 get_drive_letter(const wchar_t *path)
138 /* Skip \\?\ prefix */
139 if (!wcsncmp(path, L"\\\\?\\", 4))
142 /* Return drive letter if valid */
143 if (((path[0] >= L'a' && path[0] <= L'z') ||
144 (path[0] >= L'A' && path[0] <= L'Z')) && path[1] == L':')
151 get_vol_flags(const wchar_t *target, DWORD *vol_flags_ret,
152 bool *short_names_supported_ret)
154 wchar_t filesystem_name[MAX_PATH + 1];
156 wchar_t *volume = NULL;
159 *short_names_supported_ret = false;
161 drive[0] = get_drive_letter(target);
169 if (!GetVolumeInformation(volume, NULL, 0, NULL, NULL,
170 vol_flags_ret, filesystem_name,
171 ARRAY_LEN(filesystem_name)))
173 DWORD err = GetLastError();
174 set_errno_from_win32_error(err);
175 WARNING_WITH_ERRNO("Failed to get volume information for "
176 "\"%ls\" (err=%"PRIu32")",
181 if (wcsstr(filesystem_name, L"NTFS")) {
182 /* FILE_SUPPORTS_HARD_LINKS is only supported on Windows 7 and
183 * later. Force it on anyway if filesystem is NTFS. */
184 *vol_flags_ret |= FILE_SUPPORTS_HARD_LINKS;
186 /* There's no volume flag for short names, but according to the
187 * MS documentation they are only user-settable on NTFS. */
188 *short_names_supported_ret = true;
193 win32_get_supported_features(const wchar_t *target,
194 struct wim_features *supported_features)
197 bool short_names_supported;
199 /* Query the features of the target volume. */
201 get_vol_flags(target, &vol_flags, &short_names_supported);
203 supported_features->archive_files = 1;
204 supported_features->hidden_files = 1;
205 supported_features->system_files = 1;
207 if (vol_flags & FILE_FILE_COMPRESSION)
208 supported_features->compressed_files = 1;
210 if (vol_flags & FILE_SUPPORTS_ENCRYPTION) {
211 supported_features->encrypted_files = 1;
212 supported_features->encrypted_directories = 1;
215 supported_features->not_context_indexed_files = 1;
217 /* Don't do anything with FILE_SUPPORTS_SPARSE_FILES. */
219 if (vol_flags & FILE_NAMED_STREAMS)
220 supported_features->named_data_streams = 1;
222 if (vol_flags & FILE_SUPPORTS_HARD_LINKS)
223 supported_features->hard_links = 1;
225 if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS)
226 supported_features->reparse_points = 1;
228 if (vol_flags & FILE_PERSISTENT_ACLS)
229 supported_features->security_descriptors = 1;
231 if (short_names_supported)
232 supported_features->short_names = 1;
234 supported_features->timestamps = 1;
236 /* Note: Windows does not support case sensitive filenames! At least
237 * not without changing the registry and rebooting... */
242 /* Load the patterns from [PrepopulateList] of WimBootCompresse.ini in the WIM
243 * image being extracted. */
245 load_prepopulate_pats(struct win32_apply_ctx *ctx)
247 const wchar_t *path = L"\\Windows\\System32\\WimBootCompress.ini";
248 struct wim_dentry *dentry;
249 struct wim_lookup_table_entry *lte;
252 struct string_set *s;
254 struct text_file_section sec;
256 dentry = get_dentry(ctx->common.wim, path, WIMLIB_CASE_INSENSITIVE);
258 (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
259 FILE_ATTRIBUTE_REPARSE_POINT |
260 FILE_ATTRIBUTE_ENCRYPTED)) ||
261 !(lte = inode_unnamed_lte(dentry->d_inode, ctx->common.wim->lookup_table)))
263 WARNING("%ls does not exist in WIM image!", path);
264 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
267 ret = read_full_stream_into_alloc_buf(lte, &buf);
271 s = CALLOC(1, sizeof(struct string_set));
274 return WIMLIB_ERR_NOMEM;
277 sec.name = T("PrepopulateList");
280 ret = do_load_text_file(path, buf, lte->size, &mem, &sec, 1,
281 LOAD_TEXT_FILE_REMOVE_QUOTES |
282 LOAD_TEXT_FILE_NO_WARNINGS,
284 BUILD_BUG_ON(OS_PREFERRED_PATH_SEPARATOR != WIM_PATH_SEPARATOR);
290 ctx->wimboot.prepopulate_pats = s;
291 ctx->wimboot.mem_prepopulate_pats = mem;
295 /* Returns %true if the path to @dentry matches a pattern in [PrepopulateList]
296 * of WimBootCompress.ini. Otherwise returns %false.
298 * @dentry must have had its full path calculated. */
300 in_prepopulate_list(struct wim_dentry *dentry,
301 const struct win32_apply_ctx *ctx)
303 const struct string_set *pats = ctx->wimboot.prepopulate_pats;
305 if (!pats || !pats->num_strings)
308 return match_pattern_list(dentry->_full_path,
309 wcslen(dentry->_full_path), pats);
312 /* Calculates the SHA-1 message digest of the WIM's lookup table. */
314 hash_lookup_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
316 return wim_reshdr_to_hash(&wim->hdr.lookup_table_reshdr, wim, hash);
319 /* Prepare for doing a "WIMBoot" extraction by loading patterns from
320 * [PrepopulateList] of WimBootCompress.ini and allocating a WOF data source ID
321 * on the target volume. */
323 start_wimboot_extraction(struct win32_apply_ctx *ctx)
326 WIMStruct *wim = ctx->common.wim;
328 ret = load_prepopulate_pats(ctx);
329 if (ret == WIMLIB_ERR_NOMEM)
332 if (!wim_info_get_wimboot(wim->wim_info,
334 WARNING("Image is not marked as WIMBoot compatible!");
336 ret = hash_lookup_table(ctx->common.wim,
337 ctx->wimboot.wim_lookup_table_hash);
341 return wimboot_alloc_data_source_id(wim->filename,
345 &ctx->wimboot.data_source_id,
346 &ctx->wimboot.wof_running);
349 /* Returns the number of wide characters needed to represent the path to the
350 * specified @dentry, relative to the target directory, when extracted.
352 * Does not include null terminator (not needed for NtCreateFile). */
354 dentry_extraction_path_length(const struct wim_dentry *dentry)
357 const struct wim_dentry *d;
361 len += d->d_extraction_name_nchars + 1;
363 } while (!dentry_is_root(d) && will_extract_dentry(d));
365 return --len; /* No leading slash */
368 /* Returns the length of the longest string that might need to be appended to
369 * the path to an alias of an inode to open or create a named data stream.
371 * If the inode has no named data streams, this will be 0. Otherwise, this will
372 * be 1 plus the length of the longest-named data stream, since the data stream
373 * name must be separated form the path by the ':' character. */
375 inode_longest_named_data_stream_spec(const struct wim_inode *inode)
378 for (u16 i = 0; i < inode->i_num_ads; i++) {
379 size_t len = inode->i_ads_entries[i].stream_name_nbytes;
384 max = 1 + (max / sizeof(wchar_t));
388 /* Find the length, in wide characters, of the longest path needed for
389 * extraction of any file in @dentry_list relative to the target directory.
391 * Accounts for named data streams, but does not include null terminator (not
392 * needed for NtCreateFile). */
394 compute_path_max(struct list_head *dentry_list)
397 const struct wim_dentry *dentry;
399 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
402 len = dentry_extraction_path_length(dentry);
404 /* Account for named data streams */
405 len += inode_longest_named_data_stream_spec(dentry->d_inode);
414 /* Build the path at which to extract the @dentry, relative to the target
417 * The path is saved in ctx->pathbuf. */
419 build_extraction_path(const struct wim_dentry *dentry,
420 struct win32_apply_ctx *ctx)
424 const struct wim_dentry *d;
426 len = dentry_extraction_path_length(dentry);
428 ctx->pathbuf.Length = len * sizeof(wchar_t);
429 p = ctx->pathbuf.Buffer + len;
431 !dentry_is_root(d->d_parent) && will_extract_dentry(d->d_parent);
434 p -= d->d_extraction_name_nchars;
435 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
438 /* No leading slash */
439 p -= d->d_extraction_name_nchars;
440 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
443 /* Build the path at which to extract the @dentry, relative to the target
444 * directory, adding the suffix for a named data stream.
446 * The path is saved in ctx->pathbuf. */
448 build_extraction_path_with_ads(const struct wim_dentry *dentry,
449 struct win32_apply_ctx *ctx,
450 const wchar_t *stream_name,
451 size_t stream_name_nchars)
455 build_extraction_path(dentry, ctx);
457 /* Add :NAME for named data stream */
458 p = ctx->pathbuf.Buffer + (ctx->pathbuf.Length / sizeof(wchar_t));
460 wmemcpy(p, stream_name, stream_name_nchars);
461 ctx->pathbuf.Length += (1 + stream_name_nchars) * sizeof(wchar_t);
464 /* Build the Win32 namespace path to the specified @dentry when extracted.
466 * The path is saved in ctx->pathbuf and will be null terminated.
468 * XXX: We could get rid of this if it wasn't needed for the file encryption
471 build_win32_extraction_path(const struct wim_dentry *dentry,
472 struct win32_apply_ctx *ctx)
474 build_extraction_path(dentry, ctx);
476 /* Prepend target_ntpath to our relative path, then change \??\ into \\?\ */
478 memmove(ctx->pathbuf.Buffer +
479 (ctx->target_ntpath.Length / sizeof(wchar_t)) + 1,
480 ctx->pathbuf.Buffer, ctx->pathbuf.Length);
481 memcpy(ctx->pathbuf.Buffer, ctx->target_ntpath.Buffer,
482 ctx->target_ntpath.Length);
483 ctx->pathbuf.Buffer[ctx->target_ntpath.Length / sizeof(wchar_t)] = L'\\';
484 ctx->pathbuf.Length += ctx->target_ntpath.Length + sizeof(wchar_t);
485 ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)] = L'\0';
487 wimlib_assert(ctx->pathbuf.Length >= 4 * sizeof(wchar_t) &&
488 !wmemcmp(ctx->pathbuf.Buffer, L"\\??\\", 4));
490 ctx->pathbuf.Buffer[1] = L'\\';
494 /* Returns a "printable" representation of the last relative NT path that was
495 * constructed with build_extraction_path() or build_extraction_path_with_ads().
497 * This will be overwritten by the next call to this function. */
498 static const wchar_t *
499 current_path(struct win32_apply_ctx *ctx)
501 wchar_t *p = ctx->print_buffer;
503 p = wmempcpy(p, ctx->common.target, ctx->common.target_nchars);
505 p = wmempcpy(p, ctx->pathbuf.Buffer, ctx->pathbuf.Length / sizeof(wchar_t));
507 return ctx->print_buffer;
511 * Ensures the target directory exists and opens a handle to it, in preparation
512 * of using paths relative to it.
515 prepare_target(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
520 /* Open handle to the target directory (possibly creating it). */
522 if (func_RtlDosPathNameToNtPathName_U_WithStatus) {
523 status = (*func_RtlDosPathNameToNtPathName_U_WithStatus)(ctx->common.target,
527 if ((*func_RtlDosPathNameToNtPathName_U)(ctx->common.target,
530 status = STATUS_SUCCESS;
532 status = STATUS_NO_MEMORY;
534 if (!NT_SUCCESS(status)) {
535 if (status == STATUS_NO_MEMORY) {
536 return WIMLIB_ERR_NOMEM;
538 ERROR("\"%ls\": invalid path name "
539 "(status=0x%08"PRIx32")",
540 ctx->common.target, (u32)status);
541 return WIMLIB_ERR_INVALID_PARAM;
545 ctx->attr.Length = sizeof(ctx->attr);
546 ctx->attr.ObjectName = &ctx->target_ntpath;
548 status = (*func_NtCreateFile)(&ctx->h_target,
554 FILE_SHARE_VALID_FLAGS,
556 FILE_DIRECTORY_FILE |
557 FILE_OPEN_REPARSE_POINT |
558 FILE_OPEN_FOR_BACKUP_INTENT,
562 if (!NT_SUCCESS(status)) {
563 set_errno_from_nt_status(status);
564 ERROR_WITH_ERRNO("Can't open or create directory \"%ls\" "
565 "(status=0x%08"PRIx32")",
566 ctx->common.target, (u32)status);
567 return WIMLIB_ERR_OPENDIR;
570 path_max = compute_path_max(dentry_list);
572 /* Add some extra for building Win32 paths for the file encryption APIs
574 path_max += 2 + (ctx->target_ntpath.Length / sizeof(wchar_t));
576 ctx->pathbuf.MaximumLength = path_max * sizeof(wchar_t);
577 ctx->pathbuf.Buffer = MALLOC(ctx->pathbuf.MaximumLength);
578 if (!ctx->pathbuf.Buffer)
579 return WIMLIB_ERR_NOMEM;
581 ctx->attr.RootDirectory = ctx->h_target;
582 ctx->attr.ObjectName = &ctx->pathbuf;
584 ctx->print_buffer = MALLOC((ctx->common.target_nchars + 1 + path_max + 1) *
586 if (!ctx->print_buffer)
587 return WIMLIB_ERR_NOMEM;
592 /* When creating an inode that will have a short (DOS) name, we create it using
593 * the long name associated with the short name. This ensures that the short
594 * name gets associated with the correct long name. */
595 static const struct wim_dentry *
596 first_extraction_alias(const struct wim_inode *inode)
598 const struct list_head *next = inode->i_extraction_aliases.next;
599 const struct wim_dentry *dentry;
602 dentry = list_entry(next, struct wim_dentry,
603 d_extraction_alias_node);
604 if (dentry_has_short_name(dentry))
607 } while (next != &inode->i_extraction_aliases);
612 * Set or clear FILE_ATTRIBUTE_COMPRESSED if the inherited value is different
613 * from the desired value.
615 * Note that you can NOT override the inherited value of
616 * FILE_ATTRIBUTE_COMPRESSED directly with NtCreateFile().
619 adjust_compression_attribute(HANDLE h, const struct wim_dentry *dentry,
620 struct win32_apply_ctx *ctx)
622 const bool compressed = (dentry->d_inode->i_attributes &
623 FILE_ATTRIBUTE_COMPRESSED);
625 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
628 if (!ctx->common.supported_features.compressed_files)
631 FILE_BASIC_INFORMATION info;
633 USHORT compression_state;
635 /* Get current attributes */
636 status = (*func_NtQueryInformationFile)(h, &ctx->iosb,
638 FileBasicInformation);
639 if (NT_SUCCESS(status) &&
640 compressed == !!(info.FileAttributes & FILE_ATTRIBUTE_COMPRESSED))
642 /* Nothing needs to be done. */
646 /* Set the new compression state */
649 compression_state = COMPRESSION_FORMAT_DEFAULT;
651 compression_state = COMPRESSION_FORMAT_NONE;
653 status = (*func_NtFsControlFile)(h,
658 FSCTL_SET_COMPRESSION,
663 if (NT_SUCCESS(status))
666 set_errno_from_nt_status(status);
667 ERROR_WITH_ERRNO("Can't %s compression attribute on \"%ls\" "
668 "(status=0x%08"PRIx32")",
669 (compressed ? "set" : "clear"),
670 current_path(ctx), status);
671 return WIMLIB_ERR_SET_ATTRIBUTES;
675 * Clear FILE_ATTRIBUTE_ENCRYPTED if the file or directory is not supposed to be
678 * You can provide FILE_ATTRIBUTE_ENCRYPTED to NtCreateFile() to set it on the
679 * created file. However, the file or directory will otherwise default to the
680 * encryption state of the parent directory. This function works around this
681 * limitation by using DecryptFile() to remove FILE_ATTRIBUTE_ENCRYPTED on files
682 * (and directories) that are not supposed to have it set.
684 * Regardless of whether it succeeds or fails, this function may close the
685 * handle to the file. If it does, it sets it to NULL.
688 maybe_clear_encryption_attribute(HANDLE *h_ret, const struct wim_dentry *dentry,
689 struct win32_apply_ctx *ctx)
691 if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
694 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
697 if (!ctx->common.supported_features.encrypted_files)
700 FILE_BASIC_INFORMATION info;
704 /* Get current attributes */
705 status = (*func_NtQueryInformationFile)(*h_ret, &ctx->iosb,
707 FileBasicInformation);
708 if (NT_SUCCESS(status) &&
709 !(info.FileAttributes & FILE_ATTRIBUTE_ENCRYPTED))
711 /* Nothing needs to be done. */
715 /* Set the new encryption state */
717 /* Due to Windows' crappy file encryption APIs, we need to close the
718 * handle to the file so we don't get ERROR_SHARING_VIOLATION. We also
719 * hack together a Win32 path, although we will use the \\?\ prefix so
720 * it will actually be a NT path in disguise... */
721 (*func_NtClose)(*h_ret);
724 build_win32_extraction_path(dentry, ctx);
726 bret = DecryptFile(ctx->pathbuf.Buffer, 0);
728 /* Restore the NT namespace path */
729 build_extraction_path(dentry, ctx);
732 DWORD err = GetLastError();
733 set_errno_from_win32_error(err);
734 ERROR_WITH_ERRNO("Can't decrypt file \"%ls\" (err=%"PRIu32")",
735 current_path(ctx), (u32)err);
736 return WIMLIB_ERR_SET_ATTRIBUTES;
741 /* Set the short name on the open file @h which has been created at the location
742 * indicated by @dentry.
744 * Note that this may add, change, or remove the short name.
746 * @h must be opened with DELETE access.
748 * Returns 0 or WIMLIB_ERR_SET_SHORT_NAME. The latter only happens in
749 * STRICT_SHORT_NAMES mode.
752 set_short_name(HANDLE h, const struct wim_dentry *dentry,
753 struct win32_apply_ctx *ctx)
755 size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
756 dentry->short_name_nbytes;
757 u8 buf[bufsize] _aligned_attribute(8);
758 FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
761 info->FileNameLength = dentry->short_name_nbytes;
762 memcpy(info->FileName, dentry->short_name, dentry->short_name_nbytes);
764 status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
765 FileShortNameInformation);
766 if (NT_SUCCESS(status))
769 /* By default, failure to set short names is not an error (since short
770 * names aren't too important anymore...). */
771 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES))
774 if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
775 if (dentry->short_name_nbytes == 0)
777 ERROR("Can't extract short name when short "
778 "names are not enabled on the volume!");
780 ERROR("Can't set short name on \"%ls\" (status=0x%08"PRIx32")",
781 current_path(ctx), (u32)status);
783 return WIMLIB_ERR_SET_SHORT_NAME;
787 * A wrapper around NtCreateFile() to make it slightly more usable...
788 * This uses the path currently constructed in ctx->pathbuf.
790 * Also, we always specify FILE_OPEN_FOR_BACKUP_INTENT and
791 * FILE_OPEN_REPARSE_POINT.
794 do_create_file(PHANDLE FileHandle,
795 ACCESS_MASK DesiredAccess,
796 PLARGE_INTEGER AllocationSize,
797 ULONG FileAttributes,
798 ULONG CreateDisposition,
800 struct win32_apply_ctx *ctx)
802 return (*func_NtCreateFile)(FileHandle,
808 FILE_SHARE_VALID_FLAGS,
811 FILE_OPEN_FOR_BACKUP_INTENT |
812 FILE_OPEN_REPARSE_POINT,
817 /* Like do_create_file(), but builds the extraction path of the @dentry first.
820 create_file(PHANDLE FileHandle,
821 ACCESS_MASK DesiredAccess,
822 PLARGE_INTEGER AllocationSize,
823 ULONG FileAttributes,
824 ULONG CreateDisposition,
826 const struct wim_dentry *dentry,
827 struct win32_apply_ctx *ctx)
829 build_extraction_path(dentry, ctx);
830 return do_create_file(FileHandle,
839 /* Create empty named data streams.
841 * Since these won't have 'struct wim_lookup_table_entry's, they won't show up
842 * in the call to extract_stream_list(). Hence the need for the special case.
845 create_any_empty_ads(const struct wim_dentry *dentry,
846 struct win32_apply_ctx *ctx)
848 const struct wim_inode *inode = dentry->d_inode;
849 LARGE_INTEGER allocation_size;
850 bool path_modified = false;
853 if (!ctx->common.supported_features.named_data_streams)
856 for (u16 i = 0; i < inode->i_num_ads; i++) {
857 const struct wim_ads_entry *entry;
861 entry = &inode->i_ads_entries[i];
864 if (!entry->stream_name_nbytes)
871 /* Probably setting the allocation size to 0 has no effect, but
872 * we might as well try. */
873 allocation_size.QuadPart = 0;
875 build_extraction_path_with_ads(dentry, ctx,
877 entry->stream_name_nbytes /
879 path_modified = true;
880 status = do_create_file(&h, FILE_WRITE_DATA, &allocation_size,
881 0, FILE_SUPERSEDE, 0, ctx);
882 if (!NT_SUCCESS(status)) {
883 set_errno_from_nt_status(status);
884 ERROR_WITH_ERRNO("Can't create \"%ls\" "
885 "(status=0x%08"PRIx32")",
886 current_path(ctx), (u32)status);
887 ret = WIMLIB_ERR_OPEN;
892 /* Restore the path to the dentry itself */
894 build_extraction_path(dentry, ctx);
899 * Creates the directory named by @dentry, or uses an existing directory at that
900 * location. If necessary, sets the short name and/or fixes compression and
901 * encryption attributes.
903 * Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
906 create_directory(const struct wim_dentry *dentry,
907 struct win32_apply_ctx *ctx)
914 /* Special attributes:
916 * Use FILE_ATTRIBUTE_ENCRYPTED if the directory needs to have it set.
917 * This doesn't work for FILE_ATTRIBUTE_COMPRESSED (unfortunately).
919 * Don't specify FILE_ATTRIBUTE_DIRECTORY; it gets set anyway as a
920 * result of the FILE_DIRECTORY_FILE option. */
921 attrib = (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED);
923 /* DELETE is needed for set_short_name().
924 * GENERIC_READ and GENERIC_WRITE are needed for
925 * adjust_compression_attribute(). */
926 status = create_file(&h, GENERIC_READ | GENERIC_WRITE | DELETE, NULL,
927 attrib, FILE_OPEN_IF, FILE_DIRECTORY_FILE,
929 if (!NT_SUCCESS(status)) {
930 set_errno_from_nt_status(status);
931 ERROR_WITH_ERRNO("Can't create directory \"%ls\" "
932 "(status=0x%08"PRIx32")",
933 current_path(ctx), (u32)status);
934 return WIMLIB_ERR_MKDIR;
937 ret = set_short_name(h, dentry, ctx);
940 ret = adjust_compression_attribute(h, dentry, ctx);
943 ret = maybe_clear_encryption_attribute(&h, dentry, ctx);
944 /* May close the handle!!! */
952 * Create all the directories being extracted, other than the target directory
955 * Note: we don't honor directory hard links. However, we don't allow them to
956 * exist in WIM images anyway (see inode_fixup.c).
959 create_directories(struct list_head *dentry_list,
960 struct win32_apply_ctx *ctx)
962 const struct wim_dentry *dentry;
965 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
967 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
970 /* Note: Here we include files with
971 * FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
972 * wait until later to actually set the reparse data. */
974 /* If the root dentry is being extracted, it was already done so
975 * it prepare_target(). */
976 if (dentry_is_root(dentry))
979 ret = create_directory(dentry, ctx);
983 ret = create_any_empty_ads(dentry, ctx);
991 * Creates the nondirectory file named by @dentry.
993 * On success, returns an open handle to the file in @h_ret, with GENERIC_READ,
994 * GENERIC_WRITE, and DELETE access. Also, the path to the file will be saved
995 * in ctx->pathbuf. On failure, returns WIMLIB_ERR_OPEN.
998 create_nondirectory_inode(HANDLE *h_ret, const struct wim_dentry *dentry,
999 struct win32_apply_ctx *ctx)
1001 const struct wim_inode *inode;
1004 bool retried = false;
1006 inode = dentry->d_inode;
1008 /* If the file already exists and has FILE_ATTRIBUTE_SYSTEM and/or
1009 * FILE_ATTRIBUTE_HIDDEN, these must be specified in order to supersede
1012 * Normally the user shouldn't be trying to overwrite such files anyway,
1013 * but we at least provide FILE_ATTRIBUTE_SYSTEM and
1014 * FILE_ATTRIBUTE_HIDDEN if the WIM inode has those attributes so that
1015 * we catch the case where the user extracts the same files to the same
1016 * location more than one time.
1018 * Also specify FILE_ATTRIBUTE_ENCRYPTED if the file needs to be
1021 * In NO_ATTRIBUTES mode just don't specify any attributes at all.
1023 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) {
1026 attrib = (inode->i_attributes & (FILE_ATTRIBUTE_SYSTEM |
1027 FILE_ATTRIBUTE_HIDDEN |
1028 FILE_ATTRIBUTE_ENCRYPTED));
1030 build_extraction_path(dentry, ctx);
1032 status = do_create_file(h_ret, GENERIC_READ | GENERIC_WRITE | DELETE,
1033 NULL, attrib, FILE_SUPERSEDE,
1034 FILE_NON_DIRECTORY_FILE, ctx);
1035 if (NT_SUCCESS(status)) {
1038 ret = adjust_compression_attribute(*h_ret, dentry, ctx);
1040 (*func_NtClose)(*h_ret);
1044 ret = maybe_clear_encryption_attribute(h_ret, dentry, ctx);
1045 /* May close the handle!!! */
1049 (*func_NtClose)(*h_ret);
1054 /* Re-open the handle so that we can return it on
1056 status = do_create_file(h_ret,
1058 GENERIC_WRITE | DELETE,
1060 FILE_NON_DIRECTORY_FILE, ctx);
1061 if (!NT_SUCCESS(status))
1065 ret = create_any_empty_ads(dentry, ctx);
1067 (*func_NtClose)(*h_ret);
1073 if (status == STATUS_ACCESS_DENIED && !retried) {
1074 /* We also can't supersede an existing file that has
1075 * FILE_ATTRIBUTE_READONLY set; doing so causes NtCreateFile()
1076 * to return STATUS_ACCESS_DENIED . The only workaround seems
1077 * to be to explicitly remove FILE_ATTRIBUTE_READONLY on the
1078 * existing file, then try again. */
1080 FILE_BASIC_INFORMATION info;
1083 status = do_create_file(&h, FILE_WRITE_ATTRIBUTES, NULL, 0,
1084 FILE_OPEN, FILE_NON_DIRECTORY_FILE, ctx);
1085 if (!NT_SUCCESS(status))
1088 memset(&info, 0, sizeof(info));
1089 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
1091 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1092 &info, sizeof(info),
1093 FileBasicInformation);
1095 if (!NT_SUCCESS(status))
1101 set_errno_from_nt_status(status);
1102 ERROR_WITH_ERRNO("Can't create file \"%ls\" (status=0x%08"PRIx32")",
1103 current_path(ctx), (u32)status);
1104 return WIMLIB_ERR_OPEN;
1107 /* Creates a hard link at the location named by @dentry to the file represented
1108 * by the open handle @h. Or, if the target volume does not support hard links,
1109 * create a separate file instead. */
1111 create_link(HANDLE h, const struct wim_dentry *dentry,
1112 struct win32_apply_ctx *ctx)
1114 if (ctx->common.supported_features.hard_links) {
1116 build_extraction_path(dentry, ctx);
1118 size_t bufsize = offsetof(FILE_LINK_INFORMATION, FileName) +
1119 ctx->pathbuf.Length + sizeof(wchar_t);
1120 u8 buf[bufsize] _aligned_attribute(8);
1121 FILE_LINK_INFORMATION *info = (FILE_LINK_INFORMATION *)buf;
1124 info->ReplaceIfExists = TRUE;
1125 info->RootDirectory = ctx->attr.RootDirectory;
1126 info->FileNameLength = ctx->pathbuf.Length;
1127 memcpy(info->FileName, ctx->pathbuf.Buffer, ctx->pathbuf.Length);
1128 info->FileName[info->FileNameLength / 2] = L'\0';
1130 /* Note: the null terminator isn't actually necessary,
1131 * but if you don't add the extra character, you get
1132 * STATUS_INFO_LENGTH_MISMATCH when FileNameLength
1133 * happens to be 2 */
1135 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1137 FileLinkInformation);
1138 if (NT_SUCCESS(status))
1140 ERROR("Failed to create link \"%ls\" (status=0x%08"PRIx32")",
1141 current_path(ctx), (u32)status);
1142 return WIMLIB_ERR_LINK;
1147 ret = create_nondirectory_inode(&h2, dentry, ctx);
1151 (*func_NtClose)(h2);
1156 /* Given an inode (represented by the open handle @h) for which one link has
1157 * been created (named by @first_dentry), create the other links.
1159 * Or, if the target volume does not support hard links, create separate files.
1161 * Note: This uses ctx->pathbuf and does not reset it.
1164 create_links(HANDLE h, const struct wim_dentry *first_dentry,
1165 struct win32_apply_ctx *ctx)
1167 const struct wim_inode *inode;
1168 const struct list_head *next;
1169 const struct wim_dentry *dentry;
1172 inode = first_dentry->d_inode;
1173 next = inode->i_extraction_aliases.next;
1175 dentry = list_entry(next, struct wim_dentry,
1176 d_extraction_alias_node);
1177 if (dentry != first_dentry) {
1178 ret = create_link(h, dentry, ctx);
1183 } while (next != &inode->i_extraction_aliases);
1187 /* Create a nondirectory file, including all links. */
1189 create_nondirectory(const struct wim_inode *inode, struct win32_apply_ctx *ctx)
1191 const struct wim_dentry *first_dentry;
1195 first_dentry = first_extraction_alias(inode);
1197 /* Create first link. */
1198 ret = create_nondirectory_inode(&h, first_dentry, ctx);
1202 /* Set short name. */
1203 ret = set_short_name(h, first_dentry, ctx);
1205 /* Create additional links, OR if hard links are not supported just
1206 * create more files. */
1208 ret = create_links(h, first_dentry, ctx);
1214 /* Create all the nondirectory files being extracted, including all aliases
1217 create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1219 const struct wim_dentry *dentry;
1220 const struct wim_inode *inode;
1223 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1224 inode = dentry->d_inode;
1225 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1227 /* Call create_nondirectory() only once per inode */
1228 if (dentry != inode_first_extraction_dentry(inode))
1230 ret = create_nondirectory(inode, ctx);
1238 close_handles(struct win32_apply_ctx *ctx)
1240 for (unsigned i = 0; i < ctx->num_open_handles; i++)
1241 (*func_NtClose)(ctx->open_handles[i]);
1244 /* Prepare to read the next stream, which has size @stream_size, into an
1245 * in-memory buffer. */
1247 prepare_data_buffer(struct win32_apply_ctx *ctx, u64 stream_size)
1249 if (stream_size > ctx->data_buffer_size) {
1250 /* Larger buffer needed. */
1252 if ((size_t)stream_size != stream_size)
1253 return WIMLIB_ERR_NOMEM;
1254 new_buffer = REALLOC(ctx->data_buffer, stream_size);
1256 return WIMLIB_ERR_NOMEM;
1257 ctx->data_buffer = new_buffer;
1258 ctx->data_buffer_size = stream_size;
1260 /* On the first call this changes data_buffer_ptr from NULL, which tells
1261 * extract_chunk() that the data buffer needs to be filled while reading
1262 * the stream data. */
1263 ctx->data_buffer_ptr = ctx->data_buffer;
1268 begin_extract_stream_instance(const struct wim_lookup_table_entry *stream,
1269 struct wim_dentry *dentry,
1270 const wchar_t *stream_name,
1271 struct win32_apply_ctx *ctx)
1273 const struct wim_inode *inode = dentry->d_inode;
1274 size_t stream_name_nchars = 0;
1275 FILE_ALLOCATION_INFORMATION alloc_info;
1279 if (unlikely(stream_name))
1280 stream_name_nchars = wcslen(stream_name);
1282 if (unlikely(stream_name_nchars)) {
1283 build_extraction_path_with_ads(dentry, ctx,
1284 stream_name, stream_name_nchars);
1286 build_extraction_path(dentry, ctx);
1289 /* Reparse point? */
1290 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
1291 && (stream_name_nchars == 0))
1293 if (!ctx->common.supported_features.reparse_points)
1296 /* We can't write the reparse stream directly; we must set it
1297 * with FSCTL_SET_REPARSE_POINT, which requires that all the
1298 * data be available. So, stage the data in a buffer. */
1300 list_add_tail(&dentry->tmp_list, &ctx->reparse_dentries);
1301 return prepare_data_buffer(ctx, stream->size);
1304 /* Encrypted file? */
1305 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
1306 && (stream_name_nchars == 0))
1308 if (!ctx->common.supported_features.encrypted_files)
1311 /* We can't write encrypted file streams directly; we must use
1312 * WriteEncryptedFileRaw(), which requires providing the data
1313 * through a callback function. This can't easily be combined
1314 * with our own callback-based approach.
1316 * The current workaround is to simply read the stream into
1317 * memory and write the encrypted file from that.
1319 * TODO: This isn't sufficient for extremely large encrypted
1320 * files. Perhaps we should create an extra thread to write
1322 list_add_tail(&dentry->tmp_list, &ctx->encrypted_dentries);
1323 return prepare_data_buffer(ctx, stream->size);
1326 /* Extracting unnamed data stream in WIMBoot mode? */
1327 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)
1328 && (stream_name_nchars == 0)
1329 && (stream->resource_location == RESOURCE_IN_WIM)
1330 && (stream->rspec->wim == ctx->common.wim)
1331 && (stream->size == stream->rspec->uncompressed_size))
1333 int ret = calculate_dentry_full_path(dentry);
1336 if (in_prepopulate_list(dentry, ctx)) {
1337 union wimlib_progress_info info;
1339 info.wimboot_exclude.path_in_wim = dentry->_full_path;
1340 info.wimboot_exclude.extraction_path = current_path(ctx);
1342 ret = call_progress(ctx->common.progfunc,
1343 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE,
1344 &info, ctx->common.progctx);
1345 FREE(dentry->_full_path);
1346 dentry->_full_path = NULL;
1349 /* Go on and open the file for normal extraction. */
1351 FREE(dentry->_full_path);
1352 dentry->_full_path = NULL;
1353 return wimboot_set_pointer(&ctx->attr,
1356 ctx->wimboot.data_source_id,
1357 ctx->wimboot.wim_lookup_table_hash,
1358 ctx->wimboot.wof_running);
1362 /* Too many open handles? */
1363 if (ctx->num_open_handles == MAX_OPEN_HANDLES) {
1364 ERROR("Can't extract data: too many open files!");
1365 return WIMLIB_ERR_UNSUPPORTED;
1368 /* Open a new handle */
1369 status = do_create_file(&h,
1370 FILE_WRITE_DATA | SYNCHRONIZE,
1371 NULL, 0, FILE_OPEN_IF,
1372 FILE_SEQUENTIAL_ONLY |
1373 FILE_SYNCHRONOUS_IO_NONALERT,
1375 if (!NT_SUCCESS(status)) {
1376 set_errno_from_nt_status(status);
1377 ERROR_WITH_ERRNO("Can't open \"%ls\" for writing "
1378 "(status=0x%08"PRIx32")",
1379 current_path(ctx), (u32)status);
1380 return WIMLIB_ERR_OPEN;
1383 ctx->open_handles[ctx->num_open_handles++] = h;
1385 /* Allocate space for the data. */
1386 alloc_info.AllocationSize.QuadPart = stream->size;
1387 (*func_NtSetInformationFile)(h, &ctx->iosb,
1388 &alloc_info, sizeof(alloc_info),
1389 FileAllocationInformation);
1393 /* Set the reparse data @rpbuf of length @rpbuflen on the extracted file
1394 * corresponding to the WIM dentry @dentry. */
1396 do_set_reparse_data(const struct wim_dentry *dentry,
1397 const void *rpbuf, u16 rpbuflen,
1398 struct win32_apply_ctx *ctx)
1403 status = create_file(&h, GENERIC_WRITE, NULL,
1404 0, FILE_OPEN, 0, dentry, ctx);
1405 if (!NT_SUCCESS(status))
1408 status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
1409 &ctx->iosb, FSCTL_SET_REPARSE_POINT,
1410 (void *)rpbuf, rpbuflen,
1414 if (NT_SUCCESS(status))
1417 /* On Windows, by default only the Administrator can create symbolic
1418 * links for some reason. By default we just issue a warning if this
1419 * appears to be the problem. Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
1420 * to get a hard error. */
1421 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
1422 && (status == STATUS_PRIVILEGE_NOT_HELD ||
1423 status == STATUS_ACCESS_DENIED)
1424 && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1425 dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1427 WARNING("Can't create symbolic link \"%ls\"! \n"
1428 " (Need Administrator rights, or at least "
1430 " SeCreateSymbolicLink privilege.)",
1436 set_errno_from_nt_status(status);
1437 ERROR_WITH_ERRNO("Can't set reparse data on \"%ls\" "
1438 "(status=0x%08"PRIx32")",
1439 current_path(ctx), (u32)status);
1440 return WIMLIB_ERR_SET_REPARSE_DATA;
1443 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1444 * pointer to the suffix of the path that begins with the device directly, such
1445 * as e:\Windows\System32. */
1446 static const wchar_t *
1447 skip_nt_toplevel_component(const wchar_t *path, size_t path_nchars)
1449 static const wchar_t * const dirs[] = {
1454 size_t first_dir_len = 0;
1455 const wchar_t * const end = path + path_nchars;
1457 for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
1458 size_t len = wcslen(dirs[i]);
1459 if (len <= (end - path) && !wcsnicmp(path, dirs[i], len)) {
1460 first_dir_len = len;
1464 if (first_dir_len == 0)
1466 path += first_dir_len;
1467 while (path != end && *path == L'\\')
1472 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1473 * pointer to the suffix of the path that is device-relative, such as
1474 * Windows\System32. */
1475 static const wchar_t *
1476 get_device_relative_path(const wchar_t *path, size_t path_nchars)
1478 const wchar_t * const orig_path = path;
1479 const wchar_t * const end = path + path_nchars;
1481 path = skip_nt_toplevel_component(path, path_nchars);
1482 if (path == orig_path)
1485 path = wmemchr(path, L'\\', (end - path));
1490 } while (path != end && *path == L'\\');
1495 * Given a reparse point buffer for a symbolic link or junction, adjust its
1496 * contents so that the target of the link is consistent with the new location
1500 try_rpfix(u8 *rpbuf, u16 *rpbuflen_p, struct win32_apply_ctx *ctx)
1502 struct reparse_data rpdata;
1503 size_t orig_subst_name_nchars;
1504 const wchar_t *relpath;
1505 size_t relpath_nchars;
1506 size_t target_ntpath_nchars;
1507 size_t fixed_subst_name_nchars;
1508 const wchar_t *fixed_print_name;
1509 size_t fixed_print_name_nchars;
1511 if (parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata)) {
1512 /* Do nothing if the reparse data is invalid. */
1516 if (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK &&
1517 (rpdata.rpflags & SYMBOLIC_LINK_RELATIVE))
1519 /* Do nothing if it's a relative symbolic link. */
1523 /* Build the new substitute name from the NT namespace path to the
1524 * target directory, then a path separator, then the "device relative"
1525 * part of the old substitute name. */
1527 orig_subst_name_nchars = rpdata.substitute_name_nbytes / sizeof(wchar_t);
1529 relpath = get_device_relative_path(rpdata.substitute_name,
1530 orig_subst_name_nchars);
1531 relpath_nchars = orig_subst_name_nchars -
1532 (relpath - rpdata.substitute_name);
1534 target_ntpath_nchars = ctx->target_ntpath.Length / sizeof(wchar_t);
1536 fixed_subst_name_nchars = target_ntpath_nchars + 1 + relpath_nchars;
1537 wchar_t fixed_subst_name[fixed_subst_name_nchars];
1539 wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer,
1540 target_ntpath_nchars);
1541 fixed_subst_name[target_ntpath_nchars] = L'\\';
1542 wmemcpy(&fixed_subst_name[target_ntpath_nchars + 1],
1543 relpath, relpath_nchars);
1544 /* Doesn't need to be null-terminated. */
1546 /* Print name should be Win32, but not all NT names can even be
1547 * translated to Win32 names. But we can at least delete the top-level
1548 * directory, such as \??\, and this will have the expected result in
1549 * the usual case. */
1550 fixed_print_name = skip_nt_toplevel_component(fixed_subst_name,
1551 fixed_subst_name_nchars);
1552 fixed_print_name_nchars = fixed_subst_name_nchars - (fixed_print_name -
1555 rpdata.substitute_name = fixed_subst_name;
1556 rpdata.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
1557 rpdata.print_name = (wchar_t *)fixed_print_name;
1558 rpdata.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
1559 make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p);
1562 /* Sets reparse data on the specified file. This handles "fixing" the targets
1563 * of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX was
1566 set_reparse_data(const struct wim_dentry *dentry,
1567 const void *_rpbuf, u16 rpbuflen, struct win32_apply_ctx *ctx)
1569 const struct wim_inode *inode = dentry->d_inode;
1570 const void *rpbuf = _rpbuf;
1572 if ((ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
1573 && !inode->i_not_rpfixed
1574 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1575 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1577 memcpy(&ctx->rpfixbuf, _rpbuf, rpbuflen);
1578 try_rpfix((u8 *)&ctx->rpfixbuf, &rpbuflen, ctx);
1579 rpbuf = &ctx->rpfixbuf;
1581 return do_set_reparse_data(dentry, rpbuf, rpbuflen, ctx);
1585 /* Import the next block of raw encrypted data */
1587 import_encrypted_data(PBYTE pbData, PVOID pvCallbackContext, PULONG Length)
1589 struct win32_apply_ctx *ctx = pvCallbackContext;
1592 copy_len = min(ctx->encrypted_size - ctx->encrypted_offset, *Length);
1593 memcpy(pbData, &ctx->data_buffer[ctx->encrypted_offset], copy_len);
1594 ctx->encrypted_offset += copy_len;
1596 return ERROR_SUCCESS;
1599 /* Write the raw encrypted data to the already-created file corresponding to
1602 * The raw encrypted data is provided in ctx->data_buffer, and its size is
1603 * ctx->encrypted_size. */
1605 extract_encrypted_file(const struct wim_dentry *dentry,
1606 struct win32_apply_ctx *ctx)
1611 /* Temporarily build a Win32 path for OpenEncryptedFileRaw() */
1612 build_win32_extraction_path(dentry, ctx);
1614 err = OpenEncryptedFileRaw(ctx->pathbuf.Buffer,
1615 CREATE_FOR_IMPORT, &rawctx);
1617 /* Restore the NT namespace path */
1618 build_extraction_path(dentry, ctx);
1620 if (err != ERROR_SUCCESS) {
1621 set_errno_from_win32_error(err);
1622 ERROR_WITH_ERRNO("Can't open \"%ls\" for encrypted import "
1623 "(err=%"PRIu32")", current_path(ctx), (u32)err);
1624 return WIMLIB_ERR_OPEN;
1627 ctx->encrypted_offset = 0;
1629 err = WriteEncryptedFileRaw(import_encrypted_data, ctx, rawctx);
1631 CloseEncryptedFileRaw(rawctx);
1633 if (err != ERROR_SUCCESS) {
1634 set_errno_from_win32_error(err);
1635 ERROR_WITH_ERRNO("Can't import encrypted file \"%ls\" "
1636 "(err=%"PRIu32")", current_path(ctx), (u32)err);
1637 return WIMLIB_ERR_WRITE;
1643 /* Called when starting to read a stream for extraction on Windows */
1645 begin_extract_stream(struct wim_lookup_table_entry *stream,
1646 u32 flags, void *_ctx)
1648 struct win32_apply_ctx *ctx = _ctx;
1649 const struct stream_owner *owners = stream_owners(stream);
1652 ctx->num_open_handles = 0;
1653 ctx->data_buffer_ptr = NULL;
1654 INIT_LIST_HEAD(&ctx->reparse_dentries);
1655 INIT_LIST_HEAD(&ctx->encrypted_dentries);
1657 for (u32 i = 0; i < stream->out_refcnt; i++) {
1658 const struct wim_inode *inode = owners[i].inode;
1659 const wchar_t *stream_name = owners[i].stream_name;
1660 struct wim_dentry *dentry;
1662 /* A copy of the stream needs to be extracted to @inode. */
1664 if (ctx->common.supported_features.hard_links) {
1665 dentry = inode_first_extraction_dentry(inode);
1666 ret = begin_extract_stream_instance(stream, dentry,
1671 /* Hard links not supported. Extract the stream
1672 * separately to each alias of the inode. */
1673 struct list_head *next;
1675 next = inode->i_extraction_aliases.next;
1677 dentry = list_entry(next, struct wim_dentry,
1678 d_extraction_alias_node);
1679 ret = begin_extract_stream_instance(stream,
1686 } while (next != &inode->i_extraction_aliases);
1690 if (unlikely(ctx->num_open_handles == 0 && ctx->data_buffer_ptr == NULL)) {
1691 /* The data of this stream isn't actually needed!
1692 * (This can happen in WIMBoot mode.) */
1693 return BEGIN_STREAM_STATUS_SKIP_STREAM;
1702 /* Called when the next chunk of a stream has been read for extraction on
1705 extract_chunk(const void *chunk, size_t size, void *_ctx)
1707 struct win32_apply_ctx *ctx = _ctx;
1709 /* Write the data chunk to each open handle */
1710 for (unsigned i = 0; i < ctx->num_open_handles; i++) {
1711 u8 *bufptr = (u8 *)chunk;
1712 size_t bytes_remaining = size;
1714 while (bytes_remaining) {
1715 ULONG count = min(0xFFFFFFFF, bytes_remaining);
1717 status = (*func_NtWriteFile)(ctx->open_handles[i],
1719 &ctx->iosb, bufptr, count,
1721 if (!NT_SUCCESS(status)) {
1722 set_errno_from_nt_status(status);
1723 ERROR_WITH_ERRNO("Error writing data to target "
1724 "volume (status=0x%08"PRIx32")",
1726 return WIMLIB_ERR_WRITE;
1728 bufptr += ctx->iosb.Information;
1729 bytes_remaining -= ctx->iosb.Information;
1733 /* Copy the data chunk into the buffer (if needed) */
1734 if (ctx->data_buffer_ptr)
1735 ctx->data_buffer_ptr = mempcpy(ctx->data_buffer_ptr,
1740 /* Called when a stream has been fully read for extraction on Windows */
1742 end_extract_stream(struct wim_lookup_table_entry *stream, int status, void *_ctx)
1744 struct win32_apply_ctx *ctx = _ctx;
1746 const struct wim_dentry *dentry;
1753 if (likely(!ctx->data_buffer_ptr))
1756 if (!list_empty(&ctx->reparse_dentries)) {
1757 if (stream->size > REPARSE_DATA_MAX_SIZE) {
1758 dentry = list_first_entry(&ctx->reparse_dentries,
1759 struct wim_dentry, tmp_list);
1760 build_extraction_path(dentry, ctx);
1761 ERROR("Reparse data of \"%ls\" has size "
1762 "%"PRIu64" bytes (exceeds %u bytes)",
1763 current_path(ctx), stream->size,
1764 REPARSE_DATA_MAX_SIZE);
1765 return WIMLIB_ERR_INVALID_REPARSE_DATA;
1767 /* In the WIM format, reparse streams are just the reparse data
1768 * and omit the header. But we can reconstruct the header. */
1769 memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, stream->size);
1770 ctx->rpbuf.rpdatalen = stream->size;
1771 ctx->rpbuf.rpreserved = 0;
1772 list_for_each_entry(dentry, &ctx->reparse_dentries, tmp_list) {
1773 ctx->rpbuf.rptag = dentry->d_inode->i_reparse_tag;
1774 ret = set_reparse_data(dentry, &ctx->rpbuf,
1775 stream->size + REPARSE_DATA_OFFSET,
1782 if (!list_empty(&ctx->encrypted_dentries)) {
1783 ctx->encrypted_size = stream->size;
1784 list_for_each_entry(dentry, &ctx->encrypted_dentries, tmp_list) {
1785 ret = extract_encrypted_file(dentry, ctx);
1794 /* Attributes that can't be set directly */
1795 #define SPECIAL_ATTRIBUTES \
1796 (FILE_ATTRIBUTE_REPARSE_POINT | \
1797 FILE_ATTRIBUTE_DIRECTORY | \
1798 FILE_ATTRIBUTE_ENCRYPTED | \
1799 FILE_ATTRIBUTE_SPARSE_FILE | \
1800 FILE_ATTRIBUTE_COMPRESSED)
1802 /* Set the security descriptor @desc, of @desc_size bytes, on the file with open
1805 set_security_descriptor(HANDLE h, const void *desc,
1806 size_t desc_size, struct win32_apply_ctx *ctx)
1808 SECURITY_INFORMATION info;
1811 /* We really just want to set entire the security descriptor as-is, but
1812 * all available APIs require specifying the specific parts of the
1813 * descriptor being set. Start out by requesting all parts be set. If
1814 * permissions problems are encountered, fall back to omitting some
1815 * parts (first the SACL, then the DACL, then the owner), unless the
1816 * WIMLIB_EXTRACT_FLAG_STRICT_ACLS flag has been enabled. */
1817 info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
1818 DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION;
1820 /* Prefer NtSetSecurityObject() to SetFileSecurity(). SetFileSecurity()
1821 * itself necessarily uses NtSetSecurityObject() as the latter is the
1822 * underlying system call for setting security information, but
1823 * SetFileSecurity() opens the handle with NtCreateFile() without
1824 * FILE_OPEN_FILE_BACKUP_INTENT. Hence, access checks are done and due
1825 * to the Windows security model, even a process running as the
1826 * Administrator can have access denied. (Of course, this not mentioned
1827 * in the MS "documentation".) */
1829 status = (*func_NtSetSecurityObject)(h, info, (PSECURITY_DESCRIPTOR)desc);
1830 if (NT_SUCCESS(status))
1832 /* Failed to set the requested parts of the security descriptor. If the
1833 * error was permissions-related, try to set fewer parts of the security
1834 * descriptor, unless WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled. */
1835 if ((status == STATUS_PRIVILEGE_NOT_HELD ||
1836 status == STATUS_ACCESS_DENIED) &&
1837 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
1839 if (info & SACL_SECURITY_INFORMATION) {
1840 info &= ~SACL_SECURITY_INFORMATION;
1841 ctx->partial_security_descriptors++;
1844 if (info & DACL_SECURITY_INFORMATION) {
1845 info &= ~DACL_SECURITY_INFORMATION;
1848 if (info & OWNER_SECURITY_INFORMATION) {
1849 info &= ~OWNER_SECURITY_INFORMATION;
1852 /* Nothing left except GROUP, and if we removed it we
1853 * wouldn't have anything at all. */
1856 /* No part of the security descriptor could be set, or
1857 * WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled and the full security
1858 * descriptor could not be set. */
1859 if (!(info & SACL_SECURITY_INFORMATION))
1860 ctx->partial_security_descriptors--;
1861 ctx->no_security_descriptors++;
1865 /* Set metadata on the open file @h from the WIM inode @inode. */
1867 do_apply_metadata_to_file(HANDLE h, const struct wim_inode *inode,
1868 struct win32_apply_ctx *ctx)
1870 FILE_BASIC_INFORMATION info;
1873 /* Set security descriptor if present and not in NO_ACLS mode */
1874 if (inode->i_security_id >= 0 &&
1875 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
1877 const struct wim_security_data *sd;
1881 sd = wim_get_current_security_data(ctx->common.wim);
1882 desc = sd->descriptors[inode->i_security_id];
1883 desc_size = sd->sizes[inode->i_security_id];
1885 status = set_security_descriptor(h, desc, desc_size, ctx);
1886 if (!NT_SUCCESS(status) &&
1887 (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
1889 set_errno_from_nt_status(status);
1890 ERROR_WITH_ERRNO("Can't set security descriptor "
1891 "on \"%ls\" (status=0x%08"PRIx32")",
1892 current_path(ctx), (u32)status);
1893 return WIMLIB_ERR_SET_SECURITY;
1897 /* Set attributes and timestamps */
1898 info.CreationTime.QuadPart = inode->i_creation_time;
1899 info.LastAccessTime.QuadPart = inode->i_last_access_time;
1900 info.LastWriteTime.QuadPart = inode->i_last_write_time;
1901 info.ChangeTime.QuadPart = 0;
1902 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
1903 info.FileAttributes = 0;
1905 info.FileAttributes = inode->i_attributes & ~SPECIAL_ATTRIBUTES;
1907 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1908 &info, sizeof(info),
1909 FileBasicInformation);
1910 /* On FAT volumes we get STATUS_INVALID_PARAMETER if we try to set
1911 * attributes on the root directory. (Apparently because FAT doesn't
1912 * actually have a place to store those attributes!) */
1913 if (!NT_SUCCESS(status)
1914 && !(status == STATUS_INVALID_PARAMETER &&
1915 dentry_is_root(inode_first_extraction_dentry(inode))))
1917 set_errno_from_nt_status(status);
1918 ERROR_WITH_ERRNO("Can't set basic metadata on \"%ls\" "
1919 "(status=0x%08"PRIx32")",
1920 current_path(ctx), (u32)status);
1921 return WIMLIB_ERR_SET_ATTRIBUTES;
1928 apply_metadata_to_file(const struct wim_dentry *dentry,
1929 struct win32_apply_ctx *ctx)
1931 const struct wim_inode *inode = dentry->d_inode;
1937 perms = FILE_WRITE_ATTRIBUTES | WRITE_DAC |
1938 WRITE_OWNER | ACCESS_SYSTEM_SECURITY;
1940 build_extraction_path(dentry, ctx);
1942 /* Open a handle with as many relevant permissions as possible. */
1943 while (!NT_SUCCESS(status = do_create_file(&h, perms, NULL,
1944 0, FILE_OPEN, 0, ctx)))
1946 if (status == STATUS_PRIVILEGE_NOT_HELD ||
1947 status == STATUS_ACCESS_DENIED)
1949 if (perms & ACCESS_SYSTEM_SECURITY) {
1950 perms &= ~ACCESS_SYSTEM_SECURITY;
1953 if (perms & WRITE_DAC) {
1954 perms &= ~WRITE_DAC;
1957 if (perms & WRITE_OWNER) {
1958 perms &= ~WRITE_OWNER;
1962 set_errno_from_nt_status(status);
1963 ERROR_WITH_ERRNO("Can't open \"%ls\" to set metadata "
1964 "(status=0x%08"PRIx32")",
1965 current_path(ctx), (u32)status);
1966 return WIMLIB_ERR_OPEN;
1969 ret = do_apply_metadata_to_file(h, inode, ctx);
1977 apply_metadata(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1979 const struct wim_dentry *dentry;
1982 /* We go in reverse so that metadata is set on all a directory's
1983 * children before the directory itself. This avoids any potential
1984 * problems with attributes, timestamps, or security descriptors. */
1985 list_for_each_entry_reverse(dentry, dentry_list, d_extraction_list_node)
1987 ret = apply_metadata_to_file(dentry, ctx);
1994 /* Issue warnings about problems during the extraction for which warnings were
1995 * not already issued (due to the high number of potential warnings if we issued
1996 * them per-file). */
1998 do_warnings(const struct win32_apply_ctx *ctx)
2000 if (ctx->partial_security_descriptors == 0 &&
2001 ctx->no_security_descriptors == 0)
2004 WARNING("Extraction to \"%ls\" complete, but with one or more warnings:",
2005 ctx->common.target);
2006 if (ctx->partial_security_descriptors != 0) {
2007 WARNING("- Could only partially set the security descriptor\n"
2008 " on %lu files or directories.",
2009 ctx->partial_security_descriptors);
2011 if (ctx->no_security_descriptors != 0) {
2012 WARNING("- Could not set security descriptor at all\n"
2013 " on %lu files or directories.",
2014 ctx->no_security_descriptors);
2016 WARNING("To fully restore all security descriptors, run the program\n"
2017 " with Administrator rights.");
2020 /* Extract files from a WIM image to a directory on Windows */
2022 win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
2025 struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
2027 ret = prepare_target(dentry_list, ctx);
2031 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT) {
2032 ret = start_wimboot_extraction(ctx);
2037 ret = create_directories(dentry_list, ctx);
2041 ret = create_nondirectories(dentry_list, ctx);
2045 struct read_stream_list_callbacks cbs = {
2046 .begin_stream = begin_extract_stream,
2047 .begin_stream_ctx = ctx,
2048 .consume_chunk = extract_chunk,
2049 .consume_chunk_ctx = ctx,
2050 .end_stream = end_extract_stream,
2051 .end_stream_ctx = ctx,
2053 ret = extract_stream_list(&ctx->common, &cbs);
2057 ret = apply_metadata(dentry_list, ctx);
2064 (*func_NtClose)(ctx->h_target);
2065 if (ctx->target_ntpath.Buffer)
2066 HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
2067 FREE(ctx->pathbuf.Buffer);
2068 FREE(ctx->print_buffer);
2069 if (ctx->wimboot.prepopulate_pats) {
2070 FREE(ctx->wimboot.prepopulate_pats->strings);
2071 FREE(ctx->wimboot.prepopulate_pats);
2073 FREE(ctx->wimboot.mem_prepopulate_pats);
2074 FREE(ctx->data_buffer);
2078 const struct apply_operations win32_apply_ops = {
2080 .get_supported_features = win32_get_supported_features,
2081 .extract = win32_extract,
2082 .context_size = sizeof(struct win32_apply_ctx),
2085 #endif /* __WIN32__ */