]> wimlib.net Git - wimlib/blobdiff - src/win32_apply.c
win32_apply.c: set_short_name(): Increase minimum buffer size
[wimlib] / src / win32_apply.c
index 300571f03e41f41a02211aa09f50c9ff5e02b93f..a6b37c4a90cda4375a874fa7d9691ad63a80b82b 100644 (file)
@@ -124,6 +124,13 @@ struct win32_apply_ctx {
        /* Number of files for which we didn't have permission to set any part
         * of the security descriptor.  */
        unsigned long no_security_descriptors;
+
+       /* Number of files for which we couldn't set the short name.  */
+       unsigned long num_short_name_failures;
+
+       /* Have we tried to enable short name support on the target volume yet?
+        */
+       bool tried_to_enable_short_names;
 };
 
 /* Get the drive letter from a Windows path, or return the null character if the
@@ -341,6 +348,80 @@ start_wimboot_extraction(struct win32_apply_ctx *ctx)
                                            &ctx->wimboot.wof_running);
 }
 
+static void
+build_win32_extraction_path(const struct wim_dentry *dentry,
+                           struct win32_apply_ctx *ctx);
+
+/* Sets WimBoot=1 in the extracted SYSTEM registry hive.
+ *
+ * WIMGAPI does this, and it's possible that it's important.
+ * But I don't know exactly what this value means to Windows.  */
+static int
+end_wimboot_extraction(struct win32_apply_ctx *ctx)
+{
+       struct wim_dentry *dentry;
+       wchar_t subkeyname[32];
+       LONG res;
+       LONG res2;
+       HKEY key;
+       DWORD value;
+
+       dentry = get_dentry(ctx->common.wim, L"\\Windows\\System32\\config\\SYSTEM",
+                           WIMLIB_CASE_INSENSITIVE);
+
+       if (!dentry || !will_extract_dentry(dentry))
+               goto out;
+
+       if (!will_extract_dentry(wim_get_current_root_dentry(ctx->common.wim)))
+               goto out;
+
+       /* Not bothering to use the native routines (e.g. NtLoadKey()) for this.
+        * If this doesn't work, you probably also have many other problems.  */
+
+       build_win32_extraction_path(dentry, ctx);
+
+       randomize_char_array_with_alnum(subkeyname, 20);
+       subkeyname[20] = L'\0';
+
+       res = RegLoadKey(HKEY_LOCAL_MACHINE, subkeyname, ctx->pathbuf.Buffer);
+       if (res)
+               goto out_check_res;
+
+       wcscpy(&subkeyname[20], L"\\Setup");
+
+       res = RegCreateKeyEx(HKEY_LOCAL_MACHINE, subkeyname, 0, NULL,
+                            REG_OPTION_BACKUP_RESTORE, 0, NULL, &key, NULL);
+       if (res)
+               goto out_unload_key;
+
+       value = 1;
+
+       res = RegSetValueEx(key, L"WimBoot", 0, REG_DWORD,
+                           (const BYTE *)&value, sizeof(DWORD));
+       if (res)
+               goto out_close_key;
+
+       res = RegFlushKey(key);
+
+out_close_key:
+       res2 = RegCloseKey(key);
+       if (!res)
+               res = res2;
+out_unload_key:
+       subkeyname[20] = L'\0';
+       RegUnLoadKey(HKEY_LOCAL_MACHINE, subkeyname);
+out_check_res:
+       if (res) {
+               /* Warning only.  */
+               set_errno_from_win32_error(res);
+               WARNING_WITH_ERRNO("Failed to set \\Setup: dword \"WimBoot\"=1 value "
+                                  "in registry hive \"%ls\" (err=%"PRIu32")",
+                                  ctx->pathbuf.Buffer, (u32)res);
+       }
+out:
+       return 0;
+}
+
 /* Returns the number of wide characters needed to represent the path to the
  * specified @dentry, relative to the target directory, when extracted.
  *
@@ -461,7 +542,7 @@ build_extraction_path_with_ads(const struct wim_dentry *dentry,
  * The path is saved in ctx->pathbuf and will be null terminated.
  *
  * XXX: We could get rid of this if it wasn't needed for the file encryption
- * APIs.  */
+ * APIs, and the registry manipulation in WIMBoot mode.  */
 static void
 build_win32_extraction_path(const struct wim_dentry *dentry,
                            struct win32_apply_ctx *ctx)
@@ -715,6 +796,43 @@ maybe_clear_encryption_attribute(HANDLE *h_ptr, const struct wim_dentry *dentry,
        return 0;
 }
 
+/* Try to enable short name support on the target volume.  If successful, return
+ * true.  If unsuccessful, issue a warning and return false.  */
+static bool
+try_to_enable_short_names(const wchar_t *volume)
+{
+       HANDLE h;
+       FILE_FS_PERSISTENT_VOLUME_INFORMATION info;
+       BOOL bret;
+       DWORD bytesReturned;
+
+       h = CreateFile(volume, GENERIC_WRITE,
+                      FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
+                      FILE_FLAG_BACKUP_SEMANTICS, NULL);
+       if (h == INVALID_HANDLE_VALUE)
+               goto fail;
+
+       info.VolumeFlags = 0;
+       info.FlagMask = PERSISTENT_VOLUME_STATE_SHORT_NAME_CREATION_DISABLED;
+       info.Version = 1;
+       info.Reserved = 0;
+
+       bret = DeviceIoControl(h, FSCTL_SET_PERSISTENT_VOLUME_STATE,
+                              &info, sizeof(info), NULL, 0,
+                              &bytesReturned, NULL);
+
+       CloseHandle(h);
+
+       if (!bret)
+               goto fail;
+       return true;
+
+fail:
+       WARNING("Failed to enable short name support on %ls "
+               "(err=%"PRIu32")", volume + 4, (u32)GetLastError());
+       return false;
+}
+
 /* Set the short name on the open file @h which has been created at the location
  * indicated by @dentry.
  *
@@ -729,8 +847,24 @@ static int
 set_short_name(HANDLE h, const struct wim_dentry *dentry,
               struct win32_apply_ctx *ctx)
 {
+
+       if (!ctx->common.supported_features.short_names)
+               return 0;
+
+       /*
+        * Note: The size of the FILE_NAME_INFORMATION buffer must be such that
+        * FileName contains at least 2 wide characters (4 bytes).  Otherwise,
+        * NtSetInformationFile() will return STATUS_INFO_LENGTH_MISMATCH.  This
+        * is despite the fact that FileNameLength can validly be 0 or 2 bytes,
+        * with the former case being removing the existing short name if
+        * present, rather than setting one.
+        *
+        * FileName seemingly does not, however, need to be null-terminated in
+        * any case.
+        */
+
        size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
