Class Collector in namespace setasign\SetaPDF2\Signer\ValidationRelatedInfo in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Signer
  1. ValidationRelatedInfo

setasign\SetaPDF2\Signer\ValidationRelatedInfo

Collector Class offering methods to collect validation related information.

File: /SetaPDF v2/Signer/ValidationRelatedInfo/Collector.php
Old class name (alias): \SetaPDF_Signer_ValidationRelatedInfo_Collector

Class hierarchy

Collector

Summary

Constants

SOURCE_CRL

public const int Collector::SOURCE_CRL = 4

Source constant.

SOURCE_OCSP

public const int Collector::SOURCE_OCSP = 2

Source constant.

SOURCE_OCSP_AND_CRL

public const int Collector::SOURCE_OCSP_AND_CRL = 7

Source constant.

SOURCE_OCSP_OR_CRL

public const int Collector::SOURCE_OCSP_OR_CRL = 6

Source constant.

Properties

$_crlCache

protected ?\Psr\SimpleCache\CacheInterface Collector::$_crlCache

A cache instance for CRLs.

$_crls

protected array Collector::$_crls

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

$_extraCertificates

protected \SetaPDF_Signer_X509_Collection Collector::$_extraCertificates

A collection of extra certificates.

$_informationResolverManager

protected \SetaPDF_Signer_InformationResolver_Manager Collector::$_informationResolverManager

The informatio resolver manager.

$_issuerCache

protected ?\Psr\SimpleCache\CacheInterface Collector::$_issuerCache

A cache instance for resolved issuer certificates.

$_leftCertificates

protected \SetaPDF_Signer_X509_Certificate[] Collector::$_leftCertificates

Certificate that needs to be processed.

$_logger

protected LoggerInterface Collector::$_logger

A logger instance.

$_ocspCache

protected ?\Psr\SimpleCache\CacheInterface Collector::$_ocspCache

A cache instance for resolved OCSP responses.

$_ocspClient

protected \SetaPDF_Signer_Ocsp_Client Collector::$_ocspClient

The OCSP client instance.

$_trustedCertificates

protected \SetaPDF_Signer_X509_Collection Collector::$_trustedCertificates

A collection of trusted certificates.

Static Methods

getSignatureFieldNames()

WARNING: This method is marked as deprecated!

Use \setasign\SetaPDF2\Signer\Signer ::getSignatureFieldNames() instead.

public static Collector::getSignatureFieldNames (

\SetaPDF_Core_Document $document

): string[]

Returns all signature field names.

Parameters

$document : \SetaPDF_Core_Document

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

See

\setasign\SetaPDF2\Signer\Signer::getSignatureFieldNames()

Methods

__construct()

public Collector::__construct (

?\SetaPDF_Signer_X509_CollectionInterface $trustedCertificates = null

)

The constructor.

Parameters

$trustedCertificates : ?\SetaPDF_Signer_X509_CollectionInterface

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

_buildPath()

