(MFC) 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 C/C++ Library Downloads MS Visual C/C++ Libs

See Also: Using MFC CString in Chilkat

#include <CkPkcs11.h>
#include <CkJsonObject.h>
#include <CkCert.h>

void ChilkatSample(void)
    {
    CkString strOut;

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

    pkcs11.put_SharedLibPath("aetpkss1.dll");

    bool success = pkcs11.Initialize();
    if (success == false) {
        strOut.append(pkcs11.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // We need to call Discover to get the slot ID.
    // (A slot is a smart card reader or USB token.)
    bool onlyTokensPresent = true;
    CkJsonObject json;
    success = pkcs11.Discover(onlyTokensPresent,json);
    if (success == false) {
        strOut.append(pkcs11.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Make sure we have at least one slot.
    if (json.SizeOfArray("slot") <= 0) {
        strOut.append("No occuplied slots.");
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Get the ID of the 1st slot
    int slotID = json.IntOf("slot[0].id");

    // Open a session.
    bool readWrite = true;
    success = pkcs11.OpenSession(slotID,readWrite);
    if (success == false) {
        strOut.append(pkcs11.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        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;
    const char *pin = "0000";
    success = pkcs11.Login(userType,pin);
    if (success == false) {
        strOut.append(pkcs11.lastErrorText());
        strOut.append("\r\n");
        success = pkcs11.CloseSession();
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        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;
    // 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) {
        strOut.append("Cert with private key: ");
        strOut.append(cert.subjectCN());
        strOut.append("\r\n");
    }
    else {
        strOut.append("No certificates having a private key were found.");
        strOut.append("\r\n");
    }

    // 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) {
        strOut.append("Found: ");
        strOut.append(cert.subjectCN());
        strOut.append("\r\n");
    }
    else {
        strOut.append("Not found: ");
        strOut.append(cert.subjectCN());
        strOut.append("\r\n");
    }

    // 3) Find a certificate by hex serial number
    success = pkcs11.FindCert("serial","5087bf1feda006af54a02f23a851104948acc26f",cert);
    if (success == true) {
        strOut.append("Found: ");
        strOut.append(cert.serialNumber());
        strOut.append("\r\n");
    }
    else {
        strOut.append("Not found: ");
        strOut.append(cert.serialNumber());
        strOut.append("\r\n");
    }

    // 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) {
        strOut.append("Found: ");
        strOut.append(cert.subjectCN());
        strOut.append("\r\n");
    }
    else {
        strOut.append("Not found: ");
        strOut.append(cert.subjectCN());
        strOut.append("\r\n");
    }

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

    // Revert to an unauthenticated session by calling Logout.
    success = pkcs11.Logout();
    if (success == false) {
        strOut.append(pkcs11.lastErrorText());
        strOut.append("\r\n");
        success = pkcs11.CloseSession();
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        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) {
        strOut.append(pkcs11.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    strOut.append("Success.");
    strOut.append("\r\n");


    SetDlgItemText(IDC_EDIT1,strOut.getUnicode());

    }