Example code to get nickname from cert
[tor.git] / doc / FAQ
blob87a70719d1f144bb44f0b27a51f686af909ac0c4
1 The Onion Routing (TOR) Frequently Asked Questions
2 --------------------------------------------------
4 1. General.
6 1.1. What is tor?
8 Tor is an implementation of version 2 of Onion Routing.
10 Onion Routing is a connection-oriented anonymizing communication
11 service. Users build a layered block of asymmetric encryptions
12 (an "onion") which describes a source-routed path through a set of
13 nodes. Those nodes build a "virtual circuit" through the network, in which
14 each node knows its predecessor and successor, but no others. Traffic
15 flowing down the circuit is unwrapped by a symmetric key at each node,
16 which reveals the downstream node.
18 Basically tor provides a distributed network of servers ("onion
19 routers"). Users bounce their tcp streams (web traffic, ftp, ssh, etc)
20 around the routers, and recipients, observers, and even the routers
21 themselves have difficulty tracking the source of the stream.
23 1.2. Why's it called tor?
25 Because tor is the onion routing system. I kept telling people I was
26 working on onion routing, and they said "Neat. Which one?" Even if onion
27 routing has become a standard household term, this is the actual onion
28 routing project, started out of the Naval Research Lab.
30 (Theories about recursive acronyms are ok too.)
32 1.3 Is there a backdoor in tor?
34 Not right now, but if this answer changes we probably won't be allowed
35 to tell you. You should always check the source (or at least the diffs
36 since the last release) for suspicious things; and if we don't give you
37 source, that's a sure sign something funny could be going on.
39 2. Compiling and installing.
41 [Read the README file for now; check back here once we've got packages/etc
42 for you.]
45 3. Running tor.
47 3.1. What kind of server should I run?
49 The same executable ("or") functions as both client and server, depending
50 on which ports are specified in the configuration file. You can specify:
51 * APPort: client applications (eg privoxy, Mozilla) can speak socks to
52   this port.
53 * OPPort: onion proxies (client onion routers) connect to this port.
54 * ORPort: other onion routers connect to this port
55 * DirPort: onion proxies and onion routers speak http to this port, to
56   pull down a directory of which nodes are currently available.
58 3.2. So I can just run a full onion router and join the network?
60 No. Users should run just an onion proxy (use the 'oprc' config file).
61 If you start up a full onion router, the rest of the routers in the
62 system won't recognize you, so they will reject your handshake attempts.
64 3.3. How do I join the network then?
66 If you just want to use the onion routing network, you can run a proxy
67 and you're all set. If you want to run a router, you must convince
68 the directory server operators (currently arma@mit.edu) that you're a
69 trustworthy person. From there, the operators add you to the directory,
70 which propagates out to the rest of the network. All nodes will know
71 about you within an hour.
73 3.4. I want to run a directory server too.
75 If you run a very reliable node, you plan to be around for a long time,
76 and you want to spend some time ensuring that router operators are
77 people we know and like, we may want you to run a directory server
78 too. We must manually add you to the 'dirservers' file that's part of
79 the distribution; users will only know about you when they upgrade to
80 a new version. Of course, you can always just start up your router as a
81 directory server too --- but users won't know to ask you for directories,
82 and more importantly, you'll never learn from the real directory servers
83 about recently joined routers.
86 4. Development.
88 4.1. Who's doing this?
90 4.2. Can I help?
92 4.3. I've got a bug.
95 5. Anonymity.
97 5.1. So I'm totally anonymous if I use tor?
101 5.2. Where can I learn more about anonymity?
103 5.3. What attacks remain against onion routing?
105 tagging: can change bytes in the cells, even through link encryption
106 end node can give back wrong data, even subtly wrong data.
109 6. Comparison to related projects.
111 6.1. Onion Routing.
113 Tor *is* onion routing.
115 6.2. Freedom.
118 7. Protocol and application support.
120 7.1. http? ftp? udp? socks? mozilla?