Added preliminary Symbian support.
[silc.git] / TODO
diff --git a/TODO b/TODO
index 6e39a0ab897f3472f6ad2dc7489be16d79e90f0b..22cd60b3f0725088099f86761ffd4b8618db7d81 100644 (file)
--- a/TODO
+++ b/TODO
 TODO for 1.1 And Beyond
 =======================
 
-lib/silccrypt
-=============
+NOTE: Any item that doesn't have (***DONE) in it, isn't done yet.  The
+(***TESTING NEEDED) means that the item has been done but not yet properly
+tested.
 
- o Implement the defined SilcDH API.  The definition is in
-   lib/silccrypt/silcdh.h.
 
- o SSH2 public keys support, allowing the use of SSH2 public keys in
-   SILC.
+SILC Client    ****PARTLY DONE****
+===========
 
- o OpenPGP certificate support, allowing the use of PGP public keys
-   in SILC.
+ o Porting to new Toolkit API and new Client Library API
 
- o SILC PKCS (silcpkcs.h) reorganizing when other PK supports added.
-   Move the SILC Public Key routines away from the crypto library into
-   the core library (silccore).  silc_pkcs_public/private_key_* routines
-   to silc_public/private_key_* routines.  The silc_public_key_* routines
-   should also automatically handle SILC Public Keys, and other keys
-   and certificates as well.  Add fe. silcpk.h into silccore.  It should
-   also include the Public Key Payload encoding and decoding routines.
+ o Improve help files, especially /cmode, /cumode and /key.
 
- o Add DSS support.
 
- o Cipher optimizations (asm, that this) at least for i386 would be nice.
+lib/silcclient, The Client Library     ***PARTLY DONE****
+==================================
+
+ o silcclient.h clean up and API rewrites.
 
- o ECDSA and ECDH.
+ o silcclient_entry.h finishing, all entry relates APIs to this header.
+
+ o SilcChannelEntry, SilcServerEntry, SilcChannelUser, allocating, 
+   freeing, finding, etc. rewrite.  Also making them reference counted for 
+   multi threads use. (***DONE)
+
+ o Finish all the missing SILC packet processings, rewrites.
+
+ o The client_notify.c rewrite. (***TESTING NEEDED)
+
+ o Resuming to client_register.c (remove client_resume.c)
+   (***TESTING NEEDED)
+
+ o Rekey rewrite. (***DONE)
+
+ o Remove protocol.[ch]. (***DONE)
+
+ o File transfer rewrite.
+
+ o Starting key exchange directly, rewrite. (***DONE)
+
+ o Channel messages, channel private keys, channel entires, channel 
+   search, etc. rewrite.
+
+ o For many APIs leave the hash context allocations to the caller instead
+   of using client->sha1hash and client->md5hash, or some kind of thread
+   safe (no locking) concept.
+
+ o Password auth test, public key auth test.
+
+ o Key agreement rewrite. (***TESTING NEEDED)
+
+ o Connecting to remote client (***DONE)
+
+ o peer-to-peer private messages
+
+ o Private message waiting API (in threads)
+
+ o client_attrs.c, attributes rewrite. (***TESTING NEEDED)
+
+ o No SilcBuffer lists back to application in command_reply operations.
+   Convert them all to real lists and/or structures for easier use.
+   (***DONE)
+
+ o Nickname formatting rewrite. (***TESTING NEEDED)
+
+ o UDP connections. (***TESTING NEEDED)
+
+ o in /cmode and /cumode with +r, maybe the public key and private key
+   could be just some "string", which would then match to "string.pub" and
+   "string.prv".
+
+ o All packet waiting timeout tests and error condition tests.
+
+
+lib/silcsftp
+============
+
+ o Porting to use the new util library.
 
 
 lib/silccore/silcpacket.[ch]   ****DONE****
 ============================
 
- o SilcPacketEngine.
+ o SilcPacketEngine. (***DONE)
 
- o New SILC Packet API.
+ o New SILC Packet API. (***DONE)
 
 
-lib/silccore/silcpacket.[ch]
+lib/silccore/silcpacket.[ch]   ****PARTLY DONE****
 ============================
 
- o IV Included flag support, UDP transport support
+ o IV Included flag support, UDP transport support (***TESTING NEEDED)
 
 
 lib/silccore/silcid.[ch]       ****DONE****
 ========================
 
 o Add silc_id_str2id to accept the destination buffer as argument
-    and thus not require any memory allocation.  Same will happen
-    with silc_id_payload_* functions.
+ o Add silc_id_str2id to accept the destination buffer as argument
+   and thus not require any memory allocation.  Same will happen
+   with silc_id_payload_* functions. (***DONE)
 
