erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

plugins XEP-0473, XEP-0475, XEP-0477: rename plugins from prototype name to XEP number + doc update:

Browse source 
Plugin for pubsub encryption and signing were named using prototype name as the
specifications where not yet published at the time. Since, those specifications have been
accepted, so we can rename those plugins using the corresponding XEP numbers.

Doc has been updated to remove old mention saying that the XEP was still being evaluated.

rel 475
This commit is contained in:
Goffi 2026-02-23 12:56:42 +01:00
commit 8805f63b1f
4 changed files with 38 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

49
doc/encryption.rst
View file

@ -15,13 +15,6 @@ To make your communications inaccessible to anybody but your recipient(s), end-t
encryption (or e2ee) may be used. This page aims to explain roughly how it is done in
Libervia and XMPP so end-user can understand and exploit it correctly.
.. note::
this page is work in progress, it will be completed over time to explain the whole
machanism. Is something is not clear, please contact the development team at the XMPP
room `libervia@chat.jabberfr.org <xmpp:libervia@chat.jabberfr.org?join>`__ to get
details and help to improve this documentation.
.. _pubsub-encryption:
@ -43,14 +36,14 @@ Pubsub is not encrypted the same way as messages, because you generally need to
items of a pubsub node, even if you get access to the node once items have already been
published.
E2ee is currently done using `OpenPGP`_ (`XEP-0473: OpenPGP for XMPP Pubsub`_). Each item is encrypted
using a **symmetric** encryption, which mean that the same key (called "shared secret") is
used both to encrypt and decrypt an item, and is shared between all people who must access
or publish to the pubsub node (i.e. blog, event calendar, etc). This is done this way to
make it easy to add a new members, who can then access all archives of the node, but this
also means that if the shared secret is compromised (i.e. somebody who should not has
obtained a copy), all items made with this secret are accessible to the persons in
possession of the secret.
E2ee is currently done using `OpenPGP`_ (`XEP-0473: OpenPGP for XMPP Pubsub`_). Each item
is encrypted using a **symmetric** encryption, which mean that the same key (called
"shared secret") is used both to encrypt and decrypt an item, and is shared between all
people who must access or publish to the pubsub node (i.e. blog, event calendar, etc).
This is done this way to make it easy to add a new members, who can then access all
archives of the node, but this also means that if the shared secret is compromised (i.e.
somebody who should not has obtained a copy), all items made with this secret are
accessible to the persons in possession of the secret.
To make an encrypted pubsub node accessible to somebody, you need to share the secret with
them.
@ -98,13 +91,10 @@ On the other hand, you have all the properties of the algorithm used (for now, o
2 is supported), which means that you can have `Perfect Forward Secrecy`_ for algorithms
supporting it (it's the case for OMEMO.)
.. note::
Pubsub Targeted Encryption(PTE) specification is not currently an official XEP (XMPP
Extension Protocol), it is about to be examinated by "XMPP council". This documentation
will be updated with the evolution of the situation.
Pubsub Target Encryption (PTE) is using `XEP-0477`_
.. _Perfect Forward Secrecy: https://en.wikipedia.org/wiki/Forward_secrecy
.. _XEP-0477: https://xmpp.org/extensions/xep-0477.html
Pubsub Signature
================
@ -114,7 +104,10 @@ may be specified by the pubsub service (using the `"publisher" attribute`_), but
attribute is not set by all pubsub services, and it can be spoofed by the service or the
XMPP server.
To strongly authenticate the publisher of a pubsub item, it is possible to cryptographically sign an item. This can work with any pubsub item, encrypted or not, and it can be done after the item has been published. The process use `XEP-0476: Pubsub Signing: OpenPGP Profile`_.
To strongly authenticate the publisher of a pubsub item, it is possible to
cryptographically sign an item. This can work with any pubsub item, encrypted or not, and
it can be done after the item has been published. The process use `XEP-0476: Pubsub
Signing: OpenPGP Profile`_.
.. attention::
@ -136,10 +129,18 @@ To handle pubsub signatures from command line, you may use
E2EE with Email Gateway
=======================
For compatible gateways, Libervia supports "Relayed" encryption, which is a method for using end-to-end encryption (E2EE). This feature is currently experimental and only works for emails.
For compatible gateways, Libervia supports "Relayed" encryption, which is a method for
using end-to-end encryption (E2EE). This feature is currently experimental and only works
for emails.
If no key is known for an email recipient, Libervia uses Autocrypt. Autocrypt automatically exchanges encryption keys to enable what's called "opportunistic" encryption. While the security isn't as robust as proper key management and peer authentication, it still offers better protection than having no E2EE at all. Autocrypt is only used when a recipient’s key is not known by other, more secure means.
If no key is known for an email recipient, Libervia uses Autocrypt. Autocrypt
automatically exchanges encryption keys to enable what's called "opportunistic"
encryption. While the security isn't as robust as proper key management and peer
authentication, it still offers better protection than having no E2EE at all. Autocrypt is
only used when a recipient’s key is not known by other, more secure means.
For more information about Autocrypt and its security model, please refer to `Wikipedia's Autocrypt page`_.
For more information about Autocrypt and its security model, please refer to `Wikipedia's
Autocrypt page`_.
.. _Wikipedia's Autocrypt page: https://en.wikipedia.org/wiki/Autocrypt