Index

  1. \SetaPDF
    1. Signer
    2. Signer
      1. Asn1
      2. Cms
      3. Exception
      4. Exception
      5. InformationResolver
      6. Ocsp
      7. Signature
      8. Timestamp
      9. Tsp
      10. ValidationRelatedInfo
      11. X509
      12. CertificateBundler
      13. Digest
      14. DigestInterface
      15. DocumentSecurityStore
      16. Pem
      17. SignatureField
      18. TmpDocument

SetaPDF_Signer The main class of the SetaPDF-Signer Component

File: /SetaPDF v2/Signer.php

Class hierarchy

Summary

Static Methods

Methods

Properties

Constants

Constants

CERTIFICATION_LEVEL_FORM_FILLING

public const integer SetaPDF_Signer::CERTIFICATION_LEVEL_FORM_FILLING = 2

Certification level constant

CERTIFICATION_LEVEL_FORM_FILLING_AND_ANNOTATIONS

public const integer SetaPDF_Signer::CERTIFICATION_LEVEL_FORM_FILLING_AND_ANNOTATIONS = 3

Certification level constant

CERTIFICATION_LEVEL_NONE

public const integer SetaPDF_Signer::CERTIFICATION_LEVEL_NONE = 0

Certification level constant

CERTIFICATION_LEVEL_NO_CHANGES_ALLOWED

public const integer SetaPDF_Signer::CERTIFICATION_LEVEL_NO_CHANGES_ALLOWED = 1

Certification level constant

PROP_CONTACT_INFO

public const string SetaPDF_Signer::PROP_CONTACT_INFO = 'ContactInfo'

Property constant

PROP_LOCATION

public const string SetaPDF_Signer::PROP_LOCATION = 'Location'

Property constant

PROP_NAME

public const string SetaPDF_Signer::PROP_NAME = 'Name'

Property constant

PROP_REASON

public const string SetaPDF_Signer::PROP_REASON = 'Reason'

Property constant

PROP_TIME_OF_SIGNING

public const string SetaPDF_Signer::PROP_TIME_OF_SIGNING = 'M'

Property constant

VERSION

public const string SetaPDF_Signer::VERSION = '2.46.0.2006'

Version


Properties

$_allowSignatureContentLengthChange

protected bool SetaPDF_Signer::$_allowSignatureContentLengthChange = true

Defines if the signatureContentLength property can be changed automatically, if a signature value doesn't fit into the reserved space.

$_appearance

protected SetaPDF_Signer_Signature_Appearance_AbstractAppearance SetaPDF_Signer::$_appearance

An appearance instance

$_byteRange

protected SetaPDF_Core_Type_Array SetaPDF_Signer::$_byteRange

The byte range value

$_certificationLevel

protected int SetaPDF_Signer::$_certificationLevel = 0

The certification level

$_document

protected SetaPDF_Core_Document SetaPDF_Signer::$_document

Document which shall be signed

$_fieldName

protected string SetaPDF_Signer::$_fieldName = 'Signature'

The signature field name

$_offsetEndPlaceholder

protected string SetaPDF_Signer::$_offsetEndPlaceholder = '(<---OFFSET--->)'

A placeholder for the second length value in the ByteRange array

$_placeHolderByteOffset

protected int SetaPDF_Signer::$_placeHolderByteOffset

The byte offset position of the place holder/reserved space

$_secHandlerCallback

protected null|callback SetaPDF_Signer::$_secHandlerCallback

The callback for authenticating at the security handler of the document

$_signatureContentLength

protected int SetaPDF_Signer::$_signatureContentLength = 15000

The byte length of the reserved space for the signature content

$_signatureProperties

protected array SetaPDF_Signer::$_signatureProperties = array(...)

The signature properties

$_tempDocument

protected SetaPDF_Core_Document SetaPDF_Signer::$_tempDocument

A temporary instance of the signed document

$_tempWriter

protected SetaPDF_Core_Writer_WriterInterface SetaPDF_Signer::$_tempWriter

The temporary writer instance

$_timestampModule

protected SetaPDF_Signer_Timestamp_Module_ModuleInterface SetaPDF_Signer::$_timestampModule

A timestamp module interface


Static Methods

getCertificationLevelByDocument()

public static SetaPDF_Signer::getCertificationLevelByDocument (): null|integer

Check a PDF document for a certification signature and its level

Parameters
$document : SetaPDF_Core_Document
 
Return Values

The certification level or null if the document has no certification signature.

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception

getSignatureFieldNames()

public static SetaPDF_Signer::getSignatureFieldNames (): 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


Methods

__construct()

public SetaPDF_Signer::__construct (
SetaPDF_Core_Document $document [, callback|null $secHandlerCallback = null ]
)

