Start a Remote Shell with QuickShell

See more SSH Examples

Demonstrates the Chilkat Ssh.QuickShell method, which starts a remote shell using the simplified sequence OpenSessionChannel → SendReqPty → SendReqShell. It takes no arguments and returns the shell channel number, or -1 on failure. The default PTY size is 80 columns by 24 rows.

var
success: Boolean;
ssh: HCkSsh;
sshPort: Integer;
password: PWideChar;
channelNum: Integer;
caseSensitive: Boolean;
output: PWideChar;

begin
success := False;

//  Demonstrates the Ssh.QuickShell method, which starts a remote shell using the simplified
//  sequence OpenSessionChannel, SendReqPty, and SendReqShell.  It takes no arguments and returns
//  the shell channel number, or -1 on failure.  The default PTY size is 80 columns by 24 rows.

ssh := CkSsh_Create();

sshPort := 22;
success := CkSsh_Connect(ssh,'ssh.example.com',sshPort);
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;

//  Start the shell.  Note that QuickShell allocates a PTY, so the remote shell runs
//  interactively: it prints a command prompt and echoes the commands that are sent to it.
channelNum := CkSsh_QuickShell(ssh);
if (channelNum < 0) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

//  QuickShell returns as soon as the shell request is accepted -- it does not wait for or
//  consume the initial login text or prompt.
success := CkSsh_ChannelSendString(ssh,channelNum,'uname -a; echo DONE_MARKER' + #10,'utf-8');
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    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.
CkSsh_putReadTimeoutMs(ssh,15000);

caseSensitive := False;
success := CkSsh_ChannelReceiveUntilMatch(ssh,channelNum,'DONE_MARKER','utf-8',caseSensitive);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

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

CkSsh_Disconnect(ssh);

CkSsh_Dispose(ssh);