Struct ssh_jumper_model::SshTunnelParams

pub struct SshTunnelParams<'tunnel> {
    pub jump_host: HostSocketParams<'tunnel>,
    pub jump_host_auth_params: JumpHostAuthParams<'tunnel>,
    pub local_socket: SocketAddr,
    pub target_socket: HostSocketParams<'tunnel>,
}

Parameters to create the SSH tunnel.

Fields

jump_host: HostSocketParams<'tunnel>

Jump host address and port.

jump_host_auth_params: JumpHostAuthParams<'tunnel>

SSH auth params for the jump host.

local_socket: SocketAddr

Local socket to forward to the target host.

target_socket: HostSocketParams<'tunnel>

Target host address and port.

Implementations

impl<'tunnel> SshTunnelParams<'tunnel>

pub fn new(
    jump_host: HostAddress<'tunnel>,
    jump_host_auth_params: JumpHostAuthParams<'tunnel>,
    target_socket: HostSocketParams<'tunnel>
) -> Self

Returns new SshTunnelParams.

The local socket IP is defaulted to 127.0.0.1. Use the with_local_ip method if you would like to change this.

The local socket port is defaulted to 0, which means the operating system will allocate a port upon binding. Use the with_local_port method if you would like to change this.

pub fn with_local_ip(self, ip: IpAddr) -> Self

Sets the local IP to use.

Useful if you are connecting over a VPN, and need to bind to the local IP for that network interface.

pub fn with_local_port(self, port: u16) -> Self

Sets the local port to use.

Useful if you want use a known port for forwarding.

pub fn with_jump_host_port(self, port: u16) -> Self

Sets the jump host port to use for SSH.

Useful if you do not want to use the default port for ssh.

Trait Implementations

impl<'tunnel> Clone for SshTunnelParams<'tunnel>

fn clone(&self) -> SshTunnelParams<'tunnel>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'tunnel> Debug for SshTunnelParams<'tunnel>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.