Modifier and Type	Class and Description
private class	JceCMSContentEncryptorBuilder.CMSAuthOutputEncryptor
private class	JceCMSContentEncryptorBuilder.CMSOutputEncryptor

Access	Constructor and Description
public	JceCMSContentEncryptorBuilder(ASN1ObjectIdentifier encryptionOID)
public	JceCMSContentEncryptorBuilder(ASN1ObjectIdentifier encryptionOID, int keySize)
public	JceCMSContentEncryptorBuilder(AlgorithmIdentifier the full algorithm identifier for the encryption. encryptionAlgId) Constructor for a content encryptor builder based on an algorithm identifier and its contained parameters.

Method Summary

Modifier and Type	Method and Description
public OutputEncryptor	build()
private static boolean	checkForAEAD()
private static SecureRandom	Returns: the SecureRandom parameter if it is not null, or else the default SecureRandom getSecureRandom(SecureRandom the SecureRandom to use if it is not null. secureRandom) Return either the passed-in SecureRandom, or if it is null, then the default source of randomness.
public JceCMSContentEncryptorBuilder	Returns: the current builder instance. setAlgorithmParameters(AlgorithmParameters algorithmParameters for content encryption. algorithmParameters) Provide a set of algorithm parameters for the content encryption cipher to use.
public JceCMSContentEncryptorBuilder	Returns: the current builder instance. setProvider(Provider the provider object to use for cipher and default parameters creation. provider) Set the provider to use for content encryption.
public JceCMSContentEncryptorBuilder	Returns: the current builder instance. setProvider(String the name of the provider to use for cipher and default parameters creation. providerName) Set the provider to use for content encryption (by name)
public JceCMSContentEncryptorBuilder	Returns: the current builder instance. setSecureRandom(SecureRandom the secure random to use. random) Provide a specified source of randomness to be used for session key and IV/nonce generation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

algorithmIdentifier	back to summary
private AlgorithmIdentifier algorithmIdentifier

algorithmParameters	back to summary
private AlgorithmParameters algorithmParameters

encryptionOID	back to summary
private final ASN1ObjectIdentifier encryptionOID

helper	back to summary
private EnvelopedDataHelper helper

KEY_SIZE_PROVIDER	back to summary
private static final SecretKeySizeProvider KEY_SIZE_PROVIDER

keySize	back to summary
private final int keySize

random	back to summary
private SecureRandom random

JceCMSContentEncryptorBuilder	back to summary
public JceCMSContentEncryptorBuilder(ASN1ObjectIdentifier encryptionOID)

JceCMSContentEncryptorBuilder	back to summary
public JceCMSContentEncryptorBuilder(ASN1ObjectIdentifier encryptionOID, int keySize)

JceCMSContentEncryptorBuilder	back to summary
public JceCMSContentEncryptorBuilder(AlgorithmIdentifier encryptionAlgId) Constructor for a content encryptor builder based on an algorithm identifier and its contained parameters. Parameters encryptionAlgId:AlgorithmIdentifier the full algorithm identifier for the encryption.

Method Detail

build	back to summary
public OutputEncryptor build() throws CMSException

checkForAEAD	back to summary
private static boolean checkForAEAD()

getSecureRandom	back to summary
private static SecureRandom getSecureRandom(SecureRandom secureRandom) Return either the passed-in SecureRandom, or if it is null, then the default source of randomness. Parameters secureRandom:SecureRandom the SecureRandom to use if it is not null. Returns:SecureRandom the SecureRandom parameter if it is not null, or else the default SecureRandom

getSecureRandom

back to summary

private static SecureRandom getSecureRandom(SecureRandom secureRandom)

Return either the passed-in SecureRandom, or if it is null, then the default source of randomness.

Parameters

secureRandom:SecureRandom: the SecureRandom to use if it is not null.

Returns:SecureRandom

the SecureRandom parameter if it is not null, or else the default SecureRandom

setAlgorithmParameters	back to summary
public JceCMSContentEncryptorBuilder setAlgorithmParameters(AlgorithmParameters algorithmParameters) Provide a set of algorithm parameters for the content encryption cipher to use. Parameters algorithmParameters:AlgorithmParameters algorithmParameters for content encryption. Returns:JceCMSContentEncryptorBuilder the current builder instance.

setAlgorithmParameters

back to summary

