React Native

SSH Tunnel Authenticate with a Password

Demonstrates the Chilkat SshTunnel.AuthenticatePw method, which authenticates the SSH connection with a login name and password. The first argument is the login and the second is the password. Connect first, and call BeginAccepting afterward.

Background: Password authentication is the simplest option, but the password is a secret and should never be a hard-coded literal — obtain it from an interactive prompt, an environment variable, or a secrets vault. Public-key authentication is generally preferred for the unattended, long-running services that tunnels often are.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

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

async function chilkatExample() {
  // Demonstrates the SshTunnel.AuthenticatePw method, which authenticates the SSH connection with
  // a login name and password.  The 1st argument is the login and the 2nd is the password.

  const tunnel = new SshTunnel();

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

  console.log('Authenticated.');

  // After authenticating, call BeginAccepting to start listening for local connections to forward.

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