Class PdfPublicKeySecurityHandler

Public key security handler implementing certificate-based encryption. Uses PKCS#7 enveloped data to encrypt the file key for each recipient.

Example

const handler = new PdfPublicKeySecurityHandler({
    recipients: [{
        certificate: recipientCertBytes,
        privateKey: privateKeyBytes
    }]
})

Hierarchy (View Summary)

PdfSecurityHandler
- PdfPublicKeySecurityHandler

Constructors

constructor

new PdfPublicKeySecurityHandler(
    options: {
        encryptMetadata?: boolean;
        permissions?: number | PdfPermissions;
        recipients: PdfEncryptionRecipient[];
        seed?: ByteArray;
        standardSecurityHandler?: PdfStandardSecurityHandler;
    },
): PdfPublicKeySecurityHandler
Creates a new public key security handler.
Parameters
- options: {
      encryptMetadata?: boolean;
      permissions?: number | PdfPermissions;
      recipients: PdfEncryptionRecipient[];
      seed?: ByteArray;
      standardSecurityHandler?: PdfStandardSecurityHandler;
  }
  Configuration including recipients and encryption settings.
Returns PdfPublicKeySecurityHandler
Overrides PdfSecurityHandler.constructor
- Defined in packages/pdf-lite/src/security/handlers/pubSec.ts:48

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.
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/pubSec.ts:86

computeObjectKey

computeObjectKey(
objectNumber?: number,
generationNumber?: number,
): Promise<ByteArray>
Computes the object encryption key.
Parameters
- OptionalobjectNumber: number
  The PDF object number.
- OptionalgenerationNumber: number
  The PDF generation number.
Returns Promise<ByteArray>
The computed object key.
Overrides PdfSecurityHandler.computeObjectKey
- Defined in packages/pdf-lite/src/security/handlers/pubSec.ts:352

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 underlying security handler.
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/pubSec.ts:304

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 underlying security handler.
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/pubSec.ts:329

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

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/pubSec.ts:104

getName

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

Returns string
'Adobe.PubSec' for public key encryption.
Overrides PdfSecurityHandler.getName
- Defined in packages/pdf-lite/src/security/handlers/pubSec.ts:77

getRevision

getRevision(): number
Gets the encryption revision number.

Returns number
The revision from the underlying handler.
Overrides PdfSecurityHandler.getRevision
- Defined in packages/pdf-lite/src/security/handlers/pubSec.ts:131

getStandardSecurityHandler

getStandardSecurityHandler(): PdfStandardSecurityHandler
Gets the underlying standard security handler.

Returns PdfStandardSecurityHandler
The standard security handler used for encryption.
- Defined in packages/pdf-lite/src/security/handlers/pubSec.ts:256

getVersion

getVersion(): number
Gets the encryption version number.

Returns number
The version from the underlying handler.
Overrides PdfSecurityHandler.getVersion
- Defined in packages/pdf-lite/src/security/handlers/pubSec.ts:122

isReady

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

Returns boolean
True if the underlying handler is ready.
Overrides PdfSecurityHandler.isReady
- Defined in packages/pdf-lite/src/security/handlers/pubSec.ts:113

readEncryptionDictionary

readEncryptionDictionary(dictionary: PdfEncryptionDictionary): void
Reads encryption parameters from the encryption dictionary.
Parameters
- dictionary: PdfEncryptionDictionary
  The encryption dictionary from the PDF.
Returns void
Throws
Error if required entries are missing.
Overrides PdfSecurityHandler.readEncryptionDictionary
- Defined in packages/pdf-lite/src/security/handlers/pubSec.ts:230

setDocumentId

setDocumentId(id: PdfId): void
Sets the document ID.
Parameters
- id: PdfId
  The document ID array.
Returns void
Overrides PdfSecurityHandler.setDocumentId
- Defined in packages/pdf-lite/src/security/handlers/pubSec.ts:95

write

write(): Promise<void>
Writes the encryption dictionary with public key-specific entries.

Returns Promise<void>
Overrides PdfSecurityHandler.write
- Defined in packages/pdf-lite/src/security/handlers/pubSec.ts:185

Class PdfPublicKeySecurityHandler

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PdfPublicKeySecurityHandler

Properties

dict

encryptMetadata

permissions

Methods

ProtectedbuildPermissions

Parameters

Returns number

canEncryptMetadata

Returns boolean

computeObjectKey

Parameters

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>

getDocumentId

Returns PdfId | undefined

getName

Returns string

getRevision

Returns number

getStandardSecurityHandler

Returns PdfStandardSecurityHandler

getVersion

Returns number

isReady

Returns boolean

readEncryptionDictionary

Parameters

Returns void

Throws

setDocumentId

Parameters

Returns void

write

Returns Promise<void>

Settings

On This Page

`Protected`buildPermissions