Safe Haskell	None
Language	Haskell2010

Crypto.BLST

Contents

Main functions
Aggregate signatures
Representation datatypes
Utility typeclasses
Data kinds
Typelevel byte sizes
Misc helpers

Synopsis

keygen :: forall ba (n :: Natural). (ByteArrayAccess ba, 32 <= n, KnownNat n) => SizedByteArray n ba -> SecretKey
skToPk :: forall (c :: Curve). IsCurve c => SecretKey -> PublicKey c
sign :: forall (c :: Curve) (m :: EncodeMethod) ba ba2. (ToCurve m c, ByteArrayAccess ba, ByteArrayAccess ba2) => SecretKey -> ba -> Maybe ba2 -> Signature c m
verify :: forall (c :: Curve) (m :: EncodeMethod) ba ba2. (IsCurve c, Demote m, ByteArrayAccess ba, ByteArrayAccess ba2) => Signature c m -> PublicKey c -> ba -> Maybe ba2 -> BlstError
serializeSk :: SecretKey -> SizedByteArray SkSerializeSize ScrubbedBytes
deserializeSk :: ByteArrayAccess ba => SizedByteArray SkSerializeSize ba -> SecretKey
serializePk :: forall (c :: Curve). IsCurve c => PublicKey c -> SizedByteArray (SerializedSize (CurveToPkPoint c)) Bytes
deserializePk :: forall (c :: Curve) ba. (IsCurve c, ByteArrayAccess ba) => SizedByteArray (SerializedSize (CurveToPkPoint c)) ba -> Either BlstError (PublicKey c)
compressPk :: forall (c :: Curve). IsCurve c => PublicKey c -> SizedByteArray (CompressedSize (CurveToPkPoint c)) Bytes
decompressPk :: forall (c :: Curve) ba. (IsCurve c, ByteArrayAccess ba) => SizedByteArray (CompressedSize (CurveToPkPoint c)) ba -> Either BlstError (PublicKey c)
serializeSignature :: forall (c :: Curve) (m :: EncodeMethod). IsCurve c => Signature c m -> SizedByteArray (SerializedSize (CurveToMsgPoint c)) Bytes
deserializeSignature :: forall (c :: Curve) (m :: EncodeMethod) ba. (IsCurve c, ByteArrayAccess ba) => SizedByteArray (SerializedSize (CurveToMsgPoint c)) ba -> Either BlstError (Signature c m)
compressSignature :: forall (c :: Curve) (m :: EncodeMethod). IsCurve c => Signature c m -> SizedByteArray (CompressedSize (CurveToMsgPoint c)) Bytes
decompressSignature :: forall (c :: Curve) (m :: EncodeMethod) ba. (IsCurve c, ByteArrayAccess ba) => SizedByteArray (CompressedSize (CurveToMsgPoint c)) ba -> Either BlstError (Signature c m)
aggregateSignatures :: forall (c :: Curve) (m :: EncodeMethod). IsCurve c => NonEmpty (Signature c m) -> Signature c m
aggregateVerify :: forall (c :: Curve) (m :: EncodeMethod) ba ba2. (IsCurve c, Demote m, ByteArrayAccess ba, ByteArrayAccess ba2) => NonEmpty (PublicKey c, ba) -> Signature c m -> Maybe ba2 -> Either BlstError Bool
data SecretKey
data PublicKey (c :: Curve)
data Signature (c :: Curve) (m :: EncodeMethod)
data BlstError
- = BlstSuccess
- | BlstBadEncoding
- | BlstPointNotOnCurve
- | BlstPointNotInGroup
- | BlstAggrTypeMismatch
- | BlstVerifyFail
- | BlstPkIsInfinity
- | BlstBadScalar
class (IsPoint (CurveToMsgPoint c), IsPoint (CurveToPkPoint c)) => IsCurve (c :: Curve)
class (KnownNat (SerializedSize p), KnownNat (CompressedSize p)) => IsPoint (p :: PointKind)
class (IsCurve c, Demote meth) => ToCurve (meth :: EncodeMethod) (c :: Curve)
class Demote (x :: k)
data Curve
- = G1
- | G2
data EncodeMethod
- = Encode
- | Hash
type family ByteSize (soc :: SerializeOrCompress) a :: Nat
data SerializeOrCompress
- = Serialize
- | Compress
noDST :: Maybe Bytes
byteSize :: forall (soc :: SerializeOrCompress) a. KnownNat (ByteSize soc a) => Int

