Java

Sign a PDF using SmartCard or HSM (Hardware Security Module)

See more PDF Signatures Examples

This example demonstrates how to a sign a PDF using a smartcard or HSM (hardware security module).

Note: This example requires Chilkat v9.5.0.88 or greater.

Chilkat2 Java

import com.chilkatsoft.chilkat2.Cert;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.Pdf;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example requires the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        Pdf pdf = new Pdf();

        // Load a PDF to be signed.
        // The "hello.pdf" is available at https://chilkatsoft.com/hello.pdf
        try {
            pdf.loadFile("qa_data/pdf/hello.pdf");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Options for signing are specified in JSON.
        JsonObject json = new JsonObject();

        // In most cases, the signingCertificateV2 and signingTime attributes are required.
        json.updateInt("signingCertificateV2", 1);
        json.updateInt("signingTime", 1);

        // Put the signature on page 1, top left
        json.updateInt("page", 1);
        json.updateString("appearance.y", "top");
        json.updateString("appearance.x", "left");

        // Use a font scale of 10.0
        json.updateString("appearance.fontScale", "10.0");

        // In this example, the appearance of the digital signature will contain three lines:
        // 1) The signing certificate's common name
        // 2) The current date/time
        // 3) Some arbitrary text.
        // The keyword "cert_cn" is replaced with the Certificate's Subject Common Name.
        // The keyword "current_dt" is replaced with the current date/time.
        // Any number of appearance text lines can be added.
        json.updateString("appearance.text[0]", "Digitally signed by: cert_cn");
        json.updateString("appearance.text[1]", "current_dt");
        json.updateString("appearance.text[2]", "The crazy brown fox jumps over the lazy dog.");

        // Use a certificate on a smartcard or USB token.
        Cert cert = new Cert();

        // Provide the smartcard PIN.
        // Set the smartcard PIN prior to calling LoadFromSmartcard.
        // If the PIN is not explicitly provided here, the Windows OS should
        // display a dialog for the PIN.
        cert.setSmartCardPin("123456");

        // Load the certificate on the smartcard currently in the reader (or on the USB token).
        // Pass an empty string to allow Chilkat to automatically choose the CSP (Cryptographi Service Provider).
        // See Load Certificate on Smartcard for information about explicitly selecting a particular CSP.
        try {
            cert.loadFromSmartcard("");

            // Tell the pdf object to use the certificate for signing.
            pdf.setSigningCert(cert);

            pdf.signPdf(json, "qa_output/hello_signed_hsm.pdf");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("The PDF has been successfully cryptographically signed using an HSM.");
    }
}