Sample code for 30+ languages & platforms
Lianja

Open a Custom SSH Channel Type

See more SSH Examples

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 Lianja Downloads

Lianja
llSuccess = .F.

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

loSsh = createobject("CkSsh")

lnSshPort = 22
llSuccess = loSsh.Connect("ssh.example.com",lnSshPort)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

//  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.
lcPassword = "mySshPassword"

llSuccess = loSsh.AuthenticatePw("mySshLogin",lcPassword)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

//  Request an application-defined channel type.  The server must support it.
lcChannelType = "my-custom-channel@example.com"
lnChannelNum = loSsh.OpenCustomChannel(lcChannelType)
if (lnChannelNum < 0) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

? "Opened custom channel: " + str(lnChannelNum)

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

loSsh.Disconnect()


release loSsh