Class PdfV2SecurityHandler

V2 security handler implementing 128-bit RC4 encryption. Extends V1 with stronger key length (PDF 1.4).

Example

const handler = new PdfV2SecurityHandler({
    password: 'user123',
    ownerPassword: 'admin456'
})

Hierarchy (View Summary)

PdfV1SecurityHandler
- PdfV2SecurityHandler
  - PdfV4SecurityHandler

Constructors

constructor

new PdfV2SecurityHandler(
options: PdfStandardSecurityHandlerOptions,
): PdfV2SecurityHandler
Creates a new standard security handler.
Parameters
- options: PdfStandardSecurityHandlerOptions
  Configuration options including passwords and document ID.
Returns PdfV2SecurityHandler
Inherited from PdfV1SecurityHandler.constructor
- Defined in packages/pdf-lite/src/security/handlers/base.ts:351

Properties

dict

dict: PdfEncryptionDictionary

The encryption dictionary containing all encryption parameters.

`Protected` `Optional`documentId

documentId?: PdfId

Document identifier for key derivation.

encryptMetadata

encryptMetadata: boolean

Whether to encrypt document metadata.

`Protected` `Optional`masterKey

masterKey?: ByteArray

Derived master encryption key.

`Protected` `Optional`ownerKey

ownerKey?: ByteArray

Computed owner key (O value).

`Protected` `Optional`ownerPassword

ownerPassword?: ByteArray

Owner password for full access.

`Protected`password

password: ByteArray

User password for authentication.

permissions

permissions: number

Numeric permission flags.

`Protected` `Optional`userKey

userKey?: ByteArray

Computed user key (U value).

Methods

`Protected`buildPermissions

buildPermissions(perm: PdfPermissions): number
Builds the numeric permission flags from a PdfPermissions object.
Parameters
- perm: PdfPermissions
  The permissions to encode.
Returns number
The numeric permission flags.
Inherited from PdfV1SecurityHandler.buildPermissions
- Defined in packages/pdf-lite/src/security/handlers/base.ts:188

canEncryptMetadata

canEncryptMetadata(): boolean
Checks if metadata encryption is enabled.

Returns boolean
True if metadata should be encrypted.
Inherited from PdfV1SecurityHandler.canEncryptMetadata
- Defined in packages/pdf-lite/src/security/handlers/base.ts:445

`Protected`computeMasterKey

computeMasterKey(): Promise<ByteArray>
Computes the master encryption key from the password.

Returns Promise<ByteArray>
The computed master key.

Throws
Error if required parameters are missing or password is incorrect.
Inherited from PdfV1SecurityHandler.computeMasterKey
- Defined in packages/pdf-lite/src/security/handlers/v1.ts:104

computeObjectKey

computeObjectKey(
    objectNumber?: number,
    generationNumber?: number,
    algorithm?: PdfEncryptionAlgorithmType,
): Promise<ByteArray>
Computes the object-specific encryption key.
Parameters
- OptionalobjectNumber: number
  The PDF object number.
- OptionalgenerationNumber: number
  The PDF generation number.
- Optionalalgorithm: PdfEncryptionAlgorithmType
  Optional algorithm type for key derivation.
Returns Promise<ByteArray>
The computed object key.

Throws
Error if object or generation number is invalid.
Inherited from PdfV1SecurityHandler.computeObjectKey
- Defined in packages/pdf-lite/src/security/handlers/v1.ts:162

`Protected`computeOwnerKey

computeOwnerKey(): Promise<ByteArray>
Computes the owner key (O value) using RC4-128 algorithm.

Returns Promise<ByteArray>
The computed owner key.
Overrides PdfV1SecurityHandler.computeOwnerKey
- Defined in packages/pdf-lite/src/security/handlers/v2.ts:58

`Protected`computeUserKey

computeUserKey(): Promise<ByteArray>
Computes the user key (U value) using RC4-128 algorithm.

Returns Promise<ByteArray>
The computed user key.

Throws
Error if document ID, owner key, or permissions are not set.
Overrides PdfV1SecurityHandler.computeUserKey
- Defined in packages/pdf-lite/src/security/handlers/v2.ts:71

decodePermissions

decodePermissions(): PdfPermissions
Decodes the numeric permission flags into a PdfPermissions object.

