Feat/batching

.github/workflows/benches.yml

@@ -4,10 +4,16 @@ run-name: Benchmark on ${{ github.ref_name }} - ${{ github.sha }}
 
 on: workflow_dispatch
 
+env:
+  REDIS_HOST: "redis"
+  POSTGRES_HOST: "postgres"
+
 jobs:
   bench:
-    uses: Cosmian/reusable_workflows/.github/workflows/cargo-bench.yml@develop
+    uses: Cosmian/reusable_workflows/.github/workflows/cargo-bench.yml@fix/add_hosts_arguments
     with:
-      toolchain: stable
-      features: test-utils,redis-mem,sqlite-mem,rust-mem,postgres-mem
+      toolchain: 1.87.0
+      features: test-utils,redis-mem,sqlite-mem,postgres-mem
       force: true
+      redis-host: "redis"
+      postgres-host: "postgres"

.github/workflows/ci.yml

@@ -7,14 +7,34 @@ jobs:
   cargo-lint:
     uses: Cosmian/reusable_workflows/.github/workflows/cargo-nursery.yml@develop
     with:
-      toolchain: stable
+      toolchain: 1.87.0
+      workspace: true
+  cargo-machete:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: 1.87.0
+      - name: Install cargo-machete
+        run: cargo install cargo-machete
+      - name: Check unused dependencies in findex crate
+        run: |
+          cd crate/findex
+          cargo machete --with-metadata
+      - name: Check unused dependencies in memories crate
+        run: |
+          cd crate/memories
+          cargo machete --with-metadata
   cargo-publish:
     needs:
       - cargo-lint
     uses: Cosmian/reusable_workflows/.github/workflows/cargo-publish.yml@develop
     if: startsWith(github.ref, 'refs/tags/')
     with:
-      toolchain: stable
+      toolchain: 1.87.0
     secrets: inherit
   cleanup:
     needs:

.github/workflows/hack.yml

@@ -35,7 +35,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions-rs/toolchain@v1
         with:
-          toolchain: stable
+          toolchain: 1.87.0
           override: true
       - name: Install cargo-hack
         run: cargo install --locked cargo-hack || true

.gitignore

@@ -5,3 +5,4 @@ target/
 perf*
 flamegraph.svg
 **/*.tgz
+*.sqlite.db*

Cargo.toml

@@ -1,6 +1,9 @@
-[package]
-name = "cosmian_findex"
-version = "7.1.0"
+[workspace]
+members = ["crate/findex", "crate/memories"]
+resolver = "2"
+
+[workspace.package]
+version = "8.0.0"
 authors = [
     "Bruno Grieder <bruno.grieder@cosmian.com>",
     "Célia Corsin <celia.corsin@cosmian.com>",
@@ -15,56 +18,13 @@ keywords = ["SSE"]
 license = "BUSL-1.1"
 repository = "https://github.com/Cosmian/findex/"
 description = "Symmetric Searchable Encryption"
+readme = "README.md"
 
-[lib]
-name = "cosmian_findex"
-path = "src/lib.rs"
-
-[features]
-rust-mem = []
-redis-mem = ["redis"]
-sqlite-mem = ["async-sqlite"]
-test-utils = ["tokio", "criterion", "futures", "rand", "rand_distr"]
-postgres-mem = ["tokio-postgres", "tokio", "deadpool-postgres"]
 
-[dependencies]
-aes = "0.8"
+[workspace.dependencies]
 cosmian_crypto_core = { version = "10.1", default-features = false, features = [
     "macro",
     "sha3",
 ] }
-xts-mode = "0.5"
-
-# Used in benches and tests.
-criterion = { version = "0.5", optional = true }
-futures = { version = "0.3", optional = true }
-rand = { version = "0.9.0", optional = true }
-rand_distr = { version = "0.5.1", optional = true }
-tokio = { version = "1.44", features = ["rt-multi-thread"], optional = true }
-
-
-# Memory dependencies
-async-sqlite = { version = "0.5", optional = true }
-deadpool-postgres = { version = "0.14.1", optional = true }
-redis = { version = "0.28", features = [
-    "aio",
-    "connection-manager",
-    "tokio-comp",
-], optional = true }
-tokio-postgres = { version = "0.7.9", optional = true, features = [
-    "array-impls",
-] }
-
-
-[dev-dependencies]
-futures = { version = "0.3" }
-tokio = { version = "1.44", features = ["macros", "rt-multi-thread"] }
-
-[[bench]]
-name = "benches"
-harness = false
-required-features = ["test-utils"]
-
-[[example]]
-name = "insert"
-required-features = ["test-utils"]
+criterion = { version = "0.6" }
+tokio = { version = "1.45" }

README.md

@@ -1,22 +1,22 @@
-# Findex
+# Findex: Symmetric Searchable Encryption
 
-To build Findex simply run:
+[![Crates.io](https://img.shields.io/crates/v/cosmian_findex.svg)](https://crates.io/crates/cosmian_findex)
+[![Documentation](https://docs.rs/cosmian_findex/badge.svg)](https://docs.rs/cosmian_findex)
+[![License](https://img.shields.io/badge/License-BUSL--1.1-blue.svg)](LICENSE)
 
-```bash
-cargo build --release
-```
+Findex is a Symmetric Searchable Encryption (SSE) library that enables encrypted search over encrypted data. It allows you to securely index and search encrypted data without compromising privacy or security.
 
-To test, run:
+## Architecture
 
-```bash
-cargo test --release --all-features
-```
+This repository is organized as a Rust workspace with two crates:
 
-To launch the benchmarks, run:
+- `cosmian_findex`: Core library implementing the SSE algorithms
+- `cosmian_findex_memories`: Storage back-end implementations for different databases
 
-```bash
-cargo bench --all-features
-```
+## Related Projects
 
-Note that benches are quite involving and require *several hours* for a full
-run. Once all benchmarks are run, you will find detailed reports under `target/criterion`.
+[Findex Server](github.com/cosmian/findex-server) - A production-ready Findex server implementation
+
+## License
+
+This project is licensed under the Business Source License 1.1 (BUSL-1.1).

crate/findex/Cargo.toml

@@ -0,0 +1,38 @@
+[package]
+name = "cosmian_findex"
+version.workspace = true
+authors.workspace = true
+categories.workspace = true
+edition.workspace = true
+keywords.workspace = true
+license.workspace = true
+repository.workspace = true
+description.workspace = true
+readme = "README.md"
+
+[lib]
+name = "cosmian_findex"
+path = "src/lib.rs"
+
+[features]
+test-utils = ["tokio", "criterion"]
+
+[dependencies]
+cosmian_crypto_core.workspace = true
+aes = "0.8"
+xts-mode = "0.5"
+
+# Optional dependencies for testing and benchmarking.
+tokio = { workspace = true, features = [
+    "rt-multi-thread",
+    "macros",
+], optional = true }
+criterion = { workspace = true, optional = true }
+futures = "0.3.31"
+
+[dev-dependencies]
+tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }
+
+[[example]]
+name = "insert"
+required-features = ["test-utils"]

crate/findex/README.md

@@ -0,0 +1,14 @@
+# Findex
+
+This crate provides the core functionality of Findex, defining the abstract data types, cryptographic operations, and encoding algorithms.
+
+## Setup
+
+Add `cosmian_findex` as dependency to your project :
+
+```toml
+[dependencies]
+cosmian_findex = "8.0.0"
+```
+
+An usage example is available in the [examples folder](./examples).