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