Node.js

SSH Tunnel Dynamic Port Forwarding (Local SOCKS Proxy)

Demonstrates dynamic port forwarding with the DynamicPortForwarding, InboundSocksUsername, and InboundSocksPassword properties. In dynamic mode the listener acts as a local SOCKS proxy, so each client chooses its own destination and one tunnel can reach many hosts on the SSH server's network.

Background: This is the ssh -D scenario: instead of pinning one local port to one destination, the tunnel speaks SOCKS and lets each client name where it wants to go. Any SOCKS-capable application — a browser, a mail client — can then reach the remote network through the single tunnel. Setting an inbound SOCKS username and password restricts who may use the local proxy, which matters because it would otherwise accept unauthenticated connections from any local process.

Chilkat Node.js Downloads

Download Chilkat for Node.js

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    //  Demonstrates dynamic port forwarding with the SshTunnel properties DynamicPortForwarding,
    //  InboundSocksUsername, and InboundSocksPassword.
    //  
    //  In dynamic mode the listener behaves as a local SOCKS proxy: each client chooses its own
    //  destination, so one tunnel can reach many hosts on the SSH server's network.

    var tunnel = new chilkat.SshTunnel();

    //  Enable dynamic (SOCKS) forwarding instead of a single fixed destination.  No DestHostname or
    //  DestPort is needed.
    tunnel.DynamicPortForwarding = true;

    //  Optionally require inbound SOCKS5 clients to authenticate with the local proxy.  If left unset,
    //  the local proxy accepts unauthenticated SOCKS4 and SOCKS5 connections.
    tunnel.InboundSocksUsername = "myLocalSocksLogin";
    tunnel.InboundSocksPassword = "myLocalSocksPassword";

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

    //  Start the local SOCKS proxy on port 1080.  SOCKS-capable clients point at 127.0.0.1:1080.
    var listenPort = 1080;
    success = tunnel.BeginAccepting(listenPort);
    if (success == false) {
        console.log(tunnel.LastErrorText);
        return;
    }

    console.log("Local SOCKS proxy running on port " + listenPort);

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


}

chilkatExample();