(DataFlex) SSH Remote Shell

Demonstrates how to start a shell on a remote SSH server, run a command, and retrieve the output.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoSsh
    String sHostname
    Integer iPort
    Boolean iSuccess
    Integer iChannelNum
    String sTermType
    Integer iWidthInChars
    Integer iHeightInChars
    Integer iPixWidth
    Integer iPixHeight
    Integer n
    Integer iPollTimeoutMs
    String sCmdOutput
    String sTemp1
    Boolean bTemp1

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

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

    // Hostname may be an IP address or hostname:
    Move "www.some-ssh-server.com" To sHostname
    Move 22 To iPort

    // Connect to an SSH server:
    Get ComConnect Of hoSsh sHostname iPort To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Wait a max of 5 seconds when reading responses..
    Set ComIdleTimeoutMs Of hoSsh To 5000

    // Authenticate using login/password:
    Get ComAuthenticatePw Of hoSsh "myLogin" "myPassword" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Open a session channel.  (It is possible to have multiple
    // session channels open simultaneously.)

    Get ComOpenSessionChannel Of hoSsh To iChannelNum
    If (iChannelNum < 0) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Some SSH servers require a pseudo-terminal
    // If so, include the call to SendReqPty.  If not, then 
    // comment out the call to SendReqPty.
    // Note: The 2nd argument of SendReqPty is the terminal type,
    // which should be something like "xterm", "vt100", "dumb", etc.
    // A "dumb" terminal is one that cannot process escape sequences.
    // Smart terminals, such as "xterm", "vt100", etc. process
    // escape sequences.  If you select a type of smart terminal,
    // your application will receive these escape sequences
    // included in the command's output.  Use "dumb" if you do not
    // want to receive escape sequences.  (Assuming your SSH
    // server recognizes "dumb" as a standard dumb terminal.)
    Move "dumb" To sTermType
    Move 120 To iWidthInChars
    Move 40 To iHeightInChars
    // Use 0 for pixWidth and pixHeight when the dimensions
    // are set in number-of-chars.
    Move 0 To iPixWidth
    Move 0 To iPixHeight
    Get ComSendReqPty Of hoSsh iChannelNum sTermType iWidthInChars iHeightInChars iPixWidth iPixHeight To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Start a shell on the channel:
    Get ComSendReqShell Of hoSsh iChannelNum To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Start a command in the remote shell.  This example
    // will send a "ls" command to retrieve the directory listing.
    Get ComChannelSendString Of hoSsh iChannelNum "ls" + (character(13)) + (character(10)) "ansi" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Send an EOF.  This tells the server that no more data will 
    // be sent on this channel.  The channel remains open, and
    // the SSH client may still receive output on this channel.
    Get ComChannelSendEof Of hoSsh iChannelNum To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Read whatever output may already be available on the
    // SSH connection.  ChannelReadAndPoll returns the number of bytes
    // that are available in the channel's internal buffer that
    // are ready to be "picked up" by calling GetReceivedText
    // or GetReceivedData.
    // A return value of -1 indicates failure.
    // A return value of -2 indicates a failure via timeout.

    // The ChannelReadAndPoll method waits
    // for data to arrive on the connection usingi the IdleTimeoutMs
    // property setting.  Once the first data arrives, it continues
    // reading but instead uses the pollTimeoutMs passed in the 2nd argument:
    // A return value of -2 indicates a timeout where no data is received.

    Move 2000 To iPollTimeoutMs
    Get ComChannelReadAndPoll Of hoSsh iChannelNum iPollTimeoutMs To n
    If (n < 0) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Close the channel:
    Get ComChannelSendClose Of hoSsh iChannelNum To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Perhaps we did not receive all of the commands output.
    // To make sure,  call ChannelReceiveToClose to accumulate any remaining
    // output until the server's corresponding "channel close" is received.
    Get ComChannelReceiveToClose Of hoSsh iChannelNum To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Let's pickup the accumulated output of the command:
    Get ComGetReceivedText Of hoSsh iChannelNum "ansi" To sCmdOutput
    Get ComLastMethodSuccess Of hoSsh To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Display the remote shell's command output:
    Showln sCmdOutput

    // Disconnect
    Send ComDisconnect To hoSsh


End_Procedure