Property Detail

• static final java.lang.String DEFAULT_HASH_ALGORITHM

  Constant of default hash algorithm.

  Default:

  "SHA512"

• java.lang.String gpgKeyPassPhrase

  GnuPG Code Signing Key Passphrase Jenkins username/password credential

• java.lang.String gpgPrivateKey

  GnuPG Code Signing Private Key Jenkins Secret file credential

• java.lang.Object steps

  Reference to the groovy pipeline variable.

Constructor Detail

• Signing(java.lang.Object steps)

  Constructs the class.

  When invoking from a Jenkins pipeline script, the Pipeline must be passed the current environment of the Jenkinsfile to have access to the steps.

  Example:

   def signing = new Signing(this)
   

  Parameters:

  steps - The workflow steps object provided by the Jenkins pipeline

Method Detail

• java.lang.String getSigningKey(java.util.Map args = [:])

  Return GnuPG signing key id

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  Returns:

  signing key

• java.lang.Boolean gpgKeyExists(java.lang.String key)

  Check if a GnuPG exists.

  Parameters:

  key - GnuPG key to check

  Returns:

  exist or not

• java.lang.String hash(java.util.Map args = [:])

  Generate hash file for a package

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  Parameters:

  filename - package file will be signed

  algo - Algorithm to generate hash. Default is DEFAULT_HASH_ALGORITHM.

  Returns:

  hash file

• java.lang.String hash(java.lang.String filename)

  Generate hash file for a package

  See Also:

  hash(Map)

• void init(java.util.Map args = [:])

  Initialize signing properties

  Parameters:

  gpgKeyPassPhrase - GnuPG Code Signing Key Passphrase Jenkins username/password credential. Default value is org.zowe.jenkins_shared_library.Constants#DEFAULT_GPG_CODE_SIGNING_KEY_PASSPHRASE.

  gpgPrivateKey - GnuPG Code Signing Private Key Jenkins Secret file credential. Default value is org.zowe.jenkins_shared_library.Constants#DEFAULT_GPG_CODE_SIGNING_PRIVATE_KEY_FILE.

• java.lang.String sign(java.util.Map args = [:])

  GnuPG sign a package

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  Parameters:

  filename - package file will be signed

  Returns:

  signed signature file

• java.lang.String sign(java.lang.String filename)

  GnuPG sign a package

  See Also:

  sign(Map)

• java.lang.Boolean verifySignature(java.util.Map args = [:])

  Verify if the signature is good

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  Parameters:

  filename - package file will be verified

  signature - signature file. Optional, default will be filename with .asc extension

  Returns:

  valid or not

• java.lang.Boolean verifySignature(java.lang.String filename)

  Verify if the signature is good

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  See Also:

  verifySignature(Map)