Custom fork of rust-secp256k1 with unsafe modifications for higher speed. Unsuitable for production.
Go to file
Andrew Poelstra 91eea119b3
Merge pull request #256 from rust-bitcoin/workspace
Make test.sh test and build secp256k1-sys
2020-12-23 17:58:34 +00:00
.github/workflows switch from travis to github workflows 2020-11-10 23:58:03 +00:00
contrib Make test.sh test and build secp256k1-sys 2020-12-23 12:01:34 +02:00
examples Aded an example for recoverable signatures and recovering the pubkey 2019-10-28 22:23:56 +02:00
no_std_test Adopt no-std tests to new preacllocated_* functions 2020-12-18 12:48:19 +02:00
secp256k1-sys add warning about fuzzing being enabled 2020-12-22 17:34:50 +00:00
src Merge pull request #259 from p2pderivatives/implement-low-r-signing 2020-12-22 23:28:34 +00:00
.gitignore Added ECMULT window size 2019-07-03 17:48:35 -04:00
CHANGELOG.md Update MSRV to 1.29; increase version to 0.19 and -sys version to 0.3 2020-08-27 14:18:06 +00:00
Cargo.toml Make test.sh test and build secp256k1-sys 2020-12-23 12:01:34 +02:00
LICENSE Remove the MIT/CC0 license in favor of just CC0 2015-03-25 18:36:30 -05:00
Makefile Initial (failing) implementation. 2014-07-06 22:41:22 -07:00
README.md replace `fuzztarget` Cargo feature with a rustc --cfg flag 2020-12-22 15:42:02 +00:00

README.md

Build Status

Full documentation

rust-secp256k1

rust-secp256k1 is a wrapper around libsecp256k1, a C library by Pieter Wuille for producing ECDSA signatures using the SECG curve secp256k1. This library

  • exposes type-safe Rust bindings for all libsecp256k1 functions
  • implements key generation
  • implements deterministic nonce generation via RFC6979
  • implements many unit tests, adding to those already present in libsecp256k1
  • makes no allocations (except in unit tests) for efficiency and use in freestanding implementations

Contributing

Contributions to this library are welcome. A few guidelines:

  • Any breaking changes must have an accompanied entry in CHANGELOG.md
  • No new dependencies, please.
  • No crypto should be implemented in Rust, with the possible exception of hash functions. Cryptographic contributions should be directed upstream to libsecp256k1.
  • This library should always compile with any combination of features on Rust 1.29.

A note on Rust 1.29 support

The build dependency cc might require a more recent version of the Rust compiler. To ensure compilation with Rust 1.29.0, pin its version in your Cargo.lock with cargo update -p cc --precise 1.0.41. If you're using secp256k1 in a library, to make sure it compiles in CI, you'll need to generate a lockfile first. Example for Travis CI:

before_script:
  - if [ "$TRAVIS_RUST_VERSION" == "1.29.0" ]; then
    cargo generate-lockfile --verbose && cargo update -p cc --precise "1.0.41" --verbose;
    fi

Fuzzing

If you want to fuzz this library, or any library which depends on it, you will probably want to disable the actual cryptography, since fuzzers are unable to forge signatures and therefore won't test many interesting codepaths. To instead use a trivially-broken but fuzzer-accessible signature scheme, compile with --cfg=rust_secp_fuzz in your RUSTFLAGS variable.