Welcome to CALDERA’s documentation!

If you’re new to CALDERA, this is a good place to start.

Usage Guide:

• Installing CALDERA
  • Requirements
    • Recommended
  • Installation
  • Docker Deployment
  • Offline Installation
• Getting started
  • Autonomous red-team engagements
  • Autonomous incident-response
  • Manual red-team engagements
  • Research on artificial intelligence
• Learning the terminology
  • What is an agent?
    • Agent management
    • Types of agents
    • Agent settings
  • What is a group?
  • What is an ability?
    • Bootstrap and Deadman Abilities
  • What is an adversary?
  • What is an operation?
  • What is a fact?
  • What is a source?
  • What is a rule?
    • Subnets
  • What is a planner?
    • The Atomic planner
    • Custom Planners
    • Repeatable Abilities and Planners
  • What is a plugin?
• Server configuration
  • The existing default.yml
  • Adding your own config file
  • Enabling LDAP login
• Plugin library
  • Sandcat (54ndc47)
    • Deploy
    • Options
    • Extensions
  • Mock
  • Manx
  • Stockpile
  • Response
  • Compass
  • Caltack
  • SSL
    • Setup Instructions
  • Atomic
  • GameBoard
  • Human
  • Training
  • Access
    • Metasploit Integration
  • Builder
  • Debrief
• The REST API
  • /api/rest
  • Agents
    • DELETE
    • POST
  • Adversaries
  • Operations
    • DELETE
    • POST
    • PUT
  • /file/upload
    • Example
  • /file/download
    • Example
• How to Build Plugins
  • Creating the structure
  • The enable function
  • Writing the code
  • Making it visual
• How to Build Planners
  • Buckets
  • Creating a Planner
    • Creating the Python Module
    • Creating the Planner Object
    • Using the Planner
  • A Minimal Planner
  • Planning Service Utilities
  • Operation Utilities
• How to Build Agents
  • Understanding contacts
  • Building an agent: HTTP contact
    • Part #1
    • Part #2
    • Part #3
    • Part 4
    • Part #5
  • Lateral Movement Tracking
    • 54ndc47
• How CALDERA makes decisions
• Objectives
  • Objectives
  • Goals
• Initial Access Attacks
  • Run an initial access technique
  • Write an initial access ability
    • Create a binary
    • Create an ability
    • Run the ability
• Windows Lateral Movement Guide
  • Setup
    • Firewall Exceptions and Enabling File and Printer Sharing
    • User with Administrative Privileges
    • Additional Considerations
  • Lateral Movement Using CALDERA
    • Moving the Binary
    • Execution of the Binary
    • Displaying Lateral Movement in Debrief
  • Example Lateral Movement Profile
    • Ability Files Used
• Dynamically-Compiled Payloads
  • Basic Example
  • Advanced Examples
    • Arguments
    • DLL Dependencies
    • Donut
• CALDERA 2.0
  • Adversary Mode
  • Chain Mode
  • What’s the long-term plan?
  • Why?
  • Gotchas
• Uninstall CALDERA
• Common problems
  • I’m getting an error starting the application!
  • I start an agent but cannot see it from the server!
  • I’m seeing issues in the browser - things don’t seem right!
  • I see a 404 when I try to download conf.yml!
  • I ran an adversary and it didn’t do everything!
  • I can’t open files on the server
  • I’m getting this GO error when I run my server!
• Exfiltration
  • Accessing Exfiltrated Files
  • Accessing Operations Reports
  • Unencrypting the files
• Peer-to-Peer Proxy Functionality for 54ndc47 Agents
  • How 54ndc47 Uses Peer-to-Peer
    • Determining Available Receivers
    • Required gocat Extensions
    • Command Line Options
    • Chaining Peer-to-Peer
  • Peer-To-Peer Interfaces
  • Current Peer-to-Peer Implementations
    • HTTP proxy
• Resources
  • Ability List

The following section contains information intended to help developers understand the inner workings of the CALDERA adversary emulation tool, CALDERA plugins, or new tools that interface with the CALDERA server.

Developer Information:

• app
  • app package
    • Subpackages
    • Submodules
    • app.version module
    • Module contents

Indices and tables

• Index

• Module Index

• Search Page