Skip to content

Latest commit

 

History

History
136 lines (86 loc) · 5.91 KB

README.md

File metadata and controls

136 lines (86 loc) · 5.91 KB

CACAO Roaster logo

pages-build-deployment

Online Instance: https://opencybersecurityalliance.github.io/cacao-roaster/

CACAO Roaster Sub-Project

CACAO Roaster is a sub-project of the Open Cybersecurity Alliance. It is a web application for generating, parsing and validating, manipulating, and visualizing CACAO v2.0 playbooks.

Table of contents

Introduction

As cyber systems become increasingly complex and cybersecurity threats become more prominent, defenders must prepare, coordinate, automate, document, and share their response methodologies to the extent possible. The CACAO standard was developed to satisfy the above requirements providing a common machine-readable framework and schema to document cybersecurity operations processes, including defensive tradecraft and tactics, techniques, and procedures.

For wider adoption of the CACAO standard, it is crucial to support and simplify the playbook creation, modification, and understanding. CACAO Roaster supports the aforementioned by providing a faster and easier way to create, manipulate, visualize and share CACAO playbooks in a “no-code” graphical manner.

The CACAO Roaster web application complies fully to the CACAO v2 CS01 specification.

Project status

The CACAO Roaster is now in a stable version 1.0.0 and is under continuous maintenance and further development. The development team has an overview of open issues/working items, and we will shortly share them on the GitHub issues page.

Integration with other existing OCA or OASIS projects

CACAO, STIX, OpenC2

Screenshots of the application

Start screen of the application. Start screen of the application

Creating a new playbook. Start screen of creating new playbook

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites:

  • node >= 20.5.0
  • npm >= 9.8.0

Installation

npm i

Run the project locally (in development mode)

npm run start

The CACAO Roaster will run locally on: http://localhost:3000/

Building the project for production

npm run build

Deployment

Install serve service on hosting machine

npm install serve

Host production bundle

serve dist

Or use Docker to spin up a fully functioning container

docker build -t cacao-roaster .
docker run -it -p 3000:3000 cacao-roaster

Contributing

Add a brief explanation of what kind of contributions you are looking for and what your requirements are for accepting them. Add a link to CONTRIBUTING.md and a link to [CODE_OF_CONDUCT](link to your code_of_conduct.md file).

Maintainers

Support

Where can people ask for help: this can be any combination of an issue tracker, Slack, a chat room, an email address, etc.

Sign up for our mailing list

Stay up to date on meetings, announcements and other discussions with the CACAO Roaster mailing list. To subscribe, send an empty email to oca-cacao-roaster+subscribe@lists.oasis-open-projects.org.

Join us on Slack

CACAO Roaste has a Slack channel on the OCA Slack. Join here and say hi in #cacao-roaster.

License

Example text: This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details

Governance

[Open Project name] operates under the terms of the Open Project Rules and the applicable license(s) specified in LICENSE.md. Further details can be found in GOVERNANCE.md.

CLA & Non-assert signatures required

All technical contributions must be covered by a Contributor's License Agreement. This requirement allows our work to advance through OASIS standards development stages and potentially be submitted to de jure organizations such as ISO. You will get a prompt to sign this document when you submit your first pull request to a project repository, or you can sign here. If you are contributing on behalf of your employer, you must also sign the ECLA here.