(Node.js) SSH Commands to Sophos Router Device Console

Demonstrates how to establish an SSH session with a Sophos XG router and send commands in a device console session.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var ssh = new chilkat.Ssh();

    var success = ssh.Connect("172.16.16.16",22);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    // Authenticate using login/password:
    success = ssh.AuthenticatePw("myLogin","myPassword");
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    // Start a shell session.
    // (The QuickShell method was added in Chilkat v9.5.0.65)
    var channelNum = ssh.QuickShell();
    if (channelNum < 0) {
        console.log(ssh.LastErrorText);
        return;
    }

    // The Sophos router will send this initial prompt:

    // 	Main Menu
    // 
    // 	    1.  Network  Configuration
    // 	    2.  System   Configuration
    // 	    3.  Route    Configuration
    // 	    4.  Device Console
    // 	    5.  Device Management
    // 	    6.  VPN Management
    // 	    7.  Shutdown/Reboot Device
    // 	    0.  Exit
    // 
    // 	    Select Menu Number [0-7]: 

    success = ssh.ChannelReceiveUntilMatch(channelNum,"Select Menu Number","utf-8",true);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    // Show what we received so far:
    console.log(ssh.GetReceivedText(channelNum,"utf-8"));

    // Send "4" <RETURN> to mimic typing in a shell session.
    success = ssh.ChannelSendString(channelNum,"4\n","utf-8");
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    // We should get a "console>" prompt.
    success = ssh.ChannelReceiveUntilMatch(channelNum,"console>","utf-8",true);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    console.log(ssh.GetReceivedText(channelNum,"utf-8"));

    // Send a command and get the output..
    success = ssh.ChannelSendString(channelNum,"dnslookup host google.com\n","utf-8");
    success = ssh.ChannelReceiveUntilMatch(channelNum,"console>","utf-8",true);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    console.log(ssh.GetReceivedText(channelNum,"utf-8"));

    // Send another command and get the output, and so on...
    success = ssh.ChannelSendString(channelNum,"dnslookup host microsoft.com\n","utf-8");
    success = ssh.ChannelReceiveUntilMatch(channelNum,"console>","utf-8",true);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    console.log(ssh.GetReceivedText(channelNum,"utf-8"));

    ssh.Disconnect();

}

chilkatExample();