Install Software

Easy

A primary Whonix goal is to greatly reduce the risk posed by (additional) software installations that are not exclusively designed to work with Tor.

Users can install any software inside Whonix-Workstation using apt-get, since it is based on Debian. However, this is not a recommendation for installing additional software.

Whonix is currently the most secure platform for running Tor-unsafe applications like Adobe Flash; see the operating system comparison.

The Whonix software page lists:

• Pre-installed Whonix applications which are available for different tasks.
• Recommended software for different user activities.
• Safety advice.
• Installation instructions.

Best Practices

Prefer APT

Generally, the safest option is to stick with Debian's official package manager APT. This is referenced throughout the wiki whenever the user runs apt-get. APT is a secure package manager which passes the TUF threat model, since it features metadata verification and expiration detection.

Avoid Third Party Package Managers

There are many third party package managers besides APT, however they lack the security safeguards that are standard in Debian. Popular examples are pip and node.js. The security concern with third party options is they do not verify the code comes from the author. When used, these package managers will run processes that pull untrusted code from the Internet and perform operations with root level permissions. If a trusted Workstation VM is required for sensitive use cases such as a Bitcoin wallet, then users should completely avoid this option.

Avoid Manual Software Installation

Generally avoid the manual installation of packages, even trusted ones. In practice that means most users should only be installing software with apt-get, unless special circumstances exist. Another risk is that foreign packages are often unsigned, and users may forget to update the software in a timely fashion.

Prefer Packages from Debian Stable Repository

Users who decide to install new software after considering the risks should preference Debian's Stable repository, rather than the Testing / Unstable or third party repositories.

The Debian FAQ provides a strong rationale for using the stable repository:

Stable is rock solid. It does not break and has full security support. But it not might have support for the latest hardware.

If security or stability are at all important for you: install stable. period. This is the most preferred way.

Since there is typically over 1 year between releases you might find that stable contains old versions of packages. However, they have been tested in and out. One can confidently say that the packages do not have any known severe bugs, security holes etc., in them. The packages in stable integrate seamlessly with other stable packages. These characteristics are very important for production servers which have to work 24 hours a day, 7 days a week.

On the other hand, packages in testing or unstable can have hidden bugs, security holes etc., Moreover, some packages in testing and unstable might not be working as intended.

Mixing packages from Debian testing or Debian unstable should only be attempted by advanced users. The reason is it could lead to a dependency hell, making it very difficult to resolve the breakage of APT package management.

To use newer package versions, Debian backports is a far safer alternative than the Debian testing or unstable repositories. However, Debian backports should be used conservatively:

Backports cannot be tested as extensively as Debian stable, and backports are provided on an as-is basis, with risk of incompatibilities with other components in Debian stable. Use with care!

For instructions on using Debian backports, see here.

GUI Applications with Root Rights

Never login as root user (sudo su) or run GUI applications using sudo application. This will fail and is a limitation inherited from Debian. If a user attempts this action, error messages like those below will appear.

No protocol specified

cannot connect to X server :0

As a KDE user (Non-Qubes-Whonix default) use kdesudo application. Otherwise, use gksudo application. For example.

Open /usr/local/etc/torrc.d/50_user.conf in an editor with root rights.

If you are using a graphical Whonix or Qubes-Whonix, run.

[select code]

kdesudo kwrite /usr/local/etc/torrc.d/50_user.conf

kdesudo kwrite /usr/local/etc/torrc.d/50_user.conf

If you are using a terminal-only Whonix, run.

[select code]

sudo nano /usr/local/etc/torrc.d/50_user.conf

sudo nano /usr/local/etc/torrc.d/50_user.conf

More Security

General Advice

Whonix users are free to install their favorite software packages, but should be aware that additional software increases the attack surface of the platform. Almost any application can be installed, with a few exceptions for programs that are impossible to torify. In addition, Whonix provides:

• Protection from IP and DNS leaks (see above for details).
• Partial protection against protocol leaks and fingerprinting, but this is far from perfect.

Users are responsible for trying to prevent any other protocol leaks using the "Torify: How-to" guide, but most of those are mitigated by Whonix.

apt-get Meta-data

When updating with apt-get, information will leak about which software packages and versions have been installed, unless Tor onion repositories have been configured. This meta-data cannot be directly linked to any other activity like web browsing, because the Whonix apt-get uwt wrapper forces it to pass through its own circuit. Despite this isolation, it is still possible for updates to be correlated with the same pseudonym.

