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