(VBScript) 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

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Pkcs11")
set pkcs11 = 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.
pkcs11.SharedLibPath = "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll"

' Establish a logged-on session.
pin = "0000"
userType = 1
success = pkcs11.QuickSession(userType,pin)
If (success = 0) Then
    outFile.WriteLine(pkcs11.LastErrorText)
    WScript.Quit
End If

' Generate a 256-bit AES key.
' (32 bytes is 256 bits)
' Append 32 bytes of random data in the base64 encoding.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbAesKey = CreateObject("Chilkat.StringBuilder")
success = sbAesKey.AppendRandom(32,"base64")

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

' Provide the AES key material.
success = attrs.UpdateString("value",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.
objHandle = pkcs11.CreatePkcs11Object(attrs)
If (objHandle = 0) Then
    outFile.WriteLine(pkcs11.LastErrorText)
    outFile.WriteLine("Failed.")
Else
    outFile.WriteLine("PKCS11 object handle = " & objHandle)
    outFile.WriteLine("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.
' ...
' ...

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

outFile.Close