tor-webwml.git

1) ## translation metadata

2) # Revision: $Revision$

3) # Translation-Priority: 2-medium
4) 
5) #include "head.wmi" TITLE="Tor: Documentation" CHARSET="UTF-8"
6) <div id="content" class="clearfix">
7)   <div id="breadcrumbs">

8)     <a href="<page index>">Home &raquo; </a>

9)     <a href="<page docs/documentation>">Documentation</a>
10)   </div>
11)   <div id="maincol"> 
12)     <a id="RunningTor"></a>
13)     <h1><a class="anchor" href="#RunningTor">Running Tor</a></h1>
14)     <ul>
15)     <li><a href="<page docs/tor-doc-windows>">Installing Tor
16)     on Win32</a></li>
17)     <li><a href="<page docs/tor-doc-osx>">Installing Tor on
18)     Mac OS X</a></li>
19)     <li><a href="<page docs/tor-doc-unix>">Installing Tor on
20)     Linux/BSD/Unix</a></li>

21)     <li><a href="<page torbutton/index>">Installing

22)     Torbutton for Tor</a></li>
23)     <li><a href="<page docs/tor-doc-relay>">Configuring a
24)     Tor relay</a></li>
25)     <li><a href="<page docs/tor-hidden-service>">Configuring
26)     a Tor hidden service</a></li>
27)     </ul>
28)     
29)     <a id="Support"></a>
30)     <a id="UpToSpeed"></a>
31)     <h1><a class="anchor" href="#UpToSpeed">Getting up to speed on Tor's past,
32)     present, and future</a></h1>
33)     
34)     <ol>
35)     <li>
36)     First, read the <a href="<page about/overview>">overview page</a> to get a
37)     basic idea of how Tor works, what it's for, and who uses it.
38)     </li>
39)     
40)     <li>
41)     <a href="<page download/download>">Install the Tor bundle</a> and try it out.
42)     Make sure you've got Firefox installed first, and be sure to read the
43)     <a href="<page download/download>#Warning">list of warnings</a> about ways you
44)     can screw up your anonymity.
45)     </li>
46)     
47)     <li>
48)     Our <a

49)     href="<page docs/faq>">FAQ</a>

50)     covers all sorts of topics, including questions about setting up a client
51)     or relay, concerns about anonymity attacks, why we didn't build Tor in
52)     other ways, etc.
53)     There's a separate <a href="<page docs/faq-abuse>">Abuse FAQ</a> to answer
54)     common questions from or for relay operators.
55)     The <a href="<page eff/tor-legal-faq>">Tor Legal FAQ</a> is written by
56)     EFF lawyers, and aims to give you an overview of some of the legal issues

57)     that arise from The Tor Project in the US.

58)     </li>
59)     

60)     <li>The <a href="<page docs/tor-manual-dev>">manual</a>

61)     lists all the possible entries you can put in your <a

62)     href="<page docs/faq>#torrc">torrc

63)     file</a>. We also provide a <a href="<page docs/tor-manual-dev>">manual for
64)     the development version of Tor</a>.</li>
65)     
66)     <li>If you have questions, we have an IRC channel (for users, relay
67)     operators, and developers)
68)     at <a href="irc://irc.oftc.net/tor">#tor on irc.oftc.net</a>. If
69)     you have a bug, especially a crash bug, read <a

70)     href="<wikifaq>#MyTorkeepscrashing.">how

71)     to report a Tor bug</a> first and then tell us as much information
72)     about it as you can in
73)     <a href="https://bugs.torproject.org/tor">our bugtracker</a>.
74)     (If your bug is

75)     with your browser or some other application, please don't put

76)     it in our bugtracker.) The

77)     <a href="#MailingLists">tor-talk mailing list</a> can also be useful.

78)     </li>
79)     
80)     <li>

81)     <a href="<blog>">Tor has a blog</a>.

