Package org.bouncycastle.cms

Class CMSSignedDataParser

java.lang.Object
org.bouncycastle.cms.CMSContentInfoParser
org.bouncycastle.cms.CMSSignedDataParser
public class CMSSignedDataParser extends CMSContentInfoParser
Parsing class for an CMS Signed Data object from an input stream.

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

A simple example of usage for an encapsulated signature.

Two notes: first, in the example below the validity of the certificate isn't verified, just the fact that one of the certs matches the given signer, and, second, because we are in a streaming mode the order of the operations is important. 

      CMSSignedDataParser     sp = new CMSSignedDataParser(new JcaDigestCalculatorProviderBuilder().setProvider("BC").build(), encapSigData);

      sp.getSignedContent().drain();

      Store                   certStore = sp.getCertificates();
      SignerInformationStore  signers = sp.getSignerInfos();
      
      Collection              c = signers.getSigners();
      Iterator                it = c.iterator();

      while (it.hasNext())
      {
          SignerInformation   signer = (SignerInformation)it.next();
          Collection          certCollection = certStore.getMatches(signer.getSID());

          Iterator        certIt = certCollection.iterator();
          X509CertificateHolder cert = (X509CertificateHolder)certIt.next();

          System.out.println("verify returns: " + signer.verify(new JcaSimpleSignerInfoVerifierBuilder().setProvider("BC").build(cert)));
      }
Note also: this class does not introduce buffering - if you are processing large files you should create the parser with: 
          CMSSignedDataParser     ep = new CMSSignedDataParser(new BufferedInputStream(encapSigData, bufSize));
where bufSize is a suitably large buffer size.

  • Constructor Details

  • Method Details

    • getVersion

      public int getVersion()
      Return the version number for the SignedData object
      Returns:
      the version number

    • getDigestAlgorithmIDs

      public Set<org.bouncycastle.asn1.x509.AlgorithmIdentifier> getDigestAlgorithmIDs()
      Return the digest algorithm identifiers for the SignedData object
      Returns:
      the set of digest algorithm identifiers

    • getSignerInfos

      public SignerInformationStore getSignerInfos() throws CMSException
      return the collection of signers that are associated with the signatures for the message.
      Throws:
      CMSException

    • getCertificates

      public org.bouncycastle.util.Store getCertificates() throws CMSException
      Return any X.509 certificate objects in this SignedData structure as a Store of X509CertificateHolder objects.
      Returns:
      a Store of X509CertificateHolder objects.
      Throws:
      CMSException

    • getCRLs

      public org.bouncycastle.util.Store getCRLs() throws CMSException
      Return any X.509 CRL objects in this SignedData structure as a Store of X509CRLHolder objects.
      Returns:
      a Store of X509CRLHolder objects.
      Throws:
      CMSException

    • getAttributeCertificates

      public org.bouncycastle.util.Store getAttributeCertificates() throws CMSException
      Return any X.509 attribute certificate objects in this SignedData structure as a Store of X509AttributeCertificateHolder objects.
      Returns:
      a Store of X509AttributeCertificateHolder objects.
      Throws:
      CMSException

    • getOtherRevocationInfo

      public org.bouncycastle.util.Store getOtherRevocationInfo(org.bouncycastle.asn1.ASN1ObjectIdentifier otherRevocationInfoFormat) throws CMSException
      Return any OtherRevocationInfo OtherRevInfo objects of the type indicated by otherRevocationInfoFormat in this SignedData structure.
      Parameters:
      otherRevocationInfoFormat - OID of the format type been looked for.
      Returns:
      a Store of ASN1Encodable objects representing any objects of otherRevocationInfoFormat found.
      Throws:
      CMSException

    • getSignedContentTypeOID

      public String getSignedContentTypeOID()
      Return the a string representation of the OID associated with the encapsulated content info structure carried in the signed data.
      Returns:
      the OID for the content type.

    • getSignedContent

      public CMSTypedStream getSignedContent()

    • replaceSigners

      public static OutputStream replaceSigners(InputStream original, SignerInformationStore signerInformationStore, OutputStream out) throws CMSException, IOException
      Replace the signerinformation store associated with the passed in message contained in the stream original with the new one passed in. You would probably only want to do this if you wanted to change the unsigned attributes associated with a signer, or perhaps delete one.

      The output stream is returned unclosed.

      Parameters:
      original - the signed data stream to be used as a base.
      signerInformationStore - the new signer information store to use.
      out - the stream to write the new signed data object to.
      Returns:
      out.
      Throws:
      CMSException
      IOException

    • replaceCertificatesAndCRLs

      public static OutputStream replaceCertificatesAndCRLs(InputStream original, org.bouncycastle.util.Store certs, org.bouncycastle.util.Store crls, org.bouncycastle.util.Store attrCerts, OutputStream out) throws CMSException, IOException
      Replace the certificate and CRL information associated with this CMSSignedData object with the new one passed in.

      The output stream is returned unclosed.

      Parameters:
      original - the signed data stream to be used as a base.
      certs - new certificates to be used, if any.
      crls - new CRLs to be used, if any.
      attrCerts - new attribute certificates to be used, if any.
      out - the stream to write the new signed data object to.
      Returns:
      out.
      Throws:
      CMSException - if there is an error processing the CertStore
      IOException