feat(crypto): add no_std support to crypto

lambdaclass · Dec 28, 2023 · 34406e0 · 34406e0
1 parent f96448c
commit 34406e0
Show file tree

Hide file tree

Showing 53 changed files with 186 additions and 88 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,9 +11,9 @@ repository = "https://github.com/lambdaclass/lambdaworks"
 
 [workspace.dependencies]
 iai-callgrind = "0.3.1"
-lambdaworks-crypto = { path = "./crypto", version = "0.3.0" }
+lambdaworks-crypto = { path = "./crypto", version = "0.3.0", default-features = false }
 lambdaworks-gpu = { path = "./gpu", version = "0.3.0" }
-lambdaworks-math = { path = "./math", version = "0.3.0" }
+lambdaworks-math = { path = "./math", version = "0.3.0", default-features = false }
 stark-platinum-prover = { path = "./provers/stark", version = "0.3.0" }
 cairo-platinum-prover = { path = "./provers/cairo", version = "0.3.0" }
 

diff --git a/benches/Cargo.toml b/benches/Cargo.toml
@@ -14,6 +14,7 @@ starknet-ff = { git = "https://github.com/xJonathanLEI/starknet-rs" }
 
 [dependencies.lambdaworks-math]
 path = "../math"
+features = ["std"]
 
 [dev-dependencies]
 criterion = { version = "0.5.1", default-features = false }

diff --git a/crypto/Cargo.toml b/crypto/Cargo.toml
@@ -8,11 +8,13 @@ license.workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-lambdaworks-math.workspace = true
-sha3 = "0.10"
-sha2 = "0.10"
-thiserror = "1.0.38"
-serde = { version = "1.0", features = ["derive"] }
+lambdaworks-math = { workspace = true, features = ["alloc"] }
+sha3 = { version = "0.10", default-features = false }
+sha2 = { version = "0.10", default-features = false }
+thiserror-no-std = { version = "2.0.2", default-features = false }
+
+# Optional
+serde = { version = "1.0", default-features = false, features = ["derive"], optional = true }
 rayon = { version = "1.8.0", optional = true }
 
 [dev-dependencies]
@@ -21,6 +23,9 @@ iai-callgrind.workspace = true
 rand = "0.8.5"
 
 [features]
+default = ["std"]
+std = ["lambdaworks-math/std", "thiserror-no-std/std", "serde?/std", "sha2/std", "sha3/std"]
+serde = ["dep:serde", "lambdaworks-math/lambdaworks-serde-binary"]
 test_fiat_shamir = []
 parallel = ["dep:rayon"]
 

diff --git a/crypto/src/commitments/kzg.rs b/crypto/src/commitments/kzg.rs
@@ -1,6 +1,8 @@
-use crate::errors::SrsFromFileError;
+use alloc::borrow::ToOwned;
+use alloc::vec::Vec;
 
 use super::traits::IsCommitmentScheme;
+use core::{marker::PhantomData, mem};
 use lambdaworks_math::{
     cyclic_group::IsGroup,
     elliptic_curve::traits::IsPairing,
@@ -11,7 +13,6 @@ use lambdaworks_math::{
     traits::{Deserializable, Serializable},
     unsigned_integer::element::UnsignedInteger,
 };
-use std::{marker::PhantomData, mem};
 
 #[derive(PartialEq, Clone, Debug)]
 pub struct StructuredReferenceString<G1Point, G2Point> {
@@ -32,12 +33,13 @@ where
     }
 }
 
