Class: DocumentSecurityStore

Represents a Document Security Store (DSS). Holds information that can be used to verify signatures offline. See PDF specification for details.

Extends

• ObjectBase

Accessors

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ObjectBase.id

---

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ObjectBase.om

Methods

addVerification()

addVerification(signature, prms?): Promise<boolean>;

Add verification information for specified signature.

Parameters

signature

PdfSignature

The PdfSignature object.

prms?

DSSVerificationParams

The DSSVerificationParams object which defines parameters used to build verification information.

Returns

Promise<boolean>

---

addVerificationCert()

addVerificationCert(signature, certificatePem): void;

Adds a certificate response for a specified signature.

Parameters

signature

PdfSignature

The PdfSignature object.

certificatePem

string

PEM-encoded end-entity certificate.

Returns

void

---

addVerificationCRL()

Call Signature

addVerificationCRL(signature, crl): Promise<void>;

Adds a CRL list for a specified signature.

Parameters

signature

PdfSignature

The PdfSignature object.

crl

Uint8Array

The DER-encoded CRL.

Returns

Promise<void>

Call Signature

addVerificationCRL(
   signature, 
   crlUri, 
   externalResourcesOptions?): Promise<void>;

Adds a CRL list for a specified signature.

Parameters

signature

PdfSignature

The PdfSignature object.

crlUri

string

The URI containing CRL.

externalResourcesOptions?

ExternalResourcesOptions

The options used to execute CRL request.

Returns

Promise<void>

---

addVerificationOCSP()

Call Signature

addVerificationOCSP(signature, ocsp): Promise<void>;

Adds an OCSP response for a specified signature.

Parameters

signature

PdfSignature

The PdfSignature object.

ocsp

Uint8Array

The DER-encoded OCSP response.

Returns

Promise<void>

Call Signature

addVerificationOCSP(
   signature, 
   certificatePem, 
   parentCertificatePem, 
   url?, 
   externalResourcesOptions?): Promise<void>;

Adds an OCSP response for a specified signature.

Parameters

signature

PdfSignature

The PdfSignature object.

certificatePem

string

The certificate for which OCSP is requested.

parentCertificatePem

string

The parent certificate.

url?

string

The OCSP URL. If "null", it will be obtained from certificatePem if possible.

externalResourcesOptions?

ExternalResourcesOptions

The options used to execute OCSP request.

Returns

Promise<void>

---

free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ObjectBase.free

---

rebind()

rebind(omTo): void;

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

ObjectBase.rebind