Created SILC GIT repository.
[silc.git] / TODO
1 TODO for 1.2 And Beyond
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 NOTE: A TODO entry does not mean that it is ever going to be done.  Some
9 of the entries may be just ideas, good, bad or ugly.  If you want to work
10 on some of the TODO entries simply let us know about it by dropping a note
11 to silc-devel mailing list or appear on 'silc' channel on SILCNet.
12
13
14 lib/silccore
15 ============
16
17  o SILC_PACKET_FLAG_ACK support.  Implement ACK packet and packet payload
18    to silcpacket.c.
19
20  o All payload encoding routines should take SilcStack as argument.
21
22  o Remove SilcCommandCb from silccommand.h.
23
24  o All payload test routines into lib/silccore/tests/.
25
26
27 lib/silcclient, The Client Library
28 ==================================
29
30  o UDP SILC connection support to SILC server
31
32  o Giving WHOIS for nick that doesn't exist should remove any same
33    named entries from the client cache.
34
35  o peer-to-peer private messages
36
37  o Private message key request notification to application.  See XXX in
38    client_prvmsg.c.
39
40  o in JOIN notify handle resolving that timedout.  Currently the user is
41    never joined the channel if this happens.  What to do if message is
42    received from user that hasn't been resolved/joined?
43
44  o Add the SilcStream (socket stream) from the SilcPacketStream and
45    SilcSocket from the socket stream to SilcClientConnection for easier
46    access to them for programmers.  Currently these have to be digged up
47    from the packet stream.
48
49  o Connection option that attemps to connect to remot host with various
50    different mechanisms: UDP 706, TCP 706, TCP 80, TCP 443, UDP 7706 and
51    TCP 7706.  This is the so called hole punching mechanism.
52
53  o Message ACKing support.
54
55  o in /cmode and /cumode with +r, maybe the public key and private key
56    could be just some "string", which would then match to "string.pub" and
57    "string.prv".
58
59  o If the SILC Events (see below) are implemented, perhaps client library
60    should provide events so that application developer has a choice of
61    developing the SILC app with callbacks or with events.
62
63  o Ability to recover from rekey errors, at least try to.
64
65
66 SFTP Library, lib/silcsftp/
67 ===========================
68
69  o Read prefetch (read-ahead, reading ahead of time).  Maybe if this can
70    be done easily.
71
72
73 lib/silcske/silcske.[ch]
74 ========================
75
76  o Ratelimit to UDP/IP transport for incoming packets.
77
78
79 apps/silcd
80 ==========
81
82  o Deprecate the old server.  Write interface for the new lib/silcserver
83    server library.  The interface should work on Unix/Linux systems.
84
85  o Consider deprecating also the old config file format and use XML
86    istead.  This should require SILC XML API implementation first.
87
88  o The configuration must support dynamic router and server connections.
89    The silcd must work without specifying any servers or routers to
90    connect to.
91
92  o The configuration must support specifying whether the server is
93    SILC Server or SILC Router.  This should not be deduced from the
94    configuration as it was in < 1.2.
95
96  o The configuration must support specifying the ciphers and hmacs and
97    their order so that user can specify which algorithms take preference.
98
99
100 lib/silcserver
101 ==============
102
103  o Rewrite the entire server.  Deprecate apps/silcd as the main server
104    implementation and create lib/silcserver/.  It is a platform
105    independent server library.  The apps/silcd will merely provide a
106    a simple interface for the library.
107
108  o Write the SILC Server library extensively using SILC FSM.
109
110  o Server library must support multiple networks.  This means that one
111    server must be able to create multiple connections that each reach
112    different SILC network.  This means also that all cache's etc. must
113    be either connection-specific or network-specific.
114
115  o Library must support dynamic router and server connections.  This means
116    that connections are create only when they are needed, like when someone
117    says JOIN foo@foo.bar.com or WHOIS foobar@silcnet.org.
118
119  o Library must support server-to-server connections even though protocol
120    prohibits that.  The responder of the connection should automatically
121    act as a router.  The two servers create an own, isolated, SILC network.
122    To be used specifically with dynamic connections.
123
124  o Library must support multiple threads and must be entirely thread safe.
125
126  o Library must have support for SERVICE command.
127
128  o Both UDP and TCP support for incoming connecetions.  Maintaining long
129    term UDP sessions.
130
131  o The server must be able to run behind NAT device.  This means that
132    Server ID must be based on public IP instead of private IP (See
133    also NAT detection protocol in SILC protocol specification).
134
135  o The following data must be in per-connection context: client id cache,
136    server id cache, channel id cache, all statistics must be
137    per-connection.
138
139  o The following data must be in per-thread context: command context
140    freelist/pool, pending commands, random number generator.
141
142  o Do inccoming packet processing in an own FSM thread in the
143    server-threads FSM.  Same as in client library.
144
145  o Binding to other ports than 706 too.  To allow easier traversing
146    through NATs and firewalls server should also bind to 80, 443 and 7706
147    by default (at least try to bind).  Connections must work normally
148    even if they were established to some other port other than 706.
149
150    Connection option that attemps to connect to remot server with various
151    different mechanisms: UDP 706, TCP 706, TCP 80, TCP 443, UDP 7706 and
152    TCP 7706.  This is the so called hole punching mechanism.
153
154  o Ability to recover from rekey errors, at least try to.
155
156  o Reference count all Silc*Entry structures.
157
158  Some issues that must be kept in mind from 1.0 and 1.1 silcd's:
159
160  o The server and router software MUST work out of the box.  After
161    installation the server must not require any configuration to run the
162    most basic working configuration.  No defining IP addresses, etc.
163    The server must work just by running it.
164
165  o The SERVER_SIGNOFF notify handing is not optimal, because it'll
166    cause sending of multiple SIGNOFF notify's instead of the one
167    SERVER_SIGNOFF notify that the server received.  This should be
168    optimized so that the only SERVER_SIGNOFF is sent and not
169    SIGNOFF of notify at all (using SIGNOFF takes the idea about
170    SERVER_SIGNOFF away entirely).
171
172  o Another SERVER_SIGNOFF opt/bugfix:  Currently the signoff is
173    sent to a client if it is on same channel as the client that
174    signoffed.  However, the entire SERVER_SIGNOFF list is sent to
175    the client, ie. it may receive clients that was not on the
176    same channel.  This is actually against the specs.  It must be
177    done per channel.  It shouldn't receive the whole list just
178    because one client happened to be on same channel.
179
180  o If client's public key is saved in the server (and doing public key
181    authentication) then the hostname and the username information could
182    be taken from the public key.  Should be a configuration option!
183
184  o Add a timeout to handling incoming JOIN commands.  It should be
185    enforced that JOIN command is executed only once in a second or two
186    seconds.  Now it is possible to accept n incoming JOIN commands
187    and process them without any timeouts.  THis must be employed because
188    each JOIN command will create and distribute the new channel key
189    to everybody on the channel.
190
191  o Related to above.  If multiple JOINs are received in sequence perhaps
192    new key should be created only once, if the JOINs are handeled at the same
193    time.  Now we create multiple keys and never end up using them because
194    many JOINs are processed at the same time in sequence.  Only the last
195    key ends up being used.