summaryrefslogtreecommitdiff
path: root/doc/en/plugins/otr.txt
blob: 533f6b4be23e4f14ea8eeeb79d4a459b57040527 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
OTR
===

*DISCLAIMER: THE OTR LIB IS IN AN EXPERIMENTAL STATE AND SHOULD NOT BE
CONSIDERED AS ENTIRELY RELIABLE*

('though it works pretty well')

This plugin implements http://wiki.xmpp.org/web/OTR[Off The Record messaging].

This is a plugin used to encrypt one-to-one conversation using the OTR
encryption method. You can use it if you want good privacy, deniability,
authentication, and strong secrecy. Without this
encryption, your messages are encrypted *at least* from your client (poezio) to
your server. The message is decrypted by your server and you cannot control the
encryption method of your messages from your server to your contact’s server
(unless you are your own server’s administrator), nor from your contact’s
server to your contact’s client.

This plugin does end-to-end encryption. This means that *only* your contact can
decrypt your messages, and it is fully encrypted during *all* its travel
through the internet.

Note that if you are having an encrypted conversation with a contact, you can
*not* send XHTML-IM messages to him. They will be removed and be replaced by
plain text messages.

Installation and configuration
------------------------------

To use the OTR plugin, you must first install libopenotr.

If you use Archlinux, there is a https://aur.archlinux.org/packages.php?ID=57957[libopenotr-git] package on the AUR.

If not, then you will have to install it by hand.

First, clone the repo and go inside the created directory:

==============================================
[source,bash]
-------------
git clone https://github.com/teisenbe/libopenotr.git

cd libopenotr
-------------
==============================================

then run autogen.sh and configure

============
[source,bash]
-------------
sh autogen.sh

./configure --enable-gaping-security-hole
-------------
============

Then compile & install the lib:

============
[source,bash]
-------------
make

sudo make install
-------------
============

Finally, install the python module:

=============================
[source,bash]
-------------
python3 setup.py build

sudo python3 setup.py install
-------------
=============================



Usage
-----

To use OTR, make sure the plugin is loaded (if not, then do /load otr).

Once you are in a private conversation, you have to do a:

==========

 /otr start

==========

The status of the OTR encryption should appear in the bar between the chat and
the input "OTR: encrypted".


Once you’re done, end the OTR session with

==========

 /otr end

==========


Known problems
--------------


Empty messages send when changing status.