-
-
Notifications
You must be signed in to change notification settings - Fork 22
/
README
257 lines (173 loc) · 4.21 KB
/
README
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
== Introduction
FiSH is an encryption add-on module for https://irssi.org/[irssi]. Uses
the https://en.wikipedia.org/wiki/Blowfish_(cipher)[Blowfish cipher] to
encrypt private and public messages in *ECB* or *CBC* modes, using a
specified key. It also includes a secure Diffie-Hellman key exchange for
private chat.
== Requirements
The requirements for building FiSH-irssi are:
* cmake
* pkg-config
* Glib 2.0
* OpenSSL
* irssi (with includes)
=== Debian - Ubuntu
....
# apt-get install build-essential irssi-dev libglib2.0-dev libssl-dev cmake git
....
=== OpenBSD
....
# pkg_add glib2 irssi cmake git
....
=== FreeBSD
* https://www.freshports.org/irc/irssi-fish/[Official package]
=== Arch Linux
....
# pacman -S cmake pkg-config glib2 openssl irssi
....
* https://aur.archlinux.org/packages/fish-irssi-git/[AUR package]
=== CentOS - Fedora
....
yum install gcc pkgconfig cmake irssi irssi-devel openssl openssl-devel glib2 glib2-devel
....
* @duritong
https://copr.fedorainfracloud.org/coprs/duritong/irssi-fish/[copr
repository] with binary packages
== Building
Just type in the following commands:
....
$ git clone https://github.com/falsovsky/FiSH-irssi.git
$ cd FiSH-irssi
$ cmake .
$ make
....
If you want to install to */usr* instead of */usr/local*
....
$ cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr .
$ make
....
Run `make install` as a privileged user (if needed) to install it.
== Running
If you installed the module in the default directory, you just need to
run the following command inside irssi to load it:
....
/load fish
....
If not, just include the path while loading:
....
/load /home/username/libfish.so
....
=== Load automatically at start-up
....
echo "load fish" >> /home/username/.irssi/startup
....
== Configurations
FiSH-irssi has some configurations that can be set via `/set` on irssi.
....
process_outgoing
....
FiSH outgoing messages.
Default value is 1
....
process_incoming
....
unFiSH incoming messages.
Default value is 1
....
auto_keyxchange
....
Do an automatic key exchange in private messages.
Default value is 1
....
plain_prefix
....
Prefix needed to send an unFiSHed message. For example:
`+p Hi there in clear text`
Default value is `+p `
....
mark_encrypted
....
String used to mark a FiSHed message.
Default value is `\002>\002 `
....
mark_position
....
Defines if the mark should be a prefix (1) or a suffix (0).
Default value is 1
....
nicktracker
....
Allows seamless conversations when your chat partner changes his nick.
This feature will copy the old key to use with his new nick. It affects
nick changes for opened queries!
Default value is 1
....
mark_broken_block
....
Indicates whether a message is incomplete.
Default value is `\002&\002`
== Commands
....
/topic+ <message>
....
Sets a FiSHed topic in the current channel.
....
/topic+ TAB
....
Allows to edit a FiSHed topic.
....
/notice+ [nick / #channel] <message>
....
Sends a FiSHed notice to the current window or to the specified target.
....
/me+ <message>
....
Send a FiSHed action to the current window.
....
/setkey [servertag] [nick / #channel] <key>
....
Sets the key used to FiSH the messages for the current window or to the
specified target. To use CBC mode, prefix the key with `cbc:`.
....
/delkey [servertag] [nick/#channel]
....
Unsets the key used to FiSH the messages for the current window or to
the specified target.
....
/key|showkey [servertag] [nick / #channel]
....
Shows the used key to FiSH the messages for the current window or to the
specified target. The key will appear in the target window.
....
/keyx [-ecb|-cbc] [nick]
....
Forces a DH key exchange in the current window or to the specified
target. The default mode is CBC, use the `-ecb` parameter to force ECB
mode.
....
/setinipw <password>
....
Sets a custom password used to cipher the contents of blow.ini.
....
/unsetinipw
....
Unset the custom password used to cipher blow.ini.
....
/fishlogin
....
Used to ask again for the blow.ini password if the user inserts an
invalid password at start-up.
....
/fishhelp|helpfish
....
Show a little help inside irssi.
== Tested
FiSH-irssi has been tested on various OS and arches:
* Linux/x86
* Linux/sparc
* Linux/arm
* OpenBSD/x86
* OpenBSD/macppc
* OpenBSD/sgi
* FreeBSD/x86
* NetBSD/x86