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). Add this
84 to lib/silcutil/silcdll.[ch].
86 SilcDll silc_dll_load(const char *object_path, SilcDllFlags flags);
87 void silc_dll_close(SilcDll dll);
88 void *silc_dll_getsym(SilcDll dll, const char *symbol);
89 const char *silc_dll_error(SilcDll dll);
91 o Add directory opening/traversing functions
93 o silc_getopt routines
95 o silc_hash_table_replace -> silc_hash_table_set. Retain support for
96 silc_hash_table_replace as macro.
98 o The SILC Event signals. Asynchronous events that can be created,
99 connected to and signalled. Either own event routines or glued into
102 SilcTask silc_schedule_task_add_event(SilcSchedule schedule,
103 const char *event, ...);
104 SilcBool silc_schedule_event_connect(SilcSchedule schedule,
106 SilcTaskCallback event_callback,
108 SilcBool silc_schedule_event_signal(SilcSchedule schedule,
109 const char *event, ...);
112 silc_schedule_task_add_event(schedule, "connected",
116 silc_schedule_event_connect(schedule, "connected", connected_cb, ctx);
117 silc_schedule_event_signal(schedule, "connected", integer, buf,
119 SILC_TASK_CALLBACK(connected_cb)
121 FooCtx ctx = context;
126 va_start(args, context);
127 integer = va_arg(args, SilcUInt32);
128 buf = va_arg(args, SilcBuffer);
133 Problems: Events would be SilcSchedule specific, and would not work on
134 multi-thread/multi-scheduler system. The events should be copyable
137 o If the event signals are added, the SILC_PARAM_* stuff needs to be
138 moved from silcbuffmt.h to silctypes.h or something similar.
140 o Structured log messages to Log API. Allows machine readable log
141 messages. Would allow sending of any kind of data in a log message.
143 o Base64 to an own API
147 o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
148 SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
151 o silc_stringprep to non-allocating version.
153 o SilcStack aware SilcHashTable.
155 o SilcStack aware SilcDList.
157 o Thread pool API. Add this to lib/silcutil/silcthread.[ch].
159 typedef void (*SilcThreadPoolFunc)(SilcSchedule schedule,
162 /* Allocate thread pool with at least `min_threads' and at most
163 `max_threads' many threads. If `stack' is non-NULL all memory
164 is allocated from the `stack'. If `start_min_threads' is TRUE
165 this will start `min_threads' many threads immediately. */
166 SilcThreadPool silc_thread_pool_alloc(SilcStack stack,
167 SilcUInt32 min_threads,
168 SilcUInt32 max_threads,
169 SilcBool start_min_threads);
171 /* Free thread pool. If `wait_unfinished' is TRUE this will block
172 and waits that all remaining active threads finish before freeing
174 void silc_thread_pool_free(SilcThreadPool tp, SilcBool wait_unfinished);
176 /* Run `run' function with `run_context' in one of the threads in the
177 thread pool. Returns FALSE if the thread pool is being freed. If
178 there are no free threads left in the pool this will queue the
179 the `run' and will call it once a thread becomes free.
181 If `completion' is non-NULL it will be called to indicate completion
182 of the `run' function. If `schedule' is non-NULL the `completion'
183 will be called through the scheduler in the main thread. If it is
184 NULL the `completion' is called directly from the thread after the
185 `run' has returned. */
186 SilcBool silc_thread_pool_run(SilcThreadPool tp,
187 SilcSchedule schedule,
188 SilcThreadPoolFunc run,
190 SilcThreadPoolFunc completion,
191 void *completion_context);
193 /* Modify the amount of maximum threads of the pool. */
194 void silc_thread_pool_set_max_threads(SilcThreadPool tp,
195 SilcUInt32 max_threads);
197 /* Returns the amount of maximum size the pool can grow. */
198 SilcUInt32 silc_thread_pool_get_max_threads(SilcThreadPool tp);
200 /* Returns the amount of free threads in the pool currently. */
201 SilcUInt32 silc_thread_pool_get_free_threads(SilcThreadPool tp);
203 /* Stops all free and started threads. The minumum amount of threads
204 specified to silc_thread_pool_alloc always remains. */
205 void silc_thread_pool_stop_free_threads(SilcThreadPool tp);
207 o Fast mutex implementation. Fast rwlock implementation. Mutex and
208 rwlock implementation using atomic operations.
210 o Compression routines are missing. The protocol supports packet
211 compression thus it must be implemented. SILC Zip API must be
214 (o Generic SilcStatus or SilcResult that includes all possible status and
215 error conditions, including those of SILC protocol. Though, the SILC
216 protocol related status (currently in silcstatus.h) cannot be in
217 runtime library) maybe
219 (o SILC specific socket creation/closing routines to silcnet.h, wrappers
220 to all send(), recv(), sendto() etc. Bad thing is that we'd have to
221 define all socket options, sockaddrs, etc.) maybe
226 lib/silcutil/symbian/
227 =====================
229 o Something needs to be thought to the logging globals as well,
230 like silc_debug etc. They won't work on EPOC. Perhaps logging
231 and debugging is to be disabled on EPOC. The logging currently works
232 by it cannot be controlled, same with debugging.
235 SFTP Library, lib/silcsftp/
236 ===========================
238 o Read prefetch (read-ahead, reading ahead of time). Maybe if this can
242 SKR Library, lib/silcskr/
243 =========================
245 o Add fingerprint as search constraint.
247 o Add OpenPGP support. Adding, removing, fetching PGP keys. (Keyring
250 o Add support for importing public keys from a directory and/or from a
251 file. Add support for exporting the repository (different formats for
252 different key types?).
254 o Change the entire silc_skr_find API. Remove SilcSKRFind and just simply
255 add the find constraints as variable argument list to silc_skr_find, eg:
257 silc_skr_find(skr, schedule, callback, context,
258 SILC_SKR_FIND_PUBLIC_KEY, public_key,
259 SILC_SKR_FIND_COUNTRY, "FI",
260 SILC_SKR_FIND_USAGE, SILC_SKR_USAGE_AUTH,
263 NULL argument would be ignored and skipped.
265 o Add OR logical rule in addition of the current default AND, eg:
267 // Found key(s) MUST have this public key AND this country.
268 silc_skr_find(skr, schedule, callback, context,
269 SILC_SKR_FIND_RULE_AND,
270 SILC_SKR_FIND_PUBLIC_KEY, public_key,
271 SILC_SKR_FIND_COUNTRY, "FI",
274 // Found key(s) MUST have this public key OR this key context
275 silc_skr_find(skr, schedule, callback, context,
276 SILC_SKR_FIND_RULE_OR,
277 SILC_SKR_FIND_PUBLIC_KEY, public_key,
278 SILC_SKR_FIND_CONTEXT, key_context,
282 Crypto Library, lib/silccrypt/
283 ==============================
285 o Add fingerprint to SilcSILCPublicKey and retrieval to silcpk.h, and
286 possibly to silcpkcs.h.
288 /* Return fingerprint of the `public_key'. Returns also the algorithm
289 that has been used to make the fingerprint. */
290 const unsigned char *
291 silc_pkcs_get_fingerprint(SilcPublicKey public_key,
292 const char **hash_algorithm,
293 SilcUInt32 *fingerprint_len);
295 o Change SILC PKCS API to asynchronous, so that accelerators can be used.
296 All PKCS routines should now take callbacks as argument and they should
297 be delivered to SilcPKCSObject and SilcPKCSAlgorithm too.
299 /* Signature computation callback */
300 typedef void (*SilcPKCSSignCb)(SilcBool success,
301 const unsigned char *signature,
302 SilcUInt32 signature_len,
305 /* Signature verification callback */
306 typedef void (*SilcPKCSVerifyCb)(SilcBool success, void *context);
308 /* Encryption callback */
309 typedef void (*SilcPKCSEncryptCb)(SilcBool success,
310 const unsigned char *encrypted,
311 SilcUInt32 encrypted_len,
314 /* Decryption callback */
315 typedef void (*SilcPKCSDecryptCb)(SilcBool success,
316 const unsigned char *decrypted,
317 SilcUInt32 decrypted_len,
320 Either add new _async functions or add the callbacks to existing API
321 and if the callback is NULL then the API is not async and if provided
322 it may be async. For example;
324 SilcBool silc_pkcs_sign(SilcPrivateKey private_key,
325 unsigned char *src, SilcUInt32 src_len,
326 unsigned char *dst, SilcUInt32 dst_size,
328 SilcBool compute_hash, SilcHash hash,
329 SilcPKCSSignCb async_sign,
330 void *async_sign_context);
332 (if this is done then there's no reason why the buffers in the
333 callbacks cannot be the ones user gives here) or allow only async:
335 SilcBool silc_pkcs_sign(SilcPrivateKey private_key,
336 unsigned char *src, SilcUInt32 src_len,
337 SilcBool compute_hash, SilcHash hash,
338 SilcPKCSSignCb async_sign,
339 void *async_sign_context);
343 SilcBool silc_pkcs_sign_async(SilcPrivateKey private_key,
344 unsigned char *src, SilcUInt32 src_len,
345 SilcBool compute_hash, SilcHash hash,
346 SilcPKCSSignCb async_sign,
347 void *async_sign_context);
349 o Change PKCS Algorithm API to take SilcPKCSAlgorithm as argument to
350 encrypt, decrypt, sign and verify functions. We may need to for exmaple
351 check the alg->hash, supported hash functions. Maybe deliver it also
352 to all other functions in SilcPKCSAlgorithm to be consistent.
354 o Add DSS support. Take implementation from Tom or make it yourself.
356 o Implement the defined SilcDH API. The definition is in
357 lib/silccrypt/silcdh.h. Make sure it is asynchronous so that it can
358 be accelerated. Also take into account that it could use elliptic
363 o All cipher, hash, hmac etc. allocation routines should take their name
364 in as const char * not const unsigned char *.
367 SILC Accelerator Library
368 ========================
370 o SILC Accelerator API. Provides generic way to use different kind of
371 accelerators. Basically implements SILC PKCS API so that SilcPublicKey
372 and SilcPrivateKey can be used but they call the accelerators.
374 Something in the lines of (preliminary):
376 /* Register accelerator to system. Initializes the accelerator. */
377 Varargs are optional accelerator specific init parameteres. */
378 SilcBool silc_acc_register(const SilcAccelerator acc, ...);
380 silc_acc_register(softacc, "min_threads", 2, "max_threads", 16, NULL);
382 /* Unregister accelerator. Uninitializes the accelerator. */
383 SilcBool silc_acc_unregister(const SilcAccelerator acc);
385 /* Return list of the registered accelerators */
386 SilcDList silc_acc_get_supported(void);
388 /* Find existing accelerator. `name' is accelerator's name. */
389 SilcAccelerator silc_acc_find(const char *name);
391 /* Return accelerator's name */
392 const char *silc_acc_get_name(SilcAccelerator acc);
394 /* Accelerate `public_key'. Return accelerated public key. */
395 SilcPublicKey silc_acc_public_key(SilcAccelerator acc,
396 SilcPublicKey public_key);
398 /* Accelerate `private_key'. Returns accelerated private key. */
399 SilcPrivateKey silc_acc_private_key(SilcAccelerator acc,
400 SilcPrivateKey private_key);
402 /* Return the underlaying public key */
403 SilcPublicKey silc_acc_get_public_key(SilcAccelerator acc,
404 SilcPublicKey public_key);
406 /* Return the underlaying private key */
407 SilcPrivateKey silc_acc_get_private_key(SilcAccelerator acc,
408 SilcPrivateKey private_key);
410 typedef struct SilcAcceleratorObject {
411 const char *name; /* Accelerator's name */
412 SilcBool (*init)(va_list va); /* Initialize accelerator */
413 SilcBool (*uninit)(void); /* Uninitialize accelerator */
414 const SilcPKCSAlgorithm *pkcs; /* Accelerated PKCS algorithms */
415 const SilcDHObject *dh; /* Accelerated Diffie-Hellmans */
416 const SilcCipherObject *cipher; /* Accelerated ciphers */
417 const SilcHashObject *hash; /* Accelerated hashes */
418 const SilcRngObject *rng; /* Accelerated RNG's */
419 } *SilcAccelerator, SilcAcceleratorStruct;
421 Allows accelerator to have multiple accelerators (cipher, hash etc)
422 and multiple different algorithms and implementations (SHA-1, SHA-256 etc).
424 SilcPublicKey->SilcSILCPublicKey->RsaPublicKey accelerated as:
425 SilcPublicKey->SilcAcceleratorPublicKey->SilcSoftAccPublicKey->
426 SilcPublicKey->SilcSILCPublicKey->RsaPublicKey
428 silc_acc_public_key creates SilcPublicKey and SilcAcceleratorPublicKey
429 and acc->pkcs->import_public_key creates SilcSoftAccPublicKey.
431 o Implement software accelerator. It is a thread pool system where the
432 public key and private key operations are executed in threads.
434 const struct SilcAcceleratorObject softacc =
436 "softacc", softacc_init, softacc_uninit,
437 softacc_pkcs, NULL, NULL, NULL, NULL
440 /* Called from silc_acc_private_key */
441 int silc_softacc_import_private_key(void *key, SilcUInt32 key_len,
442 void **ret_private_key)
444 SilcSoftAccPrivateKey prv = silc_calloc(1, sizeof(*prv));
445 prv->pkcs = acc->pkcs;
446 prv->private_key = key;
447 *ret_private_key = prv;
450 (o Symmetric key cryptosystem acceleration? They are always sycnhronouos
451 even with hardware acceleration so the crypto API shouldn't require
458 o Import TFM. Talk to Tom to add the missing functions. Use TFM in
459 client and client library, but TMA in server, due to the significantly
460 increased memory consumption with TFM, and the rare need for public
461 key operations in server.
463 We want TFM's speed but not TFM's memory requirements. Talk to Tom
464 about making the TFM mp dynamic just as it is in LTM.
466 o The SILC MP API function must start returning indication of success
467 and failure of the operation.
469 o Do SilcStack support for silc_mp_init, silc_mp_init_size and other
470 any other MP function (including utility ones) that may allocate
473 o All utility functions should be made non-allocating ones.
476 SILC XML Library, lib/silcxml/
477 ==============================
479 o SILC XML API (wrapper to expat). The SILC XML API should follow and
480 resemble Simple API for XML (SAX).
483 lib/silcske/silcske.[ch]
484 ========================
486 o Ratelimit to UDP/IP transport for incoming packets.
492 o Negative integer encoding is missing, add it.
494 o SILC_ASN1_CHOICE should perhaps return an index what choice in the
495 choice list was found. Currently it is left for caller to figure out
496 which choice was found.
498 o SILC_ASN1_NULL in decoding should return SilcBool whether or not
499 the NULL was present. It's important when it's SILC_ASN1_OPTIONAL
500 and we need to know whether it was present or not.
506 o OpenPGP certificate support, allowing the use of PGP public keys
513 o SSH2 public key/private key support, allowing the use of SSH2 keys
520 o PKIX implementation
526 o (Re)write commands/command replys.
528 o (Re)write notify handling.
530 o The SERVER_SIGNOFF notify handing is not optimal, because it'll
531 cause sending of multiple SIGNOFF notify's instead of the one
532 SERVER_SIGNOFF notify that the server received. This should be
533 optimized so that the only SERVER_SIGNOFF is sent and not
534 SIGNOFF of notify at all (using SIGNOFF takes the idea about
535 SERVER_SIGNOFF away entirely).
537 o Another SERVER_SIGNOFF opt/bugfix: Currently the signoff is
538 sent to a client if it is on same channel as the client that
539 signoffed. However, the entire SERVER_SIGNOFF list is sent to
540 the client, ie. it may receive clients that was not on the
541 same channel. This is actually against the specs. It must be
542 done per channel. It shouldn't receive the whole list just
543 because one client happened to be on same channel.
545 o Add reference counters to all Silc*Entry structures
547 o SERVICEs support (plugin, SIM)
549 o If client's public key is saved in the server (and doing public key
550 authentication) then the hostname and the username information could
551 be taken from the public key. Should be a configuration option!
553 o Add a timeout to handling incoming JOIN commands. It should be
554 enforced that JOIN command is executed only once in a second or two
555 seconds. Now it is possible to accept n incoming JOIN commands
556 and process them without any timeouts. THis must be employed because
557 each JOIN command will create and distribute the new channel key
558 to everybody on the channel.
560 o Related to above. If multiple JOINs are received in sequence perhaps
561 new key should be created only once, if the JOINs are handeled at the same
562 time. Now we create multiple keys and never end up using them because
563 many JOINs are processed at the same time in sequence. Only the last
564 key ends up being used.
566 o The CMODE cipher & hmac change problem (#101).