This project has moved to https://github.com/oasis-open/openc2-yuuki

openc2-yuuki

"My family name is Yugano. My given name is Yuuki. I have no redeeming qualities. ... This is because the Internet has ruined my way of looking at the world."

from A Girl Corrupted by the Internet is the Summoned Hero?! by Eliezer Yudkowsky

Yuuki is a Python package for building an OpenC2 proxy. Yuuki is currently compatible with Python 2.7 only.

Getting Started

Create a python virtual environment and pip install yuuki. (Yuuki is alpha software; installing globally is not recommended.)

Install virtualenv via pip:

$ pip install virtualenv

Create and activate a python virtual environment:

$ mkdir test_yuuki
$ cd test_yuuki
$ virtualenv venv
$ source venv/bin/activate

Download and install yuuki

$ git clone https://github.com/OpenC2-org/openc2-yuuki.git
$ pip install ./openc2-yuuki

Usage

Start a proxy:

python -m yuuki.proxy simple_profile.py

Start a debug shell:

python -m yuuki.shell http://localhost:9001

The general form of a command issued from the debug shell:

openc2> ACTION target:type {some: specifier, another: specifier} actuator:type {some: specifier} some: modifier, another: modifier

Actuators and modifiers are optional.

Examples supported by simple_profile.py

openc2> DENY openc2:domain {URI: evil.com}
openc2> DENY openc2:user {name: John}
openc2> MITIGATE openc2:file {} openc2:rm {}