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 {
 892                 ads_entry = NULL;
 893         }
 894
 895         /* If the stream is empty, no lookup table entry is needed. */
 896         if (stream_size == 0)
 897                 return 0;
 898
 899         /* Build the path to the stream.  For unnamed streams, this is simply
 900          * the path to the file.  For named streams, this is the path to the
 901          * file, followed by a colon, followed by the stream name.  */
 902         stream_path = build_stream_path(path, path_nchars,
 903                                         stream_name, stream_name_nchars);
 904         if (!stream_path)
 905                 return WIMLIB_ERR_NOMEM;
 906
 907         /* Set up the lookup table entry for the stream.  */
 908         lte = new_lookup_table_entry();
 909         if (!lte) {
 910                 FREE(stream_path);
 911                 return WIMLIB_ERR_NOMEM;
 912         }
 913         lte->file_on_disk = stream_path;
 914         lte->resource_location = RESOURCE_IN_WINNT_FILE_ON_DISK;
 915         lte->size = stream_size;
 916         if ((inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) && !ads_entry) {
 917                 /* Special case for encrypted file.  */
 918
 919                 /* OpenEncryptedFileRaw() expects Win32 name, not NT name.
 920                  * Change \??\ into \\?\  */
 921                 lte->file_on_disk[1] = L'\\';
 922                 wimlib_assert(!wmemcmp(lte->file_on_disk, L"\\\\?\\", 4));
 923
 924                 u64 encrypted_size;
 925                 int ret;
 926
 927                 ret = win32_get_encrypted_file_size(lte->file_on_disk,
 928                                                     &encrypted_size);
 929                 if (ret) {
 930                         free_lookup_table_entry(lte);
 931                         return ret;
 932                 }
 933                 lte->size = encrypted_size;
 934                 lte->resource_location = RESOURCE_WIN32_ENCRYPTED;
 935         }
 936
 937         if (ads_entry) {
 938                 stream_id = ads_entry->stream_id;
 939                 ads_entry->lte = lte;
 940         } else {
 941                 stream_id = 0;
 942                 inode->i_lte = lte;
 943         }
 944         add_unhashed_stream(lte, inode, stream_id, unhashed_streams);
 945         return 0;
 946 }
 947
 948 /*
 949  * Load information about the streams of an open file into a WIM inode.
 950  *
 951  * We use the NtQueryInformationFile() system call instead of FindFirstStream()
 952  * and FindNextStream().  This is done for two reasons:
 953  *
 954  * - FindFirstStream() opens its own handle to the file or directory and
 955  *   apparently does so without specifying FILE_FLAG_BACKUP_SEMANTICS, thereby
 956  *   causing access denied errors on certain files (even when running as the
 957  *   Administrator).
 958  * - FindFirstStream() and FindNextStream() is only available on Windows Vista
 959  *   and later, whereas the stream support in NtQueryInformationFile() was
 960  *   already present in Windows XP.
 961  */
 962 static int
 963 winnt_scan_streams(HANDLE *hFile_p, const wchar_t *path, size_t path_nchars,
 964                    struct wim_inode *inode, struct list_head *unhashed_streams,
 965                    u64 file_size, u32 vol_flags)
 966 {
 967         int ret;
 968         u8 _buf[1024] _aligned_attribute(8);
 969         u8 *buf;
 970         size_t bufsize;
 971         IO_STATUS_BLOCK iosb;
 972         NTSTATUS status;
 973         const FILE_STREAM_INFORMATION *info;
 974
 975         buf = _buf;
 976         bufsize = sizeof(_buf);
 977
 978         if (!(vol_flags & FILE_NAMED_STREAMS))
 979                 goto unnamed_only;
 980
 981         /* Get a buffer containing the stream information.  */
 982         while (!NT_SUCCESS(status = (*func_NtQueryInformationFile)(*hFile_p,
 983                                                                    &iosb,
 984                                                                    buf,
 985                                                                    bufsize,
 986                                                                    FileStreamInformation)))
 987         {
 988
 989                 switch (status) {
 990                 case STATUS_BUFFER_OVERFLOW:
 991                         {
 992                                 u8 *newbuf;
 993
 994                                 bufsize *= 2;
 995                                 if (buf == _buf)
 996                                         newbuf = MALLOC(bufsize);
 997                                 else
 998                                         newbuf = REALLOC(buf, bufsize);
 999                                 if (!newbuf) {
1000                                         ret = WIMLIB_ERR_NOMEM;
1001                                         goto out_free_buf;
1002                                 }
1003                                 buf = newbuf;
1004                         }
1005                         break;
1006                 case STATUS_NOT_IMPLEMENTED:
1007                 case STATUS_NOT_SUPPORTED:
1008                 case STATUS_INVALID_INFO_CLASS:
1009                         goto unnamed_only;
1010                 default:
1011                         set_errno_from_nt_status(status);
1012                         ERROR_WITH_ERRNO("\"%ls\": Failed to query stream "
1013                                          "information (status=0x%08"PRIx32")",
1014                                          printable_path(path), (u32)status);
1015                         ret = WIMLIB_ERR_READ;
1016                         goto out_free_buf;
1017                 }
1018         }
1019
1020         if (iosb.Information == 0) {
1021                 /* No stream information.  */
1022                 ret = 0;
1023                 goto out_free_buf;
1024         }
1025
1026         if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)) {
1027                 /* OpenEncryptedFileRaw() seems to fail with
1028                  * ERROR_SHARING_VIOLATION if there are any handles opened to
1029                  * the file.  */
1030                 (*func_NtClose)(*hFile_p);
1031                 *hFile_p = INVALID_HANDLE_VALUE;
1032         }
1033
1034         /* Parse one or more stream information structures.  */
1035         info = (const FILE_STREAM_INFORMATION *)buf;
1036         for (;;) {
1037                 /* Load the stream information.  */
1038                 ret = winnt_scan_stream(path, path_nchars,
1039                                         info->StreamName,
1040                                         info->StreamNameLength / 2,
1041                                         info->StreamSize.QuadPart,
1042                                         inode, unhashed_streams);
1043                 if (ret)
1044                         goto out_free_buf;
1045
1046                 if (info->NextEntryOffset == 0) {
1047                         /* No more stream information.  */
1048                         break;
1049                 }
1050                 /* Advance to next stream information.  */
1051                 info = (const FILE_STREAM_INFORMATION *)
1052                                 ((const u8 *)info + info->NextEntryOffset);
1053         }
1054         ret = 0;
1055         goto out_free_buf;
1056
1057 unnamed_only:
1058         /* The volume does not support named streams.  Only capture the unnamed
1059          * data stream.  */
1060         if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
1061                                    FILE_ATTRIBUTE_REPARSE_POINT))
1062         {
1063                 ret = 0;
1064                 goto out_free_buf;
1065         }
1066
1067         ret = winnt_scan_stream(path, path_nchars, L"::$DATA", 7,
1068                                 file_size, inode, unhashed_streams);
1069 out_free_buf:
1070         /* Free buffer if allocated on heap.  */
1071         if (unlikely(buf != _buf))
1072                 FREE(buf);
1073         return ret;
1074 }
1075
1076 static int
1077 winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret,
1078                                   HANDLE cur_dir,
1079                                   wchar_t *full_path,
1080                                   size_t full_path_nchars,
1081                                   const wchar_t *filename,
1082                                   size_t filename_nchars,
1083                                   struct add_image_params *params,
1084                                   struct winnt_scan_stats *stats,
1085                                   u32 vol_flags)
1086 {
1087         struct wim_dentry *root = NULL;
1088         struct wim_inode *inode = NULL;
1089         HANDLE h = INVALID_HANDLE_VALUE;
1090         int ret;
1091         NTSTATUS status;
1092         FILE_ALL_INFORMATION file_info;
1093         u8 *rpbuf;
1094         u16 rpbuflen;
1095         u16 not_rpfixed;
1096
1097         if (should_exclude_path(full_path + params->capture_root_nchars,
1098                                 full_path_nchars - params->capture_root_nchars,
1099                                 params->config))
1100                 goto out_progress;
1101
1102         /* Open the file.  */
1103         status = winnt_openat(cur_dir,
1104                               (cur_dir ? filename : full_path),
1105                               (cur_dir ? filename_nchars : full_path_nchars),
1106                               FILE_READ_DATA |
1107                                         FILE_READ_ATTRIBUTES |
1108                                         READ_CONTROL |
1109                                         ACCESS_SYSTEM_SECURITY |
1110                                         SYNCHRONIZE,
1111                               &h);
1112         if (unlikely(!NT_SUCCESS(status))) {
1113                 set_errno_from_nt_status(status);
1114                 ERROR_WITH_ERRNO("\"%ls\": Can't open file "
1115                                  "(status=0x%08"PRIx32")",
1116                                  printable_path(full_path), (u32)status);
1117                 ret = WIMLIB_ERR_OPEN;
1118                 goto out;
1119         }
1120
1121         /* Get information about the file.  */
1122         {
1123                 IO_STATUS_BLOCK iosb;
1124
1125                 status = (*func_NtQueryInformationFile)(h, &iosb,
1126                                                         &file_info,
1127                                                         sizeof(file_info),
1128                                                         FileAllInformation);
1129
1130                 if (unlikely(!NT_SUCCESS(status) &&
1131                              status != STATUS_BUFFER_OVERFLOW))
1132                 {
1133                         set_errno_from_nt_status(status);
1134                         ERROR_WITH_ERRNO("\"%ls\": Can't get file information "
1135                                          "(status=0x%08"PRIx32")",
1136                                          printable_path(full_path), (u32)status);
1137                         ret = WIMLIB_ERR_STAT;
1138                         goto out;
1139                 }
1140         }
1141
1142         if (unlikely(!cur_dir)) {
1143
1144                 /* Root of tree being captured; get volume information.  */
1145
1146                 FILE_FS_ATTRIBUTE_INFORMATION attr_info;
1147                 FILE_FS_VOLUME_INFORMATION vol_info;
1148                 IO_STATUS_BLOCK iosb;
1149
1150                 /* Get volume flags  */
1151                 status = (*func_NtQueryVolumeInformationFile)(h, &iosb,
1152                                                               &attr_info,
1153                                                               sizeof(attr_info),
1154                                                               FileFsAttributeInformation);
1155                 if (likely((NT_SUCCESS(status) ||
1156                             (status == STATUS_BUFFER_OVERFLOW)) &&
1157                            (iosb.Information >=
1158                                 offsetof(FILE_FS_ATTRIBUTE_INFORMATION,
1159                                          FileSystemAttributes) +
1160                                 sizeof(attr_info.FileSystemAttributes))))
1161                 {
1162                         vol_flags = attr_info.FileSystemAttributes;
1163                 } else {
1164                         set_errno_from_nt_status(status);
1165                         WARNING_WITH_ERRNO("\"%ls\": Can't get volume attributes "
1166                                            "(status=0x%08"PRIx32")",
1167                                            printable_path(full_path),
1168                                            (u32)status);
1169                         vol_flags = 0;
1170                 }
1171
1172                 /* Set inode number of root directory  */
1173                 params->capture_root_ino =
1174                         file_info.InternalInformation.IndexNumber.QuadPart;
1175
1176                 /* Get volume ID.  */
1177                 status = (*func_NtQueryVolumeInformationFile)(h, &iosb,
1178                                                               &vol_info,
1179                                                               sizeof(vol_info),
1180                                                               FileFsVolumeInformation);
1181                 if (likely((NT_SUCCESS(status) ||
1182                             (status == STATUS_BUFFER_OVERFLOW)) &&
1183                            (iosb.Information >=
1184                                 offsetof(FILE_FS_VOLUME_INFORMATION,
1185                                          VolumeSerialNumber) +
1186                                 sizeof(vol_info.VolumeSerialNumber))))
1187                 {
1188                         params->capture_root_dev = vol_info.VolumeSerialNumber;
1189                 } else {
1190                         set_errno_from_nt_status(status);
1191                         WARNING_WITH_ERRNO("\"%ls\": Can't get volume ID "
1192                                            "(status=0x%08"PRIx32")",
1193                                            printable_path(full_path),
1194                                            (u32)status);
1195                         params->capture_root_dev = 0;
1196                 }
1197         }
1198
1199         /* If this is a reparse point, read the reparse data.  */
1200         if (unlikely(file_info.BasicInformation.FileAttributes &
1201                      FILE_ATTRIBUTE_REPARSE_POINT))
1202         {
1203                 rpbuf = alloca(REPARSE_POINT_MAX_SIZE);
1204                 ret = winnt_get_reparse_data(h, full_path, params,
1205                                              rpbuf, &rpbuflen);
1206                 switch (ret) {
1207                 case RP_FIXED:
1208                         not_rpfixed = 0;
1209                         break;
1210                 case RP_NOT_FIXED:
1211                         not_rpfixed = 1;
1212                         break;
1213                 default:
1214                         ERROR_WITH_ERRNO("\"%ls\": Can't get reparse data",
1215                                          printable_path(full_path));
1216                         goto out;
1217                 }
1218         }
1219
1220         /* Create a WIM dentry with an associated inode, which may be shared.
1221          *
1222          * However, we need to explicitly check for directories and files with
1223          * only 1 link and refuse to hard link them.  This is because Windows
1224          * has a bug where it can return duplicate File IDs for files and
1225          * directories on the FAT filesystem. */
1226         ret = inode_table_new_dentry(params->inode_table,
1227                                      filename,
1228                                      file_info.InternalInformation.IndexNumber.QuadPart,
1229                                      0, /* We don't follow mount points, so we
1230                                            currently don't need to get the
1231                                            volume ID / device number.  */
1232                                      (file_info.StandardInformation.NumberOfLinks <= 1 ||
1233                                         (file_info.BasicInformation.FileAttributes &
1234                                          FILE_ATTRIBUTE_DIRECTORY)),
1235                                      &root);
1236         if (ret)
1237                 goto out;
1238
1239         /* Get the short (DOS) name of the file.  */
1240         status = winnt_get_short_name(h, root);
1241
1242         /* If we can't read the short filename for any reason other than
1243          * out-of-memory, just ignore the error and assume the file has no short
1244          * name.  This shouldn't be an issue, since the short names are
1245          * essentially obsolete anyway.  */
1246         if (unlikely(status == STATUS_NO_MEMORY)) {
1247                 ret = WIMLIB_ERR_NOMEM;
1248                 goto out;
1249         }
1250
1251         inode = root->d_inode;
1252
1253         if (inode->i_nlink > 1) {
1254                 /* Shared inode (hard link); skip reading per-inode information.
1255                  */
1256                 goto out_progress;
1257         }
1258
1259         inode->i_attributes = file_info.BasicInformation.FileAttributes;
1260         inode->i_creation_time = file_info.BasicInformation.CreationTime.QuadPart;
1261         inode->i_last_write_time = file_info.BasicInformation.LastWriteTime.QuadPart;
1262         inode->i_last_access_time = file_info.BasicInformation.LastAccessTime.QuadPart;
1263         inode->i_resolved = 1;
1264
1265         /* Get the file's security descriptor, unless we are capturing in
1266          * NO_ACLS mode or the volume does not support security descriptors.  */
1267         if (!(params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS)
1268             && (vol_flags & FILE_PERSISTENT_ACLS))
1269         {
1270                 status = winnt_get_security_descriptor(h, inode,
1271                                                        params->sd_set, stats,
1272                                                        params->add_flags);
1273                 if (!NT_SUCCESS(status)) {
1274                         set_errno_from_nt_status(status);
1275                         ERROR_WITH_ERRNO("\"%ls\": Can't read security "
1276                                          "descriptor (status=0x%08"PRIu32")",
1277                                          printable_path(full_path),
1278                                          (u32)status);
1279                         ret = WIMLIB_ERR_STAT;
1280                         goto out;
1281                 }
1282         }
1283
1284         /* Load information about the unnamed data stream and any named data
1285          * streams.  */
1286         ret = winnt_scan_streams(&h,
1287                                  full_path,
1288                                  full_path_nchars,
1289                                  inode,
1290                                  params->unhashed_streams,
1291                                  file_info.StandardInformation.EndOfFile.QuadPart,
1292                                  vol_flags);
1293         if (ret)
1294                 goto out;
1295
1296         if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)) {
1297
1298                 /* Reparse point: set the reparse data (already read).  */
1299
1300                 inode->i_not_rpfixed = not_rpfixed;
1301                 inode->i_reparse_tag = le32_to_cpu(*(le32*)rpbuf);
1302                 ret = inode_set_unnamed_stream(inode, rpbuf + 8, rpbuflen - 8,
1303                                                params->lookup_table);
1304                 if (ret)
1305                         goto out;
1306         } else if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
1307
1308                 /* Directory: recurse to children.  */
1309
1310                 if (unlikely(h == INVALID_HANDLE_VALUE)) {
1311                         /* Re-open handle that was closed to read raw encrypted
1312                          * data.  */
1313                         status = winnt_openat(cur_dir,
1314                                               (cur_dir ?
1315                                                filename : full_path),
1316                                               (cur_dir ?
1317                                                filename_nchars : full_path_nchars),
1318                                               FILE_LIST_DIRECTORY | SYNCHRONIZE,
1319                                               &h);
1320                         if (!NT_SUCCESS(status)) {
1321                                 set_errno_from_nt_status(status);
1322                                 ERROR_WITH_ERRNO("\"%ls\": Can't re-open file "
1323                                                  "(status=0x%08"PRIx32")",
1324                                                  printable_path(full_path),
1325                                                  (u32)status);
1326                                 ret = WIMLIB_ERR_OPEN;
1327                                 goto out;
1328                         }
1329                 }
1330                 ret = winnt_recurse_directory(h,
1331                                               full_path,
1332                                               full_path_nchars,
1333                                               root,
1334                                               params,
1335                                               stats,
1336                                               vol_flags);
1337                 if (ret)
1338                         goto out;
1339         }
1340
1341 out_progress:
1342         params->progress.scan.cur_path = printable_path(full_path);
1343         if (likely(root))
1344                 ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK, inode);
1345         else
1346                 ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL);
1347 out:
1348         if (likely(h != INVALID_HANDLE_VALUE))
1349                 (*func_NtClose)(h);
1350         if (likely(ret == 0))
1351                 *root_ret = root;
1352         else
1353                 free_dentry_tree(root, params->lookup_table);
1354         return ret;
1355 }
1356
1357 static void
1358 winnt_do_scan_warnings(const wchar_t *path, const struct winnt_scan_stats *stats)
1359 {
1360         if (likely(stats->num_get_sacl_priv_notheld == 0 &&
1361                    stats->num_get_sd_access_denied == 0))
1362                 return;
1363
1364         WARNING("Scan of \"%ls\" complete, but with one or more warnings:", path);
1365         if (stats->num_get_sacl_priv_notheld != 0) {
1366                 WARNING("- Could not capture SACL (System Access Control List)\n"
1367                         "            on %lu files or directories.",
1368                         stats->num_get_sacl_priv_notheld);
1369         }
1370         if (stats->num_get_sd_access_denied != 0) {
1371                 WARNING("- Could not capture security descriptor at all\n"
1372                         "            on %lu files or directories.",
1373                         stats->num_get_sd_access_denied);
1374         }
1375         WARNING("To fully capture all security descriptors, run the program\n"
1376                 "          with Administrator rights.");
1377 }
1378
1379 #define WINDOWS_NT_MAX_PATH 32768
1380
1381 /* Win32 version of capturing a directory tree.  */
1382 int
1383 win32_build_dentry_tree(struct wim_dentry **root_ret,
1384                         const wchar_t *root_disk_path,
1385                         struct add_image_params *params)
1386 {
1387         wchar_t *path;
1388         DWORD dret;
1389         size_t path_nchars;
1390         int ret;
1391         struct winnt_scan_stats stats;
1392
1393         /* WARNING: There is no check for overflow later when this buffer is
1394          * being used!  But it's as long as the maximum path length understood
1395          * by Windows NT (which is NOT the same as MAX_PATH).  */
1396         path = MALLOC((WINDOWS_NT_MAX_PATH + 1) * sizeof(wchar_t));
1397         if (!path)
1398                 return WIMLIB_ERR_NOMEM;
1399
1400         /* Translate into full path.  */
1401         dret = GetFullPathName(root_disk_path, WINDOWS_NT_MAX_PATH - 3,
1402                                &path[4], NULL);
1403
1404         if (unlikely(dret == 0 || dret >= WINDOWS_NT_MAX_PATH - 3)) {
1405                 ERROR("Can't get full path name for \"%ls\"", root_disk_path);
1406                 return WIMLIB_ERR_UNSUPPORTED;
1407         }
1408
1409         /* Add \??\ prefix to form the NT namespace path.  */
1410         wmemcpy(path, L"\\??\\", 4);
1411         path_nchars = dret + 4;
1412
1413        /* Strip trailing slashes.  If we don't do this, we may create a path
1414         * with multiple consecutive backslashes, which for some reason causes
1415         * Windows to report that the file cannot be found.  */
1416         while (unlikely(path[path_nchars - 1] == L'\\' &&
1417                         path[path_nchars - 2] != L':'))
1418                 path[--path_nchars] = L'\0';
1419
1420         params->capture_root_nchars = path_nchars;
1421
1422         memset(&stats, 0, sizeof(stats));
1423
1424         ret = winnt_build_dentry_tree_recursive(root_ret, NULL,
1425                                                 path, path_nchars, L"", 0,
1426                                                 params, &stats, 0);
1427         FREE(path);
1428         if (ret == 0)
1429                 winnt_do_scan_warnings(root_disk_path, &stats);
1430         return ret;
1431 }
1432
1433 #endif /* __WIN32__ */