wimlib.net Git - wimlib/blob - src/win32_capture.c

   1 /*
   2  * win32_capture.c - Windows-specific code for capturing files into a WIM image.
   3  *
   4  * This now uses the native Windows NT API a lot and not just Win32.
   5  */
   6
   7 /*
   8  * Copyright (C) 2013, 2014 Eric Biggers
   9  *
  10  * This file is part of wimlib, a library for working with WIM files.
  11  *
  12  * wimlib is free software; you can redistribute it and/or modify it under the
  13  * terms of the GNU General Public License as published by the Free
  14  * Software Foundation; either version 3 of the License, or (at your option)
  15  * any later version.
  16  *
  17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  19  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  20  * details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  24  */
  25
  26 #ifdef __WIN32__
  27
  28 #ifdef HAVE_CONFIG_H
  29 #  include "config.h"
  30 #endif
  31
  32 #include "wimlib/win32_common.h"
  33
  34 #include "wimlib/capture.h"
  35 #include "wimlib/dentry.h"
  36 #include "wimlib/encoding.h"
  37 #include "wimlib/endianness.h"
  38 #include "wimlib/error.h"
  39 #include "wimlib/lookup_table.h"
  40 #include "wimlib/paths.h"
  41 #include "wimlib/reparse.h"
  42
  43 #include <errno.h>
  44
  45 struct winnt_scan_stats {
  46         unsigned long num_get_sd_access_denied;
  47         unsigned long num_get_sacl_priv_notheld;
  48 };
  49
  50 static inline const wchar_t *
  51 printable_path(const wchar_t *full_path)
  52 {
  53         /* Skip over \\?\ or \??\  */
  54         return full_path + 4;
  55 }
  56
  57 /*
  58  * If cur_dir is not NULL, open an existing file relative to the already-open
  59  * directory cur_dir.
  60  *
  61  * Otherwise, open the file specified by @path, which must be a Windows NT
  62  * namespace path.
  63  */
  64 static NTSTATUS
  65 winnt_openat(HANDLE cur_dir, const wchar_t *path, size_t path_nchars,
  66              ACCESS_MASK perms, HANDLE *h_ret)
  67 {
  68         UNICODE_STRING name;
  69         OBJECT_ATTRIBUTES attr;
  70         IO_STATUS_BLOCK iosb;
  71         NTSTATUS status;
  72
  73         name.Length = path_nchars * sizeof(wchar_t);
  74         name.MaximumLength = name.Length + sizeof(wchar_t);
  75         name.Buffer = (wchar_t *)path;
  76
  77         attr.Length = sizeof(attr);
  78         attr.RootDirectory = cur_dir;
  79         attr.ObjectName = &name;
  80         attr.Attributes = 0;
  81         attr.SecurityDescriptor = NULL;
  82         attr.SecurityQualityOfService = NULL;
  83
  84 retry:
  85         status = (*func_NtOpenFile)(h_ret, perms, &attr, &iosb,
  86                                     FILE_SHARE_VALID_FLAGS,
  87                                     FILE_OPEN_REPARSE_POINT |
  88                                             FILE_OPEN_FOR_BACKUP_INTENT |
  89                                             FILE_SYNCHRONOUS_IO_NONALERT |
  90                                             FILE_SEQUENTIAL_ONLY);
  91         if (!NT_SUCCESS(status)) {
  92                 /* Try requesting fewer permissions  */
  93                 if (status == STATUS_ACCESS_DENIED ||
  94                     status == STATUS_PRIVILEGE_NOT_HELD) {
  95                         if (perms & ACCESS_SYSTEM_SECURITY) {
  96                                 perms &= ~ACCESS_SYSTEM_SECURITY;
  97                                 goto retry;
  98                         }
  99                         if (perms & READ_CONTROL) {
 100                                 perms &= ~READ_CONTROL;
 101                                 goto retry;
 102                         }
 103                 }
 104         }
 105         return status;
 106 }
 107
 108 /* Read the first @size bytes from the file, or named data stream of a file,
 109  * from which the stream entry @lte was created.  */
 110 int
 111 read_winnt_file_prefix(const struct wim_lookup_table_entry *lte, u64 size,
 112                        consume_data_callback_t cb, void *cb_ctx)
 113 {
 114         const wchar_t *path;
 115         HANDLE h;
 116         NTSTATUS status;
 117         u8 buf[BUFFER_SIZE];
 118         u64 bytes_remaining;
 119         int ret;
 120
 121         /* This is an NT namespace path.  */
 122         path = lte->file_on_disk;
 123
 124         status = winnt_openat(NULL, path, wcslen(path),
 125                               FILE_READ_DATA | SYNCHRONIZE, &h);
 126         if (!NT_SUCCESS(status)) {
 127                 set_errno_from_nt_status(status);
 128                 ERROR_WITH_ERRNO("\"%ls\": Can't open for reading "
 129                                  "(status=0x%08"PRIx32")",
 130                                  printable_path(path), (u32)status);
 131                 return WIMLIB_ERR_OPEN;
 132         }
 133
 134         ret = 0;
 135         bytes_remaining = size;
 136         while (bytes_remaining) {
 137                 IO_STATUS_BLOCK iosb;
 138                 ULONG count;
 139                 ULONG bytes_read;
 140
 141                 count = min(sizeof(buf), bytes_remaining);
 142
 143                 status = (*func_NtReadFile)(h, NULL, NULL, NULL,
 144                                             &iosb, buf, count, NULL, NULL);
 145                 if (!NT_SUCCESS(status)) {
 146                         set_errno_from_nt_status(status);
 147                         ERROR_WITH_ERRNO("\"%ls\": Error reading data "
 148                                          "(status=0x%08"PRIx32")",
 149                                          printable_path(path), (u32)status);
 150                         ret = WIMLIB_ERR_READ;
 151                         break;
 152                 }
 153
 154                 bytes_read = iosb.Information;
 155
 156                 bytes_remaining -= bytes_read;
 157                 ret = (*cb)(buf, bytes_read, cb_ctx);
 158                 if (ret)
 159                         break;
 160         }
 161         (*func_NtClose)(h);
 162         return ret;
 163 }
 164
 165 struct win32_encrypted_read_ctx {
 166         consume_data_callback_t read_prefix_cb;
 167         void *read_prefix_ctx;
 168         int wimlib_err_code;
 169         u64 bytes_remaining;
 170 };
 171
 172 static DWORD WINAPI
 173 win32_encrypted_export_cb(unsigned char *data, void *_ctx, unsigned long len)
 174 {
 175         struct win32_encrypted_read_ctx *ctx = _ctx;
 176         int ret;
 177         size_t bytes_to_consume = min(len, ctx->bytes_remaining);
 178
 179         if (bytes_to_consume == 0)
 180                 return ERROR_SUCCESS;
 181
 182         ret = (*ctx->read_prefix_cb)(data, bytes_to_consume, ctx->read_prefix_ctx);
 183         if (ret) {
 184                 ctx->wimlib_err_code = ret;
 185                 /* Shouldn't matter what error code is returned here, as long as
 186                  * it isn't ERROR_SUCCESS.  */
 187                 return ERROR_READ_FAULT;
 188         }
 189         ctx->bytes_remaining -= bytes_to_consume;
 190         return ERROR_SUCCESS;
 191 }
 192
 193 int
 194 read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte,
 195                                  u64 size,
 196                                  consume_data_callback_t cb, void *cb_ctx)
 197 {
 198         struct win32_encrypted_read_ctx export_ctx;
 199         DWORD err;
 200         void *file_ctx;
 201         int ret;
 202
 203         export_ctx.read_prefix_cb = cb;
 204         export_ctx.read_prefix_ctx = cb_ctx;
 205         export_ctx.wimlib_err_code = 0;
 206         export_ctx.bytes_remaining = size;
 207
 208         err = OpenEncryptedFileRaw(lte->file_on_disk, 0, &file_ctx);
 209         if (err != ERROR_SUCCESS) {
 210                 set_errno_from_win32_error(err);
 211                 ERROR_WITH_ERRNO("Failed to open encrypted file \"%ls\" "
 212                                  "for raw read",
 213                                  printable_path(lte->file_on_disk));
 214                 return WIMLIB_ERR_OPEN;
 215         }
 216         err = ReadEncryptedFileRaw(win32_encrypted_export_cb,
 217                                    &export_ctx, file_ctx);
 218         if (err != ERROR_SUCCESS) {
 219                 set_errno_from_win32_error(err);
 220                 ERROR_WITH_ERRNO("Failed to read encrypted file \"%ls\"",
 221                                  printable_path(lte->file_on_disk));
 222                 ret = export_ctx.wimlib_err_code;
 223                 if (ret == 0)
 224                         ret = WIMLIB_ERR_READ;
 225         } else if (export_ctx.bytes_remaining != 0) {
 226                 ERROR("Only could read %"PRIu64" of %"PRIu64" bytes from "
 227                       "encryted file \"%ls\"",
 228                       size - export_ctx.bytes_remaining, size,
 229                       printable_path(lte->file_on_disk));
 230                 ret = WIMLIB_ERR_READ;
 231         } else {
 232                 ret = 0;
 233         }
 234         CloseEncryptedFileRaw(file_ctx);
 235         return ret;
 236 }
 237
 238 /*
 239  * Load the short name of a file into a WIM dentry.
 240  */
 241 static NTSTATUS
 242 winnt_get_short_name(HANDLE h, struct wim_dentry *dentry)
 243 {
 244         /* It's not any harder to just make the NtQueryInformationFile() system
 245          * call ourselves, and it saves a dumb call to FindFirstFile() which of
 246          * course has to create its own handle.  */
 247         NTSTATUS status;
 248         IO_STATUS_BLOCK iosb;
 249         u8 buf[128] _aligned_attribute(8);
 250         const FILE_NAME_INFORMATION *info;
 251
 252         status = (*func_NtQueryInformationFile)(h, &iosb, buf, sizeof(buf),
 253                                                 FileAlternateNameInformation);
 254         info = (const FILE_NAME_INFORMATION *)buf;
 255         if (NT_SUCCESS(status) && info->FileNameLength != 0) {
 256                 dentry->short_name = utf16le_dupz(info->FileName,
 257                                                   info->FileNameLength);
 258                 if (!dentry->short_name)
 259                         return STATUS_NO_MEMORY;
 260                 dentry->short_name_nbytes = info->FileNameLength;
 261         }
 262         return status;
 263 }
 264
 265 /*
 266  * Load the security descriptor of a file into the corresponding inode, and the
 267  * WIM image's security descriptor set.
 268  */
 269 static NTSTATUS
 270 winnt_get_security_descriptor(HANDLE h, struct wim_inode *inode,
 271                               struct wim_sd_set *sd_set,
 272                               struct winnt_scan_stats *stats, int add_flags)
 273 {
 274         SECURITY_INFORMATION requestedInformation;
 275         u8 _buf[4096] _aligned_attribute(8);
 276         u8 *buf;
 277         ULONG bufsize;
 278         ULONG len_needed;
 279         NTSTATUS status;
 280
 281         requestedInformation = DACL_SECURITY_INFORMATION |
 282                                SACL_SECURITY_INFORMATION |
 283                                OWNER_SECURITY_INFORMATION |
 284                                GROUP_SECURITY_INFORMATION;
 285         buf = _buf;
 286         bufsize = sizeof(_buf);
 287
 288         /*
 289          * We need the file's security descriptor in
 290          * SECURITY_DESCRIPTOR_RELATIVE format, and we currently have a handle
 291          * opened with as many relevant permissions as possible.  At this point,
 292          * on Windows there are a number of options for reading a file's
 293          * security descriptor:
 294          *
 295          * GetFileSecurity():  This takes in a path and returns the
 296          * SECURITY_DESCRIPTOR_RELATIVE.  Problem: this uses an internal handle,
 297          * not ours, and the handle created internally doesn't specify
 298          * FILE_FLAG_BACKUP_SEMANTICS.  Therefore there can be access denied
 299          * errors on some files and directories, even when running as the
 300          * Administrator.
 301          *
 302          * GetSecurityInfo():  This takes in a handle and returns the security
 303          * descriptor split into a bunch of different parts.  This should work,
 304          * but it's dumb because we have to put the security descriptor back
 305          * together again.
 306          *
 307          * BackupRead():  This can read the security descriptor, but this is a
 308          * difficult-to-use API, probably only works as the Administrator, and
 309          * the format of the returned data is not well documented.
 310          *
 311          * NtQuerySecurityObject():  This is exactly what we need, as it takes
 312          * in a handle and returns the security descriptor in
 313          * SECURITY_DESCRIPTOR_RELATIVE format.  Only problem is that it's a
 314          * ntdll function and therefore not officially part of the Win32 API.
 315          * Oh well.
 316          */
 317         while (!(NT_SUCCESS(status = (*func_NtQuerySecurityObject)(h,
 318                                                                    requestedInformation,
 319                                                                    (PSECURITY_DESCRIPTOR)buf,
 320                                                                    bufsize,
 321                                                                    &len_needed))))
 322         {
 323                 switch (status) {
 324                 case STATUS_BUFFER_TOO_SMALL:
 325                         wimlib_assert(buf == _buf);
 326                         buf = MALLOC(len_needed);
 327                         if (!buf)
 328                                 return STATUS_NO_MEMORY;
 329                         bufsize = len_needed;
 330                         break;
 331                 case STATUS_PRIVILEGE_NOT_HELD:
 332                 case STATUS_ACCESS_DENIED:
 333                         if (add_flags & WIMLIB_ADD_FLAG_STRICT_ACLS) {
 334                 default:
 335                                 /* Permission denied in STRICT_ACLS mode, or
 336                                  * unknown error.  */
 337                                 goto out_free_buf;
 338                         }
 339                         if (requestedInformation & SACL_SECURITY_INFORMATION) {
 340                                 /* Try again without the SACL.  */
 341                                 stats->num_get_sacl_priv_notheld++;
 342                                 requestedInformation &= ~SACL_SECURITY_INFORMATION;
 343                                 break;
 344                         }
 345                         /* Fake success (useful when capturing as
 346                          * non-Administrator).  */
 347                         stats->num_get_sd_access_denied++;
 348                         status = STATUS_SUCCESS;
 349                         goto out_free_buf;
 350                 }
 351         }
 352
 353         /* Add the security descriptor to the WIM image, and save its ID in
 354          * file's inode.  */
 355         inode->i_security_id = sd_set_add_sd(sd_set, buf, len_needed);
 356         if (unlikely(inode->i_security_id < 0))
 357                 status = STATUS_NO_MEMORY;
 358 out_free_buf:
 359         if (unlikely(buf != _buf))
 360                 FREE(buf);
 361         return status;
 362 }
 363
 364 static int
 365 winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret,
 366                                   HANDLE cur_dir,
 367                                   wchar_t *full_path,
 368                                   size_t full_path_nchars,
 369                                   const wchar_t *filename,
 370                                   size_t filename_nchars,
 371                                   struct add_image_params *params,
 372                                   struct winnt_scan_stats *stats,
 373                                   u32 vol_flags);
 374
 375 static int
 376 winnt_recurse_directory(HANDLE h,
 377                         wchar_t *full_path,
 378                         size_t full_path_nchars,
 379                         struct wim_dentry *parent,
 380                         struct add_image_params *params,
 381                         struct winnt_scan_stats *stats,
 382                         u32 vol_flags)
 383 {
 384         void *buf;
 385         const size_t bufsize = 8192;
 386         IO_STATUS_BLOCK iosb;
 387         NTSTATUS status;
 388         int ret;
 389
 390         buf = MALLOC(bufsize);
 391         if (!buf)
 392                 return WIMLIB_ERR_NOMEM;
 393
 394         /* Using NtQueryDirectoryFile() we can re-use the same open handle,
 395          * which we opened with FILE_FLAG_BACKUP_SEMANTICS.  */
 396
 397         while (NT_SUCCESS(status = (*func_NtQueryDirectoryFile)(h, NULL, NULL, NULL,
 398                                                                 &iosb, buf, bufsize,
 399                                                                 FileNamesInformation,
 400                                                                 FALSE, NULL, FALSE)))
 401         {
 402                 const FILE_NAMES_INFORMATION *info = buf;
 403                 for (;;) {
 404                         if (!(info->FileNameLength == 2 && info->FileName[0] == L'.') &&
 405                             !(info->FileNameLength == 4 && info->FileName[0] == L'.' &&
 406                                                            info->FileName[1] == L'.'))
 407                         {
 408                                 wchar_t *p;
 409                                 wchar_t *filename;
 410                                 struct wim_dentry *child;
 411
 412                                 p = full_path + full_path_nchars;
 413                                 /* Only add a backslash if we don't already have
 414                                  * one.  This prevents a duplicate backslash
 415                                  * from being added when the path to the capture
 416                                  * dir had a trailing backslash.  */
 417                                 if (*(p - 1) != L'\\')
 418                                         *p++ = L'\\';
 419                                 filename = p;
 420                                 p = wmempcpy(filename, info->FileName,
 421                                              info->FileNameLength / 2);
 422                                 *p = '\0';
 423
 424                                 ret = winnt_build_dentry_tree_recursive(
 425                                                         &child,
 426                                                         h,
 427                                                         full_path,
 428                                                         p - full_path,
 429                                                         filename,
 430                                                         info->FileNameLength / 2,
 431                                                         params,
 432                                                         stats,
 433                                                         vol_flags);
 434
 435                                 full_path[full_path_nchars] = L'\0';
 436
 437                                 if (ret)
 438                                         goto out_free_buf;
 439                                 if (child)
 440                                         dentry_add_child(parent, child);
 441                         }
 442                         if (info->NextEntryOffset == 0)
 443                                 break;
 444                         info = (const FILE_NAMES_INFORMATION *)
 445                                         ((const u8 *)info + info->NextEntryOffset);
 446                 }
 447         }
 448
 449         if (unlikely(status != STATUS_NO_MORE_FILES)) {
 450                 set_errno_from_nt_status(status);
 451                 ERROR_WITH_ERRNO("\"%ls\": Can't read directory "
 452                                  "(status=0x%08"PRIx32")",
 453                                  printable_path(full_path), (u32)status);
 454                 ret = WIMLIB_ERR_READ;
 455         }
 456 out_free_buf:
 457         FREE(buf);
 458         return ret;
 459 }
 460
 461 /* Reparse point fixup status code  */
 462 enum rp_status {
 463         /* Reparse point will be captured literally (no fixup)  */
 464         RP_NOT_FIXED    = -1,
 465
 466         /* Reparse point will be captured with fixup  */
 467         RP_FIXED        = -2,
 468 };
 469
 470 static bool
 471 file_has_ino_and_dev(HANDLE h, u64 ino, u64 dev)
 472 {
 473         NTSTATUS status;
 474         IO_STATUS_BLOCK iosb;
 475         FILE_INTERNAL_INFORMATION int_info;
 476         FILE_FS_VOLUME_INFORMATION vol_info;
 477
 478         status = (*func_NtQueryInformationFile)(h, &iosb,
 479                                                 &int_info, sizeof(int_info),
 480                                                 FileInternalInformation);
 481         if (!NT_SUCCESS(status))
 482                 return false;
 483
 484         if (int_info.IndexNumber.QuadPart != ino)
 485                 return false;
 486
 487         status = (*func_NtQueryVolumeInformationFile)(h, &iosb,
 488                                                       &vol_info, sizeof(vol_info),
 489                                                       FileFsVolumeInformation);
 490         if (!(NT_SUCCESS(status) || status == STATUS_BUFFER_OVERFLOW))
 491                 return false;
 492
 493         if (iosb.Information <
 494              offsetof(FILE_FS_VOLUME_INFORMATION, VolumeSerialNumber) +
 495              sizeof(vol_info.VolumeSerialNumber))
 496                 return false;
 497
 498         return (vol_info.VolumeSerialNumber == dev);
 499 }
 500
 501 /*
 502  * Given an (expected) NT namespace symbolic link or junction target @target of
 503  * length @target_nbytes, determine if a prefix of the target points to a file
 504  * identified by @capture_root_ino and @capture_root_dev.
 505  *
 506  * If yes, return a pointer to the portion of the link following this prefix.
 507  *
 508  * If no, return NULL.
 509  *
 510  * If the link target does not appear to be a valid NT namespace path, return
 511  * @target itself.
 512  */
 513 static const wchar_t *
 514 winnt_get_root_relative_target(const wchar_t *target, size_t target_nbytes,
 515                                u64 capture_root_ino, u64 capture_root_dev)
 516 {
 517         UNICODE_STRING name;
 518         OBJECT_ATTRIBUTES attr;
 519         IO_STATUS_BLOCK iosb;
 520         NTSTATUS status;
 521         const wchar_t *target_end;
 522         const wchar_t *p;
 523
 524         target_end = target + (target_nbytes / sizeof(wchar_t));
 525
 526         /* Empty path??? */
 527         if (target_end == target)
 528                 return target;
 529
 530         /* No leading slash???  */
 531         if (target[0] != L'\\')
 532                 return target;
 533
 534         /* UNC path???  */
 535         if ((target_end - target) >= 2 &&
 536             target[0] == L'\\' && target[1] == L'\\')
 537                 return target;
 538
 539         attr.Length = sizeof(attr);
 540         attr.RootDirectory = NULL;
 541         attr.ObjectName = &name;
 542         attr.Attributes = 0;
 543         attr.SecurityDescriptor = NULL;
 544         attr.SecurityQualityOfService = NULL;
 545
 546         name.Buffer = (wchar_t *)target;
 547         name.Length = 0;
 548         p = target;
 549         do {
 550                 HANDLE h;
 551                 const wchar_t *orig_p = p;
 552
 553                 /* Skip non-backslashes  */
 554                 while (p != target_end && *p != L'\\')
 555                         p++;
 556
 557                 /* Skip backslashes  */
 558                 while (p != target_end && *p == L'\\')
 559                         p++;
 560
 561                 /* Append path component  */
 562                 name.Length += (p - orig_p) * sizeof(wchar_t);
 563                 name.MaximumLength = name.Length;
 564
 565                 /* Try opening the file  */
 566                 status = (*func_NtOpenFile) (&h,
 567                                              FILE_READ_ATTRIBUTES | FILE_TRAVERSE,
 568                                              &attr,
 569                                              &iosb,
 570                                              FILE_SHARE_VALID_FLAGS,
 571                                              FILE_OPEN_FOR_BACKUP_INTENT);
 572
 573                 if (NT_SUCCESS(status)) {
 574                         /* Reset root directory  */
 575                         if (attr.RootDirectory)
 576                                 (*func_NtClose)(attr.RootDirectory);
 577                         attr.RootDirectory = h;
 578                         name.Buffer = (wchar_t *)p;
 579                         name.Length = 0;
 580
 581                         if (file_has_ino_and_dev(h, capture_root_ino,
 582                                                  capture_root_dev))
 583                                 goto out_close_root_dir;
 584                 }
 585         } while (p != target_end);
 586
 587         p = NULL;
 588
 589 out_close_root_dir:
 590         if (attr.RootDirectory)
 591                 (*func_NtClose)(attr.RootDirectory);
 592         return p;
 593 }
 594
 595 static int
 596 winnt_rpfix_progress(struct add_image_params *params, const wchar_t *path,
 597                      const struct reparse_data *rpdata,
 598                      enum wimlib_progress_msg msg)
 599 {
 600         size_t print_name_nchars = rpdata->print_name_nbytes / sizeof(wchar_t);
 601         wchar_t print_name0[print_name_nchars + 1];
 602
 603         wmemcpy(print_name0, rpdata->print_name, print_name_nchars);
 604         print_name0[print_name_nchars] = L'\0';
 605
 606         params->progress.scan.cur_path = printable_path(path);
 607         params->progress.scan.symlink_target = print_name0;
 608         return do_capture_progress(params, msg, NULL);
 609 }
 610
 611 static int
 612 winnt_try_rpfix(u8 *rpbuf, u16 *rpbuflen_p,
 613                 u64 capture_root_ino, u64 capture_root_dev,
 614                 const wchar_t *path, struct add_image_params *params)
 615 {
 616         struct reparse_data rpdata;
 617         const wchar_t *rel_target;
 618         int ret;
 619
 620         if (parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata)) {
 621                 /* Couldn't even understand the reparse data.  Don't try the
 622                  * fixup.  */
 623                 return RP_NOT_FIXED;
 624         }
 625
 626         /*
 627          * Don't do reparse point fixups on relative symbolic links.
 628          *
 629          * On Windows, a relative symbolic link is supposed to be identifiable
 630          * by having reparse tag WIM_IO_REPARSE_TAG_SYMLINK and flags
 631          * SYMBOLIC_LINK_RELATIVE.  We will use this information, although this
 632          * may not always do what the user expects, since drive-relative
 633          * symbolic links such as "\Users\Public" have SYMBOLIC_LINK_RELATIVE
 634          * set, in addition to truely relative symbolic links such as "Users" or
 635          * "Users\Public".  However, WIMGAPI (as of Windows 8.1) has this same
 636          * behavior.
 637          *
 638          * Otherwise, as far as I can tell, the targets of symbolic links that
 639          * are NOT relative, as well as junctions (note: a mountpoint is the
 640          * sames thing as a junction), must be NT namespace paths, for example:
 641          *
 642          *     - \??\e:\Users\Public
 643          *     - \DosDevices\e:\Users\Public
 644          *     - \Device\HardDiskVolume4\Users\Public
 645          *     - \??\Volume{c47cb07c-946e-4155-b8f7-052e9cec7628}\Users\Public
 646          *     - \DosDevices\Volume{c47cb07c-946e-4155-b8f7-052e9cec7628}\Users\Public
 647          */
 648         if (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK &&
 649             (rpdata.rpflags & SYMBOLIC_LINK_RELATIVE))
 650                 return RP_NOT_FIXED;
 651
 652         rel_target = winnt_get_root_relative_target(rpdata.substitute_name,
 653                                                     rpdata.substitute_name_nbytes,
 654                                                     capture_root_ino,
 655                                                     capture_root_dev);
 656         if (!rel_target) {
 657                 /* Target points outside of the tree being captured.  Don't
 658                  * adjust it.  */
 659                 ret = winnt_rpfix_progress(params, path, &rpdata,
 660                                            WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK);
 661                 if (ret)
 662                         return ret;
 663                 return RP_NOT_FIXED;
 664         }
 665
 666         if (rel_target == rpdata.substitute_name) {
 667                 /* Weird target --- keep the reparse point and don't mess with
 668                  * it.  */
 669                 return RP_NOT_FIXED;
 670         }
 671
 672         /* We have an absolute target pointing within the directory being
 673          * captured, @rel_target is the suffix of the link target that is the
 674          * part relative to the directory being captured.
 675          *
 676          * We will cut off the prefix before this part (which is the path to the
 677          * directory being captured) and add a dummy prefix.  Since the process
 678          * will need to be reversed when applying the image, it shouldn't matter
 679          * what exactly the prefix is, as long as it looks like an absolute
 680          * path.
 681          */
 682
 683         {
 684                 size_t rel_target_nbytes =
 685                         rpdata.substitute_name_nbytes - ((const u8 *)rel_target -
 686                                                          (const u8 *)rpdata.substitute_name);
 687                 size_t rel_target_nchars = rel_target_nbytes / sizeof(wchar_t);
 688
 689                 wchar_t tmp[rel_target_nchars + 7];
 690
 691                 wmemcpy(tmp, L"\\??\\X:\\", 7);
 692                 wmemcpy(tmp + 7, rel_target, rel_target_nchars);
 693
 694                 rpdata.substitute_name = tmp;
 695                 rpdata.substitute_name_nbytes = rel_target_nbytes + (7 * sizeof(wchar_t));
 696                 rpdata.print_name = tmp + 4;
 697                 rpdata.print_name_nbytes = rel_target_nbytes + (3 * sizeof(wchar_t));
 698
 699                 if (make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p))
 700                         return RP_NOT_FIXED;
 701         }
 702         ret = winnt_rpfix_progress(params, path, &rpdata,
 703                                    WIMLIB_SCAN_DENTRY_FIXED_SYMLINK);
 704         if (ret)
 705                 return ret;
 706         return RP_FIXED;
 707 }
 708
 709 /*
 710  * Loads the reparse point data from a reparse point into memory, optionally
 711  * fixing the targets of absolute symbolic links and junction points to be
 712  * relative to the root of capture.
 713  *
 714  * @h:
 715  *      Open handle to the reparse point file.
 716  * @path:
 717  *      Path to the reparse point file.
 718  * @params:
 719  *      Capture parameters.  add_flags, capture_root_ino, capture_root_dev,
 720  *      progfunc, progctx, and progress are used.
 721  * @rpbuf:
 722  *      Buffer of length at least REPARSE_POINT_MAX_SIZE bytes into which the
 723  *      reparse point buffer will be loaded.
 724  * @rpbuflen_ret:
 725  *      On success, the length of the reparse point buffer in bytes is written
 726  *      to this location.
 727  *
 728  * On success, returns a negative `enum rp_status' value.
 729  * On failure, returns a positive error code.
 730  */
 731 static int
 732 winnt_get_reparse_data(HANDLE h, const wchar_t *path,
 733                        struct add_image_params *params,
 734                        u8 *rpbuf, u16 *rpbuflen_ret)
 735 {
 736         DWORD bytes_returned;
 737         u32 reparse_tag;
 738         int ret;
 739         u16 rpbuflen;
 740
 741         if (!DeviceIoControl(h, FSCTL_GET_REPARSE_POINT,
 742                              NULL, 0, rpbuf, REPARSE_POINT_MAX_SIZE,
 743                              &bytes_returned, NULL))
 744         {
 745                 set_errno_from_GetLastError();
 746                 return WIMLIB_ERR_READ;
 747         }
 748
 749         if (unlikely(bytes_returned < 8)) {
 750                 errno = EINVAL;
 751                 return WIMLIB_ERR_INVALID_REPARSE_DATA;
 752         }
 753
 754         rpbuflen = bytes_returned;
 755         reparse_tag = le32_to_cpu(*(le32*)rpbuf);
 756         ret = RP_NOT_FIXED;
 757         if (params->add_flags & WIMLIB_ADD_FLAG_RPFIX &&
 758             (reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
 759              reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
 760         {
 761                 ret = winnt_try_rpfix(rpbuf, &rpbuflen,
 762                                       params->capture_root_ino,
 763                                       params->capture_root_dev,
 764                                       path, params);
 765         }
 766         *rpbuflen_ret = rpbuflen;
 767         return ret;
 768 }
 769
 770 static DWORD WINAPI
 771 win32_tally_encrypted_size_cb(unsigned char *_data, void *_size_ret,
 772                               unsigned long len)
 773 {
 774         *(u64*)_size_ret += len;
 775         return ERROR_SUCCESS;
 776 }
 777
 778 static int
 779 win32_get_encrypted_file_size(const wchar_t *path, u64 *size_ret)
 780 {
 781         DWORD err;
 782         void *file_ctx;
 783         int ret;
 784
 785         err = OpenEncryptedFileRaw(path, 0, &file_ctx);
 786         if (err != ERROR_SUCCESS) {
 787                 set_errno_from_win32_error(err);
 788                 ERROR_WITH_ERRNO("Failed to open encrypted file \"%ls\" "
 789                                  "for raw read", printable_path(path));
 790                 return WIMLIB_ERR_OPEN;
 791         }
 792         *size_ret = 0;
 793         err = ReadEncryptedFileRaw(win32_tally_encrypted_size_cb,
 794                                    size_ret, file_ctx);
 795         if (err != ERROR_SUCCESS) {
 796                 set_errno_from_win32_error(err);
 797                 ERROR_WITH_ERRNO("Failed to read raw encrypted data from "
 798                                  "\"%ls\"", printable_path(path));
 799                 ret = WIMLIB_ERR_READ;
 800         } else {
 801                 ret = 0;
 802         }
 803         CloseEncryptedFileRaw(file_ctx);
 804         return ret;
 805 }
 806
 807 static bool
 808 get_data_stream_name(const wchar_t *raw_stream_name, size_t raw_stream_name_nchars,
 809                      const wchar_t **stream_name_ret, size_t *stream_name_nchars_ret)
 810 {
 811         const wchar_t *sep, *type, *end;
 812
 813         /* The stream name should be returned as :NAME:TYPE  */
 814         if (raw_stream_name_nchars < 1)
 815                 return false;
 816         if (raw_stream_name[0] != L':')
 817                 return false;
 818
 819         raw_stream_name++;
 820         raw_stream_name_nchars--;
 821
 822         end = raw_stream_name + raw_stream_name_nchars;
 823
 824         sep = wmemchr(raw_stream_name, L':', raw_stream_name_nchars);
 825         if (!sep)
 826                 return false;
 827
 828         type = sep + 1;
 829         if (end - type != 5)
 830                 return false;
 831
 832         if (wmemcmp(type, L"$DATA", 5))
 833                 return false;
 834
 835         *stream_name_ret = raw_stream_name;
 836         *stream_name_nchars_ret = sep - raw_stream_name;
 837         return true;
 838 }
 839
 840 static wchar_t *
 841 build_stream_path(const wchar_t *path, size_t path_nchars,
 842                   const wchar_t *stream_name, size_t stream_name_nchars)
 843 {
 844         size_t stream_path_nchars;
 845         wchar_t *stream_path;
 846         wchar_t *p;
 847
 848         stream_path_nchars = path_nchars;
 849         if (stream_name_nchars)
 850                 stream_path_nchars += 1 + stream_name_nchars;
 851
 852         stream_path = MALLOC((stream_path_nchars + 1) * sizeof(wchar_t));
 853         if (stream_path) {
 854                 p = wmempcpy(stream_path, path, path_nchars);
 855                 if (stream_name_nchars) {
 856                         *p++ = L':';
 857                         p = wmempcpy(p, stream_name, stream_name_nchars);
 858                 }
 859                 *p++ = L'\0';
 860         }
 861         return stream_path;
 862 }
 863
 864 static int
 865 winnt_scan_stream(const wchar_t *path, size_t path_nchars,
 866                   const wchar_t *raw_stream_name, size_t raw_stream_name_nchars,
 867                   u64 stream_size,
 868                   struct wim_inode *inode, struct list_head *unhashed_streams)
 869 {
 870         const wchar_t *stream_name;
 871         size_t stream_name_nchars;
 872         struct wim_ads_entry *ads_entry;
 873         wchar_t *stream_path;
 874         struct wim_lookup_table_entry *lte;
 875         u32 stream_id;
 876
 877         /* Given the raw stream name (which is something like
 878          * :streamname:$DATA), extract just the stream name part.
 879          * Ignore any non-$DATA streams.  */
 880         if (!get_data_stream_name(raw_stream_name, raw_stream_name_nchars,
 881                                   &stream_name, &stream_name_nchars))
 882                 return 0;
 883
 884         /* If this is a named stream, allocate an ADS entry for it.  */
 885         if (stream_name_nchars) {
 886                 ads_entry = inode_add_ads_utf16le(inode, stream_name,
 887                                                   stream_name_nchars *
 888                                                         sizeof(wchar_t));
 889                 if (!ads_entry)
 890                         return WIMLIB_ERR_NOMEM;
 891         } else if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
 892                 /* Ignore unnamed data stream of reparse point  */
 893                 return 0;
 894         } else {
 895                 ads_entry = NULL;
 896         }
 897
 898         /* If the stream is empty, no lookup table entry is needed. */
 899         if (stream_size == 0)
 900                 return 0;
 901
 902         /* Build the path to the stream.  For unnamed streams, this is simply
 903          * the path to the file.  For named streams, this is the path to the
 904          * file, followed by a colon, followed by the stream name.  */
 905         stream_path = build_stream_path(path, path_nchars,
 906                                         stream_name, stream_name_nchars);
 907         if (!stream_path)
 908                 return WIMLIB_ERR_NOMEM;
 909
 910         /* Set up the lookup table entry for the stream.  */
 911         lte = new_lookup_table_entry();
 912         if (!lte) {
 913                 FREE(stream_path);
 914                 return WIMLIB_ERR_NOMEM;
 915         }
 916         lte->file_on_disk = stream_path;
 917         lte->resource_location = RESOURCE_IN_WINNT_FILE_ON_DISK;
 918         lte->size = stream_size;
 919         if ((inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) && !ads_entry) {
 920                 /* Special case for encrypted file.  */
 921
 922                 /* OpenEncryptedFileRaw() expects Win32 name, not NT name.
 923                  * Change \??\ into \\?\  */
 924                 lte->file_on_disk[1] = L'\\';
 925                 wimlib_assert(!wmemcmp(lte->file_on_disk, L"\\\\?\\", 4));
 926
 927                 u64 encrypted_size;
 928                 int ret;
 929
 930                 ret = win32_get_encrypted_file_size(lte->file_on_disk,
 931                                                     &encrypted_size);
 932                 if (ret) {
 933                         free_lookup_table_entry(lte);
 934                         return ret;
 935                 }
 936                 lte->size = encrypted_size;
 937                 lte->resource_location = RESOURCE_WIN32_ENCRYPTED;
 938         }
 939
 940         if (ads_entry) {
 941                 stream_id = ads_entry->stream_id;
 942                 ads_entry->lte = lte;
 943         } else {
 944                 stream_id = 0;
 945                 inode->i_lte = lte;
 946         }
 947         add_unhashed_stream(lte, inode, stream_id, unhashed_streams);
 948         return 0;
 949 }
 950
 951 /*
 952  * Load information about the streams of an open file into a WIM inode.
 953  *
 954  * We use the NtQueryInformationFile() system call instead of FindFirstStream()
 955  * and FindNextStream().  This is done for two reasons:
 956  *
 957  * - FindFirstStream() opens its own handle to the file or directory and
 958  *   apparently does so without specifying FILE_FLAG_BACKUP_SEMANTICS, thereby
 959  *   causing access denied errors on certain files (even when running as the
 960  *   Administrator).
 961  * - FindFirstStream() and FindNextStream() is only available on Windows Vista
 962  *   and later, whereas the stream support in NtQueryInformationFile() was
 963  *   already present in Windows XP.
 964  */
 965 static int
 966 winnt_scan_streams(HANDLE *hFile_p, const wchar_t *path, size_t path_nchars,
 967                    struct wim_inode *inode, struct list_head *unhashed_streams,
 968                    u64 file_size, u32 vol_flags)
 969 {
 970         int ret;
 971         u8 _buf[1024] _aligned_attribute(8);
 972         u8 *buf;
 973         size_t bufsize;
 974         IO_STATUS_BLOCK iosb;
 975         NTSTATUS status;
 976         const FILE_STREAM_INFORMATION *info;
 977
 978         buf = _buf;
 979         bufsize = sizeof(_buf);
 980
 981         if (!(vol_flags & FILE_NAMED_STREAMS))
 982                 goto unnamed_only;
 983
 984         /* Get a buffer containing the stream information.  */
 985         while (!NT_SUCCESS(status = (*func_NtQueryInformationFile)(*hFile_p,
 986                                                                    &iosb,
 987                                                                    buf,
 988                                                                    bufsize,
 989                                                                    FileStreamInformation)))
 990         {
 991
 992                 switch (status) {
 993                 case STATUS_BUFFER_OVERFLOW:
 994                         {
 995                                 u8 *newbuf;
 996
 997                                 bufsize *= 2;
 998                                 if (buf == _buf)
 999                                         newbuf = MALLOC(bufsize);
1000                                 else
1001                                         newbuf = REALLOC(buf, bufsize);
1002                                 if (!newbuf) {
1003                                         ret = WIMLIB_ERR_NOMEM;
1004                                         goto out_free_buf;
1005                                 }
1006                                 buf = newbuf;
1007                         }
1008                         break;
1009                 case STATUS_NOT_IMPLEMENTED:
1010                 case STATUS_NOT_SUPPORTED:
1011                 case STATUS_INVALID_INFO_CLASS:
1012                         goto unnamed_only;
1013                 default:
1014                         set_errno_from_nt_status(status);
1015                         ERROR_WITH_ERRNO("\"%ls\": Failed to query stream "
1016                                          "information (status=0x%08"PRIx32")",
1017                                          printable_path(path), (u32)status);
1018                         ret = WIMLIB_ERR_READ;
1019                         goto out_free_buf;
1020                 }
1021         }
1022
1023         if (iosb.Information == 0) {
1024                 /* No stream information.  */
1025                 ret = 0;
1026                 goto out_free_buf;
1027         }
1028
1029         if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)) {
1030                 /* OpenEncryptedFileRaw() seems to fail with
1031                  * ERROR_SHARING_VIOLATION if there are any handles opened to
1032                  * the file.  */
1033                 (*func_NtClose)(*hFile_p);
1034                 *hFile_p = INVALID_HANDLE_VALUE;
1035         }
1036
1037         /* Parse one or more stream information structures.  */
1038         info = (const FILE_STREAM_INFORMATION *)buf;
1039         for (;;) {
1040                 /* Load the stream information.  */
1041                 ret = winnt_scan_stream(path, path_nchars,
1042                                         info->StreamName,
1043                                         info->StreamNameLength / 2,
1044                                         info->StreamSize.QuadPart,
1045                                         inode, unhashed_streams);
1046                 if (ret)
1047                         goto out_free_buf;
1048
1049                 if (info->NextEntryOffset == 0) {
1050                         /* No more stream information.  */
1051                         break;
1052                 }
1053                 /* Advance to next stream information.  */
1054                 info = (const FILE_STREAM_INFORMATION *)
1055                                 ((const u8 *)info + info->NextEntryOffset);
1056         }
1057         ret = 0;
1058         goto out_free_buf;
1059
1060 unnamed_only:
1061         /* The volume does not support named streams.  Only capture the unnamed
1062          * data stream.  */
1063         if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
1064                                    FILE_ATTRIBUTE_REPARSE_POINT))
1065         {
1066                 ret = 0;
1067                 goto out_free_buf;
1068         }
1069
1070         ret = winnt_scan_stream(path, path_nchars, L"::$DATA", 7,
1071                                 file_size, inode, unhashed_streams);
1072 out_free_buf:
1073         /* Free buffer if allocated on heap.  */
1074         if (unlikely(buf != _buf))
1075                 FREE(buf);
1076         return ret;
1077 }
1078
1079 static int
1080 winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret,
1081                                   HANDLE cur_dir,
1082                                   wchar_t *full_path,
1083                                   size_t full_path_nchars,
1084                                   const wchar_t *filename,
1085                                   size_t filename_nchars,
1086                                   struct add_image_params *params,
1087                                   struct winnt_scan_stats *stats,
1088                                   u32 vol_flags)
1089 {
1090         struct wim_dentry *root = NULL;
1091         struct wim_inode *inode = NULL;
1092         HANDLE h = INVALID_HANDLE_VALUE;
1093         int ret;
1094         NTSTATUS status;
1095         FILE_ALL_INFORMATION file_info;
1096         u8 *rpbuf;
1097         u16 rpbuflen;
1098         u16 not_rpfixed;
1099
1100         ret = try_exclude(full_path, full_path_nchars, params);
1101         if (ret < 0) /* Excluded? */
1102                 goto out_progress;
1103         if (ret > 0) /* Error? */
1104                 goto out;
1105
1106         /* Open the file.  */
1107         status = winnt_openat(cur_dir,
1108                               (cur_dir ? filename : full_path),
1109                               (cur_dir ? filename_nchars : full_path_nchars),
1110                               FILE_READ_DATA |
1111                                         FILE_READ_ATTRIBUTES |
1112                                         READ_CONTROL |
1113                                         ACCESS_SYSTEM_SECURITY |
1114                                         SYNCHRONIZE,
1115                               &h);
1116         if (unlikely(!NT_SUCCESS(status))) {
1117                 if (status == STATUS_DELETE_PENDING) {
1118                         WARNING("\"%ls\": Deletion pending; skipping file",
1119                                 printable_path(full_path));
1120                         ret = 0;
1121                 } else {
1122                         set_errno_from_nt_status(status);
1123                         ERROR_WITH_ERRNO("\"%ls\": Can't open file "
1124                                          "(status=0x%08"PRIx32")",
1125                                          printable_path(full_path), (u32)status);
1126                         ret = WIMLIB_ERR_OPEN;
1127                 }
1128                 /* XXX: Provide option to exclude files that fail with
1129                  * STATUS_SHARING_VIOLATION?  */
1130                 goto out;
1131         }
1132
1133         /* Get information about the file.  */
1134         {
1135                 IO_STATUS_BLOCK iosb;
1136
1137                 status = (*func_NtQueryInformationFile)(h, &iosb,
1138                                                         &file_info,
1139                                                         sizeof(file_info),
1140                                                         FileAllInformation);
1141
1142                 if (unlikely(!NT_SUCCESS(status) &&
1143                              status != STATUS_BUFFER_OVERFLOW))
1144                 {
1145                         set_errno_from_nt_status(status);
1146                         ERROR_WITH_ERRNO("\"%ls\": Can't get file information "
1147                                          "(status=0x%08"PRIx32")",
1148                                          printable_path(full_path), (u32)status);
1149                         ret = WIMLIB_ERR_STAT;
1150                         goto out;
1151                 }
1152         }
1153
1154         if (unlikely(!cur_dir)) {
1155
1156                 /* Root of tree being captured; get volume information.  */
1157
1158                 FILE_FS_ATTRIBUTE_INFORMATION attr_info;
1159                 FILE_FS_VOLUME_INFORMATION vol_info;
1160                 IO_STATUS_BLOCK iosb;
1161
1162                 /* Get volume flags  */
1163                 status = (*func_NtQueryVolumeInformationFile)(h, &iosb,
1164                                                               &attr_info,
1165                                                               sizeof(attr_info),
1166                                                               FileFsAttributeInformation);
1167                 if (likely((NT_SUCCESS(status) ||
1168                             (status == STATUS_BUFFER_OVERFLOW)) &&
1169                            (iosb.Information >=
1170                                 offsetof(FILE_FS_ATTRIBUTE_INFORMATION,
1171                                          FileSystemAttributes) +
1172                                 sizeof(attr_info.FileSystemAttributes))))
1173                 {
1174                         vol_flags = attr_info.FileSystemAttributes;
1175                 } else {
1176                         set_errno_from_nt_status(status);
1177                         WARNING_WITH_ERRNO("\"%ls\": Can't get volume attributes "
1178                                            "(status=0x%08"PRIx32")",
1179                                            printable_path(full_path),
1180                                            (u32)status);
1181                         vol_flags = 0;
1182                 }
1183
1184                 /* Set inode number of root directory  */
1185                 params->capture_root_ino =
1186                         file_info.InternalInformation.IndexNumber.QuadPart;
1187
1188                 /* Get volume ID.  */
1189                 status = (*func_NtQueryVolumeInformationFile)(h, &iosb,
1190                                                               &vol_info,
1191                                                               sizeof(vol_info),
1192                                                               FileFsVolumeInformation);
1193                 if (likely((NT_SUCCESS(status) ||
1194                             (status == STATUS_BUFFER_OVERFLOW)) &&
1195                            (iosb.Information >=
1196                                 offsetof(FILE_FS_VOLUME_INFORMATION,
1197                                          VolumeSerialNumber) +
1198                                 sizeof(vol_info.VolumeSerialNumber))))
1199                 {
1200                         params->capture_root_dev = vol_info.VolumeSerialNumber;
1201                 } else {
1202                         set_errno_from_nt_status(status);
1203                         WARNING_WITH_ERRNO("\"%ls\": Can't get volume ID "
1204                                            "(status=0x%08"PRIx32")",
1205                                            printable_path(full_path),
1206                                            (u32)status);
1207                         params->capture_root_dev = 0;
1208                 }
1209         }
1210
1211         /* If this is a reparse point, read the reparse data.  */
1212         if (unlikely(file_info.BasicInformation.FileAttributes &
1213                      FILE_ATTRIBUTE_REPARSE_POINT))
1214         {
1215                 rpbuf = alloca(REPARSE_POINT_MAX_SIZE);
1216                 ret = winnt_get_reparse_data(h, full_path, params,
1217                                              rpbuf, &rpbuflen);
1218                 switch (ret) {
1219                 case RP_FIXED:
1220                         not_rpfixed = 0;
1221                         break;
1222                 case RP_NOT_FIXED:
1223                         not_rpfixed = 1;
1224                         break;
1225                 default:
1226                         ERROR_WITH_ERRNO("\"%ls\": Can't get reparse data",
1227                                          printable_path(full_path));
1228                         goto out;
1229                 }
1230         }
1231
1232         /* Create a WIM dentry with an associated inode, which may be shared.
1233          *
1234          * However, we need to explicitly check for directories and files with
1235          * only 1 link and refuse to hard link them.  This is because Windows
1236          * has a bug where it can return duplicate File IDs for files and
1237          * directories on the FAT filesystem. */
1238         ret = inode_table_new_dentry(params->inode_table,
1239                                      filename,
1240                                      file_info.InternalInformation.IndexNumber.QuadPart,
1241                                      0, /* We don't follow mount points, so we
1242                                            currently don't need to get the
1243                                            volume ID / device number.  */
1244                                      (file_info.StandardInformation.NumberOfLinks <= 1 ||
1245                                         (file_info.BasicInformation.FileAttributes &
1246                                          FILE_ATTRIBUTE_DIRECTORY)),
1247                                      &root);
1248         if (ret)
1249                 goto out;
1250
1251         /* Get the short (DOS) name of the file.  */
1252         status = winnt_get_short_name(h, root);
1253
1254         /* If we can't read the short filename for any reason other than
1255          * out-of-memory, just ignore the error and assume the file has no short
1256          * name.  This shouldn't be an issue, since the short names are
1257          * essentially obsolete anyway.  */
1258         if (unlikely(status == STATUS_NO_MEMORY)) {
1259                 ret = WIMLIB_ERR_NOMEM;
1260                 goto out;
1261         }
1262
1263         inode = root->d_inode;
1264
1265         if (inode->i_nlink > 1) {
1266                 /* Shared inode (hard link); skip reading per-inode information.
1267                  */
1268                 goto out_progress;
1269         }
1270
1271         inode->i_attributes = file_info.BasicInformation.FileAttributes;
1272         inode->i_creation_time = file_info.BasicInformation.CreationTime.QuadPart;
1273         inode->i_last_write_time = file_info.BasicInformation.LastWriteTime.QuadPart;
1274         inode->i_last_access_time = file_info.BasicInformation.LastAccessTime.QuadPart;
1275         inode->i_resolved = 1;
1276
1277         /* Get the file's security descriptor, unless we are capturing in
1278          * NO_ACLS mode or the volume does not support security descriptors.  */
1279         if (!(params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS)
1280             && (vol_flags & FILE_PERSISTENT_ACLS))
1281         {
1282                 status = winnt_get_security_descriptor(h, inode,
1283                                                        params->sd_set, stats,
1284                                                        params->add_flags);
1285                 if (!NT_SUCCESS(status)) {
1286                         set_errno_from_nt_status(status);
1287                         ERROR_WITH_ERRNO("\"%ls\": Can't read security "
1288                                          "descriptor (status=0x%08"PRIu32")",
1289                                          printable_path(full_path),
1290                                          (u32)status);
1291                         ret = WIMLIB_ERR_STAT;
1292                         goto out;
1293                 }
1294         }
1295
1296         /* Load information about the unnamed data stream and any named data
1297          * streams.  */
1298         ret = winnt_scan_streams(&h,
1299                                  full_path,
1300                                  full_path_nchars,
1301                                  inode,
1302                                  params->unhashed_streams,
1303                                  file_info.StandardInformation.EndOfFile.QuadPart,
1304                                  vol_flags);
1305         if (ret)
1306                 goto out;
1307
1308         if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)) {
1309
1310                 /* Reparse point: set the reparse data (already read).  */
1311
1312                 inode->i_not_rpfixed = not_rpfixed;
1313                 inode->i_reparse_tag = le32_to_cpu(*(le32*)rpbuf);
1314                 ret = inode_set_unnamed_stream(inode, rpbuf + 8, rpbuflen - 8,
1315                                                params->lookup_table);
1316                 if (ret)
1317                         goto out;
1318         } else if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
1319
1320                 /* Directory: recurse to children.  */
1321
1322                 if (unlikely(h == INVALID_HANDLE_VALUE)) {
1323                         /* Re-open handle that was closed to read raw encrypted
1324                          * data.  */
1325                         status = winnt_openat(cur_dir,
1326                                               (cur_dir ?
1327                                                filename : full_path),
1328                                               (cur_dir ?
1329                                                filename_nchars : full_path_nchars),
1330                                               FILE_LIST_DIRECTORY | SYNCHRONIZE,
1331                                               &h);
1332                         if (!NT_SUCCESS(status)) {
1333                                 set_errno_from_nt_status(status);
1334                                 ERROR_WITH_ERRNO("\"%ls\": Can't re-open file "
1335                                                  "(status=0x%08"PRIx32")",
1336                                                  printable_path(full_path),
1337                                                  (u32)status);
1338                                 ret = WIMLIB_ERR_OPEN;
1339                                 goto out;
1340                         }
1341                 }
1342                 ret = winnt_recurse_directory(h,
1343                                               full_path,
1344                                               full_path_nchars,
1345                                               root,
1346                                               params,
1347                                               stats,
1348                                               vol_flags);
1349                 if (ret)
1350                         goto out;
1351         }
1352
1353 out_progress:
1354         params->progress.scan.cur_path = printable_path(full_path);
1355         if (likely(root))
1356                 ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK, inode);
1357         else
1358                 ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL);
1359 out:
1360         if (likely(h != INVALID_HANDLE_VALUE))
1361                 (*func_NtClose)(h);
1362         if (likely(ret == 0))
1363                 *root_ret = root;
1364         else
1365                 free_dentry_tree(root, params->lookup_table);
1366         return ret;
1367 }
1368
1369 static void
1370 winnt_do_scan_warnings(const wchar_t *path, const struct winnt_scan_stats *stats)
1371 {
1372         if (likely(stats->num_get_sacl_priv_notheld == 0 &&
1373                    stats->num_get_sd_access_denied == 0))
1374                 return;
1375
1376         WARNING("Scan of \"%ls\" complete, but with one or more warnings:", path);
1377         if (stats->num_get_sacl_priv_notheld != 0) {
1378                 WARNING("- Could not capture SACL (System Access Control List)\n"
1379                         "            on %lu files or directories.",
1380                         stats->num_get_sacl_priv_notheld);
1381         }
1382         if (stats->num_get_sd_access_denied != 0) {
1383                 WARNING("- Could not capture security descriptor at all\n"
1384                         "            on %lu files or directories.",
1385                         stats->num_get_sd_access_denied);
1386         }
1387         WARNING("To fully capture all security descriptors, run the program\n"
1388                 "          with Administrator rights.");
1389 }
1390
1391 #define WINDOWS_NT_MAX_PATH 32768
1392
1393 /* Win32 version of capturing a directory tree.  */
1394 int
1395 win32_build_dentry_tree(struct wim_dentry **root_ret,
1396                         const wchar_t *root_disk_path,
1397                         struct add_image_params *params)
1398 {
1399         wchar_t *path;
1400         int ret;
1401         UNICODE_STRING ntpath;
1402         struct winnt_scan_stats stats;
1403         size_t ntpath_nchars;
1404
1405         /* WARNING: There is no check for overflow later when this buffer is
1406          * being used!  But it's as long as the maximum path length understood
1407          * by Windows NT (which is NOT the same as MAX_PATH).  */
1408         path = MALLOC((WINDOWS_NT_MAX_PATH + 1) * sizeof(wchar_t));
1409         if (!path)
1410                 return WIMLIB_ERR_NOMEM;
1411
1412         ret = win32_path_to_nt_path(root_disk_path, &ntpath);
1413         if (ret)
1414                 goto out_free_path;
1415
1416         if (ntpath.Length < 4 * sizeof(wchar_t) ||
1417             ntpath.Length > WINDOWS_NT_MAX_PATH * sizeof(wchar_t) ||
1418             wmemcmp(ntpath.Buffer, L"\\??\\", 4))
1419         {
1420                 ERROR("\"%ls\": unrecognized path format", root_disk_path);
1421                 ret = WIMLIB_ERR_INVALID_PARAM;
1422         } else {
1423                 ntpath_nchars = ntpath.Length / sizeof(wchar_t);
1424                 wmemcpy(path, ntpath.Buffer, ntpath_nchars);
1425                 path[ntpath_nchars] = L'\0';
1426
1427                 params->capture_root_nchars = ntpath_nchars;
1428                 if (path[ntpath_nchars - 1] == L'\\')
1429                         params->capture_root_nchars--;
1430                 ret = 0;
1431         }
1432         HeapFree(GetProcessHeap(), 0, ntpath.Buffer);
1433         if (ret)
1434                 goto out_free_path;
1435
1436         memset(&stats, 0, sizeof(stats));
1437
1438         ret = winnt_build_dentry_tree_recursive(root_ret, NULL,
1439                                                 path, ntpath_nchars,
1440                                                 L"", 0, params, &stats, 0);
1441 out_free_path:
1442         FREE(path);
1443         if (ret == 0)
1444                 winnt_do_scan_warnings(root_disk_path, &stats);
1445         return ret;
1446 }
1447
1448 #endif /* __WIN32__ */