public class

CMSAuthenticatedDataParser

extends CMSContentInfoParser
java.lang.Object
   ↳ org.bouncycastle.cms.CMSContentInfoParser
     ↳ org.bouncycastle.cms.CMSAuthenticatedDataParser

Class Overview

Parsing class for an CMS Authenticated 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.

      CMSAuthenticatedDataParser     ad = new CMSAuthenticatedDataParser(inputStream);

      RecipientInformationStore  recipients = ad.getRecipientInfos();

      Collection  c = recipients.getRecipients();
      Iterator    it = c.iterator();

      if (it.hasNext())
      {
          RecipientInformation   recipient = (RecipientInformation)it.next();

          CMSTypedStream recData = recipient.getContentStream(new JceKeyTransAuthenticatedRecipient(privateKey).setProvider("BC"));

          processDataStream(recData.getContentStream());

          if (!Arrays.equals(ad.getMac(), recipient.getMac())
          {
              System.err.println("Data corrupted!!!!");
          }
      }
  
Note: this class does not introduce buffering - if you are processing large files you should create the parser with:
          CMSAuthenticatedDataParser     ep = new CMSAuthenticatedDataParser(new BufferedInputStream(inputStream, bufSize));
  
where bufSize is a suitably large buffer size.

Summary

[Expand]
Inherited Fields
From class org.bouncycastle.cms.CMSContentInfoParser
Public Constructors
CMSAuthenticatedDataParser(byte[] envelopedData)
CMSAuthenticatedDataParser(byte[] envelopedData, DigestCalculatorProvider digestCalculatorProvider)
CMSAuthenticatedDataParser(InputStream envelopedData)
CMSAuthenticatedDataParser(InputStream envelopedData, DigestCalculatorProvider digestCalculatorProvider)
Public Methods
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.
byte[] getMac()
String getMacAlgOID()
return the object identifier for the mac algorithm.
byte[] getMacAlgParams()
return the ASN.1 encoded encryption algorithm parameters, or null if there aren't any.
AlgorithmParameters getMacAlgorithmParameters(String provider)
Return an AlgorithmParameters object giving the encryption parameters used to encrypt the message content.
AlgorithmParameters getMacAlgorithmParameters(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 getUnauthAttrs()
return a table of the unauthenticated 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 CMSAuthenticatedDataParser (byte[] envelopedData)

public CMSAuthenticatedDataParser (byte[] envelopedData, DigestCalculatorProvider digestCalculatorProvider)

public CMSAuthenticatedDataParser (InputStream envelopedData)

public CMSAuthenticatedDataParser (InputStream envelopedData, DigestCalculatorProvider digestCalculatorProvider)

Public Methods

public AttributeTable getAuthAttrs ()

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

Throws
IOException

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.

public byte[] getMac ()

Throws
IOException

public String getMacAlgOID ()

return the object identifier for the mac algorithm.

public byte[] getMacAlgParams ()

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

public AlgorithmParameters getMacAlgorithmParameters (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 getMacAlgorithmParameters (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 getUnauthAttrs ()

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

Throws
IOException