TimeStampReq ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- com.entrust.toolkit.asn1.tsp.TimeStampReq

All Implemented Interfaces:

ASN1Type
```
public class TimeStampReq
extends java.lang.Object
implements ASN1Type
```
This class implements the TimeStampReq structure as defined in RFC 3161, the Time-Stamp Protocol (TSP) specification.
```
 TimeStampReq ::= SEQUENCE  {
     version           INTEGER  { v1(1) },
     messageImprint    MessageImprint,
     --a hash algorithm OID and the hash value of the data to be
     --time-stamped
     reqPolicy         TSAPolicyId                OPTIONAL,
     nonce             INTEGER                    OPTIONAL,
     certReq           BOOLEAN                    DEFAULT FALSE,
     extensions        [0] IMPLICIT Extensions    OPTIONAL
 }
 
 TSAPolicyId ::= OBJECT IDENTIFIER
 
```
The messageImprint field SHOULD contain the hash of the datum to be time-stamped. The hash is represented as an OCTET STRING.

The reqPolicy field, if included, indicates the TSA policy under which the TimeStampToken SHOULD be provided.

The nonce, if included, allows the client to verify the timeliness of the response when no local clock is available. The nonce is a large random number with a high probability that the client generates it only once (e.g., a 64 bit integer). In such a case the same nonce value MUST be included in the response, otherwise the response shall be rejected.

If the certReq field is present and set to true, the TSA's public key certificate that is referenced by the ESSCertID identifier inside a SigningCertificate attribute in the response MUST be provided by the TSA in the certificates field from the SignedData structure in that response. That field may also contain other certificates.

If the certReq field is missing or if the certReq field is present and set to false then the certificates field from the SignedData structure MUST not be present in the response.

The extensions field is a generic way to add additional information to the request in the future. Extensions is defined in [RFC 3280]. If an extension, whether it is marked critical or not critical, is used by a requester but is not recognized by a time-stamping server, the server SHALL not issue a token and SHALL return a failure (unacceptedExtension).

The time-stamp request does not identify the requester, as this information is not validated by the TSA. In situations where the TSA requires the identity of the requesting entity, alternate identification/authentication means have to be used (e.g., CMS encapsulation or TLS authentication).
Since:

7.0

See Also:

RFC 3161, RFC 3280

Constructor Summary

Constructors
Constructor and Description
`TimeStampReq(ASN1Object obj)` Creates a new `TimeStampReq` object from an `ASN1Object`.
`TimeStampReq(MessageImprint messageImprint)` Creates a new `TimeStampReq` object with the specified components.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExtension(V3Extension extension)` Adds additional information about the request.
`void`	`decode(ASN1Object obj)` Decodes a TimeStampReq object from an `ASN1Object`.
`V3Extension`	`getExtension(ObjectID oid)` Returns a specific piece of addition information about the request, identified by the extension object identifier.
`X509Extensions`	`getExtensions()` Returns additional information about the request.
`MessageImprint`	`getMessageImprint()` Returns the hash of the datum to be time-stamped.
`java.math.BigInteger`	`getNonce()` Indicates if a nonce has been requested.
`ObjectID`	`getReqPolicy()` Returns the TSA request policy.
`int`	`getVersion()` Returns the version of the TimeStampReq structure.
`boolean`	`isCertReq()` Indicates whether the TSA must provide their certificate in the response.
`void`	`setCertReq(java.lang.Boolean certReq)` Sets an indicator for whether the TSA must provide their certificate in the response.
`void`	`setExtensions(X509Extensions extensions)` Sets additional information about the request.
`void`	`setNonce(java.math.BigInteger nonce)` Sets the request nonce.
`void`	`setReqPolicy(ObjectID reqPolicy)` Sets the TSA request policy.
`ASN1Object`	`toASN1Object()` Encodes this `TimeStampReq` object as an `ASN1Object`.
`java.lang.String`	`toString()` Creates a text representation of the ASN.1 structure of this `TimeStampReq` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TimeStampReq
```
public TimeStampReq(MessageImprint messageImprint)
```
    Creates a new TimeStampReq object with the specified components.
    
    Parameters:
    
    messageImprint - the hash of the datum to be time-stamped
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if the parameter is null
  - TimeStampReq
```
public TimeStampReq(ASN1Object obj)
             throws CodingException
