| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Jose.Jwt
Description
High-level JWT encoding and decoding.
See the Jose.Jws and Jose.Jwe modules for specific JWS and JWE examples.
Example usage with a key stored as a JWK:
>>>import Jose.Jwe>>>import Jose.Jwa>>>import Jose.Jwk>>>import Data.ByteString>>>import Data.Aeson (decodeStrict)>>>let jsonJwk = "{\"kty\":\"RSA\", \"kid\":\"mykey\", \"n\":\"ofgWCuLjybRlzo0tZWJjNiuSfb4p4fAkd_wWJcyQoTbji9k0l8W26mPddxHmfHQp-Vaw-4qPCJrcS2mJPMEzP1Pt0Bm4d4QlL-yRT-SFd2lZS-pCgNMsD1W_YpRPEwOWvG6b32690r2jZ47soMZo9wGzjb_7OMg0LOL-bSf63kpaSHSXndS5z5rexMdbBYUsLA9e-KXBdQOS-UTo7WTBEMa2R2CapHg665xsmtdVMTBQY4uDZlxvb3qCo5ZwKh9kG4LT6_I5IhlJH7aGhyxXFvUK-DWNmoudF8NAco9_h9iaGNj8q2ethFkMLs91kzk2PAcDTW9gb54h4FRWyuXpoQ\", \"e\":\"AQAB\", \"d\":\"Eq5xpGnNCivDflJsRQBXHx1hdR1k6Ulwe2JZD50LpXyWPEAeP88vLNO97IjlA7_GQ5sLKMgvfTeXZx9SE-7YwVol2NXOoAJe46sui395IW_GO-pWJ1O0BkTGoVEn2bKVRUCgu-GjBVaYLU6f3l9kJfFNS3E0QbVdxzubSu3Mkqzjkn439X0M_V51gfpRLI9JYanrC4D4qAdGcopV_0ZHHzQlBjudU2QvXt4ehNYTCBr6XCLQUShb1juUO1ZdiYoFaFQT5Tw8bGUl_x_jTj3ccPDVZFD9pIuhLhBOneufuBiB4cS98l2SR_RQyGWSeWjnczT0QU91p1DhOVRuOopznQ\"}" :: ByteString>>>let Just jwk = decodeStrict jsonJwk :: Maybe Jwk>>>Right (Jwt jwtEncoded) <- encode [jwk] (JwsEncoding RS256) (Claims "public claims")>>>Right jwtDecoded <- Jose.Jwt.decode [jwk] (Just (JwsEncoding RS256)) jwtEncoded>>>jwtDecodedJws (JwsHeader {jwsAlg = RS256, jwsTyp = Nothing, jwsCty = Nothing, jwsKid = Just (KeyId "mykey")},"public claims")
Synopsis
- newtype Jwt = Jwt {
- unJwt :: ByteString
- type Jwe = (JweHeader, ByteString)
- type Jws = (JwsHeader, ByteString)
- data JwtClaims = JwtClaims {}
- data JwsHeader = JwsHeader {}
- data JweHeader = JweHeader {}
- data JwtContent
- data JwtEncoding
- data JwtError
- data Payload
- encode :: MonadRandom m => [Jwk] -> JwtEncoding -> Payload -> m (Either JwtError Jwt)
- decode :: MonadRandom m => [Jwk] -> Maybe JwtEncoding -> ByteString -> m (Either JwtError JwtContent)
- decodeClaims :: FromJSON a => ByteString -> Either JwtError (JwtHeader, a)
Documentation
An encoded JWT.
Constructors
| Jwt | |
Fields
| |
type Jwe = (JweHeader, ByteString) Source #
The header and claims of a decoded JWE.
type Jws = (JwsHeader, ByteString) Source #
The header and claims of a decoded JWS.
Registered claims defined in section 4 of the JWT spec.
Constructors
| JwtClaims | |
Instances
Header content for a JWS.
Constructors
| JwsHeader | |
Instances
| FromJSON JwsHeader Source # | |
| ToJSON JwsHeader Source # | |
Defined in Jose.Types | |
| Generic JwsHeader Source # | |
| Show JwsHeader Source # | |
| Eq JwsHeader Source # | |
| type Rep JwsHeader Source # | |
Defined in Jose.Types type Rep JwsHeader = D1 ('MetaData "JwsHeader" "Jose.Types" "jose-jwt-0.9.5-8j9NRvoyMRb7Sgv5gpC9MX" 'False) (C1 ('MetaCons "JwsHeader" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jwsAlg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JwsAlg) :*: S1 ('MetaSel ('Just "jwsTyp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jwsCty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jwsKid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe KeyId))))) | |
Header content for a JWE.
Constructors
| JweHeader | |
Instances
data JwtContent Source #
A decoded JWT which can be either a JWE or a JWS, or an unsecured JWT.
Instances
| Show JwtContent Source # | |
Defined in Jose.Types Methods showsPrec :: Int -> JwtContent -> ShowS # show :: JwtContent -> String # showList :: [JwtContent] -> ShowS # | |
| Eq JwtContent Source # | |
Defined in Jose.Types | |
data JwtEncoding Source #
Defines the encoding information for a JWT.
Used for both encoding new JWTs and validating existing ones.
Constructors
| JwsEncoding JwsAlg | |
| JweEncoding JweAlg Enc |
Instances
| Show JwtEncoding Source # | |
Defined in Jose.Types Methods showsPrec :: Int -> JwtEncoding -> ShowS # show :: JwtEncoding -> String # showList :: [JwtEncoding] -> ShowS # | |
| Eq JwtEncoding Source # | |
Defined in Jose.Types | |
Decoding errors.
Constructors
| KeyError Text | No suitable key or wrong key type |
| BadAlgorithm Text | The supplied algorithm is invalid |
| BadDots Int | Wrong number of "." characters in the JWT |
| BadHeader Text | Header couldn't be decoded or contains bad data |
| BadClaims | Claims part couldn't be decoded or contains bad data |
| BadSignature | Signature is invalid |
| BadCrypto | A cryptographic operation failed |
| Base64Error String | A base64 decoding error |
The payload to be encoded in a JWT.
Constructors
| Nested Jwt | |
| Claims ByteString |
Arguments
| :: MonadRandom m | |
| => [Jwk] | The key or keys. At least one must be consistent with the chosen algorithm |
| -> JwtEncoding | The encoding algorithm(s) used to encode the payload |
| -> Payload | The payload (claims) |
| -> m (Either JwtError Jwt) | The encoded JWT, if successful |
Use the supplied JWKs to create a JWT. The list of keys will be searched to locate one which is consistent with the chosen encoding algorithms.
Arguments
| :: MonadRandom m | |
| => [Jwk] | The keys to use for decoding |
| -> Maybe JwtEncoding | The expected encoding information |
| -> ByteString | The encoded JWT |
| -> m (Either JwtError JwtContent) | The decoded JWT payload, if successful |
Uses the supplied keys to decode a JWT.
Locates a matching key by header kid value where possible
or by suitable key type for the encoding algorithm.
The algorithm(s) used can optionally be supplied for validation
by setting the JwtEncoding parameter, in which case an error will
be returned if they don't match. If you expect the tokens to use
a particular algorithm, then you should set this parameter.
For unsecured tokens (with algorithm "none"), the expected algorithm
must be set to Just (JwsEncoding None) or an error will be returned.
decodeClaims :: FromJSON a => ByteString -> Either JwtError (JwtHeader, a) Source #
Convenience function to return the claims contained in a JWS.
This is needed in situations such as client assertion authentication,
https://tools.ietf.org/html/rfc7523, where the contents of the JWT,
such as the sub claim, may be required in order to work out
which key should be used to verify the token.
Obviously this should not be used by itself to decode a token since no integrity checking is done and the contents may be forged.