proxy

package

v0.0.0-...-7edf0cb Latest Latest Go to latest Published: Nov 24, 2019 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	PrivateKeyPath string
	RemoteUser     string
	RemoteAddress  string
}

Config is used to store configuraiton information for the SSH Proxy

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

SSHProxy is a ssh client that port forwards based on configuration information.

func New(cfg *Config) (*SSHProxy, error)

New creates an instance of an SSHProxy

func (p *SSHProxy) Connect() error

Connect makes the ssh connection to the remote host

func (p *SSHProxy) Forward(remote, localPort string) (string, error)

Forward forwards a remote addess to a local port. Set localPort to 0 to generate a random port.

func (p *SSHProxy) Shutdown()

Shutdown waits for all connections to stop

func (p *SSHProxy) WithContext(ctx context.Context)

WithContext sets the current context value