chore: merge branch 'release/v2.0.1'

Author: Manuthor

.github/workflows/ci.yml

@@ -65,4 +65,62 @@ jobs:
           mypy examples/cover_crypt
       - name: Run tests
         run: |
+          python tests/non_regression_cover_crypt.py --test --write
           python -m unittest tests/test*.py
+      - name: Upload non-regression test vectors
+        uses: actions/upload-artifact@v3
+        with:
+          name: cloudproof_python
+          path: |
+            ./tests/data/export/non_regression_vector.json
+            ./tests/data/export/sqlite.db
+          retention-days: 1
+          if-no-files-found: error
+
+  cloudproof_java:
+    needs: test
+    uses: Cosmian/reusable_workflows/.github/workflows/cloudproof_java_in_docker.yml@develop
+    with:
+      branch: develop
+      target: x86_64-unknown-linux-gnu
+      extension: so
+      destination: linux-x86-64
+      os: ubuntu-20.04
+      kms-version: 4.2.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
+        cp ./cloudproof_python/sqlite.db                  src/test/resources/findex/non_regression/python_sqlite.db
+
+  cloudproof_js:
+    needs: test
+    uses: Cosmian/reusable_workflows/.github/workflows/cloudproof_js.yml@develop
+    with:
+      branch: develop
+      target: wasm32-unknown-unknown
+      kms-version: 4.2.0
+      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
+        cp ./cloudproof_python/sqlite.db                  tests/data/findex/non_regression/python_sqlite.db
+
+  cloudproof_flutter:
+    needs:
+      - test
+    uses: Cosmian/reusable_workflows/.github/workflows/cloudproof_flutter.yml@develop
+    with:
+      branch: develop
+      target: x86_64-unknown-linux-gnu
+      extension: so
+      copy_fresh_build: false
+      copy_regression_files: |
+        cp ./cloudproof_python/non_regression_vector.json test/resources/cover_crypt/non_regression/python_non_regression_vector.json
+        cp ./cloudproof_python/sqlite.db                  test/resources/findex/non_regression/python_sqlite.db
+
+  cleanup:
+    needs:
+      - cloudproof_flutter
+      - cloudproof_java
+      - cloudproof_js
+    uses: Cosmian/reusable_workflows/.github/workflows/cleanup_cache.yml@main
+    secrets: inherit

.github/workflows/publish.yml

@@ -42,7 +42,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
+          scripts/ci_install_pyo3_builds.sh
           pip install -r docs/requirements.txt
       - name: Build package
         run: |

CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.0.1] - 2023-02-27
+
+### Documentation
+
+- Update examples with `progress_callback`
+
+### Testing
+
+- Fix int conversions for new regressions tests
+- Renew non-reg cover_crypt tests
+- Uniformize findex dataset
+
+### Ci
+
+- Add cross tests
+- Clean github cache for each completed PR
+
 ## [2.0.0] - 2023-02-03
 
 ### Features

README.md

@@ -7,13 +7,30 @@ The library provides a Python API to the **Cloudproof Encryption** product of th
 
 <!-- toc -->
 
