add a new file ReleaseNotes that contains just the
[tor.git] / doc / TODO
blobbd2e787c4f2b36a152ecdc8a074a6150741c145f
1 $Id$
2 Legend:
3 SPEC!!  - Not specified
4 SPEC    - Spec not finalized
5 N       - nick claims
6 R       - arma claims
7 P       - phobos claims
8         - Not done
9         * Top priority
10         . Partially done
11         o Done
12         d Deferrable
13         D Deferred
14         X Abandoned
16     X <nickm> "Let's try to find a way to make it run and make the version
17        match, but if not, let's just make it run."
18     X <arma> "should we detect if we have a --with-ssl-dir and try the -R
19       by default, if it works?"
21 Items for 0.1.2.x, real soon now:
22 ? - Bug: combination of things:
23     When we've been idle a long time, we stop fetching server
24     descriptors. When we then get a socks request, we build circuits
25     immediately using whatever descriptors we have, rather than waiting
26     until we've fetched correct ones.
28 N - Test guard unreachable logic; make sure that we actually attempt to
29     connect to guards that we think are unreachable from time to time.
30     Make sure that we don't freak out when the network is down.
32 R - Reconstruct ChangeLog; put rolled-up info in ReleaseNotes or something.
34 Items for 0.1.2.x:
35   - weight dir requests by advertised bandwidth? with maybe a lower cutoff
36     than for tor traffic. perhaps also weighted by the expected size of
37     the response.
38   o enumerate events of important things that occur in tor, so vidalia can
39     react.
40     o Backend implementation
41     o Actually list all the events (notice and warn log messages are a good
42       place to look.)  Divide messages into categories, perhaps.
43     o Specify general event system
44     o Specify actual events.
45     o Implement or defer remaining events
46     D Implement or defer GETINFO list of current status events.
47     o Clean up relevant bits of control-spec.txt
49   . Have (and document) a BEGIN_DIR relay cell that means "Connect to your
50     directory port."
51     o Implement
52 R   - turn the received socks addr:port into a digest for setting .exit
53     - be able to connect without having a server descriptor, to bootstrap.
54 R     - handle connect-dir streams that don't have a chosen_exit_name set.
55       o include ORPort in DirServers lines so we can know where to connect.
56         list the orport as 0 if it can't handle begin_dir.
57         - List orports of actual dirservers..
59   - Servers are easy to setup and run: being a relay is about as easy as
60     being a client.
61     . Reduce resource load
62       o A way to alert controller when router flags change.
63         o Specify: SETEVENTS NS
64         o Implement
65 R       - Hunt for places that change networkstatus info that I might have
66           missed.
68   . option to dl directory info via tor:
69     TunnelDirConns and PreferTunneledDirConns
70 R   - actually cause the directory.c functions to know about or_port
71       and use it when we're supposed to.
72 N   - for tunneled edge conns, stop reading to the bridge connection
73       when the or_conn we're writing to has a full outbuf.
74       - This is iffy.  Really, it would've been better to stop writing
75         on the dir conn when the edge conn's inbuf is getting full.
76         But the issue there is that we package from edge
77         connections aggressively until we hit their package windows or the
78         circuit package windows, even if the buffer on the corresponding OR
79         connection is pretty damn big.  This sucks from a RAM usage POV.
80         Now, we could try to stop reading on the edges (or just the edges
81         connected to a local bridge) when an or_conn's outbuf is full.  But
82         if we're a server, and we stop reading on some exit conns when OR
83         conns are full, soon OR conns will contain only traffic from other OR
84         conns, and the exit data in question  will never get written.
86       - The right solution in the long run (0.2.0) is probably as follows:
87         - Remove socketpair-based bridges: use shared (or connected) buffers
88           for communication, rather than sockets.
89         - When relaying cells from an OR conn to an OR conn, have them wait
90           in a queue on the or_circuit_t object; don't move them onto the
91           target conn until there is space in the target conn's outbuf.
92           Also, only package data from exitconns when there is space in the
93           target conn's outbuf.
94           - As an added advantage, this would let us kill stalled _circuits_
95             when their buffers get too full, rather than killing entire OR
96             conns.  But we must think about anonymity implications of that.
97         - We'll probably want to do some kind of big refactoring of our
98           dataflow when we do these changes; stuff is hairy enough already,
99           and it will only get harrier with this stuff.
101       - For the short run, our options seem to be:
102         - Disable BEGIN_DIR support at the server-side unless it's
103           explicitly turned on.
104         - Go ahead and make directory bridge data not get produced when the
105           corresponding or_conn is full, and accept the sometimes directory
106           data will just never get written.
107         - Rate-limit directory bridge data somehow when the corresponding
108           or_conn is full.  Possibly based on the flush rate of the or_conn?
109         - Reject BEGIN_DIR requests that we think will be insanely big.
112 N - DNS improvements
113     . Asynchronous DNS
114       - Make evdns use windows strerror equivalents.
115       - Make sure patches get into libevent.
116       - Verify that it works well on windows
117     - Debug and re-enable server-side reverse DNS caching
119   - Critical but minor bugs, backport candidates.
120     - support dir 503s better
121       o clients don't log as loudly when they receive them
122       o they don't count toward the 3-strikes rule
123         D But eventually, we give up after getting a lot of 503s.
124         D Delay when we get a lot of 503s, rather than punting onto the
125           servers that have given us 503s?
126         o Add a 'BadDirectory' flag to statuses.
127       o authorities should *never* 503 a cache, and should never 503
128         network status requests.
129       D They can 503 client descriptor requests when they feel like it.
130         How can they distinguish? Not implemented for now, maybe
131         should abandon.
132       - update dir-spec with what we decided for each of these
134   o Have a mode that doesn't write to disk much, so we can run Tor on
135     flash memory (e.g. Linksys routers or USB keys).
136     o Add AvoidDiskWrites config option.
137     o only write state file when it's "changed"
138       o crank up the numbers if avoiddiskwrites is on.
139       D some things may not want to get written at all.
140     o stop writing fingerprint every restart
141     D more?
143 NR. Write path-spec.txt
145   - Polishing
146     - Profile client and server; fix slow spots
147     - Address XXX012 items
149   - Packaging
150     - Tell people about OSX Uninstaller
151     - Quietly document NT Service options
152     - Switch canonical win32 compiler to mingw.
153 NR  D Get some kind of "meta signing key" to be used solely to sign
154       releases/to certify releases when signed by the right people/
155       to certify sign the right people's keys?  Also use this to cert the SSL
156       key, etc.
157     - If we haven't replaced privoxy, lock down its configuration in all
158       packages, as documented in tor-doc-unix.html
160   - Docs
161     - More prominently, we should have a recommended apps list.
162       - recommend gaim.
163       - unrecommend IE because of ftp:// bug.
164 N   - torrc.complete.in needs attention?
165 N   - we should add a preamble to tor-design saying it's out of date.
166 N   - Document transport and natdport
168   - Improvements to bandwidth counting
169 R   - look into "uncounting" bytes spent on local connections, so
170       we can bandwidthrate but still have fast downloads.
171 R   - "bandwidth classes", for incoming vs initiated-here conns,
172       and to give dir conns lower priority.
173     . Write limiting; separate token bucket for write
174       o preemptively give a 503 to some v1 dir requests
175       o preemptively give a 503 to some v2 dir requests
176         o Write function to estimate bytes needed for N descriptors
177           statuses
178       D per-conn write buckets
179       D separate config options for read vs write limiting
180         (It's hard to support read > write, since we need better
181          congestion control to avoid overfull buffers there.  So,
182          defer the whole thing.)
184   - Forward compatibility fixes
185     - Caches should start trying to cache consensus docs?
186 NR    - Design
187 N     - Implement, if we think it's smart.
188     - Start uploading short and long descriptors; authorities should support
189       URLs to retrieve long descriptors, and should discard short descriptors
190       for now.  Later, once tools use the "long descriptor" URLs, authorities
191       will serve the short descriptors every time they're asked for
192       a descriptor.
193 NR    - Design
194 N     - Implement, if we think it's smart.
196 Topics to think about during 0.1.2.x development:
197   * Figure out incentives.
198     - (How can we make this tolerant of a bad v0?)
199   * Figure out non-clique.
200   * Figure out China.
201   - Figure out partial network knowledge.
202   - Figure out hidden services.
203   - Design next-version protocol for directories
204   - Design next-version protocol for connections
206 Deferred from 0.1.2.x:
207 P - Figure out why dll's compiled in mingw don't work right in WinXP.
208 P - Figure out why openssl 0.9.8d "make test" fails at sha256t test.
209   - Directory guards
210   - RAM use in directory authorities.
211   - Memory use improvements:
212     - Look into pulling serverdescs off buffers as they arrive.
213     - Save and mmap v1 directories, and networkstatus docs; store them
214       zipped, not uncompressed.
215       - Switch cached_router_t to use mmap.
216       - What to do about reference counts on windows?  (On Unix, this is
217         easy: unlink works fine.  (Right?)  On Windows, I have doubts.  Do we
218         need to keep multiple files?)
219       - What do we do about the fact that people can't read zlib-
220         compressed files manually?
222   - If the client's clock is too far in the past, it will drop (or
223     just not try to get) descriptors, so it'll never build circuits.
224   - Tolerate clock skew on bridge relays.
226   - A more efficient dir protocol.
227     - Authorities should fetch the network-statuses amongst each
228       other, consensus them, and advertise a communal network-status.
229       This is not so much for safety/complexity as it is to reduce
230       bandwidth requirements for Alice.
231       - How does this interact with our goal of being able to choose
232         your own dir authorities? I guess we're now assuming that all
233         dir authorities know all the other authorities in their "group"?
234     - Should we also look into a "delta since last network-status
235       checkpoint" scheme, to reduce overhead further?
236     - Extend the "r" line in network-status to give a set of buckets (say,
237       comma-separated) for that router.
238       - Buckets are deterministic based on IP address.
239       - Then clients can choose a bucket (or set of buckets) to
240         download and use.
242   - Improvements to versioning.
243     - When we connect to a Tor server, it sends back a cell listing
244       the IP it believes it is using. Use this to block dvorak's attack.
245       Also, this is a fine time to say what time you think it is.
246       o Verify that a new cell type is okay with deployed codebase
247       . Specify HELLO cells
248       . Figure out v0 compatibility.
249       - Implement
251   - Eventdns improvements
252     - Have a way to query for AAAA and A records simultaneously.
253     - Improve request API: At the very least, add the ability to construct
254       a more-or-less arbitrary request and get a response.
255     - (Can we suppress cnames? Should we?)
257   - Now that we're avoiding exits when picking non-exit positions,
258     we need to consider how to pick nodes for internal circuits. If
259     we avoid exits for all positions, we skew the load balancing. If
260     we accept exits for all positions, we leak whether it's an internal
261     circuit at every step. If we accept exits only at the last hop, we
262     reintroduce Lasse's attacks from the Oakland paper.
264   - We should ship with a list of stable dir mirrors -- they're not
265     trusted like the authorities, but they'll provide more robustness
266     and diversity for bootstrapping clients.
268   - Simplify authority operation
269     - Follow weasel's proposal, crossed with mixminion dir config format
271   - A way to adjust router flags from the controller.
272     (How do we prevent the authority from clobbering them soon after?)
273   - a way to pick entry guards based wholly on extend_info equivalent;
274     a way to export extend_info equivalent.
276   - Better estimates in the directory of whether servers have good uptime
277     (high expected time to failure) or good guard qualities (high
278     fractional uptime).
279     - AKA Track uptime as %-of-time-up, as well as time-since-last-down
281   - Have a "Faster" status flag that means it. Fast2, Fast4, Fast8?
282     - spec
283     - implement
285   - Failed rend desc fetches sometimes don't get retried. True/false?
287   - Windows server usability
288     - Solve the ENOBUFS problem.
289       - make tor's use of openssl operate on buffers rather than sockets,
290         so we can make use of libevent's buffer paradigm once it has one.
291       - make tor's use of libevent tolerate either the socket or the
292         buffer paradigm; includes unifying the functions in connect.c.
293     - We need a getrlimit equivalent on Windows so we can reserve some
294       file descriptors for saving files, etc. Otherwise we'll trigger
295       asserts when we're out of file descriptors and crash.
296 M   - rewrite how libevent does select() on win32 so it's not so very slow.
297       - Add overlapped IO
299   - Add an option (related to AvoidDiskWrites) to disable directory caching.
301   - More status event features:
302     - Missing events:
303       - DIR_REACHABLE
304       - BAD_DIR_RESPONSE (Unexpected directory response; maybe we're behind
305         a firewall.)
306       - BAD_PROXY (Bad http or https proxy)
307       - UNRECOGNIZED_ROUTER (a nickname we asked for is unavailable)
308       - Status events related to hibernation
309       - something about failing to parse our address?
310         from resolve_my_address() in config.c
311       - sketchy OS, sketchy threading
312       - too many onions queued: threading problems or slow CPU?
313     - Missing fields:
314       - TIMEOUT on CHECKING_REACHABILITY
315     - GETINFO status/client, status/server, status/general: There should be
316       some way to learn which status events are currently "in effect."
317       We should specify which these are, what format they appear in, and so
318       on.
320 Minor items for 0.1.2.x as time permits:
321   - include bandwidth breakdown by conn->type in BW events.
322   - getinfo ns/name/moria2 doesn't include a "v" line, even when some
323     network-statuses I have show it. I suppose the fix should go in
324     networkstatus_getinfo_helper_single() in routerlist.c.
325   - Unify autoconf search code for libevent and openssl.  Make code
326     suggest platform-appropriate "devel" / "dev" / whatever packages
327     if we can link but we can't find the headers.
328   - Recommend polipo? Please?
329   - Make documentation realize that location of system configuration file
330     will depend on location of system defaults, and isn't always /etc/torrc.
331   - Review torrc.sample to make it more discursive.
332   o when reporting clock skew (both to logs and to controller), if it's
333     taken 126 seconds to read from the directory, our clock skew estimate
334     is 126 seconds wrong. use conn->timestamp_create or _lastwritten
335     for a closer estimate?
336   - a way to generate the website diagrams from source, so we can
337     translate them as utf-8 text rather than with gimp.
338 R - add d64 and fp64 along-side d and fp so people can paste status
339     entries into a url. since + is a valid base64 char, only allow one
340     at a time. spec and then do.
341   D don't do dns hijacking tests if we're reject *:* exit policy?
342     (deferred until 0.1.1.x is less common)
343   - When we export something from foo.c file for testing purposes only,
344     make a foo_test.h file for test.c to include.
345   - The Debian package now uses --verify-config when (re)starting,
346     to distinguish configuration errors from other errors. Perhaps
347     the RPM and other startup scripts should too?
348   - add a "default.action" file to the tor/vidalia bundle so we can fix the
349     https thing in the default configuration:
350     http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#PrivoxyWeirdSSLPort
351   . Flesh out options_description array in src/or/config.c
352   - Don't let 'newnym' be triggered more often than every n seconds.
353   X If we try to publish as a nickname that's already claimed, should
354     we append a number (or increment the number) and try again? This
355     way people who read their logs can fix it as before, but people
356     who don't read their logs will still offer Tor servers.
357     - Fall back to unnamed; warn user; send controller event.  ("When we
358       notice a 'Rejected: There is already a named server with this nickname'
359       message... or maybe instead when we see in the networkstatuses that
360       somebody else is Named with the name we want: warn the user, send a
361       STATUS_SERVER message, and fall back to unnamed.")
362 ! - Tor should bind its ports before dropping privs, so users don't
363     have to do the ipchains dance.
364   - Rate limit exit connections to a given destination -- this helps
365     us play nice with websites when Tor users want to crawl them; it
366     also introduces DoS opportunities.
367   - Streamline how we pick entry nodes: Make choose_random_entry() have
368     less magic and less control logic.
369   - Christian Grothoff's attack of infinite-length circuit.
370     the solution is to have a separate 'extend-data' cell type
371     which is used for the first N data cells, and only
372     extend-data cells can be extend requests.
373     - Specify, including thought about anonymity implications.
374   - Display the reasons in 'destroy' and 'truncated' cells under some
375     circumstances?
376   - We need a way for the authorities to declare that nodes are
377     in a family.  Also, it kinda sucks that family declarations use O(N^2)
378     space in the descriptors.
379   - If the server is spewing complaints about raising your ulimit -n,
380     we should add a note about this to the server descriptor so other
381     people can notice too.
382   - cpu fixes:
383     - see if we should make use of truncate to retry
384     X kill dns workers more slowly
385   . Directory changes
386     . Some back-out mechanism for auto-approval
387       - a way of rolling back approvals to before a timestamp
388         - Consider minion-like fingerprint file/log combination.
389   - packaging and ui stuff:
390     . multiple sample torrc files
391     . figure out how to make nt service stuff work?
392       . Document it.
393     - Vet all pending installer patches
394       - Win32 installer plus privoxy, sockscap/freecap, etc.
395       - Vet win32 systray helper code
397   - Improve controller
398       - a NEWSTATUS event similar to NEWDESC.
399       - change circuit status events to give more details, like purpose,
400         whether they're internal, when they become dirty, when they become
401         too dirty for further circuits, etc.
402         - What do we want here, exactly?
403         - Specify and implement it.
404       - Change stream status events analogously.
405         - What do we want here, exactly?
406         - Specify and implement it.
407       - Make other events "better".
408       - Change stream status events analogously.
409         - What do we want here, exactly?
410         - Specify and implement it.
411       - Make other events "better" analogously
412         - What do we want here, exactly?
413         - Specify and implement it.
414       . Expose more information via getinfo:
415         - import and export rendezvous descriptors
416         - Review all static fields for additional candidates
417       - Allow EXTENDCIRCUIT to unknown server.
418       - We need some way to adjust server status, and to tell tor not to
419         download directories/network-status, and a way to force a download.
420       - Make everything work with hidden services
421   - Directory system improvements
422     - config option to publish what ports you listen on, beyond
423       ORPort/DirPort.  It should support ranges and bit prefixes (?) too.
424       - Parse this.
425       - Relay this in networkstatus.
427   - Be a DNS proxy.
428     - Need a way to request address lookups (and allocate a stream ID for
429       them) without having a corresponding client socket.
430       - Once this is done, it would be nice to have a way to request address
431         lookups from the controller without using SOCKS.
432     - Refactor exit/entry side of DNS resolve: we don't need a connection_t;
433       we can have an edge_connection_t and (say) dns_request_t both extend an
434       edge_stream_t, and have p_streams and n_streams both be linked lists
435       of edge_stream_t.
437   - Look into generating torrc.{complete|sample}.in, tor.1.in,
438     the HTML manual, and the online config documentation from a single
439     source.
441 Future version:
442   - Configuration format really wants sections.
443   - Good RBL substitute.
444   - Authorities should try using exits for http to connect to some URLS
445     (specified in a configuration file, so as not to make the List Of Things
446     Not To Censor completely obvious) and ask them for results.  Exits that
447     don't give good answers should have the BadExit flag set.
448   - Our current approach to block attempts to use Tor as a single-hop proxy
449     is pretty lame; we should get a better one.
450   . Update the hidden service stuff for the new dir approach.
451     - switch to an ascii format, maybe sexpr?
452     - authdirservers publish blobs of them.
453     - other authdirservers fetch these blobs.
454     - hidserv people have the option of not uploading their blobs.
455     - you can insert a blob via the controller.
456     - and there's some amount of backwards compatibility.
457     - teach clients, intro points, and hidservs about auth mechanisms.
458     - come up with a few more auth mechanisms.
459   - auth mechanisms to let hidden service midpoint and responder filter
460     connection requests.
461   - Bind to random port when making outgoing connections to Tor servers,
462     to reduce remote sniping attacks.
463   - Have new people be in limbo and need to demonstrate usefulness
464     before we approve them.
465   - Clients should estimate their skew as median of skew from servers
466     over last N seconds.
467   - Make router_is_general_exit() a bit smarter once we're sure what it's for.
468   - Audit everything to make sure rend and intro points are just as likely to
469     be us as not.
470   - Do something to prevent spurious EXTEND cells from making middleman
471     nodes connect all over.  Rate-limit failed connections, perhaps?
472   - Automatically determine what ports are reachable and start using
473     those, if circuits aren't working and it's a pattern we recognize
474     ("port 443 worked once and port 9001 keeps not working").
475   - Limit to 2 dir, 2 OR, N SOCKS connections per IP.
476   - Handle full buffers without totally borking
477   - Rate-limit OR and directory connections overall and per-IP and
478     maybe per subnet.
479   - Hold-open-until-flushed now works by accident; it should work by
480     design.
481   - DoS protection: TLS puzzles, public key ops, bandwidth exhaustion.
482     - Specify?
483   - tor-resolve script should use socks5 to get better error messages.
484   - hidserv offerers shouldn't need to define a SocksPort
485     * figure out what breaks for this, and do it.
486   - tor should be able to have a pool of outgoing IP addresses
487     that it is able to rotate through. (maybe)
488     - Specify; implement.
489   - let each hidden service (or other thing) specify its own
490     OutboundBindAddress?
491   - Stop using tor_socketpair to make connection bridges: do an
492     implementation that uses buffers only.
494 Blue-sky:
495   - Patch privoxy and socks protocol to pass strings to the browser.
496   - Standby/hotswap/redundant hidden services.
497   - Robust decentralized storage for hidden service descriptors.
498   - The "China problem"
499   - Allow small cells and large cells on the same network?
500   - Cell buffering and resending. This will allow us to handle broken
501     circuits as long as the endpoints don't break, plus will allow
502     connection (tls session key) rotation.
503   - Implement Morphmix, so we can compare its behavior, complexity, etc.
504   - Other transport. HTTP, udp, rdp, airhook, etc. May have to do our own
505     link crypto, unless we can bully openssl into it.
506   - Need a relay teardown cell, separate from one-way ends.
507     (Pending a user who needs this)
508   - Handle half-open connections: right now we don't support all TCP
509     streams, at least according to the protocol. But we handle all that
510     we've seen in the wild.
511     (Pending a user who needs this)
513 Non-Coding:
514   - Mark up spec; note unclear points about servers
515   - Mention controller libs someplace.
516   . more pictures from ren. he wants to describe the tor handshake
517 NR- write a spec appendix for 'being nice with tor'
518   - tor-in-the-media page
519   - Remove need for HACKING file.
520   - Figure out licenses for website material.
521   - Specify the keys and key rotation schedules and stuff
523 Website:
524   - and remove home and make the "Tor" picture be the link to home.
525   - put the logo on the website, in source form, so people can put it on
526     stickers directly, etc.
527 R - make a page with the hidden service diagrams.
529   - ask Jan to be the translation coordinator? add to volunteer page.
531   - add a page for localizing all tor's components.
533   - It would be neat if we had a single place that described _all_ the
534     tor-related tools you can use, and what they give you, and how well they
535     work.  Right now, we don't give a lot of guidance wrt
536     torbutton/foxproxy/privoxy/polipo in any consistent place.