pspdfkit/com.pspdfkit.signatures

Package-level declarations

Digital signatures.

Types

data class BiometricSignatureData(val pressurePoints: List<Float>? = null, val timePoints: List<Long>? = null, val touchRadius: Float? = null, val inputMethod: BiometricSignatureData.InputMethod? = null) : Parcelable

Biometric data of a Signature. Biometric data contains timing, pressure sensitivity, and general input information that was collected while writing the signature. The biometric data can be written to a PDF document while digitally signing using DigitalSignatureMetadata and SigningManager.

DigitalSignatureInfo

open class DigitalSignatureInfo

A digital signature stored inside a PDF document.

DigitalSignatureMetadata

data class DigitalSignatureMetadata(val signatureAppearance: SignatureAppearance? = null, val estimatedSize: Int? = null, val hashAlgorithm: HashAlgorithm? = null, val reason: String? = null, val location: String? = null, val timestampData: TimestampData? = null, val biometricData: BiometricSignatureData? = null) : Parcelable

DigitalSignatureMetadata contains all metadata like appearance config, algorithm and other configuration needed for signing data

DigitalSignatureType

enum DigitalSignatureType : Enum<DigitalSignatureType>

Enum defining the type of digital signatures.

DigitalSignatureValidationResult

class DigitalSignatureValidationResult : Parcelable

Detailed status about validity of a DigitalSignatureInfo.

DigitalSignatureValidator

object DigitalSignatureValidator

Validates digital signatures. Use .validateSignature passing it a signature info.

DocumentSignatureInfo

interface DocumentSignatureInfo

Contains information about signatures of a document.

HashAlgorithm

enum HashAlgorithm

Hash algorithm for digesting PDF data as part of a digital signing process.

PublicKey

class PublicKey(val publicKeyScheme: String, val keyLength: Int)

Holds info regarding Public Key

Signature

data class Signature(val annotationType: AnnotationType = AnnotationType.INK, val id: Long = ID_NOT_SET, val inkColor: Int = 0, val lineWidth: Float = 0.0f, val lines: List<List<PointF>> = emptyList(), val biometricData: BiometricSignatureData? = null, val signatureDrawWidthRatio: Float = 1.0f, val bitmapIdentifier: Int = BITMAP_NOT_SET, val stampRect: RectF? = null) : Parcelable

Represents a single signature (or signature item). To create an InkAnnotation or StampAnnotation from this signature use the toInkAnnotation and toStampAnnotation methods. You can check the signature annotation type through annotationType.

SignatureAppearance

data class SignatureAppearance(val signatureAppearanceMode: SignatureAppearance.SignatureAppearanceMode = SignatureAppearanceMode.SIGNATURE_AND_DESCRIPTION, val showSignerName: Boolean = true, val showSignDate: Boolean = true, val showSignatureReason: Boolean = false, val showSignatureLocation: Boolean = false, val signatureGraphic: SignatureGraphic? = null, val signatureWatermark: SignatureGraphic? = null, val reuseExistingSignatureAppearanceStream: Boolean = true, val showWatermark: Boolean = true, val showDateTimezone: Boolean = true) : Parcelable

Configures the appearance of digital signatures that are added to the document.

SignatureBitmapStorage

class SignatureBitmapStorage

In memory signature bitmap storage that fetches all the available signature bitmaps from the DatabaseSignatureStorage and loads them into signatureBitmapHashMap.

SignatureGraphic

class SignatureGraphic : Parcelable

Contains the graphic that will be used as the signature.

SignerOptions

class SignerOptions

Contains all the data needed to perform a signing operation.

SigningManager

object SigningManager

SigningManager provides a public API to digitally sign documents with either PAdES advanced digital signatures or basic CMS signatures (see DigitalSignatureType)

TrustedKeyStore

object TrustedKeyStore

Singleton object that holds the list of trusted certificates used for digital signature validation and signing. By default we load the trusted certificates from the OS as well as Adobe CA certificates from the assets. Add additional root/trusted certificates to this object if you want to use them for signing or validation.

ValidationStatus

enum ValidationStatus

Represents overall validation status.

X509CertificateData

class X509CertificateData(val publicKey: PublicKey?, val issuerCn: String?, val issuerDn: String?, val subjectCn: String?, val subjectDn: String?, val serialNumber: String?, val isSelfSigned: Boolean? = false, val isCaCertificate: Boolean? = false, val validFrom: Date?, val validUntil: Date?)

Provides metadata of signing certificate

Functions

getPrivateKeyEntryFromP12Stream

fun getPrivateKeyEntryFromP12Stream(inputStream: InputStream, password: String? = null, alias: String? = null, keyPassword: String? = null): KeyStore.PrivateKeyEntry

Convenience method to load a certificate/private key pair from a PKCS#12 file (usually with .p12 extension).

getPrivateKeyFromPemFile

fun getPrivateKeyFromPemFile(inputStream: InputStream): PrivateKey

Takes an input stream containing a PEM encoded private key and returns a PrivateKey instance.

getX509Certificates

fun KeyStore.PrivateKeyEntry.getX509Certificates(): List<X509Certificate>

getX509Certificates fetches the certificateChain and if its null it fetches certificate from the KeyStore.PrivateKeyEntry checks if they are X509Certificate and returns all in a list

loadCertificateFromFile

fun loadCertificateFromFile(file: File): X509Certificate

Convenience method to load a X.509 certificate from a File.

loadCertificateFromStream

fun loadCertificateFromStream(inputStream: InputStream): X509Certificate

Convenience method to load a X.509 certificate from an InputStream.