Xojo Plugin

PKCS11 Generate a Session RSA Key on the HSM

See more PKCS11 Examples

Generates an RSA key on the smart card or token and returns the public and private key handles. The generated RSA key exists only for the duration of the PKCS11 session.

Note: This example requires Chilkat v9.5.0.96 or later.

Xojo Plugin

Dim success As Boolean
success = False

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

Dim pkcs11 As New 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.
Dim pin As String
pin = "0000"
Dim userType As Int32
userType = 1
success = pkcs11.QuickSession(userType,pin)
If (success = False) Then
    System.DebugLog(pkcs11.LastErrorText)
    Return
End If

// Specify attributes and abilities (how this key can be used) by providing a JSON template.
// One template is for the public key, and the other for the private key.
Dim pubKeyAttr As New Chilkat.JsonObject

// Allow the public key to be used for encryption, signature verification, and symmetric key wrapping
// These attributes are optional.
success = pubKeyAttr.UpdateBool("encrypt",True)
success = pubKeyAttr.UpdateBool("verify",True)
success = pubKeyAttr.UpdateBool("wrap",True)

// Generate a 2048-bit RSA key.
// This attribute is required.
success = pubKeyAttr.UpdateInt("modulus_bits",2048)

Dim privKeyAttr As New Chilkat.JsonObject

// Generate a session RSA key.
// A session key exists only for the duration of the PKS11 session.
// To generate an RSA key that resides on the HSM, set the "token" attribute equal to True
success = privKeyAttr.UpdateBool("token",False)

// Allow the private key to be used for signing and decryption.
success = privKeyAttr.UpdateBool("sign",True)
success = privKeyAttr.UpdateBool("decrypt",True)

// Do not allow the private key to be extracted.
success = privKeyAttr.UpdateBool("extractable",False)

// Provide a JSON object to receive the public and private key handles.
Dim jsonHandles As New Chilkat.JsonObject
jsonHandles.EmitCompact = False

// Provide a Chilkat public key object to receive the public key.
Dim pubKey As New Chilkat.PublicKey

success = pkcs11.GenRsaKey(pubKeyAttr,privKeyAttr,jsonHandles,pubKey)
If (success = False) Then
    System.DebugLog(pkcs11.LastErrorText)
    System.DebugLog("Failed to generate an RSA key.")
Else
    // Sample JSON handles:
    // {
    //   "public_key_handle": 18415630,
    //   "private_key_handle": 74842125
    // }
    System.DebugLog(jsonHandles.Emit())
    System.DebugLog("public_key_handle: " + Str(jsonHandles.UIntOf("public_key_handle")))
    System.DebugLog("private_key_handle: " + Str(jsonHandles.UIntOf("private_key_handle")))
    System.DebugLog("public key JWK:")
    System.DebugLog(pubKey.GetJwk())
    // Sample JWK:
    // {"kty":"RSA","n":"1sQMSAntY80L .... If9jqfMp4omQ","e":"AQAB"}
    System.DebugLog("Success.")
End If

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