Merged Irssi 0.8.2 from irssi.org cvs.
[silc.git] / TODO
diff --git a/TODO b/TODO
index f8506a6d64ec3313bb340015f3d488c99ad4e841..d32f8bf141803cbe57d0ccbd530f13139a37fd1f 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,63 +1,65 @@
 TODO/bugs in Irssi SILC client
 ==============================
 
- o /NAMES kees showing things wrong after JOIN and after ppl has left
-   channel.
+ o Fix the silc_channels_join to parse the command like, with fe.
+   silc_parse_command_line, because currently it ignores all options,
+   including passphrase which makes autojoin impossible to +a channels.
+   Other important options are ignored too.
 
  o Add local command to switch the channel's private key when channel has
    several private keys.  Currently sending channel messages with many
    keys is not possible because changing the key is not possible by the
    user.
 
- o JOINing to +a (requires passphrase to JOIN) does not work on autojoin.
-   Seems the passwords in the .silc/config has no effect.
+ o /cumode for unknown nick does not give any error message.
 
- o Add local commands to list the current server and client public keys
-   that the user has.  And a local command to dump the contents of the
-   public key to the screen.  Something like LISTKEYS, SHOWKEY...
 
- o The JOIN command's HELP is generated from Irssi IRCs JOIN help and
-   the syntax is not same in SILC.  This must be fixed.  Most likely
-   we must forget the Irssi's JOIN command and mimic it to get our
-   required syntax for it too.
+TODO/bugs In SILC Client Library
+================================
 
- o We should get rid of the clientconfig.[ch] in Irssi SILC and move the
-   cipher, hash, hmac and pkcs configuration to the Irssi SILC's config
-   file.
+ o The PRIVATE_MESSAGE_KEY packet is not handled (it is implemented 
+   though).  This should be added and perhaps new client operation
+   should be added to notify application that it was received and
+   set the key only if application wishes to set (accept the key) it.
 
- o Add PERL scripting support from Irssi CVS.
+ o Additions to do after protocol version 1.1:
 
- o Extend the /HELP command to support sub commands or something.  So
-   that user can say /help set mutual_authentication they would get
-   help of the mutual_authentication setting.
+       o Fix the NICK_CHANGE notify handling not to create new entry
+         for the changed client, but take the nickname from the notify
+         (removes need for resolving as well).  Protocol TODO entry 3.
 
- o Set different kind of settings, like, /set mutual_authentication,
-   /set key_exchange_timeout, /set conn_auth_timeout etc etc.
+       o Add support for list of errors in command replies.  Protocol
+         TODO entry 1.
 
 
-TODO/bugs In SILC Client Library
-================================
+TODO/bugs In SILC Server
+========================
 
- o JOIN command's argument handling is buggy.  See the XXX in the code.
+ o Configuration file additions:
 
- o key agreement with itself causes the packet sequence numbers go grazy.
+       o Add support for multipe PublicKey params in connections 
+         sections.  For now, add this support only in Client and not
+         in ServerConnection nor RouterConnection.
 
+       o Add version handling, to allow, disallow certain versions to
+         connect.
 
-TODO/bugs In SILC Server
-========================
+       o Add incoming connection frequency, incoming connection frequency
+         for single IP address, key exchange frequency, key exchange
+         frequency for single IP. Add also frequency base.
 
- o After backup resume protocol the TOPIC_SET was not handled correctly
-   by all (unknown Channel ID).
+       o Add hashed passwords to config file.
 
- o Channel user mode changes are notified unnecessarely when switching
-   to backup router on router crash.
+       o Add rehashing support.
 
- o Change the server to connect to another server from low ports (706)
-   and not from high ports.  Currently we cannot do incoming connection
-   checking by remote port because the port is not fixed.
+ o If server send CUMODE_CHANGE notify (like setting founder) to router
+   and router does not have founder on channel (founder is left or there's
+   no founder on channel at all), the router will accept the server's
+   founder mode change, even though it perhaps should not do that.
 
- o Announcements are incomplete: channel topics are not announced,
-   user modes (UMODE) are not announced.
+ o The router should check for validity of received notify packets from
+   servers (after all buggy servers may send notify that is actually
+   something that should have not been sent).
 
  o Add a timeout to handling incoming JOIN commands.  It should be 
    enforced that JOIN command is executed only once in a second or two
@@ -66,131 +68,159 @@ TODO/bugs In SILC Server
    each JOIN command will create and distribute the new channel key
    to everybody on the channel.
 
- o Optimize the WHOIS and IDENTIFY commands to somehow check whether the
-   requested clients are on some channel that the server knows about.  If
-   this is the case then the request is not needed to be forwarded to the
-   router.  One specific optimization could be done with JOIN command.
-   If the previous command to the WHOIS and IDENTIFY commands are JOIN
-   command (from the client) it can be expected (though it must be
-   verified) that the client is resolving the users on the channel it just
-   joined.  If server has done this once there is really no reason to
-   resolve it twice (from the router), it can reply directly back with
-   the information it knows.  This is because the server would (will) 
-   receive notifications from the router for users that are on a local
-   channel.
-
-   The same is with whowas command.  Actually with all these commands
-   it should be checked also whether the requested information is local.
-   If it is, there is no reason to send it to the router, since the server
-   knows it best.
+ o Backup router related issues
 
- o Add support for sending the LIST command to primary router on normal
-   server to receive all the created channels.  Currently the command
-   returns only the channels the server knows about.  The protocol spec
-   does not prohibit of sending the LIST to the router.
+       o Channel user mode changes are notified unnecessarely when
+         switching to backup router on router crash.
 
- o Incomplete IPv6 support:
+ o Lots of statistics updating is missing around the server.
 
-       o silcd/serverid.c and its routines supports only IPv4.
-
- o New configuration file format must be added.  The new one will be
-   done using the dotconf config library (lib/dotconf).  The following
-   tasks relates closely to this as well and must be done at the same time
-   when adding the new config file format:
-
-       o Server says that it is able to listen on multiple ports but
-         currently that is bogus.  It can, but internals are for single
-         server.
-
-       o Protocol execution timeouts are hard coded, should be
-         configurable.
-
-       o IP address fields in configuration file should accept mask
-         format as well, IP/MASK, and not just plain IP.
-
-        o Connection classes should be actually implemented in
-         serverconfig.c.  They can be defined but they are totally
-         ignored currently.  And they should be redefined also.
+ o If client's public key is saved in the server (and doing public key
+   authentication) then the hostname and the username information could
+   be taken from the public key.  Should be a configuration option!
 
 
 TODO/bugs In SILC Libraries
 ===========================
 
- o Optimizations to lib/silcsftp
+ o Fix possible buffer overflows in silc_id_render function.
 
-       o Do not allocate new req for every client request.  Use
-         preallocated requests and recycle them.
+ o WIN32 silc_net_create_connection_async does not work the same way
+   than on Unix.  Do it with threads on WIN32.  The function works but
+   is not actually async currently.
 
-       o Use SilcList instead of SilcDList for requests.  It is faster.
+ o Rewrite the lib/silcsim/silcsim.h.  The SilcSimContext should be
+   private and silc_sim_alloc should take necessary arguments.
 
-       o Do not allocate new buffer for every packet.  Use preallocated
-         buffer and reallocate only if necessary.
+ o SILC RNG does not implement random seed files, and they should be
+   implemented.
 
- o Compression routines are missing.  The protocol supports packet
-   compression thus it must be implemented.  SILC Comp API must be
-   defined.  zlib package is already included into the lib dir (in CVS,
-   not in distribution), but it is not used yet, and it requires some
-   tweaking on the Makefiles (we want static lib not shared).
+ o The SilcSocketConnection in the SFTP interface is actually redundant
+   and should perhaps be removed.  The application can save it in the
+   context it provides, which is delivered by SFTP libary to all 
+   callback functions.
 
