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'.'))
409 struct wim_dentry *child;
411 p = full_path + full_path_nchars;
413 p = wmempcpy(p, info->FileName,
414 info->FileNameLength / 2);
417 ret = winnt_build_dentry_tree_recursive(
422 full_path + full_path_nchars + 1,
423 info->FileNameLength / 2,
428 full_path[full_path_nchars] = L'\0';
433 dentry_add_child(parent, child);
435 if (info->NextEntryOffset == 0)
437 info = (const FILE_NAMES_INFORMATION *)
438 ((const u8 *)info + info->NextEntryOffset);
442 if (unlikely(status != STATUS_NO_MORE_FILES)) {
443 set_errno_from_nt_status(status);
444 ERROR_WITH_ERRNO("\"%ls\": Can't read directory "
445 "(status=0x%08"PRIx32")",
446 printable_path(full_path), (u32)status);
447 ret = WIMLIB_ERR_READ;
454 /* Reparse point fixup status code */
456 /* Reparse point should be excluded from capture */
459 /* Reparse point will be captured literally (no fixup) */
462 /* Reparse point will be captured with fixup */
467 file_has_ino_and_dev(HANDLE h, u64 ino, u64 dev)
470 IO_STATUS_BLOCK iosb;
471 FILE_INTERNAL_INFORMATION int_info;
472 FILE_FS_VOLUME_INFORMATION vol_info;
474 status = (*func_NtQueryInformationFile)(h, &iosb,
475 &int_info, sizeof(int_info),
476 FileInternalInformation);
477 if (!NT_SUCCESS(status))
480 if (int_info.IndexNumber.QuadPart != ino)
483 status = (*func_NtQueryVolumeInformationFile)(h, &iosb,
484 &vol_info, sizeof(vol_info),
485 FileFsVolumeInformation);
486 if (!(NT_SUCCESS(status) || status == STATUS_BUFFER_OVERFLOW))
489 if (iosb.Information <
490 offsetof(FILE_FS_VOLUME_INFORMATION, VolumeSerialNumber) +
491 sizeof(vol_info.VolumeSerialNumber))
494 return (vol_info.VolumeSerialNumber == dev);
498 * Given an (expected) NT namespace symbolic link or junction target @target of
499 * length @target_nbytes, determine if a prefix of the target points to a file
500 * identified by @capture_root_ino and @capture_root_dev.
502 * If yes, return a pointer to the portion of the link following this prefix.
504 * If no, return NULL.
506 * If the link target does not appear to be a valid NT namespace path, return
509 static const wchar_t *
510 winnt_get_root_relative_target(const wchar_t *target, size_t target_nbytes,
511 u64 capture_root_ino, u64 capture_root_dev)
514 OBJECT_ATTRIBUTES attr;
515 IO_STATUS_BLOCK iosb;
517 const wchar_t *target_end;
520 target_end = target + (target_nbytes / sizeof(wchar_t));
523 if (target_end == target)
526 /* No leading slash??? */
527 if (target[0] != L'\\')
531 if ((target_end - target) >= 2 &&
532 target[0] == L'\\' && target[1] == L'\\')
535 attr.Length = sizeof(attr);
536 attr.RootDirectory = NULL;
537 attr.ObjectName = &name;
539 attr.SecurityDescriptor = NULL;
540 attr.SecurityQualityOfService = NULL;
542 name.Buffer = (wchar_t *)target;
547 const wchar_t *orig_p = p;
549 /* Skip non-backslashes */
550 while (p != target_end && *p != L'\\')
553 /* Skip backslashes */
554 while (p != target_end && *p == L'\\')
557 /* Append path component */
558 name.Length += (p - orig_p) * sizeof(wchar_t);
559 name.MaximumLength = name.Length;
561 /* Try opening the file */
562 status = (*func_NtOpenFile) (&h,
563 FILE_READ_ATTRIBUTES | FILE_TRAVERSE,
566 FILE_SHARE_VALID_FLAGS,
567 FILE_OPEN_FOR_BACKUP_INTENT);
569 if (NT_SUCCESS(status)) {
570 /* Reset root directory */
571 if (attr.RootDirectory)
572 (*func_NtClose)(attr.RootDirectory);
573 attr.RootDirectory = h;
574 name.Buffer = (wchar_t *)p;
577 if (file_has_ino_and_dev(h, capture_root_ino,
579 goto out_close_root_dir;
581 } while (p != target_end);
586 if (attr.RootDirectory)
587 (*func_NtClose)(attr.RootDirectory);
592 winnt_rpfix_progress(struct add_image_params *params, const wchar_t *path,
593 const struct reparse_data *rpdata,
594 enum wimlib_progress_msg msg)
596 size_t print_name_nchars = rpdata->print_name_nbytes / sizeof(wchar_t);
597 wchar_t print_name0[print_name_nchars + 1];
599 wmemcpy(print_name0, rpdata->print_name, print_name_nchars);
600 print_name0[print_name_nchars] = L'\0';
602 params->progress.scan.cur_path = printable_path(path);
603 params->progress.scan.symlink_target = print_name0;
604 return do_capture_progress(params, msg, NULL);
608 winnt_try_rpfix(u8 *rpbuf, u16 *rpbuflen_p,
609 u64 capture_root_ino, u64 capture_root_dev,
610 const wchar_t *path, struct add_image_params *params)
612 struct reparse_data rpdata;
613 const wchar_t *rel_target;
616 if (parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata)) {
617 /* Couldn't even understand the reparse data. Don't try the
623 * Don't do reparse point fixups on relative symbolic links.
625 * On Windows, a relative symbolic link is supposed to be identifiable
626 * by having reparse tag WIM_IO_REPARSE_TAG_SYMLINK and flags
627 * SYMBOLIC_LINK_RELATIVE. We will use this information, although this
628 * may not always do what the user expects, since drive-relative
629 * symbolic links such as "\Users\Public" have SYMBOLIC_LINK_RELATIVE
630 * set, in addition to truely relative symbolic links such as "Users" or
631 * "Users\Public". However, WIMGAPI (as of Windows 8.1) has this same
634 * Otherwise, as far as I can tell, the targets of symbolic links that
635 * are NOT relative, as well as junctions (note: a mountpoint is the
636 * sames thing as a junction), must be NT namespace paths, for example:
638 * - \??\e:\Users\Public
639 * - \DosDevices\e:\Users\Public
640 * - \Device\HardDiskVolume4\Users\Public
641 * - \??\Volume{c47cb07c-946e-4155-b8f7-052e9cec7628}\Users\Public
642 * - \DosDevices\Volume{c47cb07c-946e-4155-b8f7-052e9cec7628}\Users\Public
644 if (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK &&
645 (rpdata.rpflags & SYMBOLIC_LINK_RELATIVE))
648 rel_target = winnt_get_root_relative_target(rpdata.substitute_name,
649 rpdata.substitute_name_nbytes,
653 /* Target points outside of the tree being captured. Exclude
654 * this reparse point from the capture (but inform the library
656 ret = winnt_rpfix_progress(params, path, &rpdata,
657 WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK);
663 if (rel_target == rpdata.substitute_name) {
664 /* Weird target --- keep the reparse point and don't mess with
669 /* We have an absolute target pointing within the directory being
670 * captured, @rel_target is the suffix of the link target that is the
671 * part relative to the directory being captured.
673 * We will cut off the prefix before this part (which is the path to the
674 * directory being captured) and add a dummy prefix. Since the process
675 * will need to be reversed when applying the image, it shouldn't matter
676 * what exactly the prefix is, as long as it looks like an absolute
681 size_t rel_target_nbytes =
682 rpdata.substitute_name_nbytes - ((const u8 *)rel_target -
683 (const u8 *)rpdata.substitute_name);
684 size_t rel_target_nchars = rel_target_nbytes / sizeof(wchar_t);
686 wchar_t tmp[rel_target_nchars + 7];
688 wmemcpy(tmp, L"\\??\\X:\\", 7);
689 wmemcpy(tmp + 7, rel_target, rel_target_nchars);
691 rpdata.substitute_name = tmp;
692 rpdata.substitute_name_nbytes = rel_target_nbytes + (7 * sizeof(wchar_t));
693 rpdata.print_name = tmp + 4;
694 rpdata.print_name_nbytes = rel_target_nbytes + (3 * sizeof(wchar_t));
696 if (make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p))
699 ret = winnt_rpfix_progress(params, path, &rpdata,
700 WIMLIB_SCAN_DENTRY_FIXED_SYMLINK);
707 * Loads the reparse point data from a reparse point into memory, optionally
708 * fixing the targets of absolute symbolic links and junction points to be
709 * relative to the root of capture.
712 * Open handle to the reparse point file.
714 * Path to the reparse point file.
716 * Capture parameters. add_flags, capture_root_ino, capture_root_dev,
717 * progfunc, progctx, and progress are used.
719 * Buffer of length at least REPARSE_POINT_MAX_SIZE bytes into which the
720 * reparse point buffer will be loaded.
722 * On success, the length of the reparse point buffer in bytes is written
725 * On success, returns a nonpositive `enum rp_status' value.
726 * On failure, returns a positive error code.
729 winnt_get_reparse_data(HANDLE h, const wchar_t *path,
730 struct add_image_params *params,
731 u8 *rpbuf, u16 *rpbuflen_ret)
733 DWORD bytes_returned;
738 if (!DeviceIoControl(h, FSCTL_GET_REPARSE_POINT,
739 NULL, 0, rpbuf, REPARSE_POINT_MAX_SIZE,
740 &bytes_returned, NULL))
742 set_errno_from_GetLastError();
743 return WIMLIB_ERR_READ;
746 if (unlikely(bytes_returned < 8)) {
748 return WIMLIB_ERR_INVALID_REPARSE_DATA;
751 rpbuflen = bytes_returned;
752 reparse_tag = le32_to_cpu(*(le32*)rpbuf);
754 if (params->add_flags & WIMLIB_ADD_FLAG_RPFIX &&
755 (reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
756 reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
758 ret = winnt_try_rpfix(rpbuf, &rpbuflen,
759 params->capture_root_ino,
760 params->capture_root_dev,
763 *rpbuflen_ret = rpbuflen;
768 win32_tally_encrypted_size_cb(unsigned char *_data, void *_size_ret,
771 *(u64*)_size_ret += len;
772 return ERROR_SUCCESS;
776 win32_get_encrypted_file_size(const wchar_t *path, u64 *size_ret)
782 err = OpenEncryptedFileRaw(path, 0, &file_ctx);
783 if (err != ERROR_SUCCESS) {
784 set_errno_from_win32_error(err);
785 ERROR_WITH_ERRNO("Failed to open encrypted file \"%ls\" "
786 "for raw read", printable_path(path));
787 return WIMLIB_ERR_OPEN;
790 err = ReadEncryptedFileRaw(win32_tally_encrypted_size_cb,
792 if (err != ERROR_SUCCESS) {
793 set_errno_from_win32_error(err);
794 ERROR_WITH_ERRNO("Failed to read raw encrypted data from "
795 "\"%ls\"", printable_path(path));
796 ret = WIMLIB_ERR_READ;
800 CloseEncryptedFileRaw(file_ctx);
805 get_data_stream_name(const wchar_t *raw_stream_name, size_t raw_stream_name_nchars,
806 const wchar_t **stream_name_ret, size_t *stream_name_nchars_ret)
808 const wchar_t *sep, *type, *end;
810 /* The stream name should be returned as :NAME:TYPE */
811 if (raw_stream_name_nchars < 1)
813 if (raw_stream_name[0] != L':')
817 raw_stream_name_nchars--;
819 end = raw_stream_name + raw_stream_name_nchars;
821 sep = wmemchr(raw_stream_name, L':', raw_stream_name_nchars);
829 if (wmemcmp(type, L"$DATA", 5))
832 *stream_name_ret = raw_stream_name;
833 *stream_name_nchars_ret = sep - raw_stream_name;
838 build_stream_path(const wchar_t *path, size_t path_nchars,
839 const wchar_t *stream_name, size_t stream_name_nchars)
841 size_t stream_path_nchars;
842 wchar_t *stream_path;
845 stream_path_nchars = path_nchars;
846 if (stream_name_nchars)
847 stream_path_nchars += 1 + stream_name_nchars;
849 stream_path = MALLOC((stream_path_nchars + 1) * sizeof(wchar_t));
851 p = wmempcpy(stream_path, path, path_nchars);
852 if (stream_name_nchars) {
854 p = wmempcpy(p, stream_name, stream_name_nchars);
862 winnt_scan_stream(const wchar_t *path, size_t path_nchars,
863 const wchar_t *raw_stream_name, size_t raw_stream_name_nchars,
865 struct wim_inode *inode, struct list_head *unhashed_streams)
867 const wchar_t *stream_name;
868 size_t stream_name_nchars;
869 struct wim_ads_entry *ads_entry;
870 wchar_t *stream_path;
871 struct wim_lookup_table_entry *lte;
874 /* Given the raw stream name (which is something like
875 * :streamname:$DATA), extract just the stream name part.
876 * Ignore any non-$DATA streams. */
877 if (!get_data_stream_name(raw_stream_name, raw_stream_name_nchars,
878 &stream_name, &stream_name_nchars))
881 /* If this is a named stream, allocate an ADS entry for it. */
882 if (stream_name_nchars) {
883 ads_entry = inode_add_ads_utf16le(inode, stream_name,
887 return WIMLIB_ERR_NOMEM;
892 /* If the stream is empty, no lookup table entry is needed. */
893 if (stream_size == 0)
896 /* Build the path to the stream. For unnamed streams, this is simply
897 * the path to the file. For named streams, this is the path to the
898 * file, followed by a colon, followed by the stream name. */
899 stream_path = build_stream_path(path, path_nchars,
900 stream_name, stream_name_nchars);
902 return WIMLIB_ERR_NOMEM;
904 /* Set up the lookup table entry for the stream. */
905 lte = new_lookup_table_entry();
908 return WIMLIB_ERR_NOMEM;
910 lte->file_on_disk = stream_path;
911 lte->resource_location = RESOURCE_IN_WINNT_FILE_ON_DISK;
912 lte->size = stream_size;
913 if ((inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) && !ads_entry) {
914 /* Special case for encrypted file. */
916 /* OpenEncryptedFileRaw() expects Win32 name, not NT name.
917 * Change \??\ into \\?\ */
918 lte->file_on_disk[1] = L'\\';
919 wimlib_assert(!wmemcmp(lte->file_on_disk, L"\\\\?\\", 4));
924 ret = win32_get_encrypted_file_size(lte->file_on_disk,
927 free_lookup_table_entry(lte);
930 lte->size = encrypted_size;
931 lte->resource_location = RESOURCE_WIN32_ENCRYPTED;
935 stream_id = ads_entry->stream_id;
936 ads_entry->lte = lte;
941 add_unhashed_stream(lte, inode, stream_id, unhashed_streams);
946 * Load information about the streams of an open file into a WIM inode.
948 * We use the NtQueryInformationFile() system call instead of FindFirstStream()
949 * and FindNextStream(). This is done for two reasons:
951 * - FindFirstStream() opens its own handle to the file or directory and
952 * apparently does so without specifying FILE_FLAG_BACKUP_SEMANTICS, thereby
953 * causing access denied errors on certain files (even when running as the
955 * - FindFirstStream() and FindNextStream() is only available on Windows Vista
956 * and later, whereas the stream support in NtQueryInformationFile() was
957 * already present in Windows XP.
960 winnt_scan_streams(HANDLE *hFile_p, const wchar_t *path, size_t path_nchars,
961 struct wim_inode *inode, struct list_head *unhashed_streams,
962 u64 file_size, u32 vol_flags)
965 u8 _buf[1024] _aligned_attribute(8);
968 IO_STATUS_BLOCK iosb;
970 const FILE_STREAM_INFORMATION *info;
973 bufsize = sizeof(_buf);
975 if (!(vol_flags & FILE_NAMED_STREAMS))
978 /* Get a buffer containing the stream information. */
979 while (!NT_SUCCESS(status = (*func_NtQueryInformationFile)(*hFile_p,
983 FileStreamInformation)))
987 case STATUS_BUFFER_OVERFLOW:
993 newbuf = MALLOC(bufsize);
995 newbuf = REALLOC(buf, bufsize);
997 ret = WIMLIB_ERR_NOMEM;
1003 case STATUS_NOT_IMPLEMENTED:
1004 case STATUS_NOT_SUPPORTED:
1005 case STATUS_INVALID_INFO_CLASS:
1008 set_errno_from_nt_status(status);
1009 ERROR_WITH_ERRNO("\"%ls\": Failed to query stream "
1010 "information (status=0x%08"PRIx32")",
1011 printable_path(path), (u32)status);
1012 ret = WIMLIB_ERR_READ;
1017 if (iosb.Information == 0) {
1018 /* No stream information. */
1023 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)) {
1024 /* OpenEncryptedFileRaw() seems to fail with
1025 * ERROR_SHARING_VIOLATION if there are any handles opened to
1027 (*func_NtClose)(*hFile_p);
1028 *hFile_p = INVALID_HANDLE_VALUE;
1031 /* Parse one or more stream information structures. */
1032 info = (const FILE_STREAM_INFORMATION *)buf;
1034 /* Load the stream information. */
1035 ret = winnt_scan_stream(path, path_nchars,
1037 info->StreamNameLength / 2,
1038 info->StreamSize.QuadPart,
1039 inode, unhashed_streams);
1043 if (info->NextEntryOffset == 0) {
1044 /* No more stream information. */
1047 /* Advance to next stream information. */
1048 info = (const FILE_STREAM_INFORMATION *)
1049 ((const u8 *)info + info->NextEntryOffset);
1055 /* The volume does not support named streams. Only capture the unnamed
1057 if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
1058 FILE_ATTRIBUTE_REPARSE_POINT))
1064 ret = winnt_scan_stream(path, path_nchars, L"::$DATA", 7,
1065 file_size, inode, unhashed_streams);
1067 /* Free buffer if allocated on heap. */
1068 if (unlikely(buf != _buf))
1074 winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret,
1077 size_t full_path_nchars,
1078 const wchar_t *filename,
1079 size_t filename_nchars,
1080 struct add_image_params *params,
1081 struct winnt_scan_stats *stats,
1084 struct wim_dentry *root = NULL;
1085 struct wim_inode *inode = NULL;
1086 HANDLE h = INVALID_HANDLE_VALUE;
1089 FILE_ALL_INFORMATION file_info;
1094 if (should_exclude_path(full_path + params->capture_root_nchars,
1095 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 set_errno_from_nt_status(status);
1114 ERROR_WITH_ERRNO("\"%ls\": Can't open file "
1115 "(status=0x%08"PRIx32")",
1116 printable_path(full_path), (u32)status);
1117 ret = WIMLIB_ERR_OPEN;
1121 /* Get information about the file. */
1123 IO_STATUS_BLOCK iosb;
1125 status = (*func_NtQueryInformationFile)(h, &iosb,
1128 FileAllInformation);
1130 if (unlikely(!NT_SUCCESS(status) &&
1131 status != STATUS_BUFFER_OVERFLOW))
1133 set_errno_from_nt_status(status);
1134 ERROR_WITH_ERRNO("\"%ls\": Can't get file information "
1135 "(status=0x%08"PRIx32")",
1136 printable_path(full_path), (u32)status);
1137 ret = WIMLIB_ERR_STAT;
1142 if (unlikely(!cur_dir)) {
1144 /* Root of tree being captured; get volume information. */
1146 FILE_FS_ATTRIBUTE_INFORMATION attr_info;
1147 FILE_FS_VOLUME_INFORMATION vol_info;
1148 IO_STATUS_BLOCK iosb;
1150 /* Get volume flags */
1151 status = (*func_NtQueryVolumeInformationFile)(h, &iosb,
1154 FileFsAttributeInformation);
1155 if (likely((NT_SUCCESS(status) ||
1156 (status == STATUS_BUFFER_OVERFLOW)) &&
1157 (iosb.Information >=
1158 offsetof(FILE_FS_ATTRIBUTE_INFORMATION,
1159 FileSystemAttributes) +
1160 sizeof(attr_info.FileSystemAttributes))))
1162 vol_flags = attr_info.FileSystemAttributes;
1164 set_errno_from_nt_status(status);
1165 WARNING_WITH_ERRNO("\"%ls\": Can't get volume attributes "
1166 "(status=0x%08"PRIx32")",
1167 printable_path(full_path),
1172 /* Set inode number of root directory */
1173 params->capture_root_ino =
1174 file_info.InternalInformation.IndexNumber.QuadPart;
1176 /* Get volume ID. */
1177 status = (*func_NtQueryVolumeInformationFile)(h, &iosb,
1180 FileFsVolumeInformation);
1181 if (likely((NT_SUCCESS(status) ||
1182 (status == STATUS_BUFFER_OVERFLOW)) &&
1183 (iosb.Information >=
1184 offsetof(FILE_FS_VOLUME_INFORMATION,
1185 VolumeSerialNumber) +
1186 sizeof(vol_info.VolumeSerialNumber))))
1188 params->capture_root_dev = vol_info.VolumeSerialNumber;
1190 set_errno_from_nt_status(status);
1191 WARNING_WITH_ERRNO("\"%ls\": Can't get volume ID "
1192 "(status=0x%08"PRIx32")",
1193 printable_path(full_path),
1195 params->capture_root_dev = 0;
1199 /* If this is a reparse point, read the reparse data. */
1200 if (unlikely(file_info.BasicInformation.FileAttributes &
1201 FILE_ATTRIBUTE_REPARSE_POINT))
1203 rpbuf = alloca(REPARSE_POINT_MAX_SIZE);
1204 ret = winnt_get_reparse_data(h, full_path, params,
1217 ERROR_WITH_ERRNO("\"%ls\": Can't get reparse data",
1218 printable_path(full_path));
1223 /* Create a WIM dentry with an associated inode, which may be shared.
1225 * However, we need to explicitly check for directories and files with
1226 * only 1 link and refuse to hard link them. This is because Windows
1227 * has a bug where it can return duplicate File IDs for files and
1228 * directories on the FAT filesystem. */
1229 ret = inode_table_new_dentry(params->inode_table,
1231 file_info.InternalInformation.IndexNumber.QuadPart,
1232 0, /* We don't follow mount points, so we
1233 currently don't need to get the
1234 volume ID / device number. */
1235 (file_info.StandardInformation.NumberOfLinks <= 1 ||
1236 (file_info.BasicInformation.FileAttributes &
1237 FILE_ATTRIBUTE_DIRECTORY)),
1242 /* Get the short (DOS) name of the file. */
1243 status = winnt_get_short_name(h, root);
1245 /* If we can't read the short filename for any reason other than
1246 * out-of-memory, just ignore the error and assume the file has no short
1247 * name. This shouldn't be an issue, since the short names are
1248 * essentially obsolete anyway. */
1249 if (unlikely(status == STATUS_NO_MEMORY)) {
1250 ret = WIMLIB_ERR_NOMEM;
1254 inode = root->d_inode;
1256 if (inode->i_nlink > 1) {
1257 /* Shared inode (hard link); skip reading per-inode information.
1263 inode->i_attributes = file_info.BasicInformation.FileAttributes;
1264 inode->i_creation_time = file_info.BasicInformation.CreationTime.QuadPart;
1265 inode->i_last_write_time = file_info.BasicInformation.LastWriteTime.QuadPart;
1266 inode->i_last_access_time = file_info.BasicInformation.LastAccessTime.QuadPart;
1267 inode->i_resolved = 1;
1269 /* Get the file's security descriptor, unless we are capturing in
1270 * NO_ACLS mode or the volume does not support security descriptors. */
1271 if (!(params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS)
1272 && (vol_flags & FILE_PERSISTENT_ACLS))
1274 status = winnt_get_security_descriptor(h, inode,
1275 params->sd_set, stats,
1277 if (!NT_SUCCESS(status)) {
1278 set_errno_from_nt_status(status);
1279 ERROR_WITH_ERRNO("\"%ls\": Can't read security "
1280 "descriptor (status=0x%08"PRIu32")",
1281 printable_path(full_path),
1283 ret = WIMLIB_ERR_STAT;
1288 /* Load information about the unnamed data stream and any named data
1290 ret = winnt_scan_streams(&h,
1294 params->unhashed_streams,
1295 file_info.StandardInformation.EndOfFile.QuadPart,
1300 if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)) {
1302 /* Reparse point: set the reparse data (already read). */
1304 inode->i_not_rpfixed = not_rpfixed;
1305 inode->i_reparse_tag = le32_to_cpu(*(le32*)rpbuf);
1306 ret = inode_set_unnamed_stream(inode, rpbuf + 8, rpbuflen - 8,
1307 params->lookup_table);
1310 } else if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
1312 /* Directory: recurse to children. */
1314 if (unlikely(h == INVALID_HANDLE_VALUE)) {
1315 /* Re-open handle that was closed to read raw encrypted
1317 status = winnt_openat(cur_dir,
1319 filename : full_path),
1321 filename_nchars : full_path_nchars),
1322 FILE_LIST_DIRECTORY | SYNCHRONIZE,
1324 if (!NT_SUCCESS(status)) {
1325 set_errno_from_nt_status(status);
1326 ERROR_WITH_ERRNO("\"%ls\": Can't re-open file "
1327 "(status=0x%08"PRIx32")",
1328 printable_path(full_path),
1330 ret = WIMLIB_ERR_OPEN;
1334 ret = winnt_recurse_directory(h,
1346 params->progress.scan.cur_path = printable_path(full_path);
1348 ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK, inode);
1350 ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL);
1352 if (likely(h != INVALID_HANDLE_VALUE))
1354 if (likely(ret == 0))
1357 free_dentry_tree(root, params->lookup_table);
1362 winnt_do_scan_warnings(const wchar_t *path, const struct winnt_scan_stats *stats)
1364 if (likely(stats->num_get_sacl_priv_notheld == 0 &&
1365 stats->num_get_sd_access_denied == 0))
1368 WARNING("Scan of \"%ls\" complete, but with one or more warnings:", path);
1369 if (stats->num_get_sacl_priv_notheld != 0) {
1370 WARNING("- Could not capture SACL (System Access Control List)\n"
1371 " on %lu files or directories.",
1372 stats->num_get_sacl_priv_notheld);
1374 if (stats->num_get_sd_access_denied != 0) {
1375 WARNING("- Could not capture security descriptor at all\n"
1376 " on %lu files or directories.",
1377 stats->num_get_sd_access_denied);
1379 WARNING("To fully capture all security descriptors, run the program\n"
1380 " with Administrator rights.");
1383 #define WINDOWS_NT_MAX_PATH 32768
1385 /* Win32 version of capturing a directory tree. */
1387 win32_build_dentry_tree(struct wim_dentry **root_ret,
1388 const wchar_t *root_disk_path,
1389 struct add_image_params *params)
1395 struct winnt_scan_stats stats;
1397 /* WARNING: There is no check for overflow later when this buffer is
1398 * being used! But it's as long as the maximum path length understood
1399 * by Windows NT (which is NOT the same as MAX_PATH). */
1400 path = MALLOC((WINDOWS_NT_MAX_PATH + 1) * sizeof(wchar_t));
1402 return WIMLIB_ERR_NOMEM;
1404 /* Translate into full path. */
1405 dret = GetFullPathName(root_disk_path, WINDOWS_NT_MAX_PATH - 3,
1408 if (unlikely(dret == 0 || dret >= WINDOWS_NT_MAX_PATH - 3)) {
1409 ERROR("Can't get full path name for \"%ls\"", root_disk_path);
1410 return WIMLIB_ERR_UNSUPPORTED;
1413 /* Add \??\ prefix to form the NT namespace path. */
1414 wmemcpy(path, L"\\??\\", 4);
1415 path_nchars = dret + 4;
1417 /* Strip trailing slashes. If we don't do this, we may create a path
1418 * with multiple consecutive backslashes, which for some reason causes
1419 * Windows to report that the file cannot be found. */
1420 while (unlikely(path[path_nchars - 1] == L'\\' &&
1421 path[path_nchars - 2] != L':'))
1422 path[--path_nchars] = L'\0';
1424 params->capture_root_nchars = path_nchars;
1426 memset(&stats, 0, sizeof(stats));
1428 ret = winnt_build_dentry_tree_recursive(root_ret, NULL,
1429 path, path_nchars, L"", 0,
1433 winnt_do_scan_warnings(root_disk_path, &stats);
1437 #endif /* __WIN32__ */