-  o silc_id_str2id, silc_id2str to non-allocating routines.
+ o silc_id_str2id, silc_id2str to non-allocating routines. (***DONE)
 
 
 lib/silccore
 ============
 
-  o All payload encoding routines should take SilcStack as argument.
+ o All payload encoding routines should take SilcStack as argument.
+
+ o All payload test routines into lib/silccore/tests/.
+
+
+lib/silcskr
+===========
+
+ o Removing key from the repository is not possible currently.  It should
+   be.
+
+
+lib/silcske/silcske.[ch] ****PARTLY DONE****
+========================
+
+ o IV Included flag support in SKE (***DONE)
+
+ o UDP transport changes; retransmission support by using exponential
+   backoff algorithm. (***DONE)
+
+ o SilcConnAuth header file documentation.
+
+
+lib/silccrypt                  ****PARTLY DONE****
+=============
+
+ o Implement the defined SilcDH API.  The definition is in
+   lib/silccrypt/silcdh.h.
+
+ o SSH2 public keys support, allowing the use of SSH2 public keys in
+   SILC.
+
+ o OpenPGP certificate support, allowing the use of PGP public keys
+   in SILC.
+
+ o SILC PKCS (silcpkcs.h) reorganizing when other PK supports added.
+   Move the SILC Public Key routines away from the crypto library into
+   the core library (silccore).  silc_pkcs_public/private_key_* routines
+   to silc_public/private_key_* routines.  The silc_public_key_* routines
+   should also automatically handle SILC Public Keys, and other keys
+   and certificates as well.  Add fe. silcpk.h into silccore.  It should
+   also include the Public Key Payload encoding and decoding routines.
+   (***DONE)
+
+ o Add DSS support.
+
+ o Assembler AES (***DONE)
+
+ o ECDSA and ECDH.
 
 
 lib/silcutil                   ****PARTLY DONE****
 ============
 
+ o The regex code from lib/contrib might compile fine on all platforms.
+   No need to make it silcutil/unix/ specific.  Add them to generic
+   silcutil.c.
+
+ o silc_stringprep to non-allocating version.
+
  o Compression routines are missing.  The protocol supports packet
    compression thus it must be implemented.  SILC Zip API must be
    defined.
@@ -69,12 +175,9 @@ lib/silcutil                        ****PARTLY DONE****
    SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
    in separately.
 
- o bool -> SilcBool
-
- o SilcBit, bit field:
-
-   #define SilcBit(b) unsigned int b : 1
+ o bool -> SilcBool (***DONE)
 
+ o Silc FD Stream to WIN32 (lib/silcutil/silcfdstream.h)
 
 lib/silcutil/silcbuffer.h      ****DONE****
 =========================
