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