Unicode C

PKCS11 Import an Existing AES Key onto the HSM

See more PKCS11 Examples

Demonstrates how to import an existing AES symmetric encrytion key onto the smartcard/token. The imported AES key is a session object, and only exists for the duration of the PKCS11 session. (AES keys are typically used for wrapping/unwrapping RSA and EC keys.)

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

Unicode C

#include <C_CkPkcs11W.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkPkcs11W pkcs11;
    const wchar_t *pin;
    int userType;
    HCkStringBuilderW sbAesKey;
    HCkJsonObjectW attrs;
    unsigned long objHandle;

    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.
    // (The format of the path will change with the operating system.  Obviously, "C:/" is not used on non-Windows systems.
    CkPkcs11W_putSharedLibPath(pkcs11,L"C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll");

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

    // Generate a 256-bit AES key.
    // (32 bytes is 256 bits)
    // Append 32 bytes of random data in the base64 encoding.
    sbAesKey = CkStringBuilderW_Create();
    CkStringBuilderW_AppendRandom(sbAesKey,32,L"base64");

    attrs = CkJsonObjectW_Create();
    // Specify the type of object, and the type of key.
    CkJsonObjectW_UpdateString(attrs,L"class",L"CKO_SECRET_KEY");
    CkJsonObjectW_UpdateString(attrs,L"key_type",L"CKK_AES");
    // Add an optional label if desired.
    CkJsonObjectW_UpdateString(attrs,L"label",L"My AES wrapping/unwrapping key");
    // Allow the key to be use for wrapping and unwrapping operations.
    CkJsonObjectW_UpdateBool(attrs,L"wrap",TRUE);
    CkJsonObjectW_UpdateBool(attrs,L"unwrap",TRUE);

    // Provide the AES key material.
    CkJsonObjectW_UpdateString(attrs,L"value",CkStringBuilderW_getAsString(sbAesKey));

    // Create the object (i.e. create the AES key with the given key material.)
    // Returns the PKCS11 object handle of the created AES session key.
    objHandle = CkPkcs11W_CreatePkcs11Object(pkcs11,attrs);
    if (objHandle == 0) {
        wprintf(L"%s\n",CkPkcs11W_lastErrorText(pkcs11));
        wprintf(L"Failed.\n");
    }
    else {
        wprintf(L"PKCS11 object handle = %u\n",objHandle);
        wprintf(L"Successfully created a 256-bit AES session key.\n");
    }

    // Typically, you would do other things in the PKCS11 session that use the handle of AES key we just created.
    // ...
    // ...

    CkPkcs11W_Logout(pkcs11);
    CkPkcs11W_CloseSession(pkcs11);


    CkPkcs11W_Dispose(pkcs11);
    CkStringBuilderW_Dispose(sbAesKey);
    CkJsonObjectW_Dispose(attrs);

    }