Skip to content
KLEE Symbolic Execution Engine
C++ C CMake Other
Branch: master
Clone or download
Pull request Compare This branch is 200 commits ahead, 60 commits behind klee:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

KLEE-NATIVE

KLEE Symbolic Virtual Machine

Build Status Coverage

KLEE is a symbolic virtual machine built on top of the LLVM compiler infrastructure. Currently, there are two primary components:

  1. The core symbolic virtual machine engine; this is responsible for executing LLVM bitcode modules with support for symbolic values. This is comprised of the code in lib/.

  2. A POSIX/Linux emulation layer oriented towards supporting uClibc, with additional support for making parts of the operating system environment symbolic.

Additionally, there is a simple library for replaying computed inputs on native code (for closed programs). There is also a more complicated infrastructure for replaying the inputs generated for the POSIX/Linux emulation layer, which handles running native programs in an environment that matches a computed test input, including setting up files, pipes, environment variables, and passing command line arguments.

For further information, see the webpage.

Build Instructions

Build instructions (assuming you have typical KLEE dependencies like z3 installed). This assumes you're on either Ubuntu 18.04 or 16.04, but should work for 14.04 too.

  1. git clone git@github.com:trailofbits/remill.git
  2. cd remill/tools
  3. git clone git@github.com:trailofbits/klee.git
  4. cd ../../
  5. ./remill/scripts/build.sh --llvm-version 7.0 --use-host-compiler
  6. cd remill-build
  7. make install
  8. cd ..

If you have an issue with the last step, or later issues with things like registering a target machine, then try removing --use-host-compiler or changing to llvm version 8.0. The build.sh script downloads pre-built binaries/libraries for things like LLVM, Clang, XED, etc., and sometimes there are ABI-related linking issues for libc++ vs. libstdc++.

Snapshotting

The snapshotting program allows for the program state to be saved and loaded into the KLEE executor. It prepares a workspace directory to be later used for the klee-exec program. When a breakpoint is specified, the program will run natively until it reaches that point in execution. At that moment program state is saved.

Usage: ./klee-snapshot-[llvm-version-number] --workspace_dir [PATH TO WORKSPACE DIR] [FLAGS] -- [PATH TO BINARY]

FLAGS:

* --arch 
    OPTIONS [amd64, amd64_avx, amd64_avx512, aarch64]

* --dynamic   
    bool that represents if the binary is dynamically linked. Set to false by default.

* --breakpoint
    virtual address where snapshot is taken during execution. If the --dynamic flag is
    specified then a virtual offset is expected. It is recommended that for dynamic binaries a
    disassembler is used to find an area of interest in the program and that virtual offset is 
    inputted. 

* --verbose

* --os

Executing

Lifts code and runs it in the KLEE's executor from a workspace directory with snapshot information.

Usage: ./klee-exec-[llvm-version-number] --workspace_dir [PATH TO WORKSPACE DIR]

FLAGS:

* --symbolic_stdin
    bool that makes inputs to stdin automatic and symbolic

Example after build:

  • Dynamic Binary
  1. ./klee-snapshot-7.0 --workspace_dir ws --dynamic --breakpoint 0x1337 --arch amd64_avx -- ./a.out
  2. ./klee-exec-7.0 --workspace_dir ws --symbolic_stdin
  • Static Binary
  1. ./klee-snapshot-7.0 --workspace_dir ws --breakpoint 0x555555555555 --arch amd64 -- ./a.out
  2. ./klee-exec-7.0 --workspace_dir ws

Additional Information

An important thing to note is that if your native cpu supports sse instructions, and you decide to snapshot after cpuid is called natively, then you must specify an avx option for the architecture of the snapshot. otherwise those kinds of instructions won't lift. If you encounter any problems or desire additional information feel free to file an issue, or get on Empire Hacking Slack.

You can’t perform that action at this time.