Add documentation for using Flash with Tor VM and expand modify / repair package info.
Martin Peck

Martin Peck commited on 2009-03-25 00:00:21
Zeige 17 geänderte Dateien mit 158 Einfügungen und 24 Löschungen.

... ...
@@ -7,24 +7,30 @@
7 7
 
8 8
 <!-- PUT CONTENT AFTER THIS TAG -->
9 9
 
10
-<h2>Tor VM</h2>
11
-<hr>
10
+<h1>Tor VM</h1>
12 11
 
13
-<h3>What Is It?</h3>
14
-<p>Tor VM is a transparent Tor proxy for Windows that uses Qemu full
12
+<h2>What Is It?</h2>
13
+<p>Tor VM is an experimental transparent Tor proxy for Windows that uses Qemu
15 14
 virtualization technology for more resilient Tor clients and relays.
16 15
 </p>
17
-<p><strong>The initial 0.0.1 release is a work in progress!</strong>
16
+<p><strong>This initial 0.0.1 release is a work in progress!</strong>
18 17
 See the
19 18
 <a href="http://bugs.noreply.org/flyspray/index.php?tasks=all&amp;project=4&amp;cat=19"
20 19
 >bug tracking database for known issues</a>. Remember to backup anything
21 20
 important before using this software on your system.</p>
22 21
 
22
+
23
+<hr />
23 24
 <a id="Download"></a>
24
-<h3><a class="anchor" href="#Download">Download Tor VM Software</a></h3>
25
+<h2><a class="anchor" href="#Download">Step One: Download Tor VM Software</a></h2>
25 26
 
26
-<ul>
27
+<p>The bundle packages are preferred since they include Vidalia and other Tor
28
+software that improves the user experience. If a portable Tor VM instance is
29
+required then the self extracting archive can be used to install Tor VM alone
30
+onto a portable storage device and run wheverever administrator rights are
31
+available to you.</p>
27 32
 
33
+<ul>
28 34
 <li><a href="dist/TorVM-0.0.1-NetInstaller.exe">Tor VM Network Installer</a>
29 35
 (<a href="dist/TorVM-0.0.1-NetInstaller.exe.asc" style="font-size: 90%;">sig</a>)</li>
30 36
 
... ...
@@ -33,11 +39,11 @@ important before using this software on your system.</p>
33 39
 
34 40
 <li><a href="dist/Tor_VM.exe">Tor VM Portable Self Extractor</a>
35 41
 (<a href="dist/Tor_VM.exe.asc" style="font-size: 90%;">sig</a>)</li>
36
-
37 42
 </ul>
38 43
 
44
+<hr />
39 45
 <a id="Setup"></a>
40
-<h3><a class="anchor" href="#Setup">Configure Windows For Less Risk</a></h3>
46
+<h2><a class="anchor" href="#Setup">Step Two: Configure Windows For Less Risk</a></h2>
41 47
 
42 48
 <p>Running Firefox with Torbutton as a reduced privilege user provides
43 49
 defense in depth against various risks Internet users face. These steps
... ...
@@ -82,8 +88,10 @@ while Firefox and other Internet applications run with restricted rights.</p>
82 88
 
83 89
 <p><img src="img/uc09.png" alt="Both Tor VM admin and restricted user can be used concurrently" /></p>
84 90
 
85
-<a id="Install"></a>
86
-<h3><a class="anchor" href="#InstallExtractor">Tor VM Self-Extractor</a></h3>
91
+
92
+<hr />
93
+<a id="InstallExtractor"></a>
94
+<h2><a class="anchor" href="#InstallExtractor">Step Three: Tor VM Self-Extractor</a></h2>
87 95
 
88 96
 <p>Save the installer executable to Desktop or portable storage.</p>
89 97
 
... ...
@@ -97,9 +105,16 @@ while Firefox and other Internet applications run with restricted rights.</p>
97 105
 
98 106
 <p><img src="img/extr03.png" alt="Run the torvm.exe program in the Tor_VM folder" /></p>
99 107
 
100
-<h3><a class="anchor" href="#InstallBundle">Install Tor VM Bundle</a></h3>
108
+<h2><a class="anchor" href="#Run">Proceed to: Run Tor VM</a></h2>
101 109
 
102
-<p>Double click on the Bundle or Network Installer EXE to begin installation.</p>
110
+
111
+<hr />
112
+<a id="InstallBundle"></a>
113
+<h2><a class="anchor" href="#InstallBundle">Step Three: Install Tor VM Bundle</a></h2>
114
+
115
+<p>The bundle installers include Vidalia and other software for the local
116
+machine instead of a portable folder. Double click on the Bundle or
117
+Network Installer EXE to begin installation to the current system.</p>
103 118
 
