Z.Crypto.PubKey

This module is used for Public key cryptography. Public key cryptography (also called asymmetric cryptography) is a collection of techniques allowing for encryption, signatures, and key agreement.

Asymmetric cryptography algorithms

data KeyType

Public key cryptography algorithms.

Constructors

RSA Word32

RSA key of the given size, namely n bits, support encryption and signature.

SM2 ECGroup

Public key algorithms specified by China, support encryption and signature.

ElGamal DLGroup

ElGamal encryption system, support encryption.

DSA DLGroup

Digital Signature Algorithm based on the discrete logarithm problem.

ECDSA ECGroup

Digital Signature Algorithm which uses elliptic curve cryptography.

ECKCDSA ECGroup

Korean Certificate-based Digital Signature Algorithm.

ECGDSA ECGroup

Elliptic Curve German Digital Signature Algorithm.

GOST_34'10 ECGroup

Cryptographic algorithms defined by the Russian national standards, support signature.

Ed25519

Ed25519 elliptic-curve signatures, see ed25519.

XMSS XMSSType

eXtended Merkle Signature Scheme, see https://botan.randombit.net/handbook/api_ref/pubkey.html#extended-merkle-signature-scheme-xmss.

DH DLGroup

The Diffie–Hellman key exchange.

ECDH ECGroup

The Elliptic-curve Diffie–Hellman key exchange.

Curve25519

The Curve25519 Diffie–Hellman key exchange.

Key generation and manipulation

data PrivKey

An opaque data type for a private-public key pair.

Instances

Show PrivKey

Defined in Z.Crypto.PubKey

Methods

showsPrec :: Int -> PrivKey -> ShowS

show :: PrivKey -> String

showList :: [PrivKey] -> ShowS

Generic PrivKey

Defined in Z.Crypto.PubKey

Associated Types

type Rep PrivKey :: Type -> Type

Methods

from :: PrivKey -> Rep PrivKey x

to :: Rep PrivKey x -> PrivKey

Print PrivKey

Defined in Z.Crypto.PubKey

Methods

toUTF8BuilderP :: Int -> PrivKey -> Builder ()

type Rep PrivKey

Defined in Z.Crypto.PubKey

