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