Cortex provides secure, transparent token management for Kubernetes workloads. The shared library is at core/; the sidecar binaries live under cmd/ (see cmd/README.md for which pins which mode). Keycloak client registration is handled by the operator's ClientRegistrationReconciler (no in-pod registration sidecar). Together with SPIFFE/SPIRE, this enables zero-trust authentication flows.
📘 Looking to run the demo? See the Weather Agent or GitHub Issue Agent demos for step-by-step instructions, and Token-Exchange Routes for route configuration.
Sidecar container images:
| Image | Contents |
|---|---|
authbridge |
proxy-sidecar: the cortex binary |
authbridge-envoy |
envoy-sidecar combined: Envoy + ext_proc |
authbridge-lite |
cortex built with the lite profile (see scripts/profile-tags), a sidecar minimum. A build variant, not a separate binary |
| Mode | Image | Use Case | How It Works |
|---|---|---|---|
proxy-sidecar (default) |
authbridge |
HTTP_PROXY-based forward + reverse proxies | Agent routes outbound traffic through forward proxy; reverse proxy validates inbound JWTs |
envoy-sidecar |
authbridge-envoy |
Transparent interception via iptables | Envoy intercepts all traffic, delegates auth to authbridge via ext_proc gRPC |
There are only these two modes. lite is a build profile, not a mode: the
authbridge-lite image runs the cortex binary in proxy-sidecar
mode with a trimmed plugin set (see the profile table below).
The operator resolves the mode per workload from AgentRuntime.Spec.AuthBridgeMode → namespace ConfigMap → deprecated rossoctl.io/authbridge-mode annotation → cluster default (proxy-sidecar). See operator#361.
The runtime library at core/ holds the plugin framework, every listener (the Envoy ext_proc server and the HTTP proxies), the cost pipeline, the session store, and the auth primitives — auth being 1.6% of its non-test lines. It is not protocol-free: listener/extproc depends on gRPC and envoyproxy/go-control-plane. See core/README.md for the package reference and the measured breakdown.
See docs/plugin-catalog.md for the full list of implemented pipeline plugins, what each does, and its configuration options.
The following describes the operator-injected sidecar deployment. After cortex#411 each mode is served by its own image (one container per pod). SPIRE credentials are fetched in-process by core/spiffe's Provider over the Workload API. The legacy authbridge-unified, authbridge-light, envoy-with-processor, and standalone client-registration / spiffe-helper sidecars are gone — there is no bundled spiffe-helper binary and SPIRE_ENABLED no longer gates anything.
One top-level spiffe: block in the runtime config drives the in-process
Provider that supplies X.509-SVIDs to the mTLS listeners and a JWT-SVID to the
token-exchange plugin (when its identity.type is spiffe). An absent block
constructs no Provider at all.
spiffe:
socket: "unix:///spiffe-workload-api/spire-agent.sock" # SPIRE agent socket
mirror_files: true # write the /opt mirror on every rotation (default)
mirror_dir: "/opt" # where the mirror files landsocket(string) — the SPIRE agent's Workload API socket. Must be aunix://URL; anything else fails at startup rather than at first dial. Defaultunix:///spiffe-workload-api/spire-agent.sock.mirror_files(bool) — when true (the default), an in-process goroutine writes/opt/svid.pem,/opt/svid_key.pem,/opt/svid_bundle.pemand/opt/jwt_svid.tokenon every rotation, for external readers (e2e probes, debugging, future Envoy filesystem SDS). The listeners themselves read SVIDs in memory and never re-read the files.mirror_dir(string) — directory for the mirror files, default/opt. Only used whenmirror_filesis true.
The JWT-SVID audience that token-exchange uses as a client assertion is
per-plugin (token-exchange's identity.jwt_audience), not part of this block.
Cortex solves the challenge of secure service-to-service authentication in Kubernetes:
-
Automatic Identity - Workloads automatically obtain their identity from SPIFFE/SPIRE and register as Keycloak clients using their SPIFFE ID (e.g.,
spiffe://example.com/ns/default/sa/myapp) -
Token-Based Authorization - Callers obtain JWT tokens from Keycloak with the workload's identity as the audience, authorizing them to invoke specific services
-
Transparent Token Exchange - A sidecar intercepts outgoing requests, validates incoming tokens, and exchanges them for tokens with the appropriate target audience—all without application code changes
-
Target Service Validation - Target services validate the exchanged token, ensuring it has the correct audience before authorizing requests
Incoming request (with JWT)
│
▼
┌───────────────────────────────────────────────────────────────────────┐
│ WORKLOAD POD │
│ (with AuthBridge sidecars) │
│ │
│ ┌─────────────────────────────────────────────────────────────────┐ │
│ │ Init Container: proxy-init (iptables intercepts pod traffic, │ │
│ │ excluding Keycloak port) │ │
│ └─────────────────────────────────────────────────────────────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────────────────────────────────────────────────────┐ │
│ │ AuthBridge Sidecar (combined image) │ │
│ │ Container name = mode-dependent: │ │
│ │ proxy-sidecar (default): authbridge-proxy │ │
│ │ envoy-sidecar: envoy-proxy │ │
│ │ │ │
│ │ INBOUND: Validates JWT (signature + issuer via JWKS) │ │
│ │ Returns 401 Unauthorized if invalid │ │
│ │ OUTBOUND: Exchanges token → target-service audience │ │
│ │ (using Workload's credentials) │ │
│ └──────────────────────┬──────────────────────────────────────────┘ │
│ ▲ outbound │ inbound │
│ │ request │ (validated) │
│ │ ▼ │
│ ┌─────────┴───────────────────────────────────────────────────────┐ │
│ │ Your App │ │
│ │ (SVIDs are fetched in-process by the sidecar above over the │ │
│ │ SPIRE Workload API; no spiffe-helper container) │ │
│ └─────────────────────────────────────────────────────────────────┘ │
└───────────────────────────────────────────────────────────────────────┘
▲
│ Out-of-band: operator's ClientRegistrationReconciler
│ creates the Keycloak client + a rossoctl-keycloak-client-credentials
│ Secret. The webhook mounts that Secret into the AuthBridge sidecar
│ at /shared/client-{id,secret}.txt — no in-pod registration sidecar.
│
│ Exchanged token (aud: target-service)
▼
┌─────────────────────┐
│ TARGET SERVICE POD │
│ │
│ Validates token │
│ with audience │
│ "target-service" │
└─────────────────────┘
📊 Mermaid Architecture Diagram (click to expand)
flowchart TB
subgraph WorkloadPod["WORKLOAD POD (with AuthBridge sidecar)"]
subgraph Init["Init Container (always injected)"]
ProxyInit["proxy-init<br/>(iptables: traffic interception in<br/>envoy-sidecar mode, egress guard<br/>in proxy-sidecar/lite)"]
end
subgraph Containers["Containers"]
App["Your Application"]
Sidecar["AuthBridge sidecar<br/>name = mode-dependent:<br/>proxy-sidecar: authbridge-proxy<br/>envoy-sidecar: envoy-proxy<br/><br/>(SVIDs fetched in-process via<br/>the SPIRE Workload API)"]
end
end
subgraph Operator["operator (rossoctl-system)"]
ClientReg["ClientRegistration<br/>Reconciler"]
end
subgraph TargetPod["TARGET SERVICE POD"]
Target["Target Service<br/>(validates tokens)"]
end
subgraph External["External Services"]
SPIRE["SPIRE Agent"]
Keycloak["Keycloak"]
end
Caller["Caller<br/>(external)"]
SPIRE --> Sidecar
ClientReg -->|"creates client + Secret"| Keycloak
ClientReg -.->|"Secret mounted at /shared/"| Sidecar
Caller -->|"1. Get token"| Keycloak
Caller -->|"2. Pass token"| Sidecar
Sidecar -->|"3. Validate JWT (JWKS, returns 401 if invalid)"| Caller
Sidecar -->|"4. Forward if valid"| App
App -->|"5. Request + Token"| Sidecar
Sidecar -->|"6. Exchange via Keycloak"| Keycloak
Sidecar -->|"7. Request + Exchanged Token"| Target
Target -->|"8. Response"| App
App -->|"9. Response"| Caller
style WorkloadPod fill:#e1f5fe
style TargetPod fill:#e8f5e9
style Sidecar fill:#fff3e0
style External fill:#fce4ec
style Caller fill:#fff9c4
After cortex#411 a workload pod has the application
container plus a single combined AuthBridge sidecar. It also has a one-shot
proxy-init init container in every mode: in envoy-sidecar mode it intercepts
inbound and outbound traffic, and in proxy-sidecar mode (the cluster default)
and lite it runs the always-on enforce-redirect egress guard. SVIDs are
fetched in-process by the sidecar over the SPIRE
Workload API — there is no spiffe-helper container — and client
registration runs in the operator, not the pod.
| Component | Type | Mode | Purpose |
|---|---|---|---|
proxy-init |
init | all modes | Envoy-sidecar: iptables intercept inbound and outbound traffic (excludes Keycloak port to avoid token-exchange loops). Proxy-sidecar/lite: the enforce-redirect egress guard, always-on. See deploy/proxy-init/README.md. |
Your App |
container | both | Your application |
authbridge-proxy |
container | proxy-sidecar (default) | Sidecar from the authbridge image: HTTP forward + reverse proxies, full plugin set (jwt-validation + token-exchange + a2a/mcp/inference parsers). Fetches SVIDs in-process. |
envoy-proxy |
container | envoy-sidecar | Combined sidecar from the authbridge-envoy image: Envoy + ext_proc. Validates inbound JWTs (signature + issuer via JWKS) and exchanges outbound tokens; HTTPS is TLS-passthrough. |
Any downstream service that validates incoming tokens have the expected audience.
Initialization (out of band, before/at pod startup):
SPIRE Agent AuthBridge Sidecar Keycloak
│ │ │
│ 0. SVIDs │ │
│───────────────────────►│ (fetched in-process by │
│ (SPIFFE ID, │ core/spiffe's Provider over │
│ rotated) │ the Workload API — no │
│ │ spiffe-helper container) │
│ │ │
│ │ 1. Read client credentials │
│ │◄─── /shared/client-{id,secret}.txt
│ │ (operator's ClientRegistration-
│ │ Reconciler registered the
│ │ workload out of band, │
│ │ client_id = SPIFFE ID, │
│ │ and the webhook mounts the │
│ │ Secret it created) │
Runtime Flow:
Caller Workload Pod Keycloak Target Service
│ │ │ │
│ 2. Get token │ │ │
│ (aud: Workload's SPIFFE ID) │ │
│─────────────────────────────────────────────►│ │
│◄─────────────────────────────────────────────│ │
│ Token (aud: Workload) │ │
│ │ │ │
│ 3. Pass token │ │ │
│ to Workload │ │ │
│────────────────────►│ │ │
│ │──────────┐ │ │
│ │ Envoy intercepts │ │
│ │ inbound request │ │
│ │ │ │ │
│ │ Ext Proc validates │ │
│ │ JWT (signature + │ │
│ │ issuer via JWKS) │ │
│ │ │ │ │
│ │ 401 if invalid ──────►│ (rejected) │
│ │ │ │ │
│ │ 4. Forward to App │ │
│ │ if valid │ │
│ │◄─────────┘ │ │
│ │ │ │
│ │ 5. Workload calls │ │
│ │ Target Service with │ │
│ │ Caller's token │ │
│ │──────────┐ │ │
│ │ │ │ │
│ │ Envoy intercepts │ │
│ │ outbound request │ │
│ │ │ │ │
│ │ 6. Token Exchange │ │
│ │ (using Workload creds)│ │
│ │───────────────────────►│ │
│ │◄───────────────────────│ │
│ │ New token (aud: target-service) │
│ │ │ │ │
│ │ 7. Forward request │ │
│ │ with exchanged token │ │
│ │───────────────────────────────────────►│
│ │ │ │
│ │◄───────────────────────────────────────│
│ │ "authorized" │ │
│◄────────────────────│ │ │
│ Response │ │ │
| Step | Component | Verification |
|---|---|---|
| 0 | AuthBridge sidecar (core/spiffe Provider) |
SVID obtained in-process from the SPIRE Agent over the Workload API |
| 1 | Operator (ClientRegistrationReconciler) |
Workload registered with Keycloak out of band (client_id = SPIFFE ID); credentials mounted at /shared/ |
| 2 | Caller | Token obtained with aud: Workload's SPIFFE ID |
| 3 | Envoy + Ext Proc (inbound) | Inbound JWT validated: signature verified via JWKS, issuer checked, optional audience check. Returns 401 if invalid. |
| 4 | Workload | Validated request forwarded to application |
| 5 | Envoy + Ext Proc (outbound) | Outbound request intercepted; token exchanged using Workload's credentials → aud: target-service |
| 6 | Target Service | Token validated (aud: target-service), returns "authorized" |
📊 Mermaid Diagram (click to expand)
sequenceDiagram
autonumber
participant SPIRE as SPIRE Agent
participant Sidecar as AuthBridge sidecar
participant Operator as operator (ClientRegistrationReconciler)
participant Caller as Caller
participant App as Workload
participant Envoy as Sidecar listeners (Envoy + Ext Proc, or proxies)
participant KC as Keycloak
participant Target as Target Service
Note over Operator,SPIRE: Out-of-band initialization
Operator->>KC: Register client (client_id = SPIFFE ID)
KC-->>Operator: Client credentials
Operator-->>Sidecar: Secret mounted at /shared/
SPIRE->>Sidecar: SVID (fetched in-process over the Workload API)
Note over Caller,Target: Runtime Flow
Caller->>KC: Get token (aud: Workload's SPIFFE ID)
KC-->>Caller: Token with workload-aud scope
Note over Caller,Envoy: Inbound Path (JWT Validation)
Caller->>Envoy: Request with Bearer token
Note over Envoy: Ext Proc validates JWT:<br/>signature (JWKS), issuer,<br/>optional audience check
alt Invalid token
Envoy-->>Caller: 401 Unauthorized
end
Envoy->>App: Forward validated request
Note over App,Envoy: Outbound Path (Token Exchange)
App->>Envoy: Call Target Service with Caller's token
Note over Envoy: Ext Proc intercepts outbound<br/>Uses Workload's credentials
Envoy->>KC: Token Exchange (Workload's creds)
KC-->>Envoy: New Token (aud: target-service)
Envoy->>Target: Request + Exchanged Token
Target->>Target: Validate token (aud: target-service)
Target-->>App: "authorized"
App-->>Caller: Response
| Step | From → To | Action |
|---|---|---|
| Initialization (out of band) | ||
| 1 | Operator → Keycloak | Register client (client_id = SPIFFE ID) |
| 2 | Keycloak → Operator | Return client credentials (Secret mounted at /shared/ by the webhook) |
| 3 | SPIRE → AuthBridge sidecar | Issue SVID, fetched in-process over the Workload API (no spiffe-helper container) |
| Runtime Phase — Inbound (JWT Validation) | ||
| 4 | Caller → Keycloak | Request token (aud: Workload's SPIFFE ID) |
| 5 | Keycloak → Caller | Return token with workload-aud scope |
| 6 | Caller → Envoy (inbound) | Request intercepted by iptables, routed to Envoy inbound listener |
| 7 | Envoy → Ext Proc | Validate JWT: signature (JWKS), issuer, optional audience. Returns 401 if invalid. |
| 8 | Envoy → Workload | Forward validated request to application |
| Runtime Phase — Outbound (Token Exchange) | ||
| 9 | Workload → Envoy (outbound) | Outbound request intercepted by iptables, routed to Envoy outbound listener |
| 10 | Envoy → Ext Proc → Keycloak | Token Exchange (using Workload's credentials) |
| 11 | Keycloak → Envoy | Return new token (aud: target-service) |
| 12 | Envoy → Target Service | Forward request with exchanged token |
| 13 | Target Service | Validate token (aud: target-service) |
| 14 | Target Service → Workload | Return "authorized" |
| 15 | Workload → Caller | Return response |
- No Static Secrets - Credentials are dynamically generated during registration
- Short-Lived Tokens - JWT tokens expire and must be refreshed
- Inbound JWT Validation - Incoming requests are validated at the sidecar (signature via JWKS, issuer, optional audience) before reaching the application
- Self-Audience Scoping - Tokens include the Workload's own identity as audience, enabling token exchange
- Same Identity for Exchange - The sidecar uses the Workload's credentials (same SPIFFE ID), matching the token's audience
- Transparent to Application - Both inbound validation and outbound token exchange are handled by the sidecar; applications don't need to implement either
- Configurable Targets - Route-based configuration maps destination hosts to target audiences
- Kubernetes cluster (Kind recommended for local development)
- SPIRE installed and running (server + agent) - for SPIFFE version
- Keycloak deployed
- Docker/Podman for building images
The easiest way to get all prerequisites is to use the Rossoctl Quickstart.
See demos/README.md for the full demo index and a
recommended learning path — from the Weather Agent (inbound validation, webhook
injection) through the GitHub Issue Agent (transparent token exchange +
scope-based access) to the token-exchange routes reference.
AuthBridge supports per-host token exchange configuration via routes.yaml:
# Exchange tokens for target-alpha audience when calling this host
- host: "target-alpha-service.authbridge.svc.cluster.local"
target_audience: "target-alpha"
token_scopes: "openid target-alpha-aud"
# Glob patterns supported
- host: "*.internal.svc.cluster.local"
passthrough: true # Skip token exchangeUse keycloak_sync.py to reconcile routes.yaml with Keycloak configuration:
python scripts/keycloak_sync.py --config routes.yaml --agent-client "spiffe://..." --yesThis creates target clients, audience scopes, and assigns scopes to the agent.
Every plugin is opt-in. A binary links exactly the plugins its build tags name,
so an artifact's contents are its tag list and nothing more. A build with no
tags registers no plugins, and will reject any config that names one with
unknown plugin "..." (registered: []).
Tag sets are not written by hand. scripts/profile-tags holds one
declarative profile per shipped artifact and emits its tags:
| Profile | Artifact | Plugins |
|---|---|---|
local |
desktop cortex |
the three parsers + tool-prune |
full |
authbridge image, Kubernetes proxy-sidecar |
all fourteen |
lite |
authbridge-lite image |
sidecar minimum: jwt-validation, token-exchange, litellm-budget-track, static-inject |
envoy |
authbridge-envoy image |
envoy-sidecar set |
cpex |
authbridge-cpex image |
cpex set |
context-guru and session-budget belong to no profile — both are heavy
(roughly 16 MiB and 6 MiB respectively) and are linked only on request.
Go build:
# Desktop set
go build -tags "$(go -C scripts/profile-tags run . local)" ./cmd/cortex
# Everything a Kubernetes sidecar ships
go build -tags "$(go -C scripts/profile-tags run . full)" ./cmd/cortex
# A profile plus one optional plugin
go build -tags "$(go -C scripts/profile-tags run . full),include_plugin_sessionbudget" \
./cmd/cortexDocker build:
docker build --build-arg GO_BUILD_TAGS="$(go -C scripts/profile-tags run . full)" \
-f cmd/cortex/Dockerfile .Tags combine with commas. Go does not error on a tag that matches nothing, so a typo silently drops a plugin — prefer a profile name over a hand-written list.
To make a plugin excludable:
- Create a
plugins_<name>.gofile in eachcmd/binary that imports the plugin:
//go:build include_plugin_<name>
package main
import _ "github.com/rossoctl/cortex/core/plugins/<name>"-
Never import a plugin package from
main.go. An unconditional import cannot be excluded by any tag, and nothing reports that. -
Name the plugin in every profile that should carry it, in
scripts/profile-tags/profiles.go— or add it tooptionalif it deliberately ships in none. A plugin in neither fails the accounting guard. -
Avoid a filename whose suffix is a GOOS or GOARCH token.
plugins_sparc.gocarries an implicitGOARCH=sparcconstraint and compiles on no normal machine, silently dropping the plugin — which is why the sparc plugin's file isplugins_sparcplugin.go. A guard test enforces this.
The build constraint include_plugin_<name> means the file is compiled in only
when -tags include_plugin_<name> is passed.
- core — The runtime library: framework, listeners, cost, session store, auth (Go module)
- cmd/cortex — proxy-sidecar binary (default mode, full plugin set)
- cmd/cortex-envoy — envoy-sidecar binary (Envoy + ext_proc, full plugin set)
authbridge-liteimage —cmd/cortexbuilt with theliteprofile (seescripts/profile-tags); a build variant, not a separate binary- proxy-init — iptables init container (traffic interception in envoy-sidecar mode,
enforce-redirectegress guard in proxy-sidecar/lite) - docs/ — framework architecture and plugin author references
Keycloak client registration is handled by the operator's ClientRegistrationReconciler, not by an in-pod sidecar.