Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1.63 KB

README.md

File metadata and controls

51 lines (32 loc) · 1.63 KB
Raw

Cupcake

Cupcake is an efficient Rust library for the (additive version of) Fan-Vercauteren homomorphic encryption scheme, offering capabilities to encrypt vectors, add/subtract two encrypted vectors, and rerandomize a ciphertext.

Requirements

Cupcake requires or works with

  • Mac OS X or Linux

Installation

Add the following line to the dependencies of your Cargo.toml:

Cupcake = "0.2.1"

Building from source

git clone https://github.com/facebookresearch/Cupcake
cd cupcake
cargo build --release

Examples

Several examples are included in examples/<name>.rs, and can be run via cargo run --example <name>

Documentation

Documentation on the API can be built from cargo doc.

Benchmarks and Tests

We have included benchmarks and tests for both homomorphic operations and underlying arithmetic operations. They can be run using cargo bench and cargo test.

Supported parameters

Currently, we provide only one set of secure parameter, namely FV::<Scalar>::default_2048();. This parameter set has an estimated security level of about 128 bits according to the homomorphic encryption security standards link. Use other parameters at your own risk! With the default parameter set, the plaintext type is vector of u8 with a fixed length 2048.

References

See the CONTRIBUTING file for how to help out.

License

Cupcake is MIT licensed, as found in the LICENSE file.