(VB.NET UWP/WinRT) SSH Remote Shell

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

Chilkat Universal Windows Platform (UWP) / WinRT Downloads Chilkat for the Universal Windows Platform (UWP)

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

Dim ssh As New Chilkat.Ssh

' Hostname may be an IP address or hostname:
Dim hostname As String = "www.some-ssh-server.com"
Dim port As Integer = 22

' Connect to an SSH server:
Dim success As Boolean = Await ssh.ConnectAsync(hostname,port)
If (success <> True) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
End If


' Wait a max of 5 seconds when reading responses..
ssh.IdleTimeoutMs = 5000

' Authenticate using login/password:
success = Await ssh.AuthenticatePwAsync("myLogin","myPassword")
If (success <> True) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
End If


' Open a session channel.  (It is possible to have multiple
' session channels open simultaneously.)
Dim channelNum As Integer
channelNum = Await ssh.OpenSessionChannelAsync()
If (channelNum < 0) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
End If


' 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.)
Dim termType As String = "dumb"
Dim widthInChars As Integer = 120
Dim heightInChars As Integer = 40
' Use 0 for pixWidth and pixHeight when the dimensions
' are set in number-of-chars.
Dim pixWidth As Integer = 0
Dim pixHeight As Integer = 0
success = Await ssh.SendReqPtyAsync(channelNum,termType,widthInChars,heightInChars,pixWidth,pixHeight)
If (success <> True) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
End If


' Start a shell on the channel:
success = Await ssh.SendReqShellAsync(channelNum)
If (success <> True) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
End If


' Start a command in the remote shell.  This example
' will send a "ls" command to retrieve the directory listing.
success = Await ssh.ChannelSendStringAsync(channelNum,"ls" & vbCrLf,"ansi")
If (success <> True) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
End If


' 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.
success = Await ssh.ChannelSendEofAsync(channelNum)
If (success <> True) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
End If


' 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.
Dim n As Integer
Dim pollTimeoutMs As Integer = 2000
n = Await ssh.ChannelReadAndPollAsync(channelNum,pollTimeoutMs)
If (n < 0) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
End If


' Close the channel:
success = Await ssh.ChannelSendCloseAsync(channelNum)
If (success <> True) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
End If


' 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.
success = Await ssh.ChannelReceiveToCloseAsync(channelNum)
If (success <> True) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
End If


' Let's pickup the accumulated output of the command:
Dim cmdOutput As String = ssh.GetReceivedText(channelNum,"ansi")
If (ssh.LastMethodSuccess <> True) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
End If


' Display the remote shell's command output:
Debug.WriteLine(cmdOutput)

' Disconnect
ssh.Disconnect()