(Lianja) 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.

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loPkcs11 = createobject("CkPkcs11")

// 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.
loPkcs11.SharedLibPath = "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll"

// Establish a logged-on session.
lcPin = "0000"
lnUserType = 1
llSuccess = loPkcs11.QuickSession(lnUserType,lcPin)
if (llSuccess = .F.) then
    ? loPkcs11.LastErrorText
    release loPkcs11
    return
endif

// 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.
lcKeyType = "AES"

// Specify attributes and abilities (how this key can be used) by providing a JSON template.
loJson = createobject("CkJsonObject")

// The key can be extracted or wrapped.
loJson.UpdateBool("extractable",.T.)

// Allow the key to be used for encryption, decryption, wrapping other keys, and unwrapping other keys.
loJson.UpdateBool("encrypt",.T.)
loJson.UpdateBool("decrypt",.T.)
loJson.UpdateBool("wrap",.T.)
loJson.UpdateBool("unwrap",.T.)

// 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)
loJson.UpdateInt("value_len",32)

lnKeyHandle = loPkcs11.GenSecretKey(lcKeyType,loJson)
if (lnKeyHandle = 0) then
    ? loPkcs11.LastErrorText
    ? "Failed to generate an AES key."
else
    ? "key handle = " + str(lnKeyHandle)
    ? "Success."
endif

loPkcs11.Logout()
loPkcs11.CloseSession()


release loPkcs11
release loJson