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 Add client library parameters or options that handle what kind of
  66    messages the library should print out (using `say' client operation,
  67    for example) and what is left for the application to print.  The
  68    appliation could for example set that it handles all command printing
  69    but all error printing should be handled by the library, etc...
  70
  71  o Non-blocking connection on the background must be stopped if some
  72    other connection on same window has established.  Now it is possible
  73    that some non-blocking connection timeouts on the background when
  74    we already have a working connection to some other place; things
  75    goes bad.
  76
  77  o Input line on UI is buggy.  Cursor movement etc bugs.  Too lazy to
  78    fix it.
  79
  80  o Logic for handling multiple same nicknames for example in private
  81    message sending.  I guess the logic is done in server side but is
  82    missing from client.
  83
  84  o I guess, public key authentication (when connecting to a server)
  85    is not working currently.  It is just matter of loading the keys
  86    from file and using them (see corresponding code in server, it should
  87    support public key authentication already).
  88
  89  o Connection Authentication request resolving is missing and must be
  90    done.  This is required by the protocol.
  91
  92
  93 TODO In SILC Server
  94 ===================
  95
  96  o Packet processing can be made faster. All packet function in the
  97    packet_receive.c has same prototypes.  Instead of calling those from
  98    huge switch() make a table of callback functions that can be called
  99    directly by the packet type.
 100
 101  o silc_server_send_key_agreement and silc_server_send_private_message_key
 102    are one and same function (also silc_server_send_private_message is
 103    almost same function).  These should be unified to one generic named
 104    function and use that.
 105
 106  o DNS/IP lookup blocks the server.  This must be fixed.  Check the
 107    resolver stuff (resolver(3), resolver(5)).  Either we have to do the
 108    own resolver stuff (through scheduler, if possible without writing
 109    too much own stuff) or use threads.
 110
 111  o Length of the packet processing timeouts needs to be checked whether
 112    they are too short or too long.  I haven't really tested whether they
 113    are suitable.  They should be tested on high load which I haven't done
 114    at all yet.
 115
 116  o INVITE command must set the channel's invite list if channel is
 117    invite-only channel.
 118
 119  o Server says that it is able to listen on multiple ports but currently
 120    that is bogus.  It can, but internals are for single server.
 121
 122  o Command flag usage in general is not implemented yet.
 123
 124  o Client history must be implemented.  Protocol says that server must
 125    keep history information about clients for some period of time.
 126
 127  o Protocol execution timeouts are hard coded, should be configurable.
 128
 129  o IP address fields in configuration file should accept mask format
 130    as well, IP/MASK, and not just plain IP.
 131
 132  o Connection classes should be actually implemented in serverconfig.c.
 133    They can be defined but they are totally ignored currently.
 134
 135  o Acceptance of incoming connections (client and server connections)
 136    should be checked before key exchange protocol.  Currently it is
 137    checked at the authentication phase after KE, that is ok, but it should
 138    be checked before starting KE, as well.
 139
 140
 141 TODO In SILC Libraries
 142 ======================
 143
 144  o Rewrite the task system.  I made it too complex and too "neat" and
 145    it really should be rewritten.  We don't need priorities really, one
 146    priority is enough.  This will simplify a lot the task system.
 147
 148  o Implement PFS (Perfect Forward Secrecy) flag in SKE (and in client and
 149    server, actually).  If PFS is set, re-key must cause new key exchange.
 150    This is required by the SILC protocol.
 151
 152  o Re-key in general is actually missing (from everywhere) and must be done.
 153
 154  o ID Cache expiry does not work.
 155
 156  o Compression routines are missing.  The protocol supports packet
 157    compression thus it must be implemented.  SILC Comp API must be
 158    defined.  zlib package is already included into the lib dir (in CVS,
 159    not in distribution), but it is not used yet, and it requires some
 160    tweaking on the Makefiles (we want static lib not shared).
 161
 162  o SIM support for SILC PKCS API needs to made so that they could be
 163    used as SIM's.  At the same time some work is required on prime
 164    generation as the way it is done now sucks.  Read from code for
 165    more (silcpkcs.h).
 166
 167  o Random Number Generator needs some tweaking.  Reading /dev/random may
 168    block resulting slow initialization of RNG.  Some other things in the
 169    RNG may block as well.  Also, I have some pending changes to the RNG
 170    that needs to be commited (from Schneier's Yarrow-160 paper).  They
 171    should make the RNG even better.
 172
 173  o Scheduler needs to be analyzed on high load as it might be unfair
 174    towards select() because it may run timeout tasks before select() and
 175    after select().  If it is found to be unfair the timeout task running
 176    before select() should probably be removed.
 177
 178
 179 Other Things TODO
 180 =================
 181
 182  o Write manuals for server.
 183
 184  o Write manuals for client.
 185
 186  o Write SILC Library Reference manual.  This would include all the SILC
 187    API's with simple examples how the functions are to be used.  This is
 188    pretty easy to create by taking all the functions plus their comments
 189    from source/header files.  However, same sort of reference manual
 190    should be written for client and server as well.
 191
 192
 193 TODO After 1.0
 194 ==============
 195
 196  o Pthreads support.  A lot of problems are solved with server (and with
 197    client as well) if we add pthread support.  We can forget things such
 198    as non-blocking connecting etc, and we can do things such as DNS/IP
 199    lookups async.  The server itself also benefits great deal from
 200    threads, especially from performance point of view.
 201
 202    But, this is not a small task and almost entire SILC Library has to
 203    be made re-entrant.  Own API is probably added for the threads support
 204    to make changes in the future as painless as possible.  So the API
 205    would have things like silc_mutex_lock, silc_mutex_unlock and
 206    friends...
 207
 208  o X.509 certificate support.  SILC protocol supports certificates and
 209    it would be great to have support for them.  This is a big task as
 210    support has to be made for ASN.1 as well.  I've looked into OpenSSL
 211    package as it has X.509 certificate support (and ASN.1 as well).
 212    The code does not look very good to my eye but it has some potentials.
 213    This should be looked at more closely.
 214
 215    Naturally own SILC Certificate API has to be defined regardles what
 216    the actual X.509 library is (OpenSSL X.509 or something else).  Other
 217    choice is to write own X.509 library but I'm not going to do it -
 218    I can help to migrate the OpenSSL X.509 into SILC and I can help if
 219    someone would like to write the X.509 library - but I'm not going
 220    to start writing one myself.  Anyhow, the OpenSSL X.509 lib should
 221    be checked.
 222
 223  o SSH2 public keys support.  Maybe - not really needed but could be
 224    nice as SSH is widely used all over the place.  SILC Protocol
 225    supports SSH2 public keys.
 226
 227  o Cipher optimizations (asm, that this) at least for i386 would be nice.