Safe Haskell	None
Language	Haskell98

Crypto.JOSE.JWA.JWK

Contents

Type classes
Parameters for Elliptic Curve Keys
Parameters for RSA Keys
Parameters for Symmetric Keys
Parameters for CFRG EC keys (RFC 8037)
Key generation
Signing and verification

Description

Cryptographic Algorithms for Keys.

Synopsis

Type classes

class AsPublicKey k where Source #

Keys that may have have public material

Minimal complete definition

asPublicKey

Methods

asPublicKey :: Getter k (Maybe k) Source #

Get the public key

Instances

AsPublicKey RSAKeyParameters Source #
Methods asPublicKey :: Getter RSAKeyParameters (Maybe RSAKeyParameters) Source #
AsPublicKey ECKeyParameters Source #
Methods asPublicKey :: Getter ECKeyParameters (Maybe ECKeyParameters) Source #
AsPublicKey KeyMaterial Source #
Methods asPublicKey :: Getter KeyMaterial (Maybe KeyMaterial) Source #
AsPublicKey OKPKeyParameters Source #
Methods asPublicKey :: Getter OKPKeyParameters (Maybe OKPKeyParameters) Source #
AsPublicKey JWK Source #
Methods asPublicKey :: Getter JWK (Maybe JWK) Source #

Parameters for Elliptic Curve Keys

data Crv Source #

"crv" (Curve) Parameter

Constructors

P_256
P_384
P_521

Instances

Eq Crv Source #
Methods (==) :: Crv -> Crv -> Bool # (/=) :: Crv -> Crv -> Bool #
Ord Crv Source #
Methods compare :: Crv -> Crv -> Ordering # (<) :: Crv -> Crv -> Bool # (<=) :: Crv -> Crv -> Bool # (>) :: Crv -> Crv -> Bool # (>=) :: Crv -> Crv -> Bool # max :: Crv -> Crv -> Crv # min :: Crv -> Crv -> Crv #
Show Crv Source #
Methods showsPrec :: Int -> Crv -> ShowS # show :: Crv -> String # showList :: [Crv] -> ShowS #
Arbitrary Crv Source #
Methods arbitrary :: Gen Crv # shrink :: Crv -> [Crv] #
ToJSON Crv Source #
Methods toJSON :: Crv -> Value # toEncoding :: Crv -> Encoding #
FromJSON Crv Source #
Methods parseJSON :: Value -> Parser Crv #

data ECKeyParameters Source #

Parameters for Elliptic Curve Keys

Instances

Eq ECKeyParameters Source #
Methods (==) :: ECKeyParameters -> ECKeyParameters -> Bool # (/=) :: ECKeyParameters -> ECKeyParameters -> Bool #
Show ECKeyParameters Source #
Methods showsPrec :: Int -> ECKeyParameters -> ShowS # show :: ECKeyParameters -> String # showList :: [ECKeyParameters] -> ShowS #
Arbitrary ECKeyParameters Source #
Methods arbitrary :: Gen ECKeyParameters # shrink :: ECKeyParameters -> [ECKeyParameters] #
ToJSON ECKeyParameters Source #
Methods toJSON :: ECKeyParameters -> Value # toEncoding :: ECKeyParameters -> Encoding #
FromJSON ECKeyParameters Source #
Methods parseJSON :: Value -> Parser ECKeyParameters #
AsPublicKey ECKeyParameters Source #
Methods asPublicKey :: Getter ECKeyParameters (Maybe ECKeyParameters) Source #

ecCrv :: Getter ECKeyParameters Crv Source #

ecX :: Getter ECKeyParameters SizedBase64Integer Source #

ecY :: Getter ECKeyParameters SizedBase64Integer Source #

ecD :: Getter ECKeyParameters (Maybe SizedBase64Integer) Source #

curve :: Crv -> Curve Source #

point :: ECKeyParameters -> Point Source #

