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