JavaScript

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.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

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

var ssh = new CkSsh();

var sshPort = 22;
success = ssh.Connect("ssh.example.com",sshPort);
if (success == false) {
    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.
var password = "mySshPassword";

success = ssh.AuthenticatePw("mySshLogin",password);
if (success == false) {
    console.log(ssh.LastErrorText);
    return;
}

//  Open a session channel.  A negative return value indicates failure.
var channelNum = ssh.OpenSessionChannel();
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();