JavaScript

SSH Authenticate with a Private Key

Demonstrates the Chilkat Ssh.AuthenticatePk method, which authenticates a connected SSH session using public-key authentication. The first argument is the username and the second is an SshKey private key. The matching public key must already be authorized for the account on the server.

Note: The private-key path is relative to the application's current working directory. Supply the path to your own key file.

Background: Public-key authentication is the standard for unattended and automated SSH: the private key stays on the client, the server trusts the corresponding public key, and no reusable password crosses the wire. The SshKey object imports keys in several formats — this example loads an OpenSSH private key. An empty or public-only key is rejected locally.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

//  Demonstrates the Ssh.AuthenticatePk method, which authenticates a connected SSH session using
//  public-key authentication.  The 1st argument is the username and the 2nd is an SshKey private
//  key.  The matching public key must already be authorized for the account on the server.

var ssh = new CkSsh();

//  Connect to the SSH server.  Port 22 is the usual SSH port.
var sshPort = 22;
success = ssh.Connect("ssh.example.com",sshPort);
if (success == false) {
    console.log(ssh.LastErrorText);
    return;
}

//  Load the SSH private key.  LoadText reads the file's text, which is then imported.
var privKey = new CkSshKey();
var keyStr = privKey.LoadText("qa_data/id_rsa");
if (privKey.LastMethodSuccess == false) {
    console.log(privKey.LastErrorText);
    return;
}

success = privKey.FromOpenSshPrivateKey(keyStr);
if (success == false) {
    console.log(privKey.LastErrorText);
    return;
}

success = ssh.AuthenticatePk("mySshLogin",privKey);
if (success == false) {
    console.log(ssh.LastErrorText);
    return;
}

console.log("Authenticated with private key.");

ssh.Disconnect();