Class IntegrityResult in namespace setasign\SetaPDF2\Signer\ValidationRelatedInfo in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Signer
  1. ValidationRelatedInfo

setasign\SetaPDF2\Signer\ValidationRelatedInfo

IntegrityResult Class representing an integrity result of a signature by its field name.

File: /SetaPDF v2/Signer/ValidationRelatedInfo/IntegrityResult.php
Old class name (alias): \SetaPDF_Signer_ValidationRelatedInfo_IntegrityResult

Class hierarchy

IntegrityResult

Summary

Constants

STATUS_CADES_INVALID_SIGNING_CERTIFICATE

public const int IntegrityResult::STATUS_CADES_INVALID_SIGNING_CERTIFICATE = -7

Status if the signed attribut SigningCertificateV2 doesn't matched the signing certificate.

STATUS_CADES_SIGNING_CERTIFICATE_V2_MISSING

public const int IntegrityResult::STATUS_CADES_SIGNING_CERTIFICATE_V2_MISSING = -6

Status if the signature is a PAdES one but the required signed attribute (SigningCertificateV2) is missing.

STATUS_DIFFERENT_SIGNED_DATA_VALUE

public const int IntegrityResult::STATUS_DIFFERENT_SIGNED_DATA_VALUE = -2

Status if the signature data of the field is different to the one resolved by the byte range.

STATUS_INVALID_CONTENTS_DATA

public const IntegrityResult::STATUS_INVALID_CONTENTS_DATA = -9

Status if the Contents entry has invalid data.

STATUS_INVALID_DATA_IN_BYTE_RANGE

public const int IntegrityResult::STATUS_INVALID_DATA_IN_BYTE_RANGE = -1

Status if the signature data resolved by the byte range has more data then a single signature value.

STATUS_INVALID_SIGNATURE

public const int IntegrityResult::STATUS_INVALID_SIGNATURE = -3

Status if a signature could not be validated.

STATUS_INVALID_TIMESTAMP_MESSAGE_IMPRINT

public const int IntegrityResult::STATUS_INVALID_TIMESTAMP_MESSAGE_IMPRINT = -5

Status if the message imprint of the timestamp signature doesn't match the data of the document.

STATUS_INVALID_TIMESTAMP_SIGNATURE

public const int IntegrityResult::STATUS_INVALID_TIMESTAMP_SIGNATURE = -4

Status if a timestamp signature could not be validated.

STATUS_MISSING_ENCAPSULATED_CONTENT

public const int IntegrityResult::STATUS_MISSING_ENCAPSULATED_CONTENT = -8

Status if the eContent element is missing but required.

STATUS_NOT_SIGNED

public const int IntegrityResult::STATUS_NOT_SIGNED = 0

Status for a field that is not signed.

STATUS_VALID

public const int IntegrityResult::STATUS_VALID = 1

Status for a valid signature.

Properties

$_field

protected \SetaPDF_Signer_SignatureField IntegrityResult::$_field

The signature field.

$_isSignedRevision

protected bool IntegrityResult::$_isSignedRevision

Wether the signature covers the whole document or only a revision.

$_signedData

protected \SetaPDF_Signer_Cms_SignedData|\SetaPDF_Signer_Tsp_Token IntegrityResult::$_signedData

The signed data object.

$_status

protected int IntegrityResult::$_status

The status.

Static Methods

create()

public static IntegrityResult::create (

\SetaPDF_Core_Document $document,
string $fieldName

): \SetaPDF_Signer_ValidationRelatedInfo_IntegrityResult

Create an integrity result instance.

Parameters

$document : \SetaPDF_Core_Document
$fieldName : string: The signature field name in UTF-8 encoding

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Signer\Asn1\Exception

Throws \setasign\SetaPDF2\Signer\Exception

Methods

getField()

public IntegrityResult::getField (

void

): \SetaPDF_Signer_SignatureField

Get the signature field instance.

getSignedData()

public IntegrityResult::getSignedData (

void

): \SetaPDF_Signer_Cms_SignedData|\SetaPDF_Signer_Tsp_Token

Get access to the signed data object of the signature field.

getStatus()

public IntegrityResult::getStatus (

void

): int

Get the status of the integrity of the signature field.

isSignedRevision()

public IntegrityResult::isSignedRevision (

void

): bool

Checks whether the signature covers the whole document or only a revision.

isValid()

public IntegrityResult::isValid (

void

): bool

Checks whether the integrity of the signature of the given field is valid.