Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Crypto.EllipticCurve.BLS12_381

Contents

Types
BLS Class
Point / Group operations
PT operations
Pairings
The period (modulo) of scalars

Synopsis

data Point curve
type Point1 = Point Curve1
type Point2 = Point Curve2
data PT
data Curve1
data Curve2
data BLSTError
- = BLST_SUCCESS
- | BLST_BAD_ENCODING
- | BLST_POINT_NOT_ON_CURVE
- | BLST_POINT_NOT_IN_GROUP
- | BLST_AGGR_TYPE_MISMATCH
- | BLST_VERIFY_FAIL
- | BLST_PK_IS_INFINITY
- | BLST_BAD_SCALAR
- | BLST_UNKNOWN_ERROR
class BLS curve
blsInGroup :: BLS curve => Point curve -> Bool
blsAddOrDouble :: BLS curve => Point curve -> Point curve -> Point curve
blsMult :: BLS curve => Point curve -> Integer -> Point curve
blsCneg :: BLS curve => Point curve -> Bool -> Point curve
blsNeg :: BLS curve => Point curve -> Point curve
blsCompress :: forall curve. BLS curve => Point curve -> ByteString
blsSerialize :: forall curve. BLS curve => Point curve -> ByteString
blsUncompress :: forall curve. BLS curve => ByteString -> Either BLSTError (Point curve)
blsDeserialize :: forall curve. BLS curve => ByteString -> Either BLSTError (Point curve)
blsHash :: BLS curve => ByteString -> Maybe ByteString -> Maybe ByteString -> Point curve
blsGenerator :: BLS curve => Point curve
blsIsInf :: BLS curve => Point curve -> Bool
ptMult :: PT -> PT -> PT
ptFinalVerify :: PT -> PT -> Bool
millerLoop :: Point1 -> Point2 -> PT
scalarPeriod :: Integer

Types

data Point curve #

A point on an elliptic curve. This type guarantees that the point is part of the | prime order subgroup.

Instances

Instances details

BLS curve => Eq (Point curve) #
Instance details Defined in Cardano.Crypto.EllipticCurve.BLS12_381.Internal Methods (==) :: Point curve -> Point curve -> Bool Source # (/=) :: Point curve -> Point curve -> Bool Source #

type Point1 = Point Curve1 #

type Point2 = Point Curve2 #

data PT #

Target element without the final exponantiation. By defining target elements | as such, we save up the final exponantiation when computing a pairing, and only | compute it when necessary (e.g. comparison with another point or serialisation)

Instances

Instances details

Eq PT #
Instance details Defined in Cardano.Crypto.EllipticCurve.BLS12_381.Internal Methods (==) :: PT -> PT -> Bool Source # (/=) :: PT -> PT -> Bool Source #

data Curve1 #

Instances

Instances details

BLS Curve1 #

Instance details

Defined in Cardano.Crypto.EllipticCurve.BLS12_381.Internal

Methods

c_blst_on_curve :: PointPtr Curve1 -> IO Bool #

c_blst_add_or_double :: PointPtr Curve1 -> PointPtr Curve1 -> PointPtr Curve1 -> IO () #

c_blst_mult :: PointPtr Curve1 -> PointPtr Curve1 -> ScalarPtr -> CSize -> IO () #

c_blst_cneg :: PointPtr Curve1 -> Bool -> IO () #

c_blst_hash :: PointPtr Curve1 -> Ptr CChar -> CSize -> Ptr CChar -> CSize -> Ptr CChar -> CSize -> IO () #

c_blst_compress :: Ptr CChar -> PointPtr Curve1 -> IO () #

c_blst_serialize :: Ptr CChar -> PointPtr Curve1 -> IO () #

c_blst_uncompress :: AffinePtr Curve1 -> Ptr CChar -> IO CInt #

c_blst_deserialize :: AffinePtr Curve1 -> Ptr CChar -> IO CInt #