104 119
 <p><img src="img/bundle01.png" alt="Click to Run Bundle Installer" /> &nbsp;
105 120
 <img src="img/netinst01.png" alt="Click to Run Network Installer" /></p>
... ...
@@ -114,8 +129,10 @@ to reliably download all of the latest bundle application packages on demand.</p
114 129
 
115 130
 <p><img src="img/netinst02.png" alt="Network Installer downloads bundle software on demand" /></p>
116 131
 
132
+
133
+<hr />
117 134
 <a id="Run"></a>
118
-<h3><a class="anchor" href="#Run">Run Tor VM and Vidalia</a></h3>
135
+<h2><a class="anchor" href="#Run">Step Four: Run Tor VM</a></h2>
119 136
 
120 137
 <p>After installing the bundle packages a Tor VM controller is started in
121 138
 the background. The installer program has finished and can be closed.</p>
... ...
@@ -133,6 +150,11 @@ through the network.</p>
133 150
 
134 151
 <p><img src="img/run03.png" alt="Bootstrap not complete until circuit created" /></p>
135 152
 
153
+<p>If you are running the Tor VM bundle Vidalia will also display the current
154
+progress while bootstrapping into the Tor network.</p>
155
+
156
+<p><img src="img/vidalia-bootstrap.png" alt="Vidalia will also show bootstrap status" /></p>
157
+
136 158
 <p>After successful start a list of transparent proxy connection counts are
137 159
 shown. This indicates that Tor VM is up and ready to start transparently
138 160
 routing traffic through the Tor network. The socks port is also available to
... ...
@@ -152,26 +174,136 @@ with the generated image tiles already included.</p>
152 174
 which may resolve the problem.</p>
153 175
 -->
154 176
 
155
-<a id="Repair"></a>
156
-<h3><a class="anchor" href="#Repair">Repair Installed Applications</a></h3>
157 177
 
158
-<p><img src="img/vidalia-support.png" alt="In Add or Remove Programs - Select support option for package" /></p>
178
+<hr />
179
+<a id="RecommendedUse"></a>
180
+<h2><a class="anchor" href="#RecommendedUse">Step Five: Using Firefox and TorButton</a></h2>
159 181
 
160
-<p>Choose the repair option and all of the package files and registry will be
161
-restored.</p>
182
+<p>You should run Firefox and other Internet software as a restricted user.
183
+Switch to the restricted user account configured in <a class="anchor" href="#Setup">Step Two</a>.</p>
162 184
 
163
-<p><img src="img/vidalia-repair.png" alt="Choose Repair option" /></p>
185
+<p>Press The Windows Key + L to switch users, or select the "Log off"
186
+Start Menu option followed by "Switch User"</p>
187
+
188
+<p><img src="img/" alt="" /></p>
189
+
190
+<p>Click the "Install TorButton" shortcut if you do not have the Tor Button
191
+plugin installed.</p>
192
+
193
+<p><img src="img/torbutton01.png" alt="" /></p>
194
+
195
+<p>Continue with installation despite warning about installing from local file.</p>
196
+
197
+<p><img src="img/torbutton02.png" alt="" /></p>
198
+
199
+<p>You will need to restart Firefox to use the new TorButton extension.</p>
200
+
201
+<p><img src="img/torbutton03.png" alt="" /></p>
202
+
203
+<p>Click on the TorButton status icon in the lower right to enable Tor.</p>
204
+
205
+<p><img src="img/torbutton04.png" alt="" /></p>
206
+
207
+<p>Verify that you are using Tor via
208
+<a href="https://check.torproject.org/">https://check.torproject.org/</a></p>
209
+
210
+<p><img src="img/torbutton05.png" alt="" /></p>
211
+
212
+
213
+<hr />
214
+<a id="ExperimentalUse"></a> 
215
+<h2><a class="anchor" href="#ExperimentalUse">Experimental: Using Flash</a></h2>
216
+
217
+<p><strong>IMPORTANT: Tor VM can protect your endpoint IP address when using
218
+Flash and other software but it does not yet protect against attacks which
219
+reduce your anonymity set.</strong> DO NOT use Tor VM in this manner if you
220
+rely on unlinkable anonymity; wait until this is addressed in future releases.
221
+</p>
222
+
223
+<p>You should run Flash Player and other Internet software as a restricted user.
224
+Switch to the restricted user account configured in <a class="anchor" href="#Setup">Step Two</a>.</p>
225
+
226
+<p><img src="img/switch-user.png" alt="Switch to restricted user to play Flash content" /></p>
227
+
228
+<p>First be sure that transparent proxy of Internet traffic through Tor is
229
+working correctly. Tor VM ensures that all your traffic is anonymized
230
+regardless of whether TorButton and Firefox are used or not.</p>
164 231
 
