Add support for additional header claims in signJWT() function #5
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
In addition to providing token body claims, the options provided to `signJWT()` include additional header claims that can augment (or overwrite) the standard JWT header claims. Also added a couple more tests making it clear that `validateJWT()` does not trust the algorithm claim in the JWT 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.
Related to issue #4, this PR opens up the ability by callers to provide additional header claims when creating/signing a JWT. I originally was going to limit it to the
kidclaim, but then realized that others may have similar but different needs, so I made it possible to set any header claims:In addition to providing token body claims as part of the function signature, the options provided to
signJWT()include additional header claims that can augment (or overwrite) the standard JWT header claims.Since additional header claims are relatively useless if there is no way to read the JWT header (JOSE header, to be precise), I added a
unsafeParseJOSEHeader()function that can be used by token recipients to read the full header and determine the value of thekidclaim and choose the correct public key to pass tovalidateJWT().Also added a couple more tests making it clear that
validateJWT()does not trust the algorithm claim in the JWT header.