Skip to content
This repository has been archived by the owner on Jan 4, 2023. It is now read-only.
/ ff-zeroize Public archive
forked from zkcrypto/ff

This is a fork of zkcrypto/ff crate with zeroize feature

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

algorand/ff-zeroize

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

This is a fork of zkcrypto/ff crate with zeroize feature

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages

  • Rust 100.0%