Skip to content

mitre/atomic

Repository files navigation

MITRE Caldera plugin: Atomic

Overview:

The Atomic plugin converts Red Canary’s Atomic Red Team tests from their open-source GitHub repository into CALDERA abilities for granular ATT&CK simulation.

Context:

Atomic-level detection validation

Installation:

The Atomic plugin ships with CALDERA as a default plugin (a git submodule under plugins/atomic). To add it manually:

  1. Clone this repository into CALDERA's plugins folder: cd <path to caldera>/plugins git clone https://github.com/mitre/atomic.git
  2. Enable the plugin by adding - atomic to the plugins: list in CALDERA's conf/local.yml (or conf/default.yml).
  3. Restart CALDERA.

On first load the plugin automatically clones Red Canary's Atomic Red Team repository into plugins/atomic/data/atomic-red-team and imports the tests as abilities — no manual cloning, requirements file, or path configuration is required. The ATT&CK technique-to-tactic mapping is read from the enterprise-attack.json file bundled inside that same repository, so no separate CTI repository is needed. (This first import takes a while; see "Getting Started" below.)

Dependencies/Requirements:

  • git available on the PATH (used to clone the Atomic Red Team repository).
  • Python dependencies are provided by CALDERA core (e.g. PyYAML); the plugin has no separate requirements file or install step.

Getting Started:

The first time you access the Atomic plugin you will need to import the Atomic Red Team YAML files to populate Atomic Caldera's database. To do this click the "Add Abilities" button. Adding the abilities for the first time will take some time to complete, please be patient, the status will update when the import is completed.

Selecting an Ability

To select an ability:

  1. First select a tactic "Select ATT&CK tactic" drop down.
  2. Next select the ability from the "Select ability" drop down.

After you have selected an ability you can use the left and right arrows to quickly move through the list of available abilities related to the selected tactic.

Saving an Ability

If you have made changes to an ability and wish to save them:

  1. Click the "Save Ability" button.

Saving Variables

If you have made changes to variables and wish to save them:

  1. Click the "Save Variables" button.

Export a Single Ability

If you wish to export the selected ability only to Stockpile:

  1. Click the Export Ability button.

Export All Abilities

If you wish to export all of the abilities from Atomic Caldera to Stockpile:

  1. Click the Export All Abilities button.

Reloading Data (i.e. Start over)

If you wish to delete everything that has been imported and wish to start over, do so by:

  1. Click the Reload Abilities button
  2. Click the Yes button.

After clicking yes, it will then take some time for the abilities to complete reloading. NOTE: It is necessary to restart Caldera to view the new abilities. At the moment there is no way to force Chain to reload its database from the GUI.

Known Limitations:

  • ART tests only specify techniques they address. This plugin creates a mapping and import abilities under the corresponding tactic. Yet sometimes multiple tactics are a match, and we do not know which one the test addresses. This will be fixed in the future thanks to the ATT&CK sub-techniques. As of now, we use a new tactic category called "multiple".
  • When a command/cleanup expands over multiple lines with one of them being a comment, it messes up the whole command/cleanup (as we reduce multiple lines into one with semi-colons).
  • ART tests are not full adversary attack chains/ emulations.
  • Some ART tests are incomplete.
  • When importing tests from Atomic Red Team, this plugin also catches $PathToAtomicsFolder usages pointing to an existing file. It then imports the files as payloads and fixes path usages. Note other usages are not handled. If a path with $PathToAtomicsFolder points to an existing directory or an unexisting file, we will not process it any further and ingest it "as it is". Examples of such usages below:

About

A MITRE Caldera plugin

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors