Skip to content
forked from mitre/caldera

Scalable Automated Adversary Emulation Platform

License

Notifications You must be signed in to change notification settings

mcguiremw/caldera

 
 

Repository files navigation

Release Build Status codecov Documentation Status

CALDERA

Full documentation, training and use-cases can be found here

CALDERA is a cyber security framework designed to easily run autonomous breach-and-simulation exercises. It can also be used to run manual red-team engagements or automated incident response.

It is built on the MITRE ATT&CK™ framework and is an active research project at MITRE.

The framework consists of two components:

  1. The core system. This is the framework code, consisting of what is available in this repository. Included is an asynchronous command-and-control (C2) server with a REST API and a web interface.
  2. Plugins. These are separate repositories that hang off of the core framework, providing additional functionality. Examples include agents, GUI interfaces, collections of TTPs and more.

Plugins

Requirements

These requirements are for the computer running the core framework:

  • Any Linux or MacOS
  • Python 3.6.1+ (with Pip3)
  • Google Chrome is our only supported browsers
  • Recommended hardware to run on is 8GB+ RAM and 2+ CPUs

Installation

Start by cloning this repository recursively, passing the desired version/release in x.x.x format. This will pull in all available plugins. If you clone master - or any non-release branch - you may experience bugs.

git clone https://github.com/mitre/caldera.git --recursive --branch x.x.x 

Next run the install.sh script. See the install docs for supported operating-systems.

./install.sh

Finally, start the server.

python server.py

You can now navigate to 127.0.0.1:8888 in a browser and log in with either red team (red:admin) or blue team (blue:admin) credentials. Once you have everything running, we highly recommend going through the Training plugin to learn the ins-and-outs of the framework.

There is also a Docker image for CALDERA.

Video tutorial

Watch the following video for a brief run through of how to run your first operation.

Contributing

Refer to our contributor documentation

Licensing

In addition to CALDERA's open source capabilities, MITRE maintains several in-house CALDERA plugins that offer more advanced functionality. For more information, or to discuss licensing opportunities, please reach out to [email protected] or directly to MITRE's Technology Transfer Office.

About

Scalable Automated Adversary Emulation Platform

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 61.8%
  • HTML 27.2%
  • CSS 6.0%
  • JavaScript 4.9%
  • Dockerfile 0.1%