@noble/curves 0.5.1 → 0.6.0

package/lib/esm/abstract/bls.js

@@ -1,24 +1,16 @@
-/*! noble-curves - MIT License (c) 2022 Paul Miller (paulmillr.com) */
-// Barreto-Lynn-Scott Curves. A family of pairing friendly curves, with embedding degree = 12 or 24
-// NOTE: only 12 supported for now
-// Constructed from pair of weierstrass curves, based pairing logic
-import * as mod from './modular.js';
-import { ensureBytes, numberToBytesBE, bytesToNumberBE, bitLen, bitGet } from './utils.js';
-// Types
-import { hexToBytes, bytesToHex } from './utils.js';
-import { stringToBytes, hash_to_field, expand_message_xmd } from './hash-to-curve.js';
-import { weierstrassPoints } from './weierstrass.js';
+import { hashToPrivateScalar } from './modular.js';
+import { bitLen, bitGet, hexToBytes, bytesToHex } from './utils.js';
+import * as htf from './hash-to-curve.js';
+import { weierstrassPoints, } from './weierstrass.js';
 export function bls(CURVE) {
     // Fields looks pretty specific for curve, so for now we need to pass them with options
-    const Fp = CURVE.Fp;
-    const Fr = CURVE.Fr;
-    const Fp2 = CURVE.Fp2;
-    const Fp6 = CURVE.Fp6;
-    const Fp12 = CURVE.Fp12;
+    const { Fp, Fr, Fp2, Fp6, Fp12 } = CURVE;
     const BLS_X_LEN = bitLen(CURVE.x);
+    const groupLen = 32; // TODO: calculate; hardcoded for now
     // Pre-compute coefficients for sparse multiplication
     // Point addition and point double calculations is reused for coefficients
-    function calcPairingPrecomputes(x, y) {
+    function calcPairingPrecomputes(p) {
+        const { x, y } = p;
         // prettier-ignore
         const Qx = x, Qy = y, Qz = Fp2.ONE;
         // prettier-ignore
@@ -26,18 +18,18 @@ export function bls(CURVE) {
         let ell_coeff = [];
         for (let i = BLS_X_LEN - 2; i >= 0; i--) {
             // Double
-            let t0 = Fp2.square(Ry); // Ry²
-            let t1 = Fp2.square(Rz); // Rz²
+            let t0 = Fp2.sqr(Ry); // Ry²
+            let t1 = Fp2.sqr(Rz); // Rz²
             let t2 = Fp2.multiplyByB(Fp2.mul(t1, 3n)); // 3 * T1 * B
             let t3 = Fp2.mul(t2, 3n); // 3 * T2
-            let t4 = Fp2.sub(Fp2.sub(Fp2.square(Fp2.add(Ry, Rz)), t1), t0); // (Ry + Rz)² - T1 - T0
+            let t4 = Fp2.sub(Fp2.sub(Fp2.sqr(Fp2.add(Ry, Rz)), t1), t0); // (Ry + Rz)² - T1 - T0
             ell_coeff.push([
                 Fp2.sub(t2, t0),
-                Fp2.mul(Fp2.square(Rx), 3n),
-                Fp2.negate(t4), // -T4
+                Fp2.mul(Fp2.sqr(Rx), 3n),
+                Fp2.neg(t4), // -T4
             ]);
             Rx = Fp2.div(Fp2.mul(Fp2.mul(Fp2.sub(t0, t3), Rx), Ry), 2n); // ((T0 - T3) * Rx * Ry) / 2
-            Ry = Fp2.sub(Fp2.square(Fp2.div(Fp2.add(t0, t3), 2n)), Fp2.mul(Fp2.square(t2), 3n)); // ((T0 + T3) / 2)² - 3 * T2²
+            Ry = Fp2.sub(Fp2.sqr(Fp2.div(Fp2.add(t0, t3), 2n)), Fp2.mul(Fp2.sqr(t2), 3n)); // ((T0 + T3) / 2)² - 3 * T2²
             Rz = Fp2.mul(t0, t4); // T0 * T4
             if (bitGet(CURVE.x, i)) {
                 // Addition
@@ -45,13 +37,13 @@ export function bls(CURVE) {
                 let t1 = Fp2.sub(Rx, Fp2.mul(Qx, Rz)); // Rx - Qx * Rz
                 ell_coeff.push([
                     Fp2.sub(Fp2.mul(t0, Qx), Fp2.mul(t1, Qy)),
-                    Fp2.negate(t0),
+                    Fp2.neg(t0),
                     t1, // T1
                 ]);
-                let t2 = Fp2.square(t1); // T1²
+                let t2 = Fp2.sqr(t1); // T1²
                 let t3 = Fp2.mul(t2, t1); // T2 * T1
                 let t4 = Fp2.mul(t2, Rx); // T2 * Rx
-                let t5 = Fp2.add(Fp2.sub(t3, Fp2.mul(t4, 2n)), Fp2.mul(Fp2.square(t0), Rz)); // T3 - 2 * T4 + T0² * Rz
+                let t5 = Fp2.add(Fp2.sub(t3, Fp2.mul(t4, 2n)), Fp2.mul(Fp2.sqr(t0), Rz)); // T3 - 2 * T4 + T0² * Rz
                 Rx = Fp2.mul(t1, t5); // T1 * T5
                 Ry = Fp2.sub(Fp2.mul(Fp2.sub(t4, t5), t0), Fp2.mul(t3, Ry)); // (T4 - T5) * T0 - T3 * Ry
                 Rz = Fp2.mul(Rz, t3); // Rz * T3
@@ -60,175 +52,121 @@ export function bls(CURVE) {
         return ell_coeff;
     }
     function millerLoop(ell, g1) {
+        const { x } = CURVE;
         const Px = g1[0];
         const Py = g1[1];
         let f12 = Fp12.ONE;
         for (let j = 0, i = BLS_X_LEN - 2; i >= 0; i--, j++) {
             const E = ell[j];
             f12 = Fp12.multiplyBy014(f12, E[0], Fp2.mul(E[1], Px), Fp2.mul(E[2], Py));
-            if (bitGet(CURVE.x, i)) {
+            if (bitGet(x, i)) {
                 j += 1;
                 const F = ell[j];
                 f12 = Fp12.multiplyBy014(f12, F[0], Fp2.mul(F[1], Px), Fp2.mul(F[2], Py));
             }
             if (i !== 0)
-                f12 = Fp12.square(f12);
+                f12 = Fp12.sqr(f12);
         }
         return Fp12.conjugate(f12);
     }
-    // bls12-381 is a construction of two curves:
-    // 1. Fp: (x, y)
-    // 2. Fp₂: ((x₁, x₂+i), (y₁, y₂+i)) - (complex numbers)
-    //
-    // Bilinear Pairing (ate pairing) is used to combine both elements into a paired one:
-    //   Fp₁₂ = e(Fp, Fp2)
-    //   where Fp₁₂ = 12-degree polynomial
-    // Pairing is used to verify signatures.
-    //
-    // We are using Fp for private keys (shorter) and Fp2 for signatures (longer).
-    // Some projects may prefer to swap this relation, it is not supported for now.
-    const htfDefaults = { ...CURVE.htfDefaults };
-    function isWithinCurveOrder(num) {
-        return 0 < num && num < CURVE.r;
-    }
     const utils = {
         hexToBytes: hexToBytes,
         bytesToHex: bytesToHex,
-        mod: mod.mod,
-        stringToBytes,
+        stringToBytes: htf.stringToBytes,
         // TODO: do we need to export it here?
-        hashToField: (msg, count, options = {}) => hash_to_field(msg, count, { ...CURVE.htfDefaults, ...options }),
-        expandMessageXMD: (msg, DST, lenInBytes, H = CURVE.hash) => expand_message_xmd(msg, DST, lenInBytes, H),
-        /**
-         * Can take 40 or more bytes of uniform input e.g. from CSPRNG or KDF
-         * and convert them into private key, with the modulo bias being negligible.
-         * As per FIPS 186 B.1.1.
-         * https://research.kudelskisecurity.com/2020/07/28/the-definitive-guide-to-modulo-bias-and-how-to-avoid-it/
-         * @param hash hash output from sha512, or a similar function
-         * @returns valid private key
-         */
-        hashToPrivateKey: (hash) => {
-            hash = ensureBytes(hash);
-            if (hash.length < 40 || hash.length > 1024)
-                throw new Error('Expected 40-1024 bytes of private key as per FIPS 186');
-            //     hashToPrivateScalar(hash, CURVE.r)
-            // NOTE: doesn't add +/-1
-            const num = mod.mod(bytesToNumberBE(hash), CURVE.r);
-            // This should never happen
-            if (num === 0n || num === 1n)
-                throw new Error('Invalid private key');
-            return numberToBytesBE(num, 32);
-        },
-        randomBytes: (bytesLength = 32) => CURVE.randomBytes(bytesLength),
-        // NIST SP 800-56A rev 3, section 5.6.1.2.2
-        // https://research.kudelskisecurity.com/2020/07/28/the-definitive-guide-to-modulo-bias-and-how-to-avoid-it/
-        randomPrivateKey: () => utils.hashToPrivateKey(utils.randomBytes(40)),
-        getDSTLabel: () => htfDefaults.DST,
-        setDSTLabel(newLabel) {
-            // https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-hash-to-curve-11#section-3.1
-            if (typeof newLabel !== 'string' || newLabel.length > 2048 || newLabel.length === 0) {
-                throw new TypeError('Invalid DST');
-            }
-            htfDefaults.DST = newLabel;
-        },
+        hashToField: (msg, count, options = {}) => htf.hash_to_field(msg, count, { ...CURVE.htfDefaults, ...options }),
+        expandMessageXMD: (msg, DST, lenInBytes, H = CURVE.hash) => htf.expand_message_xmd(msg, DST, lenInBytes, H),
+        hashToPrivateKey: (hash) => Fr.toBytes(hashToPrivateScalar(hash, CURVE.r)),
+        randomBytes: (bytesLength = groupLen) => CURVE.randomBytes(bytesLength),
+        randomPrivateKey: () => utils.hashToPrivateKey(utils.randomBytes(groupLen + 8)),
     };
-    function normalizePrivKey(key) {
-        let int;
-        if (key instanceof Uint8Array && key.length === 32)
-            int = bytesToNumberBE(key);
-        else if (typeof key === 'string' && key.length === 64)
-            int = BigInt(`0x${key}`);
-        else if (typeof key === 'number' && key > 0 && Number.isSafeInteger(key))
-            int = BigInt(key);
-        else if (typeof key === 'bigint' && key > 0n)
-            int = key;
-        else
-            throw new TypeError('Expected valid private key');
-        int = mod.mod(int, CURVE.r);
-        if (!isWithinCurveOrder(int))
-            throw new Error('Private key must be 0 < key < CURVE.r');
-        return int;
-    }
     // Point on G1 curve: (x, y)
     const G1 = weierstrassPoints({
         n: Fr.ORDER,
         ...CURVE.G1,
     });
+    const G1HashToCurve = htf.hashToCurve(G1.ProjectivePoint, CURVE.G1.mapToCurve, {
+        ...CURVE.htfDefaults,
+        ...CURVE.G1.htfDefaults,
+    });
     function pairingPrecomputes(point) {
         const p = point;
         if (p._PPRECOMPUTES)
             return p._PPRECOMPUTES;
-        p._PPRECOMPUTES = calcPairingPrecomputes(p.x, p.y);
+        p._PPRECOMPUTES = calcPairingPrecomputes(point.toAffine());
         return p._PPRECOMPUTES;
     }
-    function clearPairingPrecomputes(point) {
-        const p = point;
-        p._PPRECOMPUTES = undefined;
-    }
-    clearPairingPrecomputes;
-    function millerLoopG1(Q, P) {
-        return millerLoop(pairingPrecomputes(P), [Q.x, Q.y]);
-    }
+    // TODO: export
+    // function clearPairingPrecomputes(point: G2) {
+    //   const p = point as G2 & withPairingPrecomputes;
+    //   p._PPRECOMPUTES = undefined;
+    // }
     // Point on G2 curve (complex numbers): (x₁, x₂+i), (y₁, y₂+i)
     const G2 = weierstrassPoints({
         n: Fr.ORDER,
         ...CURVE.G2,
     });
+    const C = G2.ProjectivePoint; // TODO: fix
+    const G2HashToCurve = htf.hashToCurve(C, CURVE.G2.mapToCurve, {
+        ...CURVE.htfDefaults,
+        ...CURVE.G2.htfDefaults,
+    });
     const { Signature } = CURVE.G2;
     // Calculates bilinear pairing
-    function pairing(P, Q, withFinalExponent = true) {
-        if (P.equals(G1.Point.ZERO) || Q.equals(G2.Point.ZERO))
-            throw new Error('No pairings at point of Infinity');
-        P.assertValidity();
+    function pairing(Q, P, withFinalExponent = true) {
+        if (Q.equals(G1.ProjectivePoint.ZERO) || P.equals(G2.ProjectivePoint.ZERO))
+            throw new Error('pairing is not available for ZERO point');
         Q.assertValidity();
+        P.assertValidity();
         // Performance: 9ms for millerLoop and ~14ms for exp.
-        const looped = millerLoopG1(P, Q);
+        const Qa = Q.toAffine();
+        const looped = millerLoop(pairingPrecomputes(P), [Qa.x, Qa.y]);
         return withFinalExponent ? Fp12.finalExponentiate(looped) : looped;
     }
     function normP1(point) {
-        return point instanceof G1.Point ? point : G1.Point.fromHex(point);
+        return point instanceof G1.ProjectivePoint ? point : G1.ProjectivePoint.fromHex(point);
     }
     function normP2(point) {
-        return point instanceof G2.Point ? point : Signature.decode(point);
+        return point instanceof G2.ProjectivePoint ? point : Signature.decode(point);
     }
-    function normP2Hash(point) {
-        return point instanceof G2.Point ? point : G2.Point.hashToCurve(point);
+    function normP2Hash(point, htfOpts) {
+        return point instanceof G2.ProjectivePoint
+            ? point
+            : G2HashToCurve.hashToCurve(point, htfOpts);
     }
     // Multiplies generator by private key.
     // P = pk x G
     function getPublicKey(privateKey) {
-        return G1.Point.fromPrivateKey(privateKey).toRawBytes(true);
+        return G1.ProjectivePoint.fromPrivateKey(privateKey).toRawBytes(true);
     }
-    function sign(message, privateKey) {
-        const msgPoint = normP2Hash(message);
+    function sign(message, privateKey, htfOpts) {
+        const msgPoint = normP2Hash(message, htfOpts);
         msgPoint.assertValidity();
-        const sigPoint = msgPoint.multiply(normalizePrivKey(privateKey));
-        if (message instanceof G2.Point)
+        const sigPoint = msgPoint.multiply(G1.normalizePrivateKey(privateKey));
+        if (message instanceof G2.ProjectivePoint)
             return sigPoint;
         return Signature.encode(sigPoint);
     }
     // Checks if pairing of public key & hash is equal to pairing of generator & signature.
     // e(P, H(m)) == e(G, S)
-    function verify(signature, message, publicKey) {
+    function verify(signature, message, publicKey, htfOpts) {
         const P = normP1(publicKey);
-        const Hm = normP2Hash(message);
-        const G = G1.Point.BASE;
+        const Hm = normP2Hash(message, htfOpts);
+        const G = G1.ProjectivePoint.BASE;
         const S = normP2(signature);
         // Instead of doing 2 exponentiations, we use property of billinear maps
         // and do one exp after multiplying 2 points.
         const ePHm = pairing(P.negate(), Hm, false);
         const eGS = pairing(G, S, false);
         const exp = Fp12.finalExponentiate(Fp12.mul(eGS, ePHm));
-        return Fp12.equals(exp, Fp12.ONE);
+        return Fp12.eql(exp, Fp12.ONE);
     }
     function aggregatePublicKeys(publicKeys) {
         if (!publicKeys.length)
             throw new Error('Expected non-empty array');
-        const agg = publicKeys
-            .map(normP1)
-            .reduce((sum, p) => sum.add(G1.ProjectivePoint.fromAffine(p)), G1.ProjectivePoint.ZERO);
-        const aggAffine = agg.toAffine();
-        if (publicKeys[0] instanceof G1.Point) {
+        const agg = publicKeys.map(normP1).reduce((sum, p) => sum.add(p), G1.ProjectivePoint.ZERO);
+        const aggAffine = agg; //.toAffine();
+        if (publicKeys[0] instanceof G1.ProjectivePoint) {
             aggAffine.assertValidity();
             return aggAffine;
         }
@@ -238,11 +176,9 @@ export function bls(CURVE) {
     function aggregateSignatures(signatures) {
         if (!signatures.length)
             throw new Error('Expected non-empty array');
-        const agg = signatures
-            .map(normP2)
-            .reduce((sum, s) => sum.add(G2.ProjectivePoint.fromAffine(s)), G2.ProjectivePoint.ZERO);
-        const aggAffine = agg.toAffine();
-        if (signatures[0] instanceof G2.Point) {
+        const agg = signatures.map(normP2).reduce((sum, s) => sum.add(s), G2.ProjectivePoint.ZERO);
+        const aggAffine = agg; //.toAffine();
+        if (signatures[0] instanceof G2.ProjectivePoint) {
             aggAffine.assertValidity();
             return aggAffine;
         }
@@ -250,33 +186,34 @@ export function bls(CURVE) {
     }
     // https://ethresear.ch/t/fast-verification-of-multiple-bls-signatures/5407
     // e(G, S) = e(G, SUM(n)(Si)) = MUL(n)(e(G, Si))
-    function verifyBatch(signature, messages, publicKeys) {
+    function verifyBatch(signature, messages, publicKeys, htfOpts) {
+        // @ts-ignore
+        // console.log('verifyBatch', bytesToHex(signature as any), messages, publicKeys.map(bytesToHex));
         if (!messages.length)
             throw new Error('Expected non-empty messages array');
         if (publicKeys.length !== messages.length)
             throw new Error('Pubkey count should equal msg count');
         const sig = normP2(signature);
-        const nMessages = messages.map(normP2Hash);
+        const nMessages = messages.map((i) => normP2Hash(i, htfOpts));
         const nPublicKeys = publicKeys.map(normP1);
         try {
             const paired = [];
             for (const message of new Set(nMessages)) {
-                const groupPublicKey = nMessages.reduce((groupPublicKey, subMessage, i) => subMessage === message ? groupPublicKey.add(nPublicKeys[i]) : groupPublicKey, G1.Point.ZERO);
+                const groupPublicKey = nMessages.reduce((groupPublicKey, subMessage, i) => subMessage === message ? groupPublicKey.add(nPublicKeys[i]) : groupPublicKey, G1.ProjectivePoint.ZERO);
                 // const msg = message instanceof PointG2 ? message : await PointG2.hashToCurve(message);
                 // Possible to batch pairing for same msg with different groupPublicKey here
                 paired.push(pairing(groupPublicKey, message, false));
             }
-            paired.push(pairing(G1.Point.BASE.negate(), sig, false));
+            paired.push(pairing(G1.ProjectivePoint.BASE.negate(), sig, false));
             const product = paired.reduce((a, b) => Fp12.mul(a, b), Fp12.ONE);
             const exp = Fp12.finalExponentiate(product);
-            return Fp12.equals(exp, Fp12.ONE);
+            return Fp12.eql(exp, Fp12.ONE);
         }
         catch {
             return false;
         }
     }
-    // Pre-compute points. Refer to README.
-    G1.Point.BASE._setWindowSize(4);
+    G1.ProjectivePoint.BASE._setWindowSize(4);
     return {
         CURVE,
         Fr,
@@ -289,6 +226,7 @@ export function bls(CURVE) {
         Signature,
         millerLoop,
         calcPairingPrecomputes,
+        hashToCurve: { G1: G1HashToCurve, G2: G2HashToCurve },
         pairing,
         getPublicKey,
         sign,

package/lib/esm/abstract/{group.js → curve.js}

@@ -1,8 +1,10 @@
 /*! noble-curves - MIT License (c) 2022 Paul Miller (paulmillr.com) */
 // Abelian group utilities
+import { validateField, nLength } from './modular.js';
 const _0n = BigInt(0);
 const _1n = BigInt(1);
-// Not big, but pretty complex and it is easy to break stuff. To avoid too much copy paste
+// Elliptic curve multiplication of Point by scalar. Complicated and fragile. Uses wNAF method.
+// Windowed method is 10% faster, but takes 2x longer to generate & consumes 2x memory.
 export function wNAF(c, bits) {
     const constTimeNegate = (condition, item) => {
         const neg = item.negate();
@@ -104,5 +106,39 @@ export function wNAF(c, bits) {
             // which makes it less const-time: around 1 bigint multiply.
             return { p, f };
         },
+        wNAFCached(P, precomputesMap, n, transform) {
+            // @ts-ignore
+            const W = P._WINDOW_SIZE || 1;
+            // Calculate precomputes on a first run, reuse them after
+            let comp = precomputesMap.get(P);
+            if (!comp) {
+                comp = this.precomputeWindow(P, W);
+                if (W !== 1) {
+                    precomputesMap.set(P, transform(comp));
+                }
+            }
+            return this.wNAF(W, comp, n);
+        },
     };
 }
+export function validateAbsOpts(curve) {
+    validateField(curve.Fp);
+    for (const i of ['n', 'h']) {
+        const val = curve[i];
+        if (typeof val !== 'bigint')
+            throw new Error(`Invalid curve param ${i}=${val} (${typeof val})`);
+    }
+    if (!curve.Fp.isValid(curve.Gx))
+        throw new Error('Invalid generator X coordinate Fp element');
+    if (!curve.Fp.isValid(curve.Gy))
+        throw new Error('Invalid generator Y coordinate Fp element');
+    for (const i of ['nBitLength', 'nByteLength']) {
+        const val = curve[i];
+        if (val === undefined)
+            continue; // Optional
+        if (!Number.isSafeInteger(val))
+            throw new Error(`Invalid param ${i}=${val} (${typeof val})`);
+    }
+    // Set defaults
+    return Object.freeze({ ...nLength(curve.n, curve.nBitLength), ...curve });
+}