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