(Node.js) SSH Public Key Authentication

Demonstrates how to authenticate with an SSH server using public key authentication.

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 assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var ssh = new chilkat.Ssh();

    // Set some timeouts, in milliseconds:
    ssh.ConnectTimeoutMs = 5000;
    ssh.IdleTimeoutMs = 15000;

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    var hostname = "sftp.example.com";
    var port = 22;
    var success = ssh.Connect(hostname,port);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    var key = new chilkat.SshKey();

    // Read the PEM file into a string variable:
    // (This does not load the PEM file into the key.  The LoadText
    // method is a convenience method for loading the full contents of ANY text
    // file into a string variable.)
    var privKey = key.LoadText("myPrivateKey.pem");
    if (key.LastMethodSuccess !== true) {
        console.log(key.LastErrorText);
        return;
    }

    // Load a private key from a PEM string:
    // (Private keys may be loaded from OpenSSH and Putty formats.
    // Both encrypted and unencrypted private key file formats
    // are supported.  This example loads an unencrypted private
    // key in OpenSSH format.  PuTTY keys typically use the .ppk
    // file extension, while OpenSSH keys use the PEM format.
    // (For PuTTY keys, call FromPuttyPrivateKey instead.)
    success = key.FromOpenSshPrivateKey(privKey);
    if (success !== true) {
        console.log(key.LastErrorText);
        return;
    }

    // Authenticate with the SSH server using the login and
    // private key.  (The corresponding public key should've 
    // been installed on the SSH server beforehand.)
    success = ssh.AuthenticatePk("myLogin",key);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    console.log(ssh.LastErrorText);
    console.log("Public-Key Authentication Successful!");

}

chilkatExample();