Repository navigation
feat(auth): authenticate gateway-mediated application requests - #4963
TaylorMutch wants to merge 10 commits into
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
🌿 Preview your docs: https://nvidia-preview-pr-4963.docs.buildwithfern.com/openshell |
18b394a to
ce2a99e
Compare
2574b9a to
70e365e
Compare
ce2a99e to
de94456
Compare
30cf9ce to
6b2fe9c
Compare
de94456 to
3b08d4c
Compare
6b2fe9c to
dae4a9d
Compare
c35e581 to
caacd27
Compare
66220a7 to
3dc01d7
Compare
c37b455 to
dd566cd
Compare
b71991c to
ad8be4d
Compare
00061b6 to
acc3754
Compare
Compatibility review (advisory)New or updated breaking changes; see the full report for all findings. 1. api-behavior — No explicit risk acceptance foundTLS loopback gateways now advertise
2. api-behavior — No explicit risk acceptance foundThe supervisor application listener now drops every
Review details
Advisory review; publication gates are unchanged. |
433b9b9 to
35e2d05
Compare
5f66489 to
2bc4518
Compare
Compatibility review (advisory)New or updated breaking changes; see the full report for all findings. 1. helm — No explicit risk acceptance foundhelm upgrade --reuse-values previously accepted saved chart values but now renders service_auth_enabled = "" when the new server.serviceAuthEnabled key is absent.
Review details
Advisory review; publication gates are unchanged. |
2bc4518 to
f79878c
Compare
35e2d05 to
c503a94
Compare
e5927f4 to
dfa898d
Compare
b7042a9 to
1e069a1
Compare
dfa898d to
c02b593
Compare
|
/ok to test c02b593 |
Require configured gateway authentication for application HTTP requests and WebSocket upgrades, with or without the independent app listener. Add browser sessions, application credential separation, shared revocation, request authorization, documentation, and browser coverage. Closes #4722 Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
|
/ok to test 900920c |
|
/ok to test 240aa0f |
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
|
/ok to test 1f856fa |
Compatibility review (advisory)New or updated breaking changes; see the full report for all findings. 1. api-behavior — No explicit risk acceptance foundThe supervisor application listener previously forwarded
Review details
Advisory review; publication gates are unchanged. |
Summary
Opt in to authentication and authorization for gateway-mediated application HTTP requests and WebSocket upgrades using
enable_gateway_service_auth = truein[openshell.gateway]. The default is false, preserving existing application routing. This setting is independent of the supervisor app listener and compute driver.Based on main at
df6a799eb. Stacked onfeat/4953-authoritative-app-urls/TaylorMutch.Related Issue
Closes #4722. Part of RFC 0017.
Changes
Log service authentication as enabled/disabled only when gateway-mediated service routing is enabled.
Apply service authentication and mount
/auth/servicesonly while gateway service routing is enabled.enable_gateway_service_routing = falsedisables the gateway application path regardless ofenable_gateway_service_auth.Add
enable_gateway_service_auth(default false),--enable-gateway-service-auth true,OPENSHELL_ENABLE_GATEWAY_SERVICE_AUTH=true, and HelmgatewayConfig."openshell.gateway".enable_gateway_service_auth. Explicit false overrides are supported.Preserve existing forwarding, application-owned paths, headers, and cookies when service authentication is disabled.
Store browser application-session tokens through the credential issuer using an explicit session owner, preserving existing backend scopes, opaque handles, and expiration checks.
Resolve browser login origins through the gateway route index for both readable and hashed service hosts, preserving workspace authorization and the control-plane login boundary.
Apply gateway identity, workspace access, and forwarding role/scope authorization before upstream connection.
Add browser login with single-use bootstrap codes and bounded Secure/HttpOnly/SameSite=Strict host-only sessions.
Use configured credential storage for sessions and shared revocation across gateway replicas.
Separate gateway credentials from application bearer tokens/cookies, strip reserved credentials, and enforce origin/Fetch Metadata protections.
Configuration
[openshell.gateway]→enable_gateway_service_auth = true--enable-gateway-service-auth=trueOPENSHELL_ENABLE_GATEWAY_SERVICE_AUTH=truegatewayConfig."openshell.gateway".enable_gateway_service_auth: trueenable_gateway_service_authdefaults tofalse. Precedence is CLI > environment > TOML > default.404; do not mount/auth/servicesThese flags are independent of
supervisor.app_listener.enabled. Direct app-listener access delegates authentication to the ingress provider/application.Release Notes
Gateway-mediated application authentication is opt-in through
[openshell.gateway].enable_gateway_service_auth(defaultfalse), independently of the app listener.Compatibility
With service authentication disabled, configuring mTLS, operator auth, or OIDC preserves existing loopback HTTP URLs. Enabling service authentication selects HTTPS when gateway TLS is configured. Direct supervisor ingress strips only the two gateway service session/login cookies; other application cookies retain their behavior.
Testing
Canonical Helm service-auth configuration passed the full chart/runtime-parser suite and final combined-chart tests, generated Helm docs, and Markdown lint. Tests cover the runtime default plus explicit
true/falseingatewayConfig."openshell.gateway".enable_gateway_service_auth.Renamed the auth setting consistently across TOML, CLI, environment, Helm, tests, man page, and docs. Standalone auth-stage server tests (2,822 passed; 51 PostgreSQL-dependent tests skipped), combined-stack server/proxy tests, strict Clippy, full Helm runtime validation, generated docs, Markdown lint, and formatting passed. Default remains
false; no live E2E was rerun for this configuration-only rename.Rebased all five branches onto main
df6a799eb, preserving the SPIFFE provider-token limiter and application-auth peer metadata. Branch ancestry, patch scope, and frozen Python/Go SDK checks passed.Standalone URL PR: 2,801 server tests (50 PostgreSQL-dependent tests skipped), 650 core tests, 336 Kubernetes-driver tests, 300 supervisor tests, and 409 CLI library tests passed.
Combined auth/discovery-reader/proxy stack: 2,831 server tests (51 PostgreSQL-dependent tests skipped) and all nine proxy tests passed. Strict all-target Clippy passed for server, core, Kubernetes driver, supervisor, CLI, and proxy.
Full Helm suites passed for the URL/Helm follow-up, including rendered TOML, resource coherence, ownership, and scaling. The combined stack passed all 500 gateway-chart unit tests. Generated Helm docs, Markdown/MDX lint, Rust formatting, and whitespace checks passed.
Fresh live k3d shared/push/graceful E2E passed on the rebased URL/Helm stage with matching locally built images: Pod-IP ingress without app Services, HTTP/WebSockets, Host/SNI, NetworkPolicy, withdrawal/re-exposure, takeover preserving workload identity/process/memory, and listener-disabled gateway fallback using
enable_gateway_service_routing: true. The isolated release and namespace were removed.Dedicated, poll, abrupt-loss, and external-ingress scenarios were not rerun for these review fixes. Current-head GitHub CI is pending.
Qualification limits
Live Kubernetes qualification covers dedicated/shared supervisors, graceful shared-owner replacement, gateway outage, and policy isolation. Hashed URL/public-port behavior is covered by unit tests. Whole-node failure, real network partitions, metric-driven HPA, sustained production load, external ingress/DNS automation, and published release artifacts remain unqualified. Installation-status presentation (#4670) remains separate work. The example Kubernetes HTTPRoute controller remains a separate compatibility POC.
Checklist
PR dependency order: #4956 → #4963 → #4964 → #4957.
Replaces #4959, which GitHub automatically marked merged into its former SDK base when the rebased branches were published. This draft isolates the auth change against the URL layer; main was unchanged by that event.