Class PdfV5SecurityHandler

V5 security handler implementing AES-256-CBC encryption. This is the most secure encryption method (PDF 2.0).

Example

const handler = new PdfV5SecurityHandler({
    password: 'strongPassword123',
    ownerPassword: 'adminPassword456'
})

Hierarchy (View Summary)

PdfV4SecurityHandler
- PdfV5SecurityHandler

Constructors

constructor

new PdfV5SecurityHandler(
    options: PdfSecurityHandlerOptions & {
        documentId?: string | ByteArray | PdfId;
        ownerKey?: ByteArray;
        ownerPassword?: string | ByteArray;
        password?: string | ByteArray;
        userKey?: ByteArray;
    } & { ownerEncryptedFileKey?: ByteArray; userEncryptedFileKey?: ByteArray },
): PdfV5SecurityHandler
Creates a new V5 security handler with AES-256 encryption.
Parameters
- options: PdfSecurityHandlerOptions & {
      documentId?: string | ByteArray | PdfId;
      ownerKey?: ByteArray;
      ownerPassword?: string | ByteArray;
      password?: string | ByteArray;
      userKey?: ByteArray;
  } & { ownerEncryptedFileKey?: ByteArray; userEncryptedFileKey?: ByteArray }
  Configuration options including optional pre-computed keys.
  - OptionaldocumentId?: string | ByteArray | PdfId
    Document identifier for key derivation.
  - OptionalownerKey?: ByteArray
    Pre-computed owner key.
  - OptionalownerPassword?: string | ByteArray
    Owner password for full document access.
  - Optionalpassword?: string | ByteArray
    User password for opening the document.
  - OptionaluserKey?: ByteArray
    Pre-computed user key.
  - OptionalownerEncryptedFileKey?: ByteArray
  - OptionaluserEncryptedFileKey?: ByteArray
Returns PdfV5SecurityHandler
Overrides PdfV4SecurityHandler.constructor
- Defined in packages/pdf-lite/src/security/handlers/v5.ts:45

Properties

`Protected`cryptFilters

cryptFilters: Map<string, PdfCryptFilter> = ...

Map of named crypt filters.

`Protected`cryptFiltersByType

cryptFiltersByType: { file?: string; stream?: string; string?: string } = {}

Mapping of content types to crypt filter names.

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`fileKey

fileKey?: Promise<ByteArray>

Promise resolving to the file encryption key.

`Protected` `Optional`masterKey

masterKey?: ByteArray

Derived master encryption key.

`Protected` `Optional`ownerEncryptedFileKey

ownerEncryptedFileKey?: ByteArray

Owner encrypted file key (OE value).

`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`perms

perms?: ByteArray

Permissions entry (Perms value).

`Protected` `Optional`userEncryptedFileKey

userEncryptedFileKey?: ByteArray

User encrypted file key (UE value).

`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 PdfV4SecurityHandler.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 PdfV4SecurityHandler.canEncryptMetadata
- Defined in packages/pdf-lite/src/security/handlers/base.ts:445

`Protected`computeMasterKey

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

Returns Promise<ByteArray>
The file encryption key.

Throws
Error if file key is not initialized.
Overrides PdfV4SecurityHandler.computeMasterKey
- Defined in packages/pdf-lite/src/security/handlers/v5.ts:132

computeObjectKey

computeObjectKey(): Promise<ByteArray>
Computes the object encryption key (same as master key for V5).

Returns Promise<ByteArray>
The master encryption key.
Overrides PdfV4SecurityHandler.computeObjectKey
- Defined in packages/pdf-lite/src/security/handlers/v5.ts:281

`Protected`computeOwnerKey

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

Returns Promise<ByteArray>
The computed owner key.
Inherited from PdfV4SecurityHandler.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.
Inherited from PdfV4SecurityHandler.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 PdfV4SecurityHandler.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 crypt filter for the content type.
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 PdfV4SecurityHandler.decrypt
- Defined in packages/pdf-lite/src/security/handlers/v4.ts:366

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 PdfV4SecurityHandler.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 crypt filter for the content type.
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 PdfV4SecurityHandler.encrypt
- Defined in packages/pdf-lite/src/security/handlers/v4.ts:343

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 PdfV4SecurityHandler.encryptObject
- Defined in packages/pdf-lite/src/security/handlers/base.ts:252

`Protected`getCipher

getCipher(): Promise<Cipher>
Gets an AES-256 cipher.

Returns Promise<Cipher>
An AES-256 cipher instance.
Overrides PdfV4SecurityHandler.getCipher
- Defined in packages/pdf-lite/src/security/handlers/v5.ts:191

getCryptFilter

getCryptFilter(name: string): PdfCryptFilter | undefined
Gets a crypt filter by name.
Parameters
- name: string
  The crypt filter name.
Returns PdfCryptFilter | undefined
The crypt filter, or undefined if not found.
Inherited from PdfV4SecurityHandler.getCryptFilter
- Defined in packages/pdf-lite/src/security/handlers/v4.ts:74

getCryptFilterByType

getCryptFilterByType(type: CryptFilterType): PdfCryptFilter | null
Gets the crypt filter assigned to a content type.
Parameters
- type: CryptFilterType
  The content type ('string', 'stream', or 'file').
Returns PdfCryptFilter | null
The assigned crypt filter, or null if none.
Inherited from PdfV4SecurityHandler.getCryptFilterByType
- Defined in packages/pdf-lite/src/security/handlers/v4.ts:84

getDocumentId

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

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

getKeyBits

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

Returns number
256 for V5 encryption.
Overrides PdfV4SecurityHandler.getKeyBits
- Defined in packages/pdf-lite/src/security/handlers/v5.ts:182

getName

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

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

getRevision

getRevision(): number
Gets the encryption revision number.

