Java

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

Download Chilkat for Java

Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Ssh;

public class ChilkatExample {

    public static void main(String[] args) {
        // 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.

        Ssh ssh = new Ssh();

        int sshPort = 22;
        try {
            ssh.connect("ssh.example.com", sshPort);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // 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.
        String password = "mySshPassword";

        try {
            ssh.authenticatePw("mySshLogin", password);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Request an application-defined channel type.  The server must support it.
        String channelType = "my-custom-channel@example.com";
        int channelNum = ssh.openCustomChannel(channelType);
        if (channelNum < 0) {
            System.out.println(ssh.getLastErrorText());
            return;
        }

        System.out.println("Opened custom channel: " + channelNum);

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

        ssh.disconnect();
    }
}