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.
153 o Compression routines are missing. The protocol supports packet
154 compression thus it must be implemented. SILC Zip API must be
157 (o Generic SilcStatus or SilcResult that includes all possible status and
158 error conditions, including those of SILC protocol. Though, the SILC
159 protocol related status (currently in silcstatus.h) cannot be in
160 runtime library) maybe
162 (o Thread pool) maybe
164 (o SILC specific socket creation/closing routines to silcnet.h, wrappers
165 to all send(), recv(), sendto() etc. Bad thing is that we'd have to
166 define all socket options, sockaddrs, etc.) maybe
171 lib/silcutil/symbian/
172 =====================
174 o Something needs to be thought to the logging globals as well,
175 like silc_debug etc. They won't work on EPOC. Perhaps logging
176 and debugging is to be disabled on EPOC. The logging currently works
177 by it cannot be controlled, same with debugging.
180 SFTP Library, lib/silcsftp/
181 ===========================
183 o Read prefetch (read-ahead, reading ahead of time). Maybe if this can
187 SKR Library, lib/silcskr/
188 =========================
190 o Add fingerprint as search constraint.
192 o Add OpenPGP support. Adding, removing, fetching PGP keys. (Keyring
195 o Add support for importing public keys from a directory and/or from a
196 file. Add support for exporting the repository (different formats for
197 different key types?).
199 o Change the entire silc_skr_find API. Remove SilcSKRFind and just simply
200 add the find constraints as variable argument list to silc_skr_find, eg:
202 silc_skr_find(skr, schedule, callback, context,
203 SILC_SKR_FIND_PUBLIC_KEY, public_key,
204 SILC_SKR_FIND_COUNTRY, "FI",
205 SILC_SKR_FIND_USAGE, SILC_SKR_USAGE_AUTH,
208 NULL argument would be ignored and skipped.
210 o Add OR logical rule in addition of the current default AND, eg:
212 // Found key(s) MUST have this public key AND this country.
213 silc_skr_find(skr, schedule, callback, context,
214 SILC_SKR_FIND_RULE_AND,
215 SILC_SKR_FIND_PUBLIC_KEY, public_key,
216 SILC_SKR_FIND_COUNTRY, "FI",
219 // Found key(s) MUST have this public key OR this key context
220 silc_skr_find(skr, schedule, callback, context,
221 SILC_SKR_FIND_RULE_OR,
222 SILC_SKR_FIND_PUBLIC_KEY, public_key,
223 SILC_SKR_FIND_CONTEXT, key_context,
227 Crypto Library, lib/silccrypt/
228 ==============================
230 o Add fingerprint to SilcSILCPublicKey and retrieval to silcpk.h, and
231 possibly to silcpkcs.h.
233 /* Return fingerprint of the `public_key'. Returns also the algorithm
234 that has been used to make the fingerprint. */
235 const unsigned char *
236 silc_pkcs_get_fingerprint(SilcPublicKey public_key,
237 const char **hash_algorithm,
238 SilcUInt32 *fingerprint_len);
240 o Change SILC PKCS API to asynchronous, so that accelerators can be used.
241 All PKCS routines should now take callbacks as argument and they should
242 be delivered to SilcPKCSObject and SilcPKCSAlgorithm too.
244 /* Signature computation callback */
245 typedef void (*SilcPKCSSignCb)(SilcBool success,
246 const unsigned char *signature,
247 SilcUInt32 signature_len,
250 /* Signature verification callback */
251 typedef void (*SilcPKCSVerifyCb)(SilcBool success, void *context);
253 /* Encryption callback */
254 typedef void (*SilcPKCSEncryptCb)(SilcBool success,
255 const unsigned char *encrypted,
256 SilcUInt32 encrypted_len,
259 /* Decryption callback */
260 typedef void (*SilcPKCSDecryptCb)(SilcBool success,
261 const unsigned char *decrypted,
262 SilcUInt32 decrypted_len,
265 Either add new _async functions or add the callbacks to existing API
266 and if the callback is NULL then the API is not async and if provided
267 it may be async. For example;
269 SilcBool silc_pkcs_sign(SilcPrivateKey private_key,
270 unsigned char *src, SilcUInt32 src_len,
271 unsigned char *dst, SilcUInt32 dst_size,
273 SilcBool compute_hash, SilcHash hash,
274 SilcPKCSSignCb async_sign,
275 void *async_sign_context);
277 (if this is done then there's no reason why the buffers in the
278 callbacks cannot be the ones user gives here) or allow only async:
280 SilcBool silc_pkcs_sign(SilcPrivateKey private_key,
281 unsigned char *src, SilcUInt32 src_len,
282 SilcBool compute_hash, SilcHash hash,
283 SilcPKCSSignCb async_sign,
284 void *async_sign_context);
288 SilcBool silc_pkcs_sign_async(SilcPrivateKey private_key,
289 unsigned char *src, SilcUInt32 src_len,
290 SilcBool compute_hash, SilcHash hash,
291 SilcPKCSSignCb async_sign,
292 void *async_sign_context);
294 o Change PKCS Algorithm API to take SilcPKCSAlgorithm as argument to
295 encrypt, decrypt, sign and verify functions. We may need to for exmaple
296 check the alg->hash, supported hash functions. Maybe deliver it also
297 to all other functions in SilcPKCSAlgorithm to be consistent.
299 o Add DSS support. Take implementation from Tom or make it yourself.
301 o Implement the defined SilcDH API. The definition is in
302 lib/silccrypt/silcdh.h.
304 o All cipher, hash, hmac etc. allocation routines should take their name
305 in as const char * not const unsigned char *.
310 SILC Accelerator Library
311 ========================
313 o SILC Accelerator API. Provides generic way to use different kind of
314 accelerators. Basically implements SILC PKCS API so that SilcPublicKey
315 and SilcPrivateKey can be used but they call the accelerators.
317 Something in the lines of (preliminary):
319 /* Register accelerator to system */
320 SilcBool silc_acc_register(const SilcAccelerator acc);
322 /* Unregister accelerator */
323 SilcBool silc_acc_unregister(const SilcAccelerator acc);
325 /* Find existing accelerator. `name' is accelerators name and
326 `params' is optional accelerator specific parameters. */
327 SilcAccelerator silc_acc_find(const char *name, const char *params);
329 /* Return accelerator's displayable name */
330 const char *silc_ac_get_display_name(SilcAccelerator acc);
332 /* Accelerate `public_key'. Return accelerated public key. */
333 SilcPublicKey silc_acc_public_key(SilcAccelerator acc,
334 SilcPublicKey public_key);
336 /* Accelerate `private_key'. Returns accelerated private key. */
337 SilcPrivateKey silc_acc_private_key(SilcAccelerator acc,
338 SilcPrivateKey private_key);
340 /* Return the underlaying public key */
341 SilcPublicKey silc_acc_get_public_key(SilcAccelerator acc,
342 SilcPublicKey public_key);
344 /* Return the underlaying private key */
345 SilcPrivateKey silc_acc_get_private_key(SilcAccelerator acc,
346 SilcPrivateKey private_key);
348 typedef struct SilcAcceleratorObject {
349 const char *name; /* Accelerator's name */
350 const char *display_name; /* Displayable name */
351 SilcAcceleratorType type; /* Accelerator type */
354 SilcPKCSObject *pkcs; /* PKCS, may be NULL */
355 SilcPKCSAlgorithm *algorithm; /* Accelerator */
362 } *SilcAccelerator, SilcAcceleratorStruct;
364 SilcPublicKey->SilcSILCPublicKey->RsaPublicKey accelerated as:
365 SilcPublicKey->SilcSILCPublicKey->SilcAcceleratorSoftware->RsaPublicKey or
366 SilcPublicKey->SilcSILCPublicKey->SilcAcceleratorPublicKey->
367 SilcAcceleratorSoftware->RsaPublicKey
369 The former one if u.pkcs.pkcs == NULL.
371 o Implement software accelerator. It is a thread pool system where the
372 public key and private key operations are executed in threads.
374 This implements SilcPKCSAlgorithm (and SilcPKCSObject if needed) that
375 implements the thread acclerated system.
377 (o Symmetric key cryptosystem acceleration? They are always sycnhronouos
378 even with hardware acceleration so the crypto API shouldn't require
385 o Import TFM. Talk to Tom to add the missing functions. Use TFM in
386 client and client library, but TMA in server, due to the significantly
387 increased memory consumption with TFM, and the rare need for public
388 key operations in server.
390 We want TFM's speed but not TFM's memory requirements. Talk to Tom
391 about making the TFM mp dynamic just as it is in LTM.
393 o The SILC MP API function must start returning indication of success
394 and failure of the operation.
396 o Do SilcStack support for silc_mp_init, silc_mp_init_size and other
397 any other MP function (including utility ones) that may allocate
400 o All utility functions should be made non-allocating ones.
403 SILC XML Library, lib/silcxml/
404 ==============================
406 o SILC XML API (wrapper to expat). The SILC XML API should follow and
407 resemble Simple API for XML (SAX).
410 lib/silcske/silcske.[ch]
411 ========================
413 o Ratelimit to UDP/IP transport for incoming packets.
419 o Negative integer encoding is missing, add it.
421 o SILC_ASN1_CHOICE should perhaps return an index what choice in the
422 choice list was found. Currently it is left for caller to figure out
423 which choice was found.
425 o SILC_ASN1_NULL in decoding should return SilcBool whether or not
426 the NULL was present. It's important when it's SILC_ASN1_OPTIONAL
427 and we need to know whether it was present or not.
433 o OpenPGP certificate support, allowing the use of PGP public keys
440 o SSH2 public key/private key support, allowing the use of SSH2 keys
447 o PKIX implementation
453 o (Re)write commands/command replys.
455 o (Re)write notify handling.
457 o The SERVER_SIGNOFF notify handing is not optimal, because it'll
458 cause sending of multiple SIGNOFF notify's instead of the one
459 SERVER_SIGNOFF notify that the server received. This should be
460 optimized so that the only SERVER_SIGNOFF is sent and not
461 SIGNOFF of notify at all (using SIGNOFF takes the idea about
462 SERVER_SIGNOFF away entirely).
464 o Another SERVER_SIGNOFF opt/bugfix: Currently the signoff is
465 sent to a client if it is on same channel as the client that
466 signoffed. However, the entire SERVER_SIGNOFF list is sent to
467 the client, ie. it may receive clients that was not on the
468 same channel. This is actually against the specs. It must be
469 done per channel. It shouldn't receive the whole list just
470 because one client happened to be on same channel.
472 o Add reference counters to all Silc*Entry structures
474 o SERVICEs support (plugin, SIM)
476 o If client's public key is saved in the server (and doing public key
477 authentication) then the hostname and the username information could
478 be taken from the public key. Should be a configuration option!
480 o Add a timeout to handling incoming JOIN commands. It should be
481 enforced that JOIN command is executed only once in a second or two
482 seconds. Now it is possible to accept n incoming JOIN commands
483 and process them without any timeouts. THis must be employed because
484 each JOIN command will create and distribute the new channel key
485 to everybody on the channel.
487 o Related to above. If multiple JOINs are received in sequence perhaps
488 new key should be created only once, if the JOINs are handeled at the same
489 time. Now we create multiple keys and never end up using them because
490 many JOINs are processed at the same time in sequence. Only the last
491 key ends up being used.
493 o The CMODE cipher & hmac change problem (#101).