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