Recommendations

For greater security when updating:

• Follow the guidelines below.
• Be especially careful when adding custom repositories, particularly Personal Package Archives (PPAs). Single developers are more easily pressured and/or likely to have malicious intent than the main distribution repositories.
• Read the protocol leak and fingerprinting protection entry first. It highlights useful information, like the fact that DNS and IP-related leaks do not apply to Whonix.
• Refer to the Tor Project's Torify: How-to which discusses various protocol leaks and how to mitigate them.
• Review the Tor Project's Transparent Proxy Leaks documentation, which is particularly relevant for Microsoft Windows.

How-to: Install or Update with Utmost Caution

1. Stop all activities and shutdown any open applications like Tor Browser.
2. Change the Tor circuit (this step may not apply if the user is running an onion service).
3. Update using apt-get after a random delay. By default, a new Tor circuit is generated after 10 seconds.
4. Change the Tor circuit again.
5. Continue user activities after another random period has elapsed.

Whonix-Workstation is Firewalled

The Whonix-Gateway firewall has several effects upon the Whonix-Workstation:

• Incoming connections are not supported.
  • If programs make outgoing connections, then incoming connections are accepted for web browsing, IRC, or other relevant applications.
  • Server ports ("open ports") are blocked.
  • The Ident Protocol / web server listening port is not reachable, unless it is explicitly configured.
• Onion Services can be hosted.
• Standard DNS requests on UDP port 53 are redirected to Tor's DnsPort.

Also note:

• Tor does not support UDP. This is not a Whonix-specific issue.
• Tor only partially supports IPv6, although full implementation is likely in the near term. This is not a Whonix-specific issue.
• All traffic from Whonix-Workstation and Whonix-Gateway is routed over Tor. Users should read the footnotes on the left-hand side.

The firewall on the Whonix-Gateway is very restrictive. It can be made even more restrictive by activating #OptionalFeatureNr.3# within the firewall script. It is possible to limit which outgoing ports are redirected to Tor's TransPort. Depending on what the user is trying to achieve, it could also be useful to remove all SocksPorts.

Related:

• Whonix-Workstation Firewall
• Ports

Advanced

Backports

• Replace package-name with the package you actually want to install.

Package package-name can be installed from Debian backports. This is non-ideal, see footnote.

1. Boot the Whonix-Workstation (whonix-ws-14) TemplateVM.

2. Add the current Debian stable backports codename stretch-backports to Debian apt sources.

Note: this applies to Whonix 14.0.0.7.4. Later Whonix versions may use a codename different to stretch.

In the Whonix-Workstation (whonix-ws-14) TemplateVM, run.

[select code]

sudo su -c "echo -e 'deb http://http.debian.net/debian stretch-backports main contrib non-free' > /etc/apt/sources.list.d/backports.list"

sudo su -c "echo -e 'deb http://http.debian.net/debian stretch-backports main contrib non-free' > /etc/apt/sources.list.d/backports.list"

Or alternatively if you are into Onionizing Repositories use the .onion mirror.

[select code]

sudo su -c "echo -e 'deb tor+http://vwakviie2ienjx6t.onion/debian stretch-backports main contrib non-free' > /etc/apt/sources.list.d/backports.list"

sudo su -c "echo -e 'deb tor+http://vwakviie2ienjx6t.onion/debian stretch-backports main contrib non-free' > /etc/apt/sources.list.d/backports.list"

3. Update the package lists.

[select code]

sudo apt-get update

sudo apt-get update

4. Install the selected software.

[select code]

sudo apt-get -t stretch-backports install package-name

sudo apt-get -t stretch-backports install package-name

The procedure is now complete.

5. Undo.

On occasion it is necessary to undo this configuration, for example when upgrading from Debian stretch to buster. To proceed, run.

[select code]

sudo rm /etc/apt/sources.list.d/backports.list

sudo rm /etc/apt/sources.list.d/backports.list

Install from Debian testing

Before completing steps in this section, first read #Prefer Packages from Debian Stable Repository.

Mixing packages from Debian stable with those from a later release like testing can destabilize the system due to associated software dependencies required for full functionality. First carefully check how packages will change before proceeding -- a host of upgrades is usually safe, but no Whonix packages should be removed as part of the process, see Whonix Debian Packages. It is recommended to complete this process in a separate Whonix-Workstation (whonix-ws-14-debian-testing-mix) due to the risks. Ask for advice in the forums on a case by case basis.

