React Native

SSH Tunnel Uncommon Options

Demonstrates the UncommonOptions property, which enables optional behavior for uncommon requirements. The default is an empty string; provide a comma-separated list of keywords to enable more than one option. Available keywords are listed in the reference documentation.

Background: This is a catch-all for narrow workarounds that do not warrant their own properties — forcing a specific signature algorithm, disabling the periodic keep-alive, removing weak MACs, bypassing a VPN on Android, and so on. Most applications never set it. When you do, it is usually to satisfy a particular server's quirk or a specific security requirement, and the exact keyword matters, so consult the documented list rather than guessing.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

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

async function chilkatExample() {
  // Demonstrates the SshTunnel.UncommonOptions property, which enables optional behavior for
  // uncommon requirements.  The default is an empty string, appropriate for most applications.
  // Provide a comma-separated list of keywords to enable more than one option.

  const tunnel = new SshTunnel();

  // For example, disable the periodic keep-alive ignore message and remove weak MAC algorithms
  // from those offered.  Available keywords are listed in the reference documentation.
  tunnel.uncommonOptions = 'NoKeepAliveIgnoreMsg,no-weak-mac-algs';

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

  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.');

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