Visual FoxPro

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.

Visual FoxPro

LOCAL lnSuccess
LOCAL loPkcs11
LOCAL lcPin
LOCAL lnUserType
LOCAL loSbAesKey
LOCAL loAttrs
LOCAL lnObjHandle

lnSuccess = 0

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

* Establish a logged-on session.
lcPin = "0000"
lnUserType = 1
lnSuccess = loPkcs11.QuickSession(lnUserType,lcPin)
IF (lnSuccess = 0) THEN
    ? loPkcs11.LastErrorText
    RELEASE loPkcs11
    CANCEL
ENDIF

* Generate a 256-bit AES key.
* (32 bytes is 256 bits)
* Append 32 bytes of random data in the base64 encoding.
loSbAesKey = CreateObject('Chilkat.StringBuilder')
loSbAesKey.AppendRandom(32,"base64")

loAttrs = CreateObject('Chilkat.JsonObject')
* Specify the type of object, and the type of key.
loAttrs.UpdateString("class","CKO_SECRET_KEY")
loAttrs.UpdateString("key_type","CKK_AES")
* Add an optional label if desired.
loAttrs.UpdateString("label","My AES wrapping/unwrapping key")
* Allow the key to be use for wrapping and unwrapping operations.
loAttrs.UpdateBool("wrap",1)
loAttrs.UpdateBool("unwrap",1)

* Provide the AES key material.
loAttrs.UpdateString("value",loSbAesKey.GetAsString())

* 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.
lnObjHandle = loPkcs11.CreatePkcs11Object(loAttrs)
IF (lnObjHandle = 0) THEN
    ? loPkcs11.LastErrorText
    ? "Failed."
ELSE
    ? "PKCS11 object handle = " + STR(lnObjHandle)
    ? "Successfully created a 256-bit AES session key."
ENDIF

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

loPkcs11.Logout()
loPkcs11.CloseSession()

RELEASE loPkcs11
RELEASE loSbAesKey
RELEASE loAttrs