Skip to content

[docs] auth: Correct auth OIDC forwarding, OpenAI routing, and trusted-service docs - #11572

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/auth-doctor-otlp-openai-trusted-service-20261114-ec6212d06480c1b6
Open

github-actions[bot] wants to merge 1 commit into
mainfrom
docs/auth-doctor-otlp-openai-trusted-service-20261114-ec6212d06480c1b6

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

Documentation Changes

  • docs/api-proxy-sidecar.md: the Actions OIDC variables are forwarded to the sidecar for GH_AW_OTLP_WORKLOAD_IDENTITY as well as github-oidc (buildOtelEnv() in src/services/api-proxy-env-config.ts). The Azure OIDC caveat now states that native OpenAI WIF enables agent routing through isOpenAiOidcConfigured(), 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 and secretHeaders contract 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:validate reports 26 valid findings, and npm run diagnostics:check reports the generated artifacts are in sync.

Validation

  • Implementation checked on 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.
  • Tests: 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.js passes (85 tests). npm run build and npm run lint pass with 0 errors.
  • Markdown: the new anchor awf-config-spec.md#910-trusted-llm-services matches the ### 9.10 Trusted LLM Services heading. Relative links in the three edited files resolve. Two pre-existing external GitHub blob URLs were not changed.
  • Credential-leakage review: the diff was searched for JWT, key, Bearer, and credential-bearing URL patterns. No matches. No secret values, tokens, or Authorization headers are included.
  • Not verified: the Gemini API-key migration claim in docs/auth-matrix.md. ai.google.dev redirects to aistudio.google.com, which the sandbox blocks, so that claim is left unchanged.

Sources

Generated by Auth Doctor Updater · copilot · routed: haiku55 xhigh · ~74 AIC · ⊞ 9.4K · ◷

- 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>
@github-actions github-actions Bot added ai-generated documentation Improvements or additions to documentation labels Nov 14, 2026
Copilot AI dynamic review requested due to automatic review settings November 14, 2026 03:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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 secretHeaders contract 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)

Comment thread docs/api-proxy-sidecar.md

:::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

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-generated documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant