Sample code for 30+ languages & platforms
React Native

SSH Tunnel Through an Outbound SOCKS Proxy

See more SSH Tunnel Examples

Demonstrates reaching the SSH server through an outbound SOCKS proxy using the SocksVersion, SocksHostname, SocksPort, SocksUsername, and SocksPassword properties.

Background: This is the reverse direction from dynamic forwarding: here a SOCKS proxy is used to reach the SSH server, for networks where outbound connections must pass through one. SocksVersion is the switch — 0 means no SOCKS, while 4 or 5 selects the protocol. SOCKS5 supports username/password authentication and remote DNS; SOCKS4 supports only a username.

Chilkat React Native Downloads

React Native
import { SshTunnel } from '@chilkat/react-native'

async function chilkatExample() {
  // Demonstrates reaching the SSH server through an outbound SOCKS proxy using the SshTunnel
  // properties SocksVersion, SocksHostname, SocksPort, SocksUsername, and SocksPassword.

  const tunnel = new SshTunnel();

  // Set SocksVersion to 4 or 5 to route the outbound connection to the SSH server through a SOCKS
  // proxy.  A value of 0 (the default) means no SOCKS proxy.
  tunnel.socksVersion = 5;
  tunnel.socksHostname = 'socks.example.com';
  tunnel.socksPort = 1080;

  // SOCKS4 supports only a username; SOCKS5 supports username and password.
  tunnel.socksUsername = 'myProxyLogin';
  tunnel.socksPassword = 'myProxyPassword';

  tunnel.destHostname = 'db.internal.example.com';
  tunnel.destPort = 5432;

  // Connect to the SSH server through the SOCKS proxy configured above.
  const sshPort = 22;
  try {
    await tunnel.connectAsync('ssh.example.com', sshPort);
  } catch {
    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.
  const password = 'mySshPassword';

  try {
    await tunnel.authenticatePwAsync('mySshLogin', password);
  } catch {
    console.log(tunnel.lastErrorText);
    return;
  }

  const listenPort = 1080;
  try {
    await tunnel.beginAcceptingAsync(listenPort);
  } catch {
    console.log(tunnel.lastErrorText);
    return;
  }

  console.log('Tunnel established through the SOCKS proxy.');

  const waitForThreadExit = true;
  try {
    tunnel.closeTunnel(waitForThreadExit);
  } catch {
    console.log(tunnel.lastErrorText);
    return;
  }
}