Class PdfSecurityHandler`Abstract`

Abstract base class for PDF security handlers. Security handlers manage encryption, decryption, and access permissions for PDF documents.

Example

const handler = new PdfV5SecurityHandler({ password: 'secret' })
await handler.write()
const encryptedData = await handler.encrypt('stream', data, objectNumber, generationNumber)

Hierarchy (View Summary)

PdfSecurityHandler
- PdfStandardSecurityHandler
- PdfPublicKeySecurityHandler

Index

Constructors

constructor

new PdfSecurityHandler(options?: PdfSecurityHandlerOptions): PdfSecurityHandler
Creates a new security handler.
Parameters
- Optionaloptions: PdfSecurityHandlerOptions
  Configuration options for the security handler.
Returns PdfSecurityHandler
- Defined in packages/pdf-lite/src/security/handlers/base.ts:55

Properties

dict

dict: PdfEncryptionDictionary

The encryption dictionary containing all encryption parameters.

encryptMetadata

encryptMetadata: boolean

Whether to encrypt document metadata.

permissions

permissions: number

Numeric permission flags.

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

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

decodePermissions

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

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

`Abstract`decrypt

decrypt(
    type: "string" | "stream" | "file",
    data: ByteArray,
    objectNumber?: number,
    generationNumber?: number,
): Promise<ByteArray>
Decrypts data of a specific 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.
- Defined in packages/pdf-lite/src/security/handlers/base.ts:126

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

`Abstract`encrypt

encrypt(
    type: "string" | "stream" | "file",
    data: ByteArray,
    objectNumber?: number,
    generationNumber?: number,
): Promise<ByteArray>
Encrypts data of a specific 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.
- Defined in packages/pdf-lite/src/security/handlers/base.ts:142

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

`Abstract`getDocumentId

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

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

`Abstract`getName

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

Returns string
The filter name (e.g., 'Standard').
- Defined in packages/pdf-lite/src/security/handlers/base.ts:94

`Abstract`getRevision

getRevision(): number
Gets the encryption revision number.

Returns number
The revision number.
- Defined in packages/pdf-lite/src/security/handlers/base.ts:108

`Abstract`getVersion

getVersion(): number
Gets the encryption version number.

Returns number
The version number (1-5).
- Defined in packages/pdf-lite/src/security/handlers/base.ts:101

`Abstract`isReady

isReady(): boolean
Checks if the security handler is ready for encryption/decryption.

Returns boolean
True if ready, false otherwise.
- Defined in packages/pdf-lite/src/security/handlers/base.ts:87

`Abstract`readEncryptionDictionary

readEncryptionDictionary(dictionary: PdfEncryptionDictionary): void
Reads and applies encryption parameters from a dictionary.
Parameters
- dictionary: PdfEncryptionDictionary
  The encryption dictionary from the PDF trailer.
Returns void
- Defined in packages/pdf-lite/src/security/handlers/base.ts:115

`Abstract`setDocumentId

setDocumentId(id: PdfId): void
Sets the document ID array.
Parameters
- id: PdfId
  The document ID to set.
Returns void
- Defined in packages/pdf-lite/src/security/handlers/base.ts:175

`Abstract`write

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

Returns Promise<void>
- Defined in packages/pdf-lite/src/security/handlers/base.ts:180

Class PdfSecurityHandlerAbstract

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PdfSecurityHandler

Properties

dict

encryptMetadata

permissions

Methods

ProtectedbuildPermissions

Parameters

Returns number

AbstractcomputeObjectKey

Parameters

Returns Promise<ByteArray>

decodePermissions

Returns PdfPermissions

Abstractdecrypt

Parameters

Returns Promise<ByteArray>

decryptObject

Parameters

Returns Promise<void>

Abstractencrypt

Parameters

Returns Promise<ByteArray>

encryptObject

Parameters

Returns Promise<void>

AbstractgetDocumentId

Returns PdfId | undefined

AbstractgetName

Returns string

AbstractgetRevision

Returns number

AbstractgetVersion

Returns number

AbstractisReady

Returns boolean

AbstractreadEncryptionDictionary

Parameters

Returns void

AbstractsetDocumentId

Parameters

Returns void

Abstractwrite

Returns Promise<void>

Settings

On This Page

Class PdfSecurityHandler`Abstract`

`Protected`buildPermissions

`Abstract`computeObjectKey

`Abstract`decrypt

`Abstract`encrypt

`Abstract`getDocumentId

`Abstract`getName

`Abstract`getRevision

`Abstract`getVersion

`Abstract`isReady

`Abstract`readEncryptionDictionary

`Abstract`setDocumentId

`Abstract`write