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