The constructor.

If the passed document is protected by a security handler it is possible to pass a callback as second parameter that will be called if an authentication is needed.

Parameters
$document : SetaPDF_Core_Document

The document instance

$secHandlerCallback : callback|null

A callback which should auth on a security handler (if needed). The callback will be called with two parameters: The first parameter will be the security handler and the second parameter is the current document instance. It should return true or false whether the authentication was successful or not.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

_addDocMp()

protected SetaPDF_Signer::_addDocMp (): void

Adds the document modification detection and prevention data.

Parameters
$dictionary : SetaPDF_Core_Type_Dictionary
 

_callSecHandlerCallback()

protected SetaPDF_Signer::_callSecHandlerCallback (): void

Calls a defined callback that should authenticate on the documents security handler.

Parameters
$document : SetaPDF_Core_Document

The document instance

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

_checkCertificationLevel()

protected SetaPDF_Signer::_checkCertificationLevel (
void
): void

Verifies if the defined certification level can be applied.

Certification signatures can only be applied if the document has no other existing signature.

Exceptions

Throws SetaPDF_Signer_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception

_createSignatureDictionary()

protected SetaPDF_Signer::_createSignatureDictionary (): SetaPDF_Core_Type_IndirectObject

Creates the signature dictionary.

Parameters
$field : SetaPDF_Signer_SignatureField

The signature field

$module : null|SetaPDF_Signer_Signature_DictionaryInterface
 

_createTimestampSignatureDictionary()

protected SetaPDF_Signer::_createTimestampSignatureDictionary (): void

Creates the signature dictionary.

Parameters
$field : SetaPDF_Signer_SignatureField

The signature field

$module : null|SetaPDF_Signer_Signature_DictionaryInterface
 

_ensureSignatureField()

protected SetaPDF_Signer::_ensureSignatureField (
SetaPDF_Core_Document $document [, bool $returnFieldInstance = false ]
): null|SetaPDF_Signer_SignatureField

Ensures a valid signature field instance.

Parameters
$document : SetaPDF_Core_Document

The document instance

$returnFieldInstance : bool

If true the field instance will be returned, otherwise null will be returned.

Exceptions

Throws SetaPDF_Signer_Exception

_prepareTmpDocument()

protected SetaPDF_Signer::_prepareTmpDocument (
string $type, SetaPDF_Signer_TmpDocument $tmpDocument, string $path [, null|SetaPDF_Signer_Signature_DictionaryInterface $module = null ]
): SetaPDF_Signer_TmpDocument

Prepares the temporary document instance.

Parameters
$type : string
 
$tmpDocument : SetaPDF_Signer_TmpDocument
 
$path : string
 
$module : null|SetaPDF_Signer_Signature_DictionaryInterface
 
Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Signer_Exception

_updateAcroForm()

protected SetaPDF_Signer::_updateAcroForm (): void

Updates the AcroForm dictionary.

Parameters
$document : SetaPDF_Core_Document

The document instance

addSignatureField()

public SetaPDF_Signer::addSignatureField (
[ string $fieldName = SetaPDF_Signer_SignatureField::DEFAULT_FIELD_NAME [, int $pageNumber = 1 [, int|string $xOrPosition = 0 [, int|array $yOrTranslate = 0 [, int $width = 0 [, int $height = 0 ]]]]]]
): SetaPDF_Signer_SignatureField

Proxy method for SetaPDF_Signer_SignatureField::add().

Parameters
$fieldName : string

The field name in UTF-8 encoding

$pageNumber : int

The page number on which the signature field shall appear.

$xOrPosition : int|string

Integer with the x-position or SetaPDF_Signer_SignatureField::POSITION_XXX

$yOrTranslate : int|array

Integer with the y-position (if $xOrPosition is an integer) or an array with the keys 'x' and 'y'

$width : int

Width of the signature field

$height : int

Height of the signature field

Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

See

addTimeStamp()

public SetaPDF_Signer::addTimeStamp (
string $signature, SetaPDF_Signer_TmpDocument $tmpDocument
): string

Forwards the signature to a timestamp module and merges the result into the signature container.

Parameters
$signature : string
 
$tmpDocument : SetaPDF_Signer_TmpDocument
 
Exceptions

Throws SetaPDF_Signer_Exception

cleanUp()

public SetaPDF_Signer::cleanUp (
void
): void

Release memory and cycled references.

createSignature()

public SetaPDF_Signer::createSignature (): string

Creates a signature based on a temporary document instance and a signature module.

Parameters
$tmpDocument : SetaPDF_Signer_TmpDocument
 
