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

class AsPublicKey k where
- asPublicKey :: Getter k (Maybe k)
data Crv
- = P_256
- | P_384
- | P_521
data ECKeyParameters
ecCrv :: Getter ECKeyParameters Crv
ecX :: Getter ECKeyParameters SizedBase64Integer
ecY :: Getter ECKeyParameters SizedBase64Integer
ecD :: Getter ECKeyParameters (Maybe SizedBase64Integer)
curve :: Crv -> Curve
point :: ECKeyParameters -> Point
ecPrivateKey :: (MonadError e m, AsError e) => ECKeyParameters -> m Integer
data RSAPrivateKeyOthElem = RSAPrivateKeyOthElem {
- rOth :: Base64Integer
- dOth :: Base64Integer
- tOth :: Base64Integer
}
data RSAPrivateKeyOptionalParameters = RSAPrivateKeyOptionalParameters {
- rsaP :: Base64Integer
- rsaQ :: Base64Integer
- rsaDp :: Base64Integer
- rsaDq :: Base64Integer
- rsaQi :: Base64Integer
- rsaOth :: Maybe (NonEmpty RSAPrivateKeyOthElem)
}
data RSAPrivateKeyParameters = RSAPrivateKeyParameters {
- rsaD :: Base64Integer
- rsaOptionalParameters :: Maybe RSAPrivateKeyOptionalParameters
}
data RSAKeyParameters = RSAKeyParameters Base64Integer Base64Integer (Maybe RSAPrivateKeyParameters)
toRSAKeyParameters :: PrivateKey -> RSAKeyParameters
toRSAPublicKeyParameters :: PublicKey -> RSAKeyParameters
rsaE :: Lens' RSAKeyParameters Base64Integer
rsaN :: Lens' RSAKeyParameters Base64Integer
rsaPrivateKeyParameters :: Lens' RSAKeyParameters (Maybe RSAPrivateKeyParameters)
rsaPublicKey :: RSAKeyParameters -> PublicKey
genRSA :: MonadRandom m => Int -> m RSAKeyParameters
newtype OctKeyParameters = OctKeyParameters Base64Octets
octK :: Iso' OctKeyParameters Base64Octets
data OKPKeyParameters
- = Ed25519Key PublicKey (Maybe SecretKey)
- | X25519Key PublicKey (Maybe SecretKey)
data OKPCrv
- = Ed25519
- | X25519
data KeyMaterialGenParam
- = ECGenParam Crv
- | RSAGenParam Int
- | OctGenParam Int
- | OKPGenParam OKPCrv
data KeyMaterial
- = ECKeyMaterial ECKeyParameters
- | RSAKeyMaterial RSAKeyParameters
- | OctKeyMaterial OctKeyParameters
- | OKPKeyMaterial OKPKeyParameters
genKeyMaterial :: MonadRandom m => KeyMaterialGenParam -> m KeyMaterial
sign :: (MonadRandom m, MonadError e m, AsError e) => Alg -> KeyMaterial -> ByteString -> m ByteString
verify :: (MonadError e m, AsError e) => Alg -> KeyMaterial -> ByteString -> ByteString -> m Bool
module Crypto.Random

Type classes

class AsPublicKey k where Source #

Keys that may have have public material

Methods

asPublicKey :: Getter k (Maybe k) Source #

Get the public key

Instances

AsPublicKey RSAKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods asPublicKey :: Getter RSAKeyParameters (Maybe RSAKeyParameters) Source #
AsPublicKey ECKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods asPublicKey :: Getter ECKeyParameters (Maybe ECKeyParameters) Source #
AsPublicKey KeyMaterial Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods asPublicKey :: Getter KeyMaterial (Maybe KeyMaterial) Source #
AsPublicKey OKPKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods asPublicKey :: Getter OKPKeyParameters (Maybe OKPKeyParameters) Source #
AsPublicKey JWK Source #
Instance details Defined in Crypto.JOSE.JWK 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 #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods (==) :: Crv -> Crv -> Bool # (/=) :: Crv -> Crv -> Bool #
Ord Crv Source #
Instance details Defined in Crypto.JOSE.JWA.JWK 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 #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods showsPrec :: Int -> Crv -> ShowS # show :: Crv -> String # showList :: [Crv] -> ShowS #
Arbitrary Crv Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods arbitrary :: Gen Crv # shrink :: Crv -> [Crv] #
ToJSON Crv Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods toJSON :: Crv -> Value # toEncoding :: Crv -> Encoding # toJSONList :: [Crv] -> Value # toEncodingList :: [Crv] -> Encoding #
FromJSON Crv Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods parseJSON :: Value -> Parser Crv # parseJSONList :: Value -> Parser [Crv] #

data ECKeyParameters Source #

Parameters for Elliptic Curve Keys

Instances

