GHC 10.0.0.20260917 · lts/ghc-10.0.x · 77a8662 · 2026-10-31
Modulejose-0.13GHC2021
Types and functions for working with JOSE header parameters.
A header value, along with a protection indicator.
HeaderParam p aFunctor (HeaderParam p)Defined in jose-0.13 · Crypto.JOSE.Header(Eq p, Eq a) => Eq (HeaderParam p a)Defined in jose-0.13 · Crypto.JOSE.Header(Show p, Show a) => Show (HeaderParam p a)Defined in jose-0.13 · Crypto.JOSE.HeaderConvenience constructor for a protected HeaderParam.
Convenience constructor for a protected HeaderParam.
Class that defines the protected and (if supported) unprotected values for a protection indicator data type.
getProtected :: aGet a value for indicating protection.
getUnprotected :: Maybe aProtectionSupport OptionalProtectionDefined in jose-0.13 · Crypto.JOSE.HeaderProtectionSupport RequiredProtectionDefined in jose-0.13 · Crypto.JOSE.HeaderDeprecated. renamed to 'ProtectionSupport.
Use this protection type when the serialisation supports both protected and unprotected headers.
Eq OptionalProtectionDefined in jose-0.13 · Crypto.JOSE.HeaderShow OptionalProtectionDefined in jose-0.13 · Crypto.JOSE.HeaderProtectionSupport OptionalProtectionDefined in jose-0.13 · Crypto.JOSE.HeaderUse this protection type when the serialisation only supports protected headers.
Eq RequiredProtectionDefined in jose-0.13 · Crypto.JOSE.HeaderShow RequiredProtectionDefined in jose-0.13 · Crypto.JOSE.HeaderProtectionSupport RequiredProtectionDefined in jose-0.13 · Crypto.JOSE.HeaderHasParams a => FromCompact (JWS Identity RequiredProtection a)Defined in jose-0.13 · Crypto.JOSE.JWSHasParams a => ToCompact (JWS Identity RequiredProtection a)Defined in jose-0.13 · Crypto.JOSE.JWSDeprecated. renamed to OptionalProtection.
Lens for the Protection of a HeaderParam
Getter for whether a parameter is protected
Lens for a HeaderParam value
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:
An optional parameter that may be protected or unprotected.
A required parameter that may be protected or unprotected.
An optional parameter that, if present, MUST be carried in the protected header.
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
A thing with parameters.
params :: ProtectionSupport 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, ProtectionSupport p) => Proxy b -> Maybe Object -> Maybe Object -> Parser (a p)Parse a required parameter that may be carried in either the protected or the unprotected header.
Parse a required parameter that MUST be carried in the protected header.
Parse an optional parameter that may be carried in either the protected or the unprotected header.
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.
Parse an optional parameter that, if present, MUST be carried in the protected header.
parseParams 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.)
parseCrit :: (Foldable t0, Foldable t1, Traversable t2, Traversable t3, MonadFail m)=> t0 Textreserved header parameters
-> t1 Textrecognised extensions
-> Objectfull header (union of protected and unprotected headers)
-> t2 (t3 Text)crit header
-> m (t2 (t3 Text))Parse a "crit" header param
Fails if:
any reserved header appears in "crit" header
any value in "crit" is not a recognised extension
any value in "crit" does not have a corresponding key in the object
Return the base64url-encoded protected parameters
Return unprotected params as a JSON Value (always an object)
alg :: Lens' (a p) (HeaderParam p Alg)HasJWSHeader a => HasAlg aDefined in jose-0.13 · Crypto.JOSE.JWS · orphanjku :: Lens' (a p) (Maybe (HeaderParam p URI))HasJWSHeader a => HasJku aDefined in jose-0.13 · Crypto.JOSE.JWS · orphanjwk :: Lens' (a p) (Maybe (HeaderParam p JWK))HasJWSHeader a => HasJwk aDefined in jose-0.13 · Crypto.JOSE.JWS · orphankid :: Lens' (a p) (Maybe (HeaderParam p Text))HasJWSHeader a => HasKid aDefined in jose-0.13 · Crypto.JOSE.JWS · orphanx5u :: Lens' (a p) (Maybe (HeaderParam p URI))HasJWSHeader a => HasX5u aDefined in jose-0.13 · Crypto.JOSE.JWS · orphanx5c :: Lens' (a p) (Maybe (HeaderParam p (NonEmpty SignedCertificate)))HasJWSHeader a => HasX5c aDefined in jose-0.13 · Crypto.JOSE.JWS · orphanx5t :: Lens' (a p) (Maybe (HeaderParam p Base64SHA1))HasJWSHeader a => HasX5t aDefined in jose-0.13 · Crypto.JOSE.JWS · orphanx5tS256 :: Lens' (a p) (Maybe (HeaderParam p Base64SHA256))HasJWSHeader a => HasX5tS256 aDefined in jose-0.13 · Crypto.JOSE.JWS · orphantyp :: Lens' (a p) (Maybe (HeaderParam p Text))HasJWSHeader a => HasTyp aDefined in jose-0.13 · Crypto.JOSE.JWS · orphancty :: Lens' (a p) (Maybe (HeaderParam p Text))HasJWSHeader a => HasCty aDefined in jose-0.13 · Crypto.JOSE.JWS · orphanHasJWSHeader a => HasCrit aDefined in jose-0.13 · Crypto.JOSE.JWS · orphan