$module : SetaPDF_Signer_Signature_Module_ModuleInterface
 
Exceptions

Throws SetaPDF_Signer_Exception

See

createTimestampSignature()

public SetaPDF_Signer::createTimestampSignature (): string

Creates a timestamp signature based on a temporary document instance.

The timestamp module has to be added to the signer instance through the setTimestampModule() method.

Parameters
$tmpDocument : SetaPDF_Signer_TmpDocument
 
Exceptions

Throws SetaPDF_Signer_Exception

See

getAllowSignatureContentLengthChange()

public SetaPDF_Signer::getAllowSignatureContentLengthChange (
void
): bool

Get the flag specifying whether the signature content length (reserved space) could be changed automatically ot not.

getAppearance()

public SetaPDF_Signer::getAppearance (
void
): SetaPDF_Signer_Signature_Appearance_AbstractAppearance

Get the current appearance module.

getCertificationLevel()

public SetaPDF_Signer::getCertificationLevel (
void
): int

Get the certification level.

Possible values are defined in the SetaPDF_Signer::CERTIFICATION_LEVEL_* constants.

See

getContactInfo()

public SetaPDF_Signer::getContactInfo (
void
): bool|string

Get the information provided by the signer to enable a recipient to contact the signer to verify the signature.

Return Values

If no contact info exist FALSE will be returned. Otherwise, the value will be returned.

See

getLocation()

public SetaPDF_Signer::getLocation (
void
): bool|string

Get the CPU host name or physical location of the signing.

Return Values

If no location exist FALSE will be returned. Otherwise the value will be returned.

See

getName()

public SetaPDF_Signer::getName (
void
): bool|string

Get the name of the person or authority signing the document.

Return Values

If no name exist FALSE will be returned. Otherwise the value will be returned.

See

getReason()

public SetaPDF_Signer::getReason (
void
): bool|string

Get the reason for the signing.

Return Values

If no name exist FALSE will be returned. Otherwise the value will be returned.

See

getSignatureContentLength()

public SetaPDF_Signer::getSignatureContentLength (
void
): integer

Get the signature content length that will be used to reserve space for the final signature.

getSignatureField()

public SetaPDF_Signer::getSignatureField (
[ string $fieldName = SetaPDF_Signer_SignatureField::DEFAULT_FIELD_NAME [, bool $create = true ]]
): bool|SetaPDF_Signer_SignatureField

Proxy method to SetaPDF_Signer_SignatureField::get().

Parameters
$fieldName : string

The field name in UTF-8 encoding

$create : bool

Automatically creates a hidden field if none was found by the specified name

Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Signer_Exception

See

getSignatureProperty()

public SetaPDF_Signer::getSignatureProperty (
string $name
): bool|string

Get a signature property.

Parameters
$name : string

See and use SetaPDF_Signer::PROP_* constants for valid names

Return Values

If the name is not valid FALSE will be returned. Otherwise the value will be returned.

getTimeOfSigning()

public SetaPDF_Signer::getTimeOfSigning (
void
): SetaPDF_Core_DataStructure_Date

Get the time of signing.

Exceptions

Throws Exception

See

getTimestampModule()

public SetaPDF_Signer::getTimestampModule (
void
): SetaPDF_Signer_Timestamp_Module_ModuleInterface

Get the current timestamp module.

preSign()

public SetaPDF_Signer::preSign (): SetaPDF_Signer_TmpDocument

Prepares a temporary document instance to be used further in an asynchronous signature workflow.

Parameters
$writer : SetaPDF_Core_Writer_FileInterface
 
$module : null|SetaPDF_Signer_Signature_DictionaryInterface
 
$saveMethod : integer

The $method parameter passed to the main save() call of the document instance. See SetaPDF_Core_Document::save() method.

Exceptions

Throws SetaPDF_Signer_Exception

Throws SetaPDF_Core_Exception

See

preTimestamp()

public SetaPDF_Signer::preTimestamp (): SetaPDF_Signer_TmpDocument

Prepares a temporary document instance to be used further in an asynchronous timestamp workflow.

Parameters
$writer : SetaPDF_Core_Writer_FileInterface
 
$module : null|SetaPDF_Signer_Signature_DictionaryInterface
 
$saveMethod : integer

The $method parameter passed to the main save() call of the document instance. See SetaPDF_Core_Document::save() method.*

Exceptions

Throws SetaPDF_Signer_Exception

Throws SetaPDF_Core_Exception

See

saveSignature()

public SetaPDF_Signer::saveSignature (
SetaPDF_Signer_TmpDocument $tmpDocument, string $signature
): void

Add a signature result to the temporary document instance and saves it to the main documents writer instance.

