Welcome to OpenFHE Rust wrapper’s documentation!

OpenFHE

Fully Homomorphic Encryption (FHE) is a powerful cryptographic primitive that enables performing computations over encrypted data without having access to the secret key. OpenFHE is an open-source FHE library that includes efficient implementations of all common FHE schemes:

• Brakerski/Fan-Vercauteren (BFV) scheme for integer arithmetic

• Brakerski-Gentry-Vaikuntanathan (BGV) scheme for integer arithmetic

• Cheon-Kim-Kim-Song (CKKS) scheme for real-number arithmetic (includes approximate bootstrapping)

• Ducas-Micciancio (DM/FHEW) and Chillotti-Gama-Georgieva-Izabachene (CGGI/TFHE), and Lee-Micciancio-Kim-Choi-Deryabin-Eom-Yoo (LMKCDEY) schemes for evaluating Boolean circuits and arbitrary functions over larger plaintext spaces using lookup tables

About OpenFHE-rs

OpenFHE-rs is a joint project by Fair Math & OpenFHE

Note

🔔 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 look for Help.

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.

Check out the About OpenFHE-rs section for quick start information, including installation instructions.

Contents

• About OpenFHE-rs
• Installation
  • Prerequisites
  • Installation process
    • Core OpenFHE library installation
    • Configuring your project to use the crate
    • Custom crate installation from the source
• Contributing
• License
• Limitations
  • OpenFHE
  • Rust wrapper
• Base types and algorithms
  • Cryptography schemes supported
  • Params
  • CryptoContext
• Help
• Useful Links
• Homomorphic additions, multiplications, and rotations for vectors of integers via BFV
  • Overview
  • Code breakdown
    • Importing libraries
    • The code example
    • Generating Parameters
    • Creating Crypto Context
    • Key Generation
    • Plaintext Vector Creation
    • Encrypting Plaintext Vectors
    • Performing Homomorphic Operations
    • Decrypting and Printing Results
    • Running the example
• Homomorphic additions, multiplications, and rotations for vectors of real numbers via CKKS
  • Overview
  • Code breakdown
    • Importing libraries
    • The code example
    • Generating Parameters
    • Creating Crypto Context
    • Key Generation
    • Creating Input Vectors
    • Creating Plaintext Objects
    • Encrypting Plaintext Vectors
  • Performing Homomorphic Operations
  • Decrypting and Printing Results
    • Running the example
• Arbitrary smooth function evaluation in CKKS via OpenFHE-rs
  • Overview
  • Rust example
  • Input parameters
    • Running the example
  • How to choose a multiplicative depth
• Polynomial evaluation in CKKS via OpenFHE-rs
  • Overview
  • Rust example
  • Input parameters
    • Running the example