Class PdfStandardSecurityHandler`Abstract`

Abstract base class for standard PDF security handlers. Implements password-based encryption as defined in the PDF specification.

Example

const handler = new PdfV5SecurityHandler({
    password: 'user123',
    ownerPassword: 'admin456',
    permissions: { print: true, copy: false }
})

Hierarchy (View Summary)

PdfSecurityHandler
- PdfStandardSecurityHandler
  - PdfV1SecurityHandler

Constructors

constructor

new PdfStandardSecurityHandler(
options: PdfStandardSecurityHandlerOptions,
): PdfStandardSecurityHandler
Creates a new standard security handler.
Parameters
- options: PdfStandardSecurityHandlerOptions
  Configuration options including passwords and document ID.
Returns PdfStandardSecurityHandler
Overrides PdfSecurityHandler.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 PdfSecurityHandler.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.
- Defined in packages/pdf-lite/src/security/handlers/base.ts:445

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

`Protected` `Abstract`computeOwnerKey

computeOwnerKey(): Promise<ByteArray>
Computes the owner key (O value) for the encryption dictionary.

Returns Promise<ByteArray>
The computed owner key.
- Defined in packages/pdf-lite/src/security/handlers/base.ts:505

`Protected` `Abstract`computeUserKey

computeUserKey(): Promise<ByteArray>
Computes the user key (U value) for the encryption dictionary.

Returns Promise<ByteArray>
The computed user key.
- Defined in packages/pdf-lite/src/security/handlers/base.ts:498

decodePermissions

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

Returns PdfPermissions
An object with boolean flags for each permission.
Inherited from PdfSecurityHandler.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.
Overrides PdfSecurityHandler.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 PdfSecurityHandler.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.
Overrides PdfSecurityHandler.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 PdfSecurityHandler.encryptObject
- Defined in packages/pdf-lite/src/security/handlers/base.ts:252

`Protected` `Abstract`getCipher

getCipher(
objectNumber?: number,
generationNumber?: number,
): Promise<Cipher | null>
Gets a cipher for the specified object.
Parameters
- OptionalobjectNumber: number
  The PDF object number.
- OptionalgenerationNumber: number
  The PDF generation number.
Returns Promise<Cipher | null>
A cipher instance, or null if no encryption needed.
- Defined in packages/pdf-lite/src/security/handlers/base.ts:553

getDocumentId

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

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

`Abstract`getKeyBits

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

Returns number
The key length in bits.
- Defined in packages/pdf-lite/src/security/handlers/base.ts:380

getName

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

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

`Abstract`getRevision

getRevision(): number
Gets the encryption revision number.

Returns number
The revision number.
Inherited from PdfSecurityHandler.getRevision
- 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).
Inherited from PdfSecurityHandler.getVersion
- Defined in packages/pdf-lite/src/security/handlers/base.ts:101

`Protected`initKeys

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

Returns Promise<void>
- 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.
Overrides PdfSecurityHandler.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
Overrides PdfSecurityHandler.readEncryptionDictionary
- Defined in packages/pdf-lite/src/security/handlers/base.ts:454

`Abstract`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.

Throws
Error if recovery is not supported.
- Defined in packages/pdf-lite/src/security/handlers/base.ts:622

setDocumentId

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

Class PdfStandardSecurityHandlerAbstract

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PdfStandardSecurityHandler

Properties

dict

Protected OptionaldocumentId

encryptMetadata

Protected OptionalmasterKey

Protected OptionalownerKey

Protected OptionalownerPassword

Protectedpassword

permissions

Protected OptionaluserKey

Methods

ProtectedbuildPermissions

Parameters

Returns number

canEncryptMetadata

Returns boolean

AbstractcomputeObjectKey

Parameters

Returns Promise<ByteArray>

Protected AbstractcomputeOwnerKey

Returns Promise<ByteArray>

Protected AbstractcomputeUserKey

Returns Promise<ByteArray>

decodePermissions

Returns PdfPermissions

decrypt

Parameters

Returns Promise<ByteArray>

decryptObject

Parameters

Returns Promise<void>

encrypt

Parameters

Returns Promise<ByteArray>

encryptObject

Parameters

Returns Promise<void>

Protected AbstractgetCipher

Parameters

Returns Promise<Cipher | null>

getDocumentId

Returns PdfId | undefined

AbstractgetKeyBits

Returns number

getName

Returns string

AbstractgetRevision

Returns number

AbstractgetVersion

Returns number

ProtectedinitKeys

Returns Promise<void>

isReady

Returns boolean

readEncryptionDictionary

Parameters

Returns void

AbstractrecoverUserPassword

Parameters

Returns Promise<string>

Throws

setDocumentId

Parameters

Returns void

setMasterKey

Parameters

Returns void

setOwnerPassword

Parameters

Class PdfStandardSecurityHandler`Abstract`

`Protected` `Optional`documentId

`Protected` `Optional`masterKey

`Protected` `Optional`ownerKey

`Protected` `Optional`ownerPassword

`Protected`password

`Protected` `Optional`userKey

`Protected`buildPermissions

`Abstract`computeObjectKey

`Protected` `Abstract`computeOwnerKey

`Protected` `Abstract`computeUserKey

`Protected` `Abstract`getCipher

`Abstract`getKeyBits

`Abstract`getRevision

`Abstract`getVersion

`Protected`initKeys

`Abstract`recoverUserPassword