Main functions

keygen :: forall ba (n :: Natural). (ByteArrayAccess ba, 32 <= n, KnownNat n) => SizedByteArray n ba -> SecretKey Source #

Generate a secret key from bytes.

skToPk :: forall (c :: Curve). IsCurve c => SecretKey -> PublicKey c Source #

Convert a secret key to the corresponding public key on a given curve.

sign Source #

Arguments

:: forall (c :: Curve) (m :: EncodeMethod) ba ba2. (ToCurve m c, ByteArrayAccess ba, ByteArrayAccess ba2)
=> SecretKey	Secret key
-> ba	Message to sign
-> Maybe ba2	Optional domain separation tag
-> Signature c m

Sign a single message.

verify Source #

Arguments

:: forall (c :: Curve) (m :: EncodeMethod) ba ba2. (IsCurve c, Demote m, ByteArrayAccess ba, ByteArrayAccess ba2)
=> Signature c m	Signature
-> PublicKey c	Public key of the signer
-> ba	Message
-> Maybe ba2	Optional domain separation tag (must be the same as used for signing!)
-> BlstError

Verify message signature.

serializeSk :: SecretKey -> SizedByteArray SkSerializeSize ScrubbedBytes Source #

Serialize secret key.

deserializeSk :: ByteArrayAccess ba => SizedByteArray SkSerializeSize ba -> SecretKey Source #

Deserialize secret key.

serializePk :: forall (c :: Curve). IsCurve c => PublicKey c -> SizedByteArray (SerializedSize (CurveToPkPoint c)) Bytes Source #

Serialize public key.

deserializePk :: forall (c :: Curve) ba. (IsCurve c, ByteArrayAccess ba) => SizedByteArray (SerializedSize (CurveToPkPoint c)) ba -> Either BlstError (PublicKey c) Source #

Deserialize public key.

compressPk :: forall (c :: Curve). IsCurve c => PublicKey c -> SizedByteArray (CompressedSize (CurveToPkPoint c)) Bytes Source #

Compress public key.

decompressPk :: forall (c :: Curve) ba. (IsCurve c, ByteArrayAccess ba) => SizedByteArray (CompressedSize (CurveToPkPoint c)) ba -> Either BlstError (PublicKey c) Source #

Decompress public key.

serializeSignature :: forall (c :: Curve) (m :: EncodeMethod). IsCurve c => Signature c m -> SizedByteArray (SerializedSize (CurveToMsgPoint c)) Bytes Source #

Serialize message signature.

deserializeSignature :: forall (c :: Curve) (m :: EncodeMethod) ba. (IsCurve c, ByteArrayAccess ba) => SizedByteArray (SerializedSize (CurveToMsgPoint c)) ba -> Either BlstError (Signature c m) Source #

Deserialize message signature.

compressSignature :: forall (c :: Curve) (m :: EncodeMethod). IsCurve c => Signature c m -> SizedByteArray (CompressedSize (CurveToMsgPoint c)) Bytes Source #

Serialize and compress message signature.

decompressSignature :: forall (c :: Curve) (m :: EncodeMethod) ba. (IsCurve c, ByteArrayAccess ba) => SizedByteArray (CompressedSize (CurveToMsgPoint c)) ba -> Either BlstError (Signature c m) Source #

Decompress and deserialize message signature.

Aggregate signatures

aggregateSignatures :: forall (c :: Curve) (m :: EncodeMethod). IsCurve c => NonEmpty (Signature c m) -> Signature c m Source #

