Safe Haskell	None
Language	Haskell98

Crypto.JOSE.JWK

Contents

Type classes
"kty" (Key Type) Parameter Values
Parameters for Elliptic Curve Keys
Parameters for RSA Keys
Parameters for Symmetric Keys

Description

A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. This module also defines a JSON Web Key Set (JWK Set) JSON data structure for representing a set of JWKs.

Synopsis

Documentation

data JWK Source

JWK §3. JSON Web Key (JWK) Format

Constructors

JWK KeyMaterial (Maybe KeyUse) (Maybe [KeyOp]) (Maybe Alg) (Maybe String) (Maybe URI) (Maybe (NonEmpty Base64X509)) (Maybe Base64SHA1) (Maybe Base64SHA256)

Instances

Eq JWK Source
Show JWK Source
Arbitrary JWK Source
ToJSON JWK Source
FromJSON JWK Source
AsPublicKey JWK Source

jwkMaterial :: Lens' JWK KeyMaterial Source

jwkUse :: Lens' JWK (Maybe KeyUse) Source

jwkKeyOps :: Lens' JWK (Maybe [KeyOp]) Source

jwkAlg :: Lens' JWK (Maybe Alg) Source

jwkKid :: Lens' JWK (Maybe String) Source

jwkX5u :: Lens' JWK (Maybe URI) Source

jwkX5c :: Lens' JWK (Maybe (NonEmpty Base64X509)) Source

jwkX5t :: Lens' JWK (Maybe Base64SHA1) Source

jwkX5tS256 :: Lens' JWK (Maybe Base64SHA256) Source

fromKeyMaterial :: KeyMaterial -> JWK Source

genJWK :: MonadRandom m => KeyMaterialGenParam -> m JWK Source

newtype JWKSet Source

JWK §4. JSON Web Key Set (JWK Set) Format

Constructors

JWKSet [JWK]

Instances

Eq JWKSet Source
Show JWKSet Source
FromJSON JWKSet Source

Type classes

class AsPublicKey k where Source

Methods

asPublicKey :: Prism' k k Source

Instances

AsPublicKey RSAKeyParameters Source
AsPublicKey ECKeyParameters Source
AsPublicKey KeyMaterial Source
AsPublicKey OctKeyParameters Source
AsPublicKey JWK Source
AsPublicKey JWK' Source

"kty" (Key Type) Parameter Values

data EC Source

Elliptic Curve key type (Recommeded+)

Constructors

EC

Instances

Eq EC Source
Show EC Source
ToJSON EC Source
FromJSON EC Source

data RSA Source

RSA key type (Required)

Constructors

RSA

Instances

Eq RSA Source
Show RSA Source
ToJSON RSA Source
FromJSON RSA Source

data Oct Source

Octet sequence (symmetric key) key type (Required)

Constructors

Oct

Instances

Eq Oct Source
Show Oct Source
ToJSON Oct Source
FromJSON Oct Source

Parameters for Elliptic Curve Keys

data Crv Source

"crv" (Curve) Parameter

Constructors

P_256
P_384
P_521

Instances

Eq Crv Source
Show Crv Source
Arbitrary Crv Source
ToJSON Crv Source
FromJSON Crv Source

data ECKeyParameters Source

Parameters for Elliptic Curve Keys

Constructors

ECKeyParameters
Fields ecKty :: EC ecCrv :: Crv ecX :: SizedBase64Integer ecY :: SizedBase64Integer ecD :: Maybe SizedBase64Integer

Instances

Eq ECKeyParameters Source
Show ECKeyParameters Source
Arbitrary ECKeyParameters Source
ToJSON ECKeyParameters Source
FromJSON ECKeyParameters Source
AsPublicKey ECKeyParameters Source

Parameters for RSA Keys

data RSAPrivateKeyOthElem Source

"oth" (Other Primes Info) Parameter

Constructors

