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 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/capture.h" /* for mangle_pat() and match_pattern_list() */
33 #include "wimlib/dentry.h"
34 #include "wimlib/error.h"
35 #include "wimlib/lookup_table.h"
36 #include "wimlib/metadata.h"
37 #include "wimlib/paths.h"
38 #include "wimlib/reparse.h"
39 #include "wimlib/textfile.h"
40 #include "wimlib/xml.h"
41 #include "wimlib/wildcard.h"
42 #include "wimlib/wimboot.h"
44 struct win32_apply_ctx {
46 /* Extract flags, the pointer to the WIMStruct, etc. */
47 struct apply_ctx common;
49 /* WIMBoot information, only filled in if WIMLIB_EXTRACT_FLAG_WIMBOOT
53 struct string_set *prepopulate_pats;
54 void *mem_prepopulate_pats;
55 u8 wim_lookup_table_hash[SHA1_HASH_SIZE];
57 bool tried_to_load_prepopulate_list;
60 /* Open handle to the target directory */
63 /* NT namespace path to the target directory (buffer allocated) */
64 UNICODE_STRING target_ntpath;
66 /* Temporary buffer for building paths (buffer allocated) */
67 UNICODE_STRING pathbuf;
69 /* Object attributes to reuse for opening files in the target directory.
70 * (attr.ObjectName == &pathbuf) and (attr.RootDirectory == h_target).
72 OBJECT_ATTRIBUTES attr;
74 /* Temporary I/O status block for system calls */
77 /* Allocated buffer for creating "printable" paths from our
78 * target-relative NT paths */
79 wchar_t *print_buffer;
81 /* Allocated buffer for reading stream data when it cannot be extracted
85 /* Pointer to the next byte in @data_buffer to fill */
88 /* Size allocated in @data_buffer */
89 size_t data_buffer_size;
91 /* Current offset in the raw encrypted file being written */
92 size_t encrypted_offset;
94 /* Current size of the raw encrypted file being written */
95 size_t encrypted_size;
97 /* Temporary buffer for reparse data */
98 struct reparse_buffer_disk rpbuf;
100 /* Temporary buffer for reparse data of "fixed" absolute symbolic links
102 struct reparse_buffer_disk rpfixbuf;
104 /* Array of open handles to filesystem streams currently being written
106 HANDLE open_handles[MAX_OPEN_STREAMS];
108 /* Number of handles in @open_handles currently open (filled in from the
109 * beginning of the array) */
110 unsigned num_open_handles;
112 /* List of dentries, joined by @tmp_list, that need to have reparse data
113 * extracted as soon as the whole stream has been read into
115 struct list_head reparse_dentries;
117 /* List of dentries, joined by @tmp_list, that need to have raw
118 * encrypted data extracted as soon as the whole stream has been read
119 * into @data_buffer. */
120 struct list_head encrypted_dentries;
122 /* Number of files for which we didn't have permission to set the full
123 * security descriptor. */
124 unsigned long partial_security_descriptors;
126 /* Number of files for which we didn't have permission to set any part
127 * of the security descriptor. */
128 unsigned long no_security_descriptors;
130 /* Number of files for which we couldn't set the short name. */
131 unsigned long num_set_short_name_failures;
133 /* Number of files for which we couldn't remove the short name. */
134 unsigned long num_remove_short_name_failures;
136 /* Have we tried to enable short name support on the target volume yet?
138 bool tried_to_enable_short_names;
141 /* Get the drive letter from a Windows path, or return the null character if the
142 * path is relative. */
144 get_drive_letter(const wchar_t *path)
146 /* Skip \\?\ prefix */
147 if (!wcsncmp(path, L"\\\\?\\", 4))
150 /* Return drive letter if valid */
151 if (((path[0] >= L'a' && path[0] <= L'z') ||
152 (path[0] >= L'A' && path[0] <= L'Z')) && path[1] == L':')
159 get_vol_flags(const wchar_t *target, DWORD *vol_flags_ret,
160 bool *short_names_supported_ret)
162 wchar_t filesystem_name[MAX_PATH + 1];
164 wchar_t *volume = NULL;
167 *short_names_supported_ret = false;
169 drive[0] = get_drive_letter(target);
177 if (!GetVolumeInformation(volume, NULL, 0, NULL, NULL,
178 vol_flags_ret, filesystem_name,
179 ARRAY_LEN(filesystem_name)))
181 DWORD err = GetLastError();
182 set_errno_from_win32_error(err);
183 WARNING_WITH_ERRNO("Failed to get volume information for "
184 "\"%ls\" (err=%"PRIu32")",
189 if (wcsstr(filesystem_name, L"NTFS")) {
190 /* FILE_SUPPORTS_HARD_LINKS is only supported on Windows 7 and
191 * later. Force it on anyway if filesystem is NTFS. */
192 *vol_flags_ret |= FILE_SUPPORTS_HARD_LINKS;
194 /* There's no volume flag for short names, but according to the
195 * MS documentation they are only user-settable on NTFS. */
196 *short_names_supported_ret = true;
200 static const wchar_t *
201 current_path(struct win32_apply_ctx *ctx);
204 build_extraction_path(const struct wim_dentry *dentry,
205 struct win32_apply_ctx *ctx);
208 report_dentry_apply_error(const struct wim_dentry *dentry,
209 struct win32_apply_ctx *ctx, int ret)
211 build_extraction_path(dentry, ctx);
212 return report_apply_error(&ctx->common, ret, current_path(ctx));
216 check_apply_error(const struct wim_dentry *dentry,
217 struct win32_apply_ctx *ctx, int ret)
220 ret = report_dentry_apply_error(dentry, ctx, ret);
225 win32_get_supported_features(const wchar_t *target,
226 struct wim_features *supported_features)
229 bool short_names_supported;
231 /* Query the features of the target volume. */
233 get_vol_flags(target, &vol_flags, &short_names_supported);
235 supported_features->archive_files = 1;
236 supported_features->hidden_files = 1;
237 supported_features->system_files = 1;
239 if (vol_flags & FILE_FILE_COMPRESSION)
240 supported_features->compressed_files = 1;
242 if (vol_flags & FILE_SUPPORTS_ENCRYPTION) {
243 supported_features->encrypted_files = 1;
244 supported_features->encrypted_directories = 1;
247 supported_features->not_context_indexed_files = 1;
249 /* Don't do anything with FILE_SUPPORTS_SPARSE_FILES. */
251 if (vol_flags & FILE_NAMED_STREAMS)
252 supported_features->named_data_streams = 1;
254 if (vol_flags & FILE_SUPPORTS_HARD_LINKS)
255 supported_features->hard_links = 1;
257 if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS)
258 supported_features->reparse_points = 1;
260 if (vol_flags & FILE_PERSISTENT_ACLS)
261 supported_features->security_descriptors = 1;
263 if (short_names_supported)
264 supported_features->short_names = 1;
266 supported_features->timestamps = 1;
268 /* Note: Windows does not support case sensitive filenames! At least
269 * not without changing the registry and rebooting... */
274 /* Load the patterns from [PrepopulateList] of WimBootCompress.ini in the WIM
275 * image being extracted. */
277 load_prepopulate_pats(struct win32_apply_ctx *ctx)
279 const wchar_t *path = L"\\Windows\\System32\\WimBootCompress.ini";
280 struct wim_dentry *dentry;
281 struct wim_lookup_table_entry *lte;
284 struct string_set *s;
286 struct text_file_section sec;
288 ctx->wimboot.tried_to_load_prepopulate_list = true;
290 dentry = get_dentry(ctx->common.wim, path, WIMLIB_CASE_INSENSITIVE);
292 (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
293 FILE_ATTRIBUTE_REPARSE_POINT |
294 FILE_ATTRIBUTE_ENCRYPTED)) ||
295 !(lte = inode_unnamed_lte(dentry->d_inode, ctx->common.wim->lookup_table)))
297 WARNING("%ls does not exist in WIM image!", path);
298 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
301 ret = read_full_stream_into_alloc_buf(lte, &buf);
305 s = CALLOC(1, sizeof(struct string_set));
308 return WIMLIB_ERR_NOMEM;
311 sec.name = T("PrepopulateList");
314 ret = do_load_text_file(path, buf, lte->size, &mem, &sec, 1,
315 LOAD_TEXT_FILE_REMOVE_QUOTES |
316 LOAD_TEXT_FILE_NO_WARNINGS,
318 BUILD_BUG_ON(OS_PREFERRED_PATH_SEPARATOR != WIM_PATH_SEPARATOR);
324 ctx->wimboot.prepopulate_pats = s;
325 ctx->wimboot.mem_prepopulate_pats = mem;
329 /* Returns %true if the specified absolute path to a file in the WIM image
330 * matches a pattern in [PrepopulateList] of WimBootCompress.ini. Otherwise
333 in_prepopulate_list(const wchar_t *path, size_t path_nchars,
334 const struct win32_apply_ctx *ctx)
336 const struct string_set *pats = ctx->wimboot.prepopulate_pats;
338 if (!pats || !pats->num_strings)
341 return match_pattern_list(path, path_nchars, pats);
344 /* Returns %true if the specified absolute path to a file in the WIM image can
345 * be subject to external backing when extracted. Otherwise returns %false. */
347 can_externally_back_path(const wchar_t *path, size_t path_nchars,
348 const struct win32_apply_ctx *ctx)
350 if (in_prepopulate_list(path, path_nchars, ctx))
353 /* Since we attempt to modify the SYSTEM registry after it's extracted
354 * (see end_wimboot_extraction()), it can't be extracted as externally
355 * backed. This extends to associated files such as SYSTEM.LOG that
356 * also must be writable in order to write to the registry. Normally,
357 * SYSTEM is in [PrepopulateList], and the SYSTEM.* files match patterns
358 * in [ExclusionList] and therefore are not captured in the WIM at all.
359 * However, a WIM that wasn't specifically captured in "WIMBoot mode"
360 * may contain SYSTEM.* files. So to make things "just work", hard-code
362 if (match_path(path, path_nchars, L"\\Windows\\System32\\config\\SYSTEM*",
363 OS_PREFERRED_PATH_SEPARATOR, false))
369 #define WIM_BACKING_NOT_ENABLED -1
370 #define WIM_BACKING_NOT_POSSIBLE -2
371 #define WIM_BACKING_EXCLUDED -3
374 will_externally_back_inode(struct wim_inode *inode, struct win32_apply_ctx *ctx,
375 const struct wim_dentry **excluded_dentry_ret)
377 struct list_head *next;
378 struct wim_dentry *dentry;
379 struct wim_lookup_table_entry *stream;
382 if (inode->i_can_externally_back)
385 /* This may do redundant checks because the cached value
386 * i_can_externally_back is 2-state (as opposed to 3-state:
387 * unknown/no/yes). But most files can be externally backed, so this
390 if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
391 FILE_ATTRIBUTE_REPARSE_POINT |
392 FILE_ATTRIBUTE_ENCRYPTED))
393 return WIM_BACKING_NOT_POSSIBLE;
395 stream = inode_unnamed_lte_resolved(inode);
398 stream->resource_location != RESOURCE_IN_WIM ||
399 stream->rspec->wim != ctx->common.wim ||
400 stream->size != stream->rspec->uncompressed_size)
401 return WIM_BACKING_NOT_POSSIBLE;
404 * We need to check the patterns in [PrepopulateList] against every name
405 * of the inode, in case any of them match.
407 next = inode->i_extraction_aliases.next;
409 dentry = list_entry(next, struct wim_dentry,
410 d_extraction_alias_node);
412 ret = calculate_dentry_full_path(dentry);
416 if (!can_externally_back_path(dentry->_full_path,
417 wcslen(dentry->_full_path), ctx))
419 if (excluded_dentry_ret)
420 *excluded_dentry_ret = dentry;
421 return WIM_BACKING_EXCLUDED;
424 } while (next != &inode->i_extraction_aliases);
426 inode->i_can_externally_back = 1;
431 * Determines if the unnamed data stream of a file will be created as an
432 * external backing, as opposed to a standard extraction.
435 win32_will_externally_back(struct wim_dentry *dentry, struct apply_ctx *_ctx)
437 struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
439 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
440 return WIM_BACKING_NOT_ENABLED;
442 if (!ctx->wimboot.tried_to_load_prepopulate_list)
443 if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
444 return WIMLIB_ERR_NOMEM;
446 return will_externally_back_inode(dentry->d_inode, ctx, NULL);
450 set_external_backing(HANDLE h, struct wim_inode *inode, struct win32_apply_ctx *ctx)
453 const struct wim_dentry *excluded_dentry;
455 ret = will_externally_back_inode(inode, ctx, &excluded_dentry);
456 if (ret > 0) /* Error. */
459 if (ret < 0 && ret != WIM_BACKING_EXCLUDED)
460 return 0; /* Not externally backing, other than due to exclusion. */
462 if (unlikely(ret == WIM_BACKING_EXCLUDED)) {
463 /* Not externally backing due to exclusion. */
464 union wimlib_progress_info info;
466 build_extraction_path(excluded_dentry, ctx);
468 info.wimboot_exclude.path_in_wim = excluded_dentry->_full_path;
469 info.wimboot_exclude.extraction_path = current_path(ctx);
471 return call_progress(ctx->common.progfunc,
472 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE,
473 &info, ctx->common.progctx);
475 /* Externally backing. */
476 if (unlikely(!wimboot_set_pointer(h,
477 inode_unnamed_lte_resolved(inode),
478 ctx->wimboot.data_source_id,
479 ctx->wimboot.wim_lookup_table_hash,
480 ctx->wimboot.wof_running)))
482 const DWORD err = GetLastError();
484 build_extraction_path(inode_first_extraction_dentry(inode), ctx);
485 set_errno_from_win32_error(err);
486 ERROR_WITH_ERRNO("\"%ls\": Couldn't set WIMBoot "
487 "pointer data (err=%"PRIu32")",
488 current_path(ctx), (u32)err);
489 return WIMLIB_ERR_WIMBOOT;
495 /* Calculates the SHA-1 message digest of the WIM's lookup table. */
497 hash_lookup_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
499 return wim_reshdr_to_hash(&wim->hdr.lookup_table_reshdr, wim, hash);
502 /* Prepare for doing a "WIMBoot" extraction by loading patterns from
503 * [PrepopulateList] of WimBootCompress.ini and allocating a WOF data source ID
504 * on the target volume. */
506 start_wimboot_extraction(struct win32_apply_ctx *ctx)
509 WIMStruct *wim = ctx->common.wim;
511 if (!ctx->wimboot.tried_to_load_prepopulate_list)
512 if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
513 return WIMLIB_ERR_NOMEM;
515 if (!wim_info_get_wimboot(wim->wim_info, wim->current_image))
516 WARNING("Image is not marked as WIMBoot compatible!");
518 ret = hash_lookup_table(ctx->common.wim,
519 ctx->wimboot.wim_lookup_table_hash);
523 return wimboot_alloc_data_source_id(wim->filename,
527 &ctx->wimboot.data_source_id,
528 &ctx->wimboot.wof_running);
532 build_win32_extraction_path(const struct wim_dentry *dentry,
533 struct win32_apply_ctx *ctx);
535 /* Sets WimBoot=1 in the extracted SYSTEM registry hive.
537 * WIMGAPI does this, and it's possible that it's important.
538 * But I don't know exactly what this value means to Windows. */
540 end_wimboot_extraction(struct win32_apply_ctx *ctx)
542 struct wim_dentry *dentry;
543 wchar_t subkeyname[32];
549 dentry = get_dentry(ctx->common.wim, L"\\Windows\\System32\\config\\SYSTEM",
550 WIMLIB_CASE_INSENSITIVE);
552 if (!dentry || !will_extract_dentry(dentry))
555 if (!will_extract_dentry(wim_get_current_root_dentry(ctx->common.wim)))
558 /* Not bothering to use the native routines (e.g. NtLoadKey()) for this.
559 * If this doesn't work, you probably also have many other problems. */
561 build_win32_extraction_path(dentry, ctx);
563 randomize_char_array_with_alnum(subkeyname, 20);
564 subkeyname[20] = L'\0';
566 res = RegLoadKey(HKEY_LOCAL_MACHINE, subkeyname, ctx->pathbuf.Buffer);
570 wcscpy(&subkeyname[20], L"\\Setup");
572 res = RegCreateKeyEx(HKEY_LOCAL_MACHINE, subkeyname, 0, NULL,
573 REG_OPTION_BACKUP_RESTORE, 0, NULL, &key, NULL);
579 res = RegSetValueEx(key, L"WimBoot", 0, REG_DWORD,
580 (const BYTE *)&value, sizeof(DWORD));
584 res = RegFlushKey(key);
587 res2 = RegCloseKey(key);
591 subkeyname[20] = L'\0';
592 RegUnLoadKey(HKEY_LOCAL_MACHINE, subkeyname);
596 set_errno_from_win32_error(res);
597 WARNING_WITH_ERRNO("Failed to set \\Setup: dword \"WimBoot\"=1 value "
598 "in registry hive \"%ls\" (err=%"PRIu32")",
599 ctx->pathbuf.Buffer, (u32)res);
605 /* Returns the number of wide characters needed to represent the path to the
606 * specified @dentry, relative to the target directory, when extracted.
608 * Does not include null terminator (not needed for NtCreateFile). */
610 dentry_extraction_path_length(const struct wim_dentry *dentry)
613 const struct wim_dentry *d;
617 len += d->d_extraction_name_nchars + 1;
619 } while (!dentry_is_root(d) && will_extract_dentry(d));
621 return --len; /* No leading slash */
624 /* Returns the length of the longest string that might need to be appended to
625 * the path to an alias of an inode to open or create a named data stream.
627 * If the inode has no named data streams, this will be 0. Otherwise, this will
628 * be 1 plus the length of the longest-named data stream, since the data stream
629 * name must be separated from the path by the ':' character. */
631 inode_longest_named_data_stream_spec(const struct wim_inode *inode)
634 for (u16 i = 0; i < inode->i_num_ads; i++) {
635 size_t len = inode->i_ads_entries[i].stream_name_nbytes;
640 max = 1 + (max / sizeof(wchar_t));
644 /* Find the length, in wide characters, of the longest path needed for
645 * extraction of any file in @dentry_list relative to the target directory.
647 * Accounts for named data streams, but does not include null terminator (not
648 * needed for NtCreateFile). */
650 compute_path_max(struct list_head *dentry_list)
653 const struct wim_dentry *dentry;
655 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
658 len = dentry_extraction_path_length(dentry);
660 /* Account for named data streams */
661 len += inode_longest_named_data_stream_spec(dentry->d_inode);
670 /* Build the path at which to extract the @dentry, relative to the target
673 * The path is saved in ctx->pathbuf. */
675 build_extraction_path(const struct wim_dentry *dentry,
676 struct win32_apply_ctx *ctx)
680 const struct wim_dentry *d;
682 len = dentry_extraction_path_length(dentry);
684 ctx->pathbuf.Length = len * sizeof(wchar_t);
685 p = ctx->pathbuf.Buffer + len;
687 !dentry_is_root(d->d_parent) && will_extract_dentry(d->d_parent);
690 p -= d->d_extraction_name_nchars;
691 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
694 /* No leading slash */
695 p -= d->d_extraction_name_nchars;
696 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
699 /* Build the path at which to extract the @dentry, relative to the target
700 * directory, adding the suffix for a named data stream.
702 * The path is saved in ctx->pathbuf. */
704 build_extraction_path_with_ads(const struct wim_dentry *dentry,
705 struct win32_apply_ctx *ctx,
706 const wchar_t *stream_name,
707 size_t stream_name_nchars)
711 build_extraction_path(dentry, ctx);
713 /* Add :NAME for named data stream */
714 p = ctx->pathbuf.Buffer + (ctx->pathbuf.Length / sizeof(wchar_t));
716 wmemcpy(p, stream_name, stream_name_nchars);
717 ctx->pathbuf.Length += (1 + stream_name_nchars) * sizeof(wchar_t);
720 /* Build the Win32 namespace path to the specified @dentry when extracted.
722 * The path is saved in ctx->pathbuf and will be null terminated.
724 * XXX: We could get rid of this if it wasn't needed for the file encryption
725 * APIs, and the registry manipulation in WIMBoot mode. */
727 build_win32_extraction_path(const struct wim_dentry *dentry,
728 struct win32_apply_ctx *ctx)
730 build_extraction_path(dentry, ctx);
732 /* Prepend target_ntpath to our relative path, then change \??\ into \\?\ */
734 memmove(ctx->pathbuf.Buffer +
735 (ctx->target_ntpath.Length / sizeof(wchar_t)) + 1,
736 ctx->pathbuf.Buffer, ctx->pathbuf.Length);
737 memcpy(ctx->pathbuf.Buffer, ctx->target_ntpath.Buffer,
738 ctx->target_ntpath.Length);
739 ctx->pathbuf.Buffer[ctx->target_ntpath.Length / sizeof(wchar_t)] = L'\\';
740 ctx->pathbuf.Length += ctx->target_ntpath.Length + sizeof(wchar_t);
741 ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)] = L'\0';
743 wimlib_assert(ctx->pathbuf.Length >= 4 * sizeof(wchar_t) &&
744 !wmemcmp(ctx->pathbuf.Buffer, L"\\??\\", 4));
746 ctx->pathbuf.Buffer[1] = L'\\';
750 /* Returns a "printable" representation of the last relative NT path that was
751 * constructed with build_extraction_path() or build_extraction_path_with_ads().
753 * This will be overwritten by the next call to this function. */
754 static const wchar_t *
755 current_path(struct win32_apply_ctx *ctx)
757 wchar_t *p = ctx->print_buffer;
759 p = wmempcpy(p, ctx->common.target, ctx->common.target_nchars);
761 p = wmempcpy(p, ctx->pathbuf.Buffer, ctx->pathbuf.Length / sizeof(wchar_t));
763 return ctx->print_buffer;
766 /* Open handle to the target directory if it is not already open. If the target
767 * directory does not exist, this creates it. */
769 open_target_directory(struct win32_apply_ctx *ctx)
776 ctx->attr.Length = sizeof(ctx->attr);
777 ctx->attr.RootDirectory = NULL;
778 ctx->attr.ObjectName = &ctx->target_ntpath;
779 status = (*func_NtCreateFile)(&ctx->h_target,
785 FILE_SHARE_VALID_FLAGS,
787 FILE_DIRECTORY_FILE |
788 FILE_OPEN_REPARSE_POINT |
789 FILE_OPEN_FOR_BACKUP_INTENT,
792 if (!NT_SUCCESS(status)) {
793 set_errno_from_nt_status(status);
794 ERROR_WITH_ERRNO("Can't open or create directory \"%ls\" "
795 "(status=0x%08"PRIx32")",
796 ctx->common.target, (u32)status);
797 return WIMLIB_ERR_OPENDIR;
799 ctx->attr.RootDirectory = ctx->h_target;
800 ctx->attr.ObjectName = &ctx->pathbuf;
805 close_target_directory(struct win32_apply_ctx *ctx)
808 (*func_NtClose)(ctx->h_target);
809 ctx->h_target = NULL;
810 ctx->attr.RootDirectory = NULL;
815 * Ensures the target directory exists and opens a handle to it, in preparation
816 * of using paths relative to it.
819 prepare_target(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
824 ret = win32_path_to_nt_path(ctx->common.target, &ctx->target_ntpath);
828 ret = open_target_directory(ctx);
832 path_max = compute_path_max(dentry_list);
833 /* Add some extra for building Win32 paths for the file encryption APIs,
834 * and ensure we have at least enough to potentially use a 8.3 name for
835 * the last component. */
836 path_max += max(2 + (ctx->target_ntpath.Length / sizeof(wchar_t)),
839 ctx->pathbuf.MaximumLength = path_max * sizeof(wchar_t);
840 ctx->pathbuf.Buffer = MALLOC(ctx->pathbuf.MaximumLength);
841 if (!ctx->pathbuf.Buffer)
842 return WIMLIB_ERR_NOMEM;
844 ctx->print_buffer = MALLOC((ctx->common.target_nchars + 1 + path_max + 1) *
846 if (!ctx->print_buffer)
847 return WIMLIB_ERR_NOMEM;
852 /* When creating an inode that will have a short (DOS) name, we create it using
853 * the long name associated with the short name. This ensures that the short
854 * name gets associated with the correct long name. */
855 static struct wim_dentry *
856 first_extraction_alias(const struct wim_inode *inode)
858 struct list_head *next = inode->i_extraction_aliases.next;
859 struct wim_dentry *dentry;
862 dentry = list_entry(next, struct wim_dentry,
863 d_extraction_alias_node);
864 if (dentry_has_short_name(dentry))
867 } while (next != &inode->i_extraction_aliases);
872 * Set or clear FILE_ATTRIBUTE_COMPRESSED if the inherited value is different
873 * from the desired value.
875 * Note that you can NOT override the inherited value of
876 * FILE_ATTRIBUTE_COMPRESSED directly with NtCreateFile().
879 adjust_compression_attribute(HANDLE h, const struct wim_dentry *dentry,
880 struct win32_apply_ctx *ctx)
882 const bool compressed = (dentry->d_inode->i_attributes &
883 FILE_ATTRIBUTE_COMPRESSED);
885 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
888 if (!ctx->common.supported_features.compressed_files)
891 FILE_BASIC_INFORMATION info;
893 USHORT compression_state;
895 /* Get current attributes */
896 status = (*func_NtQueryInformationFile)(h, &ctx->iosb,
898 FileBasicInformation);
899 if (NT_SUCCESS(status) &&
900 compressed == !!(info.FileAttributes & FILE_ATTRIBUTE_COMPRESSED))
902 /* Nothing needs to be done. */
906 /* Set the new compression state */
909 compression_state = COMPRESSION_FORMAT_DEFAULT;
911 compression_state = COMPRESSION_FORMAT_NONE;
913 status = (*func_NtFsControlFile)(h,
918 FSCTL_SET_COMPRESSION,
923 if (NT_SUCCESS(status))
926 set_errno_from_nt_status(status);
927 ERROR_WITH_ERRNO("Can't %s compression attribute on \"%ls\" "
928 "(status=0x%08"PRIx32")",
929 (compressed ? "set" : "clear"),
930 current_path(ctx), status);
931 return WIMLIB_ERR_SET_ATTRIBUTES;
935 * Clear FILE_ATTRIBUTE_ENCRYPTED if the file or directory is not supposed to be
938 * You can provide FILE_ATTRIBUTE_ENCRYPTED to NtCreateFile() to set it on the
939 * created file. However, the file or directory will otherwise default to the
940 * encryption state of the parent directory. This function works around this
941 * limitation by using DecryptFile() to remove FILE_ATTRIBUTE_ENCRYPTED on files
942 * (and directories) that are not supposed to have it set.
944 * Regardless of whether it succeeds or fails, this function may close the
945 * handle to the file. If it does, it sets it to NULL.
948 maybe_clear_encryption_attribute(HANDLE *h_ptr, const struct wim_dentry *dentry,
949 struct win32_apply_ctx *ctx)
951 if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
954 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
957 if (!ctx->common.supported_features.encrypted_files)
960 FILE_BASIC_INFORMATION info;
964 /* Get current attributes */
965 status = (*func_NtQueryInformationFile)(*h_ptr, &ctx->iosb,
967 FileBasicInformation);
968 if (NT_SUCCESS(status) &&
969 !(info.FileAttributes & FILE_ATTRIBUTE_ENCRYPTED))
971 /* Nothing needs to be done. */
975 /* Set the new encryption state */
977 /* Due to Windows' crappy file encryption APIs, we need to close the
978 * handle to the file so we don't get ERROR_SHARING_VIOLATION. We also
979 * hack together a Win32 path, although we will use the \\?\ prefix so
980 * it will actually be a NT path in disguise... */
981 (*func_NtClose)(*h_ptr);
984 build_win32_extraction_path(dentry, ctx);
986 bret = DecryptFile(ctx->pathbuf.Buffer, 0);
988 /* Restore the NT namespace path */
989 build_extraction_path(dentry, ctx);
992 DWORD err = GetLastError();
993 set_errno_from_win32_error(err);
994 ERROR_WITH_ERRNO("Can't decrypt file \"%ls\" (err=%"PRIu32")",
995 current_path(ctx), (u32)err);
996 return WIMLIB_ERR_SET_ATTRIBUTES;
1001 /* Try to enable short name support on the target volume. If successful, return
1002 * true. If unsuccessful, issue a warning and return false. */
1004 try_to_enable_short_names(const wchar_t *volume)
1007 FILE_FS_PERSISTENT_VOLUME_INFORMATION info;
1009 DWORD bytesReturned;
1011 h = CreateFile(volume, GENERIC_WRITE,
1012 FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
1013 FILE_FLAG_BACKUP_SEMANTICS, NULL);
1014 if (h == INVALID_HANDLE_VALUE)
1017 info.VolumeFlags = 0;
1018 info.FlagMask = PERSISTENT_VOLUME_STATE_SHORT_NAME_CREATION_DISABLED;
1022 bret = DeviceIoControl(h, FSCTL_SET_PERSISTENT_VOLUME_STATE,
1023 &info, sizeof(info), NULL, 0,
1024 &bytesReturned, NULL);
1033 WARNING("Failed to enable short name support on %ls "
1034 "(err=%"PRIu32")", volume + 4, (u32)GetLastError());
1039 remove_conflicting_short_name(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
1045 size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1046 (13 * sizeof(wchar_t));
1047 u8 buf[bufsize] _aligned_attribute(8);
1048 bool retried = false;
1049 FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1051 memset(buf, 0, bufsize);
1053 /* Build the path with the short name. */
1054 name = &ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)];
1055 while (name != ctx->pathbuf.Buffer && *(name - 1) != L'\\')
1057 end = mempcpy(name, dentry->short_name, dentry->short_name_nbytes);
1058 ctx->pathbuf.Length = ((u8 *)end - (u8 *)ctx->pathbuf.Buffer);
1060 /* Open the conflicting file (by short name). */
1061 status = (*func_NtOpenFile)(&h, GENERIC_WRITE | DELETE,
1062 &ctx->attr, &ctx->iosb,
1063 FILE_SHARE_VALID_FLAGS,
1064 FILE_OPEN_REPARSE_POINT | FILE_OPEN_FOR_BACKUP_INTENT);
1065 if (!NT_SUCCESS(status)) {
1066 WARNING("Can't open \"%ls\" (status=0x%08"PRIx32")",
1067 current_path(ctx), (u32)status);
1072 WARNING("Overriding conflicting short name; path=\"%ls\"",
1076 /* Try to remove the short name on the conflicting file. */
1079 status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1080 FileShortNameInformation);
1082 if (status == STATUS_INVALID_PARAMETER && !retried) {
1084 /* Microsoft forgot to make it possible to remove short names
1085 * until Windows 7. Oops. Use a random short name instead. */
1087 info->FileNameLength = 12 * sizeof(wchar_t);
1088 for (int i = 0; i < 8; i++)
1089 info->FileName[i] = 'A' + (rand() % 26);
1090 info->FileName[8] = L'.';
1091 info->FileName[9] = L'W';
1092 info->FileName[10] = L'L';
1093 info->FileName[11] = L'B';
1094 info->FileName[12] = L'\0';
1100 build_extraction_path(dentry, ctx);
1104 /* Set the short name on the open file @h which has been created at the location
1105 * indicated by @dentry.
1107 * Note that this may add, change, or remove the short name.
1109 * @h must be opened with DELETE access.
1111 * Returns 0 or WIMLIB_ERR_SET_SHORT_NAME. The latter only happens in
1112 * STRICT_SHORT_NAMES mode.
1115 set_short_name(HANDLE h, const struct wim_dentry *dentry,
1116 struct win32_apply_ctx *ctx)
1119 if (!ctx->common.supported_features.short_names)
1123 * Note: The size of the FILE_NAME_INFORMATION buffer must be such that
1124 * FileName contains at least 2 wide characters (4 bytes). Otherwise,
1125 * NtSetInformationFile() will return STATUS_INFO_LENGTH_MISMATCH. This
1126 * is despite the fact that FileNameLength can validly be 0 or 2 bytes,
1127 * with the former case being removing the existing short name if
1128 * present, rather than setting one.
1130 * The null terminator is seemingly optional, but to be safe we include
1131 * space for it and zero all unused space.
1134 size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1135 max(dentry->short_name_nbytes, sizeof(wchar_t)) +
1137 u8 buf[bufsize] _aligned_attribute(8);
1138 FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1140 bool tried_to_remove_existing = false;
1142 memset(buf, 0, bufsize);
1144 info->FileNameLength = dentry->short_name_nbytes;
1145 memcpy(info->FileName, dentry->short_name, dentry->short_name_nbytes);
1148 status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1149 FileShortNameInformation);
1150 if (NT_SUCCESS(status))
1153 if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
1154 if (dentry->short_name_nbytes == 0)
1156 if (!ctx->tried_to_enable_short_names) {
1160 ctx->tried_to_enable_short_names = true;
1162 ret = win32_get_drive_path(ctx->common.target,
1166 if (try_to_enable_short_names(volume))
1172 * Short names can conflict in several cases:
1174 * - a file being extracted has a short name conflicting with an
1177 * - a file being extracted has a short name conflicting with another
1178 * file being extracted (possible, but shouldn't happen)
1180 * - a file being extracted has a short name that conflicts with the
1181 * automatically generated short name of a file we previously
1182 * extracted, but failed to set the short name for. Sounds unlikely,
1183 * but this actually does happen fairly often on versions of Windows
1184 * prior to Windows 7 because they do not support removing short names
1187 if (unlikely(status == STATUS_OBJECT_NAME_COLLISION) &&
1188 dentry->short_name_nbytes && !tried_to_remove_existing)
1190 tried_to_remove_existing = true;
1191 status = remove_conflicting_short_name(dentry, ctx);
1192 if (NT_SUCCESS(status))
1196 /* By default, failure to set short names is not an error (since short
1197 * names aren't too important anymore...). */
1198 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
1199 if (dentry->short_name_nbytes)
1200 ctx->num_set_short_name_failures++;
1202 ctx->num_remove_short_name_failures++;
1206 if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
1207 ERROR("Can't set short name when short "
1208 "names are not enabled on the volume!");
1210 ERROR("Can't set short name on \"%ls\" (status=0x%08"PRIx32")",
1211 current_path(ctx), (u32)status);
1213 return WIMLIB_ERR_SET_SHORT_NAME;
1217 * A wrapper around NtCreateFile() to make it slightly more usable...
1218 * This uses the path currently constructed in ctx->pathbuf.
1220 * Also, we always specify FILE_OPEN_FOR_BACKUP_INTENT and
1221 * FILE_OPEN_REPARSE_POINT.
1224 do_create_file(PHANDLE FileHandle,
1225 ACCESS_MASK DesiredAccess,
1226 PLARGE_INTEGER AllocationSize,
1227 ULONG FileAttributes,
1228 ULONG CreateDisposition,
1229 ULONG CreateOptions,
1230 struct win32_apply_ctx *ctx)
1232 return (*func_NtCreateFile)(FileHandle,
1238 FILE_SHARE_VALID_FLAGS,
1241 FILE_OPEN_FOR_BACKUP_INTENT |
1242 FILE_OPEN_REPARSE_POINT,
1247 /* Like do_create_file(), but builds the extraction path of the @dentry first.
1250 create_file(PHANDLE FileHandle,
1251 ACCESS_MASK DesiredAccess,
1252 PLARGE_INTEGER AllocationSize,
1253 ULONG FileAttributes,
1254 ULONG CreateDisposition,
1255 ULONG CreateOptions,
1256 const struct wim_dentry *dentry,
1257 struct win32_apply_ctx *ctx)
1259 build_extraction_path(dentry, ctx);
1260 return do_create_file(FileHandle,
1269 /* Create empty named data streams.
1271 * Since these won't have 'struct wim_lookup_table_entry's, they won't show up
1272 * in the call to extract_stream_list(). Hence the need for the special case.
1275 create_any_empty_ads(const struct wim_dentry *dentry,
1276 struct win32_apply_ctx *ctx)
1278 const struct wim_inode *inode = dentry->d_inode;
1279 LARGE_INTEGER allocation_size;
1280 bool path_modified = false;
1283 if (!ctx->common.supported_features.named_data_streams)
1286 for (u16 i = 0; i < inode->i_num_ads; i++) {
1287 const struct wim_ads_entry *entry;
1293 entry = &inode->i_ads_entries[i];
1296 if (!entry->stream_name_nbytes)
1303 /* Probably setting the allocation size to 0 has no effect, but
1304 * we might as well try. */
1305 allocation_size.QuadPart = 0;
1307 build_extraction_path_with_ads(dentry, ctx,
1309 entry->stream_name_nbytes /
1311 path_modified = true;
1314 disposition = FILE_SUPERSEDE;
1316 status = do_create_file(&h, FILE_WRITE_DATA, &allocation_size,
1317 0, disposition, 0, ctx);
1318 if (unlikely(!NT_SUCCESS(status))) {
1319 if (status == STATUS_OBJECT_NAME_NOT_FOUND && !retried) {
1320 /* Workaround for defect in the Windows PE
1321 * in-memory filesystem implementation:
1322 * FILE_SUPERSEDE does not create the file, as
1323 * expected and documented, when the named file
1324 * does not exist. */
1326 disposition = FILE_CREATE;
1329 set_errno_from_nt_status(status);
1330 ERROR_WITH_ERRNO("Can't create \"%ls\" "
1331 "(status=0x%08"PRIx32")",
1332 current_path(ctx), (u32)status);
1333 ret = WIMLIB_ERR_OPEN;
1338 /* Restore the path to the dentry itself */
1340 build_extraction_path(dentry, ctx);
1345 * Creates the directory named by @dentry, or uses an existing directory at that
1346 * location. If necessary, sets the short name and/or fixes compression and
1347 * encryption attributes.
1349 * Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
1352 create_directory(const struct wim_dentry *dentry,
1353 struct win32_apply_ctx *ctx)
1359 /* DELETE is needed for set_short_name().
1360 * GENERIC_READ and GENERIC_WRITE are needed for
1361 * adjust_compression_attribute(). */
1362 status = create_file(&h, GENERIC_READ | GENERIC_WRITE | DELETE, NULL,
1363 0, FILE_OPEN_IF, FILE_DIRECTORY_FILE,
1365 if (!NT_SUCCESS(status)) {
1366 set_errno_from_nt_status(status);
1367 ERROR_WITH_ERRNO("Can't create directory \"%ls\" "
1368 "(status=0x%08"PRIx32")",
1369 current_path(ctx), (u32)status);
1370 return WIMLIB_ERR_MKDIR;
1373 ret = set_short_name(h, dentry, ctx);
1376 ret = adjust_compression_attribute(h, dentry, ctx);
1379 ret = maybe_clear_encryption_attribute(&h, dentry, ctx);
1380 /* May close the handle!!! */
1388 * Create all the directories being extracted, other than the target directory
1391 * Note: we don't honor directory hard links. However, we don't allow them to
1392 * exist in WIM images anyway (see inode_fixup.c).
1395 create_directories(struct list_head *dentry_list,
1396 struct win32_apply_ctx *ctx)
1398 const struct wim_dentry *dentry;
1401 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1403 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
1406 /* Note: Here we include files with
1407 * FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
1408 * wait until later to actually set the reparse data. */
1410 /* If the root dentry is being extracted, it was already done so
1411 * in prepare_target(). */
1412 if (!dentry_is_root(dentry)) {
1413 ret = create_directory(dentry, ctx);
1414 ret = check_apply_error(dentry, ctx, ret);
1418 ret = create_any_empty_ads(dentry, ctx);
1419 ret = check_apply_error(dentry, ctx, ret);
1424 ret = report_file_created(&ctx->common);
1432 * Creates the nondirectory file named by @dentry.
1434 * On success, returns an open handle to the file in @h_ret, with GENERIC_READ,
1435 * GENERIC_WRITE, and DELETE access. Also, the path to the file will be saved
1436 * in ctx->pathbuf. On failure, returns WIMLIB_ERR_OPEN.
1439 create_nondirectory_inode(HANDLE *h_ret, const struct wim_dentry *dentry,
1440 struct win32_apply_ctx *ctx)
1442 const struct wim_inode *inode;
1445 bool retried = false;
1448 inode = dentry->d_inode;
1450 /* If the file already exists and has FILE_ATTRIBUTE_SYSTEM and/or
1451 * FILE_ATTRIBUTE_HIDDEN, these must be specified in order to supersede
1454 * Normally the user shouldn't be trying to overwrite such files anyway,
1455 * but we at least provide FILE_ATTRIBUTE_SYSTEM and
1456 * FILE_ATTRIBUTE_HIDDEN if the WIM inode has those attributes so that
1457 * we catch the case where the user extracts the same files to the same
1458 * location more than one time.
1460 * Also specify FILE_ATTRIBUTE_ENCRYPTED if the file needs to be
1463 * In NO_ATTRIBUTES mode just don't specify any attributes at all.
1465 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) {
1468 attrib = (inode->i_attributes & (FILE_ATTRIBUTE_SYSTEM |
1469 FILE_ATTRIBUTE_HIDDEN |
1470 FILE_ATTRIBUTE_ENCRYPTED));
1472 build_extraction_path(dentry, ctx);
1473 disposition = FILE_SUPERSEDE;
1475 status = do_create_file(h_ret, GENERIC_READ | GENERIC_WRITE | DELETE,
1476 NULL, attrib, disposition,
1477 FILE_NON_DIRECTORY_FILE, ctx);
1478 if (likely(NT_SUCCESS(status))) {
1481 ret = adjust_compression_attribute(*h_ret, dentry, ctx);
1483 (*func_NtClose)(*h_ret);
1487 ret = maybe_clear_encryption_attribute(h_ret, dentry, ctx);
1488 /* May close the handle!!! */
1492 (*func_NtClose)(*h_ret);
1497 /* Re-open the handle so that we can return it on
1499 status = do_create_file(h_ret,
1501 GENERIC_WRITE | DELETE,
1503 FILE_NON_DIRECTORY_FILE, ctx);
1504 if (!NT_SUCCESS(status))
1508 ret = create_any_empty_ads(dentry, ctx);
1510 (*func_NtClose)(*h_ret);
1516 if (status == STATUS_OBJECT_NAME_NOT_FOUND && !retried) {
1517 /* Workaround for defect in the Windows PE in-memory filesystem
1518 * implementation: FILE_SUPERSEDE does not create the file, as
1519 * expected and documented, when the named file does not exist.
1522 disposition = FILE_CREATE;
1526 if (status == STATUS_ACCESS_DENIED && !retried) {
1527 /* We also can't supersede an existing file that has
1528 * FILE_ATTRIBUTE_READONLY set; doing so causes NtCreateFile()
1529 * to return STATUS_ACCESS_DENIED . The only workaround seems
1530 * to be to explicitly remove FILE_ATTRIBUTE_READONLY on the
1531 * existing file, then try again. */
1533 FILE_BASIC_INFORMATION info;
1536 status = do_create_file(&h, FILE_WRITE_ATTRIBUTES, NULL, 0,
1537 FILE_OPEN, FILE_NON_DIRECTORY_FILE, ctx);
1538 if (!NT_SUCCESS(status))
1541 memset(&info, 0, sizeof(info));
1542 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
1544 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1545 &info, sizeof(info),
1546 FileBasicInformation);
1548 if (!NT_SUCCESS(status))
1554 set_errno_from_nt_status(status);
1555 ERROR_WITH_ERRNO("Can't create file \"%ls\" (status=0x%08"PRIx32")",
1556 current_path(ctx), (u32)status);
1557 return WIMLIB_ERR_OPEN;
1560 /* Creates a hard link at the location named by @dentry to the file represented
1561 * by the open handle @h. Or, if the target volume does not support hard links,
1562 * create a separate file instead. */
1564 create_link(HANDLE h, const struct wim_dentry *dentry,
1565 struct win32_apply_ctx *ctx)
1567 if (ctx->common.supported_features.hard_links) {
1569 build_extraction_path(dentry, ctx);
1571 size_t bufsize = offsetof(FILE_LINK_INFORMATION, FileName) +
1572 ctx->pathbuf.Length + sizeof(wchar_t);
1573 u8 buf[bufsize] _aligned_attribute(8);
1574 FILE_LINK_INFORMATION *info = (FILE_LINK_INFORMATION *)buf;
1577 info->ReplaceIfExists = TRUE;
1578 info->RootDirectory = ctx->attr.RootDirectory;
1579 info->FileNameLength = ctx->pathbuf.Length;
1580 memcpy(info->FileName, ctx->pathbuf.Buffer, ctx->pathbuf.Length);
1581 info->FileName[info->FileNameLength / 2] = L'\0';
1583 /* Note: the null terminator isn't actually necessary,
1584 * but if you don't add the extra character, you get
1585 * STATUS_INFO_LENGTH_MISMATCH when FileNameLength
1586 * happens to be 2 */
1588 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1590 FileLinkInformation);
1591 if (NT_SUCCESS(status))
1593 ERROR("Failed to create link \"%ls\" (status=0x%08"PRIx32")",
1594 current_path(ctx), (u32)status);
1595 return WIMLIB_ERR_LINK;
1600 ret = create_nondirectory_inode(&h2, dentry, ctx);
1604 (*func_NtClose)(h2);
1609 /* Given an inode (represented by the open handle @h) for which one link has
1610 * been created (named by @first_dentry), create the other links.
1612 * Or, if the target volume does not support hard links, create separate files.
1614 * Note: This uses ctx->pathbuf and does not reset it.
1617 create_links(HANDLE h, const struct wim_dentry *first_dentry,
1618 struct win32_apply_ctx *ctx)
1620 const struct wim_inode *inode;
1621 const struct list_head *next;
1622 const struct wim_dentry *dentry;
1625 inode = first_dentry->d_inode;
1626 next = inode->i_extraction_aliases.next;
1628 dentry = list_entry(next, struct wim_dentry,
1629 d_extraction_alias_node);
1630 if (dentry != first_dentry) {
1631 ret = create_link(h, dentry, ctx);
1636 } while (next != &inode->i_extraction_aliases);
1640 /* Create a nondirectory file, including all links. */
1642 create_nondirectory(struct wim_inode *inode, struct win32_apply_ctx *ctx)
1644 struct wim_dentry *first_dentry;
1648 first_dentry = first_extraction_alias(inode);
1650 /* Create first link. */
1651 ret = create_nondirectory_inode(&h, first_dentry, ctx);
1655 /* Set short name. */
1656 ret = set_short_name(h, first_dentry, ctx);
1658 /* Create additional links, OR if hard links are not supported just
1659 * create more files. */
1661 ret = create_links(h, first_dentry, ctx);
1663 /* "WIMBoot" extraction: set external backing by the WIM file if needed. */
1664 if (!ret && unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
1665 ret = set_external_backing(h, inode, ctx);
1671 /* Create all the nondirectory files being extracted, including all aliases
1674 create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1676 struct wim_dentry *dentry;
1677 struct wim_inode *inode;
1680 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1681 inode = dentry->d_inode;
1682 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1684 /* Call create_nondirectory() only once per inode */
1685 if (dentry == inode_first_extraction_dentry(inode)) {
1686 ret = create_nondirectory(inode, ctx);
1687 ret = check_apply_error(dentry, ctx, ret);
1691 ret = report_file_created(&ctx->common);
1699 close_handles(struct win32_apply_ctx *ctx)
1701 for (unsigned i = 0; i < ctx->num_open_handles; i++)
1702 (*func_NtClose)(ctx->open_handles[i]);
1705 /* Prepare to read the next stream, which has size @stream_size, into an
1706 * in-memory buffer. */
1708 prepare_data_buffer(struct win32_apply_ctx *ctx, u64 stream_size)
1710 if (stream_size > ctx->data_buffer_size) {
1711 /* Larger buffer needed. */
1713 if ((size_t)stream_size != stream_size)
1715 new_buffer = REALLOC(ctx->data_buffer, stream_size);
1718 ctx->data_buffer = new_buffer;
1719 ctx->data_buffer_size = stream_size;
1721 /* On the first call this changes data_buffer_ptr from NULL, which tells
1722 * extract_chunk() that the data buffer needs to be filled while reading
1723 * the stream data. */
1724 ctx->data_buffer_ptr = ctx->data_buffer;
1729 begin_extract_stream_instance(const struct wim_lookup_table_entry *stream,
1730 struct wim_dentry *dentry,
1731 const wchar_t *stream_name,
1732 struct win32_apply_ctx *ctx)
1734 const struct wim_inode *inode = dentry->d_inode;
1735 size_t stream_name_nchars = 0;
1736 FILE_ALLOCATION_INFORMATION alloc_info;
1740 if (unlikely(stream_name))
1741 stream_name_nchars = wcslen(stream_name);
1743 if (unlikely(stream_name_nchars)) {
1744 build_extraction_path_with_ads(dentry, ctx,
1745 stream_name, stream_name_nchars);
1747 build_extraction_path(dentry, ctx);
1751 /* Encrypted file? */
1752 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
1753 && (stream_name_nchars == 0))
1755 if (!ctx->common.supported_features.encrypted_files)
1758 /* We can't write encrypted file streams directly; we must use
1759 * WriteEncryptedFileRaw(), which requires providing the data
1760 * through a callback function. This can't easily be combined
1761 * with our own callback-based approach.
1763 * The current workaround is to simply read the stream into
1764 * memory and write the encrypted file from that.
1766 * TODO: This isn't sufficient for extremely large encrypted
1767 * files. Perhaps we should create an extra thread to write
1769 if (!prepare_data_buffer(ctx, stream->size))
1770 return WIMLIB_ERR_NOMEM;
1771 list_add_tail(&dentry->tmp_list, &ctx->encrypted_dentries);
1777 * Note: FILE_ATTRIBUTE_REPARSE_POINT is tested *after*
1778 * FILE_ATTRIBUTE_ENCRYPTED since the WIM format does not store both EFS
1779 * data and reparse data for the same file, and the EFS data takes
1781 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
1782 && (stream_name_nchars == 0))
1784 if (!ctx->common.supported_features.reparse_points)
1787 /* We can't write the reparse stream directly; we must set it
1788 * with FSCTL_SET_REPARSE_POINT, which requires that all the
1789 * data be available. So, stage the data in a buffer. */
1791 if (!prepare_data_buffer(ctx, stream->size))
1792 return WIMLIB_ERR_NOMEM;
1793 list_add_tail(&dentry->tmp_list, &ctx->reparse_dentries);
1797 if (ctx->num_open_handles == MAX_OPEN_STREAMS) {
1798 /* XXX: Fix this. But because of the checks in
1799 * extract_stream_list(), this can now only happen on a
1800 * filesystem that does not support hard links. */
1801 ERROR("Can't extract data: too many open files!");
1802 return WIMLIB_ERR_UNSUPPORTED;
1805 /* Open a new handle */
1806 status = do_create_file(&h,
1807 FILE_WRITE_DATA | SYNCHRONIZE,
1808 NULL, 0, FILE_OPEN_IF,
1809 FILE_SEQUENTIAL_ONLY |
1810 FILE_SYNCHRONOUS_IO_NONALERT,
1812 if (!NT_SUCCESS(status)) {
1813 set_errno_from_nt_status(status);
1814 ERROR_WITH_ERRNO("Can't open \"%ls\" for writing "
1815 "(status=0x%08"PRIx32")",
1816 current_path(ctx), (u32)status);
1817 return WIMLIB_ERR_OPEN;
1820 ctx->open_handles[ctx->num_open_handles++] = h;
1822 /* Allocate space for the data. */
1823 alloc_info.AllocationSize.QuadPart = stream->size;
1824 (*func_NtSetInformationFile)(h, &ctx->iosb,
1825 &alloc_info, sizeof(alloc_info),
1826 FileAllocationInformation);
1830 /* Set the reparse data @rpbuf of length @rpbuflen on the extracted file
1831 * corresponding to the WIM dentry @dentry. */
1833 do_set_reparse_data(const struct wim_dentry *dentry,
1834 const void *rpbuf, u16 rpbuflen,
1835 struct win32_apply_ctx *ctx)
1840 status = create_file(&h, GENERIC_WRITE, NULL,
1841 0, FILE_OPEN, 0, dentry, ctx);
1842 if (!NT_SUCCESS(status))
1845 status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
1846 &ctx->iosb, FSCTL_SET_REPARSE_POINT,
1847 (void *)rpbuf, rpbuflen,
1851 if (NT_SUCCESS(status))
1854 /* On Windows, by default only the Administrator can create symbolic
1855 * links for some reason. By default we just issue a warning if this
1856 * appears to be the problem. Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
1857 * to get a hard error. */
1858 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
1859 && (status == STATUS_PRIVILEGE_NOT_HELD ||
1860 status == STATUS_ACCESS_DENIED)
1861 && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1862 dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1864 WARNING("Can't create symbolic link \"%ls\"! \n"
1865 " (Need Administrator rights, or at least "
1867 " SeCreateSymbolicLink privilege.)",
1873 set_errno_from_nt_status(status);
1874 ERROR_WITH_ERRNO("Can't set reparse data on \"%ls\" "
1875 "(status=0x%08"PRIx32")",
1876 current_path(ctx), (u32)status);
1877 return WIMLIB_ERR_SET_REPARSE_DATA;
1880 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1881 * pointer to the suffix of the path that begins with the device directly, such
1882 * as e:\Windows\System32. */
1883 static const wchar_t *
1884 skip_nt_toplevel_component(const wchar_t *path, size_t path_nchars)
1886 static const wchar_t * const dirs[] = {
1891 size_t first_dir_len = 0;
1892 const wchar_t * const end = path + path_nchars;
1894 for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
1895 size_t len = wcslen(dirs[i]);
1896 if (len <= (end - path) && !wcsnicmp(path, dirs[i], len)) {
1897 first_dir_len = len;
1901 if (first_dir_len == 0)
1903 path += first_dir_len;
1904 while (path != end && *path == L'\\')
1909 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1910 * pointer to the suffix of the path that is device-relative, such as
1913 * The path has an explicit length and is not necessarily null terminated.
1915 * If the path just something like \??\e: then the returned pointer will point
1916 * just past the colon. In this case the length of the result will be 0
1918 static const wchar_t *
1919 get_device_relative_path(const wchar_t *path, size_t path_nchars)
1921 const wchar_t * const orig_path = path;
1922 const wchar_t * const end = path + path_nchars;
1924 path = skip_nt_toplevel_component(path, path_nchars);
1925 if (path == orig_path)
1928 path = wmemchr(path, L'\\', (end - path));
1933 } while (path != end && *path == L'\\');
1938 * Given a reparse point buffer for a symbolic link or junction, adjust its
1939 * contents so that the target of the link is consistent with the new location
1943 try_rpfix(u8 *rpbuf, u16 *rpbuflen_p, struct win32_apply_ctx *ctx)
1945 struct reparse_data rpdata;
1946 size_t orig_subst_name_nchars;
1947 const wchar_t *relpath;
1948 size_t relpath_nchars;
1949 size_t target_ntpath_nchars;
1950 size_t fixed_subst_name_nchars;
1951 const wchar_t *fixed_print_name;
1952 size_t fixed_print_name_nchars;
1954 if (parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata)) {
1955 /* Do nothing if the reparse data is invalid. */
1959 if (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK &&
1960 (rpdata.rpflags & SYMBOLIC_LINK_RELATIVE))
1962 /* Do nothing if it's a relative symbolic link. */
1966 /* Build the new substitute name from the NT namespace path to the
1967 * target directory, then a path separator, then the "device relative"
1968 * part of the old substitute name. */
1970 orig_subst_name_nchars = rpdata.substitute_name_nbytes / sizeof(wchar_t);
1972 relpath = get_device_relative_path(rpdata.substitute_name,
1973 orig_subst_name_nchars);
1974 relpath_nchars = orig_subst_name_nchars -
1975 (relpath - rpdata.substitute_name);
1977 target_ntpath_nchars = ctx->target_ntpath.Length / sizeof(wchar_t);
1979 fixed_subst_name_nchars = target_ntpath_nchars;
1981 fixed_subst_name_nchars += 1 + relpath_nchars;
1982 wchar_t fixed_subst_name[fixed_subst_name_nchars];
1984 wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer,
1985 target_ntpath_nchars);
1986 if (relpath_nchars) {
1987 fixed_subst_name[target_ntpath_nchars] = L'\\';
1988 wmemcpy(&fixed_subst_name[target_ntpath_nchars + 1],
1989 relpath, relpath_nchars);
1991 /* Doesn't need to be null-terminated. */
1993 /* Print name should be Win32, but not all NT names can even be
1994 * translated to Win32 names. But we can at least delete the top-level
1995 * directory, such as \??\, and this will have the expected result in
1996 * the usual case. */
1997 fixed_print_name = skip_nt_toplevel_component(fixed_subst_name,
1998 fixed_subst_name_nchars);
1999 fixed_print_name_nchars = fixed_subst_name_nchars - (fixed_print_name -
2002 rpdata.substitute_name = fixed_subst_name;
2003 rpdata.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
2004 rpdata.print_name = (wchar_t *)fixed_print_name;
2005 rpdata.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
2006 make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p);
2009 /* Sets reparse data on the specified file. This handles "fixing" the targets
2010 * of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX was
2013 set_reparse_data(const struct wim_dentry *dentry,
2014 const void *_rpbuf, u16 rpbuflen, struct win32_apply_ctx *ctx)
2016 const struct wim_inode *inode = dentry->d_inode;
2017 const void *rpbuf = _rpbuf;
2019 if ((ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
2020 && !inode->i_not_rpfixed
2021 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
2022 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
2024 memcpy(&ctx->rpfixbuf, _rpbuf, rpbuflen);
2025 try_rpfix((u8 *)&ctx->rpfixbuf, &rpbuflen, ctx);
2026 rpbuf = &ctx->rpfixbuf;
2028 return do_set_reparse_data(dentry, rpbuf, rpbuflen, ctx);
2032 /* Import the next block of raw encrypted data */
2034 import_encrypted_data(PBYTE pbData, PVOID pvCallbackContext, PULONG Length)
2036 struct win32_apply_ctx *ctx = pvCallbackContext;
2039 copy_len = min(ctx->encrypted_size - ctx->encrypted_offset, *Length);
2040 memcpy(pbData, &ctx->data_buffer[ctx->encrypted_offset], copy_len);
2041 ctx->encrypted_offset += copy_len;
2043 return ERROR_SUCCESS;
2047 * Write the raw encrypted data to the already-created file (or directory)
2048 * corresponding to @dentry.
2050 * The raw encrypted data is provided in ctx->data_buffer, and its size is
2051 * ctx->encrypted_size.
2053 * This function may close the target directory, in which case the caller needs
2054 * to re-open it if needed.
2057 extract_encrypted_file(const struct wim_dentry *dentry,
2058 struct win32_apply_ctx *ctx)
2065 /* Temporarily build a Win32 path for OpenEncryptedFileRaw() */
2066 build_win32_extraction_path(dentry, ctx);
2068 flags = CREATE_FOR_IMPORT | OVERWRITE_HIDDEN;
2069 if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
2070 flags |= CREATE_FOR_DIR;
2074 err = OpenEncryptedFileRaw(ctx->pathbuf.Buffer, flags, &rawctx);
2075 if (err == ERROR_SHARING_VIOLATION && !retried) {
2076 /* This can be caused by the handle we have open to the target
2077 * directory. Try closing it temporarily. */
2078 close_target_directory(ctx);
2083 /* Restore the NT namespace path */
2084 build_extraction_path(dentry, ctx);
2086 if (err != ERROR_SUCCESS) {
2087 set_errno_from_win32_error(err);
2088 ERROR_WITH_ERRNO("Can't open \"%ls\" for encrypted import "
2089 "(err=%"PRIu32")", current_path(ctx), (u32)err);
2090 return WIMLIB_ERR_OPEN;
2093 ctx->encrypted_offset = 0;
2095 err = WriteEncryptedFileRaw(import_encrypted_data, ctx, rawctx);
2097 CloseEncryptedFileRaw(rawctx);
2099 if (err != ERROR_SUCCESS) {
2100 set_errno_from_win32_error(err);
2101 ERROR_WITH_ERRNO("Can't import encrypted file \"%ls\" "
2102 "(err=%"PRIu32")", current_path(ctx), (u32)err);
2103 return WIMLIB_ERR_WRITE;
2109 /* Called when starting to read a stream for extraction on Windows */
2111 begin_extract_stream(struct wim_lookup_table_entry *stream, void *_ctx)
2113 struct win32_apply_ctx *ctx = _ctx;
2114 const struct stream_owner *owners = stream_owners(stream);
2117 ctx->num_open_handles = 0;
2118 ctx->data_buffer_ptr = NULL;
2119 INIT_LIST_HEAD(&ctx->reparse_dentries);
2120 INIT_LIST_HEAD(&ctx->encrypted_dentries);
2122 for (u32 i = 0; i < stream->out_refcnt; i++) {
2123 const struct wim_inode *inode = owners[i].inode;
2124 const wchar_t *stream_name = owners[i].stream_name;
2125 struct wim_dentry *dentry;
2127 /* A copy of the stream needs to be extracted to @inode. */
2129 if (ctx->common.supported_features.hard_links) {
2130 dentry = inode_first_extraction_dentry(inode);
2131 ret = begin_extract_stream_instance(stream, dentry,
2133 ret = check_apply_error(dentry, ctx, ret);
2137 /* Hard links not supported. Extract the stream
2138 * separately to each alias of the inode. */
2139 struct list_head *next;
2141 next = inode->i_extraction_aliases.next;
2143 dentry = list_entry(next, struct wim_dentry,
2144 d_extraction_alias_node);
2145 ret = begin_extract_stream_instance(stream,
2149 ret = check_apply_error(dentry, ctx, ret);
2153 } while (next != &inode->i_extraction_aliases);
2164 /* Called when the next chunk of a stream has been read for extraction on
2167 extract_chunk(const void *chunk, size_t size, void *_ctx)
2169 struct win32_apply_ctx *ctx = _ctx;
2171 /* Write the data chunk to each open handle */
2172 for (unsigned i = 0; i < ctx->num_open_handles; i++) {
2173 u8 *bufptr = (u8 *)chunk;
2174 size_t bytes_remaining = size;
2176 while (bytes_remaining) {
2177 ULONG count = min(0xFFFFFFFF, bytes_remaining);
2179 status = (*func_NtWriteFile)(ctx->open_handles[i],
2181 &ctx->iosb, bufptr, count,
2183 if (!NT_SUCCESS(status)) {
2184 set_errno_from_nt_status(status);
2185 ERROR_WITH_ERRNO("Error writing data to target "
2186 "volume (status=0x%08"PRIx32")",
2188 return WIMLIB_ERR_WRITE;
2190 bufptr += ctx->iosb.Information;
2191 bytes_remaining -= ctx->iosb.Information;
2195 /* Copy the data chunk into the buffer (if needed) */
2196 if (ctx->data_buffer_ptr)
2197 ctx->data_buffer_ptr = mempcpy(ctx->data_buffer_ptr,
2202 /* Called when a stream has been fully read for extraction on Windows */
2204 end_extract_stream(struct wim_lookup_table_entry *stream, int status, void *_ctx)
2206 struct win32_apply_ctx *ctx = _ctx;
2208 const struct wim_dentry *dentry;
2215 if (likely(!ctx->data_buffer_ptr))
2218 if (!list_empty(&ctx->reparse_dentries)) {
2219 if (stream->size > REPARSE_DATA_MAX_SIZE) {
2220 dentry = list_first_entry(&ctx->reparse_dentries,
2221 struct wim_dentry, tmp_list);
2222 build_extraction_path(dentry, ctx);
2223 ERROR("Reparse data of \"%ls\" has size "
2224 "%"PRIu64" bytes (exceeds %u bytes)",
2225 current_path(ctx), stream->size,
2226 REPARSE_DATA_MAX_SIZE);
2227 ret = WIMLIB_ERR_INVALID_REPARSE_DATA;
2228 return check_apply_error(dentry, ctx, ret);
2230 /* In the WIM format, reparse streams are just the reparse data
2231 * and omit the header. But we can reconstruct the header. */
2232 memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, stream->size);
2233 ctx->rpbuf.rpdatalen = stream->size;
2234 ctx->rpbuf.rpreserved = 0;
2235 list_for_each_entry(dentry, &ctx->reparse_dentries, tmp_list) {
2236 ctx->rpbuf.rptag = dentry->d_inode->i_reparse_tag;
2237 ret = set_reparse_data(dentry, &ctx->rpbuf,
2238 stream->size + REPARSE_DATA_OFFSET,
2240 ret = check_apply_error(dentry, ctx, ret);
2246 if (!list_empty(&ctx->encrypted_dentries)) {
2247 ctx->encrypted_size = stream->size;
2248 list_for_each_entry(dentry, &ctx->encrypted_dentries, tmp_list) {
2249 ret = extract_encrypted_file(dentry, ctx);
2250 ret = check_apply_error(dentry, ctx, ret);
2253 /* Re-open the target directory if needed. */
2254 ret = open_target_directory(ctx);
2263 /* Attributes that can't be set directly */
2264 #define SPECIAL_ATTRIBUTES \
2265 (FILE_ATTRIBUTE_REPARSE_POINT | \
2266 FILE_ATTRIBUTE_DIRECTORY | \
2267 FILE_ATTRIBUTE_ENCRYPTED | \
2268 FILE_ATTRIBUTE_SPARSE_FILE | \
2269 FILE_ATTRIBUTE_COMPRESSED)
2271 /* Set the security descriptor @desc, of @desc_size bytes, on the file with open
2274 set_security_descriptor(HANDLE h, const void *_desc,
2275 size_t desc_size, struct win32_apply_ctx *ctx)
2277 SECURITY_INFORMATION info;
2279 SECURITY_DESCRIPTOR_RELATIVE *desc;
2282 * Ideally, we would just pass in the security descriptor buffer as-is.
2283 * But it turns out that Windows can mess up the security descriptor
2284 * even when using the low-level NtSetSecurityObject() function:
2286 * - Windows will clear SE_DACL_AUTO_INHERITED if it is set in the
2287 * passed buffer. To actually get Windows to set
2288 * SE_DACL_AUTO_INHERITED, the application must set the non-persistent
2289 * flag SE_DACL_AUTO_INHERIT_REQ. As usual, Microsoft didn't bother
2290 * to properly document either of these flags. It's unclear how
2291 * important SE_DACL_AUTO_INHERITED actually is, but to be safe we use
2292 * the SE_DACL_AUTO_INHERIT_REQ workaround to set it if needed.
2294 * - The above also applies to the equivalent SACL flags,
2295 * SE_SACL_AUTO_INHERITED and SE_SACL_AUTO_INHERIT_REQ.
2297 * - If the application says that it's setting
2298 * DACL_SECURITY_INFORMATION, then Windows sets SE_DACL_PRESENT in the
2299 * resulting security descriptor, even if the security descriptor the
2300 * application provided did not have a DACL. This seems to be
2301 * unavoidable, since omitting DACL_SECURITY_INFORMATION would cause a
2302 * default DACL to remain. Fortunately, this behavior seems harmless,
2303 * since the resulting DACL will still be "null" --- but it will be
2304 * "the other representation of null".
2306 * - The above also applies to SACL_SECURITY_INFORMATION and
2307 * SE_SACL_PRESENT. Again, it's seemingly unavoidable but "harmless"
2308 * that Windows changes the representation of a "null SACL".
2310 if (likely(desc_size <= STACK_MAX)) {
2311 desc = alloca(desc_size);
2313 desc = MALLOC(desc_size);
2315 return STATUS_NO_MEMORY;
2318 memcpy(desc, _desc, desc_size);
2320 if (likely(desc_size >= 4)) {
2322 if (desc->Control & SE_DACL_AUTO_INHERITED)
2323 desc->Control |= SE_DACL_AUTO_INHERIT_REQ;
2325 if (desc->Control & SE_SACL_AUTO_INHERITED)
2326 desc->Control |= SE_SACL_AUTO_INHERIT_REQ;
2330 * More API insanity. We want to set the entire security descriptor
2331 * as-is. But all available APIs require specifying the specific parts
2332 * of the security descriptor being set. Especially annoying is that
2333 * mandatory integrity labels are part of the SACL, but they aren't set
2334 * with SACL_SECURITY_INFORMATION. Instead, applications must also
2335 * specify LABEL_SECURITY_INFORMATION (Windows Vista, Windows 7) or
2336 * BACKUP_SECURITY_INFORMATION (Windows 8). But at least older versions
2337 * of Windows don't error out if you provide these newer flags...
2339 * Also, if the process isn't running as Administrator, then it probably
2340 * doesn't have SE_RESTORE_PRIVILEGE. In this case, it will always get
2341 * the STATUS_PRIVILEGE_NOT_HELD error by trying to set the SACL, even
2342 * if the security descriptor it provided did not have a SACL. By
2343 * default, in this case we try to recover and set as much of the
2344 * security descriptor as possible --- potentially excluding the DACL, and
2345 * even the owner, as well as the SACL.
2348 info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
2349 DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION |
2350 LABEL_SECURITY_INFORMATION | BACKUP_SECURITY_INFORMATION;
2354 * It's also worth noting that SetFileSecurity() is unusable because it
2355 * doesn't request "backup semantics" when it opens the file internally.
2356 * NtSetSecurityObject() seems to be the best function to use in backup
2357 * applications. (SetSecurityInfo() should also work, but it's harder
2358 * to use and must call NtSetSecurityObject() internally anyway.
2359 * BackupWrite() is theoretically usable as well, but it's inflexible
2360 * and poorly documented.)
2364 status = (*func_NtSetSecurityObject)(h, info, desc);
2365 if (NT_SUCCESS(status))
2366 goto out_maybe_free_desc;
2368 /* Failed to set the requested parts of the security descriptor. If the
2369 * error was permissions-related, try to set fewer parts of the security
2370 * descriptor, unless WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled. */
2371 if ((status == STATUS_PRIVILEGE_NOT_HELD ||
2372 status == STATUS_ACCESS_DENIED) &&
2373 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2375 if (info & SACL_SECURITY_INFORMATION) {
2376 info &= ~(SACL_SECURITY_INFORMATION |
2377 LABEL_SECURITY_INFORMATION |
2378 BACKUP_SECURITY_INFORMATION);
2379 ctx->partial_security_descriptors++;
2382 if (info & DACL_SECURITY_INFORMATION) {
2383 info &= ~DACL_SECURITY_INFORMATION;
2386 if (info & OWNER_SECURITY_INFORMATION) {
2387 info &= ~OWNER_SECURITY_INFORMATION;
2390 /* Nothing left except GROUP, and if we removed it we
2391 * wouldn't have anything at all. */
2394 /* No part of the security descriptor could be set, or
2395 * WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled and the full security
2396 * descriptor could not be set. */
2397 if (!(info & SACL_SECURITY_INFORMATION))
2398 ctx->partial_security_descriptors--;
2399 ctx->no_security_descriptors++;
2401 out_maybe_free_desc:
2402 if (unlikely(desc_size > STACK_MAX))
2407 /* Set metadata on the open file @h from the WIM inode @inode. */
2409 do_apply_metadata_to_file(HANDLE h, const struct wim_inode *inode,
2410 struct win32_apply_ctx *ctx)
2412 FILE_BASIC_INFORMATION info;
2415 /* Set security descriptor if present and not in NO_ACLS mode */
2416 if (inode->i_security_id >= 0 &&
2417 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
2419 const struct wim_security_data *sd;
2423 sd = wim_get_current_security_data(ctx->common.wim);
2424 desc = sd->descriptors[inode->i_security_id];
2425 desc_size = sd->sizes[inode->i_security_id];
2427 status = set_security_descriptor(h, desc, desc_size, ctx);
2428 if (!NT_SUCCESS(status) &&
2429 (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2431 set_errno_from_nt_status(status);
2432 ERROR_WITH_ERRNO("Can't set security descriptor "
2433 "on \"%ls\" (status=0x%08"PRIx32")",
2434 current_path(ctx), (u32)status);
2435 return WIMLIB_ERR_SET_SECURITY;
2439 /* Set attributes and timestamps */
2440 info.CreationTime.QuadPart = inode->i_creation_time;
2441 info.LastAccessTime.QuadPart = inode->i_last_access_time;
2442 info.LastWriteTime.QuadPart = inode->i_last_write_time;
2443 info.ChangeTime.QuadPart = 0;
2444 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
2445 info.FileAttributes = 0;
2447 info.FileAttributes = inode->i_attributes & ~SPECIAL_ATTRIBUTES;
2449 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
2450 &info, sizeof(info),
2451 FileBasicInformation);
2452 /* On FAT volumes we get STATUS_INVALID_PARAMETER if we try to set
2453 * attributes on the root directory. (Apparently because FAT doesn't
2454 * actually have a place to store those attributes!) */
2455 if (!NT_SUCCESS(status)
2456 && !(status == STATUS_INVALID_PARAMETER &&
2457 dentry_is_root(inode_first_extraction_dentry(inode))))
2459 set_errno_from_nt_status(status);
2460 ERROR_WITH_ERRNO("Can't set basic metadata on \"%ls\" "
2461 "(status=0x%08"PRIx32")",
2462 current_path(ctx), (u32)status);
2463 return WIMLIB_ERR_SET_ATTRIBUTES;
2470 apply_metadata_to_file(const struct wim_dentry *dentry,
2471 struct win32_apply_ctx *ctx)
2473 const struct wim_inode *inode = dentry->d_inode;
2479 perms = FILE_WRITE_ATTRIBUTES | WRITE_DAC |
2480 WRITE_OWNER | ACCESS_SYSTEM_SECURITY;
2482 build_extraction_path(dentry, ctx);
2484 /* Open a handle with as many relevant permissions as possible. */
2485 while (!NT_SUCCESS(status = do_create_file(&h, perms, NULL,
2486 0, FILE_OPEN, 0, ctx)))
2488 if (status == STATUS_PRIVILEGE_NOT_HELD ||
2489 status == STATUS_ACCESS_DENIED)
2491 if (perms & ACCESS_SYSTEM_SECURITY) {
2492 perms &= ~ACCESS_SYSTEM_SECURITY;
2495 if (perms & WRITE_DAC) {
2496 perms &= ~WRITE_DAC;
2499 if (perms & WRITE_OWNER) {
2500 perms &= ~WRITE_OWNER;
2504 set_errno_from_nt_status(status);
2505 ERROR_WITH_ERRNO("Can't open \"%ls\" to set metadata "
2506 "(status=0x%08"PRIx32")",
2507 current_path(ctx), (u32)status);
2508 return WIMLIB_ERR_OPEN;
2511 ret = do_apply_metadata_to_file(h, inode, ctx);
2519 apply_metadata(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
2521 const struct wim_dentry *dentry;
2524 /* We go in reverse so that metadata is set on all a directory's
2525 * children before the directory itself. This avoids any potential
2526 * problems with attributes, timestamps, or security descriptors. */
2527 list_for_each_entry_reverse(dentry, dentry_list, d_extraction_list_node)
2529 ret = apply_metadata_to_file(dentry, ctx);
2530 ret = check_apply_error(dentry, ctx, ret);
2533 ret = report_file_metadata_applied(&ctx->common);
2540 /* Issue warnings about problems during the extraction for which warnings were
2541 * not already issued (due to the high number of potential warnings if we issued
2542 * them per-file). */
2544 do_warnings(const struct win32_apply_ctx *ctx)
2546 if (ctx->partial_security_descriptors == 0
2547 && ctx->no_security_descriptors == 0
2548 && ctx->num_set_short_name_failures == 0
2550 && ctx->num_remove_short_name_failures == 0
2555 WARNING("Extraction to \"%ls\" complete, but with one or more warnings:",
2556 ctx->common.target);
2557 if (ctx->num_set_short_name_failures) {
2558 WARNING("- Could not set short names on %lu files or directories",
2559 ctx->num_set_short_name_failures);
2562 if (ctx->num_remove_short_name_failures) {
2563 WARNING("- Could not remove short names on %lu files or directories"
2564 " (This is expected on Vista and earlier)",
2565 ctx->num_remove_short_name_failures);
2568 if (ctx->partial_security_descriptors) {
2569 WARNING("- Could only partially set the security descriptor\n"
2570 " on %lu files or directories.",
2571 ctx->partial_security_descriptors);
2573 if (ctx->no_security_descriptors) {
2574 WARNING("- Could not set security descriptor at all\n"
2575 " on %lu files or directories.",
2576 ctx->no_security_descriptors);
2578 if (ctx->partial_security_descriptors || ctx->no_security_descriptors) {
2579 WARNING("To fully restore all security descriptors, run the program\n"
2580 " with Administrator rights.");
2585 count_dentries(const struct list_head *dentry_list)
2587 const struct list_head *cur;
2590 list_for_each(cur, dentry_list)
2596 /* Extract files from a WIM image to a directory on Windows */
2598 win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
2601 struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
2602 uint64_t dentry_count;
2604 ret = prepare_target(dentry_list, ctx);
2608 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2609 ret = start_wimboot_extraction(ctx);
2614 dentry_count = count_dentries(dentry_list);
2616 ret = start_file_structure_phase(&ctx->common, dentry_count);
2620 ret = create_directories(dentry_list, ctx);
2624 ret = create_nondirectories(dentry_list, ctx);
2628 ret = end_file_structure_phase(&ctx->common);
2632 struct read_stream_list_callbacks cbs = {
2633 .begin_stream = begin_extract_stream,
2634 .begin_stream_ctx = ctx,
2635 .consume_chunk = extract_chunk,
2636 .consume_chunk_ctx = ctx,
2637 .end_stream = end_extract_stream,
2638 .end_stream_ctx = ctx,
2640 ret = extract_stream_list(&ctx->common, &cbs);
2644 ret = start_file_metadata_phase(&ctx->common, dentry_count);
2648 ret = apply_metadata(dentry_list, ctx);
2652 ret = end_file_metadata_phase(&ctx->common);
2656 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2657 ret = end_wimboot_extraction(ctx);
2664 close_target_directory(ctx);
2665 if (ctx->target_ntpath.Buffer)
2666 HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
2667 FREE(ctx->pathbuf.Buffer);
2668 FREE(ctx->print_buffer);
2669 if (ctx->wimboot.prepopulate_pats) {
2670 FREE(ctx->wimboot.prepopulate_pats->strings);
2671 FREE(ctx->wimboot.prepopulate_pats);
2673 FREE(ctx->wimboot.mem_prepopulate_pats);
2674 FREE(ctx->data_buffer);
2678 const struct apply_operations win32_apply_ops = {
2680 .get_supported_features = win32_get_supported_features,
2681 .extract = win32_extract,
2682 .will_externally_back = win32_will_externally_back,
2683 .context_size = sizeof(struct win32_apply_ctx),
2686 #endif /* __WIN32__ */