mirror of
https://github.com/netbirdio/netbird.git
synced 2026-09-12 17:59:06 +02:00
riccardom
9f6d17b9e8
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.
85 lines
2.2 KiB
Go
85 lines
2.2 KiB
Go
package jobexec
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"time"
|
|
|
|
log "github.com/sirupsen/logrus"
|
|
|
|
"github.com/netbirdio/netbird/client/internal/debug"
|
|
)
|
|
|
|
const (
|
|
MaxBundleWaitTime = 60 * time.Minute // maximum wait time for bundle generation (1 hour)
|
|
)
|
|
|
|
var (
|
|
ErrJobNotImplemented = errors.New("job not implemented")
|
|
)
|
|
|
|
type Executor struct {
|
|
}
|
|
|
|
func NewExecutor() *Executor {
|
|
return &Executor{}
|
|
}
|
|
|
|
// BundleJob generates a debug bundle for a remote job and uploads it to
|
|
// uploadURL, returning the key the management server hands back to whoever asked.
|
|
// The caller resolves uploadURL (see debug.ResolveUploadURL): a job whose
|
|
// deployment names no upload service never reaches here, so there is no
|
|
// fallback destination to pick locally.
|
|
func (e *Executor) BundleJob(ctx context.Context, debugBundleDependencies debug.GeneratorDependencies, params debug.BundleConfig, waitForDuration time.Duration, mgmURL, uploadURL string) (string, error) {
|
|
if uploadURL == "" {
|
|
return "", debug.ErrNoUploadDestination
|
|
}
|
|
|
|
if waitForDuration > MaxBundleWaitTime {
|
|
log.Warnf("bundle wait time %v exceeds maximum %v, capping to maximum", waitForDuration, MaxBundleWaitTime)
|
|
waitForDuration = MaxBundleWaitTime
|
|
}
|
|
|
|
if waitForDuration > 0 {
|
|
if err := waitFor(ctx, waitForDuration); err != nil {
|
|
return "", err
|
|
}
|
|
}
|
|
|
|
log.Infof("execute debug bundle generation")
|
|
|
|
bundleGenerator := debug.NewBundleGenerator(debugBundleDependencies, params)
|
|
|
|
path, err := bundleGenerator.Generate()
|
|
if err != nil {
|
|
return "", fmt.Errorf("generate debug bundle: %w", err)
|
|
}
|
|
defer func() {
|
|
if err := os.Remove(path); err != nil {
|
|
log.Errorf("failed to remove debug bundle file: %v", err)
|
|
}
|
|
}()
|
|
|
|
key, err := debug.UploadDebugBundle(ctx, uploadURL, mgmURL, path, false)
|
|
if err != nil {
|
|
log.Errorf("failed to upload debug bundle: %v", err)
|
|
return "", fmt.Errorf("upload debug bundle: %w", err)
|
|
}
|
|
|
|
log.Infof("debug bundle has been generated successfully")
|
|
return key, nil
|
|
}
|
|
|
|
func waitFor(ctx context.Context, duration time.Duration) error {
|
|
log.Infof("wait for %v minutes before executing debug bundle", duration.Minutes())
|
|
select {
|
|
case <-time.After(duration):
|
|
return nil
|
|
case <-ctx.Done():
|
|
log.Infof("wait cancelled: %v", ctx.Err())
|
|
return ctx.Err()
|
|
}
|
|
}
|