vue-cli-plugin-electron-builder-notarize 1.0.0

package/entitlements.mac.inherit.plist

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>com.apple.security.cs.allow-jit</key>
+    <true/>
+    <key>com.apple.security.cs.allow-unsigned-executable-memory</key>
+    <true/>
+    <key>com.apple.security.cs.allow-dyld-environment-variables</key>
+    <true/>
+  </dict>
+</plist>

package/index.js

@@ -0,0 +1,101 @@
+'use strict';
+
+require('dotenv').config();
+
+const path = require('path');
+const fs = require('fs');
+const readPkgUp = require('read-pkg-up');
+const { notarize } = require('@electron/notarize');
+const yaml = require('js-yaml');
+const util = require('builder-util');
+const getAuthCreds = require('./validate');
+
+const isEnvTrue = value => {
+	if (value !== null) {
+		value = value.trim();
+	}
+
+	return value === 'true' || value === '' || value === '1';
+};
+
+const getAppId = params => {
+	const { packager, outDir } = params;
+
+	// Try getting appId from the packager object
+	const config = packager.info._configuration;
+	const appId = config && config.appId;
+
+	if (appId) {
+		return appId;
+	}
+
+	// Try getting appId from the `builder-effective-config.yml`
+	const effectiveConfigPath = path.join(outDir, 'builder-effective-config.yaml');
+	// This doesn't exist in CI
+	if (fs.existsSync(effectiveConfigPath)) {
+		const buildConfig = fs.readFileSync(effectiveConfigPath);
+		const { appId } = yaml.safeLoad(buildConfig);
+		return appId;
+	}
+
+	// Try getting appId from `package.json` or from an env var
+	const { packageJson } = readPkgUp.sync();
+	return (packageJson.build && packageJson.build.appId) || process.env.APP_ID;
+};
+
+module.exports = async params => {
+	if (params.electronPlatformName !== 'darwin') {
+		return;
+	}
+
+	// https://github.com/electron-userland/electron-builder/blob/c11fa1f1033aeb7c378856d7db93369282d363f5/packages/app-builder-lib/src/codeSign/macCodeSign.ts#L22-L49
+	if (util.isPullRequest()) {
+		if (!isEnvTrue(process.env.CSC_FOR_PULL_REQUEST)) {
+			console.log('Skipping notarizing, since app was not signed.');
+			return;
+		}
+	}
+
+	// Read and validate auth information from environment variables
+	let authInfo;
+	try {
+		authInfo = await getAuthCreds();
+	} catch (error) {
+		console.log(`Skipping notarization: ${error.message}`);
+		return;
+	}
+
+	const appId = getAppId(params);
+
+	if (!appId) {
+		throw new Error('`appId` was not found');
+	}
+
+	const appPath = path.join(params.appOutDir, `${params.packager.appInfo.productFilename}.app`);
+
+	const notarizeOptions = {
+		...authInfo,
+		appPath,
+		appBundleId: appId
+	};
+
+	console.log(`📦 Start notarizing ${appId} found at ${appPath}`);
+
+	try {
+		const res = await notarize(notarizeOptions);
+
+		if (!res) {
+			console.log(`🌟 Notarizing ${appId} successfully !`);
+		}
+	} catch (error) {
+		const error1048Str = 'You must first sign the relevant contracts online. (1048)';
+
+		if (String(error).includes(error1048Str)) {
+			throw new Error('📃 Error(1048): You must first sign the relevant contracts online');
+		}
+
+		fs.writeFileSync('notarization-error.log', error.message);
+
+		throw new Error('❌ Notarization Error,please check notarization-error.log');
+	}
+};

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) George Karagkiaouris <karaggeorge0@gmail.com> (gkaragkiaouris.tech)
+
+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.

package/package.json

@@ -0,0 +1,39 @@
+{
+	"name": "vue-cli-plugin-electron-builder-notarize",
+	"version": "1.0.0",
+	"description": "Notarize Electron applications using electron-builder",
+	"license": "MIT",
+	"repository": "https://github.com/hn-failte/electron-builder-notarize",
+	"author": {
+		"name": "George Karagkiaouris",
+		"email": "karaggeorge0@gmail.com",
+		"url": "https://gkaragkiaouris.tech"
+	},
+	"peerDependencies": {
+		"electron-builder": ">= 20.44.4"
+	},
+	"engines": {
+		"node": ">=8"
+	},
+	"scripts": {},
+	"files": [
+		"index.js",
+		"validate.js",
+		"entitlements.mac.inherit.plist"
+	],
+	"keywords": [
+		"electron",
+		"notarize",
+		"apple",
+		"id",
+		"builder"
+	],
+	"dependencies": {
+		"@electron/notarize": "^2.5.0",
+		"builder-util": "^22.10.5",
+		"dotenv": "^8.2.0",
+		"js-yaml": "^3.14.0",
+		"read-pkg-up": "^7.0.0"
+	},
+	"devDependencies": {}
+}

package/readme.md

