Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/angr/angr

A powerful and user-friendly binary analysis platform!
https://github.com/angr/angr

analysis angr binary hacktoberfest

Last synced: 20 days ago
JSON representation

A powerful and user-friendly binary analysis platform!

Lists

README 

        
# angr



[![Latest Release](https://img.shields.io/pypi/v/angr.svg)](https://pypi.python.org/pypi/angr/)

[![Python Version](https://img.shields.io/pypi/pyversions/angr)](https://pypi.python.org/pypi/angr/)

[![PyPI Statistics](https://img.shields.io/pypi/dm/angr.svg)](https://pypistats.org/packages/angr)

[![License](https://img.shields.io/github/license/angr/angr.svg)](https://github.com/angr/angr/blob/master/LICENSE)



angr is a platform-agnostic binary analysis framework.

It is brought to you by [the Computer Security Lab at UC Santa Barbara](https://seclab.cs.ucsb.edu), [SEFCOM at Arizona State University](https://sefcom.asu.edu), their associated CTF team, [Shellphish](https://shellphish.net), the open source community, and **[@rhelmot](https://github.com/rhelmot)**.



## Project Links

Homepage: https://angr.io



Project repository: https://github.com/angr/angr



Documentation: https://docs.angr.io



API Documentation: https://api.angr.io/en/latest/



## What is angr?



angr is a suite of Python 3 libraries that let you load a binary and do a lot of cool things to it:



- Disassembly and intermediate-representation lifting

- Program instrumentation

- Symbolic execution

- Control-flow analysis

- Data-dependency analysis

- Value-set analysis (VSA)

- Decompilation



The most common angr operation is loading a binary: `p = angr.Project('/bin/bash')` If you do this in an enhanced REPL like IPython, you can use tab-autocomplete to browse the [top-level-accessible methods](https://docs.angr.io/docs/toplevel) and their docstrings.



The short version of "how to install angr" is `mkvirtualenv --python=$(which python3) angr && python -m pip install angr`.



## Example



angr does a lot of binary analysis stuff.

To get you started, here's a simple example of using symbolic execution to get a flag in a CTF challenge.



```python

import angr



project = angr.Project("angr-doc/examples/defcamp_r100/r100", auto_load_libs=False)



@project.hook(0x400844)

def print_flag(state):

    print("FLAG SHOULD BE:", state.posix.dumps(0))

    project.terminate_execution()



project.execute()

```



# Quick Start



- [Install Instructions](https://docs.angr.io/introductory-errata/install)

- Documentation as [HTML](https://docs.angr.io/) and sources in the angr [Github repository](https://github.com/angr/angr/tree/master/docs)

- Dive right in: [top-level-accessible methods](https://docs.angr.io/core-concepts/toplevel)

- [Examples using angr to solve CTF challenges](https://docs.angr.io/examples).

- [API Reference](https://angr.io/api-doc/)

- [awesome-angr repo](https://github.com/degrigis/awesome-angr)