Server: always drop privileges, even in foreground mode.
[silc.git] / TODO
diff --git a/TODO b/TODO
index 09bc72497311ec945c386d811e61de8166a0a095..d89901f838d4d88b4a9e2383c80f75b620de1642 100644 (file)
--- a/TODO
+++ b/TODO
-TODO/bugs in Irssi SILC client
-==============================
+TODO for 1.1
+============
 
- o UTF-8 encode/decode WHOIS userinfos, topic, etc.
+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 Add STATS.
 
- o Testing
+apps/silcd, The SILC Server    ****PARTLY DONE****
+===========================
+
+ o Fix/test GETKEY. (***DONE)
+
+ o Fix/test MOTD. (***DONE)
+
+ o Rewrite rehash, HUP.
+
+ o Heartbeat-keepalive.
+
+ o Port all code to use SILC Toolkit 1.1 APIs. (***DONE)
+
+ o Remove protocol.[ch].  (***DONE)
+
+ o Rewrite connecting accepting. (***DONE)
+
+ o Rewrite async connecting. (***DONE)
+
+ o Test backup router resuming protocol. (***DONE)
+
+ o Check all packet receive routines that they call silc_packet_free. 
+   (***DONE)
+
+ o Add Web statistics module using lib/silchttp.  Give out server
+   statistics. (***DONE)
+
+
+SILC Client    ****DONE****
+===========
+
+ o Porting to new Toolkit API and new Client Library API (***DONE)
+
+ o Improve help files, especially /cmode, /cumode and /key. (***DONE)
+
+
+lib/silcclient, The Client Library     ***DONE****
+==================================
+
+ o silcclient.h clean up and API rewrites. (***DONE)
+
+ o silcclient_entry.h finishing, all entry relates APIs to this header.
+   (***DONE)
+
+ o SilcChannelEntry, SilcServerEntry, SilcChannelUser, allocating,
+   freeing, finding, etc. rewrite.  Also making them reference counted for
+   multi threads use. (***DONE)
+
+ o Rewrite client side WHOIS command (for whois -details). (***DONE)
+
+ o Finish all the missing SILC packet processings, rewrites. (***DONE)
+
+ o The client_notify.c rewrite. (***DONE)
+
+ o Resuming to client_register.c (remove client_resume.c) (***DONE)
+
+ o Rekey rewrite. (***DONE)
+
+ o Remove protocol.[ch]. (***DONE)
+
+ o File transfer rewrite. (***DONE)
+
+ o File transfer API documentation. (***DONE)
+
+ o Connection auth request. (***DONE)
+
+ o Password auth test, public key auth test. (***DONE)
+
+ o Starting key exchange directly, rewrite. (***DONE)
+
+ o Channel messages, channel private keys, channel entires, channel
+   search, etc. rewrite. (***DONE)
+
+ 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. (***DONE)
+
+ o Key agreement rewrite. (***DONE)
+
+ o Connecting to remote client (***DONE)
+
+ o Private message waiting API (in threads) (***TESTING NEEDED)
+
+ o client_attrs.c, attributes rewrite. (***DONE)
+
+ 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. (***DONE)
+
+ o UDP connections. (***TESTING NEEDED)
+
+
+lib/silcsftp                   ****DONE****
+============
+
+ o Porting to use the new util library. (***DONE)
+
+
+lib/silccore/silcpacket.[ch]   ****DONE****
+============================
+
+ o SilcPacketEngine. (***DONE)
+
+ o New SILC Packet API. (***DONE)
+
+ o Implement silc_packet_engine_stop and silc_packet_stream_destroy. (***DONE)
+
+ 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. (***DONE)
 
-TODO/bugs In SILC Client Library
-================================
+ o silc_id_str2id, silc_id2str to non-allocating routines. (***DONE)
 
- o Add support for the <Requested Attributes> in WHOIS.  Sending and
-   reception should be added.
 
- 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 0.9.x).
+lib/silcskr    ****DONE****
+===========
 
- o Testing
+ o Removing key from the repository is not possible currently.  It should
+   be. (***DONE)
 
 
-TODO/bugs In SILC Server
+lib/silcske/silcske.[ch]       ***DONE****
 ========================
 
