From 6aa85c0c5c2f873ce6b52bb0daac4e48f4ed680b Mon Sep 17 00:00:00 2001 From: Zhuo Lu Date: Fri, 2 Jun 2017 02:22:31 +0800 Subject: [PATCH] Document identity validation flag --- README.md | 18 +++++++++++++----- bin/electron-osx-flat-usage.txt | 3 +++ bin/electron-osx-sign-usage.txt | 9 ++++++--- 3 files changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ab1989b..7f0a03d 100644 --- a/README.md +++ b/README.md @@ -152,7 +152,7 @@ See [default.entitlements.mas.inherit.plist](https://github.com/electron-userlan `gatekeeper-assess` - *Boolean* -Flag to enable Gatekeeper assessment after signing the app. Disabling it is useful for signing with self-signed certificates. +Flag to enable/disable Gatekeeper assessment after signing the app. Disabling it is useful for signing with self-signed certificates. Gatekeeper assessment is enabled by default on `darwin` platform. Default to `true`. @@ -163,6 +163,11 @@ Default to be selected with respect to `provisioning-profile` and `platform` fro Signing platform `mas` will look for `3rd Party Mac Developer Application: * (*)`, and platform `darwin` will look for `Developer ID Application: * (*)` by default. +`identity-validation` - *Boolean* + +Flag to enable/disable validation for the signing identity. If enabled, the `identity` provided will be validated in the `keychain` specified. +Default to `true`. + `keychain` - *String* The keychain name. @@ -181,14 +186,12 @@ Default to auto detect by presence of `Squirrel.framework` within the applicatio `pre-auto-entitlements` - *Boolean* -Flag to enable automation of `com.apple.security.application-groups` in entitlements file and update `Info.plist` with `ElectronTeamID`. -Allowed values: `true`, `false`. +Flag to enable/disable automation of `com.apple.security.application-groups` in entitlements file and update `Info.plist` with `ElectronTeamID`. Default to `true`. `pre-embed-provisioning-profile` - *Boolean* -Flag to enable embedding of provisioning profile in the current working directory. -Allowed values: `true`, `false`. +Flag to enable/disable embedding of provisioning profile in the current working directory. Default to `true`. `provisioning-profile` - *String* @@ -304,6 +307,11 @@ Default to be selected with respect to `platform` from `keychain` or keychain by Flattening platform `mas` will look for `3rd Party Mac Developer Installer: * (*)`, and platform `darwin` will look for `Developer ID Installer: * (*)` by default. +`identity-validation` - *Boolean* + +Flag to enable/disable validation for signing identity. If enabled, the `identity` provided will be validated in the `keychain` specified. +Default to `true`. + `install` - *String* Path to install the bundle. diff --git a/bin/electron-osx-flat-usage.txt b/bin/electron-osx-flat-usage.txt index 96dcddd..e9071ff 100644 --- a/bin/electron-osx-flat-usage.txt +++ b/bin/electron-osx-flat-usage.txt @@ -17,6 +17,9 @@ DESCRIPTION Name of certificate to use when signing. Default to selected with respect to --platform from --keychain specified or keychain by system default. + --identity-validation, --no-identity-validation + Flag to enable/disable validation for the signing identity. + --install=install-path Path to install the bundle. Default to ``/Applications''. diff --git a/bin/electron-osx-sign-usage.txt b/bin/electron-osx-sign-usage.txt index b8e8e9c..dae0bdd 100644 --- a/bin/electron-osx-sign-usage.txt +++ b/bin/electron-osx-sign-usage.txt @@ -22,7 +22,7 @@ DESCRIPTION This option only applies when signing with entitlements. --gatekeeper-assess, --no-gatekeeper-assess - Flag to enable Gatekeeper assessment after signing the app. Disabling it is useful for signing with self-signed certificates. + Flag to enable/disable Gatekeeper assessment after signing the app. Disabling it is useful for signing with self-signed certificates. Gatekeeper assessment is enabled by default on ``darwin'' platform. --help @@ -32,6 +32,9 @@ DESCRIPTION Name of certificate to use when signing. Default to selected with respect to --provisioning-profile and --platform from --keychain specified or keychain by system default. + --identity-validation, --no-identity-validation + Flag to enable/disable validation for the signing identity. + --ignore=regex Regex that signals ignoring a file before signing. @@ -45,10 +48,10 @@ DESCRIPTION Default to auto detect from application bundle. --pre-auto-entitlements, --no-pre-auto-entitlements - Flag to enable automation of entitlements file and Info.plist. + Flag to enable/disable automation of entitlements file and Info.plist. --pre-embed-provisioning-profile, --no-pre-embed-provisioning-profile - Flag to enable embedding of provisioning profile. + Flag to enable/disable embedding of provisioning profile. --provisioning-profile=file Path to provisioning profile.