@@ -0,0 +1,86 @@
+# electron-builder-notarize
+
+> Notarize Electron applications using electron-builder
+
+For more details regarding the options and functionality: https://github.com/electron/@electron/notarize
+
+## Install
+
+```
+# npm
+npm i electron-builder-notarize --save-dev
+
+# yarn
+yarn add electron-builder-notarize --dev
+```
+
+
+## Usage
+
+In your electron-builder config:
+
+```json
+{
+	...
+	"afterSign": "electron-builder-notarize",
+	"mac": {
+		...
+		"hardenedRuntime": true,
+		"entitlements": "./node_modules/electron-builder-notarize/entitlements.mac.inherit.plist",
+	}
+}
+```
+
+You can replace the entitlements file with your own, as long as those properties are included as well.
+
+You will also need to authenticate yourself, either with your Apple ID or using an API key. This is done by setting the corresponding environment variables.
+
+If for some reason the script can't locate your project's `appId`, you can specify it using the `APP_ID` environment variable.
+
+### Using `notarytool`
+
+In order to use `notarytool` for notarization, XCode 13 or later is required
+
+Authentication methods:
+- username and password
+  - `APPLE_ID` String - The username of your apple developer account
+  - `APPLE_ID_PASSWORD` String - The [app-specific password](https://support.apple.com/HT204397) (not your Apple ID password).
+  - `APPLE_TEAM_ID` String - The team ID you want to notarize under.
+- apiKey with apiIssuer:
+  - `APPLE_API_KEY` String - Required for JWT authentication. See Note on JWT authentication below.
+  - `APPLE_API_KEY_ID` String - Required for JWT authentication. See Note on JWT authentication below.
+  - `APPLE_API_KEY_ISSUER` String - Issuer ID. Required if `APPLE_API_KEY` is specified.
+- keychain with keychainProfile:
+  - `APPLE_KEYCHAIN` String - The name of the keychain or path to the keychain you stored notarization credentials in.
+  - `APPLE_KEYCHAIN_PROFILE` String - The name of the profile you provided when storing notarization credentials.
+
+### Using Legacy
+
+General options:
+- `TEAM_SHORT_NAME` String - Your [Team Short Name](#notes-on-your-team-short-name).
+
+Authentication methods:
+- username and password
+  - `APPLE_ID` String - The username of your apple developer account
+  - `APPLE_ID_PASSWORD` String - The [app-specific password](https://support.apple.com/HT204397) (not your Apple ID password).
+- apiKey with apiIssuer
+  - `APPLE_API_KEY` String - Required for JWT authentication. See Note on JWT authentication below.
+  - `APPLE_API_KEY_ISSUER` String - Issuer ID. Required if `APPLE_API_KEY` is specified.
+
+### Multiple Teams
+
+If your developer account is a member of multiple teams or organizations, you might see an error. In this case, you need to provide your [Team Short Name](https://github.com/electron/@electron/notarize#notes-on-your-team-short-name) as an environment variable:
+
+```sh
+export TEAM_SHORT_NAME=XXXXXXXXX
+```
+
+## Credits
+
+This package is inspired by this [article](https://medium.com/@TwitterArchiveEraser/notarize-electron-apps-7a5f988406db)
+
+The library used for notarization: https://github.com/electron/@electron/notarize
+
+## License
+
+MIT

package/validate.js

@@ -0,0 +1,66 @@
+const { isNotaryToolAvailable } = require('@electron/notarize/lib/notarytool');
+const {
+	validateNotaryToolAuthorizationArgs,
+	validateLegacyAuthorizationArgs
+} = require('@electron/notarize/lib/validate-args');
+
+function getAuthInfo() {
+	const {
+		APPLE_ID: appleId,
+		APPLE_ID_PASSWORD: appleIdPassword,
+		APPLE_API_KEY: appleApiKey,
+		APPLE_API_KEY_ID: appleApiKeyId,
+		APPLE_API_ISSUER: appleApiIssuer,
+		API_KEY_ID: legacyApiKey,
+		API_KEY_ISSUER_ID: legacyApiIssuer,
+		TEAM_SHORT_NAME: teamShortName,
+		APPLE_TEAM_ID: teamId,
+		APPLE_KEYCHAIN: keychain,
+		APPLE_KEYCHAIN_PROFILE: keychainProfile
+	} = process.env;
+
+	return {
+		appleId,
+		appleIdPassword,
+		appleApiKey,
+		appleApiKeyId,
+		appleApiIssuer,
+		teamShortName,
+		teamId,
+		keychain,
+		keychainProfile,
+		legacyApiIssuer,
+		legacyApiKey
+	};
+}
+
+module.exports = async () => {
+	const options = getAuthInfo();
+
+	if (!options.legacyApiIssuer && !options.legacyApiKey && await isNotaryToolAvailable()) {
+		try {
+			const creds = validateNotaryToolAuthorizationArgs(options);
+			return {
+				...creds,
+				tool: 'notarytool'
+			};
+		} catch (e) {
+			console.error(e);
+		}
+	} else {
+		console.log('notarytool not found, trying legacy.');
+	}
+
+	const creds = validateLegacyAuthorizationArgs({
+		...options,
+		// Backwards compatibility
+		appleApiKey: options.appleApiKey || options.legacyApiKey,
+		appleApiIssuer: options.appleApiIssuer || options.legacyApiIssuer
+	});
+
+	return {
+		...creds,
+		tool: 'legacy',
+		ascProvider: options.teamShortName
+	};
+};