2 * win32_capture.c - Windows-specific code for capturing files into a WIM image.
4 * This now uses the native Windows NT API a lot and not just Win32.
8 * Copyright (C) 2013, 2014 Eric Biggers
10 * This file is part of wimlib, a library for working with WIM files.
12 * wimlib is free software; you can redistribute it and/or modify it under the
13 * terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 3 of the License, or (at your option)
17 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19 * A PARTICULAR PURPOSE. See the GNU General Public License for more
22 * You should have received a copy of the GNU General Public License
23 * along with wimlib; if not, see http://www.gnu.org/licenses/.
32 #include "wimlib/win32_common.h"
34 #include "wimlib/capture.h"
35 #include "wimlib/dentry.h"
36 #include "wimlib/encoding.h"
37 #include "wimlib/endianness.h"
38 #include "wimlib/error.h"
39 #include "wimlib/lookup_table.h"
40 #include "wimlib/paths.h"
41 #include "wimlib/reparse.h"
45 struct winnt_scan_stats {
46 unsigned long num_get_sd_access_denied;
47 unsigned long num_get_sacl_priv_notheld;
50 static inline const wchar_t *
51 printable_path(const wchar_t *full_path)
53 /* Skip over \\?\ or \??\ */
58 * If cur_dir is not NULL, open an existing file relative to the already-open
61 * Otherwise, open the file specified by @path, which must be a Windows NT
65 winnt_openat(HANDLE cur_dir, const wchar_t *path, size_t path_nchars,
66 ACCESS_MASK perms, HANDLE *h_ret)
69 OBJECT_ATTRIBUTES attr;
73 name.Length = path_nchars * sizeof(wchar_t);
74 name.MaximumLength = name.Length + sizeof(wchar_t);
75 name.Buffer = (wchar_t *)path;
77 attr.Length = sizeof(attr);
78 attr.RootDirectory = cur_dir;
79 attr.ObjectName = &name;
81 attr.SecurityDescriptor = NULL;
82 attr.SecurityQualityOfService = NULL;
85 status = (*func_NtOpenFile)(h_ret, perms, &attr, &iosb,
86 FILE_SHARE_VALID_FLAGS,
87 FILE_OPEN_REPARSE_POINT |
88 FILE_OPEN_FOR_BACKUP_INTENT |
89 FILE_SYNCHRONOUS_IO_NONALERT |
90 FILE_SEQUENTIAL_ONLY);
91 if (!NT_SUCCESS(status)) {
92 /* Try requesting fewer permissions */
93 if (status == STATUS_ACCESS_DENIED ||
94 status == STATUS_PRIVILEGE_NOT_HELD) {
95 if (perms & ACCESS_SYSTEM_SECURITY) {
96 perms &= ~ACCESS_SYSTEM_SECURITY;
99 if (perms & READ_CONTROL) {
100 perms &= ~READ_CONTROL;
108 /* Read the first @size bytes from the file, or named data stream of a file,
109 * from which the stream entry @lte was created. */
111 read_winnt_file_prefix(const struct wim_lookup_table_entry *lte, u64 size,
112 consume_data_callback_t cb, void *cb_ctx)
121 /* This is an NT namespace path. */
122 path = lte->file_on_disk;
124 status = winnt_openat(NULL, path, wcslen(path),
125 FILE_READ_DATA | SYNCHRONIZE, &h);
126 if (!NT_SUCCESS(status)) {
127 set_errno_from_nt_status(status);
128 ERROR_WITH_ERRNO("\"%ls\": Can't open for reading "
129 "(status=0x%08"PRIx32")",
130 printable_path(path), (u32)status);
131 return WIMLIB_ERR_OPEN;
135 bytes_remaining = size;
136 while (bytes_remaining) {
137 IO_STATUS_BLOCK iosb;
141 count = min(sizeof(buf), bytes_remaining);
143 status = (*func_NtReadFile)(h, NULL, NULL, NULL,
144 &iosb, buf, count, NULL, NULL);
145 if (!NT_SUCCESS(status)) {
146 set_errno_from_nt_status(status);
147 ERROR_WITH_ERRNO("\"%ls\": Error reading data "
148 "(status=0x%08"PRIx32")",
149 printable_path(path), (u32)status);
150 ret = WIMLIB_ERR_READ;
154 bytes_read = iosb.Information;
156 bytes_remaining -= bytes_read;
157 ret = (*cb)(buf, bytes_read, cb_ctx);
165 struct win32_encrypted_read_ctx {
166 consume_data_callback_t read_prefix_cb;
167 void *read_prefix_ctx;
173 win32_encrypted_export_cb(unsigned char *data, void *_ctx, unsigned long len)
175 struct win32_encrypted_read_ctx *ctx = _ctx;
177 size_t bytes_to_consume = min(len, ctx->bytes_remaining);
179 if (bytes_to_consume == 0)
180 return ERROR_SUCCESS;
182 ret = (*ctx->read_prefix_cb)(data, bytes_to_consume, ctx->read_prefix_ctx);
184 ctx->wimlib_err_code = ret;
185 /* Shouldn't matter what error code is returned here, as long as
186 * it isn't ERROR_SUCCESS. */
187 return ERROR_READ_FAULT;
189 ctx->bytes_remaining -= bytes_to_consume;
190 return ERROR_SUCCESS;
194 read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte,
196 consume_data_callback_t cb, void *cb_ctx)
198 struct win32_encrypted_read_ctx export_ctx;
203 export_ctx.read_prefix_cb = cb;
204 export_ctx.read_prefix_ctx = cb_ctx;
205 export_ctx.wimlib_err_code = 0;
206 export_ctx.bytes_remaining = size;
208 err = OpenEncryptedFileRaw(lte->file_on_disk, 0, &file_ctx);
209 if (err != ERROR_SUCCESS) {
210 set_errno_from_win32_error(err);
211 ERROR_WITH_ERRNO("Failed to open encrypted file \"%ls\" "
213 printable_path(lte->file_on_disk));
214 return WIMLIB_ERR_OPEN;
216 err = ReadEncryptedFileRaw(win32_encrypted_export_cb,
217 &export_ctx, file_ctx);
218 if (err != ERROR_SUCCESS) {
219 set_errno_from_win32_error(err);
220 ERROR_WITH_ERRNO("Failed to read encrypted file \"%ls\"",
221 printable_path(lte->file_on_disk));
222 ret = export_ctx.wimlib_err_code;
224 ret = WIMLIB_ERR_READ;
225 } else if (export_ctx.bytes_remaining != 0) {
226 ERROR("Only could read %"PRIu64" of %"PRIu64" bytes from "
227 "encryted file \"%ls\"",
228 size - export_ctx.bytes_remaining, size,
229 printable_path(lte->file_on_disk));
230 ret = WIMLIB_ERR_READ;
234 CloseEncryptedFileRaw(file_ctx);
239 * Load the short name of a file into a WIM dentry.
242 winnt_get_short_name(HANDLE h, struct wim_dentry *dentry)
244 /* It's not any harder to just make the NtQueryInformationFile() system
245 * call ourselves, and it saves a dumb call to FindFirstFile() which of
246 * course has to create its own handle. */
248 IO_STATUS_BLOCK iosb;
249 u8 buf[128] _aligned_attribute(8);
250 const FILE_NAME_INFORMATION *info;
252 status = (*func_NtQueryInformationFile)(h, &iosb, buf, sizeof(buf),
253 FileAlternateNameInformation);
254 info = (const FILE_NAME_INFORMATION *)buf;
255 if (NT_SUCCESS(status) && info->FileNameLength != 0) {
256 dentry->short_name = utf16le_dupz(info->FileName,
257 info->FileNameLength);
258 if (!dentry->short_name)
259 return STATUS_NO_MEMORY;
260 dentry->short_name_nbytes = info->FileNameLength;
266 * Load the security descriptor of a file into the corresponding inode, and the
267 * WIM image's security descriptor set.
270 winnt_get_security_descriptor(HANDLE h, struct wim_inode *inode,
271 struct wim_sd_set *sd_set,
272 struct winnt_scan_stats *stats, int add_flags)
274 SECURITY_INFORMATION requestedInformation;
275 u8 _buf[4096] _aligned_attribute(8);
281 requestedInformation = DACL_SECURITY_INFORMATION |
282 SACL_SECURITY_INFORMATION |
283 OWNER_SECURITY_INFORMATION |
284 GROUP_SECURITY_INFORMATION;
286 bufsize = sizeof(_buf);
289 * We need the file's security descriptor in
290 * SECURITY_DESCRIPTOR_RELATIVE format, and we currently have a handle
291 * opened with as many relevant permissions as possible. At this point,
292 * on Windows there are a number of options for reading a file's
293 * security descriptor:
295 * GetFileSecurity(): This takes in a path and returns the
296 * SECURITY_DESCRIPTOR_RELATIVE. Problem: this uses an internal handle,
297 * not ours, and the handle created internally doesn't specify
298 * FILE_FLAG_BACKUP_SEMANTICS. Therefore there can be access denied
299 * errors on some files and directories, even when running as the
302 * GetSecurityInfo(): This takes in a handle and returns the security
303 * descriptor split into a bunch of different parts. This should work,
304 * but it's dumb because we have to put the security descriptor back
307 * BackupRead(): This can read the security descriptor, but this is a
308 * difficult-to-use API, probably only works as the Administrator, and
309 * the format of the returned data is not well documented.
311 * NtQuerySecurityObject(): This is exactly what we need, as it takes
312 * in a handle and returns the security descriptor in
313 * SECURITY_DESCRIPTOR_RELATIVE format. Only problem is that it's a
314 * ntdll function and therefore not officially part of the Win32 API.
317 while (!(NT_SUCCESS(status = (*func_NtQuerySecurityObject)(h,
318 requestedInformation,
319 (PSECURITY_DESCRIPTOR)buf,
324 case STATUS_BUFFER_TOO_SMALL:
325 wimlib_assert(buf == _buf);
326 buf = MALLOC(len_needed);
328 return STATUS_NO_MEMORY;
329 bufsize = len_needed;
331 case STATUS_PRIVILEGE_NOT_HELD:
332 case STATUS_ACCESS_DENIED:
333 if (add_flags & WIMLIB_ADD_FLAG_STRICT_ACLS) {
335 /* Permission denied in STRICT_ACLS mode, or
339 if (requestedInformation & SACL_SECURITY_INFORMATION) {
340 /* Try again without the SACL. */
341 stats->num_get_sacl_priv_notheld++;
342 requestedInformation &= ~SACL_SECURITY_INFORMATION;
345 /* Fake success (useful when capturing as
346 * non-Administrator). */
347 stats->num_get_sd_access_denied++;
348 status = STATUS_SUCCESS;
353 /* Add the security descriptor to the WIM image, and save its ID in
355 inode->i_security_id = sd_set_add_sd(sd_set, buf, len_needed);
356 if (unlikely(inode->i_security_id < 0))
357 status = STATUS_NO_MEMORY;
359 if (unlikely(buf != _buf))
365 winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret,
368 size_t full_path_nchars,
369 const wchar_t *filename,
370 size_t filename_nchars,
371 struct add_image_params *params,
372 struct winnt_scan_stats *stats,
376 winnt_recurse_directory(HANDLE h,
378 size_t full_path_nchars,
379 struct wim_dentry *parent,
380 struct add_image_params *params,
381 struct winnt_scan_stats *stats,
385 const size_t bufsize = 8192;
386 IO_STATUS_BLOCK iosb;
390 buf = MALLOC(bufsize);
392 return WIMLIB_ERR_NOMEM;
394 /* Using NtQueryDirectoryFile() we can re-use the same open handle,
395 * which we opened with FILE_FLAG_BACKUP_SEMANTICS. */
397 while (NT_SUCCESS(status = (*func_NtQueryDirectoryFile)(h, NULL, NULL, NULL,
399 FileNamesInformation,
400 FALSE, NULL, FALSE)))
402 const FILE_NAMES_INFORMATION *info = buf;
404 if (!(info->FileNameLength == 2 && info->FileName[0] == L'.') &&
405 !(info->FileNameLength == 4 && info->FileName[0] == L'.' &&
406 info->FileName[1] == L'.'))
410 struct wim_dentry *child;
412 p = full_path + full_path_nchars;
413 /* Only add a backslash if we don't already have
414 * one. This prevents a duplicate backslash
415 * from being added when the path to the capture
416 * dir had a trailing backslash. */
417 if (*(p - 1) != L'\\')
420 p = wmempcpy(filename, info->FileName,
421 info->FileNameLength / 2);
424 ret = winnt_build_dentry_tree_recursive(
430 info->FileNameLength / 2,
435 full_path[full_path_nchars] = L'\0';
440 dentry_add_child(parent, child);
442 if (info->NextEntryOffset == 0)
444 info = (const FILE_NAMES_INFORMATION *)
445 ((const u8 *)info + info->NextEntryOffset);
449 if (unlikely(status != STATUS_NO_MORE_FILES)) {
450 set_errno_from_nt_status(status);
451 ERROR_WITH_ERRNO("\"%ls\": Can't read directory "
452 "(status=0x%08"PRIx32")",
453 printable_path(full_path), (u32)status);
454 ret = WIMLIB_ERR_READ;
461 /* Reparse point fixup status code */
463 /* Reparse point will be captured literally (no fixup) */
466 /* Reparse point will be captured with fixup */
471 file_has_ino_and_dev(HANDLE h, u64 ino, u64 dev)
474 IO_STATUS_BLOCK iosb;
475 FILE_INTERNAL_INFORMATION int_info;
476 FILE_FS_VOLUME_INFORMATION vol_info;
478 status = (*func_NtQueryInformationFile)(h, &iosb,
479 &int_info, sizeof(int_info),
480 FileInternalInformation);
481 if (!NT_SUCCESS(status))
484 if (int_info.IndexNumber.QuadPart != ino)
487 status = (*func_NtQueryVolumeInformationFile)(h, &iosb,
488 &vol_info, sizeof(vol_info),
489 FileFsVolumeInformation);
490 if (!(NT_SUCCESS(status) || status == STATUS_BUFFER_OVERFLOW))
493 if (iosb.Information <
494 offsetof(FILE_FS_VOLUME_INFORMATION, VolumeSerialNumber) +
495 sizeof(vol_info.VolumeSerialNumber))
498 return (vol_info.VolumeSerialNumber == dev);
502 * Given an (expected) NT namespace symbolic link or junction target @target of
503 * length @target_nbytes, determine if a prefix of the target points to a file
504 * identified by @capture_root_ino and @capture_root_dev.
506 * If yes, return a pointer to the portion of the link following this prefix.
508 * If no, return NULL.
510 * If the link target does not appear to be a valid NT namespace path, return
513 static const wchar_t *
514 winnt_get_root_relative_target(const wchar_t *target, size_t target_nbytes,
515 u64 capture_root_ino, u64 capture_root_dev)
518 OBJECT_ATTRIBUTES attr;
519 IO_STATUS_BLOCK iosb;
521 const wchar_t *target_end;
524 target_end = target + (target_nbytes / sizeof(wchar_t));
527 if (target_end == target)
530 /* No leading slash??? */
531 if (target[0] != L'\\')
535 if ((target_end - target) >= 2 &&
536 target[0] == L'\\' && target[1] == L'\\')
539 attr.Length = sizeof(attr);
540 attr.RootDirectory = NULL;
541 attr.ObjectName = &name;
543 attr.SecurityDescriptor = NULL;
544 attr.SecurityQualityOfService = NULL;
546 name.Buffer = (wchar_t *)target;
551 const wchar_t *orig_p = p;
553 /* Skip non-backslashes */
554 while (p != target_end && *p != L'\\')
557 /* Skip backslashes */
558 while (p != target_end && *p == L'\\')
561 /* Append path component */
562 name.Length += (p - orig_p) * sizeof(wchar_t);
563 name.MaximumLength = name.Length;
565 /* Try opening the file */
566 status = (*func_NtOpenFile) (&h,
567 FILE_READ_ATTRIBUTES | FILE_TRAVERSE,
570 FILE_SHARE_VALID_FLAGS,
571 FILE_OPEN_FOR_BACKUP_INTENT);
573 if (NT_SUCCESS(status)) {
574 /* Reset root directory */
575 if (attr.RootDirectory)
576 (*func_NtClose)(attr.RootDirectory);
577 attr.RootDirectory = h;
578 name.Buffer = (wchar_t *)p;
581 if (file_has_ino_and_dev(h, capture_root_ino,
583 goto out_close_root_dir;
585 } while (p != target_end);
590 if (attr.RootDirectory)
591 (*func_NtClose)(attr.RootDirectory);
596 winnt_rpfix_progress(struct add_image_params *params, const wchar_t *path,
597 const struct reparse_data *rpdata,
598 enum wimlib_progress_msg msg)
600 size_t print_name_nchars = rpdata->print_name_nbytes / sizeof(wchar_t);
601 wchar_t print_name0[print_name_nchars + 1];
603 wmemcpy(print_name0, rpdata->print_name, print_name_nchars);
604 print_name0[print_name_nchars] = L'\0';
606 params->progress.scan.cur_path = printable_path(path);
607 params->progress.scan.symlink_target = print_name0;
608 return do_capture_progress(params, msg, NULL);
612 winnt_try_rpfix(u8 *rpbuf, u16 *rpbuflen_p,
613 u64 capture_root_ino, u64 capture_root_dev,
614 const wchar_t *path, struct add_image_params *params)
616 struct reparse_data rpdata;
617 const wchar_t *rel_target;
620 if (parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata)) {
621 /* Couldn't even understand the reparse data. Don't try the
627 * Don't do reparse point fixups on relative symbolic links.
629 * On Windows, a relative symbolic link is supposed to be identifiable
630 * by having reparse tag WIM_IO_REPARSE_TAG_SYMLINK and flags
631 * SYMBOLIC_LINK_RELATIVE. We will use this information, although this
632 * may not always do what the user expects, since drive-relative
633 * symbolic links such as "\Users\Public" have SYMBOLIC_LINK_RELATIVE
634 * set, in addition to truely relative symbolic links such as "Users" or
635 * "Users\Public". However, WIMGAPI (as of Windows 8.1) has this same
638 * Otherwise, as far as I can tell, the targets of symbolic links that
639 * are NOT relative, as well as junctions (note: a mountpoint is the
640 * sames thing as a junction), must be NT namespace paths, for example:
642 * - \??\e:\Users\Public
643 * - \DosDevices\e:\Users\Public
644 * - \Device\HardDiskVolume4\Users\Public
645 * - \??\Volume{c47cb07c-946e-4155-b8f7-052e9cec7628}\Users\Public
646 * - \DosDevices\Volume{c47cb07c-946e-4155-b8f7-052e9cec7628}\Users\Public
648 if (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK &&
649 (rpdata.rpflags & SYMBOLIC_LINK_RELATIVE))
652 rel_target = winnt_get_root_relative_target(rpdata.substitute_name,
653 rpdata.substitute_name_nbytes,
657 /* Target points outside of the tree being captured. Don't
659 ret = winnt_rpfix_progress(params, path, &rpdata,
660 WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK);
666 if (rel_target == rpdata.substitute_name) {
667 /* Weird target --- keep the reparse point and don't mess with
672 /* We have an absolute target pointing within the directory being
673 * captured, @rel_target is the suffix of the link target that is the
674 * part relative to the directory being captured.
676 * We will cut off the prefix before this part (which is the path to the
677 * directory being captured) and add a dummy prefix. Since the process
678 * will need to be reversed when applying the image, it shouldn't matter
679 * what exactly the prefix is, as long as it looks like an absolute
684 size_t rel_target_nbytes =
685 rpdata.substitute_name_nbytes - ((const u8 *)rel_target -
686 (const u8 *)rpdata.substitute_name);
687 size_t rel_target_nchars = rel_target_nbytes / sizeof(wchar_t);
689 wchar_t tmp[rel_target_nchars + 7];
691 wmemcpy(tmp, L"\\??\\X:\\", 7);
692 wmemcpy(tmp + 7, rel_target, rel_target_nchars);
694 rpdata.substitute_name = tmp;
695 rpdata.substitute_name_nbytes = rel_target_nbytes + (7 * sizeof(wchar_t));
696 rpdata.print_name = tmp + 4;
697 rpdata.print_name_nbytes = rel_target_nbytes + (3 * sizeof(wchar_t));
699 if (make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p))
702 ret = winnt_rpfix_progress(params, path, &rpdata,
703 WIMLIB_SCAN_DENTRY_FIXED_SYMLINK);
710 * Loads the reparse point data from a reparse point into memory, optionally
711 * fixing the targets of absolute symbolic links and junction points to be
712 * relative to the root of capture.
715 * Open handle to the reparse point file.
717 * Path to the reparse point file.
719 * Capture parameters. add_flags, capture_root_ino, capture_root_dev,
720 * progfunc, progctx, and progress are used.
722 * Buffer of length at least REPARSE_POINT_MAX_SIZE bytes into which the
723 * reparse point buffer will be loaded.
725 * On success, the length of the reparse point buffer in bytes is written
728 * On success, returns a negative `enum rp_status' value.
729 * On failure, returns a positive error code.
732 winnt_get_reparse_data(HANDLE h, const wchar_t *path,
733 struct add_image_params *params,
734 u8 *rpbuf, u16 *rpbuflen_ret)
736 DWORD bytes_returned;
741 if (!DeviceIoControl(h, FSCTL_GET_REPARSE_POINT,
742 NULL, 0, rpbuf, REPARSE_POINT_MAX_SIZE,
743 &bytes_returned, NULL))
745 set_errno_from_GetLastError();
746 return WIMLIB_ERR_READ;
749 if (unlikely(bytes_returned < 8)) {
751 return WIMLIB_ERR_INVALID_REPARSE_DATA;
754 rpbuflen = bytes_returned;
755 reparse_tag = le32_to_cpu(*(le32*)rpbuf);
757 if (params->add_flags & WIMLIB_ADD_FLAG_RPFIX &&
758 (reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
759 reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
761 ret = winnt_try_rpfix(rpbuf, &rpbuflen,
762 params->capture_root_ino,
763 params->capture_root_dev,
766 *rpbuflen_ret = rpbuflen;
771 win32_tally_encrypted_size_cb(unsigned char *_data, void *_size_ret,
774 *(u64*)_size_ret += len;
775 return ERROR_SUCCESS;
779 win32_get_encrypted_file_size(const wchar_t *path, u64 *size_ret)
785 err = OpenEncryptedFileRaw(path, 0, &file_ctx);
786 if (err != ERROR_SUCCESS) {
787 set_errno_from_win32_error(err);
788 ERROR_WITH_ERRNO("Failed to open encrypted file \"%ls\" "
789 "for raw read", printable_path(path));
790 return WIMLIB_ERR_OPEN;
793 err = ReadEncryptedFileRaw(win32_tally_encrypted_size_cb,
795 if (err != ERROR_SUCCESS) {
796 set_errno_from_win32_error(err);
797 ERROR_WITH_ERRNO("Failed to read raw encrypted data from "
798 "\"%ls\"", printable_path(path));
799 ret = WIMLIB_ERR_READ;
803 CloseEncryptedFileRaw(file_ctx);
808 get_data_stream_name(const wchar_t *raw_stream_name, size_t raw_stream_name_nchars,
809 const wchar_t **stream_name_ret, size_t *stream_name_nchars_ret)
811 const wchar_t *sep, *type, *end;
813 /* The stream name should be returned as :NAME:TYPE */
814 if (raw_stream_name_nchars < 1)
816 if (raw_stream_name[0] != L':')
820 raw_stream_name_nchars--;
822 end = raw_stream_name + raw_stream_name_nchars;
824 sep = wmemchr(raw_stream_name, L':', raw_stream_name_nchars);
832 if (wmemcmp(type, L"$DATA", 5))
835 *stream_name_ret = raw_stream_name;
836 *stream_name_nchars_ret = sep - raw_stream_name;
841 build_stream_path(const wchar_t *path, size_t path_nchars,
842 const wchar_t *stream_name, size_t stream_name_nchars)
844 size_t stream_path_nchars;
845 wchar_t *stream_path;
848 stream_path_nchars = path_nchars;
849 if (stream_name_nchars)
850 stream_path_nchars += 1 + stream_name_nchars;
852 stream_path = MALLOC((stream_path_nchars + 1) * sizeof(wchar_t));
854 p = wmempcpy(stream_path, path, path_nchars);
855 if (stream_name_nchars) {
857 p = wmempcpy(p, stream_name, stream_name_nchars);
865 winnt_scan_stream(const wchar_t *path, size_t path_nchars,
866 const wchar_t *raw_stream_name, size_t raw_stream_name_nchars,
868 struct wim_inode *inode, struct list_head *unhashed_streams)
870 const wchar_t *stream_name;
871 size_t stream_name_nchars;
872 struct wim_ads_entry *ads_entry;
873 wchar_t *stream_path;
874 struct wim_lookup_table_entry *lte;
877 /* Given the raw stream name (which is something like
878 * :streamname:$DATA), extract just the stream name part.
879 * Ignore any non-$DATA streams. */
880 if (!get_data_stream_name(raw_stream_name, raw_stream_name_nchars,
881 &stream_name, &stream_name_nchars))
884 /* If this is a named stream, allocate an ADS entry for it. */
885 if (stream_name_nchars) {
886 ads_entry = inode_add_ads_utf16le(inode, stream_name,
890 return WIMLIB_ERR_NOMEM;
895 /* If the stream is empty, no lookup table entry is needed. */
896 if (stream_size == 0)
899 /* Build the path to the stream. For unnamed streams, this is simply
900 * the path to the file. For named streams, this is the path to the
901 * file, followed by a colon, followed by the stream name. */
902 stream_path = build_stream_path(path, path_nchars,
903 stream_name, stream_name_nchars);
905 return WIMLIB_ERR_NOMEM;
907 /* Set up the lookup table entry for the stream. */
908 lte = new_lookup_table_entry();
911 return WIMLIB_ERR_NOMEM;
913 lte->file_on_disk = stream_path;
914 lte->resource_location = RESOURCE_IN_WINNT_FILE_ON_DISK;
915 lte->size = stream_size;
916 if ((inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) && !ads_entry) {
917 /* Special case for encrypted file. */
919 /* OpenEncryptedFileRaw() expects Win32 name, not NT name.
920 * Change \??\ into \\?\ */
921 lte->file_on_disk[1] = L'\\';
922 wimlib_assert(!wmemcmp(lte->file_on_disk, L"\\\\?\\", 4));
927 ret = win32_get_encrypted_file_size(lte->file_on_disk,
930 free_lookup_table_entry(lte);
933 lte->size = encrypted_size;
934 lte->resource_location = RESOURCE_WIN32_ENCRYPTED;
938 stream_id = ads_entry->stream_id;
939 ads_entry->lte = lte;
944 add_unhashed_stream(lte, inode, stream_id, unhashed_streams);
949 * Load information about the streams of an open file into a WIM inode.
951 * We use the NtQueryInformationFile() system call instead of FindFirstStream()
952 * and FindNextStream(). This is done for two reasons:
954 * - FindFirstStream() opens its own handle to the file or directory and
955 * apparently does so without specifying FILE_FLAG_BACKUP_SEMANTICS, thereby
956 * causing access denied errors on certain files (even when running as the
958 * - FindFirstStream() and FindNextStream() is only available on Windows Vista
959 * and later, whereas the stream support in NtQueryInformationFile() was
960 * already present in Windows XP.
963 winnt_scan_streams(HANDLE *hFile_p, const wchar_t *path, size_t path_nchars,
964 struct wim_inode *inode, struct list_head *unhashed_streams,
965 u64 file_size, u32 vol_flags)
968 u8 _buf[1024] _aligned_attribute(8);
971 IO_STATUS_BLOCK iosb;
973 const FILE_STREAM_INFORMATION *info;
976 bufsize = sizeof(_buf);
978 if (!(vol_flags & FILE_NAMED_STREAMS))
981 /* Get a buffer containing the stream information. */
982 while (!NT_SUCCESS(status = (*func_NtQueryInformationFile)(*hFile_p,
986 FileStreamInformation)))
990 case STATUS_BUFFER_OVERFLOW:
996 newbuf = MALLOC(bufsize);
998 newbuf = REALLOC(buf, bufsize);
1000 ret = WIMLIB_ERR_NOMEM;
1006 case STATUS_NOT_IMPLEMENTED:
1007 case STATUS_NOT_SUPPORTED:
1008 case STATUS_INVALID_INFO_CLASS:
1011 set_errno_from_nt_status(status);
1012 ERROR_WITH_ERRNO("\"%ls\": Failed to query stream "
1013 "information (status=0x%08"PRIx32")",
1014 printable_path(path), (u32)status);
1015 ret = WIMLIB_ERR_READ;
1020 if (iosb.Information == 0) {
1021 /* No stream information. */
1026 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)) {
1027 /* OpenEncryptedFileRaw() seems to fail with
1028 * ERROR_SHARING_VIOLATION if there are any handles opened to
1030 (*func_NtClose)(*hFile_p);
1031 *hFile_p = INVALID_HANDLE_VALUE;
1034 /* Parse one or more stream information structures. */
1035 info = (const FILE_STREAM_INFORMATION *)buf;
1037 /* Load the stream information. */
1038 ret = winnt_scan_stream(path, path_nchars,
1040 info->StreamNameLength / 2,
1041 info->StreamSize.QuadPart,
1042 inode, unhashed_streams);
1046 if (info->NextEntryOffset == 0) {
1047 /* No more stream information. */
1050 /* Advance to next stream information. */
1051 info = (const FILE_STREAM_INFORMATION *)
1052 ((const u8 *)info + info->NextEntryOffset);
1058 /* The volume does not support named streams. Only capture the unnamed
1060 if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
1061 FILE_ATTRIBUTE_REPARSE_POINT))
1067 ret = winnt_scan_stream(path, path_nchars, L"::$DATA", 7,
1068 file_size, inode, unhashed_streams);
1070 /* Free buffer if allocated on heap. */
1071 if (unlikely(buf != _buf))
1077 winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret,
1080 size_t full_path_nchars,
1081 const wchar_t *filename,
1082 size_t filename_nchars,
1083 struct add_image_params *params,
1084 struct winnt_scan_stats *stats,
1087 struct wim_dentry *root = NULL;
1088 struct wim_inode *inode = NULL;
1089 HANDLE h = INVALID_HANDLE_VALUE;
1092 FILE_ALL_INFORMATION file_info;
1097 if (should_exclude_path(full_path + params->capture_root_nchars,
1098 full_path_nchars - params->capture_root_nchars,
1102 /* Open the file. */
1103 status = winnt_openat(cur_dir,
1104 (cur_dir ? filename : full_path),
1105 (cur_dir ? filename_nchars : full_path_nchars),
1107 FILE_READ_ATTRIBUTES |
1109 ACCESS_SYSTEM_SECURITY |
1112 if (unlikely(!NT_SUCCESS(status))) {
1113 if (status == STATUS_DELETE_PENDING) {
1114 WARNING("\"%ls\": Deletion pending; skipping file",
1115 printable_path(full_path));
1118 set_errno_from_nt_status(status);
1119 ERROR_WITH_ERRNO("\"%ls\": Can't open file "
1120 "(status=0x%08"PRIx32")",
1121 printable_path(full_path), (u32)status);
1122 ret = WIMLIB_ERR_OPEN;
1124 /* XXX: Provide option to exclude files that fail with
1125 * STATUS_SHARING_VIOLATION? */
1129 /* Get information about the file. */
1131 IO_STATUS_BLOCK iosb;
1133 status = (*func_NtQueryInformationFile)(h, &iosb,
1136 FileAllInformation);
1138 if (unlikely(!NT_SUCCESS(status) &&
1139 status != STATUS_BUFFER_OVERFLOW))
1141 set_errno_from_nt_status(status);
1142 ERROR_WITH_ERRNO("\"%ls\": Can't get file information "
1143 "(status=0x%08"PRIx32")",
1144 printable_path(full_path), (u32)status);
1145 ret = WIMLIB_ERR_STAT;
1150 if (unlikely(!cur_dir)) {
1152 /* Root of tree being captured; get volume information. */
1154 FILE_FS_ATTRIBUTE_INFORMATION attr_info;
1155 FILE_FS_VOLUME_INFORMATION vol_info;
1156 IO_STATUS_BLOCK iosb;
1158 /* Get volume flags */
1159 status = (*func_NtQueryVolumeInformationFile)(h, &iosb,
1162 FileFsAttributeInformation);
1163 if (likely((NT_SUCCESS(status) ||
1164 (status == STATUS_BUFFER_OVERFLOW)) &&
1165 (iosb.Information >=
1166 offsetof(FILE_FS_ATTRIBUTE_INFORMATION,
1167 FileSystemAttributes) +
1168 sizeof(attr_info.FileSystemAttributes))))
1170 vol_flags = attr_info.FileSystemAttributes;
1172 set_errno_from_nt_status(status);
1173 WARNING_WITH_ERRNO("\"%ls\": Can't get volume attributes "
1174 "(status=0x%08"PRIx32")",
1175 printable_path(full_path),
1180 /* Set inode number of root directory */
1181 params->capture_root_ino =
1182 file_info.InternalInformation.IndexNumber.QuadPart;
1184 /* Get volume ID. */
1185 status = (*func_NtQueryVolumeInformationFile)(h, &iosb,
1188 FileFsVolumeInformation);
1189 if (likely((NT_SUCCESS(status) ||
1190 (status == STATUS_BUFFER_OVERFLOW)) &&
1191 (iosb.Information >=
1192 offsetof(FILE_FS_VOLUME_INFORMATION,
1193 VolumeSerialNumber) +
1194 sizeof(vol_info.VolumeSerialNumber))))
1196 params->capture_root_dev = vol_info.VolumeSerialNumber;
1198 set_errno_from_nt_status(status);
1199 WARNING_WITH_ERRNO("\"%ls\": Can't get volume ID "
1200 "(status=0x%08"PRIx32")",
1201 printable_path(full_path),
1203 params->capture_root_dev = 0;
1207 /* If this is a reparse point, read the reparse data. */
1208 if (unlikely(file_info.BasicInformation.FileAttributes &
1209 FILE_ATTRIBUTE_REPARSE_POINT))
1211 rpbuf = alloca(REPARSE_POINT_MAX_SIZE);
1212 ret = winnt_get_reparse_data(h, full_path, params,
1222 ERROR_WITH_ERRNO("\"%ls\": Can't get reparse data",
1223 printable_path(full_path));
1228 /* Create a WIM dentry with an associated inode, which may be shared.
1230 * However, we need to explicitly check for directories and files with
1231 * only 1 link and refuse to hard link them. This is because Windows
1232 * has a bug where it can return duplicate File IDs for files and
1233 * directories on the FAT filesystem. */
1234 ret = inode_table_new_dentry(params->inode_table,
1236 file_info.InternalInformation.IndexNumber.QuadPart,
1237 0, /* We don't follow mount points, so we
1238 currently don't need to get the
1239 volume ID / device number. */
1240 (file_info.StandardInformation.NumberOfLinks <= 1 ||
1241 (file_info.BasicInformation.FileAttributes &
1242 FILE_ATTRIBUTE_DIRECTORY)),
1247 /* Get the short (DOS) name of the file. */
1248 status = winnt_get_short_name(h, root);
1250 /* If we can't read the short filename for any reason other than
1251 * out-of-memory, just ignore the error and assume the file has no short
1252 * name. This shouldn't be an issue, since the short names are
1253 * essentially obsolete anyway. */
1254 if (unlikely(status == STATUS_NO_MEMORY)) {
1255 ret = WIMLIB_ERR_NOMEM;
1259 inode = root->d_inode;
1261 if (inode->i_nlink > 1) {
1262 /* Shared inode (hard link); skip reading per-inode information.
1267 inode->i_attributes = file_info.BasicInformation.FileAttributes;
1268 inode->i_creation_time = file_info.BasicInformation.CreationTime.QuadPart;
1269 inode->i_last_write_time = file_info.BasicInformation.LastWriteTime.QuadPart;
1270 inode->i_last_access_time = file_info.BasicInformation.LastAccessTime.QuadPart;
1271 inode->i_resolved = 1;
1273 /* Get the file's security descriptor, unless we are capturing in
1274 * NO_ACLS mode or the volume does not support security descriptors. */
1275 if (!(params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS)
1276 && (vol_flags & FILE_PERSISTENT_ACLS))
1278 status = winnt_get_security_descriptor(h, inode,
1279 params->sd_set, stats,
1281 if (!NT_SUCCESS(status)) {
1282 set_errno_from_nt_status(status);
1283 ERROR_WITH_ERRNO("\"%ls\": Can't read security "
1284 "descriptor (status=0x%08"PRIu32")",
1285 printable_path(full_path),
1287 ret = WIMLIB_ERR_STAT;
1292 /* Load information about the unnamed data stream and any named data
1294 ret = winnt_scan_streams(&h,
1298 params->unhashed_streams,
1299 file_info.StandardInformation.EndOfFile.QuadPart,
1304 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)) {
1306 /* Reparse point: set the reparse data (already read). */
1308 inode->i_not_rpfixed = not_rpfixed;
1309 inode->i_reparse_tag = le32_to_cpu(*(le32*)rpbuf);
1310 ret = inode_set_unnamed_stream(inode, rpbuf + 8, rpbuflen - 8,
1311 params->lookup_table);
1314 } else if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
1316 /* Directory: recurse to children. */
1318 if (unlikely(h == INVALID_HANDLE_VALUE)) {
1319 /* Re-open handle that was closed to read raw encrypted
1321 status = winnt_openat(cur_dir,
1323 filename : full_path),
1325 filename_nchars : full_path_nchars),
1326 FILE_LIST_DIRECTORY | SYNCHRONIZE,
1328 if (!NT_SUCCESS(status)) {
1329 set_errno_from_nt_status(status);
1330 ERROR_WITH_ERRNO("\"%ls\": Can't re-open file "
1331 "(status=0x%08"PRIx32")",
1332 printable_path(full_path),
1334 ret = WIMLIB_ERR_OPEN;
1338 ret = winnt_recurse_directory(h,
1350 params->progress.scan.cur_path = printable_path(full_path);
1352 ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK, inode);
1354 ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL);
1356 if (likely(h != INVALID_HANDLE_VALUE))
1358 if (likely(ret == 0))
1361 free_dentry_tree(root, params->lookup_table);
1366 winnt_do_scan_warnings(const wchar_t *path, const struct winnt_scan_stats *stats)
1368 if (likely(stats->num_get_sacl_priv_notheld == 0 &&
1369 stats->num_get_sd_access_denied == 0))
1372 WARNING("Scan of \"%ls\" complete, but with one or more warnings:", path);
1373 if (stats->num_get_sacl_priv_notheld != 0) {
1374 WARNING("- Could not capture SACL (System Access Control List)\n"
1375 " on %lu files or directories.",
1376 stats->num_get_sacl_priv_notheld);
1378 if (stats->num_get_sd_access_denied != 0) {
1379 WARNING("- Could not capture security descriptor at all\n"
1380 " on %lu files or directories.",
1381 stats->num_get_sd_access_denied);
1383 WARNING("To fully capture all security descriptors, run the program\n"
1384 " with Administrator rights.");
1387 #define WINDOWS_NT_MAX_PATH 32768
1389 /* Win32 version of capturing a directory tree. */
1391 win32_build_dentry_tree(struct wim_dentry **root_ret,
1392 const wchar_t *root_disk_path,
1393 struct add_image_params *params)
1397 UNICODE_STRING ntpath;
1398 struct winnt_scan_stats stats;
1400 /* WARNING: There is no check for overflow later when this buffer is
1401 * being used! But it's as long as the maximum path length understood
1402 * by Windows NT (which is NOT the same as MAX_PATH). */
1403 path = MALLOC((WINDOWS_NT_MAX_PATH + 1) * sizeof(wchar_t));
1405 return WIMLIB_ERR_NOMEM;
1407 ret = win32_path_to_nt_path(root_disk_path, &ntpath);
1411 if (ntpath.Length < 4 * sizeof(wchar_t) ||
1412 ntpath.Length > WINDOWS_NT_MAX_PATH * sizeof(wchar_t) ||
1413 wmemcmp(ntpath.Buffer, L"\\??\\", 4))
1415 ERROR("\"%ls\": unrecognized path format", root_disk_path);
1416 ret = WIMLIB_ERR_INVALID_PARAM;
1420 params->capture_root_nchars = ntpath.Length / sizeof(wchar_t);
1421 wmemcpy(path, ntpath.Buffer, params->capture_root_nchars);
1422 path[params->capture_root_nchars] = L'\0';
1424 HeapFree(GetProcessHeap(), 0, ntpath.Buffer);
1426 memset(&stats, 0, sizeof(stats));
1428 ret = winnt_build_dentry_tree_recursive(root_ret, NULL,
1429 path, params->capture_root_nchars,
1430 L"", 0, params, &stats, 0);
1434 winnt_do_scan_warnings(root_disk_path, &stats);
1438 #endif /* __WIN32__ */