type Rep PrivKey = D1 ('MetaData "PrivKey" "Z.Crypto.PubKey" "Z-Botan-0.4.0.0-Cymuol1BxyD6d85e6LsrR5" 'True) (C1 ('MetaCons "PrivKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BotanStruct)))

data PubKey

A newtype wrapper.

Instances

Eq PubKey

Defined in Z.Crypto.PubKey

Methods

(==) :: PubKey -> PubKey -> Bool

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

Ord PubKey

Defined in Z.Crypto.PubKey

Methods

compare :: PubKey -> PubKey -> Ordering

(<) :: PubKey -> PubKey -> Bool

(<=) :: PubKey -> PubKey -> Bool

(>) :: PubKey -> PubKey -> Bool

(>=) :: PubKey -> PubKey -> Bool

max :: PubKey -> PubKey -> PubKey

min :: PubKey -> PubKey -> PubKey

Show PubKey

Defined in Z.Crypto.PubKey

Methods

showsPrec :: Int -> PubKey -> ShowS

show :: PubKey -> String

showList :: [PubKey] -> ShowS

Generic PubKey

Defined in Z.Crypto.PubKey

Associated Types

type Rep PubKey :: Type -> Type

Methods

from :: PubKey -> Rep PubKey x

to :: Rep PubKey x -> PubKey

Print PubKey

Defined in Z.Crypto.PubKey

Methods

toUTF8BuilderP :: Int -> PubKey -> Builder ()

type Rep PubKey

Defined in Z.Crypto.PubKey

type Rep PubKey = D1 ('MetaData "PubKey" "Z.Crypto.PubKey" "Z-Botan-0.4.0.0-Cymuol1BxyD6d85e6LsrR5" 'True) (C1 ('MetaCons "PubKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BotanStruct)))

newPrivKey

Arguments

:: HasCallStack

=> KeyType

Algorithm name and some algorithm specific arguments.

-> RNG

-> IO PrivKey

Creating a private key.

Creating a private key requires two things:

• a source of random numbers
• some algorithm specific arguments that define the security level of the resulting key.

newKeyPair

Arguments

:: HasCallStack

=> KeyType

Algorithm name and some algorithm specific arguments.

-> RNG

-> IO (PrivKey, PubKey)

Creating a new key pair.

privKeyToPubKey :: PrivKey -> PubKey

Export a public key from a given key pair.

loadPrivKey

Arguments

:: HasCallStack

=> RNG

-> Bytes

-> CBytes

Password.

-> IO PrivKey

Load a private key. If the key is encrypted, password will be used to attempt decryption.

privKeyAlgoName :: PrivKey -> IO Text

Get the algorithm name of a private key.

privKeyParam

Arguments

:: HasCallStack

=> PrivKey

key

-> CBytes

field name

-> MPI

Read an algorithm specific field from the key pair object.

exportPrivKeyDER :: HasCallStack => PrivKey -> Bytes

Export a private key in DER binary format.

exportPrivKeyPEM :: HasCallStack => PrivKey -> Text

Export a private key in PEM textual format.

exportPrivKeyEncryptedDER

Arguments

:: HasCallStack

=> PrivKey

-> RNG

-> CBytes

password

-> IO Bytes

Export a private key with password.

exportPrivKeyEncryptedPEM

Arguments

:: HasCallStack

=> PrivKey

-> RNG

-> CBytes

password

-> IO Text

Export a private key with password in PEM textual format.

loadPubKey :: HasCallStack => Bytes -> IO PubKey

Load a publickey.

pubKeyAlgoName :: PubKey -> CBytes

Get the algorithm name of a public key.

pubKeyParam

Arguments

:: PubKey

key

-> CBytes

field name

-> MPI

Read an algorithm specific field from the public key object.

exportPubKeyDER :: HasCallStack => PubKey -> Bytes

Export a public key in DER binary format..

exportPubKeyPEM :: HasCallStack => PubKey -> Text

Export a public key in PEM textual format.

estStrength :: PubKey -> Int

Estimate the strength of a public key.

fingerPrintPubKey :: PubKey -> HashType -> Bytes

Fingerprint a given publickey.

Encrypt & Decrypt

pkEncrypt

Arguments

:: HasCallStack

=> PubKey

-> EncParam

-> RNG

-> Bytes

plaintext

-> IO Bytes

ciphertext

Encrypt a message, returning the ciphertext.

Though botan support DLIES and ECIES but only EME are exported via FFI, please use an algorithm that directly support eme encryption such as RSA and ElGamal.

pkDecrypt

Arguments

:: HasCallStack

=> PrivKey

-> EncParam

-> Bytes

ciphertext

-> IO Bytes

plaintext

Decrypt a message, returning the plaintext.

Though botan support DLIES and ECIES but only EME are exported via FFI, please use an algorithm that directly support decryption such as RSA and ElGamal.

data EncParam

Sets of allowed params for public key types.

The recommended values for eme is EME1_SHA1 or EME1_SHA256. If you need compatibility with protocols using the PKCS #1 v1.5 standard, you can also use EME_PKCS1_v15'.

To use SM2 encryption, use SM2EncParam.

Constructors

EME_RAW

EME_PKCS1_v1'5

EME_OAEP HashType CBytes

hash, label

EME_OAEP' HashType HashType CBytes

hash, mask gen hash, labal

SM2EncParam HashType

Sign & verify

data SignParam

Signature params.

Currently available values for EMSA include EMSA1, EMSA2, EMSA3, EMSA4, and Raw. All of them, except Raw, take a parameter naming a message digest function to hash the message with. The Raw encoding signs the input directly; if the message is too big, the signing operation will fail. Raw is not useful except in very specialized applications. For RSA, use EMSA4 (also called PSS) unless you need compatibility with software that uses the older PKCS #1 v1.5 standard, in which case use EMSA3 (also called “EMSA-PKCS1-v1_5”). For DSA, ECDSA, ECKCDSA, ECGDSA and GOST 34.10-2001 you should use EMSA1.

Constructors

EMSA1 HashType

EMSA2 HashType

EMSA3_RAW (Maybe HashType)

EMSA3 HashType

EMSA4_Raw HashType (Maybe Int)

hash, salt size

EMSA4 HashType (Maybe Int)

hash, salt size

ISO_9796_DS2 HashType Bool (Maybe Int)

hash, implicit, salt size

ISO_9796_DS3 HashType Bool

hash, implicit

EMSA_Raw

Ed25519Pure

pure Ed25519

Ed25519ph

rfc8032 HashEdDSA variant

Ed25519Hash HashType

HashEdDSA

SM2SignParam CBytes HashType

userid, hash(GM/T 0009-2012 specifies "1234567812345678" as the default userid)

XMSSEmptyParam

XMSS do not need param

Instances

Eq SignParam

Defined in Z.Crypto.PubKey

Methods

(==) :: SignParam -> SignParam -> Bool

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

Ord SignParam

Defined in Z.Crypto.PubKey

Methods

compare :: SignParam -> SignParam -> Ordering

(<) :: SignParam -> SignParam -> Bool

(<=) :: SignParam -> SignParam -> Bool

(>) :: SignParam -> SignParam -> Bool

(>=) :: SignParam -> SignParam -> Bool

max :: SignParam -> SignParam -> SignParam

min :: SignParam -> SignParam -> SignParam

Read SignParam

Defined in Z.Crypto.PubKey

Methods

readsPrec :: Int -> ReadS SignParam

readList :: ReadS [SignParam]

readPrec :: ReadPrec SignParam

readListPrec :: ReadPrec [SignParam]

Show SignParam

Defined in Z.Crypto.PubKey

Methods

showsPrec :: Int -> SignParam -> ShowS

show :: SignParam -> String

showList :: [SignParam] -> ShowS

Generic SignParam

Defined in Z.Crypto.PubKey

Associated Types

type Rep SignParam :: Type -> Type

Methods

from :: SignParam -> Rep SignParam x

to :: Rep SignParam x -> SignParam

JSON SignParam

Defined in Z.Crypto.PubKey

Methods

fromValue :: Value -> Converter SignParam

toValue :: SignParam -> Value

encodeJSON :: SignParam -> Builder ()

Print SignParam

Defined in Z.Crypto.PubKey

Methods

toUTF8BuilderP :: Int -> SignParam -> Builder ()

type Rep SignParam

Defined in Z.Crypto.PubKey

type Rep SignParam = D1 ('MetaData "SignParam" "Z.Crypto.PubKey" "Z-Botan-0.4.0.0-Cymuol1BxyD6d85e6LsrR5" 'False) (((C1 ('MetaCons "EMSA1" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType)) :+: (C1 ('MetaCons "EMSA2" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType)) :+: C1 ('MetaCons "EMSA3_RAW" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe HashType))))) :+: ((C1 ('MetaCons "EMSA3" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType)) :+: C1 ('MetaCons "EMSA4_Raw" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :+: (C1 ('MetaCons "EMSA4" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :+: C1 ('MetaCons "ISO_9796_DS2" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))))))) :+: ((C1 ('MetaCons "ISO_9796_DS3" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :+: (C1 ('MetaCons "EMSA_Raw" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ed25519Pure" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Ed25519ph" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ed25519Hash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType))) :+: (C1 ('MetaCons "SM2SignParam" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType)) :+: C1 ('MetaCons "XMSSEmptyParam" 'PrefixI 'False) (U1 :: Type -> Type)))))

data SignFmt

Constructors

DER_SEQUENCE

IEEE_1363

Instances

Enum SignFmt

Defined in Z.Crypto.PubKey

Methods

succ :: SignFmt -> SignFmt

pred :: SignFmt -> SignFmt

toEnum :: Int -> SignFmt

fromEnum :: SignFmt -> Int

enumFrom :: SignFmt -> [SignFmt]

enumFromThen :: SignFmt -> SignFmt -> [SignFmt]

enumFromTo :: SignFmt -> SignFmt -> [SignFmt]

enumFromThenTo :: SignFmt -> SignFmt -> SignFmt -> [SignFmt]

Eq SignFmt

Defined in Z.Crypto.PubKey

Methods

(==) :: SignFmt -> SignFmt -> Bool

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

Ord SignFmt

Defined in Z.Crypto.PubKey

Methods

compare :: SignFmt -> SignFmt -> Ordering

(<) :: SignFmt -> SignFmt -> Bool

(<=) :: SignFmt -> SignFmt -> Bool

(>) :: SignFmt -> SignFmt -> Bool

(>=) :: SignFmt -> SignFmt -> Bool

max :: SignFmt -> SignFmt -> SignFmt

min :: SignFmt -> SignFmt -> SignFmt

Show SignFmt

Defined in Z.Crypto.PubKey

Methods

showsPrec :: Int -> SignFmt -> ShowS

show :: SignFmt -> String

showList :: [SignFmt] -> ShowS

Generic SignFmt

Defined in Z.Crypto.PubKey

Associated Types

type Rep SignFmt :: Type -> Type

Methods

from :: SignFmt -> Rep SignFmt x

to :: Rep SignFmt x -> SignFmt

Print SignFmt

Defined in Z.Crypto.PubKey

Methods

toUTF8BuilderP :: Int -> SignFmt -> Builder ()

type Rep SignFmt

Defined in Z.Crypto.PubKey

type Rep SignFmt = D1 ('MetaData "SignFmt" "Z.Crypto.PubKey" "Z-Botan-0.4.0.0-Cymuol1BxyD6d85e6LsrR5" 'False) (C1 ('MetaCons "DER_SEQUENCE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IEEE_1363" 'PrefixI 'False) (U1 :: Type -> Type))

data Signer

Instances

Show Signer

Defined in Z.Crypto.PubKey

Methods

showsPrec :: Int -> Signer -> ShowS

show :: Signer -> String

showList :: [Signer] -> ShowS

Generic Signer

Defined in Z.Crypto.PubKey

Associated Types

type Rep Signer :: Type -> Type

Methods

from :: Signer -> Rep Signer x

to :: Rep Signer x -> Signer

Print Signer

Defined in Z.Crypto.PubKey

Methods

toUTF8BuilderP :: Int -> Signer -> Builder ()

type Rep Signer

Defined in Z.Crypto.PubKey

type Rep Signer = D1 ('MetaData "Signer" "Z.Crypto.PubKey" "Z-Botan-0.4.0.0-Cymuol1BxyD6d85e6LsrR5" 'False) (C1 ('MetaCons "Signer" 'PrefixI 'True) (S1 ('MetaSel ('Just "signerStruct") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 BotanStruct) :*: S1 ('MetaSel ('Just "signerSize") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int)))

signerSize :: Signer -> Int

output signature length

data Verifier

Instances

Show Verifier

Defined in Z.Crypto.PubKey

Methods

showsPrec :: Int -> Verifier -> ShowS

show :: Verifier -> String

showList :: [Verifier] -> ShowS

Generic Verifier

Defined in Z.Crypto.PubKey

Associated Types

type Rep Verifier :: Type -> Type

Methods

from :: Verifier -> Rep Verifier x

to :: Rep Verifier x -> Verifier

Print Verifier

Defined in Z.Crypto.PubKey

Methods

toUTF8BuilderP :: Int -> Verifier -> Builder ()

type Rep Verifier

Defined in Z.Crypto.PubKey

type Rep Verifier = D1 ('MetaData "Verifier" "Z.Crypto.PubKey" "Z-Botan-0.4.0.0-Cymuol1BxyD6d85e6LsrR5" 'True) (C1 ('MetaCons "Verifier" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BotanStruct)))

newSigner :: HasCallStack => PrivKey -> SignParam -> SignFmt -> IO Signer

updateSigner :: HasCallStack => Signer -> Bytes -> IO ()

finalSigner :: HasCallStack => Signer -> RNG -> IO Bytes

Produce a signature over all of the bytes passed to Signer. Afterwards, the sign operator is reset and may be used to sign a new message.

sinkToSigner :: HasCallStack => HasCallStack => Signer -> Sink Bytes

Trun Signer to a Bytes sink, update Signer by write bytes to the sink.

sign

Arguments

:: HasCallStack

=> PrivKey

-> SignParam

-> SignFmt

-> Bytes

input

-> IO Bytes

signature

Directly sign a message, with system RNG.

signChunks :: HasCallStack => PrivKey -> SignParam -> SignFmt -> [Bytes] -> IO Bytes

Directly compute a chunked message's mac with system RNG.

newVerifier :: HasCallStack => PubKey -> SignParam -> SignFmt -> IO Verifier

updateVerifier :: HasCallStack => Verifier -> Bytes -> IO ()

finalVerifier :: HasCallStack => Verifier -> Bytes -> IO Bool

sinkToVerifier :: HasCallStack => Verifier -> Sink Bytes

Trun Verifier to a Bytes sink, update Verifier by write bytes to the sink.

verify

Arguments

:: HasCallStack

=> PubKey

-> SignParam

-> SignFmt

-> Bytes

input

-> Bytes

signature

-> IO Bool

Directly sign a message.

verifyChunks

Arguments

:: HasCallStack

=> PubKey

-> SignParam

-> SignFmt

-> [Bytes]

-> Bytes

signature

-> IO Bool

Directly compute a chunked message's mac.

Key agreement

data KeyAgreement

Key agreement object.

Instances

Show KeyAgreement

Defined in Z.Crypto.PubKey

Methods

showsPrec :: Int -> KeyAgreement -> ShowS

show :: KeyAgreement -> String

showList :: [KeyAgreement] -> ShowS

Generic KeyAgreement

Defined in Z.Crypto.PubKey

Associated Types

type Rep KeyAgreement :: Type -> Type

Methods

from :: KeyAgreement -> Rep KeyAgreement x

to :: Rep KeyAgreement x -> KeyAgreement

Print KeyAgreement

Defined in Z.Crypto.PubKey

Methods

toUTF8BuilderP :: Int -> KeyAgreement -> Builder ()

type Rep KeyAgreement

Defined in Z.Crypto.PubKey

type Rep KeyAgreement = D1 ('MetaData "KeyAgreement" "Z.Crypto.PubKey" "Z-Botan-0.4.0.0-Cymuol1BxyD6d85e6LsrR5" 'False) (C1 ('MetaCons "KeyAgreement" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyAgreementStruct") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 BotanStruct) :*: S1 ('MetaSel ('Just "keyAgreementSize") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int)))

keyAgreementSize :: KeyAgreement -> Int

size of the agreed key

newKeyAgreement :: HasCallStack => PrivKey -> KDFType -> IO KeyAgreement

Create a new key agreement operation with a given key pair and KDF algorithm.

Please use a key type that support key agreement, such as DH, ECDH, or Curve25519.

exportKeyAgreementPublic :: HasCallStack => PrivKey -> IO Bytes

Produce the public value to send to other party.

keyAgree

Arguments

:: HasCallStack

=> KeyAgreement

-> Bytes

other key's public

-> Bytes

salt

-> IO Secret

How key agreement works is that you trade public values with some other party, and then each of you runs a computation with the other’s value and your key (this should return the same result to both parties).

RSA specific

getRSAParams

Arguments

:: PrivKey

-> (MPI, MPI, MPI, MPI, MPI)

(p, q, n, d, e)

Get RSA parameters

• Set p to the first RSA prime.
• Set q to the second RSA prime.
• Set n to the RSA modulus.
• Set d to the RSA private exponent.
• Set e to the RSA public exponent.

newRSAPrivKey :: HasCallStack => MPI -> MPI -> MPI -> PrivKey

Initialize a RSA key pair using arguments p, q, and e.

getRSAPubParams

Arguments

:: PubKey

-> (MPI, MPI)

(n, e)

Get RSA Public parameters

• Set n to the RSA modulus.
• Set e to the RSA public exponent.

newRSAPubKey :: HasCallStack => MPI -> MPI -> PubKey

Initialize a public RSA key using arguments n and e.

DSA specific

getDSAPrivParams

Arguments

:: PrivKey

-> (MPI, MPI, MPI, MPI)

(p, q, g, x)

Get DSA parameters

• Set p, q, g to group parameters
• Set x to the private key

newDSAPrivKey :: HasCallStack => MPI -> MPI -> MPI -> MPI -> PrivKey

Initialize a DSA key pair using arguments p, q, g and x.

getDSAPubParams

Arguments

:: PubKey

-> (MPI, MPI, MPI, MPI)

(p, q, g, y)

Get DSA parameters

• Set p, q, g to group parameters
• Set y to the public key

newDSAPubKey :: HasCallStack => MPI -> MPI -> MPI -> MPI -> PubKey

Initialize a DSA public key using arguments p, q, g and y.

ElGamal specific

getElGamalPrivParams

Arguments

:: PrivKey

-> (MPI, MPI, MPI)

(p, g, x)

Get ElGamal parameters

• Set p, g to group parameters
• Set x to the private key

newElGamalPrivKey :: HasCallStack => MPI -> MPI -> MPI -> PrivKey

getElGamalPubParams

Arguments

:: PubKey

-> (MPI, MPI, MPI)

(p, g, y)

Get ElGamal parameters

• Set p, g to group parameters
• Set y to the public key

newElGamalPubKey :: HasCallStack => MPI -> MPI -> MPI -> PubKey

Diffie-Hellman specific

getDHPrivParams

Arguments

:: PrivKey

-> (MPI, MPI, MPI)

(p, g, x)

Get Diffie-Hellman parameters

• Set p, g to group parameters
• Set x to the private key

newDHPrivKey :: HasCallStack => MPI -> MPI -> MPI -> PrivKey

getDHPubParams

Arguments

:: PubKey

-> (MPI, MPI, MPI)

(p, g, y)

Get Diffie-Hellman parameters

• Set p, g to group parameters
• Set y to the public key

newDHPubKey :: HasCallStack => MPI -> MPI -> MPI -> PubKey

constants

type XMSSType = CBytes

A type wrapper.

pattern XMSS_SHA2_10_256 :: XMSSType

pattern XMSS_SHA2_16_256 :: XMSSType

pattern XMSS_SHA2_20_256 :: XMSSType

pattern XMSS_SHA2_10_512 :: XMSSType

pattern XMSS_SHA2_16_512 :: XMSSType

pattern XMSS_SHA2_20_512 :: XMSSType

pattern XMSS_SHAKE_10_256 :: XMSSType

pattern XMSS_SHAKE_16_256 :: XMSSType

pattern XMSS_SHAKE_20_256 :: XMSSType

pattern XMSS_SHAKE_10_512 :: XMSSType

pattern XMSS_SHAKE_16_512 :: XMSSType

pattern XMSS_SHAKE_20_512 :: XMSSType

type ECGroup = CBytes

An elliptic curve.

pattern Secp160k1 :: ECGroup

pattern Secp160r1 :: ECGroup

pattern Secp160r2 :: ECGroup

pattern Secp192k1 :: ECGroup

pattern Secp192r1 :: ECGroup

pattern Secp224k1 :: ECGroup

pattern Secp224r1 :: ECGroup

pattern Secp256k1 :: ECGroup

pattern Secp256r1 :: ECGroup

pattern Secp384r1 :: ECGroup

pattern Secp521r1 :: ECGroup

pattern Brainpool160r1 :: ECGroup

pattern Brainpool192r1 :: ECGroup

pattern Brainpool224r1 :: ECGroup

pattern Brainpool256r1 :: ECGroup

pattern Brainpool320r1 :: ECGroup

pattern Brainpool384r1 :: ECGroup

pattern Brainpool512r1 :: ECGroup

pattern X962_p192v2 :: ECGroup

pattern X962_p192v3 :: ECGroup

pattern X962_p239v1 :: ECGroup

pattern X962_p239v2 :: ECGroup

pattern X962_p239v3 :: ECGroup

pattern Gost_256A :: ECGroup

pattern Gost_512A :: ECGroup

pattern Frp256v1 :: ECGroup

pattern Sm2p256v1 :: ECGroup

type DLGroup = CBytes

Discrete Logarithm Group

pattern FFDHE_IETF_2048 :: DLGroup

pattern FFDHE_IETF_3072 :: DLGroup

pattern FFDHE_IETF_4096 :: DLGroup

pattern FFDHE_IETF_6144 :: DLGroup

pattern FFDHE_IETF_8192 :: DLGroup

pattern MODP_IETF_1024 :: DLGroup

pattern MODP_IETF_1536 :: DLGroup

pattern MODP_IETF_2048 :: DLGroup

pattern MODP_IETF_3072 :: DLGroup

pattern MODP_IETF_4096 :: DLGroup

pattern MODP_IETF_6144 :: DLGroup

pattern MODP_IETF_8192 :: DLGroup

pattern MODP_SRP_1024 :: DLGroup

pattern MODP_SRP_1536 :: DLGroup

pattern MODP_SRP_2048 :: DLGroup

pattern MODP_SRP_3072 :: DLGroup

pattern MODP_SRP_4096 :: DLGroup

pattern MODP_SRP_6144 :: DLGroup

pattern MODP_SRP_8192 :: DLGroup

pattern DSA_JCE_1024 :: DLGroup

pattern DSA_BOTAN_2048 :: DLGroup

pattern DSA_BOTAN_3072 :: DLGroup

re-exports

data HashType

Available Hashs

Constructors

BLAKE2b Int

A recently designed hash function. Very fast on 64-bit processors. Can output a hash of any length between 1 and 64 bytes, this is specified by passing desired byte length.

BLAKE2b256

Alias for Blake2b 32

BLAKE2b512

Alias for Blake2b 64

Keccak1600_224

An older (and incompatible) variant of SHA-3, but sometimes used. Prefer SHA-3 in new code.

Keccak1600_256

Keccak1600_384

Keccak1600_512

MD4

An old hash function that is now known to be trivially breakable. It is very fast, and may still be suitable as a (non-cryptographic) checksum.

MD5

Widely used, now known to be broken.

RIPEMD160

A 160 bit hash function, quite old but still thought to be secure (up to the limit of 2**80 computation required for a collision which is possible with any 160 bit hash function). Somewhat deprecated these days.

SHA160

Widely adopted NSA designed hash function. Starting to show significant signs of weakness, and collisions can now be generated. Avoid in new designs.

SHA256

Relatively fast 256 bit hash function, thought to be secure. Also includes the variant SHA-224. There is no real reason to use SHA-224.

SHA224

SHA512

SHA-512 is faster than SHA-256 on 64-bit processors. Also includes the truncated variants SHA-384 and SHA-512/256, which have the advantage of avoiding message extension attacks.

SHA384

SHA512_256

SHA3_224

The new NIST standard hash. Fairly slow. Supports 224, 256, 384 or 512 bit outputs. SHA-3 is faster with smaller outputs. Use as “SHA3_256” or “SHA3_512”. Plain “SHA-3” selects default 512 bit output.

SHA3_256

SHA3_384

SHA3_512

SHAKE128 Int

These are actually XOFs (extensible output functions) based on SHA-3, which can output a value of any byte length. For example “SHAKE128 @128” will produce 1024 bits of output.

SHAKE256 Int

SM3

Chinese national hash function, 256 bit output. Widely used in industry there. Fast and seemingly secure, but no reason to prefer it over SHA-2 or SHA-3 unless required.

Skein512 Int CBytes

A contender for the NIST SHA-3 competition. Very fast on 64-bit systems. Can output a hash of any length between 1 and 64 bytes. It also accepts an optional “personalization string” which can create variants of the hash. This is useful for domain separation.

Streebog256

Newly designed Russian national hash function. Due to use of input-dependent table lookups, it is vulnerable to side channels. There is no reason to use it unless compatibility is needed. Warning: The Streebog Sbox has recently been revealed to have a hidden structure which interacts with its linear layer in a way which may provide a backdoor when used in certain ways. Avoid Streebog if at all possible.

Streebog512

Whirlpool

A 512-bit hash function standardized by ISO and NESSIE. Relatively slow, and due to the table based implementation it is potentially vulnerable to cache based side channels.

Parallel HashType HashType

Parallel simply concatenates multiple hash functions. For example “Parallel SHA256 SHA512 outputs a 256+512 bit hash created by hashing the input with both SHA256 and SHA512 and concatenating the outputs.

Comb4P HashType HashType

This combines two cryptographic hashes in such a way that preimage and collision attacks are provably at least as hard as a preimage or collision attack on the strongest hash.

Adler32

Checksums, not suitable for cryptographic use, but can be used for error checking purposes.

CRC24

CRC32

Instances

Eq HashType

Defined in Z.Crypto.Hash

Methods

(==) :: HashType -> HashType -> Bool

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

Ord HashType

Defined in Z.Crypto.Hash

Methods

compare :: HashType -> HashType -> Ordering

(<) :: HashType -> HashType -> Bool

(<=) :: HashType -> HashType -> Bool

(>) :: HashType -> HashType -> Bool

(>=) :: HashType -> HashType -> Bool

max :: HashType -> HashType -> HashType

min :: HashType -> HashType -> HashType

Read HashType

Defined in Z.Crypto.Hash

Methods

readsPrec :: Int -> ReadS HashType

readList :: ReadS [HashType]

readPrec :: ReadPrec HashType

readListPrec :: ReadPrec [HashType]

Show HashType

Defined in Z.Crypto.Hash

Methods

showsPrec :: Int -> HashType -> ShowS

show :: HashType -> String

showList :: [HashType] -> ShowS

Generic HashType

Defined in Z.Crypto.Hash

Associated Types

type Rep HashType :: Type -> Type

Methods

from :: HashType -> Rep HashType x

to :: Rep HashType x -> HashType

JSON HashType

Defined in Z.Crypto.Hash

Methods

fromValue :: Value -> Converter HashType

toValue :: HashType -> Value

encodeJSON :: HashType -> Builder ()

Print HashType

Defined in Z.Crypto.Hash

Methods

toUTF8BuilderP :: Int -> HashType -> Builder ()

type Rep HashType

Defined in Z.Crypto.Hash

type Rep HashType = D1 ('MetaData "HashType" "Z.Crypto.Hash" "Z-Botan-0.4.0.0-Cymuol1BxyD6d85e6LsrR5" 'False) (((((C1 ('MetaCons "BLAKE2b" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "BLAKE2b256" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "BLAKE2b512" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Keccak1600_224" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Keccak1600_256" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Keccak1600_384" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Keccak1600_512" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MD4" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "MD5" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RIPEMD160" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SHA160" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SHA256" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "SHA224" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SHA512" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SHA384" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SHA512_256" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: ((((C1 ('MetaCons "SHA3_224" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SHA3_256" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SHA3_384" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SHA3_512" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "SHAKE128" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "SHAKE256" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) :+: (C1 ('MetaCons "SM3" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Skein512" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes))))) :+: (((C1 ('MetaCons "Streebog256" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Streebog512" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Whirlpool" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Parallel" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType)))) :+: ((C1 ('MetaCons "Comb4P" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType)) :+: C1 ('MetaCons "Adler32" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CRC24" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CRC32" 'PrefixI 'False) (U1 :: Type -> Type))))))

data KDFType

Key derivation functions are used to turn some amount of shared secret material into uniform random keys suitable for use with symmetric algorithms. An example of an input which is useful for a KDF is a shared secret created using Diffie-Hellman key agreement.

Constructors

HKDF MACType

HKDF_Extract MACType

HKDF_Expand MACType

Defined in RFC 5869, HKDF uses HMAC to process inputs. Also available are variants HKDF-Extract and HKDF-Expand. HKDF is the combined Extract+Expand operation. Use the combined HKDF unless you need compatibility with some other system.

KDF2 HashType

KDF2 comes from IEEE 1363. It uses a hash function.

KDF1_18033 HashType

KDF1 from ISO 18033-2. Very similar to (but incompatible with) KDF2.

KDF1 HashType

KDF1 from IEEE 1363. It can only produce an output at most the length of the hash function used.

TLS_PRF

A KDF from ANSI X9.42. Sometimes used for Diffie-Hellman.

TLS_12_PRF MACType

SP800_108_Counter MACType

KDFs from NIST SP 800-108. Variants include “SP800-108-Counter”, “SP800-108-Feedback” and “SP800-108-Pipeline”.

SP800_108_Feedback MACType

SP800_108_Pipeline MACType

SP800_56AHash HashType

NIST SP 800-56A KDF using hash function

SP800_56AMAC MACType

NIST SP 800-56A KDF using HMAC

SP800_56C MACType

NIST SP 800-56C KDF using HMAC

Instances

Eq KDFType

Defined in Z.Crypto.KDF

Methods

(==) :: KDFType -> KDFType -> Bool

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

Ord KDFType

Defined in Z.Crypto.KDF

Methods

compare :: KDFType -> KDFType -> Ordering

(<) :: KDFType -> KDFType -> Bool

(<=) :: KDFType -> KDFType -> Bool

(>) :: KDFType -> KDFType -> Bool

(>=) :: KDFType -> KDFType -> Bool

max :: KDFType -> KDFType -> KDFType

min :: KDFType -> KDFType -> KDFType

Read KDFType

Defined in Z.Crypto.KDF

Methods

readsPrec :: Int -> ReadS KDFType

readList :: ReadS [KDFType]

readPrec :: ReadPrec KDFType

readListPrec :: ReadPrec [KDFType]

Show KDFType

Defined in Z.Crypto.KDF

Methods

showsPrec :: Int -> KDFType -> ShowS

show :: KDFType -> String

showList :: [KDFType] -> ShowS

Generic KDFType

Defined in Z.Crypto.KDF

Associated Types

type Rep KDFType :: Type -> Type

Methods

from :: KDFType -> Rep KDFType x

to :: Rep KDFType x -> KDFType

JSON KDFType

Defined in Z.Crypto.KDF

Methods

fromValue :: Value -> Converter KDFType

toValue :: KDFType -> Value

encodeJSON :: KDFType -> Builder ()

Print KDFType

Defined in Z.Crypto.KDF

Methods

toUTF8BuilderP :: Int -> KDFType -> Builder ()

type Rep KDFType

Defined in Z.Crypto.KDF

type Rep KDFType = D1 ('MetaData "KDFType" "Z.Crypto.KDF" "Z-Botan-0.4.0.0-Cymuol1BxyD6d85e6LsrR5" 'False) (((C1 ('MetaCons "HKDF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MACType)) :+: (C1 ('MetaCons "HKDF_Extract" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MACType)) :+: C1 ('MetaCons "HKDF_Expand" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MACType)))) :+: ((C1 ('MetaCons "KDF2" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType)) :+: C1 ('MetaCons "KDF1_18033" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType))) :+: (C1 ('MetaCons "KDF1" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType)) :+: C1 ('MetaCons "TLS_PRF" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "TLS_12_PRF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MACType)) :+: (C1 ('MetaCons "SP800_108_Counter" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MACType)) :+: C1 ('MetaCons "SP800_108_Feedback" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MACType)))) :+: ((C1 ('MetaCons "SP800_108_Pipeline" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MACType)) :+: C1 ('MetaCons "SP800_56AHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType))) :+: (C1 ('MetaCons "SP800_56AMAC" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MACType)) :+: C1 ('MetaCons "SP800_56C" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MACType))))))

data RNG

Opaque botan RNG type.

Instances

Show RNG

Defined in Z.Crypto.RNG

Methods

showsPrec :: Int -> RNG -> ShowS

show :: RNG -> String

showList :: [RNG] -> ShowS

Generic RNG

Defined in Z.Crypto.RNG

Associated Types

type Rep RNG :: Type -> Type

Methods

from :: RNG -> Rep RNG x

to :: Rep RNG x -> RNG

Print RNG

Defined in Z.Crypto.RNG

Methods

toUTF8BuilderP :: Int -> RNG -> Builder ()

type Rep RNG

Defined in Z.Crypto.RNG

type Rep RNG = D1 ('MetaData "RNG" "Z.Crypto.RNG" "Z-Botan-0.4.0.0-Cymuol1BxyD6d85e6LsrR5" 'True) (C1 ('MetaCons "RNG" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BotanStruct)))

getRNG :: HasCallStack => IO RNG

Get an autoseeded RNG from a global RNG pool divide by haskell capability.

Botan internal use a lock to protect user-space RNG, which may cause contention if shared. This function will fetch an autoseeded RNG from a global RNG pool, which is recommended under concurrent settings.

internal

withPrivKey :: HasCallStack => PrivKey -> (BotanStructT -> IO r) -> IO r

Pass PrivKey to FFI.

withPubKey :: PubKey -> (BotanStructT -> IO r) -> IO r

Pass PubKey to FFI.

botanStructToPubKey :: BotanStruct -> PubKey

Unsafe construct a PubKey from a botan struct.