feat: adapt to findex v4

Author: Manuthor

.github/workflows/ci.yml

@@ -95,6 +95,7 @@ jobs:
       destination: linux-x86-64
       os: ubuntu-20.04
       kms-version: 4.3.3
+      findex-cloud-version: 0.1.0
       copy_fresh_build: false
       copy_regression_files: |
         cp ./cloudproof_python/non_regression_vector.json src/test/resources/cover_crypt/non_regression/python_non_regression_vector.json

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## Unreleased
+## [4.0.0] - 2023-06-01
 
 ### Features
 
@@ -21,6 +21,11 @@ All notable changes to this project will be documented in this file.
     - add deletions
   - change compact interface:
     - change parameter order
+- add data anonymization methods such as:
+  - noise methods
+  - hash methods
+  - number methods
+  - word methods
 
 ---
 

README.md

@@ -94,6 +94,7 @@ This table shows the minimum version correspondence between the various componen
 
 | `cloudproof_py` | CoverCrypt | Findex      | KMS   |
 | --------------- | ---------- | ----------- | ----- |
+| >=4.0.0         | 11.0.0     | 4.0.0,4.0.1 | 4.3.3 |
 | >=3.0.0         | 11.0.0     | 3.0.0       | 4.3.3 |
 | >=2.0.0         | 10.0.0     | 2.0.1,2.1.0 | 4.2.0 |
 | >=1.0.0         | 8.0.1      | 2.0.0       | -     |

examples/cli_demo/findex_db.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 import sqlite3
-from cloudproof_py.findex import Findex
+from typing import Dict, List, Set, Tuple, Sequence
 
-from typing import Dict, List, Set, Tuple
+from cloudproof_py.findex import Findex
 
 
 class FindexSQLite(Findex.FindexUpsert, Findex.FindexSearch):
@@ -12,25 +12,27 @@ def __init__(self, db_conn: sqlite3.Connection) -> None:
         super().__init__()
         self.conn = db_conn
 
-    def fetch_entry_table(self, entry_uids: List[bytes]) -> Dict[bytes, bytes]:
+    def fetch_entry_table(
+        self, entry_uids: List[bytes]
+    ) -> Sequence[Tuple[bytes, bytes]]:
         """Query the Entry Table.
 
         Args:
             entry_uids (List[bytes], optional): uids to query. if None, return the entire table
 
         Returns:
-            Dict[bytes, bytes]: uid -> value mapping
+            Sequence[Tuple[bytes, bytes]]: uid -> value mapping
         """
         str_uids = ",".join("?" * len(entry_uids))
         cur = self.conn.execute(
             f"SELECT uid, value FROM entry_table WHERE uid IN ({str_uids})",
             entry_uids,
         )
         values = cur.fetchall()
-        output_dict = {}
+        output_array = []
         for value in values:
-            output_dict[value[0]] = value[1]
-        return output_dict
+            output_array.append((value[0], value[1]))
+        return output_array
 
     def fetch_all_entry_table_uids(self) -> Set[bytes]:
         """Return all UIDs in the Entry Table.

examples/findex_upsert_search/findex_dict.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 from cloudproof_py.findex import Findex
 
-from typing import Dict, List, Tuple
+from typing import Dict, List, Tuple, Sequence
 
 
 class FindexDict(Findex.FindexUpsert, Findex.FindexSearch):
@@ -14,19 +14,21 @@ def __init__(self) -> None:
         self.chain_table: Dict[bytes, bytes] = {}
 
     # Implement callback functions
-    def fetch_entry_table(self, entry_uids: List[bytes]) -> Dict[bytes, bytes]:
+    def fetch_entry_table(
+        self, entry_uids: List[bytes]
+    ) -> Sequence[Tuple[bytes, bytes]]:
         """Query the Entry Table.
 
         Args:
             entry_uids (List[bytes], optional): uids to query. if None, return the entire table
 
         Returns:
-            Dict[bytes, bytes]: uid -> value mapping
+            Sequence[Tuple[bytes, bytes]]: uid -> value mapping
         """
-        res = {}
+        res = []
         for uid in entry_uids:
             if uid in self.entry_table:
-                res[uid] = self.entry_table[uid]
+                res.append((uid, self.entry_table[uid]))
         return res
 
     def fetch_chain_table(self, chain_uids: List[bytes]) -> Dict[bytes, bytes]:

examples/findex_upsert_search/findex_redis.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 from cloudproof_py.findex import Findex
 
-from typing import Dict, List, Tuple
+from typing import Dict, List, Tuple, Sequence
 import redis
 
 
@@ -16,20 +16,22 @@ def __init__(self) -> None:
         self.prefix_chain = b"chain:"
 
     # Implement callback functions
-    def fetch_entry_table(self, entry_uids: List[bytes]) -> Dict[bytes, bytes]:
+    def fetch_entry_table(
+        self, entry_uids: List[bytes]
+    ) -> Sequence[Tuple[bytes, bytes]]:
         """Query the Entry Table.
 
         Args:
             entry_uids (List[bytes], optional): uids to query. if None, return the entire table
 
         Returns:
