chore: merge branch 'release/v3.0.0'

Manuthor · Manuthor · commit 898ccbbfe2a6 · 2023-03-08T06:31:28.000+01:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -31,7 +31,7 @@ jobs:
   test:
     services:
       kms:
-        image: cosmian/kms:4.2.0
+        image: cosmian/kms:4.3.3
         env:
           COSMIAN_SERVER_URL: http://localhost:9998
           KMS_PUBLIC_PATH: /tmp
@@ -86,7 +86,7 @@ jobs:
       extension: so
       destination: linux-x86-64
       os: ubuntu-20.04
-      kms-version: 4.2.0
+      kms-version: 4.3.3
       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
@@ -98,7 +98,7 @@ jobs:
     with:
       branch: develop
       target: wasm32-unknown-unknown
-      kms-version: 4.2.0
+      kms-version: 4.3.3
       copy_fresh_build: false
       copy_regression_files: |
         cp ./cloudproof_python/non_regression_vector.json tests/data/cover_crypt/non_regression/python_non_regression_vector.json
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
+---
+
+## [3.0.0] - 2023-03-08
+
+### Features
+
+- Support cover_crypt v11.0 (#20)
+- Update to Findex 3.0 (#21)
+
+---
+
 ## [2.0.1] - 2023-02-27
 
 ### Documentation
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Cloudproof Encryption Python Library
+# Cloudproof Python Library
 
 [![PyPI version](https://badge.fury.io/py/cloudproof_py.svg)](https://badge.fury.io/py/cloudproof_py)
 ![Build status](https://github.com/Cosmian/cloudproof_python/actions/workflows/ci.yml/badge.svg)
@@ -88,5 +88,6 @@ This table shows the minimum version correspondence between the various componen
 
 | `cloudproof_py` | CoverCrypt | Findex      | KMS   |
 | --------------- | ---------- | ----------- | ----- |
+| >=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       | -     |
diff --git a/docs/conf.py b/docs/conf.py
@@ -8,7 +8,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "CloudProof_Py"
-copyright = "2022, Cosmian Tech"
+copyright = "2023, Cosmian Tech"
 author = "Cosmian Tech"
 
 # -- General configuration ---------------------------------------------------
diff --git a/examples/cli_demo/main.py b/examples/cli_demo/main.py
@@ -2,9 +2,10 @@
 import json
 import sqlite3
 from secrets import token_bytes
-from termcolor import colored
 
 from findex_db import FindexSQLite
+from termcolor import colored
+
 from cloudproof_py import cover_crypt, findex
 
 sql_create_users_table = """CREATE TABLE IF NOT EXISTS users (
@@ -17,7 +18,6 @@
                                             region BLOB NOT NULL,
                                             employeeNumber BLOB NOT NULL,
                                             security BLOB NOT NULL
-
                                         );"""
 
 sql_create_entry_table = """CREATE TABLE IF NOT EXISTS entry_table (
@@ -124,8 +124,8 @@
     findex_interface = FindexSQLite(conn)
 
     # Mapping of the users database UID to the corresponding keywords (firstname, lastname, etc)
-    mapping_indexed_values_to_keywords = {
-        findex.IndexedValue.from_location(user_id): [
+    mapping_indexed_values_to_keywords: findex.typing.IndexedValuesAndKeywords = {
+        findex.Location.from_bytes(user_id): [
             keyword.lower() for keyword in user.values()
         ]
         for user_id, user in zip(user_db_uids, users)
@@ -173,7 +173,7 @@
         if len(found_users) == 0:
             print(colored("No user found!", "red", attrs=["bold"]))
             continue
-        found_users_uids = found_users[keyword]
+        found_users_uids = [bytes(location) for location in found_users[keyword]]
 
         # 2. Query user database
         str_uids = ",".join("?" * len(found_users_uids))
diff --git a/examples/cli_demo/requirements.txt b/examples/cli_demo/requirements.txt
@@ -1,3 +1,3 @@
-cloudproof-py==2.0
+cloudproof-py==3.0
 termcolor==2.1.1
 types-termcolor==1.1.6
diff --git a/examples/cover_crypt/requirements.txt b/examples/cover_crypt/requirements.txt
@@ -1 +1 @@
-cloudproof-py==2.0
+cloudproof-py==3.0
diff --git a/examples/findex_upsert_search/main.py b/examples/findex_upsert_search/main.py
@@ -1,12 +1,13 @@
 # -*- coding: utf-8 -*-
 import argparse
-from typing import Dict, List, Union
+from typing import Union
 
 from findex_dict import FindexDict
 from findex_redis import FindexRedis
 from findex_sqlite import FindexSQLite
 
-from cloudproof_py.findex import MasterKey, Label, IndexedValue, Findex, utils
+from cloudproof_py.findex import Findex, Keyword, Label, Location, MasterKey, utils
+from cloudproof_py.findex.typing import IndexedValuesAndKeywords, ProgressResults
 
 # Simple database containing the firstname and lastname of each user.
 # Each line has a corresponding UID: 1, 2 or 3.
@@ -36,10 +37,10 @@ def main(backend: str = "Dict"):
         findex_interface = FindexDict()
 
     # Create the index
-    indexed_values_and_keywords = {}
+    indexed_values_and_keywords: IndexedValuesAndKeywords = {}
     for uid, keywords in data.items():
         # Convert database UIDs to IndexedValue expected by Findex
-        location = IndexedValue.from_location(uid.encode("utf-8"))
+        location = Location.from_string(uid)
         # This location has 2 keywords associated: the firstname and lastname
         indexed_values_and_keywords[location] = keywords
 
@@ -61,8 +62,8 @@ def main(backend: str = "Dict"):
     # Keywords can point to Locations but also to other Keywords, thus generating a graph.
 
     # Create the alias `Joe` for `John`
-    alias_graph = {
-        IndexedValue.from_keyword(b"John"): ["Joe"],
+    alias_graph: IndexedValuesAndKeywords = {
+        Keyword.from_string("John"): ["Joe"],
     }
     findex_interface.upsert(alias_graph, master_key, label)
 
@@ -91,7 +92,7 @@ def main(backend: str = "Dict"):
 
     print("Search using the `progress_callback`: ")
 
-    def echo_progress_callback(res: Dict[str, List[IndexedValue]]) -> bool:
+    def echo_progress_callback(res: ProgressResults) -> bool:
         print("\t Partial results:", res)
         return True
 
diff --git a/examples/findex_upsert_search/requirements.txt b/examples/findex_upsert_search/requirements.txt
@@ -1,3 +1,3 @@
-cloudproof-py==2.0
+cloudproof-py==3.0
 redis>=4.3
 types_redis>=4.3
diff --git a/pyproject.toml b/pyproject.toml
@@ -7,17 +7,16 @@ cloudproof_py = ["py.typed", "*.pyi"]
 
 [project]
 name = "cloudproof_py"
-version = "2.0.1"
+version = "3.0.0"
 authors = [{ name = "Cosmian Tech", email = "tech@cosmian.com" }]
 description = "Python library for Cosmian Cloud Proof"
 readme = "README.md"
 requires-python = ">=3.7"
 classifiers = [
   "Programming Language :: Python :: 3",
-  "License :: OSI Approved :: MIT License",
   "Operating System :: OS Independent",
 ]
-dependencies = ["cover-crypt >= 10.0.0, < 11.0.0", "findex >= 2.0.1, < 3.0.0", "cosmian-kms >= 4.2.0, < 5.0.0"]
+dependencies = ["cover-crypt >= 11.0.0, < 12.0.0", "findex >= 3.0.0, < 4.0.0", "cosmian-kms >= 4.3.3, < 5.0.0"]
 
 [project.urls]
 "Homepage" = "https://github.com/Cosmian/cloudproof_python"
diff --git a/scripts/ci_install_pyo3_builds.sh b/scripts/ci_install_pyo3_builds.sh
@@ -2,18 +2,13 @@
 set -ux
 
 install_lib() {
-    wget "https://package.cosmian.com/$1/$2/linux.zip" &&
+    wget "https://package.cosmian.com/cloudproof_rust/$1/linux.zip" &&
         unzip -o linux.zip &&
-        pip install --force-reinstall x86_64-unknown-linux-gnu/python-x86_64-unknown-linux-gnu/$1*.whl &&
-        rm linux.zip && rm -rf x86_64-unknown-linux-gnu
+        pip install --force-reinstall x86_64-unknown-linux-gnu/python-x86_64-unknown-linux-gnu/*.whl &&
+        rm linux.zip && rm -rf x86_64*
 }
 
-install_lib "cover_crypt" "v10.0.0"
+install_lib "v1.0.0"
 if [ $? -ne 0 ]; then
-    install_lib "cover_crypt" "last_build"
-fi
-
-install_lib "findex" "v2.1.0"
-if [ $? -ne 0 ]; then
-    install_lib "findex" "last_build"
+    install_lib "last_build/feature/pyo3-findex-cloud"
 fi
diff --git a/scripts/extract_lib_types.py b/scripts/extract_lib_types.py
@@ -7,8 +7,8 @@
 if __name__ == "__main__":
     SRC_DIR = "src/cloudproof_py"
     PKGs_dir = {
-        "cosmian_cover_crypt": f"{SRC_DIR}/cover_crypt",
-        "cosmian_findex": f"{SRC_DIR}/findex",
+        "cloudproof_cover_crypt": f"{SRC_DIR}/cover_crypt",
+        "cloudproof_findex": f"{SRC_DIR}/findex",
         "cosmian_kms": f"{SRC_DIR}/kms",
     }
 
diff --git a/src/cloudproof_py/cover_crypt/__init__.py b/src/cloudproof_py/cover_crypt/__init__.py
@@ -1,12 +1,12 @@
 # -*- coding: utf-8 -*-
-from cosmian_cover_crypt import (
+from cloudproof_cover_crypt import (
     Attribute,
-    Policy,
-    PolicyAxis,
     CoverCrypt,
-    SymmetricKey,
     MasterSecretKey,
+    Policy,
+    PolicyAxis,
     PublicKey,
+    SymmetricKey,
     UserSecretKey,
 )
 
diff --git a/src/cloudproof_py/findex/Findex.py b/src/cloudproof_py/findex/Findex.py
@@ -1,7 +1,17 @@
 # -*- coding: utf-8 -*-
 from abc import ABCMeta, abstractmethod
-from typing import Dict, List, Optional, Tuple, Set, Callable
-from cosmian_findex import IndexedValue, Label, MasterKey, InternalFindex
+from typing import Callable, Dict, List, Optional, Sequence, Set, Tuple, Union
+
+from cloudproof_findex import (
+    IndexedValuesAndKeywords,
+    InternalFindex,
+    Keyword,
+    Label,
+    Location,
+    MasterKey,
+    ProgressResults,
+    SearchResults,
+)
 
 
 class FindexBase(metaclass=ABCMeta):
@@ -22,15 +32,15 @@ def __init__(self) -> None:
 
     def upsert(
         self,
-        indexed_values_and_keywords: Dict[IndexedValue, List[str]],
+        indexed_values_and_keywords: IndexedValuesAndKeywords,
         master_key: MasterKey,
         label: Label,
     ) -> None:
         """Upserts the given relations between `IndexedValue` and `Keyword` into Findex tables.
 
         Args:
-            indexed_values_and_keywords (Dict[IndexedValue, List[str]]): map of `IndexedValue`
-                                                                        to a list of `Keyword`
+            indexed_values_and_keywords (Dict[Location | Keyword, List[Keyword | str]]):
+                map of `IndexedValue` to a list of `Keyword`
             master_key (MasterKey): the user master key
             label (Label): label used to allow versioning
         """
@@ -102,20 +112,18 @@ def fetch_chain_table(self, chain_uids: List[bytes]) -> Dict[bytes, bytes]:
 
     def search(
         self,
-        keywords: List[str],
+        keywords: Sequence[Union[Keyword, str]],
         master_key: MasterKey,
         label: Label,
         max_result_per_keyword: int = 2**32 - 1,
         max_depth: int = 100,
         fetch_chains_batch_size: int = 0,
-        progress_callback: Optional[
-            Callable[[Dict[str, List[IndexedValue]]], bool]
-        ] = None,
-    ) -> Dict[str, List[bytes]]:
+        progress_callback: Optional[Callable[[ProgressResults], bool]] = None,
+    ) -> SearchResults:
         """Recursively search Findex graphs for `Locations` corresponding to the given `Keyword`.
 
         Args:
-            keywords (List[str]): keywords to search using Findex.
+            keywords (List[Keyword | str]): keywords to search using Findex.
             master_key (MasterKey): user secret key.
             label (Label): public label used in keyword hashing.
             max_result_per_keyword (int, optional): maximum number of results to fetch per keyword.
@@ -125,7 +133,7 @@ def search(
                 to process intermediate search results.
 
         Returns:
-            Dict[str, List[bytes]]: `Locations` found by `Keyword`
+            Dict[Keyword, List[Location]]: `Locations` found by `Keyword`
         """
         return self.findex_core.search_wrapper(
             keywords,
@@ -215,14 +223,14 @@ def remove_chain_table(self, chain_uids: List[bytes]) -> None:
         """
 
     @abstractmethod
-    def list_removed_locations(self, locations: List[bytes]) -> List[bytes]:
+    def list_removed_locations(self, locations: List[Location]) -> List[Location]:
         """Check whether the given `Locations` still exist.
 
         Args:
-            locations (List[bytes]): `Locations` to check
+            locations (List[Location]): `Locations` to check
 
         Returns:
-            List[bytes]: list of `Locations` that were removed
+            List[Location]: list of `Locations` that were removed
         """
 
     def update_lines(
diff --git a/src/cloudproof_py/findex/__init__.py b/src/cloudproof_py/findex/__init__.py
@@ -1,5 +1,15 @@
 # -*- coding: utf-8 -*-
-from cosmian_findex import IndexedValue, Label, MasterKey
-from cloudproof_py.findex import Findex, utils
+from cloudproof_findex import FindexCloud, Keyword, Label, Location, MasterKey
 
-__all__ = ["IndexedValue", "Label", "MasterKey", "Findex", "utils"]
+from cloudproof_py.findex import Findex, typing, utils
+
+__all__ = [
+    "Keyword",
+    "Location",
+    "Label",
+    "MasterKey",
+    "Findex",
+    "utils",
+    "FindexCloud",
+    "typing",
+]
diff --git a/src/cloudproof_py/findex/typing.py b/src/cloudproof_py/findex/typing.py
@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+from cloudproof_findex import IndexedValuesAndKeywords, ProgressResults, SearchResults
+
+__all__ = ["IndexedValuesAndKeywords", "ProgressResults", "SearchResults"]
diff --git a/src/cloudproof_py/findex/utils.py b/src/cloudproof_py/findex/utils.py
@@ -1,13 +1,13 @@
 # -*- coding: utf-8 -*-
-from typing import List, Dict
-from cosmian_findex import IndexedValue
+from typing import List
+
+from cloudproof_findex import IndexedValuesAndKeywords, Keyword
 
 
 def generate_auto_completion(
     keywords: List[str],
     min_word_len: int = 3,
-    encoding: str = "utf-8",
-) -> Dict[IndexedValue, List[str]]:
+) -> IndexedValuesAndKeywords:
     """Generate a Findex graph of all sub-words from a list of keywords.
     For the keyword "Thibaud" with `min_word_len` at 3 it will return
     these aliases ["Thi" => "Thib", "Thib" => "Thiba", "Thiba" => "Thibau", "Thibau" => "Thibaud"]
@@ -17,14 +17,13 @@ def generate_auto_completion(
     Args:
         keywords (List[str]): words to generate sub-words from
         min_word_len (int, optional): length of the smallest sub-word to generate. Defaults to 3.
-        encoding (str, optional): used to encode the string to bytes. Defaults to "utf-8".
 
     Returns:
-        Dict[IndexedValue, List[str]]: keyword -> sub-word mapping to upsert in Findex.
+        Dict[Keywords, List[Keywords]]: keyword -> sub-word mapping to upsert in Findex.
     """
-    res = {}
+    res: IndexedValuesAndKeywords = {}
     for word in keywords:
         for i in range(min_word_len, len(word)):
-            res[IndexedValue.from_keyword(word[: i + 1].encode(encoding))] = [word[:i]]
+            res[Keyword.from_string(word[: i + 1])] = [word[:i]]
 
     return res
diff --git a/src/cloudproof_py/kms/__init__.py b/src/cloudproof_py/kms/__init__.py
diff --git a/tests/data/export/sqlite.db b/tests/data/export/sqlite.db
diff --git a/tests/test_cover_crypt.py b/tests/test_cover_crypt.py
diff --git a/tests/test_findex.py b/tests/test_findex.py

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-cloudproof-py==2.0`
	`1`	`+cloudproof-py==3.0`