iaik.pdf.cmscades

Class CadesSignatureStream

java.lang.Object

iaik.pdf.cmscades.AbstractCadesSignature

iaik.pdf.cmscades.CadesSignatureStream

public class CadesSignatureStream
extends AbstractCadesSignature

This class manages stream instances of SignedData objects according to CAdES or PAdES profiles. To create a CAdES signature, instantiate a new CadesSignatureStream object providing the data to be signed and the required signature mode. Add a SignerInfo for each signer who signs the data. Finally, request the encoding of the internally managed SignedData object to do the actual signing and to get the final signature. E.g.:

 CadesSignatureStream cadesSig = new CadesSignatureStream(data, SignedData.EXPLICIT);
 CadesBESParameters params = new CadesBESParameters();
 cadesSig.addSignerInfo(privKey_, certs, params);
 OutputStream signature = new ByteArrayOutputStream();
 cadesSig.encodeSignature(signature);
 

Constructor Summary

Constructors

Constructor and Description
CadesSignatureStream(java.io.InputStream signature) Create a new instance by providing only the signature as stream.
CadesSignatureStream(java.io.InputStream signature, java.io.InputStream signedContent) Create a new instance by providing the signature and signed content as stream.
CadesSignatureStream(java.io.InputStream signature, java.io.InputStream signedContent, int signedDataMode) Create a new instance by providing the signature and signed content as stream.
CadesSignatureStream(java.io.InputStream signature, java.io.InputStream signedContent, java.io.OutputStream newSignatureEncodingStream) Create a new instance by providing the signature and signed content as stream.
CadesSignatureStream(java.io.InputStream signature, java.io.InputStream signedContent, java.lang.String[] additionalContentDigestAlgs, int signedDataMode, java.io.OutputStream newSignatureEncodingStream) Create a new instance by providing the signature and signed content as stream.
CadesSignatureStream(java.io.InputStream signature, java.io.InputStream signedContent, java.lang.String[] additionalContentDigestAlgs, java.io.OutputStream newSignatureEncodingStream) Create a new instance by providing the signature and signed content as stream.
CadesSignatureStream(java.io.InputStream data, int mode) New instance creating a signed data object for the given data and mode.

Method Summary

Modifier and Type	Method and Description
void	encodeSignature(java.io.OutputStream os) Writes the encoding of the CMS signature to the specified output stream.
java.io.ByteArrayOutputStream	getEncodedSignedDataStream() Deprecated. the output stream to write the encoded signature should be specified by the user instead of writing to a ByteArrayOutputStream. use encodeSignature(OutputStream) for new signatures and AbstractCadesSignature.encodeUpgradedSignature() for upgraded signatures (e.g. upgraded with archive timestamps)

Methods inherited from class iaik.pdf.cmscades.AbstractCadesSignature

addArchiveTimeStamp, addArchiveTimeStamp, addSignerInfo, encodeUpgradedSignature, getArchiveTimeStamps, getArchiveTimeStamps, getContentTimeStamps, getContentTimeStamps, getCRL, getSignatureTimeStamps, getSignatureTimeStamps, getSignatureTimeStampToken, getSignatureTimeStampToken, getSignedDataObject, getSignerInfos, verifySignatureTimestampImprint, verifySignatureTimestampImprint, verifySignatureTimestampImprint, verifySignatureTimestampImprint, verifySignatureValue, verifySignatureValue, verifySignatureValue

Methods inherited from class java.lang.Object

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

Constructor Detail

CadesSignatureStream

public CadesSignatureStream(java.io.InputStream data,
                            int mode)

New instance creating a signed data object for the given data and mode. Used for signature creation.

Parameters:

data - InputStream of data to be signed

mode - SignedData.IMPLICIT or SignedData.EXPLICIT

CadesSignatureStream

public CadesSignatureStream(java.io.InputStream signature,
                            java.io.InputStream signedContent)
                     throws CmsCadesException

Create a new instance by providing the signature and signed content as stream. Used for signature verification.

Parameters:

signature - signature as encoded SignedData object

signedContent - the content signed by the given signature, required for explicit signatures

Throws:

CmsCadesException - if signature is invalid (e.g. can't be parsed or content hash doesn't match)

CadesSignatureStream

public CadesSignatureStream(java.io.InputStream signature,
                            java.io.InputStream signedContent,
                            java.io.OutputStream newSignatureEncodingStream)
                     throws CmsCadesException

Create a new instance by providing the signature and signed content as stream. If unsigned attributes shall be added subsequently (e.g. AbstractCadesSignature.addArchiveTimeStamp(iaik.x509.X509Certificate, iaik.pdf.parameters.CadesLTAParameters)) and not yet included content digests are required, these additional digest algorithms for hashing the signed content have to be specified here. Used for signature verification and upgrade with unsigned attributes.

