(Tcl) PKCS11 Generate a RSA Key that stays 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 stays on the HSM even after the PKCS11 session has ended.

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set pkcs11 [new_CkPkcs11]

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

# Establish a logged-on session.
# Use your actual PIN here.
set pin "0000"
set userType 1
set success [CkPkcs11_QuickSession $pkcs11 $userType $pin]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    delete_CkPkcs11 $pkcs11
    exit
}

# 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.
set pubKeyAttr [new_CkJsonObject]

# Generate a RSA key that remains on the HSM by setting the "token" attribute equal to 1
CkJsonObject_UpdateBool $pubKeyAttr "token" 1

# Given that our key will reside on the token, we should give it two attributes (id and label) to help us
# find it in future sessions.

# First, we can give it an arbitrary ID.  ID's are binary, so we specify bytes as either 
# "id_hex" for hexidecimal bytes, 
# "id_ascii" for the bytes of an ascii string, 
# "id" for bytes in base64 format.
set keyId "48656C6C6F"
CkJsonObject_UpdateString $pubKeyAttr "id_hex" $keyId

# We can also give our key a label with any descriptive string.
set keyLabel "2048-bit RSA key for testing"
CkJsonObject_UpdateString $pubKeyAttr "label" $keyLabel

# -----------------------------------------------------------------------------------
# IMPORTANT: The ID for the public key must be the same as the ID for the private key.
# -----------------------------------------------------------------------------------

# Allow the public key to be used for encryption, signature verification, and symmetric key wrapping.
# These attributes are optional.
CkJsonObject_UpdateBool $pubKeyAttr "encrypt" 1
CkJsonObject_UpdateBool $pubKeyAttr "verify" 1
CkJsonObject_UpdateBool $pubKeyAttr "wrap" 1

# Generate a 2048-bit RSA key.
# This attribute is required.
CkJsonObject_UpdateInt $pubKeyAttr "modulus_bits" 2048

set privKeyAttr [new_CkJsonObject]

# Generate a RSA key that remains on the HSM by setting the "token" attribute equal to 1
CkJsonObject_UpdateBool $privKeyAttr "token" 1

# Make sure we give the private key the same ID as the public key.
CkJsonObject_UpdateString $privKeyAttr "id_hex" $keyId

# We can also give our key a label with any descriptive string.
# (Best to use the same label as for the public key)
CkJsonObject_UpdateString $privKeyAttr "label" $keyLabel

# Allow the private key to be used for signing and decryption.
CkJsonObject_UpdateBool $privKeyAttr "sign" 1
CkJsonObject_UpdateBool $privKeyAttr "decrypt" 1

# Do not allow the private key to be extracted.
CkJsonObject_UpdateBool $privKeyAttr "extractable" 0

# Provide a JSON object to receive the public and private key handles.
set jsonHandles [new_CkJsonObject]

CkJsonObject_put_EmitCompact $jsonHandles 0

# Provide a Chilkat public key object to receive the public key.
set pubKey [new_CkPublicKey]

set success [CkPkcs11_GenRsaKey $pkcs11 $pubKeyAttr $privKeyAttr $jsonHandles $pubKey]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    puts "Failed to generate an RSA key."
} else {
    # Sample JSON handles:
    # {
    #   "public_key_handle": 18415630,
    #   "private_key_handle": 74842125
    # }
    puts [CkJsonObject_emit $jsonHandles]
    puts "public_key_handle: [CkJsonObject_UIntOf $jsonHandles public_key_handle]"
    puts "private_key_handle: [CkJsonObject_UIntOf $jsonHandles private_key_handle]"
    puts "public key JWK:"
    puts [CkPublicKey_getJwk $pubKey]
    # Sample JWK:
    # {"kty":"RSA","n":"1sQMSAntY80L .... If9jqfMp4omQ","e":"AQAB"}
    puts "Success."
}

CkPkcs11_Logout $pkcs11
CkPkcs11_CloseSession $pkcs11

delete_CkPkcs11 $pkcs11
delete_CkJsonObject $pubKeyAttr
delete_CkJsonObject $privKeyAttr
delete_CkJsonObject $jsonHandles
delete_CkPublicKey $pubKey