UNIX-like reverse engineering framework and command-line toolset
Go to file
2015-11-23 21:04:18 +01:00
binr Fix #2782 - rahash2 - slurps from stdin 2015-11-22 23:59:48 +01:00
build Remove unused r_alloca_* 2014-08-18 02:36:08 +02:00
doc Implement {R2|RASM2|RABIN2}_NOPLUGIN env var support 2015-11-05 00:38:42 +01:00
libr Config variables for jmp/cjmp references 2015-11-23 21:04:18 +01:00
man Make rabin2 -A help more readable 2015-11-05 13:37:21 +01:00
media Fix #3580 - aarj output was invalid 2015-10-27 12:11:21 +01:00
mk Unify -fPIC handling, improve windows building 2015-10-09 18:58:03 +03:00
pkgcfg Release 0.9.9 - codename AlmostThere 2015-06-05 04:07:13 +02:00
prefix Better webui, 'pi' counts opcodes and remove /new and htmlgraph 2013-01-25 03:22:09 +01:00
shlr Fix many important issues reported by clang-analyzer 2015-11-22 11:27:45 +01:00
sys Simplify scan-build script 2015-11-18 10:33:59 +01:00
.gitignore Add sdb_version.h in gitignore 2015-11-16 21:16:59 +01:00
.travis.yml Use NOREPORT in travis r2r 2015-11-17 01:50:53 +01:00
AUTHORS.md modified Authors 2015-10-20 00:39:31 +02:00
autogen.sh Fix shellcheck problem in scripts 2015-04-29 10:46:22 +02:00
config-user.mk.acr build cleanup focused on possibility to control the lib directories with the build parameters 2015-10-27 03:26:45 +01:00
configure Some random code cleanup and fixes 2015-11-23 02:36:26 +01:00
configure-plugins Implement more utf8 terminal check, handle jbe in asm.pseudo 2015-04-20 15:27:05 +02:00
configure.acr Some random code cleanup and fixes 2015-11-23 02:36:26 +01:00
configure.hook Fix shellcheck problem in scripts 2015-04-29 10:46:22 +02:00
CONTRIBUTING.md CONTRIBUTING.md: first version 2015-09-22 22:17:02 +02:00
COPYING Honor FSF filename license rules (LICENSE->COPYING) 2013-03-30 00:54:05 +01:00
COPYING.LESSER Honor FSF filename license rules (LICENSE->COPYING) 2013-03-30 00:54:05 +01:00
DEVELOPERS.md Adds markdown styling, fixes broken link 2015-11-13 00:20:09 +01:00
Dockerfile Dockerfile to the roots 2015-10-12 20:51:07 +02:00
env.sh try jot when seq not available 2015-11-05 16:11:57 +01:00
global.mk Fix @WWWROOT@ issue 2015-10-31 11:48:23 +01:00
Jamroot Somewhat better BoostJam support 2014-10-26 02:47:08 +02:00
Makefile Fix GIT_TAP after appveyour disgrace 2015-11-08 11:52:45 +01:00
plugins.def.cfg Initial PSX Executable Support 2015-11-23 20:56:19 +01:00
plugins.emscripten.cfg Move msil and mdmp into radare2-extras, add r2pm pkgs 2015-11-11 11:07:32 +01:00
plugins.nogpl.cfg Move msil and mdmp into radare2-extras, add r2pm pkgs 2015-11-11 11:07:32 +01:00
plugins.tiny.cfg Fix windist, r2pipe and plugins paths 2015-10-23 02:58:48 +02:00
radare2.spec SPEC file updated to version 0.10.0 2015-10-25 12:08:06 +01:00
README.md Initial RISC-V 32/64 analysis 2015-10-31 11:49:52 +01:00
TODO.md Remove unused variables 2015-11-05 00:47:27 +01:00

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

                www.radare.org

                                  --pancake
Jenkins Build Status
TravisCI Build Status
AppVeyor Build Status
Coverity Build 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, an 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: * 6502, 8051, CRIS, H8/300, LH5801, T8200, arc, arm, avr, bf, blackfin, csr, dalvik, dcpu16, gameboy, i386, i4004, i8080, m68k, malbolge, mips, mips, msil, msp430, nios II, powerpc, rar, sh, snes, sparc, tms320 (c54x c55x c55+), V810, x86-64, zimg, risc-v.

  • File Formats: * bios, CGC, dex, elf, elf64, filesystem, java, fatmach0, mach0, mach0-64, MZ, PE, PE+, TE, COFF, plan9, dyldcache, Gameboy and Nintendo DS ROMs

  • Operating Systems: * Android, GNU/Linux, [Net|Free|Open]BSD, iOS, OSX, QNX, w32, w64, Solaris, Haiku, FirefoxOS

  • Bindings: * Vala/Genie, Python (2, 3), NodeJS, LUA, Go, Perl, Guile, php5, 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

Uninstall

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

$ make uninstall
$ make purge

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:

$ sys/python.sh

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

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: http://www.radare.org/

IRC: irc.freenode.net #radare

Twitter: @radareorg