TODO

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