Skip to content

You want to work on the Vultron reference implementation

You want to run, change, or extend the Python code in this repository. This tab holds CERT/CC's reference implementation of the protocol: its demos, its architecture, and the requirements on how it is built. What every implementation must do is on Implement the Protocol; this tab is about one implementation of it. This page is a reading path from running the demos to understanding why the codebase is built the way it is. Each section builds on the ones before it; read a numbered list in order and a bulleted list in any order.

If you have been here before and want one page in particular, Look Something Up lists the reference pages of every tab: the specification, the requirements, the messages, and the glossary.

Run it

  1. Tutorial: Run the Receive-Report Demo — the demo environment, and one actor working an incoming report.
  2. Tutorial: Running the Multi-Actor Container Demos — several actors coordinating a case on your machine.

Understand how it is built

Decisions holds the architecture decision records behind the design.

  1. Reference Implementation Architecture — the layers, the ports and adapters, and the behavior trees that drive them.
  2. Architecture Specifications — the requirements on how this implementation is built, which other implementations need not follow.
  3. Wiring a Capability into the Reference Implementation — replacing a stub decision with your own service.

Start contributing

Contributing says how to propose a change and get it merged. The Vultron Developer Docs cover setup, testing and day-to-day development tasks.