nutrient/com.pspdfkit.signatures/DigitalSignatureInfo

DigitalSignatureInfo

open class DigitalSignatureInfo(internalDocument: InternalPdfDocument, documentSourceIndex: Int, signedFormField: NativeFormField)

A digital signature stored inside a PDF document. This can be retrieved by calling SignatureFormField.signatureInfo. As a convenience to check the signing status of a document, you can retrieve the DocumentSignatureInfo by calling com.pspdfkit.document.PdfDocument.getDocumentSignatureInfoAsync.

Parameters

documentSourceIndex

Index of the signed com.pspdfkit.document.DocumentSource of the signed compound document. A signature can only sign a single data source.

Constructors

DigitalSignatureInfo

constructor(internalDocument: InternalPdfDocument, documentSourceIndex: Int, signedFormField: NativeFormField)

Types

BuildData

data class BuildData

Build data dictionary of a software that created the digital signature.

Companion

object Companion

Keys for the BuildData entries returned by buildProperties.

Reference

data class Reference

Signature reference dictionary. This dictionary contains the object digest result, including information about how it was computed.

ReferenceTransformMethod

enum ReferenceTransformMethod : Enum<DigitalSignatureInfo.ReferenceTransformMethod>

List of possible transformation methods of a Reference.

Properties

buildProperties

val buildProperties: Map<String, DigitalSignatureInfo.BuildData>

Map of build properties of this signature. Keys will be one of BUILD_DATA_APP_KEY, BUILD_DATA_FILTER_KEY, BUILD_DATA_PUB_SEC_KEY, BUILD_DATA_SIGQ_KEY.

byteRange

val byteRange: List<Long>?

Range of bytes this signature covers. Signatures cover two parts of a document: the part before the signature and the part after the signature. This will contain four elements: offset_of_part_before_signature, length_of_part_before_signature, offset_of_part_after_signature, length_of_part_after_signature.

contents

val contents: ByteArray?

Actual byte content of this signature in the PDF file, or null if there's actually no signature attached to the signature field.

creationDate

val creationDate: Calendar?

Creation date of this signature in the UTC timezone, or null if none is stored.

document

val document: PdfDocument

The PdfDocument with which this signature info is associated.

filter

val filter: String?

Name of the filter used for signing, can be null.

isSigned

val isSigned: Boolean

Returns if the form field is actually signed. Note that this DOES NOT check if the signature is actually valid. Signature validity must be checked with the validate call.

location

val location: String?

Location for signing if the signer attached it, can be null.

name

val name: String?

Name of the signer of this signature, or null if no name is stored in the signature.

reason

val reason: String?

Reason for signing if the signer attached it, can be null.

references

val references: List<DigitalSignatureInfo.Reference>

List of signature reference dictionaries. These references contain object digest results and information about how they were computed, and can be used to verify the integrity of specific parts of the document. Empty if no references exist.

subFilter

val subFilter: String?

Name of the subfilter used for signing, can be null.

Functions

toString

open override fun toString(): String

Returns a string representation of this digital signature info for debugging purposes.

validate

open suspend fun validate(): DigitalSignatureValidationResult

Checks the actual validity of the signature and returns a DigitalSignatureValidationResult. This check will use certificates from TrustedKeyStore for validating the certificate of this signature and will also check for integrity issues. This function is main-safe: it suspends and runs the validation work on kotlinx.coroutines.Dispatchers.IO internally.