Added preliminary Symbian support.
[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 The regex code from lib/contrib might compile fine on all platforms.
165    No need to make it silcutil/unix/ specific.  Add them to generic
166    silcutil.c.
167
168  o silc_stringprep to non-allocating version.
169
170  o Compression routines are missing.  The protocol supports packet
171    compression thus it must be implemented.  SILC Zip API must be
172    defined.
173
174  o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
175    SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
176    in separately.
177
178  o bool -> SilcBool (***DONE)
179
180  o Silc FD Stream to WIN32 (lib/silcutil/silcfdstream.h)
181
182 lib/silcutil/silcbuffer.h       ****DONE****
183 =========================
184
185  o Remove the `truelen' field from SilcBuffer as it is entirely
186    redundant since we can get the true length of the buffer by
187    doing buffer->end - buffer->header.  Add silc_buffer_truelen
188    macro instead.  Consider also removing `len' field too since
189    it effectively is buffer->tail - buffer->data, and adding
190    silc_buffer_len macro can do the same.  These would save
191    totally 8 bytes of memory per buffer. (***DONE)
192
193
194 lib/silcutil/silcbuffmt.[ch]    ****DONE****
195 ============================
196
197  o SilcStack aware silc_buffer_unformat (***DONE)
198
199  o SilcStack aware silc_buffer_format (***DONE)
200
201  o silc_buffer_format reallocates automatically (***DONE)
202
203  o SILC_STR_OFFSET (***DONE)
204
205
206 lib/silcutil/silcstack.[ch]     ****DONE****
207 ===========================
208
209  o Data stack implementation (***DONE)
210
211
212 lib/silcutil/silcstream.[ch]    ****DONE****
213 ============================
214
215  o Add abstract SilcStream. (***DONE)
216
217
218 lib/silcutil/silcsocketstream.[ch]      ****PARTY DONE****
219 ==================================
220
221  o Add SilcSocketStream (***DONE)
222
223  o Add SilcSocketStream for WIN32
224
225  o Handle EOS sending to upper layer properly
226
227  o Test QoS after the changes made to socket stream
228
229
230 lib/silcutil/silcschedule*.[ch]         ****PARTLY DONE****
231 ===============================
232
233  o Scheduler can be optimized for FD tasks by changing the fd_queue
234    to SilcHashTable instead of using linked list.  We need to do
235    one-to-one mapping of FD to task and hash table is more efficient
236    for this usage.
237
238    Also redefine the silc_select to perhaps return a separate
239    structure of the events that actually occurred, instead of
240    returning the events in the fd_list which is then traversed
241    in the generic code to find the changed events.  This can be
242    made faster by having own struct which includes only the
243    changed events, thus the tarversing is faster since the whole
244    fd_list is not traversed anymore (it is still traversed in the
245    silc_select but at least it removes one extra tarversing later
246    for the same list).
247
248    Other task queues should be changed to use SilcList.  (***DONE)
249
250  o Add SILC scheduler's internal routines into a table of implementation
251    function pointers, that the generic code then takes as extern from
252    implementation.  These are the silc_schedule_internal_* routines.
253    (***DONE)
254
255  o Change SILC_TASK_CALLBACK to non-static, and remove the macro
256    SILC_TASK_CALLBACK_GLOBAL. (***DONE)
257
258  o SILC Schedule API changes to WIN32.
259
260
261 lib/silcutil/silcasync.[ch]     ****DONE****
262 ===========================
263
264  o Add SilcAsyncOperation to utility library.  Any function that takes
265    callback as an argument must/should return SilcAsyncOperation.
266    (***DONE)
267
268
269 lib/silcutil/silctime.[ch]      ****DONE****
270 ===========================
271
272  o SilcTime. (***DONE)
273
274  o system time, universal, generalized. (***DONE)
275
276
277 lib/silcutil/silcfsm.[ch]       ****DONE****
278 =========================
279
280  o SILC Finite State Machine API.  Replaces SILC Protocol API (***DONE)
281
282
283 lib/silcutil/silcnet*, lib/silcutil/*/silc*net*         ****PARTLY DONE****
284 ===============================================
285
286  o Add UDP interface (***DONE)
287
288  o Add UDP interface for WIN32
289
290  o New network interfaces (***DONE)
291
292
293 lib/silcmath
294 ============
295
296  o Import TFM.  Talk to Tom to add the missing functions.  Use TFM in
297    client and client library, but TMA in server, due to the significantly
298    increased memory consumption with TFM, and the rare need for public
299    key operations in server.
300
301  o Change LTM and TFM function names when importing to SILC tree to avoid
302    rare linking problems on system that has same named symbols already in
303    the system.
304
305  o The SILC MP API function must start returning indication of success
306    and failure of the operation.
307
308  o Do SilcStack support for silc_mp_init, silc_mp_init_size and other
309    any other MP function (including utility ones) that may allocate
310    memory.
311
312  o Test on x86_64.
313
314  o All utility functions should be made non-allocating ones.
315
316
317 lib/silcutil/symbian/           ****PARTLY DONE****
318 =====================
319
320   o lib/silcutil/symbian routines missing or not completed.
321     (****TESTING NEEDED)
322
323   o Something needs to be thought to the logging globals as well,
324     like silc_debug etc.  They won't work on EPOC.  Perhaps logging
325     and debugging is to be disabled on EPOC.
326
327
328 lib/silcasn1                    ****PARTLY DONE****
329 ============
330
331  o ASN.1 library (***DONE)
332
333  o Header documentation missing. (***DONE)
334
335  o Some string encodings missing (copy/paste matter). (***DONE)
336
337  o Negative integer encoding
338
339
340 lib/silcpkix
341 ============
342
343  o PKIX implementation
344
345
346 lib/silcserver
347 ==============
348
349  o (Re)write commands/command replys.
350
351  o (Re)write notify handling.
352
353  o The SERVER_SIGNOFF notify handing is not optimal, because it'll
354    cause sending of multiple SIGNOFF notify's instead of the one
355    SERVER_SIGNOFF notify that the server received.  This should be
356    optimized so that the only SERVER_SIGNOFF is sent and not
357    SIGNOFF of notify at all (using SIGNOFF takes the idea about
358    SERVER_SIGNOFF away entirely).
359
360  o Another SERVER_SIGNOFF opt/bugfix:  Currently the signoff is
361    sent to a client if it is on same channel as the client that
362    signoffed.  However, the entire SERVER_SIGNOFF list is sent to
363    the client, ie. it may receive clients that was not on the
364    same channel.  This is actually against the specs.  It must be
365    done per channel.  It shouldn't receive the whole list just
366    because one client happened to be on same channel.
367
368  o MAYBE: The SilcChannelClientEntry can be:
369         SilcUInt32 address;
370         SilcUInt32 mode;
371
372   where address is SilcClientEntry address XOR SilcChannelEntry.
373   You can get SilcClientEntry by doing client = chl->address XOR channel,
374   and SilcChannelEntry by doing channel = chl->address XOR client.
375   As long as the other pointer is always available when accessing the
376   structure this can be done.
377
378  o Add reference counters to all Silc*Entry structures
379
380  o SERVICEs support (plugin, SIM)
381
382  o If client's public key is saved in the server (and doing public key
383    authentication) then the hostname and the username information could
384    be taken from the public key.  Should be a configuration option!
385
386  o Add a timeout to handling incoming JOIN commands.  It should be
387    enforced that JOIN command is executed only once in a second or two
388    seconds.  Now it is possible to accept n incoming JOIN commands
389    and process them without any timeouts.  THis must be employed because
390    each JOIN command will create and distribute the new channel key
391    to everybody on the channel (Fix this to 0.9.x).
392
393  o Related to above.  If multiple JOINs are received in sequence perhaps
394    new key should be created only once, if the JOINs are handeled at the same
395    time.  Now we create multiple keys and never end up using them because
396    many JOINs are processed at the same time in sequence.  Only the last
397    key ends up being used.
398
399  o The CMODE cipher & hmac change problem (#101).