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