PowerBuilder

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.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Pkcs11
string ls_Pin
integer li_UserType
oleobject loo_JsonTemplate
integer li_PrivKeyHandle
integer li_PubKeyHandle
oleobject loo_SshKey
oleobject loo_Ssh

li_Success = 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.

loo_Pkcs11 = create oleobject
li_rc = loo_Pkcs11.ConnectToNewObject("Chilkat.Pkcs11")
if li_rc < 0 then
    destroy loo_Pkcs11
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

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

// Normal user = 1
li_UserType = 1

// Establish a logged-on user session with the HSM.
li_Success = loo_Pkcs11.QuickSession(li_UserType,ls_Pin)
if li_Success = 0 then
    Write-Debug loo_Pkcs11.LastErrorText
    destroy loo_Pkcs11
    return
end if

// Provide a template to find a PKCS11 object.
loo_JsonTemplate = create oleobject
li_rc = loo_JsonTemplate.ConnectToNewObject("Chilkat.JsonObject")

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

li_PrivKeyHandle = loo_Pkcs11.FindObject(loo_JsonTemplate)
if li_PrivKeyHandle = 0 then
    Write-Debug loo_Pkcs11.LastErrorText
    destroy loo_Pkcs11
    destroy loo_JsonTemplate
    return
end if

// 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:  
Write-Debug "private key handle: " + string(li_PrivKeyHandle)

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

li_PubKeyHandle = loo_Pkcs11.FindObject(loo_JsonTemplate)
if li_PubKeyHandle = 0 then
    Write-Debug loo_Pkcs11.LastErrorText
    destroy loo_Pkcs11
    destroy loo_JsonTemplate
    return
end if

Write-Debug "public key handle: " + string(li_PubKeyHandle)

// Create an empty SSH key object, and tell it to use the PKCS11 handles.
// We also need to indicate the key type.
loo_SshKey = create oleobject
li_rc = loo_SshKey.ConnectToNewObject("Chilkat.SshKey")

li_Success = loo_SshKey.UsePkcs11(loo_Pkcs11,li_PrivKeyHandle,li_PubKeyHandle,"rsa")
if li_Success = 0 then
    Write-Debug loo_SshKey.LastErrorText
    destroy loo_Pkcs11
    destroy loo_JsonTemplate
    destroy loo_SshKey
    return
end if

// Create an SSH object and authenticate using the SSH key, which will utilize the existing PKCS11 session.
loo_Ssh = create oleobject
li_rc = loo_Ssh.ConnectToNewObject("Chilkat.Ssh")

li_Success = loo_Ssh.Connect("my-ssh-server.com",22)
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Pkcs11
    destroy loo_JsonTemplate
    destroy loo_SshKey
    destroy loo_Ssh
    return
end if

// This is where the PKCS11 private key on the smart card is used.
li_Success = loo_Ssh.AuthenticatePk("your_ssh_username",loo_SshKey)
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Pkcs11
    destroy loo_JsonTemplate
    destroy loo_SshKey
    destroy loo_Ssh
    return
end if

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

loo_Ssh.Disconnect()

loo_Pkcs11.Logout()
loo_Pkcs11.CloseSession()


destroy loo_Pkcs11
destroy loo_JsonTemplate
destroy loo_SshKey
destroy loo_Ssh