Skip to content

Latest commit

 

History

History
123 lines (99 loc) · 3.85 KB

Getting_started.md

File metadata and controls

123 lines (99 loc) · 3.85 KB
Raw

Pre-requisites

  • python
    • 2.7 for orthrus
    • 3.X for afl-utils
  • afl-fuzz
  • afl-utils
  • virtualenv and virtualenvwrapper (optional but highly recommended)
$ pip install virtualenv && pip install virtualenvwrapper
  • Clang/LLVM toolchain (Tested with v3.8)
$ sudo apt-get install lcov
$ curl -sSL "http://apt.llvm.org/llvm-snapshot.gpg.key" | sudo -E apt-key add -
$ echo "deb http://apt.llvm.org/trusty/ llvm-toolchain-trusty-3.8 main" | sudo tee -a /etc/apt/sources.list > /dev/null
$ sudo apt-get update
$ sudo apt-get --no-install-suggests --no-install-recommends --force-yes install clang-3.8 libclang-common-3.8-dev llvm-3.8-runtime llvm-3.8
  • lcov
$ sudo apt-get install lcov
  • pysancov
$ wget -q https://raw.githubusercontent.com/llvm-mirror/compiler-rt/release_38/lib/sanitizer_common/scripts/sancov.py &> /dev/null
$ chmod +x sancov.py &> /dev/null
$ sudo mv sancov.py /usr/local/bin/pysancov &> /dev/null
  • bear (v2.1.5) for clang tooling compile commands (xenial users: sudo apt-get install bear, other users, do as follows)
$ wget https://launchpadlibrarian.net/240291131/bear_2.1.5.orig.tar.gz
$ tar xzf bear_2.1.5.orig.tar.gz && rm bear_2.1.5.orig.tar.gz
$ mkdir Bear-2.1.5.build && cd Bear-2.1.5.build && cmake ../Bear-2.1.5 && make -j all && make install 
$ cd .. && rm -rf Bear-2.1.5 Bear-2.1.5.build
  • clang-sdict for input dictionary generation
$ export CLANG_SDICT="https://www.dropbox.com/s/lqayfheheo3coag/fork-6173707-6216-gb24cc33-153448-2017-04-10.tar.gz?dl=0"
$ curl -o clang.tar.gz -L "$CLANG_SDICT"
$ tar xzf clang.tar.gz -C $HOME/local
$ export PATH=$PATH:$HOME/local
  • An autotools open-source project for fuzzing

Python package dependencies

You can install Orthus' python dependencies (afl-utils, and afl-cov) via virtualenvwrapper or natively. The former is recommended.

Using Virtualenvwrapper

All steps that work assume that you are creating and working with the afl virtualenv (workon afl)

  • afl-utils v1.32a
$ mkvirtualenv -p /usr/bin/python3.4 afl
$ wget -q https://github.com/rc0r/afl-utils/archive/v1.32a.tar.gz && tar xzf v1.32a.tar.gz
$ rm v1.32a.tar.gz && cd afl-utils-1.32a
$ python setup.py install
  • afl-cov (v0.6)
$ wget -q https://github.com/mrash/afl-cov/archive/0.6.tar.gz && tar xzf 0.6.tar.gz
$ rm 0.6.tar.gz && cd afl-cov-0.6
$ cp afl-cov ~/.virtualenvs/afl/bin/

Native installation

  • afl-utils v1.32a
$ cd $HOME
$ wget -q https://github.com/rc0r/afl-utils/archive/v1.32a.tar.gz && tar xzf v1.32a.tar.gz
$ rm v1.32a.tar.gz && cd afl-utils-1.32a
$ sudo mkdir -p /usr/lib/python3.4/site-packages && sudo python3 setup.py install
$ cd ../
$ echo "source /usr/lib/python3.4/site-packages/exploitable-1.32_rcor-py3.4.egg/exploitable/expl
$ sudo rm -rf afl-utils-1.32a
  • afl-cov (v0.6)
$ wget -q https://github.com/mrash/afl-cov/archive/0.6.tar.gz && tar xzf 0.6.tar.gz
$ rm 0.6.tar.gz && cd afl-cov-0.6
$ sudo cp afl-cov /usr/local/bin/
$ cd .. && rm -rf afl-cov-0.6

Installation

Using Virtualenvwrapper

$ mkdir -p ~/.virtualenvs/afl/lib/python2.7/site-packages/
$ export PYTHONPATH=$HOME/.virtualenvs/afl/lib/python2.7/site-packages
$ git clone https://github.com/test-pipeline/orthrus.git && cd orthrus
$ python2.7 setup.py install --prefix ~/.virtualenvs/afl

A convenient alias would be something like this appended to ~/.bash_aliases

# Uses the right PYTHONPATH before invoking orthrus
alias orthrus=`PYTHONPATH=$HOME/.virtualenvs/afl/lib/python2.7/site-packages orthrus`

Whenever you want to fuzz an autotools codebase, you may simply summon orthrus, afl-utils, and afl-cov by doing workon afl.

Native installation

$ (sudo) python2.7 setup.py install