SetaPDF v2 API Reference

): \setasign\SetaPDF2\Core\Type\IndirectObjectInterface

addForeignStreamArtifactValidationRelatedInfo()

public DocumentSecurityStore::addForeignStreamArtifactValidationRelatedInfo (

string $vriKey,
string $type,
string $data

Add foreign stream artifacts to a VRI dictionary.

Parameters

$vriKey: string: The VRI key
$type: string: The foreigh type name
$data: string: The stream data

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

): \setasign\SetaPDF2\Core\Type\AbstractType|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface

addOCSP()

public DocumentSecurityStore::addOCSP (

string|Ocsp\Response $ocspResponse

Add a OCSP response to the OCSPs entry in the DSS dictionary.

Parameters

$ocspResponse: string|Ocsp\Response

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws Asn1 \Exception

Throws Exception

addOCSPs()

public DocumentSecurityStore::addOCSPs (

array<string|Ocsp\Response> $ocsps

): void

Add OCSP responses to the OCSPs entry in the DSS dictionary.

Parameters

$ocsps: array<string|Ocsp\Response>

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws Asn1 \Exception

Throws Exception

addValidationRelatedInfo()

public DocumentSecurityStore::addValidationRelatedInfo (

): void

Add validation related information to the VRI dictionary of the DSS dictionary.

Parameters

$key: string: The sha1 digest of the signature.
$crls: array<string|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface|X509\Crl>: An array of strings, X509\Crl instances or \setasign\SetaPDF2\Core\Type\IndirectObjectInterface to streams of the CRLs.
$ocsps: array<string|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface|Ocsp\Response>: An array of strings, Ocsp\Response instances or \setasign\SetaPDF2\Core\Type\IndirectObjectInterface to streams of the OCSPs.
$certs: array<string|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface|X509\Certificate>: An array of strings, X509\Certificate instances or \setasign\SetaPDF2\Core\Type\IndirectObjectInterface to streams of the certs.
$timestamp: null|\setasign\SetaPDF2\Core\DataStructure\Date|\DateTime|string

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws Asn1 \Exception

Throws Exception

Throws \Exception

addValidationRelatedInfoByField()

WARNING: This method is marked as deprecated!

Use DocumentSecurityStore::addValidationRelatedInfoByFieldName() instead.

public DocumentSecurityStore::addValidationRelatedInfoByField (

): void

Parameters

$fieldName: string: The signature field name.
$crls: array<string|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface|X509\Crl>: An array of strings or \setasign\SetaPDF2\Core\Type\IndirectObjectInterface to streams of the CRLs.
$ocsps: array<string|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface|Ocsp\Response>: An array of strings or \setasign\SetaPDF2\Core\Type\IndirectObjectInterface to streams of the OCSPs.
$certs: array<string|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface|X509\Certificate>: An array of strings or \setasign\SetaPDF2\Core\Type\IndirectObjectInterface to streams of the certs.
$timestamp: null|\setasign\SetaPDF2\Core\DataStructure\Date|\DateTime|string

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws Asn1 \Exception

Throws Exception

See

DocumentSecurityStore::addValidationRelatedInfoByFieldName()

addValidationRelatedInfoByFieldName()

public DocumentSecurityStore::addValidationRelatedInfoByFieldName (

): void

Add validation related information to the VRI dictionary of the DSS dictionary by a specific signature field.

Parameters

$fieldName: string: The signature field name.
$crls: array<string|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface|X509\Crl>: An array of strings or \setasign\SetaPDF2\Core\Type\IndirectObjectInterface to streams of the CRLs.
$ocsps: array<string|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface|Ocsp\Response>: An array of strings or \setasign\SetaPDF2\Core\Type\IndirectObjectInterface to streams of the OCSPs.
$certs: array<string|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface|X509\Certificate>: An array of strings or \setasign\SetaPDF2\Core\Type\IndirectObjectInterface to streams of the certs.
$timestamp: null|\setasign\SetaPDF2\Core\DataStructure\Date|\DateTime|string

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws Asn1 \Exception

Throws Exception

addValidationRelatedInfoResultByField()

public DocumentSecurityStore::addValidationRelatedInfoResultByField (

string $fieldName,
ValidationRelatedInfo\Result $result

): void

Parameters

$fieldName: string: The signature field name.
$result: ValidationRelatedInfo\Result: The VRI result object with data for the given field.

Exceptions

Throws Asn1 \Exception

Throws Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

cleanUp()

public DocumentSecurityStore::cleanUp (

void

): void

Release cycled references.

getCRLs()

public DocumentSecurityStore::getCRLs (

void

): string[]

Get all CRLs the OCSPs entry in the DSS dictionary.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getCertificates()

public DocumentSecurityStore::getCertificates (

void

): string[]

Get all certificates from the Certs entry in the DSS dictionary.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

): ?\setasign\SetaPDF2\Core\Type\PdfDictionary

