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/capture.h" /* for mangle_pat() and match_pattern_list() */
32 #include "wimlib/dentry.h"
33 #include "wimlib/error.h"
34 #include "wimlib/lookup_table.h"
35 #include "wimlib/metadata.h"
36 #include "wimlib/reparse.h"
37 #include "wimlib/textfile.h"
38 #include "wimlib/xml.h"
39 #include "wimlib/wildcard.h"
40 #include "wimlib/wimboot.h"
42 struct win32_apply_ctx {
44 /* Extract flags, the pointer to the WIMStruct, etc. */
45 struct apply_ctx common;
47 /* WIMBoot information, only filled in if WIMLIB_EXTRACT_FLAG_WIMBOOT
51 struct string_set *prepopulate_pats;
52 void *mem_prepopulate_pats;
53 u8 wim_lookup_table_hash[SHA1_HASH_SIZE];
55 bool tried_to_load_prepopulate_list;
58 /* Open handle to the target directory */
61 /* NT namespace path to the target directory (buffer allocated) */
62 UNICODE_STRING target_ntpath;
64 /* Temporary buffer for building paths (buffer allocated) */
65 UNICODE_STRING pathbuf;
67 /* Object attributes to reuse for opening files in the target directory.
68 * (attr.ObjectName == &pathbuf) and (attr.RootDirectory == h_target).
70 OBJECT_ATTRIBUTES attr;
72 /* Temporary I/O status block for system calls */
75 /* Allocated buffer for creating "printable" paths from our
76 * target-relative NT paths */
77 wchar_t *print_buffer;
79 /* Allocated buffer for reading stream data when it cannot be extracted
83 /* Pointer to the next byte in @data_buffer to fill */
86 /* Size allocated in @data_buffer */
87 size_t data_buffer_size;
89 /* Current offset in the raw encrypted file being written */
90 size_t encrypted_offset;
92 /* Current size of the raw encrypted file being written */
93 size_t encrypted_size;
95 /* Temporary buffer for reparse data */
96 struct reparse_buffer_disk rpbuf;
98 /* Temporary buffer for reparse data of "fixed" absolute symbolic links
100 struct reparse_buffer_disk rpfixbuf;
102 /* Array of open handles to filesystem streams currently being written
104 HANDLE open_handles[MAX_OPEN_STREAMS];
106 /* Number of handles in @open_handles currently open (filled in from the
107 * beginning of the array) */
108 unsigned num_open_handles;
110 /* List of dentries, joined by @tmp_list, that need to have reparse data
111 * extracted as soon as the whole stream has been read into
113 struct list_head reparse_dentries;
115 /* List of dentries, joined by @tmp_list, that need to have raw
116 * encrypted data extracted as soon as the whole stream has been read
117 * into @data_buffer. */
118 struct list_head encrypted_dentries;
120 /* Number of files for which we didn't have permission to set the full
121 * security descriptor. */
122 unsigned long partial_security_descriptors;
124 /* Number of files for which we didn't have permission to set any part
125 * of the security descriptor. */
126 unsigned long no_security_descriptors;
128 /* Number of files for which we couldn't set the short name. */
129 unsigned long num_set_short_name_failures;
131 /* Number of files for which we couldn't remove the short name. */
132 unsigned long num_remove_short_name_failures;
134 /* Have we tried to enable short name support on the target volume yet?
136 bool tried_to_enable_short_names;
139 /* Get the drive letter from a Windows path, or return the null character if the
140 * path is relative. */
142 get_drive_letter(const wchar_t *path)
144 /* Skip \\?\ prefix */
145 if (!wcsncmp(path, L"\\\\?\\", 4))
148 /* Return drive letter if valid */
149 if (((path[0] >= L'a' && path[0] <= L'z') ||
150 (path[0] >= L'A' && path[0] <= L'Z')) && path[1] == L':')
157 get_vol_flags(const wchar_t *target, DWORD *vol_flags_ret,
158 bool *short_names_supported_ret)
160 wchar_t filesystem_name[MAX_PATH + 1];
162 wchar_t *volume = NULL;
165 *short_names_supported_ret = false;
167 drive[0] = get_drive_letter(target);
175 if (!GetVolumeInformation(volume, NULL, 0, NULL, NULL,
176 vol_flags_ret, filesystem_name,
177 ARRAY_LEN(filesystem_name)))
179 DWORD err = GetLastError();
180 set_errno_from_win32_error(err);
181 WARNING_WITH_ERRNO("Failed to get volume information for "
182 "\"%ls\" (err=%"PRIu32")",
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 set_errno_from_win32_error(err);
484 ERROR_WITH_ERRNO("\"%ls\": Couldn't set WIMBoot "
485 "pointer data (err=%"PRIu32")",
486 current_path(ctx), (u32)err);
487 return WIMLIB_ERR_WIMBOOT;
493 /* Calculates the SHA-1 message digest of the WIM's lookup table. */
495 hash_lookup_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
497 return wim_reshdr_to_hash(&wim->hdr.lookup_table_reshdr, wim, hash);
500 /* Prepare for doing a "WIMBoot" extraction by loading patterns from
501 * [PrepopulateList] of WimBootCompress.ini and allocating a WOF data source ID
502 * on the target volume. */
504 start_wimboot_extraction(struct win32_apply_ctx *ctx)
507 WIMStruct *wim = ctx->common.wim;
509 if (!ctx->wimboot.tried_to_load_prepopulate_list)
510 if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
511 return WIMLIB_ERR_NOMEM;
513 if (!wim_info_get_wimboot(wim->wim_info, wim->current_image))
514 WARNING("Image is not marked as WIMBoot compatible!");
516 ret = hash_lookup_table(ctx->common.wim,
517 ctx->wimboot.wim_lookup_table_hash);
521 return wimboot_alloc_data_source_id(wim->filename,
525 &ctx->wimboot.data_source_id,
526 &ctx->wimboot.wof_running);
530 build_win32_extraction_path(const struct wim_dentry *dentry,
531 struct win32_apply_ctx *ctx);
533 /* Sets WimBoot=1 in the extracted SYSTEM registry hive.
535 * WIMGAPI does this, and it's possible that it's important.
536 * But I don't know exactly what this value means to Windows. */
538 end_wimboot_extraction(struct win32_apply_ctx *ctx)
540 struct wim_dentry *dentry;
541 wchar_t subkeyname[32];
547 dentry = get_dentry(ctx->common.wim, L"\\Windows\\System32\\config\\SYSTEM",
548 WIMLIB_CASE_INSENSITIVE);
550 if (!dentry || !will_extract_dentry(dentry))
553 if (!will_extract_dentry(wim_get_current_root_dentry(ctx->common.wim)))
556 /* Not bothering to use the native routines (e.g. NtLoadKey()) for this.
557 * If this doesn't work, you probably also have many other problems. */
559 build_win32_extraction_path(dentry, ctx);
561 randomize_char_array_with_alnum(subkeyname, 20);
562 subkeyname[20] = L'\0';
564 res = RegLoadKey(HKEY_LOCAL_MACHINE, subkeyname, ctx->pathbuf.Buffer);
568 wcscpy(&subkeyname[20], L"\\Setup");
570 res = RegCreateKeyEx(HKEY_LOCAL_MACHINE, subkeyname, 0, NULL,
571 REG_OPTION_BACKUP_RESTORE, 0, NULL, &key, NULL);
577 res = RegSetValueEx(key, L"WimBoot", 0, REG_DWORD,
578 (const BYTE *)&value, sizeof(DWORD));
582 res = RegFlushKey(key);
585 res2 = RegCloseKey(key);
589 subkeyname[20] = L'\0';
590 RegUnLoadKey(HKEY_LOCAL_MACHINE, subkeyname);
594 set_errno_from_win32_error(res);
595 WARNING_WITH_ERRNO("Failed to set \\Setup: dword \"WimBoot\"=1 value "
596 "in registry hive \"%ls\" (err=%"PRIu32")",
597 ctx->pathbuf.Buffer, (u32)res);
603 /* Returns the number of wide characters needed to represent the path to the
604 * specified @dentry, relative to the target directory, when extracted.
606 * Does not include null terminator (not needed for NtCreateFile). */
608 dentry_extraction_path_length(const struct wim_dentry *dentry)
611 const struct wim_dentry *d;
615 len += d->d_extraction_name_nchars + 1;
617 } while (!dentry_is_root(d) && will_extract_dentry(d));
619 return --len; /* No leading slash */
622 /* Returns the length of the longest string that might need to be appended to
623 * the path to an alias of an inode to open or create a named data stream.
625 * If the inode has no named data streams, this will be 0. Otherwise, this will
626 * be 1 plus the length of the longest-named data stream, since the data stream
627 * name must be separated from the path by the ':' character. */
629 inode_longest_named_data_stream_spec(const struct wim_inode *inode)
632 for (u16 i = 0; i < inode->i_num_ads; i++) {
633 size_t len = inode->i_ads_entries[i].stream_name_nbytes;
638 max = 1 + (max / sizeof(wchar_t));
642 /* Find the length, in wide characters, of the longest path needed for
643 * extraction of any file in @dentry_list relative to the target directory.
645 * Accounts for named data streams, but does not include null terminator (not
646 * needed for NtCreateFile). */
648 compute_path_max(struct list_head *dentry_list)
651 const struct wim_dentry *dentry;
653 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
656 len = dentry_extraction_path_length(dentry);
658 /* Account for named data streams */
659 len += inode_longest_named_data_stream_spec(dentry->d_inode);
668 /* Build the path at which to extract the @dentry, relative to the target
671 * The path is saved in ctx->pathbuf. */
673 build_extraction_path(const struct wim_dentry *dentry,
674 struct win32_apply_ctx *ctx)
678 const struct wim_dentry *d;
680 len = dentry_extraction_path_length(dentry);
682 ctx->pathbuf.Length = len * sizeof(wchar_t);
683 p = ctx->pathbuf.Buffer + len;
685 !dentry_is_root(d->d_parent) && will_extract_dentry(d->d_parent);
688 p -= d->d_extraction_name_nchars;
689 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
692 /* No leading slash */
693 p -= d->d_extraction_name_nchars;
694 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
697 /* Build the path at which to extract the @dentry, relative to the target
698 * directory, adding the suffix for a named data stream.
700 * The path is saved in ctx->pathbuf. */
702 build_extraction_path_with_ads(const struct wim_dentry *dentry,
703 struct win32_apply_ctx *ctx,
704 const wchar_t *stream_name,
705 size_t stream_name_nchars)
709 build_extraction_path(dentry, ctx);
711 /* Add :NAME for named data stream */
712 p = ctx->pathbuf.Buffer + (ctx->pathbuf.Length / sizeof(wchar_t));
714 wmemcpy(p, stream_name, stream_name_nchars);
715 ctx->pathbuf.Length += (1 + stream_name_nchars) * sizeof(wchar_t);
718 /* Build the Win32 namespace path to the specified @dentry when extracted.
720 * The path is saved in ctx->pathbuf and will be null terminated.
722 * XXX: We could get rid of this if it wasn't needed for the file encryption
723 * APIs, and the registry manipulation in WIMBoot mode. */
725 build_win32_extraction_path(const struct wim_dentry *dentry,
726 struct win32_apply_ctx *ctx)
728 build_extraction_path(dentry, ctx);
730 /* Prepend target_ntpath to our relative path, then change \??\ into \\?\ */
732 memmove(ctx->pathbuf.Buffer +
733 (ctx->target_ntpath.Length / sizeof(wchar_t)) + 1,
734 ctx->pathbuf.Buffer, ctx->pathbuf.Length);
735 memcpy(ctx->pathbuf.Buffer, ctx->target_ntpath.Buffer,
736 ctx->target_ntpath.Length);
737 ctx->pathbuf.Buffer[ctx->target_ntpath.Length / sizeof(wchar_t)] = L'\\';
738 ctx->pathbuf.Length += ctx->target_ntpath.Length + sizeof(wchar_t);
739 ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)] = L'\0';
741 wimlib_assert(ctx->pathbuf.Length >= 4 * sizeof(wchar_t) &&
742 !wmemcmp(ctx->pathbuf.Buffer, L"\\??\\", 4));
744 ctx->pathbuf.Buffer[1] = L'\\';
748 /* Returns a "printable" representation of the last relative NT path that was
749 * constructed with build_extraction_path() or build_extraction_path_with_ads().
751 * This will be overwritten by the next call to this function. */
752 static const wchar_t *
753 current_path(struct win32_apply_ctx *ctx)
755 wchar_t *p = ctx->print_buffer;
757 p = wmempcpy(p, ctx->common.target, ctx->common.target_nchars);
759 p = wmempcpy(p, ctx->pathbuf.Buffer, ctx->pathbuf.Length / sizeof(wchar_t));
761 return ctx->print_buffer;
765 * Ensures the target directory exists and opens a handle to it, in preparation
766 * of using paths relative to it.
769 prepare_target(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
775 /* Open handle to the target directory (possibly creating it). */
777 ret = win32_path_to_nt_path(ctx->common.target, &ctx->target_ntpath);
781 ctx->attr.Length = sizeof(ctx->attr);
782 ctx->attr.ObjectName = &ctx->target_ntpath;
784 status = (*func_NtCreateFile)(&ctx->h_target,
790 FILE_SHARE_VALID_FLAGS,
792 FILE_DIRECTORY_FILE |
793 FILE_OPEN_REPARSE_POINT |
794 FILE_OPEN_FOR_BACKUP_INTENT,
798 if (!NT_SUCCESS(status)) {
799 set_errno_from_nt_status(status);
800 ERROR_WITH_ERRNO("Can't open or create directory \"%ls\" "
801 "(status=0x%08"PRIx32")",
802 ctx->common.target, (u32)status);
803 return WIMLIB_ERR_OPENDIR;
806 path_max = compute_path_max(dentry_list);
808 /* Add some extra for building Win32 paths for the file encryption APIs,
809 * and ensure we have at least enough to potentially use a 8.3 name for
810 * the last component. */
811 path_max += max(2 + (ctx->target_ntpath.Length / sizeof(wchar_t)),
814 ctx->pathbuf.MaximumLength = path_max * sizeof(wchar_t);
815 ctx->pathbuf.Buffer = MALLOC(ctx->pathbuf.MaximumLength);
816 if (!ctx->pathbuf.Buffer)
817 return WIMLIB_ERR_NOMEM;
819 ctx->attr.RootDirectory = ctx->h_target;
820 ctx->attr.ObjectName = &ctx->pathbuf;
822 ctx->print_buffer = MALLOC((ctx->common.target_nchars + 1 + path_max + 1) *
824 if (!ctx->print_buffer)
825 return WIMLIB_ERR_NOMEM;
830 /* When creating an inode that will have a short (DOS) name, we create it using
831 * the long name associated with the short name. This ensures that the short
832 * name gets associated with the correct long name. */
833 static struct wim_dentry *
834 first_extraction_alias(const struct wim_inode *inode)
836 struct list_head *next = inode->i_extraction_aliases.next;
837 struct wim_dentry *dentry;
840 dentry = list_entry(next, struct wim_dentry,
841 d_extraction_alias_node);
842 if (dentry_has_short_name(dentry))
845 } while (next != &inode->i_extraction_aliases);
850 * Set or clear FILE_ATTRIBUTE_COMPRESSED if the inherited value is different
851 * from the desired value.
853 * Note that you can NOT override the inherited value of
854 * FILE_ATTRIBUTE_COMPRESSED directly with NtCreateFile().
857 adjust_compression_attribute(HANDLE h, const struct wim_dentry *dentry,
858 struct win32_apply_ctx *ctx)
860 const bool compressed = (dentry->d_inode->i_attributes &
861 FILE_ATTRIBUTE_COMPRESSED);
863 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
866 if (!ctx->common.supported_features.compressed_files)
869 FILE_BASIC_INFORMATION info;
871 USHORT compression_state;
873 /* Get current attributes */
874 status = (*func_NtQueryInformationFile)(h, &ctx->iosb,
876 FileBasicInformation);
877 if (NT_SUCCESS(status) &&
878 compressed == !!(info.FileAttributes & FILE_ATTRIBUTE_COMPRESSED))
880 /* Nothing needs to be done. */
884 /* Set the new compression state */
887 compression_state = COMPRESSION_FORMAT_DEFAULT;
889 compression_state = COMPRESSION_FORMAT_NONE;
891 status = (*func_NtFsControlFile)(h,
896 FSCTL_SET_COMPRESSION,
901 if (NT_SUCCESS(status))
904 set_errno_from_nt_status(status);
905 ERROR_WITH_ERRNO("Can't %s compression attribute on \"%ls\" "
906 "(status=0x%08"PRIx32")",
907 (compressed ? "set" : "clear"),
908 current_path(ctx), status);
909 return WIMLIB_ERR_SET_ATTRIBUTES;
913 * Clear FILE_ATTRIBUTE_ENCRYPTED if the file or directory is not supposed to be
916 * You can provide FILE_ATTRIBUTE_ENCRYPTED to NtCreateFile() to set it on the
917 * created file. However, the file or directory will otherwise default to the
918 * encryption state of the parent directory. This function works around this
919 * limitation by using DecryptFile() to remove FILE_ATTRIBUTE_ENCRYPTED on files
920 * (and directories) that are not supposed to have it set.
922 * Regardless of whether it succeeds or fails, this function may close the
923 * handle to the file. If it does, it sets it to NULL.
926 maybe_clear_encryption_attribute(HANDLE *h_ptr, const struct wim_dentry *dentry,
927 struct win32_apply_ctx *ctx)
929 if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
932 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
935 if (!ctx->common.supported_features.encrypted_files)
938 FILE_BASIC_INFORMATION info;
942 /* Get current attributes */
943 status = (*func_NtQueryInformationFile)(*h_ptr, &ctx->iosb,
945 FileBasicInformation);
946 if (NT_SUCCESS(status) &&
947 !(info.FileAttributes & FILE_ATTRIBUTE_ENCRYPTED))
949 /* Nothing needs to be done. */
953 /* Set the new encryption state */
955 /* Due to Windows' crappy file encryption APIs, we need to close the
956 * handle to the file so we don't get ERROR_SHARING_VIOLATION. We also
957 * hack together a Win32 path, although we will use the \\?\ prefix so
958 * it will actually be a NT path in disguise... */
959 (*func_NtClose)(*h_ptr);
962 build_win32_extraction_path(dentry, ctx);
964 bret = DecryptFile(ctx->pathbuf.Buffer, 0);
966 /* Restore the NT namespace path */
967 build_extraction_path(dentry, ctx);
970 DWORD err = GetLastError();
971 set_errno_from_win32_error(err);
972 ERROR_WITH_ERRNO("Can't decrypt file \"%ls\" (err=%"PRIu32")",
973 current_path(ctx), (u32)err);
974 return WIMLIB_ERR_SET_ATTRIBUTES;
979 /* Try to enable short name support on the target volume. If successful, return
980 * true. If unsuccessful, issue a warning and return false. */
982 try_to_enable_short_names(const wchar_t *volume)
985 FILE_FS_PERSISTENT_VOLUME_INFORMATION info;
989 h = CreateFile(volume, GENERIC_WRITE,
990 FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
991 FILE_FLAG_BACKUP_SEMANTICS, NULL);
992 if (h == INVALID_HANDLE_VALUE)
995 info.VolumeFlags = 0;
996 info.FlagMask = PERSISTENT_VOLUME_STATE_SHORT_NAME_CREATION_DISABLED;
1000 bret = DeviceIoControl(h, FSCTL_SET_PERSISTENT_VOLUME_STATE,
1001 &info, sizeof(info), NULL, 0,
1002 &bytesReturned, NULL);
1011 WARNING("Failed to enable short name support on %ls "
1012 "(err=%"PRIu32")", volume + 4, (u32)GetLastError());
1017 remove_conflicting_short_name(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
1023 size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1024 (13 * sizeof(wchar_t));
1025 u8 buf[bufsize] _aligned_attribute(8);
1026 bool retried = false;
1027 FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1029 memset(buf, 0, bufsize);
1031 /* Build the path with the short name. */
1032 name = &ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)];
1033 while (name != ctx->pathbuf.Buffer && *(name - 1) != L'\\')
1035 end = mempcpy(name, dentry->short_name, dentry->short_name_nbytes);
1036 ctx->pathbuf.Length = ((u8 *)end - (u8 *)ctx->pathbuf.Buffer);
1038 /* Open the conflicting file (by short name). */
1039 status = (*func_NtOpenFile)(&h, GENERIC_WRITE | DELETE,
1040 &ctx->attr, &ctx->iosb,
1041 FILE_SHARE_VALID_FLAGS,
1042 FILE_OPEN_REPARSE_POINT | FILE_OPEN_FOR_BACKUP_INTENT);
1043 if (!NT_SUCCESS(status)) {
1044 WARNING("Can't open \"%ls\" (status=0x%08"PRIx32")",
1045 current_path(ctx), (u32)status);
1050 WARNING("Overriding conflicting short name; path=\"%ls\"",
1054 /* Try to remove the short name on the conflicting file. */
1057 status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1058 FileShortNameInformation);
1060 if (status == STATUS_INVALID_PARAMETER && !retried) {
1062 /* Microsoft forgot to make it possible to remove short names
1063 * until Windows 7. Oops. Use a random short name instead. */
1065 info->FileNameLength = 12 * sizeof(wchar_t);
1066 for (int i = 0; i < 8; i++)
1067 info->FileName[i] = 'A' + (rand() % 26);
1068 info->FileName[8] = L'.';
1069 info->FileName[9] = L'W';
1070 info->FileName[10] = L'L';
1071 info->FileName[11] = L'B';
1072 info->FileName[12] = L'\0';
1078 build_extraction_path(dentry, ctx);
1082 /* Set the short name on the open file @h which has been created at the location
1083 * indicated by @dentry.
1085 * Note that this may add, change, or remove the short name.
1087 * @h must be opened with DELETE access.
1089 * Returns 0 or WIMLIB_ERR_SET_SHORT_NAME. The latter only happens in
1090 * STRICT_SHORT_NAMES mode.
1093 set_short_name(HANDLE h, const struct wim_dentry *dentry,
1094 struct win32_apply_ctx *ctx)
1097 if (!ctx->common.supported_features.short_names)
1101 * Note: The size of the FILE_NAME_INFORMATION buffer must be such that
1102 * FileName contains at least 2 wide characters (4 bytes). Otherwise,
1103 * NtSetInformationFile() will return STATUS_INFO_LENGTH_MISMATCH. This
1104 * is despite the fact that FileNameLength can validly be 0 or 2 bytes,
1105 * with the former case being removing the existing short name if
1106 * present, rather than setting one.
1108 * The null terminator is seemingly optional, but to be safe we include
1109 * space for it and zero all unused space.
1112 size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1113 max(dentry->short_name_nbytes, sizeof(wchar_t)) +
1115 u8 buf[bufsize] _aligned_attribute(8);
1116 FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1118 bool tried_to_remove_existing = false;
1120 memset(buf, 0, bufsize);
1122 info->FileNameLength = dentry->short_name_nbytes;
1123 memcpy(info->FileName, dentry->short_name, dentry->short_name_nbytes);
1126 status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1127 FileShortNameInformation);
1128 if (NT_SUCCESS(status))
1131 if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
1132 if (dentry->short_name_nbytes == 0)
1134 if (!ctx->tried_to_enable_short_names) {
1138 ctx->tried_to_enable_short_names = true;
1140 ret = win32_get_drive_path(ctx->common.target,
1144 if (try_to_enable_short_names(volume))
1150 * Short names can conflict in several cases:
1152 * - a file being extracted has a short name conflicting with an
1155 * - a file being extracted has a short name conflicting with another
1156 * file being extracted (possible, but shouldn't happen)
1158 * - a file being extracted has a short name that conflicts with the
1159 * automatically generated short name of a file we previously
1160 * extracted, but failed to set the short name for. Sounds unlikely,
1161 * but this actually does happen fairly often on versions of Windows
1162 * prior to Windows 7 because they do not support removing short names
1165 if (unlikely(status == STATUS_OBJECT_NAME_COLLISION) &&
1166 dentry->short_name_nbytes && !tried_to_remove_existing)
1168 tried_to_remove_existing = true;
1169 status = remove_conflicting_short_name(dentry, ctx);
1170 if (NT_SUCCESS(status))
1174 /* By default, failure to set short names is not an error (since short
1175 * names aren't too important anymore...). */
1176 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
1177 if (dentry->short_name_nbytes)
1178 ctx->num_set_short_name_failures++;
1180 ctx->num_remove_short_name_failures++;
1184 if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
1185 ERROR("Can't set short name when short "
1186 "names are not enabled on the volume!");
1188 ERROR("Can't set short name on \"%ls\" (status=0x%08"PRIx32")",
1189 current_path(ctx), (u32)status);
1191 return WIMLIB_ERR_SET_SHORT_NAME;
1195 * A wrapper around NtCreateFile() to make it slightly more usable...
1196 * This uses the path currently constructed in ctx->pathbuf.
1198 * Also, we always specify FILE_OPEN_FOR_BACKUP_INTENT and
1199 * FILE_OPEN_REPARSE_POINT.
1202 do_create_file(PHANDLE FileHandle,
1203 ACCESS_MASK DesiredAccess,
1204 PLARGE_INTEGER AllocationSize,
1205 ULONG FileAttributes,
1206 ULONG CreateDisposition,
1207 ULONG CreateOptions,
1208 struct win32_apply_ctx *ctx)
1210 return (*func_NtCreateFile)(FileHandle,
1216 FILE_SHARE_VALID_FLAGS,
1219 FILE_OPEN_FOR_BACKUP_INTENT |
1220 FILE_OPEN_REPARSE_POINT,
1225 /* Like do_create_file(), but builds the extraction path of the @dentry first.
1228 create_file(PHANDLE FileHandle,
1229 ACCESS_MASK DesiredAccess,
1230 PLARGE_INTEGER AllocationSize,
1231 ULONG FileAttributes,
1232 ULONG CreateDisposition,
1233 ULONG CreateOptions,
1234 const struct wim_dentry *dentry,
1235 struct win32_apply_ctx *ctx)
1237 build_extraction_path(dentry, ctx);
1238 return do_create_file(FileHandle,
1247 /* Create empty named data streams.
1249 * Since these won't have 'struct wim_lookup_table_entry's, they won't show up
1250 * in the call to extract_stream_list(). Hence the need for the special case.
1253 create_any_empty_ads(const struct wim_dentry *dentry,
1254 struct win32_apply_ctx *ctx)
1256 const struct wim_inode *inode = dentry->d_inode;
1257 LARGE_INTEGER allocation_size;
1258 bool path_modified = false;
1261 if (!ctx->common.supported_features.named_data_streams)
1264 for (u16 i = 0; i < inode->i_num_ads; i++) {
1265 const struct wim_ads_entry *entry;
1269 entry = &inode->i_ads_entries[i];
1272 if (!entry->stream_name_nbytes)
1279 /* Probably setting the allocation size to 0 has no effect, but
1280 * we might as well try. */
1281 allocation_size.QuadPart = 0;
1283 build_extraction_path_with_ads(dentry, ctx,
1285 entry->stream_name_nbytes /
1287 path_modified = true;
1288 status = do_create_file(&h, FILE_WRITE_DATA, &allocation_size,
1289 0, FILE_SUPERSEDE, 0, ctx);
1290 if (!NT_SUCCESS(status)) {
1291 set_errno_from_nt_status(status);
1292 ERROR_WITH_ERRNO("Can't create \"%ls\" "
1293 "(status=0x%08"PRIx32")",
1294 current_path(ctx), (u32)status);
1295 ret = WIMLIB_ERR_OPEN;
1300 /* Restore the path to the dentry itself */
1302 build_extraction_path(dentry, ctx);
1307 * Creates the directory named by @dentry, or uses an existing directory at that
1308 * location. If necessary, sets the short name and/or fixes compression and
1309 * encryption attributes.
1311 * Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
1314 create_directory(const struct wim_dentry *dentry,
1315 struct win32_apply_ctx *ctx)
1322 /* Special attributes:
1324 * Use FILE_ATTRIBUTE_ENCRYPTED if the directory needs to have it set.
1325 * This doesn't work for FILE_ATTRIBUTE_COMPRESSED (unfortunately).
1327 * Don't specify FILE_ATTRIBUTE_DIRECTORY; it gets set anyway as a
1328 * result of the FILE_DIRECTORY_FILE option. */
1329 attrib = (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED);
1331 /* DELETE is needed for set_short_name().
1332 * GENERIC_READ and GENERIC_WRITE are needed for
1333 * adjust_compression_attribute(). */
1334 status = create_file(&h, GENERIC_READ | GENERIC_WRITE | DELETE, NULL,
1335 attrib, FILE_OPEN_IF, FILE_DIRECTORY_FILE,
1337 if (!NT_SUCCESS(status)) {
1338 set_errno_from_nt_status(status);
1339 ERROR_WITH_ERRNO("Can't create directory \"%ls\" "
1340 "(status=0x%08"PRIx32")",
1341 current_path(ctx), (u32)status);
1342 return WIMLIB_ERR_MKDIR;
1345 ret = set_short_name(h, dentry, ctx);
1348 ret = adjust_compression_attribute(h, dentry, ctx);
1351 ret = maybe_clear_encryption_attribute(&h, dentry, ctx);
1352 /* May close the handle!!! */
1360 * Create all the directories being extracted, other than the target directory
1363 * Note: we don't honor directory hard links. However, we don't allow them to
1364 * exist in WIM images anyway (see inode_fixup.c).
1367 create_directories(struct list_head *dentry_list,
1368 struct win32_apply_ctx *ctx)
1370 const struct wim_dentry *dentry;
1373 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1375 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
1378 /* Note: Here we include files with
1379 * FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
1380 * wait until later to actually set the reparse data. */
1382 /* If the root dentry is being extracted, it was already done so
1383 * in prepare_target(). */
1384 if (!dentry_is_root(dentry)) {
1385 ret = create_directory(dentry, ctx);
1386 ret = check_apply_error(dentry, ctx, ret);
1390 ret = create_any_empty_ads(dentry, ctx);
1391 ret = check_apply_error(dentry, ctx, ret);
1396 ret = report_file_created(&ctx->common);
1404 * Creates the nondirectory file named by @dentry.
1406 * On success, returns an open handle to the file in @h_ret, with GENERIC_READ,
1407 * GENERIC_WRITE, and DELETE access. Also, the path to the file will be saved
1408 * in ctx->pathbuf. On failure, returns WIMLIB_ERR_OPEN.
1411 create_nondirectory_inode(HANDLE *h_ret, const struct wim_dentry *dentry,
1412 struct win32_apply_ctx *ctx)
1414 const struct wim_inode *inode;
1417 bool retried = false;
1419 inode = dentry->d_inode;
1421 /* If the file already exists and has FILE_ATTRIBUTE_SYSTEM and/or
1422 * FILE_ATTRIBUTE_HIDDEN, these must be specified in order to supersede
1425 * Normally the user shouldn't be trying to overwrite such files anyway,
1426 * but we at least provide FILE_ATTRIBUTE_SYSTEM and
1427 * FILE_ATTRIBUTE_HIDDEN if the WIM inode has those attributes so that
1428 * we catch the case where the user extracts the same files to the same
1429 * location more than one time.
1431 * Also specify FILE_ATTRIBUTE_ENCRYPTED if the file needs to be
1434 * In NO_ATTRIBUTES mode just don't specify any attributes at all.
1436 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) {
1439 attrib = (inode->i_attributes & (FILE_ATTRIBUTE_SYSTEM |
1440 FILE_ATTRIBUTE_HIDDEN |
1441 FILE_ATTRIBUTE_ENCRYPTED));
1443 build_extraction_path(dentry, ctx);
1445 status = do_create_file(h_ret, GENERIC_READ | GENERIC_WRITE | DELETE,
1446 NULL, attrib, FILE_SUPERSEDE,
1447 FILE_NON_DIRECTORY_FILE, ctx);
1448 if (NT_SUCCESS(status)) {
1451 ret = adjust_compression_attribute(*h_ret, dentry, ctx);
1453 (*func_NtClose)(*h_ret);
1457 ret = maybe_clear_encryption_attribute(h_ret, dentry, ctx);
1458 /* May close the handle!!! */
1462 (*func_NtClose)(*h_ret);
1467 /* Re-open the handle so that we can return it on
1469 status = do_create_file(h_ret,
1471 GENERIC_WRITE | DELETE,
1473 FILE_NON_DIRECTORY_FILE, ctx);
1474 if (!NT_SUCCESS(status))
1478 ret = create_any_empty_ads(dentry, ctx);
1480 (*func_NtClose)(*h_ret);
1486 if (status == STATUS_ACCESS_DENIED && !retried) {
1487 /* We also can't supersede an existing file that has
1488 * FILE_ATTRIBUTE_READONLY set; doing so causes NtCreateFile()
1489 * to return STATUS_ACCESS_DENIED . The only workaround seems
1490 * to be to explicitly remove FILE_ATTRIBUTE_READONLY on the
1491 * existing file, then try again. */
1493 FILE_BASIC_INFORMATION info;
1496 status = do_create_file(&h, FILE_WRITE_ATTRIBUTES, NULL, 0,
1497 FILE_OPEN, FILE_NON_DIRECTORY_FILE, ctx);
1498 if (!NT_SUCCESS(status))
1501 memset(&info, 0, sizeof(info));
1502 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
1504 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1505 &info, sizeof(info),
1506 FileBasicInformation);
1508 if (!NT_SUCCESS(status))
1514 set_errno_from_nt_status(status);
1515 ERROR_WITH_ERRNO("Can't create file \"%ls\" (status=0x%08"PRIx32")",
1516 current_path(ctx), (u32)status);
1517 return WIMLIB_ERR_OPEN;
1520 /* Creates a hard link at the location named by @dentry to the file represented
1521 * by the open handle @h. Or, if the target volume does not support hard links,
1522 * create a separate file instead. */
1524 create_link(HANDLE h, const struct wim_dentry *dentry,
1525 struct win32_apply_ctx *ctx)
1527 if (ctx->common.supported_features.hard_links) {
1529 build_extraction_path(dentry, ctx);
1531 size_t bufsize = offsetof(FILE_LINK_INFORMATION, FileName) +
1532 ctx->pathbuf.Length + sizeof(wchar_t);
1533 u8 buf[bufsize] _aligned_attribute(8);
1534 FILE_LINK_INFORMATION *info = (FILE_LINK_INFORMATION *)buf;
1537 info->ReplaceIfExists = TRUE;
1538 info->RootDirectory = ctx->attr.RootDirectory;
1539 info->FileNameLength = ctx->pathbuf.Length;
1540 memcpy(info->FileName, ctx->pathbuf.Buffer, ctx->pathbuf.Length);
1541 info->FileName[info->FileNameLength / 2] = L'\0';
1543 /* Note: the null terminator isn't actually necessary,
1544 * but if you don't add the extra character, you get
1545 * STATUS_INFO_LENGTH_MISMATCH when FileNameLength
1546 * happens to be 2 */
1548 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1550 FileLinkInformation);
1551 if (NT_SUCCESS(status))
1553 ERROR("Failed to create link \"%ls\" (status=0x%08"PRIx32")",
1554 current_path(ctx), (u32)status);
1555 return WIMLIB_ERR_LINK;
1560 ret = create_nondirectory_inode(&h2, dentry, ctx);
1564 (*func_NtClose)(h2);
1569 /* Given an inode (represented by the open handle @h) for which one link has
1570 * been created (named by @first_dentry), create the other links.
1572 * Or, if the target volume does not support hard links, create separate files.
1574 * Note: This uses ctx->pathbuf and does not reset it.
1577 create_links(HANDLE h, const struct wim_dentry *first_dentry,
1578 struct win32_apply_ctx *ctx)
1580 const struct wim_inode *inode;
1581 const struct list_head *next;
1582 const struct wim_dentry *dentry;
1585 inode = first_dentry->d_inode;
1586 next = inode->i_extraction_aliases.next;
1588 dentry = list_entry(next, struct wim_dentry,
1589 d_extraction_alias_node);
1590 if (dentry != first_dentry) {
1591 ret = create_link(h, dentry, ctx);
1596 } while (next != &inode->i_extraction_aliases);
1600 /* Create a nondirectory file, including all links. */
1602 create_nondirectory(struct wim_inode *inode, struct win32_apply_ctx *ctx)
1604 struct wim_dentry *first_dentry;
1608 first_dentry = first_extraction_alias(inode);
1610 /* Create first link. */
1611 ret = create_nondirectory_inode(&h, first_dentry, ctx);
1615 /* Set short name. */
1616 ret = set_short_name(h, first_dentry, ctx);
1618 /* Create additional links, OR if hard links are not supported just
1619 * create more files. */
1621 ret = create_links(h, first_dentry, ctx);
1623 /* "WIMBoot" extraction: set external backing by the WIM file if needed. */
1624 if (!ret && unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
1625 ret = set_external_backing(h, inode, ctx);
1631 /* Create all the nondirectory files being extracted, including all aliases
1634 create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1636 struct wim_dentry *dentry;
1637 struct wim_inode *inode;
1640 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1641 inode = dentry->d_inode;
1642 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1644 /* Call create_nondirectory() only once per inode */
1645 if (dentry == inode_first_extraction_dentry(inode)) {
1646 ret = create_nondirectory(inode, ctx);
1647 ret = check_apply_error(dentry, ctx, ret);
1651 ret = report_file_created(&ctx->common);
1659 close_handles(struct win32_apply_ctx *ctx)
1661 for (unsigned i = 0; i < ctx->num_open_handles; i++)
1662 (*func_NtClose)(ctx->open_handles[i]);
1665 /* Prepare to read the next stream, which has size @stream_size, into an
1666 * in-memory buffer. */
1668 prepare_data_buffer(struct win32_apply_ctx *ctx, u64 stream_size)
1670 if (stream_size > ctx->data_buffer_size) {
1671 /* Larger buffer needed. */
1673 if ((size_t)stream_size != stream_size)
1675 new_buffer = REALLOC(ctx->data_buffer, stream_size);
1678 ctx->data_buffer = new_buffer;
1679 ctx->data_buffer_size = stream_size;
1681 /* On the first call this changes data_buffer_ptr from NULL, which tells
1682 * extract_chunk() that the data buffer needs to be filled while reading
1683 * the stream data. */
1684 ctx->data_buffer_ptr = ctx->data_buffer;
1689 begin_extract_stream_instance(const struct wim_lookup_table_entry *stream,
1690 struct wim_dentry *dentry,
1691 const wchar_t *stream_name,
1692 struct win32_apply_ctx *ctx)
1694 const struct wim_inode *inode = dentry->d_inode;
1695 size_t stream_name_nchars = 0;
1696 FILE_ALLOCATION_INFORMATION alloc_info;
1700 if (unlikely(stream_name))
1701 stream_name_nchars = wcslen(stream_name);
1703 if (unlikely(stream_name_nchars)) {
1704 build_extraction_path_with_ads(dentry, ctx,
1705 stream_name, stream_name_nchars);
1707 build_extraction_path(dentry, ctx);
1710 /* Reparse point? */
1711 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
1712 && (stream_name_nchars == 0))
1714 if (!ctx->common.supported_features.reparse_points)
1717 /* We can't write the reparse stream directly; we must set it
1718 * with FSCTL_SET_REPARSE_POINT, which requires that all the
1719 * data be available. So, stage the data in a buffer. */
1721 if (!prepare_data_buffer(ctx, stream->size))
1722 return WIMLIB_ERR_NOMEM;
1723 list_add_tail(&dentry->tmp_list, &ctx->reparse_dentries);
1727 /* Encrypted file? */
1728 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
1729 && (stream_name_nchars == 0))
1731 if (!ctx->common.supported_features.encrypted_files)
1734 /* We can't write encrypted file streams directly; we must use
1735 * WriteEncryptedFileRaw(), which requires providing the data
1736 * through a callback function. This can't easily be combined
1737 * with our own callback-based approach.
1739 * The current workaround is to simply read the stream into
1740 * memory and write the encrypted file from that.
1742 * TODO: This isn't sufficient for extremely large encrypted
1743 * files. Perhaps we should create an extra thread to write
1745 if (!prepare_data_buffer(ctx, stream->size))
1746 return WIMLIB_ERR_NOMEM;
1747 list_add_tail(&dentry->tmp_list, &ctx->encrypted_dentries);
1751 if (ctx->num_open_handles == MAX_OPEN_STREAMS) {
1752 /* XXX: Fix this. But because of the checks in
1753 * extract_stream_list(), this can now only happen on a
1754 * filesystem that does not support hard links. */
1755 ERROR("Can't extract data: too many open files!");
1756 return WIMLIB_ERR_UNSUPPORTED;
1759 /* Open a new handle */
1760 status = do_create_file(&h,
1761 FILE_WRITE_DATA | SYNCHRONIZE,
1762 NULL, 0, FILE_OPEN_IF,
1763 FILE_SEQUENTIAL_ONLY |
1764 FILE_SYNCHRONOUS_IO_NONALERT,
1766 if (!NT_SUCCESS(status)) {
1767 set_errno_from_nt_status(status);
1768 ERROR_WITH_ERRNO("Can't open \"%ls\" for writing "
1769 "(status=0x%08"PRIx32")",
1770 current_path(ctx), (u32)status);
1771 return WIMLIB_ERR_OPEN;
1774 ctx->open_handles[ctx->num_open_handles++] = h;
1776 /* Allocate space for the data. */
1777 alloc_info.AllocationSize.QuadPart = stream->size;
1778 (*func_NtSetInformationFile)(h, &ctx->iosb,
1779 &alloc_info, sizeof(alloc_info),
1780 FileAllocationInformation);
1784 /* Set the reparse data @rpbuf of length @rpbuflen on the extracted file
1785 * corresponding to the WIM dentry @dentry. */
1787 do_set_reparse_data(const struct wim_dentry *dentry,
1788 const void *rpbuf, u16 rpbuflen,
1789 struct win32_apply_ctx *ctx)
1794 status = create_file(&h, GENERIC_WRITE, NULL,
1795 0, FILE_OPEN, 0, dentry, ctx);
1796 if (!NT_SUCCESS(status))
1799 status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
1800 &ctx->iosb, FSCTL_SET_REPARSE_POINT,
1801 (void *)rpbuf, rpbuflen,
1805 if (NT_SUCCESS(status))
1808 /* On Windows, by default only the Administrator can create symbolic
1809 * links for some reason. By default we just issue a warning if this
1810 * appears to be the problem. Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
1811 * to get a hard error. */
1812 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
1813 && (status == STATUS_PRIVILEGE_NOT_HELD ||
1814 status == STATUS_ACCESS_DENIED)
1815 && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1816 dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1818 WARNING("Can't create symbolic link \"%ls\"! \n"
1819 " (Need Administrator rights, or at least "
1821 " SeCreateSymbolicLink privilege.)",
1827 set_errno_from_nt_status(status);
1828 ERROR_WITH_ERRNO("Can't set reparse data on \"%ls\" "
1829 "(status=0x%08"PRIx32")",
1830 current_path(ctx), (u32)status);
1831 return WIMLIB_ERR_SET_REPARSE_DATA;
1834 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1835 * pointer to the suffix of the path that begins with the device directly, such
1836 * as e:\Windows\System32. */
1837 static const wchar_t *
1838 skip_nt_toplevel_component(const wchar_t *path, size_t path_nchars)
1840 static const wchar_t * const dirs[] = {
1845 size_t first_dir_len = 0;
1846 const wchar_t * const end = path + path_nchars;
1848 for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
1849 size_t len = wcslen(dirs[i]);
1850 if (len <= (end - path) && !wcsnicmp(path, dirs[i], len)) {
1851 first_dir_len = len;
1855 if (first_dir_len == 0)
1857 path += first_dir_len;
1858 while (path != end && *path == L'\\')
1863 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1864 * pointer to the suffix of the path that is device-relative, such as
1867 * The path has an explicit length and is not necessarily null terminated.
1869 * If the path just something like \??\e: then the returned pointer will point
1870 * just past the colon. In this case the length of the result will be 0
1872 static const wchar_t *
1873 get_device_relative_path(const wchar_t *path, size_t path_nchars)
1875 const wchar_t * const orig_path = path;
1876 const wchar_t * const end = path + path_nchars;
1878 path = skip_nt_toplevel_component(path, path_nchars);
1879 if (path == orig_path)
1882 path = wmemchr(path, L'\\', (end - path));
1887 } while (path != end && *path == L'\\');
1892 * Given a reparse point buffer for a symbolic link or junction, adjust its
1893 * contents so that the target of the link is consistent with the new location
1897 try_rpfix(u8 *rpbuf, u16 *rpbuflen_p, struct win32_apply_ctx *ctx)
1899 struct reparse_data rpdata;
1900 size_t orig_subst_name_nchars;
1901 const wchar_t *relpath;
1902 size_t relpath_nchars;
1903 size_t target_ntpath_nchars;
1904 size_t fixed_subst_name_nchars;
1905 const wchar_t *fixed_print_name;
1906 size_t fixed_print_name_nchars;
1908 if (parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata)) {
1909 /* Do nothing if the reparse data is invalid. */
1913 if (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK &&
1914 (rpdata.rpflags & SYMBOLIC_LINK_RELATIVE))
1916 /* Do nothing if it's a relative symbolic link. */
1920 /* Build the new substitute name from the NT namespace path to the
1921 * target directory, then a path separator, then the "device relative"
1922 * part of the old substitute name. */
1924 orig_subst_name_nchars = rpdata.substitute_name_nbytes / sizeof(wchar_t);
1926 relpath = get_device_relative_path(rpdata.substitute_name,
1927 orig_subst_name_nchars);
1928 relpath_nchars = orig_subst_name_nchars -
1929 (relpath - rpdata.substitute_name);
1931 target_ntpath_nchars = ctx->target_ntpath.Length / sizeof(wchar_t);
1933 fixed_subst_name_nchars = target_ntpath_nchars;
1935 fixed_subst_name_nchars += 1 + relpath_nchars;
1936 wchar_t fixed_subst_name[fixed_subst_name_nchars];
1938 wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer,
1939 target_ntpath_nchars);
1940 if (relpath_nchars) {
1941 fixed_subst_name[target_ntpath_nchars] = L'\\';
1942 wmemcpy(&fixed_subst_name[target_ntpath_nchars + 1],
1943 relpath, relpath_nchars);
1945 /* Doesn't need to be null-terminated. */
1947 /* Print name should be Win32, but not all NT names can even be
1948 * translated to Win32 names. But we can at least delete the top-level
1949 * directory, such as \??\, and this will have the expected result in
1950 * the usual case. */
1951 fixed_print_name = skip_nt_toplevel_component(fixed_subst_name,
1952 fixed_subst_name_nchars);
1953 fixed_print_name_nchars = fixed_subst_name_nchars - (fixed_print_name -
1956 rpdata.substitute_name = fixed_subst_name;
1957 rpdata.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
1958 rpdata.print_name = (wchar_t *)fixed_print_name;
1959 rpdata.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
1960 make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p);
1963 /* Sets reparse data on the specified file. This handles "fixing" the targets
1964 * of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX was
1967 set_reparse_data(const struct wim_dentry *dentry,
1968 const void *_rpbuf, u16 rpbuflen, struct win32_apply_ctx *ctx)
1970 const struct wim_inode *inode = dentry->d_inode;
1971 const void *rpbuf = _rpbuf;
1973 if ((ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
1974 && !inode->i_not_rpfixed
1975 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1976 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1978 memcpy(&ctx->rpfixbuf, _rpbuf, rpbuflen);
1979 try_rpfix((u8 *)&ctx->rpfixbuf, &rpbuflen, ctx);
1980 rpbuf = &ctx->rpfixbuf;
1982 return do_set_reparse_data(dentry, rpbuf, rpbuflen, ctx);
1986 /* Import the next block of raw encrypted data */
1988 import_encrypted_data(PBYTE pbData, PVOID pvCallbackContext, PULONG Length)
1990 struct win32_apply_ctx *ctx = pvCallbackContext;
1993 copy_len = min(ctx->encrypted_size - ctx->encrypted_offset, *Length);
1994 memcpy(pbData, &ctx->data_buffer[ctx->encrypted_offset], copy_len);
1995 ctx->encrypted_offset += copy_len;
1997 return ERROR_SUCCESS;
2000 /* Write the raw encrypted data to the already-created file corresponding to
2003 * The raw encrypted data is provided in ctx->data_buffer, and its size is
2004 * ctx->encrypted_size. */
2006 extract_encrypted_file(const struct wim_dentry *dentry,
2007 struct win32_apply_ctx *ctx)
2012 /* Temporarily build a Win32 path for OpenEncryptedFileRaw() */
2013 build_win32_extraction_path(dentry, ctx);
2015 err = OpenEncryptedFileRaw(ctx->pathbuf.Buffer,
2016 CREATE_FOR_IMPORT, &rawctx);
2018 /* Restore the NT namespace path */
2019 build_extraction_path(dentry, ctx);
2021 if (err != ERROR_SUCCESS) {
2022 set_errno_from_win32_error(err);
2023 ERROR_WITH_ERRNO("Can't open \"%ls\" for encrypted import "
2024 "(err=%"PRIu32")", current_path(ctx), (u32)err);
2025 return WIMLIB_ERR_OPEN;
2028 ctx->encrypted_offset = 0;
2030 err = WriteEncryptedFileRaw(import_encrypted_data, ctx, rawctx);
2032 CloseEncryptedFileRaw(rawctx);
2034 if (err != ERROR_SUCCESS) {
2035 set_errno_from_win32_error(err);
2036 ERROR_WITH_ERRNO("Can't import encrypted file \"%ls\" "
2037 "(err=%"PRIu32")", current_path(ctx), (u32)err);
2038 return WIMLIB_ERR_WRITE;
2044 /* Called when starting to read a stream for extraction on Windows */
2046 begin_extract_stream(struct wim_lookup_table_entry *stream, void *_ctx)
2048 struct win32_apply_ctx *ctx = _ctx;
2049 const struct stream_owner *owners = stream_owners(stream);
2052 ctx->num_open_handles = 0;
2053 ctx->data_buffer_ptr = NULL;
2054 INIT_LIST_HEAD(&ctx->reparse_dentries);
2055 INIT_LIST_HEAD(&ctx->encrypted_dentries);
2057 for (u32 i = 0; i < stream->out_refcnt; i++) {
2058 const struct wim_inode *inode = owners[i].inode;
2059 const wchar_t *stream_name = owners[i].stream_name;
2060 struct wim_dentry *dentry;
2062 /* A copy of the stream needs to be extracted to @inode. */
2064 if (ctx->common.supported_features.hard_links) {
2065 dentry = inode_first_extraction_dentry(inode);
2066 ret = begin_extract_stream_instance(stream, dentry,
2068 ret = check_apply_error(dentry, ctx, ret);
2072 /* Hard links not supported. Extract the stream
2073 * separately to each alias of the inode. */
2074 struct list_head *next;
2076 next = inode->i_extraction_aliases.next;
2078 dentry = list_entry(next, struct wim_dentry,
2079 d_extraction_alias_node);
2080 ret = begin_extract_stream_instance(stream,
2084 ret = check_apply_error(dentry, ctx, ret);
2088 } while (next != &inode->i_extraction_aliases);
2099 /* Called when the next chunk of a stream has been read for extraction on
2102 extract_chunk(const void *chunk, size_t size, void *_ctx)
2104 struct win32_apply_ctx *ctx = _ctx;
2106 /* Write the data chunk to each open handle */
2107 for (unsigned i = 0; i < ctx->num_open_handles; i++) {
2108 u8 *bufptr = (u8 *)chunk;
2109 size_t bytes_remaining = size;
2111 while (bytes_remaining) {
2112 ULONG count = min(0xFFFFFFFF, bytes_remaining);
2114 status = (*func_NtWriteFile)(ctx->open_handles[i],
2116 &ctx->iosb, bufptr, count,
2118 if (!NT_SUCCESS(status)) {
2119 set_errno_from_nt_status(status);
2120 ERROR_WITH_ERRNO("Error writing data to target "
2121 "volume (status=0x%08"PRIx32")",
2123 return WIMLIB_ERR_WRITE;
2125 bufptr += ctx->iosb.Information;
2126 bytes_remaining -= ctx->iosb.Information;
2130 /* Copy the data chunk into the buffer (if needed) */
2131 if (ctx->data_buffer_ptr)
2132 ctx->data_buffer_ptr = mempcpy(ctx->data_buffer_ptr,
2137 /* Called when a stream has been fully read for extraction on Windows */
2139 end_extract_stream(struct wim_lookup_table_entry *stream, int status, void *_ctx)
2141 struct win32_apply_ctx *ctx = _ctx;
2143 const struct wim_dentry *dentry;
2150 if (likely(!ctx->data_buffer_ptr))
2153 if (!list_empty(&ctx->reparse_dentries)) {
2154 if (stream->size > REPARSE_DATA_MAX_SIZE) {
2155 dentry = list_first_entry(&ctx->reparse_dentries,
2156 struct wim_dentry, tmp_list);
2157 build_extraction_path(dentry, ctx);
2158 ERROR("Reparse data of \"%ls\" has size "
2159 "%"PRIu64" bytes (exceeds %u bytes)",
2160 current_path(ctx), stream->size,
2161 REPARSE_DATA_MAX_SIZE);
2162 ret = WIMLIB_ERR_INVALID_REPARSE_DATA;
2163 return check_apply_error(dentry, ctx, ret);
2165 /* In the WIM format, reparse streams are just the reparse data
2166 * and omit the header. But we can reconstruct the header. */
2167 memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, stream->size);
2168 ctx->rpbuf.rpdatalen = stream->size;
2169 ctx->rpbuf.rpreserved = 0;
2170 list_for_each_entry(dentry, &ctx->reparse_dentries, tmp_list) {
2171 ctx->rpbuf.rptag = dentry->d_inode->i_reparse_tag;
2172 ret = set_reparse_data(dentry, &ctx->rpbuf,
2173 stream->size + REPARSE_DATA_OFFSET,
2175 ret = check_apply_error(dentry, ctx, ret);
2181 if (!list_empty(&ctx->encrypted_dentries)) {
2182 ctx->encrypted_size = stream->size;
2183 list_for_each_entry(dentry, &ctx->encrypted_dentries, tmp_list) {
2184 ret = extract_encrypted_file(dentry, ctx);
2185 ret = check_apply_error(dentry, ctx, ret);
2194 /* Attributes that can't be set directly */
2195 #define SPECIAL_ATTRIBUTES \
2196 (FILE_ATTRIBUTE_REPARSE_POINT | \
2197 FILE_ATTRIBUTE_DIRECTORY | \
2198 FILE_ATTRIBUTE_ENCRYPTED | \
2199 FILE_ATTRIBUTE_SPARSE_FILE | \
2200 FILE_ATTRIBUTE_COMPRESSED)
2202 /* Set the security descriptor @desc, of @desc_size bytes, on the file with open
2205 set_security_descriptor(HANDLE h, const void *_desc,
2206 size_t desc_size, struct win32_apply_ctx *ctx)
2208 SECURITY_INFORMATION info;
2210 SECURITY_DESCRIPTOR_RELATIVE *desc;
2213 * Ideally, we would just pass in the security descriptor buffer as-is.
2214 * But it turns out that Windows can mess up the security descriptor
2215 * even when using the low-level NtSetSecurityObject() function:
2217 * - Windows will clear SE_DACL_AUTO_INHERITED if it is set in the
2218 * passed buffer. To actually get Windows to set
2219 * SE_DACL_AUTO_INHERITED, the application must set the non-persistent
2220 * flag SE_DACL_AUTO_INHERIT_REQ. As usual, Microsoft didn't bother
2221 * to properly document either of these flags. It's unclear how
2222 * important SE_DACL_AUTO_INHERITED actually is, but to be safe we use
2223 * the SE_DACL_AUTO_INHERIT_REQ workaround to set it if needed.
2225 * - The above also applies to the equivalent SACL flags,
2226 * SE_SACL_AUTO_INHERITED and SE_SACL_AUTO_INHERIT_REQ.
2228 * - If the application says that it's setting
2229 * DACL_SECURITY_INFORMATION, then Windows sets SE_DACL_PRESENT in the
2230 * resulting security descriptor, even if the security descriptor the
2231 * application provided did not have a DACL. This seems to be
2232 * unavoidable, since omitting DACL_SECURITY_INFORMATION would cause a
2233 * default DACL to remain. Fortunately, this behavior seems harmless,
2234 * since the resulting DACL will still be "null" --- but it will be
2235 * "the other representation of null".
2237 * - The above also applies to SACL_SECURITY_INFORMATION and
2238 * SE_SACL_PRESENT. Again, it's seemingly unavoidable but "harmless"
2239 * that Windows changes the representation of a "null SACL".
2241 if (likely(desc_size <= STACK_MAX)) {
2242 desc = alloca(desc_size);
2244 desc = MALLOC(desc_size);
2246 return STATUS_NO_MEMORY;
2249 memcpy(desc, _desc, desc_size);
2251 if (likely(desc_size >= 4)) {
2253 if (desc->Control & SE_DACL_AUTO_INHERITED)
2254 desc->Control |= SE_DACL_AUTO_INHERIT_REQ;
2256 if (desc->Control & SE_SACL_AUTO_INHERITED)
2257 desc->Control |= SE_SACL_AUTO_INHERIT_REQ;
2261 * More API insanity. We want to set the entire security descriptor
2262 * as-is. But all available APIs require specifying the specific parts
2263 * of the security descriptor being set. Especially annoying is that
2264 * mandatory integrity labels are part of the SACL, but they aren't set
2265 * with SACL_SECURITY_INFORMATION. Instead, applications must also
2266 * specify LABEL_SECURITY_INFORMATION (Windows Vista, Windows 7) or
2267 * BACKUP_SECURITY_INFORMATION (Windows 8). But at least older versions
2268 * of Windows don't error out if you provide these newer flags...
2270 * Also, if the process isn't running as Administrator, then it probably
2271 * doesn't have SE_RESTORE_PRIVILEGE. In this case, it will always get
2272 * the STATUS_PRIVILEGE_NOT_HELD error by trying to set the SACL, even
2273 * if the security descriptor it provided did not have a SACL. By
2274 * default, in this case we try to recover and set as much of the
2275 * security descriptor as possible --- potentially excluding the DACL, and
2276 * even the owner, as well as the SACL.
2279 info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
2280 DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION |
2281 LABEL_SECURITY_INFORMATION | BACKUP_SECURITY_INFORMATION;
2285 * It's also worth noting that SetFileSecurity() is unusable because it
2286 * doesn't request "backup semantics" when it opens the file internally.
2287 * NtSetSecurityObject() seems to be the best function to use in backup
2288 * applications. (SetSecurityInfo() should also work, but it's harder
2289 * to use and must call NtSetSecurityObject() internally anyway.
2290 * BackupWrite() is theoretically usable as well, but it's inflexible
2291 * and poorly documented.)
2295 status = (*func_NtSetSecurityObject)(h, info, desc);
2296 if (NT_SUCCESS(status))
2297 goto out_maybe_free_desc;
2299 /* Failed to set the requested parts of the security descriptor. If the
2300 * error was permissions-related, try to set fewer parts of the security
2301 * descriptor, unless WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled. */
2302 if ((status == STATUS_PRIVILEGE_NOT_HELD ||
2303 status == STATUS_ACCESS_DENIED) &&
2304 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2306 if (info & SACL_SECURITY_INFORMATION) {
2307 info &= ~(SACL_SECURITY_INFORMATION |
2308 LABEL_SECURITY_INFORMATION |
2309 BACKUP_SECURITY_INFORMATION);
2310 ctx->partial_security_descriptors++;
2313 if (info & DACL_SECURITY_INFORMATION) {
2314 info &= ~DACL_SECURITY_INFORMATION;
2317 if (info & OWNER_SECURITY_INFORMATION) {
2318 info &= ~OWNER_SECURITY_INFORMATION;
2321 /* Nothing left except GROUP, and if we removed it we
2322 * wouldn't have anything at all. */
2325 /* No part of the security descriptor could be set, or
2326 * WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled and the full security
2327 * descriptor could not be set. */
2328 if (!(info & SACL_SECURITY_INFORMATION))
2329 ctx->partial_security_descriptors--;
2330 ctx->no_security_descriptors++;
2332 out_maybe_free_desc:
2333 if (unlikely(desc_size > STACK_MAX))
2338 /* Set metadata on the open file @h from the WIM inode @inode. */
2340 do_apply_metadata_to_file(HANDLE h, const struct wim_inode *inode,
2341 struct win32_apply_ctx *ctx)
2343 FILE_BASIC_INFORMATION info;
2346 /* Set security descriptor if present and not in NO_ACLS mode */
2347 if (inode->i_security_id >= 0 &&
2348 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
2350 const struct wim_security_data *sd;
2354 sd = wim_get_current_security_data(ctx->common.wim);
2355 desc = sd->descriptors[inode->i_security_id];
2356 desc_size = sd->sizes[inode->i_security_id];
2358 status = set_security_descriptor(h, desc, desc_size, ctx);
2359 if (!NT_SUCCESS(status) &&
2360 (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2362 set_errno_from_nt_status(status);
2363 ERROR_WITH_ERRNO("Can't set security descriptor "
2364 "on \"%ls\" (status=0x%08"PRIx32")",
2365 current_path(ctx), (u32)status);
2366 return WIMLIB_ERR_SET_SECURITY;
2370 /* Set attributes and timestamps */
2371 info.CreationTime.QuadPart = inode->i_creation_time;
2372 info.LastAccessTime.QuadPart = inode->i_last_access_time;
2373 info.LastWriteTime.QuadPart = inode->i_last_write_time;
2374 info.ChangeTime.QuadPart = 0;
2375 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
2376 info.FileAttributes = 0;
2378 info.FileAttributes = inode->i_attributes & ~SPECIAL_ATTRIBUTES;
2380 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
2381 &info, sizeof(info),
2382 FileBasicInformation);
2383 /* On FAT volumes we get STATUS_INVALID_PARAMETER if we try to set
2384 * attributes on the root directory. (Apparently because FAT doesn't
2385 * actually have a place to store those attributes!) */
2386 if (!NT_SUCCESS(status)
2387 && !(status == STATUS_INVALID_PARAMETER &&
2388 dentry_is_root(inode_first_extraction_dentry(inode))))
2390 set_errno_from_nt_status(status);
2391 ERROR_WITH_ERRNO("Can't set basic metadata on \"%ls\" "
2392 "(status=0x%08"PRIx32")",
2393 current_path(ctx), (u32)status);
2394 return WIMLIB_ERR_SET_ATTRIBUTES;
2401 apply_metadata_to_file(const struct wim_dentry *dentry,
2402 struct win32_apply_ctx *ctx)
2404 const struct wim_inode *inode = dentry->d_inode;
2410 perms = FILE_WRITE_ATTRIBUTES | WRITE_DAC |
2411 WRITE_OWNER | ACCESS_SYSTEM_SECURITY;
2413 build_extraction_path(dentry, ctx);
2415 /* Open a handle with as many relevant permissions as possible. */
2416 while (!NT_SUCCESS(status = do_create_file(&h, perms, NULL,
2417 0, FILE_OPEN, 0, ctx)))
2419 if (status == STATUS_PRIVILEGE_NOT_HELD ||
2420 status == STATUS_ACCESS_DENIED)
2422 if (perms & ACCESS_SYSTEM_SECURITY) {
2423 perms &= ~ACCESS_SYSTEM_SECURITY;
2426 if (perms & WRITE_DAC) {
2427 perms &= ~WRITE_DAC;
2430 if (perms & WRITE_OWNER) {
2431 perms &= ~WRITE_OWNER;
2435 set_errno_from_nt_status(status);
2436 ERROR_WITH_ERRNO("Can't open \"%ls\" to set metadata "
2437 "(status=0x%08"PRIx32")",
2438 current_path(ctx), (u32)status);
2439 return WIMLIB_ERR_OPEN;
2442 ret = do_apply_metadata_to_file(h, inode, ctx);
2450 apply_metadata(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
2452 const struct wim_dentry *dentry;
2455 /* We go in reverse so that metadata is set on all a directory's
2456 * children before the directory itself. This avoids any potential
2457 * problems with attributes, timestamps, or security descriptors. */
2458 list_for_each_entry_reverse(dentry, dentry_list, d_extraction_list_node)
2460 ret = apply_metadata_to_file(dentry, ctx);
2461 ret = check_apply_error(dentry, ctx, ret);
2464 ret = report_file_metadata_applied(&ctx->common);
2471 /* Issue warnings about problems during the extraction for which warnings were
2472 * not already issued (due to the high number of potential warnings if we issued
2473 * them per-file). */
2475 do_warnings(const struct win32_apply_ctx *ctx)
2477 if (ctx->partial_security_descriptors == 0
2478 && ctx->no_security_descriptors == 0
2479 && ctx->num_set_short_name_failures == 0
2481 && ctx->num_remove_short_name_failures == 0
2486 WARNING("Extraction to \"%ls\" complete, but with one or more warnings:",
2487 ctx->common.target);
2488 if (ctx->num_set_short_name_failures) {
2489 WARNING("- Could not set short names on %lu files or directories",
2490 ctx->num_set_short_name_failures);
2493 if (ctx->num_remove_short_name_failures) {
2494 WARNING("- Could not remove short names on %lu files or directories"
2495 " (This is expected on Vista and earlier)",
2496 ctx->num_remove_short_name_failures);
2499 if (ctx->partial_security_descriptors) {
2500 WARNING("- Could only partially set the security descriptor\n"
2501 " on %lu files or directories.",
2502 ctx->partial_security_descriptors);
2504 if (ctx->no_security_descriptors) {
2505 WARNING("- Could not set security descriptor at all\n"
2506 " on %lu files or directories.",
2507 ctx->no_security_descriptors);
2509 if (ctx->partial_security_descriptors || ctx->no_security_descriptors) {
2510 WARNING("To fully restore all security descriptors, run the program\n"
2511 " with Administrator rights.");
2516 count_dentries(const struct list_head *dentry_list)
2518 const struct list_head *cur;
2521 list_for_each(cur, dentry_list)
2527 /* Extract files from a WIM image to a directory on Windows */
2529 win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
2532 struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
2533 uint64_t dentry_count;
2535 ret = prepare_target(dentry_list, ctx);
2539 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2540 ret = start_wimboot_extraction(ctx);
2545 dentry_count = count_dentries(dentry_list);
2547 ret = start_file_structure_phase(&ctx->common, dentry_count);
2551 ret = create_directories(dentry_list, ctx);
2555 ret = create_nondirectories(dentry_list, ctx);
2559 ret = end_file_structure_phase(&ctx->common);
2563 struct read_stream_list_callbacks cbs = {
2564 .begin_stream = begin_extract_stream,
2565 .begin_stream_ctx = ctx,
2566 .consume_chunk = extract_chunk,
2567 .consume_chunk_ctx = ctx,
2568 .end_stream = end_extract_stream,
2569 .end_stream_ctx = ctx,
2571 ret = extract_stream_list(&ctx->common, &cbs);
2575 ret = start_file_metadata_phase(&ctx->common, dentry_count);
2579 ret = apply_metadata(dentry_list, ctx);
2583 ret = end_file_metadata_phase(&ctx->common);
2587 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2588 ret = end_wimboot_extraction(ctx);
2596 (*func_NtClose)(ctx->h_target);
2597 if (ctx->target_ntpath.Buffer)
2598 HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
2599 FREE(ctx->pathbuf.Buffer);
2600 FREE(ctx->print_buffer);
2601 if (ctx->wimboot.prepopulate_pats) {
2602 FREE(ctx->wimboot.prepopulate_pats->strings);
2603 FREE(ctx->wimboot.prepopulate_pats);
2605 FREE(ctx->wimboot.mem_prepopulate_pats);
2606 FREE(ctx->data_buffer);
2610 const struct apply_operations win32_apply_ops = {
2612 .get_supported_features = win32_get_supported_features,
2613 .extract = win32_extract,
2614 .will_externally_back = win32_will_externally_back,
2615 .context_size = sizeof(struct win32_apply_ctx),
2618 #endif /* __WIN32__ */