updates.
[silc.git] / TODO
1 TODO for 1.1
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 apps/silcd, The SILC Server     ****PARTLY DONE****
10 ===========================
11
12  o Port all code to use SILC Toolkit 1.1 APIs.
13
14  o Fix/test GETKEY.
15
16  o Fix/test MOTD.
17
18  o Remove protocol.[ch].  (***DONE)
19
20  o Rewrite connecting accepting. (***TESTING NEEDED)
21
22  o Rewrite async connecting. (***TESTING NEEDED)
23
24  o Connecting from SILC router to SILC server.
25
26  o Rewrite rehash, HUP.
27
28  o Heartbeat-keepalive.
29
30  o Test backup router resuming protocol.
31
32  o Check all packet receive routines that they call silc_packet_free.
33
34  o Add Web statistics module using lib/silchttp.  Give out server
35    statistics. (***DONE)
36
37
38 SILC Client     ****PARTLY DONE****
39 ===========
40
41  o Porting to new Toolkit API and new Client Library API (***TESTING NEEDED)
42
43  o Improve help files, especially /cmode, /cumode and /key.
44
45
46 lib/silcclient, The Client Library      ***PARTLY DONE****
47 ==================================
48
49  o silcclient.h clean up and API rewrites. (***DONE)
50
51  o silcclient_entry.h finishing, all entry relates APIs to this header.
52    (***DONE)
53
54  o SilcChannelEntry, SilcServerEntry, SilcChannelUser, allocating,
55    freeing, finding, etc. rewrite.  Also making them reference counted for
56    multi threads use. (***DONE)
57
58  o Rewrite silc_client_get_clients_by_channel.
59
60  o Rewrite client side WHOIS command (for whois -details). (***DONE)
61
62  o Finish all the missing SILC packet processings, rewrites. (***DONE)
63
64  o The client_notify.c rewrite. (***DONE)
65
66  o Resuming to client_register.c (remove client_resume.c) (***DONE)
67
68  o Rekey rewrite. (***DONE)
69
70  o Remove protocol.[ch]. (***DONE)
71
72  o File transfer rewrite. (***DONE)
73
74  o File transfer API documentation. (***DONE)
75
76  o Connection auth request. (***DONE)
77
78  o Password auth test, public key auth test. (***TESTING NEEDED)
79
80  o Starting key exchange directly, rewrite. (***DONE)
81
82  o Channel messages, channel private keys, channel entires, channel
83    search, etc. rewrite. (***TESTING NEEDED)
84
85  o For many APIs leave the hash context allocations to the caller instead
86    of using client->sha1hash and client->md5hash, or some kind of thread
87    safe (no locking) concept. (***DONE)
88
89  o Key agreement rewrite. (***TESTING NEEDED)
90
91  o Connecting to remote client (***DONE)
92
93  o Private message waiting API (in threads) (***TESING NEEDED)
94
95  o client_attrs.c, attributes rewrite. (***TESTING NEEDED)
96
97  o No SilcBuffer lists back to application in command_reply operations.
98    Convert them all to real lists and/or structures for easier use.
99    (***DONE)
100
101  o Nickname formatting rewrite. (***TESTING NEEDED)
102
103  o UDP connections. (***TESTING NEEDED)
104
105
106 lib/silcsftp                    ****DONE****
107 ============
108
109  o Porting to use the new util library. (***DONE)
110
111
112 lib/silccore/silcpacket.[ch]    ****PARTLY DONE****
113 ============================
114
115  o SilcPacketEngine. (***DONE)
116
117  o New SILC Packet API. (***DONE)
118
119  o Implement silc_packet_engine_stop and silc_packet_stream_destroy. (***DONE)
120
121  o IV Included flag support, UDP transport support (***TESTING NEEDED)
122
123
124 lib/silccore/silcid.[ch]        ****DONE****
125 ========================
126
127  o Add silc_id_str2id to accept the destination buffer as argument
128    and thus not require any memory allocation.  Same will happen
129    with silc_id_payload_* functions. (***DONE)
130
131  o silc_id_str2id, silc_id2str to non-allocating routines. (***DONE)
132
133
134 lib/silcskr     ****DONE****
135 ===========
136
137  o Removing key from the repository is not possible currently.  It should
138    be. (***DONE)
139
140
141 lib/silcske/silcske.[ch]        ***PARTLY DONE****
142 ========================
143
144  o Responder rekey (***TESTING NEEDED)
145
146  o IV Included flag support in SKE (***DONE)
147
148  o UDP transport changes; retransmission support by using exponential
149    backoff algorithm. (***DONE)
150
151  o SilcConnAuth header file documentation. (***DONE)
152
153
154 lib/silccrypt                   ****PARTLY DONE****
155 =============
156
157  o Implement PKCS #1 sign/verify with hash OID. (***TESTING NEEDED)
158
159  o Implement SILC Public Key Version 2 handling in sign/verify.  Implement
160    Version (V) identifier (***DONE)
161
162  o SILC PKCS (silcpkcs.h) reorganizing when other PK supports added.
163    Move the SILC Public Key routines away from the crypto library into
164    the core library (silccore).  silc_pkcs_public/private_key_* routines
165    to silc_public/private_key_* routines.  The silc_public_key_* routines
166    should also automatically handle SILC Public Keys, and other keys
167    and certificates as well.  Add fe. silcpk.h into silccore.  It should
168    also include the Public Key Payload encoding and decoding routines.
169    (***DONE)
170
171  o Assembler AES (***DONE)
172
173
174 lib/silcutil                    ****PARTLY DONE****
175 ============
176
177  o The regex code from lib/contrib might compile fine on all platforms.
178    No need to make it silcutil/unix/ specific.  Add them to generic
179    silcutil.c. (***TESTNG NEEDED)
180
181  o Silc FD Stream to WIN32 (lib/silcutil/silcfdstream.h) (***TESTING NEEDED)
182
183  o bool -> SilcBool (***DONE)
184
185
186 lib/silcutil/silcbuffer.h       ****DONE****
187 =========================
188
189  o Remove the `truelen' field from SilcBuffer as it is entirely
190    redundant since we can get the true length of the buffer by
191    doing buffer->end - buffer->header.  Add silc_buffer_truelen
192    macro instead.  Consider also removing `len' field too since
193    it effectively is buffer->tail - buffer->data, and adding
194    silc_buffer_len macro can do the same.  These would save
195    totally 8 bytes of memory per buffer. (***DONE)
196
197
198 lib/silcutil/silcbuffmt.[ch]    ****DONE****
199 ============================
200
201  o SilcStack aware silc_buffer_unformat (***DONE)
202
203  o SilcStack aware silc_buffer_format (***DONE)
204
205  o silc_buffer_format reallocates automatically (***DONE)
206
207  o SILC_STR_OFFSET (***DONE)
208
209
210 lib/silcutil/silcstack.[ch]     ****DONE****
211 ===========================
212
213  o Data stack implementation (***DONE)
214
215
216 lib/silcutil/silcstream.[ch]    ****DONE****
217 ============================
218
219  o Add abstract SilcStream. (***DONE)
220
221
222 lib/silcutil/silcsocketstream.[ch]      ****PARTY DONE****
223 ==================================
224
225  o Add SilcSocketStream (***DONE)
226
227  o Add SilcSocketStream for WIN32 (***TESTING NEEDED)
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. (***TESTING NEEDED)
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 (***TESTING NEEDED)
291
292  o New network interfaces (***DONE)
293
294
295 lib/silcmath                    ****PARTLY DONE****
296 ============
297
298  o Test on x86_64.
299
300  o Change LTM and TFM function names when importing to SILC tree to avoid
301    rare linking problems on system that has same named symbols already in
302    the system. (***DONE)
303
304
305 lib/silcutil/symbian/           ****PARTLY DONE****
306 =====================
307
308   o lib/silcutil/symbian routines missing or not completed.
309     (****TESTING NEEDED)
310
311   o Something needs to be thought to the logging globals as well,
312     like silc_debug etc.  They won't work on EPOC.  Perhaps logging
313     and debugging is to be disabled on EPOC.
314
315
316 lib/silcasn1                    ****DONE****
317 ============
318
319  o ASN.1 library (***DONE)
320
321  o Header documentation missing. (***DONE)
322
323  o Some string encodings missing (copy/paste matter). (***DONE)