Safe Haskell	None
Language	Haskell2010

Jose.Jwt

Synopsis

Documentation

data Jwt Source

A decoded JWT which can be either a JWE or a JWS.

Constructors

Jws !Jws
Jwe !Jwe

type Jwe = (JweHeader, ByteString) Source

The header and claims of a decoded JWE.

type Jws = (JwsHeader, ByteString) Source

The header and claims of a decoded JWS.

data JwsHeader Source

Header content for a JWS.

Constructors

JwsHeader
Fields jwsAlg :: JwsAlg jwsTyp :: Maybe Text jwsCty :: Maybe Text jwsKid :: Maybe Text

Instances

Eq JwsHeader
Show JwsHeader
Generic JwsHeader
ToJSON JwsHeader
FromJSON JwsHeader
type Rep JwsHeader

data JweHeader Source

Header content for a JWE.

Constructors

JweHeader
Fields jweAlg :: JweAlg jweEnc :: Enc jweTyp :: Maybe Text jweCty :: Maybe Text jweZip :: Maybe Text jweKid :: Maybe Text

Instances

Eq JweHeader
Show JweHeader
Generic JweHeader
ToJSON JweHeader
FromJSON JweHeader
type Rep JweHeader

data JwtError Source

Decoding errors.

Constructors

KeyError Text	No suitable key or wrong key type
BadDots Int	Wrong number of "." characters in the JWT
BadHeader	Header couldn't be decoded or contains bad data
BadSignature	Signature is invalid
BadCrypto	A cryptographic operation failed
Base64Error String	A base64 decoding error

Instances

Eq JwtError
Show JwtError

decode Source

Arguments

:: JwkSet	The keys to use for decoding
-> ByteString	The encoded JWT
-> Either JwtError Jwt	The decoded JWT, if successful

Uses the supplied keys to decode a JWT. Locates a matching key by header kid value where possible or by suitable key type. The JWK use and alg options are currently ignored.