portfwd

Documentation

Overview

Package portfwd provides an SSH port forwarder.

Index

• func ReadAuthFromIdentityFile(identityFilename string) (ssh.AuthMethod, error)
• func SSHAgent() ssh.AuthMethod
• type Endpoints
• type SSHTunnel
  • func NewTunnel(localEndpoint, serverEndpoint, remoteEndpoint string, ...) *SSHTunnel
  • func (tunnel *SSHTunnel) Listen(ctx context.Context) error
  • func (tunnel *SSHTunnel) Open() error
  • func (tunnel *SSHTunnel) Stop() error

Functions

func ReadAuthFromIdentityFile

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

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

func SSHAgent

func SSHAgent() ssh.AuthMethod

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

Types

type Endpoints

type Endpoints struct {
	Local  string
	Server string
	Remote string
}

Endpoints contains addresses of an SSH tunnel components.

type SSHTunnel

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

SSHTunnel describes a tunnel structure.

func NewTunnel

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

NewTunnel create a new tunnel.

func (*SSHTunnel) Listen

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

Listen waits for and processes connections to the SSH tunnel.

func (*SSHTunnel) Open

func (tunnel *SSHTunnel) Open() error

Open starts an ssh tunnel.

func (*SSHTunnel) Stop

func (tunnel *SSHTunnel) Stop() error

Stop stops the SSH tunnel.