net

Documentation

Index

• func IsPrivateAddress(ip net.IP) bool
• func Relay(leftConn, rightConn DuplexConn) (int64, int64, error)
• type ConnectionError
  • func NewConnectionError(status, message string, cause error) *ConnectionError
  • func RequirePublicIP(ip net.IP) *ConnectionError
• type DuplexConn
• type TargetIPValidator

Functions

func IsPrivateAddress

func IsPrivateAddress(ip net.IP) bool

IsPrivateAddress returns whether an IP address belongs to the LAN.

func Relay

func Relay(leftConn, rightConn DuplexConn) (int64, int64, error)

Relay copies between left and right bidirectionally. Returns number of bytes copied from right to left, from left to right, and any error occurred. Relay allows for half-closed connections: if one side is done writing, it can still read all remaining data from its peer.

Types

type ConnectionError

type ConnectionError struct {
	// TODO: create status enums and move to metrics.go
	Status  string
	Message string
	Cause   error
}

func NewConnectionError

func NewConnectionError(status, message string, cause error) *ConnectionError

func RequirePublicIP

func RequirePublicIP(ip net.IP) *ConnectionError

RequirePublicIP returns an error if the destination IP is not a standard public IP.

type DuplexConn

type DuplexConn = transport.StreamConn

type TargetIPValidator

type TargetIPValidator = func(net.IP) *ConnectionError

TargetIPValidator is a type alias for checking if an IP is allowed.