Xbase++

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.

Xbase++

LOCAL nSuccess
LOCAL oPkcs11
LOCAL cPin
LOCAL nUserType
LOCAL oSbAesKey
LOCAL oAttrs
LOCAL nObjHandle

nSuccess := 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.

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

//  Establish a logged-on session.
cPin := "0000"
nUserType := 1
nSuccess := oPkcs11:QuickSession(nUserType, cPin)
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    oPkcs11:destroy()
    RETURN
ENDIF

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

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

//  Provide the AES key material.
oAttrs:UpdateString("value", oSbAesKey: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.
nObjHandle := oPkcs11:CreatePkcs11Object(oAttrs)
IF (nObjHandle == 0)
    ? oPkcs11:LastErrorText
    ? "Failed."
ELSE
    ? "PKCS11 object handle = " + Str(nObjHandle)
    ? "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.
//  ...
//  ...

oPkcs11:Logout()
oPkcs11:CloseSession()

oPkcs11:destroy()
oSbAesKey:destroy()
oAttrs:destroy()