Crypto.JOSE.Error

JOSE error types and helpers.

Running JOSE computations

runJOSE :: JOSE e m a -> m (Either e a)

Run the JOSE computation. Result is an Either e a where e is the error type (typically Error or JWTError)

unwrapJOSE :: JOSE e m a -> ExceptT e m a

Get the inner ExceptT value of the JOSE computation. Typically runJOSE would be preferred, unless you specifically need an ExceptT value.

newtype JOSE e m a

Constructors

JOSE (ExceptT e m a)

Instances

Monad m => MonadError e (JOSE e m)

Defined in Crypto.JOSE.Error

Methods

throwError :: e -> JOSE e m a

catchError :: JOSE e m a -> (e -> JOSE e m a) -> JOSE e m a

MonadTrans (JOSE e)

Defined in Crypto.JOSE.Error

Methods

lift :: Monad m => m a -> JOSE e m a

MonadIO m => MonadIO (JOSE e m)

Defined in Crypto.JOSE.Error

Methods

liftIO :: IO a -> JOSE e m a

Monad m => Applicative (JOSE e m)

Defined in Crypto.JOSE.Error

Methods

pure :: a -> JOSE e m a

(<*>) :: JOSE e m (a -> b) -> JOSE e m a -> JOSE e m b

liftA2 :: (a -> b -> c) -> JOSE e m a -> JOSE e m b -> JOSE e m c

(*>) :: JOSE e m a -> JOSE e m b -> JOSE e m b

(<*) :: JOSE e m a -> JOSE e m b -> JOSE e m a

Functor m => Functor (JOSE e m)

Defined in Crypto.JOSE.Error

Methods

fmap :: (a -> b) -> JOSE e m a -> JOSE e m b

(<$) :: a -> JOSE e m b -> JOSE e m a

Monad m => Monad (JOSE e m)

Defined in Crypto.JOSE.Error

Methods

(>>=) :: JOSE e m a -> (a -> JOSE e m b) -> JOSE e m b

(>>) :: JOSE e m a -> JOSE e m b -> JOSE e m b

return :: a -> JOSE e m a

MonadRandom m => MonadRandom (JOSE e m)

Defined in Crypto.JOSE.Error

Methods

getRandomBytes :: ByteArray byteArray => Int -> JOSE e m byteArray

Base error type and class

data Error

All the errors that can occur.

Constructors

AlgorithmNotImplemented

A requested algorithm is not implemented

AlgorithmMismatch String

A requested algorithm cannot be used

KeyMismatch Text

Wrong type of key was given

KeySizeTooSmall

Key size is too small

OtherPrimesNotSupported

RSA private key with >2 primes not supported

RSAError Error

RSA encryption, decryption or signing error

CryptoError CryptoError

Various cryptonite library error cases

CompactDecodeError CompactDecodeError

Wrong number of parts in compact serialisation

JSONDecodeError String

JSON (Aeson) decoding error

NoUsableKeys

No usable keys were found in the key store

JWSCritUnprotected

JWSNoValidSignatures

AnyValidated policy active, and no valid signature encountered

JWSInvalidSignature

AllValidated policy active, and invalid signature encountered

JWSNoSignatures

AllValidated policy active, and there were no signatures on object that matched the allowed algorithms

Instances

Show Error

Defined in Crypto.JOSE.Error

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

Eq Error

Defined in Crypto.JOSE.Error

Methods

(==) :: Error -> Error -> Bool

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

AsError Error

Defined in Crypto.JOSE.Error

Methods

_Error :: Prism' Error Error

_AlgorithmNotImplemented :: Prism' Error ()

_AlgorithmMismatch :: Prism' Error String

_KeyMismatch :: Prism' Error Text

_KeySizeTooSmall :: Prism' Error ()

_OtherPrimesNotSupported :: Prism' Error ()

_RSAError :: Prism' Error Error0

_CryptoError :: Prism' Error CryptoError

_CompactDecodeError :: Prism' Error CompactDecodeError

_JSONDecodeError :: Prism' Error String

_NoUsableKeys :: Prism' Error ()

_JWSCritUnprotected :: Prism' Error ()

_JWSNoValidSignatures :: Prism' Error ()

_JWSInvalidSignature :: Prism' Error ()

_JWSNoSignatures :: Prism' Error ()

class AsError r where

Minimal complete definition

_Error

Methods

_Error :: Prism' r Error

_AlgorithmNotImplemented :: Prism' r ()

_AlgorithmMismatch :: Prism' r String

_KeyMismatch :: Prism' r Text

