Home Explore Help
Sign In
iang
/
openfhe-rs-fork
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: ef8e5989fb
Branches Tags
openfhe-rs-f...
/
docs
/
source
/
index.rst

index.rst 2.2 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647 
  1. Welcome to OpenFHE Rust wrapper's documentation!
    2. 

  2. ===================================
    3. 

  3. 

  4. OpenFHE
    5. 

  5. --------
    6. 

  6. 

  7. Fully Homomorphic Encryption (FHE) is a powerful cryptographic primitive that enables performing computations over encrypted data without having access to the secret key.
    8. 

  8. OpenFHE is an open-source FHE library that includes efficient implementations of all common FHE schemes:
    9. 

  9.   - Brakerski/Fan-Vercauteren (BFV) scheme for integer arithmetic
    10. 

  10.   - Brakerski-Gentry-Vaikuntanathan (BGV) scheme for integer arithmetic
    11. 

  11.   - Cheon-Kim-Kim-Song (CKKS) scheme for real-number arithmetic (includes approximate bootstrapping)
    12. 

  12.   - 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
    13. 

  13. 

  14. About OpenFHE-rs
    15. 

  15. ================
    16. 

  16. 

  17. OpenFHE-rs is a joint project by `Fair Math <https://fairmath.xyz/>`_ & `OpenFHE <https://www.openfhe.org/>`_
    18. 

  18. 

  19. .. image:: https://img.shields.io/discord/1163764915803279360?logo=discord&label=Fair%20Math
    20. 

  20.    :target: https://discord.com/invite/NfhXwyr9M5
    21. 

  21. 

  22. .. image:: https://img.shields.io/twitter/follow/FairMath
    23. 

  23.    :target: https://twitter.com/FairMath
    24. 

  24. 

  25. .. note::
    26. 

  26. 

  27.    🔔 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 :doc:`support`.
    28. 

  28. 

  29. 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.
    30. 

  30. 

  31. 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.
    32. 

  32. 

  33. Check out the :doc:`intro` section for quick start information, including installation instructions.
    34. 

  34. 

  35. Contents
    36. 

  36. --------
    37. 

  37. 

  38. .. toctree::
    39. 

  39. 

  40.    intro
    41. 

  41.    limitations
    42. 

  42.    base_types_and_alg
    43. 

  43.    support
    44. 

  44.    simple_integers
    45. 

  45.    simple_real_numbers
    46. 

  46.    function_evaluation
    47. 

  47.    polynomial_evaluation
    48.