updates
[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    Also, return values from various allocations and functions needs to
129    checked.
130
131
132 TODO In SILC Server
133 ===================
134
135  o Implement all commands on server side.  A lot of commands are still yet
136    to be implemented.  Most of them are trivial but some will require some
137    planning.  Go see the command.c for unimplemented commands.
138
139  o DNS/IP lookup blocks the server.  This must be fixed.  Check the
140    resolver stuff (resolver(3), resolver(5)).  Either we have to do the
141    own resolver stuff (through scheduler, if possible without writing
142    too much own stuff) or use threads.
143
144  o Lenght of the packet processing timeouts needs to be checked whether
145    they are too short or too long.  I haven't really tested whether they
146    are suitable.  They should be tested on high load which I haven't done
147    at all yet.
148
149  o INVITE command must set the channel's invite list if channel is 
150    invite-only channel.
151
152  o Public and private key generation is now done everytime the program
153    is run.  Now, this is only for testing period as I've been lazy to
154    do it any better for now.  This must be fixed.
155
156  o Server says that it is able to listen on multiple ports but currently
157    that is bogus.  It can, but internals are for single server.
158
159  o Command lagging must implemented.  Those commands (all currently) that
160    has the LAG flag set they must not be allowed to be executed more than
161    once, say, in 2 seconds.
162
163  o Command flag usage in general is not implemented yet.
164
165  o Client history must be implemented.  Protocol says that server must
166    keep history information about clients for some period of time.
167
168  o Channel flags and user modes on channels are not implemented yet as
169    /MODE command is not implemented yet in client and server.
170
171  o Protocol execution timeouts are hard coded, should be configurable.
172
173  o Channel message sending routines uses a lot of common code.  Should
174    create a common function for those instead of writing the same code
175    again everytime, as done now.
176
177  o serverutil.c I guess should be created for util-like functions that
178    now resides in server.c, which is getting too big.
179
180  o serverconfig.c and the function naming in it is inconsistent.  It is 
181    not silc_config_server* it should be silc_server_config*.  As should
182    all the SilcConfigServer* types be SilcServerConfig*.
183
184  o Implement DENY_CONNECTION section in serverconfig.c and in server.
185
186  o Implement REDIRECT_CLIENT section in serverconfig.c and in server.
187
188  o Configuration file format - could be better.
189
190  o IP address fields in configuration file should accept mask format
191    as well, IP/MASK, and not just plain IP.
192
193  o Connection classes should be actually implemented in serverconfig.c.
194    They can be defined but they are totally ignored currently.
195
196  o Acceptance of incoming connections (client and server connections)
197    should be checked before key exchange protocol.  Currently it is
198    checked at the authentication phase after KE, that is ok, but it should
199    be checked before starting KE, as well.
200
201  o Statistics are totally missing from the server.  It would be nice
202    to gather some statistics.
203
204  o All allocations and freeing needs to be checked for memory leaks.
205    Also, return values from various allocations and functions needs to
206    checked.
207
208
209 TODO In SILC Libraries
210 ======================
211
212  o Public key verification in SKE (SILC Key Exchange) protocol is missing,
213    thus currently we trust on all public keys.  This probably doesn't cause
214    bad problems but the mechanism of verifying it from local database
215    (from files) needs to be done (it can open man-in-the-middle-attacks).
216
217  o Implement PFS (Perfect Forward Secrecy) flag in SKE (and in client and
218    server, actually).  If PFS is set, re-key must cause new key exchange.
219    This is required by the SILC protocol.
220
221  o Re-key in general is actually missing (from everywhere) and must be done.
222
223  o SKE does not send correct status types.  Types are defined but not
224    sent.
225
226  o Connection authentication protocol does not send correct status types.
227    These types are not defined currently at all.
228
229  o PKCS#1 style RSA public key encryption/decryption/sign/verify is 
230    missing, and should be added for interoperability reasons.  The thing 
231    I've done now is bad and should be removed as soon as possible (or 
232    the protocol should then state the method of how they should be done).
233
234  o SILC public key file type is bad.  I'd like to see PEM encoded files.
235    I have public domain code for base64 encoding but it needs to be 
236    rewritten.
237
238  o Slow ciphers should be removed.  I think we don't need more than
239    the AES finalists plus blowfish and RC5.
240
241  o These slow ciphers actually don't work currently as I've tested
242    only the ones that are worth testing.  The CBC mode on these slow
243    ciphers probably don't work.  No need to worry, these ciphers should
244    be removed.
245
246  o Scheduler needs to be analyzed on high load as it might be unfair
247    towards select() because it may run timeout tasks before select() and
248    after select().  If it is found to be unfair the timeout task running
249    before select() should probably be removed.
250
251  o On select() issue; maybe we should use poll() instead if it is
252    available? poll() doesn't have max fd limit...
253
254  o SIM support for SILC PKCS API needs to made so that they could be
255    used as SIM's.  At the same time some work is required on prime
256    generation as the way it is done now sucks.  Read from code for
257    more (silcpkcs.h).
258
259  o Compression routines are missing.  The protocol supports packet
260    compression thus it must be implemented.  SILC Comp API must be
261    defined.  zlib package is already included into the lib dir (in CVS,
262    not in distribution), but it is not used yet, and it requires some
263    tweaking on the Makefiles (we want static lib not shared).
264
265  o Cipher API needs to be made more consistent.  Some parts of the
266    code generated with current Cipher API looks really bad.  Same
267    is with PKCS API, even worse actually.  They need to be made
268    cleaner.  Introducing silc_cipher_encrypt/decrypt/set_key etc.
269    functions (I actually don't understand why have I left these un-done).
270
271  o Scheduler should automatically allocate task queues if NULL pointers 
272    are passed to the silc_schedule_init.  Would make initialization 
273    cleaner.
274
275  o Packet processing routines in client and server are actually pretty
276    much generic and should be moved from the client/server to the library
277    as generic routines (silc_<client/server>_packet_decrypt_rest* etc).
278    This requires heavy changes to the client and server.
279
280  o Random Number Generator needs some tweaking.  Reading /dev/random may
281    block resulting slow initialization of RNG.  Some other things in the
282    RNG may block as well.  Also, I have some pending changes to the RNG 
283    that needs to be commited (from Schneier's Yarrow-160 paper).  They 
284    should make the RNG even better.
285
286  o Logging should be made more generic in a way that application can
287    set to where the logging is destined to.  Now, it is always destined
288    to stdout (or stderr) which is a bad thing for client.  Ie. some
289    sort of logging registration functions or similiar should be done
290    (silclog.[ch] in core).  The actual output of logs should be done
291    by callback function in the application not in lib.
292
293  o I don't like the ID cache system currenly implemented.  Ugly and
294    not so good.  Must be rewritten very soon.
295
296  o All allocations and freeing needs to be checked for memory leaks.
297
298  o There are also checks missing from allocations whether the allocation
299    returns valid memory or NULL.  These are missing in library as well
300    in client and server.  Either all checks has to be added or we will
301    have to make sure that silc_*alloc()s always return valid memory
302    and assert()s if the system's memory allocator (*alloc()) fails.
303
304  o silc_buffer_[un]format() needs to be made more stable as it may
305    crash the SILC if malformed data is sent as argument.  There are a
306    lot of places in client and server where we trust directly data coming
307    from network and try to unformat it.  The unformatting routine needs
308    to be able handle situations where data sent is malformed, by mistake
309    or intentionally.  This is important as it is easy to crash the SILC
310    now by just sending malformed data.  Also, in client and server we
311    must start checking the return value from silc_buffer_[un]format.
312
313
314 Other Things TODO
315 =================
316
317  o Write manuals for server.
318
319  o Write manuals for client.
320
321  o Write SILC Library Reference manual.  This would include all the SILC
322    API's with simple examples how the functions are to be used.  This is
323    pretty easy to create by taking all the functions plus their comments
324    from source/header files.  However, same sort of reference manual 
325    should be written for client and server as well.
326
327
328 TODO After 1.0
329 ==============
330
331  o Pthreads support.  A lot of problems are solved with server (and with
332    client as well) if we add pthread support.  We can forget things such
333    as non-blocking connecting etc, and we can do things such as DNS/IP
334    lookups async.  The server itself also benefits great deal from 
335    threads, especially from performance point of view.
336
337    But, this is not a small task and almost entire SILC Library has to
338    be made re-entrant.  Own API is probably added for the threads support
339    to make changes in the future as painless as possible.  So the API 
340    would have things like silc_mutex_lock, silc_mutex_unlock and 
341    friends...
342
343  o X.509 certificate support.  SILC protocol supports certificates and
344    it would be great to have support for them.  This is a big task as
345    support has to be made for ASN.1 as well.  I've looked into OpenSSL 
346    package as it has X.509 certificate support (and ASN.1 as well).  
347    The code does not look very good to my eye but it has some potentials.
348    This should be looked at more closely.
349
350    Naturally own SILC Certificate API has to be defined regardles what
351    the actual X.509 library is (OpenSSL X.509 or something else).  Other
352    choice is to write own X.509 library but I'm not going to do it - 
353    I can help to migrate the OpenSSL X.509 into SILC and I can help if 
354    someone would like to write the X.509 library - but I'm not going 
355    to start writing one myself.  Anyhow, the OpenSSL X.509 lib should
356    be checked.
357
358  o SSH2 public keys support.  Maybe - not really needed but could be
359    nice as SSH is widely used all over the place.  SILC Protocol 
360    supports SSH2 public keys.
361
362  o IRC support for SILC client.  This would be nice to have on client
363    as it could be used to connect to SILC and IRC.  People wouldn't
364    have to have two different clients when same would work on both.
365    I'd like to see this done as SIM, after the extended SIM support
366    has been added to SILC.
367
368  o Cipher optimizations (asm, that this) at least for i386 would be nice.