2 * win32_common.c - Windows code common to applying and capturing images.
6 * Copyright (C) 2013, 2014, 2015 Eric Biggers
8 * This file is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU Lesser General Public License as published by the Free
10 * Software Foundation; either version 3 of the License, or (at your option) any
13 * This file is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this file; if not, see http://www.gnu.org/licenses/.
30 #include "wimlib/win32_common.h"
32 #include "wimlib/error.h"
33 #include "wimlib/util.h"
36 win32_error_to_errno(DWORD err_code)
38 /* This mapping is that used in Cygwin.
39 * Some of these choices are arbitrary. */
41 case ERROR_ACCESS_DENIED:
43 case ERROR_ACTIVE_CONNECTIONS:
45 case ERROR_ALREADY_EXISTS:
47 case ERROR_BAD_DEVICE:
49 case ERROR_BAD_EXE_FORMAT:
51 case ERROR_BAD_NETPATH:
53 case ERROR_BAD_NET_NAME:
55 case ERROR_BAD_NET_RESP:
57 case ERROR_BAD_PATHNAME:
63 case ERROR_BAD_USERNAME:
65 case ERROR_BEGINNING_OF_MEDIA:
67 case ERROR_BROKEN_PIPE:
73 case ERROR_CALL_NOT_IMPLEMENTED:
75 case ERROR_CANNOT_MAKE:
77 case ERROR_CHILD_NOT_COMPLETE:
79 case ERROR_COMMITMENT_LIMIT:
83 case ERROR_DEVICE_DOOR_OPEN:
85 case ERROR_DEVICE_IN_USE:
87 case ERROR_DEVICE_REQUIRES_CLEANING:
91 case ERROR_DIR_NOT_EMPTY:
93 case ERROR_DISK_CORRUPT:
101 case ERROR_EAS_DIDNT_FIT:
104 case ERROR_EAS_NOT_SUPPORTED:
107 case ERROR_EA_LIST_INCONSISTENT:
109 case ERROR_EA_TABLE_FULL:
111 case ERROR_END_OF_MEDIA:
113 case ERROR_EOM_OVERFLOW:
115 case ERROR_EXE_MACHINE_TYPE_MISMATCH:
117 case ERROR_EXE_MARKED_INVALID:
119 case ERROR_FILEMARK_DETECTED:
121 case ERROR_FILENAME_EXCED_RANGE:
123 case ERROR_FILE_CORRUPT:
125 case ERROR_FILE_EXISTS:
127 case ERROR_FILE_INVALID:
129 case ERROR_FILE_NOT_FOUND:
131 case ERROR_HANDLE_DISK_FULL:
134 case ERROR_HANDLE_EOF:
137 case ERROR_INVALID_ADDRESS:
139 case ERROR_INVALID_AT_INTERRUPT_TIME:
141 case ERROR_INVALID_BLOCK_LENGTH:
143 case ERROR_INVALID_DATA:
145 case ERROR_INVALID_DRIVE:
147 case ERROR_INVALID_EA_NAME:
149 case ERROR_INVALID_EXE_SIGNATURE:
152 case ERROR_INVALID_FUNCTION:
155 case ERROR_INVALID_HANDLE:
157 case ERROR_INVALID_NAME:
159 case ERROR_INVALID_PARAMETER:
161 case ERROR_INVALID_SIGNAL_NUMBER:
163 case ERROR_IOPL_NOT_ENABLED:
165 case ERROR_IO_DEVICE:
167 case ERROR_IO_INCOMPLETE:
169 case ERROR_IO_PENDING:
171 case ERROR_LOCK_VIOLATION:
173 case ERROR_MAX_THRDS_REACHED:
175 case ERROR_META_EXPANSION_TOO_LONG:
177 case ERROR_MOD_NOT_FOUND:
180 case ERROR_MORE_DATA:
183 case ERROR_NEGATIVE_SEEK:
185 case ERROR_NETNAME_DELETED:
189 case ERROR_NONE_MAPPED:
191 case ERROR_NONPAGED_SYSTEM_RESOURCES:
194 case ERROR_NOT_CONNECTED:
197 case ERROR_NOT_ENOUGH_MEMORY:
199 case ERROR_NOT_OWNER:
202 case ERROR_NOT_READY:
205 case ERROR_NOT_SAME_DEVICE:
207 case ERROR_NOT_SUPPORTED:
211 case ERROR_NO_DATA_DETECTED:
214 case ERROR_NO_MEDIA_IN_DRIVE:
218 case ERROR_NO_MORE_FILES:
222 case ERROR_NO_MORE_ITEMS:
225 case ERROR_NO_MORE_SEARCH_HANDLES:
227 case ERROR_NO_PROC_SLOTS:
229 case ERROR_NO_SIGNAL_SENT:
231 case ERROR_NO_SYSTEM_RESOURCES:
235 case ERROR_OPEN_FAILED:
237 case ERROR_OPEN_FILES:
239 case ERROR_OUTOFMEMORY:
241 case ERROR_PAGED_SYSTEM_RESOURCES:
243 case ERROR_PAGEFILE_QUOTA:
245 case ERROR_PATH_NOT_FOUND:
247 case ERROR_PIPE_BUSY:
249 case ERROR_PIPE_CONNECTED:
252 case ERROR_PIPE_LISTENING:
254 case ERROR_PIPE_NOT_CONNECTED:
257 case ERROR_POSSIBLE_DEADLOCK:
259 case ERROR_PRIVILEGE_NOT_HELD:
261 case ERROR_PROCESS_ABORTED:
263 case ERROR_PROC_NOT_FOUND:
266 case ERROR_REM_NOT_LIST:
269 case ERROR_SECTOR_NOT_FOUND:
273 case ERROR_SETMARK_DETECTED:
275 case ERROR_SHARING_BUFFER_EXCEEDED:
277 case ERROR_SHARING_VIOLATION:
279 case ERROR_SIGNAL_PENDING:
281 case ERROR_SIGNAL_REFUSED:
284 case ERROR_SXS_CANT_GEN_ACTCTX:
287 case ERROR_THREAD_1_INACTIVE:
289 case ERROR_TOO_MANY_LINKS:
291 case ERROR_TOO_MANY_OPEN_FILES:
293 case ERROR_WAIT_NO_CHILDREN:
295 case ERROR_WORKING_SET_QUOTA:
297 case ERROR_WRITE_PROTECT:
305 set_errno_from_win32_error(DWORD err)
307 errno = win32_error_to_errno(err);
311 set_errno_from_GetLastError(void)
313 set_errno_from_win32_error(GetLastError());
317 win32_modify_privilege(const wchar_t *privilege, bool enable)
321 TOKEN_PRIVILEGES newState;
324 if (!OpenProcessToken(GetCurrentProcess(),
325 TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY,
329 if (!LookupPrivilegeValue(NULL, privilege, &luid))
330 goto out_close_handle;
332 newState.PrivilegeCount = 1;
333 newState.Privileges[0].Luid = luid;
334 newState.Privileges[0].Attributes = (enable ? SE_PRIVILEGE_ENABLED : 0);
335 SetLastError(ERROR_SUCCESS);
336 ret = AdjustTokenPrivileges(hToken, FALSE, &newState, 0, NULL, NULL);
337 if (ret && GetLastError() == ERROR_NOT_ALL_ASSIGNED)
346 win32_modify_capture_privileges(bool enable)
348 return win32_modify_privilege(SE_BACKUP_NAME, enable)
349 && win32_modify_privilege(SE_SECURITY_NAME, enable);
353 win32_modify_apply_privileges(bool enable)
355 return win32_modify_privilege(SE_RESTORE_NAME, enable)
356 && win32_modify_privilege(SE_SECURITY_NAME, enable)
357 && win32_modify_privilege(SE_TAKE_OWNERSHIP_NAME, enable);
361 win32_release_capture_and_apply_privileges(void)
363 win32_modify_capture_privileges(false);
364 win32_modify_apply_privileges(false);
367 /* Pointers to dynamically loaded functions */
371 NTSTATUS (WINAPI *func_NtCreateFile)(PHANDLE FileHandle,
372 ACCESS_MASK DesiredAccess,
373 POBJECT_ATTRIBUTES ObjectAttributes,
374 PIO_STATUS_BLOCK IoStatusBlock,
375 PLARGE_INTEGER AllocationSize,
376 ULONG FileAttributes,
378 ULONG CreateDisposition,
383 NTSTATUS (WINAPI *func_NtOpenFile) (PHANDLE FileHandle,
384 ACCESS_MASK DesiredAccess,
385 POBJECT_ATTRIBUTES ObjectAttributes,
386 PIO_STATUS_BLOCK IoStatusBlock,
390 NTSTATUS (WINAPI *func_NtReadFile) (HANDLE FileHandle,
392 PIO_APC_ROUTINE ApcRoutine,
394 PIO_STATUS_BLOCK IoStatusBlock,
397 PLARGE_INTEGER ByteOffset,
400 NTSTATUS (WINAPI *func_NtWriteFile) (HANDLE FileHandle,
402 PIO_APC_ROUTINE ApcRoutine,
404 PIO_STATUS_BLOCK IoStatusBlock,
407 PLARGE_INTEGER ByteOffset,
410 NTSTATUS (WINAPI *func_NtQueryInformationFile)(HANDLE FileHandle,
411 PIO_STATUS_BLOCK IoStatusBlock,
412 PVOID FileInformation,
414 FILE_INFORMATION_CLASS FileInformationClass);
416 NTSTATUS (WINAPI *func_NtQuerySecurityObject)(HANDLE handle,
417 SECURITY_INFORMATION SecurityInformation,
418 PSECURITY_DESCRIPTOR SecurityDescriptor,
420 PULONG LengthNeeded);
422 NTSTATUS (WINAPI *func_NtQueryDirectoryFile) (HANDLE FileHandle,
424 PIO_APC_ROUTINE ApcRoutine,
426 PIO_STATUS_BLOCK IoStatusBlock,
427 PVOID FileInformation,
429 FILE_INFORMATION_CLASS FileInformationClass,
430 BOOLEAN ReturnSingleEntry,
431 PUNICODE_STRING FileName,
432 BOOLEAN RestartScan);
434 NTSTATUS (WINAPI *func_NtQueryVolumeInformationFile) (HANDLE FileHandle,
435 PIO_STATUS_BLOCK IoStatusBlock,
438 FS_INFORMATION_CLASS FsInformationClass);
440 NTSTATUS (WINAPI *func_NtSetInformationFile)(HANDLE FileHandle,
441 PIO_STATUS_BLOCK IoStatusBlock,
442 PVOID FileInformation,
444 FILE_INFORMATION_CLASS FileInformationClass);
446 NTSTATUS (WINAPI *func_NtSetSecurityObject)(HANDLE Handle,
447 SECURITY_INFORMATION SecurityInformation,
448 PSECURITY_DESCRIPTOR SecurityDescriptor);
450 NTSTATUS (WINAPI *func_NtFsControlFile) (HANDLE FileHandle,
452 PIO_APC_ROUTINE ApcRoutine,
454 PIO_STATUS_BLOCK IoStatusBlock,
457 ULONG InputBufferLength,
459 ULONG OutputBufferLength);
461 NTSTATUS (WINAPI *func_NtClose) (HANDLE Handle);
463 DWORD (WINAPI *func_RtlNtStatusToDosError)(NTSTATUS status);
465 BOOLEAN (WINAPI *func_RtlDosPathNameToNtPathName_U)
467 OUT PUNICODE_STRING NtName,
468 OUT PCWSTR *PartName,
469 OUT PRTL_RELATIVE_NAME_U RelativeName);
471 NTSTATUS (WINAPI *func_RtlDosPathNameToNtPathName_U_WithStatus)
473 OUT PUNICODE_STRING NtName,
474 OUT PCWSTR *PartName,
475 OUT PRTL_RELATIVE_NAME_U RelativeName);
477 NTSTATUS (WINAPI *func_RtlCreateSystemVolumeInformationFolder)
478 (PCUNICODE_STRING VolumeRootPath);
480 static bool acquired_privileges = false;
488 #define DLL_SYM(name, required) { (void **)&func_##name, #name, required }
490 #define for_each_sym(sym, spec) \
491 for ((sym) = (spec)->syms; (sym)->name; (sym)++)
496 const struct dll_sym syms[];
499 struct dll_spec ntdll_spec = {
500 .name = L"ntdll.dll",
502 DLL_SYM(NtCreateFile, true),
503 DLL_SYM(NtOpenFile, true),
504 DLL_SYM(NtReadFile, true),
505 DLL_SYM(NtWriteFile, true),
506 DLL_SYM(NtQueryInformationFile, true),
507 DLL_SYM(NtQuerySecurityObject, true),
508 DLL_SYM(NtQueryDirectoryFile, true),
509 DLL_SYM(NtQueryVolumeInformationFile, true),
510 DLL_SYM(NtSetInformationFile, true),
511 DLL_SYM(NtSetSecurityObject, true),
512 DLL_SYM(NtFsControlFile, true),
513 DLL_SYM(NtClose, true),
514 DLL_SYM(RtlNtStatusToDosError, true),
515 DLL_SYM(RtlCreateSystemVolumeInformationFolder, false),
516 DLL_SYM(RtlDosPathNameToNtPathName_U, true),
517 DLL_SYM(RtlDosPathNameToNtPathName_U_WithStatus, false), /* Not present on XP */
523 init_dll(struct dll_spec *spec)
525 const struct dll_sym *sym;
529 spec->handle = LoadLibrary(spec->name);
531 for_each_sym(sym, spec) {
533 ERROR("%ls could not be loaded!", spec->name);
534 return WIMLIB_ERR_UNSUPPORTED;
539 for_each_sym(sym, spec) {
540 addr = (void *)GetProcAddress(spec->handle, sym->name);
542 *(sym->func_ptr) = addr;
543 } else if (sym->required) {
544 ERROR("Can't find %s in %ls", sym->name, spec->name);
545 return WIMLIB_ERR_UNSUPPORTED;
552 cleanup_dll(struct dll_spec *spec)
554 const struct dll_sym *sym;
557 FreeLibrary(spec->handle);
560 for_each_sym(sym, spec)
561 *(sym->func_ptr) = NULL;
565 /* One-time initialization for Windows capture/apply code. */
567 win32_global_init(int init_flags)
571 /* Try to acquire useful privileges. */
572 if (!(init_flags & WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES)) {
573 ret = WIMLIB_ERR_INSUFFICIENT_PRIVILEGES;
574 if (!win32_modify_capture_privileges(true))
575 if (init_flags & WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES)
577 if (!win32_modify_apply_privileges(true))
578 if (init_flags & WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES)
580 acquired_privileges = true;
583 ret = init_dll(&ntdll_spec);
590 win32_release_capture_and_apply_privileges();
595 win32_global_cleanup(void)
597 if (acquired_privileges)
598 win32_release_capture_and_apply_privileges();
600 cleanup_dll(&ntdll_spec);
604 * Translates a Win32-namespace path into an NT-namespace path.
606 * On success, returns 0. The NT-namespace path will be stored in the
607 * UNICODE_STRING structure pointed to by nt_path. nt_path->Buffer will be set
608 * to a new buffer that must later be freed with HeapFree(). (Really
609 * RtlHeapFree(), but HeapFree() seems to be the same thing.)
611 * On failure, returns WIMLIB_ERR_NOMEM or WIMLIB_ERR_INVALID_PARAM.
614 win32_path_to_nt_path(const wchar_t *win32_path, UNICODE_STRING *nt_path)
618 if (func_RtlDosPathNameToNtPathName_U_WithStatus) {
619 status = (*func_RtlDosPathNameToNtPathName_U_WithStatus)(win32_path,
623 if ((*func_RtlDosPathNameToNtPathName_U)(win32_path, nt_path,
625 status = STATUS_SUCCESS;
627 status = STATUS_NO_MEMORY;
630 if (likely(NT_SUCCESS(status)))
633 if (status == STATUS_NO_MEMORY)
634 return WIMLIB_ERR_NOMEM;
636 ERROR("\"%ls\": invalid path name (status=0x%08"PRIx32")",
637 win32_path, (u32)status);
638 return WIMLIB_ERR_INVALID_PARAM;
642 win32_get_drive_path(const wchar_t *file_path, wchar_t drive_path[7])
646 file_abspath = realpath(file_path, NULL);
648 return WIMLIB_ERR_NOMEM;
650 if (file_abspath[0] == L'\0' || file_abspath[1] != L':') {
651 ERROR("\"%ls\": Path format not recognized", file_abspath);
653 return WIMLIB_ERR_UNSUPPORTED;
656 wsprintf(drive_path, L"\\\\.\\%lc:", file_abspath[0]);
662 windows_msg(u32 code, const wchar_t *format, va_list va,
663 bool is_ntstatus, bool is_error)
665 wchar_t _buf[STACK_MAX / 8];
667 size_t buflen = ARRAY_LEN(_buf);
672 n = vsnwprintf(buf, buflen, format, va);
677 n += snwprintf(&buf[n], buflen - n,
679 L" (status=%08"PRIx32"): " :
680 L" (err=%"PRIu32"): "),
686 ret = FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
688 is_ntstatus ? (*func_RtlNtStatusToDosError)(code) : code,
689 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
695 if (n >= buflen || (ret == 0 && GetLastError() == ERROR_INSUFFICIENT_BUFFER))
698 if (buf[n - 1] == L'\n')
700 if (buf[n - 1] == L'\r')
702 if (buf[n - 1] == L'.')
717 buf = MALLOC(buflen * sizeof(buf[0]));
720 ERROR("Ran out of memory while building error message!!!");
724 win32_warning(DWORD err, const wchar_t *format, ...)
728 va_start(va, format);
729 windows_msg(err, format, va, false, false);
734 win32_error(DWORD err, const wchar_t *format, ...)
738 va_start(va, format);
739 windows_msg(err, format, va, false, true);
744 winnt_warning(NTSTATUS status, const wchar_t *format, ...)
748 va_start(va, format);
749 windows_msg(status, format, va, true, false);
754 winnt_error(NTSTATUS status, const wchar_t *format, ...)
758 va_start(va, format);
759 windows_msg(status, format, va, true, true);
763 #endif /* __WIN32__ */