Java

(PKCS11) Use a Smart Card Certificate + Private Key for SSL/TLS Authentication

See more ScMinidriver Examples

Demonstrates how to use a certificate + private key located on a smart card for the TLS client certificate in an HTTPS request. Chilkat2 Java

import com.chilkatsoft.chilkat2.Cert;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
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();

        // Set your shared lib path -- either a full path to the DLL, .so, or .dylib,
        // or just the filename if the driver is in a location that can be automatically found. (Such as in C:\Windows\System32)
        pkcs11.setSharedLibPath("C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.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.
        //
        // If we don't authenticate, then we won't be able to see the private keys, and thus
        // we won't know which certificates have an associated private key stored on the smart card.

        // The smart card PIN is passed to the Login method.
        // userType 1 indicates a "Normal User".
        int userType = 1;
        String pin = "0000";
        try {
            pkcs11.login(userType, pin);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            pkcs11.closeSession();
            return;
        }

        Cert cert = new Cert();

        // Find a certificate by the Subject Common Name
        try {
            pkcs11.findCert("subjectCN", "BadSSL Client Certificate", cert);
            System.out.println("Found: " + cert.getSubjectCN());
        } catch (ChilkatException e) {
            System.out.println("Not found: " + cert.getSubjectCN());
            pkcs11.closeSession();
            return;
        }

        System.out.println("Successfully loaded the cert object from the smart card / USB token.");

        // Note: When successful, the cert object is internally linked to the Pkcs11 object's authenticated session.
        // The cert object can now be used to sign or do other cryptographic operations that occur on the smart card / USB token.

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

        // Send an HTTPS request to https://client.badssl.com
        // https://client.badssl.com (part of the badssl.com service) lets you test authentication using client SSL certificates.
        // The client certificate can be downloaded from https://badssl.com/download/.
        // This server returns 200 OK if the correct client certificate is provided, and 400 Bad Request otherwise.

        Http http = new Http();

        // Provide the client certificate (linked internally to our authenticated smartcard session)
        String responseBody;
        try {
            http.setSslClientCert(cert);

            responseBody = http.quickGetStr("https://client.badssl.com/");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            pkcs11.closeSession();
            return;
        }

        System.out.println("Response status code: " + http.getLastStatus());
        System.out.println("Response body: ");
        System.out.println(responseBody);

        // ------------------------------------------------------------------------------------------------------------
        // Revert to an unauthenticated session by calling Logout.
        try {
            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.");
    }
}