Merge pull request #169 from GWeck/patch-1

Provide information on Windows under Qubes R4.1

docs/os/windows/windows-migrate41.md

@@ -0,0 +1,40 @@
+Migrating Windows VMs from Qubes R4.0 to R4.1
+=============================================
+
+For Windows 7, 10 and 11, there is a way to migrate backups created under Qubes R4.0 to R4.1. For this, the version of Qubes Windows Tools (QWT) 4.1-67, available from [tabit-pro/qubes-windows-tools-cross](https://github.com/tabit-pro/qubes-windows-tools-cross/releases), has to be installed under Qubes R4.0, selecting the option to install the Xen PV disk driver, which emulates SCSI disks. For template VMs, the option to move user profiles may be selected, too. Then, the backup may be created, and this backup can be restored under Qubes R4.1, resulting in a VM well integrated into Qubes R4.1. If `qvm-features <VMname> audio-model ich6` is set, Windows even will have audio, although for Windows 10 and 11 somewhat scratchy.
+ 
+While this is somewhat straightforward, things get difficult if QWT 4.0.1.3 was installed in the VM. Prior to installing version 4.1-67, the old version has to be removed, which can be quite tricky for Windows 10 and 11.
+
+Preparation for Windows 7
+-------------------------
+
+ - Uninstall QWT 4.0.1.3, using the standard procedure from the system control panel of Windows. This will most likely result in a crash.
+ - Restart Windows again, hitting the F8 key, select the restart menu, and there select a start in protected mode.
+ - The system will start gain, but in a rather useless way. Just shut it down, and reboot again.
+ - Now Windows will start normally. Check in the control panel, if there are any Xen drivers left. If so, uninstall them.
+ - In the Windows device manager, check if there is still a (probably non working) Xen PV disk device. If so, uninstall it. Otherwise, QWT 4.1-67 will not install.
+ - In the control panel, check again, if the Xen drivers are removed. A Xen Bus Package (version 8.2.1.8) may remain and cannot be removed, but does no harm. Any other Xen drivers should have disappeared.
+  
+Preparation for Windows 10 and 11
+---------------------------------
+
+ - First, be sure that the automatic repair function is disabled. In a command window, execute `bcdedit /set recoveryenabled NO`, and check that this worked by issuing the command `bcdedit`, without parameters, again.
+ - Now, uninstall QWT 4.0.1.3, using the Apps and Features function of Windows. This will most likely result in a crash.
+ - Restart Windows again, possibly two or three times, until repair options are offered. By hitting the F8 key, select the restart menu, and there select a start in protected mode (in German, it's option number 4).
+ - The system will start gain, but in a rather useless way. Just shut it down, and reboot again.
+ - Now Windows will start normally. Check in the Apps and Features display, if there are any Xen drivers left. If so, uninstall them.
+ - In the Windows device manager, check if there is still a (probably non working) Xen PV disk device. If so, uninstall it. Otherwise, QWT 4.1-67 will not install.
+ - In the Apps and Features display, check again, if the Xen drivers are removed. A Xen Bus Package (version 8.2.1.8) may remain and cannot be removed, but does no harm. Any other Xen drivers should have disappeared.
+  
+Transferring the Windows Qube
+-----------------------------
+
+- Now, finally, after one additional reboot, Qubes Windows Tools 4.1-67 can be installed.
+- After one more reboot, the backup for R4.1 may be created.
+- This backup can be installed in Qubes R4.1 and will (probably) work.
+ 
+The PV disk drivers used for migration can be removed after successful installation of the VM under Qubes R4.1. For this, the QWT installation has to be started, the option Change has to be selected, and the PV disk driver must be unselected. After completion, the VM has to be rebooted. For Windows 10 and 11, the VM will crash with the error INACCESSIBLE BOOT DEVICE, which can be repaired as described above.
+
+After successful uninstallation of the PV disk drivers, the disks will appear as QEMU ATA disks.
+
+:warning: **Caution:** This change may lead Windows to declare that the hardware has changed and that in consequence, the activation is no longer valid, possibly complaining that the use of the software is no longer lawful. It should be possible to reactivate the software if a valid product key is provided.

docs/os/windows/windows-tools.md

@@ -1,5 +1,4 @@
-:warning: *Some of the information below is outdated ; please read [this forum wiki post](https://forum.qubes-os.org/t/wip-windows-qwt-user-reports/9687) for up to date instructions and users feedback.
+:warning: *The content below describes Qubes Windows Tools installation in Qubes R4.0. The text has been updated to reflect the newer R4.1 release and QWT recent development. Please see [this updated document](https://github.com/Qubes-Community/Contents/blob/master/docs/os/windows/windows-tools41.md) for instructions for Qubes R4.1 and the updated version of Qubes Windows Tools.*
-The content below will eventually be updated to reflect the newer 4.1 release and QWT recent development (contributors welcome!)*
 
 Qubes Windows Tools
 ===================

docs/os/windows/windows-tools41.md

@@ -0,0 +1,288 @@
+Qubes Windows Tools
+===================
+
+Qubes Windows Tools (QWT) are a set of programs and drivers that provide integration of Windows 7, 10 and 11 Standalone, TemplateVMs and AppVMs with the rest of the Qubes system. They contain several components than can be enabled or disabled during installation:
+
+- **Shared components (required)** - common libraries used by QWT components
+- **Qubes Core Agent** - qrexec agent and services. Needed for proper integration with Qubes
+- **Qubes GUI Agent** - video driver and GUI agent that enable the seamless GUI mode that integrates windows apps onto the common Qubes trusted desktop (currently only for Windows 7)
+- **Disable UAC** - User Account Control may interfere with QWT and doesn't really provide any additional benefits in Qubes environment
+- **Clipboard sender/receiver** - Support for [secure clipboard copy/paste](https://www.qubes-os.org/doc/copy-paste/) between the Windows VM and other AppVMs
+- **File sender/receiver** - Support for [secure file exchange](https://www.qubes-os.org/doc/copying-files/) between the Windows VM and other AppVMs
+- **Copy/Edit in Disposable VM** - Support for editing files in DisposableVMs as well as for `qvm-run` and generic `qrexec` for the Windows VM (e.g. ability to run custom service within/from the Windows VM)
+- **Audio** - Audio support requires R4.1 and is available even without QWT installation if `qvm-features audio-model` is set as `ich6`
+- **Xen PV drivers** - drivers for the virtual hardware exposed by Xen for Windows that increase performance compared to QEMU emulated devices and are required for attaching USB devices
+   - Base Xen PV Drivers (required): paravirtual bus and interface drivers
+   - Xen PV Disk Drivers: paravirtual storage drivers
+   - Xen PV Network Drivers: paravirtual network drivers
+   - Move user profiles: user profile directory (`C:\users`) is moved to VM's private disk backed by `private.img file` in `dom0` (useful mainly for HVM templates).
+	
+	> **Note**: Xen PV disk drivers are not installed by default. This is because they seem to cause problems (BSOD = Blue Screen Of Death). We're working with upstream devs to fix this. *However*, the BSOD seems to only occur after the first boot and everything works fine after that. **Enable the drivers at your own risk** of course, but we welcome reports of success/failure in any case (backup your VM first!). With disk PV drivers absent `qvm-block` will not work for the VM, but you can still use standard Qubes inter-VM file copying mechanisms. On the other hand, the Xen PV drivers allow USB device access even without QWT installation if `qvm-features stubdom-qrexec` is set as `1`
+
+Below is a breakdown of the feature availability depending on the windows version:
+
+|             Feature                  |  Windows 7 x64 | Windows 10/11 x64 |
+| ------------------------------------ | :------------: | :---------------: |
+| Qubes Video Driver                   |        +       |         -         |
+| Qubes Network Setup                  |        +       |         +         |
+| Private Volume Setup (move profiles) |        +       |         +         |
+| File sender/receiver                 |        +       |         +         |
+| Clipboard Copy/Paste                 |        +       |         +         |
+| Application shortcuts                |        +       |         +         |
+| Copy/Edit in Disposable VM           |        +       |         +         |
+| Block device                         |        +       |         +         |
+| USB device                           |        +       |         +         |
+| Audio                                |        +       |         +         |
+
+Qubes Windows Tools are open source and are distributed under a GPL license.
+
+> **Notes:**
+> - Currently only 64-bit versions of Windows 7, 10 and 11 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).
+> - This page documents the process of installing Qubes Windows Tools in version **R4.1**.
+> - *In testing VMs only* it's probably a good idea to install a VNC server before installing QWT. If something goes very wrong with the Qubes gui agent, a VNC server should still allow access to the OS.
+
+
+Preparation
+-----------
+
+**Windows 7 only:** Before proceeding with the installation we need to disable the Windows mechanism that allows only signed drivers to be installed, because currently the Qubes video driver, available for Windows 7, provided as part of the Windows Tools are not digitally signed with a publicly recognizable certificate. To do that:
+
+ 1. Start the command prompt as Administrator, i.e. right click on the Command Prompt icon (All Programs -> Accessories) and choose "Run as administrator"
+ 2. In the command prompt type `bcdedit /set testsigning on`
+ 3. 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` file can be verified as described in step 3 below. 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.
+
+The Xen PV Drivers bundled with QWT are signed by a Linux Foundation certificate. Thus Windows 10 and 11 do not require this security mitigation.
+
+> **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 and, later on, updating a Windows installation, 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`: *(where `<VMname>` is the name of your Windows VM)*
+
+		[user@dom0 ~] $ qvm-prefs <VMname> qrexec_timeout 7200
+
+Installing Windows OS in a Qubes VM
+-----------------------------------
+
+Please refer to [this page](https://www.qubes-os.org/doc/windows-vm41.md/) 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 VMs
+-------------------------------------------
+
+This will allow you to install the Qubes Windows Tools on Windows 7, 10 and 11 both as a StandaloneVM as well as a Template VM and a corresponding AppVM. But some features are not available:
+
+> **Note:** Seamless mode is currently not available for windows 10 and 11. Please check the top of this document for the full feature availability breakdown.
+
+> **Note:** *Steps 1 through 4 are prelimnary and will be replaced once Qubes Windows Tools are made available in a Qubes repository. This is a workaround for installing the Qubes windows tools until the tools are available in the Qubes repositories.*
+
+ 1. Download the [Qubes Windows Tools installation disk](https://github.com/tabit-pro/qubes-windows-tools-cross/releases/download/v4.1.67/qubes-windows-tools-4.1.67.1.iso/) into some AppVM, e.g. *untrusted*.
+
+ 2. Download the [checksumfile](https://github.com/tabit-pro/qubes-windows-tools-cross/releases/download/v4.1.67/sha256sum.txt) into the same AppVM.
+ 
+ 3. Check the integrity of the file `qubes-windows-tools-4.1.67.1.iso` by comparing its hash checksum. This can be done using the `sha256sum` command in the AppVM like:
+        
+		[user@untrusted Downloads] $ sha256sum qubes-windows-tools-4.1.67.1.iso
+
+	and compare it to the value stored in the file `sha256sum.txt` for the `iso` file (**it has to exactly match for security reasons**). If it matches, feel free to continue the installation. If not, repeat the download to make sure it was not corrupted due to a network problem. If it keeps on not matching it might be an attacker attempting to do something nasty to your system -- *Ask for support.*
+
+ 4. Start the Windows qube attaching the `iso` file as a virtual CD-Rom drive *(where `<VMname>` is the name of your Windows VM and <AppVM> the name of the AppVM where you downloaded the installation `iso`)*
+
+		[user@dom0 ~] $ qvm-start <VMname> --cdrom=<AppVM>:/<PathToFile>/qubes-windows-tools-4.1.67.1.iso
+
+	Once the Windows VM boots, a CDROM should appear in the 'My Computer' menu (typically as `D:` or `E:`) with the setup program `qubes-tools-x64.msi` in its main directory.
+
+ 5. **Windows 7 only:** Rename the private disk `D:` to `Q:`. This can be done by starting the diskmanager and changing the drive letter:
+	
+	 - Start the 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 `diskmgmt.msc`
+	 - In the disk manager, select the volume `Private (D:)`
+	 - Select the option `Change Drive Letter and Path`
+	 - Select option `Change...`
+	 - Select the letter `Q`
+	 - Click `OK` in all still open windows of the disk manager and terminate it.
+
+ 6. Install Qubes Windows Tools by starting `qubes-tools-x64.msi` as administrator, optionally selecting the `Xen PV disk drivers`. For installation in a template, you should select `Move user profiles`. If during installation, the Xen driver requests a reboot, select "No" and let the installation continue - the system will be rebooted later.
+
+ 7. After successful installation, the Windows VM must be shut down and started again, possibly a couple of times. On each shutdown, wait until the VM is really stopped, i.e. Qubes shows no more activity.
+
+ 8. Qubes will automatically detect that the tools have 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 the `qvm-prefs` command  *(where `<VMname>` is the name of your Windows VM)*:
+
+	        [user@dom0 ~] $ qvm-prefs <VMname>
+
+ 	It is advisable to set some other parameters in order to enable audio and USB block device access, synchronize the Windows clock with the Qubes clock, and so on:
+	        
+	        [user@dom0 ~] $ qvm-features <VMname> audio-model ich9
+	        [user@dom0 ~] $ qvm-features <VMname> stubdom-qrexec 1
+	        [user@dom0 ~] $ qvm-features <VMname> timezone localtime
+
+	With the value `localtime` the dom0 `timezone` will be provided to virtual hardware, effectively setting the Windows clock to that of Qubes. With a digit value (negative or positive) the guest clock will have an offset (in seconds) applied relative to UTC.
+
+ 9. Reboot Windows. If the VM starts, but does not show any window then shutdown Windows from the Qube manager, wait until it has really stopped, and reboot Windows once more.
+ 
+ 10. Now the system should be up, with QWT running correctly.
+ 
+ 11. **Windows 7 only:** Optionally enable seamless mode on VM startup. This can be done by setting appropriate values in the Windows registry: 
+	
+	 - Start the 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 `regedit`
+	 - In the registry editor, position to the key `\HKEY_LOCAL_MACHINE\Software\Invisible Things Lab\Qubes Tools\`
+	 - Change the value `SeamlessMode` from 0 to 1
+	 - Position to the key `\HKEY_LOCAL_MACHINE\Software\Invisible Things Lab\Qubes Tools\qga\`
+	 - Change the value `SeamlessMode` from 0 to 1
+	 - Terminate the registry editor.
+	
+ 	 After the next boot, the VM will start in seamless mode.
+	
+	 If Windows is used in a TemplateVM / AppVM combination, this registry fix has to be applied to the TemplateVM, as the `HKLM` registry key belongs to the template-based part of the registry.
+	
+ 12. Lastly to enable file copy operations to a Windows VM the `default_user` property should be set the `<username>` that you use to login to the Windows VM. This can be done via the following command on a `dom0` terminal: *(where `<VMname>` is the name of your Windows VM)*
+	
+		`[user@dom0 ~] $ qvm-prefs <VMname> default_user <username>`
+  
+     > **Note:** If this property is not set or set to a wrong value, files copied to this VM are stored in the folder `C:\Windows\System32\config\systemprofile\Documents\QubesIncoming\<source_VM>`.
+	 > If the target VM is an AppVM, this has the consequence that the files are stored in the corresponding TemplateVM and so are lost on AppVM shutdown.
+
+Xen PV drivers and Qubes Windows Tools
+--------------------------------------
+
+Installing Xen's PV drivers in the VM will lower its resources usage when using network and/or I/O intensive applications, but *may* come at the price of system stability (although Xen's PV drivers on a Windows VM are usually very stable). They can be installed as an optional part of Qubes Windows Tools (QWT), which bundles Xen's PV drivers.
+
+> **Notes** about using Xen's VBD (storage) PV driver:
+> - **Windows 7:** Installing the driver requires a fully updated VM or else you'll likely get a BSOD ("Blue Screen Of Death") and a VM in a difficult to fix state. Updating Windows takes *hours* and for casual usage there isn't much of a performance between the disk PV driver and the default one; so there is likely no need to go through the lengthy Windows Update process if your VM doesn't have access to untrusted networks and if you don't use I/O intensive apps or attach block devices. If you plan to update your newly installed Windows VM it is recommended that you do so *before* installing Qubes Windows Tools.  Installing the driver will probably cause Windows 7 activation to become invalid, but the activation can be restored using the Microsoft telephone activation method. 
+> - The option to install the storage PV driver is disabled by default in Qubes Windows Tools 
+> - In case you already had QWT installed without the storage PV driver and you then updated the VM, you may then install the driver by again starting the QWT installer and selecting the change option.
+
+Using Windows AppVMs in seamless mode
+-------------------------------------
+
+> **Note:** This feature is only available for Windows 7
+
+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):
+
+~~~
+[user@dom0 ~] $ qvm-run -a my-win-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@dom0 ~] $ qvm-open-in-vm my-win-appvm roadmap.pptx
+
+[user@dom0 ~]$ qvm-open-in-vm my-win-appvm 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 an HVM TemplateVM, the type "TemplateVM" has to be selected on creating the VM. Then set memory as appropriate, and install the Windows OS (or any other OS) into this template the same way as you would install it into a normal HVM -- please see instructions on [this page](https://www.qubes-os.org/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 HVM 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. For Windows 7, it requires the private disk to be renamed to `Q:` before QWT installation (see above); for Windows 10 and 11, this renaming occurs during QWT installation automatically.
+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 the 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, by selecting the type "AppVM" and a suitable template.
+
+Installation logs
+-----------------
+
+If the install process fails or something goes wrong during it, include the installation logs in your bug report. They are created in the `%TEMP%` directory, by default `<user profile>\AppData\Local\Temp`. There are two text files, one small and one big, with names starting with `Qubes_Windows_Tools`.
+
+Uninstalling QWT is supported. After uninstalling you need to manually enable the DHCP Client Windows service, or set IP settings yourself to restore network access.
+
+Configuration
+-------------
+
+Various aspects of Qubes Windows Tools (QWT) can be configured through the registry. The main configuration key is located in `HKEY_LOCAL_MACHINE\SOFTWARE\Invisible Things Lab\Qubes Tools`. Configuration values set on this level are global to all QWT components. It's possible to override global values with component-specific keys, this is useful mainly for setting log verbosity for troubleshooting. Possible configuration values are:
+
+|**Name**|**Type**|**Description**|**Default value**|
+|:-------|:-------|:--------------|:----------------|
+|LogDir|String|Directory where logs are created|c:\\Program Files\\Invisible Things Lab\\Qubes Tools\\log|
+|LogLevel|DWORD|Log verbosity (see below)|2 (INFO)|
+|LogRetention|DWORD|Maximum age of log files (in seconds), older logs are automatically deleted|604800 (7 days)|
+
+Possible log levels:
+
+|**Level**|**Title**|**Description**|
+|:-----|:-----|:--------------|
+|1|Error|Serious errors that most likely cause irrecoverable failures|
+|2|Warning|Unexpected but non-fatal events|
+|3|Info|Useful information (default)|
+|4|Debug|Internal state dumps for troubleshooting|
+|5|Verbose|Trace most function calls|
+
+Debug and Verbose levels can generate large volume of logs and are intended for development/troubleshooting only.
+
+To override global settings for a specific component, create a new key under the root key mentioned above and name it as the executable name, without `.exe` extension.
+	
+Component-specific settings currently available:
+
+|**Component**|**Setting**|**Type**|**Description**|**Default value**|
+|:------------|:----------|:-------|:--------------|:----------------|
+|qga|DisableCursor|DWORD|Disable cursor in the VM. Useful for integration with Qubes desktop so you don't see two cursors. Can be disabled if you plan to use the VM through a remote desktop connection of some sort. Needs gui agent restart to apply change (locking OS/logoff should be enough since qga is restarted on desktop change).|1|
+
+Troubleshooting
+---------------
+
+If the VM is inaccessible (doesn't respond to qrexec commands, gui is not functioning), try to boot it in safe mode:
+
+-  `[user@dom0 ~] $ qvm-start --debug <VMname>`
+-  Enable boot options and select Safe Mode (method depends on the Windows version; optionally with networking)
+
+Safe Mode should at least give you access to logs (see above).
+
+**Please include appropriate logs when reporting bugs/problems.** Logs contain the QWT version. If the OS crashes (BSOD) please include the BSOD code and parameters in your bug report. The BSOD screen should be visible if you run the VM in debug mode (`qvm-start --debug vmname`). If it's not visible or the VM reboots automatically, try to start Windows in safe mode (see above) and 1) disable automatic restart on BSOD (Control Panel - System - Advanced system settings - Advanced - Startup and recovery), 2) check the system event log for BSOD events. If you can, send the `memory.dmp` dump file from `C:\Windows`.
+	
+Xen logs (`/var/log/xen/console/guest-*`) are also useful as they contain pvdrivers diagnostic output.
+
+If a specific component is malfunctioning, you can increase its log verbosity as explained above to get more troubleshooting information. Below is a list of components:
+
+|**Component**|**Description**|
+|:------------|:--------------|
+|qrexec-agent|Responsible for most communication with Qubes (dom0 and other domains), secure clipboard, file copying, qrexec services.|
+|qrexec-wrapper|Helper executable that's responsible for launching qrexec services, handling their I/O and vchan communication.|
+|qrexec-client-vm|Used for communications by the qrexec protocol.|
+|qga|Gui agent.|
+|QgaWatchdog|Service that monitors session/desktop changes (logon/logoff/locking/UAC...) and simulates SAS sequence (Ctrl-Alt-Del).|
+|qubesdb-daemon|Service for accessing Qubes configuration database.|
+|network-setup|Service that sets up network parameters according to VM's configuration.|
+|prepare-volume|Utility that initializes and formats the disk backed by `private.img` file. It's registered to run on next system boot during QWT setup, if that feature is selected (it can't run *during* the setup because Xen block device drivers are not yet active). It in turn registers move-profiles (see below) to run at early boot.|
+|relocate-dir|Utility that moves user profiles directory to the private disk. It's registered as an early boot native executable (similar to chkdsk) so it can run before any profile files are opened by some other process. Its log is in a fixed location: `C:\move-profiles.log` (it can't use our common logger library so none of the log settings apply).|
+
+Updates
+-------
+
+:warning: *Currently Qubes Windows Tools (QWT) are not yet available from the repositories.*
+	
+When we publish a new QWT version, it's usually pushed to the `current-testing` or `unstable` repository first. To use versions from current-testing, run this in dom0:
+
+	[user@dom0 ~] $ sudo qubes-dom0-update --enablerepo=qubes-dom0-current-testing qubes-windows-tools
+
+That command will download a new QWT `iso` file from the testing repository. It goes without saying that you should **backup your VMs** before installing anything from testing repos.

docs/os/windows/windows-vm.md

@@ -1,5 +1,4 @@
-:warning: *Some of the information below is outdated ; please read [this forum wiki post](https://forum.qubes-os.org/t/wip-windows-qwt-user-reports/9687) for up to date instructions and users feedback.
+:warning: *The content below describes Windows installation in Qubes R4.0. The text has been updated to reflect the newer R4.1 release and QWT recent development. Please see [this updated document](https://github.com/Qubes-Community/Contents/blob/master/docs/os/windows/windows-vm41.md) for instructions for Qubes R4.1.*
-The content below will eventually be updated to reflect the newer 4.1 release and QWT recent development (contributors welcome!)*
 
 Installing a Windows VM
 =======================

docs/os/windows/windows-vm41.md

@@ -0,0 +1,240 @@
+Installing a Windows VM
+=======================
+
+You can install Windows just like any other OS as an [HVM](https://www.qubes-os.org/doc/hvm/), if you just want something simple and you can live without some features. This works for Windows XP, 7, 10 and 11, and it may work for Windows 8 and 8.1, although this has not been tested.
+
+You will get an environment in which basic functions are supported, but integration into the Qubes environment is rather restricted. The following functions will work right out of the box:
+
+- display (1440x900 or 1280x1024 are a nice fit onto FHD hw display)
+- keyboard (incl. correct mapping), pointing device
+- network (emulated Realtek NIC)
+- audio output and input (available even without QWT installation if `qvm-features audio-model` is set as `ich6`)
+
+For better integration, a set of drivers and services, called Qubes Windows Tools (QWT) is available. Installation of these tools is straightforward and is described in a [separate document](https://www.qubes-os.org/doc/windows-tools41.md). QWT’s main features are:
+
+- copy/paste between qubes
+- copy files between qubes
+- attaching USB devices to the qube
+- attaching block devices to the qube (XEN PV disk driver must be installed)
+- automatically set up networking
+- automatically set up time/clock synchronization
+- XEN PV drivers (some of them optional)
+- optional user migration from `C:`: to the qubes’ private volume (to be able use the qubes as a TemplateVM).
+- seamless mode (Windows 7 only for now)
+- propagating keyboard layout ?
+
+Qubes R4.1 - importing a Windows VM from an earlier version of Qubes
+--------------------------------------------------------------------
+
+- Importing from R3.2 or earlier will not work, because  Qubes R3.2 has the old stubdomain by default and this is preserved over backup and restore (as Windows otherwise won't boot.
+
+- Importing from R4.0 should work, see [Migrate backups of Windows VMs created under Qubes R4.0 to R4.1](https://www.qubes-os.org/doc/windows-migrate41.md).
+
+
+Windows VM installation
+-----------------------
+
+### qvm-create-windows-qube ###
+
+An unofficial, third-party tool for automating this process is available [here](https://github.com/elliotkillick/qvm-create-windows-qube).
+(Please note that this tool has not been reviewed by the Qubes OS Project.
+Use it at your own risk.)
+However, if you are an expert or want to do it manually you may continue below.
+
+### Summary: Installing Windows via CLI ###
+
+~~~
+qvm-create --class StandaloneVM --label orange --property virt_mode=hvm WindowsNew
+qvm-prefs WindowsNew memory 4096
+qvm-prefs WindowsNew maxmem 4096
+qvm-prefs WindowsNew kernel ''
+qvm-prefs WindowsNew qrexec_timeout 7200
+qvm-volume extend WindowsNew:root 60g
+qvm-start --cdrom=untrusted:/home/user/windows_install.iso WindowsNew
+# restart after the first part of the windows installation process ends
+qvm-start WindowsNew
+# once Windows is installed and working
+as administrator in Windows, set: powercfg -H off
+~~~
+
+To install Qubes Windows Tools, follow instructions in [Qubes Windows Tools](https://www.qubes-os.org/doc/windows-tools41.md).
+
+### Detailed instructions ###
+
+> **Notes:**
+> - The instructions may work on other versions than Windows 7, 10 and 11 x64 but haven't been tested.
+> - Qubes Windows Tools (QWT) only supports Windows 7, 10 and 11 x64. For installation, see [Qubes Windows Tools](https://www.qubes-os.org/doc/windows-tools41.md).
+
+**Installation procedure:**
+
+- Have the Windows ISO image (preferrably the 64-bit version) downloaded in some qube.
+  Windows ISOs can be downloaded directly from Microsoft (eg. [here](https://www.microsoft.com/en-us/software-download/windows10ISO) for Win10), or selected and downloaded via the [Windows Media Creation Tool](https://go.microsoft.com/fwlink/?LinkId=691209). You should, however, regard the downloaded image to be untrustworthy, since there is no reliable way to check that the download was not somehow compromised (see the discussion in issue [Simplify Qubes Windows Tools Installation for R4.1 #7240](https://github.com/QubesOS/qubes-issues/issues/7240)).
+
+  Unofficial “debloated” ISOs from projects like reviOS 18 or ameliorated 10 can be found on the net, although obviously you should consider them even “unsafer” than MS provided ISOs. Alternatively, one could download an official ISO and run scripts/apply patches before installation. Some of the “tweaks” might end up being too much depending on the qube’s planned usage though (eg. no appx functionality in ameliorated windows - so the installation of Windows Store apps is impossible, even with powershell).
+
+- Create a VM named WindowsNew in [HVM](https://www.qubes-os.org/doc/hvm/) mode (Xen's current PVH limitations precludes from using PVH):
+
+  The Windows' installer requires a significant amount of memory or else the VM will crash with such errors:
+
+  `/var/log/xen/console/hypervisor.log`:
+
+  ~~~
+  p2m_pod_demand_populate: Dom120 out of PoD memory! (tot=102411 ents=921600 dom120)
+  (XEN) domain_crash called from p2m-pod.c:1218
+  (XEN) Domain 120 (vcpu#0) crashed on cpu#3:
+  ~~~
+
+  So, increase the VM's memory to 4096MB (memory = maxmem because we don't use memory balancing).
+
+  ~~~
+  qvm-prefs WindowsNew memory 4096
+  qvm-prefs WindowsNew maxmem 4096
+  ~~~
+
+  Disable direct boot so that the VM will go through the standard cdrom/HDD boot sequence:
+
+  ~~~
+  qvm-prefs WindowsNew kernel ''
+  ~~~
+
+  A typical Windows installation requires between 25GB up to 60GB of disk space depending on the version (Home/Professional/...). Windows updates also end up using significant space. So, extend the root volume from the default 10GB to at least 60GB (note: it is straightforward to increase the root volume size after Windows is installed: simply extend the volume again in dom0 and then extend the system partition with Windows's disk manager).
+
+  ~~~
+  qvm-volume extend WindowsNew:root 60g
+  ~~~
+
+  Finally, increase the VM's `qrexec_timeout`: in case you happen to get a BSOD or a similar crash in the VM, utilities like `chkdsk` won't complete on restart before `qrexec_timeout` automatically halts the VM. That can really put the VM in a totally unrecoverable state, whereas with higher `qrexec_timeout`, `chkdsk` or the appropriate utility has plenty of time to fix the VM. Note that Qubes Windows Tools also require a larger timeout to move the user profiles to the private volume the first time the VM reboots after the tools' installation.
+
+  ~~~
+  qvm-prefs WindowsNew qrexec_timeout 7200
+  ~~~
+  
+ In order to create the new qube, select the command Qube -> New Qube in the Qube Manager::
+  - Name: WindowsNew, Color: orange
+  - Standalone Qube not based on a template
+  - Networking: sys-firewall (default)
+  - Launch settings after creation: check
+  - Click "OK".
+- Settings:
+  - Basic:
+    - System storage: 60.0+ GB
+  - Advanced:
+    - Include in memory balancing: uncheck
+    - Initial memory: 4096+ MB
+    - Kernel: None
+    - Mode: HVM
+  - Click "Apply".
+  
+This can also be done via the following CLI commands in dom0:
+~~~
+qvm-create --class StandaloneVM --label orange --property virt_mode=hvm WindowsNew
+qvm-prefs WindowsNew memory 4096
+qvm-prefs WindowsNew maxmem 4096
+qvm-prefs WindowsNew kernel ''
+qvm-volume extend WindowsNew:root 60g
+~~~
+
+After creating the new qube, set its timeout value in dom0:
+~~~
+qvm-prefs WindowsNew qrexec_timeout 7200
+~~~
+
+The VM is now ready to be started; the best practice is to use an installation ISO [located in a VM](https://www.qubes-os.org/doc/standalone-and-hvm/#installing-an-os-in-an-hvm). Now boot the newly created qube from the Windows installation media. In the Qubes Manager:
+
+- Select the new qube, in this example "WindowsNew".
+- Switch to the "Advanced" tab.
+- Click "Boot from CDROM":
+  - "from file in qube":
+    - Select the qube that has the ISO.
+    - Select ISO by clicking "...".
+    - Click "OK" to boot into the windows installer.
+
+This can also be done via the following CLI command in dom0 (assuming that the Windows installer ISO is stored in the directory `/home/user/` in the AppVM `untrusted`:
+~~~
+qvm-start --cdrom=untrusted:/home/user/windows_install.iso WindowsNew
+~~~
+
+- Windows Installer:
+  - Mostly as usual, but automatic reboots will halt the qube - just restart it again and again until the installation is finished.
+  - Install on first disk.
+  - The Windows license may be read from flash via root in dom0:
+
+    `strings < /sys/firmware/acpi/tables/MSDM`
+
+    Alternatively, you can also try a Windows 7 license key (as of 2018/11
+    they are still accepted for a free upgrade to Windows 10).
+    
+- Afterwards:
+  - In case you switch from `sys-network` to `sys-whonix`, you'll need a static IP network configuration, DHCP won't work for `sys-whonix`.
+  - From the Windows command line, use `powercfg -H off` in order to avoid incomplete Windows shutdown, which could lead to corruption of the VM's disk. Also, recent versions of Windows won’t show the CD-ROM drive after starting the qube with `qvm-start vm --cdrom ...` (or using the GUI). The solution is to disable hibernation in Windows with this command. (That command is included in QWT’s setup but it’s necessary to run it manually in order to be able to open QWT’s setup ISO/CD-ROM in Windows).
+
+powercfg -H off
+
+  - Optionally use `disk cleanup` to save some disk space.
+
+Given the higher than usual memory requirements of Windows, you may get a `Not enough memory to start domain 'WindowsNew'` error. In that case try to shutdown unneeded VMs to free memory before starting the Windows VM.
+
+At this point you may open a tab in dom0 for debugging, in case something goes amiss:
+
+~~~
+tailf /var/log/qubes/vm-WindowsNew.log \
+   /var/log/xen/console/hypervisor.log \
+   /var/log/xen/console/guest-WindowsNew-dm.log
+~~~
+
+The VM will shutdown after the installer completes the extraction of Windows installation files. It's a good idea to clone the VM now (eg. `qvm-clone WindowsNew WindowsNewbkp1`). Then, (re)start the VM with `qvm-start WindowsNew`.
+
+The second part of Windows' installer should then be able to complete successfully.
+
+At that point you should have a functional and stable Windows VM, although without updates, Xen's PV drivers nor Qubes integration (see sections [Windows Update](#windows-update) and [Xen PV drivers and Qubes Windows Tools](https://www.qubes-os.org/doc/windows-tools41/#xen-pv-drivers-and-qubes-windows-tools)). It is a good time to clone the VM again.
+
+Again, don’t forget to `qvm-clone` your qube before you install Qubes Windows Tools (QWT) in case something goes south.
+
+**Post-install best practices**
+
+Optimize resources for use in virtual machine as “vanilla” version of Windows are bloated; e.g.:
+
+- set up Windows for best performance (this pc → advanced settings → …)
+- think about Windows’ page file: is it needed ? should you set it with a fixed size ? maybe on the private volume ?
+- investigate “debloat” scripts ; eg. Windows10Debloater 2, decrapifier, OOShutUp10 1, etc.
+- disable services you don’t need
+- disable networking stuff in the network adapter’s setting (eg. link discovery, file and print server, …)
+- background: set a solid color
+- …
+
+For additional information on configuring a Windows qube, see the [Customizing Windows 7 templates](https://www.qubes-os.org/doc/windows-template-customization/) page (despite the focus on preparing the VM for use as a template, most of the instructions are independent from how the VM will be used - ie. TemplateVM or StandaloneVM).
+
+
+Windows as TemplateVM
+---------------------
+
+Windows 7, 10 and 11 can be installed as TemplateVM by selecting
+~~~
+qvm-create --class TemplateVM --property virt_mode=HVM --property kernel='' --label black Windows-template
+~~~
+when creating the VM. To have the user data stored in AppVMs depending on this template, the option `Move User Profiles` has to be selected on installation of Qubes Windows Tools. For Windows 7, before installing QWT, the private disk `D:` has to be renamed to `Q:`, see the QWT installation documentation in [Qubes Windows Tools](https://www.qubes-os.org/doc/windows-tools41.md).
+
+AppVMs based on these templates can be created the normal way by using the Qube Manager or by specifying
+~~~
+qvm-create --class=AppVM --template=<VMname> 
+~~~
+
+On starting the AppVM, sometimes a message is displayed that the Xen PV Network Class needs to restart the system. This message can be safely ignored and closed by selecting "No".
+
+**Caution:** These AppVMs must not be started while the corresponding TemplateVM is running, because they share the TemplateVM's license data. Even if this could work sometimes, it would be a violation of the license terms.
+
+Windows 10 and 11 Usage According to GDPR
+-----------------------------------------
+
+If Windows 10 or 11 is used in the EU to process personal data, according to GDPR no automatic data transfer to countries outside the EU is allowed without explicit consent of the person(s) concerned, or other legal consent, as applicable. Since no reliable way is found to completely control the sending of telemetry from Windows 10 or 11, the system containing personal data must be completely shielded from the internet.
+
+This can be achieved by installing Windows 10 or 11 in a TemplateVM with the user data directory moved to a separate drive (usually `Q:`). Personal data must not be stored within the TemplateVM, but only in AppVMs depending on this TemplateVM. Network access by these AppVMs must be restricted to the local network and perhaps additional selected servers within the EU. Any data exchange of the AppVMs must be restricted to file and clipboard operations to and from other VMs in the same Qubes system.
+
+Windows update
+--------------
+
+Depending on how old your installation media is, fully updating your Windows VM may take *hours* (this isn't specific to Xen/Qubes) so make sure you clone your VM between the mandatory reboots in case something goes wrong. For Windows 7, you may find the necessary updates bundled at [WinFuture Windows 7 SP1 Update Pack 2.107 (Vollversion)](https://10gbit.winfuture.de/9Y6Lemoxl-I1_901xOu6Hg/1648348889/2671/Update%20Packs/2020_01/WinFuture_7SP1_x64_UpdatePack_2.107_Januar_2020-Vollversion.exe).
+
+Note: if you already have Qubes Windows Tools installed the video adapter in Windows will be "Qubes video driver" and you won't be able to see the Windows Update process when the VM is being powered off because Qubes services would have been stopped by then. Depending on the size of the Windows update packs it may take a bit of time until the VM shutdowns by itself, leaving one wondering if the VM has crashed or still finalizing the updates (in dom0 a changing CPU usage - eg. shown with `xentop` - usually indicates that the VM hasn't crashed).
+
+To avoid guessing the VM's state enable debugging (`qvm-prefs -s WindowsNew debug true`) and in Windows' device manager (My computer -> Manage / Device manager / Display adapters) temporarily re-enable the standard VGA adapter and disable "Qubes video driver". You can disable debugging and revert to Qubes' display once the VM is updated.