How mandiant/flare-vm works
Project type and purpose
• FLARE-VM is an open-source, script-driven provisioning tool whose sole purpose is to automate the build and configuration of a Windows-based reverse-engineering VM. It uses PowerShell scripts (install.ps1), a configuration XML (config.xml), Chocolatey, Boxstarter, and a set of VirtualBox-specific Python scripts to produce repeatable VM images.
File structure
• Top-level:
• install.ps1 – main PowerShell installer
• config.xml – default list of packages & environment settings
• LayoutModification.xml – default taskbar layout
• scripts/lint.ps1 – code quality checks
• virtualbox/… – Python scripts & YAML configs to build VirtualBox VMs (remnux, win10, win11)
• .github/workflows – CI: linter + build pipelines
• Images, README.md, LICENSE, CONTRIBUTING.md
• Patterns:
• “infrastructure as code” for Windows provisioning
• separation between host-level VM build (Python/VirtualBox) and guest-level software install (PowerShell/Boxstarter)
README
• Confirms:
• Pre-reqs and VM snapshot strategy
• Installer parameters and GUI flow
• Relationship between install.ps1 → Boxstarter → Chocolatey → config.xml
• VirtualBox build scripts live under virtualbox/
a. Main components
1. Host Machine
2. GitHub CI (linter + build workflows)
3. VirtualBox & Python VM-build scripts (virtualbox/*.py + configs)
4. Windows VM (guest)
5. Provisioning engine inside VM: PowerShell (install.ps1) → Boxstarter → Chocolatey → packages
6. External package repos (Chocolatey community, MyGet, remote URLs)
b. Relationships & interactions
• Host Machine triggers CI on GitHub → validates scripts
• Host runs virtualbox/vbox-*.py → builds and snapshots base VM
• User or CI invokes install.ps1 (inside guest) → calls Boxstarter
• Boxstarter commands Chocolatey to fetch, install, and configure each tool per config.xml
• Taskbar layout applied via LayoutModification.xml
• Logs written to VM_COMMON_DIR, Boxstarter, Chocolatey
c. Architectural patterns
• Infrastructure-as-Code (IaC) for VM build
• Idempotent, declarative package installation via Boxstarter/Chocolatey
• Config-driven provisioning (config.xml, YAML)
d. Key technologies
• PowerShell (install.ps1, scripts/)
• Boxstarter + Chocolatey
• Python for VirtualBox automation
• YAML configs for different VM variants
• GitHub Actions for CI