torvm/en/index.wml (2935dc0ab) - tor-webwml.git

index.wml

## translation metadata
# Revision: $Revision$

#include "head.wmi" TITLE="Tor VM"

<h2>What Is It?</h2>
Tor VM is an experimental transparent Tor proxy for Windows that uses Qemu
virtualization technology for more resilient Tor clients and relays.

This initial 0.0.1 release is a work in progress!
See the
<a href="http://bugs.noreply.org/flyspray/index.php?tasks=all&amp;project=4&amp;cat=19"
>bug tracking database for known issues</a>. Remember to backup anything
important before using this software on your system.

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

The bundle packages are preferred since they include Vidalia and other Tor
software that improves the user experience. If a portable Tor VM instance is
required then the self extracting archive can be used to install Tor VM alone
onto a portable storage device.

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

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

<li><a href="dist/Tor_VM.exe">Tor VM Portable Self Extractor</a>
(<a href="dist/Tor_VM.exe.asc" style="font-size: 90%;">sig</a>)</li>
</ul>

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

Running Firefox with Torbutton as a reduced privilege user provides
defense in depth against various risks Internet users face. These steps
explain how to create a restricted account for user name "anon".

Navigate to the control panel "User Accounts" option. You can also use
the menu navigation: 

Start Menu -&gt; Settings -&gt; Control Panel -&gt; Add or Remove Programs

Select "Create a new account".

Provide a nickname for the anonymous limited user account.

Choose the "Limited" account type for the reduced privilege user feature.

Select "Create Account".

The new user is added to the list of accounts on the local system. This is
the account that Internet applications like Firefox will run as when using
Tor VM to route traffic through the Tor network.

The Switch User feature is used to run critical Tor VM software as Admin
while Firefox and other Internet applications run with restricted rights.

The new limited user desktop has its own configuration and environment.

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

Save the installer executable to Desktop or portable storage.

Select the path or folder to extract into.

Run the torvm.exe program in the extracted Tor_VM folder.

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

<hr />
<a id="InstallBundle"></a>
<h2><a class="anchor" href="#InstallBundle">Step Three: Install Tor VM Bundle</a></h2>

The bundle installers include Vidalia and other software for the local
machine instead of a portable folder. Double click on the Bundle or
Network Installer EXE to begin installation to the current system.

The bundle package installs each of the applications included with Tor VM like 
Vidalia and Tor Button.

The network installer contains the secure Tor updater software that is used
to reliably download all of the latest bundle application packages on demand.

After installing the bundle packages a Tor VM controller is started in
the background. The installer program has finished and can be closed.

After preparing network devices a Qemu virtual machine running the
Tor VM kernel is launched. A status screen will be shown detailing progress
bootstrapping the Tor software into the network.

The bootstrap is 100% complete when Tor is able to create a circuit
through the network.

If you are running the Tor VM bundle Vidalia will also display the current
progress while bootstrapping into the Tor network.

After successful start a list of transparent proxy connection counts are
shown. This indicates that Tor VM is up and ready to start transparently
routing traffic through the Tor network. The socks port is also available to
the host for use with Polipo or Privoxy http proxies.

<!-- no marble for first release
The first time Vidalia is run the image tiles needed for the Marble Map
plugin will be generated at start. If you do not have sufficient memory or
CPU to generate these tiles you can install the full Vidalia Marble package
with the generated image tiles already included.

If any of the bundle applications stop working a repair can be requested
which may resolve the problem.
-->

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

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

Press The Windows Key + L to switch users, or select the "Log off"
Start Menu option followed by "Switch User"

Click the "Install TorButton" shortcut if you do not have the Tor Button
extension installed.

Continue with installation despite warning about installing from local file.

You will need to restart Firefox to use the new TorButton extension.

Click on the TorButton status icon in the lower right to enable Tor.

Verify that you are using Tor via
<a href="https://check.torproject.org/">https://check.torproject.org/</a>

<hr />
<a id="ExperimentalUse"></a> 
<h2><a class="anchor" href="#ExperimentalUse">Experimental: Using Flash</a></h2>

IMPORTANT: Tor VM can protect your endpoint IP address when using
Flash and other software but it does not yet protect against attacks which
reduce your anonymity set. DO NOT use Tor VM in this manner if you
rely on unlinkable anonymity; wait until this is addressed in future releases.

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

First be sure that transparent proxy of Internet traffic through Tor is
working correctly. Tor VM ensures that all your traffic is relayed
by default without any application configuration.

Connections made from the Browser and Flash Player plugin will now
be transparently proxied through the Tor network when viewing content.

The transparent proxy redirection counts will indicate connections redirected
through Tor in this manner. Traffic sent via TorButton and Polipo are visible as
SOCKS connections to the Tor VM instance.

<hr />
<a id="Modify"></a>
<h2><a class="anchor" href="#Modify">Modify Tor VM Install Options</a></h2>

Once a package is installed you can change the default installation options
via the "Change" option for the package. For example, Tor VM is configured to
run at start up which can be disabled by modifying the installation.

<img src="img/change01.png" alt="Change option is in Add Remove Programs" />
 
The Change package option will launch the installer GUI for the package.

<img src="img/change02.png" alt="Changes will launch application installer GUI" />
 
The list of configurable installation options can now be set as desired.
For example, disabling the "Run at Startup" option as shown here.

<img src="img/change03.png" alt="Change desired installation options" />
 
Select "Next" once all changes have been selected.

<img src="img/change04.png" alt="Select Next when changes selected" />
 
Select "Change" to apply the changes to the installed software.

<img src="img/change05.png" alt="Select Change to confirm changes" />
 
And finally "Finish" to exit the installer GUI. The requested changes
are now in effect.

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

A script to uninstall all of the Tor bundle applications at once is placed
on the desktop. Run this utility to remove all of the Tor packages and files.

<hr />
<a id="Repair"></a>
<h2><a class="anchor" href="#Repair">Repair Installed Applications</a></h2>

If any installed files become corrupted or deleted you can repair them
with the support option for the application package having problems.

Choose the repair option and all of the package files and registry will be
restored.

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

The Tor VM category in the Tor flyspray bug tracker is used to manage
defects and features. See the
<a href="http://bugs.noreply.org/flyspray/index.php?tasks=all&amp;project=4"
>Tor flyspray bug tracker</a> for known issues and pending changes.

<hr />
<a id="More"></a>
<h2><a class="anchor" href="#More">Additional Resources</a></h2>

The latest design document for Tor VM is available in revision control:
<a href="https://svn.torproject.org/svn/torvm/trunk/doc/design.html"
>https://svn.torproject.org/svn/torvm/trunk/doc/design.html</a>.

Features and fixes planned for the Tor VM software are documented in the
<a href="https://svn.torproject.org/svn/torvm/trunk/TODO">Tor VM TODO</a>.

<a href="https://data.peertech.org/torbld/info/Tor_VM-svn">Automated package
builds are available</a> for verifying fixes in subversion and testing work in
progress.

Be sure to build against a known working tag in the torvm repo. For
example, 
svn export https://svn.torproject.org/svn/torvm/tags/torvm-0_0_1 torvm-0.0.1-src

</div>

#include <foot.wmi>

tor-webwml.git

Edit for grammar / brevity.