Returns PdfPermissions
An object with boolean flags for each permission.
Inherited from PdfV1SecurityHandler.decodePermissions
- Defined in packages/pdf-lite/src/security/handlers/base.ts:71

decrypt

decrypt(
    type: "string" | "stream" | "file",
    data: ByteArray,
    objectNumber?: number,
    generationNumber?: number,
): Promise<ByteArray>
Decrypts data using the appropriate cipher.
Parameters
- type: "string" | "stream" | "file"
  The type of content being decrypted.
- data: ByteArray
  The encrypted data.
- OptionalobjectNumber: number
  The PDF object number.
- OptionalgenerationNumber: number
  The PDF generation number.
Returns Promise<ByteArray>
The decrypted data.
Inherited from PdfV1SecurityHandler.decrypt
- Defined in packages/pdf-lite/src/security/handlers/base.ts:591

decryptObject

decryptObject(object: PdfIndirectObject): Promise<void>
Recursively decrypts all strings and streams within an indirect object.
Parameters
- object: PdfIndirectObject
  The indirect object to decrypt.
Returns Promise<void>
Inherited from PdfV1SecurityHandler.decryptObject
- Defined in packages/pdf-lite/src/security/handlers/base.ts:207

encrypt

encrypt(
    type: "string" | "stream" | "file",
    data: ByteArray,
    objectNumber?: number,
    generationNumber?: number,
): Promise<ByteArray>
Encrypts data using the appropriate cipher.
Parameters
- type: "string" | "stream" | "file"
  The type of content being encrypted.
- data: ByteArray
  The data to encrypt.
- OptionalobjectNumber: number
  The PDF object number.
- OptionalgenerationNumber: number
  The PDF generation number.
Returns Promise<ByteArray>
The encrypted data.
Inherited from PdfV1SecurityHandler.encrypt
- Defined in packages/pdf-lite/src/security/handlers/base.ts:567

encryptObject

encryptObject(object: PdfIndirectObject): Promise<void>
Recursively encrypts all strings and streams within an indirect object.
Parameters
- object: PdfIndirectObject
  The indirect object to encrypt.
Returns Promise<void>
Inherited from PdfV1SecurityHandler.encryptObject
- Defined in packages/pdf-lite/src/security/handlers/base.ts:252

`Protected`getCipher

getCipher(objectNumber?: number, generationNumber?: number): Promise<Cipher>
Gets an RC4 cipher for the specified object.
Parameters
- OptionalobjectNumber: number
  The PDF object number.
- OptionalgenerationNumber: number
  The PDF generation number.
Returns Promise<Cipher>
An RC4 cipher instance.
Overrides PdfV1SecurityHandler.getCipher
- Defined in packages/pdf-lite/src/security/handlers/v2.ts:101

getDocumentId

getDocumentId(): PdfId | undefined
Gets the document ID.

Returns PdfId | undefined
The document ID, or undefined if not set.
Inherited from PdfV1SecurityHandler.getDocumentId
- Defined in packages/pdf-lite/src/security/handlers/base.ts:414

getKeyBits

getKeyBits(): number
Gets the encryption key length in bits.

Returns number
128 for V2 encryption.
Overrides PdfV1SecurityHandler.getKeyBits
- Defined in packages/pdf-lite/src/security/handlers/v2.ts:49

getName

getName(): string
Gets the security handler filter name.

Returns string
'Standard' for password-based encryption.
Inherited from PdfV1SecurityHandler.getName
- Defined in packages/pdf-lite/src/security/handlers/base.ts:387

getRevision

getRevision(): number
Gets the encryption revision number.

Returns number
3 for V2 encryption.
Overrides PdfV1SecurityHandler.getRevision
- Defined in packages/pdf-lite/src/security/handlers/v2.ts:31

getVersion

getVersion(): number
Gets the encryption version number.

Returns number
2 for 128-bit RC4 encryption.
Overrides PdfV1SecurityHandler.getVersion
- Defined in packages/pdf-lite/src/security/handlers/v2.ts:40

`Protected`initKeys

initKeys(): Promise<void>
Initializes the user and owner keys if not already set.

Returns Promise<void>
Inherited from PdfV1SecurityHandler.initKeys
- Defined in packages/pdf-lite/src/security/handlers/base.ts:510

isReady

isReady(): boolean
Checks if the handler is ready (has document ID).

