tor-webwml.git

1) ## translation metadata
2) # Revision: $Revision$
3) 
4) #include "head.wmi" TITLE="Tor VM"
5) 
6) <div class="main-column">
7) 
8) <!-- PUT CONTENT AFTER THIS TAG -->
9) 

10) <h1>Tor VM</h1>

11) 

12) <!-- BEGIN SIDEBAR -->
13) <div class="sidebar-left">
14) <h3>Using Tor VM</h3>
15) <ul>
16) <li><a href="#Download">Download</a></li>
17) <li><a href="#Setup">Setup</a></li>
18) <li><a href="#InstallBundle">Install Bundle</a></li>
19) <li><a href="#Run">Run VM</a></li>
20) <li><a href="#RecommendedUse">Use Tor Button</a></li>
21) </ul>
22) </div>
23) <!-- END SIDEBAR -->
24) 

25) <h2>What Is It?</h2>
26) <p>Tor VM is an experimental transparent Tor proxy for Windows that uses Qemu

27) virtualization technology for more resilient clients and relays.

28) </p>

29) <p><strong>This initial 0.0.1 release is a work in progress!</strong>

30) See the
31) <a href="http://bugs.noreply.org/flyspray/index.php?tasks=all&amp;project=4&amp;cat=19"
32) >bug tracking database for known issues</a>. Remember to backup anything

33) important before using this software on your system.</p>
34) 

35) 
36) <hr />

37) <a id="Download"></a>

38) <h2><a class="anchor" href="#Download">Step One: Download Tor VM Software</a></h2>

39) 

40) <p>The bundle packages are preferred since they include Vidalia and other Tor
41) software that improves the user experience. If a portable Tor VM instance is

42) required the self extracting archive can be used to install Tor VM alone

43) onto a portable storage device.</p>

44) 

45) <ul>

46) <li><a href="dist/TorVM-0.0.1-NetInstaller.exe">Tor VM Network Installer</a>

47) (<a href="dist/TorVM-0.0.1-NetInstaller.exe.asc" style="font-size: 90%;">sig</a>)</li>

48) 

49) <li><a href="dist/TorVM-0.0.1-Bundle.exe">Tor VM Bundle Installer</a>

50) (<a href="dist/TorVM-0.0.1-Bundle.exe.asc" style="font-size: 90%;">sig</a>)</li>

51) 

52) <li><a href="dist/Tor_VM.exe">Tor VM Portable Self Extractor</a>

53) (<a href="dist/Tor_VM.exe.asc" style="font-size: 90%;">sig</a>)</li>

54) </ul>
55) 

56) <hr />

57) <a id="Setup"></a>

58) <h2><a class="anchor" href="#Setup">Step Two: Configure Windows For Less Risk</a></h2>

59) 
60) <p>Running Firefox with Torbutton as a reduced privilege user provides
61) defense in depth against various risks Internet users face. These steps
62) explain how to create a restricted account for user name "anon".</p>
63) 

64) <p>Navigate to the control panel "User Accounts" option. You can also use
65) the menu navigation:<br />
66) <!-- should this be a sequence of <span> instead? -->
67) <strong>Start Menu -&gt; Settings -&gt; Control Panel -&gt; Add or Remove Programs</strong></p>

68) 
69) <p><img src="img/uc01.png" alt="Control panel view - Select User Accounts option" /></p>
70) 
71) <p>Select "Create a new account".</p>
72) 
73) <p><img src="img/uc02.png" alt="User Accounts Tool - Select Create a new account" /></p>
74) 
75) <p>Provide a nickname for the anonymous limited user account.</p>
76) 
77) <p><img src="img/uc03.png" alt="Provide a nickname for the restricted account" /></p>
78) 
79) <p>Choose the "Limited" account type for the reduced privilege user feature.</p>
80) 
81) <p><img src="img/uc04.png" alt="Choose the Limited account type" /></p>
82) 
83) <p>Select "Create Account".</p>
84) 
85) <p><img src="img/uc05.png" alt="Select Create Account" /></p>
86) 
87) <p>The new user is added to the list of accounts on the local system. This is
88) the account that Internet applications like Firefox will run as when using
89) Tor VM to route traffic through the Tor network.
90) </p>
91) 
92) <p><img src="img/uc06.png" alt="New user is available for login session" /></p>
93) 
94) <p>The Switch User feature is used to run critical Tor VM software as Admin
95) while Firefox and other Internet applications run with restricted rights.</p>
96) 
97) <p><img src="img/uc07.png" alt="Use switch user to log in as restricted user" /></p>
98) 
99) <p>The new limited user desktop has its own configuration and environment.</p>
100) 
101) <p><img src="img/uc09.png" alt="Both Tor VM admin and restricted user can be used concurrently" /></p>
102) 

