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