1. Boot the Whonix-Workstation (whonix-ws-14-debian-testing-mix) TemplateVM

2. Add the current Debian testing codename buster to sources.list

Note: this applies to Whonix 14. Later Whonix versions may use a codename different to buster.

In the Whonix-Workstation (whonix-ws-14-debian-testing-mix) TemplateVM, run.

[select code]

sudo su -c "echo -e 'deb http://http.debian.net/debian buster main' > /etc/apt/sources.list.d/testing.list"

sudo su -c "echo -e 'deb http://http.debian.net/debian buster main' > /etc/apt/sources.list.d/testing.list"

Or alternatively use the .onion mirror.

[select code]

sudo su -c "echo -e 'deb tor+http://vwakviie2ienjx6t.onion/debian buster main' > /etc/apt/sources.list.d/testing.list"

sudo su -c "echo -e 'deb tor+http://vwakviie2ienjx6t.onion/debian buster main' > /etc/apt/sources.list.d/testing.list"

3. Update the package lists

[select code]

sudo apt-get update

sudo apt-get update

4. Install the selected software

[select code]

sudo apt-get -t buster install packagename

sudo apt-get -t buster install packagename

• Replace packagename with the package you actually want to install.

The procedure is now complete.

5. Undo

On occasion it is necessary to undo this configuration, for example when upgrading from Debian stretch to buster. To proceed, run.

[select code]

sudo rm /etc/apt/sources.list.d/testing.list

sudo rm /etc/apt/sources.list.d/testing.list

Package Reinstallation

As per the free support principle, package reinstallation uses normal Debian processes.

The example below shows how the thunderbird package would be reinstalled. The user can substitute thunderbird with many other packages, so long as they do not have too many dependencies. The instructions are not suitable with any packages that are required for connectivity such as tor, because the reinstallation would be very difficult and is currently unsupported.

Even in the case of the thunderbird package, dependency complications emerge. The anon-workstation-packages-recommended package also depends on thunderbird. Further, the whonix-workstation package depends on anon-workstation-packages-recommended.

Update the package lists and upgrade before starting this procedure. See Updates for instructions.

Purge the package you want to reinstall.

[select code]

sudo apt-get purge thunderbird

sudo apt-get purge thunderbird

The output will show something like the following.

Reading package lists... Done
Building dependency tree       
Reading state information... Done
The following packages will be REMOVED:
  anon-workstation-packages-recommended* thunderbird* whonix-workstation*
0 upgraded, 0 newly installed, 3 to remove and 0 not upgraded.
After this operation, 90.8 MB disk space will be freed.
Do you want to continue? [Y/n] 
(Reading database ... 100681 files and directories currently installed.)
Removing whonix-workstation (3:2.9-1) ...
Removing anon-workstation-packages-recommended (3:2.9-1) ...
Removing thunderbird (38.4.0esr-1~deb8u1) ...
Purging configuration files for thunderbird (38.4.0esr-1~deb8u1) ...
Processing triggers for hicolor-icon-theme (0.13-1) ...
Processing triggers for menu (2.1.47) ...
Processing triggers for man-db (2.7.0.2-5) ...
Processing triggers for desktop-file-utils (0.22-1) ...
Processing triggers for qubes-core-agent (3.0.20-1+deb8u1) ...
Processing triggers for mime-support (3.58) ...

The packages anon-workstation-packages-recommended and whonix-workstation have been inadvertently uninstalled due to technical limitations. These packages will be reinstalled later.

Delete the user configuration folder if that is desired. In this thunderbird example, the user configuration folder would be the following (it differs depending on the package).

[select code]

rm -r ~/.thunderbird

rm -r ~/.thunderbird

Now reinstall the thunderbird package and the additional packages that were purged. The --no-install-recommends parameter below is optional.

[select code]

sudo apt-get install --no-install-recommends thunderbird anon-workstation-packages-recommended whonix-workstation

sudo apt-get install --no-install-recommends thunderbird anon-workstation-packages-recommended whonix-workstation

Related to: Whonix Debian Packages.

Install Software in a TemplateBasedVM

There is no reason to avoid installing software in TemplateBasedVMs, although software installed this way will not persist across reboots. Users can opt to use a custom script to automate this process, thereby minimizing time spent re-installing packages.

Advantages

