ff-zeroize

Crates.ioff-zeroize
lib.rsff-zeroize
version0.6.3
sourcesrc
created_at2020-03-26 20:13:13.32172
updated_at2020-03-26 20:54:31.681031
descriptionLibrary for building and interfacing with finite fields
homepagehttps://github.com/algorand/ff-zeroize
repositoryhttps://github.com/algorand/ff-zeroize
max_upload_size
id223228
size27,328
Riad S. Wahby (kwantam)

documentation

https://docs.rs/ff-zeroize/

README

ff-zeroize

  • ff-zeroize is a temporary crate that enables zeroize features for ffcrate
  • ff is a finite field library written in pure Rust, with no unsafe{} code.

Disclaimers

  • This library does not provide constant-time guarantees.

Usage

Add the ff crate to your Cargo.toml:

[dependencies]
ff_zeroize = "0.6.1"

The ff crate contains Field, PrimeField, PrimeFieldRepr and SqrtField traits. See the documentation for more.

![derive(PrimeField)]

If you need an implementation of a prime field, this library also provides a procedural macro that will expand into an efficient implementation of a prime field when supplied with the modulus. PrimeFieldGenerator must be an element of Fp of p-1 order, that is also quadratic nonresidue.

First, enable the derive crate feature:

[dependencies]
ff_zeroize = { version = "0.6.1", features = ["derive"] }

And then use the macro like so:

extern crate rand;
#[macro_use]
extern crate ff;

#[derive(PrimeField)]
#[PrimeFieldModulus = "52435875175126190479447740508185965837690552500527637822603658699938581184513"]
#[PrimeFieldGenerator = "7"]
struct Fp(FpRepr);

And that's it! Fp now implements Field and PrimeField. Fp will also implement SqrtField if supported. The library implements FpRepr itself and derives PrimeFieldRepr for it.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 62

cargo fmt