103) 
104) <hr />
105) <a id="InstallExtractor"></a>
106) <h2><a class="anchor" href="#InstallExtractor">Step Three: Tor VM Self-Extractor</a></h2>

107) 
108) <p>Save the installer executable to Desktop or portable storage.</p>
109) 
110) <p><img src="img/extr01.png" alt="Save installer exe to desktop or drive" /></p>
111) 
112) <p>Select the path or folder to extract into.</p>
113) 
114) <p><img src="img/extr02.png" alt="Select path for destination" /></p>
115) 
116) <p>Run the torvm.exe program in the extracted Tor_VM folder.</p>
117) 
118) <p><img src="img/extr03.png" alt="Run the torvm.exe program in the Tor_VM folder" /></p>
119) 

120) <h2><a class="anchor" href="#Run">Proceed to: Run Tor VM</a></h2>
121) 

122) 

123) <hr />
124) <a id="InstallBundle"></a>
125) <h2><a class="anchor" href="#InstallBundle">Step Three: Install Tor VM Bundle</a></h2>
126) 
127) <p>The bundle installers include Vidalia and other software for the local
128) machine instead of a portable folder. Double click on the Bundle or
129) Network Installer EXE to begin installation to the current system.</p>

130) 

131) <p><img src="img/bundle01.png" alt="Click to Run Bundle Installer" /> &nbsp;
132) <img src="img/netinst01.png" alt="Click to Run Network Installer" /></p>

133) 

134) <p>The bundle package installs each of the applications included with Tor VM like 
135) Vidalia and Tor Button.</p>
136) 
137) <p><img src="img/bundle02.png" alt="Click to Run Bundle Installer" /></p>
138) 

139) <p>The network installer contains the secure Tor updater software that is used
140) to reliably download all of the latest bundle application packages on demand.</p>
141) 
142) <p><img src="img/netinst02.png" alt="Network Installer downloads bundle software on demand" /></p>
143) 

144) 
145) <hr />

146) <a id="Run"></a>

147) <h2><a class="anchor" href="#Run">Step Four: Run Tor VM</a></h2>

148) 

149) <p>After installing the bundle packages a Tor VM controller is started in
150) the background. The installer program has finished and can be closed.</p>

151) 

152) <p><img src="img/run01.png" alt="Tor VM controller will start at end of install" /></p>

153) 
154) <p>After preparing network devices a Qemu virtual machine running the
155) Tor VM kernel is launched. A status screen will be shown detailing progress
156) bootstrapping the Tor software into the network.</p>
157) 
158) <p><img src="img/run02.png" alt="Qemu launched with Tor VM kernel" /></p>
159) 
160) <p>The bootstrap is 100% complete when Tor is able to create a circuit
161) through the network.</p>
162) 
163) <p><img src="img/run03.png" alt="Bootstrap not complete until circuit created" /></p>
164) 

165) <p>If you are running the Tor VM bundle Vidalia will also display the current
166) progress while bootstrapping into the Tor network.</p>
167) 
168) <p><img src="img/vidalia-bootstrap.png" alt="Vidalia will also show bootstrap status" /></p>
169) 

170) <p>After successful start a list of transparent proxy connection counts are
171) shown. This indicates that Tor VM is up and ready to start transparently
172) routing traffic through the Tor network. The socks port is also available to
173) the host for use with Polipo or Privoxy http proxies.</p>
174) 
175) <p><img src="img/run04.png" alt="Proxy traffic connection counts show Tor VM status" /></p>
176) 
177) <!-- no marble for first release