Returns number
6 for V5 encryption.
Overrides PdfV4SecurityHandler.getRevision
- Defined in packages/pdf-lite/src/security/handlers/v5.ts:211

getVersion

getVersion(): number
Gets the encryption version number.

Returns number
5 for AES-256 encryption.
Overrides PdfV4SecurityHandler.getVersion
- Defined in packages/pdf-lite/src/security/handlers/v5.ts:202

`Protected`initKeys

initKeys(): Promise<void>
Initializes encryption keys, either deriving from existing values or generating new ones.

Returns Promise<void>
Overrides PdfV4SecurityHandler.initKeys
- Defined in packages/pdf-lite/src/security/handlers/v5.ts:78

isReady

isReady(): boolean
Checks if the handler is ready (has user encrypted file key).

Returns boolean
True if the handler has the required keys.
Overrides PdfV4SecurityHandler.isReady
- Defined in packages/pdf-lite/src/security/handlers/v5.ts:71

readEncryptionDictionary

readEncryptionDictionary(encryptionDictionary: PdfEncryptionDictionary): void
Reads V5-specific encryption parameters from the dictionary.
Parameters
- encryptionDictionary: PdfEncryptionDictionary
  The encryption dictionary from the PDF.
Returns void
Throws
Error if required entries are missing or invalid.
Overrides PdfV4SecurityHandler.readEncryptionDictionary
- Defined in packages/pdf-lite/src/security/handlers/v5.ts:239

recoverUserPassword

recoverUserPassword(ownerPassword?: string | ByteArray): Promise<string>
Recovers the user password from the owner password. Not supported for AES-256 encryption.
Parameters
- OptionalownerPassword: string | ByteArray
Returns Promise<string>
Throws
Error always, as this operation is not supported for V5.
Overrides PdfV4SecurityHandler.recoverUserPassword
- Defined in packages/pdf-lite/src/security/handlers/v5.ts:291

setCryptFilter

setCryptFilter(name: string, filter: PdfCryptFilter): void
Registers a named crypt filter.
Parameters
- name: string
  The filter name.
- filter: PdfCryptFilter
  The crypt filter instance.
Returns void
Inherited from PdfV4SecurityHandler.setCryptFilter
- Defined in packages/pdf-lite/src/security/handlers/v4.ts:108

setCryptFilterForType

setCryptFilterForType(type: CryptFilterType, name: string): void
Assigns a crypt filter to a content type.
Parameters
- type: CryptFilterType
  The content type.
- name: string
  The crypt filter name.
Returns void
Inherited from PdfV4SecurityHandler.setCryptFilterForType
- Defined in packages/pdf-lite/src/security/handlers/v4.ts:98

setDocumentId

setDocumentId(id: PdfId): void
Sets the document ID for key derivation.
Parameters
- id: PdfId
  The document ID array.
Returns void
Inherited from PdfV4SecurityHandler.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 PdfV4SecurityHandler.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 PdfV4SecurityHandler.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 PdfV4SecurityHandler.setPassword
- Defined in packages/pdf-lite/src/security/handlers/base.ts:423

write

write(): Promise<void>
Writes the encryption dictionary including V5-specific entries.

Returns Promise<void>
Throws
Error if required keys are not computed.
Overrides PdfV4SecurityHandler.write
- Defined in packages/pdf-lite/src/security/handlers/v5.ts:220

Class PdfV5SecurityHandler

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionaldocumentId?: string | ByteArray | PdfId

OptionalownerKey?: ByteArray

OptionalownerPassword?: string | ByteArray

Optionalpassword?: string | ByteArray

OptionaluserKey?: ByteArray

OptionalownerEncryptedFileKey?: ByteArray

OptionaluserEncryptedFileKey?: ByteArray

Returns PdfV5SecurityHandler

Properties

ProtectedcryptFilters

ProtectedcryptFiltersByType

dict

Protected OptionaldocumentId

encryptMetadata

Protected OptionalfileKey

Protected OptionalmasterKey

Protected OptionalownerEncryptedFileKey

Protected OptionalownerKey

Protected OptionalownerPassword

Protectedpassword

permissions

Protected Optionalperms

Protected OptionaluserEncryptedFileKey

Protected OptionaluserKey

Methods

ProtectedbuildPermissions

Parameters

Returns number

canEncryptMetadata

Returns boolean

ProtectedcomputeMasterKey

Returns Promise<ByteArray>

Throws

computeObjectKey

Returns Promise<ByteArray>

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

Returns Promise<Cipher>

getCryptFilter

Parameters

Returns PdfCryptFilter | undefined

getCryptFilterByType

Parameters

Returns PdfCryptFilter | null

getDocumentId

Returns PdfId | undefined

getKeyBits

Returns number

getName

Returns string

getRevision

Returns number

`Optional`documentId?: string | ByteArray | PdfId

`Optional`ownerKey?: ByteArray

`Optional`ownerPassword?: string | ByteArray

`Optional`password?: string | ByteArray

`Optional`userKey?: ByteArray

`Optional`ownerEncryptedFileKey?: ByteArray

`Optional`userEncryptedFileKey?: ByteArray

`Protected`cryptFilters

`Protected`cryptFiltersByType

`Protected` `Optional`documentId

`Protected` `Optional`fileKey

`Protected` `Optional`masterKey

`Protected` `Optional`ownerEncryptedFileKey

`Protected` `Optional`ownerKey

`Protected` `Optional`ownerPassword

`Protected`password

`Protected` `Optional`perms

`Protected` `Optional`userEncryptedFileKey

`Protected` `Optional`userKey

`Protected`buildPermissions

`Protected`computeMasterKey

`Protected`computeOwnerKey

`Protected`computeUserKey

`Protected`getCipher

`Protected`initKeys