Cleanup
[wimlib] / src / ntfs-capture.c
1 /*
2  * ntfs-capture.c
3  *
4  * Capture a WIM image from a NTFS volume.  We capture everything we can,
5  * including security data and alternate data streams.
6  */
7
8 /*
9  * Copyright (C) 2012 Eric Biggers
10  *
11  * This file is part of wimlib, a library for working with WIM files.
12  *
13  * wimlib is free software; you can redistribute it and/or modify it under the
14  * terms of the GNU General Public License as published by the Free
15  * Software Foundation; either version 3 of the License, or (at your option)
16  * any later version.
17  *
18  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
20  * A PARTICULAR PURPOSE. See the GNU General Public License for more
21  * details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with wimlib; if not, see http://www.gnu.org/licenses/.
25  */
26
27
28 #include "config.h"
29
30 #include <ntfs-3g/endians.h>
31 #include <ntfs-3g/types.h>
32
33 #include "wimlib_internal.h"
34
35
36 #include "dentry.h"
37 #include "lookup_table.h"
38 #include "buffer_io.h"
39 #include <ntfs-3g/layout.h>
40 #include <ntfs-3g/acls.h>
41 #include <ntfs-3g/attrib.h>
42 #include <ntfs-3g/misc.h>
43 #include <ntfs-3g/reparse.h>
44 #include <ntfs-3g/security.h> /* security.h before xattrs.h */
45 #include <ntfs-3g/xattrs.h>
46 #include <ntfs-3g/volume.h>
47 #include <stdlib.h>
48 #include <unistd.h>
49 #include <errno.h>
50 #include "rbtree.h"
51
52 /* Red-black tree that maps SHA1 message digests of security descriptors to
53  * security IDs, which are themselves indices into the table of security
54  * descriptors in the 'struct wim_security_data'. */
55 struct sd_set {
56         struct wim_security_data *sd;
57         struct rb_root rb_root;
58 };
59
60 struct sd_node {
61         int security_id;
62         u8 hash[SHA1_HASH_SIZE];
63         struct rb_node rb_node;
64 };
65
66 static void free_sd_tree(struct rb_node *node)
67 {
68         if (node) {
69                 free_sd_tree(node->rb_left);
70                 free_sd_tree(node->rb_right);
71                 FREE(container_of(node, struct sd_node, rb_node));
72         }
73 }
74 /* Frees a security descriptor index set. */
75 static void destroy_sd_set(struct sd_set *sd_set)
76 {
77         free_sd_tree(sd_set->rb_root.rb_node);
78 }
79
80 /* Inserts a a new node into the security descriptor index tree. */
81 static void insert_sd_node(struct sd_set *set, struct sd_node *new)
82 {
83         struct rb_root *root = &set->rb_root;
84         struct rb_node **p = &(root->rb_node);
85         struct rb_node *rb_parent = NULL;
86
87         while (*p) {
88                 struct sd_node *this = container_of(*p, struct sd_node, rb_node);
89                 int cmp = hashes_cmp(new->hash, this->hash);
90
91                 rb_parent = *p;
92                 if (cmp < 0)
93                         p = &((*p)->rb_left);
94                 else if (cmp > 0)
95                         p = &((*p)->rb_right);
96                 else
97                         wimlib_assert(0); /* Duplicate SHA1 message digest */
98         }
99         rb_link_node(&new->rb_node, rb_parent, p);
100         rb_insert_color(&new->rb_node, root);
101 }
102
103 /* Returns the index of the security descriptor having a SHA1 message digest of
104  * @hash.  If not found, return -1. */
105 static int lookup_sd(struct sd_set *set, const u8 hash[SHA1_HASH_SIZE])
106 {
107         struct rb_node *node = set->rb_root.rb_node;
108
109         while (node) {
110                 struct sd_node *sd_node = container_of(node, struct sd_node, rb_node);
111                 int cmp = hashes_cmp(hash, sd_node->hash);
112                 if (cmp < 0)
113                         node = node->rb_left;
114                 else if (cmp > 0)
115                         node = node->rb_right;
116                 else
117                         return sd_node->security_id;
118         }
119         return -1;
120 }
121
122 /*
123  * Adds a security descriptor to the indexed security descriptor set as well as
124  * the corresponding `struct wim_security_data', and returns the new security
125  * ID; or, if there is an existing security descriptor that is the same, return
126  * the security ID for it.  If a new security descriptor cannot be allocated,
127  * return -1.
128  */
129 static int sd_set_add_sd(struct sd_set *sd_set, const char descriptor[],
130                          size_t size)
131 {
132         u8 hash[SHA1_HASH_SIZE];
133         int security_id;
134         struct sd_node *new;
135         u8 **descriptors;
136         u64 *sizes;
137         u8 *descr_copy;
138         struct wim_security_data *sd;
139
140         sha1_buffer((const u8*)descriptor, size, hash);
141
142         security_id = lookup_sd(sd_set, hash);
143         if (security_id >= 0) /* Identical descriptor already exists */
144                 return security_id;
145
146         /* Need to add a new security descriptor */
147         new = MALLOC(sizeof(*new));
148         if (!new)
149                 goto out;
150         descr_copy = MALLOC(size);
151         if (!descr_copy)
152                 goto out_free_node;
153
154         sd = sd_set->sd;
155
156         memcpy(descr_copy, descriptor, size);
157         new->security_id = sd->num_entries;
158         copy_hash(new->hash, hash);
159
160         descriptors = REALLOC(sd->descriptors,
161                               (sd->num_entries + 1) * sizeof(sd->descriptors[0]));
162         if (!descriptors)
163                 goto out_free_descr;
164         sd->descriptors = descriptors;
165         sizes = REALLOC(sd->sizes,
166                         (sd->num_entries + 1) * sizeof(sd->sizes[0]));
167         if (!sizes)
168                 goto out_free_descr;
169         sd->sizes = sizes;
170         sd->descriptors[sd->num_entries] = descr_copy;
171         sd->sizes[sd->num_entries] = size;
172         sd->num_entries++;
173         DEBUG("There are now %d security descriptors", sd->num_entries);
174         sd->total_length += size + sizeof(sd->sizes[0]);
175         insert_sd_node(sd_set, new);
176         return new->security_id;
177 out_free_descr:
178         FREE(descr_copy);
179 out_free_node:
180         FREE(new);
181 out:
182         return -1;
183 }
184
185 static inline ntfschar *attr_record_name(ATTR_RECORD *ar)
186 {
187         return (ntfschar*)((u8*)ar + le16_to_cpu(ar->name_offset));
188 }
189
190 /* Calculates the SHA1 message digest of a NTFS attribute.
191  *
192  * @ni:  The NTFS inode containing the attribute.
193  * @ar:  The ATTR_RECORD describing the attribute.
194  * @md:  If successful, the returned SHA1 message digest.
195  * @reparse_tag_ret:    Optional pointer into which the first 4 bytes of the
196  *                              attribute will be written (to get the reparse
197  *                              point ID)
198  *
199  * Return 0 on success or nonzero on error.
200  */
201 static int ntfs_attr_sha1sum(ntfs_inode *ni, ATTR_RECORD *ar,
202                              u8 md[SHA1_HASH_SIZE],
203                              bool is_reparse_point,
204                              u32 *reparse_tag_ret)
205 {
206         s64 pos = 0;
207         s64 bytes_remaining;
208         char buf[BUFFER_SIZE];
209         ntfs_attr *na;
210         SHA_CTX ctx;
211
212         na = ntfs_attr_open(ni, ar->type, attr_record_name(ar),
213                             ar->name_length);
214         if (!na) {
215                 ERROR_WITH_ERRNO("Failed to open NTFS attribute");
216                 return WIMLIB_ERR_NTFS_3G;
217         }
218
219         bytes_remaining = na->data_size;
220
221         if (is_reparse_point) {
222                 if (ntfs_attr_pread(na, 0, 8, buf) != 8)
223                         goto out_error;
224                 *reparse_tag_ret = le32_to_cpu(*(u32*)buf);
225                 pos = 8;
226                 bytes_remaining -= 8;
227         }
228
229         sha1_init(&ctx);
230         while (bytes_remaining) {
231                 s64 to_read = min(bytes_remaining, sizeof(buf));
232                 if (ntfs_attr_pread(na, pos, to_read, buf) != to_read)
233                         goto out_error;
234                 sha1_update(&ctx, buf, to_read);
235                 pos += to_read;
236                 bytes_remaining -= to_read;
237         }
238         sha1_final(md, &ctx);
239         ntfs_attr_close(na);
240         return 0;
241 out_error:
242         ERROR_WITH_ERRNO("Error reading NTFS attribute");
243         return WIMLIB_ERR_NTFS_3G;
244 }
245
246 /* Load the streams from a file or reparse point in the NTFS volume into the WIM
247  * lookup table */
248 static int capture_ntfs_streams(struct wim_dentry *dentry, ntfs_inode *ni,
249                                 char path[], size_t path_len,
250                                 struct wim_lookup_table *lookup_table,
251                                 ntfs_volume **ntfs_vol_p,
252                                 ATTR_TYPES type)
253 {
254         ntfs_attr_search_ctx *actx;
255         u8 attr_hash[SHA1_HASH_SIZE];
256         struct ntfs_location *ntfs_loc = NULL;
257         int ret = 0;
258         struct wim_lookup_table_entry *lte;
259
260         DEBUG2("Capturing NTFS data streams from `%s'", path);
261
262         /* Get context to search the streams of the NTFS file. */
263         actx = ntfs_attr_get_search_ctx(ni, NULL);
264         if (!actx) {
265                 ERROR_WITH_ERRNO("Cannot get NTFS attribute search "
266                                  "context");
267                 return WIMLIB_ERR_NTFS_3G;
268         }
269
270         /* Capture each data stream or reparse data stream. */
271         while (!ntfs_attr_lookup(type, NULL, 0,
272                                  CASE_SENSITIVE, 0, NULL, 0, actx))
273         {
274                 char *stream_name_utf8;
275                 u32 reparse_tag;
276                 u64 data_size = ntfs_get_attribute_value_length(actx->attr);
277                 u64 name_length = actx->attr->name_length;
278
279                 if (data_size == 0) {
280                         if (errno != 0) {
281                                 ERROR_WITH_ERRNO("Failed to get size of attribute of "
282                                                  "`%s'", path);
283                                 ret = WIMLIB_ERR_NTFS_3G;
284                                 goto out_put_actx;
285                         }
286                         /* Empty stream.  No lookup table entry is needed. */
287                         lte = NULL;
288                 } else {
289                         if (type == AT_REPARSE_POINT && data_size < 8) {
290                                 ERROR("`%s': reparse point buffer too small",
291                                       path);
292                                 ret = WIMLIB_ERR_NTFS_3G;
293                                 goto out_put_actx;
294                         }
295                         /* Checksum the stream. */
296                         ret = ntfs_attr_sha1sum(ni, actx->attr, attr_hash,
297                                                 type == AT_REPARSE_POINT, &reparse_tag);
298                         if (ret != 0)
299                                 goto out_put_actx;
300
301                         /* Make a lookup table entry for the stream, or use an existing
302                          * one if there's already an identical stream. */
303                         lte = __lookup_resource(lookup_table, attr_hash);
304                         ret = WIMLIB_ERR_NOMEM;
305                         if (lte) {
306                                 lte->refcnt++;
307                         } else {
308                                 ntfs_loc = CALLOC(1, sizeof(*ntfs_loc));
309                                 if (!ntfs_loc)
310                                         goto out_put_actx;
311                                 ntfs_loc->ntfs_vol_p = ntfs_vol_p;
312                                 ntfs_loc->path_utf8 = MALLOC(path_len + 1);
313                                 if (!ntfs_loc->path_utf8)
314                                         goto out_free_ntfs_loc;
315                                 memcpy(ntfs_loc->path_utf8, path, path_len + 1);
316                                 if (name_length) {
317                                         ntfs_loc->stream_name_utf16 = MALLOC(name_length * 2);
318                                         if (!ntfs_loc->stream_name_utf16)
319                                                 goto out_free_ntfs_loc;
320                                         memcpy(ntfs_loc->stream_name_utf16,
321                                                attr_record_name(actx->attr),
322                                                actx->attr->name_length * 2);
323                                         ntfs_loc->stream_name_utf16_num_chars = name_length;
324                                 }
325
326                                 lte = new_lookup_table_entry();
327                                 if (!lte)
328                                         goto out_free_ntfs_loc;
329                                 lte->ntfs_loc = ntfs_loc;
330                                 lte->resource_location = RESOURCE_IN_NTFS_VOLUME;
331                                 if (type == AT_REPARSE_POINT) {
332                                         dentry->d_inode->i_reparse_tag = reparse_tag;
333                                         ntfs_loc->is_reparse_point = true;
334                                         lte->resource_entry.original_size = data_size - 8;
335                                         lte->resource_entry.size = data_size - 8;
336                                 } else {
337                                         ntfs_loc->is_reparse_point = false;
338                                         lte->resource_entry.original_size = data_size;
339                                         lte->resource_entry.size = data_size;
340                                 }
341                                 ntfs_loc = NULL;
342                                 DEBUG("Add resource for `%s' (size = %"PRIu64")",
343                                       dentry->file_name_utf8,
344                                       lte->resource_entry.original_size);
345                                 copy_hash(lte->hash, attr_hash);
346                                 lookup_table_insert(lookup_table, lte);
347                         }
348                 }
349                 if (name_length == 0) {
350                         /* Unnamed data stream.  Put the reference to it in the
351                          * dentry's inode. */
352                         if (dentry->d_inode->i_lte) {
353                                 ERROR("Found two un-named data streams for "
354                                       "`%s'", path);
355                                 ret = WIMLIB_ERR_NTFS_3G;
356                                 goto out_free_lte;
357                         }
358                         dentry->d_inode->i_lte = lte;
359                 } else {
360                         /* Named data stream.  Put the reference to it in the
361                          * alternate data stream entries */
362                         struct wim_ads_entry *new_ads_entry;
363                         size_t stream_name_utf8_len;
364
365                         ret = utf16_to_utf8((const char*)attr_record_name(actx->attr),
366                                             name_length * 2,
367                                             &stream_name_utf8,
368                                             &stream_name_utf8_len);
369                         if (ret != 0)
370                                 goto out_free_lte;
371                         new_ads_entry = inode_add_ads(dentry->d_inode, stream_name_utf8);
372                         FREE(stream_name_utf8);
373                         if (!new_ads_entry)
374                                 goto out_free_lte;
375
376                         wimlib_assert(new_ads_entry->stream_name_len == name_length * 2);
377
378                         new_ads_entry->lte = lte;
379                 }
380         }
381         ret = 0;
382         goto out_put_actx;
383 out_free_lte:
384         free_lookup_table_entry(lte);
385 out_free_ntfs_loc:
386         if (ntfs_loc) {
387                 FREE(ntfs_loc->path_utf8);
388                 FREE(ntfs_loc->stream_name_utf16);
389                 FREE(ntfs_loc);
390         }
391 out_put_actx:
392         ntfs_attr_put_search_ctx(actx);
393         if (ret == 0)
394                 DEBUG2("Successfully captured NTFS streams from `%s'", path);
395         else
396                 ERROR("Failed to capture NTFS streams from `%s", path);
397         return ret;
398 }
399
400 /* Red-black tree that maps NTFS inode numbers to DOS names */
401 struct dos_name_map {
402         struct rb_root rb_root;
403 };
404
405 struct dos_name_node {
406         struct rb_node rb_node;
407         char dos_name[24];
408         int name_len_bytes;
409         u64 ntfs_ino;
410 };
411
412 /* Inserts a new DOS name into the map */
413 static int insert_dos_name(struct dos_name_map *map,
414                            const ntfschar *dos_name, int name_len,
415                            u64 ntfs_ino)
416 {
417         struct dos_name_node *new_node;
418         struct rb_node **p;
419         struct rb_root *root;
420         struct rb_node *rb_parent;
421
422         DEBUG("DOS name_len = %d", name_len);
423         new_node = MALLOC(sizeof(struct dos_name_node));
424         if (!new_node)
425                 return -1;
426
427         /* DOS names are supposed to be 12 characters max (that's 24 bytes,
428          * assuming 2-byte ntfs characters) */
429         wimlib_assert(name_len * sizeof(ntfschar) <= sizeof(new_node->dos_name));
430
431         /* Initialize the DOS name, DOS name length, and NTFS inode number of
432          * the red-black tree node */
433         memcpy(new_node->dos_name, dos_name, name_len * sizeof(ntfschar));
434         new_node->name_len_bytes = name_len * sizeof(ntfschar);
435         new_node->ntfs_ino = ntfs_ino;
436
437         /* Insert the red-black tree node */
438         root = &map->rb_root;
439         p = &root->rb_node;
440         rb_parent = NULL;
441         while (*p) {
442                 struct dos_name_node *this;
443
444                 this = container_of(*p, struct dos_name_node, rb_node);
445                 rb_parent = *p;
446                 if (new_node->ntfs_ino < this->ntfs_ino)
447                         p = &((*p)->rb_left);
448                 else if (new_node->ntfs_ino > this->ntfs_ino)
449                         p = &((*p)->rb_right);
450                 else {
451                         /* This should be impossible since a NTFS inode cannot
452                          * have multiple DOS names, and we only should get each
453                          * DOS name entry once from the ntfs_readdir() calls. */
454                         ERROR("NTFS inode %"PRIu64" has multiple DOS names",
455                               ntfs_ino);
456                         return -1;
457                 }
458         }
459         rb_link_node(&new_node->rb_node, rb_parent, p);
460         rb_insert_color(&new_node->rb_node, root);
461         DEBUG("Inserted DOS name for inode %"PRIu64, ntfs_ino);
462         return 0;
463 }
464
465 /* Returns a structure that contains the DOS name and its length for a NTFS
466  * inode, or NULL if the inode has no DOS name. */
467 static struct dos_name_node *
468 lookup_dos_name(const struct dos_name_map *map, u64 ntfs_ino)
469 {
470         struct rb_node *node = map->rb_root.rb_node;
471         while (node) {
472                 struct dos_name_node *this;
473                 this = container_of(node, struct dos_name_node, rb_node);
474                 if (ntfs_ino < this->ntfs_ino)
475                         node = node->rb_left;
476                 else if (ntfs_ino > this->ntfs_ino)
477                         node = node->rb_right;
478                 else
479                         return this;
480         }
481         return NULL;
482 }
483
484 static int set_dentry_dos_name(struct wim_dentry *dentry, void *arg)
485 {
486         const struct dos_name_map *map = arg;
487         const struct dos_name_node *node;
488
489         if (dentry->is_win32_name) {
490                 node = lookup_dos_name(map, dentry->d_inode->i_ino);
491                 if (node) {
492                         dentry->short_name = MALLOC(node->name_len_bytes);
493                         if (!dentry->short_name)
494                                 return WIMLIB_ERR_NOMEM;
495                         memcpy(dentry->short_name, node->dos_name,
496                                node->name_len_bytes);
497                         dentry->short_name_len = node->name_len_bytes;
498                         DEBUG("Assigned DOS name to ino %"PRIu64,
499                               dentry->d_inode->i_ino);
500                 } else {
501                         WARNING("NTFS inode %"PRIu64" has Win32 name with no "
502                                 "corresponding DOS name",
503                                 dentry->d_inode->i_ino);
504                 }
505         }
506         return 0;
507 }
508
509 static void free_dos_name_tree(struct rb_node *node) {
510         if (node) {
511                 free_dos_name_tree(node->rb_left);
512                 free_dos_name_tree(node->rb_right);
513                 FREE(container_of(node, struct dos_name_node, rb_node));
514         }
515 }
516
517 static void destroy_dos_name_map(struct dos_name_map *map)
518 {
519         free_dos_name_tree(map->rb_root.rb_node);
520 }
521
522 struct readdir_ctx {
523         struct wim_dentry *parent;
524         ntfs_inode *dir_ni;
525         char *path;
526         size_t path_len;
527         struct wim_lookup_table *lookup_table;
528         struct sd_set *sd_set;
529         struct dos_name_map *dos_name_map;
530         const struct capture_config *config;
531         ntfs_volume **ntfs_vol_p;
532         int add_image_flags;
533         wimlib_progress_func_t progress_func;
534 };
535
536 static int
537 build_dentry_tree_ntfs_recursive(struct wim_dentry **root_p, ntfs_inode *dir_ni,
538                                  ntfs_inode *ni, char path[], size_t path_len,
539                                  int name_type,
540                                  struct wim_lookup_table *lookup_table,
541                                  struct sd_set *sd_set,
542                                  const struct capture_config *config,
543                                  ntfs_volume **ntfs_vol_p,
544                                  int add_image_flags,
545                                  wimlib_progress_func_t progress_func);
546
547 static int wim_ntfs_capture_filldir(void *dirent, const ntfschar *name,
548                                     const int name_len, const int name_type,
549                                     const s64 pos, const MFT_REF mref,
550                                     const unsigned dt_type)
551 {
552         struct readdir_ctx *ctx;
553         size_t utf8_name_len;
554         char *utf8_name;
555         struct wim_dentry *child;
556         int ret;
557         size_t path_len;
558
559         ctx = dirent;
560         if (name_type & FILE_NAME_DOS) {
561                 /* If this is the entry for a DOS name, store it for later. */
562                 ret = insert_dos_name(ctx->dos_name_map, name,
563                                       name_len, mref & MFT_REF_MASK_CPU);
564
565                 /* Return now if an error occurred or if this is just a DOS name
566                  * and not a Win32+DOS name. */
567                 if (ret != 0 || name_type == FILE_NAME_DOS)
568                         return ret;
569         }
570         ret = utf16_to_utf8((const char*)name, name_len * 2,
571                             &utf8_name, &utf8_name_len);
572         if (ret != 0)
573                 return -1;
574
575         if (utf8_name[0] == '.' &&
576              (utf8_name[1] == '\0' ||
577               (utf8_name[1] == '.' && utf8_name[2] == '\0'))) {
578                 /* . or .. entries
579                  *
580                  * note: name_type is POSIX for these, so DOS names will not
581                  * have been inserted for them.  */
582                 ret = 0;
583                 goto out_free_utf8_name;
584         }
585
586         /* Open the inode for this directory entry and recursively capture the
587          * directory tree rooted at it */
588         ntfs_inode *ni = ntfs_inode_open(ctx->dir_ni->vol, mref);
589         if (!ni) {
590                 ERROR_WITH_ERRNO("Failed to open NTFS inode");
591                 goto out_free_utf8_name;
592         }
593         path_len = ctx->path_len;
594         if (path_len != 1)
595                 ctx->path[path_len++] = '/';
596         memcpy(ctx->path + path_len, utf8_name, utf8_name_len + 1);
597         path_len += utf8_name_len;
598         child = NULL;
599         ret = build_dentry_tree_ntfs_recursive(&child, ctx->dir_ni,
600                                                ni, ctx->path, path_len, name_type,
601                                                ctx->lookup_table, ctx->sd_set,
602                                                ctx->config, ctx->ntfs_vol_p,
603                                                ctx->add_image_flags,
604                                                ctx->progress_func);
605         if (child)
606                 dentry_add_child(ctx->parent, child);
607         ntfs_inode_close(ni);
608 out_free_utf8_name:
609         FREE(utf8_name);
610         return ret;
611 }
612
613 /* Recursively build a WIM dentry tree corresponding to a NTFS volume.
614  * At the same time, update the WIM lookup table with lookup table entries for
615  * the NTFS streams, and build an array of security descriptors.
616  */
617 static int build_dentry_tree_ntfs_recursive(struct wim_dentry **root_p,
618                                             ntfs_inode *dir_ni,
619                                             ntfs_inode *ni,
620                                             char path[],
621                                             size_t path_len,
622                                             int name_type,
623                                             struct wim_lookup_table *lookup_table,
624                                             struct sd_set *sd_set,
625                                             const struct capture_config *config,
626                                             ntfs_volume **ntfs_vol_p,
627                                             int add_image_flags,
628                                             wimlib_progress_func_t progress_func)
629 {
630         u32 attributes;
631         int ret;
632         struct wim_dentry *root;
633
634         if (exclude_path(path, config, false)) {
635                 /* Exclude a file or directory tree based on the capture
636                  * configuration file */
637                 if ((add_image_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
638                     && progress_func)
639                 {
640                         union wimlib_progress_info info;
641                         info.scan.cur_path = path;
642                         info.scan.excluded = true;
643                         progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
644                 }
645                 *root_p = NULL;
646                 return 0;
647         }
648
649         /* Get file attributes */
650         struct SECURITY_CONTEXT ctx;
651         memset(&ctx, 0, sizeof(ctx));
652         ctx.vol = ni->vol;
653         ret = ntfs_xattr_system_getxattr(&ctx, XATTR_NTFS_ATTRIB,
654                                          ni, dir_ni, (char *)&attributes,
655                                          sizeof(u32));
656         if (ret != 4) {
657                 ERROR_WITH_ERRNO("Failed to get NTFS attributes from `%s'",
658                                  path);
659                 return WIMLIB_ERR_NTFS_3G;
660         }
661
662         if ((add_image_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
663             && progress_func)
664         {
665                 union wimlib_progress_info info;
666                 info.scan.cur_path = path;
667                 info.scan.excluded = false;
668                 progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
669         }
670
671         /* Create the new WIM dentry */
672         root = new_dentry_with_timeless_inode(path_basename(path));
673         if (!root) {
674                 if (errno == EILSEQ)
675                         return WIMLIB_ERR_INVALID_UTF8_STRING;
676                 else if (errno == ENOMEM)
677                         return WIMLIB_ERR_NOMEM;
678                 else
679                         return WIMLIB_ERR_ICONV_NOT_AVAILABLE;
680         }
681         *root_p = root;
682
683         if (name_type & FILE_NAME_WIN32) /* Win32 or Win32+DOS name */
684                 root->is_win32_name = 1;
685         root->d_inode->i_creation_time    = le64_to_cpu(ni->creation_time);
686         root->d_inode->i_last_write_time  = le64_to_cpu(ni->last_data_change_time);
687         root->d_inode->i_last_access_time = le64_to_cpu(ni->last_access_time);
688         root->d_inode->i_attributes       = le32_to_cpu(attributes);
689         root->d_inode->i_ino              = ni->mft_no;
690         root->d_inode->i_resolved         = 1;
691
692         if (attributes & FILE_ATTR_REPARSE_POINT) {
693                 /* Junction point, symbolic link, or other reparse point */
694                 ret = capture_ntfs_streams(root, ni, path, path_len,
695                                            lookup_table, ntfs_vol_p,
696                                            AT_REPARSE_POINT);
697         } else if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) {
698
699                 /* Normal directory */
700                 s64 pos = 0;
701                 struct dos_name_map dos_name_map = { .rb_root = {.rb_node = NULL} };
702                 struct readdir_ctx ctx = {
703                         .parent          = root,
704                         .dir_ni          = ni,
705                         .path            = path,
706                         .path_len        = path_len,
707                         .lookup_table    = lookup_table,
708                         .sd_set          = sd_set,
709                         .dos_name_map    = &dos_name_map,
710                         .config          = config,
711                         .ntfs_vol_p      = ntfs_vol_p,
712                         .add_image_flags = add_image_flags,
713                         .progress_func   = progress_func,
714                 };
715                 ret = ntfs_readdir(ni, &pos, &ctx, wim_ntfs_capture_filldir);
716                 if (ret) {
717                         ERROR_WITH_ERRNO("ntfs_readdir()");
718                         ret = WIMLIB_ERR_NTFS_3G;
719                 } else {
720                         ret = for_dentry_child(root, set_dentry_dos_name,
721                                                &dos_name_map);
722                 }
723                 destroy_dos_name_map(&dos_name_map);
724         } else {
725                 /* Normal file */
726                 ret = capture_ntfs_streams(root, ni, path, path_len,
727                                            lookup_table, ntfs_vol_p,
728                                            AT_DATA);
729         }
730         if (ret != 0)
731                 return ret;
732
733         /* Get security descriptor */
734         char _sd[1];
735         char *sd = _sd;
736         errno = 0;
737         ret = ntfs_xattr_system_getxattr(&ctx, XATTR_NTFS_ACL,
738                                          ni, dir_ni, sd,
739                                          sizeof(sd));
740         if (ret > sizeof(sd)) {
741                 sd = alloca(ret);
742                 ret = ntfs_xattr_system_getxattr(&ctx, XATTR_NTFS_ACL,
743                                                  ni, dir_ni, sd, ret);
744         }
745         if (ret > 0) {
746                 root->d_inode->i_security_id = sd_set_add_sd(sd_set, sd, ret);
747                 if (root->d_inode->i_security_id == -1) {
748                         ERROR("Out of memory");
749                         return WIMLIB_ERR_NOMEM;
750                 }
751                 DEBUG("Added security ID = %u for `%s'",
752                       root->d_inode->i_security_id, path);
753                 ret = 0;
754         } else if (ret < 0) {
755                 ERROR_WITH_ERRNO("Failed to get security information from "
756                                  "`%s'", path);
757                 ret = WIMLIB_ERR_NTFS_3G;
758         } else {
759                 root->d_inode->i_security_id = -1;
760                 DEBUG("No security ID for `%s'", path);
761         }
762         return ret;
763 }
764
765 int build_dentry_tree_ntfs(struct wim_dentry **root_p,
766                            const char *device,
767                            struct wim_lookup_table *lookup_table,
768                            struct wim_security_data *sd,
769                            const struct capture_config *config,
770                            int add_image_flags,
771                            wimlib_progress_func_t progress_func,
772                            void *extra_arg)
773 {
774         ntfs_volume *vol;
775         ntfs_inode *root_ni;
776         int ret;
777         struct sd_set sd_set = {
778                 .sd = sd,
779                 .rb_root = {NULL},
780         };
781         ntfs_volume **ntfs_vol_p = extra_arg;
782
783         DEBUG("Mounting NTFS volume `%s' read-only", device);
784
785 #ifdef HAVE_NTFS_MNT_RDONLY
786         /* NTFS-3g 2013 */
787         vol = ntfs_mount(device, NTFS_MNT_RDONLY);
788 #else
789         /* NTFS-3g 2011, 2012 */
790         vol = ntfs_mount(device, MS_RDONLY);
791 #endif
792         if (!vol) {
793                 ERROR_WITH_ERRNO("Failed to mount NTFS volume `%s' read-only",
794                                  device);
795                 return WIMLIB_ERR_NTFS_3G;
796         }
797         ntfs_open_secure(vol);
798
799         /* We don't want to capture the special NTFS files such as $Bitmap.  Not
800          * to be confused with "hidden" or "system" files which are real files
801          * that we do need to capture.  */
802         NVolClearShowSysFiles(vol);
803
804         DEBUG("Opening root NTFS dentry");
805         root_ni = ntfs_inode_open(vol, FILE_root);
806         if (!root_ni) {
807                 ERROR_WITH_ERRNO("Failed to open root inode of NTFS volume "
808                                  "`%s'", device);
809                 ret = WIMLIB_ERR_NTFS_3G;
810                 goto out;
811         }
812
813         /* Currently we assume that all the UTF-8 paths fit into this length and
814          * there is no check for overflow. */
815         char *path = MALLOC(32768);
816         if (!path) {
817                 ERROR("Could not allocate memory for NTFS pathname");
818                 ret = WIMLIB_ERR_NOMEM;
819                 goto out_cleanup;
820         }
821
822         path[0] = '/';
823         path[1] = '\0';
824         ret = build_dentry_tree_ntfs_recursive(root_p, NULL, root_ni, path, 1,
825                                                FILE_NAME_POSIX, lookup_table,
826                                                &sd_set,
827                                                config, ntfs_vol_p,
828                                                add_image_flags,
829                                                progress_func);
830 out_cleanup:
831         FREE(path);
832         ntfs_inode_close(root_ni);
833         destroy_sd_set(&sd_set);
834 out:
835         ntfs_index_ctx_put(vol->secure_xsii);
836         ntfs_index_ctx_put(vol->secure_xsdh);
837         ntfs_inode_close(vol->secure_ni);
838
839         if (ret) {
840                 if (ntfs_umount(vol, FALSE) != 0) {
841                         ERROR_WITH_ERRNO("Failed to unmount NTFS volume `%s'",
842                                          device);
843                         if (ret == 0)
844                                 ret = WIMLIB_ERR_NTFS_3G;
845                 }
846         } else {
847                 /* We need to leave the NTFS volume mounted so that we can read
848                  * the NTFS files again when we are actually writing the WIM */
849                 *ntfs_vol_p = vol;
850         }
851         return ret;
852 }