Crypto.JOSE.JWS

JSON Web Signature (JWS) represents content secured with digital signatures or Message Authentication Codes (MACs) using JavaScript Object Notation (JSON) based data structures.

Documentation

data Alg

JWA §3.1. "alg" (Algorithm) Header Parameters for JWS

Constructors

HS256

HS384

HS512

RS256

RS384

RS512

ES256

ES384

ES512

PS256

PS384

PS512

None

Instances

Eq Alg

Methods

(==) :: Alg -> Alg -> Bool

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

Ord Alg

Methods

compare :: Alg -> Alg -> Ordering

(<) :: Alg -> Alg -> Bool

(<=) :: Alg -> Alg -> Bool

(>) :: Alg -> Alg -> Bool

(>=) :: Alg -> Alg -> Bool

max :: Alg -> Alg -> Alg

min :: Alg -> Alg -> Alg

Show Alg

Methods

showsPrec :: Int -> Alg -> ShowS

show :: Alg -> String

showList :: [Alg] -> ShowS

ToJSON Alg

Methods

toJSON :: Alg -> Value

toEncoding :: Alg -> Encoding

toJSONList :: [Alg] -> Value

toEncodingList :: [Alg] -> Encoding

FromJSON Alg

Methods

parseJSON :: Value -> Parser Alg

parseJSONList :: Value -> Parser [Alg]

class HasJWSHeader c where

Minimal complete definition

jWSHeader

Methods

jWSHeader :: Lens' c JWSHeader

jwsHeaderAlg :: Lens' c (HeaderParam Alg)

jwsHeaderCrit :: Lens' c (Maybe (NonEmpty Text))

jwsHeaderCty :: Lens' c (Maybe (HeaderParam String))

jwsHeaderJku :: Lens' c (Maybe (HeaderParam URI))

jwsHeaderJwk :: Lens' c (Maybe (HeaderParam JWK))

jwsHeaderKid :: Lens' c (Maybe (HeaderParam String))

jwsHeaderTyp :: Lens' c (Maybe (HeaderParam String))

jwsHeaderX5c :: Lens' c (Maybe (HeaderParam (NonEmpty Base64X509)))

jwsHeaderX5t :: Lens' c (Maybe (HeaderParam Base64SHA1))

jwsHeaderX5tS256 :: Lens' c (Maybe (HeaderParam Base64SHA256))

jwsHeaderX5u :: Lens' c (Maybe (HeaderParam URI))

Instances

HasJWSHeader JWSHeader

Methods

jWSHeader :: Lens' JWSHeader JWSHeader

jwsHeaderAlg :: Lens' JWSHeader (HeaderParam Alg)

jwsHeaderCrit :: Lens' JWSHeader (Maybe (NonEmpty Text))

jwsHeaderCty :: Lens' JWSHeader (Maybe (HeaderParam String))

jwsHeaderJku :: Lens' JWSHeader (Maybe (HeaderParam URI))

jwsHeaderJwk :: Lens' JWSHeader (Maybe (HeaderParam JWK))

jwsHeaderKid :: Lens' JWSHeader (Maybe (HeaderParam String))

jwsHeaderTyp :: Lens' JWSHeader (Maybe (HeaderParam String))

jwsHeaderX5c :: Lens' JWSHeader (Maybe (HeaderParam (NonEmpty Base64X509)))

jwsHeaderX5t :: Lens' JWSHeader (Maybe (HeaderParam Base64SHA1))

jwsHeaderX5tS256 :: Lens' JWSHeader (Maybe (HeaderParam Base64SHA256))

jwsHeaderX5u :: Lens' JWSHeader (Maybe (HeaderParam URI))

data JWSHeader

JWS Header data type.

Constructors

JWSHeader

Fields

• _jwsHeaderAlg :: HeaderParam Alg
• _jwsHeaderJku :: Maybe (HeaderParam URI)

  JWK Set URL

• _jwsHeaderJwk :: Maybe (HeaderParam JWK)
• _jwsHeaderKid :: Maybe (HeaderParam String)

  interpretation unspecified

• _jwsHeaderX5u :: Maybe (HeaderParam URI)
• _jwsHeaderX5c :: Maybe (HeaderParam (NonEmpty Base64X509))
• _jwsHeaderX5t :: Maybe (HeaderParam Base64SHA1)
• _jwsHeaderX5tS256 :: Maybe (HeaderParam Base64SHA256)
• _jwsHeaderTyp :: Maybe (HeaderParam String)

  Content Type (of object)

• _jwsHeaderCty :: Maybe (HeaderParam String)

  Content Type (of payload)

• _jwsHeaderCrit :: Maybe (NonEmpty Text)

Instances

Eq JWSHeader

Methods

(==) :: JWSHeader -> JWSHeader -> Bool

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

Show JWSHeader

Methods

showsPrec :: Int -> JWSHeader -> ShowS

show :: JWSHeader -> String

showList :: [JWSHeader] -> ShowS

HasParams JWSHeader

Methods

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

extensions :: Proxy * JWSHeader -> [Text]

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

HasJWSHeader JWSHeader

Methods

jWSHeader :: Lens' JWSHeader JWSHeader

jwsHeaderAlg :: Lens' JWSHeader (HeaderParam Alg)

jwsHeaderCrit :: Lens' JWSHeader (Maybe (NonEmpty Text))

jwsHeaderCty :: Lens' JWSHeader (Maybe (HeaderParam String))

jwsHeaderJku :: Lens' JWSHeader (Maybe (HeaderParam URI))

jwsHeaderJwk :: Lens' JWSHeader (Maybe (HeaderParam JWK))

