// Copyright 2018 Dolphin Emulator Project // Licensed under GPLv2+ // Refer to the license.txt file included. #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "Common/CommonPaths.h" #include "Common/CommonTypes.h" #include "Common/FileUtil.h" #include "Common/HttpRequest.h" #include "Common/StringUtil.h" #include "Updater/UI.h" namespace { // Public key used to verify update manifests. const u8 UPDATE_PUB_KEY[] = {0x2a, 0xb3, 0xd1, 0xdc, 0x6e, 0xf5, 0x07, 0xf6, 0xa0, 0x6c, 0x7c, 0x54, 0xdf, 0x54, 0xf4, 0x42, 0x80, 0xa6, 0x28, 0x8b, 0x6d, 0x70, 0x14, 0xb5, 0x4c, 0x34, 0x95, 0x20, 0x4d, 0xd4, 0xd3, 0x5d}; const char UPDATE_TEMP_DIR[] = "TempUpdate"; // Where to log updater output. FILE* log_fp = stderr; void FlushLog() { fflush(log_fp); fclose(log_fp); } // Internal representation of options passed on the command-line. struct Options { std::string this_manifest_url; std::string next_manifest_url; std::string content_store_url; std::string install_base_path; std::optional binary_to_restart; std::optional parent_pid; std::optional log_file; }; std::vector CommandLineToUtf8Argv(PCWSTR command_line) { int nargs; LPWSTR* tokenized = CommandLineToArgvW(command_line, &nargs); if (!tokenized) return {}; std::vector argv(nargs); for (int i = 0; i < nargs; ++i) { argv[i] = UTF16ToUTF8(tokenized[i]); } LocalFree(tokenized); return argv; } std::optional ParseCommandLine(PCWSTR command_line) { using optparse::OptionParser; OptionParser parser = OptionParser().prog("updater.exe").description("Dolphin Updater binary"); parser.add_option("--this-manifest-url") .dest("this-manifest-url") .help("URL to the update manifest for the currently installed version.") .metavar("URL"); parser.add_option("--next-manifest-url") .dest("next-manifest-url") .help("URL to the update manifest for the to-be-installed version.") .metavar("URL"); parser.add_option("--content-store-url") .dest("content-store-url") .help("Base URL of the content store where files to download are stored.") .metavar("URL"); parser.add_option("--install-base-path") .dest("install-base-path") .help("Base path of the Dolphin install to be updated.") .metavar("PATH"); parser.add_option("--binary-to-restart") .dest("binary-to-restart") .help("Binary to restart after the update is over.") .metavar("PATH"); parser.add_option("--log-file") .dest("log-file") .help("File where to log updater debug output.") .metavar("PATH"); parser.add_option("--parent-pid") .dest("parent-pid") .type("int") .help("(optional) PID of the parent process. The updater will wait for this process to " "complete before proceeding.") .metavar("PID"); std::vector argv = CommandLineToUtf8Argv(command_line); optparse::Values options = parser.parse_args(argv); Options opts; // Required arguments. std::vector required{"this-manifest-url", "next-manifest-url", "content-store-url", "install-base-path"}; for (const auto& req : required) { if (!options.is_set(req)) { parser.print_help(); return {}; } } opts.this_manifest_url = options["this-manifest-url"]; opts.next_manifest_url = options["next-manifest-url"]; opts.content_store_url = options["content-store-url"]; opts.install_base_path = options["install-base-path"]; // Optional arguments. if (options.is_set("binary-to-restart")) opts.binary_to_restart = options["binary-to-restart"]; if (options.is_set("parent-pid")) opts.parent_pid = (DWORD)options.get("parent-pid"); if (options.is_set("log-file")) opts.log_file = options["log-file"]; return opts; } std::optional GzipInflate(const std::string& data) { z_stream zstrm; zstrm.zalloc = nullptr; zstrm.zfree = nullptr; zstrm.opaque = nullptr; zstrm.avail_in = static_cast(data.size()); zstrm.next_in = reinterpret_cast(const_cast(data.data())); // 16 + MAX_WBITS means gzip. Don't ask me. inflateInit2(&zstrm, 16 + MAX_WBITS); std::string out; char buffer[4096]; int ret; do { zstrm.avail_out = sizeof(buffer); zstrm.next_out = reinterpret_cast(buffer); ret = inflate(&zstrm, 0); out.append(buffer, sizeof(buffer) - zstrm.avail_out); } while (ret == Z_OK); inflateEnd(&zstrm); if (ret != Z_STREAM_END) { fprintf(log_fp, "Could not read the data as gzip: error %d.\n", ret); return {}; } return out; } bool VerifySignature(const std::string& data, const std::string& b64_signature) { u8 signature[64]; // ed25519 sig size. size_t sig_size; if (mbedtls_base64_decode(signature, sizeof(signature), &sig_size, reinterpret_cast(b64_signature.data()), b64_signature.size()) || sig_size != sizeof(signature)) { fprintf(log_fp, "Invalid base64: %s\n", b64_signature.c_str()); return false; } return ed25519_verify(signature, reinterpret_cast(data.data()), data.size(), UPDATE_PUB_KEY); } struct Manifest { using Filename = std::string; using Hash = std::array; std::map entries; }; bool HexDecode(const std::string& hex, u8* buffer, size_t size) { if (hex.size() != size * 2) return false; auto DecodeNibble = [](char c) -> std::optional { if (c >= '0' && c <= '9') return static_cast(c - '0'); else if (c >= 'a' && c <= 'f') return static_cast(c - 'a' + 10); else if (c >= 'A' && c <= 'F') return static_cast(c - 'A' + 10); else return {}; }; for (size_t i = 0; i < size; ++i) { std::optional high = DecodeNibble(hex[2 * i]); std::optional low = DecodeNibble(hex[2 * i + 1]); if (!high || !low) return false; buffer[i] = (*high << 4) | *low; } return true; } std::string HexEncode(const u8* buffer, size_t size) { std::string out(size * 2, '\0'); for (size_t i = 0; i < size; ++i) { out[2 * i] = "0123456789abcdef"[buffer[i] >> 4]; out[2 * i + 1] = "0123456789abcdef"[buffer[i] & 0xF]; } return out; } std::optional ParseManifest(const std::string& manifest) { Manifest parsed; size_t pos = 0; while (pos < manifest.size()) { size_t filename_end_pos = manifest.find('\t', pos); if (filename_end_pos == std::string::npos) { fprintf(log_fp, "Manifest entry %zu: could not find filename end.\n", parsed.entries.size()); return {}; } size_t hash_end_pos = manifest.find('\n', filename_end_pos); if (hash_end_pos == std::string::npos) { fprintf(log_fp, "Manifest entry %zu: could not find hash end.\n", parsed.entries.size()); return {}; } std::string filename = manifest.substr(pos, filename_end_pos - pos); std::string hash = manifest.substr(filename_end_pos + 1, hash_end_pos - filename_end_pos - 1); if (hash.size() != 32) { fprintf(log_fp, "Manifest entry %zu: invalid hash: \"%s\".\n", parsed.entries.size(), hash.c_str()); return {}; } Manifest::Hash decoded_hash; if (!HexDecode(hash, decoded_hash.data(), decoded_hash.size())) { fprintf(log_fp, "Manifest entry %zu: invalid hash: \"%s\".\n", parsed.entries.size(), hash.c_str()); return {}; } parsed.entries[filename] = decoded_hash; pos = hash_end_pos + 1; } return parsed; } // Not showing a progress bar here because this part is just too quick std::optional FetchAndParseManifest(const std::string& url) { Common::HttpRequest http; Common::HttpRequest::Response resp = http.Get(url); if (!resp) { fprintf(log_fp, "Manifest download failed.\n"); return {}; } std::string contents(reinterpret_cast(resp->data()), resp->size()); std::optional maybe_decompressed = GzipInflate(contents); if (!maybe_decompressed) return {}; std::string decompressed = std::move(*maybe_decompressed); // Split into manifest and signature. size_t boundary = decompressed.rfind("\n\n"); if (boundary == std::string::npos) { fprintf(log_fp, "No signature was found in manifest.\n"); return {}; } std::string signature_block = decompressed.substr(boundary + 2); // 2 for "\n\n". decompressed.resize(boundary + 1); // 1 to keep the final "\n". std::vector signatures = SplitString(signature_block, '\n'); bool found_valid_signature = false; for (const auto& signature : signatures) { if (VerifySignature(decompressed, signature)) { found_valid_signature = true; break; } } if (!found_valid_signature) { fprintf(log_fp, "Could not verify signature of the manifest.\n"); return {}; } return ParseManifest(decompressed); } // Represent the operations to be performed by the updater. struct TodoList { struct DownloadOp { Manifest::Filename filename; Manifest::Hash hash; }; std::vector to_download; struct UpdateOp { Manifest::Filename filename; std::optional old_hash; Manifest::Hash new_hash; }; std::vector to_update; struct DeleteOp { Manifest::Filename filename; Manifest::Hash old_hash; }; std::vector to_delete; void Log() const { if (to_update.size()) { fprintf(log_fp, "Updating:\n"); for (const auto& op : to_update) { std::string old_desc = op.old_hash ? HexEncode(op.old_hash->data(), op.old_hash->size()) : "(new)"; fprintf(log_fp, " - %s: %s -> %s\n", op.filename.c_str(), old_desc.c_str(), HexEncode(op.new_hash.data(), op.new_hash.size()).c_str()); } } if (to_delete.size()) { fprintf(log_fp, "Deleting:\n"); for (const auto& op : to_delete) { fprintf(log_fp, " - %s (%s)\n", op.filename.c_str(), HexEncode(op.old_hash.data(), op.old_hash.size()).c_str()); } } } }; TodoList ComputeActionsToDo(Manifest this_manifest, Manifest next_manifest) { TodoList todo; // Delete if present in this manifest but not in next manifest. for (const auto& entry : this_manifest.entries) { if (next_manifest.entries.find(entry.first) == next_manifest.entries.end()) { TodoList::DeleteOp del; del.filename = entry.first; del.old_hash = entry.second; todo.to_delete.push_back(std::move(del)); } } // Download and update if present in next manifest with different hash from this manifest. for (const auto& entry : next_manifest.entries) { std::optional old_hash; const auto& old_entry = this_manifest.entries.find(entry.first); if (old_entry != this_manifest.entries.end()) old_hash = old_entry->second; if (!old_hash || *old_hash != entry.second) { TodoList::DownloadOp download; download.filename = entry.first; download.hash = entry.second; todo.to_download.push_back(std::move(download)); TodoList::UpdateOp update; update.filename = entry.first; update.old_hash = old_hash; update.new_hash = entry.second; todo.to_update.push_back(std::move(update)); } } return todo; } std::optional FindOrCreateTempDir(const std::string& base_path) { std::string temp_path = base_path + DIR_SEP + UPDATE_TEMP_DIR; int counter = 0; do { if (!File::Exists(temp_path)) { if (File::CreateDir(temp_path)) return temp_path; else { fprintf(log_fp, "Couldn't create temp directory.\n"); return {}; } } else if (File::IsDirectory(temp_path)) { return temp_path; } else { // Try again with a counter appended to the path. std::string suffix = UPDATE_TEMP_DIR + std::to_string(counter); temp_path = base_path + DIR_SEP + suffix; } } while (counter++ < 10); fprintf(log_fp, "Could not find an appropriate temp directory name. Giving up.\n"); return {}; } void CleanUpTempDir(const std::string& temp_dir, const TodoList& todo) { // This is best-effort cleanup, we ignore most errors. for (const auto& download : todo.to_download) File::Delete(temp_dir + DIR_SEP + HexEncode(download.hash.data(), download.hash.size())); File::DeleteDir(temp_dir); } Manifest::Hash ComputeHash(const std::string& contents) { std::array full; mbedtls_sha256(reinterpret_cast(contents.data()), contents.size(), full.data(), false); Manifest::Hash out; std::copy(full.begin(), full.begin() + 16, out.begin()); return out; } bool ProgressCallback(double total, double now, double, double) { UI::SetProgress(static_cast(now), static_cast(total)); return true; } bool DownloadContent(const std::vector& to_download, const std::string& content_base_url, const std::string& temp_path) { Common::HttpRequest req(std::chrono::seconds(30), ProgressCallback); for (size_t i = 0; i < to_download.size(); i++) { auto& download = to_download[i]; std::string hash_filename = HexEncode(download.hash.data(), download.hash.size()); UI::SetDescription("Downloading " + download.filename + "... (File " + std::to_string(i + 1) + " of " + std::to_string(to_download.size()) + ")"); UI::SetMarquee(false); // Add slashes where needed. std::string content_store_path = hash_filename; content_store_path.insert(4, "/"); content_store_path.insert(2, "/"); std::string url = content_base_url + content_store_path; fprintf(log_fp, "Downloading %s ...\n", url.c_str()); auto resp = req.Get(url); if (!resp) return false; UI::SetMarquee(true); UI::SetDescription("Verifying " + download.filename + "..."); std::string contents(reinterpret_cast(resp->data()), resp->size()); std::optional maybe_decompressed = GzipInflate(contents); if (!maybe_decompressed) return false; std::string decompressed = std::move(*maybe_decompressed); // Check that the downloaded contents have the right hash. Manifest::Hash contents_hash = ComputeHash(decompressed); if (contents_hash != download.hash) { fprintf(log_fp, "Wrong hash on downloaded content %s.\n", url.c_str()); return false; } std::string out = temp_path + DIR_SEP + hash_filename; if (!File::WriteStringToFile(decompressed, out)) { fprintf(log_fp, "Could not write cache file %s.\n", out.c_str()); return false; } } return true; } bool BackupFile(const std::string& path) { std::string backup_path = path + ".bak"; fprintf(log_fp, "Backing up unknown pre-existing %s to .bak.\n", path.c_str()); if (!File::Rename(path, backup_path)) { fprintf(log_fp, "Cound not rename %s to %s for backup.\n", path.c_str(), backup_path.c_str()); return false; } return true; } bool UpdateFiles(const std::vector& to_update, const std::string& install_base_path, const std::string& temp_path) { for (const auto& op : to_update) { std::string path = install_base_path + DIR_SEP + op.filename; if (!File::CreateFullPath(path)) { fprintf(log_fp, "Could not create directory structure for %s.\n", op.filename.c_str()); return false; } if (File::Exists(path)) { std::string contents; if (!File::ReadFileToString(path, contents)) { fprintf(log_fp, "Could not read existing file %s.\n", op.filename.c_str()); return false; } Manifest::Hash contents_hash = ComputeHash(contents); if (contents_hash == op.new_hash) { fprintf(log_fp, "File %s was already up to date. Partial update?\n", op.filename.c_str()); continue; } else if (!op.old_hash || contents_hash != *op.old_hash) { if (!BackupFile(path)) return false; } } // Now we can safely move the new contents to the location. std::string content_filename = HexEncode(op.new_hash.data(), op.new_hash.size()); fprintf(log_fp, "Updating file %s from content %s...\n", op.filename.c_str(), content_filename.c_str()); if (!File::Copy(temp_path + DIR_SEP + content_filename, path)) { fprintf(log_fp, "Could not update file %s.\n", op.filename.c_str()); return false; } } return true; } bool DeleteObsoleteFiles(const std::vector& to_delete, const std::string& install_base_path) { for (const auto& op : to_delete) { std::string path = install_base_path + DIR_SEP + op.filename; if (!File::Exists(path)) { fprintf(log_fp, "File %s is already missing.\n", op.filename.c_str()); continue; } else { std::string contents; if (!File::ReadFileToString(path, contents)) { fprintf(log_fp, "Could not read file planned for deletion: %s.\n", op.filename.c_str()); return false; } Manifest::Hash contents_hash = ComputeHash(contents); if (contents_hash != op.old_hash) { if (!BackupFile(path)) return false; } File::Delete(path); } } return true; } bool PerformUpdate(const TodoList& todo, const std::string& install_base_path, const std::string& content_base_url, const std::string& temp_path) { fprintf(log_fp, "Starting download step...\n"); if (!DownloadContent(todo.to_download, content_base_url, temp_path)) return false; fprintf(log_fp, "Download step completed.\n"); fprintf(log_fp, "Starting update step...\n"); if (!UpdateFiles(todo.to_update, install_base_path, temp_path)) return false; fprintf(log_fp, "Update step completed.\n"); fprintf(log_fp, "Starting deletion step...\n"); if (!DeleteObsoleteFiles(todo.to_delete, install_base_path)) return false; fprintf(log_fp, "Deletion step completed.\n"); return true; } void FatalError(const std::string& message) { auto wide_message = UTF8ToUTF16(message); MessageBox(nullptr, (L"A fatal error occured and the updater cannot continue:\n " + wide_message).c_str(), L"Error", MB_ICONERROR); fprintf(log_fp, "%s\n", message.c_str()); UI::Stop(); } } // namespace int WINAPI wWinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, PWSTR pCmdLine, int nCmdShow) { std::optional maybe_opts = ParseCommandLine(pCmdLine); if (!maybe_opts) return 1; Options opts = std::move(*maybe_opts); bool need_admin = false; if (opts.log_file) { log_fp = _wfopen(UTF8ToUTF16(*opts.log_file).c_str(), L"w"); if (!log_fp) { log_fp = stderr; // Failing to create the logfile for writing is a good indicator that we need administrator // priviliges need_admin = true; } else atexit(FlushLog); } fprintf(log_fp, "Updating from: %s\n", opts.this_manifest_url.c_str()); fprintf(log_fp, "Updating to: %s\n", opts.next_manifest_url.c_str()); fprintf(log_fp, "Install path: %s\n", opts.install_base_path.c_str()); if (!File::IsDirectory(opts.install_base_path)) { FatalError("Cannot find install base path, or not a directory."); return 1; } if (opts.parent_pid) { fprintf(log_fp, "Waiting for parent PID %d to complete...\n", *opts.parent_pid); HANDLE parent_handle = OpenProcess(SYNCHRONIZE, FALSE, *opts.parent_pid); WaitForSingleObject(parent_handle, INFINITE); CloseHandle(parent_handle); fprintf(log_fp, "Completed! Proceeding with update.\n"); } if (need_admin) { if (IsUserAnAdmin()) { FatalError("Failed to write to directory despite administrator priviliges."); return 1; } wchar_t path[MAX_PATH]; if (GetModuleFileName(hInstance, path, sizeof(path)) == 0) { FatalError("Failed to get updater filename."); return 1; } // Relaunch the updater as administrator ShellExecuteW(nullptr, L"runas", path, pCmdLine, NULL, SW_SHOW); return 0; } std::thread thread(UI::MessageLoop); thread.detach(); UI::SetDescription("Fetching and parsing manifests..."); Manifest this_manifest, next_manifest; { std::optional maybe_manifest = FetchAndParseManifest(opts.this_manifest_url); if (!maybe_manifest) { FatalError("Could not fetch current manifest. Aborting."); return 1; } this_manifest = std::move(*maybe_manifest); maybe_manifest = FetchAndParseManifest(opts.next_manifest_url); if (!maybe_manifest) { FatalError("Could not fetch next manifest. Aborting."); return 1; } next_manifest = std::move(*maybe_manifest); } UI::SetDescription("Computing what to do..."); TodoList todo = ComputeActionsToDo(this_manifest, next_manifest); todo.Log(); std::optional maybe_temp_dir = FindOrCreateTempDir(opts.install_base_path); if (!maybe_temp_dir) return 1; std::string temp_dir = std::move(*maybe_temp_dir); UI::SetDescription("Performing Update..."); bool ok = PerformUpdate(todo, opts.install_base_path, opts.content_store_url, temp_dir); if (!ok) FatalError("Failed to apply the update."); CleanUpTempDir(temp_dir, todo); UI::ResetProgress(); UI::SetMarquee(false); UI::SetProgress(100, 100); UI::SetDescription("Done!"); // Let the user process that we are done. Sleep(1000); if (opts.binary_to_restart) { // Hack: Launching the updater over the explorer ensures that admin priviliges are dropped. Why? // Ask Microsoft. ShellExecuteW(nullptr, nullptr, L"explorer.exe", UTF8ToUTF16(*opts.binary_to_restart).c_str(), nullptr, SW_SHOW); } UI::Stop(); return !ok; }