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