phpdftk API Documentation

PdfEncryptor

in package

• phpdftk

Encrypts PDF objects for the Standard and Adobe.PubSec security handlers.

Table of Contents

Constants

PERM_ACCESSIBILITY  = 512

Extract text for accessibility.

PERM_ALL  = self::PERM_PRINT | self::PERM_MODIFY | self::PERM_COPY | self::PERM_ANNOTATE | self::PERM_FILL_FORMS | self::PERM_ACCESSIBILITY | self::PERM_ASSEMBLE | self::PERM_PRINT_HIGH

All permissions granted.

PERM_ANNOTATE  = 32

Add or modify annotations.

PERM_ASSEMBLE  = 1024

Assemble the document (insert, rotate, delete pages).

PERM_COPY  = 16

Copy/extract text and graphics.

PERM_FILL_FORMS  = 256

Fill in form fields.

PERM_MODIFY  = 8

Modify document contents.

PERM_PRINT  = 4

Print the document.

PERM_PRINT_HIGH  = 2048

High-quality print.

Methods

aes128()  : self

Create an encryptor with AES 128-bit encryption (V=4 R=4, PDF 1.6+).

aes256()  : self

Create an encryptor with AES 256-bit encryption (V=5 R=6, PDF 2.0).

encryptDictionary()  : void

Encrypt all PdfString values within a dictionary.

encryptObject()  : void

Encrypt a PdfObject in-place before serialization.

getEncryptDictionary()  : EncryptDictionary

Get the EncryptDictionary to register in the file.

getFileId()  : string

Get the file ID used for encryption (needed for the trailer /ID).

getMinimumPdfVersion()  : PdfVersion

Return the minimum PDF version for this encryption: RC4 -> 1.4, AES-128 -> 1.6, AES-256 -> 2.0. Used by PdfFileWriter to auto-bump the document version when encryption is registered.

publicKeyAes128()  : self

Create an encryptor with public-key (certificate-based) AES-128 encryption.

publicKeyAes256()  : self

Create an encryptor with public-key (certificate-based) AES-256 encryption.

rc4128()  : self

Create an encryptor with RC4 128-bit encryption (V=2 R=3, PDF 1.4+).

rc440()  : self

Create an encryptor with RC4 40-bit encryption (V=1 R=2, PDF 1.1+).

setEncryptDictObjNum()  : void

Set the object number of the encrypt dictionary so it's excluded from encryption.