To help you get started with angr, we've created several examples. We've tried to organize them into major categories, and briefly summarize that each example will expose you to. Enjoy!
There are also a great amount of slightly more redunant examples (these mostly stem from CTF problems solved with angr by Shellphish) here.
To jump to a specific category:
- Introduction - examples showing off the very basics of angr's functionality
- Reversing - examples showing angr being used in reverse engineering tasks
- Vulnerability Discovery - examples of angr being used to search for vulnerabilities
- Exploitation - examples of angr being used as an exploitation assistance tool
These are some introductory examples to give an idea of how to use angr's API.
This is a basic script that explains how to use angr to symbolically execute a program and produce concrete input satisfying certain conditions.
Binary, source, and script are found here.
These are examples that use angr to solve reverse engineering challenges. There are a lot of these. We've chosen the most unique ones, and relegated the rest to the CTF Challenges section below.
Whitehat CTF 2015 - Crypto 400
Script author: Yan Shoshitaishvili (github: @Zardus) Script runtime: 30 seconds Concepts presented: statically linked binary (manually hooking with function summaries), commandline argument, partial solutions
We solved this crackme with angr's help. The resulting script will help you understand how angr can be used for crackme assistance, not a full-out solve. Since angr cannot solve the actual crypto part of the challenge, we use it just to reduce the keyspace, and brute-force the rest.
CSAW CTF 2015 Quals - Reversing 500, "wyvern"
Script author: Audrey Dutcher (github: @rhelmot) Script runtime: 15 mins Concepts presented: stdin constraining, concrete optimization with Unicorn
TUMCTF 2016 - zwiebel
Script author: Fish Script runtime: 2 hours 31 minutes with pypy and Unicorn - expect much longer with CPython only Concepts presented: self-modifying code support, concrete optimization with Unicorn
This example is of a self-unpacking reversing challenge. This example shows how to enable Unicorn support and self-modification support in angr. Unicorn support is essential to solve this challenge within a reasonable amount of time - simulating the unpacking code symbolically is very slow. Thus, we execute it concretely in unicorn/qemu and only switch into symbolic execution when needed.
You may refer to other writeup about the internals of this binary. I didn’t reverse too much since I was pretty confident that angr is able to solve it :-)
The long-term goal of optimizing angr is to execute this script within 10 minutes. Pretty ambitious :P
FlareOn 2015 - Challenge 5
Script author: Adrian Tang (github: @tangabc) Script runtime: 2 mins 10 secs Concepts presented: Windows support
This is another reversing challenge from the FlareOn challenges.
"The challenge is designed to teach you about PCAP file parsing and traffic decryption by reverse engineering an executable used to generate it. This is a typical scenario in our malware analysis practice where we need to figure out precisely what the malware was doing on the network"
For this challenge, the author used angr to represent the desired encoded output as a series of constraints for the SAT solver to solve for the input.
0ctf quals 2016 - trace
Script author: WGH (email@example.com) Script runtime: 1 min 50 secs (CPython 2.7.10), 1 min 12 secs (PyPy 4.0.1) Concepts presented: guided symbolic tracing
In this challenge we're given a text file with trace of a program execution. The file has two columns, address and instruction executed. So we know all the instructions being executed, and which branches were taken. But the initial data is not known.
Reversing reveals that a buffer on the stack is initialized with known constant string first, then an unknown string is appended to it (the flag), and finally it's sorted with some variant of quicksort. And we need to find the flag somehow.
angr easily solves this problem. We only have to direct it to the right direction at every branch, and the solver finds the flag at a glance.
Files are here.
ASIS CTF Finals 2015 - license
Script author: Fish Wang (github: @ltfish) Script runtime: 3.6 sec Concepts presented: using the filesystem, manual symbolic summary execution
This is a crackme challenge that reads a license file. Rather than hooking the read operations of the flag file, we actually pass in a filesystem with the correct file created.
DEFCON Quals 2017 - Crackme2000
Script author: Shellphish Script runtime: varies, but on the order of seconds Concepts presented: automated reverse engineering
DEFCON Quals had a whole category for automatic reversing in 2017. Our scripts are here.
These are examples of angr being used to identify vulnerabilities in binaries.
Beginner vulnerability discovery example: strcpy_find
Script author: Kyle Ossinger (github: @k0ss) Concepts presented: exploration to vulnerability, programmatic find condition
This is the first in a series of "tutorial scripts" I'll be making which use angr to find exploitable conditions in binaries.
The first example is a very simple program.
The script finds a path from the main entry point to
strcpy, but only when we control the source buffer of the
To hit the right path, angr has to solve for a password argument, but angr solved this in less than 2 seconds on my machine using the standard python interpreter.
The script might look large, but that's only because I've heavily commented it to be more helpful to beginners.
The challenge binary is here and the script is here.
CGC crash identification
Script author: Antonio Bianchi, Jacopo Corbetta Concepts presented: exploration to vulnerability
This is a very easy binary containing a stack buffer overflow and an easter egg. CADET_00001 is one of the challenge released by DARPA for the Cyber Grand Challenge: link The binary can run in the DECREE VM: link CADET_00001.adapted (by Jacopo Corbetta) is the same program, modified to be runnable in an Intel x86 Linux machine.
Grub "back to 28" bug
Script author: Audrey Dutcher (github: @rhelmot) Concepts presented: unusal target (custom function hooking required), customized state pruning methods
This is the demonstration presented at 32c3. The script uses angr to discover the input to crash grub's password entry prompt.
These are examples of angr's use as an exploitation assistance engine.
Insomnihack Simple AEG
Script author: Nick Stephens (github: @NickStephens) Concepts presented: automatic exploit generation, global symbolic data tracking
Demonstration for Insomni'hack 2016. The script is a very simple implementation of AEG.
SecuInside 2016 Quals - mbrainfuzz - symbolic exploration for exploitability conditions
Script author: nsr (firstname.lastname@example.org) Script runtime: ~15 seconds per binary Concepts presented: symbolic exploration guided by static analysis, using the CFG
Originally, a binary was given to the ctf-player by the challenge-service, and an exploit had to be crafted automatically. Four sample binaries, obtained during the ctf, are included in the example. All binaries follow the same format; the command-line argument is validated in a bunch of functions, and when every check succeeds, a memcpy() resulting into a stack-based buffer overflow is executed. angr is used to find the way through the binary to the memcpy() and to generate valid inputs to every checking function individually.
SECCON 2016 Quals - ropsynth
Script author: Yan Shoshitaishvili (github @zardus) and Nilo Redini Script runtime: 2 minutes Concepts presented: automatic ROP chain generation, binary modification, reasoning over constraints, reasoning over action history
This challenge required the automatic generation of ropchains, with the twist that every ropchain was succeeded by an input check that, if not passed, would terminate the application. We used symbolic execution to recover those checks, removed the checks from the binary, used angrop to build the ropchains, and instrumented them with the inputs to pass the checks.