178) <p>The first time Vidalia is run the image tiles needed for the Marble Map
179) plugin will be generated at start. If you do not have sufficient memory or
180) CPU to generate these tiles you can install the full Vidalia Marble package
181) with the generated image tiles already included.</p>

182) 

183) <p><img src="img/vidalia-genmap.png" alt="It may take a minute to generate the Marble Map image tiles" /></p>

184) 

185) <p>If any of the bundle applications stop working a repair can be requested
186) which may resolve the problem.</p>

187) -->

188) 
189) 

190) <hr />
191) <a id="RecommendedUse"></a>
192) <h2><a class="anchor" href="#RecommendedUse">Step Five: Using Firefox and TorButton</a></h2>

193) 

194) <p>You should run Firefox and other Internet software as a restricted user.
195) Switch to the restricted user account configured in <a class="anchor" href="#Setup">Step Two</a>.</p>

196) 

197) <p>Press The Windows Key + L to switch users, or select the "Log off".

198) Start Menu option followed by "Switch User"</p>
199) 

200) <p><img src="img/switch-user.png" alt="Windows Key + L to switch user" /></p>

201) 
202) <p>Click the "Install TorButton" shortcut if you do not have the Tor Button

203) extension installed.</p>

204) 

205) <p><img src="img/torbutton01.png" alt="Run Install TorButton shortcut" /></p>

206) 
207) <p>Continue with installation despite warning about installing from local file.</p>
208) 

209) <p><img src="img/torbutton02.png" alt="Firefox will warn about local extension, continue" /></p>

210) 
211) <p>You will need to restart Firefox to use the new TorButton extension.</p>
212) 

213) <p><img src="img/torbutton03.png" alt="Restart Firefox to enable new extension" /></p>

214) 
215) <p>Click on the TorButton status icon in the lower right to enable Tor.</p>
216) 

217) <p><img src="img/torbutton04.png" alt="Click on TorButton status icon to toggle ON" /></p>

218) 
219) <p>Verify that you are using Tor via
220) <a href="https://check.torproject.org/">https://check.torproject.org/</a></p>
221) 

222) <p><img src="img/torbutton05.png" alt="Verify Tor use at check.torproject.org" /></p>

223) 
224) 
225) <hr />
226) <a id="ExperimentalUse"></a> 
227) <h2><a class="anchor" href="#ExperimentalUse">Experimental: Using Flash</a></h2>
228) 
229) <p><strong>IMPORTANT: Tor VM can protect your endpoint IP address when using
230) Flash and other software but it does not yet protect against attacks which
231) reduce your anonymity set.</strong> DO NOT use Tor VM in this manner if you
232) rely on unlinkable anonymity; wait until this is addressed in future releases.
233) </p>

234) 

235) <p>You should run Flash Player and other Internet software as a restricted user.
236) Switch to the restricted user account configured in <a class="anchor" href="#Setup">Step Two</a>.</p>
237) 
238) <p><img src="img/switch-user.png" alt="Switch to restricted user to play Flash content" /></p>
239) 
240) <p>First be sure that transparent proxy of Internet traffic through Tor is

241) working correctly. Tor VM ensures that all your traffic is relayed
242) by default without any application configuration.</p>

243) 

244) <p><img src="img/flash01.png" alt="Verify Tor usage at check.torproject.org" /></p>

245) 
246) <p>Connections made from the Browser and Flash Player plugin will now
247) be transparently proxied through the Tor network when viewing content.</p>
248) 

249) <p><img src="img/flash02.png" alt="Flash player and other software now using Tor" /></p>

250) 
251) <p>The transparent proxy redirection counts will indicate connections redirected
252) through Tor in this manner. Traffic sent via TorButton and Polipo are visible as
253) SOCKS connections to the Tor VM instance.</p>
254) 
255) <p><img src="img/transparent.png" alt="Transparent proxy traffic can be seen along with TorButton and Polipo traffic" /></p>
256) 
257) 
258) <hr />
259) <a id="Modify"></a>
260) <h2><a class="anchor" href="#Modify">Modify Tor VM Install Options</a></h2>
261) 
262) <p>Once a package is installed you can change the default installation options
263) via the "Change" option for the package. For example, Tor VM is configured to
264) run at start up which can be disabled by modifying the installation.</p>
265) 

