mirror of
https://github.com/slackhq/nebula.git
synced 2026-11-16 23:06:52 +01:00
Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
21a7f1b711 | ||
|
|
64bec56404 | ||
|
|
81f991f1fd | ||
|
|
21075ba32e | ||
|
|
37032a22bf |
No files matched your search
@@ -14,7 +14,7 @@ jobs:
|
||||
|
||||
- uses: actions/setup-go@v7
|
||||
with:
|
||||
go-version: '1.27'
|
||||
go-version: '1.26'
|
||||
check-latest: true
|
||||
|
||||
- name: Build
|
||||
@@ -40,7 +40,7 @@ jobs:
|
||||
|
||||
- uses: actions/setup-go@v7
|
||||
with:
|
||||
go-version: '1.27'
|
||||
go-version: '1.26'
|
||||
check-latest: true
|
||||
|
||||
- name: Build
|
||||
@@ -83,7 +83,7 @@ jobs:
|
||||
|
||||
- uses: actions/setup-go@v7
|
||||
with:
|
||||
go-version: '1.27'
|
||||
go-version: '1.26'
|
||||
check-latest: true
|
||||
|
||||
# GitHub holds ARNs, not credentials, and ARNs outlive a rotation
|
||||
|
||||
@@ -34,7 +34,7 @@ jobs:
|
||||
|
||||
- uses: actions/setup-go@v7
|
||||
with:
|
||||
go-version: '1.27'
|
||||
go-version: '1.26'
|
||||
check-latest: true
|
||||
|
||||
- name: add hashicorp source
|
||||
@@ -66,7 +66,7 @@ jobs:
|
||||
|
||||
- uses: actions/setup-go@v7
|
||||
with:
|
||||
go-version: '1.27'
|
||||
go-version: '1.26'
|
||||
check-latest: true
|
||||
|
||||
- name: add hashicorp source
|
||||
@@ -92,7 +92,7 @@ jobs:
|
||||
|
||||
- uses: actions/setup-go@v7
|
||||
with:
|
||||
go-version: '1.27'
|
||||
go-version: '1.26'
|
||||
check-latest: true
|
||||
|
||||
# WSL2 + Ubuntu so the smoke can run a real linux peer with its own
|
||||
|
||||
@@ -22,7 +22,7 @@ jobs:
|
||||
|
||||
- uses: actions/setup-go@v7
|
||||
with:
|
||||
go-version: '1.27'
|
||||
go-version: '1.26'
|
||||
check-latest: true
|
||||
|
||||
- name: Smoke Docker
|
||||
@@ -51,7 +51,7 @@ jobs:
|
||||
|
||||
- uses: actions/setup-go@v7
|
||||
with:
|
||||
go-version: '1.27'
|
||||
go-version: '1.26'
|
||||
check-latest: true
|
||||
|
||||
- name: build
|
||||
|
||||
@@ -22,7 +22,7 @@ jobs:
|
||||
|
||||
- uses: actions/setup-go@v7
|
||||
with:
|
||||
go-version: '1.27'
|
||||
go-version: '1.26'
|
||||
check-latest: true
|
||||
|
||||
- name: Install goimports
|
||||
@@ -42,7 +42,7 @@ jobs:
|
||||
- name: golangci-lint
|
||||
uses: golangci/golangci-lint-action@v9
|
||||
with:
|
||||
version: v2.14
|
||||
version: v2.12
|
||||
|
||||
test:
|
||||
name: Test ${{ matrix.name }}
|
||||
@@ -87,7 +87,7 @@ jobs:
|
||||
|
||||
- uses: actions/setup-go@v7
|
||||
with:
|
||||
go-version: '1.27'
|
||||
go-version: '1.26'
|
||||
check-latest: true
|
||||
|
||||
- name: Build
|
||||
@@ -132,7 +132,7 @@ jobs:
|
||||
|
||||
- uses: actions/setup-go@v7
|
||||
with:
|
||||
go-version: '1.27'
|
||||
go-version: '1.26'
|
||||
check-latest: true
|
||||
|
||||
- name: Build ${{ matrix.name }}
|
||||
|
||||
@@ -7,18 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Removed
|
||||
|
||||
- The SSH debug server's `start-cpu-profile`, `stop-cpu-profile`, `save-heap-profile`, `save-mutex-profile`, and
|
||||
`mutex-profile-fraction` commands, and `sshd.sandbox_dir`, which is now ignored if set.
|
||||
|
||||
### 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
|
||||
|
||||
See the [v1.11.1](https://github.com/slackhq/nebula/milestone/30?closed=1) milestone for a complete list of changes.
|
||||
|
||||
@@ -85,10 +85,9 @@ func main() {
|
||||
fmt.Printf("failed to apply logging config: %s", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
if err := logging.ApplyConfig(l, c); err != nil {
|
||||
l.Error("Failed to reconfigure logger on reload", "error", err)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
|
||||
@@ -34,10 +34,9 @@ func (p *program) Start(s service.Service) error {
|
||||
if err := logging.ApplyConfig(l, c); err != nil {
|
||||
return fmt.Errorf("failed to apply logging config: %s", err)
|
||||
}
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
if err := logging.ApplyConfig(l, c); err != nil {
|
||||
l.Error("Failed to reconfigure logger on reload", "error", err)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
|
||||
+1
-2
@@ -71,10 +71,9 @@ func main() {
|
||||
fmt.Printf("failed to apply logging config: %s", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
if err := logging.ApplyConfig(l, c); err != nil {
|
||||
l.Error("Failed to reconfigure logger on reload", "error", err)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
|
||||
+31
-40
@@ -26,12 +26,9 @@ type C struct {
|
||||
files []string
|
||||
Settings map[string]any
|
||||
oldSettings map[string]any
|
||||
callbacks []func(*C, *Reload)
|
||||
callbacks []func(*C)
|
||||
l *slog.Logger
|
||||
reloadLock sync.Mutex
|
||||
|
||||
// Set by the first reload that needs a restart and never cleared. Guarded by reloadLock
|
||||
needsRestart bool
|
||||
}
|
||||
|
||||
func NewC(l *slog.Logger) *C {
|
||||
@@ -75,9 +72,8 @@ func (c *C) LoadString(raw string) error {
|
||||
// RegisterReloadCallback stores a function to be called when a config reload is triggered. The functions registered
|
||||
// here should decide if they need to make a change to the current process before making the change. HasChanged can be
|
||||
// used to help decide if a change is necessary.
|
||||
// These functions should return quickly or spawn their own go routine if they will take a while.
|
||||
// Use r to report anything that failed or needs a restart to apply.
|
||||
func (c *C) RegisterReloadCallback(f func(c *C, r *Reload)) {
|
||||
// These functions should return quickly or spawn their own go routine if they will take a while
|
||||
func (c *C) RegisterReloadCallback(f func(*C)) {
|
||||
c.callbacks = append(c.callbacks, f)
|
||||
}
|
||||
|
||||
@@ -148,55 +144,50 @@ func (c *C) CatchHUP(ctx context.Context) {
|
||||
return
|
||||
case <-ch:
|
||||
c.l.Info("Caught HUP, reloading config")
|
||||
c.ReloadConfig().Log(c.l)
|
||||
c.ReloadConfig()
|
||||
}
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
// ReloadConfig reloads the config from the path provided to Load and runs every registered callback. A config that
|
||||
// fails to load is logged here, like any other failure, and the result carries the error for the summary.
|
||||
func (c *C) ReloadConfig() ReloadResult {
|
||||
func (c *C) ReloadConfig() {
|
||||
c.reloadLock.Lock()
|
||||
defer c.reloadLock.Unlock()
|
||||
|
||||
c.oldSettings = make(map[string]any)
|
||||
maps.Copy(c.oldSettings, c.Settings)
|
||||
|
||||
if err := c.Load(c.path); err != nil {
|
||||
c.l.Error("Error occurred while reloading config", "config_path", c.path, "error", err)
|
||||
return ReloadResult{Err: err, RestartRequired: c.needsRestart}
|
||||
err := c.Load(c.path)
|
||||
if err != nil {
|
||||
c.l.Error("Error occurred while reloading config",
|
||||
"config_path", c.path,
|
||||
"error", err,
|
||||
)
|
||||
return
|
||||
}
|
||||
|
||||
return c.runCallbacks()
|
||||
}
|
||||
|
||||
// ReloadConfigString is ReloadConfig for a config held in memory rather than on disk.
|
||||
func (c *C) ReloadConfigString(raw string) ReloadResult {
|
||||
c.reloadLock.Lock()
|
||||
defer c.reloadLock.Unlock()
|
||||
|
||||
c.oldSettings = make(map[string]any)
|
||||
maps.Copy(c.oldSettings, c.Settings)
|
||||
|
||||
if err := c.LoadString(raw); err != nil {
|
||||
c.l.Error("Error occurred while reloading config", "error", err)
|
||||
return ReloadResult{Err: err, RestartRequired: c.needsRestart}
|
||||
}
|
||||
|
||||
return c.runCallbacks()
|
||||
}
|
||||
|
||||
func (c *C) runCallbacks() ReloadResult {
|
||||
r := &Reload{c: c}
|
||||
for _, v := range c.callbacks {
|
||||
v(c, r)
|
||||
v(c)
|
||||
}
|
||||
}
|
||||
|
||||
if r.restart {
|
||||
c.needsRestart = true
|
||||
func (c *C) ReloadConfigString(raw string) error {
|
||||
c.reloadLock.Lock()
|
||||
defer c.reloadLock.Unlock()
|
||||
|
||||
c.oldSettings = make(map[string]any)
|
||||
maps.Copy(c.oldSettings, c.Settings)
|
||||
|
||||
err := c.LoadString(raw)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return ReloadResult{Failed: r.failed, RestartRequired: c.needsRestart, RestartKeys: r.keys}
|
||||
|
||||
for _, v := range c.callbacks {
|
||||
v(c)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// GetString will get the string for k or return the default d if not found or invalid
|
||||
@@ -400,7 +391,7 @@ func (c *C) parse() error {
|
||||
var nm map[string]any
|
||||
err = yaml.Unmarshal(b, &nm)
|
||||
if err != nil {
|
||||
return fmt.Errorf("%s: %w", path, err)
|
||||
return err
|
||||
}
|
||||
|
||||
// We need to use WithAppendSlice so that firewall rules in separate
|
||||
|
||||
@@ -19,7 +19,7 @@ func TestConfig_Load(t *testing.T) {
|
||||
// invalid yaml
|
||||
c := NewC(l)
|
||||
os.WriteFile(filepath.Join(dir, "01.yaml"), []byte(" invalid yaml"), 0644)
|
||||
require.EqualError(t, c.Load(dir), filepath.Join(dir, "01.yaml")+": yaml: unmarshal errors:\n line 1: cannot unmarshal !!str `invalid...` into map[string]interface {}")
|
||||
require.EqualError(t, c.Load(dir), "yaml: unmarshal errors:\n line 1: cannot unmarshal !!str `invalid...` into map[string]interface {}")
|
||||
|
||||
// simple multi config merge
|
||||
c = NewC(l)
|
||||
@@ -129,7 +129,7 @@ func TestConfig_ReloadConfig(t *testing.T) {
|
||||
|
||||
os.WriteFile(filepath.Join(dir, "01.yaml"), []byte("outer:\n inner: ho"), 0644)
|
||||
|
||||
c.RegisterReloadCallback(func(c *C, _ *Reload) {
|
||||
c.RegisterReloadCallback(func(c *C) {
|
||||
done <- true
|
||||
})
|
||||
|
||||
|
||||
@@ -1,98 +0,0 @@
|
||||
package config
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"slices"
|
||||
)
|
||||
|
||||
// ReloadResult describes how a reload went. Problems are logged where they happen, Log writes a one line summary.
|
||||
type ReloadResult struct {
|
||||
// Err is set when the new config could not be read or parsed, no callbacks ran
|
||||
Err error
|
||||
// Failed is true when a callback could not apply part of the new config
|
||||
Failed bool
|
||||
// RestartRequired is true once any reload has needed a restart, and stays true until the process restarts
|
||||
RestartRequired bool
|
||||
// RestartKeys are the keys this reload changed that only apply on a restart
|
||||
RestartKeys []string
|
||||
}
|
||||
|
||||
// Summary returns a one line summary of the reload and the level to log it at.
|
||||
func (r ReloadResult) Summary() (slog.Level, string) {
|
||||
switch {
|
||||
case r.Err != nil && r.RestartRequired:
|
||||
return slog.LevelError, "Config reload failed, the new config did not load and a restart is still required"
|
||||
case r.Err != nil:
|
||||
return slog.LevelError, "Config reload failed, the new config did not load"
|
||||
case r.Failed && r.RestartRequired:
|
||||
return slog.LevelError, "Config reload completed with errors and requires a restart to fully apply, review the logs"
|
||||
case r.Failed:
|
||||
return slog.LevelError, "Config reload completed with errors, review the logs"
|
||||
case r.RestartRequired:
|
||||
return slog.LevelWarn, "Config reload was completed but requires a restart to fully apply"
|
||||
default:
|
||||
return slog.LevelInfo, "Config reload complete"
|
||||
}
|
||||
}
|
||||
|
||||
// String is the summary with Err and RestartKeys included, for output other than the log.
|
||||
func (r ReloadResult) String() string {
|
||||
_, msg := r.Summary()
|
||||
if r.Err != nil {
|
||||
msg = fmt.Sprintf("%s: %v", msg, r.Err)
|
||||
}
|
||||
if len(r.RestartKeys) > 0 {
|
||||
msg = fmt.Sprintf("%s, keys %v", msg, r.RestartKeys)
|
||||
}
|
||||
return msg
|
||||
}
|
||||
|
||||
// Log writes Summary to l.
|
||||
func (r ReloadResult) Log(l *slog.Logger) {
|
||||
level, msg := r.Summary()
|
||||
if len(r.RestartKeys) > 0 {
|
||||
l.Log(context.Background(), level, msg, "keys", r.RestartKeys)
|
||||
return
|
||||
}
|
||||
l.Log(context.Background(), level, msg)
|
||||
}
|
||||
|
||||
// Reload is passed to each reload callback to report how applying the new config went.
|
||||
type Reload struct {
|
||||
c *C
|
||||
failed bool
|
||||
restart bool
|
||||
// Changed keys that only apply on a restart, from every callback
|
||||
keys []string
|
||||
}
|
||||
|
||||
// Failed marks the reload as failed, the caller logs why. Safe to call on a nil Reload, which is what the initial load
|
||||
// passes.
|
||||
func (r *Reload) Failed() {
|
||||
if r != nil {
|
||||
r.failed = true
|
||||
}
|
||||
}
|
||||
|
||||
// RestartRequired marks the reload as needing a restart, the caller logs why. Safe to call on a nil Reload.
|
||||
func (r *Reload) RestartRequired() {
|
||||
if r != nil {
|
||||
r.restart = true
|
||||
}
|
||||
}
|
||||
|
||||
// RestartRequiredIfChanged marks the reload as needing a restart if any of keys changed, and adds them to RestartKeys.
|
||||
// Use it for keys that are only read at startup. Safe to call on a nil Reload.
|
||||
func (r *Reload) RestartRequiredIfChanged(keys ...string) {
|
||||
if r == nil {
|
||||
return
|
||||
}
|
||||
for _, k := range keys {
|
||||
if r.c.HasChanged(k) && !slices.Contains(r.keys, k) {
|
||||
r.keys = append(r.keys, k)
|
||||
r.restart = true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,108 +0,0 @@
|
||||
package config
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"log/slog"
|
||||
"testing"
|
||||
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestReloadConfigString(t *testing.T) {
|
||||
c := NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString("a: 1"))
|
||||
fail := false
|
||||
ran := 0
|
||||
c.RegisterReloadCallback(func(c *C, r *Reload) {
|
||||
ran++
|
||||
if fail {
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
assert.Equal(t, ReloadResult{}, c.ReloadConfigString("a: 2"))
|
||||
fail = true
|
||||
assert.Equal(t, ReloadResult{Failed: true}, c.ReloadConfigString("a: 3"))
|
||||
assert.Equal(t, 2, ran)
|
||||
|
||||
// A config that fails to load runs no callbacks and returns the error
|
||||
res := c.ReloadConfigString("a: [")
|
||||
require.Error(t, res.Err)
|
||||
assert.False(t, res.Failed)
|
||||
assert.Equal(t, 2, ran)
|
||||
assert.Equal(t, 3, c.GetInt("a", 0))
|
||||
}
|
||||
|
||||
func TestReloadRestartRequiredLatches(t *testing.T) {
|
||||
c := NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString("a: 1\nb: 1"))
|
||||
c.RegisterReloadCallback(func(c *C, r *Reload) { r.RestartRequiredIfChanged("a", "b") })
|
||||
|
||||
// Nothing that needs a restart changed
|
||||
assert.Equal(t, ReloadResult{}, c.ReloadConfigString("a: 1\nb: 1\nc: 1"))
|
||||
assert.Equal(t, ReloadResult{RestartRequired: true, RestartKeys: []string{"a"}}, c.ReloadConfigString("a: 2\nb: 1\nc: 1"))
|
||||
|
||||
// The restart sticks through a reload with no changes, reverting the key and a config that fails to load. Only the
|
||||
// reload that changed the key lists it
|
||||
assert.Equal(t, ReloadResult{RestartRequired: true}, c.ReloadConfigString("a: 2\nb: 1\nc: 1"))
|
||||
assert.Equal(t, ReloadResult{RestartRequired: true, RestartKeys: []string{"a"}}, c.ReloadConfigString("a: 1\nb: 1\nc: 1"))
|
||||
|
||||
res := c.ReloadConfigString("a: [")
|
||||
require.Error(t, res.Err)
|
||||
assert.True(t, res.RestartRequired)
|
||||
}
|
||||
|
||||
// A key reported by more than one callback is listed once
|
||||
func TestReloadRestartKeysDeduped(t *testing.T) {
|
||||
c := NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString("a: 1\nb: 1"))
|
||||
c.RegisterReloadCallback(func(c *C, r *Reload) { r.RestartRequiredIfChanged("a") })
|
||||
c.RegisterReloadCallback(func(c *C, r *Reload) { r.RestartRequiredIfChanged("a", "b") })
|
||||
|
||||
assert.Equal(t, []string{"a", "b"}, c.ReloadConfigString("a: 2\nb: 2").RestartKeys)
|
||||
}
|
||||
|
||||
// A callback can require a restart without a key changing, a file the config points at may have
|
||||
func TestReloadRestartRequiredWithoutAChange(t *testing.T) {
|
||||
c := NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString("a: 1"))
|
||||
c.RegisterReloadCallback(func(c *C, r *Reload) { r.RestartRequired() })
|
||||
|
||||
assert.Equal(t, ReloadResult{RestartRequired: true}, c.ReloadConfigString("a: 1"))
|
||||
}
|
||||
|
||||
func TestReloadResultSummary(t *testing.T) {
|
||||
cases := []struct {
|
||||
res ReloadResult
|
||||
level slog.Level
|
||||
msg string
|
||||
}{
|
||||
{ReloadResult{}, slog.LevelInfo, "Config reload complete"},
|
||||
{ReloadResult{RestartRequired: true}, slog.LevelWarn, "Config reload was completed but requires a restart to fully apply"},
|
||||
{ReloadResult{Failed: true}, slog.LevelError, "Config reload completed with errors, review the logs"},
|
||||
{ReloadResult{Failed: true, RestartRequired: true}, slog.LevelError, "Config reload completed with errors and requires a restart to fully apply, review the logs"},
|
||||
{ReloadResult{Err: errors.New("bad yaml")}, slog.LevelError, "Config reload failed, the new config did not load"},
|
||||
{ReloadResult{Err: errors.New("bad yaml"), RestartRequired: true}, slog.LevelError, "Config reload failed, the new config did not load and a restart is still required"},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
level, msg := tc.res.Summary()
|
||||
assert.Equal(t, tc.level, level, tc.msg)
|
||||
assert.Equal(t, tc.msg, msg)
|
||||
}
|
||||
|
||||
res := ReloadResult{RestartRequired: true, RestartKeys: []string{"a", "b"}}
|
||||
assert.Equal(t, "Config reload was completed but requires a restart to fully apply, keys [a b]", res.String())
|
||||
|
||||
// String includes the error
|
||||
assert.Equal(t, "Config reload failed, the new config did not load: bad yaml", ReloadResult{Err: errors.New("bad yaml")}.String())
|
||||
}
|
||||
|
||||
// The initial load passes a nil Reload
|
||||
func TestReloadNilIsSafe(t *testing.T) {
|
||||
var r *Reload
|
||||
r.Failed()
|
||||
r.RestartRequired()
|
||||
r.RestartRequiredIfChanged("a")
|
||||
}
|
||||
@@ -57,8 +57,7 @@ func newConnectionManagerFromConfig(l *slog.Logger, c *config.C, hm *HostMap, p
|
||||
}
|
||||
|
||||
cm.reload(c, true)
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("timers.connection_alive_interval", "timers.pending_deletion_interval")
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
cm.reload(c, false)
|
||||
})
|
||||
|
||||
@@ -175,8 +174,10 @@ func (cm *connectionManager) doTrafficCheck(localIndex uint32, p, nb, out []byte
|
||||
|
||||
switch decision {
|
||||
case deleteTunnel:
|
||||
// Local delete only, clearing the lighthouse cache if this was the last hostinfo for the vpn addr
|
||||
cm.intf.closeTunnel(hostinfo)
|
||||
if cm.hostMap.DeleteHostInfo(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:
|
||||
cm.intf.sendCloseTunnel(hostinfo)
|
||||
|
||||
@@ -7,7 +7,6 @@ import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/rcrowley/go-metrics"
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/overlay/overlaytest"
|
||||
@@ -22,8 +21,6 @@ func newTestLighthouse() *LightHouse {
|
||||
l: test.NewLogger(),
|
||||
addrMap: map[netip.Addr]*RemoteList{},
|
||||
queryChan: make(chan netip.Addr, 10),
|
||||
// Nothing drains queryChan here, so an 11th query is dropped.
|
||||
queryDropped: metrics.NilCounter{},
|
||||
}
|
||||
lighthouses := []netip.Addr{}
|
||||
staticList := map[netip.Addr]struct{}{}
|
||||
|
||||
@@ -2,8 +2,6 @@ package nebula
|
||||
|
||||
import (
|
||||
"net/netip"
|
||||
"strconv"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
@@ -13,7 +11,6 @@ import (
|
||||
ct "github.com/slackhq/nebula/cert_test"
|
||||
"github.com/slackhq/nebula/handshake"
|
||||
"github.com/slackhq/nebula/header"
|
||||
"github.com/slackhq/nebula/overlay"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/slackhq/nebula/udp"
|
||||
"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")
|
||||
}
|
||||
|
||||
// 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) {
|
||||
initR, respR := runTestHandshake(t)
|
||||
|
||||
|
||||
+2
-1
@@ -203,7 +203,8 @@ func (c *Control) RebindUDPServer() {
|
||||
}
|
||||
|
||||
// A failure here means we are likely still pinned to the interface we came up on, so the rest of this is
|
||||
// unlikely to help. Say so instead of silently carrying on as if we rebound.
|
||||
// unlikely to help. Say so instead of silently carrying on as if we rebound. Only the first writer is rebound;
|
||||
// darwin's Rebind clears every listen routine's listener.
|
||||
if err := c.f.outside.Rebind(); err != nil {
|
||||
c.l.Error("Failed to rebind udp socket", "error", err)
|
||||
}
|
||||
|
||||
@@ -151,7 +151,7 @@ func (c *fakeConn) WriteTo(_ []byte, _ netip.AddrPort) error { return nil }
|
||||
func (c *fakeConn) WriteBatch(bufs [][]byte, _ []netip.AddrPort) (int, error) {
|
||||
return len(bufs), nil
|
||||
}
|
||||
func (c *fakeConn) ReloadConfig(_ *config.C, _ *config.Reload) {}
|
||||
func (c *fakeConn) ReloadConfig(_ *config.C) {}
|
||||
func (c *fakeConn) SupportsMultipleReaders() bool { return true }
|
||||
func (c *fakeConn) Close() error { c.closed = true; return nil }
|
||||
|
||||
|
||||
+1
-2
@@ -69,10 +69,9 @@ func newDnsServerFromConfig(ctx context.Context, l *slog.Logger, pki *PKI, hostM
|
||||
ds.mux = dns.NewServeMux()
|
||||
ds.mux.HandleFunc(".", ds.handleDnsRequest)
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
if err := ds.reload(c, false); err != nil {
|
||||
ds.l.Error("Failed to reload DNS responder from config", "error", err)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
|
||||
@@ -1513,7 +1513,7 @@ func TestLighthouseUpdateOnReload(t *testing.T) {
|
||||
// Reload the config. The lighthouse.hosts change triggers TriggerUpdate,
|
||||
// which wakes the update worker. It calls SendUpdate, initiating a
|
||||
// handshake to the new lighthouse and caching the HostUpdateNotification.
|
||||
require.NoError(t, myConfig.ReloadConfigString(string(newCfg)).Err)
|
||||
require.NoError(t, myConfig.ReloadConfigString(string(newCfg)))
|
||||
|
||||
// Route until the lighthouse receives the HostUpdateNotification.
|
||||
// This covers: handshake stage 1, stage 2, then the cached update.
|
||||
|
||||
+2
-2
@@ -129,7 +129,7 @@ func TestCertUpgrade(t *testing.T) {
|
||||
}
|
||||
|
||||
r.Logf("reload new v2-only config")
|
||||
err = myC.ReloadConfigString(string(cb)).Err
|
||||
err = myC.ReloadConfigString(string(cb))
|
||||
assert.NoError(t, err)
|
||||
r.Log("yay, spin until their sees it")
|
||||
waitStart := time.Now()
|
||||
@@ -222,7 +222,7 @@ func TestCertDowngrade(t *testing.T) {
|
||||
}
|
||||
|
||||
r.Logf("reload new v1-only config")
|
||||
err = myC.ReloadConfigString(string(cb)).Err
|
||||
err = myC.ReloadConfigString(string(cb))
|
||||
assert.NoError(t, err)
|
||||
r.Log("yay, spin until their sees it")
|
||||
waitStart := time.Now()
|
||||
|
||||
@@ -0,0 +1,90 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"net/netip"
|
||||
"sync"
|
||||
|
||||
"github.com/slackhq/nebula/udp"
|
||||
)
|
||||
|
||||
// establishedRemotes tells the udp conns that implement udp.EstablishedPeerConn which addresses are the current
|
||||
// direct remote of at least one established tunnel. A hostinfo holds a reference on its remote while it is in the
|
||||
// main hostmap, and SetRemote moves the reference; a relayed tunnel has no direct remote and holds none.
|
||||
type establishedRemotes struct {
|
||||
mu sync.Mutex
|
||||
conns []udp.EstablishedPeerConn
|
||||
refs map[netip.AddrPort]int
|
||||
}
|
||||
|
||||
// newEstablishedRemotes returns nil when no conn wants to know, which every method accepts.
|
||||
func newEstablishedRemotes(conns []udp.Conn) *establishedRemotes {
|
||||
var pc []udp.EstablishedPeerConn
|
||||
for _, c := range conns {
|
||||
if p, ok := c.(udp.EstablishedPeerConn); ok {
|
||||
pc = append(pc, p)
|
||||
}
|
||||
}
|
||||
if len(pc) == 0 {
|
||||
return nil
|
||||
}
|
||||
return &establishedRemotes{conns: pc, refs: map[netip.AddrPort]int{}}
|
||||
}
|
||||
|
||||
// add makes hostinfo hold a reference on its remote, as it joins the main hostmap. A hostinfo holds references in
|
||||
// one establishedRemotes at a time, so an add while it is in another is ignored.
|
||||
func (e *establishedRemotes) add(hostinfo *HostInfo) {
|
||||
if e == nil {
|
||||
return
|
||||
}
|
||||
e.mu.Lock()
|
||||
defer e.mu.Unlock()
|
||||
if !hostinfo.establishedIn.CompareAndSwap(nil, e) && hostinfo.establishedIn.Load() != e {
|
||||
return
|
||||
}
|
||||
e.syncLocked(hostinfo)
|
||||
}
|
||||
|
||||
// remove drops hostinfo's reference, as it leaves the main hostmap.
|
||||
func (e *establishedRemotes) remove(hostinfo *HostInfo) {
|
||||
if e == nil {
|
||||
return
|
||||
}
|
||||
e.mu.Lock()
|
||||
defer e.mu.Unlock()
|
||||
if hostinfo.establishedIn.CompareAndSwap(e, nil) {
|
||||
e.syncLocked(hostinfo)
|
||||
}
|
||||
}
|
||||
|
||||
// syncLocked moves hostinfo's reference to the remote it should hold now: its current remote while it is
|
||||
// established, none otherwise. Reading both under mu makes the last call win however add, remove and SetRemote
|
||||
// interleave. Only the establishedRemotes that hostinfo is in, or has just left, may call it, since
|
||||
// hostinfo.establishedRemote is a reference in that one's refs.
|
||||
func (e *establishedRemotes) syncLocked(hostinfo *HostInfo) {
|
||||
var want netip.AddrPort
|
||||
if hostinfo.establishedIn.Load() == e {
|
||||
want = hostinfo.GetRemote()
|
||||
}
|
||||
held := hostinfo.establishedRemote
|
||||
if want == held {
|
||||
return
|
||||
}
|
||||
if held.IsValid() {
|
||||
e.refs[held]--
|
||||
if e.refs[held] == 0 {
|
||||
delete(e.refs, held)
|
||||
for _, c := range e.conns {
|
||||
c.SetEstablishedPeer(held, false)
|
||||
}
|
||||
}
|
||||
}
|
||||
if want.IsValid() {
|
||||
e.refs[want]++
|
||||
if e.refs[want] == 1 {
|
||||
for _, c := range e.conns {
|
||||
c.SetEstablishedPeer(want, true)
|
||||
}
|
||||
}
|
||||
}
|
||||
hostinfo.establishedRemote = want
|
||||
}
|
||||
@@ -0,0 +1,173 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"net/netip"
|
||||
"sync"
|
||||
"testing"
|
||||
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/slackhq/nebula/udp"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// establishedPeerConn records which destinations the hostmap has told it are established peers, and fails the test
|
||||
// on a call that doesn't change anything, which would mean a reference count went wrong.
|
||||
type establishedPeerConn struct {
|
||||
udp.NoopConn
|
||||
t *testing.T
|
||||
mu sync.Mutex
|
||||
peers map[netip.AddrPort]bool
|
||||
}
|
||||
|
||||
func (c *establishedPeerConn) SetEstablishedPeer(dst netip.AddrPort, established bool) {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
assert.NotEqual(c.t, established, c.peers[dst], "SetEstablishedPeer(%v, %v) repeated", dst, established)
|
||||
if established {
|
||||
c.peers[dst] = true
|
||||
} else {
|
||||
delete(c.peers, dst)
|
||||
}
|
||||
}
|
||||
|
||||
func (c *establishedPeerConn) established() []netip.AddrPort {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
var out []netip.AddrPort
|
||||
for dst := range c.peers {
|
||||
out = append(out, dst)
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
// newEstablishedTestHostMap returns a hostmap whose conns are a recording conn and one that doesn't track peers.
|
||||
func newEstablishedTestHostMap(t *testing.T) (*HostMap, *establishedPeerConn) {
|
||||
hm := newHostMap(test.NewLogger())
|
||||
hm.preferredRanges.Store(&[]netip.Prefix{netip.MustParsePrefix("192.168.0.0/16")})
|
||||
c := &establishedPeerConn{t: t, peers: map[netip.AddrPort]bool{}}
|
||||
hm.established = newEstablishedRemotes([]udp.Conn{c, udp.NoopConn{}})
|
||||
require.NotNil(t, hm.established)
|
||||
return hm, c
|
||||
}
|
||||
|
||||
func newEstablishedTestHostInfo(vpnAddr netip.Addr, index uint32) *HostInfo {
|
||||
return &HostInfo{
|
||||
vpnAddrs: []netip.Addr{vpnAddr},
|
||||
localIndexId: index,
|
||||
remotes: NewRemoteList([]netip.Addr{vpnAddr}, nil),
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewEstablishedRemotesWithoutTrackingConns(t *testing.T) {
|
||||
assert.Nil(t, newEstablishedRemotes([]udp.Conn{udp.NoopConn{}}))
|
||||
}
|
||||
|
||||
// A conn hears about a remote while at least one hostinfo in the main hostmap has it as its direct remote: from
|
||||
// the add, through roaming and SetRemoteIfPreferred, until the last such hostinfo is deleted or retired by
|
||||
// MaxHostInfosPerVpnIp. Pending and relayed hostinfos never count.
|
||||
func TestHostMap_EstablishedRemotes(t *testing.T) {
|
||||
hm, c := newEstablishedTestHostMap(t)
|
||||
f := &Interface{}
|
||||
a := netip.MustParseAddr("10.0.0.1")
|
||||
r1 := netip.MustParseAddrPort("203.0.113.1:4242")
|
||||
r2 := netip.MustParseAddrPort("203.0.113.2:4242")
|
||||
r3 := netip.MustParseAddrPort("192.168.1.3:4242")
|
||||
|
||||
// A pending hostinfo, as a handshake sets its remote, isn't established.
|
||||
h1 := newEstablishedTestHostInfo(a, 1)
|
||||
h1.SetRemote(r1)
|
||||
assert.Empty(t, c.established())
|
||||
|
||||
// Handshake completion adds it to the main hostmap.
|
||||
hm.unlockedAddHostInfo(h1, f)
|
||||
assert.ElementsMatch(t, []netip.AddrPort{r1}, c.established())
|
||||
|
||||
// A relayed tunnel has no direct remote.
|
||||
relayed := newEstablishedTestHostInfo(netip.MustParseAddr("10.0.0.2"), 2)
|
||||
hm.unlockedAddHostInfo(relayed, f)
|
||||
assert.ElementsMatch(t, []netip.AddrPort{r1}, c.established())
|
||||
|
||||
// A rehandshake's new hostinfo shares the remote, which stays established until both are gone.
|
||||
h3 := newEstablishedTestHostInfo(a, 3)
|
||||
h3.SetRemote(r1)
|
||||
hm.unlockedAddHostInfo(h3, f)
|
||||
hm.DeleteHostInfo(h1)
|
||||
assert.ElementsMatch(t, []netip.AddrPort{r1}, c.established())
|
||||
|
||||
// Roaming moves the reference.
|
||||
h3.SetRemote(r2)
|
||||
assert.ElementsMatch(t, []netip.AddrPort{r2}, c.established())
|
||||
require.True(t, h3.SetRemoteIfPreferred(hm, ViaSender{UdpAddr: r3}))
|
||||
assert.ElementsMatch(t, []netip.AddrPort{r3}, c.established())
|
||||
|
||||
// A relayed tunnel that hears from its peer directly roams onto a direct remote.
|
||||
relayed.SetRemote(r1)
|
||||
assert.ElementsMatch(t, []netip.AddrPort{r1, r3}, c.established())
|
||||
hm.DeleteHostInfo(relayed)
|
||||
|
||||
// A deleted hostinfo lets go, and a SetRemote after that changes nothing.
|
||||
hm.DeleteHostInfo(h3)
|
||||
assert.Empty(t, c.established())
|
||||
h3.SetRemote(r2)
|
||||
assert.Empty(t, c.established())
|
||||
hm.DeleteHostInfo(h3)
|
||||
|
||||
// Adding past MaxHostInfosPerVpnIp retires the oldest hostinfo and its remote.
|
||||
var hs []*HostInfo
|
||||
for i := range MaxHostInfosPerVpnIp + 1 {
|
||||
h := newEstablishedTestHostInfo(a, uint32(10+i))
|
||||
h.SetRemote(netip.AddrPortFrom(netip.MustParseAddr("198.51.100.1"), uint16(1000+i)))
|
||||
hm.unlockedAddHostInfo(h, f)
|
||||
hs = append(hs, h)
|
||||
}
|
||||
assert.Len(t, c.established(), MaxHostInfosPerVpnIp)
|
||||
assert.NotContains(t, c.established(), hs[0].GetRemote())
|
||||
}
|
||||
|
||||
// Roaming on the receive path races tunnel teardown on the connection manager; whatever the order, a deleted
|
||||
// hostinfo holds no reference.
|
||||
func TestHostMap_EstablishedRemotesRoamRacesDelete(t *testing.T) {
|
||||
hm, c := newEstablishedTestHostMap(t)
|
||||
f := &Interface{}
|
||||
a := netip.MustParseAddr("10.0.0.1")
|
||||
for i := range 200 {
|
||||
h := newEstablishedTestHostInfo(a, uint32(i+1))
|
||||
h.SetRemote(netip.MustParseAddrPort("203.0.113.1:4242"))
|
||||
hm.Lock()
|
||||
hm.unlockedAddHostInfo(h, f)
|
||||
hm.Unlock()
|
||||
var wg sync.WaitGroup
|
||||
wg.Go(func() { h.SetRemote(netip.AddrPortFrom(netip.MustParseAddr("203.0.113.2"), uint16(i+1))) })
|
||||
wg.Go(func() { hm.DeleteHostInfo(h) })
|
||||
wg.Wait()
|
||||
require.Empty(t, c.established(), "round %d", i)
|
||||
}
|
||||
}
|
||||
|
||||
// A hostinfo holds its reference in the first tracking hostmap it joins; another's add and delete of it change
|
||||
// nothing, so neither hostmap's counts go wrong.
|
||||
func TestHostMap_EstablishedRemotesSingleOwner(t *testing.T) {
|
||||
hm1, c1 := newEstablishedTestHostMap(t)
|
||||
hm2, c2 := newEstablishedTestHostMap(t)
|
||||
f := &Interface{}
|
||||
r := netip.MustParseAddrPort("203.0.113.1:4242")
|
||||
h := newEstablishedTestHostInfo(netip.MustParseAddr("10.0.0.1"), 1)
|
||||
h.SetRemote(r)
|
||||
|
||||
hm1.unlockedAddHostInfo(h, f)
|
||||
hm2.unlockedAddHostInfo(h, f)
|
||||
assert.ElementsMatch(t, []netip.AddrPort{r}, c1.established())
|
||||
assert.Empty(t, c2.established())
|
||||
|
||||
hm2.DeleteHostInfo(h)
|
||||
assert.Equal(t, map[netip.AddrPort]int{r: 1}, hm1.established.refs)
|
||||
assert.Empty(t, hm2.established.refs)
|
||||
assert.ElementsMatch(t, []netip.AddrPort{r}, c1.established())
|
||||
|
||||
hm1.DeleteHostInfo(h)
|
||||
assert.Empty(t, hm1.established.refs)
|
||||
assert.Empty(t, hm2.established.refs)
|
||||
assert.Empty(t, c1.established())
|
||||
assert.Empty(t, c2.established())
|
||||
}
|
||||
+19
-26
@@ -8,7 +8,6 @@ pki:
|
||||
cert: /etc/nebula/host.crt
|
||||
key: /etc/nebula/host.key
|
||||
# blocklist is a list of certificate fingerprints that we will refuse to talk to
|
||||
# Entries are the hex fingerprints shown by `nebula-cert print`, an invalid entry fails startup and reload.
|
||||
#blocklist:
|
||||
# - c99d4e650533b92061b09918e838a5a0a6aaee21eed1d12fd937682865936c72
|
||||
# disconnect_invalid is a toggle to force a client to be disconnected if the certificate is expired or invalid.
|
||||
@@ -44,7 +43,7 @@ static_host_map:
|
||||
|
||||
lighthouse:
|
||||
# am_lighthouse is used to enable lighthouse functionality for a node. This should ONLY be true on nodes
|
||||
# you have configured to be lighthouses in your network. Not reloadable.
|
||||
# you have configured to be lighthouses in your network
|
||||
am_lighthouse: false
|
||||
# serve_dns optionally starts a dns listener that responds to various queries and can even be
|
||||
# delegated to for resolution
|
||||
@@ -127,9 +126,8 @@ lighthouse:
|
||||
# Port Nebula will be listening on. The default here is 4242. For a lighthouse node, the port should be defined,
|
||||
# however using port 0 will dynamically assign a port and is recommended for roaming nodes.
|
||||
listen:
|
||||
# To listen on only ipv4, use "0.0.0.0". Not reloadable.
|
||||
# To listen on only ipv4, use "0.0.0.0"
|
||||
host: "::"
|
||||
# Not reloadable.
|
||||
port: 4242
|
||||
# Sets the max number of packets to pull from the kernel for each syscall (under systems that support recvmmsg)
|
||||
# default is 64, does not support reload
|
||||
@@ -137,13 +135,12 @@ listen:
|
||||
# superpacket, so the receive scratch is batch * 64KiB per listening socket (~4MiB per routine at the
|
||||
# default of 64). Lower this to trade peak per-syscall throughput for memory on constrained hosts.
|
||||
#batch: 64
|
||||
# Linux only. Reloadable, but removing a value leaves the socket at the old size until Nebula restarts.
|
||||
# Configure socket buffers for the udp side (outside), leave unset to use the system defaults. Values will be doubled by the kernel
|
||||
# Default is net.core.rmem_default and net.core.wmem_default (/proc/sys/net/core/rmem_default and /proc/sys/net/core/rmem_default)
|
||||
# Maximum is limited by memory in the system, SO_RCVBUFFORCE and SO_SNDBUFFORCE is used to avoid having to raise the system wide
|
||||
# max, net.core.rmem_max and net.core.wmem_max
|
||||
read_buffer: 3412512
|
||||
write_buffer: 3412512
|
||||
#read_buffer: 10485760
|
||||
#write_buffer: 10485760
|
||||
|
||||
# On Windows only
|
||||
# When true, Nebula installs a WFP (Windows Filtering Platform) PERMIT filter scoped to UDP at the listener port.
|
||||
@@ -182,7 +179,7 @@ listen:
|
||||
# Currently, this defaults to 1 which means we have 1 tun queue reader and 1
|
||||
# UDP queue reader. Setting this above one will set IFF_MULTI_QUEUE on the tun
|
||||
# device and SO_REUSEPORT on the UDP socket to allow multiple queues.
|
||||
# This option is only supported on Linux. Not reloadable.
|
||||
# This option is only supported on Linux.
|
||||
#routines: 1
|
||||
|
||||
punchy:
|
||||
@@ -206,7 +203,6 @@ punchy:
|
||||
|
||||
# Cipher allows you to choose between the available ciphers for your network. Options are chachapoly or aes
|
||||
# IMPORTANT: this value must be identical on ALL NODES/LIGHTHOUSES. We do not/will not support use of different ciphers simultaneously!
|
||||
# Not reloadable.
|
||||
#cipher: aes
|
||||
|
||||
# Preferred ranges is used to define a hint about the local network ranges, which speeds up discovering the fastest
|
||||
@@ -233,6 +229,12 @@ punchy:
|
||||
# Trusted SSH CA public keys. These are the public keys of the CAs that are allowed to sign SSH keys for access.
|
||||
#trusted_cas:
|
||||
#- "ssh public key string"
|
||||
# sandbox_dir restricts file paths for profiling commands (start-cpu-profile, save-heap-profile,
|
||||
# save-mutex-profile) to the specified directory. Relative paths will be resolved within this directory,
|
||||
# and absolute paths outside of it will be rejected. Default is $TMP/nebula-debug.
|
||||
# The directory is NOT automatically created.
|
||||
# Overriding this to "" is the same as "/" and will allow overwriting any path on the host.
|
||||
#sandbox_dir: /var/tmp/nebula-debug
|
||||
|
||||
# EXPERIMENTAL: relay support for networks that can't establish direct connections.
|
||||
relay:
|
||||
@@ -251,25 +253,18 @@ relay:
|
||||
# Configure the private interface. Note: addr is baked into the nebula certificate
|
||||
tun:
|
||||
# When tun is disabled, a lighthouse can be started without a local tun interface (and therefore without root)
|
||||
# Not reloadable.
|
||||
disabled: false
|
||||
# Name of the device. If not set, a default will be chosen by the OS.
|
||||
# For macOS: if set, must be in the form `utun[0-9]+`.
|
||||
# For OpenBSD and NetBSD: if set, must be in the form `tun[0-9]+`, otherwise the first free one is used.
|
||||
# Not reloadable.
|
||||
# For NetBSD: Required to be set, must be in the form `tun[0-9]+`
|
||||
dev: nebula1
|
||||
# Toggles forwarding of local broadcast packets, the address of which depends on the ip/mask encoded in pki.cert
|
||||
# Not reloadable.
|
||||
drop_local_broadcast: false
|
||||
# Toggles forwarding of multicast packets. Not reloadable.
|
||||
# Toggles forwarding of multicast packets
|
||||
drop_multicast: false
|
||||
# Sets the transmit queue length, if you notice lots of transmit drops on the tun it may help to raise this number. Default is 5000
|
||||
# Not reloadable.
|
||||
tx_queue: 5000
|
||||
# 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
|
||||
# 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
|
||||
# Reloadable on Linux only. Where the tun is handed to nebula by a host app (iOS, Android, macOS network extensions)
|
||||
# the host app owns the MTU.
|
||||
mtu: 1300
|
||||
|
||||
# the use_offloads setting controls if Nebula will attempt to enable GSO and GRO for the tun device. Linux only, not reloadable.
|
||||
@@ -362,7 +357,7 @@ tun:
|
||||
#use_system_route_table: false
|
||||
# Buffer size for reading routes updates. 0 means default system buffer size. (/proc/sys/net/core/rmem_default).
|
||||
# If using massive routes updates, for example BGP, you may need to increase this value to avoid packet loss.
|
||||
# SO_RCVBUFFORCE is used to avoid having to raise the system wide max. Not reloadable.
|
||||
# SO_RCVBUFFORCE is used to avoid having to raise the system wide max
|
||||
#use_system_route_table_buffer_size: 0
|
||||
|
||||
# Configure logging level
|
||||
@@ -412,16 +407,14 @@ logging:
|
||||
# Handshakes are sent to all known addresses at each interval with a linear backoff,
|
||||
# Wait try_interval after the 1st attempt, 2 * try_interval after the 2nd, etc, until the handshake is older than timeout
|
||||
# A 100ms interval with the default 10 retries will give a handshake 5.5 seconds to resolve before timing out
|
||||
# Not reloadable.
|
||||
#try_interval: 100ms
|
||||
#retries: 20
|
||||
|
||||
# query_buffer is the size of the buffer channel for querying lighthouses, drops are recorded in the lighthouse.query.dropped metric.
|
||||
# Not reloadable.
|
||||
#query_buffer: 1024
|
||||
# query_buffer is the size of the buffer channel for querying lighthouses
|
||||
#query_buffer: 64
|
||||
|
||||
# trigger_buffer is the size of the buffer channel for quickly sending handshakes
|
||||
# after receiving the response for lighthouse queries. Not reloadable.
|
||||
# after receiving the response for lighthouse queries
|
||||
#trigger_buffer: 64
|
||||
|
||||
# Tunnel manager settings
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
module github.com/slackhq/nebula
|
||||
|
||||
go 1.27.2
|
||||
go 1.26.0
|
||||
|
||||
require (
|
||||
dario.cat/mergo v1.0.2
|
||||
@@ -33,7 +33,7 @@ require (
|
||||
golang.zx2c4.com/wireguard/windows v1.0.1
|
||||
google.golang.org/protobuf v1.36.12
|
||||
gopkg.in/yaml.v3 v3.0.1
|
||||
gvisor.dev/gvisor v0.0.0-20261014193016-04d31b385980
|
||||
gvisor.dev/gvisor v0.0.0-20240423190808-9d7a357edefe
|
||||
)
|
||||
|
||||
require (
|
||||
@@ -45,6 +45,5 @@ require (
|
||||
github.com/prometheus/common v0.70.1 // indirect
|
||||
github.com/prometheus/procfs v0.21.1 // indirect
|
||||
github.com/vishvananda/netns v0.0.5 // indirect
|
||||
golang.org/x/exp v0.0.0-20250711185948-6ae5c78190dc // indirect
|
||||
golang.org/x/time v0.15.0 // indirect
|
||||
golang.org/x/time v0.5.0 // indirect
|
||||
)
|
||||
@@ -157,8 +157,6 @@ golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPh
|
||||
golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4=
|
||||
golang.org/x/crypto v0.57.0 h1:3ZVCjf8Ggz7zneR/EHRVx68Ctf+2pmIMP2UFhh9cC6M=
|
||||
golang.org/x/crypto v0.57.0/go.mod h1:Fdz0i5U6CoizGwLda9DttjSk6qlZo25zYNtR+ycvuZA=
|
||||
golang.org/x/exp v0.0.0-20250711185948-6ae5c78190dc h1:TS73t7x3KarrNd5qAipmspBDS1rkMcgVG/fS1aRb4Rc=
|
||||
golang.org/x/exp v0.0.0-20250711185948-6ae5c78190dc/go.mod h1:A+z0yzpGtvnG90cToK5n2tu8UJVP2XUATh+r+sfOOOc=
|
||||
golang.org/x/lint v0.0.0-20200302205851-738671d3881b/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY=
|
||||
golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
|
||||
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||
@@ -205,8 +203,8 @@ golang.org/x/term v0.46.0/go.mod h1:+K02xbkittuwc0Am4abfA3Fc+XRGXkvBXNO88NCXPoc=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
|
||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/time v0.15.0 h1:bbrp8t3bGUeFOx08pvsMYRTCVSMk89u4tKbNOZbp88U=
|
||||
golang.org/x/time v0.15.0/go.mod h1:Y4YMaQmXwGQZoFaVFk4YpCt4FLQMYKZe9oeV/f4MSno=
|
||||
golang.org/x/time v0.5.0 h1:o7cqy6amK/52YcAKIPlM3a+Fpj35zvRj2TP+e1xFSfk=
|
||||
golang.org/x/time v0.5.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM=
|
||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
||||
golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
|
||||
@@ -245,5 +243,5 @@ gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
gvisor.dev/gvisor v0.0.0-20261014193016-04d31b385980 h1:ribyrTYQ/QYeUIs8x8bVLYwGyepa7RnHLqJzegT5YYk=
|
||||
gvisor.dev/gvisor v0.0.0-20261014193016-04d31b385980/go.mod h1:pK/dapF5Bf3KGW7/kd5CI5IC4lYh9FMFY1qETAIGLXk=
|
||||
gvisor.dev/gvisor v0.0.0-20240423190808-9d7a357edefe h1:fre4i6mv4iBuz5lCMOzHD1rH1ljqHWSICFmZRbbgp3g=
|
||||
gvisor.dev/gvisor v0.0.0-20240423190808-9d7a357edefe/go.mod h1:sxc3Uvk/vHcd3tj7/DHVBoR5wvWT/MmRq2pj7HRJnwU=
|
||||
+5
-18
@@ -31,7 +31,6 @@ package nebula
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"context"
|
||||
"fmt"
|
||||
"net"
|
||||
"strconv"
|
||||
@@ -52,29 +51,17 @@ type graphiteConfigExport struct {
|
||||
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
|
||||
// error if it could not connect or write all of it within timeout. It gives up
|
||||
// as soon as ctx is done.
|
||||
func graphiteOnce(ctx context.Context, c graphiteConfigExport, timeout time.Duration) error {
|
||||
// error on failed connections.
|
||||
func graphiteOnce(c graphiteConfigExport) error {
|
||||
now := time.Now().Unix()
|
||||
du := float64(c.DurationUnit)
|
||||
flushSeconds := float64(c.FlushInterval) / float64(time.Second)
|
||||
deadline := time.Now().Add(timeout)
|
||||
d := net.Dialer{Deadline: deadline}
|
||||
conn, err := d.DialContext(ctx, "tcp", c.Addr.String())
|
||||
conn, err := net.DialTCP("tcp", nil, c.Addr)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
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)
|
||||
c.Registry.Each(func(name string, i any) {
|
||||
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.mean-rate %.2f %d\n", c.Prefix, name, t.RateMean(), now)
|
||||
}
|
||||
w.Flush()
|
||||
})
|
||||
// A failed write sticks, so this reports the first one
|
||||
return w.Flush()
|
||||
return nil
|
||||
}
|
||||
@@ -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 {
|
||||
// Mutex for interacting with the vpnIps and indexes maps.
|
||||
// Lock order is hostmap, then this lock, then the lighthouse, then a RemoteList.
|
||||
// Mutex for interacting with the vpnIps and indexes maps
|
||||
sync.RWMutex
|
||||
|
||||
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()),
|
||||
}
|
||||
|
||||
// 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())
|
||||
remotesHaveChanged := !slices.Equal(remotes, hh.lastRemotes)
|
||||
|
||||
@@ -364,9 +371,6 @@ func (hm *HandshakeManager) StartHandshake(vpnAddr netip.Addr, cacheCb func(*Han
|
||||
hostinfo := &HostInfo{
|
||||
vpnAddrs: []netip.Addr{vpnAddr},
|
||||
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{
|
||||
relays: nil,
|
||||
relayForByAddr: map[netip.Addr]*Relay{},
|
||||
@@ -942,14 +946,13 @@ func (hm *HandshakeManager) continueHandshake(via ViaSender, hh *HandshakeHostIn
|
||||
|
||||
hm.DeleteHostInfo(hostinfo)
|
||||
hm.StartHandshake(hostinfo.vpnAddrs[0], func(newHH *HandshakeHostInfo) {
|
||||
newHH.hostinfo.remotes = hostinfo.remotes
|
||||
newHH.hostinfo.remotes.BlockRemote(via)
|
||||
newHH.packetStore = hh.packetStore
|
||||
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
|
||||
f.sendCloseTunnel(hostinfo)
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@@ -11,7 +11,6 @@ import (
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/slackhq/nebula/udp"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func Test_NewHandshakeManagerVpnIp(t *testing.T) {
|
||||
@@ -43,6 +42,8 @@ func Test_NewHandshakeManagerVpnIp(t *testing.T) {
|
||||
i2 := blah.StartHandshake(ip, nil)
|
||||
assert.Same(t, i, i2)
|
||||
|
||||
i.remotes = NewRemoteList([]netip.Addr{}, nil)
|
||||
|
||||
// Adding something to pending should not affect the main hostmap
|
||||
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")
|
||||
})
|
||||
}
|
||||
|
||||
// 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 (
|
||||
Version uint8 = 1
|
||||
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
|
||||
|
||||
+21
-7
@@ -69,6 +69,8 @@ type HostMap struct {
|
||||
Hosts map[netip.Addr]*HostInfo
|
||||
moreHosts map[netip.Addr][]*HostInfo
|
||||
preferredRanges atomic.Pointer[[]netip.Prefix]
|
||||
// established hears about each hostinfo that joins or leaves the hostmap; nil when no conn wants to know.
|
||||
established *establishedRemotes
|
||||
l *slog.Logger
|
||||
}
|
||||
|
||||
@@ -276,6 +278,11 @@ type HostInfo struct {
|
||||
// This value will be behind against actual tunnel utilization in the hot path.
|
||||
// This should only be used by the ConnectionManagers ticker routine.
|
||||
lastUsed time.Time
|
||||
|
||||
// establishedIn is set while the hostinfo is in a main hostmap whose conns track established remotes, and
|
||||
// establishedRemote is the remote it holds a reference on there, guarded by establishedIn's mu.
|
||||
establishedIn atomic.Pointer[establishedRemotes]
|
||||
establishedRemote netip.AddrPort
|
||||
}
|
||||
|
||||
type ViaSender struct {
|
||||
@@ -316,9 +323,9 @@ type cachedPacketMetrics struct {
|
||||
func NewHostMapFromConfig(l *slog.Logger, c *config.C) *HostMap {
|
||||
hm := newHostMap(l)
|
||||
|
||||
hm.reload(c, true, nil)
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
hm.reload(c, false, r)
|
||||
hm.reload(c, true)
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
hm.reload(c, false)
|
||||
})
|
||||
|
||||
l.Info("Main HostMap created", "preferredRanges", hm.GetPreferredRanges())
|
||||
@@ -337,8 +344,7 @@ func newHostMap(l *slog.Logger) *HostMap {
|
||||
}
|
||||
}
|
||||
|
||||
// r is nil on the initial load
|
||||
func (hm *HostMap) reload(c *config.C, initial bool, r *config.Reload) {
|
||||
func (hm *HostMap) reload(c *config.C, initial bool) {
|
||||
if initial || c.HasChanged("preferred_ranges") {
|
||||
var preferredRanges []netip.Prefix
|
||||
rawPreferredRanges := c.GetStringSlice("preferred_ranges", []string{})
|
||||
@@ -349,9 +355,8 @@ func (hm *HostMap) reload(c *config.C, initial bool, r *config.Reload) {
|
||||
if err != nil {
|
||||
hm.l.Warn("Failed to parse preferred ranges, ignoring",
|
||||
"error", err,
|
||||
"range", rawPreferredRange,
|
||||
"range", rawPreferredRanges,
|
||||
)
|
||||
r.Failed()
|
||||
continue
|
||||
}
|
||||
|
||||
@@ -518,6 +523,7 @@ func (hm *HostMap) unlockedDeleteHostInfo(hostinfo *HostInfo) bool {
|
||||
if len(hm.Indexes) == 0 {
|
||||
hm.Indexes = map[uint32]*HostInfo{}
|
||||
}
|
||||
hm.established.remove(hostinfo)
|
||||
|
||||
if hm.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||
hm.l.Debug("Hostmap hostInfo deleted",
|
||||
@@ -664,6 +670,7 @@ func (hm *HostMap) unlockedAddHostInfo(hostinfo *HostInfo, f *Interface) {
|
||||
|
||||
hm.Indexes[hostinfo.localIndexId] = hostinfo
|
||||
hm.RemoteIndexes[hostinfo.remoteIndexId] = hostinfo
|
||||
hm.established.add(hostinfo)
|
||||
|
||||
hostinfo.markOut(f.rebindEpoch.Load())
|
||||
if f.connectionManager != nil { // f.connectionManager is only nil in some unit tests
|
||||
@@ -844,6 +851,13 @@ func (i *HostInfo) SetRemote(remote netip.AddrPort) {
|
||||
if i.GetRemote() != remote {
|
||||
i.remote.Store(&remote)
|
||||
i.remotes.LearnRemote(i.vpnAddrs[0], remote)
|
||||
if e := i.establishedIn.Load(); e != nil {
|
||||
e.mu.Lock()
|
||||
if i.establishedIn.Load() == e {
|
||||
e.syncLocked(i)
|
||||
}
|
||||
e.mu.Unlock()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -447,16 +447,3 @@ func TestHostInfo_markOutOnly(t *testing.T) {
|
||||
assert.True(t, h.markOut(6), "a relayed send must not consume the epoch edge")
|
||||
assert.False(t, h.markOut(6))
|
||||
}
|
||||
|
||||
// A preferred range that doesn't parse is skipped and the rest are used, the reload says one was skipped
|
||||
func TestHostMap_reloadBadPreferredRangeFails(t *testing.T) {
|
||||
l := test.NewLogger()
|
||||
c := config.NewC(l)
|
||||
require.NoError(t, c.LoadString("preferred_ranges: [10.0.0.0/8]\n"))
|
||||
hm := NewHostMapFromConfig(l, c)
|
||||
|
||||
res := c.ReloadConfigString("preferred_ranges: [10.0.0.0/8, nope]\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.Failed)
|
||||
assert.Equal(t, []netip.Prefix{netip.MustParsePrefix("10.0.0.0/8")}, hm.GetPreferredRanges())
|
||||
}
|
||||
@@ -10,7 +10,6 @@ import (
|
||||
"github.com/slackhq/nebula/firewall"
|
||||
"github.com/slackhq/nebula/header"
|
||||
"github.com/slackhq/nebula/iputil"
|
||||
"github.com/slackhq/nebula/logging"
|
||||
"github.com/slackhq/nebula/noiseutil"
|
||||
"github.com/slackhq/nebula/overlay/batch"
|
||||
"github.com/slackhq/nebula/overlay/tio"
|
||||
@@ -18,20 +17,12 @@ import (
|
||||
)
|
||||
|
||||
func (f *Interface) consumeInsidePacket(pkt tio.Packet, fwPacket *firewall.ParsedPacket, nb []byte, sendBatch *batch.SendBatch, rejectBuf []byte, q int, localCache firewall.ConntrackCache) {
|
||||
if hostinfo := f.filterInsidePacket(pkt, fwPacket, rejectBuf, q, localCache); hostinfo != nil {
|
||||
f.sendInsideMessage(hostinfo, pkt, nb, sendBatch)
|
||||
}
|
||||
}
|
||||
|
||||
// filterInsidePacket parses and filters pkt, handling local traffic, destination lookup, pending handshakes and
|
||||
// the outbound firewall. It returns the hostinfo to send pkt to, or nil when pkt was dropped, rejected, forwarded
|
||||
// to self or cached for a pending handshake.
|
||||
func (f *Interface) filterInsidePacket(pkt tio.Packet, fwPacket *firewall.ParsedPacket, rejectBuf []byte, q int, localCache firewall.ConntrackCache) *HostInfo {
|
||||
// borrowed: pkt.Bytes is owned by the originating tio.Queue and is
|
||||
// only valid until the next Read on that queue. Filtering and sending
|
||||
// must finish before then. Self-forwarding writes synchronously and the
|
||||
// handshake cache copies each segment. To retain the packet beyond the
|
||||
// next Read, use pkt.Clone() to detach it from the borrow.
|
||||
// only valid until the next Read on that queue. Every consumer below
|
||||
// (parse, self-forward, handshake cache, sendInsideMessage) reads it
|
||||
// synchronously; do not retain pkt outside this call. If a future
|
||||
// caller needs to keep the packet, use pkt.Clone() to detach it from
|
||||
// the borrow.
|
||||
//
|
||||
// pkt.Bytes is either one IP datagram (GSO zero) or a TSO/USO
|
||||
// superpacket. In both cases the L3+L4 headers at the start describe
|
||||
@@ -46,13 +37,13 @@ func (f *Interface) filterInsidePacket(pkt tio.Packet, fwPacket *firewall.Parsed
|
||||
"error", err,
|
||||
)
|
||||
}
|
||||
return nil
|
||||
return
|
||||
}
|
||||
|
||||
// Ignore local broadcast packets
|
||||
if f.dropLocalBroadcast {
|
||||
if f.myBroadcastAddrsTable.Contains(fwPacket.RemoteAddr) {
|
||||
return nil
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
@@ -79,12 +70,12 @@ func (f *Interface) filterInsidePacket(pkt tio.Packet, fwPacket *firewall.Parsed
|
||||
}
|
||||
// Otherwise, drop. On linux, we should never see these packets - Linux
|
||||
// routes packets from the nebula addr to the nebula addr through the loopback device.
|
||||
return nil
|
||||
return
|
||||
}
|
||||
|
||||
// Ignore multicast packets
|
||||
if f.dropMulticast && fwPacket.RemoteAddr.IsMulticast() {
|
||||
return nil
|
||||
return
|
||||
}
|
||||
|
||||
hostinfo, ready := f.getOrHandshakeConsiderRouting(&fwPacket.Packet, func(hh *HandshakeHostInfo) {
|
||||
@@ -111,18 +102,17 @@ func (f *Interface) filterInsidePacket(pkt tio.Packet, fwPacket *firewall.Parsed
|
||||
"fwPacket", fwPacket,
|
||||
)
|
||||
}
|
||||
return nil
|
||||
return
|
||||
}
|
||||
|
||||
if !ready {
|
||||
return nil
|
||||
return
|
||||
}
|
||||
|
||||
dropReason := f.firewall.Drop(fwPacket.Packet, false, hostinfo, f.pki.GetCAPool(), localCache)
|
||||
if dropReason == nil {
|
||||
return hostinfo
|
||||
}
|
||||
|
||||
f.sendInsideMessage(hostinfo, pkt, nb, sendBatch)
|
||||
} else {
|
||||
f.rejectInside(packet, rejectBuf, q)
|
||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||
hostinfo.logger(f.l).Debug("dropping outbound packet",
|
||||
@@ -130,7 +120,7 @@ func (f *Interface) filterInsidePacket(pkt tio.Packet, fwPacket *firewall.Parsed
|
||||
"reason", dropReason,
|
||||
)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
func (f *Interface) sendInsideEncrypt(hostinfo *HostInfo, ci *ConnectionState, seg, scratch, nb []byte) []byte {
|
||||
@@ -208,8 +198,8 @@ func (f *Interface) sendInsideMessage(hostinfo *HostInfo, pkt tio.Packet, nb []b
|
||||
}
|
||||
|
||||
err = tio.SegmentSuperpacket(pkt, func(seg []byte) error {
|
||||
//relay header + header + plaintext + AEAD tag + relay tag
|
||||
scratch := sendBatch.Reserve(len(seg) + header.MaxOverhead)
|
||||
//relay header + header + plaintext + AEAD tag (16 bytes for both AES-GCM and ChaCha20-Poly1305) + relay tag
|
||||
scratch := sendBatch.Reserve(header.Len + header.Len + len(seg) + 16 + 16)
|
||||
|
||||
innerPacket := f.sendInsideEncrypt(hostinfo, ci, seg, scratch[header.Len:], nb)
|
||||
if innerPacket == nil {
|
||||
@@ -527,9 +517,7 @@ func (f *Interface) SendVia(via *HostInfo, relay *Relay, ad, nb, out []byte, noc
|
||||
|
||||
err = f.writers[q].WriteTo(toSend, via.GetRemote())
|
||||
if err != nil {
|
||||
if l, ok := logging.RateLimited(f.l, f.udpRelayTxErrLimiter); ok {
|
||||
via.logger(l).Info("Failed to WriteTo in sendVia", "error", err)
|
||||
}
|
||||
via.logger(f.l).Info("Failed to WriteTo in sendVia", "error", err)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -538,26 +526,16 @@ func (f *Interface) sendNoMetrics(t header.MessageType, st header.MessageSubType
|
||||
return
|
||||
}
|
||||
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
|
||||
|
||||
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.
|
||||
out = out[header.Len:header.Len]
|
||||
out = out[header.Len:]
|
||||
}
|
||||
|
||||
if noiseutil.EncryptLockNeeded {
|
||||
@@ -604,23 +582,19 @@ func (f *Interface) sendNoMetrics(t header.MessageType, st header.MessageSubType
|
||||
if remote.IsValid() {
|
||||
err = f.writers[q].WriteTo(out, remote)
|
||||
if err != nil {
|
||||
if l, ok := logging.RateLimited(f.l, f.udpTxErrLimiter); ok {
|
||||
hostinfo.logger(l).Error("Failed to write outgoing packet",
|
||||
hostinfo.logger(f.l).Error("Failed to write outgoing packet",
|
||||
"error", err,
|
||||
"udpAddr", remote,
|
||||
)
|
||||
}
|
||||
}
|
||||
} else if hr := hostinfo.GetRemote(); hr.IsValid() {
|
||||
err = f.writers[q].WriteTo(out, hr)
|
||||
if err != nil {
|
||||
if l, ok := logging.RateLimited(f.l, f.udpTxErrLimiter); ok {
|
||||
hostinfo.logger(l).Error("Failed to write outgoing packet",
|
||||
hostinfo.logger(f.l).Error("Failed to write outgoing packet",
|
||||
"error", err,
|
||||
"udpAddr", hr,
|
||||
)
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Try to send via a relay
|
||||
for _, relayIP := range hostinfo.relayState.CopyRelayIps() {
|
||||
|
||||
@@ -1,180 +0,0 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"net/netip"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gaissmai/bart"
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/firewall"
|
||||
"github.com/slackhq/nebula/header"
|
||||
"github.com/slackhq/nebula/overlay/batch"
|
||||
"github.com/slackhq/nebula/overlay/overlaytest"
|
||||
"github.com/slackhq/nebula/overlay/tio"
|
||||
"github.com/slackhq/nebula/udp"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func newInsideFilterTestInterface(t *testing.T, allow bool) (*Interface, *HostInfo, *capturingTun) {
|
||||
t.Helper()
|
||||
local := netip.MustParseAddr("192.0.2.1")
|
||||
remote := netip.MustParseAddr("192.0.2.2")
|
||||
f, tun := newSelfForwardInterface(local)
|
||||
f.inside = overlaytest.NoopTun{}
|
||||
f.myVpnNetworksTable = &bart.Lite{}
|
||||
f.myVpnNetworksTable.Insert(netip.MustParsePrefix("192.0.2.0/24"))
|
||||
f.myBroadcastAddrsTable.Insert(netip.MustParsePrefix("192.0.2.255/32"))
|
||||
f.dropLocalBroadcast, f.dropMulticast = true, true
|
||||
localCert := &dummyCert{version: cert.Version1, networks: []netip.Prefix{netip.PrefixFrom(local, 24)}}
|
||||
peerCert := &dummyCert{version: cert.Version1, networks: []netip.Prefix{netip.PrefixFrom(remote, 24)}}
|
||||
f.firewall = NewFirewall(f.l, time.Minute, time.Minute, time.Minute, localCert)
|
||||
if allow {
|
||||
require.NoError(t, f.firewall.AddRule(false, firewall.ProtoAny, 0, 0, []string{"any"}, "", "", "", "", ""))
|
||||
}
|
||||
f.pki = &PKI{}
|
||||
f.pki.caPool.Store(cert.NewCAPool())
|
||||
f.hostMap = newHostMap(f.l)
|
||||
f.lightHouse = newTestLighthouse()
|
||||
f.lightHouse.amLighthouse = true // Keep destination lookup from probing other remotes.
|
||||
f.handshakeManager = NewHandshakeManager(f.l, f.hostMap, f.lightHouse, udp.NoopConn{}, defaultHandshakeConfig)
|
||||
f.handshakeManager.f = f
|
||||
f.connectionManager = &connectionManager{intf: f}
|
||||
h := &HostInfo{
|
||||
vpnAddrs: []netip.Addr{remote},
|
||||
ConnectionState: &ConnectionState{
|
||||
peerCert: &cert.CachedCertificate{Certificate: peerCert},
|
||||
},
|
||||
}
|
||||
f.hostMap.Hosts[remote] = h
|
||||
return f, h, tun
|
||||
}
|
||||
|
||||
func TestFilterInsidePacket(t *testing.T) {
|
||||
local := netip.MustParseAddr("192.0.2.1")
|
||||
remote := netip.MustParseAddr("192.0.2.2")
|
||||
for _, tt := range []struct {
|
||||
name string
|
||||
packet []byte
|
||||
allow bool
|
||||
reject bool
|
||||
ready bool
|
||||
writes int
|
||||
}{
|
||||
{name: "allowed", packet: buildIPv4(local, remote, tcpSyn), allow: true, ready: true},
|
||||
{name: "malformed", packet: []byte{0x45}, allow: true},
|
||||
{name: "broadcast", packet: buildIPv4(local, netip.MustParseAddr("192.0.2.255"), udpDatagram), allow: true},
|
||||
{name: "multicast", packet: buildIPv4(local, netip.MustParseAddr("224.0.0.1"), udpDatagram), allow: true},
|
||||
{name: "firewall drop", packet: buildIPv4(local, remote, tcpSyn)},
|
||||
{name: "firewall reject", packet: buildIPv4(local, remote, tcpSyn), reject: true, writes: 1},
|
||||
{name: "unroutable drop", packet: buildIPv4(local, netip.MustParseAddr("198.51.100.1"), tcpSyn), allow: true},
|
||||
{name: "unroutable reject", packet: buildIPv4(local, netip.MustParseAddr("198.51.100.1"), tcpSyn), allow: true, reject: true, writes: 1},
|
||||
} {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
f, h, tun := newInsideFilterTestInterface(t, tt.allow)
|
||||
f.firewall.OutboundSendReject = tt.reject
|
||||
fp := &firewall.ParsedPacket{}
|
||||
got := f.filterInsidePacket(tio.Packet{Bytes: tt.packet}, fp, make([]byte, mtu), 0, nil)
|
||||
if tt.ready {
|
||||
require.Same(t, h, got)
|
||||
assert.Equal(t, local, fp.LocalAddr)
|
||||
assert.Equal(t, remote, fp.RemoteAddr)
|
||||
} else {
|
||||
require.Nil(t, got)
|
||||
}
|
||||
assert.Zero(t, h.ConnectionState.messageCounter.Load(), "filtering must not allocate encryption counters")
|
||||
assert.False(t, h.sentSinceCheck(), "filtering must not mark outbound traffic")
|
||||
require.Len(t, tun.writes, tt.writes)
|
||||
if tt.writes > 0 {
|
||||
require.GreaterOrEqual(t, len(tun.writes[0]), 40)
|
||||
assert.Equal(t, tt.packet[16:20], tun.writes[0][12:16])
|
||||
assert.Equal(t, tt.packet[12:16], tun.writes[0][16:20])
|
||||
assert.NotZero(t, tun.writes[0][33]&0x04, "reject must carry a TCP reset")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestFilterInsidePacketSelf(t *testing.T) {
|
||||
local := netip.MustParseAddr("192.0.2.1")
|
||||
f, _, tun := newInsideFilterTestInterface(t, true)
|
||||
pkt := buildIPv4(local, local, tcpSyn)
|
||||
require.Nil(t, f.filterInsidePacket(tio.Packet{Bytes: pkt}, &firewall.ParsedPacket{}, nil, 0, nil))
|
||||
if immediatelyForwardToSelf {
|
||||
require.Len(t, tun.writes, 1)
|
||||
assert.Equal(t, pkt, tun.writes[0])
|
||||
} else {
|
||||
assert.Empty(t, tun.writes)
|
||||
}
|
||||
}
|
||||
|
||||
func TestFilterInsidePacketPendingHandshake(t *testing.T) {
|
||||
f, h, tun := newInsideFilterTestInterface(t, true)
|
||||
remote := h.vpnAddrs[0]
|
||||
delete(f.hostMap.Hosts, remote)
|
||||
hh := &HandshakeHostInfo{hostinfo: h}
|
||||
f.handshakeManager.vpnIps[remote] = hh
|
||||
pkt := buildIPv4(netip.MustParseAddr("192.0.2.1"), remote, udpDatagram)
|
||||
want := append([]byte(nil), pkt...)
|
||||
require.Nil(t, f.filterInsidePacket(tio.Packet{Bytes: pkt}, &firewall.ParsedPacket{}, nil, 0, nil))
|
||||
require.Len(t, hh.packetStore, 1)
|
||||
clear(pkt)
|
||||
assert.Equal(t, want, hh.packetStore[0].packet, "the handshake cache must own its packet")
|
||||
assert.Equal(t, header.Message, hh.packetStore[0].messageType)
|
||||
assert.Empty(t, tun.writes)
|
||||
assert.Zero(t, h.ConnectionState.messageCounter.Load())
|
||||
}
|
||||
|
||||
type insideFilterConn struct {
|
||||
udp.NoopConn
|
||||
packets [][]byte
|
||||
}
|
||||
|
||||
func (c *insideFilterConn) WriteBatch(bufs [][]byte, _ []netip.AddrPort) (int, error) {
|
||||
for _, b := range bufs {
|
||||
c.packets = append(c.packets, append([]byte(nil), b...))
|
||||
}
|
||||
return len(bufs), nil
|
||||
}
|
||||
|
||||
func TestConsumeInsidePacketFilterAndSend(t *testing.T) {
|
||||
for _, allow := range []bool{false, true} {
|
||||
t.Run(map[bool]string{false: "denied", true: "allowed"}[allow], func(t *testing.T) {
|
||||
f, h, _ := newInsideFilterTestInterface(t, allow)
|
||||
initR, respR := runTestHandshake(t)
|
||||
ci, err := newConnectionStateFromResult(initR)
|
||||
require.NoError(t, err)
|
||||
rci, err := newConnectionStateFromResult(respR)
|
||||
require.NoError(t, err)
|
||||
ci.peerCert = h.ConnectionState.peerCert
|
||||
h.ConnectionState = ci
|
||||
h.remoteIndexId = 100
|
||||
remote := netip.MustParseAddrPort("198.51.100.2:4242")
|
||||
h.remote.Store(&remote)
|
||||
conn := &insideFilterConn{}
|
||||
sb := batch.NewSendBatch(conn, 1, mtu)
|
||||
pkt := buildIPv4(netip.MustParseAddr("192.0.2.1"), h.vpnAddrs[0], udpDatagram)
|
||||
before := ci.messageCounter.Load()
|
||||
f.consumeInsidePacket(tio.Packet{Bytes: pkt}, &firewall.ParsedPacket{}, make([]byte, 12), sb, nil, 0, nil)
|
||||
_, err = sb.Flush()
|
||||
require.NoError(t, err)
|
||||
if !allow {
|
||||
assert.Empty(t, conn.packets)
|
||||
assert.Equal(t, before, ci.messageCounter.Load())
|
||||
assert.False(t, h.sentSinceCheck())
|
||||
return
|
||||
}
|
||||
require.Len(t, conn.packets, 1)
|
||||
assert.True(t, h.sentSinceCheck())
|
||||
hdr := &header.H{}
|
||||
require.NoError(t, hdr.Parse(conn.packets[0]))
|
||||
assert.Equal(t, header.Message, hdr.Type)
|
||||
assert.Equal(t, h.remoteIndexId, hdr.RemoteIndex)
|
||||
assert.Equal(t, before+1, hdr.MessageCounter)
|
||||
plain, err := rci.Decrypt(f.l, hdr.MessageCounter, conn.packets[0], make([]byte, 12))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, pkt, plain)
|
||||
})
|
||||
}
|
||||
}
|
||||
+33
-31
@@ -24,7 +24,6 @@ import (
|
||||
"github.com/slackhq/nebula/overlay"
|
||||
"github.com/slackhq/nebula/overlay/batch"
|
||||
"github.com/slackhq/nebula/overlay/tio"
|
||||
"github.com/slackhq/nebula/ratelimit"
|
||||
"github.com/slackhq/nebula/udp"
|
||||
)
|
||||
|
||||
@@ -125,10 +124,6 @@ type Interface struct {
|
||||
batchers []*batch.MultiCoalescer
|
||||
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.
|
||||
// nil means "no fatal error" (yet)
|
||||
fatalErr atomic.Pointer[error]
|
||||
@@ -203,19 +198,6 @@ func NewInterface(ctx context.Context, c *InterfaceConfig) (*Interface, error) {
|
||||
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 {
|
||||
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,
|
||||
cpuAffinity: c.CpuAffinity,
|
||||
pinThreads: c.PinThreads,
|
||||
udpTxErrLimiter: udpTxErrLimiter,
|
||||
udpRelayTxErrLimiter: udpRelayTxErrLimiter,
|
||||
txOversizeLimiter: txOversizeLimiter,
|
||||
|
||||
metricHandshakes: metrics.GetOrRegisterHistogram("handshakes", nil, metrics.NewExpDecaySample(1028, 0.015)),
|
||||
metricTxDropped: metrics.GetOrRegisterCounter("udp.tx.dropped", nil),
|
||||
@@ -453,6 +432,11 @@ func (f *Interface) pinThisThread(i int) {
|
||||
}
|
||||
|
||||
func (f *Interface) listenIn(queue tio.Queue, i int) {
|
||||
if sendPipelinePlatform {
|
||||
listenInPipelined(f, queue, i)
|
||||
return
|
||||
}
|
||||
|
||||
// Pinning this thread (and goroutine) to a single CPU keeps every sendmmsg from this goroutine going through the
|
||||
// same TX ring on the nic, so the wire sees per-flow order. Skip entirely when tun.pin_threads is false.
|
||||
if f.pinThreads {
|
||||
@@ -499,6 +483,11 @@ func (f *Interface) listenIn(queue tio.Queue, i int) {
|
||||
func (f *Interface) flushSendBatch(sb *batch.SendBatch, q int) {
|
||||
queued := sb.Len()
|
||||
written, err := sb.Flush()
|
||||
f.accountSendBatch(queued, written, err, q)
|
||||
}
|
||||
|
||||
// accountSendBatch is flushSendBatch's accounting, also for the writes a send pipeline makes.
|
||||
func (f *Interface) accountSendBatch(queued, written int, err error, q int) {
|
||||
if err != nil {
|
||||
f.l.Error("Failed to write outgoing batch", "error", err, "writer", q)
|
||||
}
|
||||
@@ -509,11 +498,10 @@ func (f *Interface) flushSendBatch(sb *batch.SendBatch, q int) {
|
||||
|
||||
func (f *Interface) RegisterConfigChangeCallbacks(c *config.C) {
|
||||
c.RegisterReloadCallback(f.reloadFirewall)
|
||||
for _, reload := range []func(*config.C){
|
||||
f.reloadSendRecvError, f.reloadAcceptRecvError, f.reloadDisconnectInvalid, f.reloadMisc,
|
||||
} {
|
||||
c.RegisterReloadCallback(func(c *config.C, _ *config.Reload) { reload(c) })
|
||||
}
|
||||
c.RegisterReloadCallback(f.reloadSendRecvError)
|
||||
c.RegisterReloadCallback(f.reloadAcceptRecvError)
|
||||
c.RegisterReloadCallback(f.reloadDisconnectInvalid)
|
||||
c.RegisterReloadCallback(f.reloadMisc)
|
||||
|
||||
for _, udpConn := range f.writers {
|
||||
c.RegisterReloadCallback(udpConn.ReloadConfig)
|
||||
@@ -530,7 +518,7 @@ func (f *Interface) reloadDisconnectInvalid(c *config.C) {
|
||||
}
|
||||
}
|
||||
|
||||
func (f *Interface) reloadFirewall(c *config.C, r *config.Reload) {
|
||||
func (f *Interface) reloadFirewall(c *config.C) {
|
||||
cs := f.pki.getCertState()
|
||||
curCert := cs.getCertificate(cert.Version2)
|
||||
if curCert == nil {
|
||||
@@ -549,7 +537,6 @@ func (f *Interface) reloadFirewall(c *config.C, r *config.Reload) {
|
||||
fw, err := NewFirewallFromConfig(f.l, cs, c)
|
||||
if err != nil {
|
||||
f.l.Error("Error while creating firewall during reload", "error", err)
|
||||
r.Failed()
|
||||
return
|
||||
}
|
||||
|
||||
@@ -647,15 +634,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) statsEmitter() func() {
|
||||
func (f *Interface) emitStats(ctx context.Context, i time.Duration) {
|
||||
ticker := time.NewTicker(i)
|
||||
defer ticker.Stop()
|
||||
|
||||
udpStats := udp.NewUDPStatsEmitter(f.writers)
|
||||
|
||||
certExpirationGauge := metrics.GetOrRegisterGauge("certificate.ttl_seconds", nil)
|
||||
certInitiatingVersion := metrics.GetOrRegisterGauge("certificate.initiating_version", nil)
|
||||
certMaxVersion := metrics.GetOrRegisterGauge("certificate.max_version", nil)
|
||||
|
||||
return func() {
|
||||
emit := func() {
|
||||
f.firewall.EmitStats()
|
||||
f.handshakeManager.EmitStats()
|
||||
udpStats()
|
||||
@@ -672,6 +661,19 @@ func (f *Interface) statsEmitter() func() {
|
||||
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 {
|
||||
|
||||
+14
-5
@@ -3,6 +3,7 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net/netip"
|
||||
"testing"
|
||||
"time"
|
||||
@@ -17,8 +18,11 @@ import (
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// Priming before the first tick (issue #907) is Start's job, see TestStatsServer_Start_primes.
|
||||
func Test_statsEmitter_setsGauges(t *testing.T) {
|
||||
// Test_emitStats_primesGauges covers issue #907: a Prometheus scrape that
|
||||
// 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()
|
||||
|
||||
l := test.NewLogger()
|
||||
@@ -52,12 +56,17 @@ func Test_statsEmitter_setsGauges(t *testing.T) {
|
||||
ifce.pki.cs.Store(cs)
|
||||
|
||||
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()
|
||||
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.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())
|
||||
|
||||
@@ -0,0 +1,58 @@
|
||||
//go:build darwin || send_pipeline
|
||||
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"github.com/slackhq/nebula/firewall"
|
||||
"github.com/slackhq/nebula/overlay/batch"
|
||||
"github.com/slackhq/nebula/overlay/tio"
|
||||
"github.com/slackhq/nebula/udp"
|
||||
)
|
||||
|
||||
// sendPipelinePlatform lets listenIn take the pipelined send path. It is on for darwin, and for any platform built
|
||||
// with -tags send_pipeline so the pipeline's tests (and the e2e suite through it) run on linux too.
|
||||
const sendPipelinePlatform = true
|
||||
|
||||
// listenInPipelined is f.listenIn with the underlay writes moved to a sender goroutine (batch.SendPipeline). This
|
||||
// goroutine still reads the tun, runs the firewall and encrypts, straight into the pipeline's batch. The sender
|
||||
// writes whatever has built up each time its previous write returns, so under load the packets read while one
|
||||
// write is in the kernel leave together in the next one, and the next tun read overlaps the write.
|
||||
func listenInPipelined(f *Interface, queue tio.Queue, i int) {
|
||||
if f.pinThreads {
|
||||
f.pinThisThread(i)
|
||||
}
|
||||
|
||||
rejectBuf := make([]byte, mtu)
|
||||
arenaSize := batch.SendBatchCap * (udp.MTU + 32)
|
||||
onWrite := func(queued, written int, err error) {
|
||||
f.accountSendBatch(queued, written, err, i)
|
||||
}
|
||||
p := batch.NewSendPipeline(f.writers[i], batch.SendBatchCap, arenaSize, udp.MaxWriteBatch, onWrite)
|
||||
defer p.Close()
|
||||
fwPacket := &firewall.ParsedPacket{}
|
||||
nb := make([]byte, 12, 12)
|
||||
|
||||
conntrackCache := firewall.NewConntrackCacheTicker(f.ctx, f.l, f.conntrackCacheTimeout)
|
||||
|
||||
for {
|
||||
pkts, err := queue.Read()
|
||||
if err != nil {
|
||||
// Same shutdown noise handling as listenOut
|
||||
if !f.closed.Load() && f.ctx.Err() == nil {
|
||||
f.l.Error("Error while reading outbound packet, closing", "error", err, "reader", i)
|
||||
f.onFatal(err)
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
for j, pkt := range pkts {
|
||||
// One Begin/End per packet holds the batch only briefly, so a sender that finishes a write mid-read
|
||||
// takes what is ready then. An idle sender is woken once, at the end of the read, to take it whole.
|
||||
sb := p.Begin()
|
||||
f.consumeInsidePacket(pkt, fwPacket, nb, sb, rejectBuf, i, conntrackCache.Get())
|
||||
p.End(j == len(pkts)-1)
|
||||
}
|
||||
}
|
||||
|
||||
f.l.Debug("overlay reader is done", "reader", i)
|
||||
}
|
||||
@@ -0,0 +1,89 @@
|
||||
//go:build darwin || send_pipeline
|
||||
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"net/netip"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/overlay/tio"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/slackhq/nebula/udp"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"go.uber.org/goleak"
|
||||
)
|
||||
|
||||
// scriptedQueue hands out reads from a script, then fails every Read with err.
|
||||
type scriptedQueue struct {
|
||||
reads [][]tio.Packet
|
||||
err error
|
||||
}
|
||||
|
||||
func (q *scriptedQueue) Read() ([]tio.Packet, error) {
|
||||
if len(q.reads) == 0 {
|
||||
return nil, q.err
|
||||
}
|
||||
r := q.reads[0]
|
||||
q.reads = q.reads[1:]
|
||||
return r, nil
|
||||
}
|
||||
func (q *scriptedQueue) Write(b []byte) (int, error) { return len(b), nil }
|
||||
func (q *scriptedQueue) Close() error { return nil }
|
||||
|
||||
type countingConn struct {
|
||||
udp.NoopConn
|
||||
mu sync.Mutex
|
||||
batches int
|
||||
}
|
||||
|
||||
func (c *countingConn) WriteBatch(bufs [][]byte, _ []netip.AddrPort) (int, error) {
|
||||
c.mu.Lock()
|
||||
c.batches++
|
||||
c.mu.Unlock()
|
||||
return len(bufs), nil
|
||||
}
|
||||
|
||||
// TestListenInPipelinedStops pins that the pipelined reader returns when its queue fails, stopping its sender, and
|
||||
// reports the error as fatal only when the interface isn't shutting down.
|
||||
func TestListenInPipelinedStops(t *testing.T) {
|
||||
for _, closing := range []bool{false, true} {
|
||||
t.Run(map[bool]string{false: "fatal", true: "shutdown"}[closing], func(t *testing.T) {
|
||||
defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
|
||||
readErr := errors.New("tun gone")
|
||||
conn := &countingConn{}
|
||||
// Packets too short to parse are dropped before the firewall, so this reads without a hostmap.
|
||||
junk := tio.Packet{Bytes: []byte{0x45, 0}}
|
||||
q := &scriptedQueue{reads: [][]tio.Packet{{junk}, {junk, junk, junk}, {}}, err: readErr}
|
||||
shutdown := make(chan struct{})
|
||||
f := &Interface{
|
||||
ctx: context.Background(),
|
||||
l: test.NewLogger(),
|
||||
writers: []udp.Conn{conn},
|
||||
triggerShutdown: func() { close(shutdown) },
|
||||
}
|
||||
f.closed.Store(closing)
|
||||
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
f.listenIn(q, 0)
|
||||
close(done)
|
||||
}()
|
||||
select {
|
||||
case <-done:
|
||||
case <-time.After(5 * time.Second):
|
||||
t.Fatal("listenIn did not return after its queue failed")
|
||||
}
|
||||
if closing {
|
||||
assert.Nil(t, f.fatalErr.Load())
|
||||
} else {
|
||||
<-shutdown
|
||||
assert.Equal(t, readErr, *f.fatalErr.Load())
|
||||
}
|
||||
assert.Zero(t, conn.batches, "dropped packets must not be written")
|
||||
})
|
||||
}
|
||||
}
|
||||
+4
-26
@@ -65,10 +65,10 @@ func TestReloadFirewall_CertUnsafeNetworksChanged(t *testing.T) {
|
||||
pki.cs.Store(&CertState{v2Cert: c2, initiatingVersion: cert.Version2})
|
||||
|
||||
// Reload with the same YAML so HasChanged("firewall") reports false.
|
||||
require.NoError(t, cfg.ReloadConfigString(rawYAML).Err)
|
||||
require.NoError(t, cfg.ReloadConfigString(rawYAML))
|
||||
require.False(t, cfg.HasChanged("firewall"))
|
||||
|
||||
f.reloadFirewall(cfg, nil)
|
||||
f.reloadFirewall(cfg)
|
||||
|
||||
assert.NotSame(t, fw, f.firewall, "firewall pointer should have been replaced")
|
||||
assert.Equal(t, newUnsafe, f.firewall.unsafeNetworks)
|
||||
@@ -113,30 +113,8 @@ func TestReloadFirewall_NoChange(t *testing.T) {
|
||||
l: l,
|
||||
}
|
||||
|
||||
require.NoError(t, cfg.ReloadConfigString(rawYAML).Err)
|
||||
f.reloadFirewall(cfg, nil)
|
||||
require.NoError(t, cfg.ReloadConfigString(rawYAML))
|
||||
f.reloadFirewall(cfg)
|
||||
|
||||
assert.Same(t, fw, f.firewall, "firewall should not have been replaced")
|
||||
}
|
||||
|
||||
// Rules that don't parse keep the old firewall, and the reload says it could not apply them
|
||||
func TestReloadFirewall_BadRulesFailTheReload(t *testing.T) {
|
||||
l := test.NewLogger()
|
||||
pki := &PKI{}
|
||||
pki.cs.Store(&CertState{v2Cert: &dummyCert{version: cert.Version2, networks: []netip.Prefix{netip.MustParsePrefix("10.0.0.1/24")}}, initiatingVersion: cert.Version2})
|
||||
|
||||
rules := func(proto string) string {
|
||||
return "firewall:\n outbound:\n - port: any\n proto: any\n host: any\n inbound:\n - port: any\n proto: " + proto + "\n host: any\n"
|
||||
}
|
||||
cfg := config.NewC(l)
|
||||
require.NoError(t, cfg.LoadString(rules("any")))
|
||||
fw, err := NewFirewallFromConfig(l, pki.getCertState(), cfg)
|
||||
require.NoError(t, err)
|
||||
f := &Interface{pki: pki, firewall: fw, l: l}
|
||||
cfg.RegisterReloadCallback(f.reloadFirewall)
|
||||
|
||||
res := cfg.ReloadConfigString(rules("nope"))
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.Failed)
|
||||
assert.Same(t, fw, f.firewall)
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
// Package msgx calls xnu's private batched socket calls, sendmsg_x and recvmsg_x, which move many datagrams per
|
||||
// syscall. They are not public API, so a kernel or sandbox may refuse them; callers fall back to one datagram per
|
||||
// syscall when Unsupported reports that.
|
||||
package msgx
|
||||
|
||||
import (
|
||||
"syscall"
|
||||
"unsafe"
|
||||
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// Batch is the most messages the callers hand one sendmsg_x or recvmsg_x call.
|
||||
const Batch = 64
|
||||
|
||||
// Hdr mirrors xnu's struct msghdr_x (bsd/sys/socket_private.h), which the SDK doesn't ship. recvmsg_x reports each
|
||||
// message's length in Datalen rather than in its return value.
|
||||
type Hdr struct {
|
||||
Name *byte
|
||||
Namelen uint32
|
||||
Iov *unix.Iovec
|
||||
Iovlen int32
|
||||
Control *byte
|
||||
Controllen uint32
|
||||
Flags int32
|
||||
Datalen uint64
|
||||
}
|
||||
|
||||
// Send passes hdrs to sendmsg_x on fd and returns how many messages the kernel took. EINTR is retried.
|
||||
func Send(fd uintptr, hdrs []Hdr) (int, syscall.Errno) {
|
||||
return call(unix.SYS_SENDMSG_X, fd, hdrs)
|
||||
}
|
||||
|
||||
// Recv passes hdrs to recvmsg_x on fd and returns how many messages it filled. EINTR is retried.
|
||||
func Recv(fd uintptr, hdrs []Hdr) (int, syscall.Errno) {
|
||||
return call(unix.SYS_RECVMSG_X, fd, hdrs)
|
||||
}
|
||||
|
||||
func call(trap, fd uintptr, hdrs []Hdr) (int, syscall.Errno) {
|
||||
if len(hdrs) == 0 {
|
||||
return 0, syscall.EINVAL
|
||||
}
|
||||
for {
|
||||
r, _, errno := unix.Syscall6(trap, fd, uintptr(unsafe.Pointer(&hdrs[0])), uintptr(len(hdrs)), 0, 0, 0)
|
||||
switch errno {
|
||||
case 0:
|
||||
return int(r), 0
|
||||
case syscall.EINTR:
|
||||
default:
|
||||
return 0, errno
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Unsupported reports whether errno means the kernel or a sandbox refuses the private calls.
|
||||
func Unsupported(errno syscall.Errno) bool {
|
||||
return errno == syscall.ENOSYS || errno == syscall.EPERM || errno == syscall.EOPNOTSUPP
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
package msgx
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"syscall"
|
||||
"testing"
|
||||
"unsafe"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// TestHdrLayout pins Hdr to struct msghdr_x's LP64 layout: 56 bytes, Datalen last at 48.
|
||||
func TestHdrLayout(t *testing.T) {
|
||||
var h Hdr
|
||||
assert.EqualValues(t, 56, unsafe.Sizeof(h))
|
||||
assert.EqualValues(t, 48, unsafe.Offsetof(h.Datalen))
|
||||
}
|
||||
|
||||
// TestSendRecvRoundTrip sends a batch through sendmsg_x in one call and reads it back through recvmsg_x in one
|
||||
// call, each message whole, in order, with Datalen set.
|
||||
func TestSendRecvRoundTrip(t *testing.T) {
|
||||
fds, err := unix.Socketpair(unix.AF_UNIX, unix.SOCK_DGRAM, 0)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() {
|
||||
_ = unix.Close(fds[0])
|
||||
_ = unix.Close(fds[1])
|
||||
})
|
||||
// A dropped datagram fails the receive instead of hanging it.
|
||||
require.NoError(t, unix.SetsockoptTimeval(fds[1], unix.SOL_SOCKET, unix.SO_RCVTIMEO, &unix.Timeval{Sec: 2}))
|
||||
|
||||
const n = 5
|
||||
var want [n][]byte
|
||||
var iovs [n]unix.Iovec
|
||||
hdrs := make([]Hdr, n)
|
||||
for i := range n {
|
||||
want[i] = bytes.Repeat([]byte{byte(i + 1)}, 10+i)
|
||||
iovs[i] = unix.Iovec{Base: &want[i][0]}
|
||||
iovs[i].SetLen(len(want[i]))
|
||||
hdrs[i] = Hdr{Iov: &iovs[i], Iovlen: 1}
|
||||
}
|
||||
sent, errno := Send(uintptr(fds[0]), hdrs)
|
||||
require.Zero(t, errno)
|
||||
require.Equal(t, n, sent)
|
||||
|
||||
var bufs [n + 1][64]byte
|
||||
var riovs [n + 1]unix.Iovec
|
||||
rhdrs := make([]Hdr, n+1)
|
||||
for i := range rhdrs {
|
||||
riovs[i] = unix.Iovec{Base: &bufs[i][0]}
|
||||
riovs[i].SetLen(len(bufs[i]))
|
||||
rhdrs[i] = Hdr{Iov: &riovs[i], Iovlen: 1}
|
||||
}
|
||||
got, errno := Recv(uintptr(fds[1]), rhdrs)
|
||||
require.Zero(t, errno)
|
||||
require.Equal(t, n, got)
|
||||
for i := range n {
|
||||
l := int(rhdrs[i].Datalen)
|
||||
assert.Equal(t, want[i], bufs[i][:l], "message %d", i)
|
||||
}
|
||||
}
|
||||
|
||||
// TestEmptyBatch pins that an empty batch is refused before it reaches the kernel.
|
||||
func TestEmptyBatch(t *testing.T) {
|
||||
_, errno := Send(0, nil)
|
||||
assert.Equal(t, syscall.EINVAL, errno)
|
||||
_, errno = Recv(0, nil)
|
||||
assert.Equal(t, syscall.EINVAL, errno)
|
||||
}
|
||||
|
||||
func TestUnsupported(t *testing.T) {
|
||||
for _, e := range []syscall.Errno{syscall.ENOSYS, syscall.EPERM, syscall.EOPNOTSUPP} {
|
||||
assert.True(t, Unsupported(e), "%v", e)
|
||||
}
|
||||
for _, e := range []syscall.Errno{0, syscall.EAGAIN, syscall.ENOBUFS, syscall.EINVAL} {
|
||||
assert.False(t, Unsupported(e), "%v", e)
|
||||
}
|
||||
}
|
||||
+9
-38
@@ -15,7 +15,6 @@ import (
|
||||
"time"
|
||||
|
||||
"github.com/gaissmai/bart"
|
||||
"github.com/rcrowley/go-metrics"
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/header"
|
||||
@@ -82,8 +81,6 @@ type LightHouse struct {
|
||||
|
||||
updateTrigger chan struct{}
|
||||
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
|
||||
|
||||
@@ -119,8 +116,7 @@ func NewLightHouseFromConfig(ctx context.Context, l *slog.Logger, c *config.C, c
|
||||
nebulaPort: nebulaPort,
|
||||
punchy: p,
|
||||
updateTrigger: make(chan struct{}, 1),
|
||||
queryChan: make(chan netip.Addr, c.GetUint32("handshakes.query_buffer", 1024)),
|
||||
queryDropped: metrics.GetOrRegisterCounter("lighthouse.query.dropped", nil),
|
||||
queryChan: make(chan netip.Addr, c.GetUint32("handshakes.query_buffer", 64)),
|
||||
l: l,
|
||||
}
|
||||
h.localAddrsFn = func(al *LocalAllowList) []netip.Addr {
|
||||
@@ -138,21 +134,18 @@ func NewLightHouseFromConfig(ctx context.Context, l *slog.Logger, c *config.C, c
|
||||
h.metrics = newLighthouseMetrics()
|
||||
}
|
||||
|
||||
err := h.reload(c, true, nil)
|
||||
err := h.reload(c, true)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("lighthouse.am_lighthouse", "listen.port", "handshakes.query_buffer", "stats.lighthouse_metrics")
|
||||
err := h.reload(c, false, r)
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
err := h.reload(c, false)
|
||||
switch v := err.(type) {
|
||||
case *util.ContextualError:
|
||||
v.Log(l)
|
||||
r.Failed()
|
||||
case error:
|
||||
l.Error("failed to reload lighthouse", "error", err)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
@@ -193,8 +186,7 @@ func (lh *LightHouse) GetUpdateInterval() int64 {
|
||||
return lh.interval.Load()
|
||||
}
|
||||
|
||||
// r is nil on the initial load
|
||||
func (lh *LightHouse) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
func (lh *LightHouse) reload(c *config.C, initial bool) error {
|
||||
if initial || c.HasChanged("lighthouse.advertise_addrs") {
|
||||
rawAdvAddrs := c.GetStringSlice("lighthouse.advertise_addrs", []string{})
|
||||
advAddrs := make([]netip.AddrPort, 0)
|
||||
@@ -229,7 +221,6 @@ func (lh *LightHouse) reload(c *config.C, initial bool, r *config.Reload) error
|
||||
"addr", rawAddr,
|
||||
"entry", i+1,
|
||||
)
|
||||
r.Failed()
|
||||
continue
|
||||
}
|
||||
|
||||
@@ -364,13 +355,7 @@ func (lh *LightHouse) reload(c *config.C, initial bool, r *config.Reload) error
|
||||
}
|
||||
}
|
||||
|
||||
// am_relay decides whether relay.relays applies to us at all
|
||||
if initial || c.HasChanged("relay.relays") || c.HasChanged("relay.am_relay") {
|
||||
var before []netip.Addr
|
||||
if !initial {
|
||||
before = lh.GetRelaysForMe()
|
||||
}
|
||||
|
||||
if initial || c.HasChanged("relay.relays") {
|
||||
switch c.GetBool("relay.am_relay", false) {
|
||||
case true:
|
||||
// Relays aren't allowed to specify other relays
|
||||
@@ -388,7 +373,6 @@ func (lh *LightHouse) reload(c *config.C, initial bool, r *config.Reload) error
|
||||
"relay", v,
|
||||
"error", err,
|
||||
)
|
||||
r.Failed()
|
||||
} else {
|
||||
lh.l.Info("Read relay from config", "relay", v)
|
||||
relaysForMe = append(relaysForMe, configRIP)
|
||||
@@ -396,11 +380,6 @@ func (lh *LightHouse) reload(c *config.C, initial bool, r *config.Reload) error
|
||||
}
|
||||
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
|
||||
@@ -533,19 +512,14 @@ func (lh *LightHouse) Query(vpnAddr netip.Addr) *RemoteList {
|
||||
return nil
|
||||
}
|
||||
|
||||
// QueryServer is asynchronous and non-blocking, no reply should be expected.
|
||||
// If the query channel is full, the query is dropped.
|
||||
// QueryServer is asynchronous so no reply should be expected
|
||||
func (lh *LightHouse) QueryServer(vpnAddr netip.Addr) {
|
||||
// Don't put lighthouse addrs in the query channel because we can't query lighthouses about lighthouses
|
||||
if lh.amLighthouse || lh.IsLighthouseAddr(vpnAddr) {
|
||||
return
|
||||
}
|
||||
|
||||
select {
|
||||
case lh.queryChan <- vpnAddr:
|
||||
default:
|
||||
lh.queryDropped.Inc(1)
|
||||
}
|
||||
lh.queryChan <- vpnAddr
|
||||
}
|
||||
|
||||
func (lh *LightHouse) QueryCache(vpnAddrs []netip.Addr) *RemoteList {
|
||||
@@ -1261,13 +1235,10 @@ func (lhh *LightHouseHandler) handleHostQuery(n *NebulaMeta, fromVpnAddrs []neti
|
||||
// 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) {
|
||||
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) {
|
||||
n = lhh.resetMeta()
|
||||
n.Type = NebulaMeta_HostPunchNotification
|
||||
targetHI := lhh.lh.ifce.GetHostInfo(punchNotifDest)
|
||||
var useVersion cert.Version
|
||||
if targetHI == nil {
|
||||
useVersion = lhh.lh.ifce.GetCertState().initiatingVersion
|
||||
|
||||
+10
-257
@@ -6,16 +6,13 @@ import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/netip"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gaissmai/bart"
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/header"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/slackhq/nebula/udp"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"go.yaml.in/yaml/v3"
|
||||
@@ -87,15 +84,15 @@ func TestReloadLighthouseInterval(t *testing.T) {
|
||||
lh.ifce = &mockEncWriter{}
|
||||
|
||||
// The first one routine is kicked off by main.go currently, lets make sure that one dies
|
||||
require.NoError(t, c.ReloadConfigString("lighthouse:\n interval: 5").Err)
|
||||
require.NoError(t, c.ReloadConfigString("lighthouse:\n interval: 5"))
|
||||
assert.Equal(t, int64(5), lh.interval.Load())
|
||||
|
||||
// Subsequent calls are killed off by the LightHouse.Reload function
|
||||
require.NoError(t, c.ReloadConfigString("lighthouse:\n interval: 10").Err)
|
||||
require.NoError(t, c.ReloadConfigString("lighthouse:\n interval: 10"))
|
||||
assert.Equal(t, int64(10), lh.interval.Load())
|
||||
|
||||
// If this completes then nothing is stealing our reload routine
|
||||
require.NoError(t, c.ReloadConfigString("lighthouse:\n interval: 11").Err)
|
||||
require.NoError(t, c.ReloadConfigString("lighthouse:\n interval: 11"))
|
||||
assert.Equal(t, int64(11), lh.interval.Load())
|
||||
}
|
||||
|
||||
@@ -296,7 +293,7 @@ func TestLighthouse_reload(t *testing.T) {
|
||||
require.NoError(t, err)
|
||||
c.ReloadConfigString(string(rc))
|
||||
|
||||
err = lh.reload(c, false, nil)
|
||||
err = lh.reload(c, false)
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
@@ -334,7 +331,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
||||
}
|
||||
rc, err := yaml.Marshal(nc)
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
||||
require.NoError(t, c.ReloadConfigString(string(rc)))
|
||||
|
||||
rl := lh.Query(staticHost)
|
||||
require.NotNil(t, rl)
|
||||
@@ -350,7 +347,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
||||
}
|
||||
rc, err = yaml.Marshal(nc)
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
||||
require.NoError(t, c.ReloadConfigString(string(rc)))
|
||||
|
||||
rl = lh.Query(staticHost)
|
||||
require.NotNil(t, rl)
|
||||
@@ -358,7 +355,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
||||
assert.Equal(t, []netip.AddrPort{netip.MustParseAddrPort("1.1.1.1:4242")}, rl.CopyAddrs([]netip.Prefix{}))
|
||||
|
||||
// Reload with the same config. An unchanged entry must not duplicate.
|
||||
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
||||
require.NoError(t, c.ReloadConfigString(string(rc)))
|
||||
|
||||
rl = lh.Query(staticHost)
|
||||
require.NotNil(t, rl)
|
||||
@@ -373,7 +370,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
||||
}
|
||||
rc, err = yaml.Marshal(nc)
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
||||
require.NoError(t, c.ReloadConfigString(string(rc)))
|
||||
|
||||
// Add a second host alongside the first. Both should be present, neither duplicated.
|
||||
nc = map[string]any{
|
||||
@@ -384,7 +381,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
||||
}
|
||||
rc, err = yaml.Marshal(nc)
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
||||
require.NoError(t, c.ReloadConfigString(string(rc)))
|
||||
|
||||
rl = lh.Query(staticHost)
|
||||
require.NotNil(t, rl)
|
||||
@@ -406,7 +403,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
||||
}
|
||||
rc, err = yaml.Marshal(nc)
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
||||
require.NoError(t, c.ReloadConfigString(string(rc)))
|
||||
|
||||
_, isStatic := lh.GetStaticHostList()[staticHost]
|
||||
assert.False(t, isStatic)
|
||||
@@ -798,247 +795,3 @@ func TestLightHouse_logLocalAddrsErr(t *testing.T) {
|
||||
lh.logLocalAddrsErr(errors.New("something else"))
|
||||
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").Err)
|
||||
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").Err)
|
||||
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").Err)
|
||||
assert.Empty(t, lh.GetRelaysForMe())
|
||||
require.Len(t, lh.updateTrigger, 1)
|
||||
<-lh.updateTrigger
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(base+" am_relay: false\n").Err)
|
||||
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.5")}, lh.GetRelaysForMe())
|
||||
require.Len(t, lh.updateTrigger, 1)
|
||||
}
|
||||
|
||||
func TestLighthouse_reloadRestartRequired(t *testing.T) {
|
||||
l := test.NewLogger()
|
||||
c := config.NewC(l)
|
||||
base := "lighthouse:\n am_lighthouse: true\n"
|
||||
require.NoError(t, c.LoadString(base+"listen:\n port: 4242\n"))
|
||||
|
||||
_, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(netip.MustParsePrefix("10.128.0.1/24")), nil, nil)
|
||||
require.NoError(t, err)
|
||||
|
||||
res := c.ReloadConfigString(base + "listen:\n port: 4242\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.False(t, res.RestartRequired)
|
||||
res = c.ReloadConfigString(base + "listen:\n port: 4243\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.RestartRequired)
|
||||
}
|
||||
|
||||
// A relay that doesn't parse is skipped and the rest are used, the reload says one was skipped
|
||||
func TestLighthouse_reloadBadRelayFails(t *testing.T) {
|
||||
l := test.NewLogger()
|
||||
c := config.NewC(l)
|
||||
require.NoError(t, c.LoadString("listen:\n port: 4242\n"))
|
||||
lh, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(netip.MustParsePrefix("10.128.0.1/24")), nil, nil)
|
||||
require.NoError(t, err)
|
||||
|
||||
res := c.ReloadConfigString("listen:\n port: 4242\nrelay:\n relays: [10.128.0.2, nope]\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.Failed)
|
||||
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.2")}, lh.GetRelaysForMe())
|
||||
}
|
||||
|
||||
// An advertise_addrs entry inside our own network is skipped and the rest are used, the reload says one was skipped
|
||||
func TestLighthouse_reloadAdvertiseAddrInNetworkFails(t *testing.T) {
|
||||
l := test.NewLogger()
|
||||
c := config.NewC(l)
|
||||
require.NoError(t, c.LoadString("listen:\n port: 4242\n"))
|
||||
lh, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(netip.MustParsePrefix("10.128.0.1/24")), nil, nil)
|
||||
require.NoError(t, err)
|
||||
|
||||
res := c.ReloadConfigString("listen:\n port: 4242\nlighthouse:\n advertise_addrs: [\"1.2.3.4:4242\", \"10.128.0.5:4242\"]\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.Failed)
|
||||
assert.Equal(t, []netip.AddrPort{netip.MustParseAddrPort("1.2.3.4:4242")}, lh.GetAdvertiseAddrs())
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -78,7 +78,7 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
||||
wireSSHReload(l, ssh, c)
|
||||
var sshStart func()
|
||||
if c.GetBool("sshd.enabled", false) {
|
||||
sshStart, err = configSSH(l, ssh, c, nil)
|
||||
sshStart, err = configSSH(l, ssh, c)
|
||||
if err != nil {
|
||||
l.Warn("Failed to configure sshd, ssh debugging will not be available", "error", err)
|
||||
sshStart = nil
|
||||
@@ -197,7 +197,7 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
||||
if err != nil {
|
||||
return nil, util.NewContextualError("Failed to open udp listener", m{"queue": i}, err)
|
||||
}
|
||||
udpServer.ReloadConfig(c, nil)
|
||||
udpServer.ReloadConfig(c)
|
||||
udpConns[i] = udpServer
|
||||
|
||||
// If port is dynamic, discover it before the next pass through the for loop
|
||||
@@ -213,6 +213,7 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
||||
}
|
||||
|
||||
hostMap := NewHostMapFromConfig(l, c)
|
||||
hostMap.established = newEstablishedRemotes(udpConns)
|
||||
punchy := NewPunchyFromConfig(l, c, udpConns[0])
|
||||
connManager := newConnectionManagerFromConfig(l, c, hostMap, punchy)
|
||||
lightHouse, err := NewLightHouseFromConfig(ctx, l, c, pki.getCertState(), udpConns[0], punchy)
|
||||
@@ -300,7 +301,6 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
||||
}
|
||||
|
||||
var ifce *Interface
|
||||
var emitStats func()
|
||||
if !configTest {
|
||||
ifce, err = NewInterface(ctx, ifConfig)
|
||||
if err != nil {
|
||||
@@ -311,16 +311,6 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
||||
lightHouse.ifce = ifce
|
||||
|
||||
ifce.RegisterConfigChangeCallbacks(c)
|
||||
// These are only read at startup
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged(
|
||||
"routines", "tun.routines", "listen.routines", "firewall.conntrack.routine_cache_timeout",
|
||||
"listen.port", "listen.host", "stats.message_metrics",
|
||||
"handshakes.try_interval", "handshakes.retries", "handshakes.trigger_buffer",
|
||||
"tun.drop_local_broadcast", "tun.drop_multicast",
|
||||
)
|
||||
r.RestartRequiredIfChanged(osStartupOnlyKeys...)
|
||||
})
|
||||
ifce.reloadDisconnectInvalid(c)
|
||||
ifce.reloadSendRecvError(c)
|
||||
ifce.reloadAcceptRecvError(c)
|
||||
@@ -329,12 +319,9 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
||||
go handshakeManager.Run(ctx)
|
||||
|
||||
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 {
|
||||
return nil, util.ContextualizeIfNeeded("Failed to start stats emitter", err)
|
||||
}
|
||||
@@ -343,6 +330,8 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
go ifce.emitStats(ctx, c.GetDuration("stats.interval", time.Second*10))
|
||||
|
||||
attachCommands(l, c, ssh, ifce)
|
||||
|
||||
networkChanges := udp.NewNetworkChangeMonitor(ctx, l, c)
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
//go:build linux && !android && !e2e_testing
|
||||
|
||||
package nebula
|
||||
|
||||
// osStartupOnlyKeys are startup only keys that only matter on linux: udp batch size, udp offloads and thread pinning
|
||||
var osStartupOnlyKeys = []string{"listen.batch", "listen.udp_offloads", "tun.pin_threads", "tun.pin_threads_key", "tun.cpu_affinity"}
|
||||
@@ -1,6 +0,0 @@
|
||||
//go:build !linux || android || e2e_testing
|
||||
|
||||
package nebula
|
||||
|
||||
// osStartupOnlyKeys is empty, none of the OS specific startup keys matter here
|
||||
var osStartupOnlyKeys []string
|
||||
+7
-12
@@ -160,7 +160,9 @@ func (f *Interface) readOutsidePackets(via ViaSender, packet []byte, rxc *rxCont
|
||||
case header.TestReply:
|
||||
// No-op, useful for the Roaming and connectionManager side-effects above
|
||||
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.
|
||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||
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
|
||||
func (f *Interface) closeTunnel(hostInfo *HostInfo) {
|
||||
// Hold the hostmap lock across both the delete and the lighthouse eviction,
|
||||
// to avoid a race with handshake completion.
|
||||
f.hostMap.Lock()
|
||||
defer f.hostMap.Unlock()
|
||||
if !f.hostMap.unlockedDeleteHostInfo(hostInfo) {
|
||||
return
|
||||
}
|
||||
|
||||
final := f.hostMap.DeleteHostInfo(hostInfo)
|
||||
if final {
|
||||
// We no longer have any tunnels with this vpn addr, clear learned lighthouse state to lower memory usage
|
||||
f.lightHouse.DeleteVpnAddrs(hostInfo.vpnAddrs)
|
||||
}
|
||||
}
|
||||
|
||||
// sendCloseTunnel is a helper function to send a proper close tunnel packet to a remote
|
||||
func (f *Interface) sendCloseTunnel(h *HostInfo) {
|
||||
@@ -476,11 +473,9 @@ func parseV4(data []byte, incoming bool, fp *firewall.ParsedPacket) error {
|
||||
func (f *Interface) handleOutsideMessagePacket(hostinfo *HostInfo, messageCounter uint64, out []byte, rxc *rxContext) {
|
||||
err := newPacket(out, true, rxc.fwPacket)
|
||||
if err != nil {
|
||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||
hostinfo.logger(f.l).Debug("Error while validating inbound packet", "error", err, "packet", out)
|
||||
hostinfo.logger(f.l).Warn("Error while validating inbound packet", "error", err, "packet", out)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
dropReason := f.firewall.Drop(rxc.fwPacket.Packet, true, hostinfo, f.pki.GetCAPool(), rxc.ctCache.Get())
|
||||
if dropReason != nil {
|
||||
|
||||
@@ -435,3 +435,65 @@ func testPP(pkt []byte) *firewall.ParsedPacket {
|
||||
}
|
||||
return pp
|
||||
}
|
||||
|
||||
// fakeTunBatchWriter records each WriteBatch call and each plain Write separately.
|
||||
type fakeTunBatchWriter struct {
|
||||
writes [][]byte
|
||||
batches [][][]byte
|
||||
}
|
||||
|
||||
func (w *fakeTunBatchWriter) Write(p []byte) (int, error) {
|
||||
w.writes = append(w.writes, bytes.Clone(p))
|
||||
return len(p), nil
|
||||
}
|
||||
|
||||
func (w *fakeTunBatchWriter) WriteBatch(pkts [][]byte) error {
|
||||
var b [][]byte
|
||||
for _, p := range pkts {
|
||||
b = append(b, bytes.Clone(p))
|
||||
}
|
||||
w.batches = append(w.batches, b)
|
||||
return nil
|
||||
}
|
||||
|
||||
// TestPassthroughUsesWriteBatch pins that a writer implementing tio.BatchWriter gets the whole
|
||||
// passthrough lane in one WriteBatch per Flush, in order, and no plain Writes; an empty Flush
|
||||
// makes no call.
|
||||
func TestPassthroughUsesWriteBatch(t *testing.T) {
|
||||
w := &fakeTunBatchWriter{}
|
||||
m := newTestMultiCoalescer(t, w)
|
||||
k := &keySeq{epoch: 1}
|
||||
|
||||
var want [][]byte
|
||||
for i := range 5 {
|
||||
icmp := make([]byte, 28)
|
||||
icmp[0] = 0x45
|
||||
icmp[3] = 28
|
||||
icmp[9] = 1
|
||||
icmp[20] = byte(i)
|
||||
want = append(want, icmp)
|
||||
if err := m.Commit(icmp, k.next(), testPP(icmp)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
if err := m.Flush(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := m.Flush(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if len(w.writes) != 0 {
|
||||
t.Fatalf("got %d plain Writes, want 0", len(w.writes))
|
||||
}
|
||||
if len(w.batches) != 1 {
|
||||
t.Fatalf("got %d WriteBatch calls, want 1", len(w.batches))
|
||||
}
|
||||
for i, p := range w.batches[0] {
|
||||
if !bytes.Equal(p, want[i]) {
|
||||
t.Fatalf("packet %d: got % x, want % x", i, p, want[i])
|
||||
}
|
||||
}
|
||||
if len(w.batches[0]) != len(want) {
|
||||
t.Fatalf("got %d packets, want %d", len(w.batches[0]), len(want))
|
||||
}
|
||||
}
|
||||
@@ -2,18 +2,23 @@ package batch
|
||||
|
||||
import (
|
||||
"io"
|
||||
|
||||
"github.com/slackhq/nebula/overlay/tio"
|
||||
)
|
||||
|
||||
// Passthrough is MultiCoalescer's verbatim lane: no batching, packets are written at Flush in the
|
||||
// order enqueued.
|
||||
// Passthrough is MultiCoalescer's verbatim lane: no coalescing, packets are written at Flush in the
|
||||
// order enqueued, in one WriteBatch when out implements tio.BatchWriter.
|
||||
type Passthrough struct {
|
||||
out io.Writer
|
||||
bw tio.BatchWriter // nil: Flush writes one packet per Write
|
||||
slots [][]byte
|
||||
}
|
||||
|
||||
func NewPassthrough(w io.Writer) *Passthrough {
|
||||
bw, _ := w.(tio.BatchWriter)
|
||||
return &Passthrough{
|
||||
out: w,
|
||||
bw: bw,
|
||||
slots: make([][]byte, 0, 128),
|
||||
}
|
||||
}
|
||||
@@ -26,12 +31,18 @@ func (p *Passthrough) enqueue(pkt []byte) error {
|
||||
|
||||
func (p *Passthrough) Flush() error {
|
||||
var firstErr error
|
||||
if p.bw != nil {
|
||||
if len(p.slots) > 0 {
|
||||
firstErr = p.bw.WriteBatch(p.slots)
|
||||
}
|
||||
} else {
|
||||
for _, s := range p.slots {
|
||||
_, err := p.out.Write(s)
|
||||
if err != nil && firstErr == nil {
|
||||
firstErr = err
|
||||
}
|
||||
}
|
||||
}
|
||||
clear(p.slots)
|
||||
p.slots = p.slots[:0]
|
||||
return firstErr
|
||||
|
||||
@@ -0,0 +1,156 @@
|
||||
//go:build darwin || send_pipeline
|
||||
|
||||
package batch
|
||||
|
||||
import (
|
||||
"sync"
|
||||
)
|
||||
|
||||
// SendPipeline splits encrypt from send. The producer (a tun reader) encrypts packets into one SendBatch while a
|
||||
// sender goroutine writes the other, and they swap whenever the sender is free. The sender takes everything the
|
||||
// producer committed since its last take, so packets that arrive during a write leave together in the next
|
||||
// WriteBatch, and the reader returns to the tun while the kernel is still sending.
|
||||
//
|
||||
// The producer holds the batch for one packet at a time (Begin, reserve and commit, End) so the sender can take the
|
||||
// batch between any two packets, never while a reserved slot is still being written.
|
||||
//
|
||||
// Ownership: the producer touches its batch only between Begin and End, and the sender swaps batches only under
|
||||
// the same lock, so a slot the producer reserved is never sent half written. A batch goes back to the producer
|
||||
// only after its WriteBatch returned and it was emptied, so no slot is reused before its send completes.
|
||||
//
|
||||
// Memory is bounded at two batches. When the producer fills its batch while the sender is still writing the other,
|
||||
// Begin waits for the swap. That slows the tun reader instead of dropping, as the unpipelined path does.
|
||||
//
|
||||
// Order: a single sender writes batches in the order they were filled, each in commit order, so every peer's
|
||||
// packets leave in the order their message counters were taken.
|
||||
type SendPipeline struct {
|
||||
out batchWriter
|
||||
cap int
|
||||
maxWrite int
|
||||
onWrite func(queued, written int, err error)
|
||||
|
||||
mu sync.Mutex
|
||||
cond sync.Cond
|
||||
cur *SendBatch // the producer's batch, guarded by mu
|
||||
gen uint64 // swaps so far, guarded by mu
|
||||
|
||||
ready chan struct{} // cap 1: cur may have packets for the sender
|
||||
stop chan struct{}
|
||||
done chan struct{}
|
||||
once sync.Once
|
||||
}
|
||||
|
||||
// NewSendPipeline starts a pipeline over two batches of batchCap slots and arenaSize arena bytes each. It writes
|
||||
// to out at most maxWrite packets per WriteBatch. If onWrite is not nil, it is called on the sender goroutine
|
||||
// after every WriteBatch with how many packets that call was given, how many went out, and its error. Close stops
|
||||
// the pipeline.
|
||||
func NewSendPipeline(out batchWriter, batchCap, arenaSize, maxWrite int, onWrite func(queued, written int, err error)) *SendPipeline {
|
||||
batchCap = max(batchCap, 1)
|
||||
p := &SendPipeline{
|
||||
out: out,
|
||||
cap: batchCap,
|
||||
maxWrite: max(maxWrite, 1),
|
||||
onWrite: onWrite,
|
||||
cur: NewSendBatch(out, batchCap, arenaSize),
|
||||
ready: make(chan struct{}, 1),
|
||||
stop: make(chan struct{}),
|
||||
done: make(chan struct{}),
|
||||
}
|
||||
p.cond.L = &p.mu
|
||||
go p.run(NewSendBatch(out, batchCap, arenaSize))
|
||||
return p
|
||||
}
|
||||
|
||||
// Begin returns a batch with room for at least one more packet. The batch stays the producer's until End. If the
|
||||
// batch is full, Begin first waits for the sender to swap it out. Producer only.
|
||||
func (p *SendPipeline) Begin() *SendBatch {
|
||||
p.mu.Lock()
|
||||
if p.cur.Len() >= p.cap {
|
||||
g := p.gen
|
||||
p.wake()
|
||||
for p.gen == g {
|
||||
p.cond.Wait()
|
||||
}
|
||||
}
|
||||
return p.cur
|
||||
}
|
||||
|
||||
// End gives up the batch Begin returned. With wake set it also tells the sender the batch has packets for it, which
|
||||
// the producer does once a run of packets is in (the end of a tun read) rather than per packet, so the sender takes
|
||||
// the run whole when it is idle. A sender still writing takes the batch when it finishes, woken or not.
|
||||
func (p *SendPipeline) End(wake bool) {
|
||||
n := p.cur.Len()
|
||||
p.mu.Unlock()
|
||||
if wake && n > 0 {
|
||||
p.wake()
|
||||
}
|
||||
}
|
||||
|
||||
func (p *SendPipeline) wake() {
|
||||
select {
|
||||
case p.ready <- struct{}{}:
|
||||
default:
|
||||
}
|
||||
}
|
||||
|
||||
// Close writes whatever the producer left in its batch, stops the sender, and waits for it. The producer calls it,
|
||||
// outside Begin/End, once it is done. Safe to call more than once.
|
||||
func (p *SendPipeline) Close() {
|
||||
p.once.Do(func() { close(p.stop) })
|
||||
<-p.done
|
||||
}
|
||||
|
||||
func (p *SendPipeline) run(mine *SendBatch) {
|
||||
defer close(p.done)
|
||||
for {
|
||||
stopping := false
|
||||
select {
|
||||
case <-p.ready:
|
||||
case <-p.stop:
|
||||
stopping = true
|
||||
}
|
||||
// Keep taking whatever the producer committed during the last write, without waiting to be woken, so a
|
||||
// busy sender goes straight from one write to the next and each write carries everything that built up.
|
||||
// Once stopping, the producer is done and this writes what it left.
|
||||
for p.take(&mine) {
|
||||
p.write(mine)
|
||||
}
|
||||
if stopping {
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// take swaps the producer's batch for the empty *mine if the producer's has packets, and reports whether it did.
|
||||
func (p *SendPipeline) take(mine **SendBatch) bool {
|
||||
p.mu.Lock()
|
||||
defer p.mu.Unlock()
|
||||
if p.cur.Len() == 0 {
|
||||
return false
|
||||
}
|
||||
*mine, p.cur = p.cur, *mine
|
||||
p.gen++
|
||||
p.cond.Broadcast()
|
||||
return true
|
||||
}
|
||||
|
||||
// write sends b's packets, maxWrite at a time, then empties b.
|
||||
func (p *SendPipeline) write(b *SendBatch) {
|
||||
for off := 0; off < len(b.bufs); {
|
||||
n := min(p.maxWrite, len(b.bufs)-off)
|
||||
written, err := p.out.WriteBatch(b.bufs[off:off+n], b.dsts[off:off+n])
|
||||
if p.onWrite != nil {
|
||||
p.onWrite(n, written, err)
|
||||
}
|
||||
off += n
|
||||
}
|
||||
b.recycle()
|
||||
}
|
||||
|
||||
// recycle empties b without writing it. SendPipeline uses it because it writes a batch's packets itself.
|
||||
func (b *SendBatch) recycle() {
|
||||
clear(b.bufs)
|
||||
b.bufs = b.bufs[:0]
|
||||
b.dsts = b.dsts[:0]
|
||||
b.arena.Reset()
|
||||
}
|
||||
@@ -0,0 +1,400 @@
|
||||
//go:build darwin || send_pipeline
|
||||
|
||||
package batch
|
||||
|
||||
import (
|
||||
"encoding/binary"
|
||||
"errors"
|
||||
"net/netip"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
"unsafe"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"go.uber.org/goleak"
|
||||
)
|
||||
|
||||
// pipeWriter records every WriteBatch a SendPipeline makes. It checks each packet's bytes against the sequence
|
||||
// number they carry while the call is in progress, and can hold a call until the test releases it.
|
||||
type pipeWriter struct {
|
||||
t *testing.T
|
||||
|
||||
mu sync.Mutex
|
||||
seqs []uint32
|
||||
dsts []netip.AddrPort
|
||||
calls []int
|
||||
inCall [][]byte // the bufs of the call in progress, for overlap checks
|
||||
|
||||
gate chan struct{} // if not nil, each call waits for a receive from it
|
||||
entered chan int // if not nil, each call sends its size here on entry
|
||||
short int // each call reports this many fewer written
|
||||
err error
|
||||
}
|
||||
|
||||
func (w *pipeWriter) WriteBatch(bufs [][]byte, addrs []netip.AddrPort) (int, error) {
|
||||
w.mu.Lock()
|
||||
w.inCall = bufs
|
||||
w.mu.Unlock()
|
||||
if w.entered != nil {
|
||||
w.entered <- len(bufs)
|
||||
}
|
||||
if w.gate != nil {
|
||||
<-w.gate
|
||||
}
|
||||
w.mu.Lock()
|
||||
defer w.mu.Unlock()
|
||||
for i, b := range bufs {
|
||||
seq := binary.BigEndian.Uint32(b)
|
||||
if !checkPkt(b, seq) {
|
||||
w.t.Errorf("packet %d changed while being sent", seq)
|
||||
}
|
||||
w.seqs = append(w.seqs, seq)
|
||||
w.dsts = append(w.dsts, addrs[i])
|
||||
}
|
||||
w.calls = append(w.calls, len(bufs))
|
||||
w.inCall = nil
|
||||
return max(len(bufs)-w.short, 0), w.err
|
||||
}
|
||||
|
||||
func (w *pipeWriter) sent() ([]uint32, []netip.AddrPort, []int) {
|
||||
w.mu.Lock()
|
||||
defer w.mu.Unlock()
|
||||
return append([]uint32(nil), w.seqs...), append([]netip.AddrPort(nil), w.dsts...), append([]int(nil), w.calls...)
|
||||
}
|
||||
|
||||
// fillPkt writes seq and a pattern derived from it into b, as the encrypt step writes a slot.
|
||||
func fillPkt(b []byte, seq uint32) {
|
||||
binary.BigEndian.PutUint32(b, seq)
|
||||
for i := 4; i < len(b); i++ {
|
||||
b[i] = byte(seq) ^ byte(i)
|
||||
}
|
||||
}
|
||||
|
||||
func checkPkt(b []byte, seq uint32) bool {
|
||||
if len(b) < 4 || binary.BigEndian.Uint32(b) != seq {
|
||||
return false
|
||||
}
|
||||
for i := 4; i < len(b); i++ {
|
||||
if b[i] != byte(seq)^byte(i) {
|
||||
return false
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
func pktSize(seq uint32) int { return 16 + int(seq%97) }
|
||||
|
||||
var testDsts = []netip.AddrPort{
|
||||
netip.MustParseAddrPort("10.0.0.1:4242"),
|
||||
netip.MustParseAddrPort("10.0.0.2:4242"),
|
||||
netip.MustParseAddrPort("[fd00::3]:4242"),
|
||||
}
|
||||
|
||||
// commit adds packet seq to p the way listenIn does: Begin, reserve, encrypt, commit, End.
|
||||
func commit(p *SendPipeline, seq uint32, last bool) {
|
||||
sb := p.Begin()
|
||||
slot := sb.Reserve(pktSize(seq))
|
||||
fillPkt(slot, seq)
|
||||
sb.Commit(slot, testDsts[seq%uint32(len(testDsts))])
|
||||
p.End(last)
|
||||
}
|
||||
|
||||
func TestSendPipelineOrder(t *testing.T) {
|
||||
defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
|
||||
w := &pipeWriter{t: t}
|
||||
// A small arena makes the batches grow theirs, and a small maxWrite splits takes across several writes.
|
||||
p := NewSendPipeline(w, 16, 64, 5, nil)
|
||||
|
||||
const n = 20000
|
||||
seq := uint32(0)
|
||||
for seq < n {
|
||||
// Reads of 1 to 40 packets, with an occasional pause so the sender goes idle and is woken.
|
||||
read := 1 + int(seq*7%40)
|
||||
for j := 0; j < read && seq < n; j++ {
|
||||
commit(p, seq, j == read-1 || seq == n-1)
|
||||
seq++
|
||||
}
|
||||
if seq%1000 < 40 {
|
||||
time.Sleep(50 * time.Microsecond)
|
||||
}
|
||||
}
|
||||
p.Close()
|
||||
|
||||
seqs, dsts, calls := w.sent()
|
||||
require.Len(t, seqs, n)
|
||||
for i, s := range seqs {
|
||||
require.Equal(t, uint32(i), s, "packet %d out of order", i)
|
||||
require.Equal(t, testDsts[s%uint32(len(testDsts))], dsts[i])
|
||||
}
|
||||
for _, c := range calls {
|
||||
assert.LessOrEqual(t, c, 5, "WriteBatch got more than maxWrite")
|
||||
assert.Positive(t, c)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSendPipelineConcurrentPeersKeepOrder(t *testing.T) {
|
||||
defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
|
||||
// A slow writer makes the sender take many packets per write, interleaving the three peers in each batch.
|
||||
w := &pipeWriter{t: t}
|
||||
slow := &slowWriter{pipeWriter: w, d: 20 * time.Microsecond}
|
||||
p := NewSendPipeline(slow, 128, 128*64, 128, nil)
|
||||
const n = 5000
|
||||
for i := uint32(0); i < n; i++ {
|
||||
commit(p, i, i%8 == 7 || i == n-1)
|
||||
}
|
||||
p.Close()
|
||||
|
||||
seqs, dsts, _ := w.sent()
|
||||
require.Len(t, seqs, n)
|
||||
last := map[netip.AddrPort]int64{}
|
||||
for i, s := range seqs {
|
||||
prev, ok := last[dsts[i]]
|
||||
if ok {
|
||||
require.Greater(t, int64(s), prev, "peer %v went backwards", dsts[i])
|
||||
}
|
||||
last[dsts[i]] = int64(s)
|
||||
}
|
||||
}
|
||||
|
||||
type slowWriter struct {
|
||||
*pipeWriter
|
||||
d time.Duration
|
||||
}
|
||||
|
||||
func (s *slowWriter) WriteBatch(bufs [][]byte, addrs []netip.AddrPort) (int, error) {
|
||||
time.Sleep(s.d)
|
||||
return s.pipeWriter.WriteBatch(bufs, addrs)
|
||||
}
|
||||
|
||||
// TestSendPipelineBackpressureAndReuse holds the sender inside a write and checks that the producer can fill
|
||||
// exactly one more batch, that none of its slots overlap the packets being written, and that the next Begin waits
|
||||
// until the write returns.
|
||||
func TestSendPipelineBackpressureAndReuse(t *testing.T) {
|
||||
defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
|
||||
const batchCap = 8
|
||||
w := &pipeWriter{t: t, gate: make(chan struct{}), entered: make(chan int, 16)}
|
||||
p := NewSendPipeline(w, batchCap, 64, 128, nil)
|
||||
|
||||
seq := uint32(0)
|
||||
for ; seq < batchCap; seq++ {
|
||||
commit(p, seq, seq == batchCap-1)
|
||||
}
|
||||
require.Equal(t, batchCap, <-w.entered, "sender should take the first batch whole")
|
||||
|
||||
w.mu.Lock()
|
||||
inFlight := append([][]byte(nil), w.inCall...)
|
||||
w.mu.Unlock()
|
||||
|
||||
// The second batch fills while the first is being written, in slots that don't touch the first's bytes.
|
||||
for ; seq < 2*batchCap; seq++ {
|
||||
sb := p.Begin()
|
||||
slot := sb.Reserve(pktSize(seq))
|
||||
for _, b := range inFlight {
|
||||
assert.False(t, overlaps(slot, b), "slot for packet %d overlaps packet %d, still being sent", seq, binary.BigEndian.Uint32(b))
|
||||
}
|
||||
fillPkt(slot, seq)
|
||||
sb.Commit(slot, testDsts[0])
|
||||
p.End(true)
|
||||
}
|
||||
|
||||
// Both batches are now spoken for, so the next Begin must wait for the write to return.
|
||||
begun := make(chan struct{})
|
||||
go func() {
|
||||
commit(p, seq, true)
|
||||
close(begun)
|
||||
}()
|
||||
select {
|
||||
case <-begun:
|
||||
t.Fatal("Begin returned with both batches in use: the pipeline is not bounded")
|
||||
case <-time.After(50 * time.Millisecond):
|
||||
}
|
||||
for i, b := range inFlight {
|
||||
assert.True(t, checkPkt(b, uint32(i)), "packet %d was overwritten before its send completed", i)
|
||||
}
|
||||
|
||||
w.gate <- struct{}{} // first write returns; the sender swaps and starts on the second batch
|
||||
assert.Equal(t, batchCap, <-w.entered)
|
||||
select {
|
||||
case <-begun:
|
||||
case <-time.After(5 * time.Second):
|
||||
t.Fatal("Begin did not return after the sender freed a batch")
|
||||
}
|
||||
w.gate <- struct{}{}
|
||||
go func() {
|
||||
for range w.entered {
|
||||
w.gate <- struct{}{}
|
||||
}
|
||||
}()
|
||||
p.Close()
|
||||
close(w.entered)
|
||||
|
||||
seqs, _, calls := w.sent()
|
||||
require.Len(t, seqs, 2*batchCap+1)
|
||||
for i, s := range seqs {
|
||||
assert.Equal(t, uint32(i), s)
|
||||
}
|
||||
assert.Equal(t, []int{batchCap, batchCap, 1}, calls)
|
||||
}
|
||||
|
||||
func overlaps(a, b []byte) bool {
|
||||
if len(a) == 0 || len(b) == 0 {
|
||||
return false
|
||||
}
|
||||
a0, b0 := uintptr(unsafe.Pointer(&a[0])), uintptr(unsafe.Pointer(&b[0]))
|
||||
return a0 < b0+uintptr(len(b)) && b0 < a0+uintptr(len(a))
|
||||
}
|
||||
|
||||
// TestSendPipelineBatchesBuildUp checks the point of the pipeline: while one write is in the kernel, everything the
|
||||
// producer commits leaves together in the next write.
|
||||
func TestSendPipelineBatchesBuildUp(t *testing.T) {
|
||||
defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
|
||||
w := &pipeWriter{t: t, gate: make(chan struct{}), entered: make(chan int, 16)}
|
||||
p := NewSendPipeline(w, 128, 128*64, 128, nil)
|
||||
|
||||
commit(p, 0, true)
|
||||
require.Equal(t, 1, <-w.entered)
|
||||
// Ten one-packet reads while the first write is held.
|
||||
for i := uint32(1); i <= 10; i++ {
|
||||
commit(p, i, true)
|
||||
}
|
||||
w.gate <- struct{}{}
|
||||
require.Equal(t, 10, <-w.entered, "packets queued during a write should go out in one WriteBatch")
|
||||
w.gate <- struct{}{}
|
||||
p.Close()
|
||||
|
||||
_, _, calls := w.sent()
|
||||
assert.Equal(t, []int{1, 10}, calls)
|
||||
}
|
||||
|
||||
func TestSendPipelineCloseFlushes(t *testing.T) {
|
||||
defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
|
||||
w := &pipeWriter{t: t}
|
||||
p := NewSendPipeline(w, 32, 32*64, 128, nil)
|
||||
// End(false) never wakes the sender, so only Close's final take sends these.
|
||||
for i := uint32(0); i < 5; i++ {
|
||||
commit(p, i, false)
|
||||
}
|
||||
p.Close()
|
||||
p.Close() // idempotent
|
||||
seqs, _, _ := w.sent()
|
||||
assert.Equal(t, []uint32{0, 1, 2, 3, 4}, seqs)
|
||||
}
|
||||
|
||||
func TestSendPipelineCloseEmpty(t *testing.T) {
|
||||
defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
|
||||
w := &pipeWriter{t: t}
|
||||
p := NewSendPipeline(w, 4, 64, 128, nil)
|
||||
sb := p.Begin()
|
||||
p.End(true) // nothing committed: no write
|
||||
assert.Zero(t, sb.Len())
|
||||
p.Close()
|
||||
_, _, calls := w.sent()
|
||||
assert.Empty(t, calls)
|
||||
}
|
||||
|
||||
// TestSendPipelineCloseWaitsForWrite checks that Close returns only after a write in progress has returned, so the
|
||||
// caller can't free anything the sender still uses.
|
||||
func TestSendPipelineCloseWaitsForWrite(t *testing.T) {
|
||||
defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
|
||||
w := &pipeWriter{t: t, gate: make(chan struct{}), entered: make(chan int, 4)}
|
||||
p := NewSendPipeline(w, 4, 64, 128, nil)
|
||||
commit(p, 0, true)
|
||||
<-w.entered
|
||||
commit(p, 1, false)
|
||||
|
||||
closed := make(chan struct{})
|
||||
go func() {
|
||||
p.Close()
|
||||
close(closed)
|
||||
}()
|
||||
select {
|
||||
case <-closed:
|
||||
t.Fatal("Close returned during a write")
|
||||
case <-time.After(50 * time.Millisecond):
|
||||
}
|
||||
w.gate <- struct{}{}
|
||||
<-w.entered // Close's final take writes packet 1
|
||||
w.gate <- struct{}{}
|
||||
select {
|
||||
case <-closed:
|
||||
case <-time.After(5 * time.Second):
|
||||
t.Fatal("Close did not return")
|
||||
}
|
||||
seqs, _, _ := w.sent()
|
||||
assert.Equal(t, []uint32{0, 1}, seqs)
|
||||
}
|
||||
|
||||
func TestSendPipelineOnWriteAndDrops(t *testing.T) {
|
||||
defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
|
||||
werr := errors.New("boom")
|
||||
w := &pipeWriter{t: t, short: 1, err: werr}
|
||||
type call struct {
|
||||
queued, written int
|
||||
err error
|
||||
}
|
||||
var got []call
|
||||
p := NewSendPipeline(w, 16, 16*64, 4, func(q, n int, err error) {
|
||||
got = append(got, call{q, n, err}) // sender goroutine only
|
||||
})
|
||||
for i := uint32(0); i < 10; i++ {
|
||||
commit(p, i, false)
|
||||
}
|
||||
p.Close()
|
||||
|
||||
assert.Equal(t, []call{{4, 3, werr}, {4, 3, werr}, {2, 1, werr}}, got)
|
||||
}
|
||||
|
||||
// TestSendPipelineStressRace runs a producer against a sender whose writes take varying time, for the race
|
||||
// detector, and checks nothing is lost, reordered or overwritten.
|
||||
func TestSendPipelineStressRace(t *testing.T) {
|
||||
defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
|
||||
w := &pipeWriter{t: t}
|
||||
jitter := &jitterWriter{pipeWriter: w}
|
||||
p := NewSendPipeline(jitter, 32, 256, 16, nil)
|
||||
const n = 50000
|
||||
for i := uint32(0); i < n; i++ {
|
||||
commit(p, i, i%3 == 0)
|
||||
}
|
||||
p.Close()
|
||||
seqs, _, _ := w.sent()
|
||||
require.Len(t, seqs, n)
|
||||
for i, s := range seqs {
|
||||
if uint32(i) != s {
|
||||
t.Fatalf("packet %d arrived at %d", s, i)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
type jitterWriter struct {
|
||||
*pipeWriter
|
||||
i int
|
||||
}
|
||||
|
||||
func (j *jitterWriter) WriteBatch(bufs [][]byte, addrs []netip.AddrPort) (int, error) {
|
||||
j.i++
|
||||
if j.i%7 == 0 {
|
||||
time.Sleep(time.Duration(j.i%5) * 10 * time.Microsecond)
|
||||
}
|
||||
return j.pipeWriter.WriteBatch(bufs, addrs)
|
||||
}
|
||||
|
||||
type discardWriter struct{}
|
||||
|
||||
func (discardWriter) WriteBatch(bufs [][]byte, _ []netip.AddrPort) (int, error) {
|
||||
return len(bufs), nil
|
||||
}
|
||||
|
||||
// BenchmarkSendPipeline measures a packet through Begin, reserve, commit and End with a writer that costs nothing;
|
||||
// its allocs/op is the pipeline's steady-state heap cost per packet.
|
||||
func BenchmarkSendPipeline(b *testing.B) {
|
||||
p := NewSendPipeline(discardWriter{}, SendBatchCap, SendBatchCap*1500, 128, nil)
|
||||
defer p.Close()
|
||||
b.ReportAllocs()
|
||||
for i := range b.N {
|
||||
sb := p.Begin()
|
||||
sb.Commit(sb.Reserve(1400), testDsts[0])
|
||||
p.End(i%8 == 7)
|
||||
}
|
||||
}
|
||||
@@ -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) {
|
||||
routeTree := new(bart.Table[routing.Gateways])
|
||||
seen := make(map[netip.Prefix]bool, len(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 {
|
||||
l.Warn("route MTU is not supported on this platform",
|
||||
"goos", runtime.GOOS,
|
||||
@@ -104,11 +98,7 @@ func parseRoutes(c *config.C, networks []netip.Prefix) ([]Route, error) {
|
||||
|
||||
mtu, ok := rMtu.(int)
|
||||
if !ok {
|
||||
s, ok := 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)
|
||||
mtu, err = strconv.Atoi(rMtu.(string))
|
||||
if err != nil {
|
||||
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 {
|
||||
mtu, ok = rMtu.(int)
|
||||
if !ok {
|
||||
s, ok := 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)
|
||||
mtu, err = strconv.Atoi(rMtu.(string))
|
||||
if err != nil {
|
||||
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)
|
||||
if !ok {
|
||||
s, ok := rMetric.(string)
|
||||
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)
|
||||
_, err = strconv.ParseInt(rMetric.(string), 10, 32)
|
||||
if err != nil {
|
||||
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 {
|
||||
@@ -267,15 +248,10 @@ func parseUnsafeRoutes(c *config.C, networks []netip.Prefix) ([]Route, error) {
|
||||
|
||||
gatewayWeight, ok := rGatewayWeight.(int)
|
||||
if !ok {
|
||||
s, ok := rGatewayWeight.(string)
|
||||
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)
|
||||
_, err = strconv.ParseInt(rGatewayWeight.(string), 10, 32)
|
||||
if err != nil {
|
||||
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 {
|
||||
|
||||
@@ -1,17 +1,13 @@
|
||||
package overlay
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"net/netip"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/header"
|
||||
"github.com/slackhq/nebula/routing"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/slackhq/nebula/udp"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
@@ -406,115 +402,3 @@ func Test_makeMultipathUnsafeRouteTree(t *testing.T) {
|
||||
routing.CalculateBucketsForGateways(expectedGateways)
|
||||
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")
|
||||
}
|
||||
@@ -145,3 +145,14 @@ func SupportsGSO(w io.Writer, want GSOProto) (GSOWriter, bool) {
|
||||
return gw, false
|
||||
}
|
||||
}
|
||||
|
||||
// BatchWriter is implemented by Queues that can emit several already-segmented packets in one call.
|
||||
// Backends without a batched write do not implement it and callers loop over Write.
|
||||
//
|
||||
// pkts are borrowed: WriteBatch must not retain them past its return.
|
||||
// A returned error doesn't say which packets were delivered, so callers must not retry the batch.
|
||||
// Safe for concurrent use, like Write.
|
||||
type BatchWriter interface {
|
||||
io.Writer
|
||||
WriteBatch(pkts [][]byte) error
|
||||
}
|
||||
+2
-31
@@ -7,27 +7,11 @@ import (
|
||||
"net/netip"
|
||||
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/header"
|
||||
"github.com/slackhq/nebula/udp"
|
||||
"github.com/slackhq/nebula/util"
|
||||
)
|
||||
|
||||
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 {
|
||||
Name string
|
||||
Underlying error
|
||||
@@ -41,16 +25,9 @@ func (e *NameError) Error() string {
|
||||
type DeviceFactory func(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, routines int) (Device, error)
|
||||
|
||||
func NewDeviceFromConfig(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, routines int) (Device, error) {
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("tun.disabled")
|
||||
})
|
||||
|
||||
switch {
|
||||
case c.GetBool("tun.disabled", false):
|
||||
tun := newDisabledTun(vpnNetworks, c.GetInt("tun.tx_queue", 5000), c.GetBool("stats.message_metrics", false), l)
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("tun.tx_queue", "stats.message_metrics")
|
||||
})
|
||||
tun := newDisabledTun(vpnNetworks, c.GetInt("tun.tx_queue", 500), c.GetBool("stats.message_metrics", false), l)
|
||||
return tun, nil
|
||||
|
||||
default:
|
||||
@@ -64,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") {
|
||||
return false, nil, nil
|
||||
}
|
||||
@@ -80,12 +57,6 @@ func getAllRoutesFromConfig(l *slog.Logger, c *config.C, vpnNetworks []netip.Pre
|
||||
}
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
|
||||
@@ -38,17 +38,16 @@ func newTunFromFd(c *config.C, l *slog.Logger, deviceFd int, vpnNetworks []netip
|
||||
l: l,
|
||||
}
|
||||
|
||||
err := t.reload(c, true, nil)
|
||||
err := t.reload(c, true)
|
||||
if err != nil {
|
||||
_ = file.Close()
|
||||
return nil, err
|
||||
}
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
err := t.reload(c, false, r)
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
err := t.reload(c, false)
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
@@ -68,8 +67,8 @@ func (t *tun) Activate() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||
func (t *tun) reload(c *config.C, initial bool) error {
|
||||
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
//go:build (openbsd || netbsd) && !e2e_testing
|
||||
|
||||
package overlay
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"os"
|
||||
"regexp"
|
||||
"runtime"
|
||||
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
var deviceNameRE = regexp.MustCompile(`^tun[0-9]+$`)
|
||||
|
||||
// tunDevNeedsRestart is true when tun.dev asks for a particular tun that isn't the running one. Anything else takes the
|
||||
// first free one, and the one we have will do
|
||||
func tunDevNeedsRestart(name, running string) bool {
|
||||
return deviceNameRE.MatchString(name) && name != running
|
||||
}
|
||||
|
||||
// openTun opens /dev/name, or the first /dev/tunN nothing else has open when name is empty or not tunN
|
||||
func openTun(l *slog.Logger, name string) (int, string, error) {
|
||||
if name != "" && !deviceNameRE.MatchString(name) {
|
||||
// The name doesn't mean anything here, so like darwin a bad one isn't worth refusing to start over
|
||||
l.Warn("interface name must be tun[0-9]+ on "+runtime.GOOS+", ignoring", "name", name)
|
||||
name = ""
|
||||
}
|
||||
if name != "" {
|
||||
fd, err := unix.Open("/dev/"+name, os.O_RDWR, 0)
|
||||
return fd, name, err
|
||||
}
|
||||
for i := 0; ; i++ {
|
||||
name = fmt.Sprintf("tun%d", i)
|
||||
fd, err := unix.Open("/dev/"+name, os.O_RDWR, 0)
|
||||
if err == nil {
|
||||
return fd, name, nil
|
||||
}
|
||||
if !errors.Is(err, unix.EBUSY) {
|
||||
return -1, "", fmt.Errorf("no free tun device, %s: %w", name, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,80 +0,0 @@
|
||||
//go:build (openbsd || netbsd) && !e2e_testing
|
||||
|
||||
package overlay
|
||||
|
||||
import (
|
||||
"net/netip"
|
||||
"testing"
|
||||
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// A tun.dev that isn't tunN is ignored like darwin does, and the first free tun is used. Only naming a different tun
|
||||
// asks for a restart
|
||||
func TestTunReloadDevRestart(t *testing.T) {
|
||||
newWithDev := func(dev string) (*config.C, *tun, error) {
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString("tun:\n dev: "+dev+"\n"))
|
||||
tn, err := newTun(c, test.NewLogger(), []netip.Prefix{netip.MustParsePrefix("10.1.0.2/24")}, false)
|
||||
if err == nil {
|
||||
t.Cleanup(func() { _ = tn.Close() })
|
||||
}
|
||||
return c, tn, err
|
||||
}
|
||||
if _, _, err := newWithDev(""); err != nil {
|
||||
t.Skipf("can't create a tun device here: %v", err)
|
||||
}
|
||||
c, tn, err := newWithDev("nope")
|
||||
require.NoError(t, err, "a bad name should fall back to a free tun")
|
||||
require.Regexp(t, `^tun[0-9]+$`, tn.Device)
|
||||
|
||||
for _, dev := range []string{"nope", "", tn.Device, "nope"} {
|
||||
res := c.ReloadConfigString("tun:\n dev: " + dev + "\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.False(t, res.Failed, dev)
|
||||
assert.False(t, res.RestartRequired, dev)
|
||||
}
|
||||
|
||||
other := "tun0"
|
||||
if tn.Device == other {
|
||||
other = "tun1"
|
||||
}
|
||||
res := c.ReloadConfigString("tun:\n dev: " + other + "\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.Equal(t, []string{"tun.dev"}, res.RestartKeys)
|
||||
}
|
||||
|
||||
// An empty tun.dev takes the first tun nothing else has open. Reloading it empty, or naming the one we have, needs
|
||||
// no restart
|
||||
func TestTunEmptyDevPicksAFreeOne(t *testing.T) {
|
||||
newEmpty := func() (*config.C, *tun, error) {
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString("tun: {}\n"))
|
||||
tn, err := newTun(c, test.NewLogger(), []netip.Prefix{netip.MustParsePrefix("10.1.0.2/24")}, false)
|
||||
if err == nil {
|
||||
t.Cleanup(func() { _ = tn.Close() })
|
||||
}
|
||||
return c, tn, err
|
||||
}
|
||||
c, first, err := newEmpty()
|
||||
if err != nil {
|
||||
t.Skipf("can't create a tun device here: %v", err)
|
||||
}
|
||||
_, second, err := newEmpty()
|
||||
require.NoError(t, err, "the second tun should skip the one the first has open")
|
||||
assert.NotEqual(t, first.Device, second.Device)
|
||||
|
||||
for _, cfg := range []string{
|
||||
"tun: {}\npunchy:\n punch: true\n",
|
||||
"tun:\n dev: " + first.Device + "\n",
|
||||
"tun: {}\n",
|
||||
} {
|
||||
res := c.ReloadConfigString(cfg)
|
||||
require.NoError(t, res.Err)
|
||||
assert.False(t, res.Failed)
|
||||
assert.False(t, res.RestartRequired, cfg)
|
||||
}
|
||||
}
|
||||
@@ -10,9 +10,6 @@ import (
|
||||
"github.com/slackhq/nebula/wfp"
|
||||
)
|
||||
|
||||
// interfaceBypassKeys are only read when the interface bypass is installed
|
||||
var interfaceBypassKeys = []string{"tun.windows_bypass_wdf"}
|
||||
|
||||
// installInterfaceBypass installs a WFP PERMIT filter scoped to the wintun interface LUID so inbound traffic on the
|
||||
// nebula adapter bypasses Windows Defender Firewall.
|
||||
func installInterfaceBypass(l *slog.Logger, luid uint64) closer {
|
||||
|
||||
@@ -4,9 +4,6 @@ package overlay
|
||||
|
||||
import "log/slog"
|
||||
|
||||
// interfaceBypassKeys is empty, windows-386 has no bypass
|
||||
var interfaceBypassKeys []string
|
||||
|
||||
// installInterfaceBypass is a no-op on windows-386 because we don't currently build for it.
|
||||
func installInterfaceBypass(_ *slog.Logger, _ uint64) closer {
|
||||
return nil
|
||||
|
||||
+441
-157
@@ -6,7 +6,6 @@ import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"math/bits"
|
||||
"net/netip"
|
||||
"os"
|
||||
"sync"
|
||||
@@ -16,6 +15,7 @@ import (
|
||||
|
||||
"github.com/gaissmai/bart"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/internal/msgx"
|
||||
"github.com/slackhq/nebula/overlay/tio"
|
||||
"github.com/slackhq/nebula/routing"
|
||||
"github.com/slackhq/nebula/util"
|
||||
@@ -30,13 +30,28 @@ type tun struct {
|
||||
DefaultMTU int
|
||||
Routes atomic.Pointer[[]Route]
|
||||
routeTree atomic.Pointer[bart.Table[routing.Gateways]]
|
||||
linkAddr atomic.Pointer[netroute.LinkAddr]
|
||||
linkAddr *netroute.LinkAddr
|
||||
// hostOwned means the fd arrived from the OS, which has already configured addressing, mtu
|
||||
// and routes for it. NEPacketTunnelProvider on darwin does this.
|
||||
hostOwned bool
|
||||
l *slog.Logger
|
||||
|
||||
// batchMu guards batch, WriteBatch's sendmsg_x scratch.
|
||||
batchMu sync.Mutex
|
||||
batch tunBatch
|
||||
}
|
||||
|
||||
// tunBatch is WriteBatch's scratch. The kernel reads every entry in place.
|
||||
type tunBatch struct {
|
||||
heads [msgx.Batch][4]byte
|
||||
iovs [msgx.Batch][2]unix.Iovec
|
||||
hdrs [msgx.Batch]msgx.Hdr
|
||||
pkts [msgx.Batch][]byte
|
||||
}
|
||||
|
||||
// noTunSendX is set once sendmsg_x is refused on the tun; WriteBatch then writes one packet at a time.
|
||||
var noTunSendX atomic.Bool
|
||||
|
||||
type ifReq struct {
|
||||
Name [unix.IFNAMSIZ]byte
|
||||
Flags uint16
|
||||
@@ -80,31 +95,17 @@ type ifreqAlias6 struct {
|
||||
Lifetime addrLifetime
|
||||
}
|
||||
|
||||
// utunIndex is the utun tun.dev asks for, or -1 for whichever is free. ok is false for a name that isn't utunN, which
|
||||
// also gets whichever is free
|
||||
func utunIndex(name string) (index int, ok bool) {
|
||||
if name == "" || name == "utun" {
|
||||
return -1, true
|
||||
}
|
||||
if _, err := fmt.Sscanf(name, "utun%d", &index); err != nil || index < 0 {
|
||||
return -1, false
|
||||
}
|
||||
return index, true
|
||||
}
|
||||
|
||||
// tunDevNeedsRestart is true when tun.dev asks for a particular utun that isn't the running one. Anything else takes
|
||||
// whichever is free, and the one we have will do
|
||||
func tunDevNeedsRestart(name, running string) bool {
|
||||
index, _ := utunIndex(name)
|
||||
return index >= 0 && fmt.Sprintf("utun%d", index) != running
|
||||
}
|
||||
|
||||
func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*tun, error) {
|
||||
ifIndex, ok := utunIndex(c.GetString("tun.dev", ""))
|
||||
if !ok {
|
||||
name := c.GetString("tun.dev", "")
|
||||
ifIndex := -1
|
||||
if name != "" && name != "utun" {
|
||||
_, err := fmt.Sscanf(name, "utun%d", &ifIndex)
|
||||
if err != nil || ifIndex < 0 {
|
||||
// NOTE: we don't make this error so we don't break existing
|
||||
// configs that set a name before it was used.
|
||||
l.Warn("interface name must be utun[0-9]+ on Darwin, ignoring")
|
||||
ifIndex = -1
|
||||
}
|
||||
}
|
||||
|
||||
fd, err := unix.Socket(unix.AF_SYSTEM, unix.SOCK_DGRAM, unix.AF_SYS_CONTROL)
|
||||
@@ -128,7 +129,7 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
||||
return nil, fmt.Errorf("SYS_CONNECT: %v", err)
|
||||
}
|
||||
|
||||
name, err := unix.GetsockoptString(fd, unix.AF_SYS_CONTROL, _UTUN_OPT_IFNAME)
|
||||
name, err = unix.GetsockoptString(fd, unix.AF_SYS_CONTROL, _UTUN_OPT_IFNAME)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to retrieve tun name: %w", err)
|
||||
}
|
||||
@@ -142,24 +143,19 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
||||
f: os.NewFile(uintptr(fd), ""),
|
||||
Device: name,
|
||||
vpnNetworks: vpnNetworks,
|
||||
DefaultMTU: getMTU(l, c),
|
||||
DefaultMTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||
l: l,
|
||||
}
|
||||
|
||||
err = t.reload(c, true, nil)
|
||||
err = t.reload(c, true)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("tun.mtu")
|
||||
if tunDevNeedsRestart(c.GetString("tun.dev", ""), t.Device) {
|
||||
r.RestartRequiredIfChanged("tun.dev")
|
||||
}
|
||||
err := t.reload(c, false, r)
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
err := t.reload(c, false)
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
@@ -188,20 +184,19 @@ func newTunFromFd(c *config.C, l *slog.Logger, deviceFd int, vpnNetworks []netip
|
||||
f: file,
|
||||
Device: utunNameFromFd(deviceFd),
|
||||
vpnNetworks: vpnNetworks,
|
||||
DefaultMTU: getMTU(l, c),
|
||||
DefaultMTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||
hostOwned: true,
|
||||
l: l,
|
||||
}
|
||||
|
||||
if err := t.reload(c, true, nil); err != nil {
|
||||
if err := t.reload(c, true); err != nil {
|
||||
_ = file.Close()
|
||||
return nil, err
|
||||
}
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
if err := t.reload(c, false, r); err != nil {
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
if err := t.reload(c, false); err != nil {
|
||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
@@ -265,7 +260,7 @@ func (t *tun) Activate() error {
|
||||
if linkAddr == nil {
|
||||
return fmt.Errorf("unable to discover link_addr for tun interface")
|
||||
}
|
||||
t.linkAddr.Store(linkAddr)
|
||||
t.linkAddr = linkAddr
|
||||
|
||||
for _, network := range t.vpnNetworks {
|
||||
if network.Addr().Is4() {
|
||||
@@ -288,10 +283,9 @@ func (t *tun) Activate() error {
|
||||
}
|
||||
|
||||
// Unsafe path routes
|
||||
return t.addRoutes(false, nil)
|
||||
return t.addRoutes(false)
|
||||
}
|
||||
|
||||
// activate4 assigns our vpn address as a /32 and routes the vpn network to the tun explicitly.
|
||||
func (t *tun) activate4(network netip.Prefix) error {
|
||||
s, err := unix.Socket(
|
||||
unix.AF_INET,
|
||||
@@ -318,32 +312,22 @@ func (t *tun) activate4(network netip.Prefix) error {
|
||||
MaskAddr: unix.RawSockaddrInet4{
|
||||
Len: unix.SizeofSockaddrInet4,
|
||||
Family: unix.AF_INET,
|
||||
Addr: [4]byte{255, 255, 255, 255}, //always make the address a /32
|
||||
Addr: prefixToMask(network).As4(),
|
||||
},
|
||||
}
|
||||
|
||||
// On Darwin, VPNs don't edit the routing table directly.
|
||||
// A network extension hands its routes to the system, and configd installs them.
|
||||
// configd replaces any route already holding the same prefix, including ours.
|
||||
// As an example, Tailscale with an exit node treats any interface prefix wider than one address as a LAN.
|
||||
// With LAN access off, it routes each LAN into Tailscale's utun.
|
||||
// With LAN access on, it excludes each LAN from its tunnel.
|
||||
// configd routes an excluded prefix like its own routes would, ignoring ours, so it goes out the default route.
|
||||
// Either way our route is replaced, and traffic for the vpn network no longer reaches nebula.
|
||||
// A single address isn't a LAN to Tailscale, so our route is left alone.
|
||||
// We route the vpn network to the tun explicitly instead.
|
||||
|
||||
if err := ioctl(uintptr(s), unix.SIOCAIFADDR, uintptr(unsafe.Pointer(&ifr))); err != nil {
|
||||
return fmt.Errorf("failed to set tun v4 address: %s", err)
|
||||
}
|
||||
|
||||
if err := addRoute(network, t.linkAddr.Load()); err != nil {
|
||||
return fmt.Errorf("failed to add route for %v: %w", network.Masked(), err)
|
||||
err = addRoute(network, t.linkAddr)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// activate6 is activate4 for IPv6
|
||||
func (t *tun) activate6(network netip.Prefix) error {
|
||||
s, err := unix.Socket(
|
||||
unix.AF_INET6,
|
||||
@@ -365,29 +349,25 @@ func (t *tun) activate6(network netip.Prefix) error {
|
||||
PrefixMask: unix.RawSockaddrInet6{
|
||||
Len: unix.SizeofSockaddrInet6,
|
||||
Family: unix.AF_INET6,
|
||||
// Always set the netmask to be a /128. See activate4 for why we do this.
|
||||
Addr: [16]byte{255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255},
|
||||
Addr: prefixToMask(network).As16(),
|
||||
},
|
||||
Lifetime: addrLifetime{
|
||||
// never expires
|
||||
Vltime: 0xffffffff,
|
||||
Pltime: 0xffffffff,
|
||||
},
|
||||
Flags: _IN6_IFF_NODAD, // No DAD, a utun has no neighbors.
|
||||
Flags: _IN6_IFF_NODAD,
|
||||
}
|
||||
|
||||
if err := ioctl(uintptr(s), _SIOCAIFADDR_IN6, uintptr(unsafe.Pointer(&ifr))); err != nil {
|
||||
return fmt.Errorf("failed to set tun address: %s", err)
|
||||
}
|
||||
|
||||
if err := addRoute(network, t.linkAddr.Load()); err != nil {
|
||||
return fmt.Errorf("failed to add route for %v: %w", network.Masked(), err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||
func (t *tun) reload(c *config.C, initial bool) error {
|
||||
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -407,18 +387,16 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
|
||||
if !initial {
|
||||
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes), r)
|
||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
|
||||
// Ensure any routes we actually want are installed
|
||||
err = t.addRoutes(true, r)
|
||||
err = t.addRoutes(true)
|
||||
if err != nil {
|
||||
// Catch any stray logs
|
||||
util.LogWithContextIfNeeded("Failed to add routes", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -433,56 +411,6 @@ func (t *tun) RoutesFor(ip netip.Addr) routing.Gateways {
|
||||
return routing.Gateways{}
|
||||
}
|
||||
|
||||
func fetchRoutes() ([]netroute.Message, error) {
|
||||
rib, err := netroute.FetchRIB(unix.AF_UNSPEC, unix.NET_RT_DUMP, 0)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return netroute.ParseRIB(unix.NET_RT_DUMP, rib)
|
||||
}
|
||||
|
||||
// routeInterfaceIn returns the index of the interface prefix is routed through, or 0 if msgs has no route for exactly
|
||||
// that prefix. Routes scoped to an interface are skipped, they don't stop us adding ours.
|
||||
func routeInterfaceIn(msgs []netroute.Message, prefix netip.Prefix) int {
|
||||
for _, msg := range msgs {
|
||||
m, ok := msg.(*netroute.RouteMessage)
|
||||
if !ok || len(m.Addrs) <= unix.RTAX_NETMASK || m.Flags&unix.RTF_IFSCOPE != 0 {
|
||||
continue
|
||||
}
|
||||
if p, ok := routePrefix(m.Addrs[unix.RTAX_DST], m.Addrs[unix.RTAX_NETMASK]); ok && p == prefix.Masked() {
|
||||
return m.Index
|
||||
}
|
||||
}
|
||||
return 0
|
||||
}
|
||||
|
||||
// routePrefix returns the prefix a route covers. Host routes have no netmask.
|
||||
func routePrefix(dst, mask netroute.Addr) (netip.Prefix, bool) {
|
||||
switch d := dst.(type) {
|
||||
case *netroute.Inet4Addr:
|
||||
bits := 32
|
||||
if m, ok := mask.(*netroute.Inet4Addr); ok {
|
||||
bits = maskBits(m.IP[:])
|
||||
}
|
||||
return netip.PrefixFrom(netip.AddrFrom4(d.IP), bits), true
|
||||
case *netroute.Inet6Addr:
|
||||
bits := 128
|
||||
if m, ok := mask.(*netroute.Inet6Addr); ok {
|
||||
bits = maskBits(m.IP[:])
|
||||
}
|
||||
return netip.PrefixFrom(netip.AddrFrom16(d.IP), bits), true
|
||||
}
|
||||
return netip.Prefix{}, false
|
||||
}
|
||||
|
||||
func maskBits(mask []byte) int {
|
||||
n := 0
|
||||
for _, b := range mask {
|
||||
n += bits.OnesCount8(b)
|
||||
}
|
||||
return n
|
||||
}
|
||||
|
||||
// Get the LinkAddr for the interface of the given name
|
||||
// Is there an easier way to fetch this when we create the interface?
|
||||
// Maybe SIOCGIFINDEX? but this doesn't appear to exist in the darwin headers.
|
||||
@@ -511,20 +439,13 @@ func getLinkAddr(name string) (*netroute.LinkAddr, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
func (t *tun) addRoutes(logErrors bool) error {
|
||||
// The route tree is still ours, the system routing table is not
|
||||
if t.hostOwned {
|
||||
return nil
|
||||
}
|
||||
|
||||
// Activate hasn't run yet, it will install the routes
|
||||
linkAddr := t.linkAddr.Load()
|
||||
if linkAddr == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
routes := *t.Routes.Load()
|
||||
systemRoutes := sync.OnceValues(fetchRoutes)
|
||||
|
||||
for _, r := range routes {
|
||||
if len(r.Via) == 0 || !r.Install {
|
||||
@@ -532,54 +453,39 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
continue
|
||||
}
|
||||
|
||||
err := addRoute(r.Cidr, linkAddr)
|
||||
err := addRoute(r.Cidr, t.linkAddr)
|
||||
if err != nil {
|
||||
if errors.Is(err, unix.EEXIST) {
|
||||
// Every route we added already exists on a reload, only warn about someone else's
|
||||
msgs, err := systemRoutes()
|
||||
if err != nil {
|
||||
t.l.Warn("unable to add unsafe_route, a route already exists but its interface could not be determined", "route", r.Cidr, "error", err)
|
||||
} else if routeInterfaceIn(msgs, r.Cidr) != linkAddr.Index {
|
||||
t.l.Warn("unable to add unsafe_route, the destination is already routed through another interface", "route", r.Cidr)
|
||||
}
|
||||
t.l.Warn("unable to add unsafe_route, identical route already exists", "route", r.Cidr)
|
||||
} else {
|
||||
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||
if logErrors {
|
||||
retErr.Log(t.l)
|
||||
rl.Failed()
|
||||
} else {
|
||||
return retErr
|
||||
}
|
||||
}
|
||||
} else {
|
||||
t.l.Info("Added route", "route", r)
|
||||
// A cidr listed twice would otherwise find our own route missing from an older fetch
|
||||
systemRoutes = sync.OnceValues(fetchRoutes)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tun) removeRoutes(routes []Route, rl *config.Reload) error {
|
||||
linkAddr := t.linkAddr.Load()
|
||||
if t.hostOwned || linkAddr == nil {
|
||||
func (t *tun) removeRoutes(routes []Route) error {
|
||||
if t.hostOwned {
|
||||
return nil
|
||||
}
|
||||
|
||||
for _, r := range routes {
|
||||
if len(r.Via) == 0 || !r.Install {
|
||||
// addRoutes never installs these
|
||||
if !r.Install {
|
||||
continue
|
||||
}
|
||||
|
||||
err := delRoute(r.Cidr, linkAddr)
|
||||
if errors.Is(err, unix.ESRCH) {
|
||||
// Already gone, which is what we wanted
|
||||
t.l.Info("Route was already removed", "route", r)
|
||||
} else if err != nil {
|
||||
err := delRoute(r.Cidr, t.linkAddr)
|
||||
if err != nil {
|
||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||
rl.Failed()
|
||||
} else {
|
||||
t.l.Info("Removed route", "route", r)
|
||||
}
|
||||
@@ -726,16 +632,12 @@ func (t *tun) Write(from []byte) (int, error) {
|
||||
return 0, syscall.EIO
|
||||
}
|
||||
|
||||
ipVer := from[0] >> 4
|
||||
var head [4]byte
|
||||
switch ipVer {
|
||||
case 4:
|
||||
head[3] = syscall.AF_INET
|
||||
case 6:
|
||||
head[3] = syscall.AF_INET6
|
||||
default:
|
||||
return 0, fmt.Errorf("unable to determine IP version from packet")
|
||||
af, err := tunAF(from)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
head[3] = af
|
||||
|
||||
// Grab rc as a local so the compiler can devirtualize the call and keep the closure on the stack.
|
||||
rc, err := t.f.SyscallConn()
|
||||
@@ -768,6 +670,129 @@ func (t *tun) Write(from []byte) (int, error) {
|
||||
return n - 4, nil
|
||||
}
|
||||
|
||||
// tunAF returns the utun address-family prefix byte for an IP packet.
|
||||
func tunAF(pkt []byte) (byte, error) {
|
||||
switch pkt[0] >> 4 {
|
||||
case 4:
|
||||
return syscall.AF_INET, nil
|
||||
case 6:
|
||||
return syscall.AF_INET6, nil
|
||||
default:
|
||||
return 0, fmt.Errorf("unable to determine IP version from packet")
|
||||
}
|
||||
}
|
||||
|
||||
// WriteBatch writes pkts to the utun device with sendmsg_x, up to msgx.Batch packets per syscall. utun is a
|
||||
// connected datagram socket, so xnu takes the batched send path, though it still hands utun each packet on its own:
|
||||
// this saves syscalls, not per-packet kernel work. Safe for concurrent use.
|
||||
//
|
||||
// An empty packet or one with no IP version is skipped and reported, as Write would. A short count goes on with the
|
||||
// rest; EMSGSIZE, which sendmsg_x returns only when the first packet is past the send buffer, sends that one through
|
||||
// Write, which reports it. Any other error means the kernel took an unknown prefix and dropped the rest, so it is
|
||||
// reported rather than retried, which could deliver packets twice. Under mbuf exhaustion sendmsg_x reports packets it
|
||||
// freed unsent as a short count, so they are lost where writev would have delivered them.
|
||||
func (t *tun) WriteBatch(pkts [][]byte) error {
|
||||
if noTunSendX.Load() {
|
||||
return t.writeEach(pkts)
|
||||
}
|
||||
|
||||
t.batchMu.Lock()
|
||||
defer t.batchMu.Unlock()
|
||||
b := &t.batch
|
||||
var firstErr error
|
||||
keep := func(err error) {
|
||||
if err != nil && firstErr == nil {
|
||||
firstErr = err
|
||||
}
|
||||
}
|
||||
for len(pkts) > 0 {
|
||||
n := 0
|
||||
for len(pkts) > 0 && n < msgx.Batch {
|
||||
p := pkts[0]
|
||||
pkts = pkts[1:]
|
||||
if len(p) == 0 {
|
||||
keep(syscall.EIO)
|
||||
continue
|
||||
}
|
||||
af, err := tunAF(p)
|
||||
if err != nil {
|
||||
keep(err)
|
||||
continue
|
||||
}
|
||||
b.heads[n] = [4]byte{3: af}
|
||||
b.iovs[n] = [2]unix.Iovec{{Base: &b.heads[n][0], Len: 4}, {Base: &p[0], Len: uint64(len(p))}}
|
||||
b.hdrs[n] = msgx.Hdr{Iov: &b.iovs[n][0], Iovlen: 2}
|
||||
b.pkts[n] = p
|
||||
n++
|
||||
}
|
||||
|
||||
for off := 0; off < n; {
|
||||
sent, err := t.sendmsgX(b.hdrs[off:n])
|
||||
switch {
|
||||
case err == nil && sent > 0:
|
||||
off += sent
|
||||
case err == nil:
|
||||
keep(t.writeEach(b.pkts[off:n]))
|
||||
off = n
|
||||
case err == unix.EMSGSIZE:
|
||||
keep(t.writeEach(b.pkts[off : off+1]))
|
||||
off++
|
||||
case isUnsupported(err):
|
||||
if noTunSendX.CompareAndSwap(false, true) {
|
||||
t.l.Warn("sendmsg_x unavailable on the tun device, writing one packet per syscall", "error", err)
|
||||
}
|
||||
keep(t.writeEach(b.pkts[off:n]))
|
||||
keep(t.writeEach(pkts))
|
||||
pkts, off = nil, n
|
||||
default:
|
||||
keep(err)
|
||||
off = n
|
||||
}
|
||||
}
|
||||
clear(b.iovs[:n])
|
||||
clear(b.pkts[:n])
|
||||
}
|
||||
return firstErr
|
||||
}
|
||||
|
||||
// sendmsgX hands hdrs to sendmsg_x, waiting while the socket is full, and returns how many the kernel took.
|
||||
func (t *tun) sendmsgX(hdrs []msgx.Hdr) (int, error) {
|
||||
rc, err := t.f.SyscallConn()
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
var sent int
|
||||
var errno syscall.Errno
|
||||
err = rc.Write(func(fd uintptr) bool {
|
||||
sent, errno = msgx.Send(fd, hdrs)
|
||||
// sendmsg_x reports EAGAIN only when it took nothing; a partial batch returns its count.
|
||||
return errno != syscall.EAGAIN
|
||||
})
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
if errno != 0 {
|
||||
return 0, errno
|
||||
}
|
||||
return sent, nil
|
||||
}
|
||||
|
||||
func isUnsupported(err error) bool {
|
||||
errno, ok := err.(syscall.Errno)
|
||||
return ok && msgx.Unsupported(errno)
|
||||
}
|
||||
|
||||
// writeEach writes pkts one at a time with Write.
|
||||
func (t *tun) writeEach(pkts [][]byte) error {
|
||||
var firstErr error
|
||||
for _, p := range pkts {
|
||||
if _, err := t.Write(p); err != nil && firstErr == nil {
|
||||
firstErr = err
|
||||
}
|
||||
}
|
||||
return firstErr
|
||||
}
|
||||
|
||||
func (t *tun) Networks() []netip.Prefix {
|
||||
return t.vpnNetworks
|
||||
}
|
||||
@@ -777,5 +802,264 @@ func (t *tun) Name() string {
|
||||
}
|
||||
|
||||
func (t *tun) Queues(int) ([]tio.Queue, error) {
|
||||
return []tio.Queue{tio.NewSingleQueue(t, defaultBatchBufSize)}, nil
|
||||
return []tio.Queue{newTunQueue(t)}, nil
|
||||
}
|
||||
|
||||
// tunReadBatch is the most packets one tunQueue.Read returns.
|
||||
const tunReadBatch = msgx.Batch
|
||||
|
||||
// tunRecvXSlot is each recvmsg_x entry's packet buffer. recvmsg_x lays its buffers out before it knows the packet
|
||||
// sizes, so each gets room for the largest IP packet; the kernel only touches what it writes.
|
||||
const tunRecvXSlot = defaultBatchBufSize
|
||||
|
||||
// tunRecvXStride is how far apart the slots start: 64 byte aligned, and one cache line more than 64KiB so the packet
|
||||
// starts don't all land in the same cache sets.
|
||||
const tunRecvXStride = 65536 + 64
|
||||
|
||||
// tunQueue is the darwin tun's Queue. Read hands back every packet already queued on the utun, up to tunReadBatch, so
|
||||
// the caller encrypts and sends them as one batch rather than one per wakeup. It reads them with one recvmsg_x when
|
||||
// it can and one readv per packet otherwise.
|
||||
type tunQueue struct {
|
||||
t *tun
|
||||
// buf holds the packets Read returns: recvmsg_x's slots, or, for readv, one arena. readv stops once less than
|
||||
// defaultBatchBufSize of it is left, so every readv has room for the largest packet utun can return.
|
||||
buf []byte
|
||||
pkts [tunReadBatch]tio.Packet
|
||||
// x is the recvmsg_x scratch, nil once recvmsg_x is off for good.
|
||||
x *tunRecvX
|
||||
}
|
||||
|
||||
// tunRecvX is the recvmsg_x scratch. Entry i scatters its AF prefix into heads[i] and its packet into slot i of the
|
||||
// queue's buf; the kernel reads and writes every entry in place.
|
||||
type tunRecvX struct {
|
||||
heads [tunReadBatch][4]byte
|
||||
iovs [tunReadBatch][2]unix.Iovec
|
||||
hdrs [tunReadBatch]msgx.Hdr
|
||||
}
|
||||
|
||||
// newTunQueue returns t's Queue, raising t's pending packet limit first so a read can find more than one.
|
||||
func newTunQueue(t *tun) *tunQueue {
|
||||
t.raisePendingPackets()
|
||||
q := &tunQueue{t: t, buf: make([]byte, tunReadBatch*tunRecvXStride), x: &tunRecvX{}}
|
||||
x := q.x
|
||||
for i := range x.hdrs {
|
||||
x.iovs[i] = [2]unix.Iovec{
|
||||
{Base: &x.heads[i][0], Len: 4},
|
||||
{Base: &q.buf[i*tunRecvXStride], Len: tunRecvXSlot},
|
||||
}
|
||||
x.hdrs[i] = msgx.Hdr{Iov: &x.iovs[i][0], Iovlen: 2}
|
||||
}
|
||||
return q
|
||||
}
|
||||
|
||||
// Read waits for the utun to become readable, then returns the packets queued on it.
|
||||
func (q *tunQueue) Read() ([]tio.Packet, error) {
|
||||
if q.x != nil {
|
||||
if pkts, err, ok := q.readX(); ok {
|
||||
return pkts, err
|
||||
}
|
||||
}
|
||||
return q.readv()
|
||||
}
|
||||
|
||||
// tunRecvmsgX is msgx.Recv; tests swap it to inject results.
|
||||
var tunRecvmsgX = msgx.Recv
|
||||
|
||||
// readX reads up to tunReadBatch packets with one recvmsg_x. ok is false when the caller should read with readv
|
||||
// instead: recvmsg_x failed this time, or has been turned off for good. A batch that fails tunRecvXCheck is dropped:
|
||||
// its packets are off the socket, but their lengths can't be trusted.
|
||||
func (q *tunQueue) readX() (pkts []tio.Packet, err error, ok bool) {
|
||||
rc, err := q.t.f.SyscallConn()
|
||||
if err != nil {
|
||||
return nil, err, true
|
||||
}
|
||||
|
||||
x := q.x
|
||||
var n int
|
||||
var errno syscall.Errno
|
||||
err = rc.Read(func(fd uintptr) bool {
|
||||
for i := range x.hdrs {
|
||||
x.hdrs[i].Flags = 0
|
||||
x.hdrs[i].Datalen = 0
|
||||
}
|
||||
n, errno = tunRecvmsgX(fd, x.hdrs[:])
|
||||
return errno != unix.EAGAIN
|
||||
})
|
||||
if err != nil {
|
||||
return nil, err, true
|
||||
}
|
||||
if tunRecvXRefused(errno) {
|
||||
q.disableX("unavailable", errno)
|
||||
return nil, nil, false
|
||||
}
|
||||
if errno != 0 {
|
||||
// recvmsg_x can fail where readv wouldn't (a kernel allocation, say), so let readv read this wakeup and
|
||||
// report the error if it is real.
|
||||
return nil, nil, false
|
||||
}
|
||||
if cerr := tunRecvXCheck(n, x.hdrs[:], x.heads[:], tunRecvXSlot); cerr != nil {
|
||||
q.disableX("returned an unexpected batch", cerr)
|
||||
return nil, nil, false
|
||||
}
|
||||
for i := range n {
|
||||
off := i * tunRecvXStride
|
||||
end := off + int(x.hdrs[i].Datalen) - 4
|
||||
q.pkts[i] = tio.Packet{Bytes: q.buf[off:end:end]}
|
||||
}
|
||||
// n is 0 at end of file, as readv's short read is.
|
||||
return q.pkts[:n], nil, true
|
||||
}
|
||||
|
||||
// tunRecvXRefused reports whether a recvmsg_x errno means it will never work here: msgx.Unsupported's refusals, and
|
||||
// EINVAL and EMSGSIZE, which with the headers newTunQueue builds come only from xnu rejecting their layout.
|
||||
func tunRecvXRefused(errno syscall.Errno) bool {
|
||||
return msgx.Unsupported(errno) || errno == unix.EINVAL || errno == unix.EMSGSIZE
|
||||
}
|
||||
|
||||
// disableX turns recvmsg_x off for q for good. readv keeps reading into buf.
|
||||
func (q *tunQueue) disableX(why string, err error) {
|
||||
q.x = nil
|
||||
q.t.l.Warn("recvmsg_x "+why+" on the tun device, reading one packet per syscall", "error", err)
|
||||
}
|
||||
|
||||
// tunRecvXCheck rejects a recvmsg_x batch of n entries that intact msghdr_x entries can't produce, which would mean
|
||||
// the private layout changed under us: more entries than headers, one past its 4 byte head plus slot byte buffer or
|
||||
// too short to hold the head, or an AF prefix utun never writes. A slot holds the largest IP packet, so nothing is
|
||||
// ever truncated; xnu's default recvmsg_x path doesn't report MSG_TRUNC per entry anyway, only its SO_DONTTRUNC path
|
||||
// does, and that is checked too.
|
||||
func tunRecvXCheck(n int, hdrs []msgx.Hdr, heads [][4]byte, slot int) error {
|
||||
if n < 0 || n > len(hdrs) || n > len(heads) {
|
||||
return fmt.Errorf("returned %d packets for %d headers", n, len(hdrs))
|
||||
}
|
||||
for i := range n {
|
||||
h := &hdrs[i]
|
||||
if h.Flags&unix.MSG_TRUNC != 0 {
|
||||
return fmt.Errorf("packet %d came back truncated, flags %#x", i, h.Flags)
|
||||
}
|
||||
if h.Datalen < 4 || h.Datalen > uint64(4+slot) {
|
||||
return fmt.Errorf("packet %d is %d bytes, outside the 4 to %d the buffers allow", i, h.Datalen, 4+slot)
|
||||
}
|
||||
switch heads[i] {
|
||||
case [4]byte{3: syscall.AF_INET}, [4]byte{3: syscall.AF_INET6}:
|
||||
default:
|
||||
return fmt.Errorf("packet %d has AF prefix % x", i, heads[i])
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// readv reads packets one readv at a time until the utun would block. An error after at least one packet is dropped
|
||||
// in favor of returning those packets; a persistent one recurs on the next Read.
|
||||
func (q *tunQueue) readv() ([]tio.Packet, error) {
|
||||
rc, err := q.t.f.SyscallConn()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var head [4]byte
|
||||
n, off := 0, 0
|
||||
var callErr error
|
||||
err = rc.Read(func(fd uintptr) bool {
|
||||
for n < tunReadBatch && len(q.buf)-off >= defaultBatchBufSize {
|
||||
iovecs := [2]unix.Iovec{
|
||||
{Base: &head[0], Len: 4},
|
||||
{Base: &q.buf[off], Len: uint64(len(q.buf) - off)},
|
||||
}
|
||||
l, e := tunReadv(int(fd), iovecs[:])
|
||||
if e != nil {
|
||||
if errno, ok := e.(syscall.Errno); ok && errno.Temporary() {
|
||||
// Park on the poller only while there is nothing to hand back.
|
||||
return n > 0
|
||||
}
|
||||
callErr = e
|
||||
return true
|
||||
}
|
||||
if l < 4 {
|
||||
// A datagram too short to carry the AF prefix, or end of file; stop rather than spin on it.
|
||||
return true
|
||||
}
|
||||
end := off + l - 4
|
||||
q.pkts[n] = tio.Packet{Bytes: q.buf[off:end:end]}
|
||||
n++
|
||||
off = end
|
||||
}
|
||||
return true
|
||||
})
|
||||
if n > 0 {
|
||||
return q.pkts[:n], nil
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return nil, callErr
|
||||
}
|
||||
|
||||
func (q *tunQueue) Write(p []byte) (int, error) { return q.t.Write(p) }
|
||||
|
||||
func (q *tunQueue) WriteBatch(pkts [][]byte) error { return q.t.WriteBatch(pkts) }
|
||||
|
||||
func (q *tunQueue) Close() error { return q.t.Close() }
|
||||
|
||||
// xnu lets one packet wait on a utun control socket by default (if_utun.c utun_ctl_bind): utun_start stops moving
|
||||
// packets from the interface's send queue to the socket once one is waiting, and resumes only when a read wakes the
|
||||
// interface's starter thread. So every read finds one packet. tunPendingPackets lets a whole read batch wait
|
||||
// instead (_UTUN_OPT_MAX_PENDING_PACKETS, bsd/net/if_utun.h, set at SYSPROTO_CONTROL level).
|
||||
const (
|
||||
tunPendingPackets = tunReadBatch
|
||||
_UTUN_OPT_MAX_PENDING_PACKETS = 16
|
||||
_SYSPROTO_CONTROL = 2
|
||||
)
|
||||
|
||||
// tunSetsockoptInt and tunGetsockoptInt are setsockopt and getsockopt; tests swap them.
|
||||
var (
|
||||
tunSetsockoptInt = unix.SetsockoptInt
|
||||
tunGetsockoptInt = unix.GetsockoptInt
|
||||
)
|
||||
|
||||
// raisePendingPackets lets up to tunPendingPackets packets wait on the utun control socket, first growing its
|
||||
// receive buffer to hold that many packets and their 4 byte AF prefix: utun drops a packet the buffer has no room
|
||||
// for, while one over the limit waits in the interface's queue. It sizes for the larger of tun.mtu and the device's
|
||||
// current MTU. Failures are logged and leave xnu's default; the tun works either way.
|
||||
func (t *tun) raisePendingPackets() {
|
||||
if t.f == nil {
|
||||
return
|
||||
}
|
||||
rc, err := t.f.SyscallConn()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
mtu := max(t.DefaultMTU, t.currentMTU())
|
||||
_ = rc.Control(func(fd uintptr) {
|
||||
pending := tunPendingPackets
|
||||
need := pending * (mtu + 4)
|
||||
if have, err := tunGetsockoptInt(int(fd), unix.SOL_SOCKET, unix.SO_RCVBUF); err == nil && have < need {
|
||||
if err := tunSetsockoptInt(int(fd), unix.SOL_SOCKET, unix.SO_RCVBUF, need); err != nil {
|
||||
pending = max(have/(mtu+4), 1)
|
||||
t.l.Warn("could not grow the tun control socket's receive buffer, capping pending packets",
|
||||
"error", err, "rcvbuf", have, "wanted", need, "pending", pending)
|
||||
}
|
||||
}
|
||||
if err := tunSetsockoptInt(int(fd), _SYSPROTO_CONTROL, _UTUN_OPT_MAX_PENDING_PACKETS, pending); err != nil {
|
||||
t.l.Warn("could not raise the tun's pending packet limit, reads will return one packet each",
|
||||
"error", err, "pending", pending)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// currentMTU is the utun's MTU as the kernel has it now, or 0 if that can't be read. A host-owned device's MTU
|
||||
// comes from the host, not tun.mtu.
|
||||
func (t *tun) currentMTU() int {
|
||||
if t.Device == "" {
|
||||
return 0
|
||||
}
|
||||
s, err := unix.Socket(unix.AF_INET, unix.SOCK_DGRAM, unix.IPPROTO_IP)
|
||||
if err != nil {
|
||||
return 0
|
||||
}
|
||||
defer unix.Close(s)
|
||||
ifr, err := unix.IoctlGetIfreqMTU(s, t.Device)
|
||||
if err != nil {
|
||||
return 0
|
||||
}
|
||||
return int(ifr.MTU)
|
||||
}
|
||||
@@ -1,118 +0,0 @@
|
||||
//go:build darwin && !ios && !e2e_testing
|
||||
|
||||
package overlay
|
||||
|
||||
import (
|
||||
"net"
|
||||
"net/netip"
|
||||
"os"
|
||||
"os/exec"
|
||||
"strings"
|
||||
"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"
|
||||
netroute "golang.org/x/net/route"
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// Every mac routes loopback through lo0
|
||||
func TestRouteInterfaceIn(t *testing.T) {
|
||||
msgs, err := fetchRoutes()
|
||||
require.NoError(t, err)
|
||||
routeInterface := func(s string) int { return routeInterfaceIn(msgs, netip.MustParsePrefix(s)) }
|
||||
|
||||
lo0, err := net.InterfaceByName("lo0")
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Equal(t, lo0.Index, routeInterface("127.0.0.0/8"))
|
||||
assert.Equal(t, lo0.Index, routeInterface("127.0.0.1/32"), "a host route has no netmask")
|
||||
assert.Equal(t, lo0.Index, routeInterface("::1/128"))
|
||||
assert.Equal(t, 0, routeInterface("127.0.0.0/16"), "only an exact prefix counts")
|
||||
|
||||
// Most macs also list the default route scoped to their other interfaces
|
||||
out, err := exec.Command("route", "-n", "get", "default").Output()
|
||||
require.NoError(t, err)
|
||||
var name string
|
||||
for _, line := range strings.Split(string(out), "\n") {
|
||||
if v, ok := strings.CutPrefix(strings.TrimSpace(line), "interface: "); ok {
|
||||
name = v
|
||||
}
|
||||
}
|
||||
if name == "" {
|
||||
t.Skip("no default route")
|
||||
}
|
||||
def, err := net.InterfaceByName(name)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, def.Index, routeInterface("0.0.0.0/0"))
|
||||
}
|
||||
|
||||
func TestRouteInterfaceIn_SkipsScopedCopies(t *testing.T) {
|
||||
route := func(index, flags int) netroute.Message {
|
||||
addrs := make([]netroute.Addr, unix.RTAX_MAX)
|
||||
addrs[unix.RTAX_DST] = &netroute.Inet4Addr{IP: [4]byte{192, 168, 1, 0}}
|
||||
addrs[unix.RTAX_NETMASK] = &netroute.Inet4Addr{IP: [4]byte{255, 255, 255, 0}}
|
||||
return &netroute.RouteMessage{Index: index, Flags: flags, Addrs: addrs}
|
||||
}
|
||||
p := netip.MustParsePrefix("192.168.1.0/24")
|
||||
assert.Equal(t, 7, routeInterfaceIn([]netroute.Message{route(4, unix.RTF_UP|unix.RTF_IFSCOPE), route(7, unix.RTF_UP)}, p))
|
||||
assert.Equal(t, 0, routeInterfaceIn([]netroute.Message{route(4, unix.RTF_UP|unix.RTF_IFSCOPE)}, p))
|
||||
}
|
||||
|
||||
// A reload can happen before Activate
|
||||
func TestTunRoutesBeforeActivate(t *testing.T) {
|
||||
tn := &tun{l: test.NewLogger()}
|
||||
routes := []Route{{
|
||||
Cidr: netip.MustParsePrefix("10.253.1.0/24"),
|
||||
Via: routing.Gateways{routing.NewGateway(netip.MustParseAddr("10.250.0.2"), 1)},
|
||||
Install: true,
|
||||
}}
|
||||
tn.Routes.Store(&routes)
|
||||
|
||||
assert.NoError(t, tn.addRoutes(true, nil))
|
||||
assert.NoError(t, tn.removeRoutes(routes, nil))
|
||||
}
|
||||
|
||||
// A tun.routes entry with no via is never installed, so removing it must not delete a route for the same cidr that
|
||||
// belongs to someone else
|
||||
func TestTunReloadLeavesRoutesItNeverInstalled(t *testing.T) {
|
||||
if os.Geteuid() != 0 {
|
||||
t.Skip("creating a utun and adding routes needs root")
|
||||
}
|
||||
lo0, err := net.InterfaceByName("lo0")
|
||||
require.NoError(t, err)
|
||||
cidr := "10.250.0.128/25"
|
||||
require.NoError(t, exec.Command("route", "-q", "-n", "add", "-net", cidr, "-interface", "lo0").Run())
|
||||
t.Cleanup(func() { _ = exec.Command("route", "-q", "-n", "delete", "-net", cidr).Run() })
|
||||
|
||||
l := test.NewLogger()
|
||||
c := config.NewC(l)
|
||||
require.NoError(t, c.LoadString("tun:\n routes:\n - route: "+cidr+"\n mtu: 1300\n"))
|
||||
tn, err := newTun(c, l, []netip.Prefix{netip.MustParsePrefix("10.250.0.1/24")}, false)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { _ = tn.Close() })
|
||||
require.NoError(t, tn.Activate())
|
||||
|
||||
res := c.ReloadConfigString("tun: {}\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.False(t, res.Failed, "removing a route we never installed failed the reload")
|
||||
msgs, err := fetchRoutes()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, lo0.Index, routeInterfaceIn(msgs, netip.MustParsePrefix(cidr)))
|
||||
}
|
||||
|
||||
// Only naming a different utun asks for a restart. Empty, plain utun and names that aren't utunN take whichever is free
|
||||
func TestTunDevNeedsRestart(t *testing.T) {
|
||||
for name, want := range map[string]bool{
|
||||
"": false,
|
||||
"utun": false,
|
||||
"nope": false,
|
||||
"utun7": false,
|
||||
"utun3": true,
|
||||
} {
|
||||
assert.Equal(t, want, tunDevNeedsRestart(name, "utun7"), name)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,637 @@
|
||||
//go:build !ios && !e2e_testing
|
||||
|
||||
package overlay
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"os"
|
||||
"sync/atomic"
|
||||
"syscall"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/internal/msgx"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// newSocketpairTun returns a tun writing to one end of a connected AF_UNIX datagram socketpair, which
|
||||
// takes sendmsg_x the way a utun control socket does, and the other end's fd for reading back.
|
||||
// sndbuf is the writer's send buffer, which caps the largest datagram it accepts.
|
||||
func newSocketpairTun(t *testing.T, sndbuf int) (*tun, int) {
|
||||
t.Helper()
|
||||
fds, err := unix.Socketpair(unix.AF_UNIX, unix.SOCK_DGRAM, 0)
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, unix.SetsockoptInt(fds[0], unix.SOL_SOCKET, unix.SO_SNDBUF, sndbuf))
|
||||
require.NoError(t, unix.SetsockoptInt(fds[1], unix.SOL_SOCKET, unix.SO_RCVBUF, 1<<20))
|
||||
// A dropped datagram fails the read-back instead of hanging it.
|
||||
require.NoError(t, unix.SetsockoptTimeval(fds[1], unix.SOL_SOCKET, unix.SO_RCVTIMEO, &unix.Timeval{Sec: 2}))
|
||||
require.NoError(t, unix.SetNonblock(fds[0], true))
|
||||
f := os.NewFile(uintptr(fds[0]), "socketpair")
|
||||
t.Cleanup(func() {
|
||||
_ = f.Close()
|
||||
_ = unix.Close(fds[1])
|
||||
})
|
||||
return &tun{f: f, l: test.NewLogger()}, fds[1]
|
||||
}
|
||||
|
||||
// testTunPkt returns packet i of size bytes, alternating IPv4 and IPv6, and the datagram the utun
|
||||
// device should receive for it.
|
||||
func testTunPkt(i, size int) (pkt, wire []byte) {
|
||||
pkt = make([]byte, size)
|
||||
pkt[0] = 0x45
|
||||
af := byte(syscall.AF_INET)
|
||||
if i%2 == 1 {
|
||||
pkt[0] = 0x60
|
||||
af = syscall.AF_INET6
|
||||
}
|
||||
pkt[1] = byte(i)
|
||||
pkt[2] = byte(i >> 8)
|
||||
return pkt, append([]byte{0, 0, 0, af}, pkt...)
|
||||
}
|
||||
|
||||
// readTunBack asserts r receives exactly want, in order.
|
||||
func readTunBack(t *testing.T, r int, want [][]byte) {
|
||||
t.Helper()
|
||||
buf := make([]byte, 4096)
|
||||
for i, w := range want {
|
||||
n, _, err := unix.Recvfrom(r, buf, 0)
|
||||
require.NoError(t, err, "datagram %d", i)
|
||||
if !bytes.Equal(w, buf[:n]) {
|
||||
t.Fatalf("datagram %d: got % x, want % x", i, buf[:n], w)
|
||||
}
|
||||
}
|
||||
_, _, err := unix.Recvfrom(r, buf, unix.MSG_DONTWAIT)
|
||||
assert.ErrorIs(t, err, unix.EAGAIN, "extra datagrams delivered")
|
||||
}
|
||||
|
||||
// forEachTunWritePath runs fn once over sendmsg_x and once over the per-packet writev fallback.
|
||||
func forEachTunWritePath(t *testing.T, fn func(t *testing.T, fallback bool)) {
|
||||
for _, fallback := range []bool{false, true} {
|
||||
name := "sendmsg_x"
|
||||
if fallback {
|
||||
name = "writev"
|
||||
}
|
||||
t.Run(name, func(t *testing.T) {
|
||||
noTunSendX.Store(fallback)
|
||||
t.Cleanup(func() { noTunSendX.Store(false) })
|
||||
fn(t, fallback)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestTunWriteBatch pins that WriteBatch delivers every packet whole, in order and behind the right
|
||||
// utun AF prefix, across several sendmsg_x calls, and returns nil.
|
||||
func TestTunWriteBatch(t *testing.T) {
|
||||
forEachTunWritePath(t, func(t *testing.T, fallback bool) {
|
||||
tn, r := newSocketpairTun(t, 1<<20)
|
||||
|
||||
var pkts, want [][]byte
|
||||
for i := range 3*msgx.Batch + 5 {
|
||||
p, w := testTunPkt(i, 60+i)
|
||||
pkts = append(pkts, p)
|
||||
want = append(want, w)
|
||||
}
|
||||
require.NoError(t, tn.WriteBatch(pkts))
|
||||
assert.Equal(t, fallback, noTunSendX.Load())
|
||||
readTunBack(t, r, want)
|
||||
})
|
||||
}
|
||||
|
||||
// TestTunWriteBatchSkipsInvalid pins that an empty packet or one with no IP version is skipped
|
||||
// without shifting the packets after it, and that the first such error is the one reported.
|
||||
func TestTunWriteBatchSkipsInvalid(t *testing.T) {
|
||||
forEachTunWritePath(t, func(t *testing.T, fallback bool) {
|
||||
tn, r := newSocketpairTun(t, 1<<20)
|
||||
|
||||
var pkts, want [][]byte
|
||||
for i := range 20 {
|
||||
p, w := testTunPkt(i, 60)
|
||||
pkts = append(pkts, p)
|
||||
want = append(want, w)
|
||||
}
|
||||
pkts = append(pkts[:10], append([][]byte{{0x10, 1, 2}, {}}, pkts[10:]...)...)
|
||||
|
||||
err := tn.WriteBatch(pkts)
|
||||
assert.ErrorContains(t, err, "IP version")
|
||||
readTunBack(t, r, want)
|
||||
})
|
||||
}
|
||||
|
||||
// TestTunWriteBatchOversize pins that a packet larger than the socket's send buffer drops only
|
||||
// itself and is reported, whether sendmsg_x reaches it mid-call (a short count) or first (EMSGSIZE
|
||||
// for the whole call). The send buffer is 1024 bytes and the oversize packet 2000.
|
||||
func TestTunWriteBatchOversize(t *testing.T) {
|
||||
for _, tc := range []struct {
|
||||
name string
|
||||
at int
|
||||
}{
|
||||
{"mid-call", msgx.Batch + 6},
|
||||
{"first-in-call", msgx.Batch},
|
||||
} {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
forEachTunWritePath(t, func(t *testing.T, fallback bool) {
|
||||
tn, r := newSocketpairTun(t, 1024)
|
||||
|
||||
var pkts, want [][]byte
|
||||
for i := range 2*msgx.Batch + 10 {
|
||||
size := 100
|
||||
if i == tc.at {
|
||||
size = 2000
|
||||
}
|
||||
p, w := testTunPkt(i, size)
|
||||
pkts = append(pkts, p)
|
||||
if i != tc.at {
|
||||
want = append(want, w)
|
||||
}
|
||||
}
|
||||
err := tn.WriteBatch(pkts)
|
||||
assert.ErrorIs(t, err, unix.EMSGSIZE)
|
||||
assert.Equal(t, fallback, noTunSendX.Load())
|
||||
readTunBack(t, r, want)
|
||||
})
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// forEachTunReadPath runs fn once over recvmsg_x and once over the per-packet readv drain.
|
||||
func forEachTunReadPath(t *testing.T, fn func(t *testing.T, newQ func(*tun) *tunQueue)) {
|
||||
for _, recvX := range []bool{true, false} {
|
||||
name := "recvmsg_x"
|
||||
if !recvX {
|
||||
name = "readv"
|
||||
}
|
||||
t.Run(name, func(t *testing.T) {
|
||||
fn(t, func(tn *tun) *tunQueue {
|
||||
q := newTunQueue(tn)
|
||||
if !recvX {
|
||||
q.x = nil
|
||||
}
|
||||
return q
|
||||
})
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// writeTunPkts writes n test packets of size bytes to the peer end w and returns the packets the tun should hand back
|
||||
// for them.
|
||||
func writeTunPkts(t *testing.T, w, n, size int) [][]byte {
|
||||
t.Helper()
|
||||
var want [][]byte
|
||||
for i := range n {
|
||||
pkt, wire := testTunPkt(i, size+i)
|
||||
_, err := unix.Write(w, wire)
|
||||
require.NoError(t, err)
|
||||
want = append(want, pkt)
|
||||
}
|
||||
return want
|
||||
}
|
||||
|
||||
// newReadTun is newSocketpairTun with the tun's receive buffer big enough for every test burst, since an AF_UNIX
|
||||
// datagram send is bounded by the receiver's buffer, and the writer's send buffer big enough for the largest IP packet.
|
||||
func newReadTun(t *testing.T) (*tun, int) {
|
||||
t.Helper()
|
||||
tn, w := newSocketpairTun(t, 1<<20)
|
||||
require.NoError(t, unix.SetsockoptInt(w, unix.SOL_SOCKET, unix.SO_SNDBUF, 1<<18))
|
||||
rc, err := tn.f.SyscallConn()
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, rc.Control(func(fd uintptr) {
|
||||
require.NoError(t, unix.SetsockoptInt(int(fd), unix.SOL_SOCKET, unix.SO_RCVBUF, 1<<20))
|
||||
}))
|
||||
return tn, w
|
||||
}
|
||||
|
||||
// readTunPkts calls q.Read once per entry of sizes, requires each to return that many packets, and returns copies of
|
||||
// them all.
|
||||
func readTunPkts(t *testing.T, q *tunQueue, sizes ...int) [][]byte {
|
||||
t.Helper()
|
||||
var got [][]byte
|
||||
for _, size := range sizes {
|
||||
pkts, err := q.Read()
|
||||
require.NoError(t, err)
|
||||
require.Len(t, pkts, size)
|
||||
for _, p := range pkts {
|
||||
got = append(got, p.Clone().Bytes)
|
||||
}
|
||||
}
|
||||
return got
|
||||
}
|
||||
|
||||
// stubTunRecvmsgX swaps tunRecvmsgX for fn until the test ends and counts its calls. fn gets the real msgx.Recv to
|
||||
// delegate to.
|
||||
func stubTunRecvmsgX(t *testing.T, fn func(sys func(uintptr, []msgx.Hdr) (int, syscall.Errno), fd uintptr, hdrs []msgx.Hdr) (int, syscall.Errno)) *atomic.Int64 {
|
||||
t.Helper()
|
||||
sys := tunRecvmsgX
|
||||
var calls atomic.Int64
|
||||
tunRecvmsgX = func(fd uintptr, hdrs []msgx.Hdr) (int, syscall.Errno) {
|
||||
calls.Add(1)
|
||||
return fn(sys, fd, hdrs)
|
||||
}
|
||||
t.Cleanup(func() { tunRecvmsgX = sys })
|
||||
return &calls
|
||||
}
|
||||
|
||||
// TestTunQueueReadDrains pins that Read hands back every queued packet, AF prefix stripped and in order, capped at
|
||||
// tunReadBatch per call, and doesn't wait for more once the queue is empty.
|
||||
func TestTunQueueReadDrains(t *testing.T) {
|
||||
forEachTunReadPath(t, func(t *testing.T, newQ func(*tun) *tunQueue) {
|
||||
tn, w := newReadTun(t)
|
||||
q := newQ(tn)
|
||||
want := writeTunPkts(t, w, tunReadBatch+3, 60)
|
||||
assert.Equal(t, want, readTunPkts(t, q, tunReadBatch, 3))
|
||||
})
|
||||
}
|
||||
|
||||
// TestTunQueueReadUsesRecvX pins that a burst is read with one recvmsg_x, not one call per packet.
|
||||
func TestTunQueueReadUsesRecvX(t *testing.T) {
|
||||
calls := stubTunRecvmsgX(t, func(sys func(uintptr, []msgx.Hdr) (int, syscall.Errno), fd uintptr, hdrs []msgx.Hdr) (int, syscall.Errno) {
|
||||
return sys(fd, hdrs)
|
||||
})
|
||||
tn, w := newReadTun(t)
|
||||
q := newTunQueue(tn)
|
||||
want := writeTunPkts(t, w, 10, 60)
|
||||
assert.Equal(t, want, readTunPkts(t, q, 10))
|
||||
assert.EqualValues(t, 1, calls.Load())
|
||||
assert.NotNil(t, q.x)
|
||||
}
|
||||
|
||||
// TestTunQueueReadLargePackets pins that packets up to the largest IP packet come back whole, which on the recvmsg_x
|
||||
// path means each lands in its own slot and none spills into the next.
|
||||
func TestTunQueueReadLargePackets(t *testing.T) {
|
||||
forEachTunReadPath(t, func(t *testing.T, newQ func(*tun) *tunQueue) {
|
||||
tn, w := newReadTun(t)
|
||||
q := newQ(tn)
|
||||
var want [][]byte
|
||||
for i, size := range []int{65535, 1, 9001, 65535} {
|
||||
pkt, wire := testTunPkt(i, max(size, 3))
|
||||
pkt, wire = pkt[:size], wire[:4+size]
|
||||
_, err := unix.Write(w, wire)
|
||||
require.NoError(t, err)
|
||||
want = append(want, pkt)
|
||||
}
|
||||
assert.Equal(t, want, readTunPkts(t, q, 4))
|
||||
})
|
||||
}
|
||||
|
||||
// TestTunQueueReadClipsPackets pins that each returned packet's capacity ends at its own bytes, so appending to one
|
||||
// can't overwrite the next.
|
||||
func TestTunQueueReadClipsPackets(t *testing.T) {
|
||||
forEachTunReadPath(t, func(t *testing.T, newQ func(*tun) *tunQueue) {
|
||||
tn, w := newSocketpairTun(t, 1<<20)
|
||||
q := newQ(tn)
|
||||
writeTunPkts(t, w, 2, 100)
|
||||
pkts, err := q.Read()
|
||||
require.NoError(t, err)
|
||||
require.Len(t, pkts, 2)
|
||||
assert.Equal(t, len(pkts[0].Bytes), cap(pkts[0].Bytes))
|
||||
assert.Equal(t, len(pkts[1].Bytes), cap(pkts[1].Bytes))
|
||||
})
|
||||
}
|
||||
|
||||
// TestTunQueueReadDoesNotAllocate pins both read paths to zero allocations per Read once the queue exists.
|
||||
func TestTunQueueReadDoesNotAllocate(t *testing.T) {
|
||||
forEachTunReadPath(t, func(t *testing.T, newQ func(*tun) *tunQueue) {
|
||||
tn, w := newReadTun(t)
|
||||
q := newQ(tn)
|
||||
_, wire := testTunPkt(0, 1300)
|
||||
allocs := testing.AllocsPerRun(1000, func() {
|
||||
if _, err := unix.Write(w, wire); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if pkts, err := q.Read(); err != nil || len(pkts) != 1 {
|
||||
t.Fatalf("read %d packets: %v", len(pkts), err)
|
||||
}
|
||||
})
|
||||
assert.Zero(t, allocs)
|
||||
})
|
||||
}
|
||||
|
||||
// TestTunQueueReadXRefused pins that recvmsg_x being refused turns it off for good, and that the same Read still
|
||||
// hands back the queued packets through readv.
|
||||
func TestTunQueueReadXRefused(t *testing.T) {
|
||||
for _, errno := range []syscall.Errno{unix.ENOSYS, unix.EPERM, unix.EOPNOTSUPP, unix.EINVAL} {
|
||||
t.Run(errno.Error(), func(t *testing.T) {
|
||||
calls := stubTunRecvmsgX(t, func(func(uintptr, []msgx.Hdr) (int, syscall.Errno), uintptr, []msgx.Hdr) (int, syscall.Errno) {
|
||||
return 0, errno
|
||||
})
|
||||
tn, w := newReadTun(t)
|
||||
q := newTunQueue(tn)
|
||||
want := writeTunPkts(t, w, 5, 60)
|
||||
assert.Equal(t, want, readTunPkts(t, q, 5))
|
||||
assert.Nil(t, q.x)
|
||||
assert.EqualValues(t, 1, calls.Load())
|
||||
|
||||
want = writeTunPkts(t, w, 2, 60)
|
||||
assert.Equal(t, want, readTunPkts(t, q, 2))
|
||||
assert.EqualValues(t, 1, calls.Load(), "recvmsg_x was tried again after it was refused")
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestTunQueueReadXTransientError pins that an error from recvmsg_x that doesn't mean it is refused leaves this Read
|
||||
// to readv but keeps recvmsg_x on for the next.
|
||||
func TestTunQueueReadXTransientError(t *testing.T) {
|
||||
var failed atomic.Bool
|
||||
calls := stubTunRecvmsgX(t, func(sys func(uintptr, []msgx.Hdr) (int, syscall.Errno), fd uintptr, hdrs []msgx.Hdr) (int, syscall.Errno) {
|
||||
if !failed.Swap(true) {
|
||||
return 0, unix.ENOBUFS
|
||||
}
|
||||
return sys(fd, hdrs)
|
||||
})
|
||||
tn, w := newReadTun(t)
|
||||
q := newTunQueue(tn)
|
||||
want := writeTunPkts(t, w, 3, 60)
|
||||
assert.Equal(t, want, readTunPkts(t, q, 3))
|
||||
assert.NotNil(t, q.x)
|
||||
assert.EqualValues(t, 1, calls.Load())
|
||||
|
||||
want = writeTunPkts(t, w, 2, 60)
|
||||
assert.Equal(t, want, readTunPkts(t, q, 2))
|
||||
assert.EqualValues(t, 2, calls.Load(), "recvmsg_x wasn't tried again after a transient error")
|
||||
}
|
||||
|
||||
// TestTunQueueReadXParks pins that EAGAIN from recvmsg_x parks the Read until the utun is readable, rather than
|
||||
// falling back or returning an empty batch.
|
||||
func TestTunQueueReadXParks(t *testing.T) {
|
||||
var failed atomic.Bool
|
||||
calls := stubTunRecvmsgX(t, func(sys func(uintptr, []msgx.Hdr) (int, syscall.Errno), fd uintptr, hdrs []msgx.Hdr) (int, syscall.Errno) {
|
||||
if !failed.Swap(true) {
|
||||
return 0, unix.EAGAIN
|
||||
}
|
||||
return sys(fd, hdrs)
|
||||
})
|
||||
tn, w := newReadTun(t)
|
||||
q := newTunQueue(tn)
|
||||
// A real EAGAIN means nothing is queued, so the packet arrives only once Read has parked. One packet, so the
|
||||
// wakeup can't split it across Reads.
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
defer close(done)
|
||||
time.Sleep(50 * time.Millisecond)
|
||||
_, wire := testTunPkt(0, 60)
|
||||
_, _ = unix.Write(w, wire)
|
||||
}()
|
||||
t.Cleanup(func() { <-done })
|
||||
pkt, _ := testTunPkt(0, 60)
|
||||
assert.Equal(t, [][]byte{pkt}, readTunPkts(t, q, 1))
|
||||
assert.NotNil(t, q.x)
|
||||
// A spurious wakeup costs another EAGAIN, so only a floor.
|
||||
assert.GreaterOrEqual(t, calls.Load(), int64(2))
|
||||
}
|
||||
|
||||
// TestTunQueueReadXBadBatch pins that a recvmsg_x batch no intact header could produce turns recvmsg_x off for good
|
||||
// and hands the Read to readv. The stub reports a bad batch without taking any packets, so readv then reads them all.
|
||||
func TestTunQueueReadXBadBatch(t *testing.T) {
|
||||
v4 := [4]byte{3: syscall.AF_INET}
|
||||
for _, tc := range []struct {
|
||||
name string
|
||||
mess func(x *tunRecvX) int
|
||||
}{
|
||||
{"too many", func(x *tunRecvX) int {
|
||||
for i := range x.hdrs {
|
||||
x.hdrs[i].Datalen, x.heads[i] = 64, v4
|
||||
}
|
||||
return len(x.hdrs) + 1
|
||||
}},
|
||||
{"past the buffer", func(x *tunRecvX) int {
|
||||
x.hdrs[0].Datalen, x.heads[0] = 4+tunRecvXSlot+1, v4
|
||||
return 1
|
||||
}},
|
||||
{"bad AF prefix", func(x *tunRecvX) int {
|
||||
x.hdrs[0].Datalen, x.heads[0] = 64, [4]byte{syscall.AF_INET}
|
||||
return 1
|
||||
}},
|
||||
} {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
var q *tunQueue
|
||||
stubTunRecvmsgX(t, func(func(uintptr, []msgx.Hdr) (int, syscall.Errno), uintptr, []msgx.Hdr) (int, syscall.Errno) {
|
||||
return tc.mess(q.x), 0
|
||||
})
|
||||
tn, w := newReadTun(t)
|
||||
q = newTunQueue(tn)
|
||||
want := writeTunPkts(t, w, 4, 60)
|
||||
assert.Equal(t, want, readTunPkts(t, q, 4))
|
||||
assert.Nil(t, q.x)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestTunRecvXCheck pins which recvmsg_x batches tunRecvXCheck accepts.
|
||||
func TestTunRecvXCheck(t *testing.T) {
|
||||
const slot = 1000
|
||||
v4, v6 := [4]byte{3: syscall.AF_INET}, [4]byte{3: syscall.AF_INET6}
|
||||
good := func() ([]msgx.Hdr, [][4]byte) {
|
||||
hdrs := make([]msgx.Hdr, 4)
|
||||
heads := make([][4]byte, 4)
|
||||
for i := range hdrs {
|
||||
hdrs[i].Datalen = uint64(4 + 20 + i)
|
||||
heads[i] = v4
|
||||
if i%2 == 1 {
|
||||
heads[i] = v6
|
||||
}
|
||||
}
|
||||
return hdrs, heads
|
||||
}
|
||||
for _, tc := range []struct {
|
||||
name string
|
||||
n int
|
||||
mess func(hdrs []msgx.Hdr, heads [][4]byte)
|
||||
ok bool
|
||||
}{
|
||||
{"all", 4, nil, true},
|
||||
{"none", 0, nil, true},
|
||||
{"prefix", 2, nil, true},
|
||||
{"garbage past n is ignored", 2, func(h []msgx.Hdr, hd [][4]byte) { h[3].Datalen, hd[3] = 1<<40, [4]byte{9} }, true},
|
||||
{"just the AF prefix", 1, func(h []msgx.Hdr, _ [][4]byte) { h[0].Datalen = 4 }, true},
|
||||
{"fills the slot", 1, func(h []msgx.Hdr, _ [][4]byte) { h[0].Datalen = 4 + slot }, true},
|
||||
{"more than headers", 5, nil, false},
|
||||
{"negative", -1, nil, false},
|
||||
{"past the slot", 2, func(h []msgx.Hdr, _ [][4]byte) { h[1].Datalen = 4 + slot + 1 }, false},
|
||||
{"shorter than the AF prefix", 1, func(h []msgx.Hdr, _ [][4]byte) { h[0].Datalen = 3 }, false},
|
||||
{"truncated", 3, func(h []msgx.Hdr, _ [][4]byte) { h[2].Flags = unix.MSG_TRUNC }, false},
|
||||
{"zero AF prefix", 1, func(_ []msgx.Hdr, hd [][4]byte) { hd[0] = [4]byte{} }, false},
|
||||
{"host order AF prefix", 1, func(_ []msgx.Hdr, hd [][4]byte) { hd[0] = [4]byte{syscall.AF_INET} }, false},
|
||||
{"other AF", 2, func(_ []msgx.Hdr, hd [][4]byte) { hd[1] = [4]byte{3: syscall.AF_UNIX} }, false},
|
||||
} {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
hdrs, heads := good()
|
||||
if tc.mess != nil {
|
||||
tc.mess(hdrs, heads)
|
||||
}
|
||||
err := tunRecvXCheck(tc.n, hdrs, heads, slot)
|
||||
if tc.ok {
|
||||
assert.NoError(t, err)
|
||||
} else {
|
||||
assert.Error(t, err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestTunRecvXRefused pins which recvmsg_x errnos turn it off for good.
|
||||
func TestTunRecvXRefused(t *testing.T) {
|
||||
for _, errno := range []syscall.Errno{unix.ENOSYS, unix.EPERM, unix.EOPNOTSUPP, unix.EINVAL, unix.EMSGSIZE} {
|
||||
assert.True(t, tunRecvXRefused(errno), "%v", errno)
|
||||
}
|
||||
for _, errno := range []syscall.Errno{0, unix.EAGAIN, unix.EINTR, unix.ENOBUFS, unix.ENOMEM, unix.EBADF, unix.ENOTCONN} {
|
||||
assert.False(t, tunRecvXRefused(errno), "%v", errno)
|
||||
}
|
||||
}
|
||||
|
||||
// TestTunRaisePendingPackets pins that the pending limit is set at SYSPROTO_CONTROL level after the receive buffer is
|
||||
// grown to hold that many packets of the tun's MTU, and capped to what the buffer holds when it can't grow.
|
||||
func TestTunRaisePendingPackets(t *testing.T) {
|
||||
type call struct{ level, opt, value int }
|
||||
stub := func(t *testing.T, rcvbuf int, failLevel, failOpt int) *[]call {
|
||||
set, get := tunSetsockoptInt, tunGetsockoptInt
|
||||
var calls []call
|
||||
tunSetsockoptInt = func(fd, level, opt, value int) error {
|
||||
calls = append(calls, call{level, opt, value})
|
||||
if level == failLevel && opt == failOpt {
|
||||
return unix.ENOBUFS
|
||||
}
|
||||
return nil
|
||||
}
|
||||
tunGetsockoptInt = func(fd, level, opt int) (int, error) { return rcvbuf, nil }
|
||||
t.Cleanup(func() { tunSetsockoptInt, tunGetsockoptInt = set, get })
|
||||
return &calls
|
||||
}
|
||||
for _, tc := range []struct {
|
||||
name string
|
||||
rcvbuf int
|
||||
mtu int
|
||||
failLevel int
|
||||
failOpt int
|
||||
want []call
|
||||
}{
|
||||
{"grows rcvbuf first", 1 << 16, 9000, -1, -1, []call{
|
||||
{unix.SOL_SOCKET, unix.SO_RCVBUF, 64 * 9004},
|
||||
{2, 16, 64},
|
||||
}},
|
||||
{"rcvbuf already big enough", 1 << 20, 1300, -1, -1, []call{{2, 16, 64}}},
|
||||
{"rcvbuf refused caps pending", 10 * 1304, 1300, unix.SOL_SOCKET, unix.SO_RCVBUF, []call{
|
||||
{unix.SOL_SOCKET, unix.SO_RCVBUF, 64 * 1304},
|
||||
{2, 16, 10},
|
||||
}},
|
||||
} {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
calls := stub(t, tc.rcvbuf, tc.failLevel, tc.failOpt)
|
||||
tn, _ := newSocketpairTun(t, 1<<20)
|
||||
tn.DefaultMTU = tc.mtu
|
||||
_, err := tn.Queues(1)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, tc.want, *calls)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestTun_WriteFraming(t *testing.T) {
|
||||
r, w, err := os.Pipe()
|
||||
require.NoError(t, err)
|
||||
defer r.Close()
|
||||
defer w.Close()
|
||||
tn := &tun{f: w}
|
||||
|
||||
for _, tc := range []struct {
|
||||
name string
|
||||
pkt []byte
|
||||
af byte
|
||||
}{
|
||||
// Literal families rather than syscall.AF_*, so a wrong constant in Write can't also fix the expectation.
|
||||
{"ipv4", []byte{0x45, 1, 2, 3, 4, 5}, 2},
|
||||
{"ipv6", []byte{0x60, 1, 2, 3, 4, 5}, 30},
|
||||
} {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
n, err := tn.Write(tc.pkt)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, len(tc.pkt), n)
|
||||
|
||||
got := make([]byte, 64)
|
||||
n, err = r.Read(got)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, append([]byte{0, 0, 0, tc.af}, tc.pkt...), got[:n])
|
||||
})
|
||||
}
|
||||
|
||||
_, err = tn.Write([]byte{0x10, 1, 2, 3})
|
||||
require.Error(t, err)
|
||||
_, err = tn.Write([]byte{})
|
||||
require.ErrorIs(t, err, syscall.EIO)
|
||||
|
||||
// The rejected writes must not have put anything on the fd, so the next read sees only this packet.
|
||||
pkt := []byte{0x45, 9, 9}
|
||||
_, err = tn.Write(pkt)
|
||||
require.NoError(t, err)
|
||||
got := make([]byte, 64)
|
||||
n, err := r.Read(got)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, append([]byte{0, 0, 0, 2}, pkt...), got[:n])
|
||||
}
|
||||
|
||||
func TestTun_ReadStripsHeader(t *testing.T) {
|
||||
r, w, err := os.Pipe()
|
||||
require.NoError(t, err)
|
||||
defer r.Close()
|
||||
defer w.Close()
|
||||
tn := &tun{f: r}
|
||||
|
||||
pkt := []byte{0x45, 1, 2, 3, 4, 5}
|
||||
_, err = w.Write(append([]byte{0, 0, 0, syscall.AF_INET}, pkt...))
|
||||
require.NoError(t, err)
|
||||
|
||||
got := make([]byte, 64)
|
||||
n, err := tn.Read(got)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, pkt, got[:n])
|
||||
}
|
||||
|
||||
func TestTun_ReadShort(t *testing.T) {
|
||||
r, w, err := os.Pipe()
|
||||
require.NoError(t, err)
|
||||
defer r.Close()
|
||||
defer w.Close()
|
||||
tn := &tun{f: r}
|
||||
|
||||
// Fewer bytes than the protocol header is not a packet.
|
||||
_, err = w.Write([]byte{0, 0})
|
||||
require.NoError(t, err)
|
||||
n, err := tn.Read(make([]byte, 64))
|
||||
require.NoError(t, err)
|
||||
require.Zero(t, n)
|
||||
|
||||
// The next packet reads cleanly only if the short read consumed exactly what was written.
|
||||
pkt := []byte{0x45, 1, 2, 3}
|
||||
_, err = w.Write(append([]byte{0, 0, 0, syscall.AF_INET}, pkt...))
|
||||
require.NoError(t, err)
|
||||
got := make([]byte, 64)
|
||||
n, err = tn.Read(got)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, pkt, got[:n])
|
||||
}
|
||||
|
||||
// A heap allocation per packet rarely shows in a short throughput run, only across GC pauses, so
|
||||
// this pins Read and Write to zero allocations directly.
|
||||
func TestTun_ReadWriteDoNotAllocate(t *testing.T) {
|
||||
r, w, err := os.Pipe()
|
||||
require.NoError(t, err)
|
||||
defer r.Close()
|
||||
defer w.Close()
|
||||
tw := &tun{f: w}
|
||||
tr := &tun{f: r}
|
||||
|
||||
pkts := [][]byte{bytes.Repeat([]byte{0x45}, 1300), bytes.Repeat([]byte{0x60}, 1300)}
|
||||
buf := make([]byte, 1500)
|
||||
i := 0
|
||||
allocs := testing.AllocsPerRun(1000, func() {
|
||||
i++
|
||||
if _, err := tw.Write(pkts[i%len(pkts)]); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := tr.Read(buf); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
})
|
||||
require.Zero(t, allocs)
|
||||
}
|
||||
+13
-23
@@ -370,7 +370,7 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
||||
t := &tun{
|
||||
Device: deviceName,
|
||||
vpnNetworks: vpnNetworks,
|
||||
MTU: getMTU(l, c),
|
||||
MTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||
l: l,
|
||||
fd: fd,
|
||||
shutdownR: shutdownR,
|
||||
@@ -385,18 +385,16 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
||||
},
|
||||
}
|
||||
|
||||
err = t.reload(c, true, nil)
|
||||
err = t.reload(c, true)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
closeOnErr = false
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("tun.dev", "tun.mtu")
|
||||
err := t.reload(c, false, r)
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
err := t.reload(c, false)
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
@@ -495,7 +493,7 @@ func (t *tun) Activate() error {
|
||||
}
|
||||
}
|
||||
|
||||
return t.addRoutes(false, nil)
|
||||
return t.addRoutes(false)
|
||||
}
|
||||
|
||||
func (t *tun) setMTU() error {
|
||||
@@ -511,8 +509,8 @@ func (t *tun) setMTU() error {
|
||||
return err
|
||||
}
|
||||
|
||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||
func (t *tun) reload(c *config.C, initial bool) error {
|
||||
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -532,18 +530,16 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
|
||||
if !initial {
|
||||
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes), r)
|
||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
|
||||
// Ensure any routes we actually want are installed
|
||||
err = t.addRoutes(true, r)
|
||||
err = t.addRoutes(true)
|
||||
if err != nil {
|
||||
// Catch any stray logs
|
||||
util.LogWithContextIfNeeded("Failed to add routes", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -567,7 +563,7 @@ func (t *tun) Queues(int) ([]tio.Queue, error) {
|
||||
return []tio.Queue{tio.NewSingleQueue(t, defaultBatchBufSize)}, nil
|
||||
}
|
||||
|
||||
func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
func (t *tun) addRoutes(logErrors bool) error {
|
||||
routes := *t.Routes.Load()
|
||||
for _, r := range routes {
|
||||
if len(r.Via) == 0 || !r.Install {
|
||||
@@ -580,7 +576,6 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||
if logErrors {
|
||||
retErr.Log(t.l)
|
||||
rl.Failed()
|
||||
} else {
|
||||
return retErr
|
||||
}
|
||||
@@ -592,20 +587,15 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tun) removeRoutes(routes []Route, rl *config.Reload) error {
|
||||
func (t *tun) removeRoutes(routes []Route) error {
|
||||
for _, r := range routes {
|
||||
if len(r.Via) == 0 || !r.Install {
|
||||
// addRoutes never installs these
|
||||
if !r.Install {
|
||||
continue
|
||||
}
|
||||
|
||||
err := delRoute(r.Cidr, t.linkAddr)
|
||||
if errors.Is(err, unix.ESRCH) {
|
||||
// Already gone, which is what we wanted
|
||||
t.l.Info("Route was already removed", "route", r)
|
||||
} else if err != nil {
|
||||
if err != nil {
|
||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||
rl.Failed()
|
||||
} else {
|
||||
t.l.Info("Removed route", "route", r)
|
||||
}
|
||||
|
||||
+5
-6
@@ -47,17 +47,16 @@ func newTunFromFd(c *config.C, l *slog.Logger, deviceFd int, vpnNetworks []netip
|
||||
l: l,
|
||||
}
|
||||
|
||||
err := t.reload(c, true, nil)
|
||||
err := t.reload(c, true)
|
||||
if err != nil {
|
||||
_ = file.Close()
|
||||
return nil, err
|
||||
}
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
err := t.reload(c, false, r)
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
err := t.reload(c, false)
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
@@ -68,8 +67,8 @@ func (t *tun) Activate() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||
func (t *tun) reload(c *config.C, initial bool) error {
|
||||
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
+18
-41
@@ -185,10 +185,6 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, multiqueue
|
||||
}
|
||||
|
||||
t.Device = name
|
||||
// Only read when we create the device, an fd handed to us already has its name and offloads
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("tun.dev", "tun.use_offloads")
|
||||
})
|
||||
|
||||
return t, nil
|
||||
}
|
||||
@@ -225,32 +221,30 @@ func newTunGeneric(c *config.C, l *slog.Logger, fd int, vnetHdr bool, offloadFla
|
||||
vnetHdr: vnetHdr,
|
||||
offloadFlags: offloadFlags,
|
||||
vpnNetworks: vpnNetworks,
|
||||
TXQueueLen: c.GetInt("tun.tx_queue", 5000),
|
||||
TXQueueLen: c.GetInt("tun.tx_queue", 500),
|
||||
useSystemRoutes: c.GetBool("tun.use_system_route_table", false),
|
||||
useSystemRoutesBufferSize: c.GetInt("tun.use_system_route_table_buffer_size", 0),
|
||||
routesFromSystem: map[netip.Prefix]routing.Gateways{},
|
||||
l: l,
|
||||
}
|
||||
|
||||
if err = t.reload(c, true, nil); err != nil {
|
||||
if err = t.reload(c, true); err != nil {
|
||||
_ = t.Close()
|
||||
return nil, err
|
||||
}
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("tun.tx_queue", "tun.use_system_route_table", "tun.use_system_route_table_buffer_size")
|
||||
err := t.reload(c, false, r)
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
err := t.reload(c, false)
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
return t, nil
|
||||
}
|
||||
|
||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
routeChange, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||
func (t *tun) reload(c *config.C, initial bool) error {
|
||||
routeChange, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -259,15 +253,6 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
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)
|
||||
if err != nil {
|
||||
return err
|
||||
@@ -282,14 +267,14 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
|
||||
oldDefaultMTU := t.DefaultMTU
|
||||
oldMaxMTU := t.MaxMTU
|
||||
newDefaultMTU := getMTU(t.l, c)
|
||||
newDefaultMTU := c.GetInt("tun.mtu", DefaultMTU)
|
||||
newMaxMTU := newDefaultMTU
|
||||
for i, r := range routes {
|
||||
if r.MTU == 0 {
|
||||
routes[i].MTU = newDefaultMTU
|
||||
}
|
||||
|
||||
if r.MTU > newMaxMTU {
|
||||
if r.MTU > t.MaxMTU {
|
||||
newMaxMTU = r.MTU
|
||||
}
|
||||
}
|
||||
@@ -303,7 +288,7 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
|
||||
if !initial {
|
||||
if oldMaxMTU != newMaxMTU {
|
||||
t.setMTU(r)
|
||||
t.setMTU()
|
||||
t.l.Info("Set max MTU", "mtu", t.MaxMTU, "oldMTU", oldMaxMTU)
|
||||
}
|
||||
|
||||
@@ -311,8 +296,7 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
for i := range t.vpnNetworks {
|
||||
err := t.setDefaultRoute(t.vpnNetworks[i])
|
||||
if err != nil {
|
||||
t.l.Error(err.Error())
|
||||
r.Failed()
|
||||
t.l.Warn(err.Error())
|
||||
} else {
|
||||
t.l.Info("Set default MTU", "mtu", t.DefaultMTU, "oldMTU", oldDefaultMTU)
|
||||
}
|
||||
@@ -320,14 +304,13 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
}
|
||||
|
||||
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
||||
t.removeRoutes(findRemovedRoutes(routes, *oldRoutes), r)
|
||||
t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
|
||||
|
||||
// Ensure any routes we actually want are installed
|
||||
err = t.addRoutes(true, r)
|
||||
err = t.addRoutes(true)
|
||||
if err != nil {
|
||||
// This should never be called since addRoutes should log its own errors in a reload condition
|
||||
util.LogWithContextIfNeeded("Failed to refresh routes", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -482,7 +465,7 @@ func (t *tun) Activate() error {
|
||||
t.deviceIndex = link.Attrs().Index
|
||||
|
||||
// Setup our default MTU
|
||||
t.setMTU(nil)
|
||||
t.setMTU()
|
||||
|
||||
// Set the transmit queue length
|
||||
ifrq := ifreqQLEN{Name: devName, Value: int32(t.TXQueueLen)}
|
||||
@@ -514,7 +497,7 @@ func (t *tun) Activate() error {
|
||||
}
|
||||
|
||||
// Set the routes
|
||||
if err = t.addRoutes(false, nil); err != nil {
|
||||
if err = t.addRoutes(false); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
@@ -527,13 +510,12 @@ func (t *tun) Activate() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tun) setMTU(r *config.Reload) {
|
||||
func (t *tun) setMTU() {
|
||||
// Set the MTU on the device
|
||||
ifm := ifreqMTU{Name: t.deviceBytes(), MTU: int32(t.MaxMTU)}
|
||||
if err := ioctl(t.ioctlFd, unix.SIOCSIFMTU, uintptr(unsafe.Pointer(&ifm))); err != nil {
|
||||
// This is currently a non fatal condition because the route table must have the MTU set appropriately as well
|
||||
t.l.Error("Failed to set tun mtu", "error", err)
|
||||
r.Failed()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -586,7 +568,7 @@ func (t *tun) setDefaultRoute(cidr netip.Prefix) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
func (t *tun) addRoutes(logErrors bool) error {
|
||||
// Path routes
|
||||
routes := *t.Routes.Load()
|
||||
for _, r := range routes {
|
||||
@@ -616,7 +598,6 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||
if logErrors {
|
||||
retErr.Log(t.l)
|
||||
rl.Failed()
|
||||
} else {
|
||||
return retErr
|
||||
}
|
||||
@@ -628,7 +609,7 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tun) removeRoutes(routes []Route, rl *config.Reload) {
|
||||
func (t *tun) removeRoutes(routes []Route) {
|
||||
for _, r := range routes {
|
||||
if !r.Install {
|
||||
continue
|
||||
@@ -652,12 +633,8 @@ func (t *tun) removeRoutes(routes []Route, rl *config.Reload) {
|
||||
}
|
||||
|
||||
err := netlink.RouteDel(&nr)
|
||||
if errors.Is(err, unix.ESRCH) {
|
||||
// Already gone, which is what we wanted
|
||||
t.l.Info("Route was already removed", "route", r)
|
||||
} else if err != nil {
|
||||
if err != nil {
|
||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||
rl.Failed()
|
||||
} else {
|
||||
t.l.Info("Removed route", "route", r)
|
||||
}
|
||||
|
||||
+27
-27
@@ -8,6 +8,7 @@ import (
|
||||
"log/slog"
|
||||
"net/netip"
|
||||
"os"
|
||||
"regexp"
|
||||
"sync/atomic"
|
||||
"syscall"
|
||||
"unsafe"
|
||||
@@ -66,12 +67,24 @@ type tun struct {
|
||||
fd int
|
||||
}
|
||||
|
||||
var deviceNameRE = regexp.MustCompile(`^tun[0-9]+$`)
|
||||
|
||||
func newTunFromFd(_ *config.C, _ *slog.Logger, _ int, _ []netip.Prefix) (*tun, error) {
|
||||
return nil, fmt.Errorf("newTunFromFd not supported in NetBSD")
|
||||
}
|
||||
|
||||
func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*tun, error) {
|
||||
fd, deviceName, err := openTun(l, c.GetString("tun.dev", ""))
|
||||
// Try to open tun device
|
||||
var err error
|
||||
deviceName := c.GetString("tun.dev", "")
|
||||
if deviceName == "" {
|
||||
return nil, fmt.Errorf("a device name in the format of /dev/tunN must be specified")
|
||||
}
|
||||
if !deviceNameRE.MatchString(deviceName) {
|
||||
return nil, fmt.Errorf("a device name in the format of /dev/tunN must be specified")
|
||||
}
|
||||
|
||||
fd, err := unix.Open("/dev/"+deviceName, os.O_RDWR, 0)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -86,24 +99,19 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
||||
fd: fd,
|
||||
Device: deviceName,
|
||||
vpnNetworks: vpnNetworks,
|
||||
MTU: getMTU(l, c),
|
||||
MTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||
l: l,
|
||||
}
|
||||
|
||||
err = t.reload(c, true, nil)
|
||||
err = t.reload(c, true)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("tun.mtu")
|
||||
if tunDevNeedsRestart(c.GetString("tun.dev", ""), t.Device) {
|
||||
r.RestartRequiredIfChanged("tun.dev")
|
||||
}
|
||||
err := t.reload(c, false, r)
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
err := t.reload(c, false)
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
@@ -316,7 +324,7 @@ func (t *tun) Activate() error {
|
||||
}
|
||||
}
|
||||
|
||||
return t.addRoutes(false, nil)
|
||||
return t.addRoutes(false)
|
||||
}
|
||||
|
||||
func (t *tun) doIoctlByName(ctl uintptr, value uint32) error {
|
||||
@@ -331,8 +339,8 @@ func (t *tun) doIoctlByName(ctl uintptr, value uint32) error {
|
||||
return err
|
||||
}
|
||||
|
||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||
func (t *tun) reload(c *config.C, initial bool) error {
|
||||
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -352,18 +360,16 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
|
||||
if !initial {
|
||||
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes), r)
|
||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
|
||||
// Ensure any routes we actually want are installed
|
||||
err = t.addRoutes(true, r)
|
||||
err = t.addRoutes(true)
|
||||
if err != nil {
|
||||
// Catch any stray logs
|
||||
util.LogWithContextIfNeeded("Failed to add routes", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -387,7 +393,7 @@ func (t *tun) Queues(int) ([]tio.Queue, error) {
|
||||
return []tio.Queue{tio.NewSingleQueue(t, defaultBatchBufSize)}, nil
|
||||
}
|
||||
|
||||
func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
func (t *tun) addRoutes(logErrors bool) error {
|
||||
routes := *t.Routes.Load()
|
||||
|
||||
for _, r := range routes {
|
||||
@@ -401,7 +407,6 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||
if logErrors {
|
||||
retErr.Log(t.l)
|
||||
rl.Failed()
|
||||
} else {
|
||||
return retErr
|
||||
}
|
||||
@@ -413,20 +418,15 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tun) removeRoutes(routes []Route, rl *config.Reload) error {
|
||||
func (t *tun) removeRoutes(routes []Route) error {
|
||||
for _, r := range routes {
|
||||
if len(r.Via) == 0 || !r.Install {
|
||||
// addRoutes never installs these
|
||||
if !r.Install {
|
||||
continue
|
||||
}
|
||||
|
||||
err := delRoute(r.Cidr, t.vpnNetworks)
|
||||
if errors.Is(err, unix.ESRCH) {
|
||||
// Already gone, which is what we wanted
|
||||
t.l.Info("Route was already removed", "route", r)
|
||||
} else if err != nil {
|
||||
if err != nil {
|
||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||
rl.Failed()
|
||||
} else {
|
||||
t.l.Info("Removed route", "route", r)
|
||||
}
|
||||
|
||||
+27
-27
@@ -8,6 +8,7 @@ import (
|
||||
"log/slog"
|
||||
"net/netip"
|
||||
"os"
|
||||
"regexp"
|
||||
"sync/atomic"
|
||||
"syscall"
|
||||
"unsafe"
|
||||
@@ -57,12 +58,24 @@ type tun struct {
|
||||
fd int
|
||||
}
|
||||
|
||||
var deviceNameRE = regexp.MustCompile(`^tun[0-9]+$`)
|
||||
|
||||
func newTunFromFd(_ *config.C, _ *slog.Logger, _ int, _ []netip.Prefix) (*tun, error) {
|
||||
return nil, fmt.Errorf("newTunFromFd not supported in openbsd")
|
||||
}
|
||||
|
||||
func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*tun, error) {
|
||||
fd, deviceName, err := openTun(l, c.GetString("tun.dev", ""))
|
||||
// Try to open tun device
|
||||
var err error
|
||||
deviceName := c.GetString("tun.dev", "")
|
||||
if deviceName == "" {
|
||||
return nil, fmt.Errorf("a device name in the format of /dev/tunN must be specified")
|
||||
}
|
||||
if !deviceNameRE.MatchString(deviceName) {
|
||||
return nil, fmt.Errorf("a device name in the format of /dev/tunN must be specified")
|
||||
}
|
||||
|
||||
fd, err := unix.Open("/dev/"+deviceName, os.O_RDWR, 0)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -77,24 +90,19 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
||||
fd: fd,
|
||||
Device: deviceName,
|
||||
vpnNetworks: vpnNetworks,
|
||||
MTU: getMTU(l, c),
|
||||
MTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||
l: l,
|
||||
}
|
||||
|
||||
err = t.reload(c, true, nil)
|
||||
err = t.reload(c, true)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("tun.mtu")
|
||||
if tunDevNeedsRestart(c.GetString("tun.dev", ""), t.Device) {
|
||||
r.RestartRequiredIfChanged("tun.dev")
|
||||
}
|
||||
err := t.reload(c, false, r)
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
err := t.reload(c, false)
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
@@ -295,7 +303,7 @@ func (t *tun) Activate() error {
|
||||
}
|
||||
}
|
||||
|
||||
return t.addRoutes(false, nil)
|
||||
return t.addRoutes(false)
|
||||
}
|
||||
|
||||
func (t *tun) doIoctlByName(ctl uintptr, value uint32) error {
|
||||
@@ -310,8 +318,8 @@ func (t *tun) doIoctlByName(ctl uintptr, value uint32) error {
|
||||
return err
|
||||
}
|
||||
|
||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||
func (t *tun) reload(c *config.C, initial bool) error {
|
||||
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -331,18 +339,16 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
|
||||
if !initial {
|
||||
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes), r)
|
||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
|
||||
// Ensure any routes we actually want are installed
|
||||
err = t.addRoutes(true, r)
|
||||
err = t.addRoutes(true)
|
||||
if err != nil {
|
||||
// Catch any stray logs
|
||||
util.LogWithContextIfNeeded("Failed to add routes", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -366,7 +372,7 @@ func (t *tun) Queues(int) ([]tio.Queue, error) {
|
||||
return []tio.Queue{tio.NewSingleQueue(t, defaultBatchBufSize)}, nil
|
||||
}
|
||||
|
||||
func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
func (t *tun) addRoutes(logErrors bool) error {
|
||||
routes := *t.Routes.Load()
|
||||
|
||||
for _, r := range routes {
|
||||
@@ -380,7 +386,6 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||
if logErrors {
|
||||
retErr.Log(t.l)
|
||||
rl.Failed()
|
||||
} else {
|
||||
return retErr
|
||||
}
|
||||
@@ -392,20 +397,15 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tun) removeRoutes(routes []Route, rl *config.Reload) error {
|
||||
func (t *tun) removeRoutes(routes []Route) error {
|
||||
for _, r := range routes {
|
||||
if len(r.Via) == 0 || !r.Install {
|
||||
// addRoutes never installs these
|
||||
if !r.Install {
|
||||
continue
|
||||
}
|
||||
|
||||
err := delRoute(r.Cidr, t.vpnNetworks)
|
||||
if errors.Is(err, unix.ESRCH) {
|
||||
// Already gone, which is what we wanted
|
||||
t.l.Info("Route was already removed", "route", r)
|
||||
} else if err != nil {
|
||||
if err != nil {
|
||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||
rl.Failed()
|
||||
} else {
|
||||
t.l.Info("Removed route", "route", r)
|
||||
}
|
||||
|
||||
@@ -1,107 +0,0 @@
|
||||
//go:build !e2e_testing
|
||||
|
||||
package overlay
|
||||
|
||||
import (
|
||||
"net/netip"
|
||||
"os"
|
||||
"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, nil))
|
||||
|
||||
require.NoError(t, c.ReloadConfigString("tun:\n mtu: 1400\n"+routes).Err)
|
||||
_ = tn.reload(c, false, nil)
|
||||
|
||||
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, nil))
|
||||
assert.Equal(t, 1500, tn.MaxMTU)
|
||||
assert.Equal(t, 1300, tn.DefaultMTU)
|
||||
}
|
||||
|
||||
// There is no device behind this tun, so adding a route always fails. Removing one is refused without root, as root the
|
||||
// kernel answers that the route isn't there, which is what we wanted
|
||||
func TestReloadRouteFailures(t *testing.T) {
|
||||
route := "tun:\n mtu: 1300\n unsafe_routes:\n - route: 192.168.100.0/24\n via: 10.1.0.1\n"
|
||||
cases := []struct {
|
||||
name string
|
||||
from, to string
|
||||
wantFails bool
|
||||
}{
|
||||
{"added", "tun:\n mtu: 1300\n", route, true},
|
||||
{"removed", route, "tun:\n mtu: 1300\n", os.Geteuid() != 0},
|
||||
{"unchanged", route, route + "punchy:\n punch: true\n", false},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(tc.from))
|
||||
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, nil))
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
require.NoError(t, tn.reload(c, false, r))
|
||||
})
|
||||
|
||||
res := c.ReloadConfigString(tc.to)
|
||||
require.NoError(t, res.Err)
|
||||
assert.Equal(t, tc.wantFails, res.Failed)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Keys only read when the device is created need a restart to apply
|
||||
func TestTunReloadRestartKeys(t *testing.T) {
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString("tun:\n dev: nebrk0\n"))
|
||||
tn, err := NewDeviceFromConfig(c, test.NewLogger(), []netip.Prefix{netip.MustParsePrefix("10.1.0.2/24")}, 1)
|
||||
if err != nil {
|
||||
t.Skipf("can't create a tun device here: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _ = tn.Close() })
|
||||
|
||||
res := c.ReloadConfigString("tun:\n disabled: true\n dev: nebrk1\n tx_queue: 100\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.ElementsMatch(t, []string{"tun.disabled", "tun.dev", "tun.tx_queue"}, res.RestartKeys)
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
package overlay
|
||||
|
||||
import (
|
||||
"net/netip"
|
||||
"testing"
|
||||
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// tun.disabled and the disabled tun's settings are only read when the device is made
|
||||
func TestDisabledTunRestartKeys(t *testing.T) {
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString("tun:\n disabled: true\n"))
|
||||
d, err := NewDeviceFromConfig(c, test.NewLogger(), []netip.Prefix{netip.MustParsePrefix("10.1.0.2/24")}, 1)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { _ = d.Close() })
|
||||
|
||||
res := c.ReloadConfigString("tun:\n disabled: false\n tx_queue: 100\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.ElementsMatch(t, []string{"tun.disabled", "tun.tx_queue"}, res.RestartKeys)
|
||||
}
|
||||
@@ -31,7 +31,7 @@ type TestTun struct {
|
||||
}
|
||||
|
||||
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 {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
+14
-106
@@ -4,7 +4,6 @@ package overlay
|
||||
|
||||
import (
|
||||
"crypto"
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"net/netip"
|
||||
@@ -76,7 +75,7 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*w
|
||||
t := &winTun{
|
||||
Device: deviceName,
|
||||
vpnNetworks: vpnNetworks,
|
||||
MTU: getMTU(l, c),
|
||||
MTU: c.GetInt("tun.mtu", DefaultMTU),
|
||||
guid: *guid,
|
||||
networkCategory: cat,
|
||||
setCategory: setCat,
|
||||
@@ -84,7 +83,7 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*w
|
||||
l: l,
|
||||
}
|
||||
|
||||
err = t.reload(c, true, nil)
|
||||
err = t.reload(c, true)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -105,32 +104,18 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*w
|
||||
}
|
||||
t.tun = tunDevice.(*wintun.NativeTun)
|
||||
|
||||
// Disable registration before Activate assigns addresses and triggers it.
|
||||
disableDNSRegistration(l, *guid)
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("tun.dev", "tun.mtu")
|
||||
// Compare with the running category, not the last config. A restart with one we can't parse would fail, so say
|
||||
// that now rather than ask for one, and going back to the running one after a bad reload needs no restart
|
||||
if cat, setCat, err := parseNetworkCategory(c.GetString("tun.network_category", "private")); err != nil {
|
||||
t.l.Error("Invalid tun.network_category, a restart with it would fail", "error", err)
|
||||
r.Failed()
|
||||
} else if cat != t.networkCategory || setCat != t.setCategory {
|
||||
r.RestartRequiredIfChanged("tun.network_category")
|
||||
}
|
||||
r.RestartRequiredIfChanged(interfaceBypassKeys...)
|
||||
err := t.reload(c, false, r)
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
err := t.reload(c, false)
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
return t, nil
|
||||
}
|
||||
|
||||
func (t *winTun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||
func (t *winTun) reload(c *config.C, initial bool) error {
|
||||
change, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -150,18 +135,16 @@ func (t *winTun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
|
||||
if !initial {
|
||||
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
||||
err := t.removeRoutes(findRemovedSystemRoutes(routes, *oldRoutes), r)
|
||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
|
||||
if err != nil {
|
||||
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
|
||||
// Ensure any routes we actually want are installed
|
||||
err = t.addRoutes(true, r)
|
||||
err = t.addRoutes(true)
|
||||
if err != nil {
|
||||
// Catch any stray logs
|
||||
util.LogWithContextIfNeeded("Failed to add routes", err, t.l)
|
||||
r.Failed()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -176,7 +159,7 @@ func (t *winTun) Activate() error {
|
||||
return fmt.Errorf("failed to set address: %w", err)
|
||||
}
|
||||
|
||||
err = t.addRoutes(false, nil)
|
||||
err = t.addRoutes(false)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -195,49 +178,33 @@ func (t *winTun) Activate() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *winTun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
func (t *winTun) addRoutes(logErrors bool) error {
|
||||
luid := winipcfg.LUID(t.tun.LUID())
|
||||
routes := *t.Routes.Load()
|
||||
foundDefault4 := false
|
||||
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
|
||||
// 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 {
|
||||
for _, r := range routes {
|
||||
if len(r.Via) == 0 || !r.Install {
|
||||
// We don't allow route MTUs so only install routes with a via
|
||||
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.
|
||||
carriesV6 = carriesV6 || r.Cidr.Addr().Is6()
|
||||
|
||||
// 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 {
|
||||
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||
if logErrors {
|
||||
retErr.Log(t.l)
|
||||
rl.Failed()
|
||||
continue
|
||||
} else {
|
||||
return retErr
|
||||
}
|
||||
} else {
|
||||
switch result {
|
||||
case routeAdded:
|
||||
t.l.Info("Added route", "route", r)
|
||||
case routeMetricUpdated:
|
||||
t.l.Info("Updated route metric", "route", r)
|
||||
}
|
||||
}
|
||||
|
||||
if !foundDefault4 {
|
||||
@@ -288,7 +255,7 @@ func (t *winTun) setMTU(luid winipcfg.LUID, foundDefault4, carriesV6 bool) error
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *winTun) removeRoutes(routes []Route, rl *config.Reload) error {
|
||||
func (t *winTun) removeRoutes(routes []Route) error {
|
||||
luid := winipcfg.LUID(t.tun.LUID())
|
||||
|
||||
for _, r := range routes {
|
||||
@@ -298,12 +265,8 @@ func (t *winTun) removeRoutes(routes []Route, rl *config.Reload) error {
|
||||
|
||||
// See comment on luid.AddRoute
|
||||
err := luid.DeleteRoute(r.Cidr, unspecifiedNextHop(r.Cidr))
|
||||
if errors.Is(err, windows.ERROR_NOT_FOUND) {
|
||||
// Already gone, which is what we wanted
|
||||
t.l.Info("Route was already removed", "route", r)
|
||||
} else if err != nil {
|
||||
if err != nil {
|
||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||
rl.Failed()
|
||||
} else {
|
||||
t.l.Info("Removed route", "route", r)
|
||||
}
|
||||
@@ -353,61 +316,6 @@ func (t *winTun) Close() error {
|
||||
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 {
|
||||
if p.Addr().Is4() {
|
||||
return netip.IPv4Unspecified()
|
||||
|
||||
@@ -1,209 +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
|
||||
}
|
||||
|
||||
// reload applies cfg and expects nothing in it to fail
|
||||
func (rt *routeTest) reload(t *testing.T, cfg string) {
|
||||
t.Helper()
|
||||
res := rt.c.ReloadConfigString(cfg)
|
||||
require.NoError(t, res.Err)
|
||||
assert.False(t, res.Failed, "the reload reported a failure")
|
||||
}
|
||||
|
||||
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())
|
||||
|
||||
rt.reload(t, 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))
|
||||
|
||||
rt.reload(t, 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))
|
||||
|
||||
rt.reload(t, 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())
|
||||
|
||||
rt.reload(t, 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())
|
||||
rt.reload(t, routes)
|
||||
_, err = rt.luid.Route(cidr, unspecifiedNextHop(cidr))
|
||||
assert.Error(t, err, "the reload left it installed")
|
||||
})
|
||||
}
|
||||
|
||||
// Removing a route that is already gone is what we wanted, not a failure
|
||||
func TestWinTun_ReloadRouteAlreadyGone(t *testing.T) {
|
||||
forFamilies(t, func(t *testing.T, a, b string) {
|
||||
rt := newRouteTest(t, unsafeRoutes(a, b))
|
||||
require.NoError(t, rt.tun.Activate())
|
||||
p := netip.MustParsePrefix(b)
|
||||
require.NoError(t, rt.luid.DeleteRoute(p, unspecifiedNextHop(p)))
|
||||
|
||||
rt.reload(t, unsafeRoutes(a))
|
||||
})
|
||||
}
|
||||
|
||||
// A network category we can't parse would fail the restart, so it fails the reload instead of asking for one
|
||||
func TestWinTun_ReloadInvalidNetworkCategoryFails(t *testing.T) {
|
||||
rt := newRouteTest(t, unsafeRoutes())
|
||||
for range 2 {
|
||||
res := rt.c.ReloadConfigString(unsafeRoutes() + " network_category: nope\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.Failed, "a bad category that didn't change since the last reload is still bad")
|
||||
assert.False(t, res.RestartRequired)
|
||||
}
|
||||
|
||||
// Fixing it back to the running category needs nothing
|
||||
res := rt.c.ReloadConfigString(unsafeRoutes() + " network_category: private\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.False(t, res.Failed)
|
||||
assert.False(t, res.RestartRequired)
|
||||
|
||||
res = rt.c.ReloadConfigString(unsafeRoutes() + " network_category: public\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.Equal(t, []string{"tun.network_category"}, res.RestartKeys)
|
||||
}
|
||||
|
||||
// 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") })
|
||||
}
|
||||
@@ -2,9 +2,7 @@ package nebula
|
||||
|
||||
import (
|
||||
"crypto/fips140"
|
||||
"crypto/sha256"
|
||||
"encoding/binary"
|
||||
"encoding/hex"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
@@ -52,30 +50,15 @@ type CertState struct {
|
||||
myVpnBroadcastAddrsTable *bart.Lite
|
||||
}
|
||||
|
||||
// errCertNeedsRestart marks a new cert that is refused on reload because only a restart can apply it
|
||||
var errCertNeedsRestart = errors.New("a restart is required to use the new cert")
|
||||
|
||||
func NewPKIFromConfig(l *slog.Logger, c *config.C) (*PKI, error) {
|
||||
pki := &PKI{l: l}
|
||||
err := pki.reload(c, true, nil)
|
||||
err := pki.reload(c, true)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
// Compare with the running cipher, not the last config. A restart with one we can't run would fail, so say that
|
||||
// now rather than ask for one, and going back to the running one after a bad reload needs no restart
|
||||
if cipher := c.GetString("cipher", "aes"); !validCipher(cipher) {
|
||||
l.Error("Unknown cipher, a restart with it would fail", "cipher", cipher)
|
||||
r.Failed()
|
||||
} else if cipher == "chachapoly" && fipsOnly() {
|
||||
// newCipherSuite refuses it at startup
|
||||
l.Error("ChaChaPoly is not allowed in FIPS 140-only mode, a restart with it would fail", "cipher", cipher)
|
||||
r.Failed()
|
||||
} else if cipher != pki.getCertState().cipher {
|
||||
r.RestartRequiredIfChanged("cipher")
|
||||
}
|
||||
rErr := pki.reload(c, false, r)
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
rErr := pki.reload(c, false)
|
||||
if rErr != nil {
|
||||
util.LogWithContextIfNeeded("Failed to reload PKI from config", rErr, l)
|
||||
}
|
||||
@@ -92,29 +75,13 @@ func (p *PKI) getCertState() *CertState {
|
||||
return p.cs.Load()
|
||||
}
|
||||
|
||||
// r is nil on the initial load
|
||||
func (p *PKI) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
before := p.cs.Load()
|
||||
func (p *PKI) reload(c *config.C, initial bool) error {
|
||||
err := p.reloadCerts(c, initial)
|
||||
if err != nil {
|
||||
if initial {
|
||||
return err
|
||||
}
|
||||
err.Log(p.l)
|
||||
if errors.Is(err, errCertNeedsRestart) {
|
||||
r.RestartRequired()
|
||||
} else {
|
||||
r.Failed()
|
||||
}
|
||||
} else if !initial {
|
||||
// A cert for a version we weren't running is accepted without comparing its networks to ours. The tun and the
|
||||
// lighthouse keep the networks they started with
|
||||
after := p.cs.Load()
|
||||
if !slices.Equal(before.myVpnNetworks, after.myVpnNetworks) {
|
||||
p.l.Warn("The new cert changes our networks, a restart is required to use them",
|
||||
"old_networks", before.myVpnNetworks, "new_networks", after.myVpnNetworks)
|
||||
r.RestartRequired()
|
||||
}
|
||||
}
|
||||
|
||||
err = p.reloadCAPool(c)
|
||||
@@ -123,27 +90,21 @@ func (p *PKI) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
return err
|
||||
}
|
||||
err.Log(p.l)
|
||||
r.Failed()
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// fipsOnly is fips140.Enforced, a variable so a test can run the FIPS 140-only reload check without GODEBUG
|
||||
var fipsOnly = fips140.Enforced
|
||||
|
||||
// validCipher is true for the ciphers nebula can run. Each post-handshake CipherState in noiseutil hardcodes its own
|
||||
// nonce endianness, so there's nothing to set up for either.
|
||||
func validCipher(cipher string) bool {
|
||||
return cipher == "aes" || cipher == "chachapoly"
|
||||
}
|
||||
|
||||
func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
||||
var cipher string
|
||||
var currentState *CertState
|
||||
if initial {
|
||||
cipher = c.GetString("cipher", "aes")
|
||||
if !validCipher(cipher) {
|
||||
switch cipher {
|
||||
case "aes", "chachapoly":
|
||||
// Each post-handshake CipherState in noiseutil hardcodes its own
|
||||
// nonce endianness now, so there's nothing to set up here.
|
||||
default:
|
||||
return util.NewContextualError(
|
||||
"unknown cipher",
|
||||
m{"cipher": cipher},
|
||||
@@ -171,7 +132,7 @@ func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
||||
return util.NewContextualError(
|
||||
"Networks in new cert was different from old",
|
||||
m{"new_networks": newState.v1Cert.Networks(), "old_networks": currentState.v1Cert.Networks(), "cert_version": cert.Version1},
|
||||
errCertNeedsRestart,
|
||||
nil,
|
||||
)
|
||||
}
|
||||
|
||||
@@ -179,7 +140,7 @@ func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
||||
return util.NewContextualError(
|
||||
"Curve in new v1 cert was different from old",
|
||||
m{"new_curve": newState.v1Cert.Curve(), "old_curve": currentState.v1Cert.Curve(), "cert_version": cert.Version1},
|
||||
errCertNeedsRestart,
|
||||
nil,
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -194,7 +155,7 @@ func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
||||
return util.NewContextualError(
|
||||
"Networks in new cert was different from old",
|
||||
m{"new_networks": newState.v2Cert.Networks(), "old_networks": currentState.v2Cert.Networks(), "cert_version": cert.Version2},
|
||||
errCertNeedsRestart,
|
||||
nil,
|
||||
)
|
||||
}
|
||||
|
||||
@@ -202,7 +163,7 @@ func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
||||
return util.NewContextualError(
|
||||
"Curve in new cert was different from old",
|
||||
m{"new_curve": newState.v2Cert.Curve(), "old_curve": currentState.v2Cert.Curve(), "cert_version": cert.Version2},
|
||||
errCertNeedsRestart,
|
||||
nil,
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -217,7 +178,7 @@ func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
||||
return util.NewContextualError(
|
||||
"Removing a V2 cert is not permitted unless it has identical networks to the new V1 cert",
|
||||
m{"new_v1_networks": newState.v1Cert.Networks(), "old_v2_networks": currentState.v2Cert.Networks()},
|
||||
errCertNeedsRestart,
|
||||
nil,
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -235,14 +196,12 @@ func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
||||
|
||||
func (p *PKI) reloadCAPool(c *config.C) *util.ContextualError {
|
||||
caPool, err := loadCAPoolFromConfig(p.l, c)
|
||||
if caPool != nil {
|
||||
p.caPool.Store(caPool)
|
||||
p.l.Debug("Trusted CA fingerprints", "fingerprints", caPool.GetFingerprints())
|
||||
}
|
||||
if err != nil {
|
||||
return util.NewContextualError("Failed to load ca from config", nil, err)
|
||||
}
|
||||
|
||||
p.caPool.Store(caPool)
|
||||
p.l.Debug("Trusted CA fingerprints", "fingerprints", caPool.GetFingerprints())
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -617,22 +576,11 @@ func loadCAPoolFromConfig(l *slog.Logger, c *config.C) (*cert.CAPool, error) {
|
||||
|
||||
bl := c.GetStringSlice("pki.blocklist", []string{})
|
||||
if len(bl) > 0 {
|
||||
var bad []string
|
||||
for i, raw := range bl {
|
||||
// Fingerprints are compared as lowercase hex strings, a malformed entry would silently block nothing
|
||||
fp := strings.ToLower(strings.TrimSpace(raw))
|
||||
if b, err := hex.DecodeString(fp); err != nil || len(b) != sha256.Size {
|
||||
bad = append(bad, fmt.Sprintf("entry %d %q", i+1, raw))
|
||||
continue
|
||||
}
|
||||
for _, fp := range bl {
|
||||
caPool.BlocklistFingerprint(fp)
|
||||
}
|
||||
|
||||
l.Info("Blocklisted certificates", "fingerprintCount", len(bl)-len(bad))
|
||||
if len(bad) > 0 {
|
||||
// The valid entries are still returned so a failed reload blocks them, startup refuses the error
|
||||
return caPool, fmt.Errorf("pki.blocklist entries are not hex certificate fingerprints: %s", strings.Join(bad, ", "))
|
||||
}
|
||||
l.Info("Blocklisted certificates", "fingerprintCount", len(bl))
|
||||
}
|
||||
|
||||
return caPool, nil
|
||||
|
||||
-168
@@ -1,17 +1,10 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"crypto/fips140"
|
||||
"fmt"
|
||||
"net/netip"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/cert_test"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
@@ -99,164 +92,3 @@ func TestNewCipherSuiteUnsupportedCurve(t *testing.T) {
|
||||
assert.True(t, strings.HasPrefix(err.Error(), "unsupported curve:"), "got: %v", err)
|
||||
assert.Nil(t, cs)
|
||||
}
|
||||
|
||||
func TestPKIReloadRestartRequired(t *testing.T) {
|
||||
ca, _, caKey, caPEM := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
pkiConfig := func(cipher, network string) string {
|
||||
_, _, keyPEM, certPEM := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca, caKey, "host", time.Time{}, time.Time{}, []netip.Prefix{netip.MustParsePrefix(network)}, nil, nil)
|
||||
return fmt.Sprintf("cipher: %s\npki:\n ca: %q\n cert: %q\n key: %q\n", cipher, caPEM, certPEM, keyPEM)
|
||||
}
|
||||
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(pkiConfig("aes", "10.1.0.2/24")))
|
||||
p, err := NewPKIFromConfig(test.NewLogger(), c)
|
||||
require.NoError(t, err)
|
||||
|
||||
// A cert that changes our networks is refused and needs a restart, it is not a failure
|
||||
res := c.ReloadConfigString(pkiConfig("aes", "10.1.0.3/24"))
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.RestartRequired)
|
||||
assert.False(t, res.Failed)
|
||||
assert.Equal(t, []netip.Prefix{netip.MustParsePrefix("10.1.0.2/24")}, p.getCertState().myVpnNetworks)
|
||||
|
||||
// The cipher only applies at startup
|
||||
c2 := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c2.LoadString(pkiConfig("aes", "10.1.0.2/24")))
|
||||
p, err = NewPKIFromConfig(test.NewLogger(), c2)
|
||||
require.NoError(t, err)
|
||||
res = c2.ReloadConfigString(pkiConfig("chachapoly", "10.1.0.2/24"))
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.RestartRequired)
|
||||
assert.Equal(t, "aes", p.getCertState().cipher)
|
||||
|
||||
// A cipher we can't run would fail the restart, so it fails the reload instead of asking for one
|
||||
c4 := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c4.LoadString(pkiConfig("aes", "10.1.0.2/24")))
|
||||
_, err = NewPKIFromConfig(test.NewLogger(), c4)
|
||||
require.NoError(t, err)
|
||||
for range 2 {
|
||||
res = c4.ReloadConfigString(pkiConfig("nope", "10.1.0.2/24"))
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.Failed, "a bad cipher that didn't change since the last reload is still bad")
|
||||
assert.False(t, res.RestartRequired)
|
||||
}
|
||||
// Fixing it back to the running cipher needs nothing
|
||||
res = c4.ReloadConfigString(pkiConfig("aes", "10.1.0.2/24"))
|
||||
require.NoError(t, res.Err)
|
||||
assert.False(t, res.Failed)
|
||||
assert.False(t, res.RestartRequired)
|
||||
|
||||
// A cert that keeps our networks applies without a restart
|
||||
c3 := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c3.LoadString(pkiConfig("aes", "10.1.0.2/24")))
|
||||
_, err = NewPKIFromConfig(test.NewLogger(), c3)
|
||||
require.NoError(t, err)
|
||||
res = c3.ReloadConfigString(pkiConfig("aes", "10.1.0.2/24"))
|
||||
require.NoError(t, res.Err)
|
||||
assert.False(t, res.RestartRequired)
|
||||
|
||||
// A cert that can't be read is a failure, and a restart wouldn't help
|
||||
res = c3.ReloadConfigString(strings.Replace(pkiConfig("aes", "10.1.0.2/24"), "cert: \"", "cert: \"garbage", 1))
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.Failed)
|
||||
assert.False(t, res.RestartRequired)
|
||||
}
|
||||
|
||||
// A cert for a version we weren't running is accepted without comparing networks, so switching to one with different
|
||||
// networks needs a restart. One with the same networks doesn't
|
||||
func TestPKIReloadNewVersionWithOtherNetworks(t *testing.T) {
|
||||
ca1, _, ca1Key, ca1PEM := cert_test.NewTestCaCert(cert.Version1, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
ca2, _, ca2Key, ca2PEM := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
caPEM := string(ca1PEM) + string(ca2PEM)
|
||||
pkiConfig := func(v cert.Version, network string) string {
|
||||
ca, caKey := ca1, ca1Key
|
||||
if v == cert.Version2 {
|
||||
ca, caKey = ca2, ca2Key
|
||||
}
|
||||
_, _, keyPEM, certPEM := cert_test.NewTestCert(v, cert.Curve_CURVE25519, ca, caKey, "host", time.Time{}, time.Time{}, []netip.Prefix{netip.MustParsePrefix(network)}, nil, nil)
|
||||
return fmt.Sprintf("pki:\n ca: %q\n cert: %q\n key: %q\n", caPEM, certPEM, keyPEM)
|
||||
}
|
||||
|
||||
for _, tc := range []struct {
|
||||
network string
|
||||
restart bool
|
||||
}{
|
||||
{"10.9.0.7/24", true},
|
||||
{"10.1.0.2/24", false},
|
||||
} {
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(pkiConfig(cert.Version1, "10.1.0.2/24")))
|
||||
p, err := NewPKIFromConfig(test.NewLogger(), c)
|
||||
require.NoError(t, err)
|
||||
|
||||
res := c.ReloadConfigString(pkiConfig(cert.Version2, tc.network))
|
||||
require.NoError(t, res.Err)
|
||||
assert.False(t, res.Failed, tc.network)
|
||||
assert.Equal(t, tc.restart, res.RestartRequired, tc.network)
|
||||
assert.Equal(t, []netip.Prefix{netip.MustParsePrefix(tc.network)}, p.getCertState().myVpnNetworks, "accepted either way, as before")
|
||||
}
|
||||
}
|
||||
|
||||
// FIPS 140-only mode refuses chachapoly at startup, so reloading to it fails rather than asks for a restart
|
||||
func TestPKIReloadChachapolyInFIPSOnlyFails(t *testing.T) {
|
||||
fipsOnly = func() bool { return true }
|
||||
t.Cleanup(func() { fipsOnly = fips140.Enforced })
|
||||
ca, _, caKey, caPEM := cert_test.NewTestCaCert(cert.Version2, cert.Curve_P256, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
_, _, keyPEM, certPEM := cert_test.NewTestCert(cert.Version2, cert.Curve_P256, ca, caKey, "host", time.Time{}, time.Time{}, []netip.Prefix{netip.MustParsePrefix("10.1.0.2/24")}, nil, nil)
|
||||
pkiConfig := func(cipher string) string {
|
||||
return fmt.Sprintf("cipher: %s\npki:\n ca: %q\n cert: %q\n key: %q\n", cipher, caPEM, certPEM, keyPEM)
|
||||
}
|
||||
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(pkiConfig("aes")))
|
||||
_, err := NewPKIFromConfig(test.NewLogger(), c)
|
||||
require.NoError(t, err)
|
||||
|
||||
res := c.ReloadConfigString(pkiConfig("chachapoly"))
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.Failed)
|
||||
assert.False(t, res.RestartRequired)
|
||||
}
|
||||
|
||||
func TestLoadCAPoolBlocklist(t *testing.T) {
|
||||
ca, _, caKey, caPEM := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
crt, _, _, _ := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca, caKey, "host", time.Time{}, time.Time{}, []netip.Prefix{netip.MustParsePrefix("10.1.0.2/24")}, nil, nil)
|
||||
fp, err := crt.Fingerprint()
|
||||
require.NoError(t, err)
|
||||
|
||||
load := func(entry string) (*cert.CAPool, error) {
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(fmt.Sprintf("pki:\n ca: %q\n blocklist:\n - %q\n", caPEM, entry)))
|
||||
return loadCAPoolFromConfig(test.NewLogger(), c)
|
||||
}
|
||||
|
||||
for _, entry := range []string{fp, strings.ToUpper(fp), " " + fp + "\t"} {
|
||||
pool, err := load(entry)
|
||||
require.NoError(t, err, entry)
|
||||
assert.True(t, pool.IsBlocklisted(fp), entry)
|
||||
}
|
||||
|
||||
for _, entry := range []string{fp[1:], fp + "00", "sha256:" + fp, "zz" + fp[2:], ""} {
|
||||
_, err := load(entry)
|
||||
require.Error(t, err, entry)
|
||||
}
|
||||
|
||||
// A bad entry on reload fails it, the valid entries are still blocked
|
||||
_, _, keyPEM, certPEM := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca, caKey, "me", time.Time{}, time.Time{}, []netip.Prefix{netip.MustParsePrefix("10.1.0.1/24")}, nil, nil)
|
||||
pkiConfig := func(entry string) string {
|
||||
return fmt.Sprintf("pki:\n ca: %q\n cert: %q\n key: %q\n blocklist:\n - %q\n", caPEM, certPEM, keyPEM, entry)
|
||||
}
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(pkiConfig(fp)))
|
||||
p, err := NewPKIFromConfig(test.NewLogger(), c)
|
||||
require.NoError(t, err)
|
||||
|
||||
other, _, _, _ := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca, caKey, "other", time.Time{}, time.Time{}, []netip.Prefix{netip.MustParsePrefix("10.1.0.3/24")}, nil, nil)
|
||||
otherFp, err := other.Fingerprint()
|
||||
require.NoError(t, err)
|
||||
|
||||
res := c.ReloadConfigString(pkiConfig(fp) + fmt.Sprintf(" - %q\n - %q\n", otherFp, fp[1:]))
|
||||
assert.True(t, res.Failed)
|
||||
assert.True(t, p.GetCAPool().IsBlocklisted(fp))
|
||||
assert.True(t, p.GetCAPool().IsBlocklisted(otherFp))
|
||||
}
|
||||
@@ -67,8 +67,7 @@ func NewPunchyFromConfig(l *slog.Logger, c *config.C, punchConn udp.Conn) *Punch
|
||||
}
|
||||
|
||||
p.reload(c, true)
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("stats.lighthouse_metrics")
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
p.reload(c, false)
|
||||
})
|
||||
|
||||
|
||||
+6
-16
@@ -76,7 +76,7 @@ punchy:
|
||||
punch: true
|
||||
delay: 10m
|
||||
respond: true
|
||||
`).Err)
|
||||
`))
|
||||
p.reload(c, false)
|
||||
assert.True(t, p.punch.Load())
|
||||
assert.Equal(t, newDelay, time.Duration(p.delay.Load()))
|
||||
@@ -170,7 +170,7 @@ func TestPunchy_LogFormat_ReloadPunch(t *testing.T) {
|
||||
NewPunchyFromConfig(l, c, nil)
|
||||
hook.entries = nil
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(`punchy: {punch: true}`).Err)
|
||||
require.NoError(t, c.ReloadConfigString(`punchy: {punch: true}`))
|
||||
|
||||
entry := findEntry(t, hook.entries, "punchy.punch changed")
|
||||
assert.Equal(t, slog.LevelInfo, entry.Level)
|
||||
@@ -184,7 +184,7 @@ func TestPunchy_LogFormat_ReloadRespond(t *testing.T) {
|
||||
NewPunchyFromConfig(l, c, nil)
|
||||
hook.entries = nil
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(`punchy: {respond: true}`).Err)
|
||||
require.NoError(t, c.ReloadConfigString(`punchy: {respond: true}`))
|
||||
|
||||
entry := findEntry(t, hook.entries, "punchy.respond changed")
|
||||
assert.Equal(t, slog.LevelInfo, entry.Level)
|
||||
@@ -198,7 +198,7 @@ func TestPunchy_LogFormat_ReloadDelay(t *testing.T) {
|
||||
NewPunchyFromConfig(l, c, nil)
|
||||
hook.entries = nil
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(`punchy: {delay: 10s}`).Err)
|
||||
require.NoError(t, c.ReloadConfigString(`punchy: {delay: 10s}`))
|
||||
|
||||
entry := findEntry(t, hook.entries, "punchy.delay changed")
|
||||
assert.Equal(t, slog.LevelInfo, entry.Level)
|
||||
@@ -212,7 +212,7 @@ func TestPunchy_LogFormat_ReloadTargetAllRemotes(t *testing.T) {
|
||||
NewPunchyFromConfig(l, c, nil)
|
||||
hook.entries = nil
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(`punchy: {target_all_remotes: true}`).Err)
|
||||
require.NoError(t, c.ReloadConfigString(`punchy: {target_all_remotes: true}`))
|
||||
|
||||
entry := findEntry(t, hook.entries, "punchy.target_all_remotes changed")
|
||||
assert.Equal(t, slog.LevelInfo, entry.Level)
|
||||
@@ -226,19 +226,9 @@ func TestPunchy_LogFormat_ReloadRespondDelay(t *testing.T) {
|
||||
NewPunchyFromConfig(l, c, nil)
|
||||
hook.entries = nil
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(`punchy: {respond_delay: 15s}`).Err)
|
||||
require.NoError(t, c.ReloadConfigString(`punchy: {respond_delay: 15s}`))
|
||||
|
||||
entry := findEntry(t, hook.entries, "punchy.respond_delay changed")
|
||||
assert.Equal(t, slog.LevelInfo, entry.Level)
|
||||
assert.Equal(t, map[string]any{"respond_delay": 15 * time.Second}, entry.Attrs)
|
||||
}
|
||||
|
||||
func TestPunchyReloadRestartRequired(t *testing.T) {
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString("stats:\n lighthouse_metrics: false\n"))
|
||||
NewPunchyFromConfig(test.NewLogger(), c, nil)
|
||||
|
||||
res := c.ReloadConfigString("stats:\n lighthouse_metrics: true\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.RestartRequired)
|
||||
}
|
||||
@@ -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())
|
||||
}
|
||||
}
|
||||
+1
-2
@@ -28,11 +28,10 @@ func NewRelayManager(ctx context.Context, l *slog.Logger, hostmap *HostMap, c *c
|
||||
hostmap: hostmap,
|
||||
}
|
||||
rm.reload(c, true)
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
err := rm.reload(c, false)
|
||||
if err != nil {
|
||||
rm.l.Error("Failed to reload relay_manager", "error", err)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
return rm
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
//go:build !darwin && !send_pipeline
|
||||
|
||||
package nebula
|
||||
|
||||
import "github.com/slackhq/nebula/overlay/tio"
|
||||
|
||||
// sendPipelinePlatform is false off darwin: the pipelined send path (interface_pipeline.go) is darwin only for now,
|
||||
// and listenIn writes its own batches everywhere else. Being a constant, it removes the branch at compile time.
|
||||
// Build with -tags send_pipeline to run the pipeline, and its tests, on another platform.
|
||||
const sendPipelinePlatform = false
|
||||
|
||||
// listenInPipelined is a plain function rather than a method so this unreachable stub leaves no trace in the binary.
|
||||
func listenInPipelined(*Interface, tio.Queue, int) {}
|
||||
+8
-23
@@ -1,8 +1,8 @@
|
||||
package service
|
||||
|
||||
import (
|
||||
"io"
|
||||
"net"
|
||||
"sync"
|
||||
)
|
||||
|
||||
type tcpListener struct {
|
||||
@@ -10,38 +10,23 @@ type tcpListener struct {
|
||||
s *Service
|
||||
addr *net.TCPAddr
|
||||
accept chan net.Conn
|
||||
|
||||
// closed is closed instead of accept so a handler blocked handing off a
|
||||
// connection can't send on a closed channel.
|
||||
closed chan struct{}
|
||||
closeOnce sync.Once
|
||||
}
|
||||
|
||||
func (l *tcpListener) Accept() (net.Conn, error) {
|
||||
// select picks randomly among ready cases, so without this a handler still
|
||||
// waiting to hand off could win over closed after Close has returned.
|
||||
select {
|
||||
case <-l.closed:
|
||||
return nil, net.ErrClosed
|
||||
default:
|
||||
conn, ok := <-l.accept
|
||||
if !ok {
|
||||
return nil, io.EOF
|
||||
}
|
||||
|
||||
select {
|
||||
case conn := <-l.accept:
|
||||
return conn, nil
|
||||
case <-l.closed:
|
||||
return nil, net.ErrClosed
|
||||
}
|
||||
}
|
||||
|
||||
func (l *tcpListener) Close() error {
|
||||
l.closeOnce.Do(func() {
|
||||
l.s.mu.Lock()
|
||||
delete(l.s.mu.listeners, l.port)
|
||||
l.s.mu.Unlock()
|
||||
defer l.s.mu.Unlock()
|
||||
delete(l.s.mu.listeners, uint16(l.addr.Port))
|
||||
|
||||
close(l.accept)
|
||||
|
||||
close(l.closed)
|
||||
})
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
+3
-9
@@ -231,7 +231,6 @@ func (s *Service) Listen(network, address string) (net.Listener, error) {
|
||||
s: s,
|
||||
addr: addr,
|
||||
accept: make(chan net.Conn),
|
||||
closed: make(chan struct{}),
|
||||
}
|
||||
|
||||
s.mu.Lock()
|
||||
@@ -258,8 +257,9 @@ func (s *Service) tcpHandler(r *tcp.ForwarderRequest) {
|
||||
endpointID := r.ID()
|
||||
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
|
||||
l, ok := s.mu.listeners[endpointID.LocalPort]
|
||||
s.mu.Unlock()
|
||||
if !ok {
|
||||
r.Complete(true)
|
||||
return
|
||||
@@ -275,12 +275,6 @@ func (s *Service) tcpHandler(r *tcp.ForwarderRequest) {
|
||||
r.Complete(false)
|
||||
ep.SocketOptions().SetKeepAlive(true)
|
||||
|
||||
// The handoff blocks until Accept is called, so it must not hold s.mu or a
|
||||
// listener nobody accepts from stalls every other port.
|
||||
conn := gonet.NewTCPConn(&wq, ep)
|
||||
select {
|
||||
case l.accept <- conn:
|
||||
case <-l.closed:
|
||||
_ = conn.Close()
|
||||
}
|
||||
l.accept <- conn
|
||||
}
|
||||
@@ -188,142 +188,3 @@ func TestService(t *testing.T) {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
|
||||
// A listener that is never accepted from must not stall connections to other
|
||||
// ports, and closing it must not block.
|
||||
func TestServiceUnacceptedListener(t *testing.T) {
|
||||
lighthousePort := ephemeralUDPPort(t)
|
||||
|
||||
ca, _, caKey, _ := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Now(), time.Now().Add(10*time.Minute), nil, nil, []string{})
|
||||
a := newSimpleService(ca, caKey, "a", netip.MustParseAddr("10.0.0.1"), m{
|
||||
"static_host_map": m{},
|
||||
"lighthouse": m{
|
||||
"am_lighthouse": true,
|
||||
},
|
||||
"listen": m{
|
||||
"host": "0.0.0.0",
|
||||
"port": lighthousePort,
|
||||
},
|
||||
})
|
||||
t.Cleanup(func() { _ = a.Close() })
|
||||
b := newSimpleService(ca, caKey, "b", netip.MustParseAddr("10.0.0.2"), m{
|
||||
"static_host_map": m{
|
||||
"10.0.0.1": []string{fmt.Sprintf("127.0.0.1:%d", lighthousePort)},
|
||||
},
|
||||
"lighthouse": m{
|
||||
"hosts": []string{"10.0.0.1"},
|
||||
"interval": 1,
|
||||
},
|
||||
})
|
||||
t.Cleanup(func() { _ = b.Close() })
|
||||
|
||||
idle, err := a.Listen("tcp", ":1234")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
active, err := a.Listen("tcp", ":1235")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
|
||||
defer cancel()
|
||||
idleConn, err := b.DialContext(ctx, "tcp", "10.0.0.1:1234")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer idleConn.Close()
|
||||
|
||||
accepted := make(chan error, 1)
|
||||
go func() {
|
||||
conn, err := active.Accept()
|
||||
if err == nil {
|
||||
err = conn.Close()
|
||||
}
|
||||
accepted <- err
|
||||
}()
|
||||
|
||||
ctx, cancel = context.WithTimeout(context.Background(), 5*time.Second)
|
||||
defer cancel()
|
||||
activeConn, err := b.DialContext(ctx, "tcp", "10.0.0.1:1235")
|
||||
if err != nil {
|
||||
t.Fatalf("dial to accepted port stalled behind idle listener: %v", err)
|
||||
}
|
||||
defer activeConn.Close()
|
||||
|
||||
select {
|
||||
case err := <-accepted:
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
case <-time.After(5 * time.Second):
|
||||
t.Fatal("accept stalled behind idle listener")
|
||||
}
|
||||
|
||||
closed := make(chan error, 1)
|
||||
go func() { closed <- idle.Close() }()
|
||||
select {
|
||||
case err := <-closed:
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
case <-time.After(5 * time.Second):
|
||||
t.Fatal("closing idle listener blocked")
|
||||
}
|
||||
|
||||
if _, err := idle.Accept(); !errors.Is(err, net.ErrClosed) {
|
||||
t.Fatalf("expected net.ErrClosed from closed listener, got %v", err)
|
||||
}
|
||||
if err := idle.Close(); err != nil {
|
||||
t.Fatalf("second close: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Accept must report net.ErrClosed after Close even while a handler is still
|
||||
// trying to hand off a connection.
|
||||
func TestListenerAcceptAfterClose(t *testing.T) {
|
||||
s := &Service{}
|
||||
s.mu.listeners = map[uint16]*tcpListener{}
|
||||
l := &tcpListener{
|
||||
port: 1234,
|
||||
s: s,
|
||||
accept: make(chan net.Conn),
|
||||
closed: make(chan struct{}),
|
||||
}
|
||||
s.mu.listeners[l.port] = l
|
||||
if err := l.Close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// Keep a send pending so every Accept has a connection ready alongside closed.
|
||||
stop := make(chan struct{})
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
defer close(done)
|
||||
for {
|
||||
server, client := net.Pipe()
|
||||
_ = client.Close()
|
||||
select {
|
||||
case l.accept <- server:
|
||||
case <-stop:
|
||||
_ = server.Close()
|
||||
return
|
||||
}
|
||||
}
|
||||
}()
|
||||
defer func() {
|
||||
close(stop)
|
||||
<-done
|
||||
}()
|
||||
|
||||
for range 100 {
|
||||
time.Sleep(time.Millisecond)
|
||||
conn, err := l.Accept()
|
||||
if conn != nil {
|
||||
_ = conn.Close()
|
||||
}
|
||||
if !errors.Is(err, net.ErrClosed) {
|
||||
t.Fatalf("Accept after Close: got err %v, want net.ErrClosed", err)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -11,8 +11,11 @@ import (
|
||||
"net"
|
||||
"net/netip"
|
||||
"os"
|
||||
"slices"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"runtime/pprof"
|
||||
"sort"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/slackhq/nebula/config"
|
||||
@@ -55,28 +58,12 @@ type sshDeviceInfoFlags struct {
|
||||
}
|
||||
|
||||
func wireSSHReload(l *slog.Logger, ssh *sshd.SSHServer, c *config.C) {
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
if c.GetBool("sshd.enabled", false) {
|
||||
// Restarting the server drops every open session, the one that asked for this reload included. Only restart
|
||||
// when it isn't running or its config changed. The host key file can change under the same config, new
|
||||
// handshakes use the new key without a restart
|
||||
if ssh.Running() && !slices.ContainsFunc(sshdServerKeys, c.HasChanged) {
|
||||
key, err := loadSSHHostKey(c)
|
||||
if err == nil {
|
||||
err = ssh.SetHostKey(key)
|
||||
}
|
||||
sshRun, err := configSSH(l, ssh, c)
|
||||
if err != nil {
|
||||
l.Error("Failed to reconfigure the sshd", "error", err)
|
||||
ssh.Stop()
|
||||
r.Failed()
|
||||
}
|
||||
return
|
||||
}
|
||||
sshRun, err := configSSH(l, ssh, c, r)
|
||||
if err != nil {
|
||||
l.Error("Failed to reconfigure the sshd", "error", err)
|
||||
ssh.Stop()
|
||||
r.Failed()
|
||||
}
|
||||
if sshRun != nil {
|
||||
go sshRun()
|
||||
@@ -87,31 +74,11 @@ func wireSSHReload(l *slog.Logger, ssh *sshd.SSHServer, c *config.C) {
|
||||
})
|
||||
}
|
||||
|
||||
// sshdServerKeys are what configSSH reads
|
||||
var sshdServerKeys = []string{"sshd.enabled", "sshd.listen", "sshd.host_key", "sshd.trusted_cas", "sshd.authorized_users"}
|
||||
|
||||
// loadSSHHostKey returns sshd.host_key, read from its file when it names one.
|
||||
func loadSSHHostKey(c *config.C) ([]byte, error) {
|
||||
hostKeyPathOrKey := c.GetString("sshd.host_key", "")
|
||||
if hostKeyPathOrKey == "" {
|
||||
return nil, fmt.Errorf("sshd.host_key must be provided")
|
||||
}
|
||||
if strings.Contains(hostKeyPathOrKey, "-----BEGIN") {
|
||||
return []byte(hostKeyPathOrKey), nil
|
||||
}
|
||||
b, err := os.ReadFile(hostKeyPathOrKey)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("error while loading sshd.host_key file: %s", err)
|
||||
}
|
||||
return b, nil
|
||||
}
|
||||
|
||||
// configSSH reads the ssh info out of the passed-in Config and
|
||||
// updates the passed-in SSHServer. On success, it returns a function
|
||||
// that callers may invoke to run the configured ssh server. On
|
||||
// failure, it returns nil, error.
|
||||
// r is nil at startup, entries that are skipped with a warning fail it on a reload
|
||||
func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reload) (func(), error) {
|
||||
func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C) (func(), error) {
|
||||
listen := c.GetString("sshd.listen", "")
|
||||
if listen == "" {
|
||||
return nil, fmt.Errorf("sshd.listen must be provided")
|
||||
@@ -125,9 +92,19 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
||||
return nil, fmt.Errorf("sshd.listen can not use port 22")
|
||||
}
|
||||
|
||||
hostKeyBytes, err := loadSSHHostKey(c)
|
||||
hostKeyPathOrKey := c.GetString("sshd.host_key", "")
|
||||
if hostKeyPathOrKey == "" {
|
||||
return nil, fmt.Errorf("sshd.host_key must be provided")
|
||||
}
|
||||
|
||||
var hostKeyBytes []byte
|
||||
if strings.Contains(hostKeyPathOrKey, "-----BEGIN") {
|
||||
hostKeyBytes = []byte(hostKeyPathOrKey)
|
||||
} else {
|
||||
hostKeyBytes, err = os.ReadFile(hostKeyPathOrKey)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
return nil, fmt.Errorf("error while loading sshd.host_key file: %s", err)
|
||||
}
|
||||
}
|
||||
|
||||
err = ssh.SetHostKey(hostKeyBytes)
|
||||
@@ -144,7 +121,6 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
||||
err := ssh.AddTrustedCA(caAuthorizedKey)
|
||||
if err != nil {
|
||||
l.Warn("SSH CA had an error, ignoring", "error", err, "sshCA", caAuthorizedKey)
|
||||
r.Failed()
|
||||
continue
|
||||
}
|
||||
}
|
||||
@@ -156,14 +132,12 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
||||
kDef, ok := rk.(map[string]any)
|
||||
if !ok {
|
||||
l.Warn("Authorized user had an error, ignoring", "sshKeyConfig", rk)
|
||||
r.Failed()
|
||||
continue
|
||||
}
|
||||
|
||||
user, ok := kDef["user"].(string)
|
||||
if !ok {
|
||||
l.Warn("Authorized user is missing the user field", "sshKeyConfig", rk)
|
||||
r.Failed()
|
||||
continue
|
||||
}
|
||||
|
||||
@@ -177,7 +151,6 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
||||
"sshKeyConfig", rk,
|
||||
"sshKey", v,
|
||||
)
|
||||
r.Failed()
|
||||
continue
|
||||
}
|
||||
|
||||
@@ -189,7 +162,6 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
||||
"sshKeyConfig", rk,
|
||||
"sshKey", subK,
|
||||
)
|
||||
r.Failed()
|
||||
continue
|
||||
}
|
||||
|
||||
@@ -199,14 +171,12 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
||||
"error", err,
|
||||
"sshKeyConfig", sk,
|
||||
)
|
||||
r.Failed()
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
default:
|
||||
l.Warn("Authorized user is missing the keys field or was not understood", "sshKeyConfig", rk)
|
||||
r.Failed()
|
||||
}
|
||||
}
|
||||
} else {
|
||||
@@ -229,6 +199,12 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
||||
}
|
||||
|
||||
func attachCommands(l *slog.Logger, c *config.C, ssh *sshd.SSHServer, f *Interface) {
|
||||
// sandboxDir defaults to a dir in temp. The intention is that end user will
|
||||
// create this dir as needed. Overriding this config value to "" allows
|
||||
// writing to anywhere in the system.
|
||||
defaultDir := filepath.Join(os.TempDir(), "nebula-debug")
|
||||
sandboxDir := c.GetString("sshd.sandbox_dir", defaultDir)
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "list-hostmap",
|
||||
ShortDescription: "List all known previously connected hosts",
|
||||
@@ -280,7 +256,46 @@ func attachCommands(l *slog.Logger, c *config.C, ssh *sshd.SSHServer, f *Interfa
|
||||
Name: "reload",
|
||||
ShortDescription: "Reloads configuration from disk, same as sending HUP to the process",
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshReload(l, c, w)
|
||||
return sshReload(c, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "start-cpu-profile",
|
||||
ShortDescription: "Starts a cpu profile and write output to the provided file, ex: `cpu-profile.pb.gz`",
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshStartCpuProfile(sandboxDir, fs, a, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "stop-cpu-profile",
|
||||
ShortDescription: "Stops a cpu profile and writes output to the previously provided file",
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
pprof.StopCPUProfile()
|
||||
return w.WriteLine("If a CPU profile was running it is now stopped")
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "save-heap-profile",
|
||||
ShortDescription: "Saves a heap profile to the provided path, ex: `heap-profile.pb.gz`",
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshGetHeapProfile(sandboxDir, fs, a, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "mutex-profile-fraction",
|
||||
ShortDescription: "Gets or sets runtime.SetMutexProfileFraction",
|
||||
Callback: sshMutexProfileFraction,
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "save-mutex-profile",
|
||||
ShortDescription: "Saves a mutex profile to the provided path, ex: `mutex-profile.pb.gz`",
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshGetMutexProfile(sandboxDir, fs, a, w)
|
||||
},
|
||||
})
|
||||
|
||||
@@ -514,6 +529,58 @@ func sshListLighthouseMap(lightHouse *LightHouse, a any, w sshd.StringWriter) er
|
||||
return nil
|
||||
}
|
||||
|
||||
// sshSanitizeFilePath validates that the given file path is within the sandbox directory.
|
||||
// If sandboxDir is empty, the path is returned as-is for backwards compatibility.
|
||||
func sshSanitizeFilePath(sandboxDir, filePath string) (string, error) {
|
||||
if sandboxDir == "" {
|
||||
return filePath, nil
|
||||
}
|
||||
|
||||
// Clean and resolve the path relative to the sandbox directory
|
||||
if !filepath.IsAbs(filePath) {
|
||||
filePath = filepath.Join(sandboxDir, filePath)
|
||||
}
|
||||
cleaned := filepath.Clean(filePath)
|
||||
|
||||
// Ensure the resolved path is within the sandbox directory
|
||||
cleanedSandbox := filepath.Clean(sandboxDir)
|
||||
if cleaned == cleanedSandbox {
|
||||
return "", fmt.Errorf("path %q resolves to the sandbox directory itself %q", filePath, sandboxDir)
|
||||
}
|
||||
if !strings.HasPrefix(cleaned, cleanedSandbox+string(filepath.Separator)) {
|
||||
return "", fmt.Errorf("path %q is outside the sandbox directory %q", filePath, sandboxDir)
|
||||
}
|
||||
|
||||
return cleaned, nil
|
||||
}
|
||||
|
||||
func sshStartCpuProfile(sandboxDir string, fs any, a []string, w sshd.StringWriter) error {
|
||||
if len(a) == 0 {
|
||||
err := w.WriteLine("No path to write profile provided")
|
||||
return err
|
||||
}
|
||||
|
||||
filePath, err := sshSanitizeFilePath(sandboxDir, a[0])
|
||||
if err != nil {
|
||||
return w.WriteLine(err.Error())
|
||||
}
|
||||
|
||||
file, err := os.Create(filePath)
|
||||
if err != nil {
|
||||
err = w.WriteLine(fmt.Sprintf("Unable to create profile file: %s", err))
|
||||
return err
|
||||
}
|
||||
|
||||
err = pprof.StartCPUProfile(file)
|
||||
if err != nil {
|
||||
err = w.WriteLine(fmt.Sprintf("Unable to start cpu profile: %s", err))
|
||||
return err
|
||||
}
|
||||
|
||||
err = w.WriteLine(fmt.Sprintf("Started cpu profile, issue stop-cpu-profile to write the output to %s", a))
|
||||
return err
|
||||
}
|
||||
|
||||
func sshVersion(ifce *Interface, fs any, a []string, w sshd.StringWriter) error {
|
||||
return w.WriteLine(fmt.Sprintf("%s", ifce.version))
|
||||
}
|
||||
@@ -617,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
|
||||
// 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) {
|
||||
hostInfo = ifce.handshakeManager.StartHandshake(vpnAddr, nil)
|
||||
if addr.IsValid() {
|
||||
hh.hostinfo.SetRemote(addr)
|
||||
hostInfo.SetRemote(addr)
|
||||
}
|
||||
})
|
||||
|
||||
return w.WriteLine("Created")
|
||||
}
|
||||
@@ -666,6 +729,76 @@ func sshChangeRemote(ifce *Interface, fs any, a []string, w sshd.StringWriter) e
|
||||
return w.WriteLine("Changed")
|
||||
}
|
||||
|
||||
func sshGetHeapProfile(sandboxDir string, fs any, a []string, w sshd.StringWriter) error {
|
||||
if len(a) == 0 {
|
||||
return w.WriteLine("No path to write profile provided")
|
||||
}
|
||||
|
||||
filePath, err := sshSanitizeFilePath(sandboxDir, a[0])
|
||||
if err != nil {
|
||||
return w.WriteLine(err.Error())
|
||||
}
|
||||
|
||||
file, err := os.Create(filePath)
|
||||
if err != nil {
|
||||
err = w.WriteLine(fmt.Sprintf("Unable to create profile file: %s", err))
|
||||
return err
|
||||
}
|
||||
|
||||
err = pprof.WriteHeapProfile(file)
|
||||
if err != nil {
|
||||
err = w.WriteLine(fmt.Sprintf("Unable to write profile: %s", err))
|
||||
return err
|
||||
}
|
||||
|
||||
err = w.WriteLine(fmt.Sprintf("Mem profile created at %s", a))
|
||||
return err
|
||||
}
|
||||
|
||||
func sshMutexProfileFraction(fs any, a []string, w sshd.StringWriter) error {
|
||||
if len(a) == 0 {
|
||||
rate := runtime.SetMutexProfileFraction(-1)
|
||||
return w.WriteLine(fmt.Sprintf("Current value: %d", rate))
|
||||
}
|
||||
|
||||
newRate, err := strconv.Atoi(a[0])
|
||||
if err != nil {
|
||||
return w.WriteLine(fmt.Sprintf("Invalid argument: %s", a[0]))
|
||||
}
|
||||
|
||||
oldRate := runtime.SetMutexProfileFraction(newRate)
|
||||
return w.WriteLine(fmt.Sprintf("New value: %d. Old value: %d", newRate, oldRate))
|
||||
}
|
||||
|
||||
func sshGetMutexProfile(sandboxDir string, fs any, a []string, w sshd.StringWriter) error {
|
||||
if len(a) == 0 {
|
||||
return w.WriteLine("No path to write profile provided")
|
||||
}
|
||||
|
||||
filePath, err := sshSanitizeFilePath(sandboxDir, a[0])
|
||||
if err != nil {
|
||||
return w.WriteLine(err.Error())
|
||||
}
|
||||
|
||||
file, err := os.Create(filePath)
|
||||
if err != nil {
|
||||
return w.WriteLine(fmt.Sprintf("Unable to create profile file: %s", err))
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
mutexProfile := pprof.Lookup("mutex")
|
||||
if mutexProfile == nil {
|
||||
return w.WriteLine("Unable to get pprof.Lookup(\"mutex\")")
|
||||
}
|
||||
|
||||
err = mutexProfile.WriteTo(file, 0)
|
||||
if err != nil {
|
||||
return w.WriteLine(fmt.Sprintf("Unable to write profile: %s", err))
|
||||
}
|
||||
|
||||
return w.WriteLine(fmt.Sprintf("Mutex profile created at %s", a))
|
||||
}
|
||||
|
||||
func sshLogLevel(l *slog.Logger, fs any, a []string, w sshd.StringWriter) error {
|
||||
ctrl, ok := l.Handler().(interface {
|
||||
GetLevel() slog.Level
|
||||
@@ -918,13 +1051,8 @@ func sshDeviceInfo(ifce *Interface, fs any, w sshd.StringWriter) error {
|
||||
}
|
||||
}
|
||||
|
||||
// sshReload reloads the config and writes the result to the client. It reloads even if the client has gone away
|
||||
func sshReload(l *slog.Logger, c *config.C, w sshd.StringWriter) error {
|
||||
writeErr := w.WriteLine("Reloading config")
|
||||
res := c.ReloadConfig()
|
||||
res.Log(l)
|
||||
if err := w.WriteLine(res.String()); writeErr == nil {
|
||||
writeErr = err
|
||||
}
|
||||
return writeErr
|
||||
func sshReload(c *config.C, w sshd.StringWriter) error {
|
||||
err := w.WriteLine("Reloading config")
|
||||
c.ReloadConfig()
|
||||
return err
|
||||
}
|
||||
@@ -1,83 +0,0 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
type lineWriter struct {
|
||||
lines []string
|
||||
err error
|
||||
}
|
||||
|
||||
func (w *lineWriter) WriteLine(s string) error {
|
||||
w.lines = append(w.lines, s)
|
||||
return w.err
|
||||
}
|
||||
func (w *lineWriter) Write(s string) error { return w.WriteLine(s) }
|
||||
func (w *lineWriter) WriteBytes(b []byte) error { return w.WriteLine(string(b)) }
|
||||
func (w *lineWriter) GetWriter() io.Writer { return io.Discard }
|
||||
|
||||
func TestSSHReloadReportsTheResult(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
write := func(body string) {
|
||||
require.NoError(t, os.WriteFile(filepath.Join(dir, "config.yml"), []byte(body), 0o600))
|
||||
}
|
||||
write("a: 1\nb: 1")
|
||||
l := test.NewLogger()
|
||||
c := config.NewC(l)
|
||||
require.NoError(t, c.Load(dir))
|
||||
fail := false
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("b")
|
||||
if fail {
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
reload := func() []string {
|
||||
w := &lineWriter{}
|
||||
require.NoError(t, sshReload(l, c, w))
|
||||
return w.lines
|
||||
}
|
||||
|
||||
write("a: 2\nb: 1")
|
||||
assert.Equal(t, []string{"Reloading config", "Config reload complete"}, reload())
|
||||
|
||||
fail = true
|
||||
write("a: 3\nb: 1")
|
||||
assert.Equal(t, []string{"Reloading config", "Config reload completed with errors, review the logs"}, reload())
|
||||
|
||||
fail = false
|
||||
write("a: 3\nb: 2")
|
||||
assert.Equal(t, []string{"Reloading config", "Config reload was completed but requires a restart to fully apply, keys [b]"}, reload())
|
||||
|
||||
write("a: [")
|
||||
lines := reload()
|
||||
require.Len(t, lines, 2)
|
||||
assert.Contains(t, lines[1], "Config reload failed, the new config did not load")
|
||||
assert.Contains(t, lines[1], dir, "names the config that did not load")
|
||||
}
|
||||
|
||||
// A client that went away still gets the reload it asked for
|
||||
func TestSSHReloadReloadsWhenTheClientIsGone(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
require.NoError(t, os.WriteFile(filepath.Join(dir, "config.yml"), []byte("a: 1"), 0o600))
|
||||
l := test.NewLogger()
|
||||
c := config.NewC(l)
|
||||
require.NoError(t, c.Load(dir))
|
||||
reloaded := false
|
||||
c.RegisterReloadCallback(func(*config.C, *config.Reload) { reloaded = true })
|
||||
|
||||
gone := errors.New("client is gone")
|
||||
require.ErrorIs(t, sshReload(l, c, &lineWriter{err: gone}), gone)
|
||||
assert.True(t, reloaded)
|
||||
}
|
||||
+12
-47
@@ -8,17 +8,13 @@ import (
|
||||
"log/slog"
|
||||
"net"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
|
||||
"github.com/armon/go-radix"
|
||||
"golang.org/x/crypto/ssh"
|
||||
)
|
||||
|
||||
type SSHServer struct {
|
||||
// config is replaced whole when the host key changes, ssh.ServerConfig.AddHostKey only replaces a key of the same
|
||||
// algorithm and appends any other
|
||||
config atomic.Pointer[ssh.ServerConfig]
|
||||
authenticate func(ssh.ConnMetadata, ssh.PublicKey) (*ssh.Permissions, error)
|
||||
config *ssh.ServerConfig
|
||||
l *slog.Logger
|
||||
|
||||
certChecker *ssh.CertChecker
|
||||
@@ -32,12 +28,7 @@ type SSHServer struct {
|
||||
// List of available commands
|
||||
helpCommand *Command
|
||||
commands *radix.Tree
|
||||
listener atomic.Pointer[net.Listener]
|
||||
|
||||
// runs counts the Runs that are listening. A reload's Run can start before the one it replaced has returned
|
||||
runs atomic.Int32
|
||||
// addr is where the newest Run listens, nil when none is
|
||||
addr atomic.Pointer[net.Addr]
|
||||
listener net.Listener
|
||||
|
||||
// ctx parents per-Run contexts. Cancelling it (e.g. via Control.Stop) tears the server down even
|
||||
// across reloads, since each Run derives a fresh child rather than reusing this one directly.
|
||||
@@ -94,8 +85,10 @@ func NewSSHServer(ctx context.Context, l *slog.Logger) (*SSHServer, error) {
|
||||
},
|
||||
}
|
||||
|
||||
s.authenticate = cc.Authenticate
|
||||
s.config.Store(s.newConfig())
|
||||
s.config = &ssh.ServerConfig{
|
||||
PublicKeyCallback: cc.Authenticate,
|
||||
ServerVersion: fmt.Sprintf("SSH-2.0-Nebula???"),
|
||||
}
|
||||
|
||||
s.RegisterCommand(&Command{
|
||||
Name: "help",
|
||||
@@ -114,32 +107,10 @@ func (s *SSHServer) SetHostKey(hostPrivateKey []byte) error {
|
||||
return fmt.Errorf("failed to parse private key: %s", err)
|
||||
}
|
||||
|
||||
config := s.newConfig()
|
||||
config.AddHostKey(private)
|
||||
s.config.Store(config)
|
||||
s.config.AddHostKey(private)
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *SSHServer) newConfig() *ssh.ServerConfig {
|
||||
return &ssh.ServerConfig{
|
||||
PublicKeyCallback: s.authenticate,
|
||||
ServerVersion: fmt.Sprintf("SSH-2.0-Nebula???"),
|
||||
}
|
||||
}
|
||||
|
||||
// Addr is the address the newest Run listens on, nil when none is.
|
||||
func (s *SSHServer) Addr() net.Addr {
|
||||
if a := s.addr.Load(); a != nil {
|
||||
return *a
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Running is true while a Run is listening.
|
||||
func (s *SSHServer) Running() bool {
|
||||
return s.runs.Load() > 0
|
||||
}
|
||||
|
||||
func (s *SSHServer) ClearTrustedCAs() {
|
||||
s.authLock.Lock()
|
||||
s.trustedCAs = []ssh.PublicKey{}
|
||||
@@ -210,16 +181,10 @@ func (s *SSHServer) Run(addr string) error {
|
||||
// this run owns. They start equal but a fast reload may overwrite s.listener with the next run's
|
||||
// listener before this run's watcher fires, so each run must close its own listener via the local
|
||||
// reference.
|
||||
s.listener.Store(&listener)
|
||||
s.runs.Add(1)
|
||||
bound := listener.Addr()
|
||||
s.addr.Store(&bound)
|
||||
s.listener = listener
|
||||
|
||||
runCtx, cancel := context.WithCancel(s.ctx)
|
||||
defer cancel()
|
||||
// Deferred after cancel so they run first, a run on its way out no longer counts as listening
|
||||
defer s.runs.Add(-1)
|
||||
defer s.addr.CompareAndSwap(&bound, nil)
|
||||
|
||||
// Close the listener when this run's context is cancelled. That can come from the parent
|
||||
// (Control.Stop), from Run returning normally (defer cancel above), or transitively when a sibling
|
||||
@@ -232,7 +197,7 @@ func (s *SSHServer) Run(addr string) error {
|
||||
}
|
||||
}()
|
||||
|
||||
s.l.Info("SSH server is listening", "sshListener", bound)
|
||||
s.l.Info("SSH server is listening", "sshListener", addr)
|
||||
|
||||
// Run loops until there is an error
|
||||
s.run(runCtx, listener)
|
||||
@@ -261,7 +226,7 @@ func (s *SSHServer) run(ctx context.Context, listener net.Listener) {
|
||||
<-sessionContext.Done()
|
||||
c.Close()
|
||||
}()
|
||||
conn, chans, reqs, err := ssh.NewServerConn(c, s.config.Load())
|
||||
conn, chans, reqs, err := ssh.NewServerConn(c, s.config)
|
||||
fp := ""
|
||||
if conn != nil {
|
||||
fp = conn.Permissions.Extensions["fp"]
|
||||
@@ -299,8 +264,8 @@ func (s *SSHServer) run(ctx context.Context, listener net.Listener) {
|
||||
}
|
||||
|
||||
func (s *SSHServer) Stop() {
|
||||
if l := s.listener.Load(); l != nil {
|
||||
if err := (*l).Close(); err != nil && !errors.Is(err, net.ErrClosed) {
|
||||
if s.listener != nil {
|
||||
if err := s.listener.Close(); err != nil {
|
||||
s.l.Warn("Failed to close the sshd listener", "error", err)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,240 +0,0 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"crypto"
|
||||
"crypto/ed25519"
|
||||
"crypto/rand"
|
||||
"crypto/rsa"
|
||||
"encoding/pem"
|
||||
"fmt"
|
||||
"net"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/sshd"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"golang.org/x/crypto/ssh"
|
||||
)
|
||||
|
||||
type sshdReloadHarness struct {
|
||||
c *config.C
|
||||
server *sshd.SSHServer
|
||||
keyFile string
|
||||
signer ssh.Signer
|
||||
listen string
|
||||
users []string
|
||||
extra string
|
||||
}
|
||||
|
||||
func newSSHDReloadHarness(t *testing.T) *sshdReloadHarness {
|
||||
t.Helper()
|
||||
l := test.NewLogger()
|
||||
h := &sshdReloadHarness{keyFile: filepath.Join(t.TempDir(), "host_key"), listen: "127.0.0.1:0", users: []string{"test"}}
|
||||
h.writeHostKey(t, newEd25519Key(t))
|
||||
|
||||
_, userKey, err := ed25519.GenerateKey(rand.Reader)
|
||||
require.NoError(t, err)
|
||||
h.signer, err = ssh.NewSignerFromKey(userKey)
|
||||
require.NoError(t, err)
|
||||
|
||||
h.c = config.NewC(l)
|
||||
require.NoError(t, h.c.LoadString(h.config()))
|
||||
h.server, err = sshd.NewSSHServer(t.Context(), l)
|
||||
require.NoError(t, err)
|
||||
wireSSHReload(l, h.server, h.c)
|
||||
run, err := configSSH(l, h.server, h.c, nil)
|
||||
require.NoError(t, err)
|
||||
go run()
|
||||
t.Cleanup(h.server.Stop)
|
||||
require.Eventually(t, h.server.Running, 5*time.Second, 10*time.Millisecond)
|
||||
return h
|
||||
}
|
||||
|
||||
func newEd25519Key(t *testing.T) crypto.Signer {
|
||||
_, key, err := ed25519.GenerateKey(rand.Reader)
|
||||
require.NoError(t, err)
|
||||
return key
|
||||
}
|
||||
|
||||
// writeHostKey replaces the host key file and returns the public key a client should now see
|
||||
func (h *sshdReloadHarness) writeHostKey(t *testing.T, key crypto.Signer) ssh.PublicKey {
|
||||
t.Helper()
|
||||
block, err := ssh.MarshalPrivateKey(key, "")
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, os.WriteFile(h.keyFile, pem.EncodeToMemory(block), 0o600))
|
||||
pub, err := ssh.NewPublicKey(key.Public())
|
||||
require.NoError(t, err)
|
||||
return pub
|
||||
}
|
||||
|
||||
func (h *sshdReloadHarness) config() string {
|
||||
users := ""
|
||||
for _, u := range h.users {
|
||||
users += fmt.Sprintf(" - user: %s\n keys: [%q]\n", u, string(ssh.MarshalAuthorizedKey(h.signer.PublicKey())))
|
||||
}
|
||||
return fmt.Sprintf("sshd:\n enabled: true\n listen: %s\n host_key: %s\n authorized_users:\n%s%s",
|
||||
h.listen, h.keyFile, users, h.extra)
|
||||
}
|
||||
|
||||
// dial connects to wherever the server listens now, a restart on :0 moves it. hostKeyAlgorithms limits which host keys
|
||||
// the client accepts, none means any
|
||||
func (h *sshdReloadHarness) dial(hostKeyAlgorithms ...string) (*ssh.Client, ssh.PublicKey, error) {
|
||||
addr := h.server.Addr()
|
||||
if addr == nil {
|
||||
return nil, nil, fmt.Errorf("not listening")
|
||||
}
|
||||
var hostKey ssh.PublicKey
|
||||
c, err := ssh.Dial("tcp", addr.String(), &ssh.ClientConfig{
|
||||
User: "test",
|
||||
Auth: []ssh.AuthMethod{ssh.PublicKeys(h.signer)},
|
||||
HostKeyCallback: func(_ string, _ net.Addr, key ssh.PublicKey) error {
|
||||
hostKey = key
|
||||
return nil
|
||||
},
|
||||
HostKeyAlgorithms: hostKeyAlgorithms,
|
||||
Timeout: time.Second,
|
||||
})
|
||||
return c, hostKey, err
|
||||
}
|
||||
|
||||
func (h *sshdReloadHarness) connect(t *testing.T) (*ssh.Client, ssh.PublicKey) {
|
||||
t.Helper()
|
||||
var client *ssh.Client
|
||||
var hostKey ssh.PublicKey
|
||||
require.Eventually(t, func() bool {
|
||||
var err error
|
||||
client, hostKey, err = h.dial()
|
||||
return err == nil
|
||||
}, 5*time.Second, 20*time.Millisecond)
|
||||
t.Cleanup(func() { _ = client.Close() })
|
||||
return client, hostKey
|
||||
}
|
||||
|
||||
// dropped is true when the server closed the client's connection within wait
|
||||
func dropped(client *ssh.Client, wait time.Duration) bool {
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
_ = client.Wait()
|
||||
close(done)
|
||||
}()
|
||||
select {
|
||||
case <-done:
|
||||
return true
|
||||
case <-time.After(wait):
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
// Restarting sshd drops every open session, the one that asked for the reload included. A reload that touches nothing
|
||||
// sshd reads leaves it alone
|
||||
func TestSSHDReload_UnchangedKeepsSessions(t *testing.T) {
|
||||
h := newSSHDReloadHarness(t)
|
||||
client, _ := h.connect(t)
|
||||
|
||||
require.NoError(t, h.c.ReloadConfigString(h.config()+"punchy:\n punch: true\n").Err)
|
||||
assert.False(t, dropped(client, 500*time.Millisecond), "an unchanged sshd was restarted")
|
||||
}
|
||||
|
||||
// Every key the server reads restarts it when it changes
|
||||
func TestSSHDReload_ChangedConfigRestarts(t *testing.T) {
|
||||
cases := map[string]func(t *testing.T, h *sshdReloadHarness){
|
||||
"listen": func(t *testing.T, h *sshdReloadHarness) { h.listen = "localhost:0" },
|
||||
"authorized_users": func(t *testing.T, h *sshdReloadHarness) { h.users = append(h.users, "other") },
|
||||
"trusted_cas": func(t *testing.T, h *sshdReloadHarness) { h.extra = " trusted_cas: []\n" },
|
||||
"host_key": func(t *testing.T, h *sshdReloadHarness) {
|
||||
h.keyFile = filepath.Join(t.TempDir(), "other_host_key")
|
||||
h.writeHostKey(t, newEd25519Key(t))
|
||||
},
|
||||
}
|
||||
for name, change := range cases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
h := newSSHDReloadHarness(t)
|
||||
client, _ := h.connect(t)
|
||||
|
||||
change(t, h)
|
||||
require.NoError(t, h.c.ReloadConfigString(h.config()).Err)
|
||||
assert.True(t, dropped(client, 5*time.Second), "a changed sshd config was not applied")
|
||||
require.Eventually(t, h.server.Running, 5*time.Second, 10*time.Millisecond)
|
||||
h.connect(t)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// The config can stay the same while the host key file it names changes. New connections get the new key, open
|
||||
// sessions are left alone
|
||||
func TestSSHDReload_ChangedHostKeyFile(t *testing.T) {
|
||||
h := newSSHDReloadHarness(t)
|
||||
client, _ := h.connect(t)
|
||||
|
||||
want := h.writeHostKey(t, newEd25519Key(t))
|
||||
require.NoError(t, h.c.ReloadConfigString(h.config()).Err)
|
||||
_, got := h.connect(t)
|
||||
assert.Equal(t, want.Marshal(), got.Marshal(), "a new host key was not applied")
|
||||
assert.False(t, dropped(client, 500*time.Millisecond), "a new host key restarted sshd")
|
||||
}
|
||||
|
||||
// A host key of another algorithm replaces the old one rather than being offered next to it
|
||||
func TestSSHDReload_HostKeyAlgorithmChange(t *testing.T) {
|
||||
h := newSSHDReloadHarness(t)
|
||||
h.connect(t)
|
||||
|
||||
rsaKey, err := rsa.GenerateKey(rand.Reader, 2048)
|
||||
require.NoError(t, err)
|
||||
want := h.writeHostKey(t, rsaKey)
|
||||
require.NoError(t, h.c.ReloadConfigString(h.config()).Err)
|
||||
|
||||
_, got := h.connect(t)
|
||||
assert.Equal(t, want.Marshal(), got.Marshal())
|
||||
_, _, err = h.dial(ssh.KeyAlgoED25519)
|
||||
assert.Error(t, err, "the old ed25519 host key is still offered")
|
||||
}
|
||||
|
||||
// A server that isn't running, say its port was busy, is tried again on every reload as before
|
||||
func TestSSHDReload_NotRunningRestarts(t *testing.T) {
|
||||
h := newSSHDReloadHarness(t)
|
||||
h.server.Stop()
|
||||
require.Eventually(t, func() bool { return !h.server.Running() }, 5*time.Second, 10*time.Millisecond)
|
||||
|
||||
require.NoError(t, h.c.ReloadConfigString(h.config()).Err)
|
||||
require.Eventually(t, h.server.Running, 5*time.Second, 10*time.Millisecond)
|
||||
h.connect(t)
|
||||
}
|
||||
|
||||
// A host key that no longer loads stops sshd, the same as a config that doesn't
|
||||
func TestSSHDReload_BadHostKeyFileStops(t *testing.T) {
|
||||
h := newSSHDReloadHarness(t)
|
||||
h.connect(t)
|
||||
|
||||
require.NoError(t, os.WriteFile(h.keyFile, []byte("not a key"), 0o600))
|
||||
assert.True(t, h.c.ReloadConfigString(h.config()).Failed)
|
||||
require.Eventually(t, func() bool { return !h.server.Running() }, 5*time.Second, 10*time.Millisecond)
|
||||
}
|
||||
|
||||
// A trusted CA or authorized user that is skipped with a warning fails the reload, the valid ones are still used
|
||||
func TestSSHDReload_SkippedEntriesFail(t *testing.T) {
|
||||
cases := map[string]string{
|
||||
"bad trusted ca": " trusted_cas: [nope]\n",
|
||||
"user entry not a map": " - nope\n",
|
||||
"user missing": " - keys: [nope]\n",
|
||||
"bad key": " - user: other\n keys: nope\n",
|
||||
"key in a list not a string": " - user: other\n keys: [5]\n",
|
||||
"bad key in a list": " - user: other\n keys: [nope]\n",
|
||||
"keys missing": " - user: other\n",
|
||||
}
|
||||
for name, extra := range cases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
h := newSSHDReloadHarness(t)
|
||||
h.extra = extra
|
||||
res := h.c.ReloadConfigString(h.config())
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.Failed)
|
||||
require.Eventually(t, h.server.Running, 5*time.Second, 10*time.Millisecond)
|
||||
h.connect(t)
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -38,11 +38,6 @@ type statsServer struct {
|
||||
runMu sync.Mutex
|
||||
runCfg *statsConfig
|
||||
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
|
||||
@@ -87,22 +82,17 @@ type promConfig struct {
|
||||
//
|
||||
// Start is safe to call unconditionally: it no-ops when stats are disabled.
|
||||
// The returned pointer is always non-nil, even on 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) {
|
||||
func newStatsServerFromConfig(ctx context.Context, l *slog.Logger, c *config.C, buildVersion string, configTest bool) (*statsServer, error) {
|
||||
s := &statsServer{
|
||||
l: l,
|
||||
ctx: ctx,
|
||||
buildVersion: buildVersion,
|
||||
configTest: configTest,
|
||||
emitStats: emitStats,
|
||||
}
|
||||
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
c.RegisterReloadCallback(func(c *config.C) {
|
||||
if err := s.reload(c, false); err != nil {
|
||||
s.l.Error("Failed to reload stats from config", "error", err)
|
||||
r.Failed()
|
||||
}
|
||||
})
|
||||
|
||||
@@ -130,6 +120,7 @@ func (s *statsServer) reload(c *config.C, initial bool) error {
|
||||
s.runMu.Lock()
|
||||
sameCfg := s.runCfg != nil && *s.runCfg == newCfg
|
||||
s.runCfg = &newCfg
|
||||
running := s.run != nil
|
||||
s.runMu.Unlock()
|
||||
|
||||
s.enabled.Store(enabled)
|
||||
@@ -138,8 +129,9 @@ func (s *statsServer) reload(c *config.C, initial bool) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// Even with nothing running, a runtime whose listener failed can still be finishing its last pass
|
||||
if running {
|
||||
s.Stop()
|
||||
}
|
||||
if enabled && !s.configTest {
|
||||
go s.Start()
|
||||
}
|
||||
@@ -161,19 +153,13 @@ func (s *statsServer) Start() {
|
||||
return
|
||||
}
|
||||
cfg := *s.runCfg
|
||||
captureFns, listener := s.buildRuntime(cfg)
|
||||
runCtx, cancel := context.WithCancel(s.ctx)
|
||||
captureFns, listener := s.buildRuntime(runCtx, cfg)
|
||||
rt := &statsRuntime{cancel: cancel, listener: listener}
|
||||
s.run = rt
|
||||
done := make(chan struct{})
|
||||
s.loopDone = done
|
||||
s.runMu.Unlock()
|
||||
|
||||
// Prime before serving, so a scrape that lands before the first tick sees real values instead of zeros (issue #907)
|
||||
for _, fn := range captureFns {
|
||||
fn()
|
||||
}
|
||||
go captureStatsLoop(runCtx, cfg.interval, captureFns, done)
|
||||
go captureStatsLoop(runCtx, cfg.interval, captureFns)
|
||||
|
||||
cleanExit := true
|
||||
if listener == nil {
|
||||
@@ -232,12 +218,13 @@ func (s *statsServer) serveListener(listener *http.Server) bool {
|
||||
|
||||
// Stop tears down the active runtime, if any. Idempotent.
|
||||
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()
|
||||
defer s.runMu.Unlock()
|
||||
rt := s.run
|
||||
s.run = nil
|
||||
if rt != nil {
|
||||
s.runMu.Unlock()
|
||||
if rt == nil {
|
||||
return
|
||||
}
|
||||
rt.cancel()
|
||||
if rt.listener != nil {
|
||||
shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||
@@ -247,17 +234,10 @@ func (s *statsServer) Stop() {
|
||||
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
|
||||
// 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(ctx context.Context, cfg statsConfig) ([]func(), *http.Server) {
|
||||
func (s *statsServer) buildRuntime(cfg statsConfig) ([]func(), *http.Server) {
|
||||
// rcrowley/go-metrics guards these registrations with a private sync.Once,
|
||||
// so subsequent reloads are no-ops.
|
||||
metrics.RegisterDebugGCStats(metrics.DefaultRegistry)
|
||||
@@ -267,9 +247,6 @@ func (s *statsServer) buildRuntime(ctx context.Context, cfg statsConfig) ([]func
|
||||
func() { metrics.CaptureDebugGCStatsOnce(metrics.DefaultRegistry) },
|
||||
func() { metrics.CaptureRuntimeMemStatsOnce(metrics.DefaultRegistry) },
|
||||
}
|
||||
if s.emitStats != nil {
|
||||
captureFns = append(captureFns, s.emitStats)
|
||||
}
|
||||
|
||||
switch cfg.typ {
|
||||
case "graphite":
|
||||
@@ -285,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},
|
||||
}
|
||||
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)
|
||||
}
|
||||
})
|
||||
@@ -332,10 +309,8 @@ func (s *statsServer) buildRuntime(ctx context.Context, cfg statsConfig) ([]func
|
||||
return captureFns, nil
|
||||
}
|
||||
|
||||
// captureStatsLoop runs each fn on every tick of d until ctx is cancelled, then
|
||||
// closes done.
|
||||
func captureStatsLoop(ctx context.Context, d time.Duration, fns []func(), done chan struct{}) {
|
||||
defer close(done)
|
||||
// captureStatsLoop runs each fn on every tick of d until ctx is cancelled.
|
||||
func captureStatsLoop(ctx context.Context, d time.Duration, fns []func()) {
|
||||
t := time.NewTicker(d)
|
||||
defer t.Stop()
|
||||
for {
|
||||
|
||||
+29
-294
@@ -2,18 +2,13 @@ package nebula
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"log/slog"
|
||||
"net"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strconv"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/rcrowley/go-metrics"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"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) {
|
||||
h := newGraphiteHost(t, 0)
|
||||
sink := newGraphiteSink(t)
|
||||
defer sink.Close()
|
||||
|
||||
s, c := newTestStatsServer(t)
|
||||
setStatsConfig(c, map[string]any{
|
||||
"type": "graphite",
|
||||
"interval": "1s",
|
||||
"protocol": "tcp",
|
||||
"host": h.ln.Addr().String(),
|
||||
"host": sink.Addr(),
|
||||
"prefix": "test",
|
||||
})
|
||||
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
|
||||
// a reload spawned that hasn't run yet, then Stop waits out the last pass, so nothing captures into the next test
|
||||
func stopAtCleanup(t *testing.T, s **statsServer) context.Context {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
t.Cleanup(func() {
|
||||
cancel()
|
||||
if *s != nil {
|
||||
(*s).Stop()
|
||||
// graphiteSink is a minimal TCP accept-and-discard server so graphiteOnce
|
||||
// calls in tests don't spam error logs or wedge on connection refused.
|
||||
type graphiteSink struct {
|
||||
ln net.Listener
|
||||
}
|
||||
})
|
||||
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 {
|
||||
t.Helper()
|
||||
@@ -396,280 +408,3 @@ func freeTCPPort(t *testing.T) string {
|
||||
require.NoError(t, ln.Close())
|
||||
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")
|
||||
}
|
||||
+10
-3
@@ -43,12 +43,19 @@ type Conn interface {
|
||||
// its own packet, so a short count means some peers were undeliverable, not that the batch failed.
|
||||
// Not safe for concurrent use on the same Conn.
|
||||
WriteBatch(bufs [][]byte, addrs []netip.AddrPort) (int, error)
|
||||
// ReloadConfig applies the listen settings that can change, r is nil at startup
|
||||
ReloadConfig(c *config.C, r *config.Reload)
|
||||
ReloadConfig(c *config.C)
|
||||
SupportsMultipleReaders() bool
|
||||
Close() error
|
||||
}
|
||||
|
||||
// EstablishedPeerConn is a Conn that treats the remotes of established tunnels differently from other
|
||||
// destinations, as darwin's gives busy ones connected sockets.
|
||||
type EstablishedPeerConn interface {
|
||||
// SetEstablishedPeer reports whether dst is the current remote of at least one established tunnel. Calls for
|
||||
// one dst must not race each other.
|
||||
SetEstablishedPeer(dst netip.AddrPort, established bool)
|
||||
}
|
||||
|
||||
type NoopConn struct{}
|
||||
|
||||
func (NoopConn) Rebind() error {
|
||||
@@ -69,7 +76,7 @@ func (NoopConn) WriteTo(_ []byte, _ netip.AddrPort) error {
|
||||
func (NoopConn) WriteBatch(bufs [][]byte, _ []netip.AddrPort) (int, error) {
|
||||
return len(bufs), nil
|
||||
}
|
||||
func (NoopConn) ReloadConfig(_ *config.C, _ *config.Reload) {
|
||||
func (NoopConn) ReloadConfig(_ *config.C) {
|
||||
return
|
||||
}
|
||||
func (NoopConn) Close() error {
|
||||
|
||||
@@ -0,0 +1,106 @@
|
||||
//go:build !e2e_testing
|
||||
|
||||
package udp
|
||||
|
||||
import (
|
||||
"log/slog"
|
||||
"net"
|
||||
"net/netip"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// benchConnSocks opens a wildcard listener with ListenOut running and cfg applied, and a loopback peer that never
|
||||
// reads, so its sends cost only the sender.
|
||||
func benchConnSocks(b *testing.B, s Settings, cfg func(*connSockConfig)) (*StdConn, netip.AddrPort) {
|
||||
b.Helper()
|
||||
c, err := NewListener(slog.New(slog.DiscardHandler), s)
|
||||
if err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
b.Cleanup(func() { _ = c.Close() })
|
||||
u := c.(*StdConn)
|
||||
if cfg != nil {
|
||||
cfg(&u.socks.cfg)
|
||||
}
|
||||
go func() { _ = u.ListenOut(func(netip.AddrPort, []byte) {}, func() {}) }()
|
||||
for !u.listening.Load() {
|
||||
time.Sleep(time.Millisecond)
|
||||
}
|
||||
pc, err := net.ListenPacket("udp4", "127.0.0.1:0")
|
||||
if err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
b.Cleanup(func() { _ = pc.Close() })
|
||||
return u, pc.LocalAddr().(*net.UDPAddr).AddrPort()
|
||||
}
|
||||
|
||||
// BenchmarkConnSockWriteTo measures one WriteTo of a full-size datagram down each path: the listener with
|
||||
// connected sockets off, to a destination that is no tunnel's remote while another is, to an established peer
|
||||
// that never gets busy, and on a connected socket.
|
||||
func BenchmarkConnSockWriteTo(b *testing.B) {
|
||||
pkt := make([]byte, 1400)
|
||||
cases := []struct {
|
||||
name string
|
||||
cfg func(*connSockConfig)
|
||||
setup func(b *testing.B, u *StdConn, dst netip.AddrPort)
|
||||
}{
|
||||
{name: "listener/off", cfg: func(c *connSockConfig) { c.max = 0 }},
|
||||
{name: "listener/ineligible", setup: func(b *testing.B, u *StdConn, dst netip.AddrPort) {
|
||||
u.SetEstablishedPeer(netip.AddrPortFrom(dst.Addr(), dst.Port()+1), true)
|
||||
}},
|
||||
{name: "listener/eligible-not-busy", cfg: func(c *connSockConfig) { c.run = 1 << 30 },
|
||||
setup: func(b *testing.B, u *StdConn, dst netip.AddrPort) { u.SetEstablishedPeer(dst, true) }},
|
||||
{name: "connected", setup: func(b *testing.B, u *StdConn, dst netip.AddrPort) {
|
||||
u.SetEstablishedPeer(dst, true)
|
||||
for range u.socks.cfg.run {
|
||||
_ = u.WriteTo(pkt, dst)
|
||||
}
|
||||
if u.connSockFor(dst) == nil {
|
||||
b.Fatal("no connected socket")
|
||||
}
|
||||
}},
|
||||
}
|
||||
for _, c := range cases {
|
||||
b.Run(c.name, func(b *testing.B) {
|
||||
u, dst := benchConnSocks(b, Settings{Listen: netip.MustParseAddrPort("0.0.0.0:0")}, c.cfg)
|
||||
if c.setup != nil {
|
||||
c.setup(b, u, dst)
|
||||
}
|
||||
b.ReportAllocs()
|
||||
b.ResetTimer()
|
||||
for range b.N {
|
||||
_ = u.WriteTo(pkt, dst)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// BenchmarkConnSockDispatch measures what WriteTo adds before the listener's sendto, without the syscall: a v4
|
||||
// listener refuses a v6 destination before sending, with connected sockets off or with another peer established.
|
||||
func BenchmarkConnSockDispatch(b *testing.B) {
|
||||
pkt := make([]byte, 1400)
|
||||
dst := netip.MustParseAddrPort("[::1]:4242")
|
||||
for _, c := range []struct {
|
||||
name string
|
||||
cfg func(*connSockConfig)
|
||||
establish bool
|
||||
}{
|
||||
{name: "off", cfg: func(c *connSockConfig) { c.max = 0 }},
|
||||
{name: "ineligible", establish: true},
|
||||
} {
|
||||
b.Run(c.name, func(b *testing.B) {
|
||||
u, peer := benchConnSocks(b, Settings{Listen: netip.MustParseAddrPort("127.0.0.1:0"), Multi: true}, c.cfg)
|
||||
if c.establish {
|
||||
u.SetEstablishedPeer(peer, true)
|
||||
}
|
||||
b.ReportAllocs()
|
||||
b.ResetTimer()
|
||||
for range b.N {
|
||||
if u.WriteTo(pkt, dst) == nil {
|
||||
b.Fatal("sent a v6 datagram on a v4 listener")
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,839 @@
|
||||
//go:build !e2e_testing
|
||||
|
||||
package udp
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"maps"
|
||||
"net"
|
||||
"net/netip"
|
||||
"os"
|
||||
"slices"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
"syscall"
|
||||
"time"
|
||||
"unsafe"
|
||||
|
||||
"github.com/slackhq/nebula/internal/msgx"
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// A connected socket is a UDP socket connected to one busy peer, on the listener's port and bound to the source
|
||||
// address the listener's route to that peer picks, so the peer sees the same address and port from either. A send
|
||||
// on a connected socket skips the per-datagram address and MAC policy checks, and the EndpointSecurity send check
|
||||
// that xprotectd can hold every unconnected sendto on, and it is the only UDP send that reports the interface
|
||||
// queue's flow control, as ENOBUFS. A connected socket wins xnu's lookup for its peer's datagrams; it never sees
|
||||
// anyone else's.
|
||||
//
|
||||
// A connected socket sets SO_REUSEPORT and binds a specific address beside a wildcard listener, which sets
|
||||
// SO_REUSEPORT only for listen routines. xnu refuses a wildcard SO_REUSEPORT bind beside a holder without the
|
||||
// option, and refuses another uid's bind to an address a socket holds specifically, so no other user can join the
|
||||
// port while connected sockets open and close: uid nobody got EADDRINUSE on every bind against a root listener
|
||||
// with connected sockets in the 09-25 probes. A connected socket is closed, never disconnected, because xnu widens
|
||||
// a disconnected socket's local address to the wildcard.
|
||||
//
|
||||
// Only the current remote of an established tunnel may get one: Nebula names those with SetEstablishedPeer, so an
|
||||
// unauthenticated sender can't earn a connected socket by drawing replies such as recv_error or handshake
|
||||
// responses.
|
||||
type connSock struct {
|
||||
dst netip.AddrPort
|
||||
peer *connSockPeer
|
||||
conn *net.UDPConn
|
||||
rc syscall.RawConn
|
||||
// used is the monotonic time in nanoseconds of the connected socket's last send or receive.
|
||||
used atomic.Int64
|
||||
// stallAt is the monotonic time of the first ENOBUFS or EAGAIN since a send last went through, or 0, and
|
||||
// dropping is set once that stall has dropped a datagram, so each stall logs its drops once.
|
||||
stallAt atomic.Int64
|
||||
dropping atomic.Bool
|
||||
// parkMu serializes the writes that wait for a full send buffer, since the write deadline bounding each wait
|
||||
// is the descriptor's, not the writer's.
|
||||
parkMu sync.Mutex
|
||||
// sys writes bufs on the descriptor and returns how many went out: sendFd, or a stand-in for the interface in
|
||||
// tests.
|
||||
sys func(fd int, bufs [][]byte, x *sendScratch) (int, error)
|
||||
}
|
||||
|
||||
// sendScratch is the msghdr_x array one sendmsg_x reads.
|
||||
type sendScratch struct {
|
||||
hdrs [msgx.Batch]msgx.Hdr
|
||||
iovs [msgx.Batch]unix.Iovec
|
||||
}
|
||||
|
||||
// noSendX is set once sendmsg_x is refused; connected sockets then write one datagram per syscall.
|
||||
var noSendX atomic.Bool
|
||||
|
||||
// sendFd writes bufs on fd, a lone datagram with write and more with one sendmsg_x, which xnu runs through the stack
|
||||
// as a batch on a connected socket. It returns how many went out, or none and the errno. sendmsg_x reports EAGAIN,
|
||||
// ENOBUFS and EMSGSIZE only when it took nothing, and any other error without the count it took, which a connected
|
||||
// socket gets only on its first datagram, as its peer's unreachable.
|
||||
func sendFd(fd int, bufs [][]byte, x *sendScratch) (int, error) {
|
||||
if len(bufs) == 1 {
|
||||
if _, err := syscall.Write(fd, bufs[0]); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
return 1, nil
|
||||
}
|
||||
n := min(len(bufs), msgx.Batch)
|
||||
for i, b := range bufs[:n] {
|
||||
x.iovs[i] = unix.Iovec{Base: unsafe.SliceData(b)}
|
||||
x.iovs[i].SetLen(len(b))
|
||||
x.hdrs[i] = msgx.Hdr{Iov: &x.iovs[i], Iovlen: 1}
|
||||
}
|
||||
sent, errno := msgx.Send(uintptr(fd), x.hdrs[:n])
|
||||
clear(x.iovs[:n])
|
||||
if errno != 0 {
|
||||
return 0, errno
|
||||
}
|
||||
if sent == 0 {
|
||||
return 0, syscall.EAGAIN
|
||||
}
|
||||
return sent, nil
|
||||
}
|
||||
|
||||
// errStallSpent is a write that found the connected socket's stall budget spent, so its datagram is dropped.
|
||||
var errStallSpent = errors.New("connected socket stall budget spent")
|
||||
|
||||
// connSockWriter carries one write through RawConn.Write. They are pooled with fn bound once, since a closure
|
||||
// passed through the RawConn interface escapes and would allocate on every send.
|
||||
type connSockWriter struct {
|
||||
s *connSock
|
||||
// bufs holds a copy of the datagrams' slice headers rather than the caller's slice, which would escape
|
||||
// through the pool and cost WriteTo's one-datagram array an allocation per send.
|
||||
bufs [msgx.Batch][]byte
|
||||
nbufs int
|
||||
park bool
|
||||
n int
|
||||
err error
|
||||
fn func(fd uintptr) bool
|
||||
x sendScratch
|
||||
}
|
||||
|
||||
var connSockWriters = sync.Pool{New: func() any {
|
||||
w := &connSockWriter{}
|
||||
w.fn = w.write
|
||||
return w
|
||||
}}
|
||||
|
||||
func (w *connSockWriter) write(fd uintptr) bool {
|
||||
for {
|
||||
w.n, w.err = w.s.sys(int(fd), w.bufs[:w.nbufs], &w.x)
|
||||
switch {
|
||||
case w.err == syscall.EINTR:
|
||||
case w.err == syscall.EAGAIN && w.park:
|
||||
return false
|
||||
default:
|
||||
return true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// try writes bufs on s once and returns how many went out, or none and the write's errno,
|
||||
// os.ErrDeadlineExceeded, or net.ErrClosed. With park set, EAGAIN waits in the netpoller until the socket is
|
||||
// writable or the write deadline passes; without it, EAGAIN is returned.
|
||||
func (s *connSock) try(bufs [][]byte, park bool) (int, error) {
|
||||
w := connSockWriters.Get().(*connSockWriter)
|
||||
w.s, w.nbufs, w.park = s, copy(w.bufs[:], bufs), park
|
||||
rerr := s.rc.Write(w.fn)
|
||||
n, err := w.n, w.err
|
||||
clear(w.bufs[:w.nbufs])
|
||||
w.s, w.nbufs, w.n, w.err = nil, 0, 0, nil
|
||||
connSockWriters.Put(w)
|
||||
switch {
|
||||
case rerr == nil:
|
||||
return n, err
|
||||
case errors.Is(rerr, os.ErrDeadlineExceeded):
|
||||
return 0, os.ErrDeadlineExceeded
|
||||
default:
|
||||
return 0, net.ErrClosed
|
||||
}
|
||||
}
|
||||
|
||||
// connSockConfig holds the knobs, which tests change.
|
||||
type connSockConfig struct {
|
||||
// max is how many connected sockets the listen routines may have open at once; 0 turns connected sockets off.
|
||||
max int
|
||||
// run is how many datagrams to one destination within one window earn it a connected socket. darwin's tun
|
||||
// hands over one packet per read, so a peer's sends arrive one WriteTo or one-datagram batch at a time and
|
||||
// busyness has to be counted across calls.
|
||||
run int
|
||||
window time.Duration
|
||||
// idle closes a connected socket after it has neither sent nor received for this long.
|
||||
idle time.Duration
|
||||
// backoff keeps a destination whose connected socket failed on the listener for this long.
|
||||
backoff time.Duration
|
||||
// openEvery is how often the open bucket earns back an open once max are spent, which bounds connected socket
|
||||
// churn however fast senders earn connected sockets and errors close them.
|
||||
openEvery time.Duration
|
||||
// enobufsMax is how long a connected socket's sends may wait out ENOBUFS without one going through before they
|
||||
// drop instead, so a suspended interface costs one write per datagram rather than stalling the tun reader.
|
||||
enobufsMax time.Duration
|
||||
}
|
||||
|
||||
func defaultConnSockConfig() connSockConfig {
|
||||
return connSockConfig{
|
||||
max: 8,
|
||||
run: 64,
|
||||
window: time.Second,
|
||||
idle: 30 * time.Second,
|
||||
backoff: 30 * time.Second,
|
||||
openEvery: time.Second,
|
||||
enobufsMax: 10 * time.Millisecond,
|
||||
}
|
||||
}
|
||||
|
||||
// connSockGroups holds the connSocks that the listen routines bound to one address share, so the limits, the
|
||||
// connected sockets and Rebind cover every routine, and a peer has at most one connected socket.
|
||||
var connSockGroups = struct {
|
||||
sync.Mutex
|
||||
m map[netip.AddrPort]*connSocks
|
||||
}{m: map[netip.AddrPort]*connSocks{}}
|
||||
|
||||
// joinConnSocks returns the connSocks u shares with the other listen routines bound to la, and makes it for the
|
||||
// first.
|
||||
func joinConnSocks(u *StdConn, la netip.AddrPort, s Settings) *connSocks {
|
||||
g := &connSockGroups
|
||||
g.Lock()
|
||||
defer g.Unlock()
|
||||
if cs := g.m[la]; s.Multi && cs != nil {
|
||||
cs.mu.Lock()
|
||||
cs.members = append(cs.members, u)
|
||||
cs.mu.Unlock()
|
||||
return cs
|
||||
}
|
||||
cs := &connSocks{cfg: defaultConnSockConfig(), key: la, members: []*StdConn{u}, clock: monoNow, sleep: time.Sleep}
|
||||
if cs.cfg.max > 0 && !u.listenHost.IsUnspecified() && !s.Multi {
|
||||
// A connected socket on a specific listen.host binds the listener's own address, which xnu allows only when
|
||||
// both sockets set SO_REUSEPORT, and a listener with it lets another uid bind a dual-stack wildcard on the
|
||||
// port.
|
||||
cs.off.Store(true)
|
||||
u.l.Debug("connected sockets: off for a specific listen.host", "addr", s.Listen)
|
||||
}
|
||||
if s.Multi {
|
||||
g.m[la] = cs
|
||||
}
|
||||
return cs
|
||||
}
|
||||
|
||||
type connSocks struct {
|
||||
cfg connSockConfig
|
||||
// key is the listeners' bound address, which connSockGroups files this under.
|
||||
key netip.AddrPort
|
||||
// off keeps connected sockets from opening, when the listener's address can't be shared with them.
|
||||
off atomic.Bool
|
||||
// table maps each destination that is the remote of an established tunnel, and that a connected socket could
|
||||
// reach, to its peer; it is nil when there are none, so a send with nothing to consider costs one load. Every
|
||||
// send reads it without a lock, and mu guards copying it. An open that holds mu and still finds its peer here
|
||||
// can't outlive the tunnel.
|
||||
table atomic.Pointer[map[netip.AddrPort]*connSockPeer]
|
||||
// reserved counts the connected sockets that are open, opening or closing, against cfg.max; mu guards changing it.
|
||||
reserved atomic.Int32
|
||||
mu sync.Mutex
|
||||
closed bool
|
||||
// members are the listen routines' listeners that share these connected sockets.
|
||||
members []*StdConn
|
||||
// pending holds each destination whose connected socket is opening or closing, and not on its peer. xnu
|
||||
// refuses to connect a 4-tuple that is still bound, so a destination in pending can't open another.
|
||||
pending map[netip.AddrPort]struct{}
|
||||
// rebinds counts Rebinds, so an open that copied the listener's interface before one is discarded.
|
||||
rebinds uint64
|
||||
// closers tracks the goroutines that close detached connected sockets.
|
||||
closers sync.WaitGroup
|
||||
// done stops the reaper; it is made when ListenOut starts the connected sockets.
|
||||
done chan struct{}
|
||||
// opens bounds connected socket opens to cfg.max at once and one per cfg.openEvery after.
|
||||
opens gcra
|
||||
// logs bounds connected socket log lines at info or warn; see connSockLogBurst.
|
||||
logs gcra
|
||||
// clock returns monotonic nanoseconds and sleep waits out ENOBUFS: monoNow and time.Sleep, or stand-ins in
|
||||
// tests.
|
||||
clock func() int64
|
||||
sleep func(time.Duration)
|
||||
// dialHook and closeHook, when set, run just before an open's dials and a close's Close, outside mu; tests
|
||||
// use them to hold an open or close in flight.
|
||||
dialHook, closeHook func(dst netip.AddrPort)
|
||||
}
|
||||
|
||||
// connSockPeer is what connSocks keeps about an established tunnel's remote: its connected socket, how busy it is,
|
||||
// and how long a failed connected socket keeps it on the listener.
|
||||
type connSockPeer struct {
|
||||
sock atomic.Pointer[connSock]
|
||||
// windowMu guards start, the monotonic time the current window began, and n, the datagrams sent in it, so a
|
||||
// window's reset and its counts can't interleave with another sender's.
|
||||
windowMu sync.Mutex
|
||||
start int64
|
||||
n int
|
||||
// retryAt is the monotonic time before which a peer whose connected socket failed stays on the listener;
|
||||
// connSocks.mu guards it.
|
||||
retryAt int64
|
||||
}
|
||||
|
||||
// busy counts n more datagrams to p and reports whether it has now sent cfg.run within one window. A busy peer's
|
||||
// count starts over, so a peer that can't get a connected socket retries at most once per cfg.run sends.
|
||||
func (p *connSockPeer) busy(now int64, n int, cfg *connSockConfig) bool {
|
||||
p.windowMu.Lock()
|
||||
defer p.windowMu.Unlock()
|
||||
if time.Duration(now-p.start) > cfg.window {
|
||||
p.start, p.n = now, 0
|
||||
}
|
||||
p.n += n
|
||||
if p.n < cfg.run {
|
||||
return false
|
||||
}
|
||||
p.n = 0
|
||||
return true
|
||||
}
|
||||
|
||||
// connSockLogBurst and connSockLogEvery size the bucket that lets connected socket opens, closes and failures log
|
||||
// at info or warn; past it they log at debug, so churn can't flood the log.
|
||||
const (
|
||||
connSockLogBurst = 32
|
||||
connSockLogEvery = 10 * time.Second
|
||||
)
|
||||
|
||||
var monoStart = time.Now()
|
||||
|
||||
func monoNow() int64 { return int64(time.Since(monoStart)) }
|
||||
|
||||
// gcra is a token bucket kept as the monotonic time it is next full (the generic cell rate algorithm), so it needs
|
||||
// no refill tick.
|
||||
type gcra struct{ tat int64 }
|
||||
|
||||
// take spends a token from a bucket of burst that earns one back per every, and reports whether there was one to
|
||||
// spend.
|
||||
func (g *gcra) take(now int64, burst int, every time.Duration) bool {
|
||||
e := int64(every)
|
||||
tat := max(g.tat, now)
|
||||
if tat-now > int64(burst-1)*e {
|
||||
return false
|
||||
}
|
||||
g.tat = tat + e
|
||||
return true
|
||||
}
|
||||
|
||||
// logLevelLocked returns level while the log bucket has a token, and debug once it is spent.
|
||||
func (cs *connSocks) logLevelLocked(level slog.Level) slog.Level {
|
||||
if cs.logs.take(cs.clock(), connSockLogBurst, connSockLogEvery) {
|
||||
return level
|
||||
}
|
||||
return slog.LevelDebug
|
||||
}
|
||||
|
||||
// startConnSocks starts the idle reaper.
|
||||
func (u *StdConn) startConnSocks() {
|
||||
cs := u.socks
|
||||
cs.mu.Lock()
|
||||
defer cs.mu.Unlock()
|
||||
if cs.closed || cs.done != nil || cs.cfg.max <= 0 || cs.off.Load() {
|
||||
return
|
||||
}
|
||||
cs.done = make(chan struct{})
|
||||
go u.reapConnSocks(cs.done)
|
||||
}
|
||||
|
||||
// stopConnSocks closes every connected socket and keeps new ones from opening, once any listen routine's listener
|
||||
// closes, as they do together at shutdown. It returns once their descriptors are closed.
|
||||
func (u *StdConn) stopConnSocks() {
|
||||
cs := u.socks
|
||||
cs.mu.Lock()
|
||||
cs.members = slices.DeleteFunc(cs.members, func(m *StdConn) bool { return m == u })
|
||||
if !cs.closed {
|
||||
cs.closed = true
|
||||
if cs.done != nil {
|
||||
close(cs.done)
|
||||
}
|
||||
u.detachAllLocked("close")
|
||||
}
|
||||
cs.mu.Unlock()
|
||||
connSockGroups.Lock()
|
||||
if connSockGroups.m[cs.key] == cs {
|
||||
delete(connSockGroups.m, cs.key)
|
||||
}
|
||||
connSockGroups.Unlock()
|
||||
cs.closers.Wait()
|
||||
}
|
||||
|
||||
// siblings returns the other listen routines' listeners.
|
||||
func (cs *connSocks) siblings(u *StdConn) []*StdConn {
|
||||
cs.mu.Lock()
|
||||
defer cs.mu.Unlock()
|
||||
return slices.DeleteFunc(slices.Clone(cs.members), func(m *StdConn) bool { return m == u })
|
||||
}
|
||||
|
||||
// connSockFor returns dst's connected socket, or nil.
|
||||
func (u *StdConn) connSockFor(dst netip.AddrPort) *connSock {
|
||||
if p := u.socks.peer(dst); p != nil {
|
||||
return p.sock.Load()
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (cs *connSocks) peer(dst netip.AddrPort) *connSockPeer {
|
||||
if t := cs.table.Load(); t != nil {
|
||||
return (*t)[dst]
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// SetEstablishedPeer makes dst eligible for a connected socket while it is the remote of an established tunnel,
|
||||
// and closes the one it has once it no longer is. Nebula calls it for every listen routine under the hostmap's
|
||||
// write lock, so repeats are no-ops and it makes no syscalls: the descriptor is closed by another goroutine.
|
||||
func (u *StdConn) SetEstablishedPeer(dst netip.AddrPort, established bool) {
|
||||
cs := u.socks
|
||||
if cs.cfg.max <= 0 || cs.off.Load() || !u.connSockable(dst) {
|
||||
return
|
||||
}
|
||||
cs.mu.Lock()
|
||||
defer cs.mu.Unlock()
|
||||
t := cs.table.Load()
|
||||
p := cs.peer(dst)
|
||||
if cs.closed || (p != nil) == established {
|
||||
return
|
||||
}
|
||||
next := map[netip.AddrPort]*connSockPeer{}
|
||||
if t != nil {
|
||||
next = maps.Clone(*t)
|
||||
}
|
||||
if established {
|
||||
p = &connSockPeer{start: cs.clock()}
|
||||
next[dst] = p
|
||||
} else {
|
||||
delete(next, dst)
|
||||
if s := p.sock.Load(); s != nil {
|
||||
u.detachLocked(s, "tunnel gone", false)
|
||||
}
|
||||
}
|
||||
cs.storeTableLocked(next)
|
||||
}
|
||||
|
||||
// storeTableLocked publishes t, or nil for an empty one.
|
||||
func (cs *connSocks) storeTableLocked(t map[netip.AddrPort]*connSockPeer) {
|
||||
if len(t) == 0 {
|
||||
cs.table.Store(nil)
|
||||
return
|
||||
}
|
||||
cs.table.Store(&t)
|
||||
}
|
||||
|
||||
// connSockable reports whether a connected socket to dst could send what the listener would. A v4 listener can't
|
||||
// reach a v6 destination at all, and a connected socket bound to a specific listen.host must share its family.
|
||||
func (u *StdConn) connSockable(dst netip.AddrPort) bool {
|
||||
if !dst.IsValid() || dst.Port() == 0 {
|
||||
return false
|
||||
}
|
||||
if u.isV4 {
|
||||
return dst.Addr().Is4()
|
||||
}
|
||||
return u.listenHost.IsUnspecified() || u.listenHost.Unmap().Is4() == dst.Addr().Unmap().Is4()
|
||||
}
|
||||
|
||||
// connSockRun sends bufs, all to p's destination, on p's connected socket, opening one if they make p busy. It
|
||||
// returns how many went out; when that is short of len(bufs), err is the failure of bufs[sent], or nil to leave
|
||||
// bufs[sent:] to the listener.
|
||||
func (u *StdConn) connSockRun(p *connSockPeer, dst netip.AddrPort, bufs [][]byte) (sent int, err error) {
|
||||
s := p.sock.Load()
|
||||
if s == nil {
|
||||
if s = u.maybeOpenConnSock(p, dst, len(bufs)); s == nil {
|
||||
return 0, nil
|
||||
}
|
||||
}
|
||||
sent, errno, closed := u.connSockWrite(s, bufs)
|
||||
switch {
|
||||
case sent == len(bufs):
|
||||
case connSockDead(errno):
|
||||
u.closeConnSock(s, errno.Error(), true)
|
||||
case !closed:
|
||||
return sent, &net.OpError{Op: "write", Err: errno}
|
||||
}
|
||||
return sent, nil
|
||||
}
|
||||
|
||||
// maybeOpenConnSock counts n datagrams to p, and opens a connected socket to it once it is busy and nothing rules
|
||||
// one out.
|
||||
func (u *StdConn) maybeOpenConnSock(p *connSockPeer, dst netip.AddrPort, n int) *connSock {
|
||||
cs := u.socks
|
||||
if n <= 0 || !u.listening.Load() || int(cs.reserved.Load()) >= cs.cfg.max || !p.busy(cs.clock(), n, &cs.cfg) {
|
||||
return nil
|
||||
}
|
||||
cs.mu.Lock()
|
||||
if cs.closed || cs.peer(dst) != p {
|
||||
cs.mu.Unlock()
|
||||
return nil
|
||||
}
|
||||
if s := p.sock.Load(); s != nil {
|
||||
cs.mu.Unlock()
|
||||
return s
|
||||
}
|
||||
now := cs.clock()
|
||||
if _, ok := cs.pending[dst]; ok || int(cs.reserved.Load()) >= cs.cfg.max || now < p.retryAt ||
|
||||
!cs.opens.take(now, cs.cfg.max, cs.cfg.openEvery) {
|
||||
cs.mu.Unlock()
|
||||
return nil
|
||||
}
|
||||
if cs.pending == nil {
|
||||
cs.pending = map[netip.AddrPort]struct{}{}
|
||||
}
|
||||
cs.pending[dst] = struct{}{}
|
||||
cs.reserved.Add(1)
|
||||
rebinds := cs.rebinds
|
||||
cs.mu.Unlock()
|
||||
|
||||
if cs.dialHook != nil {
|
||||
cs.dialHook(dst)
|
||||
}
|
||||
s, err := u.dialConnSock(p, dst)
|
||||
|
||||
cs.mu.Lock()
|
||||
if err != nil {
|
||||
delete(cs.pending, dst)
|
||||
cs.reserved.Add(-1)
|
||||
p.retryAt = cs.clock() + int64(cs.cfg.backoff)
|
||||
level := cs.logLevelLocked(slog.LevelWarn)
|
||||
cs.mu.Unlock()
|
||||
u.l.Log(context.Background(), level, "connected socket: open failed, staying on the listener", "udpAddr", dst, "error", err)
|
||||
return nil
|
||||
}
|
||||
if cs.closed || cs.rebinds != rebinds || cs.peer(dst) != p {
|
||||
// The tunnel went away, or a Rebind or shutdown ran, while the socket was opening; it stays in pending until
|
||||
// it is closed.
|
||||
cs.mu.Unlock()
|
||||
u.finishClose(s)
|
||||
u.l.Debug("connected socket: discarded, its tunnel or route changed while it opened", "udpAddr", dst)
|
||||
return nil
|
||||
}
|
||||
delete(cs.pending, dst)
|
||||
p.sock.Store(s)
|
||||
go u.readConnSock(s)
|
||||
level := cs.logLevelLocked(slog.LevelInfo)
|
||||
cs.mu.Unlock()
|
||||
u.l.Log(context.Background(), level, "connected socket: opened", "udpAddr", dst, "local", s.conn.LocalAddr(), "open", cs.reserved.Load())
|
||||
return s
|
||||
}
|
||||
|
||||
// dialConnSock opens a socket on the listener's port with SO_REUSEPORT, bound to the configured listen.host or,
|
||||
// for a wildcard listener, to the source address the route to dst picks, and connected to dst. It carries the
|
||||
// listener's IP_BOUND_IF, so both route the same way.
|
||||
func (u *StdConn) dialConnSock(p *connSockPeer, dst netip.AddrPort) (*connSock, error) {
|
||||
raddr := net.UDPAddrFromAddrPort(netip.AddrPortFrom(dst.Addr().Unmap(), dst.Port()))
|
||||
network := "udp6"
|
||||
if raddr.IP.To4() != nil {
|
||||
network = "udp4"
|
||||
}
|
||||
ifindex, err := u.boundIf()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
local := &net.UDPAddr{IP: u.listenHost.AsSlice(), Zone: u.listenHost.Zone()}
|
||||
if u.listenHost.IsUnspecified() {
|
||||
// A connected socket gets the source address xnu would pick for an unconnected send to dst.
|
||||
d := net.Dialer{Control: connSockControl(false, ifindex)}
|
||||
probe, err := d.Dial(network, raddr.String())
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
local = probe.LocalAddr().(*net.UDPAddr)
|
||||
_ = probe.Close()
|
||||
}
|
||||
local.Port = int(u.port)
|
||||
d := net.Dialer{LocalAddr: local, Control: connSockControl(true, ifindex)}
|
||||
c, err := d.Dial(network, raddr.String())
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
uc := c.(*net.UDPConn)
|
||||
rc, err := uc.SyscallConn()
|
||||
if err != nil {
|
||||
_ = uc.Close()
|
||||
return nil, err
|
||||
}
|
||||
s := &connSock{dst: dst, peer: p, conn: uc, rc: rc, sys: sendFd}
|
||||
s.used.Store(u.socks.clock())
|
||||
return s, nil
|
||||
}
|
||||
|
||||
// connSockControl sets SO_REUSEPORT when reuse is set, and IP_BOUND_IF or IPV6_BOUND_IF when ifindex isn't 0,
|
||||
// before the socket binds.
|
||||
func connSockControl(reuse bool, ifindex int) func(network, address string, c syscall.RawConn) error {
|
||||
return func(network, _ string, c syscall.RawConn) error {
|
||||
var serr error
|
||||
err := c.Control(func(fd uintptr) {
|
||||
if reuse {
|
||||
serr = unix.SetsockoptInt(int(fd), unix.SOL_SOCKET, unix.SO_REUSEPORT, 1)
|
||||
}
|
||||
if serr == nil && ifindex != 0 {
|
||||
if network == "udp4" {
|
||||
serr = unix.SetsockoptInt(int(fd), unix.IPPROTO_IP, unix.IP_BOUND_IF, ifindex)
|
||||
} else {
|
||||
serr = unix.SetsockoptInt(int(fd), unix.IPPROTO_IPV6, unix.IPV6_BOUND_IF, ifindex)
|
||||
}
|
||||
}
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return serr
|
||||
}
|
||||
}
|
||||
|
||||
// boundIf returns the interface index the listener is scoped to, or 0. An error keeps the peer on the listener,
|
||||
// since a connected socket opened without the listener's scope could route out an interface the listener can't.
|
||||
func (u *StdConn) boundIf() (int, error) {
|
||||
level, opt := unix.IPPROTO_IPV6, unix.IPV6_BOUND_IF
|
||||
if u.isV4 {
|
||||
level, opt = unix.IPPROTO_IP, unix.IP_BOUND_IF
|
||||
}
|
||||
v, err := unix.GetsockoptInt(int(u.sysFd), level, opt)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("reading the listener's bound interface: %w", err)
|
||||
}
|
||||
return v, nil
|
||||
}
|
||||
|
||||
// closeConnSock closes s if it is still open. With backoff set, the peer stays on the listener until the backoff
|
||||
// runs out.
|
||||
func (u *StdConn) closeConnSock(s *connSock, why string, backoff bool) {
|
||||
u.socks.mu.Lock()
|
||||
u.detachLocked(s, why, backoff)
|
||||
u.socks.mu.Unlock()
|
||||
}
|
||||
|
||||
// detachLocked takes s off its peer, if it is still there, and closes it on another goroutine, since callers such
|
||||
// as SetEstablishedPeer hold locks that no socket syscall should run under. s.dst stays in pending until the close
|
||||
// completes.
|
||||
func (u *StdConn) detachLocked(s *connSock, why string, backoff bool) {
|
||||
cs := u.socks
|
||||
if !s.peer.sock.CompareAndSwap(s, nil) {
|
||||
return
|
||||
}
|
||||
if backoff {
|
||||
s.peer.retryAt = cs.clock() + int64(cs.cfg.backoff)
|
||||
}
|
||||
if cs.pending == nil {
|
||||
cs.pending = map[netip.AddrPort]struct{}{}
|
||||
}
|
||||
cs.pending[s.dst] = struct{}{}
|
||||
level := cs.logLevelLocked(slog.LevelInfo)
|
||||
cs.closers.Add(1)
|
||||
go func() {
|
||||
defer cs.closers.Done()
|
||||
open := u.finishClose(s)
|
||||
u.l.Log(context.Background(), level, "connected socket: closed", "udpAddr", s.dst, "reason", why, "open", open)
|
||||
}()
|
||||
}
|
||||
|
||||
// finishClose closes s, whose destination is in pending, then lets the destination open again, and returns how
|
||||
// many connected sockets are left. Closing waits only for a write already in a syscall: a write parked on a full
|
||||
// buffer is woken, and one waiting out ENOBUFS holds no reference on the descriptor.
|
||||
func (u *StdConn) finishClose(s *connSock) int32 {
|
||||
cs := u.socks
|
||||
if cs.closeHook != nil {
|
||||
cs.closeHook(s.dst)
|
||||
}
|
||||
_ = s.conn.Close()
|
||||
cs.mu.Lock()
|
||||
defer cs.mu.Unlock()
|
||||
delete(cs.pending, s.dst)
|
||||
return cs.reserved.Add(-1)
|
||||
}
|
||||
|
||||
// detachAllLocked detaches every connected socket, for a network change or shutdown.
|
||||
func (u *StdConn) detachAllLocked(why string) {
|
||||
if t := u.socks.table.Load(); t != nil {
|
||||
for _, p := range *t {
|
||||
if s := p.sock.Load(); s != nil {
|
||||
u.detachLocked(s, why, false)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// closeConnSocks detaches every connected socket and discards the ones still opening, for a network change.
|
||||
func (u *StdConn) closeConnSocks(why string) {
|
||||
u.socks.mu.Lock()
|
||||
u.socks.rebinds++
|
||||
u.detachAllLocked(why)
|
||||
u.socks.mu.Unlock()
|
||||
}
|
||||
|
||||
func (u *StdConn) reapConnSocks(done <-chan struct{}) {
|
||||
cs := u.socks
|
||||
idle := cs.cfg.idle
|
||||
tick := time.NewTicker(max(min(idle/4, 5*time.Second), time.Millisecond))
|
||||
defer tick.Stop()
|
||||
for {
|
||||
select {
|
||||
case <-done:
|
||||
return
|
||||
case <-tick.C:
|
||||
}
|
||||
t := cs.table.Load()
|
||||
if t == nil {
|
||||
continue
|
||||
}
|
||||
now := cs.clock()
|
||||
for _, p := range *t {
|
||||
if s := p.sock.Load(); s != nil && time.Duration(now-s.used.Load()) > idle {
|
||||
u.closeConnSock(s, "idle", false)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// connSockDead reports whether a connected socket send or receive error means the connected path to the peer is
|
||||
// gone, so its traffic belongs back on the listener. A connected UDP socket reports a peer's ICMP unreachable as
|
||||
// ECONNREFUSED on its next call, which the unconnected listener never sees.
|
||||
func connSockDead(errno syscall.Errno) bool {
|
||||
switch errno {
|
||||
case unix.ECONNREFUSED, unix.EHOSTUNREACH, unix.EHOSTDOWN, unix.ENETUNREACH, unix.ENETDOWN,
|
||||
unix.EADDRNOTAVAIL, unix.EPIPE, unix.ENOTCONN, unix.EDESTADDRREQ:
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// enobufsWait is how long a connected socket send sleeps when the interface queue is flow controlled. The kernel
|
||||
// posts no wakeup when the advisory lifts, so this polls; 50us kept a gigabit link full without spinning a core in
|
||||
// the 09-25 probes.
|
||||
const enobufsWait = 50 * time.Microsecond
|
||||
|
||||
// connSockWrite writes bufs on s, up to msgx.Batch datagrams per sendmsg_x. A full socket buffer parks the caller in the netpoller
|
||||
// until the socket is writable, and a flow-controlled interface makes it wait out ENOBUFS, so a busy link slows
|
||||
// the tun reader instead of dropping. Once the connected socket has waited cfg.enobufsMax without a send going
|
||||
// through, either one drops the datagram instead, and a dropped datagram counts as sent, as the listener's
|
||||
// unreported interface drops do; it never falls back to the listener, which would reorder it. closed reports that
|
||||
// the connected socket was closed before bufs[sent] went out; any other error stops the run and is returned with
|
||||
// how many went out.
|
||||
func (u *StdConn) connSockWrite(s *connSock, bufs [][]byte) (sent int, errno syscall.Errno, closed bool) {
|
||||
cs := u.socks
|
||||
defer func() {
|
||||
if sent > 0 {
|
||||
s.used.Store(cs.clock())
|
||||
}
|
||||
}()
|
||||
probe := false
|
||||
for sent < len(bufs) {
|
||||
n := 1
|
||||
if !noSendX.Load() && !probe {
|
||||
n = len(bufs) - sent
|
||||
}
|
||||
k, err := s.try(bufs[sent:sent+n], false)
|
||||
if errno, ok := err.(syscall.Errno); ok && n > 1 && msgx.Unsupported(errno) {
|
||||
// EPERM may be the datagram's own fault, so sendmsg_x is off for good only once a plain write of the same
|
||||
// datagram goes through.
|
||||
probe = true
|
||||
continue
|
||||
}
|
||||
if probe && err == nil && noSendX.CompareAndSwap(false, true) {
|
||||
u.l.Warn("sendmsg_x unavailable, writing one datagram per syscall")
|
||||
}
|
||||
probe = false
|
||||
if err == syscall.EAGAIN || err == os.ErrDeadlineExceeded {
|
||||
// os.ErrDeadlineExceeded here is another writer's parked deadline, passed but not yet cleared.
|
||||
k, err = u.parkedWrite(s, bufs[sent:sent+1])
|
||||
}
|
||||
switch err {
|
||||
case nil:
|
||||
sent += k
|
||||
if s.stallAt.Load() != 0 {
|
||||
s.stallAt.Store(0)
|
||||
s.dropping.Store(false)
|
||||
}
|
||||
continue
|
||||
case errStallSpent:
|
||||
u.dropStalled(s)
|
||||
sent++
|
||||
continue
|
||||
}
|
||||
errno, ok := err.(syscall.Errno)
|
||||
if !ok {
|
||||
return sent, 0, true
|
||||
}
|
||||
if errno != syscall.ENOBUFS {
|
||||
return sent, errno, false
|
||||
}
|
||||
// The wait holds no reference on the descriptor, so a close doesn't wait for it.
|
||||
if s.stalledFor(cs.clock()) < cs.cfg.enobufsMax {
|
||||
cs.sleep(enobufsWait)
|
||||
} else {
|
||||
u.dropStalled(s)
|
||||
sent++
|
||||
}
|
||||
}
|
||||
return sent, 0, false
|
||||
}
|
||||
|
||||
// parkedWrite writes b after EAGAIN, parked in the netpoller for what is left of s's stall budget, and returns
|
||||
// errStallSpent once none is. golang/go#73919: a darwin UDP write parked on EAGAIN can wait forever for a
|
||||
// writability event that never comes, so the wait always has a deadline.
|
||||
func (u *StdConn) parkedWrite(s *connSock, b [][]byte) (int, error) {
|
||||
cs := u.socks
|
||||
s.parkMu.Lock()
|
||||
defer s.parkMu.Unlock()
|
||||
left := cs.cfg.enobufsMax - s.stalledFor(cs.clock())
|
||||
if left <= 0 {
|
||||
return 0, errStallSpent
|
||||
}
|
||||
if err := s.conn.SetWriteDeadline(time.Now().Add(left)); err != nil {
|
||||
return 0, net.ErrClosed
|
||||
}
|
||||
n, err := s.try(b, true)
|
||||
_ = s.conn.SetWriteDeadline(time.Time{})
|
||||
if err == os.ErrDeadlineExceeded {
|
||||
return 0, errStallSpent
|
||||
}
|
||||
return n, err
|
||||
}
|
||||
|
||||
// dropStalled logs the first datagram a stall drops.
|
||||
func (u *StdConn) dropStalled(s *connSock) {
|
||||
if !s.dropping.Swap(true) {
|
||||
u.l.Debug("connected socket: sends stalled, dropping datagrams until one goes through", "udpAddr", s.dst)
|
||||
}
|
||||
}
|
||||
|
||||
// stalledFor records an ENOBUFS or EAGAIN on s at now and returns how long its sends have stalled: since the first
|
||||
// ENOBUFS or EAGAIN after a send last went through. Every writer measures from that one time, so concurrent writers
|
||||
// spend the budget no faster than one, and a send going through ends the stall for every writer, including one
|
||||
// asleep in it.
|
||||
func (s *connSock) stalledFor(now int64) time.Duration {
|
||||
if s.stallAt.CompareAndSwap(0, now) {
|
||||
return 0
|
||||
}
|
||||
at := s.stallAt.Load()
|
||||
if at == 0 {
|
||||
return 0
|
||||
}
|
||||
return time.Duration(now - at)
|
||||
}
|
||||
|
||||
// readConnSock hands a connected socket's batches to ListenOut until the connected socket is closed. Any receive
|
||||
// error closes it: a connected socket reports its peer's unreachables here, and retrying an unexpected error could
|
||||
// spin.
|
||||
func (u *StdConn) readConnSock(s *connSock) {
|
||||
r := u.newBatchReader(s.conn, s.rc)
|
||||
for {
|
||||
b, err := u.read(r)
|
||||
if err != nil {
|
||||
if errors.Is(err, net.ErrClosed) {
|
||||
return
|
||||
}
|
||||
why := err.Error()
|
||||
var errno syscall.Errno
|
||||
if errors.As(err, &errno) && connSockDead(errno) {
|
||||
why = errno.Error()
|
||||
} else {
|
||||
u.l.Warn("connected socket: unexpected receive error", "udpAddr", s.dst, "error", err)
|
||||
}
|
||||
u.closeConnSock(s, why, true)
|
||||
return
|
||||
}
|
||||
s.used.Store(u.socks.clock())
|
||||
if !u.deliver(b) {
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large.
Load diff
@@ -24,12 +24,6 @@ type NetworkChangeMonitor struct {
|
||||
// NewNetworkChangeMonitor builds a monitor for local network changes. The returned monitor is always usable: Start
|
||||
// is safe to call unconditionally, it no-ops when disabled or on a platform that does not need it.
|
||||
func NewNetworkChangeMonitor(ctx context.Context, l *slog.Logger, c *config.C) *NetworkChangeMonitor {
|
||||
if watchesNetworkChanges {
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
r.RestartRequiredIfChanged("listen.rebind_on_network_change")
|
||||
})
|
||||
}
|
||||
|
||||
return &NetworkChangeMonitor{
|
||||
l: l,
|
||||
ctx: ctx,
|
||||
|
||||
@@ -13,9 +13,6 @@ import (
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// watchesNetworkChanges is true where Start does anything
|
||||
const watchesNetworkChanges = true
|
||||
|
||||
const (
|
||||
// netChangeSettleWindow is how long we keep swallowing routing messages after the first interesting one. A
|
||||
// single network change is never a single message, it is a burst: the link drops, addresses go away, new ones
|
||||
|
||||
@@ -7,9 +7,6 @@ import (
|
||||
"log/slog"
|
||||
)
|
||||
|
||||
// watchesNetworkChanges is true where Start does anything
|
||||
const watchesNetworkChanges = false
|
||||
|
||||
// watchNetworkChanges is a no-op outside of darwin.
|
||||
//
|
||||
// Darwin is the platform that scopes a udp socket to the interface it came up on, so it is the platform whose socket
|
||||
|
||||
Loaded 100 of 111 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user