Index

  1. \setasign\SetaPDF2
    1. Signer
      1. Tsp
        1. Response
        2. Token

setasign\SetaPDF2\Signer\Tsp

Token Class representing a Timestamp Token

File: /SetaPDF v2/Signer/Tsp/Token.php
Old class name (alias): \SetaPDF_Signer_Tsp_Token

Class hierarchy

Summary

Static Properties

Methods

Properties

Static Properties

$usePhpseclibForRsaPss

static public bool \setasign\SetaPDF2\Signer\Asn1\Signed::$usePhpseclibForRsaPss = true

Flag defining whether usage of phpseclib or default OpenSSL methods for RSA_PSS validation.

$verifyCallback

static public ?callable \setasign\SetaPDF2\Signer\Asn1\Signed::$verifyCallback

A callable that can be used to implement individual verification logic.


Properties

$_detachedSignedData

protected string|\SetaPDF_Core_Reader_FilePath \setasign\SetaPDF2\Signer\Cms\SignedData::$_detachedSignedData

The detached signed data.

$_message

protected \SetaPDF_Signer_Asn1_Element Token::$_message

The token message.

$_signedAttributes

protected \SetaPDF_Signer_Asn1_Element[] \setasign\SetaPDF2\Signer\Cms\SignedData::$_signedAttributes

All signed attributes. Indexed by their OID.

$_tstInfo

protected Token::$_tstInfo

$_unsignedAttributes

protected \SetaPDF_Signer_Asn1_Element[] \setasign\SetaPDF2\Signer\Cms\SignedData::$_unsignedAttributes

All unsigned attributes. Indexed by their OID.


Methods

__construct()

public Token::__construct ()

Token constructor.

Parameters
$message : \SetaPDF_Signer_Asn1_Element
 
Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

_getSignedData()

protected \setasign\SetaPDF2\Signer\Cms\SignedData::_getSignedData (
void
): bool|\SetaPDF_Signer_Asn1_Element

Get SignedData element from the ASN.1 structure.

_getSignerInfo()

protected \setasign\SetaPDF2\Signer\Cms\SignedData::_getSignerInfo (
void
): bool|\SetaPDF_Signer_Asn1_Element

Get the SignerInfo element from the ASN.1 structure.

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

_getTstInfo()

protected Token::_getTstInfo (
void
): \SetaPDF_Signer_Asn1_Element

Get the timestamp token info element.

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

getAsn1()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getAsn1 (
void
): \SetaPDF_Signer_Asn1_Element

Get the ASN.1 instance of the SignedData element.

getCertificates()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getCertificates (
void
): \SetaPDF_Signer_X509_Collection

Get all certificates embedded in the SignedData structure.

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

getDigestAlgorithm()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getDigestAlgorithm (
void
): void
Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getDigestAlgorithms()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getDigestAlgorithms (
void
): array

Get the digest algorithms and parameters.

Return Values

An array of arrays where the first value holds the OID of the algorithm. The second value is the ASN.1 structure of the parameters.

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getGenerationTime()

public Token::getGenerationTime (
void
): \DateTime

Get the generation time.

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

getIssuerAndSerialNumber()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getIssuerAndSerialNumber (
void
): array|bool

Get issuer and serial number of the signee.

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

getMessageImprint()

public Token::getMessageImprint (
void
): bool|\SetaPDF_Signer_Asn1_Element

Get the message imprint element.

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

getNonce()

public Token::getNonce (
void
): bool|string

Get the none value.

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

getSerialNumber()

public Token::getSerialNumber (
void
): string

Get the serial number of the token.

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

getSignatureAlgorithm()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getSignatureAlgorithm (
void
): array
Return Values

The first value holds the OID of the algorithm. The second value is the ASN.1 structure of the parameters.

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getSignatureValue()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getSignatureValue (
bool $hex = true
): string
Parameters
$hex : bool
 
Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getSignedAttribute()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getSignedAttribute (
string $oid
): bool|mixed|\SetaPDF_Signer_Asn1_Element

Get a signed attribute by its OID.

Parameters
$oid : string
 
Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getSignedAttributes()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getSignedAttributes (
void
): array|\SetaPDF_Signer_Asn1_Element[]

Get all signed attributes.

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getSignedData()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getSignedData (
void
): \SetaPDF_Core_Reader_FilePath|string|false
Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getSigningCertificate()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getSigningCertificate (
?\SetaPDF_Signer_X509_Collection $extraCertificates = null
): bool|false|\SetaPDF_Signer_X509_Certificate|\SetaPDF_Signer_X509_CollectionInterface

Get the signing certificate.

Parameters
$extraCertificates : ?\SetaPDF_Signer_X509_Collection
 
Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

getSubjectKeyIdentifier()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getSubjectKeyIdentifier (
void
): bool|string

Get the subject key identifier.

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getUnsignedAttribute()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getUnsignedAttribute (
string $oid
): bool|mixed|\SetaPDF_Signer_Asn1_Element

Get an unsigned attribute by its OID.

Parameters
$oid : string
 
Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getUnsignedAttributes()

public \setasign\SetaPDF2\Signer\Cms\SignedData::getUnsignedAttributes (
void
): array|\SetaPDF_Signer_Asn1_Element[]

Get all unsigned attributes.

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

setDetachedSignedData()

public Token::setDetachedSignedData (
\SetaPDF_Core_Reader_FilePath|string $detachedSignedData
): void

Overwritte to disable this method. It is not allowed to use it in a timestamp token instance.

Parameters
$detachedSignedData : \SetaPDF_Core_Reader_FilePath|string
 

verify()

public Token::verify (): bool
Parameters
$signerCertificate : \SetaPDF_Signer_X509_Certificate
 
Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

verifyMessageImprint()

public Token::verifyMessageImprint (): bool

Verifies the message imprint.

Parameters
$data : string|\SetaPDF_Core_Reader_FilePath
 
Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception


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