mirror of
https://github.com/slackhq/nebula.git
synced 2026-11-16 10:06:52 +01:00
Compare commits
14
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f3b76703ae | ||
|
|
fc0dbfec4c | ||
|
|
ca69a0613b | ||
|
|
84a26846f4 | ||
|
|
317388e37d | ||
|
|
06fd191367 | ||
|
|
3f392883ca | ||
|
|
30cf2bbe6c | ||
|
|
11b04517f3 | ||
|
|
610ba57105 | ||
|
|
9e96894bd7 | ||
|
|
14f80450fb | ||
|
|
641d1fb703 | ||
|
|
11a4298c36 |
No files matched your search
@@ -7,13 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- `create-tunnel -address <ip:port>` panicked on a nil RemoteList and, over the ssh debug server, took nebula
|
|
||||||
down with it. A hostinfo returned by StartHandshake had no RemoteList until the handshake loop's first
|
|
||||||
pass attached one, and `create-tunnel -address` set the remote before that. The list is now attached when
|
|
||||||
the handshake starts, so a pending hostinfo never exists without one.
|
|
||||||
|
|
||||||
## [1.11.1] - 2026-08-21
|
## [1.11.1] - 2026-08-21
|
||||||
|
|
||||||
See the [v1.11.1](https://github.com/slackhq/nebula/milestone/30?closed=1) milestone for a complete list of changes.
|
See the [v1.11.1](https://github.com/slackhq/nebula/milestone/30?closed=1) milestone for a complete list of changes.
|
||||||
|
|||||||
@@ -174,8 +174,10 @@ func (cm *connectionManager) doTrafficCheck(localIndex uint32, p, nb, out []byte
|
|||||||
|
|
||||||
switch decision {
|
switch decision {
|
||||||
case deleteTunnel:
|
case deleteTunnel:
|
||||||
// Local delete only, clearing the lighthouse cache if this was the last hostinfo for the vpn addr
|
if cm.hostMap.DeleteHostInfo(hostinfo) {
|
||||||
cm.intf.closeTunnel(hostinfo)
|
// Only clearing the lighthouse cache if this is the last hostinfo for this vpn ip in the hostmap
|
||||||
|
cm.intf.lightHouse.DeleteVpnAddrs(hostinfo.vpnAddrs)
|
||||||
|
}
|
||||||
|
|
||||||
case closeTunnel:
|
case closeTunnel:
|
||||||
cm.intf.sendCloseTunnel(hostinfo)
|
cm.intf.sendCloseTunnel(hostinfo)
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ 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"
|
||||||
@@ -22,8 +21,6 @@ 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,8 +2,6 @@ package nebula
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"strconv"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -13,7 +11,6 @@ import (
|
|||||||
ct "github.com/slackhq/nebula/cert_test"
|
ct "github.com/slackhq/nebula/cert_test"
|
||||||
"github.com/slackhq/nebula/handshake"
|
"github.com/slackhq/nebula/handshake"
|
||||||
"github.com/slackhq/nebula/header"
|
"github.com/slackhq/nebula/header"
|
||||||
"github.com/slackhq/nebula/overlay"
|
|
||||||
"github.com/slackhq/nebula/test"
|
"github.com/slackhq/nebula/test"
|
||||||
"github.com/slackhq/nebula/udp"
|
"github.com/slackhq/nebula/udp"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
@@ -150,122 +147,6 @@ func TestSendNoMetricsCloseTunnelKeepsRebindEpoch(t *testing.T) {
|
|||||||
assert.True(t, hostinfo.markOut(1), "a CloseTunnel send must not consume the rebind epoch")
|
assert.True(t, hostinfo.markOut(1), "a CloseTunnel send must not consume the rebind epoch")
|
||||||
}
|
}
|
||||||
|
|
||||||
// capturingConn is a udp.Conn that records every WriteTo.
|
|
||||||
type capturingConn struct {
|
|
||||||
udp.NoopConn
|
|
||||||
writes [][]byte
|
|
||||||
addrs []netip.AddrPort
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *capturingConn) WriteTo(b []byte, addr netip.AddrPort) error {
|
|
||||||
c.writes = append(c.writes, append([]byte(nil), b...))
|
|
||||||
c.addrs = append(c.addrs, addr)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSendNoMetricsViaRelay sends through a relay from the mtu sized buffer the cached packet flush uses. Payloads up
|
|
||||||
// to overlay.MaxMTU go out intact, anything bigger is dropped rather than outgrowing the buffer, which once panicked.
|
|
||||||
func TestSendNoMetricsViaRelay(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
n int
|
|
||||||
sent bool
|
|
||||||
}{
|
|
||||||
{0, true},
|
|
||||||
{1300, true},
|
|
||||||
{overlay.MaxMTU, true},
|
|
||||||
{overlay.MaxMTU + 1, false}, // too big for the relay's tag
|
|
||||||
{mtu - 47, false}, // too big for the inner tag, this panicked
|
|
||||||
{9000, false}, // a full packet at tun.mtu 9000
|
|
||||||
}
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(strconv.Itoa(tt.n), func(t *testing.T) {
|
|
||||||
// One tunnel to the target, carried end to end, and one to the relay that wraps it
|
|
||||||
targetInit, targetResp := runTestHandshake(t)
|
|
||||||
relayInit, relayResp := runTestHandshake(t)
|
|
||||||
ci, err := newConnectionStateFromResult(targetInit)
|
|
||||||
require.NoError(t, err)
|
|
||||||
relayCI, err := newConnectionStateFromResult(relayInit)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
targetAddr := netip.MustParseAddr("10.0.0.2")
|
|
||||||
relayAddr := netip.MustParseAddr("10.0.0.3")
|
|
||||||
relayRemote := netip.MustParseAddrPort("192.0.2.1:4242")
|
|
||||||
|
|
||||||
relay := &Relay{Type: TerminalType, State: Established, LocalIndex: 5, RemoteIndex: 6, PeerAddr: targetAddr}
|
|
||||||
relayHI := &HostInfo{
|
|
||||||
vpnAddrs: []netip.Addr{relayAddr},
|
|
||||||
ConnectionState: relayCI,
|
|
||||||
relayState: RelayState{
|
|
||||||
relayForByAddr: map[netip.Addr]*Relay{targetAddr: relay},
|
|
||||||
relayForByIdx: map[uint32]*Relay{relay.LocalIndex: relay},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
relayHI.remote.Store(&relayRemote)
|
|
||||||
|
|
||||||
// No remote of its own, so the send has to go via the relay
|
|
||||||
hostinfo := &HostInfo{
|
|
||||||
vpnAddrs: []netip.Addr{targetAddr},
|
|
||||||
ConnectionState: ci,
|
|
||||||
remoteIndexId: 7,
|
|
||||||
relayState: RelayState{
|
|
||||||
relays: []netip.Addr{relayAddr},
|
|
||||||
relayForByAddr: map[netip.Addr]*Relay{},
|
|
||||||
relayForByIdx: map[uint32]*Relay{},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
l := test.NewLogger()
|
|
||||||
hm := newHostMap(l)
|
|
||||||
hm.Hosts[relayAddr] = relayHI
|
|
||||||
conn := &capturingConn{}
|
|
||||||
f := &Interface{
|
|
||||||
l: l,
|
|
||||||
hostMap: hm,
|
|
||||||
messageMetrics: &MessageMetrics{txExhausted: metrics.NewCounter()},
|
|
||||||
writers: []udp.Conn{conn},
|
|
||||||
}
|
|
||||||
f.connectionManager = &connectionManager{intf: f, relayUsed: map[uint32]struct{}{}, relayUsedLock: &sync.RWMutex{}}
|
|
||||||
|
|
||||||
payload := make([]byte, tt.n)
|
|
||||||
for i := range payload {
|
|
||||||
payload[i] = byte(i)
|
|
||||||
}
|
|
||||||
counter := ci.messageCounter.Load()
|
|
||||||
f.sendNoMetrics(header.Message, 0, ci, hostinfo, netip.AddrPort{}, payload, make([]byte, 12), make([]byte, mtu), 0)
|
|
||||||
|
|
||||||
if !tt.sent {
|
|
||||||
assert.Empty(t, conn.writes)
|
|
||||||
assert.Equal(t, counter, ci.messageCounter.Load(), "a dropped packet must not spend a counter")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
require.Len(t, conn.writes, 1)
|
|
||||||
assert.Equal(t, relayRemote, conn.addrs[0])
|
|
||||||
pkt := conn.writes[0]
|
|
||||||
|
|
||||||
// The relay authenticates the whole packet under its own header
|
|
||||||
outer := &header.H{}
|
|
||||||
require.NoError(t, outer.Parse(pkt))
|
|
||||||
assert.Equal(t, header.MessageRelay, outer.Subtype)
|
|
||||||
assert.Equal(t, relay.RemoteIndex, outer.RemoteIndex)
|
|
||||||
relayPeer, err := newConnectionStateFromResult(relayResp)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, relayPeer.VerifyRelay(l, outer.MessageCounter, pkt, make([]byte, 12)))
|
|
||||||
|
|
||||||
// Inside it, the target decrypts the end to end packet back to the payload
|
|
||||||
inner := pkt[header.Len : len(pkt)-relayPeer.dKey.Overhead()]
|
|
||||||
h := &header.H{}
|
|
||||||
require.NoError(t, h.Parse(inner))
|
|
||||||
assert.Equal(t, header.Message, h.Type)
|
|
||||||
assert.Equal(t, hostinfo.remoteIndexId, h.RemoteIndex)
|
|
||||||
targetPeer, err := newConnectionStateFromResult(targetResp)
|
|
||||||
require.NoError(t, err)
|
|
||||||
got, err := targetPeer.Decrypt(l, h.MessageCounter, inner, make([]byte, 12))
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Equal(t, payload, got)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestNewConnectionStateFromResult(t *testing.T) {
|
func TestNewConnectionStateFromResult(t *testing.T) {
|
||||||
initR, respR := runTestHandshake(t)
|
initR, respR := runTestHandshake(t)
|
||||||
|
|
||||||
|
|||||||
+8
-4
@@ -265,7 +265,6 @@ tun:
|
|||||||
# Sets the transmit queue length, if you notice lots of transmit drops on the tun it may help to raise this number. Default is 500
|
# Sets the transmit queue length, if you notice lots of transmit drops on the tun it may help to raise this number. Default is 500
|
||||||
tx_queue: 500
|
tx_queue: 500
|
||||||
# Default MTU for every packet, safe setting is (and the default) 1300 for internet based traffic
|
# Default MTU for every packet, safe setting is (and the default) 1300 for internet based traffic
|
||||||
# Anything above 8937, here or on a route below, is capped to 8937 with a warning
|
|
||||||
mtu: 1300
|
mtu: 1300
|
||||||
|
|
||||||
# the use_offloads setting controls if Nebula will attempt to enable GSO and GRO for the tun device. Linux only, not reloadable.
|
# the use_offloads setting controls if Nebula will attempt to enable GSO and GRO for the tun device. Linux only, not reloadable.
|
||||||
@@ -411,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, drops are recorded in the lighthouse.query.dropped metric.
|
# query_buffer is the size of the buffer channel for querying lighthouses
|
||||||
#query_buffer: 1024
|
#query_buffer: 64
|
||||||
|
|
||||||
# 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
|
||||||
@@ -450,7 +449,9 @@ firewall:
|
|||||||
#default_local_cidr_any: false
|
#default_local_cidr_any: false
|
||||||
|
|
||||||
conntrack:
|
conntrack:
|
||||||
|
# tcp_timeout also applies to sctp and dccp
|
||||||
tcp_timeout: 12m
|
tcp_timeout: 12m
|
||||||
|
# udp_timeout also applies to udplite
|
||||||
udp_timeout: 3m
|
udp_timeout: 3m
|
||||||
default_timeout: 10m
|
default_timeout: 10m
|
||||||
|
|
||||||
@@ -458,8 +459,11 @@ firewall:
|
|||||||
# Rules are comprised of a protocol, port, and one or more of host, group, or CIDR
|
# Rules are comprised of a protocol, port, and one or more of host, group, or CIDR
|
||||||
# Logical evaluation is roughly: port AND proto AND (ca_sha OR ca_name) AND (host OR group OR groups OR cidr) AND (local cidr)
|
# Logical evaluation is roughly: port AND proto AND (ca_sha OR ca_name) AND (host OR group OR groups OR cidr) AND (local cidr)
|
||||||
# - port: Takes `0` or `any` as any, a single number `80`, a range `200-901`, or `fragment` to match second and further fragments of fragmented packets (since there is no port available).
|
# - port: Takes `0` or `any` as any, a single number `80`, a range `200-901`, or `fragment` to match second and further fragments of fragmented packets (since there is no port available).
|
||||||
# proto: `any`, `tcp`, `udp`, or `icmp`
|
# proto: `any`, `tcp`, `udp`, `udplite`, `dccp`, `sctp`, `icmp`, or any other IP protocol number from 1 to 255, ie `47` for gre
|
||||||
# a port specification is ignored if proto is `icmp`
|
# a port specification is ignored if proto is `icmp`
|
||||||
|
# `icmp`, `1`, and `58` are the same, each matches both ICMP and ICMPv6
|
||||||
|
# Nebula only reads ports from tcp, udp, udplite, dccp, and sctp, so a proto `any` rule with a specific port or range only matches those protocols.
|
||||||
|
# Rules for other protocols (gre, esp, etc) need port `any`.
|
||||||
# host: `any` or a literal hostname, ie `test-host`
|
# host: `any` or a literal hostname, ie `test-host`
|
||||||
# group: `any` or a literal group name, ie `default-group`
|
# group: `any` or a literal group name, ie `default-group`
|
||||||
# groups: Same as group but accepts a list of values. Multiple values are AND'd together and a certificate would have to contain all groups to pass
|
# groups: Same as group but accepts a list of values. Multiple values are AND'd together and a certificate would have to contain all groups to pass
|
||||||
|
|||||||
+36
-755
@@ -2,17 +2,10 @@ package nebula
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"crypto/sha256"
|
|
||||||
"encoding/hex"
|
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
|
||||||
"hash/fnv"
|
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"reflect"
|
|
||||||
"slices"
|
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -24,10 +17,6 @@ import (
|
|||||||
"github.com/slackhq/nebula/iputil"
|
"github.com/slackhq/nebula/iputil"
|
||||||
)
|
)
|
||||||
|
|
||||||
type FirewallInterface interface {
|
|
||||||
AddRule(incoming bool, proto uint8, startPort int32, endPort int32, groups []string, host string, cidr, localCidr string, caName string, caSha string) error
|
|
||||||
}
|
|
||||||
|
|
||||||
type conn struct {
|
type conn struct {
|
||||||
Expires time.Time // Time when this conntrack entry will expire
|
Expires time.Time // Time when this conntrack entry will expire
|
||||||
|
|
||||||
@@ -42,8 +31,7 @@ type conn struct {
|
|||||||
type Firewall struct {
|
type Firewall struct {
|
||||||
Conntrack *FirewallConntrack
|
Conntrack *FirewallConntrack
|
||||||
|
|
||||||
InRules *FirewallTable
|
rules firewall.Rules
|
||||||
OutRules *FirewallTable
|
|
||||||
|
|
||||||
InboundSendReject bool
|
InboundSendReject bool
|
||||||
OutboundSendReject bool
|
OutboundSendReject bool
|
||||||
@@ -63,10 +51,8 @@ type Firewall struct {
|
|||||||
// unsafeNetworks is the list of unsafe networks issued to us in the certificate
|
// unsafeNetworks is the list of unsafe networks issued to us in the certificate
|
||||||
unsafeNetworks []netip.Prefix
|
unsafeNetworks []netip.Prefix
|
||||||
|
|
||||||
rules string
|
|
||||||
rulesVersion uint16
|
rulesVersion uint16
|
||||||
|
|
||||||
defaultLocalCIDRAny bool
|
|
||||||
incomingMetrics firewallMetrics
|
incomingMetrics firewallMetrics
|
||||||
outgoingMetrics firewallMetrics
|
outgoingMetrics firewallMetrics
|
||||||
|
|
||||||
@@ -86,52 +72,6 @@ type FirewallConntrack struct {
|
|||||||
TimerWheel *TimerWheel[firewall.Packet]
|
TimerWheel *TimerWheel[firewall.Packet]
|
||||||
}
|
}
|
||||||
|
|
||||||
// FirewallTable is the entry point for a rule, the evaluation order is:
|
|
||||||
// Proto AND port AND (CA SHA or CA name) AND local CIDR AND (group OR groups OR name OR remote CIDR)
|
|
||||||
type FirewallTable struct {
|
|
||||||
TCP firewallPort
|
|
||||||
UDP firewallPort
|
|
||||||
ICMP firewallPort
|
|
||||||
AnyProto firewallPort
|
|
||||||
}
|
|
||||||
|
|
||||||
func newFirewallTable() *FirewallTable {
|
|
||||||
return &FirewallTable{
|
|
||||||
TCP: firewallPort{},
|
|
||||||
UDP: firewallPort{},
|
|
||||||
ICMP: firewallPort{},
|
|
||||||
AnyProto: firewallPort{},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type FirewallCA struct {
|
|
||||||
Any *FirewallRule
|
|
||||||
CANames map[string]*FirewallRule
|
|
||||||
CAShas map[string]*FirewallRule
|
|
||||||
}
|
|
||||||
|
|
||||||
type FirewallRule struct {
|
|
||||||
// Any makes Hosts, Groups, and CIDR irrelevant
|
|
||||||
Any *firewallLocalCIDR
|
|
||||||
Hosts map[string]*firewallLocalCIDR
|
|
||||||
Groups []*firewallGroups
|
|
||||||
CIDR *bart.Table[*firewallLocalCIDR]
|
|
||||||
}
|
|
||||||
|
|
||||||
type firewallGroups struct {
|
|
||||||
Groups []string
|
|
||||||
LocalCIDR *firewallLocalCIDR
|
|
||||||
}
|
|
||||||
|
|
||||||
// Even though ports are uint16, int32 maps are faster for lookup
|
|
||||||
// Plus we can use `-1` for fragment rules
|
|
||||||
type firewallPort map[int32]*FirewallCA
|
|
||||||
|
|
||||||
type firewallLocalCIDR struct {
|
|
||||||
Any bool
|
|
||||||
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. A TimerWheel is created for you from the provided timeouts.
|
||||||
// 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 {
|
||||||
@@ -170,8 +110,8 @@ func NewFirewall(l *slog.Logger, tcpTimeout, UDPTimeout, defaultTimeout time.Dur
|
|||||||
Conns: make(map[firewall.Packet]*conn),
|
Conns: make(map[firewall.Packet]*conn),
|
||||||
TimerWheel: NewTimerWheel[firewall.Packet](tmin, tmax),
|
TimerWheel: NewTimerWheel[firewall.Packet](tmin, tmax),
|
||||||
},
|
},
|
||||||
InRules: newFirewallTable(),
|
// Nothing is allowed until there are rules
|
||||||
OutRules: newFirewallTable(),
|
rules: firewall.NewRulesBuilder(l).Build(assignedNetworks, unsafeNetworks),
|
||||||
TCPTimeout: tcpTimeout,
|
TCPTimeout: tcpTimeout,
|
||||||
UDPTimeout: UDPTimeout,
|
UDPTimeout: UDPTimeout,
|
||||||
DefaultTimeout: defaultTimeout,
|
DefaultTimeout: defaultTimeout,
|
||||||
@@ -212,8 +152,6 @@ func NewFirewallFromConfig(l *slog.Logger, cs *CertState, c *config.C) (*Firewal
|
|||||||
//TODO: max_connections
|
//TODO: max_connections
|
||||||
)
|
)
|
||||||
|
|
||||||
fw.defaultLocalCIDRAny = c.GetBool("firewall.default_local_cidr_any", false)
|
|
||||||
|
|
||||||
inboundAction := c.GetString("firewall.inbound_action", "drop")
|
inboundAction := c.GetString("firewall.inbound_action", "drop")
|
||||||
switch inboundAction {
|
switch inboundAction {
|
||||||
case "reject":
|
case "reject":
|
||||||
@@ -236,80 +174,23 @@ func NewFirewallFromConfig(l *slog.Logger, cs *CertState, c *config.C) (*Firewal
|
|||||||
fw.OutboundSendReject = false
|
fw.OutboundSendReject = false
|
||||||
}
|
}
|
||||||
|
|
||||||
err := AddFirewallRulesFromConfig(l, false, c, fw)
|
rules, err := firewall.RulesFromConfig(l, c, fw.assignedNetworks, fw.unsafeNetworks)
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
err = AddFirewallRulesFromConfig(l, true, c, fw)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
fw.rules = rules
|
||||||
|
|
||||||
return fw, nil
|
return fw, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// AddRule properly creates the in memory rule structure for a firewall table.
|
|
||||||
func (f *Firewall) AddRule(incoming bool, proto uint8, startPort int32, endPort int32, groups []string, host string, cidr, localCidr, caName string, caSha string) error {
|
|
||||||
var (
|
|
||||||
ft *FirewallTable
|
|
||||||
fp firewallPort
|
|
||||||
)
|
|
||||||
|
|
||||||
if incoming {
|
|
||||||
ft = f.InRules
|
|
||||||
} else {
|
|
||||||
ft = f.OutRules
|
|
||||||
}
|
|
||||||
|
|
||||||
switch proto {
|
|
||||||
case iputil.IPProtocolTCP:
|
|
||||||
fp = ft.TCP
|
|
||||||
case iputil.IPProtocolUDP:
|
|
||||||
fp = ft.UDP
|
|
||||||
case iputil.IPProtocolICMP, iputil.IPProtocolICMPv6:
|
|
||||||
//ICMP traffic doesn't have ports, so we always coerce to "any", even if a value is provided
|
|
||||||
if startPort != firewall.PortAny {
|
|
||||||
f.l.Warn("ignoring port specification for ICMP firewall rule", "startPort", startPort)
|
|
||||||
}
|
|
||||||
startPort = firewall.PortAny
|
|
||||||
endPort = firewall.PortAny
|
|
||||||
fp = ft.ICMP
|
|
||||||
case firewall.ProtoAny:
|
|
||||||
fp = ft.AnyProto
|
|
||||||
default:
|
|
||||||
return fmt.Errorf("unknown protocol %v", proto)
|
|
||||||
}
|
|
||||||
|
|
||||||
// We need this rule string because we generate a hash. Removing this will break firewall reload.
|
|
||||||
ruleString := fmt.Sprintf(
|
|
||||||
"incoming: %v, proto: %v, startPort: %v, endPort: %v, groups: %v, host: %v, ip: %v, localIp: %v, caName: %v, caSha: %s",
|
|
||||||
incoming, proto, startPort, endPort, groups, host, cidr, localCidr, caName, caSha,
|
|
||||||
)
|
|
||||||
f.rules += ruleString + "\n"
|
|
||||||
|
|
||||||
direction := "incoming"
|
|
||||||
if !incoming {
|
|
||||||
direction = "outgoing"
|
|
||||||
}
|
|
||||||
f.l.Info("Firewall rule added",
|
|
||||||
"firewallRule", m{"direction": direction, "proto": proto, "startPort": startPort, "endPort": endPort, "groups": groups, "host": host, "cidr": cidr, "localCidr": localCidr, "caName": caName, "caSha": caSha},
|
|
||||||
)
|
|
||||||
|
|
||||||
return fp.addRule(f, startPort, endPort, groups, host, cidr, localCidr, caName, caSha)
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetRuleHash returns a hash representation of all inbound and outbound rules
|
// GetRuleHash returns a hash representation of all inbound and outbound rules
|
||||||
func (f *Firewall) GetRuleHash() string {
|
func (f *Firewall) GetRuleHash() string {
|
||||||
sum := sha256.Sum256([]byte(f.rules))
|
return f.rules.Hash
|
||||||
return hex.EncodeToString(sum[:])
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetRuleHashFNV returns a uint32 FNV-1 hash representation the rules, for use as a metric value
|
// GetRuleHashFNV returns a uint32 FNV-1 hash representation the rules, for use as a metric value
|
||||||
func (f *Firewall) GetRuleHashFNV() uint32 {
|
func (f *Firewall) GetRuleHashFNV() uint32 {
|
||||||
h := fnv.New32a()
|
return f.rules.HashFNV
|
||||||
h.Write([]byte(f.rules))
|
|
||||||
return h.Sum32()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetRuleHashes returns both the sha256 and FNV-1 hashes, suitable for logging
|
// GetRuleHashes returns both the sha256 and FNV-1 hashes, suitable for logging
|
||||||
@@ -317,104 +198,6 @@ func (f *Firewall) GetRuleHashes() string {
|
|||||||
return "SHA:" + f.GetRuleHash() + ",FNV:" + strconv.FormatUint(uint64(f.GetRuleHashFNV()), 10)
|
return "SHA:" + f.GetRuleHash() + ",FNV:" + strconv.FormatUint(uint64(f.GetRuleHashFNV()), 10)
|
||||||
}
|
}
|
||||||
|
|
||||||
func AddFirewallRulesFromConfig(l *slog.Logger, inbound bool, c *config.C, fw FirewallInterface) error {
|
|
||||||
var table string
|
|
||||||
if inbound {
|
|
||||||
table = "firewall.inbound"
|
|
||||||
} else {
|
|
||||||
table = "firewall.outbound"
|
|
||||||
}
|
|
||||||
|
|
||||||
r := c.Get(table)
|
|
||||||
if r == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
rs, ok := r.([]any)
|
|
||||||
if !ok {
|
|
||||||
return fmt.Errorf("%s failed to parse, should be an array of rules", table)
|
|
||||||
}
|
|
||||||
|
|
||||||
for i, t := range rs {
|
|
||||||
r, err := convertRule(l, t, table, i)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("%s rule #%v; %s", table, i, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.Code != "" && r.Port != "" {
|
|
||||||
return fmt.Errorf("%s rule #%v; only one of port or code should be provided", table, i)
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.Host == "" && len(r.Groups) == 0 && r.Cidr == "" && r.LocalCidr == "" && r.CAName == "" && r.CASha == "" {
|
|
||||||
return fmt.Errorf("%s rule #%v; at least one of host, group, cidr, local_cidr, ca_name, or ca_sha must be provided", table, i)
|
|
||||||
}
|
|
||||||
|
|
||||||
var sPort, errPort string
|
|
||||||
if r.Code != "" {
|
|
||||||
errPort = "code"
|
|
||||||
sPort = r.Code
|
|
||||||
} else {
|
|
||||||
errPort = "port"
|
|
||||||
sPort = r.Port
|
|
||||||
}
|
|
||||||
|
|
||||||
var proto uint8
|
|
||||||
var startPort, endPort int32
|
|
||||||
switch r.Proto {
|
|
||||||
case "any":
|
|
||||||
proto = firewall.ProtoAny
|
|
||||||
startPort, endPort, err = parsePort(sPort)
|
|
||||||
case "tcp":
|
|
||||||
proto = iputil.IPProtocolTCP
|
|
||||||
startPort, endPort, err = parsePort(sPort)
|
|
||||||
case "udp":
|
|
||||||
proto = iputil.IPProtocolUDP
|
|
||||||
startPort, endPort, err = parsePort(sPort)
|
|
||||||
case "icmp":
|
|
||||||
proto = iputil.IPProtocolICMP
|
|
||||||
startPort = firewall.PortAny
|
|
||||||
endPort = firewall.PortAny
|
|
||||||
if sPort != "" {
|
|
||||||
l.Warn("ignoring port specification for ICMP firewall rule", "port", sPort)
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
return fmt.Errorf("%s rule #%v; proto was not understood; `%s`", table, i, r.Proto)
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("%s rule #%v; %s %s", table, i, errPort, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.Cidr != "" && r.Cidr != "any" {
|
|
||||||
_, err = netip.ParsePrefix(r.Cidr)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("%s rule #%v; cidr did not parse; %s", table, i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.LocalCidr != "" && r.LocalCidr != "any" {
|
|
||||||
_, err = netip.ParsePrefix(r.LocalCidr)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("%s rule #%v; local_cidr did not parse; %s", table, i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if warning := r.sanity(); warning != nil {
|
|
||||||
l.Warn("firewall rule sanity check",
|
|
||||||
"table", table,
|
|
||||||
"rule", i,
|
|
||||||
"warning", warning,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = fw.AddRule(inbound, proto, startPort, endPort, r.Groups, r.Host, r.Cidr, r.LocalCidr, r.CAName, r.CASha)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("%s rule #%v; `%s`", table, i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
var ErrUnknownNetworkType = errors.New("unknown network type")
|
var ErrUnknownNetworkType = errors.New("unknown network type")
|
||||||
var ErrPeerRejected = errors.New("remote address is not within a network that we handle")
|
var ErrPeerRejected = errors.New("remote address is not within a network that we handle")
|
||||||
var ErrInvalidRemoteIP = errors.New("remote address is not in remote certificate networks")
|
var ErrInvalidRemoteIP = errors.New("remote address is not in remote certificate networks")
|
||||||
@@ -458,23 +241,17 @@ 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, localCache) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
table := f.OutRules
|
if !f.rules.Match(&fp, incoming, h.ConnectionState.peerCert, caPool) {
|
||||||
if incoming {
|
|
||||||
table = f.InRules
|
|
||||||
}
|
|
||||||
|
|
||||||
// We now know which firewall table to check against
|
|
||||||
if !table.match(fp, incoming, h.ConnectionState.peerCert, caPool) {
|
|
||||||
f.metrics(incoming).droppedNoRule.Inc(1)
|
f.metrics(incoming).droppedNoRule.Inc(1)
|
||||||
return ErrNoMatchingRule
|
return ErrNoMatchingRule
|
||||||
}
|
}
|
||||||
|
|
||||||
// We always want to conntrack since it is a faster operation
|
// We always want to conntrack since it is a faster operation
|
||||||
f.addConn(fp, incoming)
|
f.addConn(&fp, incoming)
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -503,9 +280,9 @@ func (f *Firewall) EmitStats() {
|
|||||||
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, localCache firewall.ConntrackCache) bool {
|
||||||
if localCache != nil {
|
if localCache != nil {
|
||||||
if _, ok := localCache[fp]; ok {
|
if _, ok := localCache[*fp]; ok {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -518,7 +295,7 @@ func (f *Firewall) inConns(fp firewall.Packet, h *HostInfo, caPool *cert.CAPool,
|
|||||||
f.evict(ep)
|
f.evict(ep)
|
||||||
}
|
}
|
||||||
|
|
||||||
c, ok := conntrack.Conns[fp]
|
c, ok := conntrack.Conns[*fp]
|
||||||
|
|
||||||
if !ok {
|
if !ok {
|
||||||
conntrack.Unlock()
|
conntrack.Unlock()
|
||||||
@@ -528,29 +305,23 @@ func (f *Firewall) inConns(fp firewall.Packet, h *HostInfo, caPool *cert.CAPool,
|
|||||||
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
|
||||||
// it still passes with the current rule set
|
// it still passes with the current rule set
|
||||||
table := f.OutRules
|
if !f.rules.Match(fp, c.incoming, h.ConnectionState.peerCert, caPool) {
|
||||||
if c.incoming {
|
|
||||||
table = f.InRules
|
|
||||||
}
|
|
||||||
|
|
||||||
// We now know which firewall table to check against
|
|
||||||
if !table.match(fp, c.incoming, h.ConnectionState.peerCert, caPool) {
|
|
||||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||||
h.logger(f.l).Debug("dropping old conntrack entry, does not match new ruleset",
|
h.logger(f.l).Debug("dropping old conntrack entry, does not match new ruleset",
|
||||||
"fwPacket", fp,
|
"fwPacket", *fp,
|
||||||
"incoming", c.incoming,
|
"incoming", c.incoming,
|
||||||
"rulesVersion", f.rulesVersion,
|
"rulesVersion", f.rulesVersion,
|
||||||
"oldRulesVersion", c.rulesVersion,
|
"oldRulesVersion", c.rulesVersion,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
delete(conntrack.Conns, fp)
|
delete(conntrack.Conns, *fp)
|
||||||
conntrack.Unlock()
|
conntrack.Unlock()
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||||
h.logger(f.l).Debug("keeping old conntrack entry, does match new ruleset",
|
h.logger(f.l).Debug("keeping old conntrack entry, does match new ruleset",
|
||||||
"fwPacket", fp,
|
"fwPacket", *fp,
|
||||||
"incoming", c.incoming,
|
"incoming", c.incoming,
|
||||||
"rulesVersion", f.rulesVersion,
|
"rulesVersion", f.rulesVersion,
|
||||||
"oldRulesVersion", c.rulesVersion,
|
"oldRulesVersion", c.rulesVersion,
|
||||||
@@ -560,42 +331,39 @@ func (f *Firewall) inConns(fp firewall.Packet, h *HostInfo, caPool *cert.CAPool,
|
|||||||
c.rulesVersion = f.rulesVersion
|
c.rulesVersion = f.rulesVersion
|
||||||
}
|
}
|
||||||
|
|
||||||
switch fp.Protocol {
|
c.Expires = time.Now().Add(f.conntrackTimeout(fp.Protocol))
|
||||||
case iputil.IPProtocolTCP:
|
|
||||||
c.Expires = time.Now().Add(f.TCPTimeout)
|
|
||||||
case iputil.IPProtocolUDP:
|
|
||||||
c.Expires = time.Now().Add(f.UDPTimeout)
|
|
||||||
default:
|
|
||||||
c.Expires = time.Now().Add(f.DefaultTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
conntrack.Unlock()
|
conntrack.Unlock()
|
||||||
|
|
||||||
if localCache != nil {
|
if localCache != nil {
|
||||||
localCache[fp] = struct{}{}
|
localCache[*fp] = struct{}{}
|
||||||
}
|
}
|
||||||
|
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *Firewall) addConn(fp firewall.Packet, incoming bool) {
|
// conntrackTimeout returns how long a conntrack entry for proto lives without traffic.
|
||||||
var timeout time.Duration
|
// Connection oriented protocols share the tcp timeout, datagram protocols share the udp timeout.
|
||||||
c := &conn{}
|
func (f *Firewall) conntrackTimeout(proto uint8) time.Duration {
|
||||||
|
switch proto {
|
||||||
switch fp.Protocol {
|
case iputil.IPProtocolTCP, iputil.IPProtocolSCTP, iputil.IPProtocolDCCP:
|
||||||
case iputil.IPProtocolTCP:
|
return f.TCPTimeout
|
||||||
timeout = f.TCPTimeout
|
case iputil.IPProtocolUDP, iputil.IPProtocolUDPLite:
|
||||||
case iputil.IPProtocolUDP:
|
return f.UDPTimeout
|
||||||
timeout = f.UDPTimeout
|
|
||||||
default:
|
default:
|
||||||
timeout = f.DefaultTimeout
|
return f.DefaultTimeout
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *Firewall) addConn(fp *firewall.Packet, incoming bool) {
|
||||||
|
timeout := f.conntrackTimeout(fp.Protocol)
|
||||||
|
c := &conn{}
|
||||||
|
|
||||||
conntrack := f.Conntrack
|
conntrack := f.Conntrack
|
||||||
conntrack.Lock()
|
conntrack.Lock()
|
||||||
if _, ok := conntrack.Conns[fp]; !ok {
|
if _, ok := conntrack.Conns[*fp]; !ok {
|
||||||
conntrack.TimerWheel.Advance(time.Now())
|
conntrack.TimerWheel.Advance(time.Now())
|
||||||
conntrack.TimerWheel.Add(fp, timeout)
|
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
|
||||||
@@ -603,7 +371,7 @@ func (f *Firewall) addConn(fp firewall.Packet, incoming bool) {
|
|||||||
c.incoming = incoming
|
c.incoming = incoming
|
||||||
c.rulesVersion = f.rulesVersion
|
c.rulesVersion = f.rulesVersion
|
||||||
c.Expires = time.Now().Add(timeout)
|
c.Expires = time.Now().Add(timeout)
|
||||||
conntrack.Conns[fp] = c
|
conntrack.Conns[*fp] = c
|
||||||
conntrack.Unlock()
|
conntrack.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -629,490 +397,3 @@ func (f *Firewall) evict(p firewall.Packet) {
|
|||||||
// This conn is done
|
// This conn is done
|
||||||
delete(conntrack.Conns, p)
|
delete(conntrack.Conns, p)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ft *FirewallTable) match(p firewall.Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
|
||||||
if ft.AnyProto.match(p, incoming, c, caPool) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
switch p.Protocol {
|
|
||||||
case iputil.IPProtocolTCP:
|
|
||||||
if ft.TCP.match(p, incoming, c, caPool) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
case iputil.IPProtocolUDP:
|
|
||||||
if ft.UDP.match(p, incoming, c, caPool) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
case iputil.IPProtocolICMP, iputil.IPProtocolICMPv6:
|
|
||||||
if ft.ICMP.match(p, incoming, c, caPool) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
func (fp firewallPort) addRule(f *Firewall, startPort int32, endPort int32, groups []string, host string, cidr, localCidr, caName string, caSha string) error {
|
|
||||||
if startPort > endPort {
|
|
||||||
return fmt.Errorf("start port was lower than end port")
|
|
||||||
}
|
|
||||||
|
|
||||||
for i := startPort; i <= endPort; i++ {
|
|
||||||
if _, ok := fp[i]; !ok {
|
|
||||||
fp[i] = &FirewallCA{
|
|
||||||
CANames: make(map[string]*FirewallRule),
|
|
||||||
CAShas: make(map[string]*FirewallRule),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := fp[i].addRule(f, groups, host, cidr, localCidr, caName, caSha); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (fp firewallPort) match(p firewall.Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
|
||||||
// We don't have any allowed ports, bail
|
|
||||||
if fp == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// this branch is here to catch traffic from FirewallTable.Any.match and FirewallTable.ICMP.match
|
|
||||||
if p.Protocol == iputil.IPProtocolICMP || p.Protocol == iputil.IPProtocolICMPv6 {
|
|
||||||
// port numbers are re-used for connection tracking of ICMP,
|
|
||||||
// but we don't want to actually filter on them.
|
|
||||||
return fp[firewall.PortAny].match(p, c, caPool)
|
|
||||||
}
|
|
||||||
|
|
||||||
var port int32
|
|
||||||
|
|
||||||
if p.Fragment {
|
|
||||||
port = firewall.PortFragment
|
|
||||||
} else if incoming {
|
|
||||||
port = int32(p.LocalPort)
|
|
||||||
} else {
|
|
||||||
port = int32(p.RemotePort)
|
|
||||||
}
|
|
||||||
|
|
||||||
if fp[port].match(p, c, caPool) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
return fp[firewall.PortAny].match(p, c, caPool)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (fc *FirewallCA) addRule(f *Firewall, groups []string, host string, cidr, localCidr, caName, caSha string) error {
|
|
||||||
fr := func() *FirewallRule {
|
|
||||||
return &FirewallRule{
|
|
||||||
Hosts: make(map[string]*firewallLocalCIDR),
|
|
||||||
Groups: make([]*firewallGroups, 0),
|
|
||||||
CIDR: new(bart.Table[*firewallLocalCIDR]),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if caSha == "" && caName == "" {
|
|
||||||
if fc.Any == nil {
|
|
||||||
fc.Any = fr()
|
|
||||||
}
|
|
||||||
|
|
||||||
return fc.Any.addRule(f, groups, host, cidr, localCidr)
|
|
||||||
}
|
|
||||||
|
|
||||||
if caSha != "" {
|
|
||||||
if _, ok := fc.CAShas[caSha]; !ok {
|
|
||||||
fc.CAShas[caSha] = fr()
|
|
||||||
}
|
|
||||||
err := fc.CAShas[caSha].addRule(f, groups, host, cidr, localCidr)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if caName != "" {
|
|
||||||
if _, ok := fc.CANames[caName]; !ok {
|
|
||||||
fc.CANames[caName] = fr()
|
|
||||||
}
|
|
||||||
err := fc.CANames[caName].addRule(f, groups, host, cidr, localCidr)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (fc *FirewallCA) match(p firewall.Packet, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
|
||||||
if fc == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if fc.Any.match(p, c) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
if t, ok := fc.CAShas[c.Certificate.Issuer()]; ok {
|
|
||||||
if t.match(p, c) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
s, err := caPool.GetCAForCert(c.Certificate)
|
|
||||||
if err != nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
return fc.CANames[s.Certificate.Name()].match(p, c)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (fr *FirewallRule) addRule(f *Firewall, groups []string, host, cidr, localCidr string) error {
|
|
||||||
flc := func() *firewallLocalCIDR {
|
|
||||||
return &firewallLocalCIDR{
|
|
||||||
LocalCIDR: new(bart.Lite),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if fr.isAny(groups, host, cidr) {
|
|
||||||
if fr.Any == nil {
|
|
||||||
fr.Any = flc()
|
|
||||||
}
|
|
||||||
|
|
||||||
return fr.Any.addRule(f, localCidr)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(groups) > 0 {
|
|
||||||
nlc := flc()
|
|
||||||
err := nlc.addRule(f, localCidr)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
fr.Groups = append(fr.Groups, &firewallGroups{
|
|
||||||
Groups: groups,
|
|
||||||
LocalCIDR: nlc,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
if host != "" {
|
|
||||||
nlc := fr.Hosts[host]
|
|
||||||
if nlc == nil {
|
|
||||||
nlc = flc()
|
|
||||||
}
|
|
||||||
err := nlc.addRule(f, localCidr)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
fr.Hosts[host] = nlc
|
|
||||||
}
|
|
||||||
|
|
||||||
if cidr != "" {
|
|
||||||
c, err := netip.ParsePrefix(cidr)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
nlc, _ := fr.CIDR.Get(c)
|
|
||||||
if nlc == nil {
|
|
||||||
nlc = flc()
|
|
||||||
}
|
|
||||||
err = nlc.addRule(f, localCidr)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
fr.CIDR.Insert(c, nlc)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (fr *FirewallRule) isAny(groups []string, host string, cidr string) bool {
|
|
||||||
if len(groups) == 0 && host == "" && cidr == "" {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
if slices.Contains(groups, "any") {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
if host == "any" {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
if cidr == "any" {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
func (fr *FirewallRule) match(p firewall.Packet, c *cert.CachedCertificate) bool {
|
|
||||||
if fr == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// Shortcut path for if groups, hosts, or cidr contained an `any`
|
|
||||||
if fr.Any.match(p, c) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Need any of group, host, or cidr to match
|
|
||||||
for _, sg := range fr.Groups {
|
|
||||||
found := false
|
|
||||||
|
|
||||||
for _, g := range sg.Groups {
|
|
||||||
if _, ok := c.InvertedGroups[g]; !ok {
|
|
||||||
found = false
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
found = true
|
|
||||||
}
|
|
||||||
|
|
||||||
if found && sg.LocalCIDR.match(p, c) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if fr.Hosts != nil {
|
|
||||||
if flc, ok := fr.Hosts[c.Certificate.Name()]; ok {
|
|
||||||
if flc.match(p, c) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, v := range fr.CIDR.Supernets(netip.PrefixFrom(p.RemoteAddr, p.RemoteAddr.BitLen())) {
|
|
||||||
if v.match(p, c) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
func (flc *firewallLocalCIDR) addRule(f *Firewall, localCidr string) error {
|
|
||||||
if localCidr == "any" {
|
|
||||||
flc.Any = true
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if localCidr == "" {
|
|
||||||
if len(f.unsafeNetworks) == 0 || f.defaultLocalCIDRAny {
|
|
||||||
flc.Any = true
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, network := range f.assignedNetworks {
|
|
||||||
flc.LocalCIDR.Insert(network)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
c, err := netip.ParsePrefix(localCidr)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
flc.LocalCIDR.Insert(c)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (flc *firewallLocalCIDR) match(p firewall.Packet, c *cert.CachedCertificate) bool {
|
|
||||||
if flc == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if flc.Any {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
return flc.LocalCIDR.Contains(p.LocalAddr)
|
|
||||||
}
|
|
||||||
|
|
||||||
type rule struct {
|
|
||||||
Port string
|
|
||||||
Code string
|
|
||||||
Proto string
|
|
||||||
Host string
|
|
||||||
Groups []string
|
|
||||||
Cidr string
|
|
||||||
LocalCidr string
|
|
||||||
CAName string
|
|
||||||
CASha string
|
|
||||||
}
|
|
||||||
|
|
||||||
func convertRule(l *slog.Logger, p any, table string, i int) (rule, error) {
|
|
||||||
r := rule{}
|
|
||||||
|
|
||||||
m, ok := p.(map[string]any)
|
|
||||||
if !ok {
|
|
||||||
return r, errors.New("could not parse rule")
|
|
||||||
}
|
|
||||||
|
|
||||||
toString := func(k string, m map[string]any) string {
|
|
||||||
v, ok := m[k]
|
|
||||||
if !ok {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
return fmt.Sprintf("%v", v)
|
|
||||||
}
|
|
||||||
|
|
||||||
r.Port = toString("port", m)
|
|
||||||
r.Code = toString("code", m)
|
|
||||||
r.Proto = toString("proto", m)
|
|
||||||
r.Host = toString("host", m)
|
|
||||||
r.Cidr = toString("cidr", m)
|
|
||||||
r.LocalCidr = toString("local_cidr", m)
|
|
||||||
r.CAName = toString("ca_name", m)
|
|
||||||
r.CASha = toString("ca_sha", m)
|
|
||||||
|
|
||||||
// Make sure group isn't an array
|
|
||||||
if v, ok := m["group"].([]any); ok {
|
|
||||||
if len(v) > 1 {
|
|
||||||
return r, errors.New("group should contain a single value, an array with more than one entry was provided")
|
|
||||||
}
|
|
||||||
|
|
||||||
l.Warn("group was an array with a single value, converting to simple value",
|
|
||||||
"table", table,
|
|
||||||
"rule", i,
|
|
||||||
)
|
|
||||||
m["group"] = v[0]
|
|
||||||
}
|
|
||||||
|
|
||||||
singleGroup := toString("group", m)
|
|
||||||
|
|
||||||
if rg, ok := m["groups"]; ok {
|
|
||||||
switch reflect.TypeOf(rg).Kind() {
|
|
||||||
case reflect.Slice:
|
|
||||||
v := reflect.ValueOf(rg)
|
|
||||||
r.Groups = make([]string, v.Len())
|
|
||||||
for i := 0; i < v.Len(); i++ {
|
|
||||||
r.Groups[i] = v.Index(i).Interface().(string)
|
|
||||||
}
|
|
||||||
case reflect.String:
|
|
||||||
r.Groups = []string{rg.(string)}
|
|
||||||
default:
|
|
||||||
r.Groups = []string{fmt.Sprintf("%v", rg)}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
//flatten group vs groups
|
|
||||||
if singleGroup != "" {
|
|
||||||
// Check if we have both groups and group provided in the rule config
|
|
||||||
if len(r.Groups) > 0 {
|
|
||||||
return r, fmt.Errorf("only one of group or groups should be defined, both provided")
|
|
||||||
}
|
|
||||||
r.Groups = []string{singleGroup}
|
|
||||||
}
|
|
||||||
|
|
||||||
return r, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// sanity returns an error if the rule would be evaluated in a way that would short-circuit a configured check on a wildcard value
|
|
||||||
// rules are evaluated as "port AND proto AND (ca_sha OR ca_name) AND (host OR group OR groups OR cidr) AND local_cidr"
|
|
||||||
func (r *rule) sanity() error {
|
|
||||||
//port, proto, local_cidr are AND, no need to check here
|
|
||||||
//ca_sha and ca_name don't have a wildcard value, no need to check here
|
|
||||||
groupsEmpty := len(r.Groups) == 0
|
|
||||||
hostEmpty := r.Host == ""
|
|
||||||
cidrEmpty := r.Cidr == ""
|
|
||||||
|
|
||||||
if (groupsEmpty && hostEmpty && cidrEmpty) == true {
|
|
||||||
return nil //no content!
|
|
||||||
}
|
|
||||||
|
|
||||||
groupsHasAny := slices.Contains(r.Groups, "any")
|
|
||||||
if groupsHasAny && len(r.Groups) > 1 {
|
|
||||||
return fmt.Errorf("groups spec [%s] contains the group '\"any\". This rule will ignore the other groups specified", r.Groups)
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.Host == "any" {
|
|
||||||
if !groupsEmpty {
|
|
||||||
return fmt.Errorf("groups specified as %s, but host=any will match any host, regardless of groups", r.Groups)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !cidrEmpty {
|
|
||||||
return fmt.Errorf("cidr specified as %s, but host=any will match any host, regardless of cidr", r.Cidr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if groupsHasAny {
|
|
||||||
if !hostEmpty && r.Host != "any" {
|
|
||||||
return fmt.Errorf("groups spec [%s] contains the group '\"any\". This rule will ignore the specified host %s", r.Groups, r.Host)
|
|
||||||
}
|
|
||||||
if !cidrEmpty {
|
|
||||||
return fmt.Errorf("groups spec [%s] contains the group '\"any\". This rule will ignore the specified cidr %s", r.Groups, r.Cidr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.Code != "" {
|
|
||||||
return fmt.Errorf("code specified as [%s]. Support for 'code' will be dropped in a future release, as it has never been functional", r.Code)
|
|
||||||
}
|
|
||||||
|
|
||||||
//todo alert on cidr-any
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parsePort(s string) (int32, int32, error) {
|
|
||||||
const notAPort int32 = -2
|
|
||||||
if s == "any" {
|
|
||||||
return firewall.PortAny, firewall.PortAny, nil
|
|
||||||
}
|
|
||||||
if s == "fragment" {
|
|
||||||
return firewall.PortFragment, firewall.PortFragment, nil
|
|
||||||
}
|
|
||||||
if !strings.Contains(s, `-`) {
|
|
||||||
rPort, err := parsePortValue("", s)
|
|
||||||
if err != nil {
|
|
||||||
return notAPort, notAPort, err
|
|
||||||
}
|
|
||||||
return rPort, rPort, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
sPorts := strings.SplitN(s, `-`, 2)
|
|
||||||
for i := range sPorts {
|
|
||||||
sPorts[i] = strings.Trim(sPorts[i], " ")
|
|
||||||
}
|
|
||||||
if len(sPorts) != 2 || sPorts[0] == "" || sPorts[1] == "" {
|
|
||||||
return notAPort, notAPort, fmt.Errorf("appears to be a range but could not be parsed; `%s`", s)
|
|
||||||
}
|
|
||||||
|
|
||||||
startPort, err := parsePortValue("beginning range ", sPorts[0])
|
|
||||||
if err != nil {
|
|
||||||
return notAPort, notAPort, err
|
|
||||||
}
|
|
||||||
|
|
||||||
endPort, err := parsePortValue("ending range ", sPorts[1])
|
|
||||||
if err != nil {
|
|
||||||
return notAPort, notAPort, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if startPort == firewall.PortAny {
|
|
||||||
endPort = firewall.PortAny
|
|
||||||
}
|
|
||||||
|
|
||||||
return startPort, endPort, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// parsePortValue accepts a base-10 decimal in [0, 65535] and returns it
|
|
||||||
// widened to int32. Using strconv.ParseUint with bitSize 16 rejects
|
|
||||||
// negative input, out-of-range input (>65535), and any non-decimal byte
|
|
||||||
// by construction, so the int32 widening that follows is provably safe
|
|
||||||
// and cannot collide with firewall.PortAny (0) or firewall.PortFragment
|
|
||||||
// (-1) via integer truncation.
|
|
||||||
//
|
|
||||||
// prefix is prepended to both error messages so callers can disambiguate
|
|
||||||
// the single-port path (prefix="") from the range bounds (prefix="beginning
|
|
||||||
// range " / "ending range "), preserving the historical error strings.
|
|
||||||
func parsePortValue(prefix, s string) (int32, error) {
|
|
||||||
n, err := strconv.ParseUint(s, 10, 16)
|
|
||||||
if err == nil {
|
|
||||||
return int32(n), nil
|
|
||||||
}
|
|
||||||
if errors.Is(err, strconv.ErrRange) {
|
|
||||||
return 0, fmt.Errorf("%sout of range [0,65535]; `%s`", prefix, s)
|
|
||||||
}
|
|
||||||
return 0, fmt.Errorf("%swas not a number; `%s`", prefix, s)
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,319 @@
|
|||||||
|
package firewall
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
|
"net/netip"
|
||||||
|
"reflect"
|
||||||
|
"slices"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/config"
|
||||||
|
"github.com/slackhq/nebula/iputil"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ruleAdder takes firewall rules, it lets tests see what addRulesFromConfig adds
|
||||||
|
type ruleAdder interface {
|
||||||
|
AddRule(incoming bool, proto uint8, startPort int32, endPort int32, groups []string, host string, cidr, localCidr string, caName string, caSha string) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// RulesFromConfig reads the inbound and outbound firewall rules from c and builds them, see RulesBuilder.Build
|
||||||
|
func RulesFromConfig(l *slog.Logger, c *config.C, vpnNetworks, unsafeNetworks []netip.Prefix) (Rules, error) {
|
||||||
|
b := NewRulesBuilder(l)
|
||||||
|
b.defaultLocalCIDRAny = c.GetBool("firewall.default_local_cidr_any", false)
|
||||||
|
|
||||||
|
if err := addRulesFromConfig(l, false, c, b); err != nil {
|
||||||
|
return Rules{}, err
|
||||||
|
}
|
||||||
|
if err := addRulesFromConfig(l, true, c, b); err != nil {
|
||||||
|
return Rules{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return b.Build(vpnNetworks, unsafeNetworks), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func addRulesFromConfig(l *slog.Logger, inbound bool, c *config.C, ra ruleAdder) error {
|
||||||
|
var table string
|
||||||
|
if inbound {
|
||||||
|
table = "firewall.inbound"
|
||||||
|
} else {
|
||||||
|
table = "firewall.outbound"
|
||||||
|
}
|
||||||
|
|
||||||
|
r := c.Get(table)
|
||||||
|
if r == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
rs, ok := r.([]any)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("%s failed to parse, should be an array of rules", table)
|
||||||
|
}
|
||||||
|
|
||||||
|
for i, t := range rs {
|
||||||
|
r, err := yamlToConfigRule(l, t, table, i)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s rule #%v; %s", table, i, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.Code != "" && r.Port != "" {
|
||||||
|
return fmt.Errorf("%s rule #%v; only one of port or code should be provided", table, i)
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.Host == "" && len(r.Groups) == 0 && r.Cidr == "" && r.LocalCidr == "" && r.CAName == "" && r.CASha == "" {
|
||||||
|
return fmt.Errorf("%s rule #%v; at least one of host, group, cidr, local_cidr, ca_name, or ca_sha must be provided", table, i)
|
||||||
|
}
|
||||||
|
|
||||||
|
var sPort, errPort string
|
||||||
|
if r.Code != "" {
|
||||||
|
errPort = "code"
|
||||||
|
sPort = r.Code
|
||||||
|
} else {
|
||||||
|
errPort = "port"
|
||||||
|
sPort = r.Port
|
||||||
|
}
|
||||||
|
|
||||||
|
var proto uint8
|
||||||
|
switch r.Proto {
|
||||||
|
case "any":
|
||||||
|
proto = ProtoAny
|
||||||
|
case "tcp":
|
||||||
|
proto = iputil.IPProtocolTCP
|
||||||
|
case "udp":
|
||||||
|
proto = iputil.IPProtocolUDP
|
||||||
|
case "udplite":
|
||||||
|
proto = iputil.IPProtocolUDPLite
|
||||||
|
case "dccp":
|
||||||
|
proto = iputil.IPProtocolDCCP
|
||||||
|
case "sctp":
|
||||||
|
proto = iputil.IPProtocolSCTP
|
||||||
|
case "icmp":
|
||||||
|
proto = iputil.IPProtocolICMP
|
||||||
|
default:
|
||||||
|
// Any other protocol by number. 0 is reserved for `any`.
|
||||||
|
n, perr := strconv.ParseUint(r.Proto, 10, 8)
|
||||||
|
if perr != nil || n == 0 {
|
||||||
|
return fmt.Errorf("%s rule #%v; proto was not understood; `%s`", table, i, r.Proto)
|
||||||
|
}
|
||||||
|
proto = uint8(n)
|
||||||
|
}
|
||||||
|
|
||||||
|
var startPort, endPort int32
|
||||||
|
if proto == iputil.IPProtocolICMP || proto == iputil.IPProtocolICMPv6 {
|
||||||
|
startPort = PortAny
|
||||||
|
endPort = PortAny
|
||||||
|
if sPort != "" {
|
||||||
|
l.Warn("ignoring port specification for ICMP firewall rule", "port", sPort)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
startPort, endPort, err = parsePort(sPort)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s rule #%v; %s %s", table, i, errPort, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if warning := r.sanity(); warning != nil {
|
||||||
|
l.Warn("firewall rule sanity check",
|
||||||
|
"table", table,
|
||||||
|
"rule", i,
|
||||||
|
"warning", warning,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = ra.AddRule(inbound, proto, startPort, endPort, r.Groups, r.Host, r.Cidr, r.LocalCidr, r.CAName, r.CASha)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s rule #%v; %s", table, i, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type configRule struct {
|
||||||
|
Port string
|
||||||
|
Code string
|
||||||
|
Proto string
|
||||||
|
Host string
|
||||||
|
Groups []string
|
||||||
|
Cidr string
|
||||||
|
LocalCidr string
|
||||||
|
CAName string
|
||||||
|
CASha string
|
||||||
|
}
|
||||||
|
|
||||||
|
func yamlToConfigRule(l *slog.Logger, p any, table string, i int) (configRule, error) {
|
||||||
|
r := configRule{}
|
||||||
|
|
||||||
|
m, ok := p.(map[string]any)
|
||||||
|
if !ok {
|
||||||
|
return r, errors.New("could not parse rule")
|
||||||
|
}
|
||||||
|
|
||||||
|
toString := func(k string, m map[string]any) string {
|
||||||
|
v, ok := m[k]
|
||||||
|
if !ok {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("%v", v)
|
||||||
|
}
|
||||||
|
|
||||||
|
r.Port = toString("port", m)
|
||||||
|
r.Code = toString("code", m)
|
||||||
|
r.Proto = toString("proto", m)
|
||||||
|
r.Host = toString("host", m)
|
||||||
|
r.Cidr = toString("cidr", m)
|
||||||
|
r.LocalCidr = toString("local_cidr", m)
|
||||||
|
r.CAName = toString("ca_name", m)
|
||||||
|
r.CASha = toString("ca_sha", m)
|
||||||
|
|
||||||
|
// Make sure group isn't an array
|
||||||
|
if v, ok := m["group"].([]any); ok {
|
||||||
|
if len(v) > 1 {
|
||||||
|
return r, errors.New("group should contain a single value, an array with more than one entry was provided")
|
||||||
|
}
|
||||||
|
|
||||||
|
l.Warn("group was an array with a single value, converting to simple value",
|
||||||
|
"table", table,
|
||||||
|
"rule", i,
|
||||||
|
)
|
||||||
|
m["group"] = v[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
singleGroup := toString("group", m)
|
||||||
|
|
||||||
|
if rg, ok := m["groups"]; ok {
|
||||||
|
switch reflect.TypeOf(rg).Kind() {
|
||||||
|
case reflect.Slice:
|
||||||
|
v := reflect.ValueOf(rg)
|
||||||
|
r.Groups = make([]string, v.Len())
|
||||||
|
for i := 0; i < v.Len(); i++ {
|
||||||
|
r.Groups[i] = v.Index(i).Interface().(string)
|
||||||
|
}
|
||||||
|
case reflect.String:
|
||||||
|
r.Groups = []string{rg.(string)}
|
||||||
|
default:
|
||||||
|
r.Groups = []string{fmt.Sprintf("%v", rg)}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
//flatten group vs groups
|
||||||
|
if singleGroup != "" {
|
||||||
|
// Check if we have both groups and group provided in the rule config
|
||||||
|
if len(r.Groups) > 0 {
|
||||||
|
return r, fmt.Errorf("only one of group or groups should be defined, both provided")
|
||||||
|
}
|
||||||
|
r.Groups = []string{singleGroup}
|
||||||
|
}
|
||||||
|
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// sanity returns an error if the rule would be evaluated in a way that would short-circuit a configured check on a wildcard value
|
||||||
|
// rules are evaluated as "port AND proto AND (ca_sha OR ca_name) AND (host OR group OR groups OR cidr) AND local_cidr"
|
||||||
|
func (r *configRule) sanity() error {
|
||||||
|
//port, proto, local_cidr are AND, no need to check here
|
||||||
|
//ca_sha and ca_name don't have a wildcard value, no need to check here
|
||||||
|
groupsEmpty := len(r.Groups) == 0
|
||||||
|
hostEmpty := r.Host == ""
|
||||||
|
cidrEmpty := r.Cidr == ""
|
||||||
|
|
||||||
|
if (groupsEmpty && hostEmpty && cidrEmpty) == true {
|
||||||
|
return nil //no content!
|
||||||
|
}
|
||||||
|
|
||||||
|
groupsHasAny := slices.Contains(r.Groups, "any")
|
||||||
|
if groupsHasAny && len(r.Groups) > 1 {
|
||||||
|
return fmt.Errorf("groups spec [%s] contains the group '\"any\". This rule will ignore the other groups specified", r.Groups)
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.Host == "any" {
|
||||||
|
if !groupsEmpty {
|
||||||
|
return fmt.Errorf("groups specified as %s, but host=any will match any host, regardless of groups", r.Groups)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !cidrEmpty {
|
||||||
|
return fmt.Errorf("cidr specified as %s, but host=any will match any host, regardless of cidr", r.Cidr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if groupsHasAny {
|
||||||
|
if !hostEmpty && r.Host != "any" {
|
||||||
|
return fmt.Errorf("groups spec [%s] contains the group '\"any\". This rule will ignore the specified host %s", r.Groups, r.Host)
|
||||||
|
}
|
||||||
|
if !cidrEmpty {
|
||||||
|
return fmt.Errorf("groups spec [%s] contains the group '\"any\". This rule will ignore the specified cidr %s", r.Groups, r.Cidr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.Code != "" {
|
||||||
|
return fmt.Errorf("code specified as [%s]. Support for 'code' will be dropped in a future release, as it has never been functional", r.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
//todo alert on cidr-any
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func parsePort(s string) (int32, int32, error) {
|
||||||
|
const notAPort int32 = -2
|
||||||
|
if s == "any" {
|
||||||
|
return PortAny, PortAny, nil
|
||||||
|
}
|
||||||
|
if s == "fragment" {
|
||||||
|
return PortFragment, PortFragment, nil
|
||||||
|
}
|
||||||
|
if !strings.Contains(s, `-`) {
|
||||||
|
rPort, err := parsePortValue("", s)
|
||||||
|
if err != nil {
|
||||||
|
return notAPort, notAPort, err
|
||||||
|
}
|
||||||
|
return rPort, rPort, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
sPorts := strings.SplitN(s, `-`, 2)
|
||||||
|
for i := range sPorts {
|
||||||
|
sPorts[i] = strings.Trim(sPorts[i], " ")
|
||||||
|
}
|
||||||
|
if len(sPorts) != 2 || sPorts[0] == "" || sPorts[1] == "" {
|
||||||
|
return notAPort, notAPort, fmt.Errorf("appears to be a range but could not be parsed; `%s`", s)
|
||||||
|
}
|
||||||
|
|
||||||
|
startPort, err := parsePortValue("beginning range ", sPorts[0])
|
||||||
|
if err != nil {
|
||||||
|
return notAPort, notAPort, err
|
||||||
|
}
|
||||||
|
|
||||||
|
endPort, err := parsePortValue("ending range ", sPorts[1])
|
||||||
|
if err != nil {
|
||||||
|
return notAPort, notAPort, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if startPort == PortAny {
|
||||||
|
endPort = PortAny
|
||||||
|
}
|
||||||
|
|
||||||
|
return startPort, endPort, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parsePortValue accepts a base-10 decimal in [0, 65535] and returns it
|
||||||
|
// widened to int32. Using strconv.ParseUint with bitSize 16 rejects
|
||||||
|
// negative input, out-of-range input (>65535), and any non-decimal byte
|
||||||
|
// by construction, so the int32 widening that follows is provably safe
|
||||||
|
// and cannot collide with PortAny (0) or PortFragment
|
||||||
|
// (-1) via integer truncation.
|
||||||
|
//
|
||||||
|
// prefix is prepended to both error messages so callers can disambiguate
|
||||||
|
// the single-port path (prefix="") from the range bounds (prefix="beginning
|
||||||
|
// range " / "ending range "), preserving the historical error strings.
|
||||||
|
func parsePortValue(prefix, s string) (int32, error) {
|
||||||
|
n, err := strconv.ParseUint(s, 10, 16)
|
||||||
|
if err == nil {
|
||||||
|
return int32(n), nil
|
||||||
|
}
|
||||||
|
if errors.Is(err, strconv.ErrRange) {
|
||||||
|
return 0, fmt.Errorf("%sout of range [0,65535]; `%s`", prefix, s)
|
||||||
|
}
|
||||||
|
return 0, fmt.Errorf("%swas not a number; `%s`", prefix, s)
|
||||||
|
}
|
||||||
@@ -0,0 +1,477 @@
|
|||||||
|
package firewall
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"errors"
|
||||||
|
"net/netip"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/config"
|
||||||
|
"github.com/slackhq/nebula/iputil"
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func Test_parsePort(t *testing.T) {
|
||||||
|
_, _, err := parsePort("")
|
||||||
|
require.EqualError(t, err, "was not a number; ``")
|
||||||
|
|
||||||
|
_, _, err = parsePort(" ")
|
||||||
|
require.EqualError(t, err, "was not a number; ` `")
|
||||||
|
|
||||||
|
_, _, err = parsePort("-")
|
||||||
|
require.EqualError(t, err, "appears to be a range but could not be parsed; `-`")
|
||||||
|
|
||||||
|
_, _, err = parsePort(" - ")
|
||||||
|
require.EqualError(t, err, "appears to be a range but could not be parsed; ` - `")
|
||||||
|
|
||||||
|
_, _, err = parsePort("a-b")
|
||||||
|
require.EqualError(t, err, "beginning range was not a number; `a`")
|
||||||
|
|
||||||
|
_, _, err = parsePort("1-b")
|
||||||
|
require.EqualError(t, err, "ending range was not a number; `b`")
|
||||||
|
|
||||||
|
s, e, err := parsePort(" 1 - 2 ")
|
||||||
|
assert.Equal(t, int32(1), s)
|
||||||
|
assert.Equal(t, int32(2), e)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
s, e, err = parsePort("0-1")
|
||||||
|
assert.Equal(t, int32(0), s)
|
||||||
|
assert.Equal(t, int32(0), e)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
s, e, err = parsePort("9919")
|
||||||
|
assert.Equal(t, int32(9919), s)
|
||||||
|
assert.Equal(t, int32(9919), e)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
s, e, err = parsePort("any")
|
||||||
|
assert.Equal(t, int32(0), s)
|
||||||
|
assert.Equal(t, int32(0), e)
|
||||||
|
require.NoError(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test_parsePort_invalid covers inputs that must error. The named bug is
|
||||||
|
// that int32(strconv.Atoi("4294967296")) truncates to 0 == PortAny,
|
||||||
|
// silently turning a typo into a match-all-ports rule; the rest are
|
||||||
|
// representative syntax/range probes.
|
||||||
|
func Test_parsePort_invalid(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
wantErrContains string
|
||||||
|
}{
|
||||||
|
// Numeric overflow (the named bug + boundary).
|
||||||
|
{"named bug: 2^32 truncates to PortAny", "4294967296", "out of range"},
|
||||||
|
{"just above max real port", "65536", "out of range"},
|
||||||
|
|
||||||
|
// Negatives route through the range branch and hit the empty-half
|
||||||
|
// guard; included as defense in depth so a future refactor cannot
|
||||||
|
// accidentally reach the int32 cast.
|
||||||
|
{"negative", "-1", "could not be parsed"},
|
||||||
|
|
||||||
|
// Syntax probes.
|
||||||
|
{"NUL between digits", "4\x002", "was not a number"},
|
||||||
|
{"hex notation", "0x10", "was not a number"},
|
||||||
|
{"scientific notation", "1e3", "was not a number"},
|
||||||
|
{"leading whitespace", " 42", "was not a number"},
|
||||||
|
{"fullwidth digits", "42", "was not a number"},
|
||||||
|
|
||||||
|
// Range branch.
|
||||||
|
{"range upper out of range", "1-65536", "ending range out of range"},
|
||||||
|
{"range lower out of range", "65536-65537", "beginning range out of range"},
|
||||||
|
{"range with negative upper", "1--1", "ending range was not a number"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
_, _, err := parsePort(tc.input)
|
||||||
|
require.Error(t, err, "input %q must error", tc.input)
|
||||||
|
require.ErrorContains(t, err, tc.wantErrContains)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test_parsePort_valid_boundaries locks in success cases at 0, 1, and 65535
|
||||||
|
// so a future refactor cannot regress the boundaries.
|
||||||
|
func Test_parsePort_valid_boundaries(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
wantStart int32
|
||||||
|
wantEnd int32
|
||||||
|
}{
|
||||||
|
{"zero is PortAny", "0", 0, 0},
|
||||||
|
{"min real port", "1", 1, 1},
|
||||||
|
{"max real port", "65535", 65535, 65535},
|
||||||
|
{"range zero to max forces end to zero", "0-65535", 0, 0},
|
||||||
|
{"range max to max", "65535-65535", 65535, 65535},
|
||||||
|
{"range one to max", "1-65535", 1, 65535},
|
||||||
|
{"range with whitespace inside", " 1 - 2 ", 1, 2},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
s, e, err := parsePort(tc.input)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, tc.wantStart, s, "start port")
|
||||||
|
assert.Equal(t, tc.wantEnd, e, "end port")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAddRulesFromConfig(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
// Test adding tcp rule
|
||||||
|
conf := config.NewC(test.NewLogger())
|
||||||
|
mf := &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "1", "proto": "tcp", "host": "a"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, false, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: false, proto: iputil.IPProtocolTCP, startPort: 1, endPort: 1, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test adding udp rule
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "1", "proto": "udp", "host": "a"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, false, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: false, proto: iputil.IPProtocolUDP, startPort: 1, endPort: 1, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test adding udplite, dccp, and sctp rules
|
||||||
|
for name, proto := range map[string]uint8{"udplite": iputil.IPProtocolUDPLite, "dccp": iputil.IPProtocolDCCP, "sctp": iputil.IPProtocolSCTP} {
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "1-2", "proto": name, "host": "a"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, false, conf, mf), name)
|
||||||
|
assert.Equal(t, addRuleCall{incoming: false, proto: proto, startPort: 1, endPort: 2, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall, name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test adding icmp rule
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "1", "proto": "icmp", "host": "a"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, false, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: false, proto: iputil.IPProtocolICMP, startPort: PortAny, endPort: PortAny, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test adding icmp rule no port
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"proto": "icmp", "host": "a"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, false, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: false, proto: iputil.IPProtocolICMP, startPort: PortAny, endPort: PortAny, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test adding rules by protocol number, as yaml would give a string or an int
|
||||||
|
for _, proto := range []any{"47", 47} {
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "any", "proto": proto, "host": "a"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, false, conf, mf), proto)
|
||||||
|
assert.Equal(t, addRuleCall{incoming: false, proto: 47, startPort: PortAny, endPort: PortAny, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall, proto)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test ICMP and ICMPv6 by number still ignore ports
|
||||||
|
for _, proto := range []uint8{iputil.IPProtocolICMP, iputil.IPProtocolICMPv6} {
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "1", "proto": proto, "host": "a"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, false, conf, mf), proto)
|
||||||
|
assert.Equal(t, addRuleCall{incoming: false, proto: proto, startPort: PortAny, endPort: PortAny, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall, proto)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test protocols that aren't a known name or a number from 1 to 255
|
||||||
|
for _, proto := range []string{"0", "256", "-1", "gre"} {
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "any", "proto": proto, "host": "a"}}}
|
||||||
|
require.EqualError(t, addRulesFromConfig(l, false, conf, mf), "firewall.outbound rule #0; proto was not understood; `"+proto+"`")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test adding any rule
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "host": "a"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test adding rule with cidr
|
||||||
|
cidr := netip.MustParsePrefix("10.0.0.0/8")
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "cidr": cidr.String()}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: cidr.String(), localIp: ""}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test adding rule with local_cidr
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "local_cidr": cidr.String()}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: "", localIp: cidr.String()}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test adding rule with cidr ipv6
|
||||||
|
cidr6 := netip.MustParsePrefix("fd00::/8")
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "cidr": cidr6.String()}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: cidr6.String(), localIp: ""}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test adding rule with any cidr
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "cidr": "any"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: "any", localIp: ""}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test adding rule with junk cidr, which RulesBuilder rejects
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "cidr": "junk/junk"}}}
|
||||||
|
require.EqualError(t, addRulesFromConfig(l, true, conf, NewRulesBuilder(l)), "firewall.inbound rule #0; cidr did not parse; netip.ParsePrefix(\"junk/junk\"): ParseAddr(\"junk\"): unable to parse IP")
|
||||||
|
|
||||||
|
// Test adding rule with local_cidr ipv6
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "local_cidr": cidr6.String()}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: "", localIp: cidr6.String()}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test adding rule with any local_cidr
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "local_cidr": "any"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, localIp: "any"}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test adding rule with junk local_cidr, which RulesBuilder rejects
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "local_cidr": "junk/junk"}}}
|
||||||
|
require.EqualError(t, addRulesFromConfig(l, true, conf, NewRulesBuilder(l)), "firewall.inbound rule #0; local_cidr did not parse; netip.ParsePrefix(\"junk/junk\"): ParseAddr(\"junk\"): unable to parse IP")
|
||||||
|
|
||||||
|
// Test adding rule with ca_sha
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "ca_sha": "12312313123"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: "", localIp: "", caSha: "12312313123"}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test adding rule with ca_name
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "ca_name": "root01"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: "", localIp: "", caName: "root01"}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test single group
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "group": "a"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: []string{"a"}, ip: "", localIp: ""}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test single groups
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "groups": "a"}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: []string{"a"}, ip: "", localIp: ""}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test multiple AND groups
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "groups": []string{"a", "b"}}}}
|
||||||
|
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
||||||
|
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: []string{"a", "b"}, ip: "", localIp: ""}, mf.lastCall)
|
||||||
|
|
||||||
|
// Test Add error
|
||||||
|
conf = config.NewC(test.NewLogger())
|
||||||
|
mf = &mockFirewall{}
|
||||||
|
mf.nextCallReturn = errors.New("test error")
|
||||||
|
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "host": "a"}}}
|
||||||
|
require.EqualError(t, addRulesFromConfig(l, true, conf, mf), "firewall.inbound rule #0; test error")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRulesFromConfig_defaultLocalCIDR ensures rules without a local_cidr allow only the vpn networks when there are
|
||||||
|
// unsafe networks, unless default_local_cidr_any is set, and that a rule's own local_cidr is kept either way
|
||||||
|
func TestRulesFromConfig_defaultLocalCIDR(t *testing.T) {
|
||||||
|
vpnNetworks := []netip.Prefix{netip.MustParsePrefix("10.1.0.5/16")}
|
||||||
|
unsafeNetworks := []netip.Prefix{netip.MustParsePrefix("192.168.0.0/24")}
|
||||||
|
vpnAddr := netip.MustParseAddr("10.1.9.9")
|
||||||
|
unsafeAddr := netip.MustParseAddr("192.168.0.3")
|
||||||
|
|
||||||
|
allows := func(lr *localRules, addr netip.Addr) bool {
|
||||||
|
return lr.match(&Packet{LocalAddr: addr}, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
unsafeNetworks []netip.Prefix
|
||||||
|
defaultLocalCIDRAny bool
|
||||||
|
wantUnsafe bool
|
||||||
|
}{
|
||||||
|
{"no unsafe networks", nil, false, true},
|
||||||
|
{"unsafe networks", unsafeNetworks, false, false},
|
||||||
|
{"unsafe networks and default_local_cidr_any", unsafeNetworks, true, true},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
conf := config.NewC(test.NewLogger())
|
||||||
|
conf.Settings["firewall"] = map[string]any{
|
||||||
|
"default_local_cidr_any": tc.defaultLocalCIDRAny,
|
||||||
|
"inbound": []any{
|
||||||
|
map[string]any{"port": "any", "proto": "any", "host": "any"},
|
||||||
|
map[string]any{"port": "22", "proto": "tcp", "host": "any"},
|
||||||
|
map[string]any{"port": "80", "proto": "tcp", "host": "any", "local_cidr": "192.168.0.0/24"},
|
||||||
|
map[string]any{"port": "443", "proto": "tcp", "host": "any", "local_cidr": "any"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
rules, err := RulesFromConfig(test.NewLogger(), conf, vpnNetworks, tc.unsafeNetworks)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// The proto `any` rule, copied into a protocol with rules of its own and shared by one without
|
||||||
|
for _, proto := range []uint8{iputil.IPProtocolTCP, 47} {
|
||||||
|
lr := rules.In.protos[proto][PortAny].Any.Any
|
||||||
|
assert.True(t, allows(lr, vpnAddr), "proto %d", proto)
|
||||||
|
assert.Equal(t, tc.wantUnsafe, allows(lr, unsafeAddr), "proto %d", proto)
|
||||||
|
}
|
||||||
|
|
||||||
|
tcp := rules.In.protos[iputil.IPProtocolTCP]
|
||||||
|
assert.True(t, allows(tcp[22].Any.Any, vpnAddr))
|
||||||
|
assert.Equal(t, tc.wantUnsafe, allows(tcp[22].Any.Any, unsafeAddr))
|
||||||
|
|
||||||
|
assert.False(t, allows(tcp[80].Any.Any, vpnAddr))
|
||||||
|
assert.True(t, allows(tcp[80].Any.Any, unsafeAddr))
|
||||||
|
|
||||||
|
assert.True(t, allows(tcp[443].Any.Any, vpnAddr))
|
||||||
|
assert.True(t, allows(tcp[443].Any.Any, unsafeAddr))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_convertRule(t *testing.T) {
|
||||||
|
ob := &bytes.Buffer{}
|
||||||
|
l := test.NewLoggerWithOutput(ob)
|
||||||
|
|
||||||
|
// Ensure group array of 1 is converted and a warning is printed
|
||||||
|
c := map[string]any{
|
||||||
|
"group": []any{"group1"},
|
||||||
|
}
|
||||||
|
|
||||||
|
r, err := yamlToConfigRule(l, c, "test", 1)
|
||||||
|
assert.Contains(t, ob.String(), "group was an array with a single value, converting to simple value")
|
||||||
|
assert.Contains(t, ob.String(), "table=test")
|
||||||
|
assert.Contains(t, ob.String(), "rule=1")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, []string{"group1"}, r.Groups)
|
||||||
|
|
||||||
|
// Ensure group array of > 1 is errord
|
||||||
|
ob.Reset()
|
||||||
|
c = map[string]any{
|
||||||
|
"group": []any{"group1", "group2"},
|
||||||
|
}
|
||||||
|
|
||||||
|
r, err = yamlToConfigRule(l, c, "test", 1)
|
||||||
|
assert.Empty(t, ob.String())
|
||||||
|
require.Error(t, err, "group should contain a single value, an array with more than one entry was provided")
|
||||||
|
|
||||||
|
// Make sure a well formed group is alright
|
||||||
|
ob.Reset()
|
||||||
|
c = map[string]any{
|
||||||
|
"group": "group1",
|
||||||
|
}
|
||||||
|
|
||||||
|
r, err = yamlToConfigRule(l, c, "test", 1)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, []string{"group1"}, r.Groups)
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_convertRuleSanity(t *testing.T) {
|
||||||
|
ob := &bytes.Buffer{}
|
||||||
|
l := test.NewLoggerWithOutput(ob)
|
||||||
|
|
||||||
|
noWarningPlease := []map[string]any{
|
||||||
|
{"group": "group1"},
|
||||||
|
{"groups": []any{"group2"}},
|
||||||
|
{"host": "bob"},
|
||||||
|
{"cidr": "1.1.1.1/1"},
|
||||||
|
{"groups": []any{"group2"}, "host": "bob"},
|
||||||
|
{"cidr": "1.1.1.1/1", "host": "bob"},
|
||||||
|
{"groups": []any{"group2"}, "cidr": "1.1.1.1/1"},
|
||||||
|
{"groups": []any{"group2"}, "cidr": "1.1.1.1/1", "host": "bob"},
|
||||||
|
}
|
||||||
|
for _, c := range noWarningPlease {
|
||||||
|
r, err := yamlToConfigRule(l, c, "test", 1)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, r.sanity(), "should not generate a sanity warning, %+v", c)
|
||||||
|
}
|
||||||
|
|
||||||
|
yesWarningPlease := []map[string]any{
|
||||||
|
{"group": "group1"},
|
||||||
|
{"groups": []any{"group2"}},
|
||||||
|
{"cidr": "1.1.1.1/1"},
|
||||||
|
{"groups": []any{"group2"}, "host": "bob"},
|
||||||
|
{"cidr": "1.1.1.1/1", "host": "bob"},
|
||||||
|
{"groups": []any{"group2"}, "cidr": "1.1.1.1/1"},
|
||||||
|
{"groups": []any{"group2"}, "cidr": "1.1.1.1/1", "host": "bob"},
|
||||||
|
}
|
||||||
|
for _, c := range yesWarningPlease {
|
||||||
|
c["host"] = "any"
|
||||||
|
r, err := yamlToConfigRule(l, c, "test", 1)
|
||||||
|
require.NoError(t, err)
|
||||||
|
err = r.sanity()
|
||||||
|
require.Error(t, err, "I wanted a warning: %+v", c)
|
||||||
|
}
|
||||||
|
//reset the list
|
||||||
|
yesWarningPlease = []map[string]any{
|
||||||
|
{"group": "group1"},
|
||||||
|
{"groups": []any{"group2"}},
|
||||||
|
{"cidr": "1.1.1.1/1"},
|
||||||
|
{"groups": []any{"group2"}, "host": "bob"},
|
||||||
|
{"cidr": "1.1.1.1/1", "host": "bob"},
|
||||||
|
{"groups": []any{"group2"}, "cidr": "1.1.1.1/1"},
|
||||||
|
{"groups": []any{"group2"}, "cidr": "1.1.1.1/1", "host": "bob"},
|
||||||
|
}
|
||||||
|
for _, c := range yesWarningPlease {
|
||||||
|
r, err := yamlToConfigRule(l, c, "test", 1)
|
||||||
|
require.NoError(t, err)
|
||||||
|
r.Groups = append(r.Groups, "any")
|
||||||
|
err = r.sanity()
|
||||||
|
require.Error(t, err, "I wanted a warning: %+v", c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type addRuleCall struct {
|
||||||
|
incoming bool
|
||||||
|
proto uint8
|
||||||
|
startPort int32
|
||||||
|
endPort int32
|
||||||
|
groups []string
|
||||||
|
host string
|
||||||
|
ip string
|
||||||
|
localIp string
|
||||||
|
caName string
|
||||||
|
caSha string
|
||||||
|
}
|
||||||
|
|
||||||
|
type mockFirewall struct {
|
||||||
|
lastCall addRuleCall
|
||||||
|
nextCallReturn error
|
||||||
|
}
|
||||||
|
|
||||||
|
func (mf *mockFirewall) AddRule(incoming bool, proto uint8, startPort int32, endPort int32, groups []string, host string, ip, localIp, caName string, caSha string) error {
|
||||||
|
mf.lastCall = addRuleCall{
|
||||||
|
incoming: incoming,
|
||||||
|
proto: proto,
|
||||||
|
startPort: startPort,
|
||||||
|
endPort: endPort,
|
||||||
|
groups: groups,
|
||||||
|
host: host,
|
||||||
|
ip: ip,
|
||||||
|
localIp: localIp,
|
||||||
|
caName: caName,
|
||||||
|
caSha: caSha,
|
||||||
|
}
|
||||||
|
|
||||||
|
err := mf.nextCallReturn
|
||||||
|
mf.nextCallReturn = nil
|
||||||
|
return err
|
||||||
|
}
|
||||||
@@ -50,6 +50,12 @@ func (fp Packet) MarshalJSON() ([]byte, error) {
|
|||||||
proto = "icmpv6"
|
proto = "icmpv6"
|
||||||
case iputil.IPProtocolUDP:
|
case iputil.IPProtocolUDP:
|
||||||
proto = "udp"
|
proto = "udp"
|
||||||
|
case iputil.IPProtocolUDPLite:
|
||||||
|
proto = "udplite"
|
||||||
|
case iputil.IPProtocolDCCP:
|
||||||
|
proto = "dccp"
|
||||||
|
case iputil.IPProtocolSCTP:
|
||||||
|
proto = "sctp"
|
||||||
default:
|
default:
|
||||||
proto = fmt.Sprintf("unknown %v", fp.Protocol)
|
proto = fmt.Sprintf("unknown %v", fp.Protocol)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,330 @@
|
|||||||
|
package firewall
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
|
"fmt"
|
||||||
|
"hash"
|
||||||
|
"hash/fnv"
|
||||||
|
"io"
|
||||||
|
"log/slog"
|
||||||
|
"net/netip"
|
||||||
|
"slices"
|
||||||
|
|
||||||
|
"github.com/gaissmai/bart"
|
||||||
|
"github.com/slackhq/nebula/iputil"
|
||||||
|
)
|
||||||
|
|
||||||
|
// RulesBuilder collects the inbound and outbound rules, Build turns them into a Table for each direction
|
||||||
|
type RulesBuilder struct {
|
||||||
|
in, out tableRules
|
||||||
|
|
||||||
|
// defaultLocalCIDRAny makes rules without a local cidr allow any local address, even with unsafe networks
|
||||||
|
defaultLocalCIDRAny bool
|
||||||
|
|
||||||
|
// ruleSHA and ruleFNV hash every rule as it's added, see Rules
|
||||||
|
ruleSHA hash.Hash
|
||||||
|
ruleFNV hash.Hash32
|
||||||
|
|
||||||
|
l *slog.Logger
|
||||||
|
}
|
||||||
|
|
||||||
|
// tableRules are one direction's rules, waiting to be built into a Table
|
||||||
|
type tableRules struct {
|
||||||
|
anyRules []rule
|
||||||
|
// protoRules holds the rules for each protocol besides proto `any`, ICMPv6 rules are kept with ICMP
|
||||||
|
protoRules [256][]rule
|
||||||
|
}
|
||||||
|
|
||||||
|
// rule is a parsed rule, so adding it to a Table can't fail
|
||||||
|
type rule struct {
|
||||||
|
startPort, endPort int32
|
||||||
|
groups []string
|
||||||
|
host string
|
||||||
|
caName, caSha string
|
||||||
|
|
||||||
|
// cidr is the remote cidr, not valid when the rule doesn't have one
|
||||||
|
cidr netip.Prefix
|
||||||
|
anyCIDR bool
|
||||||
|
|
||||||
|
// localCIDR is the local addresses the rule allows, anyLocalCIDR allows all of them.
|
||||||
|
// Neither is set for a rule without a local cidr until the Table is built and it gets the default.
|
||||||
|
// localCIDR is shared by every localRules the rule is added to, so it's never changed, see localRules.add
|
||||||
|
localCIDR *bart.Lite
|
||||||
|
anyLocalCIDR bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewRulesBuilder(l *slog.Logger) *RulesBuilder {
|
||||||
|
return &RulesBuilder{
|
||||||
|
ruleSHA: sha256.New(),
|
||||||
|
ruleFNV: fnv.New32a(),
|
||||||
|
l: l,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddRule adds a rule for incoming or outgoing traffic, on proto or on every protocol when proto is ProtoAny.
|
||||||
|
// The rule is parsed now, so a bad rule is reported when it's added rather than when the Tables are built.
|
||||||
|
func (b *RulesBuilder) AddRule(incoming bool, proto uint8, startPort int32, endPort int32, groups []string, host string, cidr, localCidr, caName string, caSha string) error {
|
||||||
|
if proto == iputil.IPProtocolICMP || proto == iputil.IPProtocolICMPv6 {
|
||||||
|
//ICMP traffic doesn't have ports, so we always coerce to "any", even if a value is provided
|
||||||
|
if startPort != PortAny {
|
||||||
|
b.l.Warn("ignoring port specification for ICMP firewall rule", "startPort", startPort)
|
||||||
|
}
|
||||||
|
startPort = PortAny
|
||||||
|
endPort = PortAny
|
||||||
|
}
|
||||||
|
|
||||||
|
r, err := parseRule(startPort, endPort, groups, host, cidr, localCidr, caName, caSha)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if incoming {
|
||||||
|
b.in.add(proto, r)
|
||||||
|
} else {
|
||||||
|
b.out.add(proto, r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The rule hashes are of these lines, changing them changes every hash
|
||||||
|
fmt.Fprintf(io.MultiWriter(b.ruleSHA, b.ruleFNV),
|
||||||
|
"incoming: %v, proto: %v, startPort: %v, endPort: %v, groups: %v, host: %v, ip: %v, localIp: %v, caName: %v, caSha: %s\n",
|
||||||
|
incoming, proto, startPort, endPort, groups, host, cidr, localCidr, caName, caSha,
|
||||||
|
)
|
||||||
|
|
||||||
|
direction := "incoming"
|
||||||
|
if !incoming {
|
||||||
|
direction = "outgoing"
|
||||||
|
}
|
||||||
|
b.l.Info("Firewall rule added",
|
||||||
|
"firewallRule", m{"direction": direction, "proto": proto, "startPort": startPort, "endPort": endPort, "groups": groups, "host": host, "cidr": cidr, "localCidr": localCidr, "caName": caName, "caSha": caSha},
|
||||||
|
)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build turns the rules into a Table for each direction, and hashes them. Rules without a local cidr allow
|
||||||
|
// vpnNetworks when there are unsafe networks, otherwise any local address.
|
||||||
|
func (b *RulesBuilder) Build(vpnNetworks, unsafeNetworks []netip.Prefix) Rules {
|
||||||
|
var defaultLocal *bart.Lite
|
||||||
|
if len(unsafeNetworks) > 0 && !b.defaultLocalCIDRAny {
|
||||||
|
defaultLocal = new(bart.Lite)
|
||||||
|
for _, network := range vpnNetworks {
|
||||||
|
defaultLocal.Insert(network)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return Rules{
|
||||||
|
In: b.in.build(defaultLocal),
|
||||||
|
Out: b.out.build(defaultLocal),
|
||||||
|
Hash: hex.EncodeToString(b.ruleSHA.Sum(nil)),
|
||||||
|
HashFNV: b.ruleFNV.Sum32(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseRule(startPort, endPort int32, groups []string, host, cidr, localCidr, caName, caSha string) (rule, error) {
|
||||||
|
if startPort > endPort {
|
||||||
|
return rule{}, fmt.Errorf("start port was lower than end port")
|
||||||
|
}
|
||||||
|
|
||||||
|
r := rule{
|
||||||
|
startPort: startPort,
|
||||||
|
endPort: endPort,
|
||||||
|
groups: groups,
|
||||||
|
host: host,
|
||||||
|
caName: caName,
|
||||||
|
caSha: caSha,
|
||||||
|
}
|
||||||
|
|
||||||
|
var err error
|
||||||
|
r.cidr, r.anyCIDR, err = parseCIDR(cidr)
|
||||||
|
if err != nil {
|
||||||
|
return rule{}, fmt.Errorf("cidr did not parse; %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var localCIDR netip.Prefix
|
||||||
|
localCIDR, r.anyLocalCIDR, err = parseCIDR(localCidr)
|
||||||
|
if err != nil {
|
||||||
|
return rule{}, fmt.Errorf("local_cidr did not parse; %w", err)
|
||||||
|
}
|
||||||
|
if localCIDR.IsValid() {
|
||||||
|
r.localCIDR = new(bart.Lite)
|
||||||
|
r.localCIDR.Insert(localCIDR)
|
||||||
|
}
|
||||||
|
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// add keeps r for proto, or for every protocol when proto is ProtoAny
|
||||||
|
func (tr *tableRules) add(proto uint8, r rule) {
|
||||||
|
switch proto {
|
||||||
|
case ProtoAny:
|
||||||
|
tr.anyRules = append(tr.anyRules, r)
|
||||||
|
case iputil.IPProtocolICMPv6:
|
||||||
|
tr.protoRules[iputil.IPProtocolICMP] = append(tr.protoRules[iputil.IPProtocolICMP], r)
|
||||||
|
default:
|
||||||
|
tr.protoRules[proto] = append(tr.protoRules[proto], r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// build turns the rules into a Table. Rules without a local cidr allow defaultLocal,
|
||||||
|
// or any local address when defaultLocal is nil.
|
||||||
|
func (tr *tableRules) build(defaultLocal *bart.Lite) *Table {
|
||||||
|
t := &Table{}
|
||||||
|
|
||||||
|
// Every protocol starts out sharing the proto `any` rules, including protos[ProtoAny]
|
||||||
|
anyProto := newPortRules(defaultLocal, tr.anyRules)
|
||||||
|
for proto := range t.protos {
|
||||||
|
t.protos[proto] = anyProto
|
||||||
|
}
|
||||||
|
|
||||||
|
// Protocols with rules of their own get a copy of the proto `any` rules too, so a packet only checks one set
|
||||||
|
for proto, rules := range tr.protoRules {
|
||||||
|
if len(rules) > 0 {
|
||||||
|
t.protos[proto] = newPortRules(defaultLocal, tr.anyRules, rules)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ICMP and ICMPv6 share one set of rules, add keeps them together under ICMP
|
||||||
|
t.protos[iputil.IPProtocolICMPv6] = t.protos[iputil.IPProtocolICMP]
|
||||||
|
|
||||||
|
return t
|
||||||
|
}
|
||||||
|
|
||||||
|
// newPortRules builds portRules from each set of rules, or returns nil when there are none
|
||||||
|
func newPortRules(defaultLocal *bart.Lite, ruleSets ...[]rule) portRules {
|
||||||
|
var pr portRules
|
||||||
|
for _, rules := range ruleSets {
|
||||||
|
for _, r := range rules {
|
||||||
|
if pr == nil {
|
||||||
|
pr = portRules{}
|
||||||
|
}
|
||||||
|
pr.add(r.withDefaultLocal(defaultLocal))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return pr
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseCIDR parses a rule's cidr, which is empty, `any`, or a prefix
|
||||||
|
func parseCIDR(s string) (prefix netip.Prefix, isAny bool, err error) {
|
||||||
|
switch s {
|
||||||
|
case "":
|
||||||
|
return netip.Prefix{}, false, nil
|
||||||
|
case "any":
|
||||||
|
return netip.Prefix{}, true, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
prefix, err = netip.ParsePrefix(s)
|
||||||
|
return prefix, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// isAny reports whether r matches any host, making its groups, host, and cidr irrelevant
|
||||||
|
func (r rule) isAny() bool {
|
||||||
|
if len(r.groups) == 0 && r.host == "" && !r.cidr.IsValid() {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return slices.Contains(r.groups, "any") || r.host == "any" || r.anyCIDR
|
||||||
|
}
|
||||||
|
|
||||||
|
// withDefaultLocal returns r allowing defaultLocal, or any local address when defaultLocal is nil,
|
||||||
|
// unless r has a local cidr of its own
|
||||||
|
func (r rule) withDefaultLocal(defaultLocal *bart.Lite) rule {
|
||||||
|
if !r.anyLocalCIDR && r.localCIDR == nil {
|
||||||
|
r.anyLocalCIDR = defaultLocal == nil
|
||||||
|
r.localCIDR = defaultLocal
|
||||||
|
}
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pr portRules) add(r rule) {
|
||||||
|
for i := r.startPort; i <= r.endPort; i++ {
|
||||||
|
cr := pr[i]
|
||||||
|
if cr == nil {
|
||||||
|
cr = &caRules{}
|
||||||
|
pr[i] = cr
|
||||||
|
}
|
||||||
|
cr.add(r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (cr *caRules) add(r rule) {
|
||||||
|
if r.caSha == "" && r.caName == "" {
|
||||||
|
if cr.Any == nil {
|
||||||
|
cr.Any = &remoteRules{}
|
||||||
|
}
|
||||||
|
cr.Any.add(r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.caSha != "" {
|
||||||
|
getOrNew(&cr.CAShas, r.caSha).add(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.caName != "" {
|
||||||
|
getOrNew(&cr.CANames, r.caName).add(r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (rr *remoteRules) add(r rule) {
|
||||||
|
if r.isAny() {
|
||||||
|
if rr.Any == nil {
|
||||||
|
rr.Any = &localRules{}
|
||||||
|
}
|
||||||
|
rr.Any.add(r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(r.groups) > 0 {
|
||||||
|
lr := &localRules{}
|
||||||
|
lr.add(r)
|
||||||
|
rr.Groups = append(rr.Groups, &groupsRule{
|
||||||
|
Groups: r.groups,
|
||||||
|
LocalCIDR: lr,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.host != "" {
|
||||||
|
getOrNew(&rr.Hosts, r.host).add(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.cidr.IsValid() {
|
||||||
|
if rr.CIDR == nil {
|
||||||
|
rr.CIDR = new(bart.Table[*localRules])
|
||||||
|
}
|
||||||
|
lr, ok := rr.CIDR.Get(r.cidr)
|
||||||
|
if !ok {
|
||||||
|
lr = &localRules{}
|
||||||
|
rr.CIDR.Insert(r.cidr, lr)
|
||||||
|
}
|
||||||
|
lr.add(r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (lr *localRules) add(r rule) {
|
||||||
|
if r.anyLocalCIDR {
|
||||||
|
lr.Any = true
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Share the rule's local cidrs until another rule's need adding, then copy them instead of changing them
|
||||||
|
if lr.LocalCIDR == nil {
|
||||||
|
lr.LocalCIDR = r.localCIDR
|
||||||
|
return
|
||||||
|
}
|
||||||
|
for prefix := range r.localCIDR.All() {
|
||||||
|
lr.LocalCIDR = lr.LocalCIDR.InsertPersist(prefix)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// getOrNew returns m[k], adding a new value for k first when there isn't one. m is made if it's nil.
|
||||||
|
func getOrNew[M ~map[K]*V, K comparable, V any](m *M, k K) *V {
|
||||||
|
if *m == nil {
|
||||||
|
*m = make(M)
|
||||||
|
}
|
||||||
|
v := (*m)[k]
|
||||||
|
if v == nil {
|
||||||
|
v = new(V)
|
||||||
|
(*m)[k] = v
|
||||||
|
}
|
||||||
|
return v
|
||||||
|
}
|
||||||
@@ -0,0 +1,239 @@
|
|||||||
|
package firewall
|
||||||
|
|
||||||
|
import (
|
||||||
|
"math"
|
||||||
|
"net/netip"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/iputil"
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRulesBuilder_AddRule(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
|
||||||
|
ti, err := netip.ParsePrefix("1.2.3.4/32")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
ti6, err := netip.ParsePrefix("fd12::34/128")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
rb := NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1, 1, []string{}, "", "", "", "", ""))
|
||||||
|
rules := rb.Build(nil, nil)
|
||||||
|
// An empty rule is any
|
||||||
|
assert.True(t, rules.In.protos[iputil.IPProtocolTCP][1].Any.Any.Any)
|
||||||
|
assert.Empty(t, rules.In.protos[iputil.IPProtocolTCP][1].Any.Groups)
|
||||||
|
assert.Empty(t, rules.In.protos[iputil.IPProtocolTCP][1].Any.Hosts)
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolUDP, 1, 1, []string{"g1"}, "", "", "", "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.Nil(t, rules.In.protos[iputil.IPProtocolUDP][1].Any.Any)
|
||||||
|
assert.Contains(t, rules.In.protos[iputil.IPProtocolUDP][1].Any.Groups[0].Groups, "g1")
|
||||||
|
assert.Empty(t, rules.In.protos[iputil.IPProtocolUDP][1].Any.Hosts)
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolICMP, 1, 1, []string{}, "h1", "", "", "", ""))
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolICMPv6, 1, 1, []string{}, "h2", "", "", "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
//no matter what port is given for icmp, it should end up as "any"
|
||||||
|
assert.Nil(t, rules.In.protos[iputil.IPProtocolICMP][PortAny].Any.Any)
|
||||||
|
assert.Empty(t, rules.In.protos[iputil.IPProtocolICMP][PortAny].Any.Groups)
|
||||||
|
assert.Contains(t, rules.In.protos[iputil.IPProtocolICMP][PortAny].Any.Hosts, "h1")
|
||||||
|
|
||||||
|
// ICMP and ICMPv6 share one set of rules
|
||||||
|
assert.Contains(t, rules.In.protos[iputil.IPProtocolICMP][PortAny].Any.Hosts, "h2")
|
||||||
|
assert.Contains(t, rules.In.protos[iputil.IPProtocolICMPv6][PortAny].Any.Hosts, "h1")
|
||||||
|
|
||||||
|
// Any other protocol number gets its own rules
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(true, 47, 0, 0, []string{"g1"}, "", "", "", "", "")) // GRE
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.Contains(t, rules.In.protos[47][PortAny].Any.Groups[0].Groups, "g1")
|
||||||
|
assert.Nil(t, rules.In.protos[iputil.IPProtocolTCP])
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(false, ProtoAny, 1, 1, []string{}, "", ti.String(), "", "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.Nil(t, rules.Out.protos[ProtoAny][1].Any.Any)
|
||||||
|
_, ok := rules.Out.protos[ProtoAny][1].Any.CIDR.Get(ti)
|
||||||
|
assert.True(t, ok)
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(false, ProtoAny, 1, 1, []string{}, "", ti6.String(), "", "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.Nil(t, rules.Out.protos[ProtoAny][1].Any.Any)
|
||||||
|
_, ok = rules.Out.protos[ProtoAny][1].Any.CIDR.Get(ti6)
|
||||||
|
assert.True(t, ok)
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(false, ProtoAny, 1, 1, []string{}, "", "", ti.String(), "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.NotNil(t, rules.Out.protos[ProtoAny][1].Any.Any)
|
||||||
|
ok = rules.Out.protos[ProtoAny][1].Any.Any.LocalCIDR.Get(ti)
|
||||||
|
assert.True(t, ok)
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(false, ProtoAny, 1, 1, []string{}, "", "", ti6.String(), "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.NotNil(t, rules.Out.protos[ProtoAny][1].Any.Any)
|
||||||
|
ok = rules.Out.protos[ProtoAny][1].Any.Any.LocalCIDR.Get(ti6)
|
||||||
|
assert.True(t, ok)
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolUDP, 1, 1, []string{"g1"}, "", "", "", "ca-name", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.Contains(t, rules.In.protos[iputil.IPProtocolUDP][1].CANames, "ca-name")
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolUDP, 1, 1, []string{"g1"}, "", "", "", "", "ca-sha"))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.Contains(t, rules.In.protos[iputil.IPProtocolUDP][1].CAShas, "ca-sha")
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "any", "", "", "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.True(t, rules.Out.protos[ProtoAny][0].Any.Any.Any)
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
anyIp, err := netip.ParsePrefix("0.0.0.0/0")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "", anyIp.String(), "", "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.Nil(t, rules.Out.protos[ProtoAny][0].Any.Any)
|
||||||
|
table, ok := rules.Out.protos[ProtoAny][0].Any.CIDR.Lookup(netip.MustParseAddr("1.1.1.1"))
|
||||||
|
assert.True(t, table.Any)
|
||||||
|
table, ok = rules.Out.protos[ProtoAny][0].Any.CIDR.Lookup(netip.MustParseAddr("9::9"))
|
||||||
|
assert.False(t, ok)
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
anyIp6, err := netip.ParsePrefix("::/0")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "", anyIp6.String(), "", "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.Nil(t, rules.Out.protos[ProtoAny][0].Any.Any)
|
||||||
|
table, ok = rules.Out.protos[ProtoAny][0].Any.CIDR.Lookup(netip.MustParseAddr("9::9"))
|
||||||
|
assert.True(t, table.Any)
|
||||||
|
table, ok = rules.Out.protos[ProtoAny][0].Any.CIDR.Lookup(netip.MustParseAddr("1.1.1.1"))
|
||||||
|
assert.False(t, ok)
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "", "any", "", "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.True(t, rules.Out.protos[ProtoAny][0].Any.Any.Any)
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "", "", anyIp.String(), "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.False(t, rules.Out.protos[ProtoAny][0].Any.Any.Any)
|
||||||
|
assert.True(t, rules.Out.protos[ProtoAny][0].Any.Any.LocalCIDR.Lookup(netip.MustParseAddr("1.1.1.1")))
|
||||||
|
assert.False(t, rules.Out.protos[ProtoAny][0].Any.Any.LocalCIDR.Lookup(netip.MustParseAddr("9::9")))
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "", "", anyIp6.String(), "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.False(t, rules.Out.protos[ProtoAny][0].Any.Any.Any)
|
||||||
|
assert.True(t, rules.Out.protos[ProtoAny][0].Any.Any.LocalCIDR.Lookup(netip.MustParseAddr("9::9")))
|
||||||
|
assert.False(t, rules.Out.protos[ProtoAny][0].Any.Any.LocalCIDR.Lookup(netip.MustParseAddr("1.1.1.1")))
|
||||||
|
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "", "", "any", "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.True(t, rules.Out.protos[ProtoAny][0].Any.Any.Any)
|
||||||
|
|
||||||
|
// Every protocol number is accepted
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(true, math.MaxUint8, 0, 0, []string{}, "", "", "", "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.True(t, rules.In.protos[math.MaxUint8][PortAny].Any.Any.Any)
|
||||||
|
|
||||||
|
// Test error conditions, a bad rule is reported when it's added
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.Error(t, rb.AddRule(true, ProtoAny, 10, 0, []string{}, "", "", "", "", ""))
|
||||||
|
require.Error(t, rb.AddRule(true, ProtoAny, 0, 0, []string{}, "", "junk", "", "", ""))
|
||||||
|
require.Error(t, rb.AddRule(true, ProtoAny, 0, 0, []string{}, "", "", "junk", "", ""))
|
||||||
|
|
||||||
|
// ICMP and ICMPv6 share one copy of each proto `any` rule
|
||||||
|
rb = NewRulesBuilder(l)
|
||||||
|
require.NoError(t, rb.AddRule(true, ProtoAny, PortAny, PortAny, []string{"default-group"}, "", "", "", "", ""))
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolICMPv6, PortAny, PortAny, []string{"nope"}, "", "", "", "", ""))
|
||||||
|
rules = rb.Build(nil, nil)
|
||||||
|
assert.Len(t, rules.In.protos[iputil.IPProtocolICMP][PortAny].Any.Groups, 2)
|
||||||
|
assert.Len(t, rules.In.protos[iputil.IPProtocolICMPv6][PortAny].Any.Groups, 2)
|
||||||
|
|
||||||
|
// No rules allow nothing
|
||||||
|
rules = NewRulesBuilder(l).Build(nil, nil)
|
||||||
|
for proto := range rules.In.protos {
|
||||||
|
assert.Nil(t, rules.In.protos[proto], "proto %d", proto)
|
||||||
|
assert.Nil(t, rules.Out.protos[proto], "proto %d", proto)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRulesBuilder_sharedLocalCIDR ensures local cidrs shared between rules and ports are copied, not changed,
|
||||||
|
// when another rule's local cidrs are added to them. The prefixes share their first octet so the copy has to reach
|
||||||
|
// past the root of the shared table.
|
||||||
|
func TestRulesBuilder_sharedLocalCIDR(t *testing.T) {
|
||||||
|
vpnNetworks := []netip.Prefix{
|
||||||
|
netip.MustParsePrefix("10.1.0.5/16"),
|
||||||
|
netip.MustParsePrefix("10.2.0.5/16"),
|
||||||
|
netip.MustParsePrefix("fd00:1::5/64"),
|
||||||
|
}
|
||||||
|
unsafeNetworks := []netip.Prefix{netip.MustParsePrefix("192.168.0.0/24")}
|
||||||
|
vpn1 := netip.MustParseAddr("10.1.9.9")
|
||||||
|
vpn2 := netip.MustParseAddr("10.2.9.9")
|
||||||
|
vpn6 := netip.MustParseAddr("fd00:1::9")
|
||||||
|
h1Extra := netip.MustParseAddr("10.3.0.1")
|
||||||
|
h1Extra6 := netip.MustParseAddr("fd00:2::1")
|
||||||
|
h2Own := netip.MustParseAddr("10.4.0.1")
|
||||||
|
|
||||||
|
rb := NewRulesBuilder(test.NewLogger())
|
||||||
|
// h1 allows the vpn networks by default on ports 1 and 2, and 10.3.0.0/16 and fd00:2::/64 as well on port 1
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1, 2, nil, "h1", "", "", "", ""))
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1, 1, nil, "h1", "", "10.3.0.0/16", "", ""))
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1, 1, nil, "h1", "", "fd00:2::/64", "", ""))
|
||||||
|
// h2 allows 10.4.0.0/16 on ports 1 and 2, and the vpn networks by default as well on port 1
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1, 2, nil, "h2", "", "10.4.0.0/16", "", ""))
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1, 1, nil, "h2", "", "", "", ""))
|
||||||
|
// h3 only has the default
|
||||||
|
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 3, 3, nil, "h3", "", "", "", ""))
|
||||||
|
rules := rb.Build(vpnNetworks, unsafeNetworks)
|
||||||
|
|
||||||
|
for _, tc := range []struct {
|
||||||
|
port int32
|
||||||
|
host string
|
||||||
|
addr netip.Addr
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{1, "h1", vpn1, true},
|
||||||
|
{1, "h1", vpn2, true},
|
||||||
|
{1, "h1", vpn6, true},
|
||||||
|
{1, "h1", h1Extra, true},
|
||||||
|
{1, "h1", h1Extra6, true},
|
||||||
|
{1, "h1", h2Own, false},
|
||||||
|
{2, "h1", vpn1, true},
|
||||||
|
{2, "h1", h1Extra, false},
|
||||||
|
{2, "h1", h1Extra6, false},
|
||||||
|
{1, "h2", h2Own, true},
|
||||||
|
{1, "h2", vpn1, true},
|
||||||
|
{1, "h2", vpn2, true},
|
||||||
|
{1, "h2", vpn6, true},
|
||||||
|
{1, "h2", h1Extra, false},
|
||||||
|
{2, "h2", h2Own, true},
|
||||||
|
{2, "h2", vpn1, false},
|
||||||
|
{2, "h2", vpn6, false},
|
||||||
|
{3, "h3", vpn1, true},
|
||||||
|
{3, "h3", vpn2, true},
|
||||||
|
{3, "h3", vpn6, true},
|
||||||
|
{3, "h3", h1Extra, false},
|
||||||
|
{3, "h3", h1Extra6, false},
|
||||||
|
{3, "h3", h2Own, false},
|
||||||
|
} {
|
||||||
|
lr := rules.In.protos[iputil.IPProtocolTCP][tc.port].Any.Hosts[tc.host]
|
||||||
|
assert.Equal(t, tc.want, lr.match(&Packet{LocalAddr: tc.addr}, nil), "port %d, %s, %s", tc.port, tc.host, tc.addr)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,188 @@
|
|||||||
|
package firewall
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/netip"
|
||||||
|
|
||||||
|
"github.com/gaissmai/bart"
|
||||||
|
"github.com/slackhq/nebula/cert"
|
||||||
|
"github.com/slackhq/nebula/iputil"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Rules are the Tables built for each direction, with hashes of the rules they were built from
|
||||||
|
type Rules struct {
|
||||||
|
In, Out *Table
|
||||||
|
|
||||||
|
// Hash is a sha256 of the rules, HashFNV is an FNV-1a of them for use as a metric value.
|
||||||
|
// Rule sets with the same rules have the same hashes.
|
||||||
|
Hash string
|
||||||
|
HashFNV uint32
|
||||||
|
}
|
||||||
|
|
||||||
|
// Table holds the rules for one direction, the evaluation order is:
|
||||||
|
// Proto AND port AND (CA SHA or CA name) AND local CIDR AND (group OR groups OR name OR remote CIDR)
|
||||||
|
// A Table doesn't change once built, see RulesBuilder.
|
||||||
|
type Table struct {
|
||||||
|
// protos holds the rules for each IP protocol number, so a packet is only checked against one set of rules.
|
||||||
|
// A protocol with rules of its own also holds a copy of every proto `any` rule, the rest share the proto `any`
|
||||||
|
// rules, which are at protos[ProtoAny]. nil when a protocol has no rules at all.
|
||||||
|
// ICMP and ICMPv6 share one set of rules.
|
||||||
|
protos [256]portRules
|
||||||
|
}
|
||||||
|
|
||||||
|
// Even though ports are uint16, int32 maps are faster for lookup
|
||||||
|
// Plus we can use `-1` for fragment rules
|
||||||
|
type portRules map[int32]*caRules
|
||||||
|
|
||||||
|
// caRules and the types below it only make their maps and tables once a rule needs them, a range of ports
|
||||||
|
// gets a copy for every port so empty ones add up
|
||||||
|
type caRules struct {
|
||||||
|
Any *remoteRules
|
||||||
|
CANames map[string]*remoteRules
|
||||||
|
CAShas map[string]*remoteRules
|
||||||
|
}
|
||||||
|
|
||||||
|
type remoteRules struct {
|
||||||
|
// Any makes Hosts, Groups, and CIDR irrelevant
|
||||||
|
Any *localRules
|
||||||
|
Hosts map[string]*localRules
|
||||||
|
Groups []*groupsRule
|
||||||
|
CIDR *bart.Table[*localRules]
|
||||||
|
}
|
||||||
|
|
||||||
|
type groupsRule struct {
|
||||||
|
Groups []string
|
||||||
|
LocalCIDR *localRules
|
||||||
|
}
|
||||||
|
|
||||||
|
type localRules struct {
|
||||||
|
Any bool
|
||||||
|
// LocalCIDR is always set when Any isn't. It's shared with other localRules, so it's never changed.
|
||||||
|
LocalCIDR *bart.Lite
|
||||||
|
}
|
||||||
|
|
||||||
|
// Match reports whether a rule for the direction p is going allows it
|
||||||
|
func (r *Rules) Match(p *Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
||||||
|
t := r.Out
|
||||||
|
if incoming {
|
||||||
|
t = r.In
|
||||||
|
}
|
||||||
|
return t.Match(p, incoming, c, caPool)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Match reports whether a rule allows p
|
||||||
|
func (t *Table) Match(p *Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
||||||
|
return t.protos[p.Protocol].match(p, incoming, c, caPool)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pr portRules) match(p *Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
||||||
|
// We don't have any allowed ports, bail
|
||||||
|
if pr == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// ICMP has no ports, only the port `any` rules apply, including the ones copied in from proto `any` rules
|
||||||
|
if p.Protocol == iputil.IPProtocolICMP || p.Protocol == iputil.IPProtocolICMPv6 {
|
||||||
|
// port numbers are re-used for connection tracking of ICMP,
|
||||||
|
// but we don't want to actually filter on them.
|
||||||
|
return pr[PortAny].match(p, c, caPool)
|
||||||
|
}
|
||||||
|
|
||||||
|
var port int32
|
||||||
|
|
||||||
|
if p.Fragment {
|
||||||
|
port = PortFragment
|
||||||
|
} else if incoming {
|
||||||
|
port = int32(p.LocalPort)
|
||||||
|
} else {
|
||||||
|
port = int32(p.RemotePort)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Packets without ports (gre, esp, etc) have port 0, which is PortAny, don't check those rules twice
|
||||||
|
if port != PortAny && pr[port].match(p, c, caPool) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return pr[PortAny].match(p, c, caPool)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (cr *caRules) match(p *Packet, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
||||||
|
if cr == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if cr.Any.match(p, c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
if t, ok := cr.CAShas[c.Certificate.Issuer()]; ok {
|
||||||
|
if t.match(p, c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
s, err := caPool.GetCAForCert(c.Certificate)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
return cr.CANames[s.Certificate.Name()].match(p, c)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (rr *remoteRules) match(p *Packet, c *cert.CachedCertificate) bool {
|
||||||
|
if rr == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Shortcut path for if groups, hosts, or cidr contained an `any`
|
||||||
|
if rr.Any.match(p, c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Need any of group, host, or cidr to match
|
||||||
|
for _, sg := range rr.Groups {
|
||||||
|
found := false
|
||||||
|
|
||||||
|
for _, g := range sg.Groups {
|
||||||
|
if _, ok := c.InvertedGroups[g]; !ok {
|
||||||
|
found = false
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
found = true
|
||||||
|
}
|
||||||
|
|
||||||
|
if found && sg.LocalCIDR.match(p, c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if rr.Hosts != nil {
|
||||||
|
if lr, ok := rr.Hosts[c.Certificate.Name()]; ok {
|
||||||
|
if lr.match(p, c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if rr.CIDR != nil {
|
||||||
|
for _, v := range rr.CIDR.Supernets(netip.PrefixFrom(p.RemoteAddr, p.RemoteAddr.BitLen())) {
|
||||||
|
if v.match(p, c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (lr *localRules) match(p *Packet, c *cert.CachedCertificate) bool {
|
||||||
|
if lr == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if lr.Any {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return lr.LocalCIDR.Contains(p.LocalAddr)
|
||||||
|
}
|
||||||
+270
-549
File diff suppressed because it is too large.
Load diff
+5
-18
@@ -31,7 +31,6 @@ package nebula
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bufio"
|
"bufio"
|
||||||
"context"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"net"
|
"net"
|
||||||
"strconv"
|
"strconv"
|
||||||
@@ -52,29 +51,17 @@ type graphiteConfigExport struct {
|
|||||||
Percentiles []float64 // Percentiles to export from timers and histograms
|
Percentiles []float64 // Percentiles to export from timers and histograms
|
||||||
}
|
}
|
||||||
|
|
||||||
// graphiteTimeout bounds one submission, the connect and the write together. An export is a few KB, a host that can't
|
|
||||||
// take that in this long isn't going to.
|
|
||||||
const graphiteTimeout = 30 * time.Second
|
|
||||||
|
|
||||||
// graphiteOnce performs a single submission to Graphite, returning a non-nil
|
// graphiteOnce performs a single submission to Graphite, returning a non-nil
|
||||||
// error if it could not connect or write all of it within timeout. It gives up
|
// error on failed connections.
|
||||||
// as soon as ctx is done.
|
func graphiteOnce(c graphiteConfigExport) error {
|
||||||
func graphiteOnce(ctx context.Context, c graphiteConfigExport, timeout time.Duration) error {
|
|
||||||
now := time.Now().Unix()
|
now := time.Now().Unix()
|
||||||
du := float64(c.DurationUnit)
|
du := float64(c.DurationUnit)
|
||||||
flushSeconds := float64(c.FlushInterval) / float64(time.Second)
|
flushSeconds := float64(c.FlushInterval) / float64(time.Second)
|
||||||
deadline := time.Now().Add(timeout)
|
conn, err := net.DialTCP("tcp", nil, c.Addr)
|
||||||
d := net.Dialer{Deadline: deadline}
|
|
||||||
conn, err := d.DialContext(ctx, "tcp", c.Addr.String())
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
defer conn.Close()
|
defer conn.Close()
|
||||||
if err := conn.SetDeadline(deadline); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
stop := context.AfterFunc(ctx, func() { _ = conn.Close() })
|
|
||||||
defer stop()
|
|
||||||
w := bufio.NewWriter(conn)
|
w := bufio.NewWriter(conn)
|
||||||
c.Registry.Each(func(name string, i any) {
|
c.Registry.Each(func(name string, i any) {
|
||||||
switch metric := i.(type) {
|
switch metric := i.(type) {
|
||||||
@@ -124,7 +111,7 @@ func graphiteOnce(ctx context.Context, c graphiteConfigExport, timeout time.Dura
|
|||||||
fmt.Fprintf(w, "%s.%s.fifteen-minute %.2f %d\n", c.Prefix, name, t.Rate15(), now)
|
fmt.Fprintf(w, "%s.%s.fifteen-minute %.2f %d\n", c.Prefix, name, t.Rate15(), now)
|
||||||
fmt.Fprintf(w, "%s.%s.mean-rate %.2f %d\n", c.Prefix, name, t.RateMean(), now)
|
fmt.Fprintf(w, "%s.%s.mean-rate %.2f %d\n", c.Prefix, name, t.RateMean(), now)
|
||||||
}
|
}
|
||||||
|
w.Flush()
|
||||||
})
|
})
|
||||||
// A failed write sticks, so this reports the first one
|
return nil
|
||||||
return w.Flush()
|
|
||||||
}
|
}
|
||||||
@@ -1,315 +0,0 @@
|
|||||||
package nebula
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"net"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/rcrowley/go-metrics"
|
|
||||||
"github.com/slackhq/nebula/test"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// graphiteHost accepts connections and hands each one to the test
|
|
||||||
type graphiteHost struct {
|
|
||||||
ln net.Listener
|
|
||||||
conns chan net.Conn
|
|
||||||
|
|
||||||
mu sync.Mutex
|
|
||||||
closed bool
|
|
||||||
open []net.Conn
|
|
||||||
}
|
|
||||||
|
|
||||||
// newGraphiteHost accepts connections for the test. A non-zero window shrinks each connection's receive buffer, so a
|
|
||||||
// sender that is not read from blocks after a little whatever the host's TCP tuning. Only for tests that need a stall,
|
|
||||||
// a small window makes reading very slow on Linux.
|
|
||||||
func newGraphiteHost(t *testing.T, window int) *graphiteHost {
|
|
||||||
t.Helper()
|
|
||||||
ln, err := net.Listen("tcp", "127.0.0.1:0")
|
|
||||||
require.NoError(t, err)
|
|
||||||
h := &graphiteHost{ln: ln, conns: make(chan net.Conn, 8)}
|
|
||||||
done := make(chan struct{})
|
|
||||||
t.Cleanup(func() {
|
|
||||||
_ = ln.Close()
|
|
||||||
h.mu.Lock()
|
|
||||||
h.closed = true
|
|
||||||
for _, c := range h.open {
|
|
||||||
_ = c.Close()
|
|
||||||
}
|
|
||||||
h.mu.Unlock()
|
|
||||||
close(done)
|
|
||||||
})
|
|
||||||
go func() {
|
|
||||||
for {
|
|
||||||
c, err := ln.Accept()
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
h.mu.Lock()
|
|
||||||
if h.closed {
|
|
||||||
h.mu.Unlock()
|
|
||||||
_ = c.Close()
|
|
||||||
return
|
|
||||||
}
|
|
||||||
h.open = append(h.open, c)
|
|
||||||
h.mu.Unlock()
|
|
||||||
if tc, ok := c.(*net.TCPConn); ok && window > 0 {
|
|
||||||
_ = tc.SetReadBuffer(window)
|
|
||||||
}
|
|
||||||
select {
|
|
||||||
case h.conns <- c:
|
|
||||||
case <-done:
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
return h
|
|
||||||
}
|
|
||||||
|
|
||||||
func (h *graphiteHost) addr(t *testing.T) *net.TCPAddr {
|
|
||||||
a, err := net.ResolveTCPAddr("tcp", h.ln.Addr().String())
|
|
||||||
require.NoError(t, err)
|
|
||||||
return a
|
|
||||||
}
|
|
||||||
|
|
||||||
// readExport reads what one send wrote, bounded so a send that never finishes fails the test rather than hanging it
|
|
||||||
func readExport(t *testing.T, c net.Conn) []byte {
|
|
||||||
t.Helper()
|
|
||||||
require.NoError(t, c.SetReadDeadline(time.Now().Add(10*time.Second)))
|
|
||||||
b, err := io.ReadAll(c)
|
|
||||||
require.NoError(t, err)
|
|
||||||
return b
|
|
||||||
}
|
|
||||||
|
|
||||||
func (h *graphiteHost) next(t *testing.T, wait time.Duration) net.Conn {
|
|
||||||
t.Helper()
|
|
||||||
select {
|
|
||||||
case c := <-h.conns:
|
|
||||||
return c
|
|
||||||
case <-time.After(wait):
|
|
||||||
t.Fatal("no connection")
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// lockedBuffer is a log destination a test can read while the code under test writes to it from another goroutine
|
|
||||||
type lockedBuffer struct {
|
|
||||||
mu sync.Mutex
|
|
||||||
buf bytes.Buffer
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b *lockedBuffer) Write(p []byte) (int, error) {
|
|
||||||
b.mu.Lock()
|
|
||||||
defer b.mu.Unlock()
|
|
||||||
return b.buf.Write(p)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b *lockedBuffer) String() string {
|
|
||||||
b.mu.Lock()
|
|
||||||
defer b.mu.Unlock()
|
|
||||||
return b.buf.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
func testGraphiteConfig(addr *net.TCPAddr, r metrics.Registry) graphiteConfigExport {
|
|
||||||
return graphiteConfigExport{Addr: addr, Registry: r, FlushInterval: time.Second, DurationUnit: time.Nanosecond, Prefix: "nebula"}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Enough metrics that one export overflows the socket buffers on any platform, so a send to a host that stops
|
|
||||||
// reading blocks
|
|
||||||
func bigGraphiteRegistry(r metrics.Registry, t *testing.T) {
|
|
||||||
for i := range 200000 {
|
|
||||||
name := fmt.Sprintf("big.gauge.%d", i)
|
|
||||||
metrics.GetOrRegisterGauge(name, r).Update(int64(i))
|
|
||||||
t.Cleanup(func() { r.Unregister(name) })
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGraphiteOnce_sends(t *testing.T) {
|
|
||||||
r := metrics.NewRegistry()
|
|
||||||
metrics.GetOrRegisterGauge("g", r).Update(7)
|
|
||||||
metrics.GetOrRegisterCounter("c", r).Inc(3)
|
|
||||||
h := newGraphiteHost(t, 0)
|
|
||||||
|
|
||||||
require.NoError(t, graphiteOnce(t.Context(), testGraphiteConfig(h.addr(t), r), time.Minute))
|
|
||||||
b := readExport(t, h.next(t, 5*time.Second))
|
|
||||||
assert.Contains(t, string(b), "nebula.g.value 7 ")
|
|
||||||
assert.Contains(t, string(b), "nebula.c.count 3 ")
|
|
||||||
assert.Contains(t, string(b), "nebula.c.count_ps 3.00 ")
|
|
||||||
}
|
|
||||||
|
|
||||||
// A host that accepts and never reads is given up on, and the failed write is reported
|
|
||||||
func TestGraphiteOnce_stalledHostTimesOut(t *testing.T) {
|
|
||||||
r := metrics.NewRegistry()
|
|
||||||
bigGraphiteRegistry(r, t)
|
|
||||||
h := newGraphiteHost(t, 4096)
|
|
||||||
done := make(chan error, 1)
|
|
||||||
cfg := testGraphiteConfig(h.addr(t), r)
|
|
||||||
go func() { done <- graphiteOnce(t.Context(), cfg, 300*time.Millisecond) }()
|
|
||||||
h.next(t, 5*time.Second) // accepted, never read
|
|
||||||
|
|
||||||
select {
|
|
||||||
case err := <-done:
|
|
||||||
require.Error(t, err)
|
|
||||||
case <-time.After(10 * time.Second):
|
|
||||||
t.Fatal("the send did not give up on a host that stopped reading")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The timeout covers the whole send, a host that keeps reading but too slowly is still given up on
|
|
||||||
func TestGraphiteOnce_timeoutCoversTheWholeSend(t *testing.T) {
|
|
||||||
r := metrics.NewRegistry()
|
|
||||||
bigGraphiteRegistry(r, t)
|
|
||||||
h := newGraphiteHost(t, 0)
|
|
||||||
done := make(chan error, 1)
|
|
||||||
start := time.Now()
|
|
||||||
cfg := testGraphiteConfig(h.addr(t), r)
|
|
||||||
go func() { done <- graphiteOnce(t.Context(), cfg, 500*time.Millisecond) }()
|
|
||||||
c := h.next(t, 5*time.Second)
|
|
||||||
stopReading := make(chan struct{})
|
|
||||||
defer close(stopReading)
|
|
||||||
// 32KB every 10ms keeps every write well inside the timeout, the whole export takes seconds
|
|
||||||
go func() {
|
|
||||||
buf := make([]byte, 32<<10)
|
|
||||||
for {
|
|
||||||
select {
|
|
||||||
case <-stopReading:
|
|
||||||
return
|
|
||||||
case <-time.After(10 * time.Millisecond):
|
|
||||||
}
|
|
||||||
if _, err := c.Read(buf); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case err := <-done:
|
|
||||||
require.Error(t, err)
|
|
||||||
assert.Less(t, time.Since(start), 5*time.Second)
|
|
||||||
case <-time.After(10 * time.Second):
|
|
||||||
t.Fatal("a host that kept reading slowly held the send past its timeout")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGraphiteOnce_cancelledCtxDoesNotConnect(t *testing.T) {
|
|
||||||
h := newGraphiteHost(t, 0)
|
|
||||||
ctx, cancel := context.WithCancel(t.Context())
|
|
||||||
cancel()
|
|
||||||
require.Error(t, graphiteOnce(ctx, testGraphiteConfig(h.addr(t), metrics.NewRegistry()), time.Minute))
|
|
||||||
select {
|
|
||||||
case <-h.conns:
|
|
||||||
t.Fatal("connected on a cancelled ctx")
|
|
||||||
case <-time.After(200 * time.Millisecond):
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A stop or reload abandons a stuck send rather than waiting out its timeout
|
|
||||||
func TestGraphiteOnce_cancelAbandonsSend(t *testing.T) {
|
|
||||||
r := metrics.NewRegistry()
|
|
||||||
bigGraphiteRegistry(r, t)
|
|
||||||
h := newGraphiteHost(t, 4096)
|
|
||||||
ctx, cancel := context.WithCancel(t.Context())
|
|
||||||
done := make(chan error, 1)
|
|
||||||
cfg := testGraphiteConfig(h.addr(t), r)
|
|
||||||
go func() { done <- graphiteOnce(ctx, cfg, time.Minute) }()
|
|
||||||
h.next(t, 5*time.Second)
|
|
||||||
select {
|
|
||||||
case err := <-done:
|
|
||||||
t.Fatalf("the send should be stuck on a host that is not reading, it ended with %v", err)
|
|
||||||
case <-time.After(200 * time.Millisecond):
|
|
||||||
}
|
|
||||||
|
|
||||||
cancel()
|
|
||||||
select {
|
|
||||||
case err := <-done:
|
|
||||||
require.Error(t, err)
|
|
||||||
case <-time.After(5 * time.Second):
|
|
||||||
t.Fatal("the send is still stuck after its ctx was cancelled")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// buildRuntime hands graphite the configured prefix and interval
|
|
||||||
func TestStatsServer_graphiteExportUsesConfig(t *testing.T) {
|
|
||||||
const name = "graphite.wiring.test"
|
|
||||||
metrics.GetOrRegisterCounter(name, nil).Inc(8)
|
|
||||||
t.Cleanup(func() { metrics.DefaultRegistry.Unregister(name) })
|
|
||||||
h := newGraphiteHost(t, 0)
|
|
||||||
s, c := newTestStatsServer(t)
|
|
||||||
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "4s", "prefix": "pfx", "host": h.ln.Addr().String()})
|
|
||||||
cfg, err := loadStatsConfig(c)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
s.runMu.Lock()
|
|
||||||
fns, _ := s.buildRuntime(t.Context(), cfg)
|
|
||||||
s.runMu.Unlock()
|
|
||||||
for _, fn := range fns {
|
|
||||||
fn()
|
|
||||||
}
|
|
||||||
b := readExport(t, h.next(t, 5*time.Second))
|
|
||||||
assert.Contains(t, string(b), "pfx."+name+".count 8 ")
|
|
||||||
assert.Contains(t, string(b), "pfx."+name+".count_ps 2.00 ")
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStatsServer_graphiteFailureIsLogged(t *testing.T) {
|
|
||||||
logs := &lockedBuffer{}
|
|
||||||
s, c := newTestStatsServer(t)
|
|
||||||
s.l = test.NewLoggerWithOutput(logs)
|
|
||||||
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "1h", "host": "127.0.0.1:" + freeTCPPort(t)})
|
|
||||||
cfg, err := loadStatsConfig(c)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
s.runMu.Lock()
|
|
||||||
fns, _ := s.buildRuntime(t.Context(), cfg)
|
|
||||||
s.runMu.Unlock()
|
|
||||||
for _, fn := range fns {
|
|
||||||
fn()
|
|
||||||
}
|
|
||||||
assert.Contains(t, logs.String(), "Graphite export failed")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Stop abandons the running export, so it goes through Start rather than handing buildRuntime a ctx, and a stop is
|
|
||||||
// not logged as a failure
|
|
||||||
func TestStatsServer_stopAbandonsGraphiteSend(t *testing.T) {
|
|
||||||
bigGraphiteRegistry(metrics.DefaultRegistry, t)
|
|
||||||
h := newGraphiteHost(t, 4096)
|
|
||||||
logs := &lockedBuffer{}
|
|
||||||
s, c := newTestStatsServer(t)
|
|
||||||
s.l = test.NewLoggerWithOutput(logs)
|
|
||||||
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "50ms", "host": h.ln.Addr().String()})
|
|
||||||
require.NoError(t, s.reload(c, true))
|
|
||||||
|
|
||||||
started := make(chan struct{})
|
|
||||||
go func() {
|
|
||||||
s.Start()
|
|
||||||
close(started)
|
|
||||||
}()
|
|
||||||
stuck := h.next(t, 30*time.Second)
|
|
||||||
s.Stop()
|
|
||||||
select {
|
|
||||||
case <-started:
|
|
||||||
case <-time.After(5 * time.Second):
|
|
||||||
t.Fatal("Start did not return after Stop")
|
|
||||||
}
|
|
||||||
|
|
||||||
// A closed sender resets the connection once it sees this, one still sending just buffers it. Either way the
|
|
||||||
// read below doesn't have to drain the export through the small window to find out
|
|
||||||
_, err := stuck.Write([]byte("x"))
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, stuck.SetReadDeadline(time.Now().Add(10*time.Second)))
|
|
||||||
n, err := io.Copy(io.Discard, stuck)
|
|
||||||
var ne net.Error
|
|
||||||
if errors.As(err, &ne) && ne.Timeout() {
|
|
||||||
t.Fatalf("the send kept the connection after Stop, read %d bytes", n)
|
|
||||||
}
|
|
||||||
assert.Less(t, n, int64(1<<20), "the send kept going after Stop")
|
|
||||||
// The capture loop logs on its own goroutine after Start has returned, give it the chance
|
|
||||||
assert.Never(t, func() bool { return strings.Contains(logs.String(), "Graphite export failed") }, 500*time.Millisecond, 10*time.Millisecond, "a stop is not a failure")
|
|
||||||
}
|
|
||||||
+11
-8
@@ -54,8 +54,7 @@ type HandshakeConfig struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type HandshakeManager struct {
|
type HandshakeManager struct {
|
||||||
// Mutex for interacting with the vpnIps and indexes maps.
|
// Mutex for interacting with the vpnIps and indexes maps
|
||||||
// Lock order is hostmap, then this lock, then the lighthouse, then a RemoteList.
|
|
||||||
sync.RWMutex
|
sync.RWMutex
|
||||||
|
|
||||||
vpnIps map[netip.Addr]*HandshakeHostInfo
|
vpnIps map[netip.Addr]*HandshakeHostInfo
|
||||||
@@ -260,6 +259,14 @@ func (hm *HandshakeManager) handleOutbound(vpnIp netip.Addr, lighthouseTriggered
|
|||||||
"style": header.SubTypeName(header.Handshake, hh.machine.Subtype()),
|
"style": header.SubTypeName(header.Handshake, hh.machine.Subtype()),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Get a remotes object if we don't already have one.
|
||||||
|
// This is mainly to protect us as this should never be the case
|
||||||
|
// NB ^ This comment doesn't jive. It's how the thing gets initialized.
|
||||||
|
// It's the common path. Should it update every time, in case a future LH query/queries give us more info?
|
||||||
|
if hostinfo.remotes == nil {
|
||||||
|
hostinfo.remotes = hm.lightHouse.QueryCache([]netip.Addr{vpnIp})
|
||||||
|
}
|
||||||
|
|
||||||
remotes := hostinfo.remotes.CopyAddrs(hm.mainHostMap.GetPreferredRanges())
|
remotes := hostinfo.remotes.CopyAddrs(hm.mainHostMap.GetPreferredRanges())
|
||||||
remotesHaveChanged := !slices.Equal(remotes, hh.lastRemotes)
|
remotesHaveChanged := !slices.Equal(remotes, hh.lastRemotes)
|
||||||
|
|
||||||
@@ -364,9 +371,6 @@ func (hm *HandshakeManager) StartHandshake(vpnAddr netip.Addr, cacheCb func(*Han
|
|||||||
hostinfo := &HostInfo{
|
hostinfo := &HostInfo{
|
||||||
vpnAddrs: []netip.Addr{vpnAddr},
|
vpnAddrs: []netip.Addr{vpnAddr},
|
||||||
HandshakePacket: make(map[uint8][]byte, 0),
|
HandshakePacket: make(map[uint8][]byte, 0),
|
||||||
// Attached here so a pending hostinfo never exists without one: SetRemote dereferences
|
|
||||||
// it, and create-tunnel -address can reach SetRemote before the handshake loop runs.
|
|
||||||
remotes: hm.lightHouse.QueryCache([]netip.Addr{vpnAddr}),
|
|
||||||
relayState: RelayState{
|
relayState: RelayState{
|
||||||
relays: nil,
|
relays: nil,
|
||||||
relayForByAddr: map[netip.Addr]*Relay{},
|
relayForByAddr: map[netip.Addr]*Relay{},
|
||||||
@@ -942,14 +946,13 @@ func (hm *HandshakeManager) continueHandshake(via ViaSender, hh *HandshakeHostIn
|
|||||||
|
|
||||||
hm.DeleteHostInfo(hostinfo)
|
hm.DeleteHostInfo(hostinfo)
|
||||||
hm.StartHandshake(hostinfo.vpnAddrs[0], func(newHH *HandshakeHostInfo) {
|
hm.StartHandshake(hostinfo.vpnAddrs[0], func(newHH *HandshakeHostInfo) {
|
||||||
|
newHH.hostinfo.remotes = hostinfo.remotes
|
||||||
newHH.hostinfo.remotes.BlockRemote(via)
|
newHH.hostinfo.remotes.BlockRemote(via)
|
||||||
newHH.packetStore = hh.packetStore
|
newHH.packetStore = hh.packetStore
|
||||||
hh.packetStore = []*cachedPacket{}
|
hh.packetStore = []*cachedPacket{}
|
||||||
})
|
|
||||||
// sendCloseTunnel may take the hostmap lock, so it must not run under the handshake
|
|
||||||
// manager lock that StartHandshake holds around the callback.
|
|
||||||
hostinfo.vpnAddrs = vpnAddrs
|
hostinfo.vpnAddrs = vpnAddrs
|
||||||
f.sendCloseTunnel(hostinfo)
|
f.sendCloseTunnel(hostinfo)
|
||||||
|
})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ import (
|
|||||||
"github.com/slackhq/nebula/test"
|
"github.com/slackhq/nebula/test"
|
||||||
"github.com/slackhq/nebula/udp"
|
"github.com/slackhq/nebula/udp"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func Test_NewHandshakeManagerVpnIp(t *testing.T) {
|
func Test_NewHandshakeManagerVpnIp(t *testing.T) {
|
||||||
@@ -43,6 +42,8 @@ func Test_NewHandshakeManagerVpnIp(t *testing.T) {
|
|||||||
i2 := blah.StartHandshake(ip, nil)
|
i2 := blah.StartHandshake(ip, nil)
|
||||||
assert.Same(t, i, i2)
|
assert.Same(t, i, i2)
|
||||||
|
|
||||||
|
i.remotes = NewRemoteList([]netip.Addr{}, nil)
|
||||||
|
|
||||||
// Adding something to pending should not affect the main hostmap
|
// Adding something to pending should not affect the main hostmap
|
||||||
assert.Empty(t, mainHM.Hosts)
|
assert.Empty(t, mainHM.Hosts)
|
||||||
|
|
||||||
@@ -234,70 +235,3 @@ func TestHandleIncomingDispatch(t *testing.T) {
|
|||||||
assert.Empty(t, hm.indexes, "orphan stage-2 must not create state")
|
assert.Empty(t, hm.indexes, "orphan stage-2 must not create state")
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// Test_PendingHandshakeHasRemotes covers create-tunnel -address: a pending hostinfo must already
|
|
||||||
// carry its RemoteList when StartHandshake runs its callback, so SetRemote there, before the
|
|
||||||
// handshake loop has run, is safe and the address becomes one the handshake is sent to.
|
|
||||||
func Test_PendingHandshakeHasRemotes(t *testing.T) {
|
|
||||||
l := test.NewLogger()
|
|
||||||
mainHM := newHostMap(l)
|
|
||||||
preferredRanges := []netip.Prefix{}
|
|
||||||
mainHM.preferredRanges.Store(&preferredRanges)
|
|
||||||
|
|
||||||
hm := NewHandshakeManager(l, mainHM, newTestLighthouse(), &udp.NoopConn{}, defaultHandshakeConfig)
|
|
||||||
|
|
||||||
vpnIp := netip.MustParseAddr("172.1.1.2")
|
|
||||||
remote := netip.MustParseAddrPort("192.168.1.9:4242")
|
|
||||||
|
|
||||||
hi := hm.StartHandshake(vpnIp, func(hh *HandshakeHostInfo) {
|
|
||||||
require.NotNil(t, hh.hostinfo.remotes, "a pending handshake must never be without its RemoteList")
|
|
||||||
hh.hostinfo.SetRemote(remote)
|
|
||||||
})
|
|
||||||
assert.Contains(t, hi.remotes.CopyAddrs(preferredRanges), remote, "the handshake must be sent to the supplied remote")
|
|
||||||
assert.Equal(t, remote, hi.GetRemote())
|
|
||||||
|
|
||||||
// A RemoteList keeps one learned address per host, so a second remote replaces the
|
|
||||||
// first — the same behaviour change-remote has on an established tunnel.
|
|
||||||
other := netip.MustParseAddrPort("192.168.1.10:4242")
|
|
||||||
hi.SetRemote(other)
|
|
||||||
assert.Equal(t, []netip.AddrPort{other}, hi.remotes.CopyAddrs(preferredRanges))
|
|
||||||
assert.Equal(t, other, hi.GetRemote())
|
|
||||||
}
|
|
||||||
|
|
||||||
// newRemotesRaceFixture builds a handshake manager with an established tunnel to vpnAddr whose
|
|
||||||
// RemoteList is the lighthouse's cached list, the state every teardown-during-handshake race starts from.
|
|
||||||
func newRemotesRaceFixture(t *testing.T, vpnAddr netip.Addr) (*HandshakeManager, *Interface, *HostInfo) {
|
|
||||||
t.Helper()
|
|
||||||
l := test.NewLogger()
|
|
||||||
mainHM := newHostMap(l)
|
|
||||||
preferredRanges := []netip.Prefix{}
|
|
||||||
mainHM.preferredRanges.Store(&preferredRanges)
|
|
||||||
|
|
||||||
lh := newTestLighthouse()
|
|
||||||
hm := NewHandshakeManager(l, mainHM, lh, &udp.NoopConn{}, defaultHandshakeConfig)
|
|
||||||
f := &Interface{hostMap: mainHM, lightHouse: lh, handshakeManager: hm, l: l}
|
|
||||||
hm.f = f
|
|
||||||
|
|
||||||
established := &HostInfo{
|
|
||||||
vpnAddrs: []netip.Addr{vpnAddr},
|
|
||||||
localIndexId: 1,
|
|
||||||
remoteIndexId: 101,
|
|
||||||
remotes: lh.QueryCache([]netip.Addr{vpnAddr}),
|
|
||||||
HandshakePacket: map[uint8][]byte{},
|
|
||||||
}
|
|
||||||
mainHM.Lock()
|
|
||||||
mainHM.unlockedAddHostInfo(established, f)
|
|
||||||
mainHM.Unlock()
|
|
||||||
|
|
||||||
return hm, f, established
|
|
||||||
}
|
|
||||||
|
|
||||||
// With no handshake pending, tearing down the last tunnel still evicts the list.
|
|
||||||
func Test_CloseTunnelEvictsWithoutPendingHandshake(t *testing.T) {
|
|
||||||
vpnAddr := netip.MustParseAddr("172.1.1.2")
|
|
||||||
_, f, established := newRemotesRaceFixture(t, vpnAddr)
|
|
||||||
|
|
||||||
f.closeTunnel(established)
|
|
||||||
assert.NotContains(t, f.hostMap.Hosts, vpnAddr)
|
|
||||||
assert.NotContains(t, f.lightHouse.addrMap, vpnAddr)
|
|
||||||
}
|
|
||||||
@@ -24,11 +24,6 @@ type m = map[string]any
|
|||||||
const (
|
const (
|
||||||
Version uint8 = 1
|
Version uint8 = 1
|
||||||
Len = 16
|
Len = 16
|
||||||
|
|
||||||
// MaxOverhead is the most a payload grows on its way to the underlay.
|
|
||||||
// A relayed packet has two headers and two AEAD tags, one for the inner tunnel and another for the relay tunnel.
|
|
||||||
// Every supported cipher (today) has a 16 byte tag.
|
|
||||||
MaxOverhead = 2 * (Len + 16)
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type MessageType uint8
|
type MessageType uint8
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ import (
|
|||||||
"github.com/slackhq/nebula/firewall"
|
"github.com/slackhq/nebula/firewall"
|
||||||
"github.com/slackhq/nebula/header"
|
"github.com/slackhq/nebula/header"
|
||||||
"github.com/slackhq/nebula/iputil"
|
"github.com/slackhq/nebula/iputil"
|
||||||
"github.com/slackhq/nebula/logging"
|
|
||||||
"github.com/slackhq/nebula/noiseutil"
|
"github.com/slackhq/nebula/noiseutil"
|
||||||
"github.com/slackhq/nebula/overlay/batch"
|
"github.com/slackhq/nebula/overlay/batch"
|
||||||
"github.com/slackhq/nebula/overlay/tio"
|
"github.com/slackhq/nebula/overlay/tio"
|
||||||
@@ -199,8 +198,8 @@ func (f *Interface) sendInsideMessage(hostinfo *HostInfo, pkt tio.Packet, nb []b
|
|||||||
}
|
}
|
||||||
|
|
||||||
err = tio.SegmentSuperpacket(pkt, func(seg []byte) error {
|
err = tio.SegmentSuperpacket(pkt, func(seg []byte) error {
|
||||||
//relay header + header + plaintext + AEAD tag + relay tag
|
//relay header + header + plaintext + AEAD tag (16 bytes for both AES-GCM and ChaCha20-Poly1305) + relay tag
|
||||||
scratch := sendBatch.Reserve(len(seg) + header.MaxOverhead)
|
scratch := sendBatch.Reserve(header.Len + header.Len + len(seg) + 16 + 16)
|
||||||
|
|
||||||
innerPacket := f.sendInsideEncrypt(hostinfo, ci, seg, scratch[header.Len:], nb)
|
innerPacket := f.sendInsideEncrypt(hostinfo, ci, seg, scratch[header.Len:], nb)
|
||||||
if innerPacket == nil {
|
if innerPacket == nil {
|
||||||
@@ -518,9 +517,7 @@ func (f *Interface) SendVia(via *HostInfo, relay *Relay, ad, nb, out []byte, noc
|
|||||||
|
|
||||||
err = f.writers[q].WriteTo(toSend, via.GetRemote())
|
err = f.writers[q].WriteTo(toSend, via.GetRemote())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if l, ok := logging.RateLimited(f.l, f.udpRelayTxErrLimiter); ok {
|
via.logger(f.l).Info("Failed to WriteTo in sendVia", "error", err)
|
||||||
via.logger(l).Info("Failed to WriteTo in sendVia", "error", err)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -529,26 +526,16 @@ func (f *Interface) sendNoMetrics(t header.MessageType, st header.MessageSubType
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
useRelay := !remote.IsValid() && !hostinfo.GetRemote().IsValid()
|
useRelay := !remote.IsValid() && !hostinfo.GetRemote().IsValid()
|
||||||
|
|
||||||
// The encrypt appends to out in place and a relayed packet is then wrapped in place,
|
|
||||||
// so out has to fit the whole packet up front or the encrypt reallocates out from under SendVia.
|
|
||||||
// We cap the MTU of tun devices and routes we create ourselves, so only a host that set a bigger MTU than we allow gets here.
|
|
||||||
need := header.Len + len(p) + ci.eKey.Overhead()
|
|
||||||
if useRelay {
|
|
||||||
// The relay tunnel runs the same cipher, and adds its own header and tag
|
|
||||||
need += header.Len + ci.eKey.Overhead()
|
|
||||||
}
|
|
||||||
if cap(out) < need {
|
|
||||||
if l, ok := logging.RateLimited(f.l, f.txOversizeLimiter); ok {
|
|
||||||
hostinfo.logger(l).Error("Dropping outbound packet, out buffer not large enough", "outCap", cap(out), "payloadLen", len(p), "relayed", useRelay)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
fullOut := out
|
fullOut := out
|
||||||
|
|
||||||
if useRelay {
|
if useRelay {
|
||||||
|
if len(out) < header.Len {
|
||||||
|
// out always has a capacity of mtu, but not always a length greater than the header.Len.
|
||||||
|
// Grow it to make sure the next operation works.
|
||||||
|
out = out[:header.Len]
|
||||||
|
}
|
||||||
// Save a header's worth of data at the front of the 'out' buffer.
|
// Save a header's worth of data at the front of the 'out' buffer.
|
||||||
out = out[header.Len:header.Len]
|
out = out[header.Len:]
|
||||||
}
|
}
|
||||||
|
|
||||||
if noiseutil.EncryptLockNeeded {
|
if noiseutil.EncryptLockNeeded {
|
||||||
@@ -595,23 +582,19 @@ func (f *Interface) sendNoMetrics(t header.MessageType, st header.MessageSubType
|
|||||||
if remote.IsValid() {
|
if remote.IsValid() {
|
||||||
err = f.writers[q].WriteTo(out, remote)
|
err = f.writers[q].WriteTo(out, remote)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if l, ok := logging.RateLimited(f.l, f.udpTxErrLimiter); ok {
|
hostinfo.logger(f.l).Error("Failed to write outgoing packet",
|
||||||
hostinfo.logger(l).Error("Failed to write outgoing packet",
|
|
||||||
"error", err,
|
"error", err,
|
||||||
"udpAddr", remote,
|
"udpAddr", remote,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
|
||||||
} else if hr := hostinfo.GetRemote(); hr.IsValid() {
|
} else if hr := hostinfo.GetRemote(); hr.IsValid() {
|
||||||
err = f.writers[q].WriteTo(out, hr)
|
err = f.writers[q].WriteTo(out, hr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if l, ok := logging.RateLimited(f.l, f.udpTxErrLimiter); ok {
|
hostinfo.logger(f.l).Error("Failed to write outgoing packet",
|
||||||
hostinfo.logger(l).Error("Failed to write outgoing packet",
|
|
||||||
"error", err,
|
"error", err,
|
||||||
"udpAddr", hr,
|
"udpAddr", hr,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
// Try to send via a relay
|
// Try to send via a relay
|
||||||
for _, relayIP := range hostinfo.relayState.CopyRelayIps() {
|
for _, relayIP := range hostinfo.relayState.CopyRelayIps() {
|
||||||
|
|||||||
+18
-24
@@ -24,7 +24,6 @@ import (
|
|||||||
"github.com/slackhq/nebula/overlay"
|
"github.com/slackhq/nebula/overlay"
|
||||||
"github.com/slackhq/nebula/overlay/batch"
|
"github.com/slackhq/nebula/overlay/batch"
|
||||||
"github.com/slackhq/nebula/overlay/tio"
|
"github.com/slackhq/nebula/overlay/tio"
|
||||||
"github.com/slackhq/nebula/ratelimit"
|
|
||||||
"github.com/slackhq/nebula/udp"
|
"github.com/slackhq/nebula/udp"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -125,10 +124,6 @@ type Interface struct {
|
|||||||
batchers []*batch.MultiCoalescer
|
batchers []*batch.MultiCoalescer
|
||||||
wg sync.WaitGroup
|
wg sync.WaitGroup
|
||||||
|
|
||||||
udpTxErrLimiter *ratelimit.Limiter // udp direct transmit error log limiter
|
|
||||||
udpRelayTxErrLimiter *ratelimit.Limiter // udp relay transmit error log limiter
|
|
||||||
txOversizeLimiter *ratelimit.Limiter // oversized outbound packet drop log limiter
|
|
||||||
|
|
||||||
// fatalErr holds the first unexpected reader error that caused shutdown.
|
// fatalErr holds the first unexpected reader error that caused shutdown.
|
||||||
// nil means "no fatal error" (yet)
|
// nil means "no fatal error" (yet)
|
||||||
fatalErr atomic.Pointer[error]
|
fatalErr atomic.Pointer[error]
|
||||||
@@ -203,19 +198,6 @@ func NewInterface(ctx context.Context, c *InterfaceConfig) (*Interface, error) {
|
|||||||
return nil, errors.New("no connection manager")
|
return nil, errors.New("no connection manager")
|
||||||
}
|
}
|
||||||
|
|
||||||
udpTxErrLimiter, err := ratelimit.New(1, time.Second)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
udpRelayTxErrLimiter, err := ratelimit.New(1, time.Second)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
txOversizeLimiter, err := ratelimit.New(1, time.Second)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if c.routines <= 1 {
|
if c.routines <= 1 {
|
||||||
c.PinThreads = false //pinning is not useful unless there's more than one tun reader
|
c.PinThreads = false //pinning is not useful unless there's more than one tun reader
|
||||||
}
|
}
|
||||||
@@ -248,9 +230,6 @@ func NewInterface(ctx context.Context, c *InterfaceConfig) (*Interface, error) {
|
|||||||
conntrackCacheTimeout: c.ConntrackCacheTimeout,
|
conntrackCacheTimeout: c.ConntrackCacheTimeout,
|
||||||
cpuAffinity: c.CpuAffinity,
|
cpuAffinity: c.CpuAffinity,
|
||||||
pinThreads: c.PinThreads,
|
pinThreads: c.PinThreads,
|
||||||
udpTxErrLimiter: udpTxErrLimiter,
|
|
||||||
udpRelayTxErrLimiter: udpRelayTxErrLimiter,
|
|
||||||
txOversizeLimiter: txOversizeLimiter,
|
|
||||||
|
|
||||||
metricHandshakes: metrics.GetOrRegisterHistogram("handshakes", nil, metrics.NewExpDecaySample(1028, 0.015)),
|
metricHandshakes: metrics.GetOrRegisterHistogram("handshakes", nil, metrics.NewExpDecaySample(1028, 0.015)),
|
||||||
metricTxDropped: metrics.GetOrRegisterCounter("udp.tx.dropped", nil),
|
metricTxDropped: metrics.GetOrRegisterCounter("udp.tx.dropped", nil),
|
||||||
@@ -645,15 +624,17 @@ func (f *Interface) reloadMisc(c *config.C) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// statsEmitter updates the interface's gauges, the stats server runs it on its capture loop.
|
func (f *Interface) emitStats(ctx context.Context, i time.Duration) {
|
||||||
func (f *Interface) statsEmitter() func() {
|
ticker := time.NewTicker(i)
|
||||||
|
defer ticker.Stop()
|
||||||
|
|
||||||
udpStats := udp.NewUDPStatsEmitter(f.writers)
|
udpStats := udp.NewUDPStatsEmitter(f.writers)
|
||||||
|
|
||||||
certExpirationGauge := metrics.GetOrRegisterGauge("certificate.ttl_seconds", nil)
|
certExpirationGauge := metrics.GetOrRegisterGauge("certificate.ttl_seconds", nil)
|
||||||
certInitiatingVersion := metrics.GetOrRegisterGauge("certificate.initiating_version", nil)
|
certInitiatingVersion := metrics.GetOrRegisterGauge("certificate.initiating_version", nil)
|
||||||
certMaxVersion := metrics.GetOrRegisterGauge("certificate.max_version", nil)
|
certMaxVersion := metrics.GetOrRegisterGauge("certificate.max_version", nil)
|
||||||
|
|
||||||
return func() {
|
emit := func() {
|
||||||
f.firewall.EmitStats()
|
f.firewall.EmitStats()
|
||||||
f.handshakeManager.EmitStats()
|
f.handshakeManager.EmitStats()
|
||||||
udpStats()
|
udpStats()
|
||||||
@@ -670,6 +651,19 @@ func (f *Interface) statsEmitter() func() {
|
|||||||
certMaxVersion.Update(int64(certState.v1Cert.Version()))
|
certMaxVersion.Update(int64(certState.v1Cert.Version()))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Prime gauges so a Prometheus scrape that lands before the first tick
|
||||||
|
// sees real values instead of the zero defaults (issue #907).
|
||||||
|
emit()
|
||||||
|
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-ticker.C:
|
||||||
|
emit()
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *Interface) GetHostInfo(vpnIp netip.Addr) *HostInfo {
|
func (f *Interface) GetHostInfo(vpnIp netip.Addr) *HostInfo {
|
||||||
|
|||||||
+14
-5
@@ -3,6 +3,7 @@
|
|||||||
package nebula
|
package nebula
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
@@ -17,8 +18,11 @@ import (
|
|||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Priming before the first tick (issue #907) is Start's job, see TestStatsServer_Start_primes.
|
// Test_emitStats_primesGauges covers issue #907: a Prometheus scrape that
|
||||||
func Test_statsEmitter_setsGauges(t *testing.T) {
|
// landed before the first ticker fire used to read 0 for the cert gauges.
|
||||||
|
// emitStats now primes the gauges before entering the ticker loop. We assert
|
||||||
|
// the gauge is zero before the first call and non-zero after.
|
||||||
|
func Test_emitStats_primesGauges(t *testing.T) {
|
||||||
defer metrics.DefaultRegistry.UnregisterAll()
|
defer metrics.DefaultRegistry.UnregisterAll()
|
||||||
|
|
||||||
l := test.NewLogger()
|
l := test.NewLogger()
|
||||||
@@ -52,12 +56,17 @@ func Test_statsEmitter_setsGauges(t *testing.T) {
|
|||||||
ifce.pki.cs.Store(cs)
|
ifce.pki.cs.Store(cs)
|
||||||
|
|
||||||
ttlGauge := metrics.GetOrRegisterGauge("certificate.ttl_seconds", nil)
|
ttlGauge := metrics.GetOrRegisterGauge("certificate.ttl_seconds", nil)
|
||||||
require.Zero(t, ttlGauge.Value(), "gauge should be zero before the emitter runs")
|
require.Zero(t, ttlGauge.Value(), "gauge should be zero before emitStats runs")
|
||||||
|
|
||||||
ifce.statsEmitter()()
|
// Pre-cancel the context so emitStats returns after priming the gauges
|
||||||
|
// without ever reading from ticker.C. The one hour interval is just a
|
||||||
|
// belt-and-suspenders, the test does not expect the ticker to fire.
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
ifce.emitStats(ctx, time.Hour)
|
||||||
|
|
||||||
ttl := ttlGauge.Value()
|
ttl := ttlGauge.Value()
|
||||||
assert.Positive(t, ttl, "ttl gauge should be set by one run of the emitter")
|
assert.Positive(t, ttl, "ttl gauge should be primed by emitStats before its first tick")
|
||||||
assert.LessOrEqual(t, ttl, int64(3600))
|
assert.LessOrEqual(t, ttl, int64(3600))
|
||||||
assert.Equal(t, int64(cert.Version1), metrics.GetOrRegisterGauge("certificate.initiating_version", nil).Value())
|
assert.Equal(t, int64(cert.Version1), metrics.GetOrRegisterGauge("certificate.initiating_version", nil).Value())
|
||||||
assert.Equal(t, int64(cert.Version1), metrics.GetOrRegisterGauge("certificate.max_version", nil).Value())
|
assert.Equal(t, int64(cert.Version1), metrics.GetOrRegisterGauge("certificate.max_version", nil).Value())
|
||||||
|
|||||||
@@ -32,6 +32,9 @@ const (
|
|||||||
IPProtocolICMPv6 = 58
|
IPProtocolICMPv6 = 58
|
||||||
IPProtocolTCP = 6
|
IPProtocolTCP = 6
|
||||||
IPProtocolUDP = 17
|
IPProtocolUDP = 17
|
||||||
|
IPProtocolUDPLite = 136
|
||||||
|
IPProtocolDCCP = 33
|
||||||
|
IPProtocolSCTP = 132
|
||||||
ICMPv6TypeEchoRequest = 128
|
ICMPv6TypeEchoRequest = 128
|
||||||
ICMPv6TypeEchoReply = 129
|
ICMPv6TypeEchoReply = 129
|
||||||
)
|
)
|
||||||
|
|||||||
+5
-28
@@ -15,7 +15,6 @@ 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"
|
||||||
@@ -82,8 +81,6 @@ 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
|
||||||
|
|
||||||
@@ -119,8 +116,7 @@ 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", 1024)),
|
queryChan: make(chan netip.Addr, c.GetUint32("handshakes.query_buffer", 64)),
|
||||||
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 {
|
||||||
@@ -359,13 +355,7 @@ func (lh *LightHouse) reload(c *config.C, initial bool) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// am_relay decides whether relay.relays applies to us at all
|
if initial || c.HasChanged("relay.relays") {
|
||||||
if initial || c.HasChanged("relay.relays") || c.HasChanged("relay.am_relay") {
|
|
||||||
var before []netip.Addr
|
|
||||||
if !initial {
|
|
||||||
before = lh.GetRelaysForMe()
|
|
||||||
}
|
|
||||||
|
|
||||||
switch c.GetBool("relay.am_relay", false) {
|
switch c.GetBool("relay.am_relay", false) {
|
||||||
case true:
|
case true:
|
||||||
// Relays aren't allowed to specify other relays
|
// Relays aren't allowed to specify other relays
|
||||||
@@ -390,11 +380,6 @@ func (lh *LightHouse) reload(c *config.C, initial bool) error {
|
|||||||
}
|
}
|
||||||
lh.relaysForMe.Store(&relaysForMe)
|
lh.relaysForMe.Store(&relaysForMe)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Tell the lighthouses now rather than at the next interval, but only when what we advertise changed
|
|
||||||
if !initial && !slices.Equal(before, lh.GetRelaysForMe()) {
|
|
||||||
lh.TriggerUpdate()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
@@ -527,19 +512,14 @@ func (lh *LightHouse) Query(vpnAddr netip.Addr) *RemoteList {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// QueryServer is asynchronous and non-blocking, no reply should be expected.
|
// QueryServer is asynchronous so 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
|
||||||
}
|
}
|
||||||
|
|
||||||
select {
|
lh.queryChan <- vpnAddr
|
||||||
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 {
|
||||||
@@ -1255,13 +1235,10 @@ func (lhh *LightHouseHandler) handleHostQuery(n *NebulaMeta, fromVpnAddrs []neti
|
|||||||
// sendHostPunchNotification signals the other side to punch some zero byte udp packets
|
// sendHostPunchNotification signals the other side to punch some zero byte udp packets
|
||||||
func (lhh *LightHouseHandler) sendHostPunchNotification(n *NebulaMeta, fromVpnAddrs []netip.Addr, punchNotifDest netip.Addr, w EncWriter) {
|
func (lhh *LightHouseHandler) sendHostPunchNotification(n *NebulaMeta, fromVpnAddrs []netip.Addr, punchNotifDest netip.Addr, w EncWriter) {
|
||||||
whereToPunch := fromVpnAddrs[0]
|
whereToPunch := fromVpnAddrs[0]
|
||||||
// Resolve the target before taking the querier's RemoteList lock below. GetHostInfo takes the
|
|
||||||
// hostmap lock, and the hostmap is taken before the lighthouse, which is taken before a
|
|
||||||
// RemoteList, so looking it up inside the callback would deadlock.
|
|
||||||
targetHI := lhh.lh.ifce.GetHostInfo(punchNotifDest)
|
|
||||||
found, ln, err := lhh.lh.queryAndPrepMessage(whereToPunch, func(c *cache) (int, error) {
|
found, ln, err := lhh.lh.queryAndPrepMessage(whereToPunch, func(c *cache) (int, error) {
|
||||||
n = lhh.resetMeta()
|
n = lhh.resetMeta()
|
||||||
n.Type = NebulaMeta_HostPunchNotification
|
n.Type = NebulaMeta_HostPunchNotification
|
||||||
|
targetHI := lhh.lh.ifce.GetHostInfo(punchNotifDest)
|
||||||
var useVersion cert.Version
|
var useVersion cert.Version
|
||||||
if targetHI == nil {
|
if targetHI == nil {
|
||||||
useVersion = lhh.lh.ifce.GetCertState().initiatingVersion
|
useVersion = lhh.lh.ifce.GetCertState().initiatingVersion
|
||||||
|
|||||||
@@ -6,16 +6,13 @@ 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"
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
"github.com/slackhq/nebula/header"
|
"github.com/slackhq/nebula/header"
|
||||||
"github.com/slackhq/nebula/test"
|
"github.com/slackhq/nebula/test"
|
||||||
"github.com/slackhq/nebula/udp"
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
"go.yaml.in/yaml/v3"
|
"go.yaml.in/yaml/v3"
|
||||||
@@ -798,202 +795,3 @@ 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)
|
|
||||||
}
|
|
||||||
|
|
||||||
// hostmapEncWriter answers GetHostInfo from a real hostmap, the way Interface does.
|
|
||||||
type hostmapEncWriter struct {
|
|
||||||
mockEncWriter
|
|
||||||
hm *HostMap
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *hostmapEncWriter) GetHostInfo(a netip.Addr) *HostInfo { return w.hm.QueryVpnAddr(a) }
|
|
||||||
func (w *hostmapEncWriter) GetCertState() *CertState {
|
|
||||||
return &CertState{initiatingVersion: cert.Version1}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A lighthouse runs four paths that each hold one lock while waiting for the next: CheckAndComplete
|
|
||||||
// holds the hostmap and takes the handshake manager, StartHandshake holds the handshake manager and
|
|
||||||
// takes the lighthouse, a host update holds the lighthouse and takes the sender's RemoteList, and a
|
|
||||||
// punch notification holds the querier's RemoteList while it resolves the target. If that last step
|
|
||||||
// reaches the hostmap under the RemoteList lock, the four deadlock. Drive them all at once.
|
|
||||||
func TestLighthouse_PunchNotificationDoesNotCloseLockCycle(t *testing.T) {
|
|
||||||
l := test.NewLogger()
|
|
||||||
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
|
||||||
|
|
||||||
c := config.NewC(l)
|
|
||||||
c.Settings["lighthouse"] = map[string]any{"am_lighthouse": true}
|
|
||||||
c.Settings["listen"] = map[string]any{"port": 4242}
|
|
||||||
lh, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(myVpnNet), nil, nil)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
mainHM := newHostMap(l)
|
|
||||||
pr := []netip.Prefix{}
|
|
||||||
mainHM.preferredRanges.Store(&pr)
|
|
||||||
lh.ifce = &hostmapEncWriter{hm: mainHM}
|
|
||||||
|
|
||||||
hm := NewHandshakeManager(l, mainHM, lh, &udp.NoopConn{}, defaultHandshakeConfig)
|
|
||||||
f := &Interface{hostMap: mainHM, lightHouse: lh, handshakeManager: hm, l: l}
|
|
||||||
hm.f = f
|
|
||||||
|
|
||||||
peer := netip.MustParseAddr("10.128.0.2")
|
|
||||||
peerUdp := netip.MustParseAddrPort("10.0.0.2:4242")
|
|
||||||
target := netip.MustParseAddr("10.128.0.3")
|
|
||||||
targetUdp := netip.MustParseAddrPort("10.0.0.3:4242")
|
|
||||||
outbound := netip.MustParseAddr("10.128.0.4")
|
|
||||||
inbound := netip.MustParseAddr("10.128.0.5")
|
|
||||||
|
|
||||||
seed := lh.NewRequestHandler()
|
|
||||||
newLHHostUpdate(peerUdp, peer, []netip.AddrPort{peerUdp}, seed)
|
|
||||||
newLHHostUpdate(targetUdp, target, []netip.AddrPort{targetUdp}, seed)
|
|
||||||
|
|
||||||
stop := make(chan struct{})
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
loop := func(body func()) {
|
|
||||||
defer wg.Done()
|
|
||||||
for {
|
|
||||||
select {
|
|
||||||
case <-stop:
|
|
||||||
return
|
|
||||||
default:
|
|
||||||
body()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
wg.Add(4)
|
|
||||||
|
|
||||||
// Outbound handshakes keep starting and being dropped.
|
|
||||||
go loop(func() {
|
|
||||||
hm.DeleteHostInfo(hm.StartHandshake(outbound, nil))
|
|
||||||
})
|
|
||||||
|
|
||||||
// Inbound handshakes keep completing and being torn down.
|
|
||||||
var idx uint32
|
|
||||||
go loop(func() {
|
|
||||||
idx++
|
|
||||||
hi := &HostInfo{
|
|
||||||
vpnAddrs: []netip.Addr{inbound},
|
|
||||||
localIndexId: idx,
|
|
||||||
remoteIndexId: idx,
|
|
||||||
remotes: lh.QueryCache([]netip.Addr{inbound}),
|
|
||||||
HandshakePacket: map[uint8][]byte{handshakePacketStage0: {byte(idx)}},
|
|
||||||
}
|
|
||||||
if _, err := hm.CheckAndComplete(hi, handshakePacketStage0, f); err == nil {
|
|
||||||
mainHM.DeleteHostInfo(hi)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
// The peer keeps sending host updates.
|
|
||||||
updates := lh.NewRequestHandler()
|
|
||||||
go loop(func() {
|
|
||||||
newLHHostUpdate(peerUdp, peer, []netip.AddrPort{peerUdp}, updates)
|
|
||||||
})
|
|
||||||
|
|
||||||
// The same peer keeps querying for the target, which ends in a punch notification.
|
|
||||||
queries := lh.NewRequestHandler()
|
|
||||||
go loop(func() {
|
|
||||||
sendLHHostRequest(peerUdp, peer, target, queries, nil)
|
|
||||||
})
|
|
||||||
|
|
||||||
time.Sleep(time.Second)
|
|
||||||
close(stop)
|
|
||||||
done := make(chan struct{})
|
|
||||||
go func() { wg.Wait(); close(done) }()
|
|
||||||
select {
|
|
||||||
case <-done:
|
|
||||||
case <-time.After(5 * time.Second):
|
|
||||||
t.Fatal("deadlock: the lighthouse paths never finished after stop was signalled")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLighthouse_reloadRelaysTriggersUpdate(t *testing.T) {
|
|
||||||
l := test.NewLogger()
|
|
||||||
c := config.NewC(l)
|
|
||||||
base := "lighthouse:\n am_lighthouse: true\nlisten:\n port: 4242\n"
|
|
||||||
require.NoError(t, c.LoadString(base+"relay:\n relays: [10.128.0.5]\n"))
|
|
||||||
|
|
||||||
lh, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(netip.MustParsePrefix("10.128.0.1/24")), nil, nil)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Empty(t, lh.updateTrigger)
|
|
||||||
|
|
||||||
require.NoError(t, c.ReloadConfigString(base+"relay:\n relays: [10.128.0.6]\n"))
|
|
||||||
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.6")}, lh.GetRelaysForMe())
|
|
||||||
require.Len(t, lh.updateTrigger, 1)
|
|
||||||
<-lh.updateTrigger
|
|
||||||
|
|
||||||
// The config changed but what we advertise did not, a bad entry is skipped
|
|
||||||
require.NoError(t, c.ReloadConfigString(base+"relay:\n relays: [10.128.0.6, nope]\n"))
|
|
||||||
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.6")}, lh.GetRelaysForMe())
|
|
||||||
assert.Empty(t, lh.updateTrigger)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLighthouse_reloadAmRelayAlone(t *testing.T) {
|
|
||||||
l := test.NewLogger()
|
|
||||||
c := config.NewC(l)
|
|
||||||
base := "lighthouse:\n am_lighthouse: true\nlisten:\n port: 4242\nrelay:\n relays: [10.128.0.5]\n"
|
|
||||||
require.NoError(t, c.LoadString(base+" am_relay: false\n"))
|
|
||||||
|
|
||||||
lh, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(netip.MustParsePrefix("10.128.0.1/24")), nil, nil)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.5")}, lh.GetRelaysForMe())
|
|
||||||
|
|
||||||
// Relays aren't allowed to have relays, flipping am_relay alone must drop them and tell the lighthouses
|
|
||||||
require.NoError(t, c.ReloadConfigString(base+" am_relay: true\n"))
|
|
||||||
assert.Empty(t, lh.GetRelaysForMe())
|
|
||||||
require.Len(t, lh.updateTrigger, 1)
|
|
||||||
<-lh.updateTrigger
|
|
||||||
|
|
||||||
require.NoError(t, c.ReloadConfigString(base+" am_relay: false\n"))
|
|
||||||
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.5")}, lh.GetRelaysForMe())
|
|
||||||
require.Len(t, lh.updateTrigger, 1)
|
|
||||||
}
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
package logging
|
|
||||||
|
|
||||||
import "log/slog"
|
|
||||||
|
|
||||||
// RateLimiter is what RateLimited needs from a rate limiter, such as a *ratelimit.Limiter.
|
|
||||||
// Allow reports whether this call may proceed, and how many calls were denied since the last one that did.
|
|
||||||
type RateLimiter interface {
|
|
||||||
Allow() (denied uint64, ok bool)
|
|
||||||
}
|
|
||||||
|
|
||||||
// RateLimited checks lim before anything is built.
|
|
||||||
// When allowed it returns l, with a "suppressed" count attached if lim denied calls since its last allowed one.
|
|
||||||
// A nil lim allows everything.
|
|
||||||
//
|
|
||||||
// if l, ok := logging.RateLimited(f.l, f.udpTxErrLimiter); ok {
|
|
||||||
// hostinfo.logger(l).Error("Failed to write outgoing packet", "error", err)
|
|
||||||
// }
|
|
||||||
func RateLimited(l *slog.Logger, lim RateLimiter) (*slog.Logger, bool) {
|
|
||||||
if lim == nil {
|
|
||||||
return l, true
|
|
||||||
}
|
|
||||||
|
|
||||||
denied, ok := lim.Allow()
|
|
||||||
if !ok {
|
|
||||||
return nil, false
|
|
||||||
}
|
|
||||||
if denied > 0 {
|
|
||||||
return l.With("suppressed", denied), true
|
|
||||||
}
|
|
||||||
return l, true
|
|
||||||
}
|
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
package logging
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"log/slog"
|
|
||||||
"net/netip"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/ratelimit"
|
|
||||||
)
|
|
||||||
|
|
||||||
type fakeLimiter struct {
|
|
||||||
denied uint64
|
|
||||||
ok bool
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f fakeLimiter) Allow() (uint64, bool) { return f.denied, f.ok }
|
|
||||||
|
|
||||||
func TestRateLimited(t *testing.T) {
|
|
||||||
var buf bytes.Buffer
|
|
||||||
base := NewLogger(&buf)
|
|
||||||
|
|
||||||
if l, ok := RateLimited(base, fakeLimiter{ok: false}); ok || l != nil {
|
|
||||||
t.Fatalf("denied call: ok=%v logger=%v", ok, l)
|
|
||||||
}
|
|
||||||
|
|
||||||
if l, ok := RateLimited(base, fakeLimiter{ok: true}); !ok || l != base {
|
|
||||||
t.Fatal("nothing denied should hand back the same logger")
|
|
||||||
}
|
|
||||||
|
|
||||||
if l, ok := RateLimited(base, nil); !ok || l != base {
|
|
||||||
t.Fatal("a nil limiter should allow with the same logger")
|
|
||||||
}
|
|
||||||
|
|
||||||
l, ok := RateLimited(base, fakeLimiter{denied: 7, ok: true})
|
|
||||||
if !ok {
|
|
||||||
t.Fatal("allowed call denied")
|
|
||||||
}
|
|
||||||
l.Info("hello", "k", "v")
|
|
||||||
if !strings.Contains(buf.String(), "suppressed=7") {
|
|
||||||
t.Fatalf("want suppressed=7, got %q", buf.String())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The benchmarks compare a log line through slog directly against the same line behind RateLimited: logged with
|
|
||||||
// nothing denied, denied, and logged after denials.
|
|
||||||
|
|
||||||
var (
|
|
||||||
benchErr = errors.New("sendto: no buffer space available")
|
|
||||||
benchAddr = netip.MustParseAddrPort("192.0.2.1:4242")
|
|
||||||
)
|
|
||||||
|
|
||||||
func benchLogger() *slog.Logger {
|
|
||||||
return NewLogger(io.Discard).With("localIndex", 1234, "remoteIndex", 5678)
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkRateLimitedBaseline(b *testing.B) {
|
|
||||||
lg := benchLogger()
|
|
||||||
b.ReportAllocs()
|
|
||||||
for i := 0; i < b.N; i++ {
|
|
||||||
lg.Error("Failed to write outgoing packet", "error", benchErr, "udpAddr", benchAddr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkRateLimitedAllowed(b *testing.B) {
|
|
||||||
lg, lim := benchLogger(), mustLimiter(b, 1, 0)
|
|
||||||
b.ReportAllocs()
|
|
||||||
for i := 0; i < b.N; i++ {
|
|
||||||
if l, ok := RateLimited(lg, lim); ok {
|
|
||||||
l.Error("Failed to write outgoing packet", "error", benchErr, "udpAddr", benchAddr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkRateLimitedDenied(b *testing.B) {
|
|
||||||
lg, lim := benchLogger(), mustLimiter(b, 1, time.Hour)
|
|
||||||
lim.Allow()
|
|
||||||
b.ReportAllocs()
|
|
||||||
for i := 0; i < b.N; i++ {
|
|
||||||
if l, ok := RateLimited(lg, lim); ok {
|
|
||||||
l.Error("Failed to write outgoing packet", "error", benchErr, "udpAddr", benchAddr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkRateLimitedAfterDenied(b *testing.B) {
|
|
||||||
lg, lim := benchLogger(), fakeLimiter{denied: 5, ok: true}
|
|
||||||
b.ReportAllocs()
|
|
||||||
for i := 0; i < b.N; i++ {
|
|
||||||
if l, ok := RateLimited(lg, lim); ok {
|
|
||||||
l.Error("Failed to write outgoing packet", "error", benchErr, "udpAddr", benchAddr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func mustLimiter(b *testing.B, burst int, every time.Duration) *ratelimit.Limiter {
|
|
||||||
l, err := ratelimit.New(burst, every)
|
|
||||||
if err != nil {
|
|
||||||
b.Fatal(err)
|
|
||||||
}
|
|
||||||
return l
|
|
||||||
}
|
|
||||||
@@ -300,7 +300,6 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
|||||||
}
|
}
|
||||||
|
|
||||||
var ifce *Interface
|
var ifce *Interface
|
||||||
var emitStats func()
|
|
||||||
if !configTest {
|
if !configTest {
|
||||||
ifce, err = NewInterface(ctx, ifConfig)
|
ifce, err = NewInterface(ctx, ifConfig)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -319,12 +318,9 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
|||||||
go handshakeManager.Run(ctx)
|
go handshakeManager.Run(ctx)
|
||||||
|
|
||||||
punchy.Start(ctx, ifce, hostMap, lightHouse)
|
punchy.Start(ctx, ifce, hostMap, lightHouse)
|
||||||
|
|
||||||
// On the stats server's loop, so the gauges follow the interval it accepted
|
|
||||||
emitStats = ifce.statsEmitter()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
stats, err := newStatsServerFromConfig(ctx, l, c, buildVersion, configTest, emitStats)
|
stats, err := newStatsServerFromConfig(ctx, l, c, buildVersion, configTest)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, util.ContextualizeIfNeeded("Failed to start stats emitter", err)
|
return nil, util.ContextualizeIfNeeded("Failed to start stats emitter", err)
|
||||||
}
|
}
|
||||||
@@ -333,6 +329,8 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
|||||||
return nil, nil
|
return nil, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
go ifce.emitStats(ctx, c.GetDuration("stats.interval", time.Second*10))
|
||||||
|
|
||||||
attachCommands(l, c, ssh, ifce)
|
attachCommands(l, c, ssh, ifce)
|
||||||
|
|
||||||
networkChanges := udp.NewNetworkChangeMonitor(ctx, l, c)
|
networkChanges := udp.NewNetworkChangeMonitor(ctx, l, c)
|
||||||
|
|||||||
+21
-12
@@ -160,7 +160,9 @@ func (f *Interface) readOutsidePackets(via ViaSender, packet []byte, rxc *rxCont
|
|||||||
case header.TestReply:
|
case header.TestReply:
|
||||||
// No-op, useful for the Roaming and connectionManager side-effects above
|
// No-op, useful for the Roaming and connectionManager side-effects above
|
||||||
case header.TestRequest:
|
case header.TestRequest:
|
||||||
if header.MaxOverhead+len(out) > len(rxc.scratch) {
|
const maxCipherOverhead = 16 //todo we use this too often, needs a real importable const
|
||||||
|
const maxOverhead = header.Len + header.Len + maxCipherOverhead + maxCipherOverhead
|
||||||
|
if maxOverhead+len(out) > len(rxc.scratch) {
|
||||||
// A reply that cannot fit in scratch is dropped no matter the log level.
|
// A reply that cannot fit in scratch is dropped no matter the log level.
|
||||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||||
hostinfo.logger(f.l).Debug("dropping oversized test request", "payloadLen", len(out), "from", via)
|
hostinfo.logger(f.l).Debug("dropping oversized test request", "payloadLen", len(out), "from", via)
|
||||||
@@ -261,17 +263,12 @@ func (f *Interface) handleOutsideRelayPacket(hostinfo *HostInfo, via ViaSender,
|
|||||||
|
|
||||||
// closeTunnel closes a tunnel locally, it does not send a closeTunnel packet to the remote
|
// closeTunnel closes a tunnel locally, it does not send a closeTunnel packet to the remote
|
||||||
func (f *Interface) closeTunnel(hostInfo *HostInfo) {
|
func (f *Interface) closeTunnel(hostInfo *HostInfo) {
|
||||||
// Hold the hostmap lock across both the delete and the lighthouse eviction,
|
final := f.hostMap.DeleteHostInfo(hostInfo)
|
||||||
// to avoid a race with handshake completion.
|
if final {
|
||||||
f.hostMap.Lock()
|
|
||||||
defer f.hostMap.Unlock()
|
|
||||||
if !f.hostMap.unlockedDeleteHostInfo(hostInfo) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// We no longer have any tunnels with this vpn addr, clear learned lighthouse state to lower memory usage
|
// We no longer have any tunnels with this vpn addr, clear learned lighthouse state to lower memory usage
|
||||||
f.lightHouse.DeleteVpnAddrs(hostInfo.vpnAddrs)
|
f.lightHouse.DeleteVpnAddrs(hostInfo.vpnAddrs)
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// sendCloseTunnel is a helper function to send a proper close tunnel packet to a remote
|
// sendCloseTunnel is a helper function to send a proper close tunnel packet to a remote
|
||||||
func (f *Interface) sendCloseTunnel(h *HostInfo) {
|
func (f *Interface) sendCloseTunnel(h *HostInfo) {
|
||||||
@@ -388,7 +385,7 @@ func parseV6(data []byte, incoming bool, fp *firewall.ParsedPacket) error {
|
|||||||
fp.RemotePort = 0
|
fp.RemotePort = 0
|
||||||
}
|
}
|
||||||
|
|
||||||
case iputil.IPProtocolTCP, iputil.IPProtocolUDP:
|
case iputil.IPProtocolTCP, iputil.IPProtocolUDP, iputil.IPProtocolDCCP, iputil.IPProtocolSCTP, iputil.IPProtocolUDPLite:
|
||||||
if dataLen < offset+4 {
|
if dataLen < offset+4 {
|
||||||
return ErrIPv6PacketTooShort
|
return ErrIPv6PacketTooShort
|
||||||
}
|
}
|
||||||
@@ -459,10 +456,16 @@ func parseV4(data []byte, incoming bool, fp *firewall.ParsedPacket) error {
|
|||||||
if fp.Fragment {
|
if fp.Fragment {
|
||||||
fp.RemotePort = 0
|
fp.RemotePort = 0
|
||||||
fp.LocalPort = 0
|
fp.LocalPort = 0
|
||||||
} else if fp.Protocol == iputil.IPProtocolICMP { //note that orientation doesn't matter on ICMP
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
switch fp.Protocol {
|
||||||
|
case iputil.IPProtocolICMP: //note that orientation doesn't matter on ICMP
|
||||||
fp.RemotePort = binary.BigEndian.Uint16(data[ihl+4 : ihl+6]) //identifier
|
fp.RemotePort = binary.BigEndian.Uint16(data[ihl+4 : ihl+6]) //identifier
|
||||||
fp.LocalPort = 0 //code would be uint16(data[ihl+1])
|
fp.LocalPort = 0 //code would be uint16(data[ihl+1])
|
||||||
} else if incoming {
|
|
||||||
|
case iputil.IPProtocolTCP, iputil.IPProtocolUDP, iputil.IPProtocolDCCP, iputil.IPProtocolSCTP, iputil.IPProtocolUDPLite:
|
||||||
|
if incoming {
|
||||||
fp.RemotePort = binary.BigEndian.Uint16(data[ihl : ihl+2]) //src port
|
fp.RemotePort = binary.BigEndian.Uint16(data[ihl : ihl+2]) //src port
|
||||||
fp.LocalPort = binary.BigEndian.Uint16(data[ihl+2 : ihl+4]) //dst port
|
fp.LocalPort = binary.BigEndian.Uint16(data[ihl+2 : ihl+4]) //dst port
|
||||||
} else {
|
} else {
|
||||||
@@ -470,6 +473,12 @@ func parseV4(data []byte, incoming bool, fp *firewall.ParsedPacket) error {
|
|||||||
fp.RemotePort = binary.BigEndian.Uint16(data[ihl+2 : ihl+4]) //dst port
|
fp.RemotePort = binary.BigEndian.Uint16(data[ihl+2 : ihl+4]) //dst port
|
||||||
}
|
}
|
||||||
|
|
||||||
|
default:
|
||||||
|
// don't set ports for protocols Nebula doesn't inspect, the first 4 bytes of GRE, IPIP, AH, etc. are not ports
|
||||||
|
fp.RemotePort = 0
|
||||||
|
fp.LocalPort = 0
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+84
-19
@@ -77,7 +77,7 @@ func Test_newPacket(t *testing.T) {
|
|||||||
// account for variable ip header length - outgoing
|
// account for variable ip header length - outgoing
|
||||||
h = ipv4.Header{
|
h = ipv4.Header{
|
||||||
Version: 1,
|
Version: 1,
|
||||||
Protocol: 2,
|
Protocol: iputil.IPProtocolUDP,
|
||||||
Len: 100,
|
Len: 100,
|
||||||
Src: net.IPv4(10, 0, 0, 1),
|
Src: net.IPv4(10, 0, 0, 1),
|
||||||
Dst: net.IPv4(10, 0, 0, 2),
|
Dst: net.IPv4(10, 0, 0, 2),
|
||||||
@@ -89,7 +89,7 @@ func Test_newPacket(t *testing.T) {
|
|||||||
err = newPacket(b, false, p)
|
err = newPacket(b, false, p)
|
||||||
|
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.Equal(t, uint8(2), p.Protocol)
|
assert.Equal(t, uint8(iputil.IPProtocolUDP), p.Protocol)
|
||||||
assert.Equal(t, netip.MustParseAddr("10.0.0.1"), p.LocalAddr)
|
assert.Equal(t, netip.MustParseAddr("10.0.0.1"), p.LocalAddr)
|
||||||
assert.Equal(t, netip.MustParseAddr("10.0.0.2"), p.RemoteAddr)
|
assert.Equal(t, netip.MustParseAddr("10.0.0.2"), p.RemoteAddr)
|
||||||
assert.Equal(t, uint16(6), p.RemotePort)
|
assert.Equal(t, uint16(6), p.RemotePort)
|
||||||
@@ -97,6 +97,71 @@ func Test_newPacket(t *testing.T) {
|
|||||||
assert.False(t, p.Fragment)
|
assert.False(t, p.Fragment)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Test_newPacket_v4NoPorts ensures only protocols that lead with src/dst ports report them. The first 4 bytes of other protocols are not ports,
|
||||||
|
// and are often chosen by the sender: a GRE header's protocol type, an IPIP inner total length, a 6in4 flow label.
|
||||||
|
// Reading them as ports would let a `proto: any` rule with a port match tunneled traffic.
|
||||||
|
func Test_newPacket_v4NoPorts(t *testing.T) {
|
||||||
|
p := &firewall.ParsedPacket{}
|
||||||
|
|
||||||
|
for _, proto := range []uint8{4, 41, 47, 50, 51} { // IPIP, 6in4, GRE, ESP, AH
|
||||||
|
h := ipv4.Header{
|
||||||
|
Version: 4,
|
||||||
|
Len: ipv4.HeaderLen,
|
||||||
|
Protocol: int(proto),
|
||||||
|
Src: net.IPv4(10, 0, 0, 1),
|
||||||
|
Dst: net.IPv4(10, 0, 0, 2),
|
||||||
|
}
|
||||||
|
b, err := h.Marshal()
|
||||||
|
require.NoError(t, err)
|
||||||
|
b = append(b, []byte{0x00, 0x00, 0x86, 0xdd}...) // a GRE header carrying IPv6 would read as port 34525
|
||||||
|
|
||||||
|
for _, incoming := range []bool{true, false} {
|
||||||
|
require.NoError(t, newPacket(b, incoming, p))
|
||||||
|
assert.Equal(t, proto, p.Protocol)
|
||||||
|
assert.Equal(t, uint16(0), p.RemotePort)
|
||||||
|
assert.Equal(t, uint16(0), p.LocalPort)
|
||||||
|
assert.False(t, p.Fragment)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test_newPacket_portedProtocols ensures UDP-Lite, DCCP, and SCTP report ports from the same leading
|
||||||
|
// src/dst port words as TCP and UDP, oriented the same way.
|
||||||
|
func Test_newPacket_portedProtocols(t *testing.T) {
|
||||||
|
p := &firewall.ParsedPacket{}
|
||||||
|
ports := []byte{0x13, 0x88, 0x00, 0x50} // src 5000, dst 80
|
||||||
|
|
||||||
|
for _, proto := range []uint8{iputil.IPProtocolUDPLite, iputil.IPProtocolDCCP, iputil.IPProtocolSCTP} {
|
||||||
|
h := ipv4.Header{
|
||||||
|
Version: 4,
|
||||||
|
Len: ipv4.HeaderLen,
|
||||||
|
Protocol: int(proto),
|
||||||
|
Src: net.IPv4(10, 0, 0, 1),
|
||||||
|
Dst: net.IPv4(10, 0, 0, 2),
|
||||||
|
}
|
||||||
|
v4, err := h.Marshal()
|
||||||
|
require.NoError(t, err)
|
||||||
|
v4 = append(v4, ports...)
|
||||||
|
|
||||||
|
v6 := make([]byte, 40, 44)
|
||||||
|
v6[0] = 0x60
|
||||||
|
v6[6] = proto
|
||||||
|
v6[7] = 64
|
||||||
|
v6 = append(v6, ports...)
|
||||||
|
|
||||||
|
for _, b := range [][]byte{v4, v6} {
|
||||||
|
require.NoError(t, newPacket(b, true, p))
|
||||||
|
assert.Equal(t, proto, p.Protocol)
|
||||||
|
assert.Equal(t, uint16(5000), p.RemotePort)
|
||||||
|
assert.Equal(t, uint16(80), p.LocalPort)
|
||||||
|
|
||||||
|
require.NoError(t, newPacket(b, false, p))
|
||||||
|
assert.Equal(t, uint16(5000), p.LocalPort)
|
||||||
|
assert.Equal(t, uint16(80), p.RemotePort)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func Test_newPacket_v6(t *testing.T) {
|
func Test_newPacket_v6(t *testing.T) {
|
||||||
p := &firewall.ParsedPacket{}
|
p := &firewall.ParsedPacket{}
|
||||||
|
|
||||||
@@ -712,46 +777,46 @@ func Test_newPacket_v6ExtHeaderPastBuffer(t *testing.T) {
|
|||||||
|
|
||||||
// Test_newPacket_v6ExtHeaderConfusion is a regression test for parseV6 walking any unrecognized
|
// Test_newPacket_v6ExtHeaderConfusion is a regression test for parseV6 walking any unrecognized
|
||||||
// Next Header as if it were an ipv6 extension header. A real upper layer protocol Nebula doesn't
|
// Next Header as if it were an ipv6 extension header. A real upper layer protocol Nebula doesn't
|
||||||
// dissect (SCTP here) is not walkable, so applying the (len+1)*8 formula marched into the SCTP
|
// dissect (GRE here) is not walkable, so applying the (len+1)*8 formula marched into the GRE
|
||||||
// payload and landed on a byte that looked like UDP, forging a protocol/port pair the firewall
|
// payload and landed on a byte that looked like UDP, forging a protocol/port pair the firewall
|
||||||
// would trust while the host delivered the real SCTP datagram. The fix fails closed: the packet
|
// would trust while the host delivered the real GRE packet. The fix fails closed: the packet
|
||||||
// is classified as its true protocol with no ports, so it only matches an `any` rule.
|
// is classified as its true protocol with no ports, so it only matches an `any` rule.
|
||||||
func Test_newPacket_v6ExtHeaderConfusion(t *testing.T) {
|
func Test_newPacket_v6ExtHeaderConfusion(t *testing.T) {
|
||||||
p := &firewall.ParsedPacket{}
|
p := &firewall.ParsedPacket{}
|
||||||
|
|
||||||
pkt := make([]byte, 52)
|
pkt := make([]byte, 52)
|
||||||
pkt[0] = 0x60 // version 6
|
pkt[0] = 0x60 // version 6
|
||||||
pkt[6] = byte(layers.IPProtocolSCTP) // NextHeader = SCTP, a real protocol, not an extension header
|
pkt[6] = byte(layers.IPProtocolGRE) // NextHeader = GRE, a real protocol, not an extension header
|
||||||
pkt[7] = 64 // hop limit
|
pkt[7] = 64 // hop limit
|
||||||
|
|
||||||
// Real SCTP header at offset 40. Pre-fix parseV6 walked SCTP as an extension header: byte 41 (0x00, the
|
// Real GRE header at offset 40. Pre-fix parseV6 walked GRE as an extension header: byte 41 (0x00, the
|
||||||
// low byte of the src port below) was read as the header length, giving next=(0+1)*8=8, which landed the
|
// low byte of the flags/version word below) was read as the header length, giving next=(0+1)*8=8, which
|
||||||
// walk on byte 40 (0x11), misread as NextHeader=UDP, then bytes 48-51 as ports.
|
// landed the walk on byte 40 (0x11), misread as NextHeader=UDP, then bytes 48-51 as ports.
|
||||||
binary.BigEndian.PutUint16(pkt[40:42], 0x1100) // SCTP src port; byte 40=0x11, byte 41=0x00
|
binary.BigEndian.PutUint16(pkt[40:42], 0x1100) // GRE flags/version; byte 40=0x11, byte 41=0x00
|
||||||
binary.BigEndian.PutUint16(pkt[42:44], 445) // SCTP dst port, never read by parseV6
|
binary.BigEndian.PutUint16(pkt[42:44], 0x86dd) // GRE protocol type, never read by parseV6
|
||||||
binary.BigEndian.PutUint16(pkt[48:50], 53) // SCTP checksum bytes, pre-fix forged RemotePort
|
binary.BigEndian.PutUint16(pkt[48:50], 53) // GRE payload, pre-fix forged RemotePort
|
||||||
binary.BigEndian.PutUint16(pkt[50:52], 53) // pre-fix forged LocalPort
|
binary.BigEndian.PutUint16(pkt[50:52], 53) // pre-fix forged LocalPort
|
||||||
|
|
||||||
require.NoError(t, newPacket(pkt, true, p))
|
require.NoError(t, newPacket(pkt, true, p))
|
||||||
assert.Equal(t, uint8(layers.IPProtocolSCTP), p.Protocol, "must classify as the true protocol, not the forged UDP")
|
assert.Equal(t, uint8(layers.IPProtocolGRE), p.Protocol, "must classify as the true protocol, not the forged UDP")
|
||||||
assert.Equal(t, uint16(0), p.RemotePort)
|
assert.Equal(t, uint16(0), p.RemotePort)
|
||||||
assert.Equal(t, uint16(0), p.LocalPort)
|
assert.Equal(t, uint16(0), p.LocalPort)
|
||||||
assert.False(t, p.Fragment)
|
assert.False(t, p.Fragment)
|
||||||
|
|
||||||
// Same confusion, but the unknown protocol sits after a real extension header. The HopByHop is walked
|
// Same confusion, but the unknown protocol sits after a real extension header. The HopByHop is walked
|
||||||
// correctly, then SCTP must still fail closed instead of being walked into its own payload. Protocol is
|
// correctly, then GRE must still fail closed instead of being walked into its own payload. Protocol is
|
||||||
// the only assertion that discriminates the fix here, a regression that walked SCTP would misclassify it.
|
// the only assertion that discriminates the fix here, a regression that walked GRE would misclassify it.
|
||||||
chained := make([]byte, 60)
|
chained := make([]byte, 60)
|
||||||
chained[0] = 0x60 // version 6
|
chained[0] = 0x60 // version 6
|
||||||
chained[6] = byte(layers.IPProtocolIPv6HopByHop) // NextHeader = HopByHop extension
|
chained[6] = byte(layers.IPProtocolIPv6HopByHop) // NextHeader = HopByHop extension
|
||||||
chained[7] = 64 // hop limit
|
chained[7] = 64 // hop limit
|
||||||
chained[40] = byte(layers.IPProtocolSCTP) // HopByHop NextHeader = SCTP
|
chained[40] = byte(layers.IPProtocolGRE) // HopByHop NextHeader = GRE
|
||||||
chained[41] = 0 // HopByHop length 0 -> 8 bytes, SCTP begins at offset 48
|
chained[41] = 0 // HopByHop length 0 -> 8 bytes, GRE begins at offset 48
|
||||||
binary.BigEndian.PutUint16(chained[48:50], 0x1100) // SCTP src port, pre-fix forged NextHeader/length bait
|
binary.BigEndian.PutUint16(chained[48:50], 0x1100) // GRE flags/version, pre-fix forged NextHeader/length bait
|
||||||
binary.BigEndian.PutUint16(chained[50:52], 445) // SCTP dst port, never read by parseV6
|
binary.BigEndian.PutUint16(chained[50:52], 0x86dd) // GRE protocol type, never read by parseV6
|
||||||
|
|
||||||
require.NoError(t, newPacket(chained, true, p))
|
require.NoError(t, newPacket(chained, true, p))
|
||||||
assert.Equal(t, uint8(layers.IPProtocolSCTP), p.Protocol, "must fail closed on the unknown protocol after the extension header")
|
assert.Equal(t, uint8(layers.IPProtocolGRE), p.Protocol, "must fail closed on the unknown protocol after the extension header")
|
||||||
assert.Equal(t, uint16(0), p.RemotePort)
|
assert.Equal(t, uint16(0), p.RemotePort)
|
||||||
assert.Equal(t, uint16(0), p.LocalPort)
|
assert.Equal(t, uint16(0), p.LocalPort)
|
||||||
assert.False(t, p.Fragment)
|
assert.False(t, p.Fragment)
|
||||||
|
|||||||
@@ -1,57 +0,0 @@
|
|||||||
//go:build !e2e_testing
|
|
||||||
|
|
||||||
package overlay
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"log/slog"
|
|
||||||
|
|
||||||
"golang.org/x/sys/windows"
|
|
||||||
"golang.org/x/sys/windows/registry"
|
|
||||||
)
|
|
||||||
|
|
||||||
var tcpipInterfaceKeys = []string{
|
|
||||||
`SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\Interfaces`,
|
|
||||||
`SYSTEM\CurrentControlSet\Services\Tcpip6\Parameters\Interfaces`,
|
|
||||||
}
|
|
||||||
|
|
||||||
// disableDNSRegistration prevents publishing overlay addresses in the host's
|
|
||||||
// DNS records, where clients outside the overlay cannot reach them.
|
|
||||||
// Failures are non-fatal so registry access cannot prevent tunnel creation.
|
|
||||||
func disableDNSRegistration(l *slog.Logger, guid windows.GUID) {
|
|
||||||
id := guid.String()
|
|
||||||
for _, base := range tcpipInterfaceKeys {
|
|
||||||
path := base + `\` + id
|
|
||||||
if err := setDNSRegistrationValues(path); err != nil {
|
|
||||||
l.Warn("Failed to disable DNS registration on the tun adapter", "error", err, "key", path)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
l.Debug("Disabled DNS registration on the tun adapter", "key", path)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func setDNSRegistrationValues(path string) error {
|
|
||||||
// The stack may not have created the adapter's interface key yet.
|
|
||||||
k, _, err := registry.CreateKey(registry.LOCAL_MACHINE, path, registry.SET_VALUE)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("open HKLM\\%s: %w", path, err)
|
|
||||||
}
|
|
||||||
defer k.Close()
|
|
||||||
|
|
||||||
// Neither RegistrationEnabled nor DisableDynamicUpdate alone reliably
|
|
||||||
// prevents registration, so all three settings are required.
|
|
||||||
values := []struct {
|
|
||||||
name string
|
|
||||||
data uint32
|
|
||||||
}{
|
|
||||||
{"RegistrationEnabled", 0},
|
|
||||||
{"DisableDynamicUpdate", 1},
|
|
||||||
{"MaxNumberOfAddressesToRegister", 0},
|
|
||||||
}
|
|
||||||
for _, v := range values {
|
|
||||||
if err := k.SetDWordValue(v.name, v.data); err != nil {
|
|
||||||
return fmt.Errorf("set %s: %w", v.name, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
+4
-28
@@ -50,13 +50,7 @@ func (r Route) String() string {
|
|||||||
|
|
||||||
func makeRouteTree(l *slog.Logger, routes []Route, allowMTU bool) (*bart.Table[routing.Gateways], error) {
|
func makeRouteTree(l *slog.Logger, routes []Route, allowMTU bool) (*bart.Table[routing.Gateways], error) {
|
||||||
routeTree := new(bart.Table[routing.Gateways])
|
routeTree := new(bart.Table[routing.Gateways])
|
||||||
seen := make(map[netip.Prefix]bool, len(routes))
|
|
||||||
for _, r := range routes {
|
for _, r := range routes {
|
||||||
if seen[r.Cidr] {
|
|
||||||
l.Warn("route is listed more than once, only the last entry's via is used", "route", r)
|
|
||||||
}
|
|
||||||
seen[r.Cidr] = true
|
|
||||||
|
|
||||||
if !allowMTU && r.MTU > 0 {
|
if !allowMTU && r.MTU > 0 {
|
||||||
l.Warn("route MTU is not supported on this platform",
|
l.Warn("route MTU is not supported on this platform",
|
||||||
"goos", runtime.GOOS,
|
"goos", runtime.GOOS,
|
||||||
@@ -104,11 +98,7 @@ func parseRoutes(c *config.C, networks []netip.Prefix) ([]Route, error) {
|
|||||||
|
|
||||||
mtu, ok := rMtu.(int)
|
mtu, ok := rMtu.(int)
|
||||||
if !ok {
|
if !ok {
|
||||||
s, ok := rMtu.(string)
|
mtu, err = strconv.Atoi(rMtu.(string))
|
||||||
if !ok {
|
|
||||||
return nil, fmt.Errorf("entry %v.mtu in tun.routes is not an integer: %v", i+1, rMtu)
|
|
||||||
}
|
|
||||||
mtu, err = strconv.Atoi(s)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("entry %v.mtu in tun.routes is not an integer: %v", i+1, err)
|
return nil, fmt.Errorf("entry %v.mtu in tun.routes is not an integer: %v", i+1, err)
|
||||||
}
|
}
|
||||||
@@ -184,11 +174,7 @@ func parseUnsafeRoutes(c *config.C, networks []netip.Prefix) ([]Route, error) {
|
|||||||
if rMtu, ok := m["mtu"]; ok {
|
if rMtu, ok := m["mtu"]; ok {
|
||||||
mtu, ok = rMtu.(int)
|
mtu, ok = rMtu.(int)
|
||||||
if !ok {
|
if !ok {
|
||||||
s, ok := rMtu.(string)
|
mtu, err = strconv.Atoi(rMtu.(string))
|
||||||
if !ok {
|
|
||||||
return nil, fmt.Errorf("entry %v.mtu in tun.unsafe_routes is not an integer: %v", i+1, rMtu)
|
|
||||||
}
|
|
||||||
mtu, err = strconv.Atoi(s)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("entry %v.mtu in tun.unsafe_routes is not an integer: %v", i+1, err)
|
return nil, fmt.Errorf("entry %v.mtu in tun.unsafe_routes is not an integer: %v", i+1, err)
|
||||||
}
|
}
|
||||||
@@ -206,15 +192,10 @@ func parseUnsafeRoutes(c *config.C, networks []netip.Prefix) ([]Route, error) {
|
|||||||
|
|
||||||
metric, ok := rMetric.(int)
|
metric, ok := rMetric.(int)
|
||||||
if !ok {
|
if !ok {
|
||||||
s, ok := rMetric.(string)
|
_, err = strconv.ParseInt(rMetric.(string), 10, 32)
|
||||||
if !ok {
|
|
||||||
return nil, fmt.Errorf("entry %v.metric in tun.unsafe_routes is not an integer: %v", i+1, rMetric)
|
|
||||||
}
|
|
||||||
n, err := strconv.ParseInt(s, 10, 32)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("entry %v.metric in tun.unsafe_routes is not an integer: %v", i+1, err)
|
return nil, fmt.Errorf("entry %v.metric in tun.unsafe_routes is not an integer: %v", i+1, err)
|
||||||
}
|
}
|
||||||
metric = int(n)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if metric < 0 || metric > math.MaxInt32 {
|
if metric < 0 || metric > math.MaxInt32 {
|
||||||
@@ -267,15 +248,10 @@ func parseUnsafeRoutes(c *config.C, networks []netip.Prefix) ([]Route, error) {
|
|||||||
|
|
||||||
gatewayWeight, ok := rGatewayWeight.(int)
|
gatewayWeight, ok := rGatewayWeight.(int)
|
||||||
if !ok {
|
if !ok {
|
||||||
s, ok := rGatewayWeight.(string)
|
_, err = strconv.ParseInt(rGatewayWeight.(string), 10, 32)
|
||||||
if !ok {
|
|
||||||
return nil, fmt.Errorf("entry .weight in tun.unsafe_routes[%v].via[%v] is not an integer", i+1, ig+1)
|
|
||||||
}
|
|
||||||
w, err := strconv.ParseInt(s, 10, 32)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("entry .weight in tun.unsafe_routes[%v].via[%v] is not an integer", i+1, ig+1)
|
return nil, fmt.Errorf("entry .weight in tun.unsafe_routes[%v].via[%v] is not an integer", i+1, ig+1)
|
||||||
}
|
}
|
||||||
gatewayWeight = int(w)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if gatewayWeight < 1 || gatewayWeight > math.MaxInt32 {
|
if gatewayWeight < 1 || gatewayWeight > math.MaxInt32 {
|
||||||
|
|||||||
@@ -1,17 +1,13 @@
|
|||||||
package overlay
|
package overlay
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"strings"
|
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
"github.com/slackhq/nebula/header"
|
|
||||||
"github.com/slackhq/nebula/routing"
|
"github.com/slackhq/nebula/routing"
|
||||||
"github.com/slackhq/nebula/test"
|
"github.com/slackhq/nebula/test"
|
||||||
"github.com/slackhq/nebula/udp"
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
@@ -406,115 +402,3 @@ func Test_makeMultipathUnsafeRouteTree(t *testing.T) {
|
|||||||
routing.CalculateBucketsForGateways(expectedGateways)
|
routing.CalculateBucketsForGateways(expectedGateways)
|
||||||
assert.ElementsMatch(t, expectedGateways, r)
|
assert.ElementsMatch(t, expectedGateways, r)
|
||||||
}
|
}
|
||||||
|
|
||||||
func Test_getMTU(t *testing.T) {
|
|
||||||
l := test.NewLogger()
|
|
||||||
c := config.NewC(l)
|
|
||||||
|
|
||||||
// unset
|
|
||||||
assert.Equal(t, DefaultMTU, getMTU(l, c))
|
|
||||||
|
|
||||||
// the largest a relayed packet can carry in one underlay buffer
|
|
||||||
require.Equal(t, udp.MTU, MaxMTU+header.MaxOverhead)
|
|
||||||
c.Settings["tun"] = map[string]any{"mtu": MaxMTU}
|
|
||||||
assert.Equal(t, MaxMTU, getMTU(l, c))
|
|
||||||
|
|
||||||
// too big is capped
|
|
||||||
c.Settings["tun"] = map[string]any{"mtu": 9000}
|
|
||||||
assert.Equal(t, MaxMTU, getMTU(l, c))
|
|
||||||
}
|
|
||||||
|
|
||||||
func Test_getAllRoutesFromConfigCapsMTU(t *testing.T) {
|
|
||||||
l := test.NewLogger()
|
|
||||||
c := config.NewC(l)
|
|
||||||
c.Settings["tun"] = map[string]any{
|
|
||||||
"routes": []any{
|
|
||||||
map[string]any{"mtu": "9000", "route": "10.0.0.0/29"},
|
|
||||||
map[string]any{"mtu": "1300", "route": "10.0.0.8/29"},
|
|
||||||
},
|
|
||||||
"unsafe_routes": []any{
|
|
||||||
map[string]any{"via": "127.0.0.1", "mtu": "9000", "route": "1.0.0.0/29"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
changed, routes, err := getAllRoutesFromConfig(l, c, []netip.Prefix{netip.MustParsePrefix("10.0.0.0/24")}, true)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.True(t, changed)
|
|
||||||
|
|
||||||
mtus := map[string]int{}
|
|
||||||
for _, r := range routes {
|
|
||||||
mtus[r.Cidr.String()] = r.MTU
|
|
||||||
}
|
|
||||||
assert.Equal(t, map[string]int{"10.0.0.0/29": MaxMTU, "10.0.0.8/29": 1300, "1.0.0.0/29": MaxMTU}, mtus)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The route tree keeps one entry per CIDR, so a CIDR listed twice only routes by the last one. Say so instead of
|
|
||||||
// letting the earlier via, or on Windows the earlier metric, quietly lose
|
|
||||||
func Test_makeRouteTree_WarnsOnDuplicate(t *testing.T) {
|
|
||||||
buf := &bytes.Buffer{}
|
|
||||||
l := test.NewLoggerWithOutput(buf)
|
|
||||||
via := func(s string) routing.Gateways {
|
|
||||||
return routing.Gateways{routing.NewGateway(netip.MustParseAddr(s), 1)}
|
|
||||||
}
|
|
||||||
cidr := netip.MustParsePrefix("10.251.1.0/24")
|
|
||||||
|
|
||||||
_, err := makeRouteTree(l, []Route{
|
|
||||||
{Cidr: cidr, Via: via("10.250.0.2"), Install: true, Metric: 100},
|
|
||||||
{Cidr: netip.MustParsePrefix("10.251.2.0/24"), Via: via("10.250.0.2"), Install: true},
|
|
||||||
}, false)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Empty(t, buf.String())
|
|
||||||
|
|
||||||
tree, err := makeRouteTree(l, []Route{
|
|
||||||
{Cidr: cidr, Via: via("10.250.0.2"), Install: true, Metric: 100},
|
|
||||||
{Cidr: cidr, Via: via("10.250.0.3"), Install: true, Metric: 200},
|
|
||||||
}, false)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Equal(t, 1, strings.Count(buf.String(), "route is listed more than once, only the last entry's via is used"))
|
|
||||||
gw, ok := tree.Lookup(netip.MustParseAddr("10.251.1.1"))
|
|
||||||
require.True(t, ok)
|
|
||||||
assert.Equal(t, netip.MustParseAddr("10.250.0.3"), gw[0].Addr(), "the last entry wins")
|
|
||||||
}
|
|
||||||
|
|
||||||
// A quoted metric or weight is a number written as a string, it means that number. Anything else is an error, not a
|
|
||||||
// panic
|
|
||||||
func Test_parseUnsafeRoutes_QuotedNumbers(t *testing.T) {
|
|
||||||
c := config.NewC(test.NewLogger())
|
|
||||||
n := netip.MustParsePrefix("10.0.0.1/24")
|
|
||||||
route := func(metric, weight any) {
|
|
||||||
c.Settings["tun"] = map[string]any{"unsafe_routes": []any{map[string]any{
|
|
||||||
"route": "1.0.0.0/8",
|
|
||||||
"metric": metric,
|
|
||||||
"via": []any{map[string]any{"gateway": "10.0.0.2", "weight": weight}},
|
|
||||||
}}}
|
|
||||||
}
|
|
||||||
|
|
||||||
route("100", "5")
|
|
||||||
routes, err := parseUnsafeRoutes(c, []netip.Prefix{n})
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Len(t, routes, 1)
|
|
||||||
assert.Equal(t, 100, routes[0].Metric)
|
|
||||||
assert.Equal(t, "{addr: 10.0.0.2, weight: 5}", routes[0].Via[0].String())
|
|
||||||
|
|
||||||
route(1.5, 1)
|
|
||||||
_, err = parseUnsafeRoutes(c, []netip.Prefix{n})
|
|
||||||
require.EqualError(t, err, "entry 1.metric in tun.unsafe_routes is not an integer: 1.5")
|
|
||||||
|
|
||||||
route(1, true)
|
|
||||||
_, err = parseUnsafeRoutes(c, []netip.Prefix{n})
|
|
||||||
require.EqualError(t, err, "entry .weight in tun.unsafe_routes[1].via[1] is not an integer")
|
|
||||||
}
|
|
||||||
|
|
||||||
// An mtu that is neither a number nor a quoted one is an error, not a panic
|
|
||||||
func Test_parseRoutes_MTUNotANumber(t *testing.T) {
|
|
||||||
c := config.NewC(test.NewLogger())
|
|
||||||
n := netip.MustParsePrefix("10.0.0.1/24")
|
|
||||||
|
|
||||||
c.Settings["tun"] = map[string]any{"routes": []any{map[string]any{"route": "1.0.0.0/8", "mtu": 1500.5}}}
|
|
||||||
_, err := parseRoutes(c, []netip.Prefix{n})
|
|
||||||
require.EqualError(t, err, "entry 1.mtu in tun.routes is not an integer: 1500.5")
|
|
||||||
|
|
||||||
c.Settings["tun"] = map[string]any{"unsafe_routes": []any{map[string]any{"route": "1.0.0.0/8", "via": "10.0.0.2", "mtu": 1500.5}}}
|
|
||||||
_, err = parseUnsafeRoutes(c, []netip.Prefix{n})
|
|
||||||
require.EqualError(t, err, "entry 1.mtu in tun.unsafe_routes is not an integer: 1500.5")
|
|
||||||
}
|
|
||||||
+1
-23
@@ -7,27 +7,11 @@ import (
|
|||||||
"net/netip"
|
"net/netip"
|
||||||
|
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
"github.com/slackhq/nebula/header"
|
|
||||||
"github.com/slackhq/nebula/udp"
|
|
||||||
"github.com/slackhq/nebula/util"
|
"github.com/slackhq/nebula/util"
|
||||||
)
|
)
|
||||||
|
|
||||||
const DefaultMTU = 1300
|
const DefaultMTU = 1300
|
||||||
|
|
||||||
// MaxMTU is the largest tun.mtu, or route mtu, the underlay can carry.
|
|
||||||
// Every underlay buffer is udp.MTU bytes, and a relayed packet adds header.MaxOverhead to its plaintext.
|
|
||||||
const MaxMTU = udp.MTU - header.MaxOverhead
|
|
||||||
|
|
||||||
// getMTU reads tun.mtu, capping a value too big for the underlay to carry.
|
|
||||||
func getMTU(l *slog.Logger, c *config.C) int {
|
|
||||||
mtu := c.GetInt("tun.mtu", DefaultMTU)
|
|
||||||
if mtu > MaxMTU {
|
|
||||||
l.Warn("tun.mtu is too big for the underlay to carry, capping it", "mtu", mtu, "maxMTU", MaxMTU)
|
|
||||||
return MaxMTU
|
|
||||||
}
|
|
||||||
return mtu
|
|
||||||
}
|
|
||||||
|
|
||||||
type NameError struct {
|
type NameError struct {
|
||||||
Name string
|
Name string
|
||||||
Underlying error
|
Underlying error
|
||||||
@@ -57,7 +41,7 @@ func NewFdDeviceFromConfig(fd *int) DeviceFactory {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func getAllRoutesFromConfig(l *slog.Logger, c *config.C, vpnNetworks []netip.Prefix, initial bool) (bool, []Route, error) {
|
func getAllRoutesFromConfig(c *config.C, vpnNetworks []netip.Prefix, initial bool) (bool, []Route, error) {
|
||||||
if !initial && !c.HasChanged("tun.routes") && !c.HasChanged("tun.unsafe_routes") {
|
if !initial && !c.HasChanged("tun.routes") && !c.HasChanged("tun.unsafe_routes") {
|
||||||
return false, nil, nil
|
return false, nil, nil
|
||||||
}
|
}
|
||||||
@@ -73,12 +57,6 @@ func getAllRoutesFromConfig(l *slog.Logger, c *config.C, vpnNetworks []netip.Pre
|
|||||||
}
|
}
|
||||||
|
|
||||||
routes = append(routes, unsafeRoutes...)
|
routes = append(routes, unsafeRoutes...)
|
||||||
for i, r := range routes {
|
|
||||||
if r.MTU > MaxMTU {
|
|
||||||
l.Warn("route mtu is too big for the underlay to carry, capping it", "route", r.Cidr, "mtu", r.MTU, "maxMTU", MaxMTU)
|
|
||||||
routes[i].MTU = MaxMTU
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return true, routes, nil
|
return true, routes, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -68,7 +68,7 @@ func (t *tun) Activate() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -126,7 +126,7 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
|||||||
f: os.NewFile(uintptr(fd), ""),
|
f: os.NewFile(uintptr(fd), ""),
|
||||||
Device: name,
|
Device: name,
|
||||||
vpnNetworks: vpnNetworks,
|
vpnNetworks: vpnNetworks,
|
||||||
DefaultMTU: getMTU(l, c),
|
DefaultMTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -167,7 +167,7 @@ func newTunFromFd(c *config.C, l *slog.Logger, deviceFd int, vpnNetworks []netip
|
|||||||
f: file,
|
f: file,
|
||||||
Device: utunNameFromFd(deviceFd),
|
Device: utunNameFromFd(deviceFd),
|
||||||
vpnNetworks: vpnNetworks,
|
vpnNetworks: vpnNetworks,
|
||||||
DefaultMTU: getMTU(l, c),
|
DefaultMTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||||
hostOwned: true,
|
hostOwned: true,
|
||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
@@ -350,7 +350,7 @@ func (t *tun) activate6(network netip.Prefix) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -370,7 +370,7 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
|||||||
t := &tun{
|
t := &tun{
|
||||||
Device: deviceName,
|
Device: deviceName,
|
||||||
vpnNetworks: vpnNetworks,
|
vpnNetworks: vpnNetworks,
|
||||||
MTU: getMTU(l, c),
|
MTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||||
l: l,
|
l: l,
|
||||||
fd: fd,
|
fd: fd,
|
||||||
shutdownR: shutdownR,
|
shutdownR: shutdownR,
|
||||||
@@ -510,7 +510,7 @@ func (t *tun) setMTU() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
+1
-1
@@ -68,7 +68,7 @@ func (t *tun) Activate() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
+3
-12
@@ -244,7 +244,7 @@ func newTunGeneric(c *config.C, l *slog.Logger, fd int, vnetHdr bool, offloadFla
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
routeChange, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
routeChange, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -253,15 +253,6 @@ func (t *tun) reload(c *config.C, initial bool) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Only the mtu changed. The routes are the same, parse them again so the ones without their own mtu pick up the
|
|
||||||
// new default. Without this an mtu change would remove them all
|
|
||||||
if !routeChange {
|
|
||||||
_, routes, err = getAllRoutesFromConfig(t.l, c, t.vpnNetworks, true)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
routeTree, err := makeRouteTree(t.l, routes, true)
|
routeTree, err := makeRouteTree(t.l, routes, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -276,14 +267,14 @@ func (t *tun) reload(c *config.C, initial bool) error {
|
|||||||
|
|
||||||
oldDefaultMTU := t.DefaultMTU
|
oldDefaultMTU := t.DefaultMTU
|
||||||
oldMaxMTU := t.MaxMTU
|
oldMaxMTU := t.MaxMTU
|
||||||
newDefaultMTU := getMTU(t.l, c)
|
newDefaultMTU := c.GetInt("tun.mtu", DefaultMTU)
|
||||||
newMaxMTU := newDefaultMTU
|
newMaxMTU := newDefaultMTU
|
||||||
for i, r := range routes {
|
for i, r := range routes {
|
||||||
if r.MTU == 0 {
|
if r.MTU == 0 {
|
||||||
routes[i].MTU = newDefaultMTU
|
routes[i].MTU = newDefaultMTU
|
||||||
}
|
}
|
||||||
|
|
||||||
if r.MTU > newMaxMTU {
|
if r.MTU > t.MaxMTU {
|
||||||
newMaxMTU = r.MTU
|
newMaxMTU = r.MTU
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -99,7 +99,7 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
|||||||
fd: fd,
|
fd: fd,
|
||||||
Device: deviceName,
|
Device: deviceName,
|
||||||
vpnNetworks: vpnNetworks,
|
vpnNetworks: vpnNetworks,
|
||||||
MTU: getMTU(l, c),
|
MTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -340,7 +340,7 @@ func (t *tun) doIoctlByName(ctl uintptr, value uint32) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -90,7 +90,7 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
|||||||
fd: fd,
|
fd: fd,
|
||||||
Device: deviceName,
|
Device: deviceName,
|
||||||
vpnNetworks: vpnNetworks,
|
vpnNetworks: vpnNetworks,
|
||||||
MTU: getMTU(l, c),
|
MTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -319,7 +319,7 @@ func (t *tun) doIoctlByName(ctl uintptr, value uint32) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,56 +0,0 @@
|
|||||||
//go:build !e2e_testing
|
|
||||||
|
|
||||||
package overlay
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/netip"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/config"
|
|
||||||
"github.com/slackhq/nebula/routing"
|
|
||||||
"github.com/slackhq/nebula/test"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Only tun.mtu changes. The system calls fail without a real device, what matters is the routes nebula keeps
|
|
||||||
func TestReloadMTUOnlyKeepsRoutes(t *testing.T) {
|
|
||||||
routes := " unsafe_routes:\n - route: 192.168.100.0/24\n via: 10.1.0.1\n"
|
|
||||||
c := config.NewC(test.NewLogger())
|
|
||||||
require.NoError(t, c.LoadString("tun:\n mtu: 1300\n"+routes))
|
|
||||||
|
|
||||||
tn := &tun{
|
|
||||||
l: test.NewLogger(),
|
|
||||||
vpnNetworks: []netip.Prefix{netip.MustParsePrefix("10.1.0.2/24")},
|
|
||||||
ioctlFd: ^uintptr(0),
|
|
||||||
routesFromSystem: map[netip.Prefix]routing.Gateways{},
|
|
||||||
}
|
|
||||||
require.NoError(t, tn.reload(c, true))
|
|
||||||
|
|
||||||
require.NoError(t, c.ReloadConfigString("tun:\n mtu: 1400\n"+routes))
|
|
||||||
_ = tn.reload(c, false)
|
|
||||||
|
|
||||||
got := *tn.Routes.Load()
|
|
||||||
require.Len(t, got, 1)
|
|
||||||
assert.Equal(t, netip.MustParsePrefix("192.168.100.0/24"), got[0].Cidr)
|
|
||||||
assert.Equal(t, 1400, got[0].MTU)
|
|
||||||
assert.Equal(t, 1400, tn.DefaultMTU)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The device mtu has to fit the largest route mtu, wherever it sits in the list
|
|
||||||
func TestReloadMaxMTUIsTheLargestRoute(t *testing.T) {
|
|
||||||
c := config.NewC(test.NewLogger())
|
|
||||||
require.NoError(t, c.LoadString("tun:\n mtu: 1300\n unsafe_routes:\n"+
|
|
||||||
" - route: 192.168.100.0/24\n via: 10.1.0.1\n mtu: 1500\n"+
|
|
||||||
" - route: 192.168.101.0/24\n via: 10.1.0.1\n mtu: 1400\n"))
|
|
||||||
|
|
||||||
tn := &tun{
|
|
||||||
l: test.NewLogger(),
|
|
||||||
vpnNetworks: []netip.Prefix{netip.MustParsePrefix("10.1.0.2/24")},
|
|
||||||
ioctlFd: ^uintptr(0),
|
|
||||||
routesFromSystem: map[netip.Prefix]routing.Gateways{},
|
|
||||||
}
|
|
||||||
require.NoError(t, tn.reload(c, true))
|
|
||||||
assert.Equal(t, 1500, tn.MaxMTU)
|
|
||||||
assert.Equal(t, 1300, tn.DefaultMTU)
|
|
||||||
}
|
|
||||||
@@ -31,7 +31,7 @@ type TestTun struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*TestTun, error) {
|
func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*TestTun, error) {
|
||||||
_, routes, err := getAllRoutesFromConfig(l, c, vpnNetworks, true)
|
_, routes, err := getAllRoutesFromConfig(c, vpnNetworks, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|||||||
+5
-79
@@ -4,7 +4,6 @@ package overlay
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"crypto"
|
"crypto"
|
||||||
"errors"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
@@ -76,7 +75,7 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*w
|
|||||||
t := &winTun{
|
t := &winTun{
|
||||||
Device: deviceName,
|
Device: deviceName,
|
||||||
vpnNetworks: vpnNetworks,
|
vpnNetworks: vpnNetworks,
|
||||||
MTU: getMTU(l, c),
|
MTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||||
guid: *guid,
|
guid: *guid,
|
||||||
networkCategory: cat,
|
networkCategory: cat,
|
||||||
setCategory: setCat,
|
setCategory: setCat,
|
||||||
@@ -105,9 +104,6 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*w
|
|||||||
}
|
}
|
||||||
t.tun = tunDevice.(*wintun.NativeTun)
|
t.tun = tunDevice.(*wintun.NativeTun)
|
||||||
|
|
||||||
// Disable registration before Activate assigns addresses and triggers it.
|
|
||||||
disableDNSRegistration(l, *guid)
|
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
err := t.reload(c, false)
|
err := t.reload(c, false)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -119,7 +115,7 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*w
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *winTun) reload(c *config.C, initial bool) error {
|
func (t *winTun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -139,7 +135,7 @@ func (t *winTun) reload(c *config.C, initial bool) error {
|
|||||||
|
|
||||||
if !initial {
|
if !initial {
|
||||||
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
||||||
err := t.removeRoutes(findRemovedSystemRoutes(routes, *oldRoutes))
|
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
||||||
}
|
}
|
||||||
@@ -188,27 +184,17 @@ func (t *winTun) addRoutes(logErrors bool) error {
|
|||||||
foundDefault4 := false
|
foundDefault4 := false
|
||||||
carriesV6 := slices.ContainsFunc(t.vpnNetworks, func(p netip.Prefix) bool { return p.Addr().Is6() })
|
carriesV6 := slices.ContainsFunc(t.vpnNetworks, func(p netip.Prefix) bool { return p.Addr().Is6() })
|
||||||
|
|
||||||
// A CIDR listed twice routes by its last entry, install only that one or each reload would flip between them. The
|
for _, r := range routes {
|
||||||
// same rule as systemRoutes
|
|
||||||
last := make(map[netip.Prefix]int, len(routes))
|
|
||||||
for i, r := range routes {
|
|
||||||
last[r.Cidr] = i
|
|
||||||
}
|
|
||||||
|
|
||||||
for i, r := range routes {
|
|
||||||
if len(r.Via) == 0 || !r.Install {
|
if len(r.Via) == 0 || !r.Install {
|
||||||
// We don't allow route MTUs so only install routes with a via
|
// We don't allow route MTUs so only install routes with a via
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
if last[r.Cidr] != i {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// A v6 unsafe_route is legal under a v4-only cert; uninstalled ones put nothing on the adapter.
|
// A v6 unsafe_route is legal under a v4-only cert; uninstalled ones put nothing on the adapter.
|
||||||
carriesV6 = carriesV6 || r.Cidr.Addr().Is6()
|
carriesV6 = carriesV6 || r.Cidr.Addr().Is6()
|
||||||
|
|
||||||
// Add our unsafe route as an on-link route to the nebula tun device.
|
// Add our unsafe route as an on-link route to the nebula tun device.
|
||||||
result, err := addRoute(luid, r)
|
err := luid.AddRoute(r.Cidr, unspecifiedNextHop(r.Cidr), uint32(r.Metric))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||||
if logErrors {
|
if logErrors {
|
||||||
@@ -218,12 +204,7 @@ func (t *winTun) addRoutes(logErrors bool) error {
|
|||||||
return retErr
|
return retErr
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
switch result {
|
|
||||||
case routeAdded:
|
|
||||||
t.l.Info("Added route", "route", r)
|
t.l.Info("Added route", "route", r)
|
||||||
case routeMetricUpdated:
|
|
||||||
t.l.Info("Updated route metric", "route", r)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if !foundDefault4 {
|
if !foundDefault4 {
|
||||||
@@ -335,61 +316,6 @@ func (t *winTun) Close() error {
|
|||||||
return t.tun.Close()
|
return t.tun.Close()
|
||||||
}
|
}
|
||||||
|
|
||||||
// systemRoutes maps each CIDR to the route that puts it in the system table. A CIDR's last entry decides, including
|
|
||||||
// one that says not to install it
|
|
||||||
func systemRoutes(routes []Route) map[netip.Prefix]Route {
|
|
||||||
out := make(map[netip.Prefix]Route, len(routes))
|
|
||||||
for _, r := range routes {
|
|
||||||
if len(r.Via) > 0 && r.Install {
|
|
||||||
out[r.Cidr] = r
|
|
||||||
} else {
|
|
||||||
delete(out, r.Cidr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
// findRemovedSystemRoutes is the routes to delete from the system table. Windows deletes by destination and next hop,
|
|
||||||
// so only a CIDR nothing installs anymore goes, a changed metric is set on the route in place by addRoute
|
|
||||||
func findRemovedSystemRoutes(newRoutes, oldRoutes []Route) []Route {
|
|
||||||
keep := systemRoutes(newRoutes)
|
|
||||||
var removed []Route
|
|
||||||
for _, r := range systemRoutes(oldRoutes) {
|
|
||||||
if _, ok := keep[r.Cidr]; !ok {
|
|
||||||
removed = append(removed, r)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return removed
|
|
||||||
}
|
|
||||||
|
|
||||||
type routeResult int
|
|
||||||
|
|
||||||
const (
|
|
||||||
routeAdded routeResult = iota
|
|
||||||
routeMetricUpdated
|
|
||||||
routeAlreadyInstalled
|
|
||||||
)
|
|
||||||
|
|
||||||
// addRoute installs r on the interface. A reload re-adds every route to catch any the system dropped, and Windows
|
|
||||||
// refuses one it has with the same destination and next hop whatever its metric. One that is there with another
|
|
||||||
// metric, ours from before a metric change or someone else's, is brought to ours in place
|
|
||||||
func addRoute(luid winipcfg.LUID, r Route) (routeResult, error) {
|
|
||||||
nextHop := unspecifiedNextHop(r.Cidr)
|
|
||||||
err := luid.AddRoute(r.Cidr, nextHop, uint32(r.Metric))
|
|
||||||
if !errors.Is(err, windows.ERROR_OBJECT_ALREADY_EXISTS) {
|
|
||||||
return routeAdded, err
|
|
||||||
}
|
|
||||||
row, err := luid.Route(r.Cidr, nextHop)
|
|
||||||
if err != nil {
|
|
||||||
return routeAlreadyInstalled, err
|
|
||||||
}
|
|
||||||
if row.Metric != uint32(r.Metric) {
|
|
||||||
row.Metric = uint32(r.Metric)
|
|
||||||
return routeMetricUpdated, row.Set()
|
|
||||||
}
|
|
||||||
return routeAlreadyInstalled, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func unspecifiedNextHop(p netip.Prefix) netip.Addr {
|
func unspecifiedNextHop(p netip.Prefix) netip.Addr {
|
||||||
if p.Addr().Is4() {
|
if p.Addr().Is4() {
|
||||||
return netip.IPv4Unspecified()
|
return netip.IPv4Unspecified()
|
||||||
|
|||||||
@@ -1,168 +0,0 @@
|
|||||||
//go:build windows && !e2e_testing
|
|
||||||
|
|
||||||
package overlay
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"fmt"
|
|
||||||
"net/netip"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/config"
|
|
||||||
"github.com/slackhq/nebula/test"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"golang.org/x/sys/windows"
|
|
||||||
"golang.zx2c4.com/wireguard/windows/tunnel/winipcfg"
|
|
||||||
)
|
|
||||||
|
|
||||||
type routeTest struct {
|
|
||||||
c *config.C
|
|
||||||
tun *winTun
|
|
||||||
luid winipcfg.LUID
|
|
||||||
log *bytes.Buffer
|
|
||||||
}
|
|
||||||
|
|
||||||
// newRouteTest makes a wintun device of its own, before installing tun.unsafe_routes from cfg
|
|
||||||
func newRouteTest(t *testing.T, cfg string) *routeTest {
|
|
||||||
t.Helper()
|
|
||||||
if !windows.GetCurrentProcessToken().IsElevated() {
|
|
||||||
t.Skip("creating a wintun device needs an elevated process")
|
|
||||||
}
|
|
||||||
if err := checkWinTunExists(); err != nil {
|
|
||||||
t.Skipf("wintun.dll is not where nebula looks for it: %v", err)
|
|
||||||
}
|
|
||||||
rt := &routeTest{log: &bytes.Buffer{}}
|
|
||||||
l := test.NewLoggerWithOutput(rt.log)
|
|
||||||
rt.c = config.NewC(l)
|
|
||||||
require.NoError(t, rt.c.LoadString(cfg))
|
|
||||||
var err error
|
|
||||||
rt.tun, err = newTun(rt.c, l, []netip.Prefix{netip.MustParsePrefix("10.250.0.1/24")}, false)
|
|
||||||
require.NoError(t, err)
|
|
||||||
t.Cleanup(func() { _ = rt.tun.Close() })
|
|
||||||
rt.luid = winipcfg.LUID(rt.tun.tun.LUID())
|
|
||||||
return rt
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rt *routeTest) metric(t *testing.T, cidr string) uint32 {
|
|
||||||
t.Helper()
|
|
||||||
p := netip.MustParsePrefix(cidr)
|
|
||||||
row, err := rt.luid.Route(p, unspecifiedNextHop(p))
|
|
||||||
require.NoError(t, err)
|
|
||||||
return row.Metric
|
|
||||||
}
|
|
||||||
|
|
||||||
func unsafeRoutes(routes ...string) string {
|
|
||||||
var b strings.Builder
|
|
||||||
b.WriteString("tun:\n dev: nebroutetest\n unsafe_routes:\n")
|
|
||||||
// cidr[@metric][!], the ! for install: false
|
|
||||||
for _, r := range routes {
|
|
||||||
r, noInstall := strings.CutSuffix(r, "!")
|
|
||||||
cidr, metric, _ := strings.Cut(r, "@")
|
|
||||||
fmt.Fprintf(&b, " - route: %s\n via: 10.250.0.2\n", cidr)
|
|
||||||
if metric != "" {
|
|
||||||
fmt.Fprintf(&b, " metric: %s\n", metric)
|
|
||||||
}
|
|
||||||
if noInstall {
|
|
||||||
b.WriteString(" install: false\n")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return b.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// A reload that adds a route re-adds the ones already installed, Windows refusing those as already there isn't a failure
|
|
||||||
func TestWinTun_ReloadKeepsInstalledRoutes(t *testing.T) {
|
|
||||||
forFamilies(t, func(t *testing.T, a, b string) {
|
|
||||||
rt := newRouteTest(t, unsafeRoutes(a))
|
|
||||||
require.NoError(t, rt.tun.Activate())
|
|
||||||
|
|
||||||
require.NoError(t, rt.c.ReloadConfigString(unsafeRoutes(a, b)))
|
|
||||||
assert.NotContains(t, rt.log.String(), "Failed to add route")
|
|
||||||
rt.metric(t, a)
|
|
||||||
rt.metric(t, b)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// Windows calls a route the same by destination and next hop, so a changed metric is set on the installed route in
|
|
||||||
// place rather than deleted and added, which would leave a moment with no route
|
|
||||||
func TestWinTun_ReloadMetricChangeApplies(t *testing.T) {
|
|
||||||
forFamilies(t, func(t *testing.T, a, b string) {
|
|
||||||
rt := newRouteTest(t, unsafeRoutes(a+"@100"))
|
|
||||||
require.NoError(t, rt.tun.Activate())
|
|
||||||
require.Equal(t, uint32(100), rt.metric(t, a))
|
|
||||||
|
|
||||||
require.NoError(t, rt.c.ReloadConfigString(unsafeRoutes(a+"@200")))
|
|
||||||
assert.NotContains(t, rt.log.String(), "Failed to add route")
|
|
||||||
assert.NotContains(t, rt.log.String(), "Removed route")
|
|
||||||
assert.Equal(t, uint32(200), rt.metric(t, a))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// A route someone else put on the device with another metric is brought to ours, at startup too
|
|
||||||
func TestWinTun_ForeignRouteGetsOurMetric(t *testing.T) {
|
|
||||||
forFamilies(t, func(t *testing.T, a, b string) {
|
|
||||||
rt := newRouteTest(t, unsafeRoutes(a+"@100"))
|
|
||||||
p := netip.MustParsePrefix(a)
|
|
||||||
require.NoError(t, rt.luid.AddRoute(p, unspecifiedNextHop(p), 50))
|
|
||||||
|
|
||||||
require.NoError(t, rt.tun.Activate())
|
|
||||||
assert.Equal(t, uint32(100), rt.metric(t, a))
|
|
||||||
assert.Contains(t, rt.log.String(), "level=INFO msg=\"Updated route metric\"")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// A CIDR listed twice is installed once, by its last entry, and reloads leave it there instead of flipping between the
|
|
||||||
// two metrics
|
|
||||||
func TestWinTun_DuplicateCidrInstallsTheLastEntry(t *testing.T) {
|
|
||||||
forFamilies(t, func(t *testing.T, a, b string) {
|
|
||||||
rt := newRouteTest(t, unsafeRoutes(a+"@100", a+"@200"))
|
|
||||||
require.NoError(t, rt.tun.Activate())
|
|
||||||
assert.Equal(t, uint32(200), rt.metric(t, a))
|
|
||||||
|
|
||||||
require.NoError(t, rt.c.ReloadConfigString(unsafeRoutes(a+"@100", a+"@200", b)))
|
|
||||||
assert.Equal(t, uint32(200), rt.metric(t, a))
|
|
||||||
assert.NotContains(t, rt.log.String(), "Updated route metric")
|
|
||||||
assert.NotContains(t, rt.log.String(), "Failed to add route")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// Dropping the duplicate that wasn't installed leaves the installed route alone. Windows deletes by destination and
|
|
||||||
// next hop, deleting the dropped one would take the live route with it
|
|
||||||
func TestWinTun_DroppingAnUninstalledDuplicateKeepsTheRoute(t *testing.T) {
|
|
||||||
forFamilies(t, func(t *testing.T, a, b string) {
|
|
||||||
rt := newRouteTest(t, unsafeRoutes(a+"@100", a+"@200"))
|
|
||||||
require.NoError(t, rt.tun.Activate())
|
|
||||||
|
|
||||||
require.NoError(t, rt.c.ReloadConfigString(unsafeRoutes(a+"@200")))
|
|
||||||
assert.NotContains(t, rt.log.String(), "Removed route")
|
|
||||||
assert.Equal(t, uint32(200), rt.metric(t, a))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// A reload ends where a fresh start with the same config would, a CIDR whose last entry says not to install it is
|
|
||||||
// removed
|
|
||||||
func TestWinTun_ReloadMatchesAFreshStart(t *testing.T) {
|
|
||||||
forFamilies(t, func(t *testing.T, a, b string) {
|
|
||||||
cidr := netip.MustParsePrefix(a)
|
|
||||||
routes := unsafeRoutes(a+"@100", a+"@100!")
|
|
||||||
|
|
||||||
fresh := newRouteTest(t, routes)
|
|
||||||
require.NoError(t, fresh.tun.Activate())
|
|
||||||
_, err := fresh.luid.Route(cidr, unspecifiedNextHop(cidr))
|
|
||||||
require.Error(t, err, "a fresh start installed it")
|
|
||||||
require.NoError(t, fresh.tun.Close())
|
|
||||||
|
|
||||||
rt := newRouteTest(t, unsafeRoutes(a+"@100"))
|
|
||||||
require.NoError(t, rt.tun.Activate())
|
|
||||||
require.NoError(t, rt.c.ReloadConfigString(routes))
|
|
||||||
_, err = rt.luid.Route(cidr, unspecifiedNextHop(cidr))
|
|
||||||
assert.Error(t, err, "the reload left it installed")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// forFamilies runs f with two unsafe_routes CIDRs of each address family, the tun's own network stays IPv4
|
|
||||||
func forFamilies(t *testing.T, f func(t *testing.T, a, b string)) {
|
|
||||||
t.Run("ipv4", func(t *testing.T) { f(t, "10.251.1.0/24", "10.251.2.0/24") })
|
|
||||||
t.Run("ipv6", func(t *testing.T) { f(t, "fd00:251:1::/64", "fd00:251:2::/64") })
|
|
||||||
}
|
|
||||||
@@ -1,91 +0,0 @@
|
|||||||
package ratelimit
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"math"
|
|
||||||
"sync/atomic"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Limiter is a token bucket: `burst` calls are allowed at once, then one more per `every`.
|
|
||||||
// It counts the calls it denies and hands that count to the next allowed call.
|
|
||||||
//
|
|
||||||
// The budget belongs to the Limiter instance.
|
|
||||||
// Every Allow that returns true spends from it, whatever the caller then does.
|
|
||||||
//
|
|
||||||
// Time follows Go's monotonic clock.
|
|
||||||
//
|
|
||||||
// Create one Limiter for each thing you want to limit,
|
|
||||||
// sharing one between unrelated events lets the noisy one starve the quiet one.
|
|
||||||
//
|
|
||||||
// Check Allow before doing the work being limited, so a denied call stays cheap:
|
|
||||||
//
|
|
||||||
// if denied, ok := probeLimiter.Allow(); ok {
|
|
||||||
// sendProbe()
|
|
||||||
// probesDenied.Inc(int64(denied))
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// For log lines use logging.RateLimited, which attaches the denied count to the logger as "suppressed".
|
|
||||||
type Limiter struct {
|
|
||||||
every int64
|
|
||||||
slack int64
|
|
||||||
tat atomic.Int64
|
|
||||||
denied atomic.Uint64
|
|
||||||
}
|
|
||||||
|
|
||||||
// maxSpan bounds `burst` * `every` to half of int64, leaving the other half for process uptime so the bucket
|
|
||||||
// math can't overflow.
|
|
||||||
const maxSpan = math.MaxInt64 / 2
|
|
||||||
|
|
||||||
// New returns a Limiter allowing `burst` calls at once and one more per `every`.
|
|
||||||
// A `burst` under 1 is 1, and an `every` of 0 or less never limits.
|
|
||||||
// It returns an error if `burst` * `every` is over about 146 years.
|
|
||||||
func New(burst int, every time.Duration) (*Limiter, error) {
|
|
||||||
l := &Limiter{}
|
|
||||||
if every > 0 {
|
|
||||||
burst = max(burst, 1)
|
|
||||||
if int64(burst) > maxSpan/int64(every) {
|
|
||||||
return nil, fmt.Errorf("ratelimit: burst %d * every %v is too long", burst, every)
|
|
||||||
}
|
|
||||||
l.every = int64(every)
|
|
||||||
l.slack = int64(burst-1) * l.every
|
|
||||||
}
|
|
||||||
return l, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
var monoStart = time.Now()
|
|
||||||
|
|
||||||
func monoNow() int64 { return int64(time.Since(monoStart)) }
|
|
||||||
|
|
||||||
// Allow reports whether this call is allowed.
|
|
||||||
// If a token is available it spends it and returns the calls denied since the last allowed one, and true.
|
|
||||||
// Otherwise it returns 0 and false, and counts the denial.
|
|
||||||
// A nil Limiter allows everything.
|
|
||||||
func (l *Limiter) Allow() (uint64, bool) {
|
|
||||||
if l == nil {
|
|
||||||
return 0, true
|
|
||||||
}
|
|
||||||
return l.allow(monoNow())
|
|
||||||
}
|
|
||||||
|
|
||||||
// allow is Allow at a given monotonic time.
|
|
||||||
func (l *Limiter) allow(now int64) (uint64, bool) {
|
|
||||||
// Concurrent Allow calls read the clock before racing for the bucket, so one can see a time another already spent
|
|
||||||
// past and be denied. An unlimited Limiter must never deny, so it skips the bucket.
|
|
||||||
if l.every == 0 {
|
|
||||||
return 0, true
|
|
||||||
}
|
|
||||||
|
|
||||||
for {
|
|
||||||
tat := l.tat.Load()
|
|
||||||
next := max(tat, now)
|
|
||||||
if next-now > l.slack {
|
|
||||||
l.denied.Add(1)
|
|
||||||
return 0, false
|
|
||||||
}
|
|
||||||
|
|
||||||
if l.tat.CompareAndSwap(tat, next+l.every) {
|
|
||||||
return l.denied.Swap(0), true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,264 +0,0 @@
|
|||||||
package ratelimit
|
|
||||||
|
|
||||||
import (
|
|
||||||
"math"
|
|
||||||
"sync"
|
|
||||||
"sync/atomic"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
func mustLimiter(t testing.TB, burst int, every time.Duration) *Limiter {
|
|
||||||
t.Helper()
|
|
||||||
l, err := New(burst, every)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
return l
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLimiterBurstAndRefill(t *testing.T) {
|
|
||||||
l, now := mustLimiter(t, 3, time.Second), int64(0)
|
|
||||||
|
|
||||||
for i := 0; i < 3; i++ {
|
|
||||||
if n, ok := l.allow(now); !ok || n != 0 {
|
|
||||||
t.Fatalf("burst line %d: ok=%v denied=%d", i, ok, n)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
for i := 0; i < 5; i++ {
|
|
||||||
if _, ok := l.allow(now); ok {
|
|
||||||
t.Fatalf("line %d past the burst logged", i)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
now += int64(time.Second)
|
|
||||||
if n, ok := l.allow(now); !ok || n != 5 {
|
|
||||||
t.Fatalf("after one refill: ok=%v denied=%d, want true 5", ok, n)
|
|
||||||
}
|
|
||||||
if _, ok := l.allow(now); ok {
|
|
||||||
t.Fatal("one refill earned more than one line")
|
|
||||||
}
|
|
||||||
|
|
||||||
// A long quiet spell refills to burst, not past it, and the count reported above does not carry over.
|
|
||||||
now += int64(time.Hour)
|
|
||||||
for i, want := range []uint64{1, 0, 0} {
|
|
||||||
if n, ok := l.allow(now); !ok || n != want {
|
|
||||||
t.Fatalf("refilled line %d: ok=%v denied=%d, want true %d", i, ok, n, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if _, ok := l.allow(now); ok {
|
|
||||||
t.Fatal("bucket refilled past burst")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLimiterBounds(t *testing.T) {
|
|
||||||
for _, every := range []time.Duration{0, -time.Second} {
|
|
||||||
l := mustLimiter(t, 1, every)
|
|
||||||
for i := 0; i < 100; i++ {
|
|
||||||
if _, ok := l.allow(0); !ok {
|
|
||||||
t.Fatalf("every=%v limited line %d", every, i)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
l := mustLimiter(t, 0, time.Second)
|
|
||||||
if _, ok := l.allow(0); !ok {
|
|
||||||
t.Fatal("burst 0 should allow one line")
|
|
||||||
}
|
|
||||||
if _, ok := l.allow(0); ok {
|
|
||||||
t.Fatal("burst 0 should allow only one line")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLimiterOverflow(t *testing.T) {
|
|
||||||
for _, c := range []struct {
|
|
||||||
burst int
|
|
||||||
every time.Duration
|
|
||||||
}{
|
|
||||||
{math.MaxInt, time.Second},
|
|
||||||
{1, math.MaxInt64},
|
|
||||||
{2, maxSpan/2 + 1},
|
|
||||||
} {
|
|
||||||
if _, err := New(c.burst, c.every); err == nil {
|
|
||||||
t.Fatalf("burst %d every %d should not fit", c.burst, c.every)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
l := mustLimiter(t, 2, maxSpan/2)
|
|
||||||
for i := 0; i < 2; i++ {
|
|
||||||
if _, ok := l.allow(0); !ok {
|
|
||||||
t.Fatalf("the largest span should allow its burst, denied call %d", i)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if _, ok := l.allow(0); ok {
|
|
||||||
t.Fatal("the largest span allowed past its burst")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Concurrent callers read the clock at slightly different times, which must not limit a Limiter that never limits.
|
|
||||||
func TestLimiterUnlimitedConcurrent(t *testing.T) {
|
|
||||||
l := mustLimiter(t, 1, 0)
|
|
||||||
|
|
||||||
var denied atomic.Int64
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
for i := 0; i < 16; i++ {
|
|
||||||
wg.Add(1)
|
|
||||||
go func() {
|
|
||||||
defer wg.Done()
|
|
||||||
for j := 0; j < 10000; j++ {
|
|
||||||
if _, ok := l.Allow(); !ok {
|
|
||||||
denied.Add(1)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
wg.Wait()
|
|
||||||
|
|
||||||
if got := denied.Load(); got != 0 {
|
|
||||||
t.Fatalf("denied %d lines", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLimiterNil(t *testing.T) {
|
|
||||||
var l *Limiter
|
|
||||||
for i := 0; i < 10; i++ {
|
|
||||||
if _, ok := l.Allow(); !ok {
|
|
||||||
t.Fatal("nil limiter limited")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLimiterConcurrent(t *testing.T) {
|
|
||||||
l := mustLimiter(t, 10, time.Hour)
|
|
||||||
|
|
||||||
var allowed atomic.Int64
|
|
||||||
var reported atomic.Uint64
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
for i := 0; i < 16; i++ {
|
|
||||||
wg.Add(1)
|
|
||||||
go func() {
|
|
||||||
defer wg.Done()
|
|
||||||
for j := 0; j < 1000; j++ {
|
|
||||||
if n, ok := l.allow(0); ok {
|
|
||||||
allowed.Add(1)
|
|
||||||
reported.Add(n)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
wg.Wait()
|
|
||||||
|
|
||||||
if got := allowed.Load(); got != 10 {
|
|
||||||
t.Fatalf("allowed %d lines, want the burst of 10", got)
|
|
||||||
}
|
|
||||||
// An allowed call that lands after some denials reports them, so the rest are still pending.
|
|
||||||
if got := reported.Load() + l.denied.Load(); got != 16*1000-10 {
|
|
||||||
t.Fatalf("denied %d, want %d", got, 16*1000-10)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkAllowAllowed(b *testing.B) {
|
|
||||||
l := mustLimiter(b, 1, time.Nanosecond)
|
|
||||||
b.ReportAllocs()
|
|
||||||
for i := 0; i < b.N; i++ {
|
|
||||||
l.tat.Store(0)
|
|
||||||
l.Allow()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkAllowDenied(b *testing.B) {
|
|
||||||
l := mustLimiter(b, 1, time.Hour)
|
|
||||||
l.Allow()
|
|
||||||
b.ReportAllocs()
|
|
||||||
for i := 0; i < b.N; i++ {
|
|
||||||
l.Allow()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkAllowDeniedParallel(b *testing.B) {
|
|
||||||
l := mustLimiter(b, 1, time.Hour)
|
|
||||||
l.Allow()
|
|
||||||
b.ReportAllocs()
|
|
||||||
b.RunParallel(func(pb *testing.PB) {
|
|
||||||
for pb.Next() {
|
|
||||||
l.Allow()
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// FuzzLimiter checks the bucket against its exact definition over arbitrary call timings.
|
|
||||||
// A call is denied if and only if some allowed call a would leave too many calls for the time since a:
|
|
||||||
// (allowed calls since a, plus this one) * every > burst * every + (now - a).
|
|
||||||
// Every denied call must also be reported exactly once, by a later allowed call or still pending.
|
|
||||||
func FuzzLimiter(f *testing.F) {
|
|
||||||
f.Add(uint8(3), uint16(1000), []byte{0, 0, 0, 0, 16, 0, 0, 200, 1, 1, 1, 15, 17, 0})
|
|
||||||
f.Add(uint8(1), uint16(1), []byte{0, 16, 15, 16, 0, 255, 0, 0})
|
|
||||||
f.Fuzz(func(t *testing.T, burst uint8, everyUs uint16, steps []byte) {
|
|
||||||
if len(steps) > 512 {
|
|
||||||
steps = steps[:512]
|
|
||||||
}
|
|
||||||
b := int64(burst%16) + 1
|
|
||||||
every := int64(everyUs%1000+1) * int64(time.Microsecond)
|
|
||||||
l := mustLimiter(t, int(b), time.Duration(every))
|
|
||||||
|
|
||||||
var now int64
|
|
||||||
var allowedAt []int64
|
|
||||||
var denied, reported uint64
|
|
||||||
for _, s := range steps {
|
|
||||||
// Each step advances by a sixteenth of every, so timings land on and around the refill.
|
|
||||||
now += int64(s) * every / 16
|
|
||||||
|
|
||||||
over := false
|
|
||||||
for i, a := range allowedAt {
|
|
||||||
if int64(len(allowedAt)-i+1)*every > b*every+now-a {
|
|
||||||
over = true
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
n, ok := l.allow(now)
|
|
||||||
if ok == over {
|
|
||||||
t.Fatalf("at %d with %d allowed before: ok=%v, the definition says %v", now, len(allowedAt), ok, !over)
|
|
||||||
}
|
|
||||||
if !ok {
|
|
||||||
denied++
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
reported += n
|
|
||||||
allowedAt = append(allowedAt, now)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := reported + l.denied.Load(); got != denied {
|
|
||||||
t.Fatalf("reported %d denied calls, made %d", got, denied)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// Concurrent callers on the real clock must account for every denied call exactly once.
|
|
||||||
func TestLimiterDeniedConservedConcurrent(t *testing.T) {
|
|
||||||
l := mustLimiter(t, 4, time.Microsecond)
|
|
||||||
|
|
||||||
var denied, reported atomic.Uint64
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
for i := 0; i < 16; i++ {
|
|
||||||
wg.Add(1)
|
|
||||||
go func() {
|
|
||||||
defer wg.Done()
|
|
||||||
for j := 0; j < 20000; j++ {
|
|
||||||
if n, ok := l.Allow(); ok {
|
|
||||||
reported.Add(n)
|
|
||||||
} else {
|
|
||||||
denied.Add(1)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
wg.Wait()
|
|
||||||
|
|
||||||
if denied.Load() == 0 {
|
|
||||||
t.Fatal("nothing was denied, the test proves nothing")
|
|
||||||
}
|
|
||||||
if got := reported.Load() + l.denied.Load(); got != denied.Load() {
|
|
||||||
t.Fatalf("reported %d denied calls, made %d", got, denied.Load())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -684,14 +684,10 @@ func sshCreateTunnel(ifce *Interface, fs any, a []string, w sshd.StringWriter) e
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Set the remote from the callback, which StartHandshake runs under the handshake manager lock
|
hostInfo = ifce.handshakeManager.StartHandshake(vpnAddr, nil)
|
||||||
// before the hostinfo reaches the handshake loop or the static-host trigger, so the address is
|
|
||||||
// in the RemoteList before the first handshake is sent.
|
|
||||||
ifce.handshakeManager.StartHandshake(vpnAddr, func(hh *HandshakeHostInfo) {
|
|
||||||
if addr.IsValid() {
|
if addr.IsValid() {
|
||||||
hh.hostinfo.SetRemote(addr)
|
hostInfo.SetRemote(addr)
|
||||||
}
|
}
|
||||||
})
|
|
||||||
|
|
||||||
return w.WriteLine("Created")
|
return w.WriteLine("Created")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -38,11 +38,6 @@ type statsServer struct {
|
|||||||
runMu sync.Mutex
|
runMu sync.Mutex
|
||||||
runCfg *statsConfig
|
runCfg *statsConfig
|
||||||
run *statsRuntime // non-nil while a runtime is live
|
run *statsRuntime // non-nil while a runtime is live
|
||||||
// Closed when the last runtime's capture loop has returned. Stop waits on it so nothing captures once it returns,
|
|
||||||
// and a reload's new runtime never overlaps the old one, go-metrics keeps its GC capture state in unguarded globals
|
|
||||||
loopDone chan struct{}
|
|
||||||
// See newStatsServerFromConfig, never changes after it
|
|
||||||
emitStats func()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// statsRuntime is the live state owned by a single Start invocation. Start
|
// statsRuntime is the live state owned by a single Start invocation. Start
|
||||||
@@ -87,16 +82,12 @@ type promConfig struct {
|
|||||||
//
|
//
|
||||||
// Start is safe to call unconditionally: it no-ops when stats are disabled.
|
// Start is safe to call unconditionally: it no-ops when stats are disabled.
|
||||||
// The returned pointer is always non-nil, even on error.
|
// The returned pointer is always non-nil, even on error.
|
||||||
//
|
func newStatsServerFromConfig(ctx context.Context, l *slog.Logger, c *config.C, buildVersion string, configTest bool) (*statsServer, error) {
|
||||||
// emitStats, if set, updates metrics on every capture, ahead of the exporters so each export sees what it just set. It
|
|
||||||
// is fixed here, before the reload callback exists, so every runtime has it.
|
|
||||||
func newStatsServerFromConfig(ctx context.Context, l *slog.Logger, c *config.C, buildVersion string, configTest bool, emitStats func()) (*statsServer, error) {
|
|
||||||
s := &statsServer{
|
s := &statsServer{
|
||||||
l: l,
|
l: l,
|
||||||
ctx: ctx,
|
ctx: ctx,
|
||||||
buildVersion: buildVersion,
|
buildVersion: buildVersion,
|
||||||
configTest: configTest,
|
configTest: configTest,
|
||||||
emitStats: emitStats,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
@@ -129,6 +120,7 @@ func (s *statsServer) reload(c *config.C, initial bool) error {
|
|||||||
s.runMu.Lock()
|
s.runMu.Lock()
|
||||||
sameCfg := s.runCfg != nil && *s.runCfg == newCfg
|
sameCfg := s.runCfg != nil && *s.runCfg == newCfg
|
||||||
s.runCfg = &newCfg
|
s.runCfg = &newCfg
|
||||||
|
running := s.run != nil
|
||||||
s.runMu.Unlock()
|
s.runMu.Unlock()
|
||||||
|
|
||||||
s.enabled.Store(enabled)
|
s.enabled.Store(enabled)
|
||||||
@@ -137,8 +129,9 @@ func (s *statsServer) reload(c *config.C, initial bool) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Even with nothing running, a runtime whose listener failed can still be finishing its last pass
|
if running {
|
||||||
s.Stop()
|
s.Stop()
|
||||||
|
}
|
||||||
if enabled && !s.configTest {
|
if enabled && !s.configTest {
|
||||||
go s.Start()
|
go s.Start()
|
||||||
}
|
}
|
||||||
@@ -160,19 +153,13 @@ func (s *statsServer) Start() {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
cfg := *s.runCfg
|
cfg := *s.runCfg
|
||||||
|
captureFns, listener := s.buildRuntime(cfg)
|
||||||
runCtx, cancel := context.WithCancel(s.ctx)
|
runCtx, cancel := context.WithCancel(s.ctx)
|
||||||
captureFns, listener := s.buildRuntime(runCtx, cfg)
|
|
||||||
rt := &statsRuntime{cancel: cancel, listener: listener}
|
rt := &statsRuntime{cancel: cancel, listener: listener}
|
||||||
s.run = rt
|
s.run = rt
|
||||||
done := make(chan struct{})
|
|
||||||
s.loopDone = done
|
|
||||||
s.runMu.Unlock()
|
s.runMu.Unlock()
|
||||||
|
|
||||||
// Prime before serving, so a scrape that lands before the first tick sees real values instead of zeros (issue #907)
|
go captureStatsLoop(runCtx, cfg.interval, captureFns)
|
||||||
for _, fn := range captureFns {
|
|
||||||
fn()
|
|
||||||
}
|
|
||||||
go captureStatsLoop(runCtx, cfg.interval, captureFns, done)
|
|
||||||
|
|
||||||
cleanExit := true
|
cleanExit := true
|
||||||
if listener == nil {
|
if listener == nil {
|
||||||
@@ -231,12 +218,13 @@ func (s *statsServer) serveListener(listener *http.Server) bool {
|
|||||||
|
|
||||||
// Stop tears down the active runtime, if any. Idempotent.
|
// Stop tears down the active runtime, if any. Idempotent.
|
||||||
func (s *statsServer) Stop() {
|
func (s *statsServer) Stop() {
|
||||||
// Held until the last pass is done, a Start that slipped in after s.run cleared would capture alongside it
|
|
||||||
s.runMu.Lock()
|
s.runMu.Lock()
|
||||||
defer s.runMu.Unlock()
|
|
||||||
rt := s.run
|
rt := s.run
|
||||||
s.run = nil
|
s.run = nil
|
||||||
if rt != nil {
|
s.runMu.Unlock()
|
||||||
|
if rt == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
rt.cancel()
|
rt.cancel()
|
||||||
if rt.listener != nil {
|
if rt.listener != nil {
|
||||||
shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||||
@@ -246,17 +234,10 @@ func (s *statsServer) Stop() {
|
|||||||
cancel()
|
cancel()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// Nothing captures once Stop returns. The last runtime is cancelled by now, whoever cleared it, so this is at most
|
|
||||||
// the pass it was in. Nothing in a pass takes runMu
|
|
||||||
if s.loopDone != nil {
|
|
||||||
<-s.loopDone
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// buildRuntime produces the capture functions and, for prometheus, an un-served
|
// buildRuntime produces the capture functions and, for prometheus, an un-served
|
||||||
// http.Server from cfg. cfg has already been validated by loadStatsConfig.
|
// http.Server from cfg. cfg has already been validated by loadStatsConfig.
|
||||||
// A graphite send in progress is abandoned when ctx is done.
|
func (s *statsServer) buildRuntime(cfg statsConfig) ([]func(), *http.Server) {
|
||||||
func (s *statsServer) buildRuntime(ctx context.Context, cfg statsConfig) ([]func(), *http.Server) {
|
|
||||||
// rcrowley/go-metrics guards these registrations with a private sync.Once,
|
// rcrowley/go-metrics guards these registrations with a private sync.Once,
|
||||||
// so subsequent reloads are no-ops.
|
// so subsequent reloads are no-ops.
|
||||||
metrics.RegisterDebugGCStats(metrics.DefaultRegistry)
|
metrics.RegisterDebugGCStats(metrics.DefaultRegistry)
|
||||||
@@ -266,9 +247,6 @@ func (s *statsServer) buildRuntime(ctx context.Context, cfg statsConfig) ([]func
|
|||||||
func() { metrics.CaptureDebugGCStatsOnce(metrics.DefaultRegistry) },
|
func() { metrics.CaptureDebugGCStatsOnce(metrics.DefaultRegistry) },
|
||||||
func() { metrics.CaptureRuntimeMemStatsOnce(metrics.DefaultRegistry) },
|
func() { metrics.CaptureRuntimeMemStatsOnce(metrics.DefaultRegistry) },
|
||||||
}
|
}
|
||||||
if s.emitStats != nil {
|
|
||||||
captureFns = append(captureFns, s.emitStats)
|
|
||||||
}
|
|
||||||
|
|
||||||
switch cfg.typ {
|
switch cfg.typ {
|
||||||
case "graphite":
|
case "graphite":
|
||||||
@@ -284,7 +262,7 @@ func (s *statsServer) buildRuntime(ctx context.Context, cfg statsConfig) ([]func
|
|||||||
Percentiles: []float64{0.5, 0.75, 0.95, 0.99, 0.999},
|
Percentiles: []float64{0.5, 0.75, 0.95, 0.99, 0.999},
|
||||||
}
|
}
|
||||||
captureFns = append(captureFns, func() {
|
captureFns = append(captureFns, func() {
|
||||||
if err := graphiteOnce(ctx, gcfg, graphiteTimeout); err != nil && ctx.Err() == nil {
|
if err := graphiteOnce(gcfg); err != nil {
|
||||||
s.l.Error("Graphite export failed", "error", err)
|
s.l.Error("Graphite export failed", "error", err)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -331,10 +309,8 @@ func (s *statsServer) buildRuntime(ctx context.Context, cfg statsConfig) ([]func
|
|||||||
return captureFns, nil
|
return captureFns, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// captureStatsLoop runs each fn on every tick of d until ctx is cancelled, then
|
// captureStatsLoop runs each fn on every tick of d until ctx is cancelled.
|
||||||
// closes done.
|
func captureStatsLoop(ctx context.Context, d time.Duration, fns []func()) {
|
||||||
func captureStatsLoop(ctx context.Context, d time.Duration, fns []func(), done chan struct{}) {
|
|
||||||
defer close(done)
|
|
||||||
t := time.NewTicker(d)
|
t := time.NewTicker(d)
|
||||||
defer t.Stop()
|
defer t.Stop()
|
||||||
for {
|
for {
|
||||||
|
|||||||
+29
-294
@@ -2,18 +2,13 @@ package nebula
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
|
||||||
"io"
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"strconv"
|
"strconv"
|
||||||
"sync/atomic"
|
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/rcrowley/go-metrics"
|
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
@@ -115,14 +110,15 @@ func TestStatsServer_reload_initial_prometheus(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestStatsServer_Start_graphite_blocksUntilStop(t *testing.T) {
|
func TestStatsServer_Start_graphite_blocksUntilStop(t *testing.T) {
|
||||||
h := newGraphiteHost(t, 0)
|
sink := newGraphiteSink(t)
|
||||||
|
defer sink.Close()
|
||||||
|
|
||||||
s, c := newTestStatsServer(t)
|
s, c := newTestStatsServer(t)
|
||||||
setStatsConfig(c, map[string]any{
|
setStatsConfig(c, map[string]any{
|
||||||
"type": "graphite",
|
"type": "graphite",
|
||||||
"interval": "1s",
|
"interval": "1s",
|
||||||
"protocol": "tcp",
|
"protocol": "tcp",
|
||||||
"host": h.ln.Addr().String(),
|
"host": sink.Addr(),
|
||||||
"prefix": "test",
|
"prefix": "test",
|
||||||
})
|
})
|
||||||
require.NoError(t, s.reload(c, true))
|
require.NoError(t, s.reload(c, true))
|
||||||
@@ -375,18 +371,34 @@ func waitForListening(t *testing.T, addr string) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// stopAtCleanup returns the ctx to build *s with, and stops it when the test ends. Cancelling first turns away a Start
|
// graphiteSink is a minimal TCP accept-and-discard server so graphiteOnce
|
||||||
// a reload spawned that hasn't run yet, then Stop waits out the last pass, so nothing captures into the next test
|
// calls in tests don't spam error logs or wedge on connection refused.
|
||||||
func stopAtCleanup(t *testing.T, s **statsServer) context.Context {
|
type graphiteSink struct {
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
ln net.Listener
|
||||||
t.Cleanup(func() {
|
|
||||||
cancel()
|
|
||||||
if *s != nil {
|
|
||||||
(*s).Stop()
|
|
||||||
}
|
}
|
||||||
})
|
|
||||||
return ctx
|
func newGraphiteSink(t *testing.T) *graphiteSink {
|
||||||
|
t.Helper()
|
||||||
|
ln, err := net.Listen("tcp", "127.0.0.1:0")
|
||||||
|
require.NoError(t, err)
|
||||||
|
g := &graphiteSink{ln: ln}
|
||||||
|
go func() {
|
||||||
|
for {
|
||||||
|
conn, err := ln.Accept()
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
}
|
}
|
||||||
|
go func(c net.Conn) {
|
||||||
|
_, _ = io.Copy(io.Discard, c)
|
||||||
|
_ = c.Close()
|
||||||
|
}(conn)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
return g
|
||||||
|
}
|
||||||
|
|
||||||
|
func (g *graphiteSink) Addr() string { return g.ln.Addr().String() }
|
||||||
|
func (g *graphiteSink) Close() { _ = g.ln.Close() }
|
||||||
|
|
||||||
func freeTCPPort(t *testing.T) string {
|
func freeTCPPort(t *testing.T) string {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
@@ -396,280 +408,3 @@ func freeTCPPort(t *testing.T) string {
|
|||||||
require.NoError(t, ln.Close())
|
require.NoError(t, ln.Close())
|
||||||
return strconv.Itoa(port)
|
return strconv.Itoa(port)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Each export has to see what emitStats set in the same pass
|
|
||||||
func TestStatsServer_emitStatsRunsBeforeExport(t *testing.T) {
|
|
||||||
defer metrics.DefaultRegistry.Unregister("emitter.order.test")
|
|
||||||
|
|
||||||
l := slog.New(slog.DiscardHandler)
|
|
||||||
c := config.NewC(l)
|
|
||||||
setStatsConfig(c, map[string]any{
|
|
||||||
"type": "prometheus",
|
|
||||||
"interval": "1s",
|
|
||||||
"listen": "127.0.0.1:0",
|
|
||||||
"path": "/metrics",
|
|
||||||
})
|
|
||||||
gauge := metrics.GetOrRegisterGauge("emitter.order.test", nil)
|
|
||||||
s, err := newStatsServerFromConfig(t.Context(), l, c, "", false, func() { gauge.Update(42) })
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
s.runMu.Lock()
|
|
||||||
fns, srv := s.buildRuntime(t.Context(), *s.runCfg)
|
|
||||||
s.runMu.Unlock()
|
|
||||||
require.NotNil(t, srv)
|
|
||||||
for _, fn := range fns {
|
|
||||||
fn()
|
|
||||||
}
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
srv.Handler.ServeHTTP(rec, httptest.NewRequest("GET", "/metrics", nil))
|
|
||||||
assert.Contains(t, rec.Body.String(), "emitter_order_test 42")
|
|
||||||
}
|
|
||||||
|
|
||||||
// A scrape that lands the moment the listener is up already sees what emitStats set (issue #907)
|
|
||||||
func TestStatsServer_Start_primesBeforeServing(t *testing.T) {
|
|
||||||
defer metrics.DefaultRegistry.Unregister("prime.before.serving")
|
|
||||||
|
|
||||||
port := freeTCPPort(t)
|
|
||||||
l := slog.New(slog.DiscardHandler)
|
|
||||||
c := config.NewC(l)
|
|
||||||
setStatsConfig(c, map[string]any{
|
|
||||||
"type": "prometheus",
|
|
||||||
"interval": "1h",
|
|
||||||
"listen": "127.0.0.1:" + port,
|
|
||||||
"path": "/metrics",
|
|
||||||
})
|
|
||||||
gauge := metrics.GetOrRegisterGauge("prime.before.serving", nil)
|
|
||||||
// The pause would let a listener that came up before the prime serve the zero value
|
|
||||||
var s *statsServer
|
|
||||||
ctx := stopAtCleanup(t, &s)
|
|
||||||
s, err := newStatsServerFromConfig(ctx, l, c, "", false, func() {
|
|
||||||
time.Sleep(200 * time.Millisecond)
|
|
||||||
gauge.Update(42)
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
go s.Start()
|
|
||||||
waitForListening(t, "127.0.0.1:"+port)
|
|
||||||
|
|
||||||
resp, err := http.Get("http://127.0.0.1:" + port + "/metrics")
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer resp.Body.Close()
|
|
||||||
body, err := io.ReadAll(resp.Body)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Contains(t, string(body), "prime_before_serving 42")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Start captures once before the first tick, the interval here is an hour
|
|
||||||
func TestStatsServer_Start_primes(t *testing.T) {
|
|
||||||
ln, err := net.Listen("tcp", "127.0.0.1:0")
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer ln.Close()
|
|
||||||
|
|
||||||
l := slog.New(slog.DiscardHandler)
|
|
||||||
c := config.NewC(l)
|
|
||||||
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "1h", "host": ln.Addr().String()})
|
|
||||||
primed := make(chan struct{}, 1)
|
|
||||||
var s *statsServer
|
|
||||||
ctx := stopAtCleanup(t, &s)
|
|
||||||
s, err = newStatsServerFromConfig(ctx, l, c, "", false, func() {
|
|
||||||
select {
|
|
||||||
case primed <- struct{}{}:
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
go s.Start()
|
|
||||||
select {
|
|
||||||
case <-primed:
|
|
||||||
case <-time.After(5 * time.Second):
|
|
||||||
t.Fatal("nothing was captured before the first tick")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Graphite has to ship what emitStats set in the same pass, not the pass before
|
|
||||||
func TestStatsServer_emitStatsRunsBeforeGraphiteExport(t *testing.T) {
|
|
||||||
defer metrics.DefaultRegistry.Unregister("emitter.graphite.test")
|
|
||||||
|
|
||||||
ln, err := net.Listen("tcp", "127.0.0.1:0")
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer ln.Close()
|
|
||||||
received := make(chan string, 1)
|
|
||||||
go func() {
|
|
||||||
conn, err := ln.Accept()
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
defer conn.Close()
|
|
||||||
b, _ := io.ReadAll(conn)
|
|
||||||
received <- string(b)
|
|
||||||
}()
|
|
||||||
|
|
||||||
l := slog.New(slog.DiscardHandler)
|
|
||||||
c := config.NewC(l)
|
|
||||||
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "1h", "host": ln.Addr().String()})
|
|
||||||
gauge := metrics.GetOrRegisterGauge("emitter.graphite.test", nil)
|
|
||||||
s, err := newStatsServerFromConfig(t.Context(), l, c, "", false, func() { gauge.Update(42) })
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
s.runMu.Lock()
|
|
||||||
fns, _ := s.buildRuntime(t.Context(), *s.runCfg)
|
|
||||||
s.runMu.Unlock()
|
|
||||||
for _, fn := range fns {
|
|
||||||
fn()
|
|
||||||
}
|
|
||||||
|
|
||||||
select {
|
|
||||||
case body := <-received:
|
|
||||||
assert.Contains(t, body, ".emitter.graphite.test.value 42 ")
|
|
||||||
case <-time.After(5 * time.Second):
|
|
||||||
t.Fatal("graphite sent nothing")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// stats.interval reloads, and the runtime a reload starts still has emitStats
|
|
||||||
func TestStatsServer_reloadMovesTheInterval(t *testing.T) {
|
|
||||||
var passes atomic.Int64
|
|
||||||
l := slog.New(slog.DiscardHandler)
|
|
||||||
c := config.NewC(l)
|
|
||||||
// Nothing listens here, each export fails at once
|
|
||||||
host := "127.0.0.1:" + freeTCPPort(t)
|
|
||||||
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "1h", "host": host})
|
|
||||||
var s *statsServer
|
|
||||||
ctx := stopAtCleanup(t, &s)
|
|
||||||
s, err := newStatsServerFromConfig(ctx, l, c, "", false, func() { passes.Add(1) })
|
|
||||||
require.NoError(t, err)
|
|
||||||
go s.Start()
|
|
||||||
waitFor(t, func() bool { return passes.Load() == 1 })
|
|
||||||
|
|
||||||
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "20ms", "host": host})
|
|
||||||
require.NoError(t, s.reload(c, false))
|
|
||||||
waitFor(t, func() bool { return passes.Load() >= 6 })
|
|
||||||
|
|
||||||
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "1h", "host": host})
|
|
||||||
require.NoError(t, s.reload(c, false))
|
|
||||||
// The reload's Stop waited out the 20ms loop. The new runtime's prime may land either side of this read, it is the
|
|
||||||
// only pass left to come
|
|
||||||
stopped := passes.Load()
|
|
||||||
time.Sleep(300 * time.Millisecond)
|
|
||||||
assert.LessOrEqual(t, passes.Load()-stopped, int64(1), "the 20ms loop kept running after the reload")
|
|
||||||
}
|
|
||||||
|
|
||||||
// A reload's new runtime never captures while the old one is still in a pass, go-metrics keeps its GC capture state
|
|
||||||
// in unguarded globals
|
|
||||||
func TestStatsServer_reloadWaitsForTheLastPass(t *testing.T) {
|
|
||||||
var active, most atomic.Int64
|
|
||||||
l := slog.New(slog.DiscardHandler)
|
|
||||||
c := config.NewC(l)
|
|
||||||
host := "127.0.0.1:" + freeTCPPort(t)
|
|
||||||
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "10ms", "host": host})
|
|
||||||
var s *statsServer
|
|
||||||
ctx := stopAtCleanup(t, &s)
|
|
||||||
s, err := newStatsServerFromConfig(ctx, l, c, "", false, func() {
|
|
||||||
n := active.Add(1)
|
|
||||||
for {
|
|
||||||
m := most.Load()
|
|
||||||
if n <= m || most.CompareAndSwap(m, n) {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Long enough that a reload almost always lands mid pass
|
|
||||||
time.Sleep(50 * time.Millisecond)
|
|
||||||
active.Add(-1)
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
go s.Start()
|
|
||||||
|
|
||||||
for i := range 6 {
|
|
||||||
setStatsConfig(c, map[string]any{"type": "graphite", "interval": fmt.Sprintf("%dms", 11-i%2), "host": host})
|
|
||||||
require.NoError(t, s.reload(c, false))
|
|
||||||
time.Sleep(30 * time.Millisecond)
|
|
||||||
}
|
|
||||||
assert.Equal(t, int64(1), most.Load())
|
|
||||||
}
|
|
||||||
|
|
||||||
// Nothing captures once Stop returns, a pass in progress is waited out
|
|
||||||
func TestStatsServer_Stop_waitsForThePass(t *testing.T) {
|
|
||||||
var inPass atomic.Bool
|
|
||||||
entered := make(chan struct{}, 1)
|
|
||||||
l := slog.New(slog.DiscardHandler)
|
|
||||||
c := config.NewC(l)
|
|
||||||
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "1h", "host": "127.0.0.1:" + freeTCPPort(t)})
|
|
||||||
var s *statsServer
|
|
||||||
ctx := stopAtCleanup(t, &s)
|
|
||||||
s, err := newStatsServerFromConfig(ctx, l, c, "", false, func() {
|
|
||||||
inPass.Store(true)
|
|
||||||
select {
|
|
||||||
case entered <- struct{}{}:
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
time.Sleep(100 * time.Millisecond)
|
|
||||||
inPass.Store(false)
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
go s.Start()
|
|
||||||
select {
|
|
||||||
case <-entered:
|
|
||||||
case <-time.After(5 * time.Second):
|
|
||||||
t.Fatal("never captured")
|
|
||||||
}
|
|
||||||
s.Stop()
|
|
||||||
assert.False(t, inPass.Load(), "Stop returned with a pass still running")
|
|
||||||
}
|
|
||||||
|
|
||||||
// A Start that arrives while Stop waits out the last pass doesn't capture alongside it
|
|
||||||
func TestStatsServer_Start_duringStopWaitsForThePass(t *testing.T) {
|
|
||||||
var active, most atomic.Int64
|
|
||||||
entered := make(chan struct{}, 1)
|
|
||||||
l := slog.New(slog.DiscardHandler)
|
|
||||||
c := config.NewC(l)
|
|
||||||
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "1h", "host": "127.0.0.1:" + freeTCPPort(t)})
|
|
||||||
var s *statsServer
|
|
||||||
ctx := stopAtCleanup(t, &s)
|
|
||||||
s, err := newStatsServerFromConfig(ctx, l, c, "", false, func() {
|
|
||||||
n := active.Add(1)
|
|
||||||
for {
|
|
||||||
m := most.Load()
|
|
||||||
if n <= m || most.CompareAndSwap(m, n) {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
select {
|
|
||||||
case entered <- struct{}{}:
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
time.Sleep(200 * time.Millisecond)
|
|
||||||
active.Add(-1)
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
go s.Start()
|
|
||||||
select {
|
|
||||||
case <-entered:
|
|
||||||
case <-time.After(5 * time.Second):
|
|
||||||
t.Fatal("never captured")
|
|
||||||
}
|
|
||||||
stopped := make(chan struct{})
|
|
||||||
go func() {
|
|
||||||
s.Stop()
|
|
||||||
close(stopped)
|
|
||||||
}()
|
|
||||||
// Stop holds runMu for its whole wait, the next Start has to arrive after it took it
|
|
||||||
waitFor(t, func() bool {
|
|
||||||
if s.runMu.TryLock() {
|
|
||||||
s.runMu.Unlock()
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
})
|
|
||||||
go s.Start()
|
|
||||||
select {
|
|
||||||
case <-stopped:
|
|
||||||
case <-time.After(5 * time.Second):
|
|
||||||
t.Fatal("Stop did not return")
|
|
||||||
}
|
|
||||||
waitFor(t, func() bool { return len(entered) == 1 })
|
|
||||||
assert.Equal(t, int64(1), most.Load(), "a Start captured alongside the pass Stop was waiting out")
|
|
||||||
}
|
|
||||||
+4
-24
@@ -135,23 +135,12 @@ func (u *StdConn) Rebind() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetRecvBuffer tries SO_RCVBUFFORCE, which needs CAP_NET_ADMIN. Without it we
|
|
||||||
// fall back to SO_RCVBUF, which the kernel clamps to net.core.rmem_max.
|
|
||||||
func (u *StdConn) SetRecvBuffer(n int) error {
|
func (u *StdConn) SetRecvBuffer(n int) error {
|
||||||
err := unix.SetsockoptInt(u.sysFd, unix.SOL_SOCKET, unix.SO_RCVBUFFORCE, n)
|
return unix.SetsockoptInt(u.sysFd, unix.SOL_SOCKET, unix.SO_RCVBUFFORCE, n)
|
||||||
if errors.Is(err, unix.EPERM) {
|
|
||||||
err = unix.SetsockoptInt(u.sysFd, unix.SOL_SOCKET, unix.SO_RCVBUF, n)
|
|
||||||
}
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetSendBuffer is SetRecvBuffer for SO_SNDBUFFORCE/SO_SNDBUF and net.core.wmem_max.
|
|
||||||
func (u *StdConn) SetSendBuffer(n int) error {
|
func (u *StdConn) SetSendBuffer(n int) error {
|
||||||
err := unix.SetsockoptInt(u.sysFd, unix.SOL_SOCKET, unix.SO_SNDBUFFORCE, n)
|
return unix.SetsockoptInt(u.sysFd, unix.SOL_SOCKET, unix.SO_SNDBUFFORCE, n)
|
||||||
if errors.Is(err, unix.EPERM) {
|
|
||||||
err = unix.SetsockoptInt(u.sysFd, unix.SOL_SOCKET, unix.SO_SNDBUF, n)
|
|
||||||
}
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *StdConn) SetSoMark(mark int) error {
|
func (u *StdConn) SetSoMark(mark int) error {
|
||||||
@@ -407,13 +396,8 @@ func (u *StdConn) ReloadConfig(c *config.C) {
|
|||||||
b := c.GetInt("listen.read_buffer", 0)
|
b := c.GetInt("listen.read_buffer", 0)
|
||||||
if b > 0 {
|
if b > 0 {
|
||||||
if err := u.SetRecvBuffer(b); err == nil {
|
if err := u.SetRecvBuffer(b); err == nil {
|
||||||
// The kernel reports double the requested size
|
if s, err := u.GetRecvBuffer(); err == nil {
|
||||||
if s, err := u.GetRecvBuffer(); err == nil && s >= 2*b {
|
|
||||||
u.l.Info("listen.read_buffer was set", "size", s)
|
u.l.Info("listen.read_buffer was set", "size", s)
|
||||||
} else if err == nil {
|
|
||||||
u.l.Warn("listen.read_buffer was limited by the system",
|
|
||||||
"requested", b, "size", s,
|
|
||||||
"hint", "raise net.core.rmem_max or grant CAP_NET_ADMIN")
|
|
||||||
} else {
|
} else {
|
||||||
u.l.Warn("Failed to get listen.read_buffer", "error", err)
|
u.l.Warn("Failed to get listen.read_buffer", "error", err)
|
||||||
}
|
}
|
||||||
@@ -425,12 +409,8 @@ func (u *StdConn) ReloadConfig(c *config.C) {
|
|||||||
b = c.GetInt("listen.write_buffer", 0)
|
b = c.GetInt("listen.write_buffer", 0)
|
||||||
if b > 0 {
|
if b > 0 {
|
||||||
if err := u.SetSendBuffer(b); err == nil {
|
if err := u.SetSendBuffer(b); err == nil {
|
||||||
if s, err := u.GetSendBuffer(); err == nil && s >= 2*b {
|
if s, err := u.GetSendBuffer(); err == nil {
|
||||||
u.l.Info("listen.write_buffer was set", "size", s)
|
u.l.Info("listen.write_buffer was set", "size", s)
|
||||||
} else if err == nil {
|
|
||||||
u.l.Warn("listen.write_buffer was limited by the system",
|
|
||||||
"requested", b, "size", s,
|
|
||||||
"hint", "raise net.core.wmem_max or grant CAP_NET_ADMIN")
|
|
||||||
} else {
|
} else {
|
||||||
u.l.Warn("Failed to get listen.write_buffer", "error", err)
|
u.l.Warn("Failed to get listen.write_buffer", "error", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,124 +0,0 @@
|
|||||||
//go:build linux && !android && !e2e_testing
|
|
||||||
|
|
||||||
package udp
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"fmt"
|
|
||||||
"log/slog"
|
|
||||||
"net/netip"
|
|
||||||
"os"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/config"
|
|
||||||
)
|
|
||||||
|
|
||||||
func readSysctlInt(t *testing.T, path string) int {
|
|
||||||
t.Helper()
|
|
||||||
b, err := os.ReadFile(path)
|
|
||||||
if err != nil {
|
|
||||||
t.Skipf("can't read %s: %v", path, err)
|
|
||||||
}
|
|
||||||
n, err := strconv.Atoi(strings.TrimSpace(string(b)))
|
|
||||||
if err != nil {
|
|
||||||
t.Skipf("can't parse %s: %v", path, err)
|
|
||||||
}
|
|
||||||
return n
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSetBufferAboveSysctlMax asks for more than net.core.{r,w}mem_max. With
|
|
||||||
// CAP_NET_ADMIN the FORCE variant takes it as is; without it we must fall back
|
|
||||||
// to the plain option and get the clamped size instead of EPERM.
|
|
||||||
func TestSetBufferAboveSysctlMax(t *testing.T) {
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
sysctl string
|
|
||||||
set func(*StdConn, int) error
|
|
||||||
get func(*StdConn) (int, error)
|
|
||||||
}{
|
|
||||||
{"read", "/proc/sys/net/core/rmem_max", (*StdConn).SetRecvBuffer, (*StdConn).GetRecvBuffer},
|
|
||||||
{"write", "/proc/sys/net/core/wmem_max", (*StdConn).SetSendBuffer, (*StdConn).GetSendBuffer},
|
|
||||||
}
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
sysMax := readSysctlInt(t, tc.sysctl)
|
|
||||||
c, err := NewListener(testLogger(), Settings{Listen: netip.MustParseAddrPort("127.0.0.1:0"), Batch: 1})
|
|
||||||
if err != nil {
|
|
||||||
t.Skipf("NewListener: %v", err)
|
|
||||||
}
|
|
||||||
sc := c.(*StdConn)
|
|
||||||
defer sc.Close()
|
|
||||||
|
|
||||||
want := sysMax + 1<<20
|
|
||||||
if err := tc.set(sc, want); err != nil {
|
|
||||||
t.Fatalf("set %d: %v", want, err)
|
|
||||||
}
|
|
||||||
got, err := tc.get(sc)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get: %v", err)
|
|
||||||
}
|
|
||||||
// The kernel doubles the value; either path gives at least the clamped size.
|
|
||||||
if got < 2*sysMax {
|
|
||||||
t.Fatalf("effective size %d, want >= %d", got, 2*sysMax)
|
|
||||||
}
|
|
||||||
t.Logf("requested %d, %s=%d, effective %d (forced=%v)", want, tc.sysctl, sysMax, got, got >= 2*want)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestReloadConfigBufferLogLevel checks that a clamped buffer is a Warn, and a
|
|
||||||
// buffer that fits is still the Info it always was.
|
|
||||||
func TestReloadConfigBufferLogLevel(t *testing.T) {
|
|
||||||
sysMax := readSysctlInt(t, "/proc/sys/net/core/rmem_max")
|
|
||||||
if wmax := readSysctlInt(t, "/proc/sys/net/core/wmem_max"); wmax < sysMax {
|
|
||||||
sysMax = wmax
|
|
||||||
}
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
size int
|
|
||||||
want []string
|
|
||||||
}{
|
|
||||||
{"fits", 64 * 1024, []string{"level=INFO msg=\"listen.read_buffer was set\"", "level=INFO msg=\"listen.write_buffer was set\""}},
|
|
||||||
{"too big", sysMax + 1<<20, []string{"level=WARN msg=\"listen.read_buffer was limited by the system\"", "level=WARN msg=\"listen.write_buffer was limited by the system\""}},
|
|
||||||
}
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
var buf bytes.Buffer
|
|
||||||
l := slog.New(slog.NewTextHandler(&buf, nil))
|
|
||||||
c, err := NewListener(l, Settings{Listen: netip.MustParseAddrPort("127.0.0.1:0"), Batch: 1})
|
|
||||||
if err != nil {
|
|
||||||
t.Skipf("NewListener: %v", err)
|
|
||||||
}
|
|
||||||
sc := c.(*StdConn)
|
|
||||||
defer sc.Close()
|
|
||||||
|
|
||||||
if tc.size > sysMax {
|
|
||||||
// With CAP_NET_ADMIN the FORCE variant takes any size, nothing gets limited.
|
|
||||||
if err := sc.SetRecvBuffer(tc.size); err == nil {
|
|
||||||
if got, _ := sc.GetRecvBuffer(); got >= 2*tc.size {
|
|
||||||
t.Skip("FORCE path took the full size, can't observe the limit")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
cfg := config.NewC(l)
|
|
||||||
if err := cfg.LoadString(fmt.Sprintf("listen:\n read_buffer: %d\n write_buffer: %d\n", tc.size, tc.size)); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
buf.Reset()
|
|
||||||
sc.ReloadConfig(cfg)
|
|
||||||
out := buf.String()
|
|
||||||
for _, w := range tc.want {
|
|
||||||
if !strings.Contains(out, w) {
|
|
||||||
t.Errorf("missing %s in:\n%s", w, out)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if strings.Contains(out, "level=ERROR") {
|
|
||||||
t.Errorf("unexpected error log:\n%s", out)
|
|
||||||
}
|
|
||||||
t.Log(out)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -30,7 +30,7 @@ func procyield(cycles uint32)
|
|||||||
|
|
||||||
const (
|
const (
|
||||||
packetsPerRing = 1024
|
packetsPerRing = 1024
|
||||||
// Fits a relayed packet at overlay.MaxMTU, which tun.mtu and route mtus are capped to. 17.6MB page locked per socket.
|
// Caps tun.mtu at MTU-32 direct, MTU-64 relayed, unenforced anywhere else. 17.6MB page locked per socket.
|
||||||
bytesPerPacket = MTU
|
bytesPerPacket = MTU
|
||||||
receiveSpins = 15
|
receiveSpins = 15
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in new issue
Block a user