c_blst_in_g :: PointPtr Curve1 -> IO Bool #

c_blst_to_affine :: AffinePtr Curve1 -> PointPtr Curve1 -> IO () #

c_blst_from_affine :: PointPtr Curve1 -> AffinePtr Curve1 -> IO () #

c_blst_affine_in_g :: AffinePtr Curve1 -> IO Bool #

c_blst_generator :: PointPtr Curve1 #

c_blst_p_is_equal :: PointPtr Curve1 -> PointPtr Curve1 -> IO Bool #

c_blst_p_is_inf :: PointPtr Curve1 -> IO Bool #

sizePoint_ :: Proxy Curve1 -> CSize

serializedSizePoint_ :: Proxy Curve1 -> CSize

compressedSizePoint_ :: Proxy Curve1 -> CSize

sizeAffine_ :: Proxy Curve1 -> CSize

data Curve2 #

Instances

Instances details

BLS Curve2 #

Instance details

Defined in Cardano.Crypto.EllipticCurve.BLS12_381.Internal

Methods

c_blst_on_curve :: PointPtr Curve2 -> IO Bool #

c_blst_add_or_double :: PointPtr Curve2 -> PointPtr Curve2 -> PointPtr Curve2 -> IO () #

c_blst_mult :: PointPtr Curve2 -> PointPtr Curve2 -> ScalarPtr -> CSize -> IO () #

c_blst_cneg :: PointPtr Curve2 -> Bool -> IO () #

c_blst_hash :: PointPtr Curve2 -> Ptr CChar -> CSize -> Ptr CChar -> CSize -> Ptr CChar -> CSize -> IO () #

c_blst_compress :: Ptr CChar -> PointPtr Curve2 -> IO () #

c_blst_serialize :: Ptr CChar -> PointPtr Curve2 -> IO () #

c_blst_uncompress :: AffinePtr Curve2 -> Ptr CChar -> IO CInt #

c_blst_deserialize :: AffinePtr Curve2 -> Ptr CChar -> IO CInt #

c_blst_in_g :: PointPtr Curve2 -> IO Bool #

c_blst_to_affine :: AffinePtr Curve2 -> PointPtr Curve2 -> IO () #

c_blst_from_affine :: PointPtr Curve2 -> AffinePtr Curve2 -> IO () #

c_blst_affine_in_g :: AffinePtr Curve2 -> IO Bool #

c_blst_generator :: PointPtr Curve2 #

c_blst_p_is_equal :: PointPtr Curve2 -> PointPtr Curve2 -> IO Bool #

c_blst_p_is_inf :: PointPtr Curve2 -> IO Bool #

sizePoint_ :: Proxy Curve2 -> CSize

serializedSizePoint_ :: Proxy Curve2 -> CSize

compressedSizePoint_ :: Proxy Curve2 -> CSize

sizeAffine_ :: Proxy Curve2 -> CSize

data BLSTError #

Constructors

BLST_SUCCESS
BLST_BAD_ENCODING
BLST_POINT_NOT_ON_CURVE
BLST_POINT_NOT_IN_GROUP
BLST_AGGR_TYPE_MISMATCH
BLST_VERIFY_FAIL
BLST_PK_IS_INFINITY
BLST_BAD_SCALAR
BLST_UNKNOWN_ERROR

Instances

Instances details

