Preserve insertion order for claims#656
Merged
jimmyjames merged 4 commits intoauth0:masterfrom Mar 27, 2023
Merged
Conversation
jimmyjames
previously approved these changes
Mar 27, 2023
Contributor
jimmyjames
left a comment
There was a problem hiding this comment.
👍 nice change, thanks!
Contributor
Author
|
Oh, there's some interaction with the other PR that was just merged. |
Contributor
Author
|
Fixed! All that was needed was to use |
jimmyjames
approved these changes
Mar 27, 2023
Merged
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.
Changes
Make header and payload fields in the resulting JWT have the same order as they were added to the
JWTCreator.Builder.When looking at a decoded JWT it's easier to see if all expected claims are included when they aren't scrambled.
Very small change, only changed
HashMaptoLinkedHashMapforheaderClaimsandpayloadClaimsinJWTCreator.Builder.A more complicated variant could allow selection of different orderings, e.g.
scrambled(current),insertion order(this) andalphabetically sorted(e.g. by usingTreeMap).Order was unspecified before (since
HashMapwas used), now it's deterministic.References
None that I know of.
Testing
I've added a test that verifies that both header and payload claims are in insertion order.
The test doesn't care about where any other header fields are inserted, such as
algortyp(they will be last since they're added in thesignmethod).Checklist