-General
-=======
-
- 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:
-
- SILC Toolkit SILC protocol, client and server library
- SILC Runtime Toolkit runtime library
- SILC Crypto Toolkit crypto, asn1, math, skr, pgp, etc.
-
- 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.
-
- 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 SILC_PACKET_FLAG_ACK support. Implement ACK packet and packet payload
- to silcpacket.c.
-
- 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 UDP SILC connection support to SILC server
-
- 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
- client_prvmsg.c.
-
- 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 Add the SilcStream (socket stream) from the SilcPacketStream and
- SilcSocket from the socket stream to SilcClientConnection for easier
- access to them for programmers. Currently these have to be digged up
- from the packet stream.
-
- o Connection option that attemps to connect to remot host with various
- different mechanisms: UDP 706, TCP 706, TCP 80, TCP 443, UDP 7706 and
- TCP 7706. This is the so called hole punching mechanism.
-
- o Message ACKing support.
-
- 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 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.
-
- o Ability to recover from rekey errors, at least try to.
-
-
-Runtime library, lib/silcutil/
-==============================
-
- o Fix universal time decoding (doesn't accept all formats) in silctime.c.
-
- 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]. (***TESTING NEEDED WIN32, TODO Symbian)
-
- o Add directory opening/traversing functions
-
- o silc_getopt routines
-
- o 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.
-
- 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 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, ...);
-
- 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);
- ...
- }
-
- 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
- duplicated and later freed) which is not very nice.
-
- o If the event signals are added, the SILC_PARAM_* stuff needs to be
- moved from silcbuffmt.h to silctypes.h or something similar.
-
- 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.
-
- SilcSchedule silc_schedule_init(int max_tasks, void *app_context,
- 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
- delivering tasks wakeup is not needed.
-
- o Structured log messages to Log API. Allows machine readable log
- messages. Would allow sending of any kind of data in a log message.
-
- o Base64 to an own API (***DONE)
-
- o Timer API (***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_stringprep to non-allocating version.
-
- o silc_hash_table_replace -> silc_hash_table_set. Retain support for
- silc_hash_table_replace as macro. (***DONE)
-
- o SilcStack aware SilcHashTable. (***DONE)
-
- o SilcStack aware SilcDList. (***DONE)
-
- o Thread pool API. Add this to lib/silcutil/silcthread.[ch]. (***DONE)
-
- o Fast mutex implementation. Fast rwlock implementation. Mutex and
- rwlock implementation using atomic operations.
-
- o Compression routines are missing. The protocol supports packet
- compression thus it must be implemented. SILC Zip API must be
- defined.
-
- 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)
-
- o silc_stack_alloc shouldn't require multiple by 8 size argument, it
- should figure it out itself.
-
- o silc_malloc et. al. to respect --with-alignment.
-
- o Add '%@' format to silc_snprintf functions. It marks for external
- rendering function of following type:
-
- /* 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);
-
- It can work like following:
-
- char *id_renderer(void *data)
- {
- char tmp[32];
- id_to_str(tmp, sizeof(tmp), (SilcID *)data);
- return strdup(tmp);
- }
-
- silc_snprintf(buf, sizeof(buf), "Client ID %@", id_renderer, client_id);
- (***DONE)
-
- 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)
-
- (o SilcIpAddr abstraction. Ipv4 and Ipv6 support to the abstaction.)
- maybe
-
- (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
-
- (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 mmap) maybe
-
-
-lib/silcutil/symbian/
-=====================
-
- 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.
-
-
-SFTP Library, lib/silcsftp/
-===========================
-
- o Read prefetch (read-ahead, reading ahead of time). Maybe if this can
- be done easily.
-
-