React Native

Open an SSH Session Channel

Demonstrates the Chilkat Ssh.OpenSessionChannel method, which opens a new SSH session channel. It takes no arguments and returns the channel number, or -1 on failure. The transport must already be connected and authenticated.

Background: SSH multiplexes independent channels over one authenticated connection, and a session channel is the one used to run a command, start a shell, or invoke a subsystem. Opening the channel is only the container — nothing runs until you follow it with an exec, shell, or subsystem request. Always test for a negative return rather than assuming success.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

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

async function chilkatExample() {
  // Demonstrates the Ssh.OpenSessionChannel method, which opens a new SSH session channel.  It
  // takes no arguments and returns the channel number, or -1 on failure.  The transport must
  // already be connected and authenticated.

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

  // Open a session channel.  A negative return value indicates failure.
  const channelNum = await ssh.openSessionChannelAsync();
  if (channelNum < 0) {
    console.log(ssh.lastErrorText);
    return;
  }

  console.log(`Opened session channel: ${channelNum}`);

  // Opening the channel does not start a shell or command -- send an exec, shell, or subsystem
  // request next.

  ssh.disconnect();
}