From c51a22088c3c3d2c4c95c2d0438f3b2bbac5bb4c Mon Sep 17 00:00:00 2001 From: mathieui Date: Mon, 26 Mar 2012 00:05:54 +0200 Subject: Add OTR documentation --- doc/en/plugins/otr.txt | 109 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 doc/en/plugins/otr.txt diff --git a/doc/en/plugins/otr.txt b/doc/en/plugins/otr.txt new file mode 100644 index 00000000..26a6ed4e --- /dev/null +++ b/doc/en/plugins/otr.txt @@ -0,0 +1,109 @@ +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: + +============================================== + + git clone https://git.teisen.be/repo/libopenotr.git + + cd libopenotr + +============================================== + +then run autogen.sh and configure + +============ + + sh autogen.sh + + ./configure --enable-gaping-security-hole + +============ + +Then compile & install the lib: + +============ + + make + + sudo make install + +============ + +Finally, install the python module: + +============================= + + 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. -- cgit v1.2.3