ssh

Documentation

Index

• func Agent() ssh.AuthMethod
• func DefaultClientConfig() ssh.ClientConfig
• func RandPort(lo, hi int) int
• type HostPort
• type Tunnel
  • func (tunnel *Tunnel) Start() error

Functions

func Agent

func Agent() ssh.AuthMethod

Agent returns the auth method using SSH agent

func DefaultClientConfig

func DefaultClientConfig() ssh.ClientConfig

DefaultClientConfig returns the default settings of the ssh client

func RandPort

func RandPort(lo, hi int) int

RandPort picks a port from the given range randomly. It doesn't check if a port has been allocated.

Types

type HostPort

type HostPort string

HostPort is host:port

type Tunnel

type Tunnel struct {
	// Local is the local endpoint for all clients
	Local HostPort
	// Server is the middle server listening on SSH port
	Server HostPort
	// Remote is the backend that's not accessible without going through the server endpoint
	Remote HostPort

	Config *ssh.ClientConfig
}

Tunnel is a forwarder of local ssh traffic to a remote endpoint

func (*Tunnel) Start

func (tunnel *Tunnel) Start() error

Start starts the tunnel