mirror of
https://github.com/slackhq/nebula.git
synced 2026-11-16 18:56:52 +01:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
729301b409 |
No files matched your search
@@ -14,7 +14,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.27'
|
go-version: '1.26'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
@@ -40,7 +40,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.27'
|
go-version: '1.26'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
@@ -83,7 +83,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.27'
|
go-version: '1.26'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
# GitHub holds ARNs, not credentials, and ARNs outlive a rotation
|
# GitHub holds ARNs, not credentials, and ARNs outlive a rotation
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.27'
|
go-version: '1.26'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: add hashicorp source
|
- name: add hashicorp source
|
||||||
@@ -66,7 +66,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.27'
|
go-version: '1.26'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: add hashicorp source
|
- name: add hashicorp source
|
||||||
@@ -92,7 +92,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.27'
|
go-version: '1.26'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
# WSL2 + Ubuntu so the smoke can run a real linux peer with its own
|
# WSL2 + Ubuntu so the smoke can run a real linux peer with its own
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.27'
|
go-version: '1.26'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: Smoke Docker
|
- name: Smoke Docker
|
||||||
@@ -51,7 +51,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.27'
|
go-version: '1.26'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: build
|
- name: build
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.27'
|
go-version: '1.26'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: Install goimports
|
- name: Install goimports
|
||||||
@@ -42,7 +42,7 @@ jobs:
|
|||||||
- name: golangci-lint
|
- name: golangci-lint
|
||||||
uses: golangci/golangci-lint-action@v9
|
uses: golangci/golangci-lint-action@v9
|
||||||
with:
|
with:
|
||||||
version: v2.14
|
version: v2.12
|
||||||
|
|
||||||
test:
|
test:
|
||||||
name: Test ${{ matrix.name }}
|
name: Test ${{ matrix.name }}
|
||||||
@@ -87,7 +87,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.27'
|
go-version: '1.26'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
@@ -132,7 +132,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.27'
|
go-version: '1.26'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: Build ${{ matrix.name }}
|
- name: Build ${{ matrix.name }}
|
||||||
|
|||||||
@@ -85,10 +85,9 @@ func main() {
|
|||||||
fmt.Printf("failed to apply logging config: %s", err)
|
fmt.Printf("failed to apply logging config: %s", err)
|
||||||
os.Exit(1)
|
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 {
|
if err := logging.ApplyConfig(l, c); err != nil {
|
||||||
l.Error("Failed to reconfigure logger on reload", "error", err)
|
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 {
|
if err := logging.ApplyConfig(l, c); err != nil {
|
||||||
return fmt.Errorf("failed to apply logging config: %s", err)
|
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 {
|
if err := logging.ApplyConfig(l, c); err != nil {
|
||||||
l.Error("Failed to reconfigure logger on reload", "error", err)
|
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)
|
fmt.Printf("failed to apply logging config: %s", err)
|
||||||
os.Exit(1)
|
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 {
|
if err := logging.ApplyConfig(l, c); err != nil {
|
||||||
l.Error("Failed to reconfigure logger on reload", "error", err)
|
l.Error("Failed to reconfigure logger on reload", "error", err)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
+31
-40
@@ -26,12 +26,9 @@ type C struct {
|
|||||||
files []string
|
files []string
|
||||||
Settings map[string]any
|
Settings map[string]any
|
||||||
oldSettings map[string]any
|
oldSettings map[string]any
|
||||||
callbacks []func(*C, *Reload)
|
callbacks []func(*C)
|
||||||
l *slog.Logger
|
l *slog.Logger
|
||||||
reloadLock sync.Mutex
|
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 {
|
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
|
// 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
|
// 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.
|
// 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.
|
// 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)) {
|
||||||
func (c *C) RegisterReloadCallback(f func(c *C, r *Reload)) {
|
|
||||||
c.callbacks = append(c.callbacks, f)
|
c.callbacks = append(c.callbacks, f)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -148,55 +144,50 @@ func (c *C) CatchHUP(ctx context.Context) {
|
|||||||
return
|
return
|
||||||
case <-ch:
|
case <-ch:
|
||||||
c.l.Info("Caught HUP, reloading config")
|
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
|
func (c *C) ReloadConfig() {
|
||||||
// fails to load is logged here, like any other failure, and the result carries the error for the summary.
|
|
||||||
func (c *C) ReloadConfig() ReloadResult {
|
|
||||||
c.reloadLock.Lock()
|
c.reloadLock.Lock()
|
||||||
defer c.reloadLock.Unlock()
|
defer c.reloadLock.Unlock()
|
||||||
|
|
||||||
c.oldSettings = make(map[string]any)
|
c.oldSettings = make(map[string]any)
|
||||||
maps.Copy(c.oldSettings, c.Settings)
|
maps.Copy(c.oldSettings, c.Settings)
|
||||||
|
|
||||||
if err := c.Load(c.path); err != nil {
|
err := c.Load(c.path)
|
||||||
c.l.Error("Error occurred while reloading config", "config_path", c.path, "error", err)
|
if err != nil {
|
||||||
return ReloadResult{Err: err, RestartRequired: c.needsRestart}
|
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 {
|
for _, v := range c.callbacks {
|
||||||
v(c, r)
|
v(c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
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
|
||||||
}
|
}
|
||||||
|
|
||||||
if r.restart {
|
for _, v := range c.callbacks {
|
||||||
c.needsRestart = true
|
v(c)
|
||||||
}
|
}
|
||||||
return ReloadResult{Failed: r.failed, RestartRequired: c.needsRestart, RestartKeys: r.keys}
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetString will get the string for k or return the default d if not found or invalid
|
// 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
|
var nm map[string]any
|
||||||
err = yaml.Unmarshal(b, &nm)
|
err = yaml.Unmarshal(b, &nm)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("%s: %w", path, err)
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// We need to use WithAppendSlice so that firewall rules in separate
|
// We need to use WithAppendSlice so that firewall rules in separate
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ func TestConfig_Load(t *testing.T) {
|
|||||||
// invalid yaml
|
// invalid yaml
|
||||||
c := NewC(l)
|
c := NewC(l)
|
||||||
os.WriteFile(filepath.Join(dir, "01.yaml"), []byte(" invalid yaml"), 0644)
|
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
|
// simple multi config merge
|
||||||
c = NewC(l)
|
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)
|
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
|
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)
|
cm.reload(c, true)
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
r.RestartRequiredIfChanged("timers.connection_alive_interval", "timers.pending_deletion_interval")
|
|
||||||
cm.reload(c, false)
|
cm.reload(c, false)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
@@ -151,7 +151,7 @@ func (c *fakeConn) WriteTo(_ []byte, _ netip.AddrPort) error { return nil }
|
|||||||
func (c *fakeConn) WriteBatch(bufs [][]byte, _ []netip.AddrPort) (int, error) {
|
func (c *fakeConn) WriteBatch(bufs [][]byte, _ []netip.AddrPort) (int, error) {
|
||||||
return len(bufs), nil
|
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) SupportsMultipleReaders() bool { return true }
|
||||||
func (c *fakeConn) Close() error { c.closed = true; return nil }
|
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 = dns.NewServeMux()
|
||||||
ds.mux.HandleFunc(".", ds.handleDnsRequest)
|
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 {
|
if err := ds.reload(c, false); err != nil {
|
||||||
ds.l.Error("Failed to reload DNS responder from config", "error", err)
|
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,
|
// Reload the config. The lighthouse.hosts change triggers TriggerUpdate,
|
||||||
// which wakes the update worker. It calls SendUpdate, initiating a
|
// which wakes the update worker. It calls SendUpdate, initiating a
|
||||||
// handshake to the new lighthouse and caching the HostUpdateNotification.
|
// 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.
|
// Route until the lighthouse receives the HostUpdateNotification.
|
||||||
// This covers: handshake stage 1, stage 2, then the cached update.
|
// 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")
|
r.Logf("reload new v2-only config")
|
||||||
err = myC.ReloadConfigString(string(cb)).Err
|
err = myC.ReloadConfigString(string(cb))
|
||||||
assert.NoError(t, err)
|
assert.NoError(t, err)
|
||||||
r.Log("yay, spin until their sees it")
|
r.Log("yay, spin until their sees it")
|
||||||
waitStart := time.Now()
|
waitStart := time.Now()
|
||||||
@@ -222,7 +222,7 @@ func TestCertDowngrade(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
r.Logf("reload new v1-only config")
|
r.Logf("reload new v1-only config")
|
||||||
err = myC.ReloadConfigString(string(cb)).Err
|
err = myC.ReloadConfigString(string(cb))
|
||||||
assert.NoError(t, err)
|
assert.NoError(t, err)
|
||||||
r.Log("yay, spin until their sees it")
|
r.Log("yay, spin until their sees it")
|
||||||
waitStart := time.Now()
|
waitStart := time.Now()
|
||||||
|
|||||||
+11
-23
@@ -43,7 +43,7 @@ static_host_map:
|
|||||||
|
|
||||||
lighthouse:
|
lighthouse:
|
||||||
# am_lighthouse is used to enable lighthouse functionality for a node. This should ONLY be true on nodes
|
# 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
|
am_lighthouse: false
|
||||||
# serve_dns optionally starts a dns listener that responds to various queries and can even be
|
# serve_dns optionally starts a dns listener that responds to various queries and can even be
|
||||||
# delegated to for resolution
|
# delegated to for resolution
|
||||||
@@ -126,9 +126,8 @@ lighthouse:
|
|||||||
# Port Nebula will be listening on. The default here is 4242. For a lighthouse node, the port should be defined,
|
# 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.
|
# however using port 0 will dynamically assign a port and is recommended for roaming nodes.
|
||||||
listen:
|
listen:
|
||||||
# To listen on only ipv4, use "0.0.0.0". Not reloadable.
|
# To listen on only ipv4, use "0.0.0.0"
|
||||||
host: "::"
|
host: "::"
|
||||||
# Not reloadable.
|
|
||||||
port: 4242
|
port: 4242
|
||||||
# Sets the max number of packets to pull from the kernel for each syscall (under systems that support recvmmsg)
|
# 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
|
# default is 64, does not support reload
|
||||||
@@ -136,13 +135,12 @@ listen:
|
|||||||
# superpacket, so the receive scratch is batch * 64KiB per listening socket (~4MiB per routine at the
|
# 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.
|
# default of 64). Lower this to trade peak per-syscall throughput for memory on constrained hosts.
|
||||||
#batch: 64
|
#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
|
# 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)
|
# 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
|
# 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
|
# max, net.core.rmem_max and net.core.wmem_max
|
||||||
read_buffer: 3412512
|
#read_buffer: 10485760
|
||||||
write_buffer: 3412512
|
#write_buffer: 10485760
|
||||||
|
|
||||||
# On Windows only
|
# On Windows only
|
||||||
# When true, Nebula installs a WFP (Windows Filtering Platform) PERMIT filter scoped to UDP at the listener port.
|
# When true, Nebula installs a WFP (Windows Filtering Platform) PERMIT filter scoped to UDP at the listener port.
|
||||||
@@ -181,7 +179,7 @@ listen:
|
|||||||
# Currently, this defaults to 1 which means we have 1 tun queue reader and 1
|
# 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
|
# 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.
|
# 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
|
#routines: 1
|
||||||
|
|
||||||
punchy:
|
punchy:
|
||||||
@@ -205,7 +203,6 @@ punchy:
|
|||||||
|
|
||||||
# Cipher allows you to choose between the available ciphers for your network. Options are chachapoly or aes
|
# 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!
|
# 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
|
#cipher: aes
|
||||||
|
|
||||||
# Preferred ranges is used to define a hint about the local network ranges, which speeds up discovering the fastest
|
# Preferred ranges is used to define a hint about the local network ranges, which speeds up discovering the fastest
|
||||||
@@ -237,7 +234,6 @@ punchy:
|
|||||||
# and absolute paths outside of it will be rejected. Default is $TMP/nebula-debug.
|
# and absolute paths outside of it will be rejected. Default is $TMP/nebula-debug.
|
||||||
# The directory is NOT automatically created.
|
# The directory is NOT automatically created.
|
||||||
# Overriding this to "" is the same as "/" and will allow overwriting any path on the host.
|
# Overriding this to "" is the same as "/" and will allow overwriting any path on the host.
|
||||||
# Not reloadable.
|
|
||||||
#sandbox_dir: /var/tmp/nebula-debug
|
#sandbox_dir: /var/tmp/nebula-debug
|
||||||
|
|
||||||
# EXPERIMENTAL: relay support for networks that can't establish direct connections.
|
# EXPERIMENTAL: relay support for networks that can't establish direct connections.
|
||||||
@@ -257,25 +253,19 @@ relay:
|
|||||||
# Configure the private interface. Note: addr is baked into the nebula certificate
|
# Configure the private interface. Note: addr is baked into the nebula certificate
|
||||||
tun:
|
tun:
|
||||||
# When tun is disabled, a lighthouse can be started without a local tun interface (and therefore without root)
|
# When tun is disabled, a lighthouse can be started without a local tun interface (and therefore without root)
|
||||||
# Not reloadable.
|
|
||||||
disabled: false
|
disabled: false
|
||||||
# Name of the device. If not set, a default will be chosen by the OS.
|
# 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 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.
|
# For NetBSD: Required to be set, must be in the form `tun[0-9]+`
|
||||||
# Not reloadable.
|
|
||||||
dev: nebula1
|
dev: nebula1
|
||||||
# Toggles forwarding of local broadcast packets, the address of which depends on the ip/mask encoded in pki.cert
|
# 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
|
drop_local_broadcast: false
|
||||||
# Toggles forwarding of multicast packets. Not reloadable.
|
# Toggles forwarding of multicast packets
|
||||||
drop_multicast: false
|
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
|
# 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
|
||||||
# Not reloadable.
|
tx_queue: 500
|
||||||
tx_queue: 5000
|
|
||||||
# Default MTU for every packet, safe setting is (and the default) 1300 for internet based traffic
|
# Default MTU for every packet, safe setting is (and the default) 1300 for internet based traffic
|
||||||
# Anything above 8937, here or on a route below, is capped to 8937 with a warning
|
# 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
|
mtu: 1300
|
||||||
|
|
||||||
# the use_offloads setting controls if Nebula will attempt to enable GSO and GRO for the tun device. Linux only, not reloadable.
|
# the use_offloads setting controls if Nebula will attempt to enable GSO and GRO for the tun device. Linux only, not reloadable.
|
||||||
@@ -368,7 +358,7 @@ tun:
|
|||||||
#use_system_route_table: false
|
#use_system_route_table: false
|
||||||
# Buffer size for reading routes updates. 0 means default system buffer size. (/proc/sys/net/core/rmem_default).
|
# 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.
|
# 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
|
#use_system_route_table_buffer_size: 0
|
||||||
|
|
||||||
# Configure logging level
|
# Configure logging level
|
||||||
@@ -418,16 +408,14 @@ logging:
|
|||||||
# Handshakes are sent to all known addresses at each interval with a linear backoff,
|
# 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
|
# 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
|
# 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
|
#try_interval: 100ms
|
||||||
#retries: 20
|
#retries: 20
|
||||||
|
|
||||||
# query_buffer is the size of the buffer channel for querying lighthouses, drops are recorded in the lighthouse.query.dropped metric.
|
# query_buffer is the size of the buffer channel for querying lighthouses, drops are recorded in the lighthouse.query.dropped metric.
|
||||||
# Not reloadable.
|
|
||||||
#query_buffer: 1024
|
#query_buffer: 1024
|
||||||
|
|
||||||
# trigger_buffer is the size of the buffer channel for quickly sending handshakes
|
# trigger_buffer is the size of the buffer channel for quickly sending handshakes
|
||||||
# after receiving the response for lighthouse queries. Not reloadable.
|
# after receiving the response for lighthouse queries
|
||||||
#trigger_buffer: 64
|
#trigger_buffer: 64
|
||||||
|
|
||||||
# Tunnel manager settings
|
# Tunnel manager settings
|
||||||
|
|||||||
+34
-101
@@ -32,21 +32,16 @@ type conn struct {
|
|||||||
Expires time.Time // Time when this conntrack entry will expire
|
Expires time.Time // Time when this conntrack entry will expire
|
||||||
|
|
||||||
// record why the original connection passed the firewall, so we can re-validate
|
// record why the original connection passed the firewall, so we can re-validate
|
||||||
// after ruleset changes or when the peer handshakes again, which may present a
|
// after ruleset changes. Note, rulesVersion is a uint16 so that these two
|
||||||
// cert with different groups. These pack into the word after Expires.
|
// fields pack for free after the uint32 above
|
||||||
incoming bool
|
incoming bool
|
||||||
rulesVersion uint16
|
rulesVersion uint16
|
||||||
localIndex uint32
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// TODO: need conntrack max tracked connections handling
|
// TODO: need conntrack max tracked connections handling
|
||||||
type Firewall struct {
|
type Firewall struct {
|
||||||
Conntrack *FirewallConntrack
|
Conntrack *FirewallConntrack
|
||||||
|
|
||||||
// siblings finds the other gateways we route an unsafe network through, so a reply that comes back through a
|
|
||||||
// different gateway than the flow went out through can be matched to it. Nil turns that off.
|
|
||||||
siblings gatewaySiblings
|
|
||||||
|
|
||||||
InRules *FirewallTable
|
InRules *FirewallTable
|
||||||
OutRules *FirewallTable
|
OutRules *FirewallTable
|
||||||
|
|
||||||
@@ -87,8 +82,8 @@ type firewallMetrics struct {
|
|||||||
type FirewallConntrack struct {
|
type FirewallConntrack struct {
|
||||||
sync.Mutex
|
sync.Mutex
|
||||||
|
|
||||||
Conns map[firewall.ConntrackKey]*conn
|
Conns map[firewall.Packet]*conn
|
||||||
TimerWheel *TimerWheel[firewall.ConntrackKey]
|
TimerWheel *TimerWheel[firewall.Packet]
|
||||||
}
|
}
|
||||||
|
|
||||||
// FirewallTable is the entry point for a rule, the evaluation order is:
|
// FirewallTable is the entry point for a rule, the evaluation order is:
|
||||||
@@ -172,8 +167,8 @@ func NewFirewall(l *slog.Logger, tcpTimeout, UDPTimeout, defaultTimeout time.Dur
|
|||||||
|
|
||||||
return &Firewall{
|
return &Firewall{
|
||||||
Conntrack: &FirewallConntrack{
|
Conntrack: &FirewallConntrack{
|
||||||
Conns: make(map[firewall.ConntrackKey]*conn),
|
Conns: make(map[firewall.Packet]*conn),
|
||||||
TimerWheel: NewTimerWheel[firewall.ConntrackKey](tmin, tmax),
|
TimerWheel: NewTimerWheel[firewall.Packet](tmin, tmax),
|
||||||
},
|
},
|
||||||
InRules: newFirewallTable(),
|
InRules: newFirewallTable(),
|
||||||
OutRules: newFirewallTable(),
|
OutRules: newFirewallTable(),
|
||||||
@@ -430,7 +425,6 @@ var ErrNoMatchingRule = errors.New("no matching rule in firewall table")
|
|||||||
// returns nil if the packet should not be dropped.
|
// returns nil if the packet should not be dropped.
|
||||||
func (f *Firewall) Drop(fp firewall.Packet, incoming bool, h *HostInfo, caPool *cert.CAPool, localCache firewall.ConntrackCache) error {
|
func (f *Firewall) Drop(fp firewall.Packet, incoming bool, h *HostInfo, caPool *cert.CAPool, localCache firewall.ConntrackCache) error {
|
||||||
// Make sure remote address matches nebula certificate, and determine how to treat it
|
// Make sure remote address matches nebula certificate, and determine how to treat it
|
||||||
unsafe := false
|
|
||||||
if h.networks == nil {
|
if h.networks == nil {
|
||||||
// Simple case: Certificate has one address and no unsafe networks
|
// Simple case: Certificate has one address and no unsafe networks
|
||||||
if h.vpnAddrs[0] != fp.RemoteAddr {
|
if h.vpnAddrs[0] != fp.RemoteAddr {
|
||||||
@@ -450,7 +444,7 @@ func (f *Firewall) Drop(fp firewall.Packet, incoming bool, h *HostInfo, caPool *
|
|||||||
f.metrics(incoming).droppedRemoteAddr.Inc(1)
|
f.metrics(incoming).droppedRemoteAddr.Inc(1)
|
||||||
return ErrPeerRejected // reject for now, one day this may have different FW rules
|
return ErrPeerRejected // reject for now, one day this may have different FW rules
|
||||||
case NetworkTypeUnsafe:
|
case NetworkTypeUnsafe:
|
||||||
unsafe = true // nothing else special, one day this may have different FW rules
|
break // nothing special, one day this may have different FW rules
|
||||||
default:
|
default:
|
||||||
f.metrics(incoming).droppedRemoteAddr.Inc(1)
|
f.metrics(incoming).droppedRemoteAddr.Inc(1)
|
||||||
return ErrUnknownNetworkType //should never happen
|
return ErrUnknownNetworkType //should never happen
|
||||||
@@ -463,11 +457,8 @@ func (f *Firewall) Drop(fp firewall.Packet, incoming bool, h *HostInfo, caPool *
|
|||||||
return ErrInvalidLocalIP
|
return ErrInvalidLocalIP
|
||||||
}
|
}
|
||||||
|
|
||||||
// The first vpn address identifies the peer, as it does elsewhere. A host's v1 and v2 certs must agree on it
|
|
||||||
key := firewall.ConntrackKey{Packet: fp, Peer: h.vpnAddrs[0]}
|
|
||||||
|
|
||||||
// Check if we spoke to this tuple, if we did then allow this packet
|
// Check if we spoke to this tuple, if we did then allow this packet
|
||||||
if f.inConns(key, h, caPool, localCache) {
|
if f.inConns(fp, h, caPool, localCache) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -478,15 +469,12 @@ func (f *Firewall) Drop(fp firewall.Packet, incoming bool, h *HostInfo, caPool *
|
|||||||
|
|
||||||
// We now know which firewall table to check against
|
// We now know which firewall table to check against
|
||||||
if !table.match(fp, incoming, h.ConnectionState.peerCert, caPool) {
|
if !table.match(fp, incoming, h.ConnectionState.peerCert, caPool) {
|
||||||
if unsafe && f.inheritConn(key, incoming, h, caPool) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
f.metrics(incoming).droppedNoRule.Inc(1)
|
f.metrics(incoming).droppedNoRule.Inc(1)
|
||||||
return ErrNoMatchingRule
|
return ErrNoMatchingRule
|
||||||
}
|
}
|
||||||
|
|
||||||
// We always want to conntrack since it is a faster operation
|
// We always want to conntrack since it is a faster operation
|
||||||
f.addConn(key, incoming, h)
|
f.addConn(fp, incoming)
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -515,9 +503,9 @@ func (f *Firewall) EmitStats() {
|
|||||||
metrics.GetOrRegisterGauge("firewall.rules.hash", nil).Update(int64(f.GetRuleHashFNV()))
|
metrics.GetOrRegisterGauge("firewall.rules.hash", nil).Update(int64(f.GetRuleHashFNV()))
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *Firewall) inConns(key firewall.ConntrackKey, h *HostInfo, caPool *cert.CAPool, localCache firewall.ConntrackCache) bool {
|
func (f *Firewall) inConns(fp firewall.Packet, h *HostInfo, caPool *cert.CAPool, localCache firewall.ConntrackCache) bool {
|
||||||
if localCache != nil {
|
if localCache != nil {
|
||||||
if _, ok := localCache[key]; ok {
|
if _, ok := localCache[fp]; ok {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -530,52 +518,49 @@ func (f *Firewall) inConns(key firewall.ConntrackKey, h *HostInfo, caPool *cert.
|
|||||||
f.evict(ep)
|
f.evict(ep)
|
||||||
}
|
}
|
||||||
|
|
||||||
c, ok := conntrack.Conns[key]
|
c, ok := conntrack.Conns[fp]
|
||||||
|
|
||||||
if !ok {
|
if !ok {
|
||||||
conntrack.Unlock()
|
conntrack.Unlock()
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
if c.rulesVersion != f.rulesVersion || c.localIndex != h.localIndexId {
|
if c.rulesVersion != f.rulesVersion {
|
||||||
// This conntrack entry was allowed by an older rule set or for an earlier tunnel to the peer, validate
|
// This conntrack entry was for an older rule set, validate
|
||||||
// it still passes with the current rule set and the peer's current certificate
|
// it still passes with the current rule set
|
||||||
table := f.OutRules
|
table := f.OutRules
|
||||||
if c.incoming {
|
if c.incoming {
|
||||||
table = f.InRules
|
table = f.InRules
|
||||||
}
|
}
|
||||||
|
|
||||||
// We now know which firewall table to check against
|
// We now know which firewall table to check against
|
||||||
if !table.match(key.Packet, c.incoming, h.ConnectionState.peerCert, caPool) {
|
if !table.match(fp, c.incoming, h.ConnectionState.peerCert, caPool) {
|
||||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||||
h.logger(f.l).Debug("dropping old conntrack entry, does not match current ruleset and certificate",
|
h.logger(f.l).Debug("dropping old conntrack entry, does not match new ruleset",
|
||||||
"fwPacket", key.Packet,
|
"fwPacket", fp,
|
||||||
"incoming", c.incoming,
|
"incoming", c.incoming,
|
||||||
"rulesVersion", f.rulesVersion,
|
"rulesVersion", f.rulesVersion,
|
||||||
"oldRulesVersion", c.rulesVersion,
|
"oldRulesVersion", c.rulesVersion,
|
||||||
"oldLocalIndex", c.localIndex,
|
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
delete(conntrack.Conns, key)
|
delete(conntrack.Conns, fp)
|
||||||
conntrack.Unlock()
|
conntrack.Unlock()
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||||
h.logger(f.l).Debug("keeping old conntrack entry, does match current ruleset and certificate",
|
h.logger(f.l).Debug("keeping old conntrack entry, does match new ruleset",
|
||||||
"fwPacket", key.Packet,
|
"fwPacket", fp,
|
||||||
"incoming", c.incoming,
|
"incoming", c.incoming,
|
||||||
"rulesVersion", f.rulesVersion,
|
"rulesVersion", f.rulesVersion,
|
||||||
"oldRulesVersion", c.rulesVersion,
|
"oldRulesVersion", c.rulesVersion,
|
||||||
"oldLocalIndex", c.localIndex,
|
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
c.rulesVersion = f.rulesVersion
|
c.rulesVersion = f.rulesVersion
|
||||||
c.localIndex = h.localIndexId
|
|
||||||
}
|
}
|
||||||
|
|
||||||
switch key.Protocol {
|
switch fp.Protocol {
|
||||||
case iputil.IPProtocolTCP:
|
case iputil.IPProtocolTCP:
|
||||||
c.Expires = time.Now().Add(f.TCPTimeout)
|
c.Expires = time.Now().Add(f.TCPTimeout)
|
||||||
case iputil.IPProtocolUDP:
|
case iputil.IPProtocolUDP:
|
||||||
@@ -587,17 +572,17 @@ func (f *Firewall) inConns(key firewall.ConntrackKey, h *HostInfo, caPool *cert.
|
|||||||
conntrack.Unlock()
|
conntrack.Unlock()
|
||||||
|
|
||||||
if localCache != nil {
|
if localCache != nil {
|
||||||
localCache[key] = struct{}{}
|
localCache[fp] = struct{}{}
|
||||||
}
|
}
|
||||||
|
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *Firewall) addConn(key firewall.ConntrackKey, incoming bool, h *HostInfo) {
|
func (f *Firewall) addConn(fp firewall.Packet, incoming bool) {
|
||||||
var timeout time.Duration
|
var timeout time.Duration
|
||||||
c := &conn{}
|
c := &conn{}
|
||||||
|
|
||||||
switch key.Protocol {
|
switch fp.Protocol {
|
||||||
case iputil.IPProtocolTCP:
|
case iputil.IPProtocolTCP:
|
||||||
timeout = f.TCPTimeout
|
timeout = f.TCPTimeout
|
||||||
case iputil.IPProtocolUDP:
|
case iputil.IPProtocolUDP:
|
||||||
@@ -608,78 +593,26 @@ func (f *Firewall) addConn(key firewall.ConntrackKey, incoming bool, h *HostInfo
|
|||||||
|
|
||||||
conntrack := f.Conntrack
|
conntrack := f.Conntrack
|
||||||
conntrack.Lock()
|
conntrack.Lock()
|
||||||
if _, ok := conntrack.Conns[key]; !ok {
|
if _, ok := conntrack.Conns[fp]; !ok {
|
||||||
conntrack.TimerWheel.Advance(time.Now())
|
conntrack.TimerWheel.Advance(time.Now())
|
||||||
conntrack.TimerWheel.Add(key, timeout)
|
conntrack.TimerWheel.Add(fp, timeout)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Record which rulesVersion and tunnel allowed this connection, so we can retest after
|
// Record which rulesVersion allowed this connection, so we can retest after
|
||||||
// firewall reload or when the peer handshakes again
|
// firewall reload
|
||||||
c.incoming = incoming
|
c.incoming = incoming
|
||||||
c.rulesVersion = f.rulesVersion
|
c.rulesVersion = f.rulesVersion
|
||||||
c.localIndex = h.localIndexId
|
|
||||||
c.Expires = time.Now().Add(timeout)
|
c.Expires = time.Now().Add(timeout)
|
||||||
conntrack.Conns[key] = c
|
conntrack.Conns[fp] = c
|
||||||
conntrack.Unlock()
|
conntrack.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
// gatewaySiblings finds the other gateways we route an unsafe network through
|
|
||||||
type gatewaySiblings interface {
|
|
||||||
// siblingPeers appends to buf the conntrack peer of every other gateway we route remote through, if h is one of
|
|
||||||
// those gateways
|
|
||||||
siblingPeers(remote netip.Addr, h *HostInfo, buf []netip.Addr) []netip.Addr
|
|
||||||
}
|
|
||||||
|
|
||||||
// inheritConn lets h carry a flow that another of our gateways for the same unsafe network already carries. We
|
|
||||||
// spread the flows we open across the gateways, but the hosts behind them answer through whichever gateway their own
|
|
||||||
// routing picks, so a reply can come back through a different gateway than the flow went out through. The flow is
|
|
||||||
// checked against the rules that allowed it in the first place with h's certificate, the same check an entry gets
|
|
||||||
// when its peer reconnects. Peers that aren't one of our gateways for the network never inherit a flow.
|
|
||||||
func (f *Firewall) inheritConn(key firewall.ConntrackKey, incoming bool, h *HostInfo, caPool *cert.CAPool) bool {
|
|
||||||
if f.siblings == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
var buf [4]netip.Addr
|
|
||||||
now := time.Now()
|
|
||||||
for _, peer := range f.siblings.siblingPeers(key.RemoteAddr, h, buf[:0]) {
|
|
||||||
sk := key
|
|
||||||
sk.Peer = peer
|
|
||||||
conntrack := f.Conntrack
|
|
||||||
conntrack.Lock()
|
|
||||||
c, ok := conntrack.Conns[sk]
|
|
||||||
live := ok && c.Expires.After(now)
|
|
||||||
var allowedIncoming bool
|
|
||||||
if live {
|
|
||||||
allowedIncoming = c.incoming
|
|
||||||
}
|
|
||||||
conntrack.Unlock()
|
|
||||||
|
|
||||||
// The rules for this packet's own direction already said no, only a flow allowed the other way can help
|
|
||||||
if !live || allowedIncoming == incoming {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
table := f.OutRules
|
|
||||||
if allowedIncoming {
|
|
||||||
table = f.InRules
|
|
||||||
}
|
|
||||||
if !table.match(key.Packet, allowedIncoming, h.ConnectionState.peerCert, caPool) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
f.addConn(key, allowedIncoming, h)
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// Evict checks if a conntrack entry has expired, if so it is removed, if not it is re-added to the wheel
|
// Evict checks if a conntrack entry has expired, if so it is removed, if not it is re-added to the wheel
|
||||||
// Caller must own the connMutex lock!
|
// Caller must own the connMutex lock!
|
||||||
func (f *Firewall) evict(key firewall.ConntrackKey) {
|
func (f *Firewall) evict(p firewall.Packet) {
|
||||||
// Are we still tracking this conn?
|
// Are we still tracking this conn?
|
||||||
conntrack := f.Conntrack
|
conntrack := f.Conntrack
|
||||||
t, ok := conntrack.Conns[key]
|
t, ok := conntrack.Conns[p]
|
||||||
if !ok {
|
if !ok {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -689,12 +622,12 @@ func (f *Firewall) evict(key firewall.ConntrackKey) {
|
|||||||
// Timeout is in the future, re-add the timer
|
// Timeout is in the future, re-add the timer
|
||||||
if newT > 0 {
|
if newT > 0 {
|
||||||
conntrack.TimerWheel.Advance(time.Now())
|
conntrack.TimerWheel.Advance(time.Now())
|
||||||
conntrack.TimerWheel.Add(key, newT)
|
conntrack.TimerWheel.Add(p, newT)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// This conn is done
|
// This conn is done
|
||||||
delete(conntrack.Conns, key)
|
delete(conntrack.Conns, p)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ft *FirewallTable) match(p firewall.Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
func (ft *FirewallTable) match(p firewall.Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
||||||
|
|||||||
+1
-9
@@ -3,23 +3,15 @@ package firewall
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/netip"
|
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/slackhq/nebula/logging"
|
"github.com/slackhq/nebula/logging"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ConntrackKey identifies a tracked flow by its packet and the peer it was allowed for, so peers that route
|
|
||||||
// the same unsafe network never share a conntrack entry.
|
|
||||||
type ConntrackKey struct {
|
|
||||||
Peer netip.Addr
|
|
||||||
Packet
|
|
||||||
}
|
|
||||||
|
|
||||||
// ConntrackCache is used as a local routine cache to know if a given flow
|
// ConntrackCache is used as a local routine cache to know if a given flow
|
||||||
// has been seen in the conntrack table.
|
// has been seen in the conntrack table.
|
||||||
type ConntrackCache map[ConntrackKey]struct{}
|
type ConntrackCache map[Packet]struct{}
|
||||||
|
|
||||||
type ConntrackCacheTicker struct {
|
type ConntrackCacheTicker struct {
|
||||||
cacheV uint64
|
cacheV uint64
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ func newFixedTicker(t *testing.T, l *slog.Logger, cacheLen int) *ConntrackCacheT
|
|||||||
cache: make(ConntrackCache, cacheLen),
|
cache: make(ConntrackCache, cacheLen),
|
||||||
}
|
}
|
||||||
for i := range cacheLen {
|
for i := range cacheLen {
|
||||||
c.cache[ConntrackKey{Packet: Packet{LocalPort: uint16(i) + 1}}] = struct{}{}
|
c.cache[Packet{LocalPort: uint16(i) + 1}] = struct{}{}
|
||||||
}
|
}
|
||||||
c.cacheTick.Store(1) // cacheV starts at 0, so Get() takes the reset path
|
c.cacheTick.Store(1) // cacheV starts at 0, so Get() takes the reset path
|
||||||
return c
|
return c
|
||||||
|
|||||||
@@ -26,10 +26,6 @@ type Packet struct {
|
|||||||
RemotePort uint16
|
RemotePort uint16
|
||||||
Protocol uint8
|
Protocol uint8
|
||||||
Fragment bool
|
Fragment bool
|
||||||
|
|
||||||
// pad fills what would otherwise be trailing padding so maps hash and compare a ConntrackKey as one
|
|
||||||
// block of memory instead of field by field. It must always be zero.
|
|
||||||
pad [2]byte
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (fp *Packet) Copy() *Packet {
|
func (fp *Packet) Copy() *Packet {
|
||||||
|
|||||||
+1
-248
@@ -3,7 +3,6 @@ package nebula
|
|||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"math"
|
"math"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
@@ -980,252 +979,6 @@ func TestFirewall_ConntrackSourceSpoofingAcrossPeers(t *testing.T) {
|
|||||||
"SECURITY: attacker spoofed victim's overlay source IP (192.0.2.2) by reusing an existing conntrack 4-tuple; Drop returned %v instead of rejecting", got)
|
"SECURITY: attacker spoofed victim's overlay source IP (192.0.2.2) by reusing an existing conntrack 4-tuple; Drop returned %v instead of rejecting", got)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFirewall_ConntrackUnsafeNetworkPeers(t *testing.T) {
|
|
||||||
l := test.NewLoggerWithOutput(&bytes.Buffer{})
|
|
||||||
|
|
||||||
myVpnNetworksTable := new(bart.Lite)
|
|
||||||
myVpnNetworksTable.Insert(netip.MustParsePrefix("192.0.2.1/24"))
|
|
||||||
|
|
||||||
owner := &dummyCert{
|
|
||||||
name: "owner",
|
|
||||||
networks: []netip.Prefix{netip.MustParsePrefix("192.0.2.1/24")},
|
|
||||||
}
|
|
||||||
|
|
||||||
// Two routers for the same unsafe network, only one of them is trusted inbound
|
|
||||||
router := func(name string, addr string, groups ...string) *HostInfo {
|
|
||||||
inverted := map[string]struct{}{}
|
|
||||||
for _, g := range groups {
|
|
||||||
inverted[g] = struct{}{}
|
|
||||||
}
|
|
||||||
c := &cert.CachedCertificate{
|
|
||||||
Certificate: &dummyCert{
|
|
||||||
name: name,
|
|
||||||
groups: groups,
|
|
||||||
networks: []netip.Prefix{netip.MustParsePrefix(addr + "/24")},
|
|
||||||
unsafeNetworks: []netip.Prefix{netip.MustParsePrefix("198.51.100.0/24")},
|
|
||||||
},
|
|
||||||
InvertedGroups: inverted,
|
|
||||||
}
|
|
||||||
h := &HostInfo{
|
|
||||||
ConnectionState: &ConnectionState{peerCert: c},
|
|
||||||
vpnAddrs: []netip.Addr{netip.MustParseAddr(addr)},
|
|
||||||
}
|
|
||||||
h.buildNetworks(myVpnNetworksTable, c.Certificate)
|
|
||||||
return h
|
|
||||||
}
|
|
||||||
trusted := router("trusted", "192.0.2.2", "trusted")
|
|
||||||
other := router("other", "192.0.2.3")
|
|
||||||
|
|
||||||
cp := cert.NewCAPool()
|
|
||||||
flow := firewall.Packet{
|
|
||||||
LocalAddr: netip.MustParseAddr("192.0.2.1"),
|
|
||||||
RemoteAddr: netip.MustParseAddr("198.51.100.5"),
|
|
||||||
LocalPort: 443,
|
|
||||||
RemotePort: 55000,
|
|
||||||
Protocol: iputil.IPProtocolTCP,
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, useCache := range []bool{false, true} {
|
|
||||||
var cache firewall.ConntrackCache
|
|
||||||
if useCache {
|
|
||||||
cache = firewall.ConntrackCache{}
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Run(fmt.Sprintf("inbound flow allowed for one peer/cache=%v", useCache), func(t *testing.T) {
|
|
||||||
fw := NewFirewall(l, time.Second, time.Minute, time.Hour, owner)
|
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"trusted"}, "", "", "", "", ""))
|
|
||||||
clear(cache)
|
|
||||||
|
|
||||||
require.NoError(t, fw.Drop(flow, true, trusted, cp, cache))
|
|
||||||
assert.Equal(t, ErrNoMatchingRule, fw.Drop(flow, true, other, cp, cache))
|
|
||||||
require.NoError(t, fw.Drop(flow, true, trusted, cp, cache))
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run(fmt.Sprintf("reply to a flow opened via one peer/cache=%v", useCache), func(t *testing.T) {
|
|
||||||
fw := NewFirewall(l, time.Second, time.Minute, time.Hour, owner)
|
|
||||||
require.NoError(t, fw.AddRule(false, firewall.ProtoAny, 0, 0, []string{"any"}, "", "", "", "", ""))
|
|
||||||
clear(cache)
|
|
||||||
|
|
||||||
require.NoError(t, fw.Drop(flow, false, trusted, cp, cache))
|
|
||||||
require.NoError(t, fw.Drop(flow, true, trusted, cp, cache))
|
|
||||||
assert.Equal(t, ErrNoMatchingRule, fw.Drop(flow, true, other, cp, cache))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// fakeSiblings maps each gateway to the conntrack peers of the gateways it shares a route with
|
|
||||||
type fakeSiblings map[*HostInfo][]netip.Addr
|
|
||||||
|
|
||||||
func (s fakeSiblings) siblingPeers(_ netip.Addr, h *HostInfo, buf []netip.Addr) []netip.Addr {
|
|
||||||
return append(buf, s[h]...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFirewall_ConntrackGatewaySiblings(t *testing.T) {
|
|
||||||
l := test.NewLoggerWithOutput(&bytes.Buffer{})
|
|
||||||
|
|
||||||
myVpnNetworksTable := new(bart.Lite)
|
|
||||||
myVpnNetworksTable.Insert(netip.MustParsePrefix("192.0.2.1/24"))
|
|
||||||
|
|
||||||
owner := &dummyCert{
|
|
||||||
name: "owner",
|
|
||||||
networks: []netip.Prefix{netip.MustParsePrefix("192.0.2.1/24")},
|
|
||||||
}
|
|
||||||
|
|
||||||
// Routers for the same unsafe network. a and b are both our gateways for it, c only claims it in its cert
|
|
||||||
router := func(name string, addr string, groups ...string) *HostInfo {
|
|
||||||
inverted := map[string]struct{}{}
|
|
||||||
for _, g := range groups {
|
|
||||||
inverted[g] = struct{}{}
|
|
||||||
}
|
|
||||||
c := &cert.CachedCertificate{
|
|
||||||
Certificate: &dummyCert{
|
|
||||||
name: name,
|
|
||||||
groups: groups,
|
|
||||||
networks: []netip.Prefix{netip.MustParsePrefix(addr + "/24")},
|
|
||||||
unsafeNetworks: []netip.Prefix{netip.MustParsePrefix("198.51.100.0/24")},
|
|
||||||
},
|
|
||||||
InvertedGroups: inverted,
|
|
||||||
}
|
|
||||||
h := &HostInfo{
|
|
||||||
ConnectionState: &ConnectionState{peerCert: c},
|
|
||||||
vpnAddrs: []netip.Addr{netip.MustParseAddr(addr)},
|
|
||||||
}
|
|
||||||
h.buildNetworks(myVpnNetworksTable, c.Certificate)
|
|
||||||
return h
|
|
||||||
}
|
|
||||||
a := router("a", "192.0.2.2", "trusted")
|
|
||||||
b := router("b", "192.0.2.3", "trusted")
|
|
||||||
c := router("c", "192.0.2.4", "trusted")
|
|
||||||
siblings := fakeSiblings{a: {b.vpnAddrs[0]}, b: {a.vpnAddrs[0]}}
|
|
||||||
|
|
||||||
cp := cert.NewCAPool()
|
|
||||||
flow := firewall.Packet{
|
|
||||||
LocalAddr: netip.MustParseAddr("192.0.2.1"),
|
|
||||||
RemoteAddr: netip.MustParseAddr("198.51.100.5"),
|
|
||||||
LocalPort: 55000,
|
|
||||||
RemotePort: 443,
|
|
||||||
Protocol: iputil.IPProtocolTCP,
|
|
||||||
}
|
|
||||||
|
|
||||||
// We open flows through our gateways, nothing is allowed in on its own
|
|
||||||
newFirewall := func(outGroup string) *Firewall {
|
|
||||||
fw := NewFirewall(l, time.Second, time.Minute, time.Hour, owner)
|
|
||||||
require.NoError(t, fw.AddRule(false, firewall.ProtoAny, 0, 0, []string{outGroup}, "", "", "", "", ""))
|
|
||||||
fw.siblings = siblings
|
|
||||||
return fw
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Run("reply through the other gateway", func(t *testing.T) {
|
|
||||||
fw := newFirewall("trusted")
|
|
||||||
require.NoError(t, fw.Drop(flow, false, b, cp, nil))
|
|
||||||
require.NoError(t, fw.Drop(flow, true, a, cp, nil))
|
|
||||||
|
|
||||||
// a has its own entry now, and keeps the flow when b's is gone
|
|
||||||
delete(fw.Conntrack.Conns, firewall.ConntrackKey{Packet: flow, Peer: b.vpnAddrs[0]})
|
|
||||||
require.NoError(t, fw.Drop(flow, true, a, cp, nil))
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("not our gateway", func(t *testing.T) {
|
|
||||||
fw := newFirewall("trusted")
|
|
||||||
require.NoError(t, fw.Drop(flow, false, b, cp, nil))
|
|
||||||
assert.Equal(t, ErrNoMatchingRule, fw.Drop(flow, true, c, cp, nil))
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("off without siblings", func(t *testing.T) {
|
|
||||||
fw := newFirewall("trusted")
|
|
||||||
fw.siblings = nil
|
|
||||||
require.NoError(t, fw.Drop(flow, false, b, cp, nil))
|
|
||||||
assert.Equal(t, ErrNoMatchingRule, fw.Drop(flow, true, a, cp, nil))
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("expired sibling entry", func(t *testing.T) {
|
|
||||||
fw := newFirewall("trusted")
|
|
||||||
require.NoError(t, fw.Drop(flow, false, b, cp, nil))
|
|
||||||
fw.Conntrack.Conns[firewall.ConntrackKey{Packet: flow, Peer: b.vpnAddrs[0]}].Expires = time.Now().Add(-time.Second)
|
|
||||||
assert.Equal(t, ErrNoMatchingRule, fw.Drop(flow, true, a, cp, nil))
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("the original rules must allow the new gateway", func(t *testing.T) {
|
|
||||||
fw := newFirewall("b-only")
|
|
||||||
b.ConnectionState.peerCert.InvertedGroups["b-only"] = struct{}{}
|
|
||||||
defer delete(b.ConnectionState.peerCert.InvertedGroups, "b-only")
|
|
||||||
|
|
||||||
require.NoError(t, fw.Drop(flow, false, b, cp, nil))
|
|
||||||
assert.Equal(t, ErrNoMatchingRule, fw.Drop(flow, true, a, cp, nil))
|
|
||||||
})
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFirewall_ConntrackPeerRehandshake(t *testing.T) {
|
|
||||||
l := test.NewLoggerWithOutput(&bytes.Buffer{})
|
|
||||||
|
|
||||||
myVpnNetworksTable := new(bart.Lite)
|
|
||||||
myVpnNetworksTable.Insert(netip.MustParsePrefix("192.0.2.1/24"))
|
|
||||||
|
|
||||||
owner := &dummyCert{
|
|
||||||
name: "owner",
|
|
||||||
networks: []netip.Prefix{netip.MustParsePrefix("192.0.2.1/24")},
|
|
||||||
}
|
|
||||||
|
|
||||||
// Each call is a new tunnel to the same peer, presenting a cert with the given groups
|
|
||||||
tunnel := func(localIndex uint32, groups ...string) *HostInfo {
|
|
||||||
inverted := map[string]struct{}{}
|
|
||||||
for _, g := range groups {
|
|
||||||
inverted[g] = struct{}{}
|
|
||||||
}
|
|
||||||
c := &cert.CachedCertificate{
|
|
||||||
Certificate: &dummyCert{
|
|
||||||
name: "peer",
|
|
||||||
groups: groups,
|
|
||||||
networks: []netip.Prefix{netip.MustParsePrefix("192.0.2.2/24"), netip.MustParsePrefix("2001:db8::2/64")},
|
|
||||||
},
|
|
||||||
InvertedGroups: inverted,
|
|
||||||
}
|
|
||||||
h := &HostInfo{
|
|
||||||
ConnectionState: &ConnectionState{peerCert: c},
|
|
||||||
vpnAddrs: []netip.Addr{netip.MustParseAddr("192.0.2.2"), netip.MustParseAddr("2001:db8::2")},
|
|
||||||
localIndexId: localIndex,
|
|
||||||
}
|
|
||||||
h.buildNetworks(myVpnNetworksTable, c.Certificate)
|
|
||||||
return h
|
|
||||||
}
|
|
||||||
|
|
||||||
cp := cert.NewCAPool()
|
|
||||||
flow := firewall.Packet{
|
|
||||||
LocalAddr: netip.MustParseAddr("192.0.2.1"),
|
|
||||||
RemoteAddr: netip.MustParseAddr("192.0.2.2"),
|
|
||||||
LocalPort: 443,
|
|
||||||
RemotePort: 55000,
|
|
||||||
Protocol: iputil.IPProtocolTCP,
|
|
||||||
}
|
|
||||||
key := firewall.ConntrackKey{Packet: flow, Peer: netip.MustParseAddr("192.0.2.2")}
|
|
||||||
|
|
||||||
t.Run("inbound flow follows the peer's groups", func(t *testing.T) {
|
|
||||||
fw := NewFirewall(l, time.Second, time.Minute, time.Hour, owner)
|
|
||||||
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"trusted"}, "", "", "", "", ""))
|
|
||||||
|
|
||||||
require.NoError(t, fw.Drop(flow, true, tunnel(1, "trusted"), cp, nil))
|
|
||||||
|
|
||||||
// Same groups on a new tunnel keeps the entry and moves it to the new tunnel
|
|
||||||
require.NoError(t, fw.Drop(flow, true, tunnel(2, "trusted"), cp, nil))
|
|
||||||
require.Contains(t, fw.Conntrack.Conns, key)
|
|
||||||
assert.Equal(t, uint32(2), fw.Conntrack.Conns[key].localIndex)
|
|
||||||
|
|
||||||
// Losing the group on a new tunnel removes the entry
|
|
||||||
assert.Equal(t, ErrNoMatchingRule, fw.Drop(flow, true, tunnel(3), cp, nil))
|
|
||||||
assert.NotContains(t, fw.Conntrack.Conns, key)
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("reply to a flow we opened survives a new tunnel", func(t *testing.T) {
|
|
||||||
fw := NewFirewall(l, time.Second, time.Minute, time.Hour, owner)
|
|
||||||
require.NoError(t, fw.AddRule(false, firewall.ProtoAny, 0, 0, []string{"any"}, "", "", "", "", ""))
|
|
||||||
|
|
||||||
require.NoError(t, fw.Drop(flow, false, tunnel(1, "trusted"), cp, nil))
|
|
||||||
require.NoError(t, fw.Drop(flow, true, tunnel(2), cp, nil))
|
|
||||||
assert.Equal(t, uint32(2), fw.Conntrack.Conns[key].localIndex)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// BenchmarkFirewallDropConntrackHit measures Drop on an already-established flow
|
// BenchmarkFirewallDropConntrackHit measures Drop on an already-established flow
|
||||||
// (a conntrack hit). This is the fast path that the source-IP<->cert binding
|
// (a conntrack hit). This is the fast path that the source-IP<->cert binding
|
||||||
// reordering adds work to, so it quantifies the cost of moving the address checks
|
// reordering adds work to, so it quantifies the cost of moving the address checks
|
||||||
@@ -1989,6 +1742,6 @@ func (mf *mockFirewall) AddRule(incoming bool, proto uint8, startPort int32, end
|
|||||||
|
|
||||||
func resetConntrack(fw *Firewall) {
|
func resetConntrack(fw *Firewall) {
|
||||||
fw.Conntrack.Lock()
|
fw.Conntrack.Lock()
|
||||||
fw.Conntrack.Conns = map[firewall.ConntrackKey]*conn{}
|
fw.Conntrack.Conns = map[firewall.Packet]*conn{}
|
||||||
fw.Conntrack.Unlock()
|
fw.Conntrack.Unlock()
|
||||||
}
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
module github.com/slackhq/nebula
|
module github.com/slackhq/nebula
|
||||||
|
|
||||||
go 1.27.2
|
go 1.26.0
|
||||||
|
|
||||||
require (
|
require (
|
||||||
dario.cat/mergo v1.0.2
|
dario.cat/mergo v1.0.2
|
||||||
@@ -33,7 +33,7 @@ require (
|
|||||||
golang.zx2c4.com/wireguard/windows v1.0.1
|
golang.zx2c4.com/wireguard/windows v1.0.1
|
||||||
google.golang.org/protobuf v1.36.12
|
google.golang.org/protobuf v1.36.12
|
||||||
gopkg.in/yaml.v3 v3.0.1
|
gopkg.in/yaml.v3 v3.0.1
|
||||||
gvisor.dev/gvisor v0.0.0-20261014193016-04d31b385980
|
gvisor.dev/gvisor v0.0.0-20240423190808-9d7a357edefe
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
@@ -45,6 +45,5 @@ require (
|
|||||||
github.com/prometheus/common v0.70.1 // indirect
|
github.com/prometheus/common v0.70.1 // indirect
|
||||||
github.com/prometheus/procfs v0.21.1 // indirect
|
github.com/prometheus/procfs v0.21.1 // indirect
|
||||||
github.com/vishvananda/netns v0.0.5 // indirect
|
github.com/vishvananda/netns v0.0.5 // indirect
|
||||||
golang.org/x/exp v0.0.0-20250711185948-6ae5c78190dc // indirect
|
golang.org/x/time v0.5.0 // indirect
|
||||||
golang.org/x/time v0.15.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.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 h1:3ZVCjf8Ggz7zneR/EHRVx68Ctf+2pmIMP2UFhh9cC6M=
|
||||||
golang.org/x/crypto v0.57.0/go.mod h1:Fdz0i5U6CoizGwLda9DttjSk6qlZo25zYNtR+ycvuZA=
|
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/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.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
|
||||||
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
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.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.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
|
||||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
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.5.0 h1:o7cqy6amK/52YcAKIPlM3a+Fpj35zvRj2TP+e1xFSfk=
|
||||||
golang.org/x/time v0.15.0/go.mod h1:Y4YMaQmXwGQZoFaVFk4YpCt4FLQMYKZe9oeV/f4MSno=
|
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-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-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
||||||
golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
|
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.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 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
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-20240423190808-9d7a357edefe h1:fre4i6mv4iBuz5lCMOzHD1rH1ljqHWSICFmZRbbgp3g=
|
||||||
gvisor.dev/gvisor v0.0.0-20261014193016-04d31b385980/go.mod h1:pK/dapF5Bf3KGW7/kd5CI5IC4lYh9FMFY1qETAIGLXk=
|
gvisor.dev/gvisor v0.0.0-20240423190808-9d7a357edefe/go.mod h1:sxc3Uvk/vHcd3tj7/DHVBoR5wvWT/MmRq2pj7HRJnwU=
|
||||||
+5
-7
@@ -316,9 +316,9 @@ type cachedPacketMetrics struct {
|
|||||||
func NewHostMapFromConfig(l *slog.Logger, c *config.C) *HostMap {
|
func NewHostMapFromConfig(l *slog.Logger, c *config.C) *HostMap {
|
||||||
hm := newHostMap(l)
|
hm := newHostMap(l)
|
||||||
|
|
||||||
hm.reload(c, true, nil)
|
hm.reload(c, true)
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
hm.reload(c, false, r)
|
hm.reload(c, false)
|
||||||
})
|
})
|
||||||
|
|
||||||
l.Info("Main HostMap created", "preferredRanges", hm.GetPreferredRanges())
|
l.Info("Main HostMap created", "preferredRanges", hm.GetPreferredRanges())
|
||||||
@@ -337,8 +337,7 @@ func newHostMap(l *slog.Logger) *HostMap {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// r is nil on the initial load
|
func (hm *HostMap) reload(c *config.C, initial bool) {
|
||||||
func (hm *HostMap) reload(c *config.C, initial bool, r *config.Reload) {
|
|
||||||
if initial || c.HasChanged("preferred_ranges") {
|
if initial || c.HasChanged("preferred_ranges") {
|
||||||
var preferredRanges []netip.Prefix
|
var preferredRanges []netip.Prefix
|
||||||
rawPreferredRanges := c.GetStringSlice("preferred_ranges", []string{})
|
rawPreferredRanges := c.GetStringSlice("preferred_ranges", []string{})
|
||||||
@@ -349,9 +348,8 @@ func (hm *HostMap) reload(c *config.C, initial bool, r *config.Reload) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
hm.l.Warn("Failed to parse preferred ranges, ignoring",
|
hm.l.Warn("Failed to parse preferred ranges, ignoring",
|
||||||
"error", err,
|
"error", err,
|
||||||
"range", rawPreferredRange,
|
"range", rawPreferredRanges,
|
||||||
)
|
)
|
||||||
r.Failed()
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -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.True(t, h.markOut(6), "a relayed send must not consume the epoch edge")
|
||||||
assert.False(t, h.markOut(6))
|
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())
|
|
||||||
}
|
|
||||||
+5
-33
@@ -25,7 +25,6 @@ import (
|
|||||||
"github.com/slackhq/nebula/overlay/batch"
|
"github.com/slackhq/nebula/overlay/batch"
|
||||||
"github.com/slackhq/nebula/overlay/tio"
|
"github.com/slackhq/nebula/overlay/tio"
|
||||||
"github.com/slackhq/nebula/ratelimit"
|
"github.com/slackhq/nebula/ratelimit"
|
||||||
"github.com/slackhq/nebula/routing"
|
|
||||||
"github.com/slackhq/nebula/udp"
|
"github.com/slackhq/nebula/udp"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -269,9 +268,6 @@ func NewInterface(ctx context.Context, c *InterfaceConfig) (*Interface, error) {
|
|||||||
ifce.reQueryWait.Store(int64(c.reQueryWait))
|
ifce.reQueryWait.Store(int64(c.reQueryWait))
|
||||||
|
|
||||||
ifce.connectionManager.intf = ifce
|
ifce.connectionManager.intf = ifce
|
||||||
if ifce.firewall != nil {
|
|
||||||
ifce.firewall.siblings = ifce
|
|
||||||
}
|
|
||||||
|
|
||||||
// Held until Close so waiting on the interface blocks until the resources are actually released
|
// Held until Close so waiting on the interface blocks until the resources are actually released
|
||||||
ifce.wg.Add(1)
|
ifce.wg.Add(1)
|
||||||
@@ -513,11 +509,10 @@ func (f *Interface) flushSendBatch(sb *batch.SendBatch, q int) {
|
|||||||
|
|
||||||
func (f *Interface) RegisterConfigChangeCallbacks(c *config.C) {
|
func (f *Interface) RegisterConfigChangeCallbacks(c *config.C) {
|
||||||
c.RegisterReloadCallback(f.reloadFirewall)
|
c.RegisterReloadCallback(f.reloadFirewall)
|
||||||
for _, reload := range []func(*config.C){
|
c.RegisterReloadCallback(f.reloadSendRecvError)
|
||||||
f.reloadSendRecvError, f.reloadAcceptRecvError, f.reloadDisconnectInvalid, f.reloadMisc,
|
c.RegisterReloadCallback(f.reloadAcceptRecvError)
|
||||||
} {
|
c.RegisterReloadCallback(f.reloadDisconnectInvalid)
|
||||||
c.RegisterReloadCallback(func(c *config.C, _ *config.Reload) { reload(c) })
|
c.RegisterReloadCallback(f.reloadMisc)
|
||||||
}
|
|
||||||
|
|
||||||
for _, udpConn := range f.writers {
|
for _, udpConn := range f.writers {
|
||||||
c.RegisterReloadCallback(udpConn.ReloadConfig)
|
c.RegisterReloadCallback(udpConn.ReloadConfig)
|
||||||
@@ -534,7 +529,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()
|
cs := f.pki.getCertState()
|
||||||
curCert := cs.getCertificate(cert.Version2)
|
curCert := cs.getCertificate(cert.Version2)
|
||||||
if curCert == nil {
|
if curCert == nil {
|
||||||
@@ -553,12 +548,10 @@ func (f *Interface) reloadFirewall(c *config.C, r *config.Reload) {
|
|||||||
fw, err := NewFirewallFromConfig(f.l, cs, c)
|
fw, err := NewFirewallFromConfig(f.l, cs, c)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
f.l.Error("Error while creating firewall during reload", "error", err)
|
f.l.Error("Error while creating firewall during reload", "error", err)
|
||||||
r.Failed()
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
oldFw := f.firewall
|
oldFw := f.firewall
|
||||||
fw.siblings = f
|
|
||||||
conntrack := oldFw.Conntrack
|
conntrack := oldFw.Conntrack
|
||||||
conntrack.Lock()
|
conntrack.Lock()
|
||||||
defer conntrack.Unlock()
|
defer conntrack.Unlock()
|
||||||
@@ -716,24 +709,3 @@ func (f *Interface) Close() error {
|
|||||||
f.wg.Done()
|
f.wg.Done()
|
||||||
return errors.Join(errs...)
|
return errors.Join(errs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// siblingPeers implements gatewaySiblings from the routes and tunnels we have now. Routes name a gateway by any of its
|
|
||||||
// vpn addresses, conntrack keys a peer by its first one, so each gateway is resolved through its tunnel. A gateway
|
|
||||||
// we have no tunnel to can't be carrying a live flow.
|
|
||||||
func (f *Interface) siblingPeers(remote netip.Addr, h *HostInfo, buf []netip.Addr) []netip.Addr {
|
|
||||||
gateways := f.inside.RoutesFor(remote)
|
|
||||||
isGateway := func(g routing.Gateway) bool { return slices.Contains(h.vpnAddrs, g.Addr()) }
|
|
||||||
if len(gateways) < 2 || !slices.ContainsFunc(gateways, isGateway) {
|
|
||||||
return buf
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, g := range gateways {
|
|
||||||
if isGateway(g) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if s := f.hostMap.QueryVpnAddr(g.Addr()); s != nil && s != h {
|
|
||||||
buf = append(buf, s.vpnAddrs[0])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return buf
|
|
||||||
}
|
|
||||||
@@ -39,7 +39,7 @@ func Test_statsEmitter_setsGauges(t *testing.T) {
|
|||||||
hostMap: hostMap,
|
hostMap: hostMap,
|
||||||
inside: &overlaytest.NoopTun{},
|
inside: &overlaytest.NoopTun{},
|
||||||
outside: &udp.NoopConn{},
|
outside: &udp.NoopConn{},
|
||||||
firewall: &Firewall{Conntrack: &FirewallConntrack{Conns: map[firewall.ConntrackKey]*conn{}}},
|
firewall: &Firewall{Conntrack: &FirewallConntrack{Conns: map[firewall.Packet]*conn{}}},
|
||||||
lightHouse: lh,
|
lightHouse: lh,
|
||||||
pki: &PKI{},
|
pki: &PKI{},
|
||||||
handshakeManager: NewHandshakeManager(l, hostMap, lh, &udp.NoopConn{}, defaultHandshakeConfig),
|
handshakeManager: NewHandshakeManager(l, hostMap, lh, &udp.NoopConn{}, defaultHandshakeConfig),
|
||||||
|
|||||||
+4
-68
@@ -4,11 +4,8 @@ import (
|
|||||||
"net/netip"
|
"net/netip"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/gaissmai/bart"
|
|
||||||
"github.com/slackhq/nebula/cert"
|
"github.com/slackhq/nebula/cert"
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
"github.com/slackhq/nebula/overlay/overlaytest"
|
|
||||||
"github.com/slackhq/nebula/routing"
|
|
||||||
"github.com/slackhq/nebula/test"
|
"github.com/slackhq/nebula/test"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
@@ -68,10 +65,10 @@ func TestReloadFirewall_CertUnsafeNetworksChanged(t *testing.T) {
|
|||||||
pki.cs.Store(&CertState{v2Cert: c2, initiatingVersion: cert.Version2})
|
pki.cs.Store(&CertState{v2Cert: c2, initiatingVersion: cert.Version2})
|
||||||
|
|
||||||
// Reload with the same YAML so HasChanged("firewall") reports false.
|
// 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"))
|
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.NotSame(t, fw, f.firewall, "firewall pointer should have been replaced")
|
||||||
assert.Equal(t, newUnsafe, f.firewall.unsafeNetworks)
|
assert.Equal(t, newUnsafe, f.firewall.unsafeNetworks)
|
||||||
@@ -116,69 +113,8 @@ func TestReloadFirewall_NoChange(t *testing.T) {
|
|||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
require.NoError(t, cfg.ReloadConfigString(rawYAML).Err)
|
require.NoError(t, cfg.ReloadConfigString(rawYAML))
|
||||||
f.reloadFirewall(cfg, nil)
|
f.reloadFirewall(cfg)
|
||||||
|
|
||||||
assert.Same(t, fw, f.firewall, "firewall should not have been replaced")
|
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)
|
|
||||||
}
|
|
||||||
|
|
||||||
// routesTun is a NoopTun with a route table
|
|
||||||
type routesTun struct {
|
|
||||||
overlaytest.NoopTun
|
|
||||||
routes *bart.Table[routing.Gateways]
|
|
||||||
}
|
|
||||||
|
|
||||||
func (t routesTun) RoutesFor(ip netip.Addr) routing.Gateways {
|
|
||||||
r, _ := t.routes.Lookup(ip)
|
|
||||||
return r
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestInterface_SiblingPeers(t *testing.T) {
|
|
||||||
addr := netip.MustParseAddr
|
|
||||||
routes := new(bart.Table[routing.Gateways])
|
|
||||||
// a and b carry 198.51.100.0/24, the route names b by its v6 address
|
|
||||||
routes.Insert(netip.MustParsePrefix("198.51.100.0/24"), routing.Gateways{
|
|
||||||
routing.NewGateway(addr("192.0.2.2"), 1),
|
|
||||||
routing.NewGateway(addr("fd00::3"), 1),
|
|
||||||
routing.NewGateway(addr("192.0.2.5"), 1), // no tunnel to this one
|
|
||||||
})
|
|
||||||
routes.Insert(netip.MustParsePrefix("203.0.113.0/24"), routing.Gateways{routing.NewGateway(addr("192.0.2.2"), 1)})
|
|
||||||
|
|
||||||
hm := newHostMap(test.NewLogger())
|
|
||||||
a := &HostInfo{vpnAddrs: []netip.Addr{addr("192.0.2.2"), addr("fd00::2")}, localIndexId: 1}
|
|
||||||
b := &HostInfo{vpnAddrs: []netip.Addr{addr("192.0.2.3"), addr("fd00::3")}, localIndexId: 2}
|
|
||||||
c := &HostInfo{vpnAddrs: []netip.Addr{addr("192.0.2.4")}, localIndexId: 3}
|
|
||||||
for _, h := range []*HostInfo{a, b, c} {
|
|
||||||
hm.unlockedAddHostInfo(h, &Interface{})
|
|
||||||
}
|
|
||||||
f := &Interface{inside: routesTun{routes: routes}, hostMap: hm}
|
|
||||||
|
|
||||||
// Siblings come back as their first vpn address, the one conntrack keys on, whichever address the route names
|
|
||||||
assert.Equal(t, []netip.Addr{addr("192.0.2.3")}, f.siblingPeers(addr("198.51.100.5"), a, nil))
|
|
||||||
assert.Equal(t, []netip.Addr{addr("192.0.2.2")}, f.siblingPeers(addr("198.51.100.5"), b, nil))
|
|
||||||
assert.Empty(t, f.siblingPeers(addr("198.51.100.5"), c, nil), "not one of our gateways for the network")
|
|
||||||
assert.Empty(t, f.siblingPeers(addr("203.0.113.5"), a, nil), "a single gateway route has no siblings")
|
|
||||||
assert.Empty(t, f.siblingPeers(addr("192.0.2.3"), a, nil), "no route")
|
|
||||||
}
|
|
||||||
+4
-10
@@ -138,21 +138,18 @@ func NewLightHouseFromConfig(ctx context.Context, l *slog.Logger, c *config.C, c
|
|||||||
h.metrics = newLighthouseMetrics()
|
h.metrics = newLighthouseMetrics()
|
||||||
}
|
}
|
||||||
|
|
||||||
err := h.reload(c, true, nil)
|
err := h.reload(c, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
r.RestartRequiredIfChanged("lighthouse.am_lighthouse", "listen.port", "handshakes.query_buffer", "stats.lighthouse_metrics")
|
err := h.reload(c, false)
|
||||||
err := h.reload(c, false, r)
|
|
||||||
switch v := err.(type) {
|
switch v := err.(type) {
|
||||||
case *util.ContextualError:
|
case *util.ContextualError:
|
||||||
v.Log(l)
|
v.Log(l)
|
||||||
r.Failed()
|
|
||||||
case error:
|
case error:
|
||||||
l.Error("failed to reload lighthouse", "error", err)
|
l.Error("failed to reload lighthouse", "error", err)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -193,8 +190,7 @@ func (lh *LightHouse) GetUpdateInterval() int64 {
|
|||||||
return lh.interval.Load()
|
return lh.interval.Load()
|
||||||
}
|
}
|
||||||
|
|
||||||
// r is nil on the initial load
|
func (lh *LightHouse) reload(c *config.C, initial bool) error {
|
||||||
func (lh *LightHouse) reload(c *config.C, initial bool, r *config.Reload) error {
|
|
||||||
if initial || c.HasChanged("lighthouse.advertise_addrs") {
|
if initial || c.HasChanged("lighthouse.advertise_addrs") {
|
||||||
rawAdvAddrs := c.GetStringSlice("lighthouse.advertise_addrs", []string{})
|
rawAdvAddrs := c.GetStringSlice("lighthouse.advertise_addrs", []string{})
|
||||||
advAddrs := make([]netip.AddrPort, 0)
|
advAddrs := make([]netip.AddrPort, 0)
|
||||||
@@ -229,7 +225,6 @@ func (lh *LightHouse) reload(c *config.C, initial bool, r *config.Reload) error
|
|||||||
"addr", rawAddr,
|
"addr", rawAddr,
|
||||||
"entry", i+1,
|
"entry", i+1,
|
||||||
)
|
)
|
||||||
r.Failed()
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -388,7 +383,6 @@ func (lh *LightHouse) reload(c *config.C, initial bool, r *config.Reload) error
|
|||||||
"relay", v,
|
"relay", v,
|
||||||
"error", err,
|
"error", err,
|
||||||
)
|
)
|
||||||
r.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
lh.l.Info("Read relay from config", "relay", v)
|
lh.l.Info("Read relay from config", "relay", v)
|
||||||
relaysForMe = append(relaysForMe, configRIP)
|
relaysForMe = append(relaysForMe, configRIP)
|
||||||
|
|||||||
+14
-59
@@ -87,15 +87,15 @@ func TestReloadLighthouseInterval(t *testing.T) {
|
|||||||
lh.ifce = &mockEncWriter{}
|
lh.ifce = &mockEncWriter{}
|
||||||
|
|
||||||
// The first one routine is kicked off by main.go currently, lets make sure that one dies
|
// 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())
|
assert.Equal(t, int64(5), lh.interval.Load())
|
||||||
|
|
||||||
// Subsequent calls are killed off by the LightHouse.Reload function
|
// 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())
|
assert.Equal(t, int64(10), lh.interval.Load())
|
||||||
|
|
||||||
// If this completes then nothing is stealing our reload routine
|
// 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())
|
assert.Equal(t, int64(11), lh.interval.Load())
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -296,7 +296,7 @@ func TestLighthouse_reload(t *testing.T) {
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
c.ReloadConfigString(string(rc))
|
c.ReloadConfigString(string(rc))
|
||||||
|
|
||||||
err = lh.reload(c, false, nil)
|
err = lh.reload(c, false)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -334,7 +334,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
}
|
}
|
||||||
rc, err := yaml.Marshal(nc)
|
rc, err := yaml.Marshal(nc)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
require.NoError(t, c.ReloadConfigString(string(rc)))
|
||||||
|
|
||||||
rl := lh.Query(staticHost)
|
rl := lh.Query(staticHost)
|
||||||
require.NotNil(t, rl)
|
require.NotNil(t, rl)
|
||||||
@@ -350,7 +350,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
}
|
}
|
||||||
rc, err = yaml.Marshal(nc)
|
rc, err = yaml.Marshal(nc)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
require.NoError(t, c.ReloadConfigString(string(rc)))
|
||||||
|
|
||||||
rl = lh.Query(staticHost)
|
rl = lh.Query(staticHost)
|
||||||
require.NotNil(t, rl)
|
require.NotNil(t, rl)
|
||||||
@@ -358,7 +358,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
assert.Equal(t, []netip.AddrPort{netip.MustParseAddrPort("1.1.1.1:4242")}, rl.CopyAddrs([]netip.Prefix{}))
|
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.
|
// 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)
|
rl = lh.Query(staticHost)
|
||||||
require.NotNil(t, rl)
|
require.NotNil(t, rl)
|
||||||
@@ -373,7 +373,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
}
|
}
|
||||||
rc, err = yaml.Marshal(nc)
|
rc, err = yaml.Marshal(nc)
|
||||||
require.NoError(t, err)
|
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.
|
// Add a second host alongside the first. Both should be present, neither duplicated.
|
||||||
nc = map[string]any{
|
nc = map[string]any{
|
||||||
@@ -384,7 +384,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
}
|
}
|
||||||
rc, err = yaml.Marshal(nc)
|
rc, err = yaml.Marshal(nc)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
require.NoError(t, c.ReloadConfigString(string(rc)))
|
||||||
|
|
||||||
rl = lh.Query(staticHost)
|
rl = lh.Query(staticHost)
|
||||||
require.NotNil(t, rl)
|
require.NotNil(t, rl)
|
||||||
@@ -406,7 +406,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
}
|
}
|
||||||
rc, err = yaml.Marshal(nc)
|
rc, err = yaml.Marshal(nc)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
require.NoError(t, c.ReloadConfigString(string(rc)))
|
||||||
|
|
||||||
_, isStatic := lh.GetStaticHostList()[staticHost]
|
_, isStatic := lh.GetStaticHostList()[staticHost]
|
||||||
assert.False(t, isStatic)
|
assert.False(t, isStatic)
|
||||||
@@ -966,13 +966,13 @@ func TestLighthouse_reloadRelaysTriggersUpdate(t *testing.T) {
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.Empty(t, lh.updateTrigger)
|
assert.Empty(t, lh.updateTrigger)
|
||||||
|
|
||||||
require.NoError(t, c.ReloadConfigString(base+"relay:\n relays: [10.128.0.6]\n").Err)
|
require.NoError(t, c.ReloadConfigString(base+"relay:\n relays: [10.128.0.6]\n"))
|
||||||
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.6")}, lh.GetRelaysForMe())
|
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.6")}, lh.GetRelaysForMe())
|
||||||
require.Len(t, lh.updateTrigger, 1)
|
require.Len(t, lh.updateTrigger, 1)
|
||||||
<-lh.updateTrigger
|
<-lh.updateTrigger
|
||||||
|
|
||||||
// The config changed but what we advertise did not, a bad entry is skipped
|
// 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)
|
require.NoError(t, c.ReloadConfigString(base+"relay:\n relays: [10.128.0.6, nope]\n"))
|
||||||
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.6")}, lh.GetRelaysForMe())
|
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.6")}, lh.GetRelaysForMe())
|
||||||
assert.Empty(t, lh.updateTrigger)
|
assert.Empty(t, lh.updateTrigger)
|
||||||
}
|
}
|
||||||
@@ -988,57 +988,12 @@ func TestLighthouse_reloadAmRelayAlone(t *testing.T) {
|
|||||||
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.5")}, lh.GetRelaysForMe())
|
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
|
// 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)
|
require.NoError(t, c.ReloadConfigString(base+" am_relay: true\n"))
|
||||||
assert.Empty(t, lh.GetRelaysForMe())
|
assert.Empty(t, lh.GetRelaysForMe())
|
||||||
require.Len(t, lh.updateTrigger, 1)
|
require.Len(t, lh.updateTrigger, 1)
|
||||||
<-lh.updateTrigger
|
<-lh.updateTrigger
|
||||||
|
|
||||||
require.NoError(t, c.ReloadConfigString(base+" am_relay: false\n").Err)
|
require.NoError(t, c.ReloadConfigString(base+" am_relay: false\n"))
|
||||||
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.5")}, lh.GetRelaysForMe())
|
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.5")}, lh.GetRelaysForMe())
|
||||||
require.Len(t, lh.updateTrigger, 1)
|
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())
|
|
||||||
}
|
|
||||||
@@ -78,7 +78,7 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
|||||||
wireSSHReload(l, ssh, c)
|
wireSSHReload(l, ssh, c)
|
||||||
var sshStart func()
|
var sshStart func()
|
||||||
if c.GetBool("sshd.enabled", false) {
|
if c.GetBool("sshd.enabled", false) {
|
||||||
sshStart, err = configSSH(l, ssh, c, nil)
|
sshStart, err = configSSH(l, ssh, c)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
l.Warn("Failed to configure sshd, ssh debugging will not be available", "error", err)
|
l.Warn("Failed to configure sshd, ssh debugging will not be available", "error", err)
|
||||||
sshStart = nil
|
sshStart = nil
|
||||||
@@ -197,7 +197,7 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, util.NewContextualError("Failed to open udp listener", m{"queue": i}, err)
|
return nil, util.NewContextualError("Failed to open udp listener", m{"queue": i}, err)
|
||||||
}
|
}
|
||||||
udpServer.ReloadConfig(c, nil)
|
udpServer.ReloadConfig(c)
|
||||||
udpConns[i] = udpServer
|
udpConns[i] = udpServer
|
||||||
|
|
||||||
// If port is dynamic, discover it before the next pass through the for loop
|
// If port is dynamic, discover it before the next pass through the for loop
|
||||||
@@ -311,16 +311,6 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
|||||||
lightHouse.ifce = ifce
|
lightHouse.ifce = ifce
|
||||||
|
|
||||||
ifce.RegisterConfigChangeCallbacks(c)
|
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.reloadDisconnectInvalid(c)
|
||||||
ifce.reloadSendRecvError(c)
|
ifce.reloadSendRecvError(c)
|
||||||
ifce.reloadAcceptRecvError(c)
|
ifce.reloadAcceptRecvError(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
|
|
||||||
+1
-3
@@ -476,11 +476,9 @@ func parseV4(data []byte, incoming bool, fp *firewall.ParsedPacket) error {
|
|||||||
func (f *Interface) handleOutsideMessagePacket(hostinfo *HostInfo, messageCounter uint64, out []byte, rxc *rxContext) {
|
func (f *Interface) handleOutsideMessagePacket(hostinfo *HostInfo, messageCounter uint64, out []byte, rxc *rxContext) {
|
||||||
err := newPacket(out, true, rxc.fwPacket)
|
err := newPacket(out, true, rxc.fwPacket)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
hostinfo.logger(f.l).Warn("Error while validating inbound packet", "error", err, "packet", out)
|
||||||
hostinfo.logger(f.l).Debug("Error while validating inbound packet", "error", err, "packet", out)
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
dropReason := f.firewall.Drop(rxc.fwPacket.Packet, true, hostinfo, f.pki.GetCAPool(), rxc.ctCache.Get())
|
dropReason := f.firewall.Drop(rxc.fwPacket.Packet, true, hostinfo, f.pki.GetCAPool(), rxc.ctCache.Get())
|
||||||
if dropReason != nil {
|
if dropReason != nil {
|
||||||
|
|||||||
+1
-8
@@ -41,16 +41,9 @@ func (e *NameError) Error() string {
|
|||||||
type DeviceFactory func(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, routines int) (Device, error)
|
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) {
|
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 {
|
switch {
|
||||||
case c.GetBool("tun.disabled", false):
|
case c.GetBool("tun.disabled", false):
|
||||||
tun := newDisabledTun(vpnNetworks, c.GetInt("tun.tx_queue", 5000), c.GetBool("stats.message_metrics", false), l)
|
tun := newDisabledTun(vpnNetworks, c.GetInt("tun.tx_queue", 500), c.GetBool("stats.message_metrics", false), l)
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
|
||||||
r.RestartRequiredIfChanged("tun.tx_queue", "stats.message_metrics")
|
|
||||||
})
|
|
||||||
return tun, nil
|
return tun, nil
|
||||||
|
|
||||||
default:
|
default:
|
||||||
|
|||||||
@@ -38,17 +38,16 @@ func newTunFromFd(c *config.C, l *slog.Logger, deviceFd int, vpnNetworks []netip
|
|||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
err := t.reload(c, true, nil)
|
err := t.reload(c, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
_ = file.Close()
|
_ = file.Close()
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
err := t.reload(c, false, r)
|
err := t.reload(c, false)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -68,7 +67,7 @@ func (t *tun) Activate() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
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"
|
"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
|
// installInterfaceBypass installs a WFP PERMIT filter scoped to the wintun interface LUID so inbound traffic on the
|
||||||
// nebula adapter bypasses Windows Defender Firewall.
|
// nebula adapter bypasses Windows Defender Firewall.
|
||||||
func installInterfaceBypass(l *slog.Logger, luid uint64) closer {
|
func installInterfaceBypass(l *slog.Logger, luid uint64) closer {
|
||||||
|
|||||||
@@ -4,9 +4,6 @@ package overlay
|
|||||||
|
|
||||||
import "log/slog"
|
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.
|
// installInterfaceBypass is a no-op on windows-386 because we don't currently build for it.
|
||||||
func installInterfaceBypass(_ *slog.Logger, _ uint64) closer {
|
func installInterfaceBypass(_ *slog.Logger, _ uint64) closer {
|
||||||
return nil
|
return nil
|
||||||
|
|||||||
+35
-146
@@ -6,10 +6,8 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"math/bits"
|
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"os"
|
"os"
|
||||||
"sync"
|
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"syscall"
|
"syscall"
|
||||||
"unsafe"
|
"unsafe"
|
||||||
@@ -30,7 +28,7 @@ type tun struct {
|
|||||||
DefaultMTU int
|
DefaultMTU int
|
||||||
Routes atomic.Pointer[[]Route]
|
Routes atomic.Pointer[[]Route]
|
||||||
routeTree atomic.Pointer[bart.Table[routing.Gateways]]
|
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
|
// hostOwned means the fd arrived from the OS, which has already configured addressing, mtu
|
||||||
// and routes for it. NEPacketTunnelProvider on darwin does this.
|
// and routes for it. NEPacketTunnelProvider on darwin does this.
|
||||||
hostOwned bool
|
hostOwned bool
|
||||||
@@ -80,31 +78,17 @@ type ifreqAlias6 struct {
|
|||||||
Lifetime addrLifetime
|
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) {
|
func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*tun, error) {
|
||||||
ifIndex, ok := utunIndex(c.GetString("tun.dev", ""))
|
name := c.GetString("tun.dev", "")
|
||||||
if !ok {
|
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
|
// NOTE: we don't make this error so we don't break existing
|
||||||
// configs that set a name before it was used.
|
// configs that set a name before it was used.
|
||||||
l.Warn("interface name must be utun[0-9]+ on Darwin, ignoring")
|
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)
|
fd, err := unix.Socket(unix.AF_SYSTEM, unix.SOCK_DGRAM, unix.AF_SYS_CONTROL)
|
||||||
@@ -128,7 +112,7 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
|||||||
return nil, fmt.Errorf("SYS_CONNECT: %v", err)
|
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 {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("failed to retrieve tun name: %w", err)
|
return nil, fmt.Errorf("failed to retrieve tun name: %w", err)
|
||||||
}
|
}
|
||||||
@@ -146,20 +130,15 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
|||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
err = t.reload(c, true, nil)
|
err = t.reload(c, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
r.RestartRequiredIfChanged("tun.mtu")
|
err := t.reload(c, false)
|
||||||
if tunDevNeedsRestart(c.GetString("tun.dev", ""), t.Device) {
|
|
||||||
r.RestartRequiredIfChanged("tun.dev")
|
|
||||||
}
|
|
||||||
err := t.reload(c, false, r)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -193,15 +172,14 @@ func newTunFromFd(c *config.C, l *slog.Logger, deviceFd int, vpnNetworks []netip
|
|||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := t.reload(c, true, nil); err != nil {
|
if err := t.reload(c, true); err != nil {
|
||||||
_ = file.Close()
|
_ = file.Close()
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
if err := t.reload(c, false, r); err != nil {
|
if err := t.reload(c, false); err != nil {
|
||||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -265,7 +243,7 @@ func (t *tun) Activate() error {
|
|||||||
if linkAddr == nil {
|
if linkAddr == nil {
|
||||||
return fmt.Errorf("unable to discover link_addr for tun interface")
|
return fmt.Errorf("unable to discover link_addr for tun interface")
|
||||||
}
|
}
|
||||||
t.linkAddr.Store(linkAddr)
|
t.linkAddr = linkAddr
|
||||||
|
|
||||||
for _, network := range t.vpnNetworks {
|
for _, network := range t.vpnNetworks {
|
||||||
if network.Addr().Is4() {
|
if network.Addr().Is4() {
|
||||||
@@ -288,10 +266,9 @@ func (t *tun) Activate() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Unsafe path routes
|
// 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 {
|
func (t *tun) activate4(network netip.Prefix) error {
|
||||||
s, err := unix.Socket(
|
s, err := unix.Socket(
|
||||||
unix.AF_INET,
|
unix.AF_INET,
|
||||||
@@ -318,32 +295,22 @@ func (t *tun) activate4(network netip.Prefix) error {
|
|||||||
MaskAddr: unix.RawSockaddrInet4{
|
MaskAddr: unix.RawSockaddrInet4{
|
||||||
Len: unix.SizeofSockaddrInet4,
|
Len: unix.SizeofSockaddrInet4,
|
||||||
Family: unix.AF_INET,
|
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 {
|
if err := ioctl(uintptr(s), unix.SIOCAIFADDR, uintptr(unsafe.Pointer(&ifr))); err != nil {
|
||||||
return fmt.Errorf("failed to set tun v4 address: %s", err)
|
return fmt.Errorf("failed to set tun v4 address: %s", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := addRoute(network, t.linkAddr.Load()); err != nil {
|
err = addRoute(network, t.linkAddr)
|
||||||
return fmt.Errorf("failed to add route for %v: %w", network.Masked(), err)
|
if err != nil {
|
||||||
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// activate6 is activate4 for IPv6
|
|
||||||
func (t *tun) activate6(network netip.Prefix) error {
|
func (t *tun) activate6(network netip.Prefix) error {
|
||||||
s, err := unix.Socket(
|
s, err := unix.Socket(
|
||||||
unix.AF_INET6,
|
unix.AF_INET6,
|
||||||
@@ -365,28 +332,24 @@ func (t *tun) activate6(network netip.Prefix) error {
|
|||||||
PrefixMask: unix.RawSockaddrInet6{
|
PrefixMask: unix.RawSockaddrInet6{
|
||||||
Len: unix.SizeofSockaddrInet6,
|
Len: unix.SizeofSockaddrInet6,
|
||||||
Family: unix.AF_INET6,
|
Family: unix.AF_INET6,
|
||||||
// Always set the netmask to be a /128. See activate4 for why we do this.
|
Addr: prefixToMask(network).As16(),
|
||||||
Addr: [16]byte{255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255},
|
|
||||||
},
|
},
|
||||||
Lifetime: addrLifetime{
|
Lifetime: addrLifetime{
|
||||||
// never expires
|
// never expires
|
||||||
Vltime: 0xffffffff,
|
Vltime: 0xffffffff,
|
||||||
Pltime: 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 {
|
if err := ioctl(uintptr(s), _SIOCAIFADDR_IN6, uintptr(unsafe.Pointer(&ifr))); err != nil {
|
||||||
return fmt.Errorf("failed to set tun address: %s", err)
|
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
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -407,18 +370,16 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
|||||||
|
|
||||||
if !initial {
|
if !initial {
|
||||||
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
||||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes), r)
|
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Ensure any routes we actually want are installed
|
// Ensure any routes we actually want are installed
|
||||||
err = t.addRoutes(true, r)
|
err = t.addRoutes(true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// Catch any stray logs
|
// Catch any stray logs
|
||||||
util.LogWithContextIfNeeded("Failed to add routes", err, t.l)
|
util.LogWithContextIfNeeded("Failed to add routes", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -433,56 +394,6 @@ func (t *tun) RoutesFor(ip netip.Addr) routing.Gateways {
|
|||||||
return 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
|
// Get the LinkAddr for the interface of the given name
|
||||||
// Is there an easier way to fetch this when we create the interface?
|
// 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.
|
// Maybe SIOCGIFINDEX? but this doesn't appear to exist in the darwin headers.
|
||||||
@@ -511,20 +422,13 @@ func getLinkAddr(name string) (*netroute.LinkAddr, error) {
|
|||||||
return nil, nil
|
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
|
// The route tree is still ours, the system routing table is not
|
||||||
if t.hostOwned {
|
if t.hostOwned {
|
||||||
return nil
|
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()
|
routes := *t.Routes.Load()
|
||||||
systemRoutes := sync.OnceValues(fetchRoutes)
|
|
||||||
|
|
||||||
for _, r := range routes {
|
for _, r := range routes {
|
||||||
if len(r.Via) == 0 || !r.Install {
|
if len(r.Via) == 0 || !r.Install {
|
||||||
@@ -532,54 +436,39 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
err := addRoute(r.Cidr, linkAddr)
|
err := addRoute(r.Cidr, t.linkAddr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if errors.Is(err, unix.EEXIST) {
|
if errors.Is(err, unix.EEXIST) {
|
||||||
// Every route we added already exists on a reload, only warn about someone else's
|
t.l.Warn("unable to add unsafe_route, identical route already exists", "route", r.Cidr)
|
||||||
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)
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||||
if logErrors {
|
if logErrors {
|
||||||
retErr.Log(t.l)
|
retErr.Log(t.l)
|
||||||
rl.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
return retErr
|
return retErr
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
t.l.Info("Added route", "route", r)
|
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
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) removeRoutes(routes []Route, rl *config.Reload) error {
|
func (t *tun) removeRoutes(routes []Route) error {
|
||||||
linkAddr := t.linkAddr.Load()
|
if t.hostOwned {
|
||||||
if t.hostOwned || linkAddr == nil {
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, r := range routes {
|
for _, r := range routes {
|
||||||
if len(r.Via) == 0 || !r.Install {
|
if !r.Install {
|
||||||
// addRoutes never installs these
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
err := delRoute(r.Cidr, linkAddr)
|
err := delRoute(r.Cidr, t.linkAddr)
|
||||||
if errors.Is(err, unix.ESRCH) {
|
if err != nil {
|
||||||
// Already gone, which is what we wanted
|
|
||||||
t.l.Info("Route was already removed", "route", r)
|
|
||||||
} else if err != nil {
|
|
||||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||||
rl.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
t.l.Info("Removed route", "route", r)
|
t.l.Info("Removed route", "route", r)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+11
-21
@@ -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 {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
closeOnErr = false
|
closeOnErr = false
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
r.RestartRequiredIfChanged("tun.dev", "tun.mtu")
|
err := t.reload(c, false)
|
||||||
err := t.reload(c, false, r)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
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 {
|
func (t *tun) setMTU() error {
|
||||||
@@ -511,7 +509,7 @@ func (t *tun) setMTU() error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -532,18 +530,16 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
|||||||
|
|
||||||
if !initial {
|
if !initial {
|
||||||
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
||||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes), r)
|
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Ensure any routes we actually want are installed
|
// Ensure any routes we actually want are installed
|
||||||
err = t.addRoutes(true, r)
|
err = t.addRoutes(true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// Catch any stray logs
|
// Catch any stray logs
|
||||||
util.LogWithContextIfNeeded("Failed to add routes", err, t.l)
|
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
|
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()
|
routes := *t.Routes.Load()
|
||||||
for _, r := range routes {
|
for _, r := range routes {
|
||||||
if len(r.Via) == 0 || !r.Install {
|
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)
|
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||||
if logErrors {
|
if logErrors {
|
||||||
retErr.Log(t.l)
|
retErr.Log(t.l)
|
||||||
rl.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
return retErr
|
return retErr
|
||||||
}
|
}
|
||||||
@@ -592,20 +587,15 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) removeRoutes(routes []Route, rl *config.Reload) error {
|
func (t *tun) removeRoutes(routes []Route) error {
|
||||||
for _, r := range routes {
|
for _, r := range routes {
|
||||||
if len(r.Via) == 0 || !r.Install {
|
if !r.Install {
|
||||||
// addRoutes never installs these
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
err := delRoute(r.Cidr, t.linkAddr)
|
err := delRoute(r.Cidr, t.linkAddr)
|
||||||
if errors.Is(err, unix.ESRCH) {
|
if err != nil {
|
||||||
// Already gone, which is what we wanted
|
|
||||||
t.l.Info("Route was already removed", "route", r)
|
|
||||||
} else if err != nil {
|
|
||||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||||
rl.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
t.l.Info("Removed route", "route", r)
|
t.l.Info("Removed route", "route", r)
|
||||||
}
|
}
|
||||||
|
|||||||
+4
-5
@@ -47,17 +47,16 @@ func newTunFromFd(c *config.C, l *slog.Logger, deviceFd int, vpnNetworks []netip
|
|||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
err := t.reload(c, true, nil)
|
err := t.reload(c, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
_ = file.Close()
|
_ = file.Close()
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
err := t.reload(c, false, r)
|
err := t.reload(c, false)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -68,7 +67,7 @@ func (t *tun) Activate() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
|
|||||||
+15
-29
@@ -185,10 +185,6 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, multiqueue
|
|||||||
}
|
}
|
||||||
|
|
||||||
t.Device = name
|
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
|
return t, nil
|
||||||
}
|
}
|
||||||
@@ -225,31 +221,29 @@ func newTunGeneric(c *config.C, l *slog.Logger, fd int, vnetHdr bool, offloadFla
|
|||||||
vnetHdr: vnetHdr,
|
vnetHdr: vnetHdr,
|
||||||
offloadFlags: offloadFlags,
|
offloadFlags: offloadFlags,
|
||||||
vpnNetworks: vpnNetworks,
|
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),
|
useSystemRoutes: c.GetBool("tun.use_system_route_table", false),
|
||||||
useSystemRoutesBufferSize: c.GetInt("tun.use_system_route_table_buffer_size", 0),
|
useSystemRoutesBufferSize: c.GetInt("tun.use_system_route_table_buffer_size", 0),
|
||||||
routesFromSystem: map[netip.Prefix]routing.Gateways{},
|
routesFromSystem: map[netip.Prefix]routing.Gateways{},
|
||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
if err = t.reload(c, true, nil); err != nil {
|
if err = t.reload(c, true); err != nil {
|
||||||
_ = t.Close()
|
_ = t.Close()
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
r.RestartRequiredIfChanged("tun.tx_queue", "tun.use_system_route_table", "tun.use_system_route_table_buffer_size")
|
err := t.reload(c, false)
|
||||||
err := t.reload(c, false, r)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
return t, nil
|
return t, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
routeChange, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
routeChange, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -303,7 +297,7 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
|||||||
|
|
||||||
if !initial {
|
if !initial {
|
||||||
if oldMaxMTU != newMaxMTU {
|
if oldMaxMTU != newMaxMTU {
|
||||||
t.setMTU(r)
|
t.setMTU()
|
||||||
t.l.Info("Set max MTU", "mtu", t.MaxMTU, "oldMTU", oldMaxMTU)
|
t.l.Info("Set max MTU", "mtu", t.MaxMTU, "oldMTU", oldMaxMTU)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -311,8 +305,7 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
|||||||
for i := range t.vpnNetworks {
|
for i := range t.vpnNetworks {
|
||||||
err := t.setDefaultRoute(t.vpnNetworks[i])
|
err := t.setDefaultRoute(t.vpnNetworks[i])
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.l.Error(err.Error())
|
t.l.Warn(err.Error())
|
||||||
r.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
t.l.Info("Set default MTU", "mtu", t.DefaultMTU, "oldMTU", oldDefaultMTU)
|
t.l.Info("Set default MTU", "mtu", t.DefaultMTU, "oldMTU", oldDefaultMTU)
|
||||||
}
|
}
|
||||||
@@ -320,14 +313,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
|
// 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
|
// Ensure any routes we actually want are installed
|
||||||
err = t.addRoutes(true, r)
|
err = t.addRoutes(true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// This should never be called since addRoutes should log its own errors in a reload condition
|
// 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)
|
util.LogWithContextIfNeeded("Failed to refresh routes", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -482,7 +474,7 @@ func (t *tun) Activate() error {
|
|||||||
t.deviceIndex = link.Attrs().Index
|
t.deviceIndex = link.Attrs().Index
|
||||||
|
|
||||||
// Setup our default MTU
|
// Setup our default MTU
|
||||||
t.setMTU(nil)
|
t.setMTU()
|
||||||
|
|
||||||
// Set the transmit queue length
|
// Set the transmit queue length
|
||||||
ifrq := ifreqQLEN{Name: devName, Value: int32(t.TXQueueLen)}
|
ifrq := ifreqQLEN{Name: devName, Value: int32(t.TXQueueLen)}
|
||||||
@@ -514,7 +506,7 @@ func (t *tun) Activate() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Set the routes
|
// Set the routes
|
||||||
if err = t.addRoutes(false, nil); err != nil {
|
if err = t.addRoutes(false); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -527,13 +519,12 @@ func (t *tun) Activate() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) setMTU(r *config.Reload) {
|
func (t *tun) setMTU() {
|
||||||
// Set the MTU on the device
|
// Set the MTU on the device
|
||||||
ifm := ifreqMTU{Name: t.deviceBytes(), MTU: int32(t.MaxMTU)}
|
ifm := ifreqMTU{Name: t.deviceBytes(), MTU: int32(t.MaxMTU)}
|
||||||
if err := ioctl(t.ioctlFd, unix.SIOCSIFMTU, uintptr(unsafe.Pointer(&ifm))); err != nil {
|
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
|
// 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)
|
t.l.Error("Failed to set tun mtu", "error", err)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -586,7 +577,7 @@ func (t *tun) setDefaultRoute(cidr netip.Prefix) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
func (t *tun) addRoutes(logErrors bool) error {
|
||||||
// Path routes
|
// Path routes
|
||||||
routes := *t.Routes.Load()
|
routes := *t.Routes.Load()
|
||||||
for _, r := range routes {
|
for _, r := range routes {
|
||||||
@@ -616,7 +607,6 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
|||||||
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||||
if logErrors {
|
if logErrors {
|
||||||
retErr.Log(t.l)
|
retErr.Log(t.l)
|
||||||
rl.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
return retErr
|
return retErr
|
||||||
}
|
}
|
||||||
@@ -628,7 +618,7 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) removeRoutes(routes []Route, rl *config.Reload) {
|
func (t *tun) removeRoutes(routes []Route) {
|
||||||
for _, r := range routes {
|
for _, r := range routes {
|
||||||
if !r.Install {
|
if !r.Install {
|
||||||
continue
|
continue
|
||||||
@@ -652,12 +642,8 @@ func (t *tun) removeRoutes(routes []Route, rl *config.Reload) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
err := netlink.RouteDel(&nr)
|
err := netlink.RouteDel(&nr)
|
||||||
if errors.Is(err, unix.ESRCH) {
|
if err != nil {
|
||||||
// Already gone, which is what we wanted
|
|
||||||
t.l.Info("Route was already removed", "route", r)
|
|
||||||
} else if err != nil {
|
|
||||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||||
rl.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
t.l.Info("Removed route", "route", r)
|
t.l.Info("Removed route", "route", r)
|
||||||
}
|
}
|
||||||
|
|||||||
+25
-25
@@ -8,6 +8,7 @@ import (
|
|||||||
"log/slog"
|
"log/slog"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"os"
|
"os"
|
||||||
|
"regexp"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"syscall"
|
"syscall"
|
||||||
"unsafe"
|
"unsafe"
|
||||||
@@ -66,12 +67,24 @@ type tun struct {
|
|||||||
fd int
|
fd int
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var deviceNameRE = regexp.MustCompile(`^tun[0-9]+$`)
|
||||||
|
|
||||||
func newTunFromFd(_ *config.C, _ *slog.Logger, _ int, _ []netip.Prefix) (*tun, error) {
|
func newTunFromFd(_ *config.C, _ *slog.Logger, _ int, _ []netip.Prefix) (*tun, error) {
|
||||||
return nil, fmt.Errorf("newTunFromFd not supported in NetBSD")
|
return nil, fmt.Errorf("newTunFromFd not supported in NetBSD")
|
||||||
}
|
}
|
||||||
|
|
||||||
func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*tun, error) {
|
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 {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -90,20 +103,15 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
|||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
err = t.reload(c, true, nil)
|
err = t.reload(c, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
r.RestartRequiredIfChanged("tun.mtu")
|
err := t.reload(c, false)
|
||||||
if tunDevNeedsRestart(c.GetString("tun.dev", ""), t.Device) {
|
|
||||||
r.RestartRequiredIfChanged("tun.dev")
|
|
||||||
}
|
|
||||||
err := t.reload(c, false, r)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
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 {
|
func (t *tun) doIoctlByName(ctl uintptr, value uint32) error {
|
||||||
@@ -331,7 +339,7 @@ func (t *tun) doIoctlByName(ctl uintptr, value uint32) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -352,18 +360,16 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
|||||||
|
|
||||||
if !initial {
|
if !initial {
|
||||||
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
||||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes), r)
|
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Ensure any routes we actually want are installed
|
// Ensure any routes we actually want are installed
|
||||||
err = t.addRoutes(true, r)
|
err = t.addRoutes(true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// Catch any stray logs
|
// Catch any stray logs
|
||||||
util.LogWithContextIfNeeded("Failed to add routes", err, t.l)
|
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
|
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()
|
routes := *t.Routes.Load()
|
||||||
|
|
||||||
for _, r := range routes {
|
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)
|
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||||
if logErrors {
|
if logErrors {
|
||||||
retErr.Log(t.l)
|
retErr.Log(t.l)
|
||||||
rl.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
return retErr
|
return retErr
|
||||||
}
|
}
|
||||||
@@ -413,20 +418,15 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) removeRoutes(routes []Route, rl *config.Reload) error {
|
func (t *tun) removeRoutes(routes []Route) error {
|
||||||
for _, r := range routes {
|
for _, r := range routes {
|
||||||
if len(r.Via) == 0 || !r.Install {
|
if !r.Install {
|
||||||
// addRoutes never installs these
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
err := delRoute(r.Cidr, t.vpnNetworks)
|
err := delRoute(r.Cidr, t.vpnNetworks)
|
||||||
if errors.Is(err, unix.ESRCH) {
|
if err != nil {
|
||||||
// Already gone, which is what we wanted
|
|
||||||
t.l.Info("Route was already removed", "route", r)
|
|
||||||
} else if err != nil {
|
|
||||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||||
rl.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
t.l.Info("Removed route", "route", r)
|
t.l.Info("Removed route", "route", r)
|
||||||
}
|
}
|
||||||
|
|||||||
+25
-25
@@ -8,6 +8,7 @@ import (
|
|||||||
"log/slog"
|
"log/slog"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"os"
|
"os"
|
||||||
|
"regexp"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"syscall"
|
"syscall"
|
||||||
"unsafe"
|
"unsafe"
|
||||||
@@ -57,12 +58,24 @@ type tun struct {
|
|||||||
fd int
|
fd int
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var deviceNameRE = regexp.MustCompile(`^tun[0-9]+$`)
|
||||||
|
|
||||||
func newTunFromFd(_ *config.C, _ *slog.Logger, _ int, _ []netip.Prefix) (*tun, error) {
|
func newTunFromFd(_ *config.C, _ *slog.Logger, _ int, _ []netip.Prefix) (*tun, error) {
|
||||||
return nil, fmt.Errorf("newTunFromFd not supported in openbsd")
|
return nil, fmt.Errorf("newTunFromFd not supported in openbsd")
|
||||||
}
|
}
|
||||||
|
|
||||||
func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*tun, error) {
|
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 {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -81,20 +94,15 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
|||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
err = t.reload(c, true, nil)
|
err = t.reload(c, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
r.RestartRequiredIfChanged("tun.mtu")
|
err := t.reload(c, false)
|
||||||
if tunDevNeedsRestart(c.GetString("tun.dev", ""), t.Device) {
|
|
||||||
r.RestartRequiredIfChanged("tun.dev")
|
|
||||||
}
|
|
||||||
err := t.reload(c, false, r)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
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 {
|
func (t *tun) doIoctlByName(ctl uintptr, value uint32) error {
|
||||||
@@ -310,7 +318,7 @@ func (t *tun) doIoctlByName(ctl uintptr, value uint32) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
func (t *tun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -331,18 +339,16 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
|||||||
|
|
||||||
if !initial {
|
if !initial {
|
||||||
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
||||||
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes), r)
|
err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Ensure any routes we actually want are installed
|
// Ensure any routes we actually want are installed
|
||||||
err = t.addRoutes(true, r)
|
err = t.addRoutes(true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// Catch any stray logs
|
// Catch any stray logs
|
||||||
util.LogWithContextIfNeeded("Failed to add routes", err, t.l)
|
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
|
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()
|
routes := *t.Routes.Load()
|
||||||
|
|
||||||
for _, r := range routes {
|
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)
|
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||||
if logErrors {
|
if logErrors {
|
||||||
retErr.Log(t.l)
|
retErr.Log(t.l)
|
||||||
rl.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
return retErr
|
return retErr
|
||||||
}
|
}
|
||||||
@@ -392,20 +397,15 @@ func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) removeRoutes(routes []Route, rl *config.Reload) error {
|
func (t *tun) removeRoutes(routes []Route) error {
|
||||||
for _, r := range routes {
|
for _, r := range routes {
|
||||||
if len(r.Via) == 0 || !r.Install {
|
if !r.Install {
|
||||||
// addRoutes never installs these
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
err := delRoute(r.Cidr, t.vpnNetworks)
|
err := delRoute(r.Cidr, t.vpnNetworks)
|
||||||
if errors.Is(err, unix.ESRCH) {
|
if err != nil {
|
||||||
// Already gone, which is what we wanted
|
|
||||||
t.l.Info("Route was already removed", "route", r)
|
|
||||||
} else if err != nil {
|
|
||||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||||
rl.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
t.l.Info("Removed route", "route", r)
|
t.l.Info("Removed route", "route", r)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ package overlay
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"os"
|
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
@@ -26,10 +25,10 @@ func TestReloadMTUOnlyKeepsRoutes(t *testing.T) {
|
|||||||
ioctlFd: ^uintptr(0),
|
ioctlFd: ^uintptr(0),
|
||||||
routesFromSystem: map[netip.Prefix]routing.Gateways{},
|
routesFromSystem: map[netip.Prefix]routing.Gateways{},
|
||||||
}
|
}
|
||||||
require.NoError(t, tn.reload(c, true, nil))
|
require.NoError(t, tn.reload(c, true))
|
||||||
|
|
||||||
require.NoError(t, c.ReloadConfigString("tun:\n mtu: 1400\n"+routes).Err)
|
require.NoError(t, c.ReloadConfigString("tun:\n mtu: 1400\n"+routes))
|
||||||
_ = tn.reload(c, false, nil)
|
_ = tn.reload(c, false)
|
||||||
|
|
||||||
got := *tn.Routes.Load()
|
got := *tn.Routes.Load()
|
||||||
require.Len(t, got, 1)
|
require.Len(t, got, 1)
|
||||||
@@ -51,57 +50,7 @@ func TestReloadMaxMTUIsTheLargestRoute(t *testing.T) {
|
|||||||
ioctlFd: ^uintptr(0),
|
ioctlFd: ^uintptr(0),
|
||||||
routesFromSystem: map[netip.Prefix]routing.Gateways{},
|
routesFromSystem: map[netip.Prefix]routing.Gateways{},
|
||||||
}
|
}
|
||||||
require.NoError(t, tn.reload(c, true, nil))
|
require.NoError(t, tn.reload(c, true))
|
||||||
assert.Equal(t, 1500, tn.MaxMTU)
|
assert.Equal(t, 1500, tn.MaxMTU)
|
||||||
assert.Equal(t, 1300, tn.DefaultMTU)
|
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)
|
|
||||||
}
|
|
||||||
+10
-28
@@ -84,7 +84,7 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*w
|
|||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
err = t.reload(c, true, nil)
|
err = t.reload(c, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -108,28 +108,17 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*w
|
|||||||
// Disable registration before Activate assigns addresses and triggers it.
|
// Disable registration before Activate assigns addresses and triggers it.
|
||||||
disableDNSRegistration(l, *guid)
|
disableDNSRegistration(l, *guid)
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
r.RestartRequiredIfChanged("tun.dev", "tun.mtu")
|
err := t.reload(c, false)
|
||||||
// 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)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
return t, nil
|
return t, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *winTun) reload(c *config.C, initial bool, r *config.Reload) error {
|
func (t *winTun) reload(c *config.C, initial bool) error {
|
||||||
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
change, routes, err := getAllRoutesFromConfig(t.l, c, t.vpnNetworks, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -150,18 +139,16 @@ func (t *winTun) reload(c *config.C, initial bool, r *config.Reload) error {
|
|||||||
|
|
||||||
if !initial {
|
if !initial {
|
||||||
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
// Remove first, if the system removes a wanted route hopefully it will be re-added next
|
||||||
err := t.removeRoutes(findRemovedSystemRoutes(routes, *oldRoutes), r)
|
err := t.removeRoutes(findRemovedSystemRoutes(routes, *oldRoutes))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
util.LogWithContextIfNeeded("Failed to remove routes", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Ensure any routes we actually want are installed
|
// Ensure any routes we actually want are installed
|
||||||
err = t.addRoutes(true, r)
|
err = t.addRoutes(true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// Catch any stray logs
|
// Catch any stray logs
|
||||||
util.LogWithContextIfNeeded("Failed to add routes", err, t.l)
|
util.LogWithContextIfNeeded("Failed to add routes", err, t.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -176,7 +163,7 @@ func (t *winTun) Activate() error {
|
|||||||
return fmt.Errorf("failed to set address: %w", err)
|
return fmt.Errorf("failed to set address: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
err = t.addRoutes(false, nil)
|
err = t.addRoutes(false)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -195,7 +182,7 @@ func (t *winTun) Activate() error {
|
|||||||
return nil
|
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())
|
luid := winipcfg.LUID(t.tun.LUID())
|
||||||
routes := *t.Routes.Load()
|
routes := *t.Routes.Load()
|
||||||
foundDefault4 := false
|
foundDefault4 := false
|
||||||
@@ -226,7 +213,6 @@ func (t *winTun) addRoutes(logErrors bool, rl *config.Reload) error {
|
|||||||
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||||
if logErrors {
|
if logErrors {
|
||||||
retErr.Log(t.l)
|
retErr.Log(t.l)
|
||||||
rl.Failed()
|
|
||||||
continue
|
continue
|
||||||
} else {
|
} else {
|
||||||
return retErr
|
return retErr
|
||||||
@@ -288,7 +274,7 @@ func (t *winTun) setMTU(luid winipcfg.LUID, foundDefault4, carriesV6 bool) error
|
|||||||
return nil
|
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())
|
luid := winipcfg.LUID(t.tun.LUID())
|
||||||
|
|
||||||
for _, r := range routes {
|
for _, r := range routes {
|
||||||
@@ -298,12 +284,8 @@ func (t *winTun) removeRoutes(routes []Route, rl *config.Reload) error {
|
|||||||
|
|
||||||
// See comment on luid.AddRoute
|
// See comment on luid.AddRoute
|
||||||
err := luid.DeleteRoute(r.Cidr, unspecifiedNextHop(r.Cidr))
|
err := luid.DeleteRoute(r.Cidr, unspecifiedNextHop(r.Cidr))
|
||||||
if errors.Is(err, windows.ERROR_NOT_FOUND) {
|
if err != nil {
|
||||||
// Already gone, which is what we wanted
|
|
||||||
t.l.Info("Route was already removed", "route", r)
|
|
||||||
} else if err != nil {
|
|
||||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||||
rl.Failed()
|
|
||||||
} else {
|
} else {
|
||||||
t.l.Info("Removed route", "route", r)
|
t.l.Info("Removed route", "route", r)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -53,14 +53,6 @@ func (rt *routeTest) metric(t *testing.T, cidr string) uint32 {
|
|||||||
return row.Metric
|
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 {
|
func unsafeRoutes(routes ...string) string {
|
||||||
var b strings.Builder
|
var b strings.Builder
|
||||||
b.WriteString("tun:\n dev: nebroutetest\n unsafe_routes:\n")
|
b.WriteString("tun:\n dev: nebroutetest\n unsafe_routes:\n")
|
||||||
@@ -85,7 +77,7 @@ func TestWinTun_ReloadKeepsInstalledRoutes(t *testing.T) {
|
|||||||
rt := newRouteTest(t, unsafeRoutes(a))
|
rt := newRouteTest(t, unsafeRoutes(a))
|
||||||
require.NoError(t, rt.tun.Activate())
|
require.NoError(t, rt.tun.Activate())
|
||||||
|
|
||||||
rt.reload(t, unsafeRoutes(a, b))
|
require.NoError(t, rt.c.ReloadConfigString(unsafeRoutes(a, b)))
|
||||||
assert.NotContains(t, rt.log.String(), "Failed to add route")
|
assert.NotContains(t, rt.log.String(), "Failed to add route")
|
||||||
rt.metric(t, a)
|
rt.metric(t, a)
|
||||||
rt.metric(t, b)
|
rt.metric(t, b)
|
||||||
@@ -100,7 +92,7 @@ func TestWinTun_ReloadMetricChangeApplies(t *testing.T) {
|
|||||||
require.NoError(t, rt.tun.Activate())
|
require.NoError(t, rt.tun.Activate())
|
||||||
require.Equal(t, uint32(100), rt.metric(t, a))
|
require.Equal(t, uint32(100), rt.metric(t, a))
|
||||||
|
|
||||||
rt.reload(t, unsafeRoutes(a+"@200"))
|
require.NoError(t, rt.c.ReloadConfigString(unsafeRoutes(a+"@200")))
|
||||||
assert.NotContains(t, rt.log.String(), "Failed to add route")
|
assert.NotContains(t, rt.log.String(), "Failed to add route")
|
||||||
assert.NotContains(t, rt.log.String(), "Removed route")
|
assert.NotContains(t, rt.log.String(), "Removed route")
|
||||||
assert.Equal(t, uint32(200), rt.metric(t, a))
|
assert.Equal(t, uint32(200), rt.metric(t, a))
|
||||||
@@ -128,7 +120,7 @@ func TestWinTun_DuplicateCidrInstallsTheLastEntry(t *testing.T) {
|
|||||||
require.NoError(t, rt.tun.Activate())
|
require.NoError(t, rt.tun.Activate())
|
||||||
assert.Equal(t, uint32(200), rt.metric(t, a))
|
assert.Equal(t, uint32(200), rt.metric(t, a))
|
||||||
|
|
||||||
rt.reload(t, unsafeRoutes(a+"@100", a+"@200", b))
|
require.NoError(t, rt.c.ReloadConfigString(unsafeRoutes(a+"@100", a+"@200", b)))
|
||||||
assert.Equal(t, uint32(200), rt.metric(t, a))
|
assert.Equal(t, uint32(200), rt.metric(t, a))
|
||||||
assert.NotContains(t, rt.log.String(), "Updated route metric")
|
assert.NotContains(t, rt.log.String(), "Updated route metric")
|
||||||
assert.NotContains(t, rt.log.String(), "Failed to add route")
|
assert.NotContains(t, rt.log.String(), "Failed to add route")
|
||||||
@@ -142,7 +134,7 @@ func TestWinTun_DroppingAnUninstalledDuplicateKeepsTheRoute(t *testing.T) {
|
|||||||
rt := newRouteTest(t, unsafeRoutes(a+"@100", a+"@200"))
|
rt := newRouteTest(t, unsafeRoutes(a+"@100", a+"@200"))
|
||||||
require.NoError(t, rt.tun.Activate())
|
require.NoError(t, rt.tun.Activate())
|
||||||
|
|
||||||
rt.reload(t, unsafeRoutes(a+"@200"))
|
require.NoError(t, rt.c.ReloadConfigString(unsafeRoutes(a+"@200")))
|
||||||
assert.NotContains(t, rt.log.String(), "Removed route")
|
assert.NotContains(t, rt.log.String(), "Removed route")
|
||||||
assert.Equal(t, uint32(200), rt.metric(t, a))
|
assert.Equal(t, uint32(200), rt.metric(t, a))
|
||||||
})
|
})
|
||||||
@@ -163,45 +155,12 @@ func TestWinTun_ReloadMatchesAFreshStart(t *testing.T) {
|
|||||||
|
|
||||||
rt := newRouteTest(t, unsafeRoutes(a+"@100"))
|
rt := newRouteTest(t, unsafeRoutes(a+"@100"))
|
||||||
require.NoError(t, rt.tun.Activate())
|
require.NoError(t, rt.tun.Activate())
|
||||||
rt.reload(t, routes)
|
require.NoError(t, rt.c.ReloadConfigString(routes))
|
||||||
_, err = rt.luid.Route(cidr, unspecifiedNextHop(cidr))
|
_, err = rt.luid.Route(cidr, unspecifiedNextHop(cidr))
|
||||||
assert.Error(t, err, "the reload left it installed")
|
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
|
// 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)) {
|
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("ipv4", func(t *testing.T) { f(t, "10.251.1.0/24", "10.251.2.0/24") })
|
||||||
|
|||||||
@@ -50,30 +50,15 @@ type CertState struct {
|
|||||||
myVpnBroadcastAddrsTable *bart.Lite
|
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) {
|
func NewPKIFromConfig(l *slog.Logger, c *config.C) (*PKI, error) {
|
||||||
pki := &PKI{l: l}
|
pki := &PKI{l: l}
|
||||||
err := pki.reload(c, true, nil)
|
err := pki.reload(c, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
// Compare with the running cipher, not the last config. A restart with one we can't run would fail, so say that
|
rErr := pki.reload(c, false)
|
||||||
// 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)
|
|
||||||
if rErr != nil {
|
if rErr != nil {
|
||||||
util.LogWithContextIfNeeded("Failed to reload PKI from config", rErr, l)
|
util.LogWithContextIfNeeded("Failed to reload PKI from config", rErr, l)
|
||||||
}
|
}
|
||||||
@@ -90,29 +75,13 @@ func (p *PKI) getCertState() *CertState {
|
|||||||
return p.cs.Load()
|
return p.cs.Load()
|
||||||
}
|
}
|
||||||
|
|
||||||
// r is nil on the initial load
|
func (p *PKI) reload(c *config.C, initial bool) error {
|
||||||
func (p *PKI) reload(c *config.C, initial bool, r *config.Reload) error {
|
|
||||||
before := p.cs.Load()
|
|
||||||
err := p.reloadCerts(c, initial)
|
err := p.reloadCerts(c, initial)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if initial {
|
if initial {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
err.Log(p.l)
|
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)
|
err = p.reloadCAPool(c)
|
||||||
@@ -121,27 +90,21 @@ func (p *PKI) reload(c *config.C, initial bool, r *config.Reload) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
err.Log(p.l)
|
err.Log(p.l)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
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 {
|
func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
||||||
var cipher string
|
var cipher string
|
||||||
var currentState *CertState
|
var currentState *CertState
|
||||||
if initial {
|
if initial {
|
||||||
cipher = c.GetString("cipher", "aes")
|
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(
|
return util.NewContextualError(
|
||||||
"unknown cipher",
|
"unknown cipher",
|
||||||
m{"cipher": cipher},
|
m{"cipher": cipher},
|
||||||
@@ -169,7 +132,7 @@ func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
|||||||
return util.NewContextualError(
|
return util.NewContextualError(
|
||||||
"Networks in new cert was different from old",
|
"Networks in new cert was different from old",
|
||||||
m{"new_networks": newState.v1Cert.Networks(), "old_networks": currentState.v1Cert.Networks(), "cert_version": cert.Version1},
|
m{"new_networks": newState.v1Cert.Networks(), "old_networks": currentState.v1Cert.Networks(), "cert_version": cert.Version1},
|
||||||
errCertNeedsRestart,
|
nil,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -177,7 +140,7 @@ func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
|||||||
return util.NewContextualError(
|
return util.NewContextualError(
|
||||||
"Curve in new v1 cert was different from old",
|
"Curve in new v1 cert was different from old",
|
||||||
m{"new_curve": newState.v1Cert.Curve(), "old_curve": currentState.v1Cert.Curve(), "cert_version": cert.Version1},
|
m{"new_curve": newState.v1Cert.Curve(), "old_curve": currentState.v1Cert.Curve(), "cert_version": cert.Version1},
|
||||||
errCertNeedsRestart,
|
nil,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -192,7 +155,7 @@ func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
|||||||
return util.NewContextualError(
|
return util.NewContextualError(
|
||||||
"Networks in new cert was different from old",
|
"Networks in new cert was different from old",
|
||||||
m{"new_networks": newState.v2Cert.Networks(), "old_networks": currentState.v2Cert.Networks(), "cert_version": cert.Version2},
|
m{"new_networks": newState.v2Cert.Networks(), "old_networks": currentState.v2Cert.Networks(), "cert_version": cert.Version2},
|
||||||
errCertNeedsRestart,
|
nil,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -200,7 +163,7 @@ func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
|||||||
return util.NewContextualError(
|
return util.NewContextualError(
|
||||||
"Curve in new cert was different from old",
|
"Curve in new cert was different from old",
|
||||||
m{"new_curve": newState.v2Cert.Curve(), "old_curve": currentState.v2Cert.Curve(), "cert_version": cert.Version2},
|
m{"new_curve": newState.v2Cert.Curve(), "old_curve": currentState.v2Cert.Curve(), "cert_version": cert.Version2},
|
||||||
errCertNeedsRestart,
|
nil,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -215,7 +178,7 @@ func (p *PKI) reloadCerts(c *config.C, initial bool) *util.ContextualError {
|
|||||||
return util.NewContextualError(
|
return util.NewContextualError(
|
||||||
"Removing a V2 cert is not permitted unless it has identical networks to the new V1 cert",
|
"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()},
|
m{"new_v1_networks": newState.v1Cert.Networks(), "old_v2_networks": currentState.v2Cert.Networks()},
|
||||||
errCertNeedsRestart,
|
nil,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
-125
@@ -1,17 +1,10 @@
|
|||||||
package nebula
|
package nebula
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"crypto/fips140"
|
|
||||||
"fmt"
|
|
||||||
"net/netip"
|
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/cert"
|
"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/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
@@ -99,121 +92,3 @@ func TestNewCipherSuiteUnsupportedCurve(t *testing.T) {
|
|||||||
assert.True(t, strings.HasPrefix(err.Error(), "unsupported curve:"), "got: %v", err)
|
assert.True(t, strings.HasPrefix(err.Error(), "unsupported curve:"), "got: %v", err)
|
||||||
assert.Nil(t, cs)
|
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)
|
|
||||||
}
|
|
||||||
@@ -67,8 +67,7 @@ func NewPunchyFromConfig(l *slog.Logger, c *config.C, punchConn udp.Conn) *Punch
|
|||||||
}
|
}
|
||||||
|
|
||||||
p.reload(c, true)
|
p.reload(c, true)
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
r.RestartRequiredIfChanged("stats.lighthouse_metrics")
|
|
||||||
p.reload(c, false)
|
p.reload(c, false)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
+6
-16
@@ -76,7 +76,7 @@ punchy:
|
|||||||
punch: true
|
punch: true
|
||||||
delay: 10m
|
delay: 10m
|
||||||
respond: true
|
respond: true
|
||||||
`).Err)
|
`))
|
||||||
p.reload(c, false)
|
p.reload(c, false)
|
||||||
assert.True(t, p.punch.Load())
|
assert.True(t, p.punch.Load())
|
||||||
assert.Equal(t, newDelay, time.Duration(p.delay.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)
|
NewPunchyFromConfig(l, c, nil)
|
||||||
hook.entries = 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")
|
entry := findEntry(t, hook.entries, "punchy.punch changed")
|
||||||
assert.Equal(t, slog.LevelInfo, entry.Level)
|
assert.Equal(t, slog.LevelInfo, entry.Level)
|
||||||
@@ -184,7 +184,7 @@ func TestPunchy_LogFormat_ReloadRespond(t *testing.T) {
|
|||||||
NewPunchyFromConfig(l, c, nil)
|
NewPunchyFromConfig(l, c, nil)
|
||||||
hook.entries = 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")
|
entry := findEntry(t, hook.entries, "punchy.respond changed")
|
||||||
assert.Equal(t, slog.LevelInfo, entry.Level)
|
assert.Equal(t, slog.LevelInfo, entry.Level)
|
||||||
@@ -198,7 +198,7 @@ func TestPunchy_LogFormat_ReloadDelay(t *testing.T) {
|
|||||||
NewPunchyFromConfig(l, c, nil)
|
NewPunchyFromConfig(l, c, nil)
|
||||||
hook.entries = 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")
|
entry := findEntry(t, hook.entries, "punchy.delay changed")
|
||||||
assert.Equal(t, slog.LevelInfo, entry.Level)
|
assert.Equal(t, slog.LevelInfo, entry.Level)
|
||||||
@@ -212,7 +212,7 @@ func TestPunchy_LogFormat_ReloadTargetAllRemotes(t *testing.T) {
|
|||||||
NewPunchyFromConfig(l, c, nil)
|
NewPunchyFromConfig(l, c, nil)
|
||||||
hook.entries = 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")
|
entry := findEntry(t, hook.entries, "punchy.target_all_remotes changed")
|
||||||
assert.Equal(t, slog.LevelInfo, entry.Level)
|
assert.Equal(t, slog.LevelInfo, entry.Level)
|
||||||
@@ -226,19 +226,9 @@ func TestPunchy_LogFormat_ReloadRespondDelay(t *testing.T) {
|
|||||||
NewPunchyFromConfig(l, c, nil)
|
NewPunchyFromConfig(l, c, nil)
|
||||||
hook.entries = 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")
|
entry := findEntry(t, hook.entries, "punchy.respond_delay changed")
|
||||||
assert.Equal(t, slog.LevelInfo, entry.Level)
|
assert.Equal(t, slog.LevelInfo, entry.Level)
|
||||||
assert.Equal(t, map[string]any{"respond_delay": 15 * time.Second}, entry.Attrs)
|
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
-2
@@ -28,11 +28,10 @@ func NewRelayManager(ctx context.Context, l *slog.Logger, hostmap *HostMap, c *c
|
|||||||
hostmap: hostmap,
|
hostmap: hostmap,
|
||||||
}
|
}
|
||||||
rm.reload(c, true)
|
rm.reload(c, true)
|
||||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
c.RegisterReloadCallback(func(c *config.C) {
|
||||||
err := rm.reload(c, false)
|
err := rm.reload(c, false)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rm.l.Error("Failed to reload relay_manager", "error", err)
|
rm.l.Error("Failed to reload relay_manager", "error", err)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
return rm
|
return rm
|
||||||
|
|||||||
+8
-23
@@ -1,8 +1,8 @@
|
|||||||
package service
|
package service
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"io"
|
||||||
"net"
|
"net"
|
||||||
"sync"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type tcpListener struct {
|
type tcpListener struct {
|
||||||
@@ -10,38 +10,23 @@ type tcpListener struct {
|
|||||||
s *Service
|
s *Service
|
||||||
addr *net.TCPAddr
|
addr *net.TCPAddr
|
||||||
accept chan net.Conn
|
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) {
|
func (l *tcpListener) Accept() (net.Conn, error) {
|
||||||
// select picks randomly among ready cases, so without this a handler still
|
conn, ok := <-l.accept
|
||||||
// waiting to hand off could win over closed after Close has returned.
|
if !ok {
|
||||||
select {
|
return nil, io.EOF
|
||||||
case <-l.closed:
|
|
||||||
return nil, net.ErrClosed
|
|
||||||
default:
|
|
||||||
}
|
}
|
||||||
|
|
||||||
select {
|
|
||||||
case conn := <-l.accept:
|
|
||||||
return conn, nil
|
return conn, nil
|
||||||
case <-l.closed:
|
|
||||||
return nil, net.ErrClosed
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *tcpListener) Close() error {
|
func (l *tcpListener) Close() error {
|
||||||
l.closeOnce.Do(func() {
|
|
||||||
l.s.mu.Lock()
|
l.s.mu.Lock()
|
||||||
delete(l.s.mu.listeners, l.port)
|
defer l.s.mu.Unlock()
|
||||||
l.s.mu.Unlock()
|
delete(l.s.mu.listeners, uint16(l.addr.Port))
|
||||||
|
|
||||||
|
close(l.accept)
|
||||||
|
|
||||||
close(l.closed)
|
|
||||||
})
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+3
-9
@@ -231,7 +231,6 @@ func (s *Service) Listen(network, address string) (net.Listener, error) {
|
|||||||
s: s,
|
s: s,
|
||||||
addr: addr,
|
addr: addr,
|
||||||
accept: make(chan net.Conn),
|
accept: make(chan net.Conn),
|
||||||
closed: make(chan struct{}),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
s.mu.Lock()
|
s.mu.Lock()
|
||||||
@@ -258,8 +257,9 @@ func (s *Service) tcpHandler(r *tcp.ForwarderRequest) {
|
|||||||
endpointID := r.ID()
|
endpointID := r.ID()
|
||||||
|
|
||||||
s.mu.Lock()
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
|
||||||
l, ok := s.mu.listeners[endpointID.LocalPort]
|
l, ok := s.mu.listeners[endpointID.LocalPort]
|
||||||
s.mu.Unlock()
|
|
||||||
if !ok {
|
if !ok {
|
||||||
r.Complete(true)
|
r.Complete(true)
|
||||||
return
|
return
|
||||||
@@ -275,12 +275,6 @@ func (s *Service) tcpHandler(r *tcp.ForwarderRequest) {
|
|||||||
r.Complete(false)
|
r.Complete(false)
|
||||||
ep.SocketOptions().SetKeepAlive(true)
|
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)
|
conn := gonet.NewTCPConn(&wq, ep)
|
||||||
select {
|
l.accept <- conn
|
||||||
case l.accept <- conn:
|
|
||||||
case <-l.closed:
|
|
||||||
_ = conn.Close()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
@@ -188,142 +188,3 @@ func TestService(t *testing.T) {
|
|||||||
t.Fatal(err)
|
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)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -14,7 +14,6 @@ import (
|
|||||||
"path/filepath"
|
"path/filepath"
|
||||||
"runtime"
|
"runtime"
|
||||||
"runtime/pprof"
|
"runtime/pprof"
|
||||||
"slices"
|
|
||||||
"sort"
|
"sort"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -59,30 +58,12 @@ type sshDeviceInfoFlags struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func wireSSHReload(l *slog.Logger, ssh *sshd.SSHServer, c *config.C) {
|
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) {
|
||||||
// sshd.sandbox_dir is read once, when the commands are attached
|
|
||||||
r.RestartRequiredIfChanged("sshd.sandbox_dir")
|
|
||||||
if c.GetBool("sshd.enabled", false) {
|
if c.GetBool("sshd.enabled", false) {
|
||||||
// Restarting the server drops every open session, the one that asked for this reload included. Only restart
|
sshRun, err := configSSH(l, ssh, c)
|
||||||
// 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)
|
|
||||||
}
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
l.Error("Failed to reconfigure the sshd", "error", err)
|
l.Error("Failed to reconfigure the sshd", "error", err)
|
||||||
ssh.Stop()
|
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 {
|
if sshRun != nil {
|
||||||
go sshRun()
|
go sshRun()
|
||||||
@@ -93,32 +74,11 @@ func wireSSHReload(l *slog.Logger, ssh *sshd.SSHServer, c *config.C) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// sshdServerKeys are what configSSH reads. sshd.sandbox_dir isn't one, it's read once at startup and restarting the
|
|
||||||
// server doesn't apply it
|
|
||||||
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
|
// configSSH reads the ssh info out of the passed-in Config and
|
||||||
// updates the passed-in SSHServer. On success, it returns a function
|
// updates the passed-in SSHServer. On success, it returns a function
|
||||||
// that callers may invoke to run the configured ssh server. On
|
// that callers may invoke to run the configured ssh server. On
|
||||||
// failure, it returns nil, error.
|
// 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) (func(), error) {
|
||||||
func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reload) (func(), error) {
|
|
||||||
listen := c.GetString("sshd.listen", "")
|
listen := c.GetString("sshd.listen", "")
|
||||||
if listen == "" {
|
if listen == "" {
|
||||||
return nil, fmt.Errorf("sshd.listen must be provided")
|
return nil, fmt.Errorf("sshd.listen must be provided")
|
||||||
@@ -132,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")
|
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 {
|
if err != nil {
|
||||||
return nil, err
|
return nil, fmt.Errorf("error while loading sshd.host_key file: %s", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
err = ssh.SetHostKey(hostKeyBytes)
|
err = ssh.SetHostKey(hostKeyBytes)
|
||||||
@@ -151,7 +121,6 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
|||||||
err := ssh.AddTrustedCA(caAuthorizedKey)
|
err := ssh.AddTrustedCA(caAuthorizedKey)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
l.Warn("SSH CA had an error, ignoring", "error", err, "sshCA", caAuthorizedKey)
|
l.Warn("SSH CA had an error, ignoring", "error", err, "sshCA", caAuthorizedKey)
|
||||||
r.Failed()
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -163,14 +132,12 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
|||||||
kDef, ok := rk.(map[string]any)
|
kDef, ok := rk.(map[string]any)
|
||||||
if !ok {
|
if !ok {
|
||||||
l.Warn("Authorized user had an error, ignoring", "sshKeyConfig", rk)
|
l.Warn("Authorized user had an error, ignoring", "sshKeyConfig", rk)
|
||||||
r.Failed()
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
user, ok := kDef["user"].(string)
|
user, ok := kDef["user"].(string)
|
||||||
if !ok {
|
if !ok {
|
||||||
l.Warn("Authorized user is missing the user field", "sshKeyConfig", rk)
|
l.Warn("Authorized user is missing the user field", "sshKeyConfig", rk)
|
||||||
r.Failed()
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -184,7 +151,6 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
|||||||
"sshKeyConfig", rk,
|
"sshKeyConfig", rk,
|
||||||
"sshKey", v,
|
"sshKey", v,
|
||||||
)
|
)
|
||||||
r.Failed()
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -196,7 +162,6 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
|||||||
"sshKeyConfig", rk,
|
"sshKeyConfig", rk,
|
||||||
"sshKey", subK,
|
"sshKey", subK,
|
||||||
)
|
)
|
||||||
r.Failed()
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -206,14 +171,12 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
|||||||
"error", err,
|
"error", err,
|
||||||
"sshKeyConfig", sk,
|
"sshKeyConfig", sk,
|
||||||
)
|
)
|
||||||
r.Failed()
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
default:
|
default:
|
||||||
l.Warn("Authorized user is missing the keys field or was not understood", "sshKeyConfig", rk)
|
l.Warn("Authorized user is missing the keys field or was not understood", "sshKeyConfig", rk)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
@@ -293,7 +256,7 @@ func attachCommands(l *slog.Logger, c *config.C, ssh *sshd.SSHServer, f *Interfa
|
|||||||
Name: "reload",
|
Name: "reload",
|
||||||
ShortDescription: "Reloads configuration from disk, same as sending HUP to the process",
|
ShortDescription: "Reloads configuration from disk, same as sending HUP to the process",
|
||||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||||
return sshReload(l, c, w)
|
return sshReload(c, w)
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -1092,13 +1055,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(c *config.C, w sshd.StringWriter) error {
|
||||||
func sshReload(l *slog.Logger, c *config.C, w sshd.StringWriter) error {
|
err := w.WriteLine("Reloading config")
|
||||||
writeErr := w.WriteLine("Reloading config")
|
c.ReloadConfig()
|
||||||
res := c.ReloadConfig()
|
return err
|
||||||
res.Log(l)
|
|
||||||
if err := w.WriteLine(res.String()); writeErr == nil {
|
|
||||||
writeErr = err
|
|
||||||
}
|
|
||||||
return writeErr
|
|
||||||
}
|
}
|
||||||
@@ -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"
|
"log/slog"
|
||||||
"net"
|
"net"
|
||||||
"sync"
|
"sync"
|
||||||
"sync/atomic"
|
|
||||||
|
|
||||||
"github.com/armon/go-radix"
|
"github.com/armon/go-radix"
|
||||||
"golang.org/x/crypto/ssh"
|
"golang.org/x/crypto/ssh"
|
||||||
)
|
)
|
||||||
|
|
||||||
type SSHServer struct {
|
type SSHServer struct {
|
||||||
// config is replaced whole when the host key changes, ssh.ServerConfig.AddHostKey only replaces a key of the same
|
config *ssh.ServerConfig
|
||||||
// algorithm and appends any other
|
|
||||||
config atomic.Pointer[ssh.ServerConfig]
|
|
||||||
authenticate func(ssh.ConnMetadata, ssh.PublicKey) (*ssh.Permissions, error)
|
|
||||||
l *slog.Logger
|
l *slog.Logger
|
||||||
|
|
||||||
certChecker *ssh.CertChecker
|
certChecker *ssh.CertChecker
|
||||||
@@ -32,12 +28,7 @@ type SSHServer struct {
|
|||||||
// List of available commands
|
// List of available commands
|
||||||
helpCommand *Command
|
helpCommand *Command
|
||||||
commands *radix.Tree
|
commands *radix.Tree
|
||||||
listener atomic.Pointer[net.Listener]
|
listener 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]
|
|
||||||
|
|
||||||
// ctx parents per-Run contexts. Cancelling it (e.g. via Control.Stop) tears the server down even
|
// 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.
|
// 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 = &ssh.ServerConfig{
|
||||||
s.config.Store(s.newConfig())
|
PublicKeyCallback: cc.Authenticate,
|
||||||
|
ServerVersion: fmt.Sprintf("SSH-2.0-Nebula???"),
|
||||||
|
}
|
||||||
|
|
||||||
s.RegisterCommand(&Command{
|
s.RegisterCommand(&Command{
|
||||||
Name: "help",
|
Name: "help",
|
||||||
@@ -114,32 +107,10 @@ func (s *SSHServer) SetHostKey(hostPrivateKey []byte) error {
|
|||||||
return fmt.Errorf("failed to parse private key: %s", err)
|
return fmt.Errorf("failed to parse private key: %s", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
config := s.newConfig()
|
s.config.AddHostKey(private)
|
||||||
config.AddHostKey(private)
|
|
||||||
s.config.Store(config)
|
|
||||||
return nil
|
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() {
|
func (s *SSHServer) ClearTrustedCAs() {
|
||||||
s.authLock.Lock()
|
s.authLock.Lock()
|
||||||
s.trustedCAs = []ssh.PublicKey{}
|
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
|
// 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
|
// listener before this run's watcher fires, so each run must close its own listener via the local
|
||||||
// reference.
|
// reference.
|
||||||
s.listener.Store(&listener)
|
s.listener = listener
|
||||||
s.runs.Add(1)
|
|
||||||
bound := listener.Addr()
|
|
||||||
s.addr.Store(&bound)
|
|
||||||
|
|
||||||
runCtx, cancel := context.WithCancel(s.ctx)
|
runCtx, cancel := context.WithCancel(s.ctx)
|
||||||
defer cancel()
|
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
|
// 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
|
// (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
|
// Run loops until there is an error
|
||||||
s.run(runCtx, listener)
|
s.run(runCtx, listener)
|
||||||
@@ -261,7 +226,7 @@ func (s *SSHServer) run(ctx context.Context, listener net.Listener) {
|
|||||||
<-sessionContext.Done()
|
<-sessionContext.Done()
|
||||||
c.Close()
|
c.Close()
|
||||||
}()
|
}()
|
||||||
conn, chans, reqs, err := ssh.NewServerConn(c, s.config.Load())
|
conn, chans, reqs, err := ssh.NewServerConn(c, s.config)
|
||||||
fp := ""
|
fp := ""
|
||||||
if conn != nil {
|
if conn != nil {
|
||||||
fp = conn.Permissions.Extensions["fp"]
|
fp = conn.Permissions.Extensions["fp"]
|
||||||
@@ -299,8 +264,8 @@ func (s *SSHServer) run(ctx context.Context, listener net.Listener) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *SSHServer) Stop() {
|
func (s *SSHServer) Stop() {
|
||||||
if l := s.listener.Load(); l != nil {
|
if s.listener != nil {
|
||||||
if err := (*l).Close(); err != nil && !errors.Is(err, net.ErrClosed) {
|
if err := s.listener.Close(); err != nil {
|
||||||
s.l.Warn("Failed to close the sshd listener", "error", err)
|
s.l.Warn("Failed to close the sshd listener", "error", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,252 +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)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// sandbox_dir is only read at startup, restarting sshd for it would drop every session and still not apply it
|
|
||||||
func TestSSHDReload_SandboxDirKeepsSessions(t *testing.T) {
|
|
||||||
h := newSSHDReloadHarness(t)
|
|
||||||
client, _ := h.connect(t)
|
|
||||||
|
|
||||||
h.extra = " sandbox_dir: " + t.TempDir() + "\n"
|
|
||||||
res := h.c.ReloadConfigString(h.config())
|
|
||||||
require.NoError(t, res.Err)
|
|
||||||
assert.Equal(t, []string{"sshd.sandbox_dir"}, res.RestartKeys)
|
|
||||||
assert.False(t, dropped(client, 500*time.Millisecond), "sshd was restarted")
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -99,10 +99,9 @@ func newStatsServerFromConfig(ctx context.Context, l *slog.Logger, c *config.C,
|
|||||||
emitStats: emitStats,
|
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 {
|
if err := s.reload(c, false); err != nil {
|
||||||
s.l.Error("Failed to reload stats from config", "error", err)
|
s.l.Error("Failed to reload stats from config", "error", err)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
+2
-3
@@ -43,8 +43,7 @@ type Conn interface {
|
|||||||
// its own packet, so a short count means some peers were undeliverable, not that the batch failed.
|
// 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.
|
// Not safe for concurrent use on the same Conn.
|
||||||
WriteBatch(bufs [][]byte, addrs []netip.AddrPort) (int, error)
|
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)
|
||||||
ReloadConfig(c *config.C, r *config.Reload)
|
|
||||||
SupportsMultipleReaders() bool
|
SupportsMultipleReaders() bool
|
||||||
Close() error
|
Close() error
|
||||||
}
|
}
|
||||||
@@ -69,7 +68,7 @@ func (NoopConn) WriteTo(_ []byte, _ netip.AddrPort) error {
|
|||||||
func (NoopConn) WriteBatch(bufs [][]byte, _ []netip.AddrPort) (int, error) {
|
func (NoopConn) WriteBatch(bufs [][]byte, _ []netip.AddrPort) (int, error) {
|
||||||
return len(bufs), nil
|
return len(bufs), nil
|
||||||
}
|
}
|
||||||
func (NoopConn) ReloadConfig(_ *config.C, _ *config.Reload) {
|
func (NoopConn) ReloadConfig(_ *config.C) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
func (NoopConn) Close() error {
|
func (NoopConn) Close() error {
|
||||||
|
|||||||
@@ -24,12 +24,6 @@ type NetworkChangeMonitor struct {
|
|||||||
// NewNetworkChangeMonitor builds a monitor for local network changes. The returned monitor is always usable: Start
|
// 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.
|
// 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 {
|
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{
|
return &NetworkChangeMonitor{
|
||||||
l: l,
|
l: l,
|
||||||
ctx: ctx,
|
ctx: ctx,
|
||||||
|
|||||||
@@ -13,9 +13,6 @@ import (
|
|||||||
"golang.org/x/sys/unix"
|
"golang.org/x/sys/unix"
|
||||||
)
|
)
|
||||||
|
|
||||||
// watchesNetworkChanges is true where Start does anything
|
|
||||||
const watchesNetworkChanges = true
|
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// netChangeSettleWindow is how long we keep swallowing routing messages after the first interesting one. A
|
// 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
|
// 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"
|
"log/slog"
|
||||||
)
|
)
|
||||||
|
|
||||||
// watchesNetworkChanges is true where Start does anything
|
|
||||||
const watchesNetworkChanges = false
|
|
||||||
|
|
||||||
// watchNetworkChanges is a no-op outside of darwin.
|
// 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
|
// Darwin is the platform that scopes a udp socket to the interface it came up on, so it is the platform whose socket
|
||||||
|
|||||||
@@ -37,19 +37,3 @@ func TestNetworkChangeMonitorNilRebindIsANoOp(t *testing.T) {
|
|||||||
m := newMonitor(t, context.Background(), "listen:\n rebind_on_network_change: true\n")
|
m := newMonitor(t, context.Background(), "listen:\n rebind_on_network_change: true\n")
|
||||||
m.Start(nil)
|
m.Start(nil)
|
||||||
}
|
}
|
||||||
|
|
||||||
// The monitor only reads listen.rebind_on_network_change when it is made
|
|
||||||
func TestNetworkChangeMonitorRestartKey(t *testing.T) {
|
|
||||||
l := test.NewLogger()
|
|
||||||
c := config.NewC(l)
|
|
||||||
require.NoError(t, c.LoadString("listen:\n rebind_on_network_change: true\n"))
|
|
||||||
NewNetworkChangeMonitor(context.Background(), l, c)
|
|
||||||
|
|
||||||
res := c.ReloadConfigString("listen:\n rebind_on_network_change: false\n")
|
|
||||||
require.NoError(t, res.Err)
|
|
||||||
if watchesNetworkChanges {
|
|
||||||
assert.Equal(t, []string{"listen.rebind_on_network_change"}, res.RestartKeys)
|
|
||||||
} else {
|
|
||||||
assert.Empty(t, res.RestartKeys, "the setting does nothing here")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -26,9 +26,7 @@ type bypassConn struct {
|
|||||||
session *wfp.Session
|
session *wfp.Session
|
||||||
}
|
}
|
||||||
|
|
||||||
func (b *bypassConn) ReloadConfig(c *config.C, r *config.Reload) {
|
func (b *bypassConn) ReloadConfig(c *config.C) {
|
||||||
// Only read on the first call, at startup
|
|
||||||
r.RestartRequiredIfChanged("listen.windows_bypass_wdf")
|
|
||||||
b.installOnce.Do(func() {
|
b.installOnce.Do(func() {
|
||||||
if !c.GetBool("listen.windows_bypass_wdf", true) {
|
if !c.GetBool("listen.windows_bypass_wdf", true) {
|
||||||
return
|
return
|
||||||
@@ -47,7 +45,7 @@ func (b *bypassConn) ReloadConfig(c *config.C, r *config.Reload) {
|
|||||||
"port", addr.Port())
|
"port", addr.Port())
|
||||||
b.session = s
|
b.session = s
|
||||||
})
|
})
|
||||||
b.Conn.ReloadConfig(c, r)
|
b.Conn.ReloadConfig(c)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (b *bypassConn) Close() error {
|
func (b *bypassConn) Close() error {
|
||||||
|
|||||||
+1
-1
@@ -171,7 +171,7 @@ func (u *StdConn) LocalAddr() (netip.AddrPort, error) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *StdConn) ReloadConfig(c *config.C, r *config.Reload) {
|
func (u *StdConn) ReloadConfig(c *config.C) {
|
||||||
// TODO
|
// TODO
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -73,7 +73,7 @@ func (u *GenericConn) LocalAddr() (netip.AddrPort, error) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *GenericConn) ReloadConfig(c *config.C, r *config.Reload) {
|
func (u *GenericConn) ReloadConfig(c *config.C) {
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+25
-8
@@ -135,12 +135,23 @@ func (u *StdConn) Rebind() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetRecvBuffer tries SO_RCVBUFFORCE, which needs CAP_NET_ADMIN. Without it we
|
||||||
|
// fall back to SO_RCVBUF, which the kernel clamps to net.core.rmem_max.
|
||||||
func (u *StdConn) SetRecvBuffer(n int) error {
|
func (u *StdConn) SetRecvBuffer(n int) error {
|
||||||
return unix.SetsockoptInt(u.sysFd, unix.SOL_SOCKET, unix.SO_RCVBUFFORCE, n)
|
err := unix.SetsockoptInt(u.sysFd, unix.SOL_SOCKET, unix.SO_RCVBUFFORCE, n)
|
||||||
|
if errors.Is(err, unix.EPERM) {
|
||||||
|
err = unix.SetsockoptInt(u.sysFd, unix.SOL_SOCKET, unix.SO_RCVBUF, n)
|
||||||
|
}
|
||||||
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetSendBuffer is SetRecvBuffer for SO_SNDBUFFORCE/SO_SNDBUF and net.core.wmem_max.
|
||||||
func (u *StdConn) SetSendBuffer(n int) error {
|
func (u *StdConn) SetSendBuffer(n int) error {
|
||||||
return unix.SetsockoptInt(u.sysFd, unix.SOL_SOCKET, unix.SO_SNDBUFFORCE, n)
|
err := unix.SetsockoptInt(u.sysFd, unix.SOL_SOCKET, unix.SO_SNDBUFFORCE, n)
|
||||||
|
if errors.Is(err, unix.EPERM) {
|
||||||
|
err = unix.SetsockoptInt(u.sysFd, unix.SOL_SOCKET, unix.SO_SNDBUF, n)
|
||||||
|
}
|
||||||
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *StdConn) SetSoMark(mark int) error {
|
func (u *StdConn) SetSoMark(mark int) error {
|
||||||
@@ -392,32 +403,39 @@ func writeSockaddr(buf []byte, addr netip.AddrPort, isV4 bool) (int, error) {
|
|||||||
return unix.SizeofSockaddrInet6, nil
|
return unix.SizeofSockaddrInet6, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *StdConn) ReloadConfig(c *config.C, r *config.Reload) {
|
func (u *StdConn) ReloadConfig(c *config.C) {
|
||||||
b := c.GetInt("listen.read_buffer", 0)
|
b := c.GetInt("listen.read_buffer", 0)
|
||||||
if b > 0 {
|
if b > 0 {
|
||||||
if err := u.SetRecvBuffer(b); err == nil {
|
if err := u.SetRecvBuffer(b); err == nil {
|
||||||
if s, err := u.GetRecvBuffer(); err == nil {
|
// The kernel reports double the requested size
|
||||||
|
if s, err := u.GetRecvBuffer(); err == nil && s >= 2*b {
|
||||||
u.l.Info("listen.read_buffer was set", "size", s)
|
u.l.Info("listen.read_buffer was set", "size", s)
|
||||||
|
} else if err == nil {
|
||||||
|
u.l.Warn("listen.read_buffer was limited by the system",
|
||||||
|
"requested", b, "size", s,
|
||||||
|
"hint", "raise net.core.rmem_max or grant CAP_NET_ADMIN")
|
||||||
} else {
|
} else {
|
||||||
u.l.Warn("Failed to get listen.read_buffer", "error", err)
|
u.l.Warn("Failed to get listen.read_buffer", "error", err)
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
u.l.Error("Failed to set listen.read_buffer", "error", err)
|
u.l.Error("Failed to set listen.read_buffer", "error", err)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
b = c.GetInt("listen.write_buffer", 0)
|
b = c.GetInt("listen.write_buffer", 0)
|
||||||
if b > 0 {
|
if b > 0 {
|
||||||
if err := u.SetSendBuffer(b); err == nil {
|
if err := u.SetSendBuffer(b); err == nil {
|
||||||
if s, err := u.GetSendBuffer(); err == nil {
|
if s, err := u.GetSendBuffer(); err == nil && s >= 2*b {
|
||||||
u.l.Info("listen.write_buffer was set", "size", s)
|
u.l.Info("listen.write_buffer was set", "size", s)
|
||||||
|
} else if err == nil {
|
||||||
|
u.l.Warn("listen.write_buffer was limited by the system",
|
||||||
|
"requested", b, "size", s,
|
||||||
|
"hint", "raise net.core.wmem_max or grant CAP_NET_ADMIN")
|
||||||
} else {
|
} else {
|
||||||
u.l.Warn("Failed to get listen.write_buffer", "error", err)
|
u.l.Warn("Failed to get listen.write_buffer", "error", err)
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
u.l.Error("Failed to set listen.write_buffer", "error", err)
|
u.l.Error("Failed to set listen.write_buffer", "error", err)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -432,7 +450,6 @@ func (u *StdConn) ReloadConfig(c *config.C, r *config.Reload) {
|
|||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
u.l.Error("Failed to set listen.so_mark", "error", err)
|
u.l.Error("Failed to set listen.so_mark", "error", err)
|
||||||
r.Failed()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,124 @@
|
|||||||
|
//go:build linux && !android && !e2e_testing
|
||||||
|
|
||||||
|
package udp
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
|
"net/netip"
|
||||||
|
"os"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func readSysctlInt(t *testing.T, path string) int {
|
||||||
|
t.Helper()
|
||||||
|
b, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Skipf("can't read %s: %v", path, err)
|
||||||
|
}
|
||||||
|
n, err := strconv.Atoi(strings.TrimSpace(string(b)))
|
||||||
|
if err != nil {
|
||||||
|
t.Skipf("can't parse %s: %v", path, err)
|
||||||
|
}
|
||||||
|
return n
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSetBufferAboveSysctlMax asks for more than net.core.{r,w}mem_max. With
|
||||||
|
// CAP_NET_ADMIN the FORCE variant takes it as is; without it we must fall back
|
||||||
|
// to the plain option and get the clamped size instead of EPERM.
|
||||||
|
func TestSetBufferAboveSysctlMax(t *testing.T) {
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
sysctl string
|
||||||
|
set func(*StdConn, int) error
|
||||||
|
get func(*StdConn) (int, error)
|
||||||
|
}{
|
||||||
|
{"read", "/proc/sys/net/core/rmem_max", (*StdConn).SetRecvBuffer, (*StdConn).GetRecvBuffer},
|
||||||
|
{"write", "/proc/sys/net/core/wmem_max", (*StdConn).SetSendBuffer, (*StdConn).GetSendBuffer},
|
||||||
|
}
|
||||||
|
for _, tc := range cases {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
sysMax := readSysctlInt(t, tc.sysctl)
|
||||||
|
c, err := NewListener(testLogger(), Settings{Listen: netip.MustParseAddrPort("127.0.0.1:0"), Batch: 1})
|
||||||
|
if err != nil {
|
||||||
|
t.Skipf("NewListener: %v", err)
|
||||||
|
}
|
||||||
|
sc := c.(*StdConn)
|
||||||
|
defer sc.Close()
|
||||||
|
|
||||||
|
want := sysMax + 1<<20
|
||||||
|
if err := tc.set(sc, want); err != nil {
|
||||||
|
t.Fatalf("set %d: %v", want, err)
|
||||||
|
}
|
||||||
|
got, err := tc.get(sc)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("get: %v", err)
|
||||||
|
}
|
||||||
|
// The kernel doubles the value; either path gives at least the clamped size.
|
||||||
|
if got < 2*sysMax {
|
||||||
|
t.Fatalf("effective size %d, want >= %d", got, 2*sysMax)
|
||||||
|
}
|
||||||
|
t.Logf("requested %d, %s=%d, effective %d (forced=%v)", want, tc.sysctl, sysMax, got, got >= 2*want)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestReloadConfigBufferLogLevel checks that a clamped buffer is a Warn, and a
|
||||||
|
// buffer that fits is still the Info it always was.
|
||||||
|
func TestReloadConfigBufferLogLevel(t *testing.T) {
|
||||||
|
sysMax := readSysctlInt(t, "/proc/sys/net/core/rmem_max")
|
||||||
|
if wmax := readSysctlInt(t, "/proc/sys/net/core/wmem_max"); wmax < sysMax {
|
||||||
|
sysMax = wmax
|
||||||
|
}
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
size int
|
||||||
|
want []string
|
||||||
|
}{
|
||||||
|
{"fits", 64 * 1024, []string{"level=INFO msg=\"listen.read_buffer was set\"", "level=INFO msg=\"listen.write_buffer was set\""}},
|
||||||
|
{"too big", sysMax + 1<<20, []string{"level=WARN msg=\"listen.read_buffer was limited by the system\"", "level=WARN msg=\"listen.write_buffer was limited by the system\""}},
|
||||||
|
}
|
||||||
|
for _, tc := range cases {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
var buf bytes.Buffer
|
||||||
|
l := slog.New(slog.NewTextHandler(&buf, nil))
|
||||||
|
c, err := NewListener(l, Settings{Listen: netip.MustParseAddrPort("127.0.0.1:0"), Batch: 1})
|
||||||
|
if err != nil {
|
||||||
|
t.Skipf("NewListener: %v", err)
|
||||||
|
}
|
||||||
|
sc := c.(*StdConn)
|
||||||
|
defer sc.Close()
|
||||||
|
|
||||||
|
if tc.size > sysMax {
|
||||||
|
// With CAP_NET_ADMIN the FORCE variant takes any size, nothing gets limited.
|
||||||
|
if err := sc.SetRecvBuffer(tc.size); err == nil {
|
||||||
|
if got, _ := sc.GetRecvBuffer(); got >= 2*tc.size {
|
||||||
|
t.Skip("FORCE path took the full size, can't observe the limit")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg := config.NewC(l)
|
||||||
|
if err := cfg.LoadString(fmt.Sprintf("listen:\n read_buffer: %d\n write_buffer: %d\n", tc.size, tc.size)); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
buf.Reset()
|
||||||
|
sc.ReloadConfig(cfg)
|
||||||
|
out := buf.String()
|
||||||
|
for _, w := range tc.want {
|
||||||
|
if !strings.Contains(out, w) {
|
||||||
|
t.Errorf("missing %s in:\n%s", w, out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if strings.Contains(out, "level=ERROR") {
|
||||||
|
t.Errorf("unexpected error log:\n%s", out)
|
||||||
|
}
|
||||||
|
t.Log(out)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
//go:build linux && !android && !e2e_testing
|
|
||||||
|
|
||||||
package udp
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/netip"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/config"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// A setting the kernel refuses fails the reload
|
|
||||||
func TestReloadConfig_RefusedSettingFailsTheReload(t *testing.T) {
|
|
||||||
if os.Geteuid() == 0 {
|
|
||||||
t.Skip("root may set listen.so_mark, run as an unprivileged user")
|
|
||||||
}
|
|
||||||
conn, err := NewListener(testLogger(), Settings{Listen: netip.MustParseAddrPort("127.0.0.1:0"), Batch: 1})
|
|
||||||
require.NoError(t, err)
|
|
||||||
t.Cleanup(func() { _ = conn.Close() })
|
|
||||||
|
|
||||||
c := config.NewC(testLogger())
|
|
||||||
require.NoError(t, c.LoadString("listen:\n port: 0\n"))
|
|
||||||
c.RegisterReloadCallback(conn.ReloadConfig)
|
|
||||||
|
|
||||||
res := c.ReloadConfigString("listen:\n port: 0\n so_mark: 42\n")
|
|
||||||
require.NoError(t, res.Err)
|
|
||||||
assert.True(t, res.Failed)
|
|
||||||
}
|
|
||||||
@@ -351,7 +351,7 @@ func (u *RIOConn) Rebind() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *RIOConn) ReloadConfig(*config.C, *config.Reload) {}
|
func (u *RIOConn) ReloadConfig(*config.C) {}
|
||||||
|
|
||||||
func (u *RIOConn) Close() error {
|
func (u *RIOConn) Close() error {
|
||||||
if !u.isOpen.CompareAndSwap(true, false) {
|
if !u.isOpen.CompareAndSwap(true, false) {
|
||||||
|
|||||||
+1
-1
@@ -197,7 +197,7 @@ func (u *TesterConn) ListenOut(r EncReader, flush func()) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *TesterConn) ReloadConfig(*config.C, *config.Reload) {}
|
func (u *TesterConn) ReloadConfig(*config.C) {}
|
||||||
|
|
||||||
func NewUDPStatsEmitter(_ []Conn) func() {
|
func NewUDPStatsEmitter(_ []Conn) func() {
|
||||||
// No UDP stats for non-linux
|
// No UDP stats for non-linux
|
||||||
|
|||||||
Reference in new issue
Block a user