mirror of
https://github.com/slackhq/nebula.git
synced 2026-11-16 04:36:52 +01:00
Compare commits
19
Commits
No files matched your search
@@ -0,0 +1,2 @@
|
||||
# Goldens are compared byte for byte, so they must come out of git the way they went in.
|
||||
*.golden -text
|
||||
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
|
||||
- A control socket that provides access to all of the ssh debug server's commands along with support
|
||||
for running `nebula ctl <command>` as a client from the CLI.
|
||||
- An info socket that provides access to information related to identity: identity, whoami, and print-cert.
|
||||
|
||||
### Removed
|
||||
|
||||
- The SSH debug server's `start-cpu-profile`, `stop-cpu-profile`, `save-heap-profile`, `save-mutex-profile`, and
|
||||
|
||||
@@ -0,0 +1,420 @@
|
||||
package ctl
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"log/slog"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/localapi"
|
||||
)
|
||||
|
||||
// Word is the argument that selects the control client instead of the daemon.
|
||||
const Word = "ctl"
|
||||
|
||||
// Subcommand handles the one bare word a daemon binary accepts before its flags. `nebula
|
||||
// ctl <command>` runs the client. Any other first argument that is not a flag is a
|
||||
// mistyped subcommand, reported with a usage line: the daemon's flag parser would ignore
|
||||
// the stray word and start nebula, so `nebula clt` would bring up a second daemon
|
||||
// instead of reporting a typo. It returns the exit code and true when the process is
|
||||
// done, and false when argv is the daemon's to parse. Both daemon binaries, cmd/nebula
|
||||
// and cmd/nebula-service, call it before anything else, so each has a nebula ctl and
|
||||
// neither has the hazard. A word that follows the daemon's flags instead is Trailing's.
|
||||
func Subcommand(argv []string) (code int, done bool) {
|
||||
if len(argv) < 2 || strings.HasPrefix(argv[1], "-") {
|
||||
return 0, false
|
||||
}
|
||||
|
||||
if argv[1] == Word {
|
||||
return Run(argv[2:]), true
|
||||
}
|
||||
|
||||
return unknownCommand(argv[1]), true
|
||||
}
|
||||
|
||||
// Trailing handles the words the daemon's flag parser leaves unparsed: flag.Parse stops
|
||||
// at the first argument that is not a flag and hands the rest back. rest is flag.Args()
|
||||
// after the daemon has parsed, and configPath is the config the daemon's -config named,
|
||||
// "" when it did not. Both daemon binaries call it right after flag.Parse, so that
|
||||
// `nebula -config x ctl identity` runs the client and `nebula -config x clt` reports a
|
||||
// typo, as Subcommand does for a word at the front of the line; a daemon that ignored
|
||||
// the words would start in their place.
|
||||
//
|
||||
// A leading ctl word runs the client on what follows, with the daemon's -config carried
|
||||
// over: an operator who typed it meant the daemon running on that config, and the client
|
||||
// derives the same socket from it. Any other word is a mistake, reported as Subcommand
|
||||
// reports one.
|
||||
func Trailing(rest []string, configPath string) (code int, done bool) {
|
||||
if len(rest) == 0 {
|
||||
return 0, false
|
||||
}
|
||||
|
||||
if rest[0] != Word {
|
||||
return unknownCommand(rest[0]), true
|
||||
}
|
||||
|
||||
args := rest[1:]
|
||||
if configPath != "" {
|
||||
// First, so a -config on the ctl side of the line still wins: Parse applies
|
||||
// flags in order and the last value set is the one read.
|
||||
args = append([]string{"-" + commands.FlagConfig, configPath}, args...)
|
||||
}
|
||||
|
||||
return Run(args), true
|
||||
}
|
||||
|
||||
// unknownCommand reports a bare word that is neither a flag nor ctl, with the one usage
|
||||
// line that says what the two forms of the command line are.
|
||||
func unknownCommand(word string) int {
|
||||
fmt.Fprintf(os.Stderr, "nebula: unknown command %q\n\n", word)
|
||||
fmt.Fprintf(os.Stderr, "Run nebula with flags to start it, or `nebula %s <command>` to control one that is already running.\n", Word)
|
||||
return 1
|
||||
}
|
||||
|
||||
// Run implements `nebula ctl <command> [args]`
|
||||
//
|
||||
// args is everything after the `ctl` word.
|
||||
func Run(args []string) int {
|
||||
fs := flag.NewFlagSet("nebula ctl", flag.ContinueOnError)
|
||||
fs.SetOutput(os.Stderr)
|
||||
|
||||
configPath := fs.String(commands.FlagConfig, "", "Path to the config of the running nebula, used to locate its control socket")
|
||||
socketPath := fs.String(commands.FlagSocket, "", "Path to the control socket, instead of the one the config implies")
|
||||
fs.Usage = func() {
|
||||
fmt.Fprintf(os.Stderr, "Usage: nebula ctl [flags] <command> [command flags]\n\n")
|
||||
fmt.Fprintf(os.Stderr, "Inspects and controls a nebula already running on this machine.\n")
|
||||
fmt.Fprintf(os.Stderr, "Run it as the user who ran nebula, or as a member of the group %s names.\n\n", localapi.CtlGroupKey)
|
||||
fmt.Fprintf(os.Stderr, "Flags, which may come before or after the command:\n")
|
||||
fs.PrintDefaults()
|
||||
fmt.Fprintf(os.Stderr, "\nRun `nebula ctl help` for the available commands.\n")
|
||||
}
|
||||
|
||||
own, cmdArgs := splitLine(fs, args)
|
||||
if err := fs.Parse(own); err != nil {
|
||||
// fs has already printed the usage, or the problem. Asking for help is not a
|
||||
// failure, and a script that chains on `nebula ctl -h` should not see one.
|
||||
if errors.Is(err, flag.ErrHelp) {
|
||||
return 0
|
||||
}
|
||||
return 1
|
||||
}
|
||||
|
||||
if len(cmdArgs) == 0 {
|
||||
cmdArgs = []string{"help"}
|
||||
}
|
||||
|
||||
path, err := resolveSocket(*socketPath, *configPath)
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "%s\n", err)
|
||||
return 1
|
||||
}
|
||||
|
||||
client := &localapi.Client{Path: path}
|
||||
|
||||
// Ask the daemon what it serves before parsing anything. The flags belong to the
|
||||
// command, which lives over there, so this is what lets the CLI keep its usual shape
|
||||
// while the wire protocol stays a named-parameter API rather than a shipped argv.
|
||||
schema, err := client.Describe()
|
||||
if err != nil {
|
||||
// A daemon that answered was reached, and what it said, or that it could not be
|
||||
// read, is the whole message.
|
||||
var refused *localapi.DaemonError
|
||||
var unread *localapi.ReplyError
|
||||
if errors.As(err, &refused) || errors.As(err, &unread) {
|
||||
fmt.Fprintf(os.Stderr, "nebula: %s\n", err)
|
||||
return 1
|
||||
}
|
||||
|
||||
// Otherwise the operating system said why, and it is passed on as it came: a
|
||||
// permission denied or a missing socket says more about what to do than a
|
||||
// guess at the operator's setup would.
|
||||
fmt.Fprintf(os.Stderr, "nebula: could not reach the control socket at %s: %s\n", path, err)
|
||||
return 1
|
||||
}
|
||||
|
||||
req, printedHelp, err := parseCommand(schema, cmdArgs)
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "%s\n", err)
|
||||
return 1
|
||||
}
|
||||
|
||||
if printedHelp {
|
||||
return 0
|
||||
}
|
||||
|
||||
res, err := client.Invoke(string(req.name), req.Params, req.Args, wireFormat(req.Format))
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "nebula: %s\n", err)
|
||||
return 1
|
||||
}
|
||||
|
||||
out := output(res, req.Format)
|
||||
if out != "" {
|
||||
fmt.Fprint(os.Stdout, out)
|
||||
if !strings.HasSuffix(out, "\n") {
|
||||
fmt.Fprintln(os.Stdout)
|
||||
}
|
||||
}
|
||||
|
||||
// Error set is the one failure signal, whether the request never ran or the command
|
||||
// ran and refused. A refusal asked for in JSON has already gone to stdout as the
|
||||
// {ok, reason} object, and is not said again on stderr; the exit status carries it.
|
||||
if res.Error == "" {
|
||||
return 0
|
||||
}
|
||||
|
||||
if len(res.Result) == 0 && len(res.Text) == 0 {
|
||||
msg := res.Error
|
||||
if !strings.HasSuffix(msg, "\n") {
|
||||
msg += "\n"
|
||||
}
|
||||
fmt.Fprint(os.Stderr, msg)
|
||||
}
|
||||
|
||||
return 1
|
||||
}
|
||||
|
||||
// output renders what the daemon answered for the format the line asked for. A text
|
||||
// request is answered in Text with the bytes the command wrote, printed as they are; a
|
||||
// JSON request is answered in Result with the value itself, printed as it came, since a
|
||||
// value that happens to be a string is still JSON to the script reading it. Indentation
|
||||
// is the client's business: whitespace does not survive a JSON envelope, and the daemon
|
||||
// has no reason to care how its answer is laid out. The bytes are re-indented rather
|
||||
// than decoded and encoded again, which would sort the keys and round the numbers.
|
||||
func output(res *localapi.Response, format commands.Format) string {
|
||||
switch format {
|
||||
case commands.FormatJSON:
|
||||
return string(res.Result)
|
||||
case commands.FormatPrettyJSON:
|
||||
var buf bytes.Buffer
|
||||
if err := json.Indent(&buf, res.Result, "", " "); err != nil {
|
||||
return string(res.Result)
|
||||
}
|
||||
return buf.String()
|
||||
default:
|
||||
return string(res.Text)
|
||||
}
|
||||
}
|
||||
|
||||
// ctlRequest is one parsed nebula ctl command line: the command's name, which only the
|
||||
// daemon can resolve, and the line as every surface parses it. The Request's Command is
|
||||
// nil here, since the CLI holds a schema rather than the command, and its Format is
|
||||
// FormatUnset when the line named none, which to nebula ctl means text: its default
|
||||
// differs from the API's.
|
||||
type ctlRequest struct {
|
||||
name commands.Name
|
||||
commands.Request
|
||||
}
|
||||
|
||||
// wireFormat is what a request asks the daemon for. Pretty is the client's business,
|
||||
// since whitespace does not survive a JSON envelope, so it travels as json. No
|
||||
// preference is text, nebula ctl's default: a person gets the human rendering wherever
|
||||
// one exists.
|
||||
func wireFormat(f commands.Format) string {
|
||||
switch f {
|
||||
case commands.FormatJSON, commands.FormatPrettyJSON:
|
||||
return "json"
|
||||
default:
|
||||
return "text"
|
||||
}
|
||||
}
|
||||
|
||||
// parseCommand turns the user's command line into a ctlRequest, using the schema the
|
||||
// daemon supplied. The line is parsed with the same rules the daemon applies to an ssh
|
||||
// line, through ParseArgs, and ParseLine reads what was set into the Request to send, so
|
||||
// a line means the same on both.
|
||||
//
|
||||
// printedHelp reports that help was written for the command instead, and there is
|
||||
// nothing to send.
|
||||
func parseCommand(schema []commands.CommandSchema, argv []string) (req ctlRequest, printedHelp bool, err error) {
|
||||
name := commands.Name(argv[0])
|
||||
|
||||
var found *commands.CommandSchema
|
||||
for i := range schema {
|
||||
if schema[i].Name == name {
|
||||
found = &schema[i]
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if found == nil {
|
||||
// Let the daemon answer. It knows whether this is a typo or a command it holds
|
||||
// back, and its message for the second case is better than anything guessable
|
||||
// from the schema alone.
|
||||
return ctlRequest{name: name, Request: commands.Request{Args: argv[1:]}}, false, nil
|
||||
}
|
||||
|
||||
// The flag package's own report is a bare message followed by a usage dump in a layout
|
||||
// that does not match WriteCommandHelp, so it is silenced and the error is reported
|
||||
// once, below, with a pointer at the help this command actually prints.
|
||||
fs := flag.NewFlagSet(string(name), flag.ContinueOnError)
|
||||
fs.SetOutput(io.Discard)
|
||||
|
||||
for _, f := range found.Flags {
|
||||
if f.Bool {
|
||||
fs.Bool(f.Name, f.Default == "true", f.Usage)
|
||||
continue
|
||||
}
|
||||
fs.String(f.Name, f.Default, f.Usage)
|
||||
}
|
||||
|
||||
operands, err := commands.ParseArgs(fs, argv[1:])
|
||||
if err != nil {
|
||||
if errors.Is(err, flag.ErrHelp) {
|
||||
// The same rendering the daemon uses for `help <command>`, so -h and help agree.
|
||||
_ = commands.WriteCommandHelp(*found, os.Stdout)
|
||||
return ctlRequest{}, true, nil
|
||||
}
|
||||
|
||||
// Say what flag did: an unknown flag, a missing value and a malformed value are
|
||||
// different mistakes, and "does not take" would be wrong for two of them.
|
||||
return ctlRequest{}, false, fmt.Errorf("nebula: %s: %s (see 'nebula ctl %s -h')", name, err, name)
|
||||
}
|
||||
|
||||
// Only what the user actually set travels. A parameter left alone is the daemon's
|
||||
// default to apply, not the client's to assert, and the presentation flags are the
|
||||
// client's to interpret, never sent.
|
||||
//
|
||||
// Where the command has no human form the daemon says so, and only once the command
|
||||
// has run: a refusal ("No vpn address was provided") always has a human form, so
|
||||
// telling the user to pass -json before finding out whether the command would even
|
||||
// accept the line sends them to fix the wrong thing. That is why the schema does not
|
||||
// say which commands have a human form: nothing should decide on it before running.
|
||||
return ctlRequest{name: name, Request: commands.ParseLine(fs, operands)}, false, nil
|
||||
}
|
||||
|
||||
// splitLine divides a nebula ctl line into the client's own flags, for fs to parse, and
|
||||
// the command line to send, which begins with the command word. The client's flags may
|
||||
// come before the command or after it: `nebula ctl -config x identity` and
|
||||
// `nebula ctl identity -config x` mean the same, so an operator who has typed a command
|
||||
// and then remembers which daemon they meant does not have to retype the line.
|
||||
//
|
||||
// Before the command word every flag is the client's, whatever it is, so an unknown one
|
||||
// is reported by fs, and -h is the client's usage. After it only the
|
||||
// flags fs defines are lifted out, and only those: the command's own flags are unknown
|
||||
// here, since they come from the daemon the line has yet to name, and -h after the
|
||||
// command asks for that command's help. Which command flags take a value is unknown too,
|
||||
// so the client's names are reserved in the commands package and no command can give
|
||||
// one a value that would be lifted from here. A "--" before the command is consumed, as
|
||||
// fs.Parse would have; one after it belongs to the command line and ends the lifting,
|
||||
// so an operand spelled like a client flag can still be passed.
|
||||
func splitLine(fs *flag.FlagSet, args []string) (own, cmd []string) {
|
||||
seenCommand := false
|
||||
for i := 0; i < len(args); i++ {
|
||||
a := args[i]
|
||||
|
||||
if a == "--" {
|
||||
if seenCommand {
|
||||
return own, append(cmd, args[i:]...)
|
||||
}
|
||||
seenCommand = true
|
||||
continue
|
||||
}
|
||||
|
||||
if !seenCommand {
|
||||
if len(a) < 2 || a[0] != '-' {
|
||||
seenCommand = true
|
||||
cmd = append(cmd, a)
|
||||
continue
|
||||
}
|
||||
|
||||
own = append(own, a)
|
||||
if f, hasValue := commands.LookupArg(fs, a); f != nil && !hasValue && !commands.IsBoolFlag(f) && i+1 < len(args) {
|
||||
i++
|
||||
own = append(own, args[i])
|
||||
}
|
||||
continue
|
||||
}
|
||||
|
||||
if len(a) >= 2 && a[0] == '-' {
|
||||
// The same reading of the argument ParseArgs makes, so a word this lifts as a
|
||||
// client flag's value is one the daemon's parser would have read the same way.
|
||||
if f, hasValue := commands.LookupArg(fs, a); f != nil {
|
||||
own = append(own, a)
|
||||
if !hasValue && !commands.IsBoolFlag(f) && i+1 < len(args) {
|
||||
i++
|
||||
own = append(own, args[i])
|
||||
}
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
cmd = append(cmd, a)
|
||||
}
|
||||
|
||||
return own, cmd
|
||||
}
|
||||
|
||||
// resolveSocket decides which socket to talk to. It never searches: the answer is the
|
||||
// socket the operator named, or the one the config implies, and nothing else.
|
||||
//
|
||||
// An explicit flag wins. Otherwise the config is read, the one the operator named or the
|
||||
// one found next to the executable, and the path is the socket that config implies: its
|
||||
// local_api.control.socket if set, else the same derivation the daemon applies.
|
||||
func resolveSocket(socketFlag, configFlag string) (string, error) {
|
||||
if socketFlag != "" {
|
||||
return socketFlag, nil
|
||||
}
|
||||
|
||||
return pathFromConfig(configFlag)
|
||||
}
|
||||
|
||||
// pathFromConfig returns the socket path the daemon would be serving: the one
|
||||
// local_api.control.socket names in the config, so an operator who moved the socket does
|
||||
// not have to repeat themselves on every invocation, else the default.
|
||||
//
|
||||
// A config the operator did not name is a guess: config.DefaultPath looks next to the
|
||||
// executable, and a package that installs a default config there while systemd starts
|
||||
// the daemon with another will make it the wrong guess. It is still the only answer
|
||||
// that involves no searching. A guess that cannot be read is not an error, it is no
|
||||
// guess: a member of the socket's group cannot read a root daemon's config, and is
|
||||
// answered by the default path, where the daemon serves unless that config moved it.
|
||||
// A config the operator named is theirs to make readable.
|
||||
func pathFromConfig(configFlag string) (string, error) {
|
||||
return socketFromConfigFile(configFlag, configFlag != "")
|
||||
}
|
||||
|
||||
func socketFromConfigFile(configPath string, named bool) (string, error) {
|
||||
if !named {
|
||||
p, err := config.DefaultPath()
|
||||
if err != nil {
|
||||
return localapi.DefaultSocketPath, nil
|
||||
}
|
||||
configPath = p
|
||||
}
|
||||
|
||||
// The config is loaded only to find the socket path. Loading logs lines that belong
|
||||
// to the daemon, not to someone running a read only command, and mixing them into
|
||||
// the CLI's output would corrupt a -json result, so they are discarded.
|
||||
c := config.NewC(slog.New(slog.DiscardHandler))
|
||||
if err := c.Load(configPath); err != nil {
|
||||
if !named {
|
||||
return localapi.DefaultSocketPath, nil
|
||||
}
|
||||
// The operating system's error, as it came: permission denied on a root daemon's
|
||||
// config says what to do.
|
||||
return "", fmt.Errorf("nebula: could not read %s: %w", configPath, err)
|
||||
}
|
||||
|
||||
// A daemon running this config serves no socket; dialing the path would only say
|
||||
// that nothing is there.
|
||||
if !localapi.ControlEnabled(c) {
|
||||
return "", fmt.Errorf("nebula: the control socket is disabled in %s by %s", configPath, localapi.CtlEnabledKey)
|
||||
}
|
||||
|
||||
// The same call the daemon makes, so the two agree on the path and on what makes a
|
||||
// path unusable.
|
||||
p, err := localapi.SocketPathFromConfig(c)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("nebula: %w", err)
|
||||
}
|
||||
|
||||
return p, nil
|
||||
}
|
||||
@@ -0,0 +1,294 @@
|
||||
package ctl
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"flag"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/localapi"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// TestResolveSocketReportsAnUnreadableConfig: an operator who named a config must hear
|
||||
// that it could not be read, rather than have the command steered anywhere else.
|
||||
func TestResolveSocketReportsAnUnreadableConfig(t *testing.T) {
|
||||
missing := filepath.Join(t.TempDir(), "typo.yml")
|
||||
|
||||
_, err := resolveSocket("", missing)
|
||||
require.Error(t, err)
|
||||
assert.Contains(t, err.Error(), missing)
|
||||
}
|
||||
|
||||
// TestResolveSocketGuessedConfigNeedNotBeReadable: a config nobody named is a guess, and
|
||||
// one that cannot be read, a root daemon's config read by a member of the socket's
|
||||
// group, means the default path rather than an error.
|
||||
func TestResolveSocketGuessedConfigNeedNotBeReadable(t *testing.T) {
|
||||
missing := filepath.Join(t.TempDir(), "config.yml")
|
||||
|
||||
p, err := socketFromConfigFile(missing, false)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, localapi.DefaultSocketPath, p)
|
||||
|
||||
_, err = socketFromConfigFile(missing, true)
|
||||
require.ErrorContains(t, err, missing)
|
||||
}
|
||||
|
||||
// nowhereSocket is a socket name nothing listens on, spelled the way the platform
|
||||
// requires: a full pipe name on windows, an absolute path elsewhere.
|
||||
var nowhereSocket = map[bool]string{true: `\\.\pipe\nebula-nowhere`, false: "/nowhere/ctl.sock"}[runtime.GOOS == "windows"]
|
||||
|
||||
// namedSocketConfig is a config that names nowhereSocket as the control socket. Single
|
||||
// quotes keep a pipe name's backslashes literal in YAML.
|
||||
var namedSocketConfig = "local_api:\n control:\n socket: '" + nowhereSocket + "'\n"
|
||||
|
||||
// TestResolveSocketTrustsANamedConfig: a config the operator named yields the socket it
|
||||
// implies even when nothing is listening there, so a dial failure names that socket.
|
||||
func TestResolveSocketTrustsANamedConfig(t *testing.T) {
|
||||
cfg := filepath.Join(t.TempDir(), "config.yml")
|
||||
require.NoError(t, os.WriteFile(cfg, []byte(namedSocketConfig), 0600))
|
||||
|
||||
p, err := resolveSocket("", cfg)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, nowhereSocket, p)
|
||||
}
|
||||
|
||||
// TestResolveSocketSaysTheSocketIsDisabled: a config that turns the control socket off
|
||||
// is answered with that, not with a dial to a path nothing serves. -socket still wins.
|
||||
func TestResolveSocketSaysTheSocketIsDisabled(t *testing.T) {
|
||||
cfg := filepath.Join(t.TempDir(), "config.yml")
|
||||
require.NoError(t, os.WriteFile(cfg, []byte("local_api:\n control:\n enabled: false\n"), 0600))
|
||||
|
||||
_, err := resolveSocket("", cfg)
|
||||
require.ErrorContains(t, err, "the control socket is disabled in "+cfg+" by local_api.control.enabled")
|
||||
|
||||
p, err := resolveSocket("/explicit.sock", cfg)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "/explicit.sock", p)
|
||||
}
|
||||
|
||||
// TestResolveSocketUsesTheDefaultWithoutAnOverride: a config that does not name the
|
||||
// socket means the default path, the same one the daemon serves with that config, and
|
||||
// no config at all means the default too, since that is where a daemon started without
|
||||
// an override serves. Nothing is searched for.
|
||||
func TestResolveSocketUsesTheDefaultWithoutAnOverride(t *testing.T) {
|
||||
cfg := filepath.Join(t.TempDir(), "config.yml")
|
||||
require.NoError(t, os.WriteFile(cfg, []byte("static_host_map: {}\n"), 0600))
|
||||
|
||||
p, err := resolveSocket("", cfg)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, localapi.DefaultSocketPath, p)
|
||||
|
||||
// The test binary has no config next to it.
|
||||
p, err = resolveSocket("", "")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, localapi.DefaultSocketPath, p)
|
||||
}
|
||||
|
||||
func TestResolveSocketFlagWins(t *testing.T) {
|
||||
p, err := resolveSocket("/explicit.sock", "/does/not/matter.yml")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "/explicit.sock", p)
|
||||
}
|
||||
|
||||
// TestParseCommandReportsWhatFlagSaid covers the three ways a flag line goes wrong, which
|
||||
// are different mistakes: an unknown flag, a valid flag with a missing value, and a
|
||||
// valid flag with a value it cannot parse.
|
||||
func TestParseCommandReportsWhatFlagSaid(t *testing.T) {
|
||||
schema := []commands.CommandSchema{{
|
||||
Name: "change-remote",
|
||||
Flags: []commands.FlagSchema{
|
||||
{Name: "address"},
|
||||
{Name: "by-index", Bool: true},
|
||||
},
|
||||
}}
|
||||
|
||||
cases := map[string]struct {
|
||||
argv []string
|
||||
want string
|
||||
}{
|
||||
"missing value": {[]string{"change-remote", "-address"}, "flag needs an argument: -address"},
|
||||
"bad bool": {[]string{"change-remote", "-by-index=maybe"}, "invalid boolean value \"maybe\" for -by-index"},
|
||||
"unknown flag": {[]string{"change-remote", "-nope"}, "flag provided but not defined: -nope"},
|
||||
}
|
||||
|
||||
for name, tc := range cases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
_, _, err := parseCommand(schema, tc.argv)
|
||||
require.Error(t, err)
|
||||
require.ErrorContains(t, err, "nebula: change-remote: "+tc.want)
|
||||
require.ErrorContains(t, err, "see 'nebula ctl change-remote -h'")
|
||||
assert.NotContains(t, err.Error(), "does not take")
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestParseCommandOffPresentationFlagIsNoPreference: the daemon treats -json=false as
|
||||
// no preference, so nebula ctl must too, or the same line renders differently on the
|
||||
// two surfaces. Only a true value asks for JSON, and -pretty implies it.
|
||||
func TestParseCommandOffPresentationFlagIsNoPreference(t *testing.T) {
|
||||
schema := []commands.CommandSchema{{
|
||||
Name: "device-info",
|
||||
Flags: []commands.FlagSchema{
|
||||
{Name: commands.FlagJSON, Bool: true, Default: "false"},
|
||||
{Name: commands.FlagPretty, Bool: true, Default: "false"},
|
||||
},
|
||||
}}
|
||||
|
||||
for _, tc := range []struct {
|
||||
argv []string
|
||||
want commands.Format
|
||||
wire string
|
||||
}{
|
||||
{[]string{"device-info"}, commands.FormatUnset, "text"},
|
||||
{[]string{"device-info", "-json=false"}, commands.FormatUnset, "text"},
|
||||
{[]string{"device-info", "-json"}, commands.FormatJSON, "json"},
|
||||
{[]string{"device-info", "-pretty"}, commands.FormatPrettyJSON, "json"},
|
||||
} {
|
||||
t.Run(strings.Join(tc.argv[1:], " "), func(t *testing.T) {
|
||||
req, printedHelp, err := parseCommand(schema, tc.argv)
|
||||
require.NoError(t, err)
|
||||
assert.False(t, printedHelp)
|
||||
assert.Equal(t, tc.want, req.Format)
|
||||
assert.Equal(t, tc.wire, wireFormat(req.Format))
|
||||
assert.Nil(t, req.Params, "presentation flags are never sent as parameters")
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestParseCommandReadsTheLineAsTheDaemonDoes: nebula ctl parses the line with the same
|
||||
// rules as the daemon, so an operand after "--" reaches the command on both and a
|
||||
// negative number before it is the flag it would be at an ssh prompt.
|
||||
func TestParseCommandReadsTheLineAsTheDaemonDoes(t *testing.T) {
|
||||
schema := []commands.CommandSchema{{Name: "set"}}
|
||||
|
||||
req, printedHelp, err := parseCommand(schema, []string{"set", "--", "-1"})
|
||||
require.NoError(t, err)
|
||||
assert.False(t, printedHelp)
|
||||
assert.Equal(t, commands.Name("set"), req.name)
|
||||
assert.Nil(t, req.Params)
|
||||
assert.Equal(t, []string{"-1"}, req.Args)
|
||||
|
||||
_, _, err = parseCommand(schema, []string{"set", "-1"})
|
||||
require.ErrorContains(t, err, "flag provided but not defined: -1")
|
||||
}
|
||||
|
||||
// TestOutputRendersForTheFormatAsked: what the daemon answered is read by the format the
|
||||
// line asked for, never by sniffing the bytes. A text answer is the command's rendering,
|
||||
// printed as it came; a JSON answer whose value is a string stays quoted, since to the
|
||||
// script reading it that string is the JSON.
|
||||
func TestOutputRendersForTheFormatAsked(t *testing.T) {
|
||||
text := &localapi.Response{Text: []byte("Log level is: info\n")}
|
||||
assert.Equal(t, "Log level is: info\n", output(text, commands.FormatUnset))
|
||||
assert.Equal(t, "Log level is: info\n", output(text, commands.FormatText))
|
||||
|
||||
str := &localapi.Response{Result: json.RawMessage(`"some string"`)}
|
||||
assert.Equal(t, `"some string"`, output(str, commands.FormatJSON))
|
||||
assert.Equal(t, `"some string"`, output(str, commands.FormatPrettyJSON))
|
||||
|
||||
// Keys stay in the order the daemon wrote them and a uint64 past 2^53 is not rounded,
|
||||
// which decoding into `any` and encoding again would do.
|
||||
obj := &localapi.Response{Result: json.RawMessage(`{"z":18446744073709551615,"a":{"y":[1,2],"b":true}}`)}
|
||||
//nolint:testifylint // the layout is what is under test, which JSONEq would not see
|
||||
assert.Equal(t, `{"z":18446744073709551615,"a":{"y":[1,2],"b":true}}`, output(obj, commands.FormatJSON))
|
||||
//nolint:testifylint // as above
|
||||
assert.Equal(t, "{\n \"z\": 18446744073709551615,\n \"a\": {\n \"y\": [\n 1,\n 2\n ],\n \"b\": true\n }\n}", output(obj, commands.FormatPrettyJSON))
|
||||
|
||||
bad := &localapi.Response{Result: json.RawMessage(`{"a":`)}
|
||||
assert.Equal(t, `{"a":`, output(bad, commands.FormatPrettyJSON), "what cannot be indented is printed as it came")
|
||||
|
||||
none := &localapi.Response{}
|
||||
assert.Empty(t, output(none, commands.FormatJSON))
|
||||
assert.Empty(t, output(none, commands.FormatUnset))
|
||||
}
|
||||
|
||||
// TestSplitLineLiftsOwnFlagsFromAnywhere: -config and -socket are the client's wherever
|
||||
// they appear, before the command or after it, in either spelling, so the two orders
|
||||
// mean the same line. Everything else after the command word stays in order for the
|
||||
// command's own parse, including flags and operands that happen to look like values.
|
||||
func TestSplitLineLiftsOwnFlagsFromAnywhere(t *testing.T) {
|
||||
newFS := func() *flag.FlagSet {
|
||||
fs := flag.NewFlagSet("nebula ctl", flag.ContinueOnError)
|
||||
fs.String(commands.FlagConfig, "", "")
|
||||
fs.String(commands.FlagSocket, "", "")
|
||||
return fs
|
||||
}
|
||||
|
||||
for _, tc := range []struct {
|
||||
args []string
|
||||
wantOwn []string
|
||||
wantCmd []string
|
||||
}{
|
||||
{nil, nil, nil},
|
||||
{[]string{"identity"}, nil, []string{"identity"}},
|
||||
{[]string{"-config", "x", "identity"}, []string{"-config", "x"}, []string{"identity"}},
|
||||
{[]string{"identity", "-config", "x"}, []string{"-config", "x"}, []string{"identity"}},
|
||||
{[]string{"identity", "-config=x"}, []string{"-config=x"}, []string{"identity"}},
|
||||
{[]string{"identity", "--socket", "s"}, []string{"--socket", "s"}, []string{"identity"}},
|
||||
{[]string{"-socket", "s", "identity", "-config", "x"}, []string{"-socket", "s", "-config", "x"}, []string{"identity"}},
|
||||
// The command's flags and operands are left where they are, around the lifted ones.
|
||||
{[]string{"print-tunnel", "10.0.0.1", "-config", "x", "-json"}, []string{"-config", "x"}, []string{"print-tunnel", "10.0.0.1", "-json"}},
|
||||
{[]string{"change-remote", "-address", "1.2.3.4:5", "-socket", "s", "10.0.0.1"}, []string{"-socket", "s"}, []string{"change-remote", "-address", "1.2.3.4:5", "10.0.0.1"}},
|
||||
// -h before the command is the client's usage; after it, the command's help.
|
||||
{[]string{"-h"}, []string{"-h"}, nil},
|
||||
{[]string{"identity", "-h"}, nil, []string{"identity", "-h"}},
|
||||
// An unknown flag before the command is the client's to report, and does not
|
||||
// swallow the command word as its value.
|
||||
{[]string{"-nope", "identity"}, []string{"-nope"}, []string{"identity"}},
|
||||
// A -config with nothing after it is left for fs.Parse to report.
|
||||
{[]string{"identity", "-config"}, []string{"-config"}, []string{"identity"}},
|
||||
// "--" before the command is consumed, as fs.Parse consumed it; after the command
|
||||
// it belongs to the line and ends the lifting.
|
||||
{[]string{"--", "identity", "-config", "x"}, []string{"-config", "x"}, []string{"identity"}},
|
||||
{[]string{"identity", "--", "-config", "x"}, nil, []string{"identity", "--", "-config", "x"}},
|
||||
} {
|
||||
t.Run(strings.Join(tc.args, " "), func(t *testing.T) {
|
||||
own, cmd := splitLine(newFS(), tc.args)
|
||||
assert.Equal(t, tc.wantOwn, own)
|
||||
assert.Equal(t, tc.wantCmd, cmd)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestTrailingHandlesWordsAfterTheDaemonsFlags: what flag.Parse leaves behind is never
|
||||
// a daemon to start. A leading ctl runs the client on the rest, with the daemon's
|
||||
// -config carried over; anything else is a mistyped subcommand. Only -h is run here,
|
||||
// since the client's help needs no daemon: it proves the words reach Run and that a
|
||||
// carried -config is accepted by it.
|
||||
func TestTrailingHandlesWordsAfterTheDaemonsFlags(t *testing.T) {
|
||||
code, done := Trailing(nil, "")
|
||||
assert.False(t, done)
|
||||
assert.Equal(t, 0, code)
|
||||
|
||||
code, done = Trailing([]string{"clt"}, "")
|
||||
assert.True(t, done)
|
||||
assert.Equal(t, 1, code)
|
||||
|
||||
code, done = Trailing([]string{Word, "-h"}, "")
|
||||
assert.True(t, done)
|
||||
assert.Equal(t, 0, code)
|
||||
|
||||
code, done = Trailing([]string{Word, "-h"}, "/etc/nebula/config.yml")
|
||||
assert.True(t, done)
|
||||
assert.Equal(t, 0, code)
|
||||
}
|
||||
|
||||
// TestSubcommandOnlyReadsTheFirstWord: a flag first means the line is the daemon's to
|
||||
// parse, and whatever follows the flags is Trailing's to judge.
|
||||
func TestSubcommandOnlyReadsTheFirstWord(t *testing.T) {
|
||||
_, done := Subcommand([]string{"nebula", "-config", "x", Word})
|
||||
assert.False(t, done)
|
||||
|
||||
code, done := Subcommand([]string{"nebula", "clt"})
|
||||
assert.True(t, done)
|
||||
assert.Equal(t, 1, code)
|
||||
|
||||
code, done = Subcommand([]string{"nebula", Word, "-h"})
|
||||
assert.True(t, done)
|
||||
assert.Equal(t, 0, code)
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
//go:build !windows
|
||||
|
||||
package ctl
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/slackhq/nebula/localapi"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// TestResolveSocketDiagnosesAnOverlongOverride: the CLI applies the daemon's own rule to
|
||||
// the override, so it says what the daemon's log says rather than dialing a path the
|
||||
// kernel would truncate and reporting the generic failure. The rule is sun_path's, which
|
||||
// a named pipe does not have, so this is a unix test.
|
||||
func TestResolveSocketDiagnosesAnOverlongOverride(t *testing.T) {
|
||||
cfg := filepath.Join(t.TempDir(), "config.yml")
|
||||
long := "/" + strings.Repeat("x", 120)
|
||||
require.NoError(t, os.WriteFile(cfg, []byte("local_api:\n control:\n socket: "+long+"\n"), 0600))
|
||||
|
||||
_, err := resolveSocket("", cfg)
|
||||
require.Error(t, err)
|
||||
require.ErrorContains(t, err, "too long for this platform")
|
||||
assert.ErrorContains(t, err, localapi.CtlSocketKey)
|
||||
}
|
||||
|
||||
// TestResolveSocketRefusesARelativeOverride: the CLI applies the daemon's rule here too,
|
||||
// so a relative path in the config is reported as the daemon's log reports it rather
|
||||
// than resolved against wherever nebula ctl happened to be run from.
|
||||
func TestResolveSocketRefusesARelativeOverride(t *testing.T) {
|
||||
cfg := filepath.Join(t.TempDir(), "config.yml")
|
||||
require.NoError(t, os.WriteFile(cfg, []byte("local_api:\n control:\n socket: run/ctl.sock\n"), 0600))
|
||||
|
||||
_, err := resolveSocket("", cfg)
|
||||
require.Error(t, err)
|
||||
require.ErrorContains(t, err, "must be an absolute path")
|
||||
assert.ErrorContains(t, err, localapi.CtlSocketKey)
|
||||
}
|
||||
@@ -8,7 +8,9 @@ import (
|
||||
"strings"
|
||||
|
||||
"github.com/slackhq/nebula"
|
||||
"github.com/slackhq/nebula/cmd/internal/ctl"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/localapi"
|
||||
"github.com/slackhq/nebula/logging"
|
||||
"github.com/slackhq/nebula/util"
|
||||
)
|
||||
@@ -32,6 +34,11 @@ func init() {
|
||||
}
|
||||
|
||||
func main() {
|
||||
// commands are either `nebula ctl ...` or `nebula -<flag> ...`
|
||||
if code, done := ctl.Subcommand(os.Args); done {
|
||||
os.Exit(code)
|
||||
}
|
||||
|
||||
serviceFlag := flag.String("service", "", "Control the system service.")
|
||||
configPath := flag.String("config", "", "Path to either a file or directory to load configuration from")
|
||||
configTest := flag.Bool("test", false, "Test the config and print the end result. Non zero exit indicates a faulty config")
|
||||
@@ -40,6 +47,12 @@ func main() {
|
||||
|
||||
flag.Parse()
|
||||
|
||||
// A word after the daemon's flags is `ctl` in the other place an operator puts it,
|
||||
// or a mistyped subcommand, and either way not a daemon to start; see Trailing.
|
||||
if code, done := ctl.Trailing(flag.Args(), *configPath); done {
|
||||
os.Exit(code)
|
||||
}
|
||||
|
||||
if *printVersion {
|
||||
fmt.Printf("Version: %s\n", Build)
|
||||
os.Exit(0)
|
||||
@@ -104,9 +117,17 @@ func main() {
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
local := localapi.Wire(ctrl.Context(), l, c, ctrl.Commands())
|
||||
|
||||
go ctrl.ShutdownBlock()
|
||||
|
||||
if err := ctrl.Wait(); err != nil {
|
||||
err := ctrl.Wait()
|
||||
|
||||
// os.Exit skips deferred calls, so the sockets are removed here, before either
|
||||
// exit below, rather than left to a deferred Stop that would never run.
|
||||
local.Stop()
|
||||
|
||||
if err != nil {
|
||||
l.Error("Nebula stopped due to fatal error", "error", err)
|
||||
os.Exit(2)
|
||||
}
|
||||
|
||||
@@ -8,6 +8,7 @@ import (
|
||||
"github.com/kardianos/service"
|
||||
"github.com/slackhq/nebula"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/localapi"
|
||||
"github.com/slackhq/nebula/logging"
|
||||
)
|
||||
|
||||
@@ -17,6 +18,7 @@ type program struct {
|
||||
configPath *string
|
||||
build string
|
||||
control *nebula.Control
|
||||
local *localapi.Endpoints
|
||||
}
|
||||
|
||||
func (p *program) Start(s service.Service) error {
|
||||
@@ -50,10 +52,16 @@ func (p *program) Start(s service.Service) error {
|
||||
return err
|
||||
}
|
||||
|
||||
// Now that we're started, stand up the local APIs.
|
||||
p.local = localapi.Wire(p.control.Context(), l, c, p.control.Commands())
|
||||
|
||||
// Nebula can stop itself on a fatal packet reader error, make sure to log it if it happens.
|
||||
go func() {
|
||||
if err := p.control.Wait(); err != nil {
|
||||
logger.Error(fmt.Sprintf("Nebula stopped due to fatal error: %v", err))
|
||||
// os.Exit skips deferred calls and races the sockets' own context watchers,
|
||||
// so they are removed here, as cmd/nebula does.
|
||||
p.local.Stop()
|
||||
os.Exit(2)
|
||||
}
|
||||
}()
|
||||
@@ -63,6 +71,11 @@ func (p *program) Start(s service.Service) error {
|
||||
|
||||
func (p *program) Stop(s service.Service) error {
|
||||
logger.Info("Nebula service stopping.")
|
||||
|
||||
if p.local != nil {
|
||||
p.local.Stop()
|
||||
}
|
||||
|
||||
if p.control == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
+22
-1
@@ -8,7 +8,9 @@ import (
|
||||
"strings"
|
||||
|
||||
"github.com/slackhq/nebula"
|
||||
"github.com/slackhq/nebula/cmd/internal/ctl"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/localapi"
|
||||
"github.com/slackhq/nebula/logging"
|
||||
"github.com/slackhq/nebula/util"
|
||||
)
|
||||
@@ -32,6 +34,11 @@ func init() {
|
||||
}
|
||||
|
||||
func main() {
|
||||
// commands are either `nebula ctl ...` or `nebula -<flag> ...`
|
||||
if code, done := ctl.Subcommand(os.Args); done {
|
||||
os.Exit(code)
|
||||
}
|
||||
|
||||
configPath := flag.String("config", "", "Path to either a file or directory to load configuration from")
|
||||
configTest := flag.Bool("test", false, "Test the config and print the end result. Non zero exit indicates a faulty config")
|
||||
printVersion := flag.Bool("version", false, "Print version")
|
||||
@@ -39,6 +46,12 @@ func main() {
|
||||
|
||||
flag.Parse()
|
||||
|
||||
// A word after the daemon's flags is `ctl` in the other place an operator puts it,
|
||||
// or a mistyped subcommand, and either way not a daemon to start; see Trailing.
|
||||
if code, done := ctl.Trailing(flag.Args(), *configPath); done {
|
||||
os.Exit(code)
|
||||
}
|
||||
|
||||
if *printVersion {
|
||||
fmt.Printf("Version: %s\n", Build)
|
||||
os.Exit(0)
|
||||
@@ -90,10 +103,18 @@ func main() {
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
local := localapi.Wire(ctrl.Context(), l, c, ctrl.Commands())
|
||||
|
||||
go ctrl.ShutdownBlock()
|
||||
notifyReady(l)
|
||||
|
||||
if err := ctrl.Wait(); err != nil {
|
||||
err := ctrl.Wait()
|
||||
|
||||
// os.Exit skips deferred calls, so the sockets are removed here, before either
|
||||
// exit below, rather than left to a deferred Stop that would never run.
|
||||
local.Stop()
|
||||
|
||||
if err != nil {
|
||||
l.Error("Nebula stopped due to fatal error", "error", err)
|
||||
os.Exit(2)
|
||||
}
|
||||
|
||||
+683
@@ -0,0 +1,683 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"log/slog"
|
||||
"maps"
|
||||
"net/netip"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/header"
|
||||
"github.com/slackhq/nebula/logging"
|
||||
)
|
||||
|
||||
// The commands nebula serves. attachCommands builds the one registry every surface
|
||||
// reads; the ssh debug server is a consumer of it, not its owner, which is why this
|
||||
// is not ssh.go. See the commands package for what a Command is.
|
||||
|
||||
type listHostMapFlags struct {
|
||||
ByIndex bool
|
||||
}
|
||||
|
||||
type printCertFlags struct {
|
||||
Raw bool
|
||||
|
||||
// Address is the -address form of the vpn addr, which the info API needs since a
|
||||
// query string has no operands; see identityFlags for why presence is recorded.
|
||||
Address string
|
||||
addressSet bool
|
||||
}
|
||||
|
||||
func (f *printCertFlags) setAddress(v string) error {
|
||||
f.Address = v
|
||||
f.addressSet = true
|
||||
return nil
|
||||
}
|
||||
|
||||
type changeRemoteFlags struct {
|
||||
Address string
|
||||
}
|
||||
|
||||
type closeTunnelFlags struct {
|
||||
LocalOnly bool
|
||||
}
|
||||
|
||||
type createTunnelFlags struct {
|
||||
Address string
|
||||
}
|
||||
|
||||
// lighthouseInfo is one entry of list-lighthouse-addrmap.
|
||||
type lighthouseInfo struct {
|
||||
VpnAddr string `json:"vpnAddr"`
|
||||
Addrs *CacheMap `json:"addrs"`
|
||||
}
|
||||
|
||||
// deviceInfo is the result of device-info.
|
||||
type deviceInfo struct {
|
||||
Name string `json:"name"`
|
||||
Cidr []netip.Prefix `json:"cidr"`
|
||||
}
|
||||
|
||||
// certPEM is the result of print-cert -raw. The PEM form is a different thing to emit,
|
||||
// not a different formatting of the certificate, so it is its own shape.
|
||||
type certPEM struct {
|
||||
PEM string `json:"pem"`
|
||||
}
|
||||
|
||||
// Result shapes for print-relays. Field names are the JSON keys; changing them would
|
||||
// change the output.
|
||||
type relayFor struct {
|
||||
Error string `json:",omitempty"`
|
||||
Type string
|
||||
State string
|
||||
PeerAddr netip.Addr
|
||||
LocalIndex uint32
|
||||
RemoteIndex uint32
|
||||
RelayedThrough []netip.Addr
|
||||
}
|
||||
|
||||
type relayOutput struct {
|
||||
NebulaAddr netip.Addr
|
||||
RelayForAddrs []relayFor
|
||||
}
|
||||
|
||||
type relaysOutput struct {
|
||||
Relays []*relayOutput
|
||||
}
|
||||
|
||||
type versionInfo struct {
|
||||
Version string `json:"version"`
|
||||
}
|
||||
|
||||
type logLevelInfo struct {
|
||||
Level string `json:"level"`
|
||||
}
|
||||
|
||||
type logFormatInfo struct {
|
||||
Format string `json:"format"`
|
||||
}
|
||||
|
||||
// defineListHostMapFlags declares the flags list-hostmap and list-pending-hostmap share.
|
||||
func defineListHostMapFlags(fl *flag.FlagSet, s *listHostMapFlags) {
|
||||
fl.BoolVar(&s.ByIndex, "by-index", false, "gets all hosts in the hostmap from the index table")
|
||||
}
|
||||
|
||||
func attachCommands(l *slog.Logger, c *config.C, reg *commands.Registry, f *Interface) {
|
||||
reg.Register(commands.Flagged(&commands.Command{
|
||||
Name: commands.ListHostmap,
|
||||
ShortDescription: "List all known previously connected hosts",
|
||||
Text: commands.Typed(textListHostMap),
|
||||
}, defineListHostMapFlags, func(s *listHostMapFlags, a []string) (commands.Result, error) {
|
||||
return runListHostMap(f.hostMap, s)
|
||||
}))
|
||||
|
||||
reg.Register(commands.Flagged(&commands.Command{
|
||||
Name: commands.ListPendingHostmap,
|
||||
ShortDescription: "List all handshaking hosts",
|
||||
Text: commands.Typed(textListHostMap),
|
||||
}, defineListHostMapFlags, func(s *listHostMapFlags, a []string) (commands.Result, error) {
|
||||
return runListHostMap(f.handshakeManager, s)
|
||||
}))
|
||||
|
||||
reg.Register(&commands.Command{
|
||||
Name: commands.ListLighthouseAddrmap,
|
||||
ShortDescription: "List all lighthouse map entries",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return runListLighthouseMap(f.lightHouse)
|
||||
},
|
||||
Text: commands.Typed(textListLighthouseMap),
|
||||
})
|
||||
|
||||
reg.Register(&commands.Command{
|
||||
Name: commands.Reload,
|
||||
ShortDescription: "Reloads configuration from disk, same as sending HUP to the process",
|
||||
// The line goes out before the reload: a reload that restarts the ssh server ends
|
||||
// the session that asked, and this is what it sees.
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return commands.Did("Reloading config"), nil
|
||||
},
|
||||
Then: func() commands.Result {
|
||||
return runReload(l, c)
|
||||
},
|
||||
})
|
||||
|
||||
reg.Register(&commands.Command{
|
||||
Name: commands.LogLevel,
|
||||
ShortDescription: "Gets or sets the current log level",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return runLogLevel(l, a)
|
||||
},
|
||||
Text: commands.Typed(textLogLevel),
|
||||
})
|
||||
|
||||
reg.Register(&commands.Command{
|
||||
Name: commands.LogFormat,
|
||||
ShortDescription: "Gets or sets the current log format",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return runLogFormat(l, a)
|
||||
},
|
||||
Text: commands.Typed(textLogFormat),
|
||||
})
|
||||
|
||||
reg.Register(&commands.Command{
|
||||
Name: commands.Version,
|
||||
ShortDescription: "Prints the currently running version of nebula",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return commands.Value(versionInfo{Version: f.version}), nil
|
||||
},
|
||||
Text: commands.Typed(textVersion),
|
||||
})
|
||||
|
||||
reg.Register(&commands.Command{
|
||||
Name: commands.DeviceInfo,
|
||||
ShortDescription: "Prints information about the network device.",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return commands.Value(runDeviceInfo(f)), nil
|
||||
},
|
||||
Text: commands.Typed(textDeviceInfo),
|
||||
})
|
||||
|
||||
reg.Register(commands.Flagged(&commands.Command{
|
||||
Name: commands.PrintCert,
|
||||
ShortDescription: "Prints the current certificate being used or the certificate for the provided vpn addr",
|
||||
Help: "The vpn addr is an operand or -address, which may carry a port so a connection's remote address can be passed through as is. For a peer it is the certificate nebula verified when the tunnel came up; with no address it is this node's own, the v2 certificate when both versions are loaded. -raw prints the PEM.",
|
||||
Identity: true,
|
||||
Text: textPrintCert,
|
||||
}, func(fl *flag.FlagSet, s *printCertFlags) {
|
||||
fl.BoolVar(&s.Raw, "raw", false, "prints the PEM encoded certificate; with -json, an object holding it")
|
||||
fl.Func("address", "The vpn addr to look up, optionally with a port", s.setAddress)
|
||||
}, func(s *printCertFlags, a []string) (commands.Result, error) {
|
||||
return runPrintCert(f, s, a)
|
||||
}))
|
||||
|
||||
reg.Register(commands.Flagged(&commands.Command{
|
||||
Name: commands.Identity,
|
||||
ShortDescription: "Prints the certificate identity of the host owning the provided vpn addr",
|
||||
Help: "Identity is what the certificate says: name, vpn addrs, networks, groups, fingerprint, issuer and validity. The address may carry a port, so a connection's remote address can be passed through as is. For this node's own identity use whoami.",
|
||||
Identity: true,
|
||||
Text: commands.Typed(textIdentity),
|
||||
}, func(fl *flag.FlagSet, s *identityFlags) {
|
||||
fl.Func("address", "The vpn addr to look up, optionally with a port", s.setAddress)
|
||||
}, func(s *identityFlags, a []string) (commands.Result, error) {
|
||||
return runIdentity(f, s, a)
|
||||
}))
|
||||
|
||||
reg.Register(&commands.Command{
|
||||
Name: commands.Whoami,
|
||||
ShortDescription: "Prints the certificate identity of this node",
|
||||
Help: "The fields identity prints, read from this node's own certificate.",
|
||||
Identity: true,
|
||||
Text: commands.Typed(textIdentity),
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
if len(a) > 0 {
|
||||
return commands.Failed("whoami takes no arguments"), nil
|
||||
}
|
||||
return runWhoami(f)
|
||||
},
|
||||
})
|
||||
|
||||
reg.Register(&commands.Command{
|
||||
Name: commands.PrintTunnel,
|
||||
ShortDescription: "Prints json details about a tunnel for the provided vpn addr",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return runPrintTunnel(f, a)
|
||||
},
|
||||
// No Text on purpose: nothing human readable exists yet, and shipping an interim
|
||||
// form would invite scripts against it. ssh defaults these to JSON; ctl asks.
|
||||
JSONOnly: true,
|
||||
})
|
||||
|
||||
reg.Register(&commands.Command{
|
||||
Name: commands.PrintRelays,
|
||||
ShortDescription: "Prints json details about all relay info",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return commands.Value(runPrintRelays(f)), nil
|
||||
},
|
||||
// No Text on purpose; see print-tunnel.
|
||||
JSONOnly: true,
|
||||
})
|
||||
|
||||
reg.Register(commands.Flagged(&commands.Command{
|
||||
Name: commands.ChangeRemote,
|
||||
ShortDescription: "Changes the remote address used in the tunnel for the provided vpn addr",
|
||||
}, func(fl *flag.FlagSet, s *changeRemoteFlags) {
|
||||
fl.StringVar(&s.Address, "address", "", "The new remote address, ip:port")
|
||||
}, func(s *changeRemoteFlags, a []string) (commands.Result, error) {
|
||||
return runChangeRemote(f, s, a)
|
||||
}))
|
||||
|
||||
reg.Register(commands.Flagged(&commands.Command{
|
||||
Name: commands.CloseTunnel,
|
||||
ShortDescription: "Closes a tunnel for the provided vpn addr",
|
||||
}, func(fl *flag.FlagSet, s *closeTunnelFlags) {
|
||||
fl.BoolVar(&s.LocalOnly, "local-only", false, "Disables notifying the remote that the tunnel is shutting down")
|
||||
}, func(s *closeTunnelFlags, a []string) (commands.Result, error) {
|
||||
return runCloseTunnel(f, s, a)
|
||||
}))
|
||||
|
||||
reg.Register(commands.Flagged(&commands.Command{
|
||||
Name: commands.CreateTunnel,
|
||||
ShortDescription: "Creates a tunnel for the provided vpn address",
|
||||
Help: "The lighthouses will be queried for real addresses but you can provide one as well.",
|
||||
}, func(fl *flag.FlagSet, s *createTunnelFlags) {
|
||||
fl.StringVar(&s.Address, "address", "", "Optionally provide a real remote address, ip:port ")
|
||||
}, func(s *createTunnelFlags, a []string) (commands.Result, error) {
|
||||
return runCreateTunnel(f, s, a)
|
||||
}))
|
||||
|
||||
reg.Register(&commands.Command{
|
||||
Name: commands.QueryLighthouse,
|
||||
ShortDescription: "Query the lighthouses for the provided vpn address",
|
||||
Help: "This command is asynchronous. Only currently known udp addresses will be printed.",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return runQueryLighthouse(f, a)
|
||||
},
|
||||
// No Text on purpose; see print-tunnel.
|
||||
JSONOnly: true,
|
||||
})
|
||||
}
|
||||
|
||||
// runListHostMap computes the hostmap listing. Presentation is Render's job.
|
||||
func runListHostMap(hl controlHostLister, fs *listHostMapFlags) (commands.Result, error) {
|
||||
var hm []ControlHostInfo
|
||||
if fs.ByIndex {
|
||||
hm = listHostMapIndexes(hl)
|
||||
} else {
|
||||
hm = listHostMapHosts(hl)
|
||||
}
|
||||
|
||||
sort.Slice(hm, func(i, j int) bool {
|
||||
return hm[i].VpnAddrs[0].Compare(hm[j].VpnAddrs[0]) < 0
|
||||
})
|
||||
|
||||
return commands.Value(hm), nil
|
||||
}
|
||||
|
||||
// textListHostMap is the human rendering, shared by every surface.
|
||||
func textListHostMap(hm []ControlHostInfo, w io.Writer) error {
|
||||
for _, h := range hm {
|
||||
if _, err := fmt.Fprintf(w, "%s: %s\n", h.VpnAddrs, h.RemoteAddrs); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func runListLighthouseMap(lightHouse *LightHouse) (commands.Result, error) {
|
||||
lightHouse.RLock()
|
||||
addrMap := make([]lighthouseInfo, len(lightHouse.addrMap))
|
||||
x := 0
|
||||
for k, v := range lightHouse.addrMap {
|
||||
addrMap[x] = lighthouseInfo{
|
||||
VpnAddr: k.String(),
|
||||
Addrs: v.CopyCache(),
|
||||
}
|
||||
x++
|
||||
}
|
||||
lightHouse.RUnlock()
|
||||
|
||||
sort.Slice(addrMap, func(i, j int) bool {
|
||||
return strings.Compare(addrMap[i].VpnAddr, addrMap[j].VpnAddr) < 0
|
||||
})
|
||||
|
||||
return commands.Value(addrMap), nil
|
||||
}
|
||||
|
||||
func textListLighthouseMap(addrMap []lighthouseInfo, w io.Writer) error {
|
||||
for _, e := range addrMap {
|
||||
b, err := json.Marshal(e.Addrs)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := fmt.Fprintf(w, "%s: %s\n", e.VpnAddr, string(b)); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func textVersion(vi versionInfo, w io.Writer) error {
|
||||
_, err := fmt.Fprintf(w, "%s\n", vi.Version)
|
||||
return err
|
||||
}
|
||||
|
||||
// vpnAddrOperand parses the vpn address a command takes as its first operand. noun is
|
||||
// how the command's messages name it, "vpn address" or "vpn addr", which the output
|
||||
// golden pins per command. With no operand, or one that does not parse, ok is false and
|
||||
// res is the refusal to return.
|
||||
func vpnAddrOperand(a []string, noun string) (vpnAddr netip.Addr, res commands.Result, ok bool) {
|
||||
if len(a) == 0 {
|
||||
return netip.Addr{}, commands.Failed("No vpn address was provided"), false
|
||||
}
|
||||
|
||||
vpnAddr, err := netip.ParseAddr(a[0])
|
||||
if err != nil {
|
||||
return netip.Addr{}, commands.Failed("The provided %s could not be parsed: %s", noun, a[0]), false
|
||||
}
|
||||
|
||||
return vpnAddr, commands.Result{}, true
|
||||
}
|
||||
|
||||
// tunnelOperand is vpnAddrOperand followed by the lookup of the tunnel it names.
|
||||
func tunnelOperand(ifce *Interface, a []string, noun string) (*HostInfo, commands.Result, bool) {
|
||||
vpnAddr, res, ok := vpnAddrOperand(a, noun)
|
||||
if !ok {
|
||||
return nil, res, false
|
||||
}
|
||||
|
||||
hostInfo := ifce.hostMap.QueryVpnAddr(vpnAddr)
|
||||
if hostInfo == nil {
|
||||
return nil, commands.Failed("Could not find tunnel for %s: %v", noun, a[0]), false
|
||||
}
|
||||
|
||||
return hostInfo, commands.Result{}, true
|
||||
}
|
||||
|
||||
func runQueryLighthouse(ifce *Interface, a []string) (commands.Result, error) {
|
||||
vpnAddr, res, ok := vpnAddrOperand(a, "vpn address")
|
||||
if !ok {
|
||||
return res, nil
|
||||
}
|
||||
|
||||
var cm *CacheMap
|
||||
rl := ifce.lightHouse.Query(vpnAddr)
|
||||
if rl != nil {
|
||||
cm = rl.CopyCache()
|
||||
}
|
||||
return commands.Value(cm), nil
|
||||
}
|
||||
|
||||
func runCloseTunnel(ifce *Interface, flags *closeTunnelFlags, a []string) (commands.Result, error) {
|
||||
hostInfo, res, ok := tunnelOperand(ifce, a, "vpn address")
|
||||
if !ok {
|
||||
return res, nil
|
||||
}
|
||||
|
||||
if !flags.LocalOnly {
|
||||
ifce.send(
|
||||
header.CloseTunnel,
|
||||
0,
|
||||
hostInfo.ConnectionState,
|
||||
hostInfo,
|
||||
[]byte{},
|
||||
make([]byte, 12, 12),
|
||||
make([]byte, mtu),
|
||||
)
|
||||
}
|
||||
|
||||
ifce.closeTunnel(hostInfo)
|
||||
return commands.Did("Closed"), nil
|
||||
}
|
||||
|
||||
func runCreateTunnel(ifce *Interface, flags *createTunnelFlags, a []string) (commands.Result, error) {
|
||||
|
||||
vpnAddr, res, ok := vpnAddrOperand(a, "vpn address")
|
||||
if !ok {
|
||||
return res, nil
|
||||
}
|
||||
|
||||
if hostInfo := ifce.hostMap.QueryVpnAddr(vpnAddr); hostInfo != nil {
|
||||
return commands.Failed("Tunnel already exists"), nil
|
||||
}
|
||||
|
||||
if hostInfo := ifce.handshakeManager.QueryVpnAddr(vpnAddr); hostInfo != nil {
|
||||
return commands.Failed("Tunnel already handshaking"), nil
|
||||
}
|
||||
|
||||
var addr netip.AddrPort
|
||||
if flags.Address != "" {
|
||||
var err error
|
||||
addr, err = netip.ParseAddrPort(flags.Address)
|
||||
if err != nil {
|
||||
return commands.Failed("Address could not be parsed"), nil
|
||||
}
|
||||
}
|
||||
|
||||
// Set the remote from the callback, which StartHandshake runs under the handshake manager lock
|
||||
// before the hostinfo reaches the handshake loop or the static-host trigger, so the address is
|
||||
// in the RemoteList before the first handshake is sent.
|
||||
ifce.handshakeManager.StartHandshake(vpnAddr, func(hh *HandshakeHostInfo) {
|
||||
if addr.IsValid() {
|
||||
hh.hostinfo.SetRemote(addr)
|
||||
}
|
||||
})
|
||||
|
||||
return commands.Did("Created"), nil
|
||||
}
|
||||
|
||||
func runChangeRemote(ifce *Interface, flags *changeRemoteFlags, a []string) (commands.Result, error) {
|
||||
|
||||
if len(a) == 0 {
|
||||
return commands.Failed("No vpn address was provided"), nil
|
||||
}
|
||||
|
||||
if flags.Address == "" {
|
||||
return commands.Failed("No address was provided"), nil
|
||||
}
|
||||
|
||||
addr, err := netip.ParseAddrPort(flags.Address)
|
||||
if err != nil {
|
||||
return commands.Failed("Address could not be parsed"), nil
|
||||
}
|
||||
|
||||
hostInfo, res, ok := tunnelOperand(ifce, a, "vpn address")
|
||||
if !ok {
|
||||
return res, nil
|
||||
}
|
||||
|
||||
hostInfo.SetRemote(addr)
|
||||
return commands.Did("Changed"), nil
|
||||
}
|
||||
|
||||
func runLogLevel(l *slog.Logger, a []string) (commands.Result, error) {
|
||||
ctrl, ok := l.Handler().(interface {
|
||||
GetLevel() slog.Level
|
||||
SetLevel(slog.Level)
|
||||
})
|
||||
if !ok {
|
||||
return commands.Failed("Log level is not reconfigurable on this logger"), nil
|
||||
}
|
||||
|
||||
if len(a) > 0 {
|
||||
level, err := logging.ParseLevel(strings.ToLower(a[0]))
|
||||
if err != nil {
|
||||
return commands.Failed("Unknown log level %s. Possible log levels: trace, debug, info, warn, error", a), nil
|
||||
}
|
||||
|
||||
ctrl.SetLevel(level)
|
||||
}
|
||||
|
||||
return commands.Value(logLevelInfo{Level: logging.LevelName(ctrl.GetLevel())}), nil
|
||||
}
|
||||
|
||||
func textLogLevel(li logLevelInfo, w io.Writer) error {
|
||||
_, err := fmt.Fprintf(w, "Log level is: %s\n", li.Level)
|
||||
return err
|
||||
}
|
||||
|
||||
func runLogFormat(l *slog.Logger, a []string) (commands.Result, error) {
|
||||
ctrl, ok := l.Handler().(interface {
|
||||
GetFormat() string
|
||||
SetFormat(string) error
|
||||
})
|
||||
if !ok {
|
||||
return commands.Failed("Log format is not reconfigurable on this logger"), nil
|
||||
}
|
||||
|
||||
if len(a) > 0 {
|
||||
if err := ctrl.SetFormat(strings.ToLower(a[0])); err != nil {
|
||||
return commands.Failed("Unable to set log format: %s", err), nil
|
||||
}
|
||||
}
|
||||
|
||||
return commands.Value(logFormatInfo{Format: ctrl.GetFormat()}), nil
|
||||
}
|
||||
|
||||
func textLogFormat(fi logFormatInfo, w io.Writer) error {
|
||||
_, err := fmt.Fprintf(w, "Log format is: %s\n", fi.Format)
|
||||
return err
|
||||
}
|
||||
|
||||
// runPrintCert prints a certificate: this node's own, or the one the host owning a vpn
|
||||
// addr presented. The addr is an operand, as it always was over ssh, or -address, which
|
||||
// is how the info API names it, and an address of our own answers with our own
|
||||
// certificate as identity does. A tunnel still handshaking, or one being torn down, has
|
||||
// no certificate and is reported as not found.
|
||||
func runPrintCert(ifce *Interface, args *printCertFlags, a []string) (commands.Result, error) {
|
||||
if len(a) > 0 && args.addressSet {
|
||||
return commands.Failed("print-cert takes one vpn addr, as -address or as an operand, not both"), nil
|
||||
}
|
||||
|
||||
cs := ifce.pki.getCertState()
|
||||
var c cert.Certificate
|
||||
switch {
|
||||
case len(a) > 0:
|
||||
vpnAddr, res, ok := vpnAddrOperand(a, "vpn addr")
|
||||
if !ok {
|
||||
return res, nil
|
||||
}
|
||||
if c, _ = findCertificateForVpnAddr(cs, ifce.hostMap, vpnAddr); c == nil {
|
||||
return commands.NotFound("Could not find tunnel for vpn addr: %v", a[0]), nil
|
||||
}
|
||||
case args.addressSet:
|
||||
vpnAddr, err := parseVpnAddrWithOptionalPort(args.Address)
|
||||
if err != nil {
|
||||
return commands.Failed("The provided vpn addr could not be parsed: %s", args.Address), nil
|
||||
}
|
||||
if c, _ = findCertificateForVpnAddr(cs, ifce.hostMap, vpnAddr); c == nil {
|
||||
return commands.NotFound("Could not find tunnel for vpn addr: %v", args.Address), nil
|
||||
}
|
||||
default:
|
||||
if c = ownCertificate(cs); c == nil {
|
||||
return commands.Failed("No certificate is loaded"), nil
|
||||
}
|
||||
}
|
||||
|
||||
if args.Raw {
|
||||
b, err := c.MarshalPEM()
|
||||
if err != nil {
|
||||
return commands.Failed("Unable to marshal the certificate: %s", err), nil
|
||||
}
|
||||
return commands.Value(certPEM{PEM: string(b)}), nil
|
||||
}
|
||||
|
||||
return commands.Value(c), nil
|
||||
}
|
||||
|
||||
// textPrintCert takes the value untyped: print-cert returns a certificate or, with -raw,
|
||||
// its PEM, and those are two things to emit rather than two renderings of one.
|
||||
func textPrintCert(v any, w io.Writer) error {
|
||||
switch c := v.(type) {
|
||||
case certPEM:
|
||||
_, err := io.WriteString(w, c.PEM)
|
||||
return err
|
||||
case cert.Certificate:
|
||||
_, err := io.WriteString(w, c.String()+"\n")
|
||||
return err
|
||||
default:
|
||||
return fmt.Errorf("expected a certificate, got %T", v)
|
||||
}
|
||||
}
|
||||
|
||||
func runPrintRelays(ifce *Interface) any {
|
||||
ifce.hostMap.RLock()
|
||||
relays := maps.Clone(ifce.hostMap.Relays)
|
||||
ifce.hostMap.RUnlock()
|
||||
|
||||
co := relaysOutput{}
|
||||
|
||||
for k, v := range relays {
|
||||
ro := relayOutput{NebulaAddr: v.vpnAddrs[0]}
|
||||
co.Relays = append(co.Relays, &ro)
|
||||
relayHI := ifce.hostMap.QueryVpnAddr(v.vpnAddrs[0])
|
||||
if relayHI == nil {
|
||||
ro.RelayForAddrs = append(ro.RelayForAddrs, relayFor{Error: "could not find hostinfo"})
|
||||
continue
|
||||
}
|
||||
for _, vpnAddr := range relayHI.relayState.CopyRelayForIps() {
|
||||
rf := relayFor{}
|
||||
r, ok := relayHI.relayState.GetRelayForByAddr(vpnAddr)
|
||||
if ok {
|
||||
t := ""
|
||||
switch r.Type {
|
||||
case ForwardingType:
|
||||
t = "forwarding"
|
||||
case TerminalType:
|
||||
t = "terminal"
|
||||
default:
|
||||
t = "unknown"
|
||||
}
|
||||
|
||||
st := ""
|
||||
switch r.State {
|
||||
case Requested:
|
||||
st = "requested"
|
||||
case Established:
|
||||
st = "established"
|
||||
default:
|
||||
st = "unknown"
|
||||
}
|
||||
|
||||
rf.LocalIndex = r.LocalIndex
|
||||
rf.RemoteIndex = r.RemoteIndex
|
||||
rf.PeerAddr = r.PeerAddr
|
||||
rf.Type = t
|
||||
rf.State = st
|
||||
if rf.LocalIndex != k {
|
||||
rf.Error = fmt.Sprintf("hostmap LocalIndex '%v' does not match RelayState LocalIndex", k)
|
||||
}
|
||||
}
|
||||
relayedHI := ifce.hostMap.QueryVpnAddr(vpnAddr)
|
||||
if relayedHI != nil {
|
||||
rf.RelayedThrough = append(rf.RelayedThrough, relayedHI.relayState.CopyRelayIps()...)
|
||||
}
|
||||
|
||||
ro.RelayForAddrs = append(ro.RelayForAddrs, rf)
|
||||
}
|
||||
}
|
||||
|
||||
return co
|
||||
}
|
||||
|
||||
func runPrintTunnel(ifce *Interface, a []string) (commands.Result, error) {
|
||||
hostInfo, res, ok := tunnelOperand(ifce, a, "vpn addr")
|
||||
if !ok {
|
||||
return res, nil
|
||||
}
|
||||
|
||||
return commands.Value(copyHostInfo(hostInfo, ifce.hostMap.GetPreferredRanges())), nil
|
||||
}
|
||||
|
||||
func runDeviceInfo(ifce *Interface) deviceInfo {
|
||||
d := deviceInfo{
|
||||
Name: ifce.inside.Name(),
|
||||
Cidr: make([]netip.Prefix, len(ifce.inside.Networks())),
|
||||
}
|
||||
copy(d.Cidr, ifce.inside.Networks())
|
||||
return d
|
||||
}
|
||||
|
||||
func textDeviceInfo(d deviceInfo, w io.Writer) error {
|
||||
_, err := fmt.Fprintf(w, "name=%v cidr=%v\n", d.Name, d.Cidr)
|
||||
return err
|
||||
}
|
||||
|
||||
// runReload reloads the config and reports how it went. A reload that failed is a
|
||||
// refusal, exit 1 over ssh; one that merely needs a restart is not.
|
||||
func runReload(l *slog.Logger, c *config.C) commands.Result {
|
||||
res := c.ReloadConfig()
|
||||
res.Log(l)
|
||||
if res.Err != nil || res.Failed {
|
||||
return commands.Failed("%s", res.String())
|
||||
}
|
||||
return commands.Did("%s", res.String())
|
||||
}
|
||||
@@ -0,0 +1,303 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// CommandFlags is called before help or command execution to parse command line flags.
|
||||
// It should return a flag.FlagSet instance and a pointer to the struct that will contain parsed flags
|
||||
//
|
||||
// Every call must build a fresh FlagSet and a fresh struct. Nothing may be shared between
|
||||
// calls: a command runs on more than one surface and on more than one goroutine.
|
||||
type CommandFlags func() (*flag.FlagSet, any)
|
||||
|
||||
// RunFunc computes a command's Result.
|
||||
//
|
||||
// fs is the pointer returned by Command.Flags, if there was one; -h, -help, -json and
|
||||
// -pretty are reserved and handled before Run is called. a is the operands: whatever
|
||||
// was not consumed as a flag. The Result is rendered by whichever surface asked: Value
|
||||
// for a command that reports, Did or Failed for one that acts, Nothing for one with
|
||||
// nothing to say. An error is for a failure of the command itself; a bad argument is
|
||||
// Failed, so the caller hears why in its own format.
|
||||
type RunFunc func(fs any, a []string) (Result, error)
|
||||
|
||||
// TextFunc renders a Result's Value for a person. See Typed for declaring one against
|
||||
// the type the command actually returns.
|
||||
type TextFunc func(v any, w io.Writer) error
|
||||
|
||||
type Command struct {
|
||||
Name Name
|
||||
ShortDescription string
|
||||
Help string
|
||||
|
||||
// Identity indicates this command should be made available via the info socket.
|
||||
Identity bool
|
||||
|
||||
Flags CommandFlags
|
||||
|
||||
// Run produces the command's Result, leaving presentation to Render.
|
||||
Run RunFunc
|
||||
|
||||
// Text renders a Result's Value for a person. Both surfaces call it, so a command
|
||||
// reads the same over ssh as it does through the control socket. It never sees an
|
||||
// outcome: Render prints those itself, the same way for every command. Leaving it
|
||||
// nil declares that no human rendering of the Value exists yet, which JSONOnly says
|
||||
// up front; Render then refuses text rather than inventing an interim form for
|
||||
// people to script against.
|
||||
Text TextFunc
|
||||
|
||||
// JSONOnly declares that the command's Value has no human rendering yet, so a surface
|
||||
// whose default is text asks for JSON instead, and the schema says so to a client. It
|
||||
// is a statement that no such form exists, not a fallback. A refusal is still
|
||||
// rendered as a sentence, since that always has a human form.
|
||||
JSONOnly bool
|
||||
|
||||
// Then, when set, is the second half of a command that acts: Run says what is about
|
||||
// to happen and Then does it and says how it went, with its Result rendered after
|
||||
// Run's and deciding the outcome. A Run that refused is the outcome, and Then does
|
||||
// not run. It exists for a command whose action can cut off
|
||||
// its own reply: reload restarts the ssh server when the sshd keys changed, which
|
||||
// ends the session that asked, so Run's line has to be on the wire before the reload
|
||||
// begins. A surface that answers in one piece, the control socket, runs Then before
|
||||
// it answers and carries both.
|
||||
Then func() Result
|
||||
}
|
||||
|
||||
// Failure is the error a surface gets for a refusal the person has already been shown:
|
||||
// a Run that returned Failed, a command that is not there, a line that would not parse.
|
||||
// The message it rendered is the whole story, so the surface reports the failure, exit
|
||||
// status 1 over ssh, and does not log it.
|
||||
type Failure struct {
|
||||
Msg string
|
||||
}
|
||||
|
||||
func (f *Failure) Error() string {
|
||||
return f.Msg
|
||||
}
|
||||
|
||||
// commandFlags returns the FlagSet a command is driven through, on any surface: the
|
||||
// command's own flags, if it declares any, with the two presentation flags added. own
|
||||
// reports whether the command declared any of its own, which is what tells a caller
|
||||
// whether to say a parameter is unknown or that the command takes none at all.
|
||||
//
|
||||
// The presentation flags are defined here rather than by each command, because how a
|
||||
// result is displayed is not a property of the command that produced it. This is also
|
||||
// the one definition of them: the ssh line parses into it, nebula ctl parses its line
|
||||
// against the schema derived from it, and help renders from that schema. They are
|
||||
// command line flags only: a socket request chooses its rendering with the envelope's
|
||||
// format field, and Invoke refuses them as parameters.
|
||||
func commandFlags(c *Command) (fl *flag.FlagSet, fs any, own bool) {
|
||||
if c.Flags != nil {
|
||||
fl, fs = c.Flags()
|
||||
}
|
||||
own = fl != nil
|
||||
if fl == nil {
|
||||
fl = flag.NewFlagSet(string(c.Name), flag.ContinueOnError)
|
||||
}
|
||||
|
||||
addPresentationFlags(fl)
|
||||
|
||||
// What Parse prints after a bad flag, and for -h: the command's usage as help renders
|
||||
// it, so a line that went wrong is answered with the same text as `help <command>`.
|
||||
fl.Usage = func() { _ = WriteCommandHelp(schemaOf(c, fl), fl.Output()) }
|
||||
|
||||
return fl, fs, own
|
||||
}
|
||||
|
||||
// addPresentationFlags defines the two presentation flags on fl.
|
||||
func addPresentationFlags(fl *flag.FlagSet) {
|
||||
fl.Bool(FlagJSON, false, "outputs as json")
|
||||
fl.Bool(FlagPretty, false, "pretty prints json, assumes -json")
|
||||
}
|
||||
|
||||
// Flagged fills in c's Flags and Run as a pair: define declares the flags on a fresh F,
|
||||
// and run is handed that F. The struct the flags fill is the struct Run reads by
|
||||
// construction, so no Run has to assert the type it was given or decide what to do
|
||||
// when the assertion fails.
|
||||
func Flagged[F any](c *Command, define func(*flag.FlagSet, *F), run func(*F, []string) (Result, error)) *Command {
|
||||
c.Flags = func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := new(F)
|
||||
define(fl, s)
|
||||
return fl, s
|
||||
}
|
||||
c.Run = func(fs any, a []string) (Result, error) {
|
||||
s, ok := fs.(*F)
|
||||
if !ok {
|
||||
return Result{}, fmt.Errorf("%s was handed %T for its flags, not %T", c.Name, fs, s)
|
||||
}
|
||||
return run(s, a)
|
||||
}
|
||||
return c
|
||||
}
|
||||
|
||||
// isPresentationFlag reports whether name is one of the two flags commandFlags adds.
|
||||
func isPresentationFlag(name string) bool {
|
||||
return name == FlagJSON || name == FlagPretty
|
||||
}
|
||||
|
||||
// execLine runs an ssh command line against c, reporting problems to w. The line is
|
||||
// parsed into the command's own FlagSet and Run reads it directly, so a flag.Value whose
|
||||
// String does not re-parse, flag.Func above all, arrives as the line said. Invoke fills
|
||||
// the same FlagSet through Set.
|
||||
func (r *Registry) execLine(c *Command, args []string, w Output) error {
|
||||
fl, fs, _ := commandFlags(c)
|
||||
|
||||
// Parse reports a bad flag to this writer, with the command's usage after it. -h,
|
||||
// -help and --help take the same path with nothing wrong: the usage is the whole
|
||||
// answer, and Parse says so with ErrHelp. A -h that is a flag's value or follows --
|
||||
// is read as the operand it is, since ParseArgs is the one reading of the line.
|
||||
fl.SetOutput(w.Err)
|
||||
operands, err := ParseArgs(fl, args)
|
||||
if err != nil {
|
||||
if errors.Is(err, flag.ErrHelp) {
|
||||
return nil
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
format := presentationFormat(fl)
|
||||
|
||||
// An error from Run is something the command could not do rather than a refusal it
|
||||
// chose, but the person at the prompt still hears it; the surface logs it too.
|
||||
res, err := c.Run(fs, operands)
|
||||
if err != nil {
|
||||
_, _ = fmt.Fprintln(w.Err, err.Error())
|
||||
return err
|
||||
}
|
||||
|
||||
// Run's reply goes out first, and then the action, if the command has one and Run
|
||||
// did not refuse, whose Result is the outcome. In JSON only the outcome travels:
|
||||
// the promise is for a person to read, and a program expects one document.
|
||||
if c.Then == nil || !res.OK || r.formatFor(c, res, format) == FormatText {
|
||||
if err := r.renderLine(c, res, format, w); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
if c.Then != nil && res.OK {
|
||||
res = c.Then()
|
||||
if err := r.renderLine(c, res, format, w); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if !res.OK {
|
||||
return &Failure{Msg: res.Reason}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// formatFor is the format a Result is rendered in. The line wins when it asked for one;
|
||||
// otherwise the surface that owns the registry decides, from the command and its
|
||||
// Result, so each surface can keep its own default.
|
||||
func (r *Registry) formatFor(c *Command, res Result, format Format) Format {
|
||||
if format == FormatUnset {
|
||||
return r.defaultFormatFor(c, res)
|
||||
}
|
||||
return format
|
||||
}
|
||||
|
||||
// renderLine writes one Result of a command line to w; see formatFor. An empty Result
|
||||
// writes nothing.
|
||||
func (r *Registry) renderLine(c *Command, res Result, format Format, w Output) error {
|
||||
if res.Empty() {
|
||||
return nil
|
||||
}
|
||||
|
||||
if err := Render(c, res, r.formatFor(c, res, format), w.Out); err != nil {
|
||||
if errors.Is(err, ErrNoTextRendering) {
|
||||
_, _ = fmt.Fprintln(w.Err, err.Error())
|
||||
}
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// ParseArgs parses args with fl and returns the operands.
|
||||
//
|
||||
// It differs from fl.Parse in two ways, and both surfaces parse through here so a line
|
||||
// means the same typed at an ssh prompt or to nebula ctl.
|
||||
//
|
||||
// Flags and operands may come in any order, which is the one way it differs from
|
||||
// fl.Parse. Parse stops at the first operand, so `print-tunnel 10.0.0.1 -json` would
|
||||
// reach the command with "-json" as a second operand and the flag silently dropped. Here
|
||||
// an operand ends nothing: parsing resumes after it, and only "--" ends the flags, with
|
||||
// everything after it an operand. What counts as a flag is Parse's rule: every argument
|
||||
// that starts with "-", a negative number included, so one that is meant as an operand
|
||||
// goes after "--".
|
||||
func ParseArgs(fl *flag.FlagSet, args []string) ([]string, error) {
|
||||
operands := make([]string, 0, len(args))
|
||||
|
||||
for len(args) > 0 {
|
||||
// Walk the flags the way Parse will, to the first argument it would not read as a
|
||||
// flag: an operand or the terminator. Everything before it is Parse's.
|
||||
end := len(args)
|
||||
for i := 0; i < len(args); {
|
||||
a := args[i]
|
||||
if a == "--" {
|
||||
if err := fl.Parse(args[:i]); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return append(operands, args[i+1:]...), nil
|
||||
}
|
||||
|
||||
if len(a) < 2 || a[0] != '-' {
|
||||
end = i
|
||||
break
|
||||
}
|
||||
|
||||
f, hasValue := LookupArg(fl, a)
|
||||
if f == nil {
|
||||
// An undefined flag: leave it for Parse to report.
|
||||
i++
|
||||
continue
|
||||
}
|
||||
|
||||
if hasValue || IsBoolFlag(f) {
|
||||
i++
|
||||
} else {
|
||||
// The flag's value is the next argument, whatever it looks like.
|
||||
i += 2
|
||||
}
|
||||
}
|
||||
|
||||
if err := fl.Parse(args[:end]); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if end == len(args) {
|
||||
break
|
||||
}
|
||||
|
||||
operands = append(operands, args[end])
|
||||
args = args[end+1:]
|
||||
}
|
||||
|
||||
return operands, nil
|
||||
}
|
||||
|
||||
// LookupArg reads arg the way Parse does: one or two leading dashes, the flag's name, and
|
||||
// an optional "=value". f is the flag of fl by that name, nil when fl has none, and
|
||||
// hasValue reports that the value came with the argument rather than in the one after it.
|
||||
// It is the one reading of an argument's shape: ParseArgs walks a line with it, and
|
||||
// nebula ctl lifts its own flags out of a line with it, so the two cannot disagree about
|
||||
// which word is a flag's value.
|
||||
func LookupArg(fl *flag.FlagSet, arg string) (f *flag.Flag, hasValue bool) {
|
||||
name := strings.TrimPrefix(strings.TrimPrefix(arg, "-"), "-")
|
||||
if eq := strings.IndexByte(name, '='); eq >= 0 {
|
||||
name, hasValue = name[:eq], true
|
||||
}
|
||||
return fl.Lookup(name), hasValue
|
||||
}
|
||||
|
||||
// IsBoolFlag reports whether f is satisfied by its presence alone and never reads the
|
||||
// argument after it as its value. The flag package marks these with an unexported
|
||||
// interface, which is the only way to tell.
|
||||
func IsBoolFlag(f *flag.Flag) bool {
|
||||
bf, ok := f.Value.(interface{ IsBoolFlag() bool })
|
||||
return ok && bf.IsBoolFlag()
|
||||
}
|
||||
@@ -0,0 +1,101 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"flag"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// TestParseArgsAllowsFlagsAfterOperands pins the one way ParseArgs departs from fl.Parse,
|
||||
// that a flag may follow an operand, and that it departs in no other: a negative number
|
||||
// is a flag, as Parse reads it, and goes after "--" when it is meant as an operand.
|
||||
func TestParseArgsAllowsFlagsAfterOperands(t *testing.T) {
|
||||
cases := map[string]struct {
|
||||
args []string
|
||||
wantOps []string
|
||||
wantN string
|
||||
wantV bool
|
||||
wantJSON bool
|
||||
wantErr string
|
||||
}{
|
||||
"flag after operand": {args: []string{"x", "-json"}, wantOps: []string{"x"}, wantJSON: true},
|
||||
"flags around": {args: []string{"-v", "x", "-n", "1", "y"}, wantOps: []string{"x", "y"}, wantV: true, wantN: "1"},
|
||||
"value after operand": {args: []string{"x", "-n", "-1"}, wantOps: []string{"x"}, wantN: "-1"},
|
||||
"equals value": {args: []string{"-n=-1", "x"}, wantOps: []string{"x"}, wantN: "-1"},
|
||||
"terminator after": {args: []string{"x", "--", "-json", "-1"}, wantOps: []string{"x", "-json", "-1"}},
|
||||
"terminator": {args: []string{"--", "-json"}, wantOps: []string{"-json"}},
|
||||
"defined numeric": {args: []string{"-2", "x"}, wantOps: []string{"x"}, wantV: true},
|
||||
"negative number": {args: []string{"-1"}, wantErr: "flag provided but not defined: -1"},
|
||||
"bad flag after": {args: []string{"x", "-nope"}, wantErr: "flag provided but not defined: -nope"},
|
||||
"undefined flag": {args: []string{"-nope", "x"}, wantErr: "flag provided but not defined: -nope"},
|
||||
"missing value": {args: []string{"-n"}, wantErr: "flag needs an argument: -n"},
|
||||
}
|
||||
|
||||
for name, tc := range cases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
fl := flag.NewFlagSet("t", flag.ContinueOnError)
|
||||
fl.SetOutput(&bytes.Buffer{})
|
||||
n := fl.String("n", "", "")
|
||||
v := fl.Bool("v", false, "")
|
||||
two := fl.Bool("2", false, "a flag that happens to be a number")
|
||||
asJSON := fl.Bool(FlagJSON, false, "")
|
||||
|
||||
ops, err := ParseArgs(fl, tc.args)
|
||||
if tc.wantErr != "" {
|
||||
require.ErrorContains(t, err, tc.wantErr)
|
||||
return
|
||||
}
|
||||
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, tc.wantOps, ops)
|
||||
assert.Equal(t, tc.wantN, *n)
|
||||
assert.Equal(t, tc.wantV, *v || *two)
|
||||
assert.Equal(t, tc.wantJSON, *asJSON)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestDispatchFlagAfterOperand: the same through a registered command with no Flags of
|
||||
// its own, which only has the presentation flags to find.
|
||||
func TestDispatchFlagAfterOperand(t *testing.T) {
|
||||
out := &bytes.Buffer{}
|
||||
require.NoError(t, testRegistry().DispatchArgs([]string{"served", "x", "-json"}, MergedOutput(out)))
|
||||
assert.Equal(t, "\"read x\"\n", out.String())
|
||||
}
|
||||
|
||||
// TestLookupArg pins the reading of an argument's shape that ParseArgs and nebula ctl
|
||||
// share.
|
||||
func TestLookupArg(t *testing.T) {
|
||||
fl := flag.NewFlagSet("t", flag.ContinueOnError)
|
||||
fl.String("n", "", "")
|
||||
fl.Bool("v", false, "")
|
||||
|
||||
for _, tc := range []struct {
|
||||
arg string
|
||||
name string
|
||||
hasValue bool
|
||||
}{
|
||||
{"-n", "n", false},
|
||||
{"--n", "n", false},
|
||||
{"-n=1", "n", true},
|
||||
{"--n=", "n", true},
|
||||
{"-v", "v", false},
|
||||
{"-nope", "", false},
|
||||
{"-1", "", false},
|
||||
} {
|
||||
f, hasValue := LookupArg(fl, tc.arg)
|
||||
if tc.name == "" {
|
||||
assert.Nil(t, f, tc.arg)
|
||||
} else {
|
||||
require.NotNil(t, f, tc.arg)
|
||||
assert.Equal(t, tc.name, f.Name, tc.arg)
|
||||
}
|
||||
assert.Equal(t, tc.hasValue, hasValue, tc.arg)
|
||||
}
|
||||
|
||||
assert.True(t, IsBoolFlag(fl.Lookup("v")))
|
||||
assert.False(t, IsBoolFlag(fl.Lookup("n")))
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
package commands
|
||||
|
||||
// Name identifies a command. Every command nebula serves is a constant here, so a
|
||||
// surface, a client and a test spell it the same way and are told at compile time when
|
||||
// they do not. It is a string rather than an integer so a test can register a throwaway
|
||||
// command without adding it here, and so the wire carries the name as the string it has
|
||||
// always been.
|
||||
type Name string
|
||||
|
||||
const (
|
||||
ChangeRemote Name = "change-remote"
|
||||
CloseTunnel Name = "close-tunnel"
|
||||
CreateTunnel Name = "create-tunnel"
|
||||
DeviceInfo Name = "device-info"
|
||||
Help Name = "help"
|
||||
Identity Name = "identity"
|
||||
ListHostmap Name = "list-hostmap"
|
||||
ListLighthouseAddrmap Name = "list-lighthouse-addrmap"
|
||||
ListPendingHostmap Name = "list-pending-hostmap"
|
||||
LogFormat Name = "log-format"
|
||||
LogLevel Name = "log-level"
|
||||
Logout Name = "logout"
|
||||
PrintCert Name = "print-cert"
|
||||
PrintRelays Name = "print-relays"
|
||||
PrintTunnel Name = "print-tunnel"
|
||||
QueryLighthouse Name = "query-lighthouse"
|
||||
Reload Name = "reload"
|
||||
Version Name = "version"
|
||||
Whoami Name = "whoami"
|
||||
)
|
||||
@@ -0,0 +1,456 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"cmp"
|
||||
"errors"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"maps"
|
||||
"slices"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"github.com/anmitsu/go-shlex"
|
||||
)
|
||||
|
||||
// Registry holds a set of commands.
|
||||
//
|
||||
// It is safe for concurrent use: the ssh server clones it per session and the control
|
||||
// socket serves it as it is, while the daemon fills it once at startup.
|
||||
type Registry struct {
|
||||
mu sync.RWMutex
|
||||
commands map[Name]*Command
|
||||
|
||||
// full is set on a filtered registry and points at the registry it was filtered
|
||||
// from, so a command that's filtered can be reported as such.
|
||||
full *Registry
|
||||
|
||||
// reason explains, in the terms an operator cares about, why this registry withholds
|
||||
// a command they can name. It is supplied by whoever built the filter, because why a
|
||||
// surface declines a command is that surface's business, not the registry's.
|
||||
reason string
|
||||
|
||||
// DefaultFormat decides how a result is rendered when the command line named no
|
||||
// format. It sees the command and its Result, and applies to values and refusals
|
||||
// alike: the registry does not special-case either. The renderer is shared between
|
||||
// surfaces; what each asks for by default is not, so the surface that owns this
|
||||
// registry sets it. Nil means text.
|
||||
DefaultFormat func(c *Command, r Result) Format
|
||||
}
|
||||
|
||||
// defaultFormatFor resolves the surface's default for c's Result.
|
||||
func (r *Registry) defaultFormatFor(c *Command, res Result) Format {
|
||||
if r.DefaultFormat == nil {
|
||||
return FormatText
|
||||
}
|
||||
return r.DefaultFormat(c, res)
|
||||
}
|
||||
|
||||
// New returns an empty Registry with only `help` available.
|
||||
func New() *Registry {
|
||||
r := &Registry{commands: map[Name]*Command{}}
|
||||
r.registerHelp()
|
||||
return r
|
||||
}
|
||||
|
||||
func (r *Registry) registerHelp() {
|
||||
r.Register(&Command{
|
||||
Name: Help,
|
||||
ShortDescription: "prints available commands or help <command> for specific usage info",
|
||||
Run: func(a any, args []string) (Result, error) {
|
||||
if len(args) == 0 {
|
||||
return Value(r.Schema()), nil
|
||||
}
|
||||
|
||||
c, err := r.Resolve(Name(args[0]))
|
||||
if err != nil {
|
||||
var withheld *WithheldError
|
||||
if errors.As(err, &withheld) {
|
||||
return Failed("%s", err), nil
|
||||
}
|
||||
return Failed("Command not available %s", args[0]), nil
|
||||
}
|
||||
|
||||
return Value(r.SchemaFor(c)), nil
|
||||
},
|
||||
Text: renderHelp,
|
||||
})
|
||||
}
|
||||
|
||||
// renderHelp is help's human rendering: the command list, or one command's usage.
|
||||
func renderHelp(v any, w io.Writer) error {
|
||||
switch h := v.(type) {
|
||||
case []CommandSchema:
|
||||
return writeCommandList(h, w)
|
||||
case CommandSchema:
|
||||
return WriteCommandHelp(h, w)
|
||||
default:
|
||||
return fmt.Errorf("expected a command schema, got %T", v)
|
||||
}
|
||||
}
|
||||
|
||||
func writeCommandList(cmds []CommandSchema, w io.Writer) error {
|
||||
if _, err := io.WriteString(w, "Available commands:\n"); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// In the order the schema came, which is the display order; see Registry.All.
|
||||
lines := make([]string, 0, len(cmds))
|
||||
for _, c := range cmds {
|
||||
lines = append(lines, fmt.Sprintf("%s - %s", c.Name, c.Short))
|
||||
}
|
||||
|
||||
_, err := io.WriteString(w, strings.Join(lines, "\n")+"\n\n")
|
||||
return err
|
||||
}
|
||||
|
||||
// WriteCommandHelp renders one command's usage. It is the single rendering of a
|
||||
// CommandSchema for a person: the daemon uses it for `help <command>` on both surfaces,
|
||||
// and a client that already holds the schema uses it for `-h`, so the two cannot drift.
|
||||
func WriteCommandHelp(c CommandSchema, w io.Writer) error {
|
||||
if _, err := fmt.Fprintf(w, "%s - %s\n", c.Name, c.Short); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if c.Help != "" {
|
||||
if _, err := fmt.Fprintf(w, " %s\n", c.Help); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
// Same layout as flag.PrintDefaults, including its habit of leaving out a default
|
||||
// that is the zero value.
|
||||
for _, f := range c.Flags {
|
||||
kind := ""
|
||||
if !f.Bool {
|
||||
kind = " string"
|
||||
}
|
||||
def := ""
|
||||
if f.Default != "" && f.Default != "false" {
|
||||
def = fmt.Sprintf(" (default %s)", f.Default)
|
||||
}
|
||||
if _, err := fmt.Fprintf(w, " -%s%s\n \t%s%s\n", f.Name, kind, f.Usage, def); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Register adds a command that can be run by a user.
|
||||
//
|
||||
// It panics if the command declares a reserved flag. That is a programming error, and
|
||||
// surfacing it here, at startup, is better than at the moment an operator first types
|
||||
// the command.
|
||||
func (r *Registry) Register(c *Command) {
|
||||
if c.Run == nil {
|
||||
panic(fmt.Sprintf("commands: %s has no Run", c.Name))
|
||||
}
|
||||
|
||||
if c.Flags != nil {
|
||||
if fl, _ := c.Flags(); fl != nil {
|
||||
for _, name := range reservedFlags {
|
||||
if fl.Lookup(name) != nil {
|
||||
panic(fmt.Sprintf("commands: %s declares reserved flag -%s", c.Name, name))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
r.insert(c)
|
||||
}
|
||||
|
||||
// insert adds c without the reserved flag check, for commands that have already passed
|
||||
// it on another registry.
|
||||
func (r *Registry) insert(c *Command) {
|
||||
r.mu.Lock()
|
||||
defer r.mu.Unlock()
|
||||
r.commands[c.Name] = c
|
||||
}
|
||||
|
||||
// Get returns the command registered under name, or nil if there is no such command.
|
||||
func (r *Registry) Get(name Name) *Command {
|
||||
r.mu.RLock()
|
||||
defer r.mu.RUnlock()
|
||||
return r.commands[name]
|
||||
}
|
||||
|
||||
// Match returns the names of every command starting with prefix, sorted, as strings for
|
||||
// a prompt to complete and print.
|
||||
func (r *Registry) Match(prefix string) []string {
|
||||
cmds := make([]string, 0)
|
||||
r.mu.RLock()
|
||||
for n := range r.commands {
|
||||
if strings.HasPrefix(string(n), prefix) {
|
||||
cmds = append(cmds, string(n))
|
||||
}
|
||||
}
|
||||
r.mu.RUnlock()
|
||||
slices.Sort(cmds)
|
||||
return cmds
|
||||
}
|
||||
|
||||
// All returns every registered command sorted by name, which is the order help lists
|
||||
// them and the schema describes them.
|
||||
func (r *Registry) All() []*Command {
|
||||
r.mu.RLock()
|
||||
defer r.mu.RUnlock()
|
||||
|
||||
cmds := slices.Collect(maps.Values(r.commands))
|
||||
slices.SortFunc(cmds, func(a, b *Command) int { return cmp.Compare(a.Name, b.Name) })
|
||||
return cmds
|
||||
}
|
||||
|
||||
// Clone returns a copy holding the same commands.
|
||||
//
|
||||
// help is re-registered on the copy rather than carried over, because the source's help
|
||||
// is bound to the source and would list its commands, not the copy's, once a caller
|
||||
// registers something on the copy.
|
||||
func (r *Registry) Clone() *Registry {
|
||||
r.mu.RLock()
|
||||
out := &Registry{
|
||||
commands: maps.Clone(r.commands),
|
||||
full: r.full,
|
||||
reason: r.reason,
|
||||
DefaultFormat: r.DefaultFormat,
|
||||
}
|
||||
r.mu.RUnlock()
|
||||
|
||||
out.registerHelp()
|
||||
return out
|
||||
}
|
||||
|
||||
// Filter returns a filtered copy of the registry.
|
||||
//
|
||||
// Keep should return true for commands that should be included in the copy. reason
|
||||
// says, to an operator who names a command the copy left out, why this surface does
|
||||
// not serve it; "" leaves the registry to say only that it does not.
|
||||
func (r *Registry) Filter(keep func(*Command) bool, reason string) *Registry {
|
||||
out := &Registry{commands: map[Name]*Command{}, full: r, reason: reason, DefaultFormat: r.DefaultFormat}
|
||||
|
||||
for _, cmd := range r.All() {
|
||||
if keep(cmd) {
|
||||
out.insert(cmd)
|
||||
}
|
||||
}
|
||||
|
||||
// Bind help to the filtered set so it only advertises what this surface serves.
|
||||
out.registerHelp()
|
||||
return out
|
||||
}
|
||||
|
||||
// Dispatch parses a command line and runs it, reporting problems to w. The error is for
|
||||
// the caller to log, not to show; see RunFunc and Failure.
|
||||
func (r *Registry) Dispatch(line string, w Output) error {
|
||||
// A line shlex cannot split, an unbalanced quote. Reported on Err so the output
|
||||
// stream stays parseable.
|
||||
args, err := shlex.Split(line, true)
|
||||
if err != nil {
|
||||
msg := "could not parse the command line: " + err.Error()
|
||||
if _, err := fmt.Fprintln(w.Err, msg); err != nil {
|
||||
return err
|
||||
}
|
||||
return &Failure{Msg: msg}
|
||||
}
|
||||
|
||||
return r.DispatchArgs(args, w)
|
||||
}
|
||||
|
||||
// DispatchArgs runs an already tokenized command line. The error is as for Dispatch.
|
||||
//
|
||||
// An empty line and an unknown command both end up running `help`, the first with the
|
||||
// arguments help itself would take; `<command> -h` is answered by the command's own
|
||||
// FlagSet, with the same rendering, in execLine.
|
||||
func (r *Registry) DispatchArgs(args []string, w Output) error {
|
||||
if len(args) == 0 {
|
||||
args = []string{"help"}
|
||||
}
|
||||
|
||||
c, err := r.Resolve(Name(args[0]))
|
||||
if err != nil {
|
||||
var withheld *WithheldError
|
||||
if errors.As(err, &withheld) {
|
||||
// Saying why, rather than "did not understand", keeps the rule legible and
|
||||
// points at a surface that will actually run the command.
|
||||
_, _ = fmt.Fprintln(w.Err, err)
|
||||
return err
|
||||
}
|
||||
|
||||
// Only the first word was looked up, so only it is named.
|
||||
msg := fmt.Sprintf("did not understand: %s", args[0])
|
||||
if _, err := fmt.Fprintln(w.Out, msg); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := r.DispatchArgs([]string{"help"}, w); err != nil {
|
||||
return err
|
||||
}
|
||||
return &Failure{Msg: msg}
|
||||
}
|
||||
|
||||
return r.execLine(c, args[1:], w)
|
||||
}
|
||||
|
||||
// unavailable explains why name cannot be run here when this registry was filtered from
|
||||
// one that holds it: the command exists, and this surface withholds it, for the reason
|
||||
// whoever built the filter gave. It is nil when name is simply unknown, so the two cases
|
||||
// read differently to an operator.
|
||||
func (r *Registry) unavailable(name Name) error {
|
||||
if r.full == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
c := r.full.Get(name)
|
||||
if c == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
reason := r.reason
|
||||
if reason == "" {
|
||||
reason = "this surface does not serve it"
|
||||
}
|
||||
|
||||
return &WithheldError{msg: fmt.Sprintf("%s is not available on this surface: %s", c.Name, reason)}
|
||||
}
|
||||
|
||||
// WithheldError indicates that the command is supported by Nebula, but not via this path.
|
||||
type WithheldError struct {
|
||||
msg string
|
||||
}
|
||||
|
||||
func (e *WithheldError) Error() string { return e.msg }
|
||||
|
||||
// Resolve returns the command registered under name, or says why there is none: a
|
||||
// WithheldError with the filter's reason, or unknown for a name that does not exist.
|
||||
func (r *Registry) Resolve(name Name) (*Command, error) {
|
||||
if c := r.Get(name); c != nil {
|
||||
return c, nil
|
||||
}
|
||||
|
||||
if err := r.unavailable(name); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return nil, fmt.Errorf("unknown command %q", name)
|
||||
}
|
||||
|
||||
// ParamError is what Invoke returns for a parameter the command would not take: one it
|
||||
// does not have, or a value its flag would not parse. It is the caller's mistake rather
|
||||
// than the command's failure, and a surface with status codes tells the two apart by
|
||||
// it; every other error from Invoke came out of Run.
|
||||
type ParamError struct {
|
||||
msg string
|
||||
}
|
||||
|
||||
func (e *ParamError) Error() string { return e.msg }
|
||||
|
||||
func paramErrorf(format string, args ...any) error {
|
||||
return &ParamError{msg: fmt.Sprintf(format, args...)}
|
||||
}
|
||||
|
||||
// setParams sets each named parameter on fl, in the order of names, and stops at the
|
||||
// first that is unknown or does not parse. own says whether the command declared flags
|
||||
// of its own, which decides between "takes no parameters" and "has no parameter".
|
||||
//
|
||||
// The presentation flags are on fl, since commandFlags put them there, but they are not
|
||||
// parameters: a request has one place to choose its rendering, the envelope's format
|
||||
// field, and a client that sends them here is told where that is rather than having a
|
||||
// second, weaker way to say the same thing.
|
||||
func setParams(fl *flag.FlagSet, name string, names []string, params map[string]string, own bool) error {
|
||||
for _, k := range names {
|
||||
if isPresentationFlag(k) {
|
||||
return paramErrorf("%s is a command line flag, not a parameter; choose the rendering with the request's format field", k)
|
||||
}
|
||||
|
||||
f := fl.Lookup(k)
|
||||
if f == nil {
|
||||
if !own {
|
||||
return paramErrorf("%s takes no parameters", name)
|
||||
}
|
||||
return paramErrorf("%s has no parameter %q", name, k)
|
||||
}
|
||||
|
||||
if err := setFlag(fl, f, params[k]); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// setFlag applies one value to f, reporting a refusal as a ParamError in words that
|
||||
// name the value: the flag package's own words for a bad boolean are "parse error".
|
||||
func setFlag(fl *flag.FlagSet, f *flag.Flag, v string) error {
|
||||
if err := fl.Set(f.Name, v); err != nil {
|
||||
if IsBoolFlag(f) {
|
||||
return paramErrorf("%s: expected a boolean, got %q", f.Name, v)
|
||||
}
|
||||
return paramErrorf("%s: %v", f.Name, err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Schema describes every command in the registry, so a client can offer them without
|
||||
// having been built against this daemon.
|
||||
func (r *Registry) Schema() []CommandSchema {
|
||||
all := r.All()
|
||||
out := make([]CommandSchema, 0, len(all))
|
||||
for _, c := range all {
|
||||
out = append(out, r.SchemaFor(c))
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
// SchemaFor describes one command. It is the one derivation, for the whole schema and
|
||||
// for `help <command>` alike.
|
||||
func (r *Registry) SchemaFor(c *Command) CommandSchema {
|
||||
fl, _, _ := commandFlags(c)
|
||||
return schemaOf(c, fl)
|
||||
}
|
||||
|
||||
// schemaOf describes c as driven through fl, the FlagSet commandFlags built for it. The
|
||||
// presentation flags are included because a command line client parses its line
|
||||
// against this and help renders from it; they are listed after the command's own,
|
||||
// which is where readers expect them. Invoke refuses them as parameters.
|
||||
func schemaOf(c *Command, fl *flag.FlagSet) CommandSchema {
|
||||
cs := CommandSchema{Name: c.Name, Short: c.ShortDescription, Help: c.Help}
|
||||
|
||||
var own, shared []FlagSchema
|
||||
fl.VisitAll(func(f *flag.Flag) {
|
||||
fs := FlagSchema{
|
||||
Name: f.Name,
|
||||
Bool: IsBoolFlag(f),
|
||||
Default: f.DefValue,
|
||||
Usage: f.Usage,
|
||||
}
|
||||
if isPresentationFlag(f.Name) {
|
||||
shared = append(shared, fs)
|
||||
return
|
||||
}
|
||||
own = append(own, fs)
|
||||
})
|
||||
cs.Flags = append(own, shared...)
|
||||
|
||||
return cs
|
||||
}
|
||||
|
||||
// CommandSchema describes one command well enough for a client to offer it.
|
||||
type CommandSchema struct {
|
||||
Name Name `json:"name"`
|
||||
Short string `json:"short,omitempty"`
|
||||
Help string `json:"help,omitempty"`
|
||||
Flags []FlagSchema `json:"flags,omitempty"`
|
||||
}
|
||||
|
||||
// FlagSchema describes one of a command's named parameters.
|
||||
type FlagSchema struct {
|
||||
Name string `json:"name"`
|
||||
|
||||
// Bool reports a parameter that takes no value, which is what tells a command line
|
||||
// client whether `-pretty` swallows the word after it.
|
||||
Bool bool `json:"bool,omitempty"`
|
||||
|
||||
Default string `json:"default,omitempty"`
|
||||
Usage string `json:"usage,omitempty"`
|
||||
}
|
||||
@@ -0,0 +1,481 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"errors"
|
||||
"flag"
|
||||
"io"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// notWithheld is a stand in for a surface's own policy, which the registry knows nothing
|
||||
// of; see Command.Identity for the one the info API applies.
|
||||
func notWithheld(c *Command) bool { return c.Name != "withheld" }
|
||||
|
||||
const testReason = "this surface does not run commands that write"
|
||||
|
||||
// textLine is a Text renderer for test commands whose result is one string.
|
||||
func textLine(v any, w io.Writer) error {
|
||||
_, err := io.WriteString(w, v.(string)+"\n")
|
||||
return err
|
||||
}
|
||||
|
||||
func testRegistry() *Registry {
|
||||
r := New()
|
||||
r.Register(&Command{
|
||||
Name: "served",
|
||||
ShortDescription: "a command this surface serves",
|
||||
Run: func(fs any, a []string) (Result, error) {
|
||||
return Value("read " + strings.Join(a, ",")), nil
|
||||
},
|
||||
Text: textLine,
|
||||
})
|
||||
r.Register(&Command{
|
||||
Name: "withheld",
|
||||
ShortDescription: "a command this surface withholds",
|
||||
Run: func(fs any, a []string) (Result, error) {
|
||||
return Value("wrote"), nil
|
||||
},
|
||||
Text: textLine,
|
||||
})
|
||||
return r
|
||||
}
|
||||
|
||||
// TestFilterKeepsWhatKeepSays: the copy holds the commands keep accepted, and help.
|
||||
func TestFilterKeepsWhatKeepSays(t *testing.T) {
|
||||
ro := testRegistry().Filter(notWithheld, testReason)
|
||||
|
||||
names := make([]string, 0)
|
||||
for _, c := range ro.All() {
|
||||
names = append(names, string(c.Name))
|
||||
}
|
||||
|
||||
assert.ElementsMatch(t, []string{"help", "served"}, names)
|
||||
}
|
||||
|
||||
// TestRefusesWithheldByName covers a client that knows a command exists and asks for it
|
||||
// anyway. The filter lives on the serving side, so the answer must not depend on what
|
||||
// the client was told was available.
|
||||
func TestRefusesWithheldByName(t *testing.T) {
|
||||
out, errOut := &bytes.Buffer{}, &bytes.Buffer{}
|
||||
w := Output{Out: out, Err: errOut}
|
||||
|
||||
err := testRegistry().Filter(notWithheld, testReason).DispatchArgs([]string{"withheld"}, w)
|
||||
|
||||
require.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "withheld is not available on this surface")
|
||||
assert.Empty(t, out.String(), "a withheld command must produce no output")
|
||||
assert.Contains(t, errOut.String(), "withheld is not available on this surface")
|
||||
assert.Contains(t, errOut.String(), testReason,
|
||||
"the registry should render the explanation the filter supplied, not one of its own")
|
||||
}
|
||||
|
||||
// TestWithheldIsNotReportedAsUnknown keeps the two cases distinct: an operator who
|
||||
// mistypes and one who asked for a real command should not get the same answer.
|
||||
func TestWithheldIsNotReportedAsUnknown(t *testing.T) {
|
||||
out, errOut := &bytes.Buffer{}, &bytes.Buffer{}
|
||||
err := testRegistry().Filter(notWithheld, testReason).DispatchArgs([]string{"no-such-command"}, Output{Out: out, Err: errOut})
|
||||
|
||||
var f *Failure
|
||||
require.ErrorAs(t, err, &f, "an unknown command is a failure to the surface")
|
||||
assert.Contains(t, out.String(), "did not understand: no-such-command")
|
||||
}
|
||||
|
||||
// TestResolveTellsUnknownFromWithheld: the two cases read differently to an operator,
|
||||
// and a surface with status codes tells them apart by the error's type, never by asking
|
||||
// the unfiltered registry, which is the one thing a filtered surface must not consult.
|
||||
func TestResolveTellsUnknownFromWithheld(t *testing.T) {
|
||||
r := testRegistry().Filter(notWithheld, testReason)
|
||||
|
||||
c, err := r.Resolve("served")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, Name("served"), c.Name)
|
||||
|
||||
_, err = r.Resolve("withheld")
|
||||
var withheld *WithheldError
|
||||
require.ErrorAs(t, err, &withheld)
|
||||
require.ErrorContains(t, err, "withheld is not available on this surface")
|
||||
require.ErrorContains(t, err, testReason)
|
||||
|
||||
_, err = r.Resolve("no-such-command")
|
||||
require.ErrorContains(t, err, `unknown command "no-such-command"`)
|
||||
assert.NotErrorAs(t, err, &withheld, "an unknown name is not a withheld one")
|
||||
}
|
||||
|
||||
// paramRegistry holds one command with a bool flag and a duration flag, and reports what
|
||||
// the command saw when it ran.
|
||||
func paramRegistry(t *testing.T) (*Registry, *[]paramsSeen) {
|
||||
t.Helper()
|
||||
|
||||
var seen []paramsSeen
|
||||
r := New()
|
||||
r.Register(&Command{
|
||||
Name: "set",
|
||||
ShortDescription: "sets things",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := paramsSeen{}
|
||||
fl.BoolVar(&s.Verbose, "verbose", false, "say more")
|
||||
fl.DurationVar(&s.Wait, "wait", 0, "how long")
|
||||
return fl, &s
|
||||
},
|
||||
Run: func(fs any, a []string) (Result, error) {
|
||||
seen = append(seen, *fs.(*paramsSeen))
|
||||
return Value("ok"), nil
|
||||
},
|
||||
})
|
||||
|
||||
return r, &seen
|
||||
}
|
||||
|
||||
type paramsSeen struct {
|
||||
Verbose bool
|
||||
Wait time.Duration
|
||||
}
|
||||
|
||||
// TestInvokeReportsParametersInNameOrder: parameters arrive as an unordered object, so
|
||||
// with two bad ones the error must not depend on map iteration. Name order decides.
|
||||
func TestInvokeReportsParametersInNameOrder(t *testing.T) {
|
||||
r, _ := paramRegistry(t)
|
||||
|
||||
cases := map[string]struct {
|
||||
params map[string]string
|
||||
want string
|
||||
}{
|
||||
"two unknown": {map[string]string{"zed": "1", "alpha": "1"}, `set has no parameter "alpha"`},
|
||||
"unknown before bad bool": {map[string]string{"aaa": "1", "verbose": "maybe"}, `set has no parameter "aaa"`},
|
||||
"bad bool before unknown": {map[string]string{"verbose": "maybe", "zzz": "1"}, `verbose: expected a boolean, got "maybe"`},
|
||||
"bad value before bad bool": {map[string]string{"wait": "soon", "verbose": "maybe"}, `verbose: expected a boolean`},
|
||||
}
|
||||
|
||||
for name, tc := range cases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
// Enough runs that a map-order dependence would show.
|
||||
for i := 0; i < 50; i++ {
|
||||
_, err := Invoke(Request{Command: r.Get("set"), Params: tc.params})
|
||||
require.Error(t, err)
|
||||
assert.ErrorContains(t, err, tc.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestInvokeWithABadParameterSetsNothing: a request with any bad parameter must not run
|
||||
// the command, and must leave nothing behind for the next request to see. The good
|
||||
// parameter sorts before the bad one, so a one-pass Invoke would have applied it.
|
||||
func TestInvokeWithABadParameterSetsNothing(t *testing.T) {
|
||||
r, seen := paramRegistry(t)
|
||||
|
||||
_, err := Invoke(Request{Command: r.Get("set"), Params: map[string]string{"verbose": "true", "wait": "soon"}})
|
||||
require.ErrorContains(t, err, "wait:")
|
||||
assert.Empty(t, *seen, "the command must not run with a partial parameter set")
|
||||
|
||||
v, err := Invoke(Request{Command: r.Get("set")})
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "ok", v.Value)
|
||||
require.Len(t, *seen, 1)
|
||||
assert.Equal(t, paramsSeen{}, (*seen)[0], "nothing from the failed request carried over")
|
||||
|
||||
_, err = Invoke(Request{Command: r.Get("set"), Params: map[string]string{"verbose": "true", "wait": "2s"}})
|
||||
require.NoError(t, err)
|
||||
require.Len(t, *seen, 2)
|
||||
assert.Equal(t, paramsSeen{Verbose: true, Wait: 2 * time.Second}, (*seen)[1])
|
||||
}
|
||||
|
||||
func TestHelpListsOnlyServedCommands(t *testing.T) {
|
||||
out := &bytes.Buffer{}
|
||||
require.NoError(t, testRegistry().Filter(notWithheld, testReason).DispatchArgs(nil, MergedOutput(out)))
|
||||
|
||||
assert.Contains(t, out.String(), "served")
|
||||
assert.NotContains(t, out.String(), "withheld")
|
||||
}
|
||||
|
||||
// TestDispatchReportsUnparseableLine pins that a line shlex rejects says so on Err rather
|
||||
// than coming back silent, so an operator with an unbalanced quote learns the quote is the
|
||||
// problem instead of assuming the command is broken.
|
||||
func TestDispatchReportsUnparseableLine(t *testing.T) {
|
||||
out, errOut := &bytes.Buffer{}, &bytes.Buffer{}
|
||||
testRegistry().Dispatch(`served "unterminated`, Output{Out: out, Err: errOut})
|
||||
assert.Empty(t, out.String())
|
||||
assert.Contains(t, errOut.String(), "could not parse the command line")
|
||||
}
|
||||
|
||||
// TestRegisterRejectsReservedFlags: a command that declares a reserved flag is refused
|
||||
// at Register rather than when an operator first runs it; see reservedFlags.
|
||||
func TestRegisterRejectsReservedFlags(t *testing.T) {
|
||||
for _, name := range []string{"json", "pretty", "h", "help", "config", "socket"} {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
r := New()
|
||||
assert.PanicsWithValue(t, "commands: clash declares reserved flag -"+name, func() {
|
||||
r.Register(&Command{
|
||||
Name: "clash",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("clash", flag.ContinueOnError)
|
||||
fl.Bool(name, false, "")
|
||||
return fl, nil
|
||||
},
|
||||
Run: func(fs any, a []string) (Result, error) { return Nothing(), nil },
|
||||
})
|
||||
})
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestRegistryIsSafeForConcurrentUse runs the operations the surfaces perform, filtering
|
||||
// and cloning per request or session, against a stream of registrations. It exists to
|
||||
// be run under the race detector: the map underneath is not goroutine safe.
|
||||
func TestRegistryIsSafeForConcurrentUse(t *testing.T) {
|
||||
r := testRegistry()
|
||||
|
||||
var wg sync.WaitGroup
|
||||
for i := 0; i < 8; i++ {
|
||||
wg.Add(1)
|
||||
go func(i int) {
|
||||
defer wg.Done()
|
||||
for j := 0; j < 50; j++ {
|
||||
r.Register(&Command{
|
||||
Name: Name("late-" + strings.Repeat("a", i) + "-" + strings.Repeat("b", j)),
|
||||
ShortDescription: "registered after the surfaces started",
|
||||
Run: func(fs any, a []string) (Result, error) { return Nothing(), nil },
|
||||
})
|
||||
}
|
||||
}(i)
|
||||
}
|
||||
|
||||
for i := 0; i < 8; i++ {
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
for j := 0; j < 50; j++ {
|
||||
f := r.Filter(notWithheld, testReason)
|
||||
_ = f.Get("served")
|
||||
_ = f.Schema()
|
||||
_ = r.Clone().Match("late-")
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
wg.Wait()
|
||||
|
||||
f := r.Filter(notWithheld, testReason)
|
||||
assert.Len(t, f.Match("late-"), 8*50, "every late registration is visible once the writers finish")
|
||||
}
|
||||
|
||||
// TestCloneHelpSeesCloneCommands: the ssh session registers logout on its clone, and
|
||||
// the source does not learn of it. Help on the clone answers for the clone, and -h on a
|
||||
// command prints what `help <name>` does, on a clone as on the source: both render
|
||||
// through WriteCommandHelp, and Clone rebinds help to the copy.
|
||||
func TestCloneHelpSeesCloneCommands(t *testing.T) {
|
||||
r := testRegistry()
|
||||
c := r.Clone()
|
||||
c.Register(&Command{
|
||||
Name: Logout,
|
||||
ShortDescription: "ends the session",
|
||||
Run: func(fs any, a []string) (Result, error) { return Nothing(), nil },
|
||||
})
|
||||
assert.Nil(t, r.Get(Logout), "the source is not affected")
|
||||
|
||||
out := &bytes.Buffer{}
|
||||
require.NoError(t, c.DispatchArgs([]string{"help"}, MergedOutput(out)))
|
||||
assert.Contains(t, out.String(), "logout")
|
||||
|
||||
for _, name := range []string{"logout", "served"} {
|
||||
flag := &bytes.Buffer{}
|
||||
c.Dispatch(name+" -h", MergedOutput(flag))
|
||||
cmd := &bytes.Buffer{}
|
||||
c.Dispatch("help "+name, MergedOutput(cmd))
|
||||
assert.Equal(t, cmd.String(), flag.String(), name)
|
||||
assert.Contains(t, flag.String(), name+" - ", name)
|
||||
}
|
||||
}
|
||||
|
||||
// TestThenRunsAfterTheReply pins the order Then exists for: Run's line is on the writer
|
||||
// before the action begins, Then's Result follows it, and Then's outcome is the
|
||||
// command's.
|
||||
func TestThenRunsAfterTheReply(t *testing.T) {
|
||||
out := &bytes.Buffer{}
|
||||
seen := "never ran"
|
||||
outcome := Did("acted")
|
||||
|
||||
r := New()
|
||||
r.Register(&Command{
|
||||
Name: "act",
|
||||
ShortDescription: "replies, then acts",
|
||||
Run: func(fs any, a []string) (Result, error) {
|
||||
return Did("about to act"), nil
|
||||
},
|
||||
Then: func() Result {
|
||||
seen = out.String()
|
||||
return outcome
|
||||
},
|
||||
})
|
||||
|
||||
require.NoError(t, r.DispatchArgs([]string{"act"}, MergedOutput(out)))
|
||||
assert.Equal(t, "about to act\n", seen, "the line was written before the action")
|
||||
assert.Equal(t, "about to act\nacted\n", out.String())
|
||||
|
||||
out.Reset()
|
||||
outcome = Failed("could not act")
|
||||
var f *Failure
|
||||
require.ErrorAs(t, r.DispatchArgs([]string{"act"}, MergedOutput(out)), &f)
|
||||
assert.Equal(t, "about to act\ncould not act\n", out.String())
|
||||
|
||||
// In JSON only the outcome travels: one document for the program that asked.
|
||||
out.Reset()
|
||||
require.ErrorAs(t, r.DispatchArgs([]string{"act", "-json"}, MergedOutput(out)), &f)
|
||||
assert.JSONEq(t, `{"ok":false,"reason":"could not act"}`, out.String())
|
||||
|
||||
// A Run that refused is the outcome; the action does not happen.
|
||||
ran := false
|
||||
r.Register(&Command{
|
||||
Name: "refuse",
|
||||
ShortDescription: "refuses, so never acts",
|
||||
Run: func(fs any, a []string) (Result, error) {
|
||||
return Failed("not like that"), nil
|
||||
},
|
||||
Then: func() Result {
|
||||
ran = true
|
||||
return Did("acted anyway")
|
||||
},
|
||||
})
|
||||
out.Reset()
|
||||
require.ErrorAs(t, r.DispatchArgs([]string{"refuse"}, MergedOutput(out)), &f)
|
||||
assert.Equal(t, "not like that\n", out.String())
|
||||
assert.False(t, ran)
|
||||
out.Reset()
|
||||
require.ErrorAs(t, r.DispatchArgs([]string{"refuse", "-json"}, MergedOutput(out)), &f)
|
||||
assert.JSONEq(t, `{"ok":false,"reason":"not like that"}`, out.String())
|
||||
assert.False(t, ran)
|
||||
}
|
||||
|
||||
// TestWriteCommandHelpIsTheOneRendering pins the layout both `help <command>` on the
|
||||
// daemon and `-h` in the client print, so the two cannot drift apart again.
|
||||
func TestWriteCommandHelpIsTheOneRendering(t *testing.T) {
|
||||
cs := CommandSchema{
|
||||
Name: "change-remote",
|
||||
Short: "changes a remote",
|
||||
Help: "Give it an address.",
|
||||
Flags: []FlagSchema{
|
||||
{Name: "address", Usage: "the new remote", Default: "1.2.3.4:4242"},
|
||||
{Name: "by-index", Bool: true, Usage: "match by index"},
|
||||
{Name: "json", Bool: true, Usage: "outputs as json"},
|
||||
},
|
||||
}
|
||||
|
||||
out := &bytes.Buffer{}
|
||||
require.NoError(t, WriteCommandHelp(cs, out))
|
||||
|
||||
assert.Equal(t, "change-remote - changes a remote\n"+
|
||||
" Give it an address.\n"+
|
||||
" -address string\n \tthe new remote (default 1.2.3.4:4242)\n"+
|
||||
" -by-index\n \tmatch by index\n"+
|
||||
" -json\n \toutputs as json\n", out.String())
|
||||
}
|
||||
|
||||
// addrFlags is the flag struct of a test command that takes -address.
|
||||
type addrFlags struct{ Address string }
|
||||
|
||||
// TestHelpFlagIsReadWhereParseReadsIt: -h asks for help only where the line's parser
|
||||
// reads it as a flag. As a flag's value or after -- it reaches the command as the
|
||||
// operand it is, and help is rendered by the same function `help <command>` uses.
|
||||
func TestHelpFlagIsReadWhereParseReadsIt(t *testing.T) {
|
||||
var seen []string
|
||||
r := New()
|
||||
r.Register(Flagged(&Command{Name: "x", ShortDescription: "takes an address"},
|
||||
func(fl *flag.FlagSet, s *addrFlags) { fl.StringVar(&s.Address, "address", "", "an address") },
|
||||
func(s *addrFlags, a []string) (Result, error) {
|
||||
seen = append(seen, s.Address+"|"+strings.Join(a, ","))
|
||||
return Nothing(), nil
|
||||
}))
|
||||
|
||||
for _, line := range []string{"x -h", "x -help", "x --help", "x 10.0.0.1 -h", "x -address=1 -h"} {
|
||||
out := &bytes.Buffer{}
|
||||
r.Dispatch(line, MergedOutput(out))
|
||||
assert.Contains(t, out.String(), "x - takes an address\n", line)
|
||||
assert.Contains(t, out.String(), "-address string", line)
|
||||
}
|
||||
assert.Empty(t, seen, "asking for help must not run the command")
|
||||
|
||||
for _, line := range []string{"x -address -h", "x -- -h"} {
|
||||
out := &bytes.Buffer{}
|
||||
r.Dispatch(line, MergedOutput(out))
|
||||
assert.Empty(t, out.String(), line)
|
||||
}
|
||||
assert.Equal(t, []string{"-h|", "|-h"}, seen)
|
||||
}
|
||||
|
||||
// TestBadFlagIsAnsweredWithTheCommandsHelp: a flag the command does not have is reported
|
||||
// on the error stream followed by the command's usage, in the rendering help uses.
|
||||
func TestBadFlagIsAnsweredWithTheCommandsHelp(t *testing.T) {
|
||||
out, errOut := &bytes.Buffer{}, &bytes.Buffer{}
|
||||
r := New()
|
||||
r.Register(&Command{Name: "x", ShortDescription: "has no flags", Run: func(fs any, a []string) (Result, error) { return Nothing(), nil }})
|
||||
|
||||
require.Error(t, r.DispatchArgs([]string{"x", "-nope"}, Output{Out: out, Err: errOut}))
|
||||
assert.Empty(t, out.String())
|
||||
assert.Equal(t, "flag provided but not defined: -nope\nx - has no flags\n -json\n \toutputs as json\n -pretty\n \tpretty prints json, assumes -json\n", errOut.String())
|
||||
}
|
||||
|
||||
// TestParameterMistakesAreParamErrors: a surface with status codes needs to tell a
|
||||
// parameter the caller got wrong from a command that failed, and Invoke says which by
|
||||
// the error's type rather than its words.
|
||||
func TestParameterMistakesAreParamErrors(t *testing.T) {
|
||||
r := New()
|
||||
r.Register(&Command{
|
||||
Name: "flagged",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := struct{ N int }{}
|
||||
fl.IntVar(&s.N, "n", 0, "")
|
||||
return fl, &s
|
||||
},
|
||||
Run: func(fs any, a []string) (Result, error) { return Result{}, errors.New("ran and failed") },
|
||||
})
|
||||
r.Register(&Command{
|
||||
Name: "bare",
|
||||
Run: func(fs any, a []string) (Result, error) { return Nothing(), nil },
|
||||
})
|
||||
|
||||
var pe *ParamError
|
||||
for _, tc := range []struct {
|
||||
name string
|
||||
params map[string]string
|
||||
}{
|
||||
{"flagged", map[string]string{"nope": "1"}},
|
||||
{"flagged", map[string]string{"n": "x"}},
|
||||
{"flagged", map[string]string{FlagJSON: "true"}},
|
||||
{"bare", map[string]string{"n": "1"}},
|
||||
} {
|
||||
_, err := Invoke(Request{Command: r.Get(Name(tc.name)), Params: tc.params})
|
||||
require.Error(t, err, "%s %v", tc.name, tc.params)
|
||||
require.ErrorAs(t, err, &pe, "%s %v: %v", tc.name, tc.params, err)
|
||||
}
|
||||
|
||||
_, err := Invoke(Request{Command: r.Get("flagged"), Params: map[string]string{"n": "1"}})
|
||||
require.EqualError(t, err, "ran and failed")
|
||||
assert.NotErrorAs(t, err, &pe, "a Run error is the command's, not the caller's")
|
||||
}
|
||||
|
||||
// TestRunErrorIsShown: an error Run returns reaches the person at the prompt on the
|
||||
// error stream, as well as the surface that logs it.
|
||||
func TestRunErrorIsShown(t *testing.T) {
|
||||
r := New()
|
||||
r.Register(&Command{
|
||||
Name: "broken",
|
||||
ShortDescription: "cannot do what it is asked",
|
||||
Run: func(fs any, a []string) (Result, error) {
|
||||
return Result{}, errors.New("no certificate is loaded")
|
||||
},
|
||||
})
|
||||
|
||||
out, errOut := &bytes.Buffer{}, &bytes.Buffer{}
|
||||
require.EqualError(t, r.DispatchArgs([]string{"broken"}, Output{Out: out, Err: errOut}), "no certificate is loaded")
|
||||
assert.Empty(t, out.String())
|
||||
assert.Equal(t, "no certificate is loaded\n", errOut.String())
|
||||
}
|
||||
@@ -0,0 +1,194 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
)
|
||||
|
||||
// ErrNoTextRendering is returned by Render when a command's Value has no human rendering
|
||||
// and text was asked for anyway. A command declares this by leaving Text nil and saying
|
||||
// so with JSONOnly; it is not a fallback situation but a statement that no such form
|
||||
// exists yet, so nobody builds a script around an interim one. Each surface's default
|
||||
// policy avoids ever asking.
|
||||
var ErrNoTextRendering = errors.New("no human readable output yet; pass -json or -pretty")
|
||||
|
||||
// Format is how a result should be presented.
|
||||
type Format int
|
||||
|
||||
const (
|
||||
// FormatUnset is a request that expressed no preference. A surface resolves it with
|
||||
// its own default before rendering; Render itself treats it as FormatText.
|
||||
FormatUnset Format = iota
|
||||
|
||||
// FormatText renders for a person. It is what an operator gets by default on every
|
||||
// surface with a human at the other end.
|
||||
FormatText
|
||||
|
||||
// FormatJSON renders the result as compact JSON.
|
||||
FormatJSON
|
||||
|
||||
// FormatPrettyJSON renders the result as indented JSON.
|
||||
FormatPrettyJSON
|
||||
)
|
||||
|
||||
// Flag names for the two presentation flags. They are offered on every command rather
|
||||
// than declared by each one, because how a result is displayed is not a property of the
|
||||
// command that produced it.
|
||||
const (
|
||||
FlagJSON = "json"
|
||||
FlagPretty = "pretty"
|
||||
)
|
||||
|
||||
// Flag names nebula ctl takes for itself, anywhere on its line, to say which daemon to
|
||||
// talk to; see reservedFlags.
|
||||
const (
|
||||
FlagConfig = "config"
|
||||
FlagSocket = "socket"
|
||||
)
|
||||
|
||||
// reservedFlags are handled before a command's Run is called, so a command may not
|
||||
// declare them itself. -h and -help are intercepted as a request for usage; -json and
|
||||
// -pretty are added to every command's FlagSet by commandFlags, on every surface, so a
|
||||
// command that defined either would make that definition panic with "flag redefined"
|
||||
// on whichever goroutine ran the command; and -config and -socket are nebula ctl's own,
|
||||
// taken off the line before the client knows which command it names, so a command
|
||||
// that declared either would never receive it there.
|
||||
var reservedFlags = []string{"h", "help", FlagJSON, FlagPretty, FlagConfig, FlagSocket}
|
||||
|
||||
// Render writes r in the requested format. Every surface calls it, so a hostmap looks
|
||||
// the same over ssh as it does through the control socket, and a change to either
|
||||
// rendering happens once.
|
||||
func Render(c *Command, r Result, f Format, w io.Writer) error {
|
||||
switch f {
|
||||
case FormatJSON:
|
||||
return renderJSON(r.Payload(), w, false)
|
||||
|
||||
case FormatPrettyJSON:
|
||||
return renderJSON(r.Payload(), w, true)
|
||||
|
||||
default:
|
||||
// An outcome reads the same for every command: its reason, as a sentence. Only a
|
||||
// Value needs the command's own rendering, so Text never sees anything else.
|
||||
if r.Value == nil {
|
||||
_, err := io.WriteString(w, r.Reason+"\n")
|
||||
return err
|
||||
}
|
||||
|
||||
if c != nil && c.Text != nil {
|
||||
return c.Text(r.Value, w)
|
||||
}
|
||||
|
||||
name := "this command"
|
||||
if c != nil {
|
||||
name = string(c.Name)
|
||||
}
|
||||
return fmt.Errorf("%s has %w", name, ErrNoTextRendering)
|
||||
}
|
||||
}
|
||||
|
||||
func renderJSON(v any, w io.Writer, indent bool) error {
|
||||
enc := json.NewEncoder(w)
|
||||
if indent {
|
||||
enc.SetIndent("", " ")
|
||||
}
|
||||
|
||||
return enc.Encode(v)
|
||||
}
|
||||
|
||||
// Result is what every Run returns: whether the command worked, a sentence saying so,
|
||||
// and, for a command that reports rather than acts, the value it produced.
|
||||
//
|
||||
// Value and Reason are alternatives. A command that reports returns Value(v), and the
|
||||
// surfaces render v, as JSON or through the command's Text. A command that acts, or any
|
||||
// command refusing its arguments, returns Did or Failed, and the surfaces render the
|
||||
// Outcome: its Reason is the sentence these commands have always printed. Nothing is for
|
||||
// a command with nothing to say.
|
||||
//
|
||||
// The envelope itself never reaches a caller. Payload is what JSON carries, and Render
|
||||
// hands Text only the Value, so a command's renderer sees the one type it returns on
|
||||
// success and is never asked to recognise an Outcome.
|
||||
type Result struct {
|
||||
Outcome
|
||||
Value any
|
||||
|
||||
// NotFound marks a refusal that is about the thing asked for rather than the asking:
|
||||
// a vpn address with no tunnel behind it, as opposed to one that would not parse. It
|
||||
// renders exactly as any other refusal, and never reaches the wire; the distinction
|
||||
// is for a surface whose protocol has a word for it, so an HTTP client is told 404
|
||||
// rather than 400 and never has to parse the sentence.
|
||||
NotFound bool
|
||||
}
|
||||
|
||||
// Outcome is the part of a Result that says whether the command worked and, in words a
|
||||
// caller can show someone, why. It is what a program receives from a command that acts
|
||||
// rather than reports: closing a tunnel, changing a remote, reloading config.
|
||||
//
|
||||
// One shape serves all of them. Designing a payload per outcome would be work without a
|
||||
// reader. Reason is set either way, so a success says what it did rather than leaving
|
||||
// the caller to infer it from a bare true.
|
||||
type Outcome struct {
|
||||
OK bool `json:"ok"`
|
||||
Reason string `json:"reason"`
|
||||
}
|
||||
|
||||
// Value is the Result of a command that reports: v is what it has to show, and it must
|
||||
// marshal to JSON.
|
||||
func Value(v any) Result {
|
||||
return Result{Outcome: Outcome{OK: true}, Value: v}
|
||||
}
|
||||
|
||||
// Failed is a convenience for the common "it did not work, here is why" case.
|
||||
func Failed(format string, args ...any) Result {
|
||||
return Result{Outcome: Outcome{Reason: fmt.Sprintf(format, args...)}}
|
||||
}
|
||||
|
||||
// NotFound is Failed for a command asked about something that does not exist. See
|
||||
// Result.NotFound.
|
||||
func NotFound(format string, args ...any) Result {
|
||||
r := Failed(format, args...)
|
||||
r.NotFound = true
|
||||
return r
|
||||
}
|
||||
|
||||
// Did is a convenience for the common "it worked, here is what happened" case.
|
||||
func Did(format string, args ...any) Result {
|
||||
return Result{Outcome: Outcome{OK: true, Reason: fmt.Sprintf(format, args...)}}
|
||||
}
|
||||
|
||||
// Nothing is the Result of a command with nothing to say: it did its work, and the
|
||||
// surface sends an empty, successful reply without rendering anything.
|
||||
func Nothing() Result {
|
||||
return Result{Outcome: Outcome{OK: true}}
|
||||
}
|
||||
|
||||
// Empty reports a Result with nothing to render: no Value and no Reason. The zero Result
|
||||
// counts, so a Run that returns Result{} says nothing rather than failing silently.
|
||||
func (r Result) Empty() bool {
|
||||
return r.Value == nil && r.Reason == ""
|
||||
}
|
||||
|
||||
// Payload is what a program receives: the Value when there is one, otherwise the
|
||||
// Outcome. No surface sends the envelope itself, so print-tunnel -json emits the tunnel
|
||||
// and close-tunnel -json emits {ok, reason}.
|
||||
func (r Result) Payload() any {
|
||||
if r.Value != nil {
|
||||
return r.Value
|
||||
}
|
||||
return r.Outcome
|
||||
}
|
||||
|
||||
// Typed adapts a renderer for one result type to the TextFunc a Command declares. The
|
||||
// value Render passes is the command's own, see Result, so all that is left is to name
|
||||
// its type once here instead of asserting it at the top of every renderer. A renderer
|
||||
// paired with a command that returns something else fails here, saying what arrived.
|
||||
func Typed[T any](render func(T, io.Writer) error) TextFunc {
|
||||
return func(v any, w io.Writer) error {
|
||||
t, ok := v.(T)
|
||||
if !ok {
|
||||
return fmt.Errorf("expected %T, got %T", t, v)
|
||||
}
|
||||
return render(t, w)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,123 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"io"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// TestRenderPrintsAnOutcomeWithoutText: a command that acts declares no Text. Its
|
||||
// outcome renders as the reason, the same for every command, and as {ok, reason} in
|
||||
// JSON, which is the shape these commands have always emitted.
|
||||
func TestRenderPrintsAnOutcomeWithoutText(t *testing.T) {
|
||||
c := &Command{Name: "act"}
|
||||
|
||||
out := &bytes.Buffer{}
|
||||
require.NoError(t, Render(c, Did("Closed"), FormatText, out))
|
||||
assert.Equal(t, "Closed\n", out.String())
|
||||
|
||||
out.Reset()
|
||||
require.NoError(t, Render(c, Failed("No vpn address was provided"), FormatText, out))
|
||||
assert.Equal(t, "No vpn address was provided\n", out.String())
|
||||
|
||||
out.Reset()
|
||||
require.NoError(t, Render(c, Failed("nope"), FormatJSON, out))
|
||||
assert.JSONEq(t, `{"ok":false,"reason":"nope"}`, out.String())
|
||||
}
|
||||
|
||||
// TestRenderHandsTextOnlyTheValue pins the guarantee Result exists for: a command's
|
||||
// renderer sees the type it returns on success and never the envelope or an outcome, so
|
||||
// a report command that refuses its arguments needs nothing in its Text to cope.
|
||||
func TestRenderHandsTextOnlyTheValue(t *testing.T) {
|
||||
var got any
|
||||
c := &Command{
|
||||
Name: "report",
|
||||
Text: func(v any, w io.Writer) error {
|
||||
got = v
|
||||
_, err := io.WriteString(w, "rendered\n")
|
||||
return err
|
||||
},
|
||||
}
|
||||
|
||||
out := &bytes.Buffer{}
|
||||
require.NoError(t, Render(c, Value("data"), FormatText, out))
|
||||
assert.Equal(t, "data", got)
|
||||
assert.Equal(t, "rendered\n", out.String())
|
||||
|
||||
got, out = nil, &bytes.Buffer{}
|
||||
require.NoError(t, Render(c, Failed("refused"), FormatText, out))
|
||||
assert.Nil(t, got, "Text must not be called for an outcome")
|
||||
assert.Equal(t, "refused\n", out.String())
|
||||
|
||||
out.Reset()
|
||||
require.NoError(t, Render(c, Value("data"), FormatJSON, out))
|
||||
assert.JSONEq(t, `"data"`, out.String(), "JSON carries the value, never the envelope")
|
||||
}
|
||||
|
||||
// TestRenderRefusesTextForAValueWithoutText: leaving Text nil is a statement that no
|
||||
// human form of the value exists yet, and asking for one is an error that says so.
|
||||
func TestRenderRefusesTextForAValueWithoutText(t *testing.T) {
|
||||
out := &bytes.Buffer{}
|
||||
err := Render(&Command{Name: "print-tunnel"}, Value(map[string]int{"index": 7}), FormatText, out)
|
||||
require.ErrorIs(t, err, ErrNoTextRendering)
|
||||
require.ErrorContains(t, err, "print-tunnel has no human readable output yet")
|
||||
assert.Empty(t, out.String())
|
||||
}
|
||||
|
||||
// TestTypedNamesTheTypeOnce: Typed replaces the assertion at the top of every renderer.
|
||||
// The right type reaches the renderer; the wrong one is reported, naming both.
|
||||
func TestTypedNamesTheTypeOnce(t *testing.T) {
|
||||
type info struct{ Name string }
|
||||
render := Typed(func(i info, w io.Writer) error {
|
||||
_, err := io.WriteString(w, i.Name+"\n")
|
||||
return err
|
||||
})
|
||||
|
||||
out := &bytes.Buffer{}
|
||||
require.NoError(t, render(info{Name: "tun0"}, out))
|
||||
assert.Equal(t, "tun0\n", out.String())
|
||||
|
||||
err := render("not an info", out)
|
||||
require.Error(t, err)
|
||||
assert.ErrorContains(t, err, "expected commands.info, got string")
|
||||
}
|
||||
|
||||
// TestResultShapes pins what each constructor means to a surface: Empty is the one that
|
||||
// renders nothing, Payload is what a program receives, and OK is set wherever a reason
|
||||
// or value says the command worked.
|
||||
func TestResultShapes(t *testing.T) {
|
||||
assert.True(t, Nothing().Empty())
|
||||
assert.True(t, Result{}.Empty(), "the zero Result says nothing rather than failing silently")
|
||||
assert.False(t, Did("done").Empty())
|
||||
assert.False(t, Failed("no").Empty())
|
||||
assert.False(t, Value("x").Empty())
|
||||
|
||||
assert.True(t, Value("x").OK)
|
||||
assert.True(t, Did("done").OK)
|
||||
assert.False(t, Failed("no").OK)
|
||||
|
||||
assert.Equal(t, "x", Value("x").Payload())
|
||||
assert.Equal(t, Outcome{OK: true, Reason: "done"}, Did("done").Payload())
|
||||
assert.Equal(t, Outcome{Reason: "no"}, Failed("no").Payload())
|
||||
}
|
||||
|
||||
// TestNotFoundIsARefusalLikeAnyOther: NotFound renders and marshals exactly as Failed
|
||||
// does, so no surface's output changes by a command adopting it. The mark is on the
|
||||
// Result alone, for a surface whose protocol has a word for it.
|
||||
func TestNotFoundIsARefusalLikeAnyOther(t *testing.T) {
|
||||
r := NotFound("No active tunnel for vpn addr: %s", "10.0.0.5")
|
||||
assert.False(t, r.OK)
|
||||
assert.True(t, r.NotFound)
|
||||
assert.False(t, Failed("nope").NotFound)
|
||||
|
||||
out := &bytes.Buffer{}
|
||||
require.NoError(t, Render(&Command{Name: "look"}, r, FormatText, out))
|
||||
assert.Equal(t, "No active tunnel for vpn addr: 10.0.0.5\n", out.String())
|
||||
|
||||
out.Reset()
|
||||
require.NoError(t, Render(&Command{Name: "look"}, r, FormatJSON, out))
|
||||
assert.JSONEq(t, `{"ok":false,"reason":"No active tunnel for vpn addr: 10.0.0.5"}`, out.String(), "the mark never reaches the wire")
|
||||
}
|
||||
@@ -0,0 +1,143 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"flag"
|
||||
"maps"
|
||||
"slices"
|
||||
)
|
||||
|
||||
// Request is one command to run, as every surface hands it to Invoke: the command, its
|
||||
// options by name in the form their flags parse, its operands, and the rendering the
|
||||
// line asked for, if any.
|
||||
//
|
||||
// nebula ctl builds one with ParseLine and it travels as a JSON object to the control
|
||||
// socket. An ssh line never becomes one: it is parsed straight into the command's own
|
||||
// FlagSet; see execLine.
|
||||
type Request struct {
|
||||
// Command is the command to run, resolved by the surface at its edge. See
|
||||
// Registry.Resolve for the one that tells an unknown name from a withheld one.
|
||||
Command *Command
|
||||
|
||||
// Params carries the options the line set, by flag name, each in the form its flag
|
||||
// parses from. An option left alone is absent, so the command's default applies.
|
||||
Params map[string]string
|
||||
|
||||
// Args carries the operands: whatever the line did not consume as a flag.
|
||||
Args []string
|
||||
|
||||
// Format is the rendering the line asked for with -json or -pretty, or FormatUnset
|
||||
// when it expressed no preference. It is ParseLine's reading of the line for the
|
||||
// client that sends the Request; Invoke does not read it, since the surface that
|
||||
// runs a Request renders with the format it agreed with its caller.
|
||||
Format Format
|
||||
}
|
||||
|
||||
// ParseLine reads a FlagSet that ParseArgs has filled, and the operands it returned,
|
||||
// into a Request to send over the wire. Command is left for the caller to set.
|
||||
//
|
||||
// Every flag the line set other than the presentation flags travels by name, as its
|
||||
// flag's String, which is what the daemon's Set parses. That round trip is exact for
|
||||
// the bool and string flags a client builds from the schema; it is the client's to make,
|
||||
// and the ssh path does not make it, since it runs the FlagSet it parsed.
|
||||
func ParseLine(fl *flag.FlagSet, operands []string) Request {
|
||||
req := Request{Args: operands, Format: presentationFormat(fl)}
|
||||
|
||||
fl.Visit(func(f *flag.Flag) {
|
||||
if isPresentationFlag(f.Name) {
|
||||
return
|
||||
}
|
||||
if req.Params == nil {
|
||||
req.Params = map[string]string{}
|
||||
}
|
||||
req.Params[f.Name] = f.Value.String()
|
||||
})
|
||||
|
||||
return req
|
||||
}
|
||||
|
||||
// presentationFormat is the one reading of -json and -pretty from a parsed line, so a
|
||||
// line means the same on every surface: only a flag set to true asks for JSON, since one
|
||||
// set to false expresses no preference, and -pretty implies -json. FormatUnset means the
|
||||
// line expressed no preference and the surface's own default applies.
|
||||
func presentationFormat(fl *flag.FlagSet) Format {
|
||||
var asJSON, pretty bool
|
||||
fl.Visit(func(f *flag.Flag) {
|
||||
switch f.Name {
|
||||
case FlagJSON:
|
||||
asJSON = flagIsTrue(f)
|
||||
case FlagPretty:
|
||||
pretty = flagIsTrue(f)
|
||||
}
|
||||
})
|
||||
|
||||
switch {
|
||||
case pretty:
|
||||
return FormatPrettyJSON
|
||||
case asJSON:
|
||||
return FormatJSON
|
||||
default:
|
||||
return FormatUnset
|
||||
}
|
||||
}
|
||||
|
||||
// PresentationFormat is presentationFormat for a surface that takes a command's options
|
||||
// by name rather than from a line: the info API's query string. Only the two presentation
|
||||
// flags are read from params; the command's own parameters are the caller's to pass to
|
||||
// Invoke, which refuses these two among them. A flag given with no value counts as set,
|
||||
// as -pretty does on a line, and one that is not a boolean is a ParamError.
|
||||
func PresentationFormat(params map[string]string) (Format, error) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
addPresentationFlags(fl)
|
||||
|
||||
for _, k := range []string{FlagJSON, FlagPretty} {
|
||||
v, ok := params[k]
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
if v == "" {
|
||||
v = "true"
|
||||
}
|
||||
if err := setFlag(fl, fl.Lookup(k), v); err != nil {
|
||||
return FormatUnset, err
|
||||
}
|
||||
}
|
||||
|
||||
return presentationFormat(fl), nil
|
||||
}
|
||||
|
||||
// flagIsTrue reports whether a bool flag was set to true. The flag package's bool value
|
||||
// is a flag.Getter whose Get returns the bool, so this never falls back to parsing text.
|
||||
func flagIsTrue(f *flag.Flag) bool {
|
||||
g, ok := f.Value.(flag.Getter)
|
||||
if !ok {
|
||||
return false
|
||||
}
|
||||
b, _ := g.Get().(bool)
|
||||
return b
|
||||
}
|
||||
|
||||
// Invoke runs one Request and returns the command's Result, unrendered.
|
||||
//
|
||||
// The parameters are applied by flag name, in name order: a request from the wire is a
|
||||
// JSON object with no order of its own, and which of two bad parameters is reported must
|
||||
// not change from one request to the next. An unknown parameter is an error rather than
|
||||
// something quietly ignored, because a caller that misspells one deserves to hear about
|
||||
// it instead of getting a default. A bad parameter means Run is never called, and the
|
||||
// FlagSet is fresh for this call, so nothing set before it is seen by anyone.
|
||||
//
|
||||
// Nothing here writes anywhere and nothing here renders. What a surface does with the
|
||||
// Result, marshal its Payload or run the command's own text rendering through Render,
|
||||
// is the surface's decision, and keeping that out of here is what lets a caller tell a
|
||||
// refusal from a success after the text has been produced. The presentation flags are
|
||||
// not parameters: a Request says how it wants rendering in Format, and sending them as
|
||||
// parameters is refused rather than read as a preference.
|
||||
func Invoke(req Request) (Result, error) {
|
||||
c := req.Command
|
||||
|
||||
fl, fs, own := commandFlags(c)
|
||||
if err := setParams(fl, string(c.Name), slices.Sorted(maps.Keys(req.Params)), req.Params, own); err != nil {
|
||||
return Result{}, err
|
||||
}
|
||||
|
||||
return c.Run(fs, req.Args)
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"flag"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func lineFlags() *flag.FlagSet {
|
||||
fl := flag.NewFlagSet("set", flag.ContinueOnError)
|
||||
fl.Bool("verbose", false, "")
|
||||
fl.Duration("wait", 0, "")
|
||||
fl.String("label", "none", "")
|
||||
fl.Bool(FlagJSON, false, "")
|
||||
fl.Bool(FlagPretty, false, "")
|
||||
return fl
|
||||
}
|
||||
|
||||
// TestParseLineReadsThePresentationFlagsOnce: presentationFormat is the one reading of
|
||||
// -json and -pretty, for every surface, and ParseLine carries its answer. A flag set to
|
||||
// false expresses no preference, and neither flag ever travels as a parameter.
|
||||
func TestParseLineReadsThePresentationFlagsOnce(t *testing.T) {
|
||||
for _, tc := range []struct {
|
||||
args []string
|
||||
want Format
|
||||
}{
|
||||
{nil, FormatUnset},
|
||||
{[]string{"-json=false"}, FormatUnset},
|
||||
{[]string{"-pretty=false"}, FormatUnset},
|
||||
{[]string{"-json"}, FormatJSON},
|
||||
{[]string{"-pretty"}, FormatPrettyJSON},
|
||||
{[]string{"-pretty", "-json=false"}, FormatPrettyJSON},
|
||||
} {
|
||||
fl := lineFlags()
|
||||
operands, err := ParseArgs(fl, tc.args)
|
||||
require.NoError(t, err)
|
||||
|
||||
req := ParseLine(fl, operands)
|
||||
assert.Equal(t, tc.want, req.Format, "%v", tc.args)
|
||||
assert.Nil(t, req.Params, "%v: presentation flags are not parameters", tc.args)
|
||||
}
|
||||
}
|
||||
|
||||
// TestParseLineCarriesWhatWasSetInParseableForm: only the flags the line set travel,
|
||||
// each as the string its flag parses from, so the daemon's Invoke can apply them to a
|
||||
// fresh FlagSet and get the same values back. Operands come through untouched, those
|
||||
// after "--" included.
|
||||
func TestParseLineCarriesWhatWasSetInParseableForm(t *testing.T) {
|
||||
fl := lineFlags()
|
||||
operands, err := ParseArgs(fl, []string{"-verbose", "-wait", "2s", "x", "--", "-1"})
|
||||
require.NoError(t, err)
|
||||
|
||||
req := ParseLine(fl, operands)
|
||||
assert.Equal(t, map[string]string{"verbose": "true", "wait": "2s"}, req.Params, "label was left alone and must be absent")
|
||||
assert.Equal(t, []string{"x", "-1"}, req.Args)
|
||||
assert.Equal(t, FormatUnset, req.Format)
|
||||
|
||||
// The round trip a client makes: what ParseLine produced is what Invoke applies.
|
||||
r, seen := paramRegistry(t)
|
||||
req.Command = r.Get("set")
|
||||
_, err = Invoke(req)
|
||||
require.NoError(t, err)
|
||||
require.Len(t, *seen, 1)
|
||||
assert.Equal(t, paramsSeen{Verbose: true, Wait: 2 * time.Second}, (*seen)[0])
|
||||
}
|
||||
|
||||
// TestLineRunsTheFlagSetItParsed: the ssh path hands Run the FlagSet the line was parsed
|
||||
// into, with no trip through a Request. A flag.Func has no String worth re-parsing, so a
|
||||
// round trip would hand Run an empty value and no error; the line's value must arrive.
|
||||
func TestLineRunsTheFlagSetItParsed(t *testing.T) {
|
||||
var seen []string
|
||||
r := New()
|
||||
r.Register(&Command{
|
||||
Name: "mode",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := new(string)
|
||||
fl.Func("mode", "the mode", func(v string) error {
|
||||
*s = "set:" + v
|
||||
return nil
|
||||
})
|
||||
return fl, s
|
||||
},
|
||||
Run: func(fs any, a []string) (Result, error) {
|
||||
seen = append(seen, *fs.(*string))
|
||||
return Value("ok"), nil
|
||||
},
|
||||
})
|
||||
|
||||
var out, errw strings.Builder
|
||||
r.Dispatch("mode -json -mode fast", Output{Out: &out, Err: &errw})
|
||||
require.Equal(t, []string{"set:fast"}, seen)
|
||||
assert.Empty(t, errw.String())
|
||||
assert.Equal(t, "\"ok\"\n", out.String(), "-json was read from the same FlagSet")
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
package commands
|
||||
|
||||
import "io"
|
||||
|
||||
// Output is where a command line surface's text goes.
|
||||
//
|
||||
// Out and Err are distinct so a command's primary output can stay machine readable on
|
||||
// a surface that separates the two. The ssh surface points both at the same channel and
|
||||
// sees a single merged stream. The local
|
||||
// control socket does not use one at all: it invokes by named parameter and carries the
|
||||
// returned value, so there is no stream for a command to write to.
|
||||
type Output struct {
|
||||
// Out receives what a command produces.
|
||||
Out io.Writer
|
||||
|
||||
// Err receives usage text, refusals and errors.
|
||||
Err io.Writer
|
||||
}
|
||||
|
||||
// MergedOutput sends output and errors to the same writer.
|
||||
func MergedOutput(w io.Writer) Output {
|
||||
return Output{Out: w, Err: w}
|
||||
}
|
||||
@@ -0,0 +1,145 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/netip"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/cert_test"
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/logging"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// TestLogFormatRefusalIsShown: a format the logger does not know is a refusal the user
|
||||
// sees, rather than a bare error, which over ssh was silence.
|
||||
func TestLogFormatRefusalIsShown(t *testing.T) {
|
||||
l := logging.NewLogger(io.Discard)
|
||||
|
||||
res, err := runLogFormat(l, []string{"bogus"})
|
||||
require.NoError(t, err)
|
||||
assert.False(t, res.OK)
|
||||
assert.Equal(t, "Unable to set log format: unknown log format `bogus`. possible formats: [text json]", res.Reason)
|
||||
|
||||
res, err = runLogFormat(l, []string{"JSON"})
|
||||
require.NoError(t, err)
|
||||
out := &bytes.Buffer{}
|
||||
require.NoError(t, commands.Typed(textLogFormat)(res.Value, out))
|
||||
assert.Equal(t, "Log format is: json\n", out.String())
|
||||
}
|
||||
|
||||
// TestPrintRelaysReportsErrorsAsText: the Error field was an error value, which encodes
|
||||
// as {} and lost the message. It is the message now, and absent when there is none.
|
||||
func TestPrintRelaysReportsErrorsAsText(t *testing.T) {
|
||||
l := test.NewLogger()
|
||||
hm := newHostMap(l)
|
||||
relay := netip.MustParseAddr("10.0.0.1")
|
||||
peer := netip.MustParseAddr("10.0.0.2")
|
||||
|
||||
// A relay host that is in Relays but not in Hosts, so its hostinfo cannot be found.
|
||||
hm.Relays[1] = &HostInfo{vpnAddrs: []netip.Addr{relay}}
|
||||
ifce := &Interface{hostMap: hm}
|
||||
|
||||
marshal := func() string {
|
||||
b, err := json.Marshal(runPrintRelays(ifce))
|
||||
require.NoError(t, err)
|
||||
return string(b)
|
||||
}
|
||||
assert.JSONEq(t, `{"Relays":[{"NebulaAddr":"10.0.0.1","RelayForAddrs":[{"Error":"could not find hostinfo","Type":"","State":"","PeerAddr":"","LocalIndex":0,"RemoteIndex":0,"RelayedThrough":null}]}]}`, marshal())
|
||||
|
||||
// The same relay host, found, relaying for a peer whose index matches: no Error key.
|
||||
hi := hm.Relays[1]
|
||||
r := &Relay{Type: ForwardingType, State: Established, PeerAddr: peer, LocalIndex: 1, RemoteIndex: 2}
|
||||
hi.relayState = RelayState{
|
||||
relayForByAddr: map[netip.Addr]*Relay{peer: r},
|
||||
relayForByIdx: map[uint32]*Relay{r.LocalIndex: r},
|
||||
}
|
||||
hm.Hosts[relay] = hi
|
||||
assert.JSONEq(t, `{"Relays":[{"NebulaAddr":"10.0.0.1","RelayForAddrs":[{"Type":"forwarding","State":"established","PeerAddr":"10.0.0.2","LocalIndex":1,"RemoteIndex":2,"RelayedThrough":null}]}]}`, marshal())
|
||||
|
||||
// And an index mismatch names it.
|
||||
hm.Relays[7] = hi
|
||||
delete(hm.Relays, 1)
|
||||
assert.Contains(t, marshal(), `"Error":"hostmap LocalIndex '7' does not match RelayState LocalIndex"`)
|
||||
}
|
||||
|
||||
// TestPrintCertOfATunnelWithoutACertificate: a tunnel still handshaking, or one being
|
||||
// torn down, has no certificate, and print-cert refuses rather than panicking.
|
||||
func TestPrintCertOfATunnelWithoutACertificate(t *testing.T) {
|
||||
f, _ := identityFixture(t)
|
||||
|
||||
r, err := runPrintCert(f, &printCertFlags{}, []string{"10.0.0.3"})
|
||||
require.NoError(t, err)
|
||||
assert.False(t, r.OK)
|
||||
assert.Equal(t, "Could not find tunnel for vpn addr: 10.0.0.3", r.Reason)
|
||||
|
||||
r, err = runPrintCert(f, &printCertFlags{}, []string{"10.0.0.2"})
|
||||
require.NoError(t, err)
|
||||
assert.True(t, r.OK, "a tunnel with a certificate is printed")
|
||||
}
|
||||
|
||||
// TestPrintCertByAddressFlag: -address is the info API's spelling of the operand, takes a
|
||||
// port and a 4in6 form the way identity does, answers our own address with our own
|
||||
// certificate, and is refused together with an operand.
|
||||
func TestPrintCertByAddressFlag(t *testing.T) {
|
||||
f, peerCert := identityFixture(t)
|
||||
|
||||
for _, addr := range []string{"10.0.0.2", "10.0.0.2:4242", "[::ffff:10.0.0.2]:4242"} {
|
||||
fl := &printCertFlags{}
|
||||
require.NoError(t, fl.setAddress(addr))
|
||||
r, err := runPrintCert(f, fl, nil)
|
||||
require.NoError(t, err)
|
||||
require.True(t, r.OK, addr)
|
||||
assert.Equal(t, peerCert, r.Value, addr)
|
||||
}
|
||||
|
||||
fl := &printCertFlags{}
|
||||
require.NoError(t, fl.setAddress("10.0.0.1"))
|
||||
r, err := runPrintCert(f, fl, nil)
|
||||
require.NoError(t, err)
|
||||
require.True(t, r.OK)
|
||||
assert.Equal(t, ownCertificate(f.pki.getCertState()), r.Value, "our own address is our own certificate")
|
||||
|
||||
fl = &printCertFlags{}
|
||||
require.NoError(t, fl.setAddress("10.0.0.3"))
|
||||
r, err = runPrintCert(f, fl, nil)
|
||||
require.NoError(t, err)
|
||||
assert.False(t, r.OK)
|
||||
assert.True(t, r.NotFound)
|
||||
|
||||
fl = &printCertFlags{}
|
||||
require.NoError(t, fl.setAddress("not-an-address"))
|
||||
r, err = runPrintCert(f, fl, nil)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "The provided vpn addr could not be parsed: not-an-address", r.Reason)
|
||||
|
||||
fl = &printCertFlags{}
|
||||
require.NoError(t, fl.setAddress("10.0.0.2"))
|
||||
r, err = runPrintCert(f, fl, []string{"10.0.0.2"})
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "print-cert takes one vpn addr, as -address or as an operand, not both", r.Reason)
|
||||
}
|
||||
|
||||
// TestPrintCertPrefersOwnV2: with no address print-cert reports the certificate whoami
|
||||
// does, the v2 when both versions are loaded, rather than the one handshakes start with.
|
||||
func TestPrintCertPrefersOwnV2(t *testing.T) {
|
||||
v4 := netip.MustParsePrefix("10.0.0.1/24")
|
||||
ca1, _, caKey1, _ := cert_test.NewTestCaCert(cert.Version1, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
v1, _, _, _ := cert_test.NewTestCert(cert.Version1, cert.Curve_CURVE25519, ca1, caKey1, "me", time.Time{}, time.Time{}, []netip.Prefix{v4}, nil, nil)
|
||||
ca2, _, caKey2, _ := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
v2, _, _, _ := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca2, caKey2, "me", time.Time{}, time.Time{}, []netip.Prefix{v4}, nil, nil)
|
||||
|
||||
f := &Interface{pki: &PKI{}, hostMap: newHostMap(test.NewLogger())}
|
||||
f.pki.cs.Store(&CertState{v1Cert: v1, v2Cert: v2, initiatingVersion: cert.Version1})
|
||||
|
||||
r, err := runPrintCert(f, &printCertFlags{}, nil)
|
||||
require.NoError(t, err)
|
||||
require.True(t, r.OK)
|
||||
assert.Equal(t, v2, r.Value)
|
||||
}
|
||||
+34
-1
@@ -32,6 +32,11 @@ type C struct {
|
||||
|
||||
// Set by the first reload that needs a restart and never cleared. Guarded by reloadLock
|
||||
needsRestart bool
|
||||
|
||||
// callbackLock guards callbacks. Registration is not confined to startup: CatchHUP is
|
||||
// running from inside Main, and anything wired up after Main returns registers while
|
||||
// a HUP could already be reloading, so append and iteration have to be serialized.
|
||||
callbackLock sync.Mutex
|
||||
}
|
||||
|
||||
func NewC(l *slog.Logger) *C {
|
||||
@@ -78,14 +83,42 @@ func (c *C) LoadString(raw string) error {
|
||||
// These functions should return quickly or spawn their own go routine if they will take a while.
|
||||
// Use r to report anything that failed or needs a restart to apply.
|
||||
func (c *C) RegisterReloadCallback(f func(c *C, r *Reload)) {
|
||||
c.callbackLock.Lock()
|
||||
defer c.callbackLock.Unlock()
|
||||
c.callbacks = append(c.callbacks, f)
|
||||
}
|
||||
|
||||
// reloadCallbacks returns a snapshot of the registered callbacks. Reloads iterate the
|
||||
// snapshot rather than the live slice, so a registration from another goroutine cannot
|
||||
// race the loop; a callback registered while a reload is in progress runs from the next
|
||||
// reload on. callbackLock is not held during the calls themselves, so a callback that
|
||||
// registers another callback does not deadlock.
|
||||
func (c *C) reloadCallbacks() []func(*C, *Reload) {
|
||||
c.callbackLock.Lock()
|
||||
defer c.callbackLock.Unlock()
|
||||
return append(make([]func(*C, *Reload), 0, len(c.callbacks)), c.callbacks...)
|
||||
}
|
||||
|
||||
// InitialLoad returns true if this is the first load of the config, and ReloadConfig has not been called yet.
|
||||
func (c *C) InitialLoad() bool {
|
||||
return c.oldSettings == nil
|
||||
}
|
||||
|
||||
// Render returns keys and their values as yaml, for a subsystem to remember what it applied. Empty means they couldn't
|
||||
// be rendered and should never match.
|
||||
func (c *C) Render(keys ...string) string {
|
||||
m := make(map[string]any, len(keys))
|
||||
for _, k := range keys {
|
||||
m[k] = c.Get(k)
|
||||
}
|
||||
b, err := yaml.Marshal(m)
|
||||
if err != nil {
|
||||
c.l.Debug("Failed to render config", "keys", keys, "error", err)
|
||||
return ""
|
||||
}
|
||||
return string(b)
|
||||
}
|
||||
|
||||
// HasChanged checks if the underlying structure of the provided key has changed after a config reload. The value of
|
||||
// k in both the old and new settings will be serialized, the result of the string comparison is returned.
|
||||
// If k is an empty string the entire config is tested.
|
||||
@@ -189,7 +222,7 @@ func (c *C) ReloadConfigString(raw string) ReloadResult {
|
||||
|
||||
func (c *C) runCallbacks() ReloadResult {
|
||||
r := &Reload{c: c}
|
||||
for _, v := range c.callbacks {
|
||||
for _, v := range c.reloadCallbacks() {
|
||||
v(c, r)
|
||||
}
|
||||
|
||||
|
||||
@@ -3,6 +3,7 @@ package config
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
@@ -220,3 +221,41 @@ firewall:
|
||||
}
|
||||
assert.Equal(t, expected, m)
|
||||
}
|
||||
|
||||
// TestRegisterReloadCallbackDuringReload: registration is not confined to startup. The
|
||||
// HUP handler runs from inside nebula.Main, and anything wired after Main returns
|
||||
// registers while a reload may already be iterating the callbacks. Under -race this is
|
||||
// the data race on the slice; without it, it checks a callback registered mid-reload is
|
||||
// picked up by the next one.
|
||||
func TestRegisterReloadCallbackDuringReload(t *testing.T) {
|
||||
l := test.NewLogger()
|
||||
c := NewC(l)
|
||||
require.NoError(t, c.LoadString("a: 1"))
|
||||
|
||||
var wg sync.WaitGroup
|
||||
wg.Add(2)
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
for i := 0; i < 200; i++ {
|
||||
c.RegisterReloadCallback(func(*C, *Reload) {})
|
||||
}
|
||||
}()
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
for i := 0; i < 200; i++ {
|
||||
assert.NoError(t, c.ReloadConfigString("a: 1").Err)
|
||||
}
|
||||
}()
|
||||
wg.Wait()
|
||||
|
||||
// A callback that registers another callback must not deadlock, and the new one
|
||||
// runs from the following reload on.
|
||||
var ran int
|
||||
c.RegisterReloadCallback(func(c *C, _ *Reload) {
|
||||
c.RegisterReloadCallback(func(*C, *Reload) { ran++ })
|
||||
})
|
||||
require.NoError(t, c.ReloadConfigString("a: 1").Err)
|
||||
assert.Equal(t, 0, ran, "registered during this reload, so not run by it")
|
||||
require.NoError(t, c.ReloadConfigString("a: 1").Err)
|
||||
assert.Equal(t, 1, ran, "and run by the next")
|
||||
}
|
||||
@@ -11,6 +11,7 @@ import (
|
||||
"syscall"
|
||||
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/header"
|
||||
"github.com/slackhq/nebula/overlay"
|
||||
)
|
||||
@@ -47,6 +48,7 @@ type Control struct {
|
||||
|
||||
f *Interface
|
||||
l *slog.Logger
|
||||
commands *commands.Registry
|
||||
ctx context.Context
|
||||
cancel context.CancelFunc
|
||||
sshStart func()
|
||||
@@ -372,6 +374,13 @@ func (c *Control) CloseAllTunnels(excludeLighthouses bool) (closed int) {
|
||||
return
|
||||
}
|
||||
|
||||
// Commands returns the registry the daemon's surfaces serve from. It is the live
|
||||
// registry, not a copy: a command registered on it is served to every ssh session that
|
||||
// starts afterwards. Clone it to run commands without that reach.
|
||||
func (c *Control) Commands() *commands.Registry {
|
||||
return c.commands
|
||||
}
|
||||
|
||||
func (c *Control) Device() overlay.Device {
|
||||
return c.f.inside
|
||||
}
|
||||
|
||||
+11
-21
@@ -12,6 +12,7 @@ import (
|
||||
"sync/atomic"
|
||||
|
||||
"github.com/miekg/dns"
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/config"
|
||||
)
|
||||
|
||||
@@ -259,31 +260,20 @@ func (d *dnsServer) QueryCert(data string) string {
|
||||
return ""
|
||||
}
|
||||
|
||||
// The hostmap only ever contains peers we have handshaked with, so it never carries an entry for ourselves.
|
||||
// Answer self lookups straight from the local cert state.
|
||||
if cs := d.certState(); cs != nil && cs.myVpnAddrsTable != nil && cs.myVpnAddrsTable.Contains(ip) {
|
||||
c := cs.GetDefaultCertificate()
|
||||
if c == nil {
|
||||
return ""
|
||||
}
|
||||
b, err := c.MarshalJSON()
|
||||
if err != nil {
|
||||
return ""
|
||||
}
|
||||
return string(b)
|
||||
// Our own address answers with the certificate handshakes are initiated with, as the
|
||||
// TXT record always has; which of our certificates identity reports is its own choice.
|
||||
cs := d.certState()
|
||||
var crt cert.Certificate
|
||||
if ownsVpnAddr(cs, ip) {
|
||||
crt = cs.getCertificate(cs.initiatingVersion)
|
||||
} else {
|
||||
crt, _ = peerCertificateForVpnAddr(d.hostMap, ip)
|
||||
}
|
||||
|
||||
hostinfo := d.hostMap.QueryVpnAddr(ip)
|
||||
if hostinfo == nil {
|
||||
if crt == nil {
|
||||
return ""
|
||||
}
|
||||
|
||||
q := hostinfo.GetCert()
|
||||
if q == nil {
|
||||
return ""
|
||||
}
|
||||
|
||||
b, err := q.Certificate.MarshalJSON()
|
||||
b, err := crt.MarshalJSON()
|
||||
if err != nil {
|
||||
return ""
|
||||
}
|
||||
|
||||
@@ -2,6 +2,7 @@ package nebula
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"log/slog"
|
||||
"net"
|
||||
"net/netip"
|
||||
@@ -402,6 +403,32 @@ func TestDnsServer_QueryCert_returnsOwnCert(t *testing.T) {
|
||||
assert.Empty(t, ds.QueryCert(other.String()+"."), "unknown peer IP should return nothing")
|
||||
}
|
||||
|
||||
// TestDnsServer_QueryCert_answersWithTheInitiatingCertificate: with both versions loaded
|
||||
// the TXT record carries the certificate handshakes start with, as it always has, where
|
||||
// identity and print-cert report the v2.
|
||||
func TestDnsServer_QueryCert_answersWithTheInitiatingCertificate(t *testing.T) {
|
||||
ds, _ := newTestDnsServer(t)
|
||||
me := netip.MustParseAddr("10.0.0.1")
|
||||
network := netip.PrefixFrom(me, 24)
|
||||
ca1, _, caKey1, _ := cert_test.NewTestCaCert(cert.Version1, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
v1, _, _, _ := cert_test.NewTestCert(cert.Version1, cert.Curve_CURVE25519, ca1, caKey1, "lighthouse", time.Time{}, time.Time{}, []netip.Prefix{network}, nil, nil)
|
||||
ca2, _, caKey2, _ := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
v2, _, _, _ := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca2, caKey2, "lighthouse", time.Time{}, time.Time{}, []netip.Prefix{network}, nil, nil)
|
||||
|
||||
addrsTable := new(bart.Lite)
|
||||
addrsTable.Insert(netip.PrefixFrom(me, me.BitLen()))
|
||||
cs := &CertState{v1Cert: v1, v2Cert: v2, initiatingVersion: cert.Version1, myVpnAddrs: []netip.Addr{me}, myVpnAddrsTable: addrsTable}
|
||||
ds.pki = &PKI{}
|
||||
ds.pki.cs.Store(cs)
|
||||
|
||||
var got struct {
|
||||
Version cert.Version `json:"version"`
|
||||
}
|
||||
require.NoError(t, json.Unmarshal([]byte(ds.QueryCert(me.String()+".")), &got))
|
||||
assert.Equal(t, cert.Version1, got.Version)
|
||||
assert.Equal(t, v2, ownCertificate(cs), "identity reports the v2 from the same state")
|
||||
}
|
||||
|
||||
func TestDnsServer_reload_disable_stopsRunningServer(t *testing.T) {
|
||||
port := freeUDPPort(t)
|
||||
ds, c := newTestDnsServer(t)
|
||||
|
||||
@@ -0,0 +1,181 @@
|
||||
//go:build e2e_testing
|
||||
|
||||
package e2e
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/cert_test"
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/sshd"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// volatile lists everything in command output that legitimately differs between runs.
|
||||
// Each run mints fresh certificates and indexes, so these are replaced with a marker
|
||||
// before comparison. Keep the list short: anything added here is something the golden
|
||||
// stops guarding.
|
||||
var volatile = []struct {
|
||||
re *regexp.Regexp
|
||||
with string
|
||||
}{
|
||||
{regexp.MustCompile(`[0-9a-f]{40,}`), "<hex>"}, // fingerprints, keys, signatures
|
||||
{regexp.MustCompile(`\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})`), "<time>"}, // RFC 3339
|
||||
{regexp.MustCompile(`\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}(?:\.\d+)? [+-]\d{4} \w+`), "<time>"}, // time.Time.String()
|
||||
{regexp.MustCompile(`(?s)(-----BEGIN [A-Z ]+-----\n).*?(\n-----END [A-Z ]+-----)`), "${1}<pem>${2}"}, // print-cert -raw
|
||||
{regexp.MustCompile(`(-----BEGIN [A-Z ]+-----\\n).*?(\\n-----END [A-Z ]+-----)`), "${1}<pem>${2}"}, // the same, inside a JSON string
|
||||
{regexp.MustCompile(`"(localIndex|remoteIndex|messageCounter)":\d+`), `"$1":<n>`},
|
||||
{regexp.MustCompile(`(?m)^(\s*"?(?:LocalIndex|RemoteIndex|localIndex|remoteIndex|messageCounter)"?:?\s*)\d+`), "${1}<n>"}, // and the -pretty form
|
||||
}
|
||||
|
||||
func normalise(s string) string {
|
||||
for _, v := range volatile {
|
||||
s = v.re.ReplaceAllString(s, v.with)
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
// outputCase is one command line to run through the ssh dispatch path.
|
||||
type outputCase struct {
|
||||
name string
|
||||
args []string
|
||||
}
|
||||
|
||||
// TestCommandOutput pins the bytes every command produces, in every format, through the
|
||||
// ssh dispatch path. It is the safety net for moving rendering out of the commands: a
|
||||
// change here is a change someone at an ssh prompt would see. Regenerate with:
|
||||
//
|
||||
// go test -tags e2e_testing ./e2e -run TestCommandOutput -update
|
||||
func TestCommandOutput(t *testing.T) {
|
||||
ca, _, caKey, _ := cert_test.NewTestCaCert(
|
||||
cert.Version1, cert.Curve_CURVE25519,
|
||||
time.Now(), time.Now().Add(10*time.Minute),
|
||||
nil, nil, []string{},
|
||||
)
|
||||
|
||||
control, _, _, _ := newSimpleServer(cert.Version1, ca, caKey, "output-golden", "10.222.0.1/24", nil)
|
||||
control.Start()
|
||||
t.Cleanup(func() { control.Stop() })
|
||||
|
||||
// As an ssh session does: a clone of the daemon's registry with logout added, which
|
||||
// help on the clone lists and describes. There is no session to end here.
|
||||
reg := control.Commands().Clone()
|
||||
reg.Register(sshd.LogoutCommand(func() {}))
|
||||
// Dispatch with ssh's default-format policy, so the no-flag column records what an
|
||||
// operator at an ssh prompt sees.
|
||||
reg.DefaultFormat = sshd.DefaultFormat
|
||||
|
||||
// run dispatches as the ssh exec path does and returns the output and the error, which
|
||||
// over ssh is exit status 1.
|
||||
run := func(args ...string) (string, error) {
|
||||
buf := &bytes.Buffer{}
|
||||
err := reg.DispatchArgs(args, commands.MergedOutput(buf))
|
||||
return buf.String(), err
|
||||
}
|
||||
|
||||
// Seed a pending tunnel so the listing and per-address commands have something to show.
|
||||
seed, err := run("create-tunnel", "10.222.0.9")
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "Created\n", seed, "seeding a tunnel should succeed before anything else is recorded")
|
||||
|
||||
cases := []outputCase{
|
||||
{"version", nil},
|
||||
{"device-info", nil},
|
||||
{"list-hostmap", nil},
|
||||
{"list-hostmap", []string{"-by-index"}},
|
||||
{"list-pending-hostmap", nil},
|
||||
{"list-pending-hostmap", []string{"-by-index"}},
|
||||
{"list-lighthouse-addrmap", nil},
|
||||
{"print-cert", nil},
|
||||
{"print-cert", []string{"-raw"}},
|
||||
{"print-cert", []string{"10.222.0.9"}},
|
||||
// A flag after the operand is still a flag, on both surfaces.
|
||||
{"print-cert", []string{"10.222.0.9", "-json"}},
|
||||
{"print-cert", []string{"10.222.0.250"}},
|
||||
{"print-cert", []string{"not-an-address"}},
|
||||
{"whoami", nil},
|
||||
{"whoami", []string{"x"}},
|
||||
// No address is a refusal that names whoami, never this node's identity.
|
||||
{"identity", nil},
|
||||
// Our own address, which the hostmap never holds, answers from our certificate.
|
||||
{"identity", []string{"-address", "10.222.0.1"}},
|
||||
{"identity", []string{"-address", "10.222.0.1:4242"}},
|
||||
// A pending tunnel has no certificate yet.
|
||||
{"identity", []string{"-address", "10.222.0.9"}},
|
||||
{"identity", []string{"-address", "not-an-address"}},
|
||||
{"identity", []string{"-address", ""}},
|
||||
{"identity", []string{"10.222.0.9"}},
|
||||
{"print-tunnel", nil},
|
||||
{"print-tunnel", []string{"10.222.0.9"}},
|
||||
{"print-tunnel", []string{"10.222.0.250"}},
|
||||
{"print-relays", nil},
|
||||
{"query-lighthouse", nil},
|
||||
{"query-lighthouse", []string{"10.222.0.9"}},
|
||||
{"query-lighthouse", []string{"not-an-address"}},
|
||||
// The test logger cannot change level or format, so these cases record the
|
||||
// refusal each command prints on it, not a successful change.
|
||||
{"log-level", nil},
|
||||
{"log-level", []string{"debug"}},
|
||||
{"log-level", []string{"bogus"}},
|
||||
{"log-level", []string{"info"}},
|
||||
{"log-format", nil},
|
||||
{"log-format", []string{"json"}},
|
||||
{"log-format", []string{"text"}},
|
||||
{"change-remote", nil},
|
||||
{"change-remote", []string{"10.222.0.9"}},
|
||||
{"change-remote", []string{"-address", "10.94.0.10:4242", "10.222.0.9"}},
|
||||
{"change-remote", []string{"-address", "10.94.0.10:4242", "10.222.0.250"}},
|
||||
{"create-tunnel", nil},
|
||||
{"create-tunnel", []string{"10.222.0.9"}},
|
||||
// A fresh address, so this exercises the handshake start with a remote attached
|
||||
// rather than the "already handshaking" path above.
|
||||
{"create-tunnel", []string{"-address", "10.94.0.10:4242", "10.222.0.10"}},
|
||||
{"create-tunnel", []string{"not-an-address"}},
|
||||
{"close-tunnel", nil},
|
||||
{"close-tunnel", []string{"10.222.0.250"}},
|
||||
{"close-tunnel", []string{"not-an-address"}},
|
||||
{"help", nil},
|
||||
{"help", []string{"print-cert"}},
|
||||
{"help", []string{"logout"}},
|
||||
{"logout", []string{"-h"}},
|
||||
{"not-a-command", []string{"10.222.0.9"}},
|
||||
// reload is last so that whatever a reload does to the daemon cannot leak into an
|
||||
// earlier case. In this harness it fails: the config was loaded from a string and
|
||||
// has no path to re-read, which is what the recorded result says.
|
||||
{"reload", nil},
|
||||
}
|
||||
|
||||
got := &strings.Builder{}
|
||||
for _, c := range cases {
|
||||
for _, fmtFlags := range [][]string{nil, {"-json"}, {"-pretty"}} {
|
||||
args := append([]string{c.name}, fmtFlags...)
|
||||
args = append(args, c.args...)
|
||||
|
||||
fmt.Fprintf(got, "$ %s\n", strings.Join(args, " "))
|
||||
out, err := run(args...)
|
||||
out = normalise(out)
|
||||
got.WriteString(out)
|
||||
// Output that does not end in a newline is recorded as such, the way diff marks
|
||||
// it, so the golden sees that byte too and the next prompt still starts a line.
|
||||
if out != "" && !strings.HasSuffix(out, "\n") {
|
||||
got.WriteString("\\ No newline at end of output\n")
|
||||
}
|
||||
// A failed command is recorded as the exit status an ssh caller sees, so the
|
||||
// golden pins which outcomes count as failures.
|
||||
if err != nil {
|
||||
got.WriteString("exit status 1\n")
|
||||
}
|
||||
got.WriteString("\n")
|
||||
}
|
||||
}
|
||||
|
||||
test.Golden(t, filepath.Join("testdata", "commands_output.golden"), got.String())
|
||||
}
|
||||
@@ -0,0 +1,143 @@
|
||||
//go:build e2e_testing
|
||||
|
||||
package e2e
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/netip"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/cert_test"
|
||||
"github.com/slackhq/nebula/e2e/router"
|
||||
"github.com/slackhq/nebula/localapi"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// TestIdentityOverTheInfoAPI is the info API's reason to exist, end to end: a program on
|
||||
// this host has a connection arriving over the overlay and asks who is behind its
|
||||
// source address, and the answer is the identity in the certificate the tunnel was
|
||||
// established with.
|
||||
func TestIdentityOverTheInfoAPI(t *testing.T) {
|
||||
if runtime.GOOS == "windows" {
|
||||
t.Skip("the test's HTTP helpers dial unix sockets; on windows the info API is a named pipe")
|
||||
}
|
||||
|
||||
ca, _, caKey, _ := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Now(), time.Now().Add(10*time.Minute), nil, nil, []string{})
|
||||
myControl, myVpnIpNet, _, _ := newSimpleServer(cert.Version2, ca, caKey, "me", "10.128.0.1/24", nil)
|
||||
theirControl, theirVpnIpNet, theirUdpAddr, _ := newSimpleServer(cert.Version2, ca, caKey, "them", "10.128.0.2/24", nil)
|
||||
|
||||
myControl.InjectLightHouseAddr(theirVpnIpNet[0].Addr(), theirUdpAddr)
|
||||
|
||||
r := router.NewR(t, myControl, theirControl)
|
||||
defer r.RenderFlow()
|
||||
|
||||
myControl.Start()
|
||||
theirControl.Start()
|
||||
t.Cleanup(func() {
|
||||
myControl.Stop()
|
||||
theirControl.Stop()
|
||||
})
|
||||
|
||||
// Before the tunnel is up their address is unknown to us.
|
||||
path := infoSocket(t)
|
||||
info := localapi.NewInfoServer(NewTestLogger(), myControl.Commands())
|
||||
require.NoError(t, info.Rebind(context.Background(), path, localapi.Access{Mode: 0600}))
|
||||
t.Cleanup(info.Stop)
|
||||
|
||||
status, body := test.HTTPGet(t, path, "/v1/identity?address="+theirVpnIpNet[0].Addr().String())
|
||||
assert.Equal(t, http.StatusNotFound, status)
|
||||
assert.JSONEq(t, `{"error":"No active tunnel for vpn addr: 10.128.0.2"}`, body)
|
||||
|
||||
// Only we know how to reach them, so the first packet has to be ours; once the tunnel
|
||||
// is up both directions work and assertTunnel can check it.
|
||||
myControl.InjectTunPacket(BuildTunUDPPacket(theirVpnIpNet[0].Addr(), 80, myVpnIpNet[0].Addr(), 80, []byte("Hi from me")))
|
||||
p := r.RouteForAllUntilTxTun(theirControl)
|
||||
assertUdpPacket(t, []byte("Hi from me"), p, myVpnIpNet[0].Addr(), theirVpnIpNet[0].Addr(), 80, 80)
|
||||
assertTunnel(t, myVpnIpNet[0].Addr(), theirVpnIpNet[0].Addr(), myControl, theirControl, r)
|
||||
|
||||
type identity struct {
|
||||
Name string `json:"name"`
|
||||
VpnAddrs []netip.Addr `json:"vpnAddrs"`
|
||||
Networks []netip.Prefix `json:"networks"`
|
||||
Groups []string `json:"groups"`
|
||||
Issuer string `json:"issuer"`
|
||||
Fingerprint string `json:"fingerprint"`
|
||||
}
|
||||
|
||||
// A connection's RemoteAddr, port and all, resolves to the peer.
|
||||
status, body = test.HTTPGet(t, path, "/v1/identity?address="+netip.AddrPortFrom(theirVpnIpNet[0].Addr(), 51234).String())
|
||||
require.Equal(t, http.StatusOK, status, body)
|
||||
var them identity
|
||||
require.NoError(t, json.Unmarshal([]byte(body), &them))
|
||||
assert.Equal(t, "them", them.Name)
|
||||
assert.Equal(t, []netip.Addr{theirVpnIpNet[0].Addr()}, them.VpnAddrs)
|
||||
assert.Equal(t, theirVpnIpNet, them.Networks)
|
||||
assert.Equal(t, []string{}, them.Groups)
|
||||
caFP, err := ca.Fingerprint()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, caFP, them.Issuer)
|
||||
|
||||
// No address is a caller that forgot the parameter, and is refused rather than handed
|
||||
// this node's identity to authorize against; whoami is the command for that.
|
||||
status, body = test.HTTPGet(t, path, "/v1/identity")
|
||||
assert.Equal(t, http.StatusBadRequest, status, body)
|
||||
assert.Contains(t, body, "whoami")
|
||||
|
||||
status, body = test.HTTPGet(t, path, "/v1/whoami")
|
||||
require.Equal(t, http.StatusOK, status, body)
|
||||
var me identity
|
||||
require.NoError(t, json.Unmarshal([]byte(body), &me))
|
||||
assert.Equal(t, "me", me.Name)
|
||||
assert.Equal(t, []netip.Addr{myVpnIpNet[0].Addr()}, me.VpnAddrs)
|
||||
|
||||
// An empty address is a caller's bug, and is told so rather than handed our identity.
|
||||
status, body = test.HTTPGet(t, path, "/v1/identity?address=")
|
||||
assert.Equal(t, http.StatusBadRequest, status)
|
||||
assert.JSONEq(t, `{"error":"The provided vpn addr could not be parsed: "}`, body)
|
||||
|
||||
// The certificate itself, for a program that verifies it against its own CAs: the one
|
||||
// nebula verified when the tunnel came up, as PEM, by the address a connection carries.
|
||||
status, body = test.HTTPGet(t, path, "/v1/print-cert?address="+netip.AddrPortFrom(theirVpnIpNet[0].Addr(), 51234).String()+"&raw=true")
|
||||
require.Equal(t, http.StatusOK, status, body)
|
||||
var raw struct {
|
||||
PEM string `json:"pem"`
|
||||
}
|
||||
require.NoError(t, json.Unmarshal([]byte(body), &raw))
|
||||
theirs, _, err := cert.UnmarshalCertificateFromPEM([]byte(raw.PEM))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "them", theirs.Name())
|
||||
fp, err := theirs.Fingerprint()
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, them.Fingerprint, fp, "the same certificate identity reports")
|
||||
|
||||
// Without raw it is the certificate's fields; without an address, our own.
|
||||
status, body = test.HTTPGet(t, path, "/v1/print-cert")
|
||||
require.Equal(t, http.StatusOK, status, body)
|
||||
assert.Contains(t, body, `"name":"me"`)
|
||||
|
||||
status, body = test.HTTPGet(t, path, "/v1/print-cert?address=10.128.0.9")
|
||||
assert.Equal(t, http.StatusNotFound, status)
|
||||
assert.JSONEq(t, `{"error":"Could not find tunnel for vpn addr: 10.128.0.9"}`, body)
|
||||
|
||||
// Nothing else nebula serves is reachable here.
|
||||
status, body = test.HTTPGet(t, path, "/v1/list-hostmap")
|
||||
assert.Equal(t, http.StatusForbidden, status)
|
||||
assert.Contains(t, body, "identity lookups only")
|
||||
|
||||
r.RenderHostmaps("Final hostmaps", myControl, theirControl)
|
||||
}
|
||||
|
||||
// infoSocket returns a short socket path in a private directory, one level below it
|
||||
// so that listen has a directory of its own to create.
|
||||
func infoSocket(t *testing.T) string {
|
||||
t.Helper()
|
||||
return filepath.Join(test.ShortTempDir(t), "n", "info.sock")
|
||||
}
|
||||
Vendored
+1362
File diff suppressed because it is too large.
Load diff
@@ -234,6 +234,57 @@ punchy:
|
||||
#trusted_cas:
|
||||
#- "ssh public key string"
|
||||
|
||||
# Local APIs allow accessing running nebula state.
|
||||
#local_api:
|
||||
# There are two types of sockets available: a control socket intended for use on the
|
||||
# local machine, primarily for debugging, and an info socket intended to make
|
||||
# nebula's internal state available to other consumers.
|
||||
#
|
||||
# The control socket is made available by default, and can be accessed via
|
||||
# `nebula ctl <command>`. It defaults to /var/run/nebula/ctl.sock on Linux, macOS and
|
||||
# the BSDs; on Windows it is a named pipe under \\.\pipe\ProtectedPrefix\Administrators.
|
||||
#control:
|
||||
# Set to false to turn the control socket off. Reloadable.
|
||||
#enabled: true
|
||||
# The absolute path where the control socket should live, or a full pipe name on
|
||||
# Windows. The last directory is created if missing, and must be owned by root or by
|
||||
# the user running nebula. It must not be writable by anyone else.
|
||||
#socket: /var/run/nebula/ctl.sock
|
||||
# A group (or account/group/SID on Windows) that should be allowed to access the
|
||||
# socket.
|
||||
#group: nebula
|
||||
|
||||
# The info socket is not made available by default. If you enable it, it makes some
|
||||
# internal state available over HTTP.
|
||||
#
|
||||
# The currently supported HTTP requests are:
|
||||
# GET /v1/identity?address=<vpn addr>[:port] the host owning the address; the port
|
||||
# is ignored. 404 when no tunnel is
|
||||
# up, 400 when no address is given.
|
||||
# GET /v1/whoami this node's identity
|
||||
# GET /v1/print-cert?address=<vpn addr>[:port]&raw=true
|
||||
# the certificate for the specified
|
||||
# address, as {"pem": ...}.
|
||||
# GET /v1 describes what is served
|
||||
#
|
||||
# NB: unless a connection arrived on the nebula interface, there's no guarantee
|
||||
# that the identity returned belongs to the sender.
|
||||
#
|
||||
#info:
|
||||
#enabled: false
|
||||
# The absolute path to listen on, or a full pipe name on Windows. Name a pipe under
|
||||
# \\.\pipe\ProtectedPrefix\Administrators\.
|
||||
#socket: /var/run/nebula/info.sock
|
||||
# A group (or account/group/SID on Windows) that should be allowed to access the
|
||||
# socket. On Windows the group may read and write the pipe but not create an
|
||||
# instance of it, so a client in the group must open the pipe asking for read and
|
||||
# write data rather than generic read and write.
|
||||
#group: nebula-info
|
||||
# Octal mode for the socket, as a quoted string. Defaults to "0600" unless a
|
||||
# group is set, in which case it defaults to "0660". On Windows a pipe has no
|
||||
# mode and this is ignored; the group alone decides who may connect.
|
||||
#socket_mode: "0660"
|
||||
|
||||
# EXPERIMENTAL: relay support for networks that can't establish direct connections.
|
||||
relay:
|
||||
# Relays are a list of Nebula IP's that peers can use to relay packets to me.
|
||||
@@ -331,6 +382,9 @@ tun:
|
||||
# `mtu`: will default to tun mtu if this option is not specified
|
||||
# `metric`: will default to 0 if this option is not specified
|
||||
# `install`: will default to true, controls whether this route is installed in the systems routing table.
|
||||
# On macOS, a route whose destination another interface already routes, like the local network, is installed once
|
||||
# that route is removed. One deleted by hand stays deleted until nebula reloads or restarts, or until another
|
||||
# interface routes its destination and lets it go.
|
||||
# This setting is reloadable.
|
||||
unsafe_routes:
|
||||
#- route: 172.16.1.0/24
|
||||
|
||||
+21
-3
@@ -66,6 +66,9 @@ type Firewall struct {
|
||||
rules string
|
||||
rulesVersion uint16
|
||||
|
||||
// source is the rendered firewall config this firewall was built from, the cert networks are kept above
|
||||
source string
|
||||
|
||||
defaultLocalCIDRAny bool
|
||||
incomingMetrics firewallMetrics
|
||||
outgoingMetrics firewallMetrics
|
||||
@@ -203,11 +206,25 @@ func NewFirewallFromConfig(l *slog.Logger, cs *CertState, c *config.C) (*Firewal
|
||||
panic("No certificate available to reconfigure the firewall")
|
||||
}
|
||||
|
||||
tcpTimeout := c.GetDuration("firewall.conntrack.tcp_timeout", time.Minute*12)
|
||||
udpTimeout := c.GetDuration("firewall.conntrack.udp_timeout", time.Minute*3)
|
||||
defaultTimeout := c.GetDuration("firewall.conntrack.default_timeout", time.Minute*10)
|
||||
|
||||
if tcpTimeout <= 0 {
|
||||
return nil, fmt.Errorf("firewall.conntrack.tcp_timeout must be greater than 0, got: %s", tcpTimeout)
|
||||
}
|
||||
if udpTimeout <= 0 {
|
||||
return nil, fmt.Errorf("firewall.conntrack.udp_timeout must be greater than 0, got: %s", udpTimeout)
|
||||
}
|
||||
if defaultTimeout <= 0 {
|
||||
return nil, fmt.Errorf("firewall.conntrack.default_timeout must be greater than 0, got: %s", defaultTimeout)
|
||||
}
|
||||
|
||||
fw := NewFirewall(
|
||||
l,
|
||||
c.GetDuration("firewall.conntrack.tcp_timeout", time.Minute*12),
|
||||
c.GetDuration("firewall.conntrack.udp_timeout", time.Minute*3),
|
||||
c.GetDuration("firewall.conntrack.default_timeout", time.Minute*10),
|
||||
tcpTimeout,
|
||||
udpTimeout,
|
||||
defaultTimeout,
|
||||
certificate,
|
||||
//TODO: max_connections
|
||||
)
|
||||
@@ -246,6 +263,7 @@ func NewFirewallFromConfig(l *slog.Logger, cs *CertState, c *config.C) (*Firewal
|
||||
return nil, err
|
||||
}
|
||||
|
||||
fw.source = c.Render("firewall")
|
||||
return fw, nil
|
||||
}
|
||||
|
||||
|
||||
@@ -58,6 +58,31 @@ func TestNewFirewall(t *testing.T) {
|
||||
assert.Equal(t, 3602, conntrack.TimerWheel.wheelLen)
|
||||
}
|
||||
|
||||
func TestNewFirewall_ZeroOrNegativeTimeout(t *testing.T) {
|
||||
l := test.NewLogger()
|
||||
c := &dummyCert{}
|
||||
cs := &CertState{v2Cert: c, initiatingVersion: cert.Version2}
|
||||
|
||||
cases := map[string]string{
|
||||
"tcp_timeout zero": "firewall:\n conntrack:\n tcp_timeout: 0s\n",
|
||||
"tcp_timeout negative": "firewall:\n conntrack:\n tcp_timeout: -5s\n",
|
||||
"udp_timeout zero": "firewall:\n conntrack:\n udp_timeout: 0s\n",
|
||||
"udp_timeout negative": "firewall:\n conntrack:\n udp_timeout: -5s\n",
|
||||
"default_timeout zero": "firewall:\n conntrack:\n default_timeout: 0s\n",
|
||||
"default_timeout negative": "firewall:\n conntrack:\n default_timeout: -5s\n",
|
||||
}
|
||||
|
||||
for name, cfgStr := range cases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
cfg := config.NewC(l)
|
||||
require.NoError(t, cfg.LoadString(cfgStr))
|
||||
_, err := NewFirewallFromConfig(l, cs, cfg)
|
||||
require.Error(t, err, "expected error for non-positive timeout duration")
|
||||
assert.ErrorContains(t, err, "must be greater than 0")
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestFirewall_AddRule(t *testing.T) {
|
||||
ob := &bytes.Buffer{}
|
||||
l := test.NewLoggerWithOutput(ob)
|
||||
|
||||
@@ -6,8 +6,8 @@ require (
|
||||
dario.cat/mergo v1.0.2
|
||||
filippo.io/bigmod v0.1.0
|
||||
github.com/DefinedNet/netlink v1.3.2-dn.1
|
||||
github.com/Microsoft/go-winio v0.6.2
|
||||
github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be
|
||||
github.com/armon/go-radix v1.0.0
|
||||
github.com/flynn/noise v1.1.0
|
||||
github.com/gaissmai/bart v0.29.0
|
||||
github.com/gogo/protobuf v1.3.2
|
||||
|
||||
@@ -5,6 +5,8 @@ filippo.io/bigmod v0.1.0 h1:UNzDk7y9ADKST+axd9skUpBQeW7fG2KrTZyOE4uGQy8=
|
||||
filippo.io/bigmod v0.1.0/go.mod h1:OjOXDNlClLblvXdwgFFOQFJEocLhhtai8vGLy0JCZlI=
|
||||
github.com/DefinedNet/netlink v1.3.2-dn.1 h1:Md2PsUE1Xuy1Zxs/Bm6356n1kt5bq2HspXlPJ6pEspg=
|
||||
github.com/DefinedNet/netlink v1.3.2-dn.1/go.mod h1:o4YSn8Jw7zoDcYXDmV77TRd4eS5sSLuE+vu2zAN67C8=
|
||||
github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY=
|
||||
github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU=
|
||||
github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
|
||||
github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
|
||||
github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0=
|
||||
@@ -12,8 +14,6 @@ github.com/alecthomas/units v0.0.0-20190717042225-c3de453c63f4/go.mod h1:ybxpYRF
|
||||
github.com/alecthomas/units v0.0.0-20190924025748-f65c72e2690d/go.mod h1:rBZYJk541a8SKzHPHnH3zbiI+7dagKZ0cgpgrD7Fyho=
|
||||
github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8=
|
||||
github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4=
|
||||
github.com/armon/go-radix v1.0.0 h1:F4z6KzEeeQIMeLFa97iZU6vupzoecKdU5TX24SNppXI=
|
||||
github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8=
|
||||
github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=
|
||||
github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
|
||||
github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
|
||||
|
||||
+33
-23
@@ -61,16 +61,17 @@ type HandshakeManager struct {
|
||||
vpnIps map[netip.Addr]*HandshakeHostInfo
|
||||
indexes map[uint32]*HandshakeHostInfo
|
||||
|
||||
mainHostMap *HostMap
|
||||
lightHouse *LightHouse
|
||||
outside udp.Conn
|
||||
config HandshakeConfig
|
||||
OutboundHandshakeTimer *LockingTimerWheel[netip.Addr]
|
||||
messageMetrics *MessageMetrics
|
||||
metricInitiated metrics.Counter
|
||||
metricTimedOut metrics.Counter
|
||||
f *Interface
|
||||
l *slog.Logger
|
||||
mainHostMap *HostMap
|
||||
lightHouse *LightHouse
|
||||
outside udp.Conn
|
||||
config HandshakeConfig
|
||||
OutboundHandshakeTimer *LockingTimerWheel[netip.Addr]
|
||||
messageMetrics *MessageMetrics
|
||||
metricInitiated metrics.Counter
|
||||
metricTimedOut metrics.Counter
|
||||
metricRejectedBlocklisted metrics.Counter
|
||||
f *Interface
|
||||
l *slog.Logger
|
||||
|
||||
// can be used to trigger outbound handshake for the given vpnIp
|
||||
trigger chan netip.Addr
|
||||
@@ -118,18 +119,19 @@ func (hh *HandshakeHostInfo) cachePacket(l *slog.Logger, t header.MessageType, s
|
||||
|
||||
func NewHandshakeManager(l *slog.Logger, mainHostMap *HostMap, lightHouse *LightHouse, outside udp.Conn, config HandshakeConfig) *HandshakeManager {
|
||||
return &HandshakeManager{
|
||||
vpnIps: map[netip.Addr]*HandshakeHostInfo{},
|
||||
indexes: map[uint32]*HandshakeHostInfo{},
|
||||
mainHostMap: mainHostMap,
|
||||
lightHouse: lightHouse,
|
||||
outside: outside,
|
||||
config: config,
|
||||
trigger: make(chan netip.Addr, config.triggerBuffer),
|
||||
OutboundHandshakeTimer: NewLockingTimerWheel[netip.Addr](config.tryInterval, hsTimeout(config.retries, config.tryInterval)),
|
||||
messageMetrics: config.messageMetrics,
|
||||
metricInitiated: metrics.GetOrRegisterCounter("handshake_manager.initiated", nil),
|
||||
metricTimedOut: metrics.GetOrRegisterCounter("handshake_manager.timed_out", nil),
|
||||
l: l,
|
||||
vpnIps: map[netip.Addr]*HandshakeHostInfo{},
|
||||
indexes: map[uint32]*HandshakeHostInfo{},
|
||||
mainHostMap: mainHostMap,
|
||||
lightHouse: lightHouse,
|
||||
outside: outside,
|
||||
config: config,
|
||||
trigger: make(chan netip.Addr, config.triggerBuffer),
|
||||
OutboundHandshakeTimer: NewLockingTimerWheel[netip.Addr](config.tryInterval, hsTimeout(config.retries, config.tryInterval)),
|
||||
messageMetrics: config.messageMetrics,
|
||||
metricInitiated: metrics.GetOrRegisterCounter("handshake_manager.initiated", nil),
|
||||
metricTimedOut: metrics.GetOrRegisterCounter("handshake_manager.timed_out", nil),
|
||||
metricRejectedBlocklisted: metrics.GetOrRegisterCounter("handshake_manager.rejected.blocklisted", nil),
|
||||
l: l,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -717,7 +719,12 @@ func (hm *HandshakeManager) beginHandshake(via ViaSender, packet []byte, h *head
|
||||
|
||||
response, result, err := machine.ProcessPacket(nil, packet)
|
||||
if err != nil {
|
||||
f.l.Error("Failed to process handshake packet", "from", via, "error", err)
|
||||
level := slog.LevelError
|
||||
if errors.Is(err, cert.ErrBlockListed) {
|
||||
level = slog.LevelDebug
|
||||
hm.metricRejectedBlocklisted.Inc(1)
|
||||
}
|
||||
f.l.Log(context.Background(), level, "Failed to process handshake packet", "from", via, "error", err)
|
||||
return
|
||||
}
|
||||
|
||||
@@ -849,6 +856,9 @@ func (hm *HandshakeManager) continueHandshake(via ViaSender, hh *HandshakeHostIn
|
||||
|
||||
response, result, err := machine.ProcessPacket(nil, packet)
|
||||
if err != nil {
|
||||
if errors.Is(err, cert.ErrBlockListed) {
|
||||
hm.metricRejectedBlocklisted.Inc(1)
|
||||
}
|
||||
// Recoverable errors are routine noise, log at Debug. Fatal errors get a Warn.
|
||||
if machine.Failed() {
|
||||
f.l.Warn("Failed to process handshake packet, abandoning",
|
||||
|
||||
@@ -1,12 +1,17 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"log/slog"
|
||||
"net/netip"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/flynn/noise"
|
||||
"github.com/gaissmai/bart"
|
||||
"github.com/rcrowley/go-metrics"
|
||||
"github.com/slackhq/nebula/cert"
|
||||
ct "github.com/slackhq/nebula/cert_test"
|
||||
"github.com/slackhq/nebula/handshake"
|
||||
"github.com/slackhq/nebula/header"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/slackhq/nebula/udp"
|
||||
@@ -235,6 +240,89 @@ func TestHandleIncomingDispatch(t *testing.T) {
|
||||
})
|
||||
}
|
||||
|
||||
func TestBlocklistedHandshakeLogLevelAndCounter(t *testing.T) {
|
||||
ca, _, caKey, _ := ct.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
pool := ct.NewTestCAPool(ca)
|
||||
|
||||
newCredential := func(name, network string) (cert.Certificate, *handshake.Credential) {
|
||||
c, _, rawKey, _ := ct.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca, caKey,
|
||||
name, ca.NotBefore(), ca.NotAfter(), []netip.Prefix{netip.MustParsePrefix(network)}, nil, nil)
|
||||
privateKey, _, _, err := cert.UnmarshalPrivateKeyFromPEM(rawKey)
|
||||
require.NoError(t, err)
|
||||
certBytes, err := c.MarshalForHandshakes()
|
||||
require.NoError(t, err)
|
||||
cipherSuite := noise.NewCipherSuite(noise.DH25519, noise.CipherChaChaPoly, noise.HashSHA256)
|
||||
return c, handshake.NewCredential(c, certBytes, privateKey, cipherSuite)
|
||||
}
|
||||
|
||||
initiatorCert, initiatorCredential := newCredential("initiator", "10.0.0.1/24")
|
||||
responderCert, responderCredential := newCredential("responder", "10.0.0.2/24")
|
||||
fingerprint, err := initiatorCert.Fingerprint()
|
||||
require.NoError(t, err)
|
||||
pool.BlocklistFingerprint(fingerprint)
|
||||
|
||||
initiator, err := handshake.NewMachine(cert.Version2,
|
||||
func(cert.Version) *handshake.Credential { return initiatorCredential },
|
||||
func(c cert.Certificate) (*cert.CachedCertificate, error) {
|
||||
return pool.VerifyCertificate(time.Now(), c)
|
||||
},
|
||||
func() (uint32, error) { return 1, nil }, true, header.HandshakeIXPSK0)
|
||||
require.NoError(t, err)
|
||||
packet, err := initiator.Initiate(nil)
|
||||
require.NoError(t, err)
|
||||
|
||||
handler := &capturingHandler{}
|
||||
logger := slog.New(handler)
|
||||
pki := &PKI{}
|
||||
pki.cs.Store(&CertState{initiatingVersion: cert.Version2, v2Credential: responderCredential})
|
||||
pki.caPool.Store(pool)
|
||||
hm := NewHandshakeManager(logger, nil, nil, nil, defaultHandshakeConfig)
|
||||
hm.metricRejectedBlocklisted = metrics.NewCounter()
|
||||
hm.f = &Interface{pki: pki, l: logger}
|
||||
via := ViaSender{UdpAddr: netip.MustParseAddrPort("198.51.100.7:4242")}
|
||||
|
||||
hm.beginHandshake(via, packet, nil)
|
||||
entry := findEntry(t, handler.entries, "Failed to process handshake packet")
|
||||
assert.Equal(t, slog.LevelDebug, entry.Level)
|
||||
require.ErrorIs(t, entry.Attrs["error"].(error), cert.ErrBlockListed)
|
||||
assert.Equal(t, int64(1), hm.metricRejectedBlocklisted.Count())
|
||||
|
||||
handler.entries = nil
|
||||
hm.beginHandshake(via, nil, nil)
|
||||
entry = findEntry(t, handler.entries, "Failed to process handshake packet")
|
||||
assert.Equal(t, slog.LevelError, entry.Level)
|
||||
assert.Equal(t, int64(1), hm.metricRejectedBlocklisted.Count())
|
||||
|
||||
// The initiator sees the same rejection in continueHandshake, after a
|
||||
// responder has accepted its first packet and sent a valid reply.
|
||||
cleanPool := ct.NewTestCAPool(ca)
|
||||
responder, err := handshake.NewMachine(cert.Version2,
|
||||
func(cert.Version) *handshake.Credential { return responderCredential },
|
||||
func(c cert.Certificate) (*cert.CachedCertificate, error) {
|
||||
return cleanPool.VerifyCertificate(time.Now(), c)
|
||||
},
|
||||
func() (uint32, error) { return 2, nil }, false, header.HandshakeIXPSK0)
|
||||
require.NoError(t, err)
|
||||
response, _, err := responder.ProcessPacket(nil, packet)
|
||||
require.NoError(t, err)
|
||||
|
||||
responderFingerprint, err := responderCert.Fingerprint()
|
||||
require.NoError(t, err)
|
||||
pool.BlocklistFingerprint(responderFingerprint)
|
||||
|
||||
initiatingHM := NewHandshakeManager(logger, nil, nil, nil, defaultHandshakeConfig)
|
||||
initiatingHM.metricRejectedBlocklisted = metrics.NewCounter()
|
||||
initiatingHM.f = &Interface{l: logger}
|
||||
hh := &HandshakeHostInfo{
|
||||
machine: initiator,
|
||||
hostinfo: &HostInfo{localIndexId: 1, vpnAddrs: []netip.Addr{netip.MustParseAddr("10.0.0.2")}},
|
||||
}
|
||||
initiatingHM.indexes[1] = hh
|
||||
via.IsRelayed = true // skip the remote allow list before certificate validation
|
||||
initiatingHM.continueHandshake(via, hh, response)
|
||||
assert.Equal(t, int64(1), initiatingHM.metricRejectedBlocklisted.Count())
|
||||
}
|
||||
|
||||
// Test_PendingHandshakeHasRemotes covers create-tunnel -address: a pending hostinfo must already
|
||||
// carry its RemoteList when StartHandshake runs its callback, so SetRemote there, before the
|
||||
// handshake loop has run, is safe and the address becomes one the handshake is sent to.
|
||||
|
||||
+235
@@ -0,0 +1,235 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"net/netip"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/commands"
|
||||
)
|
||||
|
||||
type identityFlags struct {
|
||||
Address string
|
||||
|
||||
// addressSet records that -address was given at all, so a line that left it out is
|
||||
// told to pass it and one that passed it empty is told the value did not parse. Neither
|
||||
// is answered with this node's identity, which is whoami's to report: a program
|
||||
// passing a connection's remote address through must get an error for a value it
|
||||
// failed to fill in, not the daemon's own identity to authorize against.
|
||||
addressSet bool
|
||||
}
|
||||
|
||||
// setAddress is -address's setter. flag.Func rather than StringVar so that presence is
|
||||
// known; its String is empty, which is what a client building a line from the schema
|
||||
// sees as the default.
|
||||
func (f *identityFlags) setAddress(v string) error {
|
||||
f.Address = v
|
||||
f.addressSet = true
|
||||
return nil
|
||||
}
|
||||
|
||||
// hostIdentity is what identity reports: the identity a certificate asserts for a host,
|
||||
// and nothing else. Every field is read from a certificate nebula verified when the
|
||||
// tunnel came up, or from our own, which is what lets a program on this host make an
|
||||
// authorization decision from it, within one limit. Nebula drops an inbound packet
|
||||
// whose source address is not in the sender's certificate, and one with an overlay
|
||||
// source address that arrived through a peer's unsafe network rather than from the node
|
||||
// holding it, so for a connection that arrived on the nebula interface the source
|
||||
// address is the sender's and this is the sender's identity. A connection that arrived
|
||||
// on any other interface with an overlay source address was never checked by nebula at
|
||||
// all, so a program authorizing on this answer should confirm the connection came in
|
||||
// on the nebula interface. The field names are an API: the info API serves this shape
|
||||
// to programs that were not built against nebula.
|
||||
type hostIdentity struct {
|
||||
Name string `json:"name"`
|
||||
VpnAddrs []netip.Addr `json:"vpnAddrs"`
|
||||
Networks []netip.Prefix `json:"networks"`
|
||||
UnsafeNetworks []netip.Prefix `json:"unsafeNetworks"`
|
||||
Groups []string `json:"groups"`
|
||||
Fingerprint string `json:"fingerprint"`
|
||||
Issuer string `json:"issuer"`
|
||||
NotBefore time.Time `json:"notBefore"`
|
||||
NotAfter time.Time `json:"notAfter"`
|
||||
CertVersion int `json:"certVersion"`
|
||||
}
|
||||
|
||||
// runIdentity answers for whoever owns the address: this node, when it is one of ours, or
|
||||
// the peer behind an established tunnel. The address is required. This node's own
|
||||
// identity is whoami's to report, so a caller that failed to pass an address is told so
|
||||
// rather than handed an identity it could mistake for its peer's.
|
||||
func runIdentity(ifce *Interface, args *identityFlags, a []string) (commands.Result, error) {
|
||||
// print-cert takes its address as an operand; this takes a flag, because the query
|
||||
// string of the info API names its parameters and an operand has no name there. One
|
||||
// spelling on every surface, so the mistake is named rather than ignored.
|
||||
if len(a) > 0 {
|
||||
return commands.Failed("identity takes the vpn addr as -address, not as an operand: identity -address %s", a[0]), nil
|
||||
}
|
||||
|
||||
if !args.addressSet {
|
||||
return commands.Failed("No vpn addr was provided, use -address <vpn addr>[:port]; whoami prints this node's own identity"), nil
|
||||
}
|
||||
|
||||
vpnAddr, err := parseVpnAddrWithOptionalPort(args.Address)
|
||||
if err != nil {
|
||||
return commands.Failed("The provided vpn addr could not be parsed: %s", args.Address), nil
|
||||
}
|
||||
|
||||
crt, fingerprint := findCertificateForVpnAddr(ifce.pki.getCertState(), ifce.hostMap, vpnAddr)
|
||||
if crt == nil {
|
||||
return commands.NotFound("No active tunnel for vpn addr: %s", vpnAddr), nil
|
||||
}
|
||||
|
||||
id, err := newHostIdentity(crt, fingerprint)
|
||||
if err != nil {
|
||||
return commands.Result{}, err
|
||||
}
|
||||
|
||||
return commands.Value(id), nil
|
||||
}
|
||||
|
||||
// runWhoami answers with this node's own identity, from its own certificate.
|
||||
func runWhoami(ifce *Interface) (commands.Result, error) {
|
||||
crt := ownCertificate(ifce.pki.getCertState())
|
||||
if crt == nil {
|
||||
return commands.Failed("No certificate is loaded"), nil
|
||||
}
|
||||
|
||||
id, err := newHostIdentity(crt, "")
|
||||
if err != nil {
|
||||
return commands.Result{}, err
|
||||
}
|
||||
|
||||
return commands.Value(id), nil
|
||||
}
|
||||
|
||||
// textIdentity is the human rendering, shared by every surface.
|
||||
func textIdentity(id hostIdentity, w io.Writer) error {
|
||||
_, err := fmt.Fprintf(w,
|
||||
"name: %s\nvpn addrs: %s\nnetworks: %s\nunsafe networks: %s\ngroups: %s\nfingerprint: %s\nissuer: %s\nnot before: %s\nnot after: %s\ncert version: %d\n",
|
||||
id.Name,
|
||||
joinStringers(id.VpnAddrs),
|
||||
joinStringers(id.Networks),
|
||||
joinStringers(id.UnsafeNetworks),
|
||||
strings.Join(id.Groups, ", "),
|
||||
id.Fingerprint,
|
||||
id.Issuer,
|
||||
id.NotBefore.Format(time.RFC3339),
|
||||
id.NotAfter.Format(time.RFC3339),
|
||||
id.CertVersion,
|
||||
)
|
||||
return err
|
||||
}
|
||||
|
||||
func joinStringers[T fmt.Stringer](in []T) string {
|
||||
parts := make([]string, 0, len(in))
|
||||
for _, v := range in {
|
||||
parts = append(parts, v.String())
|
||||
}
|
||||
return strings.Join(parts, ", ")
|
||||
}
|
||||
|
||||
// newHostIdentity reads the identity out of a certificate. fingerprint is the
|
||||
// certificate's when the caller already holds it, as a verified peer certificate does,
|
||||
// and "" to have it hashed here. Slices are always allocated so a host with no groups
|
||||
// reports [] rather than null.
|
||||
func newHostIdentity(crt cert.Certificate, fingerprint string) (hostIdentity, error) {
|
||||
if fingerprint == "" {
|
||||
fp, err := crt.Fingerprint()
|
||||
if err != nil {
|
||||
return hostIdentity{}, err
|
||||
}
|
||||
fingerprint = fp
|
||||
}
|
||||
|
||||
networks, unsafeNetworks, groups := crt.Networks(), crt.UnsafeNetworks(), crt.Groups()
|
||||
id := hostIdentity{
|
||||
Name: crt.Name(),
|
||||
VpnAddrs: make([]netip.Addr, 0, len(networks)),
|
||||
Networks: append(make([]netip.Prefix, 0, len(networks)), networks...),
|
||||
UnsafeNetworks: append(make([]netip.Prefix, 0, len(unsafeNetworks)), unsafeNetworks...),
|
||||
Groups: append(make([]string, 0, len(groups)), groups...),
|
||||
Fingerprint: fingerprint,
|
||||
Issuer: crt.Issuer(),
|
||||
NotBefore: crt.NotBefore(),
|
||||
NotAfter: crt.NotAfter(),
|
||||
CertVersion: int(crt.Version()),
|
||||
}
|
||||
for _, n := range networks {
|
||||
id.VpnAddrs = append(id.VpnAddrs, n.Addr())
|
||||
}
|
||||
|
||||
return id, nil
|
||||
}
|
||||
|
||||
// ownCertificate is this node's certificate: the v2 one when it is loaded, else the v1.
|
||||
// A v2 certificate is a superset of the v1 and may carry more networks, and it is the
|
||||
// one newCertState builds myVpnAddrsTable from, so an address that matched that table is
|
||||
// always listed in the certificate reported here. It is nil only when no certificate is
|
||||
// loaded, which a running nebula never has.
|
||||
func ownCertificate(cs *CertState) cert.Certificate {
|
||||
if cs == nil {
|
||||
return nil
|
||||
}
|
||||
if crt := cs.getCertificate(cert.Version2); crt != nil {
|
||||
return crt
|
||||
}
|
||||
return cs.getCertificate(cert.Version1)
|
||||
}
|
||||
|
||||
// findCertificateForVpnAddr answers who owns a vpn address: this node, from its own
|
||||
// certificate state, since the hostmap never carries an entry for ourselves, or the peer
|
||||
// behind an established tunnel. The certificate is nil when the address is unknown,
|
||||
// when the tunnel is still pending and when it is mid teardown. A peer's comes with the
|
||||
// fingerprint nebula computed when it verified the certificate; our own comes with "",
|
||||
// since none is kept for it. identity and print-cert go through it, and the lighthouse's
|
||||
// DNS TXT lookup through the two halves, so no surface disagrees about whose address it
|
||||
// is; the TXT record alone keeps answering with the certificate handshakes start with.
|
||||
func findCertificateForVpnAddr(cs *CertState, hostMap *HostMap, ip netip.Addr) (crt cert.Certificate, fingerprint string) {
|
||||
if ownsVpnAddr(cs, ip) {
|
||||
return ownCertificate(cs), ""
|
||||
}
|
||||
return peerCertificateForVpnAddr(hostMap, ip)
|
||||
}
|
||||
|
||||
// ownsVpnAddr reports whether ip is one of this node's own vpn addresses.
|
||||
func ownsVpnAddr(cs *CertState, ip netip.Addr) bool {
|
||||
return cs != nil && cs.myVpnAddrsTable != nil && cs.myVpnAddrsTable.Contains(ip)
|
||||
}
|
||||
|
||||
// peerCertificateForVpnAddr is the certificate of the peer behind an established tunnel
|
||||
// to ip, with the fingerprint nebula computed when it verified it, or nil when there is
|
||||
// no such tunnel. See findCertificateForVpnAddr.
|
||||
func peerCertificateForVpnAddr(hostMap *HostMap, ip netip.Addr) (crt cert.Certificate, fingerprint string) {
|
||||
hostinfo := hostMap.QueryVpnAddr(ip)
|
||||
if hostinfo == nil {
|
||||
return nil, ""
|
||||
}
|
||||
|
||||
cc := hostinfo.GetCert()
|
||||
if cc == nil {
|
||||
return nil, ""
|
||||
}
|
||||
|
||||
return cc.Certificate, cc.Fingerprint
|
||||
}
|
||||
|
||||
// parseVpnAddrWithOptionalPort reads a vpn address alone or with a port,
|
||||
// 192.168.100.7:54321 or [fd00::1]:443, so a program can pass a connection's remote
|
||||
// address through as its runtime reported it. A 4in6 address (::ffff:a.b.c.d) is
|
||||
// unmapped, which is how an IPv4 peer arrives on a dual stack listener, and a zone is
|
||||
// dropped, since no vpn address carries one.
|
||||
func parseVpnAddrWithOptionalPort(s string) (netip.Addr, error) {
|
||||
ip, err := netip.ParseAddr(s)
|
||||
if err != nil {
|
||||
ap, err := netip.ParseAddrPort(s)
|
||||
if err != nil {
|
||||
return netip.Addr{}, err
|
||||
}
|
||||
ip = ap.Addr()
|
||||
}
|
||||
|
||||
return ip.Unmap().WithZone(""), nil
|
||||
}
|
||||
@@ -0,0 +1,223 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"net/netip"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/cert_test"
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// identityFixture is an Interface with our own certificate loaded and one peer behind an
|
||||
// established tunnel, which is all identity reads.
|
||||
func identityFixture(t *testing.T) (*Interface, cert.Certificate) {
|
||||
t.Helper()
|
||||
|
||||
l := test.NewLogger()
|
||||
me := netip.MustParseAddr("10.0.0.1")
|
||||
peer := netip.MustParsePrefix("10.0.0.2/24")
|
||||
|
||||
ca, _, caKey, _ := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
peerCert, _, _, _ := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca, caKey, "peer", time.Time{}, time.Time{},
|
||||
[]netip.Prefix{peer}, []netip.Prefix{netip.MustParsePrefix("192.168.1.0/24")}, []string{"web", "db"})
|
||||
|
||||
hm := newHostMap(l)
|
||||
hm.Hosts[peer.Addr()] = &HostInfo{
|
||||
vpnAddrs: []netip.Addr{peer.Addr()},
|
||||
ConnectionState: &ConnectionState{peerCert: &cert.CachedCertificate{Certificate: peerCert}},
|
||||
}
|
||||
// A tunnel still handshaking has no certificate yet, and must not be reported.
|
||||
hm.Hosts[netip.MustParseAddr("10.0.0.3")] = &HostInfo{
|
||||
vpnAddrs: []netip.Addr{netip.MustParseAddr("10.0.0.3")},
|
||||
ConnectionState: &ConnectionState{},
|
||||
}
|
||||
|
||||
return &Interface{pki: newTestPKI(t, "me", []netip.Addr{me}), hostMap: hm}, peerCert
|
||||
}
|
||||
|
||||
// identity runs the command with -address given as address.
|
||||
func identity(t *testing.T, f *Interface, address string, operands ...string) commands.Result {
|
||||
t.Helper()
|
||||
fs := &identityFlags{}
|
||||
require.NoError(t, fs.setAddress(address))
|
||||
r, err := runIdentity(f, fs, operands)
|
||||
require.NoError(t, err)
|
||||
return r
|
||||
}
|
||||
|
||||
// whoami runs the whoami command.
|
||||
func whoami(t *testing.T, f *Interface) commands.Result {
|
||||
t.Helper()
|
||||
r, err := runWhoami(f)
|
||||
require.NoError(t, err)
|
||||
return r
|
||||
}
|
||||
|
||||
// TestWhoamiWithoutACertificateRefuses: no certificate is a refusal with the reason, as
|
||||
// print-cert answers it, not an error a surface collapses to "command failed".
|
||||
func TestWhoamiWithoutACertificateRefuses(t *testing.T) {
|
||||
r := whoami(t, &Interface{pki: &PKI{}})
|
||||
assert.False(t, r.OK)
|
||||
assert.Equal(t, "No certificate is loaded", r.Reason)
|
||||
}
|
||||
|
||||
func TestWhoamiReportsThisNode(t *testing.T) {
|
||||
f, _ := identityFixture(t)
|
||||
|
||||
r := whoami(t, f)
|
||||
require.True(t, r.OK)
|
||||
id, ok := r.Value.(hostIdentity)
|
||||
require.True(t, ok, "got %T", r.Value)
|
||||
assert.Equal(t, "me", id.Name)
|
||||
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.0.0.1")}, id.VpnAddrs)
|
||||
assert.Equal(t, 2, id.CertVersion)
|
||||
assert.NotEmpty(t, id.Fingerprint)
|
||||
assert.NotEmpty(t, id.Issuer)
|
||||
|
||||
// Our own address answers the same way: the hostmap never holds ourselves.
|
||||
self := identity(t, f, "10.0.0.1")
|
||||
assert.Equal(t, id, self.Value)
|
||||
}
|
||||
|
||||
func TestIdentityReportsAPeerFromItsCertificate(t *testing.T) {
|
||||
f, peerCert := identityFixture(t)
|
||||
|
||||
for _, addr := range []string{
|
||||
"10.0.0.2",
|
||||
"10.0.0.2:54321", // a connection's RemoteAddr, as a server has it
|
||||
"::ffff:10.0.0.2", // the same peer seen through a dual stack listener
|
||||
"[::ffff:10.0.0.2]:8", // and with a port
|
||||
} {
|
||||
r := identity(t, f, addr)
|
||||
require.True(t, r.OK, "%s: %s", addr, r.Reason)
|
||||
id := r.Value.(hostIdentity)
|
||||
assert.Equal(t, "peer", id.Name, addr)
|
||||
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.0.0.2")}, id.VpnAddrs, addr)
|
||||
assert.Equal(t, []netip.Prefix{netip.MustParsePrefix("10.0.0.2/24")}, id.Networks, addr)
|
||||
assert.Equal(t, []netip.Prefix{netip.MustParsePrefix("192.168.1.0/24")}, id.UnsafeNetworks, addr)
|
||||
assert.Equal(t, []string{"web", "db"}, id.Groups, addr)
|
||||
assert.Equal(t, peerCert.Issuer(), id.Issuer, addr)
|
||||
assert.Equal(t, peerCert.NotAfter(), id.NotAfter, addr)
|
||||
}
|
||||
}
|
||||
|
||||
// TestIdentityRefusals: the ways a lookup fails are told apart, because a program
|
||||
// deciding whether to let a connection in treats them differently.
|
||||
func TestIdentityRefusals(t *testing.T) {
|
||||
f, _ := identityFixture(t)
|
||||
|
||||
unknown := identity(t, f, "10.0.0.9")
|
||||
assert.False(t, unknown.OK)
|
||||
assert.True(t, unknown.NotFound, "no tunnel is a not found")
|
||||
assert.Equal(t, "No active tunnel for vpn addr: 10.0.0.9", unknown.Reason)
|
||||
|
||||
pending := identity(t, f, "10.0.0.3:1")
|
||||
assert.True(t, pending.NotFound, "a tunnel without a certificate yet is not active")
|
||||
assert.Equal(t, "No active tunnel for vpn addr: 10.0.0.3", pending.Reason, "the reason names the address, not the port")
|
||||
|
||||
garbage := identity(t, f, "not-an-address")
|
||||
assert.False(t, garbage.OK)
|
||||
assert.False(t, garbage.NotFound, "an address that does not parse is the caller's mistake")
|
||||
assert.Equal(t, "The provided vpn addr could not be parsed: not-an-address", garbage.Reason)
|
||||
|
||||
// An address that was given and is empty is a caller that failed to fill it in, and
|
||||
// must not be answered with our own identity.
|
||||
empty := identity(t, f, "")
|
||||
assert.False(t, empty.OK)
|
||||
assert.False(t, empty.NotFound)
|
||||
assert.Equal(t, "The provided vpn addr could not be parsed: ", empty.Reason)
|
||||
|
||||
operand := identity(t, f, "", "10.0.0.2")
|
||||
assert.False(t, operand.OK)
|
||||
assert.Contains(t, operand.Reason, "identity -address 10.0.0.2")
|
||||
|
||||
// No address at all is a caller that forgot the parameter, and is pointed at whoami
|
||||
// rather than handed this node's identity.
|
||||
omitted, err := runIdentity(f, &identityFlags{}, nil)
|
||||
require.NoError(t, err)
|
||||
assert.False(t, omitted.OK)
|
||||
assert.False(t, omitted.NotFound)
|
||||
assert.Contains(t, omitted.Reason, "-address")
|
||||
assert.Contains(t, omitted.Reason, "whoami")
|
||||
}
|
||||
|
||||
// TestOwnCertificatePrefersV2: with both versions loaded, the v2 certificate is the one
|
||||
// myVpnAddrsTable is built from and may carry addresses the v1 does not, so it is the one
|
||||
// whoami and an identity lookup of our own address report, whichever version handshakes
|
||||
// are initiated with.
|
||||
func TestOwnCertificatePrefersV2(t *testing.T) {
|
||||
v4 := netip.MustParsePrefix("10.0.0.1/24")
|
||||
ca1, _, caKey1, _ := cert_test.NewTestCaCert(cert.Version1, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
v1, _, _, _ := cert_test.NewTestCert(cert.Version1, cert.Curve_CURVE25519, ca1, caKey1, "me", time.Time{}, time.Time{}, []netip.Prefix{v4}, nil, nil)
|
||||
ca2, _, caKey2, _ := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||
v2, _, _, _ := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca2, caKey2, "me", time.Time{}, time.Time{},
|
||||
[]netip.Prefix{v4, netip.MustParsePrefix("fd00::1/64")}, nil, nil)
|
||||
|
||||
assert.Nil(t, ownCertificate(nil))
|
||||
assert.Equal(t, v1, ownCertificate(&CertState{v1Cert: v1, initiatingVersion: cert.Version1}))
|
||||
assert.Equal(t, v2, ownCertificate(&CertState{v2Cert: v2, initiatingVersion: cert.Version2}))
|
||||
assert.Equal(t, v2, ownCertificate(&CertState{v1Cert: v1, v2Cert: v2, initiatingVersion: cert.Version1}),
|
||||
"the initiating version is v1, the reported certificate is still the v2")
|
||||
}
|
||||
|
||||
// TestIdentityShapes pins the JSON a program reads and the text a person reads. The
|
||||
// field names are an API served to programs not built against nebula.
|
||||
func TestIdentityShapes(t *testing.T) {
|
||||
f, _ := identityFixture(t)
|
||||
r := identity(t, f, "10.0.0.2")
|
||||
|
||||
b, err := json.Marshal(r.Payload())
|
||||
require.NoError(t, err)
|
||||
var got map[string]any
|
||||
require.NoError(t, json.Unmarshal(b, &got))
|
||||
var keys []string
|
||||
for k := range got {
|
||||
keys = append(keys, k)
|
||||
}
|
||||
assert.ElementsMatch(t, []string{
|
||||
"name", "vpnAddrs", "networks", "unsafeNetworks", "groups",
|
||||
"fingerprint", "issuer", "notBefore", "notAfter", "certVersion",
|
||||
}, keys)
|
||||
|
||||
// Empty lists marshal as [], never null.
|
||||
self := whoami(t, f)
|
||||
b, err = json.Marshal(self.Payload())
|
||||
require.NoError(t, err)
|
||||
assert.Contains(t, string(b), `"groups":[]`)
|
||||
assert.Contains(t, string(b), `"unsafeNetworks":[]`)
|
||||
|
||||
out := &bytes.Buffer{}
|
||||
require.NoError(t, commands.Render(&commands.Command{Name: commands.Identity, Text: commands.Typed(textIdentity)}, r, commands.FormatText, out))
|
||||
assert.Contains(t, out.String(), "name: peer\n")
|
||||
assert.Contains(t, out.String(), "vpn addrs: 10.0.0.2\n")
|
||||
assert.Contains(t, out.String(), "groups: web, db\n")
|
||||
assert.Contains(t, out.String(), "cert version: 2\n")
|
||||
}
|
||||
|
||||
func TestParseVpnAddrWithOptionalPort(t *testing.T) {
|
||||
for in, want := range map[string]string{
|
||||
"10.0.0.2": "10.0.0.2",
|
||||
"10.0.0.2:443": "10.0.0.2",
|
||||
"fd00::1": "fd00::1",
|
||||
"[fd00::1]:443": "fd00::1",
|
||||
"::ffff:10.0.0.2": "10.0.0.2",
|
||||
"[::ffff:10.0.0.2]:1": "10.0.0.2",
|
||||
"fe80::1%eth0": "fe80::1",
|
||||
} {
|
||||
got, err := parseVpnAddrWithOptionalPort(in)
|
||||
require.NoError(t, err, in)
|
||||
assert.Equal(t, netip.MustParseAddr(want), got, in)
|
||||
}
|
||||
|
||||
for _, in := range []string{"", "10.0.0.2:", ":443", "10.0.0", "example.com:80"} {
|
||||
_, err := parseVpnAddrWithOptionalPort(in)
|
||||
assert.Error(t, err, in)
|
||||
}
|
||||
}
|
||||
+64
-14
@@ -124,6 +124,8 @@ type Interface struct {
|
||||
// reused (every udp.Conn ListenOut guarantees that ordering).
|
||||
batchers []*batch.MultiCoalescer
|
||||
wg sync.WaitGroup
|
||||
// readers covers just the listenIn and listenOut goroutines, wg also holds the construction token Close releases
|
||||
readers sync.WaitGroup
|
||||
|
||||
udpTxErrLimiter *ratelimit.Limiter // udp direct transmit error log limiter
|
||||
udpRelayTxErrLimiter *ratelimit.Limiter // udp relay transmit error log limiter
|
||||
@@ -341,14 +343,18 @@ func (f *Interface) activate() error {
|
||||
func (f *Interface) run() {
|
||||
// Launch n queues to read packets from udp
|
||||
for i := 0; i < f.routines; i++ {
|
||||
f.readers.Add(1)
|
||||
f.wg.Go(func() {
|
||||
defer f.readers.Done()
|
||||
f.listenOut(i)
|
||||
})
|
||||
}
|
||||
|
||||
// Launch n queues to read packets from tun dev
|
||||
for i := 0; i < f.routines; i++ {
|
||||
f.readers.Add(1)
|
||||
f.wg.Go(func() {
|
||||
defer f.readers.Done()
|
||||
f.listenIn(f.queues[i], i)
|
||||
})
|
||||
}
|
||||
@@ -537,11 +543,12 @@ func (f *Interface) reloadFirewall(c *config.C, r *config.Reload) {
|
||||
curCert = cs.getCertificate(cert.Version1)
|
||||
}
|
||||
|
||||
// The firewall builds its routableNetworks set from the certificate's UnsafeNetworks at construction.
|
||||
// Check to see if that set has changed, and if so, rebuild the firewall.
|
||||
certUnsafeChanged := curCert != nil && !slices.Equal(curCert.UnsafeNetworks(), f.firewall.unsafeNetworks)
|
||||
|
||||
if !c.HasChanged("firewall") && !certUnsafeChanged {
|
||||
// Compare with what the running firewall was built from, not the last config, so a firewall that failed to build
|
||||
// is tried again. The cert is the one this reload brought, PKI registers its reload callback before this one
|
||||
src := c.Render("firewall")
|
||||
if src != "" && src == f.firewall.source && curCert != nil &&
|
||||
slices.Equal(curCert.Networks(), f.firewall.assignedNetworks) &&
|
||||
slices.Equal(curCert.UnsafeNetworks(), f.firewall.unsafeNetworks) {
|
||||
f.l.Debug("No firewall config change detected")
|
||||
return
|
||||
}
|
||||
@@ -682,6 +689,14 @@ func (f *Interface) GetCertState() *CertState {
|
||||
return f.pki.getCertState()
|
||||
}
|
||||
|
||||
// shutdowner is a udp.Conn or overlay.Device whose readers can be woken without releasing their fds
|
||||
type shutdowner interface {
|
||||
Shutdown() error
|
||||
}
|
||||
|
||||
// readerShutdownTimeout bounds how long Close waits on woken readers before releasing their fds anyway
|
||||
const readerShutdownTimeout = 5 * time.Second
|
||||
|
||||
// Close releases the interface's resources: the udp sockets and the tun device.
|
||||
// It is idempotent and safe to call at any point in the lifecycle, including on an interface that never activated,
|
||||
// calls after the first return nil without doing anything.
|
||||
@@ -691,20 +706,55 @@ func (f *Interface) Close() error {
|
||||
}
|
||||
|
||||
var errs []error
|
||||
|
||||
// Release the udp readers
|
||||
for i, u := range f.writers {
|
||||
err := u.Close()
|
||||
if err != nil {
|
||||
closeUdp := func(i int, u udp.Conn) {
|
||||
if err := u.Close(); err != nil {
|
||||
f.l.Error("Error while closing udp socket", "error", err, "writer", i)
|
||||
errs = append(errs, err)
|
||||
}
|
||||
}
|
||||
closeTun := func() {
|
||||
if err := f.inside.Close(); err != nil {
|
||||
errs = append(errs, err)
|
||||
}
|
||||
}
|
||||
|
||||
// Release the tun device (closing the tun also closes all readers)
|
||||
closeErr := f.inside.Close()
|
||||
if closeErr != nil {
|
||||
errs = append(errs, closeErr)
|
||||
// Wake every reader before releasing any fd, one that loops back into a syscall on a reused fd number never wakes.
|
||||
// Anything without Shutdown is closed right away, as before.
|
||||
var deferred []func()
|
||||
for i, u := range f.writers {
|
||||
if s, ok := u.(shutdowner); ok {
|
||||
if err := s.Shutdown(); err != nil {
|
||||
f.l.Error("Error while shutting down udp socket", "error", err, "writer", i)
|
||||
errs = append(errs, err)
|
||||
}
|
||||
deferred = append(deferred, func() { closeUdp(i, u) })
|
||||
} else {
|
||||
closeUdp(i, u)
|
||||
}
|
||||
}
|
||||
if s, ok := f.inside.(shutdowner); ok {
|
||||
if err := s.Shutdown(); err != nil {
|
||||
errs = append(errs, err)
|
||||
}
|
||||
deferred = append(deferred, closeTun)
|
||||
} else {
|
||||
closeTun()
|
||||
}
|
||||
|
||||
if len(deferred) > 0 {
|
||||
readersDone := make(chan struct{})
|
||||
go func() {
|
||||
f.readers.Wait()
|
||||
close(readersDone)
|
||||
}()
|
||||
select {
|
||||
case <-readersDone:
|
||||
case <-time.After(readerShutdownTimeout):
|
||||
f.l.Warn("Readers did not stop, closing their fds anyway", "timeout", readerShutdownTimeout)
|
||||
}
|
||||
for _, closeFn := range deferred {
|
||||
closeFn()
|
||||
}
|
||||
}
|
||||
|
||||
// Release the construction token so waiters know the resources are gone
|
||||
|
||||
+58
-3
@@ -135,8 +135,63 @@ func TestReloadFirewall_BadRulesFailTheReload(t *testing.T) {
|
||||
f := &Interface{pki: pki, firewall: fw, l: l}
|
||||
cfg.RegisterReloadCallback(f.reloadFirewall)
|
||||
|
||||
res := cfg.ReloadConfigString(rules("nope"))
|
||||
// The running firewall still isn't built from what the config asks for, so the same reload fails again
|
||||
for range 2 {
|
||||
res := cfg.ReloadConfigString(rules("nope"))
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.Failed)
|
||||
assert.Same(t, fw, f.firewall)
|
||||
}
|
||||
|
||||
res := cfg.ReloadConfigString(rules("tcp"))
|
||||
require.NoError(t, res.Err)
|
||||
assert.True(t, res.Failed)
|
||||
assert.Same(t, fw, f.firewall)
|
||||
assert.False(t, res.Failed)
|
||||
assert.NotSame(t, fw, f.firewall)
|
||||
}
|
||||
|
||||
// Every input the firewall is built from rebuilds it when it changes, and nothing else does
|
||||
func TestReloadFirewall_RebuildsOnAnyInput(t *testing.T) {
|
||||
l := test.NewLogger()
|
||||
networks := []netip.Prefix{netip.MustParsePrefix("10.0.0.1/24")}
|
||||
base := "firewall:\n inbound:\n - port: any\n proto: any\n host: any\n"
|
||||
setup := func() (*config.C, *Interface, *PKI) {
|
||||
pki := &PKI{}
|
||||
pki.cs.Store(&CertState{v2Cert: &dummyCert{version: cert.Version2, networks: networks}, initiatingVersion: cert.Version2})
|
||||
cfg := config.NewC(l)
|
||||
require.NoError(t, cfg.LoadString(base))
|
||||
fw, err := NewFirewallFromConfig(l, pki.getCertState(), cfg)
|
||||
require.NoError(t, err)
|
||||
f := &Interface{pki: pki, firewall: fw, l: l}
|
||||
cfg.RegisterReloadCallback(f.reloadFirewall)
|
||||
return cfg, f, pki
|
||||
}
|
||||
setCert := func(pki *PKI, networks, unsafe []netip.Prefix) {
|
||||
pki.cs.Store(&CertState{v2Cert: &dummyCert{version: cert.Version2, networks: networks, unsafeNetworks: unsafe}, initiatingVersion: cert.Version2})
|
||||
}
|
||||
|
||||
cases := map[string]struct {
|
||||
cfg string
|
||||
cert func(*PKI)
|
||||
want bool
|
||||
}{
|
||||
"nothing": {base + "punchy:\n punch: true\n", nil, false},
|
||||
"rules": {base + " outbound:\n - port: any\n proto: any\n host: any\n", nil, true},
|
||||
"inbound_action": {base + " inbound_action: reject\n", nil, true},
|
||||
"conntrack": {base + " conntrack:\n tcp_timeout: 1m\n", nil, true},
|
||||
"networks": {base, func(p *PKI) { setCert(p, []netip.Prefix{netip.MustParsePrefix("10.0.0.2/24")}, nil) }, true},
|
||||
"unsafe_networks": {base, func(p *PKI) { setCert(p, networks, []netip.Prefix{netip.MustParsePrefix("192.168.0.0/24")}) }, true},
|
||||
}
|
||||
for name, tc := range cases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
cfg, f, pki := setup()
|
||||
old := f.firewall
|
||||
if tc.cert != nil {
|
||||
tc.cert(pki)
|
||||
}
|
||||
res := cfg.ReloadConfigString(tc.cfg)
|
||||
require.NoError(t, res.Err)
|
||||
assert.False(t, res.Failed)
|
||||
assert.Equal(t, tc.want, f.firewall != old)
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
)
|
||||
|
||||
// Access is who may reach a socket beyond the account nebula runs as: the node's mode,
|
||||
// and the group that shares the socket when the config names one.
|
||||
//
|
||||
// It is the dockerd model (-G): the operator names a group, nebula hands the socket to
|
||||
// it, and who is in the group is managed outside nebula. On unix the mode is the
|
||||
// socket node's and the group becomes its owning group; on windows the group is an
|
||||
// entry in the pipe's security descriptor and the mode means nothing to a pipe.
|
||||
type Access struct {
|
||||
Mode os.FileMode
|
||||
Group Group
|
||||
}
|
||||
|
||||
// Group is a group named in the config, resolved to what the platform checks. The zero
|
||||
// Group is none.
|
||||
type Group struct {
|
||||
// Name is what the config said.
|
||||
Name string
|
||||
|
||||
// ID is the platform's identifier for it: a gid on unix, a SID on windows.
|
||||
ID string
|
||||
}
|
||||
|
||||
const (
|
||||
// ownerOnlyMode is a socket's mode when no group shares it: the account nebula runs
|
||||
// as, and nobody else.
|
||||
ownerOnlyMode os.FileMode = 0600
|
||||
|
||||
// groupSocketMode is the mode a socket takes when a group shares it and the config
|
||||
// names no other: the account nebula runs as and the group, and nobody else.
|
||||
groupSocketMode os.FileMode = 0660
|
||||
)
|
||||
|
||||
// errReopenForAccess is returned by applyAccess on a platform whose access control is
|
||||
// fixed when the endpoint is created, so a change means creating it again.
|
||||
var errReopenForAccess = errors.New("access is fixed at listen time")
|
||||
|
||||
// ownerOnly is the control socket's access when no group is configured. The mode
|
||||
// itself is not configurable there; what an operator can choose is a group,
|
||||
// CtlGroupKey, which makes it groupSocketMode.
|
||||
func ownerOnly() Access { return Access{Mode: ownerOnlyMode} }
|
||||
|
||||
// shared reports whether a group shares the socket.
|
||||
func (a Access) shared() bool { return a.Group.ID != "" }
|
||||
|
||||
// String renders the access for a log line.
|
||||
func (a Access) String() string {
|
||||
if !a.shared() {
|
||||
return modeString(a.Mode)
|
||||
}
|
||||
return fmt.Sprintf("%s group %s (%s)", modeString(a.Mode), a.Group.Name, a.Group.ID)
|
||||
}
|
||||
|
||||
// groupFromConfig reads the group a key names, the zero Group when it names none. The
|
||||
// name is resolved here, when the config is read, so a group that does not exist is a
|
||||
// config error reported with the key rather than a bind that fails later.
|
||||
func groupFromConfig(c interface{ GetString(string, string) string }, key string) (Group, error) {
|
||||
name := c.GetString(key, "")
|
||||
if name == "" {
|
||||
return Group{}, nil
|
||||
}
|
||||
|
||||
id, err := lookupGroupID(name)
|
||||
if err != nil {
|
||||
return Group{}, fmt.Errorf("%s: %w", key, err)
|
||||
}
|
||||
return Group{Name: name, ID: id}, nil
|
||||
}
|
||||
|
||||
func modeString(m os.FileMode) string {
|
||||
return fmt.Sprintf("%04o", m)
|
||||
}
|
||||
@@ -0,0 +1,208 @@
|
||||
//go:build !windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os"
|
||||
"os/user"
|
||||
"strconv"
|
||||
"syscall"
|
||||
"testing"
|
||||
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// ownGroup returns a group this process may hand a socket to: its own effective group,
|
||||
// by name and by gid, which is the one chown accepts from an unprivileged user.
|
||||
func ownGroup(t *testing.T) (name, gid string) {
|
||||
t.Helper()
|
||||
gid = strconv.Itoa(os.Getegid())
|
||||
g, err := user.LookupGroupId(gid)
|
||||
require.NoError(t, err)
|
||||
return g.Name, gid
|
||||
}
|
||||
|
||||
func socketGroup(t *testing.T, path string) uint32 {
|
||||
t.Helper()
|
||||
fi, err := os.Lstat(path)
|
||||
require.NoError(t, err)
|
||||
st, ok := fi.Sys().(*syscall.Stat_t)
|
||||
require.True(t, ok)
|
||||
return uint32(st.Gid)
|
||||
}
|
||||
|
||||
// TestLookupGroupID: a group is named as the host names it or by its gid; a gid the
|
||||
// host does not list is accepted as chown would accept it, and a name it does not list
|
||||
// is a mistake to report.
|
||||
func TestLookupGroupID(t *testing.T) {
|
||||
name, gid := ownGroup(t)
|
||||
|
||||
got, err := lookupGroupID(name)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, gid, got)
|
||||
|
||||
got, err = lookupGroupID(gid)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, gid, got)
|
||||
|
||||
got, err = lookupGroupID("4000000000")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "4000000000", got)
|
||||
|
||||
_, err = lookupGroupID("no-such-group-nebula-test")
|
||||
require.ErrorContains(t, err, "does not exist")
|
||||
}
|
||||
|
||||
// TestControlAccessFromConfig: no group is the owner-only socket; a group is 0660 with
|
||||
// that group; a group the host does not know is a config error naming the key.
|
||||
func TestControlAccessFromConfig(t *testing.T) {
|
||||
name, gid := ownGroup(t)
|
||||
load := func(body string) (Access, error) {
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(body))
|
||||
return controlAccessFrom(c)
|
||||
}
|
||||
|
||||
acc, err := load("local_api: {}\n")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, ownerOnly(), acc)
|
||||
|
||||
acc, err = load("local_api:\n control:\n group: " + name + "\n")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0660), acc.Mode)
|
||||
assert.Equal(t, name, acc.Group.Name)
|
||||
assert.Equal(t, gid, acc.Group.ID)
|
||||
|
||||
_, err = load("local_api:\n control:\n group: no-such-group-nebula-test\n")
|
||||
require.ErrorContains(t, err, CtlGroupKey)
|
||||
assert.ErrorContains(t, err, "does not exist")
|
||||
}
|
||||
|
||||
// TestControlSocketIsHandedToTheGroup: the socket is created with the group's gid and
|
||||
// 0660, whatever the umask, and a reload that takes the group away tightens the socket
|
||||
// in place, without moving it. The endpoint is shared, so this covers the info API too.
|
||||
func TestControlSocketIsHandedToTheGroup(t *testing.T) {
|
||||
old := unix.Umask(0077)
|
||||
defer unix.Umask(old)
|
||||
|
||||
name, gid := ownGroup(t)
|
||||
want, err := strconv.ParseUint(gid, 10, 32)
|
||||
require.NoError(t, err)
|
||||
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
path := testSocket(t)
|
||||
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: 0660, Group: Group{Name: name, ID: gid}}))
|
||||
defer s.Stop()
|
||||
|
||||
fi, err := os.Lstat(path)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0660), fi.Mode().Perm())
|
||||
assert.Equal(t, uint32(want), socketGroup(t, path))
|
||||
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
fi, err = os.Lstat(path)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0600), fi.Mode().Perm())
|
||||
assert.Equal(t, path, s.Path())
|
||||
|
||||
_, err = (&Client{Path: path}).Describe()
|
||||
require.NoError(t, err, "the same listener is still serving")
|
||||
}
|
||||
|
||||
// TestControlSocketWithAGroupTrustsTheKernel: with a group sharing the socket, the
|
||||
// kernel's check on connect is the access control and the daemon's peer check stands
|
||||
// aside, so a connection the peer check alone would refuse is served. Without a group
|
||||
// the same connection is refused; see TestPeerCheckRefusesAnotherUser.
|
||||
func TestControlSocketWithAGroupTrustsTheKernel(t *testing.T) {
|
||||
if !peerCheckSupported {
|
||||
t.Skip("no peer credentials on this platform")
|
||||
}
|
||||
name, gid := ownGroup(t)
|
||||
|
||||
me := currentUID()
|
||||
asUID(t, me+1)
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
asUID(t, me)
|
||||
|
||||
path := testSocket(t)
|
||||
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: 0660, Group: Group{Name: name, ID: gid}}))
|
||||
defer s.Stop()
|
||||
|
||||
_, err := (&Client{Path: path}).Describe()
|
||||
require.NoError(t, err, "the socket's group admitted us; the peer check must not refuse")
|
||||
|
||||
// Taking the group away on a reload puts the peer check back.
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
_, err = (&Client{Path: path}).Describe()
|
||||
require.ErrorContains(t, err, "not permitted")
|
||||
}
|
||||
|
||||
// TestInfoAccessFromConfig: a group with no mode is 0660; a mode that gives the group
|
||||
// nothing is refused, with the mode that would; an explicit mode with group bits is
|
||||
// kept as given.
|
||||
func TestInfoAccessFromConfig(t *testing.T) {
|
||||
name, gid := ownGroup(t)
|
||||
load := func(body string) (infoConfig, error) {
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(body))
|
||||
return infoConfigFrom(c)
|
||||
}
|
||||
section := func(extra string) string {
|
||||
return "local_api:\n info:\n enabled: true\n socket: /run/nebula/info.sock\n" + extra
|
||||
}
|
||||
|
||||
cfg, err := load(section(" group: " + name + "\n"))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0660), cfg.Access.Mode)
|
||||
assert.Equal(t, gid, cfg.Access.Group.ID)
|
||||
|
||||
cfg, err = load(section(" group: " + name + "\n socket_mode: \"0664\"\n"))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0664), cfg.Access.Mode)
|
||||
|
||||
_, err = load(section(" group: " + name + "\n socket_mode: \"0600\"\n"))
|
||||
require.ErrorContains(t, err, "gives group "+name+" no access")
|
||||
require.ErrorContains(t, err, `"0660"`)
|
||||
|
||||
cfg, err = load(section(""))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, ownerOnly(), cfg.Access)
|
||||
}
|
||||
|
||||
// TestRemovingTheGroupHandsTheSocketBack: a reload that drops the group key leaves the
|
||||
// mode the operator set but returns the socket to the daemon's own group, so the old
|
||||
// group's members are no longer admitted. The socket is first handed to a group this
|
||||
// process belongs to other than its own, which not every host offers.
|
||||
func TestRemovingTheGroupHandsTheSocketBack(t *testing.T) {
|
||||
own := os.Getegid()
|
||||
groups, err := os.Getgroups()
|
||||
require.NoError(t, err)
|
||||
other := -1
|
||||
for _, g := range groups {
|
||||
if g != own {
|
||||
other = g
|
||||
break
|
||||
}
|
||||
}
|
||||
if other < 0 {
|
||||
t.Skip("this process belongs to no group but its own")
|
||||
}
|
||||
gid := strconv.Itoa(other)
|
||||
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
path := testSocket(t)
|
||||
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: 0660, Group: Group{Name: gid, ID: gid}}))
|
||||
defer s.Stop()
|
||||
assert.Equal(t, uint32(other), socketGroup(t, path))
|
||||
|
||||
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: 0660}))
|
||||
assert.Equal(t, uint32(own), socketGroup(t, path), "the daemon's own group again")
|
||||
fi, err := os.Lstat(path)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0660), fi.Mode().Perm(), "the mode is the operator's")
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
//go:build windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"golang.org/x/sys/windows"
|
||||
)
|
||||
|
||||
// TestLookupGroupIDOnWindows: an account name resolves to its SID, a SID written out
|
||||
// is accepted as it is, and an account the host does not know is reported.
|
||||
func TestLookupGroupIDOnWindows(t *testing.T) {
|
||||
users, err := windows.CreateWellKnownSid(windows.WinBuiltinUsersSid)
|
||||
require.NoError(t, err)
|
||||
|
||||
got, err := lookupGroupID("Users")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, users.String(), got)
|
||||
|
||||
got, err = lookupGroupID(users.String())
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, users.String(), got)
|
||||
|
||||
_, err = lookupGroupID("no-such-account-nebula-test")
|
||||
require.ErrorContains(t, err, "does not exist")
|
||||
}
|
||||
|
||||
// TestSDDLAdmitsTheGroup: the descriptor is the owner, SYSTEM and Administrators with
|
||||
// full access, plus the group with what a client needs and nothing generic, so a
|
||||
// member cannot create an instance of the pipe; see pipeClientAccess.
|
||||
func TestSDDLAdmitsTheGroup(t *testing.T) {
|
||||
sddl, err := sddlFor(ownerOnly())
|
||||
require.NoError(t, err)
|
||||
assert.NotContains(t, sddl, "S-1-5-32-545")
|
||||
|
||||
sddl, err = sddlFor(Access{Mode: groupSocketMode, Group: Group{Name: "Users", ID: "S-1-5-32-545"}})
|
||||
require.NoError(t, err)
|
||||
assert.Contains(t, sddl, "(A;;GA;;;SY)(A;;GA;;;BA)(A;;0x120083;;;S-1-5-32-545)")
|
||||
assert.Zero(t, pipeClientAccess&windows.FILE_APPEND_DATA, "FILE_APPEND_DATA is FILE_CREATE_PIPE_INSTANCE on a pipe")
|
||||
assert.Zero(t, pipeClientAccess&(windows.GENERIC_READ|windows.GENERIC_WRITE|windows.GENERIC_ALL))
|
||||
}
|
||||
|
||||
// TestUnprotectedNameWarning: a pipe outside the protected namespace is warned about,
|
||||
// since anyone could have created the name first; one under it, however spelled, is not.
|
||||
func TestUnprotectedNameWarning(t *testing.T) {
|
||||
assert.Empty(t, unprotectedNameWarning(DefaultSocketPath))
|
||||
assert.Empty(t, unprotectedNameWarning(`\\.\PIPE\protectedprefix\administrators\nebula-info`))
|
||||
assert.Contains(t, unprotectedNameWarning(`\\.\pipe\nebula-info`), protectedPrefix)
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
//go:build darwin || freebsd || netbsd || openbsd
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"os"
|
||||
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// applyAccess sets the owning group and the mode of the socket node at path, and of
|
||||
// nothing a link at path names. The node is looked at without following links and must
|
||||
// be a socket of ours; the chown and the chmod are fchownat and fchmodat with
|
||||
// AT_SYMLINK_NOFOLLOW, which these kernels honour, so a symlink put at path in the one
|
||||
// syscall between the look and either call gets its own group or mode changed, which
|
||||
// means nothing, and not its target's. A socket cannot be opened, and there is no O_PATH
|
||||
// here to hold the inode across the calls the way the linux side does, so a hard link
|
||||
// to a file of somebody's choosing swapped in during that one syscall would be changed;
|
||||
// that needs the file on the socket's filesystem and the right to link to it, which
|
||||
// darwin and the BSDs grant to any user by default.
|
||||
func applyAccess(path string, acc Access) error {
|
||||
fi, err := os.Lstat(path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if err := checkOwnSocket(path, fi); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// With no group configured the socket is handed back to the daemon's own group, so a
|
||||
// reload that drops the key takes the access away; see the linux side.
|
||||
gid, err := gidFor(acc)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if err := unix.Fchownat(unix.AT_FDCWD, path, -1, gid, unix.AT_SYMLINK_NOFOLLOW); err != nil {
|
||||
return &os.PathError{Op: "chown", Path: path, Err: err}
|
||||
}
|
||||
|
||||
if err := unix.Fchmodat(unix.AT_FDCWD, path, uint32(acc.Mode.Perm()), unix.AT_SYMLINK_NOFOLLOW); err != nil {
|
||||
return &os.PathError{Op: "chmod", Path: path, Err: err}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,83 @@
|
||||
//go:build linux
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"strconv"
|
||||
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// applyAccess sets the owning group and the mode of the socket node at path, and of
|
||||
// nothing else. The node is opened O_PATH, which takes a reference to the inode without
|
||||
// opening the socket itself (a socket cannot be opened, and O_PATH does not try), and
|
||||
// O_NOFOLLOW, so a symlink at path is a refusal rather than a target. What the
|
||||
// descriptor holds is checked to be a socket of ours, and the chown and the chmod are
|
||||
// then made through /proc/self/fd, which names that inode whatever is at path by then:
|
||||
// a node swapped between the look and the change, for a link or for a hard link to a
|
||||
// file of somebody's choosing, is not what gets the group or the mode. This is how
|
||||
// glibc implements fchmodat(AT_SYMLINK_NOFOLLOW) too.
|
||||
//
|
||||
// Without /proc the change falls back to fchownat and fchmodat2, which do not follow a
|
||||
// link but are by path again, so a swap in the one syscall between the check and each
|
||||
// would be changed. Older than kernel 6.6 with no /proc, the mode is not set and the
|
||||
// socket is not served.
|
||||
func applyAccess(path string, acc Access) error {
|
||||
// The look is for the message: a link or a plain file is named as what it is, which
|
||||
// the O_PATH open's ELOOP or the fstat below would say less well.
|
||||
fi, err := os.Lstat(path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if err := checkOwnSocket(path, fi); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fd, err := unix.Open(path, unix.O_PATH|unix.O_NOFOLLOW|unix.O_CLOEXEC, 0)
|
||||
if err != nil {
|
||||
return &os.PathError{Op: "open", Path: path, Err: err}
|
||||
}
|
||||
defer unix.Close(fd)
|
||||
|
||||
// What the descriptor holds is what the changes land on; the Lstat above looked at
|
||||
// the path, which may have changed since.
|
||||
var st unix.Stat_t
|
||||
if err := unix.Fstat(fd, &st); err != nil {
|
||||
return &os.PathError{Op: "fstat", Path: path, Err: err}
|
||||
}
|
||||
if st.Mode&unix.S_IFMT != unix.S_IFSOCK || st.Uid != currentUID() {
|
||||
return fmt.Errorf("%s was replaced while its access was being set, refusing to change it", path)
|
||||
}
|
||||
|
||||
// The /proc name of the inode the descriptor holds. ENOENT from it means no /proc.
|
||||
held := "/proc/self/fd/" + strconv.Itoa(fd)
|
||||
|
||||
// The group first: a chown by root clears the setgid bit, which a socket never has,
|
||||
// but the mode is pinned afterwards either way. With no group configured the socket
|
||||
// is handed back to the daemon's own, so taking the key out of the config on a reload
|
||||
// takes the access away as surely as a restart would.
|
||||
gid, err := gidFor(acc)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
err = unix.Chown(held, -1, gid)
|
||||
if err == unix.ENOENT {
|
||||
err = unix.Fchownat(unix.AT_FDCWD, path, -1, gid, unix.AT_SYMLINK_NOFOLLOW)
|
||||
}
|
||||
if err != nil {
|
||||
return &os.PathError{Op: "chown", Path: path, Err: err}
|
||||
}
|
||||
|
||||
perm := uint32(acc.Mode.Perm())
|
||||
err = unix.Chmod(held, perm)
|
||||
if err == unix.ENOENT {
|
||||
err = unix.Fchmodat(unix.AT_FDCWD, path, perm, unix.AT_SYMLINK_NOFOLLOW)
|
||||
}
|
||||
if err != nil {
|
||||
return &os.PathError{Op: "chmod", Path: path, Err: err}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,163 @@
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/commands"
|
||||
)
|
||||
|
||||
// DialTimeout bounds the connect to a socket that exists but is not being served.
|
||||
const DialTimeout = 5 * time.Second
|
||||
|
||||
// ResponseTimeout bounds the exchange once connected: sending the request and waiting
|
||||
// for the daemon's answer. The daemon drops a client that is slow to send in 10s and one
|
||||
// that is slow to read in 30s, so this is the other side of the same bargain, with room
|
||||
// for the slowest command (a hostmap dump on a large network) before a stalled daemon is
|
||||
// given up on. Client.Timeout overrides it.
|
||||
const ResponseTimeout = 60 * time.Second
|
||||
|
||||
// MaxResponseBytes bounds what a client will read back. A response carries one command's
|
||||
// output, and a hostmap dump on a large network is the realistic worst case.
|
||||
const MaxResponseBytes = 64 << 20
|
||||
|
||||
// Client talks to a nebula listening at Path.
|
||||
type Client struct {
|
||||
Path string
|
||||
|
||||
// Timeout bounds the request and response once connected. Zero means
|
||||
// ResponseTimeout.
|
||||
Timeout time.Duration
|
||||
}
|
||||
|
||||
// ReplyError is an answer the client could not read: the daemon was reached and wrote
|
||||
// something back, but not a response this client understands. The daemon is not
|
||||
// nebula, or not a version this client speaks to.
|
||||
type ReplyError struct {
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *ReplyError) Error() string { return "the daemon's reply could not be read: " + e.Err.Error() }
|
||||
func (e *ReplyError) Unwrap() error { return e.Err }
|
||||
|
||||
// DaemonError is a refusal the daemon answered with: the connection worked, the request
|
||||
// was read, and the daemon said no. It is told apart from a failure to reach the daemon
|
||||
// so that a client does not send its user after a socket path, or a sudo, when the daemon
|
||||
// was right there and answered. A protocol version the daemon does not speak, a socket at
|
||||
// its connection limit and a peer the daemon will not serve all arrive as one of these.
|
||||
type DaemonError struct {
|
||||
Msg string
|
||||
}
|
||||
|
||||
func (e *DaemonError) Error() string { return e.Msg }
|
||||
|
||||
// Describe asks the daemon which commands it serves and what parameters they take, so a
|
||||
// client can offer them without having been built against this daemon.
|
||||
func (c *Client) Describe() ([]commands.CommandSchema, error) {
|
||||
res, err := c.do(&Request{Version: ProtocolVersion, Describe: true})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if res.Error != "" {
|
||||
return nil, &DaemonError{Msg: res.Error}
|
||||
}
|
||||
|
||||
schema := []commands.CommandSchema{}
|
||||
if err := json.Unmarshal(res.Result, &schema); err != nil {
|
||||
return nil, &ReplyError{Err: fmt.Errorf("could not parse the command schema: %w", err)}
|
||||
}
|
||||
|
||||
return schema, nil
|
||||
}
|
||||
|
||||
// Invoke runs one command and returns what the daemon said. params are the command's
|
||||
// options by name, as the strings a command line parsed them from; a program speaking
|
||||
// the protocol directly may send JSON's own types instead, see Request.Params. An empty
|
||||
// format asks for JSON, which is the API's default; "text" asks the daemon to apply the
|
||||
// command's own human rendering.
|
||||
func (c *Client) Invoke(command string, params map[string]string, args []string, format string) (*Response, error) {
|
||||
var wire map[string]any
|
||||
if len(params) > 0 {
|
||||
wire = make(map[string]any, len(params))
|
||||
for k, v := range params {
|
||||
wire[k] = v
|
||||
}
|
||||
}
|
||||
|
||||
return c.do(&Request{
|
||||
Version: ProtocolVersion,
|
||||
Command: command,
|
||||
Params: wire,
|
||||
Args: args,
|
||||
Format: format,
|
||||
})
|
||||
}
|
||||
|
||||
// do sends one request and reads the one response.
|
||||
//
|
||||
// Nothing is checked about the socket before the connect: its mode is the kernel's to
|
||||
// enforce, and a socket that is not ours to connect to is refused there with a
|
||||
// permission error, which the caller turns into advice.
|
||||
func (c *Client) do(req *Request) (*Response, error) {
|
||||
conn, err := dial(c.Path, DialTimeout)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer conn.Close()
|
||||
|
||||
// Without this a daemon that accepts and then stalls, blocked inside a command or
|
||||
// stopped with SIGSTOP, hangs the client for good, and a script wrapping it never
|
||||
// completes. One deadline covers the write and the read: the answer is due within
|
||||
// the budget, however the time is spent.
|
||||
timeout := c.Timeout
|
||||
if timeout <= 0 {
|
||||
timeout = ResponseTimeout
|
||||
}
|
||||
_ = conn.SetDeadline(time.Now().Add(timeout))
|
||||
|
||||
// If we get a write error, save that fact but then look for a response from the server.
|
||||
// Some error conditions manifest as the server accepting our connection, writing an
|
||||
// error, and then closing the connection. Our write races against that close.
|
||||
writeErr := error(nil)
|
||||
if err := writeFrame(conn, req); err != nil {
|
||||
writeErr = fmt.Errorf("could not send request: %w", err)
|
||||
}
|
||||
|
||||
res, err := readResponse(conn)
|
||||
if err != nil {
|
||||
// Something answered and it was not a response: the daemon was reached, and
|
||||
// that is the message even when it hung up before the request was written,
|
||||
// which a daemon that is not nebula is likely to do.
|
||||
var fe *frameError
|
||||
if errors.As(err, &fe) {
|
||||
return nil, &ReplyError{Err: err}
|
||||
}
|
||||
if writeErr != nil {
|
||||
return nil, writeErr
|
||||
}
|
||||
var ne net.Error
|
||||
if errors.As(err, &ne) && ne.Timeout() {
|
||||
return nil, fmt.Errorf("the daemon did not answer within %s", timeout)
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return res, nil
|
||||
}
|
||||
|
||||
func readResponse(conn net.Conn) (*Response, error) {
|
||||
res := &Response{}
|
||||
if err := readFrame(conn, MaxResponseBytes, "response", res, false); err != nil {
|
||||
if errors.Is(err, io.EOF) {
|
||||
return nil, errors.New("the daemon closed the connection without answering")
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return res, nil
|
||||
}
|
||||
@@ -0,0 +1,203 @@
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"log/slog"
|
||||
"net"
|
||||
"sync"
|
||||
)
|
||||
|
||||
// endpoint is the lifecycle the two local APIs share: one socket at a path, bound and
|
||||
// given up under a mutex, moved by binding the new path before the old one is released,
|
||||
// and stopped when the context that brought it up ends. What is served on the socket,
|
||||
// and by what, is the embedding server's: it hands rebindLocked a serve function and
|
||||
// gets back the thing to close.
|
||||
type endpoint struct {
|
||||
l *slog.Logger
|
||||
|
||||
// name is what the endpoint is called in its own log lines and errors, so the two
|
||||
// read apart.
|
||||
name string
|
||||
|
||||
mu sync.Mutex
|
||||
|
||||
// closer stops the serving when closed: the listener itself, or the server that owns
|
||||
// it. It is nil while the endpoint is stopped, which is what stopped means here.
|
||||
closer io.Closer
|
||||
path string
|
||||
access Access
|
||||
unwatch func() bool
|
||||
|
||||
// id identifies the node listen created at path, so a reload can tell whether the
|
||||
// socket is still there and Stop whether the node it would unlink is still ours.
|
||||
id socketID
|
||||
}
|
||||
|
||||
// socketID identifies a socket's node on the filesystem, by device and inode on unix.
|
||||
// The zero value is no identity: a platform with no node to identify, or one that could
|
||||
// not be read, and removeSocket then unlinks without looking.
|
||||
type socketID struct {
|
||||
dev, ino uint64
|
||||
}
|
||||
|
||||
// Path returns the socket path currently being served, or "" when stopped.
|
||||
func (e *endpoint) Path() string {
|
||||
e.mu.Lock()
|
||||
defer e.mu.Unlock()
|
||||
return e.path
|
||||
}
|
||||
|
||||
// rebindLocked brings the endpoint up at path with acc, moves it there, or, when it is
|
||||
// already there, applies a changed access; with nothing changed it does nothing, which
|
||||
// is what lets Wire's first attempt and its reload callback be the same call.
|
||||
//
|
||||
// The new socket is bound before the old one is given up: a bad path in a reloaded
|
||||
// config leaves the operator with the endpoint they already had rather than none. serve
|
||||
// is handed the new listener once it is certain to be kept and returns what to close to
|
||||
// stop serving it; what becomes of the old socket's connections is that closer's.
|
||||
//
|
||||
// The caller holds e.mu for the whole operation, bind included. Releasing it around
|
||||
// listen would let a Stop land in between, and this would then install a fresh socket on
|
||||
// an endpoint that had just shut down, leaving a live socket on disk until the process
|
||||
// exits. listen does not take e.mu, so holding it costs the other methods one bind's
|
||||
// wait, at most the stale socket probe, once per reload.
|
||||
func (e *endpoint) rebindLocked(ctx context.Context, path string, acc Access, serve func(net.Listener) io.Closer) error {
|
||||
reopening := false
|
||||
if e.closer != nil && e.path == path {
|
||||
if cur, ok := identifySocket(path); ok && cur == e.id {
|
||||
if e.access == acc {
|
||||
return nil
|
||||
}
|
||||
err := applyAccess(path, acc)
|
||||
if err == nil {
|
||||
e.access = acc
|
||||
e.l.Info("Changed the "+e.name+"'s socket access", "path", path, "access", acc.String())
|
||||
return nil
|
||||
}
|
||||
if !errors.Is(err, errReopenForAccess) {
|
||||
return fmt.Errorf("could not change the access of %s: %w", path, err)
|
||||
}
|
||||
|
||||
// The platform fixes access when the endpoint is created, so it is created
|
||||
// again. The name cannot be held twice, so the old one goes first, and a bind
|
||||
// that then fails leaves the endpoint down rather than on the old access the
|
||||
// operator asked to change; that is reported below.
|
||||
reopening = true
|
||||
old := e.closer
|
||||
e.forgetLocked()
|
||||
_ = old.Close()
|
||||
} else {
|
||||
// The node at the path is not the one this endpoint bound: something outside
|
||||
// nebula removed it, logind clearing /run/user/<uid> on logout or a unit
|
||||
// cleaning a RuntimeDirectory= it shares, or replaced it. The listener is still
|
||||
// open and nothing can reach it, so it is given up now and the path is bound
|
||||
// afresh below; listen's stale check decides whether whatever is there now may
|
||||
// be cleared. Given up first, rather than after a successful bind as a move
|
||||
// does, so that a bind that fails leaves the endpoint reported as down, which
|
||||
// it is, instead of serving a path nothing can reach.
|
||||
e.l.Warn("The "+e.name+"'s socket is no longer at its path, binding it again", "path", path)
|
||||
old := e.closer
|
||||
e.forgetLocked()
|
||||
_ = old.Close()
|
||||
}
|
||||
}
|
||||
|
||||
ln, err := listen(path, acc)
|
||||
if err != nil {
|
||||
if reopening {
|
||||
return fmt.Errorf("the %s was closed to change its access and could not be created again: %w", e.name, err)
|
||||
}
|
||||
return err
|
||||
}
|
||||
id, _ := identifySocket(path)
|
||||
|
||||
// A reload that arrives during shutdown must not bring the endpoint back. Stop is
|
||||
// not terminal (a Rebind after Stop is allowed, and is how an endpoint whose first
|
||||
// bind failed comes up), so whether it is running is no guide; the context is what
|
||||
// shutdown cancels, and it is checked here, while nothing else can change the state.
|
||||
if err := ctx.Err(); err != nil {
|
||||
release(ln, path, id)
|
||||
return fmt.Errorf("not starting the %s, nebula is shutting down: %w", e.name, err)
|
||||
}
|
||||
|
||||
old, oldPath, oldID := e.closer, e.path, e.id
|
||||
e.closer = serve(ln)
|
||||
e.path = path
|
||||
e.access = acc
|
||||
e.id = id
|
||||
e.watchLocked(ctx)
|
||||
|
||||
// Stop serving the old socket. When it was on this same path its node is already
|
||||
// gone, and the node there now is the new socket's, so only the closer goes.
|
||||
if old != nil {
|
||||
if oldPath == path {
|
||||
_ = old.Close()
|
||||
} else {
|
||||
release(old, oldPath, oldID)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// watchLocked stops the endpoint when ctx is cancelled. One watcher covers a run of the
|
||||
// endpoint, from the first bind that succeeds until Stop: a daemon whose initial listen
|
||||
// failed and which later Rebinds onto a good path from a reloaded config still needs its
|
||||
// socket removed on shutdown, and a Rebind on a running endpoint must not stack a second
|
||||
// watcher on the same ctx. Stop detaches the watcher, so an endpoint started again
|
||||
// afterwards is watched on the ctx that started it, and the ctx of an earlier run no
|
||||
// longer reaches it whenever that one ends. Callers hold e.mu.
|
||||
func (e *endpoint) watchLocked(ctx context.Context) {
|
||||
if e.unwatch != nil {
|
||||
return
|
||||
}
|
||||
e.unwatch = context.AfterFunc(ctx, e.Stop)
|
||||
}
|
||||
|
||||
// Stop closes the endpoint and removes its socket. Work in flight is the closer's
|
||||
// business: a listener leaves the connections it already accepted to finish, a server
|
||||
// cuts them off.
|
||||
//
|
||||
// The whole of it runs under e.mu, closer and socket included, so a Rebind cannot land
|
||||
// between the state change and the close and find a path that is still bound by the
|
||||
// socket it is replacing.
|
||||
func (e *endpoint) Stop() {
|
||||
e.mu.Lock()
|
||||
defer e.mu.Unlock()
|
||||
|
||||
if e.closer == nil {
|
||||
return
|
||||
}
|
||||
|
||||
release(e.closer, e.path, e.id)
|
||||
e.forgetLocked()
|
||||
}
|
||||
|
||||
// forgetLocked drops the state of a run once its socket has been given up, the watcher
|
||||
// with it: one watcher covers one run, and a bind that follows starts a new one on the
|
||||
// ctx it was given. The watcher is set whenever closer is; when the Stop that got here
|
||||
// is the watcher's own, stopping one that has already fired is a no-op.
|
||||
func (e *endpoint) forgetLocked() {
|
||||
e.closer, e.path, e.access, e.id = nil, "", Access{}, socketID{}
|
||||
if e.unwatch != nil {
|
||||
e.unwatch()
|
||||
e.unwatch = nil
|
||||
}
|
||||
}
|
||||
|
||||
// release gives up a socket's closer and the node at its path. The node goes first,
|
||||
// while the socket is still open: for as long as it is, the node is this endpoint's,
|
||||
// since a starting daemon's stale check refuses to remove a socket that answers. The
|
||||
// other order opens a window between the close and the unlink in which a new daemon can
|
||||
// find the node stale, clear it and bind its own at the same path, which the unlink then
|
||||
// takes from under it, leaving that daemon serving a socket nothing can reach. listen
|
||||
// turns off the listener's own unlink on close so this is the only unlink. id is the
|
||||
// node listen created, and the only node removeSocket will remove: one that replaced it,
|
||||
// another daemon's socket bound after ours was taken from under us, is left alone.
|
||||
func release(c io.Closer, path string, id socketID) {
|
||||
removeSocket(path, id)
|
||||
_ = c.Close()
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
//go:build !windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"os/user"
|
||||
"strconv"
|
||||
)
|
||||
|
||||
// lookupGroupID resolves a group's name, or a numeric gid, to the gid as a string. A
|
||||
// gid that the group database does not list is accepted as chown would accept it: the
|
||||
// operator may be naming a group the host will learn about later, or one that only a
|
||||
// directory service knows.
|
||||
func lookupGroupID(name string) (string, error) {
|
||||
if g, err := user.LookupGroup(name); err == nil {
|
||||
return g.Gid, nil
|
||||
}
|
||||
|
||||
if _, err := strconv.ParseUint(name, 10, 32); err == nil {
|
||||
return name, nil
|
||||
}
|
||||
|
||||
return "", fmt.Errorf("group %q does not exist on this host", name)
|
||||
}
|
||||
|
||||
// gidFor returns the gid the socket is owned by under acc: the configured group's, or
|
||||
// the daemon's own effective group when none is configured.
|
||||
func gidFor(acc Access) (int, error) {
|
||||
if !acc.shared() {
|
||||
return os.Getegid(), nil
|
||||
}
|
||||
gid, err := strconv.ParseUint(acc.Group.ID, 10, 32)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("group %q resolved to %q, which is not a gid", acc.Group.Name, acc.Group.ID)
|
||||
}
|
||||
return int(gid), nil
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
//go:build windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"golang.org/x/sys/windows"
|
||||
)
|
||||
|
||||
// lookupGroupID resolves an account name, local or domain qualified, or a SID written
|
||||
// out, to the SID as a string, which is how the pipe's security descriptor names it.
|
||||
// Any account the host can resolve is accepted, as docker accepts any SID for its -G: a
|
||||
// group is the natural thing to name, but the descriptor does not care.
|
||||
func lookupGroupID(name string) (string, error) {
|
||||
if strings.HasPrefix(strings.ToUpper(name), "S-1-") {
|
||||
sid, err := windows.StringToSid(name)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("%q is not a SID: %w", name, err)
|
||||
}
|
||||
return sid.String(), nil
|
||||
}
|
||||
|
||||
sid, _, _, err := windows.LookupSID("", name)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("account %q does not exist on this host: %w", name, err)
|
||||
}
|
||||
return sid.String(), nil
|
||||
}
|
||||
@@ -0,0 +1,452 @@
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"log/slog"
|
||||
"maps"
|
||||
"net"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"os"
|
||||
"path"
|
||||
"runtime"
|
||||
"runtime/debug"
|
||||
"slices"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"golang.org/x/net/netutil"
|
||||
)
|
||||
|
||||
// The info API's config keys. It is off until InfoEnabledKey is true and InfoSocketKey
|
||||
// names a socket; nothing is derived, because the programs that will dial it have to be
|
||||
// told where it is anyway.
|
||||
const (
|
||||
InfoEnabledKey = "local_api.info.enabled"
|
||||
InfoSocketKey = "local_api.info.socket"
|
||||
InfoModeKey = "local_api.info.socket_mode"
|
||||
InfoGroupKey = "local_api.info.group"
|
||||
)
|
||||
|
||||
const (
|
||||
// infoMaxConns bounds the connections held open at once. Beyond it the kernel
|
||||
// queues, which is what an HTTP client expects of a busy server; the control socket
|
||||
// refuses instead because its clients are people at a prompt.
|
||||
infoMaxConns = 64
|
||||
|
||||
infoWriteTimeout = 30 * time.Second
|
||||
infoIdleTimeout = 60 * time.Second
|
||||
infoMaxHeaderBytes = 64 * 1024
|
||||
)
|
||||
|
||||
// The read deadlines are variables so a test can shorten them. infoReadTimeout bounds
|
||||
// the whole request, not only its headers: a request is a GET with a query string and
|
||||
// the handlers never read a body, but net/http drains an unread body after the handler
|
||||
// returns, and without a deadline on that read a client sending a body a byte at a time
|
||||
// would hold its connection slot for as long as it liked, and sixty-four of them would
|
||||
// hold every slot. A body is refused as well, see refuseBody, but net/http drains it
|
||||
// before it closes, so this deadline is what ends a client that announced a body and
|
||||
// never sent it.
|
||||
var (
|
||||
infoReadHeaderTimeout = 10 * time.Second
|
||||
infoReadTimeout = 15 * time.Second
|
||||
)
|
||||
|
||||
// servedOnInfo decides what the info API will run: the commands that report identity
|
||||
// and nothing else, which the commands declare about themselves. Filter adds help to
|
||||
// the result, so a client can ask what is served; help on a filtered registry describes
|
||||
// only that registry.
|
||||
func servedOnInfo(c *commands.Command) bool {
|
||||
return c.Identity
|
||||
}
|
||||
|
||||
// notServedOnInfo explains a refusal, naming the surfaces that will run the command.
|
||||
const notServedOnInfo = "the info API serves identity lookups only; the ssh debug server and nebula ctl serve the rest"
|
||||
|
||||
// InfoServer serves the identity commands over HTTP, on a socket an operator may open to
|
||||
// other users on the host.
|
||||
//
|
||||
// It is the second local API, and the opposite of the control socket in who it is for.
|
||||
// The control socket is for the user who runs nebula, serves nearly everything and needs
|
||||
// no configuration. This one is for every other program on the machine, a web server
|
||||
// that wants to know who is on the other end of a connection arriving over the overlay,
|
||||
// say, and it is off until an operator names a socket and a mode for it. What it serves
|
||||
// is decided by the commands themselves, Command.Identity: the identity a certificate
|
||||
// asserts and nothing operational, so opening it to a group of services, or to everyone
|
||||
// on the host, gives away nothing the overlay did not already tell them.
|
||||
//
|
||||
// HTTP, so that no client library is needed. GET /v1/<command>?<flag>=<value> runs a
|
||||
// command with its options as the query string and answers with the command's JSON, the
|
||||
// same value the control socket and -json produce. GET /v1 describes what is served. A
|
||||
// refusal is a 4xx with {"error": reason}: 404 when the command said the thing asked
|
||||
// about does not exist (commands.NotFound), 400 for a parameter or an argument the
|
||||
// command would not take, 403 for a command this surface withholds.
|
||||
type InfoServer struct {
|
||||
endpoint
|
||||
|
||||
// reg is the identity commands this surface serves, filtered from the daemon's
|
||||
// registry when the server was built.
|
||||
reg *commands.Registry
|
||||
}
|
||||
|
||||
// NewInfoServer returns an InfoServer that serves the identity commands in reg. reg is
|
||||
// complete when it arrives: nebula registers every command before it wires its local
|
||||
// APIs, and nothing registers one later, so the filter is taken once here rather than
|
||||
// kept up to date against the source.
|
||||
func NewInfoServer(l *slog.Logger, reg *commands.Registry) *InfoServer {
|
||||
return &InfoServer{
|
||||
endpoint: endpoint{l: l, name: "local info API"},
|
||||
reg: reg.Filter(servedOnInfo, notServedOnInfo),
|
||||
}
|
||||
}
|
||||
|
||||
// Rebind brings the server up at path with mode, moves it there, or, when it is already
|
||||
// there, applies a changed mode; endpoint.rebindLocked says what that promises. It is
|
||||
// the one way the server comes up, so Wire's reload callback and its first attempt are
|
||||
// the same call.
|
||||
func (s *InfoServer) Rebind(ctx context.Context, path string, acc Access) error {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
|
||||
return s.rebindLocked(ctx, path, acc, func(ln net.Listener) io.Closer {
|
||||
srv := &http.Server{
|
||||
Handler: s.handler(),
|
||||
ReadHeaderTimeout: infoReadHeaderTimeout,
|
||||
ReadTimeout: infoReadTimeout,
|
||||
WriteTimeout: infoWriteTimeout,
|
||||
IdleTimeout: infoIdleTimeout,
|
||||
MaxHeaderBytes: infoMaxHeaderBytes,
|
||||
ErrorLog: slog.NewLogLogger(s.l.Handler(), slog.LevelDebug),
|
||||
}
|
||||
|
||||
s.l.Info("Local info API listening", "path", path, "access", acc.String())
|
||||
if w := unprotectedNameWarning(path); w != "" {
|
||||
s.l.Warn("Local info API is served on a pipe name that is not protected", "path", path, "risk", w)
|
||||
}
|
||||
go s.serve(srv, ln)
|
||||
|
||||
// Closing the server closes the listener Serve was handed, and a Serve that has
|
||||
// not started yet closes it on its way out, so the node is never left bound by a
|
||||
// listener nothing is accepting from. Requests in flight are cut off rather than
|
||||
// waited for: a reload must not hang on a slow client, and the answer is a lookup
|
||||
// the client can simply repeat.
|
||||
return srv
|
||||
})
|
||||
}
|
||||
|
||||
// serve runs the HTTP server on ln until it is closed. Only an error other than the
|
||||
// close is worth a line: Stop and Rebind are the two things that close it.
|
||||
func (s *InfoServer) serve(srv *http.Server, ln net.Listener) {
|
||||
err := srv.Serve(netutil.LimitListener(ln, infoMaxConns))
|
||||
if err != nil && !errors.Is(err, http.ErrServerClosed) && !errors.Is(err, net.ErrClosed) {
|
||||
s.l.Error("Local info API stopped serving", "error", err)
|
||||
}
|
||||
}
|
||||
|
||||
// handler builds the routes. Every answer is JSON, the misses included, so a client
|
||||
// never has to parse net/http's text for a path or method it did not expect. That
|
||||
// includes a path ServeMux would clean and redirect, /v1/../v1/x or //v1/x, which is
|
||||
// refused outright: nothing legitimate sends one, and a redirect is one more thing a
|
||||
// client would have to follow.
|
||||
func (s *InfoServer) handler() http.Handler {
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("GET /v1", s.handleDescribe)
|
||||
mux.HandleFunc("GET /v1/{command}", s.handleCommand)
|
||||
mux.HandleFunc("/v1", methodNotAllowed)
|
||||
mux.HandleFunc("/v1/{command}", methodNotAllowed)
|
||||
mux.HandleFunc("/", notFoundRoute)
|
||||
return s.recovering(refuseBody(mux))
|
||||
}
|
||||
|
||||
// refuseBody answers a request that carries a body with 400, before any handler sees
|
||||
// it, and has the connection closed after the reply rather than kept for another
|
||||
// request. Nothing here reads a body; one is a mistake, and the client is told what to
|
||||
// do instead. net/http still drains what the body it announced it would send, up to the
|
||||
// read deadline, so the deadline is what bounds a client that never sends it.
|
||||
func refuseBody(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.ContentLength != 0 || len(r.TransferEncoding) > 0 {
|
||||
w.Header().Set("Connection", "close")
|
||||
writeJSONError(w, http.StatusBadRequest, "the info API takes no request body; put the command's parameters in the query string")
|
||||
return
|
||||
}
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
|
||||
// recovering turns a panic in a command into a 500 and a log line rather than a dropped
|
||||
// connection, which is all net/http would offer, and keeps the daemon up, which is what
|
||||
// matters: this surface is reachable by whoever the operator opened it to. The handlers
|
||||
// produce their whole answer before writing any of it, so a panic in Run always finds
|
||||
// the response unwritten.
|
||||
func (s *InfoServer) recovering(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
defer func() {
|
||||
if rec := recover(); rec != nil {
|
||||
s.l.Error("Recovered from panic serving a local info API request",
|
||||
"panic", rec,
|
||||
"path", r.URL.Path,
|
||||
"query", r.URL.RawQuery,
|
||||
"stack", string(debug.Stack()),
|
||||
)
|
||||
writeJSONError(w, http.StatusInternalServerError, "command failed")
|
||||
}
|
||||
}()
|
||||
|
||||
if path.Clean(r.URL.Path) != r.URL.Path {
|
||||
notFoundRoute(w, r)
|
||||
return
|
||||
}
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
|
||||
// handleDescribe answers GET /v1 with the schema of every command served here, the same
|
||||
// document the control socket's describe returns for its own surface.
|
||||
func (s *InfoServer) handleDescribe(w http.ResponseWriter, _ *http.Request) {
|
||||
body, err := json.Marshal(s.reg.Schema())
|
||||
if err != nil {
|
||||
writeJSONError(w, http.StatusInternalServerError, err.Error())
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, body)
|
||||
}
|
||||
|
||||
// handleCommand answers GET /v1/<command>: the query string carries the command's
|
||||
// parameters, and the response body is the command's JSON. A request body is never
|
||||
// read. It is the control socket's serve with HTTP's vocabulary for the outcomes.
|
||||
func (s *InfoServer) handleCommand(w http.ResponseWriter, r *http.Request) {
|
||||
name := commands.Name(r.PathValue("command"))
|
||||
|
||||
reg := s.reg
|
||||
cmd, err := reg.Resolve(name)
|
||||
if err != nil {
|
||||
// A command this surface withholds is a different answer from one that does not
|
||||
// exist, and Resolve says which; only the status is picked here.
|
||||
status := http.StatusNotFound
|
||||
var withheld *commands.WithheldError
|
||||
if errors.As(err, &withheld) {
|
||||
status = http.StatusForbidden
|
||||
}
|
||||
writeJSONError(w, status, err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Parsed strictly: the lenient parser on the request drops a pair it cannot decode
|
||||
// and keeps the rest, and a request that lost its address would be answered as one
|
||||
// that never had it, which for print-cert is this node's own certificate.
|
||||
q, err := url.ParseQuery(r.URL.RawQuery)
|
||||
if err != nil {
|
||||
writeJSONError(w, http.StatusBadRequest, "malformed query string: "+err.Error())
|
||||
return
|
||||
}
|
||||
params, format, err := queryParams(q, reg.SchemaFor(cmd))
|
||||
if err != nil {
|
||||
writeJSONError(w, http.StatusBadRequest, err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
res, err := commands.Invoke(commands.Request{Command: cmd, Params: params})
|
||||
if err != nil {
|
||||
var pe *commands.ParamError
|
||||
if errors.As(err, &pe) {
|
||||
writeJSONError(w, http.StatusBadRequest, err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Run failed. The sentence is for the operator's log; the caller, who may be
|
||||
// anyone the operator admitted, is told that it failed and no more.
|
||||
s.l.Warn("Local info API command failed", "command", name, "error", err)
|
||||
writeJSONError(w, http.StatusInternalServerError, "command failed")
|
||||
return
|
||||
}
|
||||
|
||||
// A command that acts does so before this surface's one reply, whose body is the
|
||||
// outcome; see Command.Then.
|
||||
if cmd.Then != nil && res.OK {
|
||||
res = cmd.Then()
|
||||
}
|
||||
|
||||
// A refusal is answered before an empty Result is: the zero Result is a refusal with
|
||||
// nothing to say, which exits 1 over ssh and must not read as success here. One with
|
||||
// no reason is the command's fault, as a Run error is, and is answered the same way.
|
||||
if !res.OK {
|
||||
if res.Reason == "" {
|
||||
s.l.Warn("Local info API command refused without a reason", "command", name)
|
||||
writeJSONError(w, http.StatusInternalServerError, "command failed")
|
||||
return
|
||||
}
|
||||
status := http.StatusBadRequest
|
||||
if res.NotFound {
|
||||
status = http.StatusNotFound
|
||||
}
|
||||
writeJSONError(w, status, res.Reason)
|
||||
return
|
||||
}
|
||||
|
||||
if res.Empty() {
|
||||
w.WriteHeader(http.StatusNoContent)
|
||||
return
|
||||
}
|
||||
|
||||
// The same rendering function every surface uses, so the value here is byte for
|
||||
// byte what -json prints at an ssh prompt.
|
||||
buf := &bytes.Buffer{}
|
||||
if err := commands.Render(cmd, res, format, buf); err != nil {
|
||||
s.l.Warn("Local info API could not render a result", "command", name, "error", err)
|
||||
writeJSONError(w, http.StatusInternalServerError, "command failed")
|
||||
return
|
||||
}
|
||||
|
||||
writeJSON(w, http.StatusOK, buf.Bytes())
|
||||
}
|
||||
|
||||
// queryParams reads a query string as a command's parameters. Each key is a flag of the
|
||||
// command, by name, in the form the control socket takes them; one given twice is
|
||||
// refused rather than silently picking either. The presentation flags are read as a
|
||||
// command line reads them, and set apart: the answer is JSON regardless, and pretty
|
||||
// indents it.
|
||||
func queryParams(q url.Values, schema commands.CommandSchema) (map[string]string, commands.Format, error) {
|
||||
var params, presentation map[string]string
|
||||
for _, k := range slices.Sorted(maps.Keys(q)) {
|
||||
vs := q[k]
|
||||
if len(vs) > 1 {
|
||||
return nil, commands.FormatUnset, fmt.Errorf("parameter %q was given more than once", k)
|
||||
}
|
||||
|
||||
into := ¶ms
|
||||
if k == commands.FlagJSON || k == commands.FlagPretty {
|
||||
into = &presentation
|
||||
}
|
||||
if *into == nil {
|
||||
*into = map[string]string{}
|
||||
}
|
||||
v := vs[0]
|
||||
// ?raw is ?raw=true, as -raw is -raw=true on a command line.
|
||||
if v == "" && isBoolParam(schema, k) {
|
||||
v = "true"
|
||||
}
|
||||
(*into)[k] = v
|
||||
}
|
||||
|
||||
format, err := commands.PresentationFormat(presentation)
|
||||
if err != nil {
|
||||
return nil, commands.FormatUnset, err
|
||||
}
|
||||
if format == commands.FormatUnset {
|
||||
format = commands.FormatJSON
|
||||
}
|
||||
|
||||
return params, format, nil
|
||||
}
|
||||
|
||||
// isBoolParam reports whether name is one of the command's boolean flags.
|
||||
func isBoolParam(schema commands.CommandSchema, name string) bool {
|
||||
for _, f := range schema.Flags {
|
||||
if f.Name == name {
|
||||
return f.Bool
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func methodNotAllowed(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Allow", http.MethodGet)
|
||||
writeJSONError(w, http.StatusMethodNotAllowed, fmt.Sprintf("%s is not allowed; the info API is read only, use GET", r.Method))
|
||||
}
|
||||
|
||||
func notFoundRoute(w http.ResponseWriter, r *http.Request) {
|
||||
writeJSONError(w, http.StatusNotFound, fmt.Sprintf("no such path %s; GET /v1 lists the commands and GET /v1/<command> runs one", r.URL.Path))
|
||||
}
|
||||
|
||||
func writeJSON(w http.ResponseWriter, status int, body []byte) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.Header().Set("X-Content-Type-Options", "nosniff")
|
||||
w.Header().Set("Content-Length", strconv.Itoa(len(body)))
|
||||
w.WriteHeader(status)
|
||||
_, _ = w.Write(body)
|
||||
}
|
||||
|
||||
func writeJSONError(w http.ResponseWriter, status int, msg string) {
|
||||
body, _ := json.Marshal(map[string]string{"error": msg})
|
||||
writeJSON(w, status, append(body, '\n'))
|
||||
}
|
||||
|
||||
// infoConfig is the info API section of a config, read and checked.
|
||||
type infoConfig struct {
|
||||
Enabled bool
|
||||
Path string
|
||||
Access Access
|
||||
}
|
||||
|
||||
// infoConfigFrom reads the info API section. A disabled section needs nothing else to be
|
||||
// right; an enabled one needs a socket path, a group that exists if it names one, and
|
||||
// a mode that parses if it names one. A group with no mode means groupSocketMode, and a
|
||||
// mode that gives a named group nothing is refused: it would be a group that cannot
|
||||
// connect, which is not what naming one asks for.
|
||||
func infoConfigFrom(c *config.C) (infoConfig, error) {
|
||||
cfg := infoConfig{Enabled: c.GetBool(InfoEnabledKey, false)}
|
||||
if !cfg.Enabled {
|
||||
return cfg, nil
|
||||
}
|
||||
|
||||
p := c.GetString(InfoSocketKey, "")
|
||||
if p == "" {
|
||||
return cfg, fmt.Errorf("%s is true but %s is not set; the info API needs a socket path", InfoEnabledKey, InfoSocketKey)
|
||||
}
|
||||
if err := checkSocketPath(InfoSocketKey, p); err != nil {
|
||||
return cfg, err
|
||||
}
|
||||
cfg.Path = p
|
||||
|
||||
group, err := groupFromConfig(c, InfoGroupKey)
|
||||
if err != nil {
|
||||
return cfg, err
|
||||
}
|
||||
// With neither a mode nor a group named, the daemon's user alone, so that enabling
|
||||
// the API does not open it to anyone until the operator says who.
|
||||
def := ownerOnlyMode
|
||||
if group.ID != "" {
|
||||
def = groupSocketMode
|
||||
}
|
||||
|
||||
mode, err := parseSocketMode(c.Get(InfoModeKey), def)
|
||||
if err != nil {
|
||||
return cfg, fmt.Errorf("%s: %w", InfoModeKey, err)
|
||||
}
|
||||
// On unix the mode is what admits the group, so one that shuts it out is a config
|
||||
// error; on windows the group is an entry in the pipe's security descriptor and the
|
||||
// mode means nothing to a pipe, so it is not held against the group there.
|
||||
if runtime.GOOS != "windows" && group.ID != "" && mode&0070 == 0 {
|
||||
return cfg, fmt.Errorf("%s %s gives group %s no access to the socket; use \"%04o\" or leave the mode unset", InfoModeKey, modeString(mode), group.Name, mode|0060)
|
||||
}
|
||||
cfg.Access = Access{Mode: mode, Group: group}
|
||||
|
||||
return cfg, nil
|
||||
}
|
||||
|
||||
// parseSocketMode reads an octal mode written as a string. A bare 0660 in yaml is an
|
||||
// integer, and which integer depends on the parser (octal 432 under YAML 1.1, decimal
|
||||
// 660 under 1.2), so a number is refused with the fix rather than quietly applied as
|
||||
// whichever mode its digits happen to spell in octal.
|
||||
func parseSocketMode(raw any, def os.FileMode) (os.FileMode, error) {
|
||||
switch v := raw.(type) {
|
||||
case nil:
|
||||
return def, nil
|
||||
case string:
|
||||
mode, err := strconv.ParseUint(v, 8, 32)
|
||||
if err != nil || mode&^0777 != 0 {
|
||||
return 0, fmt.Errorf("%q is not an octal file mode such as \"0660\"", v)
|
||||
}
|
||||
return os.FileMode(mode), nil
|
||||
default:
|
||||
return 0, fmt.Errorf("must be a quoted octal string such as \"0660\", not the number %v; yaml reads a bare mode as a decimal or octal integer depending on the parser", v)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,432 @@
|
||||
//go:build !windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"net/http"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
type whoamiFlags struct {
|
||||
Name string
|
||||
Shout bool
|
||||
}
|
||||
|
||||
// infoRegistry holds one identity command, whoami, whose -name selects an outcome, and
|
||||
// one command the info API must withhold.
|
||||
func infoRegistry() *commands.Registry {
|
||||
reg := commands.New()
|
||||
reg.Register(&commands.Command{
|
||||
Name: "whoami",
|
||||
ShortDescription: "reports who a name belongs to",
|
||||
Identity: true,
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := &whoamiFlags{}
|
||||
fl.StringVar(&s.Name, "name", "", "the name to look up")
|
||||
fl.BoolVar(&s.Shout, "shout", false, "answers in capitals")
|
||||
return fl, s
|
||||
},
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
if f := fs.(*whoamiFlags); f.Shout {
|
||||
return commands.Value(map[string]any{"name": strings.ToUpper(f.Name)}), nil
|
||||
}
|
||||
switch name := fs.(*whoamiFlags).Name; name {
|
||||
case "":
|
||||
return commands.Value(map[string]any{"name": "me", "groups": []string{}}), nil
|
||||
case "nobody":
|
||||
return commands.NotFound("No active tunnel for vpn addr: %s", name), nil
|
||||
case "bad":
|
||||
return commands.Failed("The provided vpn addr could not be parsed: %s", name), nil
|
||||
case "boom":
|
||||
panic("this command is broken")
|
||||
case "err":
|
||||
return commands.Result{}, errors.New("an internal detail")
|
||||
case "silent":
|
||||
return commands.Result{}, nil
|
||||
case "done":
|
||||
return commands.Nothing(), nil
|
||||
default:
|
||||
return commands.Value(map[string]any{"name": name}), nil
|
||||
}
|
||||
},
|
||||
})
|
||||
reg.Register(echoCommand())
|
||||
return reg
|
||||
}
|
||||
|
||||
func serveInfo(t *testing.T, reg *commands.Registry, mode os.FileMode) (*InfoServer, string) {
|
||||
t.Helper()
|
||||
|
||||
path := testSocket(t)
|
||||
s := NewInfoServer(test.NewLogger(), reg)
|
||||
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: mode}))
|
||||
t.Cleanup(s.Stop)
|
||||
return s, path
|
||||
}
|
||||
|
||||
// httpDo sends one request over the socket at path and returns the status, body and
|
||||
// headers. The host in the URL is a placeholder: the dialer ignores it.
|
||||
func TestInfoServesIdentityCommands(t *testing.T) {
|
||||
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||
|
||||
status, body, hdr := test.HTTPDo(t, path, http.MethodGet, "/v1/whoami?name=alice")
|
||||
assert.Equal(t, http.StatusOK, status)
|
||||
assert.JSONEq(t, `{"name":"alice"}`, body)
|
||||
assert.Equal(t, "application/json", hdr.Get("Content-Type"))
|
||||
|
||||
status, body = test.HTTPGet(t, path, "/v1/whoami")
|
||||
assert.Equal(t, http.StatusOK, status)
|
||||
assert.JSONEq(t, `{"name":"me","groups":[]}`, body, "a parameter left out is the command's default")
|
||||
}
|
||||
|
||||
// TestInfoWithholdsTheRest checks the filter at the wire: a command that exists but is
|
||||
// not an identity command is refused with the reason, and a name nothing is registered
|
||||
// under is unknown, so a caller can tell a typo from a closed door.
|
||||
func TestInfoWithholdsTheRest(t *testing.T) {
|
||||
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||
|
||||
status, body := test.HTTPGet(t, path, "/v1/echo?x=1")
|
||||
assert.Equal(t, http.StatusForbidden, status)
|
||||
assert.Contains(t, body, "echo is not available on this surface")
|
||||
assert.Contains(t, body, "identity lookups only")
|
||||
|
||||
status, body = test.HTTPGet(t, path, "/v1/nope")
|
||||
assert.Equal(t, http.StatusNotFound, status)
|
||||
assert.Contains(t, body, `unknown command \"nope\"`)
|
||||
|
||||
for _, target := range []string{"/", "/v2/whoami", "/v1/", "/v1/whoami/extra", "//v1/whoami", "/v1/x/../whoami", "/v1/../v1/whoami"} {
|
||||
status, body = test.HTTPGet(t, path, target)
|
||||
assert.Equal(t, http.StatusNotFound, status, target)
|
||||
assert.Contains(t, body, `"error"`, "%s: misses are JSON too", target)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInfoStatusCodes(t *testing.T) {
|
||||
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||
|
||||
for _, tc := range []struct {
|
||||
target string
|
||||
status int
|
||||
body string
|
||||
}{
|
||||
{"/v1/whoami?name=nobody", http.StatusNotFound, `{"error":"No active tunnel for vpn addr: nobody"}`},
|
||||
{"/v1/whoami?name=bad", http.StatusBadRequest, `{"error":"The provided vpn addr could not be parsed: bad"}`},
|
||||
{"/v1/whoami?nope=1", http.StatusBadRequest, `{"error":"whoami has no parameter \"nope\""}`},
|
||||
{"/v1/whoami?name=a&name=b", http.StatusBadRequest, `{"error":"parameter \"name\" was given more than once"}`},
|
||||
{"/v1/whoami?pretty=maybe", http.StatusBadRequest, `{"error":"pretty: expected a boolean, got \"maybe\""}`},
|
||||
// A pair that does not decode is a malformed request, not a request without
|
||||
// the pair: the lenient parser would drop it and keep the rest.
|
||||
{"/v1/whoami?name=%zz", http.StatusBadRequest, `{"error":"malformed query string: invalid URL escape \"%zz\""}`},
|
||||
{"/v1/whoami?name=a;shout", http.StatusBadRequest, `{"error":"malformed query string: invalid semicolon separator in query"}`},
|
||||
// A boolean parameter with no value is set, as -shout is on a command line.
|
||||
{"/v1/whoami?name=alice&shout", http.StatusOK, `{"name":"ALICE"}`},
|
||||
{"/v1/whoami?name=alice&shout=false", http.StatusOK, `{"name":"alice"}`},
|
||||
// Run failed: the caller hears that it did and no more; the detail is for the log.
|
||||
{"/v1/whoami?name=err", http.StatusInternalServerError, `{"error":"command failed"}`},
|
||||
// A refusal with no reason, the zero Result, fails the same way rather than
|
||||
// passing as a success with nothing to say.
|
||||
{"/v1/whoami?name=silent", http.StatusInternalServerError, `{"error":"command failed"}`},
|
||||
} {
|
||||
status, body := test.HTTPGet(t, path, tc.target)
|
||||
assert.Equal(t, tc.status, status, tc.target)
|
||||
assert.JSONEq(t, tc.body, body, tc.target)
|
||||
}
|
||||
|
||||
// A success with nothing to say is the one empty reply.
|
||||
status, body := test.HTTPGet(t, path, "/v1/whoami?name=done")
|
||||
assert.Equal(t, http.StatusNoContent, status)
|
||||
assert.Empty(t, body)
|
||||
|
||||
status, body, hdr := test.HTTPDo(t, path, http.MethodPost, "/v1/whoami?name=alice")
|
||||
assert.Equal(t, http.StatusMethodNotAllowed, status)
|
||||
assert.Equal(t, http.MethodGet, hdr.Get("Allow"))
|
||||
assert.Contains(t, body, "read only")
|
||||
|
||||
status, _, _ = test.HTTPDo(t, path, http.MethodDelete, "/v1")
|
||||
assert.Equal(t, http.StatusMethodNotAllowed, status)
|
||||
}
|
||||
|
||||
// TestInfoPanicDoesNotKillTheDaemon: a broken command costs a request, not the overlay.
|
||||
// This surface may be open to anyone on the host, so that holds against them too.
|
||||
func TestInfoPanicDoesNotKillTheDaemon(t *testing.T) {
|
||||
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||
|
||||
status, body := test.HTTPGet(t, path, "/v1/whoami?name=boom")
|
||||
assert.Equal(t, http.StatusInternalServerError, status)
|
||||
assert.JSONEq(t, `{"error":"command failed"}`, body)
|
||||
|
||||
status, body = test.HTTPGet(t, path, "/v1/whoami?name=alice")
|
||||
assert.Equal(t, http.StatusOK, status)
|
||||
assert.JSONEq(t, `{"name":"alice"}`, body)
|
||||
}
|
||||
|
||||
func TestInfoDescribe(t *testing.T) {
|
||||
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||
|
||||
status, body := test.HTTPGet(t, path, "/v1")
|
||||
require.Equal(t, http.StatusOK, status)
|
||||
|
||||
var schema []commands.CommandSchema
|
||||
require.NoError(t, json.Unmarshal([]byte(body), &schema))
|
||||
|
||||
var names []commands.Name
|
||||
flags := map[commands.Name][]string{}
|
||||
for _, c := range schema {
|
||||
names = append(names, c.Name)
|
||||
for _, f := range c.Flags {
|
||||
flags[c.Name] = append(flags[c.Name], f.Name)
|
||||
}
|
||||
}
|
||||
assert.ElementsMatch(t, []commands.Name{"help", "whoami"}, names, "only what is served is described")
|
||||
assert.Equal(t, []string{"name", "shout", commands.FlagJSON, commands.FlagPretty}, flags["whoami"])
|
||||
}
|
||||
|
||||
// TestInfoPresentationFlags: the query string takes -json and -pretty as a command line
|
||||
// would. The answer is JSON either way; pretty indents it.
|
||||
func TestInfoPresentationFlags(t *testing.T) {
|
||||
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||
|
||||
_, compact := test.HTTPGet(t, path, "/v1/whoami?name=alice&json=true")
|
||||
//nolint:testifylint // the exact bytes, newline included, are what is under test
|
||||
assert.Equal(t, "{\"name\":\"alice\"}\n", compact)
|
||||
|
||||
_, pretty := test.HTTPGet(t, path, "/v1/whoami?name=alice&pretty")
|
||||
//nolint:testifylint // the layout is what is under test
|
||||
assert.Equal(t, "{\n \"name\": \"alice\"\n}\n", pretty)
|
||||
|
||||
_, off := test.HTTPGet(t, path, "/v1/whoami?name=alice&pretty=false")
|
||||
assert.Equal(t, compact, off)
|
||||
}
|
||||
|
||||
// TestInfoModeChangeRefusesASwappedSocket: whoever can write the directory can replace
|
||||
// the node with a link to a file of their choosing; the daemon must not set the
|
||||
// operator's mode on that file. The node is seen to be gone, the link is refused by the
|
||||
// stale check, the file is untouched, and the endpoint reports itself down, since
|
||||
// nothing of ours is reachable at the path.
|
||||
func TestInfoModeChangeRefusesASwappedSocket(t *testing.T) {
|
||||
s, path := serveInfo(t, infoRegistry(), 0600)
|
||||
|
||||
target := filepath.Join(filepath.Dir(path), "target")
|
||||
require.NoError(t, os.WriteFile(target, nil, 0600))
|
||||
require.NoError(t, os.Remove(path))
|
||||
require.NoError(t, os.Symlink(target, path))
|
||||
|
||||
err := s.Rebind(context.Background(), path, Access{Mode: 0666})
|
||||
require.ErrorContains(t, err, "is not a socket")
|
||||
fi, err := os.Stat(target)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0600), fi.Mode().Perm(), "the file behind the link keeps its mode")
|
||||
assert.Empty(t, s.Path(), "nothing of ours answers at the path, so nothing is served")
|
||||
}
|
||||
|
||||
func TestInfoConfig(t *testing.T) {
|
||||
load := func(t *testing.T, yaml string) (infoConfig, error) {
|
||||
t.Helper()
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(yaml))
|
||||
return infoConfigFrom(c)
|
||||
}
|
||||
|
||||
cfg, err := load(t, "local_api: {}\n")
|
||||
require.NoError(t, err)
|
||||
assert.False(t, cfg.Enabled)
|
||||
|
||||
cfg, err = load(t, "local_api:\n info:\n socket: /run/nebula/info.sock\n")
|
||||
require.NoError(t, err)
|
||||
assert.False(t, cfg.Enabled, "a socket alone does not enable it")
|
||||
|
||||
_, err = load(t, "local_api:\n info:\n enabled: true\n")
|
||||
require.Error(t, err)
|
||||
require.ErrorContains(t, err, "needs a socket path")
|
||||
|
||||
cfg, err = load(t, "local_api:\n info:\n enabled: true\n socket: /run/nebula/info.sock\n")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, infoConfig{Enabled: true, Path: "/run/nebula/info.sock", Access: Access{Mode: 0600}}, cfg)
|
||||
|
||||
cfg, err = load(t, "local_api:\n info:\n enabled: true\n socket: /run/nebula/info.sock\n socket_mode: \"0660\"\n")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, infoConfig{Enabled: true, Path: "/run/nebula/info.sock", Access: Access{Mode: 0660}}, cfg)
|
||||
|
||||
_, err = load(t, "local_api:\n info:\n enabled: true\n socket: run/info.sock\n")
|
||||
require.Error(t, err, "a relative socket path is refused rather than resolved against anything")
|
||||
require.ErrorContains(t, err, "must be an absolute path")
|
||||
require.ErrorContains(t, err, InfoSocketKey)
|
||||
|
||||
_, err = load(t, "local_api:\n info:\n enabled: true\n socket: /run/nebula/info.sock\n socket_mode: 0660\n")
|
||||
require.Error(t, err, "a bare number is whichever integer the yaml parser made of it")
|
||||
require.ErrorContains(t, err, "quoted octal string")
|
||||
|
||||
for _, bad := range []string{`"abc"`, `"1777"`, `"08"`} {
|
||||
_, err = load(t, "local_api:\n info:\n enabled: true\n socket: /run/nebula/info.sock\n socket_mode: "+bad+"\n")
|
||||
require.Error(t, err, bad)
|
||||
require.ErrorContains(t, err, "not an octal file mode", bad)
|
||||
}
|
||||
|
||||
_, err = load(t, fmt.Sprintf("local_api:\n info:\n enabled: true\n socket: /%s\n", strings.Repeat("x", sunPathMax)))
|
||||
require.Error(t, err)
|
||||
assert.ErrorContains(t, err, "too long")
|
||||
}
|
||||
|
||||
// TestWireInfoFollowsConfig: off by default, up when enabled, down when disabled, and
|
||||
// never on the control socket's path.
|
||||
func TestWireInfoFollowsConfig(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancel)
|
||||
|
||||
ctlPath := testSocket(t)
|
||||
infoPath := testSocket(t)
|
||||
section := func(enabled bool, socket string) string {
|
||||
return fmt.Sprintf("local_api:\n control:\n socket: %s\n info:\n enabled: %t\n socket: %s\n", ctlPath, enabled, socket)
|
||||
}
|
||||
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(section(false, infoPath)))
|
||||
|
||||
var logs lockedBuffer
|
||||
eps := Wire(ctx, test.NewLoggerWithOutput(&logs), c, infoRegistry())
|
||||
t.Cleanup(eps.Stop)
|
||||
assert.Equal(t, ctlPath, eps.Control.Path())
|
||||
assert.Empty(t, eps.Info.Path(), "off until enabled")
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(section(true, infoPath)).Err)
|
||||
assert.Equal(t, infoPath, eps.Info.Path())
|
||||
status, body := test.HTTPGet(t, infoPath, "/v1/whoami?name=alice")
|
||||
assert.Equal(t, http.StatusOK, status)
|
||||
assert.JSONEq(t, `{"name":"alice"}`, body)
|
||||
|
||||
// A reload that changes nothing leaves it where it is.
|
||||
require.NoError(t, c.ReloadConfigString(section(true, infoPath)).Err)
|
||||
assert.Equal(t, infoPath, eps.Info.Path())
|
||||
|
||||
// A reload that moves the socket moves it, and removes the old one.
|
||||
moved := testSocket(t)
|
||||
require.NoError(t, c.ReloadConfigString(section(true, moved)).Err)
|
||||
assert.Equal(t, moved, eps.Info.Path())
|
||||
_, err := os.Stat(infoPath)
|
||||
assert.True(t, os.IsNotExist(err))
|
||||
status, body = test.HTTPGet(t, moved, "/v1/whoami?name=bob")
|
||||
assert.Equal(t, http.StatusOK, status)
|
||||
assert.JSONEq(t, `{"name":"bob"}`, body)
|
||||
require.NoError(t, c.ReloadConfigString(section(true, infoPath)).Err)
|
||||
require.Equal(t, infoPath, eps.Info.Path())
|
||||
|
||||
// The control socket's path is refused, and the running endpoint is kept, which is
|
||||
// what the log says.
|
||||
require.NoError(t, c.ReloadConfigString(section(true, ctlPath)).Err)
|
||||
assert.Equal(t, infoPath, eps.Info.Path())
|
||||
assert.Equal(t, ctlPath, eps.Control.Path())
|
||||
assert.Contains(t, logs.String(), "keeping the current endpoint")
|
||||
assert.NotContains(t, logs.String(), "Local info API is not available")
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(section(false, infoPath)).Err)
|
||||
assert.Empty(t, eps.Info.Path())
|
||||
_, err = os.Stat(infoPath)
|
||||
assert.True(t, os.IsNotExist(err))
|
||||
|
||||
// One Stop takes both down.
|
||||
require.NoError(t, c.ReloadConfigString(section(true, infoPath)).Err)
|
||||
eps.Stop()
|
||||
assert.Empty(t, eps.Info.Path())
|
||||
assert.Empty(t, eps.Control.Path())
|
||||
}
|
||||
|
||||
// TestWireInfoKeepsRunningOnABadReload: a typo in the section must not cut off the
|
||||
// programs relying on the endpoint; the operator is told and the endpoint stays.
|
||||
func TestWireInfoKeepsRunningOnABadReload(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancel)
|
||||
|
||||
infoPath := testSocket(t)
|
||||
good := fmt.Sprintf("local_api:\n info:\n enabled: true\n socket: %s\n", infoPath)
|
||||
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(good))
|
||||
|
||||
srv := wireInfo(ctx, test.NewLogger(), c, infoRegistry())
|
||||
t.Cleanup(srv.Stop)
|
||||
require.Equal(t, infoPath, srv.Path())
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(good+" socket_mode: 0660\n").Err)
|
||||
assert.Equal(t, infoPath, srv.Path())
|
||||
status, _ := test.HTTPGet(t, infoPath, "/v1/whoami")
|
||||
assert.Equal(t, http.StatusOK, status)
|
||||
}
|
||||
|
||||
// rawInfoRequest opens the socket and writes req as it is, so a test can send what an
|
||||
// HTTP client would not: a body that never arrives. It returns the connection.
|
||||
func rawInfoRequest(t *testing.T, path, req string) net.Conn {
|
||||
t.Helper()
|
||||
conn, err := net.DialTimeout("unix", path, time.Second)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { _ = conn.Close() })
|
||||
_, err = conn.Write([]byte(req))
|
||||
require.NoError(t, err)
|
||||
return conn
|
||||
}
|
||||
|
||||
// TestInfoRefusesARequestBody: a request that announces a body is answered 400 at once,
|
||||
// before the body arrives, and the connection is closed once the read deadline has ended
|
||||
// the wait for it, so a client that never sends the body holds its slot for the deadline
|
||||
// and no longer.
|
||||
func TestInfoRefusesARequestBody(t *testing.T) {
|
||||
oldHeader, oldRead := infoReadHeaderTimeout, infoReadTimeout
|
||||
infoReadHeaderTimeout, infoReadTimeout = 200*time.Millisecond, 300*time.Millisecond
|
||||
t.Cleanup(func() { infoReadHeaderTimeout, infoReadTimeout = oldHeader, oldRead })
|
||||
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||
|
||||
start := time.Now()
|
||||
conn := rawInfoRequest(t, path, "GET /v1/whoami HTTP/1.1\r\nHost: nebula\r\nContent-Length: 10\r\n\r\n")
|
||||
require.NoError(t, conn.SetReadDeadline(time.Now().Add(2*time.Second)))
|
||||
res, err := http.ReadResponse(bufio.NewReader(conn), nil)
|
||||
require.NoError(t, err)
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
res.Body.Close()
|
||||
assert.Equal(t, http.StatusBadRequest, res.StatusCode)
|
||||
assert.Contains(t, string(body), "takes no request body")
|
||||
assert.True(t, res.Close, "the connection is not kept for another request")
|
||||
assert.Less(t, time.Since(start), 200*time.Millisecond, "answered before the body, which never comes")
|
||||
|
||||
_, err = conn.Read(make([]byte, 1))
|
||||
require.ErrorIs(t, err, io.EOF, "the server closed the connection")
|
||||
assert.Less(t, time.Since(start), time.Second, "and did so at the read deadline, not later")
|
||||
}
|
||||
|
||||
// TestInfoDropsASlowClient: a client that sends its headers and then nothing loses its
|
||||
// connection at the read timeout rather than holding a slot for as long as it likes.
|
||||
func TestInfoDropsASlowClient(t *testing.T) {
|
||||
oldHeader, oldRead := infoReadHeaderTimeout, infoReadTimeout
|
||||
infoReadHeaderTimeout, infoReadTimeout = 200*time.Millisecond, 300*time.Millisecond
|
||||
t.Cleanup(func() { infoReadHeaderTimeout, infoReadTimeout = oldHeader, oldRead })
|
||||
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||
|
||||
// Half a request line, then silence: the header deadline ends it.
|
||||
conn := rawInfoRequest(t, path, "GET /v1/whoami HTTP/1.1\r\nHost: neb")
|
||||
require.NoError(t, conn.SetReadDeadline(time.Now().Add(2*time.Second)))
|
||||
start := time.Now()
|
||||
_, err := conn.Read(make([]byte, 1))
|
||||
require.Error(t, err, "the server closed the connection")
|
||||
assert.Less(t, time.Since(start), time.Second)
|
||||
|
||||
// And the server still answers the next client.
|
||||
status, _ := test.HTTPGet(t, path, "/v1/whoami")
|
||||
assert.Equal(t, http.StatusOK, status)
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
//go:build windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"io"
|
||||
"net"
|
||||
"net/http"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/Microsoft/go-winio"
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"golang.org/x/sys/windows"
|
||||
)
|
||||
|
||||
// TestInfoIsServedOnAPipe: the info API serves HTTP on a named pipe, whose security
|
||||
// descriptor is its access control the way a socket's mode is on unix; a group named
|
||||
// in the config is admitted by it.
|
||||
func TestInfoIsServedOnAPipe(t *testing.T) {
|
||||
users, err := windows.CreateWellKnownSid(windows.WinBuiltinUsersSid)
|
||||
require.NoError(t, err)
|
||||
group := Group{Name: "Users", ID: users.String()}
|
||||
|
||||
s := NewInfoServer(test.NewLogger(), commands.New())
|
||||
path := pipePrefix + "nebula-info-test"
|
||||
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: groupSocketMode, Group: group}))
|
||||
t.Cleanup(s.Stop)
|
||||
assert.Equal(t, path, s.Path())
|
||||
|
||||
client := &http.Client{Transport: &http.Transport{
|
||||
// What a program on the host has to do: ask for the data rights alone, since the
|
||||
// group is granted no more; see pipeClientAccess.
|
||||
DialContext: func(ctx context.Context, _, _ string) (net.Conn, error) {
|
||||
ctx, cancel := context.WithTimeout(ctx, 2*time.Second)
|
||||
defer cancel()
|
||||
return winio.DialPipeAccess(ctx, path, pipeClientAccess)
|
||||
},
|
||||
}}
|
||||
res, err := client.Get("http://nebula/v1")
|
||||
require.NoError(t, err)
|
||||
defer res.Body.Close()
|
||||
body, err := io.ReadAll(res.Body)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, http.StatusOK, res.StatusCode)
|
||||
assert.Contains(t, string(body), `"help"`)
|
||||
|
||||
// A change of group means a new pipe under the same name, still serving.
|
||||
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: groupSocketMode}))
|
||||
res, err = client.Get("http://nebula/v1")
|
||||
require.NoError(t, err)
|
||||
res.Body.Close()
|
||||
assert.Equal(t, http.StatusOK, res.StatusCode)
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
package localapi
|
||||
|
||||
// DirName is the directory under /var/run that holds nebula's sockets by default.
|
||||
const DirName = "nebula"
|
||||
|
||||
// CtlEnabledKey is the optional config key that turns the control socket off. It is on
|
||||
// unless the config says false, and reloadable: a reload that turns it off removes the
|
||||
// socket, and one that turns it back on brings it up again.
|
||||
const CtlEnabledKey = "local_api.control.enabled"
|
||||
|
||||
// ControlEnabled reports whether a config leaves the control socket on. nebula ctl reads
|
||||
// it too, so a client pointed at a config that turned the socket off says so rather than
|
||||
// failing to dial.
|
||||
func ControlEnabled(c interface{ GetBool(string, bool) bool }) bool {
|
||||
return c.GetBool(CtlEnabledKey, true)
|
||||
}
|
||||
|
||||
// CtlSocketKey is the optional config key naming the control socket. Unset, the socket
|
||||
// is DefaultSocketPath, one fixed path per platform that both the daemon and nebula ctl
|
||||
// know, which is what lets the endpoint work with no configuration on either side. It
|
||||
// suits a daemon running as root, which is what the tun device needs anyway. A daemon run as another user, or a second daemon on
|
||||
// one host, names its own. The CLI reads the same key, so when both sides see the same
|
||||
// config file they agree on the socket with nothing more said.
|
||||
const CtlSocketKey = "local_api.control.socket"
|
||||
|
||||
// CtlGroupKey is the optional config key naming a group that shares the control socket.
|
||||
// Unset, the socket admits the account nebula runs as and nobody else. Set, the socket
|
||||
// is handed to the group, 0660 on unix and an entry in the pipe's security descriptor on
|
||||
// windows; see Access and Server.trustSocket.
|
||||
const CtlGroupKey = "local_api.control.group"
|
||||
|
||||
// controlAccessFrom returns the control socket's access a config implies: the group
|
||||
// CtlGroupKey names, if any, and the mode that goes with having one or not.
|
||||
func controlAccessFrom(c interface{ GetString(string, string) string }) (Access, error) {
|
||||
group, err := groupFromConfig(c, CtlGroupKey)
|
||||
if err != nil {
|
||||
return Access{}, err
|
||||
}
|
||||
if group.ID == "" {
|
||||
return ownerOnly(), nil
|
||||
}
|
||||
return Access{Mode: groupSocketMode, Group: group}, nil
|
||||
}
|
||||
|
||||
// SocketPathFromConfig returns the control socket path a config implies: CtlSocketKey
|
||||
// when it is set, else DefaultSocketPath. A configured path must be absolute, so that
|
||||
// the daemon and nebula ctl, started from wherever the operator happens to be, name the
|
||||
// same socket from one config, and one this platform can bind; see checkSocketPath.
|
||||
func SocketPathFromConfig(c interface{ GetString(string, string) string }) (string, error) {
|
||||
override := c.GetString(CtlSocketKey, "")
|
||||
if override == "" {
|
||||
return DefaultSocketPath, nil
|
||||
}
|
||||
if err := checkSocketPath(CtlSocketKey, override); err != nil {
|
||||
return "", err
|
||||
}
|
||||
return override, nil
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
//go:build !windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
type fakeConfig map[string]string
|
||||
|
||||
func (f fakeConfig) GetString(k, d string) string {
|
||||
if v, ok := f[k]; ok {
|
||||
return v
|
||||
}
|
||||
return d
|
||||
}
|
||||
|
||||
// TestSocketPathFromConfigUsesTheDefault is what makes the endpoint work with no
|
||||
// configuration: the daemon and the CLI both land on the one fixed path.
|
||||
func TestSocketPathFromConfigUsesTheDefault(t *testing.T) {
|
||||
p, err := SocketPathFromConfig(fakeConfig{})
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "/var/run/nebula/ctl.sock", p)
|
||||
assert.Equal(t, DefaultSocketPath, p)
|
||||
}
|
||||
|
||||
func TestSocketPathFromConfigHonoursOverride(t *testing.T) {
|
||||
p, err := SocketPathFromConfig(fakeConfig{CtlSocketKey: "/tmp/custom.sock"})
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "/tmp/custom.sock", p, "the path is used as given")
|
||||
}
|
||||
|
||||
// TestSocketPathFromConfigRefusesARelativeOverride: the daemon and the CLI are started
|
||||
// from different directories, so a relative path would name two sockets from one config.
|
||||
// It is refused rather than resolved against anything.
|
||||
func TestSocketPathFromConfigRefusesARelativeOverride(t *testing.T) {
|
||||
for _, rel := range []string{"run/ctl.sock", "./ctl.sock", "ctl.sock", "../ctl.sock"} {
|
||||
_, err := SocketPathFromConfig(fakeConfig{CtlSocketKey: rel})
|
||||
require.Error(t, err, rel)
|
||||
require.ErrorContains(t, err, "must be an absolute path", rel)
|
||||
assert.ErrorContains(t, err, CtlSocketKey, rel)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSocketPathFromConfigRejectsOverlongOverride(t *testing.T) {
|
||||
_, err := SocketPathFromConfig(fakeConfig{CtlSocketKey: "/" + strings.Repeat("x", sunPathMax)})
|
||||
assert.ErrorContains(t, err, "too long for this platform")
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
//go:build darwin || freebsd
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"net"
|
||||
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// peerCheckSupported reports that this platform can identify a connecting process.
|
||||
const peerCheckSupported = true
|
||||
|
||||
// peerUID returns the uid of the process on the other end of conn.
|
||||
func peerUID(conn net.Conn) (uid uint32, err error) {
|
||||
err = withPeerFD(conn, func(fd int) error {
|
||||
xu, credErr := unix.GetsockoptXucred(fd, unix.SOL_LOCAL, unix.LOCAL_PEERCRED)
|
||||
if credErr != nil {
|
||||
return credErr
|
||||
}
|
||||
uid = xu.Uid
|
||||
return nil
|
||||
})
|
||||
return uid, err
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
//go:build linux
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"net"
|
||||
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// peerCheckSupported reports that this platform can identify a connecting process.
|
||||
const peerCheckSupported = true
|
||||
|
||||
// peerUID returns the uid of the process on the other end of conn.
|
||||
func peerUID(conn net.Conn) (uid uint32, err error) {
|
||||
err = withPeerFD(conn, func(fd int) error {
|
||||
cred, credErr := unix.GetsockoptUcred(fd, unix.SOL_SOCKET, unix.SO_PEERCRED)
|
||||
if credErr != nil {
|
||||
return credErr
|
||||
}
|
||||
uid = cred.Uid
|
||||
return nil
|
||||
})
|
||||
return uid, err
|
||||
}
|
||||
@@ -0,0 +1,62 @@
|
||||
//go:build netbsd
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"encoding/binary"
|
||||
"fmt"
|
||||
"net"
|
||||
"unsafe"
|
||||
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
const peerCheckSupported = true
|
||||
|
||||
// NetBSD reports the peer's identity through LOCAL_PEEREID at the SOL_LOCAL level,
|
||||
// filling a `struct unpcbid { pid_t unp_pid; uid_t unp_euid; gid_t unp_egid; }`.
|
||||
// golang.org/x/sys/unix has no typed wrapper for it, so the getsockopt goes out by hand
|
||||
// exactly the way that package's own generated wrappers do on this platform.
|
||||
const (
|
||||
solLocal = 0
|
||||
localPeerEID = 0x0003
|
||||
|
||||
unpcbidSize = 12
|
||||
unpcbidEUIDOffs = 4
|
||||
)
|
||||
|
||||
// peerUID returns the uid of the process on the other end of conn.
|
||||
//
|
||||
// Anything unexpected here is an error rather than a default, so a wrong constant or an
|
||||
// unsupported kernel refuses connections instead of silently admitting them.
|
||||
func peerUID(conn net.Conn) (uid uint32, err error) {
|
||||
err = withPeerFD(conn, func(fd int) error {
|
||||
var (
|
||||
buf [unpcbidSize]byte
|
||||
size = uint32(unpcbidSize)
|
||||
)
|
||||
|
||||
_, _, errno := unix.Syscall6(
|
||||
unix.SYS_GETSOCKOPT,
|
||||
uintptr(fd),
|
||||
uintptr(solLocal),
|
||||
uintptr(localPeerEID),
|
||||
uintptr(unsafe.Pointer(&buf[0])),
|
||||
uintptr(unsafe.Pointer(&size)),
|
||||
0,
|
||||
)
|
||||
if errno != 0 {
|
||||
return errno
|
||||
}
|
||||
|
||||
if size != unpcbidSize {
|
||||
return fmt.Errorf("LOCAL_PEEREID returned %d bytes, expected %d", size, unpcbidSize)
|
||||
}
|
||||
|
||||
// Read, not cast: the buffer is bytes, and a cast would fault on an
|
||||
// architecture that wants the uint32 aligned.
|
||||
uid = binary.NativeEndian.Uint32(buf[unpcbidEUIDOffs:])
|
||||
return nil
|
||||
})
|
||||
return uid, err
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
//go:build openbsd
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"net"
|
||||
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// peerCheckSupported reports that this platform can identify a connecting process.
|
||||
const peerCheckSupported = true
|
||||
|
||||
// peerUID returns the uid of the process on the other end of conn.
|
||||
//
|
||||
// OpenBSD reports the peer through SO_PEERCRED at SOL_SOCKET, filling a
|
||||
// `struct sockpeercred { uid_t uid; gid_t gid; pid_t pid; }`. System calls here have to
|
||||
// go through libc, so the raw getsockopt netbsd uses is not an option, and
|
||||
// golang.org/x/sys/unix has no typed wrapper for this struct. It does export
|
||||
// GetsockoptInt, which goes through its libc trampoline with a 4 byte buffer, and the
|
||||
// kernel copies out min(caller's length, option length): the first four bytes, which are
|
||||
// the uid. That is a dependence on the field order, the same one netbsd's offset carries.
|
||||
func peerUID(conn net.Conn) (uid uint32, err error) {
|
||||
err = withPeerFD(conn, func(fd int) error {
|
||||
v, credErr := unix.GetsockoptInt(fd, unix.SOL_SOCKET, unix.SO_PEERCRED)
|
||||
if credErr != nil {
|
||||
return credErr
|
||||
}
|
||||
// A uid_t is 32 bits; GetsockoptInt read exactly that many and widened it.
|
||||
uid = uint32(v)
|
||||
return nil
|
||||
})
|
||||
return uid, err
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
//go:build windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"net"
|
||||
)
|
||||
|
||||
// peerCheckSupported is false where the connecting process is not identified separately.
|
||||
//
|
||||
// On windows there is nothing to add: the pipe's security descriptor already admits
|
||||
// only the account nebula runs as, which is the check, not a second opinion on it.
|
||||
const peerCheckSupported = false
|
||||
|
||||
var errNoPeerCheck = errors.New("peer credentials are not available on this platform")
|
||||
|
||||
func peerUID(conn net.Conn) (uint32, error) {
|
||||
return 0, errNoPeerCheck
|
||||
}
|
||||
@@ -0,0 +1,357 @@
|
||||
//go:build !windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net"
|
||||
"os"
|
||||
"os/user"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
"sync"
|
||||
"syscall"
|
||||
"time"
|
||||
)
|
||||
|
||||
const network = "unix"
|
||||
|
||||
// withPeerFD runs f on the descriptor behind conn, which must be a unix socket, and
|
||||
// returns whichever error came first: not a unix socket, no raw access to it, or f's
|
||||
// own. It is the scaffolding every platform's peerUID shares; only the getsockopt inside
|
||||
// differs.
|
||||
func withPeerFD(conn net.Conn, f func(fd int) error) error {
|
||||
uc, ok := conn.(*net.UnixConn)
|
||||
if !ok {
|
||||
return fmt.Errorf("not a unix connection")
|
||||
}
|
||||
|
||||
raw, err := uc.SyscallConn()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var inner error
|
||||
if err := raw.Control(func(fd uintptr) { inner = f(int(fd)) }); err != nil {
|
||||
return err
|
||||
}
|
||||
return inner
|
||||
}
|
||||
|
||||
// currentUID is the user the owner checks are made for. A variable so a test can stand
|
||||
// in for root, or for a stranger, without owning a second account on the host.
|
||||
var currentUID = func() uint32 { return uint32(os.Geteuid()) }
|
||||
|
||||
// listen binds the socket at path with the given access.
|
||||
//
|
||||
// Access control is the socket's own mode and group, which the node is created no
|
||||
// looser than and which are set after bind: connect(2) needs write permission on the
|
||||
// socket file on every unix we build for. The control socket is 0600 and adds the peer
|
||||
// check the server applies on accept, unless a group shares it, in which case it is
|
||||
// 0660 with that group and the kernel's check is the whole of it; the info socket is
|
||||
// whatever the operator configured, since opening it to others is its purpose.
|
||||
//
|
||||
// The directory is not part of that, and is never chmoded: a directory a service manager made for us is served from at whatever mode it
|
||||
// came with (systemd's RuntimeDirectoryMode= is 0755 by default), and one an operator
|
||||
// pointed us into keeps whatever else it holds readable. The one we make ourselves is
|
||||
// 0755, searchable by everyone, so that a nebula ctl run as another user reaches the
|
||||
// socket and gets the kernel's answer, which for a member of the configured group is
|
||||
// a connection and for anyone else is permission denied.
|
||||
func listen(path string, acc Access) (net.Listener, error) {
|
||||
// The kernel silently truncates an over long sun_path and bind then fails with
|
||||
// "invalid argument", which tells an operator nothing. Say what is actually wrong.
|
||||
if pathTooLong(path) {
|
||||
return nil, fmt.Errorf("socket path is %d bytes, over the %d byte limit for a unix socket: %s", len(path), maxSocketPath, path)
|
||||
}
|
||||
|
||||
dir := filepath.Dir(path)
|
||||
|
||||
// One level only. Every directory defaultPathFor offers sits directly under one that
|
||||
// exists, and an operator who names a deeper path creates it; a missing parent is a
|
||||
// mistake to report, not a tree to build. A directory made here stays when the
|
||||
// socket goes: an empty one costs nothing, and the next start wants it again.
|
||||
//
|
||||
// The mode comes from the umask around the call, never from a chmod afterwards: a
|
||||
// chmod by path could land on whatever somebody who can write the parent swapped in
|
||||
// between the two calls, and a chmod through a descriptor on a root-owned directory
|
||||
// they moved there, since root owns both. Born 0755 there is nothing to fix up.
|
||||
// The umask is process wide and the window is one syscall; see umaskMu.
|
||||
umaskMu.Lock()
|
||||
old := syscall.Umask(0022)
|
||||
err := os.Mkdir(dir, 0755)
|
||||
syscall.Umask(old)
|
||||
umaskMu.Unlock()
|
||||
if err != nil && !errors.Is(err, os.ErrExist) {
|
||||
return nil, fmt.Errorf("could not create %s: %w", dir, err)
|
||||
}
|
||||
|
||||
// Whether it was made here or came with the environment, the directory has to be
|
||||
// one nobody else could change; see checkSocketDir.
|
||||
if err := checkSocketDir(dir); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if err := clearStale(path); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// bind creates the socket node at the process umask, and a connect(2) between that
|
||||
// and a later chmod would be queued for accept. Tighten the umask around the bind so
|
||||
// the node is never looser than 0600, however briefly, whatever mode it ends up at;
|
||||
// see umaskMu.
|
||||
umaskMu.Lock()
|
||||
old = syscall.Umask(0077)
|
||||
ln, err := net.Listen(network, path)
|
||||
syscall.Umask(old)
|
||||
umaskMu.Unlock()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// What was just bound, so that a failure below gives up that node and not whatever
|
||||
// has been put at the path since.
|
||||
id, _ := identifySocket(path)
|
||||
|
||||
// The node at path is given up by release, which unlinks it before the listener
|
||||
// closes; see there for why the order matters. Go's listener would unlink on Close
|
||||
// as well, and an unlink after the close could only be of whatever bound the path
|
||||
// next, so that is turned off and release is the one place the node is removed.
|
||||
if ul, ok := ln.(*net.UnixListener); ok {
|
||||
ul.SetUnlinkOnClose(false)
|
||||
}
|
||||
|
||||
// The umask only promises no looser than 0600; this pins the mode and the group
|
||||
// exactly, and is the one place a failure to secure the socket is reported.
|
||||
if err := applyAccess(path, acc); err != nil {
|
||||
release(ln, path, id)
|
||||
return nil, fmt.Errorf("could not secure %s: %w", path, err)
|
||||
}
|
||||
|
||||
return ln, nil
|
||||
}
|
||||
|
||||
// checkOwnSocket refuses what fi found at path unless it is a socket owned by the user
|
||||
// this process runs as. fi comes from a look that does not follow links, so a symlink is
|
||||
// seen as one, and the mode is only ever applied to a socket of ours. checkSocketDir
|
||||
// vouched for the directory at bind, but that was then: a directory loosened since, or a
|
||||
// reload that moves the socket, is a chance for whoever can write it to replace the node
|
||||
// with a link, or a hard link to a file of their choosing, and have a root daemon set the
|
||||
// configured mode, 0660 or 0666 for an info socket, on that file. A link, another type
|
||||
// of file, or somebody else's socket is reported and left as it is. applyAccess, per
|
||||
// platform, is what makes the look and the change land on the same node.
|
||||
func checkOwnSocket(path string, fi os.FileInfo) error {
|
||||
if !isSocket(fi) {
|
||||
return fmt.Errorf("%s is not a socket but %s, refusing to change its mode", path, describeNode(fi))
|
||||
}
|
||||
|
||||
if uid, ok := owner(fi); ok && uid != currentUID() {
|
||||
return fmt.Errorf("%s is owned by %s, not by us, refusing to change its mode", path, describeUID(uid))
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// describeNode names what kind of file fi describes, for a message about something found
|
||||
// where a socket was expected.
|
||||
func describeNode(fi os.FileInfo) string {
|
||||
switch m := fi.Mode(); {
|
||||
case m&os.ModeSymlink != 0:
|
||||
return "a symlink"
|
||||
case m.IsDir():
|
||||
return "a directory"
|
||||
case m.IsRegular():
|
||||
return "a regular file"
|
||||
default:
|
||||
return "a " + m.Type().String() + " file"
|
||||
}
|
||||
}
|
||||
|
||||
// checkSocketDir refuses to serve from a directory that somebody other than the user
|
||||
// nebula runs as, or root, could change. The socket's mode and group say who may connect
|
||||
// to it; what makes the path they connect to the daemon's is the directory, since
|
||||
// whoever can write it can put a socket of their own at the path and answer the clients
|
||||
// in the daemon's place. So the directory must be owned by the daemon's user or by root
|
||||
// and writable by its owner alone; a sticky bit is not an exception. A runtime directory
|
||||
// a service manager made for another user, or /var/run/nebula created ahead of a root
|
||||
// daemon by a member of group daemon, where darwin lets that group write /var/run, are
|
||||
// both refused with the owner named.
|
||||
//
|
||||
// A link where the directory should be is judged twice: whoever owns the link decides
|
||||
// where the path leads, so the link must be ours or root's too, and the directory it
|
||||
// resolves to is then held to the rule above. /var/run is such a link on linux, root's,
|
||||
// to /run, and a socket named directly under it is served; a link somebody else planted
|
||||
// is refused as theirs.
|
||||
//
|
||||
// Only this directory is checked, not the ones above it. /var/run itself is group
|
||||
// writable on darwin by design, and the parents are the operator's to trust, as they are
|
||||
// for every file nebula reads. The check is made at bind, so a directory loosened while
|
||||
// the daemon runs is noticed at the next reload.
|
||||
func checkSocketDir(dir string) error {
|
||||
fi, err := os.Lstat(dir)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if fi.Mode()&os.ModeSymlink != 0 {
|
||||
if uid, ok := owner(fi); ok && uid != currentUID() && uid != 0 {
|
||||
return fmt.Errorf("%s is a symlink owned by %s, not by the user nebula runs as or by root, and its owner decides where the path leads; name a socket path that does not go through it", dir, describeUID(uid))
|
||||
}
|
||||
if fi, err = os.Stat(dir); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
if !fi.IsDir() {
|
||||
return fmt.Errorf("%s is not a directory", dir)
|
||||
}
|
||||
|
||||
if uid, ok := owner(fi); ok && uid != currentUID() && uid != 0 {
|
||||
return fmt.Errorf("%s is owned by %s, not by the user nebula runs as or by root, and its owner could replace the socket; make it ours or root's, or name a socket path in a directory that is", dir, describeUID(uid))
|
||||
}
|
||||
|
||||
if perm := fi.Mode().Perm(); perm&0022 != 0 {
|
||||
who := "its group"
|
||||
if perm&0002 != 0 {
|
||||
who = "everyone"
|
||||
}
|
||||
return fmt.Errorf("%s is writable by %s (mode %04o), who could replace the socket; make it writable by its owner alone, or name a socket path in a directory that is", dir, who, perm)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// owner returns the uid that owns the file fi describes.
|
||||
func owner(fi os.FileInfo) (uint32, bool) {
|
||||
st, ok := fi.Sys().(*syscall.Stat_t)
|
||||
if !ok {
|
||||
return 0, false
|
||||
}
|
||||
return uint32(st.Uid), true
|
||||
}
|
||||
|
||||
// describeUID renders a uid with its account name when the host can say what it is, so
|
||||
// a message about somebody else's socket tells the operator who that is.
|
||||
func describeUID(uid uint32) string {
|
||||
id := strconv.FormatUint(uint64(uid), 10)
|
||||
if u, err := user.LookupId(id); err == nil && u.Username != "" {
|
||||
return "uid " + id + " (" + u.Username + ")"
|
||||
}
|
||||
|
||||
return "uid " + id
|
||||
}
|
||||
|
||||
// clearStale removes a leftover socket file, but only after proving nothing is
|
||||
// listening on it. An unclean restart leaves one behind every time, so this is a
|
||||
// routine path; blindly unlinking would let a second daemon steal a live endpoint.
|
||||
//
|
||||
// Liveness is a plain connect. Only a refused connect proves there is nothing behind
|
||||
// the file. Anything else, a timeout or a permission error, is a socket we cannot vouch
|
||||
// for, and it is left alone with the reason in the error.
|
||||
//
|
||||
// The look is an Lstat: a symlink at path is refused as not a socket, whether or not it
|
||||
// resolves. Stat would report a dangling one as nothing there, and bind(2) on darwin
|
||||
// and the BSDs follows a dangling link and creates the socket node at its target.
|
||||
func clearStale(path string) error {
|
||||
fi, err := os.Lstat(path)
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return nil
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
if !isSocket(fi) {
|
||||
return fmt.Errorf("%s exists and is not a socket", path)
|
||||
}
|
||||
|
||||
conn, err := dial(path, 250*time.Millisecond)
|
||||
if err == nil {
|
||||
_ = conn.Close()
|
||||
return fmt.Errorf("%s is already in use by another nebula instance", path)
|
||||
}
|
||||
|
||||
if errors.Is(err, os.ErrNotExist) {
|
||||
// Gone between the stat and the connect; nothing to clear.
|
||||
return nil
|
||||
}
|
||||
|
||||
if !errors.Is(err, syscall.ECONNREFUSED) {
|
||||
return fmt.Errorf("%s exists and could not be shown to be stale, refusing to remove it: %w", path, err)
|
||||
}
|
||||
|
||||
return os.Remove(path)
|
||||
}
|
||||
|
||||
// removeSocket unlinks the socket node. Its directory stays, whoever made it; see
|
||||
// listen.
|
||||
//
|
||||
// Only the node id names is removed. One that replaced it is another daemon's, bound
|
||||
// after ours was taken from under us, and is left where it is. A zero id, a node that
|
||||
// could not be identified when it was bound, is removed.
|
||||
func removeSocket(path string, id socketID) {
|
||||
if cur, ok := identifySocket(path); ok && id != (socketID{}) && cur != id {
|
||||
return
|
||||
}
|
||||
_ = os.Remove(path)
|
||||
}
|
||||
|
||||
// identifySocket returns the identity of the node at path, looked at without following
|
||||
// links, and false when there is nothing there or it cannot be read.
|
||||
func identifySocket(path string) (socketID, bool) {
|
||||
fi, err := os.Lstat(path)
|
||||
if err != nil {
|
||||
return socketID{}, false
|
||||
}
|
||||
st, ok := fi.Sys().(*syscall.Stat_t)
|
||||
if !ok {
|
||||
return socketID{}, false
|
||||
}
|
||||
return socketID{dev: uint64(st.Dev), ino: uint64(st.Ino)}, true
|
||||
}
|
||||
|
||||
func dial(path string, timeout time.Duration) (net.Conn, error) {
|
||||
return net.DialTimeout(network, path, timeout)
|
||||
}
|
||||
|
||||
// sunPathMax is the smallest sun_path any platform we build for offers (104 on darwin,
|
||||
// 108 on linux). Overrunning it truncates the path rather than failing cleanly, so we
|
||||
// check against the tighter bound everywhere.
|
||||
const sunPathMax = 104
|
||||
|
||||
// maxSocketPath is the longest path that actually binds. sun_path holds the trailing
|
||||
// NUL as well, and Go's syscall package refuses a path that fills the whole buffer
|
||||
// with a bare EINVAL, so the usable limit is one byte short of the buffer.
|
||||
const maxSocketPath = sunPathMax - 1
|
||||
|
||||
// umaskMu serialises the two places the process umask is set around one syscall: the
|
||||
// umask is process wide, and two endpoints binding at once, a reload landing during
|
||||
// startup, would otherwise interleave their save and restore and leave the daemon's
|
||||
// umask at one of ours. It is held for the syscall alone. Another goroutine creating a
|
||||
// file in that moment gets the umask of the window, 0022 or 0077, rather than the
|
||||
// process's own; nothing creates files on a hot path.
|
||||
var umaskMu sync.Mutex
|
||||
|
||||
func pathTooLong(path string) bool { return len(path) > maxSocketPath }
|
||||
|
||||
// DefaultSocketPath is the control socket when the config names none. It is root's to
|
||||
// create, as the tun device is root's to open; a daemon run as anyone else names a path
|
||||
// of its own with CtlSocketKey.
|
||||
const DefaultSocketPath = "/var/run/" + DirName + "/ctl.sock"
|
||||
|
||||
// unprotectedNameWarning is for windows pipe names; a unix socket's directory is
|
||||
// checked instead.
|
||||
func unprotectedNameWarning(string) string { return "" }
|
||||
|
||||
// checkSocketPath refuses a configured socket path that is relative, or too long to
|
||||
// bind. A relative path would mean a different socket to the daemon and to nebula ctl,
|
||||
// each resolving it against the directory it happened to be started from.
|
||||
func checkSocketPath(key, value string) error {
|
||||
if !filepath.IsAbs(value) {
|
||||
return fmt.Errorf("%s must be an absolute path, got %q", key, value)
|
||||
}
|
||||
if pathTooLong(value) {
|
||||
return fmt.Errorf("%s is %d bytes, too long for this platform: %s", key, len(value), value)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func isSocket(fi os.FileInfo) bool { return fi.Mode()&os.ModeSocket != 0 }
|
||||
@@ -0,0 +1,462 @@
|
||||
//go:build !windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"context"
|
||||
"net"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"syscall"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// privateBase returns a short directory of our own, 0700, for tests to lay sockets out
|
||||
// under, short enough that a path under it fits sun_path.
|
||||
func privateBase(t *testing.T) string {
|
||||
t.Helper()
|
||||
return test.ShortTempDir(t)
|
||||
}
|
||||
|
||||
// openDir returns a world writable directory under base, the shape of /tmp.
|
||||
func openDir(t *testing.T, base string) string {
|
||||
t.Helper()
|
||||
|
||||
open := filepath.Join(base, "open")
|
||||
require.NoError(t, os.Mkdir(open, 0777))
|
||||
require.NoError(t, os.Chmod(open, 0777|os.ModeSticky))
|
||||
return open
|
||||
}
|
||||
|
||||
// TestListenLeavesAServiceManagersDirectoryAlone covers the directory a service manager
|
||||
// pre-creates: systemd's RuntimeDirectory is 0755 by default. The socket is 0600, which
|
||||
// is what refuses other users, so the directory is served from as it came and nothing
|
||||
// is chmoded that the operator did not set.
|
||||
func TestListenLeavesAServiceManagersDirectoryAlone(t *testing.T) {
|
||||
base := privateBase(t)
|
||||
dir := filepath.Join(base, DirName)
|
||||
require.NoError(t, os.Mkdir(dir, 0755))
|
||||
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
require.NoError(t, s.Rebind(context.Background(), filepath.Join(dir, "s.sock"), ownerOnly()))
|
||||
t.Cleanup(s.Stop)
|
||||
|
||||
fi, err := os.Stat(dir)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0755), fi.Mode().Perm(), "the directory is left exactly as it was")
|
||||
|
||||
fi, err = os.Stat(s.Path())
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0600), fi.Mode().Perm(), "the socket is what is private")
|
||||
_, err = (&Client{Path: s.Path()}).Describe()
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
// TestListenCreatesOneLevelOnly: the socket directory is created when it is missing,
|
||||
// but nothing above it is. A runtime directory that does not exist is the operator's to
|
||||
// provide, and the failure says which directory could not be created.
|
||||
func TestListenCreatesOneLevelOnly(t *testing.T) {
|
||||
base := privateBase(t)
|
||||
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
require.NoError(t, s.Rebind(context.Background(), filepath.Join(base, DirName, "s.sock"), ownerOnly()))
|
||||
s.Stop()
|
||||
|
||||
dir := filepath.Join(base, "missing", DirName)
|
||||
err := s.Rebind(context.Background(), filepath.Join(dir, "s.sock"), ownerOnly())
|
||||
require.Error(t, err)
|
||||
require.ErrorContains(t, err, "could not create "+dir)
|
||||
assert.NoDirExists(t, filepath.Join(base, "missing"))
|
||||
}
|
||||
|
||||
// TestListenRestoresTheUmask: listen tightens the process umask around bind so the socket
|
||||
// node is never created looser than 0600. That is process wide state, so it must come
|
||||
// back exactly as it was, on success and on failure alike.
|
||||
func TestListenRestoresTheUmask(t *testing.T) {
|
||||
old := syscall.Umask(0022)
|
||||
t.Cleanup(func() { syscall.Umask(old) })
|
||||
|
||||
base := privateBase(t)
|
||||
ln, err := listen(filepath.Join(base, DirName, "s.sock"), ownerOnly())
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { ln.Close() })
|
||||
assert.Equal(t, 0022, syscall.Umask(0022), "umask after a successful listen")
|
||||
|
||||
_, err = listen(filepath.Join(base, DirName, "s.sock"), ownerOnly())
|
||||
require.Error(t, err, "the path is already bound")
|
||||
assert.Equal(t, 0022, syscall.Umask(0022), "umask after a failed listen")
|
||||
}
|
||||
|
||||
// TestListenServesFromASharedDirectory: an operator who points local_api.control.socket
|
||||
// into a directory holding other files, /etc/nebula say, gets a socket there and keeps
|
||||
// the config and certs readable by everyone who could read them before.
|
||||
func TestListenServesFromASharedDirectory(t *testing.T) {
|
||||
base := privateBase(t)
|
||||
dir := filepath.Join(base, "etc-nebula")
|
||||
require.NoError(t, os.Mkdir(dir, 0755))
|
||||
cfg := filepath.Join(dir, "config.yml")
|
||||
require.NoError(t, os.WriteFile(cfg, []byte("{}\n"), 0644))
|
||||
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
require.NoError(t, s.Rebind(context.Background(), filepath.Join(dir, "ctl.sock"), ownerOnly()))
|
||||
t.Cleanup(s.Stop)
|
||||
|
||||
fi, err := os.Stat(dir)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0755), fi.Mode().Perm())
|
||||
fi, err = os.Stat(cfg)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0644), fi.Mode().Perm())
|
||||
}
|
||||
|
||||
func TestOverlongPathIsDiagnosed(t *testing.T) {
|
||||
long := filepath.Join(os.TempDir(), string(make([]byte, 0)))
|
||||
for len(long) <= sunPathMax {
|
||||
long = filepath.Join(long, "abcdefghij")
|
||||
}
|
||||
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
err := s.Rebind(context.Background(), filepath.Join(long, "s.sock"), ownerOnly())
|
||||
|
||||
require.Error(t, err)
|
||||
assert.ErrorContains(t, err, "byte limit for a unix socket")
|
||||
}
|
||||
|
||||
// TestPathLimitIsExact pins the boundary: sun_path has room for the NUL as well, and Go
|
||||
// refuses a path that fills the whole buffer, so the last usable length is one short.
|
||||
func TestPathLimitIsExact(t *testing.T) {
|
||||
assert.False(t, pathTooLong(strings.Repeat("a", maxSocketPath)))
|
||||
assert.True(t, pathTooLong(strings.Repeat("a", maxSocketPath+1)))
|
||||
assert.True(t, pathTooLong(strings.Repeat("a", sunPathMax)))
|
||||
}
|
||||
|
||||
// TestNamedPathIsUsedAsGiven: a path the operator named is served from, and dialed,
|
||||
// wherever it is, a directory other users can write to included; the socket's own mode
|
||||
// is what keeps them out.
|
||||
func TestNamedPathIsUsedAsGiven(t *testing.T) {
|
||||
base := privateBase(t)
|
||||
path := filepath.Join(openDir(t, base), DirName, "s.sock")
|
||||
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
t.Cleanup(s.Stop)
|
||||
|
||||
_, err := (&Client{Path: path}).Describe()
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
// TestStaleSocketIsCleared: a dead socket in a good directory is the routine leftover of
|
||||
// a hard kill, and the daemon's stale check must see it as free to replace.
|
||||
func TestStaleSocketIsCleared(t *testing.T) {
|
||||
path := testSocket(t)
|
||||
require.NoError(t, os.Mkdir(filepath.Dir(path), 0700))
|
||||
ln, err := net.Listen(network, path)
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, os.Chmod(path, 0600))
|
||||
// Close the listener but keep the file, the way a hard kill does.
|
||||
ln.(*net.UnixListener).SetUnlinkOnClose(false)
|
||||
require.NoError(t, ln.Close())
|
||||
_, statErr := os.Stat(path)
|
||||
require.NoError(t, statErr, "the socket file is still there")
|
||||
|
||||
require.NoError(t, clearStale(path), "a stale socket is cleared, not reported as in use")
|
||||
_, statErr = os.Stat(path)
|
||||
assert.True(t, os.IsNotExist(statErr))
|
||||
}
|
||||
|
||||
// TestClientSaysWhenTheReplyCannotBeRead: something answered on the socket, but not
|
||||
// with a response. That is reported as a reply that could not be read, which is what
|
||||
// it is, and not as a failure to reach the daemon, whether the other side read the
|
||||
// request first or hung up on it: a daemon that is not nebula may do either.
|
||||
func TestClientSaysWhenTheReplyCannotBeRead(t *testing.T) {
|
||||
for _, readsFirst := range []bool{true, false} {
|
||||
path := testSocket(t)
|
||||
require.NoError(t, os.Mkdir(filepath.Dir(path), 0700))
|
||||
ln, err := net.Listen(network, path)
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, os.Chmod(path, 0600))
|
||||
|
||||
go func() {
|
||||
c, err := ln.Accept()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
if readsFirst {
|
||||
_, _ = bufio.NewReader(c).ReadBytes('\n')
|
||||
}
|
||||
_, _ = c.Write([]byte("this is not a response\n"))
|
||||
c.Close()
|
||||
}()
|
||||
|
||||
_, err = (&Client{Path: path}).Describe()
|
||||
var unread *ReplyError
|
||||
require.ErrorAs(t, err, &unread, "reads first: %v", readsFirst)
|
||||
assert.Contains(t, err.Error(), "the daemon's reply could not be read")
|
||||
ln.Close()
|
||||
}
|
||||
}
|
||||
|
||||
// TestClientGivesUpOnASilentDaemon: a daemon that accepts and then never answers must
|
||||
// not hang the client for good. A script wrapping nebula ctl has no other way out.
|
||||
func TestClientGivesUpOnASilentDaemon(t *testing.T) {
|
||||
path := testSocket(t)
|
||||
require.NoError(t, os.Mkdir(filepath.Dir(path), 0700))
|
||||
ln, err := net.Listen(network, path)
|
||||
require.NoError(t, err)
|
||||
defer ln.Close()
|
||||
require.NoError(t, os.Chmod(path, 0600))
|
||||
|
||||
accepted := make(chan net.Conn, 1)
|
||||
go func() {
|
||||
c, err := ln.Accept()
|
||||
if err == nil {
|
||||
accepted <- c // held open, never written to
|
||||
}
|
||||
}()
|
||||
|
||||
start := time.Now()
|
||||
_, err = (&Client{Path: path, Timeout: 200 * time.Millisecond}).Describe()
|
||||
require.Error(t, err)
|
||||
require.ErrorContains(t, err, "did not answer within")
|
||||
assert.Less(t, time.Since(start), 5*time.Second)
|
||||
|
||||
select {
|
||||
case c := <-accepted:
|
||||
_ = c.Close()
|
||||
default:
|
||||
}
|
||||
}
|
||||
|
||||
// asUID makes the owner checks run as uid for the rest of the test. The socket the test
|
||||
// serves is still owned by the real user, so from uid's point of view it belongs to
|
||||
// somebody else: the shape of a service account's daemon, and of an impostor's.
|
||||
func asUID(t *testing.T, uid uint32) {
|
||||
t.Helper()
|
||||
real := currentUID
|
||||
currentUID = func() uint32 { return uid }
|
||||
t.Cleanup(func() { currentUID = real })
|
||||
}
|
||||
|
||||
// TestPeerCheckRefusesAnotherUser: a server built as one user and serving as another
|
||||
// refuses the real user at the peer check, and the refusal reaches the client as the
|
||||
// daemon's answer rather than as a failure to reach it.
|
||||
func TestPeerCheckRefusesAnotherUser(t *testing.T) {
|
||||
if !peerCheckSupported {
|
||||
t.Skip("no peer credentials on this platform")
|
||||
}
|
||||
|
||||
me := currentUID()
|
||||
asUID(t, me+1)
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
asUID(t, me)
|
||||
|
||||
path := testSocket(t)
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
defer s.Stop()
|
||||
|
||||
_, err := (&Client{Path: path}).Describe()
|
||||
require.Error(t, err)
|
||||
require.ErrorContains(t, err, "not permitted")
|
||||
var refused *DaemonError
|
||||
assert.ErrorAs(t, err, &refused, "the daemon answered; this is not a reachability failure")
|
||||
}
|
||||
|
||||
// TestListenerDoesNotUnlinkOnClose: the server unlinks its socket node itself, before
|
||||
// the listener closes, and the listener must not unlink again afterwards. By the time a
|
||||
// close happens the path may belong to a newer daemon that found the node stale and
|
||||
// bound its own, and a second unlink would take that daemon's socket from under it.
|
||||
func TestListenerDoesNotUnlinkOnClose(t *testing.T) {
|
||||
path := filepath.Join(privateBase(t), DirName, "s.sock")
|
||||
old, err := listen(path, ownerOnly())
|
||||
require.NoError(t, err)
|
||||
|
||||
// A newer daemon's start, with the old node gone and the path bound afresh.
|
||||
require.NoError(t, os.Remove(path))
|
||||
next, err := net.Listen(network, path)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { next.Close() })
|
||||
|
||||
require.NoError(t, old.Close())
|
||||
_, err = os.Stat(path)
|
||||
assert.NoError(t, err, "closing the old listener left the newer daemon's socket in place")
|
||||
}
|
||||
|
||||
// TestRebindRecreatesASocketRemovedFromUnderIt: logind clearing /run/user/<uid> on
|
||||
// logout, or a unit cleaning a RuntimeDirectory= it shares, takes the node away while
|
||||
// the listener stays open and unreachable. The next reload, which Rebinds onto the same
|
||||
// path, has to notice and bind the socket again rather than return early because the
|
||||
// path has not changed.
|
||||
func TestRebindRecreatesASocketRemovedFromUnderIt(t *testing.T) {
|
||||
path := testSocket(t)
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
t.Cleanup(s.Stop)
|
||||
|
||||
require.NoError(t, os.Remove(path))
|
||||
_, err := (&Client{Path: path}).Describe()
|
||||
require.Error(t, err, "nothing can reach the daemon with its node gone")
|
||||
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
assert.Equal(t, path, s.Path())
|
||||
_, err = (&Client{Path: path}).Describe()
|
||||
require.NoError(t, err, "the plain reload brought the socket back")
|
||||
|
||||
// And a Rebind with the socket in place is still a no-op.
|
||||
before, ok := identifySocket(path)
|
||||
require.True(t, ok)
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
after, _ := identifySocket(path)
|
||||
assert.Equal(t, before, after, "the node was left alone")
|
||||
}
|
||||
|
||||
// TestStopLeavesAStrangersSocketAlone: once our node has been taken from under us and
|
||||
// another daemon has bound the path, the node there is that daemon's, and our Stop must
|
||||
// not unlink it by path.
|
||||
func TestStopLeavesAStrangersSocketAlone(t *testing.T) {
|
||||
path := testSocket(t)
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
|
||||
require.NoError(t, os.Remove(path))
|
||||
other, err := net.Listen(network, path)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { other.Close() })
|
||||
|
||||
s.Stop()
|
||||
_, err = os.Stat(path)
|
||||
assert.NoError(t, err, "the newer daemon's socket is still in place")
|
||||
}
|
||||
|
||||
// TestListenRefusesADirectoryOthersCanWrite: whoever can write the socket's directory
|
||||
// can put a socket of their own at the path and answer the clients, who trust the path;
|
||||
// so a directory writable by its group or by everyone is refused, and nothing is bound.
|
||||
func TestListenRefusesADirectoryOthersCanWrite(t *testing.T) {
|
||||
for _, mode := range []os.FileMode{0775, 0757, 0777, 01777} {
|
||||
dir := filepath.Join(privateBase(t), "loose")
|
||||
require.NoError(t, os.Mkdir(dir, mode))
|
||||
require.NoError(t, os.Chmod(dir, mode))
|
||||
|
||||
_, err := listen(filepath.Join(dir, "s.sock"), ownerOnly())
|
||||
require.ErrorContains(t, err, "writable by", "mode %04o", mode)
|
||||
assert.NoFileExists(t, filepath.Join(dir, "s.sock"))
|
||||
}
|
||||
}
|
||||
|
||||
// TestListenRefusesADirectoryOwnedBySomebodyElse: a directory that is neither ours nor
|
||||
// root's is refused, since its owner could replace the socket. The test's own directory
|
||||
// stands in for somebody else's by the process pretending to be another user.
|
||||
func TestListenRefusesADirectoryOwnedBySomebodyElse(t *testing.T) {
|
||||
me := currentUID()
|
||||
if me == 0 {
|
||||
t.Skip("root's directories are accepted whoever is asking")
|
||||
}
|
||||
dir := filepath.Join(privateBase(t), "theirs")
|
||||
require.NoError(t, os.Mkdir(dir, 0755))
|
||||
|
||||
asUID(t, me+1)
|
||||
_, err := listen(filepath.Join(dir, "s.sock"), ownerOnly())
|
||||
require.ErrorContains(t, err, "is owned by")
|
||||
assert.NoFileExists(t, filepath.Join(dir, "s.sock"))
|
||||
|
||||
asUID(t, me)
|
||||
ln, err := listen(filepath.Join(dir, "s.sock"), ownerOnly())
|
||||
require.NoError(t, err, "the same directory, seen as our own, serves")
|
||||
release(ln, filepath.Join(dir, "s.sock"), socketID{})
|
||||
}
|
||||
|
||||
// TestListenThroughASymlinkedDirectory: a link where the directory should be is judged
|
||||
// by who owns it, since they decide where the path leads, and then by the directory it
|
||||
// resolves to. Our own link to a proper directory serves, as /var/run on linux is root's
|
||||
// link to /run; somebody else's link is refused, and so is a link of ours to a directory
|
||||
// others can write.
|
||||
func TestListenThroughASymlinkedDirectory(t *testing.T) {
|
||||
me := currentUID()
|
||||
if me == 0 {
|
||||
t.Skip("root's links are accepted whoever is asking")
|
||||
}
|
||||
base := privateBase(t)
|
||||
real := filepath.Join(base, "real")
|
||||
require.NoError(t, os.Mkdir(real, 0755))
|
||||
link := filepath.Join(base, "link")
|
||||
require.NoError(t, os.Symlink(real, link))
|
||||
path := filepath.Join(link, "s.sock")
|
||||
|
||||
ln, err := listen(path, ownerOnly())
|
||||
require.NoError(t, err, "our link to our directory")
|
||||
release(ln, path, socketID{})
|
||||
assert.NoFileExists(t, filepath.Join(real, "s.sock"))
|
||||
|
||||
asUID(t, me+1)
|
||||
_, err = listen(path, ownerOnly())
|
||||
require.ErrorContains(t, err, "is a symlink owned by")
|
||||
asUID(t, me)
|
||||
|
||||
require.NoError(t, os.Chmod(real, 0777))
|
||||
_, err = listen(path, ownerOnly())
|
||||
require.ErrorContains(t, err, "writable by everyone")
|
||||
}
|
||||
|
||||
// TestListenRefusesASymlinkAtThePath: a link where the socket should be is somebody
|
||||
// else's doing, and it is refused before bind rather than followed. bind(2) on darwin
|
||||
// follows a dangling link and creates the socket at its target, and the chmod after it
|
||||
// would follow a link to anything, so neither the target nor the link is touched.
|
||||
func TestListenRefusesASymlinkAtThePath(t *testing.T) {
|
||||
path := testSocket(t)
|
||||
require.NoError(t, os.Mkdir(filepath.Dir(path), 0700))
|
||||
target := filepath.Join(filepath.Dir(path), "target")
|
||||
|
||||
require.NoError(t, os.Symlink(target, path))
|
||||
_, err := listen(path, Access{Mode: 0666})
|
||||
require.ErrorContains(t, err, "is not a socket")
|
||||
_, statErr := os.Lstat(target)
|
||||
assert.True(t, os.IsNotExist(statErr), "a dangling link's target is not created")
|
||||
|
||||
require.NoError(t, os.WriteFile(target, nil, 0600))
|
||||
_, err = listen(path, Access{Mode: 0666})
|
||||
require.ErrorContains(t, err, "is not a socket")
|
||||
fi, err := os.Stat(target)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0600), fi.Mode().Perm(), "the file the link names keeps its mode")
|
||||
assert.True(t, fi.Mode().IsRegular())
|
||||
}
|
||||
|
||||
// TestChmodSocketRefusesWhatIsNotOurSocket: the mode is set through a look that does not
|
||||
// follow links, so a link, a plain file, or a socket of another user's at the path is
|
||||
// reported instead of chmoded. The last is seen as another user by changing who we are.
|
||||
func TestChmodSocketRefusesWhatIsNotOurSocket(t *testing.T) {
|
||||
dir := filepath.Join(privateBase(t), "n")
|
||||
require.NoError(t, os.Mkdir(dir, 0700))
|
||||
|
||||
file := filepath.Join(dir, "file")
|
||||
require.NoError(t, os.WriteFile(file, nil, 0600))
|
||||
link := filepath.Join(dir, "link")
|
||||
require.NoError(t, os.Symlink(file, link))
|
||||
|
||||
require.ErrorContains(t, applyAccess(link, Access{Mode: 0666}), "a symlink")
|
||||
require.ErrorContains(t, applyAccess(file, Access{Mode: 0666}), "a regular file")
|
||||
fi, err := os.Stat(file)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0600), fi.Mode().Perm())
|
||||
|
||||
sock := filepath.Join(dir, "s.sock")
|
||||
ln, err := net.Listen(network, sock)
|
||||
require.NoError(t, err)
|
||||
defer ln.Close()
|
||||
require.NoError(t, applyAccess(sock, Access{Mode: 0660}))
|
||||
fi, err = os.Stat(sock)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0660), fi.Mode().Perm())
|
||||
|
||||
asUID(t, currentUID()+1)
|
||||
require.ErrorContains(t, applyAccess(sock, Access{Mode: 0666}), "not by us")
|
||||
fi, err = os.Stat(sock)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0660), fi.Mode().Perm())
|
||||
}
|
||||
@@ -0,0 +1,272 @@
|
||||
//go:build windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/Microsoft/go-winio"
|
||||
"golang.org/x/sys/windows"
|
||||
)
|
||||
|
||||
// pipePrefix is where windows named pipes live. The pipe's own security descriptor
|
||||
// carries the access control that the socket's mode carries on unix.
|
||||
const pipePrefix = `\\.\pipe\`
|
||||
|
||||
// protectedPrefix is the pipe namespace that only administrators and SYSTEM may create
|
||||
// names under; the kernel refuses everyone else. The default name lives there, so the
|
||||
// name itself says who could have created the pipe answering it: no ordinary user can
|
||||
// have put anything under it ahead of the daemon. Tailscale, WireGuard and NetBird keep
|
||||
// their daemon pipes there for the same reason. nebula on windows is already an
|
||||
// administrator, since creating the tun adapter requires it.
|
||||
const protectedPrefix = pipePrefix + `ProtectedPrefix\Administrators\`
|
||||
|
||||
const network = "pipe"
|
||||
|
||||
// currentUID is the identity the unix owner checks are made for. There is no uid here
|
||||
// and no per-connection check that would read one, so the value is never consulted; it
|
||||
// exists so a Server is built the same way on every platform.
|
||||
var currentUID = func() uint32 { return 0 }
|
||||
|
||||
// listen creates the named pipe at path with a security descriptor that admits the user
|
||||
// nebula runs as, SYSTEM and Administrators, and the group acc names, if any, for
|
||||
// reading and writing, which is what connecting to a pipe takes. acc's mode means
|
||||
// nothing to a pipe.
|
||||
//
|
||||
// The first instance is created, never opened, so a name some other process already
|
||||
// holds is refused rather than joined: that process would otherwise answer clients in
|
||||
// nebula's place. Under protectedPrefix only an administrator could hold it; anywhere
|
||||
// else any account could. Either way the refusal is reported as errEndpointHeld for the
|
||||
// caller to log as the event it is, except when the refusal is the namespace's own: a
|
||||
// daemon that is not an administrator cannot create under protectedPrefix at all, and
|
||||
// that is told apart so the operator is sent to elevate or to name a pipe elsewhere
|
||||
// rather than to look for a process that is not there.
|
||||
func listen(path string, acc Access) (net.Listener, error) {
|
||||
sddl, err := sddlFor(acc)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not build a security descriptor for %s: %w", path, err)
|
||||
}
|
||||
|
||||
ln, err := winio.ListenPipe(path, &winio.PipeConfig{
|
||||
SecurityDescriptor: sddl,
|
||||
InputBufferSize: int32(MaxRequestBytes),
|
||||
OutputBufferSize: 64 * 1024,
|
||||
})
|
||||
if err != nil {
|
||||
return nil, listenRefused(path, isAdministrator(), err)
|
||||
}
|
||||
|
||||
return ln, nil
|
||||
}
|
||||
|
||||
// listenRefused turns a failure to create the pipe at path into the error the caller
|
||||
// logs. admin says whether this process may create under protectedPrefix.
|
||||
//
|
||||
// ERROR_ACCESS_DENIED is ambiguous: it is what the kernel says to a non-administrator
|
||||
// creating under protectedPrefix, and also what an existing instance whose DACL does
|
||||
// not admit us says to a second create. A process that is an administrator cannot be
|
||||
// getting the first, so for it, and for every name outside the prefix, access denied
|
||||
// means held.
|
||||
func listenRefused(path string, admin bool, err error) error {
|
||||
if errors.Is(err, windows.ERROR_ACCESS_DENIED) && isProtectedPath(path) && !admin {
|
||||
return fmt.Errorf("creating %s requires an administrator, as only administrators may create pipes under %s; run nebula elevated, or set %s to a pipe name outside it: %w", path, protectedPrefix, CtlSocketKey, err)
|
||||
}
|
||||
if errors.Is(err, windows.ERROR_ALREADY_EXISTS) || errors.Is(err, windows.ERROR_ACCESS_DENIED) {
|
||||
return fmt.Errorf("%w: %s: %w", errEndpointHeld, path, err)
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
// isProtectedPath says whether path is a name under protectedPrefix. Pipe names are
|
||||
// case insensitive, so the comparison is too.
|
||||
func isProtectedPath(path string) bool {
|
||||
return len(path) > len(protectedPrefix) && strings.EqualFold(path[:len(protectedPrefix)], protectedPrefix)
|
||||
}
|
||||
|
||||
// isAdministrator says whether this process holds Administrators as an enabled group,
|
||||
// which is what creating under protectedPrefix takes. SYSTEM holds it; an elevated
|
||||
// administrator holds it; an administrator's unelevated token carries it deny-only,
|
||||
// which the membership check correctly reads as no. The membership is checked against
|
||||
// the thread's own token: CheckTokenMembership wants an impersonation token and makes
|
||||
// one from the primary token when handed none. A check that cannot be made is read as
|
||||
// not an administrator, which only changes the wording of a failure that has already
|
||||
// happened.
|
||||
func isAdministrator() bool {
|
||||
admins, err := windows.CreateWellKnownSid(windows.WinBuiltinAdministratorsSid)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
member, err := windows.Token(0).IsMember(admins)
|
||||
return err == nil && member
|
||||
}
|
||||
|
||||
// sddlFor grants full access to the account nebula is running as, to SYSTEM and to
|
||||
// Administrators, and pipeClientAccess to the group acc names, if any; nobody else. P
|
||||
// makes the DACL protected, so it does not inherit entries that would widen it. It is
|
||||
// dockerd's descriptor for its pipe, with its -G group in the same place, except for
|
||||
// the group's mask; see pipeClientAccess.
|
||||
//
|
||||
// Administrators is the counterpart of the uid 0 allowance in the unix peer check. The
|
||||
// service normally runs as LocalSystem, so without it an operator in an elevated shell
|
||||
// could not reach the daemon at all; and an administrator can already stop the service,
|
||||
// so this grants no authority they did not have.
|
||||
func sddlFor(acc Access) (string, error) {
|
||||
token := windows.GetCurrentProcessToken()
|
||||
|
||||
user, err := token.GetTokenUser()
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
sddl := fmt.Sprintf("D:P(A;;GA;;;%s)(A;;GA;;;SY)(A;;GA;;;BA)", user.User.Sid.String())
|
||||
if acc.shared() {
|
||||
sddl += fmt.Sprintf("(A;;0x%x;;;%s)", pipeClientAccess, acc.Group.ID)
|
||||
}
|
||||
return sddl, nil
|
||||
}
|
||||
|
||||
// pipeClientAccess is what a client needs on the pipe to talk to the daemon, and all a
|
||||
// configured group is granted: read and write the data, read the pipe's attributes
|
||||
// and its security descriptor, which the owner check needs, and wait on it. Not the
|
||||
// generic rights. On a named pipe GENERIC_WRITE carries FILE_CREATE_PIPE_INSTANCE, the
|
||||
// right to put a second instance under the same name, and a group member with that
|
||||
// could sit on the name and answer other clients in the daemon's place; the client's
|
||||
// owner check would not catch it, since the instance it reached would be the
|
||||
// member's. A client therefore has to ask for exactly this, as dial does, and a
|
||||
// program that opens the info pipe with generic read and write is refused.
|
||||
const pipeClientAccess uint32 = windows.FILE_READ_DATA | windows.FILE_WRITE_DATA |
|
||||
windows.FILE_READ_ATTRIBUTES | windows.READ_CONTROL | windows.SYNCHRONIZE
|
||||
|
||||
// removeSocket is a no-op: a named pipe disappears when its last handle closes, so
|
||||
// there is nothing to unlink and no stale instance to clean up.
|
||||
func removeSocket(path string, id socketID) {}
|
||||
|
||||
// identifySocket has no node to identify: a pipe is its handle, and it cannot be
|
||||
// removed from under the daemon, so an endpoint on its path is always still there.
|
||||
func identifySocket(path string) (socketID, bool) { return socketID{}, true }
|
||||
|
||||
// applyAccess cannot change a pipe's access in place: its security descriptor is fixed
|
||||
// when it is created, so a change means creating it again, which the caller does.
|
||||
func applyAccess(path string, acc Access) error { return errReopenForAccess }
|
||||
|
||||
// dial connects to the pipe and, before the connection carries anything, checks who
|
||||
// serves it. The request names a command and its arguments, so it must not reach a
|
||||
// pipe that some other account put under nebula's name. For the default name the
|
||||
// namespace already promises that, since only an administrator could have created it;
|
||||
// the check is what covers a CtlSocketKey override outside protectedPrefix, and costs
|
||||
// nothing to make on every name.
|
||||
func dial(path string, timeout time.Duration) (net.Conn, error) {
|
||||
ctx, cancel := context.WithTimeout(context.Background(), timeout)
|
||||
defer cancel()
|
||||
conn, err := winio.DialPipeAccess(ctx, path, pipeClientAccess)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if err := checkPipeOwner(conn, path); err != nil {
|
||||
conn.Close()
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return conn, nil
|
||||
}
|
||||
|
||||
// checkPipeOwner refuses a pipe whose owner is not an account that could be running
|
||||
// nebula. It is the unix owner check made from the other side: the handle winio dialed
|
||||
// exposes the pipe object, and the object's owner is whoever created it.
|
||||
//
|
||||
// The owner is what makes this sound. An account can only create an object owned by
|
||||
// itself, or by a SID it holds with the owner flag, unless it has SeRestorePrivilege,
|
||||
// which ordinary users do not; so a pipe owned by SYSTEM, Administrators or a service
|
||||
// account was put there by one of them, and never by a user squatting the name. winio
|
||||
// dials with SECURITY_ANONYMOUS, so the impostor could not have impersonated the client
|
||||
// either, but it could have read the command and answered it with whatever it liked.
|
||||
func checkPipeOwner(conn net.Conn, path string) error {
|
||||
h, ok := conn.(interface{ Fd() uintptr })
|
||||
if !ok {
|
||||
return fmt.Errorf("%s: cannot identify who serves the pipe", path)
|
||||
}
|
||||
|
||||
sd, err := windows.GetSecurityInfo(windows.Handle(h.Fd()), windows.SE_KERNEL_OBJECT, windows.OWNER_SECURITY_INFORMATION)
|
||||
if err != nil {
|
||||
return fmt.Errorf("%s: could not read the pipe's owner: %w", path, err)
|
||||
}
|
||||
|
||||
owner, _, err := sd.Owner()
|
||||
if err != nil {
|
||||
return fmt.Errorf("%s: could not read the pipe's owner: %w", path, err)
|
||||
}
|
||||
if owner == nil {
|
||||
return fmt.Errorf("%s has no owner; refusing to send to it", path)
|
||||
}
|
||||
|
||||
me, err := windows.GetCurrentProcessToken().GetTokenUser()
|
||||
if err != nil {
|
||||
return fmt.Errorf("%s: could not read own identity: %w", path, err)
|
||||
}
|
||||
|
||||
if ownerAccepted(owner, me.User.Sid) {
|
||||
return nil
|
||||
}
|
||||
|
||||
return fmt.Errorf("%s is served by %s, not by nebula; run nebula ctl as that user, or pass -config or -socket to name the daemon's pipe", path, describeSID(owner))
|
||||
}
|
||||
|
||||
// ownerAccepted says whether a pipe owned by owner may be sent a request by a client
|
||||
// running as me: the client's own account, and the two accounts a daemon runs under
|
||||
// that no ordinary user can create an object as, SYSTEM and Administrators. Another
|
||||
// account is refused, whoever the client is; the daemon's DACL decides who may connect,
|
||||
// and this decides who may answer.
|
||||
func ownerAccepted(owner, me *windows.SID) bool {
|
||||
return owner.Equals(me) ||
|
||||
owner.IsWellKnown(windows.WinLocalSystemSid) ||
|
||||
owner.IsWellKnown(windows.WinBuiltinAdministratorsSid)
|
||||
}
|
||||
|
||||
// describeSID renders a SID with its account name when the host can say what it is, so
|
||||
// a message about somebody else's pipe tells the operator who that is.
|
||||
func describeSID(sid *windows.SID) string {
|
||||
account, domain, _, err := sid.LookupAccount("")
|
||||
if err != nil || account == "" {
|
||||
return sid.String()
|
||||
}
|
||||
if domain == "" {
|
||||
return account
|
||||
}
|
||||
return domain + `\` + account
|
||||
}
|
||||
|
||||
// DefaultSocketPath is the control pipe when the config names none. It is under
|
||||
// protectedPrefix, so whatever answers it was created by an administrator or SYSTEM; see
|
||||
// there.
|
||||
const DefaultSocketPath = protectedPrefix + "nebula-ctl"
|
||||
|
||||
// checkSocketPath refuses a configured name that is not a full pipe name. A pipe lives
|
||||
// under pipePrefix and nowhere else, so a bare name has no meaning here, and one under
|
||||
// pipePrefix is used as given. An override outside protectedPrefix is a name any
|
||||
// account could have created first; the owner check in dial is what protects a client
|
||||
// of one.
|
||||
// unprotectedNameWarning says what a pipe name outside protectedPrefix costs, or "" for
|
||||
// one under it. A program reading the info API opens the pipe by name and has no owner
|
||||
// check of its own, so for a name any local user could create first, whoever did
|
||||
// would be answering its queries; the daemon refuses to serve a held name and logs it,
|
||||
// but the program cannot tell. The default control pipe is under the prefix; an info
|
||||
// pipe is wherever the operator put it.
|
||||
func unprotectedNameWarning(path string) string {
|
||||
if len(path) >= len(protectedPrefix) && strings.EqualFold(path[:len(protectedPrefix)], protectedPrefix) {
|
||||
return ""
|
||||
}
|
||||
return "any local user can create a pipe by this name ahead of the daemon and answer in its place; name it under " + protectedPrefix
|
||||
}
|
||||
|
||||
func checkSocketPath(key, value string) error {
|
||||
if len(value) <= len(pipePrefix) || !strings.EqualFold(value[:len(pipePrefix)], pipePrefix) {
|
||||
return fmt.Errorf(`%s must be a full pipe name under %s, got %q`, key, pipePrefix, value)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,186 @@
|
||||
//go:build windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"net"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"golang.org/x/sys/windows"
|
||||
)
|
||||
|
||||
// TestOwnerAccepted pins which accounts may answer a nebula ctl request: the client's
|
||||
// own, and the accounts a daemon runs as that an ordinary user cannot create an object
|
||||
// owned by. Any other user is refused, since any user can create any pipe name.
|
||||
func TestOwnerAccepted(t *testing.T) {
|
||||
me, err := windows.GetCurrentProcessToken().GetTokenUser()
|
||||
require.NoError(t, err)
|
||||
|
||||
wellKnown := func(typ windows.WELL_KNOWN_SID_TYPE) *windows.SID {
|
||||
sid, err := windows.CreateWellKnownSid(typ)
|
||||
require.NoError(t, err)
|
||||
return sid
|
||||
}
|
||||
parse := func(s string) *windows.SID {
|
||||
sid, err := windows.StringToSid(s)
|
||||
require.NoError(t, err)
|
||||
return sid
|
||||
}
|
||||
|
||||
accepted := map[string]*windows.SID{
|
||||
"self": me.User.Sid,
|
||||
"SYSTEM": wellKnown(windows.WinLocalSystemSid),
|
||||
"Administrators": wellKnown(windows.WinBuiltinAdministratorsSid),
|
||||
}
|
||||
for name, sid := range accepted {
|
||||
assert.True(t, ownerAccepted(sid, me.User.Sid), name)
|
||||
}
|
||||
|
||||
refused := map[string]*windows.SID{
|
||||
"Everyone": wellKnown(windows.WinWorldSid),
|
||||
"Users": wellKnown(windows.WinBuiltinUsersSid),
|
||||
"another user": parse("S-1-5-21-1-2-3-1001"),
|
||||
"a service's own account": parse("S-1-5-80-1-2-3-4-5"),
|
||||
"LocalService": wellKnown(windows.WinLocalServiceSid),
|
||||
}
|
||||
for name, sid := range refused {
|
||||
assert.False(t, ownerAccepted(sid, me.User.Sid), name)
|
||||
}
|
||||
}
|
||||
|
||||
// TestDefaultPathIsProtected pins the default name to the namespace only administrators
|
||||
// and SYSTEM can create under, which is what lets nebula ctl trust the default name
|
||||
// from its spelling alone.
|
||||
func TestDefaultPathIsProtected(t *testing.T) {
|
||||
p := DefaultSocketPath
|
||||
assert.True(t, isProtectedPath(p), p)
|
||||
assert.Equal(t, `\\.\pipe\ProtectedPrefix\Administrators\nebula-ctl`, p)
|
||||
}
|
||||
|
||||
// TestConfiguredPipeNameMustBeFull: a configured name is used as given, and only a full
|
||||
// pipe name means anything here.
|
||||
func TestConfiguredPipeNameMustBeFull(t *testing.T) {
|
||||
p, err := SocketPathFromConfig(fakeWinConfig{CtlSocketKey: `\\.\pipe\nebula-ctl`})
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, `\\.\pipe\nebula-ctl`, p)
|
||||
|
||||
for _, bad := range []string{"nebula-ctl", `C:\nebula\ctl.sock`, `\\.\pipe\`} {
|
||||
_, err := SocketPathFromConfig(fakeWinConfig{CtlSocketKey: bad})
|
||||
require.Error(t, err, bad)
|
||||
assert.ErrorContains(t, err, "full pipe name", bad)
|
||||
}
|
||||
}
|
||||
|
||||
type fakeWinConfig map[string]string
|
||||
|
||||
func (f fakeWinConfig) GetString(k, d string) string {
|
||||
if v, ok := f[k]; ok {
|
||||
return v
|
||||
}
|
||||
return d
|
||||
}
|
||||
|
||||
func TestIsProtectedPath(t *testing.T) {
|
||||
assert.True(t, isProtectedPath(`\\.\pipe\ProtectedPrefix\Administrators\nebula-1`))
|
||||
assert.True(t, isProtectedPath(`\\.\pipe\protectedprefix\administrators\nebula-1`), "pipe names are case insensitive")
|
||||
assert.False(t, isProtectedPath(`\\.\pipe\ProtectedPrefix\Administrators\`), "the prefix alone names nothing")
|
||||
assert.False(t, isProtectedPath(`\\.\pipe\nebula-1`))
|
||||
assert.False(t, isProtectedPath(`\\.\pipe\ProtectedPrefix\Users\nebula-1`))
|
||||
}
|
||||
|
||||
// TestListenRefused pins how a failed create is reported. Access denied under the
|
||||
// protected prefix is the namespace refusing a non-administrator, and says so; the same
|
||||
// error for an administrator, or for any name outside the prefix, is a name some other
|
||||
// process holds, and is errEndpointHeld so the daemon logs it as an error.
|
||||
func TestListenRefused(t *testing.T) {
|
||||
protected := `\\.\pipe\ProtectedPrefix\Administrators\nebula-1`
|
||||
plain := `\\.\pipe\nebula-1`
|
||||
|
||||
err := listenRefused(protected, false, windows.ERROR_ACCESS_DENIED)
|
||||
assert.NotErrorIs(t, err, errEndpointHeld)
|
||||
assert.ErrorIs(t, err, windows.ERROR_ACCESS_DENIED)
|
||||
assert.Contains(t, err.Error(), "requires an administrator")
|
||||
assert.Contains(t, err.Error(), CtlSocketKey)
|
||||
|
||||
assert.ErrorIs(t, listenRefused(protected, true, windows.ERROR_ACCESS_DENIED), errEndpointHeld)
|
||||
assert.ErrorIs(t, listenRefused(plain, false, windows.ERROR_ACCESS_DENIED), errEndpointHeld)
|
||||
assert.ErrorIs(t, listenRefused(protected, false, windows.ERROR_ALREADY_EXISTS), errEndpointHeld)
|
||||
assert.ErrorIs(t, listenRefused(plain, true, windows.ERROR_ALREADY_EXISTS), errEndpointHeld)
|
||||
|
||||
other := errors.New("something else")
|
||||
assert.Same(t, other, listenRefused(protected, false, other))
|
||||
}
|
||||
|
||||
// TestListenProtectedName creates and dials a name under the protected prefix. It needs
|
||||
// an administrator, and otherwise checks only that the refusal is the one listen
|
||||
// promises a non-administrator.
|
||||
func TestListenProtectedName(t *testing.T) {
|
||||
path := protectedPrefix + "nebula-test-" + t.Name()
|
||||
ln, err := listen(path, ownerOnly())
|
||||
if !isAdministrator() {
|
||||
require.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "requires an administrator")
|
||||
t.Skip("not an administrator; the protected namespace refused the create as it should")
|
||||
}
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { ln.Close() })
|
||||
|
||||
accepted := make(chan error, 1)
|
||||
go func() {
|
||||
conn, err := ln.Accept()
|
||||
if err == nil {
|
||||
conn.Close()
|
||||
}
|
||||
accepted <- err
|
||||
}()
|
||||
|
||||
conn, err := dial(path, time.Second)
|
||||
require.NoError(t, err)
|
||||
conn.Close()
|
||||
require.NoError(t, <-accepted)
|
||||
}
|
||||
|
||||
// TestDialAcceptsOwnPipe dials a pipe this process created outside the protected
|
||||
// prefix, as an override might name, which the owner check must pass: the pipe's owner
|
||||
// is this account, or Administrators when the test is elevated.
|
||||
func TestDialAcceptsOwnPipe(t *testing.T) {
|
||||
path := pipePrefix + "nebula-test-" + t.Name()
|
||||
ln, err := listen(path, ownerOnly())
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { ln.Close() })
|
||||
|
||||
accepted := make(chan error, 1)
|
||||
go func() {
|
||||
conn, err := ln.Accept()
|
||||
if err == nil {
|
||||
conn.Close()
|
||||
}
|
||||
accepted <- err
|
||||
}()
|
||||
|
||||
conn, err := dial(path, time.Second)
|
||||
require.NoError(t, err)
|
||||
conn.Close()
|
||||
require.NoError(t, <-accepted)
|
||||
}
|
||||
|
||||
// TestListenRefusesHeldName pins that a name another listener already holds is refused
|
||||
// with errEndpointHeld rather than joined, which is what keeps an impostor from being
|
||||
// served alongside, or in place of, the daemon.
|
||||
func TestListenRefusesHeldName(t *testing.T) {
|
||||
path := pipePrefix + "nebula-test-" + t.Name()
|
||||
first, err := listen(path, ownerOnly())
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { first.Close() })
|
||||
|
||||
var second net.Listener
|
||||
second, err = listen(path, ownerOnly())
|
||||
if second != nil {
|
||||
second.Close()
|
||||
}
|
||||
require.ErrorIs(t, err, errEndpointHeld)
|
||||
}
|
||||
@@ -0,0 +1,171 @@
|
||||
// Package localapi serves the nebula command registry over local IPC endpoints: the
|
||||
// control socket, so the user who ran nebula can inspect and control it from a CLI on
|
||||
// the same machine, and the info API, so other programs on the machine can ask who is
|
||||
// behind a vpn address.
|
||||
//
|
||||
// The control socket's access is the socket's own: without a group it is 0600 to the
|
||||
// user who ran nebula, and the server checks the peer's credentials on every connection
|
||||
// besides; with a group configured it is 0660 to that group, and the kernel's check on
|
||||
// connect is the whole of it, so a member has the same control of the daemon as its
|
||||
// user. It serves every command in the registry. The info API is opt in, HTTP, and as
|
||||
// open as the operator makes its socket; it serves the identity commands alone, decided
|
||||
// here, on the serving side; see InfoServer for what that is and why it is safe.
|
||||
//
|
||||
// # Protocol
|
||||
//
|
||||
// One JSON object in, one JSON object out, both newline terminated. It is an API, not a
|
||||
// command line: a request names a command and passes its options as named parameters,
|
||||
// rather than shipping an argv the daemon has to parse. A client that is itself a CLI
|
||||
// asks for the schema first (Request.Describe) and turns the user's flags into those
|
||||
// parameters; a client that is not need never think in flags at all.
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
)
|
||||
|
||||
// ProtocolVersion is the version of the request and response envelopes. A client sending
|
||||
// a version this server does not know gets a sentence back rather than a parse error,
|
||||
// which matters because the daemon and the CLI are upgraded independently.
|
||||
const ProtocolVersion = 1
|
||||
|
||||
// MaxRequestBytes bounds the request. A request names a command and its parameters, so it
|
||||
// has no business being large, and an unbounded read is a way for a local process to
|
||||
// consume memory the packet path needs.
|
||||
const MaxRequestBytes = 64 * 1024
|
||||
|
||||
// Request is the single JSON object a client sends.
|
||||
type Request struct {
|
||||
Version int `json:"version"`
|
||||
|
||||
// Describe asks for the schema of every command this surface serves, in place of
|
||||
// running one. Command, Params and Args are ignored.
|
||||
Describe bool `json:"describe,omitempty"`
|
||||
|
||||
// Command names the command to run.
|
||||
Command string `json:"command,omitempty"`
|
||||
|
||||
// Params carries the command's options by name, with JSON's own types, true rather
|
||||
// than "true", 3 rather than "3", or as the strings a command line parsed them from,
|
||||
// which is what nebula ctl sends. Unknown names are an error, so a typo is reported
|
||||
// instead of ignored. The schema lists json and pretty on every command because the
|
||||
// command lines take them; here they are refused, since Format is how a request
|
||||
// chooses its rendering.
|
||||
Params map[string]any `json:"params,omitempty"`
|
||||
|
||||
// Args carries the command's operands, the values that are not options: the vpn
|
||||
// address `print-tunnel` prints, for instance. They stay positional because the
|
||||
// commands do not name them.
|
||||
Args []string `json:"args,omitempty"`
|
||||
|
||||
// Format asks for a rendering other than the default. "" and "json" return the
|
||||
// command's result as a JSON value, which is what a program wants. "text" asks the
|
||||
// daemon to run the command's own human rendering and return it as a string, which is
|
||||
// how `nebula ctl` shows an operator the same output the ssh server would.
|
||||
Format string `json:"format,omitempty"`
|
||||
}
|
||||
|
||||
// Response is the single JSON object a server sends back.
|
||||
type Response struct {
|
||||
Version int `json:"version"`
|
||||
|
||||
// Result is what a request for JSON produced: the command's value, or the schema
|
||||
// when the request was a Describe, as a JSON value, so a caller reads it directly
|
||||
// instead of parsing a string that happens to contain JSON.
|
||||
//
|
||||
// Whitespace inside a JSON result is not preserved: an envelope normalises it, and
|
||||
// in an API it carries no meaning anyway. Formatting a result for a human to read is
|
||||
// the client's job.
|
||||
Result json.RawMessage `json:"result,omitempty"`
|
||||
|
||||
// Text is what a request for text produced: the command's own human rendering, the
|
||||
// bytes it wrote and nothing else. They travel as bytes, base64 in the envelope,
|
||||
// rather than as a JSON string, because a string is UTF-8 and the rendering need
|
||||
// not be: a name from a certificate is whatever the certificate holds, and the ssh
|
||||
// server passes it through, so this does too.
|
||||
Text []byte `json:"text,omitempty"`
|
||||
|
||||
// Error explains a failure in a sentence, and is absent on success. It is the only
|
||||
// signal a caller needs: there is no separate status field, because a command that
|
||||
// failed always says why and one that succeeded never does. A command line client
|
||||
// turns its presence into a non-zero exit.
|
||||
//
|
||||
// A command that ran and refused sets Error too, alongside its Result when the
|
||||
// caller asked for JSON. That is how a refusal and a request that never ran are
|
||||
// told apart: the first has both, the second has Error alone.
|
||||
Error string `json:"error,omitempty"`
|
||||
}
|
||||
|
||||
// frameError is a frame that arrived and was not one: oversized, or not the JSON object
|
||||
// the protocol defines. It is told from a failed read so the client can say the daemon
|
||||
// answered with something it could not read, rather than that it could not be reached.
|
||||
type frameError struct{ err error }
|
||||
|
||||
func (e *frameError) Error() string { return e.err.Error() }
|
||||
func (e *frameError) Unwrap() error { return e.err }
|
||||
|
||||
// readFrame reads one frame, a newline terminated JSON object, from r into v. With
|
||||
// writeFrame it is where the framing rule lives, for both directions: a frame is a
|
||||
// single line, a line over max bytes is refused rather than buffered, and a final line
|
||||
// with no newline before EOF still counts. what names the frame in errors ("request", "response"); a
|
||||
// read failure is returned wrapped, so a caller can still see io.EOF or a timeout in it.
|
||||
// strict refuses a field v does not declare, which is the daemon's reading of a request:
|
||||
// a client that misspells one deserves to hear about it, as it does for a parameter.
|
||||
// The client reads a response leniently, so a field a newer daemon adds is passed over
|
||||
// rather than fatal.
|
||||
func readFrame(r io.Reader, max int, what string, v any, strict bool) error {
|
||||
br := bufio.NewReader(io.LimitReader(r, int64(max)+1))
|
||||
|
||||
line, err := br.ReadBytes('\n')
|
||||
if err != nil && (len(line) == 0 || !errors.Is(err, io.EOF)) {
|
||||
// EOF after a partial line is the unterminated final line the rule allows, and
|
||||
// an oversized line looks the same once the LimitReader cuts it off, so both go
|
||||
// on to be judged by their length. Anything else is a failed read, whatever was
|
||||
// buffered first: a deadline that lands mid frame is a timeout, not a parse
|
||||
// error in half a document.
|
||||
return fmt.Errorf("could not read %s: %w", what, err)
|
||||
}
|
||||
|
||||
// The limit is on the body, not the frame, so the terminator does not count
|
||||
// against it. A body that exceeds max is cut off by the LimitReader before its
|
||||
// newline, so a missing terminator is also what an oversized line looks like.
|
||||
body := bytes.TrimSuffix(line, []byte{'\n'})
|
||||
if len(body) > max {
|
||||
return &frameError{fmt.Errorf("%s exceeded %d bytes", what, max)}
|
||||
}
|
||||
|
||||
dec := json.NewDecoder(bytes.NewReader(body))
|
||||
if strict {
|
||||
dec.DisallowUnknownFields()
|
||||
}
|
||||
if err := dec.Decode(v); err != nil {
|
||||
return &frameError{fmt.Errorf("could not parse %s: %w", what, err)}
|
||||
}
|
||||
|
||||
// Strict is one object and nothing after it: a second object, or stray bytes, on
|
||||
// the line would be read as part of a request that happened to decode, and is
|
||||
// refused the way an unknown field is.
|
||||
if strict {
|
||||
if _, err := dec.Token(); err != io.EOF {
|
||||
return fmt.Errorf("could not parse %s: unexpected data after the object", what)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// writeFrame writes v to w as one frame: the JSON object and the newline that ends it.
|
||||
func writeFrame(w io.Writer, v any) error {
|
||||
body, err := json.Marshal(v)
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not encode frame: %w", err)
|
||||
}
|
||||
|
||||
_, err = w.Write(append(body, '\n'))
|
||||
return err
|
||||
}
|
||||
@@ -0,0 +1,102 @@
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// TestReadFrameLimitIsOnTheBody pins the framing rule at its edge: the limit bounds the
|
||||
// JSON body, so the newline that terminates the frame must not count against it.
|
||||
func TestReadFrameLimitIsOnTheBody(t *testing.T) {
|
||||
// A JSON string whose encoded form is exactly n bytes, with or without a terminator.
|
||||
body := func(n int) string {
|
||||
return fmt.Sprintf(`"%s"`, strings.Repeat("a", n-2))
|
||||
}
|
||||
|
||||
var v string
|
||||
|
||||
// Exactly at the limit, terminated: accepted.
|
||||
v = ""
|
||||
require.NoError(t, readFrame(bytes.NewReader([]byte(body(64)+"\n")), 64, "request", &v, true))
|
||||
assert.Len(t, v, 62)
|
||||
|
||||
// Exactly at the limit, EOF instead of a newline: still accepted.
|
||||
v = ""
|
||||
require.NoError(t, readFrame(bytes.NewReader([]byte(body(64))), 64, "request", &v, true))
|
||||
assert.Len(t, v, 62)
|
||||
|
||||
// One byte over: refused as oversized, not as a parse failure.
|
||||
err := readFrame(bytes.NewReader([]byte(body(65)+"\n")), 64, "request", &v, true)
|
||||
require.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "exceeded 64 bytes")
|
||||
}
|
||||
|
||||
// stallingReader hands out its bytes and then fails with err, the shape of a peer that
|
||||
// sends part of a frame and then stops, until the deadline on the connection lands.
|
||||
type stallingReader struct {
|
||||
data []byte
|
||||
err error
|
||||
}
|
||||
|
||||
func (r *stallingReader) Read(p []byte) (int, error) {
|
||||
if len(r.data) == 0 {
|
||||
return 0, r.err
|
||||
}
|
||||
n := copy(p, r.data)
|
||||
r.data = r.data[n:]
|
||||
return n, nil
|
||||
}
|
||||
|
||||
type timeoutError struct{}
|
||||
|
||||
func (timeoutError) Error() string { return "i/o timeout" }
|
||||
func (timeoutError) Timeout() bool { return true }
|
||||
func (timeoutError) Temporary() bool { return true }
|
||||
|
||||
// TestReadFramePartialLineThenReadErrorIsTheError: a read that fails after part of a
|
||||
// frame has arrived is a failed read, and the caller sees that error. The old behaviour
|
||||
// treated the fragment as the whole frame and reported a parse failure, so a client
|
||||
// that stalled mid request was told its JSON was malformed, and a daemon that stalled
|
||||
// mid response hid the timeout the client's error path looks for.
|
||||
func TestReadFramePartialLineThenReadErrorIsTheError(t *testing.T) {
|
||||
var v map[string]any
|
||||
|
||||
err := readFrame(&stallingReader{data: []byte(`{"command": "hel`), err: timeoutError{}}, 1024, "request", &v, true)
|
||||
require.Error(t, err)
|
||||
var ne net.Error
|
||||
require.ErrorAs(t, err, &ne, "the timeout is still visible through the wrapping: %v", err)
|
||||
assert.True(t, ne.Timeout())
|
||||
assert.NotContains(t, err.Error(), "parse", "a stalled peer is not a parse failure")
|
||||
|
||||
// EOF after an unterminated line is the one exception: a final line with no newline
|
||||
// is still a frame.
|
||||
v = nil
|
||||
require.NoError(t, readFrame(&stallingReader{data: []byte(`{"command": "help"}`), err: io.EOF}, 1024, "request", &v, true))
|
||||
assert.Equal(t, "help", v["command"])
|
||||
|
||||
// And an unterminated line that is EOF only because the limit cut it off is still
|
||||
// reported as oversized.
|
||||
err = readFrame(bytes.NewReader([]byte(strings.Repeat("a", 70)+"\n")), 64, "request", &v, true)
|
||||
require.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "exceeded 64 bytes")
|
||||
}
|
||||
|
||||
// TestReadFrameUnknownFieldIsRefusedWhenStrict: the daemon refuses a request field it
|
||||
// does not know, as it refuses an unknown parameter, so a misspelling is reported rather
|
||||
// than ignored; the client, reading leniently, passes over a field a newer daemon sends.
|
||||
func TestReadFrameUnknownFieldIsRefusedWhenStrict(t *testing.T) {
|
||||
var req Request
|
||||
err := readFrame(bytes.NewReader([]byte(`{"version":1,"comand":"help"}`+"\n")), 1024, "request", &req, true)
|
||||
require.ErrorContains(t, err, `unknown field "comand"`)
|
||||
|
||||
var res Response
|
||||
require.NoError(t, readFrame(bytes.NewReader([]byte(`{"version":1,"later":true}`+"\n")), 1024, "response", &res, false))
|
||||
assert.Equal(t, 1, res.Version)
|
||||
}
|
||||
@@ -0,0 +1,425 @@
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"log/slog"
|
||||
"math"
|
||||
"net"
|
||||
"runtime/debug"
|
||||
"strconv"
|
||||
"sync/atomic"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/commands"
|
||||
)
|
||||
|
||||
const (
|
||||
// defaultMaxConns caps concurrent connections. Exceeding it is rejected rather than
|
||||
// queued: a queue turns a load problem into a latency problem and hides it.
|
||||
defaultMaxConns = 8
|
||||
|
||||
// readTimeout bounds how long a client may take to send its request line.
|
||||
readTimeout = 10 * time.Second
|
||||
|
||||
// writeTimeout bounds a single write. A client that stops reading is dropped rather
|
||||
// than waited on, so a paused terminal cannot pin daemon resources.
|
||||
writeTimeout = 30 * time.Second
|
||||
|
||||
// defaultSlowAfter is how long a command may run before the daemon says so. A
|
||||
// command holds a connection slot until it returns, and one that never returns
|
||||
// holds it for good; after enough of those the socket answers only "busy". The
|
||||
// warning is what tells an operator that from load, and names the command.
|
||||
defaultSlowAfter = 30 * time.Second
|
||||
)
|
||||
|
||||
// Server serves a command registry over a local socket to the user who ran nebula.
|
||||
type Server struct {
|
||||
endpoint
|
||||
src *commands.Registry
|
||||
|
||||
maxConns int
|
||||
slowAfter time.Duration
|
||||
|
||||
sem chan struct{}
|
||||
euid uint32
|
||||
|
||||
// trustSocket is set while a group shares the socket. The kernel admitted the peer
|
||||
// through the socket's mode and group, which is the whole access control then, and
|
||||
// the peer check below stands aside: on unix it sees the peer's uid and primary gid
|
||||
// only, so it could not tell a member of the group from anyone else.
|
||||
trustSocket atomic.Bool
|
||||
}
|
||||
|
||||
// NewServer returns a Server that will serve every command in reg, including one
|
||||
// registered on it after the server is built.
|
||||
func NewServer(l *slog.Logger, reg *commands.Registry) *Server {
|
||||
return &Server{
|
||||
endpoint: endpoint{l: l, name: "local control socket"},
|
||||
src: reg,
|
||||
maxConns: defaultMaxConns,
|
||||
slowAfter: defaultSlowAfter,
|
||||
// The same identity the client's owner check is made for, so the peer check
|
||||
// cannot disagree with it, and so a test can stand in for it the same way.
|
||||
euid: currentUID(),
|
||||
}
|
||||
}
|
||||
|
||||
// Rebind brings the server up at path, moves a running server there, and serves it until
|
||||
// Stop or ctx cancellation; endpoint.rebindLocked says what that promises. An error here
|
||||
// is never fatal to the caller: nebula keeps forwarding packets without a control
|
||||
// endpoint, and the caller is expected to log and carry on.
|
||||
func (s *Server) Rebind(ctx context.Context, path string, acc Access) error {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
|
||||
// Set before the access is applied, not after, so no connection the new access
|
||||
// admits is checked against the old setting. Early is safe either way: a member
|
||||
// arriving before a group's mode is set is refused by the kernel, and with a group
|
||||
// being taken away the peer check applies a moment before the mode tightens.
|
||||
prev := s.trustSocket.Swap(acc.shared())
|
||||
err := s.rebindLocked(ctx, path, acc, func(ln net.Listener) io.Closer {
|
||||
s.l.Info("Local control socket listening", "path", path, "access", acc.String())
|
||||
// Closing the listener, when it is given up, ends the accept loop on the
|
||||
// closed-listener error; in flight commands keep their connections, which stay
|
||||
// usable until they finish.
|
||||
go s.accept(ln, s.semaphore())
|
||||
return ln
|
||||
})
|
||||
if err != nil {
|
||||
// Whatever was serving still is, with the access it had.
|
||||
s.trustSocket.Store(prev)
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
// semaphore returns the connection limiter, creating it on first use. It is made once
|
||||
// and never replaced: a handler releases into the channel it acquired from, so swapping
|
||||
// in a fresh one across a Stop and Rebind would leave any handler still in flight
|
||||
// blocked forever on a channel nothing had filled. Callers hold s.mu.
|
||||
func (s *Server) semaphore() chan struct{} {
|
||||
if s.sem == nil {
|
||||
s.sem = make(chan struct{}, s.maxConns)
|
||||
}
|
||||
return s.sem
|
||||
}
|
||||
|
||||
// Accept failures that are not the listener closing are retried after a pause that
|
||||
// doubles from acceptRetryMin up to acceptRetryMax, the same shape as net/http.Serve.
|
||||
const (
|
||||
acceptRetryMin = 5 * time.Millisecond
|
||||
acceptRetryMax = time.Second
|
||||
)
|
||||
|
||||
// accept serves connections from ln until it is closed. sem is the limiter to acquire
|
||||
// from and release into; it is passed rather than read from s so the handlers spawned
|
||||
// here never touch s.sem without the lock.
|
||||
//
|
||||
// Only a closed listener ends the loop; Stop and Rebind are the two things that close
|
||||
// it. Every other error is retried: the process being out of descriptors (EMFILE,
|
||||
// ENFILE) or a client that hung up between the kernel's queue and us (ECONNABORTED)
|
||||
// are passing conditions, and giving up on them would leave a socket on disk that
|
||||
// nothing answers, with the reason buried in a log line from minutes or days earlier.
|
||||
func (s *Server) accept(ln net.Listener, sem chan struct{}) {
|
||||
var delay time.Duration
|
||||
for {
|
||||
conn, err := ln.Accept()
|
||||
if err != nil {
|
||||
if errors.Is(err, net.ErrClosed) {
|
||||
return
|
||||
}
|
||||
|
||||
if ne, ok := err.(net.Error); ok && ne.Timeout() {
|
||||
continue
|
||||
}
|
||||
|
||||
if delay == 0 {
|
||||
delay = acceptRetryMin
|
||||
} else {
|
||||
delay = min(delay*2, acceptRetryMax)
|
||||
}
|
||||
s.l.Warn("Local control socket could not accept a connection, retrying", "error", err, "retry_in", delay)
|
||||
time.Sleep(delay)
|
||||
continue
|
||||
}
|
||||
delay = 0
|
||||
|
||||
select {
|
||||
case sem <- struct{}{}:
|
||||
default:
|
||||
// At capacity. Say so and hang up rather than holding the connection open.
|
||||
// Logged too: a slot is held for as long as a command runs, and the slow
|
||||
// command warning in serve says which ones are still running.
|
||||
s.l.Warn("Local control socket is at capacity, refusing a connection", "max", s.maxConns)
|
||||
s.reply(conn, &Response{Version: ProtocolVersion, Error: "local control socket is busy, try again"})
|
||||
_ = conn.Close()
|
||||
continue
|
||||
}
|
||||
|
||||
go func() {
|
||||
defer func() { <-sem }()
|
||||
s.handle(conn)
|
||||
}()
|
||||
}
|
||||
}
|
||||
|
||||
// handle serves one request. It recovers from panics in command callbacks: this
|
||||
// surface is present on every install and reachable by any local process running as
|
||||
// the daemon's user, so a malformed argument must cost a connection rather than the
|
||||
// overlay.
|
||||
func (s *Server) handle(conn net.Conn) {
|
||||
defer conn.Close()
|
||||
|
||||
var args []string
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
s.l.Error("Recovered from panic serving a local control command",
|
||||
"panic", r,
|
||||
"args", args,
|
||||
"stack", string(debug.Stack()),
|
||||
)
|
||||
s.reply(conn, &Response{Version: ProtocolVersion, Error: "command failed"})
|
||||
}
|
||||
}()
|
||||
|
||||
// Where the platform can identify the caller, check it, unless a group shares the
|
||||
// socket; see trustSocket. Otherwise listen's mode or security descriptor stands.
|
||||
if peerCheckSupported && !s.trustSocket.Load() {
|
||||
uid, err := peerUID(conn)
|
||||
if err != nil {
|
||||
s.l.Warn("Refusing local control connection with unreadable credentials", "error", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Access is restricted to the user who ran nebula. Root is allowed through
|
||||
// because it can reach the daemon's memory regardless of what this check says.
|
||||
if uid != s.euid && uid != 0 {
|
||||
s.l.Warn("Refusing local control connection from another user", "peerUid", uid)
|
||||
s.reply(conn, &Response{Version: ProtocolVersion, Error: "not permitted"})
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
_ = conn.SetReadDeadline(time.Now().Add(readTimeout))
|
||||
|
||||
req, err := readRequest(conn)
|
||||
if err != nil {
|
||||
s.reply(conn, &Response{Version: ProtocolVersion, Error: err.Error()})
|
||||
return
|
||||
}
|
||||
args = req.Args
|
||||
|
||||
// No deadline while a command runs; the write deadline below is what bounds a client
|
||||
// that stops reading.
|
||||
_ = conn.SetReadDeadline(time.Time{})
|
||||
_ = conn.SetWriteDeadline(time.Now().Add(writeTimeout))
|
||||
|
||||
s.reply(conn, s.serve(req))
|
||||
}
|
||||
|
||||
// serve runs one request and describes the outcome.
|
||||
//
|
||||
// Nothing bounds a command's run; a context would have to reach every Run. What is
|
||||
// bounded is the silence: a command still running at slowAfter is named in the log, with
|
||||
// the slot it is holding, so a socket that has gone "busy" can be traced to the commands
|
||||
// that wedged it. The timer is stopped however the command ends, a panic included, so
|
||||
// the line is only ever written about a command that is still running.
|
||||
func (s *Server) serve(req *Request) *Response {
|
||||
slow := time.AfterFunc(s.slowAfter, func() {
|
||||
s.l.Warn("Local control command is still running and holding a connection slot",
|
||||
"command", req.Command,
|
||||
"args", req.Args,
|
||||
"after", s.slowAfter,
|
||||
"max", s.maxConns,
|
||||
)
|
||||
})
|
||||
defer slow.Stop()
|
||||
|
||||
res := &Response{Version: ProtocolVersion}
|
||||
reg := s.src
|
||||
|
||||
if req.Describe {
|
||||
schema, err := json.Marshal(reg.Schema())
|
||||
if err != nil {
|
||||
res.Error = err.Error()
|
||||
return res
|
||||
}
|
||||
|
||||
res.Result = schema
|
||||
return res
|
||||
}
|
||||
|
||||
if req.Command == "" {
|
||||
res.Error = "no command given"
|
||||
return res
|
||||
}
|
||||
|
||||
params, err := stringParams(req.Params)
|
||||
if err != nil {
|
||||
res.Error = err.Error()
|
||||
return res
|
||||
}
|
||||
|
||||
format, err := parseFormat(req.Format)
|
||||
if err != nil {
|
||||
res.Error = err.Error()
|
||||
return res
|
||||
}
|
||||
|
||||
cmd, err := reg.Resolve(commands.Name(req.Command))
|
||||
if err != nil {
|
||||
s.l.Debug("Local control command refused", "command", req.Command, "error", err)
|
||||
res.Error = err.Error()
|
||||
return res
|
||||
}
|
||||
|
||||
r, err := commands.Invoke(commands.Request{Command: cmd, Params: params, Args: req.Args})
|
||||
if err != nil {
|
||||
s.l.Debug("Local control command failed", "command", req.Command, "error", err)
|
||||
res.Error = err.Error()
|
||||
return res
|
||||
}
|
||||
|
||||
// A command that acts does so now, before the one reply this surface gives, and the
|
||||
// reply carries both halves: the line Run promised and the outcome Then produced.
|
||||
// In JSON only the outcome travels, since the promise is for a person to read.
|
||||
var preface []byte
|
||||
if cmd.Then != nil && r.OK {
|
||||
if format == commands.FormatText && !r.Empty() {
|
||||
buf := &bytes.Buffer{}
|
||||
if err := commands.Render(cmd, r, format, buf); err == nil {
|
||||
preface = buf.Bytes()
|
||||
}
|
||||
}
|
||||
r = cmd.Then()
|
||||
}
|
||||
|
||||
// A command with nothing to say gets an empty, successful reply.
|
||||
if r.Empty() {
|
||||
res.Text = preface
|
||||
return res
|
||||
}
|
||||
|
||||
return render(res, cmd, r, format, preface)
|
||||
}
|
||||
|
||||
// render turns a command's Result into the response, in the format the caller asked for,
|
||||
// through commands.Render, so the JSON is byte for byte what -json prints over ssh.
|
||||
func render(res *Response, cmd *commands.Command, r commands.Result, format commands.Format, preface []byte) *Response {
|
||||
buf := &bytes.Buffer{}
|
||||
if err := commands.Render(cmd, r, format, buf); err != nil {
|
||||
res.Error = err.Error()
|
||||
return res
|
||||
}
|
||||
|
||||
if format != commands.FormatText {
|
||||
// The caller is a program. Carry the payload as JSON rather than as a string that
|
||||
// happens to contain some; the newline Render ends a line with is not the value's.
|
||||
res.Result = bytes.TrimSuffix(buf.Bytes(), []byte("\n"))
|
||||
|
||||
// A command that ran and refused is a failure to whoever asked, in either format.
|
||||
// The structured outcome still travels in Result for a program to read; Error
|
||||
// carries the reason so the one rule, Error set means failed, holds here too and
|
||||
// a client never has to guess from the payload.
|
||||
if !r.OK {
|
||||
res.Error = r.Reason
|
||||
}
|
||||
|
||||
return res
|
||||
}
|
||||
|
||||
// A command that ran and refused reads as an error to whoever asked for text: they
|
||||
// are a person or a script, and both expect a refusal on the error stream.
|
||||
if !r.OK {
|
||||
res.Error = string(append(preface, buf.Bytes()...))
|
||||
return res
|
||||
}
|
||||
|
||||
// The bytes the command wrote, as they are; see Response.Text.
|
||||
res.Text = append(preface, buf.Bytes()...)
|
||||
return res
|
||||
}
|
||||
|
||||
// parseFormat turns the request's format into the one the registry understands. An
|
||||
// unknown value is an error rather than a silent default, so a client that asks for
|
||||
// something this daemon cannot do hears about it.
|
||||
func parseFormat(s string) (commands.Format, error) {
|
||||
switch s {
|
||||
case "", "json":
|
||||
return commands.FormatJSON, nil
|
||||
case "text":
|
||||
return commands.FormatText, nil
|
||||
default:
|
||||
return commands.FormatJSON, fmt.Errorf("unknown format %q, expected \"json\" or \"text\"", s)
|
||||
}
|
||||
}
|
||||
|
||||
// reply writes one response frame.
|
||||
func (s *Server) reply(conn net.Conn, res *Response) {
|
||||
_ = conn.SetWriteDeadline(time.Now().Add(writeTimeout))
|
||||
if err := writeFrame(conn, res); err != nil {
|
||||
s.l.Debug("Could not send a local control response", "error", err)
|
||||
}
|
||||
}
|
||||
|
||||
// stringParams converts JSON's types into the strings flag.Value.Set expects, so a
|
||||
// caller writes true and 3 rather than "true" and "3".
|
||||
func stringParams(in map[string]any) (map[string]string, error) {
|
||||
if len(in) == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
out := make(map[string]string, len(in))
|
||||
for k, v := range in {
|
||||
switch t := v.(type) {
|
||||
case bool:
|
||||
out[k] = strconv.FormatBool(t)
|
||||
case string:
|
||||
out[k] = t
|
||||
case float64:
|
||||
// encoding/json gives every number as a float64; render whole ones without
|
||||
// a decimal point so an int flag accepts them.
|
||||
if t != math.Trunc(t) {
|
||||
out[k] = strconv.FormatFloat(t, 'f', -1, 64)
|
||||
continue
|
||||
}
|
||||
|
||||
// A whole float64 can be far outside int64, and Go's conversion of one that is
|
||||
// gives an unspecified value rather than an error, so the bounds are checked
|
||||
// first. MinInt64 is exactly representable and is in range. MaxInt64 is not:
|
||||
// as a float64 it rounds up to 2^63, which is the first value out of range,
|
||||
// hence the >= on that side.
|
||||
if t < math.MinInt64 || t >= math.MaxInt64 {
|
||||
return nil, fmt.Errorf("parameter %q is %s, outside the range of a 64-bit integer",
|
||||
k, strconv.FormatFloat(t, 'g', -1, 64))
|
||||
}
|
||||
out[k] = strconv.FormatInt(int64(t), 10)
|
||||
case nil:
|
||||
return nil, fmt.Errorf("parameter %q has no value", k)
|
||||
default:
|
||||
return nil, fmt.Errorf("parameter %q is not a string, number or boolean", k)
|
||||
}
|
||||
}
|
||||
|
||||
return out, nil
|
||||
}
|
||||
|
||||
func readRequest(conn net.Conn) (*Request, error) {
|
||||
req := &Request{}
|
||||
if err := readFrame(conn, MaxRequestBytes, "request", req, true); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if req.Version != ProtocolVersion {
|
||||
return nil, fmt.Errorf(
|
||||
"this nebula speaks local control protocol v%d, the client sent v%d; the two binaries are different versions",
|
||||
ProtocolVersion, req.Version,
|
||||
)
|
||||
}
|
||||
|
||||
return req, nil
|
||||
}
|
||||
@@ -0,0 +1,982 @@
|
||||
//go:build !windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"math"
|
||||
"net"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// testSocket returns a short socket path whose directory does not exist yet and whose
|
||||
// parent is private: one level below the test's own directory, so that listen has a
|
||||
// directory of its own to create.
|
||||
func testSocket(t *testing.T) string {
|
||||
t.Helper()
|
||||
return filepath.Join(test.ShortTempDir(t), "n", "s.sock")
|
||||
}
|
||||
|
||||
func serve(t *testing.T, reg *commands.Registry) (*Server, string) {
|
||||
t.Helper()
|
||||
|
||||
path := testSocket(t)
|
||||
s := NewServer(test.NewLogger(), reg)
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
t.Cleanup(s.Stop)
|
||||
|
||||
return s, path
|
||||
}
|
||||
|
||||
// serveAt starts a server on an exact path, for tests that care where the socket is.
|
||||
func serveAt(t *testing.T, path string) (*Server, func()) {
|
||||
t.Helper()
|
||||
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
return s, s.Stop
|
||||
}
|
||||
|
||||
// echoCommand reports its operands, for tests on either surface.
|
||||
func echoCommand() *commands.Command {
|
||||
return &commands.Command{
|
||||
Name: "echo",
|
||||
ShortDescription: "echoes its arguments",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return commands.Value(fmt.Sprintf("%v", a)), nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func basicRegistry() *commands.Registry {
|
||||
reg := commands.New()
|
||||
reg.Register(echoCommand())
|
||||
reg.Register(&commands.Command{
|
||||
Name: "boom",
|
||||
ShortDescription: "panics",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
panic("this command is broken")
|
||||
},
|
||||
})
|
||||
return reg
|
||||
}
|
||||
|
||||
// run invokes one command and returns its output and its error text. An empty error is
|
||||
// success: the protocol has no separate status field.
|
||||
func run(t *testing.T, path, command string, args ...string) (string, string) {
|
||||
t.Helper()
|
||||
|
||||
res, err := (&Client{Path: path}).Invoke(command, nil, args, "")
|
||||
require.NoError(t, err)
|
||||
return textOf(res), res.Error
|
||||
}
|
||||
|
||||
// textOf is what a test reads as a command's output: the text when text was asked for,
|
||||
// else the JSON result, unquoted when it is a JSON string so a test can compare words.
|
||||
func textOf(res *Response) string {
|
||||
if len(res.Text) > 0 {
|
||||
return string(res.Text)
|
||||
}
|
||||
if len(res.Result) > 0 && res.Result[0] == '"' {
|
||||
var s string
|
||||
if err := json.Unmarshal(res.Result, &s); err == nil {
|
||||
return s
|
||||
}
|
||||
}
|
||||
return string(res.Result)
|
||||
}
|
||||
|
||||
func TestServeAllowedCommand(t *testing.T) {
|
||||
_, path := serve(t, basicRegistry())
|
||||
|
||||
out, errOut := run(t, path, "echo", "a", "b")
|
||||
assert.Equal(t, "[a b]", out)
|
||||
assert.Empty(t, errOut, "a command that worked reports no error")
|
||||
}
|
||||
|
||||
// TestPanicInCommandDoesNotKillTheDaemon: a broken command costs a connection, not the
|
||||
// overlay.
|
||||
func TestPanicInCommandDoesNotKillTheDaemon(t *testing.T) {
|
||||
_, path := serve(t, basicRegistry())
|
||||
|
||||
out, errOut := run(t, path, "boom")
|
||||
assert.Empty(t, out)
|
||||
assert.Contains(t, errOut, "command failed")
|
||||
|
||||
// The server is still serving, which is the point of the test.
|
||||
out, errOut = run(t, path, "echo", "still", "here")
|
||||
assert.Equal(t, "[still here]", out)
|
||||
assert.Empty(t, errOut)
|
||||
}
|
||||
|
||||
// TestSocketPermissions: the modes are pinned, not left to the umask. A 077 umask would
|
||||
// make the directory 0700 and hide a root daemon's socket from an unprivileged nebula
|
||||
// ctl.
|
||||
func TestSocketPermissions(t *testing.T) {
|
||||
for _, umask := range []int{0, 0077} {
|
||||
t.Run(fmt.Sprintf("umask %04o", umask), func(t *testing.T) {
|
||||
old := unix.Umask(umask)
|
||||
defer unix.Umask(old)
|
||||
|
||||
_, path := serve(t, basicRegistry())
|
||||
|
||||
fi, err := os.Stat(path)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0600), fi.Mode().Perm(), "socket must not be reachable by other users")
|
||||
|
||||
di, err := os.Stat(filepath.Dir(path))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, os.FileMode(0755), di.Mode().Perm(), "a directory we create ourselves is searchable, so ServedByRoot can see into it")
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestLiveSocketIsNotStolen(t *testing.T) {
|
||||
first, path := serve(t, basicRegistry())
|
||||
require.NotNil(t, first)
|
||||
|
||||
second := NewServer(test.NewLogger(), basicRegistry())
|
||||
err := second.Rebind(context.Background(), path, ownerOnly())
|
||||
assert.ErrorContains(t, err, "already in use", "a live endpoint must not be unlinked by a second instance")
|
||||
}
|
||||
|
||||
// TestLiveSocketIsNotStolenBeforeItsChmod: between an instance's bind and its chmod the
|
||||
// socket is at whatever mode the umask left. A second instance starting in that window
|
||||
// must still see it as live, not stale: only a refused connect proves nothing is behind
|
||||
// the file.
|
||||
func TestLiveSocketIsNotStolenBeforeItsChmod(t *testing.T) {
|
||||
first, path := serve(t, basicRegistry())
|
||||
require.NotNil(t, first)
|
||||
require.NoError(t, os.Chmod(path, 0666))
|
||||
|
||||
second := NewServer(test.NewLogger(), basicRegistry())
|
||||
err := second.Rebind(context.Background(), path, ownerOnly())
|
||||
require.ErrorContains(t, err, "already in use", "a live socket at any mode is not thereby dead")
|
||||
|
||||
_, err = os.Stat(path)
|
||||
require.NoError(t, err, "the first instance's socket is still there")
|
||||
require.NoError(t, os.Chmod(path, 0600))
|
||||
out, _ := run(t, path, "echo", "ok")
|
||||
assert.Equal(t, "[ok]", out, "and still served")
|
||||
}
|
||||
|
||||
func TestRebindMovesTheSocket(t *testing.T) {
|
||||
s, path := serve(t, basicRegistry())
|
||||
next := filepath.Join(filepath.Dir(path), "n.sock")
|
||||
|
||||
require.NoError(t, s.Rebind(context.Background(), next, ownerOnly()))
|
||||
assert.Equal(t, next, s.Path())
|
||||
|
||||
out, _ := run(t, next, "echo", "moved")
|
||||
assert.Equal(t, "[moved]", out)
|
||||
|
||||
_, err := os.Stat(path)
|
||||
assert.True(t, os.IsNotExist(err), "the old socket should be unlinked")
|
||||
}
|
||||
|
||||
func TestRebindFailureKeepsTheOldSocket(t *testing.T) {
|
||||
s, path := serve(t, basicRegistry())
|
||||
|
||||
err := s.Rebind(context.Background(), "/nonexistent-dir-for-tests/x.sock", ownerOnly())
|
||||
require.Error(t, err)
|
||||
assert.Equal(t, path, s.Path(), "a bad path must leave the working endpoint alone")
|
||||
|
||||
out, _ := run(t, path, "echo", "ok")
|
||||
assert.Equal(t, "[ok]", out)
|
||||
}
|
||||
|
||||
// TestSemaphoreSurvivesRestart pins the rule that the connection limiter is made once. A
|
||||
// handler releases into the channel it acquired from, so if Rebind replaced it after a
|
||||
// Stop, a command still running across the restart would block forever on the new,
|
||||
// empty channel and leak its goroutine and connection.
|
||||
func TestSemaphoreSurvivesRestart(t *testing.T) {
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
path := testSocket(t)
|
||||
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
first := s.sem
|
||||
require.NotNil(t, first)
|
||||
s.Stop()
|
||||
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
defer s.Stop()
|
||||
assert.Equal(t, first, s.sem, "Rebind after Stop must keep the same semaphore")
|
||||
|
||||
require.NoError(t, s.Rebind(context.Background(), testSocket(t), ownerOnly()))
|
||||
assert.Equal(t, first, s.sem, "Rebind must keep the same semaphore")
|
||||
}
|
||||
|
||||
// TestRestartIsWatchedOnItsOwnContext: the ctx watcher is installed by the first bind of
|
||||
// a run and cleared by Stop, so a server stopped by one context's cancellation and
|
||||
// started again under another is stopped when that second context is cancelled, not
|
||||
// left serving until the process exits.
|
||||
func TestRestartIsWatchedOnItsOwnContext(t *testing.T) {
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
path := testSocket(t)
|
||||
|
||||
ctxA, cancelA := context.WithCancel(context.Background())
|
||||
require.NoError(t, s.Rebind(ctxA, path, ownerOnly()))
|
||||
cancelA()
|
||||
require.Eventually(t, func() bool { return s.Path() == "" }, time.Second, 10*time.Millisecond, "the first context must stop the server")
|
||||
|
||||
ctxB, cancelB := context.WithCancel(context.Background())
|
||||
require.NoError(t, s.Rebind(ctxB, path, ownerOnly()))
|
||||
defer s.Stop()
|
||||
assert.Equal(t, path, s.Path())
|
||||
|
||||
cancelB()
|
||||
require.Eventually(t, func() bool { return s.Path() == "" }, time.Second, 10*time.Millisecond, "the second context must stop the server too")
|
||||
_, err := os.Stat(path)
|
||||
assert.True(t, os.IsNotExist(err), "the socket must be removed when the second context stops the server")
|
||||
}
|
||||
|
||||
// TestStopDetachesTheWatcher: a server stopped by Stop and started again under another
|
||||
// context belongs to that context alone. The one that started the earlier run, ending
|
||||
// later, must not take the new run down with it.
|
||||
func TestStopDetachesTheWatcher(t *testing.T) {
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
path := testSocket(t)
|
||||
|
||||
ctxA, cancelA := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancelA)
|
||||
require.NoError(t, s.Rebind(ctxA, path, ownerOnly()))
|
||||
s.Stop()
|
||||
|
||||
ctxB, cancelB := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancelB)
|
||||
require.NoError(t, s.Rebind(ctxB, path, ownerOnly()))
|
||||
t.Cleanup(s.Stop)
|
||||
|
||||
cancelA()
|
||||
time.Sleep(50 * time.Millisecond)
|
||||
assert.Equal(t, path, s.Path(), "the first run's context has nothing to do with the second run")
|
||||
_, err := (&Client{Path: path}).Describe()
|
||||
require.NoError(t, err)
|
||||
|
||||
cancelB()
|
||||
require.Eventually(t, func() bool { return s.Path() == "" }, time.Second, 10*time.Millisecond, "the second run's context stops it")
|
||||
}
|
||||
|
||||
// TestGivingUpTheSocketDetachesTheWatcher: when the node is gone from under the endpoint
|
||||
// and the bind that follows fails, the run is over and its watcher went with it, so a
|
||||
// later Rebind is watched on the ctx it was given, as after a Stop.
|
||||
func TestGivingUpTheSocketDetachesTheWatcher(t *testing.T) {
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
path := testSocket(t)
|
||||
|
||||
ctxA, cancelA := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancelA)
|
||||
require.NoError(t, s.Rebind(ctxA, path, ownerOnly()))
|
||||
|
||||
// The node goes and a directory takes its place, so the bind that follows fails.
|
||||
require.NoError(t, os.Remove(path))
|
||||
require.NoError(t, os.Mkdir(path, 0700))
|
||||
err := s.Rebind(ctxA, path, ownerOnly())
|
||||
require.ErrorContains(t, err, "is not a socket")
|
||||
assert.Empty(t, s.Path(), "the socket was given up before the bind failed")
|
||||
require.NoError(t, os.Remove(path))
|
||||
|
||||
ctxB, cancelB := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancelB)
|
||||
require.NoError(t, s.Rebind(ctxB, path, ownerOnly()))
|
||||
t.Cleanup(s.Stop)
|
||||
|
||||
cancelA()
|
||||
time.Sleep(50 * time.Millisecond)
|
||||
assert.Equal(t, path, s.Path(), "the first run's context has nothing to do with the second run")
|
||||
|
||||
cancelB()
|
||||
require.Eventually(t, func() bool { return s.Path() == "" }, time.Second, 10*time.Millisecond, "the second run's context stops it")
|
||||
}
|
||||
|
||||
func TestVersionMismatchIsExplained(t *testing.T) {
|
||||
_, path := serve(t, basicRegistry())
|
||||
|
||||
conn, err := net.Dial("unix", path)
|
||||
require.NoError(t, err)
|
||||
defer conn.Close()
|
||||
|
||||
body, _ := json.Marshal(Request{Version: ProtocolVersion + 1, Command: "echo"})
|
||||
_, err = conn.Write(append(body, '\n'))
|
||||
require.NoError(t, err)
|
||||
|
||||
res, err := readResponse(conn)
|
||||
require.NoError(t, err)
|
||||
assert.Contains(t, res.Error, "different versions")
|
||||
}
|
||||
|
||||
func TestOversizedRequestIsRejected(t *testing.T) {
|
||||
_, path := serve(t, basicRegistry())
|
||||
|
||||
conn, err := net.Dial("unix", path)
|
||||
require.NoError(t, err)
|
||||
defer conn.Close()
|
||||
|
||||
_, err = conn.Write(append(bytes.Repeat([]byte("a"), MaxRequestBytes+10), '\n'))
|
||||
if err == nil {
|
||||
res, rerr := readResponse(conn)
|
||||
require.NoError(t, rerr)
|
||||
assert.NotEmpty(t, res.Error)
|
||||
}
|
||||
}
|
||||
|
||||
// TestConcurrentClientsAreBounded checks that going over the connection cap is answered
|
||||
// rather than queued, so a burst of clients cannot pile up against the packet path.
|
||||
// TestSlowCommandIsNamedInTheLog: a command that does not return holds its slot for
|
||||
// good, and enough of them leave the socket answering only "busy". Both are logged, the
|
||||
// command by name once it has run past slowAfter and each refused connection as it
|
||||
// happens, so a busy socket can be traced to what wedged it.
|
||||
func TestSlowCommandIsNamedInTheLog(t *testing.T) {
|
||||
reg := commands.New()
|
||||
release := make(chan struct{})
|
||||
reg.Register(&commands.Command{
|
||||
Name: "block",
|
||||
ShortDescription: "blocks until released",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
<-release
|
||||
return commands.Value("done"), nil
|
||||
},
|
||||
})
|
||||
|
||||
var logs lockedBuffer
|
||||
s := NewServer(test.NewLoggerWithOutput(&logs), reg)
|
||||
s.maxConns = 1
|
||||
s.slowAfter = 20 * time.Millisecond
|
||||
path := testSocket(t)
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
defer s.Stop()
|
||||
|
||||
var wg sync.WaitGroup
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
_, _ = (&Client{Path: path}).Invoke("block", nil, []string{"x"}, "")
|
||||
}()
|
||||
|
||||
require.Eventually(t, func() bool {
|
||||
return strings.Contains(logs.String(), "still running")
|
||||
}, 2*time.Second, 10*time.Millisecond)
|
||||
assert.Contains(t, logs.String(), "command=block")
|
||||
assert.Contains(t, logs.String(), "args=[x]")
|
||||
|
||||
res, err := (&Client{Path: path}).Invoke("block", nil, nil, "")
|
||||
require.NoError(t, err)
|
||||
assert.Contains(t, res.Error, "busy")
|
||||
assert.Contains(t, logs.String(), "at capacity")
|
||||
|
||||
close(release)
|
||||
wg.Wait()
|
||||
}
|
||||
|
||||
// TestPanickedCommandIsNotReportedAsStillRunning: the slow command line is about a slot
|
||||
// that is still held. A command that panicked has given its slot back, and the client
|
||||
// its answer, so no line must claim otherwise after the fact.
|
||||
func TestPanickedCommandIsNotReportedAsStillRunning(t *testing.T) {
|
||||
reg := commands.New()
|
||||
reg.Register(&commands.Command{
|
||||
Name: "boom",
|
||||
ShortDescription: "panics",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
panic("this command is broken")
|
||||
},
|
||||
})
|
||||
|
||||
var logs lockedBuffer
|
||||
s := NewServer(test.NewLoggerWithOutput(&logs), reg)
|
||||
s.slowAfter = 20 * time.Millisecond
|
||||
path := testSocket(t)
|
||||
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||
defer s.Stop()
|
||||
|
||||
res, err := (&Client{Path: path}).Invoke("boom", nil, nil, "")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "command failed", res.Error)
|
||||
|
||||
time.Sleep(100 * time.Millisecond)
|
||||
assert.Contains(t, logs.String(), "Recovered from panic")
|
||||
assert.NotContains(t, logs.String(), "still running")
|
||||
}
|
||||
|
||||
// lockedBuffer is a strings.Builder the server's goroutines and the test can share.
|
||||
type lockedBuffer struct {
|
||||
mu sync.Mutex
|
||||
b strings.Builder
|
||||
}
|
||||
|
||||
func (l *lockedBuffer) Write(p []byte) (int, error) {
|
||||
l.mu.Lock()
|
||||
defer l.mu.Unlock()
|
||||
return l.b.Write(p)
|
||||
}
|
||||
|
||||
func (l *lockedBuffer) String() string {
|
||||
l.mu.Lock()
|
||||
defer l.mu.Unlock()
|
||||
return l.b.String()
|
||||
}
|
||||
|
||||
// flakyListener fails its first few Accepts the way a process that is out of file
|
||||
// descriptors does, then behaves.
|
||||
type flakyListener struct {
|
||||
net.Listener
|
||||
failures int
|
||||
}
|
||||
|
||||
func (f *flakyListener) Accept() (net.Conn, error) {
|
||||
if f.failures > 0 {
|
||||
f.failures--
|
||||
return nil, &net.OpError{Op: "accept", Net: "unix", Err: errors.New("too many open files")}
|
||||
}
|
||||
return f.Listener.Accept()
|
||||
}
|
||||
|
||||
// TestAcceptSurvivesTransientErrors: an Accept that fails for a reason other than the
|
||||
// listener being closed is retried, so a moment at the descriptor limit does not take
|
||||
// the control socket down for the rest of the process. Closing the listener is still
|
||||
// what ends the loop.
|
||||
func TestAcceptSurvivesTransientErrors(t *testing.T) {
|
||||
path := testSocket(t)
|
||||
require.NoError(t, os.Mkdir(filepath.Dir(path), 0700))
|
||||
ln, err := listen(path, ownerOnly())
|
||||
require.NoError(t, err)
|
||||
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
defer close(done)
|
||||
s.accept(&flakyListener{Listener: ln, failures: 3}, make(chan struct{}, 1))
|
||||
}()
|
||||
|
||||
out, errText := run(t, path, "echo", "still", "here")
|
||||
assert.Empty(t, errText)
|
||||
assert.Equal(t, "[still here]", out)
|
||||
|
||||
require.NoError(t, ln.Close())
|
||||
select {
|
||||
case <-done:
|
||||
case <-time.After(5 * time.Second):
|
||||
t.Fatal("accept loop did not exit when the listener was closed")
|
||||
}
|
||||
}
|
||||
|
||||
func TestStopRemovesTheSocket(t *testing.T) {
|
||||
s, path := serve(t, basicRegistry())
|
||||
s.Stop()
|
||||
|
||||
_, err := os.Stat(path)
|
||||
assert.True(t, os.IsNotExist(err))
|
||||
}
|
||||
|
||||
func TestContextCancellationStops(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
path := testSocket(t)
|
||||
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
require.NoError(t, s.Rebind(ctx, path, ownerOnly()))
|
||||
|
||||
cancel()
|
||||
assert.Eventually(t, func() bool {
|
||||
_, err := os.Stat(path)
|
||||
return os.IsNotExist(err)
|
||||
}, 2*time.Second, 20*time.Millisecond)
|
||||
}
|
||||
|
||||
// TestNamedParametersDriveFlags is the point of the protocol: a caller passes options by
|
||||
// name, with JSON's own types, and never assembles a command line.
|
||||
// TestStringParamsNumbers: JSON numbers arrive as float64. Whole ones render as integers
|
||||
// so int flags accept them, and a whole one outside int64 is refused rather than
|
||||
// converted, since Go's float-to-int conversion of an out-of-range value is unspecified
|
||||
// and would set a number the caller never sent.
|
||||
func TestStringParamsNumbers(t *testing.T) {
|
||||
cases := map[string]struct {
|
||||
in float64
|
||||
want string
|
||||
wantErr bool
|
||||
}{
|
||||
"whole": {in: 3, want: "3"},
|
||||
"negative whole": {in: -1, want: "-1"},
|
||||
"fraction": {in: 1.5, want: "1.5"},
|
||||
"min int64": {in: math.MinInt64, want: "-9223372036854775808"},
|
||||
"largest in range": {in: 9223372036854774784, want: "9223372036854774784"},
|
||||
"2^63": {in: 9223372036854775808, wantErr: true},
|
||||
"1e19": {in: 1e19, wantErr: true},
|
||||
"below min int64": {in: -9.3e18, wantErr: true},
|
||||
}
|
||||
|
||||
for name, tc := range cases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
out, err := stringParams(map[string]any{"n": tc.in})
|
||||
if tc.wantErr {
|
||||
require.Error(t, err)
|
||||
require.ErrorContains(t, err, `parameter "n" is `)
|
||||
assert.ErrorContains(t, err, "outside the range of a 64-bit integer")
|
||||
return
|
||||
}
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, tc.want, out["n"])
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNamedParametersDriveFlags(t *testing.T) {
|
||||
reg := commands.New()
|
||||
reg.Register(&commands.Command{
|
||||
Name: "report",
|
||||
ShortDescription: "reports its flags",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := struct {
|
||||
Verbose bool
|
||||
Label string
|
||||
}{}
|
||||
fl.BoolVar(&s.Verbose, "verbose", false, "say more")
|
||||
fl.StringVar(&s.Label, "label", "none", "a label")
|
||||
return fl, &s
|
||||
},
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
s := fs.(*struct {
|
||||
Verbose bool
|
||||
Label string
|
||||
})
|
||||
return commands.Value(fmt.Sprintf("verbose=%v label=%s args=%v", s.Verbose, s.Label, a)), nil
|
||||
},
|
||||
})
|
||||
|
||||
_, path := serve(t, reg)
|
||||
|
||||
res, err := (&Client{Path: path}).Invoke("report",
|
||||
map[string]string{"verbose": "true", "label": "here"},
|
||||
[]string{"an-operand"},
|
||||
"",
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Empty(t, res.Error)
|
||||
assert.Equal(t, "verbose=true label=here args=[an-operand]", textOf(res))
|
||||
}
|
||||
|
||||
// TestUnknownParameterIsReported: a misspelled parameter is an error rather than a
|
||||
// silently applied default, which is the difference between an API and a guess.
|
||||
func TestUnknownParameterIsReported(t *testing.T) {
|
||||
reg := commands.New()
|
||||
reg.Register(&commands.Command{
|
||||
Name: "report",
|
||||
ShortDescription: "takes a flag",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
fl.Bool("verbose", false, "say more")
|
||||
return fl, nil
|
||||
},
|
||||
Run: func(fs any, a []string) (commands.Result, error) { return commands.Nothing(), nil },
|
||||
})
|
||||
|
||||
_, path := serve(t, reg)
|
||||
|
||||
res, err := (&Client{Path: path}).Invoke("report", map[string]string{"verbos": "true"}, nil, "")
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Contains(t, res.Error, `report has no parameter "verbos"`)
|
||||
}
|
||||
|
||||
func TestParametersOnACommandThatTakesNoneAreReported(t *testing.T) {
|
||||
_, path := serve(t, basicRegistry())
|
||||
|
||||
res, err := (&Client{Path: path}).Invoke("echo", map[string]string{"nope": "true"}, nil, "")
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Contains(t, res.Error, "echo takes no parameters")
|
||||
}
|
||||
|
||||
// TestJSONOutputIsAJSONValue: a command that emits JSON lands in the response as JSON,
|
||||
// not as a string a caller has to parse a second time.
|
||||
func TestJSONOutputIsAJSONValue(t *testing.T) {
|
||||
reg := commands.New()
|
||||
reg.Register(&commands.Command{
|
||||
Name: "emit",
|
||||
ShortDescription: "emits json",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return commands.Value(map[string]any{"hosts": []int{1, 2, 3}}), nil
|
||||
},
|
||||
})
|
||||
|
||||
_, path := serve(t, reg)
|
||||
|
||||
res, err := (&Client{Path: path}).Invoke("emit", nil, nil, "")
|
||||
require.NoError(t, err)
|
||||
|
||||
var decoded struct {
|
||||
Hosts []int `json:"hosts"`
|
||||
}
|
||||
require.NoError(t, json.Unmarshal(res.Result, &decoded))
|
||||
assert.Equal(t, []int{1, 2, 3}, decoded.Hosts)
|
||||
}
|
||||
|
||||
// TestStringValueIsAJSONString: a command whose value is a string answers a JSON request
|
||||
// with a JSON string, quotes and all.
|
||||
func TestStringValueIsAJSONString(t *testing.T) {
|
||||
_, path := serve(t, basicRegistry())
|
||||
|
||||
res, err := (&Client{Path: path}).Invoke("echo", nil, []string{"hi"}, "")
|
||||
require.NoError(t, err)
|
||||
|
||||
var s string
|
||||
require.NoError(t, json.Unmarshal(res.Result, &s))
|
||||
assert.Equal(t, "[hi]", s)
|
||||
}
|
||||
|
||||
func TestDescribeListsTheCommands(t *testing.T) {
|
||||
_, path := serve(t, basicRegistry())
|
||||
|
||||
schema, err := (&Client{Path: path}).Describe()
|
||||
require.NoError(t, err)
|
||||
|
||||
names := make([]string, 0, len(schema))
|
||||
for _, c := range schema {
|
||||
names = append(names, string(c.Name))
|
||||
}
|
||||
|
||||
assert.ElementsMatch(t, []string{"help", "echo", "boom"}, names)
|
||||
}
|
||||
|
||||
// TestPresentationParametersAreRefused: the schema lists json and pretty on every
|
||||
// command, because the command lines take them, but a request has one way to choose its
|
||||
// rendering, the format field. A client that sends them as parameters is pointed there
|
||||
// rather than given a second, weaker way to say the same thing.
|
||||
func TestPresentationParametersAreRefused(t *testing.T) {
|
||||
reg := commands.New()
|
||||
reg.Register(&commands.Command{
|
||||
Name: "pair",
|
||||
ShortDescription: "returns a pair",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return commands.Value(map[string]int{"a": 1}), nil
|
||||
},
|
||||
Text: func(v any, w io.Writer) error {
|
||||
_, err := fmt.Fprintln(w, "a is one")
|
||||
return err
|
||||
},
|
||||
})
|
||||
_, path := serve(t, reg)
|
||||
c := &Client{Path: path}
|
||||
|
||||
for _, name := range []string{"json", "pretty"} {
|
||||
res, err := c.Invoke("pair", map[string]string{name: "true"}, nil, "text")
|
||||
require.NoError(t, err)
|
||||
assert.Contains(t, res.Error, name+" is a command line flag, not a parameter")
|
||||
assert.Contains(t, res.Error, "format")
|
||||
assert.Empty(t, res.Result, "a refused request runs nothing")
|
||||
}
|
||||
|
||||
// The format field is the one that counts.
|
||||
res, err := c.Invoke("pair", nil, nil, "text")
|
||||
require.NoError(t, err)
|
||||
require.Empty(t, res.Error)
|
||||
assert.Equal(t, "a is one\n", textOf(res))
|
||||
|
||||
res, err = c.Invoke("pair", nil, nil, "")
|
||||
require.NoError(t, err)
|
||||
require.Empty(t, res.Error)
|
||||
assert.JSONEq(t, `{"a":1}`, string(res.Result), "the API default is JSON")
|
||||
}
|
||||
|
||||
// TestTextRequestToATextlessCommand: a command with no human rendering still answers a
|
||||
// text request when the answer is a refusal, since a refusal always has one. Only a
|
||||
// successful result has nothing to say in text, and that is reported then, by the daemon.
|
||||
func TestTextRequestToATextlessCommand(t *testing.T) {
|
||||
reg := commands.New()
|
||||
reg.Register(&commands.Command{
|
||||
Name: "tunnel",
|
||||
ShortDescription: "data on success, a refusal without an operand",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
if len(a) == 0 {
|
||||
return commands.Failed("No vpn address was provided"), nil
|
||||
}
|
||||
return commands.Value(map[string]int{"index": 7}), nil
|
||||
},
|
||||
JSONOnly: true,
|
||||
})
|
||||
_, path := serve(t, reg)
|
||||
c := &Client{Path: path}
|
||||
|
||||
res, err := c.Invoke("tunnel", nil, nil, "text")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "No vpn address was provided\n", res.Error, "the refusal is rendered, not the missing text form")
|
||||
|
||||
res, err = c.Invoke("tunnel", nil, []string{"10.0.0.1"}, "text")
|
||||
require.NoError(t, err)
|
||||
assert.Contains(t, res.Error, "tunnel has no human readable output yet; pass -json or -pretty")
|
||||
assert.Empty(t, res.Result)
|
||||
|
||||
res, err = c.Invoke("tunnel", nil, []string{"10.0.0.1"}, "json")
|
||||
require.NoError(t, err)
|
||||
require.Empty(t, res.Error)
|
||||
assert.JSONEq(t, `{"index":7}`, string(res.Result))
|
||||
|
||||
// A refusal asked for as JSON carries the outcome for a program and the reason in
|
||||
// Error, so a client exits non-zero on the envelope alone, never by sniffing the
|
||||
// payload for an ok field some unrelated result might also have.
|
||||
res, err = c.Invoke("tunnel", nil, nil, "json")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "No vpn address was provided", res.Error)
|
||||
assert.JSONEq(t, `{"ok":false,"reason":"No vpn address was provided"}`, string(res.Result))
|
||||
}
|
||||
|
||||
// TestRebindAfterFailedBindStillStopsOnCancel covers a daemon whose initial listen
|
||||
// failed and which later Rebinds onto a good path from a reloaded config. The context
|
||||
// watcher has to be installed by that Rebind, or the socket outlives the daemon.
|
||||
func TestRebindAfterFailedBindStillStopsOnCancel(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
defer cancel()
|
||||
|
||||
base := test.ShortTempDir(t)
|
||||
|
||||
// listen creates one level only, so a socket directory under a parent that is not
|
||||
// there yet fails to bind, the shape of a runtime directory that does not exist.
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
require.Error(t, s.Rebind(ctx, filepath.Join(base, "missing", "n", "s.sock"), ownerOnly()))
|
||||
|
||||
good := filepath.Join(base, "n", "s.sock")
|
||||
require.NoError(t, s.Rebind(ctx, good, ownerOnly()))
|
||||
t.Cleanup(s.Stop)
|
||||
_, err := (&Client{Path: good}).Describe()
|
||||
require.NoError(t, err)
|
||||
|
||||
cancel()
|
||||
assert.Eventually(t, func() bool {
|
||||
_, err := os.Stat(good)
|
||||
return os.IsNotExist(err)
|
||||
}, 2*time.Second, 20*time.Millisecond)
|
||||
}
|
||||
|
||||
// TestCommandRegisteredAfterStartIsServed: the server filters the registry per request,
|
||||
// so a command an embedder registers after wiring the socket is served, and described,
|
||||
// just as it would be over ssh.
|
||||
func TestCommandRegisteredAfterStartIsServed(t *testing.T) {
|
||||
reg := basicRegistry()
|
||||
_, path := serve(t, reg)
|
||||
|
||||
reg.Register(&commands.Command{
|
||||
Name: "late",
|
||||
ShortDescription: "registered after the server started",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return commands.Value("late"), nil
|
||||
},
|
||||
})
|
||||
|
||||
c := &Client{Path: path}
|
||||
|
||||
schema, err := c.Describe()
|
||||
require.NoError(t, err)
|
||||
names := make([]string, 0, len(schema))
|
||||
for _, cs := range schema {
|
||||
names = append(names, string(cs.Name))
|
||||
}
|
||||
assert.Contains(t, names, "late")
|
||||
|
||||
res, err := c.Invoke("late", nil, nil, "")
|
||||
require.NoError(t, err)
|
||||
require.Empty(t, res.Error)
|
||||
assert.JSONEq(t, `"late"`, string(res.Result))
|
||||
}
|
||||
|
||||
// TestThenIsAnsweredInTheOneReply: this surface answers in one piece, so a command that
|
||||
// acts does so before the reply, and the reply carries Run's line and Then's outcome in
|
||||
// text, and the outcome alone in JSON.
|
||||
func TestThenIsAnsweredInTheOneReply(t *testing.T) {
|
||||
reg := commands.New()
|
||||
acted := false
|
||||
reg.Register(&commands.Command{
|
||||
Name: "act",
|
||||
ShortDescription: "replies, then acts",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return commands.Did("about to act"), nil
|
||||
},
|
||||
Then: func() commands.Result {
|
||||
acted = true
|
||||
return commands.Did("acted")
|
||||
},
|
||||
})
|
||||
_, path := serve(t, reg)
|
||||
|
||||
res, err := (&Client{Path: path}).Invoke("act", nil, nil, "text")
|
||||
require.NoError(t, err)
|
||||
assert.True(t, acted)
|
||||
assert.Empty(t, res.Error)
|
||||
assert.Equal(t, "about to act\nacted\n", string(res.Text))
|
||||
|
||||
res, err = (&Client{Path: path}).Invoke("act", nil, nil, "")
|
||||
require.NoError(t, err)
|
||||
assert.JSONEq(t, `{"ok":true,"reason":"acted"}`, string(res.Result))
|
||||
|
||||
// A refusal from Then still carries Run's line ahead of it in text, as ssh prints it.
|
||||
acted = false
|
||||
reg.Register(&commands.Command{
|
||||
Name: "fail",
|
||||
ShortDescription: "replies, then fails to act",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return commands.Did("about to act"), nil
|
||||
},
|
||||
Then: func() commands.Result {
|
||||
return commands.Failed("could not act")
|
||||
},
|
||||
})
|
||||
res, err = (&Client{Path: path}).Invoke("fail", nil, nil, "text")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "about to act\ncould not act\n", res.Error)
|
||||
assert.Empty(t, res.Text)
|
||||
|
||||
// A Run that refused is the outcome, and Then does not run.
|
||||
acted = false
|
||||
reg.Register(&commands.Command{
|
||||
Name: "refuse",
|
||||
ShortDescription: "refuses, so never acts",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return commands.Failed("not like that"), nil
|
||||
},
|
||||
Then: func() commands.Result {
|
||||
acted = true
|
||||
return commands.Did("acted anyway")
|
||||
},
|
||||
})
|
||||
res, err = (&Client{Path: path}).Invoke("refuse", nil, nil, "text")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "not like that\n", res.Error)
|
||||
assert.False(t, acted)
|
||||
}
|
||||
|
||||
// TestRebindRefusesDuringShutdown: a reload that lands after the daemon's context is
|
||||
// cancelled must not bring the endpoint back. Stop is not terminal, so Rebind has to
|
||||
// take the answer from the context rather than from the running flag.
|
||||
func TestRebindRefusesDuringShutdown(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
defer cancel()
|
||||
|
||||
// Built by hand rather than through serve: the context watcher is installed once,
|
||||
// by the first bind, and this test needs it on a context it can cancel.
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
require.NoError(t, s.Rebind(ctx, testSocket(t), ownerOnly()))
|
||||
t.Cleanup(s.Stop)
|
||||
|
||||
cancel()
|
||||
assert.Eventually(t, func() bool { return s.Path() == "" }, 2*time.Second, 20*time.Millisecond, "the watcher stops the server")
|
||||
|
||||
next := testSocket(t)
|
||||
err := s.Rebind(ctx, next, ownerOnly())
|
||||
require.Error(t, err)
|
||||
require.ErrorContains(t, err, "shutting down")
|
||||
assert.Empty(t, s.Path(), "the server stays stopped")
|
||||
|
||||
_, statErr := os.Stat(next)
|
||||
assert.True(t, os.IsNotExist(statErr), "and the refused socket is not left on disk")
|
||||
}
|
||||
|
||||
// TestRebindAndStopSerialize hammers Rebind against Stop. Whichever runs last decides
|
||||
// the final state, so after the dust settles a Stop must leave nothing listening and no
|
||||
// socket file behind, on either path.
|
||||
func TestRebindAndStopSerialize(t *testing.T) {
|
||||
a := testSocket(t)
|
||||
b := testSocket(t)
|
||||
|
||||
for i := 0; i < 50; i++ {
|
||||
s := NewServer(test.NewLogger(), basicRegistry())
|
||||
require.NoError(t, s.Rebind(context.Background(), a, ownerOnly()))
|
||||
|
||||
var wg sync.WaitGroup
|
||||
wg.Add(2)
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
_ = s.Rebind(context.Background(), b, ownerOnly())
|
||||
}()
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
s.Stop()
|
||||
}()
|
||||
wg.Wait()
|
||||
|
||||
// The Rebind may have run after the Stop, which restarts the server by design.
|
||||
// A final Stop then has to take everything down.
|
||||
s.Stop()
|
||||
assert.Empty(t, s.Path())
|
||||
for _, p := range []string{a, b} {
|
||||
_, err := os.Stat(p)
|
||||
assert.True(t, os.IsNotExist(err), "iteration %d: %s left behind", i, p)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestUnknownRequestFieldIsRefused: a request with a field the protocol does not define
|
||||
// is answered with the field named, the way an unknown parameter is, and not run.
|
||||
func TestUnknownRequestFieldIsRefused(t *testing.T) {
|
||||
_, path := serve(t, basicRegistry())
|
||||
|
||||
conn, err := dial(path, time.Second)
|
||||
require.NoError(t, err)
|
||||
defer conn.Close()
|
||||
require.NoError(t, writeFrame(conn, map[string]any{"version": ProtocolVersion, "command": "echo", "arguments": []string{"x"}}))
|
||||
|
||||
var res Response
|
||||
require.NoError(t, readFrame(conn, MaxResponseBytes, "response", &res, false))
|
||||
assert.Contains(t, res.Error, `unknown field "arguments"`)
|
||||
assert.Empty(t, res.Result)
|
||||
}
|
||||
|
||||
// TestTrailingBytesOnARequestAreRefused: a request line is one object and nothing
|
||||
// more; a second object or stray bytes after it are refused rather than ignored.
|
||||
func TestTrailingBytesOnARequestAreRefused(t *testing.T) {
|
||||
_, path := serve(t, basicRegistry())
|
||||
|
||||
for _, line := range []string{
|
||||
`{"version":1,"command":"echo"} junk` + "\n",
|
||||
`{"version":1,"command":"echo"}{"version":1,"command":"boom"}` + "\n",
|
||||
} {
|
||||
conn, err := dial(path, time.Second)
|
||||
require.NoError(t, err)
|
||||
_, err = conn.Write([]byte(line))
|
||||
require.NoError(t, err)
|
||||
|
||||
var res Response
|
||||
require.NoError(t, readFrame(conn, MaxResponseBytes, "response", &res, false))
|
||||
assert.Contains(t, res.Error, "unexpected data after the object", line)
|
||||
conn.Close()
|
||||
}
|
||||
}
|
||||
|
||||
// TestTextOutputKeepsTheBytes: a text rendering travels as the bytes the command wrote.
|
||||
// A JSON string would have had to be UTF-8, and a byte that is not would have come out
|
||||
// as U+FFFD, where the ssh server passes it through.
|
||||
func TestTextOutputKeepsTheBytes(t *testing.T) {
|
||||
reg := commands.New()
|
||||
raw := []byte{'n', 'a', 'm', 'e', ' ', 0xff, 0xfe, '\n'}
|
||||
reg.Register(&commands.Command{
|
||||
Name: "raw",
|
||||
ShortDescription: "writes what a certificate held",
|
||||
Run: func(fs any, a []string) (commands.Result, error) { return commands.Value("raw"), nil },
|
||||
Text: func(v any, w io.Writer) error {
|
||||
_, err := w.Write(raw)
|
||||
return err
|
||||
},
|
||||
})
|
||||
_, path := serve(t, reg)
|
||||
|
||||
res, err := (&Client{Path: path}).Invoke("raw", nil, nil, "text")
|
||||
require.NoError(t, err)
|
||||
assert.Empty(t, res.Error)
|
||||
assert.Equal(t, raw, res.Text)
|
||||
assert.Empty(t, res.Result, "text is not also carried as JSON")
|
||||
}
|
||||
@@ -0,0 +1,263 @@
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"log/slog"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"strings"
|
||||
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/config"
|
||||
)
|
||||
|
||||
// Endpoints is every local API Wire brought up, with the one Stop the daemon's exit
|
||||
// path calls.
|
||||
type Endpoints struct {
|
||||
Control *Server
|
||||
Info *InfoServer
|
||||
}
|
||||
|
||||
// Stop closes both endpoints and removes their sockets.
|
||||
func (e *Endpoints) Stop() {
|
||||
e.Info.Stop()
|
||||
e.Control.Stop()
|
||||
}
|
||||
|
||||
// Wire brings up the local APIs for a running nebula and keeps them following the
|
||||
// config across reloads: the control socket unless the config turns it off, and the
|
||||
// info API when the config asks for it.
|
||||
//
|
||||
// Every entry point that runs nebula as a daemon calls this, so the endpoints behave the
|
||||
// same whether nebula was started from a shell or by a service manager. It deliberately
|
||||
// does not live in nebula.Main: the control socket is on by default, so an embedder
|
||||
// inside an app sandbox would have to know to turn off a socket it cannot use. Wiring it
|
||||
// at the daemon entry points means embedders get the command registry and no listener.
|
||||
//
|
||||
// Every failure below is a warning, bar one. Nebula is expected to keep forwarding
|
||||
// packets whether or not anyone can reach it; but a name that another process holds is
|
||||
// not a misconfiguration, it is a process that will be answering nebula ctl in the
|
||||
// daemon's place, and that is logged as an error.
|
||||
//
|
||||
// Call it after Control.Start, so the listeners only exist once the interface is up.
|
||||
func Wire(ctx context.Context, l *slog.Logger, c *config.C, reg *commands.Registry) *Endpoints {
|
||||
l = l.With("subsystem", "localapi")
|
||||
return &Endpoints{
|
||||
Control: wireControl(ctx, l, c, reg),
|
||||
Info: wireInfo(ctx, l, c, reg),
|
||||
}
|
||||
}
|
||||
|
||||
// sharedSocketPath reports the path the config gives to both the control socket and the
|
||||
// info API, when it gives them one path. The two speak different protocols, so neither
|
||||
// binds it: each side says so and leaves it, and the operator fixes the config. The
|
||||
// configured paths are compared, not the ones being served, so the case is caught on
|
||||
// whichever side reconciles first, when the other side's bind has failed, and when a
|
||||
// reload moves one socket onto the other's path.
|
||||
func sharedSocketPath(c *config.C) (string, bool) {
|
||||
if !ControlEnabled(c) {
|
||||
return "", false
|
||||
}
|
||||
|
||||
ctl, err := SocketPathFromConfig(c)
|
||||
if err != nil {
|
||||
return "", false
|
||||
}
|
||||
|
||||
info, err := infoConfigFrom(c)
|
||||
if err != nil || !info.Enabled || !samePath(info.Path, ctl) {
|
||||
return "", false
|
||||
}
|
||||
|
||||
return ctl, true
|
||||
}
|
||||
|
||||
// samePath reports whether two configured socket paths name one node: cleaned, so a
|
||||
// doubled separator or a trailing one does not hide the match, and on windows, where
|
||||
// pipe names are case-insensitive, compared without case.
|
||||
func samePath(a, b string) bool {
|
||||
a, b = filepath.Clean(a), filepath.Clean(b)
|
||||
if runtime.GOOS == "windows" {
|
||||
return strings.EqualFold(a, b)
|
||||
}
|
||||
return a == b
|
||||
}
|
||||
|
||||
// wireControl brings up the control socket and keeps it pointed at the configured path.
|
||||
func wireControl(ctx context.Context, l *slog.Logger, c *config.C, reg *commands.Registry) *Server {
|
||||
srv := NewServer(l, reg)
|
||||
|
||||
// Registered before the first attempt, so that a path or bind that is bad at startup
|
||||
// can be fixed with a config edit and a reload, the same as one that goes bad later,
|
||||
// and so that a HUP landing in between is harmless: Rebind on a server already at
|
||||
// the path is a no-op.
|
||||
reconcile := followControlConfig(ctx, l, c, srv)
|
||||
reconcile(c)
|
||||
if !ControlEnabled(c) {
|
||||
l.Info("Local control socket is disabled", "key", CtlEnabledKey)
|
||||
}
|
||||
return srv
|
||||
}
|
||||
|
||||
// followControlConfig registers the reload callback that keeps the socket where
|
||||
// local_api.control.socket says it is, moving it when the key changes and bringing one
|
||||
// up while there is none, and returns it for the first attempt to call.
|
||||
//
|
||||
// The key is reloadable because the client finds the socket by reading the config: if the
|
||||
// two could disagree, the file on disk would name a socket that is not there.
|
||||
//
|
||||
// Every reload is reconciled rather than gated on the key having changed. Rebind on a
|
||||
// server already at the path is a no-op, so that costs nothing; and a bind that failed
|
||||
// for a reason outside the config, a runtime directory that was not there yet, is fixed
|
||||
// outside the config too, so the reload that follows the fix is a plain one. That holds
|
||||
// for a move as much as for the first bind: a daemon left on its old path by a move that
|
||||
// could not bind is one the client, reading the new path from the same file, cannot
|
||||
// reach, and the operator's fix is the directory and a reload, not an edit to an
|
||||
// unrelated line to make the key read as changed.
|
||||
func followControlConfig(ctx context.Context, l *slog.Logger, c *config.C, srv *Server) func(*config.C) {
|
||||
reconcile := func(c *config.C) {
|
||||
if !ControlEnabled(c) {
|
||||
if srv.Path() != "" {
|
||||
srv.Stop()
|
||||
l.Info("Stopped the local control socket, it is disabled in the reloaded config")
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
want, err := SocketPathFromConfig(c)
|
||||
if err != nil {
|
||||
warnUnusable(l, "local control socket", srv.Path(), err)
|
||||
return
|
||||
}
|
||||
|
||||
acc, err := controlAccessFrom(c)
|
||||
if err != nil {
|
||||
warnUnusable(l, "local control socket", srv.Path(), err)
|
||||
return
|
||||
}
|
||||
|
||||
if p, shared := sharedSocketPath(c); shared {
|
||||
l.Warn("Local control socket is configured on the info API's socket path and will not bind it",
|
||||
"path", p, "current", srv.Path(), "fix", "set "+InfoSocketKey+" to another path")
|
||||
return
|
||||
}
|
||||
|
||||
old := srv.Path()
|
||||
err = srv.Rebind(ctx, want, acc)
|
||||
reportRebind(l, "local control socket", old, want, err, srv.Path())
|
||||
}
|
||||
|
||||
onReload(l, c, "local control socket", reconcile)
|
||||
return reconcile
|
||||
}
|
||||
|
||||
// onReload registers fn to run on every reload. The callback recovers from its own
|
||||
// panics rather than relying on the config package, whose callback loop has no isolation
|
||||
// of its own: a panic there would take the daemon down and skip every callback queued
|
||||
// behind this one.
|
||||
func onReload(l *slog.Logger, c *config.C, what string, fn func(*config.C)) {
|
||||
c.RegisterReloadCallback(func(c *config.C, _ *config.Reload) {
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
l.Error("Recovered from panic reloading the "+what, "panic", r)
|
||||
}
|
||||
}()
|
||||
fn(c)
|
||||
})
|
||||
}
|
||||
|
||||
// warnUnusable logs a config the endpoint cannot follow: with nothing serving, the
|
||||
// endpoint is not available; with something serving, it is kept as it is.
|
||||
func warnUnusable(l *slog.Logger, what, current string, err error) {
|
||||
if current == "" {
|
||||
l.Warn("The "+what+" is not available, its config is unusable", "error", err)
|
||||
return
|
||||
}
|
||||
l.Warn("Ignoring unusable "+what+" config from the reload, keeping the current endpoint", "error", err, "current", current)
|
||||
}
|
||||
|
||||
// reportRebind logs what a Rebind did beyond the listening line the bind itself writes:
|
||||
// nothing for an endpoint left where it was, a move with both paths, and a failure with
|
||||
// what the operator is left with. old is the path served before the call, "" for none,
|
||||
// want the one asked for, and now the path served after it: on unix a failed move keeps
|
||||
// the old socket, and now is old; on windows a change of access closes the pipe before
|
||||
// creating it again, and a failure there leaves nothing serving, so now is "".
|
||||
//
|
||||
// Nearly every failure is the operator's environment, a missing runtime directory or a
|
||||
// bad path, and a warning; a name held by another process is an error, since nothing
|
||||
// else will say that something is sitting where the daemon should be.
|
||||
func reportRebind(l *slog.Logger, what, old, want string, err error, now string) {
|
||||
level := l.Warn
|
||||
if errors.Is(err, errEndpointHeld) {
|
||||
level = l.Error
|
||||
}
|
||||
|
||||
switch {
|
||||
case err == nil:
|
||||
if old != "" && old != want {
|
||||
l.Info("Moved the "+what, "from", old, "to", want)
|
||||
}
|
||||
case old == "":
|
||||
level("Could not start the "+what+", it will not be available until a reload binds it", "error", err, "path", want)
|
||||
default:
|
||||
level("Could not bind the "+what+" at the requested path", "error", err, "requested", want, "serving", now)
|
||||
}
|
||||
}
|
||||
|
||||
// wireInfo brings up the info API when the config asks for one and follows the config
|
||||
// across reloads: enabling it, disabling it, moving its socket and changing its mode.
|
||||
//
|
||||
// Every reload is reconciled, as the control socket's is; see followControlConfig. A
|
||||
// section that does not parse keeps whatever is running: the operator is told, and the
|
||||
// programs relying on the endpoint are not cut off by a typo.
|
||||
func wireInfo(ctx context.Context, l *slog.Logger, c *config.C, reg *commands.Registry) *InfoServer {
|
||||
srv := NewInfoServer(l, reg)
|
||||
|
||||
reconcile := func(c *config.C) {
|
||||
cfg, err := infoConfigFrom(c)
|
||||
if err != nil {
|
||||
warnUnusable(l, "local info API", srv.Path(), err)
|
||||
return
|
||||
}
|
||||
|
||||
if !cfg.Enabled {
|
||||
if srv.Path() != "" {
|
||||
srv.Stop()
|
||||
l.Info("Stopped the local info API, it is disabled in the reloaded config")
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// The two endpoints speak different protocols; one socket cannot be both. Caught
|
||||
// here, from the configured paths, because listen's own answer, that the socket is
|
||||
// in use by another nebula, would send the operator looking for a second process.
|
||||
if p, shared := sharedSocketPath(c); shared {
|
||||
if cur := srv.Path(); cur != "" {
|
||||
l.Warn("Ignoring the local info API's new socket path, it is also the control socket's; keeping the current endpoint",
|
||||
"path", p, "current", cur, "fix", "set "+InfoSocketKey+" to another path")
|
||||
} else {
|
||||
l.Warn("Local info API is not available, its socket path is also the control socket's", "path", p, "fix", "set "+InfoSocketKey+" to another path")
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
old := srv.Path()
|
||||
err = srv.Rebind(ctx, cfg.Path, cfg.Access)
|
||||
reportRebind(l, "local info API", old, cfg.Path, err, srv.Path())
|
||||
}
|
||||
|
||||
// Registered before the first attempt, as the control socket's is; see wireControl.
|
||||
onReload(l, c, "local info API", reconcile)
|
||||
reconcile(c)
|
||||
return srv
|
||||
}
|
||||
|
||||
// errEndpointHeld is returned by listen when the endpoint's name is already held by
|
||||
// some other process, which nebula will not serve alongside: whoever holds it would be
|
||||
// answering the endpoint's clients. It is only raised on windows, where the default
|
||||
// name can be held by another administrator's process and an override outside the
|
||||
// protected namespace by any account's; on unix a path that is still being served is an
|
||||
// earlier nebula, which clearStale reports as in use. The log line that carries it names
|
||||
// the endpoint, so the sentence does not.
|
||||
var errEndpointHeld = errors.New("the pipe's name is held by another process")
|
||||
@@ -0,0 +1,220 @@
|
||||
//go:build !windows
|
||||
|
||||
package localapi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// TestWireRecoversFromBadPathAtStartup covers a socket path that is unusable when nebula
|
||||
// starts. The operator's fix is a config edit and a reload, so the reload has to be able
|
||||
// to bring up a socket that never existed, not only move one that does.
|
||||
func TestWireRecoversFromBadPathAtStartup(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancel)
|
||||
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(fmt.Sprintf("local_api:\n control:\n socket: /%s\n", strings.Repeat("x", sunPathMax))))
|
||||
|
||||
srv := Wire(ctx, test.NewLogger(), c, basicRegistry()).Control
|
||||
t.Cleanup(srv.Stop)
|
||||
assert.Empty(t, srv.Path(), "an over-long path must not produce a socket")
|
||||
|
||||
good := testSocket(t)
|
||||
require.NoError(t, c.ReloadConfigString(fmt.Sprintf("local_api:\n control:\n socket: %s\n", good)).Err)
|
||||
|
||||
assert.Equal(t, good, srv.Path())
|
||||
out, errText := run(t, good, "echo", "hi")
|
||||
assert.Empty(t, errText)
|
||||
assert.Equal(t, "[hi]", out)
|
||||
}
|
||||
|
||||
// TestRebindAfterReloadBoundTheSocket covers a HUP that lands inside Wire, after the
|
||||
// reload callback is registered and before the first attempt runs. The callback does the
|
||||
// first bind; the attempt must then find the socket it was about to create already up
|
||||
// and leave it, not fail or rebind it, which would have Wire warn that commands are
|
||||
// unavailable while they are.
|
||||
func TestRebindAfterReloadBoundTheSocket(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancel)
|
||||
|
||||
path := testSocket(t)
|
||||
cfg := fmt.Sprintf("local_api:\n control:\n socket: %s\n", path)
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(cfg))
|
||||
|
||||
srv := NewServer(test.NewLogger(), basicRegistry())
|
||||
t.Cleanup(srv.Stop)
|
||||
|
||||
// Wire's first half, then the HUP.
|
||||
followControlConfig(ctx, test.NewLogger(), c, srv)
|
||||
require.NoError(t, c.ReloadConfigString(cfg).Err)
|
||||
require.Equal(t, path, srv.Path(), "the reload callback does the first bind")
|
||||
|
||||
// Wire's second half.
|
||||
require.NoError(t, srv.Rebind(ctx, path, ownerOnly()))
|
||||
assert.Equal(t, path, srv.Path())
|
||||
out, errText := run(t, path, "echo", "hi")
|
||||
assert.Empty(t, errText)
|
||||
assert.Equal(t, "[hi]", out)
|
||||
}
|
||||
|
||||
// TestWireRetriesAFailedMoveOnPlainReload covers a move whose bind fails for a reason
|
||||
// outside the config: the key names a path under a runtime directory that is not there
|
||||
// yet. The daemon keeps the old socket, but the client reads the new path from the same
|
||||
// file and cannot reach it, so the operator creates the directory and reloads. The key
|
||||
// has not changed since the move was asked for, and the reload still has to make it.
|
||||
func TestWireRetriesAFailedMoveOnPlainReload(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancel)
|
||||
|
||||
section := func(path string) string {
|
||||
return fmt.Sprintf("local_api:\n control:\n socket: %s\n", path)
|
||||
}
|
||||
first := testSocket(t)
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(section(first)))
|
||||
|
||||
srv := Wire(ctx, test.NewLogger(), c, basicRegistry()).Control
|
||||
t.Cleanup(srv.Stop)
|
||||
require.Equal(t, first, srv.Path())
|
||||
|
||||
runtimeDir := filepath.Join(privateBase(t), "run")
|
||||
moved := filepath.Join(runtimeDir, DirName, "s.sock")
|
||||
require.NoError(t, c.ReloadConfigString(section(moved)).Err)
|
||||
assert.Equal(t, first, srv.Path(), "a move that cannot bind keeps the socket it had")
|
||||
|
||||
require.NoError(t, os.Mkdir(runtimeDir, 0700))
|
||||
require.NoError(t, c.ReloadConfigString(section(moved)).Err)
|
||||
require.False(t, c.HasChanged(CtlSocketKey), "the config is the same; the fix was on disk")
|
||||
|
||||
assert.Equal(t, moved, srv.Path())
|
||||
_, err := os.Stat(first)
|
||||
assert.True(t, os.IsNotExist(err), "the old socket is given up once the move binds")
|
||||
out, errText := run(t, moved, "echo", "hi")
|
||||
assert.Empty(t, errText)
|
||||
assert.Equal(t, "[hi]", out)
|
||||
}
|
||||
|
||||
// TestWireRecoversOnPlainReloadAfterBadBind covers a path that is fine but a bind that
|
||||
// is not: the runtime directory is missing when nebula starts. The fix is made outside
|
||||
// the config, so the config does not change; a plain reload still has to bring the
|
||||
// socket up.
|
||||
func TestWireRecoversOnPlainReloadAfterBadBind(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancel)
|
||||
|
||||
base := privateBase(t)
|
||||
runtimeDir := filepath.Join(base, "run")
|
||||
path := filepath.Join(runtimeDir, DirName, "s.sock")
|
||||
cfg := fmt.Sprintf("local_api:\n control:\n socket: %s\n", path)
|
||||
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(cfg))
|
||||
|
||||
srv := Wire(ctx, test.NewLogger(), c, basicRegistry()).Control
|
||||
t.Cleanup(srv.Stop)
|
||||
assert.Empty(t, srv.Path(), "listen creates one level only, so a missing runtime dir fails the bind")
|
||||
|
||||
require.NoError(t, os.Mkdir(runtimeDir, 0700))
|
||||
require.NoError(t, c.ReloadConfigString(cfg).Err)
|
||||
require.False(t, c.HasChanged(CtlSocketKey), "the config is the same; the fix was on disk")
|
||||
|
||||
assert.Equal(t, path, srv.Path())
|
||||
out, errText := run(t, path, "echo", "hi")
|
||||
assert.Empty(t, errText)
|
||||
assert.Equal(t, "[hi]", out)
|
||||
|
||||
// And a reload with a socket up and no change in the key is still a no-op.
|
||||
require.NoError(t, c.ReloadConfigString(cfg).Err)
|
||||
assert.Equal(t, path, srv.Path())
|
||||
out, errText = run(t, path, "echo", "still")
|
||||
assert.Empty(t, errText)
|
||||
assert.Equal(t, "[still]", out)
|
||||
}
|
||||
|
||||
// TestWireControlCanBeDisabled: local_api.control.enabled false serves no socket, and
|
||||
// the key follows reloads both ways. With the control socket off, its path is free for
|
||||
// the info API to use.
|
||||
func TestWireControlCanBeDisabled(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancel)
|
||||
|
||||
path := testSocket(t)
|
||||
section := func(enabled bool) string {
|
||||
return fmt.Sprintf("local_api:\n control:\n enabled: %t\n socket: %s\n", enabled, path)
|
||||
}
|
||||
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(section(false)))
|
||||
eps := Wire(ctx, test.NewLogger(), c, basicRegistry())
|
||||
t.Cleanup(eps.Stop)
|
||||
srv := eps.Control
|
||||
assert.Empty(t, srv.Path())
|
||||
_, err := os.Lstat(path)
|
||||
assert.True(t, os.IsNotExist(err), "no socket is bound")
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(section(true)).Err)
|
||||
assert.Equal(t, path, srv.Path())
|
||||
out, errText := run(t, path, "echo", "on")
|
||||
assert.Empty(t, errText)
|
||||
assert.Equal(t, "[on]", out)
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(section(false)).Err)
|
||||
assert.Empty(t, srv.Path())
|
||||
_, err = os.Lstat(path)
|
||||
assert.True(t, os.IsNotExist(err), "the socket is removed")
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(section(false)+fmt.Sprintf(" info:\n enabled: true\n socket: %s\n", path)).Err)
|
||||
assert.Equal(t, path, eps.Info.Path(), "a disabled control socket does not hold its path")
|
||||
}
|
||||
|
||||
// TestWireRefusesOnePathForBothAPIs: a config that gives the control socket and the info
|
||||
// API one path is refused by both sides, from the configured paths, so it is caught
|
||||
// however the binds would have ordered themselves. Moving one off the path on a reload
|
||||
// brings both up.
|
||||
func TestWireRefusesOnePathForBothAPIs(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
t.Cleanup(cancel)
|
||||
|
||||
section := func(ctl, info string) string {
|
||||
return fmt.Sprintf("local_api:\n control:\n socket: %s\n info:\n enabled: true\n socket: %s\n", ctl, info)
|
||||
}
|
||||
shared := testSocket(t)
|
||||
c := config.NewC(test.NewLogger())
|
||||
require.NoError(t, c.LoadString(section(shared, shared)))
|
||||
|
||||
eps := Wire(ctx, test.NewLogger(), c, basicRegistry())
|
||||
t.Cleanup(eps.Stop)
|
||||
assert.Empty(t, eps.Control.Path(), "the control socket does not take the info API's path")
|
||||
assert.Empty(t, eps.Info.Path(), "the info API does not take the control socket's path")
|
||||
|
||||
// The same node spelled differently is the same node.
|
||||
doubled := filepath.Join(filepath.Dir(shared), "") + "//" + filepath.Base(shared)
|
||||
require.NoError(t, c.ReloadConfigString(section(shared, doubled)).Err)
|
||||
assert.Empty(t, eps.Control.Path())
|
||||
assert.Empty(t, eps.Info.Path())
|
||||
_, err := os.Stat(shared)
|
||||
assert.True(t, os.IsNotExist(err), "neither side bound the shared path")
|
||||
|
||||
// A reload that moves the control socket onto the info API's path is refused the same
|
||||
// way, and the control socket keeps the one it has.
|
||||
other := testSocket(t)
|
||||
require.NoError(t, c.ReloadConfigString(section(other, shared)).Err)
|
||||
require.Equal(t, other, eps.Control.Path())
|
||||
require.Equal(t, shared, eps.Info.Path())
|
||||
|
||||
require.NoError(t, c.ReloadConfigString(section(shared, shared)).Err)
|
||||
assert.Equal(t, other, eps.Control.Path(), "a move onto the info API's path keeps the current socket")
|
||||
assert.Equal(t, shared, eps.Info.Path())
|
||||
}
|
||||
@@ -12,6 +12,7 @@ import (
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/cpupick"
|
||||
"github.com/slackhq/nebula/noiseutil"
|
||||
@@ -71,7 +72,11 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
||||
}
|
||||
l.Info("Firewall started", "firewallHashes", fw.GetRuleHashes())
|
||||
|
||||
ssh, err := sshd.NewSSHServer(ctx, l.With("subsystem", "sshd"))
|
||||
// The command registry is shared by every surface that exposes these commands, so a
|
||||
// command cannot reach one of them without reaching the others.
|
||||
cmdRegistry := commands.New()
|
||||
|
||||
ssh, err := sshd.NewSSHServer(ctx, l.With("subsystem", "sshd"), cmdRegistry)
|
||||
if err != nil {
|
||||
return nil, util.ContextualizeIfNeeded("Error while creating SSH server", err)
|
||||
}
|
||||
@@ -343,13 +348,14 @@ func Main(c *config.C, configTest bool, buildVersion string, l *slog.Logger, dev
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
attachCommands(l, c, ssh, ifce)
|
||||
attachCommands(l, c, cmdRegistry, ifce)
|
||||
|
||||
networkChanges := udp.NewNetworkChangeMonitor(ctx, l, c)
|
||||
|
||||
return &Control{
|
||||
state: StateReady,
|
||||
f: ifce,
|
||||
commands: cmdRegistry,
|
||||
l: l,
|
||||
ctx: ctx,
|
||||
cancel: cancel,
|
||||
|
||||
@@ -20,6 +20,7 @@ type offloadQueueSet struct {
|
||||
// usoEnabled is true when newTun successfully negotiated TUN_F_USO4|6 with the kernel.
|
||||
// Queues created by Add inherit this and surface it via Offload.USOSupported so coalescers can gate USO emission.
|
||||
usoEnabled bool
|
||||
shutdown atomic.Bool
|
||||
closed atomic.Bool
|
||||
// l is handed to each queue for its bad-vnet-header drop logging.
|
||||
l *slog.Logger
|
||||
@@ -69,6 +70,17 @@ func (c *offloadQueueSet) wakeForShutdown() error {
|
||||
return err
|
||||
}
|
||||
|
||||
// Shutdown wakes every reader without releasing any fds, they see POLLIN on the eventfd and return os.ErrClosed
|
||||
func (c *offloadQueueSet) Shutdown() error {
|
||||
if c.shutdown.Swap(true) {
|
||||
return nil
|
||||
}
|
||||
for _, x := range c.pq {
|
||||
x.shutdown.Store(true)
|
||||
}
|
||||
return c.wakeForShutdown()
|
||||
}
|
||||
|
||||
func (c *offloadQueueSet) Close() error {
|
||||
if c.closed.Swap(true) {
|
||||
return nil
|
||||
@@ -76,9 +88,7 @@ func (c *offloadQueueSet) Close() error {
|
||||
|
||||
errs := []error{}
|
||||
|
||||
// Signal all readers blocked in poll to wake up and exit.
|
||||
// They observe POLLIN on the shutdown eventfd and return os.ErrClosed.
|
||||
if err := c.wakeForShutdown(); err != nil {
|
||||
if err := c.Shutdown(); err != nil {
|
||||
errs = append(errs, err)
|
||||
}
|
||||
|
||||
|
||||
@@ -16,6 +16,7 @@ type pollQueueSet struct {
|
||||
// pqi is exactly the same as pq, but stored as the interface type
|
||||
pqi []Queue
|
||||
shutdownFd int
|
||||
shutdown atomic.Bool
|
||||
closed atomic.Bool
|
||||
}
|
||||
|
||||
@@ -59,6 +60,17 @@ func (c *pollQueueSet) wakeForShutdown() error {
|
||||
return err
|
||||
}
|
||||
|
||||
// Shutdown wakes every reader without releasing any fds, they see POLLIN on the eventfd and return os.ErrClosed
|
||||
func (c *pollQueueSet) Shutdown() error {
|
||||
if c.shutdown.Swap(true) {
|
||||
return nil
|
||||
}
|
||||
for _, x := range c.pq {
|
||||
x.shutdown.Store(true)
|
||||
}
|
||||
return c.wakeForShutdown()
|
||||
}
|
||||
|
||||
func (c *pollQueueSet) Close() error {
|
||||
if c.closed.Swap(true) {
|
||||
return nil
|
||||
@@ -66,9 +78,7 @@ func (c *pollQueueSet) Close() error {
|
||||
|
||||
errs := []error{}
|
||||
|
||||
// Signal all readers blocked in poll to wake up and exit.
|
||||
// They observe POLLIN on the shutdown eventfd and return os.ErrClosed.
|
||||
if err := c.wakeForShutdown(); err != nil {
|
||||
if err := c.Shutdown(); err != nil {
|
||||
errs = append(errs, err)
|
||||
}
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@ import (
|
||||
// QueueSet holds one or many Queue objects and helps close them in an orderly way.
|
||||
type QueueSet interface {
|
||||
io.Closer
|
||||
// Shutdown wakes every reader without releasing any fds, Close only once they have exited
|
||||
Shutdown() error
|
||||
Queues() []Queue
|
||||
|
||||
// Add takes a tun fd, adds it to the set, and prepares it for use as a Queue.
|
||||
|
||||
@@ -66,7 +66,9 @@ type Offload struct {
|
||||
// usoEnabled records whether the kernel agreed to TUN_F_USO* on this FD,
|
||||
// so writers can decide whether emitting GSO_UDP_L4 superpackets is safe.
|
||||
usoEnabled bool
|
||||
closed atomic.Bool
|
||||
// shutdown is set before shutdownFd is signaled, a busy reader never polls to see that
|
||||
shutdown atomic.Bool
|
||||
closed atomic.Bool
|
||||
|
||||
// gsoHdrBuf is a per-queue 10-byte scratch for the virtio_net_hdr emitted
|
||||
// by WriteGSO. Kept separate from the read-only package-level validVnetHdr
|
||||
@@ -176,6 +178,9 @@ func (r *Offload) readPacket(block bool) (int, error) {
|
||||
// This amortizes the poll wake over bursts of small packets (e.g. TCP ACKs).
|
||||
// Packet.Bytes slices point into the Offload's internal buffer and are only valid until the next Read or Close on this Queue.
|
||||
func (r *Offload) Read() ([]Packet, error) {
|
||||
if r.shutdown.Load() {
|
||||
return nil, os.ErrClosed
|
||||
}
|
||||
r.pending = r.pending[:0]
|
||||
r.rxOff = 0
|
||||
|
||||
|
||||
@@ -13,7 +13,9 @@ import (
|
||||
type Poll struct {
|
||||
fd int
|
||||
shutdownFd int
|
||||
closed atomic.Bool
|
||||
// shutdown is set before shutdownFd is signaled, a busy reader never polls to see that
|
||||
shutdown atomic.Bool
|
||||
closed atomic.Bool
|
||||
|
||||
readBuf []byte
|
||||
batchRet [1]Packet
|
||||
@@ -52,6 +54,9 @@ func (t *Poll) blockOnWrite() error {
|
||||
// config currently lose that batching. blockOn and the EAGAIN plumbing are
|
||||
// already shared; kept one-packet-per-Read for now to preserve behavior.
|
||||
func (t *Poll) Read() ([]Packet, error) {
|
||||
if t.shutdown.Load() {
|
||||
return nil, os.ErrClosed
|
||||
}
|
||||
n, err := t.readOne(t.readBuf)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
|
||||
@@ -223,3 +223,30 @@ func TestOffloadQueueSet_Close_ClosesShutdownFd(t *testing.T) {
|
||||
// Second Close must not touch fds (shutdownFd is now -1) and must return nil.
|
||||
require.NoError(t, qs.Close())
|
||||
}
|
||||
|
||||
// A busy reader never polls the shutdown eventfd, so Read has to stop on its own with data still waiting
|
||||
func TestQueueSet_ShutdownStopsReaderWithDataWaiting(t *testing.T) {
|
||||
sets := map[string]func() (QueueSet, error){
|
||||
"poll": NewPollQueueSet,
|
||||
"offload": func() (QueueSet, error) { return NewOffloadQueueSet(false, slog.New(slog.DiscardHandler)) },
|
||||
}
|
||||
for name, newSet := range sets {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
var fds [2]int
|
||||
require.NoError(t, unix.Pipe2(fds[:], unix.O_CLOEXEC))
|
||||
t.Cleanup(func() { _ = unix.Close(fds[1]) })
|
||||
|
||||
qs, err := newSet()
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, qs.Add(fds[0]))
|
||||
t.Cleanup(func() { _ = qs.Close() })
|
||||
|
||||
_, err = unix.Write(fds[1], make([]byte, 64))
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, qs.Shutdown())
|
||||
|
||||
_, err = qs.Queues()[0].Read()
|
||||
require.ErrorIs(t, err, os.ErrClosed)
|
||||
})
|
||||
}
|
||||
}
|
||||
+54
-84
@@ -3,7 +3,6 @@
|
||||
package overlay
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"math/bits"
|
||||
@@ -12,6 +11,7 @@ import (
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
"syscall"
|
||||
"time"
|
||||
"unsafe"
|
||||
|
||||
"github.com/gaissmai/bart"
|
||||
@@ -35,6 +35,26 @@ type tun struct {
|
||||
// and routes for it. NEPacketTunnelProvider on darwin does this.
|
||||
hostOwned bool
|
||||
l *slog.Logger
|
||||
|
||||
// routesMu serializes changes to the system routing table between reload and the route watcher, and guards the
|
||||
// fields below it
|
||||
routesMu sync.Mutex
|
||||
// routeStates is who held each installable unsafe_route prefix when we last looked
|
||||
routeStates map[netip.Prefix]routeState
|
||||
// routeWatch is the routing socket watchRoutes reads, Close closes it
|
||||
routeWatch *os.File
|
||||
// routeSweep reconciles the unsafe_routes every routeSweepEvery
|
||||
routeSweep *time.Timer
|
||||
routeSweepEvery time.Duration
|
||||
closed bool
|
||||
|
||||
// routeMovers is who last changed each unsafe_route prefix since the last reconcile, for its logs. It has its own
|
||||
// lock so the route watcher never waits on a reconcile
|
||||
routeMoversMu sync.Mutex
|
||||
routeMovers map[netip.Prefix]routeMover
|
||||
|
||||
// lastRouteEvent is when the routing socket last reported something that may have moved a prefix, in unix nanos
|
||||
lastRouteEvent atomic.Int64
|
||||
}
|
||||
|
||||
type ifReq struct {
|
||||
@@ -139,11 +159,12 @@ func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, _ bool) (*t
|
||||
}
|
||||
|
||||
t := &tun{
|
||||
f: os.NewFile(uintptr(fd), ""),
|
||||
Device: name,
|
||||
vpnNetworks: vpnNetworks,
|
||||
DefaultMTU: getMTU(l, c),
|
||||
l: l,
|
||||
f: os.NewFile(uintptr(fd), ""),
|
||||
Device: name,
|
||||
vpnNetworks: vpnNetworks,
|
||||
DefaultMTU: getMTU(l, c),
|
||||
routeSweepEvery: routeSweepInterval,
|
||||
l: l,
|
||||
}
|
||||
|
||||
err = t.reload(c, true, nil)
|
||||
@@ -219,6 +240,16 @@ func utunNameFromFd(fd int) string {
|
||||
}
|
||||
|
||||
func (t *tun) Close() error {
|
||||
t.routesMu.Lock()
|
||||
t.closed = true
|
||||
if t.routeWatch != nil {
|
||||
_ = t.routeWatch.Close()
|
||||
}
|
||||
if t.routeSweep != nil {
|
||||
t.routeSweep.Stop()
|
||||
}
|
||||
t.routesMu.Unlock()
|
||||
|
||||
if t.f != nil {
|
||||
return t.f.Close()
|
||||
}
|
||||
@@ -287,8 +318,22 @@ func (t *tun) Activate() error {
|
||||
return fmt.Errorf("failed to run tun device: %s", err)
|
||||
}
|
||||
|
||||
// Watch before adding so a route removed in between is still noticed
|
||||
watch, err := openRouteSocket()
|
||||
if err != nil {
|
||||
t.l.Error("Failed to watch the system routing table, unsafe_routes held by another interface are only retried every minute", "error", err)
|
||||
}
|
||||
|
||||
// Unsafe path routes
|
||||
return t.addRoutes(false, nil)
|
||||
if err = t.addRoutes(false, nil); err != nil {
|
||||
if watch != nil {
|
||||
_ = watch.Close()
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
t.startRouteWatch(watch)
|
||||
return nil
|
||||
}
|
||||
|
||||
// activate4 assigns our vpn address as a /32 and routes the vpn network to the tun explicitly.
|
||||
@@ -393,7 +438,8 @@ func (t *tun) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||
}
|
||||
|
||||
if !initial && !change {
|
||||
return nil
|
||||
// Any reload puts back the unsafe_routes someone deleted
|
||||
return t.addRoutes(true, r)
|
||||
}
|
||||
|
||||
routeTree, err := makeRouteTree(t.l, routes, false)
|
||||
@@ -511,82 +557,6 @@ func getLinkAddr(name string) (*netroute.LinkAddr, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
// The route tree is still ours, the system routing table is not
|
||||
if t.hostOwned {
|
||||
return nil
|
||||
}
|
||||
|
||||
// Activate hasn't run yet, it will install the routes
|
||||
linkAddr := t.linkAddr.Load()
|
||||
if linkAddr == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
routes := *t.Routes.Load()
|
||||
systemRoutes := sync.OnceValues(fetchRoutes)
|
||||
|
||||
for _, r := range routes {
|
||||
if len(r.Via) == 0 || !r.Install {
|
||||
// We don't allow route MTUs so only install routes with a via
|
||||
continue
|
||||
}
|
||||
|
||||
err := addRoute(r.Cidr, linkAddr)
|
||||
if err != nil {
|
||||
if errors.Is(err, unix.EEXIST) {
|
||||
// Every route we added already exists on a reload, only warn about someone else's
|
||||
msgs, err := systemRoutes()
|
||||
if err != nil {
|
||||
t.l.Warn("unable to add unsafe_route, a route already exists but its interface could not be determined", "route", r.Cidr, "error", err)
|
||||
} else if routeInterfaceIn(msgs, r.Cidr) != linkAddr.Index {
|
||||
t.l.Warn("unable to add unsafe_route, the destination is already routed through another interface", "route", r.Cidr)
|
||||
}
|
||||
} else {
|
||||
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||
if logErrors {
|
||||
retErr.Log(t.l)
|
||||
rl.Failed()
|
||||
} else {
|
||||
return retErr
|
||||
}
|
||||
}
|
||||
} else {
|
||||
t.l.Info("Added route", "route", r)
|
||||
// A cidr listed twice would otherwise find our own route missing from an older fetch
|
||||
systemRoutes = sync.OnceValues(fetchRoutes)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tun) removeRoutes(routes []Route, rl *config.Reload) error {
|
||||
linkAddr := t.linkAddr.Load()
|
||||
if t.hostOwned || linkAddr == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
for _, r := range routes {
|
||||
if len(r.Via) == 0 || !r.Install {
|
||||
// addRoutes never installs these
|
||||
continue
|
||||
}
|
||||
|
||||
err := delRoute(r.Cidr, linkAddr)
|
||||
if errors.Is(err, unix.ESRCH) {
|
||||
// Already gone, which is what we wanted
|
||||
t.l.Info("Route was already removed", "route", r)
|
||||
} else if err != nil {
|
||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||
rl.Failed()
|
||||
} else {
|
||||
t.l.Info("Removed route", "route", r)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func addRoute(prefix netip.Prefix, gateway netroute.Addr) error {
|
||||
sock, err := unix.Socket(unix.AF_ROUTE, unix.SOCK_RAW, unix.AF_UNSPEC)
|
||||
if err != nil {
|
||||
|
||||
@@ -3,12 +3,17 @@
|
||||
package overlay
|
||||
|
||||
import (
|
||||
"encoding/binary"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"net"
|
||||
"net/netip"
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/routing"
|
||||
@@ -104,6 +109,367 @@ func TestTunReloadLeavesRoutesItNeverInstalled(t *testing.T) {
|
||||
assert.Equal(t, lo0.Index, routeInterfaceIn(msgs, netip.MustParsePrefix(cidr)))
|
||||
}
|
||||
|
||||
// Captured on macOS 15.6 while adding and removing 198.51.100.77/24 on a feth
|
||||
const (
|
||||
// The kernel deleting the address's subnet route. It packs its sockaddrs without padding, x/net/route can't parse it
|
||||
kernelSubnetDelete = "870005022300000000010002070000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010020000c63364000000000000000000141223000600000000000000000000000000000007ffffffffffff"
|
||||
addressRemoved = "5000050db400000001010000230000000000000007020000ffffff00141223000606060066657468373766657468004d10020000c633644d000000000000000010020000c63364ff0000000000000000"
|
||||
// With no interface address, which x/net/route skips
|
||||
interfaceChanged = "7000050e000000004288000023000000060000060e000000dc05000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000073e5ce6a0000000000000000000001000000000000000000"
|
||||
)
|
||||
|
||||
func TestRoutesMayHaveMoved(t *testing.T) {
|
||||
cidr := netip.MustParsePrefix("192.168.1.0/24")
|
||||
via := routing.Gateways{routing.NewGateway(netip.MustParseAddr("10.250.0.2"), 1)}
|
||||
routes := []Route{{Cidr: cidr, Via: via, Install: true}}
|
||||
// A request like route(8) sends, the kernel echoes it to every routing socket
|
||||
request := func(typ, flags int, dst, mask [4]byte) []byte {
|
||||
m := &netroute.RouteMessage{
|
||||
Version: unix.RTM_VERSION,
|
||||
Type: typ,
|
||||
Flags: flags,
|
||||
ID: 1234,
|
||||
Addrs: []netroute.Addr{
|
||||
unix.RTAX_DST: &netroute.Inet4Addr{IP: dst},
|
||||
unix.RTAX_GATEWAY: &netroute.LinkAddr{Index: 4},
|
||||
unix.RTAX_NETMASK: &netroute.Inet4Addr{IP: mask},
|
||||
},
|
||||
}
|
||||
b, err := m.Marshal()
|
||||
require.NoError(t, err)
|
||||
return b
|
||||
}
|
||||
raw := func(s string) []byte {
|
||||
b, err := hex.DecodeString(s)
|
||||
require.NoError(t, err)
|
||||
return b
|
||||
}
|
||||
lan, mask := [4]byte{192, 168, 1, 0}, [4]byte{255, 255, 255, 0}
|
||||
routesMayHaveMoved := func(b []byte, routes []Route) bool {
|
||||
moved, _, _ := routesMayHaveMoved(b, routes)
|
||||
return moved
|
||||
}
|
||||
|
||||
assert.True(t, routesMayHaveMoved(request(unix.RTM_DELETE, unix.RTF_UP, lan, mask), routes))
|
||||
assert.True(t, routesMayHaveMoved(request(unix.RTM_ADD, unix.RTF_UP, lan, mask), routes))
|
||||
assert.True(t, routesMayHaveMoved(request(unix.RTM_CHANGE, unix.RTF_UP, lan, mask), routes))
|
||||
assert.False(t, routesMayHaveMoved(request(unix.RTM_GET, unix.RTF_UP, lan, mask), routes))
|
||||
assert.False(t, routesMayHaveMoved(request(unix.RTM_DELETE, unix.RTF_UP|unix.RTF_IFSCOPE, lan, mask), routes), "a scoped route never held the prefix")
|
||||
assert.False(t, routesMayHaveMoved(request(unix.RTM_ADD, unix.RTF_UP|unix.RTF_IFSCOPE, lan, mask), routes), "configd adds a scoped copy for each interface")
|
||||
assert.False(t, routesMayHaveMoved(request(unix.RTM_DELETE, unix.RTF_UP, lan, [4]byte{255, 255, 0, 0}), routes), "only an exact prefix counts")
|
||||
assert.False(t, routesMayHaveMoved(request(unix.RTM_DELETE, unix.RTF_UP, lan, mask), []Route{{Cidr: cidr, Install: true}}), "a route with no via is never installed")
|
||||
assert.False(t, routesMayHaveMoved(request(unix.RTM_DELETE, unix.RTF_UP, lan, mask), []Route{{Cidr: cidr, Via: via}}), "install: false")
|
||||
|
||||
failed := request(unix.RTM_DELETE, unix.RTF_UP, lan, mask)
|
||||
binary.NativeEndian.PutUint32(failed[24:28], uint32(unix.ESRCH))
|
||||
assert.False(t, routesMayHaveMoved(failed, routes), "a failed request is echoed too")
|
||||
|
||||
_, err := netroute.ParseRIB(unix.NET_RT_DUMP, raw(kernelSubnetDelete))
|
||||
require.Error(t, err, "if x/net/route learns to parse these, match their prefix instead")
|
||||
assert.True(t, routesMayHaveMoved(raw(kernelSubnetDelete), routes), "the kernel's own deletes could be any prefix")
|
||||
neighbor := raw(kernelSubnetDelete)
|
||||
binary.NativeEndian.PutUint32(neighbor[8:12], unix.RTF_UP|unix.RTF_HOST|unix.RTF_LLINFO)
|
||||
assert.False(t, routesMayHaveMoved(neighbor, routes), "a neighbor expiring")
|
||||
|
||||
assert.True(t, routesMayHaveMoved(raw(addressRemoved), routes))
|
||||
assert.True(t, routesMayHaveMoved(raw(interfaceChanged), routes), "detaching an interface deletes its routes without a message for each")
|
||||
}
|
||||
|
||||
// A request names its prefix and who made it, the kernel's own and interface changes name neither
|
||||
func TestRoutesMayHaveMovedSaysWho(t *testing.T) {
|
||||
cidr := netip.MustParsePrefix("192.168.1.0/24")
|
||||
routes := []Route{{Cidr: cidr, Via: routing.Gateways{routing.NewGateway(netip.MustParseAddr("10.250.0.2"), 1)}, Install: true}}
|
||||
m := &netroute.RouteMessage{
|
||||
Version: unix.RTM_VERSION,
|
||||
Type: unix.RTM_CHANGE,
|
||||
Flags: unix.RTF_UP,
|
||||
ID: 1234,
|
||||
Addrs: []netroute.Addr{
|
||||
unix.RTAX_DST: &netroute.Inet4Addr{IP: [4]byte{192, 168, 1, 0}},
|
||||
unix.RTAX_GATEWAY: &netroute.LinkAddr{Index: 4},
|
||||
unix.RTAX_NETMASK: &netroute.Inet4Addr{IP: [4]byte{255, 255, 255, 0}},
|
||||
},
|
||||
}
|
||||
b, err := m.Marshal()
|
||||
require.NoError(t, err)
|
||||
moved, p, pid := routesMayHaveMoved(b, routes)
|
||||
assert.True(t, moved)
|
||||
assert.Equal(t, cidr, p)
|
||||
assert.Equal(t, int32(1234), pid)
|
||||
|
||||
for name, s := range map[string]string{"kernel": kernelSubnetDelete, "ifinfo": interfaceChanged} {
|
||||
b, err := hex.DecodeString(s)
|
||||
require.NoError(t, err)
|
||||
moved, p, pid := routesMayHaveMoved(b, routes)
|
||||
assert.True(t, moved, name)
|
||||
assert.False(t, p.IsValid(), name)
|
||||
assert.Zero(t, pid, name)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProcessName(t *testing.T) {
|
||||
assert.Equal(t, "launchd", processName(1))
|
||||
self := filepath.Base(os.Args[0])
|
||||
assert.Equal(t, self[:min(len(self), 16)], processName(int32(os.Getpid())))
|
||||
assert.Empty(t, processName(-1))
|
||||
}
|
||||
|
||||
// newRouteTestTun is an activated tun for the root tests below with an unsafe_route for each of cidrs. sweep replaces
|
||||
// the minute between sweeps when it isn't zero.
|
||||
func newRouteTestTun(t *testing.T, sweep time.Duration, cidrs ...string) (*tun, *config.C, string) {
|
||||
requireRoot(t)
|
||||
|
||||
cfg := "tun:\n unsafe_routes:\n"
|
||||
for _, cidr := range cidrs {
|
||||
via := "10.250.0.2"
|
||||
if netip.MustParsePrefix(cidr).Addr().Is6() {
|
||||
via = "fd00:250::2"
|
||||
}
|
||||
cfg += " - route: " + cidr + "\n via: " + via + "\n"
|
||||
}
|
||||
|
||||
l := test.NewLogger()
|
||||
c := config.NewC(l)
|
||||
require.NoError(t, c.LoadString(cfg))
|
||||
tn, err := newTun(c, l, []netip.Prefix{netip.MustParsePrefix("10.250.0.1/24"), netip.MustParsePrefix("fd00:250::1/64")}, false)
|
||||
require.NoError(t, err)
|
||||
if sweep != 0 {
|
||||
tn.routeSweepEvery = sweep
|
||||
}
|
||||
t.Cleanup(func() { _ = tn.Close() })
|
||||
require.NoError(t, tn.Activate())
|
||||
return tn, c, cfg
|
||||
}
|
||||
|
||||
func requireRoot(t *testing.T) {
|
||||
if os.Geteuid() != 0 {
|
||||
t.Skip("creating interfaces and adding routes needs root")
|
||||
}
|
||||
}
|
||||
|
||||
// routeVia is the index of the interface that routes cidr, 0 if none does
|
||||
func routeVia(t *testing.T, cidr string) int {
|
||||
msgs, err := fetchRoutes()
|
||||
require.NoError(t, err)
|
||||
return routeInterfaceIn(msgs, netip.MustParsePrefix(cidr))
|
||||
}
|
||||
|
||||
// routeStateOf is what tn made of cidr when it last looked
|
||||
func routeStateOf(tn *tun, cidr string) routeState {
|
||||
tn.routesMu.Lock()
|
||||
defer tn.routesMu.Unlock()
|
||||
return tn.routeStates[netip.MustParsePrefix(cidr)]
|
||||
}
|
||||
|
||||
func routeArgs(action, cidr string, extra ...string) []string {
|
||||
args := []string{"-q", "-n", action}
|
||||
if netip.MustParsePrefix(cidr).Addr().Is6() {
|
||||
args = append(args, "-inet6")
|
||||
}
|
||||
return append(append(args, "-net", cidr), extra...)
|
||||
}
|
||||
|
||||
func routeCmd(t *testing.T, action, cidr string, extra ...string) {
|
||||
requireRouteOK(t, exec.Command("route", routeArgs(action, cidr, extra...)...))
|
||||
}
|
||||
|
||||
// requireRouteOK runs cmd, which runs route(8). route exits 0 when the kernel rejects its request, only what it prints
|
||||
// says so
|
||||
func requireRouteOK(t *testing.T, cmd *exec.Cmd) {
|
||||
out, err := cmd.CombinedOutput()
|
||||
require.NoError(t, err, string(out))
|
||||
require.NotContains(t, string(out), "writing to routing socket")
|
||||
}
|
||||
|
||||
// cleanupRoute deletes cidr's route when the test ends, whoever holds it
|
||||
func cleanupRoute(t *testing.T, cidr string) {
|
||||
t.Cleanup(func() { _ = exec.Command("route", routeArgs("delete", cidr)...).Run() })
|
||||
}
|
||||
|
||||
// routeThroughLo0 routes cidr through lo0, like a lan nebula started on
|
||||
func routeThroughLo0(t *testing.T, cidr string) int {
|
||||
requireRoot(t)
|
||||
routeCmd(t, "add", cidr, "-interface", "lo0")
|
||||
cleanupRoute(t, cidr)
|
||||
lo0, err := net.InterfaceByName("lo0")
|
||||
require.NoError(t, err)
|
||||
return lo0.Index
|
||||
}
|
||||
|
||||
// Leaving the lan that held an unsafe_route's prefix must not need a restart to get the unsafe_route
|
||||
func TestTunAddsRouteOnceItsPrefixIsFree(t *testing.T) {
|
||||
for _, cidr := range []string{"10.251.0.0/24", "2001:db8:251::/64"} {
|
||||
t.Run(cidr, func(t *testing.T) {
|
||||
lo0 := routeThroughLo0(t, cidr)
|
||||
tn, _, _ := newRouteTestTun(t, 0, cidr)
|
||||
require.Equal(t, lo0, routeVia(t, cidr), "an existing route keeps its prefix")
|
||||
|
||||
routeCmd(t, "delete", cidr)
|
||||
assert.Eventually(t, func() bool { return routeVia(t, cidr) == tn.linkAddr.Load().Index }, 5*time.Second, 50*time.Millisecond)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// The kernel deletes a route by prefix alone, so dropping an unsafe_route someone else holds must not delete theirs
|
||||
func TestTunReloadLeavesRouteItYielded(t *testing.T) {
|
||||
cidr := "10.251.1.0/24"
|
||||
lo0 := routeThroughLo0(t, cidr)
|
||||
_, c, _ := newRouteTestTun(t, 0, cidr)
|
||||
|
||||
res := c.ReloadConfigString("tun: {}\n")
|
||||
require.NoError(t, res.Err)
|
||||
assert.False(t, res.Failed)
|
||||
assert.Equal(t, lo0, routeVia(t, cidr))
|
||||
}
|
||||
|
||||
// configd takes a prefix by deleting the route holding it and adding its own. Ours goes back once theirs is removed
|
||||
func TestTunYieldsToARouteThatReplacesIt(t *testing.T) {
|
||||
cidr := "10.251.3.0/24"
|
||||
tn, _, _ := newRouteTestTun(t, 0, cidr)
|
||||
ours := tn.linkAddr.Load().Index
|
||||
require.Equal(t, ours, routeVia(t, cidr))
|
||||
|
||||
cleanupRoute(t, cidr)
|
||||
requireRouteOK(t, exec.Command("sh", "-c", "route -q -n delete -net "+cidr+" && route -q -n add -net "+cidr+" -interface lo0"))
|
||||
lo0, err := net.InterfaceByName("lo0")
|
||||
require.NoError(t, err)
|
||||
time.Sleep(2 * routeRetryDelay)
|
||||
require.Equal(t, lo0.Index, routeVia(t, cidr))
|
||||
|
||||
routeCmd(t, "delete", cidr)
|
||||
assert.Eventually(t, func() bool { return routeVia(t, cidr) == ours }, 5*time.Second, 50*time.Millisecond)
|
||||
}
|
||||
|
||||
// A route someone deleted, with nothing in its place, stays gone until a reload, so they can put their own there
|
||||
func TestTunLeavesRouteDeletedByHand(t *testing.T) {
|
||||
cidr := "10.251.4.0/24"
|
||||
tn, c, cfg := newRouteTestTun(t, 200*time.Millisecond, cidr)
|
||||
ours := tn.linkAddr.Load().Index
|
||||
require.Equal(t, ours, routeVia(t, cidr))
|
||||
|
||||
routeCmd(t, "delete", cidr)
|
||||
assert.Never(t, func() bool { return routeVia(t, cidr) != 0 }, 3*routeRetryDelay, 50*time.Millisecond)
|
||||
|
||||
// A reload with nothing changed is how to ask for it back
|
||||
res := c.ReloadConfigString(cfg)
|
||||
require.NoError(t, res.Err)
|
||||
assert.False(t, res.Failed)
|
||||
assert.Equal(t, ours, routeVia(t, cidr))
|
||||
}
|
||||
|
||||
// configd deleting ours and adding the lan's more than routeRetryDelay apart, or a sweep landing in between, looks like
|
||||
// a hand delete. Seeing the lan hold the prefix puts ours back in line, it goes back once theirs is removed
|
||||
func TestTunYieldsAfterLeavingARouteDeletedByHand(t *testing.T) {
|
||||
for name, tc := range map[string]struct {
|
||||
cidr string
|
||||
sweep time.Duration
|
||||
misfile func(t *testing.T, tn *tun, cidr string)
|
||||
}{
|
||||
// The table went quiet with nothing in its place. The minute sweep leaves noticing the lan's route to the watcher
|
||||
"settled": {"10.251.6.0/24", 0, func(t *testing.T, tn *tun, cidr string) {
|
||||
require.Eventually(t, func() bool { return routeStateOf(tn, cidr).kind == routeRemoved }, 5*time.Second, 50*time.Millisecond)
|
||||
}},
|
||||
// The sweep that caps a table that never settles
|
||||
"swept": {"10.251.7.0/24", 200 * time.Millisecond, func(t *testing.T, tn *tun, cidr string) {
|
||||
tn.reconcileRoutes()
|
||||
require.Equal(t, routeRemoved, routeStateOf(tn, cidr).kind)
|
||||
}},
|
||||
} {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
tn, _, _ := newRouteTestTun(t, tc.sweep, tc.cidr)
|
||||
ours := tn.linkAddr.Load().Index
|
||||
require.Equal(t, ours, routeVia(t, tc.cidr))
|
||||
|
||||
routeCmd(t, "delete", tc.cidr)
|
||||
tc.misfile(t, tn, tc.cidr)
|
||||
|
||||
lo0 := routeThroughLo0(t, tc.cidr)
|
||||
require.Eventually(t, func() bool {
|
||||
s := routeStateOf(tn, tc.cidr)
|
||||
return s.kind == routeYielded && s.holder == lo0
|
||||
}, 5*time.Second, 50*time.Millisecond)
|
||||
|
||||
routeCmd(t, "delete", tc.cidr)
|
||||
assert.Eventually(t, func() bool { return routeVia(t, tc.cidr) == ours }, 5*time.Second, 50*time.Millisecond)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Changing our route to another interface hands it the prefix, ours goes back once theirs is removed rather than being
|
||||
// taken for a hand delete
|
||||
func TestTunYieldsToARouteChangedAway(t *testing.T) {
|
||||
for _, cidr := range []string{"10.251.8.0/24", "2001:db8:258::/64"} {
|
||||
t.Run(cidr, func(t *testing.T) {
|
||||
tn, _, _ := newRouteTestTun(t, 0, cidr)
|
||||
ours := tn.linkAddr.Load().Index
|
||||
require.Equal(t, ours, routeVia(t, cidr))
|
||||
|
||||
cleanupRoute(t, cidr)
|
||||
routeCmd(t, "change", cidr, "-interface", "lo0")
|
||||
lo0, err := net.InterfaceByName("lo0")
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, lo0.Index, routeVia(t, cidr))
|
||||
require.Eventually(t, func() bool {
|
||||
s := routeStateOf(tn, cidr)
|
||||
return s.kind == routeYielded && s.holder == lo0.Index
|
||||
}, 5*time.Second, 50*time.Millisecond)
|
||||
|
||||
routeCmd(t, "delete", cidr)
|
||||
assert.Eventually(t, func() bool { return routeVia(t, cidr) == ours }, 5*time.Second, 50*time.Millisecond)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Detaching an interface deletes its routes without a routing socket message for each, like unplugging the dock whose
|
||||
// ethernet configd routed the lan through
|
||||
func TestTunAddsRouteWhenItsInterfaceDetaches(t *testing.T) {
|
||||
requireRoot(t)
|
||||
var feth string
|
||||
for i := 100; i < 200 && feth == ""; i++ {
|
||||
if _, err := net.InterfaceByName(fmt.Sprintf("feth%d", i)); err != nil {
|
||||
feth = fmt.Sprintf("feth%d", i)
|
||||
}
|
||||
}
|
||||
require.NotEmpty(t, feth)
|
||||
require.NoError(t, exec.Command("ifconfig", feth, "create").Run())
|
||||
t.Cleanup(func() { _ = exec.Command("ifconfig", feth, "destroy").Run() })
|
||||
require.NoError(t, exec.Command("ifconfig", feth, "inet", "198.51.100.5/24", "up").Run())
|
||||
|
||||
// Static and cloning with no gateway, like the lan routes configd installs. Named by the feth's address, macOS 27
|
||||
// refuses one named by the feth itself
|
||||
cidr := "10.251.2.0/24"
|
||||
routeCmd(t, "add", cidr, "-interface", "198.51.100.5")
|
||||
cleanupRoute(t, cidr)
|
||||
ifc, err := net.InterfaceByName(feth)
|
||||
require.NoError(t, err)
|
||||
|
||||
tn, _, _ := newRouteTestTun(t, 0, cidr)
|
||||
require.Equal(t, ifc.Index, routeVia(t, cidr))
|
||||
|
||||
// Losing the address first leaves the route, the reconcile finds it still held
|
||||
require.NoError(t, exec.Command("ifconfig", feth, "inet", "198.51.100.5", "-alias").Run())
|
||||
time.Sleep(2 * routeRetryDelay)
|
||||
require.Equal(t, ifc.Index, routeVia(t, cidr))
|
||||
|
||||
// Only RTM_IFINFO says the interface went, its route goes with no message of its own
|
||||
require.NoError(t, exec.Command("ifconfig", feth, "destroy").Run())
|
||||
assert.Eventually(t, func() bool { return routeVia(t, cidr) == tn.linkAddr.Load().Index }, 5*time.Second, 50*time.Millisecond)
|
||||
}
|
||||
|
||||
// The routing socket drops what doesn't fit its buffer without a word, the sweep finds what it missed
|
||||
func TestTunSweepAddsRouteTheWatcherMissed(t *testing.T) {
|
||||
cidr := "10.251.5.0/24"
|
||||
routeThroughLo0(t, cidr)
|
||||
tn, _, _ := newRouteTestTun(t, 200*time.Millisecond, cidr)
|
||||
|
||||
tn.routesMu.Lock()
|
||||
require.NoError(t, tn.routeWatch.Close())
|
||||
tn.routesMu.Unlock()
|
||||
|
||||
routeCmd(t, "delete", cidr)
|
||||
assert.Eventually(t, func() bool { return routeVia(t, cidr) == tn.linkAddr.Load().Index }, 5*time.Second, 50*time.Millisecond)
|
||||
}
|
||||
|
||||
// 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{
|
||||
|
||||
@@ -832,6 +832,11 @@ func (t *tun) updateRoutes(r netlink.RouteUpdate) {
|
||||
t.routeTree.Store(newTree)
|
||||
}
|
||||
|
||||
// Shutdown wakes the tun readers without releasing their fds, Close releases them
|
||||
func (t *tun) Shutdown() error {
|
||||
return t.readers.Shutdown()
|
||||
}
|
||||
|
||||
func (t *tun) Close() error {
|
||||
t.closeLock.Lock()
|
||||
defer t.closeLock.Unlock()
|
||||
|
||||
@@ -0,0 +1,451 @@
|
||||
//go:build !ios && !e2e_testing
|
||||
|
||||
package overlay
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net"
|
||||
"net/netip"
|
||||
"os"
|
||||
"strconv"
|
||||
"sync/atomic"
|
||||
"time"
|
||||
"unsafe"
|
||||
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/util"
|
||||
netroute "golang.org/x/net/route"
|
||||
"golang.org/x/sys/unix"
|
||||
)
|
||||
|
||||
// Darwin has no route metrics, the routing table holds one unscoped route per prefix. When another interface already
|
||||
// routes an unsafe_route's prefix, like the lan we started on, theirs stays and ours is added once theirs is removed.
|
||||
// Our own route removed by someone else, with nothing in its place, was removed on purpose and stays gone until a reload
|
||||
// or until another interface takes the prefix, after which ours follows theirs like any other.
|
||||
|
||||
const (
|
||||
// routeRetryDelay is how long the system routing table must be quiet before we judge who holds a prefix. configd
|
||||
// replaces a route by deleting and adding, looking in between would find the prefix free
|
||||
routeRetryDelay = time.Second
|
||||
|
||||
// routeSweepInterval bounds how long a freed unsafe_route can go unnoticed. The routing socket drops messages that
|
||||
// don't fit its receive buffer without telling the reader, and detaching an interface deletes its routes without
|
||||
// a message for each
|
||||
routeSweepInterval = time.Minute
|
||||
|
||||
// routeSocketRcvBuf is well past the 8KiB default, which a burst of neighbor routes expiring can fill
|
||||
routeSocketRcvBuf = 1 << 20
|
||||
)
|
||||
|
||||
type routeStateKind int
|
||||
|
||||
const (
|
||||
routeUnknown routeStateKind = iota
|
||||
// routeInstalled is our route holding the prefix
|
||||
routeInstalled
|
||||
// routeYielded is another interface holding the prefix, ours is added once it lets go
|
||||
routeYielded
|
||||
// routeRemoved is our route deleted by someone else with nothing in its place, it is left alone until a reload or
|
||||
// another interface takes the prefix
|
||||
routeRemoved
|
||||
// routeFailed is adding our route failing for some other reason, it is retried
|
||||
routeFailed
|
||||
)
|
||||
|
||||
type routeState struct {
|
||||
kind routeStateKind
|
||||
// holder is the index of the interface holding the prefix when kind is routeYielded
|
||||
holder int
|
||||
}
|
||||
|
||||
// routeMover is the process that last added, changed or deleted a route for an unsafe_route's prefix, for logs. Its name
|
||||
// is looked up as the message arrives, route(8) has exited by the time the table settles
|
||||
type routeMover struct {
|
||||
pid int32
|
||||
name string
|
||||
}
|
||||
|
||||
// logArgs appends m to a log line's args, when we know who it was
|
||||
func (m routeMover) logArgs(args ...any) []any {
|
||||
if m.pid == 0 {
|
||||
return args
|
||||
}
|
||||
args = append(args, "pid", m.pid)
|
||||
if m.name != "" {
|
||||
args = append(args, "process", m.name)
|
||||
}
|
||||
return args
|
||||
}
|
||||
|
||||
// processName is the name of process pid, truncated to 16 bytes, or empty when it has already exited
|
||||
func processName(pid int32) string {
|
||||
kp, err := unix.SysctlKinfoProc("kern.proc.pid", int(pid))
|
||||
if err != nil || kp.Proc.P_pid != pid {
|
||||
return ""
|
||||
}
|
||||
return unix.ByteSliceToString(kp.Proc.P_comm[:])
|
||||
}
|
||||
|
||||
// installRoutes returns the routes we put in the system routing table, one per prefix
|
||||
func installRoutes(routes []Route) []Route {
|
||||
seen := make(map[netip.Prefix]struct{}, len(routes))
|
||||
var out []Route
|
||||
for _, r := range routes {
|
||||
if len(r.Via) == 0 || !r.Install {
|
||||
// We don't allow route MTUs so only install routes with a via
|
||||
continue
|
||||
}
|
||||
p := r.Cidr.Masked()
|
||||
if _, ok := seen[p]; ok {
|
||||
continue
|
||||
}
|
||||
seen[p] = struct{}{}
|
||||
out = append(out, r)
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
// addRoutes puts every unsafe_route in the system routing table, including ones someone deleted, unless another
|
||||
// interface holds its prefix. It runs on start and on every reload.
|
||||
func (t *tun) addRoutes(logErrors bool, rl *config.Reload) error {
|
||||
// The route tree is still ours, the system routing table is not
|
||||
if t.hostOwned {
|
||||
return nil
|
||||
}
|
||||
|
||||
t.routesMu.Lock()
|
||||
defer t.routesMu.Unlock()
|
||||
|
||||
// Activate hasn't run yet, it will install the routes
|
||||
linkAddr := t.linkAddr.Load()
|
||||
if linkAddr == nil || t.closed {
|
||||
return nil
|
||||
}
|
||||
|
||||
var msgs []netroute.Message
|
||||
var msgsErr error
|
||||
fetched := false
|
||||
states := make(map[netip.Prefix]routeState)
|
||||
for _, r := range installRoutes(*t.Routes.Load()) {
|
||||
p := r.Cidr.Masked()
|
||||
prev := t.routeStates[p]
|
||||
|
||||
err := addRoute(p, linkAddr)
|
||||
if err == nil {
|
||||
t.l.Info("Added route", "route", r)
|
||||
states[p] = routeState{kind: routeInstalled}
|
||||
continue
|
||||
}
|
||||
|
||||
if !errors.Is(err, unix.EEXIST) {
|
||||
retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
|
||||
if !logErrors {
|
||||
return retErr
|
||||
}
|
||||
retErr.Log(t.l)
|
||||
rl.Failed()
|
||||
states[p] = routeState{kind: routeFailed}
|
||||
continue
|
||||
}
|
||||
|
||||
// Every route we added already exists on a reload, only warn about someone else's
|
||||
if !fetched {
|
||||
msgs, msgsErr = fetchRoutes()
|
||||
fetched = true
|
||||
}
|
||||
if msgsErr != nil {
|
||||
t.l.Warn("unable to add unsafe_route, a route already exists but its interface could not be determined", "route", r.Cidr, "error", msgsErr)
|
||||
states[p] = prev
|
||||
continue
|
||||
}
|
||||
|
||||
switch holder := routeInterfaceIn(msgs, p); holder {
|
||||
case linkAddr.Index:
|
||||
states[p] = routeState{kind: routeInstalled}
|
||||
case 0:
|
||||
// Removed since the add, the watcher will see to it
|
||||
states[p] = prev
|
||||
default:
|
||||
if prev.kind != routeYielded || prev.holder != holder {
|
||||
t.l.Warn("unable to add unsafe_route, the destination is already routed through another interface, it will be added once that route is removed", "route", r.Cidr, "interface", interfaceName(holder))
|
||||
}
|
||||
states[p] = routeState{kind: routeYielded, holder: holder}
|
||||
}
|
||||
}
|
||||
|
||||
t.routeStates = states
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tun) removeRoutes(routes []Route, rl *config.Reload) error {
|
||||
if t.hostOwned {
|
||||
return nil
|
||||
}
|
||||
|
||||
t.routesMu.Lock()
|
||||
defer t.routesMu.Unlock()
|
||||
|
||||
linkAddr := t.linkAddr.Load()
|
||||
if linkAddr == nil || t.closed {
|
||||
return nil
|
||||
}
|
||||
|
||||
// The kernel deletes a route by its prefix alone, whichever interface holds it. Only delete the ones that are ours
|
||||
msgs, err := fetchRoutes()
|
||||
if err != nil {
|
||||
var left []netip.Prefix
|
||||
for _, r := range installRoutes(routes) {
|
||||
left = append(left, r.Cidr)
|
||||
}
|
||||
return fmt.Errorf("failed to read the system routing table, leaving routes %v installed: %w", left, err)
|
||||
}
|
||||
|
||||
for _, r := range installRoutes(routes) {
|
||||
p := r.Cidr.Masked()
|
||||
// Whatever happens next, the prefix is no longer one we know about
|
||||
delete(t.routeStates, p)
|
||||
if routeInterfaceIn(msgs, p) != linkAddr.Index {
|
||||
continue
|
||||
}
|
||||
|
||||
err = delRoute(p, linkAddr)
|
||||
if errors.Is(err, unix.ESRCH) {
|
||||
// Already gone, which is what we wanted
|
||||
t.l.Info("Route was already removed", "route", r)
|
||||
} else if err != nil {
|
||||
t.l.Error("Failed to remove route", "error", err, "route", r)
|
||||
rl.Failed()
|
||||
} else {
|
||||
t.l.Info("Removed route", "route", r)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// reconcileRoutes brings the unsafe_routes in line with who holds their prefix now. It is quiet unless something
|
||||
// changed since it last looked, it runs every routeSweepEvery.
|
||||
func (t *tun) reconcileRoutes() {
|
||||
t.routesMu.Lock()
|
||||
defer t.routesMu.Unlock()
|
||||
|
||||
linkAddr := t.linkAddr.Load()
|
||||
if linkAddr == nil || t.closed {
|
||||
return
|
||||
}
|
||||
|
||||
t.routeMoversMu.Lock()
|
||||
movers := t.routeMovers
|
||||
t.routeMovers = nil
|
||||
t.routeMoversMu.Unlock()
|
||||
|
||||
msgs, err := fetchRoutes()
|
||||
if err != nil {
|
||||
t.l.Error("Failed to read the system routing table", "error", err)
|
||||
return
|
||||
}
|
||||
|
||||
states := make(map[netip.Prefix]routeState)
|
||||
for _, r := range installRoutes(*t.Routes.Load()) {
|
||||
p := r.Cidr.Masked()
|
||||
prev := t.routeStates[p]
|
||||
by := movers[p]
|
||||
|
||||
holder := routeInterfaceIn(msgs, p)
|
||||
switch {
|
||||
case holder == linkAddr.Index:
|
||||
states[p] = routeState{kind: routeInstalled}
|
||||
|
||||
case holder != 0:
|
||||
// Another interface taking a prefix we left alone puts ours back in line behind theirs
|
||||
if prev.kind != routeYielded || prev.holder != holder {
|
||||
t.l.Info("unsafe_route is routed through another interface, it will be added back when that route is removed", by.logArgs("route", r.Cidr, "interface", interfaceName(holder))...)
|
||||
}
|
||||
states[p] = routeState{kind: routeYielded, holder: holder}
|
||||
|
||||
case prev.kind == routeInstalled:
|
||||
t.l.Warn("unsafe_route was removed outside nebula, leaving it until a reload or another interface takes its destination", by.logArgs("route", r.Cidr)...)
|
||||
states[p] = routeState{kind: routeRemoved}
|
||||
|
||||
case prev.kind == routeRemoved:
|
||||
states[p] = prev
|
||||
|
||||
default:
|
||||
err := addRoute(p, linkAddr)
|
||||
switch {
|
||||
case err == nil:
|
||||
if prev.kind == routeYielded {
|
||||
t.l.Info("unsafe_route's destination is free again, added it", by.logArgs("route", r)...)
|
||||
} else {
|
||||
t.l.Info("Added route", "route", r)
|
||||
}
|
||||
states[p] = routeState{kind: routeInstalled}
|
||||
case errors.Is(err, unix.EEXIST):
|
||||
// Taken since the fetch, the next look will see by whom
|
||||
states[p] = prev
|
||||
default:
|
||||
if prev.kind != routeFailed {
|
||||
util.NewContextualError("Failed to add route", map[string]any{"route": r}, err).Log(t.l)
|
||||
}
|
||||
states[p] = routeState{kind: routeFailed}
|
||||
}
|
||||
}
|
||||
}
|
||||
t.routeStates = states
|
||||
}
|
||||
|
||||
// startRouteWatch starts reconciling the unsafe_routes, every routeSweepEvery and, when watch isn't nil, once the
|
||||
// routing table settles after anything that may have moved a prefix
|
||||
func (t *tun) startRouteWatch(watch *os.File) {
|
||||
t.routesMu.Lock()
|
||||
defer t.routesMu.Unlock()
|
||||
if t.closed {
|
||||
if watch != nil {
|
||||
_ = watch.Close()
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
t.routeSweep = time.AfterFunc(t.routeSweepEvery, t.sweepRoutes)
|
||||
if watch != nil {
|
||||
t.routeWatch = watch
|
||||
go t.watchRoutes(watch)
|
||||
}
|
||||
}
|
||||
|
||||
func (t *tun) sweepRoutes() {
|
||||
// A table still changing gets reconciled once it settles
|
||||
if time.Since(time.Unix(0, t.lastRouteEvent.Load())) >= routeRetryDelay {
|
||||
t.reconcileRoutes()
|
||||
}
|
||||
|
||||
t.routesMu.Lock()
|
||||
defer t.routesMu.Unlock()
|
||||
if !t.closed {
|
||||
t.routeSweep.Reset(t.routeSweepEvery)
|
||||
}
|
||||
}
|
||||
|
||||
func openRouteSocket() (*os.File, error) {
|
||||
fd, err := unix.Socket(unix.AF_ROUTE, unix.SOCK_RAW, unix.AF_UNSPEC)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to create AF_ROUTE socket: %w", err)
|
||||
}
|
||||
// Fewer drops, the sweep catches the rest
|
||||
_ = unix.SetsockoptInt(fd, unix.SOL_SOCKET, unix.SO_RCVBUF, routeSocketRcvBuf)
|
||||
// Non-blocking puts it on the poller, so Close interrupts a Read
|
||||
if err = unix.SetNonblock(fd, true); err != nil {
|
||||
_ = unix.Close(fd)
|
||||
return nil, fmt.Errorf("failed to set the AF_ROUTE socket to non-blocking mode: %w", err)
|
||||
}
|
||||
return os.NewFile(uintptr(fd), "route"), nil
|
||||
}
|
||||
|
||||
// watchRoutes reconciles the unsafe_routes once the routing table has been quiet for routeRetryDelay after a message
|
||||
// that may have moved a prefix. A table that keeps changing is reconciled every routeSweepEvery regardless.
|
||||
func (t *tun) watchRoutes(f *os.File) {
|
||||
var reconciled atomic.Int64
|
||||
settle := time.AfterFunc(time.Hour, func() {
|
||||
reconciled.Store(time.Now().UnixNano())
|
||||
t.reconcileRoutes()
|
||||
})
|
||||
settle.Stop()
|
||||
defer settle.Stop()
|
||||
|
||||
var burst time.Time
|
||||
self := int32(os.Getpid())
|
||||
b := make([]byte, os.Getpagesize())
|
||||
for {
|
||||
n, err := f.Read(b)
|
||||
if err != nil {
|
||||
if !errors.Is(err, os.ErrClosed) {
|
||||
t.l.Error("Stopped watching the system routing table, unsafe_routes held by another interface are only retried every minute", "error", err)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
moved, p, pid := routesMayHaveMoved(b[:n], *t.Routes.Load())
|
||||
if !moved {
|
||||
continue
|
||||
}
|
||||
// Our own are already in routeStates
|
||||
if p.IsValid() && pid != self {
|
||||
t.routeMoversMu.Lock()
|
||||
if t.routeMovers == nil {
|
||||
t.routeMovers = make(map[netip.Prefix]routeMover)
|
||||
}
|
||||
t.routeMovers[p] = routeMover{pid: pid, name: processName(pid)}
|
||||
t.routeMoversMu.Unlock()
|
||||
}
|
||||
|
||||
now := time.Now()
|
||||
t.lastRouteEvent.Store(now.UnixNano())
|
||||
if burst.IsZero() || reconciled.Load() >= burst.UnixNano() {
|
||||
burst = now
|
||||
}
|
||||
settle.Reset(max(0, min(routeRetryDelay, time.Until(burst.Add(t.routeSweepEvery)))))
|
||||
}
|
||||
}
|
||||
|
||||
// routesMayHaveMoved reports whether b, one routing socket message, may have freed a prefix one of routes installs or
|
||||
// handed it to another interface. That's a route for it added, changed or removed, or an interface that lost an address
|
||||
// or changed state, since detaching an interface deletes its routes without a message of their own. The header is read
|
||||
// directly, x/net/route skips the RTM_IFINFO the socket sends, which has no interface address, and misreads the
|
||||
// unpadded sockaddrs in messages the kernel makes itself. A request naming one of the prefixes also returns that prefix
|
||||
// and the pid of the process that made it.
|
||||
func routesMayHaveMoved(b []byte, routes []Route) (moved bool, p netip.Prefix, pid int32) {
|
||||
if len(b) < 4 {
|
||||
return false, p, 0
|
||||
}
|
||||
switch int(b[3]) {
|
||||
case unix.RTM_IFINFO, unix.RTM_DELADDR:
|
||||
return true, p, 0
|
||||
case unix.RTM_ADD, unix.RTM_CHANGE, unix.RTM_DELETE:
|
||||
default:
|
||||
return false, p, 0
|
||||
}
|
||||
|
||||
if len(b) < unix.SizeofRtMsghdr {
|
||||
return false, p, 0
|
||||
}
|
||||
hdr := (*unix.RtMsghdr)(unsafe.Pointer(&b[0]))
|
||||
// A failed request is reported too, and a scoped route never held the prefix
|
||||
if hdr.Errno != 0 || hdr.Flags&unix.RTF_IFSCOPE != 0 {
|
||||
return false, p, 0
|
||||
}
|
||||
|
||||
if hdr.Pid == 0 {
|
||||
// The kernel's own, which x/net/route can't parse. Neighbors coming and going are host routes, anything else
|
||||
// could be holding a prefix
|
||||
return hdr.Flags&(unix.RTF_HOST|unix.RTF_LLINFO) == 0, p, 0
|
||||
}
|
||||
|
||||
// Replies to a request carry the requester's padded sockaddrs
|
||||
msgs, err := netroute.ParseRIB(unix.NET_RT_DUMP, b)
|
||||
if err != nil || len(msgs) != 1 {
|
||||
return false, p, 0
|
||||
}
|
||||
m, ok := msgs[0].(*netroute.RouteMessage)
|
||||
if !ok || len(m.Addrs) <= unix.RTAX_NETMASK {
|
||||
return false, p, 0
|
||||
}
|
||||
p, ok = routePrefix(m.Addrs[unix.RTAX_DST], m.Addrs[unix.RTAX_NETMASK])
|
||||
if !ok {
|
||||
return false, netip.Prefix{}, 0
|
||||
}
|
||||
p = p.Masked()
|
||||
for _, r := range installRoutes(routes) {
|
||||
if r.Cidr.Masked() == p {
|
||||
return true, p, hdr.Pid
|
||||
}
|
||||
}
|
||||
return false, netip.Prefix{}, 0
|
||||
}
|
||||
|
||||
// interfaceName is the name of the interface with index i, for logs
|
||||
func interfaceName(i int) string {
|
||||
if ifc, err := net.InterfaceByIndex(i); err == nil {
|
||||
return ifc.Name
|
||||
}
|
||||
return strconv.Itoa(i)
|
||||
}
|
||||
@@ -528,6 +528,10 @@ func (rm *relayManager) handleCreateRelayRequest(v cert.Version, h *HostInfo, f
|
||||
if !rm.GetAmRelay() {
|
||||
return
|
||||
}
|
||||
if !slices.Contains(h.vpnAddrs, from) {
|
||||
logMsg.Info("Discarding relay request where relayFrom is not the sending peer")
|
||||
return
|
||||
}
|
||||
peer := rm.hostmap.QueryVpnAddr(target)
|
||||
if peer == nil {
|
||||
// Try to establish a connection to this host. If we get a future relay request,
|
||||
|
||||
@@ -7,8 +7,10 @@ import (
|
||||
"testing"
|
||||
|
||||
"github.com/gaissmai/bart"
|
||||
"github.com/slackhq/nebula/cert"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// TestStartRelaysLogDedupe verifies that repeated attempts with the same relay set drop the log
|
||||
@@ -95,3 +97,58 @@ func TestStartRelaysLogDedupe(t *testing.T) {
|
||||
assert.NotContains(t, buf.String(), msg, "should not log when we shortcut out")
|
||||
})
|
||||
}
|
||||
|
||||
// TestHandleCreateRelayRequestRejectsSpoofedFrom verifies that a relay only forwards a CreateRelayRequest
|
||||
// when relayFrom is the peer that sent it. Otherwise any peer could reset another host's established
|
||||
// relay back to Requested, or allocate unbounded relay entries on the target's hostinfo.
|
||||
func TestHandleCreateRelayRequestRejectsSpoofedFrom(t *testing.T) {
|
||||
l := test.NewLogger()
|
||||
relayAddr := netip.MustParseAddr("10.128.0.128")
|
||||
malloryAddr := netip.MustParseAddr("10.128.0.3")
|
||||
victimAddr := netip.MustParseAddr("10.128.0.1")
|
||||
targetAddr := netip.MustParseAddr("10.128.0.2")
|
||||
|
||||
addrTable := new(bart.Lite)
|
||||
addrTable.Insert(netip.PrefixFrom(relayAddr, relayAddr.BitLen()))
|
||||
hm := newHostMap(l)
|
||||
f := &Interface{myVpnAddrsTable: addrTable, hostMap: hm}
|
||||
rm := &relayManager{l: l, hostmap: hm}
|
||||
rm.amRelay.Store(true)
|
||||
|
||||
newRelayState := func() RelayState {
|
||||
return RelayState{relayForByAddr: map[netip.Addr]*Relay{}, relayForByIdx: map[uint32]*Relay{}}
|
||||
}
|
||||
mallory := &HostInfo{vpnAddrs: []netip.Addr{malloryAddr}, localIndexId: 1, relayState: newRelayState()}
|
||||
target := &HostInfo{
|
||||
vpnAddrs: []netip.Addr{targetAddr},
|
||||
localIndexId: 2,
|
||||
remotes: NewRemoteList([]netip.Addr{targetAddr}, nil),
|
||||
relayState: newRelayState(),
|
||||
}
|
||||
target.SetRemote(netip.MustParseAddrPort("192.0.2.2:4242"))
|
||||
hm.unlockedAddHostInfo(mallory, f)
|
||||
hm.unlockedAddHostInfo(target, f)
|
||||
|
||||
// The victim already has a working relay to the target through us.
|
||||
_, err := AddRelay(l, target, hm, victimAddr, nil, ForwardingType, Established)
|
||||
require.NoError(t, err)
|
||||
relaysBefore := len(hm.Relays)
|
||||
|
||||
for i := range 10 {
|
||||
spoofed := netip.AddrFrom4([4]byte{10, 128, 1, byte(i)})
|
||||
for _, from := range []netip.Addr{victimAddr, spoofed} {
|
||||
rm.handleCreateRelayRequest(cert.Version2, mallory, f, &NebulaControl{
|
||||
Type: NebulaControl_CreateRelayRequest,
|
||||
InitiatorRelayIndex: uint32(100 + i),
|
||||
RelayFromAddr: netAddrToProtoAddr(from),
|
||||
RelayToAddr: netAddrToProtoAddr(targetAddr),
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
r, ok := target.relayState.QueryRelayForByIp(victimAddr)
|
||||
require.True(t, ok)
|
||||
assert.Equal(t, Established, r.State, "victim's relay must not be reset by a request from another peer")
|
||||
assert.Len(t, hm.Relays, relaysBefore, "spoofed requests must not allocate relay entries")
|
||||
assert.Empty(t, mallory.relayState.CopyAllRelayFor(), "spoofed requests must not create state on the sender")
|
||||
}
|
||||
+12
-4
@@ -460,10 +460,14 @@ func (r *RemoteList) unlockedSetV4(ownerVpnIp, vpnIp netip.Addr, to []*V4AddrPor
|
||||
// Reset the slice
|
||||
c.reported = c.reported[:0]
|
||||
|
||||
// We can't take their array but we can take their pointers
|
||||
for _, v := range to[:minInt(len(to), MaxRemotes)] {
|
||||
// We can't take their array but we can take their pointers.
|
||||
// Filter before capping so denied addrs do not crowd out allowed ones reported later in the list.
|
||||
for _, v := range to {
|
||||
if check(vpnIp, v) {
|
||||
c.reported = append(c.reported, v)
|
||||
if len(c.reported) == MaxRemotes {
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -508,10 +512,14 @@ func (r *RemoteList) unlockedSetV6(ownerVpnIp, vpnIp netip.Addr, to []*V6AddrPor
|
||||
// Reset the slice
|
||||
c.reported = c.reported[:0]
|
||||
|
||||
// We can't take their array but we can take their pointers
|
||||
for _, v := range to[:minInt(len(to), MaxRemotes)] {
|
||||
// We can't take their array but we can take their pointers.
|
||||
// Filter before capping so denied addrs do not crowd out allowed ones reported later in the list.
|
||||
for _, v := range to {
|
||||
if check(vpnIp, v) {
|
||||
c.reported = append(c.reported, v)
|
||||
if len(c.reported) == MaxRemotes {
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,6 +2,7 @@ package nebula
|
||||
|
||||
import (
|
||||
"encoding/binary"
|
||||
"fmt"
|
||||
"net/netip"
|
||||
"testing"
|
||||
|
||||
@@ -346,3 +347,38 @@ func newIp6AndPortFromString(s string) *V6AddrPort {
|
||||
Port: uint32(a.Port()),
|
||||
}
|
||||
}
|
||||
|
||||
func TestRemoteList_SetFiltersBeforeCap(t *testing.T) {
|
||||
owner := netip.MustParseAddr("0.0.0.0")
|
||||
rl := NewRemoteList([]netip.Addr{owner}, nil)
|
||||
|
||||
// MaxRemotes denied addrs first, then the only allowed one, then enough allowed to exceed the cap
|
||||
var v4 []*V4AddrPort
|
||||
for i := 0; i < MaxRemotes; i++ {
|
||||
v4 = append(v4, newIp4AndPortFromString(fmt.Sprintf("172.17.0.%d:4242", i+1)))
|
||||
}
|
||||
for i := 0; i < MaxRemotes+1; i++ {
|
||||
v4 = append(v4, newIp4AndPortFromString(fmt.Sprintf("70.199.182.%d:4242", i+1)))
|
||||
}
|
||||
rl.unlockedSetV4(owner, owner, v4, func(_ netip.Addr, a *V4AddrPort) bool {
|
||||
return protoV4AddrPortToNetAddrPort(a).Addr().As4()[0] != 172
|
||||
})
|
||||
|
||||
var v6 []*V6AddrPort
|
||||
for i := 0; i < MaxRemotes; i++ {
|
||||
v6 = append(v6, newIp6AndPortFromString(fmt.Sprintf("[fd00::%d]:4242", i+1)))
|
||||
}
|
||||
for i := 0; i < MaxRemotes+1; i++ {
|
||||
v6 = append(v6, newIp6AndPortFromString(fmt.Sprintf("[2001:db8::%d]:4242", i+1)))
|
||||
}
|
||||
rl.unlockedSetV6(owner, owner, v6, func(_ netip.Addr, a *V6AddrPort) bool {
|
||||
return protoV6AddrPortToNetAddrPort(a).Addr().As16()[0] != 0xfd
|
||||
})
|
||||
|
||||
rl.Rebuild([]netip.Prefix{})
|
||||
assert.Len(t, rl.addrs, MaxRemotes*2)
|
||||
for _, a := range rl.addrs {
|
||||
assert.NotEqual(t, byte(172), a.Addr().As16()[12], "denied v4 addr %v was kept", a)
|
||||
assert.NotEqual(t, byte(0xfd), a.Addr().As16()[0], "denied v6 addr %v was kept", a)
|
||||
}
|
||||
}
|
||||
@@ -1,59 +1,17 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"flag"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"maps"
|
||||
"net"
|
||||
"net/netip"
|
||||
"os"
|
||||
"slices"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/header"
|
||||
"github.com/slackhq/nebula/logging"
|
||||
"github.com/slackhq/nebula/sshd"
|
||||
)
|
||||
|
||||
type sshListHostMapFlags struct {
|
||||
Json bool
|
||||
Pretty bool
|
||||
ByIndex bool
|
||||
}
|
||||
|
||||
type sshPrintCertFlags struct {
|
||||
Json bool
|
||||
Pretty bool
|
||||
Raw bool
|
||||
}
|
||||
|
||||
type sshPrintTunnelFlags struct {
|
||||
Pretty bool
|
||||
}
|
||||
|
||||
type sshChangeRemoteFlags struct {
|
||||
Address string
|
||||
}
|
||||
|
||||
type sshCloseTunnelFlags struct {
|
||||
LocalOnly bool
|
||||
}
|
||||
|
||||
type sshCreateTunnelFlags struct {
|
||||
Address string
|
||||
}
|
||||
|
||||
type sshDeviceInfoFlags struct {
|
||||
Json bool
|
||||
Pretty bool
|
||||
}
|
||||
|
||||
func wireSSHReload(l *slog.Logger, ssh *sshd.SSHServer, c *config.C) {
|
||||
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||
if c.GetBool("sshd.enabled", false) {
|
||||
@@ -227,704 +185,3 @@ func configSSH(l *slog.Logger, ssh *sshd.SSHServer, c *config.C, r *config.Reloa
|
||||
|
||||
return runner, nil
|
||||
}
|
||||
|
||||
func attachCommands(l *slog.Logger, c *config.C, ssh *sshd.SSHServer, f *Interface) {
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "list-hostmap",
|
||||
ShortDescription: "List all known previously connected hosts",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := sshListHostMapFlags{}
|
||||
fl.BoolVar(&s.Json, "json", false, "outputs as json with more information")
|
||||
fl.BoolVar(&s.Pretty, "pretty", false, "pretty prints json, assumes -json")
|
||||
fl.BoolVar(&s.ByIndex, "by-index", false, "gets all hosts in the hostmap from the index table")
|
||||
return fl, &s
|
||||
},
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshListHostMap(f.hostMap, fs, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "list-pending-hostmap",
|
||||
ShortDescription: "List all handshaking hosts",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := sshListHostMapFlags{}
|
||||
fl.BoolVar(&s.Json, "json", false, "outputs as json with more information")
|
||||
fl.BoolVar(&s.Pretty, "pretty", false, "pretty prints json, assumes -json")
|
||||
fl.BoolVar(&s.ByIndex, "by-index", false, "gets all hosts in the hostmap from the index table")
|
||||
return fl, &s
|
||||
},
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshListHostMap(f.handshakeManager, fs, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "list-lighthouse-addrmap",
|
||||
ShortDescription: "List all lighthouse map entries",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := sshListHostMapFlags{}
|
||||
fl.BoolVar(&s.Json, "json", false, "outputs as json with more information")
|
||||
fl.BoolVar(&s.Pretty, "pretty", false, "pretty prints json, assumes -json")
|
||||
return fl, &s
|
||||
},
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshListLighthouseMap(f.lightHouse, fs, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "reload",
|
||||
ShortDescription: "Reloads configuration from disk, same as sending HUP to the process",
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshReload(l, c, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "log-level",
|
||||
ShortDescription: "Gets or sets the current log level",
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshLogLevel(l, fs, a, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "log-format",
|
||||
ShortDescription: "Gets or sets the current log format",
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshLogFormat(l, fs, a, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "version",
|
||||
ShortDescription: "Prints the currently running version of nebula",
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshVersion(f, fs, a, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "device-info",
|
||||
ShortDescription: "Prints information about the network device.",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := sshDeviceInfoFlags{}
|
||||
fl.BoolVar(&s.Json, "json", false, "outputs as json with more information")
|
||||
fl.BoolVar(&s.Pretty, "pretty", false, "pretty prints json, assumes -json")
|
||||
return fl, &s
|
||||
},
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshDeviceInfo(f, fs, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "print-cert",
|
||||
ShortDescription: "Prints the current certificate being used or the certificate for the provided vpn addr",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := sshPrintCertFlags{}
|
||||
fl.BoolVar(&s.Json, "json", false, "outputs as json")
|
||||
fl.BoolVar(&s.Pretty, "pretty", false, "pretty prints json, assumes -json")
|
||||
fl.BoolVar(&s.Raw, "raw", false, "raw prints the PEM encoded certificate, not compatible with -json or -pretty")
|
||||
return fl, &s
|
||||
},
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshPrintCert(f, fs, a, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "print-tunnel",
|
||||
ShortDescription: "Prints json details about a tunnel for the provided vpn addr",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := sshPrintTunnelFlags{}
|
||||
fl.BoolVar(&s.Pretty, "pretty", false, "pretty prints json")
|
||||
return fl, &s
|
||||
},
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshPrintTunnel(f, fs, a, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "print-relays",
|
||||
ShortDescription: "Prints json details about all relay info",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := sshPrintTunnelFlags{}
|
||||
fl.BoolVar(&s.Pretty, "pretty", false, "pretty prints json")
|
||||
return fl, &s
|
||||
},
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshPrintRelays(f, fs, a, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "change-remote",
|
||||
ShortDescription: "Changes the remote address used in the tunnel for the provided vpn addr",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := sshChangeRemoteFlags{}
|
||||
fl.StringVar(&s.Address, "address", "", "The new remote address, ip:port")
|
||||
return fl, &s
|
||||
},
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshChangeRemote(f, fs, a, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "close-tunnel",
|
||||
ShortDescription: "Closes a tunnel for the provided vpn addr",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := sshCloseTunnelFlags{}
|
||||
fl.BoolVar(&s.LocalOnly, "local-only", false, "Disables notifying the remote that the tunnel is shutting down")
|
||||
return fl, &s
|
||||
},
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshCloseTunnel(f, fs, a, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "create-tunnel",
|
||||
ShortDescription: "Creates a tunnel for the provided vpn address",
|
||||
Help: "The lighthouses will be queried for real addresses but you can provide one as well.",
|
||||
Flags: func() (*flag.FlagSet, any) {
|
||||
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
s := sshCreateTunnelFlags{}
|
||||
fl.StringVar(&s.Address, "address", "", "Optionally provide a real remote address, ip:port ")
|
||||
return fl, &s
|
||||
},
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshCreateTunnel(f, fs, a, w)
|
||||
},
|
||||
})
|
||||
|
||||
ssh.RegisterCommand(&sshd.Command{
|
||||
Name: "query-lighthouse",
|
||||
ShortDescription: "Query the lighthouses for the provided vpn address",
|
||||
Help: "This command is asynchronous. Only currently known udp addresses will be printed.",
|
||||
Callback: func(fs any, a []string, w sshd.StringWriter) error {
|
||||
return sshQueryLighthouse(f, fs, a, w)
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
func sshListHostMap(hl controlHostLister, a any, w sshd.StringWriter) error {
|
||||
fs, ok := a.(*sshListHostMapFlags)
|
||||
if !ok {
|
||||
return nil
|
||||
}
|
||||
|
||||
var hm []ControlHostInfo
|
||||
if fs.ByIndex {
|
||||
hm = listHostMapIndexes(hl)
|
||||
} else {
|
||||
hm = listHostMapHosts(hl)
|
||||
}
|
||||
|
||||
sort.Slice(hm, func(i, j int) bool {
|
||||
return hm[i].VpnAddrs[0].Compare(hm[j].VpnAddrs[0]) < 0
|
||||
})
|
||||
|
||||
if fs.Json || fs.Pretty {
|
||||
js := json.NewEncoder(w.GetWriter())
|
||||
if fs.Pretty {
|
||||
js.SetIndent("", " ")
|
||||
}
|
||||
|
||||
err := js.Encode(hm)
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
} else {
|
||||
for _, v := range hm {
|
||||
err := w.WriteLine(fmt.Sprintf("%s: %s", v.VpnAddrs, v.RemoteAddrs))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func sshListLighthouseMap(lightHouse *LightHouse, a any, w sshd.StringWriter) error {
|
||||
fs, ok := a.(*sshListHostMapFlags)
|
||||
if !ok {
|
||||
return nil
|
||||
}
|
||||
|
||||
type lighthouseInfo struct {
|
||||
VpnAddr string `json:"vpnAddr"`
|
||||
Addrs *CacheMap `json:"addrs"`
|
||||
}
|
||||
|
||||
lightHouse.RLock()
|
||||
addrMap := make([]lighthouseInfo, len(lightHouse.addrMap))
|
||||
x := 0
|
||||
for k, v := range lightHouse.addrMap {
|
||||
addrMap[x] = lighthouseInfo{
|
||||
VpnAddr: k.String(),
|
||||
Addrs: v.CopyCache(),
|
||||
}
|
||||
x++
|
||||
}
|
||||
lightHouse.RUnlock()
|
||||
|
||||
sort.Slice(addrMap, func(i, j int) bool {
|
||||
return strings.Compare(addrMap[i].VpnAddr, addrMap[j].VpnAddr) < 0
|
||||
})
|
||||
|
||||
if fs.Json || fs.Pretty {
|
||||
js := json.NewEncoder(w.GetWriter())
|
||||
if fs.Pretty {
|
||||
js.SetIndent("", " ")
|
||||
}
|
||||
|
||||
err := js.Encode(addrMap)
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
} else {
|
||||
for _, v := range addrMap {
|
||||
b, err := json.Marshal(v.Addrs)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
err = w.WriteLine(fmt.Sprintf("%s: %s", v.VpnAddr, string(b)))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func sshVersion(ifce *Interface, fs any, a []string, w sshd.StringWriter) error {
|
||||
return w.WriteLine(fmt.Sprintf("%s", ifce.version))
|
||||
}
|
||||
|
||||
func sshQueryLighthouse(ifce *Interface, fs any, a []string, w sshd.StringWriter) error {
|
||||
if len(a) == 0 {
|
||||
return w.WriteLine("No vpn address was provided")
|
||||
}
|
||||
|
||||
vpnAddr, err := netip.ParseAddr(a[0])
|
||||
if err != nil {
|
||||
return w.WriteLine(fmt.Sprintf("The provided vpn address could not be parsed: %s", a[0]))
|
||||
}
|
||||
|
||||
if !vpnAddr.IsValid() {
|
||||
return w.WriteLine(fmt.Sprintf("The provided vpn address could not be parsed: %s", a[0]))
|
||||
}
|
||||
|
||||
var cm *CacheMap
|
||||
rl := ifce.lightHouse.Query(vpnAddr)
|
||||
if rl != nil {
|
||||
cm = rl.CopyCache()
|
||||
}
|
||||
return json.NewEncoder(w.GetWriter()).Encode(cm)
|
||||
}
|
||||
|
||||
func sshCloseTunnel(ifce *Interface, fs any, a []string, w sshd.StringWriter) error {
|
||||
flags, ok := fs.(*sshCloseTunnelFlags)
|
||||
if !ok {
|
||||
return nil
|
||||
}
|
||||
|
||||
if len(a) == 0 {
|
||||
return w.WriteLine("No vpn address was provided")
|
||||
}
|
||||
|
||||
vpnAddr, err := netip.ParseAddr(a[0])
|
||||
if err != nil {
|
||||
return w.WriteLine(fmt.Sprintf("The provided vpn address could not be parsed: %s", a[0]))
|
||||
}
|
||||
|
||||
if !vpnAddr.IsValid() {
|
||||
return w.WriteLine(fmt.Sprintf("The provided vpn address could not be parsed: %s", a[0]))
|
||||
}
|
||||
|
||||
hostInfo := ifce.hostMap.QueryVpnAddr(vpnAddr)
|
||||
if hostInfo == nil {
|
||||
return w.WriteLine(fmt.Sprintf("Could not find tunnel for vpn address: %v", a[0]))
|
||||
}
|
||||
|
||||
if !flags.LocalOnly {
|
||||
ifce.send(
|
||||
header.CloseTunnel,
|
||||
0,
|
||||
hostInfo.ConnectionState,
|
||||
hostInfo,
|
||||
[]byte{},
|
||||
make([]byte, 12, 12),
|
||||
make([]byte, mtu),
|
||||
)
|
||||
}
|
||||
|
||||
ifce.closeTunnel(hostInfo)
|
||||
return w.WriteLine("Closed")
|
||||
}
|
||||
|
||||
func sshCreateTunnel(ifce *Interface, fs any, a []string, w sshd.StringWriter) error {
|
||||
flags, ok := fs.(*sshCreateTunnelFlags)
|
||||
if !ok {
|
||||
return nil
|
||||
}
|
||||
|
||||
if len(a) == 0 {
|
||||
return w.WriteLine("No vpn address was provided")
|
||||
}
|
||||
|
||||
vpnAddr, err := netip.ParseAddr(a[0])
|
||||
if err != nil {
|
||||
return w.WriteLine(fmt.Sprintf("The provided vpn address could not be parsed: %s", a[0]))
|
||||
}
|
||||
|
||||
if !vpnAddr.IsValid() {
|
||||
return w.WriteLine(fmt.Sprintf("The provided vpn address could not be parsed: %s", a[0]))
|
||||
}
|
||||
|
||||
hostInfo := ifce.hostMap.QueryVpnAddr(vpnAddr)
|
||||
if hostInfo != nil {
|
||||
return w.WriteLine(fmt.Sprintf("Tunnel already exists"))
|
||||
}
|
||||
|
||||
hostInfo = ifce.handshakeManager.QueryVpnAddr(vpnAddr)
|
||||
if hostInfo != nil {
|
||||
return w.WriteLine(fmt.Sprintf("Tunnel already handshaking"))
|
||||
}
|
||||
|
||||
var addr netip.AddrPort
|
||||
if flags.Address != "" {
|
||||
addr, err = netip.ParseAddrPort(flags.Address)
|
||||
if err != nil {
|
||||
return w.WriteLine("Address could not be parsed")
|
||||
}
|
||||
}
|
||||
|
||||
// Set the remote from the callback, which StartHandshake runs under the handshake manager lock
|
||||
// before the hostinfo reaches the handshake loop or the static-host trigger, so the address is
|
||||
// in the RemoteList before the first handshake is sent.
|
||||
ifce.handshakeManager.StartHandshake(vpnAddr, func(hh *HandshakeHostInfo) {
|
||||
if addr.IsValid() {
|
||||
hh.hostinfo.SetRemote(addr)
|
||||
}
|
||||
})
|
||||
|
||||
return w.WriteLine("Created")
|
||||
}
|
||||
|
||||
func sshChangeRemote(ifce *Interface, fs any, a []string, w sshd.StringWriter) error {
|
||||
flags, ok := fs.(*sshChangeRemoteFlags)
|
||||
if !ok {
|
||||
return nil
|
||||
}
|
||||
|
||||
if len(a) == 0 {
|
||||
return w.WriteLine("No vpn address was provided")
|
||||
}
|
||||
|
||||
if flags.Address == "" {
|
||||
return w.WriteLine("No address was provided")
|
||||
}
|
||||
|
||||
addr, err := netip.ParseAddrPort(flags.Address)
|
||||
if err != nil {
|
||||
return w.WriteLine("Address could not be parsed")
|
||||
}
|
||||
|
||||
vpnAddr, err := netip.ParseAddr(a[0])
|
||||
if err != nil {
|
||||
return w.WriteLine(fmt.Sprintf("The provided vpn address could not be parsed: %s", a[0]))
|
||||
}
|
||||
|
||||
if !vpnAddr.IsValid() {
|
||||
return w.WriteLine(fmt.Sprintf("The provided vpn address could not be parsed: %s", a[0]))
|
||||
}
|
||||
|
||||
hostInfo := ifce.hostMap.QueryVpnAddr(vpnAddr)
|
||||
if hostInfo == nil {
|
||||
return w.WriteLine(fmt.Sprintf("Could not find tunnel for vpn address: %v", a[0]))
|
||||
}
|
||||
|
||||
hostInfo.SetRemote(addr)
|
||||
return w.WriteLine("Changed")
|
||||
}
|
||||
|
||||
func sshLogLevel(l *slog.Logger, fs any, a []string, w sshd.StringWriter) error {
|
||||
ctrl, ok := l.Handler().(interface {
|
||||
GetLevel() slog.Level
|
||||
SetLevel(slog.Level)
|
||||
})
|
||||
if !ok {
|
||||
return w.WriteLine("Log level is not reconfigurable on this logger")
|
||||
}
|
||||
|
||||
if len(a) == 0 {
|
||||
return w.WriteLine(fmt.Sprintf("Log level is: %s", logging.LevelName(ctrl.GetLevel())))
|
||||
}
|
||||
|
||||
level, err := logging.ParseLevel(strings.ToLower(a[0]))
|
||||
if err != nil {
|
||||
return w.WriteLine(fmt.Sprintf("Unknown log level %s. Possible log levels: trace, debug, info, warn, error", a))
|
||||
}
|
||||
|
||||
ctrl.SetLevel(level)
|
||||
return w.WriteLine(fmt.Sprintf("Log level is: %s", logging.LevelName(ctrl.GetLevel())))
|
||||
}
|
||||
|
||||
func sshLogFormat(l *slog.Logger, fs any, a []string, w sshd.StringWriter) error {
|
||||
ctrl, ok := l.Handler().(interface {
|
||||
GetFormat() string
|
||||
SetFormat(string) error
|
||||
})
|
||||
if !ok {
|
||||
return w.WriteLine("Log format is not reconfigurable on this logger")
|
||||
}
|
||||
|
||||
if len(a) == 0 {
|
||||
return w.WriteLine(fmt.Sprintf("Log format is: %s", ctrl.GetFormat()))
|
||||
}
|
||||
|
||||
if err := ctrl.SetFormat(strings.ToLower(a[0])); err != nil {
|
||||
return err
|
||||
}
|
||||
return w.WriteLine(fmt.Sprintf("Log format is: %s", ctrl.GetFormat()))
|
||||
}
|
||||
|
||||
func sshPrintCert(ifce *Interface, fs any, a []string, w sshd.StringWriter) error {
|
||||
args, ok := fs.(*sshPrintCertFlags)
|
||||
if !ok {
|
||||
return nil
|
||||
}
|
||||
|
||||
cert := ifce.pki.getCertState().GetDefaultCertificate()
|
||||
if len(a) > 0 {
|
||||
vpnAddr, err := netip.ParseAddr(a[0])
|
||||
if err != nil {
|
||||
return w.WriteLine(fmt.Sprintf("The provided vpn addr could not be parsed: %s", a[0]))
|
||||
}
|
||||
|
||||
if !vpnAddr.IsValid() {
|
||||
return w.WriteLine(fmt.Sprintf("The provided vpn addr could not be parsed: %s", a[0]))
|
||||
}
|
||||
|
||||
hostInfo := ifce.hostMap.QueryVpnAddr(vpnAddr)
|
||||
if hostInfo == nil {
|
||||
return w.WriteLine(fmt.Sprintf("Could not find tunnel for vpn addr: %v", a[0]))
|
||||
}
|
||||
|
||||
cert = hostInfo.GetCert().Certificate
|
||||
}
|
||||
|
||||
if args.Json || args.Pretty {
|
||||
b, err := cert.MarshalJSON()
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
if args.Pretty {
|
||||
buf := new(bytes.Buffer)
|
||||
err := json.Indent(buf, b, "", " ")
|
||||
b = buf.Bytes()
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
return w.WriteBytes(b)
|
||||
}
|
||||
|
||||
if args.Raw {
|
||||
b, err := cert.MarshalPEM()
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
return w.WriteBytes(b)
|
||||
}
|
||||
|
||||
return w.WriteLine(cert.String())
|
||||
}
|
||||
|
||||
func sshPrintRelays(ifce *Interface, fs any, a []string, w sshd.StringWriter) error {
|
||||
args, ok := fs.(*sshPrintTunnelFlags)
|
||||
if !ok {
|
||||
w.WriteLine(fmt.Sprintf("sshPrintRelays failed to convert args type"))
|
||||
return nil
|
||||
}
|
||||
|
||||
relays := map[uint32]*HostInfo{}
|
||||
ifce.hostMap.Lock()
|
||||
maps.Copy(relays, ifce.hostMap.Relays)
|
||||
ifce.hostMap.Unlock()
|
||||
|
||||
type RelayFor struct {
|
||||
Error error
|
||||
Type string
|
||||
State string
|
||||
PeerAddr netip.Addr
|
||||
LocalIndex uint32
|
||||
RemoteIndex uint32
|
||||
RelayedThrough []netip.Addr
|
||||
}
|
||||
|
||||
type RelayOutput struct {
|
||||
NebulaAddr netip.Addr
|
||||
RelayForAddrs []RelayFor
|
||||
}
|
||||
|
||||
type CmdOutput struct {
|
||||
Relays []*RelayOutput
|
||||
}
|
||||
|
||||
co := CmdOutput{}
|
||||
|
||||
enc := json.NewEncoder(w.GetWriter())
|
||||
|
||||
if args.Pretty {
|
||||
enc.SetIndent("", " ")
|
||||
}
|
||||
|
||||
for k, v := range relays {
|
||||
ro := RelayOutput{NebulaAddr: v.vpnAddrs[0]}
|
||||
co.Relays = append(co.Relays, &ro)
|
||||
relayHI := ifce.hostMap.QueryVpnAddr(v.vpnAddrs[0])
|
||||
if relayHI == nil {
|
||||
ro.RelayForAddrs = append(ro.RelayForAddrs, RelayFor{Error: errors.New("could not find hostinfo")})
|
||||
continue
|
||||
}
|
||||
for _, vpnAddr := range relayHI.relayState.CopyRelayForIps() {
|
||||
rf := RelayFor{Error: nil}
|
||||
r, ok := relayHI.relayState.GetRelayForByAddr(vpnAddr)
|
||||
if ok {
|
||||
t := ""
|
||||
switch r.Type {
|
||||
case ForwardingType:
|
||||
t = "forwarding"
|
||||
case TerminalType:
|
||||
t = "terminal"
|
||||
default:
|
||||
t = "unknown"
|
||||
}
|
||||
|
||||
s := ""
|
||||
switch r.State {
|
||||
case Requested:
|
||||
s = "requested"
|
||||
case Established:
|
||||
s = "established"
|
||||
default:
|
||||
s = "unknown"
|
||||
}
|
||||
|
||||
rf.LocalIndex = r.LocalIndex
|
||||
rf.RemoteIndex = r.RemoteIndex
|
||||
rf.PeerAddr = r.PeerAddr
|
||||
rf.Type = t
|
||||
rf.State = s
|
||||
if rf.LocalIndex != k {
|
||||
rf.Error = fmt.Errorf("hostmap LocalIndex '%v' does not match RelayState LocalIndex", k)
|
||||
}
|
||||
}
|
||||
relayedHI := ifce.hostMap.QueryVpnAddr(vpnAddr)
|
||||
if relayedHI != nil {
|
||||
rf.RelayedThrough = append(rf.RelayedThrough, relayedHI.relayState.CopyRelayIps()...)
|
||||
}
|
||||
|
||||
ro.RelayForAddrs = append(ro.RelayForAddrs, rf)
|
||||
}
|
||||
}
|
||||
err := enc.Encode(co)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func sshPrintTunnel(ifce *Interface, fs any, a []string, w sshd.StringWriter) error {
|
||||
args, ok := fs.(*sshPrintTunnelFlags)
|
||||
if !ok {
|
||||
return nil
|
||||
}
|
||||
|
||||
if len(a) == 0 {
|
||||
return w.WriteLine("No vpn address was provided")
|
||||
}
|
||||
|
||||
vpnAddr, err := netip.ParseAddr(a[0])
|
||||
if err != nil {
|
||||
return w.WriteLine(fmt.Sprintf("The provided vpn addr could not be parsed: %s", a[0]))
|
||||
}
|
||||
|
||||
if !vpnAddr.IsValid() {
|
||||
return w.WriteLine(fmt.Sprintf("The provided vpn addr could not be parsed: %s", a[0]))
|
||||
}
|
||||
|
||||
hostInfo := ifce.hostMap.QueryVpnAddr(vpnAddr)
|
||||
if hostInfo == nil {
|
||||
return w.WriteLine(fmt.Sprintf("Could not find tunnel for vpn addr: %v", a[0]))
|
||||
}
|
||||
|
||||
enc := json.NewEncoder(w.GetWriter())
|
||||
if args.Pretty {
|
||||
enc.SetIndent("", " ")
|
||||
}
|
||||
|
||||
return enc.Encode(copyHostInfo(hostInfo, ifce.hostMap.GetPreferredRanges()))
|
||||
}
|
||||
|
||||
func sshDeviceInfo(ifce *Interface, fs any, w sshd.StringWriter) error {
|
||||
|
||||
data := struct {
|
||||
Name string `json:"name"`
|
||||
Cidr []netip.Prefix `json:"cidr"`
|
||||
}{
|
||||
Name: ifce.inside.Name(),
|
||||
Cidr: make([]netip.Prefix, len(ifce.inside.Networks())),
|
||||
}
|
||||
|
||||
copy(data.Cidr, ifce.inside.Networks())
|
||||
|
||||
flags, ok := fs.(*sshDeviceInfoFlags)
|
||||
if !ok {
|
||||
return fmt.Errorf("internal error: expected flags to be sshDeviceInfoFlags but was %+v", fs)
|
||||
}
|
||||
|
||||
if flags.Json || flags.Pretty {
|
||||
js := json.NewEncoder(w.GetWriter())
|
||||
if flags.Pretty {
|
||||
js.SetIndent("", " ")
|
||||
}
|
||||
|
||||
return js.Encode(data)
|
||||
} else {
|
||||
return w.WriteLine(fmt.Sprintf("name=%v cidr=%v", data.Name, data.Cidr))
|
||||
}
|
||||
}
|
||||
|
||||
// sshReload reloads the config and writes the result to the client. It reloads even if the client has gone away
|
||||
func sshReload(l *slog.Logger, c *config.C, w sshd.StringWriter) error {
|
||||
writeErr := w.WriteLine("Reloading config")
|
||||
res := c.ReloadConfig()
|
||||
res.Log(l)
|
||||
if err := w.WriteLine(res.String()); writeErr == nil {
|
||||
writeErr = err
|
||||
}
|
||||
return writeErr
|
||||
}
|
||||
@@ -0,0 +1,119 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"path/filepath"
|
||||
"sort"
|
||||
"testing"
|
||||
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/test"
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
// TestSSHCommandSurface is a characterization test for the ssh command surface.
|
||||
// It pins the registered command set, their descriptions, help text and flag definitions
|
||||
// so that moving the registry to a transport neutral package is provably a relocation
|
||||
// rather than a rewrite. Regenerate with `go test . -run TestSSHCommandSurface -update`.
|
||||
|
||||
func TestSSHCommandSurface(t *testing.T) {
|
||||
got := renderCommandSurface(registeredCommands(t).Schema())
|
||||
test.Golden(t, filepath.Join("testdata", "ssh_commands.golden"), got)
|
||||
}
|
||||
|
||||
// registeredCommands returns a registry holding every command nebula serves. The
|
||||
// Interface is never dereferenced: attachCommands only closes over it.
|
||||
func registeredCommands(t *testing.T) *commands.Registry {
|
||||
t.Helper()
|
||||
l := test.NewLogger()
|
||||
reg := commands.New()
|
||||
attachCommands(l, config.NewC(l), reg, &Interface{})
|
||||
return reg
|
||||
}
|
||||
|
||||
// renderCommandSurface prints what a client actually sees, which is the schema rather
|
||||
// than the Command structs: the presentation flags are offered on every command that
|
||||
// returns a value, so reading Command.Flags alone would under-report the surface.
|
||||
func renderCommandSurface(cmds []commands.CommandSchema) string {
|
||||
lines := make([]string, 0, len(cmds))
|
||||
for _, cmd := range cmds {
|
||||
b := &bytes.Buffer{}
|
||||
fmt.Fprintf(b, "%s\n", cmd.Name)
|
||||
fmt.Fprintf(b, " short: %s\n", cmd.Short)
|
||||
fmt.Fprintf(b, " help: %s\n", cmd.Help)
|
||||
|
||||
if len(cmd.Flags) > 0 {
|
||||
fmt.Fprintf(b, " flags:\n")
|
||||
for _, f := range cmd.Flags {
|
||||
kind := " string"
|
||||
if f.Bool {
|
||||
kind = ""
|
||||
}
|
||||
fmt.Fprintf(b, " -%s%s\n \t%s\n", f.Name, kind, f.Usage)
|
||||
}
|
||||
}
|
||||
|
||||
lines = append(lines, b.String())
|
||||
}
|
||||
|
||||
sort.Strings(lines)
|
||||
return joinLines(lines)
|
||||
}
|
||||
|
||||
func joinLines(in []string) string {
|
||||
b := &bytes.Buffer{}
|
||||
for _, l := range in {
|
||||
b.WriteString(l)
|
||||
}
|
||||
return b.String()
|
||||
}
|
||||
|
||||
// TestLocalSocketSurface pins which of nebula's commands the always-on local socket
|
||||
// serves: every one registered. Adding a command fails here until the list below says
|
||||
// so, which turns "somebody forgot to think about it" into a visible decision.
|
||||
func TestLocalSocketSurface(t *testing.T) {
|
||||
var served []commands.Name
|
||||
for _, c := range registeredCommands(t).All() {
|
||||
served = append(served, c.Name)
|
||||
}
|
||||
|
||||
assert.ElementsMatch(t, []commands.Name{
|
||||
commands.Help,
|
||||
commands.Identity,
|
||||
commands.ListHostmap,
|
||||
commands.ListPendingHostmap,
|
||||
commands.ListLighthouseAddrmap,
|
||||
commands.PrintCert,
|
||||
commands.PrintTunnel,
|
||||
commands.PrintRelays,
|
||||
commands.DeviceInfo,
|
||||
commands.Version,
|
||||
commands.QueryLighthouse,
|
||||
commands.Reload,
|
||||
commands.LogLevel,
|
||||
commands.LogFormat,
|
||||
commands.ChangeRemote,
|
||||
commands.CloseTunnel,
|
||||
commands.CreateTunnel,
|
||||
commands.Whoami,
|
||||
}, served)
|
||||
}
|
||||
|
||||
// TestInfoAPISurface pins which commands the info API serves. That surface may be open
|
||||
// to every user on the host, so a command joins it by declaring Identity, and this test
|
||||
// is where that declaration is reviewed: anything listed here hands whoever can reach
|
||||
// the socket what the command reports.
|
||||
func TestInfoAPISurface(t *testing.T) {
|
||||
reg := registeredCommands(t)
|
||||
|
||||
var served []commands.Name
|
||||
for _, c := range reg.All() {
|
||||
if c.Identity {
|
||||
served = append(served, c.Name)
|
||||
}
|
||||
}
|
||||
|
||||
assert.ElementsMatch(t, []commands.Name{commands.PrintCert, commands.Identity, commands.Whoami}, served)
|
||||
}
|
||||
+13
-42
@@ -1,8 +1,6 @@
|
||||
package nebula
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
@@ -13,20 +11,7 @@ import (
|
||||
"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) {
|
||||
func TestReloadCommandReportsTheResult(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
write := func(body string) {
|
||||
require.NoError(t, os.WriteFile(filepath.Join(dir, "config.yml"), []byte(body), 0o600))
|
||||
@@ -43,41 +28,27 @@ func TestSSHReloadReportsTheResult(t *testing.T) {
|
||||
}
|
||||
})
|
||||
|
||||
reload := func() []string {
|
||||
w := &lineWriter{}
|
||||
require.NoError(t, sshReload(l, c, w))
|
||||
return w.lines
|
||||
// reload reports what happened. A reload that failed is a refusal, exit 1 over ssh;
|
||||
// one that merely needs a restart is not.
|
||||
reload := func(failed bool) string {
|
||||
res := runReload(l, c)
|
||||
assert.Equal(t, !failed, res.OK)
|
||||
return res.Reason
|
||||
}
|
||||
|
||||
write("a: 2\nb: 1")
|
||||
assert.Equal(t, []string{"Reloading config", "Config reload complete"}, reload())
|
||||
assert.Equal(t, "Config reload complete", reload(false))
|
||||
|
||||
fail = true
|
||||
write("a: 3\nb: 1")
|
||||
assert.Equal(t, []string{"Reloading config", "Config reload completed with errors, review the logs"}, reload())
|
||||
assert.Equal(t, "Config reload completed with errors, review the logs", reload(true))
|
||||
|
||||
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())
|
||||
assert.Equal(t, "Config reload was completed but requires a restart to fully apply, keys [b]", reload(false))
|
||||
|
||||
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)
|
||||
reason := reload(true)
|
||||
assert.Contains(t, reason, "Config reload failed, the new config did not load")
|
||||
assert.Contains(t, reason, dir, "names the config that did not load")
|
||||
}
|
||||
-161
@@ -1,161 +0,0 @@
|
||||
package sshd
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"flag"
|
||||
"fmt"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/armon/go-radix"
|
||||
)
|
||||
|
||||
// CommandFlags is a function called before help or command execution to parse command line flags
|
||||
// It should return a flag.FlagSet instance and a pointer to the struct that will contain parsed flags
|
||||
type CommandFlags func() (*flag.FlagSet, any)
|
||||
|
||||
// CommandCallback is the function called when your command should execute.
|
||||
// fs will be a a pointer to the struct provided by Command.Flags callback, if there was one. -h and -help are reserved
|
||||
// and handled automatically for you.
|
||||
// a will be any unconsumed arguments, if no Command.Flags was available this will be all the flags passed in.
|
||||
// w is the writer to use when sending messages back to the client.
|
||||
// If an error is returned by the callback it is logged locally, the callback should handle messaging errors to the user
|
||||
// where appropriate
|
||||
type CommandCallback func(fs any, a []string, w StringWriter) error
|
||||
|
||||
type Command struct {
|
||||
Name string
|
||||
ShortDescription string
|
||||
Help string
|
||||
Flags CommandFlags
|
||||
Callback CommandCallback
|
||||
}
|
||||
|
||||
func execCommand(c *Command, args []string, w StringWriter) error {
|
||||
var (
|
||||
fl *flag.FlagSet
|
||||
fs any
|
||||
)
|
||||
|
||||
if c.Flags != nil {
|
||||
fl, fs = c.Flags()
|
||||
if fl != nil {
|
||||
// SetOutput() here in case fl.Parse dumps usage.
|
||||
fl.SetOutput(w.GetWriter())
|
||||
err := fl.Parse(args)
|
||||
if err != nil {
|
||||
// fl.Parse has dumped error information to the user via the w writer.
|
||||
return err
|
||||
}
|
||||
args = fl.Args()
|
||||
}
|
||||
}
|
||||
|
||||
return c.Callback(fs, args, w)
|
||||
}
|
||||
|
||||
func dumpCommands(c *radix.Tree, w StringWriter) {
|
||||
err := w.WriteLine("Available commands:")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
cmds := make([]string, 0)
|
||||
for _, l := range allCommands(c) {
|
||||
cmds = append(cmds, fmt.Sprintf("%s - %s", l.Name, l.ShortDescription))
|
||||
}
|
||||
|
||||
sort.Strings(cmds)
|
||||
_ = w.Write(strings.Join(cmds, "\n") + "\n\n")
|
||||
}
|
||||
|
||||
func lookupCommand(c *radix.Tree, sCmd string) (*Command, error) {
|
||||
cmd, ok := c.Get(sCmd)
|
||||
if !ok {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
command, ok := cmd.(*Command)
|
||||
if !ok {
|
||||
return nil, errors.New("failed to cast command")
|
||||
}
|
||||
|
||||
return command, nil
|
||||
}
|
||||
|
||||
func matchCommand(c *radix.Tree, cmd string) []string {
|
||||
cmds := make([]string, 0)
|
||||
c.WalkPrefix(cmd, func(found string, v any) bool {
|
||||
cmds = append(cmds, found)
|
||||
return false
|
||||
})
|
||||
sort.Strings(cmds)
|
||||
return cmds
|
||||
}
|
||||
|
||||
func allCommands(c *radix.Tree) []*Command {
|
||||
cmds := make([]*Command, 0)
|
||||
c.WalkPrefix("", func(found string, v any) bool {
|
||||
cmd, ok := v.(*Command)
|
||||
if ok {
|
||||
cmds = append(cmds, cmd)
|
||||
}
|
||||
return false
|
||||
})
|
||||
return cmds
|
||||
}
|
||||
|
||||
func helpCallback(commands *radix.Tree, a []string, w StringWriter) (err error) {
|
||||
// Just typed help
|
||||
if len(a) == 0 {
|
||||
dumpCommands(commands, w)
|
||||
return nil
|
||||
}
|
||||
|
||||
// We are printing a specific commands help text
|
||||
cmd, err := lookupCommand(commands, a[0])
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
if cmd != nil {
|
||||
err = w.WriteLine(fmt.Sprintf("%s - %s", cmd.Name, cmd.ShortDescription))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if cmd.Help != "" {
|
||||
err = w.WriteLine(fmt.Sprintf(" %s", cmd.Help))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if cmd.Flags != nil {
|
||||
fs, _ := cmd.Flags()
|
||||
if fs != nil {
|
||||
fs.SetOutput(w.GetWriter())
|
||||
fs.PrintDefaults()
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
err = w.WriteLine("Command not available " + a[0])
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func checkHelpArgs(args []string) bool {
|
||||
for _, a := range args {
|
||||
if a == "-h" || a == "-help" {
|
||||
return true
|
||||
}
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
+9
-23
@@ -10,7 +10,7 @@ import (
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
|
||||
"github.com/armon/go-radix"
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"golang.org/x/crypto/ssh"
|
||||
)
|
||||
|
||||
@@ -29,10 +29,9 @@ type SSHServer struct {
|
||||
trustedKeys map[string]map[string]bool
|
||||
trustedCAs []ssh.PublicKey
|
||||
|
||||
// List of available commands
|
||||
helpCommand *Command
|
||||
commands *radix.Tree
|
||||
listener atomic.Pointer[net.Listener]
|
||||
// Available commands.
|
||||
commands *commands.Registry
|
||||
listener atomic.Pointer[net.Listener]
|
||||
|
||||
// runs counts the Runs that are listening. A reload's Run can start before the one it replaced has returned
|
||||
runs atomic.Int32
|
||||
@@ -44,14 +43,14 @@ type SSHServer struct {
|
||||
ctx context.Context
|
||||
}
|
||||
|
||||
// NewSSHServer creates a new ssh server rigged with default commands and prepares to listen.
|
||||
// The ssh server's context is parented off the supplied ctx so cancelling it
|
||||
// (e.g. on Control.Stop) tears down active sessions and closes the listener.
|
||||
func NewSSHServer(ctx context.Context, l *slog.Logger) (*SSHServer, error) {
|
||||
// NewSSHServer creates a new ssh server serving the supplied command registry and
|
||||
// prepares to listen. The ssh server's context is parented off the supplied ctx so
|
||||
// cancelling it (e.g. on Control.Stop) tears down active sessions and closes the listener.
|
||||
func NewSSHServer(ctx context.Context, l *slog.Logger, reg *commands.Registry) (*SSHServer, error) {
|
||||
s := &SSHServer{
|
||||
trustedKeys: make(map[string]map[string]bool),
|
||||
l: l,
|
||||
commands: radix.New(),
|
||||
commands: reg,
|
||||
ctx: ctx,
|
||||
}
|
||||
|
||||
@@ -97,14 +96,6 @@ func NewSSHServer(ctx context.Context, l *slog.Logger) (*SSHServer, error) {
|
||||
s.authenticate = cc.Authenticate
|
||||
s.config.Store(s.newConfig())
|
||||
|
||||
s.RegisterCommand(&Command{
|
||||
Name: "help",
|
||||
ShortDescription: "prints available commands or help <command> for specific usage info",
|
||||
Callback: func(a any, args []string, w StringWriter) error {
|
||||
return helpCallback(s.commands, args, w)
|
||||
},
|
||||
})
|
||||
|
||||
return s, nil
|
||||
}
|
||||
|
||||
@@ -189,11 +180,6 @@ func (s *SSHServer) AddAuthorizedKey(user, pubKey string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// RegisterCommand adds a command that can be run by a user, by default only `help` is available
|
||||
func (s *SSHServer) RegisterCommand(c *Command) {
|
||||
s.commands.Insert(c.Name, c)
|
||||
}
|
||||
|
||||
// Run begins listening and accepting connections. Each invocation derives a fresh per-Run context
|
||||
// from the constructor-supplied ctx so a Stop+Run sequence (used by config reload) starts clean
|
||||
// rather than carrying a permanently-cancelled context across runs.
|
||||
|
||||
+56
-44
@@ -1,13 +1,12 @@
|
||||
package sshd
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"errors"
|
||||
"log/slog"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/anmitsu/go-shlex"
|
||||
"github.com/armon/go-radix"
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"golang.org/x/crypto/ssh"
|
||||
"golang.org/x/term"
|
||||
)
|
||||
@@ -16,31 +15,56 @@ type session struct {
|
||||
l *slog.Logger
|
||||
c *ssh.ServerConn
|
||||
term *term.Terminal
|
||||
commands *radix.Tree
|
||||
commands *commands.Registry
|
||||
cancel func()
|
||||
}
|
||||
|
||||
func NewSession(commands *radix.Tree, conn *ssh.ServerConn, chans <-chan ssh.NewChannel, cancel func(), l *slog.Logger) *session {
|
||||
func NewSession(reg *commands.Registry, conn *ssh.ServerConn, chans <-chan ssh.NewChannel, cancel func(), l *slog.Logger) *session {
|
||||
s := &session{
|
||||
commands: radix.NewFromMap(commands.ToMap()),
|
||||
commands: reg.Clone(),
|
||||
l: l,
|
||||
c: conn,
|
||||
cancel: cancel,
|
||||
}
|
||||
s.commands.DefaultFormat = DefaultFormat
|
||||
|
||||
s.commands.Insert("logout", &Command{
|
||||
Name: "logout",
|
||||
ShortDescription: "Ends the current session",
|
||||
Callback: func(a any, args []string, w StringWriter) error {
|
||||
s.Close()
|
||||
return nil
|
||||
},
|
||||
})
|
||||
s.commands.Register(LogoutCommand(s.Close))
|
||||
|
||||
go s.handleChannels(chans)
|
||||
return s
|
||||
}
|
||||
|
||||
// LogoutCommand is the logout command a session registers on its clone of the registry,
|
||||
// with end as what it does. Exported so a test can serve what a session serves.
|
||||
func LogoutCommand(end func()) *commands.Command {
|
||||
return &commands.Command{
|
||||
Name: commands.Logout,
|
||||
ShortDescription: "Ends the current session",
|
||||
Run: func(a any, args []string) (commands.Result, error) {
|
||||
end()
|
||||
return commands.Nothing(), nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// DefaultFormat is what an ssh session renders when the operator gave neither -json nor
|
||||
// -pretty: text where a command has a human form, and compact JSON for the ones that
|
||||
// have none (print-tunnel, print-relays, query-lighthouse). It is ssh's policy, exported so a test
|
||||
// can dispatch through the same choice, and ssh's to change.
|
||||
func DefaultFormat(c *commands.Command, r commands.Result) commands.Format {
|
||||
if !c.JSONOnly {
|
||||
return commands.FormatText
|
||||
}
|
||||
|
||||
// A JSON-only command's refusal ("No vpn address was provided") is a sentence for a
|
||||
// person, so an outcome renders as text here; ssh users and scripts expect it.
|
||||
if r.Value == nil {
|
||||
return commands.FormatText
|
||||
}
|
||||
|
||||
return commands.FormatJSON
|
||||
}
|
||||
|
||||
func (s *session) handleChannels(chans <-chan ssh.NewChannel) {
|
||||
defer s.Close()
|
||||
for newChannel := range chans {
|
||||
@@ -87,9 +111,13 @@ func (s *session) handleRequests(in <-chan *ssh.Request, channel ssh.Channel) {
|
||||
}
|
||||
|
||||
req.Reply(true, nil)
|
||||
s.dispatchCommand(payload.Value, &stringWriter{channel})
|
||||
err := s.dispatchCommand(payload.Value, commands.MergedOutput(channel))
|
||||
|
||||
// A command that failed exits 1, so `ssh host cmd` callers can tell.
|
||||
status := struct{ Status uint32 }{uint32(0)}
|
||||
if err != nil {
|
||||
status.Status = 1
|
||||
}
|
||||
channel.SendRequest("exit-status", false, ssh.Marshal(status))
|
||||
channel.Close()
|
||||
return
|
||||
@@ -111,7 +139,7 @@ func (s *session) createTerm(channel ssh.Channel) *term.Terminal {
|
||||
term.AutoCompleteCallback = func(line string, pos int, key rune) (newLine string, newPos int, ok bool) {
|
||||
// key 9 is tab
|
||||
if key == 9 {
|
||||
cmds := matchCommand(s.commands, line)
|
||||
cmds := s.commands.Match(line)
|
||||
if len(cmds) == 1 {
|
||||
return cmds[0] + " ", len(cmds[0]) + 1, true
|
||||
}
|
||||
@@ -128,7 +156,7 @@ func (s *session) createTerm(channel ssh.Channel) *term.Terminal {
|
||||
}
|
||||
|
||||
func (s *session) handleInput() {
|
||||
w := &stringWriter{w: s.term}
|
||||
w := commands.MergedOutput(s.term)
|
||||
for {
|
||||
line, err := s.term.ReadLine()
|
||||
if err != nil {
|
||||
@@ -139,36 +167,20 @@ func (s *session) handleInput() {
|
||||
}
|
||||
}
|
||||
|
||||
func (s *session) dispatchCommand(line string, w StringWriter) {
|
||||
args, err := shlex.Split(line, true)
|
||||
if err != nil {
|
||||
return
|
||||
// dispatchCommand runs line and returns the command's error, which it has logged unless
|
||||
// the command already told the user everything: the log line is for the operator reading
|
||||
// the daemon's log, who learns nothing from a failure the user caused.
|
||||
func (s *session) dispatchCommand(line string, w commands.Output) error {
|
||||
err := s.commands.Dispatch(line, w)
|
||||
if err == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
if len(args) == 0 {
|
||||
dumpCommands(s.commands, w)
|
||||
return
|
||||
var f *commands.Failure
|
||||
if !errors.As(err, &f) {
|
||||
s.l.Debug("Command returned an error", "line", line, "error", err)
|
||||
}
|
||||
|
||||
c, err := lookupCommand(s.commands, args[0])
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
if c == nil {
|
||||
err := w.WriteLine(fmt.Sprintf("did not understand: %s", line))
|
||||
_ = err
|
||||
|
||||
dumpCommands(s.commands, w)
|
||||
return
|
||||
}
|
||||
|
||||
if checkHelpArgs(args) {
|
||||
s.dispatchCommand(fmt.Sprintf("%s %s", "help", c.Name), w)
|
||||
return
|
||||
}
|
||||
|
||||
_ = execCommand(c, args[1:], w)
|
||||
return err
|
||||
}
|
||||
|
||||
func (s *session) Close() {
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
package sshd
|
||||
|
||||
import "io"
|
||||
|
||||
type StringWriter interface {
|
||||
WriteLine(string) error
|
||||
Write(string) error
|
||||
WriteBytes([]byte) error
|
||||
GetWriter() io.Writer
|
||||
}
|
||||
|
||||
type stringWriter struct {
|
||||
w io.Writer
|
||||
}
|
||||
|
||||
func (w *stringWriter) WriteLine(s string) error {
|
||||
return w.Write(s + "\n")
|
||||
}
|
||||
|
||||
func (w *stringWriter) Write(s string) error {
|
||||
_, err := w.w.Write([]byte(s))
|
||||
return err
|
||||
}
|
||||
|
||||
func (w *stringWriter) WriteBytes(b []byte) error {
|
||||
_, err := w.w.Write(b)
|
||||
return err
|
||||
}
|
||||
|
||||
func (w *stringWriter) GetWriter() io.Writer {
|
||||
return w.w
|
||||
}
|
||||
+40
-1
@@ -10,9 +10,11 @@ import (
|
||||
"net"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/slackhq/nebula/commands"
|
||||
"github.com/slackhq/nebula/config"
|
||||
"github.com/slackhq/nebula/sshd"
|
||||
"github.com/slackhq/nebula/test"
|
||||
@@ -23,6 +25,7 @@ import (
|
||||
|
||||
type sshdReloadHarness struct {
|
||||
c *config.C
|
||||
reg *commands.Registry
|
||||
server *sshd.SSHServer
|
||||
keyFile string
|
||||
signer ssh.Signer
|
||||
@@ -44,7 +47,8 @@ func newSSHDReloadHarness(t *testing.T) *sshdReloadHarness {
|
||||
|
||||
h.c = config.NewC(l)
|
||||
require.NoError(t, h.c.LoadString(h.config()))
|
||||
h.server, err = sshd.NewSSHServer(t.Context(), l)
|
||||
h.reg = commands.New()
|
||||
h.server, err = sshd.NewSSHServer(t.Context(), l, h.reg)
|
||||
require.NoError(t, err)
|
||||
wireSSHReload(l, h.server, h.c)
|
||||
run, err := configSSH(l, h.server, h.c, nil)
|
||||
@@ -238,3 +242,38 @@ func TestSSHDReload_SkippedEntriesFail(t *testing.T) {
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestSSHExecExitStatusReflectsTheCommand: an exec request exits 1 when the command
|
||||
// returned an error and 0 otherwise, with the command's output either way.
|
||||
func TestSSHExecExitStatusReflectsTheCommand(t *testing.T) {
|
||||
h := newSSHDReloadHarness(t)
|
||||
h.reg.Register(&commands.Command{
|
||||
Name: "fails",
|
||||
Run: func(fs any, a []string) (commands.Result, error) {
|
||||
return commands.Failed("nope"), nil
|
||||
},
|
||||
})
|
||||
client, _ := h.connect(t)
|
||||
|
||||
sess, err := client.NewSession()
|
||||
require.NoError(t, err)
|
||||
out, err := sess.CombinedOutput("fails")
|
||||
var exit *ssh.ExitError
|
||||
require.ErrorAs(t, err, &exit)
|
||||
assert.Equal(t, 1, exit.ExitStatus())
|
||||
assert.Equal(t, "nope\n", string(out))
|
||||
|
||||
sess, err = client.NewSession()
|
||||
require.NoError(t, err)
|
||||
out, err = sess.CombinedOutput("help fails")
|
||||
require.NoError(t, err)
|
||||
assert.Contains(t, string(out), "fails - \n")
|
||||
|
||||
// A word that is not a command is a failure too, with the command list as before.
|
||||
sess, err = client.NewSession()
|
||||
require.NoError(t, err)
|
||||
out, err = sess.CombinedOutput("nope")
|
||||
require.ErrorAs(t, err, &exit)
|
||||
assert.Equal(t, 1, exit.ExitStatus())
|
||||
assert.True(t, strings.HasPrefix(string(out), "did not understand: nope\nAvailable commands:\n"), string(out))
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
package test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"flag"
|
||||
"io"
|
||||
"net"
|
||||
"net/http"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// ShortTempDir returns a short private directory of the test's own, removed when the
|
||||
// test ends. t.TempDir embeds the test name, which on darwin routinely pushes a unix
|
||||
// socket path laid out under it past the 104 byte sun_path limit.
|
||||
func ShortTempDir(t *testing.T) string {
|
||||
t.Helper()
|
||||
|
||||
dir, err := os.MkdirTemp("", "la")
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { _ = os.RemoveAll(dir) })
|
||||
return dir
|
||||
}
|
||||
|
||||
// Update is the -update flag: Golden rewrites its file instead of comparing against it.
|
||||
var Update = flag.Bool("update", false, "rewrite golden files instead of comparing against them")
|
||||
|
||||
// Golden compares got with the file at path, or rewrites the file when -update is set.
|
||||
func Golden(t *testing.T, path, got string) {
|
||||
t.Helper()
|
||||
|
||||
if *Update {
|
||||
require.NoError(t, os.MkdirAll(filepath.Dir(path), 0755))
|
||||
require.NoError(t, os.WriteFile(path, []byte(got), 0644))
|
||||
return
|
||||
}
|
||||
|
||||
want, err := os.ReadFile(path)
|
||||
require.NoError(t, err, "missing golden file, run with -update")
|
||||
assert.Equal(t, string(want), got)
|
||||
}
|
||||
|
||||
// HTTPDo sends one request to the HTTP server on the unix socket at socket and returns
|
||||
// the status, body and headers of its answer. The host in the URL is a placeholder:
|
||||
// every connection goes to the socket.
|
||||
func HTTPDo(t *testing.T, socket, method, target string) (int, string, http.Header) {
|
||||
t.Helper()
|
||||
|
||||
client := &http.Client{Transport: &http.Transport{
|
||||
DialContext: func(ctx context.Context, _, _ string) (net.Conn, error) {
|
||||
return (&net.Dialer{}).DialContext(ctx, "unix", socket)
|
||||
},
|
||||
}}
|
||||
t.Cleanup(client.CloseIdleConnections)
|
||||
|
||||
req, err := http.NewRequest(method, "http://nebula"+target, nil)
|
||||
require.NoError(t, err)
|
||||
res, err := client.Do(req)
|
||||
require.NoError(t, err)
|
||||
defer res.Body.Close()
|
||||
|
||||
body, err := io.ReadAll(res.Body)
|
||||
require.NoError(t, err)
|
||||
return res.StatusCode, string(body), res.Header
|
||||
}
|
||||
|
||||
// HTTPGet is HTTPDo for a GET whose headers the test does not read.
|
||||
func HTTPGet(t *testing.T, socket, target string) (int, string) {
|
||||
t.Helper()
|
||||
status, body, _ := HTTPDo(t, socket, http.MethodGet, target)
|
||||
return status, body
|
||||
}
|
||||
Vendored
+160
@@ -0,0 +1,160 @@
|
||||
change-remote
|
||||
short: Changes the remote address used in the tunnel for the provided vpn addr
|
||||
help:
|
||||
flags:
|
||||
-address string
|
||||
The new remote address, ip:port
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
close-tunnel
|
||||
short: Closes a tunnel for the provided vpn addr
|
||||
help:
|
||||
flags:
|
||||
-local-only
|
||||
Disables notifying the remote that the tunnel is shutting down
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
create-tunnel
|
||||
short: Creates a tunnel for the provided vpn address
|
||||
help: The lighthouses will be queried for real addresses but you can provide one as well.
|
||||
flags:
|
||||
-address string
|
||||
Optionally provide a real remote address, ip:port
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
device-info
|
||||
short: Prints information about the network device.
|
||||
help:
|
||||
flags:
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
help
|
||||
short: prints available commands or help <command> for specific usage info
|
||||
help:
|
||||
flags:
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
identity
|
||||
short: Prints the certificate identity of the host owning the provided vpn addr
|
||||
help: Identity is what the certificate says: name, vpn addrs, networks, groups, fingerprint, issuer and validity. The address may carry a port, so a connection's remote address can be passed through as is. For this node's own identity use whoami.
|
||||
flags:
|
||||
-address string
|
||||
The vpn addr to look up, optionally with a port
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
list-hostmap
|
||||
short: List all known previously connected hosts
|
||||
help:
|
||||
flags:
|
||||
-by-index
|
||||
gets all hosts in the hostmap from the index table
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
list-lighthouse-addrmap
|
||||
short: List all lighthouse map entries
|
||||
help:
|
||||
flags:
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
list-pending-hostmap
|
||||
short: List all handshaking hosts
|
||||
help:
|
||||
flags:
|
||||
-by-index
|
||||
gets all hosts in the hostmap from the index table
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
log-format
|
||||
short: Gets or sets the current log format
|
||||
help:
|
||||
flags:
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
log-level
|
||||
short: Gets or sets the current log level
|
||||
help:
|
||||
flags:
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
print-cert
|
||||
short: Prints the current certificate being used or the certificate for the provided vpn addr
|
||||
help: The vpn addr is an operand or -address, which may carry a port so a connection's remote address can be passed through as is. For a peer it is the certificate nebula verified when the tunnel came up; with no address it is this node's own, the v2 certificate when both versions are loaded. -raw prints the PEM.
|
||||
flags:
|
||||
-address string
|
||||
The vpn addr to look up, optionally with a port
|
||||
-raw
|
||||
prints the PEM encoded certificate; with -json, an object holding it
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
print-relays
|
||||
short: Prints json details about all relay info
|
||||
help:
|
||||
flags:
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
print-tunnel
|
||||
short: Prints json details about a tunnel for the provided vpn addr
|
||||
help:
|
||||
flags:
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
query-lighthouse
|
||||
short: Query the lighthouses for the provided vpn address
|
||||
help: This command is asynchronous. Only currently known udp addresses will be printed.
|
||||
flags:
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
reload
|
||||
short: Reloads configuration from disk, same as sending HUP to the process
|
||||
help:
|
||||
flags:
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
version
|
||||
short: Prints the currently running version of nebula
|
||||
help:
|
||||
flags:
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
whoami
|
||||
short: Prints the certificate identity of this node
|
||||
help: The fields identity prints, read from this node's own certificate.
|
||||
flags:
|
||||
-json
|
||||
outputs as json
|
||||
-pretty
|
||||
pretty prints json, assumes -json
|
||||
+12
-4
@@ -255,6 +255,10 @@ func (u *StdConn) ListenOut(r EncReader, flush func()) error {
|
||||
msgs, buffers, names, _ := prepareRawMessages(u.batch, bufSize, cmsgSpace)
|
||||
|
||||
for {
|
||||
// A shut down socket still queues and returns datagrams, a busy reader would never see an empty read
|
||||
if u.closed.Load() {
|
||||
return net.ErrClosed
|
||||
}
|
||||
if cmsgSpace > 0 {
|
||||
for i := range msgs {
|
||||
setMsgControllen(&msgs[i].Hdr, cmsgSpace)
|
||||
@@ -446,12 +450,16 @@ func (u *StdConn) getMemInfo(meminfo *[unix.SK_MEMINFO_VARS]uint32) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (u *StdConn) Close() error {
|
||||
// Shutdown wakes the reader without releasing the fd, Close only once it has exited
|
||||
func (u *StdConn) Shutdown() error {
|
||||
u.closed.Store(true)
|
||||
// Wake the reader parked in recvmmsg. shutdown(2) on an unconnected socket
|
||||
// returns ENOTCONN but still wakes it, so ignore the error.
|
||||
// The reader then sees closed and stops touching the fd, making the Close below safe.
|
||||
// shutdown(2) on an unconnected socket returns ENOTCONN but still wakes the reader, so ignore the error
|
||||
_ = unix.Shutdown(u.sysFd, unix.SHUT_RDWR)
|
||||
return nil
|
||||
}
|
||||
|
||||
func (u *StdConn) Close() error {
|
||||
_ = u.Shutdown()
|
||||
return unix.Close(u.sysFd)
|
||||
}
|
||||
|
||||
|
||||
+74
-5
@@ -76,7 +76,7 @@ func TestShutdownWakesAfterRx_Mechanism(t *testing.T) {
|
||||
}
|
||||
|
||||
// TestListenOutTeardown_TrafficPatterns reproduces the field report: a blocking
|
||||
// reader must tear down cleanly on Close() regardless of what the socket has
|
||||
// reader must tear down cleanly on Shutdown() regardless of what the socket has
|
||||
// carried. The three cases the report called out:
|
||||
//
|
||||
// no traffic ever -> works (shutdown wakes recvmmsg with n==0)
|
||||
@@ -162,11 +162,12 @@ func runTeardownCase(t *testing.T, batch int, name string, traffic func(send net
|
||||
// empty queue with the socket already having received a packet.
|
||||
time.Sleep(500 * time.Millisecond)
|
||||
|
||||
// Tear down the way Interface.Close does, the fd stays open until the reader is gone
|
||||
start := time.Now()
|
||||
if err := sc.Close(); err != nil {
|
||||
t.Fatalf("Close: %v", err)
|
||||
if err := sc.Shutdown(); err != nil {
|
||||
t.Fatalf("Shutdown: %v", err)
|
||||
}
|
||||
close(stop)
|
||||
defer func() { _ = sc.Close() }()
|
||||
|
||||
select {
|
||||
case err := <-loopDone:
|
||||
@@ -179,7 +180,75 @@ func runTeardownCase(t *testing.T, batch int, name string, traffic func(send net
|
||||
case <-time.After(3 * time.Second):
|
||||
buf := make([]byte, 1<<20)
|
||||
n := runtime.Stack(buf, true)
|
||||
t.Fatalf("%s: HANG, ListenOut did not return within 3s of Close\n%s", name, buf[:n])
|
||||
t.Fatalf("%s: HANG, ListenOut did not return within 3s of Shutdown\n%s", name, buf[:n])
|
||||
}
|
||||
close(stop)
|
||||
<-trafficDone
|
||||
}
|
||||
|
||||
// A shut down socket still returns queued datagrams, so a reader that is behind has to stop on its own within the
|
||||
// batch it was working on
|
||||
func TestListenOutShutdown_BusyReader(t *testing.T) {
|
||||
const batch = 64
|
||||
udpSettings := Settings{Listen: netip.MustParseAddrPort("127.0.0.1:0"), Multi: true, Batch: batch}
|
||||
c, err := NewListener(testLogger(), udpSettings)
|
||||
if err != nil {
|
||||
t.Fatalf("NewListener: %v", err)
|
||||
}
|
||||
sc := c.(*StdConn)
|
||||
defer sc.Close()
|
||||
addr, err := sc.LocalAddr()
|
||||
if err != nil {
|
||||
t.Fatalf("LocalAddr: %v", err)
|
||||
}
|
||||
|
||||
stop := make(chan struct{})
|
||||
defer close(stop)
|
||||
for range 8 {
|
||||
send, err := net.Dial("udp", addr.String())
|
||||
if err != nil {
|
||||
t.Fatalf("dial: %v", err)
|
||||
}
|
||||
defer send.Close()
|
||||
go func() {
|
||||
b := make([]byte, 1200)
|
||||
for {
|
||||
select {
|
||||
case <-stop:
|
||||
return
|
||||
default:
|
||||
_, _ = send.Write(b)
|
||||
}
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
var afterShutdown atomic.Int64
|
||||
loopDone := make(chan error, 1)
|
||||
go func() {
|
||||
loopDone <- sc.ListenOut(func(netip.AddrPort, []byte) {
|
||||
if sc.closed.Load() {
|
||||
afterShutdown.Add(1)
|
||||
}
|
||||
// Slower than the senders so the queue never drains
|
||||
for start := time.Now(); time.Since(start) < 200*time.Microsecond; {
|
||||
}
|
||||
}, func() {})
|
||||
}()
|
||||
|
||||
time.Sleep(200 * time.Millisecond)
|
||||
if err := sc.Shutdown(); err != nil {
|
||||
t.Fatalf("Shutdown: %v", err)
|
||||
}
|
||||
select {
|
||||
case err := <-loopDone:
|
||||
if !errors.Is(err, net.ErrClosed) {
|
||||
t.Fatalf("ListenOut returned %v, want net.ErrClosed", err)
|
||||
}
|
||||
case <-time.After(3 * time.Second):
|
||||
t.Fatalf("ListenOut still running 3s after Shutdown, delivered %d packets since", afterShutdown.Load())
|
||||
}
|
||||
if n := afterShutdown.Load(); n > batch {
|
||||
t.Fatalf("delivered %d packets after Shutdown, more than the one batch in flight", n)
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user