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 struct win32_apply_ctx {
45 /* Extract flags, the pointer to the WIMStruct, etc. */
46 struct apply_ctx common;
48 /* WIMBoot information, only filled in if WIMLIB_EXTRACT_FLAG_WIMBOOT
52 struct string_set *prepopulate_pats;
53 void *mem_prepopulate_pats;
54 u8 wim_lookup_table_hash[SHA1_HASH_SIZE];
56 bool tried_to_load_prepopulate_list;
59 /* Open handle to the target directory */
62 /* NT namespace path to the target directory (buffer allocated) */
63 UNICODE_STRING target_ntpath;
65 /* Temporary buffer for building paths (buffer allocated) */
66 UNICODE_STRING pathbuf;
68 /* Object attributes to reuse for opening files in the target directory.
69 * (attr.ObjectName == &pathbuf) and (attr.RootDirectory == h_target).
71 OBJECT_ATTRIBUTES attr;
73 /* Temporary I/O status block for system calls */
76 /* Allocated buffer for creating "printable" paths from our
77 * target-relative NT paths */
78 wchar_t *print_buffer;
80 /* Allocated buffer for reading stream data when it cannot be extracted
84 /* Pointer to the next byte in @data_buffer to fill */
87 /* Size allocated in @data_buffer */
88 size_t data_buffer_size;
90 /* Current offset in the raw encrypted file being written */
91 size_t encrypted_offset;
93 /* Current size of the raw encrypted file being written */
94 size_t encrypted_size;
96 /* Temporary buffer for reparse data */
97 struct reparse_buffer_disk rpbuf;
99 /* Temporary buffer for reparse data of "fixed" absolute symbolic links
101 struct reparse_buffer_disk rpfixbuf;
103 /* Array of open handles to filesystem streams currently being written
105 HANDLE open_handles[MAX_OPEN_STREAMS];
107 /* Number of handles in @open_handles currently open (filled in from the
108 * beginning of the array) */
109 unsigned num_open_handles;
111 /* List of dentries, joined by @tmp_list, that need to have reparse data
112 * extracted as soon as the whole stream has been read into
114 struct list_head reparse_dentries;
116 /* List of dentries, joined by @tmp_list, that need to have raw
117 * encrypted data extracted as soon as the whole stream has been read
118 * into @data_buffer. */
119 struct list_head encrypted_dentries;
121 /* Number of files for which we didn't have permission to set the full
122 * security descriptor. */
123 unsigned long partial_security_descriptors;
125 /* Number of files for which we didn't have permission to set any part
126 * of the security descriptor. */
127 unsigned long no_security_descriptors;
129 /* Number of files for which we couldn't set the short name. */
130 unsigned long num_short_name_failures;
132 /* Have we tried to enable short name support on the target volume yet?
134 bool tried_to_enable_short_names;
137 /* Get the drive letter from a Windows path, or return the null character if the
138 * path is relative. */
140 get_drive_letter(const wchar_t *path)
142 /* Skip \\?\ prefix */
143 if (!wcsncmp(path, L"\\\\?\\", 4))
146 /* Return drive letter if valid */
147 if (((path[0] >= L'a' && path[0] <= L'z') ||
148 (path[0] >= L'A' && path[0] <= L'Z')) && path[1] == L':')
155 get_vol_flags(const wchar_t *target, DWORD *vol_flags_ret,
156 bool *short_names_supported_ret)
158 wchar_t filesystem_name[MAX_PATH + 1];
160 wchar_t *volume = NULL;
163 *short_names_supported_ret = false;
165 drive[0] = get_drive_letter(target);
173 if (!GetVolumeInformation(volume, NULL, 0, NULL, NULL,
174 vol_flags_ret, filesystem_name,
175 ARRAY_LEN(filesystem_name)))
177 DWORD err = GetLastError();
178 set_errno_from_win32_error(err);
179 WARNING_WITH_ERRNO("Failed to get volume information for "
180 "\"%ls\" (err=%"PRIu32")",
185 if (wcsstr(filesystem_name, L"NTFS")) {
186 /* FILE_SUPPORTS_HARD_LINKS is only supported on Windows 7 and
187 * later. Force it on anyway if filesystem is NTFS. */
188 *vol_flags_ret |= FILE_SUPPORTS_HARD_LINKS;
190 /* There's no volume flag for short names, but according to the
191 * MS documentation they are only user-settable on NTFS. */
192 *short_names_supported_ret = true;
197 win32_get_supported_features(const wchar_t *target,
198 struct wim_features *supported_features)
201 bool short_names_supported;
203 /* Query the features of the target volume. */
205 get_vol_flags(target, &vol_flags, &short_names_supported);
207 supported_features->archive_files = 1;
208 supported_features->hidden_files = 1;
209 supported_features->system_files = 1;
211 if (vol_flags & FILE_FILE_COMPRESSION)
212 supported_features->compressed_files = 1;
214 if (vol_flags & FILE_SUPPORTS_ENCRYPTION) {
215 supported_features->encrypted_files = 1;
216 supported_features->encrypted_directories = 1;
219 supported_features->not_context_indexed_files = 1;
221 /* Don't do anything with FILE_SUPPORTS_SPARSE_FILES. */
223 if (vol_flags & FILE_NAMED_STREAMS)
224 supported_features->named_data_streams = 1;
226 if (vol_flags & FILE_SUPPORTS_HARD_LINKS)
227 supported_features->hard_links = 1;
229 if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS)
230 supported_features->reparse_points = 1;
232 if (vol_flags & FILE_PERSISTENT_ACLS)
233 supported_features->security_descriptors = 1;
235 if (short_names_supported)
236 supported_features->short_names = 1;
238 supported_features->timestamps = 1;
240 /* Note: Windows does not support case sensitive filenames! At least
241 * not without changing the registry and rebooting... */
246 /* Load the patterns from [PrepopulateList] of WimBootCompress.ini in the WIM
247 * image being extracted. */
249 load_prepopulate_pats(struct win32_apply_ctx *ctx)
251 const wchar_t *path = L"\\Windows\\System32\\WimBootCompress.ini";
252 struct wim_dentry *dentry;
253 struct wim_lookup_table_entry *lte;
256 struct string_set *s;
258 struct text_file_section sec;
260 ctx->wimboot.tried_to_load_prepopulate_list = true;
262 dentry = get_dentry(ctx->common.wim, path, WIMLIB_CASE_INSENSITIVE);
264 (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
265 FILE_ATTRIBUTE_REPARSE_POINT |
266 FILE_ATTRIBUTE_ENCRYPTED)) ||
267 !(lte = inode_unnamed_lte(dentry->d_inode, ctx->common.wim->lookup_table)))
269 WARNING("%ls does not exist in WIM image!", path);
270 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
273 ret = read_full_stream_into_alloc_buf(lte, &buf);
277 s = CALLOC(1, sizeof(struct string_set));
280 return WIMLIB_ERR_NOMEM;
283 sec.name = T("PrepopulateList");
286 ret = do_load_text_file(path, buf, lte->size, &mem, &sec, 1,
287 LOAD_TEXT_FILE_REMOVE_QUOTES |
288 LOAD_TEXT_FILE_NO_WARNINGS,
290 BUILD_BUG_ON(OS_PREFERRED_PATH_SEPARATOR != WIM_PATH_SEPARATOR);
296 ctx->wimboot.prepopulate_pats = s;
297 ctx->wimboot.mem_prepopulate_pats = mem;
301 /* Returns %true if the path to @dentry matches a pattern in [PrepopulateList]
302 * of WimBootCompress.ini. Otherwise returns %false.
304 * @dentry must have had its full path calculated. */
306 in_prepopulate_list(struct wim_dentry *dentry,
307 const struct win32_apply_ctx *ctx)
309 const struct string_set *pats = ctx->wimboot.prepopulate_pats;
311 if (!pats || !pats->num_strings)
314 return match_pattern_list(dentry->_full_path,
315 wcslen(dentry->_full_path), pats);
318 static const wchar_t *
319 current_path(struct win32_apply_ctx *ctx);
322 build_extraction_path(const struct wim_dentry *dentry,
323 struct win32_apply_ctx *ctx);
325 #define WIM_BACKING_NOT_ENABLED -1
326 #define WIM_BACKING_NOT_POSSIBLE -2
327 #define WIM_BACKING_EXCLUDED -3
330 * Determines if the unnamed data stream of a file will be created as an
331 * external backing, as opposed to a standard extraction.
334 win32_will_externally_back(struct wim_dentry *dentry, struct apply_ctx *_ctx)
336 struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
337 struct wim_lookup_table_entry *stream;
340 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
341 return WIM_BACKING_NOT_ENABLED;
343 if (!ctx->wimboot.tried_to_load_prepopulate_list) {
344 ret = load_prepopulate_pats(ctx);
345 if (ret == WIMLIB_ERR_NOMEM)
349 if (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
350 FILE_ATTRIBUTE_REPARSE_POINT |
351 FILE_ATTRIBUTE_ENCRYPTED))
352 return WIM_BACKING_NOT_POSSIBLE;
354 stream = inode_unnamed_lte_resolved(dentry->d_inode);
357 stream->resource_location != RESOURCE_IN_WIM ||
358 stream->rspec->wim != ctx->common.wim ||
359 stream->size != stream->rspec->uncompressed_size)
360 return WIM_BACKING_NOT_POSSIBLE;
362 ret = calculate_dentry_full_path(dentry);
366 if (in_prepopulate_list(dentry, ctx))
367 return WIM_BACKING_EXCLUDED;
373 set_external_backing(HANDLE h, struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
377 ret = win32_will_externally_back(dentry, &ctx->common);
378 if (ret > 0) /* Error. */
381 if (ret < 0 && ret != WIM_BACKING_EXCLUDED)
382 return 0; /* Not externally backing, other than due to exclusion. */
384 build_extraction_path(dentry, ctx);
386 if (ret == WIM_BACKING_EXCLUDED) {
387 /* Not externally backing due to exclusion. */
388 union wimlib_progress_info info;
390 info.wimboot_exclude.path_in_wim = dentry->_full_path;
391 info.wimboot_exclude.extraction_path = current_path(ctx);
393 return call_progress(ctx->common.progfunc,
394 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE,
395 &info, ctx->common.progctx);
397 /* Externally backing. */
398 return wimboot_set_pointer(h,
400 inode_unnamed_lte_resolved(dentry->d_inode),
401 ctx->wimboot.data_source_id,
402 ctx->wimboot.wim_lookup_table_hash,
403 ctx->wimboot.wof_running);
407 /* Calculates the SHA-1 message digest of the WIM's lookup table. */
409 hash_lookup_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
411 return wim_reshdr_to_hash(&wim->hdr.lookup_table_reshdr, wim, hash);
414 /* Prepare for doing a "WIMBoot" extraction by loading patterns from
415 * [PrepopulateList] of WimBootCompress.ini and allocating a WOF data source ID
416 * on the target volume. */
418 start_wimboot_extraction(struct win32_apply_ctx *ctx)
421 WIMStruct *wim = ctx->common.wim;
423 if (!ctx->wimboot.tried_to_load_prepopulate_list) {
424 ret = load_prepopulate_pats(ctx);
425 if (ret == WIMLIB_ERR_NOMEM)
429 if (!wim_info_get_wimboot(wim->wim_info, wim->current_image))
430 WARNING("Image is not marked as WIMBoot compatible!");
432 ret = hash_lookup_table(ctx->common.wim,
433 ctx->wimboot.wim_lookup_table_hash);
437 return wimboot_alloc_data_source_id(wim->filename,
441 &ctx->wimboot.data_source_id,
442 &ctx->wimboot.wof_running);
446 build_win32_extraction_path(const struct wim_dentry *dentry,
447 struct win32_apply_ctx *ctx);
449 /* Sets WimBoot=1 in the extracted SYSTEM registry hive.
451 * WIMGAPI does this, and it's possible that it's important.
452 * But I don't know exactly what this value means to Windows. */
454 end_wimboot_extraction(struct win32_apply_ctx *ctx)
456 struct wim_dentry *dentry;
457 wchar_t subkeyname[32];
463 dentry = get_dentry(ctx->common.wim, L"\\Windows\\System32\\config\\SYSTEM",
464 WIMLIB_CASE_INSENSITIVE);
466 if (!dentry || !will_extract_dentry(dentry))
469 if (!will_extract_dentry(wim_get_current_root_dentry(ctx->common.wim)))
472 /* Not bothering to use the native routines (e.g. NtLoadKey()) for this.
473 * If this doesn't work, you probably also have many other problems. */
475 build_win32_extraction_path(dentry, ctx);
477 randomize_char_array_with_alnum(subkeyname, 20);
478 subkeyname[20] = L'\0';
480 res = RegLoadKey(HKEY_LOCAL_MACHINE, subkeyname, ctx->pathbuf.Buffer);
484 wcscpy(&subkeyname[20], L"\\Setup");
486 res = RegCreateKeyEx(HKEY_LOCAL_MACHINE, subkeyname, 0, NULL,
487 REG_OPTION_BACKUP_RESTORE, 0, NULL, &key, NULL);
493 res = RegSetValueEx(key, L"WimBoot", 0, REG_DWORD,
494 (const BYTE *)&value, sizeof(DWORD));
498 res = RegFlushKey(key);
501 res2 = RegCloseKey(key);
505 subkeyname[20] = L'\0';
506 RegUnLoadKey(HKEY_LOCAL_MACHINE, subkeyname);
510 set_errno_from_win32_error(res);
511 WARNING_WITH_ERRNO("Failed to set \\Setup: dword \"WimBoot\"=1 value "
512 "in registry hive \"%ls\" (err=%"PRIu32")",
513 ctx->pathbuf.Buffer, (u32)res);
519 /* Returns the number of wide characters needed to represent the path to the
520 * specified @dentry, relative to the target directory, when extracted.
522 * Does not include null terminator (not needed for NtCreateFile). */
524 dentry_extraction_path_length(const struct wim_dentry *dentry)
527 const struct wim_dentry *d;
531 len += d->d_extraction_name_nchars + 1;
533 } while (!dentry_is_root(d) && will_extract_dentry(d));
535 return --len; /* No leading slash */
538 /* Returns the length of the longest string that might need to be appended to
539 * the path to an alias of an inode to open or create a named data stream.
541 * If the inode has no named data streams, this will be 0. Otherwise, this will
542 * be 1 plus the length of the longest-named data stream, since the data stream
543 * name must be separated from the path by the ':' character. */
545 inode_longest_named_data_stream_spec(const struct wim_inode *inode)
548 for (u16 i = 0; i < inode->i_num_ads; i++) {
549 size_t len = inode->i_ads_entries[i].stream_name_nbytes;
554 max = 1 + (max / sizeof(wchar_t));
558 /* Find the length, in wide characters, of the longest path needed for
559 * extraction of any file in @dentry_list relative to the target directory.
561 * Accounts for named data streams, but does not include null terminator (not
562 * needed for NtCreateFile). */
564 compute_path_max(struct list_head *dentry_list)
567 const struct wim_dentry *dentry;
569 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
572 len = dentry_extraction_path_length(dentry);
574 /* Account for named data streams */
575 len += inode_longest_named_data_stream_spec(dentry->d_inode);
584 /* Build the path at which to extract the @dentry, relative to the target
587 * The path is saved in ctx->pathbuf. */
589 build_extraction_path(const struct wim_dentry *dentry,
590 struct win32_apply_ctx *ctx)
594 const struct wim_dentry *d;
596 len = dentry_extraction_path_length(dentry);
598 ctx->pathbuf.Length = len * sizeof(wchar_t);
599 p = ctx->pathbuf.Buffer + len;
601 !dentry_is_root(d->d_parent) && will_extract_dentry(d->d_parent);
604 p -= d->d_extraction_name_nchars;
605 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
608 /* No leading slash */
609 p -= d->d_extraction_name_nchars;
610 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
613 /* Build the path at which to extract the @dentry, relative to the target
614 * directory, adding the suffix for a named data stream.
616 * The path is saved in ctx->pathbuf. */
618 build_extraction_path_with_ads(const struct wim_dentry *dentry,
619 struct win32_apply_ctx *ctx,
620 const wchar_t *stream_name,
621 size_t stream_name_nchars)
625 build_extraction_path(dentry, ctx);
627 /* Add :NAME for named data stream */
628 p = ctx->pathbuf.Buffer + (ctx->pathbuf.Length / sizeof(wchar_t));
630 wmemcpy(p, stream_name, stream_name_nchars);
631 ctx->pathbuf.Length += (1 + stream_name_nchars) * sizeof(wchar_t);
634 /* Build the Win32 namespace path to the specified @dentry when extracted.
636 * The path is saved in ctx->pathbuf and will be null terminated.
638 * XXX: We could get rid of this if it wasn't needed for the file encryption
639 * APIs, and the registry manipulation in WIMBoot mode. */
641 build_win32_extraction_path(const struct wim_dentry *dentry,
642 struct win32_apply_ctx *ctx)
644 build_extraction_path(dentry, ctx);
646 /* Prepend target_ntpath to our relative path, then change \??\ into \\?\ */
648 memmove(ctx->pathbuf.Buffer +
649 (ctx->target_ntpath.Length / sizeof(wchar_t)) + 1,
650 ctx->pathbuf.Buffer, ctx->pathbuf.Length);
651 memcpy(ctx->pathbuf.Buffer, ctx->target_ntpath.Buffer,
652 ctx->target_ntpath.Length);
653 ctx->pathbuf.Buffer[ctx->target_ntpath.Length / sizeof(wchar_t)] = L'\\';
654 ctx->pathbuf.Length += ctx->target_ntpath.Length + sizeof(wchar_t);
655 ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)] = L'\0';
657 wimlib_assert(ctx->pathbuf.Length >= 4 * sizeof(wchar_t) &&
658 !wmemcmp(ctx->pathbuf.Buffer, L"\\??\\", 4));
660 ctx->pathbuf.Buffer[1] = L'\\';
664 /* Returns a "printable" representation of the last relative NT path that was
665 * constructed with build_extraction_path() or build_extraction_path_with_ads().
667 * This will be overwritten by the next call to this function. */
668 static const wchar_t *
669 current_path(struct win32_apply_ctx *ctx)
671 wchar_t *p = ctx->print_buffer;
673 p = wmempcpy(p, ctx->common.target, ctx->common.target_nchars);
675 p = wmempcpy(p, ctx->pathbuf.Buffer, ctx->pathbuf.Length / sizeof(wchar_t));
677 return ctx->print_buffer;
681 * Ensures the target directory exists and opens a handle to it, in preparation
682 * of using paths relative to it.
685 prepare_target(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
691 /* Open handle to the target directory (possibly creating it). */
693 ret = win32_path_to_nt_path(ctx->common.target, &ctx->target_ntpath);
697 ctx->attr.Length = sizeof(ctx->attr);
698 ctx->attr.ObjectName = &ctx->target_ntpath;
700 status = (*func_NtCreateFile)(&ctx->h_target,
706 FILE_SHARE_VALID_FLAGS,
708 FILE_DIRECTORY_FILE |
709 FILE_OPEN_REPARSE_POINT |
710 FILE_OPEN_FOR_BACKUP_INTENT,
714 if (!NT_SUCCESS(status)) {
715 set_errno_from_nt_status(status);
716 ERROR_WITH_ERRNO("Can't open or create directory \"%ls\" "
717 "(status=0x%08"PRIx32")",
718 ctx->common.target, (u32)status);
719 return WIMLIB_ERR_OPENDIR;
722 path_max = compute_path_max(dentry_list);
724 /* Add some extra for building Win32 paths for the file encryption APIs
726 path_max += 2 + (ctx->target_ntpath.Length / sizeof(wchar_t));
728 ctx->pathbuf.MaximumLength = path_max * sizeof(wchar_t);
729 ctx->pathbuf.Buffer = MALLOC(ctx->pathbuf.MaximumLength);
730 if (!ctx->pathbuf.Buffer)
731 return WIMLIB_ERR_NOMEM;
733 ctx->attr.RootDirectory = ctx->h_target;
734 ctx->attr.ObjectName = &ctx->pathbuf;
736 ctx->print_buffer = MALLOC((ctx->common.target_nchars + 1 + path_max + 1) *
738 if (!ctx->print_buffer)
739 return WIMLIB_ERR_NOMEM;
744 /* When creating an inode that will have a short (DOS) name, we create it using
745 * the long name associated with the short name. This ensures that the short
746 * name gets associated with the correct long name. */
747 static struct wim_dentry *
748 first_extraction_alias(const struct wim_inode *inode)
750 struct list_head *next = inode->i_extraction_aliases.next;
751 struct wim_dentry *dentry;
754 dentry = list_entry(next, struct wim_dentry,
755 d_extraction_alias_node);
756 if (dentry_has_short_name(dentry))
759 } while (next != &inode->i_extraction_aliases);
764 * Set or clear FILE_ATTRIBUTE_COMPRESSED if the inherited value is different
765 * from the desired value.
767 * Note that you can NOT override the inherited value of
768 * FILE_ATTRIBUTE_COMPRESSED directly with NtCreateFile().
771 adjust_compression_attribute(HANDLE h, const struct wim_dentry *dentry,
772 struct win32_apply_ctx *ctx)
774 const bool compressed = (dentry->d_inode->i_attributes &
775 FILE_ATTRIBUTE_COMPRESSED);
777 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
780 if (!ctx->common.supported_features.compressed_files)
783 FILE_BASIC_INFORMATION info;
785 USHORT compression_state;
787 /* Get current attributes */
788 status = (*func_NtQueryInformationFile)(h, &ctx->iosb,
790 FileBasicInformation);
791 if (NT_SUCCESS(status) &&
792 compressed == !!(info.FileAttributes & FILE_ATTRIBUTE_COMPRESSED))
794 /* Nothing needs to be done. */
798 /* Set the new compression state */
801 compression_state = COMPRESSION_FORMAT_DEFAULT;
803 compression_state = COMPRESSION_FORMAT_NONE;
805 status = (*func_NtFsControlFile)(h,
810 FSCTL_SET_COMPRESSION,
815 if (NT_SUCCESS(status))
818 set_errno_from_nt_status(status);
819 ERROR_WITH_ERRNO("Can't %s compression attribute on \"%ls\" "
820 "(status=0x%08"PRIx32")",
821 (compressed ? "set" : "clear"),
822 current_path(ctx), status);
823 return WIMLIB_ERR_SET_ATTRIBUTES;
827 * Clear FILE_ATTRIBUTE_ENCRYPTED if the file or directory is not supposed to be
830 * You can provide FILE_ATTRIBUTE_ENCRYPTED to NtCreateFile() to set it on the
831 * created file. However, the file or directory will otherwise default to the
832 * encryption state of the parent directory. This function works around this
833 * limitation by using DecryptFile() to remove FILE_ATTRIBUTE_ENCRYPTED on files
834 * (and directories) that are not supposed to have it set.
836 * Regardless of whether it succeeds or fails, this function may close the
837 * handle to the file. If it does, it sets it to NULL.
840 maybe_clear_encryption_attribute(HANDLE *h_ptr, const struct wim_dentry *dentry,
841 struct win32_apply_ctx *ctx)
843 if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
846 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
849 if (!ctx->common.supported_features.encrypted_files)
852 FILE_BASIC_INFORMATION info;
856 /* Get current attributes */
857 status = (*func_NtQueryInformationFile)(*h_ptr, &ctx->iosb,
859 FileBasicInformation);
860 if (NT_SUCCESS(status) &&
861 !(info.FileAttributes & FILE_ATTRIBUTE_ENCRYPTED))
863 /* Nothing needs to be done. */
867 /* Set the new encryption state */
869 /* Due to Windows' crappy file encryption APIs, we need to close the
870 * handle to the file so we don't get ERROR_SHARING_VIOLATION. We also
871 * hack together a Win32 path, although we will use the \\?\ prefix so
872 * it will actually be a NT path in disguise... */
873 (*func_NtClose)(*h_ptr);
876 build_win32_extraction_path(dentry, ctx);
878 bret = DecryptFile(ctx->pathbuf.Buffer, 0);
880 /* Restore the NT namespace path */
881 build_extraction_path(dentry, ctx);
884 DWORD err = GetLastError();
885 set_errno_from_win32_error(err);
886 ERROR_WITH_ERRNO("Can't decrypt file \"%ls\" (err=%"PRIu32")",
887 current_path(ctx), (u32)err);
888 return WIMLIB_ERR_SET_ATTRIBUTES;
893 /* Try to enable short name support on the target volume. If successful, return
894 * true. If unsuccessful, issue a warning and return false. */
896 try_to_enable_short_names(const wchar_t *volume)
899 FILE_FS_PERSISTENT_VOLUME_INFORMATION info;
903 h = CreateFile(volume, GENERIC_WRITE,
904 FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
905 FILE_FLAG_BACKUP_SEMANTICS, NULL);
906 if (h == INVALID_HANDLE_VALUE)
909 info.VolumeFlags = 0;
910 info.FlagMask = PERSISTENT_VOLUME_STATE_SHORT_NAME_CREATION_DISABLED;
914 bret = DeviceIoControl(h, FSCTL_SET_PERSISTENT_VOLUME_STATE,
915 &info, sizeof(info), NULL, 0,
916 &bytesReturned, NULL);
925 WARNING("Failed to enable short name support on %ls "
926 "(err=%"PRIu32")", volume + 4, (u32)GetLastError());
930 /* Set the short name on the open file @h which has been created at the location
931 * indicated by @dentry.
933 * Note that this may add, change, or remove the short name.
935 * @h must be opened with DELETE access.
937 * Returns 0 or WIMLIB_ERR_SET_SHORT_NAME. The latter only happens in
938 * STRICT_SHORT_NAMES mode.
941 set_short_name(HANDLE h, const struct wim_dentry *dentry,
942 struct win32_apply_ctx *ctx)
945 if (!ctx->common.supported_features.short_names)
949 * Note: The size of the FILE_NAME_INFORMATION buffer must be such that
950 * FileName contains at least 2 wide characters (4 bytes). Otherwise,
951 * NtSetInformationFile() will return STATUS_INFO_LENGTH_MISMATCH. This
952 * is despite the fact that FileNameLength can validly be 0 or 2 bytes,
953 * with the former case being removing the existing short name if
954 * present, rather than setting one.
956 * The null terminator is seemingly optional, but to be safe we include
957 * space for it and zero all unused space.
960 size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
961 max(dentry->short_name_nbytes, sizeof(wchar_t)) +
963 u8 buf[bufsize] _aligned_attribute(8);
964 FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
967 memset(buf, 0, bufsize);
969 info->FileNameLength = dentry->short_name_nbytes;
970 memcpy(info->FileName, dentry->short_name, dentry->short_name_nbytes);
973 status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
974 FileShortNameInformation);
975 if (NT_SUCCESS(status))
978 if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
979 if (dentry->short_name_nbytes == 0)
981 if (!ctx->tried_to_enable_short_names) {
985 ctx->tried_to_enable_short_names = true;
987 ret = win32_get_drive_path(ctx->common.target,
991 if (try_to_enable_short_names(volume))
996 /* By default, failure to set short names is not an error (since short
997 * names aren't too important anymore...). */
998 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
999 ctx->num_short_name_failures++;
1003 if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
1004 ERROR("Can't set short name when short "
1005 "names are not enabled on the volume!");
1007 ERROR("Can't set short name on \"%ls\" (status=0x%08"PRIx32")",
1008 current_path(ctx), (u32)status);
1010 return WIMLIB_ERR_SET_SHORT_NAME;
1014 * A wrapper around NtCreateFile() to make it slightly more usable...
1015 * This uses the path currently constructed in ctx->pathbuf.
1017 * Also, we always specify FILE_OPEN_FOR_BACKUP_INTENT and
1018 * FILE_OPEN_REPARSE_POINT.
1021 do_create_file(PHANDLE FileHandle,
1022 ACCESS_MASK DesiredAccess,
1023 PLARGE_INTEGER AllocationSize,
1024 ULONG FileAttributes,
1025 ULONG CreateDisposition,
1026 ULONG CreateOptions,
1027 struct win32_apply_ctx *ctx)
1029 return (*func_NtCreateFile)(FileHandle,
1035 FILE_SHARE_VALID_FLAGS,
1038 FILE_OPEN_FOR_BACKUP_INTENT |
1039 FILE_OPEN_REPARSE_POINT,
1044 /* Like do_create_file(), but builds the extraction path of the @dentry first.
1047 create_file(PHANDLE FileHandle,
1048 ACCESS_MASK DesiredAccess,
1049 PLARGE_INTEGER AllocationSize,
1050 ULONG FileAttributes,
1051 ULONG CreateDisposition,
1052 ULONG CreateOptions,
1053 const struct wim_dentry *dentry,
1054 struct win32_apply_ctx *ctx)
1056 build_extraction_path(dentry, ctx);
1057 return do_create_file(FileHandle,
1066 /* Create empty named data streams.
1068 * Since these won't have 'struct wim_lookup_table_entry's, they won't show up
1069 * in the call to extract_stream_list(). Hence the need for the special case.
1072 create_any_empty_ads(const struct wim_dentry *dentry,
1073 struct win32_apply_ctx *ctx)
1075 const struct wim_inode *inode = dentry->d_inode;
1076 LARGE_INTEGER allocation_size;
1077 bool path_modified = false;
1080 if (!ctx->common.supported_features.named_data_streams)
1083 for (u16 i = 0; i < inode->i_num_ads; i++) {
1084 const struct wim_ads_entry *entry;
1088 entry = &inode->i_ads_entries[i];
1091 if (!entry->stream_name_nbytes)
1098 /* Probably setting the allocation size to 0 has no effect, but
1099 * we might as well try. */
1100 allocation_size.QuadPart = 0;
1102 build_extraction_path_with_ads(dentry, ctx,
1104 entry->stream_name_nbytes /
1106 path_modified = true;
1107 status = do_create_file(&h, FILE_WRITE_DATA, &allocation_size,
1108 0, FILE_SUPERSEDE, 0, ctx);
1109 if (!NT_SUCCESS(status)) {
1110 set_errno_from_nt_status(status);
1111 ERROR_WITH_ERRNO("Can't create \"%ls\" "
1112 "(status=0x%08"PRIx32")",
1113 current_path(ctx), (u32)status);
1114 ret = WIMLIB_ERR_OPEN;
1119 /* Restore the path to the dentry itself */
1121 build_extraction_path(dentry, ctx);
1126 * Creates the directory named by @dentry, or uses an existing directory at that
1127 * location. If necessary, sets the short name and/or fixes compression and
1128 * encryption attributes.
1130 * Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
1133 create_directory(const struct wim_dentry *dentry,
1134 struct win32_apply_ctx *ctx)
1141 /* Special attributes:
1143 * Use FILE_ATTRIBUTE_ENCRYPTED if the directory needs to have it set.
1144 * This doesn't work for FILE_ATTRIBUTE_COMPRESSED (unfortunately).
1146 * Don't specify FILE_ATTRIBUTE_DIRECTORY; it gets set anyway as a
1147 * result of the FILE_DIRECTORY_FILE option. */
1148 attrib = (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED);
1150 /* DELETE is needed for set_short_name().
1151 * GENERIC_READ and GENERIC_WRITE are needed for
1152 * adjust_compression_attribute(). */
1153 status = create_file(&h, GENERIC_READ | GENERIC_WRITE | DELETE, NULL,
1154 attrib, FILE_OPEN_IF, FILE_DIRECTORY_FILE,
1156 if (!NT_SUCCESS(status)) {
1157 set_errno_from_nt_status(status);
1158 ERROR_WITH_ERRNO("Can't create directory \"%ls\" "
1159 "(status=0x%08"PRIx32")",
1160 current_path(ctx), (u32)status);
1161 return WIMLIB_ERR_MKDIR;
1164 ret = set_short_name(h, dentry, ctx);
1167 ret = adjust_compression_attribute(h, dentry, ctx);
1170 ret = maybe_clear_encryption_attribute(&h, dentry, ctx);
1171 /* May close the handle!!! */
1179 * Create all the directories being extracted, other than the target directory
1182 * Note: we don't honor directory hard links. However, we don't allow them to
1183 * exist in WIM images anyway (see inode_fixup.c).
1186 create_directories(struct list_head *dentry_list,
1187 struct win32_apply_ctx *ctx)
1189 const struct wim_dentry *dentry;
1192 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1194 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
1197 /* Note: Here we include files with
1198 * FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
1199 * wait until later to actually set the reparse data. */
1201 /* If the root dentry is being extracted, it was already done so
1202 * in prepare_target(). */
1203 if (!dentry_is_root(dentry)) {
1204 ret = create_directory(dentry, ctx);
1208 ret = create_any_empty_ads(dentry, ctx);
1213 ret = report_file_created(&ctx->common);
1221 * Creates the nondirectory file named by @dentry.
1223 * On success, returns an open handle to the file in @h_ret, with GENERIC_READ,
1224 * GENERIC_WRITE, and DELETE access. Also, the path to the file will be saved
1225 * in ctx->pathbuf. On failure, returns WIMLIB_ERR_OPEN.
1228 create_nondirectory_inode(HANDLE *h_ret, const struct wim_dentry *dentry,
1229 struct win32_apply_ctx *ctx)
1231 const struct wim_inode *inode;
1234 bool retried = false;
1236 inode = dentry->d_inode;
1238 /* If the file already exists and has FILE_ATTRIBUTE_SYSTEM and/or
1239 * FILE_ATTRIBUTE_HIDDEN, these must be specified in order to supersede
1242 * Normally the user shouldn't be trying to overwrite such files anyway,
1243 * but we at least provide FILE_ATTRIBUTE_SYSTEM and
1244 * FILE_ATTRIBUTE_HIDDEN if the WIM inode has those attributes so that
1245 * we catch the case where the user extracts the same files to the same
1246 * location more than one time.
1248 * Also specify FILE_ATTRIBUTE_ENCRYPTED if the file needs to be
1251 * In NO_ATTRIBUTES mode just don't specify any attributes at all.
1253 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) {
1256 attrib = (inode->i_attributes & (FILE_ATTRIBUTE_SYSTEM |
1257 FILE_ATTRIBUTE_HIDDEN |
1258 FILE_ATTRIBUTE_ENCRYPTED));
1260 build_extraction_path(dentry, ctx);
1262 status = do_create_file(h_ret, GENERIC_READ | GENERIC_WRITE | DELETE,
1263 NULL, attrib, FILE_SUPERSEDE,
1264 FILE_NON_DIRECTORY_FILE, ctx);
1265 if (NT_SUCCESS(status)) {
1268 ret = adjust_compression_attribute(*h_ret, dentry, ctx);
1270 (*func_NtClose)(*h_ret);
1274 ret = maybe_clear_encryption_attribute(h_ret, dentry, ctx);
1275 /* May close the handle!!! */
1279 (*func_NtClose)(*h_ret);
1284 /* Re-open the handle so that we can return it on
1286 status = do_create_file(h_ret,
1288 GENERIC_WRITE | DELETE,
1290 FILE_NON_DIRECTORY_FILE, ctx);
1291 if (!NT_SUCCESS(status))
1295 ret = create_any_empty_ads(dentry, ctx);
1297 (*func_NtClose)(*h_ret);
1303 if (status == STATUS_ACCESS_DENIED && !retried) {
1304 /* We also can't supersede an existing file that has
1305 * FILE_ATTRIBUTE_READONLY set; doing so causes NtCreateFile()
1306 * to return STATUS_ACCESS_DENIED . The only workaround seems
1307 * to be to explicitly remove FILE_ATTRIBUTE_READONLY on the
1308 * existing file, then try again. */
1310 FILE_BASIC_INFORMATION info;
1313 status = do_create_file(&h, FILE_WRITE_ATTRIBUTES, NULL, 0,
1314 FILE_OPEN, FILE_NON_DIRECTORY_FILE, ctx);
1315 if (!NT_SUCCESS(status))
1318 memset(&info, 0, sizeof(info));
1319 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
1321 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1322 &info, sizeof(info),
1323 FileBasicInformation);
1325 if (!NT_SUCCESS(status))
1331 set_errno_from_nt_status(status);
1332 ERROR_WITH_ERRNO("Can't create file \"%ls\" (status=0x%08"PRIx32")",
1333 current_path(ctx), (u32)status);
1334 return WIMLIB_ERR_OPEN;
1337 /* Creates a hard link at the location named by @dentry to the file represented
1338 * by the open handle @h. Or, if the target volume does not support hard links,
1339 * create a separate file instead. */
1341 create_link(HANDLE h, const struct wim_dentry *dentry,
1342 struct win32_apply_ctx *ctx)
1344 if (ctx->common.supported_features.hard_links) {
1346 build_extraction_path(dentry, ctx);
1348 size_t bufsize = offsetof(FILE_LINK_INFORMATION, FileName) +
1349 ctx->pathbuf.Length + sizeof(wchar_t);
1350 u8 buf[bufsize] _aligned_attribute(8);
1351 FILE_LINK_INFORMATION *info = (FILE_LINK_INFORMATION *)buf;
1354 info->ReplaceIfExists = TRUE;
1355 info->RootDirectory = ctx->attr.RootDirectory;
1356 info->FileNameLength = ctx->pathbuf.Length;
1357 memcpy(info->FileName, ctx->pathbuf.Buffer, ctx->pathbuf.Length);
1358 info->FileName[info->FileNameLength / 2] = L'\0';
1360 /* Note: the null terminator isn't actually necessary,
1361 * but if you don't add the extra character, you get
1362 * STATUS_INFO_LENGTH_MISMATCH when FileNameLength
1363 * happens to be 2 */
1365 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1367 FileLinkInformation);
1368 if (NT_SUCCESS(status))
1370 ERROR("Failed to create link \"%ls\" (status=0x%08"PRIx32")",
1371 current_path(ctx), (u32)status);
1372 return WIMLIB_ERR_LINK;
1377 ret = create_nondirectory_inode(&h2, dentry, ctx);
1381 (*func_NtClose)(h2);
1386 /* Given an inode (represented by the open handle @h) for which one link has
1387 * been created (named by @first_dentry), create the other links.
1389 * Or, if the target volume does not support hard links, create separate files.
1391 * Note: This uses ctx->pathbuf and does not reset it.
1394 create_links(HANDLE h, const struct wim_dentry *first_dentry,
1395 struct win32_apply_ctx *ctx)
1397 const struct wim_inode *inode;
1398 const struct list_head *next;
1399 const struct wim_dentry *dentry;
1402 inode = first_dentry->d_inode;
1403 next = inode->i_extraction_aliases.next;
1405 dentry = list_entry(next, struct wim_dentry,
1406 d_extraction_alias_node);
1407 if (dentry != first_dentry) {
1408 ret = create_link(h, dentry, ctx);
1413 } while (next != &inode->i_extraction_aliases);
1417 /* Create a nondirectory file, including all links. */
1419 create_nondirectory(const struct wim_inode *inode, struct win32_apply_ctx *ctx)
1421 struct wim_dentry *first_dentry;
1425 first_dentry = first_extraction_alias(inode);
1427 /* Create first link. */
1428 ret = create_nondirectory_inode(&h, first_dentry, ctx);
1432 /* Set short name. */
1433 ret = set_short_name(h, first_dentry, ctx);
1435 /* Create additional links, OR if hard links are not supported just
1436 * create more files. */
1438 ret = create_links(h, first_dentry, ctx);
1440 /* "WIMBoot" extraction: set external backing by the WIM file if needed. */
1441 if (!ret && unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
1442 ret = set_external_backing(h, first_dentry, ctx);
1448 /* Create all the nondirectory files being extracted, including all aliases
1451 create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1453 const struct wim_dentry *dentry;
1454 const struct wim_inode *inode;
1457 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1458 inode = dentry->d_inode;
1459 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1461 /* Call create_nondirectory() only once per inode */
1462 if (dentry == inode_first_extraction_dentry(inode)) {
1463 ret = create_nondirectory(inode, ctx);
1467 ret = report_file_created(&ctx->common);
1475 close_handles(struct win32_apply_ctx *ctx)
1477 for (unsigned i = 0; i < ctx->num_open_handles; i++)
1478 (*func_NtClose)(ctx->open_handles[i]);
1481 /* Prepare to read the next stream, which has size @stream_size, into an
1482 * in-memory buffer. */
1484 prepare_data_buffer(struct win32_apply_ctx *ctx, u64 stream_size)
1486 if (stream_size > ctx->data_buffer_size) {
1487 /* Larger buffer needed. */
1489 if ((size_t)stream_size != stream_size)
1490 return WIMLIB_ERR_NOMEM;
1491 new_buffer = REALLOC(ctx->data_buffer, stream_size);
1493 return WIMLIB_ERR_NOMEM;
1494 ctx->data_buffer = new_buffer;
1495 ctx->data_buffer_size = stream_size;
1497 /* On the first call this changes data_buffer_ptr from NULL, which tells
1498 * extract_chunk() that the data buffer needs to be filled while reading
1499 * the stream data. */
1500 ctx->data_buffer_ptr = ctx->data_buffer;
1505 begin_extract_stream_instance(const struct wim_lookup_table_entry *stream,
1506 struct wim_dentry *dentry,
1507 const wchar_t *stream_name,
1508 struct win32_apply_ctx *ctx)
1510 const struct wim_inode *inode = dentry->d_inode;
1511 size_t stream_name_nchars = 0;
1512 FILE_ALLOCATION_INFORMATION alloc_info;
1516 if (unlikely(stream_name))
1517 stream_name_nchars = wcslen(stream_name);
1519 if (unlikely(stream_name_nchars)) {
1520 build_extraction_path_with_ads(dentry, ctx,
1521 stream_name, stream_name_nchars);
1523 build_extraction_path(dentry, ctx);
1526 /* Reparse point? */
1527 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
1528 && (stream_name_nchars == 0))
1530 if (!ctx->common.supported_features.reparse_points)
1533 /* We can't write the reparse stream directly; we must set it
1534 * with FSCTL_SET_REPARSE_POINT, which requires that all the
1535 * data be available. So, stage the data in a buffer. */
1537 list_add_tail(&dentry->tmp_list, &ctx->reparse_dentries);
1538 return prepare_data_buffer(ctx, stream->size);
1541 /* Encrypted file? */
1542 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
1543 && (stream_name_nchars == 0))
1545 if (!ctx->common.supported_features.encrypted_files)
1548 /* We can't write encrypted file streams directly; we must use
1549 * WriteEncryptedFileRaw(), which requires providing the data
1550 * through a callback function. This can't easily be combined
1551 * with our own callback-based approach.
1553 * The current workaround is to simply read the stream into
1554 * memory and write the encrypted file from that.
1556 * TODO: This isn't sufficient for extremely large encrypted
1557 * files. Perhaps we should create an extra thread to write
1559 list_add_tail(&dentry->tmp_list, &ctx->encrypted_dentries);
1560 return prepare_data_buffer(ctx, stream->size);
1563 if (ctx->num_open_handles == MAX_OPEN_STREAMS) {
1564 /* XXX: Fix this. But because of the checks in
1565 * extract_stream_list(), this can now only happen on a
1566 * filesystem that does not support hard links. */
1567 ERROR("Can't extract data: too many open files!");
1568 return WIMLIB_ERR_UNSUPPORTED;
1571 /* Open a new handle */
1572 status = do_create_file(&h,
1573 FILE_WRITE_DATA | SYNCHRONIZE,
1574 NULL, 0, FILE_OPEN_IF,
1575 FILE_SEQUENTIAL_ONLY |
1576 FILE_SYNCHRONOUS_IO_NONALERT,
1578 if (!NT_SUCCESS(status)) {
1579 set_errno_from_nt_status(status);
1580 ERROR_WITH_ERRNO("Can't open \"%ls\" for writing "
1581 "(status=0x%08"PRIx32")",
1582 current_path(ctx), (u32)status);
1583 return WIMLIB_ERR_OPEN;
1586 ctx->open_handles[ctx->num_open_handles++] = h;
1588 /* Allocate space for the data. */
1589 alloc_info.AllocationSize.QuadPart = stream->size;
1590 (*func_NtSetInformationFile)(h, &ctx->iosb,
1591 &alloc_info, sizeof(alloc_info),
1592 FileAllocationInformation);
1596 /* Set the reparse data @rpbuf of length @rpbuflen on the extracted file
1597 * corresponding to the WIM dentry @dentry. */
1599 do_set_reparse_data(const struct wim_dentry *dentry,
1600 const void *rpbuf, u16 rpbuflen,
1601 struct win32_apply_ctx *ctx)
1606 status = create_file(&h, GENERIC_WRITE, NULL,
1607 0, FILE_OPEN, 0, dentry, ctx);
1608 if (!NT_SUCCESS(status))
1611 status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
1612 &ctx->iosb, FSCTL_SET_REPARSE_POINT,
1613 (void *)rpbuf, rpbuflen,
1617 if (NT_SUCCESS(status))
1620 /* On Windows, by default only the Administrator can create symbolic
1621 * links for some reason. By default we just issue a warning if this
1622 * appears to be the problem. Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
1623 * to get a hard error. */
1624 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
1625 && (status == STATUS_PRIVILEGE_NOT_HELD ||
1626 status == STATUS_ACCESS_DENIED)
1627 && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1628 dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1630 WARNING("Can't create symbolic link \"%ls\"! \n"
1631 " (Need Administrator rights, or at least "
1633 " SeCreateSymbolicLink privilege.)",
1639 set_errno_from_nt_status(status);
1640 ERROR_WITH_ERRNO("Can't set reparse data on \"%ls\" "
1641 "(status=0x%08"PRIx32")",
1642 current_path(ctx), (u32)status);
1643 return WIMLIB_ERR_SET_REPARSE_DATA;
1646 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1647 * pointer to the suffix of the path that begins with the device directly, such
1648 * as e:\Windows\System32. */
1649 static const wchar_t *
1650 skip_nt_toplevel_component(const wchar_t *path, size_t path_nchars)
1652 static const wchar_t * const dirs[] = {
1657 size_t first_dir_len = 0;
1658 const wchar_t * const end = path + path_nchars;
1660 for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
1661 size_t len = wcslen(dirs[i]);
1662 if (len <= (end - path) && !wcsnicmp(path, dirs[i], len)) {
1663 first_dir_len = len;
1667 if (first_dir_len == 0)
1669 path += first_dir_len;
1670 while (path != end && *path == L'\\')
1675 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1676 * pointer to the suffix of the path that is device-relative, such as
1679 * The path has an explicit length and is not necessarily null terminated.
1681 * If the path just something like \??\e: then the returned pointer will point
1682 * just past the colon. In this case the length of the result will be 0
1684 static const wchar_t *
1685 get_device_relative_path(const wchar_t *path, size_t path_nchars)
1687 const wchar_t * const orig_path = path;
1688 const wchar_t * const end = path + path_nchars;
1690 path = skip_nt_toplevel_component(path, path_nchars);
1691 if (path == orig_path)
1694 path = wmemchr(path, L'\\', (end - path));
1699 } while (path != end && *path == L'\\');
1704 * Given a reparse point buffer for a symbolic link or junction, adjust its
1705 * contents so that the target of the link is consistent with the new location
1709 try_rpfix(u8 *rpbuf, u16 *rpbuflen_p, struct win32_apply_ctx *ctx)
1711 struct reparse_data rpdata;
1712 size_t orig_subst_name_nchars;
1713 const wchar_t *relpath;
1714 size_t relpath_nchars;
1715 size_t target_ntpath_nchars;
1716 size_t fixed_subst_name_nchars;
1717 const wchar_t *fixed_print_name;
1718 size_t fixed_print_name_nchars;
1720 if (parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata)) {
1721 /* Do nothing if the reparse data is invalid. */
1725 if (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK &&
1726 (rpdata.rpflags & SYMBOLIC_LINK_RELATIVE))
1728 /* Do nothing if it's a relative symbolic link. */
1732 /* Build the new substitute name from the NT namespace path to the
1733 * target directory, then a path separator, then the "device relative"
1734 * part of the old substitute name. */
1736 orig_subst_name_nchars = rpdata.substitute_name_nbytes / sizeof(wchar_t);
1738 relpath = get_device_relative_path(rpdata.substitute_name,
1739 orig_subst_name_nchars);
1740 relpath_nchars = orig_subst_name_nchars -
1741 (relpath - rpdata.substitute_name);
1743 target_ntpath_nchars = ctx->target_ntpath.Length / sizeof(wchar_t);
1745 fixed_subst_name_nchars = target_ntpath_nchars;
1747 fixed_subst_name_nchars += 1 + relpath_nchars;
1748 wchar_t fixed_subst_name[fixed_subst_name_nchars];
1750 wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer,
1751 target_ntpath_nchars);
1752 if (relpath_nchars) {
1753 fixed_subst_name[target_ntpath_nchars] = L'\\';
1754 wmemcpy(&fixed_subst_name[target_ntpath_nchars + 1],
1755 relpath, relpath_nchars);
1757 /* Doesn't need to be null-terminated. */
1759 /* Print name should be Win32, but not all NT names can even be
1760 * translated to Win32 names. But we can at least delete the top-level
1761 * directory, such as \??\, and this will have the expected result in
1762 * the usual case. */
1763 fixed_print_name = skip_nt_toplevel_component(fixed_subst_name,
1764 fixed_subst_name_nchars);
1765 fixed_print_name_nchars = fixed_subst_name_nchars - (fixed_print_name -
1768 rpdata.substitute_name = fixed_subst_name;
1769 rpdata.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
1770 rpdata.print_name = (wchar_t *)fixed_print_name;
1771 rpdata.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
1772 make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p);
1775 /* Sets reparse data on the specified file. This handles "fixing" the targets
1776 * of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX was
1779 set_reparse_data(const struct wim_dentry *dentry,
1780 const void *_rpbuf, u16 rpbuflen, struct win32_apply_ctx *ctx)
1782 const struct wim_inode *inode = dentry->d_inode;
1783 const void *rpbuf = _rpbuf;
1785 if ((ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
1786 && !inode->i_not_rpfixed
1787 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1788 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1790 memcpy(&ctx->rpfixbuf, _rpbuf, rpbuflen);
1791 try_rpfix((u8 *)&ctx->rpfixbuf, &rpbuflen, ctx);
1792 rpbuf = &ctx->rpfixbuf;
1794 return do_set_reparse_data(dentry, rpbuf, rpbuflen, ctx);
1798 /* Import the next block of raw encrypted data */
1800 import_encrypted_data(PBYTE pbData, PVOID pvCallbackContext, PULONG Length)
1802 struct win32_apply_ctx *ctx = pvCallbackContext;
1805 copy_len = min(ctx->encrypted_size - ctx->encrypted_offset, *Length);
1806 memcpy(pbData, &ctx->data_buffer[ctx->encrypted_offset], copy_len);
1807 ctx->encrypted_offset += copy_len;
1809 return ERROR_SUCCESS;
1812 /* Write the raw encrypted data to the already-created file corresponding to
1815 * The raw encrypted data is provided in ctx->data_buffer, and its size is
1816 * ctx->encrypted_size. */
1818 extract_encrypted_file(const struct wim_dentry *dentry,
1819 struct win32_apply_ctx *ctx)
1824 /* Temporarily build a Win32 path for OpenEncryptedFileRaw() */
1825 build_win32_extraction_path(dentry, ctx);
1827 err = OpenEncryptedFileRaw(ctx->pathbuf.Buffer,
1828 CREATE_FOR_IMPORT, &rawctx);
1830 /* Restore the NT namespace path */
1831 build_extraction_path(dentry, ctx);
1833 if (err != ERROR_SUCCESS) {
1834 set_errno_from_win32_error(err);
1835 ERROR_WITH_ERRNO("Can't open \"%ls\" for encrypted import "
1836 "(err=%"PRIu32")", current_path(ctx), (u32)err);
1837 return WIMLIB_ERR_OPEN;
1840 ctx->encrypted_offset = 0;
1842 err = WriteEncryptedFileRaw(import_encrypted_data, ctx, rawctx);
1844 CloseEncryptedFileRaw(rawctx);
1846 if (err != ERROR_SUCCESS) {
1847 set_errno_from_win32_error(err);
1848 ERROR_WITH_ERRNO("Can't import encrypted file \"%ls\" "
1849 "(err=%"PRIu32")", current_path(ctx), (u32)err);
1850 return WIMLIB_ERR_WRITE;
1856 /* Called when starting to read a stream for extraction on Windows */
1858 begin_extract_stream(struct wim_lookup_table_entry *stream, void *_ctx)
1860 struct win32_apply_ctx *ctx = _ctx;
1861 const struct stream_owner *owners = stream_owners(stream);
1864 ctx->num_open_handles = 0;
1865 ctx->data_buffer_ptr = NULL;
1866 INIT_LIST_HEAD(&ctx->reparse_dentries);
1867 INIT_LIST_HEAD(&ctx->encrypted_dentries);
1869 for (u32 i = 0; i < stream->out_refcnt; i++) {
1870 const struct wim_inode *inode = owners[i].inode;
1871 const wchar_t *stream_name = owners[i].stream_name;
1872 struct wim_dentry *dentry;
1874 /* A copy of the stream needs to be extracted to @inode. */
1876 if (ctx->common.supported_features.hard_links) {
1877 dentry = inode_first_extraction_dentry(inode);
1878 ret = begin_extract_stream_instance(stream, dentry,
1883 /* Hard links not supported. Extract the stream
1884 * separately to each alias of the inode. */
1885 struct list_head *next;
1887 next = inode->i_extraction_aliases.next;
1889 dentry = list_entry(next, struct wim_dentry,
1890 d_extraction_alias_node);
1891 ret = begin_extract_stream_instance(stream,
1898 } while (next != &inode->i_extraction_aliases);
1909 /* Called when the next chunk of a stream has been read for extraction on
1912 extract_chunk(const void *chunk, size_t size, void *_ctx)
1914 struct win32_apply_ctx *ctx = _ctx;
1916 /* Write the data chunk to each open handle */
1917 for (unsigned i = 0; i < ctx->num_open_handles; i++) {
1918 u8 *bufptr = (u8 *)chunk;
1919 size_t bytes_remaining = size;
1921 while (bytes_remaining) {
1922 ULONG count = min(0xFFFFFFFF, bytes_remaining);
1924 status = (*func_NtWriteFile)(ctx->open_handles[i],
1926 &ctx->iosb, bufptr, count,
1928 if (!NT_SUCCESS(status)) {
1929 set_errno_from_nt_status(status);
1930 ERROR_WITH_ERRNO("Error writing data to target "
1931 "volume (status=0x%08"PRIx32")",
1933 return WIMLIB_ERR_WRITE;
1935 bufptr += ctx->iosb.Information;
1936 bytes_remaining -= ctx->iosb.Information;
1940 /* Copy the data chunk into the buffer (if needed) */
1941 if (ctx->data_buffer_ptr)
1942 ctx->data_buffer_ptr = mempcpy(ctx->data_buffer_ptr,
1947 /* Called when a stream has been fully read for extraction on Windows */
1949 end_extract_stream(struct wim_lookup_table_entry *stream, int status, void *_ctx)
1951 struct win32_apply_ctx *ctx = _ctx;
1953 const struct wim_dentry *dentry;
1960 if (likely(!ctx->data_buffer_ptr))
1963 if (!list_empty(&ctx->reparse_dentries)) {
1964 if (stream->size > REPARSE_DATA_MAX_SIZE) {
1965 dentry = list_first_entry(&ctx->reparse_dentries,
1966 struct wim_dentry, tmp_list);
1967 build_extraction_path(dentry, ctx);
1968 ERROR("Reparse data of \"%ls\" has size "
1969 "%"PRIu64" bytes (exceeds %u bytes)",
1970 current_path(ctx), stream->size,
1971 REPARSE_DATA_MAX_SIZE);
1972 return WIMLIB_ERR_INVALID_REPARSE_DATA;
1974 /* In the WIM format, reparse streams are just the reparse data
1975 * and omit the header. But we can reconstruct the header. */
1976 memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, stream->size);
1977 ctx->rpbuf.rpdatalen = stream->size;
1978 ctx->rpbuf.rpreserved = 0;
1979 list_for_each_entry(dentry, &ctx->reparse_dentries, tmp_list) {
1980 ctx->rpbuf.rptag = dentry->d_inode->i_reparse_tag;
1981 ret = set_reparse_data(dentry, &ctx->rpbuf,
1982 stream->size + REPARSE_DATA_OFFSET,
1989 if (!list_empty(&ctx->encrypted_dentries)) {
1990 ctx->encrypted_size = stream->size;
1991 list_for_each_entry(dentry, &ctx->encrypted_dentries, tmp_list) {
1992 ret = extract_encrypted_file(dentry, ctx);
2001 /* Attributes that can't be set directly */
2002 #define SPECIAL_ATTRIBUTES \
2003 (FILE_ATTRIBUTE_REPARSE_POINT | \
2004 FILE_ATTRIBUTE_DIRECTORY | \
2005 FILE_ATTRIBUTE_ENCRYPTED | \
2006 FILE_ATTRIBUTE_SPARSE_FILE | \
2007 FILE_ATTRIBUTE_COMPRESSED)
2009 /* Set the security descriptor @desc, of @desc_size bytes, on the file with open
2012 set_security_descriptor(HANDLE h, const void *desc,
2013 size_t desc_size, struct win32_apply_ctx *ctx)
2015 SECURITY_INFORMATION info;
2018 /* We really just want to set entire the security descriptor as-is, but
2019 * all available APIs require specifying the specific parts of the
2020 * descriptor being set. Start out by requesting all parts be set. If
2021 * permissions problems are encountered, fall back to omitting some
2022 * parts (first the SACL, then the DACL, then the owner), unless the
2023 * WIMLIB_EXTRACT_FLAG_STRICT_ACLS flag has been enabled. */
2024 info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
2025 DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION;
2027 /* Prefer NtSetSecurityObject() to SetFileSecurity(). SetFileSecurity()
2028 * itself necessarily uses NtSetSecurityObject() as the latter is the
2029 * underlying system call for setting security information, but
2030 * SetFileSecurity() opens the handle with NtCreateFile() without
2031 * FILE_OPEN_FILE_BACKUP_INTENT. Hence, access checks are done and due
2032 * to the Windows security model, even a process running as the
2033 * Administrator can have access denied. (Of course, this not mentioned
2034 * in the MS "documentation".) */
2036 status = (*func_NtSetSecurityObject)(h, info, (PSECURITY_DESCRIPTOR)desc);
2037 if (NT_SUCCESS(status))
2039 /* Failed to set the requested parts of the security descriptor. If the
2040 * error was permissions-related, try to set fewer parts of the security
2041 * descriptor, unless WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled. */
2042 if ((status == STATUS_PRIVILEGE_NOT_HELD ||
2043 status == STATUS_ACCESS_DENIED) &&
2044 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2046 if (info & SACL_SECURITY_INFORMATION) {
2047 info &= ~SACL_SECURITY_INFORMATION;
2048 ctx->partial_security_descriptors++;
2051 if (info & DACL_SECURITY_INFORMATION) {
2052 info &= ~DACL_SECURITY_INFORMATION;
2055 if (info & OWNER_SECURITY_INFORMATION) {
2056 info &= ~OWNER_SECURITY_INFORMATION;
2059 /* Nothing left except GROUP, and if we removed it we
2060 * wouldn't have anything at all. */
2063 /* No part of the security descriptor could be set, or
2064 * WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled and the full security
2065 * descriptor could not be set. */
2066 if (!(info & SACL_SECURITY_INFORMATION))
2067 ctx->partial_security_descriptors--;
2068 ctx->no_security_descriptors++;
2072 /* Set metadata on the open file @h from the WIM inode @inode. */
2074 do_apply_metadata_to_file(HANDLE h, const struct wim_inode *inode,
2075 struct win32_apply_ctx *ctx)
2077 FILE_BASIC_INFORMATION info;
2080 /* Set security descriptor if present and not in NO_ACLS mode */
2081 if (inode->i_security_id >= 0 &&
2082 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
2084 const struct wim_security_data *sd;
2088 sd = wim_get_current_security_data(ctx->common.wim);
2089 desc = sd->descriptors[inode->i_security_id];
2090 desc_size = sd->sizes[inode->i_security_id];
2092 status = set_security_descriptor(h, desc, desc_size, ctx);
2093 if (!NT_SUCCESS(status) &&
2094 (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2096 set_errno_from_nt_status(status);
2097 ERROR_WITH_ERRNO("Can't set security descriptor "
2098 "on \"%ls\" (status=0x%08"PRIx32")",
2099 current_path(ctx), (u32)status);
2100 return WIMLIB_ERR_SET_SECURITY;
2104 /* Set attributes and timestamps */
2105 info.CreationTime.QuadPart = inode->i_creation_time;
2106 info.LastAccessTime.QuadPart = inode->i_last_access_time;
2107 info.LastWriteTime.QuadPart = inode->i_last_write_time;
2108 info.ChangeTime.QuadPart = 0;
2109 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
2110 info.FileAttributes = 0;
2112 info.FileAttributes = inode->i_attributes & ~SPECIAL_ATTRIBUTES;
2114 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
2115 &info, sizeof(info),
2116 FileBasicInformation);
2117 /* On FAT volumes we get STATUS_INVALID_PARAMETER if we try to set
2118 * attributes on the root directory. (Apparently because FAT doesn't
2119 * actually have a place to store those attributes!) */
2120 if (!NT_SUCCESS(status)
2121 && !(status == STATUS_INVALID_PARAMETER &&
2122 dentry_is_root(inode_first_extraction_dentry(inode))))
2124 set_errno_from_nt_status(status);
2125 ERROR_WITH_ERRNO("Can't set basic metadata on \"%ls\" "
2126 "(status=0x%08"PRIx32")",
2127 current_path(ctx), (u32)status);
2128 return WIMLIB_ERR_SET_ATTRIBUTES;
2135 apply_metadata_to_file(const struct wim_dentry *dentry,
2136 struct win32_apply_ctx *ctx)
2138 const struct wim_inode *inode = dentry->d_inode;
2144 perms = FILE_WRITE_ATTRIBUTES | WRITE_DAC |
2145 WRITE_OWNER | ACCESS_SYSTEM_SECURITY;
2147 build_extraction_path(dentry, ctx);
2149 /* Open a handle with as many relevant permissions as possible. */
2150 while (!NT_SUCCESS(status = do_create_file(&h, perms, NULL,
2151 0, FILE_OPEN, 0, ctx)))
2153 if (status == STATUS_PRIVILEGE_NOT_HELD ||
2154 status == STATUS_ACCESS_DENIED)
2156 if (perms & ACCESS_SYSTEM_SECURITY) {
2157 perms &= ~ACCESS_SYSTEM_SECURITY;
2160 if (perms & WRITE_DAC) {
2161 perms &= ~WRITE_DAC;
2164 if (perms & WRITE_OWNER) {
2165 perms &= ~WRITE_OWNER;
2169 set_errno_from_nt_status(status);
2170 ERROR_WITH_ERRNO("Can't open \"%ls\" to set metadata "
2171 "(status=0x%08"PRIx32")",
2172 current_path(ctx), (u32)status);
2173 return WIMLIB_ERR_OPEN;
2176 ret = do_apply_metadata_to_file(h, inode, ctx);
2184 apply_metadata(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
2186 const struct wim_dentry *dentry;
2189 /* We go in reverse so that metadata is set on all a directory's
2190 * children before the directory itself. This avoids any potential
2191 * problems with attributes, timestamps, or security descriptors. */
2192 list_for_each_entry_reverse(dentry, dentry_list, d_extraction_list_node)
2194 ret = apply_metadata_to_file(dentry, ctx);
2197 ret = report_file_metadata_applied(&ctx->common);
2204 /* Issue warnings about problems during the extraction for which warnings were
2205 * not already issued (due to the high number of potential warnings if we issued
2206 * them per-file). */
2208 do_warnings(const struct win32_apply_ctx *ctx)
2210 if (ctx->partial_security_descriptors == 0 &&
2211 ctx->no_security_descriptors == 0 &&
2212 ctx->num_short_name_failures == 0)
2215 WARNING("Extraction to \"%ls\" complete, but with one or more warnings:",
2216 ctx->common.target);
2217 if (ctx->num_short_name_failures) {
2218 WARNING("- Could not set short names on %lu files or directories",
2219 ctx->num_short_name_failures);
2221 if (ctx->partial_security_descriptors) {
2222 WARNING("- Could only partially set the security descriptor\n"
2223 " on %lu files or directories.",
2224 ctx->partial_security_descriptors);
2226 if (ctx->no_security_descriptors) {
2227 WARNING("- Could not set security descriptor at all\n"
2228 " on %lu files or directories.",
2229 ctx->no_security_descriptors);
2231 if (ctx->partial_security_descriptors || ctx->no_security_descriptors) {
2232 WARNING("To fully restore all security descriptors, run the program\n"
2233 " with Administrator rights.");
2238 count_dentries(const struct list_head *dentry_list)
2240 const struct list_head *cur;
2243 list_for_each(cur, dentry_list)
2249 /* Extract files from a WIM image to a directory on Windows */
2251 win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
2254 struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
2255 uint64_t dentry_count;
2257 ret = prepare_target(dentry_list, ctx);
2261 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2262 ret = start_wimboot_extraction(ctx);
2267 dentry_count = count_dentries(dentry_list);
2269 ret = start_file_structure_phase(&ctx->common, dentry_count);
2273 ret = create_directories(dentry_list, ctx);
2277 ret = create_nondirectories(dentry_list, ctx);
2281 ret = end_file_structure_phase(&ctx->common);
2285 struct read_stream_list_callbacks cbs = {
2286 .begin_stream = begin_extract_stream,
2287 .begin_stream_ctx = ctx,
2288 .consume_chunk = extract_chunk,
2289 .consume_chunk_ctx = ctx,
2290 .end_stream = end_extract_stream,
2291 .end_stream_ctx = ctx,
2293 ret = extract_stream_list(&ctx->common, &cbs);
2297 ret = start_file_metadata_phase(&ctx->common, dentry_count);
2301 ret = apply_metadata(dentry_list, ctx);
2305 ret = end_file_metadata_phase(&ctx->common);
2309 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2310 ret = end_wimboot_extraction(ctx);
2318 (*func_NtClose)(ctx->h_target);
2319 if (ctx->target_ntpath.Buffer)
2320 HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
2321 FREE(ctx->pathbuf.Buffer);
2322 FREE(ctx->print_buffer);
2323 if (ctx->wimboot.prepopulate_pats) {
2324 FREE(ctx->wimboot.prepopulate_pats->strings);
2325 FREE(ctx->wimboot.prepopulate_pats);
2327 FREE(ctx->wimboot.mem_prepopulate_pats);
2328 FREE(ctx->data_buffer);
2332 const struct apply_operations win32_apply_ops = {
2334 .get_supported_features = win32_get_supported_features,
2335 .extract = win32_extract,
2336 .will_externally_back = win32_will_externally_back,
2337 .context_size = sizeof(struct win32_apply_ctx),
2340 #endif /* __WIN32__ */