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