Sample code for 30+ languages & platforms
Rust

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

Rust

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

let ssh = chilkat::Ssh::new();

let ssh_port = 22;
if ssh.connect("ssh.example.com", ssh_port).is_err() {
    println!("{}", ssh.last_error_text());
    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.
let password = "mySshPassword".to_string();

if ssh.authenticate_pw("mySshLogin", &password).is_err() {
    println!("{}", ssh.last_error_text());
    return;
}

// Request an application-defined channel type.  The server must support it.
let channel_type = "my-custom-channel@example.com".to_string();
let channel_num = ssh.open_custom_channel(&channel_type);
if channel_num < 0 {
    println!("{}", ssh.last_error_text());
    return;
}

println!("Opened custom channel: {}", channel_num);

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

ssh.disconnect();