add deps.sh

Author: lunixbochs

README.md

@@ -1,6 +1,5 @@
 patchkit
 ----
-
 Patches an ELF binary using one or more simple Python scripts.
 
 Usage:
@@ -10,13 +9,11 @@ Usage:
 
 patchdir
 ----
-
 Contains one or more Python patch files, which will be executed in alphabetical order against a binary.
 
 
 Patch Example
 ----
-
     def patch(pt):
         # nop out a jump at the entry point
         pt.patch(pt.entry, hex='90' * 5)
@@ -30,7 +27,6 @@ Patch Example
 
 API
 ----
-
     addr = search(data)
     hook(addr, new_addr)
     patch(addr, *compile arg*)
@@ -46,7 +42,6 @@ API
 
 IDA scripts
 ----
-
 Some scripts live in the ida/ path. Run them like this:
 
     /Applications/IDA\ Pro\ 6.8/idaq.app/Contents/MacOS/idaq64 -A -B -Sida/allfuncs.py a.out
@@ -56,14 +51,16 @@ When invoked like this, allfuncs.py will generate `a.out.funcs` which is used by
 
 Tools
 ----
+These are somewhat CGC and x86-specific right now, but will be ported for general use in the future.
+
 - explore: uses a Python CFG and recursive backtracking emulator to find basic blocks in an executable
 - bindiff: uses the block boundaries from an explore run, as well as additional analysis to find and output basic block diffs between two binaries
 
 
 Dependencies
 ----
-* Capstone Engine - https://github.com/aquynh/capstone.git
-* Keystone Engine - https://github.com/keystone-engine/keystone.git
-* Unicorn Engine  - https://github.com/unicorn-engine/unicorn.git
-* Python bindings for the above: `cd bindings/python; sudo make install`
-* Python coding library: `pip install coding`
+- Python coding library: `pip install coding`
+- Run `./deps.sh` to automatically install these.
+  - Capstone Engine - https://github.com/aquynh/capstone.git
+  - Keystone Engine - https://github.com/keystone-engine/keystone.git
+  - Unicorn Engine  - https://github.com/unicorn-engine/unicorn.git

deps.sh

@@ -0,0 +1,61 @@
+#!/bin/bash -u
+
+echo
+echo "Take a look here if Unicorn fails to build:"
+echo " https://github.com/unicorn-engine/unicorn/blob/master/docs/COMPILE-NIX.md"
+echo
+echo "If you're on Ubuntu, you want to do this first:"
+echo " sudo apt-get update"
+echo " sudo apt-get install python-pip build-essential git cmake python-dev libglib2.0-dev"
+echo
+echo "If you're on a Mac, do this first:"
+echo " brew install pkg-config glib cmake"
+echo
+echo "Using ./build as a tmp dir. ^C if that's a bad idea."
+echo
+echo -n "[press enter to continue]"
+read
+echo
+
+cwd=$(pwd)
+build="$cwd/build"
+
+mkdir build &>/dev/null
+set -e
+
+echo "[*] Building Keystone"
+cd "$build"
+git clone https://github.com/keystone-engine/keystone.git
+cd keystone && mkdir build && cd build
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DLLVM_TARGETS_TO_BUILD="all" -G "Unix Makefiles" .. && make -j2
+echo
+
+echo "[*] Building Capstone"
+cd "$build"
+git clone https://github.com/aquynh/capstone.git
+cd capstone && make -j2
+echo
+
+echo "[*] Building Unicorn"
+cd "$build"
+git clone https://github.com/unicorn-engine/unicorn.git
+cd unicorn && ./make.sh
+
+echo
+echo "[*] Installing projects and Python bindings (using sudo)"
+cd "$build/keystone/build" && sudo make install
+cd "$build/keystone/bindings/python" && sudo make install
+
+cd "$build/capstone" && sudo make install
+cd "$build/capstone/bindings/python" && sudo make install
+
+cd "$build/unicorn" && sudo ./make.sh install
+cd "$build/unicorn/bindings/python" && sudo make install
+
+which ldconfig &>/dev/null && sudo ldconfig
+
+echo
+echo "All done! Don't forget to `sudo pip install coding`, or use a virtualenv if you're hip with that."
+echo
+echo -n "Testing Python import: "
+python -c "import capstone, keystone, unicorn; print 'works.'"