Class PdfDocumentSecurityStoreObject

Document Security Store (DSS) object for PAdES LTV signatures. Stores validation data (certificates, CRLs, OCSPs) for long-term validation.

Example

const dss = new PdfDocumentSecurityStoreObject(document)
await dss.addCert(certificateBytes)
await dss.addCrl(crlBytes)
await dss.addOcsp(ocspBytes)

Hierarchy (View Summary)

PdfIndirectObject<PdfDocumentSecurityStoreDictionary>
- PdfDocumentSecurityStoreObject

Index

Constructors

constructor

new PdfDocumentSecurityStoreObject(
document: PdfDocument,
content?: PdfDocumentSecurityStoreDictionary,
): PdfDocumentSecurityStoreObject
Creates a new DSS object.
Parameters
- document: PdfDocument
  The parent PDF document.
- Optionalcontent: PdfDocumentSecurityStoreDictionary
  Optional pre-existing DSS dictionary.
Returns PdfDocumentSecurityStoreObject
Overrides PdfIndirectObject.constructor
- Defined in packages/pdf-lite/src/signing/document-security-store.ts:79

Properties

content

content: PdfDocumentSecurityStoreDictionary

`Optional`encryptable

encryptable?: boolean

generationNumber

generationNumber: number

`Protected`modified

modified: boolean = true

Indicates whether the object has been modified. By default, assume it has been modified because it's a new object

objectNumber

objectNumber: number

offset

offset: Ref<number>

`Optional`orderIndex

orderIndex?: number

`Optional`postTokens

postTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Optional`preTokens

preTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Static` `Readonly`MAX_ORDER_INDEX

MAX_ORDER_INDEX: 2147483647

Accessors

objectType

get objectType(): string
The type of this PDF object

Returns string
Inherited from PdfIndirectObject.objectType
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:17

reference

get reference(): PdfObjectReference
Returns PdfObjectReference
Inherited from PdfIndirectObject.reference
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:48

Methods

addCert

addCert(cert: ByteArray): Promise<PdfCertObject>
Adds a certificate to the DSS, avoiding duplicates.
Parameters
- cert: ByteArray
  The DER-encoded certificate.
Returns Promise<PdfCertObject>
The created or existing certificate object.
- Defined in packages/pdf-lite/src/signing/document-security-store.ts:164

addCrl

addCrl(crl: ByteArray): Promise<PdfCrlObject>
Adds a CRL to the DSS, avoiding duplicates.
Parameters
- crl: ByteArray
  The DER-encoded CRL.
Returns Promise<PdfCrlObject>
The created or existing CRL object.
- Defined in packages/pdf-lite/src/signing/document-security-store.ts:129

addOcsp

addOcsp(ocsp: ByteArray): Promise<PdfOcspObject>
Adds an OCSP response to the DSS, avoiding duplicates.
Parameters
- ocsp: ByteArray
  The DER-encoded OCSP response.
Returns Promise<PdfOcspObject>
The created or existing OCSP object.
- Defined in packages/pdf-lite/src/signing/document-security-store.ts:93

addRevocationInfo

addRevocationInfo(revocationInfo: RevocationInfo): Promise<void>
Adds revocation information (CRLs and OCSPs) to the DSS.
Parameters
- revocationInfo: RevocationInfo
  The revocation information to add.
Returns Promise<void>
- Defined in packages/pdf-lite/src/signing/document-security-store.ts:198

as

as<T extends PdfObject>(ctor: new (...args: any[]) => T): T
Attempts to cast the object to a specific PdfObject subclass
Type Parameters
- T extends PdfObject
Parameters
- ctor: new (...args: any[]) => T
Returns T
Inherited from PdfIndirectObject.as
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:65

clone

clone(): this
Creates a deep clone of the object

Returns this
Inherited from PdfIndirectObject.clone
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:117

equals

equals(other?: PdfObject): boolean
Compares this object to another for equality based on their token representations
Parameters
- Optionalother: PdfObject
Returns boolean
Inherited from PdfIndirectObject.equals
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:79

