Class CMSAuthEnvelopedDataStreamGenerator

java.lang.Object

org.bouncycastle.cms.CMSEnvelopedGenerator

org.bouncycastle.cms.CMSAuthEnvelopedGenerator

org.bouncycastle.cms.CMSAuthEnvelopedDataStreamGenerator

public class CMSAuthEnvelopedDataStreamGenerator
extends CMSAuthEnvelopedGenerator

Generate authenticated enveloped CMS data with streaming support.

When using this generator, note:

• The returned OutputStream must be closed to finalize encryption and authentication
• Closing the returned stream does not close the underlying OutputStream passed to open()
• Callers are responsible for closing the underlying OutputStream separately

Field Summary

Fields inherited from class CMSAuthEnvelopedGenerator

AES128_CCM, AES128_GCM, AES192_CCM, AES192_GCM, AES256_CCM, AES256_GCM, authAttrsGenerator, ChaCha20Poly1305, originatorInfo, unauthAttrsGenerator

Fields inherited from class CMSEnvelopedGenerator

AES128_CBC, AES128_WRAP, AES192_CBC, AES192_WRAP, AES256_CBC, AES256_WRAP, CAMELLIA128_CBC, CAMELLIA128_WRAP, CAMELLIA192_CBC, CAMELLIA192_WRAP, CAMELLIA256_CBC, CAMELLIA256_WRAP, CAST5_CBC, DES_EDE3_CBC, DES_EDE3_WRAP, ECDH_SHA1KDF, ECMQV_SHA1KDF, ECMQV_SHA224KDF, ECMQV_SHA256KDF, ECMQV_SHA384KDF, ECMQV_SHA512KDF, encoding, IDEA_CBC, RC2_CBC, SEED_CBC, SEED_WRAP, unprotectedAttributeGenerator

Constructor Summary

Constructors

Constructor	Description
CMSAuthEnvelopedDataStreamGenerator()

Method Summary

Modifier and Type	Method	Description
OutputStream	open(OutputStream out, long inputLength, OutputAEADEncryptor encryptor)	Generate an authenticated-enveloped object for inputLength content octets, using the given encryptor.
protected OutputStream	open(OutputStream out, org.bouncycastle.asn1.ASN1EncodableVector recipientInfos, OutputAEADEncryptor encryptor)
OutputStream	open(OutputStream out, OutputAEADEncryptor encryptor)	Generate authenticated-enveloped-data using the given encryptor, and marking the encapsulated bytes as being of type DATA.
OutputStream	open(org.bouncycastle.asn1.ASN1ObjectIdentifier dataType, OutputStream out, long inputLength, OutputAEADEncryptor encryptor)	Generate an authenticated-enveloped object for inputLength content octets of the passed in type, using the given encryptor - see open(OutputStream, long, OutputAEADEncryptor).
protected OutputStream	open(org.bouncycastle.asn1.ASN1ObjectIdentifier dataType, OutputStream out, org.bouncycastle.asn1.ASN1EncodableVector recipientInfos, OutputAEADEncryptor encryptor)
OutputStream	open(org.bouncycastle.asn1.ASN1ObjectIdentifier dataType, OutputStream out, OutputAEADEncryptor encryptor)	Generate authenticated-enveloped-data using the given encryptor, and marking the encapsulated bytes as being of the passed in type.
void	setBEREncodeRecipients(boolean berEncodeRecipientSet)	Use a BER Set to store the recipient information
void	setBufferSize(int bufferSize)	Set the underlying string size for encapsulated data

Methods inherited from class CMSAuthEnvelopedGenerator

setAuthenticatedAttributeGenerator, setOriginatorInfo, setUnauthenticatedAttributeGenerator

Methods inherited from class CMSEnvelopedGenerator

addRecipientInfoGenerator, setEncoding, setUnprotectedAttributeGenerator

Methods inherited from class Object

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

Constructor Details

CMSAuthEnvelopedDataStreamGenerator

public CMSAuthEnvelopedDataStreamGenerator()

Method Details

setBufferSize

public void setBufferSize(int bufferSize)

Set the underlying string size for encapsulated data

Parameters:

bufferSize - length of octet strings to buffer the data.

setBEREncodeRecipients

public void setBEREncodeRecipients(boolean berEncodeRecipientSet)

Use a BER Set to store the recipient information

open

protected OutputStream open(org.bouncycastle.asn1.ASN1ObjectIdentifier dataType,
 OutputStream out,
 org.bouncycastle.asn1.ASN1EncodableVector recipientInfos,
 OutputAEADEncryptor encryptor)
                     throws IOException

Throws:

IOException

open

protected OutputStream open(OutputStream out,
 org.bouncycastle.asn1.ASN1EncodableVector recipientInfos,
 OutputAEADEncryptor encryptor)
                     throws CMSException

Throws:

CMSException

open

public OutputStream open(OutputStream out,
 OutputAEADEncryptor encryptor)
                  throws CMSException,
IOException

Generate authenticated-enveloped-data using the given encryptor, and marking the encapsulated bytes as being of type DATA.

Stream handling note: Closing the returned stream finalizes the CMS structure but does not close the underlying output stream. The caller remains responsible for managing the lifecycle of out.

Parameters:

out - the output stream to write the CMS structure to

encryptor - the cipher to use for encryption

Returns:

an output stream that writes encrypted and authenticated content

Throws:

CMSException

IOException

open

public OutputStream open(org.bouncycastle.asn1.ASN1ObjectIdentifier dataType,
 OutputStream out,
 OutputAEADEncryptor encryptor)
                  throws CMSException,
IOException

Generate authenticated-enveloped-data using the given encryptor, and marking the encapsulated bytes as being of the passed in type.

Stream handling note: Closing the returned stream finalizes the CMS structure but does not close the underlying output stream. The caller remains responsible for managing the lifecycle of out.

Parameters:

dataType - the type of the data being written to the object.

out - the output stream to write the CMS structure to

encryptor - the cipher to use for encryption

Returns:

an output stream that writes encrypted and authenticated content

Throws:

CMSException

IOException

open

public OutputStream open(OutputStream out,
 long inputLength,
 OutputAEADEncryptor encryptor)
                  throws CMSException,
IOException

Generate an authenticated-enveloped object for inputLength content octets, using the given encryptor. In definite-length mode (see CMSEnvelopedGenerator.setEncoding(String)) the length is used to pre-compute every enclosing header, so exactly that many content octets must then be written to the returned stream - a mismatch fails with an IOException, by which point the output is unusable and must be discarded. In BER mode the length is ignored.

In definite-length mode the buffer size and BER recipient set settings are ignored (an indefinite-length encoding may not appear inside a definite-length one). Nothing is buffered, so content larger than a Java array can carry is supported. Note that in this mode any authenticated attributes are generated and fed to the encryptor's AAD stream at open() time, ahead of the content - the order AEAD modes require.

Throws:

CMSException

IOException

open

public OutputStream open(org.bouncycastle.asn1.ASN1ObjectIdentifier dataType,
 OutputStream out,
 long inputLength,
 OutputAEADEncryptor encryptor)
                  throws CMSException,
IOException

Generate an authenticated-enveloped object for inputLength content octets of the passed in type, using the given encryptor - see open(OutputStream, long, OutputAEADEncryptor).

Throws:

CMSException

IOException