otc 4.0.0

Example

Suppose that a sender wants to send exactly one of two payloads to a receiver (such as one of two decryption keys). Furthermore, the receiver does not want to reveal to the sender which of the two payloads they chose to receive. To begin, the sender can create a send object s. The sender can then send the public key s.public to the receiver (via some communication channel):

>>> import otc
>>> s = otc.send()
>>> s.public.to_base64()
'LJKN1DmNwGiCGWl4O5DsJMIEnlJm6yhb1o2hYS8A4Hg='

The receiver can create a receive object. Once they receive s.public from the sender (via some communications channel), they can use the receive object’s query method to create an encrypted selection that the sender cannot decrypt. In the example below, the receiver is choosing the second message by supplying the integer 1 (where the two valid options are 0 or 1):

>>> r = otc.receive()
>>> selection = r.query(s.public, 1)

The sender can then use its send object’s reply method to create two encrypted replies based on the receiver’s selection; the receiver will only be able to decrypt the pre-selected payload, and the sender does not know which of the two payloads can be decrypted by the receiver:

>>> replies = s.reply(selection, bytes([0] * 16), bytes([255] * 16))

Finally, the receiver can decrypt their chosen payload using the receive object’s elect method. The example below confirms that the receiver has indeed received an encrypted version of the second message:

>>> r.elect(s.public, 1, *replies) == bytes([255] * 16)
True

See the article Privacy-Preserving Information Exchange Using Python for a more detailed presentation of this example.

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

Alternatively, all unit tests are included in the module itself and can be executed using doctest:

python src/otc/otc.py -v

Style conventions are enforced using Pylint:

python -m pip install .[lint]
python -m pylint src/otc

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 by a package maintainer. First, install the dependencies required for packaging and publishing:

python -m pip install .[publish]

Ensure that the correct version number appears in pyproject.toml, and 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. Create and push a tag for this version (replacing ?.?.? with the version number):

git tag ?.?.?
git push origin ?.?.?

Remove any old build/distribution files. Then, package the source into a distribution archive:

rm -rf build dist src/*.egg-info
python -m build --sdist --wheel .

Finally, upload the package distribution archive to PyPI:

python -m twine upload dist/*