updates.
[silc.git] / TODO
1 TODO/bugs in Irssi SILC client
2 ==============================
3
4  o Add local command to switch the channel's private key when channel has
5    several private keys.  Currently sending channel messages with many
6    keys is not possible because changing the key is not possible by the
7    user.
8
9  o JOINing to +a (requires passphrase to JOIN) does not work on autojoin.
10    Seems the passwords in the .silc/config has no effect.
11
12  o Add local commands to list the current server and client public keys
13    that the user has.  And a local command to dump the contents of the
14    public key to the screen.  Something like LISTKEYS, SHOWKEY...
15
16  o We should get rid of the clientconfig.[ch] in Irssi SILC and move the
17    cipher, hash, hmac and pkcs configuration to the Irssi SILC's config
18    file.
19
20  o Add PERL scripting support from Irssi CVS.
21
22  o Extend the /HELP command to support sub commands or something.  So
23    that user can say /help set mutual_authentication they would get
24    help of the mutual_authentication setting.
25
26  o Set different kind of settings, like, /set mutual_authentication,
27    /set key_exchange_timeout, /set conn_auth_timeout etc etc.
28
29
30 TODO/bugs In SILC Client Library
31 ================================
32
33  o The PRIVATE_MESSAGE_KEY packet is not handled (it is implemented 
34    though).  This should be added and perhaps new client operation
35    should be added to notify application that it was received and
36    set the key only if application wishes to set (accept the key) it.
37
38  o Additions to do after protocol version 1.1:
39
40         o Fix the NICK_CHANGE notify handling not to create new entry
41           for the changed client, but take the nickname from the notify
42           (removes need for resolving as well).  Protocol TODO entry 3.
43
44         o Add support for list of errors in command replies.  Protocol
45           TODO entry 1.
46
47
48 TODO/bugs In SILC Server
49 ========================
50
51  o The router should check for validity of received notify packets from
52    servers (after all buggy servers may send notify that is actually
53    something that should have not been sent).
54
55  o Add hashed passwords to silcd.conf file.
56
57  o Backup router related issues
58
59         o Channel user mode changes are notified unnecessarely when
60           switching to backup router on router crash.
61
62  o Add a timeout to handling incoming JOIN commands.  It should be 
63    enforced that JOIN command is executed only once in a second or two
64    seconds.  Now it is possible to accept n incoming JOIN commands
65    and process them without any timeouts.  THis must be employed because
66    each JOIN command will create and distribute the new channel key
67    to everybody on the channel.
68
69  o New configuration file format must be added.  The new one will be
70    done using the dotconf config library (lib/dotconf).  The following
71    tasks relates closely to this as well and must be done at the same time
72    when adding the new config file format:
73
74         o Server says that it is able to listen on multiple ports but
75           currently that is bogus.  It can, but internals are for single
76           server.
77
78         o Protocol execution timeouts are hard coded, should be
79           configurable.
80
81         o IP address fields in configuration file should accept mask
82           format as well, IP/MASK, and not just plain IP.
83
84  o Lots of statistics updating is missing around the server.
85
86  o If client's public key is saved in the server (and doing public key
87    authentication) then the hostname and the username information could
88    be taken from the public key.  Should be a configuration option!
89
90
91 TODO/bugs In SILC Libraries
92 ===========================
93
94  o WIN32 silc_net_create_connection_async does not work the same way
95    than on Unix.  Do it with threads on WIN32.  The function works but
96    is not actually async currently.
97
98  o Rewrite the lib/silcsim/silcsim.h.  The SilcSimContext should be
99    private and silc_sim_alloc should take necessary arguments.
100
101
102 TODO in SILC Protocol
103 =====================
104
105 Current protocol version is 1.0.  However, it is far from being perfect,
106 and needs to include additional features.  Following protocol TODO entries
107 describe new stuff to be added to protocol versions 1.x.
108
109  1. Re-define the Status Payload: it is now 16 bits, split it into two
110     8 bits fields.  First field includes status types from 0 - 9 and
111     10 - n *if* it is not an list of errors.  If it is list of errors then
112     the first field includes 1, 2 and/or 3, and the second field includes
113     the error status 10 - n.  This way it is possible to send multiple
114     errors (list of errors) and we have a way to tell the receiver that
115     there will be other errors as well.  The second field is used only
116     if there is list of errors.  If normal status, or normal (single)
117     error status the second field is set to zero, and must be ignored.
118     Hence, the status works same way as now except for list of errors.
119     To be included in protocol version 1.1.
120
121  2. Define that WHOIS and IDENTIFY commands must send list of errors
122     if multiple Client ID (or Channel ID and Server ID for IDENTIFY) was
123     requested and was not found.  Each unfound entry must cause an error
124     command reply to the sender.  Also define that errors must be sent
125     *after* sending successfully found entries (this way receiver may
126     ignore them).  To be included in protocol version 1.1.
127
128  3. Define the NICK_CHANGE notify to send the changed nickname as a new
129     third argument.  This will make the NICK_CHANGE notify handling easier
130     in the receiver's end (client primarily) since it removes the
131     requirement that receiver must resolve (using IDENTIFY or WHOIS) the
132     new Client ID received in the notify (because of the new nickname is
133     unknown).  To be included in protocol version 1.1.
134
135  4. Add "request parameters" or similar to the WHOIS command, which can
136     be used to request various parameters (something not returned by
137     standard WHOIS command) about clients (info that could be fetched
138     even from clients).  Additional specification (or appendix) should 
139     be done to define the payload and the parameters.  It could be used
140     to make the WHOIS command support various search conditions as well.
141     This would be the way to extend the WHOIS command to support various
142     new features without always making the command incompatible to previous
143     version.  To be included in protocol version 1.1.
144
145  5. Inviting and banning by public key should be made possible.  To be
146     included in protocol version 1.x.
147
148  6. Add perhaps SILENCE_USERS, SILENCE_OPERS channel user modes which
149     can be used to silence (moderate) normal users and opers (this set
150     only by founder).  To be included in protocol version 1.1.
151
152  7. Channel Message Payload needs slight redesining to include the IV
153     field to the MAC generation of the payload.  It is authenticated
154     by the packet's MAC but not by the payload's MAC.  Since the IV
155     belongs to the payload, its integrity should be protected by the
156     payload MAC and not alone by packet MAC.  To be included in protocol 
157     version 1.1.
158
159  8. Remove the administrative commands from the protocol all together.
160     It does not make sense for the protocol to define how a server is
161     reconnected or shutdown, since they are implementation and 
162     configuration issues.  Besides protocol provides only limited set of
163     administrative commands and cannot define all that one could imagine.
164     To be included in protocol version 1.1.
165
166  9. Add SILC_MESAGE_FLAG_REPLY for being other side to the
167     SILC_MESSAGE_FLAG_REQUEST.  Add generic SILC_MESSAGE_FLAG_DATA, which
168     can include generic payload, which can include generic data.  The
169     payload definition is left out for now.  To be included in protocol
170     version 1.1.
171
172  10. Check command reply error status types in various commands,
173      specifically NO_FOPRIV is missing from many commands.  To be 
174      included in protocol version 1.1.
175
176
177 TODO After 1.0
178 ==============
179
180 A rough list of stuff that is going to be done to SILC after 1.0 or at
181 least could be done.
182
183  o Implement the defined SilcDH API.  The definition is in
184    lib/silccrypt/silcdh.h.
185
186  o X.509 certificate support.  SILC protocol supports certificates and
187    it would be great to have support for them.  This is a big task as
188    support has to be made for ASN.1 as well.  I've looked into OpenSSL 
189    package as it has X.509 certificate support (and ASN.1 as well).  
190    The code does not look very good to my eye but it has some potentials.
191    This should be looked at more closely.
192
193    Naturally own SILC Certificate API has to be defined regardles what
194    the actual X.509 library is (OpenSSL X.509 or something else).  Other
195    choice is to write own X.509 library but I'm not going to do it - 
196    I can help to migrate the OpenSSL X.509 into SILC and I can help if 
197    someone would like to write the X.509 library - but I'm not going 
198    to start writing one myself.  Anyhow, the OpenSSL X.509 lib should
199    be checked.
200
201    Other package that should be checked is the NSS's X509 library,
202    which I like more over OpenSSL package.
203
204  o SSH2 public keys support, allowing the use of SSH2 public keys in
205    SILC.
206
207  o OpenPGP certificate support, allowing the use of PGP public keys
208    in SILC.
209
210  o Compression routines are missing.  The protocol supports packet
211    compression thus it must be implemented.  SILC Zip API must be
212    defined.
213
214  o Rewrite the lib/silcutil/silcprotocol.[ch] not to have [un]register 
215    functions, but to make it context based all the way.  The alloc should 
216    take as argument the protocol type and its callback (not only 
217    final callback).  It is not good that we have now global list of 
218    registered protocols.
219
220  o Optimizations in Libraries
221
222         o There is currently three (3) allocations per packet in the
223           silc_packet_receive_process, which is used to process and
224           dispatch all packets in the packet queue to the parser callback
225           function.  First allocation is for parse_ctx, second for the
226           SilcPacketContext, and third for packet->buffer where the actual
227           data is saved.
228
229           The parse_ctx allocation can be removed by adding it as a
230           structure to the SilcPacketContext.  When the SilcPacketContext
231           is allocated there is space for the parse context already.
232
233           The silc_packet_context_alloc could have a free list of
234           packet contexts.  If free packet context is found from the list
235           it is returned instead of allocating a new one.  The library
236           could at first allocate them and save them to the free list
237           until enough contexts for smooth processing exists in the list.
238           This would remove a big allocation since the structure is
239           quite big, and even bigger if it would include the parse_ctx.
240
241           The packet->buffer can be optimized too if the SilcBuffer
242           interface would support free lists as well.  Maybe such could
243           be done in the same way as for SilcPacketContext.  The
244           silc_buffer_alloc would check free list before actually 
245           allocating new memory.  Since the packets in the SILC protocol
246           usually are about the same size (due to padding) it would be
247           easy to find suitable size buffer from the free list very
248           quickly.
249
250           These naturally cause the overal memory consumption to grow
251           but would take away many allocations that can be done several
252           times in a second.
253
254         o Move the actual file descriptor task callback (the callback that
255           handles the incoming data, outgoing data etc, that is implemnted
256           in server and client separately (silc_server_packet_process and
257           silc_client_packet_proces)) to the low level socket connection
258           handling routines, and create an interface where the application
259           can register a callbacks for incoming data, outoing data and EOF
260           receiving, which the library will call when necessary.  This way 
261           we can move the data handling in one place.
262
263         o Add silc_id_str2id to accept the destination buffer as argument
264           and thus not require any memory allocation.  Same will happen
265           with silc_id_payload_* functions.
266
267  o Optimizations in Server
268
269         o Remove the big switch statement from the function 
270           silc_server_packet_parse_type and replace it with predefined
271           table of function pointers where each of the slot in table
272           represents the packet type value.
273
274           Same could be done with notify packets which has big switch 
275           statement too.  Same kind of table of notify callbacks could be
276           done as well.
277
278         o The parser callback in the server will add a timeout task for
279           all packets.  It will require registering and allocating a
280           new task to the SilcSchedule.  Maybe, at least, for server
281           and router packets the parser would be called immediately
282           instead of adding it to the scheduler with 0 timeout.  It
283           should be analyzed too how slow the task registering process
284           actually is, and find out ways to optimize it.
285
286  o Add SilcAsyncOperation to utility library.
287
288  o Cipher optimizations (asm, that this) at least for i386 would be nice.
289
290  o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
291    SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
292    in separately.