/*************************************************************************/ /* export_plugin.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* "Software"), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /*************************************************************************/ #include "export_plugin.h" Error EditorExportPlatformWindows::sign_shared_object(const Ref &p_preset, bool p_debug, const String &p_path) { if (p_preset->get("codesign/enable")) { return _code_sign(p_preset, p_path); } else { return OK; } } Error EditorExportPlatformWindows::export_project(const Ref &p_preset, bool p_debug, const String &p_path, int p_flags) { Error err = EditorExportPlatformPC::export_project(p_preset, p_debug, p_path, p_flags); if (err != OK) { return err; } _rcedit_add_data(p_preset, p_path); if (p_preset->get("codesign/enable") && err == OK) { err = _code_sign(p_preset, p_path); } return err; } bool EditorExportPlatformWindows::get_export_option_visibility(const String &p_option, const Map &p_options) const { // This option is not supported by "osslsigncode", used on non-Windows host. if (!OS::get_singleton()->has_feature("windows") && p_option == "codesign/identity_type") { return false; } return true; } void EditorExportPlatformWindows::get_export_options(List *r_options) { EditorExportPlatformPC::get_export_options(r_options); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/enable"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/identity_type", PROPERTY_HINT_ENUM, "Select automatically,Use PKCS12 file (specify *.PFX/*.P12 file),Use certificate store (specify SHA1 hash)"), 0)); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/identity", PROPERTY_HINT_GLOBAL_FILE, "*.pfx,*.p12"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/password"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/timestamp"), true)); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/timestamp_server_url"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/digest_algorithm", PROPERTY_HINT_ENUM, "SHA1,SHA256"), 1)); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/description"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::PACKED_STRING_ARRAY, "codesign/custom_options"), PackedStringArray())); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/icon", PROPERTY_HINT_FILE, "*.ico"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/file_version", PROPERTY_HINT_PLACEHOLDER_TEXT, "1.0.0"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/product_version", PROPERTY_HINT_PLACEHOLDER_TEXT, "1.0.0"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/company_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Company Name"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/product_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game Name"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/file_description"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/copyright"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/trademarks"), "")); } void EditorExportPlatformWindows::_rcedit_add_data(const Ref &p_preset, const String &p_path) { String rcedit_path = EditorSettings::get_singleton()->get("export/windows/rcedit"); if (rcedit_path.is_empty()) { return; } if (!FileAccess::exists(rcedit_path)) { ERR_PRINT("Could not find rcedit executable at " + rcedit_path + ", no icon or app information data will be included."); return; } #ifndef WINDOWS_ENABLED // On non-Windows we need WINE to run rcedit String wine_path = EditorSettings::get_singleton()->get("export/windows/wine"); if (!wine_path.is_empty() && !FileAccess::exists(wine_path)) { ERR_PRINT("Could not find wine executable at " + wine_path + ", no icon or app information data will be included."); return; } if (wine_path.is_empty()) { wine_path = "wine"; // try to run wine from PATH } #endif String icon_path = ProjectSettings::get_singleton()->globalize_path(p_preset->get("application/icon")); String file_verion = p_preset->get("application/file_version"); String product_version = p_preset->get("application/product_version"); String company_name = p_preset->get("application/company_name"); String product_name = p_preset->get("application/product_name"); String file_description = p_preset->get("application/file_description"); String copyright = p_preset->get("application/copyright"); String trademarks = p_preset->get("application/trademarks"); String comments = p_preset->get("application/comments"); List args; args.push_back(p_path); if (!icon_path.is_empty()) { args.push_back("--set-icon"); args.push_back(icon_path); } if (!file_verion.is_empty()) { args.push_back("--set-file-version"); args.push_back(file_verion); } if (!product_version.is_empty()) { args.push_back("--set-product-version"); args.push_back(product_version); } if (!company_name.is_empty()) { args.push_back("--set-version-string"); args.push_back("CompanyName"); args.push_back(company_name); } if (!product_name.is_empty()) { args.push_back("--set-version-string"); args.push_back("ProductName"); args.push_back(product_name); } if (!file_description.is_empty()) { args.push_back("--set-version-string"); args.push_back("FileDescription"); args.push_back(file_description); } if (!copyright.is_empty()) { args.push_back("--set-version-string"); args.push_back("LegalCopyright"); args.push_back(copyright); } if (!trademarks.is_empty()) { args.push_back("--set-version-string"); args.push_back("LegalTrademarks"); args.push_back(trademarks); } #ifdef WINDOWS_ENABLED OS::get_singleton()->execute(rcedit_path, args); #else // On non-Windows we need WINE to run rcedit args.push_front(rcedit_path); OS::get_singleton()->execute(wine_path, args); #endif } Error EditorExportPlatformWindows::_code_sign(const Ref &p_preset, const String &p_path) { List args; #ifdef WINDOWS_ENABLED String signtool_path = EditorSettings::get_singleton()->get("export/windows/signtool"); if (!signtool_path.is_empty() && !FileAccess::exists(signtool_path)) { ERR_PRINT("Could not find signtool executable at " + signtool_path + ", aborting."); return ERR_FILE_NOT_FOUND; } if (signtool_path.is_empty()) { signtool_path = "signtool"; // try to run signtool from PATH } #else String signtool_path = EditorSettings::get_singleton()->get("export/windows/osslsigncode"); if (!signtool_path.is_empty() && !FileAccess::exists(signtool_path)) { ERR_PRINT("Could not find osslsigncode executable at " + signtool_path + ", aborting."); return ERR_FILE_NOT_FOUND; } if (signtool_path.is_empty()) { signtool_path = "osslsigncode"; // try to run signtool from PATH } #endif args.push_back("sign"); //identity #ifdef WINDOWS_ENABLED int id_type = p_preset->get("codesign/identity_type"); if (id_type == 0) { //auto select args.push_back("/a"); } else if (id_type == 1) { //pkcs12 if (p_preset->get("codesign/identity") != "") { args.push_back("/f"); args.push_back(p_preset->get("codesign/identity")); } else { EditorNode::add_io_error("codesign: no identity found"); return FAILED; } } else if (id_type == 2) { //Windows certificate store if (p_preset->get("codesign/identity") != "") { args.push_back("/sha1"); args.push_back(p_preset->get("codesign/identity")); } else { EditorNode::add_io_error("codesign: no identity found"); return FAILED; } } else { EditorNode::add_io_error("codesign: invalid identity type"); return FAILED; } #else if (p_preset->get("codesign/identity") != "") { args.push_back("-pkcs12"); args.push_back(p_preset->get("codesign/identity")); } else { EditorNode::add_io_error("codesign: no identity found"); return FAILED; } #endif //password if (p_preset->get("codesign/password") != "") { #ifdef WINDOWS_ENABLED args.push_back("/p"); #else args.push_back("-pass"); #endif args.push_back(p_preset->get("codesign/password")); } //timestamp if (p_preset->get("codesign/timestamp")) { if (p_preset->get("codesign/timestamp_server") != "") { #ifdef WINDOWS_ENABLED args.push_back("/tr"); args.push_back(p_preset->get("codesign/timestamp_server_url")); args.push_back("/td"); if ((int)p_preset->get("codesign/digest_algorithm") == 0) { args.push_back("sha1"); } else { args.push_back("sha256"); } #else args.push_back("-ts"); args.push_back(p_preset->get("codesign/timestamp_server_url")); #endif } else { EditorNode::add_io_error("codesign: invalid timestamp server"); return FAILED; } } //digest #ifdef WINDOWS_ENABLED args.push_back("/fd"); #else args.push_back("-h"); #endif if ((int)p_preset->get("codesign/digest_algorithm") == 0) { args.push_back("sha1"); } else { args.push_back("sha256"); } //description if (p_preset->get("codesign/description") != "") { #ifdef WINDOWS_ENABLED args.push_back("/d"); #else args.push_back("-n"); #endif args.push_back(p_preset->get("codesign/description")); } //user options PackedStringArray user_args = p_preset->get("codesign/custom_options"); for (int i = 0; i < user_args.size(); i++) { String user_arg = user_args[i].strip_edges(); if (!user_arg.is_empty()) { args.push_back(user_arg); } } #ifndef WINDOWS_ENABLED args.push_back("-in"); #endif args.push_back(p_path); #ifndef WINDOWS_ENABLED args.push_back("-out"); args.push_back(p_path + "_signed"); #endif String str; Error err = OS::get_singleton()->execute(signtool_path, args, &str, nullptr, true); ERR_FAIL_COND_V(err != OK, err); print_line("codesign (" + p_path + "): " + str); #ifndef WINDOWS_ENABLED if (str.find("SignTool Error") != -1) { #else if (str.find("Failed") != -1) { #endif return FAILED; } #ifndef WINDOWS_ENABLED DirAccessRef tmp_dir = DirAccess::create_for_path(p_path.get_base_dir()); err = tmp_dir->remove(p_path); ERR_FAIL_COND_V(err != OK, err); err = tmp_dir->rename(p_path + "_signed", p_path); ERR_FAIL_COND_V(err != OK, err); #endif return OK; }