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