VIRTWINKVM-2071: Automate Hardware-enforced Stack Protection Compatibility Test

lib/engines/hckinstall/kits/HLK2022.json

@@ -5,7 +5,8 @@
     "FOD_2022",
     "Test-NETHLK",
     "winfsp",
-    "NDIS_Driver_Fix"
+    "NDIS_Driver_Fix",
+    "autoit"
   ],
   "studio_platform": "Win2019x64",
   "name": "HLK2022"

lib/engines/hcktest/drivers/Balloon.json

@@ -7,7 +7,6 @@
   "support": false,
   "reject_test_names": [
     "DF - Embedded Signature Verification Test (Certification)",
-    "DF - Embedded Signature Verification Test (Tuning and Validation)",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "DF - Embedded Signature Verification Test (Tuning and Validation)"
   ]
 }

lib/engines/hcktest/drivers/NetKVM.json

@@ -24,7 +24,6 @@
     "PrivateCloudSimulator - Device.Network.LAN.10GbOrGreater",
     "Run RSC Tests",
     "DF - Embedded Signature Verification Test (Certification)",
-    "DF - Embedded Signature Verification Test (Tuning and Validation)",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "DF - Embedded Signature Verification Test (Tuning and Validation)"
   ]
 }

lib/engines/hcktest/drivers/alinvme.json

@@ -39,9 +39,6 @@
         }
       ]
     }
-  ],
-  "reject_test_names": [
-    "Hardware-enforced Stack Protection Compatibility Test"
   ]
 }
 

lib/engines/hcktest/drivers/fwcfg64.json

@@ -4,8 +4,5 @@
   "inf": "fwcfg.inf",
   "install_method": "PNP",
   "type": 0,
-  "support": false,
-  "reject_test_names": [
-    "Hardware-enforced Stack Protection Compatibility Test"
-  ]
+  "support": false
 }

lib/engines/hcktest/drivers/igb.json

@@ -19,7 +19,6 @@
   ],
   "reject_test_names": [
     "NDISTest 6.5 - [2 Machine] - VMQReceiveQueueStateChecking",
-    "NDISTest 6.5 - [2 Machine] - VMQPowerManagement",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "NDISTest 6.5 - [2 Machine] - VMQPowerManagement"
   ]
 }

lib/engines/hcktest/drivers/ivshmem.json

@@ -7,7 +7,6 @@
   "support": false,
   "reject_test_names": [
     "DF - Embedded Signature Verification Test (Certification)",
-    "DF - Embedded Signature Verification Test (Tuning and Validation)",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "DF - Embedded Signature Verification Test (Tuning and Validation)"
   ]
 }

lib/engines/hcktest/drivers/ovpn-dco-win.json

@@ -8,7 +8,6 @@
   "type": 0,
   "support": false,
   "reject_test_names": [
-    "Static Tools Logo Test",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "Static Tools Logo Test"
   ]
 }

lib/engines/hcktest/drivers/pvpanic.json

@@ -7,7 +7,6 @@
   "support": false,
   "reject_test_names": [
     "DF - Embedded Signature Verification Test (Certification)",
-    "DF - Embedded Signature Verification Test (Tuning and Validation)",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "DF - Embedded Signature Verification Test (Tuning and Validation)"
   ]
 }

lib/engines/hcktest/drivers/viofs.json

@@ -7,7 +7,6 @@
   "support": false,
   "reject_test_names": [
     "DF - Embedded Signature Verification Test (Certification)",
-    "DF - Embedded Signature Verification Test (Tuning and Validation)",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "DF - Embedded Signature Verification Test (Tuning and Validation)"
   ]
 }

lib/engines/hcktest/drivers/viogpu.json

@@ -14,7 +14,6 @@
     "Test for EDID Requirements (Manual)",
     "Multimon minimum resolution check - Multihead",
     "WDDM HPD Notification Test (Manual)",
-    "Check Resolution for Dualview (WoW64) - multihead",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "Check Resolution for Dualview (WoW64) - multihead"
   ]
 }

lib/engines/hcktest/drivers/vioinput.json

@@ -7,7 +7,6 @@
   "support": false,
   "reject_test_names": [
     "DF - Embedded Signature Verification Test (Certification)",
-    "DF - Embedded Signature Verification Test (Tuning and Validation)",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "DF - Embedded Signature Verification Test (Tuning and Validation)"
   ]
 }

lib/engines/hcktest/drivers/viomem.json

@@ -4,8 +4,5 @@
   "inf": "viomem.inf",
   "install_method": "PNP",
   "type": 0,
-  "support": false,
-  "reject_test_names": [
-    "Hardware-enforced Stack Protection Compatibility Test"
-  ]
+  "support": false
 }

lib/engines/hcktest/drivers/viorng.json

@@ -7,7 +7,6 @@
   "support": false,
   "reject_test_names": [
     "DF - Embedded Signature Verification Test (Certification)",
-    "DF - Embedded Signature Verification Test (Tuning and Validation)",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "DF - Embedded Signature Verification Test (Tuning and Validation)"
   ]
 }

lib/engines/hcktest/drivers/vioscsi.json

@@ -43,7 +43,6 @@
   "reject_test_names": [
     "DF - Embedded Signature Verification Test (Certification)",
     "DF - Embedded Signature Verification Test (Tuning and Validation)",
-    "DF - Reboot Restart with IO During (Reliability)",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "DF - Reboot Restart with IO During (Reliability)"
   ]
 }

