Safe Haskell	None
Language	Haskell2010

Crypto.JOSE.Error

Contents

JOSE compact serialisation errors
Orphan instances

Description

JOSE error types.

Synopsis

data Error
- = AlgorithmNotImplemented
- | AlgorithmMismatch String
- | KeyMismatch Text
- | KeySizeTooSmall
- | OtherPrimesNotSupported
- | RSAError Error
- | CryptoError CryptoError
- | CompactDecodeError CompactDecodeError
- | JSONDecodeError String
- | NoUsableKeys
- | JWSCritUnprotected
- | JWSNoValidSignatures
- | JWSInvalidSignature
- | JWSNoSignatures
class AsError r where
- _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 ()
data InvalidNumberOfParts = InvalidNumberOfParts Natural Natural
expectedParts :: Getter InvalidNumberOfParts Natural
actualParts :: Getter InvalidNumberOfParts Natural
data CompactTextError = CompactTextError Natural UnicodeException
data CompactDecodeError
- = CompactInvalidNumberOfParts InvalidNumberOfParts
- | CompactInvalidText CompactTextError
_CompactInvalidNumberOfParts :: Prism' CompactDecodeError InvalidNumberOfParts
_CompactInvalidText :: Prism' CompactDecodeError CompactTextError

Documentation

data Error Source #

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

Instances details

Eq Error Source #
Instance details Defined in Crypto.JOSE.Error Methods (==) :: Error -> Error -> Bool (/=) :: Error -> Error -> Bool
Show Error Source #
Instance details Defined in Crypto.JOSE.Error Methods showsPrec :: Int -> Error -> ShowS show :: Error -> String showList :: [Error] -> ShowS
AsError Error Source #
Instance details Defined in Crypto.JOSE.Error Methods _Error :: Prism' Error Error Source # _AlgorithmNotImplemented :: Prism' Error () Source # _AlgorithmMismatch :: Prism' Error String Source # _KeyMismatch :: Prism' Error Text Source # _KeySizeTooSmall :: Prism' Error () Source # _OtherPrimesNotSupported :: Prism' Error () Source # _RSAError :: Prism' Error Error0 Source # _CryptoError :: Prism' Error CryptoError Source # _CompactDecodeError :: Prism' Error CompactDecodeError Source # _JSONDecodeError :: Prism' Error String Source # _NoUsableKeys :: Prism' Error () Source # _JWSCritUnprotected :: Prism' Error () Source # _JWSNoValidSignatures :: Prism' Error () Source # _JWSInvalidSignature :: Prism' Error () Source # _JWSNoSignatures :: Prism' Error () Source #

class AsError r where Source #

Minimal complete definition

_Error

Methods

_Error :: Prism' r Error Source #

_AlgorithmNotImplemented :: Prism' r () Source #

_AlgorithmMismatch :: Prism' r String Source #

_KeyMismatch :: Prism' r Text Source #

_KeySizeTooSmall :: Prism' r () Source #

_OtherPrimesNotSupported :: Prism' r () Source #

_RSAError :: Prism' r Error Source #

_CryptoError :: Prism' r CryptoError Source #

_CompactDecodeError :: Prism' r CompactDecodeError Source #

_JSONDecodeError :: Prism' r String Source #

_NoUsableKeys :: Prism' r () Source #

_JWSCritUnprotected :: Prism' r () Source #

_JWSNoValidSignatures :: Prism' r () Source #

_JWSInvalidSignature :: Prism' r () Source #

_JWSNoSignatures :: Prism' r () Source #

Instances

Instances details

