Make Windows builds using a new ssl.com code signing certificate #3050
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,9 +8,13 @@ inputs: | |
| required: true | ||
|
|
||
| # Windows Inputs | ||
| ssl_com_username: | ||
| required: true | ||
| ssl_com_password: | ||
| required: true | ||
| ssl_com_totp_secret: | ||
| required: true | ||
| ssl_com_credential_id: | ||
| required: true | ||
|
|
||
| # Mac Inputs | ||
|
|
@@ -47,16 +51,45 @@ runs: | |
| security find-identity -p codesigning -v | ||
| shell: bash | ||
|
|
||
| - name: Checkout esigner-codesign repository | ||
| if: runner.os == 'Windows' | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| repository: 'SSLcom/esigner-codesign' | ||
| path: esigner-codesign | ||
|
|
||
| - name: Make values from package.json available in Actions steps | ||
| id: zui-package | ||
| uses: RadovanPelka/github-action-json@v1.0.1 | ||
| with: | ||
| path: apps/zui/package.json | ||
|
|
||
| - name: Build & Publish | ||
| run: ${{ inputs.cmd }} | ||
| shell: bash | ||
| env: | ||
| GH_TOKEN: ${{ inputs.gh_token }} | ||
| APPLE_ID: ${{ inputs.apple_id }} | ||
| APPLE_ID_PASSWORD: ${{ inputs.apple_id_password }} | ||
| APPLE_TEAM_ID: ${{ inputs.apple_team_id }} | ||
| CODE_SIGN_SCRIPT_PATH: ${{ github.workspace }}/esigner-codesign/dist/index.js | ||
| INPUT_COMMAND: sign | ||
| INPUT_FILE_PATH: ${{ github.workspace }}/dist/apps/zui/${{ fromJSON(steps.zui-package.outputs.productName) }} Setup ${{ fromJSON(steps.zui-package.outputs.version) }}.exe | ||
|
There was a problem hiding this comment. The |
||
| INPUT_OVERRIDE: true | ||
| INPUT_MALWARE_BLOCK: false | ||
| INPUT_CLEAN_LOGS: false | ||
| INPUT_JVM_MAX_MEMORY: 1024M | ||
| INPUT_ENVIRONMENT_NAME: PROD | ||
| INPUT_USERNAME: ${{ inputs.ssl_com_username }} | ||
| INPUT_PASSWORD: ${{ inputs.ssl_com_password }} | ||
| INPUT_TOTP_SECRET: ${{ inputs.ssl_com_totp_secret }} | ||
| INPUT_CREDENTIAL_ID: ${{ inputs.ssl_com_credential_id }} | ||
|
|
||
| - name: Check for successful signing with SignTool | ||
| if: runner.os == 'Windows' | ||
| run: | | ||
| "C:\Program Files (x86)\Microsoft SDKs\ClickOnce\SignTool\signtool.exe" verify /pa "${{ github.workspace }}/dist/apps/zui/${{ fromJSON(steps.zui-package.outputs.productName) }} Setup ${{ fromJSON(steps.zui-package.outputs.version) }}.exe" | ||
| shell: cmd | ||
|
There was a problem hiding this comment. While getting the esigner tool working with electron-builder, one buggy-seeming thing I encountered is that even if the custom signing code returns This would have made it likely that we could one day be producing unsigned builds and not be aware. I found via web searches that this |
||
|
|
||
| - name: Check notorization with gatekeeper | ||
| if: runner.os == 'macOS' | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| const { execSync } = require('child_process'); | ||
| const zuiPackage = require('./package.json') | ||
|
|
||
| const config = { | ||
| appId: "io.brimdata.zui", | ||
| asar: true, | ||
| asarUnpack: ["zdeps", "LICENSE.txt", "acknowledgments.txt", "**/*.node"], | ||
| directories: {output: "../../dist/apps/zui"}, | ||
| protocols: [{name: "zui", "schemes": ["zui"]}], | ||
| win: {target: ["nsis"]}, | ||
| linux: {target: ["deb", "rpm"]}, | ||
| rpm: {depends: ["openssl"]}, | ||
| deb: {depends: ["openssl"]}, | ||
| nsis: {oneClick: false, perMachine: false}, | ||
| forceCodeSigning: true, | ||
| afterSign: "electron-builder-notarize", | ||
| publish: { | ||
| provider: "github" | ||
| }, | ||
| files: [ | ||
| "dist/**", | ||
| "out/**", | ||
| "build/**", | ||
| "zdeps/**", | ||
| "LICENSE.txt", | ||
| "acknowledgments.txt", | ||
| "package.json" | ||
| ], | ||
| } | ||
|
|
||
| // Code below for code signing with SSL.com cert in electron-builder via GitHub | ||
| // Actions taken from: | ||
| // https://github.com/electron-userland/electron-builder/issues/6158#issuecomment-1994110062 | ||
| if (process.env.CODE_SIGN_SCRIPT_PATH) { | ||
| const version = zuiPackage.version; | ||
|
There was a problem hiding this comment. The code I borrowed from the GitHub issue was doing this via: I don't know why he didn't opt to just |
||
| const productName = zuiPackage.productName; | ||
| const versionedExe = `${productName} Setup ${version}.exe`; | ||
|
|
||
| config.win.sign = (configuration) => { | ||
| console.log("Requested signing for ", configuration.path); | ||
|
|
||
| // Only proceed if the versioned exe file is in the configuration path - skip signing everything else | ||
| if (!configuration.path.includes(versionedExe)) { | ||
| console.log("Configuration path does not include the versioned exe, signing skipped."); | ||
| return true; | ||
| } | ||
|
|
||
| const scriptPath = process.env.CODE_SIGN_SCRIPT_PATH; | ||
|
|
||
| try { | ||
| // Execute the sign script synchronously | ||
| const output = execSync(`node "${scriptPath}"`).toString(); | ||
| console.log(`Script output: ${output}`); | ||
| } catch (error) { | ||
| console.error(`Error executing script: ${error.message}`); | ||
| if (error.stdout) { | ||
| console.log(`Script stdout: ${error.stdout.toString()}`); | ||
| } | ||
| if (error.stderr) { | ||
| console.error(`Script stderr: ${error.stderr.toString()}`); | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| return true; // Return true at the end of successful signing | ||
| }; | ||
|
|
||
| // Sign only for Windows 10 and above | ||
| config.win.signingHashAlgorithms = ["sha256"]; | ||
|
|
||
| } | ||
|
|
||
| module.exports = config; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| const config = { | ||
| extends: "./electron-builder-config.js", | ||
| appId: "io.brimdata.zui-insiders", | ||
| mac: { | ||
| icon: "build/insiders/icon.icns" | ||
| }, | ||
| win: { | ||
| icon: "build/insiders/icon.ico" | ||
| }, | ||
| publish: { | ||
| provider: "github", | ||
| releaseType: "release" | ||
| } | ||
| } | ||
|
|
||
| module.exports = config; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added this because one of the env variables to be passed to the esigner tool is the expected filename of what would be signed, and that filename includes both the app name (
ZuiorZui Insiders) and the version string, both of which are inpackage.json.