X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwin32_capture.c;h=0d4b783e4086b395d779fa8df64dde45acc9cb94;hp=cf116399f0447bdb661745a2479a84ae5d02f668;hb=d1c07c5254225e35a1ec2f8babe30a27ef6a8a8b;hpb=9db1bdc721081a2dead6a60cba77dfb9bdad5ceb diff --git a/src/win32_capture.c b/src/win32_capture.c index cf116399..0d4b783e 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 Eric Biggers - * - * This file is part of wimlib, a library for working with WIM files. + * Copyright (C) 2013-2016 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,636 +29,1018 @@ #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 "wimlib/win32_vss.h" +#include "wimlib/wof.h" -#define MAX_GET_SD_ACCESS_DENIED_WARNINGS 1 -#define MAX_GET_SACL_PRIV_NOTHELD_WARNINGS 1 -#define MAX_CAPTURE_LONG_PATH_WARNINGS 5 - -struct win32_capture_state { +struct winnt_scan_ctx { + struct capture_params *params; + bool is_ntfs; + u32 vol_flags; unsigned long num_get_sd_access_denied; unsigned long num_get_sacl_priv_notheld; - unsigned long num_long_path_warnings; + + /* True if WOF is definitely not attached to the volume being scanned; + * false if it may be */ + bool wof_not_attached; + + /* A reference to the VSS snapshot being used, or NULL if none */ + struct vss_snapshot *snapshot; +}; + +static inline const wchar_t * +printable_path(const wchar_t *full_path) +{ + /* Skip over \\?\ or \??\ */ + return full_path + 4; +} + +/* Description of where data is located on a Windows filesystem */ +struct windows_file { + + /* Is the data the raw encrypted data of an EFS-encrypted file? */ + u64 is_encrypted : 1; + + /* Is this file "open by file ID" rather than the regular "open by + * path"? "Open by file ID" uses resources more efficiently. */ + u64 is_file_id : 1; + + /* The file's LCN (logical cluster number) for sorting, or 0 if unknown. + */ + u64 sort_key : 62; + + /* Length of the path in bytes, excluding the null terminator if + * present. */ + size_t path_nbytes; + + /* A reference to the VSS snapshot containing the file, or NULL if none. + */ + struct vss_snapshot *snapshot; + + /* The path to the file. If 'is_encrypted=0' this is an NT namespace + * path; if 'is_encrypted=1' this is a Win32 namespace path. If + * 'is_file_id=0', then the path is null-terminated. If 'is_file_id=1' + * (only allowed with 'is_encrypted=0') the path ends with a binary file + * ID and may not be null-terminated. */ + wchar_t path[0]; }; +/* Allocate a structure to describe the location of a data stream by path. */ +static struct windows_file * +alloc_windows_file(const wchar_t *path, size_t path_nchars, + const wchar_t *stream_name, size_t stream_name_nchars, + struct vss_snapshot *snapshot, bool is_encrypted) +{ + size_t full_path_nbytes; + struct windows_file *file; + wchar_t *p; + + full_path_nbytes = path_nchars * sizeof(wchar_t); + if (stream_name_nchars) + full_path_nbytes += (1 + stream_name_nchars) * sizeof(wchar_t); + + file = MALLOC(sizeof(struct windows_file) + full_path_nbytes + + sizeof(wchar_t)); + if (!file) + return NULL; + + file->is_encrypted = is_encrypted; + file->is_file_id = 0; + file->sort_key = 0; + file->path_nbytes = full_path_nbytes; + file->snapshot = vss_get_snapshot(snapshot); + p = wmempcpy(file->path, path, path_nchars); + if (stream_name_nchars) { + /* Named data stream */ + *p++ = L':'; + p = wmempcpy(p, stream_name, stream_name_nchars); + } + *p = L'\0'; + return file; +} + +/* Allocate a structure to describe the location of a file by ID. */ +static struct windows_file * +alloc_windows_file_for_file_id(u64 file_id, const wchar_t *root_path, + size_t root_path_nchars, + struct vss_snapshot *snapshot) +{ + size_t full_path_nbytes; + struct windows_file *file; + wchar_t *p; + + full_path_nbytes = (root_path_nchars * sizeof(wchar_t)) + + sizeof(file_id); + file = MALLOC(sizeof(struct windows_file) + full_path_nbytes + + sizeof(wchar_t)); + if (!file) + return NULL; + + file->is_encrypted = 0; + file->is_file_id = 1; + file->sort_key = 0; + file->path_nbytes = full_path_nbytes; + file->snapshot = vss_get_snapshot(snapshot); + p = wmempcpy(file->path, root_path, root_path_nchars); + p = mempcpy(p, &file_id, sizeof(file_id)); + *p = L'\0'; + return file; +} + +/* Add a stream, located on a Windows filesystem, to the specified WIM inode. */ +static int +add_stream(struct wim_inode *inode, struct windows_file *windows_file, + u64 stream_size, int stream_type, const utf16lechar *stream_name, + struct list_head *unhashed_blobs) +{ + struct blob_descriptor *blob = NULL; + struct wim_inode_stream *strm; + int ret; + + if (!windows_file) + goto err_nomem; + + /* If the stream is nonempty, create a blob descriptor for it. */ + if (stream_size) { + blob = new_blob_descriptor(); + if (!blob) + goto err_nomem; + blob->windows_file = windows_file; + blob->blob_location = BLOB_IN_WINDOWS_FILE; + blob->file_inode = inode; + blob->size = stream_size; + windows_file = NULL; + } + + strm = inode_add_stream(inode, stream_type, stream_name, blob); + if (!strm) + goto err_nomem; + + prepare_unhashed_blob(blob, inode, strm->stream_id, unhashed_blobs); + ret = 0; +out: + if (windows_file) + free_windows_file(windows_file); + return ret; + +err_nomem: + free_blob_descriptor(blob); + ret = WIMLIB_ERR_NOMEM; + goto out; +} + +struct windows_file * +clone_windows_file(const struct windows_file *file) +{ + struct windows_file *new; + + new = memdup(file, sizeof(*file) + file->path_nbytes + sizeof(wchar_t)); + if (new) + vss_get_snapshot(new->snapshot); + return new; +} -static const wchar_t *capture_access_denied_msg = -L" If you are not running this program as the administrator, you may\n" - " need to do so, so that all data and metadata can be backed up.\n" - " Otherwise, there may be no way to access the desired data or\n" - " metadata without taking ownership of the file or directory.\n" - ; +void +free_windows_file(struct windows_file *file) +{ + vss_put_snapshot(file->snapshot); + FREE(file); +} int -read_win32_file_prefix(const struct wim_lookup_table_entry *lte, - u64 size, - consume_data_callback_t cb, - void *ctx_or_buf, - int _ignored_flags) +cmp_windows_files(const struct windows_file *file1, + const struct windows_file *file2) { - int ret = 0; - void *out_buf; - DWORD err; + /* Compare by starting LCN (logical cluster number) */ + int v = cmp_u64(file1->sort_key, file2->sort_key); + if (v) + return v; + + /* Fall back to comparing files by path (arbitrary heuristic). */ + v = memcmp(file1->path, file2->path, + min(file1->path_nbytes, file2->path_nbytes)); + if (v) + return v; + + return cmp_u32(file1->path_nbytes, file2->path_nbytes); +} + +const wchar_t * +get_windows_file_path(const struct windows_file *file) +{ + return file->path; +} + +/* + * Open the file named by the NT namespace path @path of length @path_nchars + * characters. If @cur_dir is not NULL then the path is given relative to + * @cur_dir; otherwise the path is absolute. @perms is the access mask of + * permissions to request on the handle. If permission to read the data is + * requested, then SYNCHRONIZE is automatically added. + */ +static NTSTATUS +winnt_openat(HANDLE cur_dir, const wchar_t *path, size_t path_nchars, + ACCESS_MASK perms, HANDLE *h_ret) +{ + UNICODE_STRING name = { + .Length = path_nchars * sizeof(wchar_t), + .MaximumLength = path_nchars * sizeof(wchar_t), + .Buffer = (wchar_t *)path, + }; + OBJECT_ATTRIBUTES attr = { + .Length = sizeof(attr), + .RootDirectory = cur_dir, + .ObjectName = &name, + }; + IO_STATUS_BLOCK iosb; + NTSTATUS status; + ULONG options = FILE_OPEN_REPARSE_POINT | FILE_OPEN_FOR_BACKUP_INTENT; + + if (perms & (FILE_READ_DATA | FILE_LIST_DIRECTORY)) { + perms |= SYNCHRONIZE; + options |= FILE_SYNCHRONOUS_IO_NONALERT; + options |= FILE_SEQUENTIAL_ONLY; + } +retry: + status = (*func_NtOpenFile)(h_ret, perms, &attr, &iosb, + FILE_SHARE_VALID_FLAGS, options); + if (!NT_SUCCESS(status)) { + /* Try requesting fewer permissions */ + if (status == STATUS_ACCESS_DENIED || + status == STATUS_PRIVILEGE_NOT_HELD) { + if (perms & ACCESS_SYSTEM_SECURITY) { + perms &= ~ACCESS_SYSTEM_SECURITY; + goto retry; + } + if (perms & READ_CONTROL) { + perms &= ~READ_CONTROL; + goto retry; + } + } + } + return status; +} + +static NTSTATUS +winnt_open(const wchar_t *path, size_t path_nchars, ACCESS_MASK perms, + HANDLE *h_ret) +{ + return winnt_openat(NULL, path, path_nchars, perms, h_ret); +} + +static const wchar_t * +windows_file_to_string(const struct windows_file *file, u8 *buf, size_t bufsize) +{ + if (file->is_file_id) { + u64 file_id; + memcpy(&file_id, + (u8 *)file->path + file->path_nbytes - sizeof(file_id), + sizeof(file_id)); + swprintf((wchar_t *)buf, L"NTFS inode 0x%016"PRIx64, file_id); + } else if (file->path_nbytes + 3 * sizeof(wchar_t) <= bufsize) { + swprintf((wchar_t *)buf, L"\"%ls\"", file->path); + } else { + return L"(name too long)"; + } + return (wchar_t *)buf; +} + +static int +read_winnt_stream_prefix(const struct windows_file *file, + u64 size, const struct read_blob_callbacks *cbs) +{ + IO_STATUS_BLOCK iosb; + UNICODE_STRING name = { + .Buffer = (wchar_t *)file->path, + .Length = file->path_nbytes, + .MaximumLength = file->path_nbytes, + }; + OBJECT_ATTRIBUTES attr = { + .Length = sizeof(attr), + .ObjectName = &name, + }; + HANDLE h; + NTSTATUS status; + u8 buf[BUFFER_SIZE] _aligned_attribute(8); u64 bytes_remaining; + int ret; - HANDLE hFile = win32_open_file_data_only(lte->file_on_disk); - if (hFile == INVALID_HANDLE_VALUE) { - err = GetLastError(); - ERROR("Failed to open \"%ls\"", lte->file_on_disk); - win32_error(err); + status = (*func_NtOpenFile)(&h, FILE_READ_DATA | SYNCHRONIZE, + &attr, &iosb, + FILE_SHARE_VALID_FLAGS, + FILE_OPEN_REPARSE_POINT | + FILE_OPEN_FOR_BACKUP_INTENT | + FILE_SYNCHRONOUS_IO_NONALERT | + FILE_SEQUENTIAL_ONLY | + (file->is_file_id ? FILE_OPEN_BY_FILE_ID : 0)); + if (unlikely(!NT_SUCCESS(status))) { + if (status == STATUS_SHARING_VIOLATION) { + ERROR("Can't open %ls for reading:\n" + " File is in use by another process! " + "Consider using snapshot (VSS) mode.", + windows_file_to_string(file, buf, sizeof(buf))); + } else { + winnt_error(status, L"Can't open %ls for reading", + windows_file_to_string(file, buf, sizeof(buf))); + } return WIMLIB_ERR_OPEN; } - if (cb) - out_buf = alloca(WIM_CHUNK_SIZE); - else - out_buf = ctx_or_buf; - + ret = 0; bytes_remaining = size; while (bytes_remaining) { - DWORD bytesToRead, bytesRead; - - bytesToRead = min(WIM_CHUNK_SIZE, bytes_remaining); - if (!ReadFile(hFile, out_buf, bytesToRead, &bytesRead, NULL) || - bytesRead != bytesToRead) - { - err = GetLastError(); - ERROR("Failed to read data from \"%ls\"", lte->file_on_disk); - win32_error(err); - ret = WIMLIB_ERR_READ; + 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 (unlikely(!NT_SUCCESS(status))) { + if (status == STATUS_END_OF_FILE) { + ERROR("%ls: File was concurrently truncated", + windows_file_to_string(file, buf, sizeof(buf))); + ret = WIMLIB_ERR_CONCURRENT_MODIFICATION_DETECTED; + } else { + winnt_error(status, L"Error reading data from %ls", + windows_file_to_string(file, buf, sizeof(buf))); + ret = WIMLIB_ERR_READ; + } break; } - bytes_remaining -= bytesRead; - if (cb) { - ret = (*cb)(out_buf, bytesRead, ctx_or_buf); - if (ret) - break; - } else { - out_buf += bytesRead; - } + + bytes_read = iosb.Information; + + bytes_remaining -= bytes_read; + ret = call_consume_chunk(buf, bytes_read, cbs); + if (ret) + break; } - CloseHandle(hFile); + (*func_NtClose)(h); return ret; } struct win32_encrypted_read_ctx { - consume_data_callback_t read_prefix_cb; - void *read_prefix_ctx_or_buf; + const struct read_blob_callbacks *cbs; int wimlib_err_code; - void *buf; - size_t buf_filled; u64 bytes_remaining; }; static DWORD WINAPI -win32_encrypted_export_cb(unsigned char *_data, void *_ctx, unsigned long len) +win32_encrypted_export_cb(unsigned char *data, void *_ctx, unsigned long len) { - const void *data = _data; struct win32_encrypted_read_ctx *ctx = _ctx; int ret; + size_t bytes_to_consume = min(len, ctx->bytes_remaining); - DEBUG("len = %lu", len); - if (ctx->read_prefix_cb) { - /* The length of the buffer passed to the ReadEncryptedFileRaw() - * export callback is undocumented, so we assume it may be of - * arbitrary size. */ - size_t bytes_to_buffer = min(ctx->bytes_remaining - ctx->buf_filled, - len); - while (bytes_to_buffer) { - size_t bytes_to_copy_to_buf = - min(bytes_to_buffer, WIM_CHUNK_SIZE - ctx->buf_filled); - - memcpy(ctx->buf + ctx->buf_filled, data, - bytes_to_copy_to_buf); - ctx->buf_filled += bytes_to_copy_to_buf; - data += bytes_to_copy_to_buf; - bytes_to_buffer -= bytes_to_copy_to_buf; - - if (ctx->buf_filled == WIM_CHUNK_SIZE || - ctx->buf_filled == ctx->bytes_remaining) - { - ret = (*ctx->read_prefix_cb)(ctx->buf, - ctx->buf_filled, - ctx->read_prefix_ctx_or_buf); - if (ret) { - ctx->wimlib_err_code = ret; - /* Shouldn't matter what error code is returned - * here, as long as it isn't ERROR_SUCCESS. */ - return ERROR_READ_FAULT; - } - ctx->bytes_remaining -= ctx->buf_filled; - ctx->buf_filled = 0; - } - } - } else { - size_t len_to_copy = min(len, ctx->bytes_remaining); - ctx->read_prefix_ctx_or_buf = mempcpy(ctx->read_prefix_ctx_or_buf, - data, - len_to_copy); - ctx->bytes_remaining -= len_to_copy; + if (bytes_to_consume == 0) + return ERROR_SUCCESS; + + ret = call_consume_chunk(data, bytes_to_consume, ctx->cbs); + if (ret) { + ctx->wimlib_err_code = ret; + /* 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; return ERROR_SUCCESS; } -int -read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte, - u64 size, - consume_data_callback_t cb, - void *ctx_or_buf, - int _ignored_flags) +static int +read_win32_encrypted_file_prefix(const wchar_t *path, bool is_dir, u64 size, + 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 encryted file \"%ls\"", - size, lte->file_on_disk); + if (is_dir) + flags |= CREATE_FOR_DIR; - export_ctx.read_prefix_cb = cb; - export_ctx.read_prefix_ctx_or_buf = ctx_or_buf; + export_ctx.cbs = cbs; export_ctx.wimlib_err_code = 0; - if (cb) { - export_ctx.buf = MALLOC(WIM_CHUNK_SIZE); - if (!export_ctx.buf) - return WIMLIB_ERR_NOMEM; - } else { - export_ctx.buf = NULL; - } - export_ctx.buf_filled = 0; export_ctx.bytes_remaining = size; - err = OpenEncryptedFileRawW(lte->file_on_disk, 0, &file_ctx); + err = OpenEncryptedFileRaw(path, flags, &file_ctx); if (err != ERROR_SUCCESS) { - ERROR("Failed to open encrypted file \"%ls\" for raw read", - lte->file_on_disk); - win32_error(err); - ret = WIMLIB_ERR_OPEN; - goto out_free_buf; + win32_error(err, + L"Failed to open encrypted file \"%ls\" for raw read", + printable_path(path)); + return WIMLIB_ERR_OPEN; } err = ReadEncryptedFileRaw(win32_encrypted_export_cb, &export_ctx, file_ctx); if (err != ERROR_SUCCESS) { - ERROR("Failed to read encrypted file \"%ls\"", - lte->file_on_disk); - win32_error(err); ret = export_ctx.wimlib_err_code; - if (ret == 0) + if (ret == 0) { + win32_error(err, + L"Failed to read encrypted file \"%ls\"", + printable_path(path)); 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(path)); ret = WIMLIB_ERR_READ; } else { ret = 0; } CloseEncryptedFileRaw(file_ctx); -out_free_buf: - FREE(export_ctx.buf); return ret; } - -static u64 -FILETIME_to_u64(const FILETIME *ft) +/* Read the first @size bytes from the file, or named data stream of a file, + * described by @blob. */ +int +read_windows_file_prefix(const struct blob_descriptor *blob, u64 size, + const struct read_blob_callbacks *cbs) { - return ((u64)ft->dwHighDateTime << 32) | (u64)ft->dwLowDateTime; + const struct windows_file *file = blob->windows_file; + + if (unlikely(file->is_encrypted)) { + bool is_dir = (blob->file_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY); + return read_win32_encrypted_file_prefix(file->path, is_dir, size, cbs); + } + + return read_winnt_stream_prefix(file, size, cbs); } -static int -win32_get_short_name(struct wim_dentry *dentry, const wchar_t *path) +/* + * Load the short name of a file into a WIM dentry. + */ +static noinline_for_stack NTSTATUS +winnt_get_short_name(HANDLE h, struct wim_dentry *dentry) { - WIN32_FIND_DATAW dat; - HANDLE hFind; - int ret = 0; - - /* If we can't read the short filename for some reason, we just ignore - * the error and assume the file has no short name. I don't think this - * should be an issue, since the short names are essentially obsolete - * anyway. */ - hFind = FindFirstFileW(path, &dat); - if (hFind != INVALID_HANDLE_VALUE) { - if (dat.cAlternateFileName[0] != L'\0') { - DEBUG("\"%ls\": short name \"%ls\"", path, dat.cAlternateFileName); - size_t short_name_nbytes = wcslen(dat.cAlternateFileName) * - sizeof(wchar_t); - size_t n = short_name_nbytes + sizeof(wchar_t); - dentry->short_name = MALLOC(n); - if (dentry->short_name) { - memcpy(dentry->short_name, dat.cAlternateFileName, n); - dentry->short_name_nbytes = short_name_nbytes; - } else { - ret = WIMLIB_ERR_NOMEM; - } - } - FindClose(hFind); + /* 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 iosb; + u8 buf[128] _aligned_attribute(8); + const FILE_NAME_INFORMATION *info; + + status = (*func_NtQueryInformationFile)(h, &iosb, buf, sizeof(buf), + FileAlternateNameInformation); + info = (const FILE_NAME_INFORMATION *)buf; + if (NT_SUCCESS(status) && info->FileNameLength != 0) { + 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 ret; + return status; } -static int -win32_get_security_descriptor(struct wim_dentry *dentry, - struct wim_sd_set *sd_set, - const wchar_t *path, - struct win32_capture_state *state, - int add_flags) +/* + * Load the security descriptor of a file into the corresponding inode and the + * WIM image's security descriptor set. + */ +static noinline_for_stack int +winnt_load_security_descriptor(HANDLE h, struct wim_inode *inode, + const wchar_t *full_path, + struct winnt_scan_ctx *ctx) { SECURITY_INFORMATION requestedInformation; - DWORD lenNeeded = 0; - BOOL status; - DWORD err; - unsigned long n; - - requestedInformation = DACL_SECURITY_INFORMATION | + u8 _buf[4096] _aligned_attribute(8); + u8 *buf; + ULONG bufsize; + ULONG len_needed; + NTSTATUS status; + + /* + * 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; -again: - /* Request length of security descriptor */ - status = GetFileSecurityW(path, requestedInformation, - NULL, 0, &lenNeeded); - err = GetLastError(); - if (!status && err == ERROR_INSUFFICIENT_BUFFER) { - DWORD len = lenNeeded; - char buf[len]; - if (GetFileSecurityW(path, requestedInformation, - (PSECURITY_DESCRIPTOR)buf, len, &lenNeeded)) - { - int security_id = sd_set_add_sd(sd_set, buf, len); - if (security_id < 0) - return WIMLIB_ERR_NOMEM; - else { - dentry->d_inode->i_security_id = security_id; - return 0; + 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: + * + * 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. + * + * 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. + * + * 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. + * + * 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, + &len_needed)))) + { + switch (status) { + case STATUS_BUFFER_TOO_SMALL: + wimlib_assert(buf == _buf); + buf = MALLOC(len_needed); + if (!buf) { + status = STATUS_NO_MEMORY; + goto out; } - } else { - err = GetLastError(); + bufsize = len_needed; + break; + case STATUS_PRIVILEGE_NOT_HELD: + case STATUS_ACCESS_DENIED: + if (ctx->params->add_flags & WIMLIB_ADD_FLAG_STRICT_ACLS) { + default: + /* Permission denied in STRICT_ACLS mode, or + * unknown error. */ + goto out; + } + if (requestedInformation & SACL_SECURITY_INFORMATION) { + /* Try again without the SACL. */ + ctx->num_get_sacl_priv_notheld++; + requestedInformation &= ~(SACL_SECURITY_INFORMATION | + LABEL_SECURITY_INFORMATION | + BACKUP_SECURITY_INFORMATION); + break; + } + /* Fake success (useful when capturing as + * non-Administrator). */ + ctx->num_get_sd_access_denied++; + status = STATUS_SUCCESS; + goto out; } } - if (add_flags & WIMLIB_ADD_FLAG_STRICT_ACLS) - goto fail; - - switch (err) { - case ERROR_PRIVILEGE_NOT_HELD: - if (requestedInformation & SACL_SECURITY_INFORMATION) { - n = state->num_get_sacl_priv_notheld++; - requestedInformation &= ~SACL_SECURITY_INFORMATION; - if (n < MAX_GET_SACL_PRIV_NOTHELD_WARNINGS) { - WARNING( -"We don't have enough privileges to read the full security\n" -" descriptor of \"%ls\"!\n" -" Re-trying with SACL omitted.\n", path); - } else if (n == MAX_GET_SACL_PRIV_NOTHELD_WARNINGS) { - WARNING( -"Suppressing further privileges not held error messages when reading\n" -" security descriptors."); - } - goto again; - } - /* Fall through */ - case ERROR_ACCESS_DENIED: - n = state->num_get_sd_access_denied++; - if (n < MAX_GET_SD_ACCESS_DENIED_WARNINGS) { - WARNING("Failed to read security descriptor of \"%ls\": " - "Access denied!\n%ls", path, capture_access_denied_msg); - } else if (n == MAX_GET_SD_ACCESS_DENIED_WARNINGS) { - WARNING("Suppressing further access denied errors messages i" - "when reading security descriptors"); - } - return 0; - default: -fail: - ERROR("Failed to read security descriptor of \"%ls\"", path); - win32_error(err); - return WIMLIB_ERR_READ; + /* Add the security descriptor to the WIM image, and save its ID in + * file's inode. */ + inode->i_security_id = sd_set_add_sd(ctx->params->sd_set, buf, len_needed); + if (unlikely(inode->i_security_id < 0)) + status = STATUS_NO_MEMORY; +out: + if (unlikely(buf != _buf)) + FREE(buf); + if (!NT_SUCCESS(status)) { + winnt_error(status, L"\"%ls\": Can't read security descriptor", + printable_path(full_path)); + return WIMLIB_ERR_STAT; } + return 0; } static int -win32_build_dentry_tree_recursive(struct wim_dentry **root_ret, - wchar_t *path, - size_t path_num_chars, - struct add_image_params *params, - struct win32_capture_state *state, - unsigned vol_flags); - -/* Reads the directory entries of directory using a Win32 API and recursively - * calls win32_build_dentry_tree() on them. */ +winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret, + HANDLE cur_dir, + wchar_t *full_path, + size_t full_path_nchars, + wchar_t *relative_path, + size_t relative_path_nchars, + const wchar_t *filename, + struct winnt_scan_ctx *ctx); + static int -win32_recurse_directory(struct wim_dentry *root, - wchar_t *dir_path, - size_t dir_path_num_chars, - struct add_image_params *params, - struct win32_capture_state *state, - unsigned vol_flags) +winnt_recurse_directory(HANDLE h, + wchar_t *full_path, + size_t full_path_nchars, + struct wim_dentry *parent, + struct winnt_scan_ctx *ctx) { - WIN32_FIND_DATAW dat; - HANDLE hFind; - DWORD err; + void *buf; + const size_t bufsize = 8192; + IO_STATUS_BLOCK iosb; + NTSTATUS status; int ret; - DEBUG("Recurse to directory \"%ls\"", dir_path); - - /* Begin reading the directory by calling FindFirstFileW. Unlike UNIX - * opendir(), FindFirstFileW has file globbing built into it. But this - * isn't what we actually want, so just add a dummy glob to get all - * entries. */ - dir_path[dir_path_num_chars] = OS_PREFERRED_PATH_SEPARATOR; - dir_path[dir_path_num_chars + 1] = L'*'; - dir_path[dir_path_num_chars + 2] = L'\0'; - hFind = FindFirstFileW(dir_path, &dat); - dir_path[dir_path_num_chars] = L'\0'; - - if (hFind == INVALID_HANDLE_VALUE) { - err = GetLastError(); - if (err == ERROR_FILE_NOT_FOUND) { - return 0; - } else { - ERROR("Failed to read directory \"%ls\"", dir_path); - win32_error(err); - return WIMLIB_ERR_READ; + 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, + &iosb, buf, bufsize, + FileNamesInformation, + FALSE, NULL, FALSE))) + { + const FILE_NAMES_INFORMATION *info = buf; + for (;;) { + 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; + /* 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 = winnt_build_dentry_tree_recursive( + &child, + h, + full_path, + p - full_path, + filename, + info->FileNameLength / 2, + filename, + ctx); + + full_path[full_path_nchars] = L'\0'; + + if (ret) + goto out_free_buf; + attach_scanned_tree(parent, child, + ctx->params->blob_table); + } + if (info->NextEntryOffset == 0) + break; + info = (const FILE_NAMES_INFORMATION *) + ((const u8 *)info + info->NextEntryOffset); } } - ret = 0; - do { - /* Skip . and .. entries */ - if (dat.cFileName[0] == L'.' && - (dat.cFileName[1] == L'\0' || - (dat.cFileName[1] == L'.' && - dat.cFileName[2] == L'\0'))) - continue; - size_t filename_len = wcslen(dat.cFileName); - - dir_path[dir_path_num_chars] = OS_PREFERRED_PATH_SEPARATOR; - wmemcpy(dir_path + dir_path_num_chars + 1, - dat.cFileName, - filename_len + 1); - - struct wim_dentry *child; - size_t path_len = dir_path_num_chars + 1 + filename_len; - ret = win32_build_dentry_tree_recursive(&child, - dir_path, - path_len, - params, - state, - vol_flags); - dir_path[dir_path_num_chars] = L'\0'; - if (ret) - goto out_find_close; - if (child) - dentry_add_child(root, child); - } while (FindNextFileW(hFind, &dat)); - err = GetLastError(); - if (err != ERROR_NO_MORE_FILES) { - ERROR("Failed to read directory \"%ls\"", dir_path); - win32_error(err); - if (ret == 0) - ret = WIMLIB_ERR_READ; + + 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_find_close: - FindClose(hFind); +out_free_buf: + 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; + + 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); - 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; + 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) +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) { - 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); - WARNING("Ignoring %ls pointing out of capture directory:\n" - " \"%ls\" -> \"%ls\"\n" - " (Use --norpfix to capture all symbolic links " - "and junction points as-is)", - (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK) ? - L"absolute symbolic link" : L"junction point", - path, print_name0); - } - 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 = 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. - * - * @hFile: Open handle to the reparse point. - * @path: Path to the reparse point. Used for error messages only. - * @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 hFile, 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 truly 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; + } - DEBUG("Loading reparse data from \"%ls\"", path); - if (!DeviceIoControl(hFile, 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)) + if (!DeviceIoControl(h, FSCTL_GET_REPARSE_POINT, + NULL, 0, &rpbuf, REPARSE_POINT_MAX_SIZE, + &bytes_returned, NULL)) { - DWORD err = GetLastError(); - ERROR("Failed to get reparse data of \"%ls\"", path); - win32_error(err); - 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) { - ERROR("Reparse data on \"%ls\" is invalid", path); - 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); - } 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 -win32_tally_encrypted_size_cb(unsigned char *_data, void *_ctx, +win32_tally_encrypted_size_cb(unsigned char *_data, void *_size_ret, unsigned long len) { - *(u64*)_ctx += len; + *(u64*)_size_ret += len; return ERROR_SUCCESS; } 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; - *size_ret = 0; - err = OpenEncryptedFileRawW(path, 0, &file_ctx); + if (is_dir) + flags |= CREATE_FOR_DIR; + + err = OpenEncryptedFileRaw(path, flags, &file_ctx); if (err != ERROR_SUCCESS) { - ERROR("Failed to open encrypted file \"%ls\" for raw read", path); - win32_error(err); + 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) { - ERROR("Failed to read raw encrypted data from \"%ls\"", path); - win32_error(err); + win32_error(err, + L"Failed to read raw encrypted data from \"%ls\"", + printable_path(path)); ret = WIMLIB_ERR_READ; } else { ret = 0; @@ -667,347 +1049,555 @@ win32_get_encrypted_file_size(const wchar_t *path, u64 *size_ret) return ret; } -/* Scans an unnamed or named stream of a Win32 file (not a reparse point - * stream); calculates its SHA1 message digest and either creates a `struct - * wim_lookup_table_entry' in memory for it, or uses an existing 'struct - * wim_lookup_table_entry' for an identical stream. - * - * @path: Path to the file (UTF-16LE). - * - * @path_num_chars: Number of 2-byte characters in @path. - * - * @inode: WIM inode to save the stream into. - * - * @lookup_table: Stream lookup table for the WIM. - * - * @dat: A `WIN32_FIND_STREAM_DATA' structure that specifies the - * stream name. - * - * Returns 0 on success; nonzero on failure. - */ static int -win32_capture_stream(const wchar_t *path, - size_t path_num_chars, - struct wim_inode *inode, - struct wim_lookup_table *lookup_table, - WIN32_FIND_STREAM_DATA *dat) +winnt_scan_efsrpc_raw_data(struct wim_inode *inode, + wchar_t *path, size_t path_nchars, + struct winnt_scan_ctx *ctx) { - struct wim_ads_entry *ads_entry; - struct wim_lookup_table_entry *lte; + const bool is_dir = (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY); + struct windows_file *windows_file; + u64 size; int ret; - wchar_t *stream_name, *colon; - size_t stream_name_nchars; - bool is_named_stream; - wchar_t *spath; - size_t spath_nchars; - size_t spath_buf_nbytes; - const wchar_t *relpath_prefix; - const wchar_t *colonchar; - - DEBUG("Capture \"%ls\" stream \"%ls\"", path, dat->cStreamName); - - /* The stream name should be returned as :NAME:TYPE */ - stream_name = dat->cStreamName; - if (*stream_name != L':') - goto out_invalid_stream_name; - stream_name += 1; - colon = wcschr(stream_name, L':'); - if (colon == NULL) - goto out_invalid_stream_name; - - if (wcscmp(colon + 1, L"$DATA")) { - /* Not a DATA stream */ - ret = 0; + + /* OpenEncryptedFileRaw() expects a Win32 name. */ + wimlib_assert(!wmemcmp(path, L"\\??\\", 4)); + path[1] = L'\\'; + + ret = win32_get_encrypted_file_size(path, is_dir, &size); + if (ret) goto out; - } - *colon = '\0'; + /* Empty EFSRPC data does not make sense */ + wimlib_assert(size != 0); - stream_name_nchars = colon - stream_name; - is_named_stream = (stream_name_nchars != 0); + windows_file = alloc_windows_file(path, path_nchars, NULL, 0, + ctx->snapshot, true); + ret = add_stream(inode, windows_file, size, STREAM_TYPE_EFSRPC_RAW_DATA, + NO_STREAM_NAME, ctx->params->unhashed_blobs); +out: + path[1] = L'?'; + return ret; +} - if (is_named_stream) { - /* Allocate an ADS entry for the named stream. */ - ads_entry = inode_add_ads_utf16le(inode, stream_name, - stream_name_nchars * sizeof(wchar_t)); - if (!ads_entry) { - ret = WIMLIB_ERR_NOMEM; - goto out; - } - } +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) +{ + const wchar_t *sep, *type, *end; - /* If zero length stream, no lookup table entry needed. */ - if ((u64)dat->StreamSize.QuadPart == 0) { - ret = 0; - goto out; - } + /* The stream name should be returned as :NAME:TYPE */ + if (raw_stream_name_nchars < 1) + return false; + if (raw_stream_name[0] != L':') + return false; - /* Create a UTF-16LE string @spath that gives the filename, then a - * colon, then the stream name. Or, if it's an unnamed stream, just the - * filename. It is MALLOC()'ed so that it can be saved in the - * wim_lookup_table_entry if needed. - * - * As yet another special case, relative paths need to be changed to - * begin with an explicit "./" so that, for example, a file t:ads, where - * :ads is the part we added, is not interpreted as a file on the t: - * drive. */ - spath_nchars = path_num_chars; - relpath_prefix = L""; - colonchar = L""; - if (is_named_stream) { - spath_nchars += 1 + stream_name_nchars; - colonchar = L":"; - if (path_num_chars == 1 && !is_any_path_separator(path[0])) { - spath_nchars += 2; - static const wchar_t _relpath_prefix[] = - {L'.', OS_PREFERRED_PATH_SEPARATOR, L'\0'}; - relpath_prefix = _relpath_prefix; - } - } + raw_stream_name++; + raw_stream_name_nchars--; - spath_buf_nbytes = (spath_nchars + 1) * sizeof(wchar_t); - spath = MALLOC(spath_buf_nbytes); + end = raw_stream_name + raw_stream_name_nchars; - swprintf(spath, L"%ls%ls%ls%ls", - relpath_prefix, path, colonchar, stream_name); + sep = wmemchr(raw_stream_name, L':', raw_stream_name_nchars); + if (!sep) + return false; - /* Make a new wim_lookup_table_entry */ - lte = new_lookup_table_entry(); - if (!lte) { - ret = WIMLIB_ERR_NOMEM; - goto out_free_spath; - } - lte->file_on_disk = spath; - spath = NULL; - if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED && !is_named_stream) { - u64 encrypted_size; - lte->resource_location = RESOURCE_WIN32_ENCRYPTED; - ret = win32_get_encrypted_file_size(path, &encrypted_size); - if (ret) - goto out_free_spath; - lte->resource_entry.original_size = encrypted_size; - } else { - lte->resource_location = RESOURCE_IN_FILE_ON_DISK; - lte->resource_entry.original_size = (u64)dat->StreamSize.QuadPart; - } + type = sep + 1; + if (end - type != 5) + return false; - u32 stream_id; - if (is_named_stream) { - stream_id = ads_entry->stream_id; - ads_entry->lte = lte; - } else { - stream_id = 0; - inode->i_lte = lte; - } - lookup_table_insert_unhashed(lookup_table, lte, inode, stream_id); - ret = 0; -out_free_spath: - FREE(spath); -out: - return ret; -out_invalid_stream_name: - ERROR("Invalid stream name: \"%ls:%ls\"", path, dat->cStreamName); - ret = WIMLIB_ERR_READ; - goto out; + if (wmemcmp(type, L"$DATA", 5)) + return false; + + *stream_name_ret = raw_stream_name; + *stream_name_nchars_ret = sep - raw_stream_name; + return true; } -/* Scans a Win32 file for unnamed and named data streams (not reparse point - * streams). - * - * @path: Path to the file (UTF-16LE). - * - * @path_num_chars: Number of 2-byte characters in @path. - * - * @inode: WIM inode to save the stream into. - * - * @lookup_table: Stream lookup table for the WIM. - * - * @file_size: Size of unnamed data stream. (Used only if alternate - * data streams API appears to be unavailable.) +static int +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 winnt_scan_ctx *ctx) +{ + wchar_t *stream_name; + size_t stream_name_nchars; + struct windows_file *windows_file; + + /* Given the raw stream name (which is something like + * :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, + (const wchar_t **)&stream_name, + &stream_name_nchars)) + return 0; + + stream_name[stream_name_nchars] = L'\0'; + + windows_file = alloc_windows_file(path, path_nchars, + stream_name, stream_name_nchars, + ctx->snapshot, false); + return add_stream(inode, windows_file, stream_size, STREAM_TYPE_DATA, + stream_name, ctx->params->unhashed_blobs); +} + +/* + * Load information about the data streams of an open file into a WIM inode. * - * @vol_flags: Flags that specify features of the volume being - * captured. + * We use the NtQueryInformationFile() system call instead of FindFirstStream() + * and FindNextStream(). This is done for two reasons: * - * Returns 0 on success; nonzero on failure. + * - FindFirstStream() opens its own handle to the file or directory and + * apparently does so without specifying FILE_FLAG_BACKUP_SEMANTICS, thereby + * causing access denied errors on certain files (even when running as the + * Administrator). + * - FindFirstStream() and FindNextStream() is only available on Windows Vista + * and later, whereas the stream support in NtQueryInformationFile() was + * already present in Windows XP. */ -static int -win32_capture_streams(const wchar_t *path, - size_t path_num_chars, - struct wim_inode *inode, - struct wim_lookup_table *lookup_table, - u64 file_size, - unsigned 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, u64 file_size, + struct winnt_scan_ctx *ctx) { - WIN32_FIND_STREAM_DATA dat; int ret; - HANDLE hFind; - DWORD err; + u8 _buf[4096] _aligned_attribute(8); + u8 *buf; + size_t bufsize; + IO_STATUS_BLOCK iosb; + NTSTATUS status; + FILE_STREAM_INFORMATION *info; - DEBUG("Capturing streams from \"%ls\"", path); + buf = _buf; + bufsize = sizeof(_buf); - if (win32func_FindFirstStreamW == NULL || - !(vol_flags & FILE_NAMED_STREAMS)) + if (!(ctx->vol_flags & FILE_NAMED_STREAMS)) goto unnamed_only; - hFind = win32func_FindFirstStreamW(path, FindStreamInfoStandard, &dat, 0); - if (hFind == INVALID_HANDLE_VALUE) { - err = GetLastError(); - if (err == ERROR_CALL_NOT_IMPLEMENTED) - goto unnamed_only; + /* Get a buffer containing the stream information. */ + while (!NT_SUCCESS(status = (*func_NtQueryInformationFile)(h, + &iosb, + buf, + bufsize, + FileStreamInformation))) + { - /* Seems legal for this to return ERROR_HANDLE_EOF on reparse - * points and directories */ - if ((inode->i_attributes & - (FILE_ATTRIBUTE_REPARSE_POINT | FILE_ATTRIBUTE_DIRECTORY)) - && err == ERROR_HANDLE_EOF) - { - DEBUG("ERROR_HANDLE_EOF (ok)"); - return 0; - } else { - if (err == ERROR_ACCESS_DENIED) { - WARNING("Failed to look up data streams " - "of \"%ls\": Access denied!\n%ls", - path, capture_access_denied_msg); - return 0; - } else { - ERROR("Failed to look up data streams " - "of \"%ls\"", path); - win32_error(err); - return WIMLIB_ERR_READ; + switch (status) { + case STATUS_BUFFER_OVERFLOW: + { + u8 *newbuf; + + bufsize *= 2; + if (buf == _buf) + newbuf = MALLOC(bufsize); + else + newbuf = REALLOC(buf, bufsize); + if (!newbuf) { + ret = WIMLIB_ERR_NOMEM; + goto out_free_buf; + } + buf = newbuf; } + break; + case STATUS_NOT_IMPLEMENTED: + case STATUS_NOT_SUPPORTED: + case STATUS_INVALID_INFO_CLASS: + goto unnamed_only; + default: + winnt_error(status, + L"\"%ls\": Failed to query stream information", + printable_path(path)); + ret = WIMLIB_ERR_READ; + goto out_free_buf; } } - do { - ret = win32_capture_stream(path, - path_num_chars, - inode, lookup_table, - &dat); + + if (iosb.Information == 0) { + /* No stream information. */ + ret = 0; + goto out_free_buf; + } + + /* Parse one or more stream information structures. */ + info = (FILE_STREAM_INFORMATION *)buf; + for (;;) { + /* Load the stream information. */ + ret = winnt_scan_data_stream(path, path_nchars, + info->StreamName, + info->StreamNameLength / 2, + info->StreamSize.QuadPart, + inode, ctx); if (ret) - goto out_find_close; - } while (win32func_FindNextStreamW(hFind, &dat)); - err = GetLastError(); - if (err != ERROR_HANDLE_EOF) { - ERROR("Win32 API: Error reading data streams from \"%ls\"", path); - win32_error(err); - ret = WIMLIB_ERR_READ; + goto out_free_buf; + + if (info->NextEntryOffset == 0) { + /* No more stream information. */ + break; + } + /* Advance to next stream information. */ + info = (FILE_STREAM_INFORMATION *) + ((u8 *)info + info->NextEntryOffset); } -out_find_close: - FindClose(hFind); - return ret; + ret = 0; + goto out_free_buf; + unnamed_only: - /* FindFirstStreamW() API is not available, or the volume does not - * support named streams. Only capture the unnamed data stream. */ - DEBUG("Only capturing unnamed data stream"); - if (inode->i_attributes & - (FILE_ATTRIBUTE_REPARSE_POINT | FILE_ATTRIBUTE_DIRECTORY)) + /* The volume does not support named streams. Only capture the unnamed + * data stream. */ + if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY | + FILE_ATTRIBUTE_REPARSE_POINT)) { ret = 0; - } else { - /* Just create our own WIN32_FIND_STREAM_DATA for an unnamed - * stream to reduce the code to a call to the - * already-implemented win32_capture_stream() */ - wcscpy(dat.cStreamName, L"::$DATA"); - dat.StreamSize.QuadPart = file_size; - ret = win32_capture_stream(path, - path_num_chars, - inode, lookup_table, - &dat); + goto out_free_buf; + } + + { + wchar_t stream_name[] = L"::$DATA"; + ret = winnt_scan_data_stream(path, path_nchars, stream_name, 7, + file_size, inode, ctx); } +out_free_buf: + /* Free buffer if allocated on heap. */ + if (unlikely(buf != _buf)) + FREE(buf); return ret; } -static int -win32_build_dentry_tree_recursive(struct wim_dentry **root_ret, - wchar_t *path, - size_t path_num_chars, - struct add_image_params *params, - struct win32_capture_state *state, - unsigned vol_flags) +static u64 +extract_starting_lcn(const RETRIEVAL_POINTERS_BUFFER *extents) { - struct wim_dentry *root = NULL; - struct wim_inode *inode; - DWORD err; - u64 file_size; + if (extents->ExtentCount < 1) + return 0; + + return extents->Extents[0].Lcn.QuadPart; +} + +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; + + return extract_starting_lcn(&out); +} + +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_WINDOWS_FILE) + blob->windows_file->sort_key = sort_key; + } +} + +static inline bool +should_try_to_use_wimboot_hash(const struct wim_inode *inode, + const struct winnt_scan_ctx *ctx, + const struct capture_params *params) +{ + /* Directories and encrypted files aren't valid for external backing. */ + if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY | + FILE_ATTRIBUTE_ENCRYPTED)) + return false; + + /* If the file is a reparse point, then try the hash fixup if it's a WOF + * reparse point and we're in WIMBOOT mode. Otherwise, try the hash + * fixup if WOF may be attached. */ + if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) + return (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_WOF) && + (params->add_flags & WIMLIB_ADD_FLAG_WIMBOOT); + return !ctx->wof_not_attached; +} + +/* + * This function implements an optimization for capturing files from a + * filesystem with a backing WIM(s). If a file is WIM-backed, then we can + * retrieve the SHA-1 message digest of its original contents from its reparse + * point. This may eliminate the need to read the file's data and/or allow the + * file's data to be immediately deduplicated with existing data in the WIM. + * + * If WOF is attached, then this function is merely an optimization, but + * potentially a very effective one. If WOF is detached, then this function + * really causes WIM-backed files to be, effectively, automatically + * "dereferenced" when possible; the unnamed data stream is updated to reference + * the original contents and the reparse point is removed. + * + * This function returns 0 if the fixup succeeded or was intentionally not + * executed. Otherwise it returns an error code. + */ +static noinline_for_stack int +try_to_use_wimboot_hash(HANDLE h, struct wim_inode *inode, + struct winnt_scan_ctx *ctx, const wchar_t *full_path) +{ + struct blob_table *blob_table = ctx->params->blob_table; + struct wim_inode_stream *reparse_strm = NULL; + struct wim_inode_stream *strm; + struct blob_descriptor *blob; + u8 hash[SHA1_HASH_SIZE]; int ret; - u8 *rpbuf; - u16 rpbuflen; - u16 not_rpfixed; - if (exclude_path(path, path_num_chars, params->config, true)) { - if (params->add_flags & WIMLIB_ADD_FLAG_ROOT) { - ERROR("Cannot exclude the root directory from capture"); - ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG; - goto out; + if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) { + struct reparse_buffer_disk rpbuf; + struct { + struct wof_external_info wof_info; + struct wim_provider_rpdata wim_info; + } *rpdata = (void *)rpbuf.rpdata; + struct blob_descriptor *reparse_blob; + + /* The file has a WOF reparse point, so WOF must be detached. + * We can read the reparse point directly. */ + ctx->wof_not_attached = true; + reparse_strm = inode_get_unnamed_stream(inode, STREAM_TYPE_REPARSE_POINT); + reparse_blob = stream_blob_resolved(reparse_strm); + + if (!reparse_blob || reparse_blob->size < sizeof(*rpdata)) + return 0; /* Not a WIM-backed file */ + + ret = read_blob_into_buf(reparse_blob, rpdata); + if (ret) + return ret; + + if (rpdata->wof_info.version != WOF_CURRENT_VERSION || + rpdata->wof_info.provider != WOF_PROVIDER_WIM || + rpdata->wim_info.version != 2) + return 0; /* Not a WIM-backed file */ + + /* Okay, this is a WIM backed file. Get its SHA-1 hash. */ + copy_hash(hash, rpdata->wim_info.unnamed_data_stream_hash); + } else { + struct { + struct wof_external_info wof_info; + struct wim_provider_external_info wim_info; + } out; + IO_STATUS_BLOCK iosb; + NTSTATUS status; + + /* WOF may be attached. Try reading this file's external + * backing info. */ + status = (*func_NtFsControlFile)(h, NULL, NULL, NULL, &iosb, + FSCTL_GET_EXTERNAL_BACKING, + NULL, 0, &out, sizeof(out)); + + /* Is WOF not attached? */ + if (status == STATUS_INVALID_DEVICE_REQUEST || + status == STATUS_NOT_SUPPORTED) { + ctx->wof_not_attached = true; + return 0; } - if ((params->add_flags & WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE) - && params->progress_func) - { - union wimlib_progress_info info; - info.scan.cur_path = path; - info.scan.status = WIMLIB_SCAN_DENTRY_EXCLUDED; - params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info); + + /* Is this file not externally backed? */ + if (status == STATUS_OBJECT_NOT_EXTERNALLY_BACKED) + return 0; + + /* Does this file have an unknown type of external backing that + * needed a larger information buffer? */ + if (status == STATUS_BUFFER_TOO_SMALL) + return 0; + + /* Was there some other failure? */ + if (status != STATUS_SUCCESS) { + winnt_error(status, + L"\"%ls\": FSCTL_GET_EXTERNAL_BACKING failed", + full_path); + return WIMLIB_ERR_STAT; } - ret = 0; - goto out; + + /* Is this file backed by a WIM? */ + if (out.wof_info.version != WOF_CURRENT_VERSION || + out.wof_info.provider != WOF_PROVIDER_WIM || + out.wim_info.version != WIM_PROVIDER_CURRENT_VERSION) + return 0; + + /* Okay, this is a WIM backed file. Get its SHA-1 hash. */ + copy_hash(hash, out.wim_info.unnamed_data_stream_hash); } -#if 0 - if (path_num_chars >= 4 && - !wmemcmp(path, L"\\\\?\\", 4) && - path_num_chars + 1 - 4 > MAX_PATH && - state->num_long_path_warnings < MAX_CAPTURE_LONG_PATH_WARNINGS) - { - WARNING("Path \"%ls\" exceeds MAX_PATH", path); - if (++state->num_long_path_warnings == MAX_CAPTURE_LONG_PATH_WARNINGS) - WARNING("Suppressing further warnings about long paths."); + /* If the file's unnamed data stream is nonempty, then fill in its hash + * and deduplicate it if possible. + * + * With WOF detached, we require that the blob *must* de-duplicable for + * any action can be taken, since without WOF we can't fall back to + * getting the "dereferenced" data by reading the stream (the real + * stream is sparse and contains all zeroes). */ + strm = inode_get_unnamed_data_stream(inode); + if (strm && (blob = stream_blob_resolved(strm))) { + struct blob_descriptor **back_ptr; + + if (reparse_strm && !lookup_blob(blob_table, hash)) + return 0; + back_ptr = retrieve_pointer_to_unhashed_blob(blob); + copy_hash(blob->hash, hash); + if (after_blob_hashed(blob, back_ptr, blob_table) != blob) + free_blob_descriptor(blob); } -#endif - if ((params->add_flags & WIMLIB_ADD_FLAG_VERBOSE) - && params->progress_func) + /* Remove the reparse point, if present. */ + if (reparse_strm) { + inode_remove_stream(inode, reparse_strm, blob_table); + inode->i_attributes &= ~(FILE_ATTRIBUTE_REPARSE_POINT | + FILE_ATTRIBUTE_SPARSE_FILE); + if (inode->i_attributes == 0) + inode->i_attributes = FILE_ATTRIBUTE_NORMAL; + } + + return 0; +} + +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 void +get_volume_information(HANDLE h, const wchar_t *full_path, + struct winnt_scan_ctx *ctx) +{ + u8 _attr_info[sizeof(FILE_FS_ATTRIBUTE_INFORMATION) + 128] _aligned_attribute(8); + FILE_FS_ATTRIBUTE_INFORMATION *attr_info = (void *)_attr_info; + FILE_FS_VOLUME_INFORMATION vol_info; + struct file_info file_info; + IO_STATUS_BLOCK iosb; + NTSTATUS status; + + /* Get volume flags */ + status = (*func_NtQueryVolumeInformationFile)(h, &iosb, attr_info, + sizeof(_attr_info), + FileFsAttributeInformation); + if (NT_SUCCESS(status)) { + ctx->vol_flags = attr_info->FileSystemAttributes; + ctx->is_ntfs = (attr_info->FileSystemNameLength == 4 * sizeof(wchar_t)) && + !wmemcmp(attr_info->FileSystemName, L"NTFS", 4); + } else { + winnt_warning(status, L"\"%ls\": Can't get volume attributes", + printable_path(full_path)); + } + + /* 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))) { - union wimlib_progress_info info; - info.scan.cur_path = path; - info.scan.status = WIMLIB_SCAN_DENTRY_OK; - params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info); - } - - HANDLE hFile = win32_open_existing_file(path, - FILE_READ_DATA | FILE_READ_ATTRIBUTES); - if (hFile == INVALID_HANDLE_VALUE) { - err = GetLastError(); - ERROR("Win32 API: Failed to open \"%ls\"", path); - win32_error(err); - ret = WIMLIB_ERR_OPEN; - goto out; + ctx->params->capture_root_dev = vol_info.VolumeSerialNumber; + } else { + winnt_warning(status, L"\"%ls\": Can't get volume ID", + printable_path(full_path)); } - BY_HANDLE_FILE_INFORMATION file_info; - if (!GetFileInformationByHandle(hFile, &file_info)) { - err = GetLastError(); - ERROR("Win32 API: Failed to get file information for \"%ls\"", - path); - win32_error(err); - ret = WIMLIB_ERR_STAT; - goto out_close_handle; - } - - if (file_info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) { - rpbuf = alloca(REPARSE_POINT_MAX_SIZE); - ret = win32_get_reparse_data(hFile, path, params, - rpbuf, &rpbuflen); - if (ret < 0) { - /* WIMLIB_ERR_* (inverted) */ - ret = -ret; - goto out_close_handle; - } else if (ret & RP_FIXED) { - not_rpfixed = 0; - } else if (ret == RP_EXCLUDED) { + /* Get inode number. */ + status = get_file_info(h, &file_info); + if (NT_SUCCESS(status)) { + ctx->params->capture_root_ino = file_info.ino; + } else { + winnt_warning(status, L"\"%ls\": Can't get file information", + printable_path(full_path)); + } +} + +static int +winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret, + HANDLE cur_dir, + wchar_t *full_path, + size_t full_path_nchars, + wchar_t *relative_path, + size_t relative_path_nchars, + const wchar_t *filename, + struct winnt_scan_ctx *ctx) +{ + struct wim_dentry *root = NULL; + struct wim_inode *inode = NULL; + HANDLE h = NULL; + int ret; + NTSTATUS status; + struct file_info file_info; + u64 sort_key; + + ret = try_exclude(full_path, ctx->params); + if (unlikely(ret < 0)) /* Excluded? */ + goto out_progress; + if (unlikely(ret > 0)) /* Error? */ + goto out; + + /* Open the file with permission to read metadata. Although we will + * later need a handle with FILE_LIST_DIRECTORY permission (or, + * equivalently, FILE_READ_DATA; they're the same numeric value) if the + * file is a directory, it can significantly slow things down to request + * this permission on all nondirectories. Perhaps it causes Windows to + * start prefetching the file contents... */ + status = winnt_openat(cur_dir, relative_path, relative_path_nchars, + FILE_READ_ATTRIBUTES | READ_CONTROL | + ACCESS_SYSTEM_SECURITY, + &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_close_handle; - } else { - not_rpfixed = 1; + goto out; + } + if (status == STATUS_SHARING_VIOLATION) { + ERROR("Can't open \"%ls\":\n" + " File is in use by another process! " + "Consider using snapshot (VSS) mode.", + printable_path(full_path)); + ret = WIMLIB_ERR_OPEN; + goto out; } + 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)) { + winnt_error(status, L"\"%ls\": Can't get file information", + printable_path(full_path)); + ret = WIMLIB_ERR_STAT; + goto out; } /* Create a WIM dentry with an associated inode, which may be shared. @@ -1015,208 +1605,1256 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret, * 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. */ - ret = inode_table_new_dentry(¶ms->inode_table, - path_basename_with_len(path, path_num_chars), - ((u64)file_info.nFileIndexHigh << 32) | - (u64)file_info.nFileIndexLow, - file_info.dwVolumeSerialNumber, - (file_info.nNumberOfLinks <= 1 || - (file_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)), + * 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(ctx->params->inode_table, + filename, + file_info.ino, + ctx->params->capture_root_dev, + (file_info.num_links <= 1), &root); if (ret) - goto out_close_handle; + goto out; - ret = win32_get_short_name(root, path); - if (ret) - goto out_close_handle; + /* Get the short (DOS) name of the file. */ + status = winnt_get_short_name(h, root); - inode = root->d_inode; + /* 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; + } - if (inode->i_nlink > 1) /* Shared inode; nothing more to do */ - goto out_close_handle; + inode = root->d_inode; - inode->i_attributes = file_info.dwFileAttributes; - inode->i_creation_time = FILETIME_to_u64(&file_info.ftCreationTime); - inode->i_last_write_time = FILETIME_to_u64(&file_info.ftLastWriteTime); - inode->i_last_access_time = FILETIME_to_u64(&file_info.ftLastAccessTime); - inode->i_resolved = 1; + if (inode->i_nlink > 1) { + /* Shared inode (hard link); skip reading per-inode information. + */ + goto out_progress; + } - 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; - if (!(params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS) - && (vol_flags & FILE_PERSISTENT_ACLS)) + /* Get the file's security descriptor, unless we are capturing in + * NO_ACLS mode or the volume does not support security descriptors. */ + if (!(ctx->params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS) + && (ctx->vol_flags & FILE_PERSISTENT_ACLS)) { - ret = win32_get_security_descriptor(root, ¶ms->sd_set, - path, state, - params->add_flags); + ret = winnt_load_security_descriptor(h, inode, full_path, ctx); + 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, ctx->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, + full_path_nchars, ctx); + 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, + file_info.end_of_file, + ctx); if (ret) - goto out_close_handle; + goto out; } - file_size = ((u64)file_info.nFileSizeHigh << 32) | - (u64)file_info.nFileSizeLow; + if (unlikely(should_try_to_use_wimboot_hash(inode, ctx, ctx->params))) { + ret = try_to_use_wimboot_hash(h, inode, ctx, full_path); + if (ret) + goto out; + } - CloseHandle(hFile); + set_sort_key(inode, sort_key); - /* Capture the unnamed data stream (only should be present for regular - * files) and any alternate data streams. */ - ret = win32_capture_streams(path, - path_num_chars, - inode, - params->lookup_table, - file_size, - vol_flags); - if (ret) - goto out; + if (inode_is_directory(inode)) { - 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 */ - ret = win32_recurse_directory(root, - path, - path_num_chars, - params, - state, - vol_flags); + /* Directory: recurse to children. */ + + /* Re-open the directory with FILE_LIST_DIRECTORY access. */ + if (h) { + (*func_NtClose)(h); + h = NULL; + } + status = winnt_openat(cur_dir, relative_path, + relative_path_nchars, FILE_LIST_DIRECTORY, + &h); + if (!NT_SUCCESS(status)) { + winnt_error(status, L"\"%ls\": Can't open directory", + printable_path(full_path)); + ret = WIMLIB_ERR_OPEN; + goto out; + } + ret = winnt_recurse_directory(h, + full_path, + full_path_nchars, + root, + ctx); + if (ret) + goto out; } - goto out; -out_close_handle: - CloseHandle(hFile); -out: - if (ret == 0) - *root_ret = root; + +out_progress: + ctx->params->progress.scan.cur_path = full_path; + if (likely(root)) + ret = do_capture_progress(ctx->params, WIMLIB_SCAN_DENTRY_OK, inode); else - free_dentry_tree(root, params->lookup_table); + ret = do_capture_progress(ctx->params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL); +out: + if (likely(h)) + (*func_NtClose)(h); + if (unlikely(ret)) { + free_dentry_tree(root, ctx->params->blob_table); + root = NULL; + ret = report_capture_error(ctx->params, ret, full_path); + } + *root_ret = root; return ret; } static void -win32_do_capture_warnings(const struct win32_capture_state *state, - int add_flags) +winnt_do_scan_warnings(const wchar_t *path, const struct winnt_scan_ctx *ctx) { - if (state->num_get_sacl_priv_notheld == 0 && - state->num_get_sd_access_denied == 0) + if (likely(ctx->num_get_sacl_priv_notheld == 0 && + ctx->num_get_sd_access_denied == 0)) return; - WARNING(""); - WARNING("Built dentry tree successfully, but with the following problem(s):"); - if (state->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); - } - if (state->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); - } - WARNING( - "Try running the program as the Administrator to make sure all the\n" -" desired metadata has been captured exactly. However, if you\n" -" do not care about capturing security descriptors correctly, then\n" -" nothing more needs to be done%ls\n", - (add_flags & WIMLIB_ADD_FLAG_NO_ACLS) ? L"." : - L", although you might consider\n" -" using the --no-acls option to explicitly capture no security\n" -" descriptors.\n"); + WARNING("Scan of \"%ls\" complete, but with one or more warnings:", path); + if (ctx->num_get_sacl_priv_notheld != 0) { + WARNING("- Could not capture SACL (System Access Control List)\n" + " on %lu files or directories.", + ctx->num_get_sacl_priv_notheld); + } + if (ctx->num_get_sd_access_denied != 0) { + WARNING("- Could not capture security descriptor at all\n" + " on %lu files or directories.", + ctx->num_get_sd_access_denied); + } + WARNING("To fully capture all security descriptors, run the program\n" + " with Administrator rights."); } -#define WINDOWS_NT_MAX_PATH 32768 +/*----------------------------------------------------------------------------* + * Fast MFT scan implementation * + *----------------------------------------------------------------------------*/ + +#define ENABLE_FAST_MFT_SCAN 1 + +#ifdef ENABLE_FAST_MFT_SCAN + +typedef struct { + u64 StartingCluster; + u64 ClusterCount; +} CLUSTER_RANGE; + +typedef struct { + u64 StartingFileReferenceNumber; + u64 EndingFileReferenceNumber; +} FILE_REFERENCE_RANGE; + +/* The FSCTL_QUERY_FILE_LAYOUT ioctl. This ioctl can be used on Windows 8 and + * later to scan the MFT of an NTFS volume. */ +#define FSCTL_QUERY_FILE_LAYOUT CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 157, METHOD_NEITHER, FILE_ANY_ACCESS) + +/* The input to FSCTL_QUERY_FILE_LAYOUT */ +typedef struct { + u32 NumberOfPairs; +#define QUERY_FILE_LAYOUT_RESTART 0x00000001 +#define QUERY_FILE_LAYOUT_INCLUDE_NAMES 0x00000002 +#define QUERY_FILE_LAYOUT_INCLUDE_STREAMS 0x00000004 +#define QUERY_FILE_LAYOUT_INCLUDE_EXTENTS 0x00000008 +#define QUERY_FILE_LAYOUT_INCLUDE_EXTRA_INFO 0x00000010 +#define QUERY_FILE_LAYOUT_INCLUDE_STREAMS_WITH_NO_CLUSTERS_ALLOCATED 0x00000020 + u32 Flags; +#define QUERY_FILE_LAYOUT_FILTER_TYPE_NONE 0 +#define QUERY_FILE_LAYOUT_FILTER_TYPE_CLUSTERS 1 +#define QUERY_FILE_LAYOUT_FILTER_TYPE_FILEID 2 +#define QUERY_FILE_LAYOUT_NUM_FILTER_TYPES 3 + u32 FilterType; + u32 Reserved; + union { + CLUSTER_RANGE ClusterRanges[1]; + FILE_REFERENCE_RANGE FileReferenceRanges[1]; + } Filter; +} QUERY_FILE_LAYOUT_INPUT; + +/* The header of the buffer returned by FSCTL_QUERY_FILE_LAYOUT */ +typedef struct { + u32 FileEntryCount; + u32 FirstFileOffset; +#define QUERY_FILE_LAYOUT_SINGLE_INSTANCED 0x00000001 + u32 Flags; + u32 Reserved; +} QUERY_FILE_LAYOUT_OUTPUT; + +/* Inode information returned by FSCTL_QUERY_FILE_LAYOUT */ +typedef struct { + u32 Version; + u32 NextFileOffset; + u32 Flags; + u32 FileAttributes; + u64 FileReferenceNumber; + u32 FirstNameOffset; + u32 FirstStreamOffset; + u32 ExtraInfoOffset; + u32 Reserved; +} FILE_LAYOUT_ENTRY; + +/* Extra inode information returned by FSCTL_QUERY_FILE_LAYOUT */ +typedef struct { + struct { + u64 CreationTime; + u64 LastAccessTime; + u64 LastWriteTime; + u64 ChangeTime; + u32 FileAttributes; + } BasicInformation; + u32 OwnerId; + u32 SecurityId; + s64 Usn; +} FILE_LAYOUT_INFO_ENTRY; + +/* Filename (or dentry) information returned by FSCTL_QUERY_FILE_LAYOUT */ +typedef struct { + u32 NextNameOffset; +#define FILE_LAYOUT_NAME_ENTRY_PRIMARY 0x00000001 +#define FILE_LAYOUT_NAME_ENTRY_DOS 0x00000002 + u32 Flags; + u64 ParentFileReferenceNumber; + u32 FileNameLength; + u32 Reserved; + wchar_t FileName[1]; +} FILE_LAYOUT_NAME_ENTRY; + +/* Stream information returned by FSCTL_QUERY_FILE_LAYOUT */ +typedef struct { + u32 Version; + u32 NextStreamOffset; +#define STREAM_LAYOUT_ENTRY_IMMOVABLE 0x00000001 +#define STREAM_LAYOUT_ENTRY_PINNED 0x00000002 +#define STREAM_LAYOUT_ENTRY_RESIDENT 0x00000004 +#define STREAM_LAYOUT_ENTRY_NO_CLUSTERS_ALLOCATED 0x00000008 + u32 Flags; + u32 ExtentInformationOffset; + u64 AllocationSize; + u64 EndOfFile; + u64 Reserved; + u32 AttributeFlags; + u32 StreamIdentifierLength; + wchar_t StreamIdentifier[1]; +} STREAM_LAYOUT_ENTRY; + + +typedef struct { +#define STREAM_EXTENT_ENTRY_AS_RETRIEVAL_POINTERS 0x00000001 +#define STREAM_EXTENT_ENTRY_ALL_EXTENTS 0x00000002 + u32 Flags; + union { + RETRIEVAL_POINTERS_BUFFER RetrievalPointers; + } ExtentInformation; +} STREAM_EXTENT_ENTRY; + +/* Extract the MFT number part of the full inode number */ +#define NTFS_MFT_NO(ref) ((ref) & (((u64)1 << 48) - 1)) + +/* Is the file the root directory of the NTFS volume? The root directory always + * occupies MFT record 5. */ +#define NTFS_IS_ROOT_FILE(ino) (NTFS_MFT_NO(ino) == 5) + +/* Is the file a special NTFS file, other than the root directory? The special + * files are the first 16 records in the MFT. */ +#define NTFS_IS_SPECIAL_FILE(ino) \ + (NTFS_MFT_NO(ino) <= 15 && !NTFS_IS_ROOT_FILE(ino)) + +/* Intermediate inode structure. This is used to temporarily save information + * from FSCTL_QUERY_FILE_LAYOUT before creating the full 'struct wim_inode'. */ +struct ntfs_inode { + struct avl_tree_node index_node; + u64 ino; + u64 creation_time; + u64 last_access_time; + u64 last_write_time; + u64 starting_lcn; + u32 attributes; + u32 security_id; + u32 num_aliases; + u32 num_streams; + u32 first_stream_offset; + struct ntfs_dentry *first_child; + wchar_t short_name[13]; +}; -/* 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) +/* Intermediate dentry structure. This is used to temporarily save information + * from FSCTL_QUERY_FILE_LAYOUT before creating the full 'struct wim_dentry'. */ +struct ntfs_dentry { + u32 offset_from_inode : 31; + u32 is_primary : 1; + union { + /* Note: build_children_lists() replaces 'parent_ino' with + * 'next_child'. */ + u64 parent_ino; + struct ntfs_dentry *next_child; + }; + wchar_t name[0]; +}; + +/* Intermediate stream structure. This is used to temporarily save information + * from FSCTL_QUERY_FILE_LAYOUT before creating the full 'struct + * wim_inode_stream'. */ +struct ntfs_stream { + u64 size; + wchar_t name[0]; +}; + +/* Map of all known NTFS inodes, keyed by inode number */ +struct ntfs_inode_map { + struct avl_tree_node *root; +}; + +#define NTFS_INODE(node) \ + avl_tree_entry((node), struct ntfs_inode, index_node) + +#define SKIP_ALIGNED(p, size) ((void *)(p) + ALIGN((size), 8)) + +/* Get a pointer to the first dentry of the inode. */ +#define FIRST_DENTRY(ni) SKIP_ALIGNED((ni), sizeof(struct ntfs_inode)) + +/* Get a pointer to the first stream of the inode. */ +#define FIRST_STREAM(ni) ((const void *)ni + ni->first_stream_offset) + +/* Advance to the next dentry of the inode. */ +#define NEXT_DENTRY(nd) SKIP_ALIGNED((nd), sizeof(struct ntfs_dentry) + \ + (wcslen((nd)->name) + 1) * sizeof(wchar_t)) + +/* Advance to the next stream of the inode. */ +#define NEXT_STREAM(ns) SKIP_ALIGNED((ns), sizeof(struct ntfs_stream) + \ + (wcslen((ns)->name) + 1) * sizeof(wchar_t)) + +static int +_avl_cmp_ntfs_inodes(const struct avl_tree_node *node1, + const struct avl_tree_node *node2) +{ + return cmp_u64(NTFS_INODE(node1)->ino, NTFS_INODE(node2)->ino); +} + +/* Adds an NTFS inode to the map. */ +static void +ntfs_inode_map_add_inode(struct ntfs_inode_map *map, struct ntfs_inode *ni) +{ + if (avl_tree_insert(&map->root, &ni->index_node, _avl_cmp_ntfs_inodes)) { + WARNING("Inode 0x%016"PRIx64" is a duplicate!", ni->ino); + FREE(ni); + } +} + +/* Find an ntfs_inode in the map by inode number. Returns NULL if not found. */ +static struct ntfs_inode * +ntfs_inode_map_lookup(struct ntfs_inode_map *map, u64 ino) +{ + struct ntfs_inode tmp; + struct avl_tree_node *res; + + tmp.ino = ino; + res = avl_tree_lookup_node(map->root, &tmp.index_node, _avl_cmp_ntfs_inodes); + if (!res) + return NULL; + return NTFS_INODE(res); +} + +/* Remove an ntfs_inode from the map and free it. */ +static void +ntfs_inode_map_remove(struct ntfs_inode_map *map, struct ntfs_inode *ni) +{ + avl_tree_remove(&map->root, &ni->index_node); + FREE(ni); +} + +/* Free all ntfs_inodes in the map. */ +static void +ntfs_inode_map_destroy(struct ntfs_inode_map *map) +{ + struct ntfs_inode *ni; + + avl_tree_for_each_in_postorder(ni, map->root, struct ntfs_inode, index_node) + FREE(ni); +} + +static bool +file_has_streams(const FILE_LAYOUT_ENTRY *file) +{ + return (file->FirstStreamOffset != 0) && + !(file->FileAttributes & FILE_ATTRIBUTE_ENCRYPTED); +} + +static bool +is_valid_name_entry(const FILE_LAYOUT_NAME_ENTRY *name) +{ + return name->FileNameLength > 0 && + name->FileNameLength % 2 == 0 && + !wmemchr(name->FileName, L'\0', name->FileNameLength / 2) && + (!(name->Flags & FILE_LAYOUT_NAME_ENTRY_DOS) || + name->FileNameLength <= 24); +} + +/* Validate the FILE_LAYOUT_NAME_ENTRYs of the specified file and compute the + * total length in bytes of the ntfs_dentry structures needed to hold the name + * information. */ +static int +validate_names_and_compute_total_length(const FILE_LAYOUT_ENTRY *file, + size_t *total_length_ret) +{ + const FILE_LAYOUT_NAME_ENTRY *name = + (const void *)file + file->FirstNameOffset; + size_t total = 0; + size_t num_long_names = 0; + + for (;;) { + if (unlikely(!is_valid_name_entry(name))) { + ERROR("Invalid FILE_LAYOUT_NAME_ENTRY! " + "FileReferenceNumber=0x%016"PRIx64", " + "FileNameLength=%"PRIu32", " + "FileName=%.*ls, Flags=0x%08"PRIx32, + file->FileReferenceNumber, + name->FileNameLength, + (int)(name->FileNameLength / 2), + name->FileName, name->Flags); + return WIMLIB_ERR_UNSUPPORTED; + } + if (name->Flags != FILE_LAYOUT_NAME_ENTRY_DOS) { + num_long_names++; + total += ALIGN(sizeof(struct ntfs_dentry) + + name->FileNameLength + sizeof(wchar_t), + 8); + } + if (name->NextNameOffset == 0) + break; + name = (const void *)name + name->NextNameOffset; + } + + if (unlikely(num_long_names == 0)) { + ERROR("Inode 0x%016"PRIx64" has no long names!", + file->FileReferenceNumber); + return WIMLIB_ERR_UNSUPPORTED; + } + + *total_length_ret = total; + return 0; +} + +static bool +is_valid_stream_entry(const STREAM_LAYOUT_ENTRY *stream) +{ + return stream->StreamIdentifierLength % 2 == 0 && + !wmemchr(stream->StreamIdentifier , L'\0', + stream->StreamIdentifierLength / 2); +} + +/* + * If the specified STREAM_LAYOUT_ENTRY represents a DATA stream as opposed to + * some other type of NTFS stream such as a STANDARD_INFORMATION stream, return + * true and set *stream_name_ret and *stream_name_nchars_ret to specify just the + * stream name. For example, ":foo:$DATA" would become "foo" with length 3 + * characters. Otherwise return false. + */ +static bool +use_stream(const FILE_LAYOUT_ENTRY *file, const STREAM_LAYOUT_ENTRY *stream, + const wchar_t **stream_name_ret, size_t *stream_name_nchars_ret) +{ + const wchar_t *stream_name; + size_t stream_name_nchars; + + if (stream->StreamIdentifierLength == 0) { + /* The unnamed data stream may be given as an empty string + * rather than as "::$DATA". Handle it both ways. */ + stream_name = L""; + stream_name_nchars = 0; + } else if (!get_data_stream_name(stream->StreamIdentifier, + stream->StreamIdentifierLength / 2, + &stream_name, &stream_name_nchars)) + return false; + + /* Skip the unnamed data stream for directories. */ + if (stream_name_nchars == 0 && + (file->FileAttributes & FILE_ATTRIBUTE_DIRECTORY)) + return false; + + *stream_name_ret = stream_name; + *stream_name_nchars_ret = stream_name_nchars; + return true; +} + +/* Validate the STREAM_LAYOUT_ENTRYs of the specified file and compute the total + * length in bytes of the ntfs_stream structures needed to hold the stream + * information. */ +static int +validate_streams_and_compute_total_length(const FILE_LAYOUT_ENTRY *file, + size_t *total_length_ret) +{ + const STREAM_LAYOUT_ENTRY *stream = + (const void *)file + file->FirstStreamOffset; + size_t total = 0; + for (;;) { + const wchar_t *name; + size_t name_nchars; + + if (unlikely(!is_valid_stream_entry(stream))) { + WARNING("Invalid STREAM_LAYOUT_ENTRY! " + "FileReferenceNumber=0x%016"PRIx64", " + "StreamIdentifierLength=%"PRIu32", " + "StreamIdentifier=%.*ls", + file->FileReferenceNumber, + stream->StreamIdentifierLength, + (int)(stream->StreamIdentifierLength / 2), + stream->StreamIdentifier); + return WIMLIB_ERR_UNSUPPORTED; + } + + if (use_stream(file, stream, &name, &name_nchars)) { + total += ALIGN(sizeof(struct ntfs_stream) + + (name_nchars + 1) * sizeof(wchar_t), 8); + } + if (stream->NextStreamOffset == 0) + break; + stream = (const void *)stream + stream->NextStreamOffset; + } + + *total_length_ret = total; + return 0; +} + +static void * +load_name_information(const FILE_LAYOUT_ENTRY *file, struct ntfs_inode *ni, + void *p) +{ + const FILE_LAYOUT_NAME_ENTRY *name = + (const void *)file + file->FirstNameOffset; + for (;;) { + struct ntfs_dentry *nd = p; + /* Note that a name may be just a short (DOS) name, just a long + * name, or both a short name and a long name. If there is a + * short name, one name should also be marked as "primary" to + * indicate which long name the short name is associated with. + * Also, there should be at most one short name per inode. */ + if (name->Flags & FILE_LAYOUT_NAME_ENTRY_DOS) { + memcpy(ni->short_name, + name->FileName, name->FileNameLength); + ni->short_name[name->FileNameLength / 2] = L'\0'; + } + if (name->Flags != FILE_LAYOUT_NAME_ENTRY_DOS) { + ni->num_aliases++; + nd->offset_from_inode = (u8 *)nd - (u8 *)ni; + nd->is_primary = ((name->Flags & + FILE_LAYOUT_NAME_ENTRY_PRIMARY) != 0); + nd->parent_ino = name->ParentFileReferenceNumber; + memcpy(nd->name, name->FileName, name->FileNameLength); + nd->name[name->FileNameLength / 2] = L'\0'; + p += ALIGN(sizeof(struct ntfs_dentry) + + name->FileNameLength + sizeof(wchar_t), 8); + } + if (name->NextNameOffset == 0) + break; + name = (const void *)name + name->NextNameOffset; + } + return p; +} + +static u64 +load_starting_lcn(const STREAM_LAYOUT_ENTRY *stream) +{ + const STREAM_EXTENT_ENTRY *entry; + + if (stream->ExtentInformationOffset == 0) + return 0; + + entry = (const void *)stream + stream->ExtentInformationOffset; + + if (!(entry->Flags & STREAM_EXTENT_ENTRY_AS_RETRIEVAL_POINTERS)) + return 0; + + return extract_starting_lcn(&entry->ExtentInformation.RetrievalPointers); +} + +static void * +load_stream_information(const FILE_LAYOUT_ENTRY *file, struct ntfs_inode *ni, + void *p) +{ + const STREAM_LAYOUT_ENTRY *stream = + (const void *)file + file->FirstStreamOffset; + const u32 first_stream_offset = (const u8 *)p - (const u8 *)ni; + for (;;) { + struct ntfs_stream *ns = p; + const wchar_t *name; + size_t name_nchars; + + if (use_stream(file, stream, &name, &name_nchars)) { + ni->first_stream_offset = first_stream_offset; + ni->num_streams++; + if (name_nchars == 0) + ni->starting_lcn = load_starting_lcn(stream); + ns->size = stream->EndOfFile; + wmemcpy(ns->name, name, name_nchars); + ns->name[name_nchars] = L'\0'; + p += ALIGN(sizeof(struct ntfs_stream) + + (name_nchars + 1) * sizeof(wchar_t), 8); + } + if (stream->NextStreamOffset == 0) + break; + stream = (const void *)stream + stream->NextStreamOffset; + } + return p; +} + +/* Process the information for a file given by FSCTL_QUERY_FILE_LAYOUT. */ +static int +load_one_file(const FILE_LAYOUT_ENTRY *file, struct ntfs_inode_map *inode_map) +{ + const FILE_LAYOUT_INFO_ENTRY *info = + (const void *)file + file->ExtraInfoOffset; + size_t inode_size; + struct ntfs_inode *ni; + size_t n; + int ret; + void *p; + + inode_size = ALIGN(sizeof(struct ntfs_inode), 8); + + /* The root file should have no names, and all other files should have + * at least one name. But just in case, we ignore the names of the root + * file, and we ignore any non-root file with no names. */ + if (!NTFS_IS_ROOT_FILE(file->FileReferenceNumber)) { + if (file->FirstNameOffset == 0) + return 0; + ret = validate_names_and_compute_total_length(file, &n); + if (ret) + return ret; + inode_size += n; + } + + if (file_has_streams(file)) { + ret = validate_streams_and_compute_total_length(file, &n); + if (ret) + return ret; + inode_size += n; + } + + /* To save memory, we allocate the ntfs_dentry's and ntfs_stream's in + * the same memory block as their ntfs_inode. */ + ni = CALLOC(1, inode_size); + if (!ni) + return WIMLIB_ERR_NOMEM; + + ni->ino = file->FileReferenceNumber; + ni->attributes = info->BasicInformation.FileAttributes; + ni->creation_time = info->BasicInformation.CreationTime; + ni->last_write_time = info->BasicInformation.LastWriteTime; + ni->last_access_time = info->BasicInformation.LastAccessTime; + ni->security_id = info->SecurityId; + + p = FIRST_DENTRY(ni); + + if (!NTFS_IS_ROOT_FILE(file->FileReferenceNumber)) + p = load_name_information(file, ni, p); + + if (file_has_streams(file)) + p = load_stream_information(file, ni, p); + + wimlib_assert((u8 *)p - (u8 *)ni == inode_size); + + ntfs_inode_map_add_inode(inode_map, ni); + return 0; +} + +/* + * Quickly find all files on an NTFS volume by using FSCTL_QUERY_FILE_LAYOUT to + * scan the MFT. The NTFS volume is specified by the NT namespace path @path. + * For each file, allocate an 'ntfs_inode' structure for each file and add it to + * 'inode_map' keyed by inode number. Include NTFS special files such as + * $Bitmap (they will be removed later). + */ +static int +load_files_from_mft(const wchar_t *path, struct ntfs_inode_map *inode_map) { - size_t path_nchars; - wchar_t *path; + HANDLE h = NULL; + QUERY_FILE_LAYOUT_INPUT in = (QUERY_FILE_LAYOUT_INPUT) { + .NumberOfPairs = 0, + .Flags = QUERY_FILE_LAYOUT_RESTART | + QUERY_FILE_LAYOUT_INCLUDE_NAMES | + QUERY_FILE_LAYOUT_INCLUDE_STREAMS | + QUERY_FILE_LAYOUT_INCLUDE_EXTENTS | + QUERY_FILE_LAYOUT_INCLUDE_EXTRA_INFO | + QUERY_FILE_LAYOUT_INCLUDE_STREAMS_WITH_NO_CLUSTERS_ALLOCATED, + .FilterType = QUERY_FILE_LAYOUT_FILTER_TYPE_NONE, + }; + const size_t outsize = 32768; + QUERY_FILE_LAYOUT_OUTPUT *out = NULL; + DWORD bytes_returned; int ret; - struct win32_capture_state state; - unsigned vol_flags; - DWORD dret; - bool need_prefix_free = false; + DWORD err; + NTSTATUS status; - if (!win32func_FindFirstStreamW) { - WARNING("Running on Windows XP or earlier; " - "alternate data streams will not be captured."); + status = winnt_open(path, wcslen(path), + FILE_READ_DATA | FILE_READ_ATTRIBUTES, &h); + if (!NT_SUCCESS(status)) { + ret = -1; /* Silently try standard recursive scan instead */ + goto out; } - path_nchars = wcslen(root_disk_path); - if (path_nchars > WINDOWS_NT_MAX_PATH) - return WIMLIB_ERR_INVALID_PARAM; + out = MALLOC(outsize); + if (!out) { + ret = WIMLIB_ERR_NOMEM; + goto out; + } - if (GetFileAttributesW(root_disk_path) == INVALID_FILE_ATTRIBUTES && - GetLastError() == ERROR_FILE_NOT_FOUND) + while (DeviceIoControl(h, FSCTL_QUERY_FILE_LAYOUT, &in, sizeof(in), + out, outsize, &bytes_returned, NULL)) { - ERROR("Capture directory \"%ls\" does not exist!", - root_disk_path); - return WIMLIB_ERR_OPENDIR; + const FILE_LAYOUT_ENTRY *file = + (const void *)out + out->FirstFileOffset; + for (;;) { + ret = load_one_file(file, inode_map); + if (ret) + goto out; + if (file->NextFileOffset == 0) + break; + file = (const void *)file + file->NextFileOffset; + } + in.Flags &= ~QUERY_FILE_LAYOUT_RESTART; } - ret = win32_get_file_and_vol_ids(root_disk_path, - ¶ms->capture_root_ino, - ¶ms->capture_root_dev); + /* Normally, FSCTL_QUERY_FILE_LAYOUT fails with error code 38 after all + * files have been enumerated. */ + err = GetLastError(); + if (err != 38) { + if (err == ERROR_INVALID_FUNCTION || + err == ERROR_INVALID_PARAMETER) { + /* Silently try standard recursive scan instead */ + ret = -1; + } else { + win32_error(err, + L"Error enumerating files on volume \"%ls\"", + path); + /* Try standard recursive scan instead */ + ret = WIMLIB_ERR_UNSUPPORTED; + } + goto out; + } + ret = 0; +out: + FREE(out); + (*func_NtClose)(h); + return ret; +} + +/* Build the list of child dentries for each inode in @map. This is done by + * iterating through each name of each inode and adding it to its parent's + * children list. Note that every name should have a parent, i.e. should belong + * to some directory. The root directory does not have any names. */ +static int +build_children_lists(struct ntfs_inode_map *map, struct ntfs_inode **root_ret) +{ + struct ntfs_inode *ni; + + avl_tree_for_each_in_order(ni, map->root, struct ntfs_inode, index_node) + { + struct ntfs_dentry *nd; + u32 n; + + if (NTFS_IS_ROOT_FILE(ni->ino)) { + *root_ret = ni; + continue; + } + + n = ni->num_aliases; + nd = FIRST_DENTRY(ni); + for (;;) { + struct ntfs_inode *parent; + + parent = ntfs_inode_map_lookup(map, nd->parent_ino); + if (unlikely(!parent)) { + ERROR("Parent inode 0x%016"PRIx64" of" + "directory entry \"%ls\" (inode " + "0x%016"PRIx64") was missing from the " + "MFT listing!", + nd->parent_ino, nd->name, ni->ino); + return WIMLIB_ERR_UNSUPPORTED; + } + nd->next_child = parent->first_child; + parent->first_child = nd; + if (!--n) + break; + nd = NEXT_DENTRY(nd); + } + } + return 0; +} + +struct security_map_node { + struct avl_tree_node index_node; + u32 disk_security_id; + u32 wim_security_id; +}; + +/* Map from disk security IDs to WIM security IDs */ +struct security_map { + struct avl_tree_node *root; +}; + +#define SECURITY_MAP_NODE(node) \ + avl_tree_entry((node), struct security_map_node, index_node) + +static int +_avl_cmp_security_map_nodes(const struct avl_tree_node *node1, + const struct avl_tree_node *node2) +{ + return cmp_u32(SECURITY_MAP_NODE(node1)->disk_security_id, + SECURITY_MAP_NODE(node2)->disk_security_id); +} + +static s32 +security_map_lookup(struct security_map *map, u32 disk_security_id) +{ + struct security_map_node tmp; + const struct avl_tree_node *res; + + if (disk_security_id == 0) /* No on-disk security ID; uncacheable */ + return -1; + + tmp.disk_security_id = disk_security_id; + res = avl_tree_lookup_node(map->root, &tmp.index_node, + _avl_cmp_security_map_nodes); + if (!res) + return -1; + return SECURITY_MAP_NODE(res)->wim_security_id; +} + +static int +security_map_insert(struct security_map *map, u32 disk_security_id, + u32 wim_security_id) +{ + struct security_map_node *node; + + if (disk_security_id == 0) /* No on-disk security ID; uncacheable */ + return 0; + + node = MALLOC(sizeof(*node)); + if (!node) + return WIMLIB_ERR_NOMEM; + + node->disk_security_id = disk_security_id; + node->wim_security_id = wim_security_id; + avl_tree_insert(&map->root, &node->index_node, + _avl_cmp_security_map_nodes); + return 0; +} + +static void +security_map_destroy(struct security_map *map) +{ + struct security_map_node *node; + + avl_tree_for_each_in_postorder(node, map->root, + struct security_map_node, index_node) + FREE(node); +} + +/* + * Turn our temporary NTFS structures into the final WIM structures: + * + * ntfs_inode => wim_inode + * ntfs_dentry => wim_dentry + * ntfs_stream => wim_inode_stream + * + * This also handles things such as exclusions and issuing progress messages. + * It's similar to winnt_build_dentry_tree_recursive(), but this is much faster + * because almost all information we need is already loaded in memory in the + * ntfs_* structures. However, in some cases we still fall back to + * winnt_build_dentry_tree_recursive() and/or opening the file. + */ +static int +generate_wim_structures_recursive(struct wim_dentry **root_ret, + wchar_t *path, size_t path_nchars, + const wchar_t *filename, bool is_primary_name, + struct ntfs_inode *ni, + struct winnt_scan_ctx *ctx, + struct ntfs_inode_map *inode_map, + struct security_map *security_map) +{ + int ret = 0; + struct wim_dentry *root = NULL; + struct wim_inode *inode = NULL; + const struct ntfs_stream *ns; + + /* Completely ignore NTFS special files. */ + if (NTFS_IS_SPECIAL_FILE(ni->ino)) + goto out; + + /* Fall back to a recursive scan for unhandled cases. Reparse points, + * in particular, can't be properly handled here because a commonly used + * filter driver (WOF) hides reparse points from regular filesystem APIs + * but not from FSCTL_QUERY_FILE_LAYOUT. */ + if (ni->attributes & (FILE_ATTRIBUTE_REPARSE_POINT | + FILE_ATTRIBUTE_ENCRYPTED)) + { + ret = winnt_build_dentry_tree_recursive(&root, + NULL, + path, + path_nchars, + path, + path_nchars, + filename, + ctx); + goto out; + } + + /* Test for exclusion based on path. */ + ret = try_exclude(path, ctx->params); + if (unlikely(ret < 0)) /* Excluded? */ + goto out_progress; + if (unlikely(ret > 0)) /* Error? */ + goto out; + + /* Create the WIM dentry and possibly a new WIM inode */ + ret = inode_table_new_dentry(ctx->params->inode_table, filename, + ni->ino, ctx->params->capture_root_dev, + false, &root); if (ret) - return ret; + goto out; - win32_get_vol_flags(root_disk_path, &vol_flags, NULL); + inode = root->d_inode; + + /* Set the short name if needed. */ + if (is_primary_name && *ni->short_name) { + size_t nbytes = wcslen(ni->short_name) * sizeof(wchar_t); + root->d_short_name = memdup(ni->short_name, + nbytes + sizeof(wchar_t)); + if (!root->d_short_name) { + ret = WIMLIB_ERR_NOMEM; + goto out; + } + root->d_short_name_nbytes = nbytes; + } + + if (inode->i_nlink > 1) { /* Already seen this inode? */ + ret = 0; + goto out_progress; + } + + /* The file attributes and timestamps were cached from the MFT. */ + inode->i_attributes = ni->attributes; + inode->i_creation_time = ni->creation_time; + inode->i_last_write_time = ni->last_write_time; + inode->i_last_access_time = ni->last_access_time; + + /* Set the security descriptor if needed. */ + if (!(ctx->params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS)) { + /* Look up the WIM security ID that corresponds to the on-disk + * security ID. */ + s32 wim_security_id = + security_map_lookup(security_map, ni->security_id); + if (likely(wim_security_id >= 0)) { + /* The mapping for this security ID is already cached.*/ + inode->i_security_id = wim_security_id; + } else { + HANDLE h; + NTSTATUS status; + + /* Create a mapping for this security ID and insert it + * into the security map. */ + + status = winnt_open(path, path_nchars, + READ_CONTROL | + ACCESS_SYSTEM_SECURITY, &h); + if (!NT_SUCCESS(status)) { + winnt_error(status, L"Can't open \"%ls\" to " + "read security descriptor", + printable_path(path)); + ret = WIMLIB_ERR_OPEN; + goto out; + } + ret = winnt_load_security_descriptor(h, inode, path, ctx); + (*func_NtClose)(h); + if (ret) + goto out; + + ret = security_map_insert(security_map, ni->security_id, + inode->i_security_id); + if (ret) + goto out; + } + } + + /* Add data streams based on the cached information from the MFT. */ + ns = FIRST_STREAM(ni); + for (u32 i = 0; i < ni->num_streams; i++) { + struct windows_file *windows_file; + + /* Reference the stream by path if it's a named data stream, or + * if the volume doesn't support "open by file ID", or if the + * application hasn't explicitly opted in to "open by file ID". + * Otherwise, only save the inode number (file ID). */ + if (*ns->name || + !(ctx->vol_flags & FILE_SUPPORTS_OPEN_BY_FILE_ID) || + !(ctx->params->add_flags & WIMLIB_ADD_FLAG_FILE_PATHS_UNNEEDED)) + { + windows_file = alloc_windows_file(path, + path_nchars, + ns->name, + wcslen(ns->name), + ctx->snapshot, + false); + } else { + windows_file = alloc_windows_file_for_file_id(ni->ino, + path, + ctx->params->capture_root_nchars + 1, + ctx->snapshot); + } + + ret = add_stream(inode, windows_file, ns->size, + STREAM_TYPE_DATA, ns->name, + ctx->params->unhashed_blobs); + if (ret) + goto out; + ns = NEXT_STREAM(ns); + } + + set_sort_key(inode, ni->starting_lcn); + + /* If processing a directory, then recurse to its children. In this + * version there is no need to go to disk, as we already have the list + * of children cached from the MFT. */ + if (inode_is_directory(inode)) { + const struct ntfs_dentry *nd = ni->first_child; + + while (nd != NULL) { + const size_t name_len = wcslen(nd->name); + wchar_t *p = path + path_nchars; + struct wim_dentry *child; + const struct ntfs_dentry *next = nd->next_child; + + if (*(p - 1) != L'\\') + *p++ = L'\\'; + p = wmempcpy(p, nd->name, name_len); + *p = '\0'; + + ret = generate_wim_structures_recursive( + &child, + path, + p - path, + nd->name, + nd->is_primary, + (void *)nd - nd->offset_from_inode, + ctx, + inode_map, + security_map); + + path[path_nchars] = L'\0'; + + if (ret) + goto out; + + attach_scanned_tree(root, child, ctx->params->blob_table); + nd = next; + } + } + +out_progress: + ctx->params->progress.scan.cur_path = path; + if (likely(root)) + ret = do_capture_progress(ctx->params, WIMLIB_SCAN_DENTRY_OK, inode); + else + ret = do_capture_progress(ctx->params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL); +out: + if (--ni->num_aliases == 0) { + /* Memory usage optimization: when we don't need the ntfs_inode + * (and its names and streams) anymore, free it. */ + ntfs_inode_map_remove(inode_map, ni); + } + if (unlikely(ret)) { + free_dentry_tree(root, ctx->params->blob_table); + root = NULL; + } + *root_ret = root; + return ret; +} + +static int +winnt_build_dentry_tree_fast(struct wim_dentry **root_ret, wchar_t *path, + size_t path_nchars, struct winnt_scan_ctx *ctx) +{ + struct ntfs_inode_map inode_map = { .root = NULL }; + struct security_map security_map = { .root = NULL }; + struct ntfs_inode *root = NULL; + bool adjust_path; + int ret; + + adjust_path = (path[path_nchars - 1] == L'\\'); + if (adjust_path) + path[path_nchars - 1] = L'\0'; + + ret = load_files_from_mft(path, &inode_map); + + if (adjust_path) + path[path_nchars - 1] = L'\\'; + + if (ret) + goto out; + + ret = build_children_lists(&inode_map, &root); + if (ret) + goto out; + + if (!root) { + ERROR("The MFT listing for volume \"%ls\" did not include a " + "root directory!", path); + ret = WIMLIB_ERR_UNSUPPORTED; + goto out; + } + + root->num_aliases = 1; + + ret = generate_wim_structures_recursive(root_ret, path, path_nchars, + L"", false, root, ctx, + &inode_map, &security_map); +out: + ntfs_inode_map_destroy(&inode_map); + security_map_destroy(&security_map); + return ret; +} + +#endif /* ENABLE_FAST_MFT_SCAN */ + +/*----------------------------------------------------------------------------* + * Entry point for directory tree scans on Windows * + *----------------------------------------------------------------------------*/ + +#define WINDOWS_NT_MAX_PATH 32768 + +int +win32_build_dentry_tree(struct wim_dentry **root_ret, + const wchar_t *root_disk_path, + struct capture_params *params) +{ + wchar_t *path = NULL; + struct winnt_scan_ctx ctx = { .params = params }; + UNICODE_STRING ntpath; + size_t ntpath_nchars; + HANDLE h = NULL; + NTSTATUS status; + int ret; /* 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 - * by Windows NT (which is NOT the same as MAX_PATH). */ - path = MALLOC(WINDOWS_NT_MAX_PATH * sizeof(wchar_t)); + * by Windows NT (which is NOT the same as MAX_PATH). */ + path = MALLOC((WINDOWS_NT_MAX_PATH + 1) * sizeof(wchar_t)); if (!path) return WIMLIB_ERR_NOMEM; - /* Work around defective behavior in Windows where paths longer than 260 - * characters are not supported by default; instead they need to be - * turned into absolute paths and prefixed with "\\?\". */ + if (params->add_flags & WIMLIB_ADD_FLAG_SNAPSHOT) + ret = vss_create_snapshot(root_disk_path, &ntpath, &ctx.snapshot); + else + ret = win32_path_to_nt_path(root_disk_path, &ntpath); - if (wcsncmp(root_disk_path, L"\\\\?\\", 4)) { - dret = GetFullPathName(root_disk_path, WINDOWS_NT_MAX_PATH - 4, - &path[4], NULL); + if (ret) + goto out; - if (dret == 0 || dret >= WINDOWS_NT_MAX_PATH - 4) { - WARNING("Can't get full path name for \"%ls\"", root_disk_path); - wmemcpy(path, root_disk_path, path_nchars + 1); - } else { - wmemcpy(path, L"\\\\?\\", 4); - path_nchars = 4 + dret; - /* Update pattern prefix */ - if (params->config != NULL) - { - params->config->_prefix = TSTRDUP(path); - params->config->_prefix_num_tchars = path_nchars; - if (params->config->_prefix == NULL) - { - ret = WIMLIB_ERR_NOMEM; - goto out_free_path; - } - need_prefix_free = true; - } - } + if (ntpath.Length < 4 * sizeof(wchar_t) || + ntpath.Length > WINDOWS_NT_MAX_PATH * sizeof(wchar_t) || + wmemcmp(ntpath.Buffer, L"\\??\\", 4)) + { + ERROR("\"%ls\": unrecognized path format", root_disk_path); + ret = WIMLIB_ERR_INVALID_PARAM; } else { - wmemcpy(path, root_disk_path, path_nchars + 1); + 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; + + status = winnt_open(path, ntpath_nchars, FILE_READ_ATTRIBUTES, &h); + if (!NT_SUCCESS(status)) { + winnt_error(status, L"Can't open \"%ls\"", printable_path(path)); + if (status == STATUS_FVE_LOCKED_VOLUME) + ret = WIMLIB_ERR_FVE_LOCKED_VOLUME; + else + ret = WIMLIB_ERR_OPEN; + goto out; } - memset(&state, 0, sizeof(state)); - ret = win32_build_dentry_tree_recursive(root_ret, path, - path_nchars, params, - &state, vol_flags); - if (need_prefix_free) - FREE(params->config->_prefix); -out_free_path: + get_volume_information(h, path, &ctx); + + (*func_NtClose)(h); + +#ifdef ENABLE_FAST_MFT_SCAN + if (ctx.is_ntfs && !_wgetenv(L"WIMLIB_DISABLE_QUERY_FILE_LAYOUT")) { + ret = winnt_build_dentry_tree_fast(root_ret, path, + ntpath_nchars, &ctx); + if (ret >= 0 && ret != WIMLIB_ERR_UNSUPPORTED) + goto out; + if (ret >= 0) { + WARNING("A problem occurred during the fast MFT scan.\n" + " Falling back to the standard " + "recursive directory tree scan."); + } + } +#endif + ret = winnt_build_dentry_tree_recursive(root_ret, NULL, + path, ntpath_nchars, + path, ntpath_nchars, + L"", &ctx); +out: + vss_put_snapshot(ctx.snapshot); FREE(path); if (ret == 0) - win32_do_capture_warnings(&state, params->add_flags); + winnt_do_scan_warnings(root_disk_path, &ctx); return ret; }