JsonWebToken exposes Header Claims #3170
Open
Conversation
This file contains 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
There was a problem hiding this comment.
Pull Request Overview
This pull request exposes the JWT header claims by adding an API to retrieve the header claims as a list of Claim objects. It also adds tests to ensure that the default header claims ("alg", "typ", and "kid") are present.
- Added a new property HeaderClaims to return header claims.
- Introduced a test case verifying the header claims count and content.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/Microsoft.IdentityModel.JsonWebTokens.Tests/JsonWebTokenTests.cs | Added test verifying the HeaderClaims API returns default claims. |
| src/Microsoft.IdentityModel.JsonWebTokens/JsonWebToken.cs | Added the HeaderClaims property to expose JWT header claims. |
SummarySummary
CoverageMicrosoft.IdentityModel.JsonWebTokens - 80.3%
|
keegan-caruso
commented
Mar 12, 2025
| /// A <see cref="Claim"/> requires each value to be represented as a string. If the value was not a string, then <see cref="Claim.Type"/> contains the json type. | ||
| /// <see cref="JsonClaimValueTypes"/> and <see cref="ClaimValueTypes"/> to determine the json type. | ||
| /// </remarks> | ||
| public IReadOnlyList<Claim> HeaderClaims => Header.Claims(Issuer ?? ClaimsIdentity.DefaultIssuer); |
There was a problem hiding this comment.
Alternatives: Only expose header names, and then call GetHeaderValue(key) with each key from the header names, or reparse the encoded header
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.
JsonWebToken exposes Header Claims
The JsonWebToken should provide an API that allows access to the JWT header keys, values, and claim value types, this is done already through the Claim type.
Fixes #3164