unix-like reverse engineering framework and commandline tools security
Permalink
Failed to load latest commit information.
.github Update ISSUE_TEMPLATE.md Feb 18, 2018
binr Fix build Oct 15, 2018
doc Add zign hash using sha256 (#11822) Oct 15, 2018
libr Fix #11834 - Check fbsd/nbsd versions for clock_nanosleep ##port Oct 18, 2018
man Fix rahash2 man page (#11768) Oct 8, 2018
mk clang build fix, propagate initial CC setting (#10316) Jun 11, 2018
pkgcfg Make xxhash dependency optional in acr and meson (#10901) Aug 6, 2018
prefix Better webui, 'pi' counts opcodes and remove /new and htmlgraph Jan 25, 2013
shlr Fix a null assert in java parser and bring back the libr.pc.acr Oct 15, 2018
sys Fix regexes in sys/release-notes.sh Oct 17, 2018
t Make git clones quieter Oct 6, 2018
.appveyor.yml Meson: Some little fixes (#9783) Mar 30, 2018
.clang-format gcc8 warnings (fixes #10338) (#11798) Oct 12, 2018
.gitignore Create script to apply style to diffs (#11261) Sep 26, 2018
.travis.yml Git clone in quiet mode to shrink travis logs Oct 6, 2018
AUTHORS.md Grammar edits to README.md (#11713) Oct 2, 2018
CONTRIBUTING.md Grammar edits to README.md (#11713) Oct 2, 2018
COPYING Honor FSF filename license rules (LICENSE->COPYING) Mar 29, 2013
COPYING.LESSER Honor FSF filename license rules (LICENSE->COPYING) Mar 29, 2013
DEVELOPERS.md Grammar edits to README.md (#11713) Oct 2, 2018
Dockerfile Make git clones quieter Oct 6, 2018
Dockerfile.travis Coverage codecov (#11494) Sep 12, 2018
Doxyfile Initial doxygen config Jun 15, 2018
Makefile Bring back mrproper to fix all the recent build issues Aug 13, 2018
README.md Grammar edits to README.md (#11713) Oct 2, 2018
Vagrantfile Add Vagrantfile for radare2 + ArchLinux Dec 18, 2017
Vagrantfile.sh Add Vagrantfile for radare2 + ArchLinux Dec 18, 2017
autogen.sh Improve autogen.sh to use r2pm if available Oct 15, 2018
config-user.mk.acr ptrace-wrap (#11723) Oct 12, 2018
configure Release 3.0.0 (codename: its-still-radare2) Oct 16, 2018
configure-plugins Fix meson build on macOS May 14, 2017
configure.acr Release 3.0.0 (codename: its-still-radare2) Oct 16, 2018
configure.hook Fix shellcheck problem in scripts Apr 29, 2015
env.sh Add more R2_ prefix for some var Aug 7, 2018
global.mk Avoid hardcoding prefix in global.mk (#11813) Oct 14, 2018
meson.build ptrace-wrap (#11723) Oct 12, 2018
meson_options.txt Reimplement TCP Server with libuv and add configure/meson flags (#11403) Sep 17, 2018
package.json Appveyor windows-installer integration Jun 5, 2017
plugins.bin.cfg Fix core.anal -> core.a2f in plugins.*.cfg Aug 1, 2018
plugins.def.cfg C-Sky and MCore support for r2 (#11448) Sep 8, 2018
plugins.emscripten.cfg Fix core.anal -> core.a2f in plugins.*.cfg Aug 1, 2018
plugins.ios-store.cfg Fix core.anal -> core.a2f in plugins.*.cfg Aug 1, 2018
plugins.ios.cfg Fix core.anal -> core.a2f in plugins.*.cfg Aug 1, 2018
plugins.nogpl.cfg Fix core.anal -> core.a2f in plugins.*.cfg Aug 1, 2018
plugins.static.cfg Fix core.anal -> core.a2f in plugins.*.cfg Aug 1, 2018
plugins.tiny.cfg Fix core.anal -> core.a2f in plugins.*.cfg Aug 1, 2018
radare2.spec SPEC file updated to version 0.10.0 Oct 25, 2015
snapcraft.yaml Fixed snapcraft.yaml to work on build.snapcraft.io Jul 18, 2018
travis-extract-var.sh Coverage codecov (#11494) Sep 12, 2018
travis-script Make git clones quieter Oct 6, 2018

README.md

    ____  ___  ___  ___ ____  ___    ____
   |  _ \/   \|   \/   \  _ \/ _ \  (__  \
   |    (  -  | |  ) -  |   (   _/  /  __/
   |__\__|_|__|___/__|__|_\__|___|  |____|

                https://www.radare.org

                                  --pancake
Jenkins Build Status
TravisCI Build Status
AppVeyor Build Status
Coverity Build Status
Infrastructure CII Best Practices
Codecov codecov
Packaging status

Introduction

r2 is a rewrite from scratch of radare in order to provide a set of libraries and tools to work with binary files.

Radare project started as a forensics tool, a scriptable commandline hexadecimal editor able to open disk files, but later support for analyzing binaries, disassembling code, debugging programs, attaching to remote gdb servers, ..

radare2 is portable.

Architectures

i386, x86-64, ARM, MIPS, PowerPC, SPARC, RISC-V, SH, m68k, AVR, XAP, System Z, XCore, CR16, HPPA, ARC, Blackfin, Z80, H8/300, V810, V850, CRIS, XAP, PIC, LM32, 8051, 6502, i4004, i8080, Propeller, Tricore, Chip8 LH5801, T8200, GameBoy, SNES, MSP430, Xtensa, NIOS II, Dalvik, WebAssembly, MSIL, EBC, TMS320 (c54x, c55x, c55+, c66), Hexagon, Brainfuck, Malbolge, DCPU16

File Formats

ELF, Mach-O, Fatmach-O, PE, PE+, MZ, COFF, OMF, TE, XBE, BIOS/UEFI, Dyldcache, DEX, ART, CGC, Java class, Android boot image, Plan9 executable, ZIMG, MBN/SBL bootloader, ELF coredump, MDMP (Windows minidump), WASM (WebAssembly binary), Commodore VICE emulator, Game Boy (Advance), Nintendo DS ROMs and Nintendo 3DS FIRMs, various filesystems.

Operating Systems

Windows (since XP), GNU/Linux, OS X, [Net|Free|Open]BSD, Android, iOS, OSX, QNX, Solaris, Haiku, FirefoxOS

Bindings

Vala/Genie, Python (2, 3), NodeJS, Lua, Go, Perl, Guile, PHP, Newlisp, Ruby, Java, OCaml, ...

Dependencies

radare2 can be built without any special dependency, just use make and get a working toolchain (gcc, clang, tcc, ..)

Optionally you can use libewf for loading EnCase disk images.

To build the bindings you need latest valabind, g++ and swig2.

Install

The easiest way to install radare2 from git is by running the following command:

$ sys/install.sh

If you want to install radare2 in the home directory without using root privileges and sudo, simply run:

$ sys/user.sh

Building with meson + ninja

If you don't already have meson and ninja, you can install them with your distribution package manager or with r2pm:

$ r2pm -i meson

If you already have them installed, you can run this line to compile radare2:

$ python ./sys/meson.py --prefix=/usr --shared --install

This method is mostly useful on Windows because the initial building with Makefile is not suitable. If you are lost in any way, just type:

$ python ./sys/meson.py --help

Update

To update Radare2 system-wide, you don't need to uninstall or pull. Just re-run:

$ sys/install.sh

If you installed Radare2 in the home directory, just re-run:

$ sys/user.sh

Uninstall

In case of a polluted filesystem, you can uninstall the current version or remove all previous installations:

$ make uninstall
$ make purge

To remove all stuff including libraries, use

$ make system-purge

Package manager

Radare2 has its own package manager - r2pm. Its packages repository is on GitHub too. To start to using it for the first time, you need to initialize packages:

$ r2pm init

Refresh the packages database before installing any package:

$ r2pm update

To install a package, use the following command:

$ r2pm install [package name]

Bindings

All language bindings are under the r2-bindings directory. You will need to install swig and valabind in order to build the bindings for Python, Lua, etc..

APIs are defined in vapi files which are then translated to swig interfaces, nodejs-ffi or other and then compiled.

The easiest way to install the python bindings is to run:

$ r2pm install lang-python2 #lang-python3 for python3 bindings
$ r2pm install r2api-python
$ r2pm install r2pipe-py

In addition there are r2pipe bindings, which is an API interface to interact with the prompt, passing commands and receivent the output as a string, many commands support JSON output, so its integrated easily with many languages in order to deserialize it into native objects.

$ npm install r2pipe   # NodeJS
$ gem install r2pipe   # Ruby
$ pip install r2pipe   # Python
$ opam install radare2 # OCaml

And also for Go, Rust, Swift, D, .NET, Java, NewLisp, Perl, Haskell, Vala, OCaml, and many more to come!

Regression Testsuite

Running make tests will fetch the radare2-regressions repository and run all the tests in order to verify that no changes break any functionality.

We run those tests on every commit, and they are also executed with ASAN and valgrind on different platforms to catch other unwanted 'features'.

Documentation

There is no formal documentation of r2 yet. Not all commands are compatible with radare1, so the best way to learn how to do stuff in r2 is by reading the examples from the web and appending '?' to every command you are interested in.

Commands are small mnemonics of few characters and there is some extra syntax sugar that makes the shell much more pleasant for scripting and interacting with the APIs.

You could also checkout the radare2 book.

Coding Style

Look at CONTRIBUTING.md.

Webserver

radare2 comes with an embedded webserver which serves a pure html/js interface that sends ajax queries to the core and aims to implement an usable UI for phones, tablets and desktops.

$ r2 -c=H /bin/ls

To use the webserver on Windows, you require a cmd instance with administrator rights. To start the webserver, use the following command in the project root.

> radare2.exe -c=H rax2.exe

Pointers

Website: https://www.radare.org/

IRC: irc.freenode.net #radare

Telegram: https://t.me/radare

Matrix: @radare2:matrix.org

Twitter: @radareorg