Rust Requires Chilkat v11.0.0+

WebSocket through SSH Tunnel

See more WebSocket Examples

This example shows how to establish a WebSocket connection through an SSH tunnel. The WebSocket protocol communications will be encapsulated within an SSH tunnel. Rust

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

// --------------------------------------------------
// This example borrows the code from the REST through SSH Tunnel example.
// We first use the Chilkat Socket object to establish a connection to the WebSocket server through an SSH Tunnel.
// Next, the Rest object uses the Socket object for its connection.
// Finally, the WebSocket object uses the Rest object for its connection.  
// 
// Hopefully the flexibility of this architecture is easy to see.  All of the HTTP functionality of the Rest object,
// such as HTTP authentication, custom headers, etc. is available to the WebSocket.  Likewise, all of the advanced functionality
// of the Socket object is in turn available to the Rest object.  

// The high-level steps for accomplishing the task of running the WebSocket protocol through an SSH accomplished as follows:
// 1) Create the SSH tunnel using Chilkat Socket.
// 2) Open a port-forwarding channel (to the WebSocket server) within the tunnel.
// 2) Tell Rest to use the Socket object.
// 3) Tell WebSocket to use the Rest object.

let tunnel = chilkat::Socket::new();

let ssh_hostname = "sftp.example.com".to_string();
let ssh_port = 22;

// Connect to an SSH server and establish the SSH tunnel:
if tunnel.ssh_open_tunnel(&ssh_hostname, ssh_port).is_err() {
    println!("{}", tunnel.last_error_text());
    return;
}

// Authenticate with the SSH server via a login/password
// or with a public key.
// This example demonstrates SSH password authentication.
if tunnel.ssh_authenticate_pw("mySshLogin", "mySshPassword").is_err() {
    println!("{}", tunnel.last_error_text());
    return;
}

//  OK, the SSH tunnel is setup.  Now open a channel within the tunnel.

let b_tls = true;
let port = 443;
let max_wait_ms = 5000;

// This returns a socket object that is a single channel within the SSH tunnel.
// The SSH channel is our logical port-forwarded connection through the SSH tunnel.
// Note: This example establishes a TLS connection to the target WebSocket server.
// (The TLS protocol will run on the logical channel within the SSH tunnel.)
// Your application can just as easily make a non-TLS connection by changing the arguments
// passed to SshNewChannel.
let channel = chilkat::Socket::new();
if tunnel.ssh_new_channel("some-websocket-server.com", port, b_tls, max_wait_ms, &channel).is_err() {
    println!("{}", tunnel.last_error_text());
    return;
}

// Create a REST object and tell it to use the SSH channel.
// This connection is a TLS running on an SSH channel through an SSH tunnel.
// In other words, TLS is wrapped within the SSH tunnel.
let rest = chilkat::Rest::new();
if rest.use_connection(&channel, false).is_err() {
    println!("{}", rest.last_error_text());
    return;
}

// Finally, tell our WebSocket object to use the Rest object..
let ws = chilkat::WebSocket::new();

// Tell the WebSocket to use this connection.
if ws.use_connection(&rest).is_err() {
    println!("{}", ws.last_error_text());
    return;
}

// Add the standard WebSocket open handshake headers that will be needed.
// (This adds the required HTTP request headers to the rest object.)
let _ = ws.add_client_headers();

// Add any additional headers that might be desired.
// Two common WebSocketSpecific headers are "Sec-WebSocket-Protocol" and "Origin".
let _ = rest.add_header("Sec-WebSocket-Protocol", "x-some-websocket-subprotocol");
let _ = rest.add_header("Origin", "http://some-websocket-server.com");

// Do the open handshake.
let Ok(response_body) = rest.full_request_no_body("GET", "/something") else {
    println!("{}", rest.last_error_text());
    return;
};

// If successful, the HTTP response status code should be 101,
// and the response body will be empty. (If it failed, we'll have a look
// at the response body..)
let status_code = rest.response_status_code();
println!("Response status code: {}", status_code);

if status_code != 101 {
    println!("{}", response_body);
    println!("-- Failed because of unexpected response status code.");
    return;
}

// We have the expected 101 response, so let's now validate the 
// contents of the response, such as the value sent by the server in the
// Sec-WebSocket-Accept header. 
if ws.validate_server_handshake().is_err() {
    println!("{}", ws.last_error_text());
    return;
}

println!("WebSocket connection successful.");

// The application may now begin sending and receiving frames on the WebSocket connection.
// (At this point, we're done with the rest object...)