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
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  o in /cmode and /cumode with +r, maybe the public key and private key
17    could be just some "string", which would then match to "string.pub" and
18    "string.prv".
19
20
21 lib/silcclient, The Client Library
22 ==================================
23
24  o silcclient.h clean up and API rewrites.
25
26  o silcclient_entry.h finishing, all entry relates APIs to this header.
27
28  o SilcChannelEntry, SilcServerEntry, SilcChannelUser, allocating, 
29    freeing, finding, etc. rewrite.  Also making them reference counted for 
30    multi threads use.
31
32  o Finish all the missing SILC packet processings, rewrites.
33
34  o The client_notify.c rewrite.
35
36  o Resuming to client_register.c (remove client_resume.c)
37
38  o Rekey rewrite.
39
40  o Remove protocol.[ch].
41
42  o File transfer rewrite.
43
44  o Starting key exchange directly, rewrite.
45
46  o Channel messages, channel private keys, channel entires, channel 
47    search, etc. rewrite.
48
49  o For many APIs leave the hash context allocations to the caller instead
50    of using client->sha1hash and client->md5hash, or some kind of thread
51    safe (no locking) concept.
52
53  o Password auth test, public key auth test.
54
55  o Key agreement rewrite.
56
57  o Connecting to remote client, peer-to-peer private messages
58
59  o Private message waiting API (in threads)
60
61  o client_attrs.c, attributes rewrite.
62
63  o No SilcBuffer lists back to application in command_reply operations.
64    Convert them all to real lists and/or structures for easier use.
65
66  o Nickname formatting rewrite.
67
68  o UDP connections.
69
70  o Remove silc_client_run and silc_client_run_one from calling SilcSchedule.
71    Leave the scheduling entirely to application.
72
73  o All packet waiting timeout tests and error condition tests.
74
75
76 lib/silccore/silcpacket.[ch]    ****DONE****
77 ============================
78
79  o SilcPacketEngine. (***DONE)
80
81  o New SILC Packet API. (***DONE)
82
83
84 lib/silccore/silcpacket.[ch]    ****PARTLY DONE****
85 ============================
86
87  o IV Included flag support, UDP transport support (***TESTING NEEDED)
88
89
90 lib/silccore/silcid.[ch]        ****DONE****
91 ========================
92
93  o Add silc_id_str2id to accept the destination buffer as argument
94    and thus not require any memory allocation.  Same will happen
95    with silc_id_payload_* functions. (***DONE)
96
97  o silc_id_str2id, silc_id2str to non-allocating routines. (***DONE)
98
99
100 lib/silccore
101 ============
102
103  o All payload encoding routines should take SilcStack as argument.
104
105  o All payload test routines into lib/silccore/tests/.
106
107
108 lib/silcskr
109 ===========
110
111  o Removing key from the repository is not possible currently.  It should
112    be.
113
114
115 lib/silcske/silcske.[ch]
116 ========================
117
118  o IV Included flag support in SKE (***TESTING NEEDED)
119
120  o UDP transport changes; retransmission support by using exponential
121    backoff algorithm.
122
123  o SilcConnAuth header file documentation.
124
125
126 lib/silccrypt                   ****PARTLY DONE****
127 =============
128
129  o Implement the defined SilcDH API.  The definition is in
130    lib/silccrypt/silcdh.h.
131
132  o SSH2 public keys support, allowing the use of SSH2 public keys in
133    SILC.
134
135  o OpenPGP certificate support, allowing the use of PGP public keys
136    in SILC.
137
138  o SILC PKCS (silcpkcs.h) reorganizing when other PK supports added.
139    Move the SILC Public Key routines away from the crypto library into
140    the core library (silccore).  silc_pkcs_public/private_key_* routines
141    to silc_public/private_key_* routines.  The silc_public_key_* routines
142    should also automatically handle SILC Public Keys, and other keys
143    and certificates as well.  Add fe. silcpk.h into silccore.  It should
144    also include the Public Key Payload encoding and decoding routines.
145    (***DONE)
146
147  o Add DSS support.
148
149  o Cipher optimizations (asm, that this) at least for i386 would be nice.
150
151  o ECDSA and ECDH.
152
153
154 lib/silcutil                    ****PARTLY DONE****
155 ============
156
157  o silc_stringprep to non-allocating version.
158
159  o Compression routines are missing.  The protocol supports packet
160    compression thus it must be implemented.  SILC Zip API must be
161    defined.
162
163  o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
164    SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
165    in separately.
166
167  o bool -> SilcBool (***DONE)
168
169  o Silc FD Stream to WIN32 (lib/silcutil/silcfdstream.h)
170
171
172 lib/silcutil/silcbuffer.h       ****DONE****
173 =========================
174
175  o Remove the `truelen' field from SilcBuffer as it is entirely
176    redundant since we can get the true length of the buffer by
177    doing buffer->end - buffer->header.  Add silc_buffer_truelen
178    macro instead.  Consider also removing `len' field too since
179    it effectively is buffer->tail - buffer->data, and adding
180    silc_buffer_len macro can do the same.  These would save
181    totally 8 bytes of memory per buffer. (***DONE)
182
183
184 lib/silcutil/silcbuffmt.[ch]    ****PARTLY DONE****
185 ============================
186
187  o SilcStack aware silc_buffer_unformat (***DONE)
188
189  o SilcStack aware silc_buffer_format (***DONE)
190
191  o silc_buffer_format reallocates automatically (***DONE)
192
193  o SILC_STR_OFFSET (***DONE)
194
195
196 lib/silcutil/silcstack.[ch]     ****DONE****
197 ===========================
198
199  o Data stack implementation (***DONE)
200
201
202 lib/silcutil/silcstream.[ch]    ****DONE****
203 ============================
204
205  o Add abstract SilcStream. (***DONE)
206
207
208 lib/silcutil/silcsocketstream.[ch]      ****PARTY DONE****
209 ==================================
210
211  o Add SilcSocketStream (***DONE)
212
213  o Add SilcSocketStream for WIN32
214
215  o Handle EOS sending to upper layer properly
216
217  o Test QoS after the changes made to socket stream
218
219
220 lib/silcutil/silcschedule*.[ch]         ****DONE****
221 ===============================
222
223  o Scheduler can be optimized for FD tasks by changing the fd_queue
224    to SilcHashTable instead of using linked list.  We need to do
225    one-to-one mapping of FD to task and hash table is more efficient
226    for this usage.
227
228    Also redefine the silc_select to perhaps return a separate
229    structure of the events that actually occurred, instead of
230    returning the events in the fd_list which is then traversed
231    in the generic code to find the changed events.  This can be
232    made faster by having own struct which includes only the
233    changed events, thus the tarversing is faster since the whole
234    fd_list is not traversed anymore (it is still traversed in the
235    silc_select but at least it removes one extra tarversing later
236    for the same list).
237
238    Other task queues should be changed to use SilcList.  (***DONE)
239
240  o Add SILC scheduler's internal routines into a table of implementation
241    function pointers, that the generic code then takes as extern from
242    implementation.  These are the silc_schedule_internal_* routines.
243    (***DONE)
244
245  o Change SILC_TASK_CALLBACK to non-static, and remove the macro
246    SILC_TASK_CALLBACK_GLOBAL. (***DONE)
247
248  o SILC Schedule API changes to WIN32.
249
250
251 lib/silcutil/silcasync.[ch]     ****DONE****
252 ===========================
253
254  o Add SilcAsyncOperation to utility library.  Any function that takes
255    callback as an argument must/should return SilcAsyncOperation.
256    (***DONE)
257
258
259 lib/silcutil/silctime.[ch]      ****DONE****
260 ===========================
261
262  o SilcTime. (***DONE)
263
264  o system time, universal, generalized. (***DONE)
265
266
267 lib/silcutil/silcfsm.[ch]       ****DONE****
268 =========================
269
270  o SILC Finite State Machine API.  Replaces SILC Protocol API (***DONE)
271
272
273 lib/silcutil/silcnet*, lib/silcutil/*/silc*net*         ****PARTLY DONE****
274 ===============================================
275
276  o Add UDP interface (***DONE)
277
278  o Add UDP interface for WIN32
279
280  o New network interfaces (***DONE)
281
282
283 lib/silcsftp
284 ============
285
286  o Porting to use the new util library.
287
288
289 lib/silcutil/epoc/*
290 ===================
291
292   o lib/silcutil/epoc routines missing or not completed.
293
294   o The PKCS#1 also calls global RNG (even though it is not used
295     currently in SILC, the interface allows its use).
296
297   o Something needs to be thought to the logging globals as well,
298     like silc_debug etc.  They won't work on EPOC.  Perhaps logging
299     and debugging is to be disabled on EPOC.
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/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).