stun

package

v0.1.1 Latest Latest Go to latest Published: Mar 27, 2022 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/pairmesh/pairmesh

Links

Open Source Insights

Documentation ¶

Overview ¶

Package stun generates STUN request packets and parses response packets.

Index ¶

Variables
func Is(b []byte) bool
func Request(tID TxID) []byte
func Response(txID TxID, ip net.IP, port uint16) []byte
type TxID

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNotSTUN            = errors.New("response is not a STUN packet")
	ErrNotSuccessResponse = errors.New("STUN packet is not a response")
	ErrMalformedAttrs     = errors.New("STUN response has malformed attributes")
	ErrNotBindingRequest  = errors.New("STUN request not a binding request")
	ErrWrongSoftware      = errors.New("STUN request came from non-PairMesh software")
	ErrNoFingerprint      = errors.New("STUN request didn't end in fingerprint")
	ErrWrongFingerprint   = errors.New("STUN request had bogus fingerprint")
)

Functions ¶

func Is ¶

func Is(b []byte) bool

Is reports whether b is a STUN message.

func Request ¶

func Request(tID TxID) []byte

Request generates a binding request STUN packet. The transaction ID, tID, should be a random sequence of bytes.

func Response ¶

func Response(txID TxID, ip net.IP, port uint16) []byte

Response generates a binding response.

Types ¶

type TxID ¶

type TxID [12]byte

TxID is a transaction ID.

func NewTxID ¶

func NewTxID() TxID

NewTxID returns a new random TxID.

func ParseBindingRequest ¶

func ParseBindingRequest(b []byte) (TxID, error)

ParseBindingRequest parses a STUN binding request.

It returns an error unless it advertises that it came from PairMesh.

func ParseResponse ¶

func ParseResponse(b []byte) (txID TxID, addr []byte, port uint16, err error)

ParseResponse parses a successful binding response STUN packet. The IP address is extracted from the XOR-MAPPED-ADDRESS attribute. The returned addr slice is owned by the caller and does not alias b.

Source Files ¶

View all Source files

stun.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL