proxy

README

socks5-proxy

This is a go library for starting a socks5 proxy server via SSH.

It is intended to be used as a library by Golang CLIs that need to proxy via an SSH jumpbox, which is a common configuration for BOSH operators, so several CLIs in Cloud Foundry could benefit from its use.

Documentation

Index

• func NewSSHClientConfig(user string, hostKeyCallback ssh.HostKeyCallback, ...) *ssh.ClientConfig
• func StartTestSSHServer(httpServerURL, sshPrivateKey, userName string) string
• type DialFunc
• type HostKey
  • func NewHostKey() HostKey
  • func (h HostKey) Get(username, privateKey, serverURL string) (ssh.PublicKey, error)
• type Socks5Proxy
  • func NewSocks5Proxy(hostKey hostKey, logger *log.Logger, keepAliveInterval time.Duration) *Socks5Proxy
  • func (s *Socks5Proxy) Addr() (string, error)
  • func (s *Socks5Proxy) Dialer(username, key, url string) (DialFunc, error)
  • func (s *Socks5Proxy) Start(username, key, url string) error
  • func (s *Socks5Proxy) StartWithDialer(dialer DialFunc) error

Functions

func NewSSHClientConfig

func NewSSHClientConfig(user string, hostKeyCallback ssh.HostKeyCallback, authMethods ...ssh.AuthMethod) *ssh.ClientConfig

func StartTestSSHServer

func StartTestSSHServer(httpServerURL, sshPrivateKey, userName string) string

Types

type DialFunc

type DialFunc func(network, address string) (net.Conn, error)

type HostKey

type HostKey struct{}

func NewHostKey

func NewHostKey() HostKey

func (HostKey) Get

func (h HostKey) Get(username, privateKey, serverURL string) (ssh.PublicKey, error)

type Socks5Proxy

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

func NewSocks5Proxy

func NewSocks5Proxy(hostKey hostKey, logger *log.Logger, keepAliveInterval time.Duration) *Socks5Proxy

func (*Socks5Proxy) Addr

func (s *Socks5Proxy) Addr() (string, error)

func (*Socks5Proxy) Dialer

func (s *Socks5Proxy) Dialer(username, key, url string) (DialFunc, error)

func (*Socks5Proxy) Start

func (s *Socks5Proxy) Start(username, key, url string) error

func (*Socks5Proxy) StartWithDialer

func (s *Socks5Proxy) StartWithDialer(dialer DialFunc) error