getDictionary()

public DocumentSecurityStore::getDictionary (

bool $create = false

Get and/or creates the DSS dictionary.

Parameters

$create: bool

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getForeignStreamArtifactValidationRelatedInfo()

public DocumentSecurityStore::getForeignStreamArtifactValidationRelatedInfo (

string $vriKey,
string $type

): array

Get foreign stream artifacts to a VRI dictionary.

Parameters

$vriKey: string
$type: string

Exceptions

Throws Exception

getForeignStreamArtifacts()

public DocumentSecurityStore::getForeignStreamArtifacts (

string $type

): array

Get foreign artifacts from the main DSS dictionary by a foreign type name.

Parameters

$type: string

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getOCSPs()

public DocumentSecurityStore::getOCSPs (

void

): string[]

Get all OCSP responses from the OCSPs entry in the DSS dictionary.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getOptimizeOcspResponses()

public DocumentSecurityStore::getOptimizeOcspResponses (

void

): bool

Get whether OCSP responses should be optimized or not.

See

DocumentSecurityStore::setOptimizeOcspResponses()

getSignatureDigest()

WARNING: This method is marked as deprecated!

Use DocumentSecurityStore::getVriNameByFieldName() instead.

public DocumentSecurityStore::getSignatureDigest (

string $fieldName

): string

Parameters

$fieldName: string

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

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

Throws Asn1 \Exception

Throws Exception

See

DocumentSecurityStore::getVriNameByFieldName()

getValidationRelatedInfo()

public DocumentSecurityStore::getValidationRelatedInfo (

?string $vriKey = null

): array<string, array|false>|array{certs: array, crls: array, ocsps: array, timestamp: \DateTimeInterface}|false

Get validation related information.

Parameters

$vriKey: ?string: The sha1 digest of the signature to get specific information. Otherwise, all found validation data is returned.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getValidationRelatedInfoByField()

WARNING: This method is marked as deprecated!

Use DocumentSecurityStore::getValidationRelatedInfoByFieldName() instead.

public DocumentSecurityStore::getValidationRelatedInfoByField (

string $fieldName

): array<string, array|false>|array{certs: array, crls: array, ocsps: array, timestamp: \DateTimeInterface}|false

Parameters

$fieldName: string: The signature field name.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws Asn1 \Exception

See

DocumentSecurityStore::getValidationRelatedInfoByFieldName()

getValidationRelatedInfoByFieldName()

public DocumentSecurityStore::getValidationRelatedInfoByFieldName (

string $fieldName

): array<string, array|false>|array{certs: array, crls: array, ocsps: array, timestamp: \DateTimeInterface}|false

Get validation related information by a signature field name.

Parameters

$fieldName: string: The signature field name.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws Asn1 \Exception

getVriName()

public DocumentSecurityStore::getVriName (

Asn1\Signed $object

): string

Get the signature digest of a CRL or OCSP response which can be used as an index in the VRI dictionary.

Parameters

$object: Asn1\Signed

getVriNameByFieldName()

public DocumentSecurityStore::getVriNameByFieldName (

string $fieldName

): string

Get the signature digest of a signature field, which can be used as an index in the VRI dictionary.

For a document signature the bytes that are hashed are those of the signature's DER-encoded PKCS#7 (and its derivatives) binary data object (base-16 decoded byte string in the Contents entry in the signature dictionary).

For the signatures of the CRL and OCSP response, it is the respective signature object represented as a BER-encoded OCTET STRING encoded with primitive encoding.

For a Time-stamp's signature it is the bytes of the Time-stamp itself since the Time-stamp token is a signed data object.

Parameters

$fieldName: string

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

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

Throws Asn1 \Exception

Throws Exception

remove()

public DocumentSecurityStore::remove (

void

): bool

Removes the DSS entry from the catalog dictionary.

Return Values

True if the entry existed or false if not.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception