TODO

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