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;
85 win32_create_file(const wchar_t *path, struct apply_ctx *ctx, u64 *cookie_ret)
89 h = CreateFile(path, 0, 0, NULL, CREATE_ALWAYS,
90 FILE_ATTRIBUTE_NORMAL | FILE_FLAG_BACKUP_SEMANTICS, NULL);
91 if (h == INVALID_HANDLE_VALUE)
97 set_errno_from_GetLastError();
98 return WIMLIB_ERR_OPEN;
102 win32_create_directory(const wchar_t *path, struct apply_ctx *ctx,
105 if (!CreateDirectory(path, NULL))
106 if (GetLastError() != ERROR_ALREADY_EXISTS)
111 set_errno_from_GetLastError();
112 return WIMLIB_ERR_MKDIR;
116 win32_create_hardlink(const wchar_t *oldpath, const wchar_t *newpath,
117 struct apply_ctx *ctx)
119 if (!CreateHardLink(newpath, oldpath, NULL)) {
120 if (GetLastError() != ERROR_ALREADY_EXISTS)
122 if (!DeleteFile(newpath))
124 if (!CreateHardLink(newpath, oldpath, NULL))
130 set_errno_from_GetLastError();
131 return WIMLIB_ERR_LINK;
135 win32_create_symlink(const wchar_t *oldpath, const wchar_t *newpath,
136 struct apply_ctx *ctx)
138 if (!(*win32func_CreateSymbolicLinkW)(newpath, oldpath, 0)) {
139 if (GetLastError() != ERROR_ALREADY_EXISTS)
141 if (!DeleteFile(newpath))
143 if (!(*win32func_CreateSymbolicLinkW)(newpath, oldpath, 0))
149 set_errno_from_GetLastError();
150 return WIMLIB_ERR_LINK;
154 win32_extract_wim_chunk(const void *buf, size_t len, void *arg)
156 HANDLE h = (HANDLE)arg;
157 DWORD nbytes_written;
159 if (unlikely(!WriteFile(h, buf, len, &nbytes_written, NULL)))
161 if (unlikely(nbytes_written != len))
166 set_errno_from_GetLastError();
167 return WIMLIB_ERR_WRITE;
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)
175 DWORD creationDisposition = OPEN_EXISTING;
176 wchar_t *stream_path = (wchar_t*)path;
180 if (stream_name_nchars) {
181 creationDisposition = CREATE_ALWAYS;
182 stream_path = alloca(sizeof(wchar_t) *
184 wcslen(stream_name) + 1));
185 tsprintf(stream_path, L"%ls:%ls", path, stream_name);
188 h = CreateFile(stream_path, FILE_WRITE_DATA, 0, NULL,
189 creationDisposition, FILE_FLAG_BACKUP_SEMANTICS |
190 FILE_FLAG_OPEN_REPARSE_POINT,
192 if (h == INVALID_HANDLE_VALUE)
197 goto out_close_handle;
198 ret = extract_wim_resource(lte, wim_resource_size(lte),
199 win32_extract_wim_chunk, h);
208 set_errno_from_GetLastError();
209 return WIMLIB_ERR_WRITE;
213 win32_extract_unnamed_stream(file_spec_t file,
214 struct wim_lookup_table_entry *lte,
215 struct apply_ctx *ctx)
217 return win32_extract_stream(file.path, NULL, 0, lte, ctx);
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)
225 return win32_extract_stream(file.path, stream_name,
226 stream_name_nchars, lte, ctx);
229 struct win32_encrypted_extract_ctx {
230 const struct wim_lookup_table_entry *lte;
235 win32_encrypted_import_cb(unsigned char *data, void *_import_ctx,
236 unsigned long *len_p)
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;
242 len = min(len, wim_resource_size(lte) - import_ctx->offset);
244 if (read_partial_wim_resource_into_buf(lte, len, import_ctx->offset, data))
245 return ERROR_READ_FAULT;
247 import_ctx->offset += len;
249 return ERROR_SUCCESS;
253 win32_extract_encrypted_stream(const wchar_t *path,
254 struct wim_lookup_table_entry *lte,
255 struct apply_ctx *ctx)
260 struct win32_encrypted_extract_ctx extract_ctx;
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;
269 extract_ctx.lte = lte;
270 extract_ctx.offset = 0;
271 err = WriteEncryptedFileRaw(win32_encrypted_import_cb, &extract_ctx,
273 if (err != ERROR_SUCCESS) {
274 set_errno_from_win32_error(err);
275 ret = WIMLIB_ERR_WRITE;
281 CloseEncryptedFileRaw(file_ctx);
287 win32_set_special_file_attributes(const wchar_t *path, u32 attributes)
291 USHORT compression_format = COMPRESSION_FORMAT_DEFAULT;
292 DWORD bytes_returned;
294 h = win32_open_existing_file(path, GENERIC_READ | GENERIC_WRITE);
295 if (h == INVALID_HANDLE_VALUE)
298 if (attributes & FILE_ATTRIBUTE_SPARSE_FILE)
299 if (!DeviceIoControl(h, FSCTL_SET_SPARSE,
302 &bytes_returned, NULL))
303 goto error_close_handle;
305 if (attributes & FILE_ATTRIBUTE_COMPRESSED)
306 if (!DeviceIoControl(h, FSCTL_SET_COMPRESSION,
307 &compression_format, sizeof(USHORT),
309 &bytes_returned, NULL))
310 goto error_close_handle;
315 if (attributes & FILE_ATTRIBUTE_ENCRYPTED)
316 if (!EncryptFile(path))
322 err = GetLastError();
330 win32_set_file_attributes(const wchar_t *path, u32 attributes,
331 struct apply_ctx *ctx, unsigned pass)
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;
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.
346 attributes &= ~FILE_ATTRIBUTE_READONLY;
348 if (!SetFileAttributes(path, attributes & ~special_attributes))
354 if (attributes & (FILE_ATTRIBUTE_SPARSE_FILE |
355 FILE_ATTRIBUTE_ENCRYPTED |
356 FILE_ATTRIBUTE_COMPRESSED))
357 if (!win32_set_special_file_attributes(path, attributes))
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)
367 if ((actual_attributes & FILE_ATTRIBUTE_ENCRYPTED) &&
368 !(attributes & FILE_ATTRIBUTE_ENCRYPTED))
369 if (!DecryptFile(path, 0))
371 if ((actual_attributes & FILE_ATTRIBUTE_COMPRESSED) &&
372 !(attributes & FILE_ATTRIBUTE_COMPRESSED))
375 DWORD bytes_returned;
376 USHORT compression_format = COMPRESSION_FORMAT_NONE;
378 h = win32_open_existing_file(path, GENERIC_READ | GENERIC_WRITE);
379 if (h == INVALID_HANDLE_VALUE)
382 if (!DeviceIoControl(h, FSCTL_SET_COMPRESSION,
383 &compression_format, sizeof(USHORT),
385 &bytes_returned, NULL))
387 DWORD err = GetLastError();
400 set_errno_from_GetLastError();
401 return WIMLIB_ERR_SET_ATTRIBUTES;
405 win32_set_reparse_data(const wchar_t *path, const u8 *rpbuf, u16 rpbuflen,
406 struct apply_ctx *ctx)
410 DWORD bytes_returned;
412 h = win32_open_existing_file(path, GENERIC_WRITE);
413 if (h == INVALID_HANDLE_VALUE)
416 if (!DeviceIoControl(h, FSCTL_SET_REPARSE_POINT,
417 (void*)rpbuf, rpbuflen,
418 NULL, 0, &bytes_returned, NULL))
419 goto error_close_handle;
427 err = GetLastError();
431 set_errno_from_GetLastError();
432 return WIMLIB_ERR_WRITE; /* XXX: need better error code */
436 win32_set_short_name(const wchar_t *path, const wchar_t *short_name,
437 size_t short_name_nchars, struct apply_ctx *ctx)
442 h = win32_open_existing_file(path, GENERIC_WRITE | DELETE);
443 if (h == INVALID_HANDLE_VALUE)
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;
460 err = GetLastError();
464 set_errno_from_GetLastError();
465 return WIMLIB_ERR_WRITE; /* XXX: need better error code */
469 do_win32_set_security_descriptor(HANDLE h, const wchar_t *path,
470 SECURITY_INFORMATION info,
471 PSECURITY_DESCRIPTOR desc)
474 if (func_NtSetSecurityObject) {
475 return (*func_RtlNtStatusToDosError)(
476 (*func_NtSetSecurityObject)(h, info, desc));
479 if (SetFileSecurity(path, info, desc))
480 return ERROR_SUCCESS;
482 return GetLastError();
486 win32_set_security_descriptor(const wchar_t *path, const u8 *desc,
487 size_t desc_size, struct apply_ctx *ctx)
489 SECURITY_INFORMATION info;
494 info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
495 DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION;
496 h = INVALID_HANDLE_VALUE;
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());
509 err = do_win32_set_security_descriptor(h, path, info,
510 (PSECURITY_DESCRIPTOR)desc);
511 if (err == ERROR_SUCCESS)
513 if ((err == ERROR_PRIVILEGE_NOT_HELD ||
514 err == ERROR_ACCESS_DENIED) &&
515 !(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
517 if (info & SACL_SECURITY_INFORMATION) {
518 info &= ~SACL_SECURITY_INFORMATION;
519 ctx->partial_security_descriptors++;
522 if (info & DACL_SECURITY_INFORMATION) {
523 info &= ~DACL_SECURITY_INFORMATION;
526 if (info & OWNER_SECURITY_INFORMATION) {
527 info &= ~OWNER_SECURITY_INFORMATION;
530 ctx->partial_security_descriptors--;
531 ctx->no_security_descriptors++;
540 if (func_NtSetSecurityObject)
546 set_errno_from_GetLastError();
547 ret = WIMLIB_ERR_SET_SECURITY;
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)
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};
565 h = win32_open_existing_file(path, FILE_WRITE_ATTRIBUTES);
566 if (h == INVALID_HANDLE_VALUE)
569 if (!SetFileTime(h, &creationTime, &lastAccessTime, &lastWriteTime))
570 goto error_close_handle;
578 err = GetLastError();
582 set_errno_from_GetLastError();
583 return WIMLIB_ERR_SET_TIMESTAMPS;
586 const struct apply_operations win32_apply_ops = {
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,
604 .path_prefix = L"\\\\?\\",
605 .path_prefix_nchars = 4,
606 .path_separator = L'\\',
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 */
617 #endif /* __WIN32__ */