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.

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

let pkcs11 = chilkat::Pkcs11::new();

// Use the PKCS#11 driver (.dll, .so, or .dylib) for your particular HSM.
pkcs11.set_shared_lib_path("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.
let pin = "0000".to_string();

// Normal user = 1
let user_type = 1;

if pkcs11.quick_session(user_type, &pin).is_err() {
    println!("{}", pkcs11.last_error_text());
    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
let json_template = chilkat::JsonObject::new();
let _ = json_template.update_string("class", "private_key");
let _ = json_template.update_string("key_type", "rsa");
let _ = json_template.update_string("label", "MySshKey");

let priv_key_handle = pkcs11.find_object(&json_template);
if priv_key_handle == 0 {
    println!("{}", pkcs11.last_error_text());
    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.
println!("private key handle: {}", priv_key_handle);

// Find the corresponding public key by changing the class in the same template.
let _ = json_template.update_string("class", "public_key");

let pub_key_handle = pkcs11.find_object(&json_template);
if pub_key_handle == 0 {
    println!("{}", pkcs11.last_error_text());
    return;
}

println!("public key handle: {}", pub_key_handle);

// Create an empty SSH key object and tell it to use the PKCS#11 handles, indicating the key type.
let ssh_key = chilkat::SshKey::new();
if ssh_key.use_pkcs11(&pkcs11, priv_key_handle, pub_key_handle, "rsa").is_err() {
    println!("{}", ssh_key.last_error_text());
    return;
}

let ssh = chilkat::Ssh::new();

let port = 22;
if ssh.connect("ssh.example.com", port).is_err() {
    println!("{}", ssh.last_error_text());
    return;
}

// Authentication uses the existing PKCS#11 session.  The signing happens on the smart card --
// the private key never leaves the device.
if ssh.authenticate_pk("mySshLogin", &ssh_key).is_err() {
    println!("{}", ssh.last_error_text());
    return;
}

println!("Public-key authentication successful.");

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

ssh.disconnect();

let _ = pkcs11.logout();
let _ = pkcs11.close_session();