feat: support zeroize codegen

Cargo.toml

@@ -16,9 +16,10 @@ edition = "2021"
 [dependencies]
 bitvec = { version = "1", default-features = false, optional = true }
 byteorder = { version = "1", default-features = false, optional = true }
-ff_derive = { version = "0.13", path = "ff_derive", optional = true }
+ff_derive = { version = "0.13.0", path = "ff_derive", optional = true }
 rand_core = { version = "0.6", default-features = false }
 subtle = { version = "2.2.1", default-features = false, features = ["i128"] }
+zeroize = { version = "1", default-features = false, optional = true }
 
 [dev-dependencies]
 blake2b_simd = "1"
@@ -28,16 +29,22 @@ rand = "0.8"
 default = ["bits", "std"]
 alloc = []
 bits = ["bitvec"]
+zero = ["zeroize"]
 derive = ["byteorder", "ff_derive"]
 std = ["alloc"]
 # with MSRV 1.60 this could be merged into bits with ff_derive?/bits
 # see PR#72 for more information.
-derive_bits = ["bits", "ff_derive/bits"]
+derive_bits = ["bits", "derive", "ff_derive/bits"]
+derive_zero = ["zero", "derive", "ff_derive/zero"]
 
 [[test]]
 name = "derive"
 required-features = ["derive"]
 
+[[test]]
+name = "derive_zero"
+required-features = ["derive_zero"]
+
 [badges]
 maintenance = { status = "actively-developed" }
 

ff_derive/Cargo.toml

@@ -15,6 +15,8 @@ edition = "2021"
 [features]
 # enabled when generating bitvec code utilizing the version of ff's bitvec
 bits = []
+# enabled when generating zeroize code utilizing the version of ff's zeroize
+zero = []
 
 [lib]
 proc-macro = true

ff_derive/src/lib.rs

@@ -332,6 +332,14 @@ fn prime_field_repr_impl(
 ) -> proc_macro2::TokenStream {
     let repr_iter_be = endianness.iter_be();
 
+    let prime_field_repr_zero_impl = if cfg!(feature = "zero") {
+        Some(quote! {
+            impl ::zeroize::DefaultIsZeroes for #repr {}
+        })
+    } else {
+        None
+    };
+
     quote! {
         #[derive(Copy, Clone)]
         pub struct #repr(pub [u8; #bytes]);
@@ -386,6 +394,8 @@ fn prime_field_repr_impl(
                 &mut self.0
             }
         }
+
+        #prime_field_repr_zero_impl
     }
 }
 
@@ -942,6 +952,14 @@ fn prime_field_impl(
         }
     };
 
+    let prime_field_zero_impl = if cfg!(feature = "zero") {
+        Some(quote! {
+            impl ::zeroize::DefaultIsZeroes for #name {}
+        })
+    } else {
+        None
+    };
+
     let top_limb_index = limbs - 1;
 
     quote! {
@@ -1261,6 +1279,7 @@ fn prime_field_impl(
         }
 
         #prime_field_bits_impl
+        #prime_field_zero_impl
 
         impl ::ff::Field for #name {
             const ZERO: Self = #name([0; #limbs]);

tests/derive_zero.rs

@@ -0,0 +1,28 @@
+//! This module exercises the `ff_derive` procedural macros, specifically to ensure
+//! zeroize works
+
+#[macro_use]
+extern crate ff;
+
+/// The BLS12-381 scalar field.
+#[derive(PrimeField)]
+#[PrimeFieldModulus = "52435875175126190479447740508185965837690552500527637822603658699938581184513"]
+#[PrimeFieldGenerator = "7"]
+#[PrimeFieldReprEndianness = "little"]
+struct Bls381K12Scalar([u64; 4]);
+
+#[test]
+fn zeroize() {
+    use ff::{Field, PrimeField};
+    use rand::rngs::OsRng;
+    use zeroize::Zeroize;
+
+    let mut f = Bls381K12Scalar::random(OsRng);
+    let mut r = f.to_repr();
+
+    f.zeroize();
+    assert_eq!(f, Bls381K12Scalar::ZERO);
+
+    r.zeroize();
+    assert_eq!(r, Default::default());
+}