(***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
+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.
o All payload encoding routines should take SilcStack as argument.
+ o Remove SilcCommandCb from silccommand.h.
+
o All payload test routines into lib/silccore/tests/.
lib/silcclient, The Client Library
==================================
+ o Giving WHOIS for nick that doesn't exist should remove any same
+ named entries from the client cache.
+
o peer-to-peer private messages
o Private message key request notification to application. See XXX in
could be just some "string", which would then match to "string.pub" and
"string.prv".
+ o If the SILC Events (see below) are implemented, perhaps client library
+ should provide events so that application developer has a choice of
+ developing the SILC app with callbacks or with events.
+
Runtime library, lib/silcutil/
==============================
o Fix universal time decoding (doesn't accept all formats) in silctime.c.
- 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);
+ o Add functions to manipulate environment variables. (***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].
-
- 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);
+ to lib/silcutil/silcdll.[ch]. (***TESTING NEEDED WIN32, TODO Symbian)
o Add directory opening/traversing functions
o silc_getopt routines
- o silc_hash_table_replace -> silc_hash_table_set. Retain support for
- silc_hash_table_replace as macro.
-
o The SILC Event signals. Asynchronous events that can be created,
connected to and signalled. Either own event routines or glued into
SilcSchedule:
va_list args;
SilcUInt32 integer;
SilcBuffer buf;
-
+
va_start(args, context);
integer = va_arg(args, SilcUInt32);
buf = va_arg(args, SilcBuffer);
...
}
- Problems: Events would be SilcSchedule specific, and would not work on
- multi-thread/multi-scheduler system. The events should be copyable
+ Problems: Events would be SilcSchedule specific, and would not work on
+ multi-thread/multi-scheduler system. The events should be copyable
between schedulers. Another problem is the signal delivery. Do we
deliver them synchronously possibly from any thread to any other thread
or do we deliver them through the target schedulers. If we use the
- schedulers then signalling would be asynchronous (data must be
+ schedulers then signalling would be asynchronous (data must be
duplicated and later freed) which is not very nice.
o If the event signals are added, the SILC_PARAM_* stuff needs to be
SilcSchedule parent);
SilcSchedule silc_schedule_get_parent(SilcSchedule schedule);
- o Additional scheduler changes: optimize silc_schedule_wakeup. Wakeup
- only if the scheduler is actually waiting something. If it is
+ 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 Structured log messages to Log API. Allows machine readable log
o silc_stringprep to non-allocating version.
- o SilcStack aware SilcHashTable.
-
- o SilcStack aware SilcDList.
-
- o Thread pool API. Add this to lib/silcutil/silcthread.[ch].
+ o silc_hash_table_replace -> silc_hash_table_set. Retain support for
+ silc_hash_table_replace as macro. (***DONE)
- typedef void (*SilcThreadPoolFunc)(SilcSchedule schedule,
- void *context);
+ o SilcStack aware SilcHashTable. (***DONE)
- /* 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);
+ o SilcStack aware SilcDList. (***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 Thread pool API. Add this to lib/silcutil/silcthread.[ch]. (***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.
+ o Fast mutex implementation. Fast rwlock implementation. Mutex and
+ rwlock implementation using atomic operations.
- 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);
+ o Compression routines are missing. The protocol supports packet
+ compression thus it must be implemented. SILC Zip API must be
+ defined.
- /* Modify the amount of maximum threads of the pool. */
- void silc_thread_pool_set_max_threads(SilcThreadPool tp,
- SilcUInt32 max_threads);
+ 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)
- /* Returns the amount of maximum size the pool can grow. */
- SilcUInt32 silc_thread_pool_num_max_threads(SilcThreadPool tp);
+ o Add '%@' format to silc_snprintf functions. It marks for external
+ rendering function of following type:
- /* Returns the amount of free threads in the pool currently. */
- SilcUInt32 silc_thread_pool_num_free_threads(SilcThreadPool tp);
+ /* Snprintf rendering function. The `data' is rendered into a string
+ and allocated string is returned. If NULL is returned the
+ rendering is skipped and ignored. If the returned string does
+ not fit to the destination buffer it may be truncated. */
+ typedef char *(*SilcSnprintfRender)(void *data);
- /* Stops all free and started threads. The minumum amount of threads
- specified to silc_thread_pool_alloc always remains. */
- void silc_thread_pool_purge(SilcThreadPool tp);
+ It can work like following:
- o Fast mutex implementation. Fast rwlock implementation. Mutex and
- rwlock implementation using atomic operations.
+ char *id_renderer(void *data)
+ {
+ char tmp[32];
+ id_to_str(tmp, sizeof(tmp), (SilcID *)data);
+ return strdup(tmp);
+ }
- o Compression routines are missing. The protocol supports packet
- compression thus it must be implemented. SILC Zip API must be
- defined.
+ silc_snprintf(buf, sizeof(buf), "Client ID %@", id_renderer, client_id);
- (o Generic SilcStatus or SilcResult that includes all possible status and
+ (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
+ protocol related status (currently in silcstatus.h) cannot be in
runtime library) maybe
(o SILC specific socket creation/closing routines to silcnet.h, wrappers
SILC_SKR_FIND_CONTEXT, key_context,
SILC_SKR_FIND_END);
+ o SilcStack to SKR API.
+
Crypto Library, lib/silccrypt/
==============================
+ o SilcStack to APIs.
+
o Add fingerprint to SilcSILCPublicKey and retrieval to silcpk.h, and
possibly to silcpkcs.h.
SilcPKCSSignCb async_sign,
void *async_sign_context);
- (if this is done then there's no reason why the buffers in the
+ (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,
==============================
o SILC XML API (wrapper to expat). Look at the expat API and simplify
- it. The SILC XML API should have at most 8-10 API functions. It should
- be possible to create full XML parser with only one function. And, it
+ it. The SILC XML API should have at most 8-10 API functions. It should
+ be possible to create full XML parser with only one function. And, it
should be possible to have a function that is able to parse an entire
XML document. It should also have a parser function to be able to
parse a stream of XML data (SilcStream). It MUST NOT have operations
o PKIX implementation
+apps/silcd
+==========
+
+ o Deprecate the old server. Write interface for the new lib/silcserver
+ server library. The interface should work on Unix/Linux systems.
+
+ o Consider deprecating also the old config file format and use XML
+ istead. This should require SILC XML API implementation first.
+
+ o The configuration must support dynamic router and server connections.
+ The silcd must work without specifying any servers or routers to
+ connect to.
+
+ o The configuration must support specifying whether the server is
+ SILC Server or SILC Router. This should not be deduced from the
+ configuration as it was in < 1.2.
+
+ o The configuration must support specifying the ciphers and hmacs and
+ their order so that user can specify which algorithms take preference.
+
+
lib/silcserver
==============
- o (Re)write commands/command replys.
+ o Rewrite the entire server. Deprecate apps/silcd as the main server
+ implementation and create lib/silcserver/. It is a platform
+ independent server library. The apps/silcd will merely provide a
+ a simple interface for the library.
+
+ o Write the SILC Server library extensively using SILC FSM.
+
+ o Server library must support multiple networks. This means that one
+ server must be able to create multiple connections that each reach
+ different SILC network. This means also that all cache's etc. must
+ be either connection-specific or network-specific.
+
+ o Library must support dynamic router and server connections. This means
+ that connections are create only when they are needed, like when someone
+ says JOIN foo@foo.bar.com or WHOIS foobar@silcnet.org.
- o (Re)write notify handling.
+ o Library must support server-to-server connections even though protocol
+ prohibits that. The responder of the connection should automatically
+ act as a router. The two servers create an own, isolated, SILC network.
+ To be used specifically with dynamic connections.
+
+ o Library must support multiple threads and must be entirely thread safe.
+
+ o Library must have support for SERVICE command.
+
+ o The server must be able to run behind NAT device. This means that
+ Server ID must be based on public IP instead of private IP.
+
+ o The following data must be in per-connection context: client id cache,
+ server id cache, channel id cache, all statistics must be
+ per-connection.
+
+ o The following data must be in per-thread context: command context
+ freelist/pool, pending commands, random number generator.
+
+ o Do inccoming packet processing in an own FSM thread in the
+ server-threads FSM. Same as in client library.
+
+ o Reference count all Silc*Entry structures.
+
+ Some issues that must be kept in mind from 1.0 and 1.1 silcd's:
o The SERVER_SIGNOFF notify handing is not optimal, because it'll
cause sending of multiple SIGNOFF notify's instead of the one
done per channel. It shouldn't receive the whole list just
because one client happened to be on same channel.
- 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!
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