Moved silc_client_ch[u]mode[_char] to client library from silc/.
[silc.git] / public_html / todo.html
1 <html>
2 <style TYPE="text/css"><!-- A:link {text-decoration: none}A:visited{text-decoration:none}A:active{text-decoration:none}--></style>
3 <body bgcolor="#ffffff">
4 <p><br>
5 <a href="index.html"><img src="silc2.jpg" border=0></a>
6 <table width="70%" border="0" cellspacing="0" cellpadding="1"
7 align=center>
8 <tr>
9 <td>
10 <p>
11 <font size=4>
12 <h1>TODO</h1>
13 <p>
14 <pre>
15 TODO
16 ====
17
18 This is more or less complete list of tasks that has to be done before
19 SILC 1.0 could ever be released.  It is clear that the list does not
20 include all the bugs that exists.  At the end of list are tasks that 
21 needs to be done but are probably post 1.0.
22
23 Feel free to contribute if you have the ability and free time - all the
24 help is really appreciated - and needed.
25
26                                                         - Pekka
27
28
29 New features TODO
30 =================
31
32  o Extended SIM (SILC Module) support.  Currently only SILC Cipher API
33    and SILC Hash API may be used as SIM's.  What I have in mind is to
34    have extended support for SIM's so that basically any SILC API could
35    be used as SIM's.  This would open tremendous possiblities but
36    opens also issues on security that needs to be dealt with.
37
38    Some sort of SIM compilation environment should be defined so that
39    the SIM's could use SILC specific symbols from the modules (which they
40    cannot do currently).  In the future modules could add new features
41    to SILC easily with this support.  I'm more thinking this from client's
42    perspective to add new features to client (such as IRC support as SIM)
43    but server should have the support as well.  Anyhow, this is an 
44    interesting feature...
45
46    This maybe post 1.0 task - dunno.
47
48  o SIM support for other platforms than just for Linux.  Apache has
49    example code (code that we could use directly pretty easily) for
50    other platforms.
51
52  o We should replace all short, int, long, unsigned short, unsigned int,
53    unsigned long with some pre-defined datatypes that really are what
54    we want on all platforms.  int16, uint16, int32, uint32 etc. are
55    what we could use or maybe SilcInt16, SilcUInt16 etc.  Also, boolean
56    datatype should be defined.
57
58  o More platform supports should be added.  The code is pretty much
59    generic but there are some parts that require porting (SIM).  Also, 
60    some support for different platforms is needed into configure.in.
61
62  o SILC requires currently GCC to work because we use GCC specific 
63    compilation options.  Generally any compiler that supports inline
64    functions and can build shared libraries (for SIMs) should work.  
65    These cases should be included into configure.in.
66
67
68 TODO In SILC Client
69 ===================
70
71  o Implement all commands.  A lot of commands are still yet to be
72    implemented.  Most of them are trivial but some will require some
73    planning.  Go see the command.c for unimplemented commands.
74
75  o Non-blocking connection on the background must be stopped if some
76    other connection on same window has established.  Now it is possible
77    that some non-blocking connection timeouts on the background when
78    we already have a working connection to some other place; things
79    goes bad.
80
81  o Finish WHOIS, finish JOIN and other commands that are partly
82    implemented.
83
84  o Input line on UI is buggy.  Cursor movement etc bugs.  Too lazy to
85    fix it.
86
87  o Logic for handling multiple same nicknames for example in private
88    message sending.  I guess the logic is done in server side but is
89    missing from client.
90
91  o Private message key setting is missing and must be implemented.
92    Currently private messages are encrypted with session keys.  This
93    is required by the protocol.
94
95  o Channel private key setting is missing and must be implemented.
96    Currently there cannot be private keys for channels.  Normal channel
97    keys (generated by server) are used.  This is required by the protocol.
98
99  o Public and private key generation is now done everytime the program
100    is run.  Now, this is only for testing period as I've been lazy to
101    do it any better for now.  This must be fixed.
102
103  o I guess, public key authentication (when connecting to a server)
104    is not working currently.  It is just matter of loading the keys
105    from file and using them (see corresponding code in server, it should
106    support public key authentication already).
107
108  o Multiple windows support.  Basic support for multiple windows already
109    exists but a lot is still missing to get it working.  Also, some
110    of the existing stuff probably needs to be tweaked a bit before the
111    multiple windows support could be done.  And of course the actual
112    commands that control the windows needs to be written (/WINDDOW).
113
114  o Implement /KEYMAP (or similiar) command to remap control and function
115    keys.
116
117  o Implement /ALIAS command to make command aliases.
118
119  o Implement /set/if/do/while etc as in IRC2.  Maybe post 1.0 task.
120    Some scripting would be good.
121
122  o Connection Authentication request resolving is missing and must be
123    done.  This is required by the protocol.
124
125  o Key Exchange protocol's responder side is missing from client.  
126    Generally it is possible for the client to be responder so it should
127    be implemented (See corresponding code from server).  Error handling
128    in the KE protocol is also in pretty bad shape in client.
129
130  o Configuration file loading from global and from local dirs.  This
131    is currently missing and I guess the global is only used.  Old SILC
132    version (in 1997) had ~./silc directory that I guess should be done
133    now as well.  The code for handling those exists but not in current
134    source tree.
135
136  o Configuration file format - could be better.
137
138  o Write help files for commands.  Nice format for the help files should
139    be selected.  I'm open for ideas.
140
141  o All allocations and freeing needs to be checked for memory leaks.
142
143
144 TODO In SILC Server
145 ===================
146
147  o Implement all commands on server side.  A lot of commands are still yet
148    to be implemented.  Most of them are trivial but some will require some
149    planning.  Go see the command.c for unimplemented commands.
150
151  o DNS/IP lookup blocks the server.  This must be fixed.  Check the
152    resolver stuff (resolver(3), resolver(5)).  Either we have to do the
153    own resolver stuff (through scheduler, if possible without writing
154    too much own stuff) or use threads.
155
156  o Lenght of the packet processing timeouts needs to be checked whether
157    they are too short or too long.  I haven't really tested whether they
158    are suitable.  They should be tested on high load which I haven't done
159    at all yet.
160
161  o INVITE command must set the channel's invite list if channel is 
162    invite-only channel.
163
164  o Public and private key generation is now done everytime the program
165    is run.  Now, this is only for testing period as I've been lazy to
166    do it any better for now.  This must be fixed.
167
168  o Server says that it is able to listen on multiple ports but currently
169    that is bogus.  It can, but internals are for single server.
170
171  o Command lagging must implemented.  Those commands (all currently) that
172    has the LAG flag set they must not be allowed to be executed more than
173    once, say, in 2 seconds.
174
175  o Command flag usage in general is not implemented yet.
176
177  o Client history must be implemented.  Protocol says that server must
178    keep history information about clients for some period of time.
179
180  o Channel flags and user modes on channels are not implemented yet as
181    /MODE command is not implemented yet in client and server.
182
183  o Protocol execution timeouts are hard coded, should be configurable.
184
185  o Channel message sending routines uses a lot of common code.  Should
186    create a common function for those instead of writing the same code
187    again everytime, as done now.
188
189  o serverutil.c I guess should be created for util-like functions that
190    now resides in server.c, which is getting too big.
191
192  o serverconfig.c and the function naming in it is inconsistent.  It is 
193    not silc_config_server* it should be silc_server_config*.  As should
194    all the SilcConfigServer* types be SilcServerConfig*.
195
196  o Implement DENY_CONNECTION section in serverconfig.c and in server.
197
198  o Implement REDIRECT_CLIENT section in serverconfig.c and in server.
199
200  o Configuration file format - could be better.
201
202  o IP address fields in configuration file should accept mask format
203    as well, IP/MASK, and not just plain IP.
204
205  o Connection classes should be actually implemented in serverconfig.c.
206    They can be defined but they are totally ignored currently.
207
208  o Acceptance of incoming connections (client and server connections)
209    should be checked before key exchange protocol.  Currently it is
210    checked at the authentication phase after KE, that is ok, but it should
211    be checked before starting KE, as well.
212
213  o Statistics are totally missing from the server.  It would be nice
214    to gather some statistics.
215
216  o All allocations and freeing needs to be checked for memory leaks.
217
218
219 TODO In SILC Libraries
220 ======================
221
222  o Public key verification in SKE (SILC Key Exchange) protocol is missing,
223    thus currently we trust on all public keys.  This probably doesn't cause
224    bad problems but the mechanism of verifying it from local database
225    (from files) needs to be done (it can open man-in-the-middle-attacks).
226
227  o Implement PFS (Perfect Forward Secrecy) flag in SKE (and in client and
228    server, actually).  If PFS is set, re-key must cause new key exchange.
229    This is required by the SILC protocol.
230
231  o Re-key in general is actually missing (from everywhere) and must be done.
232
233  o SKE does not send correct status types.  Types are defined but not
234    sent.
235
236  o Connection authentication protocol does not send correct status types.
237    These types are not defined currently at all.
238
239  o PKCS#1 style RSA public key encryption/decryption/sign/verify is 
240    missing, and should be added for interoperability reasons.  The thing 
241    I've done now is bad and should be removed as soon as possible (or 
242    the protocol should then state the method of how they should be done).
243
244  o SILC public key file type is bad.  I'd like to see PEM encoded files.
245    I have public domain code for base64 encoding but it needs to be 
246    rewritten.
247
248  o Slow ciphers should be removed.  I think we don't need more than
249    the AES finalists plus blowfish and RC5.
250
251  o These slow ciphers actually don't work currently as I've tested
252    only the ones that are worth testing.  The CBC mode on these slow
253    ciphers probably don't work.  No need to worry, these ciphers should
254    be removed.
255
256  o Scheduler needs to be analyzed on high load as it might be unfair
257    towards select() because it may run timeout tasks before select() and
258    after select().  If it is found to be unfair the timeout task running
259    before select() should probably be removed.
260
261  o On select() issue; maybe we should use poll() instead if it is
262    available? poll() doesn't have max fd limit...
263
264  o SIM support for SILC PKCS API needs to made so that they could be
265    used as SIM's.  At the same time some work is required on prime
266    generation as the way it is done now sucks.  Read from code for
267    more (silcpkcs.h).
268
269  o Compression routines are missing.  The protocol supports packet
270    compression thus it must be implemented.  SILC Comp API must be
271    defined.  zlib package is already included into the lib dir (in CVS,
272    not in distribution), but it is not used yet, and it requires some
273    tweaking on the Makefiles (we want static lib not shared).
274
275  o Cipher API needs to be made more consistent.  Some parts of the
276    code generated with current Cipher API looks really bad.  Same
277    is with PKCS API, even worse actually.  They need to be made
278    cleaner.  Introducing silc_cipher_encrypt/decrypt/set_key etc.
279    functions (I actually don't understand why have I left these un-done).
280
281  o Scheduler should automatically allocate task queues if NULL pointers 
282    are passed to the silc_schedule_init.  Would make initialization 
283    cleaner.
284
285  o Packet processing routines in client and server are actually pretty
286    much generic and should be moved from the client/server to the library
287    as generic routines (silc_<client/server>_packet_decrypt_rest* etc).
288    This requires heavy changes to the client and server.
289
290  o Random Number Generator needs some tweaking.  Reading /dev/random may
291    block resulting slow initialization of RNG.  Some other things in the
292    RNG may block as well.  Also, I have some pending changes to the RNG 
293    that needs to be commited (from Schneier's Yarrow-160 paper).  They 
294    should make the RNG even better.
295
296  o Logging should be made more generic in a way that application can
297    set to where the logging is destined to.  Now, it is always destined
298    to stdout (or stderr) which is a bad thing for client.  Ie. some
299    sort of logging registration functions or similiar should be done
300    (silclog.[ch] in core).  The actual output of logs should be done
301    by callback function in the application not in lib.
302
303  o I don't like the ID cache system currenly implemented.  Ugly and
304    not so good.  Must be rewritten very soon.
305
306  o All allocations and freeing needs to be checked for memory leaks.
307
308  o silc_buffer_[un]format() needs to be made more stable as it may
309    crash the SILC if malformed data is sent as argument.  There are a
310    lot of places in client and server where we trust directly data coming
311    from network and try to unformat it.  The unformatting routine needs
312    to be able handle situations where data sent is malformed, by mistake
313    or intentionally.  This is important as it is easy to crash the SILC
314    now by just sending malformed data.  Also, in client and server we
315    must start checking the return value from silc_buffer_[un]format.
316
317
318 Other Things TODO
319 =================
320
321  o Write manuals for server.
322
323  o Write manuals for client.
324
325  o Write SILC Library Reference manual.  This would include all the SILC
326    API's with simple examples how the functions are to be used.  This is
327    pretty easy to create by taking all the functions plus their comments
328    from source/header files.  However, same sort of reference manual 
329    should be written for client and server as well.
330
331
332 TODO After 1.0
333 ==============
334
335  o Pthreads support.  A lot of problems are solved with server (and with
336    client as well) if we add pthread support.  We can forget things such
337    as non-blocking connecting etc, and we can do things such as DNS/IP
338    lookups async.  The server itself also benefits great deal from 
339    threads, especially from performance point of view.
340
341    But, this is not a small task and almost entire SILC Library has to
342    be made re-entrant.  Own API is probably added for the threads support
343    to make changes in the future as painless as possible.  So the API 
344    would have things like silc_mutex_lock, silc_mutex_unlock and 
345    friends...
346
347  o X.509 certificate support.  SILC protocol supports certificates and
348    it would be great to have support for them.  This is a big task as
349    support has to be made for ASN.1 as well.  I've looked into OpenSSL 
350    package as it has X.509 certificate support (and ASN.1 as well).  
351    The code does not look very good to my eye but it has some potentials.
352    This should be looked at more closely.
353
354    Naturally own SILC Certificate API has to be defined regardles what
355    the actual X.509 library is (OpenSSL X.509 or something else).  Other
356    choice is to write own X.509 library but I'm not going to do it - 
357    I can help to migrate the OpenSSL X.509 into SILC and I can help if 
358    someone would like to write the X.509 library - but I'm not going 
359    to start writing one myself.  Anyhow, the OpenSSL X.509 lib should
360    be checked.
361
362  o SSH2 public keys support.  Maybe - not really needed but could be
363    nice as SSH is widely used all over the place.  SILC Protocol 
364    supports SSH2 public keys.
365
366  o IRC support for SILC client.  This would be nice to have on client
367    as it could be used to connect to SILC and IRC.  People wouldn't
368    have to have two different clients when same would work on both.
369    I'd like to see this done as SIM, after the extended SIM support
370    has been added to SILC.
371
372  o Cipher optimizations (asm, that this) at least for i386 would be nice.
373 </pre>
374 <p>
375
376 </td>
377 </tr>
378 </table>
379 </body>
380 </html>