Index

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

SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl A timestamp module using the RFC 3161 Standard

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

Class hierarchy

Implements

Summary

Static Properties

Methods

Properties

Static Properties

$statusCodes

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

PKI Status values

$userAgent

static public string SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl::$userAgent = 'SetaPDF-Signer Component TS-Module/2.0'

User agent send in timestamp request

Required by most TS servers


Properties

$_curlOptions

protected array SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl::$_curlOptions = array()

Additional curl options

$_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

$_lastResponse

protected string|false SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl::$_lastResponse

The last response of the timestamp server

$_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

$allowedResponseContentTypes

public string[] SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl::$allowedResponseContentTypes = array(...)

An array of allowed response content-types.


Methods

__construct()

public SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl::__construct (
[ string $url = null ]
)

The constructor.

Parameters
$url : string

URL of the timestamp server

_createTimestamp()

protected SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl::_createTimestamp (
string $timeStampRequest
): bool

Send the timestamp request and evaluates the response.

Parameters
$timeStampRequest : string
 
Exceptions

Throws SetaPDF_Signer_Exception

_getHash()

protected SetaPDF_Signer_Timestamp_Module_AbstractModule::_getHash (): 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

Creates the timestamp request structure.

Parameters
$data : string|SetaPDF_Core_Reader_FilePath
 

_verifyResponse()

protected SetaPDF_Signer_Timestamp_Module_Rfc3161::_verifyResponse (): void
Parameters
$tsResponse : SetaPDF_Signer_Tsp_Response
 

createTimestamp()

public SetaPDF_Signer_Timestamp_Module_Rfc3161::createTimestamp (): string

Create the timestamp signature.

Parameters
$data : string|SetaPDF_Core_Reader_FilePath
 
Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getCurlOption()

public SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl::getCurlOption (
int $option
): string|null

Returns a defined Curl option or null if not set.

Parameters
$option : int

The CURLOPT_XXX option to set

getDigest()

public SetaPDF_Signer_Timestamp_Module_AbstractModule::getDigest (
void
): string

Get the digest algorithm.

getLastResponse()

public SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl::getLastResponse (
void
): string|false

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

getReqPolicy()

public SetaPDF_Signer_Timestamp_Module_Rfc3161::getReqPolicy (
void
): string

Get the reqPolicy value / OID.

See

getUrl()

public SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl::getUrl (
void
): string|null

Returns the URL of the timestamp server.

setCurlOption()

public SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl::setCurlOption (
int|array $option [, string|null $value = null ]
): void

Sets one or more Curl options with the assigned value.

Parameters
$option : int|array

The CURLOPT_XXX option to set

$value : string|null

The value to be set on option

See

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

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

setUrl()

public SetaPDF_Signer_Timestamp_Module_Rfc3161_Curl::setUrl (
string $url
): void

Sets the URL of the timestamp server.

Parameters
$url : string

The url to the timestamp server


© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)