ecPrivateKey :: (MonadError e m, AsError e) => ECKeyParameters -> m Integer 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 #
Methods (==) :: RSAPrivateKeyOthElem -> RSAPrivateKeyOthElem -> Bool # (/=) :: RSAPrivateKeyOthElem -> RSAPrivateKeyOthElem -> Bool #
Show RSAPrivateKeyOthElem Source #
Methods showsPrec :: Int -> RSAPrivateKeyOthElem -> ShowS # show :: RSAPrivateKeyOthElem -> String # showList :: [RSAPrivateKeyOthElem] -> ShowS #
Arbitrary RSAPrivateKeyOthElem Source #
Methods arbitrary :: Gen RSAPrivateKeyOthElem # shrink :: RSAPrivateKeyOthElem -> [RSAPrivateKeyOthElem] #
ToJSON RSAPrivateKeyOthElem Source #
Methods toJSON :: RSAPrivateKeyOthElem -> Value # toEncoding :: RSAPrivateKeyOthElem -> Encoding #
FromJSON RSAPrivateKeyOthElem Source #
Methods parseJSON :: Value -> Parser RSAPrivateKeyOthElem #

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 #
Methods (==) :: RSAPrivateKeyOptionalParameters -> RSAPrivateKeyOptionalParameters -> Bool # (/=) :: RSAPrivateKeyOptionalParameters -> RSAPrivateKeyOptionalParameters -> Bool #
Show RSAPrivateKeyOptionalParameters Source #
Methods showsPrec :: Int -> RSAPrivateKeyOptionalParameters -> ShowS # show :: RSAPrivateKeyOptionalParameters -> String # showList :: [RSAPrivateKeyOptionalParameters] -> ShowS #
Arbitrary RSAPrivateKeyOptionalParameters Source #
Methods arbitrary :: Gen RSAPrivateKeyOptionalParameters # shrink :: RSAPrivateKeyOptionalParameters -> [RSAPrivateKeyOptionalParameters] #
ToJSON RSAPrivateKeyOptionalParameters Source #
Methods toJSON :: RSAPrivateKeyOptionalParameters -> Value # toEncoding :: RSAPrivateKeyOptionalParameters -> Encoding #
FromJSON RSAPrivateKeyOptionalParameters Source #
Methods parseJSON :: Value -> Parser RSAPrivateKeyOptionalParameters #

data RSAPrivateKeyParameters Source #

RSA private key parameters

Constructors

RSAPrivateKeyParameters
Fields rsaD :: Base64Integer rsaOptionalParameters :: Maybe RSAPrivateKeyOptionalParameters

Instances

Eq RSAPrivateKeyParameters Source #
Methods (==) :: RSAPrivateKeyParameters -> RSAPrivateKeyParameters -> Bool # (/=) :: RSAPrivateKeyParameters -> RSAPrivateKeyParameters -> Bool #
Show RSAPrivateKeyParameters Source #
Methods showsPrec :: Int -> RSAPrivateKeyParameters -> ShowS # show :: RSAPrivateKeyParameters -> String # showList :: [RSAPrivateKeyParameters] -> ShowS #
Arbitrary RSAPrivateKeyParameters Source #
Methods arbitrary :: Gen RSAPrivateKeyParameters # shrink :: RSAPrivateKeyParameters -> [RSAPrivateKeyParameters] #
ToJSON RSAPrivateKeyParameters Source #
Methods toJSON :: RSAPrivateKeyParameters -> Value # toEncoding :: RSAPrivateKeyParameters -> Encoding #
FromJSON RSAPrivateKeyParameters Source #
Methods parseJSON :: Value -> Parser RSAPrivateKeyParameters #

data RSAKeyParameters Source #

Parameters for RSA Keys

Constructors

RSAKeyParameters Base64Integer Base64Integer (Maybe RSAPrivateKeyParameters)

Instances

Eq RSAKeyParameters Source #
Methods (==) :: RSAKeyParameters -> RSAKeyParameters -> Bool # (/=) :: RSAKeyParameters -> RSAKeyParameters -> Bool #
Show RSAKeyParameters Source #
Methods showsPrec :: Int -> RSAKeyParameters -> ShowS # show :: RSAKeyParameters -> String # showList :: [RSAKeyParameters] -> ShowS #
Arbitrary RSAKeyParameters Source #
Methods arbitrary :: Gen RSAKeyParameters # shrink :: RSAKeyParameters -> [RSAKeyParameters] #
ToJSON RSAKeyParameters Source #
Methods toJSON :: RSAKeyParameters -> Value # toEncoding :: RSAKeyParameters -> Encoding #
FromJSON RSAKeyParameters Source #
Methods parseJSON :: Value -> Parser RSAKeyParameters #
AsPublicKey RSAKeyParameters Source #
Methods asPublicKey :: Getter RSAKeyParameters (Maybe RSAKeyParameters) Source #

toRSAKeyParameters :: PrivateKey -> RSAKeyParameters Source #

rsaE :: Lens' RSAKeyParameters Base64Integer Source #

rsaN :: Lens' RSAKeyParameters Base64Integer Source #

rsaPrivateKeyParameters :: Lens' RSAKeyParameters (Maybe RSAPrivateKeyParameters) Source #

rsaPublicKey :: RSAKeyParameters -> PublicKey Source #

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

Parameters for Symmetric Keys

newtype OctKeyParameters Source #

Symmetric key parameters data.

Constructors

OctKeyParameters Base64Octets

Instances

Eq OctKeyParameters Source #
Methods (==) :: OctKeyParameters -> OctKeyParameters -> Bool # (/=) :: OctKeyParameters -> OctKeyParameters -> Bool #
Show OctKeyParameters Source #
Methods showsPrec :: Int -> OctKeyParameters -> ShowS # show :: OctKeyParameters -> String # showList :: [OctKeyParameters] -> ShowS #
Arbitrary OctKeyParameters Source #
Methods arbitrary :: Gen OctKeyParameters # shrink :: OctKeyParameters -> [OctKeyParameters] #
ToJSON OctKeyParameters Source #
Methods toJSON :: OctKeyParameters -> Value # toEncoding :: OctKeyParameters -> Encoding #
FromJSON OctKeyParameters Source #
Methods parseJSON :: Value -> Parser OctKeyParameters #

