HESea Cryptography Library

Introduction
Build Instructions
Running Test
Example
Environment
Reference
Lincese

Introduction

HESea is a cutting-edge fully homomorphic encryption (FHE) library that provides developers with a powerful, flexible, and easy-to-use tool for secure computation. Built with state-of-the-art cryptographic techniques and optimized for high performance, HESea is ideal for a wide range of use cases. HESea offers various FHE schemes, including TFHE, CKKS, BGV, BFV, and more, which enable users to perform computations on encrypted data without the need to decrypt it. This ensures that sensitive data remains secure and protected against privacy breaches and security threats.

The library offers a variety of functions for basic primitive operation(Boolen gate, algebraic addition and multiplication), arithmetic operation(ReLu,Sigmoid) and logical operations(sorting,comparison, extraction).The library is highly optimized with advanced techniques such as ciphertext packing and batching, which minimizes the number of operations required to process large data sets, thereby improving efficiency and performance.

One of the significant advantages of HESea is its ease of use. It provides a simple and intuitive API, making it accessible to both novice and expert users. HESea is also highly efficient, with optimizations for underlying mathematical acceleration techniques such as NTT and FFT, making it an excellent choice for a variety of use cases.

HESea is an open-source library, which means that users can inspect and modify the code as needed. The library also offers comprehensive documentation and support, including tutorials and examples, making it easy for developers to integrate HESea into their projects.

Overall, HESea is a powerful and robust FHE library that offers a wide range of advanced features and optimizations for developers who want to implement secure computation in privacy-preserving machine learning. With its advanced functionalities, ease of use, and high performance, HESea is an ideal choice for developers looking to build secure and efficient applications.

Build

We use CMake to build HESea. The high-level (platform-independent) procedure for building HESEA is as follows (for OS-specific instructions, see the section "Detailed information about building HESEA" at the bottom of this page):

Install system prerequisites (if not already installed), including a C++ compiler with OMP support, cmake, make, and autoconf.
Clone the HESEA repo to your local machine.
Create a directory where the binaries will be built. The typical choice is a subfolder "build". In this case, the commands are:
```
mkdir build
cd build
cmake ..
```

Note that CMake will check for any system dependencies that are needed for the build process. If the CMake build does not complete successfully, please review the error CMake shows at the end. If the error does not go away (even though you installed the dependency), try running "make clean" to clear the CMake cache.

If you want to use any external libraries, such as NTL/GMP or tcmalloc, install these libraries.
Build HESEA by running the following command (this will take few minutes; using the -j make command-line flag is suggested to speed up the build)
```
make
```
If you want to build only library files or some other subset of HESEA, please review the last paragraph of this page.

After the "make" completes, you should see the HESEA library files in the lib folder, binaries of demos in bin/demo, binaries of benchmarks in bib/benchmark, and binaries for unit tests in the unittest folder.

Install HESEA to a system directory (if desired or for production purposes)
```
make install
```
You would probably need to run sudo make install unless you are specifying some other install location. You can change the install location by running cmake -DCMAKE_INSTALL_PREFIX=/your/path ... The header files are placed in the "include/hesea" folder of the specified path, and the binaries of the library are copied directly to the "lib" folder. For example, if no installation path is provided in Ubuntu (and many other Unix-based OSes), the header and library binary files will be placed in "/usr/local/include/hesea" and "/usr/local/lib", respectively.

Test

Run unit tests to make sure all capabilities operate as expected

make testall

Run sample code to test, e.g.,

bin/examples/pke/simple-integers

To remove the files built by make, you can execute

make clean

Example

//test.cpp
#include "hesea.h"
using namespace lbcrypto;
using namespace std;

int main() {
  // Sample Program: Step 1: Set CryptoContext
  auto cc = auto cc = CryptoContextImpl<DCRTPoly>();();
  // Set secrity params
  cc.GenerateBinFHEContext(STD128);
  // Sample Program: Step 2: Key Generation
  // Generate the secret key
  auto sk = cc.KeyGen();
  std::cout << "Generating the bootstrapping keys..." << std::endl;
  // Generate the bootstrapping keys (refresh and switching keys)
  cc.BTKeyGen(sk);
  std::cout << "Completed the key generation." << std::endl;
  // Sample Program: Step 3: Encryption
  auto ct1 = cc.Encrypt(sk, 1);
  auto ct2 = cc.Encrypt(sk, 1);

  // Sample Program: Step 4: Evaluate the boolean gate "and" "or" "not" 
  auto ctAND1 = cc.EvalBinGate(AND, ct1, ct2);
  auto ct2Not = cc.EvalNOT(ct2);
  auto ctResult = cc.EvalBinGate(OR, ctAND1, ctAND2);

  // Sample Program: Step 5: Decryption
  LWEPlaintext result;
  cc.Decrypt(sk, ctResult, &result);
  std::cout
      << "Result of encrypted computation of (1 AND 1) OR (1 AND (NOT 1)) = "
      << result << std::endl;
  return 0;
}

gcc -xc++ -lstdc++ -shared-libgcc test.cpp -o test -I /usr/local/include/hesea  -L /usr/local/lib -libHESEApke.so

Environment

HESEA CI continually tests our builds on the following operating systems:

Ubuntu [18.04] [20.04]
macOS [Mojave]
Centos 7
NVIDIA Xavier [Linux for Tegra 4.2.2]
MinGW (64-bit) on Windows 10

HESEA users have reported successful operation on the following systems:

FreeBSD
Ubuntu [16.04]
Arch Linux
Manjaro Linux

Please let us know the results if you have run HESEA any additional systems not listed above.

Reference

More detailed steps for some common platforms are provided in the following the articles:

Instructions for building HESEA in Linux

Instructions for building HESEA in Windows

Instructions for building HESEA in macOS

HESEA provides many CMake/make configuration options, such as installing specific modules of the library, compiling only libraries w/o any unit tests and demos, choosing the Debug mode for compilation, turning on/off NTL/GMP. These options are described in detail in the following Wiki article:

Use of CMake in HESEA

Instructions for building user projects that use HESEA

Lincese

HESEA Library uses BSD 2-Clause License. More can find License Information.

IvandubR/HESEA_Lib