Crypto.BLST.Internal.Bindings

Lower-level bindings. Functions starting with blst_ are raw c2hs bindings. Others are slightly higher level wrappers around those bindings.

See https://github.com/supranational/blst/tree/f791f7a465cda8ecda74df0a60778331dde40809#introductory-tutorial for a more comprehensive explanation of the functions declared here.

Documentation

data BlstError

Possible C return values.

Constructors

BlstSuccess

BlstBadEncoding

BlstPointNotOnCurve

BlstPointNotInGroup

BlstAggrTypeMismatch

BlstVerifyFail

BlstPkIsInfinity

BlstBadScalar

Instances

Bounded BlstError

Defined in Crypto.BLST.Internal.Bindings

Methods

minBound :: BlstError

maxBound :: BlstError

Enum BlstError

Generate secret key from bytes. Input must be at least 32 bytes long.

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

Defined in Crypto.BLST.Internal.Bindings

Methods

toException :: BlstError -> SomeException

fromException :: SomeException -> Maybe BlstError

displayException :: BlstError -> String

Show BlstError

Defined in Crypto.BLST.Internal.Bindings

Methods

showsPrec :: Int -> BlstError -> ShowS

show :: BlstError -> String

showList :: [BlstError] -> ShowS

Eq BlstError

Defined in Crypto.BLST.Internal.Bindings

Methods

(==) :: BlstError -> BlstError -> Bool

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

blst_pairing_finalverify :: Ptr () -> Ptr () -> IO CInt

blst_pairing_commit :: Ptr () -> IO ()

blst_pairing_init :: Ptr () -> CInt -> Ptr CUChar -> CULong -> IO ()

blst_pairing_sizeof :: IO CULong

blst_pairing_chk_n_aggr_pk_in_g2 :: Ptr () -> Ptr () -> CInt -> Ptr () -> CInt -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> IO CInt

blst_pairing_chk_n_aggr_pk_in_g1 :: Ptr () -> Ptr () -> CInt -> Ptr () -> CInt -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> IO CInt

blst_p2_from_affine :: Ptr () -> Ptr () -> IO ()

blst_p1_from_affine :: Ptr () -> Ptr () -> IO ()

blst_p2_add_or_double_affine :: Ptr () -> Ptr () -> Ptr () -> IO ()

blst_p1_add_or_double_affine :: Ptr () -> Ptr () -> Ptr () -> IO ()

blst_scalar_from_lendian :: Ptr () -> Ptr CUChar -> IO ()

blst_lendian_from_scalar :: Ptr CUChar -> Ptr () -> IO ()

blst_p2_uncompress :: Ptr () -> Ptr CUChar -> IO CInt

blst_p2_deserialize :: Ptr () -> Ptr CUChar -> IO CInt

blst_p2_affine_compress :: Ptr CUChar -> Ptr () -> IO ()

blst_p2_affine_serialize :: Ptr CUChar -> Ptr () -> IO ()

blst_p1_uncompress :: Ptr () -> Ptr CUChar -> IO CInt

blst_p1_deserialize :: Ptr () -> Ptr CUChar -> IO CInt

blst_p1_affine_compress :: Ptr CUChar -> Ptr () -> IO ()

blst_p1_affine_serialize :: Ptr CUChar -> Ptr () -> IO ()

blst_p2_to_affine :: Ptr () -> Ptr () -> IO ()

blst_p1_to_affine :: Ptr () -> Ptr () -> IO ()

blst_core_verify_pk_in_g2 :: Ptr () -> Ptr () -> CInt -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> IO CInt

blst_core_verify_pk_in_g1 :: Ptr () -> Ptr () -> CInt -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> IO CInt

blst_hash_to_g2 :: Ptr () -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> IO ()

blst_encode_to_g2 :: Ptr () -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> IO ()

blst_hash_to_g1 :: Ptr () -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> IO ()

blst_encode_to_g1 :: Ptr () -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> IO ()

blst_sign_pk_in_g2 :: Ptr () -> Ptr () -> Ptr () -> IO ()

blst_sign_pk_in_g1 :: Ptr () -> Ptr () -> Ptr () -> IO ()

blst_sk_to_pk_in_g2 :: Ptr () -> Ptr () -> IO ()

blst_sk_to_pk_in_g1 :: Ptr () -> Ptr () -> IO ()

blst_keygen :: Ptr () -> Ptr CUChar -> CULong -> Ptr CUChar -> CULong -> IO ()

keygen :: ByteArrayAccess ba => ba -> IO Scalar

skToPkInG1 :: Scalar -> IO (Point 'P1)

Convert scalar to a point in G1.

skToPkInG2 :: Scalar -> IO (Point 'P2)

Convert scalar to a P2 point in G2.

signPkInG1 :: Point 'P2 -> Scalar -> IO (Point 'P2)

Sign a message point in G1.

signPkInG2 :: Point 'P1 -> Scalar -> IO (Point 'P1)

Sign a message point in G2.

encodeToG1 :: (ByteArrayAccess ba, ByteArrayAccess ba2) => ba -> Maybe ba2 -> IO (Point 'P1)

Encode bytes to a point in G1.

hashToG1 :: (ByteArrayAccess ba, ByteArrayAccess ba2) => ba -> Maybe ba2 -> IO (Point 'P1)

Hash bytes to a point in G1.

encodeToG2 :: (ByteArrayAccess ba, ByteArrayAccess ba2) => ba -> Maybe ba2 -> IO (Point 'P2)

Encode bytes to a point in G2.

hashToG2 :: (ByteArrayAccess ba, ByteArrayAccess ba2) => ba -> Maybe ba2 -> IO (Point 'P2)

Hash bytes to a point in G2.

coreVerifyPkInG1

Arguments

:: (ByteArrayAccess ba, ByteArrayAccess ba2)

=> Affine 'P1

Public key

-> Affine 'P2

Signature

-> EncodeMethod

Was message encoded or hashed to the curve

-> ba

Message

-> Maybe ba2

Optional domain separation tag

-> IO BlstError

Core signature verification function in G1.

coreVerifyPkInG2

Arguments

:: (ByteArrayAccess ba, ByteArrayAccess ba2)

=> Affine 'P2

Public key

-> Affine 'P1

Signature

-> EncodeMethod

Was message encoded or hashed to the curve

-> ba

Message

-> Maybe ba2

Optional domain separation tag

-> IO BlstError

Core signature verification function in G2.

p1ToAffine :: Point 'P1 -> IO (Affine 'P1)

Convert point to affine point in G1.

p2ToAffine :: Point 'P2 -> IO (Affine 'P2)

Convert point to affine point in G2.

p1AffSerialize :: Affine 'P1 -> IO (SizedByteArray P1SerializeSize Bytes)

Serialize affine G1 point.

p1AffCompress :: Affine 'P1 -> IO (SizedByteArray P1CompressSize Bytes)

Serialize and compress affine G1 point.

p1Deserialize :: ByteArrayAccess ba => SizedByteArray P1SerializeSize ba -> IO (Either BlstError (Affine 'P1))

Deserialize affine G1 point.

p1Uncompress :: ByteArrayAccess ba => SizedByteArray P1CompressSize ba -> IO (Either BlstError (Affine 'P1))

Deserialize and decompress affine G1 point.

p2AffSerialize :: Affine 'P2 -> IO (SizedByteArray P2SerializeSize Bytes)

Serialize affine G2 point.

p2AffCompress :: Affine 'P2 -> IO (SizedByteArray P2CompressSize Bytes)

Serialize and compress affine G2 point.

p2Deserialize :: ByteArrayAccess ba => SizedByteArray P2SerializeSize ba -> IO (Either BlstError (Affine 'P2))

Deserialize affine G2 point.

p2Uncompress :: ByteArrayAccess ba => SizedByteArray P2CompressSize ba -> IO (Either BlstError (Affine 'P2))

Deserialize and decompress affine G2 point.

lendianFromScalar :: Scalar -> IO (SizedByteArray SkSerializeSize ScrubbedBytes)

Get scalar bytes in little endian order.

scalarFromLendian :: ByteArrayAccess ba => SizedByteArray SkSerializeSize ba -> IO Scalar

Build scalar from bytes in little endian order.

p1AddOrDoubleAffine :: Point 'P1 -> Affine 'P1 -> IO (Point 'P1)

Add affine point to point in G1.

p2AddOrDoubleAffine :: Point 'P2 -> Affine 'P2 -> IO (Point 'P2)

Add affine point to point in G2.

p1FromAffine :: Affine 'P1 -> IO (Point 'P1)

Convert affine point to point in G1.

p2FromAffine :: Affine 'P2 -> IO (Point 'P2)

Convert affine point to point in G2.

pairingChkNAggrPkInG1

Arguments

:: ByteArrayAccess ba

=> PairingCtx

Pairing context. Use pairingInit to create.

-> Affine 'P1

Public key

-> Bool

Check public key group?

-> Maybe (Affine 'P2)

Signature. Only the first call per pairing context specifies the signature, all consequent calls for the same context should use Nothing here.

-> Bool

Check signature group?

-> ba

Message

-> IO BlstError

Check aggregate signature in G1.

pairingChkNAggrPkInG2

Arguments

:: ByteArrayAccess ba

=> PairingCtx

Pairing context. Use pairingInit to create.

-> Affine 'P2

Public key

-> Bool

Check public key group?

-> Maybe (Affine 'P1)

Signature. Only the first call per pairing context specifies the signature, all consequent calls for the same context should use Nothing here.

-> Bool

Check signature group?

-> ba

Message

-> IO BlstError

Check aggregate signature in G2.

pairingInit :: ByteArrayAccess ba => EncodeMethod -> Maybe ba -> IO PairingCtx

Make new pairing context.

pairingCommit :: PairingCtx -> IO ()

Commit pairing context.

pairingFinalVerify :: PairingCtx -> IO Bool

Verify pairing context.

module Crypto.BLST.Internal.Bindings.Types