UNIX-like reverse engineering framework and command-line toolset
Go to file
2020-03-12 11:59:20 +01:00
.builds Try V suite on FreeBSD and OpenBSD (#15852) 2020-02-10 18:00:20 +08:00
.github Add .github/workflows auto-labeler infrastructure (#16154) 2020-03-09 12:00:22 +08:00
binr 'sign' as an alias for ios-sign and macos-sign ##build 2020-02-26 02:07:13 +01:00
doc Fix spelling errors (#15904) 2020-01-27 07:43:47 +01:00
libr Fix RRegisterType sign for drm command 2020-03-12 11:59:20 +01:00
man Implement radiff2 -X for hexII diffing ##diff 2019-10-24 18:23:03 +02:00
mk Fix macOS build with latest XCode ##build (#15202) 2019-10-08 10:55:31 +02:00
pkgcfg
shlr Fix #16138 - Do not preincrement when it's not necessary (#16151) 2020-03-05 19:06:59 +01:00
sys Skip continuous tag in release-notes.sh 2020-03-04 01:26:51 +01:00
test Introduce escaping in grep specifiers (#16185) 2020-03-12 18:28:45 +08:00
.appveyor.yml Do not use Draft builds in AppVeyor 2020-03-05 13:43:45 +08:00
.clang-format
.gitignore Very simple tree sitter integration (#15414) ##command 2019-11-06 10:33:23 +01:00
.lgtm.yml Fix LGTM builds 2019-05-10 16:21:29 +08:00
.travis.yml Fix Travis YAML warnings (#16089) 2020-03-02 17:25:37 +08:00
AUTHORS.md More spelling fixes in the code 2019-06-20 13:36:02 +08:00
autogen.sh
config-user.mk.acr Upgrade to acr-1.8.1 to get semver support ##core (#15816) 2020-01-17 12:18:05 +01:00
configure After release version bump 2020-03-09 09:45:08 +01:00
configure-plugins
configure.acr After release version bump 2020-03-09 09:45:08 +01:00
configure.hook
CONTRIBUTING.md Imports Tests from radare2-regressions (#15546) 2019-12-08 15:31:14 +01:00
COPYING
COPYING.LESSER
DEVELOPERS.md Don't contribute with patches 2019-11-14 18:53:10 +01:00
Dockerfile Change radare->radareorg links 2019-10-07 10:48:31 +02:00
Dockerfile.travis Prerelease travis release (#13189) 2019-02-28 16:58:09 +01:00
Doxyfile
env.sh
global.mk
Makefile Upgrade to acr-1.8.1 to get semver support ##core (#15816) 2020-01-17 12:18:05 +01:00
meson_options.txt Add Unit Tests to Meson (#15926) ##test 2020-02-05 09:55:30 +01:00
meson.build Add Unit Tests to Meson (#15926) ##test 2020-02-05 09:55:30 +01:00
package.json Change radare->radareorg links 2019-10-07 10:48:31 +02:00
plugins.android.cfg Add 64-bit iOS SEP xtr plugin ##bin 2019-12-13 15:49:35 +01:00
plugins.bin.cfg Initial implementation of LX/LE file plugin ##bin 2019-12-28 18:46:14 +01:00
plugins.def.cfg Add Windows Crash Dump format support (#16087) ##bin 2020-03-02 19:20:27 +01:00
plugins.emscripten.cfg Add 64-bit iOS SEP xtr plugin ##bin 2019-12-13 15:49:35 +01:00
plugins.ios-store.cfg Add 64-bit iOS SEP xtr plugin ##bin 2019-12-13 15:49:35 +01:00
plugins.ios.cfg Add 64-bit iOS SEP xtr plugin ##bin 2019-12-13 15:49:35 +01:00
plugins.nogpl.cfg Add 64-bit iOS SEP xtr plugin ##bin 2019-12-13 15:49:35 +01:00
plugins.static.cfg Add 64-bit iOS SEP xtr plugin ##bin 2019-12-13 15:49:35 +01:00
plugins.static.nogpl.cfg Add 64-bit iOS SEP xtr plugin ##bin 2019-12-13 15:49:35 +01:00
plugins.tiny.cfg Add 64-bit iOS SEP xtr plugin ##bin 2019-12-13 15:49:35 +01:00
radare2.spec
README.md Imports Tests from radare2-regressions (#15546) 2019-12-08 15:31:14 +01:00
snapcraft.yaml Change radare->radareorg links 2019-10-07 10:48:31 +02:00
travis-extract-var.sh Build debian package in CI ##build (#15997) 2020-02-20 00:37:30 +01:00
travis-script Try to fix the macOS build (#16013) 2020-02-21 08:20:43 +01:00
Vagrantfile
Vagrantfile.sh Change radare->radareorg links 2019-10-07 10:44:21 +02:00

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

             https://www.radare.org

                             --pancake
Service Badge
TravisCI Build Status
AppVeyor Build status
FreeBSD (sr.ht) builds.sr.ht status
OpenBSD (sr.ht) builds.sr.ht status
Coverity Build Status
LGTM Total alerts
Infrastructure CII Best Practices
Codecov codecov
Fuzzit fuzzit
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 command-line hexadecimal editor able to open disk files, but later added support for analyzing binaries, disassembling code, debugging programs, attaching to remote gdb servers...

radare2 is portable.

To learn more on radare2 you may want to read the official radare2 book.

You can also use r2lrn or r2golf for a hands-on learning experience.

Operating Systems

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

Architectures

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

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, QNX, Game Boy (Advance), Nintendo DS ROMs and Nintendo 3DS FIRMs, various filesystems.

Scripting

Native bindings are supported but the recommended way to interact with r2 from other languages is by using r2pipe

Python, Ruby, JavaScript, Lua, Perl, PHP, Go, Rust, Swift, C#, Java, Shell, OCaml, Haskell, Scheme (Guile), CommonLisp, Clojure, Erlang, D, Vala/Genie, Prolog, Nim, Newlisp...

Install / Update

The recommended way to install or update radare2 from git for single-user systems:

$ sys/install.sh

If you don't have root, or just want to install it in your home use:

$ sys/user.sh

Note that those scripts will install using configure+make using symlinks, so you don't need to reinstall every time you change something in the builddir.

  • If you don't like symlinks use sys/install.sh --install
  • To use capstone5 use the --with-capstone5 flag.

Alternatively you can also build with meson + ninja:

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

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]

Development

Coding Style

Look at CONTRIBUTING.md.

Tests

Running make tests will fetch the test binaries 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'.

Community

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

Telegram: https://t.me/radare

Twitter: @radareorg

IRC: irc.freenode.net #radare

Matrix: @radare2:matrix.org