Class PdfCryptFilter`Abstract`

Abstract base class for PDF crypt filters. Crypt filters define how specific types of data (strings, streams, files) are encrypted.

Example

const filter = new AesV2CryptFilter({ authEvent: 'DocOpen' })
filter.setSecurityHandler(securityHandler)
const encrypted = await filter.encrypt(data, objectNumber, generationNumber)

Hierarchy (View Summary)

PdfCryptFilter

Index

Constructors

constructor

new PdfCryptFilter(options: CryptFilterOptions): PdfCryptFilter
Creates a new crypt filter with the specified options.
Parameters
- options: CryptFilterOptions
  Configuration options for the crypt filter.
Returns PdfCryptFilter
- Defined in packages/pdf-lite/src/security/crypt-filters/base.ts:49

Properties

authEvent

authEvent: "DocOpen" | "EFOpen"

Authentication event trigger.

cfm

cfm: "None" | "V2" | "AESV2" | "AESV3"

Crypt filter method identifier.

length

length: number

Key length in bits.

`Protected` `Optional`securityHandler

securityHandler?: PdfSecurityHandler

Security handler for cryptographic operations.

Methods

decrypt

decrypt(
    data: ByteArray,
    objectNumber?: number,
    generationNumber?: number,
): Promise<ByteArray>
Decrypts data using this crypt filter.
Parameters
- data: ByteArray
  The data to decrypt.
- OptionalobjectNumber: number
  The PDF object number for key derivation.
- OptionalgenerationNumber: number
  The PDF generation number for key derivation.
Returns Promise<ByteArray>
The decrypted data.
- Defined in packages/pdf-lite/src/security/crypt-filters/base.ts:113

encrypt

encrypt(
    data: ByteArray,
    objectNumber?: number,
    generationNumber?: number,
): Promise<ByteArray>
Encrypts data using this crypt filter.
Parameters
- data: ByteArray
  The data to encrypt.
- OptionalobjectNumber: number
  The PDF object number for key derivation.
- OptionalgenerationNumber: number
  The PDF generation number for key derivation.
Returns Promise<ByteArray>
The encrypted data.
- Defined in packages/pdf-lite/src/security/crypt-filters/base.ts:96

`Abstract`getCipher

getCipher(objectNumber?: number, generationNumber?: number): Promise<Cipher>
Gets a cipher instance for encrypting/decrypting data.
Parameters
- OptionalobjectNumber: number
  The PDF object number for key derivation.
- OptionalgenerationNumber: number
  The PDF generation number for key derivation.
Returns Promise<Cipher>
A cipher instance for encryption/decryption operations.
- Defined in packages/pdf-lite/src/security/crypt-filters/base.ts:83

getSecurityHandler

getSecurityHandler(): PdfSecurityHandler | undefined
Gets the current security handler.

Returns PdfSecurityHandler | undefined
The security handler, or undefined if not set.
- Defined in packages/pdf-lite/src/security/crypt-filters/base.ts:72

setSecurityHandler

setSecurityHandler(handler: PdfSecurityHandler): void
Sets the security handler for this crypt filter.
Parameters
- handler: PdfSecurityHandler
  The security handler to use for key derivation.
Returns void
- Defined in packages/pdf-lite/src/security/crypt-filters/base.ts:63

toDictionary

toDictionary(): PdfCryptFilterDictionary
Converts this crypt filter to a PDF dictionary representation.

Returns PdfCryptFilterDictionary
The crypt filter dictionary.
- Defined in packages/pdf-lite/src/security/crypt-filters/base.ts:127

Class PdfCryptFilter`Abstract`

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PdfCryptFilter

Properties

authEvent

cfm

length

`Protected` `Optional`securityHandler

Methods

decrypt

Parameters

Returns Promise<ByteArray>

encrypt

Parameters

Returns Promise<ByteArray>

`Abstract`getCipher

Parameters

Returns Promise<Cipher>

getSecurityHandler

Returns PdfSecurityHandler | undefined

setSecurityHandler

Parameters

Returns void

toDictionary

Returns PdfCryptFilterDictionary

Settings

On This Page

Class PdfCryptFilterAbstract

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PdfCryptFilter

Properties

authEvent

cfm

length

Protected OptionalsecurityHandler

Methods

decrypt

Parameters

Returns Promise<ByteArray>

encrypt

Parameters

Returns Promise<ByteArray>

AbstractgetCipher

Parameters

Returns Promise<Cipher>

getSecurityHandler

Returns PdfSecurityHandler | undefined

setSecurityHandler

Parameters

Returns void

toDictionary

Returns PdfCryptFilterDictionary

Settings

On This Page

Class PdfCryptFilter`Abstract`

`Protected` `Optional`securityHandler

`Abstract`getCipher