diff --git a/src/server_manager/electron_app/windows/digicert-usb-config/eToken-macos.cfg b/src/server_manager/electron_app/windows/digicert-usb-config/eToken-macos.cfg new file mode 100644 index 00000000..a86a344c --- /dev/null +++ b/src/server_manager/electron_app/windows/digicert-usb-config/eToken-macos.cfg @@ -0,0 +1,3 @@ +name=eToken +description=SunPKCS11 via Digicert SafeNet Authentication Client +library=/usr/local/lib/libeTPkcs11.dylib diff --git a/src/server_manager/electron_app/windows/digicert-usb-config/eToken-windows.cfg b/src/server_manager/electron_app/windows/digicert-usb-config/eToken-windows.cfg new file mode 100644 index 00000000..1239d160 --- /dev/null +++ b/src/server_manager/electron_app/windows/digicert-usb-config/eToken-windows.cfg @@ -0,0 +1,3 @@ +name=eToken +description=SunPKCS11 via Digicert SafeNet Authentication Client +library=c:\WINDOWS\system32\eTPKCS11.dll diff --git a/src/server_manager/electron_app/windows/electron_builder_signing_plugin.cjs b/src/server_manager/electron_app/windows/electron_builder_signing_plugin.cjs new file mode 100644 index 00000000..fd290251 --- /dev/null +++ b/src/server_manager/electron_app/windows/electron_builder_signing_plugin.cjs @@ -0,0 +1,29 @@ +// Copyright 2022 The Outline Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/** + * The entry point which will be called by electron-builder signing module. + * @param {Object} configuration a configuration containing signing information + * @param {string} configuration.path the executable file path to be signed + * @param {'sha1'|'sha256'} configuration.hash requested hash algorithm + * @param {boolean} configuration.isNest whether it is a secondary signature + * @param {Object} configuration.options a duplication of electron-builder.json + */ +async function electronBuilderEntryPoint(configuration) { + // CommonJS module is required, ES6 module is not supported by electron-builder + const {signWindowsExecutable} = await import('./sign_windows_executable.mjs'); + await signWindowsExecutable(configuration.path, configuration.hash, null); +} + +exports.default = electronBuilderEntryPoint; diff --git a/src/server_manager/electron_app/windows/sign_windows_executable.mjs b/src/server_manager/electron_app/windows/sign_windows_executable.mjs new file mode 100644 index 00000000..a3d04cb6 --- /dev/null +++ b/src/server_manager/electron_app/windows/sign_windows_executable.mjs @@ -0,0 +1,211 @@ +// Copyright 2022 The Outline Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import {spawn} from 'child_process'; +import {constants} from 'fs'; +import {access} from 'fs/promises'; +import minimist from 'minimist'; +import {dirname, resolve} from 'path'; +import {fileURLToPath, pathToFileURL} from 'url'; +import {format} from 'util'; + +/** + * Get the parent folder path of this script. + * @returns the folder path containing the current script. + */ +function currentDirname() { + return dirname(fileURLToPath(import.meta.url)); +} + +/** + * Get the outline-server root folder path. + * @returns the folder path of outline-client root. + */ +function outlineDirname() { + return resolve(currentDirname(), '..', '..', '..', '..'); +} + +function assert(condition, msg) { + if (!condition) { + throw new Error(msg); + } +} + +async function assertFileExists(file, msg) { + try { + await access(file, constants.R_OK | constants.W_OK); + } catch (err) { + throw new Error(format(msg, file), {cause: err}); + } +} + +/** + * Get the required option value from either cliValue or environment variable. + * @param {object} options the CLI options object. + * @param {string} argName the CLI argument name. + * @param {string} envName the environment variable name for this option. + * @param {boolean} required indicates whether this option is required. + * @returns {string} the value of the option + */ +function getOptionValue(options, argName, envName, required) { + const cliValue = options ? options[argName] : null; + const v = cliValue ?? process.env[envName]; + if (required) { + assert(!!v, `either --${argName} or ${envName} is required`); + } + return v; +} + +function appendPfxJsignArgs(args, options) { + // self-signed development certificate + args.push('--storetype', 'PKCS12'); + + const pfxCert = getOptionValue(options, 'pfx', 'WINDOWS_SIGNING_PFX_CERT', true); + args.push('--keystore', pfxCert); +} + +function appendDigicertUsbJsignArgs(args, options) { + // extended validation certificate stored in USB drive + args.push('--storetype', 'PKCS11'); + + const subject = getOptionValue(options, 'subject', 'WINDOWS_SIGNING_EV_CERT_SUBJECT', false); + if (subject) { + args.push('--alias', subject); + } + + var eTokenCfg; + switch (process.platform) { + case 'win32': + eTokenCfg = resolve(currentDirname(), 'digicert-usb-config', 'eToken-windows.cfg'); + break; + case 'darwin': + eTokenCfg = resolve(currentDirname(), 'digicert-usb-config', 'eToken-macos.cfg'); + break; + default: + throw new Error(`we do not support ev signing on ${process.platform}`); + } + args.push('--keystore', eTokenCfg); +} + +/** + * Run jsign.jar according to the corresponding options targeting fileToSign. + * @param {string} fileToSign The path string of a file to be signed. + * @param {string[]} options The options to be passed to jsign. see https://ebourg.github.io/jsign/ + * @returns {Promise} A promise containing the exit code of jsign. + */ +function jsign(fileToSign, options) { + if (!options) { + throw new Error('options are required by jsign'); + } + if (!fileToSign) { + throw new Error('fileToSign is required by jsign'); + } + + const jSignJarPath = resolve(outlineDirname(), 'third_party', 'jsign', 'jsign-4.0.jar'); + const jsignProc = spawn('java', ['-jar', jSignJarPath, ...options, fileToSign], { + stdio: 'inherit', + }); + return new Promise((resolve, reject) => { + jsignProc.on('error', reject); + jsignProc.on('exit', resolve); + }); +} + +/** + * Sign the target exeFile using a specific algorithm and options. + * @param {string} exeFile the full path of the exe file to be signed. + * @param {'sha1'|'sha256'} algorithm the algorithm used for signing. + * @param {object} options additional options (cli arguments) for signing. + * the options will also be read from environment + * variables. + */ +export async function signWindowsExecutable(exeFile, algorithm, options) { + const type = getOptionValue(options, 'certtype', 'WINDOWS_SIGNING_CERT_TYPE', false); + if (!type || type === 'none') { + console.info(`skip signing "${exeFile}"`); + return; + } + + assert(!!exeFile, 'executable path is required'); + assert(algorithm === 'sha1' || algorithm === 'sha256', 'hashing algorithm must be either "sha1" or "sha256"'); + + exeFile = resolve(exeFile); + await assertFileExists(exeFile, 'executable file "%s" does not exist'); + + const password = getOptionValue(options, 'password', 'WINDOWS_SIGNING_CERT_PASSWORD', true); + + const jsignArgs = [ + '--alg', + algorithm === 'sha256' ? 'SHA-256' : 'SHA-1', + '--tsaurl', + 'http://timestamp.digicert.com', + '--storepass', + password, + ]; + + switch (type) { + case 'pfx': + appendPfxJsignArgs(jsignArgs, options); + break; + case 'digicert-usb': + appendDigicertUsbJsignArgs(jsignArgs, options); + break; + default: + throw new Error(`cert type ${type} is not supported`); + } + + var exitCode; + try { + exitCode = await jsign(exeFile, jsignArgs); + } catch (err) { + console.error('failed to start java, please make sure you have installed java'); + throw new Error(err); + } + + if (exitCode === 0) { + console.info(`successfully signed "${exeFile}"`); + } else { + console.error(`jsign exited with error code ${exitCode}`); + throw new Error(`failed to sign "${exeFile}"`); + } +} + +async function main() { + const {target, algorithm, ...options} = minimist(process.argv); + await signWindowsExecutable(target, algorithm, options); +} + +// Call this script through CLI to sign a Windows executable: +// node sign_windows_executable.mjs +// --target +// --algorithm +// --certtype +// --password +// The following options are for --certtype == pfx +// --pfx +// The following options are for --certtype == digicert-usb +// [--subject ] +// +// You can also use environment variables to specify some arguments: +// WINDOWS_SIGNING_CERT_TYPE <=> --certtype +// WINDOWS_SIGNING_CERT_PASSWORD <=> --password +// WINDOWS_SIGNING_PFX_CERT <=> --pfx +// WINDOWS_SIGNING_EV_CERT_SUBJECT <=> --subject +if (import.meta.url === pathToFileURL(process.argv[1]).href) { + try { + await main(); + } catch (err) { + console.error(err); + } +} diff --git a/src/server_manager/scripts/get_electron_build_flags.mjs b/src/server_manager/scripts/get_electron_build_flags.mjs index eaba0b93..a61224e3 100644 --- a/src/server_manager/scripts/get_electron_build_flags.mjs +++ b/src/server_manager/scripts/get_electron_build_flags.mjs @@ -32,7 +32,11 @@ export async function getElectronBuildFlags(platform, buildMode) { ]; break; case 'windows': - buildFlags = ['--win', '--ia32', '--config.win.icon=icons/win/icon.ico', ...buildFlags]; + buildFlags = [ + '--win', '--ia32', + '--config.win.icon=icons/win/icon.ico', + '--config.win.sign=src/server_manager/electron_app/windows/electron_builder_signing_plugin.cjs', + ...buildFlags]; break; case 'macos': buildFlags = ['--mac', '--config.mac.icon=icons/mac/icon.icns', ...buildFlags]; @@ -50,10 +54,6 @@ export async function getElectronBuildFlags(platform, buildMode) { ]; } - if (buildMode === 'release' && platform === 'windows') { - buildFlags.push("--config.win.certificateSubjectName='Jigsaw Operations LLC'"); - } - return buildFlags; } diff --git a/third_party/jsign/LICENSE.txt b/third_party/jsign/LICENSE.txt new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/third_party/jsign/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/third_party/jsign/METADATA b/third_party/jsign/METADATA new file mode 100644 index 00000000..8208b000 --- /dev/null +++ b/third_party/jsign/METADATA @@ -0,0 +1,17 @@ +name: "Jsign" +description: + "Java implementation of Microsoft Authenticode for signing Windows " + "executable files, installers and scripts." + +third_party { + url { + type: HOMEPAGE + value: "https://ebourg.github.io/jsign/" + } + url { + type: GIT + value: "https://github.com/ebourg/jsign" + } + version: "4.0" + last_upgrade_date { year: 2022 month: 5 day: 27 } +} diff --git a/third_party/jsign/jsign-4.0.jar b/third_party/jsign/jsign-4.0.jar new file mode 100644 index 00000000..f31f7107 Binary files /dev/null and b/third_party/jsign/jsign-4.0.jar differ