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

   1 /*
   2  * win32_apply.c - Windows-specific code for applying files from a WIM image.
   3  */
   4
   5 /*
   6  * Copyright (C) 2013 Eric Biggers
   7  *
   8  * This file is part of wimlib, a library for working with WIM files.
   9  *
  10  * wimlib is free software; you can redistribute it and/or modify it under the
  11  * terms of the GNU General Public License as published by the Free
  12  * Software Foundation; either version 3 of the License, or (at your option)
  13  * any later version.
  14  *
  15  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  16  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  17  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with wimlib; 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/apply.h"
  33 #include "wimlib/error.h"
  34 #include "wimlib/lookup_table.h"
  35
  36 static int
  37 win32_start_extract(const wchar_t *path, struct apply_ctx *ctx)
  38 {
  39         int ret;
  40         unsigned vol_flags;
  41         bool supports_SetFileShortName;
  42
  43         ret = win32_get_vol_flags(path, &vol_flags, &supports_SetFileShortName);
  44         if (ret)
  45                 return ret;
  46
  47         ctx->supported_features.archive_files = 1;
  48         ctx->supported_features.hidden_files = 1;
  49         ctx->supported_features.system_files = 1;
  50
  51         if (vol_flags & FILE_FILE_COMPRESSION)
  52                 ctx->supported_features.compressed_files = 1;
  53
  54         if (vol_flags & FILE_SUPPORTS_ENCRYPTION) {
  55                 ctx->supported_features.encrypted_files = 1;
  56                 ctx->supported_features.encrypted_directories = 1;
  57         }
  58
  59         ctx->supported_features.not_context_indexed_files = 1;
  60
  61         if (vol_flags & FILE_SUPPORTS_SPARSE_FILES)
  62                 ctx->supported_features.sparse_files = 1;
  63
  64         if (vol_flags & FILE_NAMED_STREAMS)
  65                 ctx->supported_features.named_data_streams = 1;
  66
  67         if (vol_flags & FILE_SUPPORTS_HARD_LINKS)
  68                 ctx->supported_features.hard_links = 1;
  69
  70         if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS) {
  71                 ctx->supported_features.reparse_points = 1;
  72                 if (win32func_CreateSymbolicLinkW)
  73                         ctx->supported_features.symlink_reparse_points = 1;
  74         }
  75
  76         if (vol_flags & FILE_PERSISTENT_ACLS)
  77                 ctx->supported_features.security_descriptors = 1;
  78
  79         if (supports_SetFileShortName)
  80                 ctx->supported_features.short_names = 1;
  81         return 0;
  82 }
  83
  84 static int
  85 win32_create_file(const wchar_t *path, struct apply_ctx *ctx, u64 *cookie_ret)
  86 {
  87         HANDLE h;
  88
  89         h = CreateFile(path, 0, 0, NULL, CREATE_ALWAYS,
  90                        FILE_ATTRIBUTE_NORMAL | FILE_FLAG_BACKUP_SEMANTICS, NULL);
  91         if (h == INVALID_HANDLE_VALUE)
  92                 goto error;
  93         CloseHandle(h);
  94         return 0;
  95
  96 error:
  97         set_errno_from_GetLastError();
  98         return WIMLIB_ERR_OPEN;
  99 }
 100
 101 static int
 102 win32_create_directory(const wchar_t *path, struct apply_ctx *ctx,
 103                        u64 *cookie_ret)
 104 {
 105         if (!CreateDirectory(path, NULL))
 106                 if (GetLastError() != ERROR_ALREADY_EXISTS)
 107                         goto error;
 108         return 0;
 109
 110 error:
 111         set_errno_from_GetLastError();
 112         return WIMLIB_ERR_MKDIR;
 113 }
 114
 115 static int
 116 win32_create_hardlink(const wchar_t *oldpath, const wchar_t *newpath,
 117                       struct apply_ctx *ctx)
 118 {
 119         if (!CreateHardLink(newpath, oldpath, NULL)) {
 120                 if (GetLastError() != ERROR_ALREADY_EXISTS)
 121                         goto error;
 122                 if (!DeleteFile(newpath))
 123                         goto error;
 124                 if (!CreateHardLink(newpath, oldpath, NULL))
 125                         goto error;
 126         }
 127         return 0;
 128
 129 error:
 130         set_errno_from_GetLastError();
 131         return WIMLIB_ERR_LINK;
 132 }
 133
 134 static int
 135 win32_create_symlink(const wchar_t *oldpath, const wchar_t *newpath,
 136                      struct apply_ctx *ctx)
 137 {
 138         if (!(*win32func_CreateSymbolicLinkW)(newpath, oldpath, 0)) {
 139                 if (GetLastError() != ERROR_ALREADY_EXISTS)
 140                         goto error;
 141                 if (!DeleteFile(newpath))
 142                         goto error;
 143                 if (!(*win32func_CreateSymbolicLinkW)(newpath, oldpath, 0))
 144                         goto error;
 145         }
 146         return 0;
 147
 148 error:
 149         set_errno_from_GetLastError();
 150         return WIMLIB_ERR_LINK;
 151 }
 152
 153 static int
 154 win32_extract_wim_chunk(const void *buf, size_t len, void *arg)
 155 {
 156         HANDLE h = (HANDLE)arg;
 157         DWORD nbytes_written;
 158
 159         if (unlikely(!WriteFile(h, buf, len, &nbytes_written, NULL)))
 160                 goto error;
 161         if (unlikely(nbytes_written != len))
 162                 goto error;
 163         return 0;
 164
 165 error:
 166         set_errno_from_GetLastError();
 167         return WIMLIB_ERR_WRITE;
 168 }
 169
 170 static int
 171 win32_extract_stream(const wchar_t *path, const wchar_t *stream_name,
 172                      size_t stream_name_nchars,
 173                      struct wim_lookup_table_entry *lte, struct apply_ctx *ctx)
 174 {
 175         DWORD creationDisposition = OPEN_EXISTING;
 176         wchar_t *stream_path = (wchar_t*)path;
 177         HANDLE h;
 178         int ret;
 179
 180         if (stream_name_nchars) {
 181                 creationDisposition = CREATE_ALWAYS;
 182                 stream_path = alloca(sizeof(wchar_t) *
 183                                      (wcslen(path) + 1 +
 184                                       wcslen(stream_name) + 1));
 185                 tsprintf(stream_path, L"%ls:%ls", path, stream_name);
 186         }
 187
 188         h = CreateFile(stream_path, FILE_WRITE_DATA, 0, NULL,
 189                        creationDisposition, FILE_FLAG_BACKUP_SEMANTICS |
 190                                             FILE_FLAG_OPEN_REPARSE_POINT,
 191                        NULL);
 192         if (h == INVALID_HANDLE_VALUE)
 193                 goto error;
 194
 195         ret = 0;
 196         if (!lte)
 197                 goto out_close_handle;
 198         ret = extract_wim_resource(lte, wim_resource_size(lte),
 199                                    win32_extract_wim_chunk, h);
 200 out_close_handle:
 201         if (!CloseHandle(h))
 202                 goto error;
 203         if (ret && !errno)
 204                 errno = -1;
 205         return ret;
 206
 207 error:
 208         set_errno_from_GetLastError();
 209         return WIMLIB_ERR_WRITE;
 210 }
 211
 212 static int
 213 win32_extract_unnamed_stream(file_spec_t file,
 214                              struct wim_lookup_table_entry *lte,
 215                              struct apply_ctx *ctx)
 216 {
 217         return win32_extract_stream(file.path, NULL, 0, lte, ctx);
 218 }
 219
 220 static int
 221 win32_extract_named_stream(file_spec_t file, const wchar_t *stream_name,
 222                            size_t stream_name_nchars,
 223                            struct wim_lookup_table_entry *lte, struct apply_ctx *ctx)
 224 {
 225         return win32_extract_stream(file.path, stream_name,
 226                                     stream_name_nchars, lte, ctx);
 227 }
 228
 229 struct win32_encrypted_extract_ctx {
 230         const struct wim_lookup_table_entry *lte;
 231         u64 offset;
 232 };
 233
 234 static DWORD WINAPI
 235 win32_encrypted_import_cb(unsigned char *data, void *_import_ctx,
 236                           unsigned long *len_p)
 237 {
 238         struct win32_encrypted_extract_ctx *import_ctx = _import_ctx;
 239         unsigned long len = *len_p;
 240         const struct wim_lookup_table_entry *lte = import_ctx->lte;
 241
 242         len = min(len, wim_resource_size(lte) - import_ctx->offset);
 243
 244         if (read_partial_wim_resource_into_buf(lte, len, import_ctx->offset, data))
 245                 return ERROR_READ_FAULT;
 246
 247         import_ctx->offset += len;
 248         *len_p = len;
 249         return ERROR_SUCCESS;
 250 }
 251
 252 static int
 253 win32_extract_encrypted_stream(const wchar_t *path,
 254                                struct wim_lookup_table_entry *lte,
 255                                struct apply_ctx *ctx)
 256 {
 257         void *file_ctx;
 258         DWORD err;
 259         int ret;
 260         struct win32_encrypted_extract_ctx extract_ctx;
 261
 262         err = OpenEncryptedFileRaw(path, CREATE_FOR_IMPORT, &file_ctx);
 263         if (err != ERROR_SUCCESS) {
 264                 set_errno_from_win32_error(err);
 265                 ret = WIMLIB_ERR_OPEN;
 266                 goto out;
 267         }
 268
 269         extract_ctx.lte = lte;
 270         extract_ctx.offset = 0;
 271         err = WriteEncryptedFileRaw(win32_encrypted_import_cb, &extract_ctx,
 272                                     file_ctx);
 273         if (err != ERROR_SUCCESS) {
 274                 set_errno_from_win32_error(err);
 275                 ret = WIMLIB_ERR_WRITE;
 276                 goto out_close;
 277         }
 278
 279         ret = 0;
 280 out_close:
 281         CloseEncryptedFileRaw(file_ctx);
 282 out:
 283         return ret;
 284 }
 285
 286 static BOOL
 287 win32_set_special_file_attributes(const wchar_t *path, u32 attributes)
 288 {
 289         HANDLE h;
 290         DWORD err;
 291         USHORT compression_format = COMPRESSION_FORMAT_DEFAULT;
 292         DWORD bytes_returned;
 293
 294         h = win32_open_existing_file(path, GENERIC_READ | GENERIC_WRITE);
 295         if (h == INVALID_HANDLE_VALUE)
 296                 goto error;
 297
 298         if (attributes & FILE_ATTRIBUTE_SPARSE_FILE)
 299                 if (!DeviceIoControl(h, FSCTL_SET_SPARSE,
 300                                      NULL, 0,
 301                                      NULL, 0,
 302                                      &bytes_returned, NULL))
 303                         goto error_close_handle;
 304
 305         if (attributes & FILE_ATTRIBUTE_COMPRESSED)
 306                 if (!DeviceIoControl(h, FSCTL_SET_COMPRESSION,
 307                                      &compression_format, sizeof(USHORT),
 308                                      NULL, 0,
 309                                      &bytes_returned, NULL))
 310                         goto error_close_handle;
 311
 312         if (!CloseHandle(h))
 313                 goto error;
 314
 315         if (attributes & FILE_ATTRIBUTE_ENCRYPTED)
 316                 if (!EncryptFile(path))
 317                         goto error;
 318
 319         return TRUE;
 320
 321 error_close_handle:
 322         err = GetLastError();
 323         CloseHandle(h);
 324         SetLastError(err);
 325 error:
 326         return FALSE;
 327 }
 328
 329 static int
 330 win32_set_file_attributes(const wchar_t *path, u32 attributes,
 331                           struct apply_ctx *ctx, unsigned pass)
 332 {
 333         u32 special_attributes =
 334                 FILE_ATTRIBUTE_REPARSE_POINT |
 335                 FILE_ATTRIBUTE_DIRECTORY |
 336                 FILE_ATTRIBUTE_SPARSE_FILE |
 337                 FILE_ATTRIBUTE_COMPRESSED |
 338                 FILE_ATTRIBUTE_ENCRYPTED;
 339         u32 actual_attributes;
 340
 341         /* Delay setting FILE_ATTRIBUTE_READONLY on the initial pass (when files
 342          * are created, but data not extracted); otherwise the system will
 343          * refuse access to the file even if the process has SeRestorePrivilege.
 344          */
 345         if (pass == 0)
 346                 attributes &= ~FILE_ATTRIBUTE_READONLY;
 347
 348         if (!SetFileAttributes(path, attributes & ~special_attributes))
 349                 goto error;
 350
 351         if (pass != 0)
 352                 return 0;
 353
 354         if (attributes & (FILE_ATTRIBUTE_SPARSE_FILE |
 355                           FILE_ATTRIBUTE_ENCRYPTED |
 356                           FILE_ATTRIBUTE_COMPRESSED))
 357                 if (!win32_set_special_file_attributes(path, attributes))
 358                         goto error;
 359
 360         /* If file is not supposed to be encrypted or compressed, remove
 361          * defaulted encrypted or compressed attributes (from creating file in
 362          * encrypted or compressed directory).  */
 363         actual_attributes = GetFileAttributes(path);
 364         if (actual_attributes == INVALID_FILE_ATTRIBUTES)
 365                 goto error;
 366
 367         if ((actual_attributes & FILE_ATTRIBUTE_ENCRYPTED) &&
 368             !(attributes & FILE_ATTRIBUTE_ENCRYPTED))
 369                 if (!DecryptFile(path, 0))
 370                         goto error;
 371         if ((actual_attributes & FILE_ATTRIBUTE_COMPRESSED) &&
 372             !(attributes & FILE_ATTRIBUTE_COMPRESSED))
 373         {
 374                 HANDLE h;
 375                 DWORD bytes_returned;
 376                 USHORT compression_format = COMPRESSION_FORMAT_NONE;
 377
 378                 h = win32_open_existing_file(path, GENERIC_READ | GENERIC_WRITE);
 379                 if (h == INVALID_HANDLE_VALUE)
 380                         goto error;
 381
 382                 if (!DeviceIoControl(h, FSCTL_SET_COMPRESSION,
 383                                      &compression_format, sizeof(USHORT),
 384                                      NULL, 0,
 385                                      &bytes_returned, NULL))
 386                 {
 387                         DWORD err = GetLastError();
 388                         CloseHandle(h);
 389                         SetLastError(err);
 390                         goto error;
 391                 }
 392
 393                 if (!CloseHandle(h))
 394                         goto error;
 395         }
 396
 397         return 0;
 398
 399 error:
 400         set_errno_from_GetLastError();
 401         return WIMLIB_ERR_SET_ATTRIBUTES;
 402 }
 403
 404 static int
 405 win32_set_reparse_data(const wchar_t *path, const u8 *rpbuf, u16 rpbuflen,
 406                        struct apply_ctx *ctx)
 407 {
 408         HANDLE h;
 409         DWORD err;
 410         DWORD bytes_returned;
 411
 412         h = win32_open_existing_file(path, GENERIC_WRITE);
 413         if (h == INVALID_HANDLE_VALUE)
 414                 goto error;
 415
 416         if (!DeviceIoControl(h, FSCTL_SET_REPARSE_POINT,
 417                              (void*)rpbuf, rpbuflen,
 418                              NULL, 0, &bytes_returned, NULL))
 419                 goto error_close_handle;
 420
 421         if (!CloseHandle(h))
 422                 goto error;
 423
 424         return 0;
 425
 426 error_close_handle:
 427         err = GetLastError();
 428         CloseHandle(h);
 429         SetLastError(err);
 430 error:
 431         set_errno_from_GetLastError();
 432         return WIMLIB_ERR_WRITE; /* XXX: need better error code */
 433 }
 434
 435 static int
 436 win32_set_short_name(const wchar_t *path, const wchar_t *short_name,
 437                      size_t short_name_nchars, struct apply_ctx *ctx)
 438 {
 439         HANDLE h;
 440         DWORD err;
 441
 442         h = win32_open_existing_file(path, GENERIC_WRITE | DELETE);
 443         if (h == INVALID_HANDLE_VALUE)
 444                 goto error;
 445
 446         if (short_name_nchars) {
 447                 if (!SetFileShortName(h, short_name))
 448                         goto error_close_handle;
 449         } else if (running_on_windows_7_or_later()) {
 450                 if (!SetFileShortName(h, L""))
 451                         goto error_close_handle;
 452         }
 453
 454         if (!CloseHandle(h))
 455                 goto error;
 456
 457         return 0;
 458
 459 error_close_handle:
 460         err = GetLastError();
 461         CloseHandle(h);
 462         SetLastError(err);
 463 error:
 464         set_errno_from_GetLastError();
 465         return WIMLIB_ERR_WRITE; /* XXX: need better error code */
 466 }
 467
 468 static DWORD
 469 do_win32_set_security_descriptor(HANDLE h, const wchar_t *path,
 470                                  SECURITY_INFORMATION info,
 471                                  PSECURITY_DESCRIPTOR desc)
 472 {
 473 #ifdef WITH_NTDLL
 474         if (func_NtSetSecurityObject) {
 475                 return (*func_RtlNtStatusToDosError)(
 476                                 (*func_NtSetSecurityObject)(h, info, desc));
 477         }
 478 #endif
 479         if (SetFileSecurity(path, info, desc))
 480                 return ERROR_SUCCESS;
 481         else
 482                 return GetLastError();
 483 }
 484
 485 static int
 486 win32_set_security_descriptor(const wchar_t *path, const u8 *desc,
 487                               size_t desc_size, struct apply_ctx *ctx)
 488 {
 489         SECURITY_INFORMATION info;
 490         HANDLE h;
 491         DWORD err;
 492         int ret;
 493
 494         info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
 495                DACL_SECURITY_INFORMATION  | SACL_SECURITY_INFORMATION;
 496         h = INVALID_HANDLE_VALUE;
 497
 498 #ifdef WITH_NTDLL
 499         if (func_NtSetSecurityObject) {
 500                 h = win32_open_existing_file(path, MAXIMUM_ALLOWED);
 501                 if (h == INVALID_HANDLE_VALUE) {
 502                         ERROR_WITH_ERRNO("Can't open %ls (%u)", path, GetLastError());
 503                         goto error;
 504                 }
 505         }
 506 #endif
 507
 508         for (;;) {
 509                 err = do_win32_set_security_descriptor(h, path, info,
 510                                                        (PSECURITY_DESCRIPTOR)desc);
 511                 if (err == ERROR_SUCCESS)
 512                         break;
 513                 if ((err == ERROR_PRIVILEGE_NOT_HELD ||
 514                      err == ERROR_ACCESS_DENIED) &&
 515                     !(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
 516                 {
 517                         if (info & SACL_SECURITY_INFORMATION) {
 518                                 info &= ~SACL_SECURITY_INFORMATION;
 519                                 ctx->partial_security_descriptors++;
 520                                 continue;
 521                         }
 522                         if (info & DACL_SECURITY_INFORMATION) {
 523                                 info &= ~DACL_SECURITY_INFORMATION;
 524                                 continue;
 525                         }
 526                         if (info & OWNER_SECURITY_INFORMATION) {
 527                                 info &= ~OWNER_SECURITY_INFORMATION;
 528                                 continue;
 529                         }
 530                         ctx->partial_security_descriptors--;
 531                         ctx->no_security_descriptors++;
 532                         break;
 533                 }
 534                 SetLastError(err);
 535                 goto error;
 536         }
 537         ret = 0;
 538 out_close:
 539 #ifdef WITH_NTDLL
 540         if (func_NtSetSecurityObject)
 541                 CloseHandle(h);
 542 #endif
 543         return ret;
 544
 545 error:
 546         set_errno_from_GetLastError();
 547         ret = WIMLIB_ERR_SET_SECURITY;
 548         goto out_close;
 549 }
 550
 551 static int
 552 win32_set_timestamps(const wchar_t *path, u64 creation_time,
 553                      u64 last_write_time, u64 last_access_time,
 554                      struct apply_ctx *ctx)
 555 {
 556         HANDLE h;
 557         DWORD err;
 558         FILETIME creationTime = {.dwLowDateTime = creation_time & 0xffffffff,
 559                                  .dwHighDateTime = creation_time >> 32};
 560         FILETIME lastAccessTime = {.dwLowDateTime = last_access_time & 0xffffffff,
 561                                   .dwHighDateTime = last_access_time >> 32};
 562         FILETIME lastWriteTime = {.dwLowDateTime = last_write_time & 0xffffffff,
 563                                   .dwHighDateTime = last_write_time >> 32};
 564
 565         h = win32_open_existing_file(path, FILE_WRITE_ATTRIBUTES);
 566         if (h == INVALID_HANDLE_VALUE)
 567                 goto error;
 568
 569         if (!SetFileTime(h, &creationTime, &lastAccessTime, &lastWriteTime))
 570                 goto error_close_handle;
 571
 572         if (!CloseHandle(h))
 573                 goto error;
 574
 575         return 0;
 576
 577 error_close_handle:
 578         err = GetLastError();
 579         CloseHandle(h);
 580         SetLastError(err);
 581 error:
 582         set_errno_from_GetLastError();
 583         return WIMLIB_ERR_SET_TIMESTAMPS;
 584 }
 585
 586 const struct apply_operations win32_apply_ops = {
 587         .name = L"Win32",
 588
 589         .target_is_root           = win32_path_is_root_of_drive,
 590         .start_extract            = win32_start_extract,
 591         .create_file              = win32_create_file,
 592         .create_directory         = win32_create_directory,
 593         .create_hardlink          = win32_create_hardlink,
 594         .create_symlink           = win32_create_symlink,
 595         .extract_unnamed_stream   = win32_extract_unnamed_stream,
 596         .extract_named_stream     = win32_extract_named_stream,
 597         .extract_encrypted_stream = win32_extract_encrypted_stream,
 598         .set_file_attributes      = win32_set_file_attributes,
 599         .set_reparse_data         = win32_set_reparse_data,
 600         .set_short_name           = win32_set_short_name,
 601         .set_security_descriptor  = win32_set_security_descriptor,
 602         .set_timestamps           = win32_set_timestamps,
 603
 604         .path_prefix = L"\\\\?\\",
 605         .path_prefix_nchars = 4,
 606         .path_separator = L'\\',
 607         .path_max = 32768,
 608
 609         .requires_realtarget_in_paths = 1,
 610         .realpath_works_on_nonexisting_files = 1,
 611         .root_directory_is_special = 1,
 612         .requires_final_set_attributes_pass = 1,
 613         .extract_encrypted_stream_creates_file = 1,
 614         .requires_short_name_reordering = 1, /* TODO: check if this is really needed  */
 615 };
 616
 617 #endif /* __WIN32__ */