Bouncy Castle Cryptography Library 1.87

org.bouncycastle.tsp
Class TimeStampToken

java.lang.Object
  extended byorg.bouncycastle.tsp.TimeStampToken

public class TimeStampToken
extends java.lang.Object

Carrier class for an RFC 3161 time-stamp token - the (CMS) structure, with content type id-ct-TSTInfo, signed by the TSA. Provides access to the embedded TimeStampTokenInfo and the means to verify the token against the signing certificate (see validate(SignerInformationVerifier)).

Construction checks the token's structure: the content type is id-ct-TSTInfo, there is exactly one signer, a signing-certificate signed attribute is present, and a signing-time signed attribute, if present, agrees with the TSTInfo genTime to within the token's accuracy (plus a one minute allowance). The last check can be disabled with Properties.TSP_ALLOW_INCONSISTENT_SIGNING_TIME.


Constructor Summary
TimeStampToken(CMSSignedData signedData)
           
TimeStampToken(org.bouncycastle.asn1.cms.ContentInfo contentInfo)
           
 
Method Summary
 org.bouncycastle.util.Store getAttributeCertificates()
           
 org.bouncycastle.util.Store getCertificates()
           
 org.bouncycastle.util.Store getCRLs()
           
 byte[] getEncoded()
          Return a ASN.1 encoded byte stream representing the encoded object.
 byte[] getEncoded(java.lang.String encoding)
          return the ASN.1 encoded representation of this object using the specified encoding.
 SignerId getSID()
           
 org.bouncycastle.asn1.cms.AttributeTable getSignedAttributes()
           
 TimeStampTokenInfo getTimeStampInfo()
           
 org.bouncycastle.asn1.cms.AttributeTable getUnsignedAttributes()
           
 boolean isSignatureValid(SignerInformationVerifier sigVerifier)
          Return true if the signature on time stamp token is valid.
 CMSSignedData toCMSSignedData()
          Return the underlying CMSSignedData object.
 void validate(SignerInformationVerifier sigVerifier)
          Validate the time stamp token.
 void validate(SignerInformationVerifier sigVerifier, java.util.Set allowedImprintAlgorithms)
          Validate the time stamp token, as for validate(SignerInformationVerifier), but accepting a message imprint calculated with any of the passed in hash algorithms.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TimeStampToken

public TimeStampToken(org.bouncycastle.asn1.cms.ContentInfo contentInfo)
               throws TSPException,
                      java.io.IOException

TimeStampToken

public TimeStampToken(CMSSignedData signedData)
               throws TSPException,
                      java.io.IOException
Method Detail

getTimeStampInfo

public TimeStampTokenInfo getTimeStampInfo()
Returns:
the parsed TSTInfo carried by this token.

getSID

public SignerId getSID()
Returns:
the identifier of the signer (the TSA) of this token.

getSignedAttributes

public org.bouncycastle.asn1.cms.AttributeTable getSignedAttributes()
Returns:
the table of signed (authenticated) attributes on the token.

getUnsignedAttributes

public org.bouncycastle.asn1.cms.AttributeTable getUnsignedAttributes()
Returns:
the table of unsigned attributes on the token, null if there are none.

getCertificates

public org.bouncycastle.util.Store getCertificates()
Returns:
a Store of the X.509 certificates carried by the token.

getCRLs

public org.bouncycastle.util.Store getCRLs()
Returns:
a Store of the CRLs carried by the token.

getAttributeCertificates

public org.bouncycastle.util.Store getAttributeCertificates()
Returns:
a Store of the X.509 attribute certificates carried by the token.

validate

public void validate(SignerInformationVerifier sigVerifier)
              throws TSPException,
                     TSPValidationException
Validate the time stamp token.

To be valid the token must be signed by the passed in certificate and the certificate must be the one referred to by the SigningCertificate attribute included in the hashed attributes of the token. The certificate must also have the ExtendedKeyUsageExtension with only KeyPurposeId.id_kp_timeStamping and have been valid at the time the timestamp was created.

The message imprint must also use a hash algorithm in TSPAlgorithms.ALLOWED, or in the list given by Properties.TSP_ALLOWED_IMPRINT_ALGORITHMS if it is set.

A successful call to validate means all the above are true.

Parameters:
sigVerifier - the content verifier create the objects required to verify the CMS object in the timestamp.
Throws:
TSPException - if an exception occurs in processing the token, or the imprint algorithm property names an unknown digest.
TSPValidationException - if the certificate or signature fail to be valid.
java.lang.IllegalArgumentException - if the sigVerifierProvider has no associated certificate.

validate

public void validate(SignerInformationVerifier sigVerifier,
                     java.util.Set allowedImprintAlgorithms)
              throws TSPException,
                     TSPValidationException
Validate the time stamp token, as for validate(SignerInformationVerifier), but accepting a message imprint calculated with any of the passed in hash algorithms.

Parameters:
sigVerifier - the content verifier create the objects required to verify the CMS object in the timestamp.
allowedImprintAlgorithms - the OIDs of the hash algorithms acceptable for the message imprint.
Throws:
TSPException - if an exception occurs in processing the token.
TSPValidationException - if the imprint algorithm is not allowed (failure code badAlg), or the certificate or signature fail to be valid.
java.lang.IllegalArgumentException - if the sigVerifierProvider has no associated certificate.

isSignatureValid

public boolean isSignatureValid(SignerInformationVerifier sigVerifier)
                         throws TSPException
Return true if the signature on time stamp token is valid.

Note: this is a much weaker proof of correctness than calling validate().

Parameters:
sigVerifier - the content verifier create the objects required to verify the CMS object in the timestamp.
Returns:
true if the signature matches, false otherwise.
Throws:
TSPException - if the signature cannot be processed or the provider cannot match the algorithm.

toCMSSignedData

public CMSSignedData toCMSSignedData()
Return the underlying CMSSignedData object.

Returns:
the underlying CMS structure.

getEncoded

public byte[] getEncoded()
                  throws java.io.IOException
Return a ASN.1 encoded byte stream representing the encoded object.

Throws:
java.io.IOException - if encoding fails.

getEncoded

public byte[] getEncoded(java.lang.String encoding)
                  throws java.io.IOException
return the ASN.1 encoded representation of this object using the specified encoding.

Parameters:
encoding - the ASN.1 encoding format to use ("BER", "DL", or "DER").
Throws:
java.io.IOException

Bouncy Castle Cryptography Library 1.87