org.bouncycastle.openpgp.api

Class AbstractOpenPGPDocumentSignatureGenerator<T extends AbstractOpenPGPDocumentSignatureGenerator<T>>

java.lang.Object

org.bouncycastle.openpgp.api.AbstractOpenPGPDocumentSignatureGenerator<T>

Direct Known Subclasses:

OpenPGPDetachedSignatureGenerator, OpenPGPMessageGenerator

public class AbstractOpenPGPDocumentSignatureGenerator<T extends AbstractOpenPGPDocumentSignatureGenerator<T>>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected KeyPassphraseProvider.DefaultKeyPassphraseProvider	defaultKeyPassphraseProvider
protected OpenPGPImplementation	implementation
protected OpenPGPPolicy	policy
protected java.util.List<SignatureParameters.Callback>	signatureCallbacks
protected java.util.List<PGPSignatureGenerator>	signatureGenerators
protected java.util.List<KeyPassphraseProvider>	signingKeyPassphraseProviders
protected java.util.List<OpenPGPKey.OpenPGPSecretKey>	signingKeys
protected SubkeySelector	signingKeySelector

Constructor Summary

Constructors

Constructor and Description
AbstractOpenPGPDocumentSignatureGenerator(OpenPGPImplementation implementation, OpenPGPPolicy policy)

Method Summary

Modifier and Type	Method and Description
T	addKeyPassphrase(char[] passphrase) Add a passphrase for unlocking signing keys to the set of available passphrases.
T	addSigningKey(OpenPGPKey.OpenPGPSecretKey signingKey, char[] passphrase, SignatureParameters.Callback signatureCallback) Add the given signing (sub-)key for message signing, using the optional passphrase to unlock the key in case its locked, and using the given SignatureParameters.Callback to allow modification of the signature contents.
T	addSigningKey(OpenPGPKey.OpenPGPSecretKey signingKey, KeyPassphraseProvider passphraseProvider, SignatureParameters.Callback signatureCallback) Add the given signing (sub-)key for message signing, using the passphrase provider to unlock the key in case its locked, and using the given SignatureParameters.Callback to allow modification of the signature contents.
T	addSigningKey(OpenPGPKey key) Add an OpenPGPKey for message signing.
T	addSigningKey(OpenPGPKey key, KeyPassphraseProvider passphraseProvider) Add an OpenPGPKey for message signing, using the provided KeyPassphraseProvider to unlock protected subkeys.
T	addSigningKey(OpenPGPKey key, KeyPassphraseProvider passphraseProvider, SignatureParameters.Callback signatureCallback) Add an OpenPGPKey for message signing, using the given KeyPassphraseProvider for unlocking protected subkeys and using the SignatureParameters.Callback to allow modification of the signature contents.
T	addSigningKey(OpenPGPKey key, SignatureParameters.Callback signatureCallback) Add an OpenPGPKey for message signing, using the SignatureParameters.Callback to allow modification of the signature contents.
protected void	addSignToGenerator()
protected PGPSignatureGenerator	initSignatureGenerator(OpenPGPKey.OpenPGPSecretKey signingKey, KeyPassphraseProvider passphraseProvider, SignatureParameters.Callback signatureCallback)
T	setMissingKeyPassphraseCallback(KeyPassphraseProvider callback) Set a callback that will be fired, if a passphrase for a protected signing key is missing.
T	setSigningKeySelector(SubkeySelector signingKeySelector) Replace the default signing key selector with a custom implementation.

Methods inherited from class java.lang.Object

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

Field Detail

implementation

protected final OpenPGPImplementation implementation

policy

protected final OpenPGPPolicy policy

signatureGenerators

protected final java.util.List<PGPSignatureGenerator> signatureGenerators

signingKeys

protected final java.util.List<OpenPGPKey.OpenPGPSecretKey> signingKeys

signatureCallbacks

protected final java.util.List<SignatureParameters.Callback> signatureCallbacks

signingKeyPassphraseProviders

protected final java.util.List<KeyPassphraseProvider> signingKeyPassphraseProviders

defaultKeyPassphraseProvider

protected final KeyPassphraseProvider.DefaultKeyPassphraseProvider defaultKeyPassphraseProvider

signingKeySelector

protected SubkeySelector signingKeySelector

Constructor Detail

AbstractOpenPGPDocumentSignatureGenerator

public AbstractOpenPGPDocumentSignatureGenerator(OpenPGPImplementation implementation,
                                                 OpenPGPPolicy policy)

Method Detail

setSigningKeySelector

public T setSigningKeySelector(SubkeySelector signingKeySelector)

Replace the default signing key selector with a custom implementation. The signing key selector is responsible for selecting one or more signing subkeys from a signing key.

Parameters:

signingKeySelector - selector for signing (sub-)keys

Returns:

this

addKeyPassphrase

public T addKeyPassphrase(char[] passphrase)