Eq ECKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods (==) :: ECKeyParameters -> ECKeyParameters -> Bool # (/=) :: ECKeyParameters -> ECKeyParameters -> Bool #
Show ECKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods showsPrec :: Int -> ECKeyParameters -> ShowS # show :: ECKeyParameters -> String # showList :: [ECKeyParameters] -> ShowS #
Arbitrary ECKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods arbitrary :: Gen ECKeyParameters # shrink :: ECKeyParameters -> [ECKeyParameters] #
ToJSON ECKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods toJSON :: ECKeyParameters -> Value # toEncoding :: ECKeyParameters -> Encoding # toJSONList :: [ECKeyParameters] -> Value # toEncodingList :: [ECKeyParameters] -> Encoding #
FromJSON ECKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods parseJSON :: Value -> Parser ECKeyParameters # parseJSONList :: Value -> Parser [ECKeyParameters] #
AsPublicKey ECKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK 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 #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods (==) :: RSAPrivateKeyOthElem -> RSAPrivateKeyOthElem -> Bool # (/=) :: RSAPrivateKeyOthElem -> RSAPrivateKeyOthElem -> Bool #
Show RSAPrivateKeyOthElem Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods showsPrec :: Int -> RSAPrivateKeyOthElem -> ShowS # show :: RSAPrivateKeyOthElem -> String # showList :: [RSAPrivateKeyOthElem] -> ShowS #
Arbitrary RSAPrivateKeyOthElem Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods arbitrary :: Gen RSAPrivateKeyOthElem # shrink :: RSAPrivateKeyOthElem -> [RSAPrivateKeyOthElem] #
ToJSON RSAPrivateKeyOthElem Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods toJSON :: RSAPrivateKeyOthElem -> Value # toEncoding :: RSAPrivateKeyOthElem -> Encoding # toJSONList :: [RSAPrivateKeyOthElem] -> Value # toEncodingList :: [RSAPrivateKeyOthElem] -> Encoding #
FromJSON RSAPrivateKeyOthElem Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods parseJSON :: Value -> Parser RSAPrivateKeyOthElem # parseJSONList :: 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 #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods (==) :: RSAPrivateKeyOptionalParameters -> RSAPrivateKeyOptionalParameters -> Bool # (/=) :: RSAPrivateKeyOptionalParameters -> RSAPrivateKeyOptionalParameters -> Bool #
Show RSAPrivateKeyOptionalParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods showsPrec :: Int -> RSAPrivateKeyOptionalParameters -> ShowS # show :: RSAPrivateKeyOptionalParameters -> String # showList :: [RSAPrivateKeyOptionalParameters] -> ShowS #
Arbitrary RSAPrivateKeyOptionalParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods arbitrary :: Gen RSAPrivateKeyOptionalParameters # shrink :: RSAPrivateKeyOptionalParameters -> [RSAPrivateKeyOptionalParameters] #
ToJSON RSAPrivateKeyOptionalParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods toJSON :: RSAPrivateKeyOptionalParameters -> Value # toEncoding :: RSAPrivateKeyOptionalParameters -> Encoding # toJSONList :: [RSAPrivateKeyOptionalParameters] -> Value # toEncodingList :: [RSAPrivateKeyOptionalParameters] -> Encoding #
FromJSON RSAPrivateKeyOptionalParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods parseJSON :: Value -> Parser RSAPrivateKeyOptionalParameters # parseJSONList :: Value -> Parser [RSAPrivateKeyOptionalParameters] #

data RSAPrivateKeyParameters Source #

RSA private key parameters

Constructors

RSAPrivateKeyParameters
Fields rsaD :: Base64Integer rsaOptionalParameters :: Maybe RSAPrivateKeyOptionalParameters

Instances

Eq RSAPrivateKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods (==) :: RSAPrivateKeyParameters -> RSAPrivateKeyParameters -> Bool # (/=) :: RSAPrivateKeyParameters -> RSAPrivateKeyParameters -> Bool #
Show RSAPrivateKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods showsPrec :: Int -> RSAPrivateKeyParameters -> ShowS # show :: RSAPrivateKeyParameters -> String # showList :: [RSAPrivateKeyParameters] -> ShowS #
Arbitrary RSAPrivateKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods arbitrary :: Gen RSAPrivateKeyParameters # shrink :: RSAPrivateKeyParameters -> [RSAPrivateKeyParameters] #
ToJSON RSAPrivateKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods toJSON :: RSAPrivateKeyParameters -> Value # toEncoding :: RSAPrivateKeyParameters -> Encoding # toJSONList :: [RSAPrivateKeyParameters] -> Value # toEncodingList :: [RSAPrivateKeyParameters] -> Encoding #
FromJSON RSAPrivateKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods parseJSON :: Value -> Parser RSAPrivateKeyParameters # parseJSONList :: Value -> Parser [RSAPrivateKeyParameters] #

data RSAKeyParameters Source #

Parameters for RSA Keys

Constructors

RSAKeyParameters Base64Integer Base64Integer (Maybe RSAPrivateKeyParameters)

Instances

