Package org.bouncycastle.openpgp.api

Class OpenPGPImplementation

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPImplementation

Direct Known Subclasses:

BcOpenPGPImplementation, JcaOpenPGPImplementation

public abstract class OpenPGPImplementation
extends Object

Bouncy Castle provides two implementations of OpenPGP operators. The

JCA/JCE

implementation makes use of Java Cryptography Architecture and the Java Cryptography Extension, while

Bc

uses Bouncy Castles Lightweight Cryptography API. The purpose of OpenPGPImplementation is to define a shared interface for instantiating concrete objects of either API. It is advised to define the desired implementation by calling setInstance(OpenPGPImplementation) and acquiring it via getInstance(), as swapping out the entire implementation can then be done by replacing the instance in one single place. This pattern was successfully explored by PGPainless.

Constructor Summary

Constructors

Constructor	Description
OpenPGPImplementation()

Method Summary

Modifier and Type	Method	Description
static OpenPGPImplementation	getInstance()	Return the currently set OpenPGPImplementation instance.
abstract KeyFingerPrintCalculator	keyFingerPrintCalculator()
abstract PBEDataDecryptorFactory	pbeDataDecryptorFactory(char[] messagePassphrase)	Return an instance of the PBEDataDecryptorFactory, which is responsible for providing concrete implementations needed to decrypt OpenPGP messages that were encrypted symmetrically with a passphrase.
abstract PBEKeyEncryptionMethodGenerator	pbeKeyEncryptionMethodGenerator(char[] messagePassphrase)	Return an instance of PBEKeyEncryptionMethodGenerator which is responsible for creating symmetric-key-based encryptors for OpenPGP messages, using S2K.SALTED_AND_ITERATED mode.
abstract PBEKeyEncryptionMethodGenerator	pbeKeyEncryptionMethodGenerator(char[] messagePassphrase, S2K.Argon2Params argon2Params)	Return an instance of PBEKeyEncryptionMethodGenerator which is responsible for creating symmetric-key-based encryptors for OpenPGP messages, using S2K.ARGON_2 mode.
abstract PBESecretKeyDecryptorBuilderProvider	pbeSecretKeyDecryptorBuilderProvider()	Return an instance of PBESecretKeyDecryptorBuilderProvider which is responsible for providing implementations needed for secret key unlocking.
abstract PBESecretKeyEncryptorFactory	pbeSecretKeyEncryptorFactory(boolean aead)
abstract PBESecretKeyEncryptorFactory	pbeSecretKeyEncryptorFactory(boolean aead, int symmetricKeyAlgorithm, int iterationCount)
abstract PGPContentSignerBuilder	pgpContentSignerBuilder(int publicKeyAlgorithm, int hashAlgorithm)	Return an instance of PGPContentSignerBuilder, which is responsible for providing concrete implementations needed for signature creation.
abstract PGPContentSignerBuilderProvider	pgpContentSignerBuilderProvider(int hashAlgorithmId)
abstract PGPContentVerifierBuilderProvider	pgpContentVerifierBuilderProvider()	Return an instance of PGPContentVerifierBuilderProvider which is responsible for providing implementations needed for signature verification.
abstract PGPDataEncryptorBuilder	pgpDataEncryptorBuilder(int symmetricKeyAlgorithm)	Return an instance of PGPDataEncryptorBuilder which is responsible for providing implementations needed for creating encrypted data packets.
abstract PGPDigestCalculatorProvider	pgpDigestCalculatorProvider()	Return an instance of the PGPDigestCalculatorProvider, which is responsible for providing concrete PGPDigestCalculator implementations.
abstract PGPKeyPairGeneratorProvider	pgpKeyPairGeneratorProvider()
abstract PGPObjectFactory	pgpObjectFactory(InputStream packetInputStream)	Return an instance of PGPObjectFactory based on the given InputStream.
OpenPGPPolicy	policy()
abstract PublicKeyDataDecryptorFactory	publicKeyDataDecryptorFactory(PGPPrivateKey decryptionKey)	Return an instance of the PublicKeyDataDecryptorFactory, which is responsible for providing concrete implementations needed to decrypt OpenPGP messages using a PGPPrivateKey.
abstract PublicKeyKeyEncryptionMethodGenerator	publicKeyKeyEncryptionMethodGenerator(PGPPublicKey encryptionSubkey)	Return an instance of PublicKeyKeyEncryptionMethodGenerator which is responsible for creating public-key-based encryptors for OpenPGP messages.
abstract SessionKeyDataDecryptorFactory	sessionKeyDataDecryptorFactory(PGPSessionKey sessionKey)	Return an instance of the SessionKeyDataDecryptorFactory, which is responsible for providing concrete implementations needed to decrypt OpenPGP messages using a PGPSessionKey.
static void	setInstance(OpenPGPImplementation implementation)	Replace the OpenPGPImplementation instance that is returned by getInstance().
OpenPGPImplementation	setPolicy(OpenPGPPolicy policy)

