@noble/curves
Advanced tools
@noble/curves - npm Package Compare versions
Comparing version 0.6.4 to 0.7.0
163
package.json
| { | ||
| "name": "@noble/curves", | ||
| "version": "0.6.4", | ||
| "version": "0.7.0", | ||
| "description": "Minimal, auditable JS implementation of elliptic curve cryptography", | ||
| "files": [ | ||
| "lib" | ||
| "abstract", | ||
| "esm", | ||
| "src", | ||
| "*.js", | ||
| "*.js.map", | ||
| "*.d.ts", | ||
| "*.d.ts.map" | ||
| ], | ||
@@ -27,3 +33,2 @@ "scripts": { | ||
| "devDependencies": { | ||
| "@scure/base": "~1.1.1", | ||
| "@scure/bip32": "~1.1.5", | ||
@@ -33,3 +38,3 @@ "@scure/bip39": "~1.1.1", | ||
| "fast-check": "3.0.0", | ||
| "micro-bmark": "0.3.0", | ||
| "micro-bmark": "0.3.1", | ||
| "micro-should": "0.4.0", | ||
@@ -42,125 +47,125 @@ "prettier": "2.8.3", | ||
| ".": { | ||
| "types": "./lib/index.d.ts", | ||
| "import": "./lib/esm/index.js", | ||
| "default": "./lib/index.js" | ||
| "types": "./index.d.ts", | ||
| "import": "./esm/index.js", | ||
| "default": "./index.js" | ||
| }, | ||
| "./abstract/edwards": { | ||
| "types": "./lib/abstract/edwards.d.ts", | ||
| "import": "./lib/esm/abstract/edwards.js", | ||
| "default": "./lib/abstract/edwards.js" | ||
| "types": "./abstract/edwards.d.ts", | ||
| "import": "./esm/abstract/edwards.js", | ||
| "default": "./abstract/edwards.js" | ||
| }, | ||
| "./abstract/modular": { | ||
| "types": "./lib/abstract/modular.d.ts", | ||
| "import": "./lib/esm/abstract/modular.js", | ||
| "default": "./lib/abstract/modular.js" | ||
| "types": "./abstract/modular.d.ts", | ||
| "import": "./esm/abstract/modular.js", | ||
| "default": "./abstract/modular.js" | ||
| }, | ||
| "./abstract/montgomery": { | ||
| "types": "./lib/abstract/montgomery.d.ts", | ||
| "import": "./lib/esm/abstract/montgomery.js", | ||
| "default": "./lib/abstract/montgomery.js" | ||
| "types": "./abstract/montgomery.d.ts", | ||
| "import": "./esm/abstract/montgomery.js", | ||
| "default": "./abstract/montgomery.js" | ||
| }, | ||
| "./abstract/weierstrass": { | ||
| "types": "./lib/abstract/weierstrass.d.ts", | ||
| "import": "./lib/esm/abstract/weierstrass.js", | ||
| "default": "./lib/abstract/weierstrass.js" | ||
| "types": "./abstract/weierstrass.d.ts", | ||
| "import": "./esm/abstract/weierstrass.js", | ||
| "default": "./abstract/weierstrass.js" | ||
| }, | ||
| "./abstract/bls": { | ||
| "types": "./lib/abstract/bls.d.ts", | ||
| "import": "./lib/esm/abstract/bls.js", | ||
| "default": "./lib/abstract/bls.js" | ||
| "types": "./abstract/bls.d.ts", | ||
| "import": "./esm/abstract/bls.js", | ||
| "default": "./abstract/bls.js" | ||
| }, | ||
| "./abstract/hash-to-curve": { | ||
| "types": "./lib/abstract/hash-to-curve.d.ts", | ||
| "import": "./lib/esm/abstract/hash-to-curve.js", | ||
| "default": "./lib/abstract/hash-to-curve.js" | ||
| "types": "./abstract/hash-to-curve.d.ts", | ||
| "import": "./esm/abstract/hash-to-curve.js", | ||
| "default": "./abstract/hash-to-curve.js" | ||
| }, | ||
| "./abstract/curve": { | ||
| "types": "./lib/abstract/curve.d.ts", | ||
| "import": "./lib/esm/abstract/curve.js", | ||
| "default": "./lib/abstract/curve.js" | ||
| "types": "./abstract/curve.d.ts", | ||
| "import": "./esm/abstract/curve.js", | ||
| "default": "./abstract/curve.js" | ||
| }, | ||
| "./abstract/utils": { | ||
| "types": "./lib/abstract/utils.d.ts", | ||
| "import": "./lib/esm/abstract/utils.js", | ||
| "default": "./lib/abstract/utils.js" | ||
| "types": "./abstract/utils.d.ts", | ||
| "import": "./esm/abstract/utils.js", | ||
| "default": "./abstract/utils.js" | ||
| }, | ||
| "./abstract/poseidon": { | ||
| "types": "./lib/abstract/poseidon.d.ts", | ||
| "import": "./lib/esm/abstract/poseidon.js", | ||
| "default": "./lib/abstract/poseidon.js" | ||
| "types": "./abstract/poseidon.d.ts", | ||
| "import": "./esm/abstract/poseidon.js", | ||
| "default": "./abstract/poseidon.js" | ||
| }, | ||
| "./_shortw_utils": { | ||
| "types": "./lib/_shortw_utils.d.ts", | ||
| "import": "./lib/esm/_shortw_utils.js", | ||
| "default": "./lib/_shortw_utils.js" | ||
| "types": "./_shortw_utils.d.ts", | ||
| "import": "./esm/_shortw_utils.js", | ||
| "default": "./_shortw_utils.js" | ||
| }, | ||
| "./bls12-381": { | ||
| "types": "./lib/bls12-381.d.ts", | ||
| "import": "./lib/esm/bls12-381.js", | ||
| "default": "./lib/bls12-381.js" | ||
| "types": "./bls12-381.d.ts", | ||
| "import": "./esm/bls12-381.js", | ||
| "default": "./bls12-381.js" | ||
| }, | ||
| "./bn": { | ||
| "types": "./lib/bn.d.ts", | ||
| "import": "./lib/esm/bn.js", | ||
| "default": "./lib/bn.js" | ||
| "types": "./bn.d.ts", | ||
| "import": "./esm/bn.js", | ||
| "default": "./bn.js" | ||
| }, | ||
| "./ed25519": { | ||
| "types": "./lib/ed25519.d.ts", | ||
| "import": "./lib/esm/ed25519.js", | ||
| "default": "./lib/ed25519.js" | ||
| "types": "./ed25519.d.ts", | ||
| "import": "./esm/ed25519.js", | ||
| "default": "./ed25519.js" | ||
| }, | ||
| "./ed448": { | ||
| "types": "./lib/ed448.d.ts", | ||
| "import": "./lib/esm/ed448.js", | ||
| "default": "./lib/ed448.js" | ||
| "types": "./ed448.d.ts", | ||
| "import": "./esm/ed448.js", | ||
| "default": "./ed448.js" | ||
| }, | ||
| "./index": { | ||
| "types": "./lib/index.d.ts", | ||
| "import": "./lib/esm/index.js", | ||
| "default": "./lib/index.js" | ||
| "types": "./index.d.ts", | ||
| "import": "./esm/index.js", | ||
| "default": "./index.js" | ||
| }, | ||
| "./jubjub": { | ||
| "types": "./lib/jubjub.d.ts", | ||
| "import": "./lib/esm/jubjub.js", | ||
| "default": "./lib/jubjub.js" | ||
| "types": "./jubjub.d.ts", | ||
| "import": "./esm/jubjub.js", | ||
| "default": "./jubjub.js" | ||
| }, | ||
| "./p192": { | ||
| "types": "./lib/p192.d.ts", | ||
| "import": "./lib/esm/p192.js", | ||
| "default": "./lib/p192.js" | ||
| "types": "./p192.d.ts", | ||
| "import": "./esm/p192.js", | ||
| "default": "./p192.js" | ||
| }, | ||
| "./p224": { | ||
| "types": "./lib/p224.d.ts", | ||
| "import": "./lib/esm/p224.js", | ||
| "default": "./lib/p224.js" | ||
| "types": "./p224.d.ts", | ||
| "import": "./esm/p224.js", | ||
| "default": "./p224.js" | ||
| }, | ||
| "./p256": { | ||
| "types": "./lib/p256.d.ts", | ||
| "import": "./lib/esm/p256.js", | ||
| "default": "./lib/p256.js" | ||
| "types": "./p256.d.ts", | ||
| "import": "./esm/p256.js", | ||
| "default": "./p256.js" | ||
| }, | ||
| "./p384": { | ||
| "types": "./lib/p384.d.ts", | ||
| "import": "./lib/esm/p384.js", | ||
| "default": "./lib/p384.js" | ||
| "types": "./p384.d.ts", | ||
| "import": "./esm/p384.js", | ||
| "default": "./p384.js" | ||
| }, | ||
| "./p521": { | ||
| "types": "./lib/p521.d.ts", | ||
| "import": "./lib/esm/p521.js", | ||
| "default": "./lib/p521.js" | ||
| "types": "./p521.d.ts", | ||
| "import": "./esm/p521.js", | ||
| "default": "./p521.js" | ||
| }, | ||
| "./pasta": { | ||
| "types": "./lib/pasta.d.ts", | ||
| "import": "./lib/esm/pasta.js", | ||
| "default": "./lib/pasta.js" | ||
| "types": "./pasta.d.ts", | ||
| "import": "./esm/pasta.js", | ||
| "default": "./pasta.js" | ||
| }, | ||
| "./secp256k1": { | ||
| "types": "./lib/secp256k1.d.ts", | ||
| "import": "./lib/esm/secp256k1.js", | ||
| "default": "./lib/secp256k1.js" | ||
| "types": "./secp256k1.d.ts", | ||
| "import": "./esm/secp256k1.js", | ||
| "default": "./secp256k1.js" | ||
| }, | ||
| "./stark": { | ||
| "types": "./lib/stark.d.ts", | ||
| "import": "./lib/esm/stark.js", | ||
| "default": "./lib/stark.js" | ||
| "types": "./stark.d.ts", | ||
| "import": "./esm/stark.js", | ||
| "default": "./stark.js" | ||
| } | ||
@@ -167,0 +172,0 @@ }, |
710
README.md
| # noble-curves | ||
| Minimal, auditable JS implementation of elliptic curve cryptography. | ||
| Audited & minimal JS implementation of elliptic curve cryptography. | ||
| - **noble** family, zero dependencies | ||
| - Short Weierstrass, Edwards, Montgomery curves | ||
| - ECDSA, EdDSA, Schnorr, BLS signature schemes, ECDH key agreement | ||
| - [hash to curve](https://datatracker.ietf.org/doc/draft-irtf-cfrg-hash-to-curve/) | ||
| for encoding or hashing an arbitrary string to a point on an elliptic curve | ||
| - [Poseidon](https://www.poseidon-hash.info) ZK-friendly hash | ||
| - #️⃣ [hash to curve](https://datatracker.ietf.org/doc/draft-irtf-cfrg-hash-to-curve/) | ||
| for encoding or hashing an arbitrary string to an elliptic curve point | ||
| - 🧜♂️ [Poseidon](https://www.poseidon-hash.info) ZK-friendly hash | ||
| - 🏎 [Ultra-fast](#speed), hand-optimized for caveats of JS engines | ||
@@ -16,14 +17,12 @@ - 🔍 Unique tests ensure correctness. Wycheproof vectors included | ||
| 1. `abstract/` directory specifies zero-dependency EC algorithms | ||
| 2. root directory utilizes one dependency `@noble/hashes` and provides ready-to-use: | ||
| 1. [Abstract](#abstract-api), zero-dependency EC algorithms | ||
| 2. [Implementations](#implementations), utilizing one dependency `@noble/hashes`, providing ready-to-use: | ||
| - NIST curves secp192r1/P192, secp224r1/P224, secp256r1/P256, secp384r1/P384, secp521r1/P521 | ||
| - SECG curve secp256k1 | ||
| - ed25519/curve25519/x25519/ristretto255, edwards448/curve448/x448 RFC7748 / RFC8032 / ZIP215 stuff | ||
| - pairing-friendly curves bls12-381, bn254 | ||
| - ed25519/curve25519/x25519/ristretto, edwards448/curve448/x448 RFC7748 / RFC8032 / ZIP215 stuff | ||
| Curves incorporate work from previous noble packages | ||
| ([secp256k1](https://github.com/paulmillr/noble-secp256k1), | ||
| [ed25519](https://github.com/paulmillr/noble-ed25519)), | ||
| which had security audits and were developed from 2019 to 2022. | ||
| Check out [Upgrading](#upgrading) section if you've used them before. | ||
| Check out [Upgrading](#upgrading) if you've previously used single-feature noble packages | ||
| ([secp256k1](https://github.com/paulmillr/noble-secp256k1), [ed25519](https://github.com/paulmillr/noble-ed25519)). | ||
| See [In the wild](#in-the-wild) for real-world software that uses curves. | ||
@@ -34,3 +33,3 @@ ### This library belongs to _noble_ crypto | ||
| - Protection against supply chain attacks | ||
| - No dependencies, protection against supply chain attacks | ||
| - Easily auditable TypeScript/JS code | ||
@@ -47,11 +46,37 @@ - Supported in all major browsers and stable node.js versions | ||
| Use NPM in node.js / browser, or include single file from | ||
| [GitHub's releases page](https://github.com/paulmillr/noble-curves/releases): | ||
| Use NPM for browser / node.js: | ||
| > npm install @noble/curves | ||
| The library does not have an entry point. It allows you to select specific primitives and drop everything else. If you only want to use secp256k1, just use the library with rollup or other bundlers. This is done to make your bundles tiny. All curves: | ||
| For [Deno](https://deno.land), use it with npm specifier. In browser, you could also include the single file from | ||
| [GitHub's releases page](https://github.com/paulmillr/noble-curves/releases). | ||
| The library is tree-shaking-friendly and does not expose root entry point as `import * from '@noble/curves'`. | ||
| Instead, you need to import specific primitives. This is done to ensure small size of your apps. | ||
| ### Implementations | ||
| Each curve can be used in the following way: | ||
| ```ts | ||
| import { secp256k1 } from '@noble/curves/secp256k1'; | ||
| import { secp256k1 } from '@noble/curves/secp256k1'; // ECMAScript Modules (ESM) and Common.js | ||
| // import { secp256k1 } from 'npm:@noble/curves@1.2.0/secp256k1'; // Deno | ||
| const priv = secp256k1.utils.randomPrivateKey(); | ||
| const pub = secp256k1.getPublicKey(priv); | ||
| const msg = new Uint8Array(32).fill(1); | ||
| const sig = secp256k1.sign(msg, priv); | ||
| secp256k1.verify(sig, msg, pub) === true; | ||
| const privHex = '46c930bc7bb4db7f55da20798697421b98c4175a52c630294d75a84b9c126236' | ||
| const pub2 = secp256k1.getPublicKey(privHex); // keys & other inputs can be Uint8Array-s or hex strings | ||
| // Follows hash-to-curve specification to encode arbitrary hashes to EC points | ||
| import { hashToCurve, encodeToCurve } from '@noble/curves/secp256k1'; | ||
| hashToCurve('0102abcd'); | ||
| ``` | ||
| All curves: | ||
| ```typescript | ||
| import { secp256k1, schnorr } from '@noble/curves/secp256k1'; | ||
| import { ed25519, ed25519ph, ed25519ctx, x25519, RistrettoPoint } from '@noble/curves/ed25519'; | ||
@@ -69,59 +94,204 @@ import { ed448, ed448ph, ed448ctx, x448 } from '@noble/curves/ed448'; | ||
| Every curve can be used in the following way: | ||
| Weierstrass curves feature recovering public keys from signatures and ECDH key agreement: | ||
| ```ts | ||
| import { secp256k1 } from '@noble/curves/secp256k1'; // Common.js and ECMAScript Modules (ESM) | ||
| const key = secp256k1.utils.randomPrivateKey(); | ||
| const pub = secp256k1.getPublicKey(key); | ||
| const msg = new Uint8Array(32).fill(1); | ||
| const sig = secp256k1.sign(msg, key); | ||
| // weierstrass curves should use extraEntropy: https://moderncrypto.org/mail-archive/curves/2017/000925.html | ||
| const sigImprovedSecurity = secp256k1.sign(msg, key, { extraEntropy: true }); | ||
| secp256k1.verify(sig, msg, pub) === true; | ||
| // secp, p*, pasta curves allow pub recovery | ||
| sig.recoverPublicKey(msg) === pub; | ||
| // extraEntropy https://moderncrypto.org/mail-archive/curves/2017/000925.html | ||
| const sigImprovedSecurity = secp256k1.sign(msg, priv, { extraEntropy: true }); | ||
| sig.recoverPublicKey(msg) === pub; // public key recovery | ||
| const someonesPub = secp256k1.getPublicKey(secp256k1.utils.randomPrivateKey()); | ||
| const shared = secp256k1.getSharedSecret(key, someonesPub); | ||
| const shared = secp256k1.getSharedSecret(priv, someonesPub); // ECDH (elliptic curve diffie-hellman) | ||
| ``` | ||
| To define a custom curve, check out docs below. | ||
| secp256k1 has schnorr signature implementation which follows | ||
| [BIP340](https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki): | ||
| ## API | ||
| ```ts | ||
| import { schnorr } from '@noble/curves/secp256k1'; | ||
| const priv = schnorr.utils.randomPrivateKey(); | ||
| const pub = schnorr.getPublicKey(priv); | ||
| const msg = new TextEncoder().encode('hello'); | ||
| const sig = schnorr.sign(msg, priv); | ||
| const isValid = schnorr.verify(sig, msg, pub); | ||
| console.log(isValid); | ||
| ``` | ||
| - [Overview](#overview) | ||
| ed25519 module has ed25519ctx / ed25519ph variants, | ||
| x25519 ECDH and [ristretto255](https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-ristretto255-decaf448). | ||
| It follows [ZIP215](https://zips.z.cash/zip-0215) and [can be used in consensus-critical applications](https://hdevalence.ca/blog/2020-10-04-its-25519am): | ||
| ```ts | ||
| import { ed25519 } from '@noble/curves/ed25519'; | ||
| // Variants from RFC8032: with context, prehashed | ||
| import { ed25519ctx, ed25519ph } from '@noble/curves/ed25519'; | ||
| // ECDH using curve25519 aka x25519 | ||
| import { x25519 } from '@noble/curves/ed25519'; | ||
| const priv = 'a546e36bf0527c9d3b16154b82465edd62144c0ac1fc5a18506a2244ba449ac4'; | ||
| const pub = 'e6db6867583030db3594c1a424b15f7c726624ec26b3353b10a903a6d0ab1c4c'; | ||
| x25519.getSharedSecret(priv, pub) === x25519.scalarMult(priv, pub); | ||
| x25519.getPublicKey(priv) === x25519.scalarMultBase(priv); | ||
| // hash-to-curve | ||
| import { hashToCurve, encodeToCurve } from '@noble/curves/ed25519'; | ||
| import { RistrettoPoint } from '@noble/curves/ed25519'; | ||
| const rp = RistrettoPoint.fromHex( | ||
| '6a493210f7499cd17fecb510ae0cea23a110e8d5b901f8acadd3095c73a3b919' | ||
| ); | ||
| RistrettoPoint.hashToCurve('Ristretto is traditionally a short shot of espresso coffee'); | ||
| // also has add(), equals(), multiply(), toRawBytes() methods | ||
| ``` | ||
| ed448 module is basically the same: | ||
| ```ts | ||
| import { ed448, ed448ph, ed448ctx, x448 } from '@noble/curves/ed448'; | ||
| import { hashToCurve, encodeToCurve } from '@noble/curves/ed448'; | ||
| ``` | ||
| BLS12-381 pairing-friendly Barreto-Lynn-Scott elliptic curve construction allows to | ||
| construct [zk-SNARKs](https://z.cash/technology/zksnarks/) at the 128-bit security | ||
| and use aggregated, batch-verifiable | ||
| [threshold signatures](https://medium.com/snigirev.stepan/bls-signatures-better-than-schnorr-5a7fe30ea716), | ||
| using Boneh-Lynn-Shacham signature scheme. | ||
| ```ts | ||
| import { bls12_381 as bls } from '@noble/curves/bls12-381'; | ||
| const privateKey = '67d53f170b908cabb9eb326c3c337762d59289a8fec79f7bc9254b584b73265c'; | ||
| const message = '64726e3da8'; | ||
| const publicKey = bls.getPublicKey(privateKey); | ||
| const signature = bls.sign(message, privateKey); | ||
| const isValid = bls.verify(signature, message, publicKey); | ||
| console.log({ publicKey, signature, isValid }); | ||
| // Sign 1 msg with 3 keys | ||
| const privateKeys = [ | ||
| '18f020b98eb798752a50ed0563b079c125b0db5dd0b1060d1c1b47d4a193e1e4', | ||
| 'ed69a8c50cf8c9836be3b67c7eeff416612d45ba39a5c099d48fa668bf558c9c', | ||
| '16ae669f3be7a2121e17d0c68c05a8f3d6bef21ec0f2315f1d7aec12484e4cf5', | ||
| ]; | ||
| const messages = ['d2', '0d98', '05caf3']; | ||
| const publicKeys = privateKeys.map(bls.getPublicKey); | ||
| const signatures2 = privateKeys.map((p) => bls.sign(message, p)); | ||
| const aggPubKey2 = bls.aggregatePublicKeys(publicKeys); | ||
| const aggSignature2 = bls.aggregateSignatures(signatures2); | ||
| const isValid2 = bls.verify(aggSignature2, message, aggPubKey2); | ||
| console.log({ signatures2, aggSignature2, isValid2 }); | ||
| // Sign 3 msgs with 3 keys | ||
| const signatures3 = privateKeys.map((p, i) => bls.sign(messages[i], p)); | ||
| const aggSignature3 = bls.aggregateSignatures(signatures3); | ||
| const isValid3 = bls.verifyBatch(aggSignature3, messages, publicKeys); | ||
| console.log({ publicKeys, signatures3, aggSignature3, isValid3 }); | ||
| // Pairings | ||
| // bls.pairing(PointG1, PointG2) | ||
| ``` | ||
| ## Abstract API | ||
| Abstract API allows to define custom curves. All arithmetics is done with JS bigints over finite fields, | ||
| which is defined from `modular` sub-module. For scalar multiplication, we use [precomputed tables with w-ary non-adjacent form (wNAF)](https://paulmillr.com/posts/noble-secp256k1-fast-ecc/). | ||
| Precomputes are enabled for weierstrass and edwards BASE points of a curve. You could precompute any | ||
| other point (e.g. for ECDH) using `utils.precompute()` method. | ||
| There are following zero-dependency algorithms: | ||
| - [abstract/weierstrass: Short Weierstrass curve](#abstractweierstrass-short-weierstrass-curve) | ||
| - [abstract/edwards: Twisted Edwards curve](#abstractedwards-twisted-edwards-curve) | ||
| - [abstract/montgomery: Montgomery curve](#abstractmontgomery-montgomery-curve) | ||
| - [abstract/weierstrass: Short Weierstrass curve](#abstractweierstrass-short-weierstrass-curve) | ||
| - [abstract/hash-to-curve: Hashing strings to curve points](#abstracthash-to-curve-hashing-strings-to-curve-points) | ||
| - [abstract/poseidon: Poseidon hash](#abstractposeidon-poseidon-hash) | ||
| - [abstract/modular](#abstractmodular) | ||
| - [abstract/utils](#abstractutils) | ||
| - [abstract/modular: Modular arithmetics utilities](#abstractmodular-modular-arithmetics-utilities) | ||
| - [abstract/utils: General utilities](#abstractutils-general-utilities) | ||
| ### Overview | ||
| ### abstract/weierstrass: Short Weierstrass curve | ||
| There are following zero-dependency abstract algorithms: | ||
| ```ts | ||
| import { bls } from '@noble/curves/abstract/bls'; | ||
| import { twistedEdwards } from '@noble/curves/abstract/edwards'; | ||
| import { montgomery } from '@noble/curves/abstract/montgomery'; | ||
| import { weierstrass } from '@noble/curves/abstract/weierstrass'; | ||
| import * as mod from '@noble/curves/abstract/modular'; | ||
| import * as utils from '@noble/curves/abstract/utils'; | ||
| ``` | ||
| They allow to define a new curve in a few lines of code: | ||
| Short Weierstrass curve's formula is `y² = x³ + ax + b`. `weierstrass` expects arguments `a`, `b`, field `Fp`, curve order `n`, cofactor `h` | ||
| and coordinates `Gx`, `Gy` of generator point. | ||
| **`k` generation** is done deterministically, following [RFC6979](https://www.rfc-editor.org/rfc/rfc6979). | ||
| For this you will need `hmac` & `hash`, which in our implementations is provided by noble-hashes. | ||
| If you're using different hashing library, make sure to wrap it in the following interface: | ||
| ```ts | ||
| import { Field } from '@noble/curves/abstract/modular'; | ||
| export type CHash = { | ||
| (message: Uint8Array): Uint8Array; | ||
| blockLen: number; | ||
| outputLen: number; | ||
| create(): any; | ||
| }; | ||
| ``` | ||
| **Weierstrass points:** | ||
| 1. Exported as `ProjectivePoint` | ||
| 2. Represented in projective (homogeneous) coordinates: (x, y, z) ∋ (x=x/z, y=y/z) | ||
| 3. Use complete exception-free formulas for addition and doubling | ||
| 4. Can be decoded/encoded from/to Uint8Array / hex strings using `ProjectivePoint.fromHex` and `ProjectivePoint#toRawBytes()` | ||
| 5. Have `assertValidity()` which checks for being on-curve | ||
| 6. Have `toAffine()` and `x` / `y` getters which convert to 2d xy affine coordinates | ||
| ```ts | ||
| // T is usually bigint, but can be something else like complex numbers in BLS curves | ||
| export interface ProjPointType<T> extends Group<ProjPointType<T>> { | ||
| readonly px: T; | ||
| readonly py: T; | ||
| readonly pz: T; | ||
| multiply(scalar: bigint): ProjPointType<T>; | ||
| multiplyUnsafe(scalar: bigint): ProjPointType<T>; | ||
| multiplyAndAddUnsafe(Q: ProjPointType<T>, a: bigint, b: bigint): ProjPointType<T> | undefined; | ||
| toAffine(iz?: T): AffinePoint<T>; | ||
| isTorsionFree(): boolean; | ||
| clearCofactor(): ProjPointType<T>; | ||
| assertValidity(): void; | ||
| hasEvenY(): boolean; | ||
| toRawBytes(isCompressed?: boolean): Uint8Array; | ||
| toHex(isCompressed?: boolean): string; | ||
| } | ||
| // Static methods for 3d XYZ points | ||
| export interface ProjConstructor<T> extends GroupConstructor<ProjPointType<T>> { | ||
| new (x: T, y: T, z: T): ProjPointType<T>; | ||
| fromAffine(p: AffinePoint<T>): ProjPointType<T>; | ||
| fromHex(hex: Hex): ProjPointType<T>; | ||
| fromPrivateKey(privateKey: PrivKey): ProjPointType<T>; | ||
| } | ||
| ``` | ||
| **ECDSA signatures** are represented by `Signature` instances and can be described by the interface: | ||
| ```ts | ||
| export interface SignatureType { | ||
| readonly r: bigint; | ||
| readonly s: bigint; | ||
| readonly recovery?: number; | ||
| assertValidity(): void; | ||
| addRecoveryBit(recovery: number): SignatureType; | ||
| hasHighS(): boolean; | ||
| normalizeS(): SignatureType; | ||
| recoverPublicKey(msgHash: Hex): ProjPointType<bigint>; | ||
| toCompactRawBytes(): Uint8Array; | ||
| toCompactHex(): string; | ||
| // DER-encoded | ||
| toDERRawBytes(isCompressed?: boolean): Uint8Array; | ||
| toDERHex(isCompressed?: boolean): string; | ||
| } | ||
| ``` | ||
| Example implementing [secq256k1](https://personaelabs.org/posts/spartan-ecdsa) (NOT secp256k1) | ||
| [cycle](https://zcash.github.io/halo2/background/curves.html#cycles-of-curves) of secp256k1 with Fp/N flipped. | ||
| ```typescript | ||
| import { weierstrass } from '@noble/curves/abstract/weierstrass'; | ||
| import { hmac } from '@noble/hashes/hmac'; | ||
| import { sha256 } from '@noble/hashes/sha256'; | ||
| import { concatBytes, randomBytes } from '@noble/hashes/utils'; | ||
| // secq (NOT secp) 256k1: cycle of secp256k1 with Fp/N flipped. | ||
| // https://zcash.github.io/halo2/background/curves.html#cycles-of-curves | ||
| // https://personaelabs.org/posts/spartan-ecdsa | ||
| import { Field } from '@noble/curves/abstract/modular'; // finite field, mod arithmetics done over it | ||
| import { sha256 } from '@noble/hashes/sha256'; // 3rd-party sha256() of type utils.CHash, with blockLen/outputLen | ||
| import { hmac } from '@noble/hashes/hmac'; // 3rd-party hmac() that will accept sha256() | ||
| import { concatBytes, randomBytes } from '@noble/hashes/utils'; // 3rd-party utilities | ||
| const secq256k1 = weierstrass({ | ||
| // secq256k1: cycle of secp256k1 with Fp/N flipped. | ||
| a: 0n, | ||
@@ -137,38 +307,89 @@ b: 7n, | ||
| }); | ||
| // All curves expose same generic interface. | ||
| const priv = secq256k1.utils.randomPrivateKey(); | ||
| secq256k1.getPublicKey(priv); // Convert private key to public. | ||
| const sig = secq256k1.sign(msg, priv); // Sign msg with private key. | ||
| secq256k1.verify(sig, msg, priv); // Verify if sig is correct. | ||
| const point = secq256k1.Point.BASE; // Elliptic curve Point class and BASE point static var. | ||
| point.add(point).equals(point.double()); // add(), equals(), double() methods | ||
| point.subtract(point).equals(secq256k1.Point.ZERO); // subtract() method, ZERO static var | ||
| point.negate(); // Flips point over x/y coordinate. | ||
| point.multiply(31415n); // Multiplication of Point by scalar. | ||
| point.assertValidity(); // Checks for being on-curve | ||
| point.toAffine(); // Converts to 2d affine xy coordinates | ||
| secq256k1.CURVE.n; | ||
| secq256k1.CURVE.Fp.mod(); | ||
| secq256k1.CURVE.hash(); | ||
| ``` | ||
| - To initialize new curve, you must specify its variables, order (number of points on curve), field prime (over which the modular division would be done) | ||
| - All curves expose same generic interface: | ||
| - `getPublicKey()`, `sign()`, `verify()` functions | ||
| - `Point` conforming to `Group` interface with add/multiply/double/negate/add/equals methods | ||
| - `CURVE` object with curve variables like `Gx`, `Gy`, `Fp` (field), `n` (order) | ||
| - `utils` object with `randomPrivateKey()`, `mod()`, `invert()` methods (`mod CURVE.P`) | ||
| - All arithmetics is done with JS bigints over finite fields, which is defined from `modular` sub-module | ||
| - Many features require hashing, which is not provided. `@noble/hashes` can be used for this purpose. | ||
| Any other library must conform to the CHash interface: | ||
| ```ts | ||
| export type CHash = { | ||
| (message: Uint8Array): Uint8Array; | ||
| blockLen: number; | ||
| outputLen: number; | ||
| create(): any; | ||
| `weierstrass()` returns `CurveFn`: | ||
| ```ts | ||
| export type CurveFn = { | ||
| CURVE: ReturnType<typeof validateOpts>; | ||
| getPublicKey: (privateKey: PrivKey, isCompressed?: boolean) => Uint8Array; | ||
| getSharedSecret: (privateA: PrivKey, publicB: Hex, isCompressed?: boolean) => Uint8Array; | ||
| sign: (msgHash: Hex, privKey: PrivKey, opts?: SignOpts) => SignatureType; | ||
| verify: ( | ||
| signature: Hex | SignatureType, | ||
| msgHash: Hex, | ||
| publicKey: Hex, | ||
| opts?: { lowS?: boolean; prehash?: boolean } | ||
| ) => boolean; | ||
| ProjectivePoint: ProjectivePointConstructor; | ||
| Signature: SignatureConstructor; | ||
| utils: { | ||
| isValidPrivateKey(privateKey: PrivKey): boolean; | ||
| randomPrivateKey: () => Uint8Array; | ||
| }; | ||
| ``` | ||
| - w-ary non-adjacent form (wNAF) method with constant-time adjustments is used for point multiplication. | ||
| It is possible to enable precomputes for edwards & weierstrass curves. | ||
| Precomputes are calculated once (takes ~20-40ms), after that most `G` base point multiplications: | ||
| for example, `getPublicKey()`, `sign()` and similar methods - would be much faster. | ||
| Use `curve.utils.precompute()` to adjust precomputation window size | ||
| - You could use optional special params to tune performance: | ||
| - `Fp({sqrt})` square root calculation, used for point decompression | ||
| - `endo` endomorphism options for Koblitz curves | ||
| }; | ||
| ``` | ||
| ### abstract/edwards: Twisted Edwards curve | ||
| Twisted Edwards curve's formula is: ax² + y² = 1 + dx²y². | ||
| Twisted Edwards curve's formula is `ax² + y² = 1 + dx²y²`. You must specify `a`, `d`, field `Fp`, order `n`, cofactor `h` | ||
| and coordinates `Gx`, `Gy` of generator point. | ||
| - You must specify curve params `a`, `d`, field `Fp`, order `n`, cofactor `h` and coordinates `Gx`, `Gy` of generator point | ||
| - For EdDSA signatures, params `hash` is also required. `adjustScalarBytes` which instructs how to change private scalars could be specified | ||
| For EdDSA signatures, `hash` param required. `adjustScalarBytes` which instructs how to change private scalars could be specified. | ||
| ```typescript | ||
| **Edwards points:** | ||
| 1. Exported as `ExtendedPoint` | ||
| 2. Represented in extended coordinates: (x, y, z, t) ∋ (x=x/z, y=y/z) | ||
| 3. Use complete exception-free formulas for addition and doubling | ||
| 4. Can be decoded/encoded from/to Uint8Array / hex strings using `ExtendedPoint.fromHex` and `ExtendedPoint#toRawBytes()` | ||
| 5. Have `assertValidity()` which checks for being on-curve | ||
| 6. Have `toAffine()` and `x` / `y` getters which convert to 2d xy affine coordinates | ||
| 7. Have `isTorsionFree()`, `clearCofactor()` and `isSmallOrder()` utilities to handle torsions | ||
| ```ts | ||
| export interface ExtPointType extends Group<ExtPointType> { | ||
| readonly ex: bigint; | ||
| readonly ey: bigint; | ||
| readonly ez: bigint; | ||
| readonly et: bigint; | ||
| assertValidity(): void; | ||
| multiply(scalar: bigint): ExtPointType; | ||
| multiplyUnsafe(scalar: bigint): ExtPointType; | ||
| isSmallOrder(): boolean; | ||
| isTorsionFree(): boolean; | ||
| clearCofactor(): ExtPointType; | ||
| toAffine(iz?: bigint): AffinePoint<bigint>; | ||
| } | ||
| // Static methods of Extended Point with coordinates in X, Y, Z, T | ||
| export interface ExtPointConstructor extends GroupConstructor<ExtPointType> { | ||
| new (x: bigint, y: bigint, z: bigint, t: bigint): ExtPointType; | ||
| fromAffine(p: AffinePoint<bigint>): ExtPointType; | ||
| fromHex(hex: Hex): ExtPointType; | ||
| fromPrivateKey(privateKey: Hex): ExtPointType; | ||
| } | ||
| ``` | ||
| Example implementing edwards25519: | ||
| ```ts | ||
| import { twistedEdwards } from '@noble/curves/abstract/edwards'; | ||
@@ -189,3 +410,3 @@ import { div } from '@noble/curves/abstract/modular'; | ||
| adjustScalarBytes(bytes) { | ||
| // optional in general, mandatory in ed25519 | ||
| // optional; but mandatory in ed25519 | ||
| bytes[0] &= 248; | ||
@@ -197,7 +418,2 @@ bytes[31] &= 127; | ||
| } as const); | ||
| const key = ed25519.utils.randomPrivateKey(); | ||
| const pub = ed25519.getPublicKey(key); | ||
| const msg = new TextEncoder().encode('hello world'); // strings not accepted, must be Uint8Array | ||
| const sig = ed25519.sign(msg, key); | ||
| ed25519.verify(sig, msg, pub) === true; | ||
| ``` | ||
@@ -212,4 +428,3 @@ | ||
| sign: (message: Hex, privateKey: Hex) => Uint8Array; | ||
| verify: (sig: SigType, message: Hex, publicKey: PubKey) => boolean; | ||
| Point: PointConstructor; | ||
| verify: (sig: SigType, message: Hex, publicKey: PubKey, context?: Hex) => boolean; | ||
| ExtendedPoint: ExtendedPointConstructor; | ||
@@ -232,6 +447,4 @@ Signature: SignatureConstructor; | ||
| For now the module only contains methods for x-only ECDH on Curve25519 / Curve448 from RFC7748. | ||
| The module contains methods for x-only ECDH on Curve25519 / Curve448 from RFC7748. Proper Elliptic Curve Points are not implemented yet. | ||
| Proper Elliptic Curve Points are not implemented yet. | ||
| You must specify curve field, `a24` special variable, `montgomeryBits`, `nByteLength`, and coordinate `u` of generator point. | ||
@@ -262,134 +475,40 @@ | ||
| ### abstract/weierstrass: Short Weierstrass curve | ||
| ### abstract/hash-to-curve: Hashing strings to curve points | ||
| Short Weierstrass curve's formula is: y² = x³ + ax + b. Uses deterministic ECDSA from RFC6979. You can also specify `extraEntropy` in `sign()`. | ||
| The module allows to hash arbitrary strings to elliptic curve points. Implements [hash-to-curve v11](https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-hash-to-curve-11). | ||
| - You must specify curve params: `a`, `b`, field `Fp`, order `n`, cofactor `h` and coordinates `Gx`, `Gy` of generator point | ||
| - For ECDSA, you must specify `hash`, `hmac`. It is also possible to recover keys from signatures | ||
| - For ECDH, use `getSharedSecret(privKeyA, pubKeyB)` | ||
| - Optional params are `lowS` (default value) and `endo` (endomorphism) | ||
| `expand_message_xmd` [(spec)](https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-hash-to-curve-11#section-5.4.1) produces a uniformly random byte string using a cryptographic hash function H that outputs b bits. | ||
| ```typescript | ||
| import { Fp } from '@noble/curves/abstract/modular'; | ||
| import { weierstrass } from '@noble/curves/abstract/weierstrass'; // Short Weierstrass curve | ||
| import { sha256 } from '@noble/hashes/sha256'; | ||
| import { hmac } from '@noble/hashes/hmac'; | ||
| import { concatBytes, randomBytes } from '@noble/hashes/utils'; | ||
| const secp256k1 = weierstrass({ | ||
| a: 0n, | ||
| b: 7n, | ||
| Fp: Fp(2n ** 256n - 2n ** 32n - 2n ** 9n - 2n ** 8n - 2n ** 7n - 2n ** 6n - 2n ** 4n - 1n), | ||
| n: 2n ** 256n - 432420386565659656852420866394968145599n, | ||
| Gx: 55066263022277343669578718895168534326250603453777594175500187360389116729240n, | ||
| Gy: 32670510020758816978083085130507043184471273380659243275938904335757337482424n, | ||
| hash: sha256, | ||
| hmac: (k: Uint8Array, ...msgs: Uint8Array[]) => hmac(sha256, key, concatBytes(...msgs)), | ||
| randomBytes, | ||
| // Optional params | ||
| h: 1n, // Cofactor | ||
| lowS: true, // Allow only low-S signatures by default in sign() and verify() | ||
| endo: { | ||
| // Endomorphism options for Koblitz curve | ||
| // Beta param | ||
| beta: 0x7ae96a2b657c07106e64479eac3434e99cf0497512f58995c1396c28719501een, | ||
| // Split scalar k into k1, k2 | ||
| splitScalar: (k: bigint) => { | ||
| // return { k1neg: true, k1: 512n, k2neg: false, k2: 448n }; | ||
| }, | ||
| }, | ||
| }); | ||
| // Usage | ||
| const key = secp256k1.utils.randomPrivateKey(); | ||
| const pub = secp256k1.getPublicKey(key); | ||
| const msg = randomBytes(32); | ||
| const sig = secp256k1.sign(msg, key); | ||
| secp256k1.verify(sig, msg, pub); // true | ||
| sig.recoverPublicKey(msg); // == pub | ||
| const someonesPubkey = secp256k1.getPublicKey(secp256k1.utils.randomPrivateKey()); | ||
| const shared = secp256k1.getSharedSecret(key, someonesPubkey); | ||
| ```ts | ||
| function expand_message_xmd(msg: Uint8Array, DST: Uint8Array, lenInBytes: number, H: CHash): Uint8Array; | ||
| function expand_message_xof(msg: Uint8Array, DST: Uint8Array, lenInBytes: number, k: number, H: CHash): Uint8Array; | ||
| ``` | ||
| `weierstrass()` returns `CurveFn`: | ||
| `hash_to_field(msg, count, options)` [(spec)](https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-hash-to-curve-11#section-5.3) | ||
| hashes arbitrary-length byte strings to a list of one or more elements of a finite field F. | ||
| _ `msg` a byte string containing the message to hash | ||
| _ `count` the number of elements of F to output | ||
| _ `options` `{DST: string, p: bigint, m: number, k: number, expand: 'xmd' | 'xof', hash: H}` | ||
| _ Returns `[u_0, ..., u_(count - 1)]`, a list of field elements. | ||
| ```ts | ||
| export type CurveFn = { | ||
| CURVE: ReturnType<typeof validateOpts>; | ||
| getPublicKey: (privateKey: PrivKey, isCompressed?: boolean) => Uint8Array; | ||
| getSharedSecret: (privateA: PrivKey, publicB: Hex, isCompressed?: boolean) => Uint8Array; | ||
| sign: (msgHash: Hex, privKey: PrivKey, opts?: SignOpts) => SignatureType; | ||
| verify: ( | ||
| signature: Hex | SignatureType, | ||
| msgHash: Hex, | ||
| publicKey: Hex, | ||
| opts?: { lowS?: boolean } | ||
| ) => boolean; | ||
| Point: PointConstructor; | ||
| ProjectivePoint: ProjectivePointConstructor; | ||
| Signature: SignatureConstructor; | ||
| utils: { | ||
| isValidPrivateKey(privateKey: PrivKey): boolean; | ||
| hashToPrivateKey: (hash: Hex) => Uint8Array; | ||
| randomPrivateKey: () => Uint8Array; | ||
| }; | ||
| function hash_to_field(msg: Uint8Array, count: number, options: htfOpts): bigint[][]; | ||
| type htfOpts = { | ||
| DST: string; // a domain separation tag defined in section 2.2.5 | ||
| // p: the characteristic of F | ||
| // where F is a finite field of characteristic p and order q = p^m | ||
| p: bigint; | ||
| // m: the extension degree of F, m >= 1 | ||
| // where F is a finite field of characteristic p and order q = p^m | ||
| m: number; | ||
| k: number; // the target security level for the suite in bits defined in section 5.1 | ||
| expand?: 'xmd' | 'xof'; // option to use a message that has already been processed by expand_message_xmd | ||
| // Hash functions for: expand_message_xmd is appropriate for use with a | ||
| // wide range of hash functions, including SHA-2, SHA-3, BLAKE2, and others. | ||
| // BBS+ uses blake2: https://github.com/hyperledger/aries-framework-go/issues/2247 | ||
| // TODO: verify that hash is shake if expand==='xof' via types | ||
| hash: CHash; | ||
| }; | ||
| ``` | ||
| ### abstract/hash-to-curve: Hashing strings to curve points | ||
| The module allows to hash arbitrary strings to elliptic curve points. | ||
| - `expand_message_xmd` [(spec)](https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-hash-to-curve-11#section-5.4.1) produces a uniformly random byte string using a cryptographic hash function H that outputs b bits.. | ||
| ```ts | ||
| function expand_message_xmd( | ||
| msg: Uint8Array, | ||
| DST: Uint8Array, | ||
| lenInBytes: number, | ||
| H: CHash | ||
| ): Uint8Array; | ||
| function expand_message_xof( | ||
| msg: Uint8Array, | ||
| DST: Uint8Array, | ||
| lenInBytes: number, | ||
| k: number, | ||
| H: CHash | ||
| ): Uint8Array; | ||
| ``` | ||
| - `hash_to_field(msg, count, options)` [(spec)](https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-hash-to-curve-11#section-5.3) | ||
| hashes arbitrary-length byte strings to a list of one or more elements of a finite field F. | ||
| _ `msg` a byte string containing the message to hash | ||
| _ `count` the number of elements of F to output | ||
| _ `options` `{DST: string, p: bigint, m: number, k: number, expand: 'xmd' | 'xof', hash: H}` | ||
| _ Returns `[u_0, ..., u_(count - 1)]`, a list of field elements. | ||
| ```ts | ||
| function hash_to_field(msg: Uint8Array, count: number, options: htfOpts): bigint[][]; | ||
| type htfOpts = { | ||
| // DST: a domain separation tag | ||
| // defined in section 2.2.5 | ||
| DST: string; | ||
| // p: the characteristic of F | ||
| // where F is a finite field of characteristic p and order q = p^m | ||
| p: bigint; | ||
| // m: the extension degree of F, m >= 1 | ||
| // where F is a finite field of characteristic p and order q = p^m | ||
| m: number; | ||
| // k: the target security level for the suite in bits | ||
| // defined in section 5.1 | ||
| k: number; | ||
| // option to use a message that has already been processed by | ||
| // expand_message_xmd | ||
| expand?: 'xmd' | 'xof'; | ||
| // Hash functions for: expand_message_xmd is appropriate for use with a | ||
| // wide range of hash functions, including SHA-2, SHA-3, BLAKE2, and others. | ||
| // BBS+ uses blake2: https://github.com/hyperledger/aries-framework-go/issues/2247 | ||
| // TODO: verify that hash is shake if expand==='xof' via types | ||
| hash: CHash; | ||
| }; | ||
| ``` | ||
| ### abstract/poseidon: Poseidon hash | ||
@@ -399,5 +518,5 @@ | ||
| There are many poseidon instances with different constants. We don't provide them, | ||
| but we provide ability to specify them manually. For actual usage, check out | ||
| stark curve source code. | ||
| There are many poseidon variants with different constants. | ||
| We don't provide them: you should construct them manually. | ||
| The only variant provided resides in `stark` module: inspect it for proper usage. | ||
@@ -420,23 +539,31 @@ ```ts | ||
| ### abstract/modular | ||
| ### abstract/bls | ||
| Modular arithmetics utilities. | ||
| The module abstracts BLS (Barreto-Lynn-Scott) primitives. In theory you should be able to write BLS12-377, BLS24, | ||
| and others with it. | ||
| ```typescript | ||
| import { Fp, mod, invert, div, invertBatch, sqrt } from '@noble/curves/abstract/modular'; | ||
| const fp = Fp(2n ** 255n - 19n); // Finite field over 2^255-19 | ||
| fp.mul(591n, 932n); | ||
| fp.pow(481n, 11024858120n); | ||
| ### abstract/modular: Modular arithmetics utilities | ||
| The module also contains useful `hashToPrivateScalar` method which allows to create | ||
| scalars (e.g. private keys) with the modulo bias being neglible. It follows | ||
| FIPS 186 B.4.1. Requires at least 40 bytes of input for 32-byte private key. | ||
| ```ts | ||
| import * as mod from '@noble/curves/abstract/modular'; | ||
| const fp = mod.Field(2n ** 255n - 19n); // Finite field over 2^255-19 | ||
| fp.mul(591n, 932n); // multiplication | ||
| fp.pow(481n, 11024858120n); // exponentiation | ||
| fp.div(5n, 17n); // division: 5/17 mod 2^255-19 == 5 * invert(17) | ||
| fp.sqrt(21n); // square root | ||
| // Generic non-FP utils are also available | ||
| mod(21n, 10n); // 21 mod 10 == 1n; fixed version of 21 % 10 | ||
| invert(17n, 10n); // invert(17) mod 10; modular multiplicative inverse | ||
| div(5n, 17n, 10n); // 5/17 mod 10 == 5 * invert(17) mod 10; division | ||
| invertBatch([1n, 2n, 4n], 21n); // => [1n, 11n, 16n] in one inversion | ||
| sqrt(21n, 73n); // √21 mod 73; square root | ||
| mod.mod(21n, 10n); // 21 mod 10 == 1n; fixed version of 21 % 10 | ||
| mod.invert(17n, 10n); // invert(17) mod 10; modular multiplicative inverse | ||
| mod.invertBatch([1n, 2n, 4n], 21n); // => [1n, 11n, 16n] in one inversion | ||
| mod.hashToPrivateScalar(sha512_of_something, secp256r1.n); | ||
| ``` | ||
| ### abstract/utils | ||
| ### abstract/utils: General utilities | ||
| ```typescript | ||
| ```ts | ||
| import * as utils from '@noble/curves/abstract/utils'; | ||
@@ -454,3 +581,2 @@ | ||
| utils.nLength(255n); | ||
| utils.hashToPrivateScalar(sha512_of_something, secp256r1.n); | ||
| utils.equalBytes(Uint8Array.from([0xde]), Uint8Array.from([0xde])); | ||
@@ -463,76 +589,98 @@ ``` | ||
| [Timing attack](https://en.wikipedia.org/wiki/Timing_attack) considerations: _JIT-compiler_ and _Garbage Collector_ make "constant time" extremely hard to achieve in a scripting language. Which means _any other JS library can't have constant-timeness_. Even statically typed Rust, a language without GC, [makes it harder to achieve constant-time](https://www.chosenplaintext.ca/open-source/rust-timing-shield/security) for some cases. If your goal is absolute security, don't use any JS lib — including bindings to native ones. Use low-level libraries & languages. Nonetheless we're targetting algorithmic constant time. | ||
| [Timing attack](https://en.wikipedia.org/wiki/Timing_attack) considerations: we are using non-CT bigints. However, _JIT-compiler_ and _Garbage Collector_ make "constant time" extremely hard to achieve in a scripting language. Which means _any other JS library can't have constant-timeness_. Even statically typed Rust, a language without GC, [makes it harder to achieve constant-time](https://www.chosenplaintext.ca/open-source/rust-timing-shield/security) for some cases. If your goal is absolute security, don't use any JS lib — including bindings to native ones. Use low-level libraries & languages. Nonetheless we're targetting algorithmic constant time. | ||
| We consider infrastructure attacks like rogue NPM modules very important; that's why it's crucial to minimize the amount of 3rd-party dependencies & native bindings. If your app uses 500 dependencies, any dep could get hacked and you'll be downloading malware with every `npm install`. Our goal is to minimize this attack vector. | ||
| We consider infrastructure attacks like rogue NPM modules very important; that's why it's crucial to minimize the amount of 3rd-party dependencies & native bindings. If your app uses 500 dependencies, any dep could get hacked and you'll be downloading malware with every `npm install`. Our goal is to minimize this attack vector. As for devDependencies used by the library: | ||
| - `@scure` base, bip32, bip39 (used in tests), micro-bmark (benchmark), micro-should (testing) are developed by us | ||
| and follow the same practices such as: minimal library size, auditability, signed releases | ||
| - prettier (linter), fast-check (property-based testing), | ||
| typescript versions are locked and rarely updated. Every update is checked with `npm-diff`. | ||
| The packages are big, which makes it hard to audit their source code thoroughly and fully. | ||
| - They are only used if you clone the git repo and want to add some feature to it. End-users won't use them. | ||
| ## Speed | ||
| Benchmark results on Apple M2 with node v18.10: | ||
| Benchmark results on Apple M2 with node v19: | ||
| ``` | ||
| secp256k1 | ||
| init x 57 ops/sec @ 17ms/op | ||
| getPublicKey x 4,946 ops/sec @ 202μs/op | ||
| sign x 3,914 ops/sec @ 255μs/op | ||
| verify x 682 ops/sec @ 1ms/op | ||
| getSharedSecret x 427 ops/sec @ 2ms/op | ||
| recoverPublicKey x 683 ops/sec @ 1ms/op | ||
| schnorr.sign x 539 ops/sec @ 1ms/op | ||
| schnorr.verify x 716 ops/sec @ 1ms/op | ||
| init x 58 ops/sec @ 17ms/op | ||
| getPublicKey x 5,640 ops/sec @ 177μs/op | ||
| sign x 3,909 ops/sec @ 255μs/op | ||
| verify x 780 ops/sec @ 1ms/op | ||
| getSharedSecret x 465 ops/sec @ 2ms/op | ||
| recoverPublicKey x 740 ops/sec @ 1ms/op | ||
| schnorr.sign x 597 ops/sec @ 1ms/op | ||
| schnorr.verify x 775 ops/sec @ 1ms/op | ||
| P256 | ||
| init x 30 ops/sec @ 32ms/op | ||
| getPublicKey x 5,008 ops/sec @ 199μs/op | ||
| sign x 3,970 ops/sec @ 251μs/op | ||
| verify x 515 ops/sec @ 1ms/op | ||
| init x 31 ops/sec @ 31ms/op | ||
| getPublicKey x 5,607 ops/sec @ 178μs/op | ||
| sign x 3,930 ops/sec @ 254μs/op | ||
| verify x 540 ops/sec @ 1ms/op | ||
| P384 | ||
| init x 14 ops/sec @ 66ms/op | ||
| getPublicKey x 2,434 ops/sec @ 410μs/op | ||
| sign x 1,942 ops/sec @ 514μs/op | ||
| verify x 206 ops/sec @ 4ms/op | ||
| init x 15 ops/sec @ 63ms/op | ||
| getPublicKey x 2,622 ops/sec @ 381μs/op | ||
| sign x 1,913 ops/sec @ 522μs/op | ||
| verify x 222 ops/sec @ 4ms/op | ||
| P521 | ||
| init x 7 ops/sec @ 126ms/op | ||
| getPublicKey x 1,282 ops/sec @ 779μs/op | ||
| sign x 1,077 ops/sec @ 928μs/op | ||
| verify x 110 ops/sec @ 9ms/op | ||
| init x 8 ops/sec @ 119ms/op | ||
| getPublicKey x 1,371 ops/sec @ 729μs/op | ||
| sign x 1,090 ops/sec @ 917μs/op | ||
| verify x 118 ops/sec @ 8ms/op | ||
| ed25519 | ||
| init x 37 ops/sec @ 26ms/op | ||
| getPublicKey x 8,147 ops/sec @ 122μs/op | ||
| sign x 3,979 ops/sec @ 251μs/op | ||
| verify x 848 ops/sec @ 1ms/op | ||
| init x 47 ops/sec @ 20ms/op | ||
| getPublicKey x 9,414 ops/sec @ 106μs/op | ||
| sign x 4,516 ops/sec @ 221μs/op | ||
| verify x 912 ops/sec @ 1ms/op | ||
| ed448 | ||
| init x 17 ops/sec @ 58ms/op | ||
| getPublicKey x 3,083 ops/sec @ 324μs/op | ||
| sign x 1,473 ops/sec @ 678μs/op | ||
| verify x 323 ops/sec @ 3ms/op | ||
| init x 17 ops/sec @ 56ms/op | ||
| getPublicKey x 3,363 ops/sec @ 297μs/op | ||
| sign x 1,615 ops/sec @ 619μs/op | ||
| verify x 319 ops/sec @ 3ms/op | ||
| stark | ||
| init x 35 ops/sec @ 28ms/op | ||
| pedersen x 884 ops/sec @ 1ms/op | ||
| poseidon x 8,598 ops/sec @ 116μs/op | ||
| verify x 528 ops/sec @ 1ms/op | ||
| bls12-381 | ||
| init x 30 ops/sec @ 33ms/op | ||
| getPublicKey x 788 ops/sec @ 1ms/op | ||
| sign x 45 ops/sec @ 21ms/op | ||
| verify x 32 ops/sec @ 30ms/op | ||
| pairing x 88 ops/sec @ 11ms/op | ||
| stark | ||
| init x 31 ops/sec @ 31ms/op | ||
| pedersen | ||
| ├─old x 84 ops/sec @ 11ms/op | ||
| └─noble x 802 ops/sec @ 1ms/op | ||
| poseidon x 7,466 ops/sec @ 133μs/op | ||
| verify | ||
| ├─old x 300 ops/sec @ 3ms/op | ||
| └─noble x 474 ops/sec @ 2ms/op | ||
| init x 32 ops/sec @ 30ms/op | ||
| getPublicKey 1-bit x 858 ops/sec @ 1ms/op | ||
| getPublicKey x 858 ops/sec @ 1ms/op | ||
| sign x 49 ops/sec @ 20ms/op | ||
| verify x 34 ops/sec @ 28ms/op | ||
| pairing x 94 ops/sec @ 10ms/op | ||
| aggregatePublicKeys/8 x 116 ops/sec @ 8ms/op | ||
| aggregatePublicKeys/32 x 31 ops/sec @ 31ms/op | ||
| aggregatePublicKeys/128 x 7 ops/sec @ 125ms/op | ||
| aggregateSignatures/8 x 45 ops/sec @ 22ms/op | ||
| aggregateSignatures/32 x 11 ops/sec @ 84ms/op | ||
| aggregateSignatures/128 x 3 ops/sec @ 332ms/opp | ||
| ``` | ||
| ## In the wild | ||
| Elliptic curve calculator: [paulmillr.com/ecc](https://paulmillr.com/ecc). | ||
| - secp256k1 | ||
| - [btc-signer](https://github.com/paulmillr/micro-btc-signer), [eth-signer](https://github.com/paulmillr/micro-eth-signer) | ||
| - ed25519 | ||
| - [sol-signer](https://github.com/paulmillr/micro-sol-signer) | ||
| - BLS12-381 | ||
| - Threshold sigs demo [genthresh.com](https://genthresh.com) | ||
| - BBS signatures [github.com/Wind4Greg/BBS-Draft-Checks](https://github.com/Wind4Greg/BBS-Draft-Checks) following [draft-irtf-cfrg-bbs-signatures-latest](https://identity.foundation/bbs-signature/draft-irtf-cfrg-bbs-signatures.html) | ||
| ## Upgrading | ||
| If you're coming from single-curve noble packages, the following changes need to be kept in mind: | ||
| If you're coming from single-feature noble packages, the following changes need to be kept in mind: | ||
| - 2d affine (x, y) points have been removed to reduce complexity and improve speed | ||
| - Removed `number` support as a type for private keys. `bigint` is still supported | ||
| - `mod`, `invert` are no longer present in `utils`. Use `@noble/curves/abstract/modular.js` now. | ||
| - Removed `number` support as a type for private keys, `bigint` is still supported | ||
| - `mod`, `invert` are no longer present in `utils`: use `@noble/curves/abstract/modular` | ||
@@ -539,0 +687,0 @@ Upgrading from @noble/secp256k1 1.7: |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by125.54%
1335286
- Dev dependency count
- decreased by-11.11%
8
- Number of package files
- increased by126.32%
172
- Lines of code
- increased by48.94%
18392
- Number of lines in readme file
- increased by26.33%
710
Worsened metrics
- Number of medium supply chain risk alerts
- increased byInfinity%
1
No dependency changes