LTV Signature

1
/*
2
 *   Copyright © 2020-2026 PSPDFKit GmbH. All rights reserved.
3
 *
4
 *   The PSPDFKit Sample applications are licensed with a modified BSD license.
5
 *   Please see License for details. This notice may not be removed from this file.
6
 */
7

8
package com.pspdfkit.catalog.examples.kotlin
9

10
import android.content.Context
11
import android.net.Uri
12
import android.widget.Toast
13
import com.pspdfkit.catalog.R
14
import com.pspdfkit.catalog.SdkExample
15
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
16
import com.pspdfkit.document.DocumentSource
17
import com.pspdfkit.document.PdfDocumentLoader
18
import com.pspdfkit.document.providers.AssetDataProvider
19
import com.pspdfkit.signatures.SignerOptions
20
import com.pspdfkit.signatures.SigningManager
21
import com.pspdfkit.signatures.getPrivateKeyFromFile
22
import com.pspdfkit.signatures.loadCertificateFromStream
23
import com.pspdfkit.ui.PdfActivityIntentBuilder
24
import com.pspdfkit.utils.PdfLog
25
import java.io.File
26
import java.security.PrivateKey
27
import java.security.cert.X509Certificate
28

29
/**
30
 * An example that shows how to digitally sign a PDF document using [SigningManager].
31
 * This is a Simple implementation where user provides Private key in [SignerOptions].
32
 */
33
class LongTermValidationExample(context: Context) :
34
    SdkExample(context, R.string.digitalSignatureLtvExampleTitle, R.string.digitalSignatureLtvExampleDescription) {
35
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
36
        val assetName = "Form_example.pdf"
37

38
        val unsignedDocument = PdfDocumentLoader.openDocument(context, DocumentSource(AssetDataProvider(assetName)))
39
        val privateKey = getPrivateKey(context)
40
        val certificates = getCertificates(context)
41
        val signatureFormFields = unsignedDocument.documentSignatureInfo.signatureFormFields
42
        val outputFile = File(context.filesDir, "signedDocument.pdf")
43
        outputFile.delete() // make sure output is deleted from previous runs.
44
        val signerOptions =
45
            SignerOptions
46
                .Builder(signatureFormFields[0], Uri.fromFile(outputFile))
47
                .setPrivateKey(privateKey)
48
                .setCertificates(certificates)
49
                // LTV is enabled by default, but you can disable it here if you don't need or experience issues with it.
50
                .setEnableLtv(true)
51
                .setType(digitalSignatureType)
52
                .build()
53

54
        // [SignerOptions] contains all the required configuration for [SigningManager]
55
        SigningManager.signDocument(
56
            context = context,
57
            signerOptions = signerOptions,
58
            onFailure = { e ->
59
                Toast.makeText(context, "Error launching example. See logcat for details.", Toast.LENGTH_SHORT).show()
60
                PdfLog.e("AdvancedLtvExample", e, "Error while launching example.")
61
            },
62
        ) {
63
            val signedDocument = Uri.fromFile(outputFile)
64
            // Load and show the signed document.
65
            val intent =
66
                PdfActivityIntentBuilder
67
                    .fromUri(context, signedDocument)
68
                    .configuration(configuration.build())
69
                    .build()
70
            context.startActivity(intent)
71
        }
72
    }
73

74
    /**
75
     * Loads the full chain of [X509Certificate]s used for signing; from the signer's certificate, to the issuing authority certificate
76
     * that will be used by our [SigningManager].
77
     * In this example, we are using 3 certificates (signer, issuer, and root).
78
     */
79
    private fun getCertificates(context: Context): List<X509Certificate> = listOf(
80
        loadCertificateFromStream(context.assets.open("digital-signatures/ltv/Signer.cert")),
81
        loadCertificateFromStream(context.assets.open("digital-signatures/ltv/Issuer.cert")),
82
        loadCertificateFromStream(context.assets.open("digital-signatures/ltv/Root.cert")),
83
    )
84

85
    /**
86
     * Loads the [PrivateKey] that will be used by our [SigningManager].
87
     */
88
    private fun getPrivateKey(context: Context): PrivateKey =
89
        getPrivateKeyFromFile(context.assets.open("digital-signatures/ltv/Signer.key"))
90
}