@noble/curves 0.1.0 → 0.2.0

package/lib/esm/edwards.js

@@ -0,0 +1,550 @@
+/*! noble-curves - MIT License (c) 2022 Paul Miller (paulmillr.com) */
+// Implementation of Twisted Edwards curve. The formula is: ax² + y² = 1 + dx²y²
+// Differences from @noble/ed25519 1.7:
+// 1. Different field element lengths in ed448:
+//   EDDSA (RFC8032) is 456 bits / 57 bytes, ECDH (RFC7748) is 448 bits / 56 bytes
+// 2. Different addition formula (doubling is same)
+// 3. uvRatio differs between curves (half-expected, not only pow fn changes)
+// 4. Point decompression code is different too (unexpected), now using generalized formula
+// 5. Domain function was no-op for ed25519, but adds some data even with empty context for ed448
+import * as mod from './modular.js';
+import { bytesToHex, concatBytes, ensureBytes, numberToBytesLE, bytesToNumberLE, hashToPrivateScalar, validateOpts as utilOpts, } from './utils.js'; // TODO: import * as u from './utils.js'?
+import { wNAF } from './group.js';
+// Be friendly to bad ECMAScript parsers by not using bigint literals like 123n
+const _0n = BigInt(0);
+const _1n = BigInt(1);
+const _2n = BigInt(2);
+const _8n = BigInt(8);
+// Should be separate from overrides, since overrides can use information about curve (for example nBits)
+function validateOpts(curve) {
+    const opts = utilOpts(curve);
+    if (typeof opts.hash !== 'function' || !Number.isSafeInteger(opts.hash.outputLen))
+        throw new Error('Invalid hash function');
+    for (const i of ['a', 'd']) {
+        if (typeof opts[i] !== 'bigint')
+            throw new Error(`Invalid curve param ${i}=${opts[i]} (${typeof opts[i]})`);
+    }
+    for (const fn of ['randomBytes']) {
+        if (typeof opts[fn] !== 'function')
+            throw new Error(`Invalid ${fn} function`);
+    }
+    for (const fn of ['adjustScalarBytes', 'domain', 'uvRatio']) {
+        if (opts[fn] === undefined)
+            continue; // Optional
+        if (typeof opts[fn] !== 'function')
+            throw new Error(`Invalid ${fn} function`);
+    }
+    // Set defaults
+    return Object.freeze({ ...opts });
+}
+// NOTE: it is not generic twisted curve for now, but ed25519/ed448 generic implementation
+export function twistedEdwards(curveDef) {
+    const CURVE = validateOpts(curveDef);
+    const CURVE_ORDER = CURVE.n;
+    const fieldLen = CURVE.nByteLength; // 32 (length of one field element)
+    if (fieldLen > 2048)
+        throw new Error('Field lengths over 2048 are not supported');
+    const groupLen = CURVE.nByteLength;
+    // (2n ** 256n).toString(16);
+    const maxGroupElement = _2n ** BigInt(groupLen * 8); // previous POW_2_256
+    // Function overrides
+    const { P, randomBytes } = CURVE;
+    const modP = (a) => mod.mod(a, P);
+    // sqrt(u/v)
+    function _uvRatio(u, v) {
+        try {
+            const value = mod.sqrt(u * mod.invert(v, P), P);
+            return { isValid: true, value };
+        }
+        catch (e) {
+            return { isValid: false, value: _0n };
+        }
+    }
+    const uvRatio = CURVE.uvRatio || _uvRatio;
+    const _adjustScalarBytes = (bytes) => bytes; // NOOP
+    const adjustScalarBytes = CURVE.adjustScalarBytes || _adjustScalarBytes;
+    function _domain(data, ctx, phflag) {
+        if (ctx.length || phflag)
+            throw new Error('Contexts/pre-hash are not supported');
+        return data;
+    }
+    const domain = CURVE.domain || _domain; // NOOP
+    /**
+     * Extended Point works in extended coordinates: (x, y, z, t) ∋ (x=x/z, y=y/z, t=xy).
+     * Default Point works in affine coordinates: (x, y)
+     * https://en.wikipedia.org/wiki/Twisted_Edwards_curve#Extended_coordinates
+     */
+    class ExtendedPoint {
+        constructor(x, y, z, t) {
+            this.x = x;
+            this.y = y;
+            this.z = z;
+            this.t = t;
+        }
+        static fromAffine(p) {
+            if (!(p instanceof Point)) {
+                throw new TypeError('ExtendedPoint#fromAffine: expected Point');
+            }
+            if (p.equals(Point.ZERO))
+                return ExtendedPoint.ZERO;
+            return new ExtendedPoint(p.x, p.y, _1n, modP(p.x * p.y));
+        }
+        // Takes a bunch of Jacobian Points but executes only one
+        // invert on all of them. invert is very slow operation,
+        // so this improves performance massively.
+        static toAffineBatch(points) {
+            const toInv = mod.invertBatch(points.map((p) => p.z), P);
+            return points.map((p, i) => p.toAffine(toInv[i]));
+        }
+        static normalizeZ(points) {
+            return this.toAffineBatch(points).map(this.fromAffine);
+        }
+        // Compare one point to another.
+        equals(other) {
+            assertExtPoint(other);
+            const { x: X1, y: Y1, z: Z1 } = this;
+            const { x: X2, y: Y2, z: Z2 } = other;
+            const X1Z2 = modP(X1 * Z2);
+            const X2Z1 = modP(X2 * Z1);
+            const Y1Z2 = modP(Y1 * Z2);
+            const Y2Z1 = modP(Y2 * Z1);
+            return X1Z2 === X2Z1 && Y1Z2 === Y2Z1;
+        }
+        // Inverses point to one corresponding to (x, -y) in Affine coordinates.
+        negate() {
+            return new ExtendedPoint(modP(-this.x), this.y, this.z, modP(-this.t));
+        }
+        // Fast algo for doubling Extended Point.
+        // https://hyperelliptic.org/EFD/g1p/auto-twisted-extended.html#doubling-dbl-2008-hwcd
+        // Cost: 4M + 4S + 1*a + 6add + 1*2.
+        double() {
+            const { a } = CURVE;
+            const { x: X1, y: Y1, z: Z1 } = this;
+            const A = modP(X1 * X1); // A = X12
+            const B = modP(Y1 * Y1); // B = Y12
+            const C = modP(_2n * modP(Z1 * Z1)); // C = 2*Z12
+            const D = modP(a * A); // D = a*A
+            const x1y1 = X1 + Y1;
+            const E = modP(modP(x1y1 * x1y1) - A - B); // E = (X1+Y1)2-A-B
+            const G = D + B; // G = D+B
+            const F = G - C; // F = G-C
+            const H = D - B; // H = D-B
+            const X3 = modP(E * F); // X3 = E*F
+            const Y3 = modP(G * H); // Y3 = G*H
+            const T3 = modP(E * H); // T3 = E*H
+            const Z3 = modP(F * G); // Z3 = F*G
+            return new ExtendedPoint(X3, Y3, Z3, T3);
+        }
+        // Fast algo for adding 2 Extended Points.
+        // https://hyperelliptic.org/EFD/g1p/auto-twisted-extended.html#addition-add-2008-hwcd
+        // Cost: 9M + 1*a + 1*d + 7add.
+        add(other) {
+            assertExtPoint(other);
+            const { a, d } = CURVE;
+            const { x: X1, y: Y1, z: Z1, t: T1 } = this;
+            const { x: X2, y: Y2, z: Z2, t: T2 } = other;
+            // Faster algo for adding 2 Extended Points when curve's a=-1.
+            // http://hyperelliptic.org/EFD/g1p/auto-twisted-extended-1.html#addition-add-2008-hwcd-4
+            // Cost: 8M + 8add + 2*2.
+            // Note: It does not check whether the `other` point is valid.
+            if (a === BigInt(-1)) {
+                const A = modP((Y1 - X1) * (Y2 + X2));
+                const B = modP((Y1 + X1) * (Y2 - X2));
+                const F = modP(B - A);
+                if (F === _0n)
+                    return this.double(); // Same point.
+                const C = modP(Z1 * _2n * T2);
+                const D = modP(T1 * _2n * Z2);
+                const E = D + C;
+                const G = B + A;
+                const H = D - C;
+                const X3 = modP(E * F);
+                const Y3 = modP(G * H);
+                const T3 = modP(E * H);
+                const Z3 = modP(F * G);
+                return new ExtendedPoint(X3, Y3, Z3, T3);
+            }
+            const A = modP(X1 * X2); // A = X1*X2
+            const B = modP(Y1 * Y2); // B = Y1*Y2
+            const C = modP(T1 * d * T2); // C = T1*d*T2
+            const D = modP(Z1 * Z2); // D = Z1*Z2
+            const E = modP((X1 + Y1) * (X2 + Y2) - A - B); // E = (X1+Y1)*(X2+Y2)-A-B
+            // TODO: do we need to check for same point here? Looks like working without it
+            const F = D - C; // F = D-C
+            const G = D + C; // G = D+C
+            const H = modP(B - a * A); // H = B-a*A
+            const X3 = modP(E * F); // X3 = E*F
+            const Y3 = modP(G * H); // Y3 = G*H
+            const T3 = modP(E * H); // T3 = E*H
+            const Z3 = modP(F * G); // Z3 = F*G
+            return new ExtendedPoint(X3, Y3, Z3, T3);
+        }
+        subtract(other) {
+            return this.add(other.negate());
+        }
+        wNAF(n, affinePoint) {
+            if (!affinePoint && this.equals(ExtendedPoint.BASE))
+                affinePoint = Point.BASE;
+            const W = (affinePoint && affinePoint._WINDOW_SIZE) || 1;
+            let precomputes = affinePoint && pointPrecomputes.get(affinePoint);
+            if (!precomputes) {
+                precomputes = wnaf.precomputeWindow(this, W);
+                if (affinePoint && W !== 1) {
+                    precomputes = ExtendedPoint.normalizeZ(precomputes);
+                    pointPrecomputes.set(affinePoint, precomputes);
+                }
+            }
+            const { p, f } = wnaf.wNAF(W, precomputes, n);
+            return ExtendedPoint.normalizeZ([p, f])[0];
+        }
+        // Constant time multiplication.
+        // Uses wNAF method. Windowed method may be 10% faster,
+        // but takes 2x longer to generate and consumes 2x memory.
+        multiply(scalar, affinePoint) {
+            return this.wNAF(normalizeScalar(scalar, CURVE_ORDER), affinePoint);
+        }
+        // Non-constant-time multiplication. Uses double-and-add algorithm.
+        // It's faster, but should only be used when you don't care about
+        // an exposed private key e.g. sig verification.
+        // Allows scalar bigger than curve order, but less than 2^256
+        multiplyUnsafe(scalar) {
+            let n = normalizeScalar(scalar, CURVE_ORDER, false);
+            const G = ExtendedPoint.BASE;
+            const P0 = ExtendedPoint.ZERO;
+            if (n === _0n)
+                return P0;
+            if (this.equals(P0) || n === _1n)
+                return this;
+            if (this.equals(G))
+                return this.wNAF(n);
+            return wnaf.unsafeLadder(this, n);
+        }
+        // Multiplies point by cofactor and checks if the result is 0.
+        isSmallOrder() {
+            return this.multiplyUnsafe(CURVE.h).equals(ExtendedPoint.ZERO);
+        }
+        // Multiplies point by a very big scalar n and checks if the result is 0.
+        isTorsionFree() {
+            return this.multiplyUnsafe(CURVE_ORDER).equals(ExtendedPoint.ZERO);
+        }
+        // Converts Extended point to default (x, y) coordinates.
+        // Can accept precomputed Z^-1 - for example, from invertBatch.
+        toAffine(invZ) {
+            const { x, y, z } = this;
+            const is0 = this.equals(ExtendedPoint.ZERO);
+            if (invZ == null)
+                invZ = is0 ? _8n : mod.invert(z, P); // 8 was chosen arbitrarily
+            const ax = modP(x * invZ);
+            const ay = modP(y * invZ);
+            const zz = modP(z * invZ);
+            if (is0)
+                return Point.ZERO;
+            if (zz !== _1n)
+                throw new Error('invZ was invalid');
+            return new Point(ax, ay);
+        }
+    }
+    ExtendedPoint.BASE = new ExtendedPoint(CURVE.Gx, CURVE.Gy, _1n, modP(CURVE.Gx * CURVE.Gy));
+    ExtendedPoint.ZERO = new ExtendedPoint(_0n, _1n, _1n, _0n);
+    const wnaf = wNAF(ExtendedPoint, groupLen * 8);
+    function assertExtPoint(other) {
+        if (!(other instanceof ExtendedPoint))
+            throw new TypeError('ExtendedPoint expected');
+    }
+    // Stores precomputed values for points.
+    const pointPrecomputes = new WeakMap();
+    /**
+     * Default Point works in affine coordinates: (x, y)
+     */
+    class Point {
+        constructor(x, y) {
+            this.x = x;
+            this.y = y;
+        }
+        // "Private method", don't use it directly.
+        _setWindowSize(windowSize) {
+            this._WINDOW_SIZE = windowSize;
+            pointPrecomputes.delete(this);
+        }
+        // Converts hash string or Uint8Array to Point.
+        // Uses algo from RFC8032 5.1.3.
+        static fromHex(hex, strict = true) {
+            const { d, P, a } = CURVE;
+            hex = ensureBytes(hex, fieldLen);
+            // 1.  First, interpret the string as an integer in little-endian
+            // representation. Bit 255 of this number is the least significant
+            // bit of the x-coordinate and denote this value x_0.  The
+            // y-coordinate is recovered simply by clearing this bit.  If the
+            // resulting value is >= p, decoding fails.
+            const normed = hex.slice();
+            const lastByte = hex[fieldLen - 1];
+            normed[fieldLen - 1] = lastByte & ~0x80;
+            const y = bytesToNumberLE(normed);
+            if (strict && y >= P)
+                throw new Error('Expected 0 < hex < P');
+            if (!strict && y >= maxGroupElement)
+                throw new Error('Expected 0 < hex < 2**256');
+            // 2.  To recover the x-coordinate, the curve equation implies
+            // Ed25519: x² = (y² - 1) / (d y² + 1) (mod p).
+            // Ed448: x² = (y² - 1) / (d y² - 1) (mod p).
+            // For generic case:
+            // a*x²+y²=1+d*x²*y²
+            // -> y²-1 = d*x²*y²-a*x²
+            // -> y²-1 = x² (d*y²-a)
+            // -> x² = (y²-1) / (d*y²-a)
+            // The denominator is always non-zero mod p.  Let u = y² - 1 and v = d y² + 1.
+            const y2 = modP(y * y);
+            const u = modP(y2 - _1n);
+            const v = modP(d * y2 - a);
+            let { isValid, value: x } = uvRatio(u, v);
+            if (!isValid)
+                throw new Error('Point.fromHex: invalid y coordinate');
+            // 4.  Finally, use the x_0 bit to select the right square root.  If
+            // x = 0, and x_0 = 1, decoding fails.  Otherwise, if x_0 != x mod
+            // 2, set x <-- p - x.  Return the decoded point (x,y).
+            const isXOdd = (x & _1n) === _1n;
+            const isLastByteOdd = (lastByte & 0x80) !== 0;
+            if (isLastByteOdd !== isXOdd)
+                x = modP(-x);
+            return new Point(x, y);
+        }
+        static fromPrivateKey(privateKey) {
+            return getExtendedPublicKey(privateKey).point;
+        }
+        // There can always be only two x values (x, -x) for any y
+        // When compressing point, it's enough to only store its y coordinate
+        // and use the last byte to encode sign of x.
+        toRawBytes() {
+            const bytes = numberToBytesLE(this.y, fieldLen);
+            bytes[fieldLen - 1] |= this.x & _1n ? 0x80 : 0;
+            return bytes;
+        }
+        // Same as toRawBytes, but returns string.
+        toHex() {
+            return bytesToHex(this.toRawBytes());
+        }
+        isTorsionFree() {
+            return ExtendedPoint.fromAffine(this).isTorsionFree();
+        }
+        equals(other) {
+            if (!(other instanceof Point))
+                throw new TypeError('Point#equals: expected Point');
+            return this.x === other.x && this.y === other.y;
+        }
+        negate() {
+            return new Point(modP(-this.x), this.y);
+        }
+        double() {
+            return ExtendedPoint.fromAffine(this).double().toAffine();
+        }
+        add(other) {
+            return ExtendedPoint.fromAffine(this).add(ExtendedPoint.fromAffine(other)).toAffine();
+        }
+        subtract(other) {
+            return this.add(other.negate());
+        }
+        /**
+         * Constant time multiplication.
+         * @param scalar Big-Endian number
+         * @returns new point
+         */
+        multiply(scalar) {
+            return ExtendedPoint.fromAffine(this).multiply(scalar, this).toAffine();
+        }
+    }
+    // Base point aka generator
+    // public_key = Point.BASE * private_key
+    Point.BASE = new Point(CURVE.Gx, CURVE.Gy);
+    // Identity point aka point at infinity
+    // point = point + zero_point
+    Point.ZERO = new Point(_0n, _1n);
+    /**
+     * EDDSA signature.
+     */
+    class Signature {
+        constructor(r, s) {
+            this.r = r;
+            this.s = s;
+            this.assertValidity();
+        }
+        static fromHex(hex) {
+            const bytes = ensureBytes(hex, 2 * fieldLen);
+            const r = Point.fromHex(bytes.slice(0, fieldLen), false);
+            const s = bytesToNumberLE(bytes.slice(fieldLen, 2 * fieldLen));
+            return new Signature(r, s);
+        }
+        assertValidity() {
+            const { r, s } = this;
+            if (!(r instanceof Point))
+                throw new Error('Expected Point instance');
+            // 0 <= s < l
+            normalizeScalar(s, CURVE_ORDER, false);
+            return this;
+        }
+        toRawBytes() {
+            return concatBytes(this.r.toRawBytes(), numberToBytesLE(this.s, fieldLen));
+        }
+        toHex() {
+            return bytesToHex(this.toRawBytes());
+        }
+    }
+    // Little-endian SHA512 with modulo n
+    function modlLE(hash) {
+        return mod.mod(bytesToNumberLE(hash), CURVE_ORDER);
+    }
+    /**
+     * Checks for num to be in range:
+     * For strict == true:  `0 <  num < max`.
+     * For strict == false: `0 <= num < max`.
+     * Converts non-float safe numbers to bigints.
+     */
+    function normalizeScalar(num, max, strict = true) {
+        if (!max)
+            throw new TypeError('Specify max value');
+        if (typeof num === 'number' && Number.isSafeInteger(num))
+            num = BigInt(num);
+        if (typeof num === 'bigint' && num < max) {
+            if (strict) {
+                if (_0n < num)
+                    return num;
+            }
+            else {
+                if (_0n <= num)
+                    return num;
+            }
+        }
+        throw new TypeError('Expected valid scalar: 0 < scalar < max');
+    }
+    function checkPrivateKey(key) {
+        // Normalize bigint / number / string to Uint8Array
+        key =
+            typeof key === 'bigint' || typeof key === 'number'
+                ? numberToBytesLE(normalizeScalar(key, maxGroupElement), groupLen)
+                : ensureBytes(key);
+        if (key.length !== groupLen)
+            throw new Error(`Expected ${groupLen} bytes, got ${key.length}`);
+        return key;
+    }
+    // Takes 64 bytes
+    function getKeyFromHash(hashed) {
+        // First 32 bytes of 64b uniformingly random input are taken,
+        // clears 3 bits of it to produce a random field element.
+        const head = adjustScalarBytes(hashed.slice(0, groupLen));
+        // Second 32 bytes is called key prefix (5.1.6)
+        const prefix = hashed.slice(groupLen, 2 * groupLen);
+        // The actual private scalar
+        const scalar = modlLE(head);
+        // Point on Edwards curve aka public key
+        const point = Point.BASE.multiply(scalar);
+        const pointBytes = point.toRawBytes();
+        return { head, prefix, scalar, point, pointBytes };
+    }
+    /** Convenience method that creates public key and other stuff. RFC8032 5.1.5 */
+    function getExtendedPublicKey(key) {
+        return getKeyFromHash(CURVE.hash(checkPrivateKey(key)));
+    }
+    /**
+     * Calculates ed25519 public key. RFC8032 5.1.5
+     * 1. private key is hashed with sha512, then first 32 bytes are taken from the hash
+     * 2. 3 least significant bits of the first byte are cleared
+     */
+    function getPublicKey(privateKey) {
+        return getExtendedPublicKey(privateKey).pointBytes;
+    }
+    const EMPTY = new Uint8Array();
+    function hashDomainToScalar(message, context = EMPTY) {
+        context = ensureBytes(context);
+        return modlLE(CURVE.hash(domain(message, context, !!CURVE.preHash)));
+    }
+    /** Signs message with privateKey. RFC8032 5.1.6 */
+    function sign(message, privateKey, context) {
+        message = ensureBytes(message);
+        if (CURVE.preHash)
+            message = CURVE.preHash(message);
+        const { prefix, scalar, pointBytes } = getExtendedPublicKey(privateKey);
+        const r = hashDomainToScalar(concatBytes(prefix, message), context);
+        const R = Point.BASE.multiply(r); // R = rG
+        const k = hashDomainToScalar(concatBytes(R.toRawBytes(), pointBytes, message), context); // k = hash(R+P+msg)
+        const s = mod.mod(r + k * scalar, CURVE_ORDER); // s = r + kp
+        return new Signature(R, s).toRawBytes();
+    }
+    /**
+     * Verifies EdDSA signature against message and public key.
+     * An extended group equation is checked.
+     * RFC8032 5.1.7
+     * Compliant with ZIP215:
+     * 0 <= sig.R/publicKey < 2**256 (can be >= curve.P)
+     * 0 <= sig.s < l
+     * Not compliant with RFC8032: it's not possible to comply to both ZIP & RFC at the same time.
+     */
+    function verify(sig, message, publicKey, context) {
+        message = ensureBytes(message);
+        if (CURVE.preHash)
+            message = CURVE.preHash(message);
+        // When hex is passed, we check public key fully.
+        // When Point instance is passed, we assume it has already been checked, for performance.
+        // If user passes Point/Sig instance, we assume it has been already verified.
+        // We don't check its equations for performance. We do check for valid bounds for s though
+        // We always check for: a) s bounds. b) hex validity
+        if (publicKey instanceof Point) {
+            // ignore
+        }
+        else if (publicKey instanceof Uint8Array || typeof publicKey === 'string') {
+            publicKey = Point.fromHex(publicKey, false);
+        }
+        else {
+            throw new Error(`Invalid publicKey: ${publicKey}`);
+        }
+        if (sig instanceof Signature)
+            sig.assertValidity();
+        else if (sig instanceof Uint8Array || typeof sig === 'string')
+            sig = Signature.fromHex(sig);
+        else
+            throw new Error(`Wrong signature: ${sig}`);
+        const { r, s } = sig;
+        const SB = ExtendedPoint.BASE.multiplyUnsafe(s);
+        const k = hashDomainToScalar(concatBytes(r.toRawBytes(), publicKey.toRawBytes(), message), context);
+        const kA = ExtendedPoint.fromAffine(publicKey).multiplyUnsafe(k);
+        const RkA = ExtendedPoint.fromAffine(r).add(kA);
+        // [8][S]B = [8]R + [8][k]A'
+        return RkA.subtract(SB).multiplyUnsafe(CURVE.h).equals(ExtendedPoint.ZERO);
+    }
+    // Enable precomputes. Slows down first publicKey computation by 20ms.
+    Point.BASE._setWindowSize(8);
+    const utils = {
+        getExtendedPublicKey,
+        mod: modP,
+        invert: (a, m = CURVE.P) => mod.invert(a, m),
+        /**
+         * Not needed for ed25519 private keys. Needed if you use scalars directly (rare).
+         */
+        hashToPrivateScalar: (hash) => hashToPrivateScalar(hash, CURVE_ORDER, true),
+        /**
+         * ed25519 private keys are uniform 32-bit strings. We do not need to check for
+         * modulo bias like we do in secp256k1 randomPrivateKey()
+         */
+        randomPrivateKey: () => randomBytes(fieldLen),
+        /**
+         * We're doing scalar multiplication (used in getPublicKey etc) with precomputed BASE_POINT
+         * values. This slows down first getPublicKey() by milliseconds (see Speed section),
+         * but allows to speed-up subsequent getPublicKey() calls up to 20x.
+         * @param windowSize 2, 4, 8, 16
+         */
+        precompute(windowSize = 8, point = Point.BASE) {
+            const cached = point.equals(Point.BASE) ? point : new Point(point.x, point.y);
+            cached._setWindowSize(windowSize);
+            cached.multiply(_2n);
+            return cached;
+        },
+    };
+    return {
+        CURVE,
+        getPublicKey,
+        sign,
+        verify,
+        ExtendedPoint,
+        Point,
+        Signature,
+        utils,
+    };
+}

