minitunnel

Documentation

Overview

The minitunnel package implements bidirectional TCP tunnels over any io.ReadWriter. It does this in a way similar to the ssh -L command. Tunnel construction requires a source port, destination host, and destination port.

minitunnel supports multiple connections and multiple tunnels over a single transport.

Index

• Constants
• func ListenAndServe(transport io.ReadWriteCloser) error
• type Tunnel
  • func Dial(transport io.ReadWriteCloser) (*Tunnel, error)
  • func (t *Tunnel) CloseForward(id int) error
  • func (t *Tunnel) Forward(source int, host string, dest int) error
  • func (t *Tunnel) ListForwards() map[int]string
  • func (t *Tunnel) Reverse(source int, host string, dest int) error

Constants

const (
	HANDSHAKE = iota
	CONNECT
	CLOSED
	DATA
	FORWARD
)

tunnel message types

const BufferSize = 32768

Functions

func ListenAndServe

func ListenAndServe(transport io.ReadWriteCloser) error

Listen for an incoming Tunnel connection. Only one tunnel connection is permitted. ListenAndServe will block indefinitely until an error occurs.

Types

type Tunnel

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

func Dial

func Dial(transport io.ReadWriteCloser) (*Tunnel, error)

Dial a listening minitunnel. Only one tunnel connection is permitted per transport.

func (*Tunnel) CloseForward

func (t *Tunnel) CloseForward(id int) error

func (*Tunnel) Forward

func (t *Tunnel) Forward(source int, host string, dest int) error

Forward a local port to a remote host and destination port

func (*Tunnel) ListForwards

func (t *Tunnel) ListForwards() map[int]string

func (*Tunnel) Reverse

func (t *Tunnel) Reverse(source int, host string, dest int) error

Create a reverse forwarded port from a source port on the remote end, destination host, and destination port on the local end.