SSH Authenticate using a Smart Card Private Key

See more SSH Examples

Demonstrates using a private key stored on an HSM (smart card or token) for SSH public-key authentication. A JSON template locates the private and public key objects by class, key type, and label, and the returned handles are bound to an SshKey object.

bool success = false;

//  This example requires the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

//  Demonstrates using a private key stored on an HSM (smart card or token) for SSH public-key
//  authentication.  Public-key authentication means the client uses the private key, while the
//  corresponding public key is installed on the server under the SSH account.
//  
//  Note: Chilkat's PKCS#11 implementation runs on Windows, Linux, macOS, and other supported
//  operating systems.

Chilkat.Pkcs11 pkcs11 = new Chilkat.Pkcs11();

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

//  The HSM PIN should come from a secure source rather than being hard-coded.
string pin = "0000";

//  Normal user = 1
int userType = 1;

success = pkcs11.QuickSession(userType,pin);
if (success == false) {
    Debug.WriteLine(pkcs11.LastErrorText);
    return;
}

//  Provide a template describing the PKCS#11 object to find: an RSA private key labeled
//  "MySshKey".  For how such a key is originally imported, see
//  PKCS11 Import SSH Key
Chilkat.JsonObject jsonTemplate = new Chilkat.JsonObject();
jsonTemplate.UpdateString("class","private_key");
jsonTemplate.UpdateString("key_type","rsa");
jsonTemplate.UpdateString("label","MySshKey");

uint privKeyHandle = pkcs11.FindObject(jsonTemplate);
if (privKeyHandle == 0) {
    Debug.WriteLine(pkcs11.LastErrorText);
    return;
}

//  The handle is only valid for the duration of this PKCS#11 session.  To use the key in a
//  later session, find it again.
Debug.WriteLine("private key handle: " + Convert.ToString(privKeyHandle));

//  Find the corresponding public key by changing the class in the same template.
jsonTemplate.UpdateString("class","public_key");

uint pubKeyHandle = pkcs11.FindObject(jsonTemplate);
if (pubKeyHandle == 0) {
    Debug.WriteLine(pkcs11.LastErrorText);
    return;
}

Debug.WriteLine("public key handle: " + Convert.ToString(pubKeyHandle));

//  Create an empty SSH key object and tell it to use the PKCS#11 handles, indicating the key type.
Chilkat.SshKey sshKey = new Chilkat.SshKey();
success = sshKey.UsePkcs11(pkcs11,privKeyHandle,pubKeyHandle,"rsa");
if (success == false) {
    Debug.WriteLine(sshKey.LastErrorText);
    return;
}

Chilkat.Ssh ssh = new Chilkat.Ssh();

int port = 22;
success = ssh.Connect("ssh.example.com",port);
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

//  Authentication uses the existing PKCS#11 session.  The signing happens on the smart card --
//  the private key never leaves the device.
success = ssh.AuthenticatePk("mySshLogin",sshKey);
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

Debug.WriteLine("Public-key authentication successful.");

//  ... use the authenticated SSH session ...

ssh.Disconnect();

pkcs11.Logout();
pkcs11.CloseSession();