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

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

' 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.
keyType = "AES"

' Specify attributes and abilities (how this key can be used) by providing a JSON template.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = CreateObject("Chilkat.JsonObject")

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

' Allow the key to be used for encryption, decryption, wrapping other keys, and unwrapping other keys.
success = json.UpdateBool("encrypt",1)
success = json.UpdateBool("decrypt",1)
success = json.UpdateBool("wrap",1)
success = json.UpdateBool("unwrap",1)

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

keyHandle = pkcs11.GenSecretKey(keyType,json)
If (keyHandle = 0) Then
    outFile.WriteLine(pkcs11.LastErrorText)
    outFile.WriteLine("Failed to generate an AES key.")
Else
    outFile.WriteLine("key handle = " & keyHandle)
    outFile.WriteLine("Success.")
End If

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

outFile.Close