jwsHeaderKid :: Lens' JWSHeader (Maybe (HeaderParam String))

jwsHeaderTyp :: Lens' JWSHeader (Maybe (HeaderParam String))

jwsHeaderX5c :: Lens' JWSHeader (Maybe (HeaderParam (NonEmpty Base64X509)))

jwsHeaderX5t :: Lens' JWSHeader (Maybe (HeaderParam Base64SHA1))

jwsHeaderX5tS256 :: Lens' JWSHeader (Maybe (HeaderParam Base64SHA256))

jwsHeaderX5u :: Lens' JWSHeader (Maybe (HeaderParam URI))

newJWSHeader :: (Protection, Alg) -> JWSHeader

Construct a minimal header with the given algorithm

data Signature a

Instances

(Eq a, HasParams a) => Eq (Signature a)

Methods

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

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

Show a => Show (Signature a)

Methods

showsPrec :: Int -> Signature a -> ShowS

show :: Signature a -> String

showList :: [Signature a] -> ShowS

HasParams a => ToJSON (Signature a)

Methods

toJSON :: Signature a -> Value

toEncoding :: Signature a -> Encoding

toJSONList :: [Signature a] -> Value

toEncodingList :: [Signature a] -> Encoding

HasParams a => FromJSON (Signature a)

Methods

parseJSON :: Value -> Parser (Signature a)

parseJSONList :: Value -> Parser [Signature a]

header :: forall a a. Lens (Signature a) (Signature a) a a

data JWS a

JSON Web Signature data type. Consists of a payload and a (possibly empty) list of signatures.

Parameterised by the header type.

Constructors

JWS Base64Octets [Signature a]

Instances

(HasParams a, Eq a) => Eq (JWS a)

Methods

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

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

Show a => Show (JWS a)

Methods

showsPrec :: Int -> JWS a -> ShowS

show :: JWS a -> String

showList :: [JWS a] -> ShowS

HasParams a => ToJSON (JWS a)

Methods

toJSON :: JWS a -> Value

toEncoding :: JWS a -> Encoding

toJSONList :: [JWS a] -> Value

toEncodingList :: [JWS a] -> Encoding

HasParams a => FromJSON (JWS a)

Methods

parseJSON :: Value -> Parser (JWS a)

parseJSONList :: Value -> Parser [JWS a]

HasParams a => ToCompact (JWS a)

Methods

toCompact :: (AsError e, MonadError e m) => JWS a -> m [ByteString]

HasParams a => FromCompact (JWS a)

Methods

fromCompact :: (AsError e, MonadError e m) => [ByteString] -> m (JWS a)

newJWS :: ByteString -> JWS a

Construct a new (unsigned) JWS

jwsPayload :: JWS a -> ByteString

Payload of a JWS, as a lazy bytestring.

signJWS

Arguments

:: (HasJWSHeader a, HasParams a, MonadRandom m, AsError e, MonadError e m)

=> JWS a

JWS to sign

-> a

Header for signature

-> JWK

Key with which to sign

-> m (JWS a)

JWS with new signature appended

Create a new signature on a JWS.

class HasValidationSettings c where

Minimal complete definition

validationSettings

Methods

validationSettings :: Lens' c ValidationSettings

validationSettingsAlgorithms :: Lens' c (Set Alg)

validationSettingsValidationPolicy :: Lens' c ValidationPolicy

Instances

HasValidationSettings ValidationSettings

Methods

validationSettings :: Lens' ValidationSettings ValidationSettings

validationSettingsAlgorithms :: Lens' ValidationSettings (Set Alg)

validationSettingsValidationPolicy :: Lens' ValidationSettings ValidationPolicy

HasValidationSettings JWTValidationSettings

Methods

validationSettings :: Lens' JWTValidationSettings ValidationSettings

validationSettingsAlgorithms :: Lens' JWTValidationSettings (Set Alg)

validationSettingsValidationPolicy :: Lens' JWTValidationSettings ValidationPolicy

class HasAlgorithms s where

Minimal complete definition

algorithms

Methods

algorithms :: Lens' s (Set Alg)

Instances

HasValidationSettings a => HasAlgorithms a

Methods

algorithms :: Lens' a (Set Alg)

class HasValidationPolicy s where

Minimal complete definition

validationPolicy

Methods

validationPolicy :: Lens' s ValidationPolicy

Instances

HasValidationSettings a => HasValidationPolicy a

Methods

validationPolicy :: Lens' a ValidationPolicy

data ValidationPolicy

Validation policy.

Constructors

AnyValidated

One successfully validated signature is sufficient

AllValidated

All signatures in all configured algorithms must be validated. No signatures in configured algorithms is also an error.

Instances

Eq ValidationPolicy

Methods

(==) :: ValidationPolicy -> ValidationPolicy -> Bool

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

data ValidationSettings

Instances

HasValidationSettings ValidationSettings

Methods

validationSettings :: Lens' ValidationSettings ValidationSettings

validationSettingsAlgorithms :: Lens' ValidationSettings (Set Alg)

validationSettingsValidationPolicy :: Lens' ValidationSettings ValidationPolicy

defaultValidationSettings :: ValidationSettings

verifyJWS :: (HasAlgorithms a, HasValidationPolicy a, AsError e, MonadError e m, HasJWSHeader h, HasParams h) => a -> JWK -> JWS h -> m ()

Verify a JWS.

Signatures made with an unsupported algorithms are ignored. If the validation policy is AnyValidated, a single successfully validated signature is sufficient. If the validation policy is AllValidated then all remaining signatures (there must be at least one) must be valid.

module Crypto.JOSE.Header