2 * win32_apply.c - Windows-specific code for applying files from a WIM image.
6 * Copyright (C) 2013 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
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)
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
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/.
30 #include "wimlib/win32_common.h"
32 #include "wimlib/apply.h"
33 #include "wimlib/error.h"
34 #include "wimlib/lookup_table.h"
37 win32_start_extract(const wchar_t *path, struct apply_ctx *ctx)
41 bool supports_SetFileShortName;
43 ret = win32_get_vol_flags(path, &vol_flags, &supports_SetFileShortName);
47 ctx->supported_features.archive_files = 1;
48 ctx->supported_features.hidden_files = 1;
49 ctx->supported_features.system_files = 1;
51 if (vol_flags & FILE_FILE_COMPRESSION)
52 ctx->supported_features.compressed_files = 1;
54 if (vol_flags & FILE_SUPPORTS_ENCRYPTION) {
55 ctx->supported_features.encrypted_files = 1;
56 ctx->supported_features.encrypted_directories = 1;
59 ctx->supported_features.not_context_indexed_files = 1;
61 if (vol_flags & FILE_SUPPORTS_SPARSE_FILES)
62 ctx->supported_features.sparse_files = 1;
64 if (vol_flags & FILE_NAMED_STREAMS)
65 ctx->supported_features.named_data_streams = 1;
67 if (vol_flags & FILE_SUPPORTS_HARD_LINKS)
68 ctx->supported_features.hard_links = 1;
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;
76 if (vol_flags & FILE_PERSISTENT_ACLS)
77 ctx->supported_features.security_descriptors = 1;
79 if (supports_SetFileShortName)
80 ctx->supported_features.short_names = 1;
84 /* Create a normal file, overwriting one already present. */
86 win32_create_file(const wchar_t *path, struct apply_ctx *ctx, u64 *cookie_ret)
89 unsigned retry_count = 0;
90 DWORD dwFlagsAndAttributes = FILE_FLAG_BACKUP_SEMANTICS;
93 /* WRITE_OWNER and WRITE_DAC privileges are required for some reason,
94 * even through we're creating a new file. */
95 h = CreateFile(path, WRITE_OWNER | WRITE_DAC, 0, NULL,
96 CREATE_ALWAYS, dwFlagsAndAttributes, NULL);
97 if (h == INVALID_HANDLE_VALUE) {
98 /* File couldn't be created. */
99 DWORD err = GetLastError();
100 if (err == ERROR_ACCESS_DENIED && retry_count == 0) {
102 /* Access denied error for the first time. Try
103 * adjusting file attributes. */
105 /* Get attributes of the existing file. */
106 DWORD attribs = GetFileAttributes(path);
107 if (attribs != INVALID_FILE_ATTRIBUTES &&
108 (attribs & (FILE_ATTRIBUTE_HIDDEN |
109 FILE_ATTRIBUTE_SYSTEM |
110 FILE_ATTRIBUTE_READONLY)))
112 /* If the existing file has
113 * FILE_ATTRIBUTE_HIDDEN and/or
114 * FILE_ATTRIBUTE_SYSTEM, they must be set in
115 * the call to CreateFile(). This is true even
116 * when FILE_ATTRIBUTE_NORMAL was not specified,
117 * contrary to the MS "documentation". */
118 dwFlagsAndAttributes |= (attribs &
119 (FILE_ATTRIBUTE_HIDDEN |
120 FILE_ATTRIBUTE_SYSTEM));
121 /* If the existing file has
122 * FILE_ATTRIBUTE_READONLY, it must be cleared
123 * before attempting to create a new file over
124 * it. This is true even when the process has
125 * the SE_RESTORE_NAME privilege and requested
126 * the FILE_FLAG_BACKUP_SEMANTICS flag to
128 if (attribs & FILE_ATTRIBUTE_READONLY) {
129 SetFileAttributes(path,
130 attribs & ~FILE_ATTRIBUTE_READONLY);
136 set_errno_from_win32_error(err);
137 return WIMLIB_ERR_OPEN;
144 win32_create_directory(const wchar_t *path, struct apply_ctx *ctx,
147 if (!CreateDirectory(path, NULL))
148 if (GetLastError() != ERROR_ALREADY_EXISTS)
153 set_errno_from_GetLastError();
154 return WIMLIB_ERR_MKDIR;
158 win32_create_hardlink(const wchar_t *oldpath, const wchar_t *newpath,
159 struct apply_ctx *ctx)
161 if (!CreateHardLink(newpath, oldpath, NULL)) {
162 if (GetLastError() != ERROR_ALREADY_EXISTS)
164 if (!DeleteFile(newpath))
166 if (!CreateHardLink(newpath, oldpath, NULL))
172 set_errno_from_GetLastError();
173 return WIMLIB_ERR_LINK;
177 win32_create_symlink(const wchar_t *oldpath, const wchar_t *newpath,
178 struct apply_ctx *ctx)
180 if (!(*win32func_CreateSymbolicLinkW)(newpath, oldpath, 0)) {
181 if (GetLastError() != ERROR_ALREADY_EXISTS)
183 if (!DeleteFile(newpath))
185 if (!(*win32func_CreateSymbolicLinkW)(newpath, oldpath, 0))
191 set_errno_from_GetLastError();
192 return WIMLIB_ERR_LINK;
196 win32_extract_wim_chunk(const void *buf, size_t len, void *arg)
198 HANDLE h = (HANDLE)arg;
199 DWORD nbytes_written;
201 if (unlikely(!WriteFile(h, buf, len, &nbytes_written, NULL)))
203 if (unlikely(nbytes_written != len))
208 set_errno_from_GetLastError();
209 return WIMLIB_ERR_WRITE;
213 win32_extract_stream(const wchar_t *path, const wchar_t *stream_name,
214 size_t stream_name_nchars,
215 struct wim_lookup_table_entry *lte, struct apply_ctx *ctx)
217 DWORD creationDisposition = OPEN_EXISTING;
218 wchar_t *stream_path = (wchar_t*)path;
222 if (stream_name_nchars) {
223 creationDisposition = CREATE_ALWAYS;
224 stream_path = alloca(sizeof(wchar_t) *
226 wcslen(stream_name) + 1));
227 tsprintf(stream_path, L"%ls:%ls", path, stream_name);
230 h = CreateFile(stream_path, FILE_WRITE_DATA, 0, NULL,
231 creationDisposition, FILE_FLAG_BACKUP_SEMANTICS |
232 FILE_FLAG_OPEN_REPARSE_POINT,
234 if (h == INVALID_HANDLE_VALUE)
239 goto out_close_handle;
240 ret = extract_stream(lte, lte->size, win32_extract_wim_chunk, h);
249 set_errno_from_GetLastError();
250 return WIMLIB_ERR_WRITE;
254 win32_extract_unnamed_stream(file_spec_t file,
255 struct wim_lookup_table_entry *lte,
256 struct apply_ctx *ctx)
258 return win32_extract_stream(file.path, NULL, 0, lte, ctx);
262 win32_extract_named_stream(file_spec_t file, const wchar_t *stream_name,
263 size_t stream_name_nchars,
264 struct wim_lookup_table_entry *lte, struct apply_ctx *ctx)
266 return win32_extract_stream(file.path, stream_name,
267 stream_name_nchars, lte, ctx);
270 struct win32_encrypted_extract_ctx {
271 const struct wim_lookup_table_entry *lte;
276 win32_encrypted_import_cb(unsigned char *data, void *_import_ctx,
277 unsigned long *len_p)
279 struct win32_encrypted_extract_ctx *import_ctx = _import_ctx;
280 unsigned long len = *len_p;
281 const struct wim_lookup_table_entry *lte = import_ctx->lte;
283 len = min(len, lte->size - import_ctx->offset);
285 if (read_partial_wim_stream_into_buf(lte, len, import_ctx->offset, data))
286 return ERROR_READ_FAULT;
288 import_ctx->offset += len;
290 return ERROR_SUCCESS;
294 win32_extract_encrypted_stream(const wchar_t *path,
295 struct wim_lookup_table_entry *lte,
296 struct apply_ctx *ctx)
301 struct win32_encrypted_extract_ctx extract_ctx;
303 err = OpenEncryptedFileRaw(path, CREATE_FOR_IMPORT, &file_ctx);
304 if (err != ERROR_SUCCESS) {
305 set_errno_from_win32_error(err);
306 ret = WIMLIB_ERR_OPEN;
310 extract_ctx.lte = lte;
311 extract_ctx.offset = 0;
312 err = WriteEncryptedFileRaw(win32_encrypted_import_cb, &extract_ctx,
314 if (err != ERROR_SUCCESS) {
315 set_errno_from_win32_error(err);
316 ret = WIMLIB_ERR_WRITE;
322 CloseEncryptedFileRaw(file_ctx);
328 win32_set_special_file_attributes(const wchar_t *path, u32 attributes)
332 USHORT compression_format = COMPRESSION_FORMAT_DEFAULT;
333 DWORD bytes_returned;
335 h = win32_open_existing_file(path, GENERIC_READ | GENERIC_WRITE);
336 if (h == INVALID_HANDLE_VALUE)
339 if (attributes & FILE_ATTRIBUTE_SPARSE_FILE)
340 if (!DeviceIoControl(h, FSCTL_SET_SPARSE,
343 &bytes_returned, NULL))
344 goto error_close_handle;
346 if (attributes & FILE_ATTRIBUTE_COMPRESSED)
347 if (!DeviceIoControl(h, FSCTL_SET_COMPRESSION,
348 &compression_format, sizeof(USHORT),
350 &bytes_returned, NULL))
351 goto error_close_handle;
356 if (attributes & FILE_ATTRIBUTE_ENCRYPTED)
357 if (!EncryptFile(path))
363 err = GetLastError();
371 win32_set_file_attributes(const wchar_t *path, u32 attributes,
372 struct apply_ctx *ctx, unsigned pass)
374 u32 special_attributes =
375 FILE_ATTRIBUTE_REPARSE_POINT |
376 FILE_ATTRIBUTE_DIRECTORY |
377 FILE_ATTRIBUTE_SPARSE_FILE |
378 FILE_ATTRIBUTE_COMPRESSED |
379 FILE_ATTRIBUTE_ENCRYPTED;
380 u32 actual_attributes;
382 /* Delay setting FILE_ATTRIBUTE_READONLY on the initial pass (when files
383 * are created, but data not extracted); otherwise the system will
384 * refuse access to the file even if the process has SeRestorePrivilege.
387 attributes &= ~FILE_ATTRIBUTE_READONLY;
389 if (!SetFileAttributes(path, attributes & ~special_attributes))
395 if (attributes & (FILE_ATTRIBUTE_SPARSE_FILE |
396 FILE_ATTRIBUTE_ENCRYPTED |
397 FILE_ATTRIBUTE_COMPRESSED))
398 if (!win32_set_special_file_attributes(path, attributes))
401 /* If file is not supposed to be encrypted or compressed, remove
402 * defaulted encrypted or compressed attributes (from creating file in
403 * encrypted or compressed directory). */
404 actual_attributes = GetFileAttributes(path);
405 if (actual_attributes == INVALID_FILE_ATTRIBUTES)
408 if ((actual_attributes & FILE_ATTRIBUTE_ENCRYPTED) &&
409 !(attributes & FILE_ATTRIBUTE_ENCRYPTED))
410 if (!DecryptFile(path, 0))
412 if ((actual_attributes & FILE_ATTRIBUTE_COMPRESSED) &&
413 !(attributes & FILE_ATTRIBUTE_COMPRESSED))
416 DWORD bytes_returned;
417 USHORT compression_format = COMPRESSION_FORMAT_NONE;
419 h = win32_open_existing_file(path, GENERIC_READ | GENERIC_WRITE);
420 if (h == INVALID_HANDLE_VALUE)
423 if (!DeviceIoControl(h, FSCTL_SET_COMPRESSION,
424 &compression_format, sizeof(USHORT),
426 &bytes_returned, NULL))
428 DWORD err = GetLastError();
441 set_errno_from_GetLastError();
442 return WIMLIB_ERR_SET_ATTRIBUTES;
446 win32_set_reparse_data(const wchar_t *path, const u8 *rpbuf, u16 rpbuflen,
447 struct apply_ctx *ctx)
451 DWORD bytes_returned;
453 h = win32_open_existing_file(path, GENERIC_WRITE);
454 if (h == INVALID_HANDLE_VALUE)
457 if (!DeviceIoControl(h, FSCTL_SET_REPARSE_POINT,
458 (void*)rpbuf, rpbuflen,
459 NULL, 0, &bytes_returned, NULL))
460 goto error_close_handle;
468 err = GetLastError();
472 set_errno_from_GetLastError();
473 return WIMLIB_ERR_WRITE; /* XXX: need better error code */
477 win32_set_short_name(const wchar_t *path, const wchar_t *short_name,
478 size_t short_name_nchars, struct apply_ctx *ctx)
483 h = win32_open_existing_file(path, GENERIC_WRITE | DELETE);
484 if (h == INVALID_HANDLE_VALUE)
487 if (short_name_nchars) {
488 if (!SetFileShortName(h, short_name))
489 goto error_close_handle;
490 } else if (running_on_windows_7_or_later()) {
491 if (!SetFileShortName(h, L""))
492 goto error_close_handle;
501 err = GetLastError();
505 set_errno_from_GetLastError();
506 return WIMLIB_ERR_WRITE; /* XXX: need better error code */
510 do_win32_set_security_descriptor(HANDLE h, const wchar_t *path,
511 SECURITY_INFORMATION info,
512 PSECURITY_DESCRIPTOR desc)
515 if (func_NtSetSecurityObject) {
516 return (*func_RtlNtStatusToDosError)(
517 (*func_NtSetSecurityObject)(h, info, desc));
520 if (SetFileSecurity(path, info, desc))
521 return ERROR_SUCCESS;
523 return GetLastError();
527 win32_set_security_descriptor(const wchar_t *path, const u8 *desc,
528 size_t desc_size, struct apply_ctx *ctx)
530 SECURITY_INFORMATION info;
535 info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
536 DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION;
537 h = INVALID_HANDLE_VALUE;
540 if (func_NtSetSecurityObject) {
541 h = win32_open_existing_file(path, MAXIMUM_ALLOWED);
542 if (h == INVALID_HANDLE_VALUE) {
543 ERROR_WITH_ERRNO("Can't open %ls (%u)", path, GetLastError());
550 err = do_win32_set_security_descriptor(h, path, info,
551 (PSECURITY_DESCRIPTOR)desc);
552 if (err == ERROR_SUCCESS)
554 if ((err == ERROR_PRIVILEGE_NOT_HELD ||
555 err == ERROR_ACCESS_DENIED) &&
556 !(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
558 if (info & SACL_SECURITY_INFORMATION) {
559 info &= ~SACL_SECURITY_INFORMATION;
560 ctx->partial_security_descriptors++;
563 if (info & DACL_SECURITY_INFORMATION) {
564 info &= ~DACL_SECURITY_INFORMATION;
567 if (info & OWNER_SECURITY_INFORMATION) {
568 info &= ~OWNER_SECURITY_INFORMATION;
571 ctx->partial_security_descriptors--;
572 ctx->no_security_descriptors++;
581 if (func_NtSetSecurityObject)
587 set_errno_from_GetLastError();
588 ret = WIMLIB_ERR_SET_SECURITY;
593 win32_set_timestamps(const wchar_t *path, u64 creation_time,
594 u64 last_write_time, u64 last_access_time,
595 struct apply_ctx *ctx)
599 FILETIME creationTime = {.dwLowDateTime = creation_time & 0xffffffff,
600 .dwHighDateTime = creation_time >> 32};
601 FILETIME lastAccessTime = {.dwLowDateTime = last_access_time & 0xffffffff,
602 .dwHighDateTime = last_access_time >> 32};
603 FILETIME lastWriteTime = {.dwLowDateTime = last_write_time & 0xffffffff,
604 .dwHighDateTime = last_write_time >> 32};
606 h = win32_open_existing_file(path, FILE_WRITE_ATTRIBUTES);
607 if (h == INVALID_HANDLE_VALUE)
610 if (!SetFileTime(h, &creationTime, &lastAccessTime, &lastWriteTime))
611 goto error_close_handle;
619 err = GetLastError();
623 set_errno_from_GetLastError();
624 return WIMLIB_ERR_SET_TIMESTAMPS;
627 const struct apply_operations win32_apply_ops = {
630 .target_is_root = win32_path_is_root_of_drive,
631 .start_extract = win32_start_extract,
632 .create_file = win32_create_file,
633 .create_directory = win32_create_directory,
634 .create_hardlink = win32_create_hardlink,
635 .create_symlink = win32_create_symlink,
636 .extract_unnamed_stream = win32_extract_unnamed_stream,
637 .extract_named_stream = win32_extract_named_stream,
638 .extract_encrypted_stream = win32_extract_encrypted_stream,
639 .set_file_attributes = win32_set_file_attributes,
640 .set_reparse_data = win32_set_reparse_data,
641 .set_short_name = win32_set_short_name,
642 .set_security_descriptor = win32_set_security_descriptor,
643 .set_timestamps = win32_set_timestamps,
645 .path_prefix = L"\\\\?\\",
646 .path_prefix_nchars = 4,
647 .path_separator = L'\\',
650 .requires_realtarget_in_paths = 1,
651 .realpath_works_on_nonexisting_files = 1,
652 .root_directory_is_special = 1,
653 .requires_final_set_attributes_pass = 1,
654 .extract_encrypted_stream_creates_file = 1,
655 .requires_short_name_reordering = 1, /* TODO: check if this is really needed */
658 #endif /* __WIN32__ */