-TODO/bugs in Irssi SILC client
-==============================
+TODO for 1.1 And Beyond
+=======================
- o /cumode for unknown nick does not give any error message (Fix this to
- 1.0).
+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.
-TODO/bugs In SILC Client Library
-================================
+SILC Client ****PARTLY DONE****
+===========
- 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 Porting to new Toolkit API and new Client Library API
- o Additions to do after protocol version 1.1:
+ o Improve help files, especially /cmode, /cumode and /key.
- 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.
+lib/silcclient, The Client Library ***PARTLY DONE****
+==================================
+ o silcclient.h clean up and API rewrites.
-TODO/bugs In SILC Server
+ 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. (***DONE)
+
+ o New SILC Packet API. (***DONE)
+
+
+lib/silccore/silcpacket.[ch] ****PARTLY DONE****
+============================
+
+ o IV Included flag support, UDP transport support (***TESTING NEEDED)
+
+
+lib/silccore/silcid.[ch] ****DONE****
========================
- o Configuration file additions (Do this to 0.8.x):
+ 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 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 silc_id_str2id, silc_id2str to non-allocating routines. (***DONE)
- o Add rehashing support.
- 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).
+lib/silccore
+============
- 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 All payload encoding routines should take SilcStack as argument.
- 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 All payload test routines into lib/silccore/tests/.
- 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.
+lib/silcskr
+===========
- 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 Removing key from the repository is not possible currently. It should
+ be.
- 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!
+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.
+
+ 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 bool -> SilcBool (***DONE)
+
+ o Silc FD Stream to WIN32 (lib/silcutil/silcfdstream.h)
+
+lib/silcutil/silcbuffer.h ****DONE****
+=========================
+
+ 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)
+
+
+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 1.0).
+ o Data stack implementation (***DONE)
+
+
+lib/silcutil/silcstream.[ch] ****DONE****
+============================
+
+ o Add abstract SilcStream. (***DONE)
+
+
+lib/silcutil/silcsocketstream.[ch] ****PARTY DONE****
+==================================
+
+ o Add SilcSocketStream (***DONE)
+
+ o Add SilcSocketStream for WIN32
+
+ o Handle EOS sending to upper layer properly
+
+ o Test QoS after the changes made to socket stream
+
+
+lib/silcutil/silcschedule*.[ch] ****PARTLY 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.
+
+
+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)
-TODO in Toolkit Documentation
-=============================
+lib/silcutil/silcnet*, lib/silcutil/*/silc*net* ****PARTLY DONE****
+===============================================
-Stuff that needs to be done in order to complete the Tooolkit Reference
-Manual.
+ o Add UDP interface (***DONE)
- o ROBOdoc documenting missing from lib/silcutil/silcbuffer.h.
+ o Add UDP interface for WIN32
- o ROBOdoc documenting missing from lib/silcutil/silcdlist.h.
+ o New network interfaces (***DONE)
- o ROBOdoc documenting missing from lib/silcutil/silcfileutil.h.
- o ROBOdoc documenting missing from lib/silcutil/silcutil.h.
+lib/silcmath
+============
- o ROBOdoc documenting missing from lib/silccrypt/silchash.h.
+ 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 ROBOdoc documenting missing from lib/silccrypt/silccipher.h.
+ 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 ROBOdoc documenting missing from lib/silccrypt/silcpkcs.h.
+ o The SILC MP API function must start returning indication of success
+ and failure of the operation.
- 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 Do SilcStack support for silc_mp_init, silc_mp_init_size and other
+ any other MP function (including utility ones) that may allocate
+ memory.
- o Write "Platform Implementations" document to describe what platforms
- Toolkit support, what has been implemented, what has not been, what
- works differently etc.
+ o Test on x86_64.
+ o All utility functions should be made non-allocating ones.
-TODO in SILC Protocol
+
+lib/silcutil/symbian/ ****PARTLY DONE****
=====================
-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.
+ o lib/silcutil/symbian routines missing or not completed.
+ (****TESTING NEEDED)
+
+ 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/silcasn1 ****PARTLY DONE****
+============
+
+ o ASN.1 library (***DONE)
+
+ o Header documentation missing. (***DONE)
+
+ o Some string encodings missing (copy/paste matter). (***DONE)
+
+ o Negative integer encoding
+
+
+lib/silcpkix
+============
+
+ 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
+ optimized so that the only SERVER_SIGNOFF is sent and not
+ SIGNOFF of notify at all (using SIGNOFF takes the idea about
+ SERVER_SIGNOFF away entirely).
+
+ o Another SERVER_SIGNOFF opt/bugfix: Currently the signoff is
+ sent to a client if it is on same channel as the client that
+ signoffed. However, the entire SERVER_SIGNOFF list is sent to
+ the client, ie. it may receive clients that was not on the
+ same channel. This is actually against the specs. It must be
+ done per channel. It shouldn't receive the whole list just
+ because one client happened to be on same channel.
+
+ o MAYBE: The SilcChannelClientEntry can be:
+ SilcUInt32 address;
+ SilcUInt32 mode;
+
+ where address is SilcClientEntry address XOR SilcChannelEntry.
+ You can get SilcClientEntry by doing client = chl->address XOR channel,
+ and SilcChannelEntry by doing channel = chl->address XOR client.
+ As long as the other pointer is always available when accessing the
+ structure this can be done.
+
+ o Add reference counters to all Silc*Entry structures
+
+ o SERVICEs support (plugin, SIM)
+
+ 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 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 Related to above. If multiple JOINs are received in sequence perhaps
+ new key should be created only once, if the JOINs are handeled at the same
+ time. Now we create multiple keys and never end up using them because
+ many JOINs are processed at the same time in sequence. Only the last
+ key ends up being used.
+
+ o The CMODE cipher & hmac change problem (#101).
projects / silc.git / blobdiff