package/lib/esm/group.js

@@ -0,0 +1,107 @@
+/*! @noble/curves - MIT License (c) 2022 Paul Miller (paulmillr.com) */
+// Default group related functions
+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
+export function wNAF(c, bits) {
+    const constTimeNegate = (condition, item) => {
+        const neg = item.negate();
+        return condition ? neg : item;
+    };
+    const opts = (W) => {
+        if (256 % W)
+            throw new Error('Invalid precomputation window, must be power of 2');
+        const windows = Math.ceil(bits / W) + 1; // +1, because
+        const windowSize = 2 ** (W - 1); // -1 because we skip zero
+        return { windows, windowSize };
+    };
+    return {
+        constTimeNegate,
+        // non-const time multiplication ladder
+        unsafeLadder(elm, n) {
+            let p = c.ZERO;
+            let d = elm;
+            while (n > _0n) {
+                if (n & _1n)
+                    p = p.add(d);
+                d = d.double();
+                n >>= _1n;
+            }
+            return p;
+        },
+        /**
+         * Creates a wNAF precomputation window. Used for caching.
+         * Default window size is set by `utils.precompute()` and is equal to 8.
+         * Which means we are caching 65536 points: 256 points for every bit from 0 to 256.
+         * @returns 65K precomputed points, depending on W
+         */
+        precomputeWindow(elm, W) {
+            const { windows, windowSize } = opts(W);
+            const points = [];
+            let p = elm;
+            let base = p;
+            for (let window = 0; window < windows; window++) {
+                base = p;
+                points.push(base);
+                // =1, because we skip zero
+                for (let i = 1; i < windowSize; i++) {
+                    base = base.add(p);
+                    points.push(base);
+                }
+                p = base.double();
+            }
+            return points;
+        },
+        /**
+         * Implements w-ary non-adjacent form for calculating ec multiplication.
+         * @param n
+         * @param affinePoint optional 2d point to save cached precompute windows on it.
+         * @returns real and fake (for const-time) points
+         */
+        wNAF(W, precomputes, n) {
+            const { windows, windowSize } = opts(W);
+            let p = c.ZERO;
+            let f = c.BASE;
+            const mask = BigInt(2 ** W - 1); // Create mask with W ones: 0b1111 for W=4 etc.
+            const maxNumber = 2 ** W;
+            const shiftBy = BigInt(W);
+            for (let window = 0; window < windows; window++) {
+                const offset = window * windowSize;
+                // Extract W bits.
+                let wbits = Number(n & mask);
+                // Shift number by W bits.
+                n >>= shiftBy;
+                // If the bits are bigger than max size, we'll split those.
+                // +224 => 256 - 32
+                if (wbits > windowSize) {
+                    wbits -= maxNumber;
+                    n += _1n;
+                }
+                // This code was first written with assumption that 'f' and 'p' will never be infinity point:
+                // since each addition is multiplied by 2 ** W, it cannot cancel each other. However,
+                // there is negate now: it is possible that negated element from low value
+                // would be the same as high element, which will create carry into next window.
+                // It's not obvious how this can fail, but still worth investigating later.
+                // Check if we're onto Zero point.
+                // Add random point inside current window to f.
+                const offset1 = offset;
+                const offset2 = offset + Math.abs(wbits) - 1; // -1 because we skip zero
+                const cond1 = window % 2 !== 0;
+                const cond2 = wbits < 0;
+                if (wbits === 0) {
+                    // The most important part for const-time getPublicKey
+                    f = f.add(constTimeNegate(cond1, precomputes[offset1]));
+                }
+                else {
+                    p = p.add(constTimeNegate(cond2, precomputes[offset2]));
+                }
+            }
+            // JIT-compiler should not eliminate f here, since it will later be used in normalizeZ()
+            // Even if the variable is still unused, there are some checks which will
+            // throw an exception, so compiler needs to prove they won't happen, which is hard.
+            // At this point there is a way to F be infinity-point even if p is not,
+            // which makes it less const-time: around 1 bigint multiply.
+            return { p, f };
+        },
+    };
+}

package/lib/esm/modular.js

@@ -1,4 +1,5 @@
 /*! @noble/curves - MIT License (c) 2022 Paul Miller (paulmillr.com) */
+// Utilities for modular arithmetics
 const _0n = BigInt(0);
 const _1n = BigInt(1);
 const _2n = BigInt(2);
@@ -97,7 +98,6 @@ export function legendre(num, fieldPrime) {
 }
 /**
  * Calculates square root of a number in a finite field.
- * Used to calculate y - the square root of y².
  */
 export function sqrt(number, modulo) {
     const n = number;
@@ -146,3 +146,12 @@ export function sqrt(number, modulo) {
     }
     return r;
 }
+// Little-endian check for first LE bit (last BE bit);
+export const isNegativeLE = (num, modulo) => (mod(num, modulo) & _1n) === _1n;
+// An idea on modular arithmetic for bls12-381:
+// const FIELD = {add, pow, sqrt, mul};
+// Functions will take field elements, no need for an additional class
+// Could be faster. 1 bigint field will just do operations and mod later:
+// instead of 'r = mod(r * b, P)' we will write r = mul(r, b);
+// Could be insecure without shape check, so it needs to be done.
+// Functions could be inlined by JIT.