tunnel

Documentation

Index

• func SSHAgent() ssh.AuthMethod
• type Endpoint
  • func (endpoint *Endpoint) String() string
• type Manager
  • func (tm *Manager) Tunnel(tunnelCfg cfg.Tunnel) error
• type SSHTunnel
  • func (tunnel *SSHTunnel) Start() error

Functions

func SSHAgent

func SSHAgent() ssh.AuthMethod

SSHAgent uses the exposed ssh agent from SSH_AUTH_SOCK TODO: Allow an ssh key to be specified (for automated / server runs)

Types

type Endpoint

type Endpoint struct {
	Host string
	Port int
}

Endpoint contains a host and port tunnel endpoint.

func (*Endpoint) String

func (endpoint *Endpoint) String() string

String returns a formatted string describing the Endpoint

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager handles the collection of tunnels

func (*Manager) Tunnel

func (tm *Manager) Tunnel(tunnelCfg cfg.Tunnel) error

Tunnel opens the specified tunnel if it is not alreay open.

type SSHTunnel

type SSHTunnel struct {
	Local  *Endpoint
	Server *Endpoint
	Remote *Endpoint

	Config *ssh.ClientConfig
}

SSHTunnel holds pointers to Local, Server and Remote endpoints and an ssh configuration.

func (*SSHTunnel) Start

func (tunnel *SSHTunnel) Start() error

Start an ssh tunnel