Package org.bouncycastle.openpgp.api

Class OpenPGPMessageProcessor

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPMessageProcessor

public class OpenPGPMessageProcessor
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenPGPMessageProcessor.Configuration
static interface	OpenPGPMessageProcessor.PGPExceptionCallback	Callback to handle PGPExceptions.

Constructor Summary

Constructors

Constructor	Description
OpenPGPMessageProcessor()	Create a new OpenPGPMessageProcessor using the default OpenPGPImplementation.
OpenPGPMessageProcessor(OpenPGPImplementation implementation)	Create a new OpenPGPMessageProcessor using the given OpenPGPImplementation.
OpenPGPMessageProcessor(OpenPGPImplementation implementation, OpenPGPPolicy policy)

Method Summary

Modifier and Type	Method	Description
OpenPGPMessageProcessor	addDecryptionKey(OpenPGPKey key)	Add an OpenPGPKey as potential decryption key.
OpenPGPMessageProcessor	addDecryptionKey(OpenPGPKey key, char[] passphrase)	Add an OpenPGPKey as potential decryption key, along with a KeyPassphraseProvider dedicated to this key.
OpenPGPMessageProcessor	addDecryptionKeyPassphrase(char[] passphrase)	Add a passphrase for secret key decryption.
OpenPGPMessageProcessor	addMessagePassphrase(char[] messagePassphrase)	Set a passphrase to decrypt a symmetrically encrypted OpenPGP message.
OpenPGPMessageProcessor	addVerificationCertificate(OpenPGPCertificate issuerCertificate)	Add an OpenPGPCertificate for signature verification.
OpenPGPMessageInputStream	process(InputStream messageIn)	Process an OpenPGP message.
OpenPGPMessageProcessor	setMissingMessagePassphraseCallback(MissingMessagePassphraseCallback callback)	Set a MissingMessagePassphraseCallback which will be invoked if the message is encrypted using a passphrase, but no working passphrase was provided.
OpenPGPMessageProcessor	setMissingOpenPGPCertificateProvider(OpenPGPKeyMaterialProvider.OpenPGPCertificateProvider certificateProvider)	Set a OpenPGPKeyMaterialProvider.OpenPGPCertificateProvider to allow dynamic requesting certificates for signature verification.
OpenPGPMessageProcessor	setMissingOpenPGPKeyPassphraseProvider(KeyPassphraseProvider keyPassphraseProvider)	Set a provider for dynamically requesting missing passphrases used to unlock encrypted OpenPGPKeys.
OpenPGPMessageProcessor	setMissingOpenPGPKeyProvider(OpenPGPKeyMaterialProvider.OpenPGPKeyProvider keyProvider)	Set a provider for OpenPGPKeys, which can be used to decrypt encrypted messages.
OpenPGPMessageProcessor	setSessionKey(PGPSessionKey sessionKey)	Set a PGPSessionKey with which an encrypted OpenPGP message can be decrypted without the need for using a private key or passphrase.
OpenPGPMessageProcessor	verifyNotAfter(Date date)
OpenPGPMessageProcessor	verifyNotBefore(Date date)

Methods inherited from class java.lang.Object

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

Constructor Details

OpenPGPMessageProcessor

public OpenPGPMessageProcessor()

Create a new OpenPGPMessageProcessor using the default OpenPGPImplementation.

OpenPGPMessageProcessor

public OpenPGPMessageProcessor(OpenPGPImplementation implementation)

Create a new OpenPGPMessageProcessor using the given OpenPGPImplementation.

Parameters:

implementation - openpgp implementation

OpenPGPMessageProcessor

public OpenPGPMessageProcessor(OpenPGPImplementation implementation,
 OpenPGPPolicy policy)

Method Details

addVerificationCertificate

public OpenPGPMessageProcessor addVerificationCertificate(OpenPGPCertificate issuerCertificate)

Add an OpenPGPCertificate for signature verification. If the message contains any signatures, the provided certificate will be considered as a candidate to verify the signature.

Parameters:

issuerCertificate - OpenPGP certificate

Returns:

this

verifyNotAfter

public OpenPGPMessageProcessor verifyNotAfter(Date date)

verifyNotBefore

public OpenPGPMessageProcessor verifyNotBefore(Date date)

addDecryptionKey

