utils.nix: pass all attrs

Fixes passing baseRtc and other parameters

README.md

@@ -52,3 +52,30 @@ Impure/pure mode
 Sometimes it can be useful to build the image _outside_ of the Nix sandbox for debugging purposes.
 
 For this purpose we have an attribute called `impureMode` which outputs the shell script used by Nix inside the sandbox to build the image.
+
+
+Usage with Nix Flakes
+---------------------
+
+Build the demo by running:
+```shell
+nix build .#demoImage
+```
+
+This project's **flake.nix** exposes its functions under `lib`. To use
+in your own project, setup your flake like this:
+
+```nix
+{
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    wfvm.url = "git+https://git.m-labs.hk/m-labs/wfvm";
+  };
+
+  outputs = { self, nixpkgs, wfvm }: {
+    packages."x86_64-linux".flaky-os = wfvm.lib.makeWindowsImage {
+      # configuration parameters go here
+    };
+  };
+}
+```

flake.lock

@@ -0,0 +1,27 @@
+{
+  "nodes": {
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1685004253,
+        "narHash": "sha256-AbVL1nN/TDicUQ5wXZ8xdLERxz/eJr7+o8lqkIOVuaE=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "3e01645c40b92d29f3ae76344a6d654986a91a91",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-23.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "nixpkgs": "nixpkgs"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

flake.nix

@@ -0,0 +1,37 @@
+{
+  description = "WFVM: Windows Functional Virtual Machine";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.05";
+  };
+
+  outputs = { self, nixpkgs }:
+    let
+      # only x64 is supported
+      system = "x86_64-linux";
+
+      pkgs = nixpkgs.legacyPackages.${system};
+
+    in rec {
+      lib = import ./wfvm {
+        inherit pkgs;
+      };
+
+      packages.${system} = rec {
+        demoImage = import ./wfvm/demo-image.nix {
+          inherit self;
+        };
+
+        default = lib.utils.wfvm-run {
+          name = "demo";
+          image = demoImage;
+          script =
+            ''
+            echo "Windows booted. Press Enter to terminate VM."
+            read
+            '';
+          display = true;
+        };
+      };
+    };
+}

wfvm/autounattend.nix

@@ -15,7 +15,8 @@
 , impureShellCommands ? []
 , driveLetter ? "D:"
 , efi ? true
-, imageSelection ? "Windows 10 Pro"
+, imageSelection ? "Windows 11 Pro N"
+, enableTpm
 , ...
 }:
 
