Xbase++

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.

Xbase++

LOCAL nSuccess
LOCAL oPkcs11
LOCAL cPin
LOCAL nUserType
LOCAL oJsonTemplate
LOCAL oSshKey
LOCAL cPpkContents
LOCAL nPrivKeyHandle

nSuccess := 0

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

oPkcs11 := CreateObject("Chilkat.Pkcs11")

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

//  Use your HSM's PIN.
cPin := "0000"

//  Normal user = 1
nUserType := 1

//  Establish a logged-on user session with the HSM.
nSuccess := oPkcs11:QuickSession(nUserType, cPin)
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    oPkcs11:destroy()
    RETURN
ENDIF

//  Create a PKCS11 template for importing the SSH key.
oJsonTemplate := CreateObject("Chilkat.JsonObject")

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

//  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.
oJsonTemplate:UpdateString("id_hex", "0A0B0C0D01020304")

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

//  Load the SSH key to be imported to the HSM (smartcard or token)
oSshKey := CreateObject("Chilkat.SshKey")
oSshKey:Password := "password_of_the_encrypted_ppk_file"
cPpkContents := oSshKey:LoadText("c:/my_ssh_keys/someSshKey.ppk")
nSuccess := oSshKey:FromPuttyPrivateKey(cPpkContents)
IF (nSuccess == 0)
    ? oSshKey:LastErrorText
    oPkcs11:destroy()
    oJsonTemplate:destroy()
    oSshKey:destroy()
    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.
nPrivKeyHandle := oPkcs11:ImportSshKey(oSshKey, oJsonTemplate)
IF (nPrivKeyHandle == 0)
    ? oPkcs11:LastErrorText
    oPkcs11:destroy()
    oJsonTemplate:destroy()
    oSshKey:destroy()
    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(nPrivKeyHandle)

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

oPkcs11:Logout()
oPkcs11:CloseSession()

oPkcs11:destroy()
oJsonTemplate:destroy()
oSshKey:destroy()