mirror of
https://github.com/netbirdio/netbird.git
synced 2026-05-30 12:39:54 +00:00
7aebdd69dd
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.
48 lines
1.6 KiB
Go
48 lines
1.6 KiB
Go
package auth
|
|
|
|
import (
|
|
"context"
|
|
"net/netip"
|
|
)
|
|
|
|
// PeerIdentity describes the locally-known facts about a peer reachable on
|
|
// the proxy's per-account WireGuard listener. Phase 3 fills PubKey, TunnelIP
|
|
// and FQDN from the embedded client's peerstore. UserID, Email and Groups
|
|
// stay zero in V1 — full identity still travels through ValidateTunnelPeer.
|
|
// Phase V2 will populate them once RemotePeerConfig carries user identity.
|
|
type PeerIdentity struct {
|
|
PubKey string
|
|
TunnelIP netip.Addr
|
|
FQDN string
|
|
|
|
// V2 fields (zero in V1).
|
|
UserID string
|
|
Email string
|
|
Groups []string
|
|
}
|
|
|
|
// TunnelLookupFunc resolves a tunnel IP to a peer identity using locally
|
|
// available peerstore data. ok=false means the IP is not in the calling
|
|
// account's roster.
|
|
type TunnelLookupFunc func(ip netip.Addr) (PeerIdentity, bool)
|
|
|
|
type tunnelLookupContextKey struct{}
|
|
|
|
// WithTunnelLookup attaches a per-account peerstore lookup function to
|
|
// the request context. The auth middleware calls this lookup before
|
|
// hitting management's ValidateTunnelPeer to short-circuit unknown IPs
|
|
// and to skip the RPC for already-cached identities.
|
|
func WithTunnelLookup(ctx context.Context, lookup TunnelLookupFunc) context.Context {
|
|
if lookup == nil {
|
|
return ctx
|
|
}
|
|
return context.WithValue(ctx, tunnelLookupContextKey{}, lookup)
|
|
}
|
|
|
|
// TunnelLookupFromContext returns the peerstore lookup attached to ctx,
|
|
// or nil when the request did not arrive on a per-account listener.
|
|
func TunnelLookupFromContext(ctx context.Context) TunnelLookupFunc {
|
|
v, _ := ctx.Value(tunnelLookupContextKey{}).(TunnelLookupFunc)
|
|
return v
|
|
}
|