#include <windows.h>
#include <ntdef.h>
#include <wchar.h>
-#include <shlwapi.h> /* shlwapi.h for PathMatchSpecW() */
+#include <shlwapi.h> /* for PathMatchSpecW() */
+#include <aclapi.h> /* for SetSecurityInfo() */
#ifdef ERROR /* windows.h defines this */
# undef ERROR
#endif
#include "lookup_table.h"
#include "security.h"
#include "endianness.h"
+#include "buffer_io.h"
#include <pthread.h>
#include <errno.h>
#define MAX_GET_SD_ACCESS_DENIED_WARNINGS 1
#define MAX_GET_SACL_PRIV_NOTHELD_WARNINGS 1
+#define MAX_CREATE_HARD_LINK_WARNINGS 5
struct win32_capture_state {
unsigned long num_get_sd_access_denied;
unsigned long num_get_sacl_priv_notheld;
} else {
export_ctx.buf = NULL;
}
+ export_ctx.buf_filled = 0;
export_ctx.bytes_remaining = size;
err = OpenEncryptedFileRawW(lte->file_on_disk, 0, &file_ctx);
win32_get_short_name(struct wim_dentry *dentry, const wchar_t *path)
{
WIN32_FIND_DATAW dat;
- if (FindFirstFileW(path, &dat) && 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)
- return WIMLIB_ERR_NOMEM;
- memcpy(dentry->short_name, dat.cAlternateFileName, n);
- dentry->short_name_nbytes = short_name_nbytes;
- }
+ 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. */
- return 0;
+ 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);
+ }
+ return ret;
}
static int
win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
wchar_t *path,
size_t path_num_chars,
- struct wim_lookup_table *lookup_table,
- struct wim_inode_table *inode_table,
- struct sd_set *sd_set,
- const struct wimlib_capture_config *config,
- int add_image_flags,
- wimlib_progress_func_t progress_func,
+ struct add_image_params *params,
struct win32_capture_state *state,
unsigned vol_flags);
win32_recurse_directory(struct wim_dentry *root,
wchar_t *dir_path,
size_t dir_path_num_chars,
- struct wim_lookup_table *lookup_table,
- struct wim_inode_table *inode_table,
- struct sd_set *sd_set,
- const struct wimlib_capture_config *config,
- int add_image_flags,
- wimlib_progress_func_t progress_func,
+ struct add_image_params *params,
struct win32_capture_state *state,
unsigned vol_flags)
{
ret = win32_build_dentry_tree_recursive(&child,
dir_path,
path_len,
- lookup_table,
- inode_table,
- sd_set,
- config,
- add_image_flags,
- progress_func,
+ params,
state,
vol_flags);
dir_path[dir_path_num_chars] = L'\0';
return ret;
}
-/* Load a reparse point into a WIM inode. It is just stored in memory.
- *
- * @hFile: Open handle to a reparse point, with permission to read the reparse
- * data.
- *
- * @inode: WIM inode for the reparse point.
- *
- * @lookup_table: Stream lookup table for the WIM; an entry will be added to it
- * for the reparse point unless an entry already exists for
- * the exact same data stream.
+int
+win32_get_file_and_vol_ids(const wchar_t *path, u64 *ino_ret, u64 *dev_ret)
+{
+ HANDLE hFile;
+ DWORD err;
+ BY_HANDLE_FILE_INFORMATION file_info;
+ int ret;
+
+ hFile = win32_open_existing_file(path, FILE_READ_ATTRIBUTES);
+ if (hFile == INVALID_HANDLE_VALUE) {
+ err = GetLastError();
+ WARNING("Failed to open \"%ls\" to get file and volume IDs",
+ path);
+ win32_error(err);
+ return WIMLIB_ERR_OPEN;
+ }
+
+ if (!GetFileInformationByHandle(hFile, &file_info)) {
+ err = GetLastError();
+ ERROR("Failed to get file information for \"%ls\"", path);
+ win32_error(err);
+ ret = WIMLIB_ERR_STAT;
+ } else {
+ *ino_ret = ((u64)file_info.nFileIndexHigh << 32) |
+ (u64)file_info.nFileIndexLow;
+ *dev_ret = file_info.dwVolumeSerialNumber;
+ ret = 0;
+ }
+ CloseHandle(hFile);
+ 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,
+};
+
+/* 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.
*
- * @path: External path to the reparse point. Used for error messages only.
+ * Note that this is only executed when WIMLIB_ADD_IMAGE_FLAG_RPFIX has been
+ * set.
*
- * Returns 0 on success; nonzero on failure. */
-static int
-win32_capture_reparse_point(HANDLE hFile,
- struct wim_inode *inode,
- struct wim_lookup_table *lookup_table,
- const wchar_t *path)
+ * @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 enum rp_status
+win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p,
+ u64 capture_root_ino, u64 capture_root_dev)
+{
+ size_t target_nchars= *target_nchars_p;
+ size_t stripped_chars;
+ wchar_t *orig_target;
+
+ if (target_nchars == 0)
+ /* Invalid reparse point (empty target) */
+ return RP_NOT_FIXED;
+
+ if (target[0] == L'\\') {
+ if (target_nchars >= 2 && target[1] == L'\\') {
+ /* Probably a volume. Can't do anything with it. */
+ DEBUG("Not fixing target (probably a volume)");
+ return RP_NOT_FIXED;
+ } else if (target_nchars >= 7 &&
+ target[1] == '?' &&
+ target[2] == '?' &&
+ target[3] == '\\' &&
+ target[4] != '\0' &&
+ target[5] == ':' &&
+ target[6] == '\\')
+ {
+ DEBUG("Full style path");
+ /* Full \??\x:\ style path (may be junction or symlink)
+ * */
+ stripped_chars = 6;
+ } else {
+ DEBUG("Absolute target without drive letter");
+ /* Absolute target, without drive letter */
+ stripped_chars = 0;
+ }
+ } else if (target_nchars >= 3 &&
+ target[0] != L'\0' &&
+ target[1] == L':' &&
+ target[2] == L'\\')
+ {
+ DEBUG("Absolute target with drive letter");
+ /* Absolute target, with drive letter */
+ stripped_chars = 2;
+ } else {
+ DEBUG("Relative symlink or other link");
+ /* Relative symlink or other unexpected format */
+ return RP_NOT_FIXED;
+ }
+ target[target_nchars] = L'\0';
+ orig_target = target;
+ target = fixup_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_nchars_p = target_nchars + stripped_chars;
+ DEBUG("Fixed reparse point (new target: \"%ls\")", orig_target);
+ if (stripped_chars == 6)
+ return RP_FIXED_FULLPATH;
+ else
+ return RP_FIXED_ABSPATH;
+}
+
+static enum rp_status
+win32_try_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p,
+ u64 capture_root_ino, u64 capture_root_dev)
{
- DEBUG("Capturing reparse point \"%ls\"", path);
+ const char *p_get;
+ char *p_put;
+ u16 substitute_name_offset;
+ u16 substitute_name_len;
+ wchar_t *target;
+ size_t target_nchars;
+ enum rp_status status;
+ u32 rptag;
+ DWORD rpbuflen = *rpbuflen_p;
+
+ if (rpbuflen < 16) /* Invalid reparse point (length too small) */
+ return RP_NOT_FIXED;
+ p_get = get_u32(rpbuf, &rptag);
+ p_get += 4;
+ p_get = get_u16(p_get, &substitute_name_offset);
+ p_get = get_u16(p_get, &substitute_name_len);
+ p_get += 4;
+ if (rptag == WIM_IO_REPARSE_TAG_SYMLINK) {
+ if (rpbuflen < 20) /* Invalid reparse point (length too small) */
+ return RP_NOT_FIXED;
+ p_get += 4;
+ }
+ if ((DWORD)substitute_name_offset +
+ substitute_name_len + (p_get - rpbuf) > rpbuflen)
+ /* Invalid reparse point (length too small) */
+ return RP_NOT_FIXED;
+
+ target = (wchar_t*)&p_get[substitute_name_offset];
+ target_nchars = substitute_name_len / 2;
+ /* Note: target is not necessarily null-terminated */
+
+ status = win32_maybe_rpfix_target(target, &target_nchars,
+ capture_root_ino, capture_root_dev);
+ if (status & RP_FIXED) {
+ size_t target_nbytes = target_nchars * 2;
+ size_t print_nbytes = target_nbytes;
+ wchar_t target_copy[target_nchars];
+ wchar_t *print_name = target_copy;
+
+ if (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. */
+ print_nbytes -= 8;
+ print_name += 4;
+ }
+ wmemcpy(target_copy, target, target_nchars);
+ p_put = rpbuf + 8;
+ p_put = put_u16(p_put, 0); /* Substitute name offset */
+ p_put = put_u16(p_put, target_nbytes); /* Substitute name length */
+ p_put = put_u16(p_put, target_nbytes + 2); /* Print name offset */
+ p_put = put_u16(p_put, print_nbytes); /* Print name length */
+ if (rptag == WIM_IO_REPARSE_TAG_SYMLINK)
+ p_put = put_u32(p_put, 1);
+ p_put = put_bytes(p_put, target_nbytes, target_copy);
+ p_put = put_u16(p_put, 0);
+ p_put = put_bytes(p_put, print_nbytes, print_name);
+ p_put = put_u16(p_put, 0);
+
+ /* Wrote the end of the reparse data. Recalculate the length,
+ * set the length field correctly, and return it. */
+ rpbuflen = p_put - rpbuf;
+ put_u16(rpbuf + 4, rpbuflen - 8);
+ *rpbuflen_p = rpbuflen;
+ }
+ return status;
+}
- /* "Reparse point data, including the tag and optional GUID,
- * cannot exceed 16 kilobytes." - MSDN */
- char reparse_point_buf[REPARSE_POINT_MAX_SIZE];
+static int
+win32_get_reparse_data(HANDLE hFile, const wchar_t *path,
+ struct add_image_params *params,
+ void *reparse_data, size_t *reparse_data_len_ret)
+{
DWORD bytesReturned;
+ u32 reparse_tag;
+ enum rp_status status;
+ 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" */
- reparse_point_buf, /* "A pointer to a buffer that
+ reparse_data, /* "A pointer to a buffer that
receives the reparse point data */
- sizeof(reparse_point_buf), /* "The size of the output
- buffer, in bytes */
+ REPARSE_POINT_MAX_SIZE, /* "The size of the output
+ buffer, in bytes */
&bytesReturned,
NULL))
{
DWORD err = GetLastError();
ERROR("Failed to get reparse data of \"%ls\"", path);
win32_error(err);
- return WIMLIB_ERR_READ;
+ return -WIMLIB_ERR_READ;
}
if (bytesReturned < 8) {
ERROR("Reparse data on \"%ls\" is invalid", path);
- return WIMLIB_ERR_READ;
+ return -WIMLIB_ERR_READ;
}
- inode->i_reparse_tag = le32_to_cpu(*(u32*)reparse_point_buf);
- return inode_add_ads_with_data(inode, L"",
- reparse_point_buf + 8,
- bytesReturned - 8, lookup_table);
+
+ reparse_tag = le32_to_cpu(*(u32*)reparse_data);
+ if (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_RPFIX &&
+ (reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
+ reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
+ {
+ /* Try doing reparse point fixup */
+ status = win32_try_capture_rpfix(reparse_data,
+ &bytesReturned,
+ params->capture_root_ino,
+ params->capture_root_dev);
+ } else {
+ status = RP_NOT_FIXED;
+ }
+ *reparse_data_len_ret = bytesReturned;
+ return status;
+}
+
+static DWORD WINAPI
+win32_tally_encrypted_size_cb(unsigned char *_data, void *_ctx,
+ unsigned long len)
+{
+ *(u64*)_ctx += len;
+ return ERROR_SUCCESS;
+}
+
+static int
+win32_get_encrypted_file_size(const wchar_t *path, u64 *size_ret)
+{
+ DWORD err;
+ void *file_ctx;
+ int ret;
+
+ *size_ret = 0;
+ err = OpenEncryptedFileRawW(path, 0, &file_ctx);
+ if (err != ERROR_SUCCESS) {
+ ERROR("Failed to open encrypted file \"%ls\" for raw read", path);
+ win32_error(err);
+ return WIMLIB_ERR_OPEN;
+ }
+ 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);
+ ret = WIMLIB_ERR_READ;
+ } else {
+ ret = 0;
+ }
+ CloseEncryptedFileRaw(file_ctx);
+ return ret;
}
/* Scans an unnamed or named stream of a Win32 file (not a reparse point
}
}
+ /* If zero length stream, no lookup table entry needed. */
+ if ((u64)dat->StreamSize.QuadPart == 0) {
+ ret = 0;
+ goto out;
+ }
+
/* 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
}
lte->file_on_disk = spath;
spath = NULL;
- if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED && !is_named_stream)
+ if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED && !is_named_stream) {
+ u64 encrypted_size;
lte->resource_location = RESOURCE_WIN32_ENCRYPTED;
- else
+ 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_WIN32;
- lte->resource_entry.original_size = (u64)dat->StreamSize.QuadPart;
+ lte->resource_entry.original_size = (u64)dat->StreamSize.QuadPart;
+ }
u32 stream_id;
if (is_named_stream) {
win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
wchar_t *path,
size_t path_num_chars,
- struct wim_lookup_table *lookup_table,
- struct wim_inode_table *inode_table,
- struct sd_set *sd_set,
- const struct wimlib_capture_config *config,
- int add_image_flags,
- wimlib_progress_func_t progress_func,
+ struct add_image_params *params,
struct win32_capture_state *state,
unsigned vol_flags)
{
struct wim_inode *inode;
DWORD err;
u64 file_size;
- int ret = 0;
+ int ret;
+ void *reparse_data;
+ size_t reparse_data_len;
+ u16 not_rpfixed;
- if (exclude_path(path, path_num_chars, config, true)) {
- if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) {
+ if (exclude_path(path, path_num_chars, params->config, true)) {
+ if (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) {
ERROR("Cannot exclude the root directory from capture");
ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
goto out;
}
- if ((add_image_flags & WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE)
- && progress_func)
+ if ((params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE)
+ && params->progress_func)
{
union wimlib_progress_info info;
info.scan.cur_path = path;
info.scan.excluded = true;
- progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
+ params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
}
+ ret = 0;
goto out;
}
- if ((add_image_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
- && progress_func)
+ if ((params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
+ && params->progress_func)
{
union wimlib_progress_info info;
info.scan.cur_path = path;
info.scan.excluded = false;
- progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
+ params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
}
HANDLE hFile = win32_open_existing_file(path,
goto out_close_handle;
}
- /* Create a WIM dentry with an associated inode, which may be shared */
- ret = inode_table_new_dentry(inode_table,
+ if (file_info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
+ reparse_data = alloca(REPARSE_POINT_MAX_SIZE);
+ ret = win32_get_reparse_data(hFile, path, params,
+ reparse_data, &reparse_data_len);
+ 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) {
+ ret = 0;
+ goto out_close_handle;
+ } else {
+ not_rpfixed = 1;
+ }
+ }
+
+ /* Create a WIM dentry with an associated inode, which may be shared.
+ *
+ * However, we need to explicitly check for directories and files with
+ * only 1 link and refuse to hard link them. This is because Windows
+ * has a bug where it can return duplicate File IDs for files and
+ * directories on the FAT filesystem. */
+ ret = inode_table_new_dentry(params->inode_table,
path_basename_with_len(path, path_num_chars),
((u64)file_info.nFileIndexHigh << 32) |
- (u64)file_info.nFileIndexLow,
+ (u64)file_info.nFileIndexLow,
file_info.dwVolumeSerialNumber,
+ (file_info.nNumberOfLinks <= 1 ||
+ (file_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)),
&root);
if (ret)
goto out_close_handle;
inode->i_last_access_time = FILETIME_to_u64(&file_info.ftLastAccessTime);
inode->i_resolved = 1;
- add_image_flags &= ~(WIMLIB_ADD_IMAGE_FLAG_ROOT | WIMLIB_ADD_IMAGE_FLAG_SOURCE);
+ params->add_image_flags &= ~(WIMLIB_ADD_IMAGE_FLAG_ROOT | WIMLIB_ADD_IMAGE_FLAG_SOURCE);
- if (!(add_image_flags & WIMLIB_ADD_IMAGE_FLAG_NO_ACLS)
+ if (!(params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_NO_ACLS)
&& (vol_flags & FILE_PERSISTENT_ACLS))
{
- ret = win32_get_security_descriptor(root, sd_set, path, state,
- add_image_flags);
+ ret = win32_get_security_descriptor(root, params->sd_set,
+ path, state,
+ params->add_image_flags);
if (ret)
goto out_close_handle;
}
file_size = ((u64)file_info.nFileSizeHigh << 32) |
(u64)file_info.nFileSizeLow;
- if (inode_is_directory(inode)) {
- /* Directory (not a reparse point) --- recurse to children */
+ CloseHandle(hFile);
- /* But first... directories may have alternate data streams that
- * need to be captured. */
- ret = win32_capture_streams(path,
- path_num_chars,
- inode,
- lookup_table,
- file_size,
- vol_flags);
- if (ret)
- goto out_close_handle;
+ /* 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->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(*(u32*)reparse_data);
+ ret = inode_set_unnamed_stream(inode, reparse_data + 8,
+ reparse_data_len - 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,
- lookup_table,
- inode_table,
- sd_set,
- config,
- add_image_flags,
- progress_func,
+ params,
state,
vol_flags);
- } else if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
- /* Reparse point: save the reparse tag and data. Alternate data
- * streams are not captured, if it's even possible for a reparse
- * point to have alternate data streams... */
- ret = win32_capture_reparse_point(hFile,
- inode,
- lookup_table,
- path);
- } else {
- /* Not a directory, not a reparse point; capture the default
- * file contents and any alternate data streams. */
- ret = win32_capture_streams(path,
- path_num_chars,
- inode,
- lookup_table,
- file_size,
- vol_flags);
}
+ goto out;
out_close_handle:
CloseHandle(hFile);
out:
if (ret == 0)
*root_ret = root;
else
- free_dentry_tree(root, lookup_table);
+ free_dentry_tree(root, params->lookup_table);
return ret;
}
int
win32_build_dentry_tree(struct wim_dentry **root_ret,
const wchar_t *root_disk_path,
- struct wim_lookup_table *lookup_table,
- struct wim_inode_table *inode_table,
- struct sd_set *sd_set,
- const struct wimlib_capture_config *config,
- int add_image_flags,
- wimlib_progress_func_t progress_func,
- void *extra_arg)
+ struct add_image_params *params)
{
size_t path_nchars;
wchar_t *path;
struct win32_capture_state state;
unsigned vol_flags;
+
path_nchars = wcslen(root_disk_path);
if (path_nchars > 32767)
return WIMLIB_ERR_INVALID_PARAM;
+ ret = win32_get_file_and_vol_ids(root_disk_path,
+ ¶ms->capture_root_ino,
+ ¶ms->capture_root_dev);
+ if (ret)
+ return ret;
+
win32_get_vol_flags(root_disk_path, &vol_flags);
/* There is no check for overflow later when this buffer is being used!
wmemcpy(path, root_disk_path, path_nchars + 1);
memset(&state, 0, sizeof(state));
- ret = win32_build_dentry_tree_recursive(root_ret,
- path,
- path_nchars,
- lookup_table,
- inode_table,
- sd_set,
- config,
- add_image_flags,
- progress_func,
- &state,
- vol_flags);
+ ret = win32_build_dentry_tree_recursive(root_ret, path,
+ path_nchars, params,
+ &state, vol_flags);
FREE(path);
if (ret == 0)
- win32_do_capture_warnings(&state, add_image_flags);
+ win32_do_capture_warnings(&state, params->add_image_flags);
return ret;
}
+/* Wrapper around the FSCTL_SET_REPARSE_POINT ioctl to set the reparse data on
+ * an extracted reparse point. */
static int
win32_set_reparse_data(HANDLE h,
u32 reparse_tag,
DWORD err = GetLastError();
ERROR("Failed to set reparse data on \"%ls\"", path);
win32_error(err);
- return WIMLIB_ERR_WRITE;
+ if (err == ERROR_ACCESS_DENIED || err == ERROR_PRIVILEGE_NOT_HELD)
+ return WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT;
+ else if (reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
+ reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT)
+ return WIMLIB_ERR_LINK;
+ else
+ return WIMLIB_ERR_WRITE;
}
return 0;
}
+/* Wrapper around the FSCTL_SET_COMPRESSION ioctl to change the
+ * FILE_ATTRIBUTE_COMPRESSED flag of a file or directory. */
static int
-win32_set_compressed(HANDLE hFile, const wchar_t *path)
+win32_set_compression_state(HANDLE hFile, USHORT format, const wchar_t *path)
{
- USHORT format = COMPRESSION_FORMAT_DEFAULT;
- DWORD bytesReturned = 0;
+ DWORD bytesReturned;
if (!DeviceIoControl(hFile, FSCTL_SET_COMPRESSION,
&format, sizeof(USHORT),
NULL, 0,
DWORD err = GetLastError();
ERROR("Failed to set compression flag on \"%ls\"", path);
win32_error(err);
- return WIMLIB_ERR_WRITE;
+ if (err == ERROR_ACCESS_DENIED || err == ERROR_PRIVILEGE_NOT_HELD)
+ return WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT;
+ else
+ return WIMLIB_ERR_WRITE;
}
return 0;
}
+/* Wrapper around FSCTL_SET_SPARSE ioctl to set a file as sparse. */
static int
win32_set_sparse(HANDLE hFile, const wchar_t *path)
{
- DWORD bytesReturned = 0;
+ DWORD bytesReturned;
if (!DeviceIoControl(hFile, FSCTL_SET_SPARSE,
NULL, 0,
NULL, 0,
DWORD err = GetLastError();
WARNING("Failed to set sparse flag on \"%ls\"", path);
win32_error(err);
- return WIMLIB_ERR_WRITE;
+ if (err == ERROR_ACCESS_DENIED || err == ERROR_PRIVILEGE_NOT_HELD)
+ return WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT;
+ else
+ return WIMLIB_ERR_WRITE;
}
return 0;
}
*/
static int
win32_set_security_data(const struct wim_inode *inode,
+ HANDLE hFile,
const wchar_t *path,
struct apply_args *args)
{
PSECURITY_DESCRIPTOR descriptor;
unsigned long n;
DWORD err;
+ const struct wim_security_data *sd;
+
+ SECURITY_INFORMATION securityInformation = 0;
+
+ void *owner = NULL;
+ void *group = NULL;
+ ACL *dacl = NULL;
+ ACL *sacl = NULL;
+
+ BOOL owner_defaulted;
+ BOOL group_defaulted;
+ BOOL dacl_present;
+ BOOL dacl_defaulted;
+ BOOL sacl_present;
+ BOOL sacl_defaulted;
+
+ sd = wim_const_security_data(args->w);
+ descriptor = sd->descriptors[inode->i_security_id];
+
+ GetSecurityDescriptorOwner(descriptor, &owner, &owner_defaulted);
+ if (owner)
+ securityInformation |= OWNER_SECURITY_INFORMATION;
+
+ GetSecurityDescriptorGroup(descriptor, &group, &group_defaulted);
+ if (group)
+ securityInformation |= GROUP_SECURITY_INFORMATION;
+
+ GetSecurityDescriptorDacl(descriptor, &dacl_present,
+ &dacl, &dacl_defaulted);
+ if (dacl)
+ securityInformation |= DACL_SECURITY_INFORMATION;
- descriptor = wim_const_security_data(args->w)->descriptors[inode->i_security_id];
+ GetSecurityDescriptorSacl(descriptor, &sacl_present,
+ &sacl, &sacl_defaulted);
+ if (sacl)
+ securityInformation |= SACL_SECURITY_INFORMATION;
- SECURITY_INFORMATION securityInformation = DACL_SECURITY_INFORMATION |
- SACL_SECURITY_INFORMATION |
- OWNER_SECURITY_INFORMATION |
- GROUP_SECURITY_INFORMATION;
again:
- if (SetFileSecurityW(path, securityInformation, descriptor))
+ if (securityInformation == 0)
+ return 0;
+ if (SetSecurityInfo(hFile, SE_FILE_OBJECT,
+ securityInformation, owner, group, dacl, sacl))
return 0;
err = GetLastError();
if (args->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS)
if (securityInformation & SACL_SECURITY_INFORMATION) {
n = args->num_set_sacl_priv_notheld++;
securityInformation &= ~SACL_SECURITY_INFORMATION;
+ sacl = NULL;
if (n < MAX_SET_SACL_PRIV_NOTHELD_WARNINGS) {
WARNING(
"We don't have enough privileges to set the full security\n"
fail:
ERROR("Failed to set security descriptor on \"%ls\"", path);
win32_error(err);
- return WIMLIB_ERR_WRITE;
+ if (err == ERROR_ACCESS_DENIED || err == ERROR_PRIVILEGE_NOT_HELD)
+ return WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT;
+ else
+ return WIMLIB_ERR_WRITE;
}
}
}
static int
-do_win32_extract_stream(HANDLE hStream, struct wim_lookup_table_entry *lte)
+do_win32_extract_stream(HANDLE hStream, const struct wim_lookup_table_entry *lte)
{
return extract_wim_resource(lte, wim_resource_size(lte),
win32_extract_chunk, hStream);
}
+struct win32_encrypted_extract_ctx {
+ void *file_ctx;
+ int wimlib_err_code;
+ bool done;
+ pthread_cond_t cond;
+ pthread_mutex_t mutex;
+ u8 buf[WIM_CHUNK_SIZE];
+ size_t buf_filled;
+};
+
+static DWORD WINAPI
+win32_encrypted_import_cb(unsigned char *data, void *_ctx,
+ unsigned long *len_p)
+{
+ struct win32_encrypted_extract_ctx *ctx = _ctx;
+ unsigned long len = *len_p;
+
+ pthread_mutex_lock(&ctx->mutex);
+ while (len) {
+ size_t bytes_to_copy;
+
+ DEBUG("Importing up to %lu more bytes of raw encrypted data", len);
+ while (ctx->buf_filled == 0) {
+ if (ctx->done)
+ goto out;
+ pthread_cond_wait(&ctx->cond, &ctx->mutex);
+ }
+ bytes_to_copy = min(len, ctx->buf_filled);
+ memcpy(data, ctx->buf, bytes_to_copy);
+ len -= bytes_to_copy;
+ data += bytes_to_copy;
+ ctx->buf_filled -= bytes_to_copy;
+ memmove(ctx->buf, ctx->buf + bytes_to_copy, ctx->buf_filled);
+ pthread_cond_signal(&ctx->cond);
+ }
+out:
+ *len_p -= len;
+ pthread_mutex_unlock(&ctx->mutex);
+ return ERROR_SUCCESS;
+}
+
+/* Extract ("Import") an encrypted file in a different thread. */
+static void *
+win32_encrypted_import_proc(void *arg)
+{
+ struct win32_encrypted_extract_ctx *ctx = arg;
+ DWORD ret;
+ ret = WriteEncryptedFileRaw(win32_encrypted_import_cb, ctx,
+ ctx->file_ctx);
+ pthread_mutex_lock(&ctx->mutex);
+ if (ret == ERROR_SUCCESS) {
+ ctx->wimlib_err_code = 0;
+ } else {
+ win32_error(ret);
+ ctx->wimlib_err_code = WIMLIB_ERR_WRITE;
+ }
+ ctx->done = true;
+ pthread_cond_signal(&ctx->cond);
+ pthread_mutex_unlock(&ctx->mutex);
+ return NULL;
+}
+
+
+static int
+win32_extract_raw_encrypted_chunk(const void *buf, size_t len, void *arg)
+{
+ struct win32_encrypted_extract_ctx *ctx = arg;
+ size_t bytes_to_copy;
+
+ while (len) {
+ DEBUG("Extracting up to %zu more bytes of encrypted data", len);
+ pthread_mutex_lock(&ctx->mutex);
+ while (ctx->buf_filled == WIM_CHUNK_SIZE) {
+ if (ctx->done) {
+ pthread_mutex_unlock(&ctx->mutex);
+ return ctx->wimlib_err_code;
+ }
+ pthread_cond_wait(&ctx->cond, &ctx->mutex);
+ }
+ bytes_to_copy = min(len, WIM_CHUNK_SIZE - ctx->buf_filled);
+ memcpy(&ctx->buf[ctx->buf_filled], buf, bytes_to_copy);
+ len -= bytes_to_copy;
+ buf += bytes_to_copy;
+ ctx->buf_filled += bytes_to_copy;
+ pthread_cond_signal(&ctx->cond);
+ pthread_mutex_unlock(&ctx->mutex);
+ }
+ return 0;
+}
+
+/* Create an encrypted file and extract the raw encrypted data to it.
+ *
+ * @path: Path to encrypted file to create.
+ * @lte: WIM lookup_table entry for the raw encrypted data.
+ *
+ * This is separate from do_win32_extract_stream() because the WIM is supposed
+ * to contain the *raw* encrypted data, which needs to be extracted ("imported")
+ * using the special APIs OpenEncryptedFileRawW(), WriteEncryptedFileRaw(), and
+ * CloseEncryptedFileRaw().
+ *
+ * Returns 0 on success; nonzero on failure.
+ */
static int
do_win32_extract_encrypted_stream(const wchar_t *path,
const struct wim_lookup_table_entry *lte)
{
- ERROR("Extracting encryted streams not implemented");
- return WIMLIB_ERR_INVALID_PARAM;
+ struct win32_encrypted_extract_ctx ctx;
+ void *file_ctx;
+ pthread_t import_thread;
+ int ret;
+ int ret2;
+
+ DEBUG("Opening file \"%ls\" to extract raw encrypted data", path);
+
+ ret = OpenEncryptedFileRawW(path, CREATE_FOR_IMPORT, &file_ctx);
+ if (ret) {
+ ERROR("Failed to open \"%ls\" to write raw encrypted data", path);
+ win32_error(ret);
+ return WIMLIB_ERR_OPEN;
+ }
+
+ if (!lte)
+ goto out_close;
+
+ /* Hack alert: WriteEncryptedFileRaw() requires the callback function
+ * to work with a buffer whose size we cannot control. This doesn't
+ * play well with our read_resource_prefix() function, which itself uses
+ * a callback function to extract WIM_CHUNK_SIZE chunks of data. We
+ * work around this problem by calling WriteEncryptedFileRaw() in a
+ * different thread and feeding it the data as needed. */
+ ctx.file_ctx = file_ctx;
+ ctx.buf_filled = 0;
+ ctx.done = false;
+ ctx.wimlib_err_code = 0;
+ if (pthread_mutex_init(&ctx.mutex, NULL)) {
+ ERROR_WITH_ERRNO("Can't create mutex");
+ ret = WIMLIB_ERR_NOMEM;
+ goto out_close;
+ }
+ if (pthread_cond_init(&ctx.cond, NULL)) {
+ ERROR_WITH_ERRNO("Can't create condition variable");
+ ret = WIMLIB_ERR_NOMEM;
+ goto out_pthread_mutex_destroy;
+ }
+ ret = pthread_create(&import_thread, NULL,
+ win32_encrypted_import_proc, &ctx);
+ if (ret) {
+ errno = ret;
+ ERROR_WITH_ERRNO("Failed to create thread");
+ ret = WIMLIB_ERR_FORK;
+ goto out_pthread_cond_destroy;
+ }
+
+ ret = extract_wim_resource(lte, wim_resource_size(lte),
+ win32_extract_raw_encrypted_chunk, &ctx);
+ pthread_mutex_lock(&ctx.mutex);
+ ctx.done = true;
+ pthread_cond_signal(&ctx.cond);
+ pthread_mutex_unlock(&ctx.mutex);
+ ret2 = pthread_join(import_thread, NULL);
+ if (ret2) {
+ errno = ret2;
+ ERROR_WITH_ERRNO("Failed to join encrypted import thread");
+ if (ret == 0)
+ ret = WIMLIB_ERR_WRITE;
+ }
+ if (ret == 0)
+ ret = ctx.wimlib_err_code;
+out_pthread_cond_destroy:
+ pthread_cond_destroy(&ctx.cond);
+out_pthread_mutex_destroy:
+ pthread_mutex_destroy(&ctx.mutex);
+out_close:
+ CloseEncryptedFileRaw(file_ctx);
+ if (ret)
+ ERROR("Failed to extract encrypted file \"%ls\"", path);
+ return ret;
}
static bool
return (*path == L'\0');
}
-static DWORD
-win32_get_create_flags_and_attributes(DWORD i_attributes)
+static inline DWORD
+win32_mask_attributes(DWORD i_attributes)
{
- DWORD attributes;
+ return i_attributes & ~(FILE_ATTRIBUTE_SPARSE_FILE |
+ FILE_ATTRIBUTE_COMPRESSED |
+ FILE_ATTRIBUTE_REPARSE_POINT |
+ FILE_ATTRIBUTE_DIRECTORY |
+ FILE_ATTRIBUTE_ENCRYPTED |
+ FILE_FLAG_DELETE_ON_CLOSE |
+ FILE_FLAG_NO_BUFFERING |
+ FILE_FLAG_OPEN_NO_RECALL |
+ FILE_FLAG_OVERLAPPED |
+ FILE_FLAG_RANDOM_ACCESS |
+ /*FILE_FLAG_SESSION_AWARE |*/
+ FILE_FLAG_SEQUENTIAL_SCAN |
+ FILE_FLAG_WRITE_THROUGH);
+}
+static inline DWORD
+win32_get_create_flags_and_attributes(DWORD i_attributes)
+{
/*
* Some attributes cannot be set by passing them to CreateFile(). In
* particular:
* want, but also specify FILE_FLAG_OPEN_REPARSE_POINT and
* FILE_FLAG_BACKUP_SEMANTICS as we are a backup application.
*/
- attributes = i_attributes & ~(FILE_ATTRIBUTE_SPARSE_FILE |
- FILE_ATTRIBUTE_COMPRESSED |
- FILE_ATTRIBUTE_REPARSE_POINT |
- FILE_ATTRIBUTE_DIRECTORY |
- FILE_FLAG_DELETE_ON_CLOSE |
- FILE_FLAG_NO_BUFFERING |
- FILE_FLAG_OPEN_NO_RECALL |
- FILE_FLAG_OVERLAPPED |
- FILE_FLAG_RANDOM_ACCESS |
- /*FILE_FLAG_SESSION_AWARE |*/
- FILE_FLAG_SEQUENTIAL_SCAN |
- FILE_FLAG_WRITE_THROUGH);
- return attributes |
- FILE_FLAG_OPEN_REPARSE_POINT |
- FILE_FLAG_BACKUP_SEMANTICS;
+ return win32_mask_attributes(i_attributes) |
+ FILE_FLAG_OPEN_REPARSE_POINT |
+ FILE_FLAG_BACKUP_SEMANTICS;
}
-static bool
-inode_has_special_attributes(const struct wim_inode *inode)
-{
- return (inode->i_attributes & (FILE_ATTRIBUTE_COMPRESSED |
- FILE_ATTRIBUTE_REPARSE_POINT |
- FILE_ATTRIBUTE_SPARSE_FILE)) != 0;
-}
-
-/* Set compression or sparse attributes, and reparse data, if supported by the
+/* Set compression and/or sparse attributes on a stream, if supported by the
* volume. */
static int
-win32_set_special_attributes(HANDLE hFile, const struct wim_inode *inode,
- struct wim_lookup_table_entry *unnamed_stream_lte,
- const wchar_t *path, unsigned vol_flags)
+win32_set_special_stream_attributes(HANDLE hFile, const struct wim_inode *inode,
+ struct wim_lookup_table_entry *unnamed_stream_lte,
+ const wchar_t *path, unsigned vol_flags)
{
int ret;
if (inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED) {
if (vol_flags & FILE_FILE_COMPRESSION) {
- DEBUG("Setting compression flag on \"%ls\"", path);
- ret = win32_set_compressed(hFile, path);
+ ret = win32_set_compression_state(hFile,
+ COMPRESSION_FORMAT_DEFAULT,
+ path);
if (ret)
return ret;
} else {
path);
}
}
+ return 0;
+}
- if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
- if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS) {
- DEBUG("Setting reparse data on \"%ls\"", path);
- ret = win32_set_reparse_data(hFile, inode->i_reparse_tag,
- unnamed_stream_lte, path);
+/* Pre-create directories; extract encrypted streams */
+static int
+win32_begin_extract_unnamed_stream(const struct wim_inode *inode,
+ const struct wim_lookup_table_entry *lte,
+ const wchar_t *path,
+ DWORD *creationDisposition_ret,
+ unsigned int vol_flags)
+{
+ DWORD err;
+ int ret;
+
+ /* Directories must be created with CreateDirectoryW(). Then the call
+ * to CreateFileW() will merely open the directory that was already
+ * created rather than creating a new file. */
+ if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY &&
+ !path_is_root_of_drive(path)) {
+ if (!CreateDirectoryW(path, NULL)) {
+ err = GetLastError();
+ if (err != ERROR_ALREADY_EXISTS) {
+ ERROR("Failed to create directory \"%ls\"",
+ path);
+ win32_error(err);
+ return WIMLIB_ERR_MKDIR;
+ }
+ }
+ DEBUG("Created directory \"%ls\"", path);
+ *creationDisposition_ret = OPEN_EXISTING;
+ }
+ if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED &&
+ vol_flags & FILE_SUPPORTS_ENCRYPTION)
+ {
+ if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
+ if (!EncryptFile(path)) {
+ err = GetLastError();
+ ERROR("Failed to encrypt directory \"%ls\"",
+ path);
+ win32_error(err);
+ return WIMLIB_ERR_WRITE;
+ }
+ } else {
+ ret = do_win32_extract_encrypted_stream(path, lte);
if (ret)
return ret;
- } else {
- DEBUG("Cannot set reparse data on \"%ls\": volume "
- "does not support reparse points", path);
+ DEBUG("Extracted encrypted file \"%ls\"", path);
}
+ *creationDisposition_ret = OPEN_EXISTING;
}
+ /* Set file attributes if we created the file. Otherwise, we haven't
+ * created the file set and we will set the attributes in the call to
+ * CreateFileW().
+ *
+ * The FAT filesystem does not let you change the attributes of the root
+ * directory, so treat that as a special case and do not set attributes.
+ * */
+ if (*creationDisposition_ret == OPEN_EXISTING &&
+ !path_is_root_of_drive(path))
+ {
+ if (!SetFileAttributesW(path,
+ win32_mask_attributes(inode->i_attributes)))
+ {
+ err = GetLastError();
+ ERROR("Failed to set attributes on \"%ls\"", path);
+ win32_error(err);
+ return WIMLIB_ERR_WRITE;
+ }
+ }
return 0;
}
+/* Set security descriptor and extract stream data or reparse data (skip the
+ * unnamed data stream of encrypted files, which was already extracted). */
+static int
+win32_finish_extract_stream(HANDLE h, const struct wim_inode *inode,
+ const struct wim_lookup_table_entry *lte,
+ const wchar_t *stream_path,
+ const wchar_t *stream_name_utf16,
+ struct apply_args *args)
+{
+ int ret = 0;
+ if (stream_name_utf16 == NULL) {
+ /* Unnamed stream. */
+
+ /* Set security descriptor, unless the extract_flags indicate
+ * not to or the volume does not supported it. Note that this
+ * is only done when the unnamed stream is being extracted, as
+ * security descriptors are per-file and not per-stream. */
+ if (inode->i_security_id >= 0 &&
+ !(args->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS)
+ && (args->vol_flags & FILE_PERSISTENT_ACLS))
+ {
+ ret = win32_set_security_data(inode, h, stream_path, args);
+ if (ret)
+ return ret;
+ }
+
+ /* Handle reparse points. The data for them needs to be set
+ * using a special ioctl. Note that the reparse point may have
+ * been created using CreateFileW() in the case of
+ * non-directories or CreateDirectoryW() in the case of
+ * directories; but the ioctl works either way. Also, it is
+ * only this step that actually sets the
+ * FILE_ATTRIBUTE_REPARSE_POINT, as it is not valid to set it
+ * using SetFileAttributesW() or CreateFileW().
+ *
+ * If the volume does not support reparse points we simply
+ * ignore the reparse data. (N.B. the code currently doesn't
+ * actually reach this case because reparse points are skipped
+ * entirely on such volumes.) */
+ if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
+ if (args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS) {
+ DEBUG("Setting reparse data on \"%ls\"",
+ stream_path);
+ ret = win32_set_reparse_data(h,
+ inode->i_reparse_tag,
+ lte, stream_path);
+ if (ret)
+ return ret;
+ } else {
+ DEBUG("Cannot set reparse data on \"%ls\": volume "
+ "does not support reparse points", stream_path);
+ }
+ } else if (lte != NULL &&
+ !(args->vol_flags & FILE_SUPPORTS_ENCRYPTION &&
+ inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED))
+ {
+ /* Extract the data of the unnamed stream, unless the
+ * lookup table entry is NULL (indicating an empty
+ * stream for which no data needs to be extracted), or
+ * the stream is encrypted and therefore was already
+ * extracted as a special case. */
+ ret = do_win32_extract_stream(h, lte);
+ }
+ } else {
+ /* Extract the data for a named data stream. */
+ if (lte != NULL) {
+ DEBUG("Extracting named data stream \"%ls\" (len = %"PRIu64")",
+ stream_path, wim_resource_size(lte));
+ ret = do_win32_extract_stream(h, lte);
+ }
+ }
+ return ret;
+}
+
+static int
+win32_decrypt_file(HANDLE open_handle, const wchar_t *path)
+{
+ DWORD err;
+ /* We cannot call DecryptFileW() while there is an open handle to the
+ * file. So close it first. */
+ if (!CloseHandle(open_handle)) {
+ err = GetLastError();
+ ERROR("Failed to close handle for \"%ls\"", path);
+ win32_error(err);
+ return WIMLIB_ERR_WRITE;
+ }
+ if (!DecryptFileW(path, 0 /* reserved parameter; set to 0 */)) {
+ err = GetLastError();
+ ERROR("Failed to decrypt file \"%ls\"", path);
+ win32_error(err);
+ return WIMLIB_ERR_WRITE;
+ }
+ return 0;
+}
+
+/*
+ * Create and extract a stream to a file, or create a directory, using the
+ * Windows API.
+ *
+ * This handles reparse points, directories, alternate data streams, encrypted
+ * files, compressed files, etc.
+ *
+ * @inode: WIM inode containing the stream.
+ *
+ * @path: Path to extract the file to.
+ *
+ * @stream_name_utf16:
+ * Name of the stream, or NULL if the stream is unnamed. This will
+ * be called with a NULL stream_name_utf16 before any non-NULL
+ * stream_name_utf16's.
+ *
+ * @lte: WIM lookup table entry for the stream. May be NULL to indicate
+ * a stream of length 0.
+ *
+ * @args: Additional apply context, including flags indicating supported
+ * volume features.
+ *
+ * Returns 0 on success; nonzero on failure.
+ */
static int
win32_extract_stream(const struct wim_inode *inode,
const wchar_t *path,
const wchar_t *stream_name_utf16,
struct wim_lookup_table_entry *lte,
- unsigned vol_flags)
+ struct apply_args *args)
{
wchar_t *stream_path;
HANDLE h;
int ret;
DWORD err;
DWORD creationDisposition = CREATE_ALWAYS;
+ DWORD requestedAccess;
+ BY_HANDLE_FILE_INFORMATION file_info;
if (stream_name_utf16) {
/* Named stream. Create a buffer that contains the UTF-16LE
- * string [.\]@path:@stream_name_utf16. This is needed to
+ * string [./]path:stream_name_utf16. This is needed to
* create and open the stream using CreateFileW(). I'm not
* aware of any other APIs to do this. Note: the '$DATA' suffix
* seems to be unneeded. Additional note: a "./" prefix needs
* */
stream_path = (wchar_t*)path;
- /* Directories must be created with CreateDirectoryW(). Then
- * the call to CreateFileW() will merely open the directory that
- * was already created rather than creating a new file. */
- if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
- if (!CreateDirectoryW(stream_path, NULL)) {
- err = GetLastError();
- switch (err) {
- case ERROR_ALREADY_EXISTS:
- break;
- case ERROR_ACCESS_DENIED:
- if (path_is_root_of_drive(path))
- break;
- /* Fall through */
- default:
- ERROR("Failed to create directory \"%ls\"",
- stream_path);
- win32_error(err);
- ret = WIMLIB_ERR_MKDIR;
- goto fail;
- }
- }
- DEBUG("Created directory \"%ls\"", stream_path);
- if (!inode_has_special_attributes(inode)) {
- ret = 0;
- goto out;
- }
- DEBUG("Directory \"%ls\" has special attributes!",
- stream_path);
- creationDisposition = OPEN_EXISTING;
- }
+ ret = win32_begin_extract_unnamed_stream(inode, lte, path,
+ &creationDisposition,
+ args->vol_flags);
+ if (ret)
+ goto fail;
}
DEBUG("Opening \"%ls\"", stream_path);
+ requestedAccess = GENERIC_READ | GENERIC_WRITE |
+ ACCESS_SYSTEM_SECURITY;
+try_open_again:
+ /* Open the stream to be extracted. Depending on what we have set
+ * creationDisposition to, we may be creating this for the first time,
+ * or we may be opening on existing stream we already created using
+ * CreateDirectoryW() or OpenEncryptedFileRawW(). */
h = CreateFileW(stream_path,
- GENERIC_READ | GENERIC_WRITE,
+ requestedAccess,
0,
NULL,
creationDisposition,
NULL);
if (h == INVALID_HANDLE_VALUE) {
err = GetLastError();
+ if (err == ERROR_ACCESS_DENIED &&
+ path_is_root_of_drive(stream_path))
+ {
+ ret = 0;
+ goto out;
+ }
+ if ((err == ERROR_PRIVILEGE_NOT_HELD ||
+ err == ERROR_ACCESS_DENIED) &&
+ (requestedAccess & ACCESS_SYSTEM_SECURITY))
+ {
+ /* Try opening the file again without privilege to
+ * modify SACL. */
+ requestedAccess &= ~ACCESS_SYSTEM_SECURITY;
+ goto try_open_again;
+ }
ERROR("Failed to create \"%ls\"", stream_path);
win32_error(err);
ret = WIMLIB_ERR_OPEN;
goto fail;
}
- if (stream_name_utf16 == NULL && inode_has_special_attributes(inode)) {
- ret = win32_set_special_attributes(h, inode, lte, path,
- vol_flags);
+ /* Check the attributes of the file we just opened, and remove
+ * encryption or compression if either was set by default but is not
+ * supposed to be set based on the WIM inode attributes. */
+ if (!GetFileInformationByHandle(h, &file_info)) {
+ err = GetLastError();
+ ERROR("Failed to get attributes of \"%ls\"", stream_path);
+ win32_error(err);
+ ret = WIMLIB_ERR_STAT;
+ goto fail_close_handle;
+ }
+
+ /* Remove encryption? */
+ if (file_info.dwFileAttributes & FILE_ATTRIBUTE_ENCRYPTED &&
+ !(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED))
+ {
+ /* File defaulted to encrypted due to being in an encrypted
+ * directory, but is not actually supposed to be encrypted.
+ *
+ * This is a workaround, because I'm not aware of any way to
+ * directly (e.g. with CreateFileW()) create an unencrypted file
+ * in a directory with FILE_ATTRIBUTE_ENCRYPTED set. */
+ ret = win32_decrypt_file(h, stream_path);
if (ret)
- goto fail_close_handle;
+ goto fail; /* win32_decrypt_file() closed the handle. */
+ creationDisposition = OPEN_EXISTING;
+ goto try_open_again;
}
- if (!(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)) {
- if (lte) {
- DEBUG("Extracting \"%ls\" (len = %"PRIu64")",
- stream_path, wim_resource_size(lte));
- if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED
- && stream_name_utf16 == NULL
- && (vol_flags & FILE_SUPPORTS_ENCRYPTION))
- {
- ret = do_win32_extract_encrypted_stream(stream_path,
- lte);
- } else {
- ret = do_win32_extract_stream(h, lte);
- }
- if (ret)
- goto fail_close_handle;
- }
+ /* Remove compression? */
+ if (file_info.dwFileAttributes & FILE_ATTRIBUTE_COMPRESSED &&
+ !(inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED))
+ {
+ /* Similar to the encrypted case, above, if the file defaulted
+ * to compressed due to being in an compressed directory, but is
+ * not actually supposed to be compressed, explicitly set the
+ * compression format to COMPRESSION_FORMAT_NONE. */
+ ret = win32_set_compression_state(h, COMPRESSION_FORMAT_NONE,
+ stream_path);
+ if (ret)
+ goto fail_close_handle;
}
+ /* Set compression and/or sparse attributes if needed */
+ ret = win32_set_special_stream_attributes(h, inode, lte, path,
+ args->vol_flags);
+
+ if (ret)
+ goto fail_close_handle;
+
+ /* At this point we have at least created the needed stream with the
+ * appropriate attributes. We have yet to set the appropriate security
+ * descriptor and actually extract the stream data (other than for
+ * extracted files, which were already extracted).
+ * win32_finish_extract_stream() handles these additional steps. */
+ ret = win32_finish_extract_stream(h, inode, lte, stream_path,
+ stream_name_utf16, args);
+ if (ret)
+ goto fail_close_handle;
+
+ /* Done extracting the stream. Close the handle and return. */
DEBUG("Closing \"%ls\"", stream_path);
if (!CloseHandle(h)) {
err = GetLastError();
fail_close_handle:
CloseHandle(h);
fail:
- ERROR("Error extracting %ls", stream_path);
+ ERROR("Error extracting \"%ls\"", stream_path);
out:
return ret;
}
/*
* Creates a file, directory, or reparse point and extracts all streams to it
* (unnamed data stream and/or reparse point stream, plus any alternate data
- * streams). This in Win32-specific code.
+ * streams). Handles sparse, compressed, and/or encrypted files.
*
* @inode: WIM inode for this file or directory.
* @path: UTF-16LE external path to extract the inode to.
+ * @args: Additional extraction context.
*
* Returns 0 on success; nonzero on failure.
*/
static int
win32_extract_streams(const struct wim_inode *inode,
- const wchar_t *path, u64 *completed_bytes_p,
- unsigned vol_flags)
+ const wchar_t *path, struct apply_args *args)
{
struct wim_lookup_table_entry *unnamed_lte;
int ret;
+ /* First extract the unnamed stream. */
+
unnamed_lte = inode_unnamed_lte_resolved(inode);
- ret = win32_extract_stream(inode, path, NULL, unnamed_lte,
- vol_flags);
+ ret = win32_extract_stream(inode, path, NULL, unnamed_lte, args);
if (ret)
goto out;
- if (unnamed_lte)
- *completed_bytes_p += wim_resource_size(unnamed_lte);
- if (!(vol_flags & FILE_NAMED_STREAMS))
+ /* Extract any named streams, if supported by the volume. */
+
+ if (!(args->vol_flags & FILE_NAMED_STREAMS))
goto out;
for (u16 i = 0; i < inode->i_num_ads; i++) {
const struct wim_ads_entry *ads_entry = &inode->i_ads_entries[i];
- if (ads_entry->stream_name_nbytes != 0) {
- /* Skip special UNIX data entries (see documentation for
- * WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) */
- if (ads_entry->stream_name_nbytes == WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES
- && !memcmp(ads_entry->stream_name,
- WIMLIB_UNIX_DATA_TAG_UTF16LE,
- WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES))
- continue;
- ret = win32_extract_stream(inode,
- path,
- ads_entry->stream_name,
- ads_entry->lte,
- vol_flags);
- if (ret)
- break;
- if (ads_entry->lte)
- *completed_bytes_p += wim_resource_size(ads_entry->lte);
- }
+
+ /* Skip the unnamed stream if it's in the ADS entries (we
+ * already extracted it...) */
+ if (ads_entry->stream_name_nbytes == 0)
+ continue;
+
+ /* Skip special UNIX data entries (see documentation for
+ * WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) */
+ if (ads_entry->stream_name_nbytes == WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES
+ && !memcmp(ads_entry->stream_name,
+ WIMLIB_UNIX_DATA_TAG_UTF16LE,
+ WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES))
+ continue;
+
+ /* Extract the named stream */
+ ret = win32_extract_stream(inode,
+ path,
+ ads_entry->stream_name,
+ ads_entry->lte,
+ args);
+ if (ret)
+ break;
}
out:
return ret;
}
+/* If not done already, load the supported feature flags for the volume onto
+ * which the image is being extracted, and warn the user about any missing
+ * features that could be important. */
+static int
+win32_check_vol_flags(const wchar_t *output_path, struct apply_args *args)
+{
+ if (args->have_vol_flags)
+ return 0;
+
+ win32_get_vol_flags(output_path, &args->vol_flags);
+ args->have_vol_flags = true;
+ /* Warn the user about data that may not be extracted. */
+ if (!(args->vol_flags & FILE_SUPPORTS_SPARSE_FILES))
+ WARNING("Volume does not support sparse files!\n"
+ " Sparse files will be extracted as non-sparse.");
+ if (!(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS))
+ WARNING("Volume does not support reparse points!\n"
+ " Reparse point data will not be extracted.");
+ if (!(args->vol_flags & FILE_NAMED_STREAMS)) {
+ WARNING("Volume does not support named data streams!\n"
+ " Named data streams will not be extracted.");
+ }
+ if (!(args->vol_flags & FILE_SUPPORTS_ENCRYPTION)) {
+ WARNING("Volume does not support encryption!\n"
+ " Encrypted files will be extracted as raw data.");
+ }
+ if (!(args->vol_flags & FILE_FILE_COMPRESSION)) {
+ WARNING("Volume does not support transparent compression!\n"
+ " Compressed files will be extracted as non-compressed.");
+ }
+ if (!(args->vol_flags & FILE_PERSISTENT_ACLS)) {
+ if (args->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) {
+ ERROR("Strict ACLs requested, but the volume does not "
+ "support ACLs!");
+ return WIMLIB_ERR_VOLUME_LACKS_FEATURES;
+ } else {
+ WARNING("Volume does not support persistent ACLS!\n"
+ " File permissions will not be extracted.");
+ }
+ }
+ return 0;
+}
+
+/*
+ * Try extracting a hard link.
+ *
+ * @output_path: Path to link to be extracted.
+ *
+ * @inode: WIM inode that the link is to; inode->i_extracted_file
+ * the path to a name of the file that has already been
+ * extracted (we use this to create the hard link).
+ *
+ * @args: Additional apply context, used here to keep track of
+ * the number of times creating a hard link failed due to
+ * ERROR_INVALID_FUNCTION. This error should indicate that hard
+ * links are not supported by the volume, and we would like to
+ * warn the user a few times, but not too many times.
+ *
+ * Returns 0 if the hard link was successfully extracted. Returns
+ * WIMLIB_ERR_LINK (> 0) if an error occurred, other than hard links possibly
+ * being unsupported by the volume. Returns a negative value if creating the
+ * hard link failed due to ERROR_INVALID_FUNCTION.
+ */
+static int
+win32_try_hard_link(const wchar_t *output_path, const struct wim_inode *inode,
+ struct apply_args *args)
+{
+ DWORD err;
+
+ /* There is a volume flag for this (FILE_SUPPORTS_HARD_LINKS),
+ * but it's only available on Windows 7 and later. So no use
+ * even checking it, really. Instead, CreateHardLinkW() will
+ * apparently return ERROR_INVALID_FUNCTION if the volume does
+ * not support hard links. */
+ DEBUG("Creating hard link \"%ls => %ls\"",
+ output_path, inode->i_extracted_file);
+ if (CreateHardLinkW(output_path, inode->i_extracted_file, NULL))
+ return 0;
+
+ err = GetLastError();
+ if (err != ERROR_INVALID_FUNCTION) {
+ ERROR("Can't create hard link \"%ls => %ls\"",
+ output_path, inode->i_extracted_file);
+ win32_error(err);
+ return WIMLIB_ERR_LINK;
+ } else {
+ args->num_hard_links_failed++;
+ if (args->num_hard_links_failed < MAX_CREATE_HARD_LINK_WARNINGS) {
+ WARNING("Can't create hard link \"%ls => %ls\":\n"
+ " Volume does not support hard links!\n"
+ " Falling back to extracting a copy of the file.",
+ output_path, inode->i_extracted_file);
+ } else if (args->num_hard_links_failed == MAX_CREATE_HARD_LINK_WARNINGS) {
+ WARNING("Suppressing further hard linking warnings...");
+ }
+ return -1;
+ }
+}
+
/* Extract a file, directory, reparse point, or hard link to an
* already-extracted file using the Win32 API */
int
{
int ret;
struct wim_inode *inode = dentry->d_inode;
- DWORD err;
-
- if (!args->have_vol_flags) {
- win32_get_vol_flags(output_path, &args->vol_flags);
- args->have_vol_flags = true;
- /* Warn the user about data that may not be extracted. */
- if (!(args->vol_flags & FILE_SUPPORTS_SPARSE_FILES))
- WARNING("Volume does not support sparse files!\n"
- " Sparse files will be extracted as non-sparse.");
- if (!(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS))
- WARNING("Volume does not support reparse points!\n"
- " Reparse point data will not be extracted.");
- if (!(args->vol_flags & FILE_NAMED_STREAMS)) {
- WARNING("Volume does not support named data streams!\n"
- " Named data streams will not be extracted.");
- }
- if (!(args->vol_flags & FILE_SUPPORTS_ENCRYPTION)) {
- WARNING("Volume does not support encryption!\n"
- " Encrypted files will be extracted as raw data.");
- }
- if (!(args->vol_flags & FILE_FILE_COMPRESSION)) {
- WARNING("Volume does not support transparent compression!\n"
- " Compressed files will be extracted as non-compressed.");
- }
- if (!(args->vol_flags & FILE_PERSISTENT_ACLS)) {
- if (args->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) {
- ERROR("Strict ACLs requested, but the volume does not "
- "support ACLs!");
- return WIMLIB_ERR_VOLUME_LACKS_FEATURES;
- } else {
- WARNING("Volume does not support persistent ACLS!\n"
- " File permissions will not be extracted.");
- }
- }
- }
+ ret = win32_check_vol_flags(output_path, args);
+ if (ret)
+ return ret;
if (inode->i_nlink > 1 && inode->i_extracted_file != NULL) {
/* Linked file, with another name already extracted. Create a
* hard link. */
-
- /* There is a volume flag for this (FILE_SUPPORTS_HARD_LINKS),
- * but it's only available on Windows 7 and later. So no use
- * even checking it, really. Instead, CreateHardLinkW() will
- * apparently return ERROR_INVALID_FUNCTION if the volume does
- * not support hard links. */
- DEBUG("Creating hard link \"%ls => %ls\"",
- output_path, inode->i_extracted_file);
- if (CreateHardLinkW(output_path, inode->i_extracted_file, NULL))
- return 0;
-
- err = GetLastError();
- if (err != ERROR_INVALID_FUNCTION) {
- ERROR("Can't create hard link \"%ls => %ls\"",
- output_path, inode->i_extracted_file);
- win32_error(err);
- return WIMLIB_ERR_LINK;
- } else {
- WARNING("Can't create hard link \"%ls => %ls\":\n"
- " Volume does not support hard links!\n"
- " Falling back to extracting a copy of the file.");
- }
+ ret = win32_try_hard_link(output_path, inode, args);
+ if (ret >= 0)
+ return ret;
+ /* Negative return value from win32_try_hard_link() indicates
+ * that hard links are probably not supported by the volume.
+ * Fall back to extracting a copy of the file. */
}
- /* Create the file, directory, or reparse point, and extract the
- * data streams. */
- ret = win32_extract_streams(inode, output_path,
- &args->progress.extract.completed_bytes,
- args->vol_flags);
- if (ret)
- return ret;
- if (inode->i_security_id >= 0 &&
- !(args->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS)
- && (args->vol_flags & FILE_PERSISTENT_ACLS))
+ /* If this is a reparse point and the volume does not support reparse
+ * points, just skip it completely. */
+ if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT &&
+ !(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS))
{
- ret = win32_set_security_data(inode, output_path, args);
+ WARNING("Skipping extraction of reparse point \"%ls\":\n"
+ " Not supported by destination filesystem",
+ output_path);
+ } else {
+ /* Create the file, directory, or reparse point, and extract the
+ * data streams. */
+ ret = win32_extract_streams(inode, output_path, args);
if (ret)
return ret;
}
- if (inode->i_nlink > 1) {
- /* Save extracted path for a later call to
- * CreateHardLinkW() if this inode has multiple links.
- * */
- inode->i_extracted_file = WSTRDUP(output_path);
- if (!inode->i_extracted_file)
- ret = WIMLIB_ERR_NOMEM;
+ if (inode->i_extracted_file == NULL) {
+ const struct wim_lookup_table_entry *lte;
+
+ /* Tally bytes extracted, including all alternate data streams,
+ * unless we extracted a hard link (or, at least extracted a
+ * name that was supposed to be a hard link) */
+ for (unsigned i = 0; i <= inode->i_num_ads; i++) {
+ lte = inode_stream_lte_resolved(inode, i);
+ if (lte)
+ args->progress.extract.completed_bytes +=
+ wim_resource_size(lte);
+ }
+ if (inode->i_nlink > 1) {
+ /* Save extracted path for a later call to
+ * CreateHardLinkW() if this inode has multiple links.
+ * */
+ inode->i_extracted_file = WSTRDUP(output_path);
+ if (!inode->i_extracted_file)
+ return WIMLIB_ERR_NOMEM;
+ }
}
return 0;
}
HANDLE h;
const struct wim_inode *inode = dentry->d_inode;
+ if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT &&
+ !(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS))
+ {
+ /* Skip reparse points not extracted */
+ return 0;
+ }
+
+ /* Windows doesn't let you change the timestamps of the root directory
+ * (at least on FAT, which is dumb but expected since FAT doesn't store
+ * any metadata about the root directory...) */
+ if (path_is_root_of_drive(path))
+ return 0;
+
DEBUG("Opening \"%ls\" to set timestamps", path);
h = win32_open_existing_file(path, FILE_WRITE_ATTRIBUTES);
if (h == INVALID_HANDLE_VALUE) {