Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
TFHE-rs is a pure Rust implementation of TFHE for boolean and small integer arithmetics over encrypted data. It includes:
- a Rust API
- a C API
- and a client-side WASM API
TFHE-rs is meant for developers and researchers who want full control over what they can do with TFHE, while not having to worry about the low level implementation. The goal is to have a stable, simple, high-performance and production-ready library for all the advanced features of TFHE.
Getting Started
To use TFHE-rs
in your project, you first need to add it as a dependency in your Cargo.toml
:
= { = "0.1.0", = [ "boolean","shortint","x86_64-unix" ] }
Here is a full example evaluating a Boolean circuit:
use *;
Another example of how the library can be used with shortints:
use *;
Contributing
There are two ways to contribute to TFHE-rs:
- you can open issues to report bugs or typos and to suggest new ideas
- you can ask to become an official contributor by emailing hello@zama.ai. (becoming an approved contributor involves signing our Contributor License Agreement (CLA))
Only approved contributors can send pull requests, so please make sure to get in touch before you do!
Credits
This library uses several dependencies and we would like to thank the contributors of those libraries.
License
This software is distributed under the BSD-3-Clause-Clear license. If you have any questions,
please contact us at hello@zama.ai
.
Disclaimers
Security Estimation
Security estimations are done using the
Lattice Estimator
with red_cost_model = reduction.RC.BDGL16
.
When a new update is published in the Lattice Estimator, we update parameters accordingly.
Side-Channel Attacks
Mitigation for side channel attacks have not yet been implemented in TFHE-rs, and will be released in upcoming versions.