RSAPrivateKeyOthElem
Fields rOth :: Base64Integer dOth :: Base64Integer tOth :: Base64Integer

Instances

Eq RSAPrivateKeyOthElem Source
Show RSAPrivateKeyOthElem Source
Arbitrary RSAPrivateKeyOthElem Source
ToJSON RSAPrivateKeyOthElem Source
FromJSON RSAPrivateKeyOthElem Source

data RSAPrivateKeyOptionalParameters Source

Optional parameters for RSA private keys

Constructors

RSAPrivateKeyOptionalParameters
Fields rsaP :: Base64Integer rsaQ :: Base64Integer rsaDp :: Base64Integer rsaDq :: Base64Integer rsaQi :: Base64Integer rsaOth :: Maybe (NonEmpty RSAPrivateKeyOthElem)

Instances

Eq RSAPrivateKeyOptionalParameters Source
Show RSAPrivateKeyOptionalParameters Source
Arbitrary RSAPrivateKeyOptionalParameters Source
ToJSON RSAPrivateKeyOptionalParameters Source
FromJSON RSAPrivateKeyOptionalParameters Source

data RSAPrivateKeyParameters Source

RSA private key parameters

Constructors

RSAPrivateKeyParameters
Fields rsaD :: Base64Integer rsaOptionalParameters :: Maybe RSAPrivateKeyOptionalParameters

Instances

Eq RSAPrivateKeyParameters Source
Show RSAPrivateKeyParameters Source
Arbitrary RSAPrivateKeyParameters Source
ToJSON RSAPrivateKeyParameters Source
FromJSON RSAPrivateKeyParameters Source

data RSAKeyParameters Source

Parameters for RSA Keys

Constructors

RSAKeyParameters RSA SizedBase64Integer Base64Integer (Maybe RSAPrivateKeyParameters)

Instances

Eq RSAKeyParameters Source
Show RSAKeyParameters Source
Arbitrary RSAKeyParameters Source
ToJSON RSAKeyParameters Source
FromJSON RSAKeyParameters Source
AsPublicKey RSAKeyParameters Source

rsaE :: Lens' RSAKeyParameters Base64Integer Source

rsaKty :: Lens' RSAKeyParameters RSA Source

rsaN :: Lens' RSAKeyParameters SizedBase64Integer Source

rsaPrivateKeyParameters :: Lens' RSAKeyParameters (Maybe RSAPrivateKeyParameters) Source

rsaPublicKey :: RSAKeyParameters -> PublicKey Source

genRSA :: MonadRandom m => Int -> m RSAKeyParameters Source

Parameters for Symmetric Keys

data OctKeyParameters Source

Symmetric key parameters data.

Constructors

OctKeyParameters
Fields octKty :: Oct octK :: Base64Octets

Instances

Eq OctKeyParameters Source
Show OctKeyParameters Source
Arbitrary OctKeyParameters Source
ToJSON OctKeyParameters Source
FromJSON OctKeyParameters Source
AsPublicKey OctKeyParameters Source

data KeyMaterialGenParam Source

Keygen parameters.

Constructors

ECGenParam Crv
RSAGenParam Int
OctGenParam Int

data KeyMaterial Source

Key material sum type.

Constructors

ECKeyMaterial ECKeyParameters
RSAKeyMaterial RSAKeyParameters
OctKeyMaterial OctKeyParameters

Instances

Eq KeyMaterial Source
Show KeyMaterial Source
Arbitrary KeyMaterial Source
ToJSON KeyMaterial Source
FromJSON KeyMaterial Source
AsPublicKey KeyMaterial Source

genKeyMaterial :: MonadRandom m => KeyMaterialGenParam -> m KeyMaterial Source

sign :: MonadRandom m => Alg -> KeyMaterial -> ByteString -> m (Either Error ByteString) Source

verify :: Alg -> KeyMaterial -> ByteString -> ByteString -> Either Error Bool Source

module Crypto.Random