commit 5861397b7df921307fce1db43b8731ea997c7211 Author: Andrew David Wong Date: Sun May 26 19:32:45 2019 -0500 Reorganize files to account for new "External" section QubesOS/qubes-issues#4693 diff --git a/building/building-archlinux-template.md b/building/building-archlinux-template.md new file mode 100644 index 0000000..88f3caf --- /dev/null +++ b/building/building-archlinux-template.md @@ -0,0 +1,491 @@ +--- +layout: doc +title: Building Archlinux Template +permalink: /doc/building-archlinux-template/ +redirect_from: +- /en/doc/building-archlinux-template/ +- /doc/BuildingArchlinuxTemplate/ +- /wiki/BuildingArchlinuxTemplate/ +--- + +# Archlinux template building instructions + +**These are the instructions for Qubes 3.2. They will take you step by step through the entire process start to finish** + +*Note: These instructions have not been tested for Qubes 3.1. However they could be working.* + +*Note: No binary package for the archlinux template exists for Qubes 3.1.* + +## 1: Create and configure VM to use for template building + +* The VM should be based on a Fedora template. It's best to use a standalone VM. I created a standalone VM based on + the Fedora 23 template. I named the VM “**development**”. These instructions assume a standalone VM based on a Fedora template is being used. +
+
+![arch-template-01](/attachment/wiki/ArchlinuxTemplate/arch-template-01.png) +
+
+* Ensure there is at least 25GB preferably 30GB of free space in the private storage. I made the private storage 30GB to be safe. +
+
+![arch-template-02](/attachment/wiki/ArchlinuxTemplate/arch-template-02.png) +
+
+ +*Note: Unless otherwise noted, all commands are from within the “development” VM or whatever you named your standalone VM used for building the template.* + +## 2: Create GitHub Account (optional) + +* It can be helpful. Creating only a basic account is all that is needed. This will allow you to help, going forward, with the Qubes project. You could be help edit errors in documentation. It can also be of use building other templates. + +* Create user account here https://github.com +
+
+![arch-template-03](/attachment/wiki/ArchlinuxTemplate/arch-template-03.png) +
+
+ +## 3: Install necessary packages to 'development' VM for "Qubes Automated Build System" + +* Necessary packages to install: + + * git + + * createrepo + + * rpm-build + + * make + + * rpmdevtools + + * python2-sh + + * dialog + + * rpm-sign + + * gnupg + + +* The tools can usually be installed all together with the following terminal command string: + + * **$ sudo dnf install git createrepo rpm-build make wget rpmdevtools python2-sh dialog rpm-sign gnupg** +
+
+![arch-template-04](/attachment/wiki/ArchlinuxTemplate/arch-template-04.png) +
+
+ +## 4: Downloading and verifying the integrity of the "Qubes Automated Build System" + +* Import the Qubes master key + + gpg --keyserver pgp.mit.edu --recv-keys 0xDDFA1A3E36879494 + +* Verify its fingerprint, set as 'trusted'. [This is described here](/doc/VerifyingSignatures). + +* Download the Qubes developers' keys. + + wget https://keys.qubes-os.org/keys/qubes-developers-keys.asc + gpg --import qubes-developers-keys.asc + +* Download the latest stable qubes-builder repository: + + git clone git://github.com/QubesOS/qubes-builder.git qubes-builder + + ![arch-template-05](/attachment/wiki/ArchlinuxTemplate/arch-template-05.png) + +* Copy your gpg keyrings to your local copy of the repository. (Otherwise you will be asked to download the keys again.) + + # Execute the following commands in your home directory. + # It is assumed that the path to the repository is '~/qubes-builder'. + mkdir -p qubes-builder/keyrings/git + cp -t qubes-builder/keyrings/git/ .gnupg/pubring.gpg .gnupg/trustdb.gpg + +* Verify the integrity of the downloaded repository. The last line should read `gpg: Good signature from`... + + cd qubes-builder + git tag -v `git describe` + + +## 5: Configuring setup script to create builder.conf file + +* You will be creating the builder.conf file which tells where and what to use. The most automated, and in this case the easiest, way to create this is to use the script that is provided in Qubes Builder. Its named '**setup**'. Before running the script you need to edit one file it uses. + + *In the future this should not be needed once a change is made to the 'setup' script.* + + * Edit the '**qubes-os-r3.2.conf**' which is found in **/home/user/qubes-builder/example-configs** Use the text editor of your choice. + + * **$ cd /home/user/qubes-builder/example-configs/** + + * **$ nano -W qubes-os-r3.2.conf** or **$ gedit qubes-os-r3.2.conf** or etc…. +
+
+![arch-template-06](/attachment/wiki/ArchlinuxTemplate/arch-template-06.png) +
+
+ * Go to the first line containing '**DISTS_VM ?= fc23**' it will be preceeded by line '**DIST_DOM0 ?= fc20**'. Remove '**fc23**' or whatever is listed there leaving only '**DISTS_VM ?=**'. Then save the file and close the text editor. +
+
+![arch-template-07](/attachment/wiki/ArchlinuxTemplate/arch-template-07.png) +
+
+
+ +## 6: Run the 'setup' script to build the builder.conf file + +* Run the 'setup' script located in '**/home/user/qubes-builder/**' Make sure you are in directory '**qubes-builder**' + + * **$ cd /home/user/qubes-builder/** + + * **$ ./setup** +
+
+![arch-template-08](/attachment/wiki/ArchlinuxTemplate/arch-template-08.png) +
+
+ * First screen will ask you to import 'Qubes-Master-Signing-key.asc'. The 'setup' script not only downloads but confirms the key to that of the key on Qubes-OS website. + + * Select '**YES**' + * Select '**OK**' Press '**Enter**' +
+
+![arch-template-09](/attachment/wiki/ArchlinuxTemplate/arch-template-09.png) +
+
+ + * Next screen will ask you to import Marek Marczykowski-Goracki (Qubes OS signing key). Again 'setup' will confirm this key to the fingerprint. + + * Select '**YES**' + * Select '**OK**' Press '**Enter**' +
+
+![arch-template-10](/attachment/wiki/ArchlinuxTemplate/arch-template-10.png) +
+
+ + * This screen will give you the choice of which Qubes Release to build the template for. + + * Select '**Qubes Release 3.2**' + * Select '**OK**' Press '**Enter**' +
+
+![arch-template-11](/attachment/wiki/ArchlinuxTemplate/arch-template-11.png) +
+
+ + * Screen "**Choose Repos To Use To Build Packages**" + + * Select 'QubesOS/qubes- Stable - Default Repo' + * Select '**OK**' Press '**Enter**' +
+
+![arch-template-12](/attachment/wiki/ArchlinuxTemplate/arch-template-12.png) +
+
+ + * Screen "**Build Template Only?**" + + * Select '**Yes**' Press '**Enter**' +
+
+![arch-template-12](/attachment/wiki/ArchlinuxTemplate/arch-template-12a.png) +
+
+ + * Screen '**Builder Plugin Selection**' will give choices of builder plugins to use for the build. + + * Deselect '**Fedora**' + + * Deselect '**mgmt_salt**' + + * Select '**builder-archlinux**' + + * Select '**OK**' Press **Enter** +
+
+![arch-template-13](/attachment/wiki/ArchlinuxTemplate/arch-template-13.png) +
+
+ + * Screen '**Get sources**' wants to download additional packages needed for the choosen plugin/s. + + * Select '**Yes**' Press '**Enter**' +
+
+![arch-template-14](/attachment/wiki/ArchlinuxTemplate/arch-template-14.png) +
+
+ + * Then wait for download to finish and press '**OK**' +
+
+![arch-template-14](/attachment/wiki/ArchlinuxTemplate/arch-template-15.png) +
+
+ + * Screen '**Template Distribution Selection**' allows you to choose the actual template/s you wish to build. + + * Scroll Down to the very bottom (it is off the screen at first) + + * Select '**archlinux**' + + * Select '**OK**' Press '**Enter**' +
+
+![arch-template-16](/attachment/wiki/ArchlinuxTemplate/arch-template-16.png) +
+
+ + *Note: 'Setup' will close and will output the text of the created build.conf file as well as the needed **make** commands to build the template* +
+
+![arch-template-17](/attachment/wiki/ArchlinuxTemplate/arch-template-17.png) +
+
+ +## 7: Install all the dependencies + +*Note: make sure you are in the “qubes-builder” directory to run the following cmds* + +* **$ make install-deps** +
+
+![arch-template-18](/attachment/wiki/ArchlinuxTemplate/arch-template-18.png) +
+
+ +## 8: Get all the require sources for the build: (Note: this may take some time) + +* **$ make get-sources** +
+
+![arch-template-19](/attachment/wiki/ArchlinuxTemplate/arch-template-19.png) +
+
+
+ +## 9: Make all the require Qubes Components + +* **Note:** You can run a single command to build all the Qubes components or you can run them each individually. + Both ways below: + + * Single command to build all Qubes components together: (this command can take a long time to process depending of your pc proccessing power) + + * **$ make qubes-vm** +
+
+![arch-template-20](/attachment/wiki/ArchlinuxTemplate/arch-template-20.png) +
+
+ + + * These are the indivual component 'make' commands: + + * **$ make vmm-xen-vm** + + * **$ make core-vchan-xen-vm** + + * **$ make core-qubesdb-vm** + + * **$ make linux-utils-vm** + + * **$ make core-agent-linux-vm** + + * **$ make gui-common-vm** + + * **$ make gui-agent-linux-vm** +
+
+ + +## 10: Make the actual Archlinux template + +* **$ make template** +
+
+![arch-template-21](/attachment/wiki/ArchlinuxTemplate/arch-template-21.png) +
+
+ +## 11: Transfer Template into Dom0 + +* You need to ensure these two files are in the '**noarch**' directory + + * **$ cd /home/user/qubes-builder/qubes-src/linux-template-builder/rpm/** + + * **$ ls** *(confirm the below two files are there)* + + * **install-templates.sh** (script to install template in dom0) + + * **$ cd noarch** + + * **$ ls** + + * **qubes-template-archlinux-X.X.X-XXXXXXXXXXXX.noarch.rpm** (this is the template package 'X' replaces version and build digits) +
+
+![arch-template-22](/attachment/wiki/ArchlinuxTemplate/arch-template-22.png) +
+
+ +* **Transfer the install-templates.sh script file into Dom0** + *Note: as there is not a typical file transfer method for Dom0, for security reasons, this less than simple transfer function has to be used* + + * Switch to Domo and open a terminal window. + + **Note:** Take care when entering these cmd strings. They are very long and have a number of characters that are easy to mix '**-**' vs '**.**' '**Templates** (correct) vs **templates** (wrong) or **Template_**'(also wrong) This script will also take care of transfering the actual template.rpm to Dom0 as well. + + * **$ qvm-run --pass-io development 'cat /home/user/qubes-builder/qubes-src/linux-template-builder/rpm/install-templates.sh' > install-templates.sh** + + * **$ chmod +x install-templates.sh** + + * **$ ./install-templates.sh** + +
+
+![arch-template-23](/attachment/wiki/ArchlinuxTemplate/arch-template-23.png) +
+
+![arch-template-24](/attachment/wiki/ArchlinuxTemplate/arch-template-24.png) +
+
+ +* If everything went correct there should be a Archlinux template listed in your Qubes VM Manager * + + +# Known problems in building with Qubes R3.X + +## Build fails when fetching qubes-mgmt-salt + +The `qubes-mgmt-salt` repo is not currently forked under the marmarek user on +GitHub, to whom the above instructions set the `GIT_PREFIX`. As Archlinux is +not yet supported by mgmt-salt, simply leave it out of the build (when building +the Archlinux template on its own) by appending the following to your `override.conf` file: + +`BUILDER_PLUGINS := $(filter-out mgmt-salt,$(BUILDER_PLUGINS))` + +## The nm-applet (network manager icon) fails to start when archlinux is defined as a template-vm + +In fact /etc/dbus-1/system.d/org.freedesktop.NetworkManager.conf does not allow a standard user to run network manager clients. To allow this, one need to change inside \: + +`` + +to + +`` + +## DispVM, Yum proxy and most Qubes addons (thunderbird ...) have not been tested at all + +## Error when building the gui-agent-linux with pulsecore error + +``` +module-vchan-sink.c:62:34: fatal error: pulsecore/core-error.h: No such file or directory + #include +``` + +This error is because Archlinux update package too quickly. Probably, a new version of pulseaudio has been released, but the qubes team has not imported the new development headers yet. + +You can create fake new headers just by copying the old headers: +``` +cd qubes-builder/qubes-src/gui-agent-linux/pulse +ls +cp -r pulsecore-#lastversion pulsecore-#archlinuxversion +``` + +You can check the current archlinux pulseaudio version like this: + +`sudo chroot chroot-archlinux/ pacman -Qi pulseaudio` + +## chroot-archlinux/dev/pts has not been unmounted + +This is a known problem when there are errors during building. Check what is mounted using the command mount (with no parameters). Just unmount what you can (or reboot your vm if you are too lazy :) ) + +# Known problems in building with Qubes R2-B2 + +## xen-vmm-vm fail to build with a PARSETUPLE related error (FIXED) + +Commenting out "\#define HAVE\_ATTRIBUTE\_FORMAT\_PARSETUPLE" from chroot\_archlinux/usr/include/python2.7/pyconfig.h fixes the problem, but it isn't the right solution [1]... + +A better fix is planned for the next python release (the bug is considered release blocking), and will be updated in archlinux chroot as soon as available. + +[1] [https://bugs.python.org/issue17547](https://bugs.python.org/issue17547) + +## The boot process fails without visible errors in the logs, but spawn a recovery shell + +The problem is new conflict between systemd and the old sysvinit style. To fix this, you can change the master xen template in dom0 to remove sysvinit remains: Edit **INSIDE DOM0** /usr/share/qubes/vm-template.conf, and change the variable 'extra' that contains the kernel variables: from: + +`extra="ro nomodeset 3 console=hvc0 rd_NO_PLYMOUTH {kernelopts}"` + +to: + +`extra="ro nomodeset console=hvc0 rd_NO_PLYMOUTH {kernelopts}"` + +## Qubes-OS is now using different xenstore variable names, which makes to archlinux VM failing to boot + +Apply the following fix in the template to revert the variable name to the old Qubes version. + +You can edit the template the following way: + +``` +sudo mkdir /mnt/vm +sudo mount /var/lib/qubes/vm-templates/archlinux-x64/root.img /mnt/vm +sudo chroot /mnt/vm +``` + +Then apply the fix: + +``` +sudo sed 's:qubes-keyboard:qubes_keyboard:g' -i /etc/X11/xinit/xinitrc.d/qubes-keymap.sh + +sudo sed 's:qubes-netvm-domid:qubes_netvm_domid:g' -i /etc/NetworkManager/dispatcher.d/30-qubes-external-ip +sudo sed 's:qubes-netvm-external-ip:qubes_netvm_external_ip:g' -i /etc/NetworkManager/dispatcher.d/30-qubes-external-ip + +sudo sed 's:qubes-netvm-network:qubes_netvm_network:g' -i /usr/lib/qubes/init/network-proxy-setup.sh +sudo sed 's:qubes-netvm-gateway:qubes_netvm_gateway:g' -i /usr/lib/qubes/init/network-proxy-setup.sh +sudo sed 's:qubes-netvm-netmask:qubes_netvm_netmask:g' -i /usr/lib/qubes/init/network-proxy-setup.sh +sudo sed 's:qubes-netvm-secondary-dns:qubes_netvm_secondary_dns:g' -i /usr/lib/qubes/init/network-proxy-setup.sh + +sudo sed 's:qubes-vm-type:qubes_vm_type:g' -i /usr/lib/qubes/init/qubes-sysinit.sh + +sudo sed 's:qubes-ip:qubes_ip:g' -i /usr/lib/qubes/setup-ip +sudo sed 's:qubes-netmask:qubes_netmask:g' -i /usr/lib/qubes/setup-ip +sudo sed 's:qubes-gateway:qubes_gateway:g' -i /usr/lib/qubes/setup-ip +sudo sed 's:qubes-secondary-dns:qubes_secondary_dns:g' -i /usr/lib/qubes/setup-ip +sudo sed 's:qubes-netvm-network:qubes_netvm_network:g' -i /usr/lib/qubes/setup-ip +sudo sed 's:qubes-netvm-gateway:qubes_netvm_gateway:g' -i /usr/lib/qubes/setup-ip +sudo sed 's:qubes-netvm-netmask:qubes_netvm_netmask:g' -i /usr/lib/qubes/setup-ip +sudo sed 's:qubes-netvm-secondary-dns:qubes_netvm_secondary_dns:g' -i /usr/lib/qubes/setup-ip + +sudo sed 's:qubes-iptables-domainrules:qubes_iptables_domainrules:g' -i /usr/bin/qubes-firewall +sudo sed 's:qubes-iptables-header:qubes_iptables_header:g' -i /usr/bin/qubes-firewall +sudo sed 's:qubes-iptables-error:qubes_iptables_error:g' -i /usr/bin/qubes-firewall +sudo sed 's:qubes-iptables:qubes_iptables:g' -i /usr/bin/qubes-firewall + +sudo sed 's:qubes-netvm-domid:qubes_netvm_domid:g' -i /usr/bin/qubes-netwatcher +sudo sed 's:qubes-netvm-external-ip:qubes_netvm_external_ip:g' -i /usr/bin/qubes-netwatcher +sudo sed 's:qubes-vm-updateable:qubes_vm_updateable:g' -i /usr/lib/qubes/qubes_trigger_sync_appmenus.sh + +sudo sed 's:qubes-vm-type:qubes_vm_type:g' -i /usr/bin/qubes-session +sudo sed 's:qubes-vm-updateable:qubes_vm_updateable:g' -i /usr/bin/qubes-session +``` + +Do not forgot to unmount the VM: + +`umount /mnt/vm` + +## Installing the template in dom0 fails because of a missing dependency (qubes-core-dom0-linux) + +Again you built a template based on a recent Qubes API which has not been released yet. So skip the dependency for now + +`sudo rpm -U --nodeps yourpackage.rpm` + + +# Qubes Mailing List Threads on the Archlinux build process + +* [Qubes-Devel](https://groups.google.com/forum/#!forum/qubes-devel): [Qubes Builder failed Archlinux repository is missing](https://groups.google.com/forum/#!topic/qubes-devel/tIFkS-rPVx8) + +* [Qubes-Users](https://groups.google.com/forum/#!forum/qubes-users): [Trying to compile archlinux template](https://groups.google.com/forum/#!topic/qubes-users/7wuwr3LgkQQ) + +
diff --git a/building/building-non-fedora-template.md b/building/building-non-fedora-template.md new file mode 100644 index 0000000..182634a --- /dev/null +++ b/building/building-non-fedora-template.md @@ -0,0 +1,151 @@ +--- +layout: doc +title: Building Non-Fedora Template +permalink: /doc/building-non-fedora-template/ +redirect_from: +- /en/doc/building-non-fedora-template/ +- /doc/BuildingNonFedoraTemplate/ +- /wiki/BuildingNonFedoraTemplate/ +--- + +Building a TemplateVM for ArchLinux (or another non Fedora OS) +============================================================== + +If you don't like using Fedora because of specific administration, package management or other building needs, you could build a TemplateVM for your distribution of choice. + +This article shows how to build a template for a different OS, taking ArchLinux as an example. + +Qubes builder scripts +===================== + +You can start creating Qubes builder scripts for your new OS. Just note that it will probably make your testing process harder than trying to build the package directly in an HVM on which you already installed this new OS. + +chroot initialization +--------------------- + +You need to customize some scripts that will be used to build all the Qubes tools. + +The scripts you will be interested in will be inside the `qubes-src/linux-template-builder` folder: + +~~~ +scripts_fedora +scripts_archlinux +scripts_yourOSname +~~~ + +### 00\_prepare.sh + +The goal of the first script `00_prepare.sh` is to download and verify the signature of the installation CD and tools. You can use the `$CACHEDIR` directory variable to store files that could be reused (such as downloaded scripts or iso files). + +### 01\_install\_core.sh + +The goal of this script is to install a base environment of your target OS inside the `$INSTALLDIR` directory variable. Generally you need to bootstrap/install your package manager inside the `$INSTALLDIR` directory and install the base packages. + +### Testing the installation process + +Edit the file `builder.conf` to change the variable `$DISTS_VM` to your OS name (`DISTS_VM=your_os_name`). The try to create (make) the template to check that at least these first two scripts are working correctly: + +~~~ +make linux-template-builder +~~~ + +Qubes builder Makefiles +----------------------- + +Now you need to create Makefiles specific to your OS. You will find the required scripts directly inside the `qubes-builder` folder: + +~~~ +prepare-chroot-yourOSname +Makefile.yourOSname +~~~ + +### prepare-chroot-yourOSname + +The goal of this file is to prepare a development environment of your target OS inside a chroot. You will reuse the `00_prepare.sh` and `01_install_core.sh` scripts. Additionally, the following things will be necessary to put in this Makefile: + +- the `$1` variable will contain the installation directory (`$INSTALLDIR` should contain the same value as `$1` when you run `00_prepare.sh` or `01_install_core.sh`) +- after your base system is installed, you should install development tools and libraries (gcc, make, ...) +- create a user called 'user' inside your chroot, and give him enough rights to run the command sudo without any password +- register all the repositories that are be necessary and synchronize the package database +- register a custom repository that will be used to store Qubes packages + +### Makefile.yourOSname + +This file will be used to define the action required when installing a custom package. The most important one are: + +- `dist-prepare-chroot`: that's where you will call `prepare-chroot-yourOSname` if the chroot has not been initialized. +- `dist-package`: that's where you will chroot the development environment and run the command used to build a package. +- `dist-build-dep`: that's where you will create the custom repository for your target OS based on already compiled packages. + +These additional target need to exist once you created your first packages: + +- `dist-copy-out`: that's where you will retrieve the package you just built and put it with all the other packages you prepared. +- `update-repo`: that's where you will retrieve the package that have been built and add it to the custom repository. + +### Testing the development chroot + +You will be able to test these scripts when making the first Qubes packages. Don't forget that the first things that run when running `make somcomponent-vm` will be these two scripts, and that you will need to debug it at this point. + +Qubes packages +-------------- + +* [vmm-xen](https://github.com/QubesOS/qubes-vmm-xen) +* [core-vchan-xen](https://github.com/QubesOS/qubes-core-vchan-xen) +* [linux-utils](https://github.com/QubesOS/qubes-linux-utils) +* [core-agent-linux](https://github.com/QubesOS/qubes-core-agent-linux) +* [gui-common](https://github.com/QubesOS/qubes-gui-common) +* [gui-agent-linux](https://github.com/QubesOS/qubes-gui-agent-linux) + +Additional Installation scripts +------------------------------- + +Again you need to work on scripts inside the `qubes-src/linux-template-builder` folder: + +~~~ +scripts_fedora +scripts_archlinux +scripts_yourOSname +~~~ + +### 02\_install\_groups.sh + +The goal of this script is to install all the packages that you want to use in your template (eg: firefox, thunderbird, a file manager, Xorg...). + +### 04\_install\_qubes.sh + +The goal of this script is to install in your template all the packages you built previously. Also you need to edit the fstab file of your template to mount Qubes virtual hard drives. + +### 09\_cleanup.sh + +This script is use to finalize and to remove unnecessary things from your template, such as cached packages, unused development packages ... + +Starting with an HVM +==================== + +If no Qubes packages are available for your selected OS. You could start to install an HVM with your OS. Your goals will be: + +- to identify how to install the OS using command lines +- to create required Qubes packages +- to identify potential issue making all Qubes agents and scripts working correctly. + +As soon as you manage to make `qrexec` and `qubes-gui-agent` working, it should be sufficient to start preparing a template VM. + +### Xen libraries + +Several Xen libraries are required for Qubes to work correctly. In fact, you need to make `xenstore` commands working before anything else. For this, Qubes git can be used as several patches have been selected by Qubes developers that could impact the activity inside a VM. Start be retrieving a recent git and identify how you can build a package from it: `git clone https://github.com/QubesOS/qubes-vmm-xen.git`. + +Find the .spec file in the git repository (this is the file being used to build rpm packages), and try to adapt it to your OS in order to build a package similar to the target 'vmm-xen'. For example, a PKGBUILD has been created for [ArchLinux](/doc/templates/archlinux/) and can be found in the vmm-xen repository. + +Don't be afraid with the complexity of the PKGBUILD, most of the code is almost a copy/paste of required sources and patches found in the .spec file provided in the git repository. + +Note once the package has been successfully compiled and installed, you need to setup XEN filesystem. Add the following line to your fstab (you can create this line in your package install script): `xen /proc/xen xenfs defaults 0 0`. + +Now install the package you built and mount `/proc/xen`. Verify that xenstore-read works by running: `xenstore-read name`. That should give you the current name. + +### ArchLinux example PKGBUILDs + +Qubes OS core agent (qrexec...) - [https://aur.archlinux.org/packages/qu/qubes-vm-core/PKGBUILD](https://aur.archlinux.org/packages/qu/qubes-vm-core/PKGBUILD) + +Qubes OS kernel modules - [https://aur.archlinux.org/packages/qu/qubes-vm-kernel-modules/PKGBUILD](https://aur.archlinux.org/packages/qu/qubes-vm-kernel-modules/PKGBUILD) + +Qubes OS GUI agent - [https://aur.archlinux.org/packages/qu/qubes-vm-gui/PKGBUILD](https://aur.archlinux.org/packages/qu/qubes-vm-gui/PKGBUILD) diff --git a/building/building-whonix-template.md b/building/building-whonix-template.md new file mode 100644 index 0000000..423487b --- /dev/null +++ b/building/building-whonix-template.md @@ -0,0 +1,94 @@ +--- +layout: doc +title: Building Whonix Templates +permalink: /doc/building-whonix-template/ +redirect_from: +- /en/doc/building-whonix-template/ +--- + +## Building Whonix Templates + +The Whonix templates are easily downloaded and installed by following the [procedure here](https://www.whonix.org/wiki/Qubes/Install). +However, they are integrated into `qubes-builder` so they are straight-forward to build yourself if you prefer. + +Many other Qubes templates can also be built by following this procedure. +Simply choose the appropriate builder(s) and template(s) you wish to build in the `./setup` procedure below. +Always include the `mgmt-salt` builder. + +First, set up the [Build Environment](/doc/qubes-iso-building/#build-environment) (follow the build environment section only). + +Next, configure the builder: + +~~~ +cd ~/qubes-builder +./setup +# Select Yes to add Qubes Master Signing Key +# Select Yes to add Qubes OS Signing Key +# Select 4.0 for version +# Stable +# Select Current (if you want the option to use pre-built packages) +# Yes (we want to build only templates) +# Select fc29 and stretch (for the currently shipping templates) +# Select builder-rpm, builder-debian, template-whonix, mgmt-salt +# Yes (to download) +~~~ + +Once it completes downloading, re-run `setup` to add the Whonix templates: + +~~~ +./setup +# Choose the same options as above, except at templates select: +# whonix-gateway-14, whonix-workstation-14 +# If prompted, choose Yes to add adrelanos's third party key +~~~ +Continue the build process with: + +~~~ +make install-deps +make get-sources +~~~ + +You will often need to edit/update `qubes-src/template-whonix/builder.conf` at this stage to specify the currently shipping Tor Browser version. +Open it in your favorite editor, then look for "Extra Whonix Build Options" and add/edit the `WHONIX_TBB_VERSION` variable to specify the current version. +For example: + +``` +################################################################################ +# Extra Whonix Build Options +################################################################################ + +# Whonix repository. +WHONIX_APT_REPOSITORY_OPTS ?= stable +#WHONIX_APT_REPOSITORY_OPTS = off + +# Use turbo mode to build template +BUILDER_TURBO_MODE ?= 1 + +# Enable Tor by default (0: disable; 1: enable) +WHONIX_ENABLE_TOR ?= 0 + +WHONIX_TBB_VERSION ?= 7.5.2 +``` + +You can add/edit the `WHONIX_TBB_VERSION` variable in `~/qubes-builder/builder.conf` instead of this file if preferred. + +Finally, use: + +~~~ +make qubes-vm +make template +~~~ + +Once the build is complete, the install packages for your newly built templates will be located in `~/qubes-builder/qubes-src/linux-template-builder/rpm/noarch`. +Copy them from there to dom0 and install: + +~~~ +qvm-run --pass-io 'cat ~/qubes-builder/qubes-src/linux-template-builder/rpm/noarch/qubes-template-whonix-gw-4.0.0-201802250036.noarch.rpm' > ~/qubes-template-whonix-gw-4.0.0-201802250036.noarch.rpm +qvm-run --pass-io 'cat ~/qubes-builder/qubes-src/linux-template-builder/rpm/noarch/qubes-template-whonix-ws-4.0.0-201802250145.noarch.rpm' > ~/qubes-template-whonix-ws-4.0.0-201802250145.noarch.rpm +sudo dnf install qubes-template-whonix-gw-4.0.0-201802250036.noarch.rpm +sudo dnf install qubes-template-whonix-ws-4.0.0-201802250145.noarch.rpm +~~~ + +And you are done! + + diff --git a/configuration-guides/change-time-zone.md b/configuration-guides/change-time-zone.md new file mode 100644 index 0000000..4846317 --- /dev/null +++ b/configuration-guides/change-time-zone.md @@ -0,0 +1,36 @@ +--- +layout: doc +title: Changing your Time Zone +permalink: /doc/change-time-zone/ +--- + +# Changing your Time Zone # + +## Qubes 4.0 ## + +### Command line ### + +If you use the i3 window manager or would prefer to change the system's time +zone in terminal you can issue the `timedatectl` command with the option +`set-timezone`. + +For example, to set the system's time zone to Berlin, Germany type in a dom0 +terminal: + + $ sudo timedatectl set-timezone 'Europe/Berlin' + +You can list the available time zones with the option `list-timezones` and show +the current settings of the system clock and time zone with option `status`. + +Example output status of `timedatectl` on a system with time zone set to +Europe/Berlin: + + [user@dom0 ~]$ timedatectl status + Local time: Sun 2018-10-14 06:20:00 CEST + Universal time: Sun 2018-10-14 04:20:00 UTC + RTC time: Sun 2018-10-14 04:20:00 + Time zone: Europe/Berlin (CEST, +0200) + Network time on: no + NTP synchronized: no + RTC in local TZ: no + diff --git a/configuration-guides/disk-trim.md b/configuration-guides/disk-trim.md new file mode 100644 index 0000000..e1fe258 --- /dev/null +++ b/configuration-guides/disk-trim.md @@ -0,0 +1,112 @@ +--- +layout: doc +title: Disk TRIM +permalink: /doc/disk-trim/ +redirect_from: +- /en/doc/disk-trim/ +- /doc/DiskTRIM/ +- /wiki/DiskTRIM/ +--- + +Disk Trim +========= + +Disk trimming is the procedure by which the operating system informs the underlying storage device of which storage blocks are no longer in use. +It does this by issuing an `ATA_TRIM` command for the block. This is also known as a `discard`. +In this way, the storage device can perform garbage collection of the unused blocks and internally prepare them for reuse. SSDs in general benefit from this, while HDDs do not. + +In a Linux system running on bare metal, this is relatively straight-forward. +When instructed by the operating system, discards are issued by the file-system driver directly to the storage driver and then to the SSD. + +In Qubes, this gets more complex due to virtualization, LUKS, and LVM (and thin pools on R4.0 and up). +If you run `fstrim --all` inside a TemplateVM, in a worst case the `discard` can follow a path like: + + OS -> File-system Driver -> Virtual Storage Driver -> Backend Storage Driver -> LVM Storage Driver -> LUKS Driver -> Physical Storage Driver -> Physical Storage Device + +If discards are not supported at any one of those layers, it will not make it to the underlying physical device. + +There are some security implications to permitting TRIM (read for example [this article](https://asalor.blogspot.com/2011/08/trim-dm-crypt-problems.html)), but in most cases not exploitable. +Conversely, TRIM can improve security against local forensics when using SSDs, because with TRIM enabled deleting data (usually) results in the actual data being erased quickly, rather than remaining in unallocated space indefinitely. +However deletion is not guaranteed, and can fail to happen without warning for a variety of reasons. + + +Configuration +---------- + +In all versions of Qubes, you may want to set up a periodic job in `dom0` to trim the disk. +This can be done with either systemd (weekly only) or cron (daily or weekly). + + * **Systemd** + + From a terminal as a regular user: + + ``` + systemctl enable fstrim.timer + systemctl start fstrim.timer + ``` + + * **Cron** + + This can be done from a terminal as root, by creating a `trim` file in `/etc/cron.daily` (or `/etc/cron.weekly`). + Add the following contents: + + ``` + #!/bin/bash + /sbin/fstrim --all + ``` + And mark it as executable with `chmod 755 /etc/cron.daily/trim`. + +**Note** Although discards can be issued on every delete inside `dom0` by adding the `discard` mount option to `/etc/fstab`, this option can hurt performance so the above procedure is recommended instead. +However, inside App and Template qubes, the `discard` mount option is on by default to notify the LVM thin pool driver that the space is no longer needed and can be zeroed and re-used. + +If you are using Qubes with LVM, you may also want to set `issue_discards = 1` in `/etc/lvm/lvm.conf`. +Setting this option will permit LVM to issue discards to the SSD when logical volumes are shrunk or deleted. +In R4.x, LVM Logical volumes are frequently deleted (every time a disposable VM is shut down, for example) so you may want to set `issue_discards = 1` if using an SSD, but see the article linked in the first section of this page. +However, this is relatively rare in R3.x. + + +LUKS +---------- + +If you have enabled LUKS in dom0, discards will not get passed down to the storage device. + +To enable TRIM support in dom0 with LUKS you need to: + +1. Get your LUKS device UUID: + + ~~~ + ls /dev/mapper/luks-* + ~~~ + +2. Add entry to `/etc/crypttab` (replace luks-\ with the device name and the \ with UUID alone): + + ~~~ + luks- UUID= none discard + ~~~ + +3. Add `rd.luks.options=discard` to kernel cmdline (follow either GRUB2 or EFI, not both): + * GRUB2: `/etc/default/grub`, `GRUB_CMDLINE_LINUX` line and + Rebuild grub config (`grub2-mkconfig -o /boot/grub2/grub.cfg`), then + Rebuild initrd (`dracut -f`) + * EFI: `/boot/efi/EFI/qubes/xen.cfg`, `kernel=` line(s), then + Rebuild initrd (`dracut -f /boot/efi/EFI/qubes/initramfs-$(uname -r).img $(uname -r)`) + +4. Reboot the system. + +5. To verify if discards are enabled you may use `dmsetup table` (confirm the line for your device mentions "discards") or just run `fstrim -av` (you should see a `/` followed by the number of bytes trimmed). + + +Swap Space +---------- + +By default TRIM is not enabled for swap. +To enable it add the `discard` flag to the options for the swap entry in `/etc/fstab`. +This may or may not actually improve performance. +If you only want the security against local forensics benefit of TRIM, you can use the `discard=once` option instead to only perform the TRIM operation once during at boot. + +To verify that TRIM is enabled, check `dmesg` for what flags were enabled when the swap space was activated. +You should see something like the following: + + Adding 32391164k swap on /dev/mapper/qubes_dom0-swap. Priority:-2 extents:1 across:32391164k SSDscFS + +The `s` indicates that the entire swap device will be trimmed at boot, and `c` indicates that individual pages are trimmed after they are no longer being used. diff --git a/configuration-guides/external-audio.md b/configuration-guides/external-audio.md new file mode 100644 index 0000000..b50c6a7 --- /dev/null +++ b/configuration-guides/external-audio.md @@ -0,0 +1,55 @@ +--- +layout: doc +title: External Audio +permalink: /doc/external-audio/ +redirect_from: +- /en/doc/external-audio/ +- /doc/ExternalAudio/ +- /wiki/ExternalAudio/ +--- + +Using External Audio Devices +============================ + +Why you want to use external audio devices +------------------------------------------ + +Qubes audio virtualization protocol does not implement latency reporting for security reasons, keeping the protocol as simple as possible. +Also, in a compromise between low latency and low CPU usage, latency may be around 200 ms. +So applications demanding higher audio quality (even Skype) need a better environment. +But Qubes flexibility fully allows that using external audio devices. +These are mostly USB audio cards, but firewire devices also might be used. + +Implementing external audio devices +----------------------------------- + +First you need to identify an user VM dedicated to audio and [assign a device](/doc/AssigningDevices) to it. +In the most common case the assigned device is the USB controller to which your USB audio card will be connected. + +### Fedora VMs + +In a terminal of the template from which you user VM depends, install pavucontrol with: + +~~~ +sudo dnf install pavucontrol +~~~ + +Close the template and start or restart your user VM, insert your external audio device, open a terminal and prepare pulseaudio to use it with: + +~~~ +sudo chmod a+rw /dev/snd/* +pactl load-module module-udev-detect +~~~ + +Start the audio application that is going to use the external audio device. + +Launch pavucontrol, for example using "run command in VM" of Qubes Manager and select your external audio card in pavucontrol. +You need to do that only the first time you use a new external audio device, then pulse audio will remember your selection. + +If you detach your external audio device, then want to insert it again (or want to change it with another one), you need to repeat the previous commands in terminal adding another line at the beginning: + +~~~ +pactl unload-module module-udev-detect +sudo chmod a+rw /dev/snd/* +pactl load-module module-udev-detect +~~~ diff --git a/configuration-guides/fetchmail.md b/configuration-guides/fetchmail.md new file mode 100644 index 0000000..25bd4ab --- /dev/null +++ b/configuration-guides/fetchmail.md @@ -0,0 +1,93 @@ +--- +layout: doc +title: Fetchmail +permalink: /doc/fetchmail/ +redirect_from: +- /en/doc/fetchmail/ +- /doc/Fetchmail/ +- /wiki/Fetchmail/ +--- + +Fetchmail +========= + +Fetchmail is standalone MRA (Mail Retrieval Agent) aka "IMAP/POP3 client". Its sole purpose is to fetch your messages and store it locally or feed to local MTA (Message Transfer Agent). It cannot "read" messages — for that, use a MUA like Thunderbird or [Mutt](/doc/mutt/). + +Installation +------------ + +`dnf install fetchmail` + +Configuration +------------- + +Assuming you have more than one account (safe assumption these days), you need to spawn multiple fetchmail instances, one for each IMAP/POP3 server (though one instance can watch over several accounts on one server). The easiest way is to create template systemd unit and start it several times. Fedora does not supply any, so we have to write one anyway. + +**NOTE:** this assumes you use [Postfix](/doc/postfix/) or Exim4 as your local MTA. + +In TemplateVM create `/etc/systemd/system/fetchmail@.service`: + +~~~ +[Unit] +Description=Mail Retrieval Agent +After=network.target +Requires=postfix.service + +[Service] +User=user +ExecStart=/bin/fetchmail -f /usr/local/etc/fetchmail/%I.rc -d 60 -i /usr/local/etc/fetchmail/.%I.fetchids --pidfile /usr/local/etc/fetchmail/.%I.pid +RestartSec=1 +~~~ + +Alternatively, in Debian with Exim4: + +~~~ +[Unit] +Description=Mail Retrieval Agent +After=network.target +Requires=exim4.service + +[Service] +User=user +ExecStart=/usr/bin/fetchmail -f /usr/local/etc/fetchmail/%I.rc -d 60 -i /usr/local/etc/fetchmail/.%I.fetchids --pidfile /usr/local/etc/fetchmail/.%I.pid +RestartSec=1 +~~~ + +Then shutdown TemplateVM, start AppVM and create directory `/usr/local/etc/fetchmail`. In it, create one `.rc` file for each instance of fetchmail, ie. `personal1.rc` and `personal2.rc`. Sample configuration file: + +~~~ +set syslog +set no bouncemail +#set daemon 600 + +poll mailserver1.com proto imap + no dns + uidl + tracepolls +user woju pass supersecret + ssl + sslproto "TLS1" + sslcertfile "/etc/pki/ca-trust/extracted/openssl/ca-bundle.trust.crt" + sslcertck + mda "/usr/sbin/sendmail -i -f %F -- user" + fetchall + idle + +# vim: ft=fetchmail +~~~ + +Then `chown -R user:user /usr/local/etc/fetchmail` and `chmod 600 /usr/local/etc/fetchmail/*.rc`. **This is important**, fetchmail will refuse to run with wrong permissions on its rc-file. + +Next, add this to `/rw/config/rc.local`: + +~~~ +#!/bin/sh + +for rc in /usr/local/etc/fetchmail/*.rc; do + instance=${rc%.*} + instance=${instance##*/} + systemctl --no-block start fetchmail@${instance} +done +~~~ + +Now reboot your AppVM and you are done. diff --git a/configuration-guides/gui-configuration.md b/configuration-guides/gui-configuration.md new file mode 100644 index 0000000..ee64552 --- /dev/null +++ b/configuration-guides/gui-configuration.md @@ -0,0 +1,37 @@ +--- +layout: doc +title: GUI Configuration and Troubleshooting +permalink: /doc/gui-configuration/ +--- + +GUI Configuration and Troubleshooting +===================================== + +Video RAM adjustment for high-resolution displays +------------------------------------------------- + +**Problem:** You have a 4K external display, and when you connect it, you can't click on anything but a small area in the upper-right corner. + +When a qube starts, a fixed amount of RAM is allocated to the graphics buffer called video RAM. +This buffer needs to be at least as big as the whole desktop, accounting for all displays that are or will be connected to the machine. +By default, it is as much as needed for the current display and an additional full HD (FHD) display (1920×1080 8 bit/channel RGBA). +This logic fails when the machine has primary display in FHD resolution and, after starting some qubes, a 4K display is connected. +The buffer is too small, and internal desktop resize fails. + +**Solution:** Increase the minimum size of the video RAM buffer. + +```sh +qvm-features dom0 gui-videoram-min $(($WIDTH * $HEIGHT * 4 / 1024)) +qvm-features dom0 gui-videoram-overhead 0 +``` + +Where `$WIDTH`×`$HEIGHT` is the maximum desktop size that you anticipate needing. +For example, if you expect to use a 1080p display and a 4k display side-by-side, that is `(1920 + 3840) × 2160 × 4 / 1024 = 48600`, or slightly more than 48 MiB per qube. +After making these adjustments, the qubes need to be restarted. + +The amount of memory allocated per qube is the maximum of: +- `gui-videoram-min` +- current display + `gui-videoram-overhead` + +Default overhead is about 8 MiB, which is enough for a 1080p display (see above). +So, the `gui-videoram-overhead` zeroing is not strictly necessary; it only avoids allocating memory that will not be used. diff --git a/configuration-guides/multiboot.md b/configuration-guides/multiboot.md new file mode 100644 index 0000000..d33152a --- /dev/null +++ b/configuration-guides/multiboot.md @@ -0,0 +1,214 @@ +--- +layout: doc +title: Multibooting +permalink: /doc/multiboot/ +--- + +Multibooting Qubes +======================================== + +Introduction +--------------------- + +You should think carefully before dual booting Qubes on your box. +Read the [guidelines](/doc/security-guidelines) carefully. + +One problem is that when you dual or multiboot, even if you are using +encryption on your Qubes installation, /boot is still unprotected and +could be maliciously modified by the other OS, possibly leading to Qubes +itself being maliciously modified. + +The other problem is firmware security - for example the other system +could infect BIOS firmware, which might enable compromise or spying on +the Qubes system. + +You can use [Anti Evil Maid](/doc/anti-evil-maid/), which would inform +you if /boot had been modified, but it cannot prevent or fix the problem. + +If you have considered these issues, tried out the live system and want to +install Qubes alongside your existing OS, these notes should help. + +They assume that you are installing Qubes on a PC where you already have +another OS installed. + +The first thing to do is STOP. +Before you do anything else back up all your data. +If possible do a full system backup. +Back up the MBR. +Back up /boot. +If you are really paranoid clone your disc. + +Make sure you have install discs to hand for the existing operating system. + +Qubes by default does not include other systems in the generated grub menu, +because handling of other systems has been disabled. This means +that you will have to manually add grub entries for any other OS. + +The general approach is: + +* Enable legacy boot mode +* Ensure current OS boots in legacy mode. +* Install Qubes +* Manually add boot stanzas to /etc/grub.d/40_custom +* Update grub + + + +Windows +---------------------- + +If you change boot mode to legacy boot almost certainly the Windows +installation will not boot. +You will either have to format the disk and reinitialise it, and then reinstall +Windows in legacy boot mode, or use a utility like Easy Recovery Essentials +which will change the existing installation to be bootable in both +UEFI/GPT and BIOS/MBR mode in-place, without losing any data. + +At this stage you can install Qubes. + +As noted above the default configuration will not add an entry for Windows to +the grub menu, so you will need to add one. + +1. Boot into Qubes. + +2. Identify the Windows system partition that has /bootmgr + + In blkid output, the system partition is the one with LABEL='SYSTEM + RESERVED' or LABEL='SYSTEM' and is only about 100 to 200 MB in size + +3. Add this stanza to /etc/grub.d/40_custom, + +~~~ +menuentry "Windows" { + insmod part_msdos + insmod ntldr + insmod ntfs + ntldr (hd1,X)/bootmgr +} +~~~ + +(Change `X` to reflect the relevant system partition.) + +Then update the grub config: + +~~~ +sudo grub2-mkconfig -o /boot/grub2/grub.cfg +~~~ + +There is no need to reinstall grub itself. + +If the above stanza does not work, you may try this one (at your own risk!) +instead: + +~~~ +menuentry "Windows" { + insmod part_msdos + insmod ntfs + set root='(hd0,msdosX)' + chainloader +1 +} +~~~ + +(Change `X` to reflect the relevant system partition.) + + +Linux +---------------------- + +If you have had to change to legacy boot mode then you may have to reinstall grub in +the existing OS. (Make sure that you use grub rather than a grub-efi version). + +Micah Lee +[suggests](https://micahflee.com/2014/04/dual-booting-qubes-and-ubuntu-with-encrypted-disks/) +installing grub to a partition, and then installing Qubes with grub +installed in MBR. + +If you take this approach then you need to add to /etc/grub.d/40_custom in Qubes +dom0: + +~~~ +menuentry "Other Linux" { +set root=(hd1,X) +chainloader +1 +} +(Change X to reflect the relevant partition where grub is installed.) +~~~ + +Then update the grub config: + +~~~ +sudo grub2-mkconfig -o /boot/grub2/grub.cfg +~~~ + +There is no need to reinstall grub itself. + + +Existing /boot partition, grub installed in MBR +---------------------- + +Most distros will have already installed grub to the MBR. + +It is possible to use the *same* /boot for both OS. +To do this, do **NOT** choose the automatic configuration option when installing +Qubes. +Select 'custom' layout, and assign the existing /boot partition as /boot. +Deselect the 'Format' option. +Then continue with the installation. +This will install the qubes boot files in /boot *alongside* the existing files, +but overwrite the grub.cfg file in /boot/grub2. + +If the other distro uses legacy grub you can simply copy the relevant sections +from /boot/grub/grub.cfg into /etc/grub.d/40_custom. + +If the other distro uses grub2 then copy the relevant sections +from the backup you made into /etc/grub.d/40_custom. + +Then update the grub config: + +~~~ +sudo grub2-mkconfig -o /boot/grub2/grub.cfg +~~~ + + + +Troubleshooting +---------------------- + +If you install Qubes without making any backups beforehand, don't worry. +If you didn't overwrite the original partitions, then it is usually +possible to recover your old systems relatively easily, as described above. + +If you decided to use a shared /boot and *don't* have backups of your previous +grub config, it is quite easy to fix this. +This example may help. + +* Boot into Qubes. +* Back up (at a minimum) /boot/grub2 +* Identify the partition containing the other OS. +* Then mount the other OS and chroot in to it. + +~~~ +sudo mount /dev/sdX /mnt +sudo mount --bind /dev/sdY /mnt/boot +sudo mount --bind /dev /mnt/dev +sudo mount --bind /dev/pts /mnt/dev/pts +sudo mount --bind /proc /mnt/proc +sudo mount --bind /sys /mnt/sys + +sudo chroot /mnt +~~~ + +* Update the grub config: + +~~~ +sudo grub2-mkconfig -o /boot/grub2/grub.cfg.new +~~~ + +* Exit out the chroot, and reverse the mounts. +* Copy the relevant sections from /boot/grub2/grub.cfg.new in to +/etc/grub.d/40_custom. +* Update the grub config: + +~~~ +sudo grub2-mkconfig -o /boot/grub2/grub.cfg +~~~ diff --git a/configuration-guides/multimedia.md b/configuration-guides/multimedia.md new file mode 100644 index 0000000..e4c3cf1 --- /dev/null +++ b/configuration-guides/multimedia.md @@ -0,0 +1,240 @@ +--- +layout: doc +title: How to Make a Multimedia TemplateVM +permalink: /doc/multimedia/ +redirect_from: +- /en/doc/multimedia/ +- /doc/Multimedia/ +- /wiki/Multimedia/ +--- + +How to Make a Multimedia TemplateVM +=================================== + +Note: This Howto has been written and was tested under Qubes 4rc4 + +You can consolidate most of your media streaming tasks into one "multimedia" App-VM. This howto explains how to create a multimedia template which can be used to play multimedia content. +This includes: + +- Spotify +- Amazon Prime +- Netflix +- DVDs + +Installation +------------ + +Start by cloning the default debian template in dom0. +Hint: +t-multimedia is just the template VM where we will install all packages. +In the last step we will create an AppVM from this template. + +`qvm-clone debian-9 t-multimedia` + +Launch a Terminal in the new template VM: + +`qvm-run --auto t-multimedia gnome-terminal` + +Important: +Enter all the following commands in the terminal of the template VM +Become the root user to run all following command without the need to use sudo in the multimedia template VM + +`sudo -i` + +This howto assumes that you have xclip available in the AppVM where you download the Repository Signing keys. +xclip will be used to paste the content of the clipboard to a file. +You can install xclip via: + +`apt-get install xclip` on Debian +`dnf install xclip` on Fedora + +You can of course install xclip just into the AppVM where you download the signing keys to have it available for this howto and it will be deleted if you reboot the AppVM. To have xclip available also after a reboot you need to install it in the Template VM on which your Internet AppVM is based (make sure to reboot the AppVM after you've installed any package in its template) + +Installation of Spotify +----------------------- + +Import GPG-Key for spotify +As the template VM can't connect to internet you need to get the public key file from another AppVM and copy it to the template VM. The easiest way is to use the Qubes Clipboard to copy the keys from the AppVM where you get the key to the Template VM. + +In an AppVM which has Internet access: +- Open +- Copy content of page to the Clipboard (Ctrl+A and Ctrl+C) +- open a Terminal in this AppVM and copy the content of the clipboard to a file + `xclip -o > spotify.pubkey` + +Copy the public signing key over to the multimedia template VM +- copy the file via `qvm-copy-to-vm t-multimedia spotify.pubkey` +- or create a new file on the Template VM and copy the content of the clipboard (the public key) + Copy content of page to the Qubes Clipboard (Ctrl+C and then Shift+Ctrl+C) + Switch to the gnome terminal in the Multimedia Template VM + `nano spotify.pubkey` + Paste the content from the Qubes Clipboard into nano (Shift+Ctrl+V and then Paste) + Save the file (Ctrl+O Ctrl+X) + +Check the signature of the signing key (in the multimedia Template VM). +Hint: depending on your installed version of GnuPG the command to show a public might slightly be different. +See [this StackExchange question](https://unix.stackexchange.com/questions/391344/gnupg-command-to-show-key-info-from-file) for more information. +If this command doesn't show a fingerprint choose one of the other commands mentioned in the above link. + +`gpg --with-fingerprint spotify.pubkey` + +This should look like: + + [user@t-multimedia ~]$ `gpg --with-fingerprint spotify.pubkey` + + pub 4096R/48BF1C90 2018-05-23 Spotify Public Repository Signing Key + + Key fingerprint = 931F F8E7 9F08 7613 4EDD BDCC A87F F9DF 48BF 1C90 + +You can (and should) lookup the fingerprint on at least one (or more) keyservers as the above information might be outdated. + + + +Add the public key to the repository keyring +`apt-key add spotify.pubkey` + +Add the Spotify repository to your list of package sources: + +`echo deb http://repository.spotify.com stable non-free > /etc/apt/sources.list.d/spotify.list` + +Update the list of all known packages + +`apt-get update` + +Install Spotify +`apt-get install -y spotify-client` + +Create a spotify desktop-entry + +`cp -p /usr/share/spotify/spotify.desktop /usr/share/applications/` + +`cp /usr/share/spotify/icons/spotify-linux-16.png /usr/share/icons/hicolor/16x16/apps/spotify.png` + + +Installation of VLC +------------------- + +To play DVDs you can install VLC with the needed Codecs + +Download the public key which signs the VLC package repositories +In an AppVM which has Internet access: +- Open +- Repeat all steps to save the public signing key on the AppVM (see above / Spotify example) + `xclip -o > videolan.pubkey` + +Copy the public signing key over to the multimedia template VM +- copy the file via `qvm-copy-to-vm t-multimedia videolan.pubkey` +- or create a new file on the Template VM and copy the content of the clipboard (the public key) + Copy content of page to the Qubes Clipboard (Ctrl+C and then Shift+Ctrl+C) + Switch to the gnome terminal in the Multimedia Template VM + `nano videolan.pubkey` + Paste the content from the Qubes Clipboard into nano (Shift+Ctrl+V and then Paste) + Save the file (Ctrl+O Ctrl+X) + +Check the signature of the signing key + +`gpg --with-fingerprint videolan.pubkey` + +This should look like: + + [user@t-multimedia ~]$ `gpg --with-fingerprint videolan.pubkey` + + pub 2048R/B84288D9 2013-08-27 VideoLAN APT Signing Key + + Key fingerprint = 8F08 45FE 77B1 6294 429A 7934 6BCA 5E4D B842 88D9 + + sub 2048R/288D4A2C 2013-08-27 + +You can (and should) lookup the fingerprint on at least one (or more) keyservers as the above information might be outdated. + + + +Add the public key to the repository keyring +`apt-key add videolan.pubkey` + +Add the new VLC package repositories to your list of sources + +`echo "deb http://download.videolan.org/pub/debian/stable/ /" > /etc/apt/sources.list.d/vlc.list` + +`echo "deb-src http://download.videolan.org/pub/debian/stable/ /" >> /etc/apt/sources.list.d/vlc.list` + +Update package repositories + +`apt-get update` + +Install libdvdcss and VLC + +`apt-get install -y libdvdcss2 vlc` + + +Installation Google Chrome +-------------------------- + +To play Videos with Netflix, Amazon Prime & Co using Chrome is a good option as it has all needed codecs included. +Hint: Using Chromium will not work for some reasons. + +Download the public key which signs the Google package repositories +In an AppVM which has Internet access: +- Open +- Repeat all steps to save the public signing key on the AppVM (see above / Spotify example) + `xclip -o > google.pubkey` + +Copy the public signing key over to the multimedia template VM +- copy the file via `qvm-copy-to-vm t-multimedia google.pubkey` +- or create a new file on the Template VM and copy the content of the clipboard (the public key) + Copy content of page to the Qubes Clipboard (Ctrl+C and then Shift+Ctrl+C) + Switch to the gnome terminal in the Multimedia Template VM + `nano google.pubkey` + Paste the content from the Qubes Clipboard into nano (Shift+Ctrl+V and then Paste) + Save the file (Ctrl+O Ctrl+X) + +Check the signature of the signing key (still in the AppVM where you downloaded the key) + +`gpg --with-fingerprint google.pubkey` + +This should look like: + + [user@t-multimedia ~]$ `gpg --with-fingerprint google.pubkey` + + pub 4096R/D38B4796 2016-04-12 Google Inc. (Linux Packages Signing Authority) + + + + Key fingerprint = EB4C 1BFD 4F04 2F6D DDCC EC91 7721 F63B D38B 4796 + + sub 4096R/640DB551 2016-04-12 [expires: 2019-04-12] + + sub 4096R/997C215E 2017-01-24 [expires: 2020-01-24] + +You can (and should) lookup the fingerprint on at least one (or more) keyservers as the above information might be outdated. + + + +or + + + +Add the public key to the repository keyring + +`apt-key add google.pubkey` + +Add the Google package repositories to your list of sources + +`echo "deb http://dl.google.com/linux/chrome/deb/ stable main"> /etc/apt/sources.list.d/google.list` + +Update package repositories + +`apt-get update` + +Install Chrome + +`apt-get install google-chrome-stable` + + +Create a Multimedia AppVM +------------------------- + +The last step is to create a multimedia AppVM (named "my-multimedia" here) based on the new multimedia template. + +`qvm-create --template t-multimedia --label orange my-multimedia` + diff --git a/configuration-guides/mutt.md b/configuration-guides/mutt.md new file mode 100644 index 0000000..0ae3f94 --- /dev/null +++ b/configuration-guides/mutt.md @@ -0,0 +1,222 @@ +--- +layout: doc +title: Mutt +permalink: /doc/mutt/ +redirect_from: +- /en/doc/mutt/ +- /doc/Mutt/ +- /wiki/Mutt/ +--- + +Mutt +==== + +Mutt is a fast, standards-compliant, efficient MUA (Mail User Agent). In some areas it works better than Thunderbird+Enigmail, and is certainly faster and more responsive. + +Mutt lacks true MTA (Message Transfer Agent aka "SMTP client") and MRA (Mail +Retrieval Agent aka "IMAP/POP3 client"), thus there are some provisions +built-in. In principle it is only mail reader and composer. You may install +true MTA such as [Postfix](/doc/postfix/) or Exim and MRA such as +[Fetchmail](/doc/fetchmail/). Alternatively you can synchronize your mailbox +using [OfflineIMAP](https://github.com/OfflineIMAP/offlineimap) and just stick +to integrated SMTP support. You can even use integrated IMAP client, but it is +not very convenient. + +Installation +------------ + +`dnf install mutt cyrus-sasl-plain` + +`cyrus-sasl-plain` package is necessary for SMTP authentication to work. + +Configuration +------------- + +Mutt generally works out of the box. This configuration guide discusses only Qubes-specific setup. In this example we will have one TemplateVM and several AppVMs. It also takes advantage of [SplitGPG](/doc/split-gpg/), which is assumed to be already working. + +**NOTE:** this requires `qubes-gpg-split >= 2.0.9`. 2.0.8 and earlier contains bug which causes this setup to hang in specific situations and does not allow to list keys. + +First, paste this to `/etc/Muttrc.local` in TemplateVM: + +~~~ +# specify your key or override in ~/.mutt/muttrc in AppVM +set pgp_sign_as="0xDEADBEEF" + +set pgp_use_gpg_agent = no + +# this needs qubes-gpg-split >= 2.0.8; 2.0.7 end earlier has had a deadlock on this +set pgp_decode_command="qubes-gpg-client-wrapper --status-fd=2 --batch %f" +#set pgp_decode_command="gpg --status-fd=2 %?p?--passphrase-fd=0? --no-verbose --quiet --batch --output - %f" + +set pgp_decrypt_command="$pgp_decode_command" + +set pgp_verify_command="qubes-gpg-client-wrapper --status-fd=2 --no-verbose --quiet --batch --output - --verify %s %f" + +set pgp_sign_command="qubes-gpg-client-wrapper --batch --armor --detach-sign --textmode %?a?-u %a? %f" +set pgp_clearsign_command="qubes-gpg-client-wrapper --batch --armor --textmode --clearsign %?a?-u %a? %f" + +# I found no option to add Charset armor header when it is UTF-8, since this is +# default (as specified in RFC4880). This is needed to workaround bug in +# Enigmail, which ignores RFC and without this header Thunderbird interprets +# plaintext as us-ascii. See https://sourceforge.net/p/enigmail/bugs/38/. + +### also note you must specify absolute path of pgpewrap when using debian +### e.g. /usr/lib/mutt/pgpewrap + +set pgp_encrypt_only_command="pgpewrap qubes-gpg-client-wrapper --batch --textmode --armor --always-trust %?a?--encrypt-to %a? --encrypt -- -r %r -- %f | sed -e '2iCharset: UTF-8'" +set pgp_encrypt_sign_command="pgpewrap qubes-gpg-client-wrapper --batch --textmode --armor --always-trust %?a?--encrypt-to %a? --encrypt --sign %?a?-u %a? -- -r %r -- %f | sed -e '2iCharset: UTF-8'" + +# we need to import both into vault and locally wrt $pgp_verify_command +set pgp_import_command="qubes-gpg-import-key %f; gpg --no-verbose --import %f" + +# those are unsupported by split-gpg +set pgp_export_command="gpg --no-verbose --export --armor %r" +set pgp_verify_key_command="gpg --no-verbose --batch --fingerprint --check-sigs %r" + +# read in the public key ring +set pgp_list_pubring_command="qubes-gpg-client-wrapper --no-verbose --batch --quiet --with-colons --list-keys %r" + +# read in the secret key ring +set pgp_list_secring_command="qubes-gpg-client-wrapper --no-verbose --batch --quiet --with-colons --list-secret-keys %r" + +# this set the number of seconds to keep in memory the passpharse used to encrypt/sign +# the more the less secure it will be +set pgp_timeout=600 + +# it's a regexp used against the GPG output: if it matches some line of the output +# then mutt considers the message a good signed one (ignoring the GPG exit code) +#set pgp_good_sign="^gpg: Good signature from" +set pgp_good_sign="^\\[GNUPG:\\] GOODSIG" + +# mutt uses by default PGP/GPG to sign/encrypt messages +# if you want to use S-mime instead set the smime_is_default variable to yes + +# automatically sign all outcoming messages +set crypt_autosign=yes +# sign only replies to signed messages +#set crypt_replysign + +# automatically encrypt outcoming messages +#set crypt_autoencrypt=yes +# encrypt only replies to signed messages +set crypt_replyencrypt=yes +# encrypt and sign replies to encrypted messages +set crypt_replysignencrypted=yes + +# automatically verify the sign of a message when opened +set crypt_verify_sig=yes + +send-hook "~A" set pgp_autoinline=no crypt_autoencrypt=no +send-hook "~t @invisiblethingslab\.com" set crypt_autoencrypt=yes + +# vim:ft=muttrc +~~~ + +Then shutdown your TemplateVM. Next open your AppVM, create file `/home/user/.mutt/muttrc` and adjust for your needs: + +~~~ +# +# accounts +# +set from = "Wojciech Zygmunt Porczyk " +alternates '^woju@invisiblethingslab\.com$' +alternates '^wojciech@porczyk\.eu$' + +# +# crypto +# +set pgp_sign_as = "0xDEADBEEF" +send-hook "~t @my\.family\.com" set crypt_autoencrypt=no + +# +# lists +# + +# google groups +lists .*@googlegroups\.com + +subscribe (qubes-(users|devel)|othergroup)@googlegroups\.com +fcc-save-hook qubes-users@googlegroups\.com =list/qubes-users/ +fcc-save-hook qubes-devel@googlegroups\.com =list/qubes-devel/ +fcc-save-hook othergroup@googlegroups\.com =list/othergroup/ +~~~ + +You may also create `/home/user/.signature`: + +~~~ +regards, +Wojciech Porczyk +~~~ + +Some additional useful settings +------------------------------- + +In `muttrc`: + + ###qubes integration stuff + + #open links in a dispvm using urlview + #see below for sample .urlview + macro pager \cb 'urlview' 'Follow links with urlview' + + #override default mailcap MIME settings with qvm-open-in-dvm calls + #see sample .mailcap below + set mailcap_path=~/.mailcap + + bind attach view-mailcap + +Debian-specific options: + + #use debian mutt-patched package for mailbox sidebar hack + set sidebar_width = 30 + set sidebar_visible = no + set sidebar_delim='|' + + #show/hide sidebar + macro index S 'toggle sidebar_visible' + macro pager S 'toggle sidebar_visible' + + #navigate the sidebar folders + bind index CP sidebar-prev + bind index CN sidebar-next + bind index CO sidebar-open + bind pager CP sidebar-prev + bind pager CN sidebar-next + + +In `.urlview`: + + ### TODO: this doesn't work with encrypted emails -- + ### urlview can't find the links + ### + COMMAND qvm-open-in-dvm %s + + +In `.mailcap`: + + ### TODO: override most/all default mailcap settings to prevent + ### opening in muttvm + ### is there a way to do this polymorphically? i.e. not + ### listing every damn mimetype by hand + ### + ### also would be convenient to use mailcap's TEST feature to + ### show some html in mutt pager (e.g. with w3m, links or html2text), + ### else open others in dispvm + + # MS Word documents + application/msword; qvm-open-in-dvm %s + + application/vnd.oasis.opendocument.spreadsheet; qvm-open-in-dvm %s + application/vnd.oasis.opendocument.text; qvm-open-in-dvm %s + + # Images + image/jpg; qvm-open-in-dvm %s + image/jpeg; qvm-open-in-dvm %s + image/png; qvm-open-in-dvm %s + image/gif; qvm-open-in-dvm %s + + # PDFs + application/pdf; qvm-open-in-dvm %s + + # HTML + text/html; qvm-open-in-dvm %s diff --git a/configuration-guides/network-bridge-support.md b/configuration-guides/network-bridge-support.md new file mode 100644 index 0000000..822d991 --- /dev/null +++ b/configuration-guides/network-bridge-support.md @@ -0,0 +1,146 @@ +--- +layout: doc +title: Network Bridge Support +permalink: /doc/network-bridge-support/ +redirect_from: +- /en/doc/network-bridge-support/ +- /doc/NetworkBridgeSupport/ +- /wiki/NetworkBridgeSupport/ +--- + +Network Bridge Support (EXPERIMENTAL and UNSUPPORTED) +===================================================== + +The Qubes development team does not support bridging the network interfaces found in NetVM and don't plan to support it at all. Several reasons for that: + +- Using a bridged VM is almost only necessary for developers testing or working on OSI layer 2 or layer 3 tools (MAC or routing protocols). If not for testing, such tools are almost only used directly on routers ...). +- Most of these tools can be anyway used directly inside the NetVM, which has direct access to the network card. +- It is also possible to use a secondary network card plugged into a specific development VM. +- Such a setup could break security features of Qubes such as AppVM firewalling. + +Now if you really want to work with OSI layer2 / layer 3 tools, that you don't have a secondary network card, or that you want to completely expose services of a given AppVM (at your own risk), a bridged setup may help you. + +Qubes manager patch (Qubes R2B2) +-------------------------------- + +The following patches can be applied to the Qubes Manager GUI in order to add an option to easily bridge a VM. Use it at your own risk. If the patch breaks the Qubes Manager, you can try to restore the Qubes packages: + +~~~ +# qubes-dom-update qubes-core-dom0 qubes-manager +# yum reinstall qubes-core-dom0 +# yum reinstall qubes-manager +~~~ + +First, retrieve the attachment of this Wifi article in dom0. Then apply the three patches the following way after installing the patch tool : + +~~~ +# qubes-dom0-update patch +# patch /usr/lib64/python2.7/site-package/qubes/qubes.py < qubes.py-bridge.diff +# patch /usr/lib64/python2.7/site-package/qubesmanager/settings.py < settings.py-bridge.diff +# patch /usr/lib64/python2.7/site-package/qubesmanager/ui_settingsdlg.py < ui_settingsdlg.py-bridge.diff +~~~ + +Finally restart the qubes manager GUI. + +An option is available in the AppVM Settings to enable setting the NetVM in bridge mode. For a bridged AppVM, you should then select a NetVM instead of a FirewallVM/ ProxyVM, enable the Bridge option, and restart your AppVM. + +NetVM patch (Qubes R2B2) +------------------------ + +You need to modify manually the NetVM iptable script inside the NetVM. The reason is that by default the NetVM only accepts traffic coming from network interfaces called vif\* (in our case, we will use an additional interface called bridge0. The second reason is that all traffic is NATed by default. In our case, we want to forward traffic from the bridge interface without modifying it, while NATing traffic coming from vif\* interfaces. + +Modify manually the Template you use for your NetVM (not the NetVM itself). This is by default fedora-x86\_64. Edit the file /etc/sysconfig/iptables. You need to modify two parts of the file. + +- Starting from the line -A POSTROUTING -j MASQUERADE that you need to comment : + + ~~~ + # Bridge support + # Comment the following line + #-A POSTROUTING -j MASQUERADE + # Ensure packets coming from firewallVMs or AppVMs use NAT + -A POSTROUTING -m iprange --src-range 10.137.1.0-10.137.2.255 -j MASQUERADE + # Allow redirection of bridge packets (optional as POSTROUTING default is ACCEPT) + #-A POSTROUTING -o bridge+ -j ACCEPT + # End Bridge support + ~~~ + +- Starting from the line -A FORWARD -i vif+ -j ACCEPT: + + ~~~ + -A FORWARD -i vif+ -o vif+ -j DROP + -A FORWARD -i vif+ -j ACCEPT + # Bridge Support + -A FORWARD -i bridge+ -j ACCEPT + # End Bridge Support + -A FORWARD -j DROP + ~~~ + +Ensure that the IP addresses used by default in Qubes are in the form 10.137.1.\* or 10.137.2.\* by running ifconfig. Of course, this setup won't work with IPv6. + +Now you need to restart the NetVM and FirewallVM or only iptables in both VMs if you prefer: + +~~~ +# systemctl restart iptables +~~~ + +Create a Bridge inside the NetVM +-------------------------------- + +A bridge can be created inside the standard network manager (the network icon in the taskbar). + +This requires: + +- creating a bridge that will be your main IP (ex: setup the bridge with DHCP) +- attach eth0 to your bridge + +Note: A wireless interface cannot be bridged. + +The bridge edition GUI is somewhat buggy as it does not remember all the parameters you set up. You can fix it by editing manually the files in /etc/NetworkManager/system-connections/. Here is one example for these files: + +- Bridge-DHCP + + ~~~ + [connection] + id=Bridge-DHCP + uuid=fd68198b-313a-47cb-9155-52e95cdc67f3 + type=bridge + autoconnect=false + timestamp=1363938302 + + [ipv6] + method=auto + + [ipv4] + method=auto + + [bridge] + interface-name=bridge0 + stp=false + ~~~ + +Note: Do not forget to put stp=false if you bridge only eth0 because sending BPDUs could make your admins angry :) + +- bridge0-eth0 + + ~~~ + [802-3-ethernet] + duplex=full + mac-address=88:AE:1D:AE:30:31 + + [connection] + id=bridge0-eth0 + uuid=38320e5b-226c-409e-9fd6-0fbf4d0460a0 + type=802-3-ethernet + autoconnect=false + timestamp=1363601650 + master=fd68198b-313a-47cb-9155-52e95cdc67f3 + slave-type=bridge + ~~~ + +If you do not manage to start your bridge, you can start it manually from a NetVM terminal: + +~~~ +$ nmcli con up id bridge0-eth0 +~~~ + +Now that the bridge is ready, the bridged AppVM can be started... diff --git a/configuration-guides/network-printer.md b/configuration-guides/network-printer.md new file mode 100644 index 0000000..f5d7ef9 --- /dev/null +++ b/configuration-guides/network-printer.md @@ -0,0 +1,55 @@ +--- +layout: doc +title: Network Printer +permalink: /doc/network-printer/ +redirect_from: +- /en/doc/network-printer/ +- /doc/NetworkPrinter/ +- /wiki/NetworkPrinter/ +--- + +Configuring a network printer for Qubes AppVMs +============================================== + +Where to configure printers and install drivers? +------------------------------------------------ + +One would normally want to configure a printer in a template VM, rather than in particular AppVMs. +This is because all the global settings made to AppVMs (those stored in its /etc, as well as binaries installed in /usr) would be discarded upon AppVM shutdown. +When printer is added and configured in a template VM, then all the AppVMs based on this template should automatically be able to use it (without the need for the template VM to be running, of course). + +Alternatively one can add a printer in a standalone VM, but this would limit the printer usage to this particular VM. + +Security considerations for network printers and drivers +-------------------------------------------------------- + +Some printers require third-party drivers, typically downloadable from the vendor's website. +Such drivers are typically distributed in a form of ready to install RPM packages. +However, they are often unsigned, and additionally the downloads are available via HTTP connections only. +As a result, installation of such third-party RPMs in a default template VM exposes a risk of compromise of this template VM, which, in turn, leads automatically to compromise of all the AppVMs based on the template. +(Again, it's not buggy or malicious drivers that we fear here, but rather malicious installation scripts for those drivers). + +In order to mitigate this risk, one might consider creating a custom template (i.e. clone the original template) and then install the third-party, unverified drivers there. +Such template might then be made a DVM template for [DisposableVM creation](/doc/disposablevm/), which should allow one to print any document by right-clicking on it, choosing "Open in DisposableVM" and print from there. +This would allow to print documents from more trusted AppVMs (based on a trusted default template that is not poisoned by third-party printer drivers). + +However, one should be aware that most (all?) network printing protocols are insecure, unencrypted protocols. +This means, that an attacker who is able to sniff the local network, or who is controlling the (normally untrusted) Qubes NetVM, will likely to be able to see the documents being printed. +This is a limitation of today's printers and printing protocols, something that cannot be solved by Qubes or any other OS. + +Additionally, the printer drivers as well as CUPS application itself, might be buggy and might get exploited when talking to a compromised printer (or by an attacker who controls the local network, or the default NetVM). +Consider not using printing from your more trusted AppVMs for this reason. + +Steps to configure a network printer in a template VM +---------------------------------------------------------- + +1. Start the "Printer Settings" App in a template VM (either via Qubes "Start Menu", or by launching the `system-config-printer` in the template). +2. Add/Configure the printer in the same way as one would do on any normal Linux. + You may need to allow network access from the template VM to your printer to complete configuration, as normally the template VM is not allowed any network access except to the Qubes proxy for software installation. + One can use Qubes Manager to modify firewall rules for particular VMs. +3. Optional: Test the printer by printing a test page. If it works, shut down the template VM. +4. Open an AppVM (make sure it's based on the template where you just installed the printer, normally all AppVMs are based on the default template), and test if printing works. + If it doesn't then probably the AppVM doesn't have networking access to the printer -- in that case adjust the firewall settings for that AppVM in Qubes Manager. + Also, make sure that the AppVM gets restarted after the template was shutdown. +5. Alternatively if you do not want to modify the firewall rules of the template VM (that have security scope) you can simply shut down the template VM without trying to print the test page (which will not work), start or restart an AppVM based on the template and test printing there. + diff --git a/configuration-guides/postfix.md b/configuration-guides/postfix.md new file mode 100644 index 0000000..7a142f3 --- /dev/null +++ b/configuration-guides/postfix.md @@ -0,0 +1,155 @@ +--- +layout: doc +title: Postfix +permalink: /doc/postfix/ +redirect_from: +- /en/doc/postfix/ +- /doc/Postfix/ +- /wiki/Postfix/ +--- + +Postfix +======= + +Postfix is full featured MTA (Message Transfer Agent). Here we will configure it in smarthost mode as part of common [Mutt](/doc/mutt/)+Postfix+[Fetchmail](/doc/fetchmail/) stack. + +Installation +------------ + +`dnf install postfix procmail make cyrus-sasl cyrus-sasl-plain` + +Cyrus-sasl is installed to authenticate to remote servers. Procmail is not strictly necessary, but is useful to sort your incoming mail, for example to put each mailing list in its own directory. Make is also not necessary, but is used to keep Postfix lookup tables. + +You should also check `alternatives` command, to see if it is the default `mta`. It probably is not. You may need to `dnf remove ssmtp` or something + +Configuration +------------- + +In TemplateVM open `/etc/aliases` and add line: + +~~~ +root: user +~~~ + +and run `newaliases`. + +This is the only thing to do in TemplateVM, as MTA configuration is AppVM specific, so we will keep it in `/usr/local` (ie. `/rw/usrlocal`) in each AppVM. + +Now shutdown TemplateVM, start AppVM. Create directory `/usr/local/etc/postfix` and copy `/etc/postfix/master.cf` and `/etc/postfix/postfix-files` there. + +### Makefile + +Postfix keeps its lookup tables in bdb hash databases. They need to be compiled from source files. Postfix admins like to keep track of them by means of `/usr/local/etc/postfix/Makefile`: + +~~~ +all: $(addsuffix .db,$(shell sed -n -e '/^[^#].*hash:\/etc\/postfix/s:.*/::p' main.cf)) + newaliases +clean: + $(RM) *.db +.PHONY: all clean + +%.db: % + /usr/sbin/postmap hash:$< +~~~ + +### Postfix main configuration + +`/usr/local/etc/postfix/main.cf` (`/etc/postfix` is intentional, don't correct it): + +~~~ +mydestination = $myhostname, $myhostname.$mydomain, $myhostname.localdomain, localhost, localhost.$mydomain, localhost.localdomain, $mydomain, localdomain +mynetworks_style = host + +inet_protocols = ipv4 + +smtp_generic_maps = hash:/etc/postfix/generic +local_header_rewrite_clients = + +smtp_sender_dependent_authentication = yes +sender_dependent_relayhost_maps = hash:/etc/postfix/sender_relay +smtp_sasl_auth_enable = yes +smtp_sasl_password_maps = hash:/etc/postfix/saslpass +smtp_sasl_security_options = +smtp_tls_security_level = encrypt +smtp_sasl_mechanism_filter = plain, login +smtpd_relay_restrictions = permit_mynetworks,permit_sasl_authenticated,defer_unauth_destination +smtpd_sender_restrictions = check_sender_access hash:/etc/postfix/sender_access + +home_mailbox = .maildir/ +setgid_group = postdrop +mail_owner = postfix + +html_directory = no +manpage_directory = /usr/share/man +queue_directory = /var/spool/postfix +readme_directory = no + +mailbox_command = /usr/bin/procmail +sendmail_path = /usr/sbin/sendmail +newaliases_path = /usr/bin/newaliases +mailq_path = /usr/bin/mailq +alias_maps = hash:/etc/aliases +~~~ + +### Lookup tables + +`/usr/local/etc/postfix/generic` (put there your primary address): + +~~~ +@localhost your.mail@example.com +~~~ + +`/usr/local/etc/postfix/sender_relay`. This is an important file. Put all your SMTP servers there. Pay attention to port (smtp/submission). Square brackets have their special meaning, they are almost certainly needed. For more info consult Postfix manual. + +~~~ +your.mail@exmaple.com [mail.example.com]:submission +your.other@mail.com [smtp.mail.com]:smtp +~~~ + +`/usr/local/etc/postfix/saslpass`. Here you put passwords to above mentioned servers. It depends on your provider if you need to put whole email as username or just the part before `@`. + +~~~ +[mail.example.com]:submission your.mail:y0urP4ssw0rd +[smtp.mail.com]:smtp your.other@mail.com:supers3cret +~~~ + +`/usr/local/etc/postfix/sender_access`. I use it to nullroute known spam domains. If you do not need it, comment respective line in `main.cf`. + +~~~ +spamdomain1.com DISCARD +spamdomain2.com DISCARD +~~~ + +Now run `make` in `/usr/local/etc/postfix`. It will hopefully compile four above mentioned lookup tables (`generic.db`, `sender_relay.db`, `saslpass.db` and `sender_access`). + +### procmail + +Don't start postfix or fetchmail yet, first create `/home/user/.procmailrc`: + +~~~ +MAILDIR = "${HOME}/.maildir" +ORGMAIL = "${MAILDIR}/" +DEFAULT = "${MAILDIR}/" + +:0 +* ^List-Id:.*qubes-users\.googlegroups\.com +list/qubes-users/ + +:0 +* ^List-Id:.*qubes-devel\.googlegroups\.com +list/qubes-devel/ +~~~ + +Run +--- + +Open `/rw/config/rc.local` and add those two lines (before fetchmail lines, if you have them): + +~~~ +#!/bin/sh + +mount --bind /usr/local/etc/postfix /etc/postfix +systemctl --no-block start postfix +~~~ + +Make sure `/rw/config/rc.local` is executable (i.e., `chmod a+x /rw/config/rc.local`). Reboot your AppVM and you are done. diff --git a/configuration-guides/resize-disk-image.md b/configuration-guides/resize-disk-image.md new file mode 100644 index 0000000..3c6223c --- /dev/null +++ b/configuration-guides/resize-disk-image.md @@ -0,0 +1,76 @@ +--- +layout: doc +title: Resize Disk Image +permalink: /doc/resize-disk-image/ +redirect_from: +- /en/doc/resize-disk-image/ +- /en/doc/resize-root-disk-image/ +- /doc/ResizeDiskImage/ +- /doc/ResizeRootDiskImage/ +- /wiki/ResizeDiskImage/ +- /wiki/ResizeRootDiskImage/ +--- + +Resize Disk Image +----------------- + +There are several disk images which can be easily extended, but pay attention to the overall consumed space of your sparse/thin disk images. +In most cases, the GUI tool Qube Settings (available for every qube from the Start menu, and also in the Qube Manager) will allow you to easily increase maximum disk image size. + +![vm-settings-disk-image.png](/attachment/wiki/DiskSize/vm-settings-disk-image.png) + +In case of standalone qubes and templates, just change the Disk Storage settings above. +In case of template-based qubes, the private storage (the /home directory and user files) can be changed in the qube's own settings, but the system root image is [inherited from the template](/getting-started/#appvms-qubes-and-templatevms), and so it must be changed in the template settings. +If you are increasing the disk image size for Linux-based qubes installed from Qubes OS repositories in Qubes 4.0 or later, changing the settings above is all you need to do - in other cases, you may need to do more, according to instructions below. +See also the OS-specific follow-up instructions below. + +### Resize disk image + +Use either GUI tool Qube Settings (`qubes-vm-settings`) or the CLI tool `qvm-volume`. +Maximum size which can be assigned through Qube Settings is 1048576 MiB - if you need more, use `qvm-volume`: + +~~~ +qvm-volume extend :root +~~~ +OR +~~~ +qvm-volume extend :private +~~~ + +Note: Size is the target size (i.e. 4096MB or 16GB, ...), not the size to add to the existing disk. + +If you have run out of space for software in your Template, you need to increase *root image* of the Template (not private storage!). +**Make sure changes in the Template between reboots don't exceed 10G.** +It is recommended to restart (or start and then shutdown, if it is not running) the template after resizing the root image. + +If you are **not** using Linux in the qube, you will also need to: + +1. Start the template. +2. Resize the filesystem using OS appropriate tools. +3. Verify available space in the template using `df -h` or OS specific tools. +4. Shutdown the template. + +#### Windows 7 + +1. Click Start +2. type "diskmgmt.msc" - this takes you to Disk Management +3. Right-click on your existing volume, select "Extend Volume..." +4. Click through the wizard. + +No reboot required. + +#### FreeBSD + +~~~ +gpart recover ada0 +sysctl kern.geom.debugflags=0x10 +gpart resize -i index ada0 +zpool online -e poolname ada0 +~~~ + +#### Linux + +Qubes will automatically grow the filesystem for you on all AppVMs with Qubes packages installed (which are all AppVMs installed from templates, cloned from templates etc. - if you have not created an empty HVM and installed a Linux distribution in it, without using Qubes repositories, you are almost certainly safe). +Otherwise, you will see that there is unallocated free space at the end of your primary disk. +You can use standard linux tools like `fdisk` and `resize2fs` to make this space available. + diff --git a/configuration-guides/rxvt.md b/configuration-guides/rxvt.md new file mode 100644 index 0000000..aa0c0bb --- /dev/null +++ b/configuration-guides/rxvt.md @@ -0,0 +1,152 @@ +--- +layout: doc +title: Rxvt +permalink: /doc/rxvt/ +redirect_from: +- /en/doc/rxvt/ +- /doc/Rxvt/ +- /wiki/Rxvt/ +--- + +Rxvt +==== + +`rxvt-unicode` is an advanced and efficient vt102 emulator. Here is a quick guide to configuration in both dom0 and guest VM. + +Installation +------------ + +`dnf install rxvt-unicode-256color-ml` will bring both base `rxvt-unicode` and extension. +Let me also recommend excellent Terminus font: `dnf install terminus-fonts`. + +Xresources +---------- + +In TemplateVM create file `/etc/X11/Xresources.urxvt` and paste config below. +`!`-lines are comments and may be left out. +`#`-lines are directives to CPP (C preprocessor) and are necessary. +This shouldn't go to `/etc/X11/Xresources`, because that file is not preprocessed by default. + +~~~ +! CGA colour palette + +!*color0: #000000 +!*color1: #AA0000 +!*color2: #00AA00 +!*color3: #AA5500 +!*color4: #0000AA +!*color5: #AA00AA +!*color6: #00AAAA +!*color7: #AAAAAA +!*color8: #555555 +!*color9: #FF5555 +!*color10: #55FF55 +!*color11: #FFFF55 +!*color12: #5555FF +!*color13: #FF55FF +!*color14: #55FFFF +!*color15: #FFFFFF + +! Qubes' favourite tango palette (improved with cyan) + +#define TANGO_Butter1 #c4a000 +#define TANGO_Butter2 #edd400 +#define TANGO_Butter3 #fce94f +#define TANGO_Orange1 #ce5c00 +#define TANGO_Orange2 #f57900 +#define TANGO_Orange3 #fcaf3e +#define TANGO_Chocolate1 #8f5902 +#define TANGO_Chocolate2 #c17d11 +#define TANGO_Chocolate3 #e9b96e +#define TANGO_Chameleon1 #4e9a06 +#define TANGO_Chameleon2 #73d216 +#define TANGO_Chameleon3 #8ae234 +#define TANGO_SkyBlue1 #204a87 +#define TANGO_SkyBlue2 #3465a4 +#define TANGO_SkyBlue3 #729fcf +#define TANGO_Plum1 #5c3566 +#define TANGO_Plum2 #75507b +#define TANGO_Plum3 #ad7fa8 +#define TANGO_ScarletRed1 #a40000 +#define TANGO_ScarletRed2 #cc0000 +#define TANGO_ScarletRed3 #ef2929 +#define TANGO_Aluminium1 #2e3436 +#define TANGO_Aluminium2 #555753 +#define TANGO_Aluminium3 #888a85 +#define TANGO_Aluminium4 #babdb6 +#define TANGO_Aluminium5 #d3d7cf +#define TANGO_Aluminium6 #eeeeec + +*color0: TANGO_Aluminium1 +*color1: TANGO_ScarletRed2 +*color2: TANGO_Chameleon1 +*color3: TANGO_Chocolate2 +*color4: TANGO_SkyBlue1 +*color5: TANGO_Plum2 +*color6: #06989a +*color7: TANGO_Aluminium4 + +*color8: TANGO_Aluminium3 +*color9: TANGO_ScarletRed3 +*color10: TANGO_Chameleon3 +*color11: TANGO_Butter3 +*color12: TANGO_SkyBlue3 +*color13: TANGO_Plum3 +*color14: #34e2e2 +*color15: TANGO_Aluminium6 + +URxvt.foreground: #E0E0E0 +!URxvt.background: black +!URxvt.cursorColor: rgb:ffff/0000/0000 + +URxvt.cursorColor: TANGO_ScarletRed3 + +!URxvt.font: -*-terminus-*-*-*-*-14-*-*-*-*-*-iso8859-2 +!URxvt.boldFont: -*-terminus-*-*-*-*-14-*-*-*-*-*-iso8859-2 +URxvt.font: xft:Terminus:pixelsize=14:style=Bold +URxvt.boldFont: xft:Terminus:pixelsize=14:style=Bold +URxvt.italicFont: xft:Terminus:pixelsize=14:style=Regular +URxvt.boldItalicFont: xft:Terminus:pixelsize=14:style=Regular +URxvt.scrollBar: False +URxvt.visualBell: False + +! Qubes X11 passthrough does not support those, but in dom0 they are nice. +URxvt.background: rgba:0000/0000/0000/afff +URxvt.depth: 32 +URxvt.urgentOnBell: True + +! TODO: write qubes-rpc to handle printing +URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) + +! selection-to-clipboard violates +! http://standards.freedesktop.org/clipboards-spec/clipboards-latest.txt [1], +! but it does for greater good: urxvt has no other means to move PRIMARY to +! CLIPBOARD, so Qubes' clipboard won't work without it. Also the rationale given +! in [1] has little relevance to advanced terminal emulator, specifically there +! is no need for w32-style intuition and virtually no need to "paste over". +URxvt.perl-ext-common: default,selection-to-clipboard + +! Prevent rxvt from entering Keyboard symbols entry mode whenever you press +! ctrl+shift, e.g. to copy or paste something to/from Qubes' clipboard. +URxvt.iso14755_52: false + +URxvt.insecure: False + +! some termcap-aware software sometimes throw '$TERM too long' +!URxvt.termName: rxvt-256color +~~~ + +Then create script to automatically merge those to xrdb. +File `/etc/X11/xinit/xinitrc.d/urxvt.sh`: + +~~~ +#!/bin/sh + +[ -r /etc/X11/Xresources.urxvt ] && xrdb -merge /etc/X11/Xresources.urxvt +~~~ + +Shortcuts +--------- + +For each AppVM, go to *Qubes Manager \> VM Settings \> Applications*. +Find `rxvt-unicode` (or `rxvt-unicode (256-color) multi-language`) and add. diff --git a/configuration-guides/tips-and-tricks.md b/configuration-guides/tips-and-tricks.md new file mode 100644 index 0000000..f341998 --- /dev/null +++ b/configuration-guides/tips-and-tricks.md @@ -0,0 +1,62 @@ +--- +layout: doc +title: Tips and Tricks +permalink: /doc/tips-and-tricks/ +--- + +Tips and Tricks +=============== +This section provides user suggested tips that aim to increase Qubes OS usability, security or that allow users to discover new ways to use your computer that are unique to Qubes OS. + +Opening links in your preferred AppVM +------------------------------------- +To increase both security and usability you can set an AppVM so that it automatically opens any link in an different AppVM of your choice. You can do this for example in the email AppVM, in this way you avoid to make mistakes like opening links in it. To learn more you can check [security guidelines](/doc/security-guidelines/) and [security goals](/security/goals/). + +The command `qvm-open-in-vm` lets you open a document or a URL in another VM. It takes two parameters: vmname and filename. + +For example, if you launch this command from your email AppVM: + +`qvm-open-in-vm untrusted https://duckduckgo.com` + +it will open duckduckgo.com in the `untrusted` AppVM (after you confirmed the request). + +If you want this to happen automatically you can create a .desktop file that advertises itself as a handler for http/https links, and then set this as your default browser. + +Open a text editor and copy and paste this into it: + + [Desktop Entry] + Encoding=UTF-8 + Name=BrowserVM + Exec=qvm-open-in-vm APPVMNAME %u + Terminal=false + X-MultipleArgs=false + Type=Application + Categories=Network;WebBrowser; + MimeType=x-scheme-handler/unknown;x-scheme-handler/about;text/html;text/xml;application/xhtml+xml;application/xml;application/vnd.mozilla.xul+xml;application/rss+xml;application/rdf+xml;image/gif;image/jpeg;image/png;x-scheme-handler/http;x-scheme-handler/https; + +Replace `APPVMNAME` with the AppVM name you want to open links in. Now save, in the AppVM that you want to modify, this file to `~/.local/share/applications/browser_vm.desktop` + +Finally, set it as your default browser: + +`xdg-settings set default-web-browser browser_vm.desktop` + +Credit: [Micah Lee](https://micahflee.com/2016/06/qubes-tip-opening-links-in-your-preferred-appvm/) + +Preventing data leaks +--------------------- +First make sure to read [Understanding and Preventing Data Leaks](/doc/data-leaks/) section to understand the limits of this tip. + +Suppose that you have within a not so trusted environment - for example, a Windows VM - an application that tracks and reports its usage, or you simply want to protect your data. + +Start the Windows TemplateVM (which has no user data), install/upgrade apps; then start Windows AppVM (with data) in offline mode. So, if you worry (hypothetically) that your Windows or app updater might want to send your data away, this Qubes OS trick will prevent this. +This applies also to any TemplateBasedVM relative to its parent TemplateVM, but the privacy risk is especially high in the case of Windows. + +Credit: [Joanna Rutkovska](https://twitter.com/rootkovska/status/832571372085850112) + + +Trim for standalone AppVMs +--------------------- +The `qvm-trim-template` command is not available for a standalone AppVM. + +It is still possible to trim the AppVM disks by using the `fstrim --all` command from the appvm. +You can also add the `discard` option to the mount line in `/etc/fstab` inside the standalone AppVM if you want trimming to be performed automatically, but there may be a performance impact on writes and deletes. diff --git a/configuration-guides/vpn.md b/configuration-guides/vpn.md new file mode 100644 index 0000000..7d2d63e --- /dev/null +++ b/configuration-guides/vpn.md @@ -0,0 +1,324 @@ +--- +layout: doc +title: VPN +permalink: /doc/vpn/ +redirect_from: +- /doc/privacy/vpn/ +- /en/doc/vpn/ +- /doc/VPN/ +- /wiki/VPN/ +--- + +How To make a VPN Gateway in Qubes +================================== + +Although setting up a VPN connection is not by itself Qubes specific, Qubes includes a number of tools that can make the client-side setup of your VPN more versatile and secure. This document is a Qubes-specific outline for choosing the type of VM to use, and shows how to prepare a ProxyVM for either NetworkManager or a set of fail-safe VPN scripts. + +Please refer to your guest OS and VPN service documentation when considering the specific steps and parameters for your connection(s); The relevant documentation for the Qubes default guest OS (Fedora) is [Establishing a VPN Connection.](https://docs.fedoraproject.org/en-US/Fedora/23/html/Networking_Guide/sec-Establishing_a_VPN_Connection.html) + +### NetVM + +The simplest case is to set up a VPN connection using the NetworkManager service inside your NetVM. Because the NetworkManager service is already started, you are ready to set up your VPN connection. However this has some disadvantages: + +- You have to place (and probably save) your VPN credentials inside the NetVM, which is directly connected to the outside world +- All your AppVMs which are connected to the NetVM will be connected to the VPN (by default) + +### AppVM + +While the NetworkManager service is not started here (for a good reason), you can configure any kind of VPN client in your AppVM as well. However this is only suggested if your VPN client has special requirements. + +### ProxyVM + +One of the best unique features of Qubes OS is its special type of VM called a ProxyVM. The special thing is that your AppVMs see this as a NetVM (or uplink), and your NetVMs see it as a downstream AppVM. Because of this, you can place a ProxyVM between your AppVMs and your NetVM. This is how the default sys-firewall VM functions. + +Using a ProxyVM to set up a VPN client gives you the ability to: + +- Separate your VPN credentials from your NetVM. +- Separate your VPN credentials from your AppVM data. +- Easily control which of your AppVMs are connected to your VPN by simply setting it as a NetVM of the desired AppVM. + +Set up a ProxyVM as a VPN gateway using NetworkManager +------------------------------------------------------ + +1. Create a new VM, name it, click the ProxyVM radio button, and choose a color and template. + + ![Create\_New\_VM.png](/attachment/wiki/VPN/Create_New_VM.png) + +2. Add the `network-manager` service to this new VM. + + ![Settings-services.png](/attachment/wiki/VPN/Settings-services.png) + +3. Set up your VPN as described in the NetworkManager documentation linked above. + +4. (Optional) Make your VPN start automatically. + + Edit `/rw/config/rc.local` and add these lines: + + ```bash + # Automatically connect to the VPN once Internet is up + while ! ping -c 1 -W 1 1.1.1.1; do + sleep 1 + done + PWDFILE="/rw/config/NM-system-connections/secrets/passwd-file.txt" + nmcli connection up file-vpn-conn passwd-file $PWDFILE + ``` + You can find the actual "file-vpn-conn" in `/rw/config/NM-system-connections/`. + + Create directory `/rw/config/NM-system-connections/secrets/` (You can put your `*.crt` and `*.pem` files here too). + Create a new file `/rw/config/NM-system-connections/secrets/passwd-file.txt`: + ``` + vpn.secrets.password:XXXXXXXXXXXXXX + ``` + And substitute "XXXXXXXXXXXXXX" for the actual password. + The contents of `passwd-file.txt` may differ depending on your VPN settings. See the [documentation for `nmcli up`](https://www.mankier.com/1/nmcli#up). + +5. (Optional) Make the network fail-close for the AppVMs if the connection to the VPN breaks. + + Edit `/rw/config/qubes-firewall-user-script` and add these lines: + ```bash + # Block forwarding of connections through upstream network device + # (in case the vpn tunnel breaks) + iptables -I FORWARD -o eth0 -j DROP + iptables -I FORWARD -i eth0 -j DROP + ip6tables -I FORWARD -o eth0 -j DROP + ip6tables -I FORWARD -i eth0 -j DROP + ``` + +6. Configure your AppVMs to use the new VM as a NetVM. + + ![Settings-NetVM.png](/attachment/wiki/VPN/Settings-NetVM.png) + +7. Optionally, you can install some [custom icons](https://github.com/Zrubi/qubes-artwork-proxy-vpn) for your VPN + + +Set up a ProxyVM as a VPN gateway using iptables and CLI scripts +---------------------------------------------------------------- + +This method is more involved than the one above, but has anti-leak features that also make the connection _fail closed_ should it be interrupted. +It has been tested with Fedora 23 and Debian 8 templates. + +1. Create a new VM, name it, click the ProxyVM radio button, and choose a color and template. + + ![Create\_New\_VM.png](/attachment/wiki/VPN/Create_New_VM.png) + + Note: Do not enable NetworkManager in the ProxyVM, as it can interfere with the scripts' DNS features. + If you enabled NetworkManager or used other methods in a previous attempt, do not re-use the old ProxyVM... + Create a new one according to this step. + + If your choice of TemplateVM doesn't already have the VPN client software, you'll need to install the software in the template before proceeding. + Disable any auto-starting service that comes with the software package. + For example for OpenVPN. + + sudo systemctl disable openvpn.service + + You may also wish to install `nano` or another simple text editor for entering the scripts below. + +2. Set up and test the VPN client. + Make sure the VPN VM and its TemplateVM is not running. + Run a terminal (CLI) in the VPN VM -- this will start the VM. + Then create a new `/rw/config/vpn` folder with. + + sudo mkdir /rw/config/vpn + + Copy your VPN config files to `/rw/config/vpn`. + Your VPN config file should be named `openvpn-client.ovpn`) so you can use the scripts below as is without modification. + Otherwise you would have to replace the file name. + `openvpn-client.ovpn` contents: + + * Files accompanying the main config such as `*.crt` and `*.pem` should also go to `/rw/config/vpn` folder. + * Files referenced in `openvpn-client.ovpn` should not use absolute paths such as `/etc/...`. + + The VPN scripts here are intended to work with commonly used `tun` interfaces, whereas `tap` mode is untested. + Also, the config should route all traffic through your VPN's interface after a connection is created; For OpenVPN the directive for this is `redirect-gateway def1`. + + sudo nano /rw/config/vpn/openvpn-client.ovpn + + Make sure it already includes or add: + + redirect-gateway def1 + + The VPN client may not be able to prompt you for credentials when connecting to the server. + Create a file in the `/rw/config/vpn` folder with your credentials and using a directive. + For example for OpenVPN, add: + + auth-user-pass pass.txt + + Save file `/rw/config/vpn/openvpn-client.ovpn`. + Make sure a `/rw/config/vpn/pass.txt` file actually exists. + + sudo nano /rw/config/vpn/pass.txt + + Add: + + username + password + + Replace `username` and `password` with your actual username and password. + + **Test your client configuration:** + Run the client from a CLI prompt in the 'vpn' folder, preferably as root. + For example: + + sudo openvpn --cd /rw/config/vpn --config openvpn-client.ovpn + + Watch for status messages that indicate whether the connection is successful and test from another VPN VM terminal window with `ping`. + + ping 8.8.8.8 + + `ping` can be aborted by pressing the two keys `ctrl` + `c` at the same time. + DNS may be tested at this point by replacing addresses in `/etc/resolv.conf` with ones appropriate for your VPN (although this file will not be used when setup is complete). + Diagnose any connection problems using resources such as client documentation and help from your VPN service provider. + Proceed to the next step when you're sure the basic VPN connection is working. + +3. Create the DNS-handling script. + + sudo nano /rw/config/vpn/qubes-vpn-handler.sh + + Edit and add: + + ~~~ + #!/bin/bash + set -e + export PATH="$PATH:/usr/sbin:/sbin" + + case "$1" in + + up) + # To override DHCP DNS, assign DNS addresses to 'vpn_dns' env variable before calling this script; + # Format is 'X.X.X.X Y.Y.Y.Y [...]' + if [[ -z "$vpn_dns" ]] ; then + # Parses DHCP foreign_option_* vars to automatically set DNS address translation: + for optionname in ${!foreign_option_*} ; do + option="${!optionname}" + unset fops; fops=($option) + if [ ${fops[1]} == "DNS" ] ; then vpn_dns="$vpn_dns ${fops[2]}" ; fi + done + fi + + iptables -t nat -F PR-QBS + if [[ -n "$vpn_dns" ]] ; then + # Set DNS address translation in firewall: + for addr in $vpn_dns; do + iptables -t nat -A PR-QBS -i vif+ -p udp --dport 53 -j DNAT --to $addr + iptables -t nat -A PR-QBS -i vif+ -p tcp --dport 53 -j DNAT --to $addr + done + su - -c 'notify-send "$(hostname): LINK IS UP." --icon=network-idle' user + else + su - -c 'notify-send "$(hostname): LINK UP, NO DNS!" --icon=dialog-error' user + fi + + ;; + down) + su - -c 'notify-send "$(hostname): LINK IS DOWN !" --icon=dialog-error' user + ;; + esac + ~~~ + + Save the script. + Make it executable. + + sudo chmod +x /rw/config/vpn/qubes-vpn-handler.sh + +4. Configure client to use the DNS handling script. Using openvpn as an example, edit the config. + + sudo nano /rw/config/vpn/openvpn-client.ovpn + + Add the following. + + script-security 2 + up 'qubes-vpn-handler.sh up' + down 'qubes-vpn-handler.sh down' + + Remove other instances of lines starting with `script-security`, `up` or `down` should there be any others. + Save the script. + **Restart the client and test the connection again** ...this time from an AppVM! + +5. Set up iptables anti-leak rules. + Edit the firewall script. + + sudo nano /rw/config/qubes-firewall-user-script + + Clear out the existing lines and add: + + ~~~ + #!/bin/bash + # Block forwarding of connections through upstream network device + # (in case the vpn tunnel breaks): + iptables -I FORWARD -o eth0 -j DROP + iptables -I FORWARD -i eth0 -j DROP + ip6tables -I FORWARD -o eth0 -j DROP + ip6tables -I FORWARD -i eth0 -j DROP + + # Block all outgoing traffic + iptables -P OUTPUT DROP + iptables -F OUTPUT + iptables -I OUTPUT -o lo -j ACCEPT + + # Add the `qvpn` group to system, if it doesn't already exist + if ! grep -q "^qvpn:" /etc/group ; then + groupadd -rf qvpn + sync + fi + sleep 2s + + # Allow traffic from the `qvpn` group to the uplink interface (eth0); + # Our VPN client will run with group `qvpn`. + iptables -I OUTPUT -p all -o eth0 -m owner --gid-owner qvpn -j ACCEPT + ~~~ + + Save the script. + Make it executable. + + sudo chmod +x /rw/config/qubes-firewall-user-script + +5. Set up the VPN's autostart. + + sudo nano /rw/config/rc.local + + Clear out the existing lines and add: + + ~~~ + #!/bin/bash + VPN_CLIENT='openvpn' + VPN_OPTIONS='--cd /rw/config/vpn/ --config openvpn-client.ovpn --daemon' + + su - -c 'notify-send "$(hostname): Starting $VPN_CLIENT..." --icon=network-idle' user + groupadd -rf qvpn ; sleep 2s + sg qvpn -c "$VPN_CLIENT $VPN_OPTIONS" + ~~~ + + If you are using anything other than OpenVPN, change the `VPN_CLIENT` and `VPN_OPTIONS` variables to match your VPN software. + Save the script. + Make it executable. + + sudo chmod +x /rw/config/rc.local + +6. Restart the new VM! + The link should then be established automatically with a popup notification to that effect. + + +Usage +----- + +Configure your AppVMs to use the VPN VM as a NetVM... + +![Settings-NetVM.png](/attachment/wiki/VPN/Settings-NetVM.png) + +If you want to be able to use the [Qubes firewall](/doc/firewall), create a new FirewallVM (as a ProxyVM) and set it to use the VPN VM as its NetVM. +Then, configure AppVMs to use your new FirewallVM as their NetVM. + +If you want to update your TemplateVMs through the VPN, enable the `qubes-updates-proxy` service in your new FirewallVM. +You can do this in the Services tab in Qubes VM Manager or on the command-line: + + qvm-service -e qubes-updates-proxy + +Then, configure your templates to use your new FirewallVM as their NetVM. + + +Troubleshooting +--------------- + +* Always test your basic VPN connection before adding scripts. +* Test DNS: Ping a familiar domain name from an appVM. It should print the IP address for the domain. +* For scripting: Ping external IP addresses from inside the VPN VM using `sudo sg qvpn -c 'ping ...'`, then from an appVM using just `ping ...`. Once the firewall rules are in place, you will have to use `sudo sg` to run any IP network commands in the VPN VM. +* Use `iptables -L -v` and `iptables -L -v -t nat` to check firewall rules. The latter shows the critical PR-QBS chain that enables DNS forwarding. diff --git a/configuration-guides/w3m.md b/configuration-guides/w3m.md new file mode 100644 index 0000000..5511adb --- /dev/null +++ b/configuration-guides/w3m.md @@ -0,0 +1,40 @@ +--- +layout: doc +title: Reducing the fingerprint of the text-based web browser w3m +permalink: /doc/w3m/ +redirect_from: +- /en/doc/mutt/ +- /doc/W3m/ +- /wiki/W3m/ +--- + +Reducing the fingerprint of the text-based web browser w3m +==== + +TL;DR: You can reduce the amount of information w3m gives about itself and the environment it is running in (and, by extension, you). **It will not make you anonymous; your fingerprint will still be unique.** But it may improve your privacy. + +[w3m](http://w3m.sourceforge.net/) 'is a text-based web browser as well as a pager like `more` or `less`. With w3m you can browse web pages through a terminal emulator window (xterm, rxvt or something like that). Moreover, w3m can be used as a text formatting tool which typesets HTML into plain text.' + +You can reduce the [browser fingerprint](https://panopticlick.eff.org/about#browser-fingerprinting) by applying the following changes to `~/.w3m/config` in any AppVM you want to use w3m in. (If you have not run w3m yet, you might need to copy the config file from elsewhere.) You can also apply the same changes to `/etc/w3m/config` in the relevant TemplateVM(s) to have them apply to multiple AppVMs; but make sure they are not reversed by the contents of `~/.w3m/config` in any of the AppVMs. (w3m reads `~/.w3m/config` after `/etc/w3m/config`). + +* Set `user_agent` to `user_agent Mozilla/5.0 (Windows NT 6.1; rv:45.0) Gecko/20100101 Firefox/45.0`. + + By default w3m identifies itself as `w3m/` + version number. The user agent `Mozilla/5.0 (Windows NT 6.1; rv:45.0) Gecko/20100101 Firefox/45.0` is the most common and the one used by the Tor Browser Bundle (TBB). One in fourteen browsers fingerprinted by Panopticlick has this value. + +* Make w3m use the same HTTP_ACCEPT headers the TBB by adding the following lines at the end of the file: + + accept_language en-US,en;q=0.5 + accept_encoding gzip, deflate + accept_media text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + + These changes will hide your computer's locale and some other information that may or may not be unique to the VM in which it is running. With the modifications above w3m will have the same headers as about one in fifteen browsers fingerprinted by Panopticlick. + +Testing these settings on returns a fingerprint that is distinguishable from that of the TBB (with JavaScript disabled) only by 'Screen Size (CSS)' and 'Browser supports HSTS?'.\* ( does not work with w3m.) Due to the low number of w3m users it is highly likely that you will have an unique browser fingerprint among the visitors of a website using somewhat sophisticated browser fingerprinting technology. But at least your browser fingerprint will not reveal your computer's locale settings or other specifics about it in the HTTP_ACCEPT headers. And while it may be inferred from your fingerprint that you use w3m, it is not be explicitly stated in the User-Agent header. + +**Reminder: Do not rely on these settings for anonymity. Using w3m is all but guaranteed to make you stand out in the crowd.** + +PS: You still need to delete cookies manually (`~/.w3m/cookie`) if you are not running w3m in a DispVM anyway. If you set w3m to not accept cookies, its fingerprint will change. (You can configure w3m to not use store cookies or accept new ones (or both), but the setting `use_cookie` seems to really mean `accept_cookie` and vice-versa, so maybe it is best to delete them manually for now.) + +* * * + +\* Does someone know how to fix this? diff --git a/configuration-guides/zfs.md b/configuration-guides/zfs.md new file mode 100644 index 0000000..931d459 --- /dev/null +++ b/configuration-guides/zfs.md @@ -0,0 +1,197 @@ +--- +layout: doc +title: ZFS +permalink: /doc/zfs/ +redirect_from: +- /en/doc/zfs/ +- /doc/ZFS/ +- /wiki/ZFS/ +--- + +ZFS in Qubes +============ + +**Use at your own risk**! + +Beware: Dragons might eat your precious data! + +Install ZFS in Dom0 +=================== + +Install DKMS style packages for Fedora (defunct in 0.6.2 due to spl/issues/284) +---------------------------------------------------------------------------------------------------- + +Fetch and install repository for DKMS style packages for your Dom0 Fedora version [http://zfsonlinux.org/fedora.html](http://zfsonlinux.org/fedora.html): + +~~~ +disp1# wget http://archive.zfsonlinux.org/fedora/zfs-release-1-1$(rpm -E %dist).noarch.rpm +dom0# qvm-run --pass-io disp1 'cat /home/user/zfs-release-1-1.fc18.noarch.rpm' > /home/user/zfs-release-1-1.fc18.noarch.rpm +dom0# sudo yum localinstall /home/user/zfs-release-1-1.fc18.noarch.rpm +dom0# sudo sed -i 's/$releasever/18/g' /etc/yum.repo.d/zfs.repo +dom0# sudo qubes-dom0-update @development-tools +dom0# sudo qubes-dom0-update zfs +~~~ + +Install DKMS style packages from git-repository +----------------------------------------------- + +Build and install your DKMS or KMOD packages as described in [http://zfsonlinux.org/generic-rpm.html](http://zfsonlinux.org/generic-rpm.html). + +### Prerequisites steps in AppVM (i.e. disp1) + +Checkout repositories for SPL and ZFS: + +~~~ +mkdir ~/repositories && cd ~/repositories +git clone https://github.com/zfsonlinux/spl.git +git clone https://github.com/zfsonlinux/zfs.git +~~~ + +Revert changes in SPL repository due to this bug: [https://github.com/zfsonlinux/spl/issues/284](https://github.com/zfsonlinux/spl/issues/284) + +~~~ +cd ~/repositories/spl +git config --global user.email "user@example.com" +git config --global user.name "user" +git revert e3c4d44886a8564e84aa697477b0e37211d634cd +~~~ + +### Installation steps in Dom0 + +Copy repositories over to Dom0: + +~~~ +mkdir ~/repositories +qvm-run --pass-io disp1 'tar -cf - -C ~/repositories/ {spl,zfs}' | tar -xpf - -C ~/repositories/ +~~~ + +Installing build requirements for SPL and ZFS DKMS modules: + +~~~ +sudo qubes-dom0-update dkms kernel-devel zlib-devel libuuid-devel libblkid-devel lsscsi bc autoconf automake binutils bison flex gcc gcc-c++ gdb gettext libtool make pkgconfig redhat-rpm-config rpm-build strace +~~~ + +Configure and build SPL DKMS packages: + +~~~ +cd ~/repositories/spl +./autogen.sh +./configure --with-config=user +make rpm-utils rpm-dkms +~~~ + +Configure and build ZFS DKMS packages: + +~~~ +cd ~/repositories/zfs +./autogen.sh +./configure --with-config=user +make rpm-utils rpm-dkms +~~~ + +Install SPL and ZFS packages (i.e. version 0.6.2): + +~~~ +sudo yum localinstall \ + ~/repositories/spl/spl-0.6.2-1.qbs2.x86_64.rpm \ + ~/repositories/spl/spl-dkms-0.6.2-1.qbs2.noarch.rpm \ + ~/repositories/zfs/zfs-0.6.2-1.qbs2.x86_64.rpm \ + ~/repositories/zfs/zfs-dkms-0.6.2-1.qbs2.noarch.rpm \ + ~/repositories/zfs/zfs-dracut-0.6.2-1.qbs2.x86_64.rpm \ + ~/repositories/zfs/zfs-test-0.6.2-1.qbs2.x86_64.rpm +~~~ + +Configure ZFS +============= + +Automatically load modules +-------------------------- + +/etc/sysconfig/modules/zfs.modules + +~~~ +#!/bin/sh + +for module in spl zfs; do + modprobe ${module} >/dev/null 2>&1 +done +~~~ + +Make this file executable. + +Tuning +------ + +Tame the memory-eating dragon (i.e. 512 Mb zfs\_arc\_max): + +/etc/modprobe.d/zfs.conf + +~~~ +options zfs zfs_arc_max=536870912 +~~~ + +Setup a zpool with ZFS datasets +------------------------------- + +You can create a ZFS dataset for each AppVM, ServiceVM, HVM or TemplateVM or just use a pool as your backup location. + +Move your existing directory to a temporary location, or the ZFS mount will overlay your directory. + +Beware: VMs on a ZFS dataset aren't working, if your ZFS installation deserts you. + +So keep netvm, firewallvm and your templates on your root file-system (preferably on a SSD). + +~~~ +zpool create -m none -o ashift=12 -O atime=off -O compression=lz4 qubes mirror /dev/mapper/ /dev/mapper/ +zfs create -p qubes/appvms +zfs create -m /var/lib/qubes/backup-zfs qubes/backup +zfs create -m /var/lib/qubes/appvms/banking qubes/appvms/banking +zfs create -m /var/lib/qubes/appvms/personal qubes/appvms/personal +zfs create -m /var/lib/qubes/appvms/untrusted qubes/appvms/untrusted +zfs create -m /var/lib/qubes/appvms/work qubes/appvms/work +~~~ + +Have fun with zpool and zfs. + +Tips and Hints +============== + +Backup your data +---------------- + +You're depending on an huge amount of code for this file system, keep this in mind and backup your precious data. + +Encrypt underlying devices +-------------------------- + +~~~ +dom0# cryptsetup -c aes-xts-plain64 luksFormat +dom0# cryptsetup luksOpen +~~~ + +With the use of cryptsetup a keyfile can be specified to decrypt devices. + +~~~ +dom0# head -c 256 /dev/random > /root/keyfile1 +dom0# chmod 0400 /root/keyfile1 +dom0# cryptsetup luksAddKey /root/keyfile1 +~~~ + +Decrypt devices on boot +----------------------- + +Add your devices to /etc/crypttab. + +~~~ + + none +~~~ + +Specifying a keyfile is especially useful, if ZFS should be ready during boot. + +Further Reading +--------------- + +- [http://www.open-zfs.org](http://www.open-zfs.org) +- [http://zfsonlinux.org](http://zfsonlinux.org) + diff --git a/customization-guides/awesome.md b/customization-guides/awesome.md new file mode 100644 index 0000000..4f95505 --- /dev/null +++ b/customization-guides/awesome.md @@ -0,0 +1,187 @@ +--- +layout: doc +title: awesome +permalink: /doc/awesome/ +redirect_from: +- /en/doc/awesome/ +- /doc/awesome/ +--- + +# Using awesome in dom0 + +## Qubes-specific features + +* support for the Qubes OS window colors +* rudimentary support for the Qubes application menu entries following the freedesktop standard +* support for custom filters and menu entries + +## Installation + +awesome can be installed with the standard dom0 installation mechanisms. + + $ sudo qubes-dom0-update awesome + +That's it. After logging out, you can select awesome in the login manager. + +## Development + +To [contribute code](/doc/contributing/) you may clone the awesome repository as follows: + + $ git clone https://github.com/QubesOS/qubes-desktop-linux-awesome + +For build instructions please check the repository _README_. + +The repository attempts to follow the upstream Fedora repository. + +## Common customizations + +This section focuses on Qubes-specific customizations. For generic awesome customizations you might want to have a look at the [awesome website](https://awesomewm.org). + +Customizations for awesome are usually done at `~/.config/awesome/rc.lua`. The default file can be found at `/etc/xdg/awesome/rc.lua`. + +### Application menu + +Starting from Qubes 4.0 application menu entries specific to awesome can be put into `~/.config/awesome/xdg-menu/` following the freedesktop standard. The folder might have to be created. + +### Focus steal hardening + +The default Qubes OS awesome installation comes with the defaults set by the awesome developers for focus changes. Some users may want more tight control over window focus changes - especially since focus changes can have security implications when sensitive data is provided to an incorrect application or even qube. + +#### Definition + +For the below example we'll define _wanted focus changes_ as one of the below: + +* mouse move & click afterwards +* workspace/tag change +* pre-defined key combinations for focus changes (e.g. Mod-j & Mod-k) +* tag assignments and unassignments + +Everything else is considered an unwanted _focus steal_. + +In particular the following events are not meant to cause a focus change: + +* new window created +* a window was closed +* application request +* mouse move without click (sloppy focus) + +For the below example other requests from applications to the window manager are meant to be ignored in general as well, e.g.: +* windows shouldn't be able to maximize themselves without the user giving a respective command to the WM (simple test: Firefox F11 next to another window) +* windows shouldn't be able to change their size themselves +* windows shouldn't be able to modify their borders in any way + +Users may want to adjust their definitions and respective implementations according to their needs. + +#### Implementation + +The implementation may be specific to the awesome version you're running. This guide refers to awesome version 3.5.9 which is available to Qubes 4.0 users. + +Please keep in mind that this guide may not be conclusive. Your mileage may vary. + +##### Change the autofocus implementation + +The line `require("awful.autofocus")` in your _rc.lua_ implements various focus-related features for your awesome instance. + +In order to customise these, you can copy the file `/usr/share/awesome/lib/awful/autofocus.lua` to e.g. `~/.config/awesome/autofocus_custom.lua` and replace the line above with `require("autofocus_custom")`. + +Then you can customise the focus behavior. According to our above definitions it would look as follows: + +```lua +---autofocus_custom.lua +local client = client +local screen = screen +local aclient = require("awful.client") +local atag = require("awful.tag") + +--- When loaded, this module makes sure that there's always a client that will have focus +-- on events such as tag switching, client unmanaging, etc. +-- awful.autofocus + +-- Give focus when clients appear/disappear and no one else has focus. +-- @param obj An object that should have a .screen property. +function check_focus(obj) + -- When no visible client has the focus... + if not client.focus or not client.focus:isvisible() then + local c = aclient.focus.history.get(obj.screen, 0) + if c then client.focus = c end + end +end + +-- Give focus on tag selection change. +-- @param tag A tag object +function check_focus_tag(t) + local s = atag.getscreen(t) + if not s then return end + check_focus({ screen = s }) + if client.focus and client.focus.screen ~= s then + local c = aclient.focus.history.get(s, 0) + if c then client.focus = c end + end +end + +--made above functions global & removed some focus switches below (user interaction required instead) + +--clear any focus +function clear_focus() + --unfortunately this doesn't work at the moment + --cf. https://github.com/awesomeWM/awesome/issues/164 + --(Qubes uses an older awesome version that doesn't have the fix yet) + --client.focus = nil +end + +atag.attached_connect_signal(nil, "property::selected", check_focus_tag) +client.connect_signal("unmanage", clear_focus) +client.connect_signal("tagged", check_focus) +client.connect_signal("untagged", check_focus) +client.connect_signal("property::hidden", clear_focus) +client.connect_signal("property::minimized", clear_focus) +``` + +##### Remove unwanted focus changing key bindings + +The mouse bindings + +```lua +awful.button({ }, 4, awful.tag.viewnext), +awful.button({ }, 5, awful.tag.viewprev) +``` + +in the default _rc.lua_ may cause tag and thus focus changes without keyboard interaction and tend to happen accidentally. This doesn't suit our definition from above and should therefore be removed or commented out. + +##### Adjust client rules + +The default client rule allows certain focus changes via `focus = awful.client.focus.filter`. These changes can be prevented entirely by setting `focus = false`. + +Alternatively users may provide their own focus filter functions. + +##### Disable sloppy focus + +In your _rc.lua_ you'll find a section such as + +```lua + -- Enable sloppy focus + c:connect_signal("mouse::enter", function(c) + if awful.layout.get(c.screen) ~= awful.layout.suit.magnifier + and awful.client.focus.filter(c) then + client.focus = c + end + end) +``` + +These enable _sloppy focus_ aka focus changes on mouse movements (without clicking) and should be removed or commented out to disable that behaviour. + +##### Ignore requests from applications to the window manager + +Handling of such requests is currently mostly implemented by awesome in the file `/usr/share/awesome/lib/awful/ewmh.lua`. You can either comment out the respective `client.connect_singal()` lines in that file (it will change back after each awesome update though) or disconnect the signals in your _rc.lua_. + +As of awesome 3.5.9 this however is apparently only possible for signals connected to global functions, i.e. currently only the below signals can be disconnected in the _rc.lua_: + +```lua +local ewmh = require("awful.ewmh") + +client.disconnect_signal("request::activate", ewmh.activate) +client.disconnect_signal("request::tag", ewmh.tag) +``` + +The signal names may change across awesome versions. + diff --git a/customization-guides/dark-theme.md b/customization-guides/dark-theme.md new file mode 100644 index 0000000..4cdf0c7 --- /dev/null +++ b/customization-guides/dark-theme.md @@ -0,0 +1,187 @@ +--- +layout: doc +title: Dark Theme in Dom0 and DomU +permalink: /doc/dark-theme/ +--- + +Dark Theme in Dom0 +================== + +Dark KDE in Dom0 +---------------- + +The following text describes how to change the default light theme to a dark theme. This is just an example, feel free to adjust the appearance to your taste. + +The image below shows the default light theme after installation. +![begin light theme](/attachment/wiki/Dark-Theme/kde-fresh-installed-standard.png) + +This is the result after applying the steps described here. +![end result dark theme](/attachment/wiki/Dark-Theme/kde-end-result.png) + +1. Change `Workspace Appearance` + + 1. Open the `Workspace Appearance` window + + Qubes Menu -> System Tools -> System Settings -> Workspace Appearance + + ![Workspace Appearance](/attachment/wiki/Dark-Theme/kde-app-appearance-menu-style.png) + + 2. Go to `Desktop Theme` + + ![Desktop Menu](/attachment/wiki/Dark-Theme/kde-appearance-settings-desktop-theme-oxygen.png) + + 3. Select `Oxygen` and `Apply` the change + +2. (Optional) Remove blue glowing task items + + ![blue glowing task bar items](/attachment/wiki/Dark-Theme/kde-taskbar-blue-glowing-border.png) + + 1. Adjust Oxygen `Details` + + Qubes Menu -> System Tools -> System Settings -> Workspace Appearance -> Desktop Theme -> Details (Tab) + + 2. Select `Oxygen` + + 3. Change `Theme Item -> Task Items` from `Oxygen Task Items` to `Air Task Items` + + ![Change Task items look](/attachment/wiki/Dark-Theme/kde-desktop-theme-details.png) + + 4. Apply changes + + ![task bar items blue glowing removed](/attachment/wiki/Dark-Theme/kde-taskbar-blue-glowing-removed.png) + +3. Change `Application Appearance` + + 1. Open the `Application Appearance` window + + Qubes Menu -> System Tools -> System Settings -> Application Appearance + + 2. Go to `Colors` + + ![colors tab](/attachment/wiki/Dark-Theme/kde-app-appearance-menu-colors.png) + + 3. Select `Obsidian Coast` + + ![set to Obsidian Coast](/attachment/wiki/Dark-Theme/kde-app-appearance-menu-colors-set.png) + + 4. Apply Changes + + Qubes VM Manager should now look like the image below. + + ![result black Qubes Manager](/attachment/wiki/Dark-Theme/kde-black-qubes-manager.png) + +**Note:** Changing the `Window Decorations` from `Plastik for Qubes` will remove the border color and the VM name. The problem with `Plastik for Qubes` is, that it does not overwrite the background and text color for Minimize, Maximize and Close buttons. The three button are therefore hard to read. + +Dark XCFE in Dom0 +----------------- + +The following text describes how to change the default light theme to a dark theme. This is just an example, feel free to adjust the appearance to your taste. + +The image below shows the default light theme after installation. +![begin light theme](/attachment/wiki/Dark-Theme/xfce-fresh-installed.png) + +This is the result after applying the steps described here. +![end result dark theme](/attachment/wiki/Dark-Theme/xfce-end-result.png) + +1. Change Appearance + + 1. Open the `Appearance` dialog + + Qubes Menu -> System Tools -> Appearance + + ![appearance dialog](/attachment/wiki/Dark-Theme/xfce-appearance-dialog.png) + + 2. Change Style to `Albatross` + + **Note:** The black appearance theme `Xfce-dusk` makes the VM names in the `Qubes OS Manager` unreadable. + +2. *(Optional)* Change Window Manager Style + + 1. Open the `Window Manager` dialog + + Qubes Menu -> System Tools -> Appearance + + ![window manager dialog](/attachment/wiki/Dark-Theme/xfce-window-manager-theme.png) + + 2. Change the Theme in the `Style` Tab (e. g. Defcon-IV). All available themes work. + + +Dark App VM, Template VM, Standalone VM, HVM (Linux Gnome) +========================================================== + +Almost all Qubes VMs use default applications based on the GTK toolkit. Therefore the description below is focused on tools from the Gnome Desktop Environment. + +Using "Gnome-Tweak-Tool" +------------------------ + +The advantage of creating a dark themed Template VM is, that each AppVM which is derived from the Template VM will be dark themed by default. + +**Note:** Gnome-Tweak-Tool crashes under Archlinux. A workaround is to assign the AppVM to another TemplateVM (Debian, Fedora) which has Gnome-Tweak-Tool installed. Start the AppVM and configure the settings. Shutdown the machine and switch the template VM back to Archlinux. + +1. Start VM + + **Note:** Remember that if you want to make the change persistent, the change needs to be made in the TemplateVM, not the AppVM. + +2. Install `Gnome-Tweak-Tool` + + - Fedora + + sudo dnf install gnome-tweak-tool + + - Debian + + sudo apt-get install gnome-tweak-tool + +3. *(Only AppVM)* Stop template and start AppVM + +4. Add `Gnome-Tweak-Tool` to the Application Menu + + 1. `Right-click` on VM entry in `Qubes VM Manager` select `Add/remove app shortcuts` + + 2. Select `Tweak Tool` and press the `>` button to add it + + ![Application Dialog](/attachment/wiki/Dark-Theme/dialog-add-gnome-tweak-tool.png) + +5. Enable `Global Dark Theme` + + 1. *Debian only* + + cd ~/.config/ + mkdir gtk-3.0 + cd gtk-3.0/ + touch settings.ini + + 2. Start `Tweak Tool` from the VM application menu and set the `Global Dark Theme` switch to `on` + + ![Global Dark Theme enabled](/attachment/wiki/Dark-Theme/gnome-tweak-tool.png) + +6. *(Optional)* Modify Firefox + + **Note:** Firefox uses GTK style settings by default. This can create side effects such as unusable forms or search fields. One way to avoid this is to add the following line to `/rw/config/rc.local`: + + sed -i.bak "s/Exec=firefox %u/Exec=bash -c 'GTK_THEME=Adwaita:light firefox %u'/g" /usr/share/applications/firefox.desktop + +7. Restart VM or all application + +Manually +-------- + +Manually works for Debian, Fedora and Archlinux. + +1. Start VM + + **Note:** Remember that if you want to make the change persistent, the change needs to be made in the TemplateVM, not the AppVM. + +2. Enable `Global Dark Theme` + + cd ~/.config/ + mkdir gtk-3.0 + cd gtk-3.0/ + touch settings.ini + + add the following lines to `settings.ini` + + [Settings] + gtk-application-prefer-dark-theme=1 + +3. follow step 6 and 7 in: Using `Gnome-Tweak-Tool` diff --git a/customization-guides/fedora-minimal-template-customization.md b/customization-guides/fedora-minimal-template-customization.md new file mode 100644 index 0000000..d4280f2 --- /dev/null +++ b/customization-guides/fedora-minimal-template-customization.md @@ -0,0 +1,294 @@ +--- +layout: doc +title: Fedora Minimal Template Customization +permalink: /doc/fedora-minimal-template-customization/ +redirect_from: /en/doc/fedora-minimal-template-customization/ +--- + +FEDORA Packages Recommendations +====================== + +(starting from a minimal template) + +Template installation +------------------------------ + +> [dom0]#qubes-dom0-update qubes-template-fedora-26-minimal + + +*Note*: If you have doubts about a set of tools or package you want to install, start installing and testing it in an AppVM. +You can then reproduce it later in your TemplateVM if you are satisfied. +That is the template philosophy in QubesOS. + +For more information on the uses of a minimal template read [this page][Minimal]. + +Standard tools installation +================ + +Administration (documented) +--------------------------------------------- + +> sudo pciutils vim-minimal less tcpdump telnet psmisc nmap nmap-ncat usbutils + +*Notes*: nmap can be used to discover hosts on a network (nmap -sP [network]), especially if you are inside a Microsoft network, because your AppVM will be protected/NATted behind the Qubes firewall. +(Microsoft / home networks make heavy use of autodiscovery technologies which require clients to be in the same local network (no firewall/no NAT), eg: your printer.) + +Some recommendations here: check your current network using the Network manager applet (eg: 192.168.1.65). +Then run nmap in your current AppVM/TemplateVM to search for the selected printer/equipment: + nmap -sP 192.168.1.-. +Don't forget to temporarily allow traffic via the Qubes Firewall if you are doing this in a TemplateVM. + +Administration (undocumented) +------------------------------------------------- + +> openssh keepassx openssl gnome-keyring man + +Dependency note: keepassx rely on qt which takes ~30MB + +Network VM (documented) +---------------------------------------- + +> NetworkManager NetworkManager-wifi network-manager-applet wireless-tools dbus-x11 tar tinyproxy iptables + +Network VM (undocumented) +-------------------------------------------- + +> which dconf dconf-editor + +*Notes*: which is required for autostart scripts + +*Notes*: dconf is required to remember the VM settings that are changed (the gsetting backend will be in memory only if gconf is not installed). + +Network VM (manual operations - documented) +------------------------------------------------------------------------ + +Search for wireless firmware matching your wireless card (to be launched in network VM) + +> lspci; dnf search firmware + +ProxyVM/NetworkVM for 3G Modems +-------------------------------------------- + +> ModemManager NetworkManager-wwan usb_modeswitch modem-manager-gui + +Dependency note: modem-manager-gui relies on webkit-gtk and is optional (NetworkManager can handle the modem alone) + +Source: [3GMODEM] + +ProxyVM for VPNs +-------------------------------------------- + +Search for a VPN package for your particular vpn solution then [configure][VPNNM] NetworkManager + +> dnf search NetworkManager [openvpn\|openconnect\|openswat\|...] + +OR + +Refer to [this guide][VPN] which includes instructions for failsafe anti-leak VPN configuration using CLI scripts. (An early discussion about OpenVPN configuration can be viewed [here][OPENVPNSETUP].) Required packages will be `iptables` in addition to VPN software such as `openvpn`. + + +Printer Setup +-------------------------------------------- + +> system-config-printer system-config-printer-applet cups + +Dependency Note: depends on python3 + python3 additional libraries which takes more than 40 M once installed. + +Dependency Note: cups depends on ghostscript and require installing additional printing fonts (not documented here), so it can takes several dozen of MB + +Manual operations +--------------------------- + +- Don't forget to restart your TemplateVM or only the cups service when you installed cups (systemctl start cups) + +- First you need to search for your printer. If you don't know its name or IP, search for it using nmap: check your current network using the Network manager applet (eg: 192.168.1.65). Then run nmap in your current AppVM/TemplateVM to search for the selected printer/equipement: nmap -sP 192.168.1.-. Don't forget to temporarily allow traffic via the Qubes Firewall if you are inside a TemplateVM. + +- Once you identified your printer, run system-config-printer GUI to install your printer + +- You may need to cancel the operation to install more adapted printer drivers (eg: if the driver cannot be found automatically). Use dnf search printername to find potential drivers (eg dnf search photosmart) + +GUI recommendations +====================== + +Lightweight packages recommendations +--------------------------------------------------------------- + +> lxterminal dejavu-sans-mono-fonts dejavu-sans-fonts gnome-settings-daemon + +*Note*: You need to install sans-mono fonts for the terminal or it will be unreadable (overlapping characters....), while the sans fonts are just to get nicer GUI menus. + +*Scite* is a nice notepad that can also highlight scripts with very light dependencies +> scite + +*Meld* allows easy comparison of two text files/ two configuration files. + +> meld + +*Thunar* is a light file manager usually used by xfce + +> thunar thunar-volman ntfs-3g + +Dependency Note: xfce4 dependencies (but still quite light ~1.4M downloads) + +Miscellaneous packages +-------------------------- + +*pycairo* package is needed for file's contextual menu "Send to VM" to function (to actually popup dialog box and enter VM's name where the file will be sent to). + +*pinentry-gtk* package is responsible for pop-up dialog window where you enter password for your password protected gpg key. +Install this package in the qube holding your password protected gpg keys. +If you do not use password protected gpg keys, there is no need to install this package. + +GUI themes +----------------- + +Managing GUI theme / appearance is often complex because when you do not want to depend on a specific desktop system. + +For this reason, we need to customize themes for each GUI framework that our application depends on. + +This often includes GTK2, GTK3 (which us a different configuration/themes than GTK2), Qt. + +The appearance of Windows can only be changed in dom0, however, the appearance of all buttons, menus, icons, widgets are specific to each AppVM. + +### Packages + +Choose theme packages for each framework. I recommend the following documentation [THEMEPACKAGES] + +> clearlooks-phenix-gtk2-theme clearlooks-phenix-gtk3-theme + +You can search for other themes using `dnf search theme gtk`. + +You can check your currently installed theme packages (to eventually remove them) using `rpm -qa | grep theme`. + +### Tweaking theme and appearance + +First you can get an insight of installed Gtk theme and see how it will appear using lxappearance. + +I recommend not applying settings using lxappearance (do not click on apply) because it will create multiple configuration files. + +To remove these files, follow cleanup notes. + +#### Cleanup notes + +~~~ +rm ~/.gtkrc-2.0 +rm ~/.icons/default/index.theme +rm ~/.config/gtk-3.0/settings.ini +rm ~/.config/Trolltech.conf +~~~ + +Cleaning the whole dconf settings is also possible by removing the following file. Please note that it will remove all preferences set for gnome application (not only the themes) + +~~~ +rm ~/.config/dconf/user +~~~ + +*Note*: lxappearance only has an effect on gtk3 themes so it won't work to change gtk2 themes (used by Firefox, Thunderbird ...). + However, it is very lightweight and can be used to identify the name and look of themes you are interested in. + Once you have the name, you can apply it using gsetting command line or gconf-editor. + +*Note*: if you really want a GUI theme editor, you can install gnome-tweak-tools, but this tool has a lot + of gnome dependencies (~150MB of dependencies). You can install it and uninstall it as soon as you change your theme. + +#### Testing notes + +The following programs can be used to see if theme has been correctly applied: + +* GTK2 program: scite, thunderbird, firefox +* GTK3 program: lxterminal +* Qt program: keepassx + +*Note*: testing in a TemplateVM will not work as expected because gnome-settings-daemon is not started in TemplateVM. + so test your themes in an AppVM and then update the TemplateVM accordingly. + +### Forcing theme change for all AppVM depending on a TemplateVM + +This can be done for gtk themes by creating dconf global settings. I recommend reading these articles: + +[DCONF1] + +[DCONF2] + +#### Creating global file + + * Setup global config file: + + > mkdir /etc/dconf/db/qubes.d + + Edit/Create the following file: /etc/dconf/db/qubes.d/10-global-theme-settings: + + ~~~ + [org/gnome/desktop/interface] + cursor-theme="Adwaita" + gtk-theme="Clearlooks-Phenix" + icon-theme="Adwaita" + font-name="Cantarell 11" + monospace-font-name="Monospace 11" + ~~~ + + * Generate global config database + + > dconf update + + * Configure default user profile + + Edit/Create the following file: /etc/dconf/profile/user: + + ~~~ + user-db:user + system-db:qubes + ~~~ + +#### Locking configuration + +It should be noted that the user dconf settings stored in ~/.config/dconf/user always takes precedence over the global dconf settings. + +User dconf settings can be browsed using dconf-editor GUI. + +If you want to force specific settings to be applied for all user (so in our case for all AppVMs depending on the template), you need to create locks: + +> mkdir /etc/dconf/db/qubes.d/locks + +Edit/Create the following file: /etc/dconf/db/qubes.d/locks/theme.lock: + +~~~ +/org/gnome/desktop/interface/gtk-theme +~~~ + +Finally, regenerate the dconf database +> dconf update + +### Uniform look for Qt & GTK + +Getting an uniform look for Qt & GTK is not achieved yet. A good source is on the following link [UNIFORMTHEME] + +Two case: + +1. You installed packages of the theme you selected both for Qt, GTK2 and GTK3. + (eg: Adwaita which is the default theme. I have not found another cross framework theme on fedora default packages). + +2. You want to use the GTK theme you selected for Qt but there is no qt package. + In this case QGtkStyle will take precedence and convert the style automatically. + You can verify if it is enabled by searching for "style=GTK+" in /etc/xdg/Trolltech.conf. + If style is changed to another name, it will be used instead of your GTK theme. + +*Note*: check that ~/.config/Trolltech.conf in your AppVMs is not defining another "style=" because it will take precedence over your global Qt theme. + + +[3GMODEM]: https://www.codeenigma.com/community/blog/installing-3g-usb-modems-linux + +[OPENVPNSETUP]: https://groups.google.com/forum/#!searchin/qubes-users/openvpn$20setup/qubes-users/UbY4-apKScE/lhB_ouTnAwAJ + +[THEMEPACKAGES]: https://groups.google.com/forum/#!search/appvm$20theme/qubes-users/RyVeDiEZ6D0/YR4ITjgdYX0J + +[DCONF1]: http://www.mattfischer.com/blog/?p=431 + +[DCONF2]: https://wiki.gnome.org/Projects/dconf/SystemAdministrators + +[UNIFORMTHEME]: https://wiki.archlinux.org/index.php/Uniform_look_for_Qt_and_GTK_applications + +[Minimal]: ../templates/fedora-minimal/ + +[VPNNM]: ../vpn/#set-up-a-proxyvm-as-a-vpn-gateway-using-networkmanager + +[VPN]: ../vpn/#set-up-a-proxyvm-as-a-vpn-gateway-using-iptables-and-cli-scripts diff --git a/customization-guides/i3.md b/customization-guides/i3.md new file mode 100644 index 0000000..a8de3b6 --- /dev/null +++ b/customization-guides/i3.md @@ -0,0 +1,90 @@ +--- +layout: doc +title: i3 +permalink: /doc/i3/ +redirect_from: +- /en/doc/i3/ +- /doc/i3/ +- "/doc/UserDoc/i3/" +- "/wiki/UserDoc/i3/" +--- + +# i3 installation in dom0 + +i3 is part of the stable repository (as of Qubes R3.1) and can be installed by +using the [dom0 update mechanism](/doc/software-update-dom0/). To install the i3 +window manager and the its Qubes specific configuration: + + $ sudo qubes-dom0-update i3 i3-settings-qubes + +The Qubes-specific configuration (package `i3-settings-qubes`) can be installed +optionally in case you would prefer writing your own configuration (see +[customization](#customization) section for scripts and configuration). + +That's it. After logging out, you can select i3 in the login manager. + +### Customization + +* [xdg_autostart_script](https://gist.github.com/SietsevanderMolen/7b4cc32ce7b4884513b0a639540e454f) +* [i3bar_script](https://gist.github.com/SietsevanderMolen/e7f594f209dfaa3596907e427b657e30) +* [terminal_start_script](https://gist.github.com/SietsevanderMolen/7c6f2b5773dbc0c08e1509e49abd1e96) +* [i3 config with dmenu-i3-window-jumper](https://github.com/anadahz/qubes-i3-config/blob/master/config) + +## Compilation and installation from source + +Note that the compilation from source is done in a Fedora based domU (could +be dispvm). The end result is always an `.rpm` that is copied to dom0 and then +installed through the package manager. + +### Getting the code + +Clone the i3-qubes repository here: + + $ git clone https://github.com/QubesOS/qubes-desktop-linux-i3 + +In this case, the most interesting file is probably +`i3/0001-Show-qubes-domain-in-non-optional-colored-borders.patch` It's the patch +with changes that are necessary to make i3 work nicely with Qubes OS. The code +should not need much explanation, it just gets the vmname and label from Qubes +OS and changes some defaults so the user can't override decisions. + +If you want to make any changes to the package, this is the time and place to do +it. + +### Building + +You'll need to install the build dependencies, which are listed in +build-deps.list. You can verify them and then install them with: + + $ sudo dnf install -y $(cat build-deps.list) + +This used to be more complicated, but I finally redid this and use the same +buildsystem that's used by Qubes OS for XFCE. It's just a Makefile that helps +you get the sources and start off the build: + + $ make rpms + +### Installing + +**Warning**: Manually installing software in dom0 is inherently risky, and the method described here circumvents the usual security mechanisms of qubes-dom0-update. + +You should now have your i3 rpm in `./rpm/x86_64/i3-4.8-3.fc20.x86_64.rpm`. +Protip: copying this file to `~/i3.rpm` now will save you some typing in the +next step. + +Now in dom0, copy in the rpm: + + $ qvm-run --pass-io 'cat ' > i3.rpm + +Now that the rpm is in dom0 we can proceed with installing it. i3 has some +dependencies that we can easily install with: + + $ sudo qubes-dom0-update perl-AnyEvent-I3 xorg-x11-apps \\ + rxvt-unicode xcb-util-wm perl-JSON-XS xcb-util-cursor \\ + dzen2 dmenu xorg-x11-fonts-misc libev + +After that you can just install the generated rpm like any other local package: + + $ sudo yum localinstall i3.rpm + +Log out, select i3, then log in again. diff --git a/customization-guides/kde.md b/customization-guides/kde.md new file mode 100644 index 0000000..bdc5492 --- /dev/null +++ b/customization-guides/kde.md @@ -0,0 +1,88 @@ +--- +layout: doc +title: KDE +permalink: /doc/kde/ +redirect_from: /en/doc/kde/ +--- + +Using KDE in dom0 +================= + +Installation +------------ + +Prior to R3.2, KDE was the default desktop environment in Qubes. Beginning with +R3.2, however, [XFCE is the new default desktop environment](/doc/releases/3.2/release-notes/). Nonetheless, it is +still possible to install KDE by issuing this command in dom0: + + $ sudo qubes-dom0-update @kde-desktop-qubes + +You can also change your default login manager (lightdm) to the new KDE default: sddm + + * first you need to edit the `/etc/sddm.conf` to make sure if the custom X parameter is set according to Qubes needs: + +~~~ + [XDisplay] + ServerArguments=-nolisten tcp -background none +~~~ + + * disable the lightdm service: + +~~~ + $ sudo systemctl disable lightdm +~~~ + + * enable the sddm service: + +~~~ + $ sudo systemctl enable sddm +~~~ + + * reboot + +If you encounter performance issues with KDE, try switching back to LightDM. + +Window Management +----------------- + +You can set each window's position and size like this: + +~~~ +Right click title bar --> More actions --> Special window settings... + + Window matching tab + Window class (application): Exact Match: + Window title: Substring Match: + + Size & Position tab + [x] Position: Apply Initially: x,y + [x] Size: Apply Initially: x,y +~~~ + +You can also use `kstart` to control virtual desktop placement like this: + +~~~ + kstart --desktop 3 --windowclass -q --tray -a '' +~~~ + +(Replace "3" with whichever virtual desktop you want the window to be +on.) + +This can be useful for creating a simple shell script which will set up your +workspace the way you like. + +Removal +------------ + +If you decide to remove KDE do **not** use `dnf remove @kde-desktop-qubes`. You will almost certainly break your system. + +The safest way to remove (most of) KDE is: +~~~ +sudo dnf remove kdelibs,plasma-workspace +~~~ + + +Mailing List Threads +-------------------- + + * [Nalu's KDE customization thread](https://groups.google.com/d/topic/qubes-users/KhfzF19NG1s/discussion) diff --git a/customization-guides/language-localization.md b/customization-guides/language-localization.md new file mode 100644 index 0000000..79c2255 --- /dev/null +++ b/customization-guides/language-localization.md @@ -0,0 +1,46 @@ +--- +layout: doc +title: Language Localization +permalink: /doc/language-localization/ +redirect_from: +- /en/doc/language-localization/ +- /doc/LanguageLocalization/ +- /wiki/LanguageLocalization/ +--- + +Language Localization +===================== + +How to set up pinyin input in Qubes +----------------------------------- + +The pinyin input method will be installed in a TemplateVM to make it available after restarts and across multiple AppVMs. + +1. In a TemplateVM, install `ibus-pinyin` via the package manager or terminal. + If the template is Fedora-based, run `sudo dnf install ibus-pinyin`. + If the template is Debian-based, run `sudo apt install ibus-pinyin` + +2. Shut down the TemplateVM. + +3. Start or restart an AppVM based on the template in which you installed `ibus-pinyin` and open a terminal. + +4. Run `ibus-setup`. + +5. You will likely get an error message telling you to paste the following into your bashrc: + + export GTK_IM_MODULE=ibus + export XMODIFIERS=@im=ibus + export QT_IM_MODULE=ibus + + Copy the text into your `~/.bashrc` file with your favorite text editor. + You will need to do this for any AppVM in which you wish to use pinyin input. + +6. Set up ibus input as you like using the graphical menu (add pinyin or intelligent pinyin to selections). + You can bring the menu back by issuing `ibus-setup` from a terminal. + +7. Set up your shortcut for switching between inputs. + By default it is super-space. + +If `ibus-pinyin` is not enabled when you restart one of these AppVMs, open a terminal and run `ibus-setup` to activate ibus again. + +For further discussion, see [this qubes-users thread](https://groups.google.com/forum/#!searchin/qubes-users/languge/qubes-users/VcNPlhdgVQM/iF9PqSzayacJ). diff --git a/customization-guides/removing-templatevm-packages.md b/customization-guides/removing-templatevm-packages.md new file mode 100644 index 0000000..ddb61f3 --- /dev/null +++ b/customization-guides/removing-templatevm-packages.md @@ -0,0 +1,93 @@ +--- +layout: doc +title: Removing TemplateVM Packages +permalink: /doc/removing-templatevm-packages/ +--- + +# Removing TemplateVM Packages +When removing any packages from a default TemplateVM, be sure to check what's being removed by `apt autoremove` or `dnf`. +When removing certain packages, for instance Thunderbird, `apt` and `dnf` will attempt to remove many packages required by qubes for the template to function correctly under qubes. + +As an example from a terminal in a TemplateVM: +```shell_session +$ sudo apt remove thunderbird +Reading package lists... Done +Building dependency tree +Reading state information... Done +The following packages were automatically installed and are no longer required: + debugedit libjs-sphinxdoc libjs-underscore librpm3 librpmbuild3 librpmio3 + librpmsign3 libsqlite0 linux-headers-4.9.0-6-amd64 + linux-headers-4.9.0-6-common linux-image-4.9.0-6-amd64 python-backports-abc + python-cffi-backend python-concurrent.futures python-croniter + python-cryptography python-dateutil python-enum34 python-idna + python-iniparse python-ipaddress python-jinja2 python-libxml2 python-lzma + python-markupsafe python-msgpack python-openssl python-pyasn1 python-pycurl + python-requests python-rpm python-singledispatch python-six python-sqlite + python-sqlitecachec python-tornado python-tz python-urlgrabber + python-urllib3 python-xpyb python-yaml qubes-core-agent-dom0-updates + qubes-core-agent-passwordless-root qubes-gpg-split qubes-img-converter + qubes-input-proxy-sender qubes-mgmt-salt-vm-connector qubes-pdf-converter + qubes-usb-proxy rpm rpm-common rpm2cpio salt-common salt-ssh usbutils yum + yum-utils +Use 'sudo apt autoremove' to remove them. +The following packages will be REMOVED: + icedove lightning qubes-thunderbird qubes-vm-recommended thunderbird +0 upgraded, 0 newly installed, 5 to remove and 0 not upgraded. +After this operation, 151 MB disk space will be freed. +Do you want to continue? [Y/n] +``` + +Note all of the qubes packages are tracked as dependencies that will no longer be required. `apt remove` will only remove the packages listed, which is ok. +If, however you also run `apt autoremove` the other qubes packages necessary for TemplateVMs will be removed. + +If you'd still like to remove one of these applications without breaking your TemplateVM you have a couple different options. + +## Removing Only Packages Not Needed for a Qubes TemplateVM + +### Debian + 1. In your TemplateVM terminal run: + ```shell_session $ apt remove package-name``` + Note the packages "no longer required" + 2. If the list of "no longer required" packages includes anything beginning with `qubes-` or `salt-` make a note to yourself to **never** run `$ sudo apt autoremove` on this TemplateVM + +**Recommended but optional:** Use `apt-mark` to make `apt autoremove` safe again. +```shell_session +$ sudo apt mark-manual package-name package-name +``` + +Replace package-names with actual `qubes-*` and `salt-*` packages you'd like to retain. + +For example, still in your TemplateVM terminal: +```shell_session +$ sudo apt-mark manual qubes-core-agent-dom0-updates qubes-core-agent-passwordless-root qubes-gpg-split qubes-img-converter qubes-input-proxy-sender qubes-mgmt-salt-vm-connector qubes-pdf-converter salt-common salt-ssh qubes-usb-proxy +``` + +`$ apt autoremove` should now be safe to use. + +### Fedora +In your TemplateVM terminal, run: +```shell_session +$ dnf remove --noautoremove package-name +``` + + +## Recovering A TemplateVM which you've already removed needed qubes-* packages +If you've already removed packages, run `apt autoremove` and restarted your VM you've lost passwordless sudo access. +You can login as root, open a terminal in dom0 and run: +```shell_session +$ qvm-run -u root vmname xterm +``` +This will open an xterm terminal in the TemplateVM named `vmname` + +Once you're logged in as root, reinstall these packages & their dependencies: + +### Debian +```shell_session +$ sudo apt install qubes-core-agent-dom0-updates qubes-core-agent-passwordless-root qubes-gpg-split qubes-img-converter qubes-input-proxy-sender qubes-mgmt-salt-vm-connector qubes-pdf-converter salt-common salt-ssh +``` + +### Fedora +Similar to Debian for example (package names may vary): +```shell_session +$ sudo dnf install qubes-core-agent-dom0-updates qubes-core-agent-passwordless-root qubes-gpg-split qubes-img-converter qubes-input-proxy-sender qubes-mgmt-salt-vm-connector qubes-pdf-converter salt-common salt-ssh +``` diff --git a/customization-guides/windows-template-customization.md b/customization-guides/windows-template-customization.md new file mode 100644 index 0000000..ecaffa2 --- /dev/null +++ b/customization-guides/windows-template-customization.md @@ -0,0 +1,168 @@ +--- +layout: doc +title: Windows Template Customization +permalink: /doc/windows-template-customization/ +redirect_from: /en/doc/windows-template-customization/ +--- + +Disable/Uninstall unnecessary features/services +============================= + +Windows features +---------------------------- + +Uninstall windows features from Control Panel > Turn windows features On/Off. + +Generally, it will be required to reboot after features are uninstalled. + +If you do not manage to uninstall some features, it is sometimes necessary to uninstall them one by one or two by two. + +Only keep: + + * Print and Document Service => Internet Printing Client + * Print and Document Service => Windows Fax and Scan (apparently it cannot be uninstalled) + * Windows search + +*Note*: Windows search is recommended because it is a nightmare to find something in menus if it is not enabled (it removes the search bar from the start menu, from the explorer, and from the control panel). + +*Note*: Unselecting windows media, .Net and Internet Explorer will uninstall these components. On a new install they are generally old versions anyway and it will be quicker to install directly the new versions later. + +Windows services +--------------------------- + +Disable the following services that are not required or have no sense in a VM context: + + * Base Filtering Engine (only required if you want to use Microsoft IPSEC) + * DHCP Client + * Function Discovery Provider Host + + this will not work anyway because SSDP discovery uses multicast - need to be on the same network which is not the case because of Qubes firewall + * Peer Name Resolution Protocol + * Peer Netwoking Grouping + * Peer Networking Identity Manager + * SSDP Discovery + * Security Center (is it only notifications ?) + * TCP/IP Netbios Help (is Netbios still really used by Windows ? Maybe for discovery only ?) + * Themes (if you don't care about theme) + * Volume Shadow Copy (see next note in the performance section) + * Windows defender + * Windows Firewall + +*Notes*: IP Helper is required as it is used by Qubes Agent to configure the IP address. + +Windows update +-------------------------- + +I recommend disabling windows update (Never Check for Update) because checking for updates will start every time you start an AppVM if you haven't started your template in a while. + +Running windows update is also apparently IO hungry. + +Of course I recommend starting the template regularly and checking manually for updates. + +System properties +--------------------------- + +Right click on computer and go to Properties > Advanced > Performance: + + * If you don't care about visual effect, in Visual Effect select "Adjust for best performance" + * I personally tweak the page file size to gain some space on my root. + + In Advanced>Performances>Advanced tab, change Virtual memory: + + 1. unselect automatically manage paging file size for all drive + 2. click on drive C: + 3. select no paging file + 4. click on set + 5. click on drive d: + 6. select customer size + 7. use an initial size of 500 and a max size of 1000. If the page file is too small, you will notice a low memory pop up when working on windows. In this case, it often means that you should extend your AppVM RAM. + + * System Protection + + Here you can disable Shadow Folder because it has little sense in the case of Qubes because + + * we do regular backups of AppVMs/TemplateVMs; + * we can revert at least one template change if we break something. + + Select drives where system protection is enabled and click Configure. "Turn off system protection" "Delete all restore points" + + * Remote + + Unselect Allow Remote Assistance connections to this computer. + +Task scheduler +----------------------- + +Open the task scheduler and *disable* the following tasks. + +If you remove these tasks they may be recreated automatically by various windows management tools (such as defragmentation) + + * Autochk: All + * Application Experience: All + * Customer Experience Improvement Program: All + * Defrag: All + * DiskDiagnosis: All (the disk is virtual anyway so S.M.A.R.T. has no sense) + * Maintenance: All + * SystemRestore: All + * WindowsBackup: All + +Power options +------------- + +First, enable the "Power" Windows service. Then, set all of the following: + + * Put the computer to sleep: `Never` + * Turn the display off: `Never` + * Turn off hard disk after: Setting (Minutes): `0` + +Turn off hibernation. Open a command prompt (`cmd.exe`) as an administrator, +then execute: + + powercfg -h off + +The hibernation file (`C:\hyberfil.sys`) should now be deleted. + +Manual tasks that can/should be started in the template +------------------------------------------------------- + + * Disk defragmentation + + * Windows Update + + * Windows file cleaning + 1. Run windows drive cleaner as Administrator. + 2. Enable all the task and run the cleaner + + * CCleaner file cleaning + 1. Install CCleaner free + 2. Copy the attached ccleaner configuration file in CCleaner program file folder + 3. Run ccleaner with all option set except "wipe free space" (it will also remove user history and preferences) + 4. Run ccleaner only with the option "wipe free space". + + It will write zeros in all unused space. This will allow you to strip the root.img file later + + * TemplateVM stripping + + Ensure that you know what you are doing in this section as you may destroy by error your template root.img file. + + * If you ran ccleaner with "wipe free space", follow the following procedure + + 1. from dom0, go to /var/lib/templates-vm/yourtemplate + + 2. copy root.img using the following command + + > cp --sparse=always root.img root.img.clean + + 3. if the copy worked, you can move the new root file by running this command + + > mv root.img.clean root.img + + * If it doesn't manage to fill the free space with zeros, you can follow the following *unsafe* undocumented procedure + + 1. from dom0, go to /var/lib/templates-vm/yourtemplate + 2. check the partitioning to identify the filesystem offset of root.img + 3. mount the filesystem + 4. create a file with zeros inside the filesystem until the mounted filesystem is full + 5. remove the file + 6. unmount the partition + 7. make a copy of root.img in sparse mode. diff --git a/managing-os/archlinux.md b/managing-os/archlinux.md new file mode 100644 index 0000000..7cbcfb4 --- /dev/null +++ b/managing-os/archlinux.md @@ -0,0 +1,434 @@ +--- +layout: doc +title: Archlinux Template +permalink: /doc/templates/archlinux/ +redirect_from: +- /doc/archlinux/ +- /en/doc/templates/archlinux/ +- /doc/Templates/Archlinux/ +- /wiki/Templates/Archlinux/ +--- + +# Archlinux Template + +Archlinux template is one of the templates made by Qubes community. It should +be considered experimental as Qubes developers team use mainly Fedora-based VMs +to test new features/updates. + +Main maintainer of this template is [Olivier Médoc](mailto:o_medoc@yahoo.fr). + +Updates for this template are provided by [Olivier Médoc](mailto:o_medoc@yahoo.fr) and are signed by the following key: + + + pub 2048R/2043E7ACC1833B9C 2014-03-27 [expires: 2018-03-29] + Key fingerprint = D85E E12F 9678 51CC F433 515A 2043 E7AC C183 3B9C + uid Olivier MEDOC (Qubes-OS signing key) + +## Installation + +A prebuilt template is available only for Qubes 3.2. Before Qubes 3.2, it should be compiled from source as described in [building-archlinux-template](/doc/building-archlinux-template/). + + [user@dom0 ~]$ sudo qubes-dom0-update --enablerepo=qubes-templates-community qubes-template-archlinux + +## Binary packages activation + +The Qubes update repository is disabled by default in the Archlinux template. You can however choose to trust it by registering it into pacman. + +Since November 2017, an activation package is present in the template. The update repository can thus be activated by running the following command inside the template: + + # pacman -sU /etc/pacman.d/qubes-vm-keyring*.pkg.tar.xz + +It should be noted to this command will create a trust for packages provided by [Olivier Médoc](mailto:o_medoc@yahoo.fr) and signed by the PGP key above. + +If the qubes-vm-keyring package is not present in `/etc/pacman.d/`, please refer to the section #Activating binary packages manually. + +## Optional Qubes packages + +Several Qubes packages are not necessarily installed by default in the Archlinux Template. These packages can be installed to add additional functionnalities to the template: +* `qubes-vm-networking`: Contains Qubes tools and dependencies required to use the template as a NetVM/ProxyVM +* `qubes-vm-pulseaudio`: Contains `Pulseaudio` agent enabling sound support in the template + +## Default template packages + +In order to keep the template as small and simple as possible, default installed package have been arbitrarily selected based on multiple subjective criterias that however essentially include libraries dependencies. This packages are: +* Some font packages to keep good user experience +* leafpad: a note pad +* xfce4-terminal: a terminal +* thunar: a file browser that supports mounting usb keys +* firefox: web browser +* thunderbird: a mail browser +* evince: a document viewer + +Note that Archlinux does not install GUI packages by default as this decision is left to users. These packages have only been selected to have a usable template. + +## Activating binary packages manually + +Enable the repository by running the following command: + + # rm /etc/pacman.d/99-qubes-repository-3.2.conf + # ln -s /etc/pacman.d/99-qubes-repository-3.2.disabled /etc/pacman.d/99-qubes-repository-3.2.conf + +Then you need to install and sign the public GPG key of the package maintainer (note that accessing to GPG servers requires to temporarily disable the firewall in your template): + + # pacman-key --recv-key 2043E7ACC1833B9C + # pacman-key --finger 2043E7ACC1833B9C + +If the fingerprint is correct, you can then sign the key: + + # pacman-key --lsign-key 2043E7ACC1833B9C + +## Updating a Qubes-3.2 Archlinux Template + +Because of changes in the Qubes-4.0 partition layout, and usage of XEN HVMs instead of pv-guests. It is not straightforward to update a Qubes-3.2 template to Qubes-4.0. + +For this reason, it is recommended to start from a new template in Qubes-4.0. + +## Updating a Qubes-3.1 Archlinux Template + +If you decide to use binary packages but that you were using a Qubes-3.1 Template, you can follow these instructions to enable Qubes 3.2 agents. + +You can use a template that you built for Qubes 3.1 in Qubes 3.2. The qrexec and gui agent functionalities should still be working so that you can at least open a terminal. + +In order to enable binary packages for Qubes 3.2, add the following lines to the end of /etc/pacman.conf + +``` +[qubes-r3.2] +Server = http://olivier.medoc.free.fr/archlinux/current/ +``` + +You should then follow the instruction related to pacman-key in order to sign the binary packages PGP key. With the key enabled, a pacman update will update qubes agents: +` # pacman -Suy ` + +The two lines that have just been added to /etc/pacman.conf should then be removed as they have been included in the qubes-vm-core update in the file `/etc/pacmand.d/99-qubes-repository-3.2.conf` + +## Known Issues + +### Package cannot be updated because of errors related to xorg-server or pulseaudio versions + +The Qubes GUI agent must be rebuilt whenever xorg-server or pulseaudio make major changes. +If an update of one of these packages causes your template to break, simply [revert it](https://www.qubes-os.org/doc/software-update-vm/#reverting-changes-to-a-templatevm) and wait for corresponding Qubes package updates to be available (or attempt to build them yourself, if you're so inclined). +This should not happen frequently. + +### qubes-vm is apparently starting properly (green dot) however graphical applications do not appear to work + +They are multiple potential reasons. Some of them are described in the following issue: +* https://github.com/QubesOS/qubes-issues/issues/2612 + +In issue 2612, check that the option `noauto` is present for all lines in /etc/fstab related to /rw or /home. This bug can appear if you come from an old Archlinux Template (pre February 2017). + +## Debugging a broken VM + +In order to identify the issue, you should start by getting a console access to the VM: + +* Either by running in dom0 `qvm-run --pass-io --nogui yourbrokenvm 'your command here'` + +* Or by running in dom0 `sudo xl console yourbrokenvm` + +Start by trying to run a GUI application such as xfce4-terminal in order to identify any error message. + +Then you can check potential broken systemd service by running the following command inside the broken vm: `systemctl | grep fail`. + +If you identified a broken service check `journalctl -la -u yourbrokenservice`. If not check `journalctl -b` for errors. + +Finally, errors related to the GUI agent can be found inside the VM in `/home/user/.xsession-errors` + +## Packages manager wrapper + +Powerpill is a full Pacman wrapper that not only gives easy proxy configuration but further offers numerous other advantages. + +Please check out: + +[Archlinux Powerpill](https://wiki.archlinux.org/index.php/powerpill) + +[XYNE's (dev) Powerpill](http://xyne.archlinux.ca/projects/powerpill/) + + +**Important Note:** As you are working in a template vm, by default, you will have to open network access to the template to download files manually, except for managed packages which should be handled by the Qubes proxy. You can use the "allow full access for" a given time period in the FW settings of the template in the VMM or open up the various services through the same window. Remember to change it back if you choose the later route. Actions needing network access will be noted with (needs network access) + +
+
+ +##### **1: Editing Pacman's configuration file (pacman.conf)** ##### + +* Open archlinux terminal app + +* edit /etc/pacman.conf + +* **$ sudo nano -w /etc/pacman.conf** + +* Below is the output of a correct pacman.conf file Make the changes so your file matches this one or rename the original and create a new one and copy and paste this text into it. Text should be justified left in the file. The changes from your default are to make gpg signing mandatory for packages but not required for DBs for the archlinux repos. Also to add the repo (at the end) for the Powerpill package. + + +
+
+ + + # /etc/pacman.conf + # + # See the pacman.conf(5) manpage for option and repository directives + + # + # GENERAL OPTIONS + # + [options] + # The following paths are commented out with their default values listed. + # If you wish to use different paths, uncomment and update the paths. + # RootDir = / + # DBPath = /var/lib/pacman/ + # CacheDir = /var/cache/pacman/pkg/ + # LogFile = /var/log/pacman.log + GPGDir = /etc/pacman.d/gnupg/ + HoldPkg = pacman glibc + # XferCommand = /usr/bin/curl -C - -f %u > %o + # XferCommand = /usr/bin/wget --passive-ftp -c -O %o %u + # CleanMethod = KeepInstalled + # UseDelta = 0.7 + Architecture = auto + + + # Pacman won't upgrade packages listed in IgnorePkg and members of IgnoreGroup + # IgnorePkg = + # IgnoreGroup = + # NoUpgrade = + NoUpgrade = /etc/X11/xinit/xinitrc.d/pulseaudio + NoUpgrade = /etc/X11/xinit/xinitrc.d/pulseaudio + NoUpgrade = /etc/X11/xinit/xinitrc.d/pulseaudio + # NoExtract = + + # Misc options + # UseSyslog + # Color + # TotalDownload + CheckSpace + # VerbosePkgLists + + # By default, pacman accepts packages signed by keys that its local keyring + # trusts (see pacman-key and its man page), as well as unsigned packages. + +**Edited Line:** `# SigLevel = Required DatabaseOptional` + + LocalFileSigLevel = Optional + # RemoteFileSigLevel = Required + + # NOTE: You must run `pacman-key --init` before first using pacman; the local + # keyring can then be populated with the keys of all official Arch Linux + # packagers with `pacman-key --populate archlinux`. + + # + # REPOSITORIES + # - can be defined here or included from another file + # - pacman will search repositories in the order defined here + # - local/custom mirrors can be added here or in separate files + # - repositories listed first will take precedence when packages + # have identical names, regardless of version number + # - URLs will have $repo replaced by the name of the current repo + # - URLs will have $arch replaced by the name of the architecture + # + # Repository entries are of the format: + # [repo-name] + # Server = ServerName + # Include = IncludePath + # + # The header [repo-name] is crucial - it must be present and + # uncommented to enable the repo. + # + + # The testing repositories are disabled by default. To enable, uncomment the + # repo name header and Include lines. You can add preferred servers immediately + # after the header, and they will be used before the default mirrors. + + # [testing] + # SigLevel = PackageRequired + # Include = /etc/pacman.d/mirrorlist + + [core] + +**Edited Line:** `SigLevel = PackageRequired` + + Include = /etc/pacman.d/mirrorlist + + [extra] + +**Edited Line:** `SigLevel = PackageRequired` + + Include = /etc/pacman.d/mirrorlist + + # [community-testing] + # SigLevel = PackageRequired + # Include = /etc/pacman.d/mirrorlist + + [community] + +**Edited Line:** `SigLevel = PackageRequired` + + Include = /etc/pacman.d/mirrorlist + + # If you want to run 32 bit applications on your x86_64 system, + # enable the multilib repositories as required here. + + # [multilib-testing] + # Include = /etc/pacman.d/mirrorlist + + # [multilib] + # Include = /etc/pacman.d/mirrorlist + + # An example of a custom package repository. See the pacman manpage for + # tips on creating your own repositories. + # [custom] + # SigLevel = Optional TrustAll + # Server = file:///home/custompkgs + + [multilib] + +**Edited Line:** `SigLevel = PackageRequired` + + Include = /etc/pacman.d/mirrorlist + +**Edited Line:** `# [qubes]` + +**Edited Line:** `# Server = http://olivier.medoc.free.fr/archlinux/pkgs/` + +**Add Section Below:** + + [xyne-x86_64] + # A repo for Xyne's own projects: http://xyne.archlinux.ca/projects/ + # Packages for the "x86_64" architecture. + # Added for PowerPill app + # Note that this includes all packages in [xyne-any]. + SigLevel = Required + Server = http://xyne.archlinux.ca/repos/xyne + +---------- + +
+ +##### **2: Setting Up GPG** (needs network access) ##### + +* Initialize GPG Keyring + + * **$ sudo pacman-key --init** + +* Populate the keyring with Archlinux master keys + + * **$ sudo pacman-key --populate archlinux** + + * Confirm keys with those at [Archlinux Master Keys](https://www.archlinux.org/master-keys/) + + * For more information on Pacman key signing: [Pacman Package Key Signing](https://wiki.archlinux.org/index.php/Pacman/Package_signing) + +
+
+ +##### **3: Install Powerpill (Pacman wrapper)** ##### + +* **$ sudo pacman -S powerpill** + +
+
+ +##### **4: Install Reflector** ##### + +*Note: It scripts mirror updating. Grabbing the most up to date gen mirror list. It ranks them by most recently sync'd. Then ranks them on fastest speed. Also can be used by Powerpill config to allow a once stop conf file for all if so wanted.* + +* **$ sudo pacman -S reflector** + + +Note: You can combine package downloads: **$ sudo pacman -S powerpill reflector** + +
+
+ +##### **5: Backup mirrorlist prior to first running Reflector.** ##### + +Note: For info on Reflector and its configs: [Reflector](https://wiki.archlinux.org/index.php/Reflector) + +* **$ sudo cp /etc/pacman.d/mirrorlist /etc/pacman.d/mirrorlist.bkup** + +
+
+ +##### **6: Setup mirrolist with Reflector** (needs network access)** ##### + +*Note: Look at the Reflector page to decide what filter and argument string you wish to run. Below is a default string that will work for most all to setup a working basic mirrorlist. + +*Look to Reflector pages or --help for more info on args and filters.* + +* **$ sudo reflector --verbose -l 5 --sort rate --save /etc/pacman.d/mirrorlist** + + * The above ranks all the most up to date and sorts for the 5 fastest + + * You can confirm the new list by opening the newly created mirrorlist. + +
+
+ + +##### **7: Configure Powerpill configuration file to use Qubes Proxy Service** ##### + +* Qubes Proxy Address: **10.137.255.254:8082** + +* Edit **powerpill.json** (powerpill config file) + + * **$ sudo nano -w /etc/powerpill/powerpill.json** + + * Add line '**--all-proxy=10.137.255.254:8082**' at the bottom of the list under the **"aria2"** section under the **"args"** line. Example below: + +
+ + { + "aria2": { + "args": [ + "--allow-overwrite=true", + "--always-resume=false", + "--auto-file-renaming=false", + "--check-integrity=true", + "--conditional-get=true", + "--continue=true", + "--file-allocation=none", + "--log-level=error", + "--max-concurrent-downloads=100", + "--max-connection-per-server=5", + "--min-split-size=5M", + "--remote-time=true", + "--show-console-readout=true", + "--all-proxy=10.137.255.254:8082" + ], + "path": "/usr/bin/aria2c" + }, + +
+
+ +##### **8: Test Powerpill Configuration** ##### + +*Note: Powerpill uses and passes the same syntax as pacman* + +* Configure Archlinux Template to only use the Qubes Proxy Update Service + * In the Qubes VM Manager under Archlinux FW tab make sure only the access check box for update proxy is on. All others should be set to deny. + +* **$ sudo powerpill -Syu** + + * You should get a similar output as below: + +
+
+![arch-template-26](/attachment/wiki/ArchlinuxTemplate/arch-template-26.png) +
+
+ + +**Remember you must open up network access anytime you wish to run the Reflector script to update the mirrorlist. This page will be updated when/if this situation changes.** + + +### **If the above checks out, you can start using your new Archlinux Template** ### + +
+
+ +## Want to contribute? + +* [How can I contribute to the Qubes Project?](/doc/contributing/) + +* [Guidelines for Documentation Contributors](/doc/doc-guidelines/) + +
diff --git a/managing-os/linux-hvm-tips.md b/managing-os/linux-hvm-tips.md new file mode 100644 index 0000000..c1c99fa --- /dev/null +++ b/managing-os/linux-hvm-tips.md @@ -0,0 +1,96 @@ +--- +layout: doc +title: Linux HVM Tips +permalink: /doc/linux-hvm-tips/ +redirect_from: +- /en/doc/linux-hvm-tips/ +- /doc/LinuxHVMTips/ +- /wiki/LinuxHVMTips/ +--- + +Tips for Linux in HVM domain +============================ + +How to fix bootup kernel error +------------------------------- + +The HVM may pause on boot, showing a fixed cursor. +After a while a series of warnings may be shown similar to this: + + BUG: soft lockup - CPU#0 stuck for 23s! [systemd-udevd:244] + +To fix this: + +1. Kill the HVM. +1. Start the HVM +1. Press "e" at the grub screen to edit the boot parameters +1. Find the /vmlinuz line, and edit it to replace "rhgb" with "modprobe.blacklist=bochs_drm" +1. Press "Ctrl-x" to start the HVM + +If this solves the problem then you will want to make the change permanent: + +1. Edit the file `/etc/default/grub`. +1. Find the line which starts: + ~~~ + GRUB_CMDLINE_LINUX= + ~~~ +1. Remove this text from that line: + ~~~ + rhgb + ~~~ +1. Add this text to that line: + ~~~ + modprobe.blacklist=bochs_drm + ~~~ +1. Run this command: + ~~~ + grub2-mkconfig --output=/boot/grub2/grub.cfg + ~~~ + +The HVM should now start normally. + + +Screen resolution +----------------- + +Some kernel/Xorg combinations use only 640x480 in HVM, which is quite small. +To enable maximum resolution, some changes in the Xorg configuration are needed: +1. Force "vesa" video driver +2. Provide wide horizontal synchronization range + +To achieve it (all commands to be run as root): + +1. Generate XOrg configuration (if you don't have it): + ~~~ + X -configure :1 && mv ~/xorg.conf.new /etc/X11/xorg.conf + ~~~ + +1. Add HorizSync line to Monitor section, it should look something like: + ~~~ + Section "Monitor" + Identifier "Monitor0" + VendorName "Monitor Vendor" + ModelName "Monitor Model" + HorizSync 30.0 - 60.0 + EndSection + ~~~ + +1. Change driver to "vesa" in Device section: + ~~~ + Section "Device" + # (...) + Identifier "Card0" + Driver "vesa" + VendorName "Technical Corp." + BoardName "Unknown Board" + BusID "PCI:0:2:0" + EndSection + ~~~ + +Now you should get resolution of at least 1280x1024 and should be able to choose other modes. + +Qubes agents +------------ + +Linux Qubes agents are written primarily for PV qubes, but it is possible to run them also in a HVM qube. +However some work may be required to achieve this. Check [this thread](https://groups.google.com/group/qubes-devel/browse_thread/thread/081df4a43e49e7a5). diff --git a/managing-os/netbsd.md b/managing-os/netbsd.md new file mode 100644 index 0000000..8b655ec --- /dev/null +++ b/managing-os/netbsd.md @@ -0,0 +1,23 @@ +--- +layout: doc +title: How to Create a NetBSD VM +permalink: /doc/netbsd/ +--- + +How to Create a NetBSD VM +========================= + +1. Create a StandaloneVM with the default template. +2. Replace `vmlinuz` with the `netbsd-INSTALL_XEN3_DOMU` kernel. +3. During setup, choose to install on the `xbd1` hard disk. +4. Attach the CD to the VM. +5. Configure the networking. +6. Optionally enable SSHD during the post-install configuration. +7. Replace the kernel with `netbsd-XEN3_DOMU`. +8. The VM may fail to boot automatically, in which case you must explicitly + specify `xbd1a` as the root device when prompted. + +For further discussion, please see this [thread] and this [guide]. + +[thread]: https://groups.google.com/group/qubes-devel/msg/4015c8900a813985 +[guide]: https://wiki.xen.org/wiki/How_to_install_a_NetBSD_PV_domU_on_a_Debian_Squeeze_host_%28Xen_4.0.1%29 diff --git a/managing-os/pentesting.md b/managing-os/pentesting.md new file mode 100644 index 0000000..56d7926 --- /dev/null +++ b/managing-os/pentesting.md @@ -0,0 +1,30 @@ +--- +layout: doc +title: Penetration Testing +permalink: /doc/pentesting/ +--- + +**Legal notice:** + +The usage of penetration testing tools outside your own laboratory environment requires the permission of the organization you attack. Penetration testing without permission can have legal consequences. + +To avoid such legal conflicts please refer to the [EC-Council: Code of Ethics](https://www.eccouncil.org/Support/code-of-ethics). + +Penetration Testing +=================== + +"A penetration test, colloquially known as a pen test, is an authorised simulated attack on a computer system that looks for security weaknesses, potentially gaining access to the system's features and data." (Source: [Wikipedia](https://en.wikipedia.org/wiki/Penetration_test)). + +Penetration Testing Distributions +--------------------------------- + +The following instructions explain how to install a penetration testing distribution within Qubes OS. + +- [BlackArch](/doc/pentesting/blackarch/) +- [Kali](/doc/pentesting/kali/) +- [PenTester Framework (PTF)](/doc/pentesting/ptf/) + +Using Qubes OS to host a "hacking" laboratory +--------------------------------------------- + +Qubes OS is a hypervisor based operating system. Qubes OS can host various operating systems such as Linux, Unix or Windows and run them in parallel. Qubes OS can therefore be used to host your own "hacking" laboratory. diff --git a/managing-os/pentesting/blackarch.md b/managing-os/pentesting/blackarch.md new file mode 100644 index 0000000..03fac39 --- /dev/null +++ b/managing-os/pentesting/blackarch.md @@ -0,0 +1,96 @@ +--- +layout: doc +title: How to Create a BlackArch VM +permalink: /doc/pentesting/blackarch/ +redirect_from: +- /doc/blackarch/ +--- + +**General reminder:** + +- The installation scripts and provided tools may have bugs, be vulnerable to Man in the Middle (MitM) attacks or other vulnerabilities. + +- Adding additional repositories or tools for installing software extends your trust to those tool providers. + +Please keep in mind that using such a VM or VMs based on the template for security and privacy critical tasks is not recommended. + +How to Create a BlackArch VM +============================ + +[BlackArch](https://www.blackarch.org) Linux is an [Arch Linux](https://www.archlinux.org)-based distribution for penetration testers and security researchers. The repository contains [1434](https://www.blackarch.org/tools.html) tools. + +- List of [tools](https://www.blackarch.org/tools.html) +- [Installation Instructions](https://www.blackarch.org/downloads.html) + +Create ArchLinux Based BlackArch Template +----------------------------------------- + +1. Create ArchlLinux Template + + - Follow the [Archlinux Template instructions](/doc/templates/archlinux/) + + +2. Update Template + + sudo pacman -Syyu + +3. Clone template + + 1. Via Qubes VM Manager + + 2. Via command line + + qvm-clone archlinux blackarch + +4. Install BlackArch repository + + $ curl -O https://blackarch.org/strap.sh + + # The SHA1 sum should match: 34b1a3698a4c971807fb1fe41463b9d25e1a4a09 + $ sha1sum strap.sh + + # Set execute bit + $ chmod +x strap.sh + + # Run strap.sh + $ sudo ./strap.sh + +5. Install tools + + - install all tools + + sudo pacman -S blackarch + + - or by category: + + # list available categories + pacman -Sg | grep blackarch + + # install category + sudo pacman -S blackarch- + + # example + sudo pacman -S blackarch-forensic + + - or specific tool + + # Search for tool + pacman -Ss + + # Install tool + sudo pacman -S + + # Example + pacman -Ss burpsuite + sudo pacman -S burpsuite + +6. Create a AppVMs based on the `blackarch` template + + - (Optional) Attach necessary devices + +Alternative Options to BlackArch +-------------------------------- + +- [Kali](/doc/pentesting/kali/) +- [PenTester Framework (PTF)](/doc/pentesting/ptf/) +- [Pentesting](/doc/pentesting/) diff --git a/managing-os/pentesting/kali.md b/managing-os/pentesting/kali.md new file mode 100644 index 0000000..08e0336 --- /dev/null +++ b/managing-os/pentesting/kali.md @@ -0,0 +1,616 @@ +--- +layout: doc +title: How to create a Kali Linux VM +permalink: /doc/pentesting/kali/ +redirect_from: +- /doc/kali/ +--- + +# How to create a Kali Linux VM + +## Warnings + +- The installation scripts and provided tools may have bugs, be vulnerable to Man in the Middle (MitM) attacks or other vulnerabilities. + +- Adding additional repositories or tools for installing software extends your trust to those tool providers. + +- Please keep in mind that using such a VM or VM's based on the template for security and privacy critical tasks is not recommended. + +- Kali Linux distribution is a rolling distribution based constantly on Debian testing release, so it always will have newer software base than available in Qubes OS debian template. Keep in mind that it may result in problems (especially in regard to package dependency) not covered by this tutorial. + + +## Qubes 3.2 + +### How to Create a Kali Linux VM + +This guide is being created to give guidance on ways in which you could create a [Kali Linux][kali] penetration testing VM (qube) in Qubes OS. + +Kali Linux is the most widely used penetration testing Linux distribution. + +There are multiple ways to create a Kali Linux VM: + + 1. Create a HVM and use the official ISO to install the system or convert a [Virtual Image][kali-vbox]. Explained [here](#hvm3_2). + 2. Clone the Qubes OS latest Debian template image and turn it into a Kali Linux distribution: + - using [katoolin]. Explained [here](#katoolin3_2). + - manually. Explained [here](#templatevm-from-debian3_2). + +### Kali Linux HVM + +1. Download the Kali installation DVD + +2. Create a new HVM + +3. Start the HVM with attached CD/DVD + + [user@dom0 ~]$ qvm-start --cdrom :/home/user/Downloads/.iso + +### Debian based Kali Template with Katoolin + +**Note:** The prompt on each line indicates where each command should be entered (`@dom0`, `@debian-` or `@kali`). + +1. (Optional) Check for latest Debian stable template and install it (if not already done) + + [user@dom0 ~]$ sudo qubes-dom0-update --action="search all" qubes-template-debian + [user@dom0 ~]$ sudo qubes-dom0-update + +2. Start, update and close your latest Debian template + + [user@dom0 ~]$ qvm-start debian- + [user@dom0 ~]$ qvm-run -a debian- gnome-terminal + [user@debian- ~]$ sudo apt-get update + [user@debian- ~]$ sudo apt-get upgrade + [user@dom0 ~]$ qvm-shutdown debian- + +3. Clone `debian-` template (two options) + + 1. Via Qubes VM Manager + + ![Clone Debian Template](/attachment/wiki/Kali/clone-kali.png) + + 2. Via command line + + [user@dom0 ~]$ qvm-clone debian- kali + +4. Check the name of currently used repository in `/etc/apt/sources.list` and current testing [Debian release][Debian-releases]. Update repository list accordingly + + [user@kali ~]$ sudo sed -i 's///g' /etc/apt/sources.list + [user@kali ~]$ sudo sed -i 's///g' /etc/apt/sources.list.d/qubes-r.list + + e.g. in this example we update `stretch` stable repository to `buster` testing repository + + [user@kali ~]$ sudo sed -i 's/stretch/buster/g' /etc/apt/sources.list + [user@kali ~]$ sudo sed -i 's/stretch/buster/g' /etc/apt/sources.list.d/qubes-r.list + +5. Upgrade `kali` template to latest Debian testing release + + [user@kali ~]$ sudo apt-get update + [user@kali ~]$ sudo apt-get dist-upgrade + [user@kali ~]$ sudo apt-get autoremove + + **Note:** During execution of a `dist-upgrade` command read carefully list of packages to be removed. + If it contains `qubes-*` packages, terminate operation and try to resolve `qubes-*` packages missing dependencies first. + +6. Install Katoolin and add Kali Linux repositories + + 1. Install Katoolin + + [user@kali ~]$ sudo apt-get install git + [user@kali ~]$ git clone https://github.com/LionSec/katoolin.git + [user@kali ~]$ sudo cp katoolin/katoolin.py /usr/bin/katoolin + [user@kali ~]$ sudo chmod +x /usr/bin/katoolin + [user@kali ~]$ rm -rf katoolin + + 2. Add Kali Linux repositories + + - start katoolin + + [user@kali ~]$ sudo katoolin + + - select 'Add Kali repositories & Update' + + 1) Add Kali repositories & Update + 2) View Categories + 3) Install classicmenu indicator + 4) Install Kali menu + 5) Help + + kat > 1 + + ![Add Kali repositories and Update menu](/attachment/wiki/Kali/katoolin-add-update-repo-menu.png) + + - select 'Add kali linux repositories' + + 1) Add kali linux repositories + 2) Update + 3) Remove all kali linux repositories + 4) View the contents of sources.list file + + What do you want to do ?> 1 + + ![Add Kali repositories](/attachment/wiki/Kali/katoolin-add-repos-menu.png) + + - update Kali repositories + + + 1) Add kali linux repositories + 2) Update + 3) Remove all kali linux repositories + 4) View the contents of sources.list file + + What do you want to do ?> 2 + + - quit katoolin by pressing `CRTL` + `c` keys + + What do you want to do ?> ^CShutdown requested...Goodbye... + +7. Clean up and update `kali` template + + [user@kali ~]$ sudo apt-get dist-upgrade + [user@kali ~]$ sudo apt-get autoremove + +8. Shutdown and trim `kali` template + + - Shutdown `kali` template + + [user@kali ~]$ sudo shutdown -h now + + - In `dom0` console: + + [user@dom0 ~]$ qvm-trim-template kali + +9. Start image + + [user@dom0 ~]$ qvm-start kali + +10. Install tools + + **Note** [Resize the template disk image][qubes-resize-disk-image] to at least 20GB if you plan on installing all packages from Kali distribution. + + 1. View Categories + + - start katoolin + + [user@kali ~]$ sudo katoolin + + - select `2) View Categories` + + 2. Select the categories/tools you want to install + + - For more information on how to use Katoolin see [How to Auto Install All Kali Linux Tools Using “Katoolin” on Debian/Ubuntu][katoolin-howto]. + + - **Note:** The `all` option does not work for `Information Gathering`, `Web Apps`, `Forensic Tools`, `Reverse Engineering` and `Extra`. + +11. Create a AppVMs based on the `kali` template + + - (Optional) Attach necessary devices + +### Kali Linux TemplateVM from a Debian template + +This section will explain how to create your own [Kali] Linux TemplateVM based +on a current stable Debian TemplateVM. The basic idea is to personalize the +template with all the tools needed, and then spin up isolated AppVMs based on +the template. + +The steps can be summarised as: + +1. Install Qubes stable Debian template +2. Upgrade the template to Debian testing release +3. Install Kali Linux through the ``kali-linux-full`` package +4. Use the template to build AppVM so that you can maintain isolation between + e.g. pentesting jobs + +#### Get Kali Linux GPG key + +**CAUTION:** Before proceeding, please carefully read [On Digital Signatures and Key Verification][qubes-verifying-signatures]. +This website cannot guarantee that any PGP key you download from the Internet is authentic. +Always obtain a trusted key fingerprint via other channels, and always check any key you download against your trusted copy of the fingerprint. + +This step is required since by (security) default a TemplateVM do not have a +direct Internet connectivity. Users understanding the risks of enabling such +access can change this configuration in firewall settings for the TemplateVM. + +**Note:** The prompt on each line indicates where each command should be entered +(`@dom0`, `@kali-rolling`, `@xxxx-dvm` or `@debian-`). + +1. Retrive the Kali Linux GPG key using a DispVM. + + [user@xxxx-dvm ~]$ gpg --keyserver hkp://keys.gnupg.net --recv-key 44C6513A8E4FB3D30875F758ED444FF07D8D0BF6 + [user@xxxx-dvm ~]$ gpg --list-keys --with-fingerprint 44C6513A8E4FB3D30875F758ED444FF07D8D0BF6 + [user@xxxx-dvm ~]$ gpg --export --armor 44C6513A8E4FB3D30875F758ED444FF07D8D0BF6 > kali-key.asc + +2. **DO NOT TURN OFF** the DispVM, the `kali-key.asc` file will be copied to + the Kali Linux template in a further step. + +3. Make sure the key is the authentic Kali key. + See the [Kali website] for further advice and instructions on verification. + +#### Create a Kali Linux (rolling) template + +These instructions will show you how to upgrade a Debian TemplateVM to Kali Linux. + +1. (Optional) Check for latest Debian stable template and install it (if not already done) + + [user@dom0 ~]$ sudo qubes-dom0-update --action="search all" qubes-template-debian + [user@dom0 ~]$ sudo qubes-dom0-update + +2. Start, update and close your latest Debian template + + [user@dom0 ~]$ qvm-start debian- + [user@dom0 ~]$ qvm-run -a debian- gnome-terminal + [user@debian- ~]$ sudo apt-get update + [user@debian- ~]$ sudo apt-get upgrade + [user@dom0 ~]$ qvm-shutdown debian- + +3. Clone `debian-X` template + + [user@dom0 ~]$ qvm-clone debian- kali-rolling + +4. Check the name of currently used repository in `/etc/apt/sources.list` and current testing [Debian release][Debian-releases]. Update repository list accordingly + + [user@kali-rolling ~]$ sudo sed -i 's///g' /etc/apt/sources.list + [user@kali-rolling ~]$ sudo sed -i 's///g' /etc/apt/sources.list.d/qubes-r.list + + e.g. in this example we update `stretch` stable repository to `buster` testing repository + + [user@kali-rolling ~]$ sudo sed -i 's/stretch/buster/g' /etc/apt/sources.list + [user@kali-rolling ~]$ sudo sed -i 's/stretch/buster/g' /etc/apt/sources.list.d/qubes-r.list + +5. Upgrade `kali-rolling` template to latest Debian testing release + + [user@kali-rolling ~]$ sudo apt-get update + [user@kali-rolling ~]$ sudo apt-get dist-upgrade + [user@kali-rolling ~]$ sudo apt-get autoremove + +**Note:** During execution of a `dist-upgrade` command read carefully list of packages to be removed. If it contains `qubes-*` packages, terminate operation and try to resolve `qubes-*` packages missing dependencies first. + +6. Copy the Kali GPG key from the DispVM to the new template: + + [user@xxxx-dvm ~]$ qvm-copy-to-vm kali-rolling kali-key.asc + + The DispVM can now be turned off. + +7. Add the Kali GPG key to the list of keys trusted to authenticate packages: + + [user@kali-rolling ~]$ cat /home/user/QubesIncoming/dispXXX/kali-key.asc | sudo apt-key add - + + This command should return `OK` on a line by itself. + +8. Attempt the upgrade process in the new template. + + [user@kali-rolling ~]$ sudo cat < /etc/apt/sources.list.d/kali.list + # Kali Linux repository + deb http://http.kali.org/kali kali-rolling main non-free contrib + EOF + [user@kali-rolling ~]$ sudo apt-get update + [user@kali-rolling ~]$ sudo apt-get dist-upgrade + [user@kali-rolling ~]$ sudo apt-get autoremove + +9. Shut down and trim the new template. + + [user@dom0 ~]$ qvm-shutdown kali-rolling + [user@dom0 ~]$ qvm-trim-template kali-rolling + +10. Ensure a terminal can be opened in the new template. + + [user@dom0 ~]$ qvm-run -a kali-rolling gnome-terminal + +#### Install the Kali tools + +At this point you should have a working template and you can install the tools you need. + +1. [Resize the template disk image][qubes-resize-disk-image] if you plan on installing the full Kali distribution. For example to install `kali-linux-full` you must **grow** the size of the VM system from 10GB to at least 20GB. + +2. Install Kali Linux tools: + + [user@kali-rolling ~]$ sudo apt-get install kali-linux-full + +3. (Optional) Customise the template's home directory (e.g. install your licensed copy of Burp Suite Professional) + +#### Use the template + +The template is ready to be used. You can now spin up AppVMs based on the `kali-rolling` template. + + +## Qubes 4.0 + +### How to Create a Kali Linux VM + +This guide is being created to give guidance on ways in which you could create a [Kali Linux][kali] penetration testing VM (qube) in Qubes OS. + +Kali Linux is the most widely used penetration testing Linux distribution. + +There are multiple ways to create a Kali Linux VM: + + 1. Create a HVM and use the official ISO to install the system or convert a [Virtual Image][kali-vbox]. Explained [here](#hvm4_0). + 2. Clone the Qubes OS latest Debian template image and turn it into a Kali Linux distribution: + - using [katoolin]. Explained [here](#katoolin4_0). + - manually. Explained [here](#templatevm-from-debian4_0). + +### Kali Linux HVM + +1. Download the Kali installation DVD + +2. Create a new HVM + +3. Start the HVM with attached CD/DVD + + [user@dom0 ~]$ qvm-start --cdrom :/home/user/Downloads/.iso + +### Debian based Kali Template with Katoolin + +**Note:** The prompt on each line indicates where each command should be entered (`@dom0`, `@debian-` or `@kali`). + +1. (Optional) Check for latest Debian stable template and install it (if not already done) + + [user@dom0 ~]$ sudo qubes-dom0-update --action="search all" qubes-template-debian + [user@dom0 ~]$ sudo qubes-dom0-update + +2. Start, update and close your latest Debian template + + [user@dom0 ~]$ qvm-start debian- + [user@dom0 ~]$ qvm-run -a debian- gnome-terminal + [user@debian- ~]$ sudo apt-get update + [user@debian- ~]$ sudo apt-get upgrade + [user@dom0 ~]$ qvm-shutdown debian- + +3. Clone `debian-` template (two options) + + 1. Via Qubes VM Manager + + ![Clone Debian Template](/attachment/wiki/Kali/clone-kali.png) + + 2. Via command line + + [user@dom0 ~]$ qvm-clone debian- kali + +4. Check the name of currently used repository in `/etc/apt/sources.list` and current testing [Debian release][Debian-releases]. Update repository list accordingly. + + [user@kali ~]$ sudo sed -i 's///g' /etc/apt/sources.list + [user@kali ~]$ sudo sed -i 's///g' /etc/apt/sources.list.d/qubes-r.list + + e.g. in this example we update `stretch` stable repository to `buster` testing repository + + [user@kali ~]$ sudo sed -i 's/stretch/buster/g' /etc/apt/sources.list + [user@kali ~]$ sudo sed -i 's/stretch/buster/g' /etc/apt/sources.list.d/qubes-r.list + +5. Upgrade `kali` template to latest Debian testing release + + [user@kali ~]$ sudo apt-get update + [user@kali ~]$ sudo apt-get dist-upgrade + [user@kali ~]$ sudo apt-get autoremove + + **Note:** During execution of a `dist-upgrade` command read carefully list of packages to be removed. + If it contains `qubes-*` packages, terminate operation and try to resolve `qubes-*` packages missing dependencies first. + +6. Install Katoolin and add Kali Linux repositories + + 1. Install Katoolin + + [user@kali ~]$ sudo apt-get install git + [user@kali ~]$ git clone https://github.com/LionSec/katoolin.git + [user@kali ~]$ sudo cp katoolin/katoolin.py /usr/bin/katoolin + [user@kali ~]$ sudo chmod +x /usr/bin/katoolin + [user@kali ~]$ rm -rf katoolin + + 2. Add Kali Linux repositories + + - start katoolin + + [user@kali ~]$ sudo katoolin + + - select 'Add Kali repositories & Update' + + 1) Add Kali repositories & Update + 2) View Categories + 3) Install classicmenu indicator + 4) Install Kali menu + 5) Help + + kat > 1 + + ![Add Kali repositories and Update menu](/attachment/wiki/Kali/katoolin-add-update-repo-menu.png) + + - select 'Add kali linux repositories' + + 1) Add kali linux repositories + 2) Update + 3) Remove all kali linux repositories + 4) View the contents of sources.list file + + What do you want to do ?> 1 + + ![Add Kali repositories](/attachment/wiki/Kali/katoolin-add-repos-menu.png) + + - update Kali repositories + + + 1) Add kali linux repositories + 2) Update + 3) Remove all kali linux repositories + 4) View the contents of sources.list file + + What do you want to do ?> 2 + + - quit katoolin by pressing `CRTL` + `c` keys + + What do you want to do ?> ^CShutdown requested...Goodbye... + +7. Clean up and update `kali` template + + [user@kali ~]$ sudo apt-get dist-upgrade + [user@kali ~]$ sudo apt-get autoremove + +8. Install tools + + **Note** [Resize the template disk image][qubes-resize-disk-image] to at least 20GB if you plan on installing all packages from Kali distribution. + + 1. View Categories + + - start katoolin + + [user@kali ~]$ sudo katoolin + + - select `2) View Categories` + + 2. Select the categories/tools you want to install + + - For more information on how to use Katoolin see [How to Auto Install All Kali Linux Tools Using “Katoolin” on Debian/Ubuntu][katoolin-howto]. + + - **Note:** The `all` option does not work for `Information Gathering`, `Web Apps`, `Forensic Tools`, `Reverse Engineering` and `Extra`. + +9. Create a AppVMs based on the `kali` template + + - (Optional) Attach necessary devices + +### Kali Linux TemplateVM from a Debian template + +This section will explain how to create your own [Kali] Linux TemplateVM based +on a current stable Debian TemplateVM. The basic idea is to personalize the +template with all the tools needed, and then spin up isolated AppVMs based on +the template. + +The steps can be summarised as: + +1. Install Qubes stable Debian template +2. Upgrade the template to Debian testing release +3. Install Kali Linux through the ``kali-linux-full`` package +4. Use the template to build AppVM so that you can maintain isolation between + e.g. pentesting jobs + +#### Get Kali Linux GPG key + +**CAUTION:** Before proceeding, please carefully read [On Digital Signatures and Key Verification][qubes-verifying-signatures]. +This website cannot guarantee that any PGP key you download from the Internet is authentic. +Always obtain a trusted key fingerprint via other channels, and always check any key you download against your trusted copy of the fingerprint. + +This step is required since by (security) default a TemplateVM do not have a +direct Internet connectivity. Users understanding the risks of enabling such +access can change this configuration in firewall settings for the TemplateVM. + +**Note:** The prompt on each line indicates where each command should be entered +(`@dom0`, `@kali-rolling`, `@xxxx-dvm` or `@debian-`). + +1. Retrive the Kali Linux GPG key using a DispVM. + + [user@xxxx-dvm ~]$ gpg --keyserver hkp://keys.gnupg.net --recv-key 44C6513A8E4FB3D30875F758ED444FF07D8D0BF6 + [user@xxxx-dvm ~]$ gpg --list-keys --with-fingerprint 44C6513A8E4FB3D30875F758ED444FF07D8D0BF6 + [user@xxxx-dvm ~]$ gpg --export --armor 44C6513A8E4FB3D30875F758ED444FF07D8D0BF6 > kali-key.asc + +2. **DO NOT TURN OFF** the DispVM, the `kali-key.asc` file will be copied to + the Kali Linux template in a further step. + +3. Make sure the key is the authentic Kali key. + See the [Kali website] for further advice and instructions on verification. + +#### Create a Kali Linux (rolling) template + +These instructions will show you how to upgrade a Debian TemplateVM to Kali Linux. + +1. (Optional) Check for latest Debian stable template and install it (if not already done) + + [user@dom0 ~]$ sudo qubes-dom0-update --action="search all" qubes-template-debian + [user@dom0 ~]$ sudo qubes-dom0-update + +2. Start, update and close your latest Debian template + + [user@dom0 ~]$ qvm-start debian- + [user@dom0 ~]$ qvm-run -a debian- gnome-terminal + [user@debian- ~]$ sudo apt-get update + [user@debian- ~]$ sudo apt-get upgrade + [user@dom0 ~]$ qvm-shutdown debian- + +3. Clone `debian-X` template + + [user@dom0 ~]$ qvm-clone debian- kali-rolling + +4. Check the name of currently used repository in `/etc/apt/sources.list` and current testing [Debian release][Debian-releases]. Update repository list accordingly + + [user@kali-rolling ~]$ sudo sed -i 's///g' /etc/apt/sources.list + [user@kali-rolling ~]$ sudo sed -i 's///g' /etc/apt/sources.list.d/qubes-r.list + + e.g. in this example we update `stretch` stable repository to `buster` testing repository + + [user@kali-rolling ~]$ sudo sed -i 's/stretch/buster/g' /etc/apt/sources.list + [user@kali-rolling ~]$ sudo sed -i 's/stretch/buster/g' /etc/apt/sources.list.d/qubes-r.list + +5. Upgrade `kali-rolling` template to latest Debian testing release + + [user@kali-rolling ~]$ sudo apt-get update + [user@kali-rolling ~]$ sudo apt-get dist-upgrade + [user@kali-rolling ~]$ sudo apt-get autoremove + +**Note:** During execution of a `dist-upgrade` command read carefully list of packages to be removed. If it contains `qubes-*` packages, terminate operation and try to resolve `qubes-*` packages missing dependencies first. + +6. Copy the Kali GPG key from the DispVM to the new template: + + [user@xxxx-dvm ~]$ qvm-copy kali-key.asc + + The DispVM can now be turned off. + +7. Add the Kali GPG key to the list of keys trusted to authenticate packages: + + [user@kali-rolling ~]$ cat /home/user/QubesIncoming/dispXXX/kali-key.asc | sudo apt-key add - + + This command should return `OK` on a line by itself. + +8. Attempt the upgrade process in the new template. + + [user@kali-rolling ~]$ sudo cat < /etc/apt/sources.list.d/kali.list + # Kali Linux repository + deb http://http.kali.org/kali kali-rolling main non-free contrib + EOF + [user@kali-rolling ~]$ sudo apt-get update + [user@kali-rolling ~]$ sudo apt-get dist-upgrade + [user@kali-rolling ~]$ sudo apt-get autoremove + +9. Ensure a terminal can be opened in the new template. + + [user@dom0 ~]$ qvm-run -a kali-rolling gnome-terminal + +#### Install the Kali tools + +At this point you should have a working template and you can install the tools you need. + +1. [Resize the template disk image][qubes-resize-disk-image] if you plan on installing the full Kali distribution. For example to install `kali-linux-full` you must **grow** the size of the VM system from 10GB to at least 20GB. + +2. Install Kali Linux tools: + + [user@kali-rolling ~]$ sudo apt-get install kali-linux-full + +3. (Optional) Customise the template's home directory (e.g. install your licensed copy of Burp Suite Professional) + +#### Use the template + +The template is ready to be used. You can now spin up AppVMs based on the `kali-rolling` template. + + +### Alternative Options to Kali Linux + + * [PenTester Framework][PTF], with [PTF Qubes OS guide][qubes-ptf] + * BlackArch Linux, with [BA Qubes OS guide][qubes-blackarch] + * [KATOOLIN][katoolin-howto] + * more on the [Penetration Testing page][qubes-pentesting] + + +## Notes + +Thanks to the people in [the discussion thread](https://github.com/QubesOS/qubes-issues/issues/1981). + +[qubes-verifying-signatures]: /security/verifying-signatures/ +[qubes-pentesting]: /doc/pentesting/ +[qubes-blackarch]: /doc/pentesting/blackarch/ +[qubes-ptf]: /doc/pentesting/ptf/ +[qubes-template-debian-install]: /doc/templates/debian/#install +[qubes-resize-disk-image]: /doc/resize-disk-image/ + +[kali]: https://www.kali.org/ +[kali-vbox]: https://www.offensive-security.com/kali-linux-vmware-virtualbox-image-download/ +[kali website]: https://docs.kali.org/introduction/download-official-kali-linux-images + +[PTF]: https://www.trustedsec.com/may-2015/new-tool-the-pentesters-framework-ptf-released/ + +[katoolin]: https://github.com/LionSec/katoolin +[katoolin-howto]: http://www.tecmint.com/install-kali-linux-tools-using-katoolin-on-ubuntu-debian/ + +[Debian-releases]: https://www.debian.org/releases/ + diff --git a/managing-os/pentesting/ptf.md b/managing-os/pentesting/ptf.md new file mode 100644 index 0000000..badc085 --- /dev/null +++ b/managing-os/pentesting/ptf.md @@ -0,0 +1,121 @@ +--- +layout: doc +title: How to create Penetration Testers Framework (PTF) VM +permalink: /doc/pentesting/ptf/ +redirect_from: +- /doc/ptf/ +--- + +**General reminder:** + +- The installation scripts and provided tools may have bugs, be vulnerable to Man in the Middle (MitM) attacks or other vulnerabilities. + +- Adding additional repositories or tools for installing software extends your trust to those tool providers. + +Please keep in mind that using such a VM or VM's based on the template for security and privacy critical tasks is not recommended. + +How to create Penetration Testers Framework (PTF) VM +==================================================== + +"The PenTesters Framework (PTF) is a Python script designed for Debian/Ubuntu/ArchLinux based distributions to create a similar and familiar distribution for Penetration Testing. + +PTF attempts to install all of your penetration testing tools (latest and greatest), compile them, build them, and make it so that you can install/update your distribution on any machine." (source [PTF Readme](https://github.com/trustedsec/ptf/blob/master/README.md)) + +**Note** PTF works on Debian testing as well as on Debian 8. PTF itself works with Debian 8, but the software tools will have missing dependencies. Metasploit for example requires a newer Ruby version than Debian 8 has in the repositories. Therefore the best way to install PTF is by upgrading a Debian 8 into Debian testing with additional Kali repositories. Instead of installing the tools from Kali, PTF will install and update the newest tools. + +Create Debian Based Penetration Testers Framework (PTF) Template +---------------------------------------------------------------- + +1. Create PTF template + + 1. Follow [Create Debian Based Kali Template](/doc/pentesting/kali/) till step 7. + + 2. (Optional) Rename the cloned template to `ptf` + +2. Download PTF + + sudo apt-get install git + cd /opt + sudo git clone https://github.com/trustedsec/ptf.git + + - (Optional) Configure PTF + + 1. Go to configuration directory + + cd /opt/ptf/config + + 2. Edit the configuration file + + for example by using vim: + + sudo vim ptf.config + + the configuration options are described in the `ptf.config` file + +3. Install PTF + + cd /opt/ptf + sudo ./ptf + + **Note:** the config file has to be in the same directory as the executable. It is not +possible to do sudo ptf/ptf + + PTF will put itself into `/usr/local/bin/ptf`. You can use `ptf` from now on. + +4. Install/Update modules (tools) + + 1. Start PTF + + sudo ptf + + ![PTF start banner](/attachment/wiki/PTF/ptf-banner.png) + + 2. Show available modules (tools) + + ptf> show modules + + 3. Install/Update modules (all/) + + - Install/Update all tools + + ptf> use modules/install_update_all + + - or by category Install/Update + + ptf> use modules/code-audit/install_update_all + + - or individually (example Metasploit) + + 1. Search for module + + ptf> search metasploit + [*] Search results below: + modules/exploitation/metasploit + + 2. Use module + + ptf> use modules/exploitation/metasploit + ptf:(modules/exploitation/metasploit)> + + 3. Install module + + ptf:(modules/exploitation/metasploit)>install + + 4. Run Metasploit + + ptf:(modules/exploitation/metasploit)>exit + ptf> quit + [*] Exiting PTF - the easy pentest platform creation framework. + sudo msfconsole + +5. Create an AppVM based on the `ptf` template + + - (Optional) Attach necessary devices + + +Alternative Options to PTF +-------------------------- + +- [BlackArch](/doc/pentesting/blackarch/) +- [Kali](/doc/pentesting/kali/) +- [Pentesting](/doc/pentesting/) diff --git a/managing-os/ubuntu.md b/managing-os/ubuntu.md new file mode 100644 index 0000000..91e9414 --- /dev/null +++ b/managing-os/ubuntu.md @@ -0,0 +1,41 @@ +--- +layout: doc +title: Ubuntu Template +permalink: /doc/templates/ubuntu/ +redirect_from: +- /doc/ubuntu/ +- /en/doc/templates/ubuntu/ +- /doc/Templates/Ubuntu/ +- /wiki/Templates/Ubuntu/ +--- + +Ubuntu template(s) +================== + +If you would like to use Ubuntu Linux distribution in your AppVMs, you can build and +install one of the available Ubuntu templates. These templates are currently not +available in ready to use binary packages, because Canonical does not allow +redistribution of a modified Ubuntu. The redistribution is not allowed by their +[Intellectual property rights policy](https://www.ubuntu.com/legal/terms-and-policies/intellectual-property-policy). + + +Install +------- + +It can be built using [Qubes Builder](/doc/qubes-builder/). You can also access its +documentation in the [source code +repository](https://github.com/QubesOS/qubes-builder/blob/master/README.md). + +To quickly prepare the builder configuration, you can use the `setup` script +available in the repository - it will interactively ask you which templates you +want to build. + +The build for Ubuntu 14.04 LTS (Trusty) should be straightforward. + +The build for Ubuntu 16.04 LTS (Xenial) is straightforward. Note that packages perl-Digest-MD5 and perl-Digest-SHA are required for the build to succeed. + + +---------- + +If you want to help in improving the template, feel free to +[contribute](/doc/contributing/). diff --git a/managing-os/windows/windows-tools.md b/managing-os/windows/windows-tools.md new file mode 100644 index 0000000..19aea38 --- /dev/null +++ b/managing-os/windows/windows-tools.md @@ -0,0 +1,158 @@ +--- +layout: doc +title: Qubes Windows Tools +permalink: /doc/windows-tools/ +redirect_from: +- /doc/windows-appvms/ +- /en/doc/windows-appvms/ +- /doc/WindowsAppVms/ +- /wiki/WindowsAppVms/ +--- + +Qubes Windows Tools +=================== + +Qubes Windows Tools are a set of programs and drivers that provide integration of Windows AppVMs with the rest of the Qubes system. Currently the following features are available for Windows VMs after installation of those tools: + +- Seamless GUI mode that integrates apps windows onto the common Qubes trusted desktop +- Support for [secure clipboard copy/paste](/doc/copy-paste/) between the Windows VM and other AppVMs +- Support for [secure file exchange](/doc/copying-files/) between the Windows VM and other AppVMs +- Support for qvm-run and generic qrexec for the Windows VM (e.g. ability to run custom service within/from the Windows VM) +- Xen PV drivers for Windows that increase performance compared to qemu emulated devices + +Qubes Windows Tools are open source and are distributed under a GPL license. + +NOTES: +- Qubes Windows Tools are currently unmaintained +- Currently only 64-bit versions of Windows 7 are supported by Qubes Windows Tools. Only emulated SVGA GPU is supported (although [there has been reports](https://groups.google.com/forum/#!topic/qubes-users/cmPRMOkxkdA) on working GPU passthrough). +- There is currently no audio support for Windows HVMs. +- There is currently no USB pass-through support for Windows HVMs. +- __This page documents the process of installing Qubes Windows Tools on versions up to R3.2.__. Installation on Qubes R4.0 is possible but is a work in progress and there are limitations/bugs (see [issue #3585](https://github.com/QubesOS/qubes-issues/issues/3585)). + + +Installing Windows OS in a Qubes VM +----------------------------------- + +Please refer to [this page](/doc/windows-vm/) for instructions on how to install Windows in a Qubes VM. + +NOTE: It is strongly suggested to enable autologon for any Windows HVMs that will have Qubes Tools installed. To do so, run `netplwiz` command from the `Win+R`/Start menu and uncheck the *Users must enter a user name and password to use this computer* option. + +Installing Qubes guest tools in Windows 7 VMs +--------------------------------------------- + +First, make sure that `qubes-windows-tools` is installed in your system: + +~~~ +sudo qubes-dom0-update qubes-windows-tools +~~~ + +(If the above command does not work, it could be that the Qubes Tools are not in the stable repo yet. Try installing from the testing repo instead.) + +You can also install the package from testing repositories, where we usually publish new versions first: + +~~~ +sudo qubes-dom0-update --enablerepo=qubes-dom0-current-testing qubes-windows-tools +~~~ + +This package brings the ISO with Qubes Windows Tools that is passed to the VM when `--install-windows-tools` is specified for the `qvm-start` command. Please note that none of this software ever runs in Dom0 or any other part of the system except for the Windows AppVM in which it is to be installed. + +Before proceeding with the installation we need to disable Windows mechanism that allows only signed drivers to be installed, because currently (beta releases) the drivers we provide as part of the Windows Tools are not digitally signed with a publicly recognizable certificate. To do that: + +- Start command prompt as Administrator, i.e. right click on the Command Prompt icon (All Programs -> Accessories) and choose "Run as administrator" +- In the command prompt type `bcdedit /set testsigning on` +- Reboot your Windows VM + +In the future this step will not be necessary anymore, because we will sign our drivers with a publicly verifiable certificate. However, it should be noted that even now, the fact that those drivers are not digitally signed, this doesn't affect security of the Windows VM in 'any' way. This is because the actual installation ISO (the `qubes-windows-tools-*.iso` file) is distributed as a signed RPM package and its signature is verified by the `qubes-dom0-update` utility once it's being installed in Dom0. The only downside of those drivers not being signed is the inconvenience to the user that he or she must disable the signature enforcement policy before installing the tools. + +To install the Qubes Windows Tools in a Windows VM one should start the VM passing the additional option `--install-windows-tools`: + +~~~ +qvm-start lab-win7 --install-windows-tools +~~~ + +Once the Windows VM boots, a CDROM should appear in the 'My Computer' menu (typically as `D:`) with a setup program in its main directory. + +After successful installation, the Windows VM must be shut down and started again, possibly a couple of times. + +Qubes will automatically detect the tools has been installed in the VM and will set appropriate properties for the VM, such as `qrexec_installed`, `guiagent_installed`, and `default_user`. This can be verified (but is not required) using qvm-prefs command: + +~~~ +qvm-prefs +~~~ + +NOTE: it is recommended to increase the default value of Windows VM's `qrexec_timeout` property from 60 (seconds) to, for example, 300. During one of the first reboots after Windows Tools installation Windows user profiles are moved onto the private VM's virtual disk (private.img) and this operation can take some time. Moving profiles is performed in an early boot phase when qrexec is not yet running, so timeout may occur with the default value. To change the property use this command in dom0: + +~~~ +qvm-prefs -s qrexec_timeout 300 +~~~ + +Using Windows AppVMs in seamless mode +------------------------------------- + +Once you start a Windows-based AppVM with Qubes Tools installed, you can easily start individual applications from the VM (note the `-a` switch used here, which will auto-start the VM if it is not running): + +~~~ +qvm-run -a my-win7-appvm explorer.exe +~~~ + +![windows-seamless-4.png](/attachment/wiki/WindowsAppVms/windows-seamless-4.png) ![windows-seamless-1.png](/attachment/wiki/WindowsAppVms/windows-seamless-1.png) + +Also, the inter-VM services work as usual -- e.g. to request opening a document or URL in the Windows AppVM from another VM: + +~~~ +[user@work ~]$ qvm-open-in-vm work-win7 roadmap.pptx +~~~ + +~~~ +[user@work ~]$ qvm-open-in-vm work-win7 https://invisiblethingslab.com +~~~ + +... just like in the case of Linux AppVMs. Of course all those operations are governed by central policy engine running in Dom0 -- if the policy doesn't contain explicit rules for the source and/or target AppVM, the user will be asked whether to allow or deny the operation. + +Inter-VM file copy and clipboard works for Windows AppVMs the same way as for Linux AppVM (except that we don't provide a command line wrapper, `qvm-copy-to-vm` in Windows VMs) -- to copy files from Windows AppVMs just right-click on the file in Explorer, and choose: Send To-\> Other AppVM. + +To simulate CTRL-ALT-DELETE in the HVM (SAS, Secure Attention Sequence), press Ctrl-Alt-Home while having any window of this VM in the foreground. + +![windows-seamless-7.png](/attachment/wiki/WindowsAppVms/windows-seamless-7.png) + +Changing between seamless and full desktop mode +----------------------------------------------- + +You can switch between seamless and "full desktop" mode for Windows HVMs in their settings in Qubes Manager. The latter is the default. + +Using template-based Windows AppVMs +----------------------------------- + +Qubes allows HVM VMs to share a common root filesystem from a select Template VM, just as for Linux AppVMs. This mode is not limited to Windows AppVMs, and can be used for any HVM (e.g. FreeBSD running in a HVM). + +In order to create a HVM TemplateVM one can use the following command, suitably adapted: + +~~~ +qvm-create --class TemplateVM win7-x64-template --property virt_mode=HVM --property kernel='' -l green +~~~ + +... , set memory as appropriate, and install Windows OS (or other OS) into this template the same way as you would install it into a normal HVM -- please see instructions on [this page](/doc/hvm-create/). + +If you use this Template as it is, then any HVMs that use it will effectively be DisposableVMs - the User directory will be wiped when the HVN is closed down. + +If you want to retain the User directory between reboots, then it would make sense to store the `C:\Users` directory on the 2nd disk which is automatically exposed by Qubes to all HVMs. +This 2nd disk is backed by the `private.img` file in the AppVMs' and is not reset upon AppVMs reboot, so the user's directories and profiles would survive the AppVMs reboot, unlike the "root" filesystem which will be reverted to the "golden image" from the Template VM automatically. +To facilitate such separation of user profiles, Qubes Windows Tools provide an option to automatically move `C:\Users` directory to the 2nd disk backed by `private.img`. +It's a selectable feature of the installer, enabled by default. +If that feature is selected during installation, completion of the process requires two reboots: + +- The private disk is initialized and formatted on the first reboot after tools installation. It can't be done **during** the installation because Xen mass storage drivers are not yet active. +- User profiles are moved to the private disk on the next reboot after the private disk is initialized. +Reboot is required because the "mover utility" runs very early in the boot process so OS can't yet lock any files in there. +This can take some time depending on the profiles' size and because the GUI agent is not yet active dom0/Qubes Manager may complain that the AppVM failed to boot. +That's a false alarm (you can increase AppVM's default boot timeout using `qvm-prefs`), the VM should appear "green" in Qubes Manager shortly after. + +It also makes sense to disable Automatic Updates for all the template-based AppVMs -- of course this should be done in the Template VM, not in individual AppVMs, because the system-wide settings are stored in the root filesystem (which holds the system-wide registry hives). +Then, periodically check for updates in the Template VM and the changes will be carried over to any child AppVMs. + +Once the template has been created and installed it is easy to create AppVMs based on it: + +~~~ +qvm-create --hvm --template --label