lightphe 0.0.6__tar.gz → 0.0.8__tar.gz

{lightphe-0.0.6 → lightphe-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lightphe
-Version: 0.0.6
+Version: 0.0.8
 Summary: A Lightweight Partially Homomorphic Encryption Library for Python
 Home-page: https://github.com/serengil/LightPHE
 Author: Sefik Ilkin Serengil
@@ -18,16 +18,19 @@ License-File: LICENSE
 
 <div align="center">
 
-[![PyPI Downloads](https://static.pepy.tech/personalized-badge/lightphe?period=total&units=international_system&left_color=grey&right_color=blue&left_text=pypi%20downloads)](https://pepy.tech/project/lightphe)
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/lightphe?period=total&units=international_system&left_color=grey&right_color=blue&left_text=downloads)](https://pepy.tech/project/lightphe)
 [![Stars](https://img.shields.io/github/stars/serengil/LightPHE?color=yellow&style=flat&label=%E2%AD%90%20stars)](https://github.com/serengil/LightPHE/stargazers)
 [![Tests](https://github.com/serengil/LightPHE/actions/workflows/tests.yml/badge.svg)](https://github.com/serengil/LightPHE/actions/workflows/tests.yml)
 [![License](http://img.shields.io/:license-MIT-green.svg?style=flat)](https://github.com/serengil/LightPHE/blob/master/LICENSE)
-[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dserengil%26type%3Dpatrons&style=flat)](https://www.patreon.com/serengil?repo=lightphe)
-[![GitHub Sponsors](https://img.shields.io/github/sponsors/serengil?logo=GitHub&color=lightgray)](https://github.com/sponsors/serengil)
+[![DOI](http://img.shields.io/:DOI-10.48550/arXiv.2408.05219-blue.svg?style=flat)](https://arxiv.org/abs/2408.05219)
 
 [![Blog](https://img.shields.io/:blog-sefiks.com-blue.svg?style=flat&logo=wordpress)](https://sefiks.com)
 [![YouTube](https://img.shields.io/:youtube-@sefiks-red.svg?style=flat&logo=youtube)](https://www.youtube.com/@sefiks?sub_confirmation=1)
-[![Twitter](https://img.shields.io/:follow-@serengil-blue.svg?style=flat&logo=twitter)](https://twitter.com/intent/user?screen_name=serengil)
+[![Twitter](https://img.shields.io/:follow-@serengil-blue.svg?style=flat&logo=x)](https://twitter.com/intent/user?screen_name=serengil)
+
+[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dserengil%26type%3Dpatrons&style=flat)](https://www.patreon.com/serengil?repo=lightphe)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/serengil?logo=GitHub&color=lightgray)](https://github.com/sponsors/serengil)
+[![Buy Me a Coffee](https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee)](https://buymeacoffee.com/serengil)
 
 </div>
 
@@ -109,47 +112,99 @@ m = 17
 # calculate ciphertext
 c = cs.encrypt(m)
 
+# proof of work
 assert cs.decrypt(c) == m
 ```
 
 # Homomorphic Operations
 
-Once you have the ciphertext, you will be able to perform homomorphic operations on encrypted data. For instance, Paillier is homomorphic with respect to the addition. In other words, decryption of the addition of two ciphertexts is equivalent to addition of plaintexts. 
+Once you have the ciphertext, you will be able to perform homomorphic operations on encrypted data without holding private key. For instance, Paillier is homomorphic with respect to the addition. In other words, decryption of the addition of two ciphertexts is equivalent to addition of plaintexts.
+
+### On-Prem Encryption
+
+This Python code snippet demonstrates how to generate a private-public key pair using the Paillier cryptosystem via the LightPHE library. First, an instance of the LightPHE class is created with the Paillier algorithm. Then, the public key is exported and saved to a file named "public.txt" to build the same cryptosystem with only public key in the cloud side later. The code defines two plaintext values, m1 and m2, respectively. These plaintext values are encrypted to generate ciphertexts c1 and c2 using the public key. Finally, the ciphertexts c1 and c2 are prepared to be sent to a cloud system for secure processing or storage.
 
 ```python
+# generate private-public key pair
 cs = LightPHE(algorithm_name = "Paillier")
 
+# export public key to build same cryptosystem with only public key in the cloud
+cs.export_keys(target_file = "public.txt", public = True)
+
+# export private key to build same cryptosystem on-prem later
+cs.export_keys(target_file = "private.txt", public = False)
+
 # define plaintexts
 m1 = 17
 m2 = 23
 
 # calculate ciphertexts
-c1 = cs.encrypt(m1)
-c2 = cs.encrypt(m2)
+c1 = cs.encrypt(m1).value
+c2 = cs.encrypt(m2).value
+
+# send c1 and c2 pair to a cloud system
+```
+
+### Homomorphic Operations on Cloud
+
+This Python code snippet illustrates how to handle encrypted data on the cloud side using the Paillier cryptosystem with the LightPHE library. Upon receiving the encrypted values c1 and c2, the cloud system initializes the cryptosystem using the exported public key stored in public.txt. To ensure the security of the data, a test is performed to confirm that the cloud system cannot decrypt c1 and c2 without the private key. This is done using the pytest library, which raises a ValueError if decryption is attempted, verifying that decryption is not possible without the private key. Finally, the code demonstrates homomorphic addition by adding the two ciphertexts, resulting in a new ciphertext c3 that represents the encrypted sum of the original plaintext values.
+
+```python
+# cloud side receives encrypted c1 and c2
+
+# restore cryptosystem with the exported public key
+cs = LightPHE(algorithm_name = "Paillier", key_file = "public.txt")
 
-# homomorphic addition - private key is not required!
+# convert c1 and c2 to ciphertext objects
+c1 = cs.create_ciphertext_obj(c1)
+c2 = cs.create_ciphertext_obj(c2)
+
+# confirm that cloud cannot decrypt c1
+with pytest.raises(ValueError, match="You must have private key to perform decryption"):
+  cs.decrypt(c1)
+
+# confirm that cloud cannot decrypt c2
+with pytest.raises(ValueError, match="You must have private key to perform decryption"):
+  cs.decrypt(c2)
+
+# homomorphic addition - private key not required
 c3 = c1 + c2
 
-# proof of work
+# confirm that cloud cannot decrypt c3
+with pytest.raises(ValueError, match="You must have private key to perform decryption"):
+  cs.decrypt(c3)
+```
+
+### On-Prem Decryption
+
+This Python code snippet demonstrates the final step in a secure computation process using homomorphic encryption with the LightPHE library. After receiving the ciphertext c3 from the cloud, which is the result of homomorphic addition of two ciphertexts c1 and c2, the on-premises system (which has the private key) decrypts c3 to verify the result. The decrypted value is then asserted to be equal to the sum of the original plaintext values m1 and m2. This step ensures the correctness of the homomorphic computation performed by the cloud.
+
+```python
+# on-prem side receives c3 from cloud
+
+# restore cryptosystem with the exported private key
+cs = LightPHE(algorithm_name = "Paillier", key_file = "private.txt")
+
+# proof of work - private key required
 assert cs.decrypt(c3) == m1 + m2
 ```
 
-⚡ Notice that once can perform `c1 + c2` here without holding private key. However, just the data owner with private key can perform encryption and decryption. This is the basic definition of homomorphic encryption.
+### Scalar Multiplication
 
-Besides, Paillier is supporting multiplying ciphertexts by a known plain constant. Simply put, decryption of scalar multiplication of ciphertext is equivalent to that constant times plaintext as well. 
+Besides, Paillier is supporting multiplying ciphertexts by a known plain constant. This Python code snippet demonstrates how to perform scalar multiplication on encrypted data using homomorphic encryption with the LightPHE library. The factor k is set to 1.05, representing a 5% increase. On the cloud side, this factor is used to multiply the ciphertext c1, resulting in a new ciphertext c4. When the on-premises system, which holds the private key, receives c4, it decrypts it and verifies that the decrypted value matches the original plaintext m1 scaled by k (i.e., 1.05 * m1). This ensures that the homomorphic scalar multiplication was performed correctly on the encrypted data.
 
 ```python
 # increasing something 5%
 k = 1.05
 
-# scalar multiplication - private key is not required!
+# scalar multiplication - cloud (private key is not required)
 c4 = k * c1
 
-# proof of work
+# proof of work on-prem - private key is required
 assert cs.decrypt(c4) == k * m1
 ```
 
-⚡ Herein, `k * c1` operation can be performed by anyone without holding private key.
+### Ciphertext Regeneration
 
 Similar to the most of additively homomorphic algorithms, Paillier lets you to regenerate ciphertext while you are not breaking its plaintext restoration. You may consider to do this re-generation many times to have stronger ciphertexts.
 
@@ -160,6 +215,8 @@ assert cs.decrypt(c1_prime) == m1
 assert cs.decrypt(c1) == m1
 ```
 
+### Unsupported Operations
+
 Finally, if you try to perform an operation that algorithm does not support, then an exception will be thrown. For instance, Paillier is not homomorphic with respect to the multiplication or xor. To put it simply, you cannot multiply two ciphertexts. If you enforce this calculation, you will have an exception.
 
 ```python
@@ -229,23 +286,30 @@ You should be able run `make test` and `make lint` commands successfully before
 
 There are many ways to support a project - starring⭐️ the GitHub repo is just one 🙏
 
-You can also support this work on [Patreon](https://www.patreon.com/serengil?repo=lightphe) or [GitHub Sponsors](https://github.com/sponsors/serengil).
+You can also support this work on [Patreon](https://www.patreon.com/serengil?repo=lightphe), [GitHub Sponsors](https://github.com/sponsors/serengil) or [Buy Me a Coffee](https://buymeacoffee.com/serengil).
 
 <a href="https://www.patreon.com/serengil?repo=lightphe">
 <img src="https://raw.githubusercontent.com/serengil/LightPHE/master/icons/patreon.png" width="30%" height="30%">
 </a>
 
+<a href="https://buymeacoffee.com/serengil">
+<img src="https://raw.githubusercontent.com/serengil/LightPHE/master/icons/bmc-button.png" width="25%" height="25%">
+</a>
+
+Also, your company's logo will be shown on README on GitHub if you become sponsor in gold, silver or bronze tiers.
+
 # Citation
 
 Please cite LightPHE in your publications if it helps your research. Here is its BibTex entry:
 
 ```BibTeX
-@misc{serengil2023lightphe,
-  abstract     = {A Lightweight Partially Homomorphic Encryption Library for Python},
-  author       = {Serengil, Sefik Ilkin},
-  title        = {LightPHE},
-  howpublished = {https://github.com/serengil/LightPHE},
-  year         = {2023}
+@misc{serengil2024lightphe,
+   title     = {LightPHE: Integrating Partially Homomorphic Encryption into Python with Extensive Cloud Environment Evaluations}, 
+   author    = {Serengil, Sefik Ilkin and Ozpinar, Alper},
+   year      = {2024},
+   publisher = {arXiv},
+   url       = {https://arxiv.org/abs/2408.05219},
+   doi       = {10.48550/arXiv.2408.05219}
 }
 ```
 

{lightphe-0.0.6 → lightphe-0.0.8}/README.md

@@ -2,16 +2,19 @@
 
 <div align="center">
 
-[![PyPI Downloads](https://static.pepy.tech/personalized-badge/lightphe?period=total&units=international_system&left_color=grey&right_color=blue&left_text=pypi%20downloads)](https://pepy.tech/project/lightphe)
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/lightphe?period=total&units=international_system&left_color=grey&right_color=blue&left_text=downloads)](https://pepy.tech/project/lightphe)
 [![Stars](https://img.shields.io/github/stars/serengil/LightPHE?color=yellow&style=flat&label=%E2%AD%90%20stars)](https://github.com/serengil/LightPHE/stargazers)
 [![Tests](https://github.com/serengil/LightPHE/actions/workflows/tests.yml/badge.svg)](https://github.com/serengil/LightPHE/actions/workflows/tests.yml)
 [![License](http://img.shields.io/:license-MIT-green.svg?style=flat)](https://github.com/serengil/LightPHE/blob/master/LICENSE)
-[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dserengil%26type%3Dpatrons&style=flat)](https://www.patreon.com/serengil?repo=lightphe)
-[![GitHub Sponsors](https://img.shields.io/github/sponsors/serengil?logo=GitHub&color=lightgray)](https://github.com/sponsors/serengil)
+[![DOI](http://img.shields.io/:DOI-10.48550/arXiv.2408.05219-blue.svg?style=flat)](https://arxiv.org/abs/2408.05219)
 
 [![Blog](https://img.shields.io/:blog-sefiks.com-blue.svg?style=flat&logo=wordpress)](https://sefiks.com)
 [![YouTube](https://img.shields.io/:youtube-@sefiks-red.svg?style=flat&logo=youtube)](https://www.youtube.com/@sefiks?sub_confirmation=1)
-[![Twitter](https://img.shields.io/:follow-@serengil-blue.svg?style=flat&logo=twitter)](https://twitter.com/intent/user?screen_name=serengil)
+[![Twitter](https://img.shields.io/:follow-@serengil-blue.svg?style=flat&logo=x)](https://twitter.com/intent/user?screen_name=serengil)
+
+[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dserengil%26type%3Dpatrons&style=flat)](https://www.patreon.com/serengil?repo=lightphe)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/serengil?logo=GitHub&color=lightgray)](https://github.com/sponsors/serengil)
+[![Buy Me a Coffee](https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee)](https://buymeacoffee.com/serengil)
 
 </div>
 
@@ -93,47 +96,99 @@ m = 17
 # calculate ciphertext
 c = cs.encrypt(m)
 
+# proof of work
 assert cs.decrypt(c) == m
 ```
 
 # Homomorphic Operations
 
-Once you have the ciphertext, you will be able to perform homomorphic operations on encrypted data. For instance, Paillier is homomorphic with respect to the addition. In other words, decryption of the addition of two ciphertexts is equivalent to addition of plaintexts. 
+Once you have the ciphertext, you will be able to perform homomorphic operations on encrypted data without holding private key. For instance, Paillier is homomorphic with respect to the addition. In other words, decryption of the addition of two ciphertexts is equivalent to addition of plaintexts.
+
+### On-Prem Encryption
+
+This Python code snippet demonstrates how to generate a private-public key pair using the Paillier cryptosystem via the LightPHE library. First, an instance of the LightPHE class is created with the Paillier algorithm. Then, the public key is exported and saved to a file named "public.txt" to build the same cryptosystem with only public key in the cloud side later. The code defines two plaintext values, m1 and m2, respectively. These plaintext values are encrypted to generate ciphertexts c1 and c2 using the public key. Finally, the ciphertexts c1 and c2 are prepared to be sent to a cloud system for secure processing or storage.
 
 ```python
+# generate private-public key pair
 cs = LightPHE(algorithm_name = "Paillier")
 
+# export public key to build same cryptosystem with only public key in the cloud
+cs.export_keys(target_file = "public.txt", public = True)
+
+# export private key to build same cryptosystem on-prem later
+cs.export_keys(target_file = "private.txt", public = False)
+
 # define plaintexts
 m1 = 17
 m2 = 23
 
 # calculate ciphertexts
-c1 = cs.encrypt(m1)
-c2 = cs.encrypt(m2)
+c1 = cs.encrypt(m1).value
+c2 = cs.encrypt(m2).value
+
+# send c1 and c2 pair to a cloud system
+```
+
+### Homomorphic Operations on Cloud
+
+This Python code snippet illustrates how to handle encrypted data on the cloud side using the Paillier cryptosystem with the LightPHE library. Upon receiving the encrypted values c1 and c2, the cloud system initializes the cryptosystem using the exported public key stored in public.txt. To ensure the security of the data, a test is performed to confirm that the cloud system cannot decrypt c1 and c2 without the private key. This is done using the pytest library, which raises a ValueError if decryption is attempted, verifying that decryption is not possible without the private key. Finally, the code demonstrates homomorphic addition by adding the two ciphertexts, resulting in a new ciphertext c3 that represents the encrypted sum of the original plaintext values.
+
+```python
+# cloud side receives encrypted c1 and c2
+
+# restore cryptosystem with the exported public key
+cs = LightPHE(algorithm_name = "Paillier", key_file = "public.txt")
 
-# homomorphic addition - private key is not required!
+# convert c1 and c2 to ciphertext objects
+c1 = cs.create_ciphertext_obj(c1)
+c2 = cs.create_ciphertext_obj(c2)
+
+# confirm that cloud cannot decrypt c1
+with pytest.raises(ValueError, match="You must have private key to perform decryption"):
+  cs.decrypt(c1)
+
+# confirm that cloud cannot decrypt c2
+with pytest.raises(ValueError, match="You must have private key to perform decryption"):
+  cs.decrypt(c2)
+
+# homomorphic addition - private key not required
 c3 = c1 + c2
 
-# proof of work
+# confirm that cloud cannot decrypt c3
+with pytest.raises(ValueError, match="You must have private key to perform decryption"):
+  cs.decrypt(c3)
+```
+
+### On-Prem Decryption
+
+This Python code snippet demonstrates the final step in a secure computation process using homomorphic encryption with the LightPHE library. After receiving the ciphertext c3 from the cloud, which is the result of homomorphic addition of two ciphertexts c1 and c2, the on-premises system (which has the private key) decrypts c3 to verify the result. The decrypted value is then asserted to be equal to the sum of the original plaintext values m1 and m2. This step ensures the correctness of the homomorphic computation performed by the cloud.
+
+```python
+# on-prem side receives c3 from cloud
+
+# restore cryptosystem with the exported private key
+cs = LightPHE(algorithm_name = "Paillier", key_file = "private.txt")
+
+# proof of work - private key required
 assert cs.decrypt(c3) == m1 + m2
 ```
 
-⚡ Notice that once can perform `c1 + c2` here without holding private key. However, just the data owner with private key can perform encryption and decryption. This is the basic definition of homomorphic encryption.
+### Scalar Multiplication
 
-Besides, Paillier is supporting multiplying ciphertexts by a known plain constant. Simply put, decryption of scalar multiplication of ciphertext is equivalent to that constant times plaintext as well. 
+Besides, Paillier is supporting multiplying ciphertexts by a known plain constant. This Python code snippet demonstrates how to perform scalar multiplication on encrypted data using homomorphic encryption with the LightPHE library. The factor k is set to 1.05, representing a 5% increase. On the cloud side, this factor is used to multiply the ciphertext c1, resulting in a new ciphertext c4. When the on-premises system, which holds the private key, receives c4, it decrypts it and verifies that the decrypted value matches the original plaintext m1 scaled by k (i.e., 1.05 * m1). This ensures that the homomorphic scalar multiplication was performed correctly on the encrypted data.
 
 ```python
 # increasing something 5%
 k = 1.05
 
-# scalar multiplication - private key is not required!
+# scalar multiplication - cloud (private key is not required)
 c4 = k * c1
 
-# proof of work
+# proof of work on-prem - private key is required
 assert cs.decrypt(c4) == k * m1
 ```
 
-⚡ Herein, `k * c1` operation can be performed by anyone without holding private key.
+### Ciphertext Regeneration
 
 Similar to the most of additively homomorphic algorithms, Paillier lets you to regenerate ciphertext while you are not breaking its plaintext restoration. You may consider to do this re-generation many times to have stronger ciphertexts.
 
@@ -144,6 +199,8 @@ assert cs.decrypt(c1_prime) == m1
 assert cs.decrypt(c1) == m1
 ```
 
+### Unsupported Operations
+
 Finally, if you try to perform an operation that algorithm does not support, then an exception will be thrown. For instance, Paillier is not homomorphic with respect to the multiplication or xor. To put it simply, you cannot multiply two ciphertexts. If you enforce this calculation, you will have an exception.
 
 ```python
@@ -213,23 +270,30 @@ You should be able run `make test` and `make lint` commands successfully before
 
 There are many ways to support a project - starring⭐️ the GitHub repo is just one 🙏
 
-You can also support this work on [Patreon](https://www.patreon.com/serengil?repo=lightphe) or [GitHub Sponsors](https://github.com/sponsors/serengil).
+You can also support this work on [Patreon](https://www.patreon.com/serengil?repo=lightphe), [GitHub Sponsors](https://github.com/sponsors/serengil) or [Buy Me a Coffee](https://buymeacoffee.com/serengil).
 
 <a href="https://www.patreon.com/serengil?repo=lightphe">
 <img src="https://raw.githubusercontent.com/serengil/LightPHE/master/icons/patreon.png" width="30%" height="30%">
 </a>
 
+<a href="https://buymeacoffee.com/serengil">
+<img src="https://raw.githubusercontent.com/serengil/LightPHE/master/icons/bmc-button.png" width="25%" height="25%">
+</a>
+
+Also, your company's logo will be shown on README on GitHub if you become sponsor in gold, silver or bronze tiers.
+
 # Citation
 
 Please cite LightPHE in your publications if it helps your research. Here is its BibTex entry:
 
 ```BibTeX
-@misc{serengil2023lightphe,
-  abstract     = {A Lightweight Partially Homomorphic Encryption Library for Python},
-  author       = {Serengil, Sefik Ilkin},
-  title        = {LightPHE},
-  howpublished = {https://github.com/serengil/LightPHE},
-  year         = {2023}
+@misc{serengil2024lightphe,
+   title     = {LightPHE: Integrating Partially Homomorphic Encryption into Python with Extensive Cloud Environment Evaluations}, 
+   author    = {Serengil, Sefik Ilkin and Ozpinar, Alper},
+   year      = {2024},
+   publisher = {arXiv},
+   url       = {https://arxiv.org/abs/2408.05219},
+   doi       = {10.48550/arXiv.2408.05219}
 }
 ```
 

{lightphe-0.0.6 → lightphe-0.0.8}/lightphe/__init__.py

@@ -229,8 +229,8 @@ class LightPHE:
         Returns:
             ciphertext (from lightphe.models.Ciphertext import Ciphertext): encrypted message
         """
-        if self.cs.keys.get("private_key") is None:
-            raise ValueError("You must have private key to perform decryption")
+        if self.cs.keys.get("public_key") is None:
+            raise ValueError("You must have public key to perform decryption")
 
         ciphertext_new = self.cs.reencrypt(ciphertext=ciphertext.value)
         return Ciphertext(

{lightphe-0.0.6 → lightphe-0.0.8}/lightphe/cryptosystems/ElGamal.py

@@ -1,7 +1,12 @@
+# built-in dependencies
 import random
-import math
+import decimal
 from typing import Optional
+
+# 3rd party dependencies
 import sympy
+
+# project dependencies
 from lightphe.models.Homomorphic import Homomorphic
 from lightphe.commons.logger import Logger
 
@@ -45,7 +50,9 @@ class ElGamal(Homomorphic):
         p = sympy.randprime(100, 2 ** int(key_size / 2) - 1)
 
         # picking a generator g
-        g = random.randint(2, int(math.sqrt(p)))
+        # g = random.randint(2, int(math.sqrt(p))) # reaches int limit for 3072-bit key
+        # g = int(random.uniform(2, float(decimal.Decimal(p).sqrt())))
+        g = random.randint(2, int(decimal.Decimal(p).sqrt()))
 
         # picking a private key x
         x = random.randint(1, p - 2)

{lightphe-0.0.6 → lightphe-0.0.8}/lightphe/cryptosystems/GoldwasserMicali.py

@@ -128,7 +128,12 @@ class GoldwasserMicali(Homomorphic):
             xp = i % p
             xq = i % q
 
-            if pow(xp, int((p - 1) / 2), p) == 1 and pow(xq, int((q - 1) / 2), q) == 1:
+            # reaches int limit for 3072-bit key
+            # if pow(xp, int((p - 1) / 2), p) == 1 and pow(xq, int((q - 1) / 2), q) == 1:
+            if (
+                pow(xp, int((p - 1) // 2), p) == 1
+                and pow(xq, int((q - 1) // 2), q) == 1
+            ):
                 m_binaries.append("0")
             else:
                 m_binaries.append("1")

{lightphe-0.0.6 → lightphe-0.0.8}/lightphe.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lightphe
-Version: 0.0.6
+Version: 0.0.8
 Summary: A Lightweight Partially Homomorphic Encryption Library for Python
 Home-page: https://github.com/serengil/LightPHE
 Author: Sefik Ilkin Serengil
@@ -18,16 +18,19 @@ License-File: LICENSE
 
 <div align="center">
 
-[![PyPI Downloads](https://static.pepy.tech/personalized-badge/lightphe?period=total&units=international_system&left_color=grey&right_color=blue&left_text=pypi%20downloads)](https://pepy.tech/project/lightphe)
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/lightphe?period=total&units=international_system&left_color=grey&right_color=blue&left_text=downloads)](https://pepy.tech/project/lightphe)
 [![Stars](https://img.shields.io/github/stars/serengil/LightPHE?color=yellow&style=flat&label=%E2%AD%90%20stars)](https://github.com/serengil/LightPHE/stargazers)
 [![Tests](https://github.com/serengil/LightPHE/actions/workflows/tests.yml/badge.svg)](https://github.com/serengil/LightPHE/actions/workflows/tests.yml)
 [![License](http://img.shields.io/:license-MIT-green.svg?style=flat)](https://github.com/serengil/LightPHE/blob/master/LICENSE)
-[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dserengil%26type%3Dpatrons&style=flat)](https://www.patreon.com/serengil?repo=lightphe)
-[![GitHub Sponsors](https://img.shields.io/github/sponsors/serengil?logo=GitHub&color=lightgray)](https://github.com/sponsors/serengil)
+[![DOI](http://img.shields.io/:DOI-10.48550/arXiv.2408.05219-blue.svg?style=flat)](https://arxiv.org/abs/2408.05219)
 
 [![Blog](https://img.shields.io/:blog-sefiks.com-blue.svg?style=flat&logo=wordpress)](https://sefiks.com)
 [![YouTube](https://img.shields.io/:youtube-@sefiks-red.svg?style=flat&logo=youtube)](https://www.youtube.com/@sefiks?sub_confirmation=1)
-[![Twitter](https://img.shields.io/:follow-@serengil-blue.svg?style=flat&logo=twitter)](https://twitter.com/intent/user?screen_name=serengil)
+[![Twitter](https://img.shields.io/:follow-@serengil-blue.svg?style=flat&logo=x)](https://twitter.com/intent/user?screen_name=serengil)
+
+[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dserengil%26type%3Dpatrons&style=flat)](https://www.patreon.com/serengil?repo=lightphe)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/serengil?logo=GitHub&color=lightgray)](https://github.com/sponsors/serengil)
+[![Buy Me a Coffee](https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee)](https://buymeacoffee.com/serengil)
 
 </div>
 
@@ -109,47 +112,99 @@ m = 17
 # calculate ciphertext
 c = cs.encrypt(m)
 
+# proof of work
 assert cs.decrypt(c) == m
 ```
 
 # Homomorphic Operations
 
-Once you have the ciphertext, you will be able to perform homomorphic operations on encrypted data. For instance, Paillier is homomorphic with respect to the addition. In other words, decryption of the addition of two ciphertexts is equivalent to addition of plaintexts. 
+Once you have the ciphertext, you will be able to perform homomorphic operations on encrypted data without holding private key. For instance, Paillier is homomorphic with respect to the addition. In other words, decryption of the addition of two ciphertexts is equivalent to addition of plaintexts.
+
+### On-Prem Encryption
+
+This Python code snippet demonstrates how to generate a private-public key pair using the Paillier cryptosystem via the LightPHE library. First, an instance of the LightPHE class is created with the Paillier algorithm. Then, the public key is exported and saved to a file named "public.txt" to build the same cryptosystem with only public key in the cloud side later. The code defines two plaintext values, m1 and m2, respectively. These plaintext values are encrypted to generate ciphertexts c1 and c2 using the public key. Finally, the ciphertexts c1 and c2 are prepared to be sent to a cloud system for secure processing or storage.
 
 ```python
+# generate private-public key pair
 cs = LightPHE(algorithm_name = "Paillier")
 
+# export public key to build same cryptosystem with only public key in the cloud
+cs.export_keys(target_file = "public.txt", public = True)
+
+# export private key to build same cryptosystem on-prem later
+cs.export_keys(target_file = "private.txt", public = False)
+
 # define plaintexts
 m1 = 17
 m2 = 23
 
 # calculate ciphertexts
-c1 = cs.encrypt(m1)
-c2 = cs.encrypt(m2)
+c1 = cs.encrypt(m1).value
+c2 = cs.encrypt(m2).value
+
+# send c1 and c2 pair to a cloud system
+```
+
+### Homomorphic Operations on Cloud
+
+This Python code snippet illustrates how to handle encrypted data on the cloud side using the Paillier cryptosystem with the LightPHE library. Upon receiving the encrypted values c1 and c2, the cloud system initializes the cryptosystem using the exported public key stored in public.txt. To ensure the security of the data, a test is performed to confirm that the cloud system cannot decrypt c1 and c2 without the private key. This is done using the pytest library, which raises a ValueError if decryption is attempted, verifying that decryption is not possible without the private key. Finally, the code demonstrates homomorphic addition by adding the two ciphertexts, resulting in a new ciphertext c3 that represents the encrypted sum of the original plaintext values.
+
+```python
+# cloud side receives encrypted c1 and c2
+
+# restore cryptosystem with the exported public key
+cs = LightPHE(algorithm_name = "Paillier", key_file = "public.txt")
 
-# homomorphic addition - private key is not required!
+# convert c1 and c2 to ciphertext objects
+c1 = cs.create_ciphertext_obj(c1)
+c2 = cs.create_ciphertext_obj(c2)
+
+# confirm that cloud cannot decrypt c1
+with pytest.raises(ValueError, match="You must have private key to perform decryption"):
+  cs.decrypt(c1)
+
+# confirm that cloud cannot decrypt c2
+with pytest.raises(ValueError, match="You must have private key to perform decryption"):
+  cs.decrypt(c2)
+
+# homomorphic addition - private key not required
 c3 = c1 + c2
 
-# proof of work
+# confirm that cloud cannot decrypt c3
+with pytest.raises(ValueError, match="You must have private key to perform decryption"):
+  cs.decrypt(c3)
+```
+
+### On-Prem Decryption
+
+This Python code snippet demonstrates the final step in a secure computation process using homomorphic encryption with the LightPHE library. After receiving the ciphertext c3 from the cloud, which is the result of homomorphic addition of two ciphertexts c1 and c2, the on-premises system (which has the private key) decrypts c3 to verify the result. The decrypted value is then asserted to be equal to the sum of the original plaintext values m1 and m2. This step ensures the correctness of the homomorphic computation performed by the cloud.
+
+```python
+# on-prem side receives c3 from cloud
+
+# restore cryptosystem with the exported private key
+cs = LightPHE(algorithm_name = "Paillier", key_file = "private.txt")
+
+# proof of work - private key required
 assert cs.decrypt(c3) == m1 + m2
 ```
 
-⚡ Notice that once can perform `c1 + c2` here without holding private key. However, just the data owner with private key can perform encryption and decryption. This is the basic definition of homomorphic encryption.
+### Scalar Multiplication
 
-Besides, Paillier is supporting multiplying ciphertexts by a known plain constant. Simply put, decryption of scalar multiplication of ciphertext is equivalent to that constant times plaintext as well. 
+Besides, Paillier is supporting multiplying ciphertexts by a known plain constant. This Python code snippet demonstrates how to perform scalar multiplication on encrypted data using homomorphic encryption with the LightPHE library. The factor k is set to 1.05, representing a 5% increase. On the cloud side, this factor is used to multiply the ciphertext c1, resulting in a new ciphertext c4. When the on-premises system, which holds the private key, receives c4, it decrypts it and verifies that the decrypted value matches the original plaintext m1 scaled by k (i.e., 1.05 * m1). This ensures that the homomorphic scalar multiplication was performed correctly on the encrypted data.
 
 ```python
 # increasing something 5%
 k = 1.05
 
-# scalar multiplication - private key is not required!
+# scalar multiplication - cloud (private key is not required)
 c4 = k * c1
 
-# proof of work
+# proof of work on-prem - private key is required
 assert cs.decrypt(c4) == k * m1
 ```
 
-⚡ Herein, `k * c1` operation can be performed by anyone without holding private key.
+### Ciphertext Regeneration
 
 Similar to the most of additively homomorphic algorithms, Paillier lets you to regenerate ciphertext while you are not breaking its plaintext restoration. You may consider to do this re-generation many times to have stronger ciphertexts.
 
@@ -160,6 +215,8 @@ assert cs.decrypt(c1_prime) == m1
 assert cs.decrypt(c1) == m1
 ```
 
+### Unsupported Operations
+
 Finally, if you try to perform an operation that algorithm does not support, then an exception will be thrown. For instance, Paillier is not homomorphic with respect to the multiplication or xor. To put it simply, you cannot multiply two ciphertexts. If you enforce this calculation, you will have an exception.
 
 ```python
@@ -229,23 +286,30 @@ You should be able run `make test` and `make lint` commands successfully before
 
 There are many ways to support a project - starring⭐️ the GitHub repo is just one 🙏
 
-You can also support this work on [Patreon](https://www.patreon.com/serengil?repo=lightphe) or [GitHub Sponsors](https://github.com/sponsors/serengil).
+You can also support this work on [Patreon](https://www.patreon.com/serengil?repo=lightphe), [GitHub Sponsors](https://github.com/sponsors/serengil) or [Buy Me a Coffee](https://buymeacoffee.com/serengil).
 
 <a href="https://www.patreon.com/serengil?repo=lightphe">
 <img src="https://raw.githubusercontent.com/serengil/LightPHE/master/icons/patreon.png" width="30%" height="30%">
 </a>
 
+<a href="https://buymeacoffee.com/serengil">
+<img src="https://raw.githubusercontent.com/serengil/LightPHE/master/icons/bmc-button.png" width="25%" height="25%">
+</a>
+
+Also, your company's logo will be shown on README on GitHub if you become sponsor in gold, silver or bronze tiers.
+
 # Citation
 
 Please cite LightPHE in your publications if it helps your research. Here is its BibTex entry:
 
 ```BibTeX
-@misc{serengil2023lightphe,
-  abstract     = {A Lightweight Partially Homomorphic Encryption Library for Python},
-  author       = {Serengil, Sefik Ilkin},
-  title        = {LightPHE},
-  howpublished = {https://github.com/serengil/LightPHE},
-  year         = {2023}
+@misc{serengil2024lightphe,
+   title     = {LightPHE: Integrating Partially Homomorphic Encryption into Python with Extensive Cloud Environment Evaluations}, 
+   author    = {Serengil, Sefik Ilkin and Ozpinar, Alper},
+   year      = {2024},
+   publisher = {arXiv},
+   url       = {https://arxiv.org/abs/2408.05219},
+   doi       = {10.48550/arXiv.2408.05219}
 }
 ```
 

{lightphe-0.0.6 → lightphe-0.0.8}/setup.py

@@ -8,7 +8,7 @@ with open("requirements.txt", "r", encoding="utf-8") as f:
 
 setuptools.setup(
     name="lightphe",
-    version="0.0.6",
+    version="0.0.8",
     author="Sefik Ilkin Serengil",
     author_email="serengil@gmail.com",
     description="A Lightweight Partially Homomorphic Encryption Library for Python",