sendnrw/netbird
2
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-09-14 02:39:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

[management,client] Take the debug-bundle upload destination from management

Browse Source 
The debug-bundle paths that upload without a human picking a destination
compiled the vendor endpoint in: the mobile clients and the desktop UI hold
`https://upload.debug.netbird.io/upload-url` as a constant, the CLI defaults its
flag to it, and the remote job falls back to it when nothing else is set. A
self-hosted deployment therefore shipped peer logs, routes, DNS and firewall
state to NetBird-run infrastructure without its operator ever configuring that,
and had no way to point those paths anywhere else. #7147 and #7153 gave the
remote job a per-job URL and an MDM override, but neither reaches the mobile,
UI or CLI paths, and both fail open when unset.

Publish the destination from the management server instead, on the channel that
already carries stun/turn/signal/relay/flow/metrics:

- `NetbirdConfig.debug.upload_url`, sourced from the new account setting
  `debug_bundle_upload_url` (REST + dashboard) and falling back to the new
  `DebugUpload.URL` in the management server config, which a self-hosted install
  can set once so a fresh account is not left on the vendor default. Both are
  validated as https-with-host where they are written; a change fans out to
  connected peers rather than waiting for the next login.
- One resolver on the client, `debug.ResolveUploadURL`, used by every path:
  MDM override > explicitly named URL > destination published by management >
  the NetBird service, but only for a peer enrolled with NetBird's cloud.
  Anything else fails closed with ErrNoUploadDestination and the bundle stays
  local, which is the behaviour change: a self-hosted deployment that names no
  upload service no longer uploads at all.
- The engine keeps the published value (`Engine.DebugUploadURL`) so the bundle
  paths, which run off the engine loop, do not have to read it back out of the
  opt-in sync-response store.
- The daemon request grows `upload`, so "upload to wherever this deployment
  says" is expressible; an empty `uploadURL` no longer has to mean "no upload".
  The privilege gate is unchanged and still applies only to a URL the local
  caller named — a destination published by management is the operator naming
  their own service.
- The desktop UI stops carrying a vendor URL of its own and sends the intent.

Reported privately as GHSA-hf99-43rj-h577.
This commit is contained in:
riccardom
2026-09-10 16:38:41 +02:00
parent 08718d072c
commit 9f6d17b9e8
34 changed files with 1923 additions and 1319 deletions
Download Patch File Download Diff File Expand all files Collapse all files
client/cmd/debug.go
+32 -7
View File
@@ -2,6 +2,7 @@ package cmd
import (
"context"
"errors"
"fmt"
"strings"
"time"
@@ -19,12 +20,19 @@ import (
"github.com/netbirdio/netbird/client/proto"
"github.com/netbirdio/netbird/client/server"
mgmProto "github.com/netbirdio/netbird/shared/management/proto"
"github.com/netbirdio/netbird/upload-server/types"
"github.com/netbirdio/netbird/version"
)
const errCloseConnection = "Failed to close connection: %v"
// uploadBundleURLUsage documents that an empty flag is not "no upload" but
// "wherever this deployment says": the daemon takes the destination from the
// management server, and only falls back to the service NetBird runs for a peer
// enrolled with NetBird's cloud. Naming another one requires root, since the
// daemon fetches the URL and PUTs its own logs and state to whatever it returns.
const uploadBundleURLUsage = "Upload service URL to get an upload URL from. " +
"Defaults to the one the management server publishes; requires root when set explicitly"
var (
logFileCount uint32
systemInfoFlag bool
@@ -179,6 +187,7 @@ func debugBundle(cmd *cobra.Command, _ []string) error {
CliVersion: version.NetbirdVersion(),
}
if uploadBundleFlag {
request.Upload = true
request.UploadURL = uploadBundleURLFlag
request.UploadInsecure = uploadBundleInsecureFlag
}
@@ -192,8 +201,8 @@ func debugBundle(cmd *cobra.Command, _ []string) error {
return fmt.Errorf("upload failed: %s", resp.GetUploadFailureReason())
}
if uploadBundleFlag {
cmd.Printf("Upload file key:\n%s\n", resp.GetUploadedKey())
if err := printUploadKey(cmd, resp); err != nil {
return err
}
return nil
@@ -385,6 +394,7 @@ func runForDuration(cmd *cobra.Command, args []string) error {
CliVersion: version.NetbirdVersion(),
}
if uploadBundleFlag {
request.Upload = true
request.UploadURL = uploadBundleURLFlag
request.UploadInsecure = uploadBundleInsecureFlag
}
@@ -423,8 +433,8 @@ func runForDuration(cmd *cobra.Command, args []string) error {
return fmt.Errorf("upload failed: %s", resp.GetUploadFailureReason())
}
if uploadBundleFlag {
cmd.Printf("Upload file key:\n%s\n", resp.GetUploadedKey())
if err := printUploadKey(cmd, resp); err != nil {
return err
}
return nil
@@ -533,17 +543,32 @@ func generateDebugBundle(config *profilemanager.Config, recorder *peer.Status, c
log.Infof("Generated debug bundle from SIGUSR1 at: %s", path)
}
// printUploadKey reports the upload key, or why there is none. A daemon that
// predates the destination-from-management change ignores an empty upload URL
// and returns neither a key nor a failure reason, which would otherwise print
// as an empty key.
func printUploadKey(cmd *cobra.Command, resp *proto.DebugBundleResponse) error {
if !uploadBundleFlag {
return nil
}
if resp.GetUploadedKey() == "" {
return errors.New("the daemon did not upload the bundle; pass --upload-bundle-url explicitly or update the daemon")
}
cmd.Printf("Upload file key:\n%s\n", resp.GetUploadedKey())
return nil
}
func init() {
debugBundleCmd.Flags().Uint32VarP(&logFileCount, "log-file-count", "C", 1, "Number of rotated log files to include in debug bundle")
debugBundleCmd.Flags().BoolVarP(&systemInfoFlag, "system-info", "S", true, "Adds system information to the debug bundle")
debugBundleCmd.Flags().BoolVarP(&uploadBundleFlag, "upload-bundle", "U", false, "Uploads the debug bundle to a server")
debugBundleCmd.Flags().StringVar(&uploadBundleURLFlag, "upload-bundle-url", types.DefaultBundleURL, "Service URL to get an URL to upload the debug bundle")
debugBundleCmd.Flags().StringVar(&uploadBundleURLFlag, "upload-bundle-url", "", uploadBundleURLUsage)
debugBundleCmd.Flags().BoolVar(&uploadBundleInsecureFlag, "upload-bundle-insecure", false, "Allow uploading to an http or untrusted-TLS upload server (self-hosted); requires root")
forCmd.Flags().Uint32VarP(&logFileCount, "log-file-count", "C", 1, "Number of rotated log files to include in debug bundle")
forCmd.Flags().BoolVarP(&systemInfoFlag, "system-info", "S", true, "Adds system information to the debug bundle")
forCmd.Flags().BoolVarP(&uploadBundleFlag, "upload-bundle", "U", false, "Uploads the debug bundle to a server")
forCmd.Flags().StringVar(&uploadBundleURLFlag, "upload-bundle-url", types.DefaultBundleURL, "Service URL to get an URL to upload the debug bundle")
forCmd.Flags().StringVar(&uploadBundleURLFlag, "upload-bundle-url", "", uploadBundleURLUsage)
forCmd.Flags().BoolVar(&uploadBundleInsecureFlag, "upload-bundle-insecure", false, "Allow uploading to an http or untrusted-TLS upload server (self-hosted); requires root")
forCmd.Flags().Bool("capture", false, "Capture packets during the debug duration and include in bundle")
}