Package eu.europa.esig.dss.cms.stream

Class CMSSignedDataStream

java.lang.Object
eu.europa.esig.dss.cms.stream.CMSSignedDataStream
All Implemented Interfaces:
CMS
public class CMSSignedDataStream extends Object implements CMS
Implementation of a CMS based on a parsed content.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CMSSignedDataStream()
    Default constructor to create an empty instance on CMS creation
    CMSSignedDataStream(CMSSignedDataStream cms)
    Constructor to create a copy of cms
    CMSSignedDataStream(DSSDocument cmsDocument)
    This constructor is used to create an instance of CMSSignedDataStream on parsing of an existing CMS document

  • Method Summary

    Modifier and Type
    Method
    Description
    org.bouncycastle.util.Store<org.bouncycastle.cert.X509AttributeCertificateHolder>
    getAttributeCertificates()
    Gets attribute certificates incorporates within CMS
    org.bouncycastle.util.Store<org.bouncycastle.cert.X509CertificateHolder>
    getCertificates()
    Gets the certificates store, representing the value of SignedData.certificates field
    DSSDocument
    getCMSDocument()
    Gets the original CMS document used to create the CMS
    org.bouncycastle.util.Store<org.bouncycastle.cert.X509CRLHolder>
    getCRLs()
    Gets the CRLs store (OCSP excluded), representing the value of SignedData.crls field
    byte[]
    getDEREncoded()
    Gets DER-encoded content of the CMS SignedData.
    Set<org.bouncycastle.asn1.x509.AlgorithmIdentifier>
    getDigestAlgorithmIDs()
    Returns a set of algorithm identifiers (OIDs) incorporated within SignedData.digestAlgorithms field of CMS
    byte[]
    getEncoded()
    Gets encoded content of the CMS SignedData, keeping the original encoding.
    org.bouncycastle.util.Store<?>
    getOcspBasicStore()
    Gets the OCSP Basic Store, incorporated within the SignedData.crls field
    org.bouncycastle.util.Store<?>
    getOcspResponseStore()
    Gets the OCSP Responses Store, incorporated within the SignedData.crls field
    DSSDocument
    getSignedContent()
    Gets the signed content incorporated within the SignedData.encapContentInfo.eContent field
    org.bouncycastle.asn1.ASN1ObjectIdentifier
    getSignedContentType()
    Gets signed content type, present within the SignedData.encapContentInfo.eContentType field
    org.bouncycastle.cms.SignerInformationStore
    getSignerInfos()
    Gets the signers of the signature, incorporated within the SignedData.signerInfos field
    int
    getVersion()
    Returns value of SignedData.version field
    boolean
    isDetachedSignature()
    Returns whether the signature is detached (i.e.
    void
    setAttributeCertificates(org.bouncycastle.util.Store<org.bouncycastle.cert.X509AttributeCertificateHolder> attributeCertificates)
    Sets attribute certificates incorporates within CMS
    void
    setCertificates(org.bouncycastle.util.Store<org.bouncycastle.cert.X509CertificateHolder> certificates)
    Sets the certificates store, representing the value of SignedData.certificates field
    void
    setCRLs(org.bouncycastle.util.Store<org.bouncycastle.cert.X509CRLHolder> crls)
    Sets the CRLs store (OCSP excluded), representing the value of SignedData.crls field
    void
    setDetachedSignature(boolean detachedSignature)
    Sets whether the signature is detached (i.e.
    void
    setDigestAlgorithmIDs(Collection<org.bouncycastle.asn1.x509.AlgorithmIdentifier> digestAlgorithmIDs)
    Sets a set of algorithm identifiers (OIDs) incorporated within SignedData.digestAlgorithms field of CMS
    void
    setOcspBasicStore(org.bouncycastle.util.Store<?> ocspBasicStore)
    Sets the OCSP Basic Store, incorporated within the SignedData.crls field
    void
    setOcspResponseStore(org.bouncycastle.util.Store<?> ocspResponseStore)
    Sets the OCSP Responses Store, incorporated within the SignedData.crls field
    void
    setSignedContent(DSSDocument signedContent)
    Sets the signed content incorporated within the SignedData.encapContentInfo.eContent field
    void
    setSignedContentType(org.bouncycastle.asn1.ASN1ObjectIdentifier signedContentType)
    Sets signed content type, present within the SignedData.encapContentInfo.eContentType field
    void
    setSignerInfos(org.bouncycastle.cms.SignerInformationStore signerInfos)
    Sets the signers of the signature, incorporated within the SignedData.signerInfos field
    void
    setVersion(int version)
    Sets value of SignedData.version field

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CMSSignedDataStream

      public CMSSignedDataStream()
      Default constructor to create an empty instance on CMS creation

    • CMSSignedDataStream

      public CMSSignedDataStream(CMSSignedDataStream cms)
      Constructor to create a copy of cms
      Parameters:
      cms - CMSSignedDataStream

    • CMSSignedDataStream

      public CMSSignedDataStream(DSSDocument cmsDocument)
      This constructor is used to create an instance of CMSSignedDataStream on parsing of an existing CMS document
      Parameters:
      cmsDocument - DSSDocument original document provided on parsing

  • Method Details

    • getCMSDocument

      public DSSDocument getCMSDocument()
      Gets the original CMS document used to create the CMS
      Returns:
      DSSDocument

    • getVersion

      public int getVersion()
      Description copied from interface: CMS
      Returns value of SignedData.version field
      Specified by:
      getVersion in interface CMS
      Returns:
      integer value

    • setVersion

      public void setVersion(int version)
      Sets value of SignedData.version field
      Parameters:
      version - integer value

    • getDigestAlgorithmIDs

      public Set<org.bouncycastle.asn1.x509.AlgorithmIdentifier> getDigestAlgorithmIDs()
      Description copied from interface: CMS
      Returns a set of algorithm identifiers (OIDs) incorporated within SignedData.digestAlgorithms field of CMS
      Specified by:
      getDigestAlgorithmIDs in interface CMS
      Returns:
      a set of AlgorithmIdentifiers

    • setDigestAlgorithmIDs

      public void setDigestAlgorithmIDs(Collection<org.bouncycastle.asn1.x509.AlgorithmIdentifier> digestAlgorithmIDs)
      Sets a set of algorithm identifiers (OIDs) incorporated within SignedData.digestAlgorithms field of CMS
      Parameters:
      digestAlgorithmIDs - a collection of AlgorithmIdentifiers

    • isDetachedSignature

      public boolean isDetachedSignature()
      Description copied from interface: CMS
      Returns whether the signature is detached (i.e. SignedData.encapContentInfo.eContent is null)
      Specified by:
      isDetachedSignature in interface CMS
      Returns:
      whether the signature is detached

    • setDetachedSignature

      public void setDetachedSignature(boolean detachedSignature)
      Sets whether the signature is detached (i.e. SignedData.encapContentInfo.eContent is null)
      Parameters:
      detachedSignature - whether the signature is detached

    • getSignedContentType

      public org.bouncycastle.asn1.ASN1ObjectIdentifier getSignedContentType()
      Description copied from interface: CMS
      Gets signed content type, present within the SignedData.encapContentInfo.eContentType field
      Specified by:
      getSignedContentType in interface CMS
      Returns:
      ASN1ObjectIdentifier

    • setSignedContentType

      public void setSignedContentType(org.bouncycastle.asn1.ASN1ObjectIdentifier signedContentType)
      Sets signed content type, present within the SignedData.encapContentInfo.eContentType field
      Parameters:
      signedContentType - ASN1ObjectIdentifier

    • getSignedContent

      public DSSDocument getSignedContent()
      Description copied from interface: CMS
      Gets the signed content incorporated within the SignedData.encapContentInfo.eContent field
      Specified by:
      getSignedContent in interface CMS
      Returns:
      DSSDocument

    • setSignedContent

      public void setSignedContent(DSSDocument signedContent)
      Sets the signed content incorporated within the SignedData.encapContentInfo.eContent field
      Parameters:
      signedContent - DSSDocument

    • getCertificates

      public org.bouncycastle.util.Store<org.bouncycastle.cert.X509CertificateHolder> getCertificates()
      Description copied from interface: CMS
      Gets the certificates store, representing the value of SignedData.certificates field
      Specified by:
      getCertificates in interface CMS
      Returns:
      Store

    • setCertificates

      public void setCertificates(org.bouncycastle.util.Store<org.bouncycastle.cert.X509CertificateHolder> certificates)
      Sets the certificates store, representing the value of SignedData.certificates field
      Parameters:
      certificates - Store

    • getAttributeCertificates

      public org.bouncycastle.util.Store<org.bouncycastle.cert.X509AttributeCertificateHolder> getAttributeCertificates()
      Description copied from interface: CMS
      Gets attribute certificates incorporates within CMS
      Specified by:
      getAttributeCertificates in interface CMS
      Returns:
      Store

    • setAttributeCertificates

      public void setAttributeCertificates(org.bouncycastle.util.Store<org.bouncycastle.cert.X509AttributeCertificateHolder> attributeCertificates)
      Sets attribute certificates incorporates within CMS
      Parameters:
      attributeCertificates - Store

    • getCRLs

      public org.bouncycastle.util.Store<org.bouncycastle.cert.X509CRLHolder> getCRLs()
      Description copied from interface: CMS
      Gets the CRLs store (OCSP excluded), representing the value of SignedData.crls field
      Specified by:
      getCRLs in interface CMS
      Returns:
      Store

    • setCRLs

      public void setCRLs(org.bouncycastle.util.Store<org.bouncycastle.cert.X509CRLHolder> crls)
      Sets the CRLs store (OCSP excluded), representing the value of SignedData.crls field
      Parameters:
      crls - Store

    • getOcspResponseStore

      public org.bouncycastle.util.Store<?> getOcspResponseStore()
      Description copied from interface: CMS
      Gets the OCSP Responses Store, incorporated within the SignedData.crls field
      Specified by:
      getOcspResponseStore in interface CMS
      Returns:
      Store

    • setOcspResponseStore

      public void setOcspResponseStore(org.bouncycastle.util.Store<?> ocspResponseStore)
      Sets the OCSP Responses Store, incorporated within the SignedData.crls field
      Parameters:
      ocspResponseStore - Store

    • getOcspBasicStore

      public org.bouncycastle.util.Store<?> getOcspBasicStore()
      Description copied from interface: CMS
      Gets the OCSP Basic Store, incorporated within the SignedData.crls field
      Specified by:
      getOcspBasicStore in interface CMS
      Returns:
      Store

    • setOcspBasicStore

      public void setOcspBasicStore(org.bouncycastle.util.Store<?> ocspBasicStore)
      Sets the OCSP Basic Store, incorporated within the SignedData.crls field
      Parameters:
      ocspBasicStore - Store

    • getSignerInfos

      public org.bouncycastle.cms.SignerInformationStore getSignerInfos()
      Description copied from interface: CMS
      Gets the signers of the signature, incorporated within the SignedData.signerInfos field
      Specified by:
      getSignerInfos in interface CMS
      Returns:
      SignerInformationStore

    • setSignerInfos

      public void setSignerInfos(org.bouncycastle.cms.SignerInformationStore signerInfos)
      Sets the signers of the signature, incorporated within the SignedData.signerInfos field
      Parameters:
      signerInfos - SignerInformationStore

    • getDEREncoded

      public byte[] getDEREncoded()
      Description copied from interface: CMS
      Gets DER-encoded content of the CMS SignedData. NOTE: This method returns the encoded value using in-memory byte array. Not applicable for large CMS processing.
      Specified by:
      getDEREncoded in interface CMS
      Returns:
      DER-encoded binaries

    • getEncoded

      public byte[] getEncoded()
      Description copied from interface: CMS
      Gets encoded content of the CMS SignedData, keeping the original encoding.
      Specified by:
      getEncoded in interface CMS
      Returns:
      encoded binaries