2018-03-18 18:45:38 +00:00
[![Build Status ](https://travis-ci.org/rust-bitcoin/rust-secp256k1.png?branch=master )](https://travis-ci.org/rust-bitcoin/rust-secp256k1)
2015-04-05 17:37:49 +00:00
2018-07-25 22:05:06 +00:00
[Full documentation ](https://docs.rs/secp256k1/ )
2015-04-04 17:30:07 +00:00
### rust-secp256k1
2020-11-25 22:41:02 +00:00
`rust-secp256k1` is a wrapper around [libsecp256k1 ](https://github.com/bitcoin-core/secp256k1 ),
2018-07-24 21:16:52 +00:00
a C library by Pieter Wuille for producing ECDSA signatures using the SECG curve
2015-04-04 17:30:07 +00:00
`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`
2015-04-05 16:45:40 +00:00
* makes no allocations (except in unit tests) for efficiency and use in freestanding implementations
2015-04-04 17:30:07 +00:00
2018-07-25 22:05:06 +00:00
### 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.
2021-09-14 15:46:20 +00:00
* This library should always compile with any combination of features on **Rust 1.41.1** .
2020-12-22 15:42:02 +00:00
## 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
2021-01-11 19:14:42 +00:00
`--cfg=fuzzing` in your `RUSTFLAGS` variable.
Note that `cargo hfuzz` sets this config flag automatically.
2020-12-22 15:42:02 +00:00