Python library for Cosmian Cloudproof
Project description
Cloudproof Python Library
The library provides a Python API to the Cloudproof Encryption product of the Cosmian Ubiquitous Encryption platform.
- Licensing
- Cryptographic primitives
- Getting started
- Demo
- Building and testing
- Versions Correspondence
Licensing
The library is available under a dual licensing scheme Affero GPL/v3 and commercial. See LICENSE.md for details.
Cryptographic primitives
The library is based on:
-
Covercrypt 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 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
.
To install the current release:
pip install cloudproof_py
Code examples are available in ./examples to get you started. Please check the online documentation for more details on using the CloudProof APIs.
Demo
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.
Try the demo:
examples/cli_demo/run_demo.sh
Building and testing
To build from source:
scripts/build.sh
To build and run the tests:
scripts/build.sh -t
With PyO3 packages from package.cosmian.com:
scripts/build.sh -it
Note: edit scripts/ci_install_pyo3_builds.sh with the right build name.
To build the documentation:
scripts/build.sh -d
The generated documentation will be in ./docs/_build/html
.
Versions Correspondence
This library depends on Covercrypt and Findex.
This table shows the minimum version correspondence between the various components.
cloudproof_py |
Covercrypt | Findex | KMS |
---|---|---|---|
>=4.2.0 | 13.0.0 | 6.0.0 | 4.10.0 |
>=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 |
>=1.0.0 | 8.0.1 | 2.0.0 | - |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file cloudproof_py-5.0.0.tar.gz
.
File metadata
- Download URL: cloudproof_py-5.0.0.tar.gz
- Upload date:
- Size: 25.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 054bfa12bb7350f230c575b1e560d78ed43b908dcb344cbfa94abb27d0052869 |
|
MD5 | 534e45e555bdfda9ae803da38fb9a4ee |
|
BLAKE2b-256 | f17712e1aa423f6311cdd080dccff302a0088621f46e567bebaab354f68197c2 |
File details
Details for the file cloudproof_py-5.0.0-py3-none-any.whl
.
File metadata
- Download URL: cloudproof_py-5.0.0-py3-none-any.whl
- Upload date:
- Size: 17.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b4c4b8964ea119c0c4329ec04606ea218d5ed43b0239ac7734459852cedbd4c |
|
MD5 | b1f9a9b55915a0abdd7b3abc09fc3db9 |
|
BLAKE2b-256 | bce22212c4c61b00cfe4deae5d2ca9573bab808b55fa16d16889cbc1b9e07bf7 |