mirror of
https://github.com/netbirdio/netbird.git
synced 2026-05-21 08:09: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.
158 lines
5.1 KiB
Go
158 lines
5.1 KiB
Go
package manager
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
type mockProxyManager struct {
|
|
getActiveClusterAddressesFunc func(ctx context.Context) ([]string, error)
|
|
getActiveClusterAddressesForAccountFunc func(ctx context.Context, accountID string) ([]string, error)
|
|
}
|
|
|
|
func (m *mockProxyManager) GetActiveClusterAddresses(ctx context.Context) ([]string, error) {
|
|
if m.getActiveClusterAddressesFunc != nil {
|
|
return m.getActiveClusterAddressesFunc(ctx)
|
|
}
|
|
return nil, nil
|
|
}
|
|
|
|
func (m *mockProxyManager) GetActiveClusterAddressesForAccount(ctx context.Context, accountID string) ([]string, error) {
|
|
if m.getActiveClusterAddressesForAccountFunc != nil {
|
|
return m.getActiveClusterAddressesForAccountFunc(ctx, accountID)
|
|
}
|
|
return nil, nil
|
|
}
|
|
|
|
func (m *mockProxyManager) ClusterSupportsCustomPorts(_ context.Context, _ string) *bool {
|
|
return nil
|
|
}
|
|
|
|
func (m *mockProxyManager) ClusterRequireSubdomain(_ context.Context, _ string) *bool {
|
|
return nil
|
|
}
|
|
|
|
func (m *mockProxyManager) ClusterSupportsCrowdSec(_ context.Context, _ string) *bool {
|
|
return nil
|
|
}
|
|
|
|
func (m *mockProxyManager) ClusterSupportsPrivate(_ context.Context, _ string) *bool {
|
|
return nil
|
|
}
|
|
|
|
func TestGetClusterAllowList_BYOPMergedWithPublic(t *testing.T) {
|
|
pm := &mockProxyManager{
|
|
getActiveClusterAddressesForAccountFunc: func(_ context.Context, accID string) ([]string, error) {
|
|
assert.Equal(t, "acc-123", accID)
|
|
return []string{"byop.example.com"}, nil
|
|
},
|
|
getActiveClusterAddressesFunc: func(_ context.Context) ([]string, error) {
|
|
return []string{"eu.proxy.netbird.io"}, nil
|
|
},
|
|
}
|
|
|
|
mgr := Manager{proxyManager: pm}
|
|
result, err := mgr.getClusterAllowList(context.Background(), "acc-123")
|
|
require.NoError(t, err)
|
|
assert.Equal(t, []string{"byop.example.com", "eu.proxy.netbird.io"}, result)
|
|
}
|
|
|
|
func TestGetClusterAllowList_DeduplicatesBYOPAndPublic(t *testing.T) {
|
|
pm := &mockProxyManager{
|
|
getActiveClusterAddressesForAccountFunc: func(_ context.Context, _ string) ([]string, error) {
|
|
return []string{"shared.example.com", "byop.example.com"}, nil
|
|
},
|
|
getActiveClusterAddressesFunc: func(_ context.Context) ([]string, error) {
|
|
return []string{"shared.example.com", "eu.proxy.netbird.io"}, nil
|
|
},
|
|
}
|
|
|
|
mgr := Manager{proxyManager: pm}
|
|
result, err := mgr.getClusterAllowList(context.Background(), "acc-123")
|
|
require.NoError(t, err)
|
|
assert.Equal(t, []string{"shared.example.com", "byop.example.com", "eu.proxy.netbird.io"}, result)
|
|
}
|
|
|
|
func TestGetClusterAllowList_NoBYOP_FallbackToShared(t *testing.T) {
|
|
pm := &mockProxyManager{
|
|
getActiveClusterAddressesForAccountFunc: func(_ context.Context, _ string) ([]string, error) {
|
|
return nil, nil
|
|
},
|
|
getActiveClusterAddressesFunc: func(_ context.Context) ([]string, error) {
|
|
return []string{"eu.proxy.netbird.io", "us.proxy.netbird.io"}, nil
|
|
},
|
|
}
|
|
|
|
mgr := Manager{proxyManager: pm}
|
|
result, err := mgr.getClusterAllowList(context.Background(), "acc-123")
|
|
require.NoError(t, err)
|
|
assert.Equal(t, []string{"eu.proxy.netbird.io", "us.proxy.netbird.io"}, result)
|
|
}
|
|
|
|
func TestGetClusterAllowList_BYOPError_ReturnsError(t *testing.T) {
|
|
pm := &mockProxyManager{
|
|
getActiveClusterAddressesForAccountFunc: func(_ context.Context, _ string) ([]string, error) {
|
|
return nil, errors.New("db error")
|
|
},
|
|
}
|
|
|
|
mgr := Manager{proxyManager: pm}
|
|
result, err := mgr.getClusterAllowList(context.Background(), "acc-123")
|
|
require.Error(t, err)
|
|
assert.Nil(t, result)
|
|
assert.Contains(t, err.Error(), "BYOP cluster addresses")
|
|
}
|
|
|
|
func TestGetClusterAllowList_PublicError_ReturnsError(t *testing.T) {
|
|
pm := &mockProxyManager{
|
|
getActiveClusterAddressesForAccountFunc: func(_ context.Context, _ string) ([]string, error) {
|
|
return []string{"byop.example.com"}, nil
|
|
},
|
|
getActiveClusterAddressesFunc: func(_ context.Context) ([]string, error) {
|
|
return nil, errors.New("db error")
|
|
},
|
|
}
|
|
|
|
mgr := Manager{proxyManager: pm}
|
|
result, err := mgr.getClusterAllowList(context.Background(), "acc-123")
|
|
require.Error(t, err)
|
|
assert.Nil(t, result)
|
|
assert.Contains(t, err.Error(), "public cluster addresses")
|
|
}
|
|
|
|
func TestGetClusterAllowList_BYOPEmptySlice_FallbackToShared(t *testing.T) {
|
|
pm := &mockProxyManager{
|
|
getActiveClusterAddressesForAccountFunc: func(_ context.Context, _ string) ([]string, error) {
|
|
return []string{}, nil
|
|
},
|
|
getActiveClusterAddressesFunc: func(_ context.Context) ([]string, error) {
|
|
return []string{"eu.proxy.netbird.io"}, nil
|
|
},
|
|
}
|
|
|
|
mgr := Manager{proxyManager: pm}
|
|
result, err := mgr.getClusterAllowList(context.Background(), "acc-123")
|
|
require.NoError(t, err)
|
|
assert.Equal(t, []string{"eu.proxy.netbird.io"}, result)
|
|
}
|
|
|
|
func TestGetClusterAllowList_PublicEmpty_BYOPOnly(t *testing.T) {
|
|
pm := &mockProxyManager{
|
|
getActiveClusterAddressesForAccountFunc: func(_ context.Context, _ string) ([]string, error) {
|
|
return []string{"byop.example.com"}, nil
|
|
},
|
|
getActiveClusterAddressesFunc: func(_ context.Context) ([]string, error) {
|
|
return nil, nil
|
|
},
|
|
}
|
|
|
|
mgr := Manager{proxyManager: pm}
|
|
result, err := mgr.getClusterAllowList(context.Background(), "acc-123")
|
|
require.NoError(t, err)
|
|
assert.Equal(t, []string{"byop.example.com"}, result)
|
|
}
|