mirror of
https://github.com/slackhq/nebula.git
synced 2026-11-15 15:26:52 +01:00
Build slackhq/nebula#1821 ("who is this vpn address?" over a local HTTP+JSON socket) on the command registry, so the lookup is one command on every surface and the socket is one more local API. identity - `identity [-address <vpn addr>[:port]]`: no address reports this node; with one, this node or the peer behind an established tunnel - Certificate fields only: name, vpn addresses, networks, unsafe networks, groups, fingerprint, issuer, validity, cert version; a peer's fingerprint is the one nebula computed when it verified the cert - Port accepted and stripped, 4in6 unmapped, so a RemoteAddr passes straight through - No tunnel is a commands.NotFound; an empty -address is refused - Lighthouse TXT lookup shares the owner and peer lookups, keeps answering with the initiating certificate, and no longer panics without a default cert - Served on ssh and nebula ctl too Info API - Off until `local_api.info.enabled` with `socket` and optional quoted octal `socket_mode` (default "0600"); nothing derived - Serves commands declaring Command.Identity plus help; others 403 naming their surfaces. TestInfoAPISurface pins the set to identity - GET /v1 is the schema; GET /v1/<cmd>?<flag>=<value> runs one; body is the -json rendering via commands.Render; commands.PresentationFormat reads json/pretty from the query the way a line is read - 400 commands.ParamError, 403 commands.WithheldError (what Resolve now returns for a withheld name, so help and dispatch type-check it too), 404 NotFound or unknown, 500 Run error, refusal with no reason, or recovered panic with no detail; no redirects; every miss is JSON - listen takes a mode: bind under umask 0077 then chmod; "0660" plus a searchable dir opens it to a group - The chmod, at bind and on a mode-only reload, goes through chmodSocket, which never follows a link: a user who can write the socket's directory could otherwise swap the node for a link and have a root daemon put 0660 or 0666 on any file. Only a socket we own is chmoded. On linux the node is held open O_PATH|O_NOFOLLOW, checked by fstat, and chmoded through /proc/self/fd, so the check and the chmod land on one inode; fchmodat2 is the fallback without /proc. On darwin and the BSDs it is an Lstat check and fchmodat(AT_SYMLINK_NOFOLLOW). clearStale Lstats too, so a dangling link is refused rather than followed by bind on darwin - One endpoint type owns bind under mutex, bind-before-release move, context watch and stop/unlink; each server supplies what it serves - Reloadable through the same reconcile shape as the control socket: mode applied in place, unparsable section keeps what runs, control socket path refused by name - Wire returns Endpoints{Control, Info} with one Stop - Windows unsupported for now (a pipe has no mode); warned once Tests: identity lookups and shapes; API filter, status codes, panic recovery, socket mode, rebind, cancellation; config parsing incl. bare 0660; Wire transitions; e2e of two nebulas with the info API resolving the peer by address and port, through shared test.HTTPDo/HTTPGet helpers. Goldens gain identity. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
140 lines
3.1 KiB
Go
140 lines
3.1 KiB
Go
package main
|
|
|
|
import (
|
|
"flag"
|
|
"fmt"
|
|
"os"
|
|
"runtime/debug"
|
|
"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"
|
|
)
|
|
|
|
// A version string that can be set with
|
|
//
|
|
// -ldflags "-X main.Build=SOMEVERSION"
|
|
//
|
|
// at compile-time.
|
|
var Build string
|
|
|
|
func init() {
|
|
if Build == "" {
|
|
info, ok := debug.ReadBuildInfo()
|
|
if !ok {
|
|
return
|
|
}
|
|
|
|
Build = strings.TrimPrefix(info.Main.Version, "v")
|
|
}
|
|
}
|
|
|
|
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")
|
|
printVersion := flag.Bool("version", false, "Print version")
|
|
printUsage := flag.Bool("help", false, "Print command line usage")
|
|
|
|
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)
|
|
}
|
|
|
|
if *printUsage {
|
|
flag.Usage()
|
|
os.Exit(0)
|
|
}
|
|
|
|
l := logging.NewLogger(os.Stdout)
|
|
|
|
if *serviceFlag != "" {
|
|
if *configTest {
|
|
fmt.Println("-test is not supported with -service, run the config test without -service")
|
|
os.Exit(1)
|
|
}
|
|
|
|
if err := doService(configPath, Build, serviceFlag); err != nil {
|
|
l.Error("Service command failed", "error", err)
|
|
os.Exit(1)
|
|
}
|
|
return
|
|
}
|
|
|
|
if *configPath == "" {
|
|
p, err := config.DefaultPath()
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
os.Exit(1)
|
|
}
|
|
*configPath = p
|
|
}
|
|
|
|
c := config.NewC(l)
|
|
err := c.Load(*configPath)
|
|
if err != nil {
|
|
fmt.Printf("failed to load config: %s", err)
|
|
os.Exit(1)
|
|
}
|
|
|
|
if err := logging.ApplyConfig(l, c); err != nil {
|
|
fmt.Printf("failed to apply logging config: %s", err)
|
|
os.Exit(1)
|
|
}
|
|
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
|
if err := logging.ApplyConfig(l, c); err != nil {
|
|
l.Error("Failed to reconfigure logger on reload", "error", err)
|
|
r.Failed()
|
|
}
|
|
})
|
|
|
|
ctrl, err := nebula.Main(c, *configTest, Build, l, nil)
|
|
if err != nil {
|
|
util.LogWithContextIfNeeded("Failed to start", err, l)
|
|
os.Exit(1)
|
|
}
|
|
|
|
if !*configTest {
|
|
if err := ctrl.Start(); err != nil {
|
|
util.LogWithContextIfNeeded("Error while running", err, l)
|
|
os.Exit(1)
|
|
}
|
|
|
|
local := localapi.Wire(ctrl.Context(), l, c, ctrl.Commands())
|
|
|
|
go ctrl.ShutdownBlock()
|
|
|
|
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)
|
|
}
|
|
|
|
l.Info("Goodbye")
|
|
}
|
|
|
|
os.Exit(0)
|
|
}
|