Merge pull request #649 from Ana06/vbox-export

Improve vbox-export-snapshots.py

Author: Ana06

virtualbox/README.md

@@ -4,12 +4,38 @@
 
 ## Export snapshots
 
-[`vbox-export-snapshots.py`](vbox-export-snapshots.py) export one or more snapshots in the same VirtualBox virtual machine (VM) as `.ova`, changing the network adapter to Host-Only.
+[`vbox-export-snapshots.py`](vbox-export-snapshots.py) export one or more snapshots in the same VirtualBox VM as .ova, changing the network to a single Host-Only interface.
 It also generates a file with the SHA256 hash of the exported `.ova`.
 This script is useful to export several versions of FLARE-VM after its installation consistently and with the internet disabled by default (desired for malware analysis).
 For example, you may want to export a VM with the default FLARE-VM configuration and another installing in addition the packages `visualstudio.vm` and `pdbs.pdbresym.vm`.
 These packages are useful for malware analysis but are not included in the default configuration because of the consequent increase in size.
+The scripts receives the path of the JSON configuration file as argument.
+See configuration example files in the [`configs`](configs/) directory.
 
+### Example
+
+```
+$ ./vbox-export-snapshots.py configs/export_win10_flare-vm.json
+
+Exporting snapshots from "FLARE-VM.testing" {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d}
+Export directory: "/home/anamg/EXPORTED VMS"
+
+VM {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} state: running. Shutting down VM...
+VM {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} ✨ restored snapshot "FLARE-VM"
+VM {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} state: saved. Starting VM...
+VM {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} state: running. Shutting down VM...
+VM {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} ⚙️  network set to single hostonly adapter
+VM {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} 🔄 power cycling before export... (it will take some time, go for an 🍦!)
+VM {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} state: poweroff. Starting VM...
+VM {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} state: running. Shutting down VM...
+VM {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} 🚧 exporting "FLARE-VM.20250129.dynamic"... (it will take some time, go for an 🍦!)
+VM {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} ✅ EXPORTED "/home/anamg/EXPORTED VMS/FLARE-VM.20250129.dynamic.ova"
+VM {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} ✅ GENERATED "/home/anamg/EXPORTED VMS/FLARE-VM.20250129.dynamic.ova.sha256": 73c3de4175449987ef6047f6e0bea91c1036a8599b43113b3f990104ab294a47
+
+VM {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} ❌ ERROR exporting "FLARE-VM.full":Command 'VBoxManage snapshot {2bc66f50-9ecb-4b10-a4dd-0cc329bc383d} restore FLARE-VM.full' failed: Could not find a snapshot named 'FLARE-VM.full'
+
+Done! 🙃
+```
 
 ## Check internet adapter status
 

virtualbox/configs/export_remnux.json

@@ -0,0 +1,11 @@
+{
+  "VM_NAME": "REMnux.testing",
+  "EXPORTED_VM_NAME": "REMnux",
+  "SNAPSHOTS": [
+    [
+      "DONE",
+      ".dynamic",
+      "REMnux (based on Ubuntu) with improved configuration"
+    ]
+  ]
+}

virtualbox/configs/export_win10_flare-vm.json

@@ -0,0 +1,21 @@
+{
+  "VM_NAME": "FLARE-VM.testing",
+  "EXPORTED_VM_NAME": "FLARE-VM",
+  "SNAPSHOTS": [
+    [
+      "FLARE-VM",
+      ".dynamic",
+      "Windows 10 VM with FLARE-VM default configuration"
+    ],
+    [
+      "FLARE-VM.full",
+      ".full.dynamic",
+      "Windows 10 VM with FLARE-VM default configuration + visualstudio.vm + pdbs.pdbresym.vm + microsoft-office.vm"
+    ],
+    [
+      "FLARE-VM.EDU",
+      ".EDU",
+      "Windows 10 VM with FLARE-VM default configuration + FLARE-EDU materials"
+    ]
+  ]
+}

virtualbox/configs/export_win11_flare-vm.json

@@ -0,0 +1,16 @@
+{
+  "VM_NAME": "FLARE-VM.Win11.testing",
+  "EXPORTED_VM_NAME": "FLARE-VM",
+  "SNAPSHOTS": [
+    [
+      "FLARE-VM",
+      ".win11.dynamic",
+      "Windows 11 VM with FLARE-VM default configuration"
+    ],
+    [
+      "FLARE-VM.full",
+      "win11.full.dynamic",
+      "Windows 11 VM with FLARE-VM default configuration + visualstudio.vm + pdbs.pdbresym.vm + microsoft-office.vm"
+    ]
+  ]
+}