Welcome to CALDERA’s documentation!

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

Usage Guide:

• Getting started
  • Autonomous red-team engagements
  • Manual red-team engagements
  • Autonomous incident-response
  • Research on artificial intelligence
• Learning the terminology
  • What is an agent?
  • What is a group?
  • What is an ability?
  • 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 Sequential planner
  • What is a plugin?
• Server configuration
  • The existing default.yml
  • Adding your own config file
• Plugin library
  • Sandcat (54ndc47)
    • Deploy
    • Options
  • Mock
  • Terminal
  • Stockpile
  • Response
  • Compass
  • Caltack
  • SSL
  • Atomic
  • GameBoard
  • Human
  • Training
• The REST API
  • /api/rest
    • DELETE
    • PUT
    • POST
  • /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 Agents
  • Understanding contacts
  • Building an agent: HTTP contact
    • Part #1
    • Part #2
    • Part #3
    • Part #4
• How CALDERA makes decisions
• Install CALDERA offline
• Docker deployment
• Install script
  • A Python virtual environment
  • GoLang
  • MinGW
• CALDERA 2.0
  • Adversary Mode
  • Chain Mode
  • What’s the long-term plan?
  • Why?
  • Gotchas
• 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!

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.api namespace
    • Subpackages
    • Submodules
    • app.api.rest_api module
  • app.contacts namespace
    • Subpackages
    • Submodules
    • app.contacts.contact_gist module
    • app.contacts.contact_html module
    • app.contacts.contact_http module
    • app.contacts.contact_tcp module
    • app.contacts.contact_udp module
    • app.contacts.contact_websocket module
  • app.learning namespace
    • Submodules
    • app.learning.p_ip module
    • app.learning.p_path module
  • app.objects namespace
    • Subpackages
    • Submodules
    • app.objects.c_ability module
    • app.objects.c_adversary module
    • app.objects.c_agent module
    • app.objects.c_obfuscator module
    • app.objects.c_operation module
    • app.objects.c_planner module
    • app.objects.c_plugin module
    • app.objects.c_schedule module
    • app.objects.c_source module
  • app.service namespace
    • Submodules
    • app.service.app_svc module
    • app.service.auth_svc module
    • app.service.contact_svc module
    • app.service.data_svc module
    • app.service.file_svc module
    • app.service.learning_svc module
    • app.service.planning_svc module
    • app.service.rest_svc module
  • app.utility namespace
    • Submodules
    • app.utility.base_obfuscator module
    • app.utility.base_object module
    • app.utility.base_parser module
    • app.utility.base_planning_svc module
    • app.utility.base_service module
    • app.utility.base_world module
    • app.utility.file_decryptor module
    • app.utility.payload_encoder module
    • app.utility.rule_set module

Indices and tables

• Index
• Module Index
• Search Page