JavaScript

SSH Tunnel Uncommon Options

Demonstrates the UncommonOptions property, which enables optional behavior for uncommon requirements. The default is an empty string; provide a comma-separated list of keywords to enable more than one option. Available keywords are listed in the reference documentation.

Background: This is a catch-all for narrow workarounds that do not warrant their own properties — forcing a specific signature algorithm, disabling the periodic keep-alive, removing weak MACs, bypassing a VPN on Android, and so on. Most applications never set it. When you do, it is usually to satisfy a particular server's quirk or a specific security requirement, and the exact keyword matters, so consult the documented list rather than guessing.

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.UncommonOptions property, which enables optional behavior for
//  uncommon requirements.  The default is an empty string, appropriate for most applications.
//  Provide a comma-separated list of keywords to enable more than one option.

var tunnel = new CkSshTunnel();

//  For example, disable the periodic keep-alive ignore message and remove weak MAC algorithms
//  from those offered.  Available keywords are listed in the reference documentation.
tunnel.UncommonOptions = "NoKeepAliveIgnoreMsg,no-weak-mac-algs";

tunnel.DestHostname = "db.internal.example.com";
tunnel.DestPort = 5432;

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

var listenPort = 1080;
success = tunnel.BeginAccepting(listenPort);
if (success == false) {
    console.log(tunnel.LastErrorText);
    return;
}

console.log("Tunnel established.");

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