Crypto.JOSE.Header

Types and functions for working with JOSE header parameters.

Documentation

class HasParams a where

Minimal complete definition

params, parseParamsFor

Methods

params :: a -> [(Protection, Pair)]

extensions :: Proxy a -> [Text]

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

Instances

HasParams JWSHeader

Methods

params :: JWSHeader -> [(Protection, Pair)]

extensions :: Proxy * JWSHeader -> [Text]

parseParamsFor :: HasParams b => Proxy * b -> Maybe Object -> Maybe Object -> Parser JWSHeader

HasParams JWEHeader

Methods

params :: JWEHeader -> [(Protection, Pair)]

extensions :: Proxy * JWEHeader -> [Text]

parseParamsFor :: HasParams b => Proxy * b -> Maybe Object -> Maybe Object -> Parser JWEHeader

parseParams :: forall a. HasParams a => Maybe Object -> Maybe Object -> Parser a

protectedParamsEncoded :: HasParams a => a -> ByteString

unprotectedParams

Arguments

:: HasParams a

=> a

-> Maybe Value

Object

parseCrit :: (Foldable t0, Foldable t1, Traversable t2, Traversable t3, Monad m) => t0 Text -> t1 Text -> Object -> t2 (t3 Text) -> m (t2 (t3 Text))

data Protection

Constructors

Protected

Unprotected

Instances

Eq Protection

Methods

(==) :: Protection -> Protection -> Bool

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

Show Protection

Methods

showsPrec :: Int -> Protection -> ShowS

show :: Protection -> String

showList :: [Protection] -> ShowS

data HeaderParam a

Constructors

HeaderParam Protection a

Instances

Eq a => Eq (HeaderParam a)

Methods

(==) :: HeaderParam a -> HeaderParam a -> Bool

(/=) :: HeaderParam a -> HeaderParam a -> Bool

Show a => Show (HeaderParam a)

Methods

showsPrec :: Int -> HeaderParam a -> ShowS

show :: HeaderParam a -> String

showList :: [HeaderParam a] -> ShowS

protection :: HeaderParam a -> Protection

param :: HeaderParam a -> a

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

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

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

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

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

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