Code Monkey home page Code Monkey logo

forrest's Introduction

FoRREST

A Framework of Robust Reverse Engineering Software Tools

Version 0.8

Overview

The purpose of this project is to create a binary executable analysis framework that combines existing tools into one package. It also makes it easier to create or install tools into the framework for use.

Background

This project was started as part of a National Science Foundation Foundation funded research experience for undergraduates (REU) program at Wright State University in Dayton, Ohio.

FoRREST is currently designed for Linux

Requirements

  • Python 2.7
  • python-magic
  • pyreadline
  • peewee
  • Radare2
  • angr
    • angr-utils (necessary files included already)
    • pydot
    • networkx
    • graphviz

Installation

During the installation, you will be prompted as to whether you want to install angr. This is to allow for a shorter installation time in the event that you only plan to use the lower level functions (e.g. using FoRREST as an introduction to reverse engineering).

####A Note on angr On angr's installation page, they recommend using a Python virtual environment because they have their own versions of z3 and pyvex. We do not currently do this in FoRREST, and the installation script will install the angr-custom versions of those programs.

At this point, we are not offering support for FoRREST while running angr in a virtual environment. However, if you would like to install it in a virtual environment, following these instructions should help you avoid some common problems when installing angr:

  • Install dependencies:
    • sudo apt-get install python-dev libffi-dev build-essential virtualenvwrapper
  • Make sure virtualenvwrapper is callable from bash
    • whereis virtualenvwrapper
    • sudo chmod +x PATH/TO/virtualenvwrapper.sh
    • Add the following to ~/.bashrc:
      • export WORKON_HOME=$HOME/.virtualenvs
      • source PATH/TO/virtualenvwrapper.sh
    • Then, source ~/.bashrc
  • Install several angr dependencies individually (as they tend to cause errors)
    • sudo apt-get install -I --no-use-wheel capstone angr-only-z3-custom
  • Finally, mkvirtualenv angr && pip install angr

Running

To run the program with the command line interface, from the root directory:

python main.py

Extending

To extend the program, just import FoRREST into Python

~$ python
>>> from FoRREST import FoRREST

Acknowledgments

This work was partially supported by the NSF Research Experiences for Undergraduates Site Award titled “REU Site: Cyber Security Research at Wright State University” (CNS 1560315).

forrest's People

Contributors

loganrickert avatar drsutherin avatar colemloewer avatar

Stargazers

 avatar  avatar John Vishnefske avatar  avatar

Watchers

 avatar James Cloos avatar hqax avatar  avatar  avatar  avatar

Forkers

rotbot9k hqax

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.