protected Collector::_buildPath (

\SetaPDF_Signer_X509_Certificate $certificate,
?\DateTimeInterface $dateTime = null,
?\DateTimeZone $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
$timeZone : ?\DateTimeZone

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \Psr\SimpleCache\InvalidArgumentException

Throws Exception

_getAllCertificates()

protected Collector::_getAllCertificates (

void

): \SetaPDF_Signer_X509_Collection

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

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

_getByLeftCertificates()

protected Collector::_getByLeftCertificates (

\SetaPDF_Signer_ValidationRelatedInfo_Result $result,
\SetaPDF_Signer_X509_Certificate[] $certificates,
int $sources = Collector ::SOURCE_OCSP_OR_CRL,
?\DateTimeInterface $dateTime = null,
?\DateTimeZone $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
$timeZone : ?\DateTimeZone

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \Psr\SimpleCache\InvalidArgumentException

Throws Exception

_getOcspResponse()

protected 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 \setasign\SetaPDF2\Signer\Asn1\Exception

_processCertificate()

protected Collector::_processCertificate (

\SetaPDF_Signer_ValidationRelatedInfo_Result $result,
int $sources = Collector ::SOURCE_OCSP_OR_CRL,
?\DateTimeInterface $dateTime = null,
?\DateTimeZone $timeZone = null

): void

Processes a certificate popped from the leftCertificates array.

Parameters

$result : \SetaPDF_Signer_ValidationRelatedInfo_Result
$sources : int
$dateTime : ?\DateTimeInterface
$timeZone : ?\DateTimeZone

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

Throws Exception

Throws \Psr\SimpleCache\InvalidArgumentException

getByCertificate()

public Collector::getByCertificate (

\SetaPDF_Signer_X509_Certificate $certificate,
int $sources = Collector ::SOURCE_OCSP_OR_CRL,
?\DateTimeInterface $dateTime = null,
?\DateTimeZone $timeZone = null,
?\SetaPDF_Signer_ValidationRelatedInfo_Result $result = null

): \SetaPDF_Signer_ValidationRelatedInfo_Result

Get validation related information by a certificate.

Parameters

$certificate : \SetaPDF_Signer_X509_Certificate
$sources : int
$dateTime : ?\DateTimeInterface
$timeZone : ?\DateTimeZone
$result : ?\SetaPDF_Signer_ValidationRelatedInfo_Result

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \Psr\SimpleCache\InvalidArgumentException

Throws Exception

getByFieldName()

public Collector::getByFieldName (

\SetaPDF_Core_Document $document,
string $fieldName,
int $sources = Collector ::SOURCE_OCSP_OR_CRL,
?\DateTimeInterface $dateTime = null,
?\DateTimeZone $timeZone = null,
?\SetaPDF_Signer_ValidationRelatedInfo_Result $result = null

): \SetaPDF_Signer_ValidationRelatedInfo_Result|\SetaPDF_Signer_ValidationRelatedInfo_ResultByField|\SetaPDF_Signer_ValidationRelatedInfo_ResultBySignedData

Get validation related information by a signature field name.

Parameters

$document : \SetaPDF_Core_Document
$fieldName : string
$sources : int
$dateTime : ?\DateTimeInterface
$timeZone : ?\DateTimeZone
$result : ?\SetaPDF_Signer_ValidationRelatedInfo_Result

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

Throws Exception

Throws \Psr\SimpleCache\InvalidArgumentException

getByIntegrityResult()

public Collector::getByIntegrityResult (

\SetaPDF_Signer_ValidationRelatedInfo_IntegrityResult $integrityResult,
int $sources = Collector ::SOURCE_OCSP_OR_CRL,
?\DateTimeInterface $dateTime = null,
?\DateTimeZone $timeZone = null,
?\SetaPDF_Signer_ValidationRelatedInfo_Result $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
$timeZone : ?\DateTimeZone
$result : ?\SetaPDF_Signer_ValidationRelatedInfo_Result

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

Throws Exception

Throws \Psr\SimpleCache\InvalidArgumentException

getBySignedData()

public Collector::getBySignedData (

\SetaPDF_Signer_Cms_SignedData $signedData,
int $sources = Collector ::SOURCE_OCSP_OR_CRL,
?\DateTimeInterface $dateTime = null,
?\DateTimeZone $timeZone = null,
?\SetaPDF_Signer_ValidationRelatedInfo_Result $result = null

): \SetaPDF_Signer_ValidationRelatedInfo_ResultBySignedData

Get validation related information by a SignedData object.

Parameters

$signedData : \SetaPDF_Signer_Cms_SignedData
$sources : int
$dateTime : ?\DateTimeInterface
$timeZone : ?\DateTimeZone
$result : ?\SetaPDF_Signer_ValidationRelatedInfo_Result

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

Throws Exception

Throws \Psr\SimpleCache\InvalidArgumentException

getCrlCache()

public Collector::getCrlCache (

void

): ?\Psr\SimpleCache\CacheInterface

Get the cache instance for CRLs.

getExtraCertificates()

public Collector::getExtraCertificates (

void

): \SetaPDF_Signer_X509_Collection

Get the extra certificates collection.

getInformationResolverManager()

public 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 Collector::getIssuerCache (

void

): ?\Psr\SimpleCache\CacheInterface

Get the cache instance for resolved issuer certificates.

getLogger()

public Collector::getLogger (

void

): \SetaPDF_Signer_ValidationRelatedInfo_LoggerInterface

Get the logger instance.

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

getOcspCache()

public Collector::getOcspCache (

void

): ?\Psr\SimpleCache\CacheInterface

Get the cache instance for OCSP responses.

getOcspClient()

public Collector::getOcspClient (

void

): \SetaPDF_Signer_Ocsp_Client

Get the OCSP client instance.

getTrustedCertificates()

public Collector::getTrustedCertificates (

void

): \SetaPDF_Signer_X509_Collection

Get the trusted certificates collection.

setCrlCache()

public Collector::setCrlCache (

?\Psr\SimpleCache\CacheInterface $crlCache = null

): void

Set a cache instance for CRLs.

Parameters

$crlCache : ?\Psr\SimpleCache\CacheInterface

setInformationResolverManager()

public Collector::setInformationResolverManager (

\SetaPDF_Signer_InformationResolver_Manager $manager

): void

Set an information resolver manager instance.

Parameters

$manager : \SetaPDF_Signer_InformationResolver_Manager

setIssuerCache()

public Collector::setIssuerCache (

?\Psr\SimpleCache\CacheInterface $issuerCache = null

): void

Set a cache instance for resolved issuer certificates.

Parameters

$issuerCache : ?\Psr\SimpleCache\CacheInterface

setLogger()

public Collector::setLogger (

\SetaPDF_Signer_ValidationRelatedInfo_LoggerInterface $logger

): void

Set a logger instance.

Parameters

$logger : \SetaPDF_Signer_ValidationRelatedInfo_LoggerInterface

setOcspCache()

public Collector::setOcspCache (

?\Psr\SimpleCache\CacheInterface $ocspCache = null

): void

Set a cache instance for OCSP responses.

Parameters

$ocspCache : ?\Psr\SimpleCache\CacheInterface

setOcspClient()

public Collector::setOcspClient (

\SetaPDF_Signer_Ocsp_Client $ocspClient

): void

Set an OCSP client instance.

Parameters

$ocspClient : \SetaPDF_Signer_Ocsp_Client