~ubuntu-branches/ubuntu/vivid/irssi-plugin-otr/vivid-proposed

« back to all changes in this revision

Viewing changes to README

  • Committer: Package Import Robot
  • Author(s): Antoine Beaupré
  • Date: 2013-05-10 19:43:24 UTC
  • mfrom: (4.1.1 experimental)
  • Revision ID: package-import@ubuntu.com-20130510194324-cxrycs8zwiofjia9
Tags: 1.0.0~alpha2-1
* Ship a second binary package, with debugging symbols.
* New upstream patch: gmodule-nolink.patch to remove extra linking.
* Upload to unstable now that libotr5 is usable there.
* Restore the libotr5-4.0.0-2.1 dependency to make sure this is usuable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Quick start: Do "/load otr", write "?OTR?" to your OTR buddy, wait until the now
2
 
ongoing key generation finishs and write "?OTR?" again. You should "go secure".
3
 
 
4
 
Key generation happens in a seperate  process and its duration mainly depends on
5
 
the available entropy. On  my desktop it takes about 6  Minutes, about 2 Minutes
6
 
if I run  "du /" in parallel  and on an idle  server system it can  even take an
7
 
hour.
8
 
 
9
 
The  default  OTR policy  of  irssi-otr  is  now  something between  manual  and
10
 
opportunistic. Manual means  you have to start it yourself  by issueing "?OTR?",
11
 
opportunistic means  both peers send  some magic  whitespace and start  OTR once
12
 
they  receive this  whitespace from  the other  side. irssi-otr  uses a  mode in
13
 
between  where  we  are  not  sending  whitespace  as  an  announcement  (as  in
14
 
opportunistic) but we still  handle whitespace if we see it  from the other side
15
 
(I'm  calling  it handlews).  Therefore  if  your  peer uses  opportunistic  the
16
 
handshake should still start automatically once he writes something.
17
 
 
18
 
You can  now set the  OTR policy  per peer via  the otr_policy /setting.  It's a
19
 
comma seperated  list of "<nick>@<server> <policy>"  pairs where <nick>@<server>
20
 
is interpreted as a glob pattern, i.e. you can use wildcard "*" and joker "?" as
21
 
you would  in a shell.  The policy  can be one  of never, manual,  handlews (the
22
 
default),  opportunistic, and  always. Be  aware that  the opportunistic  policy
23
 
fails with  some IRC  servers since  they strip off  the whitespace.  The always
24
 
policy has  the nice side effect  that the first  line you type will  already be
25
 
encrypted.
26
 
 
27
 
If  a  fingerprint can  be  found  for someone,  i.e.  someone  you had  an  OTR
28
 
conversation  with  before,  then  the otr_policy_known  setting  applies  after
29
 
otr_policy. It has the same syntax. The  default is "* always", i.e. enforce OTR
30
 
with  anyone you've  used  OTR with  before.
31
 
 
32
 
Should you finish an OTR session via "/otr finish" and should the active policy
33
 
be always or opportunistic then it will be temporarily set back to handlews.
34
 
Otherwise OTR would start again right away which is probably not what you want.
35
 
This is however reset once you close the query window.
36
 
 
37
 
To make  sure that you are  actually talking to your  buddy, you can agree  on a
38
 
secret somehow  and then one does  "/otr auth <secret>". Shortly  afterwards the
39
 
other  one will  be  asked to  do  the  same and  you're  done. The  traditional
40
 
alternative, comparing  fingerprints over a secure  line, can also be  used. Use
41
 
"/otr trust" once you're sure they match.
42
 
 
43
 
I also strongly  recommend to do "/statusbar window add  otr" so you're informed
44
 
about what's going on.
45
 
 
46
 
In  "~/.irssi/otr/otr.{key,fp}" you'll  find the  fingerprints and  your private
47
 
keys(should you at any point be interested).
48
 
 
49
 
Commands:
50
 
 
51
 
/otr genkey nick@irc.server.com 
52
 
        Manually generate a key for the given account(also done on demand)
53
 
/otr auth [<nick>@<server>] <secret>
54
 
        Initiate or respond to an authentication challenge
55
 
/otr authabort [<nick>@<server>] 
56
 
        Abort any ongoing authentication
57
 
/otr trust [<nick>@<server>]
58
 
        Trust the fingerprint of the user in the current window.
59
 
        You should only do this after comparing fingerprints over a secure line
60
 
/otr debug
61
 
        Switch debug mode on/off
62
 
/otr contexts
63
 
        List all OTR contexts along with their fingerprints and status
64
 
/otr finish [<nick>@<server>]
65
 
        Finish an OTR conversation
66
 
/otr version
67
 
        Display irssi-otr version. Might be a git commit
68
 
 
69
 
Settings:
70
 
 
71
 
otr_policy
72
 
        Comma-separated list of "<nick>@<server> <policy>" pairs. See comments
73
 
        above.
74
 
otr_policy_known
75
 
        Same syntax as otr_policy. Only applied where a fingerprint is
76
 
        available.
77
 
otr_ignore
78
 
        Conversations with nicks that match this regular expression completely
79
 
        bypass libotr. It is very unlikely that you need to touch this setting,
80
 
        just use the OTR policy never to prevent OTR sessions with some nicks.
81
 
otr_finishonunload
82
 
        If true running OTR sessions are finished on /unload and /quit.
83
 
otr_createqueries
84
 
        If true queries are automatically created for OTR log messages.