TODO

   1 TODO/bugs in Irssi SILC client
   2 ==============================
   3
   4  o Add local command to switch the channel's private key when channel has
   5    several private keys.  Currently sending channel messages with many
   6    keys is not possible because changing the key is not possible by the
   7    user.
   8
   9  o JOINing to +a (requires passphrase to JOIN) does not work on autojoin.
  10    Seems the passwords in the .silc/config has no effect.
  11
  12  o Add local commands to list the current server and client public keys
  13    that the user has.  And a local command to dump the contents of the
  14    public key to the screen.  Something like LISTKEYS, SHOWKEY...
  15
  16  o We should get rid of the clientconfig.[ch] in Irssi SILC and move the
  17    cipher, hash, hmac and pkcs configuration to the Irssi SILC's config
  18    file.
  19
  20  o Add PERL scripting support from Irssi CVS.
  21
  22  o Extend the /HELP command to support sub commands or something.  So
  23    that user can say /help set mutual_authentication they would get
  24    help of the mutual_authentication setting.
  25
  26  o Set different kind of settings, like, /set mutual_authentication,
  27    /set key_exchange_timeout, /set conn_auth_timeout etc etc.
  28
  29
  30 TODO/bugs In SILC Client Library
  31 ================================
  32
  33  o Rewrite the channel's user list thingy and cross list it to the
  34    Client entry.
  35
  36  o The PRIVATE_MESSAGE_KEY packet is not handled (it is implemented
  37    though).  This should be added and perhaps new client operation
  38    should be added to notify application that it was received and
  39    set the key only if application wishes to set (accept the key) it.
  40
  41  o Additions to do after protocol version 1.1:
  42
  43         o Fix the NICK_CHANGE notify handling not to create new entry
  44           for the changed client, but take the nickname from the notify
  45           (removes need for resolving as well).  Protocol TODO entry 3.
  46
  47         o Add support for list of errors in command replies.  Protocol
  48           TODO entry 1.
  49
  50
  51 TODO/bugs In SILC Server
  52 ========================
  53
  54  o Make the normal server save user counts with LIST command reply.
  55
  56  o The router should check for validity of received notify packets from
  57    servers (after all buggy servers may send notify that is actually
  58    something that should have not been sent).
  59
  60  o Add hashed passwords to silcd.conf file.
  61
  62  o Backup router related issues
  63
  64         o Channel user mode changes are notified unnecessarely when
  65           switching to backup router on router crash.
  66
  67  o Add a timeout to handling incoming JOIN commands.  It should be
  68    enforced that JOIN command is executed only once in a second or two
  69    seconds.  Now it is possible to accept n incoming JOIN commands
  70    and process them without any timeouts.  THis must be employed because
  71    each JOIN command will create and distribute the new channel key
  72    to everybody on the channel.
  73
  74  o New configuration file format must be added.  The following
  75    tasks relates closely to this as well and must be done at the same time
  76    when adding the new config file format:
  77
  78         o Server says that it is able to listen on multiple ports but
  79           currently that is bogus.  It can, but internals are for single
  80           server.
  81
  82         o Protocol execution timeouts are hard coded, should be
  83           configurable.
  84
  85         o IP address fields in configuration file should accept mask
  86           format as well, IP/MASK, and not just plain IP.
  87
  88  o Lots of statistics updating is missing around the server.
  89
  90  o If client's public key is saved in the server (and doing public key
  91    authentication) then the hostname and the username information could
  92    be taken from the public key.  Should be a configuration option!
  93
  94
  95 TODO/bugs In SILC Libraries
  96 ===========================
  97
  98  o WIN32 silc_net_create_connection_async does not work the same way
  99    than on Unix.  Do it with threads on WIN32.  The function works but
 100    is not actually async currently.
 101
 102  o Rewrite the lib/silcsim/silcsim.h.  The SilcSimContext should be
 103    private and silc_sim_alloc should take necessary arguments.
 104
 105
 106 TODO in SILC Protocol
 107 =====================
 108
 109 Current protocol version is 1.0.  However, it is far from being perfect,
 110 and needs to include additional features.  Following protocol TODO entries
 111 describe new stuff to be added to protocol versions 1.x.
 112
 113  1. Re-define the Status Payload: it is now 16 bits, split it into two
 114     8 bits fields.  First field includes status types from 0 - 9 and
 115     10 - n *if* it is not an list of errors.  If it is list of errors then
 116     the first field includes 1, 2 and/or 3, and the second field includes
 117     the error status 10 - n.  This way it is possible to send multiple
 118     errors (list of errors) and we have a way to tell the receiver that
 119     there will be other errors as well.  The second field is used only
 120     if there is list of errors.  If normal status, or normal (single)
 121     error status the second field is set to zero, and must be ignored.
 122     Hence, the status works same way as now except for list of errors.
 123     To be included in protocol version 1.1.
 124
 125  2. Define that WHOIS and IDENTIFY commands must send list of errors
 126     if multiple Client ID (or Channel ID and Server ID for IDENTIFY) was
 127     requested and was not found.  Each unfound entry must cause an error
 128     command reply to the sender.  Also define that errors must be sent
 129     *after* sending successfully found entries (this way receiver may
 130     ignore them).  To be included in protocol version 1.1.
 131
 132  3. Define the NICK_CHANGE notify to send the changed nickname as a new
 133     third argument.  This will make the NICK_CHANGE notify handling easier
 134     in the receiver's end (client primarily) since it removes the
 135     requirement that receiver must resolve (using IDENTIFY or WHOIS) the
 136     new Client ID received in the notify (because of the new nickname is
 137     unknown).  To be included in protocol version 1.1.
 138
 139  4. Add "request parameters" or similar to the WHOIS command, which can
 140     be used to request various parameters (something not returned by
 141     standard WHOIS command) about clients (info that could be fetched
 142     even from clients).  Additional specification (or appendix) should
 143     be done to define the payload and the parameters.  It could be used
 144     to make the WHOIS command support various search conditions as well.
 145     This would be the way to extend the WHOIS command to support various
 146     new features without always making the command incompatible to previous
 147     version.  To be included in protocol version 1.1.
 148
 149  5. Inviting and banning by public key should be made possible.  To be
 150     included in protocol version 1.x.
 151
 152  6. Add perhaps SILENCE_USERS, SILENCE_OPERS channel user modes which
 153     can be used to silence (moderate) normal users and opers (this set
 154     only by founder).  To be included in protocol version 1.1.
 155
 156  7. Channel Message Payload needs slight redesining to include the IV
 157     field to the MAC generation of the payload.  It is authenticated
 158     by the packet's MAC but not by the payload's MAC.  Since the IV
 159     belongs to the payload, its integrity should be protected by the
 160     payload MAC and not alone by packet MAC.  To be included in protocol
 161     version 1.1.
 162
 163  8. Remove the administrative commands from the protocol all together.
 164     It does not make sense for the protocol to define how a server is
 165     reconnected or shutdown, since they are implementation and
 166     configuration issues.  Besides protocol provides only limited set of
 167     administrative commands and cannot define all that one could imagine.
 168     To be included in protocol version 1.1.
 169
 170  9. Add SILC_MESAGE_FLAG_REPLY for being other side to the
 171     SILC_MESSAGE_FLAG_REQUEST.  Add generic SILC_MESSAGE_FLAG_DATA, which
 172     can include generic payload, which can include generic data.  The
 173     payload definition is left out for now.  To be included in protocol
 174     version 1.1.
 175
 176  10. Check command reply error status types in various commands,
 177      specifically NO_FOPRIV is missing from many commands.  To be
 178      included in protocol version 1.1.
 179
 180
 181 TODO After 1.0
 182 ==============
 183
 184 A rough list of stuff that is going to be done to SILC after 1.0 or at
 185 least could be done.
 186
 187  o Implement the defined SilcDH API.  The definition is in
 188    lib/silccrypt/silcdh.h.
 189
 190  o X.509 certificate support.  SILC protocol supports certificates and
 191    it would be great to have support for them.  This is a big task as
 192    support has to be made for ASN.1 as well.  I've looked into OpenSSL
 193    package as it has X.509 certificate support (and ASN.1 as well).
 194    The code does not look very good to my eye but it has some potentials.
 195    This should be looked at more closely.
 196
 197    Naturally own SILC Certificate API has to be defined regardles what
 198    the actual X.509 library is (OpenSSL X.509 or something else).  Other
 199    choice is to write own X.509 library but I'm not going to do it -
 200    I can help to migrate the OpenSSL X.509 into SILC and I can help if
 201    someone would like to write the X.509 library - but I'm not going
 202    to start writing one myself.  Anyhow, the OpenSSL X.509 lib should
 203    be checked.
 204
 205    Other package that should be checked is the NSS's X509 library,
 206    which I like more over OpenSSL package.
 207
 208  o SSH2 public keys support, allowing the use of SSH2 public keys in
 209    SILC.
 210
 211  o OpenPGP certificate support, allowing the use of PGP public keys
 212    in SILC.
 213
 214  o Compression routines are missing.  The protocol supports packet
 215    compression thus it must be implemented.  SILC Zip API must be
 216    defined.
 217
 218  o Rewrite the lib/silcutil/silcprotocol.[ch] not to have [un]register
 219    functions, but to make it context based all the way.  The alloc should
 220    take as argument the protocol type and its callback (not only
 221    final callback).  It is not good that we have now global list of
 222    registered protocols.
 223
 224  o Optimizations in Libraries
 225
 226         o There is currently three (3) allocations per packet in the
 227           silc_packet_receive_process, which is used to process and
 228           dispatch all packets in the packet queue to the parser callback
 229           function.  First allocation is for parse_ctx, second for the
 230           SilcPacketContext, and third for packet->buffer where the actual
 231           data is saved.
 232
 233           The parse_ctx allocation can be removed by adding it as a
 234           structure to the SilcPacketContext.  When the SilcPacketContext
 235           is allocated there is space for the parse context already.
 236
 237           The silc_packet_context_alloc could have a free list of
 238           packet contexts.  If free packet context is found from the list
 239           it is returned instead of allocating a new one.  The library
 240           could at first allocate them and save them to the free list
 241           until enough contexts for smooth processing exists in the list.
 242           This would remove a big allocation since the structure is
 243           quite big, and even bigger if it would include the parse_ctx.
 244
 245           The packet->buffer can be optimized too if the SilcBuffer
 246           interface would support free lists as well.  Maybe such could
 247           be done in the same way as for SilcPacketContext.  The
 248           silc_buffer_alloc would check free list before actually
 249           allocating new memory.  Since the packets in the SILC protocol
 250           usually are about the same size (due to padding) it would be
 251           easy to find suitable size buffer from the free list very
 252           quickly.
 253
 254           These naturally cause the overal memory consumption to grow
 255           but would take away many allocations that can be done several
 256           times in a second.
 257
 258         o Move the actual file descriptor task callback (the callback that
 259           handles the incoming data, outgoing data etc, that is implemnted
 260           in server and client separately (silc_server_packet_process and
 261           silc_client_packet_proces)) to the low level socket connection
 262           handling routines, and create an interface where the application
 263           can register a callbacks for incoming data, outoing data and EOF
 264           receiving, which the library will call when necessary.  This way
 265           we can move the data handling in one place.
 266
 267         o Add silc_id_str2id to accept the destination buffer as argument
 268           and thus not require any memory allocation.  Same will happen
 269           with silc_id_payload_* functions.
 270
 271         o Remove the `truelen' field from SilcBuffer as it is entirely
 272           redundant since we can get the true length of the buffer by
 273           doing buffer->end - buffer->header.  Add SILC_BUFFER_TRUELEN
 274           macro instead.  Consider also removing `len' field too since
 275           it effectively is buffer->tail - buffer->data, and adding
 276           SILC_BUFFER_LEN macro can do the same.  These would save
 277           totally 8 bytes of memory per buffer.
 278
 279           Add also perhaps function silc_buffer_alloc_size that would
 280           effectively do:
 281
 282                 return silc_buffer_pull_tail(silc_buffer_alloc(size),
 283                                              size);
 284
 285           to not require the user to give the pull_tail anymore.
 286
 287  o Optimizations in Server
 288
 289         o Remove the big switch statement from the function
 290           silc_server_packet_parse_type and replace it with predefined
 291           table of function pointers where each of the slot in table
 292           represents the packet type value.
 293
 294           Same could be done with notify packets which has big switch
 295           statement too.  Same kind of table of notify callbacks could be
 296           done as well.
 297
 298         o The parser callback in the server will add a timeout task for
 299           all packets.  It will require registering and allocating a
 300           new task to the SilcSchedule.  Maybe, at least, for server
 301           and router packets the parser would be called immediately
 302           instead of adding it to the scheduler with 0 timeout.  It
 303           should be analyzed too how slow the task registering process
 304           actually is, and find out ways to optimize it.
 305
 306         o The SERVER_SIGNOFF notify handing is not optimal, because it'll
 307           cause sending of multiple SIGNOFF notify's instead of the one
 308           SERVER_SIGNOFF notify that the server received.  This should be
 309           optimized so that the only SERVER_SIGNOFF is sent and not
 310           SIGNOFF of notify at all (using SIGNOFF takes the idea about
 311           SERVER_SIGNOFF away entirely).
 312
 313  o Add SilcAsyncOperation to utility library.  Any function that takes
 314    callback as an argument must return SilcAsyncOperation.
 315
 316  o Cipher optimizations (asm, that this) at least for i386 would be nice.
 317
 318  o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
 319    SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
 320    in separately.