_KeySizeTooSmall :: Prism' r ()

_OtherPrimesNotSupported :: Prism' r ()

_RSAError :: Prism' r Error

_CryptoError :: Prism' r CryptoError

_CompactDecodeError :: Prism' r CompactDecodeError

_JSONDecodeError :: Prism' r String

_NoUsableKeys :: Prism' r ()

_JWSCritUnprotected :: Prism' r ()

_JWSNoValidSignatures :: Prism' r ()

_JWSInvalidSignature :: Prism' r ()

_JWSNoSignatures :: Prism' r ()

Instances

AsError Error

Defined in Crypto.JOSE.Error

Methods

_Error :: Prism' Error Error

_AlgorithmNotImplemented :: Prism' Error ()

_AlgorithmMismatch :: Prism' Error String

_KeyMismatch :: Prism' Error Text

_KeySizeTooSmall :: Prism' Error ()

_OtherPrimesNotSupported :: Prism' Error ()

_RSAError :: Prism' Error Error0

_CryptoError :: Prism' Error CryptoError

_CompactDecodeError :: Prism' Error CompactDecodeError

_JSONDecodeError :: Prism' Error String

_NoUsableKeys :: Prism' Error ()

_JWSCritUnprotected :: Prism' Error ()

_JWSNoValidSignatures :: Prism' Error ()

_JWSInvalidSignature :: Prism' Error ()

_JWSNoSignatures :: Prism' Error ()

AsError JWTError

Defined in Crypto.JWT

Methods

_Error :: Prism' JWTError Error

_AlgorithmNotImplemented :: Prism' JWTError ()

_AlgorithmMismatch :: Prism' JWTError String

_KeyMismatch :: Prism' JWTError Text

_KeySizeTooSmall :: Prism' JWTError ()

_OtherPrimesNotSupported :: Prism' JWTError ()

_RSAError :: Prism' JWTError Error

_CryptoError :: Prism' JWTError CryptoError

_CompactDecodeError :: Prism' JWTError CompactDecodeError

_JSONDecodeError :: Prism' JWTError String

_NoUsableKeys :: Prism' JWTError ()

_JWSCritUnprotected :: Prism' JWTError ()

_JWSNoValidSignatures :: Prism' JWTError ()

_JWSInvalidSignature :: Prism' JWTError ()

_JWSNoSignatures :: Prism' JWTError ()

JOSE compact serialisation errors

data InvalidNumberOfParts

The wrong number of parts were found when decoding a compact JOSE object.

Constructors

InvalidNumberOfParts Natural Natural

expected vs actual parts

Instances

Show InvalidNumberOfParts

Defined in Crypto.JOSE.Error

Methods

showsPrec :: Int -> InvalidNumberOfParts -> ShowS

show :: InvalidNumberOfParts -> String

showList :: [InvalidNumberOfParts] -> ShowS

Eq InvalidNumberOfParts

Defined in Crypto.JOSE.Error

Methods

(==) :: InvalidNumberOfParts -> InvalidNumberOfParts -> Bool

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

expectedParts :: Getter InvalidNumberOfParts Natural

Get the expected or actual number of parts.

actualParts :: Getter InvalidNumberOfParts Natural

Get the expected or actual number of parts.

data CompactTextError

Bad UTF-8 data in a compact object, at the specified index

Constructors

CompactTextError Natural UnicodeException

Instances

Show CompactTextError

Defined in Crypto.JOSE.Error

Methods

showsPrec :: Int -> CompactTextError -> ShowS

show :: CompactTextError -> String

showList :: [CompactTextError] -> ShowS

Eq CompactTextError

Defined in Crypto.JOSE.Error

Methods

(==) :: CompactTextError -> CompactTextError -> Bool

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

data CompactDecodeError

An error when decoding a JOSE compact object. JSON decoding errors that occur during compact object processing throw JSONDecodeError.

Constructors

CompactInvalidNumberOfParts InvalidNumberOfParts

CompactInvalidText CompactTextError

Instances

Show CompactDecodeError

Defined in Crypto.JOSE.Error

Methods

showsPrec :: Int -> CompactDecodeError -> ShowS

show :: CompactDecodeError -> String

showList :: [CompactDecodeError] -> ShowS

Eq CompactDecodeError

Defined in Crypto.JOSE.Error

Methods

(==) :: CompactDecodeError -> CompactDecodeError -> Bool

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

_CompactInvalidNumberOfParts :: Prism' CompactDecodeError InvalidNumberOfParts

_CompactInvalidText :: Prism' CompactDecodeError CompactTextError