mirror of
https://github.com/netbirdio/netbird.git
synced 2026-09-17 12:19:07 +02:00
[management, client, proxy] add expose NetBird-only services over tunnel peers (#6226)
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.
This commit is contained in:
@@ -86,6 +86,9 @@ func (p *ReverseProxy) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||
if pt.RequestTimeout > 0 {
|
||||
ctx = types.WithDialTimeout(ctx, pt.RequestTimeout)
|
||||
}
|
||||
if pt.DirectUpstream {
|
||||
ctx = roundtrip.WithDirectUpstream(ctx)
|
||||
}
|
||||
|
||||
rewriteMatchedPath := result.matchedPath
|
||||
if pt.PathRewrite == PathRewritePreserve {
|
||||
@@ -142,6 +145,8 @@ func (p *ReverseProxy) rewriteFunc(target *url.URL, matchedPath string, passHost
|
||||
r.Out.Header.Set(k, v)
|
||||
}
|
||||
|
||||
stampNetBirdIdentity(r)
|
||||
|
||||
clientIP := extractHostIP(r.In.RemoteAddr)
|
||||
|
||||
if isTrustedAddr(clientIP, p.trustedProxies) {
|
||||
@@ -426,3 +431,70 @@ func opErrorContains(err error, substr string) bool {
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
const (
|
||||
// headerNetBirdUser carries the authenticated user's display identity
|
||||
// (email when the peer is attached to a user, else peer name) onto
|
||||
// upstream requests. Stripped from inbound requests before stamping
|
||||
// so a client can't spoof identity by setting the header themselves.
|
||||
headerNetBirdUser = "X-NetBird-User"
|
||||
// headerNetBirdGroups carries the user's group display names as a
|
||||
// comma-separated list. Falls back to group IDs at positions where a
|
||||
// name wasn't available at session-mint time. Labels containing a
|
||||
// comma or any non-printable byte are dropped at stamp time so the
|
||||
// list is unambiguously splittable by consumers.
|
||||
headerNetBirdGroups = "X-NetBird-Groups"
|
||||
)
|
||||
|
||||
// isHeaderValueSafe reports whether v is a valid RFC 7230 field-value:
|
||||
// VCHAR (0x21-0x7E), SP (0x20), or HTAB (0x09). Empty values are
|
||||
// rejected; the caller decides whether to omit the header entirely.
|
||||
func isHeaderValueSafe(v string) bool {
|
||||
if v == "" {
|
||||
return false
|
||||
}
|
||||
for i := 0; i < len(v); i++ {
|
||||
c := v[i]
|
||||
if c == '\t' || (c >= 0x20 && c <= 0x7E) {
|
||||
continue
|
||||
}
|
||||
return false
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
// stampNetBirdIdentity injects authenticated identity onto outbound
|
||||
// requests as X-NetBird-User and X-NetBird-Groups. Always strips any
|
||||
// client-sent values first (anti-spoof). Skips when the request didn't
|
||||
// carry CapturedData (early-path errors, internal endpoints).
|
||||
func stampNetBirdIdentity(r *httputil.ProxyRequest) {
|
||||
r.Out.Header.Del(headerNetBirdUser)
|
||||
r.Out.Header.Del(headerNetBirdGroups)
|
||||
|
||||
cd := CapturedDataFromContext(r.In.Context())
|
||||
if cd == nil {
|
||||
return
|
||||
}
|
||||
if email := cd.GetUserEmail(); isHeaderValueSafe(email) {
|
||||
r.Out.Header.Set(headerNetBirdUser, email)
|
||||
}
|
||||
groupIDs := cd.GetUserGroups()
|
||||
if len(groupIDs) == 0 {
|
||||
return
|
||||
}
|
||||
groupNames := cd.GetUserGroupNames()
|
||||
labels := make([]string, 0, len(groupIDs))
|
||||
for i, id := range groupIDs {
|
||||
label := id
|
||||
if i < len(groupNames) && groupNames[i] != "" {
|
||||
label = groupNames[i]
|
||||
}
|
||||
if !isHeaderValueSafe(label) || strings.ContainsRune(label, ',') {
|
||||
continue
|
||||
}
|
||||
labels = append(labels, label)
|
||||
}
|
||||
if len(labels) > 0 {
|
||||
r.Out.Header.Set(headerNetBirdGroups, strings.Join(labels, ","))
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user