UNIX-like reverse engineering framework and command-line toolset
Go to file
2021-04-03 11:09:45 +02:00
.github Dont run debugger tests in ASAN mode and fix crash in snap.c 2021-03-15 12:26:09 +01:00
binr Early exit in r2pm -v to avoid double rainbows 2021-03-15 12:37:18 +01:00
dist Add support to the V programming language for scripting ##lang 2021-03-18 17:49:33 +01:00
doc Update doc/license for more clarifications ##build 2021-03-17 12:56:38 +01:00
libr Fix #18534 - infinite recursion (stack exhaustion) in dwarf 2021-04-03 11:09:45 +02:00
man Fix #18412 - Add R2_IGNVER variable to load plugins ignoring the version ##core (#18413) 2021-03-03 18:03:58 +01:00
mk Add missing PARTIALLD in termux.mk 2021-03-02 01:21:53 +01:00
pkgcfg Add network support for WinDbg/KD (KDNET) ##debug (#17340) 2020-08-26 10:24:20 +08:00
shlr Fix last covs I got by mail (#18531) 2021-04-03 03:50:08 +02:00
sys Fix the failure in finding the executing user's ID during install (#18508) ##build 2021-03-29 00:32:44 +02:00
test Update to use keys that can be programmed onto a CPS2 ##crypto 2021-04-02 17:22:52 +02:00
.clang-format Some clang-format improvements ##indent 2021-01-25 00:34:58 +01:00
.gitattributes
.gitignore Add libr/include/sdb to .gitignore (#17549) 2020-08-31 12:44:00 +08:00
.lgtm.yml
.travis.yml Create dist/ to hold all the distribution build files ##build (#18131) 2020-12-31 18:57:05 +01:00
autogen.sh Add plugins=nogrub option for meson ##build 2021-03-11 12:39:47 +01:00
codecov.yml Codecov ignore test dir (#18085) 2020-12-22 12:20:09 +01:00
COMMUNITY.md Add COMMUNITY.md in hope to improve the community experience ##doc 2020-12-20 17:48:03 +01:00
config-user.mk.acr Fix debian32 in CI ##build 2021-02-27 01:01:22 +01:00
configure Apply Termux patch for r_magic.h 2021-03-02 01:15:12 +01:00
configure-plugins Create dist/ to hold all the distribution build files ##build (#18131) 2020-12-31 18:57:05 +01:00
configure.acr Fix debian32 in CI ##build 2021-02-27 01:01:22 +01:00
configure.hook Create dist/ to hold all the distribution build files ##build (#18131) 2020-12-31 18:57:05 +01:00
CONTRIBUTING.md Add commit message rules in the CONTRIBUTING file (#17335) 2020-07-31 12:23:18 +08:00
COPYING
COPYING.LESSER
DEVELOPERS.md DEVELOPERS.md: Reword about r_return_* conditions (#18119) 2020-12-28 19:47:14 +01:00
Doxyfile Exclude dependencies and tests from documentation (#16821) ##doc 2020-05-14 15:08:56 +02:00
env.sh
global.mk Forbid space builds with acr/make and add job to test them with meson/ninja ##build 2020-12-29 15:08:52 +01:00
Makefile Fix the archos regression in the CI (#18327) 2021-02-03 12:07:14 +01:00
meson_options.txt Add the nogpl meson option ##build 2021-03-19 17:41:01 +01:00
meson.build Add plugins=nogrub option for meson ##build 2021-03-11 12:39:47 +01:00
package.json Release 5.1.0 - codename: lasagna 2021-01-25 15:41:12 +01:00
README.md Improve README 2021-03-02 00:49:30 +01:00
travis-extract-var.sh
travis-script Fix asan r2pipe test by updating libasan and using LD_PRELOAD (#17594) 2020-09-11 18:47:27 +08:00

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

             https://www.radare.org

                             --pancake
Build&Test Tests Status Build Status
CodeQuality Build Status Total alerts
Coverage CII Best Practices 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 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...

Scripting

It is possible to script and extend r2 using native plugins written in C. Dynamic programming languages can be also used via the r2pipe interface or using the rlang r2pm packages which make the pythonvm run inside radare2.

Some of the languages supported by r2 are: Python, Ruby, JavaScript, Lua, Perl, PHP, Go, Rust, Swift, C#, Java, Shell, OCaml, Haskell, Scheme (Guile), Common Lisp, Clojure, Erlang, D, Vala/Genie, Prolog, Nim, Newlisp...

Documentation

To learn more about r2 we encourage you to watch youtube talks from r2con. As well as reading blogposts, slides or read the official radare2 book, You can reach us in the following chats:

Operating Systems

Windows (since XP), GNU/Linux, GNU/Darwin, GNU/Hurd, Apple's {Mac,i,iPad,watch}OS, [Dragonfly|Net|Free|Open]BSD, Android, 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, AMD Am29000.

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.

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

Or install in your home with meson + ninja:

$ sys/meson.py --prefix=$HOME/r2meson --local --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'.