iaik.pdf.asn1objects

Class ArchiveTimeStampv3

java.lang.Object

iaik.asn1.structures.AttributeValue

iaik.pdf.asn1objects.ArchiveTimeStampv3

All Implemented Interfaces:

iaik.asn1.ASN1Type

public class ArchiveTimeStampv3
extends iaik.asn1.structures.AttributeValue

This class represents the ASN.1 structure of the archive-time-stamp-v3 attribute as specified in ETSI TS 101 733 and ETSI EN 319 122-1. It includes a timestamp of type TimeStampToken (TimeStampToken) with an unsigned attribute of type AtsHashIndex. The message imprint for an archive timestamp contains the content type, content hash, the signer info fields version, sid, digest algorithm, signed attributes, signature algorithm and signature as well as the unsigned attribute of type AtsHashIndex. Before adding an archive timestamp, all data necessary for signature verification shall be included in the signature. The hashes of this data are included in the AtsHashIndex attribute and therefore protected by the archive timestamp. Only protected data shall be used for verifying a signature protected by an archive timestamp. Use getAtsHashIndex() to extract the AtsHashIndex object and to further retrieve the protected data.

Field Summary

Fields

Modifier and Type	Field and Description
static iaik.asn1.structures.AlgorithmID	DEFAULTHASHALGORITHM Default digest algorithm that may be used for generating the TimeStampToken - equal to AbstractAtsHashIndex.DEFAULTHASHALGORITHM.
static iaik.asn1.ObjectID	oid The attributeType object identifier of the ArchiveTimeStampToken attribute.

Constructor Summary

Constructors

Constructor and Description
ArchiveTimeStampv3() Empty default constructor.
ArchiveTimeStampv3(iaik.asn1.ASN1Object timestampToken) Creates a TimeStampToken from its ASN.1 representation.
ArchiveTimeStampv3(iaik.asn1.ASN1Object timestampToken, byte[] protectedDataImprint) Creates a TimeStampToken from its ASN.1 representation.

Method Summary

Modifier and Type	Method and Description
void	decode(iaik.asn1.ASN1Object obj) Decodes the given ASN.1 ArchiveTimeStampToken object
boolean	equals(java.lang.Object obj) Compares this ArchiveTimeStampToken to the specified object.
AbstractAtsHashIndex	getAtsHashIndex() Returns the AtsHashIndex attribute, that shall be included in every archive timestamp, as unsigned attribute.
iaik.asn1.ObjectID	getAttributeType()
iaik.tsp.TimeStampToken	getTimeStampToken() Returns the attribute value of this ArchiveTimeStamp as TimeStampToken object.
boolean	multipleAllowed()
iaik.asn1.ASN1Object	toASN1Object() Returns this ArchiveTimeStampToken as ASN1Object.
java.lang.String	toString()
void	verifyTimeStampToken(iaik.x509.X509Certificate tsa_certificate) Verify this archive timestamp's signature and ensure that the timestamp's imprint corresponds to the expected imprint.

Methods inherited from class iaik.asn1.structures.AttributeValue

getName

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

oid

public static final iaik.asn1.ObjectID oid

The attributeType object identifier of the ArchiveTimeStampToken attribute. The corresponding OID string is "0.4.0.1733.2.4".

DEFAULTHASHALGORITHM

public static final iaik.asn1.structures.AlgorithmID DEFAULTHASHALGORITHM

Default digest algorithm that may be used for generating the TimeStampToken - equal to AbstractAtsHashIndex.DEFAULTHASHALGORITHM.

Constructor Detail

ArchiveTimeStampv3

public ArchiveTimeStampv3()

Empty default constructor. Required for dynamic object creation. Shall NOT be used by an application.

ArchiveTimeStampv3

public ArchiveTimeStampv3(iaik.asn1.ASN1Object timestampToken)
                   throws iaik.asn1.CodingException

Creates a TimeStampToken from its ASN.1 representation.

Parameters:

timestampToken - the TimeStampToken as ASN1Object

Throws:

iaik.asn1.CodingException - if the ASN.1 object could not be parsed

ArchiveTimeStampv3

public ArchiveTimeStampv3(iaik.asn1.ASN1Object timestampToken,
                          byte[] protectedDataImprint)
                   throws iaik.asn1.CodingException

Creates a TimeStampToken from its ASN.1 representation. To be able to verify the timestamp using verifyTimeStampToken(X509Certificate) the imprint of the data protected by this timestamp is set internally by using this constructor. The given protectedDataImprint is the digest of the protected data using the same digest algorithm as used in the given timestamp object.

Parameters:

timestampToken - the timestamp object as ASN.1 object

protectedDataImprint - the imprint of the data protected by this timestamp

Throws:

iaik.asn1.CodingException - if the ASN.1 object could not be parsed

Method Detail

getAtsHashIndex

public AbstractAtsHashIndex getAtsHashIndex()
                                     throws CmsCadesException

Returns the AtsHashIndex attribute, that shall be included in every archive timestamp, as unsigned attribute.

Returns:

the AtsHashIndex attribute, either of type AtsHashIndex or AtsHashIndexv3

Throws:

CmsCadesException - if the AtsHashIndex attribute could not be extracted from the timestamp object

getTimeStampToken

public iaik.tsp.TimeStampToken getTimeStampToken()
                                          throws CmsCadesException

Returns the attribute value of this ArchiveTimeStamp as TimeStampToken object.

Returns:

the attribute's value as TimeStampToken object

Throws:

CmsCadesException - if the timestamp token could not be parsed

verifyTimeStampToken

public void verifyTimeStampToken(iaik.x509.X509Certificate tsa_certificate)
                          throws CmsCadesException,
                                 iaik.tsp.TspVerificationException

Verify this archive timestamp's signature and ensure that the timestamp's imprint corresponds to the expected imprint. To verify the signature value the given TSA certificate is used. If the given TSA certificate is null and this timestamp contains the corresponding TSA certificate, the included TSA certificate is used.

Parameters:

tsa_certificate - the certificate of the timestamp authority

Throws:

CmsCadesException - if the imprint is invalid or the timestamp token could not be parsed or no TSA certificate is available

iaik.tsp.TspVerificationException - if this timestamp's signature could not be verified

decode

public void decode(iaik.asn1.ASN1Object obj)
            throws iaik.asn1.CodingException

Decodes the given ASN.1 ArchiveTimeStampToken object

Parameters:

obj - the ArchiveTimeStampToken as ASN1Object

Throws:

iaik.asn1.CodingException - if the ASN1Object could not be parsed

toASN1Object

public iaik.asn1.ASN1Object toASN1Object()
                                  throws iaik.asn1.CodingException

Returns this ArchiveTimeStampToken as ASN1Object.

Returns:

this ArchiveTimeStampToken as ASN1Object

Throws:

iaik.asn1.CodingException - if an de/encoding error occurs

getAttributeType

public iaik.asn1.ObjectID getAttributeType()

Specified by:

getAttributeType in class iaik.asn1.structures.AttributeValue

toString

public java.lang.String toString()

Specified by:

toString in class iaik.asn1.structures.AttributeValue

equals

public boolean equals(java.lang.Object obj)

Compares this ArchiveTimeStampToken to the specified object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare this ArchiveTimeStampToken against.

Returns:

true, if the given object is equal to this ArchiveTimeStampToken, false otherwise

multipleAllowed

public boolean multipleAllowed()

Overrides:

multipleAllowed in class iaik.asn1.structures.AttributeValue