Crates.io | openfhe |
lib.rs | openfhe |
version | 0.2.0 |
source | src |
created_at | 2024-03-18 08:57:55.983958 |
updated_at | 2024-06-26 12:17:33.735335 |
description | Rust package of the OpenFHE Fully Homomorphic Encryption Library. |
homepage | |
repository | https://github.com/fairmath/openfhe-rs |
max_upload_size | |
id | 1177453 |
size | 287,543 |
☀️ 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 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.
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.
Ensure you have the following dependencies installed:
CMake >= 3.5.1
G++ >= 11.4
Rust >= 1.78
Git
To build and install the OpenFHE library, follow the steps below or refer to OpenFHE's installation documentation.
git clone https://github.com/openfheorg/openfhe-development.git
cd openfhe-development
cmake -B ./build -DBUILD_SHARED=ON .
make -C ./build -j$(nproc)
make -C ./build install
sudo ldconfig
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),
cargo build
cargo run
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:
git clone https://github.com/fairmath/openfhe-rs.git
cd openfhe-rs
cargo build
cargo test -- --test-threads=1
cargo run --example function_evaluation
cargo run --example polynomial_evaluation
cargo run --example simple_integers
cargo run --example simple_real_numbers
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.
OpenFHE-rs
is licensed under the BSD 2-Clause License.
See the LICENSE file for more details.