Delphi DLL

SSH Remote Shell

Demonstrates starting a shell on a remote SSH server, running a command, and retrieving the output. The example sends the command, signals EOF so the server knows no more input is coming, and then receives the remaining output until the channel closes.

Background: A shell channel differs from an exec channel in that it stays open for a stream of commands rather than running just one. No PTY is requested here, which is the recommended approach for automation: the shell detects a raw pipe and runs non-interactively, so no prompt is printed and typed commands are not echoed. Sending EOF is the SSH equivalent of Ctrl+D — it closes only the client-to-server direction, so output can still be received afterward, and it prompts the server to finish up and close the channel.

Chilkat Delphi DLL Downloads

Download Chilkat for Delphi DLL

Delphi DLL

var
success: Boolean;
ssh: HCkSsh;
hostname: PWideChar;
port: Integer;
password: PWideChar;
channelNum: Integer;
cmdOutput: PWideChar;

begin
success := False;

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

//  Demonstrates starting a shell on a remote SSH server, running a command, and retrieving the
//  output.  No PTY is requested, which is the recommended approach for automation.

ssh := CkSsh_Create();

hostname := 'ssh.example.com';
port := 22;
success := CkSsh_Connect(ssh,hostname,port);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    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 := CkSsh_AuthenticatePw(ssh,'mySshLogin',password);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

channelNum := CkSsh_OpenSessionChannel(ssh);
if (channelNum < 0) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

//  Start a shell WITHOUT requesting a PTY.  Without a PTY the shell sees it is connected to a
//  raw data pipe and enters non-interactive mode: it suppresses the command prompt, does not
//  echo typed commands back, and skips interactive login scripts.  The output is therefore
//  clean and easily parseable -- but because no prompt is ever sent, code must not wait for
//  one.  Instead, have each command print a predictable marker, or wait for EOF / channel close.
success := CkSsh_SendReqShell(ssh,channelNum);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

//  Send the command.  The trailing newline is required -- the shell acts on a line at a time.
success := CkSsh_ChannelSendString(ssh,channelNum,'ls -l /tmp' + #10,'utf-8');
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

//  Send EOF to tell the server no more input is coming.  The channel stays open and output can
//  still be received.
success := CkSsh_ChannelSendEof(ssh,channelNum);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

//  IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
//  it, this call waits forever if the server never sends channel close.
CkSsh_putReadTimeoutMs(ssh,15000);

//  Receive the remaining output until the server closes the channel.
success := CkSsh_ChannelReceiveToClose(ssh,channelNum);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

cmdOutput := CkSsh__getReceivedText(ssh,channelNum,'utf-8');
if (CkSsh_getLastMethodSuccess(ssh) = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;
Memo1.Lines.Add(cmdOutput);

CkSsh_Disconnect(ssh);

CkSsh_Dispose(ssh);