82)     We try to keep it updated every week or two with the latest news.
83)     </li>
84)     
85)     <li>
86)     Download and watch Roger's overview talk from What The Hack (<a
87)     href="http://freehaven.net/~arma/wth-anonymous-communication-58.mp4">video</a>,
88)     <a href="http://freehaven.net/~arma/wth1.pdf">slides</a>, <a
89)     href="http://wiki.whatthehack.org/index.php/Anonymous_communication_for_the_United_States_Department_of_Defense...and_you">abstract</a>).
90)     This talk was given in July 2005, back when we were funded by EFF and back
91)     when the network was quite small, but it still provides good background
92)     on how Tor works and what it's for.
93)     </li>
94)     
95)     <li>
96)     Look through our <a href="#DesignDoc">Design
97)     Documents</a>. Notice that we have RFC-style specs to tell you exactly
98)     how Tor is built.
99)     </li>
100)     
101)     <li>
102)     There's a skeletal <a
103)     href="https://svn.torproject.org/svn/projects/roadmaps/2008-12-19-roadmap-full.pdf">list
104)     of items we'd like to tackle in the future</a>. Alas, many of those
105)     items need to be fleshed out more before they'll make sense to people
106)     who aren't Tor developers, but you can still get a general sense of
107)     what issues need to be resolved next.
108)     </li>
109)     
110)     <li>
111)     Download and watch Nick's "Technical changes since 2004" talk from
112)     Defcon in July 2007 (<a
113)     href="http://freehaven.net/~arma/Defcon15-Mathewson-Technical_Changes_since_you_Last_Heard_about_Tor.mp4">video</a>, <a
114)     href="http://freehaven.net/~nickm/slides/Defcon07/TorChanges.pdf">slides</a>),
115)     Roger's "blocking-resistance
116)     and circumvention" talk from 23C3 in December 2006 (<a
117)     href="http://freehaven.net/~arma/23C3-1444-en-tor_and_china.m4v">video</a>,
118)     <a href="http://freehaven.net/~arma/slides-23c3.pdf">slides</a>,
119)     <a href="http://events.ccc.de/congress/2006/Fahrplan/events/1444.en.html">abstract</a>,
120)     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.html">design paper</a>),

121)     Roger's "Current events in 2007" talk from 24C3 in December

122)     2007 (<a
123)     href="http://freehaven.net/~arma/24c3-2325-en-current_events_in_tor_development.mp4">video</a>,
124)     <a href="http://freehaven.net/~arma/slides-24c3.pdf">slides</a>,

125)     <a href="http://events.ccc.de/congress/2007/Fahrplan/events/2325.en.html">abstract</a>), and
126)     Roger's "Vulnerabilities in Tor" talk from 25C3 in December
127)     2008 (<a
128)     href="https://media.torproject.org/video/25c3-2977-en-security_and_anonymity_vulnerabilities_in_tor.mp4">video</a>,
129)     <a href="http://freehaven.net/~arma/slides-25c3.pdf">slides</a>).

130)     </li>
131)     
132)     <li>
133)     See Mike's "Securing the Tor network" talk from Defcon in July 2007
134)     (<a href="http://freehaven.net/~arma/Defcon15-Mike_Perry-Securing_the_Tor_Network.mp4">video</a>,
135)      <a href="http://freehaven.net/~arma/SecuringTheTorNetwork.pdf">slides</a>).
136)     It describes common ways to attack networks like Tor and how we try
137)     to defend against them, and it introduces the <a
138)     href="https://svn.torproject.org/svn/torflow/trunk/README">Torflow</a>
139)     script collection.
140)     </li>
141)     
142)     <li>
143)     Learn about the <a

144)     href="<specblob>proposals/001-process.txt">Tor

145)     proposal process for changing our design</a>, and look over the <a

146)     href="<spectree>proposals">existing proposals</a>.

147)     </li>
148)     
149)     <li>
150)     Our <a href="<gitblob>doc/TODO">developer TODO file</a> starts with a
151)     timeline for external promises &mdash; things <a href="<page about/sponsors>">our
152)     sponsors</a> have paid to see done. It also lists many other tasks
153)     and topics we'd like to tackle next.
154)     </li>
155)     
156)     <li>
157)     Once you're up to speed, things will continue to change surprisingly fast.

158)     The <a href="#MailingLists">tor-dev mailing list</a> is where the complex

159)     discussion happens, and the #tor IRC channel
160)     is where the less complex discussion happens.
161)     </li>
162)     
163)     </ol>
164)     
165)     <a id="MailingLists"></a>
166)     <h1><a class="anchor" href="#MailingLists">Mailing List Information</a></h1>
167)     <ul>

168)     <li>The <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce/">tor-announce

169)     mailing list</a> is a low volume list for announcements of new releases
170)     and critical security updates. Everybody should be on this list.
171)     There is also an
172)     <a href="http://rss.gmane.org/gmane.network.onion-routing.announce">RSS

173)     feed</a> of tor-announce at <a href="http://gmane.org">gmane.org</a>.</li>
174)     <li>The <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-talk/">tor-talk list</a>

175)     is where a lot of discussion happens, and is where we send notifications
176)     of prerelease versions and release candidates.</li>

177)     <li>The <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays/">tor-relays list</a>

178)     is where discussions about running, configuring, and handling your tor
179)     relay happen.  If you currently run a relay, or are thinking about doing
180)     so, this is the list for you.</li>

181)     <li>The <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev/">tor-dev list</a>

182)     is for posting by developers only, and is very low traffic.</li>

183)     <li>A list for <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-mirrors">mirror

184)     operators</a> for new website mirrors, and supporting <a href="<page
185)     getinvolved/mirrors>">current website mirrors</a>.</li>

186)     <li>A list for <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits/">svn and git

187)     commits</a> may be interesting for developers.</li>

188)     <li>An automated list for <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs/">bug

