Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.openpgp.operator.PGPDataEncryptorBuilder

Method Summary

Modifier and Type	Method and Description
public PGPDataEncryptor	Returns: a data encryptor with an initialised cipher. build(byte[] the bytes of the key to use for the cipher. keyBytes) Builds a data encryptor using the algorithm configured for this builder.
public int	getAeadAlgorithm()
public int	Returns: one of the `symmetric encryption algorithms`. getAlgorithm() The encryption algorithm used by data encryptors created by this builder.
public int	getChunkSize()
public SecureRandom	getSecureRandom() Gets the SecureRandom instance used by this builder.
public boolean	isV5StyleAEAD()
public PGPDataEncryptorBuilder	Returns: the current builder setUseV5AEAD() Specify we are using V5 AEAD.
public PGPDataEncryptorBuilder	Returns: the current builder setUseV6AEAD() Specify we are using V6 AEAD.
public PGPDataEncryptorBuilder	Returns: the current builder setWithAEAD(int the AEAD mode to use. aeadAlgorithm, int the size of the chunks to be processed with each nonce. chunkSize) Sets whether the resulting encrypted data will be protected using an AEAD mode.
public PGPDataEncryptorBuilder	Returns: the current builder. setWithIntegrityPacket(boolean true if an integrity packet is to be included, false otherwise. withIntegrityPacket) Sets whether or not the resulting encrypted data will be protected using an integrity packet.

Method Detail

build	back to summary
public PGPDataEncryptor build(byte[] keyBytes) throws PGPException Builds a data encryptor using the algorithm configured for this builder. Parameters keyBytes:byte[] the bytes of the key to use for the cipher. Returns:PGPDataEncryptor a data encryptor with an initialised cipher. Exceptions PGPException: if an error occurs initialising the configured encryption.

build

back to summary

public PGPDataEncryptor build(byte[] keyBytes) throws PGPException

Builds a data encryptor using the algorithm configured for this builder.

Parameters

keyBytes:byte[]: the bytes of the key to use for the cipher.

Returns:PGPDataEncryptor

a data encryptor with an initialised cipher.

Exceptions

PGPException:: if an error occurs initialising the configured encryption.

getAeadAlgorithm	back to summary
public int getAeadAlgorithm()

getAlgorithm back to summary

getAlgorithm	back to summary
public int getAlgorithm() The encryption algorithm used by data encryptors created by this builder. Returns:int one of the `symmetric encryption algorithms`.

public int getAlgorithm()

The encryption algorithm used by data encryptors created by this builder.

Returns:int: one of the symmetric encryption algorithms.

getChunkSize	back to summary
public int getChunkSize()

getSecureRandom back to summary

getSecureRandom	back to summary
public SecureRandom getSecureRandom() Gets the SecureRandom instance used by this builder. If a SecureRandom has not been explicitly configured, a default `SecureRandom` is constructed and retained by the this builder.

public SecureRandom getSecureRandom()

Gets the SecureRandom instance used by this builder.

If a SecureRandom has not been explicitly configured, a default SecureRandom is constructed and retained by the this builder.

isV5StyleAEAD	back to summary
public boolean isV5StyleAEAD()

setUseV5AEAD	back to summary
public PGPDataEncryptorBuilder setUseV5AEAD() Specify we are using V5 AEAD. Returns:PGPDataEncryptorBuilder the current builder

setUseV5AEAD

back to summary

public PGPDataEncryptorBuilder setUseV5AEAD()

Specify we are using V5 AEAD.

Returns:PGPDataEncryptorBuilder: the current builder

setUseV6AEAD	back to summary
public PGPDataEncryptorBuilder setUseV6AEAD() Specify we are using V6 AEAD. Returns:PGPDataEncryptorBuilder the current builder

setUseV6AEAD

back to summary

public PGPDataEncryptorBuilder setUseV6AEAD()

Specify we are using V6 AEAD.

Returns:PGPDataEncryptorBuilder: the current builder

setWithAEAD	back to summary
public PGPDataEncryptorBuilder setWithAEAD(int aeadAlgorithm, int chunkSize) Sets whether the resulting encrypted data will be protected using an AEAD mode. The chunkSize is used as a power of two, result in blocks (1 << chunkSize) containing data with an extra 16 bytes for the tag. The minimum chunkSize is 6. Parameters aeadAlgorithm:int the AEAD mode to use. chunkSize:int the size of the chunks to be processed with each nonce. Returns:PGPDataEncryptorBuilder the current builder

setWithAEAD

back to summary

public PGPDataEncryptorBuilder setWithAEAD(int aeadAlgorithm, int chunkSize)

Sets whether the resulting encrypted data will be protected using an AEAD mode. The chunkSize is used as a power of two, result in blocks (1 << chunkSize) containing data with an extra 16 bytes for the tag. The minimum chunkSize is 6.

Parameters

aeadAlgorithm:int: the AEAD mode to use.
chunkSize:int: the size of the chunks to be processed with each nonce.

Returns:PGPDataEncryptorBuilder

the current builder

setWithIntegrityPacket	back to summary
public PGPDataEncryptorBuilder setWithIntegrityPacket(boolean withIntegrityPacket) Sets whether or not the resulting encrypted data will be protected using an integrity packet. Parameters withIntegrityPacket:boolean true if an integrity packet is to be included, false otherwise. Returns:PGPDataEncryptorBuilder the current builder.

setWithIntegrityPacket

back to summary

public PGPDataEncryptorBuilder setWithIntegrityPacket(boolean withIntegrityPacket)

Sets whether or not the resulting encrypted data will be protected using an integrity packet.

Parameters

withIntegrityPacket:boolean: true if an integrity packet is to be included, false otherwise.

Returns:PGPDataEncryptorBuilder

the current builder.

public Interface PGPDataEncryptorBuilder

Method Summary

Method Detail