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