This software installation method means a single VM assumes many of the positive characteristics found in both TemplateBasedVMs and StandaloneVMs.

• Centralized Updates: AppVMs are based on a TemplateVM. This means the AppVM's root filesystem is based on the corresponding template's root filesystem. Users need only update the TemplateVM and those updates will be reflected in the TemplateBasedVM's root filesystem upon restart.

• Minimal Disk Usage: TemplateBasedVMs require much less disk space than StandaloneVMs, since the AppVM's root filesystem is based the corresponding template. The AppVM only requires enough disk space to hold user files in the /home directory.

• Semi-persistent Storage: User data stored in /home , /rw and /usr/local survives reboot. Many applications like Signal and Wire store user data in the /home folder. Since the custom script installs the software seamlessly with little or no user interaction, the AppVM has "quasi-full persistence", not unlike a StandaloneVM's full persistence.

AppVM Preparation

1. Create an AppVM based on whonix-ws-14.

2. Pre-install any necessary dependencies available from packages.debian.org in the TemplateVM to speed up the repetitive software installation process. This means only packages or software missing from packages.debian.org will be repeatedly installed in the AppVM.

3. Create a custom script that runs at VM boot. The purpose of this script is to automate software installation that would otherwise require manual user steps. Note that script functionality is variable, dependent on the software packages being installed and the experience of the user.

Scripting is useful for common tasks such as:

• Adding specific software repositories.
• Importing verified signing keys.
• Updating the package list with apt-get update, after the repository and signing key are imported.
• Finally running apt-get install to install the relevant software package(s).

AppVM Use

Once user preparation is complete and the AppVM is started, it will automatically start the script to begin installing software. When the process finishes, the AppVM can be used like any other TemplateBasedVM. However when the AppVM is shutdown, all data outside of the persistent /home folder will be lost, including the newly installed software packages. Following reboot, the VM will again install the software packages automatically.

Using bind-dirs Selective Persistence

Using selective bind-dirs persistence is currently a difficult problem and undocumented. Further research is required to ascertain which files require persistence across VM reboots.

Foreign Sources

In most cases, the extensive software range available from the official Debian repositories should be enough to meet the user's needs. A selection of more than 50,000 programs can be installed within a couple of steps. These packages are constantly maintained for bug/security fixes and tightly integrated to provide a stable distribution.

To guarantee stability, no new versions are uploaded to Debian stable archives to avoid breaking the system. This makes Debian stable a dependable distribution and an excellent base for downstream distributions. However, the Linux software scene is very dynamic and sometimes the user will want software that is not yet packaged in Debian. In this instance, it may be necessary to install software from separate sources; either from third party repositories, as a stand-alone precompiled .deb binary, or directly compiled source packages.

Risks

The use of foreign sources should be kept to a minimum, as it may cause problems. Note this is simply a warning about the worst case scenario and not a predetermined outcome of installing third party software.

Security Issues

Keep in mind that foreign sources pose important security implications for the user's system. Installing software is tantamount to granting root privileges to the developers. Software originating from dubious sources could replace important system components with malicious versions that allow backdoors or Trojan horses to be installed on the system.

In general, the installation of software is a matter of trust. The fact is that users have to trust every software source they install. This trust is two-fold: firstly that the developers have integrity, and secondly that the community will notice any suspicious code, which might indicate compromise of the developers' machines.

Dependency Hell

Manually installed packages can contain library versions not available in the standard repositories. This causes problems with dependency resolution when installing additional software from the official repository. Individual applications are less critical in this context, but when important system libraries in the third-party software are considered, complications are inevitable.

Depending on the severity of the complications, upgrades to the next version of the operating system might fail, or the system may become unbootable or generally unstable.

Mitigation

Users can reduce security risks and eliminate the risk of making the workstation unusable by using Multiple Whonix-Workstations.

Footnotes

---

Random News:

Love Whonix and want to help spread the word? You can start by telling your friends or posting news about Whonix on your website, blog or social media.

---

https | (forcing) onion

Share: Twitter | Facebook

This is a wiki. Want to improve this page? Help is welcome and volunteer contributions are happily considered! See Conditions for Contributions to Whonix, then Edit! IP addresses are scrubbed, but editing over Tor is recommended. Edits are held for moderation.

Whonix is a licensee of the Open Invention Network. Unless otherwise noted, the content of this page is copyrighted and licensed under the same Libre Software license as Whonix itself. (Why?)