kylefang/graphql-engine
1
0
Fork 0
mirror of https://github.com/zhigang1992/graphql-engine.git synced 2026-04-29 04:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

type is not required for jwk_url in JWT config (#4334)

Browse Source 
* type is not required for jwk_url

* remove type from JWTConfig

* Omit type field in JWTConfig serialization if jwk_url is provided

* remove type from jwk_url test suite

* add changelog

* fix docs with new format

Co-authored-by: Alexis King <lexi.lambda@gmail.com>
This commit is contained in:
Tirumarai Selvan
2020-04-10 19:25:59 +05:30
committed by GitHub
parent 8b85c86ebe
commit 76fbe90b60
4 changed files with 27 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
server/src-lib/Hasura/Server/Auth/JWT.hs
View File

@@ -61,8 +61,7 @@ $(J.deriveJSON J.defaultOptions { J.sumEncoding = J.ObjectWithSingleField
data JWTConfig
= JWTConfig
{ jcType :: !T.Text
, jcKeyOrUrl :: !(Either Jose.JWK URI)
{ jcKeyOrUrl :: !(Either Jose.JWK URI)
, jcClaimNs :: !(Maybe T.Text)
, jcAudience :: !(Maybe Jose.Audience)
, jcClaimsFormat :: !(Maybe JWTClaimsFormat)
@@ -369,18 +368,18 @@ verifyJwt ctx (RawJWT rawJWT) = do
instance J.ToJSON JWTConfig where
toJSON (JWTConfig ty keyOrUrl claimNs aud claimsFmt iss) =
case keyOrUrl of
Left _ -> mkObj ("key" J..= J.String "<JWK REDACTED>")
Right url -> mkObj ("jwk_url" J..= url)
toJSON (JWTConfig keyOrUrl claimNs aud claimsFmt iss) =
J.object (jwkFields ++ sharedFields)
where
mkObj item = J.object [ "type" J..= ty
, "claims_namespace" J..= claimNs
, "claims_format" J..= claimsFmt
, "audience" J..= aud
, "issuer" J..= iss
, item
]
jwkFields = case keyOrUrl of
Left _ -> [ "type" J..= J.String "<TYPE REDACTED>"
, "key" J..= J.String "<JWK REDACTED>" ]
Right url -> [ "jwk_url" J..= url ]
sharedFields = [ "claims_namespace" J..= claimNs
, "claims_format" J..= claimsFmt
, "audience" J..= aud
, "issuer" J..= iss
]
-- | Parse from a json string like:
-- | `{"type": "RS256", "key": "<PEM-encoded-public-key-or-X509-cert>"}`
@@ -388,7 +387,6 @@ instance J.ToJSON JWTConfig where
instance J.FromJSON JWTConfig where
parseJSON = J.withObject "JWTConfig" $ \o -> do
keyType <- o J..: "type"
mRawKey <- o J..:? "key"
claimNs <- o J..:? "claims_namespace"
aud <- o J..:? "audience"
@@ -400,13 +398,14 @@ instance J.FromJSON JWTConfig where
(Nothing, Nothing) -> fail "key and jwk_url both cannot be empty"
(Just _, Just _) -> fail "key, jwk_url both cannot be present"
(Just rawKey, Nothing) -> do
key <- parseKey keyType rawKey
return $ JWTConfig keyType (Left key) claimNs aud isStrngfd iss
keyType <- o J..: "type"
key <- parseKey rawKey keyType
return $ JWTConfig (Left key) claimNs aud isStrngfd iss
(Nothing, Just url) ->
return $ JWTConfig keyType (Right url) claimNs aud isStrngfd iss
return $ JWTConfig (Right url) claimNs aud isStrngfd iss
where
parseKey keyType rawKey =
parseKey rawKey keyType =
case keyType of
"HS256" -> runEither $ parseHmacKey rawKey 256
"HS384" -> runEither $ parseHmacKey rawKey 384