SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Signer
  1. Signature
    1. Module

setasign\SetaPDF2\Signer\Signature\Module

PadesProxyTrait A trait for individual modules using the PAdES module internally.

File: /SetaPDF v2/Signer/Signature/Module/PadesProxyTrait.php
Old class name (alias): \SetaPDF_Signer_Signature_Module_PadesProxyTrait

Used in

Summary

Methods

_getPadesModule()
addCrl()
addOcspResponse()
getCertificate()
getCms()
setCertificate()
setExtraCertificates()
updateDocument()
updateSignatureDictionary()

Properties

$_padesModule

Properties

$_padesModule

protected Pades PadesProxyTrait::$_padesModule

Methods

_getPadesModule()

protected PadesProxyTrait::_getPadesModule (

void

Get the internal used PAdES module instance.

addCrl()

public PadesProxyTrait::addCrl (

string|\setasign\SetaPDF2\Signer\X509\Crl $crl

): void

Adds an CRL which will be embedded in the CMS structure.

Parameters

$crl : string|\setasign\SetaPDF2\Signer\X509\Crl

addOcspResponse()

public PadesProxyTrait::addOcspResponse (

string|\setasign\SetaPDF2\Signer\Ocsp\Response $ocspResponse

): void

Adds an OCSP response which will be embedded in the CMS structure.

Parameters

$ocspResponse : string|\setasign\SetaPDF2\Signer\Ocsp\Response: DER encoded OCSP response or OCSP response instance.

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getCertificate()

public PadesProxyTrait::getCertificate (

void

): string|\setasign\SetaPDF2\Signer\X509\Certificate

Get the certificate value.

getCms()

public PadesProxyTrait::getCms (

void

): \setasign\SetaPDF2\Signer\Asn1\Element

Get the complete Cryptographic Message Syntax structure.

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

setCertificate()

public PadesProxyTrait::setCertificate (

string|\setasign\SetaPDF2\Signer\X509\Certificate $certificate

): void

Set the signing certificate.

Parameters

$certificate : string|\setasign\SetaPDF2\Signer\X509\Certificate: PEM encoded certificate, path to the PEM encoded certificate or a certificate instance.

Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

setExtraCertificates()

public PadesProxyTrait::setExtraCertificates (

array|\setasign\SetaPDF2\Signer\X509\Collection $extraCertificates

): void

Add additional certificates which are placed into the CMS structure.

Parameters

$extraCertificates : array|\setasign\SetaPDF2\Signer\X509\Collection: PEM encoded certificates or pathes to PEM encoded certificates.

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

updateDocument()

public PadesProxyTrait::updateDocument (

\setasign\SetaPDF2\Core\Document $document

): void

Updates the document instance.

Parameters

$document : \setasign\SetaPDF2\Core\Document

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See

ETSI TS 102 778-3 V1.2.1 - 4.7 Extensions Dictionary
ETSI EN 319 142-1 V1.1.0 - 5.6 Extension dictionary

updateSignatureDictionary()

public PadesProxyTrait::updateSignatureDictionary (

\setasign\SetaPDF2\Core\Type\PdfDictionary $dictionary

): void

Updates the signature dictionary.

PAdES requires special Filter and SubFilter entries in the signature dictionary.

Parameters

$dictionary : \setasign\SetaPDF2\Core\Type\PdfDictionary

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception