nat

Documentation

Index

• type Mapper
  • func NewPortMapper(log logging.Logger, r Router) Mapper
  • func (dev *Mapper) Map(protocol string, intPort uint16, desc string) (uint16, error)
  • func (dev *Mapper) UnmapAllPorts()
• type Router
  • func GetRouter() Router
  • func NewNoRouter() Router

Types

type Mapper

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

Mapper attempts to open a set of ports on a router

func NewPortMapper

func NewPortMapper(log logging.Logger, r Router) Mapper

NewPortMapper returns an initialized mapper

func (*Mapper) Map

func (dev *Mapper) Map(protocol string, intPort uint16, desc string) (uint16, error)

Map sets up port mapping using given protocol, internal and external ports and returns the final port mapped. It returns 0 if mapping failed after the maximun number of retries

func (*Mapper) UnmapAllPorts

func (dev *Mapper) UnmapAllPorts()

UnmapAllPorts stops mapping all ports from this mapper and attempts to unmap them.

type Router

type Router interface {
	MapPort(protocol string, intPort, extPort uint16, desc string, duration time.Duration) error
	UnmapPort(protocol string, intPort, extPort uint16) error
	ExternalIP() (net.IP, error)
	GetPortMappingEntry(extPort uint16, protocol string) (
		InternalIP string,
		InternalPort uint16,
		Description string,
		err error,
	)
}

Router describes the functionality that a network device must support to be able to open ports to an external IP.

func GetRouter

func GetRouter() Router

GetRouter returns a router on the current network.

func NewNoRouter

func NewNoRouter() Router

NewNoRouter returns a router that assumes the network is public