Merged from silc_1_0_branch.
[silc.git] / TODO
diff --git a/TODO b/TODO
index 63cf1306d7a31513fcfba6dac51f60bd084008d6..1d5f3a69a4ed8b2250c102941de176f167e1489e 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,95 +1,39 @@
-TODO/bugs in Irssi SILC client
+TODO for Irssi SILC Client 1.0
 ==============================
 
- o /cumode for unknown nick does not give any error message (Fix this to
-   1.0).
+ o Testing - See test plan:
+     http://silcnet.org/docs/silc-client-1.0-test.pdf
+     http://silcnet.org/docs/silc-client-1.0-test.ps
 
 
-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
-   (Do this to 1.0).
-
- 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.
-
-
-TODO/bugs In SILC Server
+TODO for SILC Server 1.0
 ========================
 
- o Configuration file additions (Do this to 0.8.x):
-
-       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 KILLED (check that killling is allowed (Protocol TODO #13))
-
- o Backup router related issues (Fix this to 1.0):
+ o Fix CUMODE_CHANGE and CMODE_CHANGE for founder key things.
 
-       o Channel user mode changes are notified unnecessarely when
-         switching to backup router on router crash.
+ o 1.2 backup router support
 
- 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
-   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 (Fix this to 1.0).
-
- 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
-   be taken from the public key.  Should be a configuration option!
+ o Testing
 
 
 TODO/bugs In SILC Libraries
 ===========================
 
- 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 (Fix this to 1.0).
+ o Test cases for all cryptographic primitive in lib/silccrypt/
+
+ o Test cases for all payload encoding and decoding routins in lib/silccore/
+
+ o Test cases for math library routines in lib/silcmath/
 
 
 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.
+Manual (Do these to 0.9.x).
 
- 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 Document the "notify" and "command_reply" client operations variable 
+   argument lists for all possible notify types and command replys.
 
  o Write "Programming with Toolkit" document, describing how to build
    Toolkit, how the build system works, where is everything, how
@@ -101,93 +45,5 @@ Manual (Do these to 0.9 and 1.0).
    Toolkit support, what has been implemented, what has not been, what
    works differently etc.
 
-
-TODO in SILC Protocol
-=====================
-
-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.
-
- 13. Add the killer's client ID to the KILLED notify.  To be included in 
-     protocol version 1.1.
-
- 14. The length of Arguments Num field in Notify Payload and Command
-     Payload enforces that total of 256 arguments can be associated
-     to a such payload.  However, command-xx draft specified much higher
-     values, and these should be fixed.
-
- 15. The LEAVE command reply should return the Channel ID of the channel
-     that was parted.
+ o Searching of predefined keywords, exact and partial matches (would be 
+   nice).