nattraversal

Documentation

Overview

Package nattraversal provides tools for acquiring ports on a Network Address Translator (NAT).

Index

• func AcquirePortFromGateway(gateway UPNPGateway, port uint16) error
• func GetExternalIP() (string, error)
• type UPNPGateway
  • func DiscoverUPNPGateway() (UPNPGateway, error)

Functions

func AcquirePortFromGateway

func AcquirePortFromGateway(gateway UPNPGateway, port uint16) error

AcquirePortFromGateway sets up UDP and TCP forwarding rules for the given port on the given gateway.

func GetExternalIP

func GetExternalIP() (string, error)

GetExternalIP returns a string formatted external IP address from a UPnP-enabled NAT on the network, if such device is discovered.

Types

type UPNPGateway

type UPNPGateway interface {
	Forward(port uint16, desc string) error
	Clear(port uint16) error
}

UPNPGateway is the interface of a UPnP gateway. It supports forwarding a port and clearing a forwarding rule.

func DiscoverUPNPGateway

func DiscoverUPNPGateway() (UPNPGateway, error)

DiscoverUPNPGateway returns a UPNPGateway if one is found on the network. This process is long - about 30 seconds and is expected to fail in some network setups.