X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwin32_capture.c;h=8937891e75ee205376142a627264470d8e00fb07;hp=aed93a5fb8afc3a09bf66d6ecdfbf0dde9d46855;hb=d31b2fee211b1c31420bafe1c2379f6f89bd92fe;hpb=60c0c14a116123f8d77ad5f24361345eabdd7f57 diff --git a/src/win32_capture.c b/src/win32_capture.c index aed93a5f..8937891e 100644 --- a/src/win32_capture.c +++ b/src/win32_capture.c @@ -1,24 +1,24 @@ /* * win32_capture.c - Windows-specific code for capturing files into a WIM image. + * + * This now uses the native Windows NT API a lot and not just Win32. */ /* - * Copyright (C) 2013, 2014 Eric Biggers - * - * This file is part of wimlib, a library for working with WIM files. + * Copyright (C) 2013, 2014, 2015 Eric Biggers * - * wimlib is free software; you can redistribute it and/or modify it under the - * terms of the GNU General Public License as published by the Free - * Software Foundation; either version 3 of the License, or (at your option) - * any later version. + * This file is free software; you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by the Free + * Software Foundation; either version 3 of the License, or (at your option) any + * later version. * - * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY - * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR - * A PARTICULAR PURPOSE. See the GNU General Public License for more + * This file is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more * details. * - * You should have received a copy of the GNU General Public License - * along with wimlib; if not, see http://www.gnu.org/licenses/. + * You should have received a copy of the GNU Lesser General Public License + * along with this file; if not, see http://www.gnu.org/licenses/. */ #ifdef __WIN32__ @@ -29,23 +29,35 @@ #include "wimlib/win32_common.h" +#include "wimlib/assert.h" +#include "wimlib/blob_table.h" #include "wimlib/capture.h" #include "wimlib/dentry.h" #include "wimlib/encoding.h" #include "wimlib/endianness.h" #include "wimlib/error.h" -#include "wimlib/lookup_table.h" #include "wimlib/paths.h" #include "wimlib/reparse.h" -#include - -struct win32_capture_state { +struct winnt_scan_stats { unsigned long num_get_sd_access_denied; unsigned long num_get_sacl_priv_notheld; - unsigned long num_long_path_warnings; }; +static inline const wchar_t * +printable_path(const wchar_t *full_path) +{ + /* Skip over \\?\ or \??\ */ + return full_path + 4; +} + +/* + * If cur_dir is not NULL, open an existing file relative to the already-open + * directory cur_dir. + * + * Otherwise, open the file specified by @path, which must be a Windows NT + * namespace path. + */ static NTSTATUS winnt_openat(HANDLE cur_dir, const wchar_t *path, size_t path_nchars, ACCESS_MASK perms, HANDLE *h_ret) @@ -68,13 +80,13 @@ winnt_openat(HANDLE cur_dir, const wchar_t *path, size_t path_nchars, retry: status = (*func_NtOpenFile)(h_ret, perms, &attr, &iosb, - FILE_SHARE_READ | - FILE_SHARE_WRITE | - FILE_SHARE_DELETE, + FILE_SHARE_VALID_FLAGS, FILE_OPEN_REPARSE_POINT | FILE_OPEN_FOR_BACKUP_INTENT | - FILE_SYNCHRONOUS_IO_NONALERT); + FILE_SYNCHRONOUS_IO_NONALERT | + FILE_SEQUENTIAL_ONLY); if (!NT_SUCCESS(status)) { + /* Try requesting fewer permissions */ if (status == STATUS_ACCESS_DENIED || status == STATUS_PRIVILEGE_NOT_HELD) { if (perms & ACCESS_SYSTEM_SECURITY) { @@ -90,11 +102,11 @@ retry: return status; } +/* Read the first @size bytes from the file, or named data stream of a file, + * described by @blob. */ int -read_win32_file_prefix(const struct wim_lookup_table_entry *lte, - u64 size, - consume_data_callback_t cb, - void *cb_ctx) +read_winnt_stream_prefix(const struct blob_descriptor *blob, u64 size, + const struct read_blob_callbacks *cbs) { const wchar_t *path; HANDLE h; @@ -103,12 +115,14 @@ read_win32_file_prefix(const struct wim_lookup_table_entry *lte, u64 bytes_remaining; int ret; - path = lte->file_on_disk; + /* This is an NT namespace path. */ + path = blob->file_on_disk; + status = winnt_openat(NULL, path, wcslen(path), FILE_READ_DATA | SYNCHRONIZE, &h); if (!NT_SUCCESS(status)) { - set_errno_from_nt_status(status); - ERROR_WITH_ERRNO("\"%ls\": Can't open for reading", path); + winnt_error(status, L"\"%ls\": Can't open for reading", + printable_path(path)); return WIMLIB_ERR_OPEN; } @@ -117,20 +131,23 @@ read_win32_file_prefix(const struct wim_lookup_table_entry *lte, while (bytes_remaining) { IO_STATUS_BLOCK iosb; ULONG count; + ULONG bytes_read; count = min(sizeof(buf), bytes_remaining); status = (*func_NtReadFile)(h, NULL, NULL, NULL, &iosb, buf, count, NULL, NULL); - if (!NT_SUCCESS(status) || iosb.Information != count) { - set_errno_from_nt_status(status); - ERROR_WITH_ERRNO("\"%ls\": Error reading data", path); + if (!NT_SUCCESS(status)) { + winnt_error(status, L"\"%ls\": Error reading data", + printable_path(path)); ret = WIMLIB_ERR_READ; break; } - bytes_remaining -= count; - ret = (*cb)(buf, count, cb_ctx); + bytes_read = iosb.Information; + + bytes_remaining -= bytes_read; + ret = call_consume_chunk(buf, bytes_read, cbs); if (ret) break; } @@ -139,8 +156,7 @@ read_win32_file_prefix(const struct wim_lookup_table_entry *lte, } struct win32_encrypted_read_ctx { - consume_data_callback_t read_prefix_cb; - void *read_prefix_ctx; + const struct read_blob_callbacks *cbs; int wimlib_err_code; u64 bytes_remaining; }; @@ -155,11 +171,11 @@ win32_encrypted_export_cb(unsigned char *data, void *_ctx, unsigned long len) if (bytes_to_consume == 0) return ERROR_SUCCESS; - ret = (*ctx->read_prefix_cb)(data, bytes_to_consume, ctx->read_prefix_ctx); + ret = call_consume_chunk(data, bytes_to_consume, ctx->cbs); if (ret) { ctx->wimlib_err_code = ret; - /* Shouldn't matter what error code is returned here, as long as - * it isn't ERROR_SUCCESS. */ + /* It doesn't matter what error code is returned here, as long + * as it isn't ERROR_SUCCESS. */ return ERROR_READ_FAULT; } ctx->bytes_remaining -= bytes_to_consume; @@ -167,45 +183,45 @@ win32_encrypted_export_cb(unsigned char *data, void *_ctx, unsigned long len) } int -read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte, +read_win32_encrypted_file_prefix(const struct blob_descriptor *blob, u64 size, - consume_data_callback_t cb, - void *cb_ctx) + const struct read_blob_callbacks *cbs) { struct win32_encrypted_read_ctx export_ctx; DWORD err; void *file_ctx; int ret; + DWORD flags = 0; - DEBUG("Reading %"PRIu64" bytes from encrypted file \"%ls\"", - size, lte->file_on_disk); + if (blob->file_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) + flags |= CREATE_FOR_DIR; - export_ctx.read_prefix_cb = cb; - export_ctx.read_prefix_ctx = cb_ctx; + export_ctx.cbs = cbs; export_ctx.wimlib_err_code = 0; export_ctx.bytes_remaining = size; - err = OpenEncryptedFileRaw(lte->file_on_disk, 0, &file_ctx); + err = OpenEncryptedFileRaw(blob->file_on_disk, flags, &file_ctx); if (err != ERROR_SUCCESS) { - set_errno_from_win32_error(err); - ERROR_WITH_ERRNO("Failed to open encrypted file \"%ls\" " - "for raw read", lte->file_on_disk); + win32_error(err, + L"Failed to open encrypted file \"%ls\" for raw read", + printable_path(blob->file_on_disk)); return WIMLIB_ERR_OPEN; } err = ReadEncryptedFileRaw(win32_encrypted_export_cb, &export_ctx, file_ctx); if (err != ERROR_SUCCESS) { - set_errno_from_win32_error(err); - ERROR_WITH_ERRNO("Failed to read encrypted file \"%ls\"", - lte->file_on_disk); ret = export_ctx.wimlib_err_code; - if (ret == 0) + if (ret == 0) { + win32_error(err, + L"Failed to read encrypted file \"%ls\"", + printable_path(blob->file_on_disk)); ret = WIMLIB_ERR_READ; + } } else if (export_ctx.bytes_remaining != 0) { ERROR("Only could read %"PRIu64" of %"PRIu64" bytes from " - "encryted file \"%ls\"", + "encrypted file \"%ls\"", size - export_ctx.bytes_remaining, size, - lte->file_on_disk); + printable_path(blob->file_on_disk)); ret = WIMLIB_ERR_READ; } else { ret = 0; @@ -214,201 +230,226 @@ read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte, return ret; } -/* Load the short name of a file into a WIM dentry. - * - * If we can't read the short filename for some reason, we just ignore the error - * and assume the file has no short name. This shouldn't be an issue, since the - * short names are essentially obsolete anyway. +/* + * Load the short name of a file into a WIM dentry. */ -static int -win32_get_short_name(HANDLE hFile, struct wim_dentry *dentry) +static noinline_for_stack NTSTATUS +winnt_get_short_name(HANDLE h, struct wim_dentry *dentry) { - /* It's not any harder to just make the NtQueryInformationFile() system * call ourselves, and it saves a dumb call to FindFirstFile() which of * course has to create its own handle. */ NTSTATUS status; - IO_STATUS_BLOCK io_status; + IO_STATUS_BLOCK iosb; u8 buf[128] _aligned_attribute(8); const FILE_NAME_INFORMATION *info; - status = (*func_NtQueryInformationFile)(hFile, &io_status, buf, sizeof(buf), + status = (*func_NtQueryInformationFile)(h, &iosb, buf, sizeof(buf), FileAlternateNameInformation); - info = (const FILE_NAME_INFORMATION*)buf; + info = (const FILE_NAME_INFORMATION *)buf; if (NT_SUCCESS(status) && info->FileNameLength != 0) { - dentry->short_name = utf16le_dupz(info->FileName, - info->FileNameLength); - if (!dentry->short_name) - return WIMLIB_ERR_NOMEM; - dentry->short_name_nbytes = info->FileNameLength; + dentry->d_short_name = utf16le_dupz(info->FileName, + info->FileNameLength); + if (!dentry->d_short_name) + return STATUS_NO_MEMORY; + dentry->d_short_name_nbytes = info->FileNameLength; } - return 0; + return status; } -static int -win32_get_security_descriptor(HANDLE h, - struct wim_inode *inode, +/* + * Load the security descriptor of a file into the corresponding inode and the + * WIM image's security descriptor set. + */ +static noinline_for_stack NTSTATUS +winnt_get_security_descriptor(HANDLE h, struct wim_inode *inode, struct wim_sd_set *sd_set, - struct win32_capture_state *state, - int add_flags) + struct winnt_scan_stats *stats, int add_flags) { SECURITY_INFORMATION requestedInformation; - u8 _buf[4096]; + u8 _buf[4096] _aligned_attribute(8); u8 *buf; - size_t bufsize; - DWORD lenNeeded; + ULONG bufsize; + ULONG len_needed; NTSTATUS status; - int ret; - requestedInformation = DACL_SECURITY_INFORMATION | + /* + * LABEL_SECURITY_INFORMATION is needed on Windows Vista and 7 because + * Microsoft decided to add mandatory integrity labels to the SACL but + * not have them returned by SACL_SECURITY_INFORMATION. + * + * BACKUP_SECURITY_INFORMATION is needed on Windows 8 because Microsoft + * decided to add even more stuff to the SACL and still not have it + * returned by SACL_SECURITY_INFORMATION; but they did remember that + * backup applications exist and simply want to read the stupid thing + * once and for all, so they added a flag to read the entire security + * descriptor. + * + * Older versions of Windows tolerate these new flags being passed in. + */ + requestedInformation = OWNER_SECURITY_INFORMATION | + GROUP_SECURITY_INFORMATION | + DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION | - OWNER_SECURITY_INFORMATION | - GROUP_SECURITY_INFORMATION; + LABEL_SECURITY_INFORMATION | + BACKUP_SECURITY_INFORMATION; + buf = _buf; bufsize = sizeof(_buf); /* - * We need the file's security descriptor in SECURITY_DESCRIPTOR_RELATIVE - * format, and we currently have a handle opened with as many relevant - * permissions as possible. At this point, on Windows there are a number of - * options for reading a file's security descriptor: + * We need the file's security descriptor in + * SECURITY_DESCRIPTOR_RELATIVE format, and we currently have a handle + * opened with as many relevant permissions as possible. At this point, + * on Windows there are a number of options for reading a file's + * security descriptor: * * GetFileSecurity(): This takes in a path and returns the - * SECURITY_DESCRIPTOR_RELATIVE. Problem: this uses an internal handle, not - * ours, and the handle created internally doesn't specify - * FILE_FLAG_BACKUP_SEMANTICS. Therefore there can be access denied errors on - * some files and directories, even when running as the Administrator. + * SECURITY_DESCRIPTOR_RELATIVE. Problem: this uses an internal handle, + * not ours, and the handle created internally doesn't specify + * FILE_FLAG_BACKUP_SEMANTICS. Therefore there can be access denied + * errors on some files and directories, even when running as the + * Administrator. * * GetSecurityInfo(): This takes in a handle and returns the security - * descriptor split into a bunch of different parts. This should work, but it's - * dumb because we have to put the security descriptor back together again. + * descriptor split into a bunch of different parts. This should work, + * but it's dumb because we have to put the security descriptor back + * together again. * * BackupRead(): This can read the security descriptor, but this is a - * difficult-to-use API, probably only works as the Administrator, and the - * format of the returned data is not well documented. + * difficult-to-use API, probably only works as the Administrator, and + * the format of the returned data is not well documented. * - * NtQuerySecurityObject(): This is exactly what we need, as it takes in a - * handle and returns the security descriptor in SECURITY_DESCRIPTOR_RELATIVE - * format. Only problem is that it's a ntdll function and therefore not - * officially part of the Win32 API. Oh well. + * NtQuerySecurityObject(): This is exactly what we need, as it takes + * in a handle and returns the security descriptor in + * SECURITY_DESCRIPTOR_RELATIVE format. Only problem is that it's a + * ntdll function and therefore not officially part of the Win32 API. + * Oh well. */ while (!(NT_SUCCESS(status = (*func_NtQuerySecurityObject)(h, requestedInformation, (PSECURITY_DESCRIPTOR)buf, bufsize, - &lenNeeded)))) + &len_needed)))) { switch (status) { case STATUS_BUFFER_TOO_SMALL: wimlib_assert(buf == _buf); - buf = MALLOC(lenNeeded); + buf = MALLOC(len_needed); if (!buf) - return WIMLIB_ERR_NOMEM; - bufsize = lenNeeded; + return STATUS_NO_MEMORY; + bufsize = len_needed; break; case STATUS_PRIVILEGE_NOT_HELD: case STATUS_ACCESS_DENIED: if (add_flags & WIMLIB_ADD_FLAG_STRICT_ACLS) { default: - set_errno_from_nt_status(status); - ret = WIMLIB_ERR_READ; + /* Permission denied in STRICT_ACLS mode, or + * unknown error. */ goto out_free_buf; } if (requestedInformation & SACL_SECURITY_INFORMATION) { - state->num_get_sacl_priv_notheld++; - requestedInformation &= ~SACL_SECURITY_INFORMATION; + /* Try again without the SACL. */ + stats->num_get_sacl_priv_notheld++; + requestedInformation &= ~(SACL_SECURITY_INFORMATION | + LABEL_SECURITY_INFORMATION | + BACKUP_SECURITY_INFORMATION); break; } - state->num_get_sd_access_denied++; - ret = 0; + /* Fake success (useful when capturing as + * non-Administrator). */ + stats->num_get_sd_access_denied++; + status = STATUS_SUCCESS; goto out_free_buf; } } - inode->i_security_id = sd_set_add_sd(sd_set, buf, lenNeeded); - if (inode->i_security_id < 0) - ret = WIMLIB_ERR_NOMEM; - else - ret = 0; + /* Add the security descriptor to the WIM image, and save its ID in + * file's inode. */ + inode->i_security_id = sd_set_add_sd(sd_set, buf, len_needed); + if (unlikely(inode->i_security_id < 0)) + status = STATUS_NO_MEMORY; out_free_buf: - if (buf != _buf) + if (unlikely(buf != _buf)) FREE(buf); - return ret; + return status; } static int -win32_build_dentry_tree_recursive(struct wim_dentry **root_ret, +winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret, HANDLE cur_dir, wchar_t *full_path, size_t full_path_nchars, const wchar_t *filename, size_t filename_nchars, - struct add_image_params *params, - struct win32_capture_state *state, - DWORD vol_flags); + struct capture_params *params, + struct winnt_scan_stats *stats, + u32 vol_flags); -/* Reads the directory entries of directory and recursively calls - * win32_build_dentry_tree() on them. */ static int -win32_recurse_directory(HANDLE h, +winnt_recurse_directory(HANDLE h, wchar_t *full_path, size_t full_path_nchars, - struct wim_dentry *root, - struct add_image_params *params, - struct win32_capture_state *state, - DWORD vol_flags) + struct wim_dentry *parent, + struct capture_params *params, + struct winnt_scan_stats *stats, + u32 vol_flags) { - int ret; - - /* Using NtQueryDirectoryFile() we can re-use the same open handle, - * which we opened with FILE_FLAG_BACKUP_SEMANTICS. */ - - NTSTATUS status; - IO_STATUS_BLOCK io_status; - const size_t bufsize = 8192; void *buf; + const size_t bufsize = 8192; + IO_STATUS_BLOCK iosb; + NTSTATUS status; + int ret; buf = MALLOC(bufsize); if (!buf) return WIMLIB_ERR_NOMEM; + /* Using NtQueryDirectoryFile() we can re-use the same open handle, + * which we opened with FILE_FLAG_BACKUP_SEMANTICS. */ + while (NT_SUCCESS(status = (*func_NtQueryDirectoryFile)(h, NULL, NULL, NULL, - &io_status, buf, bufsize, + &iosb, buf, bufsize, FileNamesInformation, FALSE, NULL, FALSE))) { const FILE_NAMES_INFORMATION *info = buf; for (;;) { - if (!(info->FileNameLength == 2 && info->FileName[0] == L'.') && - !(info->FileNameLength == 4 && info->FileName[0] == L'.' && - info->FileName[1] == L'.')) + if (!should_ignore_filename(info->FileName, + info->FileNameLength / 2)) { wchar_t *p; + wchar_t *filename; struct wim_dentry *child; p = full_path + full_path_nchars; - *p++ = L'\\'; - p = wmempcpy(p, info->FileName, + /* Only add a backslash if we don't already have + * one. This prevents a duplicate backslash + * from being added when the path to the capture + * dir had a trailing backslash. */ + if (*(p - 1) != L'\\') + *p++ = L'\\'; + filename = p; + p = wmempcpy(filename, info->FileName, info->FileNameLength / 2); *p = '\0'; - ret = win32_build_dentry_tree_recursive( - &child, - h, - full_path, - p - full_path, - full_path + full_path_nchars + 1, - info->FileNameLength / 2, - params, - state, - vol_flags); + ret = winnt_build_dentry_tree_recursive( + &child, + h, + full_path, + p - full_path, + filename, + info->FileNameLength / 2, + params, + stats, + vol_flags); full_path[full_path_nchars] = L'\0'; if (ret) goto out_free_buf; - if (child) - dentry_add_child(root, child); + attach_scanned_tree(parent, child, params->blob_table); } if (info->NextEntryOffset == 0) break; @@ -417,9 +458,9 @@ win32_recurse_directory(HANDLE h, } } - if (status != STATUS_NO_MORE_FILES) { - set_errno_from_nt_status(status); - ERROR_WITH_ERRNO("\"%ls\": Can't read directory", full_path); + if (unlikely(status != STATUS_NO_MORE_FILES)) { + winnt_error(status, L"\"%ls\": Can't read directory", + printable_path(full_path)); ret = WIMLIB_ERR_READ; } out_free_buf: @@ -427,208 +468,291 @@ out_free_buf: return ret; } -/* Reparse point fixup status code */ -enum rp_status { - /* Reparse point corresponded to an absolute symbolic link or junction - * point that pointed outside the directory tree being captured, and - * therefore was excluded. */ - RP_EXCLUDED = 0x0, - - /* Reparse point was not fixed as it was either a relative symbolic - * link, a mount point, or something else we could not understand. */ - RP_NOT_FIXED = 0x1, - - /* Reparse point corresponded to an absolute symbolic link or junction - * point that pointed inside the directory tree being captured, where - * the target was specified by a "full" \??\ prefixed path, and - * therefore was fixed to be relative to the root of the directory tree - * being captured. */ - RP_FIXED_FULLPATH = 0x2, - - /* Same as RP_FIXED_FULLPATH, except the absolute link target did not - * have the \??\ prefix. It may have begun with a drive letter though. - * */ - RP_FIXED_ABSPATH = 0x4, - - /* Either RP_FIXED_FULLPATH or RP_FIXED_ABSPATH. */ - RP_FIXED = RP_FIXED_FULLPATH | RP_FIXED_ABSPATH, -}; +/* Reparse point fixup status code */ +#define RP_FIXED (-1) -/* Given the "substitute name" target of a Windows reparse point, try doing a - * fixup where we change it to be absolute relative to the root of the directory - * tree being captured. - * - * Note that this is only executed when WIMLIB_ADD_FLAG_RPFIX has been - * set. - * - * @capture_root_ino and @capture_root_dev indicate the inode number and device - * of the root of the directory tree being captured. They are meant to identify - * this directory (as an alternative to its actual path, which could potentially - * be reached via multiple destinations due to other symbolic links). This may - * not work properly on FAT, which doesn't seem to supply proper inode numbers - * or file IDs. However, FAT doesn't support reparse points so this function - * wouldn't even be called anyway. +static bool +file_has_ino_and_dev(HANDLE h, u64 ino, u64 dev) +{ + NTSTATUS status; + IO_STATUS_BLOCK iosb; + FILE_INTERNAL_INFORMATION int_info; + FILE_FS_VOLUME_INFORMATION vol_info; + + status = (*func_NtQueryInformationFile)(h, &iosb, + &int_info, sizeof(int_info), + FileInternalInformation); + if (!NT_SUCCESS(status)) + return false; + + if (int_info.IndexNumber.QuadPart != ino) + return false; + + status = (*func_NtQueryVolumeInformationFile)(h, &iosb, + &vol_info, sizeof(vol_info), + FileFsVolumeInformation); + if (!(NT_SUCCESS(status) || status == STATUS_BUFFER_OVERFLOW)) + return false; + + if (iosb.Information < + offsetof(FILE_FS_VOLUME_INFORMATION, VolumeSerialNumber) + + sizeof(vol_info.VolumeSerialNumber)) + return false; + + return (vol_info.VolumeSerialNumber == dev); +} + +/* + * This is the Windows equivalent of unix_relativize_link_target(); see there + * for general details. This version works with an "absolute" Windows link + * target, specified from the root of the Windows kernel object namespace. Note + * that we have to open directories with a trailing slash when present because + * \??\E: opens the E: device itself and not the filesystem root directory. */ -static enum rp_status -win32_capture_maybe_rpfix_target(wchar_t *target, u16 *target_nbytes_p, - u64 capture_root_ino, u64 capture_root_dev, - u32 rptag) +static const wchar_t * +winnt_relativize_link_target(const wchar_t *target, size_t target_nbytes, + u64 ino, u64 dev) { - u16 target_nchars = *target_nbytes_p / 2; - size_t stripped_chars; - wchar_t *orig_target; - int ret; + UNICODE_STRING name; + OBJECT_ATTRIBUTES attr; + IO_STATUS_BLOCK iosb; + NTSTATUS status; + const wchar_t *target_end; + const wchar_t *p; - ret = parse_substitute_name(target, *target_nbytes_p, rptag); - if (ret < 0) - return RP_NOT_FIXED; - stripped_chars = ret; - if (stripped_chars) - stripped_chars -= 2; - target[target_nchars] = L'\0'; - orig_target = target; - target = capture_fixup_absolute_symlink(target + stripped_chars, - capture_root_ino, capture_root_dev); - if (!target) - return RP_EXCLUDED; - target_nchars = wcslen(target); - wmemmove(orig_target + stripped_chars, target, target_nchars + 1); - *target_nbytes_p = (target_nchars + stripped_chars) * sizeof(wchar_t); - DEBUG("Fixed reparse point (new target: \"%ls\")", orig_target); - if (stripped_chars) - return RP_FIXED_FULLPATH; - else - return RP_FIXED_ABSPATH; + target_end = target + (target_nbytes / sizeof(wchar_t)); + + /* Empty path??? */ + if (target_end == target) + return target; + + /* No leading slash??? */ + if (target[0] != L'\\') + return target; + + /* UNC path??? */ + if ((target_end - target) >= 2 && + target[0] == L'\\' && target[1] == L'\\') + return target; + + attr.Length = sizeof(attr); + attr.RootDirectory = NULL; + attr.ObjectName = &name; + attr.Attributes = 0; + attr.SecurityDescriptor = NULL; + attr.SecurityQualityOfService = NULL; + + name.Buffer = (wchar_t *)target; + name.Length = 0; + p = target; + do { + HANDLE h; + const wchar_t *orig_p = p; + + /* Skip non-backslashes */ + while (p != target_end && *p != L'\\') + p++; + + /* Skip backslashes */ + while (p != target_end && *p == L'\\') + p++; + + /* Append path component */ + name.Length += (p - orig_p) * sizeof(wchar_t); + name.MaximumLength = name.Length; + + /* Try opening the file */ + status = (*func_NtOpenFile) (&h, + FILE_READ_ATTRIBUTES | FILE_TRAVERSE, + &attr, + &iosb, + FILE_SHARE_VALID_FLAGS, + FILE_OPEN_FOR_BACKUP_INTENT); + + if (NT_SUCCESS(status)) { + /* Reset root directory */ + if (attr.RootDirectory) + (*func_NtClose)(attr.RootDirectory); + attr.RootDirectory = h; + name.Buffer = (wchar_t *)p; + name.Length = 0; + + if (file_has_ino_and_dev(h, ino, dev)) + goto out_close_root_dir; + } + } while (p != target_end); + + p = target; + +out_close_root_dir: + if (attr.RootDirectory) + (*func_NtClose)(attr.RootDirectory); + while (p > target && *(p - 1) == L'\\') + p--; + return p; } -/* Returns: `enum rp_status' value on success; negative WIMLIB_ERR_* value on - * failure. */ static int -win32_capture_try_rpfix(u8 *rpbuf, u16 *rpbuflen_p, - u64 capture_root_ino, u64 capture_root_dev, - const wchar_t *path, struct add_image_params *params) +winnt_rpfix_progress(struct capture_params *params, const wchar_t *path, + const struct link_reparse_point *link, int scan_status) { - struct reparse_data rpdata; - int ret; - enum rp_status rp_status; + size_t print_name_nchars = link->print_name_nbytes / sizeof(wchar_t); + wchar_t print_name0[print_name_nchars + 1]; - ret = parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata); - if (ret) - return -ret; - - rp_status = win32_capture_maybe_rpfix_target(rpdata.substitute_name, - &rpdata.substitute_name_nbytes, - capture_root_ino, - capture_root_dev, - le32_to_cpu(*(le32*)rpbuf)); - if (rp_status & RP_FIXED) { - wimlib_assert(rpdata.substitute_name_nbytes % 2 == 0); - utf16lechar substitute_name_copy[rpdata.substitute_name_nbytes / 2]; - wmemcpy(substitute_name_copy, rpdata.substitute_name, - rpdata.substitute_name_nbytes / 2); - rpdata.substitute_name = substitute_name_copy; - rpdata.print_name = substitute_name_copy; - rpdata.print_name_nbytes = rpdata.substitute_name_nbytes; - if (rp_status == RP_FIXED_FULLPATH) { - /* "full path", meaning \??\ prefixed. We should not - * include this prefix in the print name, as it is - * apparently meant for the filesystem driver only. */ - rpdata.print_name += 4; - rpdata.print_name_nbytes -= 8; - } - ret = make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p); - if (ret == 0) - ret = rp_status; - else - ret = -ret; - } else { - if (rp_status == RP_EXCLUDED) { - /* Ignoring absolute symbolic link or junction point - * that points out of the tree to be captured. */ - size_t print_name_nchars = rpdata.print_name_nbytes / 2; - wchar_t print_name0[print_name_nchars + 1]; - print_name0[print_name_nchars] = L'\0'; - wmemcpy(print_name0, rpdata.print_name, print_name_nchars); - - params->progress.scan.cur_path = path; - params->progress.scan.symlink_target = print_name0; - do_capture_progress(params, - WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK, - NULL); - } - ret = rp_status; - } - return ret; + wmemcpy(print_name0, link->print_name, print_name_nchars); + print_name0[print_name_nchars] = L'\0'; + + params->progress.scan.cur_path = printable_path(path); + params->progress.scan.symlink_target = print_name0; + return do_capture_progress(params, scan_status, NULL); } -/* - * Loads the reparse point data from a reparse point into memory, optionally - * fixing the targets of absolute symbolic links and junction points to be - * relative to the root of capture. - * - * @h: Open handle to the reparse point. - * @path: Path to the reparse point file. - * @params: Additional parameters, including whether to do reparse point fixups - * or not. - * @rpbuf: Buffer of length at least REPARSE_POINT_MAX_SIZE bytes into which - * the reparse point buffer will be loaded. - * @rpbuflen_ret: On success, the length of the reparse point buffer in bytes - * is written to this location. - * - * Returns: - * On success, returns an `enum rp_status' value that indicates if and/or - * how the reparse point fixup was done. - * - * On failure, returns a negative value that is a negated WIMLIB_ERR_* - * code. - */ static int -win32_get_reparse_data(HANDLE h, const wchar_t *path, - struct add_image_params *params, - u8 *rpbuf, u16 *rpbuflen_ret) +winnt_try_rpfix(struct reparse_buffer_disk *rpbuf, u16 *rpbuflen_p, + const wchar_t *path, struct capture_params *params) { - DWORD bytesReturned; - u32 reparse_tag; + struct link_reparse_point link; + const wchar_t *rel_target; int ret; + + if (parse_link_reparse_point(rpbuf, *rpbuflen_p, &link)) { + /* Couldn't understand the reparse data; don't do the fixup. */ + return 0; + } + + /* + * Don't do reparse point fixups on relative symbolic links. + * + * On Windows, a relative symbolic link is supposed to be identifiable + * by having reparse tag WIM_IO_REPARSE_TAG_SYMLINK and flags + * SYMBOLIC_LINK_RELATIVE. We will use this information, although this + * may not always do what the user expects, since drive-relative + * symbolic links such as "\Users\Public" have SYMBOLIC_LINK_RELATIVE + * set, in addition to truely relative symbolic links such as "Users" or + * "Users\Public". However, WIMGAPI (as of Windows 8.1) has this same + * behavior. + * + * Otherwise, as far as I can tell, the targets of symbolic links that + * are NOT relative, as well as junctions (note: a mountpoint is the + * sames thing as a junction), must be NT namespace paths, for example: + * + * - \??\e:\Users\Public + * - \DosDevices\e:\Users\Public + * - \Device\HardDiskVolume4\Users\Public + * - \??\Volume{c47cb07c-946e-4155-b8f7-052e9cec7628}\Users\Public + * - \DosDevices\Volume{c47cb07c-946e-4155-b8f7-052e9cec7628}\Users\Public + */ + if (link_is_relative_symlink(&link)) + return 0; + + rel_target = winnt_relativize_link_target(link.substitute_name, + link.substitute_name_nbytes, + params->capture_root_ino, + params->capture_root_dev); + + if (rel_target == link.substitute_name) { + /* Target points outside of the tree being captured or had an + * unrecognized path format. Don't adjust it. */ + return winnt_rpfix_progress(params, path, &link, + WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK); + } + + /* We have an absolute target pointing within the directory being + * captured. @rel_target is the suffix of the link target that is the + * part relative to the directory being captured. + * + * We will cut off the prefix before this part (which is the path to the + * directory being captured) and add a dummy prefix. Since the process + * will need to be reversed when applying the image, it doesn't matter + * what exactly the prefix is, as long as it looks like an absolute + * path. */ + + static const wchar_t prefix[6] = L"\\??\\X:"; + static const size_t num_unprintable_chars = 4; + + size_t rel_target_nbytes = + link.substitute_name_nbytes - ((const u8 *)rel_target - + (const u8 *)link.substitute_name); + + wchar_t tmp[(sizeof(prefix) + rel_target_nbytes) / sizeof(wchar_t)]; + + memcpy(tmp, prefix, sizeof(prefix)); + memcpy(tmp + ARRAY_LEN(prefix), rel_target, rel_target_nbytes); + + link.substitute_name = tmp; + link.substitute_name_nbytes = sizeof(tmp); + + link.print_name = link.substitute_name + num_unprintable_chars; + link.print_name_nbytes = link.substitute_name_nbytes - + (num_unprintable_chars * sizeof(wchar_t)); + + if (make_link_reparse_point(&link, rpbuf, rpbuflen_p)) + return 0; + + ret = winnt_rpfix_progress(params, path, &link, + WIMLIB_SCAN_DENTRY_FIXED_SYMLINK); + if (ret) + return ret; + return RP_FIXED; +} + +/* Load the reparse data of a file into the corresponding WIM inode. If the + * reparse point is a symbolic link or junction with an absolute target and + * RPFIX mode is enabled, then also rewrite its target to be relative to the + * capture root. */ +static noinline_for_stack int +winnt_load_reparse_data(HANDLE h, struct wim_inode *inode, + const wchar_t *full_path, struct capture_params *params) +{ + struct reparse_buffer_disk rpbuf; + DWORD bytes_returned; u16 rpbuflen; + int ret; + + if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) { + /* See comment above assign_stream_types_encrypted() */ + WARNING("Ignoring reparse data of encrypted file \"%ls\"", + printable_path(full_path)); + return 0; + } if (!DeviceIoControl(h, FSCTL_GET_REPARSE_POINT, - NULL, /* "Not used with this operation; set to NULL" */ - 0, /* "Not used with this operation; set to 0" */ - rpbuf, /* "A pointer to a buffer that - receives the reparse point data */ - REPARSE_POINT_MAX_SIZE, /* "The size of the output - buffer, in bytes */ - &bytesReturned, - NULL)) + NULL, 0, &rpbuf, REPARSE_POINT_MAX_SIZE, + &bytes_returned, NULL)) { - set_errno_from_GetLastError(); - return -WIMLIB_ERR_READ; + win32_error(GetLastError(), L"\"%ls\": Can't get reparse point", + printable_path(full_path)); + return WIMLIB_ERR_READLINK; } - if (bytesReturned < 8 || bytesReturned > REPARSE_POINT_MAX_SIZE) { - errno = EINVAL; - return -WIMLIB_ERR_INVALID_REPARSE_DATA; + rpbuflen = bytes_returned; + + if (unlikely(rpbuflen < REPARSE_DATA_OFFSET)) { + ERROR("\"%ls\": reparse point buffer is too short", + printable_path(full_path)); + return WIMLIB_ERR_INVALID_REPARSE_DATA; } - rpbuflen = bytesReturned; - reparse_tag = le32_to_cpu(*(le32*)rpbuf); - if (params->add_flags & WIMLIB_ADD_FLAG_RPFIX && - (reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK || - reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT)) - { - /* Try doing reparse point fixup */ - ret = win32_capture_try_rpfix(rpbuf, - &rpbuflen, - params->capture_root_ino, - params->capture_root_dev, - path, - params); - } else { - ret = RP_NOT_FIXED; + if (params->add_flags & WIMLIB_ADD_FLAG_RPFIX) { + ret = winnt_try_rpfix(&rpbuf, &rpbuflen, full_path, params); + if (ret == RP_FIXED) + inode->i_rp_flags &= ~WIM_RP_FLAG_NOT_FIXED; + else if (ret) + return ret; } - *rpbuflen_ret = rpbuflen; - return ret; + + inode->i_reparse_tag = le32_to_cpu(rpbuf.rptag); + inode->i_rp_reserved = le16_to_cpu(rpbuf.rpreserved); + + if (!inode_add_stream_with_data(inode, + STREAM_TYPE_REPARSE_POINT, + NO_STREAM_NAME, + rpbuf.rpdata, + rpbuflen - REPARSE_DATA_OFFSET, + params->blob_table)) + return WIMLIB_ERR_NOMEM; + + return 0; } static DWORD WINAPI @@ -640,26 +764,30 @@ win32_tally_encrypted_size_cb(unsigned char *_data, void *_size_ret, } static int -win32_get_encrypted_file_size(const wchar_t *path, u64 *size_ret) +win32_get_encrypted_file_size(const wchar_t *path, bool is_dir, u64 *size_ret) { DWORD err; void *file_ctx; int ret; + DWORD flags = 0; + + if (is_dir) + flags |= CREATE_FOR_DIR; - err = OpenEncryptedFileRaw(path, 0, &file_ctx); + err = OpenEncryptedFileRaw(path, flags, &file_ctx); if (err != ERROR_SUCCESS) { - set_errno_from_win32_error(err); - ERROR_WITH_ERRNO("Failed to open encrypted file \"%ls\" " - "for raw read", path); + win32_error(err, + L"Failed to open encrypted file \"%ls\" for raw read", + printable_path(path)); return WIMLIB_ERR_OPEN; } *size_ret = 0; err = ReadEncryptedFileRaw(win32_tally_encrypted_size_cb, size_ret, file_ctx); if (err != ERROR_SUCCESS) { - set_errno_from_win32_error(err); - ERROR_WITH_ERRNO("Failed to read raw encrypted data from " - "\"%ls\"", path); + win32_error(err, + L"Failed to read raw encrypted data from \"%ls\"", + printable_path(path)); ret = WIMLIB_ERR_READ; } else { ret = 0; @@ -668,9 +796,56 @@ win32_get_encrypted_file_size(const wchar_t *path, u64 *size_ret) return ret; } +static int +winnt_scan_efsrpc_raw_data(struct wim_inode *inode, const wchar_t *nt_path, + struct list_head *unhashed_blobs) +{ + struct blob_descriptor *blob; + struct wim_inode_stream *strm; + int ret; + + blob = new_blob_descriptor(); + if (!blob) + goto err_nomem; + + blob->file_on_disk = WCSDUP(nt_path); + if (!blob->file_on_disk) + goto err_nomem; + blob->blob_location = BLOB_WIN32_ENCRYPTED; + + /* OpenEncryptedFileRaw() expects a Win32 name. */ + wimlib_assert(!wmemcmp(blob->file_on_disk, L"\\??\\", 4)); + blob->file_on_disk[1] = L'\\'; + + blob->file_inode = inode; + + ret = win32_get_encrypted_file_size(blob->file_on_disk, + (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY), + &blob->size); + if (ret) + goto err; + + /* Empty EFSRPC data does not make sense */ + wimlib_assert(blob->size != 0); + + strm = inode_add_stream(inode, STREAM_TYPE_EFSRPC_RAW_DATA, + NO_STREAM_NAME, blob); + if (!strm) + goto err_nomem; + + prepare_unhashed_blob(blob, inode, strm->stream_id, unhashed_blobs); + return 0; + +err_nomem: + ret = WIMLIB_ERR_NOMEM; +err: + free_blob_descriptor(blob); + return ret; +} + static bool -get_data_stream_name(const wchar_t *raw_stream_name, size_t raw_stream_name_nchars, - const wchar_t **stream_name_ret, size_t *stream_name_nchars_ret) +get_data_stream_name(wchar_t *raw_stream_name, size_t raw_stream_name_nchars, + wchar_t **stream_name_ret, size_t *stream_name_nchars_ret) { const wchar_t *sep, *type, *end; @@ -701,9 +876,12 @@ get_data_stream_name(const wchar_t *raw_stream_name, size_t raw_stream_name_ncha return true; } +/* Build the path to the data stream. For unnamed streams, this is simply the + * path to the file. For named streams, this is the path to the file, followed + * by a colon, followed by the stream name. */ static wchar_t * -build_stream_path(const wchar_t *path, size_t path_nchars, - const wchar_t *stream_name, size_t stream_name_nchars) +build_data_stream_path(const wchar_t *path, size_t path_nchars, + const wchar_t *stream_name, size_t stream_name_nchars) { size_t stream_path_nchars; wchar_t *stream_path; @@ -726,88 +904,57 @@ build_stream_path(const wchar_t *path, size_t path_nchars, } static int -win32_capture_stream(const wchar_t *path, size_t path_nchars, - const wchar_t *raw_stream_name, size_t raw_stream_name_nchars, - u64 stream_size, - struct wim_inode *inode, - struct list_head *unhashed_streams) +winnt_scan_data_stream(const wchar_t *path, size_t path_nchars, + wchar_t *raw_stream_name, size_t raw_stream_name_nchars, + u64 stream_size, + struct wim_inode *inode, struct list_head *unhashed_blobs) { - const wchar_t *stream_name; + wchar_t *stream_name; size_t stream_name_nchars; - struct wim_ads_entry *ads_entry; - wchar_t *stream_path; - struct wim_lookup_table_entry *lte; - u32 stream_id; + struct blob_descriptor *blob; + struct wim_inode_stream *strm; /* Given the raw stream name (which is something like - * L":streamname:$DATA", extract just the stream name part. */ + * :streamname:$DATA), extract just the stream name part (streamname). + * Ignore any non-$DATA streams. */ if (!get_data_stream_name(raw_stream_name, raw_stream_name_nchars, &stream_name, &stream_name_nchars)) return 0; - /* If this is a named stream, allocate an ADS entry. */ - if (stream_name_nchars) { - ads_entry = inode_add_ads_utf16le(inode, stream_name, - stream_name_nchars * sizeof(wchar_t)); - if (!ads_entry) - return WIMLIB_ERR_NOMEM; + stream_name[stream_name_nchars] = L'\0'; + + /* If the stream is non-empty, set up a blob descriptor for it. */ + if (stream_size != 0) { + blob = new_blob_descriptor(); + if (!blob) + goto err_nomem; + blob->file_on_disk = build_data_stream_path(path, + path_nchars, + stream_name, + stream_name_nchars); + if (!blob->file_on_disk) + goto err_nomem; + blob->blob_location = BLOB_IN_WINNT_FILE_ON_DISK; + blob->size = stream_size; + blob->file_inode = inode; } else { - ads_entry = NULL; + blob = NULL; } - /* If the stream is empty, no lookup table entry is needed. */ - if (stream_size == 0) - return 0; + strm = inode_add_stream(inode, STREAM_TYPE_DATA, stream_name, blob); + if (!strm) + goto err_nomem; - /* Build the path to the stream. For unnamed streams, this is simply - * the path to the file. For named streams, this is the path to the - * file, followed by a colon, followed by the stream name. */ - stream_path = build_stream_path(path, path_nchars, - stream_name, stream_name_nchars); - if (!stream_path) - return WIMLIB_ERR_NOMEM; - - /* Set up the lookup table entry for the stream. */ - lte = new_lookup_table_entry(); - if (!lte) { - FREE(stream_path); - return WIMLIB_ERR_NOMEM; - } - lte->file_on_disk = stream_path; - lte->resource_location = RESOURCE_IN_FILE_ON_DISK; - lte->size = stream_size; - if ((inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) && !ads_entry) { - /* Special case for encrypted file. */ - - /* OpenEncryptedFileRaw() expects Win32 name, not NT name. */ - lte->file_on_disk[1] = L'\\'; - wimlib_assert(!wmemcmp(lte->file_on_disk, L"\\\\?\\", 4)); - - u64 encrypted_size; - int ret; - - ret = win32_get_encrypted_file_size(lte->file_on_disk, - &encrypted_size); - if (ret) { - free_lookup_table_entry(lte); - return ret; - } - lte->size = encrypted_size; - lte->resource_location = RESOURCE_WIN32_ENCRYPTED; - } - - if (ads_entry) { - stream_id = ads_entry->stream_id; - ads_entry->lte = lte; - } else { - stream_id = 0; - inode->i_lte = lte; - } - add_unhashed_stream(lte, inode, stream_id, unhashed_streams); + prepare_unhashed_blob(blob, inode, strm->stream_id, unhashed_blobs); return 0; + +err_nomem: + free_blob_descriptor(blob); + return WIMLIB_ERR_NOMEM; } -/* Load information about the streams of an open file into a WIM inode. +/* + * Load information about the data streams of an open file into a WIM inode. * * We use the NtQueryInformationFile() system call instead of FindFirstStream() * and FindNextStream(). This is done for two reasons: @@ -820,24 +967,18 @@ win32_capture_stream(const wchar_t *path, size_t path_nchars, * and later, whereas the stream support in NtQueryInformationFile() was * already present in Windows XP. */ -static int -win32_capture_streams(HANDLE *hFile_p, - const wchar_t *path, - size_t path_nchars, - struct wim_inode *inode, - struct list_head *unhashed_streams, - u64 file_size, - DWORD vol_flags) +static noinline_for_stack int +winnt_scan_data_streams(HANDLE h, const wchar_t *path, size_t path_nchars, + struct wim_inode *inode, struct list_head *unhashed_blobs, + u64 file_size, u32 vol_flags) { int ret; - u8 _buf[1024] _aligned_attribute(8); + u8 _buf[4096] _aligned_attribute(8); u8 *buf; size_t bufsize; - IO_STATUS_BLOCK io_status; + IO_STATUS_BLOCK iosb; NTSTATUS status; - const FILE_STREAM_INFORMATION *info; - - DEBUG("Capturing streams from \"%ls\"", path); + FILE_STREAM_INFORMATION *info; buf = _buf; bufsize = sizeof(_buf); @@ -846,8 +987,8 @@ win32_capture_streams(HANDLE *hFile_p, goto unnamed_only; /* Get a buffer containing the stream information. */ - while (!NT_SUCCESS(status = (*func_NtQueryInformationFile)(*hFile_p, - &io_status, + while (!NT_SUCCESS(status = (*func_NtQueryInformationFile)(h, + &iosb, buf, bufsize, FileStreamInformation))) @@ -875,37 +1016,29 @@ win32_capture_streams(HANDLE *hFile_p, case STATUS_INVALID_INFO_CLASS: goto unnamed_only; default: - set_errno_from_nt_status(status); - ERROR_WITH_ERRNO("\"%ls\": Failed to query " - "stream information", path); + winnt_error(status, + L"\"%ls\": Failed to query stream information", + printable_path(path)); ret = WIMLIB_ERR_READ; goto out_free_buf; } } - if (io_status.Information == 0) { + if (iosb.Information == 0) { /* No stream information. */ ret = 0; goto out_free_buf; } - if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) { - /* OpenEncryptedFileRaw() seems to fail with - * ERROR_SHARING_VIOLATION if there are any handles opened to - * the file. */ - (*func_NtClose)(*hFile_p); - *hFile_p = INVALID_HANDLE_VALUE; - } - /* Parse one or more stream information structures. */ - info = (const FILE_STREAM_INFORMATION *)buf; + info = (FILE_STREAM_INFORMATION *)buf; for (;;) { - /* Capture the stream. */ - ret = win32_capture_stream(path, path_nchars, - info->StreamName, - info->StreamNameLength / 2, - info->StreamSize.QuadPart, - inode, unhashed_streams); + /* Load the stream information. */ + ret = winnt_scan_data_stream(path, path_nchars, + info->StreamName, + info->StreamNameLength / 2, + info->StreamSize.QuadPart, + inode, unhashed_blobs); if (ret) goto out_free_buf; @@ -914,16 +1047,15 @@ win32_capture_streams(HANDLE *hFile_p, break; } /* Advance to next stream information. */ - info = (const FILE_STREAM_INFORMATION *) - ((const u8 *)info + info->NextEntryOffset); + info = (FILE_STREAM_INFORMATION *) + ((u8 *)info + info->NextEntryOffset); } ret = 0; goto out_free_buf; unnamed_only: /* The volume does not support named streams. Only capture the unnamed - * data stream. */ - DEBUG("Only capturing unnamed data stream"); + * data stream. */ if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY | FILE_ATTRIBUTE_REPARSE_POINT)) { @@ -931,216 +1063,333 @@ unnamed_only: goto out_free_buf; } - ret = win32_capture_stream(path, path_nchars, - L"::$DATA", 7, file_size, - inode, unhashed_streams); + { + wchar_t stream_name[] = L"::$DATA"; + ret = winnt_scan_data_stream(path, path_nchars, stream_name, 7, + file_size, inode, unhashed_blobs); + } out_free_buf: /* Free buffer if allocated on heap. */ - if (buf != _buf) + if (unlikely(buf != _buf)) FREE(buf); return ret; } +static noinline_for_stack u64 +get_sort_key(HANDLE h) +{ + STARTING_VCN_INPUT_BUFFER in = { .StartingVcn.QuadPart = 0 }; + RETRIEVAL_POINTERS_BUFFER out; + DWORD bytesReturned; + + if (!DeviceIoControl(h, FSCTL_GET_RETRIEVAL_POINTERS, + &in, sizeof(in), + &out, sizeof(out), + &bytesReturned, NULL)) + return 0; + + if (out.ExtentCount < 1) + return 0; + + return out.Extents[0].Lcn.QuadPart; +} + +static void +set_sort_key(struct wim_inode *inode, u64 sort_key) +{ + for (unsigned i = 0; i < inode->i_num_streams; i++) { + struct wim_inode_stream *strm = &inode->i_streams[i]; + struct blob_descriptor *blob = stream_blob_resolved(strm); + if (blob && (blob->blob_location == BLOB_IN_WINNT_FILE_ON_DISK || + blob->blob_location == BLOB_WIN32_ENCRYPTED)) + blob->sort_key = sort_key; + } +} + +static noinline_for_stack u32 +get_volume_information(HANDLE h, const wchar_t *full_path, + struct capture_params *params) +{ + FILE_FS_ATTRIBUTE_INFORMATION attr_info; + FILE_FS_VOLUME_INFORMATION vol_info; + IO_STATUS_BLOCK iosb; + NTSTATUS status; + u32 vol_flags; + + /* Get volume flags */ + status = (*func_NtQueryVolumeInformationFile)(h, &iosb, + &attr_info, + sizeof(attr_info), + FileFsAttributeInformation); + if (likely((NT_SUCCESS(status) || status == STATUS_BUFFER_OVERFLOW) && + (iosb.Information >= + offsetof(FILE_FS_ATTRIBUTE_INFORMATION, + FileSystemAttributes) + + sizeof(attr_info.FileSystemAttributes)))) + { + vol_flags = attr_info.FileSystemAttributes; + } else { + winnt_warning(status, L"\"%ls\": Can't get volume attributes", + printable_path(full_path)); + vol_flags = 0; + } + + /* Get volume ID. */ + status = (*func_NtQueryVolumeInformationFile)(h, &iosb, + &vol_info, + sizeof(vol_info), + FileFsVolumeInformation); + if (likely((NT_SUCCESS(status) || status == STATUS_BUFFER_OVERFLOW) && + (iosb.Information >= + offsetof(FILE_FS_VOLUME_INFORMATION, + VolumeSerialNumber) + + sizeof(vol_info.VolumeSerialNumber)))) + { + params->capture_root_dev = vol_info.VolumeSerialNumber; + } else { + winnt_warning(status, L"\"%ls\": Can't get volume ID", + printable_path(full_path)); + params->capture_root_dev = 0; + } + return vol_flags; +} + +struct file_info { + u32 attributes; + u32 num_links; + u64 creation_time; + u64 last_write_time; + u64 last_access_time; + u64 ino; + u64 end_of_file; +}; + +static noinline_for_stack NTSTATUS +get_file_info(HANDLE h, struct file_info *info) +{ + IO_STATUS_BLOCK iosb; + NTSTATUS status; + FILE_ALL_INFORMATION all_info; + + status = (*func_NtQueryInformationFile)(h, &iosb, &all_info, + sizeof(all_info), + FileAllInformation); + + if (unlikely(!NT_SUCCESS(status) && status != STATUS_BUFFER_OVERFLOW)) + return status; + + info->attributes = all_info.BasicInformation.FileAttributes; + info->num_links = all_info.StandardInformation.NumberOfLinks; + info->creation_time = all_info.BasicInformation.CreationTime.QuadPart; + info->last_write_time = all_info.BasicInformation.LastWriteTime.QuadPart; + info->last_access_time = all_info.BasicInformation.LastAccessTime.QuadPart; + info->ino = all_info.InternalInformation.IndexNumber.QuadPart; + info->end_of_file = all_info.StandardInformation.EndOfFile.QuadPart; + return STATUS_SUCCESS; +} + static int -win32_build_dentry_tree_recursive(struct wim_dentry **root_ret, +winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret, HANDLE cur_dir, wchar_t *full_path, size_t full_path_nchars, const wchar_t *filename, size_t filename_nchars, - struct add_image_params *params, - struct win32_capture_state *state, - DWORD vol_flags) + struct capture_params *params, + struct winnt_scan_stats *stats, + u32 vol_flags) { struct wim_dentry *root = NULL; struct wim_inode *inode = NULL; - HANDLE h = INVALID_HANDLE_VALUE; + HANDLE h = NULL; int ret; NTSTATUS status; - FILE_ALL_INFORMATION file_info; - u8 *rpbuf; - u16 rpbuflen; - u16 not_rpfixed; + struct file_info file_info; + ACCESS_MASK requestedPerms; + u64 sort_key; - if (should_exclude_path(full_path + params->capture_root_nchars, - full_path_nchars - params->capture_root_nchars, - params->config)) - { - ret = 0; + ret = try_exclude(full_path, params); + if (unlikely(ret < 0)) /* Excluded? */ goto out_progress; - } + if (unlikely(ret > 0)) /* Error? */ + goto out; + /* Open the file. */ + requestedPerms = FILE_READ_DATA | + FILE_READ_ATTRIBUTES | + READ_CONTROL | + ACCESS_SYSTEM_SECURITY | + SYNCHRONIZE; +retry_open: status = winnt_openat(cur_dir, (cur_dir ? filename : full_path), (cur_dir ? filename_nchars : full_path_nchars), - FILE_READ_DATA | - FILE_READ_ATTRIBUTES | - READ_CONTROL | - ACCESS_SYSTEM_SECURITY | - SYNCHRONIZE, + requestedPerms, &h); + if (unlikely(!NT_SUCCESS(status))) { + if (status == STATUS_DELETE_PENDING) { + WARNING("\"%ls\": Deletion pending; skipping file", + printable_path(full_path)); + ret = 0; + goto out; + } + if (status == STATUS_ACCESS_DENIED && + (requestedPerms & FILE_READ_DATA)) { + /* This happens on encrypted files. */ + requestedPerms &= ~FILE_READ_DATA; + goto retry_open; + } + + winnt_error(status, L"\"%ls\": Can't open file", + printable_path(full_path)); + if (status == STATUS_FVE_LOCKED_VOLUME) + ret = WIMLIB_ERR_FVE_LOCKED_VOLUME; + else + ret = WIMLIB_ERR_OPEN; + goto out; + } + + /* Get information about the file. */ + status = get_file_info(h, &file_info); if (!NT_SUCCESS(status)) { - set_errno_from_nt_status(status); - ERROR_WITH_ERRNO("\"%ls\": Can't open file", full_path); - ret = WIMLIB_ERR_OPEN; + winnt_error(status, L"\"%ls\": Can't get file information", + printable_path(full_path)); + ret = WIMLIB_ERR_STAT; goto out; } + if (unlikely(!(requestedPerms & FILE_READ_DATA)) && + !(file_info.attributes & FILE_ATTRIBUTE_ENCRYPTED)) { - IO_STATUS_BLOCK iosb; - - status = (*func_NtQueryInformationFile)(h, &iosb, - &file_info, sizeof(file_info), - FileAllInformation); - if (!NT_SUCCESS(status) && status != STATUS_BUFFER_OVERFLOW) { - set_errno_from_GetLastError(); - ERROR_WITH_ERRNO("\"%ls\": Can't get file information", full_path); - ret = WIMLIB_ERR_STAT; - goto out; - } + ERROR("\"%ls\": Permission to read data was denied", + printable_path(full_path)); + ret = WIMLIB_ERR_OPEN; + goto out; } - if (!cur_dir) { - /* Root directory; get volume information. */ - FILE_FS_ATTRIBUTE_INFORMATION attr_info; - FILE_FS_VOLUME_INFORMATION vol_info; - IO_STATUS_BLOCK iosb; - - /* Get volume flags */ - status = (*func_NtQueryVolumeInformationFile)(h, &iosb, - &attr_info, sizeof(attr_info), - FileFsAttributeInformation); - if ((NT_SUCCESS(status) || (status == STATUS_BUFFER_OVERFLOW)) && - iosb.Information >= offsetof(FILE_FS_ATTRIBUTE_INFORMATION, - FileSystemAttributes) + - sizeof(attr_info.FileSystemAttributes)) - { - vol_flags = attr_info.FileSystemAttributes; - } else { - set_errno_from_nt_status(status); - WARNING_WITH_ERRNO("\"%ls\": Can't get volume attributes", - full_path); - vol_flags = 0; - } - - /* Set inode number of root directory */ - params->capture_root_ino = file_info.InternalInformation.IndexNumber.QuadPart; - - /* Get volume ID */ - status = (*func_NtQueryVolumeInformationFile)(h, &iosb, - &vol_info, sizeof(vol_info), - FileFsVolumeInformation); - if ((NT_SUCCESS(status) || (status == STATUS_BUFFER_OVERFLOW)) && - iosb.Information >= offsetof(FILE_FS_VOLUME_INFORMATION, - VolumeSerialNumber) + - sizeof(vol_info.VolumeSerialNumber)) - { - params->capture_root_dev = vol_info.VolumeSerialNumber; - } else { - set_errno_from_nt_status(status); - WARNING_WITH_ERRNO("\"%ls\": Can't get volume ID", - full_path); - params->capture_root_dev = 0; - } + if (unlikely(!cur_dir)) { + /* Root of tree being captured; get volume information. */ + vol_flags = get_volume_information(h, full_path, params); + params->capture_root_ino = file_info.ino; } - if (file_info.BasicInformation.FileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) { - rpbuf = alloca(REPARSE_POINT_MAX_SIZE); - ret = win32_get_reparse_data(h, full_path, - params, rpbuf, &rpbuflen); - if (ret < 0) { - /* WIMLIB_ERR_* (inverted) */ - ret = -ret; - ERROR_WITH_ERRNO("\"%ls\": Can't get reparse data", - full_path); - goto out; - } else if (ret & RP_FIXED) { - not_rpfixed = 0; - } else if (ret == RP_EXCLUDED) { - ret = 0; - goto out; - } else { - not_rpfixed = 1; - } - } /* Create a WIM dentry with an associated inode, which may be shared. * * However, we need to explicitly check for directories and files with * only 1 link and refuse to hard link them. This is because Windows * has a bug where it can return duplicate File IDs for files and - * directories on the FAT filesystem. */ + * directories on the FAT filesystem. + * + * Since we don't follow mount points on Windows, we don't need to query + * the volume ID per-file. Just once, for the root, is enough. But we + * can't simply pass 0, because then there could be inode collisions + * among multiple calls to win32_build_dentry_tree() that are scanning + * files on different volumes. */ ret = inode_table_new_dentry(params->inode_table, filename, - file_info.InternalInformation.IndexNumber.QuadPart, - 0, /* We don't follow mount points, so we - currently don't need to get the - volume ID / device number. */ - (file_info.StandardInformation.NumberOfLinks <= 1 || - (file_info.BasicInformation.FileAttributes & - FILE_ATTRIBUTE_DIRECTORY)), + file_info.ino, + params->capture_root_dev, + (file_info.num_links <= 1), &root); if (ret) goto out; - ret = win32_get_short_name(h, root); - if (ret) { - ERROR_WITH_ERRNO("\"%ls\": Can't get short name", full_path); + /* Get the short (DOS) name of the file. */ + status = winnt_get_short_name(h, root); + + /* If we can't read the short filename for any reason other than + * out-of-memory, just ignore the error and assume the file has no short + * name. This shouldn't be an issue, since the short names are + * essentially obsolete anyway. */ + if (unlikely(status == STATUS_NO_MEMORY)) { + ret = WIMLIB_ERR_NOMEM; goto out; } inode = root->d_inode; if (inode->i_nlink > 1) { - /* Shared inode; nothing more to do */ - ret = 0; + /* Shared inode (hard link); skip reading per-inode information. + */ goto out_progress; } - inode->i_attributes = file_info.BasicInformation.FileAttributes; - inode->i_creation_time = file_info.BasicInformation.CreationTime.QuadPart; - inode->i_last_write_time = file_info.BasicInformation.LastWriteTime.QuadPart; - inode->i_last_access_time = file_info.BasicInformation.LastAccessTime.QuadPart; - inode->i_resolved = 1; - - params->add_flags &= ~WIMLIB_ADD_FLAG_ROOT; + inode->i_attributes = file_info.attributes; + inode->i_creation_time = file_info.creation_time; + inode->i_last_write_time = file_info.last_write_time; + inode->i_last_access_time = file_info.last_access_time; + /* Get the file's security descriptor, unless we are capturing in + * NO_ACLS mode or the volume does not support security descriptors. */ if (!(params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS) && (vol_flags & FILE_PERSISTENT_ACLS)) { - ret = win32_get_security_descriptor(h, inode, - params->sd_set, state, - params->add_flags); - if (ret) { - ERROR_WITH_ERRNO("\"%ls\": Can't " - "read security descriptor", full_path); + status = winnt_get_security_descriptor(h, inode, + params->sd_set, stats, + params->add_flags); + if (!NT_SUCCESS(status)) { + winnt_error(status, + L"\"%ls\": Can't read security descriptor", + printable_path(full_path)); + ret = WIMLIB_ERR_STAT; goto out; } } - /* Capture the unnamed data stream (only should be present for regular - * files) and any alternate data streams. */ - ret = win32_capture_streams(&h, - full_path, - full_path_nchars, - inode, - params->unhashed_streams, - file_info.StandardInformation.EndOfFile.QuadPart, - vol_flags); - if (ret) - goto out; + /* If this is a reparse point, load the reparse data. */ + if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)) { + ret = winnt_load_reparse_data(h, inode, full_path, params); + if (ret) + goto out; + } + + sort_key = get_sort_key(h); + + if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)) { + /* Load information about the raw encrypted data. This is + * needed for any directory or non-directory that has + * FILE_ATTRIBUTE_ENCRYPTED set. + * + * Note: since OpenEncryptedFileRaw() fails with + * ERROR_SHARING_VIOLATION if there are any open handles to the + * file, we have to close the file and re-open it later if + * needed. */ + (*func_NtClose)(h); + h = NULL; + ret = winnt_scan_efsrpc_raw_data(inode, full_path, + params->unhashed_blobs); + if (ret) + goto out; + } else { + /* + * Load information about data streams (unnamed and named). + * + * Skip this step for encrypted files, since the data from + * ReadEncryptedFileRaw() already contains all data streams (and + * they do in fact all get restored by WriteEncryptedFileRaw().) + * + * Note: WIMGAPI (as of Windows 8.1) gets wrong and stores both + * the EFSRPC data and the named data stream(s)...! + */ + ret = winnt_scan_data_streams(h, + full_path, + full_path_nchars, + inode, + params->unhashed_blobs, + file_info.end_of_file, + vol_flags); + if (ret) + goto out; + } - if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) { - /* Reparse point: set the reparse data (which we read already) - * */ - inode->i_not_rpfixed = not_rpfixed; - inode->i_reparse_tag = le32_to_cpu(*(le32*)rpbuf); - ret = inode_set_unnamed_stream(inode, rpbuf + 8, rpbuflen - 8, - params->lookup_table); - } else if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) { - /* Directory (not a reparse point) --- recurse to children */ - - if (h == INVALID_HANDLE_VALUE) { + set_sort_key(inode, sort_key); + + if (inode_is_directory(inode)) { + + /* Directory: recurse to children. */ + + if (unlikely(!h)) { /* Re-open handle that was closed to read raw encrypted * data. */ status = winnt_openat(cur_dir, @@ -1151,59 +1400,59 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret, FILE_LIST_DIRECTORY | SYNCHRONIZE, &h); if (!NT_SUCCESS(status)) { - set_errno_from_nt_status(status); - ERROR_WITH_ERRNO("\"%ls\": Can't open file", - full_path); + winnt_error(status, + L"\"%ls\": Can't re-open file", + printable_path(full_path)); ret = WIMLIB_ERR_OPEN; goto out; } } - ret = win32_recurse_directory(h, + ret = winnt_recurse_directory(h, full_path, full_path_nchars, root, params, - state, + stats, vol_flags); + if (ret) + goto out; } - if (ret) - goto out; out_progress: - params->progress.scan.cur_path = full_path; - if (root) - do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK, inode); + params->progress.scan.cur_path = printable_path(full_path); + if (likely(root)) + ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK, inode); else - do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL); + ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL); out: - if (h != INVALID_HANDLE_VALUE) + if (likely(h)) (*func_NtClose)(h); - if (ret == 0) - *root_ret = root; - else - free_dentry_tree(root, params->lookup_table); + if (unlikely(ret)) { + free_dentry_tree(root, params->blob_table); + root = NULL; + ret = report_capture_error(params, ret, full_path); + } + *root_ret = root; return ret; } static void -win32_do_capture_warnings(const wchar_t *path, - const struct win32_capture_state *state, - int add_flags) +winnt_do_scan_warnings(const wchar_t *path, const struct winnt_scan_stats *stats) { - if (state->num_get_sacl_priv_notheld == 0 && - state->num_get_sd_access_denied == 0) + if (likely(stats->num_get_sacl_priv_notheld == 0 && + stats->num_get_sd_access_denied == 0)) return; WARNING("Scan of \"%ls\" complete, but with one or more warnings:", path); - if (state->num_get_sacl_priv_notheld != 0) { + if (stats->num_get_sacl_priv_notheld != 0) { WARNING("- Could not capture SACL (System Access Control List)\n" " on %lu files or directories.", - state->num_get_sacl_priv_notheld); + stats->num_get_sacl_priv_notheld); } - if (state->num_get_sd_access_denied != 0) { + if (stats->num_get_sd_access_denied != 0) { WARNING("- Could not capture security descriptor at all\n" " on %lu files or directories.", - state->num_get_sd_access_denied); + stats->num_get_sd_access_denied); } WARNING("To fully capture all security descriptors, run the program\n" " with Administrator rights."); @@ -1211,17 +1460,17 @@ win32_do_capture_warnings(const wchar_t *path, #define WINDOWS_NT_MAX_PATH 32768 -/* Win32 version of capturing a directory tree */ +/* Win32 version of capturing a directory tree. */ int win32_build_dentry_tree(struct wim_dentry **root_ret, const wchar_t *root_disk_path, - struct add_image_params *params) + struct capture_params *params) { wchar_t *path; - DWORD dret; - size_t path_nchars; int ret; - struct win32_capture_state state; + UNICODE_STRING ntpath; + struct winnt_scan_stats stats; + size_t ntpath_nchars; /* WARNING: There is no check for overflow later when this buffer is * being used! But it's as long as the maximum path length understood @@ -1230,38 +1479,39 @@ win32_build_dentry_tree(struct wim_dentry **root_ret, if (!path) return WIMLIB_ERR_NOMEM; - /* Translate into full path. */ - dret = GetFullPathName(root_disk_path, WINDOWS_NT_MAX_PATH - 3, - &path[4], NULL); - - if (dret == 0 || dret >= WINDOWS_NT_MAX_PATH - 3) { - ERROR("Can't get full path name for \"%ls\"", root_disk_path); - return WIMLIB_ERR_UNSUPPORTED; - } - - /* Add \??\ prefix to form the NT namespace path. */ - wmemcpy(path, L"\\??\\", 4); - path_nchars = dret + 4; + ret = win32_path_to_nt_path(root_disk_path, &ntpath); + if (ret) + goto out_free_path; - /* Strip trailing slashes. If we don't do this, we may create a path - * with multiple consecutive backslashes, which for some reason causes - * Windows to report that the file cannot be found. */ - while (path_nchars >= 2 && - path[path_nchars - 1] == L'\\' && - path[path_nchars - 2] != L':') + if (ntpath.Length < 4 * sizeof(wchar_t) || + ntpath.Length > WINDOWS_NT_MAX_PATH * sizeof(wchar_t) || + wmemcmp(ntpath.Buffer, L"\\??\\", 4)) { - path[--path_nchars] = L'\0'; + ERROR("\"%ls\": unrecognized path format", root_disk_path); + ret = WIMLIB_ERR_INVALID_PARAM; + } else { + ntpath_nchars = ntpath.Length / sizeof(wchar_t); + wmemcpy(path, ntpath.Buffer, ntpath_nchars); + path[ntpath_nchars] = L'\0'; + + params->capture_root_nchars = ntpath_nchars; + if (path[ntpath_nchars - 1] == L'\\') + params->capture_root_nchars--; + ret = 0; } + HeapFree(GetProcessHeap(), 0, ntpath.Buffer); + if (ret) + goto out_free_path; - params->capture_root_nchars = path_nchars; + memset(&stats, 0, sizeof(stats)); - memset(&state, 0, sizeof(state)); - ret = win32_build_dentry_tree_recursive(root_ret, NULL, - path, path_nchars, L"", 0, - params, &state, 0); + ret = winnt_build_dentry_tree_recursive(root_ret, NULL, + path, ntpath_nchars, + L"", 0, params, &stats, 0); +out_free_path: FREE(path); if (ret == 0) - win32_do_capture_warnings(root_disk_path, &state, params->add_flags); + winnt_do_scan_warnings(root_disk_path, &stats); return ret; }