B4X

Open a Custom SSH Channel Type

Demonstrates the Chilkat Ssh.OpenCustomChannel method, which requests a channel whose application-defined type is supplied as the only argument. It returns the channel number, or -1 if the server rejects the channel. The server must implement that channel type.

Background: The SSH protocol allows vendor- and application-specific channel types beyond the standard session and direct-tcpip kinds; by convention these carry an @domain suffix to avoid name collisions. This method is the escape hatch for talking to a server that implements such a type. On rejection, inspect ChannelOpenFailCode to learn why.

Chilkat B4X Downloads

Download Chilkat for B4X

B4X

Dim success As Boolean = False

'  Demonstrates the Ssh.OpenCustomChannel method, which requests a custom SSH channel whose
'  application-defined type is supplied as the only argument.  It returns the channel number,
'  or -1 if the server rejects the channel.  The server must implement that channel type.

Dim ssh As ChilkatSsh
ssh.Initialize("ssh")

Dim sshPort As Int = 22
success = ssh.Connect("ssh.example.com", sshPort)
If success = False Then
    Log(ssh.LastErrorText)
    Return
End If


'  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.
Dim password As String = "mySshPassword"

success = ssh.AuthenticatePw("mySshLogin", password)
If success = False Then
    Log(ssh.LastErrorText)
    Return
End If


'  Request an application-defined channel type.  The server must support it.
Dim channelType As String = "my-custom-channel@example.com"
Dim channelNum As Int = ssh.OpenCustomChannel(channelType)
If channelNum < 0 Then
    Log(ssh.LastErrorText)
    Return
End If


Log("Opened custom channel: " & channelNum)

'  The channel is used with the normal channel send, receive, EOF, CLOSE, and release methods.

ssh.Disconnect