updates.
[silc.git] / TODO
1 TODO for 1.1 And Beyond
2 =======================
3
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
6 tested.
7
8
9 apps/silcd, The SILC Server     ****PARTLY DONE****
10 ===========================
11
12  o Port all code to use SILC Toolkit 1.1 APIs.
13
14  o Fix/test GETKEY.
15
16  o Fix/test MOTD.
17
18  o Remove protocol.[ch].  ***DONE
19
20  o Rewrite connecting accepting.
21
22  o Rewrite async connecting.
23
24  o Connecting from SILC router to SILC server.
25
26  o Rewrite rehash, HUP.
27
28  o Heartbeat-keepalive.
29
30  o Test backup router resuming protocol.
31
32  o Check all packet receive routines that they call silc_packet_free.
33
34  o Add Web statistics module using lib/silchttp.  Give out server
35    statistics.
36
37
38 SILC Client     ****PARTLY DONE****
39 ===========
40
41  o Porting to new Toolkit API and new Client Library API (***TESTING NEEDED)
42
43  o Improve help files, especially /cmode, /cumode and /key.
44
45
46 lib/silcclient, The Client Library      ***PARTLY DONE****
47 ==================================
48
49  o in JOIN notify handle resolving that timedout.  Currently the user is
50    never joined the channel if this happens.  What to do if message is
51    received from user that hasn't been resolved/joined?  (maybe 1.1, latest
52    1.2)
53
54  o silcclient.h clean up and API rewrites.
55
56  o silcclient_entry.h finishing, all entry relates APIs to this header.
57
58  o SilcChannelEntry, SilcServerEntry, SilcChannelUser, allocating,
59    freeing, finding, etc. rewrite.  Also making them reference counted for
60    multi threads use. (***DONE)
61
62  o Rewrite silc_client_get_clients_by_channel.
63
64  o Rewrite client side WHOIS command (for whois -details). (***DONE)
65
66  o Finish all the missing SILC packet processings, rewrites. (***DONE)
67
68  o The client_notify.c rewrite. (***DONE)
69
70  o Resuming to client_register.c (remove client_resume.c) (***DONE)
71
72  o Rekey rewrite. (***DONE)
73
74  o Remove protocol.[ch]. (***DONE)
75
76  o File transfer rewrite. (***DONE)
77
78  o File transfer API documentation.
79
80  o Connection auth request. (***DONE)
81
82  o Password auth test, public key auth test.
83
84  o Starting key exchange directly, rewrite. (***DONE)
85
86  o Channel messages, channel private keys, channel entires, channel
87    search, etc. rewrite. (***TESTING NEEDED)
88
89  o For many APIs leave the hash context allocations to the caller instead
90    of using client->sha1hash and client->md5hash, or some kind of thread
91    safe (no locking) concept. (***DONE)
92
93  o Key agreement rewrite. (***TESTING NEEDED)
94
95  o Connecting to remote client (***DONE)
96
97  o peer-to-peer private messages
98
99  o Private message waiting API (in threads) (***TESING NEEDED)
100
101  o client_attrs.c, attributes rewrite. (***TESTING NEEDED)
102
103  o No SilcBuffer lists back to application in command_reply operations.
104    Convert them all to real lists and/or structures for easier use.
105    (***DONE)
106
107  o Nickname formatting rewrite. (***TESTING NEEDED)
108
109  o UDP connections. (***TESTING NEEDED)
110
111  o Message ACKing.
112
113  o in /cmode and /cumode with +r, maybe the public key and private key
114    could be just some "string", which would then match to "string.pub" and
115    "string.prv".
116
117  o All packet waiting timeout tests and error condition tests.
118
119
120 lib/silcsftp                    ****DONE****
121 ============
122
123  o Porting to use the new util library. (***DONE)
124
125  o Read-ahead (1.2)
126
127
128 lib/silccore/silcpacket.[ch]    ****PARTLY DONE****
129 ============================
130
131  o Implement silc_packet_engine_stop and silc_packet_stream_destroy.
132
133  o Implement ACK packet and packet payload.
134
135  o SilcPacketEngine. (***DONE)
136
137  o New SILC Packet API. (***DONE)
138
139
140 lib/silccore/silcpacket.[ch]    ****PARTLY DONE****
141 ============================
142
143  o IV Included flag support, UDP transport support (***TESTING NEEDED)
144
145  o SILC_PACKET_FLAG_ACK support.
146
147
148 lib/silccore/silcid.[ch]        ****DONE****
149 ========================
150
151  o Add silc_id_str2id to accept the destination buffer as argument
152    and thus not require any memory allocation.  Same will happen
153    with silc_id_payload_* functions. (***DONE)
154
155  o silc_id_str2id, silc_id2str to non-allocating routines. (***DONE)
156
157
158 lib/silcskr     ****PARTLY DONE****
159 ===========
160
161  o Removing key from the repository is not possible currently.  It should
162    be. (***DONE)
163
164  o Add fingerprint as search constraint.
165
166
167 lib/silcske/silcske.[ch]        ***PARTLY DONE****
168 ========================
169
170  o Responder rekey
171
172  o Ratelimit to UDP/IP transport for incoming packets.
173
174  o IV Included flag support in SKE (***DONE)
175
176  o UDP transport changes; retransmission support by using exponential
177    backoff algorithm. (***DONE)
178
179  o SilcConnAuth header file documentation. (***DONE)
180
181
182 lib/silccrypt                   ****PARTLY DONE****
183 =============
184
185  o Implement SILC Public Key Version 2 handling in sign/verify.  Implement
186    Version (V) identifier (***DONE)
187
188  o Add fingerprint to SilcSILCPublicKey and retrieval to silcpk.h.
189
190  o Implement PKCS #1 sign/verify with hash OID. (***TESTING NEEDED)
191
192  o SILC PKCS (silcpkcs.h) reorganizing when other PK supports added.
193    Move the SILC Public Key routines away from the crypto library into
194    the core library (silccore).  silc_pkcs_public/private_key_* routines
195    to silc_public/private_key_* routines.  The silc_public_key_* routines
196    should also automatically handle SILC Public Keys, and other keys
197    and certificates as well.  Add fe. silcpk.h into silccore.  It should
198    also include the Public Key Payload encoding and decoding routines.
199    (***DONE)
200
201  o Assembler AES (***DONE)
202
203  o Implement the defined SilcDH API.  The definition is in
204    lib/silccrypt/silcdh.h. (1.2)
205
206  o SSH2 public keys support, allowing the use of SSH2 public keys in
207    SILC. (1.2)
208
209  o Add DSS support (1.2)
210
211  o ECDSA and ECDH (1.2)
212
213
214 lib/silcutil                    ****PARTLY DONE****
215 ============
216
217  o The regex code from lib/contrib might compile fine on all platforms.
218    No need to make it silcutil/unix/ specific.  Add them to generic
219    silcutil.c.
220
221  o silc_stringprep to non-allocating version.
222
223  o Compression routines are missing.  The protocol supports packet
224    compression thus it must be implemented.  SILC Zip API must be
225    defined.
226
227  o bool -> SilcBool (***DONE)
228
229  o Silc FD Stream to WIN32 (lib/silcutil/silcfdstream.h)
230
231  o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
232    SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
233    in separately. (1.2)
234
235
236 lib/silcutil/silcbuffer.h       ****DONE****
237 =========================
238
239  o Remove the `truelen' field from SilcBuffer as it is entirely
240    redundant since we can get the true length of the buffer by
241    doing buffer->end - buffer->header.  Add silc_buffer_truelen
242    macro instead.  Consider also removing `len' field too since
243    it effectively is buffer->tail - buffer->data, and adding
244    silc_buffer_len macro can do the same.  These would save
245    totally 8 bytes of memory per buffer. (***DONE)
246
247
248 lib/silcutil/silcbuffmt.[ch]    ****DONE****
249 ============================
250
251  o SilcStack aware silc_buffer_unformat (***DONE)
252
253  o SilcStack aware silc_buffer_format (***DONE)
254
255  o silc_buffer_format reallocates automatically (***DONE)
256
257  o SILC_STR_OFFSET (***DONE)
258
259
260 lib/silcutil/silcstack.[ch]     ****DONE****
261 ===========================
262
263  o Data stack implementation (***DONE)
264
265
266 lib/silcutil/silcstream.[ch]    ****DONE****
267 ============================
268
269  o Add abstract SilcStream. (***DONE)
270
271
272 lib/silcutil/silcsocketstream.[ch]      ****PARTY DONE****
273 ==================================
274
275  o Add SilcSocketStream (***DONE)
276
277  o Add SilcSocketStream for WIN32
278
279  o Handle EOS sending to upper layer properly
280
281  o Test QoS after the changes made to socket stream
282
283
284 lib/silcutil/silcschedule*.[ch]         ****PARTLY DONE****
285 ===============================
286
287  o Scheduler can be optimized for FD tasks by changing the fd_queue
288    to SilcHashTable instead of using linked list.  We need to do
289    one-to-one mapping of FD to task and hash table is more efficient
290    for this usage.
291
292    Also redefine the silc_select to perhaps return a separate
293    structure of the events that actually occurred, instead of
294    returning the events in the fd_list which is then traversed
295    in the generic code to find the changed events.  This can be
296    made faster by having own struct which includes only the
297    changed events, thus the tarversing is faster since the whole
298    fd_list is not traversed anymore (it is still traversed in the
299    silc_select but at least it removes one extra tarversing later
300    for the same list).
301
302    Other task queues should be changed to use SilcList.  (***DONE)
303
304  o Add SILC scheduler's internal routines into a table of implementation
305    function pointers, that the generic code then takes as extern from
306    implementation.  These are the silc_schedule_internal_* routines.
307    (***DONE)
308
309  o Change SILC_TASK_CALLBACK to non-static, and remove the macro
310    SILC_TASK_CALLBACK_GLOBAL. (***DONE)
311
312  o SILC Schedule API changes to WIN32.
313
314
315 lib/silcutil/silcasync.[ch]     ****DONE****
316 ===========================
317
318  o Add SilcAsyncOperation to utility library.  Any function that takes
319    callback as an argument must/should return SilcAsyncOperation.
320    (***DONE)
321
322
323 lib/silcutil/silctime.[ch]      ****PARTLY DONE****
324 ===========================
325
326  o SilcTime. (***DONE)
327
328  o system time, universal, generalized. (***DONE)
329
330  o Fix universal time decoding (doesn't accept all forms) in silctime.c.
331
332
333 lib/silcutil/silcfsm.[ch]       ****DONE****
334 =========================
335
336  o SILC Finite State Machine API.  Replaces SILC Protocol API (***DONE)
337
338
339 lib/silcutil/silcnet*, lib/silcutil/*/silc*net*         ****PARTLY DONE****
340 ===============================================
341
342  o Add UDP interface (***DONE)
343
344  o Add UDP interface for WIN32
345
346  o New network interfaces (***DONE)
347
348
349 lib/silcmath
350 ============
351
352  o Import TFM.  Talk to Tom to add the missing functions.  Use TFM in
353    client and client library, but TMA in server, due to the significantly
354    increased memory consumption with TFM, and the rare need for public
355    key operations in server.
356
357  o Change LTM and TFM function names when importing to SILC tree to avoid
358    rare linking problems on system that has same named symbols already in
359    the system.
360
361  o The SILC MP API function must start returning indication of success
362    and failure of the operation.
363
364  o Do SilcStack support for silc_mp_init, silc_mp_init_size and other
365    any other MP function (including utility ones) that may allocate
366    memory.
367
368  o Test on x86_64.
369
370  o All utility functions should be made non-allocating ones.
371
372
373 lib/silcutil/symbian/           ****PARTLY DONE****
374 =====================
375
376   o lib/silcutil/symbian routines missing or not completed.
377     (****TESTING NEEDED)
378
379   o Something needs to be thought to the logging globals as well,
380     like silc_debug etc.  They won't work on EPOC.  Perhaps logging
381     and debugging is to be disabled on EPOC.
382
383
384 lib/silcasn1                    ****PARTLY DONE****
385 ============
386
387  o ASN.1 library (***DONE)
388
389  o Header documentation missing. (***DONE)
390
391  o Some string encodings missing (copy/paste matter). (***DONE)
392
393  o Negative integer encoding
394
395
396 lib/silccore
397 ============
398
399  o All payload encoding routines should take SilcStack as argument. (1.2)
400
401  o All payload test routines into lib/silccore/tests/.
402
403
404 lib/silcpkix (1.2)
405 ============
406
407  o PKIX implementation
408
409
410 lib/silcpgp (1.2)
411 ===========
412
413  o OpenPGP certificate support, allowing the use of PGP public keys
414    in SILC.
415
416
417 lib/silcserver (1.2)
418 ==============
419
420  o (Re)write commands/command replys.
421
422  o (Re)write notify handling.
423
424  o The SERVER_SIGNOFF notify handing is not optimal, because it'll
425    cause sending of multiple SIGNOFF notify's instead of the one
426    SERVER_SIGNOFF notify that the server received.  This should be
427    optimized so that the only SERVER_SIGNOFF is sent and not
428    SIGNOFF of notify at all (using SIGNOFF takes the idea about
429    SERVER_SIGNOFF away entirely).
430
431  o Another SERVER_SIGNOFF opt/bugfix:  Currently the signoff is
432    sent to a client if it is on same channel as the client that
433    signoffed.  However, the entire SERVER_SIGNOFF list is sent to
434    the client, ie. it may receive clients that was not on the
435    same channel.  This is actually against the specs.  It must be
436    done per channel.  It shouldn't receive the whole list just
437    because one client happened to be on same channel.
438
439  o MAYBE: The SilcChannelClientEntry can be:
440         SilcUInt32 address;
441         SilcUInt32 mode;
442
443   where address is SilcClientEntry address XOR SilcChannelEntry.
444   You can get SilcClientEntry by doing client = chl->address XOR channel,
445   and SilcChannelEntry by doing channel = chl->address XOR client.
446   As long as the other pointer is always available when accessing the
447   structure this can be done.
448
449  o Add reference counters to all Silc*Entry structures
450
451  o SERVICEs support (plugin, SIM)
452
453  o If client's public key is saved in the server (and doing public key
454    authentication) then the hostname and the username information could
455    be taken from the public key.  Should be a configuration option!
456
457  o Add a timeout to handling incoming JOIN commands.  It should be
458    enforced that JOIN command is executed only once in a second or two
459    seconds.  Now it is possible to accept n incoming JOIN commands
460    and process them without any timeouts.  THis must be employed because
461    each JOIN command will create and distribute the new channel key
462    to everybody on the channel (Fix this to 0.9.x).
463
464  o Related to above.  If multiple JOINs are received in sequence perhaps
465    new key should be created only once, if the JOINs are handeled at the same
466    time.  Now we create multiple keys and never end up using them because
467    many JOINs are processed at the same time in sequence.  Only the last
468    key ends up being used.
469
470  o The CMODE cipher & hmac change problem (#101).