octK :: Iso' OctKeyParameters Base64Octets Source #

Parameters for CFRG EC keys (RFC 8037)

data OKPKeyParameters Source #

Constructors

Ed25519Key PublicKey (Maybe SecretKey)
X25519Key PublicKey (Maybe SecretKey)

Instances

Eq OKPKeyParameters Source #
Methods (==) :: OKPKeyParameters -> OKPKeyParameters -> Bool # (/=) :: OKPKeyParameters -> OKPKeyParameters -> Bool #
Show OKPKeyParameters Source #
Methods showsPrec :: Int -> OKPKeyParameters -> ShowS # show :: OKPKeyParameters -> String # showList :: [OKPKeyParameters] -> ShowS #
Arbitrary OKPKeyParameters Source #
Methods arbitrary :: Gen OKPKeyParameters # shrink :: OKPKeyParameters -> [OKPKeyParameters] #
ToJSON OKPKeyParameters Source #
Methods toJSON :: OKPKeyParameters -> Value # toEncoding :: OKPKeyParameters -> Encoding #
FromJSON OKPKeyParameters Source #
Methods parseJSON :: Value -> Parser OKPKeyParameters #
AsPublicKey OKPKeyParameters Source #
Methods asPublicKey :: Getter OKPKeyParameters (Maybe OKPKeyParameters) Source #

data OKPCrv Source #

Constructors

Ed25519
X25519

Instances

Eq OKPCrv Source #
Methods (==) :: OKPCrv -> OKPCrv -> Bool # (/=) :: OKPCrv -> OKPCrv -> Bool #
Show OKPCrv Source #
Methods showsPrec :: Int -> OKPCrv -> ShowS # show :: OKPCrv -> String # showList :: [OKPCrv] -> ShowS #
Arbitrary OKPCrv Source #
Methods arbitrary :: Gen OKPCrv # shrink :: OKPCrv -> [OKPCrv] #

Key generation

data KeyMaterialGenParam Source #

Keygen parameters.

Constructors

ECGenParam Crv	Generate an EC key with specified curve.
RSAGenParam Int	Generate an RSA key with specified size in bytes.
OctGenParam Int	Generate a symmetric key with specified size in bytes.
OKPGenParam OKPCrv	Generate an EdDSA or Edwards ECDH key with specified curve.

Instances

Eq KeyMaterialGenParam Source #
Methods (==) :: KeyMaterialGenParam -> KeyMaterialGenParam -> Bool # (/=) :: KeyMaterialGenParam -> KeyMaterialGenParam -> Bool #
Show KeyMaterialGenParam Source #
Methods showsPrec :: Int -> KeyMaterialGenParam -> ShowS # show :: KeyMaterialGenParam -> String # showList :: [KeyMaterialGenParam] -> ShowS #
Arbitrary KeyMaterialGenParam Source #
Methods arbitrary :: Gen KeyMaterialGenParam # shrink :: KeyMaterialGenParam -> [KeyMaterialGenParam] #

data KeyMaterial Source #

Key material sum type.

Constructors

ECKeyMaterial ECKeyParameters
RSAKeyMaterial RSAKeyParameters
OctKeyMaterial OctKeyParameters
OKPKeyMaterial OKPKeyParameters

Instances

Eq KeyMaterial Source #
Methods (==) :: KeyMaterial -> KeyMaterial -> Bool # (/=) :: KeyMaterial -> KeyMaterial -> Bool #
Show KeyMaterial Source #
Methods showsPrec :: Int -> KeyMaterial -> ShowS # show :: KeyMaterial -> String # showList :: [KeyMaterial] -> ShowS #
Arbitrary KeyMaterial Source #
Methods arbitrary :: Gen KeyMaterial # shrink :: KeyMaterial -> [KeyMaterial] #
ToJSON KeyMaterial Source #
Methods toJSON :: KeyMaterial -> Value # toEncoding :: KeyMaterial -> Encoding #
FromJSON KeyMaterial Source #
Methods parseJSON :: Value -> Parser KeyMaterial #
AsPublicKey KeyMaterial Source #
Methods asPublicKey :: Getter KeyMaterial (Maybe KeyMaterial) Source #

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

Signing and verification

sign :: (MonadRandom m, MonadError e m, AsError e) => Alg -> KeyMaterial -> ByteString -> m ByteString Source #

verify :: (MonadError e m, AsError e) => Alg -> KeyMaterial -> ByteString -> ByteString -> m Bool Source #

module Crypto.Random