C Objective-C C++ JavaScript Makefile Shell Other
Latest commit 1f44f7a Jul 23, 2018
Permalink
Failed to load latest commit information.
.github Update ISSUE_TEMPLATE.md Feb 18, 2018
binr Revert "End rabin2 json output with newline" Jul 22, 2018
doc Add svg with more logos Jun 27, 2018
libr Revert "Fix ARM_INS_CMP ESIL to correctly set carry bit" Jul 23, 2018
man Fixed typo in rabin2 manpage Jul 20, 2018
mk clang build fix, propagate initial CC setting (#10316) Jun 11, 2018
pkgcfg Using safe memory clearance for sensitive data. (#10337) Jun 13, 2018
prefix Better webui, 'pi' counts opcodes and remove /new and htmlgraph Jan 25, 2013
shlr Update sdb from git Jul 19, 2018
sys Fix #10767 Jul 18, 2018
t Better t/Makefile Mar 20, 2017
.appveyor.yml Meson: Some little fixes (#9783) Mar 30, 2018
.gitignore Initial doxygen config Jun 15, 2018
.travis.yml meson fixes (#10743) Jul 17, 2018
AUTHORS.md WIP - Totally remove host endianness dependence May 4, 2016
CONTRIBUTING.md Move developer info in CONTRIBUTING.md to DEVELOPERS.md Jun 15, 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 Fix indention in switch-case statement (#10454) Jun 23, 2018
Dockerfile Fixing dependency (#9501) Feb 24, 2018
Dockerfile.travis meson fixes (#10743) Jul 17, 2018
Doxyfile Initial doxygen config Jun 15, 2018
Makefile Add rm r_version.h to make clean Jun 16, 2018
README.md Update list of supported architectures Jun 23, 2018
Vagrantfile Add Vagrantfile for radare2 + ArchLinux Dec 18, 2017
Vagrantfile.sh Add Vagrantfile for radare2 + ArchLinux Dec 18, 2017
autogen.sh Fix shellcheck problem in scripts Apr 29, 2015
config-user.mk.acr Add --with-libr and deprecate --with-{nonpic,pic,merged} (#10212) May 28, 2018
configure After release version bump Jul 9, 2018
configure-plugins Fix meson build on macOS May 14, 2017
configure.acr After release version bump Jul 9, 2018
configure.hook Fix shellcheck problem in scripts Apr 29, 2015
env.sh Blind fix for #9576 Mar 5, 2018
global.mk Fix @WWWROOT@ issue Oct 31, 2015
meson.build meson.build: do not add "r_magic" as Require in pkgconfig if using sys Jul 18, 2018
meson_options.txt meson fixes (#10743) Jul 17, 2018
package.json Appveyor windows-installer integration Jun 5, 2017
plugins.bin.cfg Move the asm and anal plugins for x86.udis to extras Mar 14, 2018
plugins.def.cfg io: Add gprobe plugin (#9735) Mar 21, 2018
plugins.emscripten.cfg Move the asm and anal plugins for x86.udis to extras Mar 14, 2018
plugins.ios-store.cfg Unbreak build of xtr_fatmach0 plugin. Jan 11, 2018
plugins.ios.cfg Unbreak build of xtr_fatmach0 plugin. Jan 11, 2018
plugins.nogpl.cfg Move the asm and anal plugins for x86.udis to extras Mar 14, 2018
plugins.static.cfg Remove a bunch of conflicting plugins for the static build Feb 19, 2018
plugins.tiny.cfg Remove x86.tab from r2 master (moved to extras) Jul 25, 2016
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 meson improvements (#10617) Jul 9, 2018
travis-script meson fixes (#10743) Jul 17, 2018

README.md

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

                https://www.radare.org

                                  --pancake
Jenkins Build Status
TravisCI Build Status
AppVeyor Build Status
Coverity Build Status
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

Package manager

Radare2 has its own package manager - r2pm. It's packages repository is on GitHub too. To start to use 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 are an API interface to interact with the prompt, passing commands and receivent the output as a string, many commands support JSON output, so it's 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 it will fetch the radare2-regressions repository and run all the tests in order to verify that no changes break a 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 that 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 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