Skip to main content

A Matrix proxy daemon that adds E2E encryption capabilities.

Project description

pantalaimon

Pantalaimon is an end-to-end encryption aware Matrix reverse proxy daemon. Pantalaimon acts as a good man in the middle that handles the encryption for you.

Messages are transparently encrypted and decrypted for clients inside of pantalaimon.

Pantalaimon in action

Installation

The Olm C library is required to be installed before installing pantalaimon.

If your distribution provides packages for libolm it is best to use those, note that a recent version of libolm is required (3.1+). If your distribution doesn't provide a package building from source is required. Please refer to the Olm readme to see how to build the C library from source.

Installing pantalaimon works like usually with python packages:

python setup.py install

Pantalaimon can also be found on pypi:

pip install pantalaimon

Pantalaimon contains a dbus based UI that can be used to controll the daemon. The dbus based UI is completely optional and needs to be installed with the daemon:

pip install pantalaimon[ui]

Do note that man pages can't be installed with pip.

macOS installation

For instance, on macOS, this means:

brew install dbus
perl -pi -e's#(<auth>EXTERNAL</auth>)#<!--$1-->#' $(brew --prefix dbus)/share/dbus-1/session.conf
brew services start dbus
# it may be necessary to restart now to get the whole OS to pick up the
# existence of the dbus daemon

git clone https://gitlab.matrix.org/matrix-org/olm
(cd olm; make)
git clone https://github.com/matrix-org/pantalaimon
(cd pantalaimon; CFLAGS=-I../olm/include LDFLAGS=-L../olm/build/ python3 setup.py install)

export DBUS_SESSION_BUS_ADDRESS=unix:path=$(launchctl getenv DBUS_LAUNCHD_SESSION_BUS_SOCKET)
cd pantalaimon
DYLD_LIBRARY_PATH=../olm/build/ pantalaimon -c contrib/pantalaimon.conf

# for notification center:
git clone https://github.com/fakechris/notification-daemon-mac-py
# if you have django's `foundation` library installed and your filesystem
# is case insensitive (the default) then you will need to `pip uninstall foundation`
# or install PyObjC in a venv...
pip install PyObjC daemon glib dbus-python
cd notification-daemon-mac-py
./notify.py

Experimental E2E search support.

Pantalaimon can handle the search endpoint of a Matrix server as well, providing search support for E2E encrypted rooms.

For this to work tantivy is needed. Tantivy is a full text search engine written in rust.

The python bindings for tantivy are needed for pantalaimon. The bindings are not yet merged upstream, instead they can be found here.

Note that rust nightly (tested version was: 1.36.0-nightly (50a0defd5 2019-05-21)) and setuptools-rust are required before the tantivy python bindings can be installed.

Usage

While pantalaimon is a daemon, it is mean to be run as your own user. It won't verify devices for you automatically, unless configured to do so, and requires user interaction to verify, ignore or blacklist devices.

Pantalaimon requires a configuration file to run. The configuration file specifies one or more homeservers for pantalaimon to connect to.

A minimal pantalaimon configuration looks like this:

[local-matrix]
Homeserver = https://localhost:8448
ListenAddress = localhost
ListenPort = 8009

The configuration file should be placed in ~/.config/pantalaimon/pantalaimon.conf.

The full documentation for the pantalaimons configuration can be found in the man page pantalaimon(5).

Now that pantalaimon is configured it can be run:

pantalaimon --log-level debug

After running the daemon, configure your client to connect to the daemon instead of your homeserver. The daemon listens by default on localhost and port 8009.

Note that logging in to the daemon is required to start a sync loop for a user. After that clients can connect using any valid access token for the user that logged in. Multiple users per homeserver are supported.

For convenience a systemd service file is provided.

To control the daemon an interactive utility is provided in the form of panctl.

panctl can be used to verify, blacklist or ignore devices, import or export session keys, or to introspect devices of users that we share encrypted rooms with.

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

pantalaimon-0.2.tar.gz (2.5 MB view details)

Uploaded Source

Built Distribution

pantalaimon-0.2-py3-none-any.whl (42.5 kB view details)

Uploaded Python 3

File details

Details for the file pantalaimon-0.2.tar.gz.

File metadata

  • Download URL: pantalaimon-0.2.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for pantalaimon-0.2.tar.gz
Algorithm Hash digest
SHA256 35690faa010ccc191ac09cb5c44b806bae4872ce98a64f1ee5b68e02e595e0d3
MD5 b79509bc910507e4478886b0d55b424b
BLAKE2b-256 154b9f7e0021ac6867729e4555e25c72db4a6bd04b4328e817e3a5978f92f0ae

See more details on using hashes here.

Provenance

File details

Details for the file pantalaimon-0.2-py3-none-any.whl.

File metadata

  • Download URL: pantalaimon-0.2-py3-none-any.whl
  • Upload date:
  • Size: 42.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for pantalaimon-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4615985e8309852a8f44f8926104f70891b71121137e7c23946af58d352e4c7b
MD5 f55e19aeeb62b1d33fe6df5c63b38234
BLAKE2b-256 48562c2c412d60935455c967ae203a62087eb4dcace2e2814c082f2340750d4c

See more details on using hashes here.

Provenance

Supported by

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