Class AesV3CryptFilter

AESV3 crypt filter using AES-256-CBC encryption. Implements 256-bit AES encryption in CBC mode for PDF content. This is the recommended encryption method for new documents.

Example

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

Hierarchy (View Summary)

PdfCryptFilter
- AesV3CryptFilter

Index

Constructors

constructor

new AesV3CryptFilter(
    options: {
        authEvent: "DocOpen" | "EFOpen";
        securityHandler?: PdfSecurityHandler;
    },
): AesV3CryptFilter
Creates a new AES-256 crypt filter.
Parameters
- options: { authEvent: "DocOpen" | "EFOpen"; securityHandler?: PdfSecurityHandler }
  Configuration options with authentication event and security handler.
Returns AesV3CryptFilter
Overrides PdfCryptFilter.constructor
- Defined in packages/pdf-lite/src/security/crypt-filters/aesv3.ts:25

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.
Inherited from PdfCryptFilter.decrypt
- 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.
Inherited from PdfCryptFilter.encrypt
- Defined in packages/pdf-lite/src/security/crypt-filters/base.ts:96

getCipher

getCipher(objectNumber?: number, generationNumber?: number): Promise<Cipher>
Gets an AES-256 cipher for encryption/decryption.
Parameters
- OptionalobjectNumber: number
  The PDF object number (unused for AESV3).
- OptionalgenerationNumber: number
  The PDF generation number (unused for AESV3).
Returns Promise<Cipher>
An AES-256 cipher instance.

Throws
Error if security handler is not set.
Overrides PdfCryptFilter.getCipher
- Defined in packages/pdf-lite/src/security/crypt-filters/aesv3.ts:40

getSecurityHandler

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

Returns PdfSecurityHandler | undefined
The security handler, or undefined if not set.
Inherited from PdfCryptFilter.getSecurityHandler
- 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
Inherited from PdfCryptFilter.setSecurityHandler
- 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.
Inherited from PdfCryptFilter.toDictionary
- Defined in packages/pdf-lite/src/security/crypt-filters/base.ts:127

Class AesV3CryptFilter

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AesV3CryptFilter

Properties

authEvent

cfm

length

`Protected` `Optional`securityHandler

Methods

decrypt

Parameters

Returns Promise<ByteArray>

encrypt

Parameters

Returns Promise<ByteArray>

getCipher

Parameters

Returns Promise<Cipher>

Throws

getSecurityHandler

Returns PdfSecurityHandler | undefined

setSecurityHandler

Parameters

Returns void

toDictionary

Returns PdfCryptFilterDictionary

Settings

On This Page

Class AesV3CryptFilter

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AesV3CryptFilter

Properties

authEvent

cfm

length

Protected OptionalsecurityHandler

Methods

decrypt

Parameters

Returns Promise<ByteArray>

encrypt

Parameters

Returns Promise<ByteArray>

getCipher

Parameters

Returns Promise<Cipher>

Throws

getSecurityHandler

Returns PdfSecurityHandler | undefined

setSecurityHandler

Parameters

Returns void

toDictionary

Returns PdfCryptFilterDictionary

Settings

On This Page

`Protected` `Optional`securityHandler