mirror of
https://github.com/slackhq/nebula.git
synced 2026-11-16 17:06:52 +01:00
Compare commits
3
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b4158b3855 | ||
|
|
905d01aee5 | ||
|
|
d5062dacf0 |
No files matched your search
@@ -7,6 +7,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/rcrowley/go-metrics"
|
||||||
"github.com/slackhq/nebula/cert"
|
"github.com/slackhq/nebula/cert"
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
"github.com/slackhq/nebula/overlay/overlaytest"
|
"github.com/slackhq/nebula/overlay/overlaytest"
|
||||||
@@ -21,6 +22,8 @@ func newTestLighthouse() *LightHouse {
|
|||||||
l: test.NewLogger(),
|
l: test.NewLogger(),
|
||||||
addrMap: map[netip.Addr]*RemoteList{},
|
addrMap: map[netip.Addr]*RemoteList{},
|
||||||
queryChan: make(chan netip.Addr, 10),
|
queryChan: make(chan netip.Addr, 10),
|
||||||
|
// Nothing drains queryChan here, so an 11th query is dropped.
|
||||||
|
queryDropped: metrics.NilCounter{},
|
||||||
}
|
}
|
||||||
lighthouses := []netip.Addr{}
|
lighthouses := []netip.Addr{}
|
||||||
staticList := map[netip.Addr]struct{}{}
|
staticList := map[netip.Addr]struct{}{}
|
||||||
|
|||||||
+2
-2
@@ -410,8 +410,8 @@ logging:
|
|||||||
#try_interval: 100ms
|
#try_interval: 100ms
|
||||||
#retries: 20
|
#retries: 20
|
||||||
|
|
||||||
# query_buffer is the size of the buffer channel for querying lighthouses
|
# query_buffer is the size of the buffer channel for querying lighthouses, drops are recorded in the lighthouse.query.dropped metric.
|
||||||
#query_buffer: 64
|
#query_buffer: 1024
|
||||||
|
|
||||||
# trigger_buffer is the size of the buffer channel for quickly sending handshakes
|
# trigger_buffer is the size of the buffer channel for quickly sending handshakes
|
||||||
# after receiving the response for lighthouse queries
|
# after receiving the response for lighthouse queries
|
||||||
|
|||||||
+98
-111
@@ -14,6 +14,7 @@ import (
|
|||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/gaissmai/bart"
|
"github.com/gaissmai/bart"
|
||||||
@@ -28,16 +29,23 @@ type FirewallInterface interface {
|
|||||||
AddRule(incoming bool, proto uint8, startPort int32, endPort int32, groups []string, host string, cidr, localCidr string, caName string, caSha string) error
|
AddRule(incoming bool, proto uint8, startPort int32, endPort int32, groups []string, host string, cidr, localCidr string, caName string, caSha string) error
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// conn is a conntrack entry. Only expires changes after it is stored, a rules version change
|
||||||
|
// stores a replacement entry instead.
|
||||||
type conn struct {
|
type conn struct {
|
||||||
Expires time.Time // Time when this conntrack entry will expire
|
expires atomic.Uint32 // conntrack clock second when this entry expires, see FirewallConntrack.now
|
||||||
|
|
||||||
// record why the original connection passed the firewall, so we can re-validate
|
// record why the original connection passed the firewall, so we can re-validate
|
||||||
// after ruleset changes. Note, rulesVersion is a uint16 so that these two
|
// after ruleset changes
|
||||||
// fields pack for free after the uint32 above
|
|
||||||
incoming bool
|
incoming bool
|
||||||
rulesVersion uint16
|
rulesVersion uint16
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func newConn(expires uint32, incoming bool, rulesVersion uint16) *conn {
|
||||||
|
c := &conn{incoming: incoming, rulesVersion: rulesVersion}
|
||||||
|
c.expires.Store(expires)
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
// TODO: need conntrack max tracked connections handling
|
// TODO: need conntrack max tracked connections handling
|
||||||
type Firewall struct {
|
type Firewall struct {
|
||||||
Conntrack *FirewallConntrack
|
Conntrack *FirewallConntrack
|
||||||
@@ -79,11 +87,69 @@ type firewallMetrics struct {
|
|||||||
droppedNoRule metrics.Counter
|
droppedNoRule metrics.Counter
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// FirewallConntrack is safe for concurrent use by every routine without a lock.
|
||||||
type FirewallConntrack struct {
|
type FirewallConntrack struct {
|
||||||
sync.Mutex
|
conns sync.Map // firewall.Packet -> *conn
|
||||||
|
count atomic.Int64 // entries in conns, which sync.Map can't tell us
|
||||||
|
now atomic.Uint32 // the conntrack clock: whole seconds since epoch, kept current by Run
|
||||||
|
epoch time.Time
|
||||||
|
}
|
||||||
|
|
||||||
Conns map[firewall.Packet]*conn
|
func newFirewallConntrack() *FirewallConntrack {
|
||||||
TimerWheel *TimerWheel[firewall.Packet]
|
return &FirewallConntrack{epoch: time.Now()}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run advances the conntrack clock every second and sweeps out expired entries every minute,
|
||||||
|
// until ctx is done. Reading a shared clock is much cheaper than asking the OS on every packet.
|
||||||
|
func (ct *FirewallConntrack) Run(ctx context.Context) {
|
||||||
|
t := time.NewTicker(time.Second)
|
||||||
|
defer t.Stop()
|
||||||
|
var nextSweep uint32
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-t.C:
|
||||||
|
// Measured from epoch rather than counted, so a late tick can't slow the clock down
|
||||||
|
now := uint32(time.Since(ct.epoch) / time.Second)
|
||||||
|
ct.now.Store(now)
|
||||||
|
if now >= nextSweep {
|
||||||
|
ct.sweep(now)
|
||||||
|
nextSweep = now + 60
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// sweep deletes entries that expired at or before now.
|
||||||
|
func (ct *FirewallConntrack) sweep(now uint32) {
|
||||||
|
ct.conns.Range(func(k, v any) bool {
|
||||||
|
if v.(*conn).expires.Load() <= now {
|
||||||
|
ct.delete(k.(firewall.Packet), v.(*conn))
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ct *FirewallConntrack) store(fp firewall.Packet, c *conn) {
|
||||||
|
if _, replaced := ct.conns.Swap(fp, c); !replaced {
|
||||||
|
ct.count.Add(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// delete removes fp's entry if it is still c, so a newer entry stored by another routine survives
|
||||||
|
func (ct *FirewallConntrack) delete(fp firewall.Packet, c *conn) {
|
||||||
|
if ct.conns.CompareAndDelete(fp, c) {
|
||||||
|
ct.count.Add(-1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// clear deletes every entry
|
||||||
|
func (ct *FirewallConntrack) clear() {
|
||||||
|
ct.conns.Range(func(k, v any) bool {
|
||||||
|
ct.delete(k.(firewall.Packet), v.(*conn))
|
||||||
|
return true
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// FirewallTable is the entry point for a rule, the evaluation order is:
|
// FirewallTable is the entry point for a rule, the evaluation order is:
|
||||||
@@ -132,26 +198,10 @@ type firewallLocalCIDR struct {
|
|||||||
LocalCIDR *bart.Lite
|
LocalCIDR *bart.Lite
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewFirewall creates a new Firewall object. A TimerWheel is created for you from the provided timeouts.
|
// NewFirewall creates a new Firewall object.
|
||||||
// The certificate provided should be the highest version loaded in memory.
|
// The certificate provided should be the highest version loaded in memory.
|
||||||
func NewFirewall(l *slog.Logger, tcpTimeout, UDPTimeout, defaultTimeout time.Duration, c cert.Certificate) *Firewall {
|
func NewFirewall(l *slog.Logger, tcpTimeout, UDPTimeout, defaultTimeout time.Duration, c cert.Certificate) *Firewall {
|
||||||
//TODO: error on 0 duration
|
//TODO: error on 0 duration
|
||||||
var tmin, tmax time.Duration
|
|
||||||
|
|
||||||
if tcpTimeout < UDPTimeout {
|
|
||||||
tmin = tcpTimeout
|
|
||||||
tmax = UDPTimeout
|
|
||||||
} else {
|
|
||||||
tmin = UDPTimeout
|
|
||||||
tmax = tcpTimeout
|
|
||||||
}
|
|
||||||
|
|
||||||
if defaultTimeout < tmin {
|
|
||||||
tmin = defaultTimeout
|
|
||||||
} else if defaultTimeout > tmax {
|
|
||||||
tmax = defaultTimeout
|
|
||||||
}
|
|
||||||
|
|
||||||
routableNetworks := new(bart.Lite)
|
routableNetworks := new(bart.Lite)
|
||||||
var assignedNetworks []netip.Prefix
|
var assignedNetworks []netip.Prefix
|
||||||
for _, network := range c.Networks() {
|
for _, network := range c.Networks() {
|
||||||
@@ -166,10 +216,7 @@ func NewFirewall(l *slog.Logger, tcpTimeout, UDPTimeout, defaultTimeout time.Dur
|
|||||||
}
|
}
|
||||||
|
|
||||||
return &Firewall{
|
return &Firewall{
|
||||||
Conntrack: &FirewallConntrack{
|
Conntrack: newFirewallConntrack(),
|
||||||
Conns: make(map[firewall.Packet]*conn),
|
|
||||||
TimerWheel: NewTimerWheel[firewall.Packet](tmin, tmax),
|
|
||||||
},
|
|
||||||
InRules: newFirewallTable(),
|
InRules: newFirewallTable(),
|
||||||
OutRules: newFirewallTable(),
|
OutRules: newFirewallTable(),
|
||||||
TCPTimeout: tcpTimeout,
|
TCPTimeout: tcpTimeout,
|
||||||
@@ -423,7 +470,7 @@ var ErrNoMatchingRule = errors.New("no matching rule in firewall table")
|
|||||||
|
|
||||||
// Drop returns an error if the packet should be dropped, explaining why. It
|
// Drop returns an error if the packet should be dropped, explaining why. It
|
||||||
// returns nil if the packet should not be dropped.
|
// returns nil if the packet should not be dropped.
|
||||||
func (f *Firewall) Drop(fp firewall.Packet, incoming bool, h *HostInfo, caPool *cert.CAPool, localCache firewall.ConntrackCache) error {
|
func (f *Firewall) Drop(fp firewall.Packet, incoming bool, h *HostInfo, caPool *cert.CAPool) error {
|
||||||
// Make sure remote address matches nebula certificate, and determine how to treat it
|
// Make sure remote address matches nebula certificate, and determine how to treat it
|
||||||
if h.networks == nil {
|
if h.networks == nil {
|
||||||
// Simple case: Certificate has one address and no unsafe networks
|
// Simple case: Certificate has one address and no unsafe networks
|
||||||
@@ -458,7 +505,7 @@ func (f *Firewall) Drop(fp firewall.Packet, incoming bool, h *HostInfo, caPool *
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Check if we spoke to this tuple, if we did then allow this packet
|
// Check if we spoke to this tuple, if we did then allow this packet
|
||||||
if f.inConns(fp, h, caPool, localCache) {
|
if f.inConns(fp, h, caPool) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -494,36 +541,19 @@ func (f *Firewall) Destroy() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (f *Firewall) EmitStats() {
|
func (f *Firewall) EmitStats() {
|
||||||
conntrack := f.Conntrack
|
metrics.GetOrRegisterGauge("firewall.conntrack.count", nil).Update(f.Conntrack.count.Load())
|
||||||
conntrack.Lock()
|
|
||||||
conntrackCount := len(conntrack.Conns)
|
|
||||||
conntrack.Unlock()
|
|
||||||
metrics.GetOrRegisterGauge("firewall.conntrack.count", nil).Update(int64(conntrackCount))
|
|
||||||
metrics.GetOrRegisterGauge("firewall.rules.version", nil).Update(int64(f.rulesVersion))
|
metrics.GetOrRegisterGauge("firewall.rules.version", nil).Update(int64(f.rulesVersion))
|
||||||
metrics.GetOrRegisterGauge("firewall.rules.hash", nil).Update(int64(f.GetRuleHashFNV()))
|
metrics.GetOrRegisterGauge("firewall.rules.hash", nil).Update(int64(f.GetRuleHashFNV()))
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *Firewall) inConns(fp firewall.Packet, h *HostInfo, caPool *cert.CAPool, localCache firewall.ConntrackCache) bool {
|
func (f *Firewall) inConns(fp firewall.Packet, h *HostInfo, caPool *cert.CAPool) bool {
|
||||||
if localCache != nil {
|
|
||||||
if _, ok := localCache[fp]; ok {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
conntrack := f.Conntrack
|
conntrack := f.Conntrack
|
||||||
conntrack.Lock()
|
v, ok := conntrack.conns.Load(fp)
|
||||||
|
|
||||||
// Purge every time we test
|
|
||||||
ep, has := conntrack.TimerWheel.Purge()
|
|
||||||
if has {
|
|
||||||
f.evict(ep)
|
|
||||||
}
|
|
||||||
|
|
||||||
c, ok := conntrack.Conns[fp]
|
|
||||||
|
|
||||||
if !ok {
|
if !ok {
|
||||||
conntrack.Unlock()
|
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
c := v.(*conn)
|
||||||
|
expires := conntrack.now.Load() + f.timeout(fp.Protocol)
|
||||||
|
|
||||||
if c.rulesVersion != f.rulesVersion {
|
if c.rulesVersion != f.rulesVersion {
|
||||||
// This conntrack entry was for an older rule set, validate
|
// This conntrack entry was for an older rule set, validate
|
||||||
@@ -543,8 +573,7 @@ func (f *Firewall) inConns(fp firewall.Packet, h *HostInfo, caPool *cert.CAPool,
|
|||||||
"oldRulesVersion", c.rulesVersion,
|
"oldRulesVersion", c.rulesVersion,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
delete(conntrack.Conns, fp)
|
conntrack.delete(fp, c)
|
||||||
conntrack.Unlock()
|
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -557,77 +586,35 @@ func (f *Firewall) inConns(fp firewall.Packet, h *HostInfo, caPool *cert.CAPool,
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
c.rulesVersion = f.rulesVersion
|
conntrack.store(fp, newConn(expires, c.incoming, f.rulesVersion))
|
||||||
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
switch fp.Protocol {
|
// Most packets land in the same second as the one before, skip writing an unchanged expiry
|
||||||
case iputil.IPProtocolTCP:
|
if c.expires.Load() != expires {
|
||||||
c.Expires = time.Now().Add(f.TCPTimeout)
|
c.expires.Store(expires)
|
||||||
case iputil.IPProtocolUDP:
|
|
||||||
c.Expires = time.Now().Add(f.UDPTimeout)
|
|
||||||
default:
|
|
||||||
c.Expires = time.Now().Add(f.DefaultTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
conntrack.Unlock()
|
|
||||||
|
|
||||||
if localCache != nil {
|
|
||||||
localCache[fp] = struct{}{}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *Firewall) addConn(fp firewall.Packet, incoming bool) {
|
func (f *Firewall) addConn(fp firewall.Packet, incoming bool) {
|
||||||
var timeout time.Duration
|
|
||||||
c := &conn{}
|
|
||||||
|
|
||||||
switch fp.Protocol {
|
|
||||||
case iputil.IPProtocolTCP:
|
|
||||||
timeout = f.TCPTimeout
|
|
||||||
case iputil.IPProtocolUDP:
|
|
||||||
timeout = f.UDPTimeout
|
|
||||||
default:
|
|
||||||
timeout = f.DefaultTimeout
|
|
||||||
}
|
|
||||||
|
|
||||||
conntrack := f.Conntrack
|
|
||||||
conntrack.Lock()
|
|
||||||
if _, ok := conntrack.Conns[fp]; !ok {
|
|
||||||
conntrack.TimerWheel.Advance(time.Now())
|
|
||||||
conntrack.TimerWheel.Add(fp, timeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Record which rulesVersion allowed this connection, so we can retest after
|
// Record which rulesVersion allowed this connection, so we can retest after
|
||||||
// firewall reload
|
// firewall reload
|
||||||
c.incoming = incoming
|
conntrack := f.Conntrack
|
||||||
c.rulesVersion = f.rulesVersion
|
conntrack.store(fp, newConn(conntrack.now.Load()+f.timeout(fp.Protocol), incoming, f.rulesVersion))
|
||||||
c.Expires = time.Now().Add(timeout)
|
|
||||||
conntrack.Conns[fp] = c
|
|
||||||
conntrack.Unlock()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Evict checks if a conntrack entry has expired, if so it is removed, if not it is re-added to the wheel
|
// timeout returns how many seconds a conntrack entry for proto lives past its last packet
|
||||||
// Caller must own the connMutex lock!
|
func (f *Firewall) timeout(proto uint8) uint32 {
|
||||||
func (f *Firewall) evict(p firewall.Packet) {
|
switch proto {
|
||||||
// Are we still tracking this conn?
|
case iputil.IPProtocolTCP:
|
||||||
conntrack := f.Conntrack
|
return uint32(f.TCPTimeout / time.Second)
|
||||||
t, ok := conntrack.Conns[p]
|
case iputil.IPProtocolUDP:
|
||||||
if !ok {
|
return uint32(f.UDPTimeout / time.Second)
|
||||||
return
|
default:
|
||||||
|
return uint32(f.DefaultTimeout / time.Second)
|
||||||
}
|
}
|
||||||
|
|
||||||
newT := t.Expires.Sub(time.Now())
|
|
||||||
|
|
||||||
// Timeout is in the future, re-add the timer
|
|
||||||
if newT > 0 {
|
|
||||||
conntrack.TimerWheel.Advance(time.Now())
|
|
||||||
conntrack.TimerWheel.Add(p, newT)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// This conn is done
|
|
||||||
delete(conntrack.Conns, p)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ft *FirewallTable) match(p firewall.Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
func (ft *FirewallTable) match(p firewall.Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
||||||
|
|||||||
@@ -1,69 +0,0 @@
|
|||||||
package firewall
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"log/slog"
|
|
||||||
"sync/atomic"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/logging"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ConntrackCache is used as a local routine cache to know if a given flow
|
|
||||||
// has been seen in the conntrack table.
|
|
||||||
type ConntrackCache map[Packet]struct{}
|
|
||||||
|
|
||||||
type ConntrackCacheTicker struct {
|
|
||||||
cacheV uint64
|
|
||||||
cacheTick atomic.Uint64
|
|
||||||
|
|
||||||
l *slog.Logger
|
|
||||||
cache ConntrackCache
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewConntrackCacheTicker(ctx context.Context, l *slog.Logger, d time.Duration) *ConntrackCacheTicker {
|
|
||||||
if d == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
c := &ConntrackCacheTicker{
|
|
||||||
l: l,
|
|
||||||
cache: ConntrackCache{},
|
|
||||||
}
|
|
||||||
|
|
||||||
go c.tick(ctx, d)
|
|
||||||
|
|
||||||
return c
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *ConntrackCacheTicker) tick(ctx context.Context, d time.Duration) {
|
|
||||||
t := time.NewTicker(d)
|
|
||||||
defer t.Stop()
|
|
||||||
for {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return
|
|
||||||
case <-t.C:
|
|
||||||
c.cacheTick.Add(1)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get checks if the cache ticker has moved to the next version before returning
|
|
||||||
// the map. If it has moved, we reset the map.
|
|
||||||
func (c *ConntrackCacheTicker) Get() ConntrackCache {
|
|
||||||
if c == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if tick := c.cacheTick.Load(); tick != c.cacheV {
|
|
||||||
c.cacheV = tick
|
|
||||||
if ll := len(c.cache); ll > 0 {
|
|
||||||
if c.l.Enabled(context.Background(), logging.LevelTrace) {
|
|
||||||
c.l.Log(context.Background(), logging.LevelTrace, "resetting conntrack cache", "len", ll)
|
|
||||||
}
|
|
||||||
c.cache = make(ConntrackCache, ll)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return c.cache
|
|
||||||
}
|
|
||||||
@@ -1,70 +0,0 @@
|
|||||||
package firewall
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"log/slog"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/logging"
|
|
||||||
"github.com/slackhq/nebula/test"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
)
|
|
||||||
|
|
||||||
// The tests below pin the log format produced by ConntrackCacheTicker.Get
|
|
||||||
// so changes cannot silently break what operators are grepping for. The
|
|
||||||
// ticker's internal state (cache + cacheTick) is poked directly to avoid
|
|
||||||
// racing a goroutine-driven tick in tests.
|
|
||||||
|
|
||||||
func newFixedTicker(t *testing.T, l *slog.Logger, cacheLen int) *ConntrackCacheTicker {
|
|
||||||
t.Helper()
|
|
||||||
c := &ConntrackCacheTicker{
|
|
||||||
l: l,
|
|
||||||
cache: make(ConntrackCache, cacheLen),
|
|
||||||
}
|
|
||||||
for i := range cacheLen {
|
|
||||||
c.cache[Packet{LocalPort: uint16(i) + 1}] = struct{}{}
|
|
||||||
}
|
|
||||||
c.cacheTick.Store(1) // cacheV starts at 0, so Get() takes the reset path
|
|
||||||
return c
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestConntrackCacheTicker_Get_TextFormat(t *testing.T) {
|
|
||||||
buf := &bytes.Buffer{}
|
|
||||||
l := test.NewLoggerWithOutputAndLevel(buf, logging.LevelTrace)
|
|
||||||
|
|
||||||
c := newFixedTicker(t, l, 3)
|
|
||||||
c.Get()
|
|
||||||
|
|
||||||
assert.Equal(t, "level=DEBUG-4 msg=\"resetting conntrack cache\" len=3\n", buf.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestConntrackCacheTicker_Get_JSONFormat(t *testing.T) {
|
|
||||||
buf := &bytes.Buffer{}
|
|
||||||
l := test.NewJSONLoggerWithOutput(buf, logging.LevelTrace)
|
|
||||||
|
|
||||||
c := newFixedTicker(t, l, 2)
|
|
||||||
c.Get()
|
|
||||||
|
|
||||||
assert.JSONEq(t, `{"level":"DEBUG-4","msg":"resetting conntrack cache","len":2}`, strings.TrimSpace(buf.String()))
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestConntrackCacheTicker_Get_QuietBelowTrace(t *testing.T) {
|
|
||||||
buf := &bytes.Buffer{}
|
|
||||||
l := test.NewLoggerWithOutputAndLevel(buf, slog.LevelDebug)
|
|
||||||
|
|
||||||
c := newFixedTicker(t, l, 5)
|
|
||||||
c.Get()
|
|
||||||
|
|
||||||
assert.Empty(t, buf.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestConntrackCacheTicker_Get_QuietWhenCacheEmpty(t *testing.T) {
|
|
||||||
buf := &bytes.Buffer{}
|
|
||||||
l := test.NewLoggerWithOutputAndLevel(buf, logging.LevelTrace)
|
|
||||||
|
|
||||||
c := newFixedTicker(t, l, 0)
|
|
||||||
c.Get()
|
|
||||||
|
|
||||||
assert.Empty(t, buf.String())
|
|
||||||
}
|
|
||||||
@@ -26,6 +26,10 @@ type Packet struct {
|
|||||||
RemotePort uint16
|
RemotePort uint16
|
||||||
Protocol uint8
|
Protocol uint8
|
||||||
Fragment bool
|
Fragment bool
|
||||||
|
|
||||||
|
// pad fills what would otherwise be compiler padding. A Packet with no padding hashes as one
|
||||||
|
// block of memory, which makes it a much faster map key. Always zero.
|
||||||
|
pad [2]byte
|
||||||
}
|
}
|
||||||
|
|
||||||
func (fp *Packet) Copy() *Packet {
|
func (fp *Packet) Copy() *Packet {
|
||||||
|
|||||||
+126
-100
@@ -2,6 +2,7 @@ package nebula
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"math"
|
"math"
|
||||||
@@ -23,39 +24,12 @@ func TestNewFirewall(t *testing.T) {
|
|||||||
l := test.NewLogger()
|
l := test.NewLogger()
|
||||||
c := &dummyCert{}
|
c := &dummyCert{}
|
||||||
fw := NewFirewall(l, time.Second, time.Minute, time.Hour, c)
|
fw := NewFirewall(l, time.Second, time.Minute, time.Hour, c)
|
||||||
conntrack := fw.Conntrack
|
assert.NotNil(t, fw.Conntrack)
|
||||||
assert.NotNil(t, conntrack)
|
|
||||||
assert.NotNil(t, conntrack.Conns)
|
|
||||||
assert.NotNil(t, conntrack.TimerWheel)
|
|
||||||
assert.NotNil(t, fw.InRules)
|
assert.NotNil(t, fw.InRules)
|
||||||
assert.NotNil(t, fw.OutRules)
|
assert.NotNil(t, fw.OutRules)
|
||||||
assert.Equal(t, time.Second, fw.TCPTimeout)
|
assert.Equal(t, time.Second, fw.TCPTimeout)
|
||||||
assert.Equal(t, time.Minute, fw.UDPTimeout)
|
assert.Equal(t, time.Minute, fw.UDPTimeout)
|
||||||
assert.Equal(t, time.Hour, fw.DefaultTimeout)
|
assert.Equal(t, time.Hour, fw.DefaultTimeout)
|
||||||
|
|
||||||
assert.Equal(t, time.Hour, conntrack.TimerWheel.wheelDuration)
|
|
||||||
assert.Equal(t, time.Hour, conntrack.TimerWheel.wheelDuration)
|
|
||||||
assert.Equal(t, 3602, conntrack.TimerWheel.wheelLen)
|
|
||||||
|
|
||||||
fw = NewFirewall(l, time.Second, time.Hour, time.Minute, c)
|
|
||||||
assert.Equal(t, time.Hour, conntrack.TimerWheel.wheelDuration)
|
|
||||||
assert.Equal(t, 3602, conntrack.TimerWheel.wheelLen)
|
|
||||||
|
|
||||||
fw = NewFirewall(l, time.Hour, time.Second, time.Minute, c)
|
|
||||||
assert.Equal(t, time.Hour, conntrack.TimerWheel.wheelDuration)
|
|
||||||
assert.Equal(t, 3602, conntrack.TimerWheel.wheelLen)
|
|
||||||
|
|
||||||
fw = NewFirewall(l, time.Hour, time.Minute, time.Second, c)
|
|
||||||
assert.Equal(t, time.Hour, conntrack.TimerWheel.wheelDuration)
|
|
||||||
assert.Equal(t, 3602, conntrack.TimerWheel.wheelLen)
|
|
||||||
|
|
||||||
fw = NewFirewall(l, time.Minute, time.Hour, time.Second, c)
|
|
||||||
assert.Equal(t, time.Hour, conntrack.TimerWheel.wheelDuration)
|
|
||||||
assert.Equal(t, 3602, conntrack.TimerWheel.wheelLen)
|
|
||||||
|
|
||||||
fw = NewFirewall(l, time.Minute, time.Second, time.Hour, c)
|
|
||||||
assert.Equal(t, time.Hour, conntrack.TimerWheel.wheelDuration)
|
|
||||||
assert.Equal(t, 3602, conntrack.TimerWheel.wheelLen)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFirewall_AddRule(t *testing.T) {
|
func TestFirewall_AddRule(t *testing.T) {
|
||||||
@@ -212,44 +186,44 @@ func TestFirewall_Drop(t *testing.T) {
|
|||||||
cp := cert.NewCAPool()
|
cp := cert.NewCAPool()
|
||||||
|
|
||||||
// Drop outbound
|
// Drop outbound
|
||||||
assert.Equal(t, ErrNoMatchingRule, fw.Drop(p, false, &h, cp, nil))
|
assert.Equal(t, ErrNoMatchingRule, fw.Drop(p, false, &h, cp))
|
||||||
// Allow inbound
|
// Allow inbound
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
require.NoError(t, fw.Drop(p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h, cp))
|
||||||
// Allow outbound because conntrack
|
// Allow outbound because conntrack
|
||||||
require.NoError(t, fw.Drop(p, false, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, false, &h, cp))
|
||||||
|
|
||||||
// test remote mismatch
|
// test remote mismatch
|
||||||
oldRemote := p.RemoteAddr
|
oldRemote := p.RemoteAddr
|
||||||
p.RemoteAddr = netip.MustParseAddr("1.2.3.10")
|
p.RemoteAddr = netip.MustParseAddr("1.2.3.10")
|
||||||
assert.Equal(t, fw.Drop(p, false, &h, cp, nil), ErrInvalidRemoteIP)
|
assert.Equal(t, fw.Drop(p, false, &h, cp), ErrInvalidRemoteIP)
|
||||||
p.RemoteAddr = oldRemote
|
p.RemoteAddr = oldRemote
|
||||||
|
|
||||||
// ensure signer doesn't get in the way of group checks
|
// ensure signer doesn't get in the way of group checks
|
||||||
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "", "signer-shasum"))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "", "signer-shasum"))
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "", "signer-shasum-bad"))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "", "signer-shasum-bad"))
|
||||||
assert.Equal(t, fw.Drop(p, true, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(p, true, &h, cp), ErrNoMatchingRule)
|
||||||
|
|
||||||
// test caSha doesn't drop on match
|
// test caSha doesn't drop on match
|
||||||
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "", "signer-shasum-bad"))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "", "signer-shasum-bad"))
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "", "signer-shasum"))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "", "signer-shasum"))
|
||||||
require.NoError(t, fw.Drop(p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h, cp))
|
||||||
|
|
||||||
// ensure ca name doesn't get in the way of group checks
|
// ensure ca name doesn't get in the way of group checks
|
||||||
cp.CAs["signer-shasum"] = &cert.CachedCertificate{Certificate: &dummyCert{name: "ca-good"}}
|
cp.CAs["signer-shasum"] = &cert.CachedCertificate{Certificate: &dummyCert{name: "ca-good"}}
|
||||||
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "ca-good", ""))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "ca-good", ""))
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "ca-good-bad", ""))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "ca-good-bad", ""))
|
||||||
assert.Equal(t, fw.Drop(p, true, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(p, true, &h, cp), ErrNoMatchingRule)
|
||||||
|
|
||||||
// test caName doesn't drop on match
|
// test caName doesn't drop on match
|
||||||
cp.CAs["signer-shasum"] = &cert.CachedCertificate{Certificate: &dummyCert{name: "ca-good"}}
|
cp.CAs["signer-shasum"] = &cert.CachedCertificate{Certificate: &dummyCert{name: "ca-good"}}
|
||||||
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "ca-good-bad", ""))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "ca-good-bad", ""))
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "ca-good", ""))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "ca-good", ""))
|
||||||
require.NoError(t, fw.Drop(p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h, cp))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFirewall_DropV6(t *testing.T) {
|
func TestFirewall_DropV6(t *testing.T) {
|
||||||
@@ -290,44 +264,44 @@ func TestFirewall_DropV6(t *testing.T) {
|
|||||||
cp := cert.NewCAPool()
|
cp := cert.NewCAPool()
|
||||||
|
|
||||||
// Drop outbound
|
// Drop outbound
|
||||||
assert.Equal(t, ErrNoMatchingRule, fw.Drop(p, false, &h, cp, nil))
|
assert.Equal(t, ErrNoMatchingRule, fw.Drop(p, false, &h, cp))
|
||||||
// Allow inbound
|
// Allow inbound
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
require.NoError(t, fw.Drop(p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h, cp))
|
||||||
// Allow outbound because conntrack
|
// Allow outbound because conntrack
|
||||||
require.NoError(t, fw.Drop(p, false, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, false, &h, cp))
|
||||||
|
|
||||||
// test remote mismatch
|
// test remote mismatch
|
||||||
oldRemote := p.RemoteAddr
|
oldRemote := p.RemoteAddr
|
||||||
p.RemoteAddr = netip.MustParseAddr("fd12::56")
|
p.RemoteAddr = netip.MustParseAddr("fd12::56")
|
||||||
assert.Equal(t, fw.Drop(p, false, &h, cp, nil), ErrInvalidRemoteIP)
|
assert.Equal(t, fw.Drop(p, false, &h, cp), ErrInvalidRemoteIP)
|
||||||
p.RemoteAddr = oldRemote
|
p.RemoteAddr = oldRemote
|
||||||
|
|
||||||
// ensure signer doesn't get in the way of group checks
|
// ensure signer doesn't get in the way of group checks
|
||||||
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "", "signer-shasum"))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "", "signer-shasum"))
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "", "signer-shasum-bad"))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "", "signer-shasum-bad"))
|
||||||
assert.Equal(t, fw.Drop(p, true, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(p, true, &h, cp), ErrNoMatchingRule)
|
||||||
|
|
||||||
// test caSha doesn't drop on match
|
// test caSha doesn't drop on match
|
||||||
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "", "signer-shasum-bad"))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "", "signer-shasum-bad"))
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "", "signer-shasum"))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "", "signer-shasum"))
|
||||||
require.NoError(t, fw.Drop(p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h, cp))
|
||||||
|
|
||||||
// ensure ca name doesn't get in the way of group checks
|
// ensure ca name doesn't get in the way of group checks
|
||||||
cp.CAs["signer-shasum"] = &cert.CachedCertificate{Certificate: &dummyCert{name: "ca-good"}}
|
cp.CAs["signer-shasum"] = &cert.CachedCertificate{Certificate: &dummyCert{name: "ca-good"}}
|
||||||
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "ca-good", ""))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "ca-good", ""))
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "ca-good-bad", ""))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "ca-good-bad", ""))
|
||||||
assert.Equal(t, fw.Drop(p, true, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(p, true, &h, cp), ErrNoMatchingRule)
|
||||||
|
|
||||||
// test caName doesn't drop on match
|
// test caName doesn't drop on match
|
||||||
cp.CAs["signer-shasum"] = &cert.CachedCertificate{Certificate: &dummyCert{name: "ca-good"}}
|
cp.CAs["signer-shasum"] = &cert.CachedCertificate{Certificate: &dummyCert{name: "ca-good"}}
|
||||||
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, &c)
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "ca-good-bad", ""))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"nope"}, "", "", "", "ca-good-bad", ""))
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "ca-good", ""))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"default-group"}, "", "", "", "ca-good", ""))
|
||||||
require.NoError(t, fw.Drop(p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h, cp))
|
||||||
}
|
}
|
||||||
|
|
||||||
func BenchmarkFirewallTable_match(b *testing.B) {
|
func BenchmarkFirewallTable_match(b *testing.B) {
|
||||||
@@ -534,10 +508,10 @@ func TestFirewall_Drop2(t *testing.T) {
|
|||||||
cp := cert.NewCAPool()
|
cp := cert.NewCAPool()
|
||||||
|
|
||||||
// h1/c1 lacks the proper groups
|
// h1/c1 lacks the proper groups
|
||||||
require.ErrorIs(t, fw.Drop(p, true, &h1, cp, nil), ErrNoMatchingRule)
|
require.ErrorIs(t, fw.Drop(p, true, &h1, cp), ErrNoMatchingRule)
|
||||||
// c has the proper groups
|
// c has the proper groups
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
require.NoError(t, fw.Drop(p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h, cp))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFirewall_Drop3(t *testing.T) {
|
func TestFirewall_Drop3(t *testing.T) {
|
||||||
@@ -614,18 +588,18 @@ func TestFirewall_Drop3(t *testing.T) {
|
|||||||
cp := cert.NewCAPool()
|
cp := cert.NewCAPool()
|
||||||
|
|
||||||
// c1 should pass because host match
|
// c1 should pass because host match
|
||||||
require.NoError(t, fw.Drop(p, true, &h1, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h1, cp))
|
||||||
// c2 should pass because ca sha match
|
// c2 should pass because ca sha match
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
require.NoError(t, fw.Drop(p, true, &h2, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h2, cp))
|
||||||
// c3 should fail because no match
|
// c3 should fail because no match
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
assert.Equal(t, fw.Drop(p, true, &h3, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(p, true, &h3, cp), ErrNoMatchingRule)
|
||||||
|
|
||||||
// Test a remote address match
|
// Test a remote address match
|
||||||
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, c.Certificate)
|
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, c.Certificate)
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 1, 1, []string{}, "", "1.2.3.4/24", "", "", ""))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 1, 1, []string{}, "", "1.2.3.4/24", "", "", ""))
|
||||||
require.NoError(t, fw.Drop(p, true, &h1, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h1, cp))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFirewall_Drop3V6(t *testing.T) {
|
func TestFirewall_Drop3V6(t *testing.T) {
|
||||||
@@ -662,7 +636,7 @@ func TestFirewall_Drop3V6(t *testing.T) {
|
|||||||
fw := NewFirewall(l, time.Second, time.Minute, time.Hour, c.Certificate)
|
fw := NewFirewall(l, time.Second, time.Minute, time.Hour, c.Certificate)
|
||||||
cp := cert.NewCAPool()
|
cp := cert.NewCAPool()
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 1, 1, []string{}, "", "fd12::34/120", "", "", ""))
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 1, 1, []string{}, "", "fd12::34/120", "", "", ""))
|
||||||
require.NoError(t, fw.Drop(p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h, cp))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFirewall_DropConntrackReload(t *testing.T) {
|
func TestFirewall_DropConntrackReload(t *testing.T) {
|
||||||
@@ -703,12 +677,12 @@ func TestFirewall_DropConntrackReload(t *testing.T) {
|
|||||||
cp := cert.NewCAPool()
|
cp := cert.NewCAPool()
|
||||||
|
|
||||||
// Drop outbound
|
// Drop outbound
|
||||||
assert.Equal(t, fw.Drop(p, false, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(p, false, &h, cp), ErrNoMatchingRule)
|
||||||
// Allow inbound
|
// Allow inbound
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
require.NoError(t, fw.Drop(p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h, cp))
|
||||||
// Allow outbound because conntrack
|
// Allow outbound because conntrack
|
||||||
require.NoError(t, fw.Drop(p, false, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, false, &h, cp))
|
||||||
|
|
||||||
oldFw := fw
|
oldFw := fw
|
||||||
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, c.Certificate)
|
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, c.Certificate)
|
||||||
@@ -717,7 +691,7 @@ func TestFirewall_DropConntrackReload(t *testing.T) {
|
|||||||
fw.rulesVersion = oldFw.rulesVersion + 1
|
fw.rulesVersion = oldFw.rulesVersion + 1
|
||||||
|
|
||||||
// Allow outbound because conntrack and new rules allow port 10
|
// Allow outbound because conntrack and new rules allow port 10
|
||||||
require.NoError(t, fw.Drop(p, false, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, false, &h, cp))
|
||||||
|
|
||||||
oldFw = fw
|
oldFw = fw
|
||||||
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, c.Certificate)
|
fw = NewFirewall(l, time.Second, time.Minute, time.Hour, c.Certificate)
|
||||||
@@ -726,7 +700,7 @@ func TestFirewall_DropConntrackReload(t *testing.T) {
|
|||||||
fw.rulesVersion = oldFw.rulesVersion + 1
|
fw.rulesVersion = oldFw.rulesVersion + 1
|
||||||
|
|
||||||
// Drop outbound because conntrack doesn't match new ruleset
|
// Drop outbound because conntrack doesn't match new ruleset
|
||||||
assert.Equal(t, fw.Drop(p, false, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(p, false, &h, cp), ErrNoMatchingRule)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFirewall_ICMPPortBehavior(t *testing.T) {
|
func TestFirewall_ICMPPortBehavior(t *testing.T) {
|
||||||
@@ -771,12 +745,12 @@ func TestFirewall_ICMPPortBehavior(t *testing.T) {
|
|||||||
p.LocalPort = 0
|
p.LocalPort = 0
|
||||||
p.RemotePort = 0
|
p.RemotePort = 0
|
||||||
// Drop outbound
|
// Drop outbound
|
||||||
assert.Equal(t, fw.Drop(*p, false, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, false, &h, cp), ErrNoMatchingRule)
|
||||||
// Allow inbound
|
// Allow inbound
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
require.NoError(t, fw.Drop(*p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(*p, true, &h, cp))
|
||||||
//now also allow outbound
|
//now also allow outbound
|
||||||
require.NoError(t, fw.Drop(*p, false, &h, cp, nil))
|
require.NoError(t, fw.Drop(*p, false, &h, cp))
|
||||||
})
|
})
|
||||||
|
|
||||||
t.Run("nonzero ports", func(t *testing.T) {
|
t.Run("nonzero ports", func(t *testing.T) {
|
||||||
@@ -784,12 +758,12 @@ func TestFirewall_ICMPPortBehavior(t *testing.T) {
|
|||||||
p.LocalPort = 0xabcd
|
p.LocalPort = 0xabcd
|
||||||
p.RemotePort = 0x1234
|
p.RemotePort = 0x1234
|
||||||
// Drop outbound
|
// Drop outbound
|
||||||
assert.Equal(t, fw.Drop(*p, false, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, false, &h, cp), ErrNoMatchingRule)
|
||||||
// Allow inbound
|
// Allow inbound
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
require.NoError(t, fw.Drop(*p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(*p, true, &h, cp))
|
||||||
//now also allow outbound
|
//now also allow outbound
|
||||||
require.NoError(t, fw.Drop(*p, false, &h, cp, nil))
|
require.NoError(t, fw.Drop(*p, false, &h, cp))
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -801,12 +775,12 @@ func TestFirewall_ICMPPortBehavior(t *testing.T) {
|
|||||||
p.LocalPort = 0
|
p.LocalPort = 0
|
||||||
p.RemotePort = 0
|
p.RemotePort = 0
|
||||||
// Drop outbound
|
// Drop outbound
|
||||||
assert.Equal(t, fw.Drop(*p, false, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, false, &h, cp), ErrNoMatchingRule)
|
||||||
// Allow inbound
|
// Allow inbound
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
assert.Equal(t, fw.Drop(*p, true, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, true, &h, cp), ErrNoMatchingRule)
|
||||||
//now also allow outbound
|
//now also allow outbound
|
||||||
assert.Equal(t, fw.Drop(*p, false, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, false, &h, cp), ErrNoMatchingRule)
|
||||||
})
|
})
|
||||||
|
|
||||||
t.Run("nonzero ports, still blocked", func(t *testing.T) {
|
t.Run("nonzero ports, still blocked", func(t *testing.T) {
|
||||||
@@ -814,12 +788,12 @@ func TestFirewall_ICMPPortBehavior(t *testing.T) {
|
|||||||
p.LocalPort = 0xabcd
|
p.LocalPort = 0xabcd
|
||||||
p.RemotePort = 0x1234
|
p.RemotePort = 0x1234
|
||||||
// Drop outbound
|
// Drop outbound
|
||||||
assert.Equal(t, fw.Drop(*p, false, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, false, &h, cp), ErrNoMatchingRule)
|
||||||
// Allow inbound
|
// Allow inbound
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
assert.Equal(t, fw.Drop(*p, true, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, true, &h, cp), ErrNoMatchingRule)
|
||||||
//now also allow outbound
|
//now also allow outbound
|
||||||
assert.Equal(t, fw.Drop(*p, false, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, false, &h, cp), ErrNoMatchingRule)
|
||||||
})
|
})
|
||||||
|
|
||||||
t.Run("nonzero, matching ports, still blocked", func(t *testing.T) {
|
t.Run("nonzero, matching ports, still blocked", func(t *testing.T) {
|
||||||
@@ -827,12 +801,12 @@ func TestFirewall_ICMPPortBehavior(t *testing.T) {
|
|||||||
p.LocalPort = 80
|
p.LocalPort = 80
|
||||||
p.RemotePort = 80
|
p.RemotePort = 80
|
||||||
// Drop outbound
|
// Drop outbound
|
||||||
assert.Equal(t, fw.Drop(*p, false, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, false, &h, cp), ErrNoMatchingRule)
|
||||||
// Allow inbound
|
// Allow inbound
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
assert.Equal(t, fw.Drop(*p, true, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, true, &h, cp), ErrNoMatchingRule)
|
||||||
//now also allow outbound
|
//now also allow outbound
|
||||||
assert.Equal(t, fw.Drop(*p, false, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, false, &h, cp), ErrNoMatchingRule)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
t.Run("Any proto, any port", func(t *testing.T) {
|
t.Run("Any proto, any port", func(t *testing.T) {
|
||||||
@@ -844,12 +818,12 @@ func TestFirewall_ICMPPortBehavior(t *testing.T) {
|
|||||||
p.LocalPort = 0
|
p.LocalPort = 0
|
||||||
p.RemotePort = 0
|
p.RemotePort = 0
|
||||||
// Drop outbound
|
// Drop outbound
|
||||||
assert.Equal(t, fw.Drop(*p, false, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, false, &h, cp), ErrNoMatchingRule)
|
||||||
// Allow inbound
|
// Allow inbound
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
require.NoError(t, fw.Drop(*p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(*p, true, &h, cp))
|
||||||
//now also allow outbound
|
//now also allow outbound
|
||||||
require.NoError(t, fw.Drop(*p, false, &h, cp, nil))
|
require.NoError(t, fw.Drop(*p, false, &h, cp))
|
||||||
})
|
})
|
||||||
|
|
||||||
t.Run("nonzero ports, allowed", func(t *testing.T) {
|
t.Run("nonzero ports, allowed", func(t *testing.T) {
|
||||||
@@ -858,15 +832,15 @@ func TestFirewall_ICMPPortBehavior(t *testing.T) {
|
|||||||
p.LocalPort = 0xabcd
|
p.LocalPort = 0xabcd
|
||||||
p.RemotePort = 0x1234
|
p.RemotePort = 0x1234
|
||||||
// Drop outbound
|
// Drop outbound
|
||||||
assert.Equal(t, fw.Drop(*p, false, &h, cp, nil), ErrNoMatchingRule)
|
assert.Equal(t, fw.Drop(*p, false, &h, cp), ErrNoMatchingRule)
|
||||||
// Allow inbound
|
// Allow inbound
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
require.NoError(t, fw.Drop(*p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(*p, true, &h, cp))
|
||||||
//now also allow outbound
|
//now also allow outbound
|
||||||
require.NoError(t, fw.Drop(*p, false, &h, cp, nil))
|
require.NoError(t, fw.Drop(*p, false, &h, cp))
|
||||||
//different ID is blocked
|
//different ID is blocked
|
||||||
p.RemotePort++
|
p.RemotePort++
|
||||||
require.Equal(t, fw.Drop(*p, false, &h, cp, nil), ErrNoMatchingRule)
|
require.Equal(t, fw.Drop(*p, false, &h, cp), ErrNoMatchingRule)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -914,7 +888,7 @@ func TestFirewall_DropIPSpoofing(t *testing.T) {
|
|||||||
Protocol: iputil.IPProtocolUDP,
|
Protocol: iputil.IPProtocolUDP,
|
||||||
Fragment: false,
|
Fragment: false,
|
||||||
}
|
}
|
||||||
assert.Equal(t, fw.Drop(p, true, &h1, cp, nil), ErrInvalidRemoteIP)
|
assert.Equal(t, fw.Drop(p, true, &h1, cp), ErrInvalidRemoteIP)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFirewall_ConntrackSourceSpoofingAcrossPeers(t *testing.T) {
|
func TestFirewall_ConntrackSourceSpoofingAcrossPeers(t *testing.T) {
|
||||||
@@ -965,20 +939,84 @@ func TestFirewall_ConntrackSourceSpoofingAcrossPeers(t *testing.T) {
|
|||||||
Protocol: iputil.IPProtocolUDP,
|
Protocol: iputil.IPProtocolUDP,
|
||||||
}
|
}
|
||||||
|
|
||||||
require.NoError(t, fw.Drop(flow, true, &victimHI, cp, nil),
|
require.NoError(t, fw.Drop(flow, true, &victimHI, cp),
|
||||||
"victim's own traffic from its own overlay IP must be allowed")
|
"victim's own traffic from its own overlay IP must be allowed")
|
||||||
|
|
||||||
unseen := flow
|
unseen := flow
|
||||||
unseen.RemotePort = 55001
|
unseen.RemotePort = 55001
|
||||||
assert.Equal(t, ErrInvalidRemoteIP, fw.Drop(unseen, true, &attackerHI, cp, nil),
|
assert.Equal(t, ErrInvalidRemoteIP, fw.Drop(unseen, true, &attackerHI, cp),
|
||||||
"sanity: attacker forging victim's source IP must be rejected when no conntrack entry exists")
|
"sanity: attacker forging victim's source IP must be rejected when no conntrack entry exists")
|
||||||
|
|
||||||
got := fw.Drop(flow, true, &attackerHI, cp, nil)
|
got := fw.Drop(flow, true, &attackerHI, cp)
|
||||||
t.Logf("attacker replaying victim's 4-tuple: Drop returned %v (nil == packet ALLOWED == spoof succeeded)", got)
|
t.Logf("attacker replaying victim's 4-tuple: Drop returned %v (nil == packet ALLOWED == spoof succeeded)", got)
|
||||||
assert.Equal(t, ErrInvalidRemoteIP, got,
|
assert.Equal(t, ErrInvalidRemoteIP, got,
|
||||||
"SECURITY: attacker spoofed victim's overlay source IP (192.0.2.2) by reusing an existing conntrack 4-tuple; Drop returned %v instead of rejecting", got)
|
"SECURITY: attacker spoofed victim's overlay source IP (192.0.2.2) by reusing an existing conntrack 4-tuple; Drop returned %v instead of rejecting", got)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestFirewallConntrack_sweep(t *testing.T) {
|
||||||
|
ct := newFirewallConntrack()
|
||||||
|
live := firewall.Packet{LocalPort: 1}
|
||||||
|
dead := firewall.Packet{LocalPort: 2}
|
||||||
|
ct.store(live, newConn(11, true, 0))
|
||||||
|
ct.store(dead, newConn(10, true, 0))
|
||||||
|
assert.Equal(t, int64(2), ct.count.Load())
|
||||||
|
|
||||||
|
ct.sweep(10)
|
||||||
|
_, ok := ct.conns.Load(live)
|
||||||
|
assert.True(t, ok)
|
||||||
|
_, ok = ct.conns.Load(dead)
|
||||||
|
assert.False(t, ok)
|
||||||
|
assert.Equal(t, int64(1), ct.count.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFirewallConntrack_storeAndDeleteCount(t *testing.T) {
|
||||||
|
ct := newFirewallConntrack()
|
||||||
|
fp := firewall.Packet{LocalPort: 1}
|
||||||
|
first := newConn(10, true, 0)
|
||||||
|
ct.store(fp, first)
|
||||||
|
|
||||||
|
// Replacing an entry doesn't add to the count
|
||||||
|
second := newConn(20, true, 1)
|
||||||
|
ct.store(fp, second)
|
||||||
|
assert.Equal(t, int64(1), ct.count.Load())
|
||||||
|
|
||||||
|
// Deleting a stale entry is a no-op, the newer one stays
|
||||||
|
ct.delete(fp, first)
|
||||||
|
v, ok := ct.conns.Load(fp)
|
||||||
|
assert.True(t, ok)
|
||||||
|
assert.Same(t, second, v)
|
||||||
|
assert.Equal(t, int64(1), ct.count.Load())
|
||||||
|
|
||||||
|
ct.delete(fp, second)
|
||||||
|
_, ok = ct.conns.Load(fp)
|
||||||
|
assert.False(t, ok)
|
||||||
|
assert.Equal(t, int64(0), ct.count.Load())
|
||||||
|
|
||||||
|
ct.store(fp, first)
|
||||||
|
ct.store(firewall.Packet{LocalPort: 2}, newConn(10, true, 0))
|
||||||
|
ct.clear()
|
||||||
|
assert.Equal(t, int64(0), ct.count.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFirewallConntrack_Run(t *testing.T) {
|
||||||
|
ct := newFirewallConntrack()
|
||||||
|
ct.epoch = time.Now().Add(-time.Hour)
|
||||||
|
ct.store(firewall.Packet{LocalPort: 1}, newConn(10, true, 0))
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
ct.Run(ctx)
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
|
||||||
|
// The first tick sets the clock to an hour in and sweeps the long expired entry
|
||||||
|
require.Eventually(t, func() bool { return ct.count.Load() == 0 }, 5*time.Second, 10*time.Millisecond)
|
||||||
|
assert.GreaterOrEqual(t, ct.now.Load(), uint32(3600))
|
||||||
|
cancel()
|
||||||
|
<-done
|
||||||
|
}
|
||||||
|
|
||||||
// BenchmarkFirewallDropConntrackHit measures Drop on an already-established flow
|
// BenchmarkFirewallDropConntrackHit measures Drop on an already-established flow
|
||||||
// (a conntrack hit). This is the fast path that the source-IP<->cert binding
|
// (a conntrack hit). This is the fast path that the source-IP<->cert binding
|
||||||
// reordering adds work to, so it quantifies the cost of moving the address checks
|
// reordering adds work to, so it quantifies the cost of moving the address checks
|
||||||
@@ -987,8 +1025,6 @@ func TestFirewall_ConntrackSourceSpoofingAcrossPeers(t *testing.T) {
|
|||||||
// so the remote-address check is a single netip.Addr compare.
|
// so the remote-address check is a single netip.Addr compare.
|
||||||
// - complex: peer cert has unsafe networks (h.networks populated), so the
|
// - complex: peer cert has unsafe networks (h.networks populated), so the
|
||||||
// remote-address check is a BART lookup.
|
// remote-address check is a BART lookup.
|
||||||
// - noCache/localCache: whether a per-batch ConntrackCache is supplied, which in
|
|
||||||
// the original code let the fast path skip straight past the address checks.
|
|
||||||
func BenchmarkFirewallDropConntrackHit(b *testing.B) {
|
func BenchmarkFirewallDropConntrackHit(b *testing.B) {
|
||||||
l := test.NewLoggerWithOutput(&bytes.Buffer{})
|
l := test.NewLoggerWithOutput(&bytes.Buffer{})
|
||||||
|
|
||||||
@@ -1038,12 +1074,9 @@ func BenchmarkFirewallDropConntrackHit(b *testing.B) {
|
|||||||
cases := []struct {
|
cases := []struct {
|
||||||
name string
|
name string
|
||||||
host *HostInfo
|
host *HostInfo
|
||||||
useCache bool
|
|
||||||
}{
|
}{
|
||||||
{"simple/noCache", simpleHost, false},
|
{"simple", simpleHost},
|
||||||
{"simple/localCache", simpleHost, true},
|
{"complex", complexHost},
|
||||||
{"complex/noCache", complexHost, false},
|
|
||||||
{"complex/localCache", complexHost, true},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tc := range cases {
|
for _, tc := range cases {
|
||||||
@@ -1052,17 +1085,12 @@ func BenchmarkFirewallDropConntrackHit(b *testing.B) {
|
|||||||
require.NoError(b, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"any"}, "", "", "", "", ""))
|
require.NoError(b, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"any"}, "", "", "", "", ""))
|
||||||
|
|
||||||
// Establish the conntrack entry so every benchmarked Drop is a hit.
|
// Establish the conntrack entry so every benchmarked Drop is a hit.
|
||||||
require.NoError(b, fw.Drop(flow, true, tc.host, cp, nil))
|
require.NoError(b, fw.Drop(flow, true, tc.host, cp))
|
||||||
|
|
||||||
var cache firewall.ConntrackCache
|
|
||||||
if tc.useCache {
|
|
||||||
cache = firewall.ConntrackCache{}
|
|
||||||
}
|
|
||||||
|
|
||||||
b.ReportAllocs()
|
b.ReportAllocs()
|
||||||
b.ResetTimer()
|
b.ResetTimer()
|
||||||
for i := 0; i < b.N; i++ {
|
for i := 0; i < b.N; i++ {
|
||||||
if err := fw.Drop(flow, true, tc.host, cp, cache); err != nil {
|
if err := fw.Drop(flow, true, tc.host, cp); err != nil {
|
||||||
b.Fatal(err)
|
b.Fatal(err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1550,7 +1578,7 @@ func (c *testcase) Test(t *testing.T, fw *Firewall) {
|
|||||||
t.Helper()
|
t.Helper()
|
||||||
cp := cert.NewCAPool()
|
cp := cert.NewCAPool()
|
||||||
resetConntrack(fw)
|
resetConntrack(fw)
|
||||||
err := fw.Drop(c.p, true, c.h, cp, nil)
|
err := fw.Drop(c.p, true, c.h, cp)
|
||||||
if c.err == nil {
|
if c.err == nil {
|
||||||
require.NoError(t, err, "failed to not drop remote address %s", c.p.RemoteAddr)
|
require.NoError(t, err, "failed to not drop remote address %s", c.p.RemoteAddr)
|
||||||
} else {
|
} else {
|
||||||
@@ -1741,7 +1769,5 @@ func (mf *mockFirewall) AddRule(incoming bool, proto uint8, startPort int32, end
|
|||||||
}
|
}
|
||||||
|
|
||||||
func resetConntrack(fw *Firewall) {
|
func resetConntrack(fw *Firewall) {
|
||||||
fw.Conntrack.Lock()
|
fw.Conntrack.clear()
|
||||||
fw.Conntrack.Conns = map[firewall.Packet]*conn{}
|
|
||||||
fw.Conntrack.Unlock()
|
|
||||||
}
|
}
|
||||||
@@ -16,7 +16,7 @@ import (
|
|||||||
"github.com/slackhq/nebula/routing"
|
"github.com/slackhq/nebula/routing"
|
||||||
)
|
)
|
||||||
|
|
||||||
func (f *Interface) consumeInsidePacket(pkt tio.Packet, fwPacket *firewall.ParsedPacket, nb []byte, sendBatch *batch.SendBatch, rejectBuf []byte, q int, localCache firewall.ConntrackCache) {
|
func (f *Interface) consumeInsidePacket(pkt tio.Packet, fwPacket *firewall.ParsedPacket, nb []byte, sendBatch *batch.SendBatch, rejectBuf []byte, q int) {
|
||||||
// borrowed: pkt.Bytes is owned by the originating tio.Queue and is
|
// borrowed: pkt.Bytes is owned by the originating tio.Queue and is
|
||||||
// only valid until the next Read on that queue. Every consumer below
|
// only valid until the next Read on that queue. Every consumer below
|
||||||
// (parse, self-forward, handshake cache, sendInsideMessage) reads it
|
// (parse, self-forward, handshake cache, sendInsideMessage) reads it
|
||||||
@@ -109,7 +109,7 @@ func (f *Interface) consumeInsidePacket(pkt tio.Packet, fwPacket *firewall.Parse
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
dropReason := f.firewall.Drop(fwPacket.Packet, false, hostinfo, f.pki.GetCAPool(), localCache)
|
dropReason := f.firewall.Drop(fwPacket.Packet, false, hostinfo, f.pki.GetCAPool())
|
||||||
if dropReason == nil {
|
if dropReason == nil {
|
||||||
f.sendInsideMessage(hostinfo, pkt, nb, sendBatch)
|
f.sendInsideMessage(hostinfo, pkt, nb, sendBatch)
|
||||||
} else {
|
} else {
|
||||||
@@ -380,7 +380,7 @@ func (f *Interface) sendMessageNow(t header.MessageType, st header.MessageSubTyp
|
|||||||
}
|
}
|
||||||
|
|
||||||
// check if packet is in outbound fw rules
|
// check if packet is in outbound fw rules
|
||||||
dropReason := f.firewall.Drop(fp.Packet, false, hostinfo, f.pki.GetCAPool(), nil)
|
dropReason := f.firewall.Drop(fp.Packet, false, hostinfo, f.pki.GetCAPool())
|
||||||
if dropReason != nil {
|
if dropReason != nil {
|
||||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||||
f.l.Debug("dropping cached packet",
|
f.l.Debug("dropping cached packet",
|
||||||
|
|||||||
+1
-1
@@ -50,7 +50,7 @@ func newSelfForwardInterface(myAddrs ...netip.Addr) (*Interface, *capturingTun)
|
|||||||
}
|
}
|
||||||
|
|
||||||
func consumeInside(f *Interface, packet []byte) {
|
func consumeInside(f *Interface, packet []byte) {
|
||||||
f.consumeInsidePacket(tio.Packet{Bytes: packet}, &firewall.ParsedPacket{}, make([]byte, 12), nil, make([]byte, mtu), 0, nil)
|
f.consumeInsidePacket(tio.Packet{Bytes: packet}, &firewall.ParsedPacket{}, make([]byte, 12), nil, make([]byte, mtu), 0)
|
||||||
}
|
}
|
||||||
|
|
||||||
// l4Proto describes one upper-layer header for these tests: its IP next-header
|
// l4Proto describes one upper-layer header for these tests: its IP next-header
|
||||||
|
|||||||
+17
-16
@@ -52,8 +52,6 @@ type InterfaceConfig struct {
|
|||||||
reQueryEvery uint32
|
reQueryEvery uint32
|
||||||
reQueryWait time.Duration
|
reQueryWait time.Duration
|
||||||
|
|
||||||
ConntrackCacheTimeout time.Duration
|
|
||||||
|
|
||||||
// CpuAffinity, when non-empty, names the CPUs each TUN reader goroutine
|
// CpuAffinity, when non-empty, names the CPUs each TUN reader goroutine
|
||||||
// should pin to. Queue i pins to CpuAffinity[i % len(CpuAffinity)] —
|
// should pin to. Queue i pins to CpuAffinity[i % len(CpuAffinity)] —
|
||||||
// shorter lists than `routines` cycle. Empty list keeps the default
|
// shorter lists than `routines` cycle. Empty list keeps the default
|
||||||
@@ -111,8 +109,6 @@ type Interface struct {
|
|||||||
rebindEpoch atomic.Uint32
|
rebindEpoch atomic.Uint32
|
||||||
version string
|
version string
|
||||||
|
|
||||||
conntrackCacheTimeout time.Duration
|
|
||||||
|
|
||||||
ctx context.Context
|
ctx context.Context
|
||||||
writers []udp.Conn
|
writers []udp.Conn
|
||||||
queues []tio.Queue
|
queues []tio.Queue
|
||||||
@@ -227,7 +223,6 @@ func NewInterface(ctx context.Context, c *InterfaceConfig) (*Interface, error) {
|
|||||||
myBroadcastAddrsTable: cs.myVpnBroadcastAddrsTable,
|
myBroadcastAddrsTable: cs.myVpnBroadcastAddrsTable,
|
||||||
relayManager: c.relayManager,
|
relayManager: c.relayManager,
|
||||||
connectionManager: c.connectionManager,
|
connectionManager: c.connectionManager,
|
||||||
conntrackCacheTimeout: c.ConntrackCacheTimeout,
|
|
||||||
cpuAffinity: c.CpuAffinity,
|
cpuAffinity: c.CpuAffinity,
|
||||||
pinThreads: c.PinThreads,
|
pinThreads: c.PinThreads,
|
||||||
|
|
||||||
@@ -361,8 +356,19 @@ type rxContext struct {
|
|||||||
h *header.H
|
h *header.H
|
||||||
fwPacket *firewall.ParsedPacket
|
fwPacket *firewall.ParsedPacket
|
||||||
hostmapCache map[uint32]*HostInfo
|
hostmapCache map[uint32]*HostInfo
|
||||||
|
|
||||||
|
// lastAllowed is the last flow the inbound firewall let in during this batch. UDP GRO hands us segments
|
||||||
|
// in runs from the same flow, so the rest of a run can skip the firewall. Cleared by endBatch.
|
||||||
|
lastAllowed firewall.Packet
|
||||||
|
lastAllowedHost *HostInfo
|
||||||
lhh *LightHouseHandler
|
lhh *LightHouseHandler
|
||||||
ctCache *firewall.ConntrackCacheTicker
|
}
|
||||||
|
|
||||||
|
// endBatch forgets what was learned during a batch, so nothing outlives a hostmap or firewall change by more than one batch
|
||||||
|
func (rxc *rxContext) endBatch() {
|
||||||
|
clear(rxc.hostmapCache)
|
||||||
|
rxc.lastAllowed = firewall.Packet{}
|
||||||
|
rxc.lastAllowedHost = nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func newRxContext(f *Interface, q int) *rxContext {
|
func newRxContext(f *Interface, q int) *rxContext {
|
||||||
@@ -374,7 +380,6 @@ func newRxContext(f *Interface, q int) *rxContext {
|
|||||||
fwPacket: &firewall.ParsedPacket{},
|
fwPacket: &firewall.ParsedPacket{},
|
||||||
hostmapCache: map[uint32]*HostInfo{},
|
hostmapCache: map[uint32]*HostInfo{},
|
||||||
lhh: f.lightHouse.NewRequestHandler(),
|
lhh: f.lightHouse.NewRequestHandler(),
|
||||||
ctCache: firewall.NewConntrackCacheTicker(f.ctx, f.l, f.conntrackCacheTimeout),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -396,7 +401,7 @@ func (f *Interface) listenOut(i int) {
|
|||||||
if err := f.batchers[i].Flush(); err != nil {
|
if err := f.batchers[i].Flush(); err != nil {
|
||||||
f.l.Error("Failed to flush tun coalescer", "error", err)
|
f.l.Error("Failed to flush tun coalescer", "error", err)
|
||||||
}
|
}
|
||||||
clear(rxc.hostmapCache)
|
rxc.endBatch()
|
||||||
}
|
}
|
||||||
|
|
||||||
err := li.ListenOut(listener, flusher)
|
err := li.ListenOut(listener, flusher)
|
||||||
@@ -444,8 +449,6 @@ func (f *Interface) listenIn(queue tio.Queue, i int) {
|
|||||||
fwPacket := &firewall.ParsedPacket{}
|
fwPacket := &firewall.ParsedPacket{}
|
||||||
nb := make([]byte, 12, 12)
|
nb := make([]byte, 12, 12)
|
||||||
|
|
||||||
conntrackCache := firewall.NewConntrackCacheTicker(f.ctx, f.l, f.conntrackCacheTimeout)
|
|
||||||
|
|
||||||
for {
|
for {
|
||||||
pkts, err := queue.Read()
|
pkts, err := queue.Read()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -458,7 +461,7 @@ func (f *Interface) listenIn(queue tio.Queue, i int) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
for _, pkt := range pkts {
|
for _, pkt := range pkts {
|
||||||
f.consumeInsidePacket(pkt, fwPacket, nb, sb, rejectBuf, i, conntrackCache.Get())
|
f.consumeInsidePacket(pkt, fwPacket, nb, sb, rejectBuf, i)
|
||||||
// Flush incrementally once a full sendmmsg batch has
|
// Flush incrementally once a full sendmmsg batch has
|
||||||
// accumulated so the first packets of a deep read drain
|
// accumulated so the first packets of a deep read drain
|
||||||
// hit the wire while the rest are still being encrypted.
|
// hit the wire while the rest are still being encrypted.
|
||||||
@@ -531,9 +534,8 @@ func (f *Interface) reloadFirewall(c *config.C) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
oldFw := f.firewall
|
oldFw := f.firewall
|
||||||
conntrack := oldFw.Conntrack
|
// Conntrack lives as long as the interface, keep using the running one
|
||||||
conntrack.Lock()
|
fw.Conntrack = oldFw.Conntrack
|
||||||
defer conntrack.Unlock()
|
|
||||||
|
|
||||||
fw.rulesVersion = oldFw.rulesVersion + 1
|
fw.rulesVersion = oldFw.rulesVersion + 1
|
||||||
// If rulesVersion is back to zero, we have wrapped all the way around. Be
|
// If rulesVersion is back to zero, we have wrapped all the way around. Be
|
||||||
@@ -544,8 +546,7 @@ func (f *Interface) reloadFirewall(c *config.C) {
|
|||||||
"oldFirewallHashes", oldFw.GetRuleHashes(),
|
"oldFirewallHashes", oldFw.GetRuleHashes(),
|
||||||
"rulesVersion", fw.rulesVersion,
|
"rulesVersion", fw.rulesVersion,
|
||||||
)
|
)
|
||||||
} else {
|
fw.Conntrack.clear()
|
||||||
fw.Conntrack = conntrack
|
|
||||||
}
|
}
|
||||||
|
|
||||||
f.firewall = fw
|
f.firewall = fw
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ import (
|
|||||||
|
|
||||||
"github.com/rcrowley/go-metrics"
|
"github.com/rcrowley/go-metrics"
|
||||||
"github.com/slackhq/nebula/cert"
|
"github.com/slackhq/nebula/cert"
|
||||||
"github.com/slackhq/nebula/firewall"
|
|
||||||
"github.com/slackhq/nebula/overlay/overlaytest"
|
"github.com/slackhq/nebula/overlay/overlaytest"
|
||||||
"github.com/slackhq/nebula/test"
|
"github.com/slackhq/nebula/test"
|
||||||
"github.com/slackhq/nebula/udp"
|
"github.com/slackhq/nebula/udp"
|
||||||
@@ -43,7 +42,7 @@ func Test_emitStats_primesGauges(t *testing.T) {
|
|||||||
hostMap: hostMap,
|
hostMap: hostMap,
|
||||||
inside: &overlaytest.NoopTun{},
|
inside: &overlaytest.NoopTun{},
|
||||||
outside: &udp.NoopConn{},
|
outside: &udp.NoopConn{},
|
||||||
firewall: &Firewall{Conntrack: &FirewallConntrack{Conns: map[firewall.Packet]*conn{}}},
|
firewall: &Firewall{Conntrack: newFirewallConntrack()},
|
||||||
lightHouse: lh,
|
lightHouse: lh,
|
||||||
pki: &PKI{},
|
pki: &PKI{},
|
||||||
handshakeManager: NewHandshakeManager(l, hostMap, lh, &udp.NoopConn{}, defaultHandshakeConfig),
|
handshakeManager: NewHandshakeManager(l, hostMap, lh, &udp.NoopConn{}, defaultHandshakeConfig),
|
||||||
|
|||||||
@@ -1,5 +0,0 @@
|
|||||||
// Package msgx calls xnu's private batched socket calls, sendmsg_x and recvmsg_x, through libSystem.
|
|
||||||
//
|
|
||||||
// The calls are not public API, so the package never links them: it looks them up with dlsym on first use.
|
|
||||||
// The package is darwin-only, and on iOS Available is always false, so App Store builds keep to public API.
|
|
||||||
package msgx
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
package msgx
|
|
||||||
|
|
||||||
import "golang.org/x/sys/unix"
|
|
||||||
|
|
||||||
// Hdr mirrors xnu's struct msghdr_x (bsd/sys/socket_private.h), which the SDK doesn't ship.
|
|
||||||
// recvmsg_x reports each message's length in Datalen rather than in its return value.
|
|
||||||
type Hdr struct {
|
|
||||||
Name *byte
|
|
||||||
Namelen uint32
|
|
||||||
Iov *unix.Iovec
|
|
||||||
Iovlen int32
|
|
||||||
Control *byte
|
|
||||||
Controllen uint32
|
|
||||||
Flags int32
|
|
||||||
Datalen uint64
|
|
||||||
}
|
|
||||||
@@ -1,77 +0,0 @@
|
|||||||
//go:build !ios
|
|
||||||
|
|
||||||
package msgx
|
|
||||||
|
|
||||||
import (
|
|
||||||
"sync"
|
|
||||||
"syscall"
|
|
||||||
"unsafe"
|
|
||||||
)
|
|
||||||
|
|
||||||
// dlsym is public libSystem API, imported the way x/sys/unix imports its libSystem stubs. The local name is
|
|
||||||
// distinct from runtime/race's dlsym import.
|
|
||||||
//
|
|
||||||
//go:cgo_import_dynamic msgx_dlsym dlsym "/usr/lib/libSystem.B.dylib"
|
|
||||||
|
|
||||||
// dlsymTrampolineAddr is the address of msgx_darwin.s's jump to dlsym.
|
|
||||||
var dlsymTrampolineAddr uintptr
|
|
||||||
|
|
||||||
// syscall6X calls the C function at fn on the system stack and returns errno when it returns a 64-bit -1.
|
|
||||||
// It is how x/sys/unix calls libSystem, and the runtime keeps it linkable for that.
|
|
||||||
//
|
|
||||||
//go:linkname syscall6X syscall.syscall6X
|
|
||||||
func syscall6X(fn, a1, a2, a3, a4, a5, a6 uintptr) (r1, r2 uintptr, err syscall.Errno)
|
|
||||||
|
|
||||||
// rtldDefault is dlfcn.h's RTLD_DEFAULT, ((void *)-2): search every image loaded in the process.
|
|
||||||
const rtldDefault = ^uintptr(1)
|
|
||||||
|
|
||||||
var (
|
|
||||||
sendmsgXName = []byte("sendmsg_x\x00")
|
|
||||||
recvmsgXName = []byte("recvmsg_x\x00")
|
|
||||||
)
|
|
||||||
|
|
||||||
type funcs struct {
|
|
||||||
sendmsgX uintptr
|
|
||||||
recvmsgX uintptr
|
|
||||||
}
|
|
||||||
|
|
||||||
var resolve = sync.OnceValue(func() funcs {
|
|
||||||
return funcs{sendmsgX: lookup(sendmsgXName), recvmsgX: lookup(recvmsgXName)}
|
|
||||||
})
|
|
||||||
|
|
||||||
// lookup returns the address of the NUL-terminated C symbol name, or 0 when no loaded image exports it.
|
|
||||||
func lookup(name []byte) uintptr {
|
|
||||||
p, _, _ := syscall6X(dlsymTrampolineAddr, rtldDefault, uintptr(unsafe.Pointer(&name[0])), 0, 0, 0, 0)
|
|
||||||
return p
|
|
||||||
}
|
|
||||||
|
|
||||||
// Available reports whether libSystem exports both sendmsg_x and recvmsg_x. When it is false, Send and Recv
|
|
||||||
// return ENOSYS.
|
|
||||||
func Available() bool {
|
|
||||||
f := resolve()
|
|
||||||
return f.sendmsgX != 0 && f.recvmsgX != 0
|
|
||||||
}
|
|
||||||
|
|
||||||
// Send passes hdrs to sendmsg_x on fd and returns how many messages the kernel took.
|
|
||||||
func Send(fd uintptr, hdrs []Hdr, flags int) (int, syscall.Errno) {
|
|
||||||
return call(resolve().sendmsgX, fd, hdrs, flags)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Recv passes hdrs to recvmsg_x on fd and returns how many messages it filled.
|
|
||||||
func Recv(fd uintptr, hdrs []Hdr, flags int) (int, syscall.Errno) {
|
|
||||||
return call(resolve().recvmsgX, fd, hdrs, flags)
|
|
||||||
}
|
|
||||||
|
|
||||||
func call(fn, fd uintptr, hdrs []Hdr, flags int) (int, syscall.Errno) {
|
|
||||||
if fn == 0 {
|
|
||||||
return 0, syscall.ENOSYS
|
|
||||||
}
|
|
||||||
if len(hdrs) == 0 {
|
|
||||||
return 0, syscall.EINVAL
|
|
||||||
}
|
|
||||||
r, _, errno := syscall6X(fn, fd, uintptr(unsafe.Pointer(&hdrs[0])), uintptr(len(hdrs)), uintptr(flags), 0, 0)
|
|
||||||
if errno != 0 {
|
|
||||||
return 0, errno
|
|
||||||
}
|
|
||||||
return int(r), 0
|
|
||||||
}
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
//go:build !ios
|
|
||||||
|
|
||||||
#include "textflag.h"
|
|
||||||
|
|
||||||
// The same trampoline shape x/sys/unix uses for its libSystem stubs; it assembles for amd64 and arm64 alike.
|
|
||||||
TEXT msgx_dlsym_trampoline<>(SB),NOSPLIT,$0-0
|
|
||||||
JMP msgx_dlsym(SB)
|
|
||||||
GLOBL ·dlsymTrampolineAddr(SB), RODATA, $8
|
|
||||||
DATA ·dlsymTrampolineAddr(SB)/8, $msgx_dlsym_trampoline<>(SB)
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
//go:build !ios
|
|
||||||
|
|
||||||
package msgx
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"syscall"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestAvailable pins that dlsym finds both calls in this macOS's libSystem, so the batched paths are live.
|
|
||||||
func TestAvailable(t *testing.T) {
|
|
||||||
assert.True(t, Available())
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSendRecvRoundTrip pins the libSystem calling path end to end: a batch goes out through sendmsg_x in one
|
|
||||||
// call and comes back through recvmsg_x in one call, each message whole, in order, with Datalen set.
|
|
||||||
func TestSendRecvRoundTrip(t *testing.T) {
|
|
||||||
fds, err := unix.Socketpair(unix.AF_UNIX, unix.SOCK_DGRAM, 0)
|
|
||||||
require.NoError(t, err)
|
|
||||||
t.Cleanup(func() {
|
|
||||||
_ = unix.Close(fds[0])
|
|
||||||
_ = unix.Close(fds[1])
|
|
||||||
})
|
|
||||||
// A dropped datagram fails the receive instead of hanging it.
|
|
||||||
require.NoError(t, unix.SetsockoptTimeval(fds[1], unix.SOL_SOCKET, unix.SO_RCVTIMEO, &unix.Timeval{Sec: 2}))
|
|
||||||
|
|
||||||
const n = 5
|
|
||||||
var want [n][]byte
|
|
||||||
var iovs [n]unix.Iovec
|
|
||||||
hdrs := make([]Hdr, n)
|
|
||||||
for i := range n {
|
|
||||||
want[i] = bytes.Repeat([]byte{byte(i + 1)}, 10+i)
|
|
||||||
iovs[i] = unix.Iovec{Base: &want[i][0]}
|
|
||||||
iovs[i].SetLen(len(want[i]))
|
|
||||||
hdrs[i] = Hdr{Iov: &iovs[i], Iovlen: 1}
|
|
||||||
}
|
|
||||||
sent, errno := Send(uintptr(fds[0]), hdrs, 0)
|
|
||||||
require.Zero(t, errno)
|
|
||||||
require.Equal(t, n, sent)
|
|
||||||
|
|
||||||
var bufs [n + 1][64]byte
|
|
||||||
var riovs [n + 1]unix.Iovec
|
|
||||||
rhdrs := make([]Hdr, n+1)
|
|
||||||
for i := range rhdrs {
|
|
||||||
riovs[i] = unix.Iovec{Base: &bufs[i][0]}
|
|
||||||
riovs[i].SetLen(len(bufs[i]))
|
|
||||||
rhdrs[i] = Hdr{Iov: &riovs[i], Iovlen: 1}
|
|
||||||
}
|
|
||||||
got, errno := Recv(uintptr(fds[1]), rhdrs, 0)
|
|
||||||
require.Zero(t, errno)
|
|
||||||
require.Equal(t, n, got)
|
|
||||||
for i := range n {
|
|
||||||
l := int(rhdrs[i].Datalen)
|
|
||||||
assert.Equal(t, want[i], bufs[i][:l], "message %d", i)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestEmptyBatch pins that an empty batch is refused before it reaches the kernel.
|
|
||||||
func TestEmptyBatch(t *testing.T) {
|
|
||||||
_, errno := Send(0, nil, 0)
|
|
||||||
assert.Equal(t, syscall.EINVAL, errno)
|
|
||||||
_, errno = Recv(0, nil, 0)
|
|
||||||
assert.Equal(t, syscall.EINVAL, errno)
|
|
||||||
}
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
package msgx
|
|
||||||
|
|
||||||
import "syscall"
|
|
||||||
|
|
||||||
// Available is always false on iOS, so App Store builds never look up private symbols.
|
|
||||||
func Available() bool { return false }
|
|
||||||
|
|
||||||
// Send always returns ENOSYS on iOS.
|
|
||||||
func Send(uintptr, []Hdr, int) (int, syscall.Errno) { return 0, syscall.ENOSYS }
|
|
||||||
|
|
||||||
// Recv always returns ENOSYS on iOS.
|
|
||||||
func Recv(uintptr, []Hdr, int) (int, syscall.Errno) { return 0, syscall.ENOSYS }
|
|
||||||
+12
-3
@@ -15,6 +15,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/gaissmai/bart"
|
"github.com/gaissmai/bart"
|
||||||
|
"github.com/rcrowley/go-metrics"
|
||||||
"github.com/slackhq/nebula/cert"
|
"github.com/slackhq/nebula/cert"
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
"github.com/slackhq/nebula/header"
|
"github.com/slackhq/nebula/header"
|
||||||
@@ -81,6 +82,8 @@ type LightHouse struct {
|
|||||||
|
|
||||||
updateTrigger chan struct{}
|
updateTrigger chan struct{}
|
||||||
queryChan chan netip.Addr
|
queryChan chan netip.Addr
|
||||||
|
// queryDropped counts queries QueryServer dropped because queryChan was full.
|
||||||
|
queryDropped metrics.Counter
|
||||||
|
|
||||||
calculatedRemotes atomic.Pointer[bart.Table[[]*calculatedRemote]] // Maps VpnAddr to []*calculatedRemote
|
calculatedRemotes atomic.Pointer[bart.Table[[]*calculatedRemote]] // Maps VpnAddr to []*calculatedRemote
|
||||||
|
|
||||||
@@ -116,7 +119,8 @@ func NewLightHouseFromConfig(ctx context.Context, l *slog.Logger, c *config.C, c
|
|||||||
nebulaPort: nebulaPort,
|
nebulaPort: nebulaPort,
|
||||||
punchy: p,
|
punchy: p,
|
||||||
updateTrigger: make(chan struct{}, 1),
|
updateTrigger: make(chan struct{}, 1),
|
||||||
queryChan: make(chan netip.Addr, c.GetUint32("handshakes.query_buffer", 64)),
|
queryChan: make(chan netip.Addr, c.GetUint32("handshakes.query_buffer", 1024)),
|
||||||
|
queryDropped: metrics.GetOrRegisterCounter("lighthouse.query.dropped", nil),
|
||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
h.localAddrsFn = func(al *LocalAllowList) []netip.Addr {
|
h.localAddrsFn = func(al *LocalAllowList) []netip.Addr {
|
||||||
@@ -512,14 +516,19 @@ func (lh *LightHouse) Query(vpnAddr netip.Addr) *RemoteList {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// QueryServer is asynchronous so no reply should be expected
|
// QueryServer is asynchronous and non-blocking, no reply should be expected.
|
||||||
|
// If the query channel is full, the query is dropped.
|
||||||
func (lh *LightHouse) QueryServer(vpnAddr netip.Addr) {
|
func (lh *LightHouse) QueryServer(vpnAddr netip.Addr) {
|
||||||
// Don't put lighthouse addrs in the query channel because we can't query lighthouses about lighthouses
|
// Don't put lighthouse addrs in the query channel because we can't query lighthouses about lighthouses
|
||||||
if lh.amLighthouse || lh.IsLighthouseAddr(vpnAddr) {
|
if lh.amLighthouse || lh.IsLighthouseAddr(vpnAddr) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
lh.queryChan <- vpnAddr
|
select {
|
||||||
|
case lh.queryChan <- vpnAddr:
|
||||||
|
default:
|
||||||
|
lh.queryDropped.Inc(1)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (lh *LightHouse) QueryCache(vpnAddrs []netip.Addr) *RemoteList {
|
func (lh *LightHouse) QueryCache(vpnAddrs []netip.Addr) *RemoteList {
|
||||||
|
|||||||
@@ -6,7 +6,9 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
|
"sync"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/gaissmai/bart"
|
"github.com/gaissmai/bart"
|
||||||
"github.com/slackhq/nebula/cert"
|
"github.com/slackhq/nebula/cert"
|
||||||
@@ -795,3 +797,55 @@ func TestLightHouse_logLocalAddrsErr(t *testing.T) {
|
|||||||
lh.logLocalAddrsErr(errors.New("something else"))
|
lh.logLocalAddrsErr(errors.New("something else"))
|
||||||
assert.Contains(t, out.String(), "level=WARN")
|
assert.Contains(t, out.String(), "level=WARN")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// heldEncWriter holds the query worker in its first GetHostInfo until release closes.
|
||||||
|
type heldEncWriter struct {
|
||||||
|
mockEncWriter
|
||||||
|
once sync.Once
|
||||||
|
held chan struct{}
|
||||||
|
release chan struct{}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *heldEncWriter) GetHostInfo(netip.Addr) *HostInfo {
|
||||||
|
w.once.Do(func() { close(w.held) })
|
||||||
|
<-w.release
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// QueryServer never waits on the query worker, since the packet readers call it and nothing drains the channel at
|
||||||
|
// shutdown; a query that finds the channel full is dropped and counted. The worker is held on its first query so the
|
||||||
|
// channel fills.
|
||||||
|
func TestLighthouse_QueryServerDoesNotBlock(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
cs := testCertState(netip.MustParsePrefix("10.128.0.1/16"))
|
||||||
|
lh1 := "10.128.0.2"
|
||||||
|
c := config.NewC(l)
|
||||||
|
c.Settings["lighthouse"] = map[string]any{"hosts": []any{lh1}}
|
||||||
|
c.Settings["static_host_map"] = map[string]any{lh1: []any{"1.1.1.1:4242"}}
|
||||||
|
c.Settings["handshakes"] = map[string]any{"query_buffer": 1}
|
||||||
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
w := &heldEncWriter{held: make(chan struct{}), release: make(chan struct{})}
|
||||||
|
lh.ifce = w
|
||||||
|
t.Cleanup(func() { close(w.release) })
|
||||||
|
|
||||||
|
lh.QueryServer(netip.MustParseAddr("10.128.0.10"))
|
||||||
|
select {
|
||||||
|
case <-w.held:
|
||||||
|
case <-time.After(5 * time.Second):
|
||||||
|
t.Fatal("the query worker never took the first query")
|
||||||
|
}
|
||||||
|
dropped := lh.queryDropped.Count()
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
lh.QueryServer(netip.MustParseAddr("10.128.0.11"))
|
||||||
|
lh.QueryServer(netip.MustParseAddr("10.128.0.12"))
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(5 * time.Second):
|
||||||
|
t.Fatal("QueryServer blocked on a full query channel")
|
||||||
|
}
|
||||||
|
assert.EqualValues(t, 1, lh.queryDropped.Count()-dropped)
|
||||||
|
}
|
||||||
@@ -113,18 +113,6 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
|||||||
l.Info("Using multiple routines", "routines", routines)
|
l.Info("Using multiple routines", "routines", routines)
|
||||||
}
|
}
|
||||||
|
|
||||||
// EXPERIMENTAL
|
|
||||||
// Intentionally not documented yet while we do more testing and determine
|
|
||||||
// a good default value.
|
|
||||||
conntrackCacheTimeout := c.GetDuration("firewall.conntrack.routine_cache_timeout", 0)
|
|
||||||
if routines > 1 && !c.IsSet("firewall.conntrack.routine_cache_timeout") {
|
|
||||||
// Use a different default if we are running with multiple routines
|
|
||||||
conntrackCacheTimeout = 1 * time.Second
|
|
||||||
}
|
|
||||||
if conntrackCacheTimeout > 0 {
|
|
||||||
l.Info("Using routine-local conntrack cache", "duration", conntrackCacheTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
var tun overlay.Device
|
var tun overlay.Device
|
||||||
if !configTest {
|
if !configTest {
|
||||||
c.CatchHUP(ctx)
|
c.CatchHUP(ctx)
|
||||||
@@ -293,7 +281,6 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
|||||||
version: buildVersion,
|
version: buildVersion,
|
||||||
relayManager: NewRelayManager(ctx, l, hostMap, c),
|
relayManager: NewRelayManager(ctx, l, hostMap, c),
|
||||||
punchy: punchy,
|
punchy: punchy,
|
||||||
ConntrackCacheTimeout: conntrackCacheTimeout,
|
|
||||||
CpuAffinity: cpuAffinity,
|
CpuAffinity: cpuAffinity,
|
||||||
PinThreads: pinThreads,
|
PinThreads: pinThreads,
|
||||||
l: l,
|
l: l,
|
||||||
@@ -316,6 +303,7 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
|||||||
|
|
||||||
handshakeManager.f = ifce
|
handshakeManager.f = ifce
|
||||||
go handshakeManager.Run(ctx)
|
go handshakeManager.Run(ctx)
|
||||||
|
go ifce.firewall.Conntrack.Run(ctx)
|
||||||
|
|
||||||
punchy.Start(ctx, ifce, hostMap, lightHouse)
|
punchy.Start(ctx, ifce, hostMap, lightHouse)
|
||||||
}
|
}
|
||||||
|
|||||||
+18
-1
@@ -477,7 +477,7 @@ func (f *Interface) handleOutsideMessagePacket(hostinfo *HostInfo, messageCounte
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
dropReason := f.firewall.Drop(rxc.fwPacket.Packet, true, hostinfo, f.pki.GetCAPool(), rxc.ctCache.Get())
|
dropReason := f.allowInbound(hostinfo, rxc)
|
||||||
if dropReason != nil {
|
if dropReason != nil {
|
||||||
f.rejectOutside(out, hostinfo.ConnectionState, hostinfo, rxc.nb, rxc.scratch, rxc.q)
|
f.rejectOutside(out, hostinfo.ConnectionState, hostinfo, rxc.nb, rxc.scratch, rxc.q)
|
||||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||||
@@ -492,6 +492,23 @@ func (f *Interface) handleOutsideMessagePacket(hostinfo *HostInfo, messageCounte
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// allowInbound runs the inbound firewall check on rxc.fwPacket. It skips the check when the packet belongs to
|
||||||
|
// the same flow from the same host as the last one allowed in this batch.
|
||||||
|
func (f *Interface) allowInbound(hostinfo *HostInfo, rxc *rxContext) error {
|
||||||
|
fp := rxc.fwPacket.Packet
|
||||||
|
if hostinfo == rxc.lastAllowedHost && fp == rxc.lastAllowed {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := f.firewall.Drop(fp, true, hostinfo, f.pki.GetCAPool()); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
rxc.lastAllowed = fp
|
||||||
|
rxc.lastAllowedHost = hostinfo
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func (f *Interface) maybeSendRecvError(endpoint netip.AddrPort, index uint32) {
|
func (f *Interface) maybeSendRecvError(endpoint netip.AddrPort, index uint32) {
|
||||||
if f.sendRecvErrorConfig.ShouldRecvError(endpoint) {
|
if f.sendRecvErrorConfig.ShouldRecvError(endpoint) {
|
||||||
f.sendRecvError(endpoint, index)
|
f.sendRecvError(endpoint, index)
|
||||||
|
|||||||
@@ -6,12 +6,16 @@ import (
|
|||||||
"net"
|
"net"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/gaissmai/bart"
|
||||||
"github.com/google/gopacket"
|
"github.com/google/gopacket"
|
||||||
"github.com/google/gopacket/layers"
|
"github.com/google/gopacket/layers"
|
||||||
|
"github.com/slackhq/nebula/cert"
|
||||||
"github.com/slackhq/nebula/iputil"
|
"github.com/slackhq/nebula/iputil"
|
||||||
|
|
||||||
"github.com/slackhq/nebula/firewall"
|
"github.com/slackhq/nebula/firewall"
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
"golang.org/x/net/ipv4"
|
"golang.org/x/net/ipv4"
|
||||||
@@ -841,3 +845,49 @@ func Test_newPacket_parsedFields(t *testing.T) {
|
|||||||
assert.True(t, p.Fragment)
|
assert.True(t, p.Fragment)
|
||||||
assert.True(t, p.FragAny)
|
assert.True(t, p.FragAny)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestInterface_allowInbound(t *testing.T) {
|
||||||
|
l := test.NewLoggerWithOutput(&bytes.Buffer{})
|
||||||
|
myNetworks := new(bart.Lite)
|
||||||
|
myNetworks.Insert(netip.MustParsePrefix("192.0.2.1/24"))
|
||||||
|
me := &dummyCert{name: "me", networks: []netip.Prefix{netip.MustParsePrefix("192.0.2.1/24")}}
|
||||||
|
peer := &cert.CachedCertificate{Certificate: &dummyCert{name: "peer", networks: []netip.Prefix{netip.MustParsePrefix("192.0.2.2/24")}}}
|
||||||
|
h := &HostInfo{ConnectionState: &ConnectionState{peerCert: peer}, vpnAddrs: []netip.Addr{netip.MustParseAddr("192.0.2.2")}}
|
||||||
|
h.buildNetworks(myNetworks, peer.Certificate)
|
||||||
|
|
||||||
|
allowAll := NewFirewall(l, time.Minute, time.Minute, time.Minute, me)
|
||||||
|
require.NoError(t, allowAll.AddRule(true, firewall.ProtoAny, 0, 0, []string{"any"}, "", "", "", "", ""))
|
||||||
|
allowNone := NewFirewall(l, time.Minute, time.Minute, time.Minute, me)
|
||||||
|
|
||||||
|
f := &Interface{firewall: allowAll, pki: &PKI{}, l: l}
|
||||||
|
rxc := &rxContext{fwPacket: &firewall.ParsedPacket{}, hostmapCache: map[uint32]*HostInfo{}}
|
||||||
|
flow := firewall.Packet{
|
||||||
|
LocalAddr: netip.MustParseAddr("192.0.2.1"),
|
||||||
|
RemoteAddr: netip.MustParseAddr("192.0.2.2"),
|
||||||
|
LocalPort: 443,
|
||||||
|
RemotePort: 55000,
|
||||||
|
Protocol: iputil.IPProtocolUDP,
|
||||||
|
}
|
||||||
|
rxc.fwPacket.Packet = flow
|
||||||
|
require.NoError(t, f.allowInbound(h, rxc))
|
||||||
|
|
||||||
|
// With a firewall that allows nothing, the rest of the flow's run in this batch still passes
|
||||||
|
f.firewall = allowNone
|
||||||
|
require.NoError(t, f.allowInbound(h, rxc))
|
||||||
|
|
||||||
|
// A different flow is checked
|
||||||
|
other := flow
|
||||||
|
other.RemotePort++
|
||||||
|
rxc.fwPacket.Packet = other
|
||||||
|
require.ErrorIs(t, f.allowInbound(h, rxc), ErrNoMatchingRule)
|
||||||
|
|
||||||
|
// So is the same flow from a different host
|
||||||
|
rxc.fwPacket.Packet = flow
|
||||||
|
h2 := &HostInfo{ConnectionState: h.ConnectionState, vpnAddrs: h.vpnAddrs}
|
||||||
|
h2.buildNetworks(myNetworks, peer.Certificate)
|
||||||
|
require.ErrorIs(t, f.allowInbound(h2, rxc), ErrNoMatchingRule)
|
||||||
|
|
||||||
|
// And the same flow in the next batch
|
||||||
|
rxc.endBatch()
|
||||||
|
require.ErrorIs(t, f.allowInbound(h, rxc), ErrNoMatchingRule)
|
||||||
|
}
|
||||||
@@ -435,65 +435,3 @@ func testPP(pkt []byte) *firewall.ParsedPacket {
|
|||||||
}
|
}
|
||||||
return pp
|
return pp
|
||||||
}
|
}
|
||||||
|
|
||||||
// fakeTunBatchWriter records each WriteBatch call and each plain Write separately.
|
|
||||||
type fakeTunBatchWriter struct {
|
|
||||||
writes [][]byte
|
|
||||||
batches [][][]byte
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *fakeTunBatchWriter) Write(p []byte) (int, error) {
|
|
||||||
w.writes = append(w.writes, bytes.Clone(p))
|
|
||||||
return len(p), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *fakeTunBatchWriter) WriteBatch(pkts [][]byte) error {
|
|
||||||
var b [][]byte
|
|
||||||
for _, p := range pkts {
|
|
||||||
b = append(b, bytes.Clone(p))
|
|
||||||
}
|
|
||||||
w.batches = append(w.batches, b)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPassthroughUsesWriteBatch pins that a writer implementing tio.BatchWriter gets the whole
|
|
||||||
// passthrough lane in one WriteBatch per Flush, in order, and no plain Writes; an empty Flush
|
|
||||||
// makes no call.
|
|
||||||
func TestPassthroughUsesWriteBatch(t *testing.T) {
|
|
||||||
w := &fakeTunBatchWriter{}
|
|
||||||
m := newTestMultiCoalescer(t, w)
|
|
||||||
k := &keySeq{epoch: 1}
|
|
||||||
|
|
||||||
var want [][]byte
|
|
||||||
for i := range 5 {
|
|
||||||
icmp := make([]byte, 28)
|
|
||||||
icmp[0] = 0x45
|
|
||||||
icmp[3] = 28
|
|
||||||
icmp[9] = 1
|
|
||||||
icmp[20] = byte(i)
|
|
||||||
want = append(want, icmp)
|
|
||||||
if err := m.Commit(icmp, k.next(), testPP(icmp)); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if err := m.Flush(); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if err := m.Flush(); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if len(w.writes) != 0 {
|
|
||||||
t.Fatalf("got %d plain Writes, want 0", len(w.writes))
|
|
||||||
}
|
|
||||||
if len(w.batches) != 1 {
|
|
||||||
t.Fatalf("got %d WriteBatch calls, want 1", len(w.batches))
|
|
||||||
}
|
|
||||||
for i, p := range w.batches[0] {
|
|
||||||
if !bytes.Equal(p, want[i]) {
|
|
||||||
t.Fatalf("packet %d: got % x, want % x", i, p, want[i])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if len(w.batches[0]) != len(want) {
|
|
||||||
t.Fatalf("got %d packets, want %d", len(w.batches[0]), len(want))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -2,23 +2,18 @@ package batch
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"io"
|
"io"
|
||||||
|
|
||||||
"github.com/slackhq/nebula/overlay/tio"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Passthrough is MultiCoalescer's verbatim lane: no coalescing, packets are written at Flush in the
|
// Passthrough is MultiCoalescer's verbatim lane: no batching, packets are written at Flush in the
|
||||||
// order enqueued, in one WriteBatch when out implements tio.BatchWriter.
|
// order enqueued.
|
||||||
type Passthrough struct {
|
type Passthrough struct {
|
||||||
out io.Writer
|
out io.Writer
|
||||||
bw tio.BatchWriter // nil: Flush writes one packet per Write
|
|
||||||
slots [][]byte
|
slots [][]byte
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewPassthrough(w io.Writer) *Passthrough {
|
func NewPassthrough(w io.Writer) *Passthrough {
|
||||||
bw, _ := w.(tio.BatchWriter)
|
|
||||||
return &Passthrough{
|
return &Passthrough{
|
||||||
out: w,
|
out: w,
|
||||||
bw: bw,
|
|
||||||
slots: make([][]byte, 0, 128),
|
slots: make([][]byte, 0, 128),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -31,18 +26,12 @@ func (p *Passthrough) enqueue(pkt []byte) error {
|
|||||||
|
|
||||||
func (p *Passthrough) Flush() error {
|
func (p *Passthrough) Flush() error {
|
||||||
var firstErr error
|
var firstErr error
|
||||||
if p.bw != nil {
|
|
||||||
if len(p.slots) > 0 {
|
|
||||||
firstErr = p.bw.WriteBatch(p.slots)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
for _, s := range p.slots {
|
for _, s := range p.slots {
|
||||||
_, err := p.out.Write(s)
|
_, err := p.out.Write(s)
|
||||||
if err != nil && firstErr == nil {
|
if err != nil && firstErr == nil {
|
||||||
firstErr = err
|
firstErr = err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
clear(p.slots)
|
clear(p.slots)
|
||||||
p.slots = p.slots[:0]
|
p.slots = p.slots[:0]
|
||||||
return firstErr
|
return firstErr
|
||||||
|
|||||||
@@ -145,14 +145,3 @@ func SupportsGSO(w io.Writer, want GSOProto) (GSOWriter, bool) {
|
|||||||
return gw, false
|
return gw, false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// BatchWriter is implemented by Queues that can emit several already-segmented packets in one call.
|
|
||||||
// Backends without a batched write do not implement it and callers loop over Write.
|
|
||||||
//
|
|
||||||
// pkts are borrowed: WriteBatch must not retain them past its return.
|
|
||||||
// A returned error doesn't say which packets were delivered, so callers must not retry the batch.
|
|
||||||
// Safe for concurrent use, like Write.
|
|
||||||
type BatchWriter interface {
|
|
||||||
io.Writer
|
|
||||||
WriteBatch(pkts [][]byte) error
|
|
||||||
}
|
|
||||||
@@ -1,328 +0,0 @@
|
|||||||
//go:build darwin && !ios
|
|
||||||
|
|
||||||
package tio
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"log/slog"
|
|
||||||
"os"
|
|
||||||
"sync"
|
|
||||||
"sync/atomic"
|
|
||||||
"syscall"
|
|
||||||
_ "unsafe" // for go:linkname
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/internal/msgx"
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
// tunMaxPacket is the largest packet utun can return at any device MTU.
|
|
||||||
const tunMaxPacket = 65535
|
|
||||||
|
|
||||||
// tunReadBatch is the most packets one Utun.Read returns.
|
|
||||||
const tunReadBatch = 64
|
|
||||||
|
|
||||||
// tunReadArena is Utun's receive buffer. Draining stops once less than tunMaxPacket of it is left,
|
|
||||||
// so every readv has room for the largest packet utun can return.
|
|
||||||
const tunReadArena = 4 * tunMaxPacket
|
|
||||||
|
|
||||||
// tunWriteBatch is how many packets one sendmsg_x call may carry.
|
|
||||||
const tunWriteBatch = 64
|
|
||||||
|
|
||||||
// Utun is a darwin utun control socket as a Queue. Every packet crosses the socket behind a 4 byte
|
|
||||||
// address family prefix, which Read strips and the writes add.
|
|
||||||
//
|
|
||||||
// The fd lives in the runtime poller, so Close wakes a Read parked on it; darwin needs no QueueSet
|
|
||||||
// shutdown fd.
|
|
||||||
type Utun struct {
|
|
||||||
f *os.File
|
|
||||||
l *slog.Logger
|
|
||||||
|
|
||||||
// readBuf and readRet are Read's scratch, owned by the single reader.
|
|
||||||
readBuf []byte
|
|
||||||
readRet [tunReadBatch]Packet
|
|
||||||
|
|
||||||
// noSendmsgX is set when libSystem lacks sendmsg_x or the kernel refuses it; WriteBatch then writes one packet at a time.
|
|
||||||
noSendmsgX atomic.Bool
|
|
||||||
batchMu sync.Mutex
|
|
||||||
batch tunBatch
|
|
||||||
}
|
|
||||||
|
|
||||||
// tunBatch is WriteBatch's scratch, guarded by Utun.batchMu. The kernel reads every entry in place.
|
|
||||||
type tunBatch struct {
|
|
||||||
heads [tunWriteBatch][4]byte
|
|
||||||
iovs [tunWriteBatch][2]unix.Iovec
|
|
||||||
hdrs [tunWriteBatch]msgx.Hdr
|
|
||||||
pkts [tunWriteBatch][]byte
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewUtun wraps a utun control socket fd and makes it non-blocking.
|
|
||||||
// On failure it does NOT close fd: the caller owns fd until NewUtun succeeds, after which Close closes it.
|
|
||||||
func NewUtun(fd int, l *slog.Logger) (*Utun, error) {
|
|
||||||
// Before os.NewFile, which only hands a non-blocking fd to the runtime poller.
|
|
||||||
if err := unix.SetNonblock(fd, true); err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to set the tun fd to non-blocking mode: %w", err)
|
|
||||||
}
|
|
||||||
u := &Utun{
|
|
||||||
f: os.NewFile(uintptr(fd), "utun"),
|
|
||||||
l: l,
|
|
||||||
readBuf: make([]byte, tunReadArena),
|
|
||||||
}
|
|
||||||
u.noSendmsgX.Store(!msgx.Available())
|
|
||||||
return u, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// tunWritev and tunReadv are linkname'd to x/sys/unix's libc-routed writev/readv stubs so the
|
|
||||||
// calls go through libSystem's pinned trampoline. A raw syscall.Syscall(SYS_WRITEV/SYS_READV, ...)
|
|
||||||
// on darwin/arm64 emits an SVC #0x80 trap (see $GOROOT/src/syscall/asm_darwin_arm64.s), the path
|
|
||||||
// Apple keeps warning they will eventually disallow. We pull the low-level stubs instead of calling
|
|
||||||
// unix.Writev/unix.Readv because those take [][]byte and rebuild the []Iovec every call, which
|
|
||||||
// heap-allocates the header; linkname'ing the stubs lets us hand them our own stack-allocated
|
|
||||||
// iovecs. See golang/go#78049.
|
|
||||||
|
|
||||||
//go:linkname tunWritev golang.org/x/sys/unix.writev
|
|
||||||
//go:noescape
|
|
||||||
func tunWritev(fd int, iovecs []unix.Iovec) (n int, err error)
|
|
||||||
|
|
||||||
//go:linkname tunReadv golang.org/x/sys/unix.readv
|
|
||||||
//go:noescape
|
|
||||||
func tunReadv(fd int, iovecs []unix.Iovec) (n int, err error)
|
|
||||||
|
|
||||||
// Read waits for the utun to become readable, then reads packets until it would block, up to
|
|
||||||
// tunReadBatch, so the caller encrypts and sends them as one batch rather than one per wakeup. Each
|
|
||||||
// packet is read with its AF prefix scattered away, so the payload lands directly in readBuf.
|
|
||||||
// An error after at least one packet is dropped in favor of returning those packets; a persistent
|
|
||||||
// one recurs on the next Read.
|
|
||||||
func (u *Utun) Read() ([]Packet, error) {
|
|
||||||
rc, err := u.f.SyscallConn()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var head [4]byte
|
|
||||||
n, off := 0, 0
|
|
||||||
var callErr error
|
|
||||||
err = rc.Read(func(fd uintptr) bool {
|
|
||||||
for n < tunReadBatch && len(u.readBuf)-off >= tunMaxPacket {
|
|
||||||
iovecs := [2]unix.Iovec{
|
|
||||||
{Base: &head[0], Len: 4},
|
|
||||||
{Base: &u.readBuf[off], Len: uint64(len(u.readBuf) - off)},
|
|
||||||
}
|
|
||||||
l, e := tunReadv(int(fd), iovecs[:])
|
|
||||||
if e != nil {
|
|
||||||
if errno, ok := e.(syscall.Errno); ok && errno.Temporary() {
|
|
||||||
// Park on the poller only while there is nothing to hand back.
|
|
||||||
return n > 0
|
|
||||||
}
|
|
||||||
callErr = e
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
if l < 4 {
|
|
||||||
// A datagram too short to carry the AF prefix, or end of file; stop rather than spin on it.
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
end := off + l - 4
|
|
||||||
u.readRet[n] = Packet{Bytes: u.readBuf[off:end:end]}
|
|
||||||
n++
|
|
||||||
off = end
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
})
|
|
||||||
if n > 0 {
|
|
||||||
return u.readRet[:n], nil
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return nil, callErr
|
|
||||||
}
|
|
||||||
|
|
||||||
// Write pushes one IP packet onto the utun device. Safe for concurrent use:
|
|
||||||
// the AF prefix and iovecs are per-call stack state, and the fd write itself
|
|
||||||
// serializes on the runtime's fd mutex (see the Queue contract in tio.go).
|
|
||||||
func (u *Utun) Write(from []byte) (int, error) {
|
|
||||||
if len(from) == 0 {
|
|
||||||
return 0, syscall.EIO
|
|
||||||
}
|
|
||||||
|
|
||||||
var head [4]byte
|
|
||||||
af, err := tunAF(from)
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
head[3] = af
|
|
||||||
|
|
||||||
// Grab rc as a local so the compiler can devirtualize the call and keep the closure on the stack.
|
|
||||||
rc, err := u.f.SyscallConn()
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var n int
|
|
||||||
var callErr error
|
|
||||||
err = rc.Write(func(fd uintptr) bool {
|
|
||||||
iovecs := []unix.Iovec{
|
|
||||||
{Base: &head[0], Len: 4},
|
|
||||||
{Base: &from[0], Len: uint64(len(from))},
|
|
||||||
}
|
|
||||||
n, callErr = tunWritev(int(fd), iovecs)
|
|
||||||
// Type-assert to syscall.Errno so the EAGAIN/EWOULDBLOCK/EINTR check doesn't box the errno
|
|
||||||
// constants into error interfaces on every call.
|
|
||||||
if errno, ok := callErr.(syscall.Errno); ok && errno.Temporary() {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
if callErr != nil {
|
|
||||||
return 0, callErr
|
|
||||||
}
|
|
||||||
|
|
||||||
return n - 4, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// tunAF returns the utun address-family prefix byte for an IP packet.
|
|
||||||
func tunAF(pkt []byte) (byte, error) {
|
|
||||||
switch pkt[0] >> 4 {
|
|
||||||
case 4:
|
|
||||||
return syscall.AF_INET, nil
|
|
||||||
case 6:
|
|
||||||
return syscall.AF_INET6, nil
|
|
||||||
default:
|
|
||||||
return 0, fmt.Errorf("unable to determine IP version from packet")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WriteBatch writes pkts to the utun device with sendmsg_x, xnu's private batched sendmsg, up to
|
|
||||||
// tunWriteBatch packets per syscall. The kernel still hands each packet to utun on its own, so this
|
|
||||||
// saves syscalls, not per-packet kernel work. Safe for concurrent use.
|
|
||||||
//
|
|
||||||
// An empty packet or one with no IP version is skipped and reported, as Write would. Any other
|
|
||||||
// error from sendmsg_x means the kernel took an unknown prefix of that call and dropped the rest, so
|
|
||||||
// it is reported rather than retried, which could deliver packets twice.
|
|
||||||
//
|
|
||||||
// Under mbuf exhaustion, sendmsg_x silently drops packets that writev would have delivered: the
|
|
||||||
// kernel counts each packet as sent once it is copied in, and when a later allocation fails it
|
|
||||||
// frees that prefix unsent and returns its length as a short count, which is indistinguishable
|
|
||||||
// from a real one.
|
|
||||||
func (u *Utun) WriteBatch(pkts [][]byte) error {
|
|
||||||
if u.noSendmsgX.Load() {
|
|
||||||
return u.writeEach(pkts)
|
|
||||||
}
|
|
||||||
|
|
||||||
u.batchMu.Lock()
|
|
||||||
defer u.batchMu.Unlock()
|
|
||||||
b := &u.batch
|
|
||||||
var firstErr error
|
|
||||||
for len(pkts) > 0 {
|
|
||||||
n := 0
|
|
||||||
for len(pkts) > 0 && n < tunWriteBatch {
|
|
||||||
p := pkts[0]
|
|
||||||
pkts = pkts[1:]
|
|
||||||
var af byte
|
|
||||||
err := error(syscall.EIO)
|
|
||||||
if len(p) > 0 {
|
|
||||||
af, err = tunAF(p)
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
if firstErr == nil {
|
|
||||||
firstErr = err
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
b.heads[n] = [4]byte{3: af}
|
|
||||||
b.iovs[n] = [2]unix.Iovec{
|
|
||||||
{Base: &b.heads[n][0], Len: 4},
|
|
||||||
{Base: &p[0], Len: uint64(len(p))},
|
|
||||||
}
|
|
||||||
b.hdrs[n] = msgx.Hdr{Iov: &b.iovs[n][0], Iovlen: 2}
|
|
||||||
b.pkts[n] = p
|
|
||||||
n++
|
|
||||||
}
|
|
||||||
if n == 0 {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
for off := 0; off < n; {
|
|
||||||
sent, err := u.sendmsgX(off, n)
|
|
||||||
switch {
|
|
||||||
case err == nil && sent > 0:
|
|
||||||
// The kernel stops early without an error on a packet larger than the socket's send
|
|
||||||
// buffer, or when sending a later packet fails with ENOBUFS; resend the remainder.
|
|
||||||
off += sent
|
|
||||||
case err == nil:
|
|
||||||
if werr := u.writeEach(b.pkts[off:n]); werr != nil && firstErr == nil {
|
|
||||||
firstErr = werr
|
|
||||||
}
|
|
||||||
off = n
|
|
||||||
case err == unix.EMSGSIZE:
|
|
||||||
// Only the first packet being larger than the socket's send buffer fails the whole call,
|
|
||||||
// before the kernel takes any; Write reports that one and the rest go out in the next call.
|
|
||||||
if werr := u.writeEach(b.pkts[off : off+1]); werr != nil && firstErr == nil {
|
|
||||||
firstErr = werr
|
|
||||||
}
|
|
||||||
off++
|
|
||||||
case err == unix.ENOSYS || err == unix.EPERM || err == unix.EOPNOTSUPP:
|
|
||||||
// sendmsg_x is private API: fall back to writev if a kernel or sandbox refuses it.
|
|
||||||
if u.noSendmsgX.CompareAndSwap(false, true) {
|
|
||||||
u.l.Warn("sendmsg_x unavailable on the tun device, writing one packet per syscall", "error", err)
|
|
||||||
}
|
|
||||||
if werr := u.writeEach(b.pkts[off:n]); werr != nil && firstErr == nil {
|
|
||||||
firstErr = werr
|
|
||||||
}
|
|
||||||
clear(b.iovs[:n])
|
|
||||||
clear(b.pkts[:n])
|
|
||||||
if werr := u.writeEach(pkts); werr != nil && firstErr == nil {
|
|
||||||
firstErr = werr
|
|
||||||
}
|
|
||||||
return firstErr
|
|
||||||
default:
|
|
||||||
if firstErr == nil {
|
|
||||||
firstErr = err
|
|
||||||
}
|
|
||||||
off = n
|
|
||||||
}
|
|
||||||
}
|
|
||||||
clear(b.iovs[:n])
|
|
||||||
clear(b.pkts[:n])
|
|
||||||
}
|
|
||||||
return firstErr
|
|
||||||
}
|
|
||||||
|
|
||||||
// sendmsgX hands entries off through n-1 of u.batch to sendmsg_x and returns how many the kernel took.
|
|
||||||
func (u *Utun) sendmsgX(off, n int) (int, error) {
|
|
||||||
rc, err := u.f.SyscallConn()
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
var sent int
|
|
||||||
var errno syscall.Errno
|
|
||||||
err = rc.Write(func(fd uintptr) bool {
|
|
||||||
sent, errno = msgx.Send(fd, u.batch.hdrs[off:n], 0)
|
|
||||||
// sendmsg_x reports EAGAIN only when it took nothing; a partial batch returns its count.
|
|
||||||
return !errno.Temporary()
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
if errno != 0 {
|
|
||||||
return 0, errno
|
|
||||||
}
|
|
||||||
return sent, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// writeEach writes pkts one at a time with Write.
|
|
||||||
func (u *Utun) writeEach(pkts [][]byte) error {
|
|
||||||
var firstErr error
|
|
||||||
for _, p := range pkts {
|
|
||||||
if _, err := u.Write(p); err != nil && firstErr == nil {
|
|
||||||
firstErr = err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return firstErr
|
|
||||||
}
|
|
||||||
|
|
||||||
func (u *Utun) Close() error {
|
|
||||||
return u.f.Close()
|
|
||||||
}
|
|
||||||
@@ -1,198 +0,0 @@
|
|||||||
//go:build darwin && !ios
|
|
||||||
|
|
||||||
package tio
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"log/slog"
|
|
||||||
"syscall"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
// newSocketpairUtun returns a Utun over one end of a connected AF_UNIX datagram socketpair, which
|
|
||||||
// takes sendmsg_x the way a utun control socket does, and the other end's fd for the test to use.
|
|
||||||
// sndbuf is the Utun's send buffer, which caps the largest datagram it accepts.
|
|
||||||
func newSocketpairUtun(t *testing.T, sndbuf int) (*Utun, int) {
|
|
||||||
t.Helper()
|
|
||||||
fds, err := unix.Socketpair(unix.AF_UNIX, unix.SOCK_DGRAM, 0)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, unix.SetsockoptInt(fds[0], unix.SOL_SOCKET, unix.SO_SNDBUF, sndbuf))
|
|
||||||
// An AF_UNIX datagram send is bounded by the receiver's buffer, so size both ends' for the tests.
|
|
||||||
require.NoError(t, unix.SetsockoptInt(fds[0], unix.SOL_SOCKET, unix.SO_RCVBUF, 1<<20))
|
|
||||||
require.NoError(t, unix.SetsockoptInt(fds[1], unix.SOL_SOCKET, unix.SO_RCVBUF, 1<<20))
|
|
||||||
// A dropped datagram fails the read-back instead of hanging it.
|
|
||||||
require.NoError(t, unix.SetsockoptTimeval(fds[1], unix.SOL_SOCKET, unix.SO_RCVTIMEO, &unix.Timeval{Sec: 2}))
|
|
||||||
u, err := NewUtun(fds[0], slog.New(slog.DiscardHandler))
|
|
||||||
if err != nil {
|
|
||||||
_ = unix.Close(fds[0])
|
|
||||||
_ = unix.Close(fds[1])
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
t.Cleanup(func() {
|
|
||||||
_ = u.Close()
|
|
||||||
_ = unix.Close(fds[1])
|
|
||||||
})
|
|
||||||
return u, fds[1]
|
|
||||||
}
|
|
||||||
|
|
||||||
// testTunPkt returns packet i of size bytes, alternating IPv4 and IPv6, and the datagram the utun
|
|
||||||
// device should receive for it.
|
|
||||||
func testTunPkt(i, size int) (pkt, wire []byte) {
|
|
||||||
pkt = make([]byte, size)
|
|
||||||
pkt[0] = 0x45
|
|
||||||
af := byte(syscall.AF_INET)
|
|
||||||
if i%2 == 1 {
|
|
||||||
pkt[0] = 0x60
|
|
||||||
af = syscall.AF_INET6
|
|
||||||
}
|
|
||||||
pkt[1] = byte(i)
|
|
||||||
pkt[2] = byte(i >> 8)
|
|
||||||
return pkt, append([]byte{0, 0, 0, af}, pkt...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// readTunBack asserts r receives exactly want, in order.
|
|
||||||
func readTunBack(t *testing.T, r int, want [][]byte) {
|
|
||||||
t.Helper()
|
|
||||||
buf := make([]byte, 4096)
|
|
||||||
for i, w := range want {
|
|
||||||
n, _, err := unix.Recvfrom(r, buf, 0)
|
|
||||||
require.NoError(t, err, "datagram %d", i)
|
|
||||||
if !bytes.Equal(w, buf[:n]) {
|
|
||||||
t.Fatalf("datagram %d: got % x, want % x", i, buf[:n], w)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
_, _, err := unix.Recvfrom(r, buf, unix.MSG_DONTWAIT)
|
|
||||||
assert.ErrorIs(t, err, unix.EAGAIN, "extra datagrams delivered")
|
|
||||||
}
|
|
||||||
|
|
||||||
// forEachTunWritePath runs fn once over sendmsg_x and once over the per-packet writev fallback.
|
|
||||||
func forEachTunWritePath(t *testing.T, fn func(t *testing.T, fallback bool)) {
|
|
||||||
for _, fallback := range []bool{false, true} {
|
|
||||||
name := "sendmsg_x"
|
|
||||||
if fallback {
|
|
||||||
name = "writev"
|
|
||||||
}
|
|
||||||
t.Run(name, func(t *testing.T) { fn(t, fallback) })
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestUtunWriteBatch pins that WriteBatch delivers every packet whole, in order and behind the right
|
|
||||||
// utun AF prefix, across several sendmsg_x calls, and returns nil.
|
|
||||||
func TestUtunWriteBatch(t *testing.T) {
|
|
||||||
forEachTunWritePath(t, func(t *testing.T, fallback bool) {
|
|
||||||
u, r := newSocketpairUtun(t, 1<<20)
|
|
||||||
u.noSendmsgX.Store(fallback)
|
|
||||||
|
|
||||||
var pkts, want [][]byte
|
|
||||||
for i := range 3*tunWriteBatch + 5 {
|
|
||||||
p, w := testTunPkt(i, 60+i)
|
|
||||||
pkts = append(pkts, p)
|
|
||||||
want = append(want, w)
|
|
||||||
}
|
|
||||||
require.NoError(t, u.WriteBatch(pkts))
|
|
||||||
assert.Equal(t, fallback, u.noSendmsgX.Load())
|
|
||||||
readTunBack(t, r, want)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestUtunWriteBatchSkipsInvalid pins that an empty packet or one with no IP version is skipped
|
|
||||||
// without shifting the packets after it, and that the first such error is the one reported.
|
|
||||||
func TestUtunWriteBatchSkipsInvalid(t *testing.T) {
|
|
||||||
forEachTunWritePath(t, func(t *testing.T, fallback bool) {
|
|
||||||
u, r := newSocketpairUtun(t, 1<<20)
|
|
||||||
u.noSendmsgX.Store(fallback)
|
|
||||||
|
|
||||||
var pkts, want [][]byte
|
|
||||||
for i := range 20 {
|
|
||||||
p, w := testTunPkt(i, 60)
|
|
||||||
pkts = append(pkts, p)
|
|
||||||
want = append(want, w)
|
|
||||||
}
|
|
||||||
pkts = append(pkts[:10], append([][]byte{{0x10, 1, 2}, {}}, pkts[10:]...)...)
|
|
||||||
|
|
||||||
err := u.WriteBatch(pkts)
|
|
||||||
assert.ErrorContains(t, err, "IP version")
|
|
||||||
readTunBack(t, r, want)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestUtunWriteBatchOversize pins that a packet larger than the socket's send buffer drops only
|
|
||||||
// itself and is reported, whether sendmsg_x reaches it mid-call (a short count) or first (EMSGSIZE
|
|
||||||
// for the whole call). The send buffer is 1024 bytes and the oversize packet 2000.
|
|
||||||
func TestUtunWriteBatchOversize(t *testing.T) {
|
|
||||||
for _, tc := range []struct {
|
|
||||||
name string
|
|
||||||
at int
|
|
||||||
}{
|
|
||||||
{"mid-call", tunWriteBatch + 6},
|
|
||||||
{"first-in-call", tunWriteBatch},
|
|
||||||
} {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
forEachTunWritePath(t, func(t *testing.T, fallback bool) {
|
|
||||||
u, r := newSocketpairUtun(t, 1024)
|
|
||||||
u.noSendmsgX.Store(fallback)
|
|
||||||
|
|
||||||
var pkts, want [][]byte
|
|
||||||
for i := range 2*tunWriteBatch + 10 {
|
|
||||||
size := 100
|
|
||||||
if i == tc.at {
|
|
||||||
size = 2000
|
|
||||||
}
|
|
||||||
p, w := testTunPkt(i, size)
|
|
||||||
pkts = append(pkts, p)
|
|
||||||
if i != tc.at {
|
|
||||||
want = append(want, w)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
err := u.WriteBatch(pkts)
|
|
||||||
assert.ErrorIs(t, err, unix.EMSGSIZE)
|
|
||||||
assert.Equal(t, fallback, u.noSendmsgX.Load())
|
|
||||||
readTunBack(t, r, want)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestUtunReadDrains pins that Read hands back every queued packet, AF prefix stripped and in
|
|
||||||
// order, capped at tunReadBatch per call, and doesn't wait for more once the queue is empty.
|
|
||||||
func TestUtunReadDrains(t *testing.T) {
|
|
||||||
u, w := newSocketpairUtun(t, 1<<20)
|
|
||||||
total := tunReadBatch + 3
|
|
||||||
var want [][]byte
|
|
||||||
for i := range total {
|
|
||||||
pkt, wire := testTunPkt(i, 60+i)
|
|
||||||
_, err := unix.Write(w, wire)
|
|
||||||
require.NoError(t, err)
|
|
||||||
want = append(want, pkt)
|
|
||||||
}
|
|
||||||
|
|
||||||
var got [][]byte
|
|
||||||
for _, size := range []int{tunReadBatch, 3} {
|
|
||||||
pkts, err := u.Read()
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Len(t, pkts, size)
|
|
||||||
for _, p := range pkts {
|
|
||||||
got = append(got, p.Clone().Bytes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
assert.Equal(t, want, got)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestUtunReadClipsPackets pins that each returned packet's capacity ends at its own bytes, so
|
|
||||||
// appending to one can't overwrite the next.
|
|
||||||
func TestUtunReadClipsPackets(t *testing.T) {
|
|
||||||
u, w := newSocketpairUtun(t, 1<<20)
|
|
||||||
for i := range 2 {
|
|
||||||
_, wire := testTunPkt(i, 100)
|
|
||||||
_, err := unix.Write(w, wire)
|
|
||||||
require.NoError(t, err)
|
|
||||||
}
|
|
||||||
pkts, err := u.Read()
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Len(t, pkts, 2)
|
|
||||||
assert.Equal(t, len(pkts[0].Bytes), cap(pkts[0].Bytes))
|
|
||||||
}
|
|
||||||
+115
-12
@@ -7,7 +7,9 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
|
"os"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
|
"syscall"
|
||||||
"unsafe"
|
"unsafe"
|
||||||
|
|
||||||
"github.com/gaissmai/bart"
|
"github.com/gaissmai/bart"
|
||||||
@@ -20,7 +22,7 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
type tun struct {
|
type tun struct {
|
||||||
queue *tio.Utun
|
f *os.File
|
||||||
Device string
|
Device string
|
||||||
vpnNetworks []netip.Prefix
|
vpnNetworks []netip.Prefix
|
||||||
DefaultMTU int
|
DefaultMTU int
|
||||||
@@ -115,13 +117,13 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
|||||||
return nil, fmt.Errorf("failed to retrieve tun name: %w", err)
|
return nil, fmt.Errorf("failed to retrieve tun name: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
queue, err := tio.NewUtun(fd, l)
|
err = unix.SetNonblock(fd, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, fmt.Errorf("SetNonblock: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
t := &tun{
|
t := &tun{
|
||||||
queue: queue,
|
f: os.NewFile(uintptr(fd), ""),
|
||||||
Device: name,
|
Device: name,
|
||||||
vpnNetworks: vpnNetworks,
|
vpnNetworks: vpnNetworks,
|
||||||
DefaultMTU: c.GetInt("tun.mtu", DefaultMTU),
|
DefaultMTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||||
@@ -154,15 +156,15 @@ func (t *tun) deviceBytes() (o [16]byte) {
|
|||||||
// network extension is handed its device. Everything about moving packets is shared with newTun,
|
// network extension is handed its device. Everything about moving packets is shared with newTun,
|
||||||
// only the setup differs: the host owns addressing and routing here.
|
// only the setup differs: the host owns addressing and routing here.
|
||||||
func newTunFromFd(c *config.C, l *slog.Logger, deviceFd int, vpnNetworks []netip.Prefix) (*tun, error) {
|
func newTunFromFd(c *config.C, l *slog.Logger, deviceFd int, vpnNetworks []netip.Prefix) (*tun, error) {
|
||||||
queue, err := tio.NewUtun(deviceFd, l)
|
if err := unix.SetNonblock(deviceFd, true); err != nil {
|
||||||
if err != nil {
|
|
||||||
// We own the fd from the moment it is handed to us
|
// We own the fd from the moment it is handed to us
|
||||||
_ = unix.Close(deviceFd)
|
_ = unix.Close(deviceFd)
|
||||||
return nil, err
|
return nil, fmt.Errorf("failed to set the tun fd to non-blocking mode: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
file := os.NewFile(uintptr(deviceFd), "/dev/tun")
|
||||||
t := &tun{
|
t := &tun{
|
||||||
queue: queue,
|
f: file,
|
||||||
Device: utunNameFromFd(deviceFd),
|
Device: utunNameFromFd(deviceFd),
|
||||||
vpnNetworks: vpnNetworks,
|
vpnNetworks: vpnNetworks,
|
||||||
DefaultMTU: c.GetInt("tun.mtu", DefaultMTU),
|
DefaultMTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||||
@@ -171,7 +173,7 @@ func newTunFromFd(c *config.C, l *slog.Logger, deviceFd int, vpnNetworks []netip
|
|||||||
}
|
}
|
||||||
|
|
||||||
if err := t.reload(c, true); err != nil {
|
if err := t.reload(c, true); err != nil {
|
||||||
_ = queue.Close()
|
_ = file.Close()
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -195,8 +197,8 @@ func utunNameFromFd(fd int) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) Close() error {
|
func (t *tun) Close() error {
|
||||||
if t.queue != nil {
|
if t.f != nil {
|
||||||
return t.queue.Close()
|
return t.f.Close()
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -554,6 +556,107 @@ func delRoute(prefix netip.Prefix, gateway netroute.Addr) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// tunWritev and tunReadv are linkname'd to x/sys/unix's libc-routed writev/readv stubs so the
|
||||||
|
// calls go through libSystem's pinned trampoline. A raw syscall.Syscall(SYS_WRITEV/SYS_READV, ...)
|
||||||
|
// on darwin/arm64 emits an SVC #0x80 trap (see $GOROOT/src/syscall/asm_darwin_arm64.s), the path
|
||||||
|
// Apple keeps warning they will eventually disallow. We pull the low-level stubs instead of calling
|
||||||
|
// unix.Writev/unix.Readv because those take [][]byte and rebuild the []Iovec every call, which
|
||||||
|
// heap-allocates the header; linkname'ing the stubs lets us hand them our own stack-allocated
|
||||||
|
// iovecs. See golang/go#78049.
|
||||||
|
|
||||||
|
//go:linkname tunWritev golang.org/x/sys/unix.writev
|
||||||
|
//go:noescape
|
||||||
|
func tunWritev(fd int, iovecs []unix.Iovec) (n int, err error)
|
||||||
|
|
||||||
|
//go:linkname tunReadv golang.org/x/sys/unix.readv
|
||||||
|
//go:noescape
|
||||||
|
func tunReadv(fd int, iovecs []unix.Iovec) (n int, err error)
|
||||||
|
|
||||||
|
// Read pulls one IP packet off the utun device, scattering the 4 byte protocol header away from
|
||||||
|
// the packet so the payload lands directly in to.
|
||||||
|
func (t *tun) Read(to []byte) (int, error) {
|
||||||
|
var head [4]byte
|
||||||
|
|
||||||
|
rc, err := t.f.SyscallConn()
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var n int
|
||||||
|
var callErr error
|
||||||
|
err = rc.Read(func(fd uintptr) bool {
|
||||||
|
iovecs := []unix.Iovec{
|
||||||
|
{Base: &head[0], Len: 4},
|
||||||
|
{Base: &to[0], Len: uint64(len(to))},
|
||||||
|
}
|
||||||
|
n, callErr = tunReadv(int(fd), iovecs)
|
||||||
|
if errno, ok := callErr.(syscall.Errno); ok && errno.Temporary() {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
if callErr != nil {
|
||||||
|
return 0, callErr
|
||||||
|
}
|
||||||
|
if n < 4 {
|
||||||
|
return 0, nil
|
||||||
|
}
|
||||||
|
return n - 4, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write pushes one IP packet onto the utun device. Safe for concurrent use:
|
||||||
|
// the AF prefix and iovecs are per-call stack state, and the fd write itself
|
||||||
|
// serializes on the runtime's fd mutex (see the Queue contract in tio.go).
|
||||||
|
func (t *tun) Write(from []byte) (int, error) {
|
||||||
|
if len(from) == 0 {
|
||||||
|
return 0, syscall.EIO
|
||||||
|
}
|
||||||
|
|
||||||
|
ipVer := from[0] >> 4
|
||||||
|
var head [4]byte
|
||||||
|
switch ipVer {
|
||||||
|
case 4:
|
||||||
|
head[3] = syscall.AF_INET
|
||||||
|
case 6:
|
||||||
|
head[3] = syscall.AF_INET6
|
||||||
|
default:
|
||||||
|
return 0, fmt.Errorf("unable to determine IP version from packet")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Grab rc as a local so the compiler can devirtualize the call and keep the closure on the stack.
|
||||||
|
rc, err := t.f.SyscallConn()
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var n int
|
||||||
|
var callErr error
|
||||||
|
err = rc.Write(func(fd uintptr) bool {
|
||||||
|
iovecs := []unix.Iovec{
|
||||||
|
{Base: &head[0], Len: 4},
|
||||||
|
{Base: &from[0], Len: uint64(len(from))},
|
||||||
|
}
|
||||||
|
n, callErr = tunWritev(int(fd), iovecs)
|
||||||
|
// Type-assert to syscall.Errno so the EAGAIN/EWOULDBLOCK/EINTR check doesn't box the errno
|
||||||
|
// constants into error interfaces on every call.
|
||||||
|
if errno, ok := callErr.(syscall.Errno); ok && errno.Temporary() {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
if callErr != nil {
|
||||||
|
return 0, callErr
|
||||||
|
}
|
||||||
|
|
||||||
|
return n - 4, nil
|
||||||
|
}
|
||||||
|
|
||||||
func (t *tun) Networks() []netip.Prefix {
|
func (t *tun) Networks() []netip.Prefix {
|
||||||
return t.vpnNetworks
|
return t.vpnNetworks
|
||||||
}
|
}
|
||||||
@@ -563,5 +666,5 @@ func (t *tun) Name() string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) Queues(int) ([]tio.Queue, error) {
|
func (t *tun) Queues(int) ([]tio.Queue, error) {
|
||||||
return []tio.Queue{t.queue}, nil
|
return []tio.Queue{tio.NewSingleQueue(t, defaultBatchBufSize)}, nil
|
||||||
}
|
}
|
||||||
+6
-263
@@ -10,12 +10,10 @@ import (
|
|||||||
"log/slog"
|
"log/slog"
|
||||||
"net"
|
"net"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"sync/atomic"
|
|
||||||
"syscall"
|
"syscall"
|
||||||
"unsafe"
|
"unsafe"
|
||||||
|
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
"github.com/slackhq/nebula/internal/msgx"
|
|
||||||
"golang.org/x/sys/unix"
|
"golang.org/x/sys/unix"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -24,9 +22,6 @@ type StdConn struct {
|
|||||||
isV4 bool
|
isV4 bool
|
||||||
sysFd uintptr
|
sysFd uintptr
|
||||||
l *slog.Logger
|
l *slog.Logger
|
||||||
|
|
||||||
noSendmsgX atomic.Bool
|
|
||||||
sb *sendScratch
|
|
||||||
}
|
}
|
||||||
|
|
||||||
var _ Conn = &StdConn{}
|
var _ Conn = &StdConn{}
|
||||||
@@ -40,7 +35,6 @@ func NewListener(l *slog.Logger, s Settings) (Conn, error) {
|
|||||||
|
|
||||||
if uc, ok := pc.(*net.UDPConn); ok {
|
if uc, ok := pc.(*net.UDPConn); ok {
|
||||||
c := &StdConn{UDPConn: uc, l: l}
|
c := &StdConn{UDPConn: uc, l: l}
|
||||||
c.noSendmsgX.Store(!msgx.Available())
|
|
||||||
|
|
||||||
rc, err := uc.SyscallConn()
|
rc, err := uc.SyscallConn()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -145,138 +139,11 @@ func (u *StdConn) WriteTo(b []byte, ap netip.AddrPort) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// sendBatch is how many datagrams one sendmsg_x call may carry.
|
|
||||||
const sendBatch = 64
|
|
||||||
|
|
||||||
// sendScratch is WriteBatch's scratch. The kernel reads every entry in place.
|
|
||||||
type sendScratch struct {
|
|
||||||
names [sendBatch]unix.RawSockaddrInet6
|
|
||||||
iovs [sendBatch]unix.Iovec
|
|
||||||
hdrs [sendBatch]msgx.Hdr
|
|
||||||
// idx maps each entry back to its index in WriteBatch's bufs.
|
|
||||||
idx [sendBatch]int
|
|
||||||
}
|
|
||||||
|
|
||||||
// WriteBatch sends bufs with sendmsg_x, darwin's private batched sendmsg, so one syscall carries up to
|
|
||||||
// sendBatch datagrams. On this unconnected socket xnu still runs each message through sendit, so the
|
|
||||||
// saving is the syscall crossings, not the per-send policy checks.
|
|
||||||
//
|
|
||||||
// xnu's per-message loop stops at the first message that fails. For the errors in sentNothing it reports
|
|
||||||
// how many went out; for any other it returns only the errno, with the messages before it already sent.
|
|
||||||
// Each call therefore carries one run of datagrams to the same destination: a destination the kernel
|
|
||||||
// refuses fails on its first datagram, so a failed call costs that run and nothing else, and no datagram
|
|
||||||
// is ever resent after the kernel may have taken it.
|
|
||||||
//
|
|
||||||
// TODO: WriteTo maps EWOULDBLOCK to an error, so a full send buffer
|
|
||||||
// silently drops the rest of a burst (linux blocks instead). Poll for
|
|
||||||
// writability on EAGAIN before giving up on the remainder.
|
|
||||||
func (u *StdConn) WriteBatch(bufs [][]byte, addrs []netip.AddrPort) (int, error) {
|
func (u *StdConn) WriteBatch(bufs [][]byte, addrs []netip.AddrPort) (int, error) {
|
||||||
if u.noSendmsgX.Load() {
|
// An un-sendable destination costs its own packet, never the ones behind it in the batch.
|
||||||
return u.writeEach(bufs, addrs), nil
|
// TODO: WriteTo maps EWOULDBLOCK to an error, so a full send buffer
|
||||||
}
|
// silently drops the rest of a burst (linux blocks instead). Poll for
|
||||||
if u.sb == nil {
|
// writability on EAGAIN before giving up on the remainder.
|
||||||
u.sb = new(sendScratch)
|
|
||||||
}
|
|
||||||
b := u.sb
|
|
||||||
written := 0
|
|
||||||
for i := 0; i < len(bufs); {
|
|
||||||
n := 0
|
|
||||||
for ; i < len(bufs) && n < sendBatch; i++ {
|
|
||||||
namelen, err := u.putSockaddr(&b.names[n], addrs[i])
|
|
||||||
if err != nil {
|
|
||||||
u.l.Debug("failed to write packet in batch", "udpAddr", addrs[i], "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
b.iovs[n] = unix.Iovec{}
|
|
||||||
if len(bufs[i]) > 0 {
|
|
||||||
b.iovs[n].Base = &bufs[i][0]
|
|
||||||
b.iovs[n].SetLen(len(bufs[i]))
|
|
||||||
}
|
|
||||||
b.hdrs[n] = msgx.Hdr{Name: (*byte)(unsafe.Pointer(&b.names[n])), Namelen: namelen, Iov: &b.iovs[n], Iovlen: 1}
|
|
||||||
b.idx[n] = i
|
|
||||||
n++
|
|
||||||
}
|
|
||||||
|
|
||||||
for off := 0; off < n; {
|
|
||||||
dst := addrs[b.idx[off]]
|
|
||||||
end := off + 1
|
|
||||||
for end < n && addrs[b.idx[end]] == dst {
|
|
||||||
end++
|
|
||||||
}
|
|
||||||
sent, errno := u.sendmsgX(off, end)
|
|
||||||
switch {
|
|
||||||
case errno == 0 && sent > 0:
|
|
||||||
written += sent
|
|
||||||
off += sent
|
|
||||||
continue
|
|
||||||
case sentNothing(errno):
|
|
||||||
// The datagram at off failed on its own account. sendto delivers or reports it, as without
|
|
||||||
// batching, and the rest of the run goes back to sendmsg_x.
|
|
||||||
j := b.idx[off]
|
|
||||||
written += u.writeEach(bufs[j:j+1], addrs[j:j+1])
|
|
||||||
off++
|
|
||||||
continue
|
|
||||||
case errno == 0:
|
|
||||||
case errno == unix.ENOSYS || errno == unix.EOPNOTSUPP:
|
|
||||||
u.fallBack(errno)
|
|
||||||
case errno == unix.EPERM || errno == unix.EINVAL:
|
|
||||||
// Either can refuse one destination, but a datagram that sendto delivers was refused by
|
|
||||||
// sendmsg_x itself, as a sandbox or an older kernel would.
|
|
||||||
j := b.idx[off]
|
|
||||||
if u.writeEach(bufs[j:j+1], addrs[j:j+1]) == 0 {
|
|
||||||
off = end
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
written++
|
|
||||||
off++
|
|
||||||
u.fallBack(errno)
|
|
||||||
default:
|
|
||||||
u.l.Debug("failed to write packets in batch", "udpAddr", dst, "packets", end-off, "error", errno)
|
|
||||||
off = end
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
// The kernel took nothing from this call, so the rest can go out one datagram at a time.
|
|
||||||
for _, j := range b.idx[off:n] {
|
|
||||||
written += u.writeEach(bufs[j:j+1], addrs[j:j+1])
|
|
||||||
}
|
|
||||||
off = n
|
|
||||||
if u.noSendmsgX.Load() {
|
|
||||||
clear(b.iovs[:n])
|
|
||||||
return written + u.writeEach(bufs[i:], addrs[i:]), nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
clear(b.iovs[:n])
|
|
||||||
}
|
|
||||||
return written, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// sendmsgX hands entries off through end-1 of u.sb to sendmsg_x and returns how many the kernel took.
|
|
||||||
// The socket is non-blocking, so a full send buffer returns EAGAIN rather than waiting.
|
|
||||||
func (u *StdConn) sendmsgX(off, end int) (int, syscall.Errno) {
|
|
||||||
for {
|
|
||||||
sent, errno := msgx.Send(u.sysFd, u.sb.hdrs[off:end], 0)
|
|
||||||
if errno == unix.EINTR {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
return sent, errno
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// sentNothing reports whether sendmsg_x failing with errno means no datagram went out: once any has, xnu
|
|
||||||
// turns these errors into a short count instead.
|
|
||||||
func sentNothing(errno syscall.Errno) bool {
|
|
||||||
return errno == unix.EWOULDBLOCK || errno == unix.ENOBUFS || errno == unix.EMSGSIZE
|
|
||||||
}
|
|
||||||
|
|
||||||
// fallBack switches WriteBatch to one sendto per datagram for the life of the socket.
|
|
||||||
func (u *StdConn) fallBack(errno syscall.Errno) {
|
|
||||||
if u.noSendmsgX.CompareAndSwap(false, true) {
|
|
||||||
u.l.Warn("sendmsg_x unavailable, sending one datagram per syscall", "error", errno)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// writeEach sends bufs one at a time with WriteTo and returns how many were written.
|
|
||||||
func (u *StdConn) writeEach(bufs [][]byte, addrs []netip.AddrPort) int {
|
|
||||||
written := 0
|
written := 0
|
||||||
for i, b := range bufs {
|
for i, b := range bufs {
|
||||||
if err := u.WriteTo(b, addrs[i]); err == nil {
|
if err := u.WriteTo(b, addrs[i]); err == nil {
|
||||||
@@ -285,23 +152,7 @@ func (u *StdConn) writeEach(bufs [][]byte, addrs []netip.AddrPort) int {
|
|||||||
u.l.Debug("failed to write packet in batch", "udpAddr", addrs[i], "error", err)
|
u.l.Debug("failed to write packet in batch", "udpAddr", addrs[i], "error", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return written
|
return written, nil
|
||||||
}
|
|
||||||
|
|
||||||
// putSockaddr writes ap into sa in the socket's address family, as WriteTo would, and returns its length.
|
|
||||||
func (u *StdConn) putSockaddr(sa *unix.RawSockaddrInet6, ap netip.AddrPort) (uint32, error) {
|
|
||||||
if u.isV4 {
|
|
||||||
if ap.Addr().Is6() {
|
|
||||||
return 0, ErrInvalidIPv6RemoteForSocket
|
|
||||||
}
|
|
||||||
sa4 := (*unix.RawSockaddrInet4)(unsafe.Pointer(sa))
|
|
||||||
*sa4 = unix.RawSockaddrInet4{Family: unix.AF_INET, Addr: ap.Addr().As4()}
|
|
||||||
binary.BigEndian.PutUint16((*[2]byte)(unsafe.Pointer(&sa4.Port))[:], ap.Port())
|
|
||||||
return unix.SizeofSockaddrInet4, nil
|
|
||||||
}
|
|
||||||
*sa = unix.RawSockaddrInet6{Family: unix.AF_INET6, Addr: ap.Addr().As16()}
|
|
||||||
binary.BigEndian.PutUint16((*[2]byte)(unsafe.Pointer(&sa.Port))[:], ap.Port())
|
|
||||||
return unix.SizeofSockaddrInet6, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *StdConn) LocalAddr() (netip.AddrPort, error) {
|
func (u *StdConn) LocalAddr() (netip.AddrPort, error) {
|
||||||
@@ -329,106 +180,11 @@ func NewUDPStatsEmitter(udpConns []Conn) func() {
|
|||||||
return func() {}
|
return func() {}
|
||||||
}
|
}
|
||||||
|
|
||||||
// recvBatch is how many datagrams one recvmsg_x call may return.
|
|
||||||
const recvBatch = 64
|
|
||||||
|
|
||||||
// ListenOut drains the socket with recvmsg_x, darwin's private batched recvmsg, so one syscall reads
|
|
||||||
// up to recvBatch datagrams instead of one.
|
|
||||||
func (u *StdConn) ListenOut(r EncReader, flush func()) error {
|
func (u *StdConn) ListenOut(r EncReader, flush func()) error {
|
||||||
if !msgx.Available() {
|
|
||||||
return u.listenOutSingle(r, flush)
|
|
||||||
}
|
|
||||||
rc, err := u.UDPConn.SyscallConn()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
bufs := make([][]byte, recvBatch)
|
|
||||||
names := make([]unix.RawSockaddrInet6, recvBatch)
|
|
||||||
iovs := make([]unix.Iovec, recvBatch)
|
|
||||||
hdrs := make([]msgx.Hdr, recvBatch)
|
|
||||||
for i := range hdrs {
|
|
||||||
bufs[i] = make([]byte, MTU)
|
|
||||||
iovs[i].Base = &bufs[i][0]
|
|
||||||
iovs[i].SetLen(MTU)
|
|
||||||
hdrs[i].Iov = &iovs[i]
|
|
||||||
hdrs[i].Iovlen = 1
|
|
||||||
hdrs[i].Name = (*byte)(unsafe.Pointer(&names[i]))
|
|
||||||
}
|
|
||||||
|
|
||||||
for {
|
|
||||||
var n int
|
|
||||||
var errno syscall.Errno
|
|
||||||
err := rc.Read(func(fd uintptr) bool {
|
|
||||||
for i := range hdrs {
|
|
||||||
hdrs[i].Namelen = unix.SizeofSockaddrInet6
|
|
||||||
hdrs[i].Flags = 0
|
|
||||||
hdrs[i].Datalen = 0
|
|
||||||
}
|
|
||||||
n, errno = msgx.Recv(fd, hdrs, 0)
|
|
||||||
return errno != unix.EAGAIN
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, net.ErrClosed) {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
u.l.Error("unexpected udp socket receive error", "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if errno == unix.ENOSYS || errno == unix.EPERM || errno == unix.EOPNOTSUPP {
|
|
||||||
// recvmsg_x is private, so a kernel or sandbox may refuse it.
|
|
||||||
u.l.Warn("recvmsg_x unavailable, reading one datagram per syscall", "error", errno)
|
|
||||||
return u.listenOutSingle(r, flush)
|
|
||||||
}
|
|
||||||
if errno != 0 {
|
|
||||||
if errno != unix.EINTR {
|
|
||||||
u.l.Error("unexpected udp socket receive error", "error", errno)
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if err := checkMsghdrX(hdrs, names, n); err != nil {
|
|
||||||
// The batch was read through a layout the kernel no longer writes, so none of it is trustworthy.
|
|
||||||
u.l.Warn("recvmsg_x returned an unexpected header, reading one datagram per syscall", "error", err)
|
|
||||||
return u.listenOutSingle(r, flush)
|
|
||||||
}
|
|
||||||
|
|
||||||
for i := 0; i < n; i++ {
|
|
||||||
addr, ok := sockaddrToAddrPort(&names[i])
|
|
||||||
if !ok {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
l := int(hdrs[i].Datalen)
|
|
||||||
r(addr, bufs[i][:l:l])
|
|
||||||
}
|
|
||||||
flush()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// checkMsghdrX rejects a recvmsg_x result that intact msghdr_x entries can't produce, which is how a change
|
|
||||||
// to xnu's private struct layout would show up.
|
|
||||||
func checkMsghdrX(hdrs []msgx.Hdr, names []unix.RawSockaddrInet6, n int) error {
|
|
||||||
if n > len(hdrs) {
|
|
||||||
return fmt.Errorf("returned %d datagrams for %d headers", n, len(hdrs))
|
|
||||||
}
|
|
||||||
for i := range n {
|
|
||||||
if hdrs[i].Datalen > MTU {
|
|
||||||
return fmt.Errorf("datagram %d is %d bytes, past the %d byte buffer", i, hdrs[i].Datalen, MTU)
|
|
||||||
}
|
|
||||||
switch {
|
|
||||||
case names[i].Family == unix.AF_INET && hdrs[i].Namelen == unix.SizeofSockaddrInet4:
|
|
||||||
case names[i].Family == unix.AF_INET6 && hdrs[i].Namelen == unix.SizeofSockaddrInet6:
|
|
||||||
default:
|
|
||||||
return fmt.Errorf("datagram %d has address family %d with length %d", i, names[i].Family, hdrs[i].Namelen)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// listenOutSingle reads one datagram per recvfrom and flushes after each, for when recvmsg_x is refused or misbehaves.
|
|
||||||
func (u *StdConn) listenOutSingle(r EncReader, flush func()) error {
|
|
||||||
buffer := make([]byte, MTU)
|
buffer := make([]byte, MTU)
|
||||||
|
|
||||||
for {
|
for {
|
||||||
|
// Just read one packet at a time
|
||||||
n, rua, err := u.ReadFromUDPAddrPort(buffer)
|
n, rua, err := u.ReadFromUDPAddrPort(buffer)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if errors.Is(err, net.ErrClosed) {
|
if errors.Is(err, net.ErrClosed) {
|
||||||
@@ -443,19 +199,6 @@ func (u *StdConn) listenOutSingle(r EncReader, flush func()) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func sockaddrToAddrPort(sa *unix.RawSockaddrInet6) (netip.AddrPort, bool) {
|
|
||||||
switch sa.Family {
|
|
||||||
case unix.AF_INET:
|
|
||||||
sa4 := (*unix.RawSockaddrInet4)(unsafe.Pointer(sa))
|
|
||||||
port := binary.BigEndian.Uint16((*[2]byte)(unsafe.Pointer(&sa4.Port))[:])
|
|
||||||
return netip.AddrPortFrom(netip.AddrFrom4(sa4.Addr), port), true
|
|
||||||
case unix.AF_INET6:
|
|
||||||
port := binary.BigEndian.Uint16((*[2]byte)(unsafe.Pointer(&sa.Port))[:])
|
|
||||||
return netip.AddrPortFrom(netip.AddrFrom16(sa.Addr).Unmap(), port), true
|
|
||||||
}
|
|
||||||
return netip.AddrPort{}, false
|
|
||||||
}
|
|
||||||
|
|
||||||
func (u *StdConn) SupportsMultipleReaders() bool {
|
func (u *StdConn) SupportsMultipleReaders() bool {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,85 +0,0 @@
|
|||||||
//go:build !e2e_testing
|
|
||||||
|
|
||||||
package udp
|
|
||||||
|
|
||||||
import (
|
|
||||||
"log/slog"
|
|
||||||
"net"
|
|
||||||
"net/netip"
|
|
||||||
"sync"
|
|
||||||
"sync/atomic"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
// BenchmarkListenOut measures the receive path on loopback: senders flood datagrams sized like a full tunnel
|
|
||||||
// packet, and each op is one datagram delivered to the reader. There are enough senders that the reader, not the
|
|
||||||
// senders, sets the pace. flushes/pkt is 1 when every receive is its own syscall and falls as receives batch. The
|
|
||||||
// senders share the machine, so ns/op is only comparable between runs on the same host.
|
|
||||||
func BenchmarkListenOut(b *testing.B) {
|
|
||||||
for _, tc := range []struct{ name, listen string }{
|
|
||||||
{"v4", "127.0.0.1"},
|
|
||||||
{"v6", "::1"},
|
|
||||||
} {
|
|
||||||
b.Run(tc.name, func(b *testing.B) {
|
|
||||||
c, err := NewListener(slog.New(slog.DiscardHandler), Settings{Listen: netip.AddrPortFrom(netip.MustParseAddr(tc.listen), 0)})
|
|
||||||
if err != nil {
|
|
||||||
b.Fatal(err)
|
|
||||||
}
|
|
||||||
la, err := c.LocalAddr()
|
|
||||||
if err != nil {
|
|
||||||
b.Fatal(err)
|
|
||||||
}
|
|
||||||
const size, senders = 1300, 4
|
|
||||||
txs := make([]net.Conn, senders)
|
|
||||||
for i := range txs {
|
|
||||||
if txs[i], err = net.Dial("udp", la.String()); err != nil {
|
|
||||||
b.Fatal(err)
|
|
||||||
}
|
|
||||||
defer txs[i].Close()
|
|
||||||
}
|
|
||||||
|
|
||||||
target := int64(b.N)
|
|
||||||
var got, flushes atomic.Int64
|
|
||||||
reached := make(chan struct{})
|
|
||||||
done := make(chan struct{})
|
|
||||||
go func() {
|
|
||||||
_ = c.ListenOut(func(netip.AddrPort, []byte) {
|
|
||||||
if got.Add(1) == target {
|
|
||||||
close(reached)
|
|
||||||
}
|
|
||||||
}, func() { flushes.Add(1) })
|
|
||||||
close(done)
|
|
||||||
}()
|
|
||||||
|
|
||||||
// Writes fail with ENOBUFS while the send queue is full; the flood only has to keep the receiver busy.
|
|
||||||
stop := make(chan struct{})
|
|
||||||
var sent sync.WaitGroup
|
|
||||||
for _, tx := range txs {
|
|
||||||
sent.Go(func() {
|
|
||||||
payload := make([]byte, size)
|
|
||||||
for {
|
|
||||||
select {
|
|
||||||
case <-stop:
|
|
||||||
return
|
|
||||||
default:
|
|
||||||
_, _ = tx.Write(payload)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
b.SetBytes(size)
|
|
||||||
b.ResetTimer()
|
|
||||||
<-reached
|
|
||||||
b.StopTimer()
|
|
||||||
|
|
||||||
close(stop)
|
|
||||||
sent.Wait()
|
|
||||||
if err := c.Close(); err != nil {
|
|
||||||
b.Fatal(err)
|
|
||||||
}
|
|
||||||
<-done
|
|
||||||
b.ReportMetric(float64(flushes.Load())/float64(got.Load()), "flushes/pkt")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,302 +0,0 @@
|
|||||||
//go:build !e2e_testing
|
|
||||||
|
|
||||||
package udp
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"fmt"
|
|
||||||
"log/slog"
|
|
||||||
"net"
|
|
||||||
"net/netip"
|
|
||||||
"sync"
|
|
||||||
"syscall"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
"unsafe"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/internal/msgx"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
// A burst larger than recvBatch arrives whole, with each datagram's own bytes and source address, and
|
|
||||||
// flush runs once per recvmsg_x batch rather than once per datagram.
|
|
||||||
func TestListenOutBatchesBurst(t *testing.T) {
|
|
||||||
for _, tc := range []struct{ name, listen string }{
|
|
||||||
{"v4", "127.0.0.1"},
|
|
||||||
{"v6", "::1"},
|
|
||||||
} {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
c, err := NewListener(slog.New(slog.DiscardHandler), Settings{Listen: netip.AddrPortFrom(netip.MustParseAddr(tc.listen), 0)})
|
|
||||||
require.NoError(t, err)
|
|
||||||
la, err := c.LocalAddr()
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
tx, err := net.Dial("udp", la.String())
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer tx.Close()
|
|
||||||
txAddr := netip.MustParseAddrPort(tx.LocalAddr().String())
|
|
||||||
|
|
||||||
const total = recvBatch*3 + 7
|
|
||||||
var mu sync.Mutex
|
|
||||||
var got []string
|
|
||||||
var froms []netip.AddrPort
|
|
||||||
flushes := 0
|
|
||||||
// Queued before the reader starts, so recvmsg_x sees full batches.
|
|
||||||
for i := 0; i < total; i++ {
|
|
||||||
_, err := tx.Write([]byte(fmt.Sprintf("pkt-%03d", i)))
|
|
||||||
require.NoError(t, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
done := make(chan struct{})
|
|
||||||
go func() {
|
|
||||||
_ = c.ListenOut(func(addr netip.AddrPort, payload []byte) {
|
|
||||||
mu.Lock()
|
|
||||||
got = append(got, string(payload))
|
|
||||||
froms = append(froms, addr)
|
|
||||||
mu.Unlock()
|
|
||||||
}, func() {
|
|
||||||
mu.Lock()
|
|
||||||
flushes++
|
|
||||||
mu.Unlock()
|
|
||||||
})
|
|
||||||
close(done)
|
|
||||||
}()
|
|
||||||
|
|
||||||
require.Eventually(t, func() bool {
|
|
||||||
mu.Lock()
|
|
||||||
defer mu.Unlock()
|
|
||||||
return len(got) == total
|
|
||||||
}, 5*time.Second, 10*time.Millisecond)
|
|
||||||
|
|
||||||
require.NoError(t, c.Close())
|
|
||||||
<-done
|
|
||||||
|
|
||||||
for i, p := range got {
|
|
||||||
assert.Equal(t, fmt.Sprintf("pkt-%03d", i), p)
|
|
||||||
assert.Equal(t, txAddr, froms[i])
|
|
||||||
}
|
|
||||||
assert.Equal(t, (total+recvBatch-1)/recvBatch, flushes)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// msgx.Hdr round-trips through xnu's recvmsg_x on a loopback socket, v4 and v6. The kernel reads Name, Namelen,
|
|
||||||
// Iov and Iovlen from each entry and writes Namelen, Flags and Datalen back, so a field at the wrong offset or a
|
|
||||||
// wrong stride between entries shows up as a wrong length, sender, or payload.
|
|
||||||
// TestListenOutSingleFallback pins the path ListenOut takes when the kernel refuses recvmsg_x.
|
|
||||||
func TestListenOutSingleFallback(t *testing.T) {
|
|
||||||
c, err := NewListener(slog.New(slog.DiscardHandler), Settings{Listen: netip.MustParseAddrPort("127.0.0.1:0")})
|
|
||||||
require.NoError(t, err)
|
|
||||||
la, err := c.LocalAddr()
|
|
||||||
require.NoError(t, err)
|
|
||||||
tx, err := net.Dial("udp", la.String())
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer tx.Close()
|
|
||||||
txAddr := netip.MustParseAddrPort(tx.LocalAddr().String())
|
|
||||||
|
|
||||||
const total = 5
|
|
||||||
for i := 0; i < total; i++ {
|
|
||||||
_, err := tx.Write([]byte(fmt.Sprintf("pkt-%03d", i)))
|
|
||||||
require.NoError(t, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var mu sync.Mutex
|
|
||||||
var got []string
|
|
||||||
flushes := 0
|
|
||||||
done := make(chan struct{})
|
|
||||||
go func() {
|
|
||||||
_ = c.(*StdConn).listenOutSingle(func(addr netip.AddrPort, payload []byte) {
|
|
||||||
assert.Equal(t, txAddr, addr)
|
|
||||||
mu.Lock()
|
|
||||||
got = append(got, string(payload))
|
|
||||||
mu.Unlock()
|
|
||||||
}, func() {
|
|
||||||
mu.Lock()
|
|
||||||
flushes++
|
|
||||||
mu.Unlock()
|
|
||||||
})
|
|
||||||
close(done)
|
|
||||||
}()
|
|
||||||
|
|
||||||
require.Eventually(t, func() bool {
|
|
||||||
mu.Lock()
|
|
||||||
defer mu.Unlock()
|
|
||||||
return len(got) == total
|
|
||||||
}, 5*time.Second, 10*time.Millisecond)
|
|
||||||
require.NoError(t, c.Close())
|
|
||||||
<-done
|
|
||||||
|
|
||||||
for i, p := range got {
|
|
||||||
assert.Equal(t, fmt.Sprintf("pkt-%03d", i), p)
|
|
||||||
}
|
|
||||||
assert.Equal(t, total, flushes)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheckMsghdrX(t *testing.T) {
|
|
||||||
valid := func() ([]msgx.Hdr, []unix.RawSockaddrInet6) {
|
|
||||||
hdrs := make([]msgx.Hdr, 2)
|
|
||||||
names := make([]unix.RawSockaddrInet6, 2)
|
|
||||||
hdrs[0].Namelen, hdrs[0].Datalen = unix.SizeofSockaddrInet4, 1
|
|
||||||
names[0].Family = unix.AF_INET
|
|
||||||
hdrs[1].Namelen, hdrs[1].Datalen = unix.SizeofSockaddrInet6, MTU
|
|
||||||
names[1].Family = unix.AF_INET6
|
|
||||||
return hdrs, names
|
|
||||||
}
|
|
||||||
|
|
||||||
hdrs, names := valid()
|
|
||||||
require.NoError(t, checkMsghdrX(hdrs, names, 2))
|
|
||||||
require.NoError(t, checkMsghdrX(hdrs, names, 0))
|
|
||||||
|
|
||||||
for _, tc := range []struct {
|
|
||||||
name string
|
|
||||||
n int
|
|
||||||
mutate func([]msgx.Hdr, []unix.RawSockaddrInet6)
|
|
||||||
}{
|
|
||||||
{"count past headers", 3, func([]msgx.Hdr, []unix.RawSockaddrInet6) {}},
|
|
||||||
{"datalen past buffer", 2, func(h []msgx.Hdr, _ []unix.RawSockaddrInet6) { h[1].Datalen = MTU + 1 }},
|
|
||||||
{"unknown family", 2, func(_ []msgx.Hdr, a []unix.RawSockaddrInet6) { a[0].Family = unix.AF_UNIX }},
|
|
||||||
{"family and length disagree", 2, func(h []msgx.Hdr, _ []unix.RawSockaddrInet6) { h[0].Namelen = unix.SizeofSockaddrInet6 }},
|
|
||||||
} {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
hdrs, names := valid()
|
|
||||||
tc.mutate(hdrs, names)
|
|
||||||
assert.Error(t, checkMsghdrX(hdrs, names, tc.n))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestMsghdrXKernelRoundTrip(t *testing.T) {
|
|
||||||
for _, v6 := range []bool{false, true} {
|
|
||||||
t.Run(fmt.Sprintf("v6=%v", v6), func(t *testing.T) {
|
|
||||||
// Loopback delivery goes through the dlil input thread, so the settle gives all three time to
|
|
||||||
// queue and come back from one call, which is what exercises the stride.
|
|
||||||
got := recvmsgXRoundTrip(t, v6, []int{1, 300, 1400}, 4, 50*time.Millisecond)
|
|
||||||
assert.Equal(t, 3, got, "largest batch from one recvmsg_x call")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Any burst, of any datagram lengths up to the kernel's maxdgram, into any number of headers, comes back in order
|
|
||||||
// with every entry's fields intact, and headers past the returned count untouched.
|
|
||||||
func FuzzMsghdrXKernelRoundTrip(f *testing.F) {
|
|
||||||
f.Add(false, uint8(3), []byte{0, 1, 1, 44, 5, 120})
|
|
||||||
f.Add(true, uint8(0), []byte{0, 0, 0x23, 0x29}) // one empty datagram, then one at MTU
|
|
||||||
f.Add(false, uint8(1), []byte{0x23, 0x2a, 0x24, 0x00, 0}) // past MTU: cut to MTU, no MSG_TRUNC
|
|
||||||
f.Add(true, uint8(recvBatch-1), bytes.Repeat([]byte{0x05, 0xdc}, recvBatch))
|
|
||||||
|
|
||||||
f.Fuzz(func(t *testing.T, v6 bool, spare uint8, sizes []byte) {
|
|
||||||
// Two bytes per datagram, big-endian, folded into [0, maxdgram].
|
|
||||||
var lens []int
|
|
||||||
for i := 0; i+1 < len(sizes) && len(lens) < recvBatch; i += 2 {
|
|
||||||
lens = append(lens, (int(sizes[i])<<8|int(sizes[i+1]))%(maxDgram+1))
|
|
||||||
}
|
|
||||||
if len(lens) == 0 {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
recvmsgXRoundTrip(t, v6, lens, 1+int(spare)%recvBatch, time.Millisecond)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// maxDgram is darwin's default net.inet.udp.maxdgram, the largest datagram a loopback sender may write.
|
|
||||||
const maxDgram = 9216
|
|
||||||
|
|
||||||
// recvmsgXRoundTrip sends one datagram per entry of lens to a fresh loopback socket, drains them with recvmsg_x
|
|
||||||
// into nh headers, and checks every field the kernel writes. Neighboring datagrams differ in sender, length and
|
|
||||||
// fill byte, so no field can pass by reading a neighbor's value. It returns the largest batch one call returned.
|
|
||||||
func recvmsgXRoundTrip(t *testing.T, v6 bool, lens []int, nh int, settle time.Duration) int {
|
|
||||||
t.Helper()
|
|
||||||
network, lo := "udp4", netip.MustParseAddr("127.0.0.1")
|
|
||||||
if v6 {
|
|
||||||
network, lo = "udp6", netip.IPv6Loopback()
|
|
||||||
}
|
|
||||||
rx, err := net.ListenUDP(network, net.UDPAddrFromAddrPort(netip.AddrPortFrom(lo, 0)))
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer rx.Close()
|
|
||||||
|
|
||||||
txs := make([]*net.UDPConn, 3)
|
|
||||||
for i := range txs {
|
|
||||||
txs[i], err = net.DialUDP(network, nil, rx.LocalAddr().(*net.UDPAddr))
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer txs[i].Close()
|
|
||||||
}
|
|
||||||
senders := make([]netip.AddrPort, len(lens))
|
|
||||||
for i, l := range lens {
|
|
||||||
tx := txs[i%len(txs)]
|
|
||||||
senders[i] = tx.LocalAddr().(*net.UDPAddr).AddrPort()
|
|
||||||
_, err := tx.Write(bytes.Repeat([]byte{byte(i + 1)}, l))
|
|
||||||
require.NoError(t, err)
|
|
||||||
}
|
|
||||||
time.Sleep(settle)
|
|
||||||
|
|
||||||
// Namelen goes in as the v6 size on both families, so the v4 size coming back proves the kernel wrote it.
|
|
||||||
const sentinel = 0xa5a5a5a5a5a5a5a5
|
|
||||||
wantNamelen := uint32(unix.SizeofSockaddrInet4)
|
|
||||||
if v6 {
|
|
||||||
wantNamelen = unix.SizeofSockaddrInet6
|
|
||||||
}
|
|
||||||
bufs := make([][]byte, nh)
|
|
||||||
names := make([]unix.RawSockaddrInet6, nh)
|
|
||||||
iovs := make([]unix.Iovec, nh)
|
|
||||||
hdrs := make([]msgx.Hdr, nh)
|
|
||||||
for i := range hdrs {
|
|
||||||
bufs[i] = make([]byte, MTU)
|
|
||||||
iovs[i].Base = &bufs[i][0]
|
|
||||||
iovs[i].SetLen(MTU)
|
|
||||||
}
|
|
||||||
|
|
||||||
// A datagram dropped on loopback would otherwise block rc.Read forever.
|
|
||||||
require.NoError(t, rx.SetReadDeadline(time.Now().Add(5*time.Second)))
|
|
||||||
rc, err := rx.SyscallConn()
|
|
||||||
require.NoError(t, err)
|
|
||||||
largest := 0
|
|
||||||
for next := 0; next < len(lens); {
|
|
||||||
for i := range hdrs {
|
|
||||||
clear(bufs[i])
|
|
||||||
hdrs[i] = msgx.Hdr{
|
|
||||||
Name: (*byte)(unsafe.Pointer(&names[i])),
|
|
||||||
Namelen: unix.SizeofSockaddrInet6,
|
|
||||||
Iov: &iovs[i],
|
|
||||||
Iovlen: 1,
|
|
||||||
Flags: -1,
|
|
||||||
Datalen: sentinel,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
var n int
|
|
||||||
var errno syscall.Errno
|
|
||||||
require.NoError(t, rc.Read(func(fd uintptr) bool {
|
|
||||||
n, errno = msgx.Recv(fd, hdrs[:nh], 0)
|
|
||||||
return errno != unix.EAGAIN
|
|
||||||
}), "received %d of %d datagrams", next, len(lens))
|
|
||||||
require.Zero(t, errno)
|
|
||||||
require.Positive(t, n)
|
|
||||||
require.LessOrEqual(t, n, min(nh, len(lens)-next))
|
|
||||||
largest = max(largest, n)
|
|
||||||
require.NoError(t, checkMsghdrX(hdrs[:nh], names[:nh], n), "ListenOut would fall back on this batch")
|
|
||||||
|
|
||||||
for i := range n {
|
|
||||||
d := next + i
|
|
||||||
h := &hdrs[i]
|
|
||||||
want := min(lens[d], MTU)
|
|
||||||
require.EqualValues(t, want, h.Datalen, "datagram %d Datalen", d)
|
|
||||||
require.Equal(t, wantNamelen, h.Namelen, "datagram %d Namelen", d)
|
|
||||||
from, ok := sockaddrToAddrPort(&names[i])
|
|
||||||
require.True(t, ok, "datagram %d family %d", d, names[i].Family)
|
|
||||||
require.Equal(t, senders[d], from, "datagram %d sender", d)
|
|
||||||
// Flags goes in as -1 and must come back 0. xnu's list receive (soreceive_m_list) never sets
|
|
||||||
// MSG_TRUNC, so a datagram past MTU arrives silently cut to MTU, as recvfrom through net.UDPConn does.
|
|
||||||
require.Zero(t, h.Flags, "datagram %d Flags", d)
|
|
||||||
require.Equal(t, bytes.Repeat([]byte{byte(d + 1)}, want), bufs[i][:want], "datagram %d payload", d)
|
|
||||||
if want < MTU {
|
|
||||||
require.Zero(t, bufs[i][want], "datagram %d wrote past Datalen", d)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
for i := n; i < nh; i++ {
|
|
||||||
require.EqualValues(t, uint64(sentinel), hdrs[i].Datalen, "spare header %d Datalen", i)
|
|
||||||
require.EqualValues(t, unix.SizeofSockaddrInet6, hdrs[i].Namelen, "spare header %d Namelen", i)
|
|
||||||
}
|
|
||||||
next += n
|
|
||||||
}
|
|
||||||
return largest
|
|
||||||
}
|
|
||||||
@@ -1,150 +0,0 @@
|
|||||||
//go:build !e2e_testing
|
|
||||||
|
|
||||||
package udp
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"log/slog"
|
|
||||||
"net"
|
|
||||||
"net/netip"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// recvAll reads n datagrams from pc, or fails the test after a second without one.
|
|
||||||
func recvAll(t *testing.T, pc net.PacketConn, n int) []string {
|
|
||||||
t.Helper()
|
|
||||||
var got []string
|
|
||||||
buf := make([]byte, 64)
|
|
||||||
for len(got) < n {
|
|
||||||
require.NoError(t, pc.SetReadDeadline(time.Now().Add(time.Second)))
|
|
||||||
l, _, err := pc.ReadFrom(buf)
|
|
||||||
require.NoError(t, err, "after %d of %d datagrams", len(got), n)
|
|
||||||
got = append(got, string(buf[:l]))
|
|
||||||
}
|
|
||||||
return got
|
|
||||||
}
|
|
||||||
|
|
||||||
// A batch longer than sendBatch reaches each peer whole and in order through sendmsg_x, without falling
|
|
||||||
// back to sendto: a run to one peer that spans two calls, then datagrams alternating between peers.
|
|
||||||
func TestWriteBatchSendsEachToItsPeer(t *testing.T) {
|
|
||||||
for _, tc := range []struct{ name, listen string }{
|
|
||||||
{"v4", "127.0.0.1"},
|
|
||||||
{"v6", "::1"},
|
|
||||||
} {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
c, err := NewListener(slog.New(slog.DiscardHandler), Settings{Listen: netip.AddrPortFrom(netip.MustParseAddr(tc.listen), 0)})
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer c.Close()
|
|
||||||
|
|
||||||
var peers [2]net.PacketConn
|
|
||||||
var dsts [2]netip.AddrPort
|
|
||||||
for i := range peers {
|
|
||||||
peers[i], err = net.ListenPacket("udp", net.JoinHostPort(tc.listen, "0"))
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer peers[i].Close()
|
|
||||||
dsts[i] = netip.MustParseAddrPort(peers[i].LocalAddr().String())
|
|
||||||
}
|
|
||||||
|
|
||||||
const total = sendBatch*2 + 5
|
|
||||||
bufs := make([][]byte, total)
|
|
||||||
addrs := make([]netip.AddrPort, total)
|
|
||||||
var want [2][]string
|
|
||||||
for i := range bufs {
|
|
||||||
bufs[i] = fmt.Appendf(nil, "pkt-%03d", i)
|
|
||||||
p := i % 2
|
|
||||||
if i < sendBatch+6 {
|
|
||||||
p = 0
|
|
||||||
}
|
|
||||||
addrs[i] = dsts[p]
|
|
||||||
want[p] = append(want[p], string(bufs[i]))
|
|
||||||
}
|
|
||||||
|
|
||||||
n, err := c.WriteBatch(bufs, addrs)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Equal(t, total, n)
|
|
||||||
assert.False(t, c.(*StdConn).noSendmsgX.Load(), "fell back to sendto")
|
|
||||||
for i := range peers {
|
|
||||||
assert.Equal(t, want[i], recvAll(t, peers[i], len(want[i])))
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Destinations that can't be sent to cost only their own packets: an IPv6 peer on an IPv4 socket is
|
|
||||||
// skipped before the call, and a broadcast address without SO_BROADCAST is refused by the kernel
|
|
||||||
// mid-batch. Neither stops the packets around it, delivers any twice, or turns sendmsg_x off.
|
|
||||||
func TestWriteBatchSkipsUnsendableDestinations(t *testing.T) {
|
|
||||||
c, err := NewListener(slog.New(slog.DiscardHandler), Settings{Listen: netip.MustParseAddrPort("127.0.0.1:0")})
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer c.Close()
|
|
||||||
|
|
||||||
peer, err := net.ListenPacket("udp", "127.0.0.1:0")
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer peer.Close()
|
|
||||||
good := netip.MustParseAddrPort(peer.LocalAddr().String())
|
|
||||||
bcast := netip.AddrPortFrom(netip.MustParseAddr("255.255.255.255"), good.Port())
|
|
||||||
v6 := netip.MustParseAddrPort("[::1]:4242")
|
|
||||||
|
|
||||||
addrs := []netip.AddrPort{good, bcast, bcast, good, v6, good, bcast}
|
|
||||||
bufs := make([][]byte, len(addrs))
|
|
||||||
for i := range bufs {
|
|
||||||
bufs[i] = fmt.Appendf(nil, "pkt-%d", i)
|
|
||||||
}
|
|
||||||
|
|
||||||
n, err := c.WriteBatch(bufs, addrs)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Equal(t, 3, n)
|
|
||||||
assert.False(t, c.(*StdConn).noSendmsgX.Load(), "fell back to sendto")
|
|
||||||
assert.Equal(t, []string{"pkt-0", "pkt-3", "pkt-5"}, recvAll(t, peer, 3))
|
|
||||||
require.NoError(t, peer.SetReadDeadline(time.Now().Add(100*time.Millisecond)))
|
|
||||||
_, _, err = peer.ReadFrom(make([]byte, 64))
|
|
||||||
assert.Error(t, err, "a datagram arrived twice")
|
|
||||||
}
|
|
||||||
|
|
||||||
// A datagram the kernel refuses as its own fault (EMSGSIZE here, as ENOBUFS would be under a full
|
|
||||||
// interface queue) costs only itself, whether it fails after others in the same call (a short count) or
|
|
||||||
// first (the errno alone): the rest of its run still arrives, in order, and sendmsg_x stays on.
|
|
||||||
func TestWriteBatchLosesOnlyTheFailedDatagram(t *testing.T) {
|
|
||||||
for _, tc := range []struct {
|
|
||||||
name string
|
|
||||||
big int
|
|
||||||
}{
|
|
||||||
{"mid-call", 2},
|
|
||||||
{"first", 0},
|
|
||||||
} {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
c, err := NewListener(slog.New(slog.DiscardHandler), Settings{Listen: netip.MustParseAddrPort("127.0.0.1:0")})
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer c.Close()
|
|
||||||
|
|
||||||
peer, err := net.ListenPacket("udp", "127.0.0.1:0")
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer peer.Close()
|
|
||||||
dst := netip.MustParseAddrPort(peer.LocalAddr().String())
|
|
||||||
|
|
||||||
bufs := make([][]byte, 5)
|
|
||||||
addrs := make([]netip.AddrPort, len(bufs))
|
|
||||||
var want []string
|
|
||||||
for i := range bufs {
|
|
||||||
addrs[i] = dst
|
|
||||||
if i == tc.big {
|
|
||||||
// Past the 65535-byte IP datagram limit, so the kernel can only refuse it.
|
|
||||||
bufs[i] = make([]byte, 70000)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
bufs[i] = fmt.Appendf(nil, "pkt-%d", i)
|
|
||||||
want = append(want, string(bufs[i]))
|
|
||||||
}
|
|
||||||
|
|
||||||
n, err := c.WriteBatch(bufs, addrs)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Equal(t, len(want), n)
|
|
||||||
assert.False(t, c.(*StdConn).noSendmsgX.Load(), "fell back to sendto")
|
|
||||||
assert.Equal(t, want, recvAll(t, peer, len(want)))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Reference in new issue
Block a user