@@ -58,18 +59,16 @@ let
   assertCommand = c: builtins.typeOf c == "string" || builtins.typeOf c == "set" && builtins.hasAttr "Path" c && builtins.hasAttr "Description" c;
 
   commands = builtins.map (x: assert assertCommand x; if builtins.typeOf x == "string" then { Path = x; Description = x; } else x) (
-    [
-      {
-        Path = "powershell.exe Set-ExecutionPolicy -Force Unrestricted";
-        Description = "Allow unsigned powershell scripts.";
-      }
-    ]
-    ++ [
-      {
-        Path = ''powershell.exe ${driveLetter}\win-bundle-installer.exe'';
-        Description = "Install any declared packages.";
-      }
-    ]
+    [ {
+      Path = "powershell.exe Set-ExecutionPolicy -Force Unrestricted";
+      Description = "Allow unsigned powershell scripts.";
+    } {
+      Path = ''powershell.exe ${driveLetter}\win-bundle-installer.exe'';
+      Description = "Install any declared packages.";
+    } {
+      Path = "net accounts /maxpwage:unlimited";
+      Description = "Disable forced password expiry.";
+    } ]
     ++ setupCommands
     ++ [
       {
@@ -148,6 +147,14 @@ let
           </DriverPaths>
         </component>
         <component name="Microsoft-Windows-Setup" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS" xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+          ${lib.optionalString (!enableTpm) ''
+            <RunSynchronous>
+              <RunSynchronousCommand wcm:action="add">
+                <Order>1</Order>
+                <Path>reg add HKLM\System\Setup\LabConfig /v BypassTPMCheck /t reg_dword /d 0x00000001 /f</Path>
+              </RunSynchronousCommand>
+            </RunSynchronous>
+          ''}
 
           <DiskConfiguration>
             <Disk wcm:action="add">
@@ -199,6 +206,7 @@ let
                 <PartitionID>3</PartitionID>
               </InstallTo>
               <InstallFrom>
+                <Path>\install.swm</Path>
                 <MetaData wcm:action="add">
                   <Key>/IMAGE/NAME</Key>
                   <Value>${imageSelection}</Value>
@@ -209,7 +217,7 @@ let
 
           <UserData>
             <ProductKey>
-              ${if productKey != null then "<Key>${productKey}</Key>" else ""}
+              ${if productKey != null then "<Key>${productKey}</Key>" else "<Key/>"}
               <WillShowUI>OnError</WillShowUI>
             </ProductKey>
             <AcceptEula>true</AcceptEula>
@@ -299,13 +307,13 @@ let
         </component>
       </settings>
 
-       <cpi:offlineImage cpi:source="wim:c:/wim/windows-10/install.wim#${imageSelection}" xmlns:cpi="urn:schemas-microsoft-com:cpi" />
+       <cpi:offlineImage cpi:source="wim:c:/wim/windows-11/install.wim#${imageSelection}" xmlns:cpi="urn:schemas-microsoft-com:cpi" />
     </unattend>
   '';
 
 in {
   # Lint and format as a sanity check
-  autounattendXML = pkgs.runCommandNoCC "autounattend.xml" {} ''
+  autounattendXML = pkgs.runCommand "autounattend.xml" {} ''
     ${pkgs.libxml2}/bin/xmllint --format ${autounattendXML} > $out
   '';
 

wfvm/bundle/default.nix

@@ -1,6 +1,6 @@
 { pkgs }:
 
-pkgs.runCommandNoCC "win-bundle-installer.exe" {} ''
+pkgs.runCommand "win-bundle-installer.exe" {} ''
   mkdir bundle
   cd bundle
   cp ${./go.mod} go.mod

wfvm/default.nix

@@ -2,6 +2,6 @@
 
 {
   makeWindowsImage = attrs: import ./win.nix ({ inherit pkgs; } // attrs);
-  layers = (import ./layers { inherit pkgs; });
-  utils = (import ./utils.nix { inherit pkgs; });
+  layers = import ./layers { inherit pkgs; };
+  utils = import ./utils.nix { inherit pkgs; };
 }

wfvm/demo-image.nix

@@ -1,7 +1,17 @@
-{ pkgs ? import <nixpkgs> {}, impureMode ? false }:
+{ pkgs ? import <nixpkgs> {}
+# Whether to generate just a script to start and debug the windows installation
+, impureMode ? false
+# Flake input `self`
+, self ? null
+}:
 
 let
-  wfvm = (import ./default.nix { inherit pkgs; });
+  wfvm =
+    if self == null
+    # nix-build
+    then (import ./default.nix { inherit pkgs; })
+    # built from flake.nix
+    else self.lib;
 in
 wfvm.makeWindowsImage {
   # Build install script & skip building iso
@@ -9,9 +19,9 @@ wfvm.makeWindowsImage {
 
   # Custom base iso
   # windowsImage = pkgs.requireFile rec {
-  #   name = "Win10_21H1_English_x64.iso";
-  #   sha256 = "1sl51lnx4r6ckh5fii7m2hi15zh8fh7cf7rjgjq9kacg8hwyh4b9";
-  #   message = "Get ${name} from https://www.microsoft.com/en-us/software-download/windows10ISO";
+  #   name = "Win11_22H2_English_x64v1.iso";
+  #   sha256 = "08mbppsm1naf73z8fjyqkf975nbls7xj9n4fq0yp802dv1rz3whd";
+  #   message = "Get disk image ${name} from https://www.microsoft.com/en-us/software-download/windows11/";
   # };
 
   # impureShellCommands = [
@@ -47,7 +57,7 @@ wfvm.makeWindowsImage {
         disable-autolock
         disable-firewall
       ])
-      anaconda3 msys2 msvc msvc-ide-unbreak
+      anaconda3 msys2
     ];
 
   # services = {
@@ -60,7 +70,7 @@ wfvm.makeWindowsImage {
 
   # License key (required)
   # productKey = throw "Search the f* web"
-  imageSelection = "Windows 10 Pro";
+  imageSelection = "Windows 11 Pro N";
 
 
   # Locales

wfvm/layers/default.nix

@@ -72,7 +72,7 @@ in
       bootstrapper = pkgs.fetchurl {
         name = "RESTRICTDIST-vs_Community.exe";
         url = "https://aka.ms/vs/16/release/vs_community.exe";
-        sha256 = "0b3csxz0qsafnvc0d74ywfpralwz8chv4zf9k07akpm8lp8ycgq0";
+        sha256 = "sha256-l4ZKFZTgHf3BmD0eFWyGwsvb4lqB/LiQYizAABOs3gg=";
       };
       # This touchy-feely "community" piece of trash seems deliberately crafted to break Wine, so we use the VM to run it.
       download-vs = wfvm.utils.wfvm-run {
@@ -93,7 +93,7 @@ in
 
         outputHashAlgo = "sha256";
         outputHashMode = "recursive";
-        outputHash = "0ic3jvslp2y9v8yv9mfr2mafkvj2q5frmcyhmlbxj71si1x3kpag";
+        outputHash = "sha256-GoOKzln8DXVMx52jWGEjwkOFkpSW+wEffAVmBVugIyk=";
 
         phases = [ "buildPhase" ];
         buildInputs = [ download-vs ];

wfvm/utils.nix

@@ -1,23 +1,45 @@
-{ pkgs, baseRtc ? "2020-04-20T14:21:42", cores ? "4", qemuMem ? "4G", efi ? true }:
+{ pkgs
+, baseRtc ? "2022-10-10T10:10:10"
+, cores ? "4"
+, qemuMem ? "4G"
+, efi ? true
+, enableTpm ? false
+, ...
+}:
 
 rec {
   # qemu_test is a smaller closure only building for a single system arch
   qemu = pkgs.qemu;
 
+  OVMF = pkgs.OVMF.override {
+    secureBoot = true;
+  };
+
   mkQemuFlags = extraFlags: [
     "-enable-kvm"
     "-cpu host"
     "-smp ${cores}"
     "-m ${qemuMem}"
-    "-M q35"
+    "-M q35,smm=on"
     "-vga qxl"
     "-rtc base=${baseRtc}"
     "-device qemu-xhci"
     "-device virtio-net-pci,netdev=n1"
   ] ++ pkgs.lib.optionals efi [
-    "-bios ${pkgs.OVMF.fd}/FV/OVMF.fd"
+    "-bios ${OVMF.fd}/FV/OVMF.fd"
+  ] ++ pkgs.lib.optionals enableTpm [
+    "-chardev" "socket,id=chrtpm,path=tpm.sock"
+    "-tpmdev" "emulator,id=tpm0,chardev=chrtpm"
+    "-device" "tpm-tis,tpmdev=tpm0"
   ] ++ extraFlags;
 
+  tpmStartCommands = pkgs.lib.optionalString enableTpm ''
+    mkdir -p tpmstate
+    ${pkgs.swtpm}/bin/swtpm socket \
+      --tpmstate dir=tpmstate \
+      --ctrl type=unixio,path=tpm.sock &
+  '';
+
   # Pass empty config file to prevent ssh from failing to create ~/.ssh
   sshOpts = "-F /dev/null -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o LogLevel=ERROR -o ConnectTimeout=1";
   win-exec = pkgs.writeShellScriptBin "win-exec" ''
@@ -93,6 +115,7 @@ rec {
       ]);
     in pkgs.writeShellScriptBin "wfvm-run-${name}" ''
       set -e -m
+      ${tpmStartCommands}
       ${qemu}/bin/qemu-system-x86_64 ${pkgs.lib.concatStringsSep " " qemuParams} &
 
       ${win-wait}/bin/win-wait

wfvm/win.nix

@@ -5,16 +5,17 @@
 , impureMode ? false
 , installCommands ? []
 , users ? {}
+, enableTpm ? true
 # autounattend always installs index 1, so this default is backward-compatible
-, imageSelection ? "Windows 10 Pro"
+, imageSelection ? "Windows 11 Pro N"
 , efi ? true
 , ...
 }@attrs:
 
 let
   lib = pkgs.lib;
-  utils = import ./utils.nix { inherit pkgs efi; };
-  libguestfs = pkgs.libguestfs-with-appliance;
+  utils = import ./utils.nix ({ inherit pkgs efi enableTpm; } // attrs);
+  inherit (pkgs) guestfs-tools;
 
   # p7zip on >20.03 has known vulns but we have no better option
   p7zip = pkgs.p7zip.overrideAttrs(old: {
@@ -24,7 +25,7 @@ let
   });
 
   runQemuCommand = name: command: (
-    pkgs.runCommandNoCC name { buildInputs = [ p7zip utils.qemu libguestfs ]; }
+    pkgs.runCommand name { buildInputs = [ p7zip utils.qemu guestfs-tools ]; }
       (
         ''
           if ! test -f; then
@@ -36,15 +37,14 @@ let
   );
 
   windowsIso = if windowsImage != null then windowsImage else pkgs.requireFile rec {
-    name = "Win10_21H1_English_x64.iso";
-    sha256 = "1sl51lnx4r6ckh5fii7m2hi15zh8fh7cf7rjgjq9kacg8hwyh4b9";
-    message = "Get ${name} from https://www.microsoft.com/en-us/software-download/windows10ISO";
+    name = "Win11_22H2_English_x64v2.iso";
+    sha256 = "0xhhxy47yaf1jsfmskym5f65hljw8q0aqs70my86m402i6dsjnc0";
+    message = "Get disk image ${name} from https://www.microsoft.com/en-us/software-download/windows11/";
   };
 
-  # stable as of 2021-04-08
   virtioWinIso = pkgs.fetchurl {
-    url = "https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/archive-virtio/virtio-win-0.1.185-2/virtio-win-0.1.185.iso";
-    sha256 = "11n3kjyawiwacmi3jmfmn311g9xvfn6m0ccdwnjxw1brzb4kqaxg";
+    url = "https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/archive-virtio/virtio-win-0.1.229-1/virtio-win.iso";
+    sha256 = "1q5vrcd70kya4nhlbpxmj7mwmwra1hm3x7w8rzkawpk06kg0v2n8";
   };
 
   openSshServerPackage = pkgs.fetchurl {
@@ -54,7 +54,7 @@ let
 
   autounattend = import ./autounattend.nix (
     attrs // {
-      inherit pkgs;
+      inherit pkgs enableTpm;
       users = users // {
         wfvm = {
           password = "1234";
@@ -109,7 +109,7 @@ let
       ''
         #!${pkgs.runtimeShell}
         set -euxo pipefail
-        export PATH=${lib.makeBinPath [ p7zip utils.qemu libguestfs pkgs.wimlib ]}:$PATH
+        export PATH=${lib.makeBinPath [ p7zip utils.qemu guestfs-tools pkgs.wimlib ]}:$PATH
 
         # Create a bootable "USB" image
         # Booting in USB mode circumvents the "press any key to boot from cdrom" prompt
@@ -120,7 +120,7 @@ let
         7z x -y ${windowsIso} -owin
 
         # Split image so it fits in FAT32 partition
-        wimsplit win/sources/install.wim win/sources/install.swm 4090
+        wimsplit win/sources/install.wim win/sources/install.swm 4070
         rm win/sources/install.wim
 
         cp ${autounattend.autounattendXML} win/autounattend.xml
@@ -132,18 +132,20 @@ let
         ''}
         rm -rf win
 
+        ${utils.tpmStartCommands}
+
         # Qemu requires files to be rw
         qemu-img create -f qcow2 c.img ${diskImageSize}
         qemu-system-x86_64 ${lib.concatStringsSep " " qemuParams}
       ''
   );
 
-  baseImage = pkgs.runCommandNoCC "RESTRICTDIST-windows.img" {} ''
+  baseImage = pkgs.runCommand "RESTRICTDIST-windows.img" {} ''
     ${installScript}
     mv c.img $out
   '';
 
-  finalImage = builtins.foldl' (acc: v: pkgs.runCommandNoCC "RESTRICTDIST-${v.name}.img" {
+  finalImage = builtins.foldl' (acc: v: pkgs.runCommand "RESTRICTDIST-${v.name}.img" {
     buildInputs = with utils; [
       qemu win-wait win-exec win-put
     ] ++ (v.buildInputs or []);
@@ -158,8 +160,11 @@ let
     ]);
 
   in ''
+    set -x
+    ${utils.tpmStartCommands}
+
     # Create an image referencing the previous image in the chain
-    qemu-img create -f qcow2 -b ${acc} c.img
+    qemu-img create -F qcow2 -f qcow2 -b ${acc} c.img
 
     set -m
     qemu-system-x86_64 ${lib.concatStringsSep " " qemuParams} &