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