updates
[silc.git] / TODO
1 TODO/bugs in Irssi SILC client
2 ==============================
3
4  o /cumode for unknown nick does not give any error message (Fix this to
5    1.0).
6
7
8 TODO/bugs In SILC Client Library
9 ================================
10
11  o The PRIVATE_MESSAGE_KEY packet is not handled (it is implemented 
12    though).  This should be added and perhaps new client operation
13    should be added to notify application that it was received and
14    set the key only if application wishes to set (accept the key) it
15    (Do this to 1.0).
16
17  o Additions to do after protocol version 1.1:
18
19         o Fix the NICK_CHANGE notify handling not to create new entry
20           for the changed client, but take the nickname from the notify
21           (removes need for resolving as well).  Protocol TODO entry 3.
22
23         o Add support for list of errors in command replies.  Protocol
24           TODO entry 1.
25
26
27 TODO/bugs In SILC Server
28 ========================
29
30  o Configuration file additions (Do this to 0.8.x):
31
32         o Add incoming connection frequency, incoming connection frequency
33           for single IP address, key exchange frequency, key exchange
34           frequency for single IP. Add also frequency base.
35
36         o Add rehashing support.
37
38  o If server send CUMODE_CHANGE notify (like setting founder) to router
39    and router does not have founder on channel (founder is left or there's
40    no founder on channel at all), the router will accept the server's
41    founder mode change, even though it perhaps should not do that (Fix 
42    this to 0.9).
43
44  o The router should check for validity of received notify packets from
45    routers (fix this to 0.9).  Following NOTIFYs needs to be verified:
46
47         o JOIN (check that joining is allowed)
48         o SIGNOFF (maybe should check that notifier owns the client)
49         o KILLED (check that killling is allowed (Protocol TODO #13))
50
51  o Backup router related issues (Fix this to 1.0):
52
53         o Channel user mode changes are notified unnecessarely when
54           switching to backup router on router crash.
55
56  o Add a timeout to handling incoming JOIN commands.  It should be 
57    enforced that JOIN command is executed only once in a second or two
58    seconds.  Now it is possible to accept n incoming JOIN commands
59    and process them without any timeouts.  THis must be employed because
60    each JOIN command will create and distribute the new channel key
61    to everybody on the channel (Fix this to 1.0).
62
63  o Lots of statistics updating is missing around the server.
64
65  o If client's public key is saved in the server (and doing public key
66    authentication) then the hostname and the username information could
67    be taken from the public key.  Should be a configuration option!
68
69
70 TODO/bugs In SILC Libraries
71 ===========================
72
73  o WIN32 silc_net_create_connection_async does not work the same way
74    than on Unix.  Do it with threads on WIN32.  The function works but
75    is not actually async currently.
76
77  o EPOC specific additions/changes required:
78
79         o lib/silcutil/epoc routines missing or not completed.
80
81
82 TODO in Toolkit Documentation
83 =============================
84
85 Stuff that needs to be done in order to complete the Tooolkit Reference
86 Manual.
87
88  o ROBOdoc documenting missing from lib/silcutil/silcbuffer.h.
89
90  o ROBOdoc documenting missing from lib/silcutil/silcdlist.h.
91
92  o ROBOdoc documenting missing from lib/silcutil/silcfileutil.h.
93
94  o ROBOdoc documenting missing from lib/silcutil/silcutil.h.
95
96  o ROBOdoc documenting missing from lib/silccrypt/silchash.h.
97
98  o ROBOdoc documenting missing from lib/silccrypt/silccipher.h.
99
100  o ROBOdoc documenting missing from lib/silccrypt/silcpkcs.h.
101
102  o Write "Programming with Toolkit" document, describing how to build
103    Toolkit, how the build system works, where is everything, how
104    new (external) projects can be glued into Toolkit (use irssi as an
105    example), and how external projects can use Toolkit without gluing into
106    it (how to link etc), debugging, architecture, types, etc.
107
108  o Write "Platform Implementations" document to describe what platforms
109    Toolkit support, what has been implemented, what has not been, what
110    works differently etc.
111
112
113 TODO in SILC Protocol
114 =====================
115
116 Current protocol version is 1.0.  However, it is far from being perfect,
117 and needs to include additional features.  Following protocol TODO entries
118 describe new stuff to be added to protocol versions 1.x.
119
120  1. Re-define the Status Payload: it is now 16 bits, split it into two
121     8 bits fields.  First field includes status types from 0 - 9 and
122     10 - n *if* it is not an list of errors.  If it is list of errors then
123     the first field includes 1, 2 and/or 3, and the second field includes
124     the error status 10 - n.  This way it is possible to send multiple
125     errors (list of errors) and we have a way to tell the receiver that
126     there will be other errors as well.  The second field is used only
127     if there is list of errors.  If normal status, or normal (single)
128     error status the second field is set to zero, and must be ignored.
129     Hence, the status works same way as now except for list of errors.
130     To be included in protocol version 1.1.
131
132  2. Define that WHOIS and IDENTIFY commands must send list of errors
133     if multiple Client ID (or Channel ID and Server ID for IDENTIFY) was
134     requested and was not found.  Each unfound entry must cause an error
135     command reply to the sender.  Also define that errors must be sent
136     *after* sending successfully found entries (this way receiver may
137     ignore them).  To be included in protocol version 1.1.
138
139  3. Define the NICK_CHANGE notify to send the changed nickname as a new
140     third argument.  This will make the NICK_CHANGE notify handling easier
141     in the receiver's end (client primarily) since it removes the
142     requirement that receiver must resolve (using IDENTIFY or WHOIS) the
143     new Client ID received in the notify (because of the new nickname is
144     unknown).  To be included in protocol version 1.1.
145
146  4. Add "request parameters" or similar to the WHOIS command, which can
147     be used to request various parameters (something not returned by
148     standard WHOIS command) about clients (info that could be fetched
149     even from clients).  Additional specification (or appendix) should 
150     be done to define the payload and the parameters.  It could be used
151     to make the WHOIS command support various search conditions as well.
152     This would be the way to extend the WHOIS command to support various
153     new features without always making the command incompatible to previous
154     version.  To be included in protocol version 1.1.
155
156  5. Inviting and banning by public key should be made possible.  To be
157     included in protocol version 1.x.
158
159  6. Add perhaps SILENCE_USERS, SILENCE_OPERS channel user modes which
160     can be used to silence (moderate) normal users and opers (this set
161     only by founder).  To be included in protocol version 1.1.
162
163  7. Channel Message Payload needs slight redesining to include the IV
164     field to the MAC generation of the payload.  It is authenticated
165     by the packet's MAC but not by the payload's MAC.  Since the IV
166     belongs to the payload, its integrity should be protected by the
167     payload MAC and not alone by packet MAC.  To be included in protocol 
168     version 1.1.
169
170  8. Remove the administrative commands from the protocol all together.
171     It does not make sense for the protocol to define how a server is
172     reconnected or shutdown, since they are implementation and 
173     configuration issues.  Besides protocol provides only limited set of
174     administrative commands and cannot define all that one could imagine.
175     To be included in protocol version 1.1.
176
177  9. Add SILC_MESAGE_FLAG_REPLY for being other side to the
178     SILC_MESSAGE_FLAG_REQUEST.  Add generic SILC_MESSAGE_FLAG_DATA, which
179     can include generic payload, which can include generic data.  The
180     payload definition is left out for now.  To be included in protocol
181     version 1.1.
182
183  10. Check command reply error status types in various commands,
184      specifically NO_FOPRIV is missing from many commands.  To be 
185      included in protocol version 1.1.
186
187  11. Change the wording in Private Message Key Payload definition to
188      describe the problems of trusting the payload, and to indicate that
189      the receiver may not accept the key in the payload, and to describe
190      other means of distributing a key.
191
192  13. Add the killer's client ID to the KILLED notify.  To be included in 
193      protocol version 1.1.
194
195  14. The length of Arguments Num field in Notify Payload and Command
196      Payload enforces that total of 256 arguments can be associated
197      to a such payload.  However, command-xx draft specified much higher
198      values, and these should be fixed.