Aggregate multiple signatures.

aggregateVerify Source #

Arguments

:: forall (c :: Curve) (m :: EncodeMethod) ba ba2. (IsCurve c, Demote m, ByteArrayAccess ba, ByteArrayAccess ba2)
=> NonEmpty (PublicKey c, ba)	Public keys with corresponding messages
-> Signature c m	Aggregate signature
-> Maybe ba2	Optional domain separation tag (must be the same as used for signing!)
-> Either BlstError Bool

Aggregate signature verification.

Representation datatypes

data SecretKey Source #

Representation for the secret key.

Instances

Instances details

Show SecretKey Source #
Instance details Defined in Crypto.BLST.Internal.Types Methods showsPrec :: Int -> SecretKey -> ShowS # show :: SecretKey -> String # showList :: [SecretKey] -> ShowS #
NFData SecretKey Source #
Instance details Defined in Crypto.BLST.Internal.Types Methods rnf :: SecretKey -> () #
Eq SecretKey Source #
Instance details Defined in Crypto.BLST.Internal.Types Methods (==) :: SecretKey -> SecretKey -> Bool # (/=) :: SecretKey -> SecretKey -> Bool #
type ByteSize 'Serialize SecretKey Source #
Instance details Defined in Crypto.BLST.Internal.Types type ByteSize 'Serialize SecretKey = SkSerializeSize

data PublicKey (c :: Curve) Source #

Public key representation.

Instances

Instances details

Show (PublicKey c) Source #
Instance details Defined in Crypto.BLST.Internal.Types Methods showsPrec :: Int -> PublicKey c -> ShowS # show :: PublicKey c -> String # showList :: [PublicKey c] -> ShowS #
NFData (PublicKey c) Source #
Instance details Defined in Crypto.BLST.Internal.Types Methods rnf :: PublicKey c -> () #
Eq (PublicKey c) Source #
Instance details Defined in Crypto.BLST.Internal.Types Methods (==) :: PublicKey c -> PublicKey c -> Bool # (/=) :: PublicKey c -> PublicKey c -> Bool #
type ByteSize 'Compress (PublicKey c) Source #
Instance details Defined in Crypto.BLST.Internal.Types type ByteSize 'Compress (PublicKey c) = CompressedSize (CurveToPkPoint c)
type ByteSize 'Serialize (PublicKey c) Source #
Instance details Defined in Crypto.BLST.Internal.Types type ByteSize 'Serialize (PublicKey c) = SerializedSize (CurveToPkPoint c)

data Signature (c :: Curve) (m :: EncodeMethod) Source #

Signature representation.

Instances

Instances details

Show (Signature c m) Source #
Instance details Defined in Crypto.BLST.Internal.Types Methods showsPrec :: Int -> Signature c m -> ShowS # show :: Signature c m -> String # showList :: [Signature c m] -> ShowS #
NFData (Signature c m) Source #
Instance details Defined in Crypto.BLST.Internal.Types Methods rnf :: Signature c m -> () #
Eq (Signature c m) Source #
Instance details Defined in Crypto.BLST.Internal.Types Methods (==) :: Signature c m -> Signature c m -> Bool # (/=) :: Signature c m -> Signature c m -> Bool #
type ByteSize 'Compress (Signature c _1) Source #
Instance details Defined in Crypto.BLST.Internal.Types type ByteSize 'Compress (Signature c _1) = CompressedSize (CurveToMsgPoint c)
type ByteSize 'Serialize (Signature c _1) Source #
Instance details Defined in Crypto.BLST.Internal.Types type ByteSize 'Serialize (Signature c _1) = SerializedSize (CurveToMsgPoint c)

data BlstError Source #

Possible C return values.

Constructors

BlstSuccess
BlstBadEncoding
BlstPointNotOnCurve
BlstPointNotInGroup
BlstAggrTypeMismatch
BlstVerifyFail
BlstPkIsInfinity
BlstBadScalar

