11 releases

0.2.8 Jun 26, 2024
0.2.0 Jun 26, 2024
0.1.8 Jun 21, 2024
0.1.4 May 18, 2024
0.0.0 Mar 18, 2024

#189 in Cryptography

Download history 138/week @ 2024-03-18 21/week @ 2024-04-01 444/week @ 2024-05-13 43/week @ 2024-05-20 4/week @ 2024-05-27 206/week @ 2024-06-10 431/week @ 2024-06-17 249/week @ 2024-06-24

886 downloads per month

BSD-2-Clause

170KB
3K SLoC

C++ 2K SLoC // 0.0% comments Rust 1.5K SLoC // 0.0% comments Shell 22 SLoC

About OpenFHE-rs

☀️ OpenFHE-rs is a joint project by FairMath & OpenFHE.


Discord Twitter

🔔 Keep in mind that the library is WIP and may contain some unpolished interfaces. If you encounter any issues or have any suggestions, feel free to ping us on our Discord server or open a new issue in the GitHub repository.


OpenFHE-rs is a Rust interface for the OpenFHE library, which is renowned for its comprehensive suite of Fully Homomorphic Encryption (FHE) schemes, all implemented in C++. By providing a Rust wrapper for OpenFHE, we aim to make these advanced FHE capabilities easily accessible to Rust developers.

Whether you're developing secure data processing applications or privacy-focused tools, OpenFHE-rs enables you to leverage the powerful encryption technologies of OpenFHE seamlessly within your Rust projects.

Installation

To use OpenFHE-rs, you'll need to install several dependencies and follow the installation steps for both the core OpenFHE library and the Rust crate.

Prerequisites

Ensure you have the following dependencies installed:

  • CMake >= 3.5.1
  • G++ >= 11.4
  • Rust >= 1.78
  • Git

Installation process

Core OpenFHE library installation

To build and install the OpenFHE library, follow the steps below or refer to OpenFHE's installation documentation.

  1. Clone the repository
git clone https://github.com/openfheorg/openfhe-development.git
cd openfhe-development
  1. Configure CMake
cmake -B ./build -DBUILD_SHARED=ON .
  1. Build and install the C++ OpenFHE library
make -C ./build -j$(nproc)
make -C ./build install
  1. Update the cache for the linker
sudo ldconfig

Configuring your project to use the crate

To use the OpenFHE crate in your Rust project, add it as a dependency from crates.io:

cargo add openfhe

You also need to add a small piece of code for the core dependencies' configuration in your build.rs file:

fn main
{
    // linking openFHE
    println!("cargo::rustc-link-arg=-L/usr/local/lib");
    println!("cargo::rustc-link-arg=-lOPENFHEpke");
    println!("cargo::rustc-link-arg=-lOPENFHEbinfhe");
    println!("cargo::rustc-link-arg=-lOPENFHEcore");
    // linking OpenMP
    println!("cargo::rustc-link-arg=-fopenmp");
    // necessary to avoid LD_LIBRARY_PATH
    println!("cargo::rustc-link-arg=-Wl,-rpath=/usr/local/lib");
}

To build and run a complete working example, go to the crate_usage directory (assuming that the OpenFHE library is already installed),

  1. Build the application
cargo build
  1. Run
cargo run

Custom crate installation from the source

You can adjust the installation process by building the crate manually. In that case, you need to clone the Fair Math's openfhe-rs repo to your local machine and build it:

  1. Clone the repository
git clone https://github.com/fairmath/openfhe-rs.git
cd openfhe-rs
  1. Build the library
cargo build
  1. Run tests
cargo test -- --test-threads=1
  1. Run the examples
cargo run --example function_evaluation
cargo run --example polynomial_evaluation
cargo run --example simple_integers
cargo run --example simple_real_numbers

Contributing

Contributions are always welcome! If you find bugs, have feature requests, or want to contribute code, please open an issue or pull request on the GitHub repository.

License

OpenFHE-rs is licensed under the BSD 2-Clause License. See the LICENSE file for more details.

Dependencies

~0.6–2MB
~31K SLoC