/unfetter

Main Build directory

Primary LanguageShellOtherNOASSERTION

Unfetter

Welcome to the Unfetter project, a reference implementation inspired by The MITRE Corporation's Cyber Analytics Repository (CAR) and Adversarial Tactics, Techniques, and Common Knowledge (ATT&CK™) projects.

This reference implementation provides a framework for collecting events (process creation, network connections, Window Event Logs, etc.) from a client machine (Windows 7) and performing CAR analytics to detect potential adversary activity.

The goal of this effort is to enable analytic developers, malware analysts, or infrastructure owners to experiment with existing adversary detection analytics or create additional analytics. Efforts have been made to simplify the installation and setup of this reference implementation. While scalable components have been used, this is meant to be a development system. A production architecture would need to be further developed to run in a large scale environment.

Please see our webpage for more details: https://www.unfetter.io.

System Requirements

Project Setup

Unfetter Analytic uses three different systems to really work. First, is the analytic system, based on an ELK stack with Apache Spark on top. The second, is the Unfetter Discover Web service. The third system is any Windows machine that can generate Sysmon and Windows Events and ship to the Unfetter Analytic system.

Details for setting up this project are at https://iadgov.github.io/unfetter/analytic-setup.html

To quickly get the Unfetter Analytic and Unfetter Discover systems running, follow these steps.

Create a directory to hold all the projects,

mkdir unfetter-analytic
cd unfetter-analytic

Next, you will need to clone all the projects in unfetter-analytic.

 curl -s https://api.github.com/orgs/unfetter-analytic/repos\?per_page\=200 | perl -ne 'print "$1\n" if (/"clone_url": "([^"]+)/)' | xargs -n 1 git clone

Next, change directories into the unfetter directory, which houses the docker-compose.yml files, and run docker-compose

cd unfetter
docker-compose up

Kibana

After running the docker-compose command, you can view the Kibana application at: https://localhost/

The Web Application

After running the docker-compose command you can view the application at:

https://localhost/unfetter-discover-ui/

Note: If you receive a 404 error from nginx, ensure you include the trailing slash on the URL

Unfetter-Discover will create certs and store them locally. You will need to accept the certificates to move forward.

ATT&CK is a trademark of The MITRE Corporation.