The highest tagged major version is v3.

portfwd

package

v2.4.0 Latest Latest Go to latest Published: Jul 9, 2021 License: AGPL-3.0 Imports: 10 Imported by: 0

Details

Package portfwd provides an SSH port forwarder.

This section is empty.

This section is empty.

func ReadAuthFromIdentityFile(identityFilename string) (ssh.AuthMethod, error)

ReadAuthFromIdentityFile reads an identity file and returns an AuthMethod that uses the given key pairs.

func SSHAgent() ssh.AuthMethod

SSHAgent returns an auth method that runs the given function to obtain a list of key pairs.

type Endpoints struct {
	Local  string
	Server string
	Remote string
}

Endpoints contains addresses of an SSH tunnel components.

type SSHTunnel struct {
	Endpoints Endpoints
	Config    *ssh.ClientConfig
	// contains filtered or unexported fields
}

SSHTunnel describes a tunnel structure.

func NewTunnel(localEndpoint, serverEndpoint, remoteEndpoint string, sshConfig *ssh.ClientConfig) *SSHTunnel

NewTunnel create a new tunnel.

func (tunnel *SSHTunnel) Listen(ctx context.Context) error

Listen waits for and processes connections to the SSH tunnel.

func (tunnel *SSHTunnel) Open() error

Open starts an ssh tunnel.

func (tunnel *SSHTunnel) Stop() error

Stop stops the SSH tunnel.