public OpenPGPMessageProcessor addDecryptionKey(OpenPGPKey key)

Add an OpenPGPKey as potential decryption key. If the message is encrypted for an OpenPGPKey, this key can be tried to decrypt the message. Keys added via this method will also be available for message decryption if the message was encrypted to an anonymous recipient (wildcard key-id / fingerprint).

Parameters:

key - OpenPGP key

Returns:

this

addDecryptionKey

public OpenPGPMessageProcessor addDecryptionKey(OpenPGPKey key,
 char[] passphrase)

Add an OpenPGPKey as potential decryption key, along with a KeyPassphraseProvider dedicated to this key. If the message is encrypted for an OpenPGPKey, this key can be tried to decrypt the message. Keys added via this method will also be available for message decryption if the message was encrypted to an anonymous recipient (wildcard key-id / fingerprint).

Parameters:

key - OpenPGP key

Returns:

this

addDecryptionKeyPassphrase

public OpenPGPMessageProcessor addDecryptionKeyPassphrase(char[] passphrase)

Add a passphrase for secret key decryption. If the corresponding OpenPGPKey which key this passphrase is for is known in advance, it is highly advised to call addDecryptionKey(OpenPGPKey, char[]) instead, due to performance reasons.

Parameters:

passphrase - key-passphrase

Returns:

this

setMissingOpenPGPKeyPassphraseProvider

public OpenPGPMessageProcessor setMissingOpenPGPKeyPassphraseProvider(KeyPassphraseProvider keyPassphraseProvider)

Set a provider for dynamically requesting missing passphrases used to unlock encrypted OpenPGPKeys. This provider is called, if a key cannot be unlocked using any passphrase provided via addDecryptionKey(OpenPGPKey, char[]).

Parameters:

keyPassphraseProvider - key passphrase provider

Returns:

this

setMissingOpenPGPCertificateProvider

public OpenPGPMessageProcessor setMissingOpenPGPCertificateProvider(OpenPGPKeyMaterialProvider.OpenPGPCertificateProvider certificateProvider)

Set a OpenPGPKeyMaterialProvider.OpenPGPCertificateProvider to allow dynamic requesting certificates for signature verification. This provider is called if the requested OpenPGPCertificate has not yet been added explicitly via addVerificationCertificate(OpenPGPCertificate). This allows lazily requesting verification certificates at runtime.

Parameters:

certificateProvider - provider for OpenPGP certificates

Returns:

this

setMissingOpenPGPKeyProvider

public OpenPGPMessageProcessor setMissingOpenPGPKeyProvider(OpenPGPKeyMaterialProvider.OpenPGPKeyProvider keyProvider)

Set a provider for OpenPGPKeys, which can be used to decrypt encrypted messages. This provider is called if an OpenPGPKey required to decrypt the message has not yet been explicitly added via addDecryptionKey(OpenPGPKey). This allows lazily requesting decryption keys at runtime.

Parameters:

keyProvider - provider for OpenPGP keys

Returns:

this

addMessagePassphrase

public OpenPGPMessageProcessor addMessagePassphrase(char[] messagePassphrase)

Set a passphrase to decrypt a symmetrically encrypted OpenPGP message.

Parameters:

messagePassphrase - passphrase for message decryption

Returns:

this

setMissingMessagePassphraseCallback

public OpenPGPMessageProcessor setMissingMessagePassphraseCallback(MissingMessagePassphraseCallback callback)

Set a MissingMessagePassphraseCallback which will be invoked if the message is encrypted using a passphrase, but no working passphrase was provided.

Parameters:

callback - callback

Returns:

this

setSessionKey

public OpenPGPMessageProcessor setSessionKey(PGPSessionKey sessionKey)

Set a PGPSessionKey with which an encrypted OpenPGP message can be decrypted without the need for using a private key or passphrase. Typically, this method can be used, if the PGPSessionKey of a message is already known (e.g. because the message has already been decrypted before). The benefit of this is, that public-key operations can be costly.

Parameters:

sessionKey - session key

Returns:

this

process

public OpenPGPMessageInputStream process(InputStream messageIn)
                                  throws IOException,
PGPException

Process an OpenPGP message.

Parameters:

messageIn - input stream of the OpenPGP message

Returns:

plaintext input stream

Throws:

IOException

PGPException