$i18n.getString(

eclipse-winsigner-plugin:sign

Full name:

org.eclipse.cbi.maven.plugins:eclipse-winsigner-plugin:1.5.3-SNAPSHOT:sign

Description:

Signs executables found in the project build directory using the Eclipse Windows executable signer webservice.

Attributes:

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

Required Parameters

Name Type Since Description
<signerUrl> String 1.0.4 The signing service URL for signing Windows binaries. The signing service should return a signed exe file.
Default: https://cbi.eclipse.org/authenticode/sign
User Property: cbi.winsigner.signerUrl

Optional Parameters

Name Type Since Description
<baseSearchDir> String 1.0.4 (for the parameter, since 1.1.3 for the qualified user property). The base directory to search for executables to sign. The executable name to search for can be configured with parameter fileNames. This parameter is ignored if signFiles is set.
Default: ${project.build.directory}/products/
User Property: cbi.winsigner.baseSearchDir
<continueOnFail> boolean 1.0.5 (for the parameter, since 1.1.3 for the qualified user property). Whether the build should be stopped if the signing process fails.
Default: false
User Property: cbi.winsigner.continueOnFail
<deprecatedBaseSearchDir> String 1.0.4 (for the user property, since 1.1.3 for the parameter)
Deprecated.
The user property baseSearchDir is deprecated. You should use the qualified property cbi.winsigner.baseSearchDir instead. The deprecatedBaseSearchDir parameter has been introduced to support this deprecated user property for backward compatibility only.

The base directory to search for executables to sign. The executable name to search for can be configured with parameter fileNames. This parameter is ignored if signFiles is set.
User Property: baseSearchDir
<deprecatedContinueOnFail> boolean 1.0.5 (for the user property, since 1.1.3 for the parameter).
Deprecated.
The user property continueOnFail is deprecated. You should use the qualified property cbi.winsigner.continueOnFail instead. The deprecatedContinueOnFail parameter has been introduced to support this deprecated user property for backward compatibility only.

Whether the build should be stopped if the signing process fails.
Default: false
User Property: continueOnFail
<deprecatedFileNames> Set<String> 1.0.4 (for the user property, since 1.1.3 for the parameter).
Deprecated.
The user property fileNames is deprecated. You should use the qualified property cbi.winsigner.fileNames instead. The deprecatedFileNames parameter has been introduced to support this deprecated user property for backward compatibility only.

List of file names to sign. These file names will be searched in baseSearchDir. This parameter is ignored if signFiles is set.

Default value is {eclipse.exe, eclipsec.exe}.


User Property: fileNames
<deprecatedRetryLimit> int 1.1.0 (for the user property, since 1.1.3 for the parameter).
Deprecated.
The user property retryLimit is deprecated. You should use the qualified property cbi.winsigner.retryLimit instead. The deprecatedRetryLimit parameter has been introduced to support this deprecated user property for backward compatibility only.

Number of times to retry signing if server fails to sign
Default: 3
User Property: retryLimit
<deprecatedRetryTimer> int 1.1.0 (for the user property, since 1.1.3 for the parameter).
Deprecated.
The user property retryTimer is deprecated. You should use the qualified property cbi.winsigner.retryTimer instead. The deprecatedRetryTimer parameter has been introduced to support this deprecated user property for backward compatibility only.

Number of seconds to wait before retrying to sign
Default: 10
User Property: retryTimer
<deprecatedSignFiles> Set<String> 1.0.4 (for the user property, since 1.1.3 for the parameter)
Deprecated.
The user property signFiles is deprecated. You should use the qualified property cbi.winsigner.signFiles instead. The deprecatedSignFiles parameter has been introduced to support this deprecated user property for backward compatibility only.

The list of absolute paths of executables to be signed. If configured, only these executables will be signed and the parameters baseSearchDir and fileNames will be ignored.
User Property: signFiles
<fileNames> Set<String> 1.0.4 (for the parameter, since 1.1.3 for the qualified user property). List of file names to sign. These file names will be searched in baseSearchDir. This parameter is ignored if signFiles is set.

Default value is {"eclipse.exe", "eclipsec.exe"}}.


User Property: cbi.winsigner.fileNames
<retryLimit> int 1.1.0 (for the parameter, since 1.1.3 for the qualified user property). Number of times to retry signing if server fails to sign
Default: 3
User Property: cbi.winsigner.retryLimit
<retryTimer> int 1.1.0 (for the parameter, since 1.1.3 for the qualified user property). Number of seconds to wait before retrying to sign
Default: 10
User Property: cbi.winsigner.retryTimer
<signFiles> Set<String> 1.0.4 (for the parameter, since 1.1.3 for the qualified user property). The list of absolute paths of executables to be signed. If configured, only these executables will be signed and the parameters baseSearchDir and fileNames will be ignored.
User Property: cbi.winsigner.signFiles
<timeoutMillis> int 1.1.5 Defines the wall timeout in milliseconds for performing the remote request. A timeout value of zero is interpreted as an infinite timeout.
Default: 0
User Property: cbi.winsigner.timeoutMillis

Parameter Details

<baseSearchDir>

The base directory to search for executables to sign. The executable name to search for can be configured with parameter fileNames. This parameter is ignored if signFiles is set.
  • Type: java.lang.String
  • Since: 1.0.4 (for the parameter, since 1.1.3 for the qualified user property).
  • Required: No
  • User Property: cbi.winsigner.baseSearchDir
  • Default: ${project.build.directory}/products/

