ssh

Documentation

Index

• type Endpoint
  • func (endpoint *Endpoint) String() string
• type SSH
  • func NewTunnel(host, tunnelHost, tunnelUser, tunnelPassword, tunnelPrivateKey string, ...) (*SSH, error)
  • func (tunnel *SSH) Start(wg *sync.WaitGroup) error

Types

type Endpoint

type Endpoint struct {
	// Server host address
	Host string
	// Server port
	Port int
}

Endpoint represents a Host/port combo

func (*Endpoint) String

func (endpoint *Endpoint) String() string

type SSH

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

	Config *ssh.ClientConfig
}

SSH represents a local/remote/tunnel combination

func NewTunnel

func NewTunnel(host, tunnelHost, tunnelUser,
	tunnelPassword, tunnelPrivateKey string, tunnelRequired bool) (*SSH, error)

NewTunnel will create a string of the form "host:port", and will establish an SSH tunnel if necessary to create a string that can be used to connect to a remote machine

func (*SSH) Start

func (tunnel *SSH) Start(wg *sync.WaitGroup) error

Start opens a persistent tunnel