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. Java

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

    // 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.

    CkPkcs11 pkcs11 = new CkPkcs11();

    // 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.put_SharedLibPath("C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll");

    success = pkcs11.Initialize();
    if (success == false) {
        System.out.println(pkcs11.lastErrorText());
        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;
    success = pkcs11.OpenSession(slotID,readWrite);
    if (success == false) {
        System.out.println(pkcs11.lastErrorText());
        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";
    success = pkcs11.Login(userType,pin);
    if (success == false) {
        System.out.println(pkcs11.lastErrorText());
        success = pkcs11.CloseSession();
        return;
        }

    CkCert cert = new CkCert();

    // Find a certificate by the Subject Common Name
    success = pkcs11.FindCert("subjectCN","BadSSL Client Certificate",cert);
    if (success == true) {
        System.out.println("Found: " + cert.subjectCN());
        }
    else {
        System.out.println("Not found: " + cert.subjectCN());
        success = 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.

    CkHttp http = new CkHttp();

    // Provide the client certificate (linked internally to our authenticated smartcard session)
    success = http.SetSslClientCert(cert);
    if (success == false) {
        System.out.println(http.lastErrorText());
        success = pkcs11.CloseSession();
        return;
        }

    String responseBody = http.quickGetStr("https://client.badssl.com/");
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        success = pkcs11.CloseSession();
        return;
        }

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

    // ------------------------------------------------------------------------------------------------------------
    // Revert to an unauthenticated session by calling Logout.
    success = pkcs11.Logout();
    if (success == false) {
        System.out.println(pkcs11.lastErrorText());
        success = 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).
    success = pkcs11.CloseSession();
    if (success == false) {
        System.out.println(pkcs11.lastErrorText());
        return;
        }

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