Go to file
pancake 9116caab2c Cleaning up the environment to workaround issues on some systems 2024-03-26 12:44:07 +01:00
.github Fix CodeQL job by scaning only for C and C 2024-03-21 11:52:41 +01:00
binr Fix #22745 - Fix Android static builds and autodetect NDK on Ubuntu ##build 2024-03-25 19:23:57 +01:00
dist Few more cleanups for rahash2 and add the strhash crypto plugin 2024-03-21 11:16:16 +01:00
doc Fix #22698 - Implement rax2 -j flag for json output ##tools 2024-03-25 17:26:19 +01:00
libr Implement 'wao recj' for 'tbz/tbnz' arm64 instructions ##arch 2024-03-25 19:27:47 +01:00
man Fix #22698 - Implement rax2 -j flag for json output ##tools 2024-03-25 17:26:19 +01:00
mk Fix #22745 - Fix Android static builds and autodetect NDK on Ubuntu ##build 2024-03-25 19:23:57 +01:00
pkgcfg Autodetect libc version and support manual specification ##debug 2024-02-14 14:38:40 +01:00
shlr Upgrade to the latest capstone v5 commit from git 2024-03-20 15:39:24 +01:00
sys Cleaning up the environment to workaround issues on some systems 2024-03-26 12:44:07 +01:00
test Fix #22698 - Implement rax2 -j flag for json output ##tools 2024-03-25 17:26:19 +01:00
.clang-format Some clang-format improvements ##indent 2021-01-25 00:34:58 +01:00
.gitignore Ignore meson/ninja build artifacts 2023-03-30 15:54:30 +02:00
COMMUNITY.md Improve wording of COMMUNITY.md 2022-05-30 19:35:37 +02:00
CONTRIBUTING.md Update merging style in CONTRIBUTING.md (#21467) 2023-03-12 18:40:28 +01:00
COPYING Referenced https:// instead of http:// everywhere as per requirement 2023-03-22 06:58:25 +01:00
COPYING.LESSER Referenced https:// instead of http:// everywhere as per requirement 2023-03-22 06:58:25 +01:00
DEVELOPERS.md Add IDE setting guide in `DEVELOPERS.md` 2023-07-19 11:03:33 +02:00
INSTALL.md Add a line for fixing directory permissions in INSTALL.md 2023-03-21 12:37:08 +01:00
Makefile Unify the visual_find() code with graph and visual ##visual 2023-09-09 10:51:01 +02:00
README.md Update README for clarity regarding sarif plugin (#22728) 2024-03-21 01:54:26 +01:00
SECURITY.md Rewrite user-facing documentation (#19543) 2022-01-01 06:11:46 -06:00
USAGE.md Few more cleanups for rahash2 and add the strhash crypto plugin 2024-03-21 11:16:16 +01:00
autogen.sh The beginning of the abi breaking season (5.9.9 version bump) 2023-06-08 17:03:52 +02:00
config-user.mk.acr Fix regression in capstone 5.0.1 (--with-syscapstone) ##build 2023-10-22 23:42:38 +02:00
configure AIX configure support ##port 2023-12-06 17:30:49 +01:00
configure-plugins Initial implementation of the arch.any.as plugin ##arch 2022-11-30 15:43:54 +01:00
configure.acr AIX configure support ##port 2023-12-06 17:30:49 +01:00
configure.bat Windows builds include debug information by default ##build 2022-06-22 00:56:29 +02:00
configure.hook Create dist/ to hold all the distribution build files ##build (#18131) 2020-12-31 18:57:05 +01:00
env.sh Old shells expect number for test -gt 2024-02-06 18:51:28 +01:00
global.mk Improve output for make -s and fix magic install with symlinks issue (#18781) 2021-05-30 23:46:58 +02:00
make.bat Simplify meson logic and use ole's PR to fix Windows ##build 2022-01-31 23:54:00 +01:00
meson.build AIX configure support ##port 2023-12-06 17:30:49 +01:00
meson_options.txt Add --disable-debugstuff to build without R_LOG_DEBUG, ^C and other stuff ##build 2023-11-21 14:26:32 +01:00
preconfigure Support capstone from r2pm via sys/install.sh 2023-08-01 18:04:20 +02:00
preconfigure.bat preconfigure.bat now accepts 'arm64' as build target 2024-02-17 13:06:15 +01:00
vsfix.bat Update sdb to remove double include paths ##build 2022-11-19 01:05:18 +01:00

README.md

screenshot

Radare2: Libre Reversing Framework for Unix Geeks

Latest packaged version Tests Status build tcc CII Best Practices Build Status Discord

See the Releases page for downloads. The current git master branch is 5.8.9, next will be 5.9.0.

  • Since r2-5.6.0 all the patch releases are abi stable
  • Odd patch versions are used in git builds only, releases use even numbers
  • No need to recompile the plugins, bindings or tools if the major and minor version are the same

Description

r2 is a complete rewrite of radare. It provides a set of libraries, tools and plugins to ease reverse engineering tasks. Distributed mostly under LGPLv3, each plugin can have different licenses (see r2 -L, rasm2 -L, ...).

The radare project started as a simple command-line hexadecimal editor focused on forensics. Today, r2 is a featureful low-level command-line tool with support for scripting with the embedded Javascript interpreter or via r2pipe.

r2 can edit files on local hard drives, view kernel memory, and debug programs locally or via a remote gdb/windbg servers. r2's wide architecture support allows you to analyze, emulate, debug, modify, and disassemble any binary.

screenshot

Installation

The recommended way to install radare2 is via Git using acr/make or meson:

git clone https://github.com/radareorg/radare2
radare2/sys/install.sh

On Windows you may want to use the precompiled builds or the .bat files to compile if you have msvc:

preconfigure.bat       REM setup python, meson, ninja
configure.bat          REM run meson b + vs project
make.bat               REM run ninja -C b
prefix\bin\radare2.exe
  • r2 can be installed from git or via pip using r2env.
  • Run sys/install.sh for the default acr+make+symlink installation
  • meson/ninja (muon/samu also works) and make builds are supported.
  • Windows builds require meson and msvc or mingw as compilers
  • To uninstall the current build of r2 run make uninstall
  • To uninstall ALL the system installations of r2 do: sudo make purge

Using the r2pm tool you can browse and install many plugins and tools that use radare2.

  • esilsolve: The symbolic execution plugin, based on esil and z3
  • iaito: The official Qt graphical interface
  • keystone Assembler instructions using the Keystone library
  • r2ai Run a Language Model in localhost with Llama inside r2!
  • r2dec: A decompiler based on r2 written in JS, accessed with the pdd command
  • r2diaphora: Diaphora's diffing engine working on top of radare2
  • r2frida: The frida io plugin. Start r2 with r2 frida://0 to use it
  • r2ghidra: The native ghidra decompiler plugin, accessed with the pdg command
  • r2papi High level api on top of r2pipe
  • r2pipe Script radare2 from any programming language
  • r2poke Integration with GNU/Poke for extended binary parsing capabilities
  • r2yara Run Yara from r2 or use r2 primitives from Yara
  • radius2: A fast symbolic execution engine based on boolector and esil
  • r2sarif import/export SARIF documents, streamlining vulnerability reporting and visualization in binaries

Usage

These are the first steps to use r2, read the book or find tutorials for more details

$ r2 /bin/ls   # open file in read-only
> aaa          # analyse the program (r2 -A)
> afl          # list all functions (try aflt, aflm)
> px 32        # print 32 byte hexdump current block
> s sym.main   # seek to main (using flag name)
> f~foo        # filter flags matching 'foo' (internal |grep)
> iS;is        # list sections and symbols (rabin2 -Ss)
> pdf; agf     # disassembly and ascii-art function graph
> oo+;w hello  # reopen in read-write and write a string
> ?*~...       # interactive filter in all command help
> q            # quit

Many plugins are included in r2 by default. But you can extend its capabilities by using the r2pm package manager.

r2pm -s <word>  # search packages matching a word
r2pm -Uci <pkg> # update database and clean install a package
r2pm -u <pkg>   # uninstall the given package
r2pm -l <pkg>   # list installed packages

Resources

Documentation

Learn more about r2 watching youtube talks from r2con. There are also many blogposts, slidedecks and the official radare2 book, but it's always a good idea to join any of the official chats and drop your questions/feedback around.

Community

Supported Platforms

Operating Systems

Windows (since XP), Linux, Darwin, GNU/Hurd, Apple's {Mac,i,iPad,watch}OS, Android, [Dragonfly, Net, Free, Open] BSD, Z/OS, QNX, SerenityOS, Solaris, Haiku, Vinix, FirefoxOS.

Architectures

i386, x86-64, Alpha, ARM, AVR, BPF, MIPS, PowerPC, SPARC, RISC-V, SH, m68k, S390, XCore, CR16, HPPA, ARC, Blackfin, Z80, H8/300, V810, PDP11, m680x, V850, CRIS, XAP (CSR), PIC, LM32, 8051, 6502, i4004, i8080, Propeller, EVM, OR1K Tricore, CHIP-8, LH5801, T8200, GameBoy, SNES, SPC700, MSP430, Xtensa, xcore, NIOS II, Java, Dalvik, Pickle, WebAssembly, MSIL, EBC, TMS320 (c54x, c55x, c55+, c64x), Hexagon, Brainfuck, Malbolge, whitespace, DCPU16, LANAI, lm32, MCORE, mcs96, RSP, SuperH-4, VAX, KVX, Am29000, LOONGARCH, JDH8, s390x.

File Formats

ELF, Mach-O, Fatmach-O, PE, PE+, MZ, COFF, XCOFF, OMF, TE, XBE, SEP64, BIOS/UEFI, Dyldcache, DEX, ART, Java class, Android boot image, Plan9 executables, Amiga HUNK, ZIMG, MBN/SBL bootloader, ELF coredump, MDMP (Windows minidump), PDP11, XTAC, CGC, WASM (WebAssembly binary), Commodore VICE emulator, QNX, WAD, OFF, TIC-80, GB/GBA, NDS and N3DS, and mount several filesystems like NTFS, FAT, HFS+, EXT,...

Packaging Status

  • Snap package
  • Termux package
  • Alpine Linux Edge package Alpine Linux 3.13 package Alpine Linux 3.12 package
  • Arch package AUR package
  • EPEL 7 package
  • EPEL 8 package
  • EPEL 9 package
  • Fedora Dev Fedora 36 Fedora 34
  • FreeBSD port OpenBSD port pkgsrc current package
  • Homebrew package MacPorts package
  • Haiku Ports Void Linux
  • Ubuntu 20.04 package Ubuntu 18.04 package
  • Debian Unstable package Raspbian Stable package Kali Linux Rolling package