Mercurial > libervia-backend

changeset 4352:382dc6e62b6e default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (components, encryption): add documentation on autocrypt for client and email gateway: fix 456
author Goffi <goffi@goffi.org>
date Fri, 28 Feb 2025 09:23:35 +0100
parents 6a0a081485b8
children
files doc/components.rst doc/encryption.rst
diffstat 2 files changed, 23 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/components.rst	Fri Feb 28 09:23:35 2025 +0100
+++ b/doc/components.rst	Fri Feb 28 09:23:35 2025 +0100
@@ -977,6 +977,18 @@
 (in technical terms, it's by telling it to use MIME and OpenPGP) before sending it to the
 gateway. This only works with clients implementing this specification.
 
+Autocrypt
+~~~~~~~~~
+
+The gateway relays "Autocrypt" headers, which is a way to share public keys without
+relaying them to a key server. In layman's terms, it's a way to exchange encryption data
+to be able to encrypt messages automatically. However, while better than not using
+end-to-end encryption, this method is not as secure as proper management of encryption
+keys and authentication of the peer we're talking to.
+
+Please refer to `Wikipedia's Autocrypt page`_ for more details, in particular on its
+security model
+
 
 .. note::
 
@@ -989,4 +1001,5 @@
 .. _XEP-0106 (JID Escaping): https://xmpp.org/extensions/xep-0106.html
 .. _XEP-0131 (Stanza Headers and Internet Metadata): https://xmpp.org/extensions/xep-0131.html
 .. _XEP-0498 (Pubsub File Sharing): https://xmpp.org/extensions/xep-0498.html
+.. _Wikipedia's Autocrypt page: https://en.wikipedia.org/wiki/Autocrypt
 
--- a/doc/encryption.rst	Fri Feb 28 09:23:35 2025 +0100
+++ b/doc/encryption.rst	Fri Feb 28 09:23:35 2025 +0100
@@ -133,3 +133,13 @@
 
 .. _XEP-0476: Pubsub Signing: OpenPGP Profile: https://xmpp.org/extensions/xep-0476.html
 
+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.
+
+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`_.
+
+.. _Wikipedia's Autocrypt page: https://en.wikipedia.org/wiki/Autocrypt