(Node.js) 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.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var pkcs11 = new chilkat.Pkcs11();

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

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

    // Normal user = 1
    var userType = 1;

    // Establish a logged-on user session with the HSM.
    var success = pkcs11.QuickSession(userType,pin);
    if (success == false) {
        console.log(pkcs11.LastErrorText);
        return;
    }

    // Provide a template to find a PKCS11 object.
    var jsonTemplate = new 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
    jsonTemplate.UpdateString("class","private_key");
    jsonTemplate.UpdateString("key_type","rsa");
    jsonTemplate.UpdateString("label","MySshKey");

    var privKeyHandle = pkcs11.FindObject(jsonTemplate);
    if (privKeyHandle == 0) {
        console.log(pkcs11.LastErrorText);
        return;
    }

    // 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:  
    console.log("private key handle: " + privKeyHandle);

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

    var pubKeyHandle = pkcs11.FindObject(jsonTemplate);
    if (pubKeyHandle == 0) {
        console.log(pkcs11.LastErrorText);
        return;
    }

    console.log("public key handle: " + pubKeyHandle);

    // Create an empty SSH key object, and tell it to use the PKCS11 handles.
    // We also need to indicate the key type.
    var sshKey = new chilkat.SshKey();
    success = sshKey.UsePkcs11(pkcs11,privKeyHandle,pubKeyHandle,"rsa");
    if (success == false) {
        console.log(sshKey.LastErrorText);
        return;
    }

    // Create an SSH object and authenticate using the SSH key, which will utilize the existing PKCS11 session.
    var ssh = new chilkat.Ssh();

    success = ssh.Connect("my-ssh-server.com",22);
    if (success == false) {
        console.log(ssh.LastErrorText);
        return;
    }

    // This is where the PKCS11 private key on the smart card is used.
    success = ssh.AuthenticatePk("your_ssh_username",sshKey);
    if (success == false) {
        console.log(ssh.LastErrorText);
        return;
    }

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

    ssh.Disconnect();

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

}

chilkatExample();