-            Dict[bytes, bytes]: uid -> value mapping
+            Sequence[Tuple[bytes, bytes]]: uid -> value mapping
         """
-        res = {}
+        res = []
         for uid in entry_uids:
             existing_value = self.redis.get(self.prefix_entry + uid)
             if existing_value:
-                res[uid] = existing_value
+                res.append((uid, existing_value))
         return res
 
     def fetch_chain_table(self, chain_uids: List[bytes]) -> Dict[bytes, bytes]:

examples/findex_upsert_search/findex_sqlite.py

@@ -2,7 +2,7 @@
 import sqlite3
 from cloudproof_py.findex import Findex
 
-from typing import Dict, List, Set, Tuple
+from typing import Dict, List, Set, Tuple, Sequence
 
 
 class FindexSQLite(Findex.FindexUpsert, Findex.FindexSearch):
@@ -26,24 +26,26 @@ def __init__(self) -> None:
                             );"""
         )
 
-    def fetch_entry_table(self, entry_uids: List[bytes]) -> Dict[bytes, bytes]:
+    def fetch_entry_table(
+        self, entry_uids: List[bytes]
+    ) -> Sequence[Tuple[bytes, bytes]]:
         """Query the Entry Table.
 
         Args:
             entry_uids (List[bytes], optional): uids to query. if None, return the entire table
 
         Returns:
-            Dict[bytes, bytes]: uid -> value mapping
+            Sequence[Tuple[bytes, bytes]]: uid -> value mapping
         """
         str_uids = ",".join("?" * len(entry_uids))
         cur = self.conn.execute(
             f"SELECT uid, value FROM entry_table WHERE uid IN ({str_uids})",
             entry_uids,
         )
         values = cur.fetchall()
-        output_dict = {}
+        output_dict = []
         for value in values:
-            output_dict[value[0]] = value[1]
+            output_dict.append((value[0], value[1]))
         return output_dict
 
     def fetch_all_entry_table_uids(self) -> Set[bytes]:

pyproject.toml

@@ -7,7 +7,7 @@ cloudproof_py = ["py.typed", "*.pyi"]
 
 [project]
 name = "cloudproof_py"
-version = "3.1.0"
+version = "4.0.0"
 authors = [{ name = "Cosmian Tech", email = "tech@cosmian.com" }]
 description = "Python library for Cosmian Cloudproof"
 readme = "README.md"
@@ -17,6 +17,7 @@ classifiers = [
   "Operating System :: OS Independent",
 ]
 dependencies = [
+  "cloudproof-anonymization >= 0.1.0, < 1.0.0",
   "cover-crypt >= 11.0.0, < 12.0.0",
   "findex >= 4.0.0, < 5.0.0",
   "cosmian-kms >= 4.3.3, < 5.0.0",

scripts/ci_install_pyo3_builds.sh

@@ -8,9 +8,9 @@ install_lib() {
         rm linux.zip && rm -rf x86_64*
 }
 
-install_lib "v2.1.0"
+install_lib "v2.0.1"
 if [ $? -ne 0 ]; then
-    install_lib "last_build/feature/rust_anonymization"
+    install_lib "last_build/release/v2.0.1"
 fi
 
 exit 0

src/cloudproof_py/findex/Findex.py

@@ -50,14 +50,16 @@ def upsert(
         self.findex_core.upsert_wrapper(master_key, label, additions, deletions)
 
     @abstractmethod
-    def fetch_entry_table(self, entry_uids: List[bytes]) -> Dict[bytes, bytes]:
+    def fetch_entry_table(
+        self, entry_uids: List[bytes]
+    ) -> Sequence[Tuple[bytes, bytes]]:
         """Query the Entry Table.
 
         Args:
             entry_uids (List[bytes], optional): uids to query. if None, return the entire table
 
         Returns:
-            Dict[bytes, bytes]: uid -> value mapping
+           Sequence[Tuple[bytes, bytes]]: uid -> value mapping
         """
 
     @abstractmethod
@@ -92,14 +94,16 @@ def __init__(self) -> None:
         )
 
     @abstractmethod
-    def fetch_entry_table(self, entry_uids: List[bytes]) -> Dict[bytes, bytes]:
+    def fetch_entry_table(
+        self, entry_uids: List[bytes]
+    ) -> Sequence[Tuple[bytes, bytes]]:
         """Query the Entry Table.
 
         Args:
             entry_uids (List[bytes], optional): uids to query. if None, return the entire table
 
         Returns:
-            Dict[bytes, bytes]: uid -> value mapping
+            Sequence[Tuple[bytes, bytes]]: uid -> value mapping
         """
 
     @abstractmethod
@@ -154,14 +158,16 @@ def __init__(self) -> None:
         )
 
     @abstractmethod
-    def fetch_entry_table(self, entry_uids: List[bytes]) -> Dict[bytes, bytes]:
+    def fetch_entry_table(
+        self, entry_uids: List[bytes]
+    ) -> Sequence[Tuple[bytes, bytes]]:
         """Query the Entry Table.
 
         Args:
             entry_uids (List[bytes]): uids to query
 
         Returns:
-            Dict[bytes, bytes]: uid -> value mapping
+            Sequence[Tuple[bytes, bytes]]: uid -> value mapping
         """
 
     @abstractmethod