JavaScript

Get an SSH Tunnel's Current State (Diagnostics)

Demonstrates the Chilkat SshTunnel.GetCurrentState method, which returns an XML snapshot describing the tunnel manager, SSH channels, and current tunnel clients. It takes no arguments and is intended for diagnostics and monitoring.

Background: Because the tunnel forwards traffic on a background thread, there is no natural place in your code to observe what it is doing at a given moment. GetCurrentState provides that visibility — byte counts, active channels, and connected clients — as structured XML suited to logging or a monitoring dashboard. It is a read-only snapshot and does not affect the tunnel.

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.GetCurrentState method, which returns an XML snapshot describing the
//  tunnel manager, SSH channels, and current tunnel clients.  It takes no arguments and is
//  intended for diagnostics and monitoring.

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

//  Begin accepting so there is live tunnel state to inspect.
var listenPort = 1080;
success = tunnel.BeginAccepting(listenPort);
if (success == false) {
    console.log(tunnel.LastErrorText);
    return;
}

//  Get a diagnostic snapshot of the tunnel's current state as XML.
var stateXml = tunnel.GetCurrentState();
if (tunnel.LastMethodSuccess == false) {
    console.log(tunnel.LastErrorText);
    return;
}

console.log(stateXml);

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