Package org.bouncycastle.openpgp.api.jcajce

Class JcaOpenPGPImplementation

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPImplementation

org.bouncycastle.openpgp.api.jcajce.JcaOpenPGPImplementation

public class JcaOpenPGPImplementation
extends OpenPGPImplementation

Implementation of OpenPGPImplementation using the JCA/JCE implementation of OpenPGP classes.

Constructor Summary

Constructors

Constructor	Description
JcaOpenPGPImplementation()
JcaOpenPGPImplementation(Provider provider, SecureRandom secureRandom)

Method Summary

Modifier and Type	Method	Description
KeyFingerPrintCalculator	keyFingerPrintCalculator()
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.
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.
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.
PBESecretKeyDecryptorBuilderProvider	pbeSecretKeyDecryptorBuilderProvider()	Return an instance of PBESecretKeyDecryptorBuilderProvider which is responsible for providing implementations needed for secret key unlocking.
PBESecretKeyEncryptorFactory	pbeSecretKeyEncryptorFactory(boolean aead)
PBESecretKeyEncryptorFactory	pbeSecretKeyEncryptorFactory(boolean aead, int symmetricKeyAlgorithm, int iterationCount)
PGPContentSignerBuilder	pgpContentSignerBuilder(int publicKeyAlgorithm, int hashAlgorithm)	Return an instance of PGPContentSignerBuilder, which is responsible for providing concrete implementations needed for signature creation.
PGPContentSignerBuilderProvider	pgpContentSignerBuilderProvider(int hashAlgorithmId)
PGPContentVerifierBuilderProvider	pgpContentVerifierBuilderProvider()	Return an instance of PGPContentVerifierBuilderProvider which is responsible for providing implementations needed for signature verification.
PGPDataEncryptorBuilder	pgpDataEncryptorBuilder(int symmetricKeyAlgorithm)	Return an instance of PGPDataEncryptorBuilder which is responsible for providing implementations needed for creating encrypted data packets.
PGPDigestCalculatorProvider	pgpDigestCalculatorProvider()	Return an instance of the PGPDigestCalculatorProvider, which is responsible for providing concrete PGPDigestCalculator implementations.
PGPKeyPairGeneratorProvider	pgpKeyPairGeneratorProvider()
PGPObjectFactory	pgpObjectFactory(InputStream packetInputStream)	Return an instance of PGPObjectFactory based on the given InputStream.
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.
PublicKeyKeyEncryptionMethodGenerator	publicKeyKeyEncryptionMethodGenerator(PGPPublicKey encryptionSubkey)	Return an instance of PublicKeyKeyEncryptionMethodGenerator which is responsible for creating public-key-based encryptors for OpenPGP messages.
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.

Methods inherited from class org.bouncycastle.openpgp.api.OpenPGPImplementation

getInstance, policy, setInstance, setPolicy

Methods inherited from class java.lang.Object

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

Constructor Details

JcaOpenPGPImplementation

public JcaOpenPGPImplementation()

JcaOpenPGPImplementation

public JcaOpenPGPImplementation(Provider provider,
 SecureRandom secureRandom)

Method Details

pgpObjectFactory

public PGPObjectFactory pgpObjectFactory(InputStream packetInputStream)

Description copied from class: OpenPGPImplementation

Return an instance of PGPObjectFactory based on the given InputStream.

Specified by:

pgpObjectFactory in class OpenPGPImplementation

Parameters:

packetInputStream - packet input stream

Returns:

object factory

pgpContentVerifierBuilderProvider

public PGPContentVerifierBuilderProvider pgpContentVerifierBuilderProvider()

Description copied from class: OpenPGPImplementation

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

Specified by:

pgpContentVerifierBuilderProvider in class OpenPGPImplementation

Returns:

content verifier builder provider

pbeSecretKeyDecryptorBuilderProvider

public PBESecretKeyDecryptorBuilderProvider pbeSecretKeyDecryptorBuilderProvider()

Description copied from class: OpenPGPImplementation

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

Specified by:

pbeSecretKeyDecryptorBuilderProvider in class OpenPGPImplementation

Returns:

secret key decryptor builder provider

pgpDataEncryptorBuilder

public PGPDataEncryptorBuilder pgpDataEncryptorBuilder(int symmetricKeyAlgorithm)

Description copied from class: OpenPGPImplementation

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

Specified by:

pgpDataEncryptorBuilder in class OpenPGPImplementation

Parameters:

