2 * win32_capture.c - Windows-specific code for capturing files into a WIM image.
6 * Copyright (C) 2013 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
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)
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
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/.
30 #include "wimlib/win32_common.h"
32 #include "wimlib/capture.h"
33 #include "wimlib/endianness.h"
34 #include "wimlib/error.h"
35 #include "wimlib/lookup_table.h"
36 #include "wimlib/paths.h"
37 #include "wimlib/reparse.h"
39 #define MAX_GET_SD_ACCESS_DENIED_WARNINGS 1
40 #define MAX_GET_SACL_PRIV_NOTHELD_WARNINGS 1
41 #define MAX_CAPTURE_LONG_PATH_WARNINGS 5
43 struct win32_capture_state {
44 unsigned long num_get_sd_access_denied;
45 unsigned long num_get_sacl_priv_notheld;
46 unsigned long num_long_path_warnings;
50 static const wchar_t *capture_access_denied_msg =
51 L" If you are not running this program as the administrator, you may\n"
52 " need to do so, so that all data and metadata can be backed up.\n"
53 " Otherwise, there may be no way to access the desired data or\n"
54 " metadata without taking ownership of the file or directory.\n"
58 read_win32_file_prefix(const struct wim_lookup_table_entry *lte,
60 consume_data_callback_t cb,
67 HANDLE hFile = win32_open_existing_file(lte->file_on_disk,
69 if (hFile == INVALID_HANDLE_VALUE) {
70 set_errno_from_GetLastError();
71 ERROR_WITH_ERRNO("Failed to open \"%ls\"", lte->file_on_disk);
72 return WIMLIB_ERR_OPEN;
75 bytes_remaining = size;
76 while (bytes_remaining) {
77 DWORD bytesToRead, bytesRead;
79 bytesToRead = min(sizeof(buf), bytes_remaining);
80 if (!ReadFile(hFile, buf, bytesToRead, &bytesRead, NULL) ||
81 bytesRead != bytesToRead)
83 set_errno_from_GetLastError();
84 ERROR_WITH_ERRNO("Failed to read data from \"%ls\"",
86 ret = WIMLIB_ERR_READ;
89 bytes_remaining -= bytesRead;
90 ret = (*cb)(buf, bytesRead, cb_ctx);
99 struct win32_encrypted_read_ctx {
100 consume_data_callback_t read_prefix_cb;
101 void *read_prefix_ctx;
107 win32_encrypted_export_cb(unsigned char *data, void *_ctx, unsigned long len)
109 struct win32_encrypted_read_ctx *ctx = _ctx;
111 size_t bytes_to_consume = min(len, ctx->bytes_remaining);
113 ret = (*ctx->read_prefix_cb)(data, bytes_to_consume, ctx->read_prefix_ctx);
115 ctx->wimlib_err_code = ret;
116 /* Shouldn't matter what error code is returned here, as long as
117 * it isn't ERROR_SUCCESS. */
118 return ERROR_READ_FAULT;
120 ctx->bytes_remaining -= bytes_to_consume;
121 return ERROR_SUCCESS;
125 read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte,
127 consume_data_callback_t cb,
130 struct win32_encrypted_read_ctx export_ctx;
135 DEBUG("Reading %"PRIu64" bytes from encryted file \"%ls\"",
136 size, lte->file_on_disk);
138 export_ctx.read_prefix_cb = cb;
139 export_ctx.read_prefix_ctx = cb_ctx;
140 export_ctx.wimlib_err_code = 0;
141 export_ctx.bytes_remaining = size;
143 err = OpenEncryptedFileRaw(lte->file_on_disk, 0, &file_ctx);
144 if (err != ERROR_SUCCESS) {
145 set_errno_from_win32_error(err);
146 ERROR_WITH_ERRNO("Failed to open encrypted file \"%ls\" "
147 "for raw read", lte->file_on_disk);
148 return WIMLIB_ERR_OPEN;
150 err = ReadEncryptedFileRaw(win32_encrypted_export_cb,
151 &export_ctx, file_ctx);
152 if (err != ERROR_SUCCESS) {
153 set_errno_from_win32_error(err);
154 ERROR_WITH_ERRNO("Failed to read encrypted file \"%ls\"",
156 ret = export_ctx.wimlib_err_code;
158 ret = WIMLIB_ERR_READ;
159 } else if (export_ctx.bytes_remaining != 0) {
160 ERROR("Only could read %"PRIu64" of %"PRIu64" bytes from "
161 "encryted file \"%ls\"",
162 size - export_ctx.bytes_remaining, size,
164 ret = WIMLIB_ERR_READ;
168 CloseEncryptedFileRaw(file_ctx);
174 FILETIME_to_u64(const FILETIME *ft)
176 return ((u64)ft->dwHighDateTime << 32) | (u64)ft->dwLowDateTime;
179 /* Load the short name of a file into a WIM dentry.
181 * If we can't read the short filename for some reason, we just ignore the error
182 * and assume the file has no short name. This shouldn't be an issue, since the
183 * short names are essentially obsolete anyway.
186 win32_get_short_name(HANDLE hFile, const wchar_t *path, struct wim_dentry *dentry)
189 /* It's not any harder to just make the NtQueryInformationFile() system
190 * call ourselves, and it saves a dumb call to FindFirstFile() which of
191 * course has to create its own handle. */
193 if (func_NtQueryInformationFile) {
195 IO_STATUS_BLOCK io_status;
196 u8 buf[128] _aligned_attribute(8);
197 const FILE_NAME_INFORMATION *info;
199 status = (*func_NtQueryInformationFile)(hFile, &io_status, buf, sizeof(buf),
200 FileAlternateNameInformation);
201 info = (const FILE_NAME_INFORMATION*)buf;
202 if (status == STATUS_SUCCESS && info->FileNameLength != 0) {
203 dentry->short_name = MALLOC(info->FileNameLength + 2);
204 if (!dentry->short_name)
205 return WIMLIB_ERR_NOMEM;
206 memcpy(dentry->short_name, info->FileName,
207 info->FileNameLength);
208 dentry->short_name[info->FileNameLength / 2] = L'\0';
209 dentry->short_name_nbytes = info->FileNameLength;
215 WIN32_FIND_DATAW dat;
219 hFind = FindFirstFile(path, &dat);
220 if (hFind != INVALID_HANDLE_VALUE) {
221 if (dat.cAlternateFileName[0] != L'\0') {
222 DEBUG("\"%ls\": short name \"%ls\"", path, dat.cAlternateFileName);
223 size_t short_name_nbytes = wcslen(dat.cAlternateFileName) *
225 size_t n = short_name_nbytes + sizeof(wchar_t);
226 dentry->short_name = MALLOC(n);
227 if (dentry->short_name) {
228 memcpy(dentry->short_name, dat.cAlternateFileName, n);
229 dentry->short_name_nbytes = short_name_nbytes;
231 ret = WIMLIB_ERR_NOMEM;
240 * win32_query_security_descriptor() - Query a file's security descriptor
242 * We need the file's security descriptor in SECURITY_DESCRIPTOR_RELATIVE
243 * format, and we currently have a handle opened with as many relevant
244 * permissions as possible. At this point, on Windows there are a number of
245 * options for reading a file's security descriptor:
247 * GetFileSecurity(): This takes in a path and returns the
248 * SECURITY_DESCRIPTOR_RELATIVE. Problem: this uses an internal handle, not
249 * ours, and the handle created internally doesn't specify
250 * FILE_FLAG_BACKUP_SEMANTICS. Therefore there can be access denied errors on
251 * some files and directories, even when running as the Administrator.
253 * GetSecurityInfo(): This takes in a handle and returns the security
254 * descriptor split into a bunch of different parts. This should work, but it's
255 * dumb because we have to put the security descriptor back together again.
257 * BackupRead(): This can read the security descriptor, but this is a
258 * difficult-to-use API, probably only works as the Administrator, and the
259 * format of the returned data is not well documented.
261 * NtQuerySecurityObject(): This is exactly what we need, as it takes in a
262 * handle and returns the security descriptor in SECURITY_DESCRIPTOR_RELATIVE
263 * format. Only problem is that it's a ntdll function and therefore not
264 * officially part of the Win32 API. Oh well.
267 win32_query_security_descriptor(HANDLE hFile, const wchar_t *path,
268 SECURITY_INFORMATION requestedInformation,
269 SECURITY_DESCRIPTOR *buf,
270 DWORD bufsize, DWORD *lengthNeeded)
273 if (func_NtQuerySecurityObject) {
276 status = (*func_NtQuerySecurityObject)(hFile,
277 requestedInformation, buf,
278 bufsize, lengthNeeded);
279 /* Since it queries an already-open handle, NtQuerySecurityObject()
280 * apparently returns STATUS_ACCESS_DENIED rather than
281 * STATUS_PRIVILEGE_NOT_HELD. */
282 if (status == STATUS_ACCESS_DENIED)
283 return ERROR_PRIVILEGE_NOT_HELD;
285 return (*func_RtlNtStatusToDosError)(status);
288 if (GetFileSecurity(path, requestedInformation, buf,
289 bufsize, lengthNeeded))
290 return ERROR_SUCCESS;
292 return GetLastError();
296 win32_get_security_descriptor(HANDLE hFile,
298 struct wim_inode *inode,
299 struct wim_sd_set *sd_set,
300 struct win32_capture_state *state,
303 SECURITY_INFORMATION requestedInformation;
311 requestedInformation = DACL_SECURITY_INFORMATION |
312 SACL_SECURITY_INFORMATION |
313 OWNER_SECURITY_INFORMATION |
314 GROUP_SECURITY_INFORMATION;
316 bufsize = sizeof(_buf);
318 err = win32_query_security_descriptor(hFile, path,
319 requestedInformation,
320 (SECURITY_DESCRIPTOR*)buf,
321 bufsize, &lenNeeded);
324 goto have_descriptor;
325 case ERROR_INSUFFICIENT_BUFFER:
326 wimlib_assert(buf == _buf);
327 buf = MALLOC(lenNeeded);
329 return WIMLIB_ERR_NOMEM;
332 case ERROR_PRIVILEGE_NOT_HELD:
333 if (add_flags & WIMLIB_ADD_FLAG_STRICT_ACLS)
335 if (requestedInformation & SACL_SECURITY_INFORMATION) {
336 state->num_get_sacl_priv_notheld++;
337 requestedInformation &= ~SACL_SECURITY_INFORMATION;
341 case ERROR_ACCESS_DENIED:
342 if (add_flags & WIMLIB_ADD_FLAG_STRICT_ACLS)
344 state->num_get_sd_access_denied++;
349 set_errno_from_win32_error(err);
350 ERROR_WITH_ERRNO("Failed to read security descriptor of \"%ls\"", path);
351 ret = WIMLIB_ERR_READ;
357 inode->i_security_id = sd_set_add_sd(sd_set, buf, lenNeeded);
358 if (inode->i_security_id < 0)
359 ret = WIMLIB_ERR_NOMEM;
369 win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
371 size_t path_num_chars,
372 struct add_image_params *params,
373 struct win32_capture_state *state,
376 /* Reads the directory entries of directory and recursively calls
377 * win32_build_dentry_tree() on them. */
379 win32_recurse_directory(HANDLE hDir,
381 size_t dir_path_num_chars,
382 struct wim_dentry *root,
383 struct add_image_params *params,
384 struct win32_capture_state *state,
389 DEBUG("Recurse to directory \"%ls\"", dir_path);
391 /* Using NtQueryDirectoryFile() we can re-use the same open handle,
392 * which we opened with FILE_FLAG_BACKUP_SEMANTICS (probably not the
393 * case for the FindFirstFile() API; it's not documented). */
395 if (!func_NtQueryDirectoryFile)
396 goto use_FindFirstFile;
399 IO_STATUS_BLOCK io_status;
400 const size_t bufsize = 8192;
402 BOOL restartScan = TRUE;
403 const FILE_NAMES_INFORMATION *info;
405 buf = MALLOC(bufsize);
407 return WIMLIB_ERR_NOMEM;
409 status = (*func_NtQueryDirectoryFile)(hDir, NULL, NULL, NULL,
410 &io_status, buf, bufsize,
411 FileNamesInformation,
412 FALSE, NULL, restartScan);
414 if (status != STATUS_SUCCESS) {
415 if (status == STATUS_NO_MORE_FILES ||
416 status == STATUS_NO_MORE_ENTRIES ||
417 status == STATUS_NO_MORE_MATCHES) {
419 } else if (status == STATUS_NOT_IMPLEMENTED ||
420 status == STATUS_NOT_SUPPORTED ||
421 status == STATUS_INVALID_INFO_CLASS) {
423 goto use_FindFirstFile;
425 set_errno_from_nt_status(status);
426 ERROR_WITH_ERRNO("Failed to read directory "
427 "\"%ls\"", dir_path);
428 ret = WIMLIB_ERR_READ;
432 wimlib_assert(io_status.Information != 0);
433 info = (const FILE_NAMES_INFORMATION*)buf;
435 if (!(info->FileNameLength == 2 && info->FileName[0] == L'.') &&
436 !(info->FileNameLength == 4 && info->FileName[0] == L'.' &&
437 info->FileName[1] == L'.'))
440 struct wim_dentry *child;
442 p = dir_path + dir_path_num_chars;
444 p = wmempcpy(p, info->FileName,
445 info->FileNameLength / 2);
448 ret = win32_build_dentry_tree_recursive(
456 dir_path[dir_path_num_chars] = L'\0';
461 dentry_add_child(root, child);
463 if (info->NextEntryOffset == 0)
465 info = (const FILE_NAMES_INFORMATION*)
466 ((const u8*)info + info->NextEntryOffset);
476 WIN32_FIND_DATAW dat;
480 /* Begin reading the directory by calling FindFirstFileW. Unlike UNIX
481 * opendir(), FindFirstFileW has file globbing built into it. But this
482 * isn't what we actually want, so just add a dummy glob to get all
484 dir_path[dir_path_num_chars] = OS_PREFERRED_PATH_SEPARATOR;
485 dir_path[dir_path_num_chars + 1] = L'*';
486 dir_path[dir_path_num_chars + 2] = L'\0';
487 hFind = FindFirstFile(dir_path, &dat);
488 dir_path[dir_path_num_chars] = L'\0';
490 if (hFind == INVALID_HANDLE_VALUE) {
491 err = GetLastError();
492 if (err == ERROR_FILE_NOT_FOUND) {
495 set_errno_from_win32_error(err);
496 ERROR_WITH_ERRNO("Failed to read directory \"%ls\"",
498 return WIMLIB_ERR_READ;
503 /* Skip . and .. entries */
504 if (dat.cFileName[0] == L'.' &&
505 (dat.cFileName[1] == L'\0' ||
506 (dat.cFileName[1] == L'.' &&
507 dat.cFileName[2] == L'\0')))
509 size_t filename_len = wcslen(dat.cFileName);
511 dir_path[dir_path_num_chars] = OS_PREFERRED_PATH_SEPARATOR;
512 wmemcpy(dir_path + dir_path_num_chars + 1,
516 struct wim_dentry *child;
517 size_t path_len = dir_path_num_chars + 1 + filename_len;
518 ret = win32_build_dentry_tree_recursive(&child,
524 dir_path[dir_path_num_chars] = L'\0';
528 dentry_add_child(root, child);
529 } while (FindNextFile(hFind, &dat));
530 err = GetLastError();
531 if (err != ERROR_NO_MORE_FILES) {
532 set_errno_from_win32_error(err);
533 ERROR_WITH_ERRNO("Failed to read directory \"%ls\"", dir_path);
535 ret = WIMLIB_ERR_READ;
542 /* Reparse point fixup status code */
544 /* Reparse point corresponded to an absolute symbolic link or junction
545 * point that pointed outside the directory tree being captured, and
546 * therefore was excluded. */
549 /* Reparse point was not fixed as it was either a relative symbolic
550 * link, a mount point, or something else we could not understand. */
553 /* Reparse point corresponded to an absolute symbolic link or junction
554 * point that pointed inside the directory tree being captured, where
555 * the target was specified by a "full" \??\ prefixed path, and
556 * therefore was fixed to be relative to the root of the directory tree
558 RP_FIXED_FULLPATH = 0x2,
560 /* Same as RP_FIXED_FULLPATH, except the absolute link target did not
561 * have the \??\ prefix. It may have begun with a drive letter though.
563 RP_FIXED_ABSPATH = 0x4,
565 /* Either RP_FIXED_FULLPATH or RP_FIXED_ABSPATH. */
566 RP_FIXED = RP_FIXED_FULLPATH | RP_FIXED_ABSPATH,
569 /* Given the "substitute name" target of a Windows reparse point, try doing a
570 * fixup where we change it to be absolute relative to the root of the directory
571 * tree being captured.
573 * Note that this is only executed when WIMLIB_ADD_FLAG_RPFIX has been
576 * @capture_root_ino and @capture_root_dev indicate the inode number and device
577 * of the root of the directory tree being captured. They are meant to identify
578 * this directory (as an alternative to its actual path, which could potentially
579 * be reached via multiple destinations due to other symbolic links). This may
580 * not work properly on FAT, which doesn't seem to supply proper inode numbers
581 * or file IDs. However, FAT doesn't support reparse points so this function
582 * wouldn't even be called anyway.
584 static enum rp_status
585 win32_capture_maybe_rpfix_target(wchar_t *target, u16 *target_nbytes_p,
586 u64 capture_root_ino, u64 capture_root_dev,
589 u16 target_nchars = *target_nbytes_p / 2;
590 size_t stripped_chars;
591 wchar_t *orig_target;
594 ret = parse_substitute_name(target, *target_nbytes_p, rptag);
597 stripped_chars = ret;
600 target[target_nchars] = L'\0';
601 orig_target = target;
602 target = capture_fixup_absolute_symlink(target + stripped_chars,
603 capture_root_ino, capture_root_dev);
606 target_nchars = wcslen(target);
607 wmemmove(orig_target + stripped_chars, target, target_nchars + 1);
608 *target_nbytes_p = (target_nchars + stripped_chars) * sizeof(wchar_t);
609 DEBUG("Fixed reparse point (new target: \"%ls\")", orig_target);
611 return RP_FIXED_FULLPATH;
613 return RP_FIXED_ABSPATH;
616 /* Returns: `enum rp_status' value on success; negative WIMLIB_ERR_* value on
619 win32_capture_try_rpfix(u8 *rpbuf, u16 *rpbuflen_p,
620 u64 capture_root_ino, u64 capture_root_dev,
623 struct reparse_data rpdata;
625 enum rp_status rp_status;
627 ret = parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata);
631 rp_status = win32_capture_maybe_rpfix_target(rpdata.substitute_name,
632 &rpdata.substitute_name_nbytes,
635 le32_to_cpu(*(le32*)rpbuf));
636 if (rp_status & RP_FIXED) {
637 wimlib_assert(rpdata.substitute_name_nbytes % 2 == 0);
638 utf16lechar substitute_name_copy[rpdata.substitute_name_nbytes / 2];
639 wmemcpy(substitute_name_copy, rpdata.substitute_name,
640 rpdata.substitute_name_nbytes / 2);
641 rpdata.substitute_name = substitute_name_copy;
642 rpdata.print_name = substitute_name_copy;
643 rpdata.print_name_nbytes = rpdata.substitute_name_nbytes;
644 if (rp_status == RP_FIXED_FULLPATH) {
645 /* "full path", meaning \??\ prefixed. We should not
646 * include this prefix in the print name, as it is
647 * apparently meant for the filesystem driver only. */
648 rpdata.print_name += 4;
649 rpdata.print_name_nbytes -= 8;
651 ret = make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p);
657 if (rp_status == RP_EXCLUDED) {
658 size_t print_name_nchars = rpdata.print_name_nbytes / 2;
659 wchar_t print_name0[print_name_nchars + 1];
660 print_name0[print_name_nchars] = L'\0';
661 wmemcpy(print_name0, rpdata.print_name, print_name_nchars);
662 WARNING("Ignoring %ls pointing out of capture directory:\n"
663 " \"%ls\" -> \"%ls\"\n"
664 " (Use --norpfix to capture all symbolic links "
665 "and junction points as-is)",
666 (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK) ?
667 L"absolute symbolic link" : L"junction point",
676 * Loads the reparse point data from a reparse point into memory, optionally
677 * fixing the targets of absolute symbolic links and junction points to be
678 * relative to the root of capture.
680 * @hFile: Open handle to the reparse point.
681 * @path: Path to the reparse point. Used for error messages only.
682 * @params: Additional parameters, including whether to do reparse point fixups
684 * @rpbuf: Buffer of length at least REPARSE_POINT_MAX_SIZE bytes into which
685 * the reparse point buffer will be loaded.
686 * @rpbuflen_ret: On success, the length of the reparse point buffer in bytes
687 * is written to this location.
690 * On success, returns an `enum rp_status' value that indicates if and/or
691 * how the reparse point fixup was done.
693 * On failure, returns a negative value that is a negated WIMLIB_ERR_*
697 win32_get_reparse_data(HANDLE hFile, const wchar_t *path,
698 struct add_image_params *params,
699 u8 *rpbuf, u16 *rpbuflen_ret)
706 DEBUG("Loading reparse data from \"%ls\"", path);
707 if (!DeviceIoControl(hFile, FSCTL_GET_REPARSE_POINT,
708 NULL, /* "Not used with this operation; set to NULL" */
709 0, /* "Not used with this operation; set to 0" */
710 rpbuf, /* "A pointer to a buffer that
711 receives the reparse point data */
712 REPARSE_POINT_MAX_SIZE, /* "The size of the output
717 set_errno_from_GetLastError();
718 ERROR_WITH_ERRNO("Failed to get reparse data of \"%ls\"", path);
719 return -WIMLIB_ERR_READ;
721 if (bytesReturned < 8 || bytesReturned > REPARSE_POINT_MAX_SIZE) {
722 ERROR("Reparse data on \"%ls\" is invalid", path);
723 return -WIMLIB_ERR_INVALID_REPARSE_DATA;
726 rpbuflen = bytesReturned;
727 reparse_tag = le32_to_cpu(*(le32*)rpbuf);
728 if (params->add_flags & WIMLIB_ADD_FLAG_RPFIX &&
729 (reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
730 reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
732 /* Try doing reparse point fixup */
733 ret = win32_capture_try_rpfix(rpbuf,
735 params->capture_root_ino,
736 params->capture_root_dev,
741 *rpbuflen_ret = rpbuflen;
746 win32_tally_encrypted_size_cb(unsigned char *_data, void *_size_ret,
749 *(u64*)_size_ret += len;
750 return ERROR_SUCCESS;
754 win32_get_encrypted_file_size(const wchar_t *path, u64 *size_ret)
760 err = OpenEncryptedFileRaw(path, 0, &file_ctx);
761 if (err != ERROR_SUCCESS) {
762 set_errno_from_win32_error(err);
763 ERROR_WITH_ERRNO("Failed to open encrypted file \"%ls\" "
764 "for raw read", path);
765 return WIMLIB_ERR_OPEN;
768 err = ReadEncryptedFileRaw(win32_tally_encrypted_size_cb,
770 if (err != ERROR_SUCCESS) {
771 set_errno_from_win32_error(err);
772 ERROR_WITH_ERRNO("Failed to read raw encrypted data from "
774 ret = WIMLIB_ERR_READ;
778 CloseEncryptedFileRaw(file_ctx);
782 /* Scans an unnamed or named stream of a Win32 file (not a reparse point
783 * stream); calculates its SHA1 message digest and either creates a `struct
784 * wim_lookup_table_entry' in memory for it, or uses an existing 'struct
785 * wim_lookup_table_entry' for an identical stream.
787 * @path: Path to the file (UTF-16LE).
789 * @path_num_chars: Number of 2-byte characters in @path.
791 * @inode: WIM inode to save the stream into.
793 * @lookup_table: Stream lookup table for the WIM.
795 * @dat: A `WIN32_FIND_STREAM_DATA' structure that specifies the
798 * Returns 0 on success; nonzero on failure.
801 win32_capture_stream(const wchar_t *path,
802 size_t path_num_chars,
803 struct wim_inode *inode,
804 struct wim_lookup_table *lookup_table,
805 WIN32_FIND_STREAM_DATA *dat)
807 struct wim_ads_entry *ads_entry;
808 struct wim_lookup_table_entry *lte;
810 wchar_t *stream_name, *colon;
811 size_t stream_name_nchars;
812 bool is_named_stream;
815 size_t spath_buf_nbytes;
816 const wchar_t *relpath_prefix;
817 const wchar_t *colonchar;
819 DEBUG("Capture \"%ls\" stream \"%ls\"", path, dat->cStreamName);
821 /* The stream name should be returned as :NAME:TYPE */
822 stream_name = dat->cStreamName;
823 if (*stream_name != L':')
824 goto out_invalid_stream_name;
826 colon = wcschr(stream_name, L':');
828 goto out_invalid_stream_name;
830 if (wcscmp(colon + 1, L"$DATA")) {
831 /* Not a DATA stream */
838 stream_name_nchars = colon - stream_name;
839 is_named_stream = (stream_name_nchars != 0);
841 if (is_named_stream) {
842 /* Allocate an ADS entry for the named stream. */
843 ads_entry = inode_add_ads_utf16le(inode, stream_name,
844 stream_name_nchars * sizeof(wchar_t));
846 ret = WIMLIB_ERR_NOMEM;
851 /* If zero length stream, no lookup table entry needed. */
852 if ((u64)dat->StreamSize.QuadPart == 0) {
857 /* Create a UTF-16LE string @spath that gives the filename, then a
858 * colon, then the stream name. Or, if it's an unnamed stream, just the
859 * filename. It is MALLOC()'ed so that it can be saved in the
860 * wim_lookup_table_entry if needed.
862 * As yet another special case, relative paths need to be changed to
863 * begin with an explicit "./" so that, for example, a file t:ads, where
864 * :ads is the part we added, is not interpreted as a file on the t:
866 spath_nchars = path_num_chars;
867 relpath_prefix = L"";
869 if (is_named_stream) {
870 spath_nchars += 1 + stream_name_nchars;
872 if (path_num_chars == 1 && !is_any_path_separator(path[0])) {
874 static const wchar_t _relpath_prefix[] =
875 {L'.', OS_PREFERRED_PATH_SEPARATOR, L'\0'};
876 relpath_prefix = _relpath_prefix;
880 spath_buf_nbytes = (spath_nchars + 1) * sizeof(wchar_t);
881 spath = MALLOC(spath_buf_nbytes);
883 tsprintf(spath, L"%ls%ls%ls%ls",
884 relpath_prefix, path, colonchar, stream_name);
886 /* Make a new wim_lookup_table_entry */
887 lte = new_lookup_table_entry();
889 ret = WIMLIB_ERR_NOMEM;
892 lte->file_on_disk = spath;
894 if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED && !is_named_stream) {
896 lte->resource_location = RESOURCE_WIN32_ENCRYPTED;
897 ret = win32_get_encrypted_file_size(path, &encrypted_size);
900 lte->size = encrypted_size;
902 lte->resource_location = RESOURCE_IN_FILE_ON_DISK;
903 lte->size = (u64)dat->StreamSize.QuadPart;
907 if (is_named_stream) {
908 stream_id = ads_entry->stream_id;
909 ads_entry->lte = lte;
914 lookup_table_insert_unhashed(lookup_table, lte, inode, stream_id);
920 out_invalid_stream_name:
921 ERROR("Invalid stream name: \"%ls:%ls\"", path, dat->cStreamName);
922 ret = WIMLIB_ERR_READ;
926 /* Load information about the streams of an open file into a WIM inode.
928 * By default, we use the NtQueryInformationFile() system call instead of
929 * FindFirstStream() and FindNextStream(). This is done for two reasons:
931 * - FindFirstStream() opens its own handle to the file or directory and
932 * apparently does so without specifying FILE_FLAG_BACKUP_SEMANTICS, thereby
933 * causing access denied errors on certain files (even when running as the
935 * - FindFirstStream() and FindNextStream() is only available on Windows Vista
936 * and later, whereas the stream support in NtQueryInformationFile() was
937 * already present in Windows XP.
940 win32_capture_streams(HANDLE *hFile_p,
942 size_t path_num_chars,
943 struct wim_inode *inode,
944 struct wim_lookup_table *lookup_table,
948 WIN32_FIND_STREAM_DATA dat;
951 u8 _buf[8192] _aligned_attribute(8);
954 IO_STATUS_BLOCK io_status;
956 const FILE_STREAM_INFORMATION *info;
961 DEBUG("Capturing streams from \"%ls\"", path);
963 if (!(vol_flags & FILE_NAMED_STREAMS))
967 if (!func_NtQueryInformationFile)
968 goto use_FindFirstStream;
971 bufsize = sizeof(_buf);
973 /* Get a buffer containing the stream information. */
975 status = (*func_NtQueryInformationFile)(*hFile_p, &io_status,
977 FileStreamInformation);
978 if (status == STATUS_SUCCESS) {
980 } else if (status == STATUS_BUFFER_OVERFLOW) {
985 newbuf = MALLOC(bufsize);
987 newbuf = REALLOC(buf, bufsize);
990 ret = WIMLIB_ERR_NOMEM;
994 } else if (status == STATUS_NOT_IMPLEMENTED ||
995 status == STATUS_NOT_SUPPORTED ||
996 status == STATUS_INVALID_INFO_CLASS) {
997 goto use_FindFirstStream;
999 set_errno_from_nt_status(status);
1000 ERROR_WITH_ERRNO("Failed to read streams of %ls", path);
1001 ret = WIMLIB_ERR_READ;
1006 if (io_status.Information == 0) {
1007 /* No stream information. */
1012 if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) {
1013 /* OpenEncryptedFileRaw() seems to fail with
1014 * ERROR_SHARING_VIOLATION if there are any handles opened to
1016 CloseHandle(*hFile_p);
1017 *hFile_p = INVALID_HANDLE_VALUE;
1020 /* Parse one or more stream information structures. */
1021 info = (const FILE_STREAM_INFORMATION*)buf;
1023 if (info->StreamNameLength <= sizeof(dat.cStreamName) - 2) {
1024 dat.StreamSize = info->StreamSize;
1025 memcpy(dat.cStreamName, info->StreamName, info->StreamNameLength);
1026 dat.cStreamName[info->StreamNameLength / 2] = L'\0';
1028 /* Capture the stream. */
1029 ret = win32_capture_stream(path, path_num_chars, inode,
1030 lookup_table, &dat);
1034 if (info->NextEntryOffset == 0) {
1035 /* No more stream information. */
1039 /* Advance to next stream information. */
1040 info = (const FILE_STREAM_INFORMATION*)
1041 ((const u8*)info + info->NextEntryOffset);
1044 /* Free buffer if allocated on heap. */
1048 #endif /* WITH_NTDLL */
1050 use_FindFirstStream:
1051 if (win32func_FindFirstStreamW == NULL)
1053 hFind = win32func_FindFirstStreamW(path, FindStreamInfoStandard, &dat, 0);
1054 if (hFind == INVALID_HANDLE_VALUE) {
1055 err = GetLastError();
1056 if (err == ERROR_CALL_NOT_IMPLEMENTED ||
1057 err == ERROR_NOT_SUPPORTED ||
1058 err == ERROR_INVALID_FUNCTION ||
1059 err == ERROR_INVALID_PARAMETER)
1062 /* Seems legal for this to return ERROR_HANDLE_EOF on reparse
1063 * points and directories */
1064 if ((inode->i_attributes &
1065 (FILE_ATTRIBUTE_REPARSE_POINT | FILE_ATTRIBUTE_DIRECTORY))
1066 && err == ERROR_HANDLE_EOF)
1068 DEBUG("ERROR_HANDLE_EOF (ok)");
1071 if (err == ERROR_ACCESS_DENIED) {
1072 WARNING("Failed to look up data streams "
1073 "of \"%ls\": Access denied!\n%ls",
1074 path, capture_access_denied_msg);
1077 set_errno_from_win32_error(err);
1078 ERROR_WITH_ERRNO("Failed to look up data streams "
1079 "of \"%ls\"", path);
1080 return WIMLIB_ERR_READ;
1085 ret = win32_capture_stream(path,
1087 inode, lookup_table,
1090 goto out_find_close;
1091 } while (win32func_FindNextStreamW(hFind, &dat));
1092 err = GetLastError();
1093 if (err != ERROR_HANDLE_EOF) {
1094 set_errno_from_win32_error(err);
1095 ERROR_WITH_ERRNO("Error reading data streams from "
1097 ret = WIMLIB_ERR_READ;
1104 /* FindFirstStream() API is not available, or the volume does not
1105 * support named streams. Only capture the unnamed data stream. */
1106 DEBUG("Only capturing unnamed data stream");
1107 if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
1108 FILE_ATTRIBUTE_REPARSE_POINT))
1111 wcscpy(dat.cStreamName, L"::$DATA");
1112 dat.StreamSize.QuadPart = file_size;
1113 return win32_capture_stream(path, path_num_chars,
1114 inode, lookup_table, &dat);
1118 win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
1120 size_t path_num_chars,
1121 struct add_image_params *params,
1122 struct win32_capture_state *state,
1125 struct wim_dentry *root = NULL;
1126 struct wim_inode *inode;
1134 DWORD desiredAccess;
1136 params->progress.scan.cur_path = path;
1138 if (exclude_path(path, path_num_chars, params->config, true)) {
1139 if (params->add_flags & WIMLIB_ADD_FLAG_ROOT) {
1140 ERROR("Cannot exclude the root directory from capture");
1141 ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
1144 do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED);
1150 if (path_num_chars >= 4 &&
1151 !wmemcmp(path, L"\\\\?\\", 4) &&
1152 path_num_chars + 1 - 4 > MAX_PATH &&
1153 state->num_long_path_warnings < MAX_CAPTURE_LONG_PATH_WARNINGS)
1155 WARNING("Path \"%ls\" exceeds MAX_PATH", path);
1156 if (++state->num_long_path_warnings == MAX_CAPTURE_LONG_PATH_WARNINGS)
1157 WARNING("Suppressing further warnings about long paths.");
1161 do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK);
1163 desiredAccess = FILE_READ_DATA | FILE_READ_ATTRIBUTES |
1164 READ_CONTROL | ACCESS_SYSTEM_SECURITY;
1166 hFile = win32_open_existing_file(path, desiredAccess);
1167 if (hFile == INVALID_HANDLE_VALUE) {
1168 err = GetLastError();
1169 if (err == ERROR_ACCESS_DENIED || err == ERROR_PRIVILEGE_NOT_HELD) {
1170 if (desiredAccess & ACCESS_SYSTEM_SECURITY) {
1171 desiredAccess &= ~ACCESS_SYSTEM_SECURITY;
1174 if (desiredAccess & READ_CONTROL) {
1175 desiredAccess &= ~READ_CONTROL;
1179 set_errno_from_GetLastError();
1180 ERROR_WITH_ERRNO("Failed to open \"%ls\" for reading", path);
1181 ret = WIMLIB_ERR_OPEN;
1185 BY_HANDLE_FILE_INFORMATION file_info;
1186 if (!GetFileInformationByHandle(hFile, &file_info)) {
1187 set_errno_from_GetLastError();
1188 ERROR_WITH_ERRNO("Failed to get file information for \"%ls\"",
1190 ret = WIMLIB_ERR_STAT;
1191 goto out_close_handle;
1194 if (file_info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1195 rpbuf = alloca(REPARSE_POINT_MAX_SIZE);
1196 ret = win32_get_reparse_data(hFile, path, params,
1199 /* WIMLIB_ERR_* (inverted) */
1201 goto out_close_handle;
1202 } else if (ret & RP_FIXED) {
1204 } else if (ret == RP_EXCLUDED) {
1206 goto out_close_handle;
1212 /* Create a WIM dentry with an associated inode, which may be shared.
1214 * However, we need to explicitly check for directories and files with
1215 * only 1 link and refuse to hard link them. This is because Windows
1216 * has a bug where it can return duplicate File IDs for files and
1217 * directories on the FAT filesystem. */
1218 ret = inode_table_new_dentry(¶ms->inode_table,
1219 path_basename_with_len(path, path_num_chars),
1220 ((u64)file_info.nFileIndexHigh << 32) |
1221 (u64)file_info.nFileIndexLow,
1222 file_info.dwVolumeSerialNumber,
1223 (file_info.nNumberOfLinks <= 1 ||
1224 (file_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)),
1227 goto out_close_handle;
1229 ret = win32_get_short_name(hFile, path, root);
1231 goto out_close_handle;
1233 inode = root->d_inode;
1235 if (inode->i_nlink > 1) /* Shared inode; nothing more to do */
1236 goto out_close_handle;
1238 inode->i_attributes = file_info.dwFileAttributes;
1239 inode->i_creation_time = FILETIME_to_u64(&file_info.ftCreationTime);
1240 inode->i_last_write_time = FILETIME_to_u64(&file_info.ftLastWriteTime);
1241 inode->i_last_access_time = FILETIME_to_u64(&file_info.ftLastAccessTime);
1242 inode->i_resolved = 1;
1244 params->add_flags &= ~WIMLIB_ADD_FLAG_ROOT;
1246 if (!(params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS)
1247 && (vol_flags & FILE_PERSISTENT_ACLS))
1249 ret = win32_get_security_descriptor(hFile, path, inode,
1250 ¶ms->sd_set, state,
1253 goto out_close_handle;
1256 file_size = ((u64)file_info.nFileSizeHigh << 32) |
1257 (u64)file_info.nFileSizeLow;
1260 /* Capture the unnamed data stream (only should be present for regular
1261 * files) and any alternate data streams. */
1262 ret = win32_capture_streams(&hFile,
1266 params->lookup_table,
1270 goto out_close_handle;
1272 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1273 /* Reparse point: set the reparse data (which we read already)
1275 inode->i_not_rpfixed = not_rpfixed;
1276 inode->i_reparse_tag = le32_to_cpu(*(le32*)rpbuf);
1277 ret = inode_set_unnamed_stream(inode, rpbuf + 8, rpbuflen - 8,
1278 params->lookup_table);
1279 } else if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
1280 /* Directory (not a reparse point) --- recurse to children */
1282 if (hFile == INVALID_HANDLE_VALUE) {
1283 /* Re-open handle that was closed to read raw encrypted
1285 hFile = win32_open_existing_file(path, FILE_READ_DATA);
1286 if (hFile == INVALID_HANDLE_VALUE) {
1287 set_errno_from_GetLastError();
1288 ERROR_WITH_ERRNO("Failed to reopen \"%ls\"",
1290 ret = WIMLIB_ERR_OPEN;
1291 goto out_close_handle;
1294 ret = win32_recurse_directory(hFile,
1308 free_dentry_tree(root, params->lookup_table);
1313 win32_do_capture_warnings(const wchar_t *path,
1314 const struct win32_capture_state *state,
1317 if (state->num_get_sacl_priv_notheld == 0 &&
1318 state->num_get_sd_access_denied == 0)
1321 WARNING("Scan of \"%ls\" complete, but with one or more warnings:", path);
1322 if (state->num_get_sacl_priv_notheld != 0) {
1323 WARNING("- Could not capture SACL (System Access Control List)\n"
1324 " on %lu files or directories.",
1325 state->num_get_sacl_priv_notheld);
1327 if (state->num_get_sd_access_denied != 0) {
1328 WARNING("- Could not capture security descriptor at all\n"
1329 " on %lu files or directories.",
1330 state->num_get_sd_access_denied);
1332 WARNING("To fully capture all security descriptors, run the program\n"
1333 " with Administrator rights.");
1336 #define WINDOWS_NT_MAX_PATH 32768
1338 /* Win32 version of capturing a directory tree */
1340 win32_build_dentry_tree(struct wim_dentry **root_ret,
1341 const wchar_t *root_disk_path,
1342 struct add_image_params *params)
1347 struct win32_capture_state state;
1350 bool need_prefix_free = false;
1352 if (!win32func_FindFirstStreamW
1354 && !func_NtQueryInformationFile
1358 WARNING("Running on Windows XP or earlier; "
1359 "alternate data streams will not be captured.");
1362 path_nchars = wcslen(root_disk_path);
1363 if (path_nchars > WINDOWS_NT_MAX_PATH)
1364 return WIMLIB_ERR_INVALID_PARAM;
1366 ret = win32_get_file_and_vol_ids(root_disk_path,
1367 ¶ms->capture_root_ino,
1368 ¶ms->capture_root_dev);
1370 ERROR_WITH_ERRNO("Can't open %ls", root_disk_path);
1374 win32_get_vol_flags(root_disk_path, &vol_flags, NULL);
1376 /* WARNING: There is no check for overflow later when this buffer is
1377 * being used! But it's as long as the maximum path length understood
1378 * by Windows NT (which is NOT the same as MAX_PATH). */
1379 path = MALLOC(WINDOWS_NT_MAX_PATH * sizeof(wchar_t));
1381 return WIMLIB_ERR_NOMEM;
1383 /* Work around defective behavior in Windows where paths longer than 260
1384 * characters are not supported by default; instead they need to be
1385 * turned into absolute paths and prefixed with "\\?\". */
1387 if (wcsncmp(root_disk_path, L"\\\\?\\", 4)) {
1388 dret = GetFullPathName(root_disk_path, WINDOWS_NT_MAX_PATH - 4,
1391 if (dret == 0 || dret >= WINDOWS_NT_MAX_PATH - 4) {
1392 WARNING("Can't get full path name for \"%ls\"", root_disk_path);
1393 wmemcpy(path, root_disk_path, path_nchars + 1);
1395 wmemcpy(path, L"\\\\?\\", 4);
1396 path_nchars = 4 + dret;
1397 /* Update pattern prefix */
1398 if (params->config != NULL)
1400 params->config->_prefix = TSTRDUP(path);
1401 params->config->_prefix_num_tchars = path_nchars;
1402 if (params->config->_prefix == NULL)
1404 ret = WIMLIB_ERR_NOMEM;
1407 need_prefix_free = true;
1411 wmemcpy(path, root_disk_path, path_nchars + 1);
1414 memset(&state, 0, sizeof(state));
1415 ret = win32_build_dentry_tree_recursive(root_ret, path,
1416 path_nchars, params,
1418 if (need_prefix_free)
1419 FREE(params->config->_prefix);
1423 win32_do_capture_warnings(root_disk_path, &state, params->add_flags);
1427 #endif /* __WIN32__ */