1 TODO for 1.2 And Beyond
2 =======================
4 NOTE: Any item that doesn't have (***DONE) in it, isn't done yet. The
5 (***TESTING NEEDED) means that the item has been done but not yet properly
8 NOTE: A TODO entry does not mean that it is ever going to be done. Some
9 of the entries may be just ideas, good, bad or ugly. If you want to work
10 on some of the TODO entries simply let us know about it by dropping a note
11 to silc-devel mailing list or appear on 'silc' channel on SILCNet.
17 o Create apps/tutorial containing various Toolkit API tutorials.
19 o The Toolkit split. The Toolkit is to be splitted in parts. How many
20 parts and what the parts are isn't decided yet. Each part is a separate
21 software package. Current thinking is of the following:
23 SILC Toolkit SILC protocol, client and server library
24 SILC Runtime Toolkit runtime library
25 SILC Crypto Toolkit crypto, asn1, math, skr, pgp, etc.
27 The rationale for this is of course that other than SILC projects
28 might like to use the various libraries SILC Toolkit provides, but
29 naturally they don't want the bloat of SILC protocol related stuff.
31 The Runtime library in SILC Toolkit is a general purpose runtime library,
32 like Glib and APR are. The runtime library is to be developed further
33 to provide alternative to Glib and APR.
35 The Crypto library in SILC Toolkit is a general purpose crypto library
36 providing pretty nice APIs compared to many other crypto libraries,
37 especially OpenSSL. The Crypto library is to be developed further
38 to include support for OpenPGP, X.509 and SSH2.
44 o SILC_PACKET_FLAG_ACK support. Implement ACK packet and packet payload
47 o All payload encoding routines should take SilcStack as argument.
49 o All payload test routines into lib/silccore/tests/.
52 lib/silcclient, The Client Library
53 ==================================
55 o peer-to-peer private messages
57 o Private message key request notification to application. See XXX in
60 o in JOIN notify handle resolving that timedout. Currently the user is
61 never joined the channel if this happens. What to do if message is
62 received from user that hasn't been resolved/joined?
64 o Message ACKing support.
66 o in /cmode and /cumode with +r, maybe the public key and private key
67 could be just some "string", which would then match to "string.pub" and
71 Runtime library, lib/silcutil/
72 ==============================
74 o Fix universal time decoding (doesn't accept all formats) in silctime.c.
76 o Add functions to manipulate environment variables.
78 SilcBool silc_setenv(const char *variable, const char *value);
79 const char *silc_getenv(const char *variable);
80 SilcBool silc_clearenv(const char *variable);
82 o Add functions to loading shared/dynamic object symbols (replaces the
83 SIM library (lib/silcsim) and introduces generic library).
85 SilcDll silc_dll_load(const char *object_path, SilcDllFlags flags);
86 void silc_dll_close(SilcDll dll);
87 void *silc_dll_getsym(SilcDll dll, const char *symbol);
88 const char *silc_dll_error(SilcDll dll);
90 o Add directory opening/traversing functions
92 o silc_getopt routines
94 o silc_hash_table_replace -> silc_hash_table_set. Retain support for
95 silc_hash_table_replace as macro.
97 o The SILC Event signals. Asynchronous events that can be created,
98 connected to and signalled. Either own event routines or glued into
101 SilcTask silc_schedule_task_add_event(SilcSchedule schedule,
102 const char *event, ...);
103 SilcBool silc_schedule_event_connect(SilcSchedule schedule,
105 SilcTaskCallback event_callback,
107 SilcBool silc_schedule_event_signal(SilcSchedule schedule,
108 const char *event, ...);
111 silc_schedule_task_add_event(schedule, "connected",
115 silc_schedule_event_connect(schedule, "connected", connected_cb, ctx);
116 silc_schedule_event_signal(schedule, "connected", integer, buf,
118 SILC_TASK_CALLBACK(connected_cb)
120 FooCtx ctx = context;
125 va_start(args, context);
126 integer = va_arg(args, SilcUInt32);
127 buf = va_arg(args, SilcBuffer);
132 Problems: Events would be SilcSchedule specific, and would not work on
133 multi-thread/multi-scheduler system. The events should be copyable
136 o Structured log messages to Log API. Allows machine readable log
137 messages. Would allow sending of any kind of data in a log message.
139 o Base64 to an own API
143 o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
144 SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
147 o silc_stringprep to non-allocating version.
149 o SilcStack aware SilcHashTable.
151 o SilcStack aware SilcDList.
155 typedef void (*SilcThreadPoolFunc)(SilcSchedule schedule,
158 /* Allocate thread pool with at least `min_threads' and at most
159 `max_threads' many threads. If `stack' is non-NULL all memory
160 is allocated from the `stack'. If `start_min_threads' is TRUE
161 this will start `min_threads' many threads immediately. */
162 SilcThreadPool silc_thread_pool_alloc(SilcStack stack,
163 SilcUInt32 min_threads,
164 SilcUInt32 max_threads,
165 SilcBool start_min_threads);
167 /* Free thread pool. If `wait_unfinished' is TRUE this will block
168 and waits that all remaining active threads finish before freeing
170 void silc_thread_pool_free(SilcThreadPool tp, SilcBool wait_unfinished);
172 /* Run `run' function with `run_context' in one of the threads in the
173 thread pool. Returns FALSE if the thread pool is being freed. If
174 there are no free threads left in the pool this will queue the
175 the `run' and will call it once a thread becomes free.
177 If `completion' is non-NULL it will be called to indicate completion
178 of the `run' function. If `schedule' is non-NULL the `completion'
179 will be called through the scheduler in the main thread. If it is
180 NULL the `completion' is called directly from the thread after the
181 `run' has returned. */
182 SilcBool silc_thread_pool_run(SilcThreadPool tp,
183 SilcSchedule schedule,
184 SilcThreadPoolFunc run,
186 SilcThreadPoolFunc completion,
187 void *completion_context);
189 /* Modify the amount of maximum threads of the pool. */
190 void silc_thread_pool_set_max_threads(SilcThreadPool tp,
191 SilcUInt32 max_threads);
193 /* Returns the amount of maximum size the pool can grow. */
194 SilcUInt32 silc_thread_pool_get_max_threads(SilcThreadPool tp);
196 /* Returns the amount of free threads in the pool currently. */
197 SilcUInt32 silc_thread_pool_get_free_threads(SilcThreadPool tp);
199 /* Stops all free and started threads. The minumum amount of threads
200 specified to silc_thread_pool_alloc always remains. */
201 void silc_thread_pool_stop_free_threads(SilcThreadPool tp);
203 o Fast mutex implementation. Fast rwlock implementation. Mutex and
204 rwlock implementation using atomic operations.
206 o Compression routines are missing. The protocol supports packet
207 compression thus it must be implemented. SILC Zip API must be
210 (o Generic SilcStatus or SilcResult that includes all possible status and
211 error conditions, including those of SILC protocol. Though, the SILC
212 protocol related status (currently in silcstatus.h) cannot be in
213 runtime library) maybe
215 (o SILC specific socket creation/closing routines to silcnet.h, wrappers
216 to all send(), recv(), sendto() etc. Bad thing is that we'd have to
217 define all socket options, sockaddrs, etc.) maybe
222 lib/silcutil/symbian/
223 =====================
225 o Something needs to be thought to the logging globals as well,
226 like silc_debug etc. They won't work on EPOC. Perhaps logging
227 and debugging is to be disabled on EPOC. The logging currently works
228 by it cannot be controlled, same with debugging.
231 SFTP Library, lib/silcsftp/
232 ===========================
234 o Read prefetch (read-ahead, reading ahead of time). Maybe if this can
238 SKR Library, lib/silcskr/
239 =========================
241 o Add fingerprint as search constraint.
243 o Add OpenPGP support. Adding, removing, fetching PGP keys. (Keyring
246 o Add support for importing public keys from a directory and/or from a
247 file. Add support for exporting the repository (different formats for
248 different key types?).
250 o Change the entire silc_skr_find API. Remove SilcSKRFind and just simply
251 add the find constraints as variable argument list to silc_skr_find, eg:
253 silc_skr_find(skr, schedule, callback, context,
254 SILC_SKR_FIND_PUBLIC_KEY, public_key,
255 SILC_SKR_FIND_COUNTRY, "FI",
256 SILC_SKR_FIND_USAGE, SILC_SKR_USAGE_AUTH,
259 NULL argument would be ignored and skipped.
261 o Add OR logical rule in addition of the current default AND, eg:
263 // Found key(s) MUST have this public key AND this country.
264 silc_skr_find(skr, schedule, callback, context,
265 SILC_SKR_FIND_RULE_AND,
266 SILC_SKR_FIND_PUBLIC_KEY, public_key,
267 SILC_SKR_FIND_COUNTRY, "FI",
270 // Found key(s) MUST have this public key OR this key context
271 silc_skr_find(skr, schedule, callback, context,
272 SILC_SKR_FIND_RULE_OR,
273 SILC_SKR_FIND_PUBLIC_KEY, public_key,
274 SILC_SKR_FIND_CONTEXT, key_context,
278 Crypto Library, lib/silccrypt/
279 ==============================
281 o Add fingerprint to SilcSILCPublicKey and retrieval to silcpk.h, and
282 possibly to silcpkcs.h.
284 /* Return fingerprint of the `public_key'. Returns also the algorithm
285 that has been used to make the fingerprint. */
286 const unsigned char *
287 silc_pkcs_get_fingerprint(SilcPublicKey public_key,
288 const char **hash_algorithm,
289 SilcUInt32 *fingerprint_len);
291 o Change SILC PKCS API to asynchronous, so that accelerators can be used.
292 All PKCS routines should now take callbacks as argument and they should
293 be delivered to SilcPKCSObject and SilcPKCSAlgorithm too.
295 /* Signature computation callback */
296 typedef void (*SilcPKCSSignCb)(SilcBool success,
297 const unsigned char *signature,
298 SilcUInt32 signature_len,
301 /* Signature verification callback */
302 typedef void (*SilcPKCSVerifyCb)(SilcBool success, void *context);
304 /* Encryption callback */
305 typedef void (*SilcPKCSEncryptCb)(SilcBool success,
306 const unsigned char *encrypted,
307 SilcUInt32 encrypted_len,
310 /* Decryption callback */
311 typedef void (*SilcPKCSDecryptCb)(SilcBool success,
312 const unsigned char *decrypted,
313 SilcUInt32 decrypted_len,
316 Either add new _async functions or add the callbacks to existing API
317 and if the callback is NULL then the API is not async and if provided
318 it may be async. For example;
320 SilcBool silc_pkcs_sign(SilcPrivateKey private_key,
321 unsigned char *src, SilcUInt32 src_len,
322 unsigned char *dst, SilcUInt32 dst_size,
324 SilcBool compute_hash, SilcHash hash,
325 SilcPKCSSignCb async_sign,
326 void *async_sign_context);
328 (if this is done then there's no reason why the buffers in the
329 callbacks cannot be the ones user gives here) or allow only async:
331 SilcBool silc_pkcs_sign(SilcPrivateKey private_key,
332 unsigned char *src, SilcUInt32 src_len,
333 SilcBool compute_hash, SilcHash hash,
334 SilcPKCSSignCb async_sign,
335 void *async_sign_context);
339 SilcBool silc_pkcs_sign_async(SilcPrivateKey private_key,
340 unsigned char *src, SilcUInt32 src_len,
341 SilcBool compute_hash, SilcHash hash,
342 SilcPKCSSignCb async_sign,
343 void *async_sign_context);
345 o Change PKCS Algorithm API to take SilcPKCSAlgorithm as argument to
346 encrypt, decrypt, sign and verify functions. We may need to for exmaple
347 check the alg->hash, supported hash functions. Maybe deliver it also
348 to all other functions in SilcPKCSAlgorithm to be consistent.
350 o Add DSS support. Take implementation from Tom or make it yourself.
352 o Implement the defined SilcDH API. The definition is in
353 lib/silccrypt/silcdh.h.
355 o All cipher, hash, hmac etc. allocation routines should take their name
356 in as const char * not const unsigned char *.
361 SILC Accelerator Library
362 ========================
364 o SILC Accelerator API. Provides generic way to use different kind of
365 accelerators. Basically implements SILC PKCS API so that SilcPublicKey
366 and SilcPrivateKey can be used but they call the accelerators.
368 Something in the lines of (preliminary):
370 /* Register accelerator to system */
371 SilcBool silc_acc_register(const SilcAccelerator acc);
373 /* Unregister accelerator */
374 SilcBool silc_acc_unregister(const SilcAccelerator acc);
376 /* Find existing accelerator. `name' is accelerators name and
377 `params' is optional accelerator specific parameters. */
378 SilcAccelerator silc_acc_find(const char *name, const char *params);
380 /* Return accelerator's displayable name */
381 const char *silc_ac_get_display_name(SilcAccelerator acc);
383 /* Accelerate `public_key'. Return accelerated public key. */
384 SilcPublicKey silc_acc_public_key(SilcAccelerator acc,
385 SilcPublicKey public_key);
387 /* Accelerate `private_key'. Returns accelerated private key. */
388 SilcPrivateKey silc_acc_private_key(SilcAccelerator acc,
389 SilcPrivateKey private_key);
391 /* Return the underlaying public key */
392 SilcPublicKey silc_acc_get_public_key(SilcAccelerator acc,
393 SilcPublicKey public_key);
395 /* Return the underlaying private key */
396 SilcPrivateKey silc_acc_get_private_key(SilcAccelerator acc,
397 SilcPrivateKey private_key);
399 typedef struct SilcAcceleratorObject {
400 const char *name; /* Accelerator's name */
401 const char *display_name; /* Displayable name */
402 SilcAcceleratorType type; /* Accelerator type */
405 SilcPKCSObject *pkcs; /* Accelerator PKCS*/
406 SilcPKCSAlgorithm *algorithm; /* Accelerator Alg, may be
414 } *SilcAccelerator, SilcAcceleratorStruct;
416 SilcPublicKey->SilcSILCPublicKey->RsaPublicKey accelerated as:
417 SilcPublicKey->SilcAcceleratorSoftware->SilcSILCPublicKey->RsaPublicKey or
418 SilcPublicKey->SilcAcceleratorPublicKey->SilcAcceleratorSoftware->
419 SilcSILCPublicKey->RsaPublicKey
421 The former one if u.pkcs.algorithm == NULL.
423 o Implement software accelerator. It is a thread pool system where the
424 public key and private key operations are executed in threads.
426 This implements SilcPKCSAlgorithm (and SilcPKCSObject if needed) that
427 implements the thread acclerated system.
429 (o Symmetric key cryptosystem acceleration? They are always sycnhronouos
430 even with hardware acceleration so the crypto API shouldn't require
437 o Import TFM. Talk to Tom to add the missing functions. Use TFM in
438 client and client library, but TMA in server, due to the significantly
439 increased memory consumption with TFM, and the rare need for public
440 key operations in server.
442 We want TFM's speed but not TFM's memory requirements. Talk to Tom
443 about making the TFM mp dynamic just as it is in LTM.
445 o The SILC MP API function must start returning indication of success
446 and failure of the operation.
448 o Do SilcStack support for silc_mp_init, silc_mp_init_size and other
449 any other MP function (including utility ones) that may allocate
452 o All utility functions should be made non-allocating ones.
455 SILC XML Library, lib/silcxml/
456 ==============================
458 o SILC XML API (wrapper to expat). The SILC XML API should follow and
459 resemble Simple API for XML (SAX).
462 lib/silcske/silcske.[ch]
463 ========================
465 o Ratelimit to UDP/IP transport for incoming packets.
471 o Negative integer encoding is missing, add it.
473 o SILC_ASN1_CHOICE should perhaps return an index what choice in the
474 choice list was found. Currently it is left for caller to figure out
475 which choice was found.
477 o SILC_ASN1_NULL in decoding should return SilcBool whether or not
478 the NULL was present. It's important when it's SILC_ASN1_OPTIONAL
479 and we need to know whether it was present or not.
485 o OpenPGP certificate support, allowing the use of PGP public keys
492 o SSH2 public key/private key support, allowing the use of SSH2 keys
499 o PKIX implementation
505 o (Re)write commands/command replys.
507 o (Re)write notify handling.
509 o The SERVER_SIGNOFF notify handing is not optimal, because it'll
510 cause sending of multiple SIGNOFF notify's instead of the one
511 SERVER_SIGNOFF notify that the server received. This should be
512 optimized so that the only SERVER_SIGNOFF is sent and not
513 SIGNOFF of notify at all (using SIGNOFF takes the idea about
514 SERVER_SIGNOFF away entirely).
516 o Another SERVER_SIGNOFF opt/bugfix: Currently the signoff is
517 sent to a client if it is on same channel as the client that
518 signoffed. However, the entire SERVER_SIGNOFF list is sent to
519 the client, ie. it may receive clients that was not on the
520 same channel. This is actually against the specs. It must be
521 done per channel. It shouldn't receive the whole list just
522 because one client happened to be on same channel.
524 o Add reference counters to all Silc*Entry structures
526 o SERVICEs support (plugin, SIM)
528 o If client's public key is saved in the server (and doing public key
529 authentication) then the hostname and the username information could
530 be taken from the public key. Should be a configuration option!
532 o Add a timeout to handling incoming JOIN commands. It should be
533 enforced that JOIN command is executed only once in a second or two
534 seconds. Now it is possible to accept n incoming JOIN commands
535 and process them without any timeouts. THis must be employed because
536 each JOIN command will create and distribute the new channel key
537 to everybody on the channel.
539 o Related to above. If multiple JOINs are received in sequence perhaps
540 new key should be created only once, if the JOINs are handeled at the same
541 time. Now we create multiple keys and never end up using them because
542 many JOINs are processed at the same time in sequence. Only the last
543 key ends up being used.
545 o The CMODE cipher & hmac change problem (#101).