JwtAuth

This module contains all the web framework independent code for parsing and verifying JSON Web Tokens.

Token verification

data VerificationError

Constructors

TokenUsedTooEarly

TokenExpired

TokenInvalid

TokenNotFound

TokenSignatureInvalid

Instances

Eq VerificationError

Defined in JwtAuth

Methods

(==) :: VerificationError -> VerificationError -> Bool

(/=) :: VerificationError -> VerificationError -> Bool

Show VerificationError

Defined in JwtAuth

Methods

showsPrec :: Int -> VerificationError -> ShowS

show :: VerificationError -> String

showList :: [VerificationError] -> ShowS

verifyToken :: POSIXTime -> Signer -> ByteString -> Either VerificationError (JWT VerifiedJWT)

Check that a token is valid at the given time for the given secret.

verifyNotBefore :: POSIXTime -> JWT VerifiedJWT -> Either VerificationError (JWT VerifiedJWT)

Verify that the token is not used before it was issued.

verifyExpiry :: POSIXTime -> JWT VerifiedJWT -> Either VerificationError (JWT VerifiedJWT)

Verify that the token is not used after is has expired.

verifySignature :: Signer -> JWT UnverifiedJWT -> Either VerificationError (JWT VerifiedJWT)

Verify that the token contains a valid signature.

decodeToken :: ByteString -> Either VerificationError (JWT UnverifiedJWT)

Claim parsing

data TokenError

Constructors

VerificationError VerificationError

JWT could not be verified.

ClaimError String

The claims do not fit the schema.

Instances

Eq TokenError

Defined in JwtAuth

Methods

(==) :: TokenError -> TokenError -> Bool

(/=) :: TokenError -> TokenError -> Bool

Show TokenError

Defined in JwtAuth

Methods

showsPrec :: Int -> TokenError -> ShowS

show :: TokenError -> String

showList :: [TokenError] -> ShowS

extractClaim :: POSIXTime -> Signer -> ByteString -> Either TokenError IcepeakClaim

Verify the token and extract the icepeak claim from it.

extractClaimUnverified :: ByteString -> Either TokenError IcepeakClaim

Extract the icepeak claim from the token without verifying it.

getIcepeakClaim :: JWT r -> Either String IcepeakClaim

Token generation

addIcepeakClaim :: IcepeakClaim -> JWTClaimsSet -> JWTClaimsSet

Add the icepeak claim to a set of JWT claims.