2 * win32_apply.c - Windows-specific code for applying files from a WIM image.
6 * Copyright (C) 2013, 2014 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
10 * wimlib is free software; you can redistribute it and/or modify it under the
11 * terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 3 of the License, or (at your option)
15 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 * A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with wimlib; if not, see http://www.gnu.org/licenses/.
30 #include "wimlib/win32_common.h"
32 #include "wimlib/apply.h"
33 #include "wimlib/capture.h" /* for mangle_pat() and match_pattern_list() */
34 #include "wimlib/dentry.h"
35 #include "wimlib/error.h"
36 #include "wimlib/lookup_table.h"
37 #include "wimlib/metadata.h"
38 #include "wimlib/reparse.h"
39 #include "wimlib/textfile.h"
40 #include "wimlib/xml.h"
41 #include "wimlib/wimboot.h"
43 struct win32_apply_ctx {
45 /* Extract flags, the pointer to the WIMStruct, etc. */
46 struct apply_ctx common;
48 /* WIMBoot information, only filled in if WIMLIB_EXTRACT_FLAG_WIMBOOT
52 struct string_set *prepopulate_pats;
53 void *mem_prepopulate_pats;
54 u8 wim_lookup_table_hash[SHA1_HASH_SIZE];
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_short_name_failures;
131 /* Have we tried to enable short name support on the target volume yet?
133 bool tried_to_enable_short_names;
136 /* Get the drive letter from a Windows path, or return the null character if the
137 * path is relative. */
139 get_drive_letter(const wchar_t *path)
141 /* Skip \\?\ prefix */
142 if (!wcsncmp(path, L"\\\\?\\", 4))
145 /* Return drive letter if valid */
146 if (((path[0] >= L'a' && path[0] <= L'z') ||
147 (path[0] >= L'A' && path[0] <= L'Z')) && path[1] == L':')
154 get_vol_flags(const wchar_t *target, DWORD *vol_flags_ret,
155 bool *short_names_supported_ret)
157 wchar_t filesystem_name[MAX_PATH + 1];
159 wchar_t *volume = NULL;
162 *short_names_supported_ret = false;
164 drive[0] = get_drive_letter(target);
172 if (!GetVolumeInformation(volume, NULL, 0, NULL, NULL,
173 vol_flags_ret, filesystem_name,
174 ARRAY_LEN(filesystem_name)))
176 DWORD err = GetLastError();
177 set_errno_from_win32_error(err);
178 WARNING_WITH_ERRNO("Failed to get volume information for "
179 "\"%ls\" (err=%"PRIu32")",
184 if (wcsstr(filesystem_name, L"NTFS")) {
185 /* FILE_SUPPORTS_HARD_LINKS is only supported on Windows 7 and
186 * later. Force it on anyway if filesystem is NTFS. */
187 *vol_flags_ret |= FILE_SUPPORTS_HARD_LINKS;
189 /* There's no volume flag for short names, but according to the
190 * MS documentation they are only user-settable on NTFS. */
191 *short_names_supported_ret = true;
196 win32_get_supported_features(const wchar_t *target,
197 struct wim_features *supported_features)
200 bool short_names_supported;
202 /* Query the features of the target volume. */
204 get_vol_flags(target, &vol_flags, &short_names_supported);
206 supported_features->archive_files = 1;
207 supported_features->hidden_files = 1;
208 supported_features->system_files = 1;
210 if (vol_flags & FILE_FILE_COMPRESSION)
211 supported_features->compressed_files = 1;
213 if (vol_flags & FILE_SUPPORTS_ENCRYPTION) {
214 supported_features->encrypted_files = 1;
215 supported_features->encrypted_directories = 1;
218 supported_features->not_context_indexed_files = 1;
220 /* Don't do anything with FILE_SUPPORTS_SPARSE_FILES. */
222 if (vol_flags & FILE_NAMED_STREAMS)
223 supported_features->named_data_streams = 1;
225 if (vol_flags & FILE_SUPPORTS_HARD_LINKS)
226 supported_features->hard_links = 1;
228 if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS)
229 supported_features->reparse_points = 1;
231 if (vol_flags & FILE_PERSISTENT_ACLS)
232 supported_features->security_descriptors = 1;
234 if (short_names_supported)
235 supported_features->short_names = 1;
237 supported_features->timestamps = 1;
239 /* Note: Windows does not support case sensitive filenames! At least
240 * not without changing the registry and rebooting... */
245 /* Load the patterns from [PrepopulateList] of WimBootCompress.ini in the WIM
246 * image being extracted. */
248 load_prepopulate_pats(struct win32_apply_ctx *ctx)
250 const wchar_t *path = L"\\Windows\\System32\\WimBootCompress.ini";
251 struct wim_dentry *dentry;
252 struct wim_lookup_table_entry *lte;
255 struct string_set *s;
257 struct text_file_section sec;
259 dentry = get_dentry(ctx->common.wim, path, WIMLIB_CASE_INSENSITIVE);
261 (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
262 FILE_ATTRIBUTE_REPARSE_POINT |
263 FILE_ATTRIBUTE_ENCRYPTED)) ||
264 !(lte = inode_unnamed_lte(dentry->d_inode, ctx->common.wim->lookup_table)))
266 WARNING("%ls does not exist in WIM image!", path);
267 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
270 ret = read_full_stream_into_alloc_buf(lte, &buf);
274 s = CALLOC(1, sizeof(struct string_set));
277 return WIMLIB_ERR_NOMEM;
280 sec.name = T("PrepopulateList");
283 ret = do_load_text_file(path, buf, lte->size, &mem, &sec, 1,
284 LOAD_TEXT_FILE_REMOVE_QUOTES |
285 LOAD_TEXT_FILE_NO_WARNINGS,
287 BUILD_BUG_ON(OS_PREFERRED_PATH_SEPARATOR != WIM_PATH_SEPARATOR);
293 ctx->wimboot.prepopulate_pats = s;
294 ctx->wimboot.mem_prepopulate_pats = mem;
298 /* Returns %true if the path to @dentry matches a pattern in [PrepopulateList]
299 * of WimBootCompress.ini. Otherwise returns %false.
301 * @dentry must have had its full path calculated. */
303 in_prepopulate_list(struct wim_dentry *dentry,
304 const struct win32_apply_ctx *ctx)
306 const struct string_set *pats = ctx->wimboot.prepopulate_pats;
308 if (!pats || !pats->num_strings)
311 return match_pattern_list(dentry->_full_path,
312 wcslen(dentry->_full_path), pats);
315 static const wchar_t *
316 current_path(struct win32_apply_ctx *ctx);
319 build_extraction_path(const struct wim_dentry *dentry,
320 struct win32_apply_ctx *ctx);
322 #define WIM_BACKING_NOT_ENABLED -1
323 #define WIM_BACKING_NOT_POSSIBLE -2
324 #define WIM_BACKING_EXCLUDED -3
327 * Determines if the unnamed data stream of a file will be created as an
328 * external backing, as opposed to a standard extraction.
331 win32_will_externally_back(struct wim_dentry *dentry, struct apply_ctx *_ctx)
333 struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
334 struct wim_lookup_table_entry *stream;
337 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
338 return WIM_BACKING_NOT_ENABLED;
340 if (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
341 FILE_ATTRIBUTE_REPARSE_POINT |
342 FILE_ATTRIBUTE_ENCRYPTED))
343 return WIM_BACKING_NOT_POSSIBLE;
345 stream = inode_unnamed_lte_resolved(dentry->d_inode);
348 stream->resource_location != RESOURCE_IN_WIM ||
349 stream->rspec->wim != ctx->common.wim ||
350 stream->size != stream->rspec->uncompressed_size)
351 return WIM_BACKING_NOT_POSSIBLE;
353 ret = calculate_dentry_full_path(dentry);
357 if (in_prepopulate_list(dentry, ctx))
358 return WIM_BACKING_EXCLUDED;
364 set_external_backing(struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
368 ret = win32_will_externally_back(dentry, &ctx->common);
369 if (ret > 0) /* Error. */
372 if (ret < 0 && ret != WIM_BACKING_EXCLUDED)
373 return 0; /* Not externally backing, other than due to exclusion. */
375 build_extraction_path(dentry, ctx);
377 if (ret == WIM_BACKING_EXCLUDED) {
378 /* Not externally backing due to exclusion. */
379 union wimlib_progress_info info;
381 info.wimboot_exclude.path_in_wim = dentry->_full_path;
382 info.wimboot_exclude.extraction_path = current_path(ctx);
384 return call_progress(ctx->common.progfunc,
385 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE,
386 &info, ctx->common.progctx);
388 /* Externally backing. */
389 return wimboot_set_pointer(&ctx->attr,
391 inode_unnamed_lte_resolved(dentry->d_inode),
392 ctx->wimboot.data_source_id,
393 ctx->wimboot.wim_lookup_table_hash,
394 ctx->wimboot.wof_running);
398 /* Calculates the SHA-1 message digest of the WIM's lookup table. */
400 hash_lookup_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
402 return wim_reshdr_to_hash(&wim->hdr.lookup_table_reshdr, wim, hash);
405 /* Prepare for doing a "WIMBoot" extraction by loading patterns from
406 * [PrepopulateList] of WimBootCompress.ini and allocating a WOF data source ID
407 * on the target volume. */
409 start_wimboot_extraction(struct win32_apply_ctx *ctx)
412 WIMStruct *wim = ctx->common.wim;
414 ret = load_prepopulate_pats(ctx);
415 if (ret == WIMLIB_ERR_NOMEM)
418 if (!wim_info_get_wimboot(wim->wim_info, wim->current_image))
419 WARNING("Image is not marked as WIMBoot compatible!");
421 ret = hash_lookup_table(ctx->common.wim,
422 ctx->wimboot.wim_lookup_table_hash);
426 return wimboot_alloc_data_source_id(wim->filename,
430 &ctx->wimboot.data_source_id,
431 &ctx->wimboot.wof_running);
435 build_win32_extraction_path(const struct wim_dentry *dentry,
436 struct win32_apply_ctx *ctx);
438 /* Sets WimBoot=1 in the extracted SYSTEM registry hive.
440 * WIMGAPI does this, and it's possible that it's important.
441 * But I don't know exactly what this value means to Windows. */
443 end_wimboot_extraction(struct win32_apply_ctx *ctx)
445 struct wim_dentry *dentry;
446 wchar_t subkeyname[32];
452 dentry = get_dentry(ctx->common.wim, L"\\Windows\\System32\\config\\SYSTEM",
453 WIMLIB_CASE_INSENSITIVE);
455 if (!dentry || !will_extract_dentry(dentry))
458 if (!will_extract_dentry(wim_get_current_root_dentry(ctx->common.wim)))
461 /* Not bothering to use the native routines (e.g. NtLoadKey()) for this.
462 * If this doesn't work, you probably also have many other problems. */
464 build_win32_extraction_path(dentry, ctx);
466 randomize_char_array_with_alnum(subkeyname, 20);
467 subkeyname[20] = L'\0';
469 res = RegLoadKey(HKEY_LOCAL_MACHINE, subkeyname, ctx->pathbuf.Buffer);
473 wcscpy(&subkeyname[20], L"\\Setup");
475 res = RegCreateKeyEx(HKEY_LOCAL_MACHINE, subkeyname, 0, NULL,
476 REG_OPTION_BACKUP_RESTORE, 0, NULL, &key, NULL);
482 res = RegSetValueEx(key, L"WimBoot", 0, REG_DWORD,
483 (const BYTE *)&value, sizeof(DWORD));
487 res = RegFlushKey(key);
490 res2 = RegCloseKey(key);
494 subkeyname[20] = L'\0';
495 RegUnLoadKey(HKEY_LOCAL_MACHINE, subkeyname);
499 set_errno_from_win32_error(res);
500 WARNING_WITH_ERRNO("Failed to set \\Setup: dword \"WimBoot\"=1 value "
501 "in registry hive \"%ls\" (err=%"PRIu32")",
502 ctx->pathbuf.Buffer, (u32)res);
508 /* Returns the number of wide characters needed to represent the path to the
509 * specified @dentry, relative to the target directory, when extracted.
511 * Does not include null terminator (not needed for NtCreateFile). */
513 dentry_extraction_path_length(const struct wim_dentry *dentry)
516 const struct wim_dentry *d;
520 len += d->d_extraction_name_nchars + 1;
522 } while (!dentry_is_root(d) && will_extract_dentry(d));
524 return --len; /* No leading slash */
527 /* Returns the length of the longest string that might need to be appended to
528 * the path to an alias of an inode to open or create a named data stream.
530 * If the inode has no named data streams, this will be 0. Otherwise, this will
531 * be 1 plus the length of the longest-named data stream, since the data stream
532 * name must be separated from the path by the ':' character. */
534 inode_longest_named_data_stream_spec(const struct wim_inode *inode)
537 for (u16 i = 0; i < inode->i_num_ads; i++) {
538 size_t len = inode->i_ads_entries[i].stream_name_nbytes;
543 max = 1 + (max / sizeof(wchar_t));
547 /* Find the length, in wide characters, of the longest path needed for
548 * extraction of any file in @dentry_list relative to the target directory.
550 * Accounts for named data streams, but does not include null terminator (not
551 * needed for NtCreateFile). */
553 compute_path_max(struct list_head *dentry_list)
556 const struct wim_dentry *dentry;
558 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
561 len = dentry_extraction_path_length(dentry);
563 /* Account for named data streams */
564 len += inode_longest_named_data_stream_spec(dentry->d_inode);
573 /* Build the path at which to extract the @dentry, relative to the target
576 * The path is saved in ctx->pathbuf. */
578 build_extraction_path(const struct wim_dentry *dentry,
579 struct win32_apply_ctx *ctx)
583 const struct wim_dentry *d;
585 len = dentry_extraction_path_length(dentry);
587 ctx->pathbuf.Length = len * sizeof(wchar_t);
588 p = ctx->pathbuf.Buffer + len;
590 !dentry_is_root(d->d_parent) && will_extract_dentry(d->d_parent);
593 p -= d->d_extraction_name_nchars;
594 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
597 /* No leading slash */
598 p -= d->d_extraction_name_nchars;
599 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
602 /* Build the path at which to extract the @dentry, relative to the target
603 * directory, adding the suffix for a named data stream.
605 * The path is saved in ctx->pathbuf. */
607 build_extraction_path_with_ads(const struct wim_dentry *dentry,
608 struct win32_apply_ctx *ctx,
609 const wchar_t *stream_name,
610 size_t stream_name_nchars)
614 build_extraction_path(dentry, ctx);
616 /* Add :NAME for named data stream */
617 p = ctx->pathbuf.Buffer + (ctx->pathbuf.Length / sizeof(wchar_t));
619 wmemcpy(p, stream_name, stream_name_nchars);
620 ctx->pathbuf.Length += (1 + stream_name_nchars) * sizeof(wchar_t);
623 /* Build the Win32 namespace path to the specified @dentry when extracted.
625 * The path is saved in ctx->pathbuf and will be null terminated.
627 * XXX: We could get rid of this if it wasn't needed for the file encryption
628 * APIs, and the registry manipulation in WIMBoot mode. */
630 build_win32_extraction_path(const struct wim_dentry *dentry,
631 struct win32_apply_ctx *ctx)
633 build_extraction_path(dentry, ctx);
635 /* Prepend target_ntpath to our relative path, then change \??\ into \\?\ */
637 memmove(ctx->pathbuf.Buffer +
638 (ctx->target_ntpath.Length / sizeof(wchar_t)) + 1,
639 ctx->pathbuf.Buffer, ctx->pathbuf.Length);
640 memcpy(ctx->pathbuf.Buffer, ctx->target_ntpath.Buffer,
641 ctx->target_ntpath.Length);
642 ctx->pathbuf.Buffer[ctx->target_ntpath.Length / sizeof(wchar_t)] = L'\\';
643 ctx->pathbuf.Length += ctx->target_ntpath.Length + sizeof(wchar_t);
644 ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)] = L'\0';
646 wimlib_assert(ctx->pathbuf.Length >= 4 * sizeof(wchar_t) &&
647 !wmemcmp(ctx->pathbuf.Buffer, L"\\??\\", 4));
649 ctx->pathbuf.Buffer[1] = L'\\';
653 /* Returns a "printable" representation of the last relative NT path that was
654 * constructed with build_extraction_path() or build_extraction_path_with_ads().
656 * This will be overwritten by the next call to this function. */
657 static const wchar_t *
658 current_path(struct win32_apply_ctx *ctx)
660 wchar_t *p = ctx->print_buffer;
662 p = wmempcpy(p, ctx->common.target, ctx->common.target_nchars);
664 p = wmempcpy(p, ctx->pathbuf.Buffer, ctx->pathbuf.Length / sizeof(wchar_t));
666 return ctx->print_buffer;
670 * Ensures the target directory exists and opens a handle to it, in preparation
671 * of using paths relative to it.
674 prepare_target(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
680 /* Open handle to the target directory (possibly creating it). */
682 ret = win32_path_to_nt_path(ctx->common.target, &ctx->target_ntpath);
686 ctx->attr.Length = sizeof(ctx->attr);
687 ctx->attr.ObjectName = &ctx->target_ntpath;
689 status = (*func_NtCreateFile)(&ctx->h_target,
695 FILE_SHARE_VALID_FLAGS,
697 FILE_DIRECTORY_FILE |
698 FILE_OPEN_REPARSE_POINT |
699 FILE_OPEN_FOR_BACKUP_INTENT,
703 if (!NT_SUCCESS(status)) {
704 set_errno_from_nt_status(status);
705 ERROR_WITH_ERRNO("Can't open or create directory \"%ls\" "
706 "(status=0x%08"PRIx32")",
707 ctx->common.target, (u32)status);
708 return WIMLIB_ERR_OPENDIR;
711 path_max = compute_path_max(dentry_list);
713 /* Add some extra for building Win32 paths for the file encryption APIs
715 path_max += 2 + (ctx->target_ntpath.Length / sizeof(wchar_t));
717 ctx->pathbuf.MaximumLength = path_max * sizeof(wchar_t);
718 ctx->pathbuf.Buffer = MALLOC(ctx->pathbuf.MaximumLength);
719 if (!ctx->pathbuf.Buffer)
720 return WIMLIB_ERR_NOMEM;
722 ctx->attr.RootDirectory = ctx->h_target;
723 ctx->attr.ObjectName = &ctx->pathbuf;
725 ctx->print_buffer = MALLOC((ctx->common.target_nchars + 1 + path_max + 1) *
727 if (!ctx->print_buffer)
728 return WIMLIB_ERR_NOMEM;
733 /* When creating an inode that will have a short (DOS) name, we create it using
734 * the long name associated with the short name. This ensures that the short
735 * name gets associated with the correct long name. */
736 static struct wim_dentry *
737 first_extraction_alias(const struct wim_inode *inode)
739 struct list_head *next = inode->i_extraction_aliases.next;
740 struct wim_dentry *dentry;
743 dentry = list_entry(next, struct wim_dentry,
744 d_extraction_alias_node);
745 if (dentry_has_short_name(dentry))
748 } while (next != &inode->i_extraction_aliases);
753 * Set or clear FILE_ATTRIBUTE_COMPRESSED if the inherited value is different
754 * from the desired value.
756 * Note that you can NOT override the inherited value of
757 * FILE_ATTRIBUTE_COMPRESSED directly with NtCreateFile().
760 adjust_compression_attribute(HANDLE h, const struct wim_dentry *dentry,
761 struct win32_apply_ctx *ctx)
763 const bool compressed = (dentry->d_inode->i_attributes &
764 FILE_ATTRIBUTE_COMPRESSED);
766 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
769 if (!ctx->common.supported_features.compressed_files)
772 FILE_BASIC_INFORMATION info;
774 USHORT compression_state;
776 /* Get current attributes */
777 status = (*func_NtQueryInformationFile)(h, &ctx->iosb,
779 FileBasicInformation);
780 if (NT_SUCCESS(status) &&
781 compressed == !!(info.FileAttributes & FILE_ATTRIBUTE_COMPRESSED))
783 /* Nothing needs to be done. */
787 /* Set the new compression state */
790 compression_state = COMPRESSION_FORMAT_DEFAULT;
792 compression_state = COMPRESSION_FORMAT_NONE;
794 status = (*func_NtFsControlFile)(h,
799 FSCTL_SET_COMPRESSION,
804 if (NT_SUCCESS(status))
807 set_errno_from_nt_status(status);
808 ERROR_WITH_ERRNO("Can't %s compression attribute on \"%ls\" "
809 "(status=0x%08"PRIx32")",
810 (compressed ? "set" : "clear"),
811 current_path(ctx), status);
812 return WIMLIB_ERR_SET_ATTRIBUTES;
816 * Clear FILE_ATTRIBUTE_ENCRYPTED if the file or directory is not supposed to be
819 * You can provide FILE_ATTRIBUTE_ENCRYPTED to NtCreateFile() to set it on the
820 * created file. However, the file or directory will otherwise default to the
821 * encryption state of the parent directory. This function works around this
822 * limitation by using DecryptFile() to remove FILE_ATTRIBUTE_ENCRYPTED on files
823 * (and directories) that are not supposed to have it set.
825 * Regardless of whether it succeeds or fails, this function may close the
826 * handle to the file. If it does, it sets it to NULL.
829 maybe_clear_encryption_attribute(HANDLE *h_ptr, const struct wim_dentry *dentry,
830 struct win32_apply_ctx *ctx)
832 if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
835 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
838 if (!ctx->common.supported_features.encrypted_files)
841 FILE_BASIC_INFORMATION info;
845 /* Get current attributes */
846 status = (*func_NtQueryInformationFile)(*h_ptr, &ctx->iosb,
848 FileBasicInformation);
849 if (NT_SUCCESS(status) &&
850 !(info.FileAttributes & FILE_ATTRIBUTE_ENCRYPTED))
852 /* Nothing needs to be done. */
856 /* Set the new encryption state */
858 /* Due to Windows' crappy file encryption APIs, we need to close the
859 * handle to the file so we don't get ERROR_SHARING_VIOLATION. We also
860 * hack together a Win32 path, although we will use the \\?\ prefix so
861 * it will actually be a NT path in disguise... */
862 (*func_NtClose)(*h_ptr);
865 build_win32_extraction_path(dentry, ctx);
867 bret = DecryptFile(ctx->pathbuf.Buffer, 0);
869 /* Restore the NT namespace path */
870 build_extraction_path(dentry, ctx);
873 DWORD err = GetLastError();
874 set_errno_from_win32_error(err);
875 ERROR_WITH_ERRNO("Can't decrypt file \"%ls\" (err=%"PRIu32")",
876 current_path(ctx), (u32)err);
877 return WIMLIB_ERR_SET_ATTRIBUTES;
882 /* Try to enable short name support on the target volume. If successful, return
883 * true. If unsuccessful, issue a warning and return false. */
885 try_to_enable_short_names(const wchar_t *volume)
888 FILE_FS_PERSISTENT_VOLUME_INFORMATION info;
892 h = CreateFile(volume, GENERIC_WRITE,
893 FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
894 FILE_FLAG_BACKUP_SEMANTICS, NULL);
895 if (h == INVALID_HANDLE_VALUE)
898 info.VolumeFlags = 0;
899 info.FlagMask = PERSISTENT_VOLUME_STATE_SHORT_NAME_CREATION_DISABLED;
903 bret = DeviceIoControl(h, FSCTL_SET_PERSISTENT_VOLUME_STATE,
904 &info, sizeof(info), NULL, 0,
905 &bytesReturned, NULL);
914 WARNING("Failed to enable short name support on %ls "
915 "(err=%"PRIu32")", volume + 4, (u32)GetLastError());
919 /* Set the short name on the open file @h which has been created at the location
920 * indicated by @dentry.
922 * Note that this may add, change, or remove the short name.
924 * @h must be opened with DELETE access.
926 * Returns 0 or WIMLIB_ERR_SET_SHORT_NAME. The latter only happens in
927 * STRICT_SHORT_NAMES mode.
930 set_short_name(HANDLE h, const struct wim_dentry *dentry,
931 struct win32_apply_ctx *ctx)
934 if (!ctx->common.supported_features.short_names)
938 * Note: The size of the FILE_NAME_INFORMATION buffer must be such that
939 * FileName contains at least 2 wide characters (4 bytes). Otherwise,
940 * NtSetInformationFile() will return STATUS_INFO_LENGTH_MISMATCH. This
941 * is despite the fact that FileNameLength can validly be 0 or 2 bytes,
942 * with the former case being removing the existing short name if
943 * present, rather than setting one.
945 * FileName seemingly does not, however, need to be null-terminated in
949 size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
950 max(dentry->short_name_nbytes, 2 * sizeof(wchar_t));
951 u8 buf[bufsize] _aligned_attribute(8);
952 FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
955 info->FileNameLength = dentry->short_name_nbytes;
956 memcpy(info->FileName, dentry->short_name, dentry->short_name_nbytes);
960 status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
961 FileShortNameInformation);
962 if (NT_SUCCESS(status))
965 if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
966 if (dentry->short_name_nbytes == 0)
968 if (!ctx->tried_to_enable_short_names) {
972 ctx->tried_to_enable_short_names = true;
974 ret = win32_get_drive_path(ctx->common.target,
978 if (try_to_enable_short_names(volume))
983 /* By default, failure to set short names is not an error (since short
984 * names aren't too important anymore...). */
985 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
986 ctx->num_short_name_failures++;
990 if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
991 ERROR("Can't set short name when short "
992 "names are not enabled on the volume!");
994 ERROR("Can't set short name on \"%ls\" (status=0x%08"PRIx32")",
995 current_path(ctx), (u32)status);
997 return WIMLIB_ERR_SET_SHORT_NAME;
1001 * A wrapper around NtCreateFile() to make it slightly more usable...
1002 * This uses the path currently constructed in ctx->pathbuf.
1004 * Also, we always specify FILE_OPEN_FOR_BACKUP_INTENT and
1005 * FILE_OPEN_REPARSE_POINT.
1008 do_create_file(PHANDLE FileHandle,
1009 ACCESS_MASK DesiredAccess,
1010 PLARGE_INTEGER AllocationSize,
1011 ULONG FileAttributes,
1012 ULONG CreateDisposition,
1013 ULONG CreateOptions,
1014 struct win32_apply_ctx *ctx)
1016 return (*func_NtCreateFile)(FileHandle,
1022 FILE_SHARE_VALID_FLAGS,
1025 FILE_OPEN_FOR_BACKUP_INTENT |
1026 FILE_OPEN_REPARSE_POINT,
1031 /* Like do_create_file(), but builds the extraction path of the @dentry first.
1034 create_file(PHANDLE FileHandle,
1035 ACCESS_MASK DesiredAccess,
1036 PLARGE_INTEGER AllocationSize,
1037 ULONG FileAttributes,
1038 ULONG CreateDisposition,
1039 ULONG CreateOptions,
1040 const struct wim_dentry *dentry,
1041 struct win32_apply_ctx *ctx)
1043 build_extraction_path(dentry, ctx);
1044 return do_create_file(FileHandle,
1053 /* Create empty named data streams.
1055 * Since these won't have 'struct wim_lookup_table_entry's, they won't show up
1056 * in the call to extract_stream_list(). Hence the need for the special case.
1059 create_any_empty_ads(const struct wim_dentry *dentry,
1060 struct win32_apply_ctx *ctx)
1062 const struct wim_inode *inode = dentry->d_inode;
1063 LARGE_INTEGER allocation_size;
1064 bool path_modified = false;
1067 if (!ctx->common.supported_features.named_data_streams)
1070 for (u16 i = 0; i < inode->i_num_ads; i++) {
1071 const struct wim_ads_entry *entry;
1075 entry = &inode->i_ads_entries[i];
1078 if (!entry->stream_name_nbytes)
1085 /* Probably setting the allocation size to 0 has no effect, but
1086 * we might as well try. */
1087 allocation_size.QuadPart = 0;
1089 build_extraction_path_with_ads(dentry, ctx,
1091 entry->stream_name_nbytes /
1093 path_modified = true;
1094 status = do_create_file(&h, FILE_WRITE_DATA, &allocation_size,
1095 0, FILE_SUPERSEDE, 0, ctx);
1096 if (!NT_SUCCESS(status)) {
1097 set_errno_from_nt_status(status);
1098 ERROR_WITH_ERRNO("Can't create \"%ls\" "
1099 "(status=0x%08"PRIx32")",
1100 current_path(ctx), (u32)status);
1101 ret = WIMLIB_ERR_OPEN;
1106 /* Restore the path to the dentry itself */
1108 build_extraction_path(dentry, ctx);
1113 * Creates the directory named by @dentry, or uses an existing directory at that
1114 * location. If necessary, sets the short name and/or fixes compression and
1115 * encryption attributes.
1117 * Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
1120 create_directory(const struct wim_dentry *dentry,
1121 struct win32_apply_ctx *ctx)
1128 /* Special attributes:
1130 * Use FILE_ATTRIBUTE_ENCRYPTED if the directory needs to have it set.
1131 * This doesn't work for FILE_ATTRIBUTE_COMPRESSED (unfortunately).
1133 * Don't specify FILE_ATTRIBUTE_DIRECTORY; it gets set anyway as a
1134 * result of the FILE_DIRECTORY_FILE option. */
1135 attrib = (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED);
1137 /* DELETE is needed for set_short_name().
1138 * GENERIC_READ and GENERIC_WRITE are needed for
1139 * adjust_compression_attribute(). */
1140 status = create_file(&h, GENERIC_READ | GENERIC_WRITE | DELETE, NULL,
1141 attrib, FILE_OPEN_IF, FILE_DIRECTORY_FILE,
1143 if (!NT_SUCCESS(status)) {
1144 set_errno_from_nt_status(status);
1145 ERROR_WITH_ERRNO("Can't create directory \"%ls\" "
1146 "(status=0x%08"PRIx32")",
1147 current_path(ctx), (u32)status);
1148 return WIMLIB_ERR_MKDIR;
1151 ret = set_short_name(h, dentry, ctx);
1154 ret = adjust_compression_attribute(h, dentry, ctx);
1157 ret = maybe_clear_encryption_attribute(&h, dentry, ctx);
1158 /* May close the handle!!! */
1166 * Create all the directories being extracted, other than the target directory
1169 * Note: we don't honor directory hard links. However, we don't allow them to
1170 * exist in WIM images anyway (see inode_fixup.c).
1173 create_directories(struct list_head *dentry_list,
1174 struct win32_apply_ctx *ctx)
1176 const struct wim_dentry *dentry;
1179 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1181 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
1184 /* Note: Here we include files with
1185 * FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
1186 * wait until later to actually set the reparse data. */
1188 /* If the root dentry is being extracted, it was already done so
1189 * in prepare_target(). */
1190 if (dentry_is_root(dentry))
1193 ret = create_directory(dentry, ctx);
1197 ret = create_any_empty_ads(dentry, ctx);
1201 ret = report_file_created(&ctx->common);
1209 * Creates the nondirectory file named by @dentry.
1211 * On success, returns an open handle to the file in @h_ret, with GENERIC_READ,
1212 * GENERIC_WRITE, and DELETE access. Also, the path to the file will be saved
1213 * in ctx->pathbuf. On failure, returns WIMLIB_ERR_OPEN.
1216 create_nondirectory_inode(HANDLE *h_ret, const struct wim_dentry *dentry,
1217 struct win32_apply_ctx *ctx)
1219 const struct wim_inode *inode;
1222 bool retried = false;
1224 inode = dentry->d_inode;
1226 /* If the file already exists and has FILE_ATTRIBUTE_SYSTEM and/or
1227 * FILE_ATTRIBUTE_HIDDEN, these must be specified in order to supersede
1230 * Normally the user shouldn't be trying to overwrite such files anyway,
1231 * but we at least provide FILE_ATTRIBUTE_SYSTEM and
1232 * FILE_ATTRIBUTE_HIDDEN if the WIM inode has those attributes so that
1233 * we catch the case where the user extracts the same files to the same
1234 * location more than one time.
1236 * Also specify FILE_ATTRIBUTE_ENCRYPTED if the file needs to be
1239 * In NO_ATTRIBUTES mode just don't specify any attributes at all.
1241 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) {
1244 attrib = (inode->i_attributes & (FILE_ATTRIBUTE_SYSTEM |
1245 FILE_ATTRIBUTE_HIDDEN |
1246 FILE_ATTRIBUTE_ENCRYPTED));
1248 build_extraction_path(dentry, ctx);
1250 status = do_create_file(h_ret, GENERIC_READ | GENERIC_WRITE | DELETE,
1251 NULL, attrib, FILE_SUPERSEDE,
1252 FILE_NON_DIRECTORY_FILE, ctx);
1253 if (NT_SUCCESS(status)) {
1256 ret = adjust_compression_attribute(*h_ret, dentry, ctx);
1258 (*func_NtClose)(*h_ret);
1262 ret = maybe_clear_encryption_attribute(h_ret, dentry, ctx);
1263 /* May close the handle!!! */
1267 (*func_NtClose)(*h_ret);
1272 /* Re-open the handle so that we can return it on
1274 status = do_create_file(h_ret,
1276 GENERIC_WRITE | DELETE,
1278 FILE_NON_DIRECTORY_FILE, ctx);
1279 if (!NT_SUCCESS(status))
1283 ret = create_any_empty_ads(dentry, ctx);
1285 (*func_NtClose)(*h_ret);
1291 if (status == STATUS_ACCESS_DENIED && !retried) {
1292 /* We also can't supersede an existing file that has
1293 * FILE_ATTRIBUTE_READONLY set; doing so causes NtCreateFile()
1294 * to return STATUS_ACCESS_DENIED . The only workaround seems
1295 * to be to explicitly remove FILE_ATTRIBUTE_READONLY on the
1296 * existing file, then try again. */
1298 FILE_BASIC_INFORMATION info;
1301 status = do_create_file(&h, FILE_WRITE_ATTRIBUTES, NULL, 0,
1302 FILE_OPEN, FILE_NON_DIRECTORY_FILE, ctx);
1303 if (!NT_SUCCESS(status))
1306 memset(&info, 0, sizeof(info));
1307 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
1309 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1310 &info, sizeof(info),
1311 FileBasicInformation);
1313 if (!NT_SUCCESS(status))
1319 set_errno_from_nt_status(status);
1320 ERROR_WITH_ERRNO("Can't create file \"%ls\" (status=0x%08"PRIx32")",
1321 current_path(ctx), (u32)status);
1322 return WIMLIB_ERR_OPEN;
1325 /* Creates a hard link at the location named by @dentry to the file represented
1326 * by the open handle @h. Or, if the target volume does not support hard links,
1327 * create a separate file instead. */
1329 create_link(HANDLE h, const struct wim_dentry *dentry,
1330 struct win32_apply_ctx *ctx)
1332 if (ctx->common.supported_features.hard_links) {
1334 build_extraction_path(dentry, ctx);
1336 size_t bufsize = offsetof(FILE_LINK_INFORMATION, FileName) +
1337 ctx->pathbuf.Length + sizeof(wchar_t);
1338 u8 buf[bufsize] _aligned_attribute(8);
1339 FILE_LINK_INFORMATION *info = (FILE_LINK_INFORMATION *)buf;
1342 info->ReplaceIfExists = TRUE;
1343 info->RootDirectory = ctx->attr.RootDirectory;
1344 info->FileNameLength = ctx->pathbuf.Length;
1345 memcpy(info->FileName, ctx->pathbuf.Buffer, ctx->pathbuf.Length);
1346 info->FileName[info->FileNameLength / 2] = L'\0';
1348 /* Note: the null terminator isn't actually necessary,
1349 * but if you don't add the extra character, you get
1350 * STATUS_INFO_LENGTH_MISMATCH when FileNameLength
1351 * happens to be 2 */
1353 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1355 FileLinkInformation);
1356 if (NT_SUCCESS(status))
1358 ERROR("Failed to create link \"%ls\" (status=0x%08"PRIx32")",
1359 current_path(ctx), (u32)status);
1360 return WIMLIB_ERR_LINK;
1365 ret = create_nondirectory_inode(&h2, dentry, ctx);
1369 (*func_NtClose)(h2);
1374 /* Given an inode (represented by the open handle @h) for which one link has
1375 * been created (named by @first_dentry), create the other links.
1377 * Or, if the target volume does not support hard links, create separate files.
1379 * Note: This uses ctx->pathbuf and does not reset it.
1382 create_links(HANDLE h, const struct wim_dentry *first_dentry,
1383 struct win32_apply_ctx *ctx)
1385 const struct wim_inode *inode;
1386 const struct list_head *next;
1387 const struct wim_dentry *dentry;
1390 inode = first_dentry->d_inode;
1391 next = inode->i_extraction_aliases.next;
1393 dentry = list_entry(next, struct wim_dentry,
1394 d_extraction_alias_node);
1395 if (dentry != first_dentry) {
1396 ret = create_link(h, dentry, ctx);
1401 } while (next != &inode->i_extraction_aliases);
1405 /* Create a nondirectory file, including all links. */
1407 create_nondirectory(const struct wim_inode *inode, struct win32_apply_ctx *ctx)
1409 struct wim_dentry *first_dentry;
1413 first_dentry = first_extraction_alias(inode);
1415 /* Create first link. */
1416 ret = create_nondirectory_inode(&h, first_dentry, ctx);
1420 /* Set short name. */
1421 ret = set_short_name(h, first_dentry, ctx);
1423 /* Create additional links, OR if hard links are not supported just
1424 * create more files. */
1426 ret = create_links(h, first_dentry, ctx);
1428 /* "WIMBoot" extraction: set external backing by the WIM file if needed. */
1429 if (!ret && unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
1430 ret = set_external_backing(first_dentry, ctx);
1436 /* Create all the nondirectory files being extracted, including all aliases
1439 create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1441 const struct wim_dentry *dentry;
1442 const struct wim_inode *inode;
1445 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1446 inode = dentry->d_inode;
1447 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1449 /* Call create_nondirectory() only once per inode */
1450 if (dentry != inode_first_extraction_dentry(inode))
1452 ret = create_nondirectory(inode, ctx);
1455 ret = report_file_created(&ctx->common);
1463 close_handles(struct win32_apply_ctx *ctx)
1465 for (unsigned i = 0; i < ctx->num_open_handles; i++)
1466 (*func_NtClose)(ctx->open_handles[i]);
1469 /* Prepare to read the next stream, which has size @stream_size, into an
1470 * in-memory buffer. */
1472 prepare_data_buffer(struct win32_apply_ctx *ctx, u64 stream_size)
1474 if (stream_size > ctx->data_buffer_size) {
1475 /* Larger buffer needed. */
1477 if ((size_t)stream_size != stream_size)
1478 return WIMLIB_ERR_NOMEM;
1479 new_buffer = REALLOC(ctx->data_buffer, stream_size);
1481 return WIMLIB_ERR_NOMEM;
1482 ctx->data_buffer = new_buffer;
1483 ctx->data_buffer_size = stream_size;
1485 /* On the first call this changes data_buffer_ptr from NULL, which tells
1486 * extract_chunk() that the data buffer needs to be filled while reading
1487 * the stream data. */
1488 ctx->data_buffer_ptr = ctx->data_buffer;
1493 begin_extract_stream_instance(const struct wim_lookup_table_entry *stream,
1494 struct wim_dentry *dentry,
1495 const wchar_t *stream_name,
1496 struct win32_apply_ctx *ctx)
1498 const struct wim_inode *inode = dentry->d_inode;
1499 size_t stream_name_nchars = 0;
1500 FILE_ALLOCATION_INFORMATION alloc_info;
1504 if (unlikely(stream_name))
1505 stream_name_nchars = wcslen(stream_name);
1507 if (unlikely(stream_name_nchars)) {
1508 build_extraction_path_with_ads(dentry, ctx,
1509 stream_name, stream_name_nchars);
1511 build_extraction_path(dentry, ctx);
1514 /* Reparse point? */
1515 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
1516 && (stream_name_nchars == 0))
1518 if (!ctx->common.supported_features.reparse_points)
1521 /* We can't write the reparse stream directly; we must set it
1522 * with FSCTL_SET_REPARSE_POINT, which requires that all the
1523 * data be available. So, stage the data in a buffer. */
1525 list_add_tail(&dentry->tmp_list, &ctx->reparse_dentries);
1526 return prepare_data_buffer(ctx, stream->size);
1529 /* Encrypted file? */
1530 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
1531 && (stream_name_nchars == 0))
1533 if (!ctx->common.supported_features.encrypted_files)
1536 /* We can't write encrypted file streams directly; we must use
1537 * WriteEncryptedFileRaw(), which requires providing the data
1538 * through a callback function. This can't easily be combined
1539 * with our own callback-based approach.
1541 * The current workaround is to simply read the stream into
1542 * memory and write the encrypted file from that.
1544 * TODO: This isn't sufficient for extremely large encrypted
1545 * files. Perhaps we should create an extra thread to write
1547 list_add_tail(&dentry->tmp_list, &ctx->encrypted_dentries);
1548 return prepare_data_buffer(ctx, stream->size);
1551 if (ctx->num_open_handles == MAX_OPEN_STREAMS) {
1552 /* XXX: Fix this. But because of the checks in
1553 * extract_stream_list(), this can now only happen on a
1554 * filesystem that does not support hard links. */
1555 ERROR("Can't extract data: too many open files!");
1556 return WIMLIB_ERR_UNSUPPORTED;
1559 /* Open a new handle */
1560 status = do_create_file(&h,
1561 FILE_WRITE_DATA | SYNCHRONIZE,
1562 NULL, 0, FILE_OPEN_IF,
1563 FILE_SEQUENTIAL_ONLY |
1564 FILE_SYNCHRONOUS_IO_NONALERT,
1566 if (!NT_SUCCESS(status)) {
1567 set_errno_from_nt_status(status);
1568 ERROR_WITH_ERRNO("Can't open \"%ls\" for writing "
1569 "(status=0x%08"PRIx32")",
1570 current_path(ctx), (u32)status);
1571 return WIMLIB_ERR_OPEN;
1574 ctx->open_handles[ctx->num_open_handles++] = h;
1576 /* Allocate space for the data. */
1577 alloc_info.AllocationSize.QuadPart = stream->size;
1578 (*func_NtSetInformationFile)(h, &ctx->iosb,
1579 &alloc_info, sizeof(alloc_info),
1580 FileAllocationInformation);
1584 /* Set the reparse data @rpbuf of length @rpbuflen on the extracted file
1585 * corresponding to the WIM dentry @dentry. */
1587 do_set_reparse_data(const struct wim_dentry *dentry,
1588 const void *rpbuf, u16 rpbuflen,
1589 struct win32_apply_ctx *ctx)
1594 status = create_file(&h, GENERIC_WRITE, NULL,
1595 0, FILE_OPEN, 0, dentry, ctx);
1596 if (!NT_SUCCESS(status))
1599 status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
1600 &ctx->iosb, FSCTL_SET_REPARSE_POINT,
1601 (void *)rpbuf, rpbuflen,
1605 if (NT_SUCCESS(status))
1608 /* On Windows, by default only the Administrator can create symbolic
1609 * links for some reason. By default we just issue a warning if this
1610 * appears to be the problem. Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
1611 * to get a hard error. */
1612 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
1613 && (status == STATUS_PRIVILEGE_NOT_HELD ||
1614 status == STATUS_ACCESS_DENIED)
1615 && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1616 dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1618 WARNING("Can't create symbolic link \"%ls\"! \n"
1619 " (Need Administrator rights, or at least "
1621 " SeCreateSymbolicLink privilege.)",
1627 set_errno_from_nt_status(status);
1628 ERROR_WITH_ERRNO("Can't set reparse data on \"%ls\" "
1629 "(status=0x%08"PRIx32")",
1630 current_path(ctx), (u32)status);
1631 return WIMLIB_ERR_SET_REPARSE_DATA;
1634 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1635 * pointer to the suffix of the path that begins with the device directly, such
1636 * as e:\Windows\System32. */
1637 static const wchar_t *
1638 skip_nt_toplevel_component(const wchar_t *path, size_t path_nchars)
1640 static const wchar_t * const dirs[] = {
1645 size_t first_dir_len = 0;
1646 const wchar_t * const end = path + path_nchars;
1648 for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
1649 size_t len = wcslen(dirs[i]);
1650 if (len <= (end - path) && !wcsnicmp(path, dirs[i], len)) {
1651 first_dir_len = len;
1655 if (first_dir_len == 0)
1657 path += first_dir_len;
1658 while (path != end && *path == L'\\')
1663 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1664 * pointer to the suffix of the path that is device-relative, such as
1667 * The path has an explicit length and is not necessarily null terminated.
1669 * If the path just something like \??\e: then the returned pointer will point
1670 * just past the colon. In this case the length of the result will be 0
1672 static const wchar_t *
1673 get_device_relative_path(const wchar_t *path, size_t path_nchars)
1675 const wchar_t * const orig_path = path;
1676 const wchar_t * const end = path + path_nchars;
1678 path = skip_nt_toplevel_component(path, path_nchars);
1679 if (path == orig_path)
1682 path = wmemchr(path, L'\\', (end - path));
1687 } while (path != end && *path == L'\\');
1692 * Given a reparse point buffer for a symbolic link or junction, adjust its
1693 * contents so that the target of the link is consistent with the new location
1697 try_rpfix(u8 *rpbuf, u16 *rpbuflen_p, struct win32_apply_ctx *ctx)
1699 struct reparse_data rpdata;
1700 size_t orig_subst_name_nchars;
1701 const wchar_t *relpath;
1702 size_t relpath_nchars;
1703 size_t target_ntpath_nchars;
1704 size_t fixed_subst_name_nchars;
1705 const wchar_t *fixed_print_name;
1706 size_t fixed_print_name_nchars;
1708 if (parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata)) {
1709 /* Do nothing if the reparse data is invalid. */
1713 if (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK &&
1714 (rpdata.rpflags & SYMBOLIC_LINK_RELATIVE))
1716 /* Do nothing if it's a relative symbolic link. */
1720 /* Build the new substitute name from the NT namespace path to the
1721 * target directory, then a path separator, then the "device relative"
1722 * part of the old substitute name. */
1724 orig_subst_name_nchars = rpdata.substitute_name_nbytes / sizeof(wchar_t);
1726 relpath = get_device_relative_path(rpdata.substitute_name,
1727 orig_subst_name_nchars);
1728 relpath_nchars = orig_subst_name_nchars -
1729 (relpath - rpdata.substitute_name);
1731 target_ntpath_nchars = ctx->target_ntpath.Length / sizeof(wchar_t);
1733 fixed_subst_name_nchars = target_ntpath_nchars;
1735 fixed_subst_name_nchars += 1 + relpath_nchars;
1736 wchar_t fixed_subst_name[fixed_subst_name_nchars];
1738 wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer,
1739 target_ntpath_nchars);
1740 if (relpath_nchars) {
1741 fixed_subst_name[target_ntpath_nchars] = L'\\';
1742 wmemcpy(&fixed_subst_name[target_ntpath_nchars + 1],
1743 relpath, relpath_nchars);
1745 /* Doesn't need to be null-terminated. */
1747 /* Print name should be Win32, but not all NT names can even be
1748 * translated to Win32 names. But we can at least delete the top-level
1749 * directory, such as \??\, and this will have the expected result in
1750 * the usual case. */
1751 fixed_print_name = skip_nt_toplevel_component(fixed_subst_name,
1752 fixed_subst_name_nchars);
1753 fixed_print_name_nchars = fixed_subst_name_nchars - (fixed_print_name -
1756 rpdata.substitute_name = fixed_subst_name;
1757 rpdata.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
1758 rpdata.print_name = (wchar_t *)fixed_print_name;
1759 rpdata.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
1760 make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p);
1763 /* Sets reparse data on the specified file. This handles "fixing" the targets
1764 * of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX was
1767 set_reparse_data(const struct wim_dentry *dentry,
1768 const void *_rpbuf, u16 rpbuflen, struct win32_apply_ctx *ctx)
1770 const struct wim_inode *inode = dentry->d_inode;
1771 const void *rpbuf = _rpbuf;
1773 if ((ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
1774 && !inode->i_not_rpfixed
1775 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1776 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1778 memcpy(&ctx->rpfixbuf, _rpbuf, rpbuflen);
1779 try_rpfix((u8 *)&ctx->rpfixbuf, &rpbuflen, ctx);
1780 rpbuf = &ctx->rpfixbuf;
1782 return do_set_reparse_data(dentry, rpbuf, rpbuflen, ctx);
1786 /* Import the next block of raw encrypted data */
1788 import_encrypted_data(PBYTE pbData, PVOID pvCallbackContext, PULONG Length)
1790 struct win32_apply_ctx *ctx = pvCallbackContext;
1793 copy_len = min(ctx->encrypted_size - ctx->encrypted_offset, *Length);
1794 memcpy(pbData, &ctx->data_buffer[ctx->encrypted_offset], copy_len);
1795 ctx->encrypted_offset += copy_len;
1797 return ERROR_SUCCESS;
1800 /* Write the raw encrypted data to the already-created file corresponding to
1803 * The raw encrypted data is provided in ctx->data_buffer, and its size is
1804 * ctx->encrypted_size. */
1806 extract_encrypted_file(const struct wim_dentry *dentry,
1807 struct win32_apply_ctx *ctx)
1812 /* Temporarily build a Win32 path for OpenEncryptedFileRaw() */
1813 build_win32_extraction_path(dentry, ctx);
1815 err = OpenEncryptedFileRaw(ctx->pathbuf.Buffer,
1816 CREATE_FOR_IMPORT, &rawctx);
1818 /* Restore the NT namespace path */
1819 build_extraction_path(dentry, ctx);
1821 if (err != ERROR_SUCCESS) {
1822 set_errno_from_win32_error(err);
1823 ERROR_WITH_ERRNO("Can't open \"%ls\" for encrypted import "
1824 "(err=%"PRIu32")", current_path(ctx), (u32)err);
1825 return WIMLIB_ERR_OPEN;
1828 ctx->encrypted_offset = 0;
1830 err = WriteEncryptedFileRaw(import_encrypted_data, ctx, rawctx);
1832 CloseEncryptedFileRaw(rawctx);
1834 if (err != ERROR_SUCCESS) {
1835 set_errno_from_win32_error(err);
1836 ERROR_WITH_ERRNO("Can't import encrypted file \"%ls\" "
1837 "(err=%"PRIu32")", current_path(ctx), (u32)err);
1838 return WIMLIB_ERR_WRITE;
1844 /* Called when starting to read a stream for extraction on Windows */
1846 begin_extract_stream(struct wim_lookup_table_entry *stream, void *_ctx)
1848 struct win32_apply_ctx *ctx = _ctx;
1849 const struct stream_owner *owners = stream_owners(stream);
1852 ctx->num_open_handles = 0;
1853 ctx->data_buffer_ptr = NULL;
1854 INIT_LIST_HEAD(&ctx->reparse_dentries);
1855 INIT_LIST_HEAD(&ctx->encrypted_dentries);
1857 for (u32 i = 0; i < stream->out_refcnt; i++) {
1858 const struct wim_inode *inode = owners[i].inode;
1859 const wchar_t *stream_name = owners[i].stream_name;
1860 struct wim_dentry *dentry;
1862 /* A copy of the stream needs to be extracted to @inode. */
1864 if (ctx->common.supported_features.hard_links) {
1865 dentry = inode_first_extraction_dentry(inode);
1866 ret = begin_extract_stream_instance(stream, dentry,
1871 /* Hard links not supported. Extract the stream
1872 * separately to each alias of the inode. */
1873 struct list_head *next;
1875 next = inode->i_extraction_aliases.next;
1877 dentry = list_entry(next, struct wim_dentry,
1878 d_extraction_alias_node);
1879 ret = begin_extract_stream_instance(stream,
1886 } while (next != &inode->i_extraction_aliases);
1897 /* Called when the next chunk of a stream has been read for extraction on
1900 extract_chunk(const void *chunk, size_t size, void *_ctx)
1902 struct win32_apply_ctx *ctx = _ctx;
1904 /* Write the data chunk to each open handle */
1905 for (unsigned i = 0; i < ctx->num_open_handles; i++) {
1906 u8 *bufptr = (u8 *)chunk;
1907 size_t bytes_remaining = size;
1909 while (bytes_remaining) {
1910 ULONG count = min(0xFFFFFFFF, bytes_remaining);
1912 status = (*func_NtWriteFile)(ctx->open_handles[i],
1914 &ctx->iosb, bufptr, count,
1916 if (!NT_SUCCESS(status)) {
1917 set_errno_from_nt_status(status);
1918 ERROR_WITH_ERRNO("Error writing data to target "
1919 "volume (status=0x%08"PRIx32")",
1921 return WIMLIB_ERR_WRITE;
1923 bufptr += ctx->iosb.Information;
1924 bytes_remaining -= ctx->iosb.Information;
1928 /* Copy the data chunk into the buffer (if needed) */
1929 if (ctx->data_buffer_ptr)
1930 ctx->data_buffer_ptr = mempcpy(ctx->data_buffer_ptr,
1935 /* Called when a stream has been fully read for extraction on Windows */
1937 end_extract_stream(struct wim_lookup_table_entry *stream, int status, void *_ctx)
1939 struct win32_apply_ctx *ctx = _ctx;
1941 const struct wim_dentry *dentry;
1948 if (likely(!ctx->data_buffer_ptr))
1951 if (!list_empty(&ctx->reparse_dentries)) {
1952 if (stream->size > REPARSE_DATA_MAX_SIZE) {
1953 dentry = list_first_entry(&ctx->reparse_dentries,
1954 struct wim_dentry, tmp_list);
1955 build_extraction_path(dentry, ctx);
1956 ERROR("Reparse data of \"%ls\" has size "
1957 "%"PRIu64" bytes (exceeds %u bytes)",
1958 current_path(ctx), stream->size,
1959 REPARSE_DATA_MAX_SIZE);
1960 return WIMLIB_ERR_INVALID_REPARSE_DATA;
1962 /* In the WIM format, reparse streams are just the reparse data
1963 * and omit the header. But we can reconstruct the header. */
1964 memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, stream->size);
1965 ctx->rpbuf.rpdatalen = stream->size;
1966 ctx->rpbuf.rpreserved = 0;
1967 list_for_each_entry(dentry, &ctx->reparse_dentries, tmp_list) {
1968 ctx->rpbuf.rptag = dentry->d_inode->i_reparse_tag;
1969 ret = set_reparse_data(dentry, &ctx->rpbuf,
1970 stream->size + REPARSE_DATA_OFFSET,
1977 if (!list_empty(&ctx->encrypted_dentries)) {
1978 ctx->encrypted_size = stream->size;
1979 list_for_each_entry(dentry, &ctx->encrypted_dentries, tmp_list) {
1980 ret = extract_encrypted_file(dentry, ctx);
1989 /* Attributes that can't be set directly */
1990 #define SPECIAL_ATTRIBUTES \
1991 (FILE_ATTRIBUTE_REPARSE_POINT | \
1992 FILE_ATTRIBUTE_DIRECTORY | \
1993 FILE_ATTRIBUTE_ENCRYPTED | \
1994 FILE_ATTRIBUTE_SPARSE_FILE | \
1995 FILE_ATTRIBUTE_COMPRESSED)
1997 /* Set the security descriptor @desc, of @desc_size bytes, on the file with open
2000 set_security_descriptor(HANDLE h, const void *desc,
2001 size_t desc_size, struct win32_apply_ctx *ctx)
2003 SECURITY_INFORMATION info;
2006 /* We really just want to set entire the security descriptor as-is, but
2007 * all available APIs require specifying the specific parts of the
2008 * descriptor being set. Start out by requesting all parts be set. If
2009 * permissions problems are encountered, fall back to omitting some
2010 * parts (first the SACL, then the DACL, then the owner), unless the
2011 * WIMLIB_EXTRACT_FLAG_STRICT_ACLS flag has been enabled. */
2012 info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
2013 DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION;
2015 /* Prefer NtSetSecurityObject() to SetFileSecurity(). SetFileSecurity()
2016 * itself necessarily uses NtSetSecurityObject() as the latter is the
2017 * underlying system call for setting security information, but
2018 * SetFileSecurity() opens the handle with NtCreateFile() without
2019 * FILE_OPEN_FILE_BACKUP_INTENT. Hence, access checks are done and due
2020 * to the Windows security model, even a process running as the
2021 * Administrator can have access denied. (Of course, this not mentioned
2022 * in the MS "documentation".) */
2024 status = (*func_NtSetSecurityObject)(h, info, (PSECURITY_DESCRIPTOR)desc);
2025 if (NT_SUCCESS(status))
2027 /* Failed to set the requested parts of the security descriptor. If the
2028 * error was permissions-related, try to set fewer parts of the security
2029 * descriptor, unless WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled. */
2030 if ((status == STATUS_PRIVILEGE_NOT_HELD ||
2031 status == STATUS_ACCESS_DENIED) &&
2032 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2034 if (info & SACL_SECURITY_INFORMATION) {
2035 info &= ~SACL_SECURITY_INFORMATION;
2036 ctx->partial_security_descriptors++;
2039 if (info & DACL_SECURITY_INFORMATION) {
2040 info &= ~DACL_SECURITY_INFORMATION;
2043 if (info & OWNER_SECURITY_INFORMATION) {
2044 info &= ~OWNER_SECURITY_INFORMATION;
2047 /* Nothing left except GROUP, and if we removed it we
2048 * wouldn't have anything at all. */
2051 /* No part of the security descriptor could be set, or
2052 * WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled and the full security
2053 * descriptor could not be set. */
2054 if (!(info & SACL_SECURITY_INFORMATION))
2055 ctx->partial_security_descriptors--;
2056 ctx->no_security_descriptors++;
2060 /* Set metadata on the open file @h from the WIM inode @inode. */
2062 do_apply_metadata_to_file(HANDLE h, const struct wim_inode *inode,
2063 struct win32_apply_ctx *ctx)
2065 FILE_BASIC_INFORMATION info;
2068 /* Set security descriptor if present and not in NO_ACLS mode */
2069 if (inode->i_security_id >= 0 &&
2070 !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
2072 const struct wim_security_data *sd;
2076 sd = wim_get_current_security_data(ctx->common.wim);
2077 desc = sd->descriptors[inode->i_security_id];
2078 desc_size = sd->sizes[inode->i_security_id];
2080 status = set_security_descriptor(h, desc, desc_size, ctx);
2081 if (!NT_SUCCESS(status) &&
2082 (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2084 set_errno_from_nt_status(status);
2085 ERROR_WITH_ERRNO("Can't set security descriptor "
2086 "on \"%ls\" (status=0x%08"PRIx32")",
2087 current_path(ctx), (u32)status);
2088 return WIMLIB_ERR_SET_SECURITY;
2092 /* Set attributes and timestamps */
2093 info.CreationTime.QuadPart = inode->i_creation_time;
2094 info.LastAccessTime.QuadPart = inode->i_last_access_time;
2095 info.LastWriteTime.QuadPart = inode->i_last_write_time;
2096 info.ChangeTime.QuadPart = 0;
2097 if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
2098 info.FileAttributes = 0;
2100 info.FileAttributes = inode->i_attributes & ~SPECIAL_ATTRIBUTES;
2102 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
2103 &info, sizeof(info),
2104 FileBasicInformation);
2105 /* On FAT volumes we get STATUS_INVALID_PARAMETER if we try to set
2106 * attributes on the root directory. (Apparently because FAT doesn't
2107 * actually have a place to store those attributes!) */
2108 if (!NT_SUCCESS(status)
2109 && !(status == STATUS_INVALID_PARAMETER &&
2110 dentry_is_root(inode_first_extraction_dentry(inode))))
2112 set_errno_from_nt_status(status);
2113 ERROR_WITH_ERRNO("Can't set basic metadata on \"%ls\" "
2114 "(status=0x%08"PRIx32")",
2115 current_path(ctx), (u32)status);
2116 return WIMLIB_ERR_SET_ATTRIBUTES;
2123 apply_metadata_to_file(const struct wim_dentry *dentry,
2124 struct win32_apply_ctx *ctx)
2126 const struct wim_inode *inode = dentry->d_inode;
2132 perms = FILE_WRITE_ATTRIBUTES | WRITE_DAC |
2133 WRITE_OWNER | ACCESS_SYSTEM_SECURITY;
2135 build_extraction_path(dentry, ctx);
2137 /* Open a handle with as many relevant permissions as possible. */
2138 while (!NT_SUCCESS(status = do_create_file(&h, perms, NULL,
2139 0, FILE_OPEN, 0, ctx)))
2141 if (status == STATUS_PRIVILEGE_NOT_HELD ||
2142 status == STATUS_ACCESS_DENIED)
2144 if (perms & ACCESS_SYSTEM_SECURITY) {
2145 perms &= ~ACCESS_SYSTEM_SECURITY;
2148 if (perms & WRITE_DAC) {
2149 perms &= ~WRITE_DAC;
2152 if (perms & WRITE_OWNER) {
2153 perms &= ~WRITE_OWNER;
2157 set_errno_from_nt_status(status);
2158 ERROR_WITH_ERRNO("Can't open \"%ls\" to set metadata "
2159 "(status=0x%08"PRIx32")",
2160 current_path(ctx), (u32)status);
2161 return WIMLIB_ERR_OPEN;
2164 ret = do_apply_metadata_to_file(h, inode, ctx);
2172 apply_metadata(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
2174 const struct wim_dentry *dentry;
2177 /* We go in reverse so that metadata is set on all a directory's
2178 * children before the directory itself. This avoids any potential
2179 * problems with attributes, timestamps, or security descriptors. */
2180 list_for_each_entry_reverse(dentry, dentry_list, d_extraction_list_node)
2182 ret = apply_metadata_to_file(dentry, ctx);
2185 ret = report_file_metadata_applied(&ctx->common);
2192 /* Issue warnings about problems during the extraction for which warnings were
2193 * not already issued (due to the high number of potential warnings if we issued
2194 * them per-file). */
2196 do_warnings(const struct win32_apply_ctx *ctx)
2198 if (ctx->partial_security_descriptors == 0 &&
2199 ctx->no_security_descriptors == 0 &&
2200 ctx->num_short_name_failures == 0)
2203 WARNING("Extraction to \"%ls\" complete, but with one or more warnings:",
2204 ctx->common.target);
2205 if (ctx->num_short_name_failures) {
2206 WARNING("- Could not set short names on %lu files or directories",
2207 ctx->num_short_name_failures);
2209 if (ctx->partial_security_descriptors) {
2210 WARNING("- Could only partially set the security descriptor\n"
2211 " on %lu files or directories.",
2212 ctx->partial_security_descriptors);
2214 if (ctx->no_security_descriptors) {
2215 WARNING("- Could not set security descriptor at all\n"
2216 " on %lu files or directories.",
2217 ctx->no_security_descriptors);
2219 if (ctx->partial_security_descriptors || ctx->no_security_descriptors) {
2220 WARNING("To fully restore all security descriptors, run the program\n"
2221 " with Administrator rights.");
2225 /* Extract files from a WIM image to a directory on Windows */
2227 win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
2230 struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
2232 ret = prepare_target(dentry_list, ctx);
2236 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2237 ret = start_wimboot_extraction(ctx);
2242 reset_file_progress(&ctx->common);
2244 ret = create_directories(dentry_list, ctx);
2248 ret = create_nondirectories(dentry_list, ctx);
2252 struct read_stream_list_callbacks cbs = {
2253 .begin_stream = begin_extract_stream,
2254 .begin_stream_ctx = ctx,
2255 .consume_chunk = extract_chunk,
2256 .consume_chunk_ctx = ctx,
2257 .end_stream = end_extract_stream,
2258 .end_stream_ctx = ctx,
2260 ret = extract_stream_list(&ctx->common, &cbs);
2264 reset_file_progress(&ctx->common);
2266 ret = apply_metadata(dentry_list, ctx);
2270 if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2271 ret = end_wimboot_extraction(ctx);
2279 (*func_NtClose)(ctx->h_target);
2280 if (ctx->target_ntpath.Buffer)
2281 HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
2282 FREE(ctx->pathbuf.Buffer);
2283 FREE(ctx->print_buffer);
2284 if (ctx->wimboot.prepopulate_pats) {
2285 FREE(ctx->wimboot.prepopulate_pats->strings);
2286 FREE(ctx->wimboot.prepopulate_pats);
2288 FREE(ctx->wimboot.mem_prepopulate_pats);
2289 FREE(ctx->data_buffer);
2293 const struct apply_operations win32_apply_ops = {
2295 .get_supported_features = win32_get_supported_features,
2296 .extract = win32_extract,
2297 .will_externally_back = win32_will_externally_back,
2298 .context_size = sizeof(struct win32_apply_ctx),
2301 #endif /* __WIN32__ */