Rust

SSH Tunnel with Dynamic Port Forwarding

See more SSH Examples

Demonstrates how to start a background thread that runs a portable SSH tunnel w/ dynamic port forwarding that the foreground thread can use for establishing connections through an SSH tunnel. Rust

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

let _ = false;

let tunnel = chilkat::SshTunnel::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.connect(&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.authenticate_pw("mySshLogin", "mySshPassword").is_err() {
    println!("{}", tunnel.last_error_text());
    return;
}

// Indicate that the background SSH tunnel thread will behave as a SOCKS proxy server
// with dynamic port forwarding:
tunnel.set_dynamic_port_forwarding(true);

// We may optionally require that connecting clients authenticate with our SOCKS proxy server.
// To do this, set an inbound username/password.  Any connecting clients would be required to 
// use SOCKS5 with the correct username/password.
// If no inbound username/password is set, then our SOCKS proxy server will accept both
// SOCKS4 and SOCKS5 unauthenticated connections.

tunnel.set_inbound_socks_username("chilkat123");
tunnel.set_inbound_socks_password("password123");

// Start the listen/accept thread to begin accepting SOCKS proxy client connections.
// Listen on port 1080.
if tunnel.begin_accepting(1080).is_err() {
    println!("{}", tunnel.last_error_text());
    return;
}

// Now that a background thread is running a SOCKS proxy server that forwards connections
// through an SSH tunnel, it is possible to use any Chilkat implemented protocol that is SOCKS capable,
// such as HTTP, POP3, SMTP, IMAP, FTP, etc.  The protocol may use SSL/TLS because the SSL/TLS
// will be passed through the SSH tunnel to the end-destination.  Also, any number of simultaneous
// connections may be routed through the SSH tunnel.

// For this example, let's do a simple HTTPS request:
let url = "https://www.ethereum.org/".to_string();

let http = chilkat::Http::new();

// Indicate that the HTTP object is to use our portable SOCKS proxy/SSH tunnel running in our background thread.
http.set_socks_hostname("localhost");
http.set_socks_port(1080);
http.set_socks_version(5);
http.set_socks_username("chilkat123");
http.set_socks_password("password123");

http.set_send_cookies(true);
http.set_save_cookies(true);
http.set_cookie_dir("memory");

// Do the HTTPS page fetch (through the SSH tunnel)
let Ok(html) = http.quick_get_str(&url) else {
    println!("{}", http.last_error_text());
    return;
};

// Stop the background listen/accept thread:
let wait_for_thread_exit = true;
if tunnel.stop_accepting(wait_for_thread_exit).is_err() {
    println!("{}", tunnel.last_error_text());
    return;
}

// Close the SSH tunnel (would also kick any remaining connected clients).
if tunnel.close_tunnel(wait_for_thread_exit).is_err() {
    println!("{}", tunnel.last_error_text());
    return;
}