Unicode C

PKCS11 Generate Secret Key (such as AES)

See more PKCS11 Examples

Generates a symmetric secret key such as AES on the HSM.

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

Unicode C

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

void ChilkatSample(void)
    {
    BOOL success;
    HCkPkcs11W pkcs11;
    const wchar_t *pin;
    int userType;
    const wchar_t *keyType;
    HCkJsonObjectW json;
    unsigned long keyHandle;

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

    // Let's generate a 256-bit AES key on the token, which will exist for the duration of this session.
    // Symmetric keys, such as AES keys, are typically created (or imported) and used during a single session.

    // Other possible values for keyType are "AES XTS", "Blowfish", "Twofish", "ChaCha20", and others. 
    // In virtually all cases, you'll want to create an AES key.
    keyType = L"AES";

    // Specify attributes and abilities (how this key can be used) by providing a JSON template.
    json = CkJsonObjectW_Create();

    // The key can be extracted or wrapped.
    CkJsonObjectW_UpdateBool(json,L"extractable",TRUE);

    // Allow the key to be used for encryption, decryption, wrapping other keys, and unwrapping other keys.
    CkJsonObjectW_UpdateBool(json,L"encrypt",TRUE);
    CkJsonObjectW_UpdateBool(json,L"decrypt",TRUE);
    CkJsonObjectW_UpdateBool(json,L"wrap",TRUE);
    CkJsonObjectW_UpdateBool(json,L"unwrap",TRUE);

    // Indicate a 256-bit AES key is to be generated by setting the value_len attribute equal to the key size in bytes.
    // (32 bytes * 8 bits/byte = 256 bits)
    CkJsonObjectW_UpdateInt(json,L"value_len",32);

    keyHandle = CkPkcs11W_GenSecretKey(pkcs11,keyType,json);
    if (keyHandle == 0) {
        wprintf(L"%s\n",CkPkcs11W_lastErrorText(pkcs11));
        wprintf(L"Failed to generate an AES key.\n");
    }
    else {
        wprintf(L"key handle = %u\n",keyHandle);
        wprintf(L"Success.\n");
    }

    CkPkcs11W_Logout(pkcs11);
    CkPkcs11W_CloseSession(pkcs11);


    CkPkcs11W_Dispose(pkcs11);
    CkJsonObjectW_Dispose(json);

    }