Servant.Auth.Server.Internal.JWT

Documentation

class FromJWT a where

How to decode data from a JWT.

The default implementation assumes the data is stored in the unregistered dat claim, and uses the FromJSON instance to decode value from there.

Methods

decodeJWT :: ClaimsSet -> Either Text a

decodeJWT :: FromJSON a => ClaimsSet -> Either Text a

class ToJWT a where

How to encode data from a JWT.

The default implementation stores data in the unregistered dat claim, and uses the type's ToJSON instance to encode the data.

Methods

encodeJWT :: a -> ClaimsSet

encodeJWT :: ToJSON a => a -> ClaimsSet

jwtAuthCheck :: FromJWT usr => JWTSettings -> AuthCheck usr

A JWT AuthCheck. You likely won't need to use this directly unless you are protecting a Raw endpoint.

makeJWT :: ToJWT a => a -> JWTSettings -> Maybe UTCTime -> IO (Either Error ByteString)

Creates a JWT containing the specified data. The data is stored in the dat claim. The 'Maybe UTCTime' argument indicates the time at which the token expires.