Class SetaPDF_Signer_ValidationRelatedInfo_Collector in SetaPDF v2 API Reference

Index

\SetaPDF
1. Signer
2. Signer
  1. ValidationRelatedInfo

SetaPDF_Signer_ValidationRelatedInfo_Collector Class offering methods to collect validation related information.

File: /SetaPDF v2/Signer/ValidationRelatedInfo/Collector.php

Class hierarchy

SetaPDF_Signer_ValidationRelatedInfo_Collector

Summary

Constants

SOURCE_CRL

public const int SetaPDF_Signer_ValidationRelatedInfo_Collector::SOURCE_CRL = 4

Source constant.

SOURCE_OCSP

public const int SetaPDF_Signer_ValidationRelatedInfo_Collector::SOURCE_OCSP = 2

Source constant.

SOURCE_OCSP_AND_CRL

public const int SetaPDF_Signer_ValidationRelatedInfo_Collector::SOURCE_OCSP_AND_CRL = 7

Source constant.

SOURCE_OCSP_OR_CRL

public const int SetaPDF_Signer_ValidationRelatedInfo_Collector::SOURCE_OCSP_OR_CRL = 6

Source constant.

Properties

$_crlCache

protected Psr\SimpleCache\CacheInterface|null SetaPDF_Signer_ValidationRelatedInfo_Collector::$_crlCache

A cache instance for CRLs.

$_crls

protected array SetaPDF_Signer_ValidationRelatedInfo_Collector::$_crls

CRL list indexed by md5 hash of the issuers public key.

$_extraCertificates

protected SetaPDF_Signer_X509_Collection SetaPDF_Signer_ValidationRelatedInfo_Collector::$_extraCertificates

A collection of extra certificates.

$_informationResolverManager

protected SetaPDF_Signer_InformationResolver_Manager SetaPDF_Signer_ValidationRelatedInfo_Collector::$_informationResolverManager

The informatio resolver manager.

$_issuerCache

protected Psr\SimpleCache\CacheInterface|null SetaPDF_Signer_ValidationRelatedInfo_Collector::$_issuerCache

A cache instance for resolved issuer certificates.

$_leftCertificates

protected SetaPDF_Signer_X509_Certificate[] SetaPDF_Signer_ValidationRelatedInfo_Collector::$_leftCertificates

Certificate that needs to be processed.

$_logger

protected SetaPDF_Signer_ValidationRelatedInfo_LoggerInterface SetaPDF_Signer_ValidationRelatedInfo_Collector::$_logger

A logger instance.

$_ocspCache

protected Psr\SimpleCache\CacheInterface|null SetaPDF_Signer_ValidationRelatedInfo_Collector::$_ocspCache

A cache instance for resolved OCSP responses.

$_ocspClient

protected SetaPDF_Signer_Ocsp_Client SetaPDF_Signer_ValidationRelatedInfo_Collector::$_ocspClient

The OCSP client instance.

$_trustedCertificates

protected SetaPDF_Signer_X509_Collection SetaPDF_Signer_ValidationRelatedInfo_Collector::$_trustedCertificates

A collection of trusted certificates.

Static Methods

getSignatureFieldNames()

WARNING: This method is marked as deprecated!

Use SetaPDF_Signer::getSignatureFieldNames() instead.

public static SetaPDF_Signer_ValidationRelatedInfo_Collector::getSignatureFieldNames (

SetaPDF_Core_Document $document

): string[]

Returns all signature field names.

Parameters

$document : SetaPDF_Core_Document

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

See

SetaPDF_Signer::getSignatureFieldNames()

Methods

__construct()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::__construct (

[ SetaPDF_Signer_X509_CollectionInterface|null $trustedCertificates = null ]

)

The constructor.

Parameters

$trustedCertificates : SetaPDF_Signer_X509_CollectionInterface|null

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

_buildPath()

protected SetaPDF_Signer_ValidationRelatedInfo_Collector::_buildPath (

SetaPDF_Signer_X509_Certificate $certificate [, DateTimeInterface|null $dateTime = null [, DateTimeZone|null $timeZone = null ]]

): SetaPDF_Signer_X509_Certificate[]

Build a certificate path by a certificate, date and time.

Internally the method tries to gather issuer certificates through the AIA extension of the certificates if the path couldn't be created.

Parameters

$certificate : SetaPDF_Signer_X509_Certificate
$dateTime : DateTimeInterface|null
$timeZone : DateTimeZone|null

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws \Psr\SimpleCache\InvalidArgumentException

Throws SetaPDF_Signer_ValidationRelatedInfo_Exception

_getAllCertificates()

