Modulejose-0.13GHC2021
Crypto.JOSE.Error
JOSE error types and helpers.
Synopsis
- value runJOSE
- value unwrapJOSE
- newtype JOSE
- data Error
- class AsError
- data InvalidNumberOfParts
- value expectedParts
- value actualParts
- data CompactTextError
- data CompactDecodeError
- value _CompactInvalidNumberOfParts
- value _CompactInvalidText
- Packagejose-0.13
- Exports12
- LanguageGHC2021
- LicenceApache-2.0
- SourceError.hs
Running JOSE computations
Instances7MonadError, MonadTrans, Monad, Functor, Applicative, MonadIO, …
Monad m => MonadError e (JOSE e m)Defined in jose-0.13 · Crypto.JOSE.ErrorMonadTrans (JOSE e)Defined in jose-0.13 · Crypto.JOSE.ErrorMonad m => Monad (JOSE e m)Defined in jose-0.13 · Crypto.JOSE.ErrorFunctor m => Functor (JOSE e m)Defined in jose-0.13 · Crypto.JOSE.ErrorMonad m => Applicative (JOSE e m)Defined in jose-0.13 · Crypto.JOSE.ErrorMonadIO m => MonadIO (JOSE e m)Defined in jose-0.13 · Crypto.JOSE.ErrorMonadRandom m => MonadRandom (JOSE e m)Defined in jose-0.13 · Crypto.JOSE.Error
Base error type and class
All the errors that can occur.
Constructors
AlgorithmNotImplementedA requested algorithm is not implemented
AlgorithmMismatch StringA requested algorithm cannot be used
KeyMismatch TextWrong type of key was given
KeySizeTooSmallKey size is too small
OtherPrimesNotSupportedRSA private key with >2 primes not supported
RSAError ErrorRSA encryption, decryption or signing error
CryptoError CryptoErrorVarious cryptonite library error cases
CompactDecodeError CompactDecodeErrorWrong number of parts in compact serialisation
JSONDecodeError StringJSON (Aeson) decoding error
NoUsableKeysNo usable keys were found in the key store
JWSCritUnprotectedJWSNoValidSignaturesAnyValidatedpolicy active, and no valid signature encounteredJWSInvalidSignatureAllValidatedpolicy active, and invalid signature encounteredJWSNoSignaturesAllValidatedpolicy active, and there were no signatures on object that matched the allowed algorithms
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 ()
JOSE compact serialisation errors
The wrong number of parts were found when decoding a compact JOSE object.
Constructors
InvalidNumberOfParts Natural Naturalexpected vs actual parts
Instances2Eq, Show
Eq InvalidNumberOfPartsDefined in jose-0.13 · Crypto.JOSE.ErrorShow InvalidNumberOfPartsDefined in jose-0.13 · Crypto.JOSE.Error
Get the expected or actual number of parts.
Get the expected or actual number of parts.
Bad UTF-8 data in a compact object, at the specified index
Constructors
Instances2Eq, Show
Eq CompactTextErrorDefined in jose-0.13 · Crypto.JOSE.ErrorShow CompactTextErrorDefined in jose-0.13 · Crypto.JOSE.Error
An error when decoding a JOSE compact object.
JSON decoding errors that occur during compact object processing
throw JSONDecodeError.
Instances2Eq, Show
Eq CompactDecodeErrorDefined in jose-0.13 · Crypto.JOSE.ErrorShow CompactDecodeErrorDefined in jose-0.13 · Crypto.JOSE.Error