Add a passphrase for unlocking signing keys to the set of available passphrases.

Parameters:

passphrase - passphrase

Returns:

this

addSigningKey

public T addSigningKey(OpenPGPKey key)
                throws InvalidSigningKeyException

Add an OpenPGPKey for message signing. The signingKeySelector is responsible for selecting one or more subkeys of the key to sign with. If no (sub-)key in the signing key is capable of creating signatures, or if the key is expired or revoked, this method will throw an InvalidSigningKeyException.

Parameters:

key - OpenPGP key

Returns:

this

Throws:

InvalidSigningKeyException - if the key is not capable of signing

addSigningKey

public T addSigningKey(OpenPGPKey key,
                       KeyPassphraseProvider passphraseProvider)
                throws InvalidSigningKeyException

Add an OpenPGPKey for message signing, using the provided KeyPassphraseProvider to unlock protected subkeys. The signingKeySelector is responsible for selecting one or more subkeys of the key to sign with. If no (sub-)key in the signing key is capable of creating signatures, or if the key is expired or revoked, this method will throw an InvalidSigningKeyException.

Parameters:

key - OpenPGP key

passphraseProvider - provides the passphrase to unlock the signing key

Returns:

this

Throws:

InvalidSigningKeyException - if the OpenPGP key does not contain a usable signing subkey

addSigningKey

public T addSigningKey(OpenPGPKey key,
                       SignatureParameters.Callback signatureCallback)
                throws InvalidSigningKeyException

Add an OpenPGPKey for message signing, using the SignatureParameters.Callback to allow modification of the signature contents. The signingKeySelector is responsible for selecting one or more subkeys of the key to sign with. If no (sub-)key in the signing key is capable of creating signatures, or if the key is expired or revoked, this method will throw an InvalidSigningKeyException.

Parameters:

key - OpenPGP key

signatureCallback - optional callback to modify the signature contents with

Returns:

this

Throws:

InvalidSigningKeyException - if the OpenPGP key does not contain a usable signing subkey

addSigningKey

public T addSigningKey(OpenPGPKey key,
                       KeyPassphraseProvider passphraseProvider,
                       SignatureParameters.Callback signatureCallback)
                throws InvalidSigningKeyException

Add an OpenPGPKey for message signing, using the given KeyPassphraseProvider for unlocking protected subkeys and using the SignatureParameters.Callback to allow modification of the signature contents. The signingKeySelector is responsible for selecting one or more subkeys of the key to sign with. If no (sub-)key in the signing key is capable of creating signatures, or if the key is expired or revoked, this method will throw an InvalidSigningKeyException.

Parameters:

key - OpenPGP key

passphraseProvider - key passphrase provider

signatureCallback - optional callback to modify the signature contents with

Returns:

this

Throws:

InvalidSigningKeyException - if the OpenPGP key does not contain a usable signing subkey

addSigningKey

public T addSigningKey(OpenPGPKey.OpenPGPSecretKey signingKey,
                       char[] passphrase,
                       SignatureParameters.Callback signatureCallback)
                throws InvalidSigningKeyException

Add the given signing (sub-)key for message signing, using the optional passphrase to unlock the key in case its locked, and using the given SignatureParameters.Callback to allow modification of the signature contents.

Parameters:

signingKey - signing (sub-)key

passphrase - optional subkey passphrase

signatureCallback - optional callback to modify the signature contents

Returns:

this

Throws:

InvalidSigningKeyException - if the subkey is not signing-capable

addSigningKey

public T addSigningKey(OpenPGPKey.OpenPGPSecretKey signingKey,
                       KeyPassphraseProvider passphraseProvider,
                       SignatureParameters.Callback signatureCallback)
                throws InvalidSigningKeyException

Add the given signing (sub-)key for message signing, using the passphrase provider to unlock the key in case its locked, and using the given SignatureParameters.Callback to allow modification of the signature contents.

Parameters:

signingKey - signing (sub-)key

passphraseProvider - passphrase provider for unlocking the subkey

signatureCallback - optional callback to modify the signature contents

Returns:

this

Throws:

InvalidSigningKeyException - if the subkey is not signing-capable

initSignatureGenerator

protected PGPSignatureGenerator initSignatureGenerator(OpenPGPKey.OpenPGPSecretKey signingKey,
                                                       KeyPassphraseProvider passphraseProvider,
                                                       SignatureParameters.Callback signatureCallback)
                                                throws PGPException

Throws:

PGPException

setMissingKeyPassphraseCallback

public T setMissingKeyPassphraseCallback(KeyPassphraseProvider callback)

Set a callback that will be fired, if a passphrase for a protected signing key is missing. This can be used for example to implement interactive on-demand passphrase prompting.

Parameters:

callback - passphrase provider

Returns:

builder

addSignToGenerator

protected void addSignToGenerator()
                           throws PGPException

Throws:

PGPException