mirror of
https://github.com/netbirdio/netbird.git
synced 2026-05-31 21:19:55 +00:00
Adds a new "private" service mode for the reverse proxy: services reachable exclusively over the embedded WireGuard tunnel, gated by per-peer group membership instead of operator auth schemes. Wire contract - ProxyMapping.private (field 13): the proxy MUST call ValidateTunnelPeer and fail closed; operator schemes are bypassed. - ProxyCapabilities.private (4) + supports_private_service (5): capability gate. Management never streams private mappings to proxies that don't claim the capability; the broadcast path applies the same filter via filterMappingsForProxy. - ValidateTunnelPeer RPC: resolves an inbound tunnel IP to a peer, checks the peer's groups against service.AccessGroups, and mints a session JWT on success. checkPeerGroupAccess fails closed when a private service has empty AccessGroups. - ValidateSession/ValidateTunnelPeer responses now carry peer_group_ids + peer_group_names so the proxy can authorise policy-aware middlewares without an extra management round-trip. - ProxyInboundListener + SendStatusUpdate.inbound_listener: per-account inbound listener state surfaced to dashboards. - PathTargetOptions.direct_upstream (11): bypass the embedded NetBird client and dial the target via the proxy host's network stack for upstreams reachable without WireGuard. Data model - Service.Private (bool) + Service.AccessGroups ([]string, JSON- serialised). Validate() rejects bearer auth on private services. Copy() deep-copies AccessGroups. pgx getServices loads the columns. - DomainConfig.Private threaded into the proxy auth middleware. Request handler routes private services through forwardWithTunnelPeer and returns 403 on validation failure. - Account-level SynthesizePrivateServiceZones (synthetic DNS) and injectPrivateServicePolicies (synthetic ACL) gate on len(svc.AccessGroups) > 0. Proxy - /netbird proxy --private (embedded mode) flag; Config.Private in proxy/lifecycle.go. - Per-account inbound listener (proxy/inbound.go) binding HTTP/HTTPS on the embedded NetBird client's WireGuard tunnel netstack. - proxy/internal/auth/tunnel_cache: ValidateTunnelPeer response cache with single-flight de-duplication and per-account eviction. - Local peerstore short-circuit: when the inbound IP isn't in the account roster, deny fast without an RPC. - proxy/server.go reports SupportsPrivateService=true and redacts the full ProxyMapping JSON from info logs (auth_token + header-auth hashed values now only at debug level). Identity forwarding - ValidateSessionJWT returns user_id, email, method, groups, group_names. sessionkey.Claims carries Email + Groups + GroupNames so the proxy can stamp identity onto upstream requests without an extra management round-trip on every cookie-bearing request. - CapturedData carries userEmail / userGroups / userGroupNames; the proxy stamps X-NetBird-User and X-NetBird-Groups on r.Out from the authenticated identity (strips client-supplied values first to prevent spoofing). - AccessLog.UserGroups: access-log enrichment captures the user's group memberships at write time so the dashboard can render group context without reverse-resolving stale memberships. OpenAPI/dashboard surface - ReverseProxyService gains private + access_groups; ReverseProxyCluster gains private + supports_private. ReverseProxyTarget target_type enum gains "cluster". ServiceTargetOptions gains direct_upstream. ProxyAccessLog gains user_groups.
113 lines
4.3 KiB
Go
113 lines
4.3 KiB
Go
package roundtrip
|
|
|
|
import (
|
|
"crypto/tls"
|
|
"errors"
|
|
"net"
|
|
"net/http"
|
|
"time"
|
|
|
|
log "github.com/sirupsen/logrus"
|
|
)
|
|
|
|
// MultiTransport dispatches each request to either the embedded NetBird
|
|
// http.RoundTripper or a stdlib http.Transport based on a per-request
|
|
// context flag set by the reverse-proxy rewrite step. When the flag is
|
|
// absent (the default for every existing target), requests follow the
|
|
// embedded NetBird path — current behaviour, preserved.
|
|
//
|
|
// The stdlib branch is used when a target was configured with
|
|
// direct_upstream=true. It dials via the host's network stack, which is
|
|
// what private (`netbird proxy`) deployments and centralised proxies
|
|
// fronting host-reachable upstreams (public APIs, LAN services,
|
|
// localhost sidecars) want.
|
|
//
|
|
// An embedded roundtripper is required. To run direct-only (no WG
|
|
// branch at all), construct the MultiTransport via NewDirectOnly.
|
|
type MultiTransport struct {
|
|
embedded http.RoundTripper
|
|
direct *http.Transport
|
|
insecure *http.Transport
|
|
}
|
|
|
|
// errNoEmbeddedTransport is returned when a request reaches the
|
|
// embedded branch on a MultiTransport that wasn't given one. Surfaces
|
|
// the misconfiguration to the caller instead of silently routing to
|
|
// the direct branch, which would bypass the WG tunnel.
|
|
var errNoEmbeddedTransport = errors.New("multitransport: embedded roundtripper not configured")
|
|
|
|
// NewMultiTransport wires both branches. embedded is the existing NetBird
|
|
// roundtripper and must not be nil — pass to NewDirectOnly for a
|
|
// MultiTransport that only ever uses the direct branch. The direct
|
|
// branches honour the same NB_PROXY_* tuning env vars as the embedded
|
|
// transport (see loadTransportConfig) plus a dial-timeout wrapper that
|
|
// respects types.WithDialTimeout.
|
|
func NewMultiTransport(embedded http.RoundTripper, logger *log.Logger) *MultiTransport {
|
|
if logger == nil {
|
|
logger = log.StandardLogger()
|
|
}
|
|
cfg := loadTransportConfig(logger)
|
|
dialer := &net.Dialer{
|
|
Timeout: 30 * time.Second,
|
|
KeepAlive: 30 * time.Second,
|
|
}
|
|
direct := &http.Transport{
|
|
DialContext: dialWithTimeout(dialer.DialContext),
|
|
ForceAttemptHTTP2: true,
|
|
MaxIdleConns: cfg.maxIdleConns,
|
|
MaxIdleConnsPerHost: cfg.maxIdleConnsPerHost,
|
|
MaxConnsPerHost: cfg.maxConnsPerHost,
|
|
IdleConnTimeout: cfg.idleConnTimeout,
|
|
TLSHandshakeTimeout: cfg.tlsHandshakeTimeout,
|
|
ExpectContinueTimeout: cfg.expectContinueTimeout,
|
|
ResponseHeaderTimeout: cfg.responseHeaderTimeout,
|
|
WriteBufferSize: cfg.writeBufferSize,
|
|
ReadBufferSize: cfg.readBufferSize,
|
|
DisableCompression: cfg.disableCompression,
|
|
}
|
|
insecure := direct.Clone()
|
|
insecure.TLSClientConfig = &tls.Config{InsecureSkipVerify: true} //nolint:gosec // matches the embedded NetBird transport's per-target opt-in
|
|
|
|
return &MultiTransport{
|
|
embedded: embedded,
|
|
direct: direct,
|
|
insecure: insecure,
|
|
}
|
|
}
|
|
|
|
// NewDirectOnly returns a MultiTransport with no embedded branch.
|
|
// Every request goes through the direct branch regardless of the
|
|
// per-request flag, so the embedded path can never be reached
|
|
// silently — wiring code that needs WG must use NewMultiTransport.
|
|
func NewDirectOnly(logger *log.Logger) *MultiTransport {
|
|
return NewMultiTransport(noEmbeddedRoundTripper{}, logger)
|
|
}
|
|
|
|
// noEmbeddedRoundTripper is the sentinel embedded transport for
|
|
// direct-only MultiTransports. RoundTrip is never called in practice
|
|
// because the direct branch matches every request, but if anything
|
|
// ever did reach this path it would fail loudly instead of falling
|
|
// back to direct.
|
|
type noEmbeddedRoundTripper struct{}
|
|
|
|
func (noEmbeddedRoundTripper) RoundTrip(*http.Request) (*http.Response, error) {
|
|
return nil, errNoEmbeddedTransport
|
|
}
|
|
|
|
// RoundTrip dispatches by reading the direct-upstream flag from the request
|
|
// context. When set, the request is forwarded via the stdlib transport,
|
|
// honouring the existing per-request skip-TLS-verify flag. Otherwise it
|
|
// goes through the embedded NetBird roundtripper.
|
|
func (m *MultiTransport) RoundTrip(req *http.Request) (*http.Response, error) {
|
|
if DirectUpstreamFromContext(req.Context()) {
|
|
if skipTLSVerifyFromContext(req.Context()) {
|
|
return m.insecure.RoundTrip(req)
|
|
}
|
|
return m.direct.RoundTrip(req)
|
|
}
|
|
if m.embedded == nil {
|
|
return nil, errNoEmbeddedTransport
|
|
}
|
|
return m.embedded.RoundTrip(req)
|
|
}
|