stun

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, addrPort netip.AddrPort) []byte
• type TxID
  • func NewTxID() TxID
  • func ParseBindingRequest(b []byte) (TxID, error)
  • func ParseResponse(b []byte) (tID TxID, addr netip.AddrPort, err error)

Examples

• Request

Variables

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-Tailscale 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.

Example

package main

import (
	"fmt"

	"tailscale.com/net/stun"
)

func main() {
	txID := stun.NewTxID()
	req := stun.Request(txID)
	fmt.Printf("%x\n", req)
}

func Response

func Response(txID TxID, addrPort netip.AddrPort) []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 Tailscale.

func ParseResponse

func ParseResponse(b []byte) (tID TxID, addr netip.AddrPort, err error)

ParseResponse parses a successful binding response STUN packet. The IP address is extracted from the XOR-MAPPED-ADDRESS attribute.