public JceCMSContentEncryptorBuilder setAlgorithmParameters(AlgorithmParameters algorithmParameters)

Provide a set of algorithm parameters for the content encryption cipher to use.

Parameters

algorithmParameters:AlgorithmParameters: algorithmParameters for content encryption.

Returns:JceCMSContentEncryptorBuilder

the current builder instance.

setProvider	back to summary
public JceCMSContentEncryptorBuilder setProvider(Provider provider) Set the provider to use for content encryption. Parameters provider:Provider the provider object to use for cipher and default parameters creation. Returns:JceCMSContentEncryptorBuilder the current builder instance.

setProvider

back to summary

public JceCMSContentEncryptorBuilder setProvider(Provider provider)

Set the provider to use for content encryption.

Parameters

provider:Provider: the provider object to use for cipher and default parameters creation.

Returns:JceCMSContentEncryptorBuilder

the current builder instance.

setProvider	back to summary
public JceCMSContentEncryptorBuilder setProvider(String providerName) Set the provider to use for content encryption (by name) Parameters providerName:String the name of the provider to use for cipher and default parameters creation. Returns:JceCMSContentEncryptorBuilder the current builder instance.

setProvider

back to summary

public JceCMSContentEncryptorBuilder setProvider(String providerName)

Set the provider to use for content encryption (by name)

Parameters

providerName:String: the name of the provider to use for cipher and default parameters creation.

Returns:JceCMSContentEncryptorBuilder

the current builder instance.

setSecureRandom	back to summary
public JceCMSContentEncryptorBuilder setSecureRandom(SecureRandom random) Provide a specified source of randomness to be used for session key and IV/nonce generation. Parameters random:SecureRandom the secure random to use. Returns:JceCMSContentEncryptorBuilder the current builder instance.

setSecureRandom

back to summary

public JceCMSContentEncryptorBuilder setSecureRandom(SecureRandom random)

Provide a specified source of randomness to be used for session key and IV/nonce generation.

Parameters

random:SecureRandom: the secure random to use.

Returns:JceCMSContentEncryptorBuilder

the current builder instance.

org.bouncycastle.cms.jcajce back to summary

private Class JceCMSContentEncryptorBuilder.CMSAuthOutputEncryptor

Class Inheritance

extends Object
implements OutputAEADEncryptor

java.lang.Object
org.bouncycastle.cms.jcajce.JceCMSContentEncryptorBuilder.CMSAuthOutputEncryptor

All Implemented Interfaces

org.bouncycastle.operator.OutputAEADEncryptor, org.bouncycastle.operator.AADProcessor, org.bouncycastle.operator.OutputEncryptor

Field Summary

Modifier and Type	Field and Description
private AlgorithmIdentifier	algorithmIdentifier
private Cipher	cipher
private SecretKey	encKey
private MacCaptureStream	macOut

Constructor Summary

Access	Constructor and Description
pack-priv	CMSAuthOutputEncryptor(ASN1ObjectIdentifier encryptionOID, int keySize, AlgorithmParameters params, SecureRandom random)

Method Summary

Modifier and Type	Method and Description
public OutputStream	getAADStream() Implements org.bouncycastle.operator.AADProcessor.getAADStream. Return a stream to write associated data to in order to have it incorporated into the AEAD cipher's MAC.
public AlgorithmIdentifier	getAlgorithmIdentifier() Implements org.bouncycastle.operator.OutputEncryptor.getAlgorithmIdentifier. Return the algorithm identifier describing the encryption algorithm and parameters this encryptor uses.
public GenericKey	getKey() Implements org.bouncycastle.operator.OutputEncryptor.getKey. Return the key used for encrypting the output.
public byte[]	getMAC() Implements org.bouncycastle.operator.AADProcessor.getMAC. Return the final value of AEAD cipher's MAC.
public OutputStream	getOutputStream(OutputStream output stream for encrypted output. dOut) Implements org.bouncycastle.operator.OutputEncryptor.getOutputStream. Wrap the passed in output stream encOut, returning an output stream that encrypts anything passed in before sending on to encOut.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

algorithmIdentifier	back to summary
private AlgorithmIdentifier algorithmIdentifier

cipher	back to summary
private Cipher cipher

encKey	back to summary
private SecretKey encKey

macOut	back to summary
private MacCaptureStream macOut

Constructor Detail

CMSAuthOutputEncryptor	back to summary
pack-priv CMSAuthOutputEncryptor(ASN1ObjectIdentifier encryptionOID, int keySize, AlgorithmParameters params, SecureRandom random) throws CMSException

Method Detail

getAADStream	back to summary
public OutputStream getAADStream() Implements org.bouncycastle.operator.AADProcessor.getAADStream. Doc from org.bouncycastle.operator.AADProcessor.getAADStream. Return a stream to write associated data to in order to have it incorporated into the AEAD cipher's MAC. Returns:OutputStream a stream for collecting associated data.

getAADStream

back to summary

public OutputStream getAADStream()

Implements org.bouncycastle.operator.AADProcessor.getAADStream.

Doc from org.bouncycastle.operator.AADProcessor.getAADStream.

Return a stream to write associated data to in order to have it incorporated into the AEAD cipher's MAC.

Returns:OutputStream: a stream for collecting associated data.

getAlgorithmIdentifier	back to summary
public AlgorithmIdentifier getAlgorithmIdentifier() Implements org.bouncycastle.operator.OutputEncryptor.getAlgorithmIdentifier. Doc from org.bouncycastle.operator.OutputEncryptor.getAlgorithmIdentifier. Return the algorithm identifier describing the encryption algorithm and parameters this encryptor uses. Returns:AlgorithmIdentifier algorithm oid and parameters.

getAlgorithmIdentifier

back to summary

public AlgorithmIdentifier getAlgorithmIdentifier()

Implements org.bouncycastle.operator.OutputEncryptor.getAlgorithmIdentifier.

Doc from org.bouncycastle.operator.OutputEncryptor.getAlgorithmIdentifier.

Return the algorithm identifier describing the encryption algorithm and parameters this encryptor uses.

Returns:AlgorithmIdentifier: algorithm oid and parameters.

getKey	back to summary
public GenericKey getKey() Implements org.bouncycastle.operator.OutputEncryptor.getKey. Doc from org.bouncycastle.operator.OutputEncryptor.getKey. Return the key used for encrypting the output. Returns:GenericKey the encryption key.

getKey

back to summary

public GenericKey getKey()

Implements org.bouncycastle.operator.OutputEncryptor.getKey.

Doc from org.bouncycastle.operator.OutputEncryptor.getKey.

Return the key used for encrypting the output.

Returns:GenericKey: the encryption key.

getMAC	back to summary
public byte[] getMAC() Implements org.bouncycastle.operator.AADProcessor.getMAC. Doc from org.bouncycastle.operator.AADProcessor.getMAC. Return the final value of AEAD cipher's MAC. Returns:byte[] MAC value for the AEAD cipher.

getMAC

back to summary

public byte[] getMAC()

Implements org.bouncycastle.operator.AADProcessor.getMAC.

Doc from org.bouncycastle.operator.AADProcessor.getMAC.

Return the final value of AEAD cipher's MAC.

Returns:byte[]: MAC value for the AEAD cipher.

getOutputStream	back to summary
public OutputStream getOutputStream(OutputStream dOut) Implements org.bouncycastle.operator.OutputEncryptor.getOutputStream. Doc from org.bouncycastle.operator.OutputEncryptor.getOutputStream. Wrap the passed in output stream encOut, returning an output stream that encrypts anything passed in before sending on to encOut. Parameters dOut:OutputStream output stream for encrypted output. Returns:OutputStream an encrypting OutputStream

getOutputStream

back to summary

public OutputStream getOutputStream(OutputStream dOut)

Implements org.bouncycastle.operator.OutputEncryptor.getOutputStream.

Doc from org.bouncycastle.operator.OutputEncryptor.getOutputStream.

Wrap the passed in output stream encOut, returning an output stream that encrypts anything passed in before sending on to encOut.

Parameters

dOut:OutputStream: output stream for encrypted output.

Returns:OutputStream

an encrypting OutputStream

org.bouncycastle.cms.jcajce back to summary

private Class JceCMSContentEncryptorBuilder.CMSOutputEncryptor

Class Inheritance

extends Object
implements OutputEncryptor

java.lang.Object
org.bouncycastle.cms.jcajce.JceCMSContentEncryptorBuilder.CMSOutputEncryptor

All Implemented Interfaces

org.bouncycastle.operator.OutputEncryptor

Field Summary

