1 Contributing
jbarnett-r7 edited this page 2016-08-30 16:45:18 -05:00

Directory Structure

  • metasploitable3/answer_files
    • This contains the Autounattend.xml files that Windows uses to automatically configure settings during installation. These are created on a per-OS basis.
  • metasploitable3/iso
    • This is a cache folder that can be used to store iso files when you don't want to download them during the Packer build. Nothing should ever be committed to this folder.
  • metasploitable3/resources
    • This folder contains any extra files that may be needed by a particular vulnerability or configuration. Each vulnerability or config should get its own folder.
  • metasploitable3/scripts
    • metasploitable3/scripts/chocolatey_installs
      • Any scripts here perform installs of applications specifically using chocolatey.
    • metasploitable3/scripts/configs
      • Any scripts that adjust the configuration of a base OS setting should go here
    • metasploitable3/scripts/installs
      • Any scripts that installs or configures a third party application should go here
  • metasploitable3/Vagrantfile
    • This file contains most of the calls to the provisioning scripts used to set up the Vagrant environment. More information on how the Vagrantfile works is here.
  • metasploitable3/vagrantfile-.template
    • This file is used by Packer to generate the base Vagrant configuration.
  • metasploitable3/*.json
    • This is provisioning file used by Packer to build the base VM. More information on how this file works is here.

Guidelines

  • Don't add large files to the repo. 50 MB will generate a warning, 100 MB will not be allowed. A good counter is to have a script that downloads the the large files directly to the target VM.

Scripts

  • Scripts can either be in the .bat or .ps1 format.