wimlib.net Git - wimlib/blob - src/ntfs-3g_apply.c

   1 /*
   2  * ntfs-3g_apply.c
   3  *
   4  * Apply a WIM image directly to an NTFS volume using libntfs-3g.  Restore as
   5  * much information as possible, including security data, file attributes, DOS
   6  * names, and alternate data streams.
   7  *
   8  * Note: because NTFS-3g offers inode-based interfaces, we actually don't need
   9  * to deal with paths at all!  (Other than for error messages.)
  10  */
  11
  12 /*
  13  * Copyright (C) 2012, 2013, 2014, 2015 Eric Biggers
  14  *
  15  * This file is free software; you can redistribute it and/or modify it under
  16  * the terms of the GNU Lesser General Public License as published by the Free
  17  * Software Foundation; either version 3 of the License, or (at your option) any
  18  * later version.
  19  *
  20  * This file is distributed in the hope that it will be useful, but WITHOUT
  21  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  22  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  23  * details.
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * along with this file; if not, see http://www.gnu.org/licenses/.
  27  */
  28
  29 #ifdef HAVE_CONFIG_H
  30 #  include "config.h"
  31 #endif
  32
  33 #include <locale.h>
  34 #include <string.h>
  35
  36 #include <ntfs-3g/attrib.h>
  37 #include <ntfs-3g/reparse.h>
  38 #include <ntfs-3g/security.h>
  39
  40 #include "wimlib/assert.h"
  41 #include "wimlib/apply.h"
  42 #include "wimlib/blob_table.h"
  43 #include "wimlib/dentry.h"
  44 #include "wimlib/encoding.h"
  45 #include "wimlib/error.h"
  46 #include "wimlib/metadata.h"
  47 #include "wimlib/ntfs_3g.h"
  48 #include "wimlib/reparse.h"
  49 #include "wimlib/security.h"
  50 #include "wimlib/security_descriptor.h"
  51
  52 static int
  53 ntfs_3g_get_supported_features(const char *target,
  54                                struct wim_features *supported_features)
  55 {
  56         supported_features->archive_files             = 1;
  57         supported_features->hidden_files              = 1;
  58         supported_features->system_files              = 1;
  59         supported_features->compressed_files          = 1;
  60         supported_features->not_context_indexed_files = 1;
  61         supported_features->named_data_streams        = 1;
  62         supported_features->hard_links                = 1;
  63         supported_features->reparse_points            = 1;
  64         supported_features->security_descriptors      = 1;
  65         supported_features->short_names               = 1;
  66         supported_features->timestamps                = 1;
  67         supported_features->case_sensitive_filenames  = 1;
  68         return 0;
  69 }
  70
  71 struct ntfs_3g_apply_ctx {
  72         /* Extract flags, the pointer to the WIMStruct, etc.  */
  73         struct apply_ctx common;
  74
  75         /* Pointer to the open NTFS volume  */
  76         ntfs_volume *vol;
  77
  78         ntfs_attr *open_attrs[MAX_OPEN_FILES];
  79         unsigned num_open_attrs;
  80         ntfs_inode *open_inodes[MAX_OPEN_FILES];
  81         unsigned num_open_inodes;
  82
  83         struct reparse_buffer_disk rpbuf;
  84         u8 *reparse_ptr;
  85
  86         /* Offset in the blob currently being read  */
  87         u64 offset;
  88
  89         unsigned num_reparse_inodes;
  90         ntfs_inode *ntfs_reparse_inodes[MAX_OPEN_FILES];
  91         struct wim_inode *wim_reparse_inodes[MAX_OPEN_FILES];
  92 };
  93
  94 static size_t
  95 sid_size(const wimlib_SID *sid)
  96 {
  97         return offsetof(wimlib_SID, sub_authority) +
  98                 sizeof(le32) * sid->sub_authority_count;
  99 }
 100
 101 /*
 102  * sd_fixup - Fix up a Windows NT security descriptor for libntfs-3g.
 103  *
 104  * libntfs-3g validates security descriptors before setting them, but old
 105  * versions contain bugs causing it to reject unusual but valid security
 106  * descriptors:
 107  *
 108  * - Versions before 2013.1.13 reject security descriptors ending with an empty
 109  *   SACL (System Access Control List).  This bug can be worked around either by
 110  *   moving the empty SACL earlier in the security descriptor or by removing the
 111  *   SACL entirely.  The latter work-around is valid because an empty SACL is
 112  *   equivalent to a "null", or non-existent, SACL.
 113  * - Versions up to and including 2013.1.13 reject security descriptors ending
 114  *   with an empty DACL (Discretionary Access Control List).  This is very
 115  *   similar to the SACL bug and should be fixed in the next release after
 116  *   2013.1.13.  However, removing the DACL is not a valid workaround because
 117  *   this changes the meaning of the security descriptor--- an empty DACL allows
 118  *   no access, whereas a "null" DACL allows all access.
 119  *
 120  * If the security descriptor was fixed, this function returns an allocated
 121  * buffer containing the fixed security descriptor, and its size is updated.
 122  * Otherwise (or if no memory is available) the original descriptor is returned.
 123  */
 124 static u8 *
 125 sd_fixup(const u8 *_desc, size_t *size_p)
 126 {
 127         u32 owner_offset, group_offset, dacl_offset;
 128 #if !defined(HAVE_NTFS_MNT_RDONLY)
 129         u32 sacl_offset;
 130 #endif
 131         bool owner_valid, group_valid;
 132         size_t size = *size_p;
 133         const wimlib_SECURITY_DESCRIPTOR_RELATIVE *desc =
 134                         (const wimlib_SECURITY_DESCRIPTOR_RELATIVE*)_desc;
 135         wimlib_SECURITY_DESCRIPTOR_RELATIVE *desc_new;
 136         const wimlib_SID *owner, *group, *sid;
 137
 138         /* Don't attempt to fix clearly invalid security descriptors.  */
 139         if (size < sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE))
 140                 return (u8*)_desc;
 141
 142         if (le16_to_cpu(desc->control) & wimlib_SE_DACL_PRESENT)
 143                 dacl_offset = le32_to_cpu(desc->dacl_offset);
 144         else
 145                 dacl_offset = 0;
 146
 147 #if !defined(HAVE_NTFS_MNT_RDONLY)
 148         if (le16_to_cpu(desc->control) & wimlib_SE_SACL_PRESENT)
 149                 sacl_offset = le32_to_cpu(desc->sacl_offset);
 150         else
 151                 sacl_offset = 0;
 152 #endif
 153
 154         /* Check if the security descriptor will be affected by one of the bugs.
 155          * If not, do nothing and return.
 156          *
 157          * Note: HAVE_NTFS_MNT_RDONLY is defined if libntfs-3g is
 158          * version 2013.1.13 or later.  */
 159         if (!(
 160         #if !defined(HAVE_NTFS_MNT_RDONLY)
 161             (sacl_offset != 0 && sacl_offset == size - sizeof(wimlib_ACL)) ||
 162         #endif
 163             (dacl_offset != 0 && dacl_offset == size - sizeof(wimlib_ACL))))
 164                 return (u8*)_desc;
 165
 166         owner_offset = le32_to_cpu(desc->owner_offset);
 167         group_offset = le32_to_cpu(desc->group_offset);
 168         owner = (const wimlib_SID*)((const u8*)desc + owner_offset);
 169         group = (const wimlib_SID*)((const u8*)desc + group_offset);
 170
 171         /* We'll try to move the owner or group SID to the end of the security
 172          * descriptor to avoid the bug.  This is only possible if at least one
 173          * is valid.  */
 174         owner_valid = (owner_offset != 0) &&
 175                         (owner_offset % 4 == 0) &&
 176                         (owner_offset <= size - sizeof(SID)) &&
 177                         (owner_offset + sid_size(owner) <= size) &&
 178                         (owner_offset >= sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE));
 179         group_valid = (group_offset != 0) &&
 180                         (group_offset % 4 == 0) &&
 181                         (group_offset <= size - sizeof(SID)) &&
 182                         (group_offset + sid_size(group) <= size) &&
 183                         (group_offset >= sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE));
 184         if (owner_valid) {
 185                 sid = owner;
 186         } else if (group_valid) {
 187                 sid = group;
 188         } else {
 189                 return (u8*)_desc;
 190         }
 191
 192         desc_new = MALLOC(size + sid_size(sid));
 193         if (!desc_new)
 194                 return (u8*)_desc;
 195
 196         memcpy(desc_new, desc, size);
 197         if (owner_valid)
 198                 desc_new->owner_offset = cpu_to_le32(size);
 199         else if (group_valid)
 200                 desc_new->group_offset = cpu_to_le32(size);
 201         memcpy((u8*)desc_new + size, sid, sid_size(sid));
 202         *size_p = size + sid_size(sid);
 203         return (u8*)desc_new;
 204 }
 205
 206 /* Set the security descriptor @desc of size @desc_size on the NTFS inode @ni.
 207   */
 208 static int
 209 ntfs_3g_set_security_descriptor(ntfs_inode *ni, const void *desc, size_t desc_size)
 210 {
 211         struct SECURITY_CONTEXT sec_ctx;
 212         u8 *desc_fixed;
 213         int ret = 0;
 214
 215         memset(&sec_ctx, 0, sizeof(sec_ctx));
 216         sec_ctx.vol = ni->vol;
 217
 218         desc_fixed = sd_fixup(desc, &desc_size);
 219
 220         if (ntfs_set_ntfs_acl(&sec_ctx, ni, desc_fixed, desc_size, 0))
 221                 ret = WIMLIB_ERR_SET_SECURITY;
 222
 223         if (desc_fixed != desc)
 224                 FREE(desc_fixed);
 225
 226         return ret;
 227 }
 228
 229 static int
 230 ntfs_3g_set_timestamps(ntfs_inode *ni, const struct wim_inode *inode)
 231 {
 232         u64 times[3] = {
 233                 inode->i_creation_time,
 234                 inode->i_last_write_time,
 235                 inode->i_last_access_time,
 236         };
 237
 238         if (ntfs_inode_set_times(ni, (const char *)times, sizeof(times), 0))
 239                 return WIMLIB_ERR_SET_TIMESTAMPS;
 240         return 0;
 241 }
 242
 243 /* Restore the timestamps on the NTFS inode corresponding to @inode.  */
 244 static int
 245 ntfs_3g_restore_timestamps(ntfs_volume *vol, const struct wim_inode *inode)
 246 {
 247         ntfs_inode *ni;
 248         int res;
 249
 250         ni = ntfs_inode_open(vol, inode->i_mft_no);
 251         if (!ni)
 252                 goto fail;
 253
 254         res = ntfs_3g_set_timestamps(ni, inode);
 255
 256         if (ntfs_inode_close(ni) || res)
 257                 goto fail;
 258
 259         return 0;
 260
 261 fail:
 262         ERROR_WITH_ERRNO("Failed to update timestamps of \"%s\" in NTFS volume",
 263                          dentry_full_path(inode_first_extraction_dentry(inode)));
 264         return WIMLIB_ERR_SET_TIMESTAMPS;
 265 }
 266
 267 /* Restore the DOS name of the @dentry.
 268  * This closes both @ni and @dir_ni.
 269  * If either is NULL, then they are opened temporarily.  */
 270 static int
 271 ntfs_3g_restore_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni,
 272                          struct wim_dentry *dentry, ntfs_volume *vol)
 273 {
 274         int ret;
 275         const char *dos_name;
 276         size_t dos_name_nbytes;
 277
 278         /* Note: ntfs_set_ntfs_dos_name() closes both inodes (even if it fails).
 279          * And it takes in a multibyte string, even though it translates it to
 280          * UTF-16LE internally... which is annoying because we currently have
 281          * the UTF-16LE string but not the multibyte string.  */
 282
 283         ret = utf16le_get_tstr(dentry->short_name, dentry->short_name_nbytes,
 284                                &dos_name, &dos_name_nbytes);
 285         if (ret)
 286                 goto out_close;
 287
 288         if (!dir_ni)
 289                 dir_ni = ntfs_inode_open(vol, dentry->d_parent->d_inode->i_mft_no);
 290         if (!ni)
 291                 ni = ntfs_inode_open(vol, dentry->d_inode->i_mft_no);
 292         if (dir_ni && ni) {
 293                 ret = ntfs_set_ntfs_dos_name(ni, dir_ni,
 294                                              dos_name, dos_name_nbytes, 0);
 295                 dir_ni = NULL;
 296                 ni = NULL;
 297         } else {
 298                 ret = -1;
 299         }
 300         utf16le_put_tstr(dos_name);
 301         if (ret) {
 302                 ERROR_WITH_ERRNO("Failed to set DOS name of \"%s\" in NTFS "
 303                                  "volume", dentry_full_path(dentry));
 304                 ret = WIMLIB_ERR_SET_SHORT_NAME;
 305                 goto out_close;
 306         }
 307
 308         /* Unlike most other NTFS-3g functions, ntfs_set_ntfs_dos_name()
 309          * changes the directory's last modification timestamp...
 310          * Change it back.  */
 311         return ntfs_3g_restore_timestamps(vol, dentry->d_parent->d_inode);
 312
 313 out_close:
 314         /* ntfs_inode_close() can take a NULL argument, but it's probably best
 315          * not to rely on this behavior.  */
 316         if (ni)
 317                 ntfs_inode_close(ni);
 318         if (dir_ni)
 319                 ntfs_inode_close(dir_ni);
 320         return ret;
 321 }
 322
 323 /*
 324  * Create empty named data streams for the specified file, if there are any.
 325  *
 326  * Since these won't have blob descriptors, they won't show up in the call to
 327  * extract_blob_list().  Hence the need for the special case.
 328  */
 329 static int
 330 ntfs_3g_create_empty_named_data_streams(ntfs_inode *ni,
 331                                         const struct wim_inode *inode,
 332                                         const struct ntfs_3g_apply_ctx *ctx)
 333 {
 334         for (unsigned i = 0; i < inode->i_num_streams; i++) {
 335
 336                 const struct wim_inode_stream *strm = &inode->i_streams[i];
 337
 338                 if (!stream_is_named_data_stream(strm) ||
 339                     stream_blob_resolved(strm) != NULL)
 340                         continue;
 341
 342                 if (ntfs_attr_add(ni, AT_DATA, strm->stream_name,
 343                                   utf16le_len_chars(strm->stream_name),
 344                                   NULL, 0))
 345                 {
 346                         ERROR_WITH_ERRNO("Failed to create named data stream "
 347                                          "of \"%s\"", dentry_full_path(
 348                                                 inode_first_extraction_dentry(inode)));
 349                         return WIMLIB_ERR_NTFS_3G;
 350                 }
 351         }
 352         return 0;
 353 }
 354
 355 /* Set attributes, security descriptor, and timestamps on the NTFS inode @ni.
 356  */
 357 static int
 358 ntfs_3g_set_metadata(ntfs_inode *ni, const struct wim_inode *inode,
 359                      const struct ntfs_3g_apply_ctx *ctx)
 360 {
 361         int extract_flags;
 362         const struct wim_security_data *sd;
 363         struct wim_dentry *one_dentry;
 364         int ret;
 365
 366         extract_flags = ctx->common.extract_flags;
 367         sd = wim_get_current_security_data(ctx->common.wim);
 368         one_dentry = inode_first_extraction_dentry(inode);
 369
 370         /* Attributes  */
 371         if (!(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)) {
 372                 u32 attrib = inode->i_attributes;
 373
 374                 attrib &= ~(FILE_ATTRIBUTE_SPARSE_FILE |
 375                             FILE_ATTRIBUTE_ENCRYPTED);
 376
 377                 if (ntfs_set_ntfs_attrib(ni, (const char *)&attrib,
 378                                          sizeof(attrib), 0))
 379                 {
 380                         ERROR_WITH_ERRNO("Failed to set attributes on \"%s\" "
 381                                          "in NTFS volume",
 382                                          dentry_full_path(one_dentry));
 383                         return WIMLIB_ERR_SET_ATTRIBUTES;
 384                 }
 385         }
 386
 387         /* Security descriptor  */
 388         if ((inode->i_security_id >= 0)
 389             && !(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
 390         {
 391                 const void *desc;
 392                 size_t desc_size;
 393
 394                 desc = sd->descriptors[inode->i_security_id];
 395                 desc_size = sd->sizes[inode->i_security_id];
 396
 397                 ret = ntfs_3g_set_security_descriptor(ni, desc, desc_size);
 398                 if (ret) {
 399                         if (wimlib_print_errors) {
 400                                 ERROR_WITH_ERRNO("Failed to set security descriptor "
 401                                                  "on \"%s\" in NTFS volume",
 402                                                  dentry_full_path(one_dentry));
 403                                 fprintf(wimlib_error_file,
 404                                         "The security descriptor is: ");
 405                                 print_byte_field(desc, desc_size, wimlib_error_file);
 406                                 fprintf(wimlib_error_file, "\n");
 407                         }
 408                         return ret;
 409                 }
 410         }
 411
 412         /* Timestamps  */
 413         ret = ntfs_3g_set_timestamps(ni, inode);
 414         if (ret) {
 415                 ERROR_WITH_ERRNO("Failed to set timestamps on \"%s\" "
 416                                  "in NTFS volume",
 417                                  dentry_full_path(one_dentry));
 418                 return ret;
 419         }
 420         return 0;
 421 }
 422
 423 /* Recursively creates all the subdirectories of @dir, which has been created as
 424  * the NTFS inode @dir_ni.  */
 425 static int
 426 ntfs_3g_create_dirs_recursive(ntfs_inode *dir_ni, struct wim_dentry *dir,
 427                               struct ntfs_3g_apply_ctx *ctx)
 428 {
 429         struct wim_dentry *child;
 430
 431         for_dentry_child(child, dir) {
 432                 ntfs_inode *ni;
 433                 int ret;
 434
 435                 if (!(child->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
 436                         continue;
 437                 if (!will_extract_dentry(child))
 438                         continue;
 439
 440                 ni = ntfs_create(dir_ni, 0, child->d_extraction_name,
 441                                  child->d_extraction_name_nchars, S_IFDIR);
 442                 if (!ni) {
 443                         ERROR_WITH_ERRNO("Error creating \"%s\" in NTFS volume",
 444                                          dentry_full_path(child));
 445                         return WIMLIB_ERR_NTFS_3G;
 446                 }
 447
 448                 child->d_inode->i_mft_no = ni->mft_no;
 449
 450                 ret = report_file_created(&ctx->common);
 451                 if (!ret)
 452                         ret = ntfs_3g_set_metadata(ni, child->d_inode, ctx);
 453                 if (!ret)
 454                         ret = ntfs_3g_create_empty_named_data_streams(ni, child->d_inode, ctx);
 455                 if (!ret)
 456                         ret = ntfs_3g_create_dirs_recursive(ni, child, ctx);
 457
 458                 if (ntfs_inode_close_in_dir(ni, dir_ni) && !ret) {
 459                         ERROR_WITH_ERRNO("Error closing \"%s\" in NTFS volume",
 460                                          dentry_full_path(child));
 461                         ret = WIMLIB_ERR_NTFS_3G;
 462                 }
 463                 if (ret)
 464                         return ret;
 465         }
 466         return 0;
 467 }
 468
 469 /* For each WIM dentry in the @root tree that represents a directory, create the
 470  * corresponding directory in the NTFS volume @ctx->vol.  */
 471 static int
 472 ntfs_3g_create_directories(struct wim_dentry *root,
 473                            struct list_head *dentry_list,
 474                            struct ntfs_3g_apply_ctx *ctx)
 475 {
 476         ntfs_inode *root_ni;
 477         int ret;
 478         struct wim_dentry *dentry;
 479
 480         /* Create the directories using POSIX names.  */
 481
 482         root_ni = ntfs_inode_open(ctx->vol, FILE_root);
 483         if (!root_ni) {
 484                 ERROR_WITH_ERRNO("Can't open root of NTFS volume");
 485                 return WIMLIB_ERR_NTFS_3G;
 486         }
 487
 488         root->d_inode->i_mft_no = FILE_root;
 489
 490         ret = ntfs_3g_create_dirs_recursive(root_ni, root, ctx);
 491
 492         if (ntfs_inode_close(root_ni) && !ret) {
 493                 ERROR_WITH_ERRNO("Error closing root of NTFS volume");
 494                 ret = WIMLIB_ERR_NTFS_3G;
 495         }
 496         if (ret)
 497                 return ret;
 498
 499         /* Set the DOS name of any directory that has one.  */
 500         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
 501                 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
 502                         continue;
 503                 if (!dentry_has_short_name(dentry))
 504                         continue;
 505                 ret = ntfs_3g_restore_dos_name(NULL, NULL, dentry, ctx->vol);
 506                 if (ret)
 507                         return ret;
 508                 ret = report_file_created(&ctx->common);
 509                 if (ret)
 510                         return ret;
 511         }
 512         return 0;
 513 }
 514
 515 /* When creating an inode that will have a short (DOS) name, we create it using
 516  * the long name associated with the short name.  This ensures that the short
 517  * name gets associated with the correct long name.  */
 518 static struct wim_dentry *
 519 ntfs_3g_first_extraction_alias(struct wim_inode *inode)
 520 {
 521         struct list_head *next = inode->i_extraction_aliases.next;
 522         struct wim_dentry *dentry;
 523
 524         do {
 525                 dentry = list_entry(next, struct wim_dentry,
 526                                     d_extraction_alias_node);
 527                 if (dentry_has_short_name(dentry))
 528                         break;
 529                 next = next->next;
 530         } while (next != &inode->i_extraction_aliases);
 531         return dentry;
 532 }
 533
 534 /*
 535  * Add a hard link for the NTFS inode @ni at the location corresponding to the
 536  * WIM dentry @dentry.
 537  *
 538  * The parent directory must have already been created on the NTFS volume.
 539  *
 540  * Returns 0 on success; returns WIMLIB_ERR_NTFS_3G and sets errno on failure.
 541  */
 542 static int
 543 ntfs_3g_add_link(ntfs_inode *ni, struct wim_dentry *dentry)
 544 {
 545         ntfs_inode *dir_ni;
 546         int res;
 547
 548         /* Open the inode of the parent directory.  */
 549         dir_ni = ntfs_inode_open(ni->vol, dentry->d_parent->d_inode->i_mft_no);
 550         if (!dir_ni)
 551                 goto fail;
 552
 553         /* Create the link.  */
 554         res = ntfs_link(ni, dir_ni, dentry->d_extraction_name,
 555                         dentry->d_extraction_name_nchars);
 556
 557         /* Close the parent directory.  */
 558         if (ntfs_inode_close(dir_ni) || res)
 559                 goto fail;
 560
 561         return 0;
 562
 563 fail:
 564         ERROR_WITH_ERRNO("Can't create link \"%s\" in NTFS volume",
 565                          dentry_full_path(dentry));
 566         return WIMLIB_ERR_NTFS_3G;
 567 }
 568
 569 static int
 570 ntfs_3g_create_nondirectory(struct wim_inode *inode,
 571                             const struct ntfs_3g_apply_ctx *ctx)
 572 {
 573         struct wim_dentry *first_dentry;
 574         ntfs_inode *dir_ni;
 575         ntfs_inode *ni;
 576         struct list_head *next;
 577         struct wim_dentry *dentry;
 578         int ret;
 579
 580         first_dentry = ntfs_3g_first_extraction_alias(inode);
 581
 582         /* Create first link.  */
 583
 584         dir_ni = ntfs_inode_open(ctx->vol, first_dentry->d_parent->d_inode->i_mft_no);
 585         if (!dir_ni) {
 586                 ERROR_WITH_ERRNO("Can't open \"%s\" in NTFS volume",
 587                                  dentry_full_path(first_dentry->d_parent));
 588                 return WIMLIB_ERR_NTFS_3G;
 589         }
 590
 591         ni = ntfs_create(dir_ni, 0, first_dentry->d_extraction_name,
 592                          first_dentry->d_extraction_name_nchars, S_IFREG);
 593
 594         if (!ni) {
 595                 ERROR_WITH_ERRNO("Can't create \"%s\" in NTFS volume",
 596                                  dentry_full_path(first_dentry));
 597                 ntfs_inode_close(dir_ni);
 598                 return WIMLIB_ERR_NTFS_3G;
 599         }
 600
 601         inode->i_mft_no = ni->mft_no;
 602
 603         /* Set short name if present.  */
 604         if (dentry_has_short_name(first_dentry)) {
 605
 606                 ret = ntfs_3g_restore_dos_name(ni, dir_ni, first_dentry, ctx->vol);
 607
 608                 /* ntfs_3g_restore_dos_name() closed both 'ni' and 'dir_ni'.  */
 609
 610                 if (ret)
 611                         return ret;
 612
 613                 /* Reopen the inode.  */
 614                 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
 615                 if (!ni) {
 616                         ERROR_WITH_ERRNO("Failed to reopen \"%s\" "
 617                                          "in NTFS volume",
 618                                          dentry_full_path(first_dentry));
 619                         return WIMLIB_ERR_NTFS_3G;
 620                 }
 621         } else {
 622                 /* Close the directory in which the first link was created.  */
 623                 if (ntfs_inode_close(dir_ni)) {
 624                         ERROR_WITH_ERRNO("Failed to close \"%s\" in NTFS volume",
 625                                          dentry_full_path(first_dentry->d_parent));
 626                         ret = WIMLIB_ERR_NTFS_3G;
 627                         goto out_close_ni;
 628                 }
 629         }
 630
 631         /* Create additional links if present.  */
 632         next = inode->i_extraction_aliases.next;
 633         do {
 634                 dentry = list_entry(next, struct wim_dentry,
 635                                     d_extraction_alias_node);
 636                 if (dentry != first_dentry) {
 637                         ret = ntfs_3g_add_link(ni, dentry);
 638                         if (ret)
 639                                 goto out_close_ni;
 640                 }
 641                 next = next->next;
 642         } while (next != &inode->i_extraction_aliases);
 643
 644         /* Set metadata.  */
 645         ret = ntfs_3g_set_metadata(ni, inode, ctx);
 646         if (ret)
 647                 goto out_close_ni;
 648
 649         ret = ntfs_3g_create_empty_named_data_streams(ni, inode, ctx);
 650
 651 out_close_ni:
 652         /* Close the inode.  */
 653         if (ntfs_inode_close(ni) && !ret) {
 654                 ERROR_WITH_ERRNO("Error closing \"%s\" in NTFS volume",
 655                                  dentry_full_path(first_dentry));
 656                 ret = WIMLIB_ERR_NTFS_3G;
 657         }
 658         return ret;
 659 }
 660
 661 /* For each WIM dentry in the @dentry_list that represents a nondirectory file,
 662  * create the corresponding nondirectory file in the NTFS volume.
 663  *
 664  * Directories must have already been created.  */
 665 static int
 666 ntfs_3g_create_nondirectories(struct list_head *dentry_list,
 667                               struct ntfs_3g_apply_ctx *ctx)
 668 {
 669         struct wim_dentry *dentry;
 670         struct wim_inode *inode;
 671         int ret;
 672
 673         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
 674                 inode = dentry->d_inode;
 675                 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
 676                         continue;
 677                 if (dentry == inode_first_extraction_dentry(inode)) {
 678                         ret = ntfs_3g_create_nondirectory(inode, ctx);
 679                         if (ret)
 680                                 return ret;
 681                 }
 682                 ret = report_file_created(&ctx->common);
 683                 if (ret)
 684                         return ret;
 685         }
 686         return 0;
 687 }
 688
 689 static int
 690 ntfs_3g_begin_extract_blob_instance(struct blob_descriptor *blob,
 691                                     ntfs_inode *ni,
 692                                     struct wim_inode *inode,
 693                                     const struct wim_inode_stream *strm,
 694                                     struct ntfs_3g_apply_ctx *ctx)
 695 {
 696         struct wim_dentry *one_dentry = inode_first_extraction_dentry(inode);
 697         size_t stream_name_nchars;
 698         ntfs_attr *attr;
 699
 700         if (unlikely(strm->stream_type == STREAM_TYPE_REPARSE_POINT)) {
 701
 702                 if (blob->size > REPARSE_DATA_MAX_SIZE) {
 703                         ERROR("Reparse data of \"%s\" has size "
 704                               "%"PRIu64" bytes (exceeds %u bytes)",
 705                               dentry_full_path(one_dentry),
 706                               blob->size, REPARSE_DATA_MAX_SIZE);
 707                         return WIMLIB_ERR_INVALID_REPARSE_DATA;
 708                 }
 709                 ctx->reparse_ptr = ctx->rpbuf.rpdata;
 710                 ctx->ntfs_reparse_inodes[ctx->num_reparse_inodes] = ni;
 711                 ctx->wim_reparse_inodes[ctx->num_reparse_inodes] = inode;
 712                 ctx->num_reparse_inodes++;
 713                 return 0;
 714         }
 715
 716         /* It's a data stream (may be unnamed or named).  */
 717         wimlib_assert(strm->stream_type == STREAM_TYPE_DATA);
 718
 719         stream_name_nchars = utf16le_len_chars(strm->stream_name);
 720
 721         if (stream_name_nchars &&
 722             (ntfs_attr_add(ni, AT_DATA, strm->stream_name,
 723                            stream_name_nchars, NULL, 0)))
 724         {
 725                 ERROR_WITH_ERRNO("Failed to create named data stream of \"%s\"",
 726                                  dentry_full_path(one_dentry));
 727                 return WIMLIB_ERR_NTFS_3G;
 728         }
 729
 730         /* This should be ensured by extract_blob_list()  */
 731         wimlib_assert(ctx->num_open_attrs < MAX_OPEN_FILES);
 732
 733         attr = ntfs_attr_open(ni, AT_DATA, strm->stream_name,
 734                               stream_name_nchars);
 735         if (!attr) {
 736                 ERROR_WITH_ERRNO("Failed to open data stream of \"%s\"",
 737                                  dentry_full_path(one_dentry));
 738                 return WIMLIB_ERR_NTFS_3G;
 739         }
 740         ctx->open_attrs[ctx->num_open_attrs++] = attr;
 741         ntfs_attr_truncate_solid(attr, blob->size);
 742         return 0;
 743 }
 744
 745 static int
 746 ntfs_3g_cleanup_blob_extract(struct ntfs_3g_apply_ctx *ctx)
 747 {
 748         int ret = 0;
 749
 750         for (unsigned i = 0; i < ctx->num_open_attrs; i++) {
 751                 if (ntfs_attr_pclose(ctx->open_attrs[i]))
 752                         ret = -1;
 753                 ntfs_attr_close(ctx->open_attrs[i]);
 754         }
 755
 756         ctx->num_open_attrs = 0;
 757
 758         for (unsigned i = 0; i < ctx->num_open_inodes; i++) {
 759                 if (ntfs_inode_close(ctx->open_inodes[i]))
 760                         ret = -1;
 761         }
 762         ctx->num_open_inodes = 0;
 763
 764         ctx->offset = 0;
 765         ctx->reparse_ptr = NULL;
 766         ctx->num_reparse_inodes = 0;
 767         return ret;
 768 }
 769
 770 static ntfs_inode *
 771 ntfs_3g_open_inode(struct wim_inode *inode, struct ntfs_3g_apply_ctx *ctx)
 772 {
 773         ntfs_inode *ni = NULL;
 774
 775         if (inode->i_visited) {
 776                 for (u32 i = 0; i < ctx->num_open_inodes; i++) {
 777                         if (ctx->open_inodes[i]->mft_no == inode->i_mft_no) {
 778                                 ni = ctx->open_inodes[i];
 779                                 break;
 780                         }
 781                 }
 782         }
 783         if (!ni) {
 784                 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
 785                 ctx->open_inodes[ctx->num_open_inodes++] = ni;
 786                 inode->i_visited = 1;
 787         }
 788
 789         if (!ni) {
 790                 ERROR_WITH_ERRNO("Can't open \"%s\" in NTFS volume",
 791                                  dentry_full_path(
 792                                         inode_first_extraction_dentry(inode)));
 793                 return NULL;
 794         }
 795         return ni;
 796 }
 797
 798 static int
 799 ntfs_3g_begin_extract_blob(struct blob_descriptor *blob, void *_ctx)
 800 {
 801         struct ntfs_3g_apply_ctx *ctx = _ctx;
 802         const struct blob_extraction_target *targets = blob_extraction_targets(blob);
 803         int ret;
 804         ntfs_inode *ni;
 805
 806         for (u32 i = 0; i < blob->out_refcnt; i++) {
 807                 ret = WIMLIB_ERR_NTFS_3G;
 808                 ni = ntfs_3g_open_inode(targets[i].inode, ctx);
 809                 if (!ni)
 810                         goto out_cleanup;
 811
 812                 ret = ntfs_3g_begin_extract_blob_instance(blob, ni,
 813                                                           targets[i].inode,
 814                                                           targets[i].stream, ctx);
 815                 if (ret)
 816                         goto out_cleanup;
 817         }
 818         ret = 0;
 819         goto out;
 820
 821 out_cleanup:
 822         ntfs_3g_cleanup_blob_extract(ctx);
 823 out:
 824         for (u32 i = 0; i < blob->out_refcnt; i++)
 825                 targets[i].inode->i_visited = 0;
 826         return ret;
 827 }
 828
 829 static int
 830 ntfs_3g_extract_chunk(const void *chunk, size_t size, void *_ctx)
 831 {
 832         struct ntfs_3g_apply_ctx *ctx = _ctx;
 833         s64 res;
 834
 835         for (unsigned i = 0; i < ctx->num_open_attrs; i++) {
 836                 res = ntfs_attr_pwrite(ctx->open_attrs[i],
 837                                        ctx->offset, size, chunk);
 838                 if (res != size) {
 839                         ERROR_WITH_ERRNO("Error writing data to NTFS volume");
 840                         return WIMLIB_ERR_NTFS_3G;
 841                 }
 842         }
 843         if (ctx->reparse_ptr)
 844                 ctx->reparse_ptr = mempcpy(ctx->reparse_ptr, chunk, size);
 845         ctx->offset += size;
 846         return 0;
 847 }
 848
 849 static int
 850 ntfs_3g_end_extract_blob(struct blob_descriptor *blob, int status, void *_ctx)
 851 {
 852         struct ntfs_3g_apply_ctx *ctx = _ctx;
 853         int ret;
 854
 855         if (status) {
 856                 ret = status;
 857                 goto out;
 858         }
 859
 860         for (u32 i = 0; i < ctx->num_reparse_inodes; i++) {
 861                 struct wim_inode *inode = ctx->wim_reparse_inodes[i];
 862
 863                 complete_reparse_point(&ctx->rpbuf, inode, blob->size);
 864
 865                 if (ntfs_set_ntfs_reparse_data(ctx->ntfs_reparse_inodes[i],
 866                                                (const char *)&ctx->rpbuf,
 867                                                REPARSE_DATA_OFFSET + blob->size,
 868                                                0))
 869                 {
 870                         ERROR_WITH_ERRNO("Failed to set reparse "
 871                                          "data on \"%s\"",
 872                                          dentry_full_path(
 873                                                 inode_first_extraction_dentry(inode)));
 874                         ret = WIMLIB_ERR_SET_REPARSE_DATA;
 875                         goto out;
 876                 }
 877         }
 878         ret = 0;
 879 out:
 880         if (ntfs_3g_cleanup_blob_extract(ctx) && !ret) {
 881                 ERROR_WITH_ERRNO("Error writing data to NTFS volume");
 882                 ret = WIMLIB_ERR_NTFS_3G;
 883         }
 884         return ret;
 885 }
 886
 887 static u64
 888 ntfs_3g_count_dentries(const struct list_head *dentry_list)
 889 {
 890         const struct wim_dentry *dentry;
 891         u64 count = 0;
 892
 893         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
 894                 count++;
 895                 if ((dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) &&
 896                     dentry_has_short_name(dentry))
 897                 {
 898                         count++;
 899                 }
 900         }
 901
 902         return count;
 903 }
 904
 905 static int
 906 ntfs_3g_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
 907 {
 908         struct ntfs_3g_apply_ctx *ctx = (struct ntfs_3g_apply_ctx *)_ctx;
 909         ntfs_volume *vol;
 910         struct wim_dentry *root;
 911         int ret;
 912
 913         /* For NTFS-3g extraction mode we require that the dentries to extract
 914          * form a single tree.  */
 915         root = list_first_entry(dentry_list, struct wim_dentry,
 916                                 d_extraction_list_node);
 917
 918         /* Mount the NTFS volume.  */
 919         vol = ntfs_mount(ctx->common.target, 0);
 920         if (!vol) {
 921                 ERROR_WITH_ERRNO("Failed to mount \"%s\" with NTFS-3g",
 922                                  ctx->common.target);
 923                 return WIMLIB_ERR_NTFS_3G;
 924         }
 925         ctx->vol = vol;
 926
 927         /* Create all inodes and aliases, including short names, and set
 928          * metadata (attributes, security descriptors, and timestamps).  */
 929
 930         ret = start_file_structure_phase(&ctx->common,
 931                                          ntfs_3g_count_dentries(dentry_list));
 932         if (ret)
 933                 goto out_unmount;
 934
 935         ret = ntfs_3g_create_directories(root, dentry_list, ctx);
 936         if (ret)
 937                 goto out_unmount;
 938
 939         ret = ntfs_3g_create_nondirectories(dentry_list, ctx);
 940         if (ret)
 941                 goto out_unmount;
 942
 943         ret = end_file_structure_phase(&ctx->common);
 944         if (ret)
 945                 goto out_unmount;
 946
 947         /* Extract blobs.  */
 948         struct read_blob_callbacks cbs = {
 949                 .begin_blob     = ntfs_3g_begin_extract_blob,
 950                 .consume_chunk  = ntfs_3g_extract_chunk,
 951                 .end_blob       = ntfs_3g_end_extract_blob,
 952                 .ctx            = ctx,
 953         };
 954         ret = extract_blob_list(&ctx->common, &cbs);
 955
 956         /* We do not need a final pass to set timestamps because libntfs-3g does
 957          * not update timestamps automatically (exception:
 958          * ntfs_set_ntfs_dos_name() does, but we handle this elsewhere).  */
 959
 960 out_unmount:
 961         if (ntfs_umount(ctx->vol, FALSE) && !ret) {
 962                 ERROR_WITH_ERRNO("Failed to unmount \"%s\" with NTFS-3g",
 963                                  ctx->common.target);
 964                 ret = WIMLIB_ERR_NTFS_3G;
 965         }
 966         return ret;
 967 }
 968
 969 const struct apply_operations ntfs_3g_apply_ops = {
 970         .name                   = "NTFS-3g",
 971         .get_supported_features = ntfs_3g_get_supported_features,
 972         .extract                = ntfs_3g_extract,
 973         .context_size           = sizeof(struct ntfs_3g_apply_ctx),
 974         .single_tree_only       = true,
 975 };
 976
 977 void
 978 libntfs3g_global_init(void)
 979 {
 980        ntfs_set_char_encoding(setlocale(LC_ALL, ""));
 981 }