updates.
[silc.git] / TODO
diff --git a/TODO b/TODO
index 7184c05e2683d4ef31aad629b8b10811e3a4cb71..afa8ad7445eb2783a697ae0979c0098f038b241b 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,34 +1,8 @@
 TODO/bugs in Irssi SILC client
 ==============================
 
- 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 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 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 Add auto-nick support to Irssi, so that the user specified nickname
-   would be sent to the server immediately (automatically) after the
-   client is connected to the server.
-
- o Add PERL scripting support from Irssi CVS.
-
- 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 Set different kind of settings, like, /set mutual_authentication,
-   /set key_exchange_timeout, /set conn_auth_timeout etc etc.
+ o /cumode for unknown nick does not give any error message (Fix this to
+   1.0).
 
 
 TODO/bugs In SILC Client Library
@@ -37,26 +11,13 @@ TODO/bugs In SILC Client Library
  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 should /nick nick and /nick Nick cause the Nick to be Nick@host becase
-   it used to be nick??
+   set the key only if application wishes to set (accept the key) it
+   (Do this to 1.0).
 
- o When changing own nickname and there exists a same nickname the library
-   can give the client now nickname in format nick@host.  This is new
-   behaviour and maybe should be removed.  The changer should always
-   get the one it wants and not have the formatted nickname.
-
- o Remove the command destructor all together from the client, it is
-   not needed and its usage is buggy when the context is registered
-   to multiple pending commands.
+ o Remove conn->current_channel.
 
  o Additions to do after protocol version 1.1:
 
-       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 Add support for list of errors in command replies.  Protocol
          TODO entry 1.
 
@@ -64,9 +25,25 @@ TODO/bugs In SILC Client Library
 TODO/bugs In SILC Server
 ========================
 
- o strerror messages from premature EOF's to signoff messages.
+ o Configuration file additions (Do this to 0.8.x):
 
- o Backup router related issues
+       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 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 (Fix 
+   this to 0.9).
+
+ o The router should check for validity of received notify packets from
+   routers (fix this to 0.9).  Following NOTIFYs needs to be verified:
+
+       o JOIN (check that joining is allowed)
+       o SIGNOFF (maybe should check that notifier owns the client)
+
+ o Backup router related issues (Fix this to 1.0):
 
        o Channel user mode changes are notified unnecessarely when
          switching to backup router on router crash.
@@ -76,22 +53,9 @@ TODO/bugs In SILC Server
    seconds.  Now it is possible to accept n incoming JOIN commands
    and process them without any timeouts.  THis must be employed because
    each JOIN command will create and distribute the new channel key
-   to everybody on the channel.
-
- 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:
+   to everybody on the channel (Fix this to 1.0).
 
-       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 Lots of statistics updating is missing around the server.
 
  o If client's public key is saved in the server (and doing public key
    authentication) then the hostname and the username information could
@@ -101,15 +65,38 @@ TODO/bugs In SILC Server
 TODO/bugs In SILC Libraries
 ===========================
 
- o make install copies the symblic links from lib/silcsim/ and not
-   modules.
-
  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.
+   is not actually async currently (Fix this to 1.0).
+
 
- o Rewrite the lib/silcsim/silcsim.h.  The SilcSimContext should be
-   private and silc_sim_alloc should take necessary arguments.
+TODO in Toolkit Documentation
+=============================
+
+Stuff that needs to be done in order to complete the Tooolkit Reference
+Manual (Do these to 0.9 and 1.0).
+
+ o ROBOdoc documenting missing from lib/silcutil/silcbuffer.h.
+
+ o ROBOdoc documenting missing from lib/silcutil/silcdlist.h.
+
+ o ROBOdoc documenting missing from lib/silcutil/silcfileutil.h.
+
+ o ROBOdoc documenting missing from lib/silccrypt/silchash.h.
+
+ o ROBOdoc documenting missing from lib/silccrypt/silccipher.h.
+
+ o ROBOdoc documenting missing from lib/silccrypt/silcpkcs.h.
+
+ 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 Write "Platform Implementations" document to describe what platforms
+   Toolkit support, what has been implemented, what has not been, what
+   works differently etc.
 
 
 TODO in SILC Protocol
@@ -119,18 +106,6 @@ 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
@@ -138,13 +113,6 @@ describe new stuff to be added to protocol versions 1.x.
     *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
@@ -155,50 +123,23 @@ describe new stuff to be added to protocol versions 1.x.
     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.
-
-
-TODO After 1.0
-==============
-
- o Compression routines are missing.  The protocol supports packet
-   compression thus it must be implemented.  SILC Zip 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 Implement the defined SilcDH API.  The definition is in
-   lib/silccrypt/silcdh.h.
-
- 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 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.
-
-   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.
+ 17. Cell wide channel founder support, and permanent channels when
+     founder mode set.
 
-   Other package that should be checked is the NSS's X509 library,
-   which I like more over OpenSSL package.
+ 20. Services support?
 
- o SSH2 public keys support.
+ 21. Subscription/IRC's notify kind support?
 
- o OpenPGP certificate support.
+ o Inviting and banning by public key should be made possible.  To be
+   included in protocol version 1.2.
 
- o Cipher optimizations (asm, that this) at least for i386 would be nice.
+ o UTF-8 support/requirement for nicknames & channel names.  UTF-8 support
+   in terminals and OS's are so hazy that this matter is left for
+   consideration in next version of the protocol (1.2).  For good UTF-8
+   reference and tutorial see: http://www.cl.cam.ac.uk/~mgk25/unicode.html.
+   What should CLI application do if it receives nickname that it cannot
+   display without messing up the terminal?  If UTF-8 is mandatory in
+   SILC then SILC clients cannot be allowed to start on terminals that do
+   not support UTF-8 (which renders 98% of users unable to use CLI SILC
+   app without hacking their environment).  See also site
+   http://gratrix.net/unicode/