(Java) PKCS11 Find Specific Certificate on Smart Card or USB Token

See more PKCS11 Examples

This example code shows how to find a particular certificate on a smart card or USB token.

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

Chilkat Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris Java Libs for Android

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[])
  {
    // 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");

    boolean 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;
        }

    // --------------------------------------------------------------------------
    // The FindCert method can find a particular certificate in a number of different ways.
    // I'll demonstrate some common ways..

    // 1) In many cases you'll be working with a smart card that contains one certificate that is to be used for 
    // signing, and it is the certificate that is associated with the private key also stored on the smart card (or USB token).
    // There may be other certificates on the card, but these are the issuer certificates in the chain of authentication.
    // You're just interested in getting the certificate with the private key.
    // You can do it like this:
    CkCert cert = new CkCert();
    // Pass the keyword "privateKey" in the 1st argument, and an empty string in the 2nd arg.
    // This returns the 1st certificate that has a private key.
    success = pkcs11.FindCert("privateKey","",cert);
    if (success == true) {
        System.out.println("Cert with private key: " + cert.subjectCN());
        }
    else {
        System.out.println("No certificates having a private key were found.");
        }

    // 2) Find a certificate by the Subject Common Name
    success = pkcs11.FindCert("subjectCN","Chil application account (8c9be8e0-5544-4cd0-9062-290fbff353a7)",cert);
    if (success == true) {
        System.out.println("Found: " + cert.subjectCN());
        }
    else {
        System.out.println("Not found: " + cert.subjectCN());
        }

    // 3) Find a certificate by hex serial number
    success = pkcs11.FindCert("serial","5087bf1feda006af54a02f23a851104948acc26f",cert);
    if (success == true) {
        System.out.println("Found: " + cert.serialNumber());
        }
    else {
        System.out.println("Not found: " + cert.serialNumber());
        }

    // 4) Find a certificate by hex serial number and Issuer Common Name
    success = pkcs11.FindCert("serial:issuerCN","5087bf1feda006af54a02f23a851104948acc26f:Ibanity Production Third Party Application CA",cert);
    if (success == true) {
        System.out.println("Found: " + cert.subjectCN());
        }
    else {
        System.out.println("Not found: " + cert.subjectCN());
        }

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

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