Index

  1. \setasign\SetaPDF2
    1. Signer
      1. Cms
        1. CertsOnly
        2. SignedData

setasign\SetaPDF2\Signer\Cms

SignedData Class representing a CMS signed data container.

File: /SetaPDF v2/Signer/Cms/SignedData.php
Old class name (alias): \SetaPDF_Signer_Cms_SignedData

Class hierarchy

Summary

Static Properties

Methods

Properties

Static Properties

$usePhpseclibForRsaPss

static public bool \setasign\SetaPDF2\Signer\Asn1\Signed::$usePhpseclibForRsaPss = true

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

$verifyCallback

static public ?callable \setasign\SetaPDF2\Signer\Asn1\Signed::$verifyCallback

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


Properties

$_detachedSignedData

protected string|\SetaPDF_Core_Reader_FilePath SignedData::$_detachedSignedData

The detached signed data.

$_message

protected \SetaPDF_Signer_Asn1_Element SignedData::$_message

The message object.

$_signedAttributes

protected \SetaPDF_Signer_Asn1_Element[] SignedData::$_signedAttributes

All signed attributes. Indexed by their OID.

$_unsignedAttributes

protected \SetaPDF_Signer_Asn1_Element[] SignedData::$_unsignedAttributes

All unsigned attributes. Indexed by their OID.


Methods

__construct()

public SignedData::__construct (
string $message
)

The constructor.

Parameters
$message : string

PEM or DER encoded message.

_getSignedData()

protected SignedData::_getSignedData (
void
): bool|\SetaPDF_Signer_Asn1_Element

Get SignedData element from the ASN.1 structure.

_getSignerInfo()

protected SignedData::_getSignerInfo (
void
): bool|\SetaPDF_Signer_Asn1_Element

Get the SignerInfo element from the ASN.1 structure.

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getAsn1()

public SignedData::getAsn1 (
void
): \SetaPDF_Signer_Asn1_Element

Get the ASN.1 instance of the SignedData element.

getCertificates()

public SignedData::getCertificates (
void
): \SetaPDF_Signer_X509_Collection

Get all certificates embedded in the SignedData structure.

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

getDigestAlgorithm()

public SignedData::getDigestAlgorithm (
void
): void
Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getDigestAlgorithms()

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

getIssuerAndSerialNumber()

public SignedData::getIssuerAndSerialNumber (
void
): array|bool

Get issuer and serial number of the signee.

Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

getSignatureAlgorithm()

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

getSignatureValue()

public SignedData::getSignatureValue (
bool $hex = true
): string
Parameters
$hex : bool
 
Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getSignedAttribute()

public SignedData::getSignedAttribute (
string $oid
): bool|mixed|\SetaPDF_Signer_Asn1_Element

Get a signed attribute by its OID.

Parameters
$oid : string
 
Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getSignedAttributes()

public SignedData::getSignedAttributes (
void
): array|\SetaPDF_Signer_Asn1_Element[]

Get all signed attributes.

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getSignedData()

public SignedData::getSignedData (
void
): \SetaPDF_Core_Reader_FilePath|string|false
Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getSigningCertificate()

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

Throws \setasign\SetaPDF2\Signer\Exception

getSubjectKeyIdentifier()

public SignedData::getSubjectKeyIdentifier (
void
): bool|string

Get the subject key identifier.

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getUnsignedAttribute()

public SignedData::getUnsignedAttribute (
string $oid
): bool|mixed|\SetaPDF_Signer_Asn1_Element

Get an unsigned attribute by its OID.

Parameters
$oid : string
 
Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

getUnsignedAttributes()

public SignedData::getUnsignedAttributes (
void
): array|\SetaPDF_Signer_Asn1_Element[]

Get all unsigned attributes.

Exceptions

Throws \setasign\SetaPDF2\Signer\Exception

setDetachedSignedData()

public SignedData::setDetachedSignedData (
string|\SetaPDF_Core_Reader_FilePath $detachedSignedData
): void

Set the detached signed data.

Parameters
$detachedSignedData : string|\SetaPDF_Core_Reader_FilePath
 

verify()

public SignedData::verify (): bool
Parameters
$signerCertificate : \SetaPDF_Signer_X509_Certificate
 
Exceptions

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception


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