Zig

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

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    var success: bool = false;

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

    success = false;

    const tunnel = try chilkat.SshTunnel.init();
    defer tunnel.deinit();

    const ssh_hostname = "sftp.example.com";
    const ssh_port = 22;

    // Connect to an SSH server and establish the SSH tunnel:
    tunnel.connect(ssh_hostname, ssh_port) catch {
        std.debug.print("{s}\n", .{try tunnel.getLastErrorText(alloc)});
        return;
    };

    // Authenticate with the SSH server via a login/password
    // or with a public key.
    // This example demonstrates SSH password authentication.
    tunnel.authenticatePw("mySshLogin", "mySshPassword") catch {
        std.debug.print("{s}\n", .{try tunnel.getLastErrorText(alloc)});
        return;
    };

    // Indicate that the background SSH tunnel thread will behave as a SOCKS proxy server
    // with dynamic port forwarding:
    tunnel.setDynamicPortForwarding(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.setInboundSocksUsername("chilkat123");
    tunnel.setInboundSocksPassword("password123");

    // Start the listen/accept thread to begin accepting SOCKS proxy client connections.
    // Listen on port 1080.
    tunnel.beginAccepting(1080) catch {
        std.debug.print("{s}\n", .{try tunnel.getLastErrorText(alloc)});
        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:
    const url = "https://www.ethereum.org/";

    const http = try chilkat.Http.init();
    defer http.deinit();

    // Indicate that the HTTP object is to use our portable SOCKS proxy/SSH tunnel running in our background thread.
    http.setSocksHostname("localhost");
    http.setSocksPort(1080);
    http.setSocksVersion(5);
    http.setSocksUsername("chilkat123");
    http.setSocksPassword("password123");

    http.setSendCookies(true);
    http.setSaveCookies(true);
    http.setCookieDir("memory");

    // Do the HTTPS page fetch (through the SSH tunnel)
    _ = http.quickGetStr(alloc, url) catch {
        std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
        return;
    };

    // Stop the background listen/accept thread:
    const wait_for_thread_exit = true;
    tunnel.stopAccepting(wait_for_thread_exit) catch {
        std.debug.print("{s}\n", .{try tunnel.getLastErrorText(alloc)});
        return;
    };

    // Close the SSH tunnel (would also kick any remaining connected clients).
    tunnel.closeTunnel(wait_for_thread_exit) catch {
        std.debug.print("{s}\n", .{try tunnel.getLastErrorText(alloc)});
        return;
    };
}