Instances

Instances details

Bounded BlstError Source #
Instance details Defined in Crypto.BLST.Internal.Bindings Methods minBound :: BlstError # maxBound :: BlstError #
Enum BlstError Source #	Generate secret key from bytes. Input must be at least 32 bytes long.
Instance details Defined in Crypto.BLST.Internal.Bindings Methods succ :: BlstError -> BlstError # pred :: BlstError -> BlstError # toEnum :: Int -> BlstError # fromEnum :: BlstError -> Int # enumFrom :: BlstError -> [BlstError] # enumFromThen :: BlstError -> BlstError -> [BlstError] # enumFromTo :: BlstError -> BlstError -> [BlstError] # enumFromThenTo :: BlstError -> BlstError -> BlstError -> [BlstError] #
Exception BlstError Source #
Instance details Defined in Crypto.BLST.Internal.Bindings Methods toException :: BlstError -> SomeException # fromException :: SomeException -> Maybe BlstError # displayException :: BlstError -> String #
Show BlstError Source #
Instance details Defined in Crypto.BLST.Internal.Bindings Methods showsPrec :: Int -> BlstError -> ShowS # show :: BlstError -> String # showList :: [BlstError] -> ShowS #
Eq BlstError Source #
Instance details Defined in Crypto.BLST.Internal.Bindings Methods (==) :: BlstError -> BlstError -> Bool # (/=) :: BlstError -> BlstError -> Bool #

Utility typeclasses

class (IsPoint (CurveToMsgPoint c), IsPoint (CurveToPkPoint c)) => IsCurve (c :: Curve) Source #

Class for operations on curves.

Minimal complete definition

skToPkPoint, signPk, coreVerifyPk, pairingChkNAggrPk

Instances

Instances details