+- [Licensing](#licensing)
+- [Cryptographic primitives](#cryptographic-primitives)
 - [Getting started](#getting-started)
 - [Demo](#demo)
 - [Building and testing](#building-and-testing)
 - [Versions Correspondence](#versions-correspondence)
 
 <!-- tocstop -->
 
+## Licensing
+
+The library is available under a dual licensing scheme Affero GPL/v3 and commercial. See [LICENSE.md](LICENSE.md) for details.
+
+## Cryptographic primitives
+
+The library is based on:
+
+- [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.
+
+- [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
+
 ## Getting started
 
 This library requires `Python >= 3.7`.
@@ -69,7 +86,7 @@ This library depends on [CoverCrypt](https://github.com/Cosmian/cover_crypt) and
 
 This table shows the minimum version correspondence between the various components.
 
-| `cloudproof_py` | CoverCrypt | Findex | KMS   |
-| --------------- | ---------- | ------ | ----- |
-| >=2.0.0         | 10.0.0     | 2.0.1  | 4.2.0 |
-| >=1.0.0         | 8.0.1      | 2.0.0  | -     |
+| `cloudproof_py` | CoverCrypt | Findex      | KMS   |
+| --------------- | ---------- | ----------- | ----- |
+| >=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/requirements.txt

@@ -1,3 +1,3 @@
-cloudproof-py==1.0
+cloudproof-py==2.0
 termcolor==2.1.1
 types-termcolor==1.1.6

examples/cover_crypt/main.py

@@ -13,15 +13,20 @@ async def main(use_kms: bool = True):
     policy.add_axis(
         PolicyAxis(
             "Security Level",
-            [("Protected", False), ("Confidential", False), ("Top Secret", False)],
-            hierarchical=True,
+            [
+                ("Protected", False),
+                ("Confidential", False),
+                # the following attribute is hybridized allowing post-quantum resistance
+                ("Top Secret", True),
+            ],
+            hierarchical=True,  # this is a hierarchical axis
         )
     )
     policy.add_axis(
         PolicyAxis(
             "Department",
             [("FIN", False), ("MKG", False), ("HR", False)],
-            hierarchical=False,
+            hierarchical=False,  # this is NOT a hierarchical axis
         )
     )
 

examples/cover_crypt/requirements.txt

@@ -1 +1 @@
-cloudproof-py==1.0
+cloudproof-py==2.0

examples/findex_upsert_search/main.py

@@ -1,10 +1,12 @@
 # -*- coding: utf-8 -*-
+import argparse
+from typing import Dict, List, Union
+
 from findex_dict import FindexDict
 from findex_redis import FindexRedis
 from findex_sqlite import FindexSQLite
-from cloudproof_py import findex
-from typing import Union
-import argparse
+
+from cloudproof_py.findex import MasterKey, Label, IndexedValue, Findex, utils
 
 # Simple database containing the firstname and lastname of each user.
 # Each line has a corresponding UID: 1, 2 or 3.
@@ -19,13 +21,13 @@ def main(backend: str = "Dict"):
     print("Database to index:", data)
 
     # Initialize a symmetric key
-    master_key = findex.MasterKey.random()
+    master_key = MasterKey.random()
 
     # Initialize a random label
-    label = findex.Label.random()
+    label = Label.random()
 
     # Instance the class implementing the required callbacks
-    findex_interface: Union[findex.Findex.FindexUpsert, findex.Findex.FindexSearch]
+    findex_interface: Union[Findex.FindexUpsert, Findex.FindexSearch]
     if backend == "Redis":
         findex_interface = FindexRedis()
     elif backend == "SQLite":
@@ -37,7 +39,7 @@ def main(backend: str = "Dict"):
     indexed_values_and_keywords = {}
     for uid, keywords in data.items():
         # Convert database UIDs to IndexedValue expected by Findex
-        location = findex.IndexedValue.from_location(uid.encode("utf-8"))
+        location = IndexedValue.from_location(uid.encode("utf-8"))
         # This location has 2 keywords associated: the firstname and lastname
         indexed_values_and_keywords[location] = keywords
 
@@ -60,21 +62,21 @@ def main(backend: str = "Dict"):
 
     # Create the alias `Joe` for `John`
     alias_graph = {
-        findex.IndexedValue.from_keyword(b"John"): ["Joe"],
+        IndexedValue.from_keyword(b"John"): ["Joe"],
     }
     findex_interface.upsert(alias_graph, master_key, label)
 
     # Now searching `Joe` will return the same location as `John`
-    print("Search for Joe:")
+    print("Search with aliases:")
     print("\t", findex_interface.search(["Joe"], master_key, label))
 
     # Generate an auto-completion graph:
     # For example, with the word `Wilkins`, one could upsert the following aliases:
     # ["Wil" => "Wilk", "Wilk" => "Wilki", "Wilki" => "Wilkin", "Wilkin" => "Wilkins"].
-    # A search for the Keyword Thi will then return the Location of `Wilkins`.
+    # A search for the Keyword "Wil" will then return the Location of `Wilkins`.
 
     # CloudProof provides a helper function to generate such graph
-    auto_completion_graph = findex.utils.generate_auto_completion(
+    auto_completion_graph = utils.generate_auto_completion(
         ["Martin", "Martial", "Wilkins"]
     )
     findex_interface.upsert(auto_completion_graph, master_key, label)
@@ -87,6 +89,17 @@ def main(backend: str = "Dict"):
     # `Mar` points to both Martin's and Martial's locations.
     # `Wil` only points to Wilkins' location.
 
+    print("Search using the `progress_callback`: ")
+
+    def echo_progress_callback(res: Dict[str, List[IndexedValue]]) -> bool:
+        print("\t Partial results:", res)
+        return True
+
+    found_locations = findex_interface.search(
+        ["Mar"], master_key, label, progress_callback=echo_progress_callback
+    )
+    print("\t Final results:", found_locations)
+
 
 if __name__ == "__main__":
 
@@ -111,5 +124,5 @@ def main(backend: str = "Dict"):
         print("Using in-memory SQLite")
         main("SQLite")
     else:
-        print("Using in-memory dictionnaries")
+        print("Using in-memory dictionaries")
         main("Dict")

examples/findex_upsert_search/requirements.txt

@@ -1,3 +1,3 @@
-cloudproof-py==1.0
+cloudproof-py==2.0
 redis>=4.3
 types_redis>=4.3

pyproject.toml

@@ -7,7 +7,7 @@ cloudproof_py = ["py.typed", "*.pyi"]
 
 [project]
 name = "cloudproof_py"
-version = "2.0.0"
+version = "2.0.1"
 authors = [{ name = "Cosmian Tech", email = "tech@cosmian.com" }]
 description = "Python library for Cosmian Cloud Proof"
 readme = "README.md"