ElliotKillick/qvm-create-windows-qube

Qvm-Create-Windows-Qube

Spin up new Windows qubes quickly, effortlessly and securely

About

Qvm-Create-Windows-Qube is a tool for quickly and conveniently installing fresh new Windows qubes with Qubes Windows Tools (QWT) drivers automatically. It officially supports Windows 7, 8.1 and 10 as well as Windows Server 2008 R2, 2012 R2, 2016 and 2019.

The project emphasizes correctness, security and treating Windows as an untrusted guest operating system throughout the entire process. The installation takes place 100% air gapped and features optional Whonix integration on the finished Windows qube for added privacy.

It also features other niceties such as automatic installation of packages including Firefox, Office 365, Notepad++, Visual Studio and more using Chocolatey to get you up and running quickly in your new environment.

As featured on: Hacker News | Proudly ranked in the top 10 on the front page of Hacker News as well as first place for Show HN

Installation

1. Download the installation script by opening the link, right-clicking and then selecting "Save [Page] as..."
2. Copy install.sh into Dom0 by running the following command in Dom0:
   • qvm-run -p --filter-escape-chars --no-color-output <name_of_qube_script_is_located_on> "cat '/home/user/Downloads/install.sh'" > install.sh
   • Make sure to get all the single and double quotes
3. Review the code of install.sh to ensure its integrity
   • Safer with escape character filtering enabled in the previous step; qvm-run disables it by default when the output is a file
4. Run chmod +x install.sh && ./install.sh
   • Note that this will install packages in the global default TemplateVM, which is fedora-XX by default
5. Review the code of the resulting /usr/bin/qvm-create-windows-qube

Updating

To update Qvm-Create-Windows-Qube, start by simply deleting the windows-mgmt VM and main program by running the following command in Dom0:

qvm-remove -f windows-mgmt && sudo rm /usr/bin/qvm-create-windows-qube

Lastly, follow the installation steps above to reinstall.

Note that this will also delete any Windows ISOs that have already been downloaded. This may be desirable in the case that Microsoft has updated the Windows ISOs (meaning you should redownload them anyway). However, if you would like to avoid downloading any of the Windows ISOs again, simply navigate to /home/user/qvm-create-windows-qube/windows/isos in the windows-mgmt VM and copy its contents to another (preferably disposable) qube. After the reinstall is complete, copy those ISOs back into windows-mgmt at the aforementioned directory.

Usage