232
+<p><img src="img/flash01.png" alt="" /></p>
233
+
234
+<p>Connections made from the Browser and Flash Player plugin will now
235
+be transparently proxied through the Tor network when viewing content.</p>
236
+
237
+<p><img src="img/flash02.png" alt="" /></p>
238
+
239
+<p>The transparent proxy redirection counts will indicate connections redirected
240
+through Tor in this manner. Traffic sent via TorButton and Polipo are visible as
241
+SOCKS connections to the Tor VM instance.</p>
242
+
243
+<p><img src="img/transparent.png" alt="Transparent proxy traffic can be seen along with TorButton and Polipo traffic" /></p>
244
+
245
+
246
+<hr />
247
+<a id="Modify"></a>
248
+<h2><a class="anchor" href="#Modify">Modify Tor VM Install Options</a></h2>
249
+
250
+<p>Once a package is installed you can change the default installation options
251
+via the "Change" option for the package. For example, Tor VM is configured to
252
+run at start up which can be disabled by modifying the installation.</p>
253
+
254
+<p><img src="img/change01.png" alt="" /></p>
255
+ 
256
+<p>The Change package option will launch the installer GUI for the package.</p>
257
+
258
+<p><img src="img/change02.png" alt="" /></p>
259
+ 
260
+<p>The list of configurable installation options can now be set as desired.
261
+For example, disabling the "Run at Startup" option as shown here.</p>
262
+
263
+<p><img src="img/change03.png" alt="" /></p>
264
+ 
265
+<p>Select "Next" once all changes have been selected.</p>
266
+
267
+<p><img src="img/change04.png" alt="" /></p>
268
+ 
269
+<p>Select "Change" to apply the changes to the installed software.</p>
270
+
271
+<p><img src="img/change05.png" alt="" /></p>
272
+ 
273
+<p>And finally "Finish" to exit the installer GUI. The requested changes
274
+are now in effect.</p>
275
+
276
+<p><img src="img/change06.png" alt="" /></p>
277
+ 
278
+
279
+<hr />
165 280
 <a id="Remove"></a>
166
-<h3><a class="anchor" href="#Remove">Uninstall Tor Bundle Software</a></h3>
281
+<h2><a class="anchor" href="#Remove">Uninstall Tor Bundle Software</a></h2>
167 282
 
168 283
 <p>A script to uninstall all of the Tor bundle applications at once is placed
169 284
 on the desktop. Run this utility to remove all of the Tor packages and files.</p>
170 285
 
171 286
 <p><img src="img/uninstall.png" alt="The Uninstall_Tor script will remove all Tor packages and files" /></p>
172 287
 
288
+
289
+<hr />
290
+<a id="Repair"></a>
291
+<h2><a class="anchor" href="#Repair">Repair Installed Applications</a></h2>
292
+
293
+<p>If any installed files become corrupted or deleted you can repair them
294
+with the support option for the application package having problems.</p>
295
+
296
+<p><img src="img/vidalia-support.png" alt="In Add or Remove Programs - Select support option for package" /></p>
297
+
298
+<p>Choose the repair option and all of the package files and registry will be
299
+restored.</p>
300
+
301
+<p><img src="img/vidalia-repair.png" alt="Choose Repair option" /></p>
302
+
303
+
304
+<hr />
173 305
 <a id="Debug"></a>
174
-<h3><a class="anchor" href="#Debug">Troubleshoot Problems and Report Bugs</a></h3>
306
+<h2><a class="anchor" href="#Debug">Troubleshoot Problems and Report Bugs</a></h2>
175 307
 
176 308
 <p>The Tor VM category in the Tor flyspray bug tracker is used to manage
177 309
 defects and features. See the
... ...
@@ -180,11 +312,13 @@ defects and features. See the
180 312
 
181 313
 <!-- localized installers and full Marble data bundle?
182 314
 <a id="Advanced"></a>
183
-<h3><a class="anchor" href="#Advanced">Experimental Packages and Usage</a></h3>
315
+<h2><a class="anchor" href="#Advanced">Experimental Packages and Usage</a></h2>
184 316
 -->
185 317
 
318
+
319
+<hr />
186 320
 <a id="More"></a>
187
-<h3><a class="anchor" href="#More">Additional Resources</a></h3>
321
+<h2><a class="anchor" href="#More">Additional Resources</a></h2>
188 322
 
189 323
 <p>The latest design document for Tor VM is available in revision control:
190 324
 <a href="https://svn.torproject.org/svn/torvm/trunk/doc/design.html"