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