-                        dentry->short_name_nbytes;
+                        max(dentry->short_name_nbytes, 2 * sizeof(wchar_t));
        u8 buf[bufsize] _aligned_attribute(8);
        FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
        NTSTATUS status;
@@ -738,20 +872,40 @@ set_short_name(HANDLE h, const struct wim_dentry *dentry,
        info->FileNameLength = dentry->short_name_nbytes;
        memcpy(info->FileName, dentry->short_name, dentry->short_name_nbytes);
 
+
+retry:
        status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
                                              FileShortNameInformation);
        if (NT_SUCCESS(status))
                return 0;
 
+       if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
+               if (dentry->short_name_nbytes == 0)
+                       return 0;
+               if (!ctx->tried_to_enable_short_names) {
+                       wchar_t volume[7];
+                       int ret;
+
+                       ctx->tried_to_enable_short_names = true;
+
+                       ret = win32_get_drive_path(ctx->common.target,
+                                                  volume);
+                       if (ret)
+                               return ret;
+                       if (try_to_enable_short_names(volume))
+                               goto retry;
+               }
+       }
+
        /* By default, failure to set short names is not an error (since short
         * names aren't too important anymore...).  */
-       if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES))
+       if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
+               ctx->num_short_name_failures++;
                return 0;
+       }
 
        if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
-               if (dentry->short_name_nbytes == 0)
-                       return 0;
-               ERROR("Can't extract short name when short "
+               ERROR("Can't set short name when short "
                      "names are not enabled on the volume!");
        } else {
                ERROR("Can't set short name on \"%ls\" (status=0x%08"PRIx32")",
@@ -960,6 +1114,10 @@ create_directories(struct list_head *dentry_list,
                ret = create_any_empty_ads(dentry, ctx);
                if (ret)
                        return ret;
+
+               ret = report_file_created(&ctx->common);
+               if (ret)
+                       return ret;
        }
        return 0;
 }
@@ -1207,6 +1365,9 @@ create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx
                ret = create_nondirectory(inode, ctx);
                if (ret)
                        return ret;
+               ret = report_file_created(&ctx->common);
+               if (ret)
+                       return ret;
        }
        return 0;
 }
@@ -1970,6 +2131,9 @@ apply_metadata(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
                ret = apply_metadata_to_file(dentry, ctx);
                if (ret)
                        return ret;
+               ret = report_file_metadata_applied(&ctx->common);
+               if (ret)
+                       return ret;
        }
        return 0;
 }
@@ -1981,23 +2145,30 @@ static void
 do_warnings(const struct win32_apply_ctx *ctx)
 {
        if (ctx->partial_security_descriptors == 0 &&
-           ctx->no_security_descriptors == 0)
+           ctx->no_security_descriptors == 0 &&
+           ctx->num_short_name_failures == 0)
                return;
 
        WARNING("Extraction to \"%ls\" complete, but with one or more warnings:",
                ctx->common.target);
-       if (ctx->partial_security_descriptors != 0) {
+       if (ctx->num_short_name_failures) {
+               WARNING("- Could not set short names on %lu files or directories",
+                       ctx->num_short_name_failures);
+       }
+       if (ctx->partial_security_descriptors) {
                WARNING("- Could only partially set the security descriptor\n"
                        "            on %lu files or directories.",
                        ctx->partial_security_descriptors);
        }
-       if (ctx->no_security_descriptors != 0) {
+       if (ctx->no_security_descriptors) {
                WARNING("- Could not set security descriptor at all\n"
                        "            on %lu files or directories.",
                        ctx->no_security_descriptors);
        }
-       WARNING("To fully restore all security descriptors, run the program\n"
-               "          with Administrator rights.");
+       if (ctx->partial_security_descriptors || ctx->no_security_descriptors) {
+               WARNING("To fully restore all security descriptors, run the program\n"
+                       "          with Administrator rights.");
+       }
 }
 
 /* Extract files from a WIM image to a directory on Windows  */
@@ -2011,12 +2182,14 @@ win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
        if (ret)
                goto out;
 
-       if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT) {
+       if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
                ret = start_wimboot_extraction(ctx);
                if (ret)
                        goto out;
        }
 
+       reset_file_progress(&ctx->common);
+
        ret = create_directories(dentry_list, ctx);
        if (ret)
                goto out;
@@ -2037,10 +2210,18 @@ win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
        if (ret)
                goto out;
 
+       reset_file_progress(&ctx->common);
+
        ret = apply_metadata(dentry_list, ctx);
        if (ret)
                goto out;
 
+       if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
+               ret = end_wimboot_extraction(ctx);
+               if (ret)
+                       goto out;
+       }
+
        do_warnings(ctx);
 out:
        if (ctx->h_target)