JavaScript

SSH Tunnel Authenticate with a Password

Demonstrates the Chilkat SshTunnel.AuthenticatePw method, which authenticates the SSH connection with a login name and password. The first argument is the login and the second is the password. Connect first, and call BeginAccepting afterward.

Background: Password authentication is the simplest option, but the password is a secret and should never be a hard-coded literal — obtain it from an interactive prompt, an environment variable, or a secrets vault. Public-key authentication is generally preferred for the unattended, long-running services that tunnels often are.

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.AuthenticatePw method, which authenticates the SSH connection with
//  a login name and password.  The 1st argument is the login and the 2nd is the password.

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;
}

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
var password = "mySshPassword";

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

console.log("Authenticated.");

//  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;
}