jwt: support custom header types #124
Merged
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
frasertweedale
force-pushed
the
fix/122-jwt-generalised-header
branch
2 times, most recently
from
f993243
to
1477082
Compare
|
ping @ericpashman - could you please review this PR and advise if it meets your needs per #122? |
frasertweedale
force-pushed
the
fix/122-jwt-generalised-header
branch
2 times, most recently
from
48ed92d
to
1534de5
Compare
Generalise the types of `signJWT`, `verifyJWT`, and related
functions to accept custom JWS header types. Add new type synonym
`SignedJWTWithHeader h` (keeping `SignedJWT` *as is*). This change
could break some applications by introducing type ambiguity.
Possible solutions include…
Type application:
```haskell
{-# LANGUAGE TypeApplications #-}
decodeCompact @SignedJWT s >>= verifyClaims settings k
```
Type annotation:
```haskell
do
jwt <- decodeCompact s
verifyClaims settings k (jwt :: SignedJWT)
```
Explicitly typed coercion function:
```haskell
let
fixType = id :: SignedJWT -> SignedJWT
in
verifyClaims settings k . fixType =<< decodeCompact s
```
I used type applications in the test suite to address the ambiguity.
Fixes: #122
frasertweedale
force-pushed
the
fix/122-jwt-generalised-header
branch
from
1534de5
to
5d49f98
Compare
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.
Generalise the types of
signJWT,verifyJWT, and related functions to accept custom JWS header types. Add new type synonymSignedJWTWithHeader h(keepingSignedJWTas is). This change could break some applications by introducing type ambiguity. The solution is to add a type annotation or apply a function like:I applied this technique in the test suite to address such ambiguity.
Fixes: #122