protected SetaPDF_Signer_ValidationRelatedInfo_Collector::_getAllCertificates (

void

): SetaPDF_Signer_X509_Collection

Get a collection with all certificates (trusted + extra).

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

_getByLeftCertificates()

protected SetaPDF_Signer_ValidationRelatedInfo_Collector::_getByLeftCertificates (

SetaPDF_Signer_ValidationRelatedInfo_Result $result, SetaPDF_Signer_X509_Certificate[] $certificates [, int $sources = SetaPDF_Signer_ValidationRelatedInfo_Collector ::SOURCE_OCSP_OR_CRL [, DateTimeInterface|null $dateTime = null [, DateTimeZone|null $timeZone = null ]]]

): SetaPDF_Signer_ValidationRelatedInfo_Result

Get validation related information by left certificates.

Parameters

$result : SetaPDF_Signer_ValidationRelatedInfo_Result
$certificates : SetaPDF_Signer_X509_Certificate[]
$sources : int
$dateTime : DateTimeInterface|null
$timeZone : DateTimeZone|null

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws \Psr\SimpleCache\InvalidArgumentException

Throws SetaPDF_Signer_ValidationRelatedInfo_Exception

_getOcspResponse()

protected SetaPDF_Signer_ValidationRelatedInfo_Collector::_getOcspResponse (

SetaPDF_Signer_X509_Certificate $certificate

): bool|SetaPDF_Signer_Ocsp_Response

Get an OCSP response by a certificate.

Parameters

$certificate : SetaPDF_Signer_X509_Certificate

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

_processCertificate()

protected SetaPDF_Signer_ValidationRelatedInfo_Collector::_processCertificate (

SetaPDF_Signer_ValidationRelatedInfo_Result $result [, int $sources = SetaPDF_Signer_ValidationRelatedInfo_Collector ::SOURCE_OCSP_OR_CRL [, DateTimeInterface|null $dateTime = null [, DateTimeZone|null $timeZone = null ]]]

): void

Processes a certificate popped from the leftCertificates array.

Parameters

$result : SetaPDF_Signer_ValidationRelatedInfo_Result
$sources : int
$dateTime : DateTimeInterface|null
$timeZone : DateTimeZone|null

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

Throws SetaPDF_Signer_ValidationRelatedInfo_Exception

Throws \Psr\SimpleCache\InvalidArgumentException

getByCertificate()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::getByCertificate (

SetaPDF_Signer_X509_Certificate $certificate [, int $sources = SetaPDF_Signer_ValidationRelatedInfo_Collector ::SOURCE_OCSP_OR_CRL [, DateTimeInterface|null $dateTime = null [, DateTimeZone|null $timeZone = null [, SetaPDF_Signer_ValidationRelatedInfo_Result|null $result = null ]]]]

): SetaPDF_Signer_ValidationRelatedInfo_Result

Get validation related information by a certificate.

Parameters

$certificate : SetaPDF_Signer_X509_Certificate
$sources : int
$dateTime : DateTimeInterface|null
$timeZone : DateTimeZone|null
$result : SetaPDF_Signer_ValidationRelatedInfo_Result|null

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws \Psr\SimpleCache\InvalidArgumentException

Throws SetaPDF_Signer_ValidationRelatedInfo_Exception

getByFieldName()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::getByFieldName (

SetaPDF_Core_Document $document, string $fieldName [, int $sources = SetaPDF_Signer_ValidationRelatedInfo_Collector ::SOURCE_OCSP_OR_CRL [, DateTimeInterface|null $dateTime = null [, DateTimeZone|null $timeZone = null [, SetaPDF_Signer_ValidationRelatedInfo_Result|null $result = null ]]]]

): SetaPDF_Signer_ValidationRelatedInfo_Result|SetaPDF_Signer_ValidationRelatedInfo_ResultByField|SetaPDF_Signer_ValidationRelatedInfo_ResultBySignedData

Get validation related information by a signatue field name.

Parameters

$document : SetaPDF_Core_Document
$fieldName : string
$sources : int
$dateTime : DateTimeInterface|null
$timeZone : DateTimeZone|null
$result : SetaPDF_Signer_ValidationRelatedInfo_Result|null

Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

Throws SetaPDF_Signer_ValidationRelatedInfo_Exception

Throws \Psr\SimpleCache\InvalidArgumentException

