Class V2CryptFilter

V2 crypt filter using RC4 encryption. Implements the legacy RC4 stream cipher for PDF encryption.

Example

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

Hierarchy (View Summary)

PdfCryptFilter
- V2CryptFilter

Index

Constructors

constructor

new V2CryptFilter(
    options: {
        authEvent: "DocOpen" | "EFOpen";
        length?: number;
        securityHandler?: PdfSecurityHandler;
    },
): V2CryptFilter
Creates a new V2 crypt filter with RC4 encryption.
Parameters
- options: {
      authEvent: "DocOpen" | "EFOpen";
      length?: number;
      securityHandler?: PdfSecurityHandler;
  }
  Configuration options including key length.
Returns V2CryptFilter
Overrides PdfCryptFilter.constructor
- Defined in packages/pdf-lite/src/security/crypt-filters/v2.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 RC4 cipher for encryption/decryption.
Parameters
- OptionalobjectNumber: number
  The PDF object number for key derivation.
- OptionalgenerationNumber: number
  The PDF generation number for key derivation.
Returns Promise<Cipher>
An RC4 cipher instance.

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

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 V2CryptFilter

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns V2CryptFilter

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 V2CryptFilter

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns V2CryptFilter

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