Methods inherited from class java.lang.Object

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

Constructor Details

OpenPGPImplementation

public OpenPGPImplementation()

Method Details

setInstance

public static void setInstance(OpenPGPImplementation implementation)

Replace the OpenPGPImplementation instance that is returned by getInstance().

Parameters:

implementation - instance

getInstance

public static OpenPGPImplementation getInstance()

Return the currently set OpenPGPImplementation instance. The default is BcOpenPGPImplementation.

Returns:

instance

policy

public OpenPGPPolicy policy()

setPolicy

public OpenPGPImplementation setPolicy(OpenPGPPolicy policy)

pgpObjectFactory

public abstract PGPObjectFactory pgpObjectFactory(InputStream packetInputStream)

Return an instance of PGPObjectFactory based on the given InputStream.

Parameters:

packetInputStream - packet input stream

Returns:

object factory

pgpContentVerifierBuilderProvider

public abstract PGPContentVerifierBuilderProvider pgpContentVerifierBuilderProvider()

Return an instance of PGPContentVerifierBuilderProvider which is responsible for providing implementations needed for signature verification.

Returns:

content verifier builder provider

pbeSecretKeyDecryptorBuilderProvider

public abstract PBESecretKeyDecryptorBuilderProvider pbeSecretKeyDecryptorBuilderProvider()

Return an instance of PBESecretKeyDecryptorBuilderProvider which is responsible for providing implementations needed for secret key unlocking.

Returns:

secret key decryptor builder provider

pgpDataEncryptorBuilder

public abstract PGPDataEncryptorBuilder pgpDataEncryptorBuilder(int symmetricKeyAlgorithm)

Return an instance of PGPDataEncryptorBuilder which is responsible for providing implementations needed for creating encrypted data packets.

Parameters:

symmetricKeyAlgorithm - symmetric encryption algorithm

Returns:

data encryptor builder

publicKeyKeyEncryptionMethodGenerator

public abstract PublicKeyKeyEncryptionMethodGenerator publicKeyKeyEncryptionMethodGenerator(PGPPublicKey encryptionSubkey)

Return an instance of PublicKeyKeyEncryptionMethodGenerator which is responsible for creating public-key-based encryptors for OpenPGP messages. Public-key-based encryptors are used when a message is encrypted for a recipients public key.

Parameters:

encryptionSubkey - subkey for which a message shall be encrypted

Returns:

public-key key-encryption method generator

pbeKeyEncryptionMethodGenerator

public abstract PBEKeyEncryptionMethodGenerator pbeKeyEncryptionMethodGenerator(char[] messagePassphrase)

Return an instance of PBEKeyEncryptionMethodGenerator which is responsible for creating symmetric-key-based encryptors for OpenPGP messages, using S2K.SALTED_AND_ITERATED mode. Symmetric-key-based encryptors are used when a message is encrypted using a passphrase.

