Top Description Inners Fields Constructors Methods
org.bouncycastle.cms

public Class CMSEnvelopedDataStreamGenerator

extends CMSEnvelopedGenerator
Class Inheritance
Imports
java.io.IOException, .OutputStream, java.util.Collections, org.bouncycastle.asn1.ASN1EncodableVector, .ASN1Integer, .ASN1ObjectIdentifier, .BERSequenceGenerator, .DLSet, org.bouncycastle.asn1.cms.CMSObjectIdentifiers, .EnvelopedData, org.bouncycastle.asn1.x509.AlgorithmIdentifier, org.bouncycastle.operator.OutputAEADEncryptor, .OutputEncryptor
General class for generating a CMS enveloped-data message stream.

A simple example of usage. 

     CMSEnvelopedDataStreamGenerator edGen = new CMSEnvelopedDataStreamGenerator();

     edGen.addRecipientInfoGenerator(new JceKeyTransRecipientInfoGenerator(recipientCert).setProvider("BC"));

     ByteArrayOutputStream  bOut = new ByteArrayOutputStream();

     OutputStream out = edGen.open(
                             bOut, new JceCMSContentEncryptorBuilder(CMSAlgorithm.DES_EDE3_CBC)
                                             .setProvider("BC").build());
     out.write(data);

     out.close();

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
CMSEnvelopedDataStreamGenerator.CmsEnvelopedDataOutputStream

Field Summary

Modifier and TypeField and Description
private boolean
_berEncodeRecipientSet

private int
_bufferSize

Inherited from org.bouncycastle.cms.CMSEnvelopedGenerator:
AES128_CBCAES128_WRAPAES192_CBCAES192_WRAPAES256_CBCAES256_WRAPCAMELLIA128_CBCCAMELLIA128_WRAPCAMELLIA192_CBCCAMELLIA192_WRAPCAMELLIA256_CBCCAMELLIA256_WRAPCAST5_CBCDES_EDE3_CBCDES_EDE3_WRAPECDH_SHA1KDFECMQV_SHA1KDFECMQV_SHA224KDFECMQV_SHA256KDFECMQV_SHA384KDFECMQV_SHA512KDFIDEA_CBCoriginatorInfoRC2_CBCrecipientInfoGeneratorsSEED_CBCSEED_WRAPunprotectedAttributeGenerator

Constructor Summary

AccessConstructor and Description
public
CMSEnvelopedDataStreamGenerator()

base constructor

Method Summary

Modifier and TypeMethod and Description
private OutputStream
doOpen(ASN1ObjectIdentifier dataType, OutputStream out, OutputEncryptor encryptor)

private ASN1Integer
getVersion(ASN1EncodableVector recipientInfos)

protected OutputStream
open(ASN1ObjectIdentifier dataType, OutputStream out, ASN1EncodableVector recipientInfos, OutputEncryptor encryptor)

protected OutputStream
open(OutputStream out, ASN1EncodableVector recipientInfos, OutputEncryptor encryptor)

public OutputStream
open(OutputStream out, OutputEncryptor encryptor)

generate an enveloped object that contains an CMS Enveloped Data object using the given encryptor.

public OutputStream
open(ASN1ObjectIdentifier dataType, OutputStream out, OutputEncryptor encryptor)

generate an enveloped object that contains an CMS Enveloped Data object using the given encryptor and marking the data as being of the passed in type.

public void
setBEREncodeRecipients(boolean berEncodeRecipientSet)

Use a BER Set to store the recipient information

public void
setBufferSize(int
length of octet strings to buffer the data.
bufferSize)

Set the underlying string size for encapsulated data

Inherited from org.bouncycastle.cms.CMSEnvelopedGenerator:
addRecipientInfoGeneratorsetOriginatorInfosetUnprotectedAttributeGenerator

Field Detail

_berEncodeRecipientSetback to summary
private boolean _berEncodeRecipientSet
_bufferSizeback to summary
private int _bufferSize

Constructor Detail

CMSEnvelopedDataStreamGeneratorback to summary
public CMSEnvelopedDataStreamGenerator()

base constructor

Method Detail

doOpenback to summary
private OutputStream doOpen(ASN1ObjectIdentifier dataType, OutputStream out, OutputEncryptor encryptor) throws IOException, CMSException
getVersionback to summary
private ASN1Integer getVersion(ASN1EncodableVector recipientInfos)
openback to summary
protected OutputStream open(ASN1ObjectIdentifier dataType, OutputStream out, ASN1EncodableVector recipientInfos, OutputEncryptor encryptor) throws IOException
openback to summary
protected OutputStream open(OutputStream out, ASN1EncodableVector recipientInfos, OutputEncryptor encryptor) throws CMSException
openback to summary
public OutputStream open(OutputStream out, OutputEncryptor encryptor) throws CMSException, IOException

generate an enveloped object that contains an CMS Enveloped Data object using the given encryptor.

openback to summary
public OutputStream open(ASN1ObjectIdentifier dataType, OutputStream out, OutputEncryptor encryptor) throws CMSException, IOException

generate an enveloped object that contains an CMS Enveloped Data object using the given encryptor and marking the data as being of the passed in type.

setBEREncodeRecipientsback to summary
public void setBEREncodeRecipients(boolean berEncodeRecipientSet)

Use a BER Set to store the recipient information

setBufferSizeback to summary
public void setBufferSize(int bufferSize)

Set the underlying string size for encapsulated data

Parameters
bufferSize:int

length of octet strings to buffer the data.

org.bouncycastle.cms back to summary

private Class CMSEnvelopedDataStreamGenerator.CmsEnvelopedDataOutputStream

extends OutputStream
Class Inheritance

Field Summary

Modifier and TypeField and Description
private BERSequenceGenerator
_cGen

private final OutputStream
_cOut

private BERSequenceGenerator
_eiGen

private final OutputEncryptor
_encryptor

private BERSequenceGenerator
_envGen

private OutputStream
_octetStream

Constructor Summary

AccessConstructor and Description
public
CmsEnvelopedDataOutputStream(OutputEncryptor encryptor, OutputStream octetStream, BERSequenceGenerator cGen, BERSequenceGenerator envGen, BERSequenceGenerator eiGen)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with this stream.

public void
write(int
the byte.
b)

Implements abstract java.io.OutputStream.write.

Writes the specified byte to this output stream.

public void
write(byte[]
the data.
bytes, int
the start offset in the data.
off, int
the number of bytes to write.
len)

Overrides java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.

public void
write(byte[]
the data.
bytes)

Overrides java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream.

Inherited from java.io.OutputStream:
flushnullOutputStream

Field Detail

_cGenback to summary
private BERSequenceGenerator _cGen
_cOutback to summary
private final OutputStream _cOut
_eiGenback to summary
private BERSequenceGenerator _eiGen
_encryptorback to summary
private final OutputEncryptor _encryptor
_envGenback to summary
private BERSequenceGenerator _envGen
_octetStreamback to summary
private OutputStream _octetStream

Constructor Detail

CmsEnvelopedDataOutputStreamback to summary
public CmsEnvelopedDataOutputStream(OutputEncryptor encryptor, OutputStream octetStream, BERSequenceGenerator cGen, BERSequenceGenerator envGen, BERSequenceGenerator eiGen)

Method Detail

closeback to summary
public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters
b:int

the byte.

Exceptions
IOException:
if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
writeback to summary
public void write(byte[] bytes, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters
bytes:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Exceptions
IOException:
if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.
writeback to summary
public void write(byte[] bytes) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters
bytes:byte[]

the data.

Exceptions
IOException:
if an I/O error occurs.