mirror of
https://github.com/netbirdio/netbird.git
synced 2026-05-31 13: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.
273 lines
9.2 KiB
Go
273 lines
9.2 KiB
Go
//go:build integration
|
|
|
|
package rest_test
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"io"
|
|
"net/http"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/netbirdio/netbird/shared/management/client/rest"
|
|
"github.com/netbirdio/netbird/shared/management/http/api"
|
|
"github.com/netbirdio/netbird/shared/management/http/util"
|
|
)
|
|
|
|
var testServiceTarget = api.ServiceTarget{
|
|
TargetId: "peer-123",
|
|
TargetType: "peer",
|
|
Protocol: "https",
|
|
Port: 8443,
|
|
Enabled: true,
|
|
}
|
|
|
|
var testService = api.Service{
|
|
Id: "svc-1",
|
|
Name: "test-service",
|
|
Domain: "test.example.com",
|
|
Enabled: true,
|
|
Auth: api.ServiceAuthConfig{},
|
|
Meta: api.ServiceMeta{
|
|
CreatedAt: time.Date(2026, 1, 1, 0, 0, 0, 0, time.UTC),
|
|
Status: "active",
|
|
},
|
|
Targets: []api.ServiceTarget{testServiceTarget},
|
|
}
|
|
|
|
func TestReverseProxyServices_List_200(t *testing.T) {
|
|
withMockClient(func(c *rest.Client, mux *http.ServeMux) {
|
|
mux.HandleFunc("/api/reverse-proxies/services", func(w http.ResponseWriter, r *http.Request) {
|
|
retBytes, _ := json.Marshal([]api.Service{testService})
|
|
_, err := w.Write(retBytes)
|
|
require.NoError(t, err)
|
|
})
|
|
ret, err := c.ReverseProxyServices.List(context.Background())
|
|
require.NoError(t, err)
|
|
require.Len(t, ret, 1)
|
|
assert.Equal(t, testService.Id, ret[0].Id)
|
|
assert.Equal(t, testService.Name, ret[0].Name)
|
|
})
|
|
}
|
|
|
|
func TestReverseProxyServices_List_Err(t *testing.T) {
|
|
withMockClient(func(c *rest.Client, mux *http.ServeMux) {
|
|
mux.HandleFunc("/api/reverse-proxies/services", func(w http.ResponseWriter, r *http.Request) {
|
|
retBytes, _ := json.Marshal(util.ErrorResponse{Message: "No", Code: 400})
|
|
w.WriteHeader(400)
|
|
_, err := w.Write(retBytes)
|
|
require.NoError(t, err)
|
|
})
|
|
ret, err := c.ReverseProxyServices.List(context.Background())
|
|
assert.Error(t, err)
|
|
assert.Equal(t, "No", err.Error())
|
|
assert.Empty(t, ret)
|
|
})
|
|
}
|
|
|
|
func TestReverseProxyServices_Get_200(t *testing.T) {
|
|
withMockClient(func(c *rest.Client, mux *http.ServeMux) {
|
|
mux.HandleFunc("/api/reverse-proxies/services/svc-1", func(w http.ResponseWriter, r *http.Request) {
|
|
retBytes, _ := json.Marshal(testService)
|
|
_, err := w.Write(retBytes)
|
|
require.NoError(t, err)
|
|
})
|
|
ret, err := c.ReverseProxyServices.Get(context.Background(), "svc-1")
|
|
require.NoError(t, err)
|
|
assert.Equal(t, testService.Id, ret.Id)
|
|
assert.Equal(t, testService.Domain, ret.Domain)
|
|
})
|
|
}
|
|
|
|
func TestReverseProxyServices_Get_Err(t *testing.T) {
|
|
withMockClient(func(c *rest.Client, mux *http.ServeMux) {
|
|
mux.HandleFunc("/api/reverse-proxies/services/svc-1", func(w http.ResponseWriter, r *http.Request) {
|
|
retBytes, _ := json.Marshal(util.ErrorResponse{Message: "No", Code: 404})
|
|
w.WriteHeader(404)
|
|
_, err := w.Write(retBytes)
|
|
require.NoError(t, err)
|
|
})
|
|
ret, err := c.ReverseProxyServices.Get(context.Background(), "svc-1")
|
|
assert.Error(t, err)
|
|
assert.Equal(t, "No", err.Error())
|
|
assert.Nil(t, ret)
|
|
})
|
|
}
|
|
|
|
func TestReverseProxyServices_Create_200(t *testing.T) {
|
|
withMockClient(func(c *rest.Client, mux *http.ServeMux) {
|
|
mux.HandleFunc("/api/reverse-proxies/services", func(w http.ResponseWriter, r *http.Request) {
|
|
assert.Equal(t, "POST", r.Method)
|
|
reqBytes, err := io.ReadAll(r.Body)
|
|
require.NoError(t, err)
|
|
var req api.ServiceRequest
|
|
require.NoError(t, json.Unmarshal(reqBytes, &req))
|
|
assert.Equal(t, "test-service", req.Name)
|
|
assert.Equal(t, "test.example.com", req.Domain)
|
|
retBytes, _ := json.Marshal(testService)
|
|
_, err = w.Write(retBytes)
|
|
require.NoError(t, err)
|
|
})
|
|
ret, err := c.ReverseProxyServices.Create(context.Background(), api.PostApiReverseProxiesServicesJSONRequestBody{
|
|
Name: "test-service",
|
|
Domain: "test.example.com",
|
|
Enabled: true,
|
|
Auth: &api.ServiceAuthConfig{},
|
|
Targets: &[]api.ServiceTarget{testServiceTarget},
|
|
})
|
|
require.NoError(t, err)
|
|
assert.Equal(t, testService.Id, ret.Id)
|
|
})
|
|
}
|
|
|
|
func TestReverseProxyServices_Create_Err(t *testing.T) {
|
|
withMockClient(func(c *rest.Client, mux *http.ServeMux) {
|
|
mux.HandleFunc("/api/reverse-proxies/services", func(w http.ResponseWriter, r *http.Request) {
|
|
retBytes, _ := json.Marshal(util.ErrorResponse{Message: "No", Code: 400})
|
|
w.WriteHeader(400)
|
|
_, err := w.Write(retBytes)
|
|
require.NoError(t, err)
|
|
})
|
|
ret, err := c.ReverseProxyServices.Create(context.Background(), api.PostApiReverseProxiesServicesJSONRequestBody{
|
|
Name: "test-service",
|
|
Domain: "test.example.com",
|
|
Enabled: true,
|
|
Auth: &api.ServiceAuthConfig{},
|
|
Targets: &[]api.ServiceTarget{testServiceTarget},
|
|
})
|
|
assert.Error(t, err)
|
|
assert.Equal(t, "No", err.Error())
|
|
assert.Nil(t, ret)
|
|
})
|
|
}
|
|
|
|
func TestReverseProxyServices_Create_WithPerTargetOptions(t *testing.T) {
|
|
withMockClient(func(c *rest.Client, mux *http.ServeMux) {
|
|
mux.HandleFunc("/api/reverse-proxies/services", func(w http.ResponseWriter, r *http.Request) {
|
|
assert.Equal(t, "POST", r.Method)
|
|
reqBytes, err := io.ReadAll(r.Body)
|
|
require.NoError(t, err)
|
|
var req api.ServiceRequest
|
|
require.NoError(t, json.Unmarshal(reqBytes, &req))
|
|
|
|
require.NotNil(t, req.Targets, "targets must be set on the request")
|
|
require.Len(t, *req.Targets, 1)
|
|
target := (*req.Targets)[0]
|
|
require.NotNil(t, target.Options, "options should be present")
|
|
opts := target.Options
|
|
require.NotNil(t, opts.SkipTlsVerify, "skip_tls_verify should be present")
|
|
assert.True(t, *opts.SkipTlsVerify)
|
|
require.NotNil(t, opts.RequestTimeout, "request_timeout should be present")
|
|
assert.Equal(t, "30s", *opts.RequestTimeout)
|
|
require.NotNil(t, opts.PathRewrite, "path_rewrite should be present")
|
|
assert.Equal(t, api.ServiceTargetOptionsPathRewrite("preserve"), *opts.PathRewrite)
|
|
require.NotNil(t, opts.CustomHeaders, "custom_headers should be present")
|
|
assert.Equal(t, "bar", (*opts.CustomHeaders)["X-Foo"])
|
|
|
|
retBytes, _ := json.Marshal(testService)
|
|
_, err = w.Write(retBytes)
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
pathRewrite := api.ServiceTargetOptionsPathRewrite("preserve")
|
|
ret, err := c.ReverseProxyServices.Create(context.Background(), api.PostApiReverseProxiesServicesJSONRequestBody{
|
|
Name: "test-service",
|
|
Domain: "test.example.com",
|
|
Enabled: true,
|
|
Auth: &api.ServiceAuthConfig{},
|
|
Targets: &[]api.ServiceTarget{
|
|
{
|
|
TargetId: "peer-123",
|
|
TargetType: "peer",
|
|
Protocol: "https",
|
|
Port: 8443,
|
|
Enabled: true,
|
|
Options: &api.ServiceTargetOptions{
|
|
SkipTlsVerify: ptr(true),
|
|
RequestTimeout: ptr("30s"),
|
|
PathRewrite: &pathRewrite,
|
|
CustomHeaders: &map[string]string{"X-Foo": "bar"},
|
|
},
|
|
},
|
|
},
|
|
})
|
|
require.NoError(t, err)
|
|
assert.Equal(t, testService.Id, ret.Id)
|
|
})
|
|
}
|
|
|
|
func TestReverseProxyServices_Update_200(t *testing.T) {
|
|
withMockClient(func(c *rest.Client, mux *http.ServeMux) {
|
|
mux.HandleFunc("/api/reverse-proxies/services/svc-1", func(w http.ResponseWriter, r *http.Request) {
|
|
assert.Equal(t, "PUT", r.Method)
|
|
reqBytes, err := io.ReadAll(r.Body)
|
|
require.NoError(t, err)
|
|
var req api.ServiceRequest
|
|
require.NoError(t, json.Unmarshal(reqBytes, &req))
|
|
assert.Equal(t, "updated-service", req.Name)
|
|
retBytes, _ := json.Marshal(testService)
|
|
_, err = w.Write(retBytes)
|
|
require.NoError(t, err)
|
|
})
|
|
ret, err := c.ReverseProxyServices.Update(context.Background(), "svc-1", api.PutApiReverseProxiesServicesServiceIdJSONRequestBody{
|
|
Name: "updated-service",
|
|
Domain: "test.example.com",
|
|
Enabled: true,
|
|
Auth: &api.ServiceAuthConfig{},
|
|
Targets: &[]api.ServiceTarget{testServiceTarget},
|
|
})
|
|
require.NoError(t, err)
|
|
assert.Equal(t, testService.Id, ret.Id)
|
|
})
|
|
}
|
|
|
|
func TestReverseProxyServices_Update_Err(t *testing.T) {
|
|
withMockClient(func(c *rest.Client, mux *http.ServeMux) {
|
|
mux.HandleFunc("/api/reverse-proxies/services/svc-1", func(w http.ResponseWriter, r *http.Request) {
|
|
retBytes, _ := json.Marshal(util.ErrorResponse{Message: "No", Code: 400})
|
|
w.WriteHeader(400)
|
|
_, err := w.Write(retBytes)
|
|
require.NoError(t, err)
|
|
})
|
|
ret, err := c.ReverseProxyServices.Update(context.Background(), "svc-1", api.PutApiReverseProxiesServicesServiceIdJSONRequestBody{
|
|
Name: "updated-service",
|
|
Domain: "test.example.com",
|
|
Enabled: true,
|
|
Auth: &api.ServiceAuthConfig{},
|
|
Targets: &[]api.ServiceTarget{testServiceTarget},
|
|
})
|
|
assert.Error(t, err)
|
|
assert.Equal(t, "No", err.Error())
|
|
assert.Nil(t, ret)
|
|
})
|
|
}
|
|
|
|
func TestReverseProxyServices_Delete_200(t *testing.T) {
|
|
withMockClient(func(c *rest.Client, mux *http.ServeMux) {
|
|
mux.HandleFunc("/api/reverse-proxies/services/svc-1", func(w http.ResponseWriter, r *http.Request) {
|
|
assert.Equal(t, "DELETE", r.Method)
|
|
w.WriteHeader(200)
|
|
})
|
|
err := c.ReverseProxyServices.Delete(context.Background(), "svc-1")
|
|
require.NoError(t, err)
|
|
})
|
|
}
|
|
|
|
func TestReverseProxyServices_Delete_Err(t *testing.T) {
|
|
withMockClient(func(c *rest.Client, mux *http.ServeMux) {
|
|
mux.HandleFunc("/api/reverse-proxies/services/svc-1", func(w http.ResponseWriter, r *http.Request) {
|
|
retBytes, _ := json.Marshal(util.ErrorResponse{Message: "Not found", Code: 404})
|
|
w.WriteHeader(404)
|
|
_, err := w.Write(retBytes)
|
|
require.NoError(t, err)
|
|
})
|
|
err := c.ReverseProxyServices.Delete(context.Background(), "svc-1")
|
|
assert.Error(t, err)
|
|
assert.Equal(t, "Not found", err.Error())
|
|
})
|
|
}
|