ssh_reverse_tunnel

README

ssh_reverse_tunnel

This is the SSH Client for Reverse Tunneling in Golang

Golang

• Golang: 1.10
• Go Dep: link

Documentation

Index

• Variables
• func OpenSSHAuthMethod(keyFile string) (ssh.AuthMethod, error)
• type Client
  • func NewClient(config ClientConfig) *Client
  • func (c *Client) Close() error
  • func (c *Client) Connect() (err error)
• type ClientConfig
• type Endpoint
  • func (endpoint Endpoint) String() string

Variables

var (
	CanelledError = errors.New("Cancelled")
)

var (
	PEMDecodeError = errors.New("Cannot Decode PEM.")
)

Functions

func OpenSSHAuthMethod

func OpenSSHAuthMethod(keyFile string) (ssh.AuthMethod, error)

Types

type Client

type Client struct {
	*ssh.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient(config ClientConfig) *Client

func (*Client) Close

func (c *Client) Close() error

func (*Client) Connect

func (c *Client) Connect() (err error)

type ClientConfig

type ClientConfig struct {
	ssh.ClientConfig

	RetryInterval time.Duration
	SSHServer     Endpoint

	Remote Endpoint
	Local  Endpoint
}

ClientConfig will confgure SSH connection and reserve tunnel.

type Endpoint

type Endpoint struct {
	Host string
	Port int

	ConnectTimeout time.Duration
}

Endpoint is a network location, with host and port.

func (Endpoint) String

func (endpoint Endpoint) String() string