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