lib/engines/hcktest/drivers/vioserial.json

@@ -7,7 +7,6 @@
   "support": false,
   "reject_test_names": [
     "DF - Embedded Signature Verification Test (Certification)",
-    "DF - Embedded Signature Verification Test (Tuning and Validation)",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "DF - Embedded Signature Verification Test (Tuning and Validation)"
   ]
 }

lib/engines/hcktest/drivers/viosock.json

@@ -7,7 +7,6 @@
   "support": false,
   "reject_test_names": [
     "DF - Embedded Signature Verification Test (Certification)",
-    "DF - Embedded Signature Verification Test (Tuning and Validation)",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "DF - Embedded Signature Verification Test (Tuning and Validation)"
   ]
 }

lib/engines/hcktest/drivers/viostor.json

@@ -46,7 +46,6 @@
     "Thin Provisioning SCSI Compliance Test (LOGO)",
     "Thin Provisioning Performance Test - RAW Disk (LOGO)",
     "Thin Provisioning Performance Test - NTFS (LOGO)",
-    "Thin Provisioning Threshold and Resource Exhaustion Test (LOGO)",
-    "Hardware-enforced Stack Protection Compatibility Test"
+    "Thin Provisioning Threshold and Resource Exhaustion Test (LOGO)"
   ]
 }

lib/engines/hcktest/hcktest.json

@@ -46,6 +46,32 @@
           "value": "C:\\Windows\\mib.bin"
         }
       ]
+    },
+    {
+      "tests": ["Hardware-enforced Stack Protection Compatibility Test"],
+      "pre_test_commands": [
+        {
+          "desc": "Upload HSP watcher script",
+          "files_action": [
+            {
+              "local_path": "lib/engines/hcktest/scripts/autoit/hsp_watcher.au3",
+              "remote_path": "C:\\UIAgent\\autoit\\hsp_watcher.au3",
+              "direction": "local-to-remote"
+            }
+          ]
+        },
+        {
+          "desc": "Set HSP watcher to start on any user logon and reboot to activate",
+          "guest_run": "New-ItemProperty -Path 'HKLM:\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Run' -Name 'AutoHCK_UIWatcher' -Value '\"C:\\Program Files (x86)\\AutoIt3\\AutoIt3.exe\" \"C:\\UIAgent\\autoit\\hsp_watcher.au3\"' -PropertyType String -Force",
+          "guest_reboot": true
+        }
+      ],
+      "post_test_commands": [
+        {
+          "desc": "Stop and remove HSP watcher",
+          "guest_run": "Remove-ItemProperty -Path 'HKLM:\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Run' -Name 'AutoHCK_UIWatcher' -ErrorAction SilentlyContinue; Stop-Process -Name AutoIt3 -Force -ErrorAction SilentlyContinue; exit 0"
+        }
+      ]
     }
   ]
 }

lib/engines/hcktest/scripts/autoit/hsp_watcher.au3

@@ -0,0 +1,52 @@
+#NoTrayIcon
+#include <AutoItConstants.au3>
+
+Opt("WinTitleMatchMode", 2)
+HotKeySet("+{ESC}", "Terminate")
+
+Global $hspDone = False
+Global $ignoredCmds = "|"
+
+ConsoleWrite("[" & @HOUR & ":" & @MIN & ":" & @SEC & "] HSP Watcher Started..." & @CRLF)
+
+While 1
+    If Not $hspDone And WinExists("C:\Windows\SYSTEM32\cmd.exe") Then
+        Local $hWnd = WinGetHandle("C:\Windows\SYSTEM32\cmd.exe")
+
+        If Not StringInStr($ignoredCmds, "|" & $hWnd & "|") Then
+            WinActivate($hWnd)
+            WinWaitActive($hWnd, "", 2)
+
+            Local $bakClip = ClipGet()
+            ClipPut("")
+
+            Send("^a")
+            Sleep(100)
+            Send("{ENTER}")
+            Sleep(200)
+
+            Local $winText = ClipGet()
+            ClipPut($bakClip)
+
+            If StringInStr($winText, "Hardware-enforced") Then
+                ConsoleWrite("[" & @HOUR & ":" & @MIN & ":" & @SEC & "] Confirmed HSP test window, sending Y..." & @CRLF)
+                Send("{ESC}")
+                Sleep(100)
+                Send("Y")
+                Sleep(200)
+                Send("{ENTER}")
+                $hspDone = True
+                Sleep(5000)
+            Else
+                Send("{ESC}")
+                $ignoredCmds &= $hWnd & "|"
+            EndIf
+        EndIf
+    EndIf
+
+    Sleep(200)
+WEnd
+
+Func Terminate()
+    Exit
+EndFunc

lib/engines/hcktest/tests.rb

@@ -205,6 +205,11 @@ def run_guest_test_command(command, replacement)
 
       run_command_on_client(@client, command.guest_run, command.desc, replacement)
       run_command_on_client(@support, command.guest_run, command.desc, replacement) unless @support.nil?
+
+      return unless command.guest_reboot
+
+      @logger.info("Rebooting client #{@client.name} after command (#{command.desc})")
+      @tools.restart_machine(@client.name)
     end
 
     def run_host_test_command(command)