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