Get Received SSH Text Up To a Substring

See more SSH Examples

Demonstrates the Chilkat Ssh.GetReceivedTextS method, which searches the receive buffer for a literal, case-sensitive substring. The arguments are the channel number, the substring, and the charset. If found, everything through and including the first occurrence is returned and removed; if not found, an empty string is returned successfully and the buffer is left unchanged.

var
success: Integer;
ssh: TChilkatSsh;
sshPort: Integer;
password: WideString;
channelNum: Integer;
pollTimeoutMs: Integer;
result: Integer;
upToMarker: WideString;

begin
success := 0;

//  Demonstrates the Ssh.GetReceivedTextS method, which searches the receive buffer for a literal
//  substring.  The 1st argument is the channel number, the 2nd is the substring, and the 3rd is
//  the charset.  If found, everything through and including the first occurrence is returned and
//  removed from the buffer.

ssh := TChilkatSsh.Create(Self);

sshPort := 22;
success := ssh.Connect('ssh.example.com',sshPort);
if (success = 0) then
  begin
    Memo1.Lines.Add(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 = 0) then
  begin
    Memo1.Lines.Add(ssh.LastErrorText);
    Exit;
  end;

channelNum := ssh.OpenSessionChannel();
if (channelNum < 0) then
  begin
    Memo1.Lines.Add(ssh.LastErrorText);
    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 := ssh.SendReqShell(channelNum);
if (success = 0) then
  begin
    Memo1.Lines.Add(ssh.LastErrorText);
    Exit;
  end;

success := ssh.ChannelSendString(channelNum,'echo BEGIN; ls /tmp; echo END_MARKER' + #10,'utf-8');
if (success = 0) then
  begin
    Memo1.Lines.Add(ssh.LastErrorText);
    Exit;
  end;

pollTimeoutMs := 1000;
result := ssh.ChannelReadAndPoll(channelNum,pollTimeoutMs);
if (result = -1) then
  begin
    Memo1.Lines.Add(ssh.LastErrorText);
    Exit;
  end;

//  Return everything up through the marker.  If the marker is not present, an empty string is
//  returned successfully and the buffer is left unchanged.
upToMarker := ssh.GetReceivedTextS(channelNum,'END_MARKER','utf-8');
if (ssh.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(ssh.LastErrorText);
    Exit;
  end;
Memo1.Lines.Add(upToMarker);

ssh.Disconnect();