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

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]

data JWSHeader

JWS Header data type.

Constructors

JWSHeader

Fields

• headerAlg :: Maybe Alg
• headerJku :: Maybe URI

  JWK Set URL

• headerJwk :: Maybe JWK
• headerKid :: Maybe String

  interpretation unspecified

• headerX5u :: Maybe URI
• headerX5c :: Maybe (NonEmpty Base64X509)
• headerX5t :: Maybe Base64SHA1
• headerX5tS256 :: Maybe Base64SHA256
• headerTyp :: Maybe String

  Content Type (of object)

• headerCty :: Maybe String

  Content Type (of payload)

• headerCrit :: Maybe CritParameters

Instances

Eq JWSHeader

Methods

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

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

Show JWSHeader

Methods

showsPrec :: Int -> JWSHeader -> ShowS

show :: JWSHeader -> String

showList :: [JWSHeader] -> ShowS

ToJSON JWSHeader

Methods

toJSON :: JWSHeader -> Value

toEncoding :: JWSHeader -> Encoding

toJSONList :: [JWSHeader] -> Value

toEncodingList :: [JWSHeader] -> Encoding

FromJSON JWSHeader

Methods

parseJSON :: Value -> Parser JWSHeader

parseJSONList :: Value -> Parser [JWSHeader]

Default JWSHeader

Methods

def :: JWSHeader

newJWSHeader :: Alg -> JWSHeader

Construct a minimal header with the given algorithm

data JWS

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

Constructors

JWS Base64Octets [Signature]

Instances

Eq JWS

Methods

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

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

Show JWS

Methods

showsPrec :: Int -> JWS -> ShowS

show :: JWS -> String

showList :: [JWS] -> ShowS

ToJSON JWS

Methods

toJSON :: JWS -> Value

toEncoding :: JWS -> Encoding

toJSONList :: [JWS] -> Value

toEncodingList :: [JWS] -> Encoding

FromJSON JWS

Methods

parseJSON :: Value -> Parser JWS

parseJSONList :: Value -> Parser [JWS]

ToCompact JWS

Methods

toCompact :: JWS -> Either Error [ByteString]

FromCompact JWS

Methods

fromCompact :: [ByteString] -> Either Error JWS

newJWS :: ByteString -> JWS

Construct a new (unsigned) JWS

jwsPayload :: JWS -> ByteString

Payload of a JWS, as a lazy bytestring.

signJWS

Arguments

:: MonadRandom m

=> JWS

JWS to sign

-> JWSHeader

Header for signature

-> JWK

Key with which to sign

-> m (Either Error JWS)

JWS with new signature appended

Create a new signature on a JWS.

newtype ValidationAlgorithms

Algorithms for which validation will be attempted. The default value includes all algorithms except None.

Constructors

ValidationAlgorithms [Alg]

Instances

Default ValidationAlgorithms

Methods

def :: ValidationAlgorithms

data ValidationPolicy

Validation policy. The default policy is AllValidated.

Constructors

AnyValidated

One successfully validated signature is sufficient

AllValidated

All signatures for which validation is attempted must be validated

Instances

Default ValidationPolicy

Methods

def :: ValidationPolicy

verifyJWS :: ValidationAlgorithms -> ValidationPolicy -> JWK -> JWS -> Bool

Verify a JWS.

Verification succeeds if any signature on the JWS is successfully validated with the given Key.

If only specific signatures need to be validated, and the ValidationPolicy argument is not enough to express this, the caller is responsible for removing irrelevant signatures prior to calling verifyJWS.