@@ -85,51 +188,46 @@ lib/silcutil/silcbuffer.h  ****DONE****
    macro instead.  Consider also removing `len' field too since
    it effectively is buffer->tail - buffer->data, and adding
    silc_buffer_len macro can do the same.  These would save
-   totally 8 bytes of memory per buffer.
+   totally 8 bytes of memory per buffer. (***DONE)
 
 
-lib/silcutil/silcbuffmt.[ch]   ****PARTY DONE****
+lib/silcutil/silcbuffmt.[ch]   ****DONE****
 ============================
 
- o SILC_STR_APPEND, _APPEND_TAIL.
+ o SilcStack aware silc_buffer_unformat (***DONE)
+
+ o SilcStack aware silc_buffer_format (***DONE)
 
- o SILC_STR_OFFSET
+ o silc_buffer_format reallocates automatically (***DONE)
+
+ o SILC_STR_OFFSET (***DONE)
 
 
 lib/silcutil/silcstack.[ch]    ****DONE****
 ===========================
 
- o Data stack implementation
+ o Data stack implementation (***DONE)
 
 
 lib/silcutil/silcstream.[ch]   ****DONE****
 ============================
 
- o Add abstract SilcStream.
+ o Add abstract SilcStream. (***DONE)
 
 
 lib/silcutil/silcsocketstream.[ch]     ****PARTY DONE****
 ==================================
 
- o Add SilcSocketStream.
-
- o Test QoS
-
-
-lib/silcutil/epoc/*
-===================
+ o Add SilcSocketStream (***DONE)
 
-  o lib/silcutil/epoc routines missing or not completed.
+ o Add SilcSocketStream for WIN32
 
-  o The PKCS#1 also calls global RNG (even though it is not used
-    currently in SILC, the interface allows its use).
+ o Handle EOS sending to upper layer properly
 
-  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 Test QoS after the changes made to socket stream
 
 
-lib/silcutil/silcschedule*.[ch]                ****DONE****
+lib/silcutil/silcschedule*.[ch]                ****PARTLY DONE****
 ===============================
 
  o Scheduler can be optimized for FD tasks by changing the fd_queue
@@ -147,14 +245,17 @@ lib/silcutil/silcschedule*.[ch]           ****DONE****
    silc_select but at least it removes one extra tarversing later
    for the same list).
 
-   Other task queues should be changed to use SilcList.
+   Other task queues should be changed to use SilcList.  (***DONE)
 
  o Add SILC scheduler's internal routines into a table of implementation
    function pointers, that the generic code then takes as extern from
    implementation.  These are the silc_schedule_internal_* routines.
+   (***DONE)
 
  o Change SILC_TASK_CALLBACK to non-static, and remove the macro
-   SILC_TASK_CALLBACK_GLOBAL.
+   SILC_TASK_CALLBACK_GLOBAL. (***DONE)
+
+ o SILC Schedule API changes to WIN32.
 
 
 lib/silcutil/silcasync.[ch]    ****DONE****
@@ -162,19 +263,45 @@ lib/silcutil/silcasync.[ch]       ****DONE****
 
  o Add SilcAsyncOperation to utility library.  Any function that takes
    callback as an argument must/should return SilcAsyncOperation.
+   (***DONE)
 
 
 lib/silcutil/silctime.[ch]     ****DONE****
 ===========================
 
- o SilcTime.
+ o SilcTime. (***DONE)
 
- o system time, universal, generalized.
+ o system time, universal, generalized. (***DONE)
+
+
+lib/silcutil/silcfsm.[ch]      ****DONE****
+=========================
+
+ o SILC Finite State Machine API.  Replaces SILC Protocol API (***DONE)
+
+
+lib/silcutil/silcnet*, lib/silcutil/*/silc*net*                ****PARTLY DONE****
+===============================================
+
+ o Add UDP interface (***DONE)
+
+ o Add UDP interface for WIN32
+
+ o New network interfaces (***DONE)
 
 
 lib/silcmath
 ============
 
+ o Import TFM.  Talk to Tom to add the missing functions.  Use TFM in
+   client and client library, but TMA in server, due to the significantly
+   increased memory consumption with TFM, and the rare need for public
+   key operations in server.
+
+ o Change LTM and TFM function names when importing to SILC tree to avoid
+   rare linking problems on system that has same named symbols already in
+   the system.
+
  o The SILC MP API function must start returning indication of success
    and failure of the operation.
 
@@ -182,46 +309,47 @@ lib/silcmath
    any other MP function (including utility ones) that may allocate
    memory.
 
- o All utility functions should be made non-allocating ones.
+ o Test on x86_64.
 
+ o All utility functions should be made non-allocating ones.
 
-lib/silcasn1                   ****PARTLY DONE****
-============
 
- o ASN.1 library
+lib/silcutil/symbian/          ****PARTLY DONE****
+=====================
 
- o Header documentation missing.
+  o lib/silcutil/symbian routines missing or not completed.
+    (****TESTING NEEDED)
 
- o Some string encodings missing (copy/paste matter).
+  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.
 
 
-lib/silcpkix
+lib/silcasn1                   ****PARTLY DONE****
 ============
 
- o PKIX implementation
+ o ASN.1 library (***DONE)
 
+ o Header documentation missing. (***DONE)
 
-lib/silcutil/silcfsm.[ch]      ****DONE****
-=========================
+ o Some string encodings missing (copy/paste matter). (***DONE)
 
- o SILC Finite State Machine API.  Replaces SILC Protocol API,
+ o Negative integer encoding
 
 
-lib/silcutil/silcnet*, lib/silcutil/*/silc*net*                ****PARTLY DONE****
-===============================================
-
- o Add UDP interface
-
- o New network interfaces
+lib/silcpkix
+============
 
- o Other functions should remain as they are since these new functions have
-   to use them.  This way we also provide them for applications that want
-   to handle the sockets by themself.
+ o PKIX implementation
 
 
 lib/silcserver
 ==============
 
+ o (Re)write commands/command replys.
+
+ o (Re)write notify handling.
+
  o The SERVER_SIGNOFF notify handing is not optimal, because it'll
    cause sending of multiple SIGNOFF notify's instead of the one
    SERVER_SIGNOFF notify that the server received.  This should be