AsError Error Source #
Instance details Defined in Crypto.JOSE.Error Methods _Error :: Prism' Error Error Source # _AlgorithmNotImplemented :: Prism' Error () Source # _AlgorithmMismatch :: Prism' Error String Source # _KeyMismatch :: Prism' Error Text Source # _KeySizeTooSmall :: Prism' Error () Source # _OtherPrimesNotSupported :: Prism' Error () Source # _RSAError :: Prism' Error Error0 Source # _CryptoError :: Prism' Error CryptoError Source # _CompactDecodeError :: Prism' Error CompactDecodeError Source # _JSONDecodeError :: Prism' Error String Source # _NoUsableKeys :: Prism' Error () Source # _JWSCritUnprotected :: Prism' Error () Source # _JWSNoValidSignatures :: Prism' Error () Source # _JWSInvalidSignature :: Prism' Error () Source # _JWSNoSignatures :: Prism' Error () Source #
AsError JWTError Source #
Instance details Defined in Crypto.JWT Methods _Error :: Prism' JWTError Error Source # _AlgorithmNotImplemented :: Prism' JWTError () Source # _AlgorithmMismatch :: Prism' JWTError String Source # _KeyMismatch :: Prism' JWTError Text Source # _KeySizeTooSmall :: Prism' JWTError () Source # _OtherPrimesNotSupported :: Prism' JWTError () Source # _RSAError :: Prism' JWTError Error Source # _CryptoError :: Prism' JWTError CryptoError Source # _CompactDecodeError :: Prism' JWTError CompactDecodeError Source # _JSONDecodeError :: Prism' JWTError String Source # _NoUsableKeys :: Prism' JWTError () Source # _JWSCritUnprotected :: Prism' JWTError () Source # _JWSNoValidSignatures :: Prism' JWTError () Source # _JWSInvalidSignature :: Prism' JWTError () Source # _JWSNoSignatures :: Prism' JWTError () Source #

JOSE compact serialisation errors

data InvalidNumberOfParts Source #

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

Constructors

InvalidNumberOfParts Natural Natural

expected vs actual parts

Instances

Instances details

Eq InvalidNumberOfParts Source #
Instance details Defined in Crypto.JOSE.Error Methods (==) :: InvalidNumberOfParts -> InvalidNumberOfParts -> Bool (/=) :: InvalidNumberOfParts -> InvalidNumberOfParts -> Bool
Show InvalidNumberOfParts Source #
Instance details Defined in Crypto.JOSE.Error Methods showsPrec :: Int -> InvalidNumberOfParts -> ShowS show :: InvalidNumberOfParts -> String showList :: [InvalidNumberOfParts] -> ShowS

expectedParts :: Getter InvalidNumberOfParts Natural Source #

Get the expected or actual number of parts.

actualParts :: Getter InvalidNumberOfParts Natural Source #

Get the expected or actual number of parts.

data CompactTextError Source #

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

Constructors

CompactTextError Natural UnicodeException

Instances

Instances details

Eq CompactTextError Source #
Instance details Defined in Crypto.JOSE.Error Methods (==) :: CompactTextError -> CompactTextError -> Bool (/=) :: CompactTextError -> CompactTextError -> Bool
Show CompactTextError Source #
Instance details Defined in Crypto.JOSE.Error Methods showsPrec :: Int -> CompactTextError -> ShowS show :: CompactTextError -> String showList :: [CompactTextError] -> ShowS

data CompactDecodeError Source #

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

Instances details

Eq CompactDecodeError Source #
Instance details Defined in Crypto.JOSE.Error Methods (==) :: CompactDecodeError -> CompactDecodeError -> Bool (/=) :: CompactDecodeError -> CompactDecodeError -> Bool
Show CompactDecodeError Source #
Instance details Defined in Crypto.JOSE.Error Methods showsPrec :: Int -> CompactDecodeError -> ShowS show :: CompactDecodeError -> String showList :: [CompactDecodeError] -> ShowS

_CompactInvalidNumberOfParts :: Prism' CompactDecodeError InvalidNumberOfParts Source #

_CompactInvalidText :: Prism' CompactDecodeError CompactTextError Source #

Orphan instances

(MonadRandom m, MonadTrans t, Functor (t m), Monad (t m)) => MonadRandom (t m) Source #
Instance details Methods getRandomBytes :: ByteArray byteArray => Int -> t m byteArray