tor-webwml.git

1) ## translation metadata

2) # Revision: $Revision$

3) # Translation-Priority: 3-low
4) 
5) #include "head.wmi" TITLE="Tor Project: Hidden Service Configuration Instructions" 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 &raquo; </a>
10)     <a href="<page docs/tor-hidden-service>">Tor Hidden Service</a>
11)   </div>
12)   <div id="maincol">

13)     <h1>Configuring Hidden Services for <a href="<page index>">Tor</a></h1>

14)     <hr>

15) 

16)     <p>Tor allows clients and relays to offer hidden services. That is,
17)     you can offer a web server, SSH server, etc., without revealing your
18)     IP address to its users. In fact, because you don't use any public address,
19)     you can run a hidden service from behind your firewall.
20)     </p>

21) 

22)     <p>If you have Tor installed, you can see hidden services

23)     in action by visiting one of our official hidden services:
24)     <ul>
25)     <li><a href="http://idnxcnkne4qt76tg.onion/">The Tor Project Website</a></li>
26)     <li><a href="http://j6im4v42ur6dpic3.onion/">The Tor Package Archive</a></li>
27)     <li><a href="http://p3igkncehackjtib.onion/">The Tor Media Archive</a></li>
28)     </ul>
29) 
30)     Others run reliable hidden services, such as <a
31)     href="http://3g2upl4pq6kufc4m.onion/">The Duck Duck
32)     Go</a> search engine and someone hosting a <a
33)     href="http://duskgytldkxiuqc6.onion/">sample site</a>.

34)     </p>

35) 
36)     <p>

37)     This page describes the steps for setting up your own hidden service

38)     website. For the technical details of how the hidden service protocol

39)     works, see our <a href="<page docs/hidden-services>">hidden service
40)     protocol</a> page.

41)     </p>

42) 

43)     <hr>

44)     <a id="zero"></a>
45)     <h2><a class="anchor" href="#zero">Step Zero: Get Tor working</a></h2>

46)     <br>

47) 

48)     <p>Before you start, you need to make sure:</p>
49)     <ol>
50)     <li>Tor is up and running,</li>
51)     <li>You actually set it up correctly.</li>
52)     </ol>

53) 

54)     <p>Windows users should follow the <a
55)     href="<page docs/tor-doc-windows>">Windows
56)     howto</a>, OS X users should follow the <a
57)     href="<page docs/tor-doc-osx>">OS
58)     X howto</a>, and Linux/BSD/Unix users should follow the <a
59)     href="<page docs/tor-doc-unix>">Unix howto</a>.
60)     </p>

61) 

62)     <hr>

63)     <a id="one"></a>
64)     <h2><a class="anchor" href="#one">Step One: Install a web server locally</a></h2>

65)     <br>

66) 

67)     <p>
68)     First, you need to set up a web server locally. Setting up a web

69)     server can be complex. We're not going to cover how to setup a web
70)     server here. If you get stuck or want to do more, find a friend who
71)     can help you. We recommend you install a new separate web server for

72)     your hidden service, since even if you already have one installed,
73)     you may be using it (or want to use it later) for an actual website.

74)     </p>

75) 

76)     <p>
77)     You need to configure your web server so it doesn't give away any
78)     information about you, your computer, or your location. Be sure to
79)     bind the web server only to localhost (if people could get to it
80)     directly, they could confirm that your computer is the one offering
81)     the hidden service). Be sure that its error messages don't list
82)     your hostname or other hints. Consider putting the web server in a
83)     sandbox or VM to limit the damage from code vulnerabilities.
84)     </p>
85) 

86)     <p>

87)     Once your web server is set up, make

88)     sure it works: open your browser and go to <a

89)     href="http://localhost:8080/">http://localhost:8080/</a>, where
90)     8080 is the webserver port you chose during setup (you can choose any
91)     port, 8080 is just an example). Then try putting a file in the main
92)     html directory, and make sure it shows up when you access the site.

93)     </p>

94) 

95)     <hr>

96)     <a id="two"></a>
97)     <h2><a class="anchor" href="#two">Step Two: Configure your hidden service</a></h2>

98)     <br>

99) 

100)     <p>Next, you need to configure your hidden service to point to your
101)     local web server.
102)     </p>

103) 
104)     <p>First, open your torrc file in your favorite text editor. (See
105)     <a href="<page docs/faq>#torrc">the torrc FAQ entry</a> to learn
106)     what this means.) Go to the middle section and look for the line</p>
107) 

108)     <pre>
109)     \############### This section is just for location-hidden services ###
110)     </pre>

111) 

112)     <p>
113)     This section of the file consists of groups of lines, each representing
114)     one hidden service. Right now they are all commented out (the lines
115)     start with #), so hidden services are disabled. Each group of lines
116)     consists of one <var>HiddenServiceDir</var> line, and one or more
117)     <var>HiddenServicePort</var> lines:</p>
118)     <ul>
119)     <li><var>HiddenServiceDir</var> is a directory where Tor will store information
120)     about that hidden service.  In particular, Tor will create a file here named
121)     <var>hostname</var> which will tell you the onion URL.  You don't need to
122)     add any files to this directory. Make sure this is not the same directory
123)     as the hidserv directory you created when setting up thttpd, as your
124)     HiddenServiceDir contains secret information!</li>
125)     <li><var>HiddenServicePort</var> lets you specify a virtual port (that is, what
126)     port people accessing the hidden service will think they're using) and an
127)     IP address and port for redirecting connections to this virtual port.</li>
128)     </ul>

