TODO

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