Sample code for 30+ languages & platforms
Unicode C

PKCS11 Find Private Key by Label

See more PKCS11 Examples

Demonstrates how to find a private key based on a user-specified label.

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

Chilkat Unicode C Downloads

Unicode C
#include <C_CkPkcs11W.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkPkcs11W pkcs11;
    const wchar_t *pin;
    int userType;
    HCkJsonObjectW jsonTemplate;
    unsigned long privKeyHandle;

    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.

    pkcs11 = CkPkcs11W_Create();

    // Use the PKCS11 driver (.dll, .so, .dylib) for your particular HSM.
    // For example:
    CkPkcs11W_putSharedLibPath(pkcs11,L"C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS11.dll");

    // Use your HSM's PIN.
    pin = L"0000";

    // Normal user = 1
    userType = 1;

    // Establish a logged-on user session with the HSM.
    success = CkPkcs11W_QuickSession(pkcs11,userType,pin);
    if (success == FALSE) {
        wprintf(L"%s\n",CkPkcs11W_lastErrorText(pkcs11));
        CkPkcs11W_Dispose(pkcs11);
        return;
    }

    // Provide a template to find a PKCS11 object.
    jsonTemplate = CkJsonObjectW_Create();

    // Find an RSA private key with the label "MySshKey".
    // Here's an example of how the key was originally imported: 
    // PKCS11 Import SSH Key
    CkJsonObjectW_UpdateString(jsonTemplate,L"class",L"private_key");
    CkJsonObjectW_UpdateString(jsonTemplate,L"key_type",L"rsa");
    CkJsonObjectW_UpdateString(jsonTemplate,L"label",L"MySshKey");

    privKeyHandle = CkPkcs11W_FindObject(pkcs11,jsonTemplate);
    if (privKeyHandle == 0) {
        wprintf(L"%s\n",CkPkcs11W_lastErrorText(pkcs11));
        CkPkcs11W_Dispose(pkcs11);
        CkJsonObjectW_Dispose(jsonTemplate);
        return;
    }

    // The private key handle is only valid during the PKCS11 session.
    // If you wish to use the private key in another PKCS11 session,
    // you'll first need to find it.  See:  
    wprintf(L"private key handle: %u\n",privKeyHandle);

    // Do whatever you wish with the private key handle...
    // ...
    // ...

    CkPkcs11W_Logout(pkcs11);
    CkPkcs11W_CloseSession(pkcs11);


    CkPkcs11W_Dispose(pkcs11);
    CkJsonObjectW_Dispose(jsonTemplate);

    }