Add digital signature to PDF in Kotlin for Android

1
/*
2
 *   Copyright © 2020-2025 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.getPrivateKeyEntryFromP12Stream
22
import com.pspdfkit.ui.PdfActivityIntentBuilder
23
import com.pspdfkit.utils.PdfLog
24
import java.io.File
25
import java.io.IOException
26
import java.security.GeneralSecurityException
27
import java.security.KeyStore
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 DigitalSignatureExample(context: Context) : SdkExample(context, R.string.digitalSignatureExampleTitle, R.string.digitalSignatureExampleDescription) {
34

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 keyEntryWithCertificates = getPrivateKeyEntry(context)
40
        val signatureFormFields = unsignedDocument.documentSignatureInfo.signatureFormFields
41
        val outputFile = File(context.filesDir, "signedDocument.pdf")
42
        outputFile.delete() // make sure output is deleted from previous runs.
43
        val signerOptions = SignerOptions.Builder(signatureFormFields[0], Uri.fromFile(outputFile))
44
            .setPrivateKey(keyEntryWithCertificates)
45
            .setType(digitalSignatureType)
46
            .build()
47

48
        /** [SignerOptions] contains all the required configuration for [SigningManager]*/
49
        SigningManager.signDocument(
50
            context = context,
51
            signerOptions = signerOptions,
52
            onFailure = { e ->
53
                Toast.makeText(context, "Error launching example. See logcat for details.", Toast.LENGTH_SHORT).show()
54
                PdfLog.e("DigitalSignatureExample", e, "Error while launching example.")
55
            }
56
        ) {
57
            val signedDocument = Uri.fromFile(outputFile)
58
            // Load and show the signed document.
59
            val intent = PdfActivityIntentBuilder.fromUri(context, signedDocument)
60
                .configuration(configuration.build())
61
                .build()
62
            context.startActivity(intent)
63
        }
64
    }
65

66
    /**
67
     * Loads the [KeyStore.PrivateKeyEntry] that will be used by our [SigningManager].
68
     */
69
    @Throws(IOException::class, GeneralSecurityException::class)
70
    private fun getPrivateKeyEntry(context: Context): KeyStore.PrivateKeyEntry {
71
        // Inside a p12 we have both the certificate (or certificate chain to the root CA) and private key used for signing.
72
        val keystoreFile = context.assets.open("digital-signatures/ExampleSigner.p12")
73
        return getPrivateKeyEntryFromP12Stream(keystoreFile, "test")
74
    }
75
}