feat: update to findex 5.0.0

Author: Hugo Rosenkranz-Costa

CHANGELOG.md

@@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file.
 
 ### Features
 
+- Update to findex 5.0.0
 - Support KMS v4.5.0 with tagging support
 
 ## [4.0.2] - 2023-07-17

README.md

@@ -24,9 +24,9 @@ The library is available under a dual licensing scheme Affero GPL/v3 and commerc
 
 The library is based on:
 
-- [CoverCrypt](https://github.com/Cosmian/cover_crypt) algorithm which allows
+- [Covercrypt](https://github.com/Cosmian/cover_crypt) algorithm which allows
   creating ciphertexts for a set of attributes and issuing user keys with access
-  policies over these attributes. `CoverCrypt` offers Post-Quantum resistance.
+  policies over these attributes. `Covercrypt` offers Post-Quantum resistance.
 
 - [Findex](https://github.com/Cosmian/findex) which is a cryptographic protocol designed to securely make search queries on
   an untrusted cloud server. Thanks to its encrypted indexes, large databases can
@@ -48,7 +48,7 @@ Please [check the online documentation](https://docs.cosmian.com/cloudproof_encr
 
 An interactive CLI demo combining policy-based encryption with searchable keywords.
 
-Users data from `./examples/cli_demo/data.json` are encrypted using CoverCrypt and indexed via Findex.
+Users data from `./examples/cli_demo/data.json` are encrypted using Covercrypt and indexed via Findex.
 
 Try the demo:
 
@@ -88,15 +88,15 @@ The generated documentation will be in `./docs/_build/html`.
 
 ## Versions Correspondence
 
-This library depends on [CoverCrypt](https://github.com/Cosmian/cover_crypt) and [Findex](https://github.com/Cosmian/findex).
+This library depends on [Covercrypt](https://github.com/Cosmian/cover_crypt) and [Findex](https://github.com/Cosmian/findex).
 
 This table shows the minimum version correspondence between the various components.
 
-| `cloudproof_py` | CoverCrypt | Findex      | KMS   |
+| `cloudproof_py` | Covercrypt | Findex      | KMS   |
 | --------------- | ---------- | ----------- | ----- |
-| >=4.1.0         | 11.0.0     | 4.0.0,4.0.1 | 4.5.0 |
-| >=4.0.2         | 11.0.0     | 4.0.0,4.0.1 | 4.4.3 |
-| >=4.0.1         | 11.0.0     | 4.0.0,4.0.1 | 4.4.2 |
+| >=4.1.0         | 12.0.0     | 5.0.0       | 4.5.0 |
+| >=4.0.2         | 11.0.0     | 4.0.1       | 4.4.3 |
+| >=4.0.1         | 11.0.0     | 4.0.1       | 4.4.2 |
 | >=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 |

pyproject.toml

@@ -19,7 +19,7 @@ classifiers = [
 dependencies = [
   "cloudproof-anonymization >= 0.1.0, < 1.0.0",
   "cover-crypt >= 11.0.0, < 12.0.0",
-  "findex >= 4.0.0, < 5.0.0",
+  "findex >= 5.0.0, < 6.0.0",
   "cosmian-kms >= 4.5.0, < 5.0.0",
   "cloudproof-fpe >= 0.1.0, < 1.0.0",
 ]

src/cloudproof_py/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+import importlib.metadata
+
+__version__ = importlib.metadata.version(__package__ or __name__)

src/cloudproof_py/findex/Findex.py

@@ -36,7 +36,7 @@ def upsert(
         label: Label,
         additions: IndexedValuesAndKeywords,
         deletions: IndexedValuesAndKeywords,
-    ) -> None:
+    ) -> Set[Keyword]:
         """Upserts the given relations between `IndexedValue` and `Keyword` into Findex tables.
 
         Args:
@@ -47,7 +47,7 @@ def upsert(
             deletions (Dict[Location | Keyword, List[Keyword | str]]):
                 map of `IndexedValue` to a list of `Keyword` to delete from the index
         """
-        self.findex_core.upsert_wrapper(master_key, label, additions, deletions)
+        return self.findex_core.upsert_wrapper(master_key, label, additions, deletions)
 
     @abstractmethod
     def fetch_entry_table(

tests/test_findex.py

@@ -4,7 +4,7 @@
 import sqlite3
 import unittest
 from base64 import b64decode
-from typing import Dict, List, Optional, Set, Tuple, Sequence
+from typing import Dict, List, Optional, Sequence, Set, Tuple
 
 from cloudproof_py.findex import Findex, Keyword, Label, Location, MasterKey
 from cloudproof_py.findex.typing import IndexedValuesAndKeywords, ProgressResults
@@ -228,7 +228,10 @@ def test_sqlite_upsert_graph(self) -> None:
         indexed_values_and_keywords: IndexedValuesAndKeywords = {
             Location.from_bytes(key): value for key, value in self.users.items()
         }
-        self.interface.upsert(self.mk, self.label, indexed_values_and_keywords, {})
+        inserted_kw = self.interface.upsert(
+            self.mk, self.label, indexed_values_and_keywords, {}
+        )
+        self.assertEqual(len(inserted_kw), 5)
 
         res = self.interface.search(self.mk, self.label, ["Sheperd"])
         self.assertEqual(len(res["Sheperd"]), 2)