Returns boolean
True if document ID is set.
Inherited from PdfV1SecurityHandler.isReady
- Defined in packages/pdf-lite/src/security/handlers/base.ts:396

readEncryptionDictionary

readEncryptionDictionary(encryptionDictionary: PdfEncryptionDictionary): void
Reads encryption parameters from the encryption dictionary.
Parameters
- encryptionDictionary: PdfEncryptionDictionary
  The encryption dictionary from the PDF.
Returns void
Inherited from PdfV1SecurityHandler.readEncryptionDictionary
- Defined in packages/pdf-lite/src/security/handlers/base.ts:454

recoverUserPassword

recoverUserPassword(ownerPassword?: string | ByteArray): Promise<string>
Recovers the user password from the owner password.
Parameters
- OptionalownerPassword: string | ByteArray
  The owner password.
Returns Promise<string>
The recovered user password as a string.
Overrides PdfV1SecurityHandler.recoverUserPassword
- Defined in packages/pdf-lite/src/security/handlers/v2.ts:116

setDocumentId

setDocumentId(id: PdfId): void
Sets the document ID for key derivation.
Parameters
- id: PdfId
  The document ID array.
Returns void
Inherited from PdfV1SecurityHandler.setDocumentId
- Defined in packages/pdf-lite/src/security/handlers/base.ts:405

setMasterKey

setMasterKey(masterKey: ByteArray): void
Sets the master encryption key directly.
Parameters
- masterKey: ByteArray
  The master key to use.
Returns void
Inherited from PdfV1SecurityHandler.setMasterKey
- Defined in packages/pdf-lite/src/security/handlers/base.ts:611

setOwnerPassword

setOwnerPassword(ownerPassword: string | ByteArray): void
Sets the owner password.
Parameters
- ownerPassword: string | ByteArray
  The owner password string or bytes.
Returns void
Inherited from PdfV1SecurityHandler.setOwnerPassword
- Defined in packages/pdf-lite/src/security/handlers/base.ts:433

setPassword

setPassword(password: string | ByteArray): void
Sets the user password.
Parameters
- password: string | ByteArray
  The user password string or bytes.
Returns void
Inherited from PdfV1SecurityHandler.setPassword
- Defined in packages/pdf-lite/src/security/handlers/base.ts:423

write

write(): Promise<void>
Writes the encryption dictionary with all computed keys and parameters.

Returns Promise<void>
Throws
Error if required keys are not computed.
Inherited from PdfV1SecurityHandler.write
- Defined in packages/pdf-lite/src/security/handlers/base.ts:520

Class PdfV2SecurityHandler

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PdfV2SecurityHandler

Properties

dict

Protected OptionaldocumentId

encryptMetadata

Protected OptionalmasterKey

Protected OptionalownerKey

Protected OptionalownerPassword

Protectedpassword

permissions

Protected OptionaluserKey

Methods

ProtectedbuildPermissions

Parameters

Returns number

canEncryptMetadata

Returns boolean

ProtectedcomputeMasterKey

Returns Promise<ByteArray>

Throws

computeObjectKey

Parameters

Returns Promise<ByteArray>

Throws

ProtectedcomputeOwnerKey

Returns Promise<ByteArray>

ProtectedcomputeUserKey

Returns Promise<ByteArray>

Throws

decodePermissions

Returns PdfPermissions

decrypt

Parameters

Returns Promise<ByteArray>

decryptObject

Parameters

Returns Promise<void>

encrypt

Parameters

Returns Promise<ByteArray>

encryptObject

Parameters

Returns Promise<void>

ProtectedgetCipher

Parameters

Returns Promise<Cipher>

getDocumentId

Returns PdfId | undefined

getKeyBits

Returns number

getName

Returns string

getRevision

Returns number

getVersion

Returns number

ProtectedinitKeys

Returns Promise<void>

isReady

Returns boolean

readEncryptionDictionary

Parameters

Returns void

recoverUserPassword

Parameters

Returns Promise<string>

setDocumentId

Parameters

Returns void

setMasterKey

`Protected` `Optional`documentId

`Protected` `Optional`masterKey

`Protected` `Optional`ownerKey

`Protected` `Optional`ownerPassword

`Protected`password

`Protected` `Optional`userKey

`Protected`buildPermissions

`Protected`computeMasterKey

`Protected`computeOwnerKey

`Protected`computeUserKey

`Protected`getCipher

`Protected`initKeys