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