public class

CMSEnvelopedDataParser

extends CMSContentInfoParser
java.lang.Object
   ↳ org.bouncycastle.cms.CMSContentInfoParser
     ↳ org.bouncycastle.cms.CMSEnvelopedDataParser
Known Direct Subclasses

Class Overview

Parsing class for an CMS Enveloped Data object from an input stream.

Note: that because we are in a streaming mode only one recipient can be tried and it is important that the methods on the parser are called in the appropriate order.

Example of use - assuming the first recipient matches the private key we have.

      CMSEnvelopedDataParser     ep = new CMSEnvelopedDataParser(inputStream);

      RecipientInformationStore  recipients = ep.getRecipientInfos();

      Collection  c = recipients.getRecipients();
      Iterator    it = c.iterator();
      
      if (it.hasNext())
      {
          RecipientInformation   recipient = (RecipientInformation)it.next();

          CMSTypedStream recData = recipient.getContentStream(new JceKeyTransEnvelopedRecipient(privateKey).setProvider("BC"));
          
          processDataStream(recData.getContentStream());
      }
  
Note: this class does not introduce buffering - if you are processing large files you should create the parser with:
          CMSEnvelopedDataParser     ep = new CMSEnvelopedDataParser(new BufferedInputStream(inputStream, bufSize));
  
where bufSize is a suitably large buffer size.

Summary

[Expand]
Inherited Fields
From class org.bouncycastle.cms.CMSContentInfoParser
Public Constructors
CMSEnvelopedDataParser(byte[] envelopedData)
CMSEnvelopedDataParser(InputStream envelopedData)
Public Methods
String getEncryptionAlgOID()
return the object identifier for the content encryption algorithm.
byte[] getEncryptionAlgParams()
return the ASN.1 encoded encryption algorithm parameters, or null if there aren't any.
AlgorithmParameters getEncryptionAlgorithmParameters(String provider)
Return an AlgorithmParameters object giving the encryption parameters used to encrypt the message content.
AlgorithmParameters getEncryptionAlgorithmParameters(Provider provider)
Return an AlgorithmParameters object giving the encryption parameters used to encrypt the message content.
RecipientInformationStore getRecipientInfos()
return a store of the intended recipients for this message
AttributeTable getUnprotectedAttributes()
return a table of the unprotected attributes indexed by the OID of the attribute.
[Expand]
Inherited Methods
From class org.bouncycastle.cms.CMSContentInfoParser
From class java.lang.Object

Public Constructors

public CMSEnvelopedDataParser (byte[] envelopedData)

public CMSEnvelopedDataParser (InputStream envelopedData)

Public Methods

public String getEncryptionAlgOID ()

return the object identifier for the content encryption algorithm.

public byte[] getEncryptionAlgParams ()

return the ASN.1 encoded encryption algorithm parameters, or null if there aren't any.

public AlgorithmParameters getEncryptionAlgorithmParameters (String provider)

Return an AlgorithmParameters object giving the encryption parameters used to encrypt the message content.

Parameters
provider the name of the provider to generate the parameters for.
Returns
  • the parameters object, null if there is not one.
Throws
CMSException if the algorithm cannot be found, or the parameters can't be parsed.
NoSuchProviderException if the provider cannot be found.

public AlgorithmParameters getEncryptionAlgorithmParameters (Provider provider)

Return an AlgorithmParameters object giving the encryption parameters used to encrypt the message content.

Parameters
provider the provider to generate the parameters for.
Returns
  • the parameters object, null if there is not one.
Throws
CMSException if the algorithm cannot be found, or the parameters can't be parsed.

public RecipientInformationStore getRecipientInfos ()

return a store of the intended recipients for this message

public AttributeTable getUnprotectedAttributes ()

return a table of the unprotected attributes indexed by the OID of the attribute.

Throws
IOException