kitepdf-pdf/io.github.yuroyami.kitepdf/PdfSignature

PdfSignature

A digital signature in a signature field (ISO 32000-1, 12.8): what its signature dictionary says, and validate to check it. PdfDocument.signatures lists the signatures of a document.

Properties

byteRange

val byteRange: List<Long>

The signed bytes of the file (/ByteRange): an offset and a length for each part. The gap between the parts holds the signature itself.

certificationLevel

val certificationLevel: Int?

The permission level when this is a certification signature (/DocMDP, ISO 32000-1, 12.8.2.2): 1 allows no change, 2 allows filling in forms and signing, and 3 also allows annotations. Null for an approval signature.

contactInfo

val contactInfo: String?

How to reach the signer (/ContactInfo), or null.

field

val field: PdfFormField

The signature field that holds this signature.

isDocumentTimestamp

val isDocumentTimestamp: Boolean

True for a document timestamp (/Type /DocTimeStamp, ISO 32000-2, 12.8.5). A timestamp authority signs it to prove that the document existed at a time. It names no person.

location

val location: String?

Where the document was signed (/Location), or null.

name

val name: String?

The signer's name as the signing application wrote it (/Name). PdfSignatureValidation.signer is the checked name.

reason

val reason: String?

Why the document was signed (/Reason), or null.

signingTime

val signingTime: PdfDate?

When the document was signed, as the signing application wrote it (/M). Nothing checks this time.

subFilter

val subFilter: String?

The encoding of the signature (/SubFilter), such as adbe.pkcs7.detached or ETSI.CAdES.detached.

Functions

toString

open override fun toString(): String

validate

fun validate(trustAnchors: List<ByteArray> = emptyList(), revocationData: List<ByteArray> = emptyList()): PdfSignatureValidation

Checks the signature against the file. trustAnchors are the DER encodings of the certificates the caller trusts. An entry that is not a certificate is ignored. The check hashes the signed bytes, which are almost the whole file, so run it off the main thread.