milksad
/
rust-secp256k1-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-secp256k1-unsafe-fast/README.md

72 lines
3.7 KiB
Markdown
Raw Normal View History

Improve the README files Improve the secp256k1 readme by: - Use a top level markdown header (level 1) - Add a link to the SECG's website (www.secg.org) - Add a link for `secp256k1` to bitcoin.it explaining the curve Improve the secp256k1-sys readme by: - Mirror secp256k1 readme badges, heading, docs link - Basic cleanup - Use 100 column width - Use backticks - Use capitals
2022-12-16 00:09:16 +00:00
<div align="center">
<h1>Rust Secp256k1</h1>
Add Travis build status to README
2015-04-05 17:37:49 +00:00
Improve the README files Improve the secp256k1 readme by: - Use a top level markdown header (level 1) - Add a link to the SECG's website (www.secg.org) - Add a link for `secp256k1` to bitcoin.it explaining the curve Improve the secp256k1-sys readme by: - Mirror secp256k1 readme badges, heading, docs link - Basic cleanup - Use 100 column width - Use backticks - Use capitals
2022-12-16 00:09:16 +00:00
<p>
<a href="https://crates.io/crates/secp256k1"><img alt="Crate Info" src="https://img.shields.io/crates/v/secp256k1.svg"/></a>
<a href="https://github.com/rust-bitcoin/rust-secp256k1/blob/master/LICENSE"><img alt="CC0 1.0 Universal Licensed" src="https://img.shields.io/badge/license-CC0--1.0-blue.svg"/></a>
<a href="https://github.com/rust-bitcoin/rust-secp256k1/actions?query=workflow%3AContinuous%20integration"><img alt="CI Status" src="https://github.com/rust-bitcoin/rust-secp256k1/workflows/Continuous%20integration/badge.svg"></a>
<a href="https://docs.rs/secp256k1"><img alt="API Docs" src="https://img.shields.io/badge/docs.rs-secp256k1-green"/></a>
<a href="https://blog.rust-lang.org/2020/02/27/Rust-1.48.0.html"><img alt="Rustc Version 1.48.0+" src="https://img.shields.io/badge/rustc-1.48.0%2B-lightgrey.svg"/></a>
</p>
</div>
bump version to 0.10.0; introduce CHANGELOG.md
2018-07-25 22:05:06 +00:00
Improve the README files Improve the secp256k1 readme by: - Use a top level markdown header (level 1) - Add a link to the SECG's website (www.secg.org) - Add a link for `secp256k1` to bitcoin.it explaining the curve Improve the secp256k1-sys readme by: - Mirror secp256k1 readme badges, heading, docs link - Basic cleanup - Use 100 column width - Use backticks - Use capitals
2022-12-16 00:09:16 +00:00
`rust-secp256k1` is a wrapper around [libsecp256k1](https://github.com/bitcoin-core/secp256k1), a C
library implementing various cryptographic functions using the [SECG](https://www.secg.org/) curve
[secp256k1](https://en.bitcoin.it/wiki/Secp256k1).
This library:
Add README
2015-04-04 17:30:07 +00:00
* 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`
Make note about non-allocations
2015-04-05 16:45:40 +00:00
* makes no allocations (except in unit tests) for efficiency and use in freestanding implementations
Add README
2015-04-04 17:30:07 +00:00
bump version to 0.10.0; introduce CHANGELOG.md
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.
Bump MSRV to 1.48 We are upgrading the MSRV across the whole Rust Bitcoin ecosystem. Update the README, clippy config file, and CI to use the new MSRV. Changes to use the new MSRV will be done later. Add mention of MSRV to `secp256k1-sys`, add unreleased section to both changelogs.
2023-03-30 22:18:02 +00:00
* This library should always compile with any combination of features on **Rust 1.48.0**.
replace `fuzztarget` Cargo feature with a rustc --cfg flag It's super dangerous to use Cargo features for this, since they can be set accidentally (or maliciously by any crate in a user's entire dep tree). Instead we can just require users set `RUSTFLAGS` appropriately, which we can easily do in our fuzzing scripts.
2020-12-22 15:42:02 +00:00
Add githooks Add `githooks` directory and: - Copy the default pre-commit hook into new githooks directory - Add a call to clippy to the pre-commit hook - Add a section to the README instructing devs how to use the new githooks
2022-06-10 02:58:39 +00:00
### Githooks
To assist devs in catching errors _before_ running CI we provide some githooks. If you do not
already have locally configured githooks you can use the ones in this repository by running, in the
root directory of the repository:
```
git config --local core.hooksPath githooks/
```
Alternatively add symlinks in your `.git/hooks` directory to any of the githooks we provide.
Create configuration conditional bench As we did in rust-bitcoin [0] create a configuration conditional `bench` that we can use to guard bench mark code. This has the benefit of making our features additive i.e., we can now test with `--all-features` with a stable toolchain (currently this fails because of our use of the `test` crate). [0] - https://github.com/rust-bitcoin/rust-bitcoin/pull/1092
2022-07-13 04:40:49 +00:00
### Benchmarks
We use a custom Rust compiler configuration conditional to guard the bench mark code. To run the
bench marks use: `RUSTFLAGS='--cfg=bench' cargo +nightly bench --features=recovery`.
implement "non_secure_erase" methods This PR implements a `non_secure_erase()` method on SecretKey, KeyPair, SharedSecret, Scalar, and DisplaySecret. The purpose of this method is to (attempt to) overwrite secret data with valid default values. This method can be used by libraries to implement Zeroize on structs containing secret values. `non_secure_erase()` attempts to avoid being optimized away or reordered using the same mechanism as the zeroize crate: first, using `std::ptr::write_volatile` (which will not be optimized away) to overwrite the memory, then using a memory fence to prevent subtle issues due to load or store reordering. Note, however, that this method is *very unlikely* to do anything useful on its own. Effective use involves carefully placing these values inside non-Copy structs and pinning those structs in place. See the [`zeroize`](https://docs.rs/zeroize) documentation for tips and tricks, and for further discussion. [this commit includes a squashed-in commit from tcharding to fix docs and helpful suggestions from apoelstra and Kixunil]
2023-02-20 18:36:32 +00:00
### A note on `non_secure_erase`
Rename KeyPair to Keypair We use "keypair" in identifiers (local vars and function names) but `KeyPair` - one of them is wrong. Elect to follow upstream and define keypair as a single word i.e., use `Keypair` for type name and `keypair` in identifiers. This patch can be reproduced mechanically by doing two search-and-replace operations on all files excluding the CHANGELOG - Replace "KeyPair" with "Keypair" - Replace "key_pair" with "keypair"
2023-08-18 22:28:42 +00:00
This crate's secret types (`SecretKey`, `Keypair`, `SharedSecret`, `Scalar`, and `DisplaySecret`)
implement "non_secure_erase" methods This PR implements a `non_secure_erase()` method on SecretKey, KeyPair, SharedSecret, Scalar, and DisplaySecret. The purpose of this method is to (attempt to) overwrite secret data with valid default values. This method can be used by libraries to implement Zeroize on structs containing secret values. `non_secure_erase()` attempts to avoid being optimized away or reordered using the same mechanism as the zeroize crate: first, using `std::ptr::write_volatile` (which will not be optimized away) to overwrite the memory, then using a memory fence to prevent subtle issues due to load or store reordering. Note, however, that this method is *very unlikely* to do anything useful on its own. Effective use involves carefully placing these values inside non-Copy structs and pinning those structs in place. See the [`zeroize`](https://docs.rs/zeroize) documentation for tips and tricks, and for further discussion. [this commit includes a squashed-in commit from tcharding to fix docs and helpful suggestions from apoelstra and Kixunil]
2023-02-20 18:36:32 +00:00
have a method called `non_secure_erase` that *attempts* to overwrite the contained secret. This
method is provided to assist other libraries in building secure secret erasure. However, this
library makes no guarantees about the security of using `non_secure_erase`. In particular,
the compiler doesn't have any concept of secrets and in most cases can arbitrarily move or copy
values anywhere it pleases. For more information, consult the [`zeroize`](https://docs.rs/zeroize)
documentation.
replace `fuzztarget` Cargo feature with a rustc --cfg flag It's super dangerous to use Cargo features for this, since they can be set accidentally (or maliciously by any crate in a user's entire dep tree). Instead we can just require users set `RUSTFLAGS` appropriately, which we can easily do in our fuzzing scripts.
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
change --cfg=fuzzing to --cfg=secp256k1_fuzz
2023-04-26 15:16:26 +00:00
`--cfg=secp256k1_fuzz` in your `RUSTFLAGS` variable.
rename `rust_secp_fuzz` to `fuzzing`
2021-01-11 19:14:42 +00:00
change --cfg=fuzzing to --cfg=secp256k1_fuzz
2023-04-26 15:16:26 +00:00
Note that `cargo hfuzz` does **not** set this config flag automatically. In 0.27.0
and earlier versions, we used the `--cfg=fuzzing` which honggfuzz does set, but we
changed this because there was no way to override it.
replace `fuzztarget` Cargo feature with a rustc --cfg flag It's super dangerous to use Cargo features for this, since they can be set accidentally (or maliciously by any crate in a user's entire dep tree). Instead we can just require users set `RUSTFLAGS` appropriately, which we can easily do in our fuzzing scripts.
2020-12-22 15:42:02 +00:00