- o Backup router can accidently free its own id_entry and ID?  Could happen
-   when some server is connecting and connecting fails (like too many
-   connections, etc).  Some weird crashes relating to this occurred.
+ o Responder rekey (***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. (***DONE)
+
+
+lib/silccrypt                  ****DONE****
+=============
+
+ o Implement PKCS #1 sign/verify with hash OID. (***TESTING NEEDED)
+
+ o Implement SILC Public Key Version 2 handling in sign/verify.  Implement
+   Version (V) identifier (***DONE)
+
+ 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 Assembler AES (***DONE)
+
+
+lib/silcutil                   ****DONE****
+============
 
- o Add support for the <Requested Attributes> in WHOIS.  Sending and
-   reception, with clients and servers should be added.
+ 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. (***DONE)
 
- o Backup router related issues:
+ o Silc FD Stream to WIN32 (lib/silcutil/silcfdstream.h) (***TESTING NEEDED)
 
-       o Add special handling in router and server for "connection
-         timed out" error.  Be optimistic.
+ o bool -> SilcBool (***DONE)
 
-       o Testing
 
- o Close unconfigured client connections in rehash.
+lib/silcutil/silcbuffer.h      ****DONE****
+=========================
 
- 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 0.9.x).
+ o Remove the `truelen' field from SilcBuffer as it is entirely
+   redundant since we can get the true length of the buffer by
+   doing buffer->end - buffer->header.  Add silc_buffer_truelen
+   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. (***DONE)
 
- 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
+lib/silcutil/silcbuffmt.[ch]   ****DONE****
+============================
 
+ o SilcStack aware silc_buffer_unformat (***DONE)
 
-TODO/bugs In SILC Libraries
+ o SilcStack aware silc_buffer_format (***DONE)
+
+ o silc_buffer_format reallocates automatically (***DONE)
+
+ o SILC_STR_OFFSET (***DONE)
+
+
+lib/silcutil/silcstack.[ch]    ****DONE****
 ===========================
 
- 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 0.9.x).
+ o Data stack implementation (***DONE)
+
+
+lib/silcutil/silcstream.[ch]   ****DONE****
+============================
+
+ o Add abstract SilcStream. (***DONE)
+
+
+lib/silcutil/silcsocketstream.[ch]     ****DONE****
+==================================
+
+ o Add SilcSocketStream (***DONE)
+
+ o Add SilcSocketStream for WIN32 (***TESTING NEEDED)
+
+ o Test QoS after the changes made to socket stream
+
+
+lib/silcutil/silcschedule*.[ch]                ****DONE****
+===============================
+
+ o Scheduler can be optimized for FD tasks by changing the fd_queue
+   to SilcHashTable instead of using linked list.  We need to do
+   one-to-one mapping of FD to task and hash table is more efficient
+   for this usage.
+
+   Also redefine the silc_select to perhaps return a separate
+   structure of the events that actually occurred, instead of
+   returning the events in the fd_list which is then traversed
+   in the generic code to find the changed events.  This can be
+   made faster by having own struct which includes only the
+   changed events, thus the tarversing is faster since the whole
+   fd_list is not traversed anymore (it is still traversed in the
+   silc_select but at least it removes one extra tarversing later
+   for the same list).
+
+   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. (***DONE)
+
+ o SILC Schedule API changes to WIN32. (***DONE)
+
+
+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. (***DONE)
+
+ 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*                ****DONE****
+===============================================
+
+ o Add UDP interface (***DONE)
+
+ o Add UDP interface for WIN32 (***TESTING NEEDED)
+
+ o New network interfaces (***DONE)
+
 
+lib/silcmath                   ****DONE****
+============
 
-TODO in Toolkit Documentation
-=============================
+ o Test on x86_64. (***TESTING NEEDED)
 
-Stuff that needs to be done in order to complete the Tooolkit Reference
-Manual (Do these to 0.9.x).
+ 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. (***DONE)
 
- o ROBOdoc documenting missing from lib/silcutil/silcbuffer.h.
 
- o ROBOdoc documenting missing from lib/silcutil/silcdlist.h.
+lib/silcutil/symbian/          ****DONE****
+=====================
 
- o ROBOdoc documenting missing from lib/silcutil/silcfileutil.h.
+  o lib/silcutil/symbian routines missing or not completed.
+    (****TESTING NEEDED)
 
- o ROBOdoc documenting missing from lib/silccrypt/silccipher.h.
+  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 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.
+lib/silcasn1                   ****DONE****
+============
 
- o Write "Platform Implementations" document to describe what platforms
-   Toolkit support, what has been implemented, what has not been, what
-   works differently etc.
+ o ASN.1 library (***DONE)
 
- o Automatically generated index (would be nice).
+ o Header documentation missing. (***DONE)
 
- o Searching of predefined keywords, exact and partial matches (would be 
-   nice).
+ o Some string encodings missing (copy/paste matter). (***DONE)