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