Apache Maven Jarsigner Plugin

jarsigner:verify

Full name:

org.apache.maven.plugins:maven-jarsigner-plugin:3.1.0:verify

Description:

Checks the signatures of a project artifact and attachments using jarsigner.

Attributes:

Requires a Maven project to be executed.
The goal is thread-safe and supports parallel builds.
Since version: 1.0.
Binds by default to the lifecycle phase: verify.

Optional Parameters

Name	Type	Since	Description
`<alias>`	`String`	`-`	See options. User Property: `jarsigner.alias`
`<archive>`	`File`	`-`	Archive to process. If set, neither the project artifact nor any attachments or archive sets are processed. User Property: `jarsigner.archive`
`<archiveDirectory>`	`File`	`1.1`	The base directory to scan for JAR files using Ant-like inclusion/exclusion patterns. User Property: `jarsigner.archiveDirectory`
`<arguments>`	`String[]`	`-`	List of additional arguments to append to the jarsigner command line. Each argument should be specified as a separate element. For example, to specify the name of the signed jar, two elements are needed: Alternative using the command line: `-Djarsigner.arguments="-signedjar,my-project_signed.jar"` Alternative using the Maven POM configuration: `<configuration> <arguments> <argument>-signedjar</argument> <argument>my-project_signed.jar</argument> </arguments> </configuration>` User Property: `jarsigner.arguments`
`<certs>`	`boolean`	`-`	See options. Default: `false` User Property: `jarsigner.certs`
`<errorWhenNotSigned>`	`boolean`	`1.3`	When `true` this will make the execute() operation fail, throwing an exception, when verifying a non signed jar. Primarily to keep backwards compatibility with existing code, and allow reusing the bean in unattended operations when set to `false`. Default: `false` User Property: `jarsigner.errorWhenNotSigned`
`<excludeClassifiers>`	`String[]`	`1.2`	A set of artifact classifiers describing the project attachments that should not be processed. This parameter is only relevant if `processAttachedArtifacts` is `true`. If empty, no attachments are excluded.
`<excludes>`	`String[]`	`1.1`	The Ant-like exclusion patterns used to exclude JAR files from processing. The patterns must be relative to the directory given by the parameter `archiveDirectory`.
`<includeClassifiers>`	`String[]`	`1.2`	A set of artifact classifiers describing the project attachments that should be processed. This parameter is only relevant if `processAttachedArtifacts` is `true`. If empty, all attachments are included.
`<includes>`	`String[]`	`1.1`	The Ant-like inclusion patterns used to select JAR files to process. The patterns must be relative to the directory given by the parameter `archiveDirectory`. By default, the pattern `*/.?ar` is used.
`<keystore>`	`String`	`-`	See options. User Property: `jarsigner.keystore`
`<maxMemory>`	`String`	`-`	The maximum memory available to the JAR signer, e.g. `256M`. See -Xmx for more details. User Property: `jarsigner.maxMemory`
`<processAttachedArtifacts>`	`boolean`	`1.1`	Controls processing of project attachments. If enabled, attached artifacts that are no JAR/ZIP files will be automatically excluded from processing. Default: `true` User Property: `jarsigner.processAttachedArtifacts`
`<processMainArtifact>`	`boolean`	`1.1`	Controls processing of the main artifact produced by the project. Default: `true` User Property: `jarsigner.processMainArtifact`
`<protectedAuthenticationPath>`	`boolean`	`1.3`	Must be set to true if the password must be given via a protected authentication path such as a dedicated PIN reader. Default: `false` User Property: `jarsigner.protectedAuthenticationPath`
`<providerArg>`	`String`	`-`	See options. User Property: `jarsigner.providerArg`
`<providerClass>`	`String`	`-`	See options. User Property: `jarsigner.providerClass`
`<providerName>`	`String`	`-`	See options. User Property: `jarsigner.providerName`
`<skip>`	`boolean`	`-`	Set to `true` to disable the plugin. Default: `false` User Property: `jarsigner.skip`
`<storepass>`	`String`	`-`	See options. User Property: `jarsigner.storepass`
`<storetype>`	`String`	`-`	See options. User Property: `jarsigner.storetype`
`<verbose>`	`boolean`	`-`	See options. Default: `false` User Property: `jarsigner.verbose`
`<workingDirectory>`	`File`	`1.3`	Location of the working directory. Default: `${project.basedir}`

Parameter Details

<alias>

See options.

Type: java.lang.String
Required: No
User Property: jarsigner.alias

<archive>

Archive to process. If set, neither the project artifact nor any attachments or archive sets are processed.

Type: java.io.File
Required: No
User Property: jarsigner.archive

<archiveDirectory>

The base directory to scan for JAR files using Ant-like inclusion/exclusion patterns.

Type: java.io.File
Since: 1.1
Required: No
User Property: jarsigner.archiveDirectory

<arguments>

List of additional arguments to append to the jarsigner command line. Each argument should be specified as a separate element. For example, to specify the name of the signed jar, two elements are needed:

Alternative using the command line: -Djarsigner.arguments="-signedjar,my-project_signed.jar"
Alternative using the Maven POM configuration:

<configuration>
  <arguments>
    <argument>-signedjar</argument>
    <argument>my-project_signed.jar</argument>
  </arguments>
</configuration>

Type: java.lang.String[]
Required: No
User Property: jarsigner.arguments

<certs>

See options.

Type: boolean
Required: No
User Property: jarsigner.certs
Default: false

<errorWhenNotSigned>

When true this will make the execute() operation fail, throwing an exception, when verifying a non signed jar. Primarily to keep backwards compatibility with existing code, and allow reusing the bean in unattended operations when set to false.

Type: boolean
Since: 1.3
Required: No
User Property: jarsigner.errorWhenNotSigned
Default: false

<excludeClassifiers>

A set of artifact classifiers describing the project attachments that should not be processed. This parameter is only relevant if processAttachedArtifacts is true. If empty, no attachments are excluded.

Type: java.lang.String[]
Since: 1.2
Required: No

<excludes>

The Ant-like exclusion patterns used to exclude JAR files from processing. The patterns must be relative to the directory given by the parameter archiveDirectory.

Type: java.lang.String[]
Since: 1.1
Required: No

<includeClassifiers>

A set of artifact classifiers describing the project attachments that should be processed. This parameter is only relevant if processAttachedArtifacts is true. If empty, all attachments are included.

Type: java.lang.String[]
Since: 1.2
Required: No

<includes>

The Ant-like inclusion patterns used to select JAR files to process. The patterns must be relative to the directory given by the parameter archiveDirectory. By default, the pattern **/*.?ar is used.

Type: java.lang.String[]
Since: 1.1
Required: No