Libjwt.Decoding

JWT decoding definition

This module can be considered internal to the library Users should never need to implement the Decode typeclass or use any of the exported functions or types directly. You'll only need to know of Decode typeclass if you want to write a function polymorphic in the type of payloads.

If you want to extend the types supported by the library, see Libjwt.Classes

Documentation

newtype DecodeResult t

Constructors

Result

Fields

• getOptional :: JwtIO (Maybe t)

Instances

Monad DecodeResult

Defined in Libjwt.Decoding

Methods

(>>=) :: DecodeResult a -> (a -> DecodeResult b) -> DecodeResult b

(>>) :: DecodeResult a -> DecodeResult b -> DecodeResult b

return :: a -> DecodeResult a

Functor DecodeResult

Defined in Libjwt.Decoding

Methods

fmap :: (a -> b) -> DecodeResult a -> DecodeResult b

(<$) :: a -> DecodeResult b -> DecodeResult a

Applicative DecodeResult

Defined in Libjwt.Decoding

Methods

pure :: a -> DecodeResult a

(<*>) :: DecodeResult (a -> b) -> DecodeResult a -> DecodeResult b

liftA2 :: (a -> b -> c) -> DecodeResult a -> DecodeResult b -> DecodeResult c

(*>) :: DecodeResult a -> DecodeResult b -> DecodeResult b

(<*) :: DecodeResult a -> DecodeResult b -> DecodeResult a

Alternative DecodeResult

Defined in Libjwt.Decoding

Methods

empty :: DecodeResult a

(<|>) :: DecodeResult a -> DecodeResult a -> DecodeResult a

some :: DecodeResult a -> DecodeResult [a]

many :: DecodeResult a -> DecodeResult [a]

hoistResult :: Maybe a -> DecodeResult a

Lift pure value

class ClaimDecoder t where

Low-level definition of claims decoding.

Methods

decodeClaim :: String -> JwtT -> DecodeResult t

Given a pointer to jwt_t, try to decode the value of type t

Instances

(DecoderDef a ~ ty, ClaimDecoder' ty a) => ClaimDecoder a

Defined in Libjwt.Decoding

Methods

decodeClaim :: String -> JwtT -> DecodeResult a

class Decode c where

Definition of claims decoding.

The only use for the user is probably to write a function that is polymorphic in the payload type

Methods

decode :: JwtT -> JwtIO c

Construct an action that decodes the value of type c, given a pointer to jwt_t. The action may fail.

Instances

Decode Header

Defined in Libjwt.Header

Methods

decode :: JwtT -> JwtIO Header

Decode Typ

Defined in Libjwt.Header

Methods

decode :: JwtT -> JwtIO Typ

Decode Alg

Defined in Libjwt.Header

Methods

decode :: JwtT -> JwtIO Alg

Decode Jti

Defined in Libjwt.RegisteredClaims

Methods

decode :: JwtT -> JwtIO Jti

Decode Iat

Defined in Libjwt.RegisteredClaims

Methods

decode :: JwtT -> JwtIO Iat

Decode Nbf

Defined in Libjwt.RegisteredClaims

Methods

decode :: JwtT -> JwtIO Nbf

Decode Exp

Defined in Libjwt.RegisteredClaims

Methods

decode :: JwtT -> JwtIO Exp

Decode Aud

Defined in Libjwt.RegisteredClaims

Methods

decode :: JwtT -> JwtIO Aud

Decode Sub

Defined in Libjwt.RegisteredClaims

Methods

decode :: JwtT -> JwtIO Sub

Decode Iss

Defined in Libjwt.RegisteredClaims

Methods

decode :: JwtT -> JwtIO Iss

(ty ~ DecodeAuxDef a, DecodeAux ty ns name a, CanAdd name tl, Decode (PrivateClaims tl ns)) => Decode (PrivateClaims ((name ->> a) ': tl) ns)

Defined in Libjwt.PrivateClaims

Methods

decode :: JwtT -> JwtIO (PrivateClaims ((name ->> a) ': tl) ns)

Decode (PrivateClaims Empty ns)

Defined in Libjwt.PrivateClaims

Methods

decode :: JwtT -> JwtIO (PrivateClaims Empty ns)

Decode (PrivateClaims pc ns) => Decode (Payload pc ns)

Defined in Libjwt.Payload

Methods

decode :: JwtT -> JwtIO (Payload pc ns)

getOrEmpty :: Monoid a => DecodeResult a -> JwtIO a

Action that returns mempty if decoding has failed

decodeClaimOrThrow :: ClaimDecoder t => String -> proxy t -> JwtT -> JwtIO t

Action that throws MissingClaim if decoding has failed

decodeClaimProxied :: ClaimDecoder t => String -> proxy t -> JwtT -> DecodeResult t

decodeClaim through proxy

type family Decodable t :: Constraint where ...

Equations

Decodable t = ClaimDecoder' (DecoderDef t) t

data JwtIO a

IO restricted to calling libjwt and jsmn

Instances

Monad JwtIO

Defined in Libjwt.FFI.Jwt

Methods

(>>=) :: JwtIO a -> (a -> JwtIO b) -> JwtIO b

(>>) :: JwtIO a -> JwtIO b -> JwtIO b

return :: a -> JwtIO a

Functor JwtIO

Defined in Libjwt.FFI.Jwt

Methods

fmap :: (a -> b) -> JwtIO a -> JwtIO b

(<$) :: a -> JwtIO b -> JwtIO a

Applicative JwtIO

Defined in Libjwt.FFI.Jwt

Methods

pure :: a -> JwtIO a

(<*>) :: JwtIO (a -> b) -> JwtIO a -> JwtIO b

liftA2 :: (a -> b -> c) -> JwtIO a -> JwtIO b -> JwtIO c

(*>) :: JwtIO a -> JwtIO b -> JwtIO b

(<*) :: JwtIO a -> JwtIO b -> JwtIO a

MonadThrow JwtIO

Defined in Libjwt.FFI.Jwt

Methods

throwM :: Exception e => e -> JwtIO a

MonadCatch JwtIO

Defined in Libjwt.FFI.Jwt

Methods

catch :: Exception e => JwtIO a -> (e -> JwtIO a) -> JwtIO a