Optional Parameters

<gpgArguments>
  <arg>--no-random-seed-file</arg>
  <arg>--no-permission-warning</arg>
</gpgArguments>
<homedir>
GPG Signer only: The directory from which gpg will load keyrings. If not specified, gpg will use the value configured for its installation, e.g. ~/.gnupg or %APPDATA%/gnupg.
User Property: gpg.homedir
<keyEnvName>
String
3.2.0
BC Signer only: The env variable name where the GnuPG key is set. To use BC Signer you must provide GnuPG key, as it does not use GnuPG home directory to extract/find the key (while it does use GnuPG Agent to ask for password in interactive mode). The key should be in TSK format and may be passphrase protected.
Default: MAVEN_GPG_KEY
User Property: gpg.keyEnvName
<keyFilePath>
String
3.2.0
BC Signer only: The path of the exported key in TSK format, and may be passphrase protected. If relative, the file is resolved against user home directory. 
Note: it is not recommended to have sensitive files checked into SCM repository. Key file should reside on developer workstation, outside of SCM tracked repository. For CI-like use cases you should set the key material as env variable instead.

Default: maven-signing-key.key
User Property: gpg.keyFilePath
<keyFingerprint>
String
3.2.0
BC Signer only: The fingerprint of the key to use for signing. If not given, first key in keyring will be used.
User Property: gpg.keyFingerprint
<keyFingerprintEnvName>
String
3.2.0
BC Signer only: The env variable name where the GnuPG key fingerprint is set, if the provided keyring contains multiple keys.
Default: MAVEN_GPG_KEY_FINGERPRINT
User Property: gpg.keyFingerprintEnvName
<keyname>
String
GPG Signer only: The "name" of the key to sign with. Passed to gpg as --local-user.
User Property: gpg.keyname
<lockMode>
String
GPG Signer only: The lock mode to use when invoking gpg. By default no lock mode will be specified. Valid values are once, multiple and never. The lock mode gets translated into the corresponding --lock-___ command line argument. Improper usage of this option may lead to data and key corruption.
See also: the --lock-options
User Property: gpg.lockMode
<passphrase>
String
Deprecated. The passphrase to use when signing. If not given, look up the value under Maven settings using server id at 'passphraseServerKey' configuration. Do not use this parameter, it leaks sensitive data. Passphrase should be provided only via gpg-agent or via env variable. If parameter bestPractices set to true, plugin fails when this parameter is configured.
User Property: gpg.passphrase
<passphraseEnvName>
String
3.2.0
The env variable name where the GnuPG passphrase is set. This is the recommended way to pass passphrase for signing in batch mode execution of Maven.
Default: MAVEN_GPG_PASSPHRASE
User Property: gpg.passphraseEnvName
<passphraseServerId>
String
Deprecated. Server id to lookup the passphrase under Maven settings. Do not use this parameter, it leaks sensitive data. Passphrase should be provided only via gpg-agent or via env variable. If parameter bestPractices set to true, plugin fails when this parameter is configured.
Default: gpg.passphrase
User Property: gpg.passphraseServerId
<publicKeyring>
String
Deprecated. GPG Signer only: The path to a public keyring to add to the list of keyrings. By default, only the pubring.gpg from gpg's home directory is considered. Use this option (and defaultKeyring if required) to use a different public key. Note: Relative paths are resolved against gpg's home directory, not the project base directory. 
NOTE: As of gpg 2.1 this is an obsolete option and ignored. All public keys are stored in the ‘pubring.kbx’ file below the GnuPG home directory.

User Property: gpg.publicKeyring
<secretKeyring>
String
Deprecated. GPG Signer only: The path to a secret keyring to add to the list of keyrings. By default, only the secring.gpg from gpg's home directory is considered. Use this option (in combination with publicKeyring and defaultKeyring if required) to use a different secret key. Note: Relative paths are resolved against gpg's home directory, not the project base directory. 
NOTE: As of gpg 2.1 this is an obsolete option and ignored. All secret keys are stored in the ‘private-keys-v1.d’ directory below the GnuPG home directory.

User Property: gpg.secretKeyring
<signer>
String
3.2.0
The name of the Signer implementation to use. Accepted values are "gpg" (the default, uses GnuPG executable) and "bc" (uses Bouncy Castle pure Java signer).
Default: gpg
User Property: gpg.signer
boolean
Skip doing the gpg signing.
Default: false
User Property: gpg.skip
<useAgent>
boolean
All signers: whether gpg-agent is allowed to be used or not. If enabled, passphrase is optional, as agent may provide it. Have to be noted, that in "batch" mode, gpg-agent will be prevented to pop up pinentry dialogue, hence best is to "prime" the agent caches beforehand. 
GPG Signer: Passes --use-agent or --no-use-agent option to gpg if it is version 2.1 or older. Otherwise, will use an agent. In non-interactive mode gpg options are appended with --pinentry-mode error, preventing gpg agent to pop up pinentry dialogue. Agent will be able to hand over only cached passwords.
BC Signer: Allows signer to communicate with gpg agent. In non-interactive mode it uses --no-ask option with the GET_PASSPHRASE function. Agent will be able to hand over only cached passwords.

Default: true
User Property: gpg.useagent

Parameter Details

<ascDirectory>

<bestPractices>

<defaultKeyring>

<excludes>

<executable>

<gpgArguments>