Class JcePGPDataEncryptorBuilder
java.lang.Object
org.bouncycastle.openpgp.operator.jcajce.JcePGPDataEncryptorBuilder
- All Implemented Interfaces:
PGPDataEncryptorBuilder
PGPDataEncryptorBuilder
implementation that sources cryptographic primitives using the
JCE APIs.
By default, cryptographic primitives will be loaded using the default JCE load order (i.e.
without specifying a provider).
A specific provider can be specified using one of the setProvider(String)
methods.
-
Constructor Summary
ConstructorsConstructorDescriptionJcePGPDataEncryptorBuilder
(int encAlgorithm) Constructs a new data encryptor builder for a specified cipher type. -
Method Summary
Modifier and TypeMethodDescriptionbuild
(byte[] keyBytes) Builds a data encryptor using the algorithm configured for this builder.int
The encryption algorithm used by data encryptors created by this builder.Gets the SecureRandom instance used by this builder.setProvider
(String providerName) Sets the JCE provider to source cryptographic primitives from.setProvider
(Provider provider) Sets the JCE provider to source cryptographic primitives from.setSecureRandom
(SecureRandom random) Provide a user defined source of randomness.setWithIntegrityPacket
(boolean withIntegrityPacket) Sets whether or not the resulting encrypted data will be protected using an integrity packet.
-
Constructor Details
-
JcePGPDataEncryptorBuilder
public JcePGPDataEncryptorBuilder(int encAlgorithm) Constructs a new data encryptor builder for a specified cipher type.- Parameters:
encAlgorithm
- one of thesupported symmetric cipher algorithms
. May not beSymmetricKeyAlgorithmTags.NULL
.
-
-
Method Details
-
setWithIntegrityPacket
Sets whether or not the resulting encrypted data will be protected using an integrity packet.- Specified by:
setWithIntegrityPacket
in interfacePGPDataEncryptorBuilder
- Parameters:
withIntegrityPacket
- true if an integrity packet is to be included, false otherwise.- Returns:
- the current builder.
-
setProvider
Sets the JCE provider to source cryptographic primitives from.- Parameters:
provider
- the JCE provider to use.- Returns:
- the current builder.
-
setProvider
Sets the JCE provider to source cryptographic primitives from.- Parameters:
providerName
- the name of the JCE provider to use.- Returns:
- the current builder.
-
setSecureRandom
Provide a user defined source of randomness.If no SecureRandom is configured, a default SecureRandom will be used.
- Parameters:
random
- the secure random to be used.- Returns:
- the current builder.
-
getAlgorithm
public int getAlgorithm()Description copied from interface:PGPDataEncryptorBuilder
The encryption algorithm used by data encryptors created by this builder.- Specified by:
getAlgorithm
in interfacePGPDataEncryptorBuilder
- Returns:
- one of the
symmetric encryption algorithms
.
-
getSecureRandom
Description copied from interface:PGPDataEncryptorBuilder
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.- Specified by:
getSecureRandom
in interfacePGPDataEncryptorBuilder
-
build
Description copied from interface:PGPDataEncryptorBuilder
Builds a data encryptor using the algorithm configured for this builder.- Specified by:
build
in interfacePGPDataEncryptorBuilder
- Parameters:
keyBytes
- the bytes of the key to use for the cipher.- Returns:
- a data encryptor with an initialised cipher.
- Throws:
PGPException
- if an error occurs initialising the configured encryption.
-