Class SetaPDF_Signer_Ocsp_Response in SetaPDF v2 API Reference

Index

\SetaPDF
1. Signer
2. Signer
  1. Ocsp

SetaPDF_Signer_Ocsp_Response Class representing an OCSPResponse structure.

File: /SetaPDF v2/Signer/Ocsp/Response.php

OCSPResponse ::= SEQUENCE { responseStatus OCSPResponseStatus, responseBytes [0] EXPLICIT ResponseBytes OPTIONAL }

OCSPResponseStatus ::= ENUMERATED { successful (0), --Response has valid confirmations malformedRequest (1), --Illegal confirmation request internalError (2), --Internal error in issuer tryLater (3), --Try again later --(4) is not used sigRequired (5), --Must sign the request unauthorized (6) --Request unauthorized }

Class hierarchy

SetaPDF_Signer_Asn1_Signed
- SetaPDF_Signer_Ocsp_Response

Summary

Constants

STATUS_INTERNAL_ERROR

public const int SetaPDF_Signer_Ocsp_Response::STATUS_INTERNAL_ERROR = 2

Status constant.

STATUS_MALFORMED_REQUEST

public const int SetaPDF_Signer_Ocsp_Response::STATUS_MALFORMED_REQUEST = 1

Status constant.

STATUS_SIG_REQUIRED

public const int SetaPDF_Signer_Ocsp_Response::STATUS_SIG_REQUIRED = 5

Status constant.

STATUS_SUCCESSFUL

public const int SetaPDF_Signer_Ocsp_Response::STATUS_SUCCESSFUL = 0

Status constant.

STATUS_TRY_LATER

public const int SetaPDF_Signer_Ocsp_Response::STATUS_TRY_LATER = 3

Status constant.

STATUS_UNAUTHORIZED

public const int SetaPDF_Signer_Ocsp_Response::STATUS_UNAUTHORIZED = 6

Status constant.

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

$_basicResponse

protected null|SetaPDF_Signer_Asn1_Element SetaPDF_Signer_Ocsp_Response::$_basicResponse

The basic response element if available.

$_response

protected SetaPDF_Signer_Asn1_Element SetaPDF_Signer_Ocsp_Response::$_response

The response message.

$_singleResponses

protected SetaPDF_Signer_Ocsp_SingleResponse[] SetaPDF_Signer_Ocsp_Response::$_singleResponses

An array of the single responses.

Methods

__construct()

public SetaPDF_Signer_Ocsp_Response::__construct (

string $response

)

The constructor.

Parameters

$response : string

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws InvalidArgumentException

_getBasicResponse()

protected SetaPDF_Signer_Ocsp_Response::_getBasicResponse (

void

): bool|SetaPDF_Signer_Asn1_Element

Get the basic response element.

Exceptions

Throws SetaPDF_Signer_Asn1_Exception,SetaPDF_Signer_Exception

_getExtension()

protected SetaPDF_Signer_Ocsp_Response::_getExtension (

string $extensionOid

): bool|SetaPDF_Signer_Asn1_Element

Get an extension from the response by its OID.

Parameters

$extensionOid : string

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

_getResponseData()

protected SetaPDF_Signer_Ocsp_Response::_getResponseData (

void

): bool|SetaPDF_Signer_Asn1_Element

Get the responseData.

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

get()

public SetaPDF_Signer_Ocsp_Response::get (

void

): string

Get the response as an ASN.1 string.

getAsn1()

public SetaPDF_Signer_Ocsp_Response::getAsn1 (

void

): SetaPDF_Signer_Asn1_Element

Get the ASN.1 instance of the OCSP response.

getCertificates()

public SetaPDF_Signer_Ocsp_Response::getCertificates (

void

): SetaPDF_Signer_X509_Collection

Get all certificates embedded in the response.

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getNonce()

public SetaPDF_Signer_Ocsp_Response::getNonce (

void

): bool|string

Get the nonce value from the response.

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getProducedAt()

public SetaPDF_Signer_Ocsp_Response::getProducedAt (

void

): DateTime|null

Get the producedAt information.

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getResponderId()

public SetaPDF_Signer_Ocsp_Response::getResponderId (

void

): string|null

Get the responder id from the responder data.

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getSignatureAlgorithm()

public SetaPDF_Signer_Ocsp_Response::getSignatureAlgorithm (

void

): array|null

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getSignatureValue()

public SetaPDF_Signer_Ocsp_Response::getSignatureValue (

[ bool $hex = true ]

): string|null

Parameters

$hex : bool

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getSignedData()

public SetaPDF_Signer_Ocsp_Response::getSignedData (

void

): bool|string

Exceptions

Throws SetaPDF_Signer_Exception

getSingleResponses()

public SetaPDF_Signer_Ocsp_Response::getSingleResponses (

void

): SetaPDF_Signer_Ocsp_SingleResponse[]

Get the single responses from the response.

Exceptions

Throws SetaPDF_Signer_Asn1_Exception

Throws SetaPDF_Signer_Exception

getStatus()

public SetaPDF_Signer_Ocsp_Response::getStatus (

void

): int

Get the status of the response.

Return Values

See self::STATUS_* constants.

Exceptions

Throws SetaPDF_Signer_Exception

isGood()

public SetaPDF_Signer_Ocsp_Response::isGood (

void

): bool

Checks if this response object is "good".

Evaluates to true if the status of the whole response is self::STATUS_SUCCESSFUL and the certificate status of all single responses are SingleResponse::CERT_STATUS_GOOD.