Go to file
Riccardo Schirone 0955b27c9e
Reintroduce --without-r2r configure option (#17294) ##build
This reverts commit 8758fa6b40.
2020-07-17 13:00:14 +02:00
.builds #!pipe: Fix stray command output on Windows and add r2pipe.py test (#17156) 2020-06-30 17:41:39 +08:00
.github Hardcode the version of meson/ninja to use to ensure consistency (#17260) 2020-07-13 14:56:42 +02:00
binr Reintroduce --without-r2r configure option (#17294) ##build 2020-07-17 13:00:14 +02:00
doc Fix issues in the indent-example file (#17280) 2020-07-15 10:08:28 +02:00
libr CPU affinity and backtrace upport or SunOS ##port (#17288) 2020-07-17 08:07:18 +08:00
man Implement rafind2 -F to find the contents of the file ##search (#17143) 2020-06-29 20:11:34 +02:00
mk mk: allow AR override 2020-05-25 12:51:43 +08:00
pkgcfg Move trie, mixed, slist into Sdb's Attic, and DES from util to crypto ##refactor 2018-11-07 17:18:14 +01:00
shlr Update spp to 1.2.0 (#17243) 2020-07-09 17:20:06 +08:00
sys Release pipeline with GitHub Actions (#17192) 2020-07-09 12:07:45 +08:00
test Detect stack vars accesses with misc regs with 'aaef' ##anal (#17255) 2020-07-17 08:01:03 +08:00
.appveyor.yml #!pipe: Fix stray command output on Windows and add r2pipe.py test (#17156) 2020-06-30 17:41:39 +08:00
.clang-format gcc8 warnings (fixes #10338) (#11798) 2018-10-13 01:32:20 +02:00
.gitattributes Compile new shell parser by default (#16660) 2020-04-21 13:44:30 +02:00
.gitignore Fix #4056 - rename DEPS to R2DEPS ##build (#17020) 2020-06-12 10:49:28 +08:00
.lgtm.yml Fix LGTM builds 2019-05-10 16:21:29 +08:00
.travis.yml Fixes some of the issues in Travis (#17267) 2020-07-16 20:47:30 +08:00
AUTHORS.md More spelling fixes in the code 2019-06-20 13:36:02 +08:00
CODEOWNERS Replace radare with trufae (#17045) 2020-06-11 07:40:46 -05:00
CONTRIBUTING.md Add rebasing instructions to CONTRIBUTING.md (#17256) 2020-07-17 14:49:37 +08: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 Use (void) instead of () in function signatures (#17026) ##refactoring 2020-06-14 16:08:32 +02:00
Dockerfile Fix Docker build (#16809) 2020-05-11 18:53:17 +08:00
Dockerfile.travis Install r2pipe in docker image for travis (#17262) 2020-07-13 14:56:14 +02:00
Doxyfile Exclude dependencies and tests from documentation (#16821) ##doc 2020-05-14 15:08:56 +02:00
Makefile Improved make pkgcfg (#16655) 2020-04-20 12:14:28 +02:00
README.md Update README: Added link to the new radare2book (#17228) 2020-07-07 15:04:12 +08:00
Vagrantfile Add Vagrantfile for radare2 + ArchLinux 2017-12-19 00:50:56 +01:00
Vagrantfile.sh Change radare->radareorg links 2019-10-07 10:44:21 +02:00
autogen.sh Improve autogen.sh to use r2pm if available 2018-10-16 00:28:51 +02:00
config-user.mk.acr Reintroduce --without-r2r configure option (#17294) ##build 2020-07-17 13:00:14 +02:00
configure Reintroduce --without-r2r configure option (#17294) ##build 2020-07-17 13:00:14 +02:00
configure-plugins Fix meson build on macOS 2017-05-14 23:15:07 +02:00
configure.acr Reintroduce --without-r2r configure option (#17294) ##build 2020-07-17 13:00:14 +02:00
configure.hook Fix shellcheck problem in scripts 2015-04-29 10:46:22 +02:00
env.sh Add more R2_ prefix for some var 2018-08-07 22:14:54 +02:00
global.mk Avoid hardcoding prefix in global.mk (#11813) 2018-10-15 00:54:03 +02:00
meson.build Fixes some of the issues in Travis (#17267) 2020-07-16 20:47:30 +08:00
meson_options.txt Add support for binr/blob and fix android build ##meson ##build (#17150) 2020-07-05 10:53:37 +08: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 Initial implementation of io.fd plugin ##io (#17158) 2020-07-08 11:28:08 +08:00
plugins.emscripten.cfg Build fixes to make emscripten builds happy (#16406) ##build 2020-04-02 17:52:03 +02: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 SPEC file updated to version 0.10.0 2015-10-25 12:08:06 +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 Build fixes to make emscripten builds happy (#16406) ##build 2020-04-02 17:52:03 +02:00

README.md

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

             https://www.radare.org

                             --pancake
Service Badge
GithubCI Tests Status
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, 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.

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), Common Lisp, 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