Delphi DLL

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.

Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, SshKey, Pkcs11, Ssh, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
pkcs11: HCkPkcs11;
pin: PWideChar;
userType: Integer;
jsonTemplate: HCkJsonObject;
privKeyHandle: Cardinal;
pubKeyHandle: Cardinal;
sshKey: HCkSshKey;
ssh: HCkSsh;

begin
success := False;

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

pkcs11 := CkPkcs11_Create();

// Use the PKCS11 driver (.dll, .so, .dylib) for your particular HSM.
// For example:
CkPkcs11_putSharedLibPath(pkcs11,'C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS11.dll');

// Use your HSM's PIN.
pin := '0000';

// Normal user = 1
userType := 1;

// Establish a logged-on user session with the HSM.
success := CkPkcs11_QuickSession(pkcs11,userType,pin);
if (success = False) then
  begin
    Memo1.Lines.Add(CkPkcs11__lastErrorText(pkcs11));
    Exit;
  end;

// Provide a template to find a PKCS11 object.
jsonTemplate := CkJsonObject_Create();

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

privKeyHandle := CkPkcs11_FindObject(pkcs11,jsonTemplate);
if (privKeyHandle = 0) then
  begin
    Memo1.Lines.Add(CkPkcs11__lastErrorText(pkcs11));
    Exit;
  end;

// 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:  
Memo1.Lines.Add('private key handle: ' + IntToStr(privKeyHandle));

// We'll also need the PKCS11 public key handle
// Modify the template by updating the "class" to "public_key"
CkJsonObject_UpdateString(jsonTemplate,'class','public_key');

pubKeyHandle := CkPkcs11_FindObject(pkcs11,jsonTemplate);
if (pubKeyHandle = 0) then
  begin
    Memo1.Lines.Add(CkPkcs11__lastErrorText(pkcs11));
    Exit;
  end;

Memo1.Lines.Add('public key handle: ' + IntToStr(pubKeyHandle));

// Create an empty SSH key object, and tell it to use the PKCS11 handles.
// We also need to indicate the key type.
sshKey := CkSshKey_Create();
success := CkSshKey_UsePkcs11(sshKey,pkcs11,privKeyHandle,pubKeyHandle,'rsa');
if (success = False) then
  begin
    Memo1.Lines.Add(CkSshKey__lastErrorText(sshKey));
    Exit;
  end;

// Create an SSH object and authenticate using the SSH key, which will utilize the existing PKCS11 session.
ssh := CkSsh_Create();

success := CkSsh_Connect(ssh,'my-ssh-server.com',22);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// This is where the PKCS11 private key on the smart card is used.
success := CkSsh_AuthenticatePk(ssh,'your_ssh_username',sshKey);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

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

CkSsh_Disconnect(ssh);

CkPkcs11_Logout(pkcs11);
CkPkcs11_CloseSession(pkcs11);

CkPkcs11_Dispose(pkcs11);
CkJsonObject_Dispose(jsonTemplate);
CkSshKey_Dispose(sshKey);
CkSsh_Dispose(ssh);

end;