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