Java

PKCS11 Sign PDF using Certificate and Private Key on Smart Card / USB Token

See more PKCS11 Examples

Sample code showing how to use PKCS11 to sign a PDF with a certificate and private key stored on a smart card or USB token.

Note: This example requires Chilkat v9.5.0.96 or later.

Chilkat2 Java

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

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.

        // Note: Chilkat's PKCS11 implementation runs on Windows, Linux, Mac OS X, and other supported operating systems.

        Pkcs11 pkcs11 = new Pkcs11();

        pkcs11.setSharedLibPath("C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll");
        String pin = "0000";
        int userType = 1;

        // Establish a PKCS11 logged-on session using the driver (.so, .dylib, or .dll) as specified in the SharedLibPath above.
        try {
            pkcs11.quickSession(userType, pin);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Get the certificate (on the smart card) that has a private key.
        // There are other ways to locate a certificate on the HSM.
        // This example assumes there is a single certificate w/ private key.
        Cert cert = new Cert();
        try {
            pkcs11.findCert("privateKey", "", cert);
            System.out.println("Cert with private key: " + cert.getSubjectCN());
        } catch (ChilkatException e) {
            System.out.println("No certificates having a private key were found.");
            pkcs11.closeSession();
            return;
        }

        // --------------------------------------------------------------------------
        // At this point, we have the cert to be used for signing.
        // Our PDF signing code is the same as for a cert obtained from any other source..

        Pdf pdf = new Pdf();

        // Load a PDF to be signed.
        try {
            pdf.loadFile("qa_data/pdf/hello.pdf");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            pkcs11.closeSession();
            return;
        }

        JsonObject json = new JsonObject();

        json.updateInt("page", 1);
        json.updateString("appearance.y", "top");
        json.updateString("appearance.x", "left");
        json.updateString("appearance.fontScale", "10.0");
        json.updateString("signingAlgorithm", "pss");
        json.updateString("hashAlgorithm", "sha256");

        int i = 0;
        json.setI(i);
        json.updateString("appearance.text[i]", "Digitaly signed by: Xyz Widgets, Inc.");
        i = i + 1;
        json.setI(i);
        json.updateString("appearance.text[i]", "current_dt");
        i = i + 1;
        json.setI(i);
        json.updateString("appearance.text[i]", "blah blah blah");

        // The certificate is internally linked to the Pkcs11 object, which is currently in an authenticated session.
        pdf.setSigningCert(cert);

        try {
            pdf.signPdf(json, "qa_output/out.pdf");

            // --------------------------------------------------------------------------

            // Revert to an unauthenticated session by calling Logout.
            pkcs11.logout();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            pkcs11.closeSession();
            return;
        }

        // When finished, close the session.
        // It is important to close the session (memory leaks will occur if the session is not properly closed).
        try {
            pkcs11.closeSession();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("Success.");
    }
}