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) <h2>Tor VM</h2>
11) <hr>
12) 

13) <h3>What Is It?</h3>
14) <p>Tor VM is a transparent Tor proxy for Windows that uses Qemu full
15) virtualization technology for more resilient Tor clients and relays.

16) </p>

17) <p><strong>The initial 0.0.1 release is a work in progress!</strong>

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

21) important before using this software on your system.</p>
22) 
23) <a id="Download"></a>
24) <h3><a class="anchor" href="#Download">Download Tor VM Software</a></h3>
25) 
26) <ul>
27) 
28) <!-- XXX: need to replace harcoded version with var replace in include -->

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

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

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

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

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

38) (<a href="dist/Tor_VM.exe.asc" style="font-size: 90%;">sig</a>/
39) <a href="dist/Tor_VM.exe.sha1.txt" style="font-size: 90%;">sha1</a>)</li>
40) 
41) </ul>
42) 
43) <a id="Setup"></a>
44) <h3><a class="anchor" href="#Setup">Configure Windows For Less Risk</a></h3>
45) 
46) <p>Running Firefox with Torbutton as a reduced privilege user provides
47) defense in depth against various risks Internet users face. These steps
48) explain how to create a restricted account for user name "anon".</p>
49) 

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

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

90) <h3><a class="anchor" href="#InstallExtractor">Tor VM Self-Extractor</a></h3>
91) 
92) <p>Save the installer executable to Desktop or portable storage.</p>
93) 
94) <p><img src="img/extr01.png" alt="Save installer exe to desktop or drive" /></p>
95) 
96) <p>Select the path or folder to extract into.</p>
97) 
98) <p><img src="img/extr02.png" alt="Select path for destination" /></p>
99) 
100) <p>Run the torvm.exe program in the extracted Tor_VM folder.</p>
101) 
102) <p><img src="img/extr03.png" alt="Run the torvm.exe program in the Tor_VM folder" /></p>
103) 
104) <h3><a class="anchor" href="#InstallBundle">Install Tor VM Bundle</a></h3>

105) 

106) <p>Double click on the Bundle or Network Installer EXE to begin installation.</p>

107) 

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

110) 

111) <p>The bundle package installs each of the applications included with Tor VM like 
112) Vidalia and Tor Button.</p>
113) 
114) <p><img src="img/bundle02.png" alt="Click to Run Bundle Installer" /></p>
115) 

116) <a id="Run"></a>
117) <h3><a class="anchor" href="#Run">Run Tor VM and Vidalia</a></h3>
118) 

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

121) 

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

123) 
124) <p>After preparing network devices a Qemu virtual machine running the
125) Tor VM kernel is launched. A status screen will be shown detailing progress
126) bootstrapping the Tor software into the network.</p>
127) 
128) <p><img src="img/run02.png" alt="Qemu launched with Tor VM kernel" /></p>
129) 
130) <p>The bootstrap is 100% complete when Tor is able to create a circuit
131) through the network.</p>
132) 
133) <p><img src="img/run03.png" alt="Bootstrap not complete until circuit created" /></p>
134) 
135) <p>After successful start a list of transparent proxy connection counts are
136) shown. This indicates that Tor VM is up and ready to start transparently
137) routing traffic through the Tor network. The socks port is also available to
138) the host for use with Polipo or Privoxy http proxies.</p>
139) 
140) <p><img src="img/run04.png" alt="Proxy traffic connection counts show Tor VM status" /></p>
141) 
142) <!-- no marble for first release

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

147) 

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

149) 

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

152) -->

153) 
154) <a id="Repair"></a>
155) <h3><a class="anchor" href="#Repair">Repair Installed Applications</a></h3>
156) 
157) <p><img src="img/vidalia-support.png" alt="In Add or Remove Programs - Select support option for package" /></p>
158) 
159) <p>Choose the repair option and all of the package files and registry will be
160) restored.</p>
161) 
162) <p><img src="img/vidalia-repair.png" alt="Choose Repair option" /></p>

163) 

164) <a id="Remove"></a>
165) <h3><a class="anchor" href="#Remove">Uninstall Tor Bundle Software</a></h3>
166) 
167) <p>A script to uninstall all of the Tor bundle applications at once is placed
168) on the desktop. Run this utility to remove all of the Tor packages and files.</p>
169) 
170) <p><img src="img/uninstall.png" alt="The Uninstall_Tor script will remove all Tor packages and files" /></p>
171) 

172) <a id="Debug"></a>
173) <h3><a class="anchor" href="#Debug">Troubleshoot Problems and Report Bugs</a></h3>
174) 
175) <p>The Tor VM category in the Tor flyspray bug tracker is used to manage
176) defects and features. See the

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

179) 

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

181) <a id="Advanced"></a>
182) <h3><a class="anchor" href="#Advanced">Experimental Packages and Usage</a></h3>
183) -->
184) 
185) <a id="More"></a>
186) <h3><a class="anchor" href="#More">Additional Resources</a></h3>
187) 
188) <p>The latest design document for Tor VM is available in revision control:

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

191) </p>
192) 
193) <p>Features and fixes planned for the Tor VM software are documented in the
194) <a href="https://svn.torproject.org/svn/torvm/trunk/TODO">Tor VM TODO</a>.</p>
195) 
196) <p><a href="https://data.peertech.org/torbld/info/Tor_VM-svn">Automated package
197) builds are available</a> for verifying fixes in subversion and testing work in
198) progress.</p>

199) 

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

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

203) </p>
204)