Giter Club home page Giter Club logo

reternal-quickstart's Introduction

RE:TERNAL


Drawing

version


Note: Still under development, only use for testing and do not expose interfaces

RE:TERNAL is a centralised purple team simulation platform. Reternal uses agents installed on a simulation network to execute various known red-teaming techniques in order to test blue-teaming capabilities. The simulations are mapped to the MITRE ATT&CK framework. This repo contains the compose file in order to set up the reternal platform via docker. An additional import script is available to create your first user and import Mitre and Metta databases.

Reternal components

Component Description Code Build
API Administrative API to schedule tasks Python Build Status
UI VueJS-based UI buildscript and NGinx webserver VueJS Build Status
C2 Seperate API endpoint that agents use to communicate with Python Build Status
Agent Compiler Service that compiles the agent (Golang) payloads Python Go Build Status

Compose Status

Component Description Build
Total Stack Build verifying entire stack via docker-compose in this repository Build Status

Additional components

Component Description
Quickstart Quickstart repo that contains the compose-file and management tools to create users, techniques etc
Mitre Repository containing already existing mapped techniques for reternal

Drawing

Component installation

Reternal components are primarily aimed to be run as docker containers since the component configuration depends on environment variables set by docker-compose or the dockerfile. A docker-compose with all the default options can be found in this repository.

Pre-Requirements

  • docker
  • docker-compose
  • python3
  • pip (3)

Getting started

  • Clone the quickstart repo to your system: git clone https://github.com/d3vzer0/reternal-quickstart --recurse
  • Navigate to the reternal-quickstart directory: cd reternal-quickstart
  • Install pip dependencies: pip3 install -r requirements.txt
  • Create unique keys for JWT and Session tokens: python3 manage.py -a update -t compose

When done, execute 'docker-compose up -d --build' inside the root reternal-quickstart directory to run all the services. The latest version from the Development branch will be pulled and build.

Post-setup

The quickstart repo contains a management script called 'manage.py'. You can use this script to create your first user and import already existing techniques.

  • Configure all variables and create first user: python3 manage.py -a install -t all

You can now open a browser of choice and navigate to http://localhost. Use the credentials you just created via the manage.py script.

Individual options
  • Create user: python3 manage.py -a create -t user
  • Import Mitre DB: python3 manage.py -a import -t mitre
  • Import Techniques: python3 manage.py -a import -t mapping
  • Create Default commands: python3 manage.py -a create -t command

Feature Requests & Bugs

We use the Github to manage Feature requests and Bug reports.

Developers and Contact

Joey Dreijer < [email protected] >
Yaleesa Borgman < [email protected] >

Whats up with the name?

This project has been re-developed so many times, it will probably never really finish. Hence RE (Redo) and Ternal (Eternal).

Special Thanks

Screenshots

Technique mapping

alt text

Recipe builder

alt text

Included MITRE DB for details

alt text

Interactive terminal

alt text

Agents overview

alt text

Screenshot galery from agents

alt text

Included MITRE DB for details

alt text

reternal-quickstart's People

Contributors

d3vzer0 avatar olafhartong avatar

Watchers

Budi Khoirudin avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.