+#[cfg(feature = "std")]
 impl<G1Point, G2Point> StructuredReferenceString<G1Point, G2Point>
 where
     G1Point: IsGroup + Deserializable,
     G2Point: IsGroup + Deserializable,
 {
-    pub fn from_file(file_path: &str) -> Result<Self, SrsFromFileError> {
+    pub fn from_file(file_path: &str) -> Result<Self, crate::errors::SrsFromFileError> {
         let bytes = std::fs::read(file_path)?;
         Ok(Self::deserialize(&bytes)?)
     }

diff --git a/crypto/src/fiat_shamir/default_transcript.rs b/crypto/src/fiat_shamir/default_transcript.rs
@@ -1,4 +1,5 @@
 use super::transcript::Transcript;
+use alloc::borrow::ToOwned;
 use sha3::{Digest, Keccak256};
 
 pub struct DefaultTranscript {

diff --git a/crypto/src/hash/hash_to_field.rs b/crypto/src/hash/hash_to_field.rs
@@ -1,3 +1,5 @@
+use alloc::string::String;
+use alloc::{vec, vec::Vec};
 use lambdaworks_math::{
     field::{
         element::FieldElement,

diff --git a/crypto/src/hash/poseidon/mod.rs b/crypto/src/hash/poseidon/mod.rs
@@ -1,3 +1,5 @@
+use alloc::borrow::ToOwned;
+use alloc::{vec, vec::Vec};
 use lambdaworks_math::field::element::FieldElement as FE;
 
 pub mod parameters;

diff --git a/crypto/src/hash/sha3/mod.rs b/crypto/src/hash/sha3/mod.rs
@@ -1,3 +1,5 @@
+use alloc::string::{String, ToString};
+use alloc::vec::Vec;
 use sha3::{Digest, Sha3_256};
 
 pub struct Sha3Hasher;

diff --git a/crypto/src/lib.rs b/crypto/src/lib.rs
@@ -1,4 +1,10 @@
+#![cfg_attr(not(feature = "std"), no_std)]
+
+#[macro_use]
+extern crate alloc;
+
 pub mod commitments;
+#[cfg(feature = "std")]
 pub mod errors;
 pub mod fiat_shamir;
 pub mod hash;

diff --git a/crypto/src/merkle_tree/backends/field_element.rs b/crypto/src/merkle_tree/backends/field_element.rs
@@ -1,6 +1,7 @@
 use crate::hash::poseidon::Poseidon;
 
 use crate::merkle_tree::traits::IsMerkleTreeBackend;
+use core::marker::PhantomData;
 use lambdaworks_math::{
     field::{element::FieldElement, traits::IsField},
     traits::Serializable,
@@ -9,7 +10,7 @@ use sha3::{
     digest::{generic_array::GenericArray, OutputSizeUser},
     Digest,
 };
-use std::marker::PhantomData;
+
 #[derive(Clone)]
 pub struct FieldElementBackend<F, D: Digest, const NUM_BYTES: usize> {
     phantom1: PhantomData<F>,

diff --git a/crypto/src/merkle_tree/backends/field_element_vector.rs b/crypto/src/merkle_tree/backends/field_element_vector.rs
@@ -1,4 +1,5 @@
-use std::marker::PhantomData;
+use alloc::vec::Vec;
+use core::marker::PhantomData;
 
 use crate::hash::poseidon::Poseidon;
 use crate::merkle_tree::traits::IsMerkleTreeBackend;

diff --git a/crypto/src/merkle_tree/merkle.rs b/crypto/src/merkle_tree/merkle.rs
@@ -1,13 +1,22 @@
 use super::{proof::Proof, traits::IsMerkleTreeBackend, utils::*};
+use alloc::{vec, vec::Vec};
+use thiserror_no_std::Error;
 
-#[derive(Clone, serde::Serialize, serde::Deserialize)]
+#[derive(Clone)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct MerkleTree<B: IsMerkleTreeBackend> {
     pub root: B::Node,
     nodes: Vec<B::Node>,
 }
 
 const ROOT: usize = 0;
 
+#[derive(Debug, Error)]
+pub enum Error {
+    #[error("Accessed node was out of boud")]
+    OutOfBounds,
+}
+
 impl<B> MerkleTree<B>
 where
     B: IsMerkleTreeBackend,
@@ -46,14 +55,14 @@ where
         Some(Proof { merkle_path })
     }
 
-    fn build_merkle_path(&self, pos: usize) -> Result<Vec<B::Node>, std::io::Error> {
+    fn build_merkle_path(&self, pos: usize) -> Result<Vec<B::Node>, Error> {
         let mut merkle_path = Vec::new();
         let mut pos = pos;
 
         while pos != ROOT {
             let Some(node) = self.nodes.get(sibling_index(pos)) else {
                 // out of bounds, exit returning the current merkle_path
-                return Err(std::io::Error::from(std::io::ErrorKind::InvalidInput));
+                return Err(Error::OutOfBounds);
             };
             merkle_path.push(node.clone());
 

diff --git a/crypto/src/merkle_tree/proof.rs b/crypto/src/merkle_tree/proof.rs
@@ -1,3 +1,4 @@
+use alloc::vec::Vec;
 use lambdaworks_math::{
     errors::DeserializationError,
     traits::{Deserializable, Serializable},
@@ -10,7 +11,8 @@ use super::traits::IsMerkleTreeBackend;
 /// `merkle_path` field, in such a way that, if the merkle tree is of height `n`, the
 /// `i`-th element of `merkle_path` is the sibling node in the `n - 1 - i`-th check
 /// when verifying.
-#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Proof<T: PartialEq + Eq> {
     pub merkle_path: Vec<T>,
 }

diff --git a/crypto/src/merkle_tree/test_merkle.rs b/crypto/src/merkle_tree/test_merkle.rs
@@ -1,4 +1,4 @@
-use std::marker::PhantomData;
+use core::marker::PhantomData;
 
 use lambdaworks_math::field::{element::FieldElement, traits::IsField};
 

diff --git a/crypto/src/merkle_tree/traits.rs b/crypto/src/merkle_tree/traits.rs
@@ -1,3 +1,5 @@
+use alloc::vec::Vec;
+
 #[cfg(feature = "parallel")]
 use rayon::prelude::{IntoParallelRefIterator, ParallelIterator};
 

diff --git a/crypto/src/merkle_tree/utils.rs b/crypto/src/merkle_tree/utils.rs
@@ -1,4 +1,5 @@
 use super::traits::IsMerkleTreeBackend;
+use alloc::vec::Vec;
 
 pub fn sibling_index(node_index: usize) -> usize {
     if node_index % 2 == 0 {

diff --git a/ensure-no_std/Cargo.toml b/ensure-no_std/Cargo.toml
@@ -5,7 +5,9 @@ edition = "2021"
 
 
 [dependencies]
-lambdaworks-math = { path = "../math", default-features = false }
+wee_alloc = "0.4.5"
+lambdaworks-math = { path = "../math", default-features = false, features = ["alloc", "lambdaworks-serde-binary", "lambdaworks-serde-string"] }
+lambdaworks-crypto = { path = "../crypto", default-features = false, features = ["serde"] }
 
 [profile.dev]
 panic = "abort"

diff --git a/ensure-no_std/src/main.rs b/ensure-no_std/src/main.rs
@@ -14,5 +14,10 @@ fn panic(_info: &PanicInfo) -> ! {
     loop {}
 }
 
+#[global_allocator]
+static ALLOC: wee_alloc::WeeAlloc = wee_alloc::WeeAlloc::INIT;
+
+#[allow(unused_imports)]
+use lambdaworks_crypto;
 #[allow(unused_imports)]
 use lambdaworks_math;
diff --git a/examples/merkle-tree-cli/Cargo.toml b/examples/merkle-tree-cli/Cargo.toml
@@ -11,8 +11,8 @@ path = "src/main.rs"
 
 [dependencies]
 clap = { version = "4.4.6", features = ["derive"] }
-lambdaworks-crypto = { workspace = true }
-lambdaworks-math = { workspace = true, features = ["lambdaworks-serde-string"] }
+lambdaworks-crypto = { workspace = true, features = ["std"] }
+lambdaworks-math = { workspace = true, features = ["std", "lambdaworks-serde-string"] }
 serde = { version = "1.0" }
 serde_json = "1"
 bincode = { version = "2.0.0-rc.2", tag = "v2.0.0-rc.2", git = "https://github.com/bincode-org/bincode.git", features= ['serde'] }
diff --git a/fuzz/Cargo.toml b/fuzz/Cargo.toml
@@ -8,7 +8,7 @@ publish = false
 version = "0.1.1"
 
 [workspace.dependencies]
-lambdaworks-math = { path = "../math" }
+lambdaworks-math = { path = "../math", features = ["std"] }
 lambdaworks-gpu = { path = "../gpu" }
 stark-platinum-prover = { path = "../provers/stark" }
 libfuzzer-sys = "0.4"

diff --git a/fuzz/cuda_fuzz/Cargo.toml b/fuzz/cuda_fuzz/Cargo.toml
@@ -7,7 +7,7 @@ edition.workspace = true
 cargo-fuzz = true
 
 [dependencies]
-lambdaworks-math = { workspace = true, features = ["cuda"] }
+lambdaworks-math = { workspace = true, features = ["std", "cuda"] }
 lambdaworks-gpu = { workspace = true, features = ["cuda"] }
 honggfuzz = "0.5.55"
 

diff --git a/fuzz/metal_fuzz/Cargo.toml b/fuzz/metal_fuzz/Cargo.toml
@@ -7,7 +7,7 @@ edition.workspace = true
 cargo-fuzz = true
 
 [dependencies]
-lambdaworks-math = { workspace = true, features = ["metal"] }
+lambdaworks-math = { workspace = true, features = ["std", "metal"] }
 lambdaworks-gpu = { workspace = true, features = ["metal"] }
 libfuzzer-sys = { workspace = true }
 

diff --git a/fuzz/no_gpu_fuzz/Cargo.toml b/fuzz/no_gpu_fuzz/Cargo.toml
@@ -7,7 +7,7 @@ edition.workspace = true
 cargo-fuzz = true
 
 [dependencies]
-lambdaworks-math = { workspace = true }
+lambdaworks-math = { workspace = true, features = ["std"] }
 lambdaworks-gpu = { workspace = true }
 libfuzzer-sys = { workspace = true }
 stark-platinum-prover = { workspace = true }

diff --git a/math/Cargo.toml b/math/Cargo.toml
@@ -8,9 +8,9 @@ license.workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-thiserror = { version = "1.0", optional = true }
-serde = { version = "1.0", features = ["derive"], optional = true }
-serde_json = { version = "1.0", optional = true }
+thiserror-no-std = { version = "2.0.2", default-features = false }
+serde = { version = "1.0", features = ["derive"], default-features = false, optional = true }
+serde_json = { version = "1.0", default-features = false, optional = true }
 proptest = { version = "1.1.0", optional = true }
 winter-math = { package = "winter-math", version = "0.6.4", default-features = false, optional = true }
 miden-core = { package = "miden-core" , version = "0.7", default-features = false, optional = true }
@@ -39,9 +39,10 @@ pprof = { version = "0.13.0", features = ["criterion","flamegraph"] }
 [features]
 rayon = ["dep:rayon"]
 default = ["rayon", "std"]
-std = ["dep:thiserror"]
-lambdaworks-serde-binary = ["dep:serde", "std"]
-lambdaworks-serde-string = ["dep:serde", "dep:serde_json", "std"]
+std = ["thiserror-no-std/std", "alloc", "serde?/std", "serde_json?/std"]
+alloc = ["serde?/alloc", "serde_json?/alloc"]
+lambdaworks-serde-binary = ["dep:serde", "alloc"]
+lambdaworks-serde-string = ["dep:serde", "dep:serde_json", "alloc"]
 proptest = ["dep:proptest"]
 winter_compatibility = ["winter-math", "miden-core"]
 

diff --git a/math/src/elliptic_curve/short_weierstrass/curves/bls12_381/field_extension.rs b/math/src/elliptic_curve/short_weierstrass/curves/bls12_381/field_extension.rs
@@ -11,6 +11,9 @@ use crate::field::{
 use crate::traits::ByteConversion;
 use crate::unsigned_integer::element::U384;
 
+#[cfg(feature = "alloc")]
+use alloc::vec::Vec;
+
 pub const BLS12381_PRIME_FIELD_ORDER: U384 = U384::from_hex_unchecked("1a0111ea397fe69a4b1ba7b6434bacd764774b84f38512bf6730d2a0f6b0f6241eabfffeb153ffffb9feffffffffaaab");
 
 // FPBLS12381
@@ -143,21 +146,21 @@ impl IsSubFieldOf<Degree2ExtensionField> for BLS12381PrimeField {
         [FieldElement::from_raw(a), FieldElement::zero()]
     }
 
-    #[cfg(feature = "std")]
+    #[cfg(feature = "alloc")]
     fn to_subfield_vec(b: <Degree2ExtensionField as IsField>::BaseType) -> Vec<Self::BaseType> {
         b.into_iter().map(|x| x.to_raw()).collect()
     }
 }
 
 impl ByteConversion for FieldElement<Degree2ExtensionField> {
-    #[cfg(feature = "std")]
+    #[cfg(feature = "alloc")]
     fn to_bytes_be(&self) -> Vec<u8> {
         let mut byte_slice = ByteConversion::to_bytes_be(&self.value()[0]);
         byte_slice.extend(ByteConversion::to_bytes_be(&self.value()[1]));
         byte_slice
     }
 
-    #[cfg(feature = "std")]
+    #[cfg(feature = "alloc")]
     fn to_bytes_le(&self) -> Vec<u8> {
         let mut byte_slice = ByteConversion::to_bytes_le(&self.value()[0]);
         byte_slice.extend(ByteConversion::to_bytes_le(&self.value()[1]));

diff --git a/math/src/fft/errors.rs b/math/src/fft/errors.rs
@@ -1,5 +1,5 @@
 use crate::field::errors::FieldError;
-use thiserror::Error;
+use thiserror_no_std::Error;
 
 #[cfg(feature = "metal")]
 use lambdaworks_gpu::metal::abstractions::errors::MetalError;

diff --git a/math/src/field/element.rs b/math/src/field/element.rs
@@ -6,6 +6,8 @@ use crate::traits::ByteConversion;
 use crate::unsigned_integer::element::UnsignedInteger;
 use crate::unsigned_integer::montgomery::MontgomeryAlgorithms;
 use crate::unsigned_integer::traits::IsUnsignedInteger;
+#[cfg(feature = "alloc")]
+use alloc::vec::Vec;
 use core::fmt;
 use core::fmt::Debug;
 use core::iter::Sum;
@@ -41,7 +43,7 @@ pub struct FieldElement<F: IsField> {
     value: F::BaseType,
 }
 
-#[cfg(feature = "std")]
+#[cfg(feature = "alloc")]
 impl<F: IsField> FieldElement<F> {
     // Source: https://en.wikipedia.org/wiki/Modular_multiplicative_inverse#Multiple_inverses
     pub fn inplace_batch_inverse(numbers: &mut [Self]) -> Result<(), FieldError> {