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.

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoSsh
    Integer iSshPort
    String sPassword
    Integer iChannelNum
    Integer iPollTimeoutMs
    Integer iResult
    String sUpToMarker
    String sTemp1
    Boolean bTemp1

    Move False To iSuccess

    //  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.

    Get Create (RefClass(cComChilkatSsh)) To hoSsh
    If (Not(IsComObjectCreated(hoSsh))) Begin
        Send CreateComObject of hoSsh
    End

    Move 22 To iSshPort
    Get ComConnect Of hoSsh "ssh.example.com" iSshPort To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    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.
    Move "mySshPassword" To sPassword

    Get ComAuthenticatePw Of hoSsh "mySshLogin" sPassword To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComOpenSessionChannel Of hoSsh To iChannelNum
    If (iChannelNum < 0) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    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.
    Get ComSendReqShell Of hoSsh iChannelNum To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComChannelSendString Of hoSsh iChannelNum "echo BEGIN; ls /tmp; echo END_MARKER" + (character(10)) "utf-8" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Move 1000 To iPollTimeoutMs
    Get ComChannelReadAndPoll Of hoSsh iChannelNum iPollTimeoutMs To iResult
    If (iResult = -1) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    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.
    Get ComGetReceivedTextS Of hoSsh iChannelNum "END_MARKER" "utf-8" To sUpToMarker
    Get ComLastMethodSuccess Of hoSsh To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln sUpToMarker

    Send ComDisconnect To hoSsh


End_Procedure