add serde support

Cargo.toml

@@ -33,6 +33,7 @@ prost = "^0.12.4"
 prost-build = "^0.12.3"
 rand = "^0.8.5"
 rand_chacha = "^0.3.1"
+serde = "1.0.217"
 sha2 = "^0.10.8"
 thiserror = "^1.0.58"
 zeroize = "^1.8.0"

crates/fhe-math/Cargo.toml

@@ -13,6 +13,7 @@ rust-version.workspace = true
 bench = false  # Disable default bench (we use criterion)
 
 [features]
+serde = ["dep:serde", "ndarray/serde", "num-bigint/serde", "rand/serde1", "rand_chacha/serde"]
 concrete-ntt = []
 concrete-ntt-nightly = ["concrete-ntt/nightly"]
 
@@ -30,12 +31,13 @@ num-bigint.workspace = true
 num-bigint-dig.workspace = true
 num-traits.workspace = true
 prost.workspace = true
-pulp = "^0.18.9"
+pulp = { git = "https://github.com/zefr0x/pulp.git", branch = "implserde", features = ["serde"] }
 rand.workspace = true
 rand_chacha.workspace = true
 thiserror.workspace = true
 zeroize.workspace = true
 zeroize_derive.workspace = true
+serde = { workspace = true, optional = true }
 sha2.workspace = true
 
 [build-dependencies]

crates/fhe-math/src/ntt/native.rs

@@ -5,6 +5,7 @@ use rand_chacha::ChaCha8Rng;
 use std::iter::successors;
 
 /// Number-Theoretic Transform operator.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct NttOperator {
     p: Modulus,

crates/fhe-math/src/rns/mod.rs