symmetricKeyAlgorithm - symmetric encryption algorithm

Returns:

data encryptor builder

publicKeyKeyEncryptionMethodGenerator

public PublicKeyKeyEncryptionMethodGenerator publicKeyKeyEncryptionMethodGenerator(PGPPublicKey encryptionSubkey)

Description copied from class: OpenPGPImplementation

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.

Specified by:

publicKeyKeyEncryptionMethodGenerator in class OpenPGPImplementation

Parameters:

encryptionSubkey - subkey for which a message shall be encrypted

Returns:

public-key key-encryption method generator

pbeKeyEncryptionMethodGenerator

public PBEKeyEncryptionMethodGenerator pbeKeyEncryptionMethodGenerator(char[] messagePassphrase)

Description copied from class: OpenPGPImplementation

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.

Specified by:

pbeKeyEncryptionMethodGenerator in class OpenPGPImplementation

Parameters:

messagePassphrase - passphrase to encrypt the message with

Returns:

pbe key encryption method generator

pbeKeyEncryptionMethodGenerator

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

Description copied from class: OpenPGPImplementation

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.

Specified by:

pbeKeyEncryptionMethodGenerator in class OpenPGPImplementation

Parameters:

messagePassphrase - passphrase to encrypt the message with

argon2Params - parameters for the Argon2 hash function

Returns:

pbe key encryption method generator

pgpContentSignerBuilder

public PGPContentSignerBuilder pgpContentSignerBuilder(int publicKeyAlgorithm,
 int hashAlgorithm)

Description copied from class: OpenPGPImplementation

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

Specified by:

pgpContentSignerBuilder in class OpenPGPImplementation

Parameters:

publicKeyAlgorithm - the signing-keys public-key algorithm

hashAlgorithm - signature hash algorithm

Returns:

content signer builder

pbeDataDecryptorFactory

public PBEDataDecryptorFactory pbeDataDecryptorFactory(char[] messagePassphrase)
                                                throws PGPException

Description copied from class: OpenPGPImplementation

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.

Specified by:

pbeDataDecryptorFactory in class OpenPGPImplementation

Parameters:

messagePassphrase - message passphrase

Returns:

pbe data decryptor factory

Throws:

PGPException - if the factory cannot be instantiated

sessionKeyDataDecryptorFactory

public SessionKeyDataDecryptorFactory sessionKeyDataDecryptorFactory(PGPSessionKey sessionKey)

Description copied from class: OpenPGPImplementation

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

Specified by:

sessionKeyDataDecryptorFactory in class OpenPGPImplementation

Parameters:

sessionKey - session key

Returns:

session-key data decryptor factory

publicKeyDataDecryptorFactory

public PublicKeyDataDecryptorFactory publicKeyDataDecryptorFactory(PGPPrivateKey decryptionKey)

Description copied from class: OpenPGPImplementation

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

Specified by:

publicKeyDataDecryptorFactory in class OpenPGPImplementation

Parameters:

decryptionKey - private decryption key

Returns:

public-key data decryptor factory

pgpDigestCalculatorProvider

public PGPDigestCalculatorProvider pgpDigestCalculatorProvider()
                                                        throws PGPException

Description copied from class: OpenPGPImplementation

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

Specified by:

pgpDigestCalculatorProvider in class OpenPGPImplementation

Returns:

pgp digest calculator provider

Throws:

PGPException - if the provider cannot be instantiated

pgpKeyPairGeneratorProvider

public PGPKeyPairGeneratorProvider pgpKeyPairGeneratorProvider()

Specified by:

pgpKeyPairGeneratorProvider in class OpenPGPImplementation

pgpContentSignerBuilderProvider

public PGPContentSignerBuilderProvider pgpContentSignerBuilderProvider(int hashAlgorithmId)

Specified by:

pgpContentSignerBuilderProvider in class OpenPGPImplementation

keyFingerPrintCalculator

public KeyFingerPrintCalculator keyFingerPrintCalculator()

Specified by:

keyFingerPrintCalculator in class OpenPGPImplementation

pbeSecretKeyEncryptorFactory

public PBESecretKeyEncryptorFactory pbeSecretKeyEncryptorFactory(boolean aead)
                                                          throws PGPException

Specified by:

pbeSecretKeyEncryptorFactory in class OpenPGPImplementation

Throws:

PGPException

pbeSecretKeyEncryptorFactory

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

Specified by:

pbeSecretKeyEncryptorFactory in class OpenPGPImplementation

Throws:

PGPException