This repo is deprecated. Please use activecm/rita instead.
Go Shell Makefile
Clone or download
ethack Merge pull request #169 from Zalgo2462/master-dep
Add Go Dep to the master branch
Latest commit 7944e4e Jan 27, 2018

Readme.md

RITA (Real Intelligence Threat Analytics)

Brought to you by Offensive CounterMeasures.


What is Here

RITA is an open source framework for network traffic analysis.

The framework ingests Bro Logs, and currently supports the following analysis features:

  • Beaconing: Search for signs of beaconing behavior in and out of your network
  • DNS Tunneling Search for signs of DNS based covert channels
  • Blacklisted: Query blacklists to search for suspicious domains and hosts
  • URL Length Analysis: Search for lengthy URLs indicative of malware
  • Scanning: Search for signs of port scans in your network

Additional functionality is being developed and will be included soon.

Automatic Installation

The automatic installer is officially supported on Ubuntu 14.04, 16.04 LTS, Security Onion, and CentOS 7

  • Clone the package: git clone https://github.com/ocmdev/rita.git
  • Change into the source directory: cd rita
  • Make the installer executable: chmod +x install.sh
  • Run the installer: sudo ./install.sh
  • Source your .bashrc (the installer added RITA to the PATH): source ~/.bashrc
  • Start MongoDB: sudo service mongod start

Manual Installation

To install each component of RITA by hand, check out the instructions in the wiki.

Configuration File

RITA contains a yaml format configuration file.

You can specify the location for the configuration file with the -c command line flag. If not specified, RITA will first look for the configuration in ~/.rita/config.yaml then /etc/rita/config.yaml.

API Keys

RITA relies on the the Google Safe Browsing API to check network log data for connections to known threats. An API key is required to use this service. Obtaining a key is free, and only requires a Google account.

To obtain an API key:

  • Go to the Google cloud platform console.
  • From the projects list, select a project or create a new one.
  • If the API Manager page is not already open, open the left side menu and select API Manager.
  • On the left, choose Credentials.
  • Click Create credentials and then select API key.
  • Copy this API key to the APIKey field under SafeBrowsing in the configuration file.
  • On the left, choose Library.
  • Search for Safe Browsing.
  • Click on Google Safe Browsing API.
  • Near the top, click Enable.

Getting Started

Obtaining Data (Generating Bro Logs):

  • Option 1: Generate PCAPs outside of Bro

    • Generate PCAP files with a packet sniffer (tcpdump, wireshark, etc.)
    • (Optional) Merge multiple PCAP files into one PCAP file
      • mergecap -w outFile.pcap inFile1.pcap inFile2.pcap
    • Generate bro logs from the PCAP files
      • Set local_nets to your local networks
      • bro -r pcap_to_log.pcap local "Site::local_nets += { 192.168.0.0/24 }" "Log::default_rotation_interval = 1 day"
  • Option 2: Install Bro and let it monitor an interface directly [instructions]

    • You may wish to compile Bro from source for performance reasons
    • The automated installer for RITA installs pre-compiled Bro binaries

Importing Data Into RITA

  • After installing, rita should be in your PATH
  • Option 1: Import directly from the terminal (one time import)
    • rita import -i path/to/your/bro_logs/ -d dataset_name
  • Option 2: Set up the Bro configuration in ~/.rita/config.yaml for repeated imports
    • Set LogPath to the path/to/your/bro_logs
    • Set DBPrefix to an identifier common to your set of logs
    • Set up the DirectoryMap
      • Logs found in folders which match the substring on the left are imported into the dataset on the right
    • Example
      • Say you have two sets of logs to analyze
        • /share/bro_logs/networkA
        • /share/bro_logs/networkB
      • A correct Bro config section would look like
      Bro:
          LogPath: /share/bro_logs/
          DBPrefix: MyCompany_
          DirectoryMap:
            networkA: A
            networkB: B
      • This would import /share/brologs/networkA into MyCompany_A and /share/brologs/networkB into MyCompany_B

Analyzing Data With RITA

  • Option 1: Analyze one dataset
    • rita analyze -d dataset_name
    • Ex: rita analyze -d MyCompany_A
  • Option 2: Analyze all imported datasets
    • rita analyze

Examining Data With RITA

  • Use the show-X commands
  • -H displays human readable data
  • rita show-beacons -d dataset_name -H
  • rita show-blacklisted -d dataset_name -H

A link to a video tutorial will be added soon!

Getting help

Head over to OFTC and join #ocmdev for any questions you may have.

Contributing to RITA

To contribute to RITA visit our Contributing Guide

License

GNU GPL V3 © Offensive CounterMeasures ™