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/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 win32_warning(GetLastError(),
182 L"Failed to get volume information for \"%ls\"",
187 if (wcsstr(filesystem_name, L"NTFS")) {
188 /* FILE_SUPPORTS_HARD_LINKS is only supported on Windows 7 and
189 * later. Force it on anyway if filesystem is NTFS. */
190 *vol_flags_ret |= FILE_SUPPORTS_HARD_LINKS;
192 /* There's no volume flag for short names, but according to the
193 * MS documentation they are only user-settable on NTFS. */
194 *short_names_supported_ret = true;
198 static const wchar_t *
199 current_path(struct win32_apply_ctx *ctx);
202 build_extraction_path(const struct wim_dentry *dentry,
203 struct win32_apply_ctx *ctx);
206 report_dentry_apply_error(const struct wim_dentry *dentry,
207 struct win32_apply_ctx *ctx, int ret)
209 build_extraction_path(dentry, ctx);
210 return report_apply_error(&ctx->common, ret, current_path(ctx));
214 check_apply_error(const struct wim_dentry *dentry,
215 struct win32_apply_ctx *ctx, int ret)
218 ret = report_dentry_apply_error(dentry, ctx, ret);
223 win32_get_supported_features(const wchar_t *target,
224 struct wim_features *supported_features)
227 bool short_names_supported;
229 /* Query the features of the target volume. */
231 get_vol_flags(target, &vol_flags, &short_names_supported);
233 supported_features->archive_files = 1;
234 supported_features->hidden_files = 1;
235 supported_features->system_files = 1;
237 if (vol_flags & FILE_FILE_COMPRESSION)
238 supported_features->compressed_files = 1;
240 if (vol_flags & FILE_SUPPORTS_ENCRYPTION) {
241 supported_features->encrypted_files = 1;
242 supported_features->encrypted_directories = 1;
245 supported_features->not_context_indexed_files = 1;
247 /* Don't do anything with FILE_SUPPORTS_SPARSE_FILES. */
249 if (vol_flags & FILE_NAMED_STREAMS)
250 supported_features->named_data_streams = 1;
252 if (vol_flags & FILE_SUPPORTS_HARD_LINKS)
253 supported_features->hard_links = 1;
255 if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS)
256 supported_features->reparse_points = 1;
258 if (vol_flags & FILE_PERSISTENT_ACLS)
259 supported_features->security_descriptors = 1;
261 if (short_names_supported)
262 supported_features->short_names = 1;
264 supported_features->timestamps = 1;
266 /* Note: Windows does not support case sensitive filenames! At least
267 * not without changing the registry and rebooting... */
272 /* Load the patterns from [PrepopulateList] of WimBootCompress.ini in the WIM
273 * image being extracted. */
275 load_prepopulate_pats(struct win32_apply_ctx *ctx)
277 const wchar_t *path = L"\\Windows\\System32\\WimBootCompress.ini";
278 struct wim_dentry *dentry;
279 struct wim_lookup_table_entry *lte;
282 struct string_set *s;
284 struct text_file_section sec;
286 ctx->wimboot.tried_to_load_prepopulate_list = true;
288 dentry = get_dentry(ctx->common.wim, path, WIMLIB_CASE_INSENSITIVE);
290 (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
291 FILE_ATTRIBUTE_REPARSE_POINT |
292 FILE_ATTRIBUTE_ENCRYPTED)) ||
293 !(lte = inode_unnamed_lte(dentry->d_inode, ctx->common.wim->lookup_table)))
295 WARNING("%ls does not exist in WIM image!", path);
296 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
299 ret = read_full_stream_into_alloc_buf(lte, &buf);
303 s = CALLOC(1, sizeof(struct string_set));
306 return WIMLIB_ERR_NOMEM;
309 sec.name = T("PrepopulateList");
312 ret = do_load_text_file(path, buf, lte->size, &mem, &sec, 1,
313 LOAD_TEXT_FILE_REMOVE_QUOTES |
314 LOAD_TEXT_FILE_NO_WARNINGS,
316 BUILD_BUG_ON(OS_PREFERRED_PATH_SEPARATOR != WIM_PATH_SEPARATOR);
322 ctx->wimboot.prepopulate_pats = s;
323 ctx->wimboot.mem_prepopulate_pats = mem;
327 /* Returns %true if the specified absolute path to a file in the WIM image
328 * matches a pattern in [PrepopulateList] of WimBootCompress.ini. Otherwise
331 in_prepopulate_list(const wchar_t *path, size_t path_nchars,
332 const struct win32_apply_ctx *ctx)
334 const struct string_set *pats = ctx->wimboot.prepopulate_pats;
336 if (!pats || !pats->num_strings)
339 return match_pattern_list(path, path_nchars, pats);
342 /* Returns %true if the specified absolute path to a file in the WIM image can
343 * be subject to external backing when extracted. Otherwise returns %false. */
345 can_externally_back_path(const wchar_t *path, size_t path_nchars,
346 const struct win32_apply_ctx *ctx)
348 if (in_prepopulate_list(path, path_nchars, ctx))
351 /* Since we attempt to modify the SYSTEM registry after it's extracted
352 * (see end_wimboot_extraction()), it can't be extracted as externally
353 * backed. This extends to associated files such as SYSTEM.LOG that
354 * also must be writable in order to write to the registry. Normally,
355 * SYSTEM is in [PrepopulateList], and the SYSTEM.* files match patterns
356 * in [ExclusionList] and therefore are not captured in the WIM at all.
357 * However, a WIM that wasn't specifically captured in "WIMBoot mode"
358 * may contain SYSTEM.* files. So to make things "just work", hard-code
360 if (match_path(path, path_nchars, L"\\Windows\\System32\\config\\SYSTEM*",
361 OS_PREFERRED_PATH_SEPARATOR, false))
367 #define WIM_BACKING_NOT_ENABLED -1
368 #define WIM_BACKING_NOT_POSSIBLE -2
369 #define WIM_BACKING_EXCLUDED -3
372 will_externally_back_inode(struct wim_inode *inode, struct win32_apply_ctx *ctx,
373 const struct wim_dentry **excluded_dentry_ret)
375 struct list_head *next;
376 struct wim_dentry *dentry;
377 struct wim_lookup_table_entry *stream;
380 if (inode->i_can_externally_back)
383 /* This may do redundant checks because the cached value
384 * i_can_externally_back is 2-state (as opposed to 3-state:
385 * unknown/no/yes). But most files can be externally backed, so this
388 if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
389 FILE_ATTRIBUTE_REPARSE_POINT |
390 FILE_ATTRIBUTE_ENCRYPTED))
391 return WIM_BACKING_NOT_POSSIBLE;
393 stream = inode_unnamed_lte_resolved(inode);
396 stream->resource_location != RESOURCE_IN_WIM ||
397 stream->rspec->wim != ctx->common.wim ||
398 stream->size != stream->rspec->uncompressed_size)
399 return WIM_BACKING_NOT_POSSIBLE;
402 * We need to check the patterns in [PrepopulateList] against every name
403 * of the inode, in case any of them match.
405 next = inode->i_extraction_aliases.next;
407 dentry = list_entry(next, struct wim_dentry,
408 d_extraction_alias_node);
410 ret = calculate_dentry_full_path(dentry);
414 if (!can_externally_back_path(dentry->_full_path,
415 wcslen(dentry->_full_path), ctx))
417 if (excluded_dentry_ret)
418 *excluded_dentry_ret = dentry;
419 return WIM_BACKING_EXCLUDED;
422 } while (next != &inode->i_extraction_aliases);
424 inode->i_can_externally_back = 1;
429 * Determines if the unnamed data stream of a file will be created as an
430 * external backing, as opposed to a standard extraction.
433 win32_will_externally_back(struct wim_dentry *dentry, struct apply_ctx *_ctx)
435 struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
437 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
438 return WIM_BACKING_NOT_ENABLED;
440 if (!ctx->wimboot.tried_to_load_prepopulate_list)
441 if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
442 return WIMLIB_ERR_NOMEM;
444 return will_externally_back_inode(dentry->d_inode, ctx, NULL);
448 set_external_backing(HANDLE h, struct wim_inode *inode, struct win32_apply_ctx *ctx)
451 const struct wim_dentry *excluded_dentry;
453 ret = will_externally_back_inode(inode, ctx, &excluded_dentry);
454 if (ret > 0) /* Error. */
457 if (ret < 0 && ret != WIM_BACKING_EXCLUDED)
458 return 0; /* Not externally backing, other than due to exclusion. */
460 if (unlikely(ret == WIM_BACKING_EXCLUDED)) {
461 /* Not externally backing due to exclusion. */
462 union wimlib_progress_info info;
464 build_extraction_path(excluded_dentry, ctx);
466 info.wimboot_exclude.path_in_wim = excluded_dentry->_full_path;
467 info.wimboot_exclude.extraction_path = current_path(ctx);
469 return call_progress(ctx->common.progfunc,
470 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE,
471 &info, ctx->common.progctx);
473 /* Externally backing. */
474 if (unlikely(!wimboot_set_pointer(h,
475 inode_unnamed_lte_resolved(inode),
476 ctx->wimboot.data_source_id,
477 ctx->wimboot.wim_lookup_table_hash,
478 ctx->wimboot.wof_running)))
480 const DWORD err = GetLastError();
482 build_extraction_path(inode_first_extraction_dentry(inode), ctx);
483 win32_error(err, L"\"%ls\": Couldn't set WIMBoot pointer data",
485 return WIMLIB_ERR_WIMBOOT;
491 /* Calculates the SHA-1 message digest of the WIM's lookup table. */
493 hash_lookup_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
495 return wim_reshdr_to_hash(&wim->hdr.lookup_table_reshdr, wim, hash);
498 /* Prepare for doing a "WIMBoot" extraction by loading patterns from
499 * [PrepopulateList] of WimBootCompress.ini and allocating a WOF data source ID
500 * on the target volume. */
502 start_wimboot_extraction(struct win32_apply_ctx *ctx)
505 WIMStruct *wim = ctx->common.wim;
507 if (!ctx->wimboot.tried_to_load_prepopulate_list)
508 if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
509 return WIMLIB_ERR_NOMEM;
511 if (!wim_info_get_wimboot(wim->wim_info, wim->current_image))
512 WARNING("Image is not marked as WIMBoot compatible!");
514 ret = hash_lookup_table(ctx->common.wim,
515 ctx->wimboot.wim_lookup_table_hash);
519 return wimboot_alloc_data_source_id(wim->filename,
523 &ctx->wimboot.data_source_id,
524 &ctx->wimboot.wof_running);
528 build_win32_extraction_path(const struct wim_dentry *dentry,
529 struct win32_apply_ctx *ctx);
531 /* Sets WimBoot=1 in the extracted SYSTEM registry hive.
533 * WIMGAPI does this, and it's possible that it's important.
534 * But I don't know exactly what this value means to Windows. */
536 end_wimboot_extraction(struct win32_apply_ctx *ctx)
538 struct wim_dentry *dentry;
539 wchar_t subkeyname[32];
545 dentry = get_dentry(ctx->common.wim, L"\\Windows\\System32\\config\\SYSTEM",
546 WIMLIB_CASE_INSENSITIVE);
548 if (!dentry || !will_extract_dentry(dentry))
551 if (!will_extract_dentry(wim_get_current_root_dentry(ctx->common.wim)))
554 /* Not bothering to use the native routines (e.g. NtLoadKey()) for this.
555 * If this doesn't work, you probably also have many other problems. */
557 build_win32_extraction_path(dentry, ctx);
559 randomize_char_array_with_alnum(subkeyname, 20);
560 subkeyname[20] = L'\0';
562 res = RegLoadKey(HKEY_LOCAL_MACHINE, subkeyname, ctx->pathbuf.Buffer);
566 wcscpy(&subkeyname[20], L"\\Setup");
568 res = RegCreateKeyEx(HKEY_LOCAL_MACHINE, subkeyname, 0, NULL,
569 REG_OPTION_BACKUP_RESTORE, 0, NULL, &key, NULL);
575 res = RegSetValueEx(key, L"WimBoot", 0, REG_DWORD,
576 (const BYTE *)&value, sizeof(DWORD));
580 res = RegFlushKey(key);
583 res2 = RegCloseKey(key);
587 subkeyname[20] = L'\0';
588 RegUnLoadKey(HKEY_LOCAL_MACHINE, subkeyname);
592 win32_warning(res, L"Failed to set \\Setup: dword \"WimBoot\"=1 "
593 "value in registry hive \"%ls\"",
594 ctx->pathbuf.Buffer);
600 /* Returns the number of wide characters needed to represent the path to the
601 * specified @dentry, relative to the target directory, when extracted.
603 * Does not include null terminator (not needed for NtCreateFile). */
605 dentry_extraction_path_length(const struct wim_dentry *dentry)
608 const struct wim_dentry *d;
612 len += d->d_extraction_name_nchars + 1;
614 } while (!dentry_is_root(d) && will_extract_dentry(d));
616 return --len; /* No leading slash */
619 /* Returns the length of the longest string that might need to be appended to
620 * the path to an alias of an inode to open or create a named data stream.
622 * If the inode has no named data streams, this will be 0. Otherwise, this will
623 * be 1 plus the length of the longest-named data stream, since the data stream
624 * name must be separated from the path by the ':' character. */
626 inode_longest_named_data_stream_spec(const struct wim_inode *inode)
629 for (u16 i = 0; i < inode->i_num_ads; i++) {
630 size_t len = inode->i_ads_entries[i].stream_name_nbytes;
635 max = 1 + (max / sizeof(wchar_t));
639 /* Find the length, in wide characters, of the longest path needed for
640 * extraction of any file in @dentry_list relative to the target directory.
642 * Accounts for named data streams, but does not include null terminator (not
643 * needed for NtCreateFile). */
645 compute_path_max(struct list_head *dentry_list)
648 const struct wim_dentry *dentry;
650 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
653 len = dentry_extraction_path_length(dentry);
655 /* Account for named data streams */
656 len += inode_longest_named_data_stream_spec(dentry->d_inode);
665 /* Build the path at which to extract the @dentry, relative to the target
668 * The path is saved in ctx->pathbuf. */
670 build_extraction_path(const struct wim_dentry *dentry,
671 struct win32_apply_ctx *ctx)
675 const struct wim_dentry *d;
677 len = dentry_extraction_path_length(dentry);
679 ctx->pathbuf.Length = len * sizeof(wchar_t);
680 p = ctx->pathbuf.Buffer + len;
682 !dentry_is_root(d->d_parent) && will_extract_dentry(d->d_parent);
685 p -= d->d_extraction_name_nchars;
686 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
689 /* No leading slash */
690 p -= d->d_extraction_name_nchars;
691 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
694 /* Build the path at which to extract the @dentry, relative to the target
695 * directory, adding the suffix for a named data stream.
697 * The path is saved in ctx->pathbuf. */
699 build_extraction_path_with_ads(const struct wim_dentry *dentry,
700 struct win32_apply_ctx *ctx,
701 const wchar_t *stream_name,
702 size_t stream_name_nchars)
706 build_extraction_path(dentry, ctx);
708 /* Add :NAME for named data stream */
709 p = ctx->pathbuf.Buffer + (ctx->pathbuf.Length / sizeof(wchar_t));
711 wmemcpy(p, stream_name, stream_name_nchars);
712 ctx->pathbuf.Length += (1 + stream_name_nchars) * sizeof(wchar_t);
715 /* Build the Win32 namespace path to the specified @dentry when extracted.
717 * The path is saved in ctx->pathbuf and will be null terminated.
719 * XXX: We could get rid of this if it wasn't needed for the file encryption
720 * APIs, and the registry manipulation in WIMBoot mode. */
722 build_win32_extraction_path(const struct wim_dentry *dentry,
723 struct win32_apply_ctx *ctx)
725 build_extraction_path(dentry, ctx);
727 /* Prepend target_ntpath to our relative path, then change \??\ into \\?\ */
729 memmove(ctx->pathbuf.Buffer +
730 (ctx->target_ntpath.Length / sizeof(wchar_t)) + 1,
731 ctx->pathbuf.Buffer, ctx->pathbuf.Length);
732 memcpy(ctx->pathbuf.Buffer, ctx->target_ntpath.Buffer,
733 ctx->target_ntpath.Length);
734 ctx->pathbuf.Buffer[ctx->target_ntpath.Length / sizeof(wchar_t)] = L'\\';
735 ctx->pathbuf.Length += ctx->target_ntpath.Length + sizeof(wchar_t);
736 ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)] = L'\0';
738 wimlib_assert(ctx->pathbuf.Length >= 4 * sizeof(wchar_t) &&
739 !wmemcmp(ctx->pathbuf.Buffer, L"\\??\\", 4));
741 ctx->pathbuf.Buffer[1] = L'\\';
745 /* Returns a "printable" representation of the last relative NT path that was
746 * constructed with build_extraction_path() or build_extraction_path_with_ads().
748 * This will be overwritten by the next call to this function. */
749 static const wchar_t *
750 current_path(struct win32_apply_ctx *ctx)
752 wchar_t *p = ctx->print_buffer;
754 p = wmempcpy(p, ctx->common.target, ctx->common.target_nchars);
756 p = wmempcpy(p, ctx->pathbuf.Buffer, ctx->pathbuf.Length / sizeof(wchar_t));
758 return ctx->print_buffer;
761 /* Open handle to the target directory if it is not already open. If the target
762 * directory does not exist, this creates it. */
764 open_target_directory(struct win32_apply_ctx *ctx)
771 ctx->attr.Length = sizeof(ctx->attr);
772 ctx->attr.RootDirectory = NULL;
773 ctx->attr.ObjectName = &ctx->target_ntpath;
774 status = (*func_NtCreateFile)(&ctx->h_target,
780 FILE_SHARE_VALID_FLAGS,
782 FILE_DIRECTORY_FILE |
783 FILE_OPEN_REPARSE_POINT |
784 FILE_OPEN_FOR_BACKUP_INTENT,
787 if (!NT_SUCCESS(status)) {
788 winnt_error(status, L"Can't open or create directory \"%ls\"",
790 return WIMLIB_ERR_OPENDIR;
792 ctx->attr.RootDirectory = ctx->h_target;
793 ctx->attr.ObjectName = &ctx->pathbuf;
798 close_target_directory(struct win32_apply_ctx *ctx)
801 (*func_NtClose)(ctx->h_target);
802 ctx->h_target = NULL;
803 ctx->attr.RootDirectory = NULL;
808 * Ensures the target directory exists and opens a handle to it, in preparation
809 * of using paths relative to it.
812 prepare_target(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
817 ret = win32_path_to_nt_path(ctx->common.target, &ctx->target_ntpath);
821 ret = open_target_directory(ctx);
825 path_max = compute_path_max(dentry_list);
826 /* Add some extra for building Win32 paths for the file encryption APIs,
827 * and ensure we have at least enough to potentially use a 8.3 name for
828 * the last component. */
829 path_max += max(2 + (ctx->target_ntpath.Length / sizeof(wchar_t)),
832 ctx->pathbuf.MaximumLength = path_max * sizeof(wchar_t);
833 ctx->pathbuf.Buffer = MALLOC(ctx->pathbuf.MaximumLength);
834 if (!ctx->pathbuf.Buffer)
835 return WIMLIB_ERR_NOMEM;
837 ctx->print_buffer = MALLOC((ctx->common.target_nchars + 1 + path_max + 1) *
839 if (!ctx->print_buffer)
840 return WIMLIB_ERR_NOMEM;
845 /* When creating an inode that will have a short (DOS) name, we create it using
846 * the long name associated with the short name. This ensures that the short
847 * name gets associated with the correct long name. */
848 static struct wim_dentry *
849 first_extraction_alias(const struct wim_inode *inode)
851 struct list_head *next = inode->i_extraction_aliases.next;
852 struct wim_dentry *dentry;
855 dentry = list_entry(next, struct wim_dentry,
856 d_extraction_alias_node);
857 if (dentry_has_short_name(dentry))
860 } while (next != &inode->i_extraction_aliases);
865 * Set or clear FILE_ATTRIBUTE_COMPRESSED if the inherited value is different
866 * from the desired value.
868 * Note that you can NOT override the inherited value of
869 * FILE_ATTRIBUTE_COMPRESSED directly with NtCreateFile().
872 adjust_compression_attribute(HANDLE h, const struct wim_dentry *dentry,
873 struct win32_apply_ctx *ctx)
875 const bool compressed = (dentry->d_inode->i_attributes &
876 FILE_ATTRIBUTE_COMPRESSED);
878 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
881 if (!ctx->common.supported_features.compressed_files)
884 FILE_BASIC_INFORMATION info;
886 USHORT compression_state;
888 /* Get current attributes */
889 status = (*func_NtQueryInformationFile)(h, &ctx->iosb,
891 FileBasicInformation);
892 if (NT_SUCCESS(status) &&
893 compressed == !!(info.FileAttributes & FILE_ATTRIBUTE_COMPRESSED))
895 /* Nothing needs to be done. */
899 /* Set the new compression state */
902 compression_state = COMPRESSION_FORMAT_DEFAULT;
904 compression_state = COMPRESSION_FORMAT_NONE;
906 status = (*func_NtFsControlFile)(h,
911 FSCTL_SET_COMPRESSION,
916 if (NT_SUCCESS(status))
919 winnt_error(status, L"Can't %s compression attribute on \"%ls\"",
920 (compressed ? "set" : "clear"), current_path(ctx));
921 return WIMLIB_ERR_SET_ATTRIBUTES;
924 /* Try to enable short name support on the target volume. If successful, return
925 * true. If unsuccessful, issue a warning and return false. */
927 try_to_enable_short_names(const wchar_t *volume)
930 FILE_FS_PERSISTENT_VOLUME_INFORMATION info;
934 h = CreateFile(volume, GENERIC_WRITE,
935 FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
936 FILE_FLAG_BACKUP_SEMANTICS, NULL);
937 if (h == INVALID_HANDLE_VALUE)
940 info.VolumeFlags = 0;
941 info.FlagMask = PERSISTENT_VOLUME_STATE_SHORT_NAME_CREATION_DISABLED;
945 bret = DeviceIoControl(h, FSCTL_SET_PERSISTENT_VOLUME_STATE,
946 &info, sizeof(info), NULL, 0,
947 &bytesReturned, NULL);
956 win32_warning(GetLastError(),
957 L"Failed to enable short name support on %ls",
963 remove_conflicting_short_name(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
969 size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
970 (13 * sizeof(wchar_t));
971 u8 buf[bufsize] _aligned_attribute(8);
972 bool retried = false;
973 FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
975 memset(buf, 0, bufsize);
977 /* Build the path with the short name. */
978 name = &ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)];
979 while (name != ctx->pathbuf.Buffer && *(name - 1) != L'\\')
981 end = mempcpy(name, dentry->short_name, dentry->short_name_nbytes);
982 ctx->pathbuf.Length = ((u8 *)end - (u8 *)ctx->pathbuf.Buffer);
984 /* Open the conflicting file (by short name). */
985 status = (*func_NtOpenFile)(&h, GENERIC_WRITE | DELETE,
986 &ctx->attr, &ctx->iosb,
987 FILE_SHARE_VALID_FLAGS,
988 FILE_OPEN_REPARSE_POINT | FILE_OPEN_FOR_BACKUP_INTENT);
989 if (!NT_SUCCESS(status)) {
990 winnt_warning(status, L"Can't open \"%ls\"", current_path(ctx));
995 WARNING("Overriding conflicting short name; path=\"%ls\"",
999 /* Try to remove the short name on the conflicting file. */
1002 status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1003 FileShortNameInformation);
1005 if (status == STATUS_INVALID_PARAMETER && !retried) {
1007 /* Microsoft forgot to make it possible to remove short names
1008 * until Windows 7. Oops. Use a random short name instead. */
1010 info->FileNameLength = 12 * sizeof(wchar_t);
1011 for (int i = 0; i < 8; i++)
1012 info->FileName[i] = 'A' + (rand() % 26);
1013 info->FileName[8] = L'.';
1014 info->FileName[9] = L'W';
1015 info->FileName[10] = L'L';
1016 info->FileName[11] = L'B';
1017 info->FileName[12] = L'\0';
1023 build_extraction_path(dentry, ctx);
1027 /* Set the short name on the open file @h which has been created at the location
1028 * indicated by @dentry.
1030 * Note that this may add, change, or remove the short name.
1032 * @h must be opened with DELETE access.
1034 * Returns 0 or WIMLIB_ERR_SET_SHORT_NAME. The latter only happens in
1035 * STRICT_SHORT_NAMES mode.
1038 set_short_name(HANDLE h, const struct wim_dentry *dentry,
1039 struct win32_apply_ctx *ctx)
1042 if (!ctx->common.supported_features.short_names)
1046 * Note: The size of the FILE_NAME_INFORMATION buffer must be such that
1047 * FileName contains at least 2 wide characters (4 bytes). Otherwise,
1048 * NtSetInformationFile() will return STATUS_INFO_LENGTH_MISMATCH. This
1049 * is despite the fact that FileNameLength can validly be 0 or 2 bytes,
1050 * with the former case being removing the existing short name if
1051 * present, rather than setting one.
1053 * The null terminator is seemingly optional, but to be safe we include
1054 * space for it and zero all unused space.
1057 size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1058 max(dentry->short_name_nbytes, sizeof(wchar_t)) +
1060 u8 buf[bufsize] _aligned_attribute(8);
1061 FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1063 bool tried_to_remove_existing = false;
1065 memset(buf, 0, bufsize);
1067 info->FileNameLength = dentry->short_name_nbytes;
1068 memcpy(info->FileName, dentry->short_name, dentry->short_name_nbytes);
1071 status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1072 FileShortNameInformation);
1073 if (NT_SUCCESS(status))
1076 if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
1077 if (dentry->short_name_nbytes == 0)
1079 if (!ctx->tried_to_enable_short_names) {
1083 ctx->tried_to_enable_short_names = true;
1085 ret = win32_get_drive_path(ctx->common.target,
1089 if (try_to_enable_short_names(volume))
1095 * Short names can conflict in several cases:
1097 * - a file being extracted has a short name conflicting with an
1100 * - a file being extracted has a short name conflicting with another
1101 * file being extracted (possible, but shouldn't happen)
1103 * - a file being extracted has a short name that conflicts with the
1104 * automatically generated short name of a file we previously
1105 * extracted, but failed to set the short name for. Sounds unlikely,
1106 * but this actually does happen fairly often on versions of Windows
1107 * prior to Windows 7 because they do not support removing short names
1110 if (unlikely(status == STATUS_OBJECT_NAME_COLLISION) &&
1111 dentry->short_name_nbytes && !tried_to_remove_existing)
1113 tried_to_remove_existing = true;
1114 status = remove_conflicting_short_name(dentry, ctx);
1115 if (NT_SUCCESS(status))
1119 /* By default, failure to set short names is not an error (since short
1120 * names aren't too important anymore...). */
1121 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
1122 if (dentry->short_name_nbytes)
1123 ctx->num_set_short_name_failures++;
1125 ctx->num_remove_short_name_failures++;
1129 winnt_error(status, L"Can't set short name on \"%ls\"", current_path(ctx));
1130 return WIMLIB_ERR_SET_SHORT_NAME;
1134 * A wrapper around NtCreateFile() to make it slightly more usable...
1135 * This uses the path currently constructed in ctx->pathbuf.
1137 * Also, we always specify FILE_OPEN_FOR_BACKUP_INTENT and
1138 * FILE_OPEN_REPARSE_POINT.
1141 do_create_file(PHANDLE FileHandle,
1142 ACCESS_MASK DesiredAccess,
1143 PLARGE_INTEGER AllocationSize,
1144 ULONG FileAttributes,
1145 ULONG CreateDisposition,
1146 ULONG CreateOptions,
1147 struct win32_apply_ctx *ctx)
1149 return (*func_NtCreateFile)(FileHandle,
1155 FILE_SHARE_VALID_FLAGS,
1158 FILE_OPEN_FOR_BACKUP_INTENT |
1159 FILE_OPEN_REPARSE_POINT,
1164 /* Like do_create_file(), but builds the extraction path of the @dentry first.
1167 create_file(PHANDLE FileHandle,
1168 ACCESS_MASK DesiredAccess,
1169 PLARGE_INTEGER AllocationSize,
1170 ULONG FileAttributes,
1171 ULONG CreateDisposition,
1172 ULONG CreateOptions,
1173 const struct wim_dentry *dentry,
1174 struct win32_apply_ctx *ctx)
1176 build_extraction_path(dentry, ctx);
1177 return do_create_file(FileHandle,
1187 delete_file_or_stream(struct win32_apply_ctx *ctx)
1191 FILE_DISPOSITION_INFORMATION disposition_info;
1192 FILE_BASIC_INFORMATION basic_info;
1193 bool retried = false;
1195 status = do_create_file(&h,
1200 FILE_NON_DIRECTORY_FILE,
1202 if (unlikely(!NT_SUCCESS(status))) {
1203 winnt_error(status, L"Can't open \"%ls\" for deletion",
1205 return WIMLIB_ERR_OPEN;
1209 disposition_info.DoDeleteFile = TRUE;
1210 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1212 sizeof(disposition_info),
1213 FileDispositionInformation);
1215 if (likely(NT_SUCCESS(status)))
1218 if (status == STATUS_CANNOT_DELETE && !retried) {
1219 /* Clear file attributes and try again. This is necessary for
1220 * FILE_ATTRIBUTE_READONLY files. */
1221 status = do_create_file(&h,
1222 FILE_WRITE_ATTRIBUTES | DELETE,
1226 FILE_NON_DIRECTORY_FILE,
1228 if (!NT_SUCCESS(status)) {
1230 L"Can't open \"%ls\" to reset attributes",
1232 return WIMLIB_ERR_OPEN;
1234 memset(&basic_info, 0, sizeof(basic_info));
1235 basic_info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
1236 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1239 FileBasicInformation);
1240 if (!NT_SUCCESS(status)) {
1242 L"Can't reset file attributes on \"%ls\"",
1245 return WIMLIB_ERR_SET_ATTRIBUTES;
1250 winnt_error(status, L"Can't delete \"%ls\"", current_path(ctx));
1251 return WIMLIB_ERR_OPEN;
1255 * Create a nondirectory file or named data stream at the current path,
1256 * superseding any that already exists at that path. If successful, return an
1257 * open handle to the file or named data stream.
1260 supersede_file_or_stream(struct win32_apply_ctx *ctx, HANDLE *h_ret)
1263 bool retried = false;
1265 /* FILE_ATTRIBUTE_SYSTEM is needed to ensure that
1266 * FILE_ATTRIBUTE_ENCRYPTED doesn't get set before we want it to be. */
1268 status = do_create_file(h_ret,
1269 GENERIC_READ | GENERIC_WRITE | DELETE,
1271 FILE_ATTRIBUTE_SYSTEM,
1273 FILE_NON_DIRECTORY_FILE,
1275 if (likely(NT_SUCCESS(status)))
1278 /* STATUS_OBJECT_NAME_COLLISION means that the file or stream already
1279 * exists. Delete the existing file or stream, then try again.
1281 * Note: we don't use FILE_OVERWRITE_IF or FILE_SUPERSEDE because of
1282 * problems with certain file attributes, especially
1283 * FILE_ATTRIBUTE_ENCRYPTED. FILE_SUPERSEDE is also broken in the
1284 * Windows PE ramdisk. */
1285 if (status == STATUS_OBJECT_NAME_COLLISION && !retried) {
1286 int ret = delete_file_or_stream(ctx);
1292 winnt_error(status, L"Can't create \"%ls\"", current_path(ctx));
1293 return WIMLIB_ERR_OPEN;
1296 /* Create empty named data streams.
1298 * Since these won't have 'struct wim_lookup_table_entry's, they won't show up
1299 * in the call to extract_stream_list(). Hence the need for the special case.
1302 create_any_empty_ads(const struct wim_dentry *dentry,
1303 struct win32_apply_ctx *ctx)
1305 const struct wim_inode *inode = dentry->d_inode;
1306 bool path_modified = false;
1309 if (!ctx->common.supported_features.named_data_streams)
1312 for (u16 i = 0; i < inode->i_num_ads; i++) {
1313 const struct wim_ads_entry *entry;
1316 entry = &inode->i_ads_entries[i];
1319 if (!entry->stream_name_nbytes)
1326 build_extraction_path_with_ads(dentry, ctx,
1328 entry->stream_name_nbytes /
1330 path_modified = true;
1331 ret = supersede_file_or_stream(ctx, &h);
1336 /* Restore the path to the dentry itself */
1338 build_extraction_path(dentry, ctx);
1343 * Creates the directory named by @dentry, or uses an existing directory at that
1344 * location. If necessary, sets the short name and/or fixes compression and
1345 * encryption attributes.
1347 * Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
1350 create_directory(const struct wim_dentry *dentry,
1351 struct win32_apply_ctx *ctx)
1357 /* DELETE is needed for set_short_name(); GENERIC_READ and GENERIC_WRITE
1358 * are needed for adjust_compression_attribute().
1360 * FILE_ATTRIBUTE_SYSTEM is needed to ensure that
1361 * FILE_ATTRIBUTE_ENCRYPTED doesn't get set before we want it to be. */
1362 status = create_file(&h, GENERIC_READ | GENERIC_WRITE | DELETE, NULL,
1363 FILE_ATTRIBUTE_SYSTEM, FILE_OPEN_IF, FILE_DIRECTORY_FILE,
1365 if (!NT_SUCCESS(status)) {
1366 winnt_error(status, L"Can't create directory \"%ls\"",
1368 return WIMLIB_ERR_MKDIR;
1371 ret = set_short_name(h, dentry, ctx);
1374 ret = adjust_compression_attribute(h, dentry, ctx);
1381 * Create all the directories being extracted, other than the target directory
1384 * Note: we don't honor directory hard links. However, we don't allow them to
1385 * exist in WIM images anyway (see inode_fixup.c).
1388 create_directories(struct list_head *dentry_list,
1389 struct win32_apply_ctx *ctx)
1391 const struct wim_dentry *dentry;
1394 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1396 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
1399 /* Note: Here we include files with
1400 * FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
1401 * wait until later to actually set the reparse data. */
1403 /* If the root dentry is being extracted, it was already done so
1404 * in prepare_target(). */
1405 if (!dentry_is_root(dentry)) {
1406 ret = create_directory(dentry, ctx);
1407 ret = check_apply_error(dentry, ctx, ret);
1411 ret = create_any_empty_ads(dentry, ctx);
1412 ret = check_apply_error(dentry, ctx, ret);
1417 ret = report_file_created(&ctx->common);
1425 * Creates the nondirectory file named by @dentry.
1427 * On success, returns an open handle to the file in @h_ret, with GENERIC_READ,
1428 * GENERIC_WRITE, and DELETE access. Also, the path to the file will be saved
1429 * in ctx->pathbuf. On failure, returns an error code.
1432 create_nondirectory_inode(HANDLE *h_ret, const struct wim_dentry *dentry,
1433 struct win32_apply_ctx *ctx)
1438 build_extraction_path(dentry, ctx);
1440 ret = supersede_file_or_stream(ctx, &h);
1444 ret = adjust_compression_attribute(h, dentry, ctx);
1448 ret = create_any_empty_ads(dentry, ctx);
1461 /* Creates a hard link at the location named by @dentry to the file represented
1462 * by the open handle @h. Or, if the target volume does not support hard links,
1463 * create a separate file instead. */
1465 create_link(HANDLE h, const struct wim_dentry *dentry,
1466 struct win32_apply_ctx *ctx)
1468 if (ctx->common.supported_features.hard_links) {
1470 build_extraction_path(dentry, ctx);
1472 size_t bufsize = offsetof(FILE_LINK_INFORMATION, FileName) +
1473 ctx->pathbuf.Length + sizeof(wchar_t);
1474 u8 buf[bufsize] _aligned_attribute(8);
1475 FILE_LINK_INFORMATION *info = (FILE_LINK_INFORMATION *)buf;
1478 info->ReplaceIfExists = TRUE;
1479 info->RootDirectory = ctx->attr.RootDirectory;
1480 info->FileNameLength = ctx->pathbuf.Length;
1481 memcpy(info->FileName, ctx->pathbuf.Buffer, ctx->pathbuf.Length);
1482 info->FileName[info->FileNameLength / 2] = L'\0';
1484 /* Note: the null terminator isn't actually necessary,
1485 * but if you don't add the extra character, you get
1486 * STATUS_INFO_LENGTH_MISMATCH when FileNameLength
1487 * happens to be 2 */
1489 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1491 FileLinkInformation);
1492 if (NT_SUCCESS(status))
1494 winnt_error(status, L"Failed to create link \"%ls\"",
1496 return WIMLIB_ERR_LINK;
1501 ret = create_nondirectory_inode(&h2, dentry, ctx);
1505 (*func_NtClose)(h2);
1510 /* Given an inode (represented by the open handle @h) for which one link has
1511 * been created (named by @first_dentry), create the other links.
1513 * Or, if the target volume does not support hard links, create separate files.
1515 * Note: This uses ctx->pathbuf and does not reset it.
1518 create_links(HANDLE h, const struct wim_dentry *first_dentry,
1519 struct win32_apply_ctx *ctx)
1521 const struct wim_inode *inode;
1522 const struct list_head *next;
1523 const struct wim_dentry *dentry;
1526 inode = first_dentry->d_inode;
1527 next = inode->i_extraction_aliases.next;
1529 dentry = list_entry(next, struct wim_dentry,
1530 d_extraction_alias_node);
1531 if (dentry != first_dentry) {
1532 ret = create_link(h, dentry, ctx);
1537 } while (next != &inode->i_extraction_aliases);
1541 /* Create a nondirectory file, including all links. */
1543 create_nondirectory(struct wim_inode *inode, struct win32_apply_ctx *ctx)
1545 struct wim_dentry *first_dentry;
1549 first_dentry = first_extraction_alias(inode);
1551 /* Create first link. */
1552 ret = create_nondirectory_inode(&h, first_dentry, ctx);
1556 /* Set short name. */
1557 ret = set_short_name(h, first_dentry, ctx);
1559 /* Create additional links, OR if hard links are not supported just
1560 * create more files. */
1562 ret = create_links(h, first_dentry, ctx);
1564 /* "WIMBoot" extraction: set external backing by the WIM file if needed. */
1565 if (!ret && unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
1566 ret = set_external_backing(h, inode, ctx);
1572 /* Create all the nondirectory files being extracted, including all aliases
1575 create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1577 struct wim_dentry *dentry;
1578 struct wim_inode *inode;
1581 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1582 inode = dentry->d_inode;
1583 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1585 /* Call create_nondirectory() only once per inode */
1586 if (dentry == inode_first_extraction_dentry(inode)) {
1587 ret = create_nondirectory(inode, ctx);
1588 ret = check_apply_error(dentry, ctx, ret);
1592 ret = report_file_created(&ctx->common);
1600 close_handles(struct win32_apply_ctx *ctx)
1602 for (unsigned i = 0; i < ctx->num_open_handles; i++)
1603 (*func_NtClose)(ctx->open_handles[i]);
1606 /* Prepare to read the next stream, which has size @stream_size, into an
1607 * in-memory buffer. */
1609 prepare_data_buffer(struct win32_apply_ctx *ctx, u64 stream_size)
1611 if (stream_size > ctx->data_buffer_size) {
1612 /* Larger buffer needed. */
1614 if ((size_t)stream_size != stream_size)
1616 new_buffer = REALLOC(ctx->data_buffer, stream_size);
1619 ctx->data_buffer = new_buffer;
1620 ctx->data_buffer_size = stream_size;
1622 /* On the first call this changes data_buffer_ptr from NULL, which tells
1623 * extract_chunk() that the data buffer needs to be filled while reading
1624 * the stream data. */
1625 ctx->data_buffer_ptr = ctx->data_buffer;
1630 begin_extract_stream_instance(const struct wim_lookup_table_entry *stream,
1631 struct wim_dentry *dentry,
1632 const wchar_t *stream_name,
1633 struct win32_apply_ctx *ctx)
1635 const struct wim_inode *inode = dentry->d_inode;
1636 size_t stream_name_nchars = 0;
1637 FILE_ALLOCATION_INFORMATION alloc_info;
1641 if (unlikely(stream_name))
1642 stream_name_nchars = wcslen(stream_name);
1644 if (unlikely(stream_name_nchars)) {
1645 build_extraction_path_with_ads(dentry, ctx,
1646 stream_name, stream_name_nchars);
1648 build_extraction_path(dentry, ctx);
1652 /* Encrypted file? */
1653 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
1654 && (stream_name_nchars == 0))
1656 if (!ctx->common.supported_features.encrypted_files)
1659 /* We can't write encrypted file streams directly; we must use
1660 * WriteEncryptedFileRaw(), which requires providing the data
1661 * through a callback function. This can't easily be combined
1662 * with our own callback-based approach.
1664 * The current workaround is to simply read the stream into
1665 * memory and write the encrypted file from that.
1667 * TODO: This isn't sufficient for extremely large encrypted
1668 * files. Perhaps we should create an extra thread to write
1670 if (!prepare_data_buffer(ctx, stream->size))
1671 return WIMLIB_ERR_NOMEM;
1672 list_add_tail(&dentry->tmp_list, &ctx->encrypted_dentries);
1678 * Note: FILE_ATTRIBUTE_REPARSE_POINT is tested *after*
1679 * FILE_ATTRIBUTE_ENCRYPTED since the WIM format does not store both EFS
1680 * data and reparse data for the same file, and the EFS data takes
1682 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
1683 && (stream_name_nchars == 0))
1685 if (!ctx->common.supported_features.reparse_points)
1688 /* We can't write the reparse stream directly; we must set it
1689 * with FSCTL_SET_REPARSE_POINT, which requires that all the
1690 * data be available. So, stage the data in a buffer. */
1692 if (!prepare_data_buffer(ctx, stream->size))
1693 return WIMLIB_ERR_NOMEM;
1694 list_add_tail(&dentry->tmp_list, &ctx->reparse_dentries);
1698 if (ctx->num_open_handles == MAX_OPEN_STREAMS) {
1699 /* XXX: Fix this. But because of the checks in
1700 * extract_stream_list(), this can now only happen on a
1701 * filesystem that does not support hard links. */
1702 ERROR("Can't extract data: too many open files!");
1703 return WIMLIB_ERR_UNSUPPORTED;
1706 /* Open a new handle */
1707 status = do_create_file(&h,
1708 FILE_WRITE_DATA | SYNCHRONIZE,
1709 NULL, 0, FILE_OPEN_IF,
1710 FILE_SEQUENTIAL_ONLY |
1711 FILE_SYNCHRONOUS_IO_NONALERT,
1713 if (!NT_SUCCESS(status)) {
1714 winnt_error(status, L"Can't open \"%ls\" for writing",
1716 return WIMLIB_ERR_OPEN;
1719 ctx->open_handles[ctx->num_open_handles++] = h;
1721 /* Allocate space for the data. */
1722 alloc_info.AllocationSize.QuadPart = stream->size;
1723 (*func_NtSetInformationFile)(h, &ctx->iosb,
1724 &alloc_info, sizeof(alloc_info),
1725 FileAllocationInformation);
1729 /* Set the reparse data @rpbuf of length @rpbuflen on the extracted file
1730 * corresponding to the WIM dentry @dentry. */
1732 do_set_reparse_data(const struct wim_dentry *dentry,
1733 const void *rpbuf, u16 rpbuflen,
1734 struct win32_apply_ctx *ctx)
1739 status = create_file(&h, GENERIC_WRITE, NULL,
1740 0, FILE_OPEN, 0, dentry, ctx);
1741 if (!NT_SUCCESS(status))
1744 status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
1745 &ctx->iosb, FSCTL_SET_REPARSE_POINT,
1746 (void *)rpbuf, rpbuflen,
1750 if (NT_SUCCESS(status))
1753 /* On Windows, by default only the Administrator can create symbolic
1754 * links for some reason. By default we just issue a warning if this
1755 * appears to be the problem. Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
1756 * to get a hard error. */
1757 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
1758 && (status == STATUS_PRIVILEGE_NOT_HELD ||
1759 status == STATUS_ACCESS_DENIED)
1760 && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1761 dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1763 WARNING("Can't create symbolic link \"%ls\"! \n"
1764 " (Need Administrator rights, or at least "
1766 " SeCreateSymbolicLink privilege.)",
1772 winnt_error(status, L"Can't set reparse data on \"%ls\"",
1774 return WIMLIB_ERR_SET_REPARSE_DATA;
1777 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1778 * pointer to the suffix of the path that begins with the device directly, such
1779 * as e:\Windows\System32. */
1780 static const wchar_t *
1781 skip_nt_toplevel_component(const wchar_t *path, size_t path_nchars)
1783 static const wchar_t * const dirs[] = {
1788 size_t first_dir_len = 0;
1789 const wchar_t * const end = path + path_nchars;
1791 for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
1792 size_t len = wcslen(dirs[i]);
1793 if (len <= (end - path) && !wcsnicmp(path, dirs[i], len)) {
1794 first_dir_len = len;
1798 if (first_dir_len == 0)
1800 path += first_dir_len;
1801 while (path != end && *path == L'\\')
1806 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1807 * pointer to the suffix of the path that is device-relative, such as
1810 * The path has an explicit length and is not necessarily null terminated.
1812 * If the path just something like \??\e: then the returned pointer will point
1813 * just past the colon. In this case the length of the result will be 0
1815 static const wchar_t *
1816 get_device_relative_path(const wchar_t *path, size_t path_nchars)
1818 const wchar_t * const orig_path = path;
1819 const wchar_t * const end = path + path_nchars;
1821 path = skip_nt_toplevel_component(path, path_nchars);
1822 if (path == orig_path)
1825 path = wmemchr(path, L'\\', (end - path));
1830 } while (path != end && *path == L'\\');
1835 * Given a reparse point buffer for a symbolic link or junction, adjust its
1836 * contents so that the target of the link is consistent with the new location
1840 try_rpfix(u8 *rpbuf, u16 *rpbuflen_p, struct win32_apply_ctx *ctx)
1842 struct reparse_data rpdata;
1843 size_t orig_subst_name_nchars;
1844 const wchar_t *relpath;
1845 size_t relpath_nchars;
1846 size_t target_ntpath_nchars;
1847 size_t fixed_subst_name_nchars;
1848 const wchar_t *fixed_print_name;
1849 size_t fixed_print_name_nchars;
1851 if (parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata)) {
1852 /* Do nothing if the reparse data is invalid. */
1856 if (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK &&
1857 (rpdata.rpflags & SYMBOLIC_LINK_RELATIVE))
1859 /* Do nothing if it's a relative symbolic link. */
1863 /* Build the new substitute name from the NT namespace path to the
1864 * target directory, then a path separator, then the "device relative"
1865 * part of the old substitute name. */
1867 orig_subst_name_nchars = rpdata.substitute_name_nbytes / sizeof(wchar_t);
1869 relpath = get_device_relative_path(rpdata.substitute_name,
1870 orig_subst_name_nchars);
1871 relpath_nchars = orig_subst_name_nchars -
1872 (relpath - rpdata.substitute_name);
1874 target_ntpath_nchars = ctx->target_ntpath.Length / sizeof(wchar_t);
1876 fixed_subst_name_nchars = target_ntpath_nchars;
1878 fixed_subst_name_nchars += 1 + relpath_nchars;
1879 wchar_t fixed_subst_name[fixed_subst_name_nchars];
1881 wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer,
1882 target_ntpath_nchars);
1883 if (relpath_nchars) {
1884 fixed_subst_name[target_ntpath_nchars] = L'\\';
1885 wmemcpy(&fixed_subst_name[target_ntpath_nchars + 1],
1886 relpath, relpath_nchars);
1888 /* Doesn't need to be null-terminated. */
1890 /* Print name should be Win32, but not all NT names can even be
1891 * translated to Win32 names. But we can at least delete the top-level
1892 * directory, such as \??\, and this will have the expected result in
1893 * the usual case. */
1894 fixed_print_name = skip_nt_toplevel_component(fixed_subst_name,
1895 fixed_subst_name_nchars);
1896 fixed_print_name_nchars = fixed_subst_name_nchars - (fixed_print_name -
1899 rpdata.substitute_name = fixed_subst_name;
1900 rpdata.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
1901 rpdata.print_name = (wchar_t *)fixed_print_name;
1902 rpdata.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
1903 make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p);
1906 /* Sets reparse data on the specified file. This handles "fixing" the targets
1907 * of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX was
1910 set_reparse_data(const struct wim_dentry *dentry,
1911 const void *_rpbuf, u16 rpbuflen, struct win32_apply_ctx *ctx)
1913 const struct wim_inode *inode = dentry->d_inode;
1914 const void *rpbuf = _rpbuf;
1916 if ((ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
1917 && !inode->i_not_rpfixed
1918 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1919 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1921 memcpy(&ctx->rpfixbuf, _rpbuf, rpbuflen);
1922 try_rpfix((u8 *)&ctx->rpfixbuf, &rpbuflen, ctx);
1923 rpbuf = &ctx->rpfixbuf;
1925 return do_set_reparse_data(dentry, rpbuf, rpbuflen, ctx);
1929 /* Import the next block of raw encrypted data */
1931 import_encrypted_data(PBYTE pbData, PVOID pvCallbackContext, PULONG Length)
1933 struct win32_apply_ctx *ctx = pvCallbackContext;
1936 copy_len = min(ctx->encrypted_size - ctx->encrypted_offset, *Length);
1937 memcpy(pbData, &ctx->data_buffer[ctx->encrypted_offset], copy_len);
1938 ctx->encrypted_offset += copy_len;
1940 return ERROR_SUCCESS;
1944 * Write the raw encrypted data to the already-created file (or directory)
1945 * corresponding to @dentry.
1947 * The raw encrypted data is provided in ctx->data_buffer, and its size is
1948 * ctx->encrypted_size.
1950 * This function may close the target directory, in which case the caller needs
1951 * to re-open it if needed.
1954 extract_encrypted_file(const struct wim_dentry *dentry,
1955 struct win32_apply_ctx *ctx)
1962 /* Temporarily build a Win32 path for OpenEncryptedFileRaw() */
1963 build_win32_extraction_path(dentry, ctx);
1965 flags = CREATE_FOR_IMPORT | OVERWRITE_HIDDEN;
1966 if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1967 flags |= CREATE_FOR_DIR;
1971 err = OpenEncryptedFileRaw(ctx->pathbuf.Buffer, flags, &rawctx);
1972 if (err == ERROR_SHARING_VIOLATION && !retried) {
1973 /* This can be caused by the handle we have open to the target
1974 * directory. Try closing it temporarily. */
1975 close_target_directory(ctx);
1980 /* Restore the NT namespace path */
1981 build_extraction_path(dentry, ctx);
1983 if (err != ERROR_SUCCESS) {
1984 win32_error(err, L"Can't open \"%ls\" for encrypted import",
1986 return WIMLIB_ERR_OPEN;
1989 ctx->encrypted_offset = 0;
1991 err = WriteEncryptedFileRaw(import_encrypted_data, ctx, rawctx);
1993 CloseEncryptedFileRaw(rawctx);
1995 if (err != ERROR_SUCCESS) {
1996 win32_error(err, L"Can't import encrypted file \"%ls\"",
1998 return WIMLIB_ERR_WRITE;
2004 /* Called when starting to read a stream for extraction on Windows */
2006 begin_extract_stream(struct wim_lookup_table_entry *stream, void *_ctx)
2008 struct win32_apply_ctx *ctx = _ctx;
2009 const struct stream_owner *owners = stream_owners(stream);
2012 ctx->num_open_handles = 0;
2013 ctx->data_buffer_ptr = NULL;
2014 INIT_LIST_HEAD(&ctx->reparse_dentries);
2015 INIT_LIST_HEAD(&ctx->encrypted_dentries);
2017 for (u32 i = 0; i < stream->out_refcnt; i++) {
2018 const struct wim_inode *inode = owners[i].inode;
2019 const wchar_t *stream_name = owners[i].stream_name;
2020 struct wim_dentry *dentry;
2022 /* A copy of the stream needs to be extracted to @inode. */
2024 if (ctx->common.supported_features.hard_links) {
2025 dentry = inode_first_extraction_dentry(inode);
2026 ret = begin_extract_stream_instance(stream, dentry,
2028 ret = check_apply_error(dentry, ctx, ret);
2032 /* Hard links not supported. Extract the stream
2033 * separately to each alias of the inode. */
2034 struct list_head *next;
2036 next = inode->i_extraction_aliases.next;
2038 dentry = list_entry(next, struct wim_dentry,
2039 d_extraction_alias_node);
2040 ret = begin_extract_stream_instance(stream,
2044 ret = check_apply_error(dentry, ctx, ret);
2048 } while (next != &inode->i_extraction_aliases);
2059 /* Called when the next chunk of a stream has been read for extraction on
2062 extract_chunk(const void *chunk, size_t size, void *_ctx)
2064 struct win32_apply_ctx *ctx = _ctx;
2066 /* Write the data chunk to each open handle */
2067 for (unsigned i = 0; i < ctx->num_open_handles; i++) {
2068 u8 *bufptr = (u8 *)chunk;
2069 size_t bytes_remaining = size;
2071 while (bytes_remaining) {
2072 ULONG count = min(0xFFFFFFFF, bytes_remaining);
2074 status = (*func_NtWriteFile)(ctx->open_handles[i],
2076 &ctx->iosb, bufptr, count,
2078 if (!NT_SUCCESS(status)) {
2079 winnt_error(status, L"Error writing data to target volume");
2080 return WIMLIB_ERR_WRITE;
2082 bufptr += ctx->iosb.Information;
2083 bytes_remaining -= ctx->iosb.Information;
2087 /* Copy the data chunk into the buffer (if needed) */
2088 if (ctx->data_buffer_ptr)
2089 ctx->data_buffer_ptr = mempcpy(ctx->data_buffer_ptr,
2094 /* Called when a stream has been fully read for extraction on Windows */
2096 end_extract_stream(struct wim_lookup_table_entry *stream, int status, void *_ctx)
2098 struct win32_apply_ctx *ctx = _ctx;
2100 const struct wim_dentry *dentry;
2107 if (likely(!ctx->data_buffer_ptr))
2110 if (!list_empty(&ctx->reparse_dentries)) {
2111 if (stream->size > REPARSE_DATA_MAX_SIZE) {
2112 dentry = list_first_entry(&ctx->reparse_dentries,
2113 struct wim_dentry, tmp_list);
2114 build_extraction_path(dentry, ctx);
2115 ERROR("Reparse data of \"%ls\" has size "
2116 "%"PRIu64" bytes (exceeds %u bytes)",
2117 current_path(ctx), stream->size,
2118 REPARSE_DATA_MAX_SIZE);
2119 ret = WIMLIB_ERR_INVALID_REPARSE_DATA;
2120 return check_apply_error(dentry, ctx, ret);
2122 /* In the WIM format, reparse streams are just the reparse data
2123 * and omit the header. But we can reconstruct the header. */
2124 memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, stream->size);
2125 ctx->rpbuf.rpdatalen = stream->size;
2126 ctx->rpbuf.rpreserved = 0;
2127 list_for_each_entry(dentry, &ctx->reparse_dentries, tmp_list) {
2128 ctx->rpbuf.rptag = dentry->d_inode->i_reparse_tag;
2129 ret = set_reparse_data(dentry, &ctx->rpbuf,
2130 stream->size + REPARSE_DATA_OFFSET,
2132 ret = check_apply_error(dentry, ctx, ret);
2138 if (!list_empty(&ctx->encrypted_dentries)) {
2139 ctx->encrypted_size = stream->size;
2140 list_for_each_entry(dentry, &ctx->encrypted_dentries, tmp_list) {
2141 ret = extract_encrypted_file(dentry, ctx);
2142 ret = check_apply_error(dentry, ctx, ret);
2145 /* Re-open the target directory if needed. */
2146 ret = open_target_directory(ctx);
2155 /* Attributes that can't be set directly */
2156 #define SPECIAL_ATTRIBUTES \
2157 (FILE_ATTRIBUTE_REPARSE_POINT | \
2158 FILE_ATTRIBUTE_DIRECTORY | \
2159 FILE_ATTRIBUTE_ENCRYPTED | \
2160 FILE_ATTRIBUTE_SPARSE_FILE | \
2161 FILE_ATTRIBUTE_COMPRESSED)
2163 /* Set the security descriptor @desc, of @desc_size bytes, on the file with open
2166 set_security_descriptor(HANDLE h, const void *_desc,
2167 size_t desc_size, struct win32_apply_ctx *ctx)
2169 SECURITY_INFORMATION info;
2171 SECURITY_DESCRIPTOR_RELATIVE *desc;
2174 * Ideally, we would just pass in the security descriptor buffer as-is.
2175 * But it turns out that Windows can mess up the security descriptor
2176 * even when using the low-level NtSetSecurityObject() function:
2178 * - Windows will clear SE_DACL_AUTO_INHERITED if it is set in the
2179 * passed buffer. To actually get Windows to set
2180 * SE_DACL_AUTO_INHERITED, the application must set the non-persistent
2181 * flag SE_DACL_AUTO_INHERIT_REQ. As usual, Microsoft didn't bother
2182 * to properly document either of these flags. It's unclear how
2183 * important SE_DACL_AUTO_INHERITED actually is, but to be safe we use
2184 * the SE_DACL_AUTO_INHERIT_REQ workaround to set it if needed.
2186 * - The above also applies to the equivalent SACL flags,
2187 * SE_SACL_AUTO_INHERITED and SE_SACL_AUTO_INHERIT_REQ.
2189 * - If the application says that it's setting
2190 * DACL_SECURITY_INFORMATION, then Windows sets SE_DACL_PRESENT in the
2191 * resulting security descriptor, even if the security descriptor the
2192 * application provided did not have a DACL. This seems to be
2193 * unavoidable, since omitting DACL_SECURITY_INFORMATION would cause a
2194 * default DACL to remain. Fortunately, this behavior seems harmless,
2195 * since the resulting DACL will still be "null" --- but it will be
2196 * "the other representation of null".
2198 * - The above also applies to SACL_SECURITY_INFORMATION and
2199 * SE_SACL_PRESENT. Again, it's seemingly unavoidable but "harmless"
2200 * that Windows changes the representation of a "null SACL".
2202 if (likely(desc_size <= STACK_MAX)) {
2203 desc = alloca(desc_size);
2205 desc = MALLOC(desc_size);
2207 return STATUS_NO_MEMORY;
2210 memcpy(desc, _desc, desc_size);
2212 if (likely(desc_size >= 4)) {
2214 if (desc->Control & SE_DACL_AUTO_INHERITED)
2215 desc->Control |= SE_DACL_AUTO_INHERIT_REQ;
2217 if (desc->Control & SE_SACL_AUTO_INHERITED)
2218 desc->Control |= SE_SACL_AUTO_INHERIT_REQ;
2222 * More API insanity. We want to set the entire security descriptor
2223 * as-is. But all available APIs require specifying the specific parts
2224 * of the security descriptor being set. Especially annoying is that
2225 * mandatory integrity labels are part of the SACL, but they aren't set
2226 * with SACL_SECURITY_INFORMATION. Instead, applications must also
2227 * specify LABEL_SECURITY_INFORMATION (Windows Vista, Windows 7) or
2228 * BACKUP_SECURITY_INFORMATION (Windows 8). But at least older versions
2229 * of Windows don't error out if you provide these newer flags...
2231 * Also, if the process isn't running as Administrator, then it probably
2232 * doesn't have SE_RESTORE_PRIVILEGE. In this case, it will always get
2233 * the STATUS_PRIVILEGE_NOT_HELD error by trying to set the SACL, even
2234 * if the security descriptor it provided did not have a SACL. By
2235 * default, in this case we try to recover and set as much of the
2236 * security descriptor as possible --- potentially excluding the DACL, and
2237 * even the owner, as well as the SACL.
2240 info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
2241 DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION |
2242 LABEL_SECURITY_INFORMATION | BACKUP_SECURITY_INFORMATION;
2246 * It's also worth noting that SetFileSecurity() is unusable because it
2247 * doesn't request "backup semantics" when it opens the file internally.
2248 * NtSetSecurityObject() seems to be the best function to use in backup
2249 * applications. (SetSecurityInfo() should also work, but it's harder
2250 * to use and must call NtSetSecurityObject() internally anyway.
2251 * BackupWrite() is theoretically usable as well, but it's inflexible
2252 * and poorly documented.)
2256 status = (*func_NtSetSecurityObject)(h, info, desc);
2257 if (NT_SUCCESS(status))
2258 goto out_maybe_free_desc;
2260 /* Failed to set the requested parts of the security descriptor. If the
2261 * error was permissions-related, try to set fewer parts of the security
2262 * descriptor, unless WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled. */
2263 if ((status == STATUS_PRIVILEGE_NOT_HELD ||
2264 status == STATUS_ACCESS_DENIED) &&
2265 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2267 if (info & SACL_SECURITY_INFORMATION) {
2268 info &= ~(SACL_SECURITY_INFORMATION |
2269 LABEL_SECURITY_INFORMATION |
2270 BACKUP_SECURITY_INFORMATION);
2271 ctx->partial_security_descriptors++;
2274 if (info & DACL_SECURITY_INFORMATION) {
2275 info &= ~DACL_SECURITY_INFORMATION;
2278 if (info & OWNER_SECURITY_INFORMATION) {
2279 info &= ~OWNER_SECURITY_INFORMATION;
2282 /* Nothing left except GROUP, and if we removed it we
2283 * wouldn't have anything at all. */
2286 /* No part of the security descriptor could be set, or
2287 * WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled and the full security
2288 * descriptor could not be set. */
2289 if (!(info & SACL_SECURITY_INFORMATION))
2290 ctx->partial_security_descriptors--;
2291 ctx->no_security_descriptors++;
2293 out_maybe_free_desc:
2294 if (unlikely(desc_size > STACK_MAX))
2299 /* Set metadata on the open file @h from the WIM inode @inode. */
2301 do_apply_metadata_to_file(HANDLE h, const struct wim_inode *inode,
2302 struct win32_apply_ctx *ctx)
2304 FILE_BASIC_INFORMATION info;
2307 /* Set security descriptor if present and not in NO_ACLS mode */
2308 if (inode->i_security_id >= 0 &&
2309 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
2311 const struct wim_security_data *sd;
2315 sd = wim_get_current_security_data(ctx->common.wim);
2316 desc = sd->descriptors[inode->i_security_id];
2317 desc_size = sd->sizes[inode->i_security_id];
2319 status = set_security_descriptor(h, desc, desc_size, ctx);
2320 if (!NT_SUCCESS(status) &&
2321 (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2324 L"Can't set security descriptor on \"%ls\"",
2326 return WIMLIB_ERR_SET_SECURITY;
2330 /* Set attributes and timestamps */
2331 info.CreationTime.QuadPart = inode->i_creation_time;
2332 info.LastAccessTime.QuadPart = inode->i_last_access_time;
2333 info.LastWriteTime.QuadPart = inode->i_last_write_time;
2334 info.ChangeTime.QuadPart = 0;
2335 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) {
2336 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
2338 info.FileAttributes = inode->i_attributes & ~SPECIAL_ATTRIBUTES;
2339 if (info.FileAttributes == 0)
2340 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
2343 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
2344 &info, sizeof(info),
2345 FileBasicInformation);
2346 /* On FAT volumes we get STATUS_INVALID_PARAMETER if we try to set
2347 * attributes on the root directory. (Apparently because FAT doesn't
2348 * actually have a place to store those attributes!) */
2349 if (!NT_SUCCESS(status)
2350 && !(status == STATUS_INVALID_PARAMETER &&
2351 dentry_is_root(inode_first_extraction_dentry(inode))))
2353 winnt_error(status, L"Can't set basic metadata on \"%ls\"",
2355 return WIMLIB_ERR_SET_ATTRIBUTES;
2362 apply_metadata_to_file(const struct wim_dentry *dentry,
2363 struct win32_apply_ctx *ctx)
2365 const struct wim_inode *inode = dentry->d_inode;
2371 perms = FILE_WRITE_ATTRIBUTES | WRITE_DAC |
2372 WRITE_OWNER | ACCESS_SYSTEM_SECURITY;
2374 build_extraction_path(dentry, ctx);
2376 /* Open a handle with as many relevant permissions as possible. */
2377 while (!NT_SUCCESS(status = do_create_file(&h, perms, NULL,
2378 0, FILE_OPEN, 0, ctx)))
2380 if (status == STATUS_PRIVILEGE_NOT_HELD ||
2381 status == STATUS_ACCESS_DENIED)
2383 if (perms & ACCESS_SYSTEM_SECURITY) {
2384 perms &= ~ACCESS_SYSTEM_SECURITY;
2387 if (perms & WRITE_DAC) {
2388 perms &= ~WRITE_DAC;
2391 if (perms & WRITE_OWNER) {
2392 perms &= ~WRITE_OWNER;
2396 winnt_error(status, L"Can't open \"%ls\" to set metadata",
2398 return WIMLIB_ERR_OPEN;
2401 ret = do_apply_metadata_to_file(h, inode, ctx);
2409 apply_metadata(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
2411 const struct wim_dentry *dentry;
2414 /* We go in reverse so that metadata is set on all a directory's
2415 * children before the directory itself. This avoids any potential
2416 * problems with attributes, timestamps, or security descriptors. */
2417 list_for_each_entry_reverse(dentry, dentry_list, d_extraction_list_node)
2419 ret = apply_metadata_to_file(dentry, ctx);
2420 ret = check_apply_error(dentry, ctx, ret);
2423 ret = report_file_metadata_applied(&ctx->common);
2430 /* Issue warnings about problems during the extraction for which warnings were
2431 * not already issued (due to the high number of potential warnings if we issued
2432 * them per-file). */
2434 do_warnings(const struct win32_apply_ctx *ctx)
2436 if (ctx->partial_security_descriptors == 0
2437 && ctx->no_security_descriptors == 0
2438 && ctx->num_set_short_name_failures == 0
2440 && ctx->num_remove_short_name_failures == 0
2445 WARNING("Extraction to \"%ls\" complete, but with one or more warnings:",
2446 ctx->common.target);
2447 if (ctx->num_set_short_name_failures) {
2448 WARNING("- Could not set short names on %lu files or directories",
2449 ctx->num_set_short_name_failures);
2452 if (ctx->num_remove_short_name_failures) {
2453 WARNING("- Could not remove short names on %lu files or directories"
2454 " (This is expected on Vista and earlier)",
2455 ctx->num_remove_short_name_failures);
2458 if (ctx->partial_security_descriptors) {
2459 WARNING("- Could only partially set the security descriptor\n"
2460 " on %lu files or directories.",
2461 ctx->partial_security_descriptors);
2463 if (ctx->no_security_descriptors) {
2464 WARNING("- Could not set security descriptor at all\n"
2465 " on %lu files or directories.",
2466 ctx->no_security_descriptors);
2468 if (ctx->partial_security_descriptors || ctx->no_security_descriptors) {
2469 WARNING("To fully restore all security descriptors, run the program\n"
2470 " with Administrator rights.");
2475 count_dentries(const struct list_head *dentry_list)
2477 const struct list_head *cur;
2480 list_for_each(cur, dentry_list)
2486 /* Extract files from a WIM image to a directory on Windows */
2488 win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
2491 struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
2492 uint64_t dentry_count;
2494 ret = prepare_target(dentry_list, ctx);
2498 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2499 ret = start_wimboot_extraction(ctx);
2504 dentry_count = count_dentries(dentry_list);
2506 ret = start_file_structure_phase(&ctx->common, dentry_count);
2510 ret = create_directories(dentry_list, ctx);
2514 ret = create_nondirectories(dentry_list, ctx);
2518 ret = end_file_structure_phase(&ctx->common);
2522 struct read_stream_list_callbacks cbs = {
2523 .begin_stream = begin_extract_stream,
2524 .begin_stream_ctx = ctx,
2525 .consume_chunk = extract_chunk,
2526 .consume_chunk_ctx = ctx,
2527 .end_stream = end_extract_stream,
2528 .end_stream_ctx = ctx,
2530 ret = extract_stream_list(&ctx->common, &cbs);
2534 ret = start_file_metadata_phase(&ctx->common, dentry_count);
2538 ret = apply_metadata(dentry_list, ctx);
2542 ret = end_file_metadata_phase(&ctx->common);
2546 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2547 ret = end_wimboot_extraction(ctx);
2554 close_target_directory(ctx);
2555 if (ctx->target_ntpath.Buffer)
2556 HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
2557 FREE(ctx->pathbuf.Buffer);
2558 FREE(ctx->print_buffer);
2559 if (ctx->wimboot.prepopulate_pats) {
2560 FREE(ctx->wimboot.prepopulate_pats->strings);
2561 FREE(ctx->wimboot.prepopulate_pats);
2563 FREE(ctx->wimboot.mem_prepopulate_pats);
2564 FREE(ctx->data_buffer);
2568 const struct apply_operations win32_apply_ops = {
2570 .get_supported_features = win32_get_supported_features,
2571 .extract = win32_extract,
2572 .will_externally_back = win32_will_externally_back,
2573 .context_size = sizeof(struct win32_apply_ctx),
2576 #endif /* __WIN32__ */