JavaScript

SSH Tunnel Thread Activity Log

Demonstrates the tunnel-log properties KeepTunnelLog, TunnelLog, and TunnelLogPath, which record the activity of the SSH tunnel and client-manager threads.

Note: The log paths are relative to the application's current working directory. Absolute paths may also be used.

Background: This is the counterpart to the accept log, covering the SSH side rather than the listener: the tunnel and client-manager threads that actually move data. As with the accept log, KeepTunnelLog enables the in-memory TunnelLog while TunnelLogPath writes a separate file. Together the two logs let you localize a problem to either the accepting side or the forwarding side.

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 tunnel-log properties KeepTunnelLog, TunnelLog, and TunnelLogPath.
//  
//  These log the activity of the SSH tunnel and client-manager threads.

var tunnel = new CkSshTunnel();

//  Retain the SSH tunnel-thread activity in memory so it can be read from the TunnelLog property.
tunnel.KeepTunnelLog = true;

//  Optionally also write the tunnel-thread activity to a file (separate from the in-memory log).
tunnel.TunnelLogPath = "qa_output/tunnel.log";

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

//  ... clients transfer data through the tunnel ...

//  Read the accumulated in-memory tunnel log.
console.log(tunnel.TunnelLog);

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