Parameters:

messagePassphrase - passphrase to encrypt the message with

Returns:

pbe key encryption method generator

pbeKeyEncryptionMethodGenerator

public abstract PBEKeyEncryptionMethodGenerator pbeKeyEncryptionMethodGenerator(char[] messagePassphrase,
 S2K.Argon2Params argon2Params)

Return an instance of PBEKeyEncryptionMethodGenerator which is responsible for creating symmetric-key-based encryptors for OpenPGP messages, using S2K.ARGON_2 mode. Symmetric-key-based encryptors are used when a message is encrypted using a passphrase.

Parameters:

messagePassphrase - passphrase to encrypt the message with

argon2Params - parameters for the Argon2 hash function

Returns:

pbe key encryption method generator

pgpContentSignerBuilder

public abstract PGPContentSignerBuilder pgpContentSignerBuilder(int publicKeyAlgorithm,
 int hashAlgorithm)

Return an instance of PGPContentSignerBuilder, which is responsible for providing concrete implementations needed for signature creation.

Parameters:

publicKeyAlgorithm - the signing-keys public-key algorithm

hashAlgorithm - signature hash algorithm

Returns:

content signer builder

pbeDataDecryptorFactory

public abstract PBEDataDecryptorFactory pbeDataDecryptorFactory(char[] messagePassphrase)
                                                         throws PGPException

Return an instance of the PBEDataDecryptorFactory, which is responsible for providing concrete implementations needed to decrypt OpenPGP messages that were encrypted symmetrically with a passphrase.

Parameters:

messagePassphrase - message passphrase

Returns:

pbe data decryptor factory

Throws:

PGPException - if the factory cannot be instantiated

sessionKeyDataDecryptorFactory

public abstract SessionKeyDataDecryptorFactory sessionKeyDataDecryptorFactory(PGPSessionKey sessionKey)

Return an instance of the SessionKeyDataDecryptorFactory, which is responsible for providing concrete implementations needed to decrypt OpenPGP messages using a PGPSessionKey.

Parameters:

sessionKey - session key

Returns:

session-key data decryptor factory

publicKeyDataDecryptorFactory

public abstract PublicKeyDataDecryptorFactory publicKeyDataDecryptorFactory(PGPPrivateKey decryptionKey)

Return an instance of the PublicKeyDataDecryptorFactory, which is responsible for providing concrete implementations needed to decrypt OpenPGP messages using a PGPPrivateKey.

Parameters:

decryptionKey - private decryption key

Returns:

public-key data decryptor factory

pgpDigestCalculatorProvider

public abstract PGPDigestCalculatorProvider pgpDigestCalculatorProvider()
                                                                 throws PGPException

Return an instance of the PGPDigestCalculatorProvider, which is responsible for providing concrete PGPDigestCalculator implementations.

Returns:

pgp digest calculator provider

Throws:

PGPException - if the provider cannot be instantiated

pgpKeyPairGeneratorProvider

public abstract PGPKeyPairGeneratorProvider pgpKeyPairGeneratorProvider()

pgpContentSignerBuilderProvider

public abstract PGPContentSignerBuilderProvider pgpContentSignerBuilderProvider(int hashAlgorithmId)

keyFingerPrintCalculator

public abstract KeyFingerPrintCalculator keyFingerPrintCalculator()

pbeSecretKeyEncryptorFactory

public abstract PBESecretKeyEncryptorFactory pbeSecretKeyEncryptorFactory(boolean aead)
                                                                   throws PGPException

Throws:

PGPException

pbeSecretKeyEncryptorFactory

public abstract PBESecretKeyEncryptorFactory pbeSecretKeyEncryptorFactory(boolean aead,
 int symmetricKeyAlgorithm,
 int iterationCount)
                                                                   throws PGPException

Throws:

PGPException