OMEMO Double Ratchet
Project description
Initial codebase was forked from https://github.com/tgalal/python-axolotl but has since been heavily rewritten.
Dependencies
- protobuf (>=4.21.0)
- cryptography
Linux
pip install .
Usage
This library handles only the crypto part of OMEMO, not the XMPP protocol part. This means you need to take care yourself of things like publishing/downloading bundles, publishing/subscribing to PEP deviceliste updates, sending and receiving messages.
Building a session
A OMEMO client needs to implement the Store interface (omemo_dr.state.store.Store). This will manage loading and storing of identity, prekeys, signed prekeys, and session state.
Once this is implemented, building a session is fairly straightforward:
storage = MyStorage()
config = OMEMOConfig(default_prekey_amount=100,
min_prekey_amount=80,
spk_archive_seconds=86400 * 15,
spk_cycle_seconds=86400,
unacknowledged_count=2000)
manager = OMEMOSessionManager(address, storage, config)
# Get your bundle for publishing
bundle = manager.get_bundle('eu.siacs.conversations.axolotl')
my_publish_method(bundle)
# Build a session with a downloaded bundle of a remote contact
bundle = my_receive_bundle_method()
manager.build_session(remote_address, bundle)
# Encrypt a message to a remote contact
message = manager.encrypt(remote_address, plaintext)
my_send_message_method(message)
# Descrypt a message
message = my_receive_message_method()
plaintext, fingerprint, trust = manager.decrypt(message, remote_address)
Development
Generating protobuf files
Download the protobuf-compiler > 3.19 and execute
$ protoc -I=src/omemo_dr/protobuf --python_out=src/omemo_dr/protocol omemo.proto whisper.proto
$ protoc -I=src/omemo_dr/protobuf --python_out=src/omemo_dr/state storage.proto
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file omemo-dr-1.0.1.tar.gz
.
File metadata
- Download URL: omemo-dr-1.0.1.tar.gz
- Upload date:
- Size: 152.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a8a8c77231d73949bdd375278d4d5a261252bdaee52cb6241acb251c202d361 |
|
MD5 | 7a5ad159693ad756b4fe7f9f4e5377c5 |
|
BLAKE2b-256 | 9bf1c1f9a04a5eec3dc9aa766391d1bb7e45cba50e27ce80e051ab95edd6b880 |