Bounded BLSTError #
Instance details Defined in Cardano.Crypto.EllipticCurve.BLS12_381.Internal Methods minBound :: BLSTError Source # maxBound :: BLSTError Source #
Enum BLSTError #
Instance details Defined in Cardano.Crypto.EllipticCurve.BLS12_381.Internal Methods succ :: BLSTError -> BLSTError Source # pred :: BLSTError -> BLSTError Source # toEnum :: Int -> BLSTError Source # fromEnum :: BLSTError -> Int Source # enumFrom :: BLSTError -> [BLSTError] Source # enumFromThen :: BLSTError -> BLSTError -> [BLSTError] Source # enumFromTo :: BLSTError -> BLSTError -> [BLSTError] Source # enumFromThenTo :: BLSTError -> BLSTError -> BLSTError -> [BLSTError] Source #
Show BLSTError #
Instance details Defined in Cardano.Crypto.EllipticCurve.BLS12_381.Internal Methods showsPrec :: Int -> BLSTError -> ShowS Source # show :: BLSTError -> String Source # showList :: [BLSTError] -> ShowS Source #
Eq BLSTError #
Instance details Defined in Cardano.Crypto.EllipticCurve.BLS12_381.Internal Methods (==) :: BLSTError -> BLSTError -> Bool Source # (/=) :: BLSTError -> BLSTError -> Bool Source #
Ord BLSTError #
Instance details Defined in Cardano.Crypto.EllipticCurve.BLS12_381.Internal Methods compare :: BLSTError -> BLSTError -> Ordering Source # (<) :: BLSTError -> BLSTError -> Bool Source # (<=) :: BLSTError -> BLSTError -> Bool Source # (>) :: BLSTError -> BLSTError -> Bool Source # (>=) :: BLSTError -> BLSTError -> Bool Source # max :: BLSTError -> BLSTError -> BLSTError Source # min :: BLSTError -> BLSTError -> BLSTError Source #

BLS Class

class BLS curve #

BLS curve operations. Class methods are low-level; user code will want to use higher-level wrappers such as blsAddOrDouble, blsMult, blsCneg, blsNeg, etc.

Minimal complete definition

c_blst_on_curve, c_blst_add_or_double, c_blst_mult, c_blst_cneg, c_blst_hash, c_blst_compress, c_blst_serialize, c_blst_uncompress, c_blst_deserialize, c_blst_in_g, c_blst_to_affine, c_blst_from_affine, c_blst_affine_in_g, c_blst_generator, c_blst_p_is_equal, c_blst_p_is_inf, sizePoint_, serializedSizePoint_, compressedSizePoint_, sizeAffine_

Instances

Instances details

BLS Curve1 #
Instance details Defined in Cardano.Crypto.EllipticCurve.BLS12_381.Internal Methods c_blst_on_curve :: PointPtr Curve1 -> IO Bool # c_blst_add_or_double :: PointPtr Curve1 -> PointPtr Curve1 -> PointPtr Curve1 -> IO () # c_blst_mult :: PointPtr Curve1 -> PointPtr Curve1 -> ScalarPtr -> CSize -> IO () # c_blst_cneg :: PointPtr Curve1 -> Bool -> IO () # c_blst_hash :: PointPtr Curve1 -> Ptr CChar -> CSize -> Ptr CChar -> CSize -> Ptr CChar -> CSize -> IO () # c_blst_compress :: Ptr CChar -> PointPtr Curve1 -> IO () # c_blst_serialize :: Ptr CChar -> PointPtr Curve1 -> IO () # c_blst_uncompress :: AffinePtr Curve1 -> Ptr CChar -> IO CInt # c_blst_deserialize :: AffinePtr Curve1 -> Ptr CChar -> IO CInt # c_blst_in_g :: PointPtr Curve1 -> IO Bool # c_blst_to_affine :: AffinePtr Curve1 -> PointPtr Curve1 -> IO () # c_blst_from_affine :: PointPtr Curve1 -> AffinePtr Curve1 -> IO () # c_blst_affine_in_g :: AffinePtr Curve1 -> IO Bool # c_blst_generator :: PointPtr Curve1 # c_blst_p_is_equal :: PointPtr Curve1 -> PointPtr Curve1 -> IO Bool # c_blst_p_is_inf :: PointPtr Curve1 -> IO Bool # sizePoint_ :: Proxy Curve1 -> CSize serializedSizePoint_ :: Proxy Curve1 -> CSize compressedSizePoint_ :: Proxy Curve1 -> CSize sizeAffine_ :: Proxy Curve1 -> CSize
BLS Curve2 #
Instance details Defined in Cardano.Crypto.EllipticCurve.BLS12_381.Internal Methods c_blst_on_curve :: PointPtr Curve2 -> IO Bool # c_blst_add_or_double :: PointPtr Curve2 -> PointPtr Curve2 -> PointPtr Curve2 -> IO () # c_blst_mult :: PointPtr Curve2 -> PointPtr Curve2 -> ScalarPtr -> CSize -> IO () # c_blst_cneg :: PointPtr Curve2 -> Bool -> IO () # c_blst_hash :: PointPtr Curve2 -> Ptr CChar -> CSize -> Ptr CChar -> CSize -> Ptr CChar -> CSize -> IO () # c_blst_compress :: Ptr CChar -> PointPtr Curve2 -> IO () # c_blst_serialize :: Ptr CChar -> PointPtr Curve2 -> IO () # c_blst_uncompress :: AffinePtr Curve2 -> Ptr CChar -> IO CInt # c_blst_deserialize :: AffinePtr Curve2 -> Ptr CChar -> IO CInt # c_blst_in_g :: PointPtr Curve2 -> IO Bool # c_blst_to_affine :: AffinePtr Curve2 -> PointPtr Curve2 -> IO () # c_blst_from_affine :: PointPtr Curve2 -> AffinePtr Curve2 -> IO () # c_blst_affine_in_g :: AffinePtr Curve2 -> IO Bool # c_blst_generator :: PointPtr Curve2 # c_blst_p_is_equal :: PointPtr Curve2 -> PointPtr Curve2 -> IO Bool # c_blst_p_is_inf :: PointPtr Curve2 -> IO Bool # sizePoint_ :: Proxy Curve2 -> CSize serializedSizePoint_ :: Proxy Curve2 -> CSize compressedSizePoint_ :: Proxy Curve2 -> CSize sizeAffine_ :: Proxy Curve2 -> CSize

Point / Group operations

These work on both curves, and take phantom parameters of type Curve1 or Curve2 to select one of the two provided elliptic curves.

blsInGroup :: BLS curve => Point curve -> Bool #

Check whether a point is in the group corresponding to its elliptic curve

blsAddOrDouble :: BLS curve => Point curve -> Point curve -> Point curve #

Curve point addition.

blsMult :: BLS curve => Point curve -> Integer -> Point curve #

Scalar multiplication of a curve point. The scalar will be brought into the range of modular arithmetic by means of a modulo operation over the scalarPeriod. Negative number will also be brought to the range [0, scalarPeriod - 1] via modular reduction.

blsCneg :: BLS curve => Point curve -> Bool -> Point curve #

Conditional curve point negation. blsCneg x cond = if cond then neg x else x

blsNeg :: BLS curve => Point curve -> Point curve #

Unconditional curve point negation

blsCompress :: forall curve. BLS curve => Point curve -> ByteString #

blsSerialize :: forall curve. BLS curve => Point curve -> ByteString #

blsUncompress :: forall curve. BLS curve => ByteString -> Either BLSTError (Point curve) #

blsDeserialize :: forall curve. BLS curve => ByteString -> Either BLSTError (Point curve) #

blsHash :: BLS curve => ByteString -> Maybe ByteString -> Maybe ByteString -> Point curve #

blsHash msg mDST mAug generates the elliptic curve blsHash for the given message msg; mDST and mAug are the optional aug and dst arguments.

blsGenerator :: BLS curve => Point curve #

blsIsInf :: BLS curve => Point curve -> Bool #

Infinity check on curve points.

PT operations

ptMult :: PT -> PT -> PT #

ptFinalVerify :: PT -> PT -> Bool #

Pairings

millerLoop :: Point1 -> Point2 -> PT #

The period (modulo) of scalars

scalarPeriod :: Integer #

The period of scalar modulo operations.