```
    Creates a new TimeStampReq object from an ASN1Object.
    The ASN1Object must be a TimeStampReq structure.
    
    Parameters:
    
    obj - the ASN.1 representation of a TimeStampReq structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
    
    java.lang.IllegalArgumentException - thrown if the parameter is null
- Method Detail
  - getVersion
```
public int getVersion()
```
    Returns the version of the TimeStampReq structure.
    
    Returns:
    
    the version component
  - getMessageImprint
```
public MessageImprint getMessageImprint()
```
    Returns the hash of the datum to be time-stamped.
    
    Returns:
    
    the messageImprint component
  - getReqPolicy
```
public ObjectID getReqPolicy()
```
    Returns the TSA request policy.
    
    Returns:
    
    the reqPolicy component; null if the reqPolicy component is not set
  - getNonce
```
public java.math.BigInteger getNonce()
```
    Indicates if a nonce has been requested.
    
    Returns:
    
    the nonce component; null if the nonce component is not set
  - isCertReq
```
public boolean isCertReq()
```
    Indicates whether the TSA must provide their certificate in the response.
    
    Returns:
    
    the certReq component; false if the certReq component was not set
  - getExtensions
```
public X509Extensions getExtensions()
```
    Returns additional information about the request.
    
    Returns:
    
    the extensions component; null if the tsa component is not set
  - getExtension
```
public V3Extension getExtension(ObjectID oid)
                         throws X509ExtensionInitException
```
    Returns a specific piece of addition information about the request, identified by the extension object identifier.
    
    Returns:
    
    an extension from the extensions component; null if the requested extension does not exist in the extensions component
    
    Throws:
    
    X509ExtensionInitException - if there is a problem with the extension
  - setReqPolicy
```
public void setReqPolicy(ObjectID reqPolicy)
```
    Sets the TSA request policy.
    
    Parameters:
    
    reqPolicy - the reqPolicy component
  - setNonce
```
public void setNonce(java.math.BigInteger nonce)
```
    Sets the request nonce.
    
    Parameters:
    
    nonce - the nonce component
  - setCertReq
```
public void setCertReq(java.lang.Boolean certReq)
```
    Sets an indicator for whether the TSA must provide their certificate in the response.
    
    Parameters:
    
    certReq - the certReq component
  - setExtensions
```
public void setExtensions(X509Extensions extensions)
```
    Sets additional information about the request.
    
    Parameters:
    
    extensions - the extensions component
  - addExtension
```
public void addExtension(V3Extension extension)
                  throws X509ExtensionException
```
    Adds additional information about the request.
    
    Parameters:
    
    extension - an extension
    
    Throws:
    
    X509ExtensionException
  - decode
```
public void decode(ASN1Object obj)
            throws CodingException
```
    Decodes a TimeStampReq object from an ASN1Object.
    The ASN1Object must contain a TimeStampReq structure.
    
    Specified by:
    
    decode in interface ASN1Type
    
    Parameters:
    
    obj - an ASN.1 representation of a TimeStampReq structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
    
    java.lang.IllegalArgumentException - thrown if the parameter is null
  - toASN1Object
```
public ASN1Object toASN1Object()
                        throws CodingException
```
    Encodes this TimeStampReq object as an ASN1Object.
    
    Specified by:
    
    toASN1Object in interface ASN1Type
    
    Returns:
    
    an ASN.1 representation of the TimeStampReq structure
    
    Throws:
    
    CodingException - thrown if an error occurs while encoding the 'extensions' component
  - toString
```
public java.lang.String toString()
```
    Creates a text representation of the ASN.1 structure of this TimeStampReq object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a text representation of the ASN.1 structure of this object

Class TimeStampReq

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TimeStampReq

TimeStampReq

Method Detail

getVersion

getMessageImprint

getReqPolicy

getNonce

isCertReq

getExtensions

getExtension

setReqPolicy

setNonce

setCertReq

setExtensions

addExtension

decode

toASN1Object

toString