Xojo Plugin

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.

Xojo Plugin

Dim success As Boolean
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.

Dim pkcs11 As New Chilkat.Pkcs11

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

// Establish a logged-on session.
Dim pin As String
pin = "0000"
Dim userType As Int32
userType = 1
success = pkcs11.QuickSession(userType,pin)
If (success = False) Then
    System.DebugLog(pkcs11.LastErrorText)
    Return
End If

// 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.
Dim keyType As String
keyType = "AES"

// Specify attributes and abilities (how this key can be used) by providing a JSON template.
Dim json As New Chilkat.JsonObject

// The key can be extracted or wrapped.
success = json.UpdateBool("extractable",True)

// Allow the key to be used for encryption, decryption, wrapping other keys, and unwrapping other keys.
success = json.UpdateBool("encrypt",True)
success = json.UpdateBool("decrypt",True)
success = json.UpdateBool("wrap",True)
success = json.UpdateBool("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)
success = json.UpdateInt("value_len",32)

Dim keyHandle As UInt32
keyHandle = pkcs11.GenSecretKey(keyType,json)
If (keyHandle = 0) Then
    System.DebugLog(pkcs11.LastErrorText)
    System.DebugLog("Failed to generate an AES key.")
Else
    System.DebugLog("key handle = " + Str(keyHandle))
    System.DebugLog("Success.")
End If

success = pkcs11.Logout()
success = pkcs11.CloseSession()