Eq RSAKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods (==) :: RSAKeyParameters -> RSAKeyParameters -> Bool # (/=) :: RSAKeyParameters -> RSAKeyParameters -> Bool #
Show RSAKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods showsPrec :: Int -> RSAKeyParameters -> ShowS # show :: RSAKeyParameters -> String # showList :: [RSAKeyParameters] -> ShowS #
Arbitrary RSAKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods arbitrary :: Gen RSAKeyParameters # shrink :: RSAKeyParameters -> [RSAKeyParameters] #
ToJSON RSAKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods toJSON :: RSAKeyParameters -> Value # toEncoding :: RSAKeyParameters -> Encoding # toJSONList :: [RSAKeyParameters] -> Value # toEncodingList :: [RSAKeyParameters] -> Encoding #
FromJSON RSAKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods parseJSON :: Value -> Parser RSAKeyParameters # parseJSONList :: Value -> Parser [RSAKeyParameters] #
AsPublicKey RSAKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods asPublicKey :: Getter RSAKeyParameters (Maybe RSAKeyParameters) Source #

toRSAKeyParameters :: PrivateKey -> RSAKeyParameters Source #

toRSAPublicKeyParameters :: PublicKey -> 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 #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods (==) :: OctKeyParameters -> OctKeyParameters -> Bool # (/=) :: OctKeyParameters -> OctKeyParameters -> Bool #
Show OctKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods showsPrec :: Int -> OctKeyParameters -> ShowS # show :: OctKeyParameters -> String # showList :: [OctKeyParameters] -> ShowS #
Arbitrary OctKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods arbitrary :: Gen OctKeyParameters # shrink :: OctKeyParameters -> [OctKeyParameters] #
ToJSON OctKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods toJSON :: OctKeyParameters -> Value # toEncoding :: OctKeyParameters -> Encoding # toJSONList :: [OctKeyParameters] -> Value # toEncodingList :: [OctKeyParameters] -> Encoding #
FromJSON OctKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods parseJSON :: Value -> Parser OctKeyParameters # parseJSONList :: 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 #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods (==) :: OKPKeyParameters -> OKPKeyParameters -> Bool # (/=) :: OKPKeyParameters -> OKPKeyParameters -> Bool #
Show OKPKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods showsPrec :: Int -> OKPKeyParameters -> ShowS # show :: OKPKeyParameters -> String # showList :: [OKPKeyParameters] -> ShowS #
Arbitrary OKPKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods arbitrary :: Gen OKPKeyParameters # shrink :: OKPKeyParameters -> [OKPKeyParameters] #
ToJSON OKPKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods toJSON :: OKPKeyParameters -> Value # toEncoding :: OKPKeyParameters -> Encoding # toJSONList :: [OKPKeyParameters] -> Value # toEncodingList :: [OKPKeyParameters] -> Encoding #
FromJSON OKPKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods parseJSON :: Value -> Parser OKPKeyParameters # parseJSONList :: Value -> Parser [OKPKeyParameters] #
AsPublicKey OKPKeyParameters Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods asPublicKey :: Getter OKPKeyParameters (Maybe OKPKeyParameters) Source #

data OKPCrv Source #

Constructors

Ed25519
X25519

Instances

Eq OKPCrv Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods (==) :: OKPCrv -> OKPCrv -> Bool # (/=) :: OKPCrv -> OKPCrv -> Bool #
Show OKPCrv Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods showsPrec :: Int -> OKPCrv -> ShowS # show :: OKPCrv -> String # showList :: [OKPCrv] -> ShowS #
Arbitrary OKPCrv Source #
Instance details Defined in Crypto.JOSE.JWA.JWK 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 #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods (==) :: KeyMaterialGenParam -> KeyMaterialGenParam -> Bool # (/=) :: KeyMaterialGenParam -> KeyMaterialGenParam -> Bool #
Show KeyMaterialGenParam Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods showsPrec :: Int -> KeyMaterialGenParam -> ShowS # show :: KeyMaterialGenParam -> String # showList :: [KeyMaterialGenParam] -> ShowS #
Arbitrary KeyMaterialGenParam Source #
Instance details Defined in Crypto.JOSE.JWA.JWK 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 #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods (==) :: KeyMaterial -> KeyMaterial -> Bool # (/=) :: KeyMaterial -> KeyMaterial -> Bool #
Show KeyMaterial Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods showsPrec :: Int -> KeyMaterial -> ShowS # show :: KeyMaterial -> String # showList :: [KeyMaterial] -> ShowS #
Arbitrary KeyMaterial Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods arbitrary :: Gen KeyMaterial # shrink :: KeyMaterial -> [KeyMaterial] #
ToJSON KeyMaterial Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods toJSON :: KeyMaterial -> Value # toEncoding :: KeyMaterial -> Encoding # toJSONList :: [KeyMaterial] -> Value # toEncodingList :: [KeyMaterial] -> Encoding #
FromJSON KeyMaterial Source #
Instance details Defined in Crypto.JOSE.JWA.JWK Methods parseJSON :: Value -> Parser KeyMaterial # parseJSONList :: Value -> Parser [KeyMaterial] #
AsPublicKey KeyMaterial Source #
Instance details Defined in Crypto.JOSE.JWA.JWK 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