SSH Commands to a Sophos Router Device Console

See more SSH Examples

Demonstrates establishing an SSH session with a Sophos XG router and sending commands in its device console session. The router presents a numbered main menu; the example selects the Device Console entry and then runs commands at the resulting console> prompt.

Note: QuickShell allocates a PTY, which is what a network device console expects. The device presents an interactive prompt, and each command's output is read up to the next prompt.

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.Ssh;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  ssh: TSsh;
  port: Integer;
  password: string;
  channelNum: Integer;
  caseSensitive: Boolean;
  cmdOutput: string;

begin
  success := False;

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

  //  Demonstrates establishing an SSH session with a Sophos XG router and sending commands in its
  //  device console session.
  //  
  //  Note: QuickShell allocates a PTY, which is what a device console expects.  Navigating the
  //  device's menus is a matter of reading up to each prompt and sending the expected keystrokes.

  ssh := TSsh.Create;

  port := 22;
  success := ssh.Connect('172.16.16.16',port);
  if (success = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

  //  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.
  password := 'mySshPassword';

  success := ssh.AuthenticatePw('mySshLogin',password);
  if (success = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

  channelNum := ssh.QuickShell();
  if (channelNum < 0) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

  //  IMPORTANT: Set a read timeout before receiving until a match.  ReadTimeoutMs defaults to 0,
  //  which means no limit -- without it, this call waits forever if the received data never
  //  contains a match.
  ssh.ReadTimeoutMs := 15000;

  caseSensitive := True;

  //  The router presents a numbered main menu ending with "Select Menu Number [0-7]: ".
  success := ssh.ChannelReceiveUntilMatch(channelNum,'Select Menu Number','utf-8',caseSensitive);
  if (success = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

  cmdOutput := ssh.GetReceivedText(channelNum,'utf-8');
  if (ssh.LastMethodSuccess = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;
  WriteLn(cmdOutput);

  //  Choose menu item 4 (Device Console), exactly as if typing it in a terminal.
  success := ssh.ChannelSendString(channelNum,'4' + #10,'utf-8');
  if (success = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

  //  The device console prompt is "console>".
  success := ssh.ChannelReceiveUntilMatch(channelNum,'console>','utf-8',caseSensitive);
  if (success = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

  cmdOutput := ssh.GetReceivedText(channelNum,'utf-8');
  if (ssh.LastMethodSuccess = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;
  WriteLn(cmdOutput);

  //  Send a console command and read its output up to the next prompt.
  success := ssh.ChannelSendString(channelNum,'dnslookup host google.com' + #10,'utf-8');
  if (success = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

  success := ssh.ChannelReceiveUntilMatch(channelNum,'console>','utf-8',caseSensitive);
  if (success = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

  cmdOutput := ssh.GetReceivedText(channelNum,'utf-8');
  if (ssh.LastMethodSuccess = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;
  WriteLn(cmdOutput);

  //  Additional commands follow the same pattern.
  success := ssh.ChannelSendString(channelNum,'dnslookup host microsoft.com' + #10,'utf-8');
  if (success = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

  success := ssh.ChannelReceiveUntilMatch(channelNum,'console>','utf-8',caseSensitive);
  if (success = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;

  cmdOutput := ssh.GetReceivedText(channelNum,'utf-8');
  if (ssh.LastMethodSuccess = False) then
    begin
      WriteLn(ssh.LastErrorText);
      Exit;
    end;
  WriteLn(cmdOutput);

  ssh.Disconnect();


  ssh.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.