X3DH 1.2.0

A Python implementation of the Extended Triple Diffie-Hellman key agreement protocol.

This repository is actively maintained.

Activity is low at times because this project is already feature-complete, documented and tested.

python-x3dh

A Python implementation of the Extended Triple Diffie-Hellman key agreement protocol.

Installation

Install the latest release using pip (pip install X3DH) or manually from source by running pip install . in the cloned repository.

Differences to the Specification

In the X3DH specification, the identity key is a Curve25519/Curve448 key and XEdDSA is used to create signatures with it. This library does not support Curve448, however, it supports Ed25519 in addition to Curve25519. You can choose whether the public part of the identity key in the bundle is transferred as Curve25519 or Ed25519. Refer to the documentation for details.

Testing, Type Checks and Linting

python-x3dh uses pytest as its testing framework, mypy for static type checks and both pylint and Flake8 for linting. All tests/checks can be run locally with the following commands:

$ pip install --upgrade .[test,lint]
$ mypy x3dh/ tests/
$ pylint x3dh/ tests/
$ flake8 x3dh/ tests/
$ pytest

Documentation

View the documentation on readthedocs.io or build it locally. Additional requirements to build the docs can be installed using pip install .[docs]. With all dependencies installed, run make html in the docs/ directory. You can find the generated documentation in docs/_build/html/.