getByIntegrityResult()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::getByIntegrityResult (

SetaPDF_Signer_ValidationRelatedInfo_IntegrityResult $integrityResult [, int $sources = SetaPDF_Signer_ValidationRelatedInfo_Collector ::SOURCE_OCSP_OR_CRL [, DateTimeInterface|null $dateTime = null [, DateTimeZone|null $timeZone = null [, SetaPDF_Signer_ValidationRelatedInfo_Result|null $result = null ]]]]

): SetaPDF_Signer_ValidationRelatedInfo_Result|SetaPDF_Signer_ValidationRelatedInfo_ResultByField

Get validation related information by an integrity result.

Parameters

$integrityResult : SetaPDF_Signer_ValidationRelatedInfo_IntegrityResult
$sources : int
$dateTime : DateTimeInterface|null
$timeZone : DateTimeZone|null
$result : SetaPDF_Signer_ValidationRelatedInfo_Result|null

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

Throws SetaPDF_Signer_ValidationRelatedInfo_Exception

Throws \Psr\SimpleCache\InvalidArgumentException

getBySignedData()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::getBySignedData (

SetaPDF_Signer_Cms_SignedData $signedData [, int $sources = SetaPDF_Signer_ValidationRelatedInfo_Collector ::SOURCE_OCSP_OR_CRL [, DateTimeInterface|null $dateTime = null [, DateTimeZone|null $timeZone = null [, SetaPDF_Signer_ValidationRelatedInfo_Result|null $result = null ]]]]

): SetaPDF_Signer_ValidationRelatedInfo_ResultBySignedData

Get validation related information by a SignedData object.

Parameters

$signedData : SetaPDF_Signer_Cms_SignedData
$sources : int
$dateTime : DateTimeInterface|null
$timeZone : DateTimeZone|null
$result : SetaPDF_Signer_ValidationRelatedInfo_Result|null

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

Throws SetaPDF_Signer_ValidationRelatedInfo_Exception

Throws \Psr\SimpleCache\InvalidArgumentException

getCrlCache()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::getCrlCache (

void

): Psr\SimpleCache\CacheInterface|null

Get the cache instance for CRLs.

getExtraCertificates()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::getExtraCertificates (

void

): SetaPDF_Signer_X509_Collection

Get the extra certificates collection.

getInformationResolverManager()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::getInformationResolverManager (

void

): SetaPDF_Signer_InformationResolver_Manager

Get the information resolver manager instance.

If none was explicity was passed before it will create a standard instance with an HTTP resolver that uses cURL.

getIssuerCache()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::getIssuerCache (

void

): Psr\SimpleCache\CacheInterface|null

Get the cache instance for resolved issuer certificates.

getLogger()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::getLogger (

void

): SetaPDF_Signer_ValidationRelatedInfo_LoggerInterface

Get the logger instance.

If no logger instance was passed before a new instance of SetaPDF_Signer_ValidationRelatedInfo_Logger is returned.

getOcspCache()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::getOcspCache (

void

): Psr\SimpleCache\CacheInterface|null

Get the cache instance for OCSP responses.

getOcspClient()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::getOcspClient (

void

): SetaPDF_Signer_Ocsp_Client

Get the OCSP client instance.

getTrustedCertificates()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::getTrustedCertificates (

void

): SetaPDF_Signer_X509_Collection

Get the trusted certificates collection.

setCrlCache()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::setCrlCache (

[ Psr\SimpleCache\CacheInterface|null $crlCache = null ]

): void

Set a cache instance for CRLs.

Parameters

$crlCache : Psr\SimpleCache\CacheInterface|null

setInformationResolverManager()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::setInformationResolverManager (

SetaPDF_Signer_InformationResolver_Manager $manager

): void

Set an information resolver manager instance.

Parameters

$manager : SetaPDF_Signer_InformationResolver_Manager

setIssuerCache()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::setIssuerCache (

[ Psr\SimpleCache\CacheInterface|null $issuerCache = null ]

): void

Set a cache instance for resolved issuer certificates.

Parameters

$issuerCache : Psr\SimpleCache\CacheInterface|null

setLogger()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::setLogger (

SetaPDF_Signer_ValidationRelatedInfo_LoggerInterface $logger

): void

Set a logger instance.

Parameters

$logger : SetaPDF_Signer_ValidationRelatedInfo_LoggerInterface

setOcspCache()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::setOcspCache (

[ Psr\SimpleCache\CacheInterface|null $ocspCache = null ]

): void

Set a cache instance for OCSP responses.

Parameters

$ocspCache : Psr\SimpleCache\CacheInterface|null

setOcspClient()

public SetaPDF_Signer_ValidationRelatedInfo_Collector::setOcspClient (

SetaPDF_Signer_Ocsp_Client $ocspClient

): void

Set an OCSP client instance.

Parameters

$ocspClient : SetaPDF_Signer_Ocsp_Client