X-Git-Url: http://git.silcnet.org/gitweb/?p=runtime.git;a=blobdiff_plain;f=TODO;h=e7693efc7bf6f951fa6c0fa8b2c023527a5e1a94;hp=9f031d87f12189609d30e94c25b6348580131eb5;hb=HEAD;hpb=5e8e3a77c70f10a29e78aa645366c84564b8bc7d diff --git a/TODO b/TODO index 9f031d87..e7693efc 100644 --- a/TODO +++ b/TODO @@ -1,397 +1,161 @@ -TODO for 1.1 And Beyond -======================= +SILC Runtime Toolkit 1.2 and beyond +=================================== 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. +NOTE: A TODO entry does not mean that it is ever going to be done. Some +of the entries may be just ideas, good, bad or ugly. If you want to work +on some of the TODO entries simply let us know about it by dropping a note +to silc-devel mailing list or appear on 'silc' channel on SILCNet. -SILC Client -=========== - o Porting to new Toolkit API and new Client Library API +Runtime library, lib/silcutil/ +============================== - o Improve help files, especially /cmode, /cumode and /key. + o Add SILC Zip API, compression. - 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 file removing, chmod, rmmod, etc. chdir, rmdir, stat, etc. to + lib/silcutil/silcfileutil.h. + o mmap API -lib/silcclient, The Client Library -================================== + o Multicast support. - o silcclient.h clean up and API rewrites. + o Implement silc_get_num_cpu. - o silcclient_entry.h finishing, all entry relates APIs to this header. + o silc_file_readfile and silc_file_writefile should perhaps do the thing + with mmap, as it's probably a bit faster. - o SilcChannelEntry, SilcServerEntry, SilcChannelUser, allocating, - freeing, finding, etc. rewrite. Also making them reference counted for - multi threads use. + o silc_malloc et. al. to respect --with-alignment. - o Finish all the missing SILC packet processings, rewrites. + o Fix universal time decoding (doesn't accept all formats) in silctime.c. - o The client_notify.c rewrite. - - o Resuming to client_register.c (remove client_resume.c) - - o Rekey rewrite. - - o Remove protocol.[ch]. - - o File transfer rewrite. - - o Starting key exchange directly, rewrite. - - 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. - - o Connecting to remote client, peer-to-peer private messages - - o Private message waiting API (in threads) - - o client_attrs.c, attributes rewrite. - - o No SilcBuffer lists back to application in command_reply operations. - Convert them all to real lists and/or structures for easier use. - - o Nickname formatting rewrite. - - o UDP connections. - - o Remove silc_client_run and silc_client_run_one from calling SilcSchedule. - Leave the scheduling entirely to application. - - o All packet waiting timeout tests and error condition tests. - - -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 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. (***DONE) - - -lib/silccore -============ - - 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] -======================== - - o IV Included flag support in SKE (***TESTING NEEDED) - - o UDP transport changes; retransmission support by using exponential - backoff algorithm. - - 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 Cipher optimizations (asm, that this) at least for i386 would be nice. - - o ECDSA and ECDH. - - -lib/silcutil ****PARTLY DONE**** -============ + o Additional scheduler changes: optimize silc_schedule_wakeup. Wakeup + only if the scheduler is actually waiting something. If it is + delivering tasks wakeup is not needed. 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) - + o Add silc_xml_parse_stream to parse SilcStream XML stream. -lib/silcutil/silcbuffmt.[ch] ****PARTLY DONE**** -============================ + o SILC XML API (wrapper to expat). (***DONE) - o SilcStack aware silc_buffer_unformat (***DONE) + o Bring silchttp HTTP server library to SRT. (***DONE) - o SilcStack aware silc_buffer_format (***DONE) + o Simple SILC Rand API for pseudo-random numbers. (***DONE) - o silc_buffer_format reallocates automatically (***DONE) + o Add directory opening/traversing functions (***DONE, TODO Windows & Symbian) - o SILC_STR_OFFSET (***DONE) + o regex from /lib/contrib to lib/silcutil, define SILC Regex API. (***DONE) + o Add functions to manipulate environment variables. (***DONE) -lib/silcutil/silcstack.[ch] ****DONE**** -=========================== + o Add functions to loading shared/dynamic object symbols (replaces the + SIM library (lib/silcsim) and introduces generic library). Add this + to lib/silcutil/silcdll.[ch]. (***TESTING NEEDED WIN32, TODO Symbian) - o Data stack implementation (***DONE) + o silc_getopt routines (***DONE) + o The SILC Event signals. Asynchronous events that can be created, + connected to and signalled. Either own event routines or glued into + SilcSchedule. (***DONE) -lib/silcutil/silcstream.[ch] ****DONE**** -============================ + o If the event signals are added, the SILC_PARAM_* stuff needs to be + moved from silcbuffmt.h to silctypes.h or something similar. (***DONE) - o Add abstract SilcStream. (***DONE) + o In case the SILC Events are done we shall create a new concept of + parent and child SilcSchedule's. When new SilcSchedule is created a + parent can be associated to it. This association could be done either + directly by the parent or by any other children. This way the signals + would in effect be global and would reach all children schedulers. + This relationship would be associative only. The schedulers are still + independent and run independently from each other. All schedulers + would be linked and could be accessed from any of the schedulers. + It should be possible to retrieve the parent and enumerate all children + from any of the schedulers. + (***DONE) -lib/silcutil/silcsocketstream.[ch] ****PARTY DONE**** -================================== - - o Add SilcSocketStream (***DONE) - - o Add SilcSocketStream for WIN32 + o Base64 to an own API (***DONE) - o Handle EOS sending to upper layer properly + o Timer API (***DONE) - o Test QoS after the changes made to socket stream + o silc_hash_table_replace -> silc_hash_table_set. Retain support for + silc_hash_table_replace as macro. (***DONE) + o SilcStack aware SilcHashTable. (***DONE) -lib/silcutil/silcschedule*.[ch] ****DONE**** -=============================== + o SilcStack aware SilcDList. (***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. + o Thread pool API. Add this to lib/silcutil/silcthread.[ch]. (***DONE) - 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 Add new functions to SilcStack API in lib/silcutil/silcstack.[ch]. Add + silc_stack_[set|get]_alignment. It defines the default alignment used + when allocating memory from stack. It can be used to specify special + alignments too when needed (such as for hardware devices like crypto + accelerators). Move also the low level silc_stack_malloc and + silc_stack_realloc from silcstack_i.h to silcstack.h. Remove the + _ua unaligned memory allocation routines. Remove unaligned memory + allocation possibility. (***DONE) - Other task queues should be changed to use SilcList. (***DONE) + o silc_stack_alloc shouldn't require multiple by 8 size argument, it + should figure it out itself. (***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. + o Add '%@' format to silc_snprintf functions. (***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. + o SILC Tls (Thread-local storage) API to lib/silcutil/silcthread.[ch]. (***DONE) + o Change silc_gettimeofday on Unix to use clock_gettime with REALTIME + clock if it is available, otherwise use gettimeofday(). (***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* ****PARTLY DONE**** -=============================================== - - o Add UDP interface (***DONE) - - o Add UDP interface for WIN32 - - o New network interfaces (***DONE) - - -lib/silcsftp -============ - - o Porting to use the new util library. - - -lib/silcutil/epoc/* -=================== - - o lib/silcutil/epoc routines missing or not completed. - - o The PKCS#1 also calls global RNG (even though it is not used - currently in SILC, the interface allows its use). - - 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/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. - - 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 Test on x86_64. - - o All utility functions should be made non-allocating ones. - - -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 - + o Generic SilcResult that includes all possible status and + error conditions and generic errno API. (***DONE) -lib/silcserver -============== + (o Structured log messages to Log API. Allows machine readable log + messages. Would allow sending of any kind of data in a log message.) maybe - o (Re)write commands/command replys. + (o Change some stream routines (like socket stream API) to accept ANY + stream and use silc_stream_get_root to get the socket stream from the + given stream. This will make various stream APIs more easier to use + when user doesn't have to dig up the correct stream. - o (Re)write notify handling. + Add silc_stream_get_root and add get_root stream operation. It + returns the root of the stream or NULL if stream doesn't have root.) maybe - 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 SilcIpAddr abstraction. Ipv4 and Ipv6 support to the abstaction.) + maybe - 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 SILC specific socket creation/closing routines to silcnet.h, wrappers + to all send(), recv(), sendto() etc. Bad thing is that we'd have to + define all socket options, sockaddrs, etc.) maybe - o MAYBE: The SilcChannelClientEntry can be: - SilcUInt32 address; - SilcUInt32 mode; + (o Fast mutex implementation. Fast rwlock implementation. Mutex and + rwlock implementation using atomic operations.) not for now. - 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 +Windows Support +=============== - 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! +Symbian OS Support +================== - 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 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. The logging currently works + by it cannot be controlled, same with debugging. SILC Global API + MUST be used with all globals on Symbian. - 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 gethostname() returns "Function not implemented". Others may return + the same. We should fix that probably to use RHostResolver and + GetHostName(). - o The CMODE cipher & hmac change problem (#101). + o silc_thread_exit should call User::Exit().