Usage: qvm-create-windows-qube [options] -i <iso> -a <answer file> <name>
  -h, --help
  -c, --count <number> Number of Windows qubes with given basename desired
  -t, --template Make this qube a TemplateVM instead of a StandaloneVM
  -n, --netvm <qube> NetVM for Windows to use
  -s, --seamless Enable seamless mode persistently across reboots
  -o, --optimize Optimize Windows by disabling unnecessary functionality for a qube
  -y, --spyless Configure Windows telemetry settings to respect privacy
  -w, --whonix Apply Whonix recommended settings for a Windows-Whonix-Workstation
  -p, --packages <packages> Comma-separated list of packages to pre-install (see available packages at: https://chocolatey.org/packages)
  -P, --pool <name> LVM storage pool to install Windows on (https://www.qubes-os.org/doc/secondary-storage/)
  -i, --iso <file> Windows media to automatically install and setup
  -a, --answer-file <xml file> Settings for Windows installation

Downloading Windows ISO

Mido (mido.sh) is the secure Microsoft Windows Downloader (for Unix), inspired by Fido from Rufus. It's capable of automating the download process for a few Windows ISOs that Microsoft has behind a gated download web interface. Mido is robust and securely downloads Windows ISOs to be used by Qvm-Create-Windows-Qube from official Microsoft servers. You can find it located at /home/user/qvm-create-windows-qube/windows/isos/mido.sh in windows-mgmt.

windows-mgmt is air gapped from the network. This means that in order to securely perform the download, one must copy the mido.sh script to another (disposable) qube followed by transferring the newly downloaded ISO(s) into windows-mgmt and placing them into the /home/user/qvm-create-windows-qube/windows/isos directory. Alternatively, windows-mgmt can temporarily be given network access, however, this isn't recommended for security reasons.

Once generated, Windows ISOs are cached in /home/user/qvm-create-windows-qube/windows/out for later use. If you download an updated ISO with Mido, then make sure to remove the same ISO from the aforementioned cache directory. This will cause the cache to be regenerated from the updated ISO.

For advanced readers: Qvm-Create-Windows-Qube takes a generic approach to handling ISOs that can work with any given Windows ISO. If you have your own Windows ISO you would like to use then likely only a very slight adjustment to the closest matching answer file (namely the /IMAGE/NAME key) would be needed to make it work. You can get the valid /IMAGE/NAME values for your ISO by parsing the install.wim inside using the wiminfo command (packaged as wimlib-utils on Fedora or wimtools on Debian) or from within Windows using Windows ADK.

Creating Windows VM

Important: Be sure to read the Qubes Windows Tools Known Issues section below for a small upstream issue.

Windows 10

Video demonstration

qvm-create-windows-qube -n sys-firewall -oyp firefox,notepadplusplus,office365proplus -i win10x64.iso -a win10x64-pro.xml work-win10

qvm-create-windows-qube -n sys-firewall -oyp steam -i win10x64.iso -a win10x64-pro.xml game-console

Windows Server 2019

qvm-create-windows-qube -n sys-firewall -oy -i win2019-eval.iso -a win2019-datacenter-eval.xml fs-win2019

Windows 10 Enterprise LTSC

• A more stable, minified, secure and private version of Windows 10 officially provided by Microsoft
• This version of Windows 10 is recommended for those who need the best in Windows security and privacy

qvm-create-windows-qube -n sys-firewall -oyp firefox,notepadplusplus,office365proplus -i win10x64-enterprise-ltsc-eval.iso -a win10x64-enterprise-ltsc-eval.xml work-win10

qvm-create-windows-qube -n sys-whonix -oyw -i win10x64-enterprise-ltsc-eval.iso -a win10x64-enterprise-ltsc-eval.xml anon-win10

Windows 7

• Not recommended because Windows 7 is no longer supported by Microsoft, however, it's the only desktop OS the Qubes GUI driver (in Qubes Windows Tools) supports if seamless window integration or dynamic resizing is required

Video demonstration

qvm-create-windows-qube -n sys-firewall -soyp firefox,notepadplusplus,office365proplus -i win7x64-ultimate.iso -a win7x64-ultimate.xml work-win7

Security

Qvm-Create-Windows-Qube is "reasonably secure" as Qubes would have it.

• windows-mgmt is air gapped
• The entirety of the Windows qube setup process is done air gapped
  • Exception: If (and only if) packages are configured for installation then Windows will be allowed access to the Internet at the very end of the Windows qube installation
• Entire class of command injection vulnerabilities eliminated in the Dom0 shell script by not letting it parse any output from the untrusted windows-mgmt qube
  • Only exit codes are passed by qvm-run; no variables
  • This also mitigates the fallout of another Shellshock Bash vulnerability
• Downloading of the Windows ISOs is made secure by enforcing:
  • ISOs are downloaded straight from Microsoft controlled subdomains of microsoft.com
  • HTTPS TLS 1.2/1.3
  • SHA-256 verification of the files after download
    • Each file is saved with the extension .UNVERIFIED until it's made certain that its checksum is a match
  • Mido is robust and very explicit (but also user friendly) so you can be sure any downloaded ISOs are authentic and untampered with
  • Mido is written in POSIX sh (the minimal Dash shell will be used if available) so interaction with Microsoft's gated download web interface is more secure
    • For more security, it could even be run in a POSIX-compliant Rust shell (e.g. nsh) with Rust coreutils (e.g. uutils). This is not the default configuration.
• Windows is treated as an untrusted guest operating system the entire way through
• The impact of any theoretical vulnerabilities in handling of the Windows ISO (e.g. vulnerability in filesystem parsing) or answer file is limited to windows-mgmt
• All commits by the maintainers are always signed with their respective PGP keys
  • Should signing ever cease, assume compromise
  • Current maintainer 1: Elliot Killick
    • PGP key: 018F B9DE 6DFA 13FB 18FB 5552 F9B9 0D44 F83D D5F2
  • Current maintainer 2: Frédéric Pierret (No Keybase account)
    • PGP key: 9FA6 4B92 F95E 706B F28E 2CA6 4840 10B5 CDC5 76E2
    • Mostly concerned with Qubes R4.1 support
      • See the release4.1 branch and qubes-mgmt-salt-windows-mgmt

Windows

Maintenance

Don't forget to apply any applicable updates upon creation of your Windows qube. Microsoft frequently builds up-to-date ISOs for current versions of Windows, such as Windows 10. For these Windows versions, it's recommended to periodically download the latest version using Mido to get a fresh Windows image out of the box.

Advisories

Windows 7 and Windows Server 2008 R2 reached end of life (EOL) on January 14, 2020.

Privacy

Qvm-Create-Windows-Qube aims to be the most private way to use Windows. Many Qubes users switched from Windows (or another proprietary OS) in part to get away from Microsoft (or Big Tech in general) and so being able to use Windows from a safe distance is of utmost importance to this project. Or at least, as safe a distance as possible for what is essentially a huge, proprietary binary blob.

Windows Telemetry

Configures Windows telemetry settings to respect privacy.

• Opt-out of Customer Experience Improvement Program (CEIP)
• Disable Windows Error Reporting (WER)
• Disable DiagTrack service
• Switch off all telemetry in Windows 10 "Settings" application
• Enable "Security" level of telemetry on compatible editions of Windows 10
• See spyless.bat for more info

Whonix Recommendations for Windows-Whonix-Workstation

Everything mentioned here up to "Even more security" is implemented. "Most security" is to use an official Whonix-Workstation built yourself from source. This feature is not official or endorsed by Whonix.

It's recommended to read this Whonix documentation to understand the implications of using Windows in this way.

Easy to Reset Fingerprint

There are countless unique identifiers present in every Windows installation such as the MachineGUID, installation ID, NTFS drive Volume Serial Numbers (VSNs) and more. With Qvm-Create-Windows-Qube, these unique identifiers can easily be reset by automatically reinstalling Windows.

Limitations

Fingerprinting is possible through the hypervisor in the event of VM compromise, here are some practical examples (not specific to Windows):

• Xen clocksource as wallclock
  • Timezone leak can at least be mitigated by configuring UTC time in the BIOS/UEFI
    • The local timezone can still be configured for the XFCE Dom0 clock and in desired VMs by running timedatectl set-timezone every boot using the standard /rw/config/rc.local Qubes provides
  • However, time correlation between VMs remains trivial
• CPUID
• Generally, some of the VM interfaces documented here (e.g. screen dimensions)

Frequently Asked Questions (FAQ)

Do I need a Windows license to use this project?

No, with every Windows installation comes an embedded trial product key which is used by default if none other is provided. Qvm-Create-Windows-Qube explicitly specifies no product key in the answer files in order to use the default trial key.

On general consumer versions of Windows such as (non-enterprise) 7, 8.1 and 10, these trials extend forever with the understanding that a watermark or pop up may start appearing requesting activation of the product.

On Windows Enterprise Evaluation and Server Evaluation versions, once the trial is up the machine will automatically (and without warning) be shut down after being up for a set amount of time by the Windows License Monitoring Service (C:\Windows\System32\wlms\wlms.exe; it's in a hidden folder). When this occurs, the aforementioned reason for shutdown will be logged in the Event Viewer. To renew the trial run slmgr /rearm in the command prompt. This will work for the number of times specified in slmgr /dlv (it can vary) at which point the product must be activated or reinstalled.

It's recommended that you license the product when the trial is up in all cases.

Giving Windows Internet access is not required for using the trial key (as it's embedded within each ISO). However, it is required for activating Windows with a product key of your own (unless you do activation by phone).

What is the purpose of the windows-mgmt AppVM? May I delete it once the Windows installation is complete?

The purpose of the windows-mgmt AppVM is to securely isolate everything that goes on as part of the Windows installation to a single virtual machine. That way, the exploitation of any bugs that exist in, for example, in the Linux ISO filesystem parsing code is limited in the amount of harm it can do should a Windows ISO be malicious. This is the security principle upon which all of Qubes OS is built upon, it's known as "security by isolation" or "security by compartmentalization".

Feel free to delete windows-mgmt if you are sure there are no more Windows VMs you would like to create. However, if it's just the disk space you want to reclaim then you can simply delete the ISOs located at /home/user/qvm-create-windows-qube/windows/isos and /home/user/qvm-create-windows-qube/windows/out (in windows-mgmt) to save the vast majority of that space.

Anything else I should know?

Don't enable "Include in memory balancing" (the checkbox) in the Windows qube settings. This feature of Qubes OS is currently unstable on Windows and enabling it will lead to frequent Windows crashes (BSODs).

Contributing

You can start by giving this project a star! High quality PRs are also welcome! Take a look at the todo list below if you're looking for things that need improvement. Other improvements such as more elegant ways of completing a task, code cleanup and other fixes are also welcome.

Lots of Windows-related GSoCs for those interested.

The logo of this project is by Max Andersen, used with written permission.

This project is the product of an independent effort that is not officially endorsed by Qubes OS.

Qubes Windows Tools Known Issues

• The new QWT installer disables private disk creation by default
  • This is probably due to stability concerns?
  • Can't make a TemplateVM

Newer Xen Drivers Notice (for olders OSs such as Windows 7)

In Qubes R4.1, Qubes Windows Tools comes with newer drivers that work better on newer versions of Windows such as Windows 10. Unfortunately, it's also been documented that these new drivers work less well with older versions of Windows such as Windows 7. Ideally, the fixes should be consolidated into a single driver but that is yet to happen.

Windows 7 is an EOL operating system at this point so this is less important. However, there are still some valid reasons for using (at least an air gapped) Windows 7 machine (e.g. for technical research/testing purposes).

There are community members documenting this experience (I can also attest to it) on the Qubes OS Forum and a few Qubes OS GitHub issues.

Mailing list threads

• qubes-users
• qubes-devel

Windows tagged Qubes OS GitHub issues

• C: windows-tools
• C: windows-vm

Todo

• Gain the ability to reliably unpack/insert answer file/repack for any given ISO 9660 (Windows ISO format)
  • ISO 9660 is write-once (i.e. read-only) filesystem; you cannot just add a file to it without creating a whole new ISO
  • Blocking issue for supporting other versions of Windows
  • This is the same way VMWare does it as can be seen by the "Creating Disk..." part in the video below (Further research indicates that they use mkisofs)
  • In the future, it would be best for Qubes to do this by extending core admin for libvirt XML templates
    • Much faster
    • Saves storage due to not having to create a new ISO
• auto-qwt takes D:\ making QWT put the user profile on E:\; it would be nicer to have it on D:\ so there is no awkward gap in the middle
• Make Windows answer file automatically use default trial key for Windows installation without hard-coding any product keys anywhere (Windows is finicky on this one)
• Support Windows 8.1-10 (Note: QWT doesn't fully officially any OS other than Windows 7 yet, however, everything is functional except the GUI driver)
• Support Windows Server 2008 R2 to Windows Server 2019
• Support Windows 10 Enterprise LTSC (Long Term Support Channel)
  • Provides security updates for 10 years, very stable and less bloat than stock Windows 10
• Support Windows 11
  • Qvm-Create-Windows-Qube was made to be Windows version independent, the only real work to do here is creating an answer file (probably just slightly modifying the Windows 10 one) and adding it mido.sh (which will not be a problem now that I've extended it's functionality to download from behind the gated Microsoft ISO download API)
  • The real question is whether Qubes Windows Tools is going to work under Windows 11
    • Microsoft has a fantastic track record for backwards compatibility even at the kernel API level though (because businesses love backwards compatibility) so it's possible it works just fine
    • Help wanted, testers welcome
• Provision Chocolatey
• Add an option to slim down Windows as documented for Qubes here
• Make windows-mgmt air gapped
• Extend functionality of download-windows.sh (now mido.sh to download ISOs from behind Microsoft's gated ISO download API
• I recently discovered this is a Qubes Google Summer of Code project
  • Add automated tests
    • Using Travis CI for automated ShellCheck
  • ACPI tables for fetching Windows the license embedded there
    • Found more info on this, should be very simple by just placing the following jinja libvirt template extension in /etc/qubes/templates/libvirt/xen/by-name/<windows_qube>
      • Thanks to @jevank for the patch
  • Port to Python
    • This seems like it would be unnecessary for scripts like create-media.sh where the Python script would essentially just be calling out to external programs
    • This would certainly be suitable for the qvm-create-windows-qube program though
      • This would allow us to interchange data between Dom0 and the VM without worrying about the potential for command injection or another Shellshock
• Automatically select which answer file to use based on Windows ISO characteristics gathered from the wiminfo command (Currently a WIP; see branch)
  • wiminfo works just like DISM on Windows
  • Once core admin is extended to allow for libvirt XML templates (answer files) becomes possible (previous todo, it's a blocking issue), we could also securely read the characteristics of the install.wim from the ISO without even having to mount the ISO as a loop device using libguestfs
    • I've also seen libguestfs used on QEMU/KVM so it's definitely a good candidate for this use case
    • Note that libguestfs cannot write (an answer file) to an ISO which is why we there's no point in using using this library until we no longer need to create a whole new ISO to add the answer file to it
• Follow Whonix documentation to make Windows-Whonix-Workstation
• Add functionality for create-media.sh to add MSUs (Microsoft Update standalone packages) to be installed during the Windows PE pass (specifically "Installing updates...") of Windows setup
  • We could fix currently not working QWT installation for old Windows 7 SP1 and Windows Server 2008 (non-R2) ISOs using KB4474419 to add SHA-256 driver signing support
    • The other option is to have Xen sign their drivers with SHA-1 as well, which other driver vendors seem to do, but is not ideal from a security standpoint
  • Allows us to get rid of allow-drivers.vbs hack by fixing SHA-256 automatic driver installation bug in newer versions of Windows 7 with KB2921916 (see allow-drivers.vbs for details)
    • This Windows bug was intentionally patched and unpatched by Microsoft in an attempt to force enterprises to upgrade to Windows 10
  • Patch a couple Windows security bugs?
    • Patch BlueKeep for Windows 7 out of the box
    • Windows Server 2008 R2 base ISO is also vulnerable to ETERNALBLUE and BlueKeep out of the box
    • Probably not worth getting into that, users should just update the VM upon making it
• Headless mode
  • Help wanted
    • What mechanism is there to accomplish this in Qubes? Something in Qubes GUI agent/daemon?
• Package this project so its delivery can be made more streamlined and secure through qubes-dom0-update
• Add ReactOS support as an open source alternative to Windows
  • This would be a good at least until a ReactOS template is made
  • Perhaps ReactOS developers may want to use this to develop ReactOS
  • Or maybe just add ReactOS as a template (outside of this project)
    • However, someone would have to maintain this template
    • Also, there may not be much point if QWT/Xen drivers don't work
      • At least for basic features like copy/paste and file transfer
  • Interest from both sides
    • Qubes OS
    • ReactOS
      • "one of the most interesting offers for collaboration we got till today"
  • ReactOS unattended installations look to be different than Windows ones
  • Only blocking issue I could find is the QEMU SCSI controller type
    • Qubes could extend core admin to support configuring the SCSI controller in the libvirt template
      • This solution seems better because according to this comment it would also fix a bunch of other OSs whose installer doesn't support our current SCSI controller
    • ReactOS could add support for our current SCSI controller type
    • ReactOS Issue
    • Qubes OS Issue
    • Exposing a different SCSI controller does not expand attack surface because QEMU runs in a Xen stub domain
  • ReactOS is in alpha so for most users this probably won't be viable right now
  • Help wanted
    • No timeline for this currently

End Goal

Have a feature similar (or superior) to VMWare's Windows "Easy Install" feature on Qubes OS. VMWare's solution is proprietary and only available in their paid products.

VirtualBox also has something similar but it's not as feature-rich.