Class PdfSignatureObject`Abstract`

Abstract base class for PDF signature objects. Subclasses implement specific signature formats (PKCS#7, CAdES, etc.).

Example

const signature = new PdfAdbePkcs7DetachedSignatureObject({
    privateKey,
    certificate,
    reason: 'Approval'
})
document.add(signature)
await document.commit()

Hierarchy (View Summary)

PdfIndirectObject<PdfSignatureDictionary>
- PdfSignatureObject

Constructors

constructor

new PdfSignatureObject(
    content:
        | PdfSignatureDictionary
        | PdfSignatureSignOptions & {
            certs?: ByteArray[];
            subfilter: PdfSignatureSubType;
        },
): PdfSignatureObject
Creates a new signature object.
Parameters
- content:
      | PdfSignatureDictionary
      | PdfSignatureSignOptions & {
          certs?: ByteArray[];
          subfilter: PdfSignatureSubType;
      }
  Either a signature dictionary or options to create one.
Returns PdfSignatureObject
Overrides PdfIndirectObject.constructor
- Defined in packages/pdf-lite/src/signing/signatures/base.ts:99

Properties

content

content: PdfSignatureDictionary

`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

signedBytes

get signedBytes(): ByteArray
Gets the raw signature bytes.

Returns ByteArray
The signature bytes.
- Defined in packages/pdf-lite/src/signing/signatures/base.ts:172

signedHexadecimal

get signedHexadecimal(): PdfHexadecimal
Gets the signature hexadecimal content.

Returns PdfHexadecimal
The Contents entry as hexadecimal.

Throws
Error if Contents entry is missing.
- Defined in packages/pdf-lite/src/signing/signatures/base.ts:158

Methods

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

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
Gets the insertion order for this object in the PDF.

Returns number
High order value to place signature near end of document.
Overrides PdfIndirectObject.order
- Defined in packages/pdf-lite/src/signing/signatures/base.ts:226

setByteRange

setByteRange(byteRange: number[]): void
Sets the byte range array for the signature.
Parameters
- byteRange: number[]
  Array of [offset1, length1, offset2, length2].
Returns void
Throws
Error if ByteRange entry is missing.
- Defined in packages/pdf-lite/src/signing/signatures/base.ts:201

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

setSignedBytes

setSignedBytes(signedBytes: ByteArray): void
Sets the signed bytes in the signature dictionary.
Parameters
- signedBytes: ByteArray
  The signature bytes to set.
Returns void
Throws
Error if Contents entry is missing.
- Defined in packages/pdf-lite/src/signing/signatures/base.ts:182

`Abstract`sign

sign(
options: { bytes: ByteArray; embedRevocationInfo?: boolean },
): Promise<{ revocationInfo?: RevocationInfo; signedBytes: ByteArray }>
Signs the document bytes and returns the signature.
Parameters
- options: { bytes: ByteArray; embedRevocationInfo?: boolean }
  Signing options including bytes to sign.
Returns Promise<{ revocationInfo?: RevocationInfo; signedBytes: ByteArray }>
The signed bytes and optional revocation information.
- Defined in packages/pdf-lite/src/signing/signatures/base.ts:144

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 PdfSignatureObjectAbstract

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfSignatureObject

Properties

content

Optionalencryptable

generationNumber

Protectedmodified

objectNumber

offset

OptionalorderIndex

OptionalpostTokens

OptionalpreTokens

Static ReadonlyMAX_ORDER_INDEX

Accessors

objectType

Returns string

reference

Returns PdfObjectReference

signedBytes

Returns ByteArray

signedHexadecimal

Returns PdfHexadecimal

Throws

Methods

as

Type Parameters

Parameters

Returns T

clone

Returns this

equals

Parameters

Returns boolean

inPdf

Returns boolean

isEncryptable

Returns boolean

isModified

Returns boolean

matchesReference

Parameters

Returns boolean

order

Returns number

setByteRange

Parameters

Returns void

Throws

setModified

Parameters

Returns void

setSignedBytes

Parameters

Returns void

Throws

Abstractsign

Parameters

Returns Promise<{ revocationInfo?: RevocationInfo; signedBytes: ByteArray }>

toBytes

Parameters

Returns ByteArray

Protectedtokenize

Returns PdfToken[]

toString

Returns string

toTokens

Returns PdfToken[]

StaticcreatePlaceholder

Type Parameters

Parameters

Class PdfSignatureObject`Abstract`

`Optional`encryptable

`Protected`modified

`Optional`orderIndex

`Optional`postTokens

`Optional`preTokens

`Static` `Readonly`MAX_ORDER_INDEX

`Abstract`sign

`Protected`tokenize

`Static`createPlaceholder