py-openkat 1.2.1

A lightweight version of OpenKAT.

Openkat

An experimental sandbox environment to easily experiment with (some) functionality of openkat. This version of openkat runs all services in a single process and replaces services such as Bytes, Rabbitmq and Celery with an in-memory implementation. As a consequence, the current version does not guarantee persistence beyond the lifetime of the process. It speaks for itself that this library should not be used in a production environment. To properly deploy an openkat instance, please refer to the official documentation on Github.

Overview

Features

These features of openkat are currently present in this package

• The Rocky interface: UI around reporting on Findings
• The Octopoes models: for modelling the Objects Of Interest (OOIs)
• The Boefjes/Normalizers: the python scripts that find OOIs (excluding the containerized versions)
• The Scheduler: dispatching Boefjes and Normalizers automatically

Benefits

The benefits and extra features of this package are:

• Lightweight: a single process for the app, reducing overhead of the official services and installation times
• A default superuser and development organization
• OTP disabled to optimize for restarting the service even after an update
• Adding plugins by creating plugins in a custom plugins folder

Missing Features

However, some features are excluded from this version on purpose:

• Audit trailing using Bytes
• Miscellaneous functionality in the interface, such as specifying a depth of an OOI tree and custom images in the KATalogus
• Deletion Propagation: you have to manually delete every single OOI
• ScanProfile inheritance: you have to manually add scan profiles to observed OOIs
• Valid times: you cannot browse the OOI history through time

Coming Features

Some missing features are still to be added:

• Bits
• Object persistence beyond server lifetime

Installation

$ pip install py-openkat

Usage

To start the instance, run

$ python -m openkat

and navigate to http://localhost:8000. Login with email [e-mail] and password superuser. You can start adding your objects now (see the official documentation). Note: restarting the service clears your object database.

Dependencies

To use the Dockerized boefjes, you must have Docker installed on your machine.

Contributing

Dependencies:

• poetry
• yarn

To setup a development environment, run

$ make init

To build, run

$ make build