189)     reports from trac</a> may be interesting for users and developers.</li>
190)     </ul>
191)     
192)     <a id="DesignDoc"></a>
193)     <h1><a class="anchor" href="#DesignDoc">Design Documents</a></h1>
194)     <ul>
195)     <li>The <b>design document</b> (published at Usenix Security 2004)
196)     gives our justifications and security analysis for the Tor design:
197)     <a href="https://svn.torproject.org/svn/projects/design-paper/tor-design.pdf">PDF</a> and
198)     <a href="https://svn.torproject.org/svn/projects/design-paper/tor-design.html">HTML</a>
199)     versions available.</li>
200)     <li>Our follow-up paper on <b>challenges in low-latency anonymity</b>
201)     (still in draft form) details more recent experiences and directions:
202)     <a href="https://svn.torproject.org/svn/projects/design-paper/challenges.pdf">PDF
203)     draft</a>.</li>
204)     <li>Our paper at WEIS 2006 &mdash; <b>Anonymity Loves Company:
205)     Usability and the Network Effect</b> &mdash; explains why usability in
206)     anonymity systems matters for their security: <a
207)     href="http://freehaven.net/anonbib/cache/usability:weis2006.pdf">PDF</a>.</li>
208)     <li>Our preliminary design to make it harder for large firewalls to
209)     prevent access to the Tor network is described in
210)     <b>design of a blocking-resistant anonymity system</b>:
211)     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.pdf">PDF draft</a> and
212)     <a href="https://svn.torproject.org/svn/projects/design-paper/blocking.html">HTML draft</a>.
213)     Want to <a href="<page getinvolved/volunteer>#Coding">help us build it</a>?</li>
214)     <li>The <b>specifications</b> aim to give
215)     developers enough information to build a compatible version of Tor:
216)     <ul>

217)     <li><a href="<specblob>tor-spec.txt">Main Tor specification</a></li>
218)     <li><a href="<specblob>dir-spec.txt">Tor

219)     version 3 directory server specification</a> (and older <a

220)     href="<specblob>dir-spec-v1.txt">version 1</a> and <a
221)     href="<specblob>dir-spec-v2.txt">version 2</a> directory

222)     specifications)</li>

223)     <li><a href="<specblob>control-spec.txt">Tor control protocol

224)     specification</a></li>

225)     <li><a href="<specblob>rend-spec.txt">Tor rendezvous

226)     specification</a></li>

227)     <li><a href="<specblob>path-spec.txt">Tor path selection

228)     specification</a></li>

229)     <li><a href="<specblob>address-spec.txt">Special hostnames in

230)     Tor</a></li>

231)     <li><a href="<specblob>socks-extensions.txt">Tor's SOCKS support

232)     and extensions</a></li>

233)     <li><a href="<specblob>version-spec.txt">How Tor version numbers

234)     work</a></li>

235)     <li><a href="<spectree>proposals">In-progress drafts of

236)     new specifications and proposed changes</a></li>
237)     </ul></li>
238)     
239)     </ul>
240)     
241)     <a id="NeatLinks"></a>
242)     <h1><a class="anchor" href="#NeatLinks">Neat Links</a></h1>
243)     <ul>

244)     <li>The <a href="<wiki>">Tor

245)     wiki</a> provides a plethora of helpful contributions from Tor
246)     users. Check it out!</li>
247)     <li><a

248)     href="<wiki>TheOnionRouter/SupportPrograms">A

249)     list of supporting programs you might want to use in association with
250)     Tor</a>.</li>
251)     <li><a href="https://check.torproject.org/">The
252)     Tor detector</a> or <a href="http://torcheck.xenobite.eu/">the other
253)     Tor detector</a> try to guess if you're using Tor or not.</li>
254)     <li>Check out one of the Tor status pages, such as <a
255)     href="http://torstatus.blutmagie.de/">blutmagie's</a>, or <a
256)     href="http://trunk.torstatus.kgprog.com/index.php">kgprog's</a>, or
257)     Xenobite's <a href="https://torstat.xenobite.eu/">Tor node status</a> page.
258)     Remember that these lists may not be as accurate as what your Tor
259)     client uses, because your client fetches its own directory information and
260)     examines it locally.</li>
261)     <li>Read <a
262)     href="http://freehaven.net/anonbib/topic.html#Anonymous_20communication">these
263)     papers</a> (especially the ones in boxes) to get up to speed on the field
264)     of anonymous communication systems.</li>
265)     </ul>
266)     
267)     <a id="Developers"></a>
268)     <h1><a class="anchor" href="#Developers">For Developers</a></h1>
269)       Browse the Tor <b>source repository</b>:
270)       <ul>
271)         <li><a href="<gitrepo>">Browse the repository's source tree directly</a></li>
272)         <li>Git and SVN access:
273)           <ul>
274)             <li><kbd>git clone git://git.torproject.org/git/tor</kbd></li>

275)             <li>The development branch is <kbd>master</kbd>.  The active maintenance branches are <kbd>maint-0.2.1</kbd> and <kbd>maint-0.2.2</kbd>.</li>