(Lianja) SSH Authenticate using Smart Card Private Key

See more SSH Examples

Demonstrates how to use a private key stored on an HSM (smartcard or token) for SSH public-key authentication. (Public-key authentication means the client, which is your application, uses the private key, while the corresponding public key is installed on the server under your SSH account.)

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

// Provide a template to find a PKCS11 object.
loJsonTemplate = createobject("CkJsonObject")

// Find an RSA private key with the label "MySshKey".
// Here's an example of how the key was originally imported: 
// PKCS11 Import SSH Key
loJsonTemplate.UpdateString("class","private_key")
loJsonTemplate.UpdateString("key_type","rsa")
loJsonTemplate.UpdateString("label","MySshKey")

lnPrivKeyHandle = loPkcs11.FindObject(loJsonTemplate)
if (lnPrivKeyHandle = 0) then
    ? loPkcs11.LastErrorText
    release loPkcs11
    release loJsonTemplate
    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:  
? "private key handle: " + str(lnPrivKeyHandle)

// We'll also need the PKCS11 public key handle
// Modify the template by updating the "class" to "public_key"
loJsonTemplate.UpdateString("class","public_key")

lnPubKeyHandle = loPkcs11.FindObject(loJsonTemplate)
if (lnPubKeyHandle = 0) then
    ? loPkcs11.LastErrorText
    release loPkcs11
    release loJsonTemplate
    return
endif

? "public key handle: " + str(lnPubKeyHandle)

// Create an empty SSH key object, and tell it to use the PKCS11 handles.
// We also need to indicate the key type.
loSshKey = createobject("CkSshKey")
llSuccess = loSshKey.UsePkcs11(loPkcs11,lnPrivKeyHandle,lnPubKeyHandle,"rsa")
if (llSuccess = .F.) then
    ? loSshKey.LastErrorText
    release loPkcs11
    release loJsonTemplate
    release loSshKey
    return
endif

// Create an SSH object and authenticate using the SSH key, which will utilize the existing PKCS11 session.
loSsh = createobject("CkSsh")

llSuccess = loSsh.Connect("my-ssh-server.com",22)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loPkcs11
    release loJsonTemplate
    release loSshKey
    release loSsh
    return
endif

// This is where the PKCS11 private key on the smart card is used.
llSuccess = loSsh.AuthenticatePk("your_ssh_username",loSshKey)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loPkcs11
    release loJsonTemplate
    release loSshKey
    release loSsh
    return
endif

// Do whatever it is your app needs to do using the authenticated SSH session....
// ...
// ...

loSsh.Disconnect()

loPkcs11.Logout()
loPkcs11.CloseSession()


release loPkcs11
release loJsonTemplate
release loSshKey
release loSsh