266) <p><img src="img/change01.png" alt="Change option is in Add Remove Programs" /></p>

267)  
268) <p>The Change package option will launch the installer GUI for the package.</p>
269) 

270) <p><img src="img/change02.png" alt="Changes will launch application installer GUI" /></p>

271)  
272) <p>The list of configurable installation options can now be set as desired.
273) For example, disabling the "Run at Startup" option as shown here.</p>
274) 

275) <p><img src="img/change03.png" alt="Change desired installation options" /></p>

276)  
277) <p>Select "Next" once all changes have been selected.</p>
278) 

279) <p><img src="img/change04.png" alt="Select Next when changes selected" /></p>

280)  
281) <p>Select "Change" to apply the changes to the installed software.</p>
282) 

283) <p><img src="img/change05.png" alt="Select Change to confirm changes" /></p>

284)  
285) <p>And finally "Finish" to exit the installer GUI. The requested changes
286) are now in effect.</p>
287) 

288) <p><img src="img/change06.png" alt="Select Finish to complete modifications" /></p>

289)  
290) 
291) <hr />

292) <a id="Remove"></a>

293) <h2><a class="anchor" href="#Remove">Uninstall Tor Bundle Software</a></h2>

294) 
295) <p>A script to uninstall all of the Tor bundle applications at once is placed
296) on the desktop. Run this utility to remove all of the Tor packages and files.</p>
297) 
298) <p><img src="img/uninstall.png" alt="The Uninstall_Tor script will remove all Tor packages and files" /></p>
299) 

300) 
301) <hr />
302) <a id="Repair"></a>
303) <h2><a class="anchor" href="#Repair">Repair Installed Applications</a></h2>
304) 
305) <p>If any installed files become corrupted or deleted you can repair them
306) with the support option for the application package having problems.</p>
307) 
308) <p><img src="img/vidalia-support.png" alt="In Add or Remove Programs - Select support option for package" /></p>
309) 
310) <p>Choose the repair option and all of the package files and registry will be
311) restored.</p>
312) 
313) <p><img src="img/vidalia-repair.png" alt="Choose Repair option" /></p>
314) 
315) 
316) <hr />

317) <a id="Debug"></a>

318) <h2><a class="anchor" href="#Debug">Troubleshoot Problems and Report Bugs</a></h2>

319) 
320) <p>The Tor VM category in the Tor flyspray bug tracker is used to manage
321) defects and features. See the

322) <a href="http://bugs.noreply.org/flyspray/index.php?tasks=all&amp;project=4"
323) >Tor flyspray bug tracker</a> for known issues and pending changes.</p>

324) 

325) <!-- localized installers and full Marble data bundle?

326) <a id="Advanced"></a>

327) <h2><a class="anchor" href="#Advanced">Experimental Packages and Usage</a></h2>

328) -->
329) 

330) 
331) <hr />

332) <a id="More"></a>

333) <h2><a class="anchor" href="#More">Additional Resources</a></h2>

334) 
335) <p>The latest design document for Tor VM is available in revision control:

336) <a href="https://svn.torproject.org/svn/torvm/trunk/doc/design.html"
337) >https://svn.torproject.org/svn/torvm/trunk/doc/design.html</a>.

338) </p>
339) 
340) <p>Features and fixes planned for the Tor VM software are documented in the
341) <a href="https://svn.torproject.org/svn/torvm/trunk/TODO">Tor VM TODO</a>.</p>
342) 
343) <p><a href="https://data.peertech.org/torbld/info/Tor_VM-svn">Automated package
344) builds are available</a> for verifying fixes in subversion and testing work in
345) progress.</p>

346) 

347) <p>Be sure to build against a known working tag in the torvm repo. For
348) example,<br />

349) svn export https://svn.torproject.org/svn/torvm/tags/torvm-0_0_1 torvm-0.0.1-src

350) </p>
351)