
Automated Adversary Emulation Platform
Caldera™ is a cyber security platform designed to easily automate adversary emulation, assist manual red-teams, and automate 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:
⭐ Create your own plugin! Plugin generator: Skeleton ⭐
These plugins are supported and maintained by the Caldera team.
These plugins are ready to use but are not included by default and are not maintained by the Caldera team.
These requirements are for the computer running the core framework:
Note: we HIGHLY recommend installing Caldera in a Python virtual environment to avoid issues with pip packages. You can use an existing environment if you wish or create a new one from scratch:
python3 -m venv .calderavenv
source .calderavenv/bin/activate
Concise installation steps:
git clone https://github.com/apache/caldera.git --recursive
cd caldera
pip3 install -r requirements.txt
pip3 install -r requirements-debrief.txt # optional: PDF reports in the debrief plugin
python3 server.py --insecure --build
Full steps: Start by cloning this repository recursively, passing the desired version/release in x.x.x format. This will pull in all available plugins.
git clone https://github.com/apache/caldera.git --recursive --branch x.x.x
If you start from the source release archive (apache-caldera-x.x.x-incubating-src.tar.gz) instead of a clone, note that it holds the core framework only. The plugin directories in it are empty, and the server needs the plugins to start. The file plugin-revisions.txt in the archive lists the repository and the exact commit of each plugin for that release. To fetch them, run this in the top directory of the unpacked archive:
grep -v '^#' plugin-revisions.txt | while read -r path commit url; do
if [ ! -d "$path/.git" ]; then
git clone "$url" "$path" || exit 1
fi
git -C "$path" checkout --detach "$commit" || exit 1
done
If a plugin cannot be fetched, the loop stops with an error. Run it again to continue: plugins that were already cloned are reused. The recursive clone of the same version gives the same plugin commits.
Next, install the PIP requirements:
pip3 install -r requirements.txt
LDAP login is optional. To use it, also install the LDAP requirements, which are kept in a separate file because the ldap3 package is licensed under the LGPL 3.0:
pip3 install -r requirements-ldap.txt
The debrief plugin, which conf/default.yml enables, needs the svglib package to build PDF reports. It is kept in a separate file because it is licensed under the LGPL 3.0:
pip3 install -r requirements-debrief.txt
These two commands apply to an installation on the host. The Docker images do not include either set of packages. See Docker Installation for how to add them to an image.
Finally, start the server.
python3 server.py --insecure --build
The --build flag automatically installs any VueJS UI dependencies, bundles the UI into a dist directory and is served by the Caldera server. You will only have to use the --build flag again if you add any plugins or make any changes to the UI. Once started, log into http://localhost:8888 using the default credentials red/admin. Then go into Plugins -> Training and complete the capture-the-flag style training course to learn how to use Caldera.
If you prefer to not use the new VueJS UI, revert to Caldera v4.2.0. Correspondingly, do not use the --build flag for earlier versions as not required.
Additionally, please note security recommendations for deploying Caldera.
Local build:
git clone https://github.com/apache/caldera.git --recursive
cd caldera
docker build --build-arg VARIANT=full -t caldera .
docker run -it -p 8888:8888 caldera
Adjust the port forwarding (-p) and build args (--build-arg) as desired to make ports accessible or change the Caldera variant. The ports that you expose depend on which contacts you plan on using (see Dockerfile and docker-compose.yml for reference).