inPdf

inPdf(): boolean
Returns boolean
Inherited from PdfIndirectObject.inPdf
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:92

isEmpty

isEmpty(): boolean
Checks if the DSS is empty (contains no certificates, CRLs, or OCSPs).

Returns boolean
True if the DSS has no stored data.
- Defined in packages/pdf-lite/src/signing/document-security-store.ts:213

isEncryptable

isEncryptable(): boolean
Returns boolean
Inherited from PdfIndirectObject.isEncryptable
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:66

isModified

isModified(): boolean
Indicates whether the object has been modified. Override this method if the modified state is determined differently

Returns boolean
Inherited from PdfIndirectObject.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:130

matchesReference

matchesReference(ref?: PdfObjectReference): boolean
Parameters
- Optionalref: PdfObjectReference
Returns boolean
Inherited from PdfIndirectObject.matchesReference
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:96

order

order(): number
Returns number
Inherited from PdfIndirectObject.order
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:126

setModified

setModified(modified?: boolean): void
Sets the modified state of the object. Override this method if the modified state is determined differently
Parameters
- modified: boolean = true
Returns void
Inherited from PdfIndirectObject.setModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:27

toBytes

toBytes(padTo?: number): ByteArray
Converts the object to a ByteArray, optionally padding to a specified length
Parameters
- OptionalpadTo: number
Returns ByteArray
Inherited from PdfIndirectObject.toBytes
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:41

`Protected`tokenize

tokenize(): PdfToken[]
Tokenizes the object into an array of PdfTokens

Returns PdfToken[]
Inherited from PdfIndirectObject.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:106

toString

toString(): string
Converts the object to a string representation

Returns string
Inherited from PdfIndirectObject.toString
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:56

toTokens

toTokens(): PdfToken[]
Converts the object to an array of PdfTokens, including any pre or post tokens

Returns PdfToken[]
Inherited from PdfIndirectObject.toTokens
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:32

`Static`createPlaceholder

createPlaceholder<T extends PdfObject>(
    objectNumber?: number,
    generationNumber?: number,
    content?: T,
): PdfIndirectObject<T extends unknown ? PdfNull : T>
Type Parameters
- T extends PdfObject
Parameters
- OptionalobjectNumber: number
- OptionalgenerationNumber: number
- Optionalcontent: T
Returns PdfIndirectObject<T extends unknown ? PdfNull : T>
Inherited from PdfIndirectObject.createPlaceholder
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:79

Class PdfDocumentSecurityStoreObject

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfDocumentSecurityStoreObject

Properties

content

Optionalencryptable

generationNumber

Protectedmodified

objectNumber

offset

OptionalorderIndex

OptionalpostTokens

OptionalpreTokens

Static ReadonlyMAX_ORDER_INDEX

Accessors

objectType

Returns string

reference

Returns PdfObjectReference

Methods

addCert

Parameters

Returns Promise<PdfCertObject>

addCrl

Parameters

Returns Promise<PdfCrlObject>

addOcsp

Parameters

Returns Promise<PdfOcspObject>

addRevocationInfo

Parameters

Returns Promise<void>

as

Type Parameters

Parameters

Returns T

clone

Returns this

equals

Parameters

Returns boolean

inPdf

Returns boolean

isEmpty

Returns boolean

isEncryptable

Returns boolean

isModified

Returns boolean

matchesReference

Parameters

Returns boolean

order

Returns number

setModified

Parameters

Returns void

toBytes

Parameters

Returns ByteArray

Protectedtokenize

Returns PdfToken[]

toString

Returns string

toTokens

Returns PdfToken[]

StaticcreatePlaceholder

Type Parameters

Parameters

Returns PdfIndirectObject<T extends unknown ? PdfNull : T>

Settings

`Optional`encryptable

`Protected`modified

`Optional`orderIndex

`Optional`postTokens

`Optional`preTokens

`Static` `Readonly`MAX_ORDER_INDEX

`Protected`tokenize

`Static`createPlaceholder