IsCurve 'G1 Source #
Instance details Defined in Crypto.BLST.Internal.Classy Methods skToPkPoint :: Scalar -> IO (Point (CurveToPkPoint 'G1)) Source # signPk :: Point (CurveToMsgPoint 'G1) -> Scalar -> IO (Point (CurveToMsgPoint 'G1)) Source # coreVerifyPk :: (ByteArrayAccess ba, ByteArrayAccess ba2) => Affine (CurveToPkPoint 'G1) -> Affine (CurveToMsgPoint 'G1) -> EncodeMethod -> ba -> Maybe ba2 -> IO BlstError Source # pairingChkNAggrPk :: ByteArrayAccess ba => PairingCtx -> Affine (CurveToPkPoint 'G1) -> Bool -> Maybe (Affine (CurveToMsgPoint 'G1)) -> Bool -> ba -> IO BlstError Source #
IsCurve 'G2 Source #
Instance details Defined in Crypto.BLST.Internal.Classy Methods skToPkPoint :: Scalar -> IO (Point (CurveToPkPoint 'G2)) Source # signPk :: Point (CurveToMsgPoint 'G2) -> Scalar -> IO (Point (CurveToMsgPoint 'G2)) Source # coreVerifyPk :: (ByteArrayAccess ba, ByteArrayAccess ba2) => Affine (CurveToPkPoint 'G2) -> Affine (CurveToMsgPoint 'G2) -> EncodeMethod -> ba -> Maybe ba2 -> IO BlstError Source # pairingChkNAggrPk :: ByteArrayAccess ba => PairingCtx -> Affine (CurveToPkPoint 'G2) -> Bool -> Maybe (Affine (CurveToMsgPoint 'G2)) -> Bool -> ba -> IO BlstError Source #

class (KnownNat (SerializedSize p), KnownNat (CompressedSize p)) => IsPoint (p :: PointKind) Source #

Class for operations on points.

Minimal complete definition

toAffine, fromAffine, affSerialize, affCompress, uncompress, addOrDoubleAffine, deserialize

Instances

Instances details

IsPoint 'P1 Source #
Instance details Defined in Crypto.BLST.Internal.Classy Methods toAffine :: Point 'P1 -> IO (Affine 'P1) Source # fromAffine :: Affine 'P1 -> IO (Point 'P1) Source # affSerialize :: Affine 'P1 -> IO (SizedByteArray (SerializedSize 'P1) Bytes) Source # affCompress :: Affine 'P1 -> IO (SizedByteArray (CompressedSize 'P1) Bytes) Source # uncompress :: ByteArrayAccess ba => SizedByteArray (CompressedSize 'P1) ba -> IO (Either BlstError (Affine 'P1)) Source # addOrDoubleAffine :: Point 'P1 -> Affine 'P1 -> IO (Point 'P1) Source # deserialize :: ByteArrayAccess ba => SizedByteArray (SerializedSize 'P1) ba -> IO (Either BlstError (Affine 'P1)) Source #
IsPoint 'P2 Source #
Instance details Defined in Crypto.BLST.Internal.Classy Methods toAffine :: Point 'P2 -> IO (Affine 'P2) Source # fromAffine :: Affine 'P2 -> IO (Point 'P2) Source # affSerialize :: Affine 'P2 -> IO (SizedByteArray (SerializedSize 'P2) Bytes) Source # affCompress :: Affine 'P2 -> IO (SizedByteArray (CompressedSize 'P2) Bytes) Source # uncompress :: ByteArrayAccess ba => SizedByteArray (CompressedSize 'P2) ba -> IO (Either BlstError (Affine 'P2)) Source # addOrDoubleAffine :: Point 'P2 -> Affine 'P2 -> IO (Point 'P2) Source # deserialize :: ByteArrayAccess ba => SizedByteArray (SerializedSize 'P2) ba -> IO (Either BlstError (Affine 'P2)) Source #

class (IsCurve c, Demote meth) => ToCurve (meth :: EncodeMethod) (c :: Curve) Source #

Class for encoding/hashing to curve.

Minimal complete definition

toCurve

Instances

Instances details

ToCurve 'Encode 'G1 Source #
Instance details Defined in Crypto.BLST.Internal.Classy Methods toCurve :: (ByteArrayAccess ba, ByteArrayAccess ba2) => ba -> Maybe ba2 -> IO (Point (CurveToMsgPoint 'G1)) Source #
ToCurve 'Encode 'G2 Source #
Instance details Defined in Crypto.BLST.Internal.Classy Methods toCurve :: (ByteArrayAccess ba, ByteArrayAccess ba2) => ba -> Maybe ba2 -> IO (Point (CurveToMsgPoint 'G2)) Source #
ToCurve 'Hash 'G1 Source #
Instance details Defined in Crypto.BLST.Internal.Classy Methods toCurve :: (ByteArrayAccess ba, ByteArrayAccess ba2) => ba -> Maybe ba2 -> IO (Point (CurveToMsgPoint 'G1)) Source #
ToCurve 'Hash 'G2 Source #
Instance details Defined in Crypto.BLST.Internal.Classy Methods toCurve :: (ByteArrayAccess ba, ByteArrayAccess ba2) => ba -> Maybe ba2 -> IO (Point (CurveToMsgPoint 'G2)) Source #

class Demote (x :: k) Source #

Demotes a promoted data kind.

Minimal complete definition

demote

Instances

Instances details

Demote 'Encode Source #
Instance details Defined in Crypto.BLST.Internal.Bindings.Types Methods demote :: EncodeMethod Source #
Demote 'Hash Source #
Instance details Defined in Crypto.BLST.Internal.Bindings.Types Methods demote :: EncodeMethod Source #
Demote 'P1 Source #
Instance details Defined in Crypto.BLST.Internal.Bindings.Types Methods demote :: PointKind Source #
Demote 'P2 Source #
Instance details Defined in Crypto.BLST.Internal.Bindings.Types Methods demote :: PointKind Source #
Demote 'G1 Source #
Instance details Defined in Crypto.BLST.Internal.Classy Methods demote :: Curve Source #
Demote 'G2 Source #
Instance details Defined in Crypto.BLST.Internal.Classy Methods demote :: Curve Source #

Data kinds

data Curve Source #

Curve data kind.

Constructors

G1
G2

Instances

Instances details

Demote 'G1 Source #
Instance details Defined in Crypto.BLST.Internal.Classy Methods demote :: Curve Source #
Demote 'G2 Source #
Instance details Defined in Crypto.BLST.Internal.Classy Methods demote :: Curve Source #

data EncodeMethod Source #

Flag to choose whether values are hashed or encoded to the curve.

Constructors

Encode
Hash

Instances

Instances details

Bounded EncodeMethod Source #
Instance details Defined in Crypto.BLST.Internal.Bindings.Types Methods minBound :: EncodeMethod # maxBound :: EncodeMethod #
Enum EncodeMethod Source #
Instance details Defined in Crypto.BLST.Internal.Bindings.Types Methods succ :: EncodeMethod -> EncodeMethod # pred :: EncodeMethod -> EncodeMethod # toEnum :: Int -> EncodeMethod # fromEnum :: EncodeMethod -> Int # enumFrom :: EncodeMethod -> [EncodeMethod] # enumFromThen :: EncodeMethod -> EncodeMethod -> [EncodeMethod] # enumFromTo :: EncodeMethod -> EncodeMethod -> [EncodeMethod] # enumFromThenTo :: EncodeMethod -> EncodeMethod -> EncodeMethod -> [EncodeMethod] #
Show EncodeMethod Source #
Instance details Defined in Crypto.BLST.Internal.Bindings.Types Methods showsPrec :: Int -> EncodeMethod -> ShowS # show :: EncodeMethod -> String # showList :: [EncodeMethod] -> ShowS #
Eq EncodeMethod Source #
Instance details Defined in Crypto.BLST.Internal.Bindings.Types Methods (==) :: EncodeMethod -> EncodeMethod -> Bool # (/=) :: EncodeMethod -> EncodeMethod -> Bool #
Demote 'Encode Source #
Instance details Defined in Crypto.BLST.Internal.Bindings.Types Methods demote :: EncodeMethod Source #
Demote 'Hash Source #
Instance details Defined in Crypto.BLST.Internal.Bindings.Types Methods demote :: EncodeMethod Source #

Typelevel byte sizes

type family ByteSize (soc :: SerializeOrCompress) a :: Nat Source #

Size in bytes of serialized/compressed representations of basic types.

Instances

Instances details

type ByteSize 'Serialize SecretKey Source #
Instance details Defined in Crypto.BLST.Internal.Types type ByteSize 'Serialize SecretKey = SkSerializeSize
type ByteSize 'Compress (PublicKey c) Source #
Instance details Defined in Crypto.BLST.Internal.Types type ByteSize 'Compress (PublicKey c) = CompressedSize (CurveToPkPoint c)
type ByteSize 'Serialize (PublicKey c) Source #
Instance details Defined in Crypto.BLST.Internal.Types type ByteSize 'Serialize (PublicKey c) = SerializedSize (CurveToPkPoint c)
type ByteSize 'Compress (Signature c _1) Source #
Instance details Defined in Crypto.BLST.Internal.Types type ByteSize 'Compress (Signature c _1) = CompressedSize (CurveToMsgPoint c)
type ByteSize 'Serialize (Signature c _1) Source #
Instance details Defined in Crypto.BLST.Internal.Types type ByteSize 'Serialize (Signature c _1) = SerializedSize (CurveToMsgPoint c)

data SerializeOrCompress Source #

Data kind flag for ByteSize.

Constructors

Serialize
Compress

Misc helpers

noDST :: Maybe Bytes Source #

Convenience synonym for Nothing. Do not use domain separation tag.

byteSize :: forall (soc :: SerializeOrCompress) a. KnownNat (ByteSize soc a) => Int Source #

Convenience function to get byte size as an Int value.