TODO

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