Modulejose-0.11Haskell2010

Crypto.JOSE.Header

Types and functions for working with JOSE header parameters.

2 types
13 classes
12 values

Packagejose-0.11
Exports27
LanguageHaskell2010
LicenceApache-2.0
SourceHeader.hs

Defining header data types

6 declarations

datadata HeaderParam p a

A header value, along with a protection indicator.

Constructors

HeaderParam p a

Instances3Functor, Eq, Show

Functor (HeaderParam p)Defined in jose-0.11 · Crypto.JOSE.Header
(Eq p, Eq a) => Eq (HeaderParam p a)Defined in jose-0.11 · Crypto.JOSE.Header
(Show p, Show a) => Show (HeaderParam p a)Defined in jose-0.11 · Crypto.JOSE.Header

classclass Eq a => ProtectionIndicator a where

Methods

getProtected :: a
Get a value for indicating protection.
getUnprotected :: Maybe a
Get a Just a value for indicating no protection, or Nothing if the type does not support unprotected headers.

Instances2ProtectionIndicator

ProtectionIndicator ProtectionDefined in jose-0.11 · Crypto.JOSE.Header
ProtectionIndicator ()Defined in jose-0.11 · Crypto.JOSE.Header

datadata Protection

Whether a header is protected or unprotected

Protected Unprotected

Instances3Eq, Show, ProtectionIndicator

Eq ProtectionDefined in jose-0.11 · Crypto.JOSE.Header
Show ProtectionDefined in jose-0.11 · Crypto.JOSE.Header
ProtectionIndicator ProtectionDefined in jose-0.11 · Crypto.JOSE.Header

valueprotection

:: Functor f
=> p -> f p
-> HeaderParam p a
-> f (HeaderParam p a)

Lens for the Protection of a HeaderParam

valueisProtected :: ProtectionIndicator p => Getter (HeaderParam p a) Bool

Getter for whether a parameter is protected

valueparam :: Functor f => (a -> f a) -> HeaderParam p a -> f (HeaderParam p a)

Lens for a HeaderParam value

Defining header parsers

6 declarations

The parseParamsFor function defines the parser for a header type.

parseParamsFor
  :: (HasParams a, HasParams b)
  => Proxy b -> Maybe Object -> Maybe Object -> Parser a

It is defined over two objects: the protected header and the unprotected header. The following functions are provided for parsing header parameters:

headerOptional: An optional parameter that may be protected or unprotected.
headerRequired: A required parameter that may be protected or unprotected.
headerOptionalProtected: An optional parameter that, if present, MUST be carried in the protected header.
headerRequiredProtected: A required parameter that, if present, MUST be carried in the protected header.

Duplicate headers are forbidden. The above functions all perform duplicate header detection. If you do not use them, be sure to perform this detection yourself!

An example parser:

instance HasParams ACMEHeader where
  parseParamsFor proxy hp hu = ACMEHeader
    <$> parseParamsFor proxy hp hu
    <*> headerRequiredProtected "nonce" hp hu

classclass HasParams (a :: Type -> Type) where

A thing with parameters.

Methods

params :: ProtectionIndicator p => a p -> [(Bool, Pair)]
Return a list of parameters, each paired with whether it is protected or not.
extensions :: Proxy a -> [Text]
List of "known extensions", i.e. keys that may appear in the "crit" header parameter.
parseParamsFor :: (HasParams b, ProtectionIndicator p) => Proxy b -> Maybe Object -> Maybe Object -> Parser (a p)

Instances2HasParams

HasParams JWEHeaderDefined in jose-0.11 · Crypto.JOSE.JWE
HasParams JWSHeaderDefined in jose-0.11 · Crypto.JOSE.JWS

valueheaderRequired

:: (FromJSON a, ProtectionIndicator p)
=> Text
-> Maybe Object
-> Maybe Object
-> Parser (HeaderParam p a)

Parse a required parameter that may be carried in either the protected or the unprotected header.

valueheaderRequiredProtected

:: FromJSON a
=> Text
-> Maybe Object
-> Maybe Object
-> Parser a

Parse a required parameter that MUST be carried in the protected header.

valueheaderOptional

:: (FromJSON a, ProtectionIndicator p)
=> Text
-> Maybe Object
-> Maybe Object
-> Parser (Maybe (HeaderParam p a))

Parse an optional parameter that may be carried in either the protected or the unprotected header.

valueheaderOptional'

:: ProtectionIndicator p
=> Value -> Parser a
-> Text
-> Maybe Object
-> Maybe Object
-> Parser (Maybe (HeaderParam p a))

Parse an optional parameter that may be carried in either the protected or the unprotected header. Like headerOptional, but with an explicit argument for the parser.

valueheaderOptionalProtected

:: FromJSON a
=> Text
-> Maybe Object
-> Maybe Object
-> Parser (Maybe a)

Parse an optional parameter that, if present, MUST be carried in the protected header.

Parsing headers

2 declarations

valueparseParams

:: (HasParams a, ProtectionIndicator p)
=> Maybe Object
protected header
-> Maybe Object
unprotected header
-> Parser (a p)

Parse a pair of objects (protected and unprotected header)

This internally invokes parseParamsFor applied to a proxy for the target type. (This allows the parsing of the "crit" parameter to access "known extensions" understood by the target type.)

valueparseCrit