<continueOnFail>

Whether the build should be stopped if the signing process fails.
  • Type: boolean
  • Since: 1.0.5 (for the parameter, since 1.1.3 for the qualified user property).
  • Required: No
  • User Property: cbi.winsigner.continueOnFail
  • Default: false

<deprecatedBaseSearchDir>

Deprecated.
The user property baseSearchDir is deprecated. You should use the qualified property cbi.winsigner.baseSearchDir instead. The deprecatedBaseSearchDir parameter has been introduced to support this deprecated user property for backward compatibility only.

The base directory to search for executables to sign. The executable name to search for can be configured with parameter fileNames. This parameter is ignored if signFiles is set.
  • Type: java.lang.String
  • Since: 1.0.4 (for the user property, since 1.1.3 for the parameter)
  • Required: No
  • User Property: baseSearchDir

<deprecatedContinueOnFail>

Deprecated.
The user property continueOnFail is deprecated. You should use the qualified property cbi.winsigner.continueOnFail instead. The deprecatedContinueOnFail parameter has been introduced to support this deprecated user property for backward compatibility only.

Whether the build should be stopped if the signing process fails.
  • Type: boolean
  • Since: 1.0.5 (for the user property, since 1.1.3 for the parameter).
  • Required: No
  • User Property: continueOnFail
  • Default: false

<deprecatedFileNames>

Deprecated.
The user property fileNames is deprecated. You should use the qualified property cbi.winsigner.fileNames instead. The deprecatedFileNames parameter has been introduced to support this deprecated user property for backward compatibility only.

List of file names to sign. These file names will be searched in baseSearchDir. This parameter is ignored if signFiles is set.

Default value is {eclipse.exe, eclipsec.exe}.

  • Type: java.util.Set<java.lang.String>
  • Since: 1.0.4 (for the user property, since 1.1.3 for the parameter).
  • Required: No
  • User Property: fileNames

<deprecatedRetryLimit>

Deprecated.
The user property retryLimit is deprecated. You should use the qualified property cbi.winsigner.retryLimit instead. The deprecatedRetryLimit parameter has been introduced to support this deprecated user property for backward compatibility only.

Number of times to retry signing if server fails to sign
  • Type: int
  • Since: 1.1.0 (for the user property, since 1.1.3 for the parameter).
  • Required: No
  • User Property: retryLimit
  • Default: 3

<deprecatedRetryTimer>

Deprecated.
The user property retryTimer is deprecated. You should use the qualified property cbi.winsigner.retryTimer instead. The deprecatedRetryTimer parameter has been introduced to support this deprecated user property for backward compatibility only.

Number of seconds to wait before retrying to sign
  • Type: int
  • Since: 1.1.0 (for the user property, since 1.1.3 for the parameter).
  • Required: No
  • User Property: retryTimer
  • Default: 10

<deprecatedSignFiles>

Deprecated.
The user property signFiles is deprecated. You should use the qualified property cbi.winsigner.signFiles instead. The deprecatedSignFiles parameter has been introduced to support this deprecated user property for backward compatibility only.

The list of absolute paths of executables to be signed. If configured, only these executables will be signed and the parameters baseSearchDir and fileNames will be ignored.
  • Type: java.util.Set<java.lang.String>
  • Since: 1.0.4 (for the user property, since 1.1.3 for the parameter)
  • Required: No
  • User Property: signFiles

<fileNames>

List of file names to sign. These file names will be searched in baseSearchDir. This parameter is ignored if signFiles is set.

Default value is {"eclipse.exe", "eclipsec.exe"}}.

  • Type: java.util.Set<java.lang.String>
  • Since: 1.0.4 (for the parameter, since 1.1.3 for the qualified user property).
  • Required: No
  • User Property: cbi.winsigner.fileNames

<retryLimit>

Number of times to retry signing if server fails to sign
  • Type: int
  • Since: 1.1.0 (for the parameter, since 1.1.3 for the qualified user property).
  • Required: No
  • User Property: cbi.winsigner.retryLimit
  • Default: 3

<retryTimer>

Number of seconds to wait before retrying to sign
  • Type: int
  • Since: 1.1.0 (for the parameter, since 1.1.3 for the qualified user property).
  • Required: No
  • User Property: cbi.winsigner.retryTimer
  • Default: 10

<signFiles>

The list of absolute paths of executables to be signed. If configured, only these executables will be signed and the parameters baseSearchDir and fileNames will be ignored.
  • Type: java.util.Set<java.lang.String>
  • Since: 1.0.4 (for the parameter, since 1.1.3 for the qualified user property).
  • Required: No
  • User Property: cbi.winsigner.signFiles

<signerUrl>

The signing service URL for signing Windows binaries. The signing service should return a signed exe file.
  • Type: java.lang.String
  • Since: 1.0.4
  • Required: Yes
  • User Property: cbi.winsigner.signerUrl
  • Default: https://cbi.eclipse.org/authenticode/sign

<timeoutMillis>

Defines the wall timeout in milliseconds for performing the remote request. A timeout value of zero is interpreted as an infinite timeout.
  • Type: int
  • Since: 1.1.5
  • Required: No
  • User Property: cbi.winsigner.timeoutMillis
  • Default: 0