-TODO for 1.1 And Beyond
+TODO for 1.2 And Beyond
=======================
-NOTE: Any item that doesn't have (***DONE) in it, isn't done yet.
+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.
-lib/silccore/silcpacket.[ch] ****DONE****
-============================
- o SilcPacketEngine. (***DONE)
+General
+=======
- o New SILC Packet API. (***DONE)
+ o Create apps/tutorial containing various Toolkit API tutorials.
+ o The Toolkit split. The Toolkit is to be splitted in parts. How many
+ parts and what the parts are isn't decided yet. Each part is a separate
+ software package. Current thinking is of the following:
-lib/silccore/silcpacket.[ch] ****PARTLY DONE****
-============================
+ SILC Toolkit SILC protocol, client and server library
+ SILC Runtime Toolkit runtime library
+ SILC Crypto Toolkit crypto, asn1, math, skr, pgp, etc.
- o IV Included flag support, UDP transport support (***TESTING NEEDED)
+ The rationale for this is of course that other than SILC projects
+ might like to use the various libraries SILC Toolkit provides, but
+ naturally they don't want the bloat of SILC protocol related stuff.
+ The Runtime library in SILC Toolkit is a general purpose runtime library,
+ like Glib and APR are. The runtime library is to be developed further
+ to provide alternative to Glib and APR.
-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)
+ The Crypto library in SILC Toolkit is a general purpose crypto library
+ providing pretty nice APIs compared to many other crypto libraries,
+ especially OpenSSL. The Crypto library is to be developed further
+ to include support for OpenPGP, X.509 and SSH2.
lib/silccore
============
- o All payload encoding routines should take SilcStack as argument.
+ o SILC_PACKET_FLAG_ACK support. Implement ACK packet and packet payload
+ to silcpacket.c.
+ o All payload encoding routines should take SilcStack as argument.
-lib/silcske/silcske.[ch]
-========================
+ o All payload test routines into lib/silccore/tests/.
- o IV Included flag support in SKE (it currently doesn't accept it)
- o SilcConnAuth header file documentation.
+lib/silcclient, The Client Library
+==================================
+ o peer-to-peer private messages
-lib/silccrypt ****PARTLY DONE****
-=============
+ o Private message key request notification to application. See XXX in
+ client_prvmsg.c.
- o Implement the defined SilcDH API. The definition is in
- lib/silccrypt/silcdh.h.
+ o in JOIN notify handle resolving that timedout. Currently the user is
+ never joined the channel if this happens. What to do if message is
+ received from user that hasn't been resolved/joined?
- o SSH2 public keys support, allowing the use of SSH2 public keys in
- SILC.
+ o Message ACKing support.
- o OpenPGP certificate support, allowing the use of PGP public keys
- in SILC.
+ 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 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.
+Runtime library, lib/silcutil/
+==============================
- o Cipher optimizations (asm, that this) at least for i386 would be nice.
+ o Fix universal time decoding (doesn't accept all formats) in silctime.c.
- o ECDSA and ECDH.
+ o Add functions to manipulate environment variables.
+ SilcBool silc_setenv(const char *variable, const char *value);
+ const char *silc_getenv(const char *variable);
+ SilcBool silc_clearenv(const char *variable);
-lib/silcutil ****PARTLY DONE****
-============
+ o Add functions to loading shared/dynamic object symbols (replaces the
+ SIM library (lib/silcsim) and introduces generic library).
- o silc_stringprep to non-allocating version.
+ SilcDll silc_dll_load(const char *object_path, SilcDllFlags flags);
+ void silc_dll_close(SilcDll dll);
+ void *silc_dll_getsym(SilcDll dll, const char *symbol);
+ const char *silc_dll_error(SilcDll dll);
- o Compression routines are missing. The protocol supports packet
- compression thus it must be implemented. SILC Zip API must be
- defined.
+ o Add directory opening/traversing functions
- 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 silc_getopt routines
- o bool -> SilcBool (***DONE)
+ o silc_hash_table_replace -> silc_hash_table_set. Retain support for
+ silc_hash_table_replace as macro.
- o Silc FD Stream to WIN32 (lib/silcutil/silcfdstream.h)
+ o The SILC Event signals. Asynchronous events that can be created,
+ connected to and signalled. Either own event routines or glued into
+ SilcSchedule:
+ SilcTask silc_schedule_task_add_event(SilcSchedule schedule,
+ const char *event, ...);
+ SilcBool silc_schedule_event_connect(SilcSchedule schedule,
+ const char *event,
+ SilcTaskCallback event_callback,
+ void *context);
+ SilcBool silc_schedule_event_signal(SilcSchedule schedule,
+ const char *event, ...);
-lib/silcutil/silcbuffer.h ****DONE****
-=========================
+ Example:
+ silc_schedule_task_add_event(schedule, "connected",
+ SILC_PARAM_UI32_INT,
+ SILC_PARAM_BUFFER,
+ SILC_PARAM_END);
+ silc_schedule_event_connect(schedule, "connected", connected_cb, ctx);
+ silc_schedule_event_signal(schedule, "connected", integer, buf,
+ SILC_PARAM_END);
+ SILC_TASK_CALLBACK(connected_cb)
+ {
+ FooCtx ctx = context;
+ va_list args;
+ SilcUInt32 integer;
+ SilcBuffer buf;
+
+ va_start(args, context);
+ integer = va_arg(args, SilcUInt32);
+ buf = va_arg(args, SilcBuffer);
+ va_end(args);
+ ...
+ }
- 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)
+ Problems: Events would be SilcSchedule specific, and would not work on
+ multi-thread/multi-scheduler system. The events should be copyable
+ between schedulers.
+ o Structured log messages to Log API. Allows machine readable log
+ messages. Would allow sending of any kind of data in a log message.
-lib/silcutil/silcbuffmt.[ch] ****PARTLY DONE****
-============================
+ o Base64 to an own API
- o SilcStack aware silc_buffer_unformat
+ o Timer API
- o SilcStack aware silc_buffer_format (***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 silc_buffer_format reallocates automatically (***DONE)
+ o silc_stringprep to non-allocating version.
- o SILC_STR_OFFSET (***DONE)
+ o SilcStack aware SilcHashTable.
+ o SilcStack aware SilcDList.
-lib/silcutil/silcstack.[ch] ****DONE****
-===========================
+ o Thread pool API.
- o Data stack implementation (***DONE)
+ typedef void (*SilcThreadPoolFunc)(SilcSchedule schedule,
+ void *context);
+ /* Allocate thread pool with at least `min_threads' and at most
+ `max_threads' many threads. If `stack' is non-NULL all memory
+ is allocated from the `stack'. If `start_min_threads' is TRUE
+ this will start `min_threads' many threads immediately. */
+ SilcThreadPool silc_thread_pool_alloc(SilcStack stack,
+ SilcUInt32 min_threads,
+ SilcUInt32 max_threads,
+ SilcBool start_min_threads);
-lib/silcutil/silcstream.[ch] ****DONE****
-============================
+ /* Free thread pool. If `wait_unfinished' is TRUE this will block
+ and waits that all remaining active threads finish before freeing
+ the pool. */
+ void silc_thread_pool_free(SilcThreadPool tp, SilcBool wait_unfinished);
- o Add abstract SilcStream. (***DONE)
+ /* Run `run' function with `run_context' in one of the threads in the
+ thread pool. Returns FALSE if the thread pool is being freed. If
+ there are no free threads left in the pool this will queue the
+ the `run' and will call it once a thread becomes free.
+ If `completion' is non-NULL it will be called to indicate completion
+ of the `run' function. If `schedule' is non-NULL the `completion'
+ will be called through the scheduler in the main thread. If it is
+ NULL the `completion' is called directly from the thread after the
+ `run' has returned. */
+ SilcBool silc_thread_pool_run(SilcThreadPool tp,
+ SilcSchedule schedule,
+ SilcThreadPoolFunc run,
+ void *run_context,
+ SilcThreadPoolFunc completion,
+ void *completion_context);
-lib/silcutil/silcsocketstream.[ch] ****PARTY DONE****
-==================================
+ /* Modify the amount of maximum threads of the pool. */
+ void silc_thread_pool_set_max_threads(SilcThreadPool tp,
+ SilcUInt32 max_threads);
- o Add SilcSocketStream (***DONE)
+ /* Returns the amount of maximum size the pool can grow. */
+ SilcUInt32 silc_thread_pool_get_max_threads(SilcThreadPool tp);
- o Add SilcSocketStream for WIN32
+ /* Returns the amount of free threads in the pool currently. */
+ SilcUInt32 silc_thread_pool_get_free_threads(SilcThreadPool tp);
- o Test QoS after the changes made to socket stream
+ /* Stops all free and started threads. The minumum amount of threads
+ specified to silc_thread_pool_alloc always remains. */
+ void silc_thread_pool_stop_free_threads(SilcThreadPool tp);
+ o Fast mutex implementation. Fast rwlock implementation. Mutex and
+ rwlock implementation using atomic operations.
-lib/silcutil/silcschedule*.[ch] ****DONE****
-===============================
+ o Compression routines are missing. The protocol supports packet
+ compression thus it must be implemented. SILC Zip API must be
+ defined.
- 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 Generic SilcStatus or SilcResult that includes all possible status and
+ error conditions, including those of SILC protocol. Though, the SILC
+ protocol related status (currently in silcstatus.h) cannot be in
+ runtime library) maybe
- 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 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
- Other task queues should be changed to use SilcList. (***DONE)
+ (o mmap) maybe
- 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)
+lib/silcutil/symbian/
+=====================
- o SILC Schedule API changes to WIN32.
+ 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.
-lib/silcutil/silcasync.[ch] ****DONE****
+SFTP Library, lib/silcsftp/
===========================
- o Add SilcAsyncOperation to utility library. Any function that takes
- callback as an argument must/should return SilcAsyncOperation.
- (***DONE)
+ o Read prefetch (read-ahead, reading ahead of time). Maybe if this can
+ be done easily.
-lib/silcutil/silctime.[ch] ****DONE****
-===========================
+SKR Library, lib/silcskr/
+=========================
- o SilcTime. (***DONE)
+ o Add fingerprint as search constraint.
+
+ o Add OpenPGP support. Adding, removing, fetching PGP keys. (Keyring
+ support?)
+
+ o Add support for importing public keys from a directory and/or from a
+ file. Add support for exporting the repository (different formats for
+ different key types?).
+
+ o Change the entire silc_skr_find API. Remove SilcSKRFind and just simply
+ add the find constraints as variable argument list to silc_skr_find, eg:
+
+ silc_skr_find(skr, schedule, callback, context,
+ SILC_SKR_FIND_PUBLIC_KEY, public_key,
+ SILC_SKR_FIND_COUNTRY, "FI",
+ SILC_SKR_FIND_USAGE, SILC_SKR_USAGE_AUTH,
+ SILC_SKR_FIND_END);
+
+ NULL argument would be ignored and skipped.
+
+ o Add OR logical rule in addition of the current default AND, eg:
+
+ // Found key(s) MUST have this public key AND this country.
+ silc_skr_find(skr, schedule, callback, context,
+ SILC_SKR_FIND_RULE_AND,
+ SILC_SKR_FIND_PUBLIC_KEY, public_key,
+ SILC_SKR_FIND_COUNTRY, "FI",
+ SILC_SKR_FIND_END);
+
+ // Found key(s) MUST have this public key OR this key context
+ silc_skr_find(skr, schedule, callback, context,
+ SILC_SKR_FIND_RULE_OR,
+ SILC_SKR_FIND_PUBLIC_KEY, public_key,
+ SILC_SKR_FIND_CONTEXT, key_context,
+ SILC_SKR_FIND_END);
+
+
+Crypto Library, lib/silccrypt/
+==============================
+
+ o Add fingerprint to SilcSILCPublicKey and retrieval to silcpk.h, and
+ possibly to silcpkcs.h.
+
+ /* Return fingerprint of the `public_key'. Returns also the algorithm
+ that has been used to make the fingerprint. */
+ const unsigned char *
+ silc_pkcs_get_fingerprint(SilcPublicKey public_key,
+ const char **hash_algorithm,
+ SilcUInt32 *fingerprint_len);
+
+ o Change SILC PKCS API to asynchronous, so that accelerators can be used.
+ All PKCS routines should now take callbacks as argument and they should
+ be delivered to SilcPKCSObject and SilcPKCSAlgorithm too.
+
+ /* Signature computation callback */
+ typedef void (*SilcPKCSSignCb)(SilcBool success,
+ const unsigned char *signature,
+ SilcUInt32 signature_len,
+ void *context);
+
+ /* Signature verification callback */
+ typedef void (*SilcPKCSVerifyCb)(SilcBool success, void *context);
+
+ /* Encryption callback */
+ typedef void (*SilcPKCSEncryptCb)(SilcBool success,
+ const unsigned char *encrypted,
+ SilcUInt32 encrypted_len,
+ void *context);
+
+ /* Decryption callback */
+ typedef void (*SilcPKCSDecryptCb)(SilcBool success,
+ const unsigned char *decrypted,
+ SilcUInt32 decrypted_len,
+ void *context);
+
+ Either add new _async functions or add the callbacks to existing API
+ and if the callback is NULL then the API is not async and if provided
+ it may be async. For example;
+
+ SilcBool silc_pkcs_sign(SilcPrivateKey private_key,
+ unsigned char *src, SilcUInt32 src_len,
+ unsigned char *dst, SilcUInt32 dst_size,
+ SilcUInt32 *dst_len,
+ SilcBool compute_hash, SilcHash hash,
+ SilcPKCSSignCb async_sign,
+ void *async_sign_context);
+
+ (if this is done then there's no reason why the buffers in the
+ callbacks cannot be the ones user gives here) or allow only async:
+
+ SilcBool silc_pkcs_sign(SilcPrivateKey private_key,
+ unsigned char *src, SilcUInt32 src_len,
+ SilcBool compute_hash, SilcHash hash,
+ SilcPKCSSignCb async_sign,
+ void *async_sign_context);
+
+ or add new:
+
+ SilcBool silc_pkcs_sign_async(SilcPrivateKey private_key,
+ unsigned char *src, SilcUInt32 src_len,
+ SilcBool compute_hash, SilcHash hash,
+ SilcPKCSSignCb async_sign,
+ void *async_sign_context);
+
+ o Change PKCS Algorithm API to take SilcPKCSAlgorithm as argument to
+ encrypt, decrypt, sign and verify functions. We may need to for exmaple
+ check the alg->hash, supported hash functions. Maybe deliver it also
+ to all other functions in SilcPKCSAlgorithm to be consistent.
+
+ o Add DSS support. Take implementation from Tom or make it yourself.
- o system time, universal, generalized. (***DONE)
+ o Implement the defined SilcDH API. The definition is in
+ lib/silccrypt/silcdh.h.
+ o All cipher, hash, hmac etc. allocation routines should take their name
+ in as const char * not const unsigned char *.
-lib/silcutil/silcfsm.[ch] ****DONE****
-=========================
+ o ECDSA and ECDH
- o SILC Finite State Machine API. Replaces SILC Protocol API (***DONE)
+SILC Accelerator Library
+========================
-lib/silcutil/silcnet*, lib/silcutil/*/silc*net* ****PARTLY DONE****
-===============================================
+ o SILC Accelerator API. Provides generic way to use different kind of
+ accelerators. Basically implements SILC PKCS API so that SilcPublicKey
+ and SilcPrivateKey can be used but they call the accelerators.
- o Add UDP interface (***DONE)
+ Something in the lines of (preliminary):
- o Add UDP interface for WIN32
+ /* Register accelerator to system */
+ SilcBool silc_acc_register(const SilcAccelerator acc);
- o New network interfaces (***DONE)
+ /* Unregister accelerator */
+ SilcBool silc_acc_unregister(const SilcAccelerator acc);
+ /* Find existing accelerator. `name' is accelerators name and
+ `params' is optional accelerator specific parameters. */
+ SilcAccelerator silc_acc_find(const char *name, const char *params);
-lib/silcsftp
-============
+ /* Return accelerator's displayable name */
+ const char *silc_ac_get_display_name(SilcAccelerator acc);
+
+ /* Accelerate `public_key'. Return accelerated public key. */
+ SilcPublicKey silc_acc_public_key(SilcAccelerator acc,
+ SilcPublicKey public_key);
+
+ /* Accelerate `private_key'. Returns accelerated private key. */
+ SilcPrivateKey silc_acc_private_key(SilcAccelerator acc,
+ SilcPrivateKey private_key);
+
+ /* Return the underlaying public key */
+ SilcPublicKey silc_acc_get_public_key(SilcAccelerator acc,
+ SilcPublicKey public_key);
+
+ /* Return the underlaying private key */
+ SilcPrivateKey silc_acc_get_private_key(SilcAccelerator acc,
+ SilcPrivateKey private_key);
+
+ typedef struct SilcAcceleratorObject {
+ const char *name; /* Accelerator's name */
+ const char *display_name; /* Displayable name */
+ SilcAcceleratorType type; /* Accelerator type */
+ union {
+ struct {
+ SilcPKCSObject *pkcs; /* Accelerator PKCS*/
+ SilcPKCSAlgorithm *algorithm; /* Accelerator Alg, may be
+ NULL */
+ } pkcs;
+
+ struct {
- o Porting to use the new util library.
+ } cipher;
+ } u;
+ } *SilcAccelerator, SilcAcceleratorStruct;
+ SilcPublicKey->SilcSILCPublicKey->RsaPublicKey accelerated as:
+ SilcPublicKey->SilcAcceleratorSoftware->SilcSILCPublicKey->RsaPublicKey or
+ SilcPublicKey->SilcAcceleratorPublicKey->SilcAcceleratorSoftware->
+ SilcSILCPublicKey->RsaPublicKey
-lib/silcutil/epoc/*
-===================
+ The former one if u.pkcs.algorithm == NULL.
- o lib/silcutil/epoc routines missing or not completed.
+ o Implement software accelerator. It is a thread pool system where the
+ public key and private key operations are executed in threads.
- o The PKCS#1 also calls global RNG (even though it is not used
- currently in SILC, the interface allows its use).
+ This implements SilcPKCSAlgorithm (and SilcPKCSObject if needed) that
+ implements the thread acclerated system.
- 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 Symmetric key cryptosystem acceleration? They are always sycnhronouos
+ even with hardware acceleration so the crypto API shouldn't require
+ changes.) maybe
lib/silcmath
increased memory consumption with TFM, and the rare need for public
key operations in server.
+ We want TFM's speed but not TFM's memory requirements. Talk to Tom
+ about making the TFM mp dynamic just as it is in LTM.
+
o The SILC MP API function must start returning indication of success
and failure of the operation.
o All utility functions should be made non-allocating ones.
-lib/silcasn1 ****PARTLY DONE****
+SILC XML Library, lib/silcxml/
+==============================
+
+ o SILC XML API (wrapper to expat). The SILC XML API should follow and
+ resemble Simple API for XML (SAX).
+
+
+lib/silcske/silcske.[ch]
+========================
+
+ o Ratelimit to UDP/IP transport for incoming packets.
+
+
+lib/silcasn1
============
- o ASN.1 library (***DONE)
+ o Negative integer encoding is missing, add it.
+
+ o SILC_ASN1_CHOICE should perhaps return an index what choice in the
+ choice list was found. Currently it is left for caller to figure out
+ which choice was found.
+
+ o SILC_ASN1_NULL in decoding should return SilcBool whether or not
+ the NULL was present. It's important when it's SILC_ASN1_OPTIONAL
+ and we need to know whether it was present or not.
+
+
+lib/silcpgp
+===========
+
+ o OpenPGP certificate support, allowing the use of PGP public keys
+ in SILC.
- o Header documentation missing. (***DONE)
- o Some string encodings missing (copy/paste matter). (***DONE)
+lib/silcssh
+===========
- o Negative integer encoding
+ o SSH2 public key/private key support, allowing the use of SSH2 keys
+ in SILC. RFC 4716.
lib/silcpkix
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)
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).
+ to everybody on the channel.
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
key ends up being used.
o The CMODE cipher & hmac change problem (#101).
-
-
-lib/silcclient
-==============
-
- o Some form of rewrite to make it more efficient.
-
- o Clear up interfaces.
-
- o Remove silc_client_run and silc_client_run_one from calling SilcSchedule.
- Leave the scheduling entirely to application.