Mercurial > libervia-backend

comparison doc/libervia-cli/encryption.rst @ 3563:267e4987b58b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
author Goffi <goffi@goffi.org>
date Fri, 11 Jun 2021 09:21:41 +0200
parents 4705f80b6e23
children
comparison
equal deleted inserted replaced
3562:9f599ccbea4e 3563:267e4987b58b
1 ======================================== 1 ========================================
2 encryption: encryption sessions handling 2 encryption: encryption sessions handling
3 ======================================== 3 ========================================
4 4
5 Libervia being an XMPP client does encryption by default between client and server. In 5 Libervia being an XMPP client does encryption by default between client and server. In
6 addition, SàT is also capable of doing end-to-end (e2e) encryption, meaning that the 6 addition, Libervia is also capable of doing end-to-end (e2e) encryption, meaning that the
7 payload of messages are encrypted to be hidden from the servers (and their 7 payload of messages are encrypted to be hidden from the servers (and their
8 administrators). The ``encryption`` commands are here to handle those e2e encryption 8 administrators). The ``encryption`` commands are here to handle those e2e encryption
9 sessions and algorithms. 9 sessions and algorithms.
10 10
11 .. note:: 11 .. note::
54 Start e2e session with an entity. 54 Start e2e session with an entity.
55 55
56 You need to specify the JID of the entity you want to start a session with as a positional 56 You need to specify the JID of the entity you want to start a session with as a positional
57 argument. 57 argument.
58 58
59 By default, SàT will select itself the algorithm to use among those available, but you can 59 By default, Libervia will select itself the algorithm to use among those available, but you can
60 specify one using either its name with ``-n NAME, --name NAME`` or its namespace using 60 specify one using either its name with ``-n NAME, --name NAME`` or its namespace using
61 ``-N NAMESPACE, --namespace``. ``NAME`` is the short name of the algorithm, e.g. ``omemo`` 61 ``-N NAMESPACE, --namespace``. ``NAME`` is the short name of the algorithm, e.g. ``omemo``
62 while the namespace is the longer (e.g. ``urn:xmpp:otr:0``). 62 while the namespace is the longer (e.g. ``urn:xmpp:otr:0``).
63 63
64 If an encryption session is started but one with an other algorithm was already there, the 64 If an encryption session is started but one with an other algorithm was already there, the
70 command will succeed in all cases and nothing will be changed. 70 command will succeed in all cases and nothing will be changed.
71 71
72 examples 72 examples
73 -------- 73 --------
74 74
75 Start e2e encryption with Pierre, using the algorithm selected by SàT:: 75 Start e2e encryption with Pierre, using the algorithm selected by Libervia::
76 76
77 $ li encryption start louise@example.net 77 $ li encryption start louise@example.net
78 78
79 Start an OMEMO session with Louise:: 79 Start an OMEMO session with Louise::
80 80
85 85
86 Terminate an e2e session with given entity. The entity must be specified as positional 86 Terminate an e2e session with given entity. The entity must be specified as positional
87 argument. 87 argument.
88 88
89 After this command is run, the messages with specified entity will not be e2e encrypted 89 After this command is run, the messages with specified entity will not be e2e encrypted
90 anymore (but this won't affect encryption between SàT and XMPP server and between XMPP 90 anymore (but this won't affect encryption between Libervia and XMPP server and between XMPP
91 servers). 91 servers).
92 92
93 example 93 example
94 ------- 94 -------
95 95