Modifier and Type	Field and Description
private AlgorithmIdentifier	algorithmIdentifier
private Cipher	cipher
private SecretKey	encKey

Constructor Summary

Access	Constructor and Description
pack-priv	CMSOutputEncryptor(ASN1ObjectIdentifier encryptionOID, int keySize, AlgorithmParameters params, SecureRandom random)

Method Summary

Modifier and Type	Method and Description
public AlgorithmIdentifier	getAlgorithmIdentifier() Implements org.bouncycastle.operator.OutputEncryptor.getAlgorithmIdentifier. Return the algorithm identifier describing the encryption algorithm and parameters this encryptor uses.
public GenericKey	getKey() Implements org.bouncycastle.operator.OutputEncryptor.getKey. Return the key used for encrypting the output.
public OutputStream	getOutputStream(OutputStream output stream for encrypted output. dOut) Implements org.bouncycastle.operator.OutputEncryptor.getOutputStream. Wrap the passed in output stream encOut, returning an output stream that encrypts anything passed in before sending on to encOut.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

algorithmIdentifier	back to summary
private AlgorithmIdentifier algorithmIdentifier

cipher	back to summary
private Cipher cipher

encKey	back to summary
private SecretKey encKey

Constructor Detail

CMSOutputEncryptor	back to summary
pack-priv CMSOutputEncryptor(ASN1ObjectIdentifier encryptionOID, int keySize, AlgorithmParameters params, SecureRandom random) throws CMSException

Method Detail

getAlgorithmIdentifier	back to summary
public AlgorithmIdentifier getAlgorithmIdentifier() Implements org.bouncycastle.operator.OutputEncryptor.getAlgorithmIdentifier. Doc from org.bouncycastle.operator.OutputEncryptor.getAlgorithmIdentifier. Return the algorithm identifier describing the encryption algorithm and parameters this encryptor uses. Returns:AlgorithmIdentifier algorithm oid and parameters.

getAlgorithmIdentifier

back to summary

public AlgorithmIdentifier getAlgorithmIdentifier()

Implements org.bouncycastle.operator.OutputEncryptor.getAlgorithmIdentifier.

Doc from org.bouncycastle.operator.OutputEncryptor.getAlgorithmIdentifier.

Return the algorithm identifier describing the encryption algorithm and parameters this encryptor uses.

Returns:AlgorithmIdentifier: algorithm oid and parameters.

getKey	back to summary
public GenericKey getKey() Implements org.bouncycastle.operator.OutputEncryptor.getKey. Doc from org.bouncycastle.operator.OutputEncryptor.getKey. Return the key used for encrypting the output. Returns:GenericKey the encryption key.

getKey

back to summary

public GenericKey getKey()

Implements org.bouncycastle.operator.OutputEncryptor.getKey.

Doc from org.bouncycastle.operator.OutputEncryptor.getKey.

Return the key used for encrypting the output.

Returns:GenericKey: the encryption key.

getOutputStream	back to summary
public OutputStream getOutputStream(OutputStream dOut) Implements org.bouncycastle.operator.OutputEncryptor.getOutputStream. Doc from org.bouncycastle.operator.OutputEncryptor.getOutputStream. Wrap the passed in output stream encOut, returning an output stream that encrypts anything passed in before sending on to encOut. Parameters dOut:OutputStream output stream for encrypted output. Returns:OutputStream an encrypting OutputStream

getOutputStream

back to summary

public OutputStream getOutputStream(OutputStream dOut)

Implements org.bouncycastle.operator.OutputEncryptor.getOutputStream.

Doc from org.bouncycastle.operator.OutputEncryptor.getOutputStream.

Wrap the passed in output stream encOut, returning an output stream that encrypts anything passed in before sending on to encOut.

Parameters

dOut:OutputStream: output stream for encrypted output.

Returns:OutputStream

an encrypting OutputStream

public Class JceCMSContentEncryptorBuilder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class JceCMSContentEncryptorBuilder.CMSAuthOutputEncryptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class JceCMSContentEncryptorBuilder.CMSOutputEncryptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private AlgorithmIdentifier	algorithmIdentifier
private AlgorithmParameters	algorithmParameters
private final ASN1ObjectIdentifier	encryptionOID
private EnvelopedDataHelper	helper
private static final SecretKeySizeProvider	KEY_SIZE_PROVIDER
private final int	keySize
private SecureRandom	random