Update to v1.2.0 (#819)

* updated to v1.2.0 * updates requirements.txt * fixes URL --------- Co-authored-by: Yuriy Polyakov <ypolyakod@dualitytech.com>
openfheorg · Jun 25, 2024 · 4cb244b · 4cb244b
1 parent 2150cfd
commit 4cb244b
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 7 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -26,8 +26,8 @@ endif()
 project (OpenFHE C CXX)
 
 set(OPENFHE_VERSION_MAJOR 1)
-set(OPENFHE_VERSION_MINOR 1)
-set(OPENFHE_VERSION_PATCH 4)
+set(OPENFHE_VERSION_MINOR 2)
+set(OPENFHE_VERSION_PATCH 0)
 set(OPENFHE_VERSION ${OPENFHE_VERSION_MAJOR}.${OPENFHE_VERSION_MINOR}.${OPENFHE_VERSION_PATCH})
 
 set(CMAKE_CXX_STANDARD 17)

diff --git a/README.md b/README.md
@@ -82,6 +82,7 @@ To get familiar with the main API of OpenFHE, we recommend looking at the code o
 ## Main API
 
 - [PKE CryptoContext API (BGV/BFV/CKKS)](https://openfhe-development.readthedocs.io/en/latest/api/classlbcrypto_1_1CryptoContextImpl.html)
+- [Description of CryptoContext Parameters for BGV, BFV, and CKKS](https://github.com/openfheorg/openfhe-development/blob/main/src/pke/examples#description-of-the-cryptocontext-parameters-and-their-restrictions)
 
 - [BinFHE Context API (FHEW/TFHE)](https://openfhe-development.readthedocs.io/en/latest/api/classlbcrypto_1_1BinFHEContext.html)
 
@@ -110,19 +111,19 @@ We welcome all contributions including but not limited to:
 
 ## How to Cite OpenFHE
 
-To cite OpenFHE in academic papers, please use the following BibTeX entry
+To cite OpenFHE in academic papers, please use the following BibTeX entry (updated version)
 
 ```
 @misc{OpenFHE,
-      author = {Ahmad Al Badawi and Jack Bates and Flavio Bergamaschi and David Bruce Cousins and Saroja Erabelli and Nicholas Genise and Shai Halevi and Hamish Hunt and Andrey Kim and Yongwoo Lee and Zeyu Liu and Daniele Micciancio and Ian Quah and Yuriy Polyakov and Saraswathy R.V. and Kurt Rohloff and Jonathan Saylor and Dmitriy Suponitsky and Matthew Triplett and Vinod Vaikuntanathan and Vincent Zucca},
-      title = {OpenFHE: Open-Source Fully Homomorphic Encryption Library},
+      author = {Ahmad Al Badawi and Andreea Alexandru and Jack Bates and Flavio Bergamaschi and David Bruce Cousins and Saroja Erabelli and Nicholas Genise and Shai Halevi and Hamish Hunt and Andrey Kim and Yongwoo Lee and Zeyu Liu and Daniele Micciancio and Carlo Pascoe and Yuriy Polyakov and Ian Quah and Saraswathy R.V. and Kurt Rohloff and Jonathan Saylor and Dmitriy Suponitsky and Matthew Triplett and Vinod Vaikuntanathan and Vincent Zucca},
+      title = {{OpenFHE}: Open-Source Fully Homomorphic Encryption Library},
       howpublished = {Cryptology ePrint Archive, Paper 2022/915},
       year = {2022},
       note = {\url{https://eprint.iacr.org/2022/915}},
       url = {https://eprint.iacr.org/2022/915}
 }
 ```
-or, alternatively (WAHC@CCS'22 version),
+or, alternatively (original WAHC@CCS'22 version),
 ```
 @inproceedings{10.1145/3560827.3563379,
       author = {Al Badawi, Ahmad and Bates, Jack and Bergamaschi, Flavio and Cousins, David Bruce and Erabelli, Saroja and Genise, Nicholas and Halevi, Shai and Hunt, Hamish and Kim, Andrey and Lee, Yongwoo and Liu, Zeyu and Micciancio, Daniele and Quah, Ian and Polyakov, Yuriy and R.V., Saraswathy and Rohloff, Kurt and Saylor, Jonathan and Suponitsky, Dmitriy and Triplett, Matthew and Vaikuntanathan, Vinod and Zucca, Vincent},

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -5,7 +5,7 @@ certifi>=2023.7.22
 charset-normalizer==2.0.12
 docutils==0.17.1
 exhale>=0.3.0
-idna==3.3
+idna>=3.7
 imagesize==1.3.0
 importlib-metadata>=4.0.0
 jinja2>=3.1.3

diff --git a/docs/sphinx_rsts/intro/tutorials.rst b/docs/sphinx_rsts/intro/tutorials.rst
@@ -1,6 +1,8 @@
 Tutorials on Cryptographic Capabilities
 ====================================
 
+-  `Description of the CryptoContext parameters for BGV, BFV, and CKKS <https://github.com/openfheorg/openfhe-development/blob/main/src/pke/examples#description-of-the-cryptocontext-parameters-and-their-restrictions>`_
+
 -  `CKKS Noise Flooding <https://github.com/openfheorg/openfhe-development/blob/main/src/pke/examples/CKKS_NOISE_FLOODING.md>`_
 
 -  `Smooth Arbitrary Function Evaluation in CKKS <https://github.com/openfheorg/openfhe-development/blob/main/src/pke/examples/FUNCTION_EVALUATION.md>`_

diff --git a/docs/static_docs/Release_Notes.md b/docs/static_docs/Release_Notes.md
@@ -1,3 +1,17 @@
+06/25/2024: OpenFHE 1.2.0 (stable) is released
+
+* Updates the lattice parameters tables to support the ring dimension of 2^{16} and 2^{17} for ternary and Gaussian secrets (#806)
+* Adds application specifications validator for BGV, BFV, and CKKS (#710)
+* Updates the parameter sets for CGGI/DM/LMKCDEY; adds low-probability-of-failure parameter sets (below 2^{-120}) (#673)
+* Adds several optimizations for BFV, including support for modulus switching during computation (#682, #715, #731)
+* Fixes parameter estimation bugs for BGV, BFV, and CKKS (insecure configurations were possible for scenarios with hybrid key switching) (#785, #786)
+* Includes several fixes related to handling the map of automorphism keys for various EvalSum*KeyGen operations (#756, #773, #783, #797)
+* Add support for selective serialization/deserialization of automorphism/rotation keys (#775)
+* Updates the HRA-Secure BGV PRE implementation based on https://eprint.iacr.org/2024/681 (#767)
+* Includes many other bug fixes
+
+The detailed list of changes is available at https://github.com/openfheorg/openfhe-development/issues?q=is%3Aissue+milestone%3A%22Release+1.2.0%22
+
 03/08/2024: OpenFHE 1.1.4 (stable) is released
 
 * Fixes a bug affecting the Google C++ Transpiler code generation (#701)