@@ -15,6 +15,7 @@ mod scaler;
 pub use scaler::{RnsScaler, ScalingFactor};
 
 /// Context for a Residue Number System.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Default, Clone, PartialEq, Eq)]
 pub struct RnsContext {
     moduli_u64: Vec<u64>,

crates/fhe-math/src/rns/scaler.rs

@@ -11,6 +11,7 @@ use num_traits::{One, ToPrimitive, Zero};
 use std::{cmp::min, sync::Arc};
 
 /// Scaling factor when performing a RNS scaling.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
 pub struct ScalingFactor {
     numerator: BigUint,
@@ -41,6 +42,7 @@ impl ScalingFactor {
 
 /// Scaler for a RNS context.
 /// This is a helper struct to perform RNS scaling.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
 pub struct RnsScaler {
     from: Arc<RnsContext>,

crates/fhe-math/src/rq/context.rs

@@ -5,6 +5,7 @@ use std::{fmt::Debug, sync::Arc};
 use crate::{ntt::NttOperator, rns::RnsContext, zq::Modulus, Error, Result};
 
 /// Struct that holds the context associated with elements in rq.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Default, Clone, PartialEq, Eq)]
 pub struct Context {
     pub(crate) moduli: Box<[u64]>,

crates/fhe-math/src/rq/mod.rs

@@ -25,6 +25,7 @@ use std::sync::Arc;
 use zeroize::{Zeroize, Zeroizing};
 
 /// Possible representations of the underlying polynomial.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
 pub enum Representation {
     /// This is the list of coefficients ci, such that the polynomial is c0 + c1
@@ -39,6 +40,7 @@ pub enum Representation {
 }
 
 /// An exponent for a substitution.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Debug, PartialEq, Eq)]
 pub struct SubstitutionExponent {
     /// The value of the exponent.
@@ -76,6 +78,7 @@ impl SubstitutionExponent {
 }
 
 /// Struct that holds a polynomial for a specific context.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
 pub struct Poly {
     ctx: Arc<Context>,

crates/fhe-math/src/rq/scaler.rs

@@ -12,6 +12,7 @@ use ndarray::{s, Array2, Axis};
 use std::sync::Arc;
 
 /// Context extender.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
 pub struct Scaler {
     from: Arc<Context>,

crates/fhe-math/src/zq/mod.rs

@@ -25,6 +25,7 @@ const fn const_time_cond_select(on_true: u64, on_false: u64, cond: bool) -> u64
 /// Structure encapsulating an integer modulus up to 62 bits.
 #[derive(Derivative)]
 #[derivative(PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Debug, Clone)]
 pub struct Modulus {
     pub(crate) p: u64,

crates/fhe/Cargo.toml

@@ -13,6 +13,7 @@ rust-version.workspace = true
 bench = false # Disable default bench (we use criterion)
 
 [features]
+serde = ["dep:serde", "ndarray/serde", "num-bigint/serde", "rand/serde1", "rand_chacha/serde", "fhe-math/serde"]
 concrete-ntt = ["fhe-math/concrete-ntt"]
 concrete-ntt-nightly = ["fhe-math/concrete-ntt-nightly"]
 
@@ -28,6 +29,7 @@ num-traits.workspace = true
 prost.workspace = true
 rand.workspace = true
 rand_chacha.workspace = true
+serde = { workspace = true, optional = true }
 zeroize.workspace = true
 zeroize_derive.workspace = true
 ndarray.workspace = true

crates/fhe/src/bfv/ciphertext.rs

@@ -14,6 +14,7 @@ use std::ops::{Deref, DerefMut};
 use std::sync::Arc;
 
 /// A ciphertext encrypting a plaintext.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct Ciphertext {
     /// The parameters of the underlying BFV encryption scheme.

crates/fhe/src/bfv/encoding.rs

@@ -4,6 +4,7 @@ use std::fmt::Display;
 
 use fhe_traits::FhePlaintextEncoding;
 
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Debug, Clone, Eq, PartialEq)]
 pub(crate) enum EncodingEnum {
     Poly,
@@ -17,6 +18,7 @@ impl Display for EncodingEnum {
 }
 
 /// An encoding for the plaintext.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Debug, Clone, Eq, PartialEq)]
 pub struct Encoding {
     pub(crate) encoding: EncodingEnum,

crates/fhe/src/bfv/keys/evaluation_key.rs

@@ -19,6 +19,7 @@ use zeroize::{Zeroize, ZeroizeOnDrop};
 /// - row rotation
 /// - oblivious expansion
 /// - inner sum
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Debug, PartialEq, Eq)]
 pub struct EvaluationKey {
     par: Arc<BfvParameters>,

crates/fhe/src/bfv/keys/galois_key.rs

@@ -15,6 +15,7 @@ use zeroize::Zeroizing;
 /// Galois key for the BFV encryption scheme.
 /// A Galois key is a special type of key switching key,
 /// which switch from `s(x^i)` to `s(x)` where `s(x)` is the secret key.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Debug, PartialEq, Eq)]
 pub struct GaloisKey {
     pub(crate) element: SubstitutionExponent,

crates/fhe/src/bfv/keys/key_switching_key.rs

@@ -18,6 +18,7 @@ use std::sync::Arc;
 use zeroize::Zeroizing;
 
 /// Key switching key for the BFV encryption scheme.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Debug, PartialEq, Eq, Clone)]
 pub struct KeySwitchingKey {
     /// The parameters of the underlying BFV encryption scheme.

crates/fhe/src/bfv/keys/public_key.rs

@@ -14,6 +14,7 @@ use zeroize::Zeroizing;
 use super::SecretKey;
 
 /// Public key for the BFV encryption scheme.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Debug, PartialEq, Eq, Clone)]
 pub struct PublicKey {
     pub(crate) par: Arc<BfvParameters>,

crates/fhe/src/bfv/keys/relinearization_key.rs

@@ -19,6 +19,7 @@ use zeroize::Zeroizing;
 /// Relinearization key for the BFV encryption scheme.
 /// A relinearization key is a special type of key switching key,
 /// which switch from `s^2` to `s` where `s` is the secret key.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Debug, PartialEq, Eq, Clone)]
 pub struct RelinearizationKey {
     pub(crate) ksk: KeySwitchingKey,