4 * Capture a WIM image directly from an NTFS volume using libntfs-3g. We capture
5 * everything we can, including security data and alternate data streams.
9 * Copyright (C) 2012, 2013, 2014, 2015 Eric Biggers
11 * This file is free software; you can redistribute it and/or modify it under
12 * the terms of the GNU Lesser General Public License as published by the Free
13 * Software Foundation; either version 3 of the License, or (at your option) any
16 * This file is distributed in the hope that it will be useful, but WITHOUT
17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this file; if not, see http://www.gnu.org/licenses/.
33 #include <ntfs-3g/attrib.h>
34 #include <ntfs-3g/reparse.h>
35 #include <ntfs-3g/security.h>
36 #include <ntfs-3g/volume.h>
38 #include "wimlib/alloca.h"
39 #include "wimlib/assert.h"
40 #include "wimlib/blob_table.h"
41 #include "wimlib/capture.h"
42 #include "wimlib/dentry.h"
43 #include "wimlib/encoding.h"
44 #include "wimlib/endianness.h"
45 #include "wimlib/error.h"
46 #include "wimlib/ntfs_3g.h"
47 #include "wimlib/paths.h"
48 #include "wimlib/reparse.h"
49 #include "wimlib/security.h"
51 /* A reference-counted NTFS volume than is automatically unmounted when the
52 * reference count reaches 0 */
53 struct ntfs_volume_wrapper {
58 /* Description of where data is located in an NTFS volume */
59 struct ntfs_location {
60 struct ntfs_volume_wrapper *volume;
64 utf16lechar *attr_name;
68 static struct ntfs_volume_wrapper *
69 get_ntfs_volume(struct ntfs_volume_wrapper *volume)
76 put_ntfs_volume(struct ntfs_volume_wrapper *volume)
78 if (--volume->refcnt == 0) {
79 ntfs_umount(volume->vol, FALSE);
84 static inline const ntfschar *
85 attr_record_name(const ATTR_RECORD *record)
87 return (const ntfschar *)
88 ((const u8 *)record + le16_to_cpu(record->name_offset));
92 open_ntfs_attr(ntfs_inode *ni, const struct ntfs_location *loc)
96 na = ntfs_attr_open(ni, loc->attr_type, loc->attr_name,
97 loc->attr_name_nchars);
99 ERROR_WITH_ERRNO("Failed to open attribute of NTFS inode %"PRIu64,
106 read_ntfs_attribute_prefix(const struct blob_descriptor *blob, u64 size,
107 const struct read_blob_callbacks *cbs)
109 const struct ntfs_location *loc = blob->ntfs_loc;
110 ntfs_volume *vol = loc->volume->vol;
118 ni = ntfs_inode_open(vol, loc->mft_no);
120 ERROR_WITH_ERRNO("Failed to open NTFS inode %"PRIu64,
122 ret = WIMLIB_ERR_NTFS_3G;
126 na = open_ntfs_attr(ni, loc);
128 ret = WIMLIB_ERR_NTFS_3G;
129 goto out_close_ntfs_inode;
132 pos = (loc->attr_type == AT_REPARSE_POINT) ? REPARSE_DATA_OFFSET : 0;
133 bytes_remaining = size;
134 while (bytes_remaining) {
135 s64 to_read = min(bytes_remaining, sizeof(buf));
136 if (ntfs_attr_pread(na, pos, to_read, buf) != to_read) {
137 ERROR_WITH_ERRNO("Error reading data from NTFS inode "
138 "%"PRIu64, loc->mft_no);
139 ret = WIMLIB_ERR_NTFS_3G;
140 goto out_close_ntfs_attr;
143 bytes_remaining -= to_read;
144 ret = call_consume_chunk(buf, to_read, cbs);
146 goto out_close_ntfs_attr;
151 out_close_ntfs_inode:
152 ntfs_inode_close(ni);
158 free_ntfs_location(struct ntfs_location *loc)
160 put_ntfs_volume(loc->volume);
161 FREE(loc->attr_name);
165 struct ntfs_location *
166 clone_ntfs_location(const struct ntfs_location *loc)
168 struct ntfs_location *new = memdup(loc, sizeof(*loc));
171 if (loc->attr_name) {
172 new->attr_name = utf16le_dup(loc->attr_name);
176 new->volume = get_ntfs_volume(loc->volume);
186 cmp_ntfs_locations(const struct ntfs_location *loc1,
187 const struct ntfs_location *loc2)
189 return cmp_u64(loc1->sort_key, loc2->sort_key);
192 /* Read rptag and rpreserved from the NTFS inode and save them in the WIM inode.
195 read_reparse_header(ntfs_inode *ni, struct wim_inode *inode)
205 na = ntfs_attr_open(ni, AT_REPARSE_POINT, AT_UNNAMED, 0);
207 return WIMLIB_ERR_NTFS_3G;
209 res = ntfs_attr_pread(na, 0, sizeof(hdr), &hdr);
213 if (res != sizeof(hdr))
214 return WIMLIB_ERR_NTFS_3G;
216 inode->i_reparse_tag = le32_to_cpu(hdr.rptag);
217 inode->i_rp_reserved = le16_to_cpu(hdr.rpreserved);
222 attr_type_to_wimlib_stream_type(ATTR_TYPES type)
226 return STREAM_TYPE_DATA;
227 case AT_REPARSE_POINT:
228 return STREAM_TYPE_REPARSE_POINT;
231 return STREAM_TYPE_UNKNOWN;
235 /* When sorting blobs located in NTFS volumes for sequential reading, we sort
236 * first by starting LCN of the attribute if available, otherwise no sort order
237 * is defined. This usually results in better sequential access to the volume.
240 set_attr_sort_key(ntfs_inode *ni, struct ntfs_location *loc)
245 na = open_ntfs_attr(ni, loc);
247 return WIMLIB_ERR_NTFS_3G;
249 rl = ntfs_attr_find_vcn(na, 0);
250 if (rl && rl->lcn != LCN_HOLE)
251 loc->sort_key = rl->lcn;
259 /* Save information about an NTFS attribute (stream) to a WIM inode. */
261 scan_ntfs_attr(struct wim_inode *inode,
265 struct list_head *unhashed_blobs,
266 struct ntfs_volume_wrapper *volume,
268 const ATTR_RECORD *record)
270 u64 data_size = ntfs_get_attribute_value_length(record);
271 const u32 name_nchars = record->name_length;
272 struct blob_descriptor *blob = NULL;
273 utf16lechar *stream_name = NULL;
274 struct wim_inode_stream *strm;
277 if (unlikely(name_nchars)) {
279 stream_name = utf16le_dupz(attr_record_name(record),
280 name_nchars * sizeof(ntfschar));
282 ret = WIMLIB_ERR_NOMEM;
287 if (unlikely(type == AT_REPARSE_POINT)) {
288 if (data_size < REPARSE_DATA_OFFSET) {
289 ERROR("Reparse point attribute of \"%s\" "
290 "is too short!", path);
291 ret = WIMLIB_ERR_INVALID_REPARSE_DATA;
294 data_size -= REPARSE_DATA_OFFSET;
296 ret = read_reparse_header(ni, inode);
298 ERROR_WITH_ERRNO("Error reading reparse point header "
304 /* If the stream is non-empty, set up a blob descriptor for it. */
305 if (data_size != 0) {
306 blob = new_blob_descriptor();
307 if (unlikely(!blob)) {
308 ret = WIMLIB_ERR_NOMEM;
312 blob->ntfs_loc = CALLOC(1, sizeof(struct ntfs_location));
313 if (unlikely(!blob->ntfs_loc)) {
314 ret = WIMLIB_ERR_NOMEM;
318 blob->blob_location = BLOB_IN_NTFS_VOLUME;
319 blob->size = data_size;
320 blob->ntfs_loc->volume = get_ntfs_volume(volume);
321 blob->ntfs_loc->attr_type = type;
322 blob->ntfs_loc->mft_no = ni->mft_no;
324 if (unlikely(name_nchars)) {
325 blob->ntfs_loc->attr_name = utf16le_dup(stream_name);
326 if (!blob->ntfs_loc->attr_name) {
327 ret = WIMLIB_ERR_NOMEM;
330 blob->ntfs_loc->attr_name_nchars = name_nchars;
333 ret = set_attr_sort_key(ni, blob->ntfs_loc);
338 strm = inode_add_stream(inode,
339 attr_type_to_wimlib_stream_type(type),
340 stream_name ? stream_name : NO_STREAM_NAME,
342 if (unlikely(!strm)) {
343 ret = WIMLIB_ERR_NOMEM;
346 prepare_unhashed_blob(blob, inode, strm->stream_id, unhashed_blobs);
350 free_blob_descriptor(blob);
355 /* Scan attributes of the specified type from a file in the NTFS volume */
357 scan_ntfs_attrs_with_type(struct wim_inode *inode,
361 struct list_head *unhashed_blobs,
362 struct ntfs_volume_wrapper *volume,
365 ntfs_attr_search_ctx *actx;
368 actx = ntfs_attr_get_search_ctx(ni, NULL);
370 ERROR_WITH_ERRNO("Failed to get NTFS attribute search "
371 "context for \"%s\"", path);
372 return WIMLIB_ERR_NTFS_3G;
375 while (!ntfs_attr_lookup(type, NULL, 0,
376 CASE_SENSITIVE, 0, NULL, 0, actx))
378 ret = scan_ntfs_attr(inode,
389 if (errno != ENOENT) {
390 ERROR_WITH_ERRNO("Error listing NTFS attributes of \"%s\"", path);
391 ret = WIMLIB_ERR_NTFS_3G;
396 ntfs_attr_put_search_ctx(actx);
400 /* Load the security descriptor of an NTFS inode into the corresponding WIM
401 * inode and the WIM image's security descriptor set. */
402 static noinline_for_stack int
403 get_security_descriptor(ntfs_inode *ni, struct wim_inode *inode,
404 ntfs_volume *vol, struct wim_sd_set *sd_set)
406 struct SECURITY_CONTEXT scx = {.vol = vol};
409 size_t avail_size = sizeof(_buf);
413 ret = ntfs_get_ntfs_acl(&scx, ni, buf, avail_size);
414 if (unlikely(ret < 0)) {
415 ret = WIMLIB_ERR_NTFS_3G;
419 if (unlikely(ret > avail_size)) {
420 if (unlikely(buf != _buf))
424 ret = WIMLIB_ERR_NOMEM;
431 if (likely(ret > 0)) {
432 inode->i_security_id = sd_set_add_sd(sd_set, buf, ret);
433 if (unlikely(inode->i_security_id < 0)) {
434 ret = WIMLIB_ERR_NOMEM;
441 if (unlikely(buf != _buf))
446 /* Binary tree that maps NTFS inode numbers to DOS names */
447 struct dos_name_map {
448 struct avl_tree_node *root;
451 struct dos_name_node {
452 struct avl_tree_node index_node;
458 #define DOS_NAME_NODE(avl_node) \
459 avl_tree_entry(avl_node, struct dos_name_node, index_node)
462 _avl_cmp_by_ntfs_ino(const struct avl_tree_node *n1,
463 const struct avl_tree_node *n2)
465 return cmp_u64(DOS_NAME_NODE(n1)->ntfs_ino,
466 DOS_NAME_NODE(n2)->ntfs_ino);
469 /* Inserts a new DOS name into the map */
471 insert_dos_name(struct dos_name_map *map, const ntfschar *dos_name,
472 size_t name_nbytes, u64 ntfs_ino)
474 struct dos_name_node *new_node;
476 new_node = MALLOC(sizeof(struct dos_name_node));
478 return WIMLIB_ERR_NOMEM;
480 /* DOS names are supposed to be 12 characters max (that's 24 bytes,
481 * assuming 2-byte ntfs characters) */
482 wimlib_assert(name_nbytes <= sizeof(new_node->dos_name));
484 /* Initialize the DOS name, DOS name length, and NTFS inode number of
485 * the search tree node */
486 memcpy(new_node->dos_name, dos_name, name_nbytes);
487 new_node->name_nbytes = name_nbytes;
488 new_node->ntfs_ino = ntfs_ino;
490 /* Insert the search tree node */
491 if (avl_tree_insert(&map->root, &new_node->index_node,
492 _avl_cmp_by_ntfs_ino))
494 /* This should be impossible since an NTFS inode cannot have
495 * multiple DOS names, and we only should get each DOS name
496 * entry once from the ntfs_readdir() calls. */
497 WARNING("NTFS inode %"PRIu64" has multiple DOS names", ntfs_ino);
503 /* Returns a structure that contains the DOS name and its length for an NTFS
504 * inode, or NULL if the inode has no DOS name. */
505 static struct dos_name_node *
506 lookup_dos_name(const struct dos_name_map *map, u64 ntfs_ino)
508 struct dos_name_node dummy;
509 struct avl_tree_node *res;
511 dummy.ntfs_ino = ntfs_ino;
513 res = avl_tree_lookup_node(map->root, &dummy.index_node,
514 _avl_cmp_by_ntfs_ino);
517 return DOS_NAME_NODE(res);
521 set_dentry_dos_name(struct wim_dentry *dentry, const struct dos_name_map *map)
523 const struct dos_name_node *node;
525 if (dentry->d_is_win32_name) {
526 node = lookup_dos_name(map, dentry->d_inode->i_ino);
528 dentry->d_short_name = utf16le_dupz(node->dos_name,
530 if (!dentry->d_short_name)
531 return WIMLIB_ERR_NOMEM;
532 dentry->d_short_name_nbytes = node->name_nbytes;
534 WARNING("NTFS inode %"PRIu64" has Win32 name with no "
535 "corresponding DOS name",
536 dentry->d_inode->i_ino);
543 destroy_dos_name_map(struct dos_name_map *map)
545 struct dos_name_node *node;
546 avl_tree_for_each_in_postorder(node, map->root,
547 struct dos_name_node, index_node)
552 struct wim_dentry *parent;
555 struct dos_name_map dos_name_map;
556 struct ntfs_volume_wrapper *volume;
557 struct capture_params *params;
562 ntfs_3g_build_dentry_tree_recursive(struct wim_dentry **root_p,
567 struct ntfs_volume_wrapper *volume,
568 struct capture_params *params);
571 filldir(void *_ctx, const ntfschar *name, const int name_nchars,
572 const int name_type, const s64 pos, const MFT_REF mref,
573 const unsigned dt_type)
575 struct readdir_ctx *ctx = _ctx;
576 const size_t name_nbytes = name_nchars * sizeof(ntfschar);
578 size_t mbs_name_nbytes;
580 struct wim_dentry *child;
583 if (name_type & FILE_NAME_DOS) {
584 /* If this is the entry for a DOS name, store it for later. */
585 ret = insert_dos_name(&ctx->dos_name_map, name,
586 name_nbytes, MREF(mref));
588 /* Return now if an error occurred or if this is just a DOS name
589 * and not a Win32+DOS name. */
590 if (ret != 0 || name_type == FILE_NAME_DOS)
594 /* Ignore . and .. entries */
596 if ((name_nchars == 1 && name[0] == cpu_to_le16('.')) ||
597 (name_nchars == 2 && name[0] == cpu_to_le16('.') &&
598 name[1] == cpu_to_le16('.')))
601 ret = utf16le_to_tstr(name, name_nbytes, &mbs_name, &mbs_name_nbytes);
605 path_len = ctx->path_len;
607 ctx->path[path_len++] = '/';
608 memcpy(ctx->path + path_len, mbs_name, mbs_name_nbytes + 1);
609 path_len += mbs_name_nbytes;
611 ret = ntfs_3g_build_dentry_tree_recursive(&child, mref, ctx->path,
613 ctx->volume, ctx->params);
615 dentry_add_child(ctx->parent, child);
623 ntfs_3g_recurse_directory(ntfs_inode *ni, char *path, size_t path_len,
624 struct wim_dentry *parent,
625 struct ntfs_volume_wrapper *volume,
626 struct capture_params *params)
630 struct readdir_ctx ctx = {
633 .path_len = path_len,
634 .dos_name_map = { .root = NULL },
639 ret = ntfs_readdir(ni, &pos, &ctx, filldir);
640 path[path_len] = '\0';
646 /* error from ntfs_readdir() itself */
647 ERROR_WITH_ERRNO("Error reading directory \"%s\"", path);
648 ret = WIMLIB_ERR_NTFS_3G;
651 struct wim_dentry *child;
654 for_dentry_child(child, parent) {
655 ret = set_dentry_dos_name(child, &ctx.dos_name_map);
660 destroy_dos_name_map(&ctx.dos_name_map);
665 ntfs_3g_build_dentry_tree_recursive(struct wim_dentry **root_ret,
670 struct ntfs_volume_wrapper *volume,
671 struct capture_params *params)
675 struct wim_dentry *root = NULL;
676 struct wim_inode *inode = NULL;
677 ntfs_inode *ni = NULL;
679 ret = try_exclude(path, params);
680 if (unlikely(ret < 0)) /* Excluded? */
682 if (unlikely(ret > 0)) /* Error? */
685 ni = ntfs_inode_open(volume->vol, mref);
687 ERROR_WITH_ERRNO("Failed to open NTFS file \"%s\"", path);
688 ret = WIMLIB_ERR_NTFS_3G;
692 /* Get file attributes */
693 ret = ntfs_get_ntfs_attrib(ni, (char*)&attributes, sizeof(attributes));
694 if (ret != sizeof(attributes)) {
695 ERROR_WITH_ERRNO("Failed to get NTFS attributes from \"%s\"", path);
696 ret = WIMLIB_ERR_NTFS_3G;
700 if (unlikely(attributes & FILE_ATTRIBUTE_ENCRYPTED)) {
701 if (params->add_flags & WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE)
703 ERROR("Can't archive \"%s\" because NTFS-3g capture mode "
704 "does not support encrypted files and directories", path);
705 ret = WIMLIB_ERR_UNSUPPORTED_FILE;
708 params->progress.scan.cur_path = path;
709 ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_UNSUPPORTED, NULL);
713 /* Create a WIM dentry with an associated inode, which may be shared */
714 ret = inode_table_new_dentry(params->inode_table,
715 path_basename_with_len(path, path_len),
716 ni->mft_no, 0, false, &root);
720 if (name_type & FILE_NAME_WIN32) /* Win32 or Win32+DOS name (rather than POSIX) */
721 root->d_is_win32_name = 1;
723 inode = root->d_inode;
725 if (inode->i_nlink > 1) {
726 /* Shared inode; nothing more to do */
730 inode->i_creation_time = le64_to_cpu(ni->creation_time);
731 inode->i_last_write_time = le64_to_cpu(ni->last_data_change_time);
732 inode->i_last_access_time = le64_to_cpu(ni->last_access_time);
733 inode->i_attributes = attributes;
735 if (attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
736 /* Scan the reparse point stream. */
737 ret = scan_ntfs_attrs_with_type(inode, ni, path, path_len,
738 params->unhashed_blobs,
739 volume, AT_REPARSE_POINT);
744 /* Scan the data streams.
746 * Note: directories should not have an unnamed data stream, but they
747 * may have named data streams. Nondirectories (including reparse
748 * points) can have an unnamed data stream as well as named data
750 ret = scan_ntfs_attrs_with_type(inode, ni, path, path_len,
751 params->unhashed_blobs,
756 /* Reparse-point fixups are a no-op because in NTFS-3g capture mode we
757 * only allow capturing an entire volume. */
758 if (params->add_flags & WIMLIB_ADD_FLAG_RPFIX &&
759 inode_is_symlink(inode))
760 inode->i_rp_flags &= ~WIM_RP_FLAG_NOT_FIXED;
762 if (!(params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS)) {
763 ret = get_security_descriptor(ni, inode, volume->vol,
766 ERROR_WITH_ERRNO("Error reading security descriptor "
772 if (inode_is_directory(inode)) {
773 ret = ntfs_3g_recurse_directory(ni, path, path_len, root,
780 params->progress.scan.cur_path = path;
782 ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL);
784 ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK, inode);
787 ntfs_inode_close(ni);
789 free_dentry_tree(root, params->blob_table);
791 ret = report_capture_error(params, ret, path);
798 ntfs_3g_build_dentry_tree(struct wim_dentry **root_ret,
800 struct capture_params *params)
802 struct ntfs_volume_wrapper *volume;
807 volume = MALLOC(sizeof(struct ntfs_volume_wrapper));
809 return WIMLIB_ERR_NOMEM;
811 /* NTFS-3g 2013 renamed the "read-only" mount flag from MS_RDONLY to
814 * Unfortunately we can't check for defined(NTFS_MNT_RDONLY) because
815 * NTFS_MNT_RDONLY is an enumerated constant. Also, the NTFS-3g headers
816 * don't seem to contain any explicit version information. So we have
817 * to rely on a test done at configure time to detect whether
818 * NTFS_MNT_RDONLY should be used. */
819 #ifdef HAVE_NTFS_MNT_RDONLY
821 vol = ntfs_mount(device, NTFS_MNT_RDONLY);
822 #elif defined(MS_RDONLY)
823 /* NTFS-3g 2011, 2012 */
824 vol = ntfs_mount(device, MS_RDONLY);
826 #error "Can't find NTFS_MNT_RDONLY or MS_RDONLY flags"
829 ERROR_WITH_ERRNO("Failed to mount NTFS volume \"%s\" read-only",
832 return WIMLIB_ERR_NTFS_3G;
838 ntfs_open_secure(vol);
840 /* We don't want to capture the special NTFS files such as $Bitmap. Not
841 * to be confused with "hidden" or "system" files which are real files
842 * that we do need to capture. */
843 NVolClearShowSysFiles(vol);
845 /* Currently we assume that all the paths fit into this length and there
846 * is no check for overflow. */
847 path = MALLOC(32768);
849 ret = WIMLIB_ERR_NOMEM;
850 goto out_put_ntfs_volume;
855 ret = ntfs_3g_build_dentry_tree_recursive(root_ret, FILE_root, path, 1,
856 FILE_NAME_POSIX, volume,
860 ntfs_index_ctx_put(vol->secure_xsii);
861 ntfs_index_ctx_put(vol->secure_xsdh);
862 ntfs_inode_close(vol->secure_ni);
863 put_ntfs_volume(volume);
866 #endif /* WITH_NTFS_3G */