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