(Lianja) Import an SSH Key to an HSM using PKCS11

See more PKCS11 Examples

Demonstrates how to import an SSH private key to an HSM (smartcard or token).

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loPkcs11 = createobject("CkPkcs11")

// Use the PKCS11 driver (.dll, .so, .dylib) for your particular HSM.
// For example:
loPkcs11.SharedLibPath = "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS11.dll"

// Use your HSM's PIN.
lcPin = "0000"

// Normal user = 1
lnUserType = 1

// Establish a logged-on user session with the HSM.
llSuccess = loPkcs11.QuickSession(lnUserType,lcPin)
if (llSuccess = .F.) then
    ? loPkcs11.LastErrorText
    release loPkcs11
    return
endif

// Create a PKCS11 template for importing the SSH key.
loJsonTemplate = createobject("CkJsonObject")

// Indicate the key is to be stored on the token (i.e. it is not a session-only key)
loJsonTemplate.UpdateBool("token",.T.)
// The key should have the ability to sign
loJsonTemplate.UpdateBool("sign",.T.)

// Let's provide a few attributes to help us find the this key at a later time.
// See SSH Public-Key Authentication using an HSM

// The ID is byte data, so it should be base64 or hex.
// Specify "id" if passing base64 data, "id_hex" for hexidecimal, or "id_ascii" for directly copying the ascii bytes of the string.
// You can provide any ID of your choice.  It is optional.
loJsonTemplate.UpdateString("id_hex","0A0B0C0D01020304")

// Optionally specify a label.
loJsonTemplate.UpdateString("label","MySshKey")

// Load the SSH key to be imported to the HSM (smartcard or token)
loSshKey = createobject("CkSshKey")
loSshKey.Password = "password_of_the_encrypted_ppk_file"
lcPpkContents = loSshKey.LoadText("c:/my_ssh_keys/someSshKey.ppk")
llSuccess = loSshKey.FromPuttyPrivateKey(lcPpkContents)
if (llSuccess = .F.) then
    ? loSshKey.LastErrorText
    release loPkcs11
    release loJsonTemplate
    release loSshKey
    return
endif

// Import the SSH private key onto the HSM.
// The PKCS11 handle to the imported private key is returned.
// A 0 is returned on failure.
lnPrivKeyHandle = loPkcs11.ImportSshKey(loSshKey,loJsonTemplate)
if (lnPrivKeyHandle = 0) then
    ? loPkcs11.LastErrorText
    release loPkcs11
    release loJsonTemplate
    release loSshKey
    return
endif

// The private key handle is only valid during the PKCS11 session.
// If you wish to use the private key in another PKCS11 session,
// you'll first need to find it.  See  SSH Public-Key Authentication using a Smartcard
? "private key handle: " + str(lnPrivKeyHandle)

? "Successfully imported the SSH key onto the HSM."

loPkcs11.Logout()
loPkcs11.CloseSession()


release loPkcs11
release loJsonTemplate
release loSshKey