+/*
+ * ntfs-apply.c
+ *
+ * Apply a WIM image to a NTFS volume, restoring everything we can, including
+ * security data and alternate data streams. There should be no loss of
+ * information.
+ */
+
/*
* Copyright (C) 2012 Eric Biggers
*
#ifdef WITH_NTFS_3G
#include "dentry.h"
#include "lookup_table.h"
+#include "io.h"
#include <ntfs-3g/layout.h>
#include <ntfs-3g/acls.h>
#include <ntfs-3g/attrib.h>
u32 selection, const char *attr);
extern int _ntfs_set_file_attributes(ntfs_inode *ni, s32 attrib);
-static int extract_resource_to_ntfs_attr(WIMStruct *w, const struct resource_entry *entry,
- ntfs_attr *na)
+/*
+ * Extracts a WIM resource to a NTFS attribute.
+ */
+static int
+extract_wim_resource_to_ntfs_attr(const struct lookup_table_entry *lte,
+ ntfs_attr *na)
{
- u8 buf[min(entry->original_size, WIM_CHUNK_SIZE)];
- u64 num_chunks = (entry->original_size + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE;
- u64 n = WIM_CHUNK_SIZE;
- int res_ctype = wim_resource_compression_type(w, entry);
+ u64 bytes_remaining = wim_resource_size(lte);
+ char buf[min(WIM_CHUNK_SIZE, bytes_remaining)];
u64 offset = 0;
- for (u64 i = 0; i < num_chunks; i++) {
- DEBUG("Write chunk %u of %u", i + 1, num_chunks);
- int ret;
- if (i == num_chunks - 1) {
- n = entry->original_size % WIM_CHUNK_SIZE;
- if (n == 0) {
- n = WIM_CHUNK_SIZE;
- }
- }
+ int ret = 0;
+ u8 hash[SHA1_HASH_SIZE];
- ret = read_resource(w->fp, entry->size, entry->original_size,
- entry->offset, res_ctype, n, offset, buf);
- if (ret != 0)
- return ret;
+ SHA_CTX ctx;
+ sha1_init(&ctx);
- if (ntfs_attr_pwrite(na, offset, n, buf) != n) {
- ERROR("Failed to write to NTFS data stream");
+ while (bytes_remaining) {
+ u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE);
+ ret = read_wim_resource(lte, buf, to_read, offset, false);
+ if (ret != 0)
+ break;
+ sha1_update(&ctx, buf, to_read);
+ if (ntfs_attr_pwrite(na, offset, to_read, buf) != to_read) {
+ ERROR_WITH_ERRNO("Error extracting WIM resource");
return WIMLIB_ERR_WRITE;
}
- offset += n;
+ bytes_remaining -= to_read;
+ offset += to_read;
+ }
+ sha1_final(hash, &ctx);
+ if (!hashes_equal(hash, lte->hash)) {
+ ERROR("Invalid checksum on a WIM resource "
+ "(detected when extracting to NTFS stream file)");
+ ERROR("The following WIM resource is invalid:");
+ print_lookup_table_entry(lte);
+ return WIMLIB_ERR_INVALID_RESOURCE_HASH;
}
return 0;
}
+/* Writes the data streams to a NTFS file
+ *
+ * @ni: The NTFS inode for the file.
+ * @dentry: The directory entry in the WIM file.
+ * @w: The WIMStruct for the WIM containing the image we are applying.
+ *
+ * Returns 0 on success, nonzero on failure.
+ */
static int write_ntfs_data_streams(ntfs_inode *ni, const struct dentry *dentry,
WIMStruct *w)
{
- ntfs_attr *na;
- struct lookup_table_entry *lte;
- int ret;
-
+ int ret = 0;
+ unsigned stream_idx = 0;
+ ntfschar *stream_name = AT_UNNAMED;
+ u32 stream_name_len = 0;
DEBUG("Writing NTFS data streams for `%s'", dentry->full_path_utf8);
- wimlib_assert(dentry->num_ads == 0);
-
- lte = dentry_stream_lte(dentry, 0, w->lookup_table);
- if (lte && lte->resource_entry.original_size != 0) {
+ while (1) {
+ struct lookup_table_entry *lte;
+ ntfs_attr *na;
- na = ntfs_attr_open(ni, AT_DATA, AT_UNNAMED, 0);
+ lte = dentry_stream_lte(dentry, 0, w->lookup_table);
+ na = ntfs_attr_open(ni, AT_DATA, stream_name, stream_name_len);
if (!na) {
- ERROR_WITH_ERRNO("Failed to open unnamed data stream of "
+ ERROR_WITH_ERRNO("Failed to open a data stream of "
"extracted file `%s'",
dentry->full_path_utf8);
- return WIMLIB_ERR_NTFS_3G;
+ ret = WIMLIB_ERR_NTFS_3G;
+ break;
}
- ret = extract_resource_to_ntfs_attr(w, <e->resource_entry, na);
- if (ret != 0)
- return ret;
+ if (lte && wim_resource_size(lte) != 0)
+ ret = extract_wim_resource_to_ntfs_attr(lte, na);
ntfs_attr_close(na);
+ if (ret != 0)
+ break;
+ if (stream_idx == dentry->num_ads)
+ break;
+ stream_name = (ntfschar*)dentry->ads_entries[stream_idx].stream_name;
+ stream_name_len = dentry->ads_entries[stream_idx].stream_name_len / 2;
+ stream_idx++;
+ }
+ return ret;
+}
+
+/*
+ * Makes a NTFS hard link
+ *
+ * It is named @from_dentry->file_name and is located under the directory
+ * specified by @dir_ni, and it is made to point to the previously extracted
+ * file located at @to_dentry->extracted_file.
+ *
+ * Return 0 on success, nonzero on failure.
+ */
+static int wim_apply_hardlink_ntfs(const struct dentry *from_dentry,
+ const struct dentry *to_dentry,
+ ntfs_inode *dir_ni)
+{
+ int ret;
+ ntfs_inode *to_ni;
+
+ DEBUG("Extracting NTFS hard link `%s' => `%s'",
+ from_dentry->full_path_utf8, to_dentry->extracted_file);
+
+ to_ni = ntfs_pathname_to_inode(dir_ni->vol, NULL,
+ to_dentry->extracted_file);
+ if (!to_ni) {
+ ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
+ to_dentry->extracted_file);
+ return WIMLIB_ERR_NTFS_3G;
+ }
+ ret = ntfs_link(to_ni, dir_ni,
+ (ntfschar*)from_dentry->file_name,
+ from_dentry->file_name_len / 2);
+ if (ret != 0) {
+ ERROR_WITH_ERRNO("Could not create hard link `%s' => `%s'",
+ from_dentry->full_path_utf8,
+ to_dentry->extracted_file);
+ ret = WIMLIB_ERR_NTFS_3G;
+ }
+ if (ntfs_inode_close(to_ni) != 0) {
+ ERROR_WITH_ERRNO("Failed to close NTFS inode for `%s'",
+ to_dentry->extracted_file);
+ ret = WIMLIB_ERR_NTFS_3G;
+ }
+ return ret;
+}
+
+static int
+apply_file_attributes_and_security_data(ntfs_inode *ni,
+ const struct dentry *dentry,
+ const WIMStruct *w)
+{
+ DEBUG("Setting NTFS file attributes on `%s' to %#"PRIx32,
+ dentry->full_path_utf8, dentry->attributes);
+ if (!_ntfs_set_file_attributes(ni, dentry->attributes)) {
+ ERROR("Failed to set NTFS file attributes on `%s'",
+ dentry->full_path_utf8);
+ return WIMLIB_ERR_NTFS_3G;
}
+ if (dentry->security_id != -1) {
+ const struct wim_security_data *sd;
+
+ sd = wim_const_security_data(w);
+ wimlib_assert(dentry->security_id < sd->num_entries);
+ DEBUG("Applying security descriptor %d to `%s'",
+ dentry->security_id, dentry->full_path_utf8);
+ if (!_ntfs_set_file_security(ni->vol, ni, ~0,
+ sd->descriptors[dentry->security_id]))
+ {
+ ERROR_WITH_ERRNO("Failed to set security data on `%s'",
+ dentry->full_path_utf8);
+ return WIMLIB_ERR_NTFS_3G;
+ }
+ }
+ return 0;
+}
+
+static int apply_reparse_data(ntfs_inode *ni, const struct dentry *dentry,
+ const WIMStruct *w)
+{
+ struct lookup_table_entry *lte;
+ int ret = 0;
+
+ wimlib_assert(dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT);
+
+ lte = dentry_first_lte(dentry, w->lookup_table);
+
+ if (!lte) {
+ ERROR("Could not find reparse data for `%s'",
+ dentry->full_path_utf8);
+ return WIMLIB_ERR_INVALID_DENTRY;
+ }
+
+ if (wim_resource_size(lte) >= 0xffff) {
+ ERROR("Reparse data of `%s' is too long (%lu bytes)",
+ dentry->full_path_utf8, wim_resource_size(lte));
+ return WIMLIB_ERR_INVALID_DENTRY;
+ }
+
+ char reparse_data_buf[8 + wim_resource_size(lte)];
+ char *p = reparse_data_buf;
+ p = put_u32(p, dentry->reparse_tag); /* ReparseTag */
+ p = put_u16(p, wim_resource_size(lte)); /* ReparseDataLength */
+ p = put_u16(p, 0); /* Reserved */
+
+ ret = read_full_wim_resource(lte, p);
+ if (ret != 0)
+ return ret;
+
+ ret = ntfs_set_ntfs_reparse_data(ni, reparse_data_buf,
+ wim_resource_size(lte) + 8, 0);
+ if (ret != 0) {
+ ERROR_WITH_ERRNO("Failed to set NTFS reparse data on `%s'",
+ dentry->full_path_utf8);
+ return WIMLIB_ERR_NTFS_3G;
+ }
return 0;
}
*
* @return: 0 on success; nonzero on failure.
*/
-static int __ntfs_apply_dentry(struct dentry *dentry, ntfs_inode *dir_ni,
- WIMStruct *w)
+static int do_wim_apply_dentry_ntfs(struct dentry *dentry, ntfs_inode *dir_ni,
+ WIMStruct *w)
{
ntfs_inode *ni;
- int ret;
+ int ret = 0;
mode_t type;
- print_dentry(dentry, w->lookup_table);
-
- if (dentry_is_directory(dentry))
+ if (dentry_is_directory(dentry)) {
type = S_IFDIR;
- else
+ } else {
type = S_IFREG;
+ const struct list_head *head = &dentry->link_group_list;
+ if (head->next != head) {
+ /* This dentry is one of a hard link set of at least 2
+ * dentries. If one of the other dentries has already
+ * been extracted, make a hard link to the file
+ * corresponding to this already-extracted directory.
+ * Otherwise, extract the file, and set the
+ * dentry->extracted_file field so that other dentries
+ * in the hard link group can link to it. */
+ struct dentry *other;
+ list_for_each_entry(other, head, link_group_list) {
+ if (other->extracted_file) {
+ return wim_apply_hardlink_ntfs(
+ dentry, other, dir_ni);
+ }
+ }
+ }
+ FREE(dentry->extracted_file);
+ dentry->extracted_file = STRDUP(dentry->full_path_utf8);
+ if (!dentry->extracted_file) {
+ ERROR("Failed to allocate memory for filename");
+ return WIMLIB_ERR_NOMEM;
+ }
+ }
+ /*
+ * Create a directory or file.
+ *
+ * Note: if it's a reparse point (such as a symbolic link), we still
+ * pass S_IFREG here, since we manually set the reparse data later.
+ */
ni = ntfs_create(dir_ni, 0, (ntfschar*)dentry->file_name,
dentry->file_name_len / 2, type);
goto out;
}
+ /* Write the data streams, unless this is a directory or reparse point
+ * */
if (!dentry_is_directory(dentry) &&
!(dentry->attributes & FILE_ATTRIBUTE_REPARSE_POINT)) {
ret = write_ntfs_data_streams(ni, dentry, w);
goto out;
}
- DEBUG("Setting file attributes 0x%x on `%s'",
- dentry->attributes,
- dentry->full_path_utf8);
- if (!_ntfs_set_file_attributes(ni, dentry->attributes)) {
- ERROR("Failed to set NTFS file attributes on `%s'",
- dentry->full_path_utf8);
- ret = WIMLIB_ERR_NTFS_3G;
+ ret = apply_file_attributes_and_security_data(ni, dentry, w);
+ if (ret != 0)
goto out;
- }
-
- if (dentry->security_id != -1) {
- const struct wim_security_data *sd = wim_security_data(w);
- wimlib_assert(dentry->security_id < sd->num_entries);
- DEBUG("Applying security descriptor %d to `%s'",
- dentry->security_id, dentry->full_path_utf8);
- if (!_ntfs_set_file_security(ni->vol, ni, ~0,
- sd->descriptors[dentry->security_id]))
- {
- ERROR_WITH_ERRNO("Failed to set security data on `%s'",
- dentry->full_path_utf8);
- ret = WIMLIB_ERR_NTFS_3G;
- goto out;
- }
- }
if (dentry->attributes & FILE_ATTR_REPARSE_POINT) {
- struct lookup_table_entry *lte;
- ntfs_inode *ni;
- lte = dentry_first_lte(dentry, w->lookup_table);
- if (!lte) {
- ERROR("Could not find reparse data for `%s'",
- dentry->full_path_utf8);
- ret = WIMLIB_ERR_INVALID_DENTRY;
- goto out;
- }
-
- ret = ntfs_set_ntfs_reparse_data(ni, lte->symlink_buf,
- lte->resource_entry.original_size,
- 0);
- if (ret != 0) {
- ERROR_WITH_ERRNO("Failed to set NTFS reparse data on "
- "`%s'", dentry->full_path_utf8);
- ret = WIMLIB_ERR_NTFS_3G;
+ ret = apply_reparse_data(ni, dentry, w);
+ if (ret != 0)
goto out;
- }
}
if (ntfs_inode_close_in_dir(ni, dir_ni) != 0) {
return ret;
}
-static int ntfs_apply_dentry(struct dentry *dentry, void *arg)
+static int wim_apply_root_dentry_ntfs(const struct dentry *dentry,
+ ntfs_volume *vol,
+ const WIMStruct *w)
+{
+ ntfs_inode *ni;
+ int ret = 0;
+
+ wimlib_assert(dentry_is_directory(dentry));
+ ni = ntfs_pathname_to_inode(vol, NULL, "/");
+ if (!ni) {
+ ERROR_WITH_ERRNO("Could not find root NTFS inode");
+ return WIMLIB_ERR_NTFS_3G;
+ }
+ ret = apply_file_attributes_and_security_data(ni, dentry, w);
+ if (ntfs_inode_close(ni) != 0) {
+ ERROR_WITH_ERRNO("Failed to close NTFS inode for root "
+ "directory");
+ ret = WIMLIB_ERR_NTFS_3G;
+ }
+ return ret;
+}
+
+/* Applies a WIM dentry to the NTFS volume */
+static int wim_apply_dentry_ntfs(struct dentry *dentry, void *arg)
{
struct ntfs_apply_args *args = arg;
ntfs_volume *vol = args->vol;
WIMStruct *w = args->w;
ntfs_inode *dir_ni;
int ret;
+ char *p;
+ char orig;
+ const char *dir_name;
- DEBUG("Applying `%s'", dentry->full_path_utf8);
+ wimlib_assert(dentry->full_path_utf8);
- if (dentry_is_root(dentry))
- return 0;
+ DEBUG("Applying dentry `%s' to NTFS", dentry->full_path_utf8);
- if (extract_flags & WIMLIB_EXTRACT_FLAG_VERBOSE) {
- wimlib_assert(dentry->full_path_utf8);
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_VERBOSE)
puts(dentry->full_path_utf8);
- }
- char *p = dentry->full_path_utf8 + dentry->full_path_utf8_len;
+ if (dentry_is_root(dentry))
+ return wim_apply_root_dentry_ntfs(dentry, vol, w);
+
+ p = dentry->full_path_utf8 + dentry->full_path_utf8_len;
do {
p--;
} while (*p != '/');
- char orig = *p;
+ orig = *p;
*p = '\0';
- const char *dir_name = dentry->full_path_utf8;
+ dir_name = dentry->full_path_utf8;
dir_ni = ntfs_pathname_to_inode(vol, NULL, dir_name);
*p = orig;
}
DEBUG("Found NTFS inode for `%s'", dir_name);
- ret = __ntfs_apply_dentry(dentry, dir_ni, w);
+ ret = do_wim_apply_dentry_ntfs(dentry, dir_ni, w);
if (ntfs_inode_close(dir_ni) != 0) {
if (ret == 0)
}
-static int do_ntfs_apply(WIMStruct *w, const char *device, int extract_flags)
+static int do_wim_apply_image_ntfs(WIMStruct *w, const char *device, int extract_flags)
{
ntfs_volume *vol;
int ret;
.extract_flags = extract_flags,
.w = w,
};
- ret = for_dentry_in_tree(wim_root_dentry(w), ntfs_apply_dentry,
+ ret = for_dentry_in_tree(wim_root_dentry(w), wim_apply_dentry_ntfs,
&args);
if (ntfs_umount(vol, FALSE) != 0) {
- ERROR_WITH_ERRNO("Failed to unmount NTFS volume");
+ ERROR_WITH_ERRNO("Failed to unmount NTFS volume `%s'", device);
if (ret == 0)
ret = WIMLIB_ERR_NTFS_3G;
}
return ret;
}
+
+/*
+ * API entry point for applying a WIM image to a NTFS volume.
+ *
+ * Please note that this is a NTFS *volume* and not a directory. The intention
+ * is that the volume contain an empty filesystem, and the WIM image contain a
+ * full filesystem to be applied to the volume.
+ */
WIMLIBAPI int wimlib_apply_image_to_ntfs_volume(WIMStruct *w, int image,
const char *device, int flags)
{
return WIMLIB_ERR_INVALID_PARAM;
}
if (flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK)) {
- ERROR("Cannot specifcy symlink or hardlink flags when applying ");
+ ERROR("Cannot specify symlink or hardlink flags when applying ");
ERROR("directly to a NTFS volume");
return WIMLIB_ERR_INVALID_PARAM;
}
return WIMLIB_ERR_NOT_ROOT;
}
#endif
- return do_ntfs_apply(w, device, flags);
+ return do_wim_apply_image_ntfs(w, device, flags);
}
#else /* WITH_NTFS_3G */