README.rst 1.86 KB
Newer Older
1 2 3
Poezio OMEMO plugin
###################

4 5 6
**This plugin will not work with Poezio 0.12.**


7 8 9
This is a `Poezio <https://poez.io>`_ plugin providing OMEMO support. It
distributed separately for licensing reasons.

10 11
This plugin is very much **alpha**. It handles encryption and decryption
of OMEMO messages, but doesn't display the encryption state of messages,
12 13 14
and neither does it have a way to do trust management. As this plugin is
still changing often, it is recommended that users follow experimental
(master) versions of this project and its dependencies.
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

License
-------

This plugin is licensed under GPLv3.

Note on the underlying OMEMO library
------------------------------------

As stated in `python-xeddsa's
README <https://github.com/Syndace/python-xeddsa/blob/136b9f12c8286b9463566308963e70f090b60e50/README.md>`_,
(dependency of python-omemo), this library has not undergone any
security audits. If you have the knowledge, any help is welcome.

Please take this into consideration when using this library.

Installation
------------

34 35 36 37
As this plugin is still changing often, it is recommended that users
follow experimental (master) versions of this project and its
dependencies.

38 39 40 41 42
- ArchLinux (AUR):
   `python-poezio-omemo <https://aur.archlinux.org/packages/python-poezio-omemo>`_, or
   `python-poezio-omemo-git <https://aur.archlinux.org/packages/python-poezio-omemo-git>`_
- PIP: `poezio-omemo`
- Manual: `python3 setup.py install`
43 44 45 46 47 48 49 50 51

Use in poezio
-------------

Once installed (see the `Installation`_ section below), you can add
`omemo` in the `plugin_autoload` configuration. See the Poezio
`documentation
<https://doc.poez.io/plugins/index.html#plugin-autoload>`_ for more
information about autoloading plugins.
Maxime Buquet's avatar
Maxime Buquet committed
52 53 54 55 56 57

TODO
----

- MUC support. Needs support for handling MUC reflections in poezio first.
- aesgcm
Maxime Buquet's avatar
Maxime Buquet committed
58
- UI, various commands and indicators that messages are encrypted or not.