Parameters:

signature - signature as encoded SignedData object

signedContent - the content signed by the given signature, required for explicit signatures

newSignatureEncodingStream - output stream to write the encoding of the new upgraded signature

Throws:

CmsCadesException - if signature is invalid (e.g. can't be parsed or content hash doesn't match)

CadesSignatureStream

public CadesSignatureStream(java.io.InputStream signature,
                            java.io.InputStream signedContent,
                            java.lang.String[] additionalContentDigestAlgs,
                            java.io.OutputStream newSignatureEncodingStream)
                     throws CmsCadesException

Create a new instance by providing the signature and signed content as stream. The new signature upgraded with further unsigned attributes (e.g. AbstractCadesSignature.addArchiveTimeStamp(iaik.x509.X509Certificate, iaik.pdf.parameters.CadesLTAParameters)) will be encoded to the given output stream. If not yet included content digests are required for upgrading the signature, these additional digest algorithms for hashing the signed content have to be specified here. Used for signature verification and upgrade with unsigned attributes.

Parameters:

signature - signature as encoded SignedData object

signedContent - the content signed by the given signature, required for explicit signatures

additionalContentDigestAlgs - digest algorithms that shall be added to the signature for later usage

newSignatureEncodingStream - output stream to write the encoding of the new upgraded signature

Throws:

CmsCadesException - if signature is invalid (e.g. can't be parsed or content hash doesn't match)

CadesSignatureStream

public CadesSignatureStream(java.io.InputStream signature,
                            java.io.InputStream signedContent,
                            int signedDataMode)
                     throws CmsCadesException

Create a new instance by providing the signature and signed content as stream. Checks whether given and actual signedDataMode correspond. Used for signature verification.

Parameters:

signature - signature as encoded SignedData object

signedContent - the content signed by the given signature, required for explicit signatures

signedDataMode - SignedData.EXPLICIT or SignedData.IMPLICIT

Throws:

CmsCadesException - if signature is invalid (e.g. can't be parsed or content hash doesn't match)

CadesSignatureStream

public CadesSignatureStream(java.io.InputStream signature,
                            java.io.InputStream signedContent,
                            java.lang.String[] additionalContentDigestAlgs,
                            int signedDataMode,
                            java.io.OutputStream newSignatureEncodingStream)
                     throws CmsCadesException

Create a new instance by providing the signature and signed content as stream. Checks whether given and actual signedDataMode correspond. The new signature upgraded with further unsigned attributes (e.g. AbstractCadesSignature.addArchiveTimeStamp(iaik.x509.X509Certificate, iaik.pdf.parameters.CadesLTAParameters)) will be encoded to the given output stream. If not yet included content digests are required for upgrading the signature, these additional digest algorithms for hashing the signed content have to be specified here. Used for signature verification and upgrade with unsigned attributes.

Parameters:

signature - signature as encoded SignedData object

signedContent - the content signed by the given signature, required for explicit signatures

additionalContentDigestAlgs - digest algorithms that shall be added to the signature for later usage

signedDataMode - SignedData.EXPLICIT or SignedData.IMPLICIT

newSignatureEncodingStream - output stream to write the encoding of the new upgraded signature

Throws:

CmsCadesException - if signature is invalid (e.g. can't be parsed or content hash doesn't match)

CadesSignatureStream

public CadesSignatureStream(java.io.InputStream signature)
                     throws CmsCadesException

Create a new instance by providing only the signature as stream. Can only be used for implicit signatures, i.e. if signed content need not be provided. Used for signature verification.

Parameters:

signature - signature as encoded SignedData object

Throws:

CmsCadesException - if signature is invalid (e.g. can't be parsed or content hash doesn't match)

Method Detail

getEncodedSignedDataStream

public java.io.ByteArrayOutputStream getEncodedSignedDataStream()
                                                         throws java.io.IOException,
                                                                CmsCadesException

Deprecated. the output stream to write the encoded signature should be specified by the user instead of writing to a ByteArrayOutputStream. use encodeSignature(OutputStream) for new signatures and AbstractCadesSignature.encodeUpgradedSignature() for upgraded signatures (e.g. upgraded with archive timestamps)

Create encoded CMS signature.

Returns:

DER encoding of the CMS signature as ByteArrayOutputStream

Throws:

java.io.IOException - if data can't be read

CmsCadesException - if signed data attributes or signed data object can't be created

encodeSignature

public void encodeSignature(java.io.OutputStream os)
                     throws java.io.IOException,
                            CmsCadesException

Writes the encoding of the CMS signature to the specified output stream. Use this method to get the encoding of a new signature created with CadesSignatureStream(InputStream, int).

Parameters:

os - output stream to write the DER encoded CMS signature to

Throws:

java.io.IOException - if data can't be read

CmsCadesException - if signed data attributes or signed data object can't be created