JavaScript

SSH Tunnel Authenticate with a Private Key

Demonstrates the Chilkat SshTunnel.AuthenticatePk method, which authenticates the SSH connection 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 installed for the account on the SSH server.

Note: The private-key path is relative to the application's current working directory. Absolute paths may also be used. Supply the path to your own key file.

Background: Public-key authentication suits tunnels especially well because they typically run unattended for long periods: 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 several formats; for an encrypted key, set its Password before importing.

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 SshTunnel.AuthenticatePk method, which authenticates the SSH connection 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 installed for the account on the SSH server.

var tunnel = new CkSshTunnel();

//  The tunnel forwards accepted local connections to this destination through the SSH server.
tunnel.DestHostname = "db.internal.example.com";
tunnel.DestPort = 5432;

//  Connect to the SSH server.  This performs the TCP/proxy connection and SSH handshake, but
//  does not authenticate yet.
var sshPort = 22;
success = tunnel.Connect("ssh.example.com",sshPort);
if (success == false) {
    console.log(tunnel.LastErrorText);
    return;
}

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

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

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

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

//  After authenticating, call BeginAccepting to start listening for local connections to forward.

var waitForThreadExit = true;
success = tunnel.CloseTunnel(waitForThreadExit);
if (success == false) {
    console.log(tunnel.LastErrorText);
    return;
}