Skip to content
Zachary Wimer edited this page Apr 22, 2018 · 4 revisions

Welcome to the DrShadowStack wiki!

Build Status

DrShadowStack is a software defined dynamic shadow stack implemented via DynamoRIO. DrShadowStack implements a shadow stack any binary given to it, provided the file has an ELF header. If the program attempts to return to a corrupted return address, DrShadowStack will terminate the entire process group (which it sets up). DrShadowStack can handle multi-threaded processes, processes that fork, processes that call any variation of exec. All of these processes will also be protected by DrShadowStack.

Table of Contents

  1. Requirements
  2. Installation Instructions
  3. Usage
  4. Example
  5. Documentation
  6. Developers

Requirements

  1. This project utilizes DynamoRIO version 7.0.17636. This release can be found here.
  2. This project utilizes the C++ library Boost. This library can be built from source, as explained here. On Ubuntu 16.04, this library can be installed as follows:
sudo apt-get update && sudo apt-get install libboost-all-dev
  1. The project is built on Ubuntu 16.04 LTS via CMake. It requires compiler that supports C++11.
  2. The system architecture is in the x86 or x86_64 families.

For more specific information about requirements, visit the requirements wiki page here.

Installation Instructions

  1. Install dependencies
  2. Clone the repository
git clone https://github.com/zwimer/DrShadowStack
  1. Configure the DrShadowStack/src/CMakeLists.txt file. Instructions in the file itself.
  2. Create a build directory
cd DrShadowStack/src
mkdir build && cd build
  1. Build with CMake and make
cmake .. && make -j 4

Usage

The full usage of this program can be found via: ./DrShadowStack --help

In general, the usage is of this format:

./DrShadowStack [--ss_mode <Mode>] <executable target> <target arguments>

There are two different modes, int (internal) and ext (external). The internal mode keeps the shadow stack internally in the DynamoRIO client. The external mode stores the stack in a separate process.

Example

From the build directory of a previous version, an example could be:

vagrant@ubuntu-xenial ~/S/s/build> ./DrShadowStack ls -la ./
total 612
drwxrwxr-x 3 vagrant vagrant   4096 Apr  3 20:01 .
drwxrwxr-x 4 vagrant vagrant   4096 Apr  3 19:59 ..
-rw-rw-r-- 1 vagrant vagrant  14536 Apr  3 19:59 CMakeCache.txt
drwxrwxr-x 7 vagrant vagrant   4096 Apr  3 20:01 CMakeFiles
-rw-rw-r-- 1 vagrant vagrant   1381 Apr  3 19:59 cmake_install.cmake
-rw-rw-r-- 1 vagrant vagrant   8045 Apr  3 20:01 compile_commands.json
-rwxrwxr-x 1 vagrant vagrant 402168 Apr  3 20:01 DrShadowStack
-rwxrwxr-x 1 vagrant vagrant  53264 Apr  3 20:00 libss_dr_client.so
-rwxrwxr-x 1 vagrant vagrant  96304 Apr  3 19:59 libss_support.so
-rw-rw-r-- 1 vagrant vagrant  15265 Apr  3 20:01 Makefile
-rw-rw-r-- 1 vagrant vagrant   8157 Apr  3 20:01 ss_dr_client.ldscript

Documentation

Additional documentation of DrShadowStack can be found in the wiki.

Developers

Before pushing any code, please run the run-before-push.sh script. This will automatically update the changelog and format all C++ code.

Additional documentation to each component of DrShadowStack is built automatically via Travis CI utilizing Doxygen, and hosted here.

You can’t perform that action at this time.