Class SetaPDF_Signer_Cms_SignedData in SetaPDF v2 API Reference

Index

\SetaPDF
1. Signer
2. Signer
  1. Cms
    1. CertsOnly
    2. SignedData

SetaPDF_Signer_Cms_SignedData Class representing a CMS signed data container.

File: /SetaPDF v2/Signer/Cms/SignedData.php

Class hierarchy

SetaPDF_Signer_Asn1_Signed
- SetaPDF_Signer_Cms_SignedData
  - SetaPDF_Signer_Tsp_Token

Summary

Static Properties

$usePhpseclibForRsaPss

static public bool SetaPDF_Signer_Asn1_Signed::$usePhpseclibForRsaPss = true

Flag defining whether usage of phpseclib or default OpenSSL methods for RSA_PSS validation.

$verifyCallback

static public null|callable SetaPDF_Signer_Asn1_Signed::$verifyCallback

A callable that can be used to implement individual verification logic.

Properties

$_detachedSignedData

protected string|SetaPDF_Core_Reader_FilePath SetaPDF_Signer_Cms_SignedData::$_detachedSignedData

The detached signed data.

$_message

protected SetaPDF_Signer_Asn1_Element SetaPDF_Signer_Cms_SignedData::$_message

The message object.

$_signedAttributes

protected SetaPDF_Signer_Asn1_Element[] SetaPDF_Signer_Cms_SignedData::$_signedAttributes

All signed attributes. Indexed by their OID.

$_unsignedAttributes

protected SetaPDF_Signer_Asn1_Element[] SetaPDF_Signer_Cms_SignedData::$_unsignedAttributes

All unsigned attributes. Indexed by their OID.

Methods

__construct()

public SetaPDF_Signer_Cms_SignedData::__construct (

string $message

)

The constructor.

Parameters

$message : string: PEM or DER encoded message.

_getSignedData()

protected SetaPDF_Signer_Cms_SignedData::_getSignedData (

void

): bool|SetaPDF_Signer_Asn1_Element

Get SignedData element from the ASN.1 structure.

_getSignerInfo()

protected SetaPDF_Signer_Cms_SignedData::_getSignerInfo (

void

): bool|SetaPDF_Signer_Asn1_Element

Get the SignerInfo element from the ASN.1 structure.

Exceptions

Throws SetaPDF_Signer_Exception

getAsn1()

public SetaPDF_Signer_Cms_SignedData::getAsn1 (

void

): SetaPDF_Signer_Asn1_Element

Get the ASN.1 instance of the SignedData element.

getCertificates()

public SetaPDF_Signer_Cms_SignedData::getCertificates (

void

): SetaPDF_Signer_X509_Collection

Get all certificates embedded in the SignedData structure.

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

getDigestAlgorithm()

public SetaPDF_Signer_Cms_SignedData::getDigestAlgorithm (

void

): void

Exceptions

Throws SetaPDF_Signer_Exception

getDigestAlgorithms()

public SetaPDF_Signer_Cms_SignedData::getDigestAlgorithms (

void

): array

Get the digest algorithms and parameters.

Return Values

An array of arrays where the first value holds the OID of the algorithm. The second value is the ASN.1 structure of the parameters.

Exceptions

Throws SetaPDF_Signer_Exception

getIssuerAndSerialNumber()

public SetaPDF_Signer_Cms_SignedData::getIssuerAndSerialNumber (

void

): array|bool

Get issuer and serial number of the signee.

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getSignatureAlgorithm()

public SetaPDF_Signer_Cms_SignedData::getSignatureAlgorithm (

void

): array

Return Values

The first value holds the OID of the algorithm. The second value is the ASN.1 structure of the parameters.

Exceptions

Throws SetaPDF_Signer_Exception

getSignatureValue()

public SetaPDF_Signer_Cms_SignedData::getSignatureValue (

[ bool $hex = true ]

): string

Parameters

$hex : bool

Exceptions

Throws SetaPDF_Signer_Exception

getSignedAttribute()

public SetaPDF_Signer_Cms_SignedData::getSignedAttribute (

string $oid

): bool|mixed|SetaPDF_Signer_Asn1_Element

Get a signed attribute by its OID.

Parameters

$oid : string

Exceptions

Throws SetaPDF_Signer_Exception

getSignedAttributes()

public SetaPDF_Signer_Cms_SignedData::getSignedAttributes (

void

): array|SetaPDF_Signer_Asn1_Element[]

Get all signed attributes.

Exceptions

Throws SetaPDF_Signer_Exception

getSignedData()

public SetaPDF_Signer_Cms_SignedData::getSignedData (

void

): SetaPDF_Core_Reader_FilePath|string

Exceptions

Throws SetaPDF_Signer_Exception

getSigningCertificate()

public SetaPDF_Signer_Cms_SignedData::getSigningCertificate (

[ SetaPDF_Signer_X509_Collection $extraCertificates = null ]

): bool|false|SetaPDF_Signer_X509_Certificate|SetaPDF_Signer_X509_CollectionInterface

Get the signing certificate.

Parameters

$extraCertificates : SetaPDF_Signer_X509_Collection

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getSubjectKeyIdentifier()

public SetaPDF_Signer_Cms_SignedData::getSubjectKeyIdentifier (

void

): bool|string

Get the subject key identifier.

Exceptions

Throws SetaPDF_Signer_Exception

getUnsignedAttribute()

public SetaPDF_Signer_Cms_SignedData::getUnsignedAttribute (

string $oid

): bool|mixed|SetaPDF_Signer_Asn1_Element

Get an unsigned attribute by its OID.

Parameters

$oid : string

Exceptions

Throws SetaPDF_Signer_Exception

getUnsignedAttributes()

public SetaPDF_Signer_Cms_SignedData::getUnsignedAttributes (

void

): array|SetaPDF_Signer_Asn1_Element[]

Get all unsigned attributes.

Exceptions

Throws SetaPDF_Signer_Exception

setDetachedSignedData()

public SetaPDF_Signer_Cms_SignedData::setDetachedSignedData (

string|SetaPDF_Core_Reader_FilePath $detachedSignedData

): void

Set the detached signed data.

Parameters

$detachedSignedData : string|SetaPDF_Core_Reader_FilePath

verify()

public SetaPDF_Signer_Cms_SignedData::verify (

SetaPDF_Signer_X509_Certificate $signerCertificate

): bool

Parameters

$signerCertificate : SetaPDF_Signer_X509_Certificate

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception