Index

  1. \SetaPDF
    1. Signer
    2. Signer
      1. X509
        1. Extension
        2. Certificate
        3. Chain
        4. Collection
        5. CollectionInterface
        6. Crl
        7. Extensions
        8. Format

SetaPDF_Signer_X509_Certificate Class representing a X509 Certificate.

File: /SetaPDF v2/Signer/X509/Certificate.php

Class hierarchy

Summary

Static Methods

Static Properties

Methods

Properties

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

$_certificate

protected SetaPDF_Signer_Asn1_Element SetaPDF_Signer_X509_Certificate::$_certificate

The ASN.1 element holding the X509 certificate.

$_digestCache

protected array SetaPDF_Signer_X509_Certificate::$_digestCache = array()

A digest cache.

$_extensions

protected SetaPDF_Signer_X509_Extensions SetaPDF_Signer_X509_Certificate::$_extensions

The extensions instance.

$_issuerName

protected array SetaPDF_Signer_X509_Certificate::$_issuerName = array()

A cache for the issuer name.

$_subjectName

protected array SetaPDF_Signer_X509_Certificate::$_subjectName = array()

A cache for the subject name.


Static Methods

fromFile()

public static SetaPDF_Signer_X509_Certificate::fromFile (
string $path
): SetaPDF_Signer_X509_Certificate

Create an instance by a path.

Parameters
$path : string
 
Exceptions

Throws SetaPDF_Signer_Asn1_Exception

fromFileOrString()

public static SetaPDF_Signer_X509_Certificate::fromFileOrString (
string $pathOrString
): SetaPDF_Signer_X509_Certificate

Create an instance by a path or a string.

Parameters
$pathOrString : string
 
Exceptions

Throws SetaPDF_Signer_Asn1_Exception


Methods

__construct()

public SetaPDF_Signer_X509_Certificate::__construct (
string $certificate
)

The constructor.

Parameters
$certificate : string

PEM or DER encoded string of the certificate.

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

_getTBSCertificate()

protected SetaPDF_Signer_X509_Certificate::_getTBSCertificate (
void
): SetaPDF_Signer_Asn1_Element

Get the TBSCertificate value.

_getValidity()

protected SetaPDF_Signer_X509_Certificate::_getValidity (
void
): bool|SetaPDF_Signer_Asn1_Element

Get the validity field.

Exceptions

Throws SetaPDF_Signer_Exception

get()

public SetaPDF_Signer_X509_Certificate::get (
[ string $format = SetaPDF_Signer_X509_Format::PEM ]
): string

Get the certificate encoded as DER or PEM.

Parameters
$format : string
 

getAsn1()

public SetaPDF_Signer_X509_Certificate::getAsn1 (
void
): SetaPDF_Signer_Asn1_Element

Get the ASN.1 instance of the certificate.

getDigest()

public SetaPDF_Signer_X509_Certificate::getDigest (
[ string $algo = 'sha1' [, bool $raw = false ]]
): string

Get the digest of the certificate.

Parameters
$algo : string
 
$raw : bool
 

getExtensions()

public SetaPDF_Signer_X509_Certificate::getExtensions (
void
): SetaPDF_Signer_X509_Extensions

Get the extensions object.

getIssuer()

public SetaPDF_Signer_X509_Certificate::getIssuer (): null|SetaPDF_Signer_X509_Certificate

Returns the first issuer found in the given Collection.

Parameters
$collection : SetaPDF_Signer_X509_Collection
 
Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getIssuerName()

public SetaPDF_Signer_X509_Certificate::getIssuerName (
[ bool $asArray = false [, bool $onlyKnown = true ]]
): string|array

Get the issuer name.

Parameters
$asArray : bool

Whether the subject is returned as an array or string

$onlyKnown : bool

Whether attributes with an unknown OID are returend or not.

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getIssuerNameRaw()

public SetaPDF_Signer_X509_Certificate::getIssuerNameRaw (
void
): SetaPDF_Signer_Asn1_Element

Get the IssuerName field.

Exceptions

Throws SetaPDF_Signer_Exception

getIssuers()

public SetaPDF_Signer_X509_Certificate::getIssuers (): SetaPDF_Signer_X509_Collection

Get all found issuers found in the given collection.

Parameters
$collection : SetaPDF_Signer_X509_Collection
 
Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getSerialNumber()

public SetaPDF_Signer_X509_Certificate::getSerialNumber (
void
): string

Get the serial number (hex encoded).

Exceptions

Throws SetaPDF_Signer_Exception

getSerialNumberRaw()

public SetaPDF_Signer_X509_Certificate::getSerialNumberRaw (
void
): bool|SetaPDF_Signer_Asn1_Element

Get the serial number as a raw ASN.1 element.

Exceptions

Throws SetaPDF_Signer_Exception

getSignatureAlgorithm()

public SetaPDF_Signer_X509_Certificate::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.

getSignatureValue()

public SetaPDF_Signer_X509_Certificate::getSignatureValue (
[ bool $hex = true ]
): string
Parameters
$hex : bool
 

getSignedData()

public SetaPDF_Signer_X509_Certificate::getSignedData (
void
): SetaPDF_Core_Reader_FilePath|string

getSubjectName()

public SetaPDF_Signer_X509_Certificate::getSubjectName (
[ bool $asArray = false [, bool $onlyKnown = true ]]
): string|array

Get the subject name.

Parameters
$asArray : bool

Whether the subject is returned as an array or string

$onlyKnown : bool

Whether attributes with an unknown OID are returend or not.

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

getSubjectPublicKeyInfoAlgorithmIdentifier()

public SetaPDF_Signer_X509_Certificate::getSubjectPublicKeyInfoAlgorithmIdentifier (
void
): array

Get the subject public key info algorithm identifier.

Return Values

First entry is the OID of the identifier. The second entry are the raw parameters as ASN.1 structures.

Exceptions

Throws SetaPDF_Signer_Exception

getSubjectPublicKeyInfoRaw()

public SetaPDF_Signer_X509_Certificate::getSubjectPublicKeyInfoRaw (
void
): string

Get the data of the Subject Public Key Info field.

Exceptions

Throws SetaPDF_Signer_Exception

getValidFrom()

public SetaPDF_Signer_X509_Certificate::getValidFrom (
[ DateTimeZone|null $timeZone = null ]
): DateTime

Get the "valid from" value.

Parameters
$timeZone : DateTimeZone|null

Default timezone is UTC.

Exceptions

Throws Exception

getValidTo()

public SetaPDF_Signer_X509_Certificate::getValidTo (
[ DateTimeZone|null $timeZone = null ]
): DateTime

Get the "valid to" value.

Parameters
$timeZone : DateTimeZone|null

Default timezone is UTC.

Exceptions

Throws Exception

isValidAt()

public SetaPDF_Signer_X509_Certificate::isValidAt (
DateTimeInterface $dateTime [, DateTimeZone|null $timeZone = null ]
): bool

Checks whether the certificate was valid at a given date and time.

Parameters
$dateTime : DateTimeInterface
 
$timeZone : DateTimeZone|null
 
Exceptions

Throws Exception

verify()

public SetaPDF_Signer_X509_Certificate::verify (
[ SetaPDF_Signer_X509_Certificate|null $issuerCertifcate = null ]
): bool

Verify the signed object.

Parameters
$issuerCertifcate : SetaPDF_Signer_X509_Certificate|null

If omitted the certificate instance is used as the issuer (self-signed).

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception


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