2 * win32_apply.c - Windows-specific code for applying files from a WIM image.
6 * Copyright (C) 2013, 2014, 2015 Eric Biggers
8 * This file is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU Lesser General Public License as published by the Free
10 * Software Foundation; either version 3 of the License, or (at your option) any
13 * This file is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this file; if not, see http://www.gnu.org/licenses/.
28 #include "wimlib/win32_common.h"
30 #include "wimlib/apply.h"
31 #include "wimlib/assert.h"
32 #include "wimlib/blob_table.h"
33 #include "wimlib/capture.h" /* for mangle_pat() and match_pattern_list() */
34 #include "wimlib/dentry.h"
35 #include "wimlib/encoding.h"
36 #include "wimlib/error.h"
37 #include "wimlib/metadata.h"
38 #include "wimlib/paths.h"
39 #include "wimlib/reparse.h"
40 #include "wimlib/textfile.h"
41 #include "wimlib/xml.h"
42 #include "wimlib/wildcard.h"
43 #include "wimlib/wimboot.h"
45 struct win32_apply_ctx {
47 /* Extract flags, the pointer to the WIMStruct, etc. */
48 struct apply_ctx common;
50 /* WIMBoot information, only filled in if WIMLIB_EXTRACT_FLAG_WIMBOOT
53 /* This array contains the WIM files registered with WOF on the
54 * target volume for this extraction operation. All WIMStructs
55 * in this array are distinct and have ->filename != NULL. */
59 u8 blob_table_hash[SHA1_HASH_SIZE];
62 struct string_set *prepopulate_pats;
63 void *mem_prepopulate_pats;
65 bool tried_to_load_prepopulate_list;
67 bool have_wrong_version_wims;
68 bool have_uncompressed_wims;
69 bool have_unsupported_compressed_resources;
70 bool have_huge_resources;
73 /* Open handle to the target directory */
76 /* NT namespace path to the target directory (buffer allocated) */
77 UNICODE_STRING target_ntpath;
79 /* Temporary buffer for building paths (buffer allocated) */
80 UNICODE_STRING pathbuf;
82 /* Object attributes to reuse for opening files in the target directory.
83 * (attr.ObjectName == &pathbuf) and (attr.RootDirectory == h_target).
85 OBJECT_ATTRIBUTES attr;
87 /* Temporary I/O status block for system calls */
90 /* Allocated buffer for creating "printable" paths from our
91 * target-relative NT paths */
92 wchar_t *print_buffer;
94 /* Allocated buffer for reading blob data when it cannot be extracted
98 /* Pointer to the next byte in @data_buffer to fill */
101 /* Size allocated in @data_buffer */
102 size_t data_buffer_size;
104 /* Current offset in the raw encrypted file being written */
105 size_t encrypted_offset;
107 /* Current size of the raw encrypted file being written */
108 size_t encrypted_size;
110 /* Temporary buffer for reparse data */
111 struct reparse_buffer_disk rpbuf;
113 /* Temporary buffer for reparse data of "fixed" absolute symbolic links
115 struct reparse_buffer_disk rpfixbuf;
117 /* Array of open handles to filesystem streams currently being written
119 HANDLE open_handles[MAX_OPEN_FILES];
121 /* Number of handles in @open_handles currently open (filled in from the
122 * beginning of the array) */
123 unsigned num_open_handles;
125 /* List of dentries, joined by @d_tmp_list, that need to have reparse
126 * data extracted as soon as the whole blob has been read into
128 struct list_head reparse_dentries;
130 /* List of dentries, joined by @d_tmp_list, that need to have raw
131 * encrypted data extracted as soon as the whole blob has been read into
133 struct list_head encrypted_dentries;
135 /* Number of files for which we didn't have permission to set the full
136 * security descriptor. */
137 unsigned long partial_security_descriptors;
139 /* Number of files for which we didn't have permission to set any part
140 * of the security descriptor. */
141 unsigned long no_security_descriptors;
143 /* Number of files for which we couldn't set the short name. */
144 unsigned long num_set_short_name_failures;
146 /* Number of files for which we couldn't remove the short name. */
147 unsigned long num_remove_short_name_failures;
149 /* Have we tried to enable short name support on the target volume yet?
151 bool tried_to_enable_short_names;
154 /* Get the drive letter from a Windows path, or return the null character if the
155 * path is relative. */
157 get_drive_letter(const wchar_t *path)
159 /* Skip \\?\ prefix */
160 if (!wcsncmp(path, L"\\\\?\\", 4))
163 /* Return drive letter if valid */
164 if (((path[0] >= L'a' && path[0] <= L'z') ||
165 (path[0] >= L'A' && path[0] <= L'Z')) && path[1] == L':')
172 get_vol_flags(const wchar_t *target, DWORD *vol_flags_ret,
173 bool *short_names_supported_ret)
175 wchar_t filesystem_name[MAX_PATH + 1];
177 wchar_t *volume = NULL;
180 *short_names_supported_ret = false;
182 drive[0] = get_drive_letter(target);
190 if (!GetVolumeInformation(volume, NULL, 0, NULL, NULL,
191 vol_flags_ret, filesystem_name,
192 ARRAY_LEN(filesystem_name)))
194 win32_warning(GetLastError(),
195 L"Failed to get volume information for \"%ls\"",
200 if (wcsstr(filesystem_name, L"NTFS")) {
201 /* FILE_SUPPORTS_HARD_LINKS is only supported on Windows 7 and
202 * later. Force it on anyway if filesystem is NTFS. */
203 *vol_flags_ret |= FILE_SUPPORTS_HARD_LINKS;
205 /* There's no volume flag for short names, but according to the
206 * MS documentation they are only user-settable on NTFS. */
207 *short_names_supported_ret = true;
211 static const wchar_t *
212 current_path(struct win32_apply_ctx *ctx);
215 build_extraction_path(const struct wim_dentry *dentry,
216 struct win32_apply_ctx *ctx);
219 report_dentry_apply_error(const struct wim_dentry *dentry,
220 struct win32_apply_ctx *ctx, int ret)
222 build_extraction_path(dentry, ctx);
223 return report_apply_error(&ctx->common, ret, current_path(ctx));
227 check_apply_error(const struct wim_dentry *dentry,
228 struct win32_apply_ctx *ctx, int ret)
231 ret = report_dentry_apply_error(dentry, ctx, ret);
236 win32_get_supported_features(const wchar_t *target,
237 struct wim_features *supported_features)
240 bool short_names_supported;
242 /* Query the features of the target volume. */
244 get_vol_flags(target, &vol_flags, &short_names_supported);
246 supported_features->archive_files = 1;
247 supported_features->hidden_files = 1;
248 supported_features->system_files = 1;
250 if (vol_flags & FILE_FILE_COMPRESSION)
251 supported_features->compressed_files = 1;
253 if (vol_flags & FILE_SUPPORTS_ENCRYPTION) {
254 supported_features->encrypted_files = 1;
255 supported_features->encrypted_directories = 1;
258 supported_features->not_context_indexed_files = 1;
260 /* Don't do anything with FILE_SUPPORTS_SPARSE_FILES. */
262 if (vol_flags & FILE_NAMED_STREAMS)
263 supported_features->named_data_streams = 1;
265 if (vol_flags & FILE_SUPPORTS_HARD_LINKS)
266 supported_features->hard_links = 1;
268 if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS)
269 supported_features->reparse_points = 1;
271 if (vol_flags & FILE_PERSISTENT_ACLS)
272 supported_features->security_descriptors = 1;
274 if (short_names_supported)
275 supported_features->short_names = 1;
277 supported_features->timestamps = 1;
279 /* Note: Windows does not support case sensitive filenames! At least
280 * not without changing the registry and rebooting... */
285 /* Load the patterns from [PrepopulateList] of WimBootCompress.ini in the WIM
286 * image being extracted. */
288 load_prepopulate_pats(struct win32_apply_ctx *ctx)
290 const wchar_t *path = L"\\Windows\\System32\\WimBootCompress.ini";
291 struct wim_dentry *dentry;
292 const struct blob_descriptor *blob;
295 struct string_set *s;
297 struct text_file_section sec;
299 ctx->wimboot.tried_to_load_prepopulate_list = true;
301 dentry = get_dentry(ctx->common.wim, path, WIMLIB_CASE_INSENSITIVE);
303 (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
304 FILE_ATTRIBUTE_REPARSE_POINT |
305 FILE_ATTRIBUTE_ENCRYPTED)) ||
306 !(blob = inode_get_blob_for_unnamed_data_stream(dentry->d_inode,
307 ctx->common.wim->blob_table)))
309 WARNING("%ls does not exist in the WIM image.\n"
310 " The default configuration will be used instead; it assumes that all\n"
311 " files are valid for external backing regardless of path, equivalent\n"
312 " to an empty [PrepopulateList] section.", path);
313 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
316 ret = read_blob_into_alloc_buf(blob, &buf);
320 s = CALLOC(1, sizeof(struct string_set));
323 return WIMLIB_ERR_NOMEM;
326 sec.name = T("PrepopulateList");
329 ret = do_load_text_file(path, buf, blob->size, &mem, &sec, 1,
330 LOAD_TEXT_FILE_REMOVE_QUOTES |
331 LOAD_TEXT_FILE_NO_WARNINGS,
333 BUILD_BUG_ON(OS_PREFERRED_PATH_SEPARATOR != WIM_PATH_SEPARATOR);
339 ctx->wimboot.prepopulate_pats = s;
340 ctx->wimboot.mem_prepopulate_pats = mem;
344 /* Returns %true if the specified absolute path to a file in the WIM image
345 * matches a pattern in [PrepopulateList] of WimBootCompress.ini. Otherwise
348 in_prepopulate_list(const wchar_t *path, size_t path_nchars,
349 const struct win32_apply_ctx *ctx)
351 const struct string_set *pats = ctx->wimboot.prepopulate_pats;
353 if (!pats || !pats->num_strings)
356 return match_pattern_list(path, path_nchars, pats);
359 /* Returns %true if the specified absolute path to a file in the WIM image can
360 * be subject to external backing when extracted. Otherwise returns %false. */
362 can_externally_back_path(const wchar_t *path, size_t path_nchars,
363 const struct win32_apply_ctx *ctx)
365 if (in_prepopulate_list(path, path_nchars, ctx))
368 /* Since we attempt to modify the SYSTEM registry after it's extracted
369 * (see end_wimboot_extraction()), it can't be extracted as externally
370 * backed. This extends to associated files such as SYSTEM.LOG that
371 * also must be writable in order to write to the registry. Normally,
372 * SYSTEM is in [PrepopulateList], and the SYSTEM.* files match patterns
373 * in [ExclusionList] and therefore are not captured in the WIM at all.
374 * However, a WIM that wasn't specifically captured in "WIMBoot mode"
375 * may contain SYSTEM.* files. So to make things "just work", hard-code
377 if (match_path(path, path_nchars, L"\\Windows\\System32\\config\\SYSTEM*",
378 OS_PREFERRED_PATH_SEPARATOR, false))
385 is_resource_valid_for_external_backing(const struct wim_resource_descriptor *rdesc,
386 struct win32_apply_ctx *ctx)
388 /* Must be the original WIM file format. This check excludes pipable
389 * resources and solid resources. It also excludes other resources
390 * contained in such files even if they would be otherwise compatible.
392 if (rdesc->wim->hdr.magic != WIM_MAGIC ||
393 rdesc->wim->hdr.wim_version != WIM_VERSION_DEFAULT)
395 ctx->wimboot.have_wrong_version_wims = true;
400 * Whitelist of compression types and chunk sizes supported by
401 * Microsoft's WOF driver.
404 * - Uncompressed WIMs result in BSOD. However, this only applies to
405 * the WIM file itself, not to uncompressed resources in a WIM file
406 * that is otherwise compressed.
407 * - XPRESS 64K sometimes appears to work, but sometimes it causes
408 * reads to fail with STATUS_UNSUCCESSFUL.
410 switch (rdesc->compression_type) {
411 case WIMLIB_COMPRESSION_TYPE_NONE:
412 if (rdesc->wim->compression_type == WIMLIB_COMPRESSION_TYPE_NONE) {
413 ctx->wimboot.have_uncompressed_wims = true;
417 case WIMLIB_COMPRESSION_TYPE_XPRESS:
418 switch (rdesc->chunk_size) {
425 ctx->wimboot.have_unsupported_compressed_resources = true;
429 case WIMLIB_COMPRESSION_TYPE_LZX:
430 switch (rdesc->chunk_size) {
434 ctx->wimboot.have_unsupported_compressed_resources = true;
439 ctx->wimboot.have_unsupported_compressed_resources = true;
443 /* Microsoft's WoF driver errors out if it tries to satisfy a read with
444 * ending offset >= 4 GiB from an externally backed file. */
445 if (rdesc->uncompressed_size > 4200000000) {
446 ctx->wimboot.have_huge_resources = true;
453 #define WIM_BACKING_NOT_ENABLED -1
454 #define WIM_BACKING_NOT_POSSIBLE -2
455 #define WIM_BACKING_EXCLUDED -3
458 will_externally_back_inode(struct wim_inode *inode, struct win32_apply_ctx *ctx,
459 const struct wim_dentry **excluded_dentry_ret)
461 struct wim_dentry *dentry;
462 struct blob_descriptor *blob;
465 if (inode->i_can_externally_back)
468 /* This may do redundant checks because the cached value
469 * i_can_externally_back is 2-state (as opposed to 3-state:
470 * unknown/no/yes). But most files can be externally backed, so this
473 if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
474 FILE_ATTRIBUTE_REPARSE_POINT |
475 FILE_ATTRIBUTE_ENCRYPTED))
476 return WIM_BACKING_NOT_POSSIBLE;
478 blob = inode_get_blob_for_unnamed_data_stream_resolved(inode);
480 if (!blob || blob->blob_location != BLOB_IN_WIM ||
481 !is_resource_valid_for_external_backing(blob->rdesc, ctx))
482 return WIM_BACKING_NOT_POSSIBLE;
485 * We need to check the patterns in [PrepopulateList] against every name
486 * of the inode, in case any of them match.
489 inode_for_each_extraction_alias(dentry, inode) {
491 ret = calculate_dentry_full_path(dentry);
495 if (!can_externally_back_path(dentry->d_full_path,
496 wcslen(dentry->d_full_path), ctx))
498 if (excluded_dentry_ret)
499 *excluded_dentry_ret = dentry;
500 return WIM_BACKING_EXCLUDED;
504 inode->i_can_externally_back = 1;
509 * Determines if the unnamed data stream of a file will be created as an
510 * external backing, as opposed to a standard extraction.
513 win32_will_externally_back(struct wim_dentry *dentry, struct apply_ctx *_ctx)
515 struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
517 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
518 return WIM_BACKING_NOT_ENABLED;
520 if (!ctx->wimboot.tried_to_load_prepopulate_list)
521 if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
522 return WIMLIB_ERR_NOMEM;
524 return will_externally_back_inode(dentry->d_inode, ctx, NULL);
527 /* Find the WOF registration information for the specified WIM file. */
528 static struct wimboot_wim *
529 find_wimboot_wim(WIMStruct *wim_to_find, struct win32_apply_ctx *ctx)
531 for (size_t i = 0; i < ctx->wimboot.num_wims; i++)
532 if (wim_to_find == ctx->wimboot.wims[i].wim)
533 return &ctx->wimboot.wims[i];
540 set_external_backing(HANDLE h, struct wim_inode *inode, struct win32_apply_ctx *ctx)
543 const struct wim_dentry *excluded_dentry;
544 const struct blob_descriptor *blob;
545 const struct wimboot_wim *wimboot_wim;
547 ret = will_externally_back_inode(inode, ctx, &excluded_dentry);
548 if (ret > 0) /* Error. */
551 if (ret < 0 && ret != WIM_BACKING_EXCLUDED)
552 return 0; /* Not externally backing, other than due to exclusion. */
554 if (unlikely(ret == WIM_BACKING_EXCLUDED)) {
555 /* Not externally backing due to exclusion. */
556 union wimlib_progress_info info;
558 build_extraction_path(excluded_dentry, ctx);
560 info.wimboot_exclude.path_in_wim = excluded_dentry->d_full_path;
561 info.wimboot_exclude.extraction_path = current_path(ctx);
563 return call_progress(ctx->common.progfunc,
564 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE,
565 &info, ctx->common.progctx);
568 /* Externally backing. */
570 blob = inode_get_blob_for_unnamed_data_stream_resolved(inode);
571 wimboot_wim = find_wimboot_wim(blob->rdesc->wim, ctx);
573 if (unlikely(!wimboot_set_pointer(h,
575 wimboot_wim->data_source_id,
576 wimboot_wim->blob_table_hash,
577 ctx->wimboot.wof_running)))
579 const DWORD err = GetLastError();
581 build_extraction_path(inode_first_extraction_dentry(inode), ctx);
582 win32_error(err, L"\"%ls\": Couldn't set WIMBoot pointer data",
584 return WIMLIB_ERR_WIMBOOT;
589 /* Calculates the SHA-1 message digest of the WIM's blob table. */
591 hash_blob_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
593 return wim_reshdr_to_hash(&wim->hdr.blob_table_reshdr, wim, hash);
597 register_wim_with_wof(WIMStruct *wim, struct win32_apply_ctx *ctx)
599 struct wimboot_wim *p;
602 /* Check if already registered */
603 for (size_t i = 0; i < ctx->wimboot.num_wims; i++)
604 if (wim == ctx->wimboot.wims[i].wim)
607 /* Not yet registered */
609 p = REALLOC(ctx->wimboot.wims,
610 (ctx->wimboot.num_wims + 1) * sizeof(ctx->wimboot.wims[0]));
612 return WIMLIB_ERR_NOMEM;
613 ctx->wimboot.wims = p;
615 ctx->wimboot.wims[ctx->wimboot.num_wims].wim = wim;
617 ret = hash_blob_table(wim, ctx->wimboot.wims[ctx->wimboot.num_wims].blob_table_hash);
621 ret = wimboot_alloc_data_source_id(wim->filename,
623 ctx->common.wim->current_image,
625 &ctx->wimboot.wims[ctx->wimboot.num_wims].data_source_id,
626 &ctx->wimboot.wof_running);
630 ctx->wimboot.num_wims++;
634 /* Prepare for doing a "WIMBoot" extraction by loading patterns from
635 * [PrepopulateList] of WimBootCompress.ini and registering each source WIM file
636 * with WOF on the target volume. */
638 start_wimboot_extraction(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
641 struct wim_dentry *dentry;
643 if (!ctx->wimboot.tried_to_load_prepopulate_list)
644 if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
645 return WIMLIB_ERR_NOMEM;
647 if (!wim_info_get_wimboot(ctx->common.wim->wim_info,
648 ctx->common.wim->current_image))
649 WARNING("The WIM image is not marked as WIMBoot compatible. This usually\n"
650 " means it is not intended to be used to back a Windows operating\n"
651 " system. Proceeding anyway.");
653 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
654 struct blob_descriptor *blob;
656 ret = win32_will_externally_back(dentry, &ctx->common);
657 if (ret > 0) /* Error */
659 if (ret < 0) /* Won't externally back */
662 blob = inode_get_blob_for_unnamed_data_stream_resolved(dentry->d_inode);
663 ret = register_wim_with_wof(blob->rdesc->wim, ctx);
668 if (ctx->wimboot.have_wrong_version_wims) {
669 WARNING("At least one of the source WIM files uses a version of the WIM\n"
670 " file format that not supported by Microsoft's wof.sys driver.\n"
671 " Files whose data is contained in one of these WIM files will be\n"
672 " extracted as full files rather than externally backed.");
675 if (ctx->wimboot.have_uncompressed_wims) {
676 WARNING("At least one of the source WIM files is uncompressed. Files whose\n"
677 " data is contained in an uncompressed WIM file will be extracted as\n"
678 " full files rather than externally backed, since uncompressed WIM\n"
679 " files are not supported by Microsoft's wof.sys driver.");
682 if (ctx->wimboot.have_unsupported_compressed_resources) {
683 WARNING("At least one of the source WIM files uses a compression format that\n"
684 " is not supported by Microsoft's wof.sys driver. Files whose data is\n"
685 " contained in a compressed resource in one of these WIM files will be\n"
686 " extracted as full files rather than externally backed. (The\n"
687 " compression formats supported by wof.sys are: XPRESS 4K, XPRESS 8K,\n"
688 " XPRESS 16K, XPRESS 32K, and LZX 32K.)");
691 if (ctx->wimboot.have_huge_resources) {
692 WARNING("Some files exceeded 4.2 GB in size. Such files will be extracted\n"
693 " as full files rather than externally backed, since very large files\n"
694 " are not supported by Microsoft's wof.sys driver.");
701 build_win32_extraction_path(const struct wim_dentry *dentry,
702 struct win32_apply_ctx *ctx);
704 /* Sets WimBoot=1 in the extracted SYSTEM registry hive.
706 * WIMGAPI does this, and it's possible that it's important.
707 * But I don't know exactly what this value means to Windows. */
709 end_wimboot_extraction(struct win32_apply_ctx *ctx)
711 struct wim_dentry *dentry;
712 wchar_t subkeyname[32];
718 dentry = get_dentry(ctx->common.wim, L"\\Windows\\System32\\config\\SYSTEM",
719 WIMLIB_CASE_INSENSITIVE);
721 if (!dentry || !will_extract_dentry(dentry))
724 if (!will_extract_dentry(wim_get_current_root_dentry(ctx->common.wim)))
727 /* Not bothering to use the native routines (e.g. NtLoadKey()) for this.
728 * If this doesn't work, you probably also have many other problems. */
730 build_win32_extraction_path(dentry, ctx);
732 randomize_char_array_with_alnum(subkeyname, 20);
733 subkeyname[20] = L'\0';
735 res = RegLoadKey(HKEY_LOCAL_MACHINE, subkeyname, ctx->pathbuf.Buffer);
739 wcscpy(&subkeyname[20], L"\\Setup");
741 res = RegCreateKeyEx(HKEY_LOCAL_MACHINE, subkeyname, 0, NULL,
742 REG_OPTION_BACKUP_RESTORE, 0, NULL, &key, NULL);
748 res = RegSetValueEx(key, L"WimBoot", 0, REG_DWORD,
749 (const BYTE *)&value, sizeof(DWORD));
753 res = RegFlushKey(key);
756 res2 = RegCloseKey(key);
760 subkeyname[20] = L'\0';
761 RegUnLoadKey(HKEY_LOCAL_MACHINE, subkeyname);
765 win32_warning(res, L"Failed to set \\Setup: dword \"WimBoot\"=1 "
766 "value in registry hive \"%ls\"",
767 ctx->pathbuf.Buffer);
773 /* Returns the number of wide characters needed to represent the path to the
774 * specified @dentry, relative to the target directory, when extracted.
776 * Does not include null terminator (not needed for NtCreateFile). */
778 dentry_extraction_path_length(const struct wim_dentry *dentry)
781 const struct wim_dentry *d;
785 len += d->d_extraction_name_nchars + 1;
787 } while (!dentry_is_root(d) && will_extract_dentry(d));
789 return --len; /* No leading slash */
792 /* Returns the length of the longest string that might need to be appended to
793 * the path to an alias of an inode to open or create a named data stream.
795 * If the inode has no named data streams, this will be 0. Otherwise, this will
796 * be 1 plus the length of the longest-named data stream, since the data stream
797 * name must be separated from the path by the ':' character. */
799 inode_longest_named_data_stream_spec(const struct wim_inode *inode)
802 for (unsigned i = 0; i < inode->i_num_streams; i++) {
803 const struct wim_inode_stream *strm = &inode->i_streams[i];
804 if (!stream_is_named_data_stream(strm))
806 size_t len = utf16le_len_chars(strm->stream_name);
815 /* Find the length, in wide characters, of the longest path needed for
816 * extraction of any file in @dentry_list relative to the target directory.
818 * Accounts for named data streams, but does not include null terminator (not
819 * needed for NtCreateFile). */
821 compute_path_max(struct list_head *dentry_list)
824 const struct wim_dentry *dentry;
826 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
829 len = dentry_extraction_path_length(dentry);
831 /* Account for named data streams */
832 len += inode_longest_named_data_stream_spec(dentry->d_inode);
841 /* Build the path at which to extract the @dentry, relative to the target
844 * The path is saved in ctx->pathbuf. */
846 build_extraction_path(const struct wim_dentry *dentry,
847 struct win32_apply_ctx *ctx)
851 const struct wim_dentry *d;
853 len = dentry_extraction_path_length(dentry);
855 ctx->pathbuf.Length = len * sizeof(wchar_t);
856 p = ctx->pathbuf.Buffer + len;
858 !dentry_is_root(d->d_parent) && will_extract_dentry(d->d_parent);
861 p -= d->d_extraction_name_nchars;
862 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
865 /* No leading slash */
866 p -= d->d_extraction_name_nchars;
867 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
870 /* Build the path at which to extract the @dentry, relative to the target
871 * directory, adding the suffix for a named data stream.
873 * The path is saved in ctx->pathbuf. */
875 build_extraction_path_with_ads(const struct wim_dentry *dentry,
876 struct win32_apply_ctx *ctx,
877 const wchar_t *stream_name,
878 size_t stream_name_nchars)
882 build_extraction_path(dentry, ctx);
884 /* Add :NAME for named data stream */
885 p = ctx->pathbuf.Buffer + (ctx->pathbuf.Length / sizeof(wchar_t));
887 wmemcpy(p, stream_name, stream_name_nchars);
888 ctx->pathbuf.Length += (1 + stream_name_nchars) * sizeof(wchar_t);
891 /* Build the Win32 namespace path to the specified @dentry when extracted.
893 * The path is saved in ctx->pathbuf and will be null terminated.
895 * XXX: We could get rid of this if it wasn't needed for the file encryption
896 * APIs, and the registry manipulation in WIMBoot mode. */
898 build_win32_extraction_path(const struct wim_dentry *dentry,
899 struct win32_apply_ctx *ctx)
901 build_extraction_path(dentry, ctx);
903 /* Prepend target_ntpath to our relative path, then change \??\ into \\?\ */
905 memmove(ctx->pathbuf.Buffer +
906 (ctx->target_ntpath.Length / sizeof(wchar_t)) + 1,
907 ctx->pathbuf.Buffer, ctx->pathbuf.Length);
908 memcpy(ctx->pathbuf.Buffer, ctx->target_ntpath.Buffer,
909 ctx->target_ntpath.Length);
910 ctx->pathbuf.Buffer[ctx->target_ntpath.Length / sizeof(wchar_t)] = L'\\';
911 ctx->pathbuf.Length += ctx->target_ntpath.Length + sizeof(wchar_t);
912 ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)] = L'\0';
914 wimlib_assert(ctx->pathbuf.Length >= 4 * sizeof(wchar_t) &&
915 !wmemcmp(ctx->pathbuf.Buffer, L"\\??\\", 4));
917 ctx->pathbuf.Buffer[1] = L'\\';
921 /* Returns a "printable" representation of the last relative NT path that was
922 * constructed with build_extraction_path() or build_extraction_path_with_ads().
924 * This will be overwritten by the next call to this function. */
925 static const wchar_t *
926 current_path(struct win32_apply_ctx *ctx)
928 wchar_t *p = ctx->print_buffer;
930 p = wmempcpy(p, ctx->common.target, ctx->common.target_nchars);
932 p = wmempcpy(p, ctx->pathbuf.Buffer, ctx->pathbuf.Length / sizeof(wchar_t));
934 return ctx->print_buffer;
937 /* Open handle to the target directory if it is not already open. If the target
938 * directory does not exist, this creates it. */
940 open_target_directory(struct win32_apply_ctx *ctx)
947 ctx->attr.Length = sizeof(ctx->attr);
948 ctx->attr.RootDirectory = NULL;
949 ctx->attr.ObjectName = &ctx->target_ntpath;
950 status = (*func_NtCreateFile)(&ctx->h_target,
956 FILE_SHARE_VALID_FLAGS,
958 FILE_DIRECTORY_FILE |
959 FILE_OPEN_REPARSE_POINT |
960 FILE_OPEN_FOR_BACKUP_INTENT,
963 if (!NT_SUCCESS(status)) {
964 winnt_error(status, L"Can't open or create directory \"%ls\"",
966 return WIMLIB_ERR_OPENDIR;
968 ctx->attr.RootDirectory = ctx->h_target;
969 ctx->attr.ObjectName = &ctx->pathbuf;
974 close_target_directory(struct win32_apply_ctx *ctx)
977 (*func_NtClose)(ctx->h_target);
978 ctx->h_target = NULL;
979 ctx->attr.RootDirectory = NULL;
984 * Ensures the target directory exists and opens a handle to it, in preparation
985 * of using paths relative to it.
988 prepare_target(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
993 ret = win32_path_to_nt_path(ctx->common.target, &ctx->target_ntpath);
997 ret = open_target_directory(ctx);
1001 path_max = compute_path_max(dentry_list);
1002 /* Add some extra for building Win32 paths for the file encryption APIs,
1003 * and ensure we have at least enough to potentially use a 8.3 name for
1004 * the last component. */
1005 path_max += max(2 + (ctx->target_ntpath.Length / sizeof(wchar_t)),
1008 ctx->pathbuf.MaximumLength = path_max * sizeof(wchar_t);
1009 ctx->pathbuf.Buffer = MALLOC(ctx->pathbuf.MaximumLength);
1010 if (!ctx->pathbuf.Buffer)
1011 return WIMLIB_ERR_NOMEM;
1013 ctx->print_buffer = MALLOC((ctx->common.target_nchars + 1 + path_max + 1) *
1015 if (!ctx->print_buffer)
1016 return WIMLIB_ERR_NOMEM;
1021 /* When creating an inode that will have a short (DOS) name, we create it using
1022 * the long name associated with the short name. This ensures that the short
1023 * name gets associated with the correct long name. */
1024 static struct wim_dentry *
1025 first_extraction_alias(const struct wim_inode *inode)
1027 struct wim_dentry *dentry;
1029 inode_for_each_extraction_alias(dentry, inode)
1030 if (dentry_has_short_name(dentry))
1032 return inode_first_extraction_dentry(inode);
1036 * Set or clear FILE_ATTRIBUTE_COMPRESSED if the inherited value is different
1037 * from the desired value.
1039 * Note that you can NOT override the inherited value of
1040 * FILE_ATTRIBUTE_COMPRESSED directly with NtCreateFile().
1043 adjust_compression_attribute(HANDLE h, const struct wim_dentry *dentry,
1044 struct win32_apply_ctx *ctx)
1046 const bool compressed = (dentry->d_inode->i_attributes &
1047 FILE_ATTRIBUTE_COMPRESSED);
1049 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
1052 if (!ctx->common.supported_features.compressed_files)
1055 FILE_BASIC_INFORMATION info;
1057 USHORT compression_state;
1059 /* Get current attributes */
1060 status = (*func_NtQueryInformationFile)(h, &ctx->iosb,
1061 &info, sizeof(info),
1062 FileBasicInformation);
1063 if (NT_SUCCESS(status) &&
1064 compressed == !!(info.FileAttributes & FILE_ATTRIBUTE_COMPRESSED))
1066 /* Nothing needs to be done. */
1070 /* Set the new compression state */
1073 compression_state = COMPRESSION_FORMAT_DEFAULT;
1075 compression_state = COMPRESSION_FORMAT_NONE;
1077 status = (*func_NtFsControlFile)(h,
1082 FSCTL_SET_COMPRESSION,
1087 if (NT_SUCCESS(status))
1090 winnt_error(status, L"Can't %s compression attribute on \"%ls\"",
1091 (compressed ? "set" : "clear"), current_path(ctx));
1092 return WIMLIB_ERR_SET_ATTRIBUTES;
1095 /* Try to enable short name support on the target volume. If successful, return
1096 * true. If unsuccessful, issue a warning and return false. */
1098 try_to_enable_short_names(const wchar_t *volume)
1101 FILE_FS_PERSISTENT_VOLUME_INFORMATION info;
1103 DWORD bytesReturned;
1105 h = CreateFile(volume, GENERIC_WRITE,
1106 FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
1107 FILE_FLAG_BACKUP_SEMANTICS, NULL);
1108 if (h == INVALID_HANDLE_VALUE)
1111 info.VolumeFlags = 0;
1112 info.FlagMask = PERSISTENT_VOLUME_STATE_SHORT_NAME_CREATION_DISABLED;
1116 bret = DeviceIoControl(h, FSCTL_SET_PERSISTENT_VOLUME_STATE,
1117 &info, sizeof(info), NULL, 0,
1118 &bytesReturned, NULL);
1127 win32_warning(GetLastError(),
1128 L"Failed to enable short name support on %ls",
1134 remove_conflicting_short_name(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
1140 size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1141 (13 * sizeof(wchar_t));
1142 u8 buf[bufsize] _aligned_attribute(8);
1143 bool retried = false;
1144 FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1146 memset(buf, 0, bufsize);
1148 /* Build the path with the short name. */
1149 name = &ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)];
1150 while (name != ctx->pathbuf.Buffer && *(name - 1) != L'\\')
1152 end = mempcpy(name, dentry->d_short_name, dentry->d_short_name_nbytes);
1153 ctx->pathbuf.Length = ((u8 *)end - (u8 *)ctx->pathbuf.Buffer);
1155 /* Open the conflicting file (by short name). */
1156 status = (*func_NtOpenFile)(&h, GENERIC_WRITE | DELETE,
1157 &ctx->attr, &ctx->iosb,
1158 FILE_SHARE_VALID_FLAGS,
1159 FILE_OPEN_REPARSE_POINT | FILE_OPEN_FOR_BACKUP_INTENT);
1160 if (!NT_SUCCESS(status)) {
1161 winnt_warning(status, L"Can't open \"%ls\"", current_path(ctx));
1166 WARNING("Overriding conflicting short name; path=\"%ls\"",
1170 /* Try to remove the short name on the conflicting file. */
1173 status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1174 FileShortNameInformation);
1176 if (status == STATUS_INVALID_PARAMETER && !retried) {
1178 /* Microsoft forgot to make it possible to remove short names
1179 * until Windows 7. Oops. Use a random short name instead. */
1181 info->FileNameLength = 12 * sizeof(wchar_t);
1182 for (int i = 0; i < 8; i++)
1183 info->FileName[i] = 'A' + (rand() % 26);
1184 info->FileName[8] = L'.';
1185 info->FileName[9] = L'W';
1186 info->FileName[10] = L'L';
1187 info->FileName[11] = L'B';
1188 info->FileName[12] = L'\0';
1194 build_extraction_path(dentry, ctx);
1198 /* Set the short name on the open file @h which has been created at the location
1199 * indicated by @dentry.
1201 * Note that this may add, change, or remove the short name.
1203 * @h must be opened with DELETE access.
1205 * Returns 0 or WIMLIB_ERR_SET_SHORT_NAME. The latter only happens in
1206 * STRICT_SHORT_NAMES mode.
1209 set_short_name(HANDLE h, const struct wim_dentry *dentry,
1210 struct win32_apply_ctx *ctx)
1213 if (!ctx->common.supported_features.short_names)
1217 * Note: The size of the FILE_NAME_INFORMATION buffer must be such that
1218 * FileName contains at least 2 wide characters (4 bytes). Otherwise,
1219 * NtSetInformationFile() will return STATUS_INFO_LENGTH_MISMATCH. This
1220 * is despite the fact that FileNameLength can validly be 0 or 2 bytes,
1221 * with the former case being removing the existing short name if
1222 * present, rather than setting one.
1224 * The null terminator is seemingly optional, but to be safe we include
1225 * space for it and zero all unused space.
1228 size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1229 max(dentry->d_short_name_nbytes, sizeof(wchar_t)) +
1231 u8 buf[bufsize] _aligned_attribute(8);
1232 FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1234 bool tried_to_remove_existing = false;
1236 memset(buf, 0, bufsize);
1238 info->FileNameLength = dentry->d_short_name_nbytes;
1239 memcpy(info->FileName, dentry->d_short_name, dentry->d_short_name_nbytes);
1242 status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1243 FileShortNameInformation);
1244 if (NT_SUCCESS(status))
1247 if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
1248 if (dentry->d_short_name_nbytes == 0)
1250 if (!ctx->tried_to_enable_short_names) {
1254 ctx->tried_to_enable_short_names = true;
1256 ret = win32_get_drive_path(ctx->common.target,
1260 if (try_to_enable_short_names(volume))
1266 * Short names can conflict in several cases:
1268 * - a file being extracted has a short name conflicting with an
1271 * - a file being extracted has a short name conflicting with another
1272 * file being extracted (possible, but shouldn't happen)
1274 * - a file being extracted has a short name that conflicts with the
1275 * automatically generated short name of a file we previously
1276 * extracted, but failed to set the short name for. Sounds unlikely,
1277 * but this actually does happen fairly often on versions of Windows
1278 * prior to Windows 7 because they do not support removing short names
1281 if (unlikely(status == STATUS_OBJECT_NAME_COLLISION) &&
1282 dentry->d_short_name_nbytes && !tried_to_remove_existing)
1284 tried_to_remove_existing = true;
1285 status = remove_conflicting_short_name(dentry, ctx);
1286 if (NT_SUCCESS(status))
1290 /* By default, failure to set short names is not an error (since short
1291 * names aren't too important anymore...). */
1292 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
1293 if (dentry->d_short_name_nbytes)
1294 ctx->num_set_short_name_failures++;
1296 ctx->num_remove_short_name_failures++;
1300 winnt_error(status, L"Can't set short name on \"%ls\"", current_path(ctx));
1301 return WIMLIB_ERR_SET_SHORT_NAME;
1305 * A wrapper around NtCreateFile() to make it slightly more usable...
1306 * This uses the path currently constructed in ctx->pathbuf.
1308 * Also, we always specify FILE_OPEN_FOR_BACKUP_INTENT and
1309 * FILE_OPEN_REPARSE_POINT.
1312 do_create_file(PHANDLE FileHandle,
1313 ACCESS_MASK DesiredAccess,
1314 PLARGE_INTEGER AllocationSize,
1315 ULONG FileAttributes,
1316 ULONG CreateDisposition,
1317 ULONG CreateOptions,
1318 struct win32_apply_ctx *ctx)
1320 return (*func_NtCreateFile)(FileHandle,
1326 FILE_SHARE_VALID_FLAGS,
1329 FILE_OPEN_FOR_BACKUP_INTENT |
1330 FILE_OPEN_REPARSE_POINT,
1335 /* Like do_create_file(), but builds the extraction path of the @dentry first.
1338 create_file(PHANDLE FileHandle,
1339 ACCESS_MASK DesiredAccess,
1340 PLARGE_INTEGER AllocationSize,
1341 ULONG FileAttributes,
1342 ULONG CreateDisposition,
1343 ULONG CreateOptions,
1344 const struct wim_dentry *dentry,
1345 struct win32_apply_ctx *ctx)
1347 build_extraction_path(dentry, ctx);
1348 return do_create_file(FileHandle,
1358 delete_file_or_stream(struct win32_apply_ctx *ctx)
1362 FILE_DISPOSITION_INFORMATION disposition_info;
1363 FILE_BASIC_INFORMATION basic_info;
1364 bool retried = false;
1366 status = do_create_file(&h,
1371 FILE_NON_DIRECTORY_FILE,
1373 if (unlikely(!NT_SUCCESS(status))) {
1374 winnt_error(status, L"Can't open \"%ls\" for deletion",
1376 return WIMLIB_ERR_OPEN;
1380 disposition_info.DoDeleteFile = TRUE;
1381 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1383 sizeof(disposition_info),
1384 FileDispositionInformation);
1386 if (likely(NT_SUCCESS(status)))
1389 if (status == STATUS_CANNOT_DELETE && !retried) {
1390 /* Clear file attributes and try again. This is necessary for
1391 * FILE_ATTRIBUTE_READONLY files. */
1392 status = do_create_file(&h,
1393 FILE_WRITE_ATTRIBUTES | DELETE,
1397 FILE_NON_DIRECTORY_FILE,
1399 if (!NT_SUCCESS(status)) {
1401 L"Can't open \"%ls\" to reset attributes",
1403 return WIMLIB_ERR_OPEN;
1405 memset(&basic_info, 0, sizeof(basic_info));
1406 basic_info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
1407 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1410 FileBasicInformation);
1411 if (!NT_SUCCESS(status)) {
1413 L"Can't reset file attributes on \"%ls\"",
1416 return WIMLIB_ERR_SET_ATTRIBUTES;
1421 winnt_error(status, L"Can't delete \"%ls\"", current_path(ctx));
1422 return WIMLIB_ERR_OPEN;
1426 * Create a nondirectory file or named data stream at the current path,
1427 * superseding any that already exists at that path. If successful, return an
1428 * open handle to the file or named data stream.
1431 supersede_file_or_stream(struct win32_apply_ctx *ctx, HANDLE *h_ret)
1434 bool retried = false;
1436 /* FILE_ATTRIBUTE_SYSTEM is needed to ensure that
1437 * FILE_ATTRIBUTE_ENCRYPTED doesn't get set before we want it to be. */
1439 status = do_create_file(h_ret,
1440 GENERIC_READ | GENERIC_WRITE | DELETE,
1442 FILE_ATTRIBUTE_SYSTEM,
1444 FILE_NON_DIRECTORY_FILE,
1446 if (likely(NT_SUCCESS(status)))
1449 /* STATUS_OBJECT_NAME_COLLISION means that the file or stream already
1450 * exists. Delete the existing file or stream, then try again.
1452 * Note: we don't use FILE_OVERWRITE_IF or FILE_SUPERSEDE because of
1453 * problems with certain file attributes, especially
1454 * FILE_ATTRIBUTE_ENCRYPTED. FILE_SUPERSEDE is also broken in the
1455 * Windows PE ramdisk. */
1456 if (status == STATUS_OBJECT_NAME_COLLISION && !retried) {
1457 int ret = delete_file_or_stream(ctx);
1463 winnt_error(status, L"Can't create \"%ls\"", current_path(ctx));
1464 return WIMLIB_ERR_OPEN;
1468 * Create empty named data streams for the specified file, if there are any.
1470 * Since these won't have blob descriptors, they won't show up in the call to
1471 * extract_blob_list(). Hence the need for the special case.
1474 create_empty_named_data_streams(const struct wim_dentry *dentry,
1475 struct win32_apply_ctx *ctx)
1477 const struct wim_inode *inode = dentry->d_inode;
1478 bool path_modified = false;
1481 if (!ctx->common.supported_features.named_data_streams)
1484 for (unsigned i = 0; i < inode->i_num_streams; i++) {
1485 const struct wim_inode_stream *strm = &inode->i_streams[i];
1488 if (!stream_is_named_data_stream(strm) ||
1489 stream_blob_resolved(strm) != NULL)
1492 build_extraction_path_with_ads(dentry, ctx,
1494 utf16le_len_chars(strm->stream_name));
1495 path_modified = true;
1496 ret = supersede_file_or_stream(ctx, &h);
1501 /* Restore the path to the dentry itself */
1503 build_extraction_path(dentry, ctx);
1508 * Creates the directory named by @dentry, or uses an existing directory at that
1509 * location. If necessary, sets the short name and/or fixes compression and
1510 * encryption attributes.
1512 * Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
1515 create_directory(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
1522 /* DELETE is needed for set_short_name(); GENERIC_READ and GENERIC_WRITE
1523 * are needed for adjust_compression_attribute(). */
1524 perms = GENERIC_READ | GENERIC_WRITE;
1525 if (!dentry_is_root(dentry))
1528 /* FILE_ATTRIBUTE_SYSTEM is needed to ensure that
1529 * FILE_ATTRIBUTE_ENCRYPTED doesn't get set before we want it to be. */
1530 status = create_file(&h, perms, NULL, FILE_ATTRIBUTE_SYSTEM,
1531 FILE_OPEN_IF, FILE_DIRECTORY_FILE, dentry, ctx);
1532 if (!NT_SUCCESS(status)) {
1533 winnt_error(status, L"Can't create directory \"%ls\"",
1535 return WIMLIB_ERR_MKDIR;
1538 if (ctx->iosb.Information == FILE_OPENED) {
1539 /* If we opened an existing directory, try to clear its file
1540 * attributes. As far as I know, this only actually makes a
1541 * difference in the case where a FILE_ATTRIBUTE_READONLY
1542 * directory has a named data stream which needs to be
1543 * extracted. You cannot create a named data stream of such a
1544 * directory, even though this contradicts Microsoft's
1545 * documentation for FILE_ATTRIBUTE_READONLY which states it is
1546 * not honored for directories! */
1547 FILE_BASIC_INFORMATION basic_info = { .FileAttributes = FILE_ATTRIBUTE_NORMAL };
1548 (*func_NtSetInformationFile)(h, &ctx->iosb, &basic_info,
1549 sizeof(basic_info), FileBasicInformation);
1552 if (!dentry_is_root(dentry)) {
1553 ret = set_short_name(h, dentry, ctx);
1558 ret = adjust_compression_attribute(h, dentry, ctx);
1565 * Create all the directories being extracted, other than the target directory
1568 * Note: we don't honor directory hard links. However, we don't allow them to
1569 * exist in WIM images anyway (see inode_fixup.c).
1572 create_directories(struct list_head *dentry_list,
1573 struct win32_apply_ctx *ctx)
1575 const struct wim_dentry *dentry;
1578 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1580 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
1583 /* Note: Here we include files with
1584 * FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
1585 * wait until later to actually set the reparse data. */
1587 ret = create_directory(dentry, ctx);
1590 ret = create_empty_named_data_streams(dentry, ctx);
1592 ret = check_apply_error(dentry, ctx, ret);
1596 ret = report_file_created(&ctx->common);
1604 * Creates the nondirectory file named by @dentry.
1606 * On success, returns an open handle to the file in @h_ret, with GENERIC_READ,
1607 * GENERIC_WRITE, and DELETE access. Also, the path to the file will be saved
1608 * in ctx->pathbuf. On failure, returns an error code.
1611 create_nondirectory_inode(HANDLE *h_ret, const struct wim_dentry *dentry,
1612 struct win32_apply_ctx *ctx)
1617 build_extraction_path(dentry, ctx);
1619 ret = supersede_file_or_stream(ctx, &h);
1623 ret = adjust_compression_attribute(h, dentry, ctx);
1627 ret = create_empty_named_data_streams(dentry, ctx);
1640 /* Creates a hard link at the location named by @dentry to the file represented
1641 * by the open handle @h. Or, if the target volume does not support hard links,
1642 * create a separate file instead. */
1644 create_link(HANDLE h, const struct wim_dentry *dentry,
1645 struct win32_apply_ctx *ctx)
1647 if (ctx->common.supported_features.hard_links) {
1649 build_extraction_path(dentry, ctx);
1651 size_t bufsize = offsetof(FILE_LINK_INFORMATION, FileName) +
1652 ctx->pathbuf.Length + sizeof(wchar_t);
1653 u8 buf[bufsize] _aligned_attribute(8);
1654 FILE_LINK_INFORMATION *info = (FILE_LINK_INFORMATION *)buf;
1657 info->ReplaceIfExists = TRUE;
1658 info->RootDirectory = ctx->attr.RootDirectory;
1659 info->FileNameLength = ctx->pathbuf.Length;
1660 memcpy(info->FileName, ctx->pathbuf.Buffer, ctx->pathbuf.Length);
1661 info->FileName[info->FileNameLength / 2] = L'\0';
1663 /* Note: the null terminator isn't actually necessary,
1664 * but if you don't add the extra character, you get
1665 * STATUS_INFO_LENGTH_MISMATCH when FileNameLength
1666 * happens to be 2 */
1668 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1670 FileLinkInformation);
1671 if (NT_SUCCESS(status))
1673 winnt_error(status, L"Failed to create link \"%ls\"",
1675 return WIMLIB_ERR_LINK;
1680 ret = create_nondirectory_inode(&h2, dentry, ctx);
1684 (*func_NtClose)(h2);
1689 /* Given an inode (represented by the open handle @h) for which one link has
1690 * been created (named by @first_dentry), create the other links.
1692 * Or, if the target volume does not support hard links, create separate files.
1694 * Note: This uses ctx->pathbuf and does not reset it.
1697 create_links(HANDLE h, const struct wim_dentry *first_dentry,
1698 struct win32_apply_ctx *ctx)
1700 const struct wim_inode *inode = first_dentry->d_inode;
1701 const struct wim_dentry *dentry;
1704 inode_for_each_extraction_alias(dentry, inode) {
1705 if (dentry != first_dentry) {
1706 ret = create_link(h, dentry, ctx);
1714 /* Create a nondirectory file, including all links. */
1716 create_nondirectory(struct wim_inode *inode, struct win32_apply_ctx *ctx)
1718 struct wim_dentry *first_dentry;
1722 first_dentry = first_extraction_alias(inode);
1724 /* Create first link. */
1725 ret = create_nondirectory_inode(&h, first_dentry, ctx);
1729 /* Set short name. */
1730 ret = set_short_name(h, first_dentry, ctx);
1732 /* Create additional links, OR if hard links are not supported just
1733 * create more files. */
1735 ret = create_links(h, first_dentry, ctx);
1737 /* "WIMBoot" extraction: set external backing by the WIM file if needed. */
1738 if (!ret && unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
1739 ret = set_external_backing(h, inode, ctx);
1745 /* Create all the nondirectory files being extracted, including all aliases
1748 create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1750 struct wim_dentry *dentry;
1751 struct wim_inode *inode;
1754 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1755 inode = dentry->d_inode;
1756 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1758 /* Call create_nondirectory() only once per inode */
1759 if (dentry == inode_first_extraction_dentry(inode)) {
1760 ret = create_nondirectory(inode, ctx);
1761 ret = check_apply_error(dentry, ctx, ret);
1765 ret = report_file_created(&ctx->common);
1773 close_handles(struct win32_apply_ctx *ctx)
1775 for (unsigned i = 0; i < ctx->num_open_handles; i++)
1776 (*func_NtClose)(ctx->open_handles[i]);
1779 /* Prepare to read the next blob, which has size @blob_size, into an in-memory
1782 prepare_data_buffer(struct win32_apply_ctx *ctx, u64 blob_size)
1784 if (blob_size > ctx->data_buffer_size) {
1785 /* Larger buffer needed. */
1787 if ((size_t)blob_size != blob_size)
1789 new_buffer = REALLOC(ctx->data_buffer, blob_size);
1792 ctx->data_buffer = new_buffer;
1793 ctx->data_buffer_size = blob_size;
1795 /* On the first call this changes data_buffer_ptr from NULL, which tells
1796 * extract_chunk() that the data buffer needs to be filled while reading
1797 * the stream data. */
1798 ctx->data_buffer_ptr = ctx->data_buffer;
1803 begin_extract_blob_instance(const struct blob_descriptor *blob,
1804 struct wim_dentry *dentry,
1805 const struct wim_inode_stream *strm,
1806 struct win32_apply_ctx *ctx)
1808 FILE_ALLOCATION_INFORMATION alloc_info;
1812 if (unlikely(strm->stream_type == STREAM_TYPE_REPARSE_POINT)) {
1813 /* We can't write the reparse point stream directly; we must set
1814 * it with FSCTL_SET_REPARSE_POINT, which requires that all the
1815 * data be available. So, stage the data in a buffer. */
1816 if (!prepare_data_buffer(ctx, blob->size))
1817 return WIMLIB_ERR_NOMEM;
1818 list_add_tail(&dentry->d_tmp_list, &ctx->reparse_dentries);
1822 if (unlikely(strm->stream_type == STREAM_TYPE_EFSRPC_RAW_DATA)) {
1823 /* We can't write encrypted files directly; we must use
1824 * WriteEncryptedFileRaw(), which requires providing the data
1825 * through a callback function. This can't easily be combined
1826 * with our own callback-based approach.
1828 * The current workaround is to simply read the blob into memory
1829 * and write the encrypted file from that.
1831 * TODO: This isn't sufficient for extremely large encrypted
1832 * files. Perhaps we should create an extra thread to write
1834 if (!prepare_data_buffer(ctx, blob->size))
1835 return WIMLIB_ERR_NOMEM;
1836 list_add_tail(&dentry->d_tmp_list, &ctx->encrypted_dentries);
1840 /* It's a data stream (may be unnamed or named). */
1841 wimlib_assert(strm->stream_type == STREAM_TYPE_DATA);
1843 if (ctx->num_open_handles == MAX_OPEN_FILES) {
1844 /* XXX: Fix this. But because of the checks in
1845 * extract_blob_list(), this can now only happen on a filesystem
1846 * that does not support hard links. */
1847 ERROR("Can't extract data: too many open files!");
1848 return WIMLIB_ERR_UNSUPPORTED;
1852 if (unlikely(stream_is_named(strm))) {
1853 build_extraction_path_with_ads(dentry, ctx,
1855 utf16le_len_chars(strm->stream_name));
1857 build_extraction_path(dentry, ctx);
1861 /* Open a new handle */
1862 status = do_create_file(&h,
1863 FILE_WRITE_DATA | SYNCHRONIZE,
1864 NULL, 0, FILE_OPEN_IF,
1865 FILE_SEQUENTIAL_ONLY |
1866 FILE_SYNCHRONOUS_IO_NONALERT,
1868 if (!NT_SUCCESS(status)) {
1869 winnt_error(status, L"Can't open \"%ls\" for writing",
1871 return WIMLIB_ERR_OPEN;
1874 ctx->open_handles[ctx->num_open_handles++] = h;
1876 /* Allocate space for the data. */
1877 alloc_info.AllocationSize.QuadPart = blob->size;
1878 (*func_NtSetInformationFile)(h, &ctx->iosb,
1879 &alloc_info, sizeof(alloc_info),
1880 FileAllocationInformation);
1884 /* Set the reparse point @rpbuf of length @rpbuflen on the extracted file
1885 * corresponding to the WIM dentry @dentry. */
1887 do_set_reparse_point(const struct wim_dentry *dentry,
1888 const struct reparse_buffer_disk *rpbuf, u16 rpbuflen,
1889 struct win32_apply_ctx *ctx)
1894 status = create_file(&h, GENERIC_WRITE, NULL,
1895 0, FILE_OPEN, 0, dentry, ctx);
1896 if (!NT_SUCCESS(status))
1899 status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
1900 &ctx->iosb, FSCTL_SET_REPARSE_POINT,
1901 (void *)rpbuf, rpbuflen,
1905 if (NT_SUCCESS(status))
1908 /* On Windows, by default only the Administrator can create symbolic
1909 * links for some reason. By default we just issue a warning if this
1910 * appears to be the problem. Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
1911 * to get a hard error. */
1912 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
1913 && (status == STATUS_PRIVILEGE_NOT_HELD ||
1914 status == STATUS_ACCESS_DENIED)
1915 && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1916 dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1918 WARNING("Can't create symbolic link \"%ls\"! \n"
1919 " (Need Administrator rights, or at least "
1921 " SeCreateSymbolicLink privilege.)",
1927 winnt_error(status, L"Can't set reparse data on \"%ls\"",
1929 return WIMLIB_ERR_SET_REPARSE_DATA;
1932 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1933 * pointer to the suffix of the path that begins with the device directly, such
1934 * as e:\Windows\System32. */
1935 static const wchar_t *
1936 skip_nt_toplevel_component(const wchar_t *path, size_t path_nchars)
1938 static const wchar_t * const dirs[] = {
1943 const wchar_t * const end = path + path_nchars;
1945 for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
1946 size_t len = wcslen(dirs[i]);
1947 if (len <= (end - path) && !wmemcmp(path, dirs[i], len)) {
1949 while (path != end && *path == L'\\')
1958 * Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1959 * pointer to the suffix of the path that is device-relative but possibly with
1960 * leading slashes, such as \Windows\System32.
1962 * The path has an explicit length and is not necessarily null terminated.
1964 static const wchar_t *
1965 get_device_relative_path(const wchar_t *path, size_t path_nchars)
1967 const wchar_t * const orig_path = path;
1968 const wchar_t * const end = path + path_nchars;
1970 path = skip_nt_toplevel_component(path, path_nchars);
1971 if (path == orig_path)
1974 while (path != end && *path != L'\\')
1981 * Given a reparse point buffer for an inode for which the absolute link target
1982 * was relativized when it was archived, de-relative the link target to be
1983 * consistent with the actual extraction location.
1986 try_rpfix(struct reparse_buffer_disk *rpbuf, u16 *rpbuflen_p,
1987 struct win32_apply_ctx *ctx)
1989 struct link_reparse_point link;
1990 size_t orig_subst_name_nchars;
1991 const wchar_t *relpath;
1992 size_t relpath_nchars;
1993 size_t target_ntpath_nchars;
1994 size_t fixed_subst_name_nchars;
1995 const wchar_t *fixed_print_name;
1996 size_t fixed_print_name_nchars;
1998 /* Do nothing if the reparse data is invalid. */
1999 if (parse_link_reparse_point(rpbuf, *rpbuflen_p, &link))
2002 /* Do nothing if the reparse point is a relative symbolic link. */
2003 if (link_is_relative_symlink(&link))
2006 /* Build the new substitute name from the NT namespace path to the
2007 * target directory, then a path separator, then the "device relative"
2008 * part of the old substitute name. */
2010 orig_subst_name_nchars = link.substitute_name_nbytes / sizeof(wchar_t);
2012 relpath = get_device_relative_path(link.substitute_name,
2013 orig_subst_name_nchars);
2014 relpath_nchars = orig_subst_name_nchars -
2015 (relpath - link.substitute_name);
2017 target_ntpath_nchars = ctx->target_ntpath.Length / sizeof(wchar_t);
2019 fixed_subst_name_nchars = target_ntpath_nchars + relpath_nchars;
2021 wchar_t fixed_subst_name[fixed_subst_name_nchars];
2023 wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer, target_ntpath_nchars);
2024 wmemcpy(&fixed_subst_name[target_ntpath_nchars], relpath, relpath_nchars);
2025 /* Doesn't need to be null-terminated. */
2027 /* Print name should be Win32, but not all NT names can even be
2028 * translated to Win32 names. But we can at least delete the top-level
2029 * directory, such as \??\, and this will have the expected result in
2030 * the usual case. */
2031 fixed_print_name = skip_nt_toplevel_component(fixed_subst_name,
2032 fixed_subst_name_nchars);
2033 fixed_print_name_nchars = fixed_subst_name_nchars - (fixed_print_name -
2036 link.substitute_name = fixed_subst_name;
2037 link.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
2038 link.print_name = (wchar_t *)fixed_print_name;
2039 link.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
2040 make_link_reparse_point(&link, rpbuf, rpbuflen_p);
2043 /* Sets the reparse point on the specified file. This handles "fixing" the
2044 * targets of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX
2047 set_reparse_point(const struct wim_dentry *dentry,
2048 const struct reparse_buffer_disk *rpbuf, u16 rpbuflen,
2049 struct win32_apply_ctx *ctx)
2051 if ((ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
2052 && !(dentry->d_inode->i_rp_flags & WIM_RP_FLAG_NOT_FIXED))
2054 memcpy(&ctx->rpfixbuf, rpbuf, rpbuflen);
2055 try_rpfix(&ctx->rpfixbuf, &rpbuflen, ctx);
2056 rpbuf = &ctx->rpfixbuf;
2058 return do_set_reparse_point(dentry, rpbuf, rpbuflen, ctx);
2062 /* Import the next block of raw encrypted data */
2064 import_encrypted_data(PBYTE pbData, PVOID pvCallbackContext, PULONG Length)
2066 struct win32_apply_ctx *ctx = pvCallbackContext;
2069 copy_len = min(ctx->encrypted_size - ctx->encrypted_offset, *Length);
2070 memcpy(pbData, &ctx->data_buffer[ctx->encrypted_offset], copy_len);
2071 ctx->encrypted_offset += copy_len;
2073 return ERROR_SUCCESS;
2077 * Write the raw encrypted data to the already-created file (or directory)
2078 * corresponding to @dentry.
2080 * The raw encrypted data is provided in ctx->data_buffer, and its size is
2081 * ctx->encrypted_size.
2083 * This function may close the target directory, in which case the caller needs
2084 * to re-open it if needed.
2087 extract_encrypted_file(const struct wim_dentry *dentry,
2088 struct win32_apply_ctx *ctx)
2095 /* Temporarily build a Win32 path for OpenEncryptedFileRaw() */
2096 build_win32_extraction_path(dentry, ctx);
2098 flags = CREATE_FOR_IMPORT | OVERWRITE_HIDDEN;
2099 if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
2100 flags |= CREATE_FOR_DIR;
2104 err = OpenEncryptedFileRaw(ctx->pathbuf.Buffer, flags, &rawctx);
2105 if (err == ERROR_SHARING_VIOLATION && !retried) {
2106 /* This can be caused by the handle we have open to the target
2107 * directory. Try closing it temporarily. */
2108 close_target_directory(ctx);
2113 /* Restore the NT namespace path */
2114 build_extraction_path(dentry, ctx);
2116 if (err != ERROR_SUCCESS) {
2117 win32_error(err, L"Can't open \"%ls\" for encrypted import",
2119 return WIMLIB_ERR_OPEN;
2122 ctx->encrypted_offset = 0;
2124 err = WriteEncryptedFileRaw(import_encrypted_data, ctx, rawctx);
2126 CloseEncryptedFileRaw(rawctx);
2128 if (err != ERROR_SUCCESS) {
2129 win32_error(err, L"Can't import encrypted file \"%ls\"",
2131 return WIMLIB_ERR_WRITE;
2137 /* Called when starting to read a blob for extraction on Windows */
2139 begin_extract_blob(struct blob_descriptor *blob, void *_ctx)
2141 struct win32_apply_ctx *ctx = _ctx;
2142 const struct blob_extraction_target *targets = blob_extraction_targets(blob);
2145 ctx->num_open_handles = 0;
2146 ctx->data_buffer_ptr = NULL;
2147 INIT_LIST_HEAD(&ctx->reparse_dentries);
2148 INIT_LIST_HEAD(&ctx->encrypted_dentries);
2150 for (u32 i = 0; i < blob->out_refcnt; i++) {
2151 const struct wim_inode *inode = targets[i].inode;
2152 const struct wim_inode_stream *strm = targets[i].stream;
2153 struct wim_dentry *dentry;
2155 /* A copy of the blob needs to be extracted to @inode. */
2157 if (ctx->common.supported_features.hard_links) {
2158 dentry = inode_first_extraction_dentry(inode);
2159 ret = begin_extract_blob_instance(blob, dentry, strm, ctx);
2160 ret = check_apply_error(dentry, ctx, ret);
2164 /* Hard links not supported. Extract the blob
2165 * separately to each alias of the inode. */
2166 inode_for_each_extraction_alias(dentry, inode) {
2167 ret = begin_extract_blob_instance(blob, dentry, strm, ctx);
2168 ret = check_apply_error(dentry, ctx, ret);
2182 /* Called when the next chunk of a blob has been read for extraction on Windows
2185 extract_chunk(const void *chunk, size_t size, void *_ctx)
2187 struct win32_apply_ctx *ctx = _ctx;
2189 /* Write the data chunk to each open handle */
2190 for (unsigned i = 0; i < ctx->num_open_handles; i++) {
2191 u8 *bufptr = (u8 *)chunk;
2192 size_t bytes_remaining = size;
2194 while (bytes_remaining) {
2195 ULONG count = min(0xFFFFFFFF, bytes_remaining);
2197 status = (*func_NtWriteFile)(ctx->open_handles[i],
2199 &ctx->iosb, bufptr, count,
2201 if (!NT_SUCCESS(status)) {
2202 winnt_error(status, L"Error writing data to target volume");
2203 return WIMLIB_ERR_WRITE;
2205 bufptr += ctx->iosb.Information;
2206 bytes_remaining -= ctx->iosb.Information;
2210 /* Copy the data chunk into the buffer (if needed) */
2211 if (ctx->data_buffer_ptr)
2212 ctx->data_buffer_ptr = mempcpy(ctx->data_buffer_ptr,
2217 /* Called when a blob has been fully read for extraction on Windows */
2219 end_extract_blob(struct blob_descriptor *blob, int status, void *_ctx)
2221 struct win32_apply_ctx *ctx = _ctx;
2223 const struct wim_dentry *dentry;
2230 if (likely(!ctx->data_buffer_ptr))
2233 if (!list_empty(&ctx->reparse_dentries)) {
2234 if (blob->size > REPARSE_DATA_MAX_SIZE) {
2235 dentry = list_first_entry(&ctx->reparse_dentries,
2236 struct wim_dentry, d_tmp_list);
2237 build_extraction_path(dentry, ctx);
2238 ERROR("Reparse data of \"%ls\" has size "
2239 "%"PRIu64" bytes (exceeds %u bytes)",
2240 current_path(ctx), blob->size,
2241 REPARSE_DATA_MAX_SIZE);
2242 ret = WIMLIB_ERR_INVALID_REPARSE_DATA;
2243 return check_apply_error(dentry, ctx, ret);
2246 memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, blob->size);
2248 list_for_each_entry(dentry, &ctx->reparse_dentries, d_tmp_list) {
2250 /* Reparse point header */
2251 complete_reparse_point(&ctx->rpbuf, dentry->d_inode,
2254 ret = set_reparse_point(dentry, &ctx->rpbuf,
2255 REPARSE_DATA_OFFSET + blob->size,
2257 ret = check_apply_error(dentry, ctx, ret);
2263 if (!list_empty(&ctx->encrypted_dentries)) {
2264 ctx->encrypted_size = blob->size;
2265 list_for_each_entry(dentry, &ctx->encrypted_dentries, d_tmp_list) {
2266 ret = extract_encrypted_file(dentry, ctx);
2267 ret = check_apply_error(dentry, ctx, ret);
2270 /* Re-open the target directory if needed. */
2271 ret = open_target_directory(ctx);
2280 /* Attributes that can't be set directly */
2281 #define SPECIAL_ATTRIBUTES \
2282 (FILE_ATTRIBUTE_REPARSE_POINT | \
2283 FILE_ATTRIBUTE_DIRECTORY | \
2284 FILE_ATTRIBUTE_ENCRYPTED | \
2285 FILE_ATTRIBUTE_SPARSE_FILE | \
2286 FILE_ATTRIBUTE_COMPRESSED)
2288 /* Set the security descriptor @desc, of @desc_size bytes, on the file with open
2291 set_security_descriptor(HANDLE h, const void *_desc,
2292 size_t desc_size, struct win32_apply_ctx *ctx)
2294 SECURITY_INFORMATION info;
2296 SECURITY_DESCRIPTOR_RELATIVE *desc;
2299 * Ideally, we would just pass in the security descriptor buffer as-is.
2300 * But it turns out that Windows can mess up the security descriptor
2301 * even when using the low-level NtSetSecurityObject() function:
2303 * - Windows will clear SE_DACL_AUTO_INHERITED if it is set in the
2304 * passed buffer. To actually get Windows to set
2305 * SE_DACL_AUTO_INHERITED, the application must set the non-persistent
2306 * flag SE_DACL_AUTO_INHERIT_REQ. As usual, Microsoft didn't bother
2307 * to properly document either of these flags. It's unclear how
2308 * important SE_DACL_AUTO_INHERITED actually is, but to be safe we use
2309 * the SE_DACL_AUTO_INHERIT_REQ workaround to set it if needed.
2311 * - The above also applies to the equivalent SACL flags,
2312 * SE_SACL_AUTO_INHERITED and SE_SACL_AUTO_INHERIT_REQ.
2314 * - If the application says that it's setting
2315 * DACL_SECURITY_INFORMATION, then Windows sets SE_DACL_PRESENT in the
2316 * resulting security descriptor, even if the security descriptor the
2317 * application provided did not have a DACL. This seems to be
2318 * unavoidable, since omitting DACL_SECURITY_INFORMATION would cause a
2319 * default DACL to remain. Fortunately, this behavior seems harmless,
2320 * since the resulting DACL will still be "null" --- but it will be
2321 * "the other representation of null".
2323 * - The above also applies to SACL_SECURITY_INFORMATION and
2324 * SE_SACL_PRESENT. Again, it's seemingly unavoidable but "harmless"
2325 * that Windows changes the representation of a "null SACL".
2327 if (likely(desc_size <= STACK_MAX)) {
2328 desc = alloca(desc_size);
2330 desc = MALLOC(desc_size);
2332 return STATUS_NO_MEMORY;
2335 memcpy(desc, _desc, desc_size);
2337 if (likely(desc_size >= 4)) {
2339 if (desc->Control & SE_DACL_AUTO_INHERITED)
2340 desc->Control |= SE_DACL_AUTO_INHERIT_REQ;
2342 if (desc->Control & SE_SACL_AUTO_INHERITED)
2343 desc->Control |= SE_SACL_AUTO_INHERIT_REQ;
2347 * More API insanity. We want to set the entire security descriptor
2348 * as-is. But all available APIs require specifying the specific parts
2349 * of the security descriptor being set. Especially annoying is that
2350 * mandatory integrity labels are part of the SACL, but they aren't set
2351 * with SACL_SECURITY_INFORMATION. Instead, applications must also
2352 * specify LABEL_SECURITY_INFORMATION (Windows Vista, Windows 7) or
2353 * BACKUP_SECURITY_INFORMATION (Windows 8). But at least older versions
2354 * of Windows don't error out if you provide these newer flags...
2356 * Also, if the process isn't running as Administrator, then it probably
2357 * doesn't have SE_RESTORE_PRIVILEGE. In this case, it will always get
2358 * the STATUS_PRIVILEGE_NOT_HELD error by trying to set the SACL, even
2359 * if the security descriptor it provided did not have a SACL. By
2360 * default, in this case we try to recover and set as much of the
2361 * security descriptor as possible --- potentially excluding the DACL, and
2362 * even the owner, as well as the SACL.
2365 info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
2366 DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION |
2367 LABEL_SECURITY_INFORMATION | BACKUP_SECURITY_INFORMATION;
2371 * It's also worth noting that SetFileSecurity() is unusable because it
2372 * doesn't request "backup semantics" when it opens the file internally.
2373 * NtSetSecurityObject() seems to be the best function to use in backup
2374 * applications. (SetSecurityInfo() should also work, but it's harder
2375 * to use and must call NtSetSecurityObject() internally anyway.
2376 * BackupWrite() is theoretically usable as well, but it's inflexible
2377 * and poorly documented.)
2381 status = (*func_NtSetSecurityObject)(h, info, desc);
2382 if (NT_SUCCESS(status))
2383 goto out_maybe_free_desc;
2385 /* Failed to set the requested parts of the security descriptor. If the
2386 * error was permissions-related, try to set fewer parts of the security
2387 * descriptor, unless WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled. */
2388 if ((status == STATUS_PRIVILEGE_NOT_HELD ||
2389 status == STATUS_ACCESS_DENIED) &&
2390 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2392 if (info & SACL_SECURITY_INFORMATION) {
2393 info &= ~(SACL_SECURITY_INFORMATION |
2394 LABEL_SECURITY_INFORMATION |
2395 BACKUP_SECURITY_INFORMATION);
2396 ctx->partial_security_descriptors++;
2399 if (info & DACL_SECURITY_INFORMATION) {
2400 info &= ~DACL_SECURITY_INFORMATION;
2403 if (info & OWNER_SECURITY_INFORMATION) {
2404 info &= ~OWNER_SECURITY_INFORMATION;
2407 /* Nothing left except GROUP, and if we removed it we
2408 * wouldn't have anything at all. */
2411 /* No part of the security descriptor could be set, or
2412 * WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled and the full security
2413 * descriptor could not be set. */
2414 if (!(info & SACL_SECURITY_INFORMATION))
2415 ctx->partial_security_descriptors--;
2416 ctx->no_security_descriptors++;
2418 out_maybe_free_desc:
2419 if (unlikely(desc_size > STACK_MAX))
2424 /* Set metadata on the open file @h from the WIM inode @inode. */
2426 do_apply_metadata_to_file(HANDLE h, const struct wim_inode *inode,
2427 struct win32_apply_ctx *ctx)
2429 FILE_BASIC_INFORMATION info;
2432 /* Set security descriptor if present and not in NO_ACLS mode */
2433 if (inode_has_security_descriptor(inode) &&
2434 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
2436 const struct wim_security_data *sd;
2440 sd = wim_get_current_security_data(ctx->common.wim);
2441 desc = sd->descriptors[inode->i_security_id];
2442 desc_size = sd->sizes[inode->i_security_id];
2444 status = set_security_descriptor(h, desc, desc_size, ctx);
2445 if (!NT_SUCCESS(status) &&
2446 (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2449 L"Can't set security descriptor on \"%ls\"",
2451 return WIMLIB_ERR_SET_SECURITY;
2455 /* Set attributes and timestamps */
2456 info.CreationTime.QuadPart = inode->i_creation_time;
2457 info.LastAccessTime.QuadPart = inode->i_last_access_time;
2458 info.LastWriteTime.QuadPart = inode->i_last_write_time;
2459 info.ChangeTime.QuadPart = 0;
2460 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) {
2461 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
2463 info.FileAttributes = inode->i_attributes & ~SPECIAL_ATTRIBUTES;
2464 if (info.FileAttributes == 0)
2465 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
2468 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
2469 &info, sizeof(info),
2470 FileBasicInformation);
2471 /* On FAT volumes we get STATUS_INVALID_PARAMETER if we try to set
2472 * attributes on the root directory. (Apparently because FAT doesn't
2473 * actually have a place to store those attributes!) */
2474 if (!NT_SUCCESS(status)
2475 && !(status == STATUS_INVALID_PARAMETER &&
2476 dentry_is_root(inode_first_extraction_dentry(inode))))
2478 winnt_error(status, L"Can't set basic metadata on \"%ls\"",
2480 return WIMLIB_ERR_SET_ATTRIBUTES;
2487 apply_metadata_to_file(const struct wim_dentry *dentry,
2488 struct win32_apply_ctx *ctx)
2490 const struct wim_inode *inode = dentry->d_inode;
2496 perms = FILE_WRITE_ATTRIBUTES | WRITE_DAC |
2497 WRITE_OWNER | ACCESS_SYSTEM_SECURITY;
2499 build_extraction_path(dentry, ctx);
2501 /* Open a handle with as many relevant permissions as possible. */
2502 while (!NT_SUCCESS(status = do_create_file(&h, perms, NULL,
2503 0, FILE_OPEN, 0, ctx)))
2505 if (status == STATUS_PRIVILEGE_NOT_HELD ||
2506 status == STATUS_ACCESS_DENIED)
2508 if (perms & ACCESS_SYSTEM_SECURITY) {
2509 perms &= ~ACCESS_SYSTEM_SECURITY;
2512 if (perms & WRITE_DAC) {
2513 perms &= ~WRITE_DAC;
2516 if (perms & WRITE_OWNER) {
2517 perms &= ~WRITE_OWNER;
2521 winnt_error(status, L"Can't open \"%ls\" to set metadata",
2523 return WIMLIB_ERR_OPEN;
2526 ret = do_apply_metadata_to_file(h, inode, ctx);
2534 apply_metadata(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
2536 const struct wim_dentry *dentry;
2539 /* We go in reverse so that metadata is set on all a directory's
2540 * children before the directory itself. This avoids any potential
2541 * problems with attributes, timestamps, or security descriptors. */
2542 list_for_each_entry_reverse(dentry, dentry_list, d_extraction_list_node)
2544 ret = apply_metadata_to_file(dentry, ctx);
2545 ret = check_apply_error(dentry, ctx, ret);
2548 ret = report_file_metadata_applied(&ctx->common);
2555 /* Issue warnings about problems during the extraction for which warnings were
2556 * not already issued (due to the high number of potential warnings if we issued
2557 * them per-file). */
2559 do_warnings(const struct win32_apply_ctx *ctx)
2561 if (ctx->partial_security_descriptors == 0
2562 && ctx->no_security_descriptors == 0
2563 && ctx->num_set_short_name_failures == 0
2565 && ctx->num_remove_short_name_failures == 0
2570 WARNING("Extraction to \"%ls\" complete, but with one or more warnings:",
2571 ctx->common.target);
2572 if (ctx->num_set_short_name_failures) {
2573 WARNING("- Could not set short names on %lu files or directories",
2574 ctx->num_set_short_name_failures);
2577 if (ctx->num_remove_short_name_failures) {
2578 WARNING("- Could not remove short names on %lu files or directories"
2579 " (This is expected on Vista and earlier)",
2580 ctx->num_remove_short_name_failures);
2583 if (ctx->partial_security_descriptors) {
2584 WARNING("- Could only partially set the security descriptor\n"
2585 " on %lu files or directories.",
2586 ctx->partial_security_descriptors);
2588 if (ctx->no_security_descriptors) {
2589 WARNING("- Could not set security descriptor at all\n"
2590 " on %lu files or directories.",
2591 ctx->no_security_descriptors);
2593 if (ctx->partial_security_descriptors || ctx->no_security_descriptors) {
2594 WARNING("To fully restore all security descriptors, run the program\n"
2595 " with Administrator rights.");
2600 count_dentries(const struct list_head *dentry_list)
2602 const struct list_head *cur;
2605 list_for_each(cur, dentry_list)
2611 /* Extract files from a WIM image to a directory on Windows */
2613 win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
2616 struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
2619 ret = prepare_target(dentry_list, ctx);
2623 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2624 ret = start_wimboot_extraction(dentry_list, ctx);
2629 dentry_count = count_dentries(dentry_list);
2631 ret = start_file_structure_phase(&ctx->common, dentry_count);
2635 ret = create_directories(dentry_list, ctx);
2639 ret = create_nondirectories(dentry_list, ctx);
2643 ret = end_file_structure_phase(&ctx->common);
2647 struct read_blob_callbacks cbs = {
2648 .begin_blob = begin_extract_blob,
2649 .consume_chunk = extract_chunk,
2650 .end_blob = end_extract_blob,
2653 ret = extract_blob_list(&ctx->common, &cbs);
2657 ret = start_file_metadata_phase(&ctx->common, dentry_count);
2661 ret = apply_metadata(dentry_list, ctx);
2665 ret = end_file_metadata_phase(&ctx->common);
2669 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2670 ret = end_wimboot_extraction(ctx);
2677 close_target_directory(ctx);
2678 if (ctx->target_ntpath.Buffer)
2679 HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
2680 FREE(ctx->pathbuf.Buffer);
2681 FREE(ctx->print_buffer);
2682 FREE(ctx->wimboot.wims);
2683 if (ctx->wimboot.prepopulate_pats) {
2684 FREE(ctx->wimboot.prepopulate_pats->strings);
2685 FREE(ctx->wimboot.prepopulate_pats);
2687 FREE(ctx->wimboot.mem_prepopulate_pats);
2688 FREE(ctx->data_buffer);
2692 const struct apply_operations win32_apply_ops = {
2694 .get_supported_features = win32_get_supported_features,
2695 .extract = win32_extract,
2696 .will_externally_back = win32_will_externally_back,
2697 .context_size = sizeof(struct win32_apply_ctx),
2700 #endif /* __WIN32__ */