Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 23 additions & 95 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,15 @@ subtle = { version = "2.2.1", default-features = false, features = ["i128"] }
[dev-dependencies]
blake2b_simd = "1"
rand = "0.9"
zeroize = { version = "1", default-features = false }

[features]
default = ["bits", "std"]
alloc = []
bits = ["bitvec", "ff_derive?/bits"]
derive = ["byteorder", "ff_derive"]
std = ["alloc"]
test_derive_zeroize = ["derive", "ff_derive/zeroize"]

[[test]]
name = "derive"
Expand Down
2 changes: 2 additions & 0 deletions ff_derive/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ repository = "https://github.com/zkcrypto/ff"
# enabled when generating bitvec code utilizing the version of ff's bitvec
# ff/bits enables this
bits = []
# enabled when generating zeroize bindings
zeroize = []

[lib]
proc-macro = true
Expand Down
19 changes: 19 additions & 0 deletions ff_derive/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,14 @@ fn prime_field_repr_impl(
) -> proc_macro2::TokenStream {
let repr_iter_be = endianness.iter_be();

let prime_field_repr_zeroize_impl = if cfg!(feature = "zeroize") {
Some(quote! {
impl ::zeroize::DefaultIsZeroes for #repr {}
})
} else {
None
};

quote! {
#[derive(Copy, Clone)]
pub struct #repr(pub [u8; #bytes]);
Expand Down Expand Up @@ -386,6 +394,8 @@ fn prime_field_repr_impl(
&mut self.0
}
}

#prime_field_repr_zeroize_impl
}
}

Expand Down Expand Up @@ -934,6 +944,14 @@ fn prime_field_impl(
None
};

let prime_field_zeroize_impl = if cfg!(feature = "zeroize") {
Some(quote! {
impl ::zeroize::DefaultIsZeroes for #name {}
})
} else {
None
};

let top_limb_index = limbs - 1;

quote! {
Expand Down Expand Up @@ -1253,6 +1271,7 @@ fn prime_field_impl(
}

#prime_field_bits_impl
#prime_field_zeroize_impl

impl ::ff::Field for #name {
const ZERO: Self = #name([0; #limbs]);
Expand Down
17 changes: 17 additions & 0 deletions tests/derive.rs
Original file line number Diff line number Diff line change
Expand Up @@ -155,3 +155,20 @@ fn sqrt() {
test(Fp::ONE);
test(Fp::random(&mut rand::rng()));
}

#[cfg(feature = "test_derive_zeroize")]
#[test]
fn zeroize() {
use ff::{Field, PrimeField};
use rand::{rngs::OsRng, TryRngCore};
use zeroize::Zeroize;

let mut f = Bls381K12Scalar::random(&mut OsRng.unwrap_err());
let mut r = f.to_repr();

f.zeroize();
assert_eq!(f, Bls381K12Scalar::ZERO);

r.zeroize();
assert_eq!(r, Default::default());
}