Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ZenGo-X/curv
Rust language general purpose elliptic curve cryptography.
https://github.com/ZenGo-X/curv
bignumber cryptography elliptic-curves rust zero-knowledge-proofs
Last synced: 6 days ago
JSON representation
Rust language general purpose elliptic curve cryptography.
- Host: GitHub
- URL: https://github.com/ZenGo-X/curv
- Owner: ZenGo-X
- License: mit
- Created: 2018-07-12T17:29:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-03T01:26:02.000Z (about 1 year ago)
- Last Synced: 2024-04-25T21:43:55.544Z (7 months ago)
- Topics: bignumber, cryptography, elliptic-curves, rust, zero-knowledge-proofs
- Language: Rust
- Homepage:
- Size: 1.09 MB
- Stars: 265
- Watchers: 17
- Forks: 109
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Audit: audit/kzen-curv-audit final 03.01.2019.pdf
Awesome Lists containing this project
README
[](https://app.travis-ci.com/ZenGo-X/curv)
[](https://crates.io/crates/curv-kzen)
[](https://docs.rs/curv-kzen)
[](LICENSE)
[](https://deps.rs/repo/github/ZenGo-X/curv)
Curv
=====================================
Curv contains an extremely simple interface to onboard new elliptic curves.
Use this library for general purpose elliptic curve cryptography.
The library has a built in support for some useful operations/primitives such as verifiable secret sharing, commitment
schemes, zero knowledge proofs, and simple two party protocols such as ECDH and coin flip. The library comes with
serialize/deserialize support to be used in higher level code to implement networking.
### Usage
To use `curv` crate, add the following to your Cargo.toml:
```toml
[dependencies]
curv-kzen = "0.9"
```
The crate will be available under `curv` name, e.g.:
```rust
use curv::elliptic::curves::*;
```
### Currently Supported Elliptic Curves
| Curve | low level library | curve description |
|-------------------------------|------------------------|------------------------|
| **Secp256k1** | [rust-secp256k1](https://github.com/rust-bitcoin/rust-secp256k1) | [bitcoin wiki](https://en.bitcoin.it/wiki/Secp256k1) |
| **P-256** | [RustCrypto](https://crates.io/crates/p256) | [NIST.FIPS.186.4](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf) |
| **Ed25519** | [cryptoxide](https://github.com/typed-io/cryptoxide/blob/master/src/curve25519.rs) | [BDLSY11](https://ed25519.cr.yp.to/ed25519-20110926.pdf) |
| **Ristretto** | [curve25519-dalek](https://github.com/dalek-cryptography/curve25519-dalek) | [ristretto group](https://ristretto.group/) |
| **BLS12-381** | [bls12-381](https://crates.io/crates/bls12_381) | [BLS12-381 For The Rest Of Us](https://hackmd.io/@benjaminion/bls12-381) |
### Security
The library was audited by [Kudelski security](https://www.kudelskisecurity.com/) on Feb19. The report can be found
[here](https://github.com/KZen-networks/curv/tree/master/audit). No critical issue were found and all issues found
were fixed.
The code was reviewed independently by few other cryptographers. Special thanks goes to [Claudio Orlandi](http://cs.au.dk/~orlandi/)
from Aarhus University.
In general security of the library is strongly dependent on the security of the low level libraries used. We chose only
libraries that are used as part of other big projects and went through heavy audit/review.
The library is not immune to side channel attacks but considerable effort was given to try and catch as many such
attacks as possible (see audit report).
### Build
Use `cargo build` to build everything including curve implementations, cryptoprimitives, BigInt, etc.
### Big integer implementation
The library supports a couple of bigint implementations and can easily switch between them.
You can choose any one which you prefer by specifying a feature:
* **rust-gmp-kzen**, uses GMP bindings, requires GMP to be installed on a machine. Used by default.
* **num-bigint**, Rust's pure implementation of big integer. In order to use it, put in Cargo.toml:
```toml
[dependencies.curv-kzen]
version = "0.8"
default-features = false
features = ["num-bigint"]
```
**_Warning:_** `num-bigint` support is experimental and should not be used in production. For this
bigint implementation, we use prime numbers generator which is not considered secure.
### Examples
The library includes some basic examples to get you going. To run them:
`cargo run --example EXAMPLE_NAME -- CURVE_NAME`
for example: `cargo run --example proof_of_knowledge_of_dlog -- secp256k1`
### Docs
To build docs, use:
```bash
cargo doc
RUSTDOCFLAGS="--html-in-header katex-header.html" cargo doc --no-deps --open
```
### License
Curv is released under the terms of the MIT license. See [LICENSE](LICENSE) for more information.
### Development Process & Contact
This library is maintained by ZenGo-X. Contributions are highly welcomed! Besides GitHub issues and PRs, feel free to [reach out](mailto:[email protected]) by mail or join ZenGo X [Telegram](https://t.me/joinchat/ET1mddGXRoyCxZ-7) for discussions on code and research.