6 releases
0.1.4 | May 18, 2024 |
---|---|
0.1.3 | May 17, 2024 |
0.0.0 | Mar 18, 2024 |
#230 in Cryptography
487 downloads per month
80KB
1.5K
SLoC
About OpenFHE-rs
☀️ OpenFHE-rs is a joint project by FairMath & OpenFHE
🔔 Keep in mind that the library is WIP and may contain some unpolished interfaces. If you struggle with anything or have 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. OpenFHE is known for its wide range of Fully Homomorphic Encryption (FHE) schemes, all implemented in C++. We're bringing this capability to Rust developers.
By offering a Rust wrapper for OpenFHE, we make it easier for Rust devs to use advanced FHE schemes in their projects. Whether you're building secure data processing apps or privacy-focused tools, OpenFHE-rs helps you do that with the power of OpenFHE's encryption technology.
Installation
You can use this library as a cargo crate from crates.io or build it from the source.
In both cases you need to have the core OpenFHE library installed on your system to support the low-level optimizations.
Install dependencies
- CMake >= 3.5.1
- Clang >= 12.0 or GCC >= 11.4
- Rust >= 1.78
- Git
Unix
On Debian systems, everything can be installed with the following command:
sudo apt install build-essential libssl-dev cmake clang git
Installation process
Core OpenFHE library installation
Build and install OpenFHE library. Right now you need to use the Fair Math fork. It contains the required features, which will be included in the next planned release (v1.1.5):
- Clone the repository
git clone https://github.com/fairmath/openfhe.git
cd openfhe
- Configure CMake
cmake -B ${OPENFHE_BUILD:-build} -DBUILD_EXAMPLES=ON -DBUILD_EXTRAS=ON -DBUILD_SHARED=ON .
- Build and install the C++ OpenFHE library
make -C ${OPENFHE_BUILD:-build} -j$(nproc)
make -C ${OPENFHE_BUILD:-build} install
- Configure your dynamic linker
sudo ldconfig
Configuring your project to use the crate
To get the cargo crate from crates.io, you need to add it as a dependency to you project:
cargo add openfhe
You also need to add a small piece of code for 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");
}
Template repository
Instead of doing it manually, you start your project by forking our template repository.
Custom crate installation from source
You can adjust the installation process by building the crate mannually. In that case you need to clone the Fair Math openfhe-rs repo to your local machine and build it:
- Clone the repository
git clone https://github.com/fairmath/openfhe-rs.git
cd openfhe-rs
- Build the library
cargo build
- Run tests
cargo test -- --test-threads=1
- Run the examples
cargo run --example polynomial_evaluation
Dependencies
~0.6–2MB
~32K SLoC