-TODO/bugs in Irssi SILC client
-==============================
+TODO for 1.1
+============
- o /USERS does not show the user modes on the channel correctly.
+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 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.
- 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.
+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 Add the server/router operator info to the statusbar.
+ o Resuming to client_register.c (remove client_resume.c) (***DONE)
- o /cumode for unknown nick does not give any error message.
+ o Rekey rewrite. (***DONE)
+ o Remove protocol.[ch]. (***DONE)
-TODO/bugs In SILC Client Library
-================================
+ o File transfer rewrite. (***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 API documentation. (***DONE)
- o Additions to do after protocol version 1.1:
+ o Connection auth request. (***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 Password auth test, public key auth test. (***DONE)
- o Add support for list of errors in command replies. Protocol
- TODO entry 1.
+ o Starting key exchange directly, rewrite. (***DONE)
+ o Channel messages, channel private keys, channel entires, channel
+ search, etc. rewrite. (***DONE)
-TODO/bugs In SILC Server
+ 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)
- 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 Add hashed passwords to config file.
+lib/silcskr ****DONE****
+===========
+
+ o Removing key from the repository is not possible currently. It should
+ be. (***DONE)
+
+
+lib/silcske/silcske.[ch] ***DONE****
+========================
+
+ o Responder rekey (***DONE)
- o Add rehashing support.
+ o IV Included flag support in SKE (***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 UDP transport changes; retransmission support by using exponential
+ backoff algorithm. (***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 SilcConnAuth header file documentation. (***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.
- o Backup router related issues
+lib/silccrypt ****DONE****
+=============
- o Channel user mode changes are notified unnecessarely when
- switching to backup router on router crash.
+ o Implement PKCS #1 sign/verify with hash OID. (***TESTING NEEDED)
- o Lots of statistics updating is missing around the server.
+ o Implement SILC Public Key Version 2 handling in sign/verify. Implement
+ Version (V) identifier (***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 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)
-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 Fix possible buffer overflows in silc_id_render function.
+ o Data stack implementation (***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 Rewrite the lib/silcsim/silcsim.h. The SilcSimContext should be
- private and silc_sim_alloc should take necessary arguments.
+lib/silcutil/silcstream.[ch] ****DONE****
+============================
- o SILC RNG does not implement random seed files, and they should be
- implemented.
+ o Add abstract SilcStream. (***DONE)
- o The SilcSocketConnection in the SFTP interface is actually redundant
- and should perhaps be removed. The application can save it in the
- context it provides, which is delivered by SFTP libary to all
- callback functions.
+lib/silcutil/silcsocketstream.[ch] ****DONE****
+==================================
-TODO in Toolkit Documentation
-=============================
+ o Add SilcSocketStream (***DONE)
-Stuff that needs to be done in order to complete the Tooolkit Reference
-Manual.
+ o Add SilcSocketStream for WIN32 (***TESTING NEEDED)
- o Lots of ROBOdoc header formatting is undone in lib/silcutil, and
- lib/silccrypt.
+ o Test QoS after the changes made to socket stream
- 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 Write "Platform Implementations" document to describe what platforms
- Toolkit support, what has been implemented, what has not been, what
- wors differently etc.
+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.
-TODO in SILC Protocol
-=====================
+ 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)
-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.
-
-
-TODO After 1.0
-==============
-
-A rough list of stuff that is going to be done to SILC after 1.0 or at
-least could be done.
-
- o Implement the defined SilcDH API. The definition is in
- lib/silccrypt/silcdh.h.
-
- o X.509 certificate support. SILC protocol supports certificates and
- it would be great to have support for them. This is a big task as
- support has to be made for ASN.1 as well. I've looked into OpenSSL
- package as it has X.509 certificate support (and ASN.1 as well).
- The code does not look very good to my eye but it has some potentials.
- This should be looked at more closely.
-
- Naturally own SILC Certificate API has to be defined regardles what
- the actual X.509 library is (OpenSSL X.509 or something else). Other
- choice is to write own X.509 library but I'm not going to do it -
- I can help to migrate the OpenSSL X.509 into SILC and I can help if
- someone would like to write the X.509 library - but I'm not going
- to start writing one myself. Anyhow, the OpenSSL X.509 lib should
- be checked.
-
- Other package that should be checked is the NSS's X509 library,
- which I like more over OpenSSL package.
-
- 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 Compression routines are missing. The protocol supports packet
- compression thus it must be implemented. SILC Zip API must be
- defined.
-
- o Rewrite the lib/silcutil/silcprotocol.[ch] not to have [un]register
- functions, but to make it context based all the way. The alloc should
- take as argument the protocol type and its callback (not only
- final callback). It is not good that we have now global list of
- registered protocols.
-
- o Optimizations in Libraries
-
- o There is currently three (3) allocations per packet in the
- silc_packet_receive_process, which is used to process and
- dispatch all packets in the packet queue to the parser callback
- function. First allocation is for parse_ctx, second for the
- SilcPacketContext, and third for packet->buffer where the actual
- data is saved.
-
- The parse_ctx allocation can be removed by adding it as a
- structure to the SilcPacketContext. When the SilcPacketContext
- is allocated there is space for the parse context already.
-
- The silc_packet_context_alloc could have a free list of
- packet contexts. If free packet context is found from the list
- it is returned instead of allocating a new one. The library
- could at first allocate them and save them to the free list
- until enough contexts for smooth processing exists in the list.
- This would remove a big allocation since the structure is
- quite big, and even bigger if it would include the parse_ctx.
-
- The packet->buffer can be optimized too if the SilcBuffer
- interface would support free lists as well. Maybe such could
- be done in the same way as for SilcPacketContext. The
- silc_buffer_alloc would check free list before actually
- allocating new memory. Since the packets in the SILC protocol
- usually are about the same size (due to padding) it would be
- easy to find suitable size buffer from the free list very
- quickly.
-
- These naturally cause the overal memory consumption to grow
- but would take away many allocations that can be done several
- times in a second.
-
- o Move the actual file descriptor task callback (the callback that
- handles the incoming data, outgoing data etc, that is implemnted
- in server and client separately (silc_server_packet_process and
- silc_client_packet_proces)) to the low level socket connection
- handling routines, and create an interface where the application
- can register a callbacks for incoming data, outoing data and EOF
- receiving, which the library will call when necessary. This way
- we can move the data handling in one place.
-
- 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 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.
-
- Add also perhaps function silc_buffer_alloc_size that would
- effectively do:
-
- return silc_buffer_pull_tail(silc_buffer_alloc(size),
- size);
-
- to not require the user to give the pull_tail anymore.
-
- o Optimizations in Server
-
- o Remove the big switch statement from the function
- silc_server_packet_parse_type and replace it with predefined
- table of function pointers where each of the slot in table
- represents the packet type value.
-
- Same could be done with notify packets which has big switch
- statement too. Same kind of table of notify callbacks could be
- done as well.
-
- o The parser callback in the server will add a timeout task for
- all packets. It will require registering and allocating a
- new task to the SilcSchedule. Maybe, at least, for server
- and router packets the parser would be called immediately
- instead of adding it to the scheduler with 0 timeout. It
- should be analyzed too how slow the task registering process
- actually is, and find out ways to optimize it.
-
- 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 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 return SilcAsyncOperation.
+ 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****
+============
+
+ 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****
+=====================
+
+ 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 Add DSS support.
+ o ASN.1 library (***DONE)
- o Cipher optimizations (asm, that this) at least for i386 would be nice.
+ o Header documentation missing. (***DONE)
- 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 Some string encodings missing (copy/paste matter). (***DONE)
projects / silc.git / blobdiff