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 TODO in command.c and in command_reply.c:
 104
 105         o RESTART is not implemented
 106         o INVITE is probably not working correctly
 107         o JOIN does not check the invite and ban lists
 108         o CMODE should be rewritten as it uses a lot duplicated code.
 109           Some of the modes may still not be implemented or is implemented
 110           the wrong way.  Also, setting ban and invite lists does not
 111           work at all and requires some thinking how to do them.
 112         o In servers all command reply funtions should still call the
 113           pending command reply even if the reply was error.  In client
 114           it is not called but in server, I think, it must be called.
 115           When implementing this check that all commands handle the
 116           situation correctly when it is called as pending command
 117           (it should most likely check that cmd->pending == TRUE/FALSE).
 118
 119  o Packet processing can be made faster. All packet function in the
 120    packet_receive.c has same prototypes.  Instead of calling those from
 121    huge switch() make a table of callback functions that can be called
 122    directly by the packet type.
 123
 124  o DNS/IP lookup blocks the server.  This must be fixed.  Check the
 125    resolver stuff (resolver(3), resolver(5)).  Either we have to do the
 126    own resolver stuff (through scheduler, if possible without writing
 127    too much own stuff) or use threads.
 128
 129  o Acceptance of incoming connections (client and server connections)
 130    should be checked before key exchange protocol.  Currently it is
 131    checked at the authentication phase after KE, that is ok, but it should
 132    be checked before starting KE, as well.
 133
 134  o Server says that it is able to listen on multiple ports but currently
 135    that is bogus.  It can, but internals are for single server.
 136
 137  o Protocol execution timeouts are hard coded, should be configurable.
 138
 139  o IP address fields in configuration file should accept mask format
 140    as well, IP/MASK, and not just plain IP.
 141
 142  o Connection classes should be actually implemented in serverconfig.c.
 143    They can be defined but they are totally ignored currently.
 144
 145
 146 TODO In SILC Libraries
 147 ======================
 148
 149  o Rewrite the task system.  I made it too complex and too "neat" and
 150    it really should be rewritten.  We don't need priorities really, one
 151    priority is enough.  This will simplify a lot the task system.
 152
 153  o Implement PFS (Perfect Forward Secrecy) flag in SKE (and in client and
 154    server, actually).  If PFS is set, re-key must cause new key exchange.
 155    This is required by the SILC protocol.
 156
 157  o Re-key in general is actually missing (from everywhere) and must be done.
 158
 159  o ID Cache expiry does not work.
 160
 161  o Compression routines are missing.  The protocol supports packet
 162    compression thus it must be implemented.  SILC Comp API must be
 163    defined.  zlib package is already included into the lib dir (in CVS,
 164    not in distribution), but it is not used yet, and it requires some
 165    tweaking on the Makefiles (we want static lib not shared).
 166
 167  o SIM support for SILC PKCS API needs to made so that they could be
 168    used as SIM's.  At the same time some work is required on prime
 169    generation as the way it is done now sucks.  Read from code for
 170    more (silcpkcs.h).
 171
 172  o Random Number Generator needs some tweaking.  Reading /dev/random may
 173    block resulting slow initialization of RNG.  Some other things in the
 174    RNG may block as well.  Also, I have some pending changes to the RNG
 175    that needs to be commited (from Schneier's Yarrow-160 paper).  They
 176    should make the RNG even better.
 177
 178  o Scheduler needs to be analyzed on high load as it might be unfair
 179    towards select() because it may run timeout tasks before select() and
 180    after select().  If it is found to be unfair the timeout task running
 181    before select() should probably be removed.
 182
 183
 184 Other Things TODO
 185 =================
 186
 187  o Write manuals for server.
 188
 189  o Write manuals for client.
 190
 191  o Write SILC Library Reference manual.  This would include all the SILC
 192    API's with simple examples how the functions are to be used.  This is
 193    pretty easy to create by taking all the functions plus their comments
 194    from source/header files.  However, same sort of reference manual
 195    should be written for client and server as well.
 196
 197
 198 TODO After 1.0
 199 ==============
 200
 201  o Pthreads support.  A lot of problems are solved with server (and with
 202    client as well) if we add pthread support.  We can forget things such
 203    as non-blocking connecting etc, and we can do things such as DNS/IP
 204    lookups async.  The server itself also benefits great deal from
 205    threads, especially from performance point of view.
 206
 207    But, this is not a small task and almost entire SILC Library has to
 208    be made re-entrant.  Own API is probably added for the threads support
 209    to make changes in the future as painless as possible.  So the API
 210    would have things like silc_mutex_lock, silc_mutex_unlock and
 211    friends...
 212
 213  o X.509 certificate support.  SILC protocol supports certificates and
 214    it would be great to have support for them.  This is a big task as
 215    support has to be made for ASN.1 as well.  I've looked into OpenSSL
 216    package as it has X.509 certificate support (and ASN.1 as well).
 217    The code does not look very good to my eye but it has some potentials.
 218    This should be looked at more closely.
 219
 220    Naturally own SILC Certificate API has to be defined regardles what
 221    the actual X.509 library is (OpenSSL X.509 or something else).  Other
 222    choice is to write own X.509 library but I'm not going to do it -
 223    I can help to migrate the OpenSSL X.509 into SILC and I can help if
 224    someone would like to write the X.509 library - but I'm not going
 225    to start writing one myself.  Anyhow, the OpenSSL X.509 lib should
 226    be checked.
 227
 228  o SSH2 public keys support.  Maybe - not really needed but could be
 229    nice as SSH is widely used all over the place.  SILC Protocol
 230    supports SSH2 public keys.
 231
 232  o Cipher optimizations (asm, that this) at least for i386 would be nice.