-TODO/bugs in Irssi SILC client
-==============================
+TODO for 1.1
+============
- o Fix the silc_channels_join to parse the command like, with fe.
- silc_parse_command_line, because currently it ignores all options,
- including passphrase which makes autojoin impossible to +a channels.
- Other important options are ignored too.
+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 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 /cumode for unknown nick does not give any error message.
+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)
-TODO/bugs In SILC Client Library
-================================
+ o Remove protocol.[ch]. (***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.
+ o File transfer rewrite. (***DONE)
- o Additions to do after protocol version 1.1:
+ o File transfer API documentation. (***DONE)
- 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 Connection auth request. (***DONE)
- o Add support for list of errors in command replies. Protocol
- TODO entry 1.
+ o Password auth test, public key auth test. (***DONE)
+ o Starting key exchange directly, rewrite. (***DONE)
-TODO/bugs In SILC Server
+ 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 Configuration file additions:
+ 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 version handling, to allow, disallow certain versions to
- connect.
+ o silc_id_str2id, silc_id2str to non-allocating routines. (***DONE)
+
+
+lib/silcskr ****DONE****
+===========
+
+ o Removing key from the repository is not possible currently. It should
+ be. (***DONE)
+
+
+lib/silcske/silcske.[ch] ***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 Responder rekey (***DONE)
- o Add hashed passwords to config file.
+ o IV Included flag support in SKE (***DONE)
- o Add rehashing support.
+ o UDP transport changes; retransmission support by using exponential
+ backoff algorithm. (***DONE)
- 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.
+ o SilcConnAuth header file documentation. (***DONE)
- o The router should check for validity of received notify packets from
- servers (after all buggy servers may send notify that is actually
- something that should have not been sent).
- 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.
+lib/silccrypt ****DONE****
+=============
- o Backup router related issues
+ o Implement PKCS #1 sign/verify with hash OID. (***TESTING NEEDED)
- o Channel user mode changes are notified unnecessarely when
- switching to backup router on router crash.
+ o Implement SILC Public Key Version 2 handling in sign/verify. Implement
+ Version (V) identifier (***DONE)
- o Lots of statistics updating is missing around the server.
+ 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 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 Assembler AES (***DONE)
-TODO/bugs In SILC Libraries
+lib/silcutil ****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. (***DONE)
+
+ o Silc FD Stream to WIN32 (lib/silcutil/silcfdstream.h) (***TESTING NEEDED)
+
+ o bool -> SilcBool (***DONE)
+
+
+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)
+
+ 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.
+ o Data stack implementation (***DONE)
+
+
+lib/silcutil/silcstream.[ch] ****DONE****
+============================
+
+ o Add abstract SilcStream. (***DONE)
+
+
+lib/silcutil/silcsocketstream.[ch] ****DONE****
+==================================
- o EPOC specific additions/changes required:
+ o Add SilcSocketStream (***DONE)
- o lib/silcutil/epoc routines missing or not completed.
+ o Add SilcSocketStream for WIN32 (***TESTING NEEDED)
+ o Test QoS after the changes made to socket stream
-TODO in Toolkit Documentation
-=============================
-Stuff that needs to be done in order to complete the Tooolkit Reference
-Manual.
+lib/silcutil/silcschedule*.[ch] ****DONE****
+===============================
- o Lots of ROBOdoc header formatting is undone in lib/silcutil, and
- lib/silccrypt.
+ 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.
- 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.
+ 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).
- o Write "Platform Implementations" document to describe what platforms
- Toolkit support, what has been implemented, what has not been, what
- works differently etc.
+ 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)
-TODO in SILC Protocol
+
+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****
+============
+
+ o Test on x86_64. (***TESTING NEEDED)
+
+ 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)
+
+
+lib/silcutil/symbian/ ****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.
+ 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 ****DONE****
+============
+
+ o ASN.1 library (***DONE)
+
+ o Header documentation missing. (***DONE)
+
+ o Some string encodings missing (copy/paste matter). (***DONE)
projects / silc.git / blobdiff