Skip to content

Commit e7fc61f

Browse files
committed
Merge #228: Simple dedicated -zkp README
4d9d8f9 Simple dedicated -zkp README (Tim Ruffing) Pull request description: ACKs for top commit: jonasnick: ACK 4d9d8f9 Tree-SHA512: bae7aafed0d524d2fea956261547ca094dbaa4b444b56b6f3fb947764cc5647b5eec82ac392f988df3d3d88d1357ae2aa34550c7a596b386a2d0a774f9764661
2 parents 050d9b2 + 4d9d8f9 commit e7fc61f

File tree

1 file changed

+19
-68
lines changed

1 file changed

+19
-68
lines changed

README.md

+19-68
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,36 @@
1-
libsecp256k1
2-
============
3-
4-
[![Build Status](https://api.cirrus-ci.com/github/bitcoin-core/secp256k1.svg?branch=master)](https://cirrus-ci.com/github/bitcoin-core/secp256k1)
5-
6-
Optimized C library for ECDSA signatures and secret/public key operations on curve secp256k1.
7-
8-
This library is intended to be the highest quality publicly available library for cryptography on the secp256k1 curve. However, the primary focus of its development has been for usage in the Bitcoin system and usage unlike Bitcoin's may be less well tested, verified, or suffer from a less well thought out interface. Correct usage requires some care and consideration that the library is fit for your application's purpose.
9-
10-
Features:
11-
* secp256k1 ECDSA signing/verification and key generation.
12-
* Additive and multiplicative tweaking of secret/public keys.
13-
* Serialization/parsing of secret keys, public keys, signatures.
14-
* Constant time, constant memory access signing and public key generation.
15-
* Derandomized ECDSA (via RFC6979 or with a caller provided function.)
16-
* Very efficient implementation.
17-
* Suitable for embedded systems.
18-
* Optional module for public key recovery.
19-
* Optional module for ECDH key exchange.
20-
* Optional module for Schnorr signatures according to [BIP-340](https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki).
21-
* Optional module for ECDSA adaptor signatures (experimental).
22-
23-
Experimental features have not received enough scrutiny to satisfy the standard of quality of this library but are made available for testing and review by the community. The APIs of these features should not be considered stable.
24-
25-
Implementation details
26-
----------------------
27-
28-
* General
29-
* No runtime heap allocation.
30-
* Extensive testing infrastructure.
31-
* Structured to facilitate review and analysis.
32-
* Intended to be portable to any system with a C89 compiler and uint64_t support.
33-
* No use of floating types.
34-
* Expose only higher level interfaces to minimize the API surface and improve application security. ("Be difficult to use insecurely.")
35-
* Field operations
36-
* Optimized implementation of arithmetic modulo the curve's field size (2^256 - 0x1000003D1).
37-
* Using 5 52-bit limbs (including hand-optimized assembly for x86_64, by Diederik Huys).
38-
* Using 10 26-bit limbs (including hand-optimized assembly for 32-bit ARM, by Wladimir J. van der Laan).
39-
* This is an experimental feature that has not received enough scrutiny to satisfy the standard of quality of this library but is made available for testing and review by the community.
40-
* Scalar operations
41-
* Optimized implementation without data-dependent branches of arithmetic modulo the curve's order.
42-
* Using 4 64-bit limbs (relying on __int128 support in the compiler).
43-
* Using 8 32-bit limbs.
44-
* Modular inverses (both field elements and scalars) based on [safegcd](https://gcd.cr.yp.to/index.html) with some modifications, and a variable-time variant (by Peter Dettman).
45-
* Group operations
46-
* Point addition formula specifically simplified for the curve equation (y^2 = x^3 + 7).
47-
* Use addition between points in Jacobian and affine coordinates where possible.
48-
* Use a unified addition/doubling formula where necessary to avoid data-dependent branches.
49-
* Point/x comparison without a field inversion by comparison in the Jacobian coordinate space.
50-
* Point multiplication for verification (a*P + b*G).
51-
* Use wNAF notation for point multiplicands.
52-
* Use a much larger window for multiples of G, using precomputed multiples.
53-
* Use Shamir's trick to do the multiplication with the public key and the generator simultaneously.
54-
* Use secp256k1's efficiently-computable endomorphism to split the P multiplicand into 2 half-sized ones.
55-
* Point multiplication for signing
56-
* Use a precomputed table of multiples of powers of 16 multiplied with the generator, so general multiplication becomes a series of additions.
57-
* Intended to be completely free of timing sidechannels for secret-key operations (on reasonable hardware/toolchains)
58-
* Access the table with branch-free conditional moves so memory access is uniform.
59-
* No data-dependent branches
60-
* Optional runtime blinding which attempts to frustrate differential power analysis.
61-
* The precomputed tables add and eventually subtract points for which no known scalar (secret key) is known, preventing even an attacker with control over the secret key used to control the data internally.
1+
libsecp256k1-zkp
2+
================
3+
4+
[![Build Status](https://api.cirrus-ci.com/github/BlockstreamResearch/secp256k1-zkp.svg?branch=master)](https://cirrus-ci.com/github/BlockstreamResearch/secp256k1-zkp)
5+
6+
A fork of [libsecp256k1](https://github.com/bitcoin-core/secp256k1) with support for advanced and experimental features such as Confidential Assets and MuSig2
7+
8+
Added features:
9+
* Experimental module for ECDSA adaptor signatures.
10+
* Experimental module for ECDSA sign-to-contract.
11+
* Experimental module for [MuSig2](src/modules/musig/musig.md).
12+
* Experimental module for Confidential Assets (Pedersen commitments, range proofs, and [surjection proofs](src/modules/surjection/surjection.md)).
13+
* Experimental module for Bulletproofs++ range proofs.
14+
* Experimental module for [address whitelisting](src/modules/whitelist/whitelist.md).
15+
16+
Experimental features are made available for testing and review by the community. The APIs of these features should not be considered stable.
6217

6318
Build steps
6419
-----------
6520

66-
libsecp256k1 is built using autotools:
21+
libsecp256k1-zkp is built using autotools:
6722

6823
$ ./autogen.sh
6924
$ ./configure
7025
$ make
7126
$ make check # run the test suite
7227
$ sudo make install # optional
7328

74-
To compile optional modules (such as Schnorr signatures), you need to run `./configure` with additional flags (such as `--enable-module-schnorrsig`). Run `./configure --help` to see the full list of available flags.
29+
To compile optional modules (such as Schnorr signatures), you need to run `./configure` with additional flags (such as `--enable-module-schnorrsig`). Run `./configure --help` to see the full list of available flags. For experimental modules, you will also need `--enable-experimental` as well as a flag for each individual module, e.g. `--enable-module-musig`.
7530

7631
Usage examples
7732
-----------
7833
Usage examples can be found in the [examples](examples) directory. To compile them you need to configure with `--enable-examples`.
79-
* [ECDSA example](examples/ecdsa.c)
80-
* [Schnorr signatures example](examples/schnorr.c)
81-
* [Deriving a shared secret (ECDH) example](examples/ecdh.c)
82-
To compile the Schnorr signature and ECDH examples, you also need to configure with `--enable-module-schnorrsig` and `--enable-module-ecdh`.
8334

8435
Test coverage
8536
-----------
@@ -105,7 +56,7 @@ To create a HTML report with coloured and annotated source code:
10556

10657
Benchmark
10758
------------
108-
If configured with `--enable-benchmark` (which is the default), binaries for benchmarking the libsecp256k1 functions will be present in the root directory after the build.
59+
If configured with `--enable-benchmark` (which is the default), binaries for benchmarking the libsecp256k1-zkp functions will be present in the root directory after the build.
10960

11061
To print the benchmark result to the command line:
11162

0 commit comments

Comments
 (0)