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 Optimization in general.  I have not focused to program optimized code
  19    in many circumstances.  It has been more important to get this up and
  20    working.  A lot must be optimized especially the ID cache.  Instead of
  21    using lists some hash tables should be used.  The searching by ID and
  22    such must be made a lot faster.  If someone would like dedicate their
  23    efforts purely to generate optimized code I'd be appreaciated.
  24
  25  o We should replace all short, int, long, unsigned short, unsigned int,
  26    unsigned long with some pre-defined datatypes that really are what
  27    we want on all platforms.  int16, uint16, int32, uint32 etc. are
  28    what we could use or maybe SilcInt16, SilcUInt16 etc.  Also, boolean
  29    datatype should be defined.
  30
  31  o Add boolean (or bool), typedef of unsigned char.
  32
  33  o More platform supports should be added.  The code is pretty much
  34    generic but there are some parts that require porting (SIM).  Also,
  35    some support for different platforms is needed into configure.in.
  36
  37  o SILC requires currently GCC to work because we use GCC specific
  38    compilation options.  Generally any compiler that supports inline
  39    functions and can build shared libraries (for SIMs) should work.
  40    These cases should be included into configure.in.
  41
  42  o Extended SIM (SILC Module) support.  Currently only SILC Cipher API
  43    and SILC Hash API may be used as SIM's.  What I have in mind is to
  44    have extended support for SIM's so that basically any SILC API could
  45    be used as SIM's.  This would open tremendous possiblities but
  46    opens also issues on security that needs to be dealt with.
  47
  48    Some sort of SIM compilation environment should be defined so that
  49    the SIM's could use SILC specific symbols from the modules (which they
  50    cannot do currently).  In the future modules could add new features
  51    to SILC easily with this support.  I'm more thinking this from client's
  52    perspective to add new features to client (such as IRC support as SIM)
  53    but server should have the support as well.  Anyhow, this is an
  54    interesting feature...
  55
  56    This maybe post 1.0 task - dunno.
  57
  58  o SIM support for other platforms than just for Linux.  Apache has
  59    example code (code that we could use directly pretty easily) for
  60    other platforms.
  61
  62 TODO In SILC Client Library
  63 ===========================
  64
  65  o Client library crashes if for example server timeouts protocol
  66    execution and disconnects the client.  The client, on the other hand
  67    may still assume that the connection is active, even after receiving
  68    the EOF.  Reason for this is that the clien library does not handle
  69    the SilcSocketConnection reference counter at all.  This must be
  70    fixed.
  71
  72  o Add client library parameters or options that handle what kind of
  73    messages the library should print out (using `say' client operation,
  74    for example) and what is left for the application to print.  The
  75    appliation could for example set that it handles all command printing
  76    but all error printing should be handled by the library, etc...
  77
  78  o Non-blocking connection on the background must be stopped if some
  79    other connection on same window has established.  Now it is possible
  80    that some non-blocking connection timeouts on the background when
  81    we already have a working connection to some other place; things
  82    goes bad.
  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 I guess, public key authentication (when connecting to a server)
  92    is not working currently.  It is just matter of loading the keys
  93    from file and using them (see corresponding code in server, it should
  94    support public key authentication already).
  95
  96  o Connection Authentication request resolving is missing and must be
  97    done.  This is required by the protocol.
  98
  99
 100 TODO In SILC Server
 101 ===================
 102
 103  o Functions such as silc_server_private_message,
 104    silc_server_private_message_key and
 105    silc_server_packet_process_relay_notify can be optimized.  I don't think
 106    we need such a big lookups to lookup the router to the destination,
 107    it is already provided in the client entry.
 108
 109  o silc_server_send_key_agreement and silc_server_send_private_message_key
 110    are one and same function (also silc_server_send_private_message is
 111    almost same function).  These should be unified to one generic named
 112    function and use that (silc_server_packet_relay_notify is also
 113    same function).
 114
 115  o Packet processing can be made faster. All packet function in the
 116    packet_receive.c has same prototypes.  Instead of calling those from
 117    huge switch() make a table of callback functions that can be called
 118    directly by the packet type.
 119
 120  o DNS/IP lookup blocks the server.  This must be fixed.  Check the
 121    resolver stuff (resolver(3), resolver(5)).  Either we have to do the
 122    own resolver stuff (through scheduler, if possible without writing
 123    too much own stuff) or use threads.
 124
 125  o Length of the packet processing timeouts needs to be checked whether
 126    they are too short or too long.  I haven't really tested whether they
 127    are suitable.  They should be tested on high load which I haven't done
 128    at all yet.
 129
 130  o INVITE command must set the channel's invite list if channel is
 131    invite-only channel.
 132
 133  o Server says that it is able to listen on multiple ports but currently
 134    that is bogus.  It can, but internals are for single server.
 135
 136  o Command flag usage in general is not implemented yet.
 137
 138  o Client history must be implemented.  Protocol says that server must
 139    keep history information about clients for some period of time.
 140
 141  o Protocol execution timeouts are hard coded, should be configurable.
 142
 143  o IP address fields in configuration file should accept mask format
 144    as well, IP/MASK, and not just plain IP.
 145
 146  o Connection classes should be actually implemented in serverconfig.c.
 147    They can be defined but they are totally ignored currently.
 148
 149  o Acceptance of incoming connections (client and server connections)
 150    should be checked before key exchange protocol.  Currently it is
 151    checked at the authentication phase after KE, that is ok, but it should
 152    be checked before starting KE, as well.
 153
 154
 155 TODO In SILC Libraries
 156 ======================
 157
 158  o Rewrite the task system.  I made it too complex and too "neat" and
 159    it really should be rewritten.  We don't need priorities really, one
 160    priority is enough.  This will simplify a lot the task system.
 161
 162  o Implement PFS (Perfect Forward Secrecy) flag in SKE (and in client and
 163    server, actually).  If PFS is set, re-key must cause new key exchange.
 164    This is required by the SILC protocol.
 165
 166  o Re-key in general is actually missing (from everywhere) and must be done.
 167
 168  o ID Cache expiry does not work.
 169
 170  o Compression routines are missing.  The protocol supports packet
 171    compression thus it must be implemented.  SILC Comp API must be
 172    defined.  zlib package is already included into the lib dir (in CVS,
 173    not in distribution), but it is not used yet, and it requires some
 174    tweaking on the Makefiles (we want static lib not shared).
 175
 176  o SIM support for SILC PKCS API needs to made so that they could be
 177    used as SIM's.  At the same time some work is required on prime
 178    generation as the way it is done now sucks.  Read from code for
 179    more (silcpkcs.h).
 180
 181  o Random Number Generator needs some tweaking.  Reading /dev/random may
 182    block resulting slow initialization of RNG.  Some other things in the
 183    RNG may block as well.  Also, I have some pending changes to the RNG
 184    that needs to be commited (from Schneier's Yarrow-160 paper).  They
 185    should make the RNG even better.
 186
 187  o Scheduler needs to be analyzed on high load as it might be unfair
 188    towards select() because it may run timeout tasks before select() and
 189    after select().  If it is found to be unfair the timeout task running
 190    before select() should probably be removed.
 191
 192
 193 Other Things TODO
 194 =================
 195
 196  o Write manuals for server.
 197
 198  o Write manuals for client.
 199
 200  o Write SILC Library Reference manual.  This would include all the SILC
 201    API's with simple examples how the functions are to be used.  This is
 202    pretty easy to create by taking all the functions plus their comments
 203    from source/header files.  However, same sort of reference manual
 204    should be written for client and server as well.
 205
 206
 207 TODO After 1.0
 208 ==============
 209
 210  o Pthreads support.  A lot of problems are solved with server (and with
 211    client as well) if we add pthread support.  We can forget things such
 212    as non-blocking connecting etc, and we can do things such as DNS/IP
 213    lookups async.  The server itself also benefits great deal from
 214    threads, especially from performance point of view.
 215
 216    But, this is not a small task and almost entire SILC Library has to
 217    be made re-entrant.  Own API is probably added for the threads support
 218    to make changes in the future as painless as possible.  So the API
 219    would have things like silc_mutex_lock, silc_mutex_unlock and
 220    friends...
 221
 222  o X.509 certificate support.  SILC protocol supports certificates and
 223    it would be great to have support for them.  This is a big task as
 224    support has to be made for ASN.1 as well.  I've looked into OpenSSL
 225    package as it has X.509 certificate support (and ASN.1 as well).
 226    The code does not look very good to my eye but it has some potentials.
 227    This should be looked at more closely.
 228
 229    Naturally own SILC Certificate API has to be defined regardles what
 230    the actual X.509 library is (OpenSSL X.509 or something else).  Other
 231    choice is to write own X.509 library but I'm not going to do it -
 232    I can help to migrate the OpenSSL X.509 into SILC and I can help if
 233    someone would like to write the X.509 library - but I'm not going
 234    to start writing one myself.  Anyhow, the OpenSSL X.509 lib should
 235    be checked.
 236
 237  o SSH2 public keys support.  Maybe - not really needed but could be
 238    nice as SSH is widely used all over the place.  SILC Protocol
 239    supports SSH2 public keys.
 240
 241  o Cipher optimizations (asm, that this) at least for i386 would be nice.