Sample code for 30+ languages & platforms
React Native

Open a direct-tcpip Channel (SSH Port Forwarding)

See more SSH Examples

Demonstrates the Chilkat Ssh.OpenDirectTcpIpChannel method, which opens a direct-tcpip channel through the SSH server to a target host and port. The first argument is the target hostname and the second is the target port. It returns the channel number, or -1 on failure.

Background: This is SSH local port forwarding at the API level: the channel carries ordinary TCP traffic to a service that may be reachable only from the SSH server's network — a database, an internal web app, a message broker. The key detail is that the server resolves the target name, not your machine, so it must resolve and be reachable there. Supplying a numeric IPv4 address avoids remote DNS resolution entirely.

Chilkat React Native Downloads

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

async function chilkatExample() {
  // Demonstrates the Ssh.OpenDirectTcpIpChannel method, which opens a direct-tcpip channel
  // through the SSH server to a target host and port.  The 1st argument is the target hostname
  // and the 2nd is the target port.  It returns the channel number, or -1 on failure.

  const ssh = new Ssh();

  const sshPort = 22;
  try {
    await ssh.connectAsync('ssh.example.com', sshPort);
  } catch {
    console.log(ssh.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 ssh.authenticatePwAsync('mySshLogin', password);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  // The target name is resolved by the SSH server, not by this computer, so it must be
  // reachable from the server's network.
  const targetHostname = 'db.internal.example.com';
  const targetPort = 5432;
  const channelNum = await ssh.openDirectTcpIpChannelAsync(targetHostname, targetPort);
  if (channelNum < 0) {
    console.log(ssh.lastErrorText);
    return;
  }

  console.log(`Opened direct-tcpip channel: ${channelNum}`);

  // The channel now carries ordinary TCP data to the target, tunneled over SSH.

  ssh.disconnect();
}