Java

PKCS11 Certificate Chain

See more PKCS11 Examples

Demonstrates how to make CA certs available for the certificate chain to be included when creating a signature (using a PKCS11 compatible smart card / USB token) such as for PDF, XMLDSig, etc.

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

Chilkat2 Java

import com.chilkatsoft.chilkat2.Cert;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Pkcs11;
import com.chilkatsoft.chilkat2.XmlCertVault;

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();

        // You will use the DLL (or shared lib) provided by your smart card vendor, or a DLL compatible with your smart card.
        // On Windows, if the DLL is located in C:\Windows\System32, specify only the filename.
        // Otherwise provide the full path.
        pkcs11.setSharedLibPath("bit4xpki.dll");

        try {
            pkcs11.initialize();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Pass -1 for the slotID to open a session on the first non-empty slot.
        int slotID = -1;

        // Open a session.
        boolean readWrite = true;
        try {
            pkcs11.openSession(slotID, readWrite);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Make it an authenticated session by calling Login.
        int userType = 1;
        // Make sure to use the correct PIN for your smart card..
        String pin = "0000";
        try {
            pkcs11.login(userType, pin);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            pkcs11.closeSession();
            return;
        }

        // Get the certificate (on the smart card) that has a 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;
        }

        // If the certificates in the chain of authentication were contained on the smart card,
        // then Chilkat would already have them (via the FindCert function) and the certs in the chain will be automatically used
        // as needed when signing occurs.

        // If you have CA certs located elsewhere, such as in .cer files, you can make them available to Chilkat in the following way:

        XmlCertVault certVault = new XmlCertVault();
        // Please review the methods available in the XML certificate vault class.  Different methods exist for adding certificates
        // from various sources, such as PEM, PFX, or in-memory sources..
        certVault.addCertFile("someDir/caIntermediateCert.cer");
        // ...
        certVault.addCertFile("someDir/caCert.cer");
        // (Your code should check the return value to make sure it succeeded.)

        try {
            cert.useCertVault(certVault);

            // --------------------------------------------------------------------------
            // At this point, we have the cert (and certs in the chain of authentication) to be used for signing.
            // The code for using the certificate in creating the digital signature, such as for a PDF, XML, etc., go here...

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

            // 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.");
    }
}