+struct win32_encrypted_extract_ctx {
+ void *file_ctx;
+ int wimlib_err_code;
+ bool done;
+ pthread_cond_t cond;
+ pthread_mutex_t mutex;
+ u8 buf[WIM_CHUNK_SIZE];
+ size_t buf_filled;
+};
+
+static DWORD WINAPI
+win32_encrypted_import_cb(unsigned char *data, void *_ctx,
+ unsigned long *len_p)
+{
+ struct win32_encrypted_extract_ctx *ctx = _ctx;
+ unsigned long len = *len_p;
+
+ pthread_mutex_lock(&ctx->mutex);
+ while (len) {
+ size_t bytes_to_copy;
+
+ DEBUG("Importing up to %lu more bytes of raw encrypted data", len);
+ while (ctx->buf_filled == 0) {
+ if (ctx->done)
+ goto out;
+ pthread_cond_wait(&ctx->cond, &ctx->mutex);
+ }
+ bytes_to_copy = min(len, ctx->buf_filled);
+ memcpy(data, ctx->buf, bytes_to_copy);
+ len -= bytes_to_copy;
+ data += bytes_to_copy;
+ ctx->buf_filled -= bytes_to_copy;
+ memmove(ctx->buf, ctx->buf + bytes_to_copy, ctx->buf_filled);
+ pthread_cond_signal(&ctx->cond);
+ }
+out:
+ *len_p -= len;
+ pthread_mutex_unlock(&ctx->mutex);
+ return ERROR_SUCCESS;
+}
+
+/* Extract ("Import") an encrypted file in a different thread. */
+static void *
+win32_encrypted_import_proc(void *arg)
+{
+ struct win32_encrypted_extract_ctx *ctx = arg;
+ DWORD ret;
+ ret = WriteEncryptedFileRaw(win32_encrypted_import_cb, ctx,
+ ctx->file_ctx);
+ pthread_mutex_lock(&ctx->mutex);
+ if (ret == ERROR_SUCCESS) {
+ ctx->wimlib_err_code = 0;
+ } else {
+ win32_error(ret);
+ ctx->wimlib_err_code = WIMLIB_ERR_WRITE;
+ }
+ ctx->done = true;
+ pthread_cond_signal(&ctx->cond);
+ pthread_mutex_unlock(&ctx->mutex);
+ return NULL;
+}
+
+
+static int
+win32_extract_raw_encrypted_chunk(const void *buf, size_t len, void *arg)
+{
+ struct win32_encrypted_extract_ctx *ctx = arg;
+ size_t bytes_to_copy;
+
+ while (len) {
+ DEBUG("Extracting up to %zu more bytes of encrypted data", len);
+ pthread_mutex_lock(&ctx->mutex);
+ while (ctx->buf_filled == WIM_CHUNK_SIZE) {
+ if (ctx->done) {
+ pthread_mutex_unlock(&ctx->mutex);
+ return ctx->wimlib_err_code;
+ }
+ pthread_cond_wait(&ctx->cond, &ctx->mutex);
+ }
+ bytes_to_copy = min(len, WIM_CHUNK_SIZE - ctx->buf_filled);
+ memcpy(&ctx->buf[ctx->buf_filled], buf, bytes_to_copy);
+ len -= bytes_to_copy;
+ buf += bytes_to_copy;
+ ctx->buf_filled += bytes_to_copy;
+ pthread_cond_signal(&ctx->cond);
+ pthread_mutex_unlock(&ctx->mutex);
+ }
+ return 0;
+}
+
+/* Create an encrypted file and extract the raw encrypted data to it.
+ *
+ * @path: Path to encrypted file to create.
+ * @lte: WIM lookup_table entry for the raw encrypted data.
+ *
+ * This is separate from do_win32_extract_stream() because the WIM is supposed
+ * to contain the *raw* encrypted data, which needs to be extracted ("imported")
+ * using the special APIs OpenEncryptedFileRawW(), WriteEncryptedFileRaw(), and
+ * CloseEncryptedFileRaw().
+ *
+ * Returns 0 on success; nonzero on failure.
+ */
+static int
+do_win32_extract_encrypted_stream(const wchar_t *path,
+ const struct wim_lookup_table_entry *lte)
+{
+ struct win32_encrypted_extract_ctx ctx;
+ void *file_ctx;
+ pthread_t import_thread;
+ int ret;
+ int ret2;
+
+ DEBUG("Opening file \"%ls\" to extract raw encrypted data", path);
+
+ ret = OpenEncryptedFileRawW(path, CREATE_FOR_IMPORT, &file_ctx);
+ if (ret) {
+ ERROR("Failed to open \"%ls\" to write raw encrypted data", path);
+ win32_error(ret);
+ return WIMLIB_ERR_OPEN;
+ }
+
+ if (!lte)
+ goto out_close;
+
+ /* Hack alert: WriteEncryptedFileRaw() requires the callback function
+ * to work with a buffer whose size we cannot control. This doesn't
+ * play well with our read_resource_prefix() function, which itself uses
+ * a callback function to extract WIM_CHUNK_SIZE chunks of data. We
+ * work around this problem by calling WriteEncryptedFileRaw() in a
+ * different thread and feeding it the data as needed. */
+ ctx.file_ctx = file_ctx;
+ ctx.buf_filled = 0;
+ ctx.done = false;
+ ctx.wimlib_err_code = 0;
+ if (pthread_mutex_init(&ctx.mutex, NULL)) {
+ ERROR_WITH_ERRNO("Can't create mutex");
+ ret = WIMLIB_ERR_NOMEM;
+ goto out_close;
+ }
+ if (pthread_cond_init(&ctx.cond, NULL)) {
+ ERROR_WITH_ERRNO("Can't create condition variable");
+ ret = WIMLIB_ERR_NOMEM;
+ goto out_pthread_mutex_destroy;
+ }
+ ret = pthread_create(&import_thread, NULL,
+ win32_encrypted_import_proc, &ctx);
+ if (ret) {
+ errno = ret;
+ ERROR_WITH_ERRNO("Failed to create thread");
+ ret = WIMLIB_ERR_FORK;
+ goto out_pthread_cond_destroy;
+ }
+
+ ret = extract_wim_resource(lte, wim_resource_size(lte),
+ win32_extract_raw_encrypted_chunk, &ctx);
+ pthread_mutex_lock(&ctx.mutex);
+ ctx.done = true;
+ pthread_cond_signal(&ctx.cond);
+ pthread_mutex_unlock(&ctx.mutex);
+ ret2 = pthread_join(import_thread, NULL);
+ if (ret2) {
+ errno = ret2;
+ ERROR_WITH_ERRNO("Failed to join encrypted import thread");
+ if (ret == 0)
+ ret = WIMLIB_ERR_WRITE;
+ }
+ if (ret == 0)
+ ret = ctx.wimlib_err_code;
+out_pthread_cond_destroy:
+ pthread_cond_destroy(&ctx.cond);
+out_pthread_mutex_destroy:
+ pthread_mutex_destroy(&ctx.mutex);
+out_close:
+ CloseEncryptedFileRaw(file_ctx);
+ if (ret)
+ ERROR("Failed to extract encrypted file \"%ls\"", path);
+ return ret;
+}
+
+static bool
+path_is_root_of_drive(const wchar_t *path)
+{
+ if (!*path)
+ return false;
+
+ if (*path != L'/' && *path != L'\\') {
+ if (*(path + 1) == L':')
+ path += 2;
+ else
+ return false;
+ }
+ while (*path == L'/' || *path == L'\\')
+ path++;
+ return (*path == L'\0');
+}
+
+static inline DWORD
+win32_mask_attributes(DWORD i_attributes)
+{
+ return i_attributes & ~(FILE_ATTRIBUTE_SPARSE_FILE |
+ FILE_ATTRIBUTE_COMPRESSED |
+ FILE_ATTRIBUTE_REPARSE_POINT |
+ FILE_ATTRIBUTE_DIRECTORY |
+ FILE_ATTRIBUTE_ENCRYPTED |
+ FILE_FLAG_DELETE_ON_CLOSE |
+ FILE_FLAG_NO_BUFFERING |
+ FILE_FLAG_OPEN_NO_RECALL |
+ FILE_FLAG_OVERLAPPED |
+ FILE_FLAG_RANDOM_ACCESS |
+ /*FILE_FLAG_SESSION_AWARE |*/
+ FILE_FLAG_SEQUENTIAL_SCAN |
+ FILE_FLAG_WRITE_THROUGH);
+}
+
+static inline DWORD
+win32_get_create_flags_and_attributes(DWORD i_attributes)
+{
+ /*
+ * Some attributes cannot be set by passing them to CreateFile(). In
+ * particular:
+ *
+ * FILE_ATTRIBUTE_DIRECTORY:
+ * CreateDirectory() must be called instead of CreateFile().
+ *
+ * FILE_ATTRIBUTE_SPARSE_FILE:
+ * Needs an ioctl.
+ * See: win32_set_sparse().
+ *
+ * FILE_ATTRIBUTE_COMPRESSED:
+ * Not clear from the documentation, but apparently this needs an
+ * ioctl as well.
+ * See: win32_set_compressed().
+ *
+ * FILE_ATTRIBUTE_REPARSE_POINT:
+ * Needs an ioctl, with the reparse data specified.
+ * See: win32_set_reparse_data().
+ *
+ * In addition, clear any file flags in the attributes that we don't
+ * want, but also specify FILE_FLAG_OPEN_REPARSE_POINT and
+ * FILE_FLAG_BACKUP_SEMANTICS as we are a backup application.
+ */
+ return win32_mask_attributes(i_attributes) |
+ FILE_FLAG_OPEN_REPARSE_POINT |
+ FILE_FLAG_BACKUP_SEMANTICS;
+}
+
+/* Set compression and/or sparse attributes on a stream, if supported by the
+ * volume. */
+static int
+win32_set_special_stream_attributes(HANDLE hFile, const struct wim_inode *inode,
+ struct wim_lookup_table_entry *unnamed_stream_lte,
+ const wchar_t *path, unsigned vol_flags)
+{
+ int ret;
+
+ if (inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED) {
+ if (vol_flags & FILE_FILE_COMPRESSION) {
+ ret = win32_set_compression_state(hFile,
+ COMPRESSION_FORMAT_DEFAULT,
+ path);
+ if (ret)
+ return ret;
+ } else {
+ DEBUG("Cannot set compression attribute on \"%ls\": "
+ "volume does not support transparent compression",
+ path);
+ }
+ }
+
+ if (inode->i_attributes & FILE_ATTRIBUTE_SPARSE_FILE) {
+ if (vol_flags & FILE_SUPPORTS_SPARSE_FILES) {
+ DEBUG("Setting sparse flag on \"%ls\"", path);
+ ret = win32_set_sparse(hFile, path);
+ if (ret)
+ return ret;
+ } else {
+ DEBUG("Cannot set sparse attribute on \"%ls\": "
+ "volume does not support sparse files",
+ path);
+ }
+ }
+ return 0;
+}
+
+/* Pre-create directories; extract encrypted streams */
+static int
+win32_begin_extract_unnamed_stream(const struct wim_inode *inode,
+ const struct wim_lookup_table_entry *lte,
+ const wchar_t *path,
+ DWORD *creationDisposition_ret,
+ unsigned int vol_flags)
+{
+ DWORD err;
+ int ret;
+
+ /* Directories must be created with CreateDirectoryW(). Then the call
+ * to CreateFileW() will merely open the directory that was already
+ * created rather than creating a new file. */
+ if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY &&
+ !path_is_root_of_drive(path)) {
+ if (!CreateDirectoryW(path, NULL)) {
+ err = GetLastError();
+ if (err != ERROR_ALREADY_EXISTS) {
+ ERROR("Failed to create directory \"%ls\"",
+ path);
+ win32_error(err);
+ return WIMLIB_ERR_MKDIR;
+ }
+ }
+ DEBUG("Created directory \"%ls\"", path);
+ *creationDisposition_ret = OPEN_EXISTING;
+ }
+ if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED &&
+ vol_flags & FILE_SUPPORTS_ENCRYPTION)
+ {
+ if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
+ if (!EncryptFile(path)) {
+ err = GetLastError();
+ ERROR("Failed to encrypt directory \"%ls\"",
+ path);
+ win32_error(err);
+ return WIMLIB_ERR_WRITE;
+ }
+ } else {
+ ret = do_win32_extract_encrypted_stream(path, lte);
+ if (ret)
+ return ret;
+ DEBUG("Extracted encrypted file \"%ls\"", path);
+ }
+ *creationDisposition_ret = OPEN_EXISTING;
+ }
+
+ /* Set file attributes if we created the file. Otherwise, we haven't
+ * created the file set and we will set the attributes in the call to
+ * CreateFileW().
+ *
+ * The FAT filesystem does not let you change the attributes of the root
+ * directory, so treat that as a special case and do not set attributes.
+ * */
+ if (*creationDisposition_ret == OPEN_EXISTING &&
+ !path_is_root_of_drive(path))
+ {
+ if (!SetFileAttributesW(path,
+ win32_mask_attributes(inode->i_attributes)))
+ {
+ err = GetLastError();
+ ERROR("Failed to set attributes on \"%ls\"", path);
+ win32_error(err);
+ return WIMLIB_ERR_WRITE;
+ }
+ }
+ return 0;
+}
+
+/* Set security descriptor and extract stream data or reparse data (skip the
+ * unnamed data stream of encrypted files, which was already extracted). */
+static int
+win32_finish_extract_stream(HANDLE h, const struct wim_inode *inode,
+ const struct wim_lookup_table_entry *lte,
+ const wchar_t *stream_path,
+ const wchar_t *stream_name_utf16,
+ struct apply_args *args)
+{
+ int ret = 0;
+ if (stream_name_utf16 == NULL) {
+ /* Unnamed stream. */
+
+ /* Set security descriptor, unless the extract_flags indicate
+ * not to or the volume does not supported it. Note that this
+ * is only done when the unnamed stream is being extracted, as
+ * security descriptors are per-file and not per-stream. */
+ if (inode->i_security_id >= 0 &&
+ !(args->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS)
+ && (args->vol_flags & FILE_PERSISTENT_ACLS))
+ {
+ ret = win32_set_security_data(inode, h, stream_path, args);
+ if (ret)
+ return ret;
+ }
+
+ /* Handle reparse points. The data for them needs to be set
+ * using a special ioctl. Note that the reparse point may have
+ * been created using CreateFileW() in the case of
+ * non-directories or CreateDirectoryW() in the case of
+ * directories; but the ioctl works either way. Also, it is
+ * only this step that actually sets the
+ * FILE_ATTRIBUTE_REPARSE_POINT, as it is not valid to set it
+ * using SetFileAttributesW() or CreateFileW().
+ *
+ * If the volume does not support reparse points we simply
+ * ignore the reparse data. (N.B. the code currently doesn't
+ * actually reach this case because reparse points are skipped
+ * entirely on such volumes.) */
+ if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
+ if (args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS) {
+ ret = win32_set_reparse_data(h, inode,
+ lte, stream_path,
+ args);
+ if (ret)
+ return ret;
+ } else {
+ DEBUG("Cannot set reparse data on \"%ls\": volume "
+ "does not support reparse points", stream_path);
+ }
+ } else if (lte != NULL &&
+ !(args->vol_flags & FILE_SUPPORTS_ENCRYPTION &&
+ inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED))
+ {
+ /* Extract the data of the unnamed stream, unless the
+ * lookup table entry is NULL (indicating an empty
+ * stream for which no data needs to be extracted), or
+ * the stream is encrypted and therefore was already
+ * extracted as a special case. */
+ ret = do_win32_extract_stream(h, lte);
+ }
+ } else {
+ /* Extract the data for a named data stream. */
+ if (lte != NULL) {
+ DEBUG("Extracting named data stream \"%ls\" (len = %"PRIu64")",
+ stream_path, wim_resource_size(lte));
+ ret = do_win32_extract_stream(h, lte);
+ }
+ }
+ return ret;
+}
+
+static int
+win32_decrypt_file(HANDLE open_handle, const wchar_t *path)
+{
+ DWORD err;
+ /* We cannot call DecryptFileW() while there is an open handle to the
+ * file. So close it first. */
+ if (!CloseHandle(open_handle)) {
+ err = GetLastError();
+ ERROR("Failed to close handle for \"%ls\"", path);
+ win32_error(err);
+ return WIMLIB_ERR_WRITE;
+ }
+ if (!DecryptFileW(path, 0 /* reserved parameter; set to 0 */)) {
+ err = GetLastError();
+ ERROR("Failed to decrypt file \"%ls\"", path);
+ win32_error(err);
+ return WIMLIB_ERR_WRITE;
+ }
+ return 0;
+}
+
+/*
+ * Create and extract a stream to a file, or create a directory, using the
+ * Windows API.
+ *
+ * This handles reparse points, directories, alternate data streams, encrypted
+ * files, compressed files, etc.
+ *
+ * @inode: WIM inode containing the stream.
+ *
+ * @path: Path to extract the file to.
+ *
+ * @stream_name_utf16:
+ * Name of the stream, or NULL if the stream is unnamed. This will
+ * be called with a NULL stream_name_utf16 before any non-NULL
+ * stream_name_utf16's.
+ *
+ * @lte: WIM lookup table entry for the stream. May be NULL to indicate
+ * a stream of length 0.
+ *
+ * @args: Additional apply context, including flags indicating supported
+ * volume features.
+ *
+ * Returns 0 on success; nonzero on failure.
+ */