- o All payload parsing (decoding) functions should take unsigned char *
-   and uint32 as data and data length as arguments.  Now some of the
-   routines do already that but most of the routines use SilcBuffer.
-   The SilcBuffer ones should be removed since buf->data and buf->len
-   is more convenient to use.  These are currently only cosmetic changes
-   but at some point must be done to make the payload interfaces
-   consistent.
+ o EPOC specific additions/changes required:
 
- o Incomplete IPv6 support:
+       o lib/silcutil/epoc routines missing or not completed.
 
-       o All network routines in lib/silcutil/silcnet.[ch] does not
-         support IPv6.
-       o silc_id_render supports only IPv4 based ID's in the file
-         lib/silcutil/silcutil.c.
+       o Rewrite the lib/silcutil/silcprotocol.[ch] not to have 
+         [un]register functions, but to make it context based all the 
+         way.  The alloc should take as argument the protocol type and 
+         its callback (not only final callback).  It is not good that we 
+         have now global list of registered protocols.
 
- o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
-   SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
-   in separately.
+       o Global RNG should not be allowed on EPOC, since it won't
+         work.  Every function in library that calls the global RNG must
+         also take the RNG context as argument so that application can
+         provide it if it doesn't want to use global RNG.
 
+       o Think some solution to the global crypto lists in lib/silccrypt.
+         They won't work on EPOC.
 
-TODO/Bugs in native WIN32 support (libraries)
-=============================================
+       o Something needs to be thought to the logging globals as well, 
+         like silc_debug etc.  They won't work on EPOC.  Perhaps logging
+         and debugging is to be disabled on EPOC.
 
- o silc_net_create_connection_async does not work the same way than on
-   Unix.  Do it with threads on WIN32.  The function works but is not
-   actually async currently.
 
+TODO in Toolkit Documentation
+=============================
 
-TODO In SILC Protocol
-=====================
-
- o If channel founder mode is set and the invite mode is set on channel
-   then the founder should be added to the list automatically so that
-   if the founder signoff's it will be able join again to the invite only
-   channel wihtout being invited.
+Stuff that needs to be done in order to complete the Tooolkit Reference
+Manual.
 
+ o Lots of ROBOdoc header formatting is undone in lib/silcutil, and 
+   lib/silccrypt.
 
-TODO After 1.0
-==============
+ o Write "Programming with Toolkit" document, describing how to build
+   Toolkit, how the build system works, where is everything, how
+   new (external) projects can be glued into Toolkit (use irssi as an
+   example), and how external projects can use Toolkit without gluing into
+   it (how to link etc), debugging, architecture, types, etc.
 
- o X.509 certificate support.  SILC protocol supports certificates and
-   it would be great to have support for them.  This is a big task as
-   support has to be made for ASN.1 as well.  I've looked into OpenSSL 
-   package as it has X.509 certificate support (and ASN.1 as well).  
-   The code does not look very good to my eye but it has some potentials.
-   This should be looked at more closely.
+ o Write "Platform Implementations" document to describe what platforms
+   Toolkit support, what has been implemented, what has not been, what
+   wors differently etc.
 
-   Naturally own SILC Certificate API has to be defined regardles what
-   the actual X.509 library is (OpenSSL X.509 or something else).  Other
-   choice is to write own X.509 library but I'm not going to do it - 
-   I can help to migrate the OpenSSL X.509 into SILC and I can help if 
-   someone would like to write the X.509 library - but I'm not going 
-   to start writing one myself.  Anyhow, the OpenSSL X.509 lib should
-   be checked.
 
-   Other package that should be checked is the NSS's X509 library.
-
- o SSH2 public keys support.  Maybe - not really needed but could be
-   nice as SSH is widely used all over the place.  SILC Protocol 
-   supports SSH2 public keys.
+TODO in SILC Protocol
+=====================
 
