Package org.bouncycastle.openpgp.operator

Interface PGPDataDecryptorFactory

All Known Subinterfaces:

PublicKeyDataDecryptorFactory, SessionKeyDataDecryptorFactory

All Known Implementing Classes:

AbstractPublicKeyDataDecryptorFactory, BcPBEDataDecryptorFactory, BcPublicKeyDataDecryptorFactory, BcSessionKeyDataDecryptorFactory, PBEDataDecryptorFactory

public interface PGPDataDecryptorFactory

Base interface of factories for PGPDataDecryptor.

Method Summary

Modifier and Type	Method	Description
PGPDataDecryptor	createDataDecryptor(boolean withIntegrityPacket, int encAlgorithm, byte[] key)	Constructs a data decryptor for SED or v1 SEIPD packets.
PGPDataDecryptor	createDataDecryptor(AEADEncDataPacket aeadEncDataPacket, PGPSessionKey sessionKey)	Constructs a data decryptor for AEAD Encrypted Data packets.
PGPDataDecryptor	createDataDecryptor(SymmetricEncIntegrityPacket seipd, PGPSessionKey sessionKey)	Constructs a data decryptor for v2 SEIPD packets.

Method Detail

createDataDecryptor

PGPDataDecryptor createDataDecryptor(boolean withIntegrityPacket,
                                     int encAlgorithm,
                                     byte[] key)
                              throws PGPException

Constructs a data decryptor for SED or v1 SEIPD packets.

Parameters:

withIntegrityPacket - true if the packet to be decrypted has integrity checking enabled.

encAlgorithm - the identifier of the encryption algorithm to decrypt with.

key - the bytes of the key for the cipher.

Returns:

a data decryptor that can decrypt (and verify) streams of encrypted data.

Throws:

PGPException - if an error occurs initialising the decryption and integrity checking functions.

createDataDecryptor

PGPDataDecryptor createDataDecryptor(AEADEncDataPacket aeadEncDataPacket,
                                     PGPSessionKey sessionKey)
                              throws PGPException

Constructs a data decryptor for AEAD Encrypted Data packets. This method is used with OpenPGP v5 AEAD.

Parameters:

aeadEncDataPacket - AEAD encrypted data packet

sessionKey - decrypted session key

Returns:

a data decryptor that can decrypt (and verify) streams of encrypted data.

Throws:

PGPException - if an error occurs initialising the decryption and integrity checking functions.

createDataDecryptor

PGPDataDecryptor createDataDecryptor(SymmetricEncIntegrityPacket seipd,
                                     PGPSessionKey sessionKey)
                              throws PGPException

Constructs a data decryptor for v2 SEIPD packets. This method is used with OpenPGP v6 AEAD.

Parameters:

seipd - version 2 symmetrically encrypted integrity-protected data packet using AEAD.

sessionKey - decrypted session key

Returns:

a data decryptor that can decrypt (and verify) streams of encrypted data.

Throws:

PGPException - if an error occurs initialising the decryption and integrity checking functions.