129) 

130)     <p>Add the following lines to your torrc:
131)     </p>

132) 

133)     <pre>
134)     HiddenServiceDir /Library/Tor/var/lib/tor/hidden_service/

135)     HiddenServicePort 80 127.0.0.1:8080

136)     </pre>

137) 

138)     <p>You're going to want to change the <var>HiddenServiceDir</var> line, so it points
139)     to an actual directory that is readable/writeable by the user that will
140)     be running Tor. The above line should work if you're using the OS X Tor
141)     package. On Unix, try "/home/username/hidden_service/" and fill in your own
142)     username in place of "username". On Windows you might pick:</p>
143)     <pre>

144)     HiddenServiceDir C:\Users\username\Documents\tor\hidden_service

145)     HiddenServicePort 80 127.0.0.1:8080

146)     </pre>

147) 
148)     <p>Now save the torrc and restart your tor.</p>
149) 

150)     <p>If Tor starts up again, great. Otherwise, something is wrong. First look at
151)     your logfiles for hints. It will print some warnings or error messages. That
152)     should give you an idea what went wrong. Typically there are typos in the torrc

153)     or wrong directory permissions (See <a href="<page docs/faq>#Logs">the

154)     logging FAQ entry</a> if you don't know how to enable or find your
155)     log file.)
156)     </p>

157) 

158)     <p>When Tor starts, it will automatically create the <var>HiddenServiceDir</var>
159)     that you specified (if necessary), and it will create two files there.</p>

160) 

161)     <dl>
162)     <dt><var>private_key</var></dt>
163)     <dd>First, Tor will generate a new public/private keypair for your hidden
164)     service. It is written into a file called "private_key". Don't share this key
165)     with others -- if you do they will be able to impersonate your hidden
166)     service.</dd>
167)     <dt><var>hostname</var></dt>
168)     <dd>The other file Tor will create is called "hostname". This contains
169)     a short summary of your public key -- it will look something like
170)     <tt>duskgytldkxiuqc6.onion</tt>. This is the public name for your service,
171)     and you can tell it to people, publish it on websites, put it on business
172)     cards, etc.</dd>
173)     </dl>

174) 

175)     <p>If Tor runs as a different user than you, for example on
176)     OS X, Debian, or Red Hat, then you may need to become root to be able
177)     to view these files.</p>

178) 

179)     <p>Now that you've restarted Tor, it is busy picking introduction points
180)     in the Tor network, and generating a <em>hidden service
181)     descriptor</em>. This is a signed list of introduction points along with
182)     the service's full public key. It anonymously publishes this descriptor
183)     to the directory servers, and other people anonymously fetch it from the
184)     directory servers when they're trying to access your service.
185)     </p>

186) 

187)     <p>Try it now: paste the contents of the hostname file into your web
188)     browser. If it works, you'll get the html page you set up in step one.
189)     If it doesn't work, look in your logs for some hints, and keep playing
190)     with it until it works.
191)     </p>

192) 

193)     <hr>

194)     <a id="three"></a>
195)     <h2><a class="anchor" href="#three">Step Three: More advanced tips</a></h2>

196)     <br>

197) 

198)     <p>If you plan to keep your service available for a long time, you might
199)     want to make a backup copy of the <var>private_key</var> file somewhere.
200)     </p>

201) 

202)     <p>If you want to forward multiple virtual ports for a single hidden
203)     service, just add more <var>HiddenServicePort</var> lines.
204)     If you want to run multiple hidden services from the same Tor
205)     client, just add another <var>HiddenServiceDir</var> line. All the following
206)     <var>HiddenServicePort</var> lines refer to this <var>HiddenServiceDir</var> line, until
207)     you add another <var>HiddenServiceDir</var> line:
208)     </p>

209) 

210)     <pre>
211)     HiddenServiceDir /usr/local/etc/tor/hidden_service/
212)     HiddenServicePort 80 127.0.0.1:8080

213) 

214)     HiddenServiceDir /usr/local/etc/tor/other_hidden_service/
215)     HiddenServicePort 6667 127.0.0.1:6667
216)     HiddenServicePort 22 127.0.0.1:22
217)     </pre>

218) 

219)     <p>There are some anonymity issues you should keep in mind too:
220)     </p>
221)     <ul>
222)     <li>As mentioned above, be careful of letting your web server reveal
223)     identifying information about you, your computer, or your location.
224)     For example, readers can probably determine whether it's thttpd or
225)     Apache, and learn something about your operating system.</li>
226)     <li>If your computer isn't online all the time, your hidden service
227)     won't be either. This leaks information to an observant adversary.</li>

228)     <li>It is generally a better idea to host hidden services on a Tor client 
229)     rather than a Tor relay, since relay uptime and other properties are
230)     publicly visible.</li>

231)     <!-- increased risks over time -->
232)     </ul>

233) 

234)     <hr>

235)