Library for working with encrypted data within nilDB queries and replies.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for lapets from gravatar.com lapets Avatar for nillion from gravatar.com nillion Avatar for stephorpilla from gravatar.com stephorpilla

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT
  • Requires: Python >=3.9
  • Provides-Extra: docs , test , lint , coveralls , publish
Report project as malware

Project description

Library for working with encrypted data within nilDB queries and replies.

PyPI version and link. Read the Docs documentation status. GitHub Actions status. Coveralls test coverage summary.

Description and Purpose

This library provides cryptographic operations that are compatible with nilDB nodes and clusters, allowing developers to leverage certain privacy-enhancing technologies (PETs) when storing, operating upon, and retrieving data while working with nilDB. The table below summarizes the functionalities that nilQL makes available.

Cluster

Operation

Implementation Details

Supported Types
single
node

store
XSalsa20 stream cipher
Poly1305 MAC
32-bit signed integer
UTF-8 string (<4097 bytes)

match
deterministic salted hashing
via SHA-512
32-bit signed integer
UTF-8 string (<4097 bytes)

sum
non-deterministic Paillier
with 2048-bit primes

32-bit signed integer
multiple
nodes

store

XOR-based secret sharing
32-bit signed integer
UTF-8 string (<4097 bytes)

match
deterministic salted hashing
via SHA-512
32-bit signed integer
UTF-8 string (<4097 bytes)

sum
additive secret sharing (no threshold)
Shamir secret sharing (with threshold)
(prime modulus 2^32 + 15 for both)

32-bit signed integer

Installation and Usage

The library can be imported in the usual ways:

import nilql
from nilql import *

Example

An example workflow that demonstrates use of the library is presented below:

import nilql
cluster = {'nodes': [{}, {}, {}]}
secret_key = nilql.SecretKey.generate(cluster, {'store': True})
plaintext = 123
ciphertext = nilql.encrypt(secret_key, plaintext)
decrypted = nilql.decrypt(secret_key, ciphertext)
assert(plaintext == decrypted)

Development

All installation and development dependencies are fully specified in pyproject.toml. The project.optional-dependencies object is used to specify optional requirements for various development tasks. This makes it possible to specify additional options (such as docs, lint, and so on) when performing installation using pip:

python -m pip install ".[docs,lint]"

Documentation

The documentation can be generated automatically from the source files using Sphinx:

python -m pip install ".[docs]"
cd docs
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html

Testing and Conventions

All unit tests are executed and their coverage is measured when using pytest (see the pyproject.toml file for configuration details):

python -m pip install ".[test]"
python -m pytest

The subset of the unit tests included in the module itself and can be executed using doctest:

python src/nilql/nilql.py -v

Style conventions are enforced using Pylint:

python -m pip install ".[lint]"
python -m pylint src/nilql test/test_nilql.py

Contributions

In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.

Versioning

The version number format for this library and the changes to the library associated with version number increments conform with Semantic Versioning 2.0.0.

Publishing

This library can be published as a package on PyPI via the GitHub Actions workflow found in .github/workflows/build-publish-sign-release.yml that follows the recommendations found in the Python Packaging User Guide.

Ensure that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an automation rule that activates and sets as the default all tagged versions.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for lapets from gravatar.com lapets Avatar for nillion from gravatar.com nillion Avatar for stephorpilla from gravatar.com stephorpilla

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT
  • Requires: Python >=3.9
  • Provides-Extra: docs , test , lint , coveralls , publish

Release history Release notifications | RSS feed

This version

0.0.0a13 pre-release

0.0.0a12 pre-release

0.0.0a11 pre-release

0.0.0a10 pre-release

0.0.0a9 pre-release

0.0.0a8 pre-release

0.0.0a6 pre-release

0.0.0a5 pre-release

0.0.0a4 pre-release

0.0.0a3 pre-release

0.0.0a2 pre-release

0.0.0a1 pre-release

0.0.0a0 pre-release

Download files

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

Source Distribution

nilql-0.0.0a13.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nilql-0.0.0a13-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

Details for the file nilql-0.0.0a13.tar.gz.

File metadata

  • Download URL: nilql-0.0.0a13.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nilql-0.0.0a13.tar.gz
Algorithm Hash digest
SHA256 cb0011ff704001c83209a3185d89a8b0a16cec8089551469b5c19d52659dd359
MD5 c41fb498c3eeadcd8327a2068ac8e650
BLAKE2b-256 3f6759f4b6ceac7c7719e4830a8f017d7d289b48da20dc2791f55ba3d2968bbb

See more details on using hashes here.

Provenance

The following attestation bundles were made for nilql-0.0.0a13.tar.gz:

Publisher: build-publish-sign-release.yml on NillionNetwork/nilql-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nilql-0.0.0a13-py3-none-any.whl.

File metadata

  • Download URL: nilql-0.0.0a13-py3-none-any.whl
  • Upload date:
  • Size: 13.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nilql-0.0.0a13-py3-none-any.whl
Algorithm Hash digest
SHA256 f369a0530340ef890d9916d748147c0c54eb8a1b9f79dd6f3124c546ec39d9f3
MD5 79fad6b231b279ee9e009ae242183978
BLAKE2b-256 13b08b8641ddd3d40aaee0fccb3a167d7ee31f0021c93c93c0a19ddc50942d9a

See more details on using hashes here.

Provenance

The following attestation bundles were made for nilql-0.0.0a13-py3-none-any.whl:

Publisher: build-publish-sign-release.yml on NillionNetwork/nilql-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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