How cliffe/secgen works
SecGen turns a scenario specification and its module catalog into randomized vulnerable systems and challenges, then generates project artifacts and provisions virtual machines. The README documents the main orchestration and provisioning flow; the tree shows reader, model, generator, output, and provider components. Source excerpts are sparse, so edges below rely on the README’s explicit workflow descriptions; internal calls between unsampled components are not asserted.
Main entry points: secgen.rb SecGen CLI · xml_reader.rb XML reader · batch_secgen.rb Scenario randomization · module_reader.rb Module catalog reader
Components 22
Scenario entry
- SecGen CLI
secgen.rb - Scenario definition
Scenario processing
- XML reader
lib/readers/xml_reader.rb - Module catalog reader
lib/readers/module_reader.rb - System reader
lib/readers/system_reader.rb - Scenario model
lib/helpers/scenario.rb - System model
lib/objects/system.rb - Module model
lib/objects/module.rb - Scenario randomization
lib/batch/batch_secgen.rb
Challenge content
- Services and vulnerabilities
modules - Challenge generators
lib/objects - String encoder
lib/objects/local_string_encoder.rb
Artifacts and provisioning
- Project files
lib/output/project_files_creator.rb - Scenario XML output
lib/output/xml_scenario_generator.rb - CyBOK XML output
lib/output/xml_cybok_generator.rb - CTFd output
lib/output/ctfd_generator.rb
Infrastructure providers
Other components
- Scenario author
Connections 20
- Scenario author → SecGen CLI: invokes
- Scenario author → Scenario definition: specifies
- SecGen CLI → XML reader: reads configuration
- XML reader → Scenario model: loads scenario
- XML reader → Module catalog reader: loads catalog
- Module catalog reader → Services and vulnerabilities: reads modules
- SecGen CLI → Scenario randomization: randomizes scenario
- Scenario randomization → System model: selects systems
- Scenario randomization → Module model: selects modules
- Services and vulnerabilities → Challenge generators: provides content
- Challenge generators → String encoder: uses encoder
lib/objects/local_paragraph_generator.rb - SecGen CLI → Project files: generates project
- SecGen CLI → Scenario XML output: generates XML
- SecGen CLI → CyBOK XML output: generates index
- SecGen CLI → CTFd output: generates CTFd
- SecGen CLI → Vagrant: provisions VMs
- Vagrant → VirtualBox: runs guests
- Vagrant → Puppet: provisions guests
- SecGen CLI → oVirt: supports deployment
- SecGen CLI → Proxmox: supports deployment