Files
go-stun/stuncheck/stuncheck.go
2025-07-22 03:11:23 +00:00

359 lines
9.5 KiB
Go

package stuncheck
import (
"errors"
"net"
"time"
"github.com/oneclickvirt/gostun/model"
"github.com/pion/stun/v2"
)
// From https://github.com/pion/stun/blob/master/cmd/stun-nat-behaviour/main.go
type stunServerConn struct {
conn net.PacketConn
LocalAddr net.Addr
RemoteAddr *net.UDPAddr
OtherAddr *net.UDPAddr
messageChan chan *stun.Message
}
func (c *stunServerConn) Close() error {
return c.conn.Close()
}
const (
messageHeaderSize = 20
)
var (
errResponseMessage = errors.New("error reading from response message channel")
errTimedOut = errors.New("timed out waiting for response")
errNoOtherAddress = errors.New("no OTHER-ADDRESS in message")
)
func isIPv6Address(addr string) bool {
host, _, err := net.SplitHostPort(addr)
if err != nil {
return false
}
ip := net.ParseIP(host)
return ip != nil && ip.To4() == nil
}
func getNetworkType(addrStr string) string {
switch model.IPVersion {
case "ipv6":
return "udp6"
case "ipv4":
return "udp4"
case "both":
if isIPv6Address(addrStr) {
return "udp6"
}
return "udp4"
}
return "udp4"
}
func MappingTests(addrStr string) error { //nolint:cyclop
mapTestConn, err := connect(addrStr)
if err != nil {
if model.EnableLoger {
model.Log.Warnf("Error creating STUN connection: %s", err)
}
return err
}
if model.EnableLoger {
model.Log.Info("Mapping Test I: Regular binding request")
}
request := stun.MustBuild(stun.TransactionID, stun.BindingRequest)
resp, err := mapTestConn.roundTrip(request, mapTestConn.RemoteAddr)
if err != nil {
return err
}
resps1 := parse(resp)
if resps1.xorAddr == nil || resps1.otherAddr == nil {
if model.EnableLoger {
model.Log.Info("Error: NAT discovery feature not supported by this server")
}
return errNoOtherAddress
}
networkType := getNetworkType(addrStr)
addr, err := net.ResolveUDPAddr(networkType, resps1.otherAddr.String())
if err != nil {
if model.EnableLoger {
model.Log.Infof("Failed resolving OTHER-ADDRESS: %v", resps1.otherAddr)
}
return err
}
mapTestConn.OtherAddr = addr
if model.EnableLoger {
model.Log.Infof("Received XOR-MAPPED-ADDRESS: %v", resps1.xorAddr)
}
if resps1.xorAddr.String() == mapTestConn.LocalAddr.String() {
model.NatMappingBehavior = "endpoint independent (no NAT)"
if model.EnableLoger {
model.Log.Warn("=> NAT mapping behavior: endpoint independent (no NAT)")
}
return nil
}
if model.EnableLoger {
model.Log.Info("Mapping Test II: Send binding request to the other address but primary port")
}
oaddr := *mapTestConn.OtherAddr
oaddr.Port = mapTestConn.RemoteAddr.Port
resp, err = mapTestConn.roundTrip(request, &oaddr)
if err != nil {
return err
}
resps2 := parse(resp)
if model.EnableLoger {
model.Log.Infof("Received XOR-MAPPED-ADDRESS: %v", resps2.xorAddr)
}
if resps2.xorAddr.String() == resps1.xorAddr.String() {
model.NatMappingBehavior = "endpoint independent"
if model.EnableLoger {
model.Log.Warn("=> NAT mapping behavior: endpoint independent")
}
return nil
}
if model.EnableLoger {
model.Log.Info("Mapping Test III: Send binding request to the other address and port")
}
resp, err = mapTestConn.roundTrip(request, mapTestConn.OtherAddr)
if err != nil {
return err
}
resps3 := parse(resp)
if model.EnableLoger {
model.Log.Infof("Received XOR-MAPPED-ADDRESS: %v", resps3.xorAddr)
}
if resps3.xorAddr.String() == resps2.xorAddr.String() {
model.NatMappingBehavior = "address dependent"
if model.EnableLoger {
model.Log.Warn("=> NAT mapping behavior: address dependent")
}
} else {
model.NatMappingBehavior = "address and port dependent"
if model.EnableLoger {
model.Log.Warn("=> NAT mapping behavior: address and port dependent")
}
}
return mapTestConn.Close()
}
func FilteringTests(addrStr string) error { //nolint:cyclop
mapTestConn, err := connect(addrStr)
if err != nil {
if model.EnableLoger {
model.Log.Warnf("Error creating STUN connection: %s", err)
}
return err
}
if model.EnableLoger {
model.Log.Info("Filtering Test I: Regular binding request")
}
request := stun.MustBuild(stun.TransactionID, stun.BindingRequest)
resp, err := mapTestConn.roundTrip(request, mapTestConn.RemoteAddr)
if err != nil || errors.Is(err, errTimedOut) {
return err
}
resps := parse(resp)
if resps.xorAddr == nil || resps.otherAddr == nil {
if model.EnableLoger {
model.Log.Warn("Error: NAT discovery feature not supported by this server")
}
return errNoOtherAddress
}
networkType := getNetworkType(addrStr)
addr, err := net.ResolveUDPAddr(networkType, resps.otherAddr.String())
if err != nil {
if model.EnableLoger {
model.Log.Infof("Failed resolving OTHER-ADDRESS: %v", resps.otherAddr)
}
return err
}
mapTestConn.OtherAddr = addr
if model.EnableLoger {
model.Log.Info("Filtering Test II: Request to change both IP and port")
}
request = stun.MustBuild(stun.TransactionID, stun.BindingRequest)
request.Add(stun.AttrChangeRequest, []byte{0x00, 0x00, 0x00, 0x06})
resp, err = mapTestConn.roundTrip(request, mapTestConn.RemoteAddr)
if err == nil {
parse(resp)
model.NatFilteringBehavior = "endpoint independent"
if model.EnableLoger {
model.Log.Warn("=> NAT filtering behavior: endpoint independent")
}
return nil
} else if !errors.Is(err, errTimedOut) {
return err
}
if model.EnableLoger {
model.Log.Info("Filtering Test III: Request to change port only")
}
request = stun.MustBuild(stun.TransactionID, stun.BindingRequest)
request.Add(stun.AttrChangeRequest, []byte{0x00, 0x00, 0x00, 0x02})
resp, err = mapTestConn.roundTrip(request, mapTestConn.RemoteAddr)
if err == nil {
parse(resp)
model.NatFilteringBehavior = "address dependent"
if model.EnableLoger {
model.Log.Warn("=> NAT filtering behavior: address dependent")
}
} else if errors.Is(err, errTimedOut) {
model.NatFilteringBehavior = "address and port dependent"
if model.EnableLoger {
model.Log.Warn("=> NAT filtering behavior: address and port dependent")
}
}
return mapTestConn.Close()
}
func parse(msg *stun.Message) (ret struct {
xorAddr *stun.XORMappedAddress
otherAddr *stun.OtherAddress
respOrigin *stun.ResponseOrigin
mappedAddr *stun.MappedAddress
software *stun.Software
},
) {
ret.mappedAddr = &stun.MappedAddress{}
ret.xorAddr = &stun.XORMappedAddress{}
ret.respOrigin = &stun.ResponseOrigin{}
ret.otherAddr = &stun.OtherAddress{}
ret.software = &stun.Software{}
if ret.xorAddr.GetFrom(msg) != nil {
ret.xorAddr = nil
}
if ret.otherAddr.GetFrom(msg) != nil {
ret.otherAddr = nil
}
if ret.respOrigin.GetFrom(msg) != nil {
ret.respOrigin = nil
}
if ret.mappedAddr.GetFrom(msg) != nil {
ret.mappedAddr = nil
}
if ret.software.GetFrom(msg) != nil {
ret.software = nil
}
if model.EnableLoger {
model.Log.Debugf("%v", msg)
model.Log.Debugf("\tMAPPED-ADDRESS: %v", ret.mappedAddr)
model.Log.Debugf("\tXOR-MAPPED-ADDRESS: %v", ret.xorAddr)
model.Log.Debugf("\tRESPONSE-ORIGIN: %v", ret.respOrigin)
model.Log.Debugf("\tOTHER-ADDRESS: %v", ret.otherAddr)
model.Log.Debugf("\tSOFTWARE: %v", ret.software)
}
for _, attr := range msg.Attributes {
switch attr.Type {
case
stun.AttrXORMappedAddress,
stun.AttrOtherAddress,
stun.AttrResponseOrigin,
stun.AttrMappedAddress,
stun.AttrSoftware:
break //nolint:staticcheck
default:
if model.EnableLoger {
model.Log.Debugf("\t%v (l=%v)", attr, attr.Length)
}
}
}
return ret
}
func connect(addrStr string) (*stunServerConn, error) {
if model.EnableLoger {
model.Log.Infof("Connecting to STUN server: %s", addrStr)
}
networkType := getNetworkType(addrStr)
addr, err := net.ResolveUDPAddr(networkType, addrStr)
if err != nil {
if model.EnableLoger {
model.Log.Warnf("Error resolving address: %s", err)
}
return nil, err
}
c, err := net.ListenUDP(networkType, nil)
if err != nil {
return nil, err
}
if model.EnableLoger {
model.Log.Infof("Local address: %s", c.LocalAddr())
model.Log.Infof("Remote address: %s", addr.String())
}
mChan := listen(c)
return &stunServerConn{
conn: c,
LocalAddr: c.LocalAddr(),
RemoteAddr: addr,
messageChan: mChan,
}, nil
}
func (c *stunServerConn) roundTrip(msg *stun.Message, addr net.Addr) (*stun.Message, error) {
_ = msg.NewTransactionID()
if model.EnableLoger {
model.Log.Infof("Sending to %v: (%v bytes)", addr, msg.Length+messageHeaderSize)
model.Log.Debugf("%v", msg)
for _, attr := range msg.Attributes {
model.Log.Debugf("\t%v (l=%v)", attr, attr.Length)
}
}
_, err := c.conn.WriteTo(msg.Raw, addr)
if err != nil {
if model.EnableLoger {
model.Log.Warnf("Error sending request to %v", addr)
}
return nil, err
}
select {
case m, ok := <-c.messageChan:
if !ok {
return nil, errResponseMessage
}
return m, nil
case <-time.After(time.Duration(model.Timeout) * time.Second):
if model.EnableLoger {
model.Log.Infof("Timed out waiting for response from server %v", addr)
}
return nil, errTimedOut
}
}
// taken from https://github.com/pion/stun/blob/master/cmd/stun-traversal/main.go
func listen(conn *net.UDPConn) (messages chan *stun.Message) {
messages = make(chan *stun.Message)
go func() {
for {
buf := make([]byte, 1024)
n, addr, err := conn.ReadFromUDP(buf)
if err != nil {
close(messages)
return
}
if model.EnableLoger {
model.Log.Infof("Response from %v: (%v bytes)", addr, n)
}
buf = buf[:n]
m := new(stun.Message)
m.Raw = buf
err = m.Decode()
if err != nil {
if model.EnableLoger {
model.Log.Infof("Error decoding message: %v", err)
}
close(messages)
return
}
messages <- m
}
}()
return
}