SetaPDF v2 API Reference

Index

\SetaPDF
1. Signer
2. Signer
  1. Timestamp
    1. Module
      1. Rfc3161
      2. Rfc3161
        Curl
        Exception

SetaPDF_Signer_Timestamp_Module_Rfc3161 Abstract class representing a timestamp module of the standard RFC 3161

File: /SetaPDF v2/Signer/Timestamp/Module/Rfc3161.php

RFC 3161 describes the format of a request sent to a Time Stamp Authority and of the response that is returned.

Class hierarchy

SetaPDF_Signer_Timestamp_Module_AbstractModule
- SetaPDF_Signer_Timestamp_Module_Rfc3161
  - SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl

Summary

Static Properties

$statusCodes

Methods

_createTimestamp()
_getHash()
_getTimestampRequest()
_verifyResponse()
createTimestamp()
getDigest()
getLastResponse()
getNonce()
getReqPolicy()
setDigest()
setNonce()
setReqPolicy()

Properties

$_digest
$_lastMessageImprint
$_nonce
$_nonceValue
$_reqPolicy

Static Properties

$statusCodes

static public array SetaPDF_Signer_Timestamp_Module_Rfc3161::$statusCodes = array(...)

PKI Status values

Properties

$_digest

protected string SetaPDF_Signer_Timestamp_Module_AbstractModule::$_digest = 'sha256'

The message digest

$_lastMessageImprint

protected SetaPDF_Signer_Asn1_Element SetaPDF_Signer_Timestamp_Module_Rfc3161::$_lastMessageImprint

$_nonce

protected boolean SetaPDF_Signer_Timestamp_Module_Rfc3161::$_nonce = true

Defines if the nonce value should be included in the timestamp request

$_nonceValue

protected string SetaPDF_Signer_Timestamp_Module_Rfc3161::$_nonceValue

The value of the nonce value

$_reqPolicy

protected string SetaPDF_Signer_Timestamp_Module_Rfc3161::$_reqPolicy

The value for reqPolicy in timestamp request

Methods

_createTimestamp()

abstract protected SetaPDF_Signer_Timestamp_Module_Rfc3161::_createTimestamp (

string $timeStampRequest

): bool

Parameters

$timeStampRequest : string

_getHash()

protected SetaPDF_Signer_Timestamp_Module_AbstractModule::_getHash (

string|SetaPDF_Core_Reader_FilePath $data

): string

Get the hash that should be timestamped.

Parameters

$data : string|SetaPDF_Core_Reader_FilePath: The hash of the main signature

_getTimestampRequest()

protected SetaPDF_Signer_Timestamp_Module_Rfc3161::_getTimestampRequest (

string|SetaPDF_Core_Reader_FilePath $data

): string

Creates the timestamp request structure.

Parameters

$data : string|SetaPDF_Core_Reader_FilePath

_verifyResponse()

protected SetaPDF_Signer_Timestamp_Module_Rfc3161::_verifyResponse (

SetaPDF_Signer_Tsp_Response $tsResponse

): void

Parameters

$tsResponse : SetaPDF_Signer_Tsp_Response

createTimestamp()

public SetaPDF_Signer_Timestamp_Module_Rfc3161::createTimestamp (

string|SetaPDF_Core_Reader_FilePath $data

): string

Create the timestamp signature.

Parameters

$data : string|SetaPDF_Core_Reader_FilePath

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getDigest()

public SetaPDF_Signer_Timestamp_Module_AbstractModule::getDigest (

void

): string

Get the digest algorithm.

getLastResponse()

abstract public SetaPDF_Signer_Timestamp_Module_Rfc3161::getLastResponse (

void

): string

Returns the last response of the timestamp server.

getNonce()

public SetaPDF_Signer_Timestamp_Module_Rfc3161::getNonce (

void

): boolean

Queries if nonce should be set.

See

SetaPDF_Signer_Timestamp_Module_Rfc3161::setNonce()

getReqPolicy()

public SetaPDF_Signer_Timestamp_Module_Rfc3161::getReqPolicy (

void

): string

Get the reqPolicy value / OID.

See

SetaPDF_Signer_Timestamp_Module_Rfc3161::setReqPolicy()

setDigest()

public SetaPDF_Signer_Timestamp_Module_AbstractModule::setDigest (

string $digest

): void

Set the digest algorithm to use.

Parameters

$digest : string: Possible values are defined in SetaPDF_Signer_Digest

See

SetaPDF_Signer_Digest

setNonce()

public SetaPDF_Signer_Timestamp_Module_Rfc3161::setNonce (

boolean $nonce

): void

Define if the nonce value should be set or not

"2.4.1 Request Format: [...] 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."

Parameters

$nonce : boolean

See

RFC 3161 - 2.4.1. Request Format

setReqPolicy()

public SetaPDF_Signer_Timestamp_Module_Rfc3161::setReqPolicy (

string $reqPolicy

): void

Set the reqPolicy value / OID.

"2.4.1 Request Format: [...] The reqPolicy field, if included, indicates the TSA policy under which the TimeStampToken SHOULD be provided."

Parameters

$reqPolicy : string

See

RFC 3161 - 2.4.1. Request Format