Repository navigation
[docs] auth: Correct auth OIDC forwarding, OpenAI routing, and trusted-service docs - #11572
Open
github-actions[bot] wants to merge 1 commit into
Open
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
- Actions OIDC runtime variables are forwarded to the sidecar for GH_AW_OTLP_WORKLOAD_IDENTITY as well as github-oidc (buildOtelEnv). - Native OpenAI WIF enables agent routing via isOpenAiOidcConfigured(); the Azure OIDC caveat now states this explicitly. - Document the trustedService secret-header contract (#11345) in the auth matrix, linking the normative spec section 9.10. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Contradictory OIDC forwarding statements remain across the authentication documentation, including the cited later passage and related files, so the active documentation issue must be resolved.
1 open issue
What changed in this PR
This documentation-only PR corrects AWF authentication guidance to match current OIDC forwarding, native OpenAI workload-identity routing, and trusted-service behavior.
Changes:
- Documents Actions OIDC variable forwarding for OTLP workload identity.
- Clarifies that native OpenAI WIF enables agent routing, while Azure OIDC alone does not.
- Adds the trusted LLM service endpoint and
secretHeaderscontract to the authentication matrix.
| File | Description |
|---|---|
| docs/environment.md | Updates environment documentation to describe OIDC variable forwarding for OTLP workload identity. |
| docs/auth-matrix.md | Clarifies provider-specific OIDC routing and documents trusted LLM service secret headers. |
| docs/api-proxy-sidecar.md | Updates sidecar OIDC forwarding and Azure/OpenAI routing guidance. |
Review effort: Lite (dynamic)
|
|
||
| :::note[OIDC request capability is sidecar-only] | ||
| AWF forwards `ACTIONS_ID_TOKEN_REQUEST_URL` and `ACTIONS_ID_TOKEN_REQUEST_TOKEN` only to the api-proxy sidecar when `AWF_AUTH_TYPE=github-oidc`. The variables are excluded from the agent even when `--env-all`, `--env-file`, or explicit `--env` options request them. The minted GitHub JWT and exchanged provider credentials also remain inside the sidecar. | ||
| AWF forwards `ACTIONS_ID_TOKEN_REQUEST_URL` and `ACTIONS_ID_TOKEN_REQUEST_TOKEN` only to the api-proxy sidecar when `AWF_AUTH_TYPE=github-oidc` or when `GH_AW_OTLP_WORKLOAD_IDENTITY` is set for OTLP exporter workload identity (`buildOtelEnv()` in `src/services/api-proxy-env-config.ts`). The variables are excluded from the agent even when `--env-all`, `--env-file`, or explicit `--env` options request them. The minted GitHub JWT and exchanged provider credentials also remain inside the sidecar. |
This branch has not been deployed
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
main. The OTLP workload-identity forwarding path is shipped code, not pending work.Documentation Changes
docs/api-proxy-sidecar.md: the Actions OIDC variables are forwarded to the sidecar forGH_AW_OTLP_WORKLOAD_IDENTITYas well asgithub-oidc(buildOtelEnv()insrc/services/api-proxy-env-config.ts). The Azure OIDC caveat now states that native OpenAI WIF enables agent routing throughisOpenAiOidcConfigured(), and that Azure OIDC does not.docs/environment.md: the same OTLP forwarding correction in the OIDC runtime variables paragraph.docs/auth-matrix.md: the OTLP forwarding correction in the OIDC Providers section; the Azure OIDC routing note; and a new Trusted LLM service secret headers (trustedService) subsection under Custom Headers, documenting the endpoint andsecretHeaderscontract from Add opt-in trusted LLM service routing and secret headers #11345 and linking the normative spec §9.10.Canonical Registry Changes
No
AUTH-*record changes in this PR. The three corrections are documentation accuracy fixes, not new diagnosis failures.npm run diagnostics:validatereports 26 valid findings, andnpm run diagnostics:checkreports the generated artifacts are in sync.Validation
main:src/services/api-proxy-env-config.ts(buildOtelEnv,buildOidcEnv),src/services/credentials/openai-oidc-config.ts,containers/api-proxy/trusted-service.js,containers/api-proxy/providers/cloud-oidc-init.js,containers/api-proxy/providers/openai.js,containers/api-proxy/upstream-log.js.npx jest scripts/ci/auth-doctor-updater-workflow.test.ts src/services/api-proxy-env-config.test.ts containers/api-proxy/server.auth-matrix.test.jspasses (85 tests).npm run buildandnpm run lintpass with 0 errors.awf-config-spec.md#910-trusted-llm-servicesmatches the### 9.10 Trusted LLM Servicesheading. Relative links in the three edited files resolve. Two pre-existing external GitHub blob URLs were not changed.Authorizationheaders are included.docs/auth-matrix.md.ai.google.devredirects toaistudio.google.com, which the sandbox blocks, so that claim is left unchanged.Sources