faacd718b7e9178e0d00610a7bd4aa57ea1b3313
[wimlib] / src / win32_apply.c
1 /*
2  * win32_apply.c - Windows-specific code for applying files from a WIM image.
3  */
4
5 /*
6  * Copyright (C) 2013, 2014, 2015 Eric Biggers
7  *
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
11  * later version.
12  *
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
16  * details.
17  *
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/.
20  */
21
22 #ifdef __WIN32__
23
24 #ifdef HAVE_CONFIG_H
25 #  include "config.h"
26 #endif
27
28 #include "wimlib/win32_common.h"
29
30 #include "wimlib/apply.h"
31 #include "wimlib/assert.h"
32 #include "wimlib/blob_table.h"
33 #include "wimlib/capture.h" /* for mangle_pat() and match_pattern_list()  */
34 #include "wimlib/dentry.h"
35 #include "wimlib/encoding.h"
36 #include "wimlib/error.h"
37 #include "wimlib/metadata.h"
38 #include "wimlib/paths.h"
39 #include "wimlib/pattern.h"
40 #include "wimlib/reparse.h"
41 #include "wimlib/textfile.h"
42 #include "wimlib/xml.h"
43 #include "wimlib/wimboot.h"
44 #include "wimlib/wof.h"
45
46 struct win32_apply_ctx {
47
48         /* Extract flags, the pointer to the WIMStruct, etc.  */
49         struct apply_ctx common;
50
51         /* WIMBoot information, only filled in if WIMLIB_EXTRACT_FLAG_WIMBOOT
52          * was provided  */
53         struct {
54                 /* This array contains the WIM files registered with WOF on the
55                  * target volume for this extraction operation.  All WIMStructs
56                  * in this array are distinct and have ->filename != NULL.  */
57                 struct wimboot_wim {
58                         WIMStruct *wim;
59                         u64 data_source_id;
60                         u8 blob_table_hash[SHA1_HASH_SIZE];
61                 } *wims;
62                 size_t num_wims;
63                 bool wof_running;
64                 bool have_wrong_version_wims;
65                 bool have_uncompressed_wims;
66                 bool have_unsupported_compressed_resources;
67                 bool have_huge_resources;
68         } wimboot;
69
70         /* External backing information  */
71         struct string_set *prepopulate_pats;
72         void *mem_prepopulate_pats;
73         bool tried_to_load_prepopulate_list;
74
75         /* Open handle to the target directory  */
76         HANDLE h_target;
77
78         /* NT namespace path to the target directory (buffer allocated)  */
79         UNICODE_STRING target_ntpath;
80
81         /* Temporary buffer for building paths (buffer allocated)  */
82         UNICODE_STRING pathbuf;
83
84         /* Object attributes to reuse for opening files in the target directory.
85          * (attr.ObjectName == &pathbuf) and (attr.RootDirectory == h_target).
86          */
87         OBJECT_ATTRIBUTES attr;
88
89         /* Temporary I/O status block for system calls  */
90         IO_STATUS_BLOCK iosb;
91
92         /* Allocated buffer for creating "printable" paths from our
93          * target-relative NT paths  */
94         wchar_t *print_buffer;
95
96         /* Allocated buffer for reading blob data when it cannot be extracted
97          * directly  */
98         u8 *data_buffer;
99
100         /* Pointer to the next byte in @data_buffer to fill  */
101         u8 *data_buffer_ptr;
102
103         /* Size allocated in @data_buffer  */
104         size_t data_buffer_size;
105
106         /* Current offset in the raw encrypted file being written  */
107         size_t encrypted_offset;
108
109         /* Current size of the raw encrypted file being written  */
110         size_t encrypted_size;
111
112         /* Temporary buffer for reparse data  */
113         struct reparse_buffer_disk rpbuf;
114
115         /* Temporary buffer for reparse data of "fixed" absolute symbolic links
116          * and junctions  */
117         struct reparse_buffer_disk rpfixbuf;
118
119         /* Array of open handles to filesystem streams currently being written
120          */
121         HANDLE open_handles[MAX_OPEN_FILES];
122
123         /* Number of handles in @open_handles currently open (filled in from the
124          * beginning of the array)  */
125         unsigned num_open_handles;
126
127         /* List of dentries, joined by @d_tmp_list, that need to have reparse
128          * data extracted as soon as the whole blob has been read into
129          * @data_buffer.  */
130         struct list_head reparse_dentries;
131
132         /* List of dentries, joined by @d_tmp_list, that need to have raw
133          * encrypted data extracted as soon as the whole blob has been read into
134          * @data_buffer.  */
135         struct list_head encrypted_dentries;
136
137         /* Number of files for which we didn't have permission to set the full
138          * security descriptor.  */
139         unsigned long partial_security_descriptors;
140
141         /* Number of files for which we didn't have permission to set any part
142          * of the security descriptor.  */
143         unsigned long no_security_descriptors;
144
145         /* Number of files for which we couldn't set the short name.  */
146         unsigned long num_set_short_name_failures;
147
148         /* Number of files for which we couldn't remove the short name.  */
149         unsigned long num_remove_short_name_failures;
150
151         /* Number of files on which we couldn't set System Compression.  */
152         unsigned long num_system_compression_failures;
153
154         /* The number of files which, for compatibility with the Windows
155          * bootloader, were not compressed using the requested system
156          * compression format.  This includes matches with the hardcoded pattern
157          * list only; it does not include matches with patterns in
158          * [PrepopulateList].  */
159         unsigned long num_system_compression_exclusions;
160
161         /* The Windows build number of the image being applied, or 0 if unknown.
162          */
163         u64 windows_build_number;
164
165         /* Have we tried to enable short name support on the target volume yet?
166          */
167         bool tried_to_enable_short_names;
168 };
169
170 /* Get the drive letter from a Windows path, or return the null character if the
171  * path is relative.  */
172 static wchar_t
173 get_drive_letter(const wchar_t *path)
174 {
175         /* Skip \\?\ prefix  */
176         if (!wcsncmp(path, L"\\\\?\\", 4))
177                 path += 4;
178
179         /* Return drive letter if valid  */
180         if (((path[0] >= L'a' && path[0] <= L'z') ||
181              (path[0] >= L'A' && path[0] <= L'Z')) && path[1] == L':')
182                 return path[0];
183
184         return L'\0';
185 }
186
187 static void
188 get_vol_flags(const wchar_t *target, DWORD *vol_flags_ret,
189               bool *short_names_supported_ret)
190 {
191         wchar_t filesystem_name[MAX_PATH + 1];
192         wchar_t drive[4];
193         wchar_t *volume = NULL;
194
195         *vol_flags_ret = 0;
196         *short_names_supported_ret = false;
197
198         drive[0] = get_drive_letter(target);
199         if (drive[0]) {
200                 drive[1] = L':';
201                 drive[2] = L'\\';
202                 drive[3] = L'\0';
203                 volume = drive;
204         }
205
206         if (!GetVolumeInformation(volume, NULL, 0, NULL, NULL,
207                                   vol_flags_ret, filesystem_name,
208                                   ARRAY_LEN(filesystem_name)))
209         {
210                 win32_warning(GetLastError(),
211                               L"Failed to get volume information for \"%ls\"",
212                               target);
213                 return;
214         }
215
216         if (wcsstr(filesystem_name, L"NTFS")) {
217                 /* FILE_SUPPORTS_HARD_LINKS is only supported on Windows 7 and
218                  * later.  Force it on anyway if filesystem is NTFS.  */
219                 *vol_flags_ret |= FILE_SUPPORTS_HARD_LINKS;
220
221                 /* There's no volume flag for short names, but according to the
222                  * MS documentation they are only user-settable on NTFS.  */
223                 *short_names_supported_ret = true;
224         }
225 }
226
227 /* Is the image being extracted an OS image for Windows 10 or later?  */
228 static bool
229 is_image_windows_10_or_later(struct win32_apply_ctx *ctx)
230 {
231         /* Note: if no build number is available, this returns false.  */
232         return ctx->windows_build_number >= 10240;
233 }
234
235 static const wchar_t *
236 current_path(struct win32_apply_ctx *ctx);
237
238 static void
239 build_extraction_path(const struct wim_dentry *dentry,
240                       struct win32_apply_ctx *ctx);
241
242 static int
243 report_dentry_apply_error(const struct wim_dentry *dentry,
244                           struct win32_apply_ctx *ctx, int ret)
245 {
246         build_extraction_path(dentry, ctx);
247         return report_apply_error(&ctx->common, ret, current_path(ctx));
248 }
249
250 static inline int
251 check_apply_error(const struct wim_dentry *dentry,
252                   struct win32_apply_ctx *ctx, int ret)
253 {
254         if (unlikely(ret))
255                 ret = report_dentry_apply_error(dentry, ctx, ret);
256         return ret;
257 }
258
259 static int
260 win32_get_supported_features(const wchar_t *target,
261                              struct wim_features *supported_features)
262 {
263         DWORD vol_flags;
264         bool short_names_supported;
265
266         /* Query the features of the target volume.  */
267
268         get_vol_flags(target, &vol_flags, &short_names_supported);
269
270         supported_features->readonly_files = 1;
271         supported_features->hidden_files = 1;
272         supported_features->system_files = 1;
273         supported_features->archive_files = 1;
274
275         if (vol_flags & FILE_FILE_COMPRESSION)
276                 supported_features->compressed_files = 1;
277
278         if (vol_flags & FILE_SUPPORTS_ENCRYPTION) {
279                 supported_features->encrypted_files = 1;
280                 supported_features->encrypted_directories = 1;
281         }
282
283         supported_features->not_context_indexed_files = 1;
284
285         /* Don't do anything with FILE_SUPPORTS_SPARSE_FILES.  */
286
287         if (vol_flags & FILE_NAMED_STREAMS)
288                 supported_features->named_data_streams = 1;
289
290         if (vol_flags & FILE_SUPPORTS_HARD_LINKS)
291                 supported_features->hard_links = 1;
292
293         if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS)
294                 supported_features->reparse_points = 1;
295
296         if (vol_flags & FILE_PERSISTENT_ACLS)
297                 supported_features->security_descriptors = 1;
298
299         if (short_names_supported)
300                 supported_features->short_names = 1;
301
302         supported_features->timestamps = 1;
303
304         /* Note: Windows does not support case sensitive filenames!  At least
305          * not without changing the registry and rebooting...  */
306
307         return 0;
308 }
309
310 #define COMPACT_FLAGS   (WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K |         \
311                          WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K |         \
312                          WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K |        \
313                          WIMLIB_EXTRACT_FLAG_COMPACT_LZX)
314
315
316
317 /*
318  * If not done already, load the patterns from the [PrepopulateList] section of
319  * WimBootCompress.ini in the WIM image being extracted.
320  *
321  * Note: WimBootCompress.ini applies to both types of "external backing":
322  *
323  *      - WIM backing ("WIMBoot" - Windows 8.1 and later)
324  *      - File backing ("System Compression" - Windows 10 and later)
325  */
326 static int
327 load_prepopulate_pats(struct win32_apply_ctx *ctx)
328 {
329         const wchar_t *path = L"\\Windows\\System32\\WimBootCompress.ini";
330         struct wim_dentry *dentry;
331         const struct blob_descriptor *blob;
332         int ret;
333         void *buf;
334         struct string_set *s;
335         void *mem;
336         struct text_file_section sec;
337
338         if (ctx->tried_to_load_prepopulate_list)
339                 return 0;
340
341         ctx->tried_to_load_prepopulate_list = true;
342
343         dentry = get_dentry(ctx->common.wim, path, WIMLIB_CASE_INSENSITIVE);
344         if (!dentry ||
345             (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
346                                               FILE_ATTRIBUTE_REPARSE_POINT |
347                                               FILE_ATTRIBUTE_ENCRYPTED)) ||
348             !(blob = inode_get_blob_for_unnamed_data_stream(dentry->d_inode,
349                                                             ctx->common.wim->blob_table)))
350         {
351                 WARNING("%ls does not exist in the WIM image.\n"
352                         "          The default configuration will be used instead; it assumes that all\n"
353                         "          files are valid for external backing regardless of path, equivalent\n"
354                         "          to an empty [PrepopulateList] section.", path);
355                 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
356         }
357
358         ret = read_blob_into_alloc_buf(blob, &buf);
359         if (ret)
360                 return ret;
361
362         s = CALLOC(1, sizeof(struct string_set));
363         if (!s) {
364                 FREE(buf);
365                 return WIMLIB_ERR_NOMEM;
366         }
367
368         sec.name = T("PrepopulateList");
369         sec.strings = s;
370
371         ret = do_load_text_file(path, buf, blob->size, &mem, &sec, 1,
372                                 LOAD_TEXT_FILE_REMOVE_QUOTES |
373                                         LOAD_TEXT_FILE_NO_WARNINGS,
374                                 mangle_pat);
375         STATIC_ASSERT(OS_PREFERRED_PATH_SEPARATOR == WIM_PATH_SEPARATOR);
376         FREE(buf);
377         if (ret) {
378                 FREE(s);
379                 return ret;
380         }
381         ctx->prepopulate_pats = s;
382         ctx->mem_prepopulate_pats = mem;
383         return 0;
384 }
385
386 /* Returns %true if the specified absolute path to a file in the WIM image can
387  * be subject to external backing when extracted.  Otherwise returns %false.  */
388 static bool
389 can_externally_back_path(const wchar_t *path, const struct win32_apply_ctx *ctx)
390 {
391         /* Does the path match a pattern given in the [PrepopulateList] section
392          * of WimBootCompress.ini?  */
393         if (ctx->prepopulate_pats && match_pattern_list(path, ctx->prepopulate_pats))
394                 return false;
395
396         /* Since we attempt to modify the SYSTEM registry after it's extracted
397          * (see end_wimboot_extraction()), it can't be extracted as externally
398          * backed.  This extends to associated files such as SYSTEM.LOG that
399          * also must be writable in order to write to the registry.  Normally,
400          * SYSTEM is in [PrepopulateList], and the SYSTEM.* files match patterns
401          * in [ExclusionList] and therefore are not captured in the WIM at all.
402          * However, a WIM that wasn't specifically captured in "WIMBoot mode"
403          * may contain SYSTEM.* files.  So to make things "just work", hard-code
404          * the pattern.  */
405         if (match_path(path, L"\\Windows\\System32\\config\\SYSTEM*", false))
406                 return false;
407
408         return true;
409 }
410
411 /* Can the specified WIM resource be used as the source of an external backing
412  * for the wof.sys WIM provider?  */
413 static bool
414 is_resource_valid_for_external_backing(const struct wim_resource_descriptor *rdesc,
415                                        struct win32_apply_ctx *ctx)
416 {
417         /* Must be the original WIM file format.  This check excludes pipable
418          * resources and solid resources.  It also excludes other resources
419          * contained in such files even if they would be otherwise compatible.
420          */
421         if (rdesc->wim->hdr.magic != WIM_MAGIC ||
422             rdesc->wim->hdr.wim_version != WIM_VERSION_DEFAULT)
423         {
424                 ctx->wimboot.have_wrong_version_wims = true;
425                 return false;
426         }
427
428         /*
429          * Whitelist of compression types and chunk sizes supported by
430          * Microsoft's WOF driver.
431          *
432          * Notes:
433          *    - Uncompressed WIMs result in BSOD.  However, this only applies to
434          *      the WIM file itself, not to uncompressed resources in a WIM file
435          *      that is otherwise compressed.
436          *    - XPRESS 64K sometimes appears to work, but sometimes it causes
437          *      reads to fail with STATUS_UNSUCCESSFUL.
438          */
439         switch (rdesc->compression_type) {
440         case WIMLIB_COMPRESSION_TYPE_NONE:
441                 if (rdesc->wim->compression_type == WIMLIB_COMPRESSION_TYPE_NONE) {
442                         ctx->wimboot.have_uncompressed_wims = true;
443                         return false;
444                 }
445                 break;
446         case WIMLIB_COMPRESSION_TYPE_XPRESS:
447                 switch (rdesc->chunk_size) {
448                 case 4096:
449                 case 8192:
450                 case 16384:
451                 case 32768:
452                         break;
453                 default:
454                         ctx->wimboot.have_unsupported_compressed_resources = true;
455                         return false;
456                 }
457                 break;
458         case WIMLIB_COMPRESSION_TYPE_LZX:
459                 switch (rdesc->chunk_size) {
460                 case 32768:
461                         break;
462                 default:
463                         ctx->wimboot.have_unsupported_compressed_resources = true;
464                         return false;
465                 }
466                 break;
467         default:
468                 ctx->wimboot.have_unsupported_compressed_resources = true;
469                 return false;
470         }
471
472         /* Microsoft's WoF driver errors out if it tries to satisfy a read with
473          * ending offset >= 4 GiB from an externally backed file.  */
474         if (rdesc->uncompressed_size > 4200000000) {
475                 ctx->wimboot.have_huge_resources = true;
476                 return false;
477         }
478
479         return true;
480 }
481
482 #define EXTERNAL_BACKING_NOT_ENABLED            -1
483 #define EXTERNAL_BACKING_NOT_POSSIBLE           -2
484 #define EXTERNAL_BACKING_EXCLUDED               -3
485
486 /*
487  * Determines whether the specified file will be externally backed.  Returns a
488  * negative status code if no, 0 if yes, or a positive wimlib error code on
489  * error.  If the file is excluded from external backing based on its path, then
490  * *excluded_dentry_ret is set to the dentry for the path that matched the
491  * exclusion rule.
492  *
493  * Note that this logic applies to both types of "external backing":
494  *
495  *      - WIM backing ("WIMBoot" - Windows 8.1 and later)
496  *      - File backing ("System Compression" - Windows 10 and later)
497  *
498  * However, in the case of WIM backing we also need to validate that the WIM
499  * resource that would be the source of the backing is supported by the wof.sys
500  * WIM provider.
501  */
502 static int
503 will_externally_back_inode(struct wim_inode *inode, struct win32_apply_ctx *ctx,
504                            const struct wim_dentry **excluded_dentry_ret,
505                            bool wimboot_mode)
506 {
507         struct wim_dentry *dentry;
508         struct blob_descriptor *blob;
509         int ret;
510
511         if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
512                 return WIMLIB_ERR_NOMEM;
513
514         if (inode->i_can_externally_back)
515                 return 0;
516
517         /* This may do redundant checks because the cached value
518          * i_can_externally_back is 2-state (as opposed to 3-state:
519          * unknown/no/yes).  But most files can be externally backed, so this
520          * way is fine.  */
521
522         if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
523                                    FILE_ATTRIBUTE_REPARSE_POINT |
524                                    FILE_ATTRIBUTE_ENCRYPTED))
525                 return EXTERNAL_BACKING_NOT_POSSIBLE;
526
527         blob = inode_get_blob_for_unnamed_data_stream_resolved(inode);
528
529         if (!blob)
530                 return EXTERNAL_BACKING_NOT_POSSIBLE;
531
532         if (wimboot_mode &&
533             (blob->blob_location != BLOB_IN_WIM ||
534              !is_resource_valid_for_external_backing(blob->rdesc, ctx)))
535                 return EXTERNAL_BACKING_NOT_POSSIBLE;
536
537         /*
538          * We need to check the patterns in [PrepopulateList] against every name
539          * of the inode, in case any of them match.
540          */
541
542         inode_for_each_extraction_alias(dentry, inode) {
543
544                 ret = calculate_dentry_full_path(dentry);
545                 if (ret)
546                         return ret;
547
548                 if (!can_externally_back_path(dentry->d_full_path, ctx)) {
549                         if (excluded_dentry_ret)
550                                 *excluded_dentry_ret = dentry;
551                         return EXTERNAL_BACKING_EXCLUDED;
552                 }
553         }
554
555         inode->i_can_externally_back = 1;
556         return 0;
557 }
558
559 /*
560  * Determines if the unnamed data stream of a file will be created as a WIM
561  * external backing (a "WIMBoot pointer file"), as opposed to a standard
562  * extraction.
563  */
564 static int
565 win32_will_back_from_wim(struct wim_dentry *dentry, struct apply_ctx *_ctx)
566 {
567         struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
568
569         if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
570                 return EXTERNAL_BACKING_NOT_ENABLED;
571
572         return will_externally_back_inode(dentry->d_inode, ctx, NULL, true);
573 }
574
575 /* Find the WOF registration information for the specified WIM file.  */
576 static struct wimboot_wim *
577 find_wimboot_wim(WIMStruct *wim_to_find, struct win32_apply_ctx *ctx)
578 {
579         for (size_t i = 0; i < ctx->wimboot.num_wims; i++)
580                 if (wim_to_find == ctx->wimboot.wims[i].wim)
581                         return &ctx->wimboot.wims[i];
582
583         wimlib_assert(0);
584         return NULL;
585 }
586
587 static int
588 set_backed_from_wim(HANDLE h, struct wim_inode *inode, struct win32_apply_ctx *ctx)
589 {
590         int ret;
591         const struct wim_dentry *excluded_dentry;
592         const struct blob_descriptor *blob;
593         const struct wimboot_wim *wimboot_wim;
594
595         ret = will_externally_back_inode(inode, ctx, &excluded_dentry, true);
596         if (ret > 0) /* Error.  */
597                 return ret;
598
599         if (ret < 0 && ret != EXTERNAL_BACKING_EXCLUDED)
600                 return 0; /* Not externally backing, other than due to exclusion.  */
601
602         if (unlikely(ret == EXTERNAL_BACKING_EXCLUDED)) {
603                 /* Not externally backing due to exclusion.  */
604                 union wimlib_progress_info info;
605
606                 build_extraction_path(excluded_dentry, ctx);
607
608                 info.wimboot_exclude.path_in_wim = excluded_dentry->d_full_path;
609                 info.wimboot_exclude.extraction_path = current_path(ctx);
610
611                 return call_progress(ctx->common.progfunc,
612                                      WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE,
613                                      &info, ctx->common.progctx);
614         }
615
616         /* Externally backing.  */
617
618         blob = inode_get_blob_for_unnamed_data_stream_resolved(inode);
619         wimboot_wim = find_wimboot_wim(blob->rdesc->wim, ctx);
620
621         if (unlikely(!wimboot_set_pointer(h,
622                                           blob,
623                                           wimboot_wim->data_source_id,
624                                           wimboot_wim->blob_table_hash,
625                                           ctx->wimboot.wof_running)))
626         {
627                 const DWORD err = GetLastError();
628
629                 build_extraction_path(inode_first_extraction_dentry(inode), ctx);
630                 win32_error(err, L"\"%ls\": Couldn't set WIMBoot pointer data",
631                             current_path(ctx));
632                 return WIMLIB_ERR_WIMBOOT;
633         }
634         return 0;
635 }
636
637 /* Calculates the SHA-1 message digest of the WIM's blob table.  */
638 static int
639 hash_blob_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
640 {
641         return wim_reshdr_to_hash(&wim->hdr.blob_table_reshdr, wim, hash);
642 }
643
644 static int
645 register_wim_with_wof(WIMStruct *wim, struct win32_apply_ctx *ctx)
646 {
647         struct wimboot_wim *p;
648         int ret;
649
650         /* Check if already registered  */
651         for (size_t i = 0; i < ctx->wimboot.num_wims; i++)
652                 if (wim == ctx->wimboot.wims[i].wim)
653                         return 0;
654
655         /* Not yet registered  */
656
657         p = REALLOC(ctx->wimboot.wims,
658                     (ctx->wimboot.num_wims + 1) * sizeof(ctx->wimboot.wims[0]));
659         if (!p)
660                 return WIMLIB_ERR_NOMEM;
661         ctx->wimboot.wims = p;
662
663         ctx->wimboot.wims[ctx->wimboot.num_wims].wim = wim;
664
665         ret = hash_blob_table(wim, ctx->wimboot.wims[ctx->wimboot.num_wims].blob_table_hash);
666         if (ret)
667                 return ret;
668
669         ret = wimboot_alloc_data_source_id(wim->filename,
670                                            wim->hdr.guid,
671                                            ctx->common.wim->current_image,
672                                            ctx->common.target,
673                                            &ctx->wimboot.wims[ctx->wimboot.num_wims].data_source_id,
674                                            &ctx->wimboot.wof_running);
675         if (ret)
676                 return ret;
677
678         ctx->wimboot.num_wims++;
679         return 0;
680 }
681
682 /* Prepare for doing a "WIMBoot" extraction by registering each source WIM file
683  * with WOF on the target volume.  */
684 static int
685 start_wimboot_extraction(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
686 {
687         int ret;
688         struct wim_dentry *dentry;
689
690         if (!xml_get_wimboot(ctx->common.wim->xml_info,
691                              ctx->common.wim->current_image))
692                 WARNING("The WIM image is not marked as WIMBoot compatible.  This usually\n"
693                         "          means it is not intended to be used to back a Windows operating\n"
694                         "          system.  Proceeding anyway.");
695
696         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
697                 struct blob_descriptor *blob;
698
699                 ret = win32_will_back_from_wim(dentry, &ctx->common);
700                 if (ret > 0) /* Error */
701                         return ret;
702                 if (ret < 0) /* Won't externally back */
703                         continue;
704
705                 blob = inode_get_blob_for_unnamed_data_stream_resolved(dentry->d_inode);
706                 ret = register_wim_with_wof(blob->rdesc->wim, ctx);
707                 if (ret)
708                         return ret;
709         }
710
711         if (ctx->wimboot.have_wrong_version_wims) {
712   WARNING("At least one of the source WIM files uses a version of the WIM\n"
713 "          file format that not supported by Microsoft's wof.sys driver.\n"
714 "          Files whose data is contained in one of these WIM files will be\n"
715 "          extracted as full files rather than externally backed.");
716         }
717
718         if (ctx->wimboot.have_uncompressed_wims) {
719   WARNING("At least one of the source WIM files is uncompressed.  Files whose\n"
720 "          data is contained in an uncompressed WIM file will be extracted as\n"
721 "          full files rather than externally backed, since uncompressed WIM\n"
722 "          files are not supported by Microsoft's wof.sys driver.");
723         }
724
725         if (ctx->wimboot.have_unsupported_compressed_resources) {
726   WARNING("At least one of the source WIM files uses a compression format that\n"
727 "          is not supported by Microsoft's wof.sys driver.  Files whose data is\n"
728 "          contained in a compressed resource in one of these WIM files will be\n"
729 "          extracted as full files rather than externally backed.  (The\n"
730 "          compression formats supported by wof.sys are: XPRESS 4K, XPRESS 8K,\n"
731 "          XPRESS 16K, XPRESS 32K, and LZX 32K.)");
732         }
733
734         if (ctx->wimboot.have_huge_resources) {
735   WARNING("Some files exceeded 4.2 GB in size.  Such files will be extracted\n"
736 "          as full files rather than externally backed, since very large files\n"
737 "          are not supported by Microsoft's wof.sys driver.");
738         }
739
740         return 0;
741 }
742
743 static void
744 build_win32_extraction_path(const struct wim_dentry *dentry,
745                             struct win32_apply_ctx *ctx);
746
747 /* Sets WimBoot=1 in the extracted SYSTEM registry hive.
748  *
749  * WIMGAPI does this, and it's possible that it's important.
750  * But I don't know exactly what this value means to Windows.  */
751 static int
752 end_wimboot_extraction(struct win32_apply_ctx *ctx)
753 {
754         struct wim_dentry *dentry;
755         wchar_t subkeyname[32];
756         LONG res;
757         LONG res2;
758         HKEY key;
759         DWORD value;
760
761         dentry = get_dentry(ctx->common.wim, L"\\Windows\\System32\\config\\SYSTEM",
762                             WIMLIB_CASE_INSENSITIVE);
763
764         if (!dentry || !will_extract_dentry(dentry))
765                 goto out;
766
767         if (!will_extract_dentry(wim_get_current_root_dentry(ctx->common.wim)))
768                 goto out;
769
770         /* Not bothering to use the native routines (e.g. NtLoadKey()) for this.
771          * If this doesn't work, you probably also have many other problems.  */
772
773         build_win32_extraction_path(dentry, ctx);
774
775         randomize_char_array_with_alnum(subkeyname, 20);
776         subkeyname[20] = L'\0';
777
778         res = RegLoadKey(HKEY_LOCAL_MACHINE, subkeyname, ctx->pathbuf.Buffer);
779         if (res)
780                 goto out_check_res;
781
782         wcscpy(&subkeyname[20], L"\\Setup");
783
784         res = RegCreateKeyEx(HKEY_LOCAL_MACHINE, subkeyname, 0, NULL,
785                              REG_OPTION_BACKUP_RESTORE, 0, NULL, &key, NULL);
786         if (res)
787                 goto out_unload_key;
788
789         value = 1;
790
791         res = RegSetValueEx(key, L"WimBoot", 0, REG_DWORD,
792                             (const BYTE *)&value, sizeof(DWORD));
793         if (res)
794                 goto out_close_key;
795
796         res = RegFlushKey(key);
797
798 out_close_key:
799         res2 = RegCloseKey(key);
800         if (!res)
801                 res = res2;
802 out_unload_key:
803         subkeyname[20] = L'\0';
804         RegUnLoadKey(HKEY_LOCAL_MACHINE, subkeyname);
805 out_check_res:
806         if (res) {
807                 /* Warning only.  */
808                 win32_warning(res, L"Failed to set \\Setup: dword \"WimBoot\"=1 "
809                               "value in registry hive \"%ls\"",
810                               ctx->pathbuf.Buffer);
811         }
812 out:
813         return 0;
814 }
815
816 /* Returns the number of wide characters needed to represent the path to the
817  * specified @dentry, relative to the target directory, when extracted.
818  *
819  * Does not include null terminator (not needed for NtCreateFile).  */
820 static size_t
821 dentry_extraction_path_length(const struct wim_dentry *dentry)
822 {
823         size_t len = 0;
824         const struct wim_dentry *d;
825
826         d = dentry;
827         do {
828                 len += d->d_extraction_name_nchars + 1;
829                 d = d->d_parent;
830         } while (!dentry_is_root(d) && will_extract_dentry(d));
831
832         return --len;  /* No leading slash  */
833 }
834
835 /* Returns the length of the longest string that might need to be appended to
836  * the path to an alias of an inode to open or create a named data stream.
837  *
838  * If the inode has no named data streams, this will be 0.  Otherwise, this will
839  * be 1 plus the length of the longest-named data stream, since the data stream
840  * name must be separated from the path by the ':' character.  */
841 static size_t
842 inode_longest_named_data_stream_spec(const struct wim_inode *inode)
843 {
844         size_t max = 0;
845         for (unsigned i = 0; i < inode->i_num_streams; i++) {
846                 const struct wim_inode_stream *strm = &inode->i_streams[i];
847                 if (!stream_is_named_data_stream(strm))
848                         continue;
849                 size_t len = utf16le_len_chars(strm->stream_name);
850                 if (len > max)
851                         max = len;
852         }
853         if (max)
854                 max += 1;
855         return max;
856 }
857
858 /* Find the length, in wide characters, of the longest path needed for
859  * extraction of any file in @dentry_list relative to the target directory.
860  *
861  * Accounts for named data streams, but does not include null terminator (not
862  * needed for NtCreateFile).  */
863 static size_t
864 compute_path_max(struct list_head *dentry_list)
865 {
866         size_t max = 0;
867         const struct wim_dentry *dentry;
868
869         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
870                 size_t len;
871
872                 len = dentry_extraction_path_length(dentry);
873
874                 /* Account for named data streams  */
875                 len += inode_longest_named_data_stream_spec(dentry->d_inode);
876
877                 if (len > max)
878                         max = len;
879         }
880
881         return max;
882 }
883
884 /* Build the path at which to extract the @dentry, relative to the target
885  * directory.
886  *
887  * The path is saved in ctx->pathbuf.  */
888 static void
889 build_extraction_path(const struct wim_dentry *dentry,
890                       struct win32_apply_ctx *ctx)
891 {
892         size_t len;
893         wchar_t *p;
894         const struct wim_dentry *d;
895
896         len = dentry_extraction_path_length(dentry);
897
898         ctx->pathbuf.Length = len * sizeof(wchar_t);
899         p = ctx->pathbuf.Buffer + len;
900         for (d = dentry;
901              !dentry_is_root(d->d_parent) && will_extract_dentry(d->d_parent);
902              d = d->d_parent)
903         {
904                 p -= d->d_extraction_name_nchars;
905                 if (d->d_extraction_name_nchars)
906                         wmemcpy(p, d->d_extraction_name,
907                                 d->d_extraction_name_nchars);
908                 *--p = '\\';
909         }
910         /* No leading slash  */
911         p -= d->d_extraction_name_nchars;
912         wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
913 }
914
915 /* Build the path at which to extract the @dentry, relative to the target
916  * directory, adding the suffix for a named data stream.
917  *
918  * The path is saved in ctx->pathbuf.  */
919 static void
920 build_extraction_path_with_ads(const struct wim_dentry *dentry,
921                                struct win32_apply_ctx *ctx,
922                                const wchar_t *stream_name,
923                                size_t stream_name_nchars)
924 {
925         wchar_t *p;
926
927         build_extraction_path(dentry, ctx);
928
929         /* Add :NAME for named data stream  */
930         p = ctx->pathbuf.Buffer + (ctx->pathbuf.Length / sizeof(wchar_t));
931         *p++ = L':';
932         wmemcpy(p, stream_name, stream_name_nchars);
933         ctx->pathbuf.Length += (1 + stream_name_nchars) * sizeof(wchar_t);
934 }
935
936 /* Build the Win32 namespace path to the specified @dentry when extracted.
937  *
938  * The path is saved in ctx->pathbuf and will be null terminated.
939  *
940  * XXX: We could get rid of this if it wasn't needed for the file encryption
941  * APIs, and the registry manipulation in WIMBoot mode.  */
942 static void
943 build_win32_extraction_path(const struct wim_dentry *dentry,
944                             struct win32_apply_ctx *ctx)
945 {
946         build_extraction_path(dentry, ctx);
947
948         /* Prepend target_ntpath to our relative path, then change \??\ into \\?\  */
949
950         memmove(ctx->pathbuf.Buffer +
951                         (ctx->target_ntpath.Length / sizeof(wchar_t)) + 1,
952                 ctx->pathbuf.Buffer, ctx->pathbuf.Length);
953         memcpy(ctx->pathbuf.Buffer, ctx->target_ntpath.Buffer,
954                 ctx->target_ntpath.Length);
955         ctx->pathbuf.Buffer[ctx->target_ntpath.Length / sizeof(wchar_t)] = L'\\';
956         ctx->pathbuf.Length += ctx->target_ntpath.Length + sizeof(wchar_t);
957         ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)] = L'\0';
958
959         wimlib_assert(ctx->pathbuf.Length >= 4 * sizeof(wchar_t) &&
960                       !wmemcmp(ctx->pathbuf.Buffer, L"\\??\\", 4));
961
962         ctx->pathbuf.Buffer[1] = L'\\';
963
964 }
965
966 /* Returns a "printable" representation of the last relative NT path that was
967  * constructed with build_extraction_path() or build_extraction_path_with_ads().
968  *
969  * This will be overwritten by the next call to this function.  */
970 static const wchar_t *
971 current_path(struct win32_apply_ctx *ctx)
972 {
973         wchar_t *p = ctx->print_buffer;
974
975         p = wmempcpy(p, ctx->common.target, ctx->common.target_nchars);
976         *p++ = L'\\';
977         p = wmempcpy(p, ctx->pathbuf.Buffer, ctx->pathbuf.Length / sizeof(wchar_t));
978         *p = L'\0';
979         return ctx->print_buffer;
980 }
981
982 /* Open handle to the target directory if it is not already open.  If the target
983  * directory does not exist, this creates it.  */
984 static int
985 open_target_directory(struct win32_apply_ctx *ctx)
986 {
987         NTSTATUS status;
988
989         if (ctx->h_target)
990                 return 0;
991
992         ctx->attr.Length = sizeof(ctx->attr);
993         ctx->attr.RootDirectory = NULL;
994         ctx->attr.ObjectName = &ctx->target_ntpath;
995
996         /* Don't use FILE_OPEN_REPARSE_POINT here; we want the extraction to
997          * happen at the directory "pointed to" by the reparse point. */
998         status = (*func_NtCreateFile)(&ctx->h_target,
999                                       FILE_TRAVERSE,
1000                                       &ctx->attr,
1001                                       &ctx->iosb,
1002                                       NULL,
1003                                       0,
1004                                       FILE_SHARE_VALID_FLAGS,
1005                                       FILE_OPEN_IF,
1006                                       FILE_DIRECTORY_FILE |
1007                                               FILE_OPEN_FOR_BACKUP_INTENT,
1008                                       NULL,
1009                                       0);
1010         if (!NT_SUCCESS(status)) {
1011                 winnt_error(status, L"Can't open or create directory \"%ls\"",
1012                             ctx->common.target);
1013                 return WIMLIB_ERR_OPENDIR;
1014         }
1015         ctx->attr.RootDirectory = ctx->h_target;
1016         ctx->attr.ObjectName = &ctx->pathbuf;
1017         return 0;
1018 }
1019
1020 static void
1021 close_target_directory(struct win32_apply_ctx *ctx)
1022 {
1023         if (ctx->h_target) {
1024                 (*func_NtClose)(ctx->h_target);
1025                 ctx->h_target = NULL;
1026                 ctx->attr.RootDirectory = NULL;
1027         }
1028 }
1029
1030 /*
1031  * Ensures the target directory exists and opens a handle to it, in preparation
1032  * of using paths relative to it.
1033  */
1034 static int
1035 prepare_target(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1036 {
1037         int ret;
1038         size_t path_max;
1039
1040         ret = win32_path_to_nt_path(ctx->common.target, &ctx->target_ntpath);
1041         if (ret)
1042                 return ret;
1043
1044         ret = open_target_directory(ctx);
1045         if (ret)
1046                 return ret;
1047
1048         path_max = compute_path_max(dentry_list);
1049         /* Add some extra for building Win32 paths for the file encryption APIs,
1050          * and ensure we have at least enough to potentially use a 8.3 name for
1051          * the last component.  */
1052         path_max += max(2 + (ctx->target_ntpath.Length / sizeof(wchar_t)),
1053                         8 + 1 + 3);
1054
1055         ctx->pathbuf.MaximumLength = path_max * sizeof(wchar_t);
1056         ctx->pathbuf.Buffer = MALLOC(ctx->pathbuf.MaximumLength);
1057         if (!ctx->pathbuf.Buffer)
1058                 return WIMLIB_ERR_NOMEM;
1059
1060         ctx->print_buffer = MALLOC((ctx->common.target_nchars + 1 + path_max + 1) *
1061                                    sizeof(wchar_t));
1062         if (!ctx->print_buffer)
1063                 return WIMLIB_ERR_NOMEM;
1064
1065         return 0;
1066 }
1067
1068 /* When creating an inode that will have a short (DOS) name, we create it using
1069  * the long name associated with the short name.  This ensures that the short
1070  * name gets associated with the correct long name.  */
1071 static struct wim_dentry *
1072 first_extraction_alias(const struct wim_inode *inode)
1073 {
1074         struct wim_dentry *dentry;
1075
1076         inode_for_each_extraction_alias(dentry, inode)
1077                 if (dentry_has_short_name(dentry))
1078                         return dentry;
1079         return inode_first_extraction_dentry(inode);
1080 }
1081
1082 /*
1083  * Set or clear FILE_ATTRIBUTE_COMPRESSED if the inherited value is different
1084  * from the desired value.
1085  *
1086  * Note that you can NOT override the inherited value of
1087  * FILE_ATTRIBUTE_COMPRESSED directly with NtCreateFile().
1088  */
1089 static int
1090 adjust_compression_attribute(HANDLE h, const struct wim_dentry *dentry,
1091                              struct win32_apply_ctx *ctx)
1092 {
1093         const bool compressed = (dentry->d_inode->i_attributes &
1094                                  FILE_ATTRIBUTE_COMPRESSED);
1095
1096         if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
1097                 return 0;
1098
1099         if (!ctx->common.supported_features.compressed_files)
1100                 return 0;
1101
1102         FILE_BASIC_INFORMATION info;
1103         NTSTATUS status;
1104         USHORT compression_state;
1105         DWORD bytes_returned;
1106
1107         /* Get current attributes  */
1108         status = (*func_NtQueryInformationFile)(h, &ctx->iosb,
1109                                                 &info, sizeof(info),
1110                                                 FileBasicInformation);
1111         if (NT_SUCCESS(status) &&
1112             compressed == !!(info.FileAttributes & FILE_ATTRIBUTE_COMPRESSED))
1113         {
1114                 /* Nothing needs to be done.  */
1115                 return 0;
1116         }
1117
1118         /* Set the new compression state  */
1119
1120         if (compressed)
1121                 compression_state = COMPRESSION_FORMAT_DEFAULT;
1122         else
1123                 compression_state = COMPRESSION_FORMAT_NONE;
1124
1125         /* Note: don't use NtFsControlFile() here unless prepared to handle
1126          * STATUS_PENDING.  */
1127         if (DeviceIoControl(h, FSCTL_SET_COMPRESSION,
1128                             &compression_state, sizeof(USHORT), NULL, 0,
1129                             &bytes_returned, NULL))
1130                 return 0;
1131
1132         win32_error(GetLastError(), L"Can't %s compression attribute on \"%ls\"",
1133                     (compressed ? "set" : "clear"), current_path(ctx));
1134         return WIMLIB_ERR_SET_ATTRIBUTES;
1135 }
1136
1137 /* Try to enable short name support on the target volume.  If successful, return
1138  * true.  If unsuccessful, issue a warning and return false.  */
1139 static bool
1140 try_to_enable_short_names(const wchar_t *volume)
1141 {
1142         HANDLE h;
1143         FILE_FS_PERSISTENT_VOLUME_INFORMATION info;
1144         BOOL bret;
1145         DWORD bytesReturned;
1146
1147         h = CreateFile(volume, GENERIC_WRITE,
1148                        FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
1149                        FILE_FLAG_BACKUP_SEMANTICS, NULL);
1150         if (h == INVALID_HANDLE_VALUE)
1151                 goto fail;
1152
1153         info.VolumeFlags = 0;
1154         info.FlagMask = PERSISTENT_VOLUME_STATE_SHORT_NAME_CREATION_DISABLED;
1155         info.Version = 1;
1156         info.Reserved = 0;
1157
1158         bret = DeviceIoControl(h, FSCTL_SET_PERSISTENT_VOLUME_STATE,
1159                                &info, sizeof(info), NULL, 0,
1160                                &bytesReturned, NULL);
1161
1162         CloseHandle(h);
1163
1164         if (!bret)
1165                 goto fail;
1166         return true;
1167
1168 fail:
1169         win32_warning(GetLastError(),
1170                       L"Failed to enable short name support on %ls",
1171                       volume + 4);
1172         return false;
1173 }
1174
1175 static NTSTATUS
1176 remove_conflicting_short_name(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
1177 {
1178         wchar_t *name;
1179         wchar_t *end;
1180         NTSTATUS status;
1181         HANDLE h;
1182         size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1183                          (13 * sizeof(wchar_t));
1184         u8 buf[bufsize] _aligned_attribute(8);
1185         bool retried = false;
1186         FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1187
1188         memset(buf, 0, bufsize);
1189
1190         /* Build the path with the short name.  */
1191         name = &ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)];
1192         while (name != ctx->pathbuf.Buffer && *(name - 1) != L'\\')
1193                 name--;
1194         end = mempcpy(name, dentry->d_short_name, dentry->d_short_name_nbytes);
1195         ctx->pathbuf.Length = ((u8 *)end - (u8 *)ctx->pathbuf.Buffer);
1196
1197         /* Open the conflicting file (by short name).  */
1198         status = (*func_NtOpenFile)(&h, GENERIC_WRITE | DELETE,
1199                                     &ctx->attr, &ctx->iosb,
1200                                     FILE_SHARE_VALID_FLAGS,
1201                                     FILE_OPEN_REPARSE_POINT | FILE_OPEN_FOR_BACKUP_INTENT);
1202         if (!NT_SUCCESS(status)) {
1203                 winnt_warning(status, L"Can't open \"%ls\"", current_path(ctx));
1204                 goto out;
1205         }
1206
1207 #if 0
1208         WARNING("Overriding conflicting short name; path=\"%ls\"",
1209                 current_path(ctx));
1210 #endif
1211
1212         /* Try to remove the short name on the conflicting file.  */
1213
1214 retry:
1215         status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1216                                               FileShortNameInformation);
1217
1218         if (status == STATUS_INVALID_PARAMETER && !retried) {
1219
1220                 /* Microsoft forgot to make it possible to remove short names
1221                  * until Windows 7.  Oops.  Use a random short name instead.  */
1222
1223                 info->FileNameLength = 12 * sizeof(wchar_t);
1224                 for (int i = 0; i < 8; i++)
1225                         info->FileName[i] = 'A' + (rand() % 26);
1226                 info->FileName[8] = L'.';
1227                 info->FileName[9] = L'W';
1228                 info->FileName[10] = L'L';
1229                 info->FileName[11] = L'B';
1230                 info->FileName[12] = L'\0';
1231                 retried = true;
1232                 goto retry;
1233         }
1234         (*func_NtClose)(h);
1235 out:
1236         build_extraction_path(dentry, ctx);
1237         return status;
1238 }
1239
1240 /* Set the short name on the open file @h which has been created at the location
1241  * indicated by @dentry.
1242  *
1243  * Note that this may add, change, or remove the short name.
1244  *
1245  * @h must be opened with DELETE access.
1246  *
1247  * Returns 0 or WIMLIB_ERR_SET_SHORT_NAME.  The latter only happens in
1248  * STRICT_SHORT_NAMES mode.
1249  */
1250 static int
1251 set_short_name(HANDLE h, const struct wim_dentry *dentry,
1252                struct win32_apply_ctx *ctx)
1253 {
1254
1255         if (!ctx->common.supported_features.short_names)
1256                 return 0;
1257
1258         /*
1259          * Note: The size of the FILE_NAME_INFORMATION buffer must be such that
1260          * FileName contains at least 2 wide characters (4 bytes).  Otherwise,
1261          * NtSetInformationFile() will return STATUS_INFO_LENGTH_MISMATCH.  This
1262          * is despite the fact that FileNameLength can validly be 0 or 2 bytes,
1263          * with the former case being removing the existing short name if
1264          * present, rather than setting one.
1265          *
1266          * The null terminator is seemingly optional, but to be safe we include
1267          * space for it and zero all unused space.
1268          */
1269
1270         size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1271                          max(dentry->d_short_name_nbytes, sizeof(wchar_t)) +
1272                          sizeof(wchar_t);
1273         u8 buf[bufsize] _aligned_attribute(8);
1274         FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1275         NTSTATUS status;
1276         bool tried_to_remove_existing = false;
1277
1278         memset(buf, 0, bufsize);
1279
1280         info->FileNameLength = dentry->d_short_name_nbytes;
1281         memcpy(info->FileName, dentry->d_short_name, dentry->d_short_name_nbytes);
1282
1283 retry:
1284         status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1285                                               FileShortNameInformation);
1286         if (NT_SUCCESS(status))
1287                 return 0;
1288
1289         if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
1290                 if (dentry->d_short_name_nbytes == 0)
1291                         return 0;
1292                 if (!ctx->tried_to_enable_short_names) {
1293                         wchar_t volume[7];
1294                         int ret;
1295
1296                         ctx->tried_to_enable_short_names = true;
1297
1298                         ret = win32_get_drive_path(ctx->common.target,
1299                                                    volume);
1300                         if (ret)
1301                                 return ret;
1302                         if (try_to_enable_short_names(volume))
1303                                 goto retry;
1304                 }
1305         }
1306
1307         /*
1308          * Short names can conflict in several cases:
1309          *
1310          * - a file being extracted has a short name conflicting with an
1311          *   existing file
1312          *
1313          * - a file being extracted has a short name conflicting with another
1314          *   file being extracted (possible, but shouldn't happen)
1315          *
1316          * - a file being extracted has a short name that conflicts with the
1317          *   automatically generated short name of a file we previously
1318          *   extracted, but failed to set the short name for.  Sounds unlikely,
1319          *   but this actually does happen fairly often on versions of Windows
1320          *   prior to Windows 7 because they do not support removing short names
1321          *   from files.
1322          */
1323         if (unlikely(status == STATUS_OBJECT_NAME_COLLISION) &&
1324             dentry->d_short_name_nbytes && !tried_to_remove_existing)
1325         {
1326                 tried_to_remove_existing = true;
1327                 status = remove_conflicting_short_name(dentry, ctx);
1328                 if (NT_SUCCESS(status))
1329                         goto retry;
1330         }
1331
1332         /* By default, failure to set short names is not an error (since short
1333          * names aren't too important anymore...).  */
1334         if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
1335                 if (dentry->d_short_name_nbytes)
1336                         ctx->num_set_short_name_failures++;
1337                 else
1338                         ctx->num_remove_short_name_failures++;
1339                 return 0;
1340         }
1341
1342         winnt_error(status, L"Can't set short name on \"%ls\"", current_path(ctx));
1343         return WIMLIB_ERR_SET_SHORT_NAME;
1344 }
1345
1346 /*
1347  * A wrapper around NtCreateFile() to make it slightly more usable...
1348  * This uses the path currently constructed in ctx->pathbuf.
1349  *
1350  * Also, we always specify FILE_OPEN_FOR_BACKUP_INTENT and
1351  * FILE_OPEN_REPARSE_POINT.
1352  */
1353 static NTSTATUS
1354 do_create_file(PHANDLE FileHandle,
1355                ACCESS_MASK DesiredAccess,
1356                PLARGE_INTEGER AllocationSize,
1357                ULONG FileAttributes,
1358                ULONG CreateDisposition,
1359                ULONG CreateOptions,
1360                struct win32_apply_ctx *ctx)
1361 {
1362         return (*func_NtCreateFile)(FileHandle,
1363                                     DesiredAccess,
1364                                     &ctx->attr,
1365                                     &ctx->iosb,
1366                                     AllocationSize,
1367                                     FileAttributes,
1368                                     FILE_SHARE_VALID_FLAGS,
1369                                     CreateDisposition,
1370                                     CreateOptions |
1371                                         FILE_OPEN_FOR_BACKUP_INTENT |
1372                                         FILE_OPEN_REPARSE_POINT,
1373                                     NULL,
1374                                     0);
1375 }
1376
1377 /* Like do_create_file(), but builds the extraction path of the @dentry first.
1378  */
1379 static NTSTATUS
1380 create_file(PHANDLE FileHandle,
1381             ACCESS_MASK DesiredAccess,
1382             PLARGE_INTEGER AllocationSize,
1383             ULONG FileAttributes,
1384             ULONG CreateDisposition,
1385             ULONG CreateOptions,
1386             const struct wim_dentry *dentry,
1387             struct win32_apply_ctx *ctx)
1388 {
1389         build_extraction_path(dentry, ctx);
1390         return do_create_file(FileHandle,
1391                               DesiredAccess,
1392                               AllocationSize,
1393                               FileAttributes,
1394                               CreateDisposition,
1395                               CreateOptions,
1396                               ctx);
1397 }
1398
1399 static int
1400 delete_file_or_stream(struct win32_apply_ctx *ctx)
1401 {
1402         NTSTATUS status;
1403         HANDLE h;
1404         ULONG perms = DELETE;
1405         ULONG flags = FILE_NON_DIRECTORY_FILE | FILE_DELETE_ON_CLOSE;
1406
1407         /* First try opening the file with FILE_DELETE_ON_CLOSE.  In most cases,
1408          * all we have to do is that plus close the file handle.  */
1409 retry:
1410         status = do_create_file(&h, perms, NULL, 0, FILE_OPEN, flags, ctx);
1411
1412         if (unlikely(status == STATUS_CANNOT_DELETE)) {
1413                 /* This error occurs for files with FILE_ATTRIBUTE_READONLY set.
1414                  * Try an alternate approach: first open the file without
1415                  * FILE_DELETE_ON_CLOSE, then reset the file attributes, then
1416                  * set the "delete" disposition on the handle.  */
1417                 if (flags & FILE_DELETE_ON_CLOSE) {
1418                         flags &= ~FILE_DELETE_ON_CLOSE;
1419                         perms |= FILE_WRITE_ATTRIBUTES;
1420                         goto retry;
1421                 }
1422         }
1423
1424         if (unlikely(!NT_SUCCESS(status))) {
1425                 winnt_error(status, L"Can't open \"%ls\" for deletion "
1426                             "(perms=%x, flags=%x)",
1427                             current_path(ctx), perms, flags);
1428                 return WIMLIB_ERR_OPEN;
1429         }
1430
1431         if (unlikely(!(flags & FILE_DELETE_ON_CLOSE))) {
1432
1433                 FILE_BASIC_INFORMATION basic_info =
1434                         { .FileAttributes = FILE_ATTRIBUTE_NORMAL };
1435                 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1436                                                       &basic_info,
1437                                                       sizeof(basic_info),
1438                                                       FileBasicInformation);
1439
1440                 if (!NT_SUCCESS(status)) {
1441                         winnt_error(status, L"Can't reset attributes of \"%ls\" "
1442                                     "to prepare for deletion", current_path(ctx));
1443                         (*func_NtClose)(h);
1444                         return WIMLIB_ERR_SET_ATTRIBUTES;
1445                 }
1446
1447                 FILE_DISPOSITION_INFORMATION disp_info =
1448                         { .DoDeleteFile = TRUE };
1449                 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1450                                                       &disp_info,
1451                                                       sizeof(disp_info),
1452                                                       FileDispositionInformation);
1453                 if (!NT_SUCCESS(status)) {
1454                         winnt_error(status, L"Can't set delete-on-close "
1455                                     "disposition on \"%ls\"", current_path(ctx));
1456                         (*func_NtClose)(h);
1457                         return WIMLIB_ERR_SET_ATTRIBUTES;
1458                 }
1459         }
1460
1461         status = (*func_NtClose)(h);
1462         if (unlikely(!NT_SUCCESS(status))) {
1463                 winnt_error(status, L"Error closing \"%ls\" after setting "
1464                             "delete-on-close disposition", current_path(ctx));
1465                 return WIMLIB_ERR_OPEN;
1466         }
1467
1468         return 0;
1469 }
1470
1471 /*
1472  * Create a nondirectory file or named data stream at the current path,
1473  * superseding any that already exists at that path.  If successful, return an
1474  * open handle to the file or named data stream.
1475  */
1476 static int
1477 supersede_file_or_stream(struct win32_apply_ctx *ctx, HANDLE *h_ret)
1478 {
1479         NTSTATUS status;
1480         bool retried = false;
1481
1482         /* FILE_ATTRIBUTE_SYSTEM is needed to ensure that
1483          * FILE_ATTRIBUTE_ENCRYPTED doesn't get set before we want it to be.  */
1484 retry:
1485         status = do_create_file(h_ret,
1486                                 GENERIC_READ | GENERIC_WRITE | DELETE,
1487                                 NULL,
1488                                 FILE_ATTRIBUTE_SYSTEM,
1489                                 FILE_CREATE,
1490                                 FILE_NON_DIRECTORY_FILE,
1491                                 ctx);
1492         if (likely(NT_SUCCESS(status)))
1493                 return 0;
1494
1495         /* STATUS_OBJECT_NAME_COLLISION means that the file or stream already
1496          * exists.  Delete the existing file or stream, then try again.
1497          *
1498          * Note: we don't use FILE_OVERWRITE_IF or FILE_SUPERSEDE because of
1499          * problems with certain file attributes, especially
1500          * FILE_ATTRIBUTE_ENCRYPTED.  FILE_SUPERSEDE is also broken in the
1501          * Windows PE ramdisk.  */
1502         if (status == STATUS_OBJECT_NAME_COLLISION && !retried) {
1503                 int ret = delete_file_or_stream(ctx);
1504                 if (ret)
1505                         return ret;
1506                 retried = true;
1507                 goto retry;
1508         }
1509         winnt_error(status, L"Can't create \"%ls\"", current_path(ctx));
1510         return WIMLIB_ERR_OPEN;
1511 }
1512
1513 /* Set the reparse point @rpbuf of length @rpbuflen on the extracted file
1514  * corresponding to the WIM dentry @dentry.  */
1515 static int
1516 do_set_reparse_point(const struct wim_dentry *dentry,
1517                      const struct reparse_buffer_disk *rpbuf, u16 rpbuflen,
1518                      struct win32_apply_ctx *ctx)
1519 {
1520         NTSTATUS status;
1521         HANDLE h;
1522
1523         status = create_file(&h, GENERIC_WRITE, NULL,
1524                              0, FILE_OPEN, 0, dentry, ctx);
1525         if (!NT_SUCCESS(status))
1526                 goto fail;
1527
1528         status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
1529                                          &ctx->iosb, FSCTL_SET_REPARSE_POINT,
1530                                          (void *)rpbuf, rpbuflen,
1531                                          NULL, 0);
1532         (*func_NtClose)(h);
1533
1534         if (NT_SUCCESS(status))
1535                 return 0;
1536
1537         /* On Windows, by default only the Administrator can create symbolic
1538          * links for some reason.  By default we just issue a warning if this
1539          * appears to be the problem.  Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
1540          * to get a hard error.  */
1541         if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
1542             && (status == STATUS_PRIVILEGE_NOT_HELD ||
1543                 status == STATUS_ACCESS_DENIED)
1544             && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1545                 dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1546         {
1547                 WARNING("Can't create symbolic link \"%ls\"!              \n"
1548                         "          (Need Administrator rights, or at least "
1549                         "the\n"
1550                         "          SeCreateSymbolicLink privilege.)",
1551                         current_path(ctx));
1552                 return 0;
1553         }
1554
1555 fail:
1556         winnt_error(status, L"Can't set reparse data on \"%ls\"",
1557                     current_path(ctx));
1558         return WIMLIB_ERR_SET_REPARSE_DATA;
1559 }
1560
1561 /*
1562  * Create empty named data streams and potentially a reparse point for the
1563  * specified file, if any.
1564  *
1565  * Since these won't have blob descriptors, they won't show up in the call to
1566  * extract_blob_list().  Hence the need for the special case.
1567  */
1568 static int
1569 create_empty_streams(const struct wim_dentry *dentry,
1570                      struct win32_apply_ctx *ctx)
1571 {
1572         const struct wim_inode *inode = dentry->d_inode;
1573         int ret;
1574
1575         for (unsigned i = 0; i < inode->i_num_streams; i++) {
1576                 const struct wim_inode_stream *strm = &inode->i_streams[i];
1577
1578                 if (stream_blob_resolved(strm) != NULL)
1579                         continue;
1580
1581                 if (strm->stream_type == STREAM_TYPE_REPARSE_POINT &&
1582                     ctx->common.supported_features.reparse_points)
1583                 {
1584                         u8 buf[REPARSE_DATA_OFFSET] _aligned_attribute(8);
1585                         struct reparse_buffer_disk *rpbuf =
1586                                 (struct reparse_buffer_disk *)buf;
1587                         complete_reparse_point(rpbuf, inode, 0);
1588                         ret = do_set_reparse_point(dentry, rpbuf,
1589                                                    REPARSE_DATA_OFFSET, ctx);
1590                         if (ret)
1591                                 return ret;
1592                 } else if (stream_is_named_data_stream(strm) &&
1593                            ctx->common.supported_features.named_data_streams)
1594                 {
1595                         HANDLE h;
1596
1597                         build_extraction_path_with_ads(dentry, ctx,
1598                                                        strm->stream_name,
1599                                                        utf16le_len_chars(strm->stream_name));
1600                         ret = supersede_file_or_stream(ctx, &h);
1601
1602                         build_extraction_path(dentry, ctx);
1603
1604                         if (ret)
1605                                 return ret;
1606                         (*func_NtClose)(h);
1607                 }
1608         }
1609
1610         return 0;
1611 }
1612
1613 /*
1614  * Creates the directory named by @dentry, or uses an existing directory at that
1615  * location.  If necessary, sets the short name and/or fixes compression and
1616  * encryption attributes.
1617  *
1618  * Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
1619  */
1620 static int
1621 create_directory(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
1622 {
1623         DWORD perms;
1624         NTSTATUS status;
1625         HANDLE h;
1626         int ret;
1627
1628         /* DELETE is needed for set_short_name(); GENERIC_READ and GENERIC_WRITE
1629          * are needed for adjust_compression_attribute(); WRITE_DAC is needed to
1630          * remove the directory's DACL if the directory already existed  */
1631         perms = GENERIC_READ | GENERIC_WRITE | WRITE_DAC;
1632         if (!dentry_is_root(dentry))
1633                 perms |= DELETE;
1634
1635         /* FILE_ATTRIBUTE_SYSTEM is needed to ensure that
1636          * FILE_ATTRIBUTE_ENCRYPTED doesn't get set before we want it to be.  */
1637 retry:
1638         status = create_file(&h, perms, NULL, FILE_ATTRIBUTE_SYSTEM,
1639                              FILE_OPEN_IF, FILE_DIRECTORY_FILE, dentry, ctx);
1640         if (unlikely(!NT_SUCCESS(status))) {
1641                 if (status == STATUS_ACCESS_DENIED) {
1642                         if (perms & WRITE_DAC) {
1643                                 perms &= ~WRITE_DAC;
1644                                 goto retry;
1645                         }
1646                         if (perms & DELETE) {
1647                                 perms &= ~DELETE;
1648                                 goto retry;
1649                         }
1650                 }
1651                 winnt_error(status, L"Can't create directory \"%ls\"",
1652                             current_path(ctx));
1653                 return WIMLIB_ERR_MKDIR;
1654         }
1655
1656         if (ctx->iosb.Information == FILE_OPENED) {
1657                 /* If we opened an existing directory, try to clear its file
1658                  * attributes.  As far as I know, this only actually makes a
1659                  * difference in the case where a FILE_ATTRIBUTE_READONLY
1660                  * directory has a named data stream which needs to be
1661                  * extracted.  You cannot create a named data stream of such a
1662                  * directory, even though this contradicts Microsoft's
1663                  * documentation for FILE_ATTRIBUTE_READONLY which states it is
1664                  * not honored for directories!  */
1665                 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)) {
1666                         FILE_BASIC_INFORMATION basic_info =
1667                                 { .FileAttributes = FILE_ATTRIBUTE_NORMAL };
1668                         (*func_NtSetInformationFile)(h, &ctx->iosb, &basic_info,
1669                                                      sizeof(basic_info),
1670                                                      FileBasicInformation);
1671                 }
1672
1673                 /* Also try to remove the directory's DACL.  This isn't supposed
1674                  * to be necessary because we *always* use backup semantics.
1675                  * However, there is a case where NtCreateFile() fails with
1676                  * STATUS_ACCESS_DENIED when creating a named data stream that
1677                  * was just deleted, using a directory-relative open.  I have no
1678                  * idea why Windows is broken in this case.  */
1679                 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS)) {
1680                         static const SECURITY_DESCRIPTOR_RELATIVE desc = {
1681                                 .Revision = SECURITY_DESCRIPTOR_REVISION1,
1682                                 .Control = SE_SELF_RELATIVE | SE_DACL_PRESENT,
1683                                 .Owner = 0,
1684                                 .Group = 0,
1685                                 .Sacl = 0,
1686                                 .Dacl = 0,
1687                         };
1688                         (*func_NtSetSecurityObject)(h, DACL_SECURITY_INFORMATION,
1689                                                     (void *)&desc);
1690                 }
1691         }
1692
1693         if (!dentry_is_root(dentry)) {
1694                 ret = set_short_name(h, dentry, ctx);
1695                 if (ret)
1696                         goto out;
1697         }
1698
1699         ret = adjust_compression_attribute(h, dentry, ctx);
1700 out:
1701         (*func_NtClose)(h);
1702         return ret;
1703 }
1704
1705 /*
1706  * Create all the directories being extracted, other than the target directory
1707  * itself.
1708  *
1709  * Note: we don't honor directory hard links.  However, we don't allow them to
1710  * exist in WIM images anyway (see inode_fixup.c).
1711  */
1712 static int
1713 create_directories(struct list_head *dentry_list,
1714                    struct win32_apply_ctx *ctx)
1715 {
1716         const struct wim_dentry *dentry;
1717         int ret;
1718
1719         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1720
1721                 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
1722                         continue;
1723
1724                 /* Note: Here we include files with
1725                  * FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
1726                  * wait until later to actually set the reparse data.  */
1727
1728                 ret = create_directory(dentry, ctx);
1729
1730                 if (!ret)
1731                         ret = create_empty_streams(dentry, ctx);
1732
1733                 ret = check_apply_error(dentry, ctx, ret);
1734                 if (ret)
1735                         return ret;
1736
1737                 ret = report_file_created(&ctx->common);
1738                 if (ret)
1739                         return ret;
1740         }
1741         return 0;
1742 }
1743
1744 /*
1745  * Creates the nondirectory file named by @dentry.
1746  *
1747  * On success, returns an open handle to the file in @h_ret, with GENERIC_READ,
1748  * GENERIC_WRITE, and DELETE access.  Also, the path to the file will be saved
1749  * in ctx->pathbuf.  On failure, returns an error code.
1750  */
1751 static int
1752 create_nondirectory_inode(HANDLE *h_ret, const struct wim_dentry *dentry,
1753                           struct win32_apply_ctx *ctx)
1754 {
1755         int ret;
1756         HANDLE h;
1757
1758         build_extraction_path(dentry, ctx);
1759
1760         ret = supersede_file_or_stream(ctx, &h);
1761         if (ret)
1762                 goto out;
1763
1764         ret = adjust_compression_attribute(h, dentry, ctx);
1765         if (ret)
1766                 goto out_close;
1767
1768         ret = create_empty_streams(dentry, ctx);
1769         if (ret)
1770                 goto out_close;
1771
1772         *h_ret = h;
1773         return 0;
1774
1775 out_close:
1776         (*func_NtClose)(h);
1777 out:
1778         return ret;
1779 }
1780
1781 /* Creates a hard link at the location named by @dentry to the file represented
1782  * by the open handle @h.  Or, if the target volume does not support hard links,
1783  * create a separate file instead.  */
1784 static int
1785 create_link(HANDLE h, const struct wim_dentry *dentry,
1786             struct win32_apply_ctx *ctx)
1787 {
1788         if (ctx->common.supported_features.hard_links) {
1789
1790                 build_extraction_path(dentry, ctx);
1791
1792                 size_t bufsize = offsetof(FILE_LINK_INFORMATION, FileName) +
1793                                  ctx->pathbuf.Length + sizeof(wchar_t);
1794                 u8 buf[bufsize] _aligned_attribute(8);
1795                 FILE_LINK_INFORMATION *info = (FILE_LINK_INFORMATION *)buf;
1796                 NTSTATUS status;
1797
1798                 info->ReplaceIfExists = TRUE;
1799                 info->RootDirectory = ctx->attr.RootDirectory;
1800                 info->FileNameLength = ctx->pathbuf.Length;
1801                 memcpy(info->FileName, ctx->pathbuf.Buffer, ctx->pathbuf.Length);
1802                 info->FileName[info->FileNameLength / 2] = L'\0';
1803
1804                 /* Note: the null terminator isn't actually necessary,
1805                  * but if you don't add the extra character, you get
1806                  * STATUS_INFO_LENGTH_MISMATCH when FileNameLength
1807                  * happens to be 2  */
1808
1809                 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1810                                                       info, bufsize,
1811                                                       FileLinkInformation);
1812                 if (NT_SUCCESS(status))
1813                         return 0;
1814                 winnt_error(status, L"Failed to create link \"%ls\"",
1815                             current_path(ctx));
1816                 return WIMLIB_ERR_LINK;
1817         } else {
1818                 HANDLE h2;
1819                 int ret;
1820
1821                 ret = create_nondirectory_inode(&h2, dentry, ctx);
1822                 if (ret)
1823                         return ret;
1824
1825                 (*func_NtClose)(h2);
1826                 return 0;
1827         }
1828 }
1829
1830 /* Given an inode (represented by the open handle @h) for which one link has
1831  * been created (named by @first_dentry), create the other links.
1832  *
1833  * Or, if the target volume does not support hard links, create separate files.
1834  *
1835  * Note: This uses ctx->pathbuf and does not reset it.
1836  */
1837 static int
1838 create_links(HANDLE h, const struct wim_dentry *first_dentry,
1839              struct win32_apply_ctx *ctx)
1840 {
1841         const struct wim_inode *inode = first_dentry->d_inode;
1842         const struct wim_dentry *dentry;
1843         int ret;
1844
1845         inode_for_each_extraction_alias(dentry, inode) {
1846                 if (dentry != first_dentry) {
1847                         ret = create_link(h, dentry, ctx);
1848                         if (ret)
1849                                 return ret;
1850                 }
1851         }
1852         return 0;
1853 }
1854
1855 /* Create a nondirectory file, including all links.  */
1856 static int
1857 create_nondirectory(struct wim_inode *inode, struct win32_apply_ctx *ctx)
1858 {
1859         struct wim_dentry *first_dentry;
1860         HANDLE h;
1861         int ret;
1862
1863         first_dentry = first_extraction_alias(inode);
1864
1865         /* Create first link.  */
1866         ret = create_nondirectory_inode(&h, first_dentry, ctx);
1867         if (ret)
1868                 return ret;
1869
1870         /* Set short name.  */
1871         ret = set_short_name(h, first_dentry, ctx);
1872
1873         /* Create additional links, OR if hard links are not supported just
1874          * create more files.  */
1875         if (!ret)
1876                 ret = create_links(h, first_dentry, ctx);
1877
1878         /* "WIMBoot" extraction: set external backing by the WIM file if needed.  */
1879         if (!ret && unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
1880                 ret = set_backed_from_wim(h, inode, ctx);
1881
1882         (*func_NtClose)(h);
1883         return ret;
1884 }
1885
1886 /* Create all the nondirectory files being extracted, including all aliases
1887  * (hard links).  */
1888 static int
1889 create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1890 {
1891         struct wim_dentry *dentry;
1892         struct wim_inode *inode;
1893         int ret;
1894
1895         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1896                 inode = dentry->d_inode;
1897                 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1898                         continue;
1899                 /* Call create_nondirectory() only once per inode  */
1900                 if (dentry == inode_first_extraction_dentry(inode)) {
1901                         ret = create_nondirectory(inode, ctx);
1902                         ret = check_apply_error(dentry, ctx, ret);
1903                         if (ret)
1904                                 return ret;
1905                 }
1906                 ret = report_file_created(&ctx->common);
1907                 if (ret)
1908                         return ret;
1909         }
1910         return 0;
1911 }
1912
1913 static void
1914 close_handles(struct win32_apply_ctx *ctx)
1915 {
1916         for (unsigned i = 0; i < ctx->num_open_handles; i++)
1917                 (*func_NtClose)(ctx->open_handles[i]);
1918 }
1919
1920 /* Prepare to read the next blob, which has size @blob_size, into an in-memory
1921  * buffer.  */
1922 static bool
1923 prepare_data_buffer(struct win32_apply_ctx *ctx, u64 blob_size)
1924 {
1925         if (blob_size > ctx->data_buffer_size) {
1926                 /* Larger buffer needed.  */
1927                 void *new_buffer;
1928                 if ((size_t)blob_size != blob_size)
1929                         return false;
1930                 new_buffer = REALLOC(ctx->data_buffer, blob_size);
1931                 if (!new_buffer)
1932                         return false;
1933                 ctx->data_buffer = new_buffer;
1934                 ctx->data_buffer_size = blob_size;
1935         }
1936         /* On the first call this changes data_buffer_ptr from NULL, which tells
1937          * extract_chunk() that the data buffer needs to be filled while reading
1938          * the stream data.  */
1939         ctx->data_buffer_ptr = ctx->data_buffer;
1940         return true;
1941 }
1942
1943 static int
1944 begin_extract_blob_instance(const struct blob_descriptor *blob,
1945                             struct wim_dentry *dentry,
1946                             const struct wim_inode_stream *strm,
1947                             struct win32_apply_ctx *ctx)
1948 {
1949         FILE_ALLOCATION_INFORMATION alloc_info;
1950         HANDLE h;
1951         NTSTATUS status;
1952
1953         if (unlikely(strm->stream_type == STREAM_TYPE_REPARSE_POINT)) {
1954                 /* We can't write the reparse point stream directly; we must set
1955                  * it with FSCTL_SET_REPARSE_POINT, which requires that all the
1956                  * data be available.  So, stage the data in a buffer.  */
1957                 if (!prepare_data_buffer(ctx, blob->size))
1958                         return WIMLIB_ERR_NOMEM;
1959                 list_add_tail(&dentry->d_tmp_list, &ctx->reparse_dentries);
1960                 return 0;
1961         }
1962
1963         if (unlikely(strm->stream_type == STREAM_TYPE_EFSRPC_RAW_DATA)) {
1964                 /* We can't write encrypted files directly; we must use
1965                  * WriteEncryptedFileRaw(), which requires providing the data
1966                  * through a callback function.  This can't easily be combined
1967                  * with our own callback-based approach.
1968                  *
1969                  * The current workaround is to simply read the blob into memory
1970                  * and write the encrypted file from that.
1971                  *
1972                  * TODO: This isn't sufficient for extremely large encrypted
1973                  * files.  Perhaps we should create an extra thread to write
1974                  * such files...  */
1975                 if (!prepare_data_buffer(ctx, blob->size))
1976                         return WIMLIB_ERR_NOMEM;
1977                 list_add_tail(&dentry->d_tmp_list, &ctx->encrypted_dentries);
1978                 return 0;
1979         }
1980
1981         /* It's a data stream (may be unnamed or named).  */
1982         wimlib_assert(strm->stream_type == STREAM_TYPE_DATA);
1983
1984         if (ctx->num_open_handles == MAX_OPEN_FILES) {
1985                 /* XXX: Fix this.  But because of the checks in
1986                  * extract_blob_list(), this can now only happen on a filesystem
1987                  * that does not support hard links.  */
1988                 ERROR("Can't extract data: too many open files!");
1989                 return WIMLIB_ERR_UNSUPPORTED;
1990         }
1991
1992
1993         if (unlikely(stream_is_named(strm))) {
1994                 build_extraction_path_with_ads(dentry, ctx,
1995                                                strm->stream_name,
1996                                                utf16le_len_chars(strm->stream_name));
1997         } else {
1998                 build_extraction_path(dentry, ctx);
1999         }
2000
2001
2002         /* Open a new handle  */
2003         status = do_create_file(&h,
2004                                 FILE_WRITE_DATA | SYNCHRONIZE,
2005                                 NULL, 0, FILE_OPEN_IF,
2006                                 FILE_SEQUENTIAL_ONLY |
2007                                         FILE_SYNCHRONOUS_IO_NONALERT,
2008                                 ctx);
2009         if (!NT_SUCCESS(status)) {
2010                 winnt_error(status, L"Can't open \"%ls\" for writing",
2011                             current_path(ctx));
2012                 return WIMLIB_ERR_OPEN;
2013         }
2014
2015         ctx->open_handles[ctx->num_open_handles++] = h;
2016
2017         /* Allocate space for the data.  */
2018         alloc_info.AllocationSize.QuadPart = blob->size;
2019         (*func_NtSetInformationFile)(h, &ctx->iosb,
2020                                      &alloc_info, sizeof(alloc_info),
2021                                      FileAllocationInformation);
2022         return 0;
2023 }
2024
2025 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
2026  * pointer to the suffix of the path that begins with the device directly, such
2027  * as e:\Windows\System32.  */
2028 static const wchar_t *
2029 skip_nt_toplevel_component(const wchar_t *path, size_t path_nchars)
2030 {
2031         static const wchar_t * const dirs[] = {
2032                 L"\\??\\",
2033                 L"\\DosDevices\\",
2034                 L"\\Device\\",
2035         };
2036         const wchar_t * const end = path + path_nchars;
2037
2038         for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
2039                 size_t len = wcslen(dirs[i]);
2040                 if (len <= (end - path) && !wmemcmp(path, dirs[i], len)) {
2041                         path += len;
2042                         while (path != end && *path == L'\\')
2043                                 path++;
2044                         return path;
2045                 }
2046         }
2047         return path;
2048 }
2049
2050 /*
2051  * Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
2052  * pointer to the suffix of the path that is device-relative but possibly with
2053  * leading slashes, such as \Windows\System32.
2054  *
2055  * The path has an explicit length and is not necessarily null terminated.
2056  */
2057 static const wchar_t *
2058 get_device_relative_path(const wchar_t *path, size_t path_nchars)
2059 {
2060         const wchar_t * const orig_path = path;
2061         const wchar_t * const end = path + path_nchars;
2062
2063         path = skip_nt_toplevel_component(path, path_nchars);
2064         if (path == orig_path)
2065                 return orig_path;
2066
2067         while (path != end && *path != L'\\')
2068                 path++;
2069
2070         return path;
2071 }
2072
2073 /*
2074  * Given a reparse point buffer for an inode for which the absolute link target
2075  * was relativized when it was archived, de-relative the link target to be
2076  * consistent with the actual extraction location.
2077  */
2078 static void
2079 try_rpfix(struct reparse_buffer_disk *rpbuf, u16 *rpbuflen_p,
2080           struct win32_apply_ctx *ctx)
2081 {
2082         struct link_reparse_point link;
2083         size_t orig_subst_name_nchars;
2084         const wchar_t *relpath;
2085         size_t relpath_nchars;
2086         size_t target_ntpath_nchars;
2087         size_t fixed_subst_name_nchars;
2088         const wchar_t *fixed_print_name;
2089         size_t fixed_print_name_nchars;
2090
2091         /* Do nothing if the reparse data is invalid.  */
2092         if (parse_link_reparse_point(rpbuf, *rpbuflen_p, &link))
2093                 return;
2094
2095         /* Do nothing if the reparse point is a relative symbolic link.  */
2096         if (link_is_relative_symlink(&link))
2097                 return;
2098
2099         /* Build the new substitute name from the NT namespace path to the
2100          * target directory, then a path separator, then the "device relative"
2101          * part of the old substitute name.  */
2102
2103         orig_subst_name_nchars = link.substitute_name_nbytes / sizeof(wchar_t);
2104
2105         relpath = get_device_relative_path(link.substitute_name,
2106                                            orig_subst_name_nchars);
2107         relpath_nchars = orig_subst_name_nchars -
2108                          (relpath - link.substitute_name);
2109
2110         target_ntpath_nchars = ctx->target_ntpath.Length / sizeof(wchar_t);
2111
2112         fixed_subst_name_nchars = target_ntpath_nchars + relpath_nchars;
2113
2114         wchar_t fixed_subst_name[fixed_subst_name_nchars];
2115
2116         wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer, target_ntpath_nchars);
2117         wmemcpy(&fixed_subst_name[target_ntpath_nchars], relpath, relpath_nchars);
2118         /* Doesn't need to be null-terminated.  */
2119
2120         /* Print name should be Win32, but not all NT names can even be
2121          * translated to Win32 names.  But we can at least delete the top-level
2122          * directory, such as \??\, and this will have the expected result in
2123          * the usual case.  */
2124         fixed_print_name = skip_nt_toplevel_component(fixed_subst_name,
2125                                                       fixed_subst_name_nchars);
2126         fixed_print_name_nchars = fixed_subst_name_nchars - (fixed_print_name -
2127                                                              fixed_subst_name);
2128
2129         link.substitute_name = fixed_subst_name;
2130         link.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
2131         link.print_name = (wchar_t *)fixed_print_name;
2132         link.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
2133         make_link_reparse_point(&link, rpbuf, rpbuflen_p);
2134 }
2135
2136 /* Sets the reparse point on the specified file.  This handles "fixing" the
2137  * targets of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX
2138  * was specified.  */
2139 static int
2140 set_reparse_point(const struct wim_dentry *dentry,
2141                   const struct reparse_buffer_disk *rpbuf, u16 rpbuflen,
2142                   struct win32_apply_ctx *ctx)
2143 {
2144         if ((ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
2145             && !(dentry->d_inode->i_rp_flags & WIM_RP_FLAG_NOT_FIXED))
2146         {
2147                 memcpy(&ctx->rpfixbuf, rpbuf, rpbuflen);
2148                 try_rpfix(&ctx->rpfixbuf, &rpbuflen, ctx);
2149                 rpbuf = &ctx->rpfixbuf;
2150         }
2151         return do_set_reparse_point(dentry, rpbuf, rpbuflen, ctx);
2152
2153 }
2154
2155 /* Import the next block of raw encrypted data  */
2156 static DWORD WINAPI
2157 import_encrypted_data(PBYTE pbData, PVOID pvCallbackContext, PULONG Length)
2158 {
2159         struct win32_apply_ctx *ctx = pvCallbackContext;
2160         ULONG copy_len;
2161
2162         copy_len = min(ctx->encrypted_size - ctx->encrypted_offset, *Length);
2163         memcpy(pbData, &ctx->data_buffer[ctx->encrypted_offset], copy_len);
2164         ctx->encrypted_offset += copy_len;
2165         *Length = copy_len;
2166         return ERROR_SUCCESS;
2167 }
2168
2169 /*
2170  * Write the raw encrypted data to the already-created file (or directory)
2171  * corresponding to @dentry.
2172  *
2173  * The raw encrypted data is provided in ctx->data_buffer, and its size is
2174  * ctx->encrypted_size.
2175  *
2176  * This function may close the target directory, in which case the caller needs
2177  * to re-open it if needed.
2178  */
2179 static int
2180 extract_encrypted_file(const struct wim_dentry *dentry,
2181                        struct win32_apply_ctx *ctx)
2182 {
2183         void *rawctx;
2184         DWORD err;
2185         ULONG flags;
2186         bool retried;
2187
2188         /* Temporarily build a Win32 path for OpenEncryptedFileRaw()  */
2189         build_win32_extraction_path(dentry, ctx);
2190
2191         flags = CREATE_FOR_IMPORT | OVERWRITE_HIDDEN;
2192         if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
2193                 flags |= CREATE_FOR_DIR;
2194
2195         retried = false;
2196 retry:
2197         err = OpenEncryptedFileRaw(ctx->pathbuf.Buffer, flags, &rawctx);
2198         if (err == ERROR_SHARING_VIOLATION && !retried) {
2199                 /* This can be caused by the handle we have open to the target
2200                  * directory.  Try closing it temporarily.  */
2201                 close_target_directory(ctx);
2202                 retried = true;
2203                 goto retry;
2204         }
2205
2206         /* Restore the NT namespace path  */
2207         build_extraction_path(dentry, ctx);
2208
2209         if (err != ERROR_SUCCESS) {
2210                 win32_error(err, L"Can't open \"%ls\" for encrypted import",
2211                             current_path(ctx));
2212                 return WIMLIB_ERR_OPEN;
2213         }
2214
2215         ctx->encrypted_offset = 0;
2216
2217         err = WriteEncryptedFileRaw(import_encrypted_data, ctx, rawctx);
2218
2219         CloseEncryptedFileRaw(rawctx);
2220
2221         if (err != ERROR_SUCCESS) {
2222                 win32_error(err, L"Can't import encrypted file \"%ls\"",
2223                             current_path(ctx));
2224                 return WIMLIB_ERR_WRITE;
2225         }
2226
2227         return 0;
2228 }
2229
2230 /* Called when starting to read a blob for extraction on Windows  */
2231 static int
2232 begin_extract_blob(struct blob_descriptor *blob, void *_ctx)
2233 {
2234         struct win32_apply_ctx *ctx = _ctx;
2235         const struct blob_extraction_target *targets = blob_extraction_targets(blob);
2236         int ret;
2237
2238         ctx->num_open_handles = 0;
2239         ctx->data_buffer_ptr = NULL;
2240         INIT_LIST_HEAD(&ctx->reparse_dentries);
2241         INIT_LIST_HEAD(&ctx->encrypted_dentries);
2242
2243         for (u32 i = 0; i < blob->out_refcnt; i++) {
2244                 const struct wim_inode *inode = targets[i].inode;
2245                 const struct wim_inode_stream *strm = targets[i].stream;
2246                 struct wim_dentry *dentry;
2247
2248                 /* A copy of the blob needs to be extracted to @inode.  */
2249
2250                 if (ctx->common.supported_features.hard_links) {
2251                         dentry = inode_first_extraction_dentry(inode);
2252                         ret = begin_extract_blob_instance(blob, dentry, strm, ctx);
2253                         ret = check_apply_error(dentry, ctx, ret);
2254                         if (ret)
2255                                 goto fail;
2256                 } else {
2257                         /* Hard links not supported.  Extract the blob
2258                          * separately to each alias of the inode.  */
2259                         inode_for_each_extraction_alias(dentry, inode) {
2260                                 ret = begin_extract_blob_instance(blob, dentry, strm, ctx);
2261                                 ret = check_apply_error(dentry, ctx, ret);
2262                                 if (ret)
2263                                         goto fail;
2264                         }
2265                 }
2266         }
2267
2268         return 0;
2269
2270 fail:
2271         close_handles(ctx);
2272         return ret;
2273 }
2274
2275 /* Called when the next chunk of a blob has been read for extraction on Windows
2276  */
2277 static int
2278 extract_chunk(const void *chunk, size_t size, void *_ctx)
2279 {
2280         struct win32_apply_ctx *ctx = _ctx;
2281
2282         /* Write the data chunk to each open handle  */
2283         for (unsigned i = 0; i < ctx->num_open_handles; i++) {
2284                 u8 *bufptr = (u8 *)chunk;
2285                 size_t bytes_remaining = size;
2286                 NTSTATUS status;
2287                 while (bytes_remaining) {
2288                         ULONG count = min(0xFFFFFFFF, bytes_remaining);
2289
2290                         status = (*func_NtWriteFile)(ctx->open_handles[i],
2291                                                      NULL, NULL, NULL,
2292                                                      &ctx->iosb, bufptr, count,
2293                                                      NULL, NULL);
2294                         if (!NT_SUCCESS(status)) {
2295                                 winnt_error(status, L"Error writing data to target volume");
2296                                 return WIMLIB_ERR_WRITE;
2297                         }
2298                         bufptr += ctx->iosb.Information;
2299                         bytes_remaining -= ctx->iosb.Information;
2300                 }
2301         }
2302
2303         /* Copy the data chunk into the buffer (if needed)  */
2304         if (ctx->data_buffer_ptr)
2305                 ctx->data_buffer_ptr = mempcpy(ctx->data_buffer_ptr,
2306                                                chunk, size);
2307         return 0;
2308 }
2309
2310 static int
2311 get_system_compression_format(int extract_flags)
2312 {
2313         if (extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K)
2314                 return FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K;
2315
2316         if (extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K)
2317                 return FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS8K;
2318
2319         if (extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K)
2320                 return FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS16K;
2321
2322         return FILE_PROVIDER_COMPRESSION_FORMAT_LZX;
2323 }
2324
2325
2326 static const wchar_t *
2327 get_system_compression_format_string(int format)
2328 {
2329         switch (format) {
2330         case FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K:
2331                 return L"XPRESS4K";
2332         case FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS8K:
2333                 return L"XPRESS8K";
2334         case FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS16K:
2335                 return L"XPRESS16K";
2336         default:
2337                 return L"LZX";
2338         }
2339 }
2340
2341 static NTSTATUS
2342 set_system_compression(HANDLE h, int format)
2343 {
2344         NTSTATUS status;
2345         IO_STATUS_BLOCK iosb;
2346         struct {
2347                 struct wof_external_info wof_info;
2348                 struct file_provider_external_info file_info;
2349         } in = {
2350                 .wof_info = {
2351                         .version = WOF_CURRENT_VERSION,
2352                         .provider = WOF_PROVIDER_FILE,
2353                 },
2354                 .file_info = {
2355                         .version = FILE_PROVIDER_CURRENT_VERSION,
2356                         .compression_format = format,
2357                 },
2358         };
2359
2360         /* We intentionally use NtFsControlFile() rather than DeviceIoControl()
2361          * here because the "compressing this object would not save space"
2362          * status code does not map to a valid Win32 error code on older
2363          * versions of Windows (before Windows 10?).  This can be a problem if
2364          * the WOFADK driver is being used rather than the regular WOF, since
2365          * WOFADK can be used on older versions of Windows.  */
2366         status = (*func_NtFsControlFile)(h, NULL, NULL, NULL, &iosb,
2367                                          FSCTL_SET_EXTERNAL_BACKING,
2368                                          &in, sizeof(in), NULL, 0);
2369
2370         if (status == 0xC000046F) /* "Compressing this object would not save space."  */
2371                 return STATUS_SUCCESS;
2372
2373         return status;
2374 }
2375
2376 /* Hard-coded list of files which the Windows bootloader may need to access
2377  * before the WOF driver has been loaded.  */
2378 static wchar_t *bootloader_pattern_strings[] = {
2379         L"*winload.*",
2380         L"*winresume.*",
2381         L"\\Windows\\AppPatch\\drvmain.sdb",
2382         L"\\Windows\\Boot\\DVD\\*",
2383         L"\\Windows\\Boot\\EFI\\*",
2384         L"\\Windows\\bootstat.dat",
2385         L"\\Windows\\Fonts\\vgaoem.fon",
2386         L"\\Windows\\Fonts\\vgasys.fon",
2387         L"\\Windows\\INF\\errata.inf",
2388         L"\\Windows\\System32\\config\\*",
2389         L"\\Windows\\System32\\ntkrnlpa.exe",
2390         L"\\Windows\\System32\\ntoskrnl.exe",
2391         L"\\Windows\\System32\\bootvid.dll",
2392         L"\\Windows\\System32\\ci.dll",
2393         L"\\Windows\\System32\\hal*.dll",
2394         L"\\Windows\\System32\\mcupdate_AuthenticAMD.dll",
2395         L"\\Windows\\System32\\mcupdate_GenuineIntel.dll",
2396         L"\\Windows\\System32\\pshed.dll",
2397         L"\\Windows\\System32\\apisetschema.dll",
2398         L"\\Windows\\System32\\api-ms-win*.dll",
2399         L"\\Windows\\System32\\ext-ms-win*.dll",
2400         L"\\Windows\\System32\\KernelBase.dll",
2401         L"\\Windows\\System32\\drivers\\*.sys",
2402         L"\\Windows\\System32\\*.nls",
2403         L"\\Windows\\System32\\kbd*.dll",
2404         L"\\Windows\\System32\\kd*.dll",
2405         L"\\Windows\\System32\\clfs.sys",
2406         L"\\Windows\\System32\\CodeIntegrity\\driver.stl",
2407 };
2408
2409 static const struct string_set bootloader_patterns = {
2410         .strings = bootloader_pattern_strings,
2411         .num_strings = ARRAY_LEN(bootloader_pattern_strings),
2412 };
2413
2414 static NTSTATUS
2415 set_system_compression_on_inode(struct wim_inode *inode, int format,
2416                                 struct win32_apply_ctx *ctx)
2417 {
2418         bool retried = false;
2419         NTSTATUS status;
2420         HANDLE h;
2421
2422         /* If it may be needed for compatibility with the Windows bootloader,
2423          * force this file to XPRESS4K or uncompressed format.  The bootloader
2424          * of Windows 10 supports XPRESS4K only; older versions don't support
2425          * system compression at all.  */
2426         if (!is_image_windows_10_or_later(ctx) ||
2427             format != FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K)
2428         {
2429                 /* We need to check the patterns against every name of the
2430                  * inode, in case any of them match.  */
2431                 struct wim_dentry *dentry;
2432                 inode_for_each_extraction_alias(dentry, inode) {
2433                         bool incompatible;
2434                         bool warned;
2435
2436                         if (calculate_dentry_full_path(dentry)) {
2437                                 ERROR("Unable to compute file path!");
2438                                 return STATUS_NO_MEMORY;
2439                         }
2440
2441                         incompatible = match_pattern_list(dentry->d_full_path,
2442                                                           &bootloader_patterns);
2443                         FREE(dentry->d_full_path);
2444                         dentry->d_full_path = NULL;
2445
2446                         if (!incompatible)
2447                                 continue;
2448
2449                         warned = (ctx->num_system_compression_exclusions++ > 0);
2450
2451                         if (is_image_windows_10_or_later(ctx)) {
2452                                 /* Force to XPRESS4K  */
2453                                 if (!warned) {
2454                                         WARNING("For compatibility with the "
2455                                                 "Windows bootloader, some "
2456                                                 "files are being\n"
2457                                                 "          compacted "
2458                                                 "using the XPRESS4K format "
2459                                                 "instead of the %"TS" format\n"
2460                                                 "          you requested.",
2461                                                 get_system_compression_format_string(format));
2462                                 }
2463                                 format = FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K;
2464                                 break;
2465                         } else {
2466                                 /* Force to uncompressed  */
2467                                 if (!warned) {
2468                                         WARNING("For compatibility with the "
2469                                                 "Windows bootloader, some "
2470                                                 "files will not\n"
2471                                                 "          be compressed with"
2472                                                 " system compression "
2473                                                 "(\"compacted\").");
2474                                 }
2475                                 return STATUS_SUCCESS;
2476                         }
2477
2478                 }
2479         }
2480
2481         /* Open the extracted file.  */
2482         status = create_file(&h, GENERIC_READ | GENERIC_WRITE, NULL,
2483                              0, FILE_OPEN, 0,
2484                              inode_first_extraction_dentry(inode), ctx);
2485
2486         if (!NT_SUCCESS(status))
2487                 return status;
2488 retry:
2489         /* Compress the file.  If the attempt fails with "invalid device
2490          * request", then attach wof.sys (or wofadk.sys) and retry.  */
2491         status = set_system_compression(h, format);
2492         if (unlikely(status == STATUS_INVALID_DEVICE_REQUEST && !retried)) {
2493                 wchar_t drive_path[7];
2494                 if (!win32_get_drive_path(ctx->common.target, drive_path) &&
2495                     win32_try_to_attach_wof(drive_path + 4)) {
2496                         retried = true;
2497                         goto retry;
2498                 }
2499         }
2500
2501         (*func_NtClose)(h);
2502         return status;
2503 }
2504
2505 /*
2506  * This function is called when doing a "compact-mode" extraction and we just
2507  * finished extracting a blob to one or more locations.  For each location that
2508  * was the unnamed data stream of a file, this function compresses the
2509  * corresponding file using System Compression, if allowed.
2510  *
2511  * Note: we're doing the compression immediately after extracting the data
2512  * rather than during a separate compression pass.  This way should be faster
2513  * since the operating system should still have the file's data cached.
2514  *
2515  * Note: we're having the operating system do the compression, which is not
2516  * ideal because wimlib could create the compressed data faster and more
2517  * efficiently (the compressed data format is identical to a WIM resource).  But
2518  * we seemingly don't have a choice because WOF prevents applications from
2519  * creating its reparse points.
2520  */
2521 static void
2522 handle_system_compression(struct blob_descriptor *blob, struct win32_apply_ctx *ctx)
2523 {
2524         const struct blob_extraction_target *targets = blob_extraction_targets(blob);
2525
2526         const int format = get_system_compression_format(ctx->common.extract_flags);
2527
2528         for (u32 i = 0; i < blob->out_refcnt; i++) {
2529                 struct wim_inode *inode = targets[i].inode;
2530                 struct wim_inode_stream *strm = targets[i].stream;
2531                 NTSTATUS status;
2532
2533                 if (!stream_is_unnamed_data_stream(strm))
2534                         continue;
2535
2536                 if (will_externally_back_inode(inode, ctx, NULL, false) != 0)
2537                         continue;
2538
2539                 status = set_system_compression_on_inode(inode, format, ctx);
2540                 if (likely(NT_SUCCESS(status)))
2541                         continue;
2542
2543                 if (status == STATUS_INVALID_DEVICE_REQUEST) {
2544                         WARNING(
2545           "The request to compress the extracted files using System Compression\n"
2546 "          will not be honored because the operating system or target volume\n"
2547 "          does not support it.  System Compression is only supported on\n"
2548 "          Windows 10 and later, and only on NTFS volumes.");
2549                         ctx->common.extract_flags &= ~COMPACT_FLAGS;
2550                         return;
2551                 }
2552
2553                 ctx->num_system_compression_failures++;
2554                 if (ctx->num_system_compression_failures < 10) {
2555                         winnt_warning(status, L"\"%ls\": Failed to compress "
2556                                       "extracted file using System Compression",
2557                                       current_path(ctx));
2558                 } else if (ctx->num_system_compression_failures == 10) {
2559                         WARNING("Suppressing further warnings about "
2560                                 "System Compression failures.");
2561                 }
2562         }
2563 }
2564
2565 /* Called when a blob has been fully read for extraction on Windows  */
2566 static int
2567 end_extract_blob(struct blob_descriptor *blob, int status, void *_ctx)
2568 {
2569         struct win32_apply_ctx *ctx = _ctx;
2570         int ret;
2571         const struct wim_dentry *dentry;
2572
2573         close_handles(ctx);
2574
2575         if (status)
2576                 return status;
2577
2578         if (unlikely(ctx->common.extract_flags & COMPACT_FLAGS))
2579                 handle_system_compression(blob, ctx);
2580
2581         if (likely(!ctx->data_buffer_ptr))
2582                 return 0;
2583
2584         if (!list_empty(&ctx->reparse_dentries)) {
2585                 if (blob->size > REPARSE_DATA_MAX_SIZE) {
2586                         dentry = list_first_entry(&ctx->reparse_dentries,
2587                                                   struct wim_dentry, d_tmp_list);
2588                         build_extraction_path(dentry, ctx);
2589                         ERROR("Reparse data of \"%ls\" has size "
2590                               "%"PRIu64" bytes (exceeds %u bytes)",
2591                               current_path(ctx), blob->size,
2592                               REPARSE_DATA_MAX_SIZE);
2593                         ret = WIMLIB_ERR_INVALID_REPARSE_DATA;
2594                         return check_apply_error(dentry, ctx, ret);
2595                 }
2596                 /* Reparse data  */
2597                 memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, blob->size);
2598
2599                 list_for_each_entry(dentry, &ctx->reparse_dentries, d_tmp_list) {
2600
2601                         /* Reparse point header  */
2602                         complete_reparse_point(&ctx->rpbuf, dentry->d_inode,
2603                                                blob->size);
2604
2605                         ret = set_reparse_point(dentry, &ctx->rpbuf,
2606                                                 REPARSE_DATA_OFFSET + blob->size,
2607                                                 ctx);
2608                         ret = check_apply_error(dentry, ctx, ret);
2609                         if (ret)
2610                                 return ret;
2611                 }
2612         }
2613
2614         if (!list_empty(&ctx->encrypted_dentries)) {
2615                 ctx->encrypted_size = blob->size;
2616                 list_for_each_entry(dentry, &ctx->encrypted_dentries, d_tmp_list) {
2617                         ret = extract_encrypted_file(dentry, ctx);
2618                         ret = check_apply_error(dentry, ctx, ret);
2619                         if (ret)
2620                                 return ret;
2621                         /* Re-open the target directory if needed.  */
2622                         ret = open_target_directory(ctx);
2623                         if (ret)
2624                                 return ret;
2625                 }
2626         }
2627
2628         return 0;
2629 }
2630
2631 /* Attributes that can't be set directly  */
2632 #define SPECIAL_ATTRIBUTES                      \
2633         (FILE_ATTRIBUTE_REPARSE_POINT   |       \
2634          FILE_ATTRIBUTE_DIRECTORY       |       \
2635          FILE_ATTRIBUTE_ENCRYPTED       |       \
2636          FILE_ATTRIBUTE_SPARSE_FILE     |       \
2637          FILE_ATTRIBUTE_COMPRESSED)
2638
2639 /* Set the security descriptor @desc, of @desc_size bytes, on the file with open
2640  * handle @h.  */
2641 static NTSTATUS
2642 set_security_descriptor(HANDLE h, const void *_desc,
2643                         size_t desc_size, struct win32_apply_ctx *ctx)
2644 {
2645         SECURITY_INFORMATION info;
2646         NTSTATUS status;
2647         SECURITY_DESCRIPTOR_RELATIVE *desc;
2648
2649         /*
2650          * Ideally, we would just pass in the security descriptor buffer as-is.
2651          * But it turns out that Windows can mess up the security descriptor
2652          * even when using the low-level NtSetSecurityObject() function:
2653          *
2654          * - Windows will clear SE_DACL_AUTO_INHERITED if it is set in the
2655          *   passed buffer.  To actually get Windows to set
2656          *   SE_DACL_AUTO_INHERITED, the application must set the non-persistent
2657          *   flag SE_DACL_AUTO_INHERIT_REQ.  As usual, Microsoft didn't bother
2658          *   to properly document either of these flags.  It's unclear how
2659          *   important SE_DACL_AUTO_INHERITED actually is, but to be safe we use
2660          *   the SE_DACL_AUTO_INHERIT_REQ workaround to set it if needed.
2661          *
2662          * - The above also applies to the equivalent SACL flags,
2663          *   SE_SACL_AUTO_INHERITED and SE_SACL_AUTO_INHERIT_REQ.
2664          *
2665          * - If the application says that it's setting
2666          *   DACL_SECURITY_INFORMATION, then Windows sets SE_DACL_PRESENT in the
2667          *   resulting security descriptor, even if the security descriptor the
2668          *   application provided did not have a DACL.  This seems to be
2669          *   unavoidable, since omitting DACL_SECURITY_INFORMATION would cause a
2670          *   default DACL to remain.  Fortunately, this behavior seems harmless,
2671          *   since the resulting DACL will still be "null" --- but it will be
2672          *   "the other representation of null".
2673          *
2674          * - The above also applies to SACL_SECURITY_INFORMATION and
2675          *   SE_SACL_PRESENT.  Again, it's seemingly unavoidable but "harmless"
2676          *   that Windows changes the representation of a "null SACL".
2677          */
2678         if (likely(desc_size <= STACK_MAX)) {
2679                 desc = alloca(desc_size);
2680         } else {
2681                 desc = MALLOC(desc_size);
2682                 if (!desc)
2683                         return STATUS_NO_MEMORY;
2684         }
2685
2686         memcpy(desc, _desc, desc_size);
2687
2688         if (likely(desc_size >= 4)) {
2689
2690                 if (desc->Control & SE_DACL_AUTO_INHERITED)
2691                         desc->Control |= SE_DACL_AUTO_INHERIT_REQ;
2692
2693                 if (desc->Control & SE_SACL_AUTO_INHERITED)
2694                         desc->Control |= SE_SACL_AUTO_INHERIT_REQ;
2695         }
2696
2697         /*
2698          * More API insanity.  We want to set the entire security descriptor
2699          * as-is.  But all available APIs require specifying the specific parts
2700          * of the security descriptor being set.  Especially annoying is that
2701          * mandatory integrity labels are part of the SACL, but they aren't set
2702          * with SACL_SECURITY_INFORMATION.  Instead, applications must also
2703          * specify LABEL_SECURITY_INFORMATION (Windows Vista, Windows 7) or
2704          * BACKUP_SECURITY_INFORMATION (Windows 8).  But at least older versions
2705          * of Windows don't error out if you provide these newer flags...
2706          *
2707          * Also, if the process isn't running as Administrator, then it probably
2708          * doesn't have SE_RESTORE_PRIVILEGE.  In this case, it will always get
2709          * the STATUS_PRIVILEGE_NOT_HELD error by trying to set the SACL, even
2710          * if the security descriptor it provided did not have a SACL.  By
2711          * default, in this case we try to recover and set as much of the
2712          * security descriptor as possible --- potentially excluding the DACL, and
2713          * even the owner, as well as the SACL.
2714          */
2715
2716         info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
2717                DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION |
2718                LABEL_SECURITY_INFORMATION | BACKUP_SECURITY_INFORMATION;
2719
2720
2721         /*
2722          * It's also worth noting that SetFileSecurity() is unusable because it
2723          * doesn't request "backup semantics" when it opens the file internally.
2724          * NtSetSecurityObject() seems to be the best function to use in backup
2725          * applications.  (SetSecurityInfo() should also work, but it's harder
2726          * to use and must call NtSetSecurityObject() internally anyway.
2727          * BackupWrite() is theoretically usable as well, but it's inflexible
2728          * and poorly documented.)
2729          */
2730
2731 retry:
2732         status = (*func_NtSetSecurityObject)(h, info, desc);
2733         if (NT_SUCCESS(status))
2734                 goto out_maybe_free_desc;
2735
2736         /* Failed to set the requested parts of the security descriptor.  If the
2737          * error was permissions-related, try to set fewer parts of the security
2738          * descriptor, unless WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled.  */
2739         if ((status == STATUS_PRIVILEGE_NOT_HELD ||
2740              status == STATUS_ACCESS_DENIED) &&
2741             !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2742         {
2743                 if (info & SACL_SECURITY_INFORMATION) {
2744                         info &= ~(SACL_SECURITY_INFORMATION |
2745                                   LABEL_SECURITY_INFORMATION |
2746                                   BACKUP_SECURITY_INFORMATION);
2747                         ctx->partial_security_descriptors++;
2748                         goto retry;
2749                 }
2750                 if (info & DACL_SECURITY_INFORMATION) {
2751                         info &= ~DACL_SECURITY_INFORMATION;
2752                         goto retry;
2753                 }
2754                 if (info & OWNER_SECURITY_INFORMATION) {
2755                         info &= ~OWNER_SECURITY_INFORMATION;
2756                         goto retry;
2757                 }
2758                 /* Nothing left except GROUP, and if we removed it we
2759                  * wouldn't have anything at all.  */
2760         }
2761
2762         /* No part of the security descriptor could be set, or
2763          * WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled and the full security
2764          * descriptor could not be set.  */
2765         if (!(info & SACL_SECURITY_INFORMATION))
2766                 ctx->partial_security_descriptors--;
2767         ctx->no_security_descriptors++;
2768
2769 out_maybe_free_desc:
2770         if (unlikely(desc_size > STACK_MAX))
2771                 FREE(desc);
2772         return status;
2773 }
2774
2775 /* Set metadata on the open file @h from the WIM inode @inode.  */
2776 static int
2777 do_apply_metadata_to_file(HANDLE h, const struct wim_inode *inode,
2778                           struct win32_apply_ctx *ctx)
2779 {
2780         FILE_BASIC_INFORMATION info;
2781         NTSTATUS status;
2782
2783         /* Set security descriptor if present and not in NO_ACLS mode  */
2784         if (inode_has_security_descriptor(inode) &&
2785             !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
2786         {
2787                 const struct wim_security_data *sd;
2788                 const void *desc;
2789                 size_t desc_size;
2790
2791                 sd = wim_get_current_security_data(ctx->common.wim);
2792                 desc = sd->descriptors[inode->i_security_id];
2793                 desc_size = sd->sizes[inode->i_security_id];
2794
2795                 status = set_security_descriptor(h, desc, desc_size, ctx);
2796                 if (!NT_SUCCESS(status) &&
2797                     (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2798                 {
2799                         winnt_error(status,
2800                                     L"Can't set security descriptor on \"%ls\"",
2801                                     current_path(ctx));
2802                         return WIMLIB_ERR_SET_SECURITY;
2803                 }
2804         }
2805
2806         /* Set attributes and timestamps  */
2807         info.CreationTime.QuadPart = inode->i_creation_time;
2808         info.LastAccessTime.QuadPart = inode->i_last_access_time;
2809         info.LastWriteTime.QuadPart = inode->i_last_write_time;
2810         info.ChangeTime.QuadPart = 0;
2811         if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) {
2812                 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
2813         } else {
2814                 info.FileAttributes = inode->i_attributes & ~SPECIAL_ATTRIBUTES;
2815                 if (info.FileAttributes == 0)
2816                         info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
2817         }
2818
2819         status = (*func_NtSetInformationFile)(h, &ctx->iosb,
2820                                               &info, sizeof(info),
2821                                               FileBasicInformation);
2822         /* On FAT volumes we get STATUS_INVALID_PARAMETER if we try to set
2823          * attributes on the root directory.  (Apparently because FAT doesn't
2824          * actually have a place to store those attributes!)  */
2825         if (!NT_SUCCESS(status)
2826             && !(status == STATUS_INVALID_PARAMETER &&
2827                  dentry_is_root(inode_first_extraction_dentry(inode))))
2828         {
2829                 winnt_error(status, L"Can't set basic metadata on \"%ls\"",
2830                             current_path(ctx));
2831                 return WIMLIB_ERR_SET_ATTRIBUTES;
2832         }
2833
2834         return 0;
2835 }
2836
2837 static int
2838 apply_metadata_to_file(const struct wim_dentry *dentry,
2839                        struct win32_apply_ctx *ctx)
2840 {
2841         const struct wim_inode *inode = dentry->d_inode;
2842         DWORD perms;
2843         HANDLE h;
2844         NTSTATUS status;
2845         int ret;
2846
2847         perms = FILE_WRITE_ATTRIBUTES | WRITE_DAC |
2848                 WRITE_OWNER | ACCESS_SYSTEM_SECURITY;
2849
2850         build_extraction_path(dentry, ctx);
2851
2852         /* Open a handle with as many relevant permissions as possible.  */
2853         while (!NT_SUCCESS(status = do_create_file(&h, perms, NULL,
2854                                                    0, FILE_OPEN, 0, ctx)))
2855         {
2856                 if (status == STATUS_PRIVILEGE_NOT_HELD ||
2857                     status == STATUS_ACCESS_DENIED)
2858                 {
2859                         if (perms & ACCESS_SYSTEM_SECURITY) {
2860                                 perms &= ~ACCESS_SYSTEM_SECURITY;
2861                                 continue;
2862                         }
2863                         if (perms & WRITE_DAC) {
2864                                 perms &= ~WRITE_DAC;
2865                                 continue;
2866                         }
2867                         if (perms & WRITE_OWNER) {
2868                                 perms &= ~WRITE_OWNER;
2869                                 continue;
2870                         }
2871                 }
2872                 winnt_error(status, L"Can't open \"%ls\" to set metadata",
2873                             current_path(ctx));
2874                 return WIMLIB_ERR_OPEN;
2875         }
2876
2877         ret = do_apply_metadata_to_file(h, inode, ctx);
2878
2879         (*func_NtClose)(h);
2880
2881         return ret;
2882 }
2883
2884 static int
2885 apply_metadata(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
2886 {
2887         const struct wim_dentry *dentry;
2888         int ret;
2889
2890         /* We go in reverse so that metadata is set on all a directory's
2891          * children before the directory itself.  This avoids any potential
2892          * problems with attributes, timestamps, or security descriptors.  */
2893         list_for_each_entry_reverse(dentry, dentry_list, d_extraction_list_node)
2894         {
2895                 ret = apply_metadata_to_file(dentry, ctx);
2896                 ret = check_apply_error(dentry, ctx, ret);
2897                 if (ret)
2898                         return ret;
2899                 ret = report_file_metadata_applied(&ctx->common);
2900                 if (ret)
2901                         return ret;
2902         }
2903         return 0;
2904 }
2905
2906 /* Issue warnings about problems during the extraction for which warnings were
2907  * not already issued (due to the high number of potential warnings if we issued
2908  * them per-file).  */
2909 static void
2910 do_warnings(const struct win32_apply_ctx *ctx)
2911 {
2912         if (ctx->partial_security_descriptors == 0
2913             && ctx->no_security_descriptors == 0
2914             && ctx->num_set_short_name_failures == 0
2915         #if 0
2916             && ctx->num_remove_short_name_failures == 0
2917         #endif
2918             )
2919                 return;
2920
2921         WARNING("Extraction to \"%ls\" complete, but with one or more warnings:",
2922                 ctx->common.target);
2923         if (ctx->num_set_short_name_failures) {
2924                 WARNING("- Could not set short names on %lu files or directories",
2925                         ctx->num_set_short_name_failures);
2926         }
2927 #if 0
2928         if (ctx->num_remove_short_name_failures) {
2929                 WARNING("- Could not remove short names on %lu files or directories"
2930                         "          (This is expected on Vista and earlier)",
2931                         ctx->num_remove_short_name_failures);
2932         }
2933 #endif
2934         if (ctx->partial_security_descriptors) {
2935                 WARNING("- Could only partially set the security descriptor\n"
2936                         "            on %lu files or directories.",
2937                         ctx->partial_security_descriptors);
2938         }
2939         if (ctx->no_security_descriptors) {
2940                 WARNING("- Could not set security descriptor at all\n"
2941                         "            on %lu files or directories.",
2942                         ctx->no_security_descriptors);
2943         }
2944         if (ctx->partial_security_descriptors || ctx->no_security_descriptors) {
2945                 WARNING("To fully restore all security descriptors, run the program\n"
2946                         "          with Administrator rights.");
2947         }
2948 }
2949
2950 static u64
2951 count_dentries(const struct list_head *dentry_list)
2952 {
2953         const struct list_head *cur;
2954         u64 count = 0;
2955
2956         list_for_each(cur, dentry_list)
2957                 count++;
2958
2959         return count;
2960 }
2961
2962 /* Extract files from a WIM image to a directory on Windows  */
2963 static int
2964 win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
2965 {
2966         int ret;
2967         struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
2968         u64 dentry_count;
2969
2970         ret = prepare_target(dentry_list, ctx);
2971         if (ret)
2972                 goto out;
2973
2974         if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2975                 ret = start_wimboot_extraction(dentry_list, ctx);
2976                 if (ret)
2977                         goto out;
2978         }
2979
2980         ctx->windows_build_number = xml_get_windows_build_number(ctx->common.wim->xml_info,
2981                                                                  ctx->common.wim->current_image);
2982
2983         dentry_count = count_dentries(dentry_list);
2984
2985         ret = start_file_structure_phase(&ctx->common, dentry_count);
2986         if (ret)
2987                 goto out;
2988
2989         ret = create_directories(dentry_list, ctx);
2990         if (ret)
2991                 goto out;
2992
2993         ret = create_nondirectories(dentry_list, ctx);
2994         if (ret)
2995                 goto out;
2996
2997         ret = end_file_structure_phase(&ctx->common);
2998         if (ret)
2999                 goto out;
3000
3001         struct read_blob_callbacks cbs = {
3002                 .begin_blob     = begin_extract_blob,
3003                 .consume_chunk  = extract_chunk,
3004                 .end_blob       = end_extract_blob,
3005                 .ctx            = ctx,
3006         };
3007         ret = extract_blob_list(&ctx->common, &cbs);
3008         if (ret)
3009                 goto out;
3010
3011         ret = start_file_metadata_phase(&ctx->common, dentry_count);
3012         if (ret)
3013                 goto out;
3014
3015         ret = apply_metadata(dentry_list, ctx);
3016         if (ret)
3017                 goto out;
3018
3019         ret = end_file_metadata_phase(&ctx->common);
3020         if (ret)
3021                 goto out;
3022
3023         if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
3024                 ret = end_wimboot_extraction(ctx);
3025                 if (ret)
3026                         goto out;
3027         }
3028
3029         do_warnings(ctx);
3030 out:
3031         close_target_directory(ctx);
3032         if (ctx->target_ntpath.Buffer)
3033                 HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
3034         FREE(ctx->pathbuf.Buffer);
3035         FREE(ctx->print_buffer);
3036         FREE(ctx->wimboot.wims);
3037         if (ctx->prepopulate_pats) {
3038                 FREE(ctx->prepopulate_pats->strings);
3039                 FREE(ctx->prepopulate_pats);
3040         }
3041         FREE(ctx->mem_prepopulate_pats);
3042         FREE(ctx->data_buffer);
3043         return ret;
3044 }
3045
3046 const struct apply_operations win32_apply_ops = {
3047         .name                   = "Windows",
3048         .get_supported_features = win32_get_supported_features,
3049         .extract                = win32_extract,
3050         .will_back_from_wim     = win32_will_back_from_wim,
3051         .context_size           = sizeof(struct win32_apply_ctx),
3052 };
3053
3054 #endif /* __WIN32__ */