oblivious 3.0.1

Python library that serves as an API for common primitives used to implement OPRF, OT, and PSI protocols.

Python library that serves as an API for common primitives used to implement OPRF, OT, and PSI protocols.

Purpose

This library provides native Python implementations, Python libsodium wrappers, and additional utility methods for cryptographic primitives that are often used to implement oblivious pseudorandom function (OPRF), oblivious transfer (OT), and private set intersection (PSI) protocols.

For more information and background about the underlying mathematical structures and primitives, consult materials about Curve25519, the Ristretto group, and the related Ed25519 system.

Package Installation and Usage

The package is available on PyPI:

python -m pip install oblivious

The library can be imported in the usual ways:

import oblivious
from oblivious import *

Testing and Conventions

All unit tests are executed and their coverage is measured when using nose (see setup.cfg for configuration details):

nosetests

Concise unit tests are implemented with the help of fountains and new reference bit lists for these tests can be generated in the following way:

python test/test_oblivious.py

Style conventions are enforced using Pylint:

pylint oblivious test/test_oblivious

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

Beginning with version 0.1.0, 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.