Parameters
$tmpDocument : SetaPDF_Signer_TmpDocument
 
$signature : string

The PKCS7 byte string to be added to the temporary document.

Exceptions

Throws SetaPDF_Signer_Exception

Throws SetaPDF_Signer_Exception_ContentLength

setAllowSignatureContentLengthChange()

public SetaPDF_Signer::setAllowSignatureContentLengthChange (
bool $allowSignatureContentLengthChange
): void

Set a flag specifying whether the signature content length (reserved space) could be changed automatically or not.

If this value is set to true and the resulting signature is bigger than the reserved space (defined by SetaPDF_Signer::setSignatureContentLength() the signature content length will be increased and the signature process will restart.

Parameters
$allowSignatureContentLengthChange : bool

The flag status

setAppearance()

public SetaPDF_Signer::setAppearance (): void

Set an appearance instance.

Parameters
$appearance : SetaPDF_Signer_Signature_Appearance_AbstractAppearance

The appearance instance

setCertificationLevel()

public SetaPDF_Signer::setCertificationLevel (
integer $certificationLevel
): void

Set the certification level.

Parameters
$certificationLevel : integer

Possible values are defined in the SetaPDF_Signer::CERTIFICATION_LEVEL_XXX constants.

See

setContactInfo()

public SetaPDF_Signer::setContactInfo (
string $contactInfo
): void

Set the information provided by the signer to enable a recipient to contact the signer to verify the signature.

Parameters
$contactInfo : string

The contact info in UTF-8 encoding

See

setLocation()

public SetaPDF_Signer::setLocation (
string $location
): void

Set the host name or physical location of the signing.

Parameters
$location : string

The physical location or host name in UTF-8 encoding

See

setName()

public SetaPDF_Signer::setName (
string $name
): void

Set the name of the person or authority signing the document.

Parameters
$name : string

The value in UTF-8 encoding

See

setReason()

public SetaPDF_Signer::setReason (
string $reason
): void

Set the reason for the signing.

Parameters
$reason : string

The reason for the signing in UTF-8 encoding

See

setSignatureContentLength()

public SetaPDF_Signer::setSignatureContentLength (
integer $length
): void

Set the signature content length that will be used to reserve space for the final signature.

Parameters
$length : integer

The length of the signature content.

setSignatureFieldName()

public SetaPDF_Signer::setSignatureFieldName (
string $fieldName
): void

Set the signature field name.

This can be the name of an existing signature field or an individual name which will be used to create a hidden field automatically.

Parameters
$fieldName : string

The field name in UTF-8 encoding

setSignatureProperty()

public SetaPDF_Signer::setSignatureProperty (
string $name, string $value
): void

Set a signature property.

Parameters
$name : string

See and use SetaPDF_Signer::PROP_* constants for valid names

$value : string

The value in UTF-8 encoding

Exceptions

Throws InvalidArgumentException if the name is not valid

setTimeOfSigning()

public SetaPDF_Signer::setTimeOfSigning (): void

Set the time of signing.

Parameters
$timeOfSigning : string|DateTime|SetaPDF_Core_DataStructure_Date

The time of signing in UTF-8 encoding

See

setTimestampModule()

public SetaPDF_Signer::setTimestampModule (): void

Set a timestamp module.

Parameters
$module : SetaPDF_Signer_Timestamp_Module_ModuleInterface

The timestamp module instance

sign()

public SetaPDF_Signer::sign (): void

Digital signs the initial document.

The SetaPDF_Core_Document instance will be temporary saved and finished. It is not possible to work on it further. The final PDF will be passed to the previously attached writer instance, so that the final signed document will be written to the correct writer.

Parameters
$module : SetaPDF_Signer_Signature_Module_ModuleInterface

The module instance

$saveMethod : integer

The $method parameter passed to the main save() call of the document instance. See SetaPDF_Core_Document::save() method.

Exceptions

Throws SetaPDF_Signer_Exception

Throws SetaPDF_Core_Exception

timestamp()

public SetaPDF_Signer::timestamp (
[ integer $saveMethod = SetaPDF_Core_Document::SAVE_METHOD_UPDATE ]
): string

Adds a document level timestamp.

The SetaPDF_Core_Document instance will be temporary saved and finished. It is not possible to work on it further. The final PDF will be passed to the previously attached writer instance, so that the final signed document will be written to the correct writer.

Parameters
$saveMethod : integer

The $method parameter passed to the main save() call of the document instance. See SetaPDF_Core_Document::save() method.

Return Values

The timestamp token/signature

Exceptions

Throws SetaPDF_Signer_Exception

Throws SetaPDF_Signer_Exception_ContentLength

Throws SetaPDF_Core_Exception


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