kitepdf-pdf/io.github.yuroyami.kitepdf.crypto/StandardSecurityHandler

StandardSecurityHandler

class StandardSecurityHandler(encryptDict: PdfDictionary, fileIdFirst: ByteArray, userPassword: ByteArray = byteArrayOf(), ownerPassword: ByteArray = byteArrayOf())

PDF Standard Security Handler (ISO 32000-1 §7.6.4).

Implements key derivation and per-object decryption for security handlers V1, V2, V4 (RC4 / AES-128), and V5 (AES-256). V6 (PDF 2.0) shares V5's mechanism but with a slightly different password-validation algorithm; we accept both since most readers in the wild treat them interchangeably.

Construction tries the supplied password, then the empty password as fallback. isAuthenticated reports whether one of them worked; if not, decryption returns the original bytes (so the document can still be opened read-only for its public metadata).

Constructors

StandardSecurityHandler

constructor(encryptDict: PdfDictionary, fileIdFirst: ByteArray, userPassword: ByteArray = byteArrayOf(), ownerPassword: ByteArray = byteArrayOf())

Types

Companion

object Companion

Properties

encryptMetadata

val encryptMetadata: Boolean

Whether the /Metadata stream is encrypted. When false (V4+ with /EncryptMetadata false), the metadata stream is left as clear text and Decryptor must skip it. Exposed for that reason.

isAuthenticated

val isAuthenticated: Boolean

val p: Int

Raw /P bit-flags. Negative because the high bit is set on permissive PDFs.

val r: Int

Revision number, exposed so the public permissions API can pick the right bit semantics.

supportsWrite

val supportsWrite: Boolean

Whether Encryptor can produce new objects matching this handler's parameters: the document must be authenticated and use AES (V4 /AESV2 or V5/V6). Legacy RC4 documents are read-only.

Functions

decryptStream

fun decryptStream(objNum: Long, genNum: Int, ciphertext: ByteArray): ByteArray

Decrypt a stream's raw bytes (call BEFORE running the filter chain).

decryptString

fun decryptString(objNum: Long, genNum: Int, ciphertext: ByteArray): ByteArray

Decrypt a literal-string's bytes (replaces PdfString.bytes in place).