Files
netbird/proxy/internal/middleware/builtin/llm_identity_inject/middleware_test.go
Maycon Santos 92a66cdd20 [management,proxy,client] 0.74.0 version (#6563)
* [management,proxy] Agent network: per-account LLM gateway (policy, metering, multi-provider) (#6555)

* [agent-network] Shared proto, OpenAPI schema, and generated types

* [agent-network] Management: store, manager, synthesizer, policy engine, provider catalog, HTTP/gRPC API

Adds the account-scoped agent-network module: provider/policy/budget CRUD and
store, the reverse-proxy service synthesizer, policy selection + limit
enforcement, the provider catalog (incl. Vertex AI and AWS Bedrock entries),
and the management HTTP + proxy gRPC surfaces.

* [management] Fix agent-network proxy-peer fan-out on affected-peer recompute

The affected-peers resolver loaded only persisted reverse-proxy services, but
agent-network services are synthesized on demand and never persisted. As a
result the embedded proxy peer was never folded into the affected set when a
client's group changed, so the proxy received no network-map update for a newly
authorised client and rejected its handshake until a full resync (restart).

loadProxyServices now merges the synthesized agent-network services (injected
via a registration hook to avoid an import cycle), so proxy peers learn newly
authorised clients immediately.

* [proxy] Reverse-proxy middleware framework, chain, and request plumbing

The per-target middleware chain (slots, dispatcher, mutation gate, metadata
merger), body capture, access-log terminal sink, and the proxy wiring that
builds + runs chains for synthesized agent-network services.

* [proxy] LLM parsers, pricing, and builtin middlewares (OpenAI, Anthropic, Vertex AI, AWS Bedrock)

Request/response parsers and SSE/event-stream metering, the embedded pricing
table, and the builtin middleware set: request parser, router, policy
limit-check/record, cost meter, guardrail, identity inject, response parser.
Includes the path-routed providers — Google Vertex AI (keyfile:: service-account
OAuth minting) and AWS Bedrock (bearer auth, invoke/converse/streaming, optional
/bedrock prefix) — plus the Models allowlist and unmeterable-publisher deny.

* [proxy] IPv6 in-place apply and TCP accept-loop hardening on netstack listeners

* [agent-network] End-to-end test suite, module docs, and deployment preset

* [agent-network] Fix codespell typos and exclude false positives

- labelgen word pool: vermillion -> vermilion, racoon -> raccoon.
- codespell ignore list: add flate (Go compress/flate package), recordin
  (a test-local identifier), and unparseable (a valid alternative spelling used
  consistently across identifiers + a metadata-value constant).

* [management] Set LastSeen on injected proxy peer in realstack test (MySQL strict-mode)

The injected embedded proxy peer had a PeerStatus with a zero LastSeen, which
serializes to '0000-00-00' and is rejected by MySQL in strict mode (SQLite
tolerates it). Set LastSeen to a valid time so SaveAccount succeeds on both
engines.

* [agent-network] Remove e2e shell-script suite from this branch

The end-to-end shell scripts under scripts/e2e/ are maintained in a separate
testing suite and are not part of this change set.

* [agent-network] Polish module docs: remove internal review scaffolding, fix links, verify diagrams

Strip PR-review framing, commit references, absolute paths, and stale internal
references from the agent-network module docs; fix broken relative links; verify
all diagrams against the current architecture. Remove the internal AI-reviewer
prompt file.

* [management] Refine session expiration handling to support 3-state encoding for SSO deadlines

* [agent-network] Relocate agentnetwork package to internals/modules

Move management/server/agentnetwork (and its catalog/, labelgen/, types/
subpackages) to management/internals/modules/agentnetwork, alongside the
reverse-proxy module, and rewrite all importers. Pure relocation: package names,
the synthesizer + affectedpeers registration hook, and store access (shared
store.Store) are unchanged, so no import cycle is introduced (affectedpeers
still depends only on the agentnetwork/types leaf).

* [agent-network] Co-locate HTTP handlers in the module (RegisterEndpoints)

Move the agent-network HTTP handlers from server/http/handlers/agentnetwork into
the module at internals/modules/agentnetwork/handlers (package handlers) and
rename the entrypoint AddEndpoints -> RegisterEndpoints, matching the
reverse-proxy module convention. Wiring in http/handler.go updated accordingly.

* Update getting started to point to rc when agent network enabled

* Add a reference to a commercial license

* Fix docs localhost link

* Fix docs localhost link

* Add private services domain note

* [management] Add agent-network telemetry metrics (#6561)

Surface agent-network adoption and usage in the self-hosted metrics
worker: distinct accounts, providers, policies, budget rules, accounts
with log collection enabled, and aggregated input/output tokens plus
cost.

Tokens and cost are summed from agent_network_request_usage (the
always-written per-request ledger) so the figures are accurate
regardless of the log-collection toggle and carry no double-counting.
All values come from a handful of indexed aggregate queries run only on
the worker's periodic tick.

Adds store.AgentNetworkMetrics with GetAgentNetworkMetrics on the Store
interface, the SqlStore implementation, and a zero-valued FileStore stub.

* Update NetBird server and proxy image versions to 0.74.0-rc.2

* [management,proxy] Reduce agent-network cognitive complexity (#6566)

Address the SonarCloud quality-gate findings in new agent-network code
by extracting focused helpers. No behavior change.

- synthesizer.go: split buildIdentityInjectConfigJSON into per-shape
  rule builders; extract mergeGuardrail from mergeGuardrails to cut
  nesting depth.
- llm_identity_inject: extract injectionEmitsAnything validation
  predicate from New.
- llm_response_parser/streaming.go: extract applyOpenAIStreamUsage and
  applyAnthropicStreamUsage (via a named anthropicStreamUsage type) and
  simplify the OpenAI scanner loop.
- reverseproxy.go: decompose ServeHTTP into serveRouteError,
  buildTargetContext, serveDirect, serveWithChain, captureRequestForChain,
  serveDeny, newResponseWriter, observeResponse, and forwardUpstream,
  preserving the defer ordering so response observation still reads the
  captured writer before it is released.

* [management] Move agent-network access-log ingest into the agentnetwork module (#6568)

The agent-network access-log ingest path (metaKey wire contract, flatten,
usage derivation, and the dual-write of the usage ledger + settings-gated
full row) lived in the reverseproxy accesslogs manager, even though the
agentnetwork module already owns the rest of that domain — types, read
(ListAccessLogs / GetUsageOverview), the budget-counter writes, and
retention cleanup.

Move it next to the rest: a stateless agentnetwork.IngestAccessLog(ctx,
store, entry) that the reverseproxy SaveAccessLog delegates to when the
entry is agent-network. Removes the agentNetworkTypes import from the
reverseproxy manager. No behavior change; the write/read table separation
is unchanged.

Adds real-store coverage for the disable->enable log-collection toggle
(usage ledger always written, full row gated) plus the metadata parse and
group-dedup helpers, which previously had no dedicated tests.

* Add session view support in the access log

* [management,proxy] Container-based agent-network e2e harness (#6577)

* [e2e] Add container-based agent-network e2e harness (Pillar 1)

Introduce a self-contained, OIDC-free e2e harness that stands up NetBird
in containers, so suites no longer depend on the hand-maintained Tilt
stack or a real IdP.

- harness brings up the combined server (management + signal + relay +
  STUN + embedded IdP) in a single container built from
  combined/Dockerfile.multistage, and mints an admin PAT through the
  unauthenticated /api/setup bootstrap (NB_SETUP_PAT_ENABLED). API access
  goes through the existing shared/management/client/rest typed client.
- the image is built via the docker CLI (BuildKit) so the Dockerfile's
  cache mounts are honored; testcontainers then runs the tagged image.
- everything is behind the `e2e` build tag so normal builds and unit
  tests never pull in testcontainers.

Adds BuildKit cache mounts to combined/Dockerfile.multistage so source
changes recompile incrementally rather than from scratch.

Pillar 1 proven by TestCombinedBootstrap: server builds, boots, mints a
PAT, and the PAT authenticates a real management API call.

* [e2e] Add management-side agent-network scenarios (Pillar 2)

Port the API-driven agent-network scenarios from the bash suites to Go,
sharing one combined server per package run (TestMain) with each test
owning its resource cleanup. Drives the /api/agent-network/* endpoints
through the shared REST client's NewRequest primitive with the generated
api types.

Scenarios:
- provider lifecycle (create/get/list/delete + 404 after delete)
- provider validation (missing api_key, unknown catalog id → 4xx)
- settings collection-toggle round-trip with cluster/subdomain immutability
- policy window floor (reject <60s enabled limit, accept at 60s)
- consumption read endpoint returns an array

All deterministic and dependency-free (dummy provider keys; no upstream
calls), so they run headless in CI.

* [e2e] Add live chat-through-proxy scenario (Pillar 3)

Stand up the full agent-network data path in containers and drive a real
chat-completion through the gateway:

- harness: a shared docker network (combined server reachable by alias),
  a proxy container built from the published reverse-proxy image
  (NB_PROXY_PRIVATE, NB_PROXY_ALLOW_INSECURE, NB_RELAY_TRANSPORT=ws to match
  the combined server's WS-multiplexed relay) with a generated self-signed
  wildcard cert, and a netbird client container that joins via a setup key.
- the combined image, proxy image, and client image default to the
  published rc.2 releases (overridable via NB_E2E_*_IMAGE; a bare local tag
  is built from source instead). Geolocation download is disabled so the
  server starts without external fetches.
- one shared domain is used for the management exposed address, the proxy
  domain, and the agent-network cluster; the proxy token is minted via the
  server CLI (global) to match the manual install.

TestChatCompletionThroughProxy provisions provider+policy+group+setup key,
runs proxy+client, drives an OpenAI chat-completion through the tunnel, and
asserts a 200 plus the ingested access-log row. Requires OPENAI_TOKEN
(skips otherwise). The provider must be created with enabled=true explicitly
— the create default is false despite the API doc.

* [e2e] Run the live chat scenario across a provider matrix

Replace the single-provider chat test with a data-driven matrix that runs
the same scenario through every provider whose credentials are present in
the environment (keys/URLs sourced from ~/.llm-keys locally, Actions
secrets in CI):

- OpenAI (chat), Anthropic (messages), Vercel, OpenRouter, Cloudflare
  (OpenAI-compatible gateways), and Bedrock (path-routed, bearer, via the
  messages shape) — covering both wire shapes and the gateway routing.
- all providers are created enabled with a unique model string so the
  proxy's connect-time snapshot carries them all and model->provider
  routing is unambiguous (provider toggles after connect don't reconcile
  to a connected proxy).
- the client supports both wire shapes (/v1/chat/completions and
  /v1/messages); Cloudflare gets the openai provider segment appended to
  its gateway URL.

Each provider must return 200 through the tunnel and produce an ingested
access-log row. Vertex is intentionally excluded from the uniform matrix:
it needs a bespoke rawPredict request shape rather than the shared
chat/messages path, so it warrants a dedicated scenario.

* [ci] Add manual workflow for the agent-network e2e suite

The e2e suite (build tag `e2e`) stands up the combined server + proxy +
client in Docker and drives live chat-completions, so it is slow and needs
provider credentials. Gate it out of normal CI (it already is, via the
build tag) and run it on demand via workflow_dispatch. Provider scenarios
skip when their secret is unset, so it degrades gracefully.

* [e2e] Add Vertex to the provider matrix; run e2e on ubuntu-latest

Vertex (Anthropic-on-Vertex) doesn't share the chat/messages wire shapes:
the model travels in a rawPredict path and the proxy mints the service
account's OAuth token. Add a Vertex client method that posts
/v1/projects/<project>/locations/<region>/publishers/anthropic/models/<model>:rawPredict
with the Vertex anthropic_version body, and wire it into the matrix as a
path-routed provider (created without a models array). It is keyed off
GOOGLE_VERTEX_SA_BASE64 + GOOGLE_VERTEX_PROJECT (region defaults to
"global", model to a pinned claude snapshot, both overridable).

Also bump the e2e workflow runner to ubuntu-latest and add the Vertex
secrets.

* Add docker/docker and docker/go-connections as direct dependencies in go.mod

* [ci] Trigger agent-network e2e workflow on push to main and pull requests

* [e2e] Fix proxy cert permission denied on Linux CI runners

The proxy bind-mounts a temp dir of self-signed certs. MkdirTemp creates
it 0700 and the key was 0600, which Docker Desktop on macOS ignores but a
non-root proxy container on Linux runners cannot traverse/read, so the
cert watcher failed with "open /certs/tls.crt: permission denied" and the
container exited. Widen the cert dir to 0755 and write the throwaway key
0644 so the proxy uid can read the bind-mounted material.

* [e2e] Build images from source by default instead of pulling rc.2

The agent-network code under test lives in this branch, so the e2e should
exercise it rather than a frozen published release. Flip the harness
default: combined/proxy/client are now built from their in-repo
Dockerfiles (combined/Dockerfile.multistage, proxy/Dockerfile.multistage,
e2e/harness/Dockerfile.client) under local tags. Pulling a published image
stays available by setting NB_E2E_*_IMAGE to a registry reference.

Builds now go through buildx --load so the Dockerfile cache mounts are
honored and the result is loaded for testcontainers. The CI workflow adds
a container-driver builder and a local layer cache (NB_E2E_BUILDX_CACHE)
persisted via actions/cache, which caches the base/apt/dep-download layers
across runs. The Go compile still re-runs each time, as BuildKit mount
caches cannot be exported to the GitHub cache.

* [e2e] Cover real providers in lifecycle + assert real consumption metering

- TestProviderLifecycle now runs per available real provider (create → get →
  list → delete → 404) instead of a single dummy provider, exercising each
  catalog's create and field round-trip. Create is offline, so it stays fast
  and burns no provider quota; falls back to a synthetic OpenAI provider when
  no keys are set.
- TestProvidersMatrix attaches a token limit (high caps, 60s window) to its
  policy, which switches on usage metering, and asserts consumption rows are
  recorded with positive token counts after the live traffic. Consumption is
  account-scoped (keyed by source group / user and window, not per provider),
  so the assertion is aggregate.
- TestProviderValidation gains invalid-upstream and blank-name cases. Create
  validation is uniform across catalogs (no per-provider required-field rules),
  so per-provider rejection cases would be redundant.

* [e2e] Assert session id propagates per provider

Each matrix request now sends a unique session id as the universal
x-session-id header and asserts it round-trips into that provider's
access-log row. This guards the session-grouping contract end to end for
every provider (header extraction runs in llm_request_parser ahead of the
parser-specific body extraction, so it is provider-agnostic).

* [e2e] Drop accidentally committed sync-phases dashboard

netbird-sync-phases.json was swept into the Pillar 1 commit by a broad
git add; it belongs to the unrelated sync-phases metrics work, not this
e2e harness. Remove it from the branch so the PR diff is scoped to the
e2e changes.

* [e2e] Revert accidentally committed sync-phase ingest spec

The netbird_sync_phase measurement spec in metrics ingest was swept into
the Pillar 1 commit; it belongs to the unrelated sync-phases metrics work,
not this e2e harness. Its emission side never landed here, so the spec was
orphaned anyway. Restore ingest/main.go to its origin/main state.

* Fix golint issues

* Fix sonar

* Add access log session test

* Fix access log tests

---------

Co-authored-by: braginini <bangvalo@gmail.com>
Co-authored-by: Zoltan Papp <zoltan.pmail@gmail.com>
2026-07-01 12:45:14 +02:00

667 lines
25 KiB
Go

package llm_identity_inject
import (
"context"
"encoding/json"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/netbirdio/netbird/proxy/internal/middleware"
)
const (
litellmProvider = "ainp_litellm-test"
portkeyProvider = "ainp_portkey-test"
)
func newInput(resolvedProvider, userID string, groups []string) *middleware.Input {
return &middleware.Input{
Slot: middleware.SlotOnRequest,
AccountID: "acct-test",
UserID: userID,
UserGroups: groups,
SourceIP: "100.64.0.5",
RequestID: "req-1",
Metadata: []middleware.KV{
{Key: middleware.KeyLLMResolvedProviderID, Value: resolvedProvider},
},
}
}
func liteLLMRule() ProviderInjection {
return ProviderInjection{
ProviderID: litellmProvider,
HeaderPair: &HeaderPairRule{
EndUserIDHeader: "x-litellm-end-user-id",
TagsHeader: "x-litellm-tags",
},
}
}
func TestMiddlewareIdentity(t *testing.T) {
mw := New(Config{})
assert.Equal(t, ID, mw.ID())
assert.Equal(t, Version, mw.Version())
assert.Equal(t, middleware.SlotOnRequest, mw.Slot())
assert.True(t, mw.MutationsSupported())
assert.Empty(t, mw.MetadataKeys(), "middleware emits no metadata")
assert.Nil(t, mw.AcceptedContentTypes())
require.NoError(t, mw.Close())
}
func TestInject_MatchedProvider_StampsHeaders(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRule()}})
in := newInput(litellmProvider, "alice", []string{"grp-eng", "grp-it"})
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out)
assert.Equal(t, middleware.DecisionAllow, out.Decision)
require.NotNil(t, out.Mutations)
// Strips the same headers we're about to add (anti-spoof).
assert.ElementsMatch(t,
[]string{"x-litellm-end-user-id", "x-litellm-tags"},
out.Mutations.HeadersRemove,
"every injected header must also appear in HeadersRemove so client-supplied values are wiped before our trusted values land")
added := map[string]string{}
for _, kv := range out.Mutations.HeadersAdd {
added[kv.Key] = kv.Value
}
assert.Equal(t, "alice", added["x-litellm-end-user-id"])
assert.Equal(t, "grp-eng,grp-it", added["x-litellm-tags"], "tags CSV must be sorted")
}
func TestInject_UnmatchedProvider_NoMutations(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRule()}})
in := newInput("ainp_some-other-provider", "alice", []string{"grp-eng"})
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out)
assert.Equal(t, middleware.DecisionAllow, out.Decision)
assert.Nil(t, out.Mutations, "non-LiteLLM resolved provider must produce no mutations")
}
func TestInject_NoResolvedProvider_NoMutations(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRule()}})
in := &middleware.Input{Slot: middleware.SlotOnRequest, UserID: "alice"}
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out)
assert.Nil(t, out.Mutations,
"missing llm.resolved_provider_id metadata means the router didn't run; never stamp identity blindly")
}
func TestInject_PartialRule_StampsOnlyConfiguredHeaders(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{{
ProviderID: litellmProvider,
HeaderPair: &HeaderPairRule{
EndUserIDHeader: "x-litellm-end-user-id",
// TagsHeader intentionally empty.
},
}}})
in := newInput(litellmProvider, "alice", []string{"grp-eng"})
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out)
require.NotNil(t, out.Mutations)
assert.Equal(t, []string{"x-litellm-end-user-id"}, out.Mutations.HeadersRemove,
"only configured header should be stripped")
require.Len(t, out.Mutations.HeadersAdd, 1)
assert.Equal(t, "x-litellm-end-user-id", out.Mutations.HeadersAdd[0].Key)
assert.Equal(t, "alice", out.Mutations.HeadersAdd[0].Value)
}
func TestInject_EmptyIdentity_StripsButDoesNotAdd(t *testing.T) {
// Caller has no UserID and no groups. We still strip the headers
// (so the client can't inject identity) but we don't add empty
// values that would mislead the gateway.
mw := New(Config{Providers: []ProviderInjection{liteLLMRule()}})
in := newInput(litellmProvider, "", nil)
in.AccountID = ""
in.SourceIP = ""
in.RequestID = ""
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out)
require.NotNil(t, out.Mutations)
assert.ElementsMatch(t,
[]string{"x-litellm-end-user-id", "x-litellm-tags"},
out.Mutations.HeadersRemove,
"identity headers must be stripped even when we don't have values to add — anti-spoof")
assert.Empty(t, out.Mutations.HeadersAdd,
"no NetBird identity available; do not stamp empty / misleading values")
}
func TestInject_TagsCSV_DedupesAndSorts(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRule()}})
in := newInput(litellmProvider, "alice", []string{"grp-zzz", "grp-aaa", "grp-zzz", "", " "})
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out)
require.NotNil(t, out.Mutations)
for _, kv := range out.Mutations.HeadersAdd {
if kv.Key == "x-litellm-tags" {
assert.Equal(t, "grp-aaa,grp-zzz", kv.Value,
"tags CSV must dedupe, drop empty, and sort")
return
}
}
t.Fatalf("expected x-litellm-tags in HeadersAdd; got %v", out.Mutations.HeadersAdd)
}
func TestFactory_RejectsBadJSON(t *testing.T) {
_, err := Factory{}.New([]byte("{not json"))
require.Error(t, err)
}
func TestFactory_AcceptsEmptyShapes(t *testing.T) {
for _, raw := range [][]byte{nil, []byte(""), []byte(" "), []byte("null"), []byte("{}"), []byte("[]")} {
mw, err := Factory{}.New(raw)
require.NoError(t, err)
require.NotNil(t, mw)
out, ierr := mw.Invoke(context.Background(),
newInput(litellmProvider, "alice", []string{"grp-eng"}))
require.NoError(t, ierr)
assert.Equal(t, middleware.DecisionAllow, out.Decision)
assert.Nil(t, out.Mutations,
"empty config means no providers to inject for; every resolved provider passes through")
}
}
func TestFactory_DropsInjectionRuleWithEmptyHeaders(t *testing.T) {
mw, err := Factory{}.New([]byte(`{"providers":[{"provider_id":"x"}]}`))
require.NoError(t, err)
out, ierr := mw.Invoke(context.Background(), newInput("x", "alice", []string{"grp-eng"}))
require.NoError(t, ierr)
assert.Nil(t, out.Mutations,
"a rule with no header names is functionally a no-op and must be dropped at New() time")
}
// TestInject_TagsFromAuthorisingMetadata pins that when llm_router has
// emitted llm.authorising_groups, the inject middleware uses THAT
// (the per-request authorising intersection) for the tags header — not
// the full UserGroups, which can include groups unrelated to this
// request's routing.
func TestInject_TagsFromAuthorisingMetadata(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRule()}})
in := newInput(litellmProvider, "alice", []string{"grp-eng", "grp-it", "grp-oncall"})
in.Metadata = append(in.Metadata, middleware.KV{
Key: middleware.KeyLLMAuthorisingGroups,
Value: "grp-eng",
})
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out)
require.NotNil(t, out.Mutations)
for _, kv := range out.Mutations.HeadersAdd {
if kv.Key == "x-litellm-tags" {
assert.Equal(t, "grp-eng", kv.Value,
"tags must come from llm.authorising_groups, not the full UserGroups; unrelated peer groups must not leak")
return
}
}
t.Fatalf("expected x-litellm-tags in HeadersAdd; got %v", out.Mutations.HeadersAdd)
}
// TestInject_TagsFallsBackToUserGroups pins the defensive fallback: if
// llm_router didn't emit authorising-groups metadata (chain
// misconfiguration) the middleware uses UserGroups so identity is
// still stamped, just over-broad.
func TestInject_TagsFallsBackToUserGroups(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRule()}})
in := newInput(litellmProvider, "alice", []string{"grp-eng", "grp-it"})
// No llm.authorising_groups metadata.
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out)
require.NotNil(t, out.Mutations)
for _, kv := range out.Mutations.HeadersAdd {
if kv.Key == "x-litellm-tags" {
assert.Equal(t, "grp-eng,grp-it", kv.Value,
"absent metadata must fall back to the full UserGroups CSV")
return
}
}
t.Fatalf("expected x-litellm-tags in HeadersAdd; got %v", out.Mutations.HeadersAdd)
}
// portkeyRule is the JSONMetadata-shape analogue of liteLLMRule: a
// single x-portkey-metadata header carrying _user and groups, with
// Portkey's 128-byte per-value cap.
func portkeyRule() ProviderInjection {
return ProviderInjection{
ProviderID: portkeyProvider,
JSONMetadata: &JSONMetadataRule{
Header: "x-portkey-metadata",
UserKey: "_user",
GroupsKey: "groups",
MaxValueLength: 128,
},
}
}
// TestInject_JSONMetadata_StampsHeader pins the Portkey-style emission:
// one header carrying a JSON envelope with reserved keys for user
// identity and groups CSV.
func TestInject_JSONMetadata_StampsHeader(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{portkeyRule()}})
in := newInput(portkeyProvider, "alice", []string{"grp-eng", "grp-it"})
in.UserEmail = "alice@example.com"
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out)
require.NotNil(t, out.Mutations)
assert.Equal(t, []string{"x-portkey-metadata"}, out.Mutations.HeadersRemove,
"the JSON header must be stripped before we add our trusted value")
require.Len(t, out.Mutations.HeadersAdd, 1)
added := out.Mutations.HeadersAdd[0]
assert.Equal(t, "x-portkey-metadata", added.Key)
var payload map[string]string
require.NoError(t, json.Unmarshal([]byte(added.Value), &payload))
assert.Equal(t, "alice@example.com", payload["_user"],
"_user reserved key carries the display identity (UserEmail)")
assert.Equal(t, "grp-eng,grp-it", payload["groups"],
"groups key carries the sorted CSV of group display names")
}
// TestInject_JSONMetadata_TruncatesValues pins the per-value byte cap.
// Portkey rejects metadata values longer than 128 chars; oversized
// values are truncated rather than failing the request.
func TestInject_JSONMetadata_TruncatesValues(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{portkeyRule()}})
in := newInput(portkeyProvider, "alice", []string{"grp-eng"})
in.UserEmail = strings.Repeat("a", 200) + "@example.com"
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out.Mutations)
require.Len(t, out.Mutations.HeadersAdd, 1)
var payload map[string]string
require.NoError(t, json.Unmarshal([]byte(out.Mutations.HeadersAdd[0].Value), &payload))
assert.Len(t, payload["_user"], 128,
"per-value byte length must be capped at MaxValueLength")
}
// TestInject_JSONMetadata_EmptyIdentity_StripsButDoesNotAdd verifies the
// anti-spoof Remove still fires when there's nothing to stamp.
func TestInject_JSONMetadata_EmptyIdentity_StripsButDoesNotAdd(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{portkeyRule()}})
in := newInput(portkeyProvider, "", nil)
in.UserEmail = ""
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out.Mutations)
assert.Equal(t, []string{"x-portkey-metadata"}, out.Mutations.HeadersRemove,
"strip even with no payload — client can't smuggle identity headers")
assert.Empty(t, out.Mutations.HeadersAdd,
"no NetBird identity available; do not stamp empty / misleading values")
}
// TestFactory_RejectsRuleWithBothShapes pins the configuration-error
// guard: a rule that sets both HeaderPair and JSONMetadata is dropped
// at New() time rather than guessing which wins.
func TestFactory_RejectsRuleWithBothShapes(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{{
ProviderID: litellmProvider,
HeaderPair: &HeaderPairRule{
EndUserIDHeader: "x-litellm-end-user-id",
},
JSONMetadata: &JSONMetadataRule{
Header: "x-portkey-metadata",
UserKey: "_user",
},
}}})
in := newInput(litellmProvider, "alice", []string{"grp-eng"})
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
assert.Nil(t, out.Mutations,
"a rule that sets both shapes is ambiguous and must be dropped at New() time")
}
// liteLLMRuleWithBody is the LiteLLM-style rule with body tag injection
// enabled (matches the catalog default).
func liteLLMRuleWithBody() ProviderInjection {
return ProviderInjection{
ProviderID: litellmProvider,
HeaderPair: &HeaderPairRule{
EndUserIDHeader: "x-litellm-end-user-id",
TagsHeader: "x-litellm-tags",
TagsInBody: true,
},
}
}
// TestInject_BodyTags_AddsMetadataTags pins the body-inject path that
// LiteLLM's _tag_max_budget_check requires. With TagsInBody set, the
// middleware writes the authorising-groups slice into
// request.metadata.tags (in addition to the header).
func TestInject_BodyTags_AddsMetadataTags(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRuleWithBody()}})
in := newInput(litellmProvider, "alice", []string{"grp-eng", "grp-sre"})
in.Body = []byte(`{"model":"gpt-4o-mini","messages":[]}`)
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out.Mutations)
require.NotEmpty(t, out.Mutations.BodyReplace, "body must be rewritten when TagsInBody is set")
var doc map[string]any
require.NoError(t, json.Unmarshal(out.Mutations.BodyReplace, &doc))
meta, ok := doc["metadata"].(map[string]any)
require.True(t, ok, "metadata must be an object")
tags, ok := meta["tags"].([]any)
require.True(t, ok, "metadata.tags must be a JSON array")
got := make([]string, 0, len(tags))
for _, t := range tags {
s, _ := t.(string)
got = append(got, s)
}
assert.Equal(t, []string{"grp-eng", "grp-sre"}, got,
"metadata.tags must carry the sorted authorising-groups slice")
assert.Equal(t, "gpt-4o-mini", doc["model"],
"the rest of the body must be preserved verbatim")
}
// TestInject_BodyTags_PreservesExistingMetadata pins that an existing
// metadata object on the request is merged with our tags rather than
// clobbered — clients sometimes set metadata fields the proxy
// shouldn't blow away (jobID, taskName, etc.).
func TestInject_BodyTags_PreservesExistingMetadata(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRuleWithBody()}})
in := newInput(litellmProvider, "alice", []string{"grp-eng"})
in.Body = []byte(`{"model":"gpt-4o-mini","metadata":{"jobID":"j-42","tags":["should-be-replaced"]}}`)
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotEmpty(t, out.Mutations.BodyReplace)
var doc map[string]any
require.NoError(t, json.Unmarshal(out.Mutations.BodyReplace, &doc))
meta := doc["metadata"].(map[string]any)
assert.Equal(t, "j-42", meta["jobID"],
"client-supplied metadata fields outside `tags` must survive")
tags := meta["tags"].([]any)
require.Len(t, tags, 1)
assert.Equal(t, "grp-eng", tags[0],
"our tags overwrite any client-supplied metadata.tags so spoofing is impossible")
}
// TestInject_BodyTags_SkipsHostileMetadataShape pins the defensive
// refusal: when the request body has a non-object metadata field
// (string/number/array), we don't inject — header path still emits.
func TestInject_BodyTags_SkipsHostileMetadataShape(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRuleWithBody()}})
in := newInput(litellmProvider, "alice", []string{"grp-eng"})
in.Body = []byte(`{"model":"gpt-4o-mini","metadata":"not-an-object"}`)
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out.Mutations)
assert.Empty(t, out.Mutations.BodyReplace,
"non-object metadata must skip body inject (don't clobber)")
for _, kv := range out.Mutations.HeadersAdd {
if kv.Key == "x-litellm-tags" {
assert.Equal(t, "grp-eng", kv.Value,
"header path must still emit so spend tracking keeps working")
return
}
}
t.Fatalf("expected x-litellm-tags header even when body inject was skipped")
}
// TestInject_BodyTags_SkipsTruncatedBody pins that we don't blindly
// rewrite a body we don't have in full. The header path still runs.
func TestInject_BodyTags_SkipsTruncatedBody(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRuleWithBody()}})
in := newInput(litellmProvider, "alice", []string{"grp-eng"})
in.Body = []byte(`{"model":"gpt-4o-mini","messages":[]}`)
in.BodyTruncated = true
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
assert.Empty(t, out.Mutations.BodyReplace,
"truncated body must skip body inject — re-marshaling would corrupt the request")
}
// TestInject_BodyTags_SkipsNonJSONBody pins graceful behavior when the
// body isn't JSON (e.g. a streaming binary or form upload sneaking
// through the LLM chain). Header path still runs.
func TestInject_BodyTags_SkipsNonJSONBody(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRuleWithBody()}})
in := newInput(litellmProvider, "alice", []string{"grp-eng"})
in.Body = []byte(`not even close to json`)
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
assert.Empty(t, out.Mutations.BodyReplace,
"non-JSON body must skip body inject silently")
}
// liteLLMRuleFull mirrors the catalog default: header path + body
// metadata.tags (groups) + body user (end-user id).
func liteLLMRuleFull() ProviderInjection {
return ProviderInjection{
ProviderID: litellmProvider,
HeaderPair: &HeaderPairRule{
EndUserIDHeader: "x-litellm-end-user-id",
TagsHeader: "x-litellm-tags",
TagsInBody: true,
EndUserIDInBody: true,
},
}
}
// TestInject_BodyUser_WritesTopLevelUser pins the EndUserIDInBody path
// alone: body's top-level "user" field carries the display identity.
// Tags-in-body is OFF here so we isolate the user write.
func TestInject_BodyUser_WritesTopLevelUser(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{{
ProviderID: litellmProvider,
HeaderPair: &HeaderPairRule{
EndUserIDHeader: "x-litellm-end-user-id",
EndUserIDInBody: true,
},
}}})
in := newInput(litellmProvider, "alice", nil)
in.UserEmail = "alice@example.com"
in.Body = []byte(`{"model":"gpt-4o-mini","messages":[]}`)
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out.Mutations)
require.NotEmpty(t, out.Mutations.BodyReplace)
var doc map[string]any
require.NoError(t, json.Unmarshal(out.Mutations.BodyReplace, &doc))
assert.Equal(t, "alice@example.com", doc["user"],
"body's top-level user field must carry the display identity")
_, hasMeta := doc["metadata"]
assert.False(t, hasMeta, "TagsInBody is off; metadata must not be added")
}
// TestInject_BodyUser_OverwritesClientSupplied pins anti-spoof: a
// client-supplied "user" in the body is overwritten so the gateway
// only sees our trusted identity.
func TestInject_BodyUser_OverwritesClientSupplied(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRuleFull()}})
in := newInput(litellmProvider, "alice", []string{"grp-eng"})
in.UserEmail = "alice@example.com"
in.Body = []byte(`{"model":"gpt-4o-mini","user":"ceo@company.com"}`)
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotEmpty(t, out.Mutations.BodyReplace)
var doc map[string]any
require.NoError(t, json.Unmarshal(out.Mutations.BodyReplace, &doc))
assert.Equal(t, "alice@example.com", doc["user"],
"client-supplied user must be overwritten with the trusted identity")
}
// TestInject_BodyCombined_TagsAndUser pins that with both flags on,
// the body carries both metadata.tags AND top-level user, and the
// header path still emits.
func TestInject_BodyCombined_TagsAndUser(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRuleFull()}})
in := newInput(litellmProvider, "alice", []string{"grp-eng", "grp-sre"})
in.UserEmail = "alice@example.com"
in.Body = []byte(`{"model":"gpt-4o-mini"}`)
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotEmpty(t, out.Mutations.BodyReplace)
var doc map[string]any
require.NoError(t, json.Unmarshal(out.Mutations.BodyReplace, &doc))
assert.Equal(t, "alice@example.com", doc["user"])
meta := doc["metadata"].(map[string]any)
tags := meta["tags"].([]any)
require.Len(t, tags, 2)
assert.Equal(t, "grp-eng", tags[0])
assert.Equal(t, "grp-sre", tags[1])
// Header path still emits — header end-user-id is the primary
// path for LiteLLM's resolver, body is defense-in-depth.
added := map[string]string{}
for _, kv := range out.Mutations.HeadersAdd {
added[kv.Key] = kv.Value
}
assert.Equal(t, "alice@example.com", added["x-litellm-end-user-id"])
assert.Equal(t, "grp-eng,grp-sre", added["x-litellm-tags"])
}
// TestInject_BodyCombined_HostileMetadataKeepsUser pins the partial-
// success path: a hostile (non-object) metadata field skips the tag
// write but still allows the orthogonal user write to land.
func TestInject_BodyCombined_HostileMetadataKeepsUser(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{liteLLMRuleFull()}})
in := newInput(litellmProvider, "alice", []string{"grp-eng"})
in.UserEmail = "alice@example.com"
in.Body = []byte(`{"model":"gpt-4o-mini","metadata":"not-an-object"}`)
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotEmpty(t, out.Mutations.BodyReplace,
"user write must still go through even when metadata is hostile")
var doc map[string]any
require.NoError(t, json.Unmarshal(out.Mutations.BodyReplace, &doc))
assert.Equal(t, "alice@example.com", doc["user"])
assert.Equal(t, "not-an-object", doc["metadata"],
"hostile metadata must be left untouched, not clobbered")
}
// TestInject_ExtraHeaders_Stamped pins the extras path: with a
// per-provider ExtraHeader configured (e.g. Portkey config id), the
// middleware stamps it on every matching request and adds the same
// name to HeadersRemove for anti-spoof.
func TestInject_ExtraHeaders_Stamped(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{{
ProviderID: portkeyProvider,
JSONMetadata: &JSONMetadataRule{
Header: "x-portkey-metadata",
UserKey: "_user",
GroupsKey: "groups",
},
ExtraHeaders: []ExtraHeaderKV{
{Name: "x-portkey-config", Value: "pc-prod-3f2a"},
},
}}})
in := newInput(portkeyProvider, "alice", []string{"grp-eng"})
in.UserEmail = "alice@example.com"
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out.Mutations)
assert.Contains(t, out.Mutations.HeadersRemove, "x-portkey-config",
"extras must be stripped before stamping for anti-spoof")
added := map[string]string{}
for _, kv := range out.Mutations.HeadersAdd {
added[kv.Key] = kv.Value
}
assert.Equal(t, "pc-prod-3f2a", added["x-portkey-config"],
"extras must carry the operator-configured value verbatim")
// Identity-stamping shape (JSONMetadata header) still emitted.
assert.Contains(t, added, "x-portkey-metadata",
"extras and identity stamping are independent — both must land")
}
// TestInject_ExtraHeaders_OnlyRule pins that an extras-only rule
// (no HeaderPair, no JSONMetadata) survives New() and stamps the
// extras anyway. Useful for hypothetical gateways that need a static
// routing header but no NetBird identity stamping.
func TestInject_ExtraHeaders_OnlyRule(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{{
ProviderID: "ainp_extras-only",
ExtraHeaders: []ExtraHeaderKV{
{Name: "x-routing-key", Value: "rk-1"},
},
}}})
in := newInput("ainp_extras-only", "alice", nil)
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out.Mutations,
"extras alone keep the rule alive — middleware must emit them")
added := map[string]string{}
for _, kv := range out.Mutations.HeadersAdd {
added[kv.Key] = kv.Value
}
assert.Equal(t, "rk-1", added["x-routing-key"])
}
// TestInject_ExtraHeaders_EmptyValueSkipped pins that empty values are
// dropped silently (the synth would normally not send them, but the
// middleware is defensive).
func TestInject_ExtraHeaders_EmptyValueSkipped(t *testing.T) {
mw := New(Config{Providers: []ProviderInjection{{
ProviderID: portkeyProvider,
JSONMetadata: &JSONMetadataRule{
Header: "x-portkey-metadata",
UserKey: "_user",
},
ExtraHeaders: []ExtraHeaderKV{
{Name: "x-portkey-config", Value: ""},
},
}}})
in := newInput(portkeyProvider, "alice", []string{"grp-eng"})
in.UserEmail = "alice@example.com"
out, err := mw.Invoke(context.Background(), in)
require.NoError(t, err)
require.NotNil(t, out.Mutations)
assert.NotContains(t, out.Mutations.HeadersRemove, "x-portkey-config",
"empty extra value must not even strip the header")
for _, kv := range out.Mutations.HeadersAdd {
assert.NotEqual(t, "x-portkey-config", kv.Key,
"empty extra value must not be stamped")
}
}