Bouncy Castle Cryptography Library 1.84

org.bouncycastle.cms
Class CMSAuthEnvelopedDataParser

java.lang.Object
  extended byorg.bouncycastle.cms.CMSContentInfoParser
      extended byorg.bouncycastle.cms.CMSAuthEnvelopedDataParser

public class CMSAuthEnvelopedDataParser
extends CMSContentInfoParser

Parser for authenticated enveloped CMS data structures.

Important usage notes: The constructor fully drains and closes the provided InputStream Plaintext content is buffered in memory and available via Do not reuse the input stream after parsing


Field Summary
 
Fields inherited from class org.bouncycastle.cms.CMSContentInfoParser
_contentInfo, _data
 
Constructor Summary
CMSAuthEnvelopedDataParser(byte[] envelopedData)
          Create a parser from a byte array.
CMSAuthEnvelopedDataParser(java.io.InputStream envelopedData)
          Create a parser from an input stream.
 
Method Summary
 org.bouncycastle.asn1.cms.AttributeTable getAuthAttrs()
          return a table of the unauthenticated attributes indexed by the OID of the attribute.
 byte[] getContentDigest()
          This will only be valid after the content has been read.
 java.lang.String getEncAlgOID()
          return the object identifier for the mac algorithm.
 byte[] getEncAlgParams()
          return the ASN.1 encoded encryption algorithm parameters, or null if there aren't any.
 org.bouncycastle.asn1.x509.AlgorithmIdentifier getEncryptionAlgOID()
          Return the MAC algorithm details for the MAC associated with the data in this object.
 byte[] getMac()
           
 OriginatorInformation getOriginatorInfo()
          Return the originator information associated with this message if present.
 RecipientInformationStore getRecipientInfos()
          return a store of the intended recipients for this message
 org.bouncycastle.asn1.cms.AttributeTable getUnauthAttrs()
          return a table of the unauthenticated attributes indexed by the OID of the attribute.
 
Methods inherited from class org.bouncycastle.cms.CMSContentInfoParser
close
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMSAuthEnvelopedDataParser

public CMSAuthEnvelopedDataParser(byte[] envelopedData)
                           throws CMSException,
                                  java.io.IOException
Create a parser from a byte array.

Note: The input is fully consumed during parsing. Plaintext content is buffered in memory.

Parameters:
envelopedData - the CMS auth enveloped data bytes

CMSAuthEnvelopedDataParser

public CMSAuthEnvelopedDataParser(java.io.InputStream envelopedData)
                           throws CMSException,
                                  java.io.IOException
Create a parser from an input stream.

Stream handling note: This constructor fully reads and closes the input stream before returning. The plaintext content is buffered in memory and accessible via RecipientInformation.getContentStream(org.bouncycastle.cms.Recipient).

Parameters:
envelopedData - the CMS auth enveloped data stream
Method Detail

getOriginatorInfo

public OriginatorInformation getOriginatorInfo()
Return the originator information associated with this message if present.

Returns:
OriginatorInformation, null if not present.

getEncryptionAlgOID

public org.bouncycastle.asn1.x509.AlgorithmIdentifier getEncryptionAlgOID()
Return the MAC algorithm details for the MAC associated with the data in this object.

Returns:
AlgorithmIdentifier representing the MAC algorithm.

getEncAlgOID

public java.lang.String getEncAlgOID()
return the object identifier for the mac algorithm.


getEncAlgParams

public byte[] getEncAlgParams()
return the ASN.1 encoded encryption algorithm parameters, or null if there aren't any.


getRecipientInfos

public RecipientInformationStore getRecipientInfos()
return a store of the intended recipients for this message


getMac

public byte[] getMac()
              throws java.io.IOException
Throws:
java.io.IOException

getAuthAttrs

public org.bouncycastle.asn1.cms.AttributeTable getAuthAttrs()
                                                      throws java.io.IOException
return a table of the unauthenticated attributes indexed by the OID of the attribute.

Throws:
java.io.IOException

getUnauthAttrs

public org.bouncycastle.asn1.cms.AttributeTable getUnauthAttrs()
                                                        throws java.io.IOException
return a table of the unauthenticated attributes indexed by the OID of the attribute.

Throws:
java.io.IOException

getContentDigest

public byte[] getContentDigest()
This will only be valid after the content has been read.

Returns:
the contents of the messageDigest attribute, if available. Null if not present.

Bouncy Castle Cryptography Library 1.84