Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@bithighlander/electron-builder-notarize

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@bithighlander/electron-builder-notarize

Notarize Electron applications using electron-builder

  • 0.0.12
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

electron-builder-notarize Build Status

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:

{
	...
	"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 (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:

Authentication methods:

  • username and password
    • APPLE_ID String - The username of your apple developer account
    • APPLE_ID_PASSWORD String - The app-specific password (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 as an environment variable:

export TEAM_SHORT_NAME=XXXXXXXXX

Credits

This package is inspired by this article

The library used for notarization: https://github.com/electron/electron-notarize

License

MIT

Keywords

FAQs

Package last updated on 16 Apr 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc