win32_apply.c: Adjust short name behavior
[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 Eric Biggers
7  *
8  * This file is part of wimlib, a library for working with WIM files.
9  *
10  * wimlib is free software; you can redistribute it and/or modify it under the
11  * terms of the GNU General Public License as published by the Free
12  * Software Foundation; either version 3 of the License, or (at your option)
13  * any later version.
14  *
15  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17  * A PARTICULAR PURPOSE. See the GNU General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with wimlib; if not, see http://www.gnu.org/licenses/.
22  */
23
24 #ifdef __WIN32__
25
26 #ifdef HAVE_CONFIG_H
27 #  include "config.h"
28 #endif
29
30 #include "wimlib/win32_common.h"
31
32 #include "wimlib/apply.h"
33 #include "wimlib/capture.h" /* for mangle_pat() and match_pattern_list()  */
34 #include "wimlib/dentry.h"
35 #include "wimlib/error.h"
36 #include "wimlib/lookup_table.h"
37 #include "wimlib/metadata.h"
38 #include "wimlib/reparse.h"
39 #include "wimlib/textfile.h"
40 #include "wimlib/xml.h"
41 #include "wimlib/wimboot.h"
42
43 struct win32_apply_ctx {
44
45         /* Extract flags, the pointer to the WIMStruct, etc.  */
46         struct apply_ctx common;
47
48         /* WIMBoot information, only filled in if WIMLIB_EXTRACT_FLAG_WIMBOOT
49          * was provided  */
50         struct {
51                 u64 data_source_id;
52                 struct string_set *prepopulate_pats;
53                 void *mem_prepopulate_pats;
54                 u8 wim_lookup_table_hash[SHA1_HASH_SIZE];
55                 bool wof_running;
56         } wimboot;
57
58         /* Open handle to the target directory  */
59         HANDLE h_target;
60
61         /* NT namespace path to the target directory (buffer allocated)  */
62         UNICODE_STRING target_ntpath;
63
64         /* Temporary buffer for building paths (buffer allocated)  */
65         UNICODE_STRING pathbuf;
66
67         /* Object attributes to reuse for opening files in the target directory.
68          * (attr.ObjectName == &pathbuf) and (attr.RootDirectory == h_target).
69          */
70         OBJECT_ATTRIBUTES attr;
71
72         /* Temporary I/O status block for system calls  */
73         IO_STATUS_BLOCK iosb;
74
75         /* Allocated buffer for creating "printable" paths from our
76          * target-relative NT paths  */
77         wchar_t *print_buffer;
78
79         /* Allocated buffer for reading stream data when it cannot be extracted
80          * directly  */
81         u8 *data_buffer;
82
83         /* Pointer to the next byte in @data_buffer to fill  */
84         u8 *data_buffer_ptr;
85
86         /* Size allocated in @data_buffer  */
87         size_t data_buffer_size;
88
89         /* Current offset in the raw encrypted file being written  */
90         size_t encrypted_offset;
91
92         /* Current size of the raw encrypted file being written  */
93         size_t encrypted_size;
94
95         /* Temporary buffer for reparse data  */
96         struct reparse_buffer_disk rpbuf;
97
98         /* Temporary buffer for reparse data of "fixed" absolute symbolic links
99          * and junctions  */
100         struct reparse_buffer_disk rpfixbuf;
101
102         /* Array of open handles to filesystem streams currently being written
103          */
104         HANDLE open_handles[MAX_OPEN_STREAMS];
105
106         /* Number of handles in @open_handles currently open (filled in from the
107          * beginning of the array)  */
108         unsigned num_open_handles;
109
110         /* List of dentries, joined by @tmp_list, that need to have reparse data
111          * extracted as soon as the whole stream has been read into
112          * @data_buffer.  */
113         struct list_head reparse_dentries;
114
115         /* List of dentries, joined by @tmp_list, that need to have raw
116          * encrypted data extracted as soon as the whole stream has been read
117          * into @data_buffer.  */
118         struct list_head encrypted_dentries;
119
120         /* Number of files for which we didn't have permission to set the full
121          * security descriptor.  */
122         unsigned long partial_security_descriptors;
123
124         /* Number of files for which we didn't have permission to set any part
125          * of the security descriptor.  */
126         unsigned long no_security_descriptors;
127
128         /* Number of files for which we couldn't set the short name.  */
129         unsigned long num_short_name_failures;
130
131         /* Have we tried to enable short name support on the target volume yet?
132          */
133         bool tried_to_enable_short_names;
134 };
135
136 /* Get the drive letter from a Windows path, or return the null character if the
137  * path is relative.  */
138 static wchar_t
139 get_drive_letter(const wchar_t *path)
140 {
141         /* Skip \\?\ prefix  */
142         if (!wcsncmp(path, L"\\\\?\\", 4))
143                 path += 4;
144
145         /* Return drive letter if valid  */
146         if (((path[0] >= L'a' && path[0] <= L'z') ||
147              (path[0] >= L'A' && path[0] <= L'Z')) && path[1] == L':')
148                 return path[0];
149
150         return L'\0';
151 }
152
153 static void
154 get_vol_flags(const wchar_t *target, DWORD *vol_flags_ret,
155               bool *short_names_supported_ret)
156 {
157         wchar_t filesystem_name[MAX_PATH + 1];
158         wchar_t drive[4];
159         wchar_t *volume = NULL;
160
161         *vol_flags_ret = 0;
162         *short_names_supported_ret = false;
163
164         drive[0] = get_drive_letter(target);
165         if (drive[0]) {
166                 drive[1] = L':';
167                 drive[2] = L'\\';
168                 drive[3] = L'\0';
169                 volume = drive;
170         }
171
172         if (!GetVolumeInformation(volume, NULL, 0, NULL, NULL,
173                                   vol_flags_ret, filesystem_name,
174                                   ARRAY_LEN(filesystem_name)))
175         {
176                 DWORD err = GetLastError();
177                 set_errno_from_win32_error(err);
178                 WARNING_WITH_ERRNO("Failed to get volume information for "
179                                    "\"%ls\" (err=%"PRIu32")",
180                                    target, (u32)err);
181                 return;
182         }
183
184         if (wcsstr(filesystem_name, L"NTFS")) {
185                 /* FILE_SUPPORTS_HARD_LINKS is only supported on Windows 7 and
186                  * later.  Force it on anyway if filesystem is NTFS.  */
187                 *vol_flags_ret |= FILE_SUPPORTS_HARD_LINKS;
188
189                 /* There's no volume flag for short names, but according to the
190                  * MS documentation they are only user-settable on NTFS.  */
191                 *short_names_supported_ret = true;
192         }
193 }
194
195 static int
196 win32_get_supported_features(const wchar_t *target,
197                              struct wim_features *supported_features)
198 {
199         DWORD vol_flags;
200         bool short_names_supported;
201
202         /* Query the features of the target volume.  */
203
204         get_vol_flags(target, &vol_flags, &short_names_supported);
205
206         supported_features->archive_files = 1;
207         supported_features->hidden_files = 1;
208         supported_features->system_files = 1;
209
210         if (vol_flags & FILE_FILE_COMPRESSION)
211                 supported_features->compressed_files = 1;
212
213         if (vol_flags & FILE_SUPPORTS_ENCRYPTION) {
214                 supported_features->encrypted_files = 1;
215                 supported_features->encrypted_directories = 1;
216         }
217
218         supported_features->not_context_indexed_files = 1;
219
220         /* Don't do anything with FILE_SUPPORTS_SPARSE_FILES.  */
221
222         if (vol_flags & FILE_NAMED_STREAMS)
223                 supported_features->named_data_streams = 1;
224
225         if (vol_flags & FILE_SUPPORTS_HARD_LINKS)
226                 supported_features->hard_links = 1;
227
228         if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS)
229                 supported_features->reparse_points = 1;
230
231         if (vol_flags & FILE_PERSISTENT_ACLS)
232                 supported_features->security_descriptors = 1;
233
234         if (short_names_supported)
235                 supported_features->short_names = 1;
236
237         supported_features->timestamps = 1;
238
239         /* Note: Windows does not support case sensitive filenames!  At least
240          * not without changing the registry and rebooting...  */
241
242         return 0;
243 }
244
245 /* Load the patterns from [PrepopulateList] of WimBootCompress.ini in the WIM
246  * image being extracted.  */
247 static int
248 load_prepopulate_pats(struct win32_apply_ctx *ctx)
249 {
250         const wchar_t *path = L"\\Windows\\System32\\WimBootCompress.ini";
251         struct wim_dentry *dentry;
252         struct wim_lookup_table_entry *lte;
253         int ret;
254         void *buf;
255         struct string_set *s;
256         void *mem;
257         struct text_file_section sec;
258
259         dentry = get_dentry(ctx->common.wim, path, WIMLIB_CASE_INSENSITIVE);
260         if (!dentry ||
261             (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
262                                               FILE_ATTRIBUTE_REPARSE_POINT |
263                                               FILE_ATTRIBUTE_ENCRYPTED)) ||
264             !(lte = inode_unnamed_lte(dentry->d_inode, ctx->common.wim->lookup_table)))
265         {
266                 WARNING("%ls does not exist in WIM image!", path);
267                 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
268         }
269
270         ret = read_full_stream_into_alloc_buf(lte, &buf);
271         if (ret)
272                 return ret;
273
274         s = CALLOC(1, sizeof(struct string_set));
275         if (!s) {
276                 FREE(buf);
277                 return WIMLIB_ERR_NOMEM;
278         }
279
280         sec.name = T("PrepopulateList");
281         sec.strings = s;
282
283         ret = do_load_text_file(path, buf, lte->size, &mem, &sec, 1,
284                                 LOAD_TEXT_FILE_REMOVE_QUOTES |
285                                         LOAD_TEXT_FILE_NO_WARNINGS,
286                                 mangle_pat);
287         BUILD_BUG_ON(OS_PREFERRED_PATH_SEPARATOR != WIM_PATH_SEPARATOR);
288         FREE(buf);
289         if (ret) {
290                 FREE(s);
291                 return ret;
292         }
293         ctx->wimboot.prepopulate_pats = s;
294         ctx->wimboot.mem_prepopulate_pats = mem;
295         return 0;
296 }
297
298 /* Returns %true if the path to @dentry matches a pattern in [PrepopulateList]
299  * of WimBootCompress.ini.  Otherwise returns %false.
300  *
301  * @dentry must have had its full path calculated.  */
302 static bool
303 in_prepopulate_list(struct wim_dentry *dentry,
304                     const struct win32_apply_ctx *ctx)
305 {
306         const struct string_set *pats = ctx->wimboot.prepopulate_pats;
307
308         if (!pats || !pats->num_strings)
309                 return false;
310
311         return match_pattern_list(dentry->_full_path,
312                                   wcslen(dentry->_full_path), pats);
313 }
314
315 /* Calculates the SHA-1 message digest of the WIM's lookup table.  */
316 static int
317 hash_lookup_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
318 {
319         return wim_reshdr_to_hash(&wim->hdr.lookup_table_reshdr, wim, hash);
320 }
321
322 /* Prepare for doing a "WIMBoot" extraction by loading patterns from
323  * [PrepopulateList] of WimBootCompress.ini and allocating a WOF data source ID
324  * on the target volume.  */
325 static int
326 start_wimboot_extraction(struct win32_apply_ctx *ctx)
327 {
328         int ret;
329         WIMStruct *wim = ctx->common.wim;
330
331         ret = load_prepopulate_pats(ctx);
332         if (ret == WIMLIB_ERR_NOMEM)
333                 return ret;
334
335         if (!wim_info_get_wimboot(wim->wim_info, wim->current_image))
336                 WARNING("Image is not marked as WIMBoot compatible!");
337
338         ret = hash_lookup_table(ctx->common.wim,
339                                 ctx->wimboot.wim_lookup_table_hash);
340         if (ret)
341                 return ret;
342
343         return wimboot_alloc_data_source_id(wim->filename,
344                                             wim->hdr.guid,
345                                             wim->current_image,
346                                             ctx->common.target,
347                                             &ctx->wimboot.data_source_id,
348                                             &ctx->wimboot.wof_running);
349 }
350
351 static void
352 build_win32_extraction_path(const struct wim_dentry *dentry,
353                             struct win32_apply_ctx *ctx);
354
355 /* Sets WimBoot=1 in the extracted SYSTEM registry hive.
356  *
357  * WIMGAPI does this, and it's possible that it's important.
358  * But I don't know exactly what this value means to Windows.  */
359 static int
360 end_wimboot_extraction(struct win32_apply_ctx *ctx)
361 {
362         struct wim_dentry *dentry;
363         wchar_t subkeyname[32];
364         LONG res;
365         LONG res2;
366         HKEY key;
367         DWORD value;
368
369         dentry = get_dentry(ctx->common.wim, L"\\Windows\\System32\\config\\SYSTEM",
370                             WIMLIB_CASE_INSENSITIVE);
371
372         if (!dentry || !will_extract_dentry(dentry))
373                 goto out;
374
375         if (!will_extract_dentry(wim_get_current_root_dentry(ctx->common.wim)))
376                 goto out;
377
378         /* Not bothering to use the native routines (e.g. NtLoadKey()) for this.
379          * If this doesn't work, you probably also have many other problems.  */
380
381         build_win32_extraction_path(dentry, ctx);
382
383         randomize_char_array_with_alnum(subkeyname, 20);
384         subkeyname[20] = L'\0';
385
386         res = RegLoadKey(HKEY_LOCAL_MACHINE, subkeyname, ctx->pathbuf.Buffer);
387         if (res)
388                 goto out_check_res;
389
390         wcscpy(&subkeyname[20], L"\\Setup");
391
392         res = RegCreateKeyEx(HKEY_LOCAL_MACHINE, subkeyname, 0, NULL,
393                              REG_OPTION_BACKUP_RESTORE, 0, NULL, &key, NULL);
394         if (res)
395                 goto out_unload_key;
396
397         value = 1;
398
399         res = RegSetValueEx(key, L"WimBoot", 0, REG_DWORD,
400                             (const BYTE *)&value, sizeof(DWORD));
401         if (res)
402                 goto out_close_key;
403
404         res = RegFlushKey(key);
405
406 out_close_key:
407         res2 = RegCloseKey(key);
408         if (!res)
409                 res = res2;
410 out_unload_key:
411         subkeyname[20] = L'\0';
412         RegUnLoadKey(HKEY_LOCAL_MACHINE, subkeyname);
413 out_check_res:
414         if (res) {
415                 /* Warning only.  */
416                 set_errno_from_win32_error(res);
417                 WARNING_WITH_ERRNO("Failed to set \\Setup: dword \"WimBoot\"=1 value "
418                                    "in registry hive \"%ls\" (err=%"PRIu32")",
419                                    ctx->pathbuf.Buffer, (u32)res);
420         }
421 out:
422         return 0;
423 }
424
425 /* Returns the number of wide characters needed to represent the path to the
426  * specified @dentry, relative to the target directory, when extracted.
427  *
428  * Does not include null terminator (not needed for NtCreateFile).  */
429 static size_t
430 dentry_extraction_path_length(const struct wim_dentry *dentry)
431 {
432         size_t len = 0;
433         const struct wim_dentry *d;
434
435         d = dentry;
436         do {
437                 len += d->d_extraction_name_nchars + 1;
438                 d = d->d_parent;
439         } while (!dentry_is_root(d) && will_extract_dentry(d));
440
441         return --len;  /* No leading slash  */
442 }
443
444 /* Returns the length of the longest string that might need to be appended to
445  * the path to an alias of an inode to open or create a named data stream.
446  *
447  * If the inode has no named data streams, this will be 0.  Otherwise, this will
448  * be 1 plus the length of the longest-named data stream, since the data stream
449  * name must be separated from the path by the ':' character.  */
450 static size_t
451 inode_longest_named_data_stream_spec(const struct wim_inode *inode)
452 {
453         size_t max = 0;
454         for (u16 i = 0; i < inode->i_num_ads; i++) {
455                 size_t len = inode->i_ads_entries[i].stream_name_nbytes;
456                 if (len > max)
457                         max = len;
458         }
459         if (max)
460                 max = 1 + (max / sizeof(wchar_t));
461         return max;
462 }
463
464 /* Find the length, in wide characters, of the longest path needed for
465  * extraction of any file in @dentry_list relative to the target directory.
466  *
467  * Accounts for named data streams, but does not include null terminator (not
468  * needed for NtCreateFile).  */
469 static size_t
470 compute_path_max(struct list_head *dentry_list)
471 {
472         size_t max = 0;
473         const struct wim_dentry *dentry;
474
475         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
476                 size_t len;
477
478                 len = dentry_extraction_path_length(dentry);
479
480                 /* Account for named data streams  */
481                 len += inode_longest_named_data_stream_spec(dentry->d_inode);
482
483                 if (len > max)
484                         max = len;
485         }
486
487         return max;
488 }
489
490 /* Build the path at which to extract the @dentry, relative to the target
491  * directory.
492  *
493  * The path is saved in ctx->pathbuf.  */
494 static void
495 build_extraction_path(const struct wim_dentry *dentry,
496                       struct win32_apply_ctx *ctx)
497 {
498         size_t len;
499         wchar_t *p;
500         const struct wim_dentry *d;
501
502         len = dentry_extraction_path_length(dentry);
503
504         ctx->pathbuf.Length = len * sizeof(wchar_t);
505         p = ctx->pathbuf.Buffer + len;
506         for (d = dentry;
507              !dentry_is_root(d->d_parent) && will_extract_dentry(d->d_parent);
508              d = d->d_parent)
509         {
510                 p -= d->d_extraction_name_nchars;
511                 wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
512                 *--p = '\\';
513         }
514         /* No leading slash  */
515         p -= d->d_extraction_name_nchars;
516         wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
517 }
518
519 /* Build the path at which to extract the @dentry, relative to the target
520  * directory, adding the suffix for a named data stream.
521  *
522  * The path is saved in ctx->pathbuf.  */
523 static void
524 build_extraction_path_with_ads(const struct wim_dentry *dentry,
525                                struct win32_apply_ctx *ctx,
526                                const wchar_t *stream_name,
527                                size_t stream_name_nchars)
528 {
529         wchar_t *p;
530
531         build_extraction_path(dentry, ctx);
532
533         /* Add :NAME for named data stream  */
534         p = ctx->pathbuf.Buffer + (ctx->pathbuf.Length / sizeof(wchar_t));
535         *p++ = L':';
536         wmemcpy(p, stream_name, stream_name_nchars);
537         ctx->pathbuf.Length += (1 + stream_name_nchars) * sizeof(wchar_t);
538 }
539
540 /* Build the Win32 namespace path to the specified @dentry when extracted.
541  *
542  * The path is saved in ctx->pathbuf and will be null terminated.
543  *
544  * XXX: We could get rid of this if it wasn't needed for the file encryption
545  * APIs, and the registry manipulation in WIMBoot mode.  */
546 static void
547 build_win32_extraction_path(const struct wim_dentry *dentry,
548                             struct win32_apply_ctx *ctx)
549 {
550         build_extraction_path(dentry, ctx);
551
552         /* Prepend target_ntpath to our relative path, then change \??\ into \\?\  */
553
554         memmove(ctx->pathbuf.Buffer +
555                         (ctx->target_ntpath.Length / sizeof(wchar_t)) + 1,
556                 ctx->pathbuf.Buffer, ctx->pathbuf.Length);
557         memcpy(ctx->pathbuf.Buffer, ctx->target_ntpath.Buffer,
558                 ctx->target_ntpath.Length);
559         ctx->pathbuf.Buffer[ctx->target_ntpath.Length / sizeof(wchar_t)] = L'\\';
560         ctx->pathbuf.Length += ctx->target_ntpath.Length + sizeof(wchar_t);
561         ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)] = L'\0';
562
563         wimlib_assert(ctx->pathbuf.Length >= 4 * sizeof(wchar_t) &&
564                       !wmemcmp(ctx->pathbuf.Buffer, L"\\??\\", 4));
565
566         ctx->pathbuf.Buffer[1] = L'\\';
567
568 }
569
570 /* Returns a "printable" representation of the last relative NT path that was
571  * constructed with build_extraction_path() or build_extraction_path_with_ads().
572  *
573  * This will be overwritten by the next call to this function.  */
574 static const wchar_t *
575 current_path(struct win32_apply_ctx *ctx)
576 {
577         wchar_t *p = ctx->print_buffer;
578
579         p = wmempcpy(p, ctx->common.target, ctx->common.target_nchars);
580         *p++ = L'\\';
581         p = wmempcpy(p, ctx->pathbuf.Buffer, ctx->pathbuf.Length / sizeof(wchar_t));
582         *p = L'\0';
583         return ctx->print_buffer;
584 }
585
586 /*
587  * Ensures the target directory exists and opens a handle to it, in preparation
588  * of using paths relative to it.
589  */
590 static int
591 prepare_target(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
592 {
593         int ret;
594         NTSTATUS status;
595         size_t path_max;
596
597         /* Open handle to the target directory (possibly creating it).  */
598
599         ret = win32_path_to_nt_path(ctx->common.target, &ctx->target_ntpath);
600         if (ret)
601                 return ret;
602
603         ctx->attr.Length = sizeof(ctx->attr);
604         ctx->attr.ObjectName = &ctx->target_ntpath;
605
606         status = (*func_NtCreateFile)(&ctx->h_target,
607                                       FILE_TRAVERSE,
608                                       &ctx->attr,
609                                       &ctx->iosb,
610                                       NULL,
611                                       0,
612                                       FILE_SHARE_VALID_FLAGS,
613                                       FILE_OPEN_IF,
614                                       FILE_DIRECTORY_FILE |
615                                               FILE_OPEN_REPARSE_POINT |
616                                               FILE_OPEN_FOR_BACKUP_INTENT,
617                                       NULL,
618                                       0);
619
620         if (!NT_SUCCESS(status)) {
621                 set_errno_from_nt_status(status);
622                 ERROR_WITH_ERRNO("Can't open or create directory \"%ls\" "
623                                  "(status=0x%08"PRIx32")",
624                                  ctx->common.target, (u32)status);
625                 return WIMLIB_ERR_OPENDIR;
626         }
627
628         path_max = compute_path_max(dentry_list);
629
630         /* Add some extra for building Win32 paths for the file encryption APIs
631          * ...  */
632         path_max += 2 + (ctx->target_ntpath.Length / sizeof(wchar_t));
633
634         ctx->pathbuf.MaximumLength = path_max * sizeof(wchar_t);
635         ctx->pathbuf.Buffer = MALLOC(ctx->pathbuf.MaximumLength);
636         if (!ctx->pathbuf.Buffer)
637                 return WIMLIB_ERR_NOMEM;
638
639         ctx->attr.RootDirectory = ctx->h_target;
640         ctx->attr.ObjectName = &ctx->pathbuf;
641
642         ctx->print_buffer = MALLOC((ctx->common.target_nchars + 1 + path_max + 1) *
643                                    sizeof(wchar_t));
644         if (!ctx->print_buffer)
645                 return WIMLIB_ERR_NOMEM;
646
647         return 0;
648 }
649
650 /* When creating an inode that will have a short (DOS) name, we create it using
651  * the long name associated with the short name.  This ensures that the short
652  * name gets associated with the correct long name.  */
653 static const struct wim_dentry *
654 first_extraction_alias(const struct wim_inode *inode)
655 {
656         const struct list_head *next = inode->i_extraction_aliases.next;
657         const struct wim_dentry *dentry;
658
659         do {
660                 dentry = list_entry(next, struct wim_dentry,
661                                     d_extraction_alias_node);
662                 if (dentry_has_short_name(dentry))
663                         break;
664                 next = next->next;
665         } while (next != &inode->i_extraction_aliases);
666         return dentry;
667 }
668
669 /*
670  * Set or clear FILE_ATTRIBUTE_COMPRESSED if the inherited value is different
671  * from the desired value.
672  *
673  * Note that you can NOT override the inherited value of
674  * FILE_ATTRIBUTE_COMPRESSED directly with NtCreateFile().
675  */
676 static int
677 adjust_compression_attribute(HANDLE h, const struct wim_dentry *dentry,
678                              struct win32_apply_ctx *ctx)
679 {
680         const bool compressed = (dentry->d_inode->i_attributes &
681                                  FILE_ATTRIBUTE_COMPRESSED);
682
683         if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
684                 return 0;
685
686         if (!ctx->common.supported_features.compressed_files)
687                 return 0;
688
689         FILE_BASIC_INFORMATION info;
690         NTSTATUS status;
691         USHORT compression_state;
692
693         /* Get current attributes  */
694         status = (*func_NtQueryInformationFile)(h, &ctx->iosb,
695                                                 &info, sizeof(info),
696                                                 FileBasicInformation);
697         if (NT_SUCCESS(status) &&
698             compressed == !!(info.FileAttributes & FILE_ATTRIBUTE_COMPRESSED))
699         {
700                 /* Nothing needs to be done.  */
701                 return 0;
702         }
703
704         /* Set the new compression state  */
705
706         if (compressed)
707                 compression_state = COMPRESSION_FORMAT_DEFAULT;
708         else
709                 compression_state = COMPRESSION_FORMAT_NONE;
710
711         status = (*func_NtFsControlFile)(h,
712                                          NULL,
713                                          NULL,
714                                          NULL,
715                                          &ctx->iosb,
716                                          FSCTL_SET_COMPRESSION,
717                                          &compression_state,
718                                          sizeof(USHORT),
719                                          NULL,
720                                          0);
721         if (NT_SUCCESS(status))
722                 return 0;
723
724         set_errno_from_nt_status(status);
725         ERROR_WITH_ERRNO("Can't %s compression attribute on \"%ls\" "
726                          "(status=0x%08"PRIx32")",
727                          (compressed ? "set" : "clear"),
728                          current_path(ctx), status);
729         return WIMLIB_ERR_SET_ATTRIBUTES;
730 }
731
732 /*
733  * Clear FILE_ATTRIBUTE_ENCRYPTED if the file or directory is not supposed to be
734  * encrypted.
735  *
736  * You can provide FILE_ATTRIBUTE_ENCRYPTED to NtCreateFile() to set it on the
737  * created file.  However, the file or directory will otherwise default to the
738  * encryption state of the parent directory.  This function works around this
739  * limitation by using DecryptFile() to remove FILE_ATTRIBUTE_ENCRYPTED on files
740  * (and directories) that are not supposed to have it set.
741  *
742  * Regardless of whether it succeeds or fails, this function may close the
743  * handle to the file.  If it does, it sets it to NULL.
744  */
745 static int
746 maybe_clear_encryption_attribute(HANDLE *h_ptr, const struct wim_dentry *dentry,
747                                  struct win32_apply_ctx *ctx)
748 {
749         if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
750                 return 0;
751
752         if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
753                 return 0;
754
755         if (!ctx->common.supported_features.encrypted_files)
756                 return 0;
757
758         FILE_BASIC_INFORMATION info;
759         NTSTATUS status;
760         BOOL bret;
761
762         /* Get current attributes  */
763         status = (*func_NtQueryInformationFile)(*h_ptr, &ctx->iosb,
764                                                 &info, sizeof(info),
765                                                 FileBasicInformation);
766         if (NT_SUCCESS(status) &&
767             !(info.FileAttributes & FILE_ATTRIBUTE_ENCRYPTED))
768         {
769                 /* Nothing needs to be done.  */
770                 return 0;
771         }
772
773         /* Set the new encryption state  */
774
775         /* Due to Windows' crappy file encryption APIs, we need to close the
776          * handle to the file so we don't get ERROR_SHARING_VIOLATION.  We also
777          * hack together a Win32 path, although we will use the \\?\ prefix so
778          * it will actually be a NT path in disguise...  */
779         (*func_NtClose)(*h_ptr);
780         *h_ptr = NULL;
781
782         build_win32_extraction_path(dentry, ctx);
783
784         bret = DecryptFile(ctx->pathbuf.Buffer, 0);
785
786         /* Restore the NT namespace path  */
787         build_extraction_path(dentry, ctx);
788
789         if (!bret) {
790                 DWORD err = GetLastError();
791                 set_errno_from_win32_error(err);
792                 ERROR_WITH_ERRNO("Can't decrypt file \"%ls\" (err=%"PRIu32")",
793                                   current_path(ctx), (u32)err);
794                 return WIMLIB_ERR_SET_ATTRIBUTES;
795         }
796         return 0;
797 }
798
799 /* Try to enable short name support on the target volume.  If successful, return
800  * true.  If unsuccessful, issue a warning and return false.  */
801 static bool
802 try_to_enable_short_names(struct win32_apply_ctx *ctx)
803 {
804         FILE_FS_PERSISTENT_VOLUME_INFORMATION info;
805         NTSTATUS status;
806
807         info.VolumeFlags = 0;
808         info.FlagMask = PERSISTENT_VOLUME_STATE_SHORT_NAME_CREATION_DISABLED;
809         info.Version = 1;
810         info.Reserved = 0;
811
812         status = (*func_NtFsControlFile)(ctx->h_target, NULL, NULL, NULL,
813                                          &ctx->iosb,
814                                          FSCTL_SET_PERSISTENT_VOLUME_STATE,
815                                          &info, sizeof(info), NULL, 0);
816         if (!NT_SUCCESS(status)) {
817                 WARNING("Failed to enable short name support on target volume "
818                         "(status=0x%08"PRIx32")", (u32)status);
819                 return false;
820         }
821
822         return true;
823 }
824
825 /* Set the short name on the open file @h which has been created at the location
826  * indicated by @dentry.
827  *
828  * Note that this may add, change, or remove the short name.
829  *
830  * @h must be opened with DELETE access.
831  *
832  * Returns 0 or WIMLIB_ERR_SET_SHORT_NAME.  The latter only happens in
833  * STRICT_SHORT_NAMES mode.
834  */
835 static int
836 set_short_name(HANDLE h, const struct wim_dentry *dentry,
837                struct win32_apply_ctx *ctx)
838 {
839
840         if (!ctx->common.supported_features.short_names)
841                 return 0;
842
843         size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
844                          dentry->short_name_nbytes;
845         u8 buf[bufsize] _aligned_attribute(8);
846         FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
847         NTSTATUS status;
848
849         info->FileNameLength = dentry->short_name_nbytes;
850         memcpy(info->FileName, dentry->short_name, dentry->short_name_nbytes);
851
852
853 retry:
854         status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
855                                               FileShortNameInformation);
856         if (NT_SUCCESS(status))
857                 return 0;
858
859         if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
860                 if (dentry->short_name_nbytes == 0)
861                         return 0;
862                 if (!ctx->tried_to_enable_short_names) {
863                         ctx->tried_to_enable_short_names = true;
864                         if (try_to_enable_short_names(ctx))
865                                 goto retry;
866                 }
867         }
868
869         /* By default, failure to set short names is not an error (since short
870          * names aren't too important anymore...).  */
871         if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
872                 ctx->num_short_name_failures++;
873                 return 0;
874         }
875
876         if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
877                 ERROR("Can't set short name when short "
878                       "names are not enabled on the volume!");
879         } else {
880                 ERROR("Can't set short name on \"%ls\" (status=0x%08"PRIx32")",
881                       current_path(ctx), (u32)status);
882         }
883         return WIMLIB_ERR_SET_SHORT_NAME;
884 }
885
886 /*
887  * A wrapper around NtCreateFile() to make it slightly more usable...
888  * This uses the path currently constructed in ctx->pathbuf.
889  *
890  * Also, we always specify FILE_OPEN_FOR_BACKUP_INTENT and
891  * FILE_OPEN_REPARSE_POINT.
892  */
893 static NTSTATUS
894 do_create_file(PHANDLE FileHandle,
895                ACCESS_MASK DesiredAccess,
896                PLARGE_INTEGER AllocationSize,
897                ULONG FileAttributes,
898                ULONG CreateDisposition,
899                ULONG CreateOptions,
900                struct win32_apply_ctx *ctx)
901 {
902         return (*func_NtCreateFile)(FileHandle,
903                                     DesiredAccess,
904                                     &ctx->attr,
905                                     &ctx->iosb,
906                                     AllocationSize,
907                                     FileAttributes,
908                                     FILE_SHARE_VALID_FLAGS,
909                                     CreateDisposition,
910                                     CreateOptions |
911                                         FILE_OPEN_FOR_BACKUP_INTENT |
912                                         FILE_OPEN_REPARSE_POINT,
913                                     NULL,
914                                     0);
915 }
916
917 /* Like do_create_file(), but builds the extraction path of the @dentry first.
918  */
919 static NTSTATUS
920 create_file(PHANDLE FileHandle,
921             ACCESS_MASK DesiredAccess,
922             PLARGE_INTEGER AllocationSize,
923             ULONG FileAttributes,
924             ULONG CreateDisposition,
925             ULONG CreateOptions,
926             const struct wim_dentry *dentry,
927             struct win32_apply_ctx *ctx)
928 {
929         build_extraction_path(dentry, ctx);
930         return do_create_file(FileHandle,
931                               DesiredAccess,
932                               AllocationSize,
933                               FileAttributes,
934                               CreateDisposition,
935                               CreateOptions,
936                               ctx);
937 }
938
939 /* Create empty named data streams.
940  *
941  * Since these won't have 'struct wim_lookup_table_entry's, they won't show up
942  * in the call to extract_stream_list().  Hence the need for the special case.
943  */
944 static int
945 create_any_empty_ads(const struct wim_dentry *dentry,
946                      struct win32_apply_ctx *ctx)
947 {
948         const struct wim_inode *inode = dentry->d_inode;
949         LARGE_INTEGER allocation_size;
950         bool path_modified = false;
951         int ret = 0;
952
953         if (!ctx->common.supported_features.named_data_streams)
954                 return 0;
955
956         for (u16 i = 0; i < inode->i_num_ads; i++) {
957                 const struct wim_ads_entry *entry;
958                 NTSTATUS status;
959                 HANDLE h;
960
961                 entry = &inode->i_ads_entries[i];
962
963                 /* Not named?  */
964                 if (!entry->stream_name_nbytes)
965                         continue;
966
967                 /* Not empty?  */
968                 if (entry->lte)
969                         continue;
970
971                 /* Probably setting the allocation size to 0 has no effect, but
972                  * we might as well try.  */
973                 allocation_size.QuadPart = 0;
974
975                 build_extraction_path_with_ads(dentry, ctx,
976                                                entry->stream_name,
977                                                entry->stream_name_nbytes /
978                                                         sizeof(wchar_t));
979                 path_modified = true;
980                 status = do_create_file(&h, FILE_WRITE_DATA, &allocation_size,
981                                         0, FILE_SUPERSEDE, 0, ctx);
982                 if (!NT_SUCCESS(status)) {
983                         set_errno_from_nt_status(status);
984                         ERROR_WITH_ERRNO("Can't create \"%ls\" "
985                                          "(status=0x%08"PRIx32")",
986                                          current_path(ctx), (u32)status);
987                         ret = WIMLIB_ERR_OPEN;
988                         break;
989                 }
990                 (*func_NtClose)(h);
991         }
992         /* Restore the path to the dentry itself  */
993         if (path_modified)
994                 build_extraction_path(dentry, ctx);
995         return ret;
996 }
997
998 /*
999  * Creates the directory named by @dentry, or uses an existing directory at that
1000  * location.  If necessary, sets the short name and/or fixes compression and
1001  * encryption attributes.
1002  *
1003  * Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
1004  */
1005 static int
1006 create_directory(const struct wim_dentry *dentry,
1007                  struct win32_apply_ctx *ctx)
1008 {
1009         HANDLE h;
1010         NTSTATUS status;
1011         int ret;
1012         ULONG attrib;
1013
1014         /* Special attributes:
1015          *
1016          * Use FILE_ATTRIBUTE_ENCRYPTED if the directory needs to have it set.
1017          * This doesn't work for FILE_ATTRIBUTE_COMPRESSED (unfortunately).
1018          *
1019          * Don't specify FILE_ATTRIBUTE_DIRECTORY; it gets set anyway as a
1020          * result of the FILE_DIRECTORY_FILE option.  */
1021         attrib = (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED);
1022
1023         /* DELETE is needed for set_short_name().
1024          * GENERIC_READ and GENERIC_WRITE are needed for
1025          * adjust_compression_attribute().  */
1026         status = create_file(&h, GENERIC_READ | GENERIC_WRITE | DELETE, NULL,
1027                              attrib, FILE_OPEN_IF, FILE_DIRECTORY_FILE,
1028                              dentry, ctx);
1029         if (!NT_SUCCESS(status)) {
1030                 set_errno_from_nt_status(status);
1031                 ERROR_WITH_ERRNO("Can't create directory \"%ls\" "
1032                                  "(status=0x%08"PRIx32")",
1033                                  current_path(ctx), (u32)status);
1034                 return WIMLIB_ERR_MKDIR;
1035         }
1036
1037         ret = set_short_name(h, dentry, ctx);
1038
1039         if (!ret)
1040                 ret = adjust_compression_attribute(h, dentry, ctx);
1041
1042         if (!ret)
1043                 ret = maybe_clear_encryption_attribute(&h, dentry, ctx);
1044                 /* May close the handle!!! */
1045
1046         if (h)
1047                 (*func_NtClose)(h);
1048         return ret;
1049 }
1050
1051 /*
1052  * Create all the directories being extracted, other than the target directory
1053  * itself.
1054  *
1055  * Note: we don't honor directory hard links.  However, we don't allow them to
1056  * exist in WIM images anyway (see inode_fixup.c).
1057  */
1058 static int
1059 create_directories(struct list_head *dentry_list,
1060                    struct win32_apply_ctx *ctx)
1061 {
1062         const struct wim_dentry *dentry;
1063         int ret;
1064
1065         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1066
1067                 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
1068                         continue;
1069
1070                 /* Note: Here we include files with
1071                  * FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
1072                  * wait until later to actually set the reparse data.  */
1073
1074                 /* If the root dentry is being extracted, it was already done so
1075                  * in prepare_target().  */
1076                 if (dentry_is_root(dentry))
1077                         continue;
1078
1079                 ret = create_directory(dentry, ctx);
1080                 if (ret)
1081                         return ret;
1082
1083                 ret = create_any_empty_ads(dentry, ctx);
1084                 if (ret)
1085                         return ret;
1086
1087                 ret = report_file_created(&ctx->common);
1088                 if (ret)
1089                         return ret;
1090         }
1091         return 0;
1092 }
1093
1094 /*
1095  * Creates the nondirectory file named by @dentry.
1096  *
1097  * On success, returns an open handle to the file in @h_ret, with GENERIC_READ,
1098  * GENERIC_WRITE, and DELETE access.  Also, the path to the file will be saved
1099  * in ctx->pathbuf.  On failure, returns WIMLIB_ERR_OPEN.
1100  */
1101 static int
1102 create_nondirectory_inode(HANDLE *h_ret, const struct wim_dentry *dentry,
1103                           struct win32_apply_ctx *ctx)
1104 {
1105         const struct wim_inode *inode;
1106         ULONG attrib;
1107         NTSTATUS status;
1108         bool retried = false;
1109
1110         inode = dentry->d_inode;
1111
1112         /* If the file already exists and has FILE_ATTRIBUTE_SYSTEM and/or
1113          * FILE_ATTRIBUTE_HIDDEN, these must be specified in order to supersede
1114          * the file.
1115          *
1116          * Normally the user shouldn't be trying to overwrite such files anyway,
1117          * but we at least provide FILE_ATTRIBUTE_SYSTEM and
1118          * FILE_ATTRIBUTE_HIDDEN if the WIM inode has those attributes so that
1119          * we catch the case where the user extracts the same files to the same
1120          * location more than one time.
1121          *
1122          * Also specify FILE_ATTRIBUTE_ENCRYPTED if the file needs to be
1123          * encrypted.
1124          *
1125          * In NO_ATTRIBUTES mode just don't specify any attributes at all.
1126          */
1127         if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) {
1128                 attrib = 0;
1129         } else {
1130                 attrib = (inode->i_attributes & (FILE_ATTRIBUTE_SYSTEM |
1131                                                  FILE_ATTRIBUTE_HIDDEN |
1132                                                  FILE_ATTRIBUTE_ENCRYPTED));
1133         }
1134         build_extraction_path(dentry, ctx);
1135 retry:
1136         status = do_create_file(h_ret, GENERIC_READ | GENERIC_WRITE | DELETE,
1137                                 NULL, attrib, FILE_SUPERSEDE,
1138                                 FILE_NON_DIRECTORY_FILE, ctx);
1139         if (NT_SUCCESS(status)) {
1140                 int ret;
1141
1142                 ret = adjust_compression_attribute(*h_ret, dentry, ctx);
1143                 if (ret) {
1144                         (*func_NtClose)(*h_ret);
1145                         return ret;
1146                 }
1147
1148                 ret = maybe_clear_encryption_attribute(h_ret, dentry, ctx);
1149                 /* May close the handle!!! */
1150
1151                 if (ret) {
1152                         if (*h_ret)
1153                                 (*func_NtClose)(*h_ret);
1154                         return ret;
1155                 }
1156
1157                 if (!*h_ret) {
1158                         /* Re-open the handle so that we can return it on
1159                          * success.  */
1160                         status = do_create_file(h_ret,
1161                                                 GENERIC_READ |
1162                                                         GENERIC_WRITE | DELETE,
1163                                                 NULL, 0, FILE_OPEN,
1164                                                 FILE_NON_DIRECTORY_FILE, ctx);
1165                         if (!NT_SUCCESS(status))
1166                                 goto fail;
1167                 }
1168
1169                 ret = create_any_empty_ads(dentry, ctx);
1170                 if (ret) {
1171                         (*func_NtClose)(*h_ret);
1172                         return ret;
1173                 }
1174                 return 0;
1175         }
1176
1177         if (status == STATUS_ACCESS_DENIED && !retried) {
1178                 /* We also can't supersede an existing file that has
1179                  * FILE_ATTRIBUTE_READONLY set; doing so causes NtCreateFile()
1180                  * to return STATUS_ACCESS_DENIED .  The only workaround seems
1181                  * to be to explicitly remove FILE_ATTRIBUTE_READONLY on the
1182                  * existing file, then try again.  */
1183
1184                 FILE_BASIC_INFORMATION info;
1185                 HANDLE h;
1186
1187                 status = do_create_file(&h, FILE_WRITE_ATTRIBUTES, NULL, 0,
1188                                         FILE_OPEN, FILE_NON_DIRECTORY_FILE, ctx);
1189                 if (!NT_SUCCESS(status))
1190                         goto fail;
1191
1192                 memset(&info, 0, sizeof(info));
1193                 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
1194
1195                 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1196                                                       &info, sizeof(info),
1197                                                       FileBasicInformation);
1198                 (*func_NtClose)(h);
1199                 if (!NT_SUCCESS(status))
1200                         goto fail;
1201                 retried = true;
1202                 goto retry;
1203         }
1204 fail:
1205         set_errno_from_nt_status(status);
1206         ERROR_WITH_ERRNO("Can't create file \"%ls\" (status=0x%08"PRIx32")",
1207                          current_path(ctx), (u32)status);
1208         return WIMLIB_ERR_OPEN;
1209 }
1210
1211 /* Creates a hard link at the location named by @dentry to the file represented
1212  * by the open handle @h.  Or, if the target volume does not support hard links,
1213  * create a separate file instead.  */
1214 static int
1215 create_link(HANDLE h, const struct wim_dentry *dentry,
1216             struct win32_apply_ctx *ctx)
1217 {
1218         if (ctx->common.supported_features.hard_links) {
1219
1220                 build_extraction_path(dentry, ctx);
1221
1222                 size_t bufsize = offsetof(FILE_LINK_INFORMATION, FileName) +
1223                                  ctx->pathbuf.Length + sizeof(wchar_t);
1224                 u8 buf[bufsize] _aligned_attribute(8);
1225                 FILE_LINK_INFORMATION *info = (FILE_LINK_INFORMATION *)buf;
1226                 NTSTATUS status;
1227
1228                 info->ReplaceIfExists = TRUE;
1229                 info->RootDirectory = ctx->attr.RootDirectory;
1230                 info->FileNameLength = ctx->pathbuf.Length;
1231                 memcpy(info->FileName, ctx->pathbuf.Buffer, ctx->pathbuf.Length);
1232                 info->FileName[info->FileNameLength / 2] = L'\0';
1233
1234                 /* Note: the null terminator isn't actually necessary,
1235                  * but if you don't add the extra character, you get
1236                  * STATUS_INFO_LENGTH_MISMATCH when FileNameLength
1237                  * happens to be 2  */
1238
1239                 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1240                                                       info, bufsize,
1241                                                       FileLinkInformation);
1242                 if (NT_SUCCESS(status))
1243                         return 0;
1244                 ERROR("Failed to create link \"%ls\" (status=0x%08"PRIx32")",
1245                       current_path(ctx), (u32)status);
1246                 return WIMLIB_ERR_LINK;
1247         } else {
1248                 HANDLE h2;
1249                 int ret;
1250
1251                 ret = create_nondirectory_inode(&h2, dentry, ctx);
1252                 if (ret)
1253                         return ret;
1254
1255                 (*func_NtClose)(h2);
1256                 return 0;
1257         }
1258 }
1259
1260 /* Given an inode (represented by the open handle @h) for which one link has
1261  * been created (named by @first_dentry), create the other links.
1262  *
1263  * Or, if the target volume does not support hard links, create separate files.
1264  *
1265  * Note: This uses ctx->pathbuf and does not reset it.
1266  */
1267 static int
1268 create_links(HANDLE h, const struct wim_dentry *first_dentry,
1269              struct win32_apply_ctx *ctx)
1270 {
1271         const struct wim_inode *inode;
1272         const struct list_head *next;
1273         const struct wim_dentry *dentry;
1274         int ret;
1275
1276         inode = first_dentry->d_inode;
1277         next = inode->i_extraction_aliases.next;
1278         do {
1279                 dentry = list_entry(next, struct wim_dentry,
1280                                     d_extraction_alias_node);
1281                 if (dentry != first_dentry) {
1282                         ret = create_link(h, dentry, ctx);
1283                         if (ret)
1284                                 return ret;
1285                 }
1286                 next = next->next;
1287         } while (next != &inode->i_extraction_aliases);
1288         return 0;
1289 }
1290
1291 /* Create a nondirectory file, including all links.  */
1292 static int
1293 create_nondirectory(const struct wim_inode *inode, struct win32_apply_ctx *ctx)
1294 {
1295         const struct wim_dentry *first_dentry;
1296         HANDLE h;
1297         int ret;
1298
1299         first_dentry = first_extraction_alias(inode);
1300
1301         /* Create first link.  */
1302         ret = create_nondirectory_inode(&h, first_dentry, ctx);
1303         if (ret)
1304                 return ret;
1305
1306         /* Set short name.  */
1307         ret = set_short_name(h, first_dentry, ctx);
1308
1309         /* Create additional links, OR if hard links are not supported just
1310          * create more files.  */
1311         if (!ret)
1312                 ret = create_links(h, first_dentry, ctx);
1313
1314         (*func_NtClose)(h);
1315         return ret;
1316 }
1317
1318 /* Create all the nondirectory files being extracted, including all aliases
1319  * (hard links).  */
1320 static int
1321 create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1322 {
1323         const struct wim_dentry *dentry;
1324         const struct wim_inode *inode;
1325         int ret;
1326
1327         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1328                 inode = dentry->d_inode;
1329                 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1330                         continue;
1331                 /* Call create_nondirectory() only once per inode  */
1332                 if (dentry != inode_first_extraction_dentry(inode))
1333                         continue;
1334                 ret = create_nondirectory(inode, ctx);
1335                 if (ret)
1336                         return ret;
1337                 ret = report_file_created(&ctx->common);
1338                 if (ret)
1339                         return ret;
1340         }
1341         return 0;
1342 }
1343
1344 static void
1345 close_handles(struct win32_apply_ctx *ctx)
1346 {
1347         for (unsigned i = 0; i < ctx->num_open_handles; i++)
1348                 (*func_NtClose)(ctx->open_handles[i]);
1349 }
1350
1351 /* Prepare to read the next stream, which has size @stream_size, into an
1352  * in-memory buffer.  */
1353 static int
1354 prepare_data_buffer(struct win32_apply_ctx *ctx, u64 stream_size)
1355 {
1356         if (stream_size > ctx->data_buffer_size) {
1357                 /* Larger buffer needed.  */
1358                 void *new_buffer;
1359                 if ((size_t)stream_size != stream_size)
1360                         return WIMLIB_ERR_NOMEM;
1361                 new_buffer = REALLOC(ctx->data_buffer, stream_size);
1362                 if (!new_buffer)
1363                         return WIMLIB_ERR_NOMEM;
1364                 ctx->data_buffer = new_buffer;
1365                 ctx->data_buffer_size = stream_size;
1366         }
1367         /* On the first call this changes data_buffer_ptr from NULL, which tells
1368          * extract_chunk() that the data buffer needs to be filled while reading
1369          * the stream data.  */
1370         ctx->data_buffer_ptr = ctx->data_buffer;
1371         return 0;
1372 }
1373
1374 static int
1375 begin_extract_stream_instance(const struct wim_lookup_table_entry *stream,
1376                               struct wim_dentry *dentry,
1377                               const wchar_t *stream_name,
1378                               struct win32_apply_ctx *ctx)
1379 {
1380         const struct wim_inode *inode = dentry->d_inode;
1381         size_t stream_name_nchars = 0;
1382         FILE_ALLOCATION_INFORMATION alloc_info;
1383         HANDLE h;
1384         NTSTATUS status;
1385
1386         if (unlikely(stream_name))
1387                 stream_name_nchars = wcslen(stream_name);
1388
1389         if (unlikely(stream_name_nchars)) {
1390                 build_extraction_path_with_ads(dentry, ctx,
1391                                                stream_name, stream_name_nchars);
1392         } else {
1393                 build_extraction_path(dentry, ctx);
1394         }
1395
1396         /* Reparse point?  */
1397         if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
1398             && (stream_name_nchars == 0))
1399         {
1400                 if (!ctx->common.supported_features.reparse_points)
1401                         return 0;
1402
1403                 /* We can't write the reparse stream directly; we must set it
1404                  * with FSCTL_SET_REPARSE_POINT, which requires that all the
1405                  * data be available.  So, stage the data in a buffer.  */
1406
1407                 list_add_tail(&dentry->tmp_list, &ctx->reparse_dentries);
1408                 return prepare_data_buffer(ctx, stream->size);
1409         }
1410
1411         /* Encrypted file?  */
1412         if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
1413             && (stream_name_nchars == 0))
1414         {
1415                 if (!ctx->common.supported_features.encrypted_files)
1416                         return 0;
1417
1418                 /* We can't write encrypted file streams directly; we must use
1419                  * WriteEncryptedFileRaw(), which requires providing the data
1420                  * through a callback function.  This can't easily be combined
1421                  * with our own callback-based approach.
1422                  *
1423                  * The current workaround is to simply read the stream into
1424                  * memory and write the encrypted file from that.
1425                  *
1426                  * TODO: This isn't sufficient for extremely large encrypted
1427                  * files.  Perhaps we should create an extra thread to write
1428                  * such files...  */
1429                 list_add_tail(&dentry->tmp_list, &ctx->encrypted_dentries);
1430                 return prepare_data_buffer(ctx, stream->size);
1431         }
1432
1433         /* Extracting unnamed data stream in WIMBoot mode?  */
1434         if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)
1435             && (stream_name_nchars == 0)
1436             && (stream->resource_location == RESOURCE_IN_WIM)
1437             && (stream->rspec->wim == ctx->common.wim)
1438             && (stream->size == stream->rspec->uncompressed_size))
1439         {
1440                 int ret = calculate_dentry_full_path(dentry);
1441                 if (ret)
1442                         return ret;
1443                 if (in_prepopulate_list(dentry, ctx)) {
1444                         union wimlib_progress_info info;
1445
1446                         info.wimboot_exclude.path_in_wim = dentry->_full_path;
1447                         info.wimboot_exclude.extraction_path = current_path(ctx);
1448
1449                         ret = call_progress(ctx->common.progfunc,
1450                                             WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE,
1451                                             &info, ctx->common.progctx);
1452                         FREE(dentry->_full_path);
1453                         dentry->_full_path = NULL;
1454                         if (ret)
1455                                 return ret;
1456                         /* Go on and open the file for normal extraction.  */
1457                 } else {
1458                         FREE(dentry->_full_path);
1459                         dentry->_full_path = NULL;
1460                         return wimboot_set_pointer(&ctx->attr,
1461                                                    current_path(ctx),
1462                                                    stream,
1463                                                    ctx->wimboot.data_source_id,
1464                                                    ctx->wimboot.wim_lookup_table_hash,
1465                                                    ctx->wimboot.wof_running);
1466                 }
1467         }
1468
1469         if (ctx->num_open_handles == MAX_OPEN_STREAMS) {
1470                 /* XXX: Fix this.  But because of the checks in
1471                  * extract_stream_list(), this can now only happen on a
1472                  * filesystem that does not support hard links.  */
1473                 ERROR("Can't extract data: too many open files!");
1474                 return WIMLIB_ERR_UNSUPPORTED;
1475         }
1476
1477         /* Open a new handle  */
1478         status = do_create_file(&h,
1479                                 FILE_WRITE_DATA | SYNCHRONIZE,
1480                                 NULL, 0, FILE_OPEN_IF,
1481                                 FILE_SEQUENTIAL_ONLY |
1482                                         FILE_SYNCHRONOUS_IO_NONALERT,
1483                                 ctx);
1484         if (!NT_SUCCESS(status)) {
1485                 set_errno_from_nt_status(status);
1486                 ERROR_WITH_ERRNO("Can't open \"%ls\" for writing "
1487                                  "(status=0x%08"PRIx32")",
1488                                  current_path(ctx), (u32)status);
1489                 return WIMLIB_ERR_OPEN;
1490         }
1491
1492         ctx->open_handles[ctx->num_open_handles++] = h;
1493
1494         /* Allocate space for the data.  */
1495         alloc_info.AllocationSize.QuadPart = stream->size;
1496         (*func_NtSetInformationFile)(h, &ctx->iosb,
1497                                      &alloc_info, sizeof(alloc_info),
1498                                      FileAllocationInformation);
1499         return 0;
1500 }
1501
1502 /* Set the reparse data @rpbuf of length @rpbuflen on the extracted file
1503  * corresponding to the WIM dentry @dentry.  */
1504 static int
1505 do_set_reparse_data(const struct wim_dentry *dentry,
1506                     const void *rpbuf, u16 rpbuflen,
1507                     struct win32_apply_ctx *ctx)
1508 {
1509         NTSTATUS status;
1510         HANDLE h;
1511
1512         status = create_file(&h, GENERIC_WRITE, NULL,
1513                              0, FILE_OPEN, 0, dentry, ctx);
1514         if (!NT_SUCCESS(status))
1515                 goto fail;
1516
1517         status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
1518                                          &ctx->iosb, FSCTL_SET_REPARSE_POINT,
1519                                          (void *)rpbuf, rpbuflen,
1520                                          NULL, 0);
1521         (*func_NtClose)(h);
1522
1523         if (NT_SUCCESS(status))
1524                 return 0;
1525
1526         /* On Windows, by default only the Administrator can create symbolic
1527          * links for some reason.  By default we just issue a warning if this
1528          * appears to be the problem.  Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
1529          * to get a hard error.  */
1530         if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
1531             && (status == STATUS_PRIVILEGE_NOT_HELD ||
1532                 status == STATUS_ACCESS_DENIED)
1533             && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1534                 dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1535         {
1536                 WARNING("Can't create symbolic link \"%ls\"!              \n"
1537                         "          (Need Administrator rights, or at least "
1538                         "the\n"
1539                         "          SeCreateSymbolicLink privilege.)",
1540                         current_path(ctx));
1541                 return 0;
1542         }
1543
1544 fail:
1545         set_errno_from_nt_status(status);
1546         ERROR_WITH_ERRNO("Can't set reparse data on \"%ls\" "
1547                          "(status=0x%08"PRIx32")",
1548                          current_path(ctx), (u32)status);
1549         return WIMLIB_ERR_SET_REPARSE_DATA;
1550 }
1551
1552 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1553  * pointer to the suffix of the path that begins with the device directly, such
1554  * as e:\Windows\System32.  */
1555 static const wchar_t *
1556 skip_nt_toplevel_component(const wchar_t *path, size_t path_nchars)
1557 {
1558         static const wchar_t * const dirs[] = {
1559                 L"\\??\\",
1560                 L"\\DosDevices\\",
1561                 L"\\Device\\",
1562         };
1563         size_t first_dir_len = 0;
1564         const wchar_t * const end = path + path_nchars;
1565
1566         for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
1567                 size_t len = wcslen(dirs[i]);
1568                 if (len <= (end - path) && !wcsnicmp(path, dirs[i], len)) {
1569                         first_dir_len = len;
1570                         break;
1571                 }
1572         }
1573         if (first_dir_len == 0)
1574                 return path;
1575         path += first_dir_len;
1576         while (path != end && *path == L'\\')
1577                 path++;
1578         return path;
1579 }
1580
1581 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
1582  * pointer to the suffix of the path that is device-relative, such as
1583  * Windows\System32.
1584  *
1585  * The path has an explicit length and is not necessarily null terminated.
1586  *
1587  * If the path just something like \??\e: then the returned pointer will point
1588  * just past the colon.  In this case the length of the result will be 0
1589  * characters.  */
1590 static const wchar_t *
1591 get_device_relative_path(const wchar_t *path, size_t path_nchars)
1592 {
1593         const wchar_t * const orig_path = path;
1594         const wchar_t * const end = path + path_nchars;
1595
1596         path = skip_nt_toplevel_component(path, path_nchars);
1597         if (path == orig_path)
1598                 return orig_path;
1599
1600         path = wmemchr(path, L'\\', (end - path));
1601         if (!path)
1602                 return end;
1603         do {
1604                 path++;
1605         } while (path != end && *path == L'\\');
1606         return path;
1607 }
1608
1609 /*
1610  * Given a reparse point buffer for a symbolic link or junction, adjust its
1611  * contents so that the target of the link is consistent with the new location
1612  * of the files.
1613  */
1614 static void
1615 try_rpfix(u8 *rpbuf, u16 *rpbuflen_p, struct win32_apply_ctx *ctx)
1616 {
1617         struct reparse_data rpdata;
1618         size_t orig_subst_name_nchars;
1619         const wchar_t *relpath;
1620         size_t relpath_nchars;
1621         size_t target_ntpath_nchars;
1622         size_t fixed_subst_name_nchars;
1623         const wchar_t *fixed_print_name;
1624         size_t fixed_print_name_nchars;
1625
1626         if (parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata)) {
1627                 /* Do nothing if the reparse data is invalid.  */
1628                 return;
1629         }
1630
1631         if (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK &&
1632             (rpdata.rpflags & SYMBOLIC_LINK_RELATIVE))
1633         {
1634                 /* Do nothing if it's a relative symbolic link.  */
1635                 return;
1636         }
1637
1638         /* Build the new substitute name from the NT namespace path to the
1639          * target directory, then a path separator, then the "device relative"
1640          * part of the old substitute name.  */
1641
1642         orig_subst_name_nchars = rpdata.substitute_name_nbytes / sizeof(wchar_t);
1643
1644         relpath = get_device_relative_path(rpdata.substitute_name,
1645                                            orig_subst_name_nchars);
1646         relpath_nchars = orig_subst_name_nchars -
1647                          (relpath - rpdata.substitute_name);
1648
1649         target_ntpath_nchars = ctx->target_ntpath.Length / sizeof(wchar_t);
1650
1651         fixed_subst_name_nchars = target_ntpath_nchars;
1652         if (relpath_nchars)
1653                 fixed_subst_name_nchars += 1 + relpath_nchars;
1654         wchar_t fixed_subst_name[fixed_subst_name_nchars];
1655
1656         wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer,
1657                 target_ntpath_nchars);
1658         if (relpath_nchars) {
1659                 fixed_subst_name[target_ntpath_nchars] = L'\\';
1660                 wmemcpy(&fixed_subst_name[target_ntpath_nchars + 1],
1661                         relpath, relpath_nchars);
1662         }
1663         /* Doesn't need to be null-terminated.  */
1664
1665         /* Print name should be Win32, but not all NT names can even be
1666          * translated to Win32 names.  But we can at least delete the top-level
1667          * directory, such as \??\, and this will have the expected result in
1668          * the usual case.  */
1669         fixed_print_name = skip_nt_toplevel_component(fixed_subst_name,
1670                                                       fixed_subst_name_nchars);
1671         fixed_print_name_nchars = fixed_subst_name_nchars - (fixed_print_name -
1672                                                              fixed_subst_name);
1673
1674         rpdata.substitute_name = fixed_subst_name;
1675         rpdata.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
1676         rpdata.print_name = (wchar_t *)fixed_print_name;
1677         rpdata.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
1678         make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p);
1679 }
1680
1681 /* Sets reparse data on the specified file.  This handles "fixing" the targets
1682  * of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX was
1683  * specified.  */
1684 static int
1685 set_reparse_data(const struct wim_dentry *dentry,
1686                  const void *_rpbuf, u16 rpbuflen, struct win32_apply_ctx *ctx)
1687 {
1688         const struct wim_inode *inode = dentry->d_inode;
1689         const void *rpbuf = _rpbuf;
1690
1691         if ((ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
1692             && !inode->i_not_rpfixed
1693             && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1694                 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1695         {
1696                 memcpy(&ctx->rpfixbuf, _rpbuf, rpbuflen);
1697                 try_rpfix((u8 *)&ctx->rpfixbuf, &rpbuflen, ctx);
1698                 rpbuf = &ctx->rpfixbuf;
1699         }
1700         return do_set_reparse_data(dentry, rpbuf, rpbuflen, ctx);
1701
1702 }
1703
1704 /* Import the next block of raw encrypted data  */
1705 static DWORD WINAPI
1706 import_encrypted_data(PBYTE pbData, PVOID pvCallbackContext, PULONG Length)
1707 {
1708         struct win32_apply_ctx *ctx = pvCallbackContext;
1709         ULONG copy_len;
1710
1711         copy_len = min(ctx->encrypted_size - ctx->encrypted_offset, *Length);
1712         memcpy(pbData, &ctx->data_buffer[ctx->encrypted_offset], copy_len);
1713         ctx->encrypted_offset += copy_len;
1714         *Length = copy_len;
1715         return ERROR_SUCCESS;
1716 }
1717
1718 /* Write the raw encrypted data to the already-created file corresponding to
1719  * @dentry.
1720  *
1721  * The raw encrypted data is provided in ctx->data_buffer, and its size is
1722  * ctx->encrypted_size.  */
1723 static int
1724 extract_encrypted_file(const struct wim_dentry *dentry,
1725                        struct win32_apply_ctx *ctx)
1726 {
1727         void *rawctx;
1728         DWORD err;
1729
1730         /* Temporarily build a Win32 path for OpenEncryptedFileRaw()  */
1731         build_win32_extraction_path(dentry, ctx);
1732
1733         err = OpenEncryptedFileRaw(ctx->pathbuf.Buffer,
1734                                    CREATE_FOR_IMPORT, &rawctx);
1735
1736         /* Restore the NT namespace path  */
1737         build_extraction_path(dentry, ctx);
1738
1739         if (err != ERROR_SUCCESS) {
1740                 set_errno_from_win32_error(err);
1741                 ERROR_WITH_ERRNO("Can't open \"%ls\" for encrypted import "
1742                                  "(err=%"PRIu32")", current_path(ctx), (u32)err);
1743                 return WIMLIB_ERR_OPEN;
1744         }
1745
1746         ctx->encrypted_offset = 0;
1747
1748         err = WriteEncryptedFileRaw(import_encrypted_data, ctx, rawctx);
1749
1750         CloseEncryptedFileRaw(rawctx);
1751
1752         if (err != ERROR_SUCCESS) {
1753                 set_errno_from_win32_error(err);
1754                 ERROR_WITH_ERRNO("Can't import encrypted file \"%ls\" "
1755                                  "(err=%"PRIu32")", current_path(ctx), (u32)err);
1756                 return WIMLIB_ERR_WRITE;
1757         }
1758
1759         return 0;
1760 }
1761
1762 /* Called when starting to read a stream for extraction on Windows  */
1763 static int
1764 begin_extract_stream(struct wim_lookup_table_entry *stream, void *_ctx)
1765 {
1766         struct win32_apply_ctx *ctx = _ctx;
1767         const struct stream_owner *owners = stream_owners(stream);
1768         int ret;
1769
1770         ctx->num_open_handles = 0;
1771         ctx->data_buffer_ptr = NULL;
1772         INIT_LIST_HEAD(&ctx->reparse_dentries);
1773         INIT_LIST_HEAD(&ctx->encrypted_dentries);
1774
1775         for (u32 i = 0; i < stream->out_refcnt; i++) {
1776                 const struct wim_inode *inode = owners[i].inode;
1777                 const wchar_t *stream_name = owners[i].stream_name;
1778                 struct wim_dentry *dentry;
1779
1780                 /* A copy of the stream needs to be extracted to @inode.  */
1781
1782                 if (ctx->common.supported_features.hard_links) {
1783                         dentry = inode_first_extraction_dentry(inode);
1784                         ret = begin_extract_stream_instance(stream, dentry,
1785                                                             stream_name, ctx);
1786                         if (ret)
1787                                 goto fail;
1788                 } else {
1789                         /* Hard links not supported.  Extract the stream
1790                          * separately to each alias of the inode.  */
1791                         struct list_head *next;
1792
1793                         next = inode->i_extraction_aliases.next;
1794                         do {
1795                                 dentry = list_entry(next, struct wim_dentry,
1796                                                     d_extraction_alias_node);
1797                                 ret = begin_extract_stream_instance(stream,
1798                                                                     dentry,
1799                                                                     stream_name,
1800                                                                     ctx);
1801                                 if (ret)
1802                                         goto fail;
1803                                 next = next->next;
1804                         } while (next != &inode->i_extraction_aliases);
1805                 }
1806         }
1807
1808         return 0;
1809
1810 fail:
1811         close_handles(ctx);
1812         return ret;
1813 }
1814
1815 /* Called when the next chunk of a stream has been read for extraction on
1816  * Windows  */
1817 static int
1818 extract_chunk(const void *chunk, size_t size, void *_ctx)
1819 {
1820         struct win32_apply_ctx *ctx = _ctx;
1821
1822         /* Write the data chunk to each open handle  */
1823         for (unsigned i = 0; i < ctx->num_open_handles; i++) {
1824                 u8 *bufptr = (u8 *)chunk;
1825                 size_t bytes_remaining = size;
1826                 NTSTATUS status;
1827                 while (bytes_remaining) {
1828                         ULONG count = min(0xFFFFFFFF, bytes_remaining);
1829
1830                         status = (*func_NtWriteFile)(ctx->open_handles[i],
1831                                                      NULL, NULL, NULL,
1832                                                      &ctx->iosb, bufptr, count,
1833                                                      NULL, NULL);
1834                         if (!NT_SUCCESS(status)) {
1835                                 set_errno_from_nt_status(status);
1836                                 ERROR_WITH_ERRNO("Error writing data to target "
1837                                                  "volume (status=0x%08"PRIx32")",
1838                                                  (u32)status);
1839                                 return WIMLIB_ERR_WRITE;
1840                         }
1841                         bufptr += ctx->iosb.Information;
1842                         bytes_remaining -= ctx->iosb.Information;
1843                 }
1844         }
1845
1846         /* Copy the data chunk into the buffer (if needed)  */
1847         if (ctx->data_buffer_ptr)
1848                 ctx->data_buffer_ptr = mempcpy(ctx->data_buffer_ptr,
1849                                                chunk, size);
1850         return 0;
1851 }
1852
1853 /* Called when a stream has been fully read for extraction on Windows  */
1854 static int
1855 end_extract_stream(struct wim_lookup_table_entry *stream, int status, void *_ctx)
1856 {
1857         struct win32_apply_ctx *ctx = _ctx;
1858         int ret;
1859         const struct wim_dentry *dentry;
1860
1861         close_handles(ctx);
1862
1863         if (status)
1864                 return status;
1865
1866         if (likely(!ctx->data_buffer_ptr))
1867                 return 0;
1868
1869         if (!list_empty(&ctx->reparse_dentries)) {
1870                 if (stream->size > REPARSE_DATA_MAX_SIZE) {
1871                         dentry = list_first_entry(&ctx->reparse_dentries,
1872                                                   struct wim_dentry, tmp_list);
1873                         build_extraction_path(dentry, ctx);
1874                         ERROR("Reparse data of \"%ls\" has size "
1875                               "%"PRIu64" bytes (exceeds %u bytes)",
1876                               current_path(ctx), stream->size,
1877                               REPARSE_DATA_MAX_SIZE);
1878                         return WIMLIB_ERR_INVALID_REPARSE_DATA;
1879                 }
1880                 /* In the WIM format, reparse streams are just the reparse data
1881                  * and omit the header.  But we can reconstruct the header.  */
1882                 memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, stream->size);
1883                 ctx->rpbuf.rpdatalen = stream->size;
1884                 ctx->rpbuf.rpreserved = 0;
1885                 list_for_each_entry(dentry, &ctx->reparse_dentries, tmp_list) {
1886                         ctx->rpbuf.rptag = dentry->d_inode->i_reparse_tag;
1887                         ret = set_reparse_data(dentry, &ctx->rpbuf,
1888                                                stream->size + REPARSE_DATA_OFFSET,
1889                                                ctx);
1890                         if (ret)
1891                                 return ret;
1892                 }
1893         }
1894
1895         if (!list_empty(&ctx->encrypted_dentries)) {
1896                 ctx->encrypted_size = stream->size;
1897                 list_for_each_entry(dentry, &ctx->encrypted_dentries, tmp_list) {
1898                         ret = extract_encrypted_file(dentry, ctx);
1899                         if (ret)
1900                                 return ret;
1901                 }
1902         }
1903
1904         return 0;
1905 }
1906
1907 /* Attributes that can't be set directly  */
1908 #define SPECIAL_ATTRIBUTES                      \
1909         (FILE_ATTRIBUTE_REPARSE_POINT   |       \
1910          FILE_ATTRIBUTE_DIRECTORY       |       \
1911          FILE_ATTRIBUTE_ENCRYPTED       |       \
1912          FILE_ATTRIBUTE_SPARSE_FILE     |       \
1913          FILE_ATTRIBUTE_COMPRESSED)
1914
1915 /* Set the security descriptor @desc, of @desc_size bytes, on the file with open
1916  * handle @h.  */
1917 static NTSTATUS
1918 set_security_descriptor(HANDLE h, const void *desc,
1919                         size_t desc_size, struct win32_apply_ctx *ctx)
1920 {
1921         SECURITY_INFORMATION info;
1922         NTSTATUS status;
1923
1924         /* We really just want to set entire the security descriptor as-is, but
1925          * all available APIs require specifying the specific parts of the
1926          * descriptor being set.  Start out by requesting all parts be set.  If
1927          * permissions problems are encountered, fall back to omitting some
1928          * parts (first the SACL, then the DACL, then the owner), unless the
1929          * WIMLIB_EXTRACT_FLAG_STRICT_ACLS flag has been enabled.  */
1930         info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
1931                DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION;
1932
1933         /* Prefer NtSetSecurityObject() to SetFileSecurity().  SetFileSecurity()
1934          * itself necessarily uses NtSetSecurityObject() as the latter is the
1935          * underlying system call for setting security information, but
1936          * SetFileSecurity() opens the handle with NtCreateFile() without
1937          * FILE_OPEN_FILE_BACKUP_INTENT.  Hence, access checks are done and due
1938          * to the Windows security model, even a process running as the
1939          * Administrator can have access denied.  (Of course, this not mentioned
1940          * in the MS "documentation".)  */
1941 retry:
1942         status = (*func_NtSetSecurityObject)(h, info, (PSECURITY_DESCRIPTOR)desc);
1943         if (NT_SUCCESS(status))
1944                 return status;
1945         /* Failed to set the requested parts of the security descriptor.  If the
1946          * error was permissions-related, try to set fewer parts of the security
1947          * descriptor, unless WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled.  */
1948         if ((status == STATUS_PRIVILEGE_NOT_HELD ||
1949              status == STATUS_ACCESS_DENIED) &&
1950             !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
1951         {
1952                 if (info & SACL_SECURITY_INFORMATION) {
1953                         info &= ~SACL_SECURITY_INFORMATION;
1954                         ctx->partial_security_descriptors++;
1955                         goto retry;
1956                 }
1957                 if (info & DACL_SECURITY_INFORMATION) {
1958                         info &= ~DACL_SECURITY_INFORMATION;
1959                         goto retry;
1960                 }
1961                 if (info & OWNER_SECURITY_INFORMATION) {
1962                         info &= ~OWNER_SECURITY_INFORMATION;
1963                         goto retry;
1964                 }
1965                 /* Nothing left except GROUP, and if we removed it we
1966                  * wouldn't have anything at all.  */
1967         }
1968
1969         /* No part of the security descriptor could be set, or
1970          * WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled and the full security
1971          * descriptor could not be set.  */
1972         if (!(info & SACL_SECURITY_INFORMATION))
1973                 ctx->partial_security_descriptors--;
1974         ctx->no_security_descriptors++;
1975         return status;
1976 }
1977
1978 /* Set metadata on the open file @h from the WIM inode @inode.  */
1979 static int
1980 do_apply_metadata_to_file(HANDLE h, const struct wim_inode *inode,
1981                           struct win32_apply_ctx *ctx)
1982 {
1983         FILE_BASIC_INFORMATION info;
1984         NTSTATUS status;
1985
1986         /* Set security descriptor if present and not in NO_ACLS mode  */
1987         if (inode->i_security_id >= 0 &&
1988             !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
1989         {
1990                 const struct wim_security_data *sd;
1991                 const void *desc;
1992                 size_t desc_size;
1993
1994                 sd = wim_get_current_security_data(ctx->common.wim);
1995                 desc = sd->descriptors[inode->i_security_id];
1996                 desc_size = sd->sizes[inode->i_security_id];
1997
1998                 status = set_security_descriptor(h, desc, desc_size, ctx);
1999                 if (!NT_SUCCESS(status) &&
2000                     (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2001                 {
2002                         set_errno_from_nt_status(status);
2003                         ERROR_WITH_ERRNO("Can't set security descriptor "
2004                                          "on \"%ls\" (status=0x%08"PRIx32")",
2005                                          current_path(ctx), (u32)status);
2006                         return WIMLIB_ERR_SET_SECURITY;
2007                 }
2008         }
2009
2010         /* Set attributes and timestamps  */
2011         info.CreationTime.QuadPart = inode->i_creation_time;
2012         info.LastAccessTime.QuadPart = inode->i_last_access_time;
2013         info.LastWriteTime.QuadPart = inode->i_last_write_time;
2014         info.ChangeTime.QuadPart = 0;
2015         if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
2016                 info.FileAttributes = 0;
2017         else
2018                 info.FileAttributes = inode->i_attributes & ~SPECIAL_ATTRIBUTES;
2019
2020         status = (*func_NtSetInformationFile)(h, &ctx->iosb,
2021                                               &info, sizeof(info),
2022                                               FileBasicInformation);
2023         /* On FAT volumes we get STATUS_INVALID_PARAMETER if we try to set
2024          * attributes on the root directory.  (Apparently because FAT doesn't
2025          * actually have a place to store those attributes!)  */
2026         if (!NT_SUCCESS(status)
2027             && !(status == STATUS_INVALID_PARAMETER &&
2028                  dentry_is_root(inode_first_extraction_dentry(inode))))
2029         {
2030                 set_errno_from_nt_status(status);
2031                 ERROR_WITH_ERRNO("Can't set basic metadata on \"%ls\" "
2032                                  "(status=0x%08"PRIx32")",
2033                                  current_path(ctx), (u32)status);
2034                 return WIMLIB_ERR_SET_ATTRIBUTES;
2035         }
2036
2037         return 0;
2038 }
2039
2040 static int
2041 apply_metadata_to_file(const struct wim_dentry *dentry,
2042                        struct win32_apply_ctx *ctx)
2043 {
2044         const struct wim_inode *inode = dentry->d_inode;
2045         DWORD perms;
2046         HANDLE h;
2047         NTSTATUS status;
2048         int ret;
2049
2050         perms = FILE_WRITE_ATTRIBUTES | WRITE_DAC |
2051                 WRITE_OWNER | ACCESS_SYSTEM_SECURITY;
2052
2053         build_extraction_path(dentry, ctx);
2054
2055         /* Open a handle with as many relevant permissions as possible.  */
2056         while (!NT_SUCCESS(status = do_create_file(&h, perms, NULL,
2057                                                    0, FILE_OPEN, 0, ctx)))
2058         {
2059                 if (status == STATUS_PRIVILEGE_NOT_HELD ||
2060                     status == STATUS_ACCESS_DENIED)
2061                 {
2062                         if (perms & ACCESS_SYSTEM_SECURITY) {
2063                                 perms &= ~ACCESS_SYSTEM_SECURITY;
2064                                 continue;
2065                         }
2066                         if (perms & WRITE_DAC) {
2067                                 perms &= ~WRITE_DAC;
2068                                 continue;
2069                         }
2070                         if (perms & WRITE_OWNER) {
2071                                 perms &= ~WRITE_OWNER;
2072                                 continue;
2073                         }
2074                 }
2075                 set_errno_from_nt_status(status);
2076                 ERROR_WITH_ERRNO("Can't open \"%ls\" to set metadata "
2077                                  "(status=0x%08"PRIx32")",
2078                                  current_path(ctx), (u32)status);
2079                 return WIMLIB_ERR_OPEN;
2080         }
2081
2082         ret = do_apply_metadata_to_file(h, inode, ctx);
2083
2084         (*func_NtClose)(h);
2085
2086         return ret;
2087 }
2088
2089 static int
2090 apply_metadata(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
2091 {
2092         const struct wim_dentry *dentry;
2093         int ret;
2094
2095         /* We go in reverse so that metadata is set on all a directory's
2096          * children before the directory itself.  This avoids any potential
2097          * problems with attributes, timestamps, or security descriptors.  */
2098         list_for_each_entry_reverse(dentry, dentry_list, d_extraction_list_node)
2099         {
2100                 ret = apply_metadata_to_file(dentry, ctx);
2101                 if (ret)
2102                         return ret;
2103                 ret = report_file_metadata_applied(&ctx->common);
2104                 if (ret)
2105                         return ret;
2106         }
2107         return 0;
2108 }
2109
2110 /* Issue warnings about problems during the extraction for which warnings were
2111  * not already issued (due to the high number of potential warnings if we issued
2112  * them per-file).  */
2113 static void
2114 do_warnings(const struct win32_apply_ctx *ctx)
2115 {
2116         if (ctx->partial_security_descriptors == 0 &&
2117             ctx->no_security_descriptors == 0 &&
2118             ctx->num_short_name_failures == 0)
2119                 return;
2120
2121         WARNING("Extraction to \"%ls\" complete, but with one or more warnings:",
2122                 ctx->common.target);
2123         if (ctx->num_short_name_failures) {
2124                 WARNING("- Could not set short names on %lu files or directories",
2125                         ctx->num_short_name_failures);
2126         }
2127         if (ctx->partial_security_descriptors) {
2128                 WARNING("- Could only partially set the security descriptor\n"
2129                         "            on %lu files or directories.",
2130                         ctx->partial_security_descriptors);
2131         }
2132         if (ctx->no_security_descriptors) {
2133                 WARNING("- Could not set security descriptor at all\n"
2134                         "            on %lu files or directories.",
2135                         ctx->no_security_descriptors);
2136         }
2137         if (ctx->partial_security_descriptors || ctx->no_security_descriptors) {
2138                 WARNING("To fully restore all security descriptors, run the program\n"
2139                         "          with Administrator rights.");
2140         }
2141 }
2142
2143 /* Extract files from a WIM image to a directory on Windows  */
2144 static int
2145 win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
2146 {
2147         int ret;
2148         struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
2149
2150         ret = prepare_target(dentry_list, ctx);
2151         if (ret)
2152                 goto out;
2153
2154         if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2155                 ret = start_wimboot_extraction(ctx);
2156                 if (ret)
2157                         goto out;
2158         }
2159
2160         reset_file_progress(&ctx->common);
2161
2162         ret = create_directories(dentry_list, ctx);
2163         if (ret)
2164                 goto out;
2165
2166         ret = create_nondirectories(dentry_list, ctx);
2167         if (ret)
2168                 goto out;
2169
2170         struct read_stream_list_callbacks cbs = {
2171                 .begin_stream      = begin_extract_stream,
2172                 .begin_stream_ctx  = ctx,
2173                 .consume_chunk     = extract_chunk,
2174                 .consume_chunk_ctx = ctx,
2175                 .end_stream        = end_extract_stream,
2176                 .end_stream_ctx    = ctx,
2177         };
2178         ret = extract_stream_list(&ctx->common, &cbs);
2179         if (ret)
2180                 goto out;
2181
2182         reset_file_progress(&ctx->common);
2183
2184         ret = apply_metadata(dentry_list, ctx);
2185         if (ret)
2186                 goto out;
2187
2188         if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
2189                 ret = end_wimboot_extraction(ctx);
2190                 if (ret)
2191                         goto out;
2192         }
2193
2194         do_warnings(ctx);
2195 out:
2196         if (ctx->h_target)
2197                 (*func_NtClose)(ctx->h_target);
2198         if (ctx->target_ntpath.Buffer)
2199                 HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
2200         FREE(ctx->pathbuf.Buffer);
2201         FREE(ctx->print_buffer);
2202         if (ctx->wimboot.prepopulate_pats) {
2203                 FREE(ctx->wimboot.prepopulate_pats->strings);
2204                 FREE(ctx->wimboot.prepopulate_pats);
2205         }
2206         FREE(ctx->wimboot.mem_prepopulate_pats);
2207         FREE(ctx->data_buffer);
2208         return ret;
2209 }
2210
2211 const struct apply_operations win32_apply_ops = {
2212         .name                   = "Windows",
2213         .get_supported_features = win32_get_supported_features,
2214         .extract                = win32_extract,
2215         .context_size           = sizeof(struct win32_apply_ctx),
2216 };
2217
2218 #endif /* __WIN32__ */