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 Remove SilcCommandCb from silccommand.h.
51 o All payload test routines into lib/silccore/tests/.
54 lib/silcclient, The Client Library
55 ==================================
57 o UDP SILC connection support to SILC server
59 o Giving WHOIS for nick that doesn't exist should remove any same
60 named entries from the client cache.
62 o peer-to-peer private messages
64 o Private message key request notification to application. See XXX in
67 o in JOIN notify handle resolving that timedout. Currently the user is
68 never joined the channel if this happens. What to do if message is
69 received from user that hasn't been resolved/joined?
71 o Add the SilcStream (socket stream) from the SilcPacketStream and
72 SilcSocket from the socket stream to SilcClientConnection for easier
73 access to them for programmers. Currently these have to be digged up
74 from the packet stream.
76 o Connection option that attemps to connect to remot host with various
77 different mechanisms: UDP 706, TCP 706, TCP 80, TCP 443, UDP 7706 and
78 TCP 7706. This is the so called hole punching mechanism.
80 o Message ACKing support.
82 o in /cmode and /cumode with +r, maybe the public key and private key
83 could be just some "string", which would then match to "string.pub" and
86 o If the SILC Events (see below) are implemented, perhaps client library
87 should provide events so that application developer has a choice of
88 developing the SILC app with callbacks or with events.
90 o Ability to recover from rekey errors, at least try to.
93 Runtime library, lib/silcutil/
94 ==============================
96 o Fix universal time decoding (doesn't accept all formats) in silctime.c.
98 o Add functions to manipulate environment variables. (***DONE)
100 o Add functions to loading shared/dynamic object symbols (replaces the
101 SIM library (lib/silcsim) and introduces generic library). Add this
102 to lib/silcutil/silcdll.[ch]. (***TESTING NEEDED WIN32, TODO Symbian)
104 o Add directory opening/traversing functions
106 o silc_getopt routines (***DONE)
108 o regex from /lib/contrib to lib/silcutil.
110 o The SILC Event signals. Asynchronous events that can be created,
111 connected to and signalled. Either own event routines or glued into
114 SilcTask silc_schedule_task_add_event(SilcSchedule schedule,
115 const char *event, ...);
116 SilcBool silc_schedule_event_connect(SilcSchedule schedule,
118 SilcTaskCallback event_callback,
120 SilcBool silc_schedule_event_signal(SilcSchedule schedule,
121 const char *event, ...);
124 silc_schedule_task_add_event(schedule, "connected",
128 silc_schedule_event_connect(schedule, "connected", connected_cb, ctx);
129 silc_schedule_event_signal(schedule, "connected", integer, buf,
131 SILC_TASK_CALLBACK(connected_cb)
133 FooCtx ctx = context;
138 va_start(args, context);
139 integer = va_arg(args, SilcUInt32);
140 buf = va_arg(args, SilcBuffer);
145 Problems: Events would be SilcSchedule specific, and would not work on
146 multi-thread/multi-scheduler system. The events should be copyable
147 between schedulers. Another problem is the signal delivery. Do we
148 deliver them synchronously possibly from any thread to any other thread
149 or do we deliver them through the target schedulers. If we use the
150 schedulers then signalling would be asynchronous (data must be
151 duplicated and later freed) which is not very nice.
153 o If the event signals are added, the SILC_PARAM_* stuff needs to be
154 moved from silcbuffmt.h to silctypes.h or something similar.
156 o In case the SILC Events are done we shall create a new concept of
157 parent and child SilcSchedule's. When new SilcSchedule is created a
158 parent can be associated to it. This association could be done either
159 directly by the parent or by any other children. This way the signals
160 would in effect be global and would reach all children schedulers.
162 This relationship would be associative only. The schedulers are still
163 independent and run independently from each other. All schedulers
164 would be linked and could be accessed from any of the schedulers.
165 It should be possible to retrieve the parent and enumerate all children
166 from any of the schedulers.
168 SilcSchedule silc_schedule_init(int max_tasks, void *app_context,
169 SilcSchedule parent);
170 SilcSchedule silc_schedule_get_parent(SilcSchedule schedule);
172 o Additional scheduler changes: optimize silc_schedule_wakeup. Wakeup
173 only if the scheduler is actually waiting something. If it is
174 delivering tasks wakeup is not needed.
176 o Structured log messages to Log API. Allows machine readable log
177 messages. Would allow sending of any kind of data in a log message.
179 o Base64 to an own API (***DONE)
181 o Timer API (***DONE)
183 o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
184 SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
187 o silc_stringprep to non-allocating version.
189 o silc_hash_table_replace -> silc_hash_table_set. Retain support for
190 silc_hash_table_replace as macro. (***DONE)
192 o SilcStack aware SilcHashTable. (***DONE)
194 o SilcStack aware SilcDList. (***DONE)
196 o Thread pool API. Add this to lib/silcutil/silcthread.[ch]. (***DONE)
198 o Add new functions to SilcStack API in lib/silcutil/silcstack.[ch]. Add
199 silc_stack_[set|get]_alignment. It defines the default alignment used
200 when allocating memory from stack. It can be used to specify special
201 alignments too when needed (such as for hardware devices like crypto
202 accelerators). Move also the low level silc_stack_malloc and
203 silc_stack_realloc from silcstack_i.h to silcstack.h. Remove the
204 _ua unaligned memory allocation routines. Remove unaligned memory
205 allocation possibility. (***DONE)
207 o silc_stack_alloc shouldn't require multiple by 8 size argument, it
208 should figure it out itself. (***DONE)
210 o silc_malloc et. al. to respect --with-alignment.
212 o Add '%@' format to silc_snprintf functions. It marks for external
213 rendering function of following type:
215 /* Snprintf rendering function. The `data' is rendered into a string
216 and allocated string is returned. If NULL is returned the
217 rendering is skipped and ignored. If the returned string does
218 not fit to the destination buffer it may be truncated. */
219 typedef char *(*SilcSnprintfRender)(void *data);
221 It can work like following:
223 char *id_renderer(void *data)
226 id_to_str(tmp, sizeof(tmp), (SilcID *)data);
230 silc_snprintf(buf, sizeof(buf), "Client ID %@", id_renderer, client_id);
233 o SILC Tls (Thread-local storage) API to lib/silcutil/silcthread.[ch].
236 o Change silc_gettimeofday on Unix to use clock_gettime with REALTIME
237 clock if it is available, otherwise use gettimeofday(). (***DONE)
239 o Generic SilcResult that includes all possible status and
240 error conditions and generic errno API. (***DONE)
242 (o Change some stream routines (like socket stream API) to accept ANY
243 stream and use silc_stream_get_root to get the socket stream from the
244 given stream. This will make various stream APIs more easier to use
245 when user doesn't have to dig up the correct stream.
247 Add silc_stream_get_root and add get_root stream operation. It
248 returns the root of the stream or NULL if stream doesn't have root.) maybe
250 (o Compression routines are missing. The protocol supports packet
251 compression thus it must be implemented. SILC Zip API must be
254 (o SilcIpAddr abstraction. Ipv4 and Ipv6 support to the abstaction.)
257 (o SILC specific socket creation/closing routines to silcnet.h, wrappers
258 to all send(), recv(), sendto() etc. Bad thing is that we'd have to
259 define all socket options, sockaddrs, etc.) maybe
261 (o Fast mutex implementation. Fast rwlock implementation. Mutex and
262 rwlock implementation using atomic operations.) not for now.
267 lib/silcutil/symbian/
268 =====================
270 o Something needs to be thought to the logging globals as well,
271 like silc_debug etc. They won't work on EPOC. Perhaps logging
272 and debugging is to be disabled on EPOC. The logging currently works
273 by it cannot be controlled, same with debugging.
276 SFTP Library, lib/silcsftp/
277 ===========================
279 o Read prefetch (read-ahead, reading ahead of time). Maybe if this can
283 SKR Library, lib/silcskr/
284 =========================
286 o Add fingerprint as search constraint.
288 o Add OpenPGP support. Adding, removing, fetching PGP keys. (Keyring
291 o Add support for importing public keys from a directory and/or from a
292 file. Add support for exporting the repository (different formats for
293 different key types?).
295 o Change the entire silc_skr_find API. Remove SilcSKRFind and just simply
296 add the find constraints as variable argument list to silc_skr_find, eg:
298 silc_skr_find(skr, schedule, callback, context,
299 SILC_SKR_FIND_PUBLIC_KEY, public_key,
300 SILC_SKR_FIND_COUNTRY, "FI",
301 SILC_SKR_FIND_USAGE, SILC_SKR_USAGE_AUTH,
304 NULL argument would be ignored and skipped.
306 o Add OR logical rule in addition of the current default AND, eg:
308 // Found key(s) MUST have this public key AND this country.
309 silc_skr_find(skr, schedule, callback, context,
310 SILC_SKR_FIND_RULE_AND,
311 SILC_SKR_FIND_PUBLIC_KEY, public_key,
312 SILC_SKR_FIND_COUNTRY, "FI",
315 // Found key(s) MUST have this public key OR this key context
316 silc_skr_find(skr, schedule, callback, context,
317 SILC_SKR_FIND_RULE_OR,
318 SILC_SKR_FIND_PUBLIC_KEY, public_key,
319 SILC_SKR_FIND_CONTEXT, key_context,
322 o SilcStack to SKR API.
325 Crypto Library, lib/silccrypt/
326 ==============================
328 o Add silc_crypto_init and silc_crypto_uninit. The _init should take
329 SilcStack that will act as global memory pool for all of crypto
330 library. It should not be necessary anymore to separately register
331 default ciphers, HMACs, etc, the _init would do that. However, if
332 user after _init calls silc_pkcs_register, for example, it would take
333 preference over the default once, ie. user can always dictate the
334 order of algorithms. (***DONE)
336 o Add fingerprint to SilcSILCPublicKey and retrieval to silcpk.h, and
337 possibly to silcpkcs.h.
339 /* Return fingerprint of the `public_key'. Returns also the algorithm
340 that has been used to make the fingerprint. */
341 const unsigned char *
342 silc_pkcs_get_fingerprint(SilcPublicKey public_key,
343 const char **hash_algorithm,
344 SilcUInt32 *fingerprint_len);
346 o Change SILC PKCS API to asynchronous, so that accelerators can be used.
347 All PKCS routines should now take callbacks as argument and they should
348 be delivered to SilcPKCSObject and SilcPKCSAlgorithm too. (***DONE)
350 o Change PKCS Algorithm API to take SilcPKCSAlgorithm as argument to
351 encrypt, decrypt, sign and verify functions. We may need to for exmaple
352 check the alg->hash, supported hash functions. Maybe deliver it also
353 to all other functions in SilcPKCSAlgorithm to be consistent. (***DONE)
355 o Add DSA support to SILC public key.
357 o Add DSS support. (***DONE)
359 o Implement the defined SilcDH API. The definition is in
360 lib/silccrypt/silcdh.h. Make sure it is asynchronous so that it can
361 be accelerated. Also take into account that it could use elliptic
368 o AES CBC is missing proper alignment code (see silc_1_1_branch).
370 o All cipher, hash, hmac etc. allocation routines should take their name
371 in as const char * not const unsigned char *. (***DONE)
374 SILC Accelerator Library
375 ========================
377 o SILC Accelerator API. Provides generic way to use different kind of
378 accelerators. Basically implements SILC PKCS API so that SilcPublicKey
379 and SilcPrivateKey can be used but they call the accelerators.
382 o Implement software accelerator. It is a thread pool system where the
383 public key and private key operations are executed in threads.
386 o Add init options to SilcAcceleratorObject as a SilcAcceleratorOption
387 structure. Each accelerator defines the options that they support and
388 can be retrieved from the SilcAccelerator with silc_acc_get_options.
389 The format must also be machine parseable. The structure can be of the
392 typedef struct SilcAcceleratorOptionStruct {
393 const char *option; /* Option name */
394 const char *display_name; /* Option displayable name */
395 SilcParamType type; /* Option data format */
396 void *default_value; /* Option's default value */
397 SilcUInt32 default_value_len; /* Default value length */
398 } *SilcAcceleratorOption;
400 For software accelerator it could be for example:
402 { "min_threads", "Minimum threads", SILC_PARAM_UINT32, (void *)2, 4 },
403 { "max_threads", "Maximum threads", SILC_PARAM_UINT32, (void *)4, 4 },
405 o Diffie-Hellman acceleration
407 (o Symmetric key cryptosystem acceleration? They are always sycnhronouos
408 even with hardware acceleration so the crypto API shouldn't require
415 o Import TFM. We want TFM's speed but its memory requirements are
416 just too much. By default it uses large pre-allocated tables which
417 will eat memory when there are thousands of public keys in system.
418 We probably want to change TFM's fp_int dynamic so that a specific
419 size can be allocated for the int. We could have two new functions:
421 SilcBool silc_mp_init_size(SilcMPInt *mp, SilcUInt32 bit_size);
422 SilcBool silc_mp_sinit_size(SilcStack stack, SilcMPInt *mp,
423 SilcUInt32 bit_size);
425 Which by default allocates `bit_size' bits instead of some default
426 value. silc_mp_init would allocate the default FP_SIZE with TFM
427 and do normal init with TMA and GMP. _init_size with TMA and GMP
428 would be same as _init.
430 o Add AND, OR and XOR support to TFM or ask Tom to do it.
432 o The SILC MP API function must start returning indication of success
433 and failure of the operation.
435 o Do SilcStack support for silc_mp_init, silc_mp_init_size and other
436 any other MP function (including utility ones) that may allocate
439 o Prime generation progress using callback instead of printing to
442 o All utility functions should be made non-allocating ones.
445 SILC XML Library, lib/silcxml/
446 ==============================
448 o SILC XML API (wrapper to expat). Look at the expat API and simplify
449 it. The SILC XML API should have at most 8-10 API functions. It should
450 be possible to create full XML parser with only one function. And, it
451 should be possible to have a function that is able to parse an entire
452 XML document. It should also have a parser function to be able to
453 parse a stream of XML data (SilcStream). It MUST NOT have operations
454 that require multiple function calls to be able to execute that one
455 operation (like creating parser).
458 lib/silcske/silcske.[ch]
459 ========================
461 o Ratelimit to UDP/IP transport for incoming packets.
467 o Negative integer encoding is missing, add it.
469 o SILC_ASN1_CHOICE should perhaps return an index what choice in the
470 choice list was found. Currently it is left for caller to figure out
471 which choice was found. (***DONE)
473 o SILC_ASN1_NULL in decoding should return SilcBool whether or not
474 the NULL was present. It's important when it's SILC_ASN1_OPTIONAL
475 and we need to know whether it was present or not. (***DONE)
481 o OpenPGP certificate support, allowing the use of PGP public keys.
487 o SSH2 public key/private key support, allowing the use of SSH2 keys.
494 o PKIX implementation
500 o Deprecate the old server. Write interface for the new lib/silcserver
501 server library. The interface should work on Unix/Linux systems.
503 o Consider deprecating also the old config file format and use XML
504 istead. This should require SILC XML API implementation first.
506 o The configuration must support dynamic router and server connections.
507 The silcd must work without specifying any servers or routers to
510 o The configuration must support specifying whether the server is
511 SILC Server or SILC Router. This should not be deduced from the
512 configuration as it was in < 1.2.
514 o The configuration must support specifying the ciphers and hmacs and
515 their order so that user can specify which algorithms take preference.
521 o Rewrite the entire server. Deprecate apps/silcd as the main server
522 implementation and create lib/silcserver/. It is a platform
523 independent server library. The apps/silcd will merely provide a
524 a simple interface for the library.
526 o Write the SILC Server library extensively using SILC FSM.
528 o Server library must support multiple networks. This means that one
529 server must be able to create multiple connections that each reach
530 different SILC network. This means also that all cache's etc. must
531 be either connection-specific or network-specific.
533 o Library must support dynamic router and server connections. This means
534 that connections are create only when they are needed, like when someone
535 says JOIN foo@foo.bar.com or WHOIS foobar@silcnet.org.
537 o Library must support server-to-server connections even though protocol
538 prohibits that. The responder of the connection should automatically
539 act as a router. The two servers create an own, isolated, SILC network.
540 To be used specifically with dynamic connections.
542 o Library must support multiple threads and must be entirely thread safe.
544 o Library must have support for SERVICE command.
546 o Both UDP and TCP support for incoming connecetions. Maintaining long
549 o The server must be able to run behind NAT device. This means that
550 Server ID must be based on public IP instead of private IP (See
551 also NAT detection protocol in SILC protocol specification).
553 o The following data must be in per-connection context: client id cache,
554 server id cache, channel id cache, all statistics must be
557 o The following data must be in per-thread context: command context
558 freelist/pool, pending commands, random number generator.
560 o Do inccoming packet processing in an own FSM thread in the
561 server-threads FSM. Same as in client library.
563 o Binding to other ports than 706 too. To allow easier traversing
564 through NATs and firewalls server should also bind to 80, 443 and 7706
565 by default (at least try to bind). Connections must work normally
566 even if they were established to some other port other than 706.
568 Connection option that attemps to connect to remot server with various
569 different mechanisms: UDP 706, TCP 706, TCP 80, TCP 443, UDP 7706 and
570 TCP 7706. This is the so called hole punching mechanism.
572 o Ability to recover from rekey errors, at least try to.
574 o Reference count all Silc*Entry structures.
576 Some issues that must be kept in mind from 1.0 and 1.1 silcd's:
578 o The server and router software MUST work out of the box. After
579 installation the server must not require any configuration to run the
580 most basic working configuration. No defining IP addresses, etc.
581 The server must work just by running it.
583 o The SERVER_SIGNOFF notify handing is not optimal, because it'll
584 cause sending of multiple SIGNOFF notify's instead of the one
585 SERVER_SIGNOFF notify that the server received. This should be
586 optimized so that the only SERVER_SIGNOFF is sent and not
587 SIGNOFF of notify at all (using SIGNOFF takes the idea about
588 SERVER_SIGNOFF away entirely).
590 o Another SERVER_SIGNOFF opt/bugfix: Currently the signoff is
591 sent to a client if it is on same channel as the client that
592 signoffed. However, the entire SERVER_SIGNOFF list is sent to
593 the client, ie. it may receive clients that was not on the
594 same channel. This is actually against the specs. It must be
595 done per channel. It shouldn't receive the whole list just
596 because one client happened to be on same channel.
598 o If client's public key is saved in the server (and doing public key
599 authentication) then the hostname and the username information could
600 be taken from the public key. Should be a configuration option!
602 o Add a timeout to handling incoming JOIN commands. It should be
603 enforced that JOIN command is executed only once in a second or two
604 seconds. Now it is possible to accept n incoming JOIN commands
605 and process them without any timeouts. THis must be employed because
606 each JOIN command will create and distribute the new channel key
607 to everybody on the channel.
609 o Related to above. If multiple JOINs are received in sequence perhaps
610 new key should be created only once, if the JOINs are handeled at the same
611 time. Now we create multiple keys and never end up using them because
612 many JOINs are processed at the same time in sequence. Only the last
613 key ends up being used.