dev.jeka.core.api.crypto.gpg

Class JkGpgSigner

java.lang.Object

dev.jeka.core.api.crypto.gpg.JkGpgSigner

All Implemented Interfaces:

JkFileSigner, JkSigner

public final class JkGpgSigner
extends java.lang.Object
implements JkSigner

Provides methods for signing data with GnuPG.

Method Summary

Modifier and Type	Method and Description
static java.nio.file.Path	getDefaultGpgSecretRingPath() Returns the default path for the secret ring file.
java.nio.file.Path	getSecretRingPath() Returns the secret ring of this object.
static JkGpgSigner	ofAsciiKey(java.lang.String asciiKey, java.lang.String passphrase) Creates a new instance of JkGpgSigner with the specified ascii key and passphrase.
static JkGpgSigner	ofDefaultGnuPg(java.lang.String password, java.lang.String keyName) Creates a JkGpgSigner with default GnuPgp file location.
static JkGpgSigner	ofSecretRing(java.nio.file.Path secRing, java.lang.String password) Creates a JkGpgSigner with the specified secret key ring, assuming the secret ring contains a single key.
static JkGpgSigner	ofSecretRing(java.nio.file.Path secRing, java.lang.String passphrase, java.lang.String keyName) Creates a new instance of JkGpgSigner with the specified secret ring, passphrase, and key name.
static JkGpgSigner	ofStandardProject(java.nio.file.Path baseDir) Creates a JkGpgSigner instance for a standard project.
static JkGpgSigner	ofStandardProperties() Creates a new instance of JkGpgSigner with the standard properties. Use jeka.gpg.secret-key property or JEKA_GPG_SECRET_KEY for passing private ascii key.
void	sign(java.io.InputStream streamToSign, java.io.OutputStream signatureStream) Signs the data in the specified input stream and writes the signature to the output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.jeka.core.api.crypto.JkSigner

sign

Methods inherited from interface dev.jeka.core.api.crypto.JkFileSigner

sign

Method Detail

ofSecretRing

public static JkGpgSigner ofSecretRing(java.nio.file.Path secRing,
                                       java.lang.String passphrase,
                                       java.lang.String keyName)

Creates a new instance of JkGpgSigner with the specified secret ring, passphrase, and key name.

Parameters:

secRing - the path to the secret ring file

passphrase - the passphrase for the secret ring file

keyName - the name of the key to use within the secret ring file. Can be empty if secRing contains a single key.

Returns:

a new instance of JkGpg

ofSecretRing

public static JkGpgSigner ofSecretRing(java.nio.file.Path secRing,
                                       java.lang.String password)

Creates a JkGpgSigner with the specified secret key ring, assuming the secret ring contains a single key.

ofAsciiKey

public static JkGpgSigner ofAsciiKey(java.lang.String asciiKey,
                                     java.lang.String passphrase)

Creates a new instance of JkGpgSigner with the specified ascii key and passphrase.

Parameters:

asciiKey - The armored key to use for signing. It is generally by exporting key in asc format

passphrase - The passphrase for the armored key. The exported key is protected by a passphrase. This is the passphrase to use for decoding the armored key.

ofStandardProject

public static JkGpgSigner ofStandardProject(java.nio.file.Path baseDir)

Creates a JkGpgSigner instance for a standard project.

This method creates a JkGpgSigner instance using the specified base directory to locate the public and secret ring files. If the public or secret ring files are not found in the base directory, the default files will be used.

Parameters:

baseDir - the base directory of the project

Returns:

a JkGpgSigner instance for the standard project

ofStandardProperties

public static JkGpgSigner ofStandardProperties()

Creates a new instance of JkGpgSigner with the standard properties.
Use jeka.gpg.secret-key property or JEKA_GPG_SECRET_KEY for passing private ascii key.
Use jeka.gpg.passphrase property or EKA_GPG_PASSPHRASE for passing key password

Returns:

a new instance of JkGpgSigner

ofDefaultGnuPg

public static JkGpgSigner ofDefaultGnuPg(java.lang.String password,
                                         java.lang.String keyName)

Creates a JkGpgSigner with default GnuPgp file location.

Parameters:

keyName - Can be empty if secret ring contains a single key.

getDefaultGpgSecretRingPath

public static java.nio.file.Path getDefaultGpgSecretRingPath()

Returns the default path for the secret ring file.

getSecretRingPath

public java.nio.file.Path getSecretRingPath()

Returns the secret ring of this object.

sign

public void sign(java.io.InputStream streamToSign,
                 java.io.OutputStream signatureStream)

Description copied from interface: JkSigner

Signs the data in the specified input stream and writes the signature to the output stream.

Specified by:

sign in interface JkSigner

Parameters:

streamToSign - the input stream containing the data to be signed

signatureStream - the output stream to write the signature string to