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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Pkcs11
string ls_Pin
integer li_UserType
integer li_Success
oleobject loo_SbAesKey
oleobject loo_Attrs
integer li_ObjHandle

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

loo_Pkcs11 = create oleobject
// Use "Chilkat_9_5_0.Pkcs11" for versions of Chilkat < 10.0.0
li_rc = loo_Pkcs11.ConnectToNewObject("Chilkat.Pkcs11")
if li_rc < 0 then
    destroy loo_Pkcs11
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

// Establish a logged-on session.
ls_Pin = "0000"
li_UserType = 1
li_Success = loo_Pkcs11.QuickSession(li_UserType,ls_Pin)
if li_Success = 0 then
    Write-Debug loo_Pkcs11.LastErrorText
    destroy loo_Pkcs11
    return
end if

// Generate a 256-bit AES key.
// (32 bytes is 256 bits)
// Append 32 bytes of random data in the base64 encoding.
loo_SbAesKey = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbAesKey.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbAesKey.AppendRandom(32,"base64")

loo_Attrs = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Attrs.ConnectToNewObject("Chilkat.JsonObject")

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

// Provide the AES key material.
loo_Attrs.UpdateString("value",loo_SbAesKey.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.
li_ObjHandle = loo_Pkcs11.CreatePkcs11Object(loo_Attrs)
if li_ObjHandle = 0 then
    Write-Debug loo_Pkcs11.LastErrorText
    Write-Debug "Failed."
else
    Write-Debug "PKCS11 object handle = " + string(li_ObjHandle)
    Write-Debug "Successfully created a 256-bit AES session key."
end if

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

loo_Pkcs11.Logout()
loo_Pkcs11.CloseSession()


destroy loo_Pkcs11
destroy loo_SbAesKey
destroy loo_Attrs