jarsigner:sign

Full name:

org.apache.maven.plugins:maven-jarsigner-plugin:3.0.0:sign

Description:

Signs a project artifact and attachments using jarsigner.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
<alias> String 1.0 See options.
User property is: jarsigner.alias.
<archive> File 1.0 Archive to process. If set, neither the project artifact nor any attachments or archive sets are processed.
User property is: jarsigner.archive.
<archiveDirectory> File 1.1 The base directory to scan for JAR files using Ant-like inclusion/exclusion patterns.
User property is: jarsigner.archiveDirectory.
<arguments> String[] 1.0 List of additional arguments to append to the jarsigner command line.
User property is: jarsigner.arguments.
<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.
<keypass> String 1.0 See options.
User property is: jarsigner.keypass.
<keystore> String 1.0 See options.
User property is: jarsigner.keystore.
<maxMemory> String 1.0 The maximum memory available to the JAR signer, e.g. 256M. See -Xmx for more details.
User property is: 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 value is: true.
User property is: jarsigner.processAttachedArtifacts.
<processMainArtifact> boolean 1.1 Controls processing of the main artifact produced by the project.
Default value is: true.
User property is: 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 value is: false.
User property is: jarsigner.protectedAuthenticationPath.
<providerArg> String 1.0 See options.
User property is: jarsigner.providerArg.
<providerClass> String 1.0 See options.
User property is: jarsigner.providerClass.
<providerName> String 1.0 See options.
User property is: jarsigner.providerName.
<removeExistingSignatures> boolean 1.1 Indicates whether existing signatures should be removed from the processed JAR files prior to signing them. If enabled, the resulting JAR will appear as being signed only once.
Default value is: false.
User property is: jarsigner.removeExistingSignatures.
<sigfile> String 1.0 See options.
User property is: jarsigner.sigfile.
<skip> boolean 1.0 Set to true to disable the plugin.
Default value is: false.
User property is: jarsigner.skip.
<storepass> String 1.0 See options.
User property is: jarsigner.storepass.
<storetype> String 1.0 See options.
User property is: jarsigner.storetype.
<tsa> String 1.3 See options.
User property is: jarsigner.tsa.
<tsacert> String 1.3 See options.
User property is: jarsigner.tsacert.
<verbose> boolean 1.0 See options.
Default value is: false.
User property is: jarsigner.verbose.
<workingDirectory> File 1.3 Location of the working directory.
Default value is: ${project.basedir}.

Parameter Details

<alias>

See options.
  • Type: java.lang.String
  • Since: 1.0
  • 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
  • Since: 1.0
  • 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.
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No
  • User Property: jarsigner.arguments

<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

<keypass>

See options.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: jarsigner.keypass

<keystore>

See options.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: jarsigner.keystore

<maxMemory>

The maximum memory available to the JAR signer, e.g. 256M. See -Xmx for more details.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: jarsigner.maxMemory

<processAttachedArtifacts>

Controls processing of project attachments. If enabled, attached artifacts that are no JAR/ZIP files will be automatically excluded from processing.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: jarsigner.processAttachedArtifacts
  • Default: true

<processMainArtifact>

Controls processing of the main artifact produced by the project.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: jarsigner.processMainArtifact
  • Default: true

<protectedAuthenticationPath>

Must be set to true if the password must be given via a protected authentication path such as a dedicated PIN reader.
  • Type: boolean
  • Since: 1.3
  • Required: No
  • User Property: jarsigner.protectedAuthenticationPath
  • Default: false

<providerArg>

See options.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: jarsigner.providerArg

<providerClass>

See options.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: jarsigner.providerClass

<providerName>

See options.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: jarsigner.providerName

<removeExistingSignatures>

Indicates whether existing signatures should be removed from the processed JAR files prior to signing them. If enabled, the resulting JAR will appear as being signed only once.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: jarsigner.removeExistingSignatures
  • Default: false

<sigfile>

See options.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: jarsigner.sigfile

<skip>

Set to true to disable the plugin.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: jarsigner.skip
  • Default: false

<storepass>

See options.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: jarsigner.storepass

<storetype>

See options.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: jarsigner.storetype

<tsa>

See options.
  • Type: java.lang.String
  • Since: 1.3
  • Required: No
  • User Property: jarsigner.tsa

<tsacert>

See options.
  • Type: java.lang.String
  • Since: 1.3
  • Required: No
  • User Property: jarsigner.tsacert

<verbose>

See options.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: jarsigner.verbose
  • Default: false

<workingDirectory>

Location of the working directory.
  • Type: java.io.File
  • Since: 1.3
  • Required: No
  • Default: ${project.basedir}