feat(sdk): add extension auth for middleware E2E - #2784
Open
pimlock wants to merge 3 commits into
Open
Conversation
Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
|
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-2784.docs.buildwithfern.com/openshell |
Collaborator
Author
|
/ok to test 3128169 |
|
Label |
Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
13 tasks
Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
pimlock
marked this pull request as ready for review
August 18, 2026 23:22
pimlock
requested review from
a team,
derekwaynecarr,
mrunalp and
sjenning
as code owners
August 18, 2026 23:22
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Establish the first Rust SDK surface for building OpenShell extension services and add authenticated supervisor middleware end-to-end coverage.
This PR intentionally starts with a narrow foundation: the opt-in
openshell-sdkextensionfeature provides service-side caller verification, and one Docker E2E proves the complete gateway → sandbox supervisor → authenticated middleware → upstream HTTP path. The middleware replaces sensitive content and adds a header before the request reaches the upstream.Related Issue
Related to #1733.
Follow-up coverage and SDK adoption are tracked in #2794.
Changes
Extension SDK foundation
openshell-sdkextensionfeature and moduleGatewayJwtAuthenticator,AuthenticatedCaller, andExtensionCallerKindopenshell-extension-coredependencyAuthenticated middleware E2E
extensionfeaturemise run e2e:supervisor-middlewareand a dedicated GitHub Actions E2E matrix laneSDK Direction
The
extensionmodule is intended to become the Rust SDK for implementing extension services. As it grows, the SDK should own common lifecycle concerns such as service interfaces, authentication before handler dispatch, key caching and refresh after trusted bootstrap, protocol lifecycle validation, consistent errors, and observability. Extension authors should primarily implement manifests, configuration validation, and request or message business logic.Rust is the initial proving ground, not a Rust-only extension model. OpenShell's other language SDKs should provide equivalent extension support within their existing packages rather than introducing a separate family of extension packages. The cross-language API shape still needs dedicated design work so each SDK remains idiomatic while sharing the same lifecycle, trust, and interoperability guarantees.
The deployment must continue to provide cold-start trust configuration, including the trusted gateway identity, issuer, audience, and CA or initial verification keys. Extension-specific authorization also remains application-owned. In this initial PR, key refresh remains deployment-owned and middleware protobuf interfaces still come from the existing core surface.
Alternative Considered
We considered publishing a dedicated extension SDK, separate from the existing API SDK in each language. Keeping extension support in the regular SDKs gives OpenShell fewer packages, release paths, and dependency surfaces to maintain. It also reflects the expected usage model: extensions will likely call OpenShell APIs in addition to implementing service interfaces.
A unified SDK can eventually provide an extension-oriented API client wrapper with the appropriate authentication configured for extension-to-OpenShell calls. This avoids requiring extension authors to combine and configure two SDK families themselves. Cargo features and language-appropriate modules can preserve an opt-in boundary without introducing separate packages.
Follow-up
Issue #2794 tracks the next layer of work:
examples/supervisor-middleware-content-guardto the SDK and use it as the behavioral E2E fixturekid, algorithm, time bounds, claim shape, and JWKS validationTesting
mise run pre-commitpassesmise run e2e:supervisor-middlewarepasses against a Docker-backed gatewayChecklist