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.
135 lines
5.0 KiB
Go
135 lines
5.0 KiB
Go
package roundtrip
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
// stubRoundTripper records whether RoundTrip was called and returns a
|
|
// canned response so tests can assert the dispatch decision without
|
|
// running a real network.
|
|
type stubRoundTripper struct {
|
|
called bool
|
|
body string
|
|
}
|
|
|
|
func (s *stubRoundTripper) RoundTrip(_ *http.Request) (*http.Response, error) {
|
|
s.called = true
|
|
return &http.Response{
|
|
StatusCode: http.StatusOK,
|
|
Body: io.NopCloser(strings.NewReader(s.body)),
|
|
Header: http.Header{},
|
|
}, nil
|
|
}
|
|
|
|
func TestMultiTransport_DispatchesByContextFlag(t *testing.T) {
|
|
embedded := &stubRoundTripper{body: "embedded"}
|
|
mt := NewMultiTransport(embedded, nil)
|
|
|
|
t.Run("default routes to embedded", func(t *testing.T) {
|
|
embedded.called = false
|
|
req := httptest.NewRequest(http.MethodGet, "http://example.invalid", nil)
|
|
resp, err := mt.RoundTrip(req)
|
|
require.NoError(t, err, "embedded path must not error on stubbed transport")
|
|
require.NotNil(t, resp)
|
|
_ = resp.Body.Close()
|
|
assert.True(t, embedded.called, "request without WithDirectUpstream must hit the embedded transport")
|
|
})
|
|
|
|
t.Run("WithDirectUpstream skips embedded", func(t *testing.T) {
|
|
embedded.called = false
|
|
// Hit a server we control to verify the stdlib transport is used.
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
|
_, _ = io.WriteString(w, "direct")
|
|
}))
|
|
defer srv.Close()
|
|
|
|
req, err := http.NewRequestWithContext(WithDirectUpstream(context.Background()), http.MethodGet, srv.URL, nil)
|
|
require.NoError(t, err)
|
|
resp, err := mt.RoundTrip(req)
|
|
require.NoError(t, err, "direct path must dial via stdlib transport")
|
|
body, err := io.ReadAll(resp.Body)
|
|
_ = resp.Body.Close()
|
|
require.NoError(t, err)
|
|
assert.Equal(t, "direct", string(body), "stdlib transport must reach the test server")
|
|
assert.False(t, embedded.called, "WithDirectUpstream must bypass the embedded transport")
|
|
})
|
|
}
|
|
|
|
// TestMultiTransport_AppliesEnvOverridesToDirect verifies that the
|
|
// NB_PROXY_* env vars consumed by loadTransportConfig flow into the
|
|
// direct branches (previously they only applied to the embedded
|
|
// roundtripper, so direct-upstream traffic ignored operator tuning).
|
|
func TestMultiTransport_AppliesEnvOverridesToDirect(t *testing.T) {
|
|
t.Setenv(EnvMaxIdleConns, "42")
|
|
t.Setenv(EnvIdleConnTimeout, "11s")
|
|
t.Setenv(EnvTLSHandshakeTimeout, "7s")
|
|
|
|
mt := NewMultiTransport(&stubRoundTripper{body: "embedded"}, nil)
|
|
|
|
assert.Equal(t, 42, mt.direct.MaxIdleConns,
|
|
"NB_PROXY_MAX_IDLE_CONNS must propagate to the direct transport")
|
|
assert.Equal(t, 11*time.Second, mt.direct.IdleConnTimeout,
|
|
"NB_PROXY_IDLE_CONN_TIMEOUT must propagate to the direct transport")
|
|
assert.Equal(t, 7*time.Second, mt.direct.TLSHandshakeTimeout,
|
|
"NB_PROXY_TLS_HANDSHAKE_TIMEOUT must propagate to the direct transport")
|
|
assert.Equal(t, 42, mt.insecure.MaxIdleConns,
|
|
"env tuning must also apply to the insecure-skip-verify direct transport")
|
|
}
|
|
|
|
// TestMultiTransport_NilEmbeddedErrorsWhenWGPathRequested guards
|
|
// against the previous silent fallback: a MultiTransport constructed
|
|
// without an embedded transport must reject requests that don't
|
|
// explicitly opt into the direct branch, rather than routing them
|
|
// over the host stack and bypassing WireGuard.
|
|
func TestMultiTransport_NilEmbeddedErrorsWhenWGPathRequested(t *testing.T) {
|
|
mt := NewMultiTransport(nil, nil)
|
|
|
|
req := httptest.NewRequest(http.MethodGet, "http://example.invalid", nil)
|
|
resp, err := mt.RoundTrip(req)
|
|
if resp != nil {
|
|
_ = resp.Body.Close()
|
|
}
|
|
require.Error(t, err, "nil embedded must surface as an explicit error, not a silent direct dispatch")
|
|
assert.Nil(t, resp)
|
|
assert.ErrorIs(t, err, errNoEmbeddedTransport,
|
|
"the error must be the sentinel so callers can distinguish misconfiguration from network failures")
|
|
}
|
|
|
|
// TestMultiTransport_DirectOnlyServesDirectBranch verifies NewDirectOnly
|
|
// constructs a MultiTransport whose direct branch handles requests with
|
|
// the direct-upstream flag set, and surfaces the explicit sentinel
|
|
// when the embedded path is reached.
|
|
func TestMultiTransport_DirectOnlyServesDirectBranch(t *testing.T) {
|
|
mt := NewDirectOnly(nil)
|
|
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
|
_, _ = io.WriteString(w, "ok")
|
|
}))
|
|
defer srv.Close()
|
|
|
|
req, err := http.NewRequestWithContext(WithDirectUpstream(context.Background()), http.MethodGet, srv.URL, nil)
|
|
require.NoError(t, err)
|
|
resp, err := mt.RoundTrip(req)
|
|
require.NoError(t, err, "direct-only must serve requests that opt into the direct branch")
|
|
_ = resp.Body.Close()
|
|
assert.Equal(t, http.StatusOK, resp.StatusCode)
|
|
|
|
wgReq := httptest.NewRequest(http.MethodGet, "http://example.invalid", nil)
|
|
resp, err = mt.RoundTrip(wgReq)
|
|
if resp != nil {
|
|
_ = resp.Body.Close()
|
|
}
|
|
require.Error(t, err, "direct-only must refuse requests that didn't opt into the direct branch")
|
|
assert.Nil(t, resp)
|
|
assert.ErrorIs(t, err, errNoEmbeddedTransport)
|
|
}
|