Enhanced debugging for OIDC token exchange#2443
Open
Lanaparezanin wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Improves diagnosability of the OIDC ID token exchange flow in @actions/core by enriching error messages and ensuring sensitive request tokens are masked in logs during failures.
Changes:
- Expanded missing-OIDC-permissions error messages for
ACTIONS_ID_TOKEN_REQUEST_TOKENandACTIONS_ID_TOKEN_REQUEST_URL. - Added
setSecret(token)for the OIDC request token to ensure it gets masked if it appears in logs. - Improved the “missing ID token in response” error message with HTTP status and actionable troubleshooting guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
31
to
35
| throw new Error( | ||
| 'Unable to get ACTIONS_ID_TOKEN_REQUEST_TOKEN env variable' | ||
| 'Unable to get ACTIONS_ID_TOKEN_REQUEST_TOKEN env variable. Ensure your workflow has:\n' + | ||
| ' permissions:\n' + | ||
| ' id-token: write' | ||
| ) |
Comment on lines
43
to
+48
| if (!runtimeUrl) { | ||
| throw new Error('Unable to get ACTIONS_ID_TOKEN_REQUEST_URL env variable') | ||
| throw new Error( | ||
| 'Unable to get ACTIONS_ID_TOKEN_REQUEST_URL env variable. Ensure your workflow has:\n' + | ||
| ' permissions:\n' + | ||
| ' id-token: write' | ||
| ) |
Comment on lines
+68
to
+71
| throw new Error( | ||
| `Response json body does not have ID Token field (HTTP ${res.statusCode}). ` + | ||
| 'Verify that the audience is correct and that the token service URL is reachable.' | ||
| ) |
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.
In NuGet, we want to change our OIDC implementation to use toolkit functions. I am enhancing these logs to support that transition.