| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Cardano.Crypto.EllipticCurve.BLS12_381.Internal
Synopsis
- newtype ScalarPtr = ScalarPtr (Ptr Word8)
- newtype PointPtr curve = PointPtr (Ptr Word8)
- newtype AffinePtr curve = AffinePtr (Ptr Word8)
- newtype PointArrayPtr curve = PointArrayPtr (Ptr Void)
- newtype AffineArrayPtr curve = AffineArrayPtr (Ptr Void)
- newtype AffineBlockPtr curve = AffineBlockPtr (Ptr Void)
- type Point1Ptr = PointPtr Curve1
- type Point2Ptr = PointPtr Curve2
- type Affine1Ptr = AffinePtr Curve1
- type Affine2Ptr = AffinePtr Curve2
- data PTPtr
- data Curve1
- data Curve2
- type family DualCurve curve = dual | dual → curve where ...
- c_blst_success ∷ CInt
- c_blst_error_bad_encoding ∷ CInt
- c_blst_error_point_not_on_curve ∷ CInt
- c_blst_error_point_not_in_group ∷ CInt
- c_blst_error_aggr_type_mismatch ∷ CInt
- c_blst_error_verify_fail ∷ CInt
- c_blst_error_pk_is_infinity ∷ CInt
- c_blst_error_bad_scalar ∷ CInt
- data Affine curve
- type Affine1 = Affine Curve1
- type Affine2 = Affine Curve2
- type family AffineSize curve where ...
- data BLSTError
- newtype Point curve = Point (PinnedSizedBytes (PointSize curve))
- type Point1 = Point Curve1
- type Point2 = Point Curve2
- type family PointSize curve where ...
- type family CompressedPointSize (curve ∷ Type) ∷ Nat where ...
- data PT
- newtype Scalar = Scalar (PinnedSizedBytes 32)
- newtype Fr = Fr (PinnedSizedBytes 32)
- unsafePointFromPointPtr ∷ ∀ curve. BLS curve ⇒ PointPtr curve → Point curve
- scalarPeriod ∷ Integer
- class (KnownNat (PointSize curve), KnownNat (AffineSize curve), KnownNat (CompressedPointSize curve), KnownNat (SerializedPointSize curve)) ⇒ BLS curve where
- c_blst_on_curve ∷ PointPtr curve → IO Bool
- c_blst_add_or_double ∷ PointPtr curve → PointPtr curve → PointPtr curve → IO ()
- c_blst_mult ∷ PointPtr curve → PointPtr curve → ScalarPtr → CSize → IO ()
- c_blst_cneg ∷ PointPtr curve → Bool → IO ()
- c_blst_scratch_sizeof ∷ Proxy curve → CSize → CSize
- c_blst_to_affines ∷ AffineBlockPtr curve → PointArrayPtr curve → CSize → IO ()
- c_blst_mult_pippenger ∷ PointPtr curve → AffineArrayPtr curve → CSize → ScalarArrayPtr → CSize → ScratchPtr → IO ()
- c_blst_hash ∷ PointPtr curve → Ptr CChar → CSize → Ptr CChar → CSize → Ptr CChar → CSize → IO ()
- c_blst_compress ∷ Ptr CChar → PointPtr curve → IO ()
- c_blst_serialize ∷ Ptr CChar → PointPtr curve → IO ()
- c_blst_uncompress ∷ AffinePtr curve → Ptr CChar → IO CInt
- c_blst_deserialize ∷ AffinePtr curve → Ptr CChar → IO CInt
- c_blst_in_g ∷ PointPtr curve → IO Bool
- c_blst_to_affine ∷ AffinePtr curve → PointPtr curve → IO ()
- c_blst_from_affine ∷ PointPtr curve → AffinePtr curve → IO ()
- c_blst_affine_in_g ∷ AffinePtr curve → IO Bool
- c_blst_generator ∷ PointPtr curve
- c_blst_p_is_equal ∷ PointPtr curve → PointPtr curve → IO Bool
- c_blst_p_is_inf ∷ PointPtr curve → IO Bool
- c_blst_sk_to_pk ∷ PointPtr curve → ScalarPtr → IO ()
- c_blst_sign ∷ PointPtr (DualCurve curve) → PointPtr (DualCurve curve) → ScalarPtr → IO ()
- c_blst_core_verify ∷ AffinePtr curve → AffinePtr (DualCurve curve) → Bool → Ptr CChar → CSize → Ptr CChar → CSize → Ptr CChar → CSize → IO CInt
- c_blst_miller_loop ∷ PTPtr → Affine2Ptr → Affine1Ptr → IO ()
- c_blst_fp12_mul ∷ PTPtr → PTPtr → PTPtr → IO ()
- c_blst_fp12_is_equal ∷ PTPtr → PTPtr → IO CBool
- c_blst_fp12_finalverify ∷ PTPtr → PTPtr → IO CBool
- c_blst_scalar_fr_check ∷ ScalarPtr → IO CBool
- c_blst_scalar_from_fr ∷ ScalarPtr → FrPtr → IO ()
- c_blst_fr_from_scalar ∷ FrPtr → ScalarPtr → IO ()
- c_blst_scalar_from_be_bytes ∷ ScalarPtr → Ptr CChar → CSize → IO CBool
- c_blst_bendian_from_scalar ∷ Ptr CChar → ScalarPtr → IO ()
- c_blst_keygen ∷ ScalarPtr → Ptr CChar → CSize → Ptr CChar → CSize → IO ()
- sizePoint ∷ ∀ curve. BLS curve ⇒ Proxy curve → Int
- withPoint ∷ ∀ a curve. Point curve → (PointPtr curve → IO a) → IO a
- withNewPoint ∷ ∀ curve a. BLS curve ⇒ (PointPtr curve → IO a) → IO (a, Point curve)
- withNewPoint_ ∷ BLS curve ⇒ (PointPtr curve → IO a) → IO a
- withNewPoint' ∷ BLS curve ⇒ (PointPtr curve → IO a) → IO (Point curve)
- clonePoint ∷ ∀ curve. BLS curve ⇒ Point curve → IO (Point curve)
- compressedSizePoint ∷ ∀ curve. BLS curve ⇒ Proxy curve → Int
- serializedSizePoint ∷ ∀ curve. BLS curve ⇒ Proxy curve → Int
- sizeAffine ∷ ∀ curve. BLS curve ⇒ Proxy curve → Int
- withAffine ∷ ∀ a curve. Affine curve → (AffinePtr curve → IO a) → IO a
- withNewAffine ∷ ∀ curve a. BLS curve ⇒ (AffinePtr curve → IO a) → IO (a, Affine curve)
- withNewAffine_ ∷ BLS curve ⇒ (AffinePtr curve → IO a) → IO a
- withNewAffine' ∷ BLS curve ⇒ (AffinePtr curve → IO a) → IO (Affine curve)
- withPointArray ∷ [Point curve] → (Int → PointArrayPtr curve → IO a) → IO a
- sizePT ∷ Int
- withPT ∷ PT → (PTPtr → IO a) → IO a
- withNewPT ∷ (PTPtr → IO a) → IO (a, PT)
- withNewPT_ ∷ (PTPtr → IO a) → IO a
- withNewPT' ∷ (PTPtr → IO a) → IO PT
- sizeScalar ∷ Int
- withScalar ∷ Scalar → (ScalarPtr → IO a) → IO a
- withNewScalar ∷ (ScalarPtr → IO a) → IO (a, Scalar)
- withNewScalar_ ∷ (ScalarPtr → IO a) → IO a
- withNewScalar' ∷ (ScalarPtr → IO a) → IO Scalar
- withScalarArray ∷ [Scalar] → (Int → ScalarArrayPtr → IO a) → IO a
- cloneScalar ∷ Scalar → IO Scalar
- sizeFr ∷ Int
- withFr ∷ Fr → (FrPtr → IO a) → IO a
- withNewFr ∷ (FrPtr → IO a) → IO (a, Fr)
- withNewFr_ ∷ (FrPtr → IO a) → IO a
- withNewFr' ∷ (FrPtr → IO a) → IO Fr
- cloneFr ∷ Fr → IO Fr
- withMaybeCStringLen ∷ Maybe ByteString → (CStringLen → IO a) → IO a
- integerAsCStrL ∷ Int → Integer → (Ptr CChar → Int → IO a) → IO a
- cstrToInteger ∷ Ptr CChar → Int → IO Integer
- integerToBS ∷ Integer → ByteString
- padBS ∷ Int → ByteString → ByteString
- mkBLSTError ∷ CInt → BLSTError
- 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
- blsMSM ∷ ∀ curve. BLS curve ⇒ [(Integer, Point curve)] → Point curve
- blsCompress ∷ ∀ curve. BLS curve ⇒ Point curve → ByteString
- blsSerialize ∷ ∀ curve. BLS curve ⇒ Point curve → ByteString
- blsUncompress ∷ ∀ curve. BLS curve ⇒ ByteString → Either BLSTError (Point curve)
- blsDeserialize ∷ ∀ 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
- blsZero ∷ ∀ curve. BLS curve ⇒ Point curve
- toAffine ∷ BLS curve ⇒ Point curve → Affine curve
- fromAffine ∷ BLS curve ⇒ Affine curve → Point curve
- affineInG ∷ BLS curve ⇒ Affine curve → Bool
- ptMult ∷ PT → PT → PT
- ptFinalVerify ∷ PT → PT → Bool
- scalarFromFr ∷ Fr → IO Scalar
- frFromScalar ∷ Scalar → IO Fr
- frFromCanonicalScalar ∷ Scalar → IO (Maybe Fr)
- scalarFromBS ∷ ByteString → Either BLSTError Scalar
- scalarToBS ∷ Scalar → ByteString
- scalarFromInteger ∷ Integer → IO Scalar
- scalarToInteger ∷ Scalar → IO Integer
- scalarCanonical ∷ Scalar → Bool
- millerLoop ∷ Point1 → Point2 → PT
- finalVerifyPairs ∷ ∀ curve. BLS curve ⇒ PairingSide curve → PairingSide curve → Bool
Unsafe Types
newtype PointArrayPtr curve Source #
A pointer to an array of pointers to points
Constructors
| PointArrayPtr (Ptr Void) |
newtype AffineArrayPtr curve Source #
A pointer to an array of pointers to affine points
Constructors
| AffineArrayPtr (Ptr Void) |
newtype AffineBlockPtr curve Source #
A pointer to a contiguous array of affine points
Constructors
| AffineBlockPtr (Ptr Void) |
type Affine1Ptr = AffinePtr Curve1 Source #
type Affine2Ptr = AffinePtr Curve2 Source #
Phantom Types
Instances
Instances
type family DualCurve curve = dual | dual → curve where ... Source #
A type family mapping a curve to its dual curve (its an involution).
Error codes
Safe types
type family AffineSize curve where ... Source #
Type family to get the size of an affine point on a given curve
Equations
| AffineSize Curve1 = 96 | |
| AffineSize Curve2 = 192 |
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
| Bounded BLSTError Source # | |
| Enum BLSTError Source # | |
| Show BLSTError Source # | |
| Eq BLSTError Source # | |
| Ord BLSTError Source # | |
A point on an elliptic curve. This type guarantees that the point is part of the | prime order subgroup.
Constructors
| Point (PinnedSizedBytes (PointSize curve)) |
type family PointSize curve where ... Source #
Type family to get the size of a point on a given curve
type family CompressedPointSize (curve ∷ Type) ∷ Nat where ... Source #
Type family to get the size of a compressed point on a given curve
Equations
| CompressedPointSize Curve1 = 48 | |
| CompressedPointSize Curve2 = 96 |
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)
Constructors
| Scalar (PinnedSizedBytes 32) |
Constructors
| Fr (PinnedSizedBytes 32) |
The period of scalars
scalarPeriod ∷ Integer Source #
The period of scalar modulo operations.
Curve abstraction
class (KnownNat (PointSize curve), KnownNat (AffineSize curve), KnownNat (CompressedPointSize curve), KnownNat (SerializedPointSize curve)) ⇒ BLS curve where Source #
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_scratch_sizeof, c_blst_to_affines, c_blst_mult_pippenger, 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, c_blst_sk_to_pk, c_blst_sign, c_blst_core_verify, millerSide
Methods
c_blst_on_curve ∷ PointPtr curve → IO Bool Source #
c_blst_add_or_double ∷ PointPtr curve → PointPtr curve → PointPtr curve → IO () Source #
c_blst_mult ∷ PointPtr curve → PointPtr curve → ScalarPtr → CSize → IO () Source #
c_blst_cneg ∷ PointPtr curve → Bool → IO () Source #
c_blst_scratch_sizeof ∷ Proxy curve → CSize → CSize Source #
c_blst_to_affines ∷ AffineBlockPtr curve → PointArrayPtr curve → CSize → IO () Source #
c_blst_mult_pippenger ∷ PointPtr curve → AffineArrayPtr curve → CSize → ScalarArrayPtr → CSize → ScratchPtr → IO () Source #
c_blst_hash ∷ PointPtr curve → Ptr CChar → CSize → Ptr CChar → CSize → Ptr CChar → CSize → IO () Source #
c_blst_compress ∷ Ptr CChar → PointPtr curve → IO () Source #
c_blst_serialize ∷ Ptr CChar → PointPtr curve → IO () Source #
c_blst_uncompress ∷ AffinePtr curve → Ptr CChar → IO CInt Source #
c_blst_deserialize ∷ AffinePtr curve → Ptr CChar → IO CInt Source #
c_blst_in_g ∷ PointPtr curve → IO Bool Source #
c_blst_to_affine ∷ AffinePtr curve → PointPtr curve → IO () Source #
c_blst_from_affine ∷ PointPtr curve → AffinePtr curve → IO () Source #
c_blst_affine_in_g ∷ AffinePtr curve → IO Bool Source #
c_blst_generator ∷ PointPtr curve Source #
c_blst_p_is_equal ∷ PointPtr curve → PointPtr curve → IO Bool Source #
c_blst_p_is_inf ∷ PointPtr curve → IO Bool Source #
c_blst_sk_to_pk ∷ PointPtr curve → ScalarPtr → IO () Source #
c_blst_sign ∷ PointPtr (DualCurve curve) → PointPtr (DualCurve curve) → ScalarPtr → IO () Source #
c_blst_core_verify ∷ AffinePtr curve → AffinePtr (DualCurve curve) → Bool → Ptr CChar → CSize → Ptr CChar → CSize → Ptr CChar → CSize → IO CInt Source #
Core signature verification function. This function is used with the following signature:
c_blst_core_verify @curve pk sig True msg msgLen dst dstLen aug augLen
where the True indicates we are using the `Hash to Curve` method.
Instances
Pairing check
c_blst_miller_loop ∷ PTPtr → Affine2Ptr → Affine1Ptr → IO () Source #
FP12 functions
Scalar functions
c_blst_scalar_from_fr ∷ ScalarPtr → FrPtr → IO () Source #
c_blst_fr_from_scalar ∷ FrPtr → ScalarPtr → IO () Source #
Marshalling functions
sizePoint ∷ ∀ curve. BLS curve ⇒ Proxy curve → Int Source #
Sizes of various representations of elliptic curve points. | Size of a curve point in memory
compressedSizePoint ∷ ∀ curve. BLS curve ⇒ Proxy curve → Int Source #
Size of a curved point when serialized in compressed form
serializedSizePoint ∷ ∀ curve. BLS curve ⇒ Proxy curve → Int Source #
Size of a curved point when serialized in uncompressed form
sizeAffine ∷ ∀ curve. BLS curve ⇒ Proxy curve → Int Source #
In-memory size of the affine representation of a curve point
withPointArray ∷ [Point curve] → (Int → PointArrayPtr curve → IO a) → IO a Source #
sizeScalar ∷ Int Source #
withNewFr_ ∷ (FrPtr → IO a) → IO a Source #
Utility
withMaybeCStringLen ∷ Maybe ByteString → (CStringLen → IO a) → IO a Source #
padBS ∷ Int → ByteString → ByteString Source #
mkBLSTError ∷ CInt → BLSTError Source #
Point1/G1 operations
blsInGroup ∷ BLS curve ⇒ Point curve → Bool Source #
Check whether a point is in the group corresponding to its elliptic curve
blsMult ∷ BLS curve ⇒ Point curve → Integer → Point curve Source #
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 Source #
Conditional curve point negation.
blsCneg x cond = if cond then neg x else x
blsMSM ∷ ∀ curve. BLS curve ⇒ [(Integer, Point curve)] → Point curve Source #
Multi-scalar multiplication using the Pippenger algorithm.
The scalars will be brought into the range of modular arithmetic
by means of a modulo operation over the scalarPeriod.
Negative numbers will also be brought to the range
[0, scalarPeriod - 1] via modular reduction.
blsCompress ∷ ∀ curve. BLS curve ⇒ Point curve → ByteString Source #
blsSerialize ∷ ∀ curve. BLS curve ⇒ Point curve → ByteString Source #
blsUncompress ∷ ∀ curve. BLS curve ⇒ ByteString → Either BLSTError (Point curve) Source #
blsDeserialize ∷ ∀ curve. BLS curve ⇒ ByteString → Either BLSTError (Point curve) Source #
blsHash ∷ BLS curve ⇒ ByteString → Maybe ByteString → Maybe ByteString → Point curve Source #
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 Source #
PT operations
Scalar / Fr operations
scalarCanonical ∷ Scalar → Bool Source #
Pairings
finalVerifyPairs ∷ ∀ curve. BLS curve ⇒ PairingSide curve → PairingSide curve → Bool Source #