- o Cipher optimizations (asm, that this) at least for i386 would be nice.
+Current protocol version is 1.0.  However, it is far from being perfect,
+and needs to include additional features.  Following protocol TODO entries
+describe new stuff to be added to protocol versions 1.x.
+
+ 1. Re-define the Status Payload: it is now 16 bits, split it into two
+    8 bits fields.  First field includes status types from 0 - 9 and
+    10 - n *if* it is not an list of errors.  If it is list of errors then
+    the first field includes 1, 2 and/or 3, and the second field includes
+    the error status 10 - n.  This way it is possible to send multiple
+    errors (list of errors) and we have a way to tell the receiver that
+    there will be other errors as well.  The second field is used only
+    if there is list of errors.  If normal status, or normal (single)
+    error status the second field is set to zero, and must be ignored.
+    Hence, the status works same way as now except for list of errors.
+    To be included in protocol version 1.1.
+
+ 2. Define that WHOIS and IDENTIFY commands must send list of errors
+    if multiple Client ID (or Channel ID and Server ID for IDENTIFY) was
+    requested and was not found.  Each unfound entry must cause an error
+    command reply to the sender.  Also define that errors must be sent
+    *after* sending successfully found entries (this way receiver may
+    ignore them).  To be included in protocol version 1.1.
+
+ 3. Define the NICK_CHANGE notify to send the changed nickname as a new
+    third argument.  This will make the NICK_CHANGE notify handling easier
+    in the receiver's end (client primarily) since it removes the
+    requirement that receiver must resolve (using IDENTIFY or WHOIS) the
+    new Client ID received in the notify (because of the new nickname is
+    unknown).  To be included in protocol version 1.1.
+
+ 4. Add "request parameters" or similar to the WHOIS command, which can
+    be used to request various parameters (something not returned by
+    standard WHOIS command) about clients (info that could be fetched
+    even from clients).  Additional specification (or appendix) should 
+    be done to define the payload and the parameters.  It could be used
+    to make the WHOIS command support various search conditions as well.
+    This would be the way to extend the WHOIS command to support various
+    new features without always making the command incompatible to previous
+    version.  To be included in protocol version 1.1.
+
+ 5. Inviting and banning by public key should be made possible.  To be
+    included in protocol version 1.x.
+
+ 6. Add perhaps SILENCE_USERS, SILENCE_OPERS channel user modes which
+    can be used to silence (moderate) normal users and opers (this set
+    only by founder).  To be included in protocol version 1.1.
+
+ 7. Channel Message Payload needs slight redesining to include the IV
+    field to the MAC generation of the payload.  It is authenticated
+    by the packet's MAC but not by the payload's MAC.  Since the IV
+    belongs to the payload, its integrity should be protected by the
+    payload MAC and not alone by packet MAC.  To be included in protocol 
+    version 1.1.
+
+ 8. Remove the administrative commands from the protocol all together.
+    It does not make sense for the protocol to define how a server is
+    reconnected or shutdown, since they are implementation and 
+    configuration issues.  Besides protocol provides only limited set of
+    administrative commands and cannot define all that one could imagine.
+    To be included in protocol version 1.1.
+
+ 9. Add SILC_MESAGE_FLAG_REPLY for being other side to the
+    SILC_MESSAGE_FLAG_REQUEST.  Add generic SILC_MESSAGE_FLAG_DATA, which
+    can include generic payload, which can include generic data.  The
+    payload definition is left out for now.  To be included in protocol
+    version 1.1.
+
+ 10. Check command reply error status types in various commands,
+     specifically NO_FOPRIV is missing from many commands.  To be 
+     included in protocol version 1.1.
+
+ 11. Change the wording in Private Message Key Payload definition to
+     describe the problems of trusting the payload, and to indicate that
+     the receiver may not accept the key in the payload, and to describe
+     other means of distributing a key.
+
+ 12. The router to router connection diagram in spec-xx is showing the
+     primary routers direction to wrong direction.  Swap it.