Skip to main content

Python library for Cosmian Cloud Proof

Project description

Cloudproof Python Library

PyPI version Build status

The library provides a Python API to the Cloudproof Encryption product of the Cosmian Ubiquitous Encryption platform.

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 [-i]

Note: add -i to install after build.

To build and run the tests:

scripts/build.sh -it

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
>=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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

cloudproof_py-3.0.0-py3-none-any.whl (19.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page