cb488a9f6ed656013b74b67cacbf74b6c63914af
[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 (!xml_get_wimboot(ctx->common.wim->xml_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                 if (d->d_extraction_name_nchars)
905                         wmemcpy(p, d->d_extraction_name,
906                                 d->d_extraction_name_nchars);
907                 *--p = '\\';
908         }
909         /* No leading slash  */
910         p -= d->d_extraction_name_nchars;
911         wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
912 }
913
914 /* Build the path at which to extract the @dentry, relative to the target
915  * directory, adding the suffix for a named data stream.
916  *
917  * The path is saved in ctx->pathbuf.  */
918 static void
919 build_extraction_path_with_ads(const struct wim_dentry *dentry,
920                                struct win32_apply_ctx *ctx,
921                                const wchar_t *stream_name,
922                                size_t stream_name_nchars)
923 {
924         wchar_t *p;
925
926         build_extraction_path(dentry, ctx);
927
928         /* Add :NAME for named data stream  */
929         p = ctx->pathbuf.Buffer + (ctx->pathbuf.Length / sizeof(wchar_t));
930         *p++ = L':';
931         wmemcpy(p, stream_name, stream_name_nchars);
932         ctx->pathbuf.Length += (1 + stream_name_nchars) * sizeof(wchar_t);
933 }
934
935 /* Build the Win32 namespace path to the specified @dentry when extracted.
936  *
937  * The path is saved in ctx->pathbuf and will be null terminated.
938  *
939  * XXX: We could get rid of this if it wasn't needed for the file encryption
940  * APIs, and the registry manipulation in WIMBoot mode.  */
941 static void
942 build_win32_extraction_path(const struct wim_dentry *dentry,
943                             struct win32_apply_ctx *ctx)
944 {
945         build_extraction_path(dentry, ctx);
946
947         /* Prepend target_ntpath to our relative path, then change \??\ into \\?\  */
948
949         memmove(ctx->pathbuf.Buffer +
950                         (ctx->target_ntpath.Length / sizeof(wchar_t)) + 1,
951                 ctx->pathbuf.Buffer, ctx->pathbuf.Length);
952         memcpy(ctx->pathbuf.Buffer, ctx->target_ntpath.Buffer,
953                 ctx->target_ntpath.Length);
954         ctx->pathbuf.Buffer[ctx->target_ntpath.Length / sizeof(wchar_t)] = L'\\';
955         ctx->pathbuf.Length += ctx->target_ntpath.Length + sizeof(wchar_t);
956         ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)] = L'\0';
957
958         wimlib_assert(ctx->pathbuf.Length >= 4 * sizeof(wchar_t) &&
959                       !wmemcmp(ctx->pathbuf.Buffer, L"\\??\\", 4));
960
961         ctx->pathbuf.Buffer[1] = L'\\';
962
963 }
964
965 /* Returns a "printable" representation of the last relative NT path that was
966  * constructed with build_extraction_path() or build_extraction_path_with_ads().
967  *
968  * This will be overwritten by the next call to this function.  */
969 static const wchar_t *
970 current_path(struct win32_apply_ctx *ctx)
971 {
972         wchar_t *p = ctx->print_buffer;
973
974         p = wmempcpy(p, ctx->common.target, ctx->common.target_nchars);
975         *p++ = L'\\';
976         p = wmempcpy(p, ctx->pathbuf.Buffer, ctx->pathbuf.Length / sizeof(wchar_t));
977         *p = L'\0';
978         return ctx->print_buffer;
979 }
980
981 /* Open handle to the target directory if it is not already open.  If the target
982  * directory does not exist, this creates it.  */
983 static int
984 open_target_directory(struct win32_apply_ctx *ctx)
985 {
986         NTSTATUS status;
987
988         if (ctx->h_target)
989                 return 0;
990
991         ctx->attr.Length = sizeof(ctx->attr);
992         ctx->attr.RootDirectory = NULL;
993         ctx->attr.ObjectName = &ctx->target_ntpath;
994
995         /* Don't use FILE_OPEN_REPARSE_POINT here; we want the extraction to
996          * happen at the directory "pointed to" by the reparse point. */
997         status = (*func_NtCreateFile)(&ctx->h_target,
998                                       FILE_TRAVERSE,
999                                       &ctx->attr,
1000                                       &ctx->iosb,
1001                                       NULL,
1002                                       0,
1003                                       FILE_SHARE_VALID_FLAGS,
1004                                       FILE_OPEN_IF,
1005                                       FILE_DIRECTORY_FILE |
1006                                               FILE_OPEN_FOR_BACKUP_INTENT,
1007                                       NULL,
1008                                       0);
1009         if (!NT_SUCCESS(status)) {
1010                 winnt_error(status, L"Can't open or create directory \"%ls\"",
1011                             ctx->common.target);
1012                 return WIMLIB_ERR_OPENDIR;
1013         }
1014         ctx->attr.RootDirectory = ctx->h_target;
1015         ctx->attr.ObjectName = &ctx->pathbuf;
1016         return 0;
1017 }
1018
1019 static void
1020 close_target_directory(struct win32_apply_ctx *ctx)
1021 {
1022         if (ctx->h_target) {
1023                 (*func_NtClose)(ctx->h_target);
1024                 ctx->h_target = NULL;
1025                 ctx->attr.RootDirectory = NULL;
1026         }
1027 }
1028
1029 /*
1030  * Ensures the target directory exists and opens a handle to it, in preparation
1031  * of using paths relative to it.
1032  */
1033 static int
1034 prepare_target(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1035 {
1036         int ret;
1037         size_t path_max;
1038
1039         ret = win32_path_to_nt_path(ctx->common.target, &ctx->target_ntpath);
1040         if (ret)
1041                 return ret;
1042
1043         ret = open_target_directory(ctx);
1044         if (ret)
1045                 return ret;
1046
1047         path_max = compute_path_max(dentry_list);
1048         /* Add some extra for building Win32 paths for the file encryption APIs,
1049          * and ensure we have at least enough to potentially use a 8.3 name for
1050          * the last component.  */
1051         path_max += max(2 + (ctx->target_ntpath.Length / sizeof(wchar_t)),
1052                         8 + 1 + 3);
1053
1054         ctx->pathbuf.MaximumLength = path_max * sizeof(wchar_t);
1055         ctx->pathbuf.Buffer = MALLOC(ctx->pathbuf.MaximumLength);
1056         if (!ctx->pathbuf.Buffer)
1057                 return WIMLIB_ERR_NOMEM;
1058
1059         ctx->print_buffer = MALLOC((ctx->common.target_nchars + 1 + path_max + 1) *
1060                                    sizeof(wchar_t));
1061         if (!ctx->print_buffer)
1062                 return WIMLIB_ERR_NOMEM;
1063
1064         return 0;
1065 }
1066
1067 /* When creating an inode that will have a short (DOS) name, we create it using
1068  * the long name associated with the short name.  This ensures that the short
1069  * name gets associated with the correct long name.  */
1070 static struct wim_dentry *
1071 first_extraction_alias(const struct wim_inode *inode)
1072 {
1073         struct wim_dentry *dentry;
1074
1075         inode_for_each_extraction_alias(dentry, inode)
1076                 if (dentry_has_short_name(dentry))
1077                         return dentry;
1078         return inode_first_extraction_dentry(inode);
1079 }
1080
1081 /*
1082  * Set or clear FILE_ATTRIBUTE_COMPRESSED if the inherited value is different
1083  * from the desired value.
1084  *
1085  * Note that you can NOT override the inherited value of
1086  * FILE_ATTRIBUTE_COMPRESSED directly with NtCreateFile().
1087  */
1088 static int
1089 adjust_compression_attribute(HANDLE h, const struct wim_dentry *dentry,
1090                              struct win32_apply_ctx *ctx)
1091 {
1092         const bool compressed = (dentry->d_inode->i_attributes &
1093                                  FILE_ATTRIBUTE_COMPRESSED);
1094
1095         if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
1096                 return 0;
1097
1098         if (!ctx->common.supported_features.compressed_files)
1099                 return 0;
1100
1101         FILE_BASIC_INFORMATION info;
1102         NTSTATUS status;
1103         USHORT compression_state;
1104         DWORD bytes_returned;
1105
1106         /* Get current attributes  */
1107         status = (*func_NtQueryInformationFile)(h, &ctx->iosb,
1108                                                 &info, sizeof(info),
1109                                                 FileBasicInformation);
1110         if (NT_SUCCESS(status) &&
1111             compressed == !!(info.FileAttributes & FILE_ATTRIBUTE_COMPRESSED))
1112         {
1113                 /* Nothing needs to be done.  */
1114                 return 0;
1115         }
1116
1117         /* Set the new compression state  */
1118
1119         if (compressed)
1120                 compression_state = COMPRESSION_FORMAT_DEFAULT;
1121         else
1122                 compression_state = COMPRESSION_FORMAT_NONE;
1123
1124         /* Note: don't use NtFsControlFile() here unless prepared to handle
1125          * STATUS_PENDING.  */
1126         if (DeviceIoControl(h, FSCTL_SET_COMPRESSION,
1127                             &compression_state, sizeof(USHORT), NULL, 0,
1128                             &bytes_returned, NULL))
1129                 return 0;
1130
1131         win32_error(GetLastError(), L"Can't %s compression attribute on \"%ls\"",
1132                     (compressed ? "set" : "clear"), current_path(ctx));
1133         return WIMLIB_ERR_SET_ATTRIBUTES;
1134 }
1135
1136 /* Try to enable short name support on the target volume.  If successful, return
1137  * true.  If unsuccessful, issue a warning and return false.  */
1138 static bool
1139 try_to_enable_short_names(const wchar_t *volume)
1140 {
1141         HANDLE h;
1142         FILE_FS_PERSISTENT_VOLUME_INFORMATION info;
1143         BOOL bret;
1144         DWORD bytesReturned;
1145
1146         h = CreateFile(volume, GENERIC_WRITE,
1147                        FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
1148                        FILE_FLAG_BACKUP_SEMANTICS, NULL);
1149         if (h == INVALID_HANDLE_VALUE)
1150                 goto fail;
1151
1152         info.VolumeFlags = 0;
1153         info.FlagMask = PERSISTENT_VOLUME_STATE_SHORT_NAME_CREATION_DISABLED;
1154         info.Version = 1;
1155         info.Reserved = 0;
1156
1157         bret = DeviceIoControl(h, FSCTL_SET_PERSISTENT_VOLUME_STATE,
1158                                &info, sizeof(info), NULL, 0,
1159                                &bytesReturned, NULL);
1160
1161         CloseHandle(h);
1162
1163         if (!bret)
1164                 goto fail;
1165         return true;
1166
1167 fail:
1168         win32_warning(GetLastError(),
1169                       L"Failed to enable short name support on %ls",
1170                       volume + 4);
1171         return false;
1172 }
1173
1174 static NTSTATUS
1175 remove_conflicting_short_name(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
1176 {
1177         wchar_t *name;
1178         wchar_t *end;
1179         NTSTATUS status;
1180         HANDLE h;
1181         size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1182                          (13 * sizeof(wchar_t));
1183         u8 buf[bufsize] _aligned_attribute(8);
1184         bool retried = false;
1185         FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1186
1187         memset(buf, 0, bufsize);
1188
1189         /* Build the path with the short name.  */
1190         name = &ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)];
1191         while (name != ctx->pathbuf.Buffer && *(name - 1) != L'\\')
1192                 name--;
1193         end = mempcpy(name, dentry->d_short_name, dentry->d_short_name_nbytes);
1194         ctx->pathbuf.Length = ((u8 *)end - (u8 *)ctx->pathbuf.Buffer);
1195
1196         /* Open the conflicting file (by short name).  */
1197         status = (*func_NtOpenFile)(&h, GENERIC_WRITE | DELETE,
1198                                     &ctx->attr, &ctx->iosb,
1199                                     FILE_SHARE_VALID_FLAGS,
1200                                     FILE_OPEN_REPARSE_POINT | FILE_OPEN_FOR_BACKUP_INTENT);
1201         if (!NT_SUCCESS(status)) {
1202                 winnt_warning(status, L"Can't open \"%ls\"", current_path(ctx));
1203                 goto out;
1204         }
1205
1206 #if 0
1207         WARNING("Overriding conflicting short name; path=\"%ls\"",
1208                 current_path(ctx));
1209 #endif
1210
1211         /* Try to remove the short name on the conflicting file.  */
1212
1213 retry:
1214         status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1215                                               FileShortNameInformation);
1216
1217         if (status == STATUS_INVALID_PARAMETER && !retried) {
1218
1219                 /* Microsoft forgot to make it possible to remove short names
1220                  * until Windows 7.  Oops.  Use a random short name instead.  */
1221
1222                 info->FileNameLength = 12 * sizeof(wchar_t);
1223                 for (int i = 0; i < 8; i++)
1224                         info->FileName[i] = 'A' + (rand() % 26);
1225                 info->FileName[8] = L'.';
1226                 info->FileName[9] = L'W';
1227                 info->FileName[10] = L'L';
1228                 info->FileName[11] = L'B';
1229                 info->FileName[12] = L'\0';
1230                 retried = true;
1231                 goto retry;
1232         }
1233         (*func_NtClose)(h);
1234 out:
1235         build_extraction_path(dentry, ctx);
1236         return status;
1237 }
1238
1239 /* Set the short name on the open file @h which has been created at the location
1240  * indicated by @dentry.
1241  *
1242  * Note that this may add, change, or remove the short name.
1243  *
1244  * @h must be opened with DELETE access.
1245  *
1246  * Returns 0 or WIMLIB_ERR_SET_SHORT_NAME.  The latter only happens in
1247  * STRICT_SHORT_NAMES mode.
1248  */
1249 static int
1250 set_short_name(HANDLE h, const struct wim_dentry *dentry,
1251                struct win32_apply_ctx *ctx)
1252 {
1253
1254         if (!ctx->common.supported_features.short_names)
1255                 return 0;
1256
1257         /*
1258          * Note: The size of the FILE_NAME_INFORMATION buffer must be such that
1259          * FileName contains at least 2 wide characters (4 bytes).  Otherwise,
1260          * NtSetInformationFile() will return STATUS_INFO_LENGTH_MISMATCH.  This
1261          * is despite the fact that FileNameLength can validly be 0 or 2 bytes,
1262          * with the former case being removing the existing short name if
1263          * present, rather than setting one.
1264          *
1265          * The null terminator is seemingly optional, but to be safe we include
1266          * space for it and zero all unused space.
1267          */
1268
1269         size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1270                          max(dentry->d_short_name_nbytes, sizeof(wchar_t)) +
1271                          sizeof(wchar_t);
1272         u8 buf[bufsize] _aligned_attribute(8);
1273         FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1274         NTSTATUS status;
1275         bool tried_to_remove_existing = false;
1276
1277         memset(buf, 0, bufsize);
1278
1279         info->FileNameLength = dentry->d_short_name_nbytes;
1280         memcpy(info->FileName, dentry->d_short_name, dentry->d_short_name_nbytes);
1281
1282 retry:
1283         status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1284                                               FileShortNameInformation);
1285         if (NT_SUCCESS(status))
1286                 return 0;
1287
1288         if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
1289                 if (dentry->d_short_name_nbytes == 0)
1290                         return 0;
1291                 if (!ctx->tried_to_enable_short_names) {
1292                         wchar_t volume[7];
1293                         int ret;
1294
1295                         ctx->tried_to_enable_short_names = true;
1296
1297                         ret = win32_get_drive_path(ctx->common.target,
1298                                                    volume);
1299                         if (ret)
1300                                 return ret;
1301                         if (try_to_enable_short_names(volume))
1302                                 goto retry;
1303                 }
1304         }
1305
1306         /*
1307          * Short names can conflict in several cases:
1308          *
1309          * - a file being extracted has a short name conflicting with an
1310          *   existing file
1311          *
1312          * - a file being extracted has a short name conflicting with another
1313          *   file being extracted (possible, but shouldn't happen)
1314          *
1315          * - a file being extracted has a short name that conflicts with the
1316          *   automatically generated short name of a file we previously
1317          *   extracted, but failed to set the short name for.  Sounds unlikely,
1318          *   but this actually does happen fairly often on versions of Windows
1319          *   prior to Windows 7 because they do not support removing short names
1320          *   from files.
1321          */
1322         if (unlikely(status == STATUS_OBJECT_NAME_COLLISION) &&
1323             dentry->d_short_name_nbytes && !tried_to_remove_existing)
1324         {
1325                 tried_to_remove_existing = true;
1326                 status = remove_conflicting_short_name(dentry, ctx);
1327                 if (NT_SUCCESS(status))
1328                         goto retry;
1329         }
1330
1331         /* By default, failure to set short names is not an error (since short
1332          * names aren't too important anymore...).  */
1333         if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
1334                 if (dentry->d_short_name_nbytes)
1335                         ctx->num_set_short_name_failures++;
1336                 else
1337                         ctx->num_remove_short_name_failures++;
1338                 return 0;
1339         }
1340
1341         winnt_error(status, L"Can't set short name on \"%ls\"", current_path(ctx));
1342         return WIMLIB_ERR_SET_SHORT_NAME;
1343 }
1344
1345 /*
1346  * A wrapper around NtCreateFile() to make it slightly more usable...
1347  * This uses the path currently constructed in ctx->pathbuf.
1348  *
1349  * Also, we always specify FILE_OPEN_FOR_BACKUP_INTENT and
1350  * FILE_OPEN_REPARSE_POINT.
1351  */
1352 static NTSTATUS
1353 do_create_file(PHANDLE FileHandle,
1354                ACCESS_MASK DesiredAccess,
1355                PLARGE_INTEGER AllocationSize,
1356                ULONG FileAttributes,
1357                ULONG CreateDisposition,
1358                ULONG CreateOptions,
1359                struct win32_apply_ctx *ctx)
1360 {
1361         return (*func_NtCreateFile)(FileHandle,
1362                                     DesiredAccess,
1363                                     &ctx->attr,
1364                                     &ctx->iosb,
1365                                     AllocationSize,
1366                                     FileAttributes,
1367                                     FILE_SHARE_VALID_FLAGS,
1368                                     CreateDisposition,
1369                                     CreateOptions |
1370                                         FILE_OPEN_FOR_BACKUP_INTENT |
1371                                         FILE_OPEN_REPARSE_POINT,
1372                                     NULL,
1373                                     0);
1374 }
1375
1376 /* Like do_create_file(), but builds the extraction path of the @dentry first.
1377  */
1378 static NTSTATUS
1379 create_file(PHANDLE FileHandle,
1380             ACCESS_MASK DesiredAccess,
1381             PLARGE_INTEGER AllocationSize,
1382             ULONG FileAttributes,
1383             ULONG CreateDisposition,
1384             ULONG CreateOptions,
1385             const struct wim_dentry *dentry,
1386             struct win32_apply_ctx *ctx)
1387 {
1388         build_extraction_path(dentry, ctx);
1389         return do_create_file(FileHandle,
1390                               DesiredAccess,
1391                               AllocationSize,
1392                               FileAttributes,
1393                               CreateDisposition,
1394                               CreateOptions,
1395                               ctx);
1396 }
1397
1398 static int
1399 delete_file_or_stream(struct win32_apply_ctx *ctx)
1400 {
1401         NTSTATUS status;
1402         HANDLE h;
1403         FILE_DISPOSITION_INFORMATION disposition_info;
1404         FILE_BASIC_INFORMATION basic_info;
1405         bool retried = false;
1406
1407         status = do_create_file(&h,
1408                                 DELETE,
1409                                 NULL,
1410                                 0,
1411                                 FILE_OPEN,
1412                                 FILE_NON_DIRECTORY_FILE,
1413                                 ctx);
1414         if (unlikely(!NT_SUCCESS(status))) {
1415                 winnt_error(status, L"Can't open \"%ls\" for deletion",
1416                             current_path(ctx));
1417                 return WIMLIB_ERR_OPEN;
1418         }
1419
1420 retry:
1421         disposition_info.DoDeleteFile = TRUE;
1422         status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1423                                               &disposition_info,
1424                                               sizeof(disposition_info),
1425                                               FileDispositionInformation);
1426         (*func_NtClose)(h);
1427         if (likely(NT_SUCCESS(status)))
1428                 return 0;
1429
1430         if (status == STATUS_CANNOT_DELETE && !retried) {
1431                 /* Clear file attributes and try again.  This is necessary for
1432                  * FILE_ATTRIBUTE_READONLY files.  */
1433                 status = do_create_file(&h,
1434                                         FILE_WRITE_ATTRIBUTES | DELETE,
1435                                         NULL,
1436                                         0,
1437                                         FILE_OPEN,
1438                                         FILE_NON_DIRECTORY_FILE,
1439                                         ctx);
1440                 if (!NT_SUCCESS(status)) {
1441                         winnt_error(status,
1442                                     L"Can't open \"%ls\" to reset attributes",
1443                                     current_path(ctx));
1444                         return WIMLIB_ERR_OPEN;
1445                 }
1446                 memset(&basic_info, 0, sizeof(basic_info));
1447                 basic_info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
1448                 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1449                                                       &basic_info,
1450                                                       sizeof(basic_info),
1451                                                       FileBasicInformation);
1452                 if (!NT_SUCCESS(status)) {
1453                         winnt_error(status,
1454                                     L"Can't reset file attributes on \"%ls\"",
1455                                     current_path(ctx));
1456                         (*func_NtClose)(h);
1457                         return WIMLIB_ERR_SET_ATTRIBUTES;
1458                 }
1459                 retried = true;
1460                 goto retry;
1461         }
1462         winnt_error(status, L"Can't delete \"%ls\"", current_path(ctx));
1463         return WIMLIB_ERR_OPEN;
1464 }
1465
1466 /*
1467  * Create a nondirectory file or named data stream at the current path,
1468  * superseding any that already exists at that path.  If successful, return an
1469  * open handle to the file or named data stream.
1470  */
1471 static int
1472 supersede_file_or_stream(struct win32_apply_ctx *ctx, HANDLE *h_ret)
1473 {
1474         NTSTATUS status;
1475         bool retried = false;
1476
1477         /* FILE_ATTRIBUTE_SYSTEM is needed to ensure that
1478          * FILE_ATTRIBUTE_ENCRYPTED doesn't get set before we want it to be.  */
1479 retry:
1480         status = do_create_file(h_ret,
1481                                 GENERIC_READ | GENERIC_WRITE | DELETE,
1482                                 NULL,
1483                                 FILE_ATTRIBUTE_SYSTEM,
1484                                 FILE_CREATE,
1485                                 FILE_NON_DIRECTORY_FILE,
1486                                 ctx);
1487         if (likely(NT_SUCCESS(status)))
1488                 return 0;
1489
1490         /* STATUS_OBJECT_NAME_COLLISION means that the file or stream already
1491          * exists.  Delete the existing file or stream, then try again.
1492          *
1493          * Note: we don't use FILE_OVERWRITE_IF or FILE_SUPERSEDE because of
1494          * problems with certain file attributes, especially
1495          * FILE_ATTRIBUTE_ENCRYPTED.  FILE_SUPERSEDE is also broken in the
1496          * Windows PE ramdisk.  */
1497         if (status == STATUS_OBJECT_NAME_COLLISION && !retried) {
1498                 int ret = delete_file_or_stream(ctx);
1499                 if (ret)
1500                         return ret;
1501                 retried = true;
1502                 goto retry;
1503         }
1504         winnt_error(status, L"Can't create \"%ls\"", current_path(ctx));
1505         return WIMLIB_ERR_OPEN;
1506 }
1507
1508 /* Set the reparse point @rpbuf of length @rpbuflen on the extracted file
1509  * corresponding to the WIM dentry @dentry.  */
1510 static int
1511 do_set_reparse_point(const struct wim_dentry *dentry,
1512                      const struct reparse_buffer_disk *rpbuf, u16 rpbuflen,
1513                      struct win32_apply_ctx *ctx)
1514 {
1515         NTSTATUS status;
1516         HANDLE h;
1517
1518         status = create_file(&h, GENERIC_WRITE, NULL,
1519                              0, FILE_OPEN, 0, dentry, ctx);
1520         if (!NT_SUCCESS(status))
1521                 goto fail;
1522
1523         status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
1524                                          &ctx->iosb, FSCTL_SET_REPARSE_POINT,
1525                                          (void *)rpbuf, rpbuflen,
1526                                          NULL, 0);
1527         (*func_NtClose)(h);
1528
1529         if (NT_SUCCESS(status))
1530                 return 0;
1531
1532         /* On Windows, by default only the Administrator can create symbolic
1533          * links for some reason.  By default we just issue a warning if this
1534          * appears to be the problem.  Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
1535          * to get a hard error.  */
1536         if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
1537             && (status == STATUS_PRIVILEGE_NOT_HELD ||
1538                 status == STATUS_ACCESS_DENIED)
1539             && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1540                 dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1541         {
1542                 WARNING("Can't create symbolic link \"%ls\"!              \n"
1543                         "          (Need Administrator rights, or at least "
1544                         "the\n"
1545                         "          SeCreateSymbolicLink privilege.)",
1546                         current_path(ctx));
1547                 return 0;
1548         }
1549
1550 fail:
1551         winnt_error(status, L"Can't set reparse data on \"%ls\"",
1552                     current_path(ctx));
1553         return WIMLIB_ERR_SET_REPARSE_DATA;
1554 }
1555
1556 /*
1557  * Create empty named data streams and potentially a reparse point for the
1558  * specified file, if any.
1559  *
1560  * Since these won't have blob descriptors, they won't show up in the call to
1561  * extract_blob_list().  Hence the need for the special case.
1562  */
1563 static int
1564 create_empty_streams(const struct wim_dentry *dentry,
1565                      struct win32_apply_ctx *ctx)
1566 {
1567         const struct wim_inode *inode = dentry->d_inode;
1568         int ret;
1569
1570         for (unsigned i = 0; i < inode->i_num_streams; i++) {
1571                 const struct wim_inode_stream *strm = &inode->i_streams[i];
1572
1573                 if (stream_blob_resolved(strm) != NULL)
1574                         continue;
1575
1576                 if (strm->stream_type == STREAM_TYPE_REPARSE_POINT &&
1577                     ctx->common.supported_features.reparse_points)
1578                 {
1579                         u8 buf[REPARSE_DATA_OFFSET] _aligned_attribute(8);
1580                         struct reparse_buffer_disk *rpbuf =
1581                                 (struct reparse_buffer_disk *)buf;
1582                         complete_reparse_point(rpbuf, inode, 0);
1583                         ret = do_set_reparse_point(dentry, rpbuf,
1584                                                    REPARSE_DATA_OFFSET, ctx);
1585                         if (ret)
1586                                 return ret;
1587                 } else if (stream_is_named_data_stream(strm) &&
1588                            ctx->common.supported_features.named_data_streams)
1589                 {
1590                         HANDLE h;
1591
1592                         build_extraction_path_with_ads(dentry, ctx,
1593                                                        strm->stream_name,
1594                                                        utf16le_len_chars(strm->stream_name));
1595                         ret = supersede_file_or_stream(ctx, &h);
1596
1597                         build_extraction_path(dentry, ctx);
1598
1599                         if (ret)
1600                                 return ret;
1601                         (*func_NtClose)(h);
1602                 }
1603         }
1604
1605         return 0;
1606 }
1607
1608 /*
1609  * Creates the directory named by @dentry, or uses an existing directory at that
1610  * location.  If necessary, sets the short name and/or fixes compression and
1611  * encryption attributes.
1612  *
1613  * Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
1614  */
1615 static int
1616 create_directory(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
1617 {
1618         DWORD perms;
1619         NTSTATUS status;
1620         HANDLE h;
1621         int ret;
1622
1623         /* DELETE is needed for set_short_name(); GENERIC_READ and GENERIC_WRITE
1624          * are needed for adjust_compression_attribute().  */
1625         perms = GENERIC_READ | GENERIC_WRITE;
1626         if (!dentry_is_root(dentry))
1627                 perms |= DELETE;
1628
1629         /* FILE_ATTRIBUTE_SYSTEM is needed to ensure that
1630          * FILE_ATTRIBUTE_ENCRYPTED doesn't get set before we want it to be.  */
1631         status = create_file(&h, perms, NULL, FILE_ATTRIBUTE_SYSTEM,
1632                              FILE_OPEN_IF, FILE_DIRECTORY_FILE, dentry, ctx);
1633         if (!NT_SUCCESS(status)) {
1634                 winnt_error(status, L"Can't create directory \"%ls\"",
1635                             current_path(ctx));
1636                 return WIMLIB_ERR_MKDIR;
1637         }
1638
1639         if (ctx->iosb.Information == FILE_OPENED) {
1640                 /* If we opened an existing directory, try to clear its file
1641                  * attributes.  As far as I know, this only actually makes a
1642                  * difference in the case where a FILE_ATTRIBUTE_READONLY
1643                  * directory has a named data stream which needs to be
1644                  * extracted.  You cannot create a named data stream of such a
1645                  * directory, even though this contradicts Microsoft's
1646                  * documentation for FILE_ATTRIBUTE_READONLY which states it is
1647                  * not honored for directories!  */
1648                 FILE_BASIC_INFORMATION basic_info = { .FileAttributes = FILE_ATTRIBUTE_NORMAL };
1649                 (*func_NtSetInformationFile)(h, &ctx->iosb, &basic_info,
1650                                              sizeof(basic_info), FileBasicInformation);
1651         }
1652
1653         if (!dentry_is_root(dentry)) {
1654                 ret = set_short_name(h, dentry, ctx);
1655                 if (ret)
1656                         goto out;
1657         }
1658
1659         ret = adjust_compression_attribute(h, dentry, ctx);
1660 out:
1661         (*func_NtClose)(h);
1662         return ret;
1663 }
1664
1665 /*
1666  * Create all the directories being extracted, other than the target directory
1667  * itself.
1668  *
1669  * Note: we don't honor directory hard links.  However, we don't allow them to
1670  * exist in WIM images anyway (see inode_fixup.c).
1671  */
1672 static int
1673 create_directories(struct list_head *dentry_list,
1674                    struct win32_apply_ctx *ctx)
1675 {
1676         const struct wim_dentry *dentry;
1677         int ret;
1678
1679         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1680
1681                 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
1682                         continue;
1683
1684                 /* Note: Here we include files with
1685                  * FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
1686                  * wait until later to actually set the reparse data.  */
1687
1688                 ret = create_directory(dentry, ctx);
1689
1690                 if (!ret)
1691                         ret = create_empty_streams(dentry, ctx);
1692
1693                 ret = check_apply_error(dentry, ctx, ret);
1694                 if (ret)
1695                         return ret;
1696
1697                 ret = report_file_created(&ctx->common);
1698                 if (ret)
1699                         return ret;
1700         }
1701         return 0;
1702 }
1703
1704 /*
1705  * Creates the nondirectory file named by @dentry.
1706  *
1707  * On success, returns an open handle to the file in @h_ret, with GENERIC_READ,
1708  * GENERIC_WRITE, and DELETE access.  Also, the path to the file will be saved
1709  * in ctx->pathbuf.  On failure, returns an error code.
1710  */
1711 static int
1712 create_nondirectory_inode(HANDLE *h_ret, const struct wim_dentry *dentry,
1713                           struct win32_apply_ctx *ctx)
1714 {
1715         int ret;
1716         HANDLE h;
1717
1718         build_extraction_path(dentry, ctx);
1719
1720         ret = supersede_file_or_stream(ctx, &h);
1721         if (ret)
1722                 goto out;
1723
1724         ret = adjust_compression_attribute(h, dentry, ctx);
1725         if (ret)
1726                 goto out_close;
1727
1728         ret = create_empty_streams(dentry, ctx);
1729         if (ret)
1730                 goto out_close;
1731
1732         *h_ret = h;
1733         return 0;
1734
1735 out_close:
1736         (*func_NtClose)(h);
1737 out:
1738         return ret;
1739 }
1740
1741 /* Creates a hard link at the location named by @dentry to the file represented
1742  * by the open handle @h.  Or, if the target volume does not support hard links,
1743  * create a separate file instead.  */
1744 static int
1745 create_link(HANDLE h, const struct wim_dentry *dentry,
1746             struct win32_apply_ctx *ctx)
1747 {
1748         if (ctx->common.supported_features.hard_links) {
1749
1750                 build_extraction_path(dentry, ctx);
1751
1752                 size_t bufsize = offsetof(FILE_LINK_INFORMATION, FileName) +
1753                                  ctx->pathbuf.Length + sizeof(wchar_t);
1754                 u8 buf[bufsize] _aligned_attribute(8);
1755                 FILE_LINK_INFORMATION *info = (FILE_LINK_INFORMATION *)buf;
1756                 NTSTATUS status;
1757
1758                 info->ReplaceIfExists = TRUE;
1759                 info->RootDirectory = ctx->attr.RootDirectory;
1760                 info->FileNameLength = ctx->pathbuf.Length;
1761                 memcpy(info->FileName, ctx->pathbuf.Buffer, ctx->pathbuf.Length);
1762                 info->FileName[info->FileNameLength / 2] = L'\0';
1763
1764                 /* Note: the null terminator isn't actually necessary,
1765                  * but if you don't add the extra character, you get
1766                  * STATUS_INFO_LENGTH_MISMATCH when FileNameLength
1767                  * happens to be 2  */
1768
1769                 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1770                                                       info, bufsize,
1771                                                       FileLinkInformation);
1772                 if (NT_SUCCESS(status))
1773                         return 0;
1774                 winnt_error(status, L"Failed to create link \"%ls\"",
1775                             current_path(ctx));
1776                 return WIMLIB_ERR_LINK;
1777         } else {
1778                 HANDLE h2;
1779                 int ret;
1780
1781                 ret = create_nondirectory_inode(&h2, dentry, ctx);
1782                 if (ret)
1783                         return ret;
1784
1785                 (*func_NtClose)(h2);
1786                 return 0;
1787         }
1788 }
1789
1790 /* Given an inode (represented by the open handle @h) for which one link has
1791  * been created (named by @first_dentry), create the other links.
1792  *
1793  * Or, if the target volume does not support hard links, create separate files.
1794  *
1795  * Note: This uses ctx->pathbuf and does not reset it.
1796  */
1797 static int
1798 create_links(HANDLE h, const struct wim_dentry *first_dentry,
1799              struct win32_apply_ctx *ctx)
1800 {
1801         const struct wim_inode *inode = first_dentry->d_inode;
1802         const struct wim_dentry *dentry;
1803         int ret;
1804
1805         inode_for_each_extraction_alias(dentry, inode) {
1806                 if (dentry != first_dentry) {
1807                         ret = create_link(h, dentry, ctx);
1808                         if (ret)
1809                                 return ret;
1810                 }
1811         }
1812         return 0;
1813 }
1814
1815 /* Create a nondirectory file, including all links.  */
1816 static int
1817 create_nondirectory(struct wim_inode *inode, struct win32_apply_ctx *ctx)
1818 {
1819         struct wim_dentry *first_dentry;
1820         HANDLE h;
1821         int ret;
1822
1823         first_dentry = first_extraction_alias(inode);
1824
1825         /* Create first link.  */
1826         ret = create_nondirectory_inode(&h, first_dentry, ctx);
1827         if (ret)
1828                 return ret;
1829
1830         /* Set short name.  */
1831         ret = set_short_name(h, first_dentry, ctx);
1832
1833         /* Create additional links, OR if hard links are not supported just
1834          * create more files.  */
1835         if (!ret)
1836                 ret = create_links(h, first_dentry, ctx);
1837
1838         /* "WIMBoot" extraction: set external backing by the WIM file if needed.  */
1839         if (!ret && unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
1840                 ret = set_backed_from_wim(h, inode, ctx);
1841
1842         (*func_NtClose)(h);
1843         return ret;
1844 }
1845
1846 /* Create all the nondirectory files being extracted, including all aliases
1847  * (hard links).  */
1848 static int
1849 create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1850 {
1851         struct wim_dentry *dentry;
1852         struct wim_inode *inode;
1853         int ret;
1854
1855         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1856                 inode = dentry->d_inode;
1857                 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1858                         continue;
1859                 /* Call create_nondirectory() only once per inode  */
1860                 if (dentry == inode_first_extraction_dentry(inode)) {
1861                         ret = create_nondirectory(inode, ctx);
1862                         ret = check_apply_error(dentry, ctx, ret);
1863                         if (ret)
1864                                 return ret;
1865                 }
1866                 ret = report_file_created(&ctx->common);
1867                 if (ret)
1868                         return ret;
1869         }
1870         return 0;
1871 }
1872
1873 static void
1874 close_handles(struct win32_apply_ctx *ctx)
1875 {
1876         for (unsigned i = 0; i < ctx->num_open_handles; i++)
1877                 (*func_NtClose)(ctx->open_handles[i]);
1878 }
1879
1880 /* Prepare to read the next blob, which has size @blob_size, into an in-memory
1881  * buffer.  */
1882 static bool
1883 prepare_data_buffer(struct win32_apply_ctx *ctx, u64 blob_size)
1884 {
1885         if (blob_size > ctx->data_buffer_size) {
1886                 /* Larger buffer needed.  */
1887                 void *new_buffer;
1888                 if ((size_t)blob_size != blob_size)
1889                         return false;
1890                 new_buffer = REALLOC(ctx->data_buffer, blob_size);
1891                 if (!new_buffer)
1892                         return false;
1893                 ctx->data_buffer = new_buffer;
1894                 ctx->data_buffer_size = blob_size;
1895         }
1896         /* On the first call this changes data_buffer_ptr from NULL, which tells
1897          * extract_chunk() that the data buffer needs to be filled while reading
1898          * the stream data.  */
1899         ctx->data_buffer_ptr = ctx->data_buffer;
1900         return true;
1901 }
1902
1903 static int
1904 begin_extract_blob_instance(const struct blob_descriptor *blob,
1905                             struct wim_dentry *dentry,
1906                             const struct wim_inode_stream *strm,
1907                             struct win32_apply_ctx *ctx)
1908 {
1909         FILE_ALLOCATION_INFORMATION alloc_info;
1910         HANDLE h;
1911         NTSTATUS status;
1912
1913         if (unlikely(strm->stream_type == STREAM_TYPE_REPARSE_POINT)) {
1914                 /* We can't write the reparse point stream directly; we must set
1915                  * it with FSCTL_SET_REPARSE_POINT, which requires that all the
1916                  * data be available.  So, stage the data in a buffer.  */
1917                 if (!prepare_data_buffer(ctx, blob->size))
1918                         return WIMLIB_ERR_NOMEM;
1919                 list_add_tail(&dentry->d_tmp_list, &ctx->reparse_dentries);
1920                 return 0;
1921         }
1922
1923         if (unlikely(strm->stream_type == STREAM_TYPE_EFSRPC_RAW_DATA)) {
1924                 /* We can't write encrypted files directly; we must use
1925                  * WriteEncryptedFileRaw(), which requires providing the data
1926                  * through a callback function.  This can't easily be combined
1927                  * with our own callback-based approach.
1928                  *
1929                  * The current workaround is to simply read the blob into memory
1930                  * and write the encrypted file from that.
1931                  *
1932                  * TODO: This isn't sufficient for extremely large encrypted
1933                  * files.  Perhaps we should create an extra thread to write
1934                  * such files...  */
1935                 if (!prepare_data_buffer(ctx, blob->size))
1936                         return WIMLIB_ERR_NOMEM;
1937                 list_add_tail(&dentry->d_tmp_list, &ctx->encrypted_dentries);
1938                 return 0;
1939         }
1940
1941         /* It's a data stream (may be unnamed or named).  */
1942         wimlib_assert(strm->stream_type == STREAM_TYPE_DATA);
1943
1944         if (ctx->num_open_handles == MAX_OPEN_FILES) {
1945                 /* XXX: Fix this.  But because of the checks in
1946                  * extract_blob_list(), this can now only happen on a filesystem
1947                  * that does not support hard links.  */
1948                 ERROR("Can't extract data: too many open files!");
1949                 return WIMLIB_ERR_UNSUPPORTED;
1950         }
1951
1952
1953         if (unlikely(stream_is_named(strm))) {
1954                 build_extraction_path_with_ads(dentry, ctx,
1955                                                strm->stream_name,
1956                                                utf16le_len_chars(strm->stream_name));
1957         } else {
1958                 build_extraction_path(dentry, ctx);
1959         }
1960
1961
1962         /* Open a new handle  */
1963         status = do_create_file(&h,
1964                                 FILE_WRITE_DATA | SYNCHRONIZE,
1965                                 NULL, 0, FILE_OPEN_IF,
1966                                 FILE_SEQUENTIAL_ONLY |
1967                                         FILE_SYNCHRONOUS_IO_NONALERT,
1968                                 ctx);
1969         if (!NT_SUCCESS(status)) {
1970                 winnt_error(status, L"Can't open \"%ls\" for writing",
1971                             current_path(ctx));
1972                 return WIMLIB_ERR_OPEN;
1973         }
1974
1975         ctx->open_handles[ctx->num_open_handles++] = h;
1976
1977         /* Allocate space for the data.  */
1978         alloc_info.AllocationSize.QuadPart = blob->size;
1979         (*func_NtSetInformationFile)(h, &ctx->iosb,
1980                                      &alloc_info, sizeof(alloc_info),
1981                                      FileAllocationInformation);
1982         return 0;
1983 }
1984
1985 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1986  * pointer to the suffix of the path that begins with the device directly, such
1987  * as e:\Windows\System32.  */
1988 static const wchar_t *
1989 skip_nt_toplevel_component(const wchar_t *path, size_t path_nchars)
1990 {
1991         static const wchar_t * const dirs[] = {
1992                 L"\\??\\",
1993                 L"\\DosDevices\\",
1994                 L"\\Device\\",
1995         };
1996         const wchar_t * const end = path + path_nchars;
1997
1998         for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
1999                 size_t len = wcslen(dirs[i]);
2000                 if (len <= (end - path) && !wmemcmp(path, dirs[i], len)) {
2001                         path += len;
2002                         while (path != end && *path == L'\\')
2003                                 path++;
2004                         return path;
2005                 }
2006         }
2007         return path;
2008 }
2009
2010 /*
2011  * Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
2012  * pointer to the suffix of the path that is device-relative but possibly with
2013  * leading slashes, such as \Windows\System32.
2014  *
2015  * The path has an explicit length and is not necessarily null terminated.
2016  */
2017 static const wchar_t *
2018 get_device_relative_path(const wchar_t *path, size_t path_nchars)
2019 {
2020         const wchar_t * const orig_path = path;
2021         const wchar_t * const end = path + path_nchars;
2022
2023         path = skip_nt_toplevel_component(path, path_nchars);
2024         if (path == orig_path)
2025                 return orig_path;
2026
2027         while (path != end && *path != L'\\')
2028                 path++;
2029
2030         return path;
2031 }
2032
2033 /*
2034  * Given a reparse point buffer for an inode for which the absolute link target
2035  * was relativized when it was archived, de-relative the link target to be
2036  * consistent with the actual extraction location.
2037  */
2038 static void
2039 try_rpfix(struct reparse_buffer_disk *rpbuf, u16 *rpbuflen_p,
2040           struct win32_apply_ctx *ctx)
2041 {
2042         struct link_reparse_point link;
2043         size_t orig_subst_name_nchars;
2044         const wchar_t *relpath;
2045         size_t relpath_nchars;
2046         size_t target_ntpath_nchars;
2047         size_t fixed_subst_name_nchars;
2048         const wchar_t *fixed_print_name;
2049         size_t fixed_print_name_nchars;
2050
2051         /* Do nothing if the reparse data is invalid.  */
2052         if (parse_link_reparse_point(rpbuf, *rpbuflen_p, &link))
2053                 return;
2054
2055         /* Do nothing if the reparse point is a relative symbolic link.  */
2056         if (link_is_relative_symlink(&link))
2057                 return;
2058
2059         /* Build the new substitute name from the NT namespace path to the
2060          * target directory, then a path separator, then the "device relative"
2061          * part of the old substitute name.  */
2062
2063         orig_subst_name_nchars = link.substitute_name_nbytes / sizeof(wchar_t);
2064
2065         relpath = get_device_relative_path(link.substitute_name,
2066                                            orig_subst_name_nchars);
2067         relpath_nchars = orig_subst_name_nchars -
2068                          (relpath - link.substitute_name);
2069
2070         target_ntpath_nchars = ctx->target_ntpath.Length / sizeof(wchar_t);
2071
2072         fixed_subst_name_nchars = target_ntpath_nchars + relpath_nchars;
2073
2074         wchar_t fixed_subst_name[fixed_subst_name_nchars];
2075
2076         wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer, target_ntpath_nchars);
2077         wmemcpy(&fixed_subst_name[target_ntpath_nchars], relpath, relpath_nchars);
2078         /* Doesn't need to be null-terminated.  */
2079
2080         /* Print name should be Win32, but not all NT names can even be
2081          * translated to Win32 names.  But we can at least delete the top-level
2082          * directory, such as \??\, and this will have the expected result in
2083          * the usual case.  */
2084         fixed_print_name = skip_nt_toplevel_component(fixed_subst_name,
2085                                                       fixed_subst_name_nchars);
2086         fixed_print_name_nchars = fixed_subst_name_nchars - (fixed_print_name -
2087                                                              fixed_subst_name);
2088
2089         link.substitute_name = fixed_subst_name;
2090         link.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
2091         link.print_name = (wchar_t *)fixed_print_name;
2092         link.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
2093         make_link_reparse_point(&link, rpbuf, rpbuflen_p);
2094 }
2095
2096 /* Sets the reparse point on the specified file.  This handles "fixing" the
2097  * targets of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX
2098  * was specified.  */
2099 static int
2100 set_reparse_point(const struct wim_dentry *dentry,
2101                   const struct reparse_buffer_disk *rpbuf, u16 rpbuflen,
2102                   struct win32_apply_ctx *ctx)
2103 {
2104         if ((ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
2105             && !(dentry->d_inode->i_rp_flags & WIM_RP_FLAG_NOT_FIXED))
2106         {
2107                 memcpy(&ctx->rpfixbuf, rpbuf, rpbuflen);
2108                 try_rpfix(&ctx->rpfixbuf, &rpbuflen, ctx);
2109                 rpbuf = &ctx->rpfixbuf;
2110         }
2111         return do_set_reparse_point(dentry, rpbuf, rpbuflen, ctx);
2112
2113 }
2114
2115 /* Import the next block of raw encrypted data  */
2116 static DWORD WINAPI
2117 import_encrypted_data(PBYTE pbData, PVOID pvCallbackContext, PULONG Length)
2118 {
2119         struct win32_apply_ctx *ctx = pvCallbackContext;
2120         ULONG copy_len;
2121
2122         copy_len = min(ctx->encrypted_size - ctx->encrypted_offset, *Length);
2123         memcpy(pbData, &ctx->data_buffer[ctx->encrypted_offset], copy_len);
2124         ctx->encrypted_offset += copy_len;
2125         *Length = copy_len;
2126         return ERROR_SUCCESS;
2127 }
2128
2129 /*
2130  * Write the raw encrypted data to the already-created file (or directory)
2131  * corresponding to @dentry.
2132  *
2133  * The raw encrypted data is provided in ctx->data_buffer, and its size is
2134  * ctx->encrypted_size.
2135  *
2136  * This function may close the target directory, in which case the caller needs
2137  * to re-open it if needed.
2138  */
2139 static int
2140 extract_encrypted_file(const struct wim_dentry *dentry,
2141                        struct win32_apply_ctx *ctx)
2142 {
2143         void *rawctx;
2144         DWORD err;
2145         ULONG flags;
2146         bool retried;
2147
2148         /* Temporarily build a Win32 path for OpenEncryptedFileRaw()  */
2149         build_win32_extraction_path(dentry, ctx);
2150
2151         flags = CREATE_FOR_IMPORT | OVERWRITE_HIDDEN;
2152         if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
2153                 flags |= CREATE_FOR_DIR;
2154
2155         retried = false;
2156 retry:
2157         err = OpenEncryptedFileRaw(ctx->pathbuf.Buffer, flags, &rawctx);
2158         if (err == ERROR_SHARING_VIOLATION && !retried) {
2159                 /* This can be caused by the handle we have open to the target
2160                  * directory.  Try closing it temporarily.  */
2161                 close_target_directory(ctx);
2162                 retried = true;
2163                 goto retry;
2164         }
2165
2166         /* Restore the NT namespace path  */
2167         build_extraction_path(dentry, ctx);
2168
2169         if (err != ERROR_SUCCESS) {
2170                 win32_error(err, L"Can't open \"%ls\" for encrypted import",
2171                             current_path(ctx));
2172                 return WIMLIB_ERR_OPEN;
2173         }
2174
2175         ctx->encrypted_offset = 0;
2176
2177         err = WriteEncryptedFileRaw(import_encrypted_data, ctx, rawctx);
2178
2179         CloseEncryptedFileRaw(rawctx);
2180
2181         if (err != ERROR_SUCCESS) {
2182                 win32_error(err, L"Can't import encrypted file \"%ls\"",
2183                             current_path(ctx));
2184                 return WIMLIB_ERR_WRITE;
2185         }
2186
2187         return 0;
2188 }
2189
2190 /* Called when starting to read a blob for extraction on Windows  */
2191 static int
2192 begin_extract_blob(struct blob_descriptor *blob, void *_ctx)
2193 {
2194         struct win32_apply_ctx *ctx = _ctx;
2195         const struct blob_extraction_target *targets = blob_extraction_targets(blob);
2196         int ret;
2197
2198         ctx->num_open_handles = 0;
2199         ctx->data_buffer_ptr = NULL;
2200         INIT_LIST_HEAD(&ctx->reparse_dentries);
2201         INIT_LIST_HEAD(&ctx->encrypted_dentries);
2202
2203         for (u32 i = 0; i < blob->out_refcnt; i++) {
2204                 const struct wim_inode *inode = targets[i].inode;
2205                 const struct wim_inode_stream *strm = targets[i].stream;
2206                 struct wim_dentry *dentry;
2207
2208                 /* A copy of the blob needs to be extracted to @inode.  */
2209
2210                 if (ctx->common.supported_features.hard_links) {
2211                         dentry = inode_first_extraction_dentry(inode);
2212                         ret = begin_extract_blob_instance(blob, dentry, strm, ctx);
2213                         ret = check_apply_error(dentry, ctx, ret);
2214                         if (ret)
2215                                 goto fail;
2216                 } else {
2217                         /* Hard links not supported.  Extract the blob
2218                          * separately to each alias of the inode.  */
2219                         inode_for_each_extraction_alias(dentry, inode) {
2220                                 ret = begin_extract_blob_instance(blob, dentry, strm, ctx);
2221                                 ret = check_apply_error(dentry, ctx, ret);
2222                                 if (ret)
2223                                         goto fail;
2224                         }
2225                 }
2226         }
2227
2228         return 0;
2229
2230 fail:
2231         close_handles(ctx);
2232         return ret;
2233 }
2234
2235 /* Called when the next chunk of a blob has been read for extraction on Windows
2236  */
2237 static int
2238 extract_chunk(const void *chunk, size_t size, void *_ctx)
2239 {
2240         struct win32_apply_ctx *ctx = _ctx;
2241
2242         /* Write the data chunk to each open handle  */
2243         for (unsigned i = 0; i < ctx->num_open_handles; i++) {
2244                 u8 *bufptr = (u8 *)chunk;
2245                 size_t bytes_remaining = size;
2246                 NTSTATUS status;
2247                 while (bytes_remaining) {
2248                         ULONG count = min(0xFFFFFFFF, bytes_remaining);
2249
2250                         status = (*func_NtWriteFile)(ctx->open_handles[i],
2251                                                      NULL, NULL, NULL,
2252                                                      &ctx->iosb, bufptr, count,
2253                                                      NULL, NULL);
2254                         if (!NT_SUCCESS(status)) {
2255                                 winnt_error(status, L"Error writing data to target volume");
2256                                 return WIMLIB_ERR_WRITE;
2257                         }
2258                         bufptr += ctx->iosb.Information;
2259                         bytes_remaining -= ctx->iosb.Information;
2260                 }
2261         }
2262
2263         /* Copy the data chunk into the buffer (if needed)  */
2264         if (ctx->data_buffer_ptr)
2265                 ctx->data_buffer_ptr = mempcpy(ctx->data_buffer_ptr,
2266                                                chunk, size);
2267         return 0;
2268 }
2269
2270 static int
2271 get_system_compression_format(int extract_flags)
2272 {
2273         if (extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K)
2274                 return FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K;
2275
2276         if (extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K)
2277                 return FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS8K;
2278
2279         if (extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K)
2280                 return FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS16K;
2281
2282         return FILE_PROVIDER_COMPRESSION_FORMAT_LZX;
2283 }
2284
2285
2286 static const wchar_t *
2287 get_system_compression_format_string(int format)
2288 {
2289         switch (format) {
2290         case FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K:
2291                 return L"XPRESS4K";
2292         case FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS8K:
2293                 return L"XPRESS8K";
2294         case FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS16K:
2295                 return L"XPRESS16K";
2296         default:
2297                 return L"LZX";
2298         }
2299 }
2300
2301 static NTSTATUS
2302 set_system_compression(HANDLE h, int format)
2303 {
2304         NTSTATUS status;
2305         IO_STATUS_BLOCK iosb;
2306         struct {
2307                 struct wof_external_info wof_info;
2308                 struct file_provider_external_info file_info;
2309         } in = {
2310                 .wof_info = {
2311                         .version = WOF_CURRENT_VERSION,
2312                         .provider = WOF_PROVIDER_FILE,
2313                 },
2314                 .file_info = {
2315                         .version = FILE_PROVIDER_CURRENT_VERSION,
2316                         .compression_format = format,
2317                 },
2318         };
2319
2320         /* We intentionally use NtFsControlFile() rather than DeviceIoControl()
2321          * here because the "compressing this object would not save space"
2322          * status code does not map to a valid Win32 error code on older
2323          * versions of Windows (before Windows 10?).  This can be a problem if
2324          * the WOFADK driver is being used rather than the regular WOF, since
2325          * WOFADK can be used on older versions of Windows.  */
2326         status = (*func_NtFsControlFile)(h, NULL, NULL, NULL, &iosb,
2327                                          FSCTL_SET_EXTERNAL_BACKING,
2328                                          &in, sizeof(in), NULL, 0);
2329
2330         if (status == 0xC000046F) /* "Compressing this object would not save space."  */
2331                 return STATUS_SUCCESS;
2332
2333         return status;
2334 }
2335
2336 /* Hard-coded list of files which the Windows bootloader may need to access
2337  * before the WOF driver has been loaded.  */
2338 static wchar_t *bootloader_pattern_strings[] = {
2339         L"*winload.*",
2340         L"*winresume.*",
2341         L"\\Windows\\AppPatch\\drvmain.sdb",
2342         L"\\Windows\\Boot\\DVD\\*",
2343         L"\\Windows\\Boot\\EFI\\*",
2344         L"\\Windows\\bootstat.dat",
2345         L"\\Windows\\Fonts\\vgaoem.fon",
2346         L"\\Windows\\Fonts\\vgasys.fon",
2347         L"\\Windows\\INF\\errata.inf",
2348         L"\\Windows\\System32\\config\\*",
2349         L"\\Windows\\System32\\ntkrnlpa.exe",
2350         L"\\Windows\\System32\\ntoskrnl.exe",
2351         L"\\Windows\\System32\\bootvid.dll",
2352         L"\\Windows\\System32\\ci.dll",
2353         L"\\Windows\\System32\\hal*.dll",
2354         L"\\Windows\\System32\\mcupdate_AuthenticAMD.dll",
2355         L"\\Windows\\System32\\mcupdate_GenuineIntel.dll",
2356         L"\\Windows\\System32\\pshed.dll",
2357         L"\\Windows\\System32\\apisetschema.dll",
2358         L"\\Windows\\System32\\api-ms-win*.dll",
2359         L"\\Windows\\System32\\ext-ms-win*.dll",
2360         L"\\Windows\\System32\\KernelBase.dll",
2361         L"\\Windows\\System32\\drivers\\*.sys",
2362         L"\\Windows\\System32\\*.nls",
2363         L"\\Windows\\System32\\kbd*.dll",
2364         L"\\Windows\\System32\\kd*.dll",
2365         L"\\Windows\\System32\\clfs.sys",
2366         L"\\Windows\\System32\\CodeIntegrity\\driver.stl",
2367 };
2368
2369 static const struct string_set bootloader_patterns = {
2370         .strings = bootloader_pattern_strings,
2371         .num_strings = ARRAY_LEN(bootloader_pattern_strings),
2372 };
2373
2374 static NTSTATUS
2375 set_system_compression_on_inode(struct wim_inode *inode, int format,
2376                                 struct win32_apply_ctx *ctx)
2377 {
2378         bool retried = false;
2379         NTSTATUS status;
2380         HANDLE h;
2381
2382         /* If it may be needed for compatibility with the Windows bootloader,
2383          * force this file to XPRESS4K or uncompressed format.  The bootloader
2384          * of Windows 10 supports XPRESS4K only; older versions don't support
2385          * system compression at all.  */
2386         if (!is_image_windows_10_or_later(ctx) ||
2387             format != FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K)
2388         {
2389                 /* We need to check the patterns against every name of the
2390                  * inode, in case any of them match.  */
2391                 struct wim_dentry *dentry;
2392                 inode_for_each_extraction_alias(dentry, inode) {
2393                         bool incompatible;
2394                         bool warned;
2395
2396                         if (calculate_dentry_full_path(dentry)) {
2397                                 ERROR("Unable to compute file path!");
2398                                 return STATUS_NO_MEMORY;
2399                         }
2400
2401                         incompatible = match_pattern_list(dentry->d_full_path,
2402                                                           &bootloader_patterns);
2403                         FREE(dentry->d_full_path);
2404                         dentry->d_full_path = NULL;
2405
2406                         if (!incompatible)
2407                                 continue;
2408
2409                         warned = (ctx->num_system_compression_exclusions++ > 0);
2410
2411                         if (is_image_windows_10_or_later(ctx)) {
2412                                 /* Force to XPRESS4K  */
2413                                 if (!warned) {
2414                                         WARNING("For compatibility with the "
2415                                                 "Windows bootloader, some "
2416                                                 "files are being\n"
2417                                                 "          compacted "
2418                                                 "using the XPRESS4K format "
2419                                                 "instead of the %"TS" format\n"
2420                                                 "          you requested.",
2421                                                 get_system_compression_format_string(format));
2422                                 }
2423                                 format = FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K;
2424                                 break;
2425                         } else {
2426                                 /* Force to uncompressed  */
2427                                 if (!warned) {
2428                                         WARNING("For compatibility with the "
2429                                                 "Windows bootloader, some "
2430                                                 "files will not\n"
2431                                                 "          be compressed with"
2432                                                 " system compression "
2433                                                 "(\"compacted\").");
2434                                 }
2435                                 return STATUS_SUCCESS;
2436                         }
2437
2438                 }
2439         }
2440
2441         /* Open the extracted file.  */
2442         status = create_file(&h, GENERIC_READ | GENERIC_WRITE, NULL,
2443                              0, FILE_OPEN, 0,
2444                              inode_first_extraction_dentry(inode), ctx);
2445
2446         if (!NT_SUCCESS(status))
2447                 return status;
2448 retry:
2449         /* Compress the file.  If the attempt fails with "invalid device
2450          * request", then attach wof.sys (or wofadk.sys) and retry.  */
2451         status = set_system_compression(h, format);
2452         if (unlikely(status == STATUS_INVALID_DEVICE_REQUEST && !retried)) {
2453                 wchar_t drive_path[7];
2454                 if (!win32_get_drive_path(ctx->common.target, drive_path) &&
2455                     win32_try_to_attach_wof(drive_path + 4)) {
2456                         retried = true;
2457                         goto retry;
2458                 }
2459         }
2460
2461         (*func_NtClose)(h);
2462         return status;
2463 }
2464
2465 /*
2466  * This function is called when doing a "compact-mode" extraction and we just
2467  * finished extracting a blob to one or more locations.  For each location that
2468  * was the unnamed data stream of a file, this function compresses the
2469  * corresponding file using System Compression, if allowed.
2470  *
2471  * Note: we're doing the compression immediately after extracting the data
2472  * rather than during a separate compression pass.  This way should be faster
2473  * since the operating system should still have the file's data cached.
2474  *
2475  * Note: we're having the operating system do the compression, which is not
2476  * ideal because wimlib could create the compressed data faster and more
2477  * efficiently (the compressed data format is identical to a WIM resource).  But
2478  * we seemingly don't have a choice because WOF prevents applications from
2479  * creating its reparse points.
2480  */
2481 static void
2482 handle_system_compression(struct blob_descriptor *blob, struct win32_apply_ctx *ctx)
2483 {
2484         const struct blob_extraction_target *targets = blob_extraction_targets(blob);
2485
2486         const int format = get_system_compression_format(ctx->common.extract_flags);
2487
2488         for (u32 i = 0; i < blob->out_refcnt; i++) {
2489                 struct wim_inode *inode = targets[i].inode;
2490                 struct wim_inode_stream *strm = targets[i].stream;
2491                 NTSTATUS status;
2492
2493                 if (!stream_is_unnamed_data_stream(strm))
2494                         continue;
2495
2496                 if (will_externally_back_inode(inode, ctx, NULL, false) != 0)
2497                         continue;
2498
2499                 status = set_system_compression_on_inode(inode, format, ctx);
2500                 if (likely(NT_SUCCESS(status)))
2501                         continue;
2502
2503                 if (status == STATUS_INVALID_DEVICE_REQUEST) {
2504                         WARNING(
2505           "The request to compress the extracted files using System Compression\n"
2506 "          will not be honored because the operating system or target volume\n"
2507 "          does not support it.  System Compression is only supported on\n"
2508 "          Windows 10 and later, and only on NTFS volumes.");
2509                         ctx->common.extract_flags &= ~COMPACT_FLAGS;
2510                         return;
2511                 }
2512
2513                 ctx->num_system_compression_failures++;
2514                 if (ctx->num_system_compression_failures < 10) {
2515                         winnt_warning(status, L"\"%ls\": Failed to compress "
2516                                       "extracted file using System Compression",
2517                                       current_path(ctx));
2518                 } else if (ctx->num_system_compression_failures == 10) {
2519                         WARNING("Suppressing further warnings about "
2520                                 "System Compression failures.");
2521                 }
2522         }
2523 }
2524
2525 /* Called when a blob has been fully read for extraction on Windows  */
2526 static int
2527 end_extract_blob(struct blob_descriptor *blob, int status, void *_ctx)
2528 {
2529         struct win32_apply_ctx *ctx = _ctx;
2530         int ret;
2531         const struct wim_dentry *dentry;
2532
2533         close_handles(ctx);
2534
2535         if (status)
2536                 return status;
2537
2538         if (unlikely(ctx->common.extract_flags & COMPACT_FLAGS))
2539                 handle_system_compression(blob, ctx);
2540
2541         if (likely(!ctx->data_buffer_ptr))
2542                 return 0;
2543
2544         if (!list_empty(&ctx->reparse_dentries)) {
2545                 if (blob->size > REPARSE_DATA_MAX_SIZE) {
2546                         dentry = list_first_entry(&ctx->reparse_dentries,
2547                                                   struct wim_dentry, d_tmp_list);
2548                         build_extraction_path(dentry, ctx);
2549                         ERROR("Reparse data of \"%ls\" has size "
2550                               "%"PRIu64" bytes (exceeds %u bytes)",
2551                               current_path(ctx), blob->size,
2552                               REPARSE_DATA_MAX_SIZE);
2553                         ret = WIMLIB_ERR_INVALID_REPARSE_DATA;
2554                         return check_apply_error(dentry, ctx, ret);
2555                 }
2556                 /* Reparse data  */
2557                 memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, blob->size);
2558
2559                 list_for_each_entry(dentry, &ctx->reparse_dentries, d_tmp_list) {
2560
2561                         /* Reparse point header  */
2562                         complete_reparse_point(&ctx->rpbuf, dentry->d_inode,
2563                                                blob->size);
2564
2565                         ret = set_reparse_point(dentry, &ctx->rpbuf,
2566                                                 REPARSE_DATA_OFFSET + blob->size,
2567                                                 ctx);
2568                         ret = check_apply_error(dentry, ctx, ret);
2569                         if (ret)
2570                                 return ret;
2571                 }
2572         }
2573
2574         if (!list_empty(&ctx->encrypted_dentries)) {
2575                 ctx->encrypted_size = blob->size;
2576                 list_for_each_entry(dentry, &ctx->encrypted_dentries, d_tmp_list) {
2577                         ret = extract_encrypted_file(dentry, ctx);
2578                         ret = check_apply_error(dentry, ctx, ret);
2579                         if (ret)
2580                                 return ret;
2581                         /* Re-open the target directory if needed.  */
2582                         ret = open_target_directory(ctx);
2583                         if (ret)
2584                                 return ret;
2585                 }
2586         }
2587
2588         return 0;
2589 }
2590
2591 /* Attributes that can't be set directly  */
2592 #define SPECIAL_ATTRIBUTES                      \
2593         (FILE_ATTRIBUTE_REPARSE_POINT   |       \
2594          FILE_ATTRIBUTE_DIRECTORY       |       \
2595          FILE_ATTRIBUTE_ENCRYPTED       |       \
2596          FILE_ATTRIBUTE_SPARSE_FILE     |       \
2597          FILE_ATTRIBUTE_COMPRESSED)
2598
2599 /* Set the security descriptor @desc, of @desc_size bytes, on the file with open
2600  * handle @h.  */
2601 static NTSTATUS
2602 set_security_descriptor(HANDLE h, const void *_desc,
2603                         size_t desc_size, struct win32_apply_ctx *ctx)
2604 {
2605         SECURITY_INFORMATION info;
2606         NTSTATUS status;
2607         SECURITY_DESCRIPTOR_RELATIVE *desc;
2608
2609         /*
2610          * Ideally, we would just pass in the security descriptor buffer as-is.
2611          * But it turns out that Windows can mess up the security descriptor
2612          * even when using the low-level NtSetSecurityObject() function:
2613          *
2614          * - Windows will clear SE_DACL_AUTO_INHERITED if it is set in the
2615          *   passed buffer.  To actually get Windows to set
2616          *   SE_DACL_AUTO_INHERITED, the application must set the non-persistent
2617          *   flag SE_DACL_AUTO_INHERIT_REQ.  As usual, Microsoft didn't bother
2618          *   to properly document either of these flags.  It's unclear how
2619          *   important SE_DACL_AUTO_INHERITED actually is, but to be safe we use
2620          *   the SE_DACL_AUTO_INHERIT_REQ workaround to set it if needed.
2621          *
2622          * - The above also applies to the equivalent SACL flags,
2623          *   SE_SACL_AUTO_INHERITED and SE_SACL_AUTO_INHERIT_REQ.
2624          *
2625          * - If the application says that it's setting
2626          *   DACL_SECURITY_INFORMATION, then Windows sets SE_DACL_PRESENT in the
2627          *   resulting security descriptor, even if the security descriptor the
2628          *   application provided did not have a DACL.  This seems to be
2629          *   unavoidable, since omitting DACL_SECURITY_INFORMATION would cause a
2630          *   default DACL to remain.  Fortunately, this behavior seems harmless,
2631          *   since the resulting DACL will still be "null" --- but it will be
2632          *   "the other representation of null".
2633          *
2634          * - The above also applies to SACL_SECURITY_INFORMATION and
2635          *   SE_SACL_PRESENT.  Again, it's seemingly unavoidable but "harmless"
2636          *   that Windows changes the representation of a "null SACL".
2637          */
2638         if (likely(desc_size <= STACK_MAX)) {
2639                 desc = alloca(desc_size);
2640         } else {
2641                 desc = MALLOC(desc_size);
2642                 if (!desc)
2643                         return STATUS_NO_MEMORY;
2644         }
2645
2646         memcpy(desc, _desc, desc_size);
2647
2648         if (likely(desc_size >= 4)) {
2649
2650                 if (desc->Control & SE_DACL_AUTO_INHERITED)
2651                         desc->Control |= SE_DACL_AUTO_INHERIT_REQ;
2652
2653                 if (desc->Control & SE_SACL_AUTO_INHERITED)
2654                         desc->Control |= SE_SACL_AUTO_INHERIT_REQ;
2655         }
2656
2657         /*
2658          * More API insanity.  We want to set the entire security descriptor
2659          * as-is.  But all available APIs require specifying the specific parts
2660          * of the security descriptor being set.  Especially annoying is that
2661          * mandatory integrity labels are part of the SACL, but they aren't set
2662          * with SACL_SECURITY_INFORMATION.  Instead, applications must also
2663          * specify LABEL_SECURITY_INFORMATION (Windows Vista, Windows 7) or
2664          * BACKUP_SECURITY_INFORMATION (Windows 8).  But at least older versions
2665          * of Windows don't error out if you provide these newer flags...
2666          *
2667          * Also, if the process isn't running as Administrator, then it probably
2668          * doesn't have SE_RESTORE_PRIVILEGE.  In this case, it will always get
2669          * the STATUS_PRIVILEGE_NOT_HELD error by trying to set the SACL, even
2670          * if the security descriptor it provided did not have a SACL.  By
2671          * default, in this case we try to recover and set as much of the
2672          * security descriptor as possible --- potentially excluding the DACL, and
2673          * even the owner, as well as the SACL.
2674          */
2675
2676         info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
2677                DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION |
2678                LABEL_SECURITY_INFORMATION | BACKUP_SECURITY_INFORMATION;
2679
2680
2681         /*
2682          * It's also worth noting that SetFileSecurity() is unusable because it
2683          * doesn't request "backup semantics" when it opens the file internally.
2684          * NtSetSecurityObject() seems to be the best function to use in backup
2685          * applications.  (SetSecurityInfo() should also work, but it's harder
2686          * to use and must call NtSetSecurityObject() internally anyway.
2687          * BackupWrite() is theoretically usable as well, but it's inflexible
2688          * and poorly documented.)
2689          */
2690
2691 retry:
2692         status = (*func_NtSetSecurityObject)(h, info, desc);
2693         if (NT_SUCCESS(status))
2694                 goto out_maybe_free_desc;
2695
2696         /* Failed to set the requested parts of the security descriptor.  If the
2697          * error was permissions-related, try to set fewer parts of the security
2698          * descriptor, unless WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled.  */
2699         if ((status == STATUS_PRIVILEGE_NOT_HELD ||
2700              status == STATUS_ACCESS_DENIED) &&
2701             !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2702         {
2703                 if (info & SACL_SECURITY_INFORMATION) {
2704                         info &= ~(SACL_SECURITY_INFORMATION |
2705                                   LABEL_SECURITY_INFORMATION |
2706                                   BACKUP_SECURITY_INFORMATION);
2707                         ctx->partial_security_descriptors++;
2708                         goto retry;
2709                 }
2710                 if (info & DACL_SECURITY_INFORMATION) {
2711                         info &= ~DACL_SECURITY_INFORMATION;
2712                         goto retry;
2713                 }
2714                 if (info & OWNER_SECURITY_INFORMATION) {
2715                         info &= ~OWNER_SECURITY_INFORMATION;
2716                         goto retry;
2717                 }
2718                 /* Nothing left except GROUP, and if we removed it we
2719                  * wouldn't have anything at all.  */
2720         }
2721
2722         /* No part of the security descriptor could be set, or
2723          * WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled and the full security
2724          * descriptor could not be set.  */
2725         if (!(info & SACL_SECURITY_INFORMATION))
2726                 ctx->partial_security_descriptors--;
2727         ctx->no_security_descriptors++;
2728
2729 out_maybe_free_desc:
2730         if (unlikely(desc_size > STACK_MAX))
2731                 FREE(desc);
2732         return status;
2733 }
2734
2735 /* Set metadata on the open file @h from the WIM inode @inode.  */
2736 static int
2737 do_apply_metadata_to_file(HANDLE h, const struct wim_inode *inode,
2738                           struct win32_apply_ctx *ctx)
2739 {
2740         FILE_BASIC_INFORMATION info;
2741         NTSTATUS status;
2742
2743         /* Set security descriptor if present and not in NO_ACLS mode  */
2744         if (inode_has_security_descriptor(inode) &&
2745             !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
2746         {
2747                 const struct wim_security_data *sd;
2748                 const void *desc;
2749                 size_t desc_size;
2750
2751                 sd = wim_get_current_security_data(ctx->common.wim);
2752                 desc = sd->descriptors[inode->i_security_id];
2753                 desc_size = sd->sizes[inode->i_security_id];
2754
2755                 status = set_security_descriptor(h, desc, desc_size, ctx);
2756                 if (!NT_SUCCESS(status) &&
2757                     (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2758                 {
2759                         winnt_error(status,
2760                                     L"Can't set security descriptor on \"%ls\"",
2761                                     current_path(ctx));
2762                         return WIMLIB_ERR_SET_SECURITY;
2763                 }
2764         }
2765
2766         /* Set attributes and timestamps  */
2767         info.CreationTime.QuadPart = inode->i_creation_time;
2768         info.LastAccessTime.QuadPart = inode->i_last_access_time;
2769         info.LastWriteTime.QuadPart = inode->i_last_write_time;
2770         info.ChangeTime.QuadPart = 0;
2771         if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) {
2772                 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
2773         } else {
2774                 info.FileAttributes = inode->i_attributes & ~SPECIAL_ATTRIBUTES;
2775                 if (info.FileAttributes == 0)
2776                         info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
2777         }
2778
2779         status = (*func_NtSetInformationFile)(h, &ctx->iosb,
2780                                               &info, sizeof(info),
2781                                               FileBasicInformation);
2782         /* On FAT volumes we get STATUS_INVALID_PARAMETER if we try to set
2783          * attributes on the root directory.  (Apparently because FAT doesn't
2784          * actually have a place to store those attributes!)  */
2785         if (!NT_SUCCESS(status)
2786             && !(status == STATUS_INVALID_PARAMETER &&
2787                  dentry_is_root(inode_first_extraction_dentry(inode))))
2788         {
2789                 winnt_error(status, L"Can't set basic metadata on \"%ls\"",
2790                             current_path(ctx));
2791                 return WIMLIB_ERR_SET_ATTRIBUTES;
2792         }
2793
2794         return 0;
2795 }
2796
2797 static int
2798 apply_metadata_to_file(const struct wim_dentry *dentry,
2799                        struct win32_apply_ctx *ctx)
2800 {
2801         const struct wim_inode *inode = dentry->d_inode;
2802         DWORD perms;
2803         HANDLE h;
2804         NTSTATUS status;
2805         int ret;
2806
2807         perms = FILE_WRITE_ATTRIBUTES | WRITE_DAC |
2808                 WRITE_OWNER | ACCESS_SYSTEM_SECURITY;
2809
2810         build_extraction_path(dentry, ctx);
2811
2812         /* Open a handle with as many relevant permissions as possible.  */
2813         while (!NT_SUCCESS(status = do_create_file(&h, perms, NULL,
2814                                                    0, FILE_OPEN, 0, ctx)))
2815         {
2816                 if (status == STATUS_PRIVILEGE_NOT_HELD ||
2817                     status == STATUS_ACCESS_DENIED)
2818                 {
2819                         if (perms & ACCESS_SYSTEM_SECURITY) {
2820                                 perms &= ~ACCESS_SYSTEM_SECURITY;
2821                                 continue;
2822                         }
2823                         if (perms & WRITE_DAC) {
2824                                 perms &= ~WRITE_DAC;
2825                                 continue;
2826                         }
2827                         if (perms & WRITE_OWNER) {
2828                                 perms &= ~WRITE_OWNER;
2829                                 continue;
2830                         }
2831                 }
2832                 winnt_error(status, L"Can't open \"%ls\" to set metadata",
2833                             current_path(ctx));
2834                 return WIMLIB_ERR_OPEN;
2835         }
2836
2837         ret = do_apply_metadata_to_file(h, inode, ctx);
2838
2839         (*func_NtClose)(h);
2840
2841         return ret;
2842 }
2843
2844 static int
2845 apply_metadata(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
2846 {
2847         const struct wim_dentry *dentry;
2848         int ret;
2849
2850         /* We go in reverse so that metadata is set on all a directory's
2851          * children before the directory itself.  This avoids any potential
2852          * problems with attributes, timestamps, or security descriptors.  */
2853         list_for_each_entry_reverse(dentry, dentry_list, d_extraction_list_node)
2854         {
2855                 ret = apply_metadata_to_file(dentry, ctx);
2856                 ret = check_apply_error(dentry, ctx, ret);
2857                 if (ret)
2858                         return ret;
2859                 ret = report_file_metadata_applied(&ctx->common);
2860                 if (ret)
2861                         return ret;
2862         }
2863         return 0;
2864 }
2865
2866 /* Issue warnings about problems during the extraction for which warnings were
2867  * not already issued (due to the high number of potential warnings if we issued
2868  * them per-file).  */
2869 static void
2870 do_warnings(const struct win32_apply_ctx *ctx)
2871 {
2872         if (ctx->partial_security_descriptors == 0
2873             && ctx->no_security_descriptors == 0
2874             && ctx->num_set_short_name_failures == 0
2875         #if 0
2876             && ctx->num_remove_short_name_failures == 0
2877         #endif
2878             )
2879                 return;
2880
2881         WARNING("Extraction to \"%ls\" complete, but with one or more warnings:",
2882                 ctx->common.target);
2883         if (ctx->num_set_short_name_failures) {
2884                 WARNING("- Could not set short names on %lu files or directories",
2885                         ctx->num_set_short_name_failures);
2886         }
2887 #if 0
2888         if (ctx->num_remove_short_name_failures) {
2889                 WARNING("- Could not remove short names on %lu files or directories"
2890                         "          (This is expected on Vista and earlier)",
2891                         ctx->num_remove_short_name_failures);
2892         }
2893 #endif
2894         if (ctx->partial_security_descriptors) {
2895                 WARNING("- Could only partially set the security descriptor\n"
2896                         "            on %lu files or directories.",
2897                         ctx->partial_security_descriptors);
2898         }
2899         if (ctx->no_security_descriptors) {
2900                 WARNING("- Could not set security descriptor at all\n"
2901                         "            on %lu files or directories.",
2902                         ctx->no_security_descriptors);
2903         }
2904         if (ctx->partial_security_descriptors || ctx->no_security_descriptors) {
2905                 WARNING("To fully restore all security descriptors, run the program\n"
2906                         "          with Administrator rights.");
2907         }
2908 }
2909
2910 static u64
2911 count_dentries(const struct list_head *dentry_list)
2912 {
2913         const struct list_head *cur;
2914         u64 count = 0;
2915
2916         list_for_each(cur, dentry_list)
2917                 count++;
2918
2919         return count;
2920 }
2921
2922 /* Extract files from a WIM image to a directory on Windows  */
2923 static int
2924 win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
2925 {
2926         int ret;
2927         struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
2928         u64 dentry_count;
2929
2930         ret = prepare_target(dentry_list, ctx);
2931         if (ret)
2932                 goto out;
2933
2934         if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2935                 ret = start_wimboot_extraction(dentry_list, ctx);
2936                 if (ret)
2937                         goto out;
2938         }
2939
2940         ctx->windows_build_number = xml_get_windows_build_number(ctx->common.wim->xml_info,
2941                                                                  ctx->common.wim->current_image);
2942
2943         dentry_count = count_dentries(dentry_list);
2944
2945         ret = start_file_structure_phase(&ctx->common, dentry_count);
2946         if (ret)
2947                 goto out;
2948
2949         ret = create_directories(dentry_list, ctx);
2950         if (ret)
2951                 goto out;
2952
2953         ret = create_nondirectories(dentry_list, ctx);
2954         if (ret)
2955                 goto out;
2956
2957         ret = end_file_structure_phase(&ctx->common);
2958         if (ret)
2959                 goto out;
2960
2961         struct read_blob_callbacks cbs = {
2962                 .begin_blob     = begin_extract_blob,
2963                 .consume_chunk  = extract_chunk,
2964                 .end_blob       = end_extract_blob,
2965                 .ctx            = ctx,
2966         };
2967         ret = extract_blob_list(&ctx->common, &cbs);
2968         if (ret)
2969                 goto out;
2970
2971         ret = start_file_metadata_phase(&ctx->common, dentry_count);
2972         if (ret)
2973                 goto out;
2974
2975         ret = apply_metadata(dentry_list, ctx);
2976         if (ret)
2977                 goto out;
2978
2979         ret = end_file_metadata_phase(&ctx->common);
2980         if (ret)
2981                 goto out;
2982
2983         if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2984                 ret = end_wimboot_extraction(ctx);
2985                 if (ret)
2986                         goto out;
2987         }
2988
2989         do_warnings(ctx);
2990 out:
2991         close_target_directory(ctx);
2992         if (ctx->target_ntpath.Buffer)
2993                 HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
2994         FREE(ctx->pathbuf.Buffer);
2995         FREE(ctx->print_buffer);
2996         FREE(ctx->wimboot.wims);
2997         if (ctx->prepopulate_pats) {
2998                 FREE(ctx->prepopulate_pats->strings);
2999                 FREE(ctx->prepopulate_pats);
3000         }
3001         FREE(ctx->mem_prepopulate_pats);
3002         FREE(ctx->data_buffer);
3003         return ret;
3004 }
3005
3006 const struct apply_operations win32_apply_ops = {
3007         .name                   = "Windows",
3008         .get_supported_features = win32_get_supported_features,
3009         .extract                = win32_extract,
3010         .will_back_from_wim     = win32_will_back_from_wim,
3011         .context_size           = sizeof(struct win32_apply_ctx),
3012 };
3013
3014 #endif /* __WIN32__ */