2023-04-01 00:25:22 +02:00
< a href = "https://radare.org/" > < img border = 0 src = "doc/images/r2emoji.png" alt = "screenshot" align = "left" width = "128px" > < / a >
2012-10-23 01:03:26 +02:00
2022-09-13 08:30:52 +02:00
## Radare2: Libre Reversing Framework for Unix Geeks
2012-10-23 01:03:26 +02:00
2022-07-05 13:38:22 +02:00
[](https://repology.org/project/radare2/versions) [](https://github.com/radareorg/radare2/actions/workflows/ci.yml?query=branch%3Amaster) [](https://github.com/radareorg/radare2/actions/workflows/build.yml?query=branch%3Amaster) [](https://github.com/radareorg/radare2/actions/workflows/tcc.yml)
2023-02-20 22:14:56 +01:00
[](https://bestpractices.coreinfrastructure.org/projects/741) [](https://scan.coverity.com/projects/416) [](https://discord.gg/YBey7CR9jf)
2022-05-03 15:51:39 +02:00
2022-01-06 11:05:42 -06:00
See the [Releases ](https://github.com/radareorg/radare2/releases ) page for
2024-04-01 14:07:14 +02:00
downloads. The current git `master` branch is `5.9.1` , next will be `5.9.2` .
2021-05-25 00:05:25 +02:00
2022-08-18 20:51:06 +02:00
* Since r2-5.6.0 all the patch releases are [abi stable ](doc/abi.md )
* 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
2022-03-15 19:41:11 +01:00
2022-05-18 00:25:00 +02:00
### Description
2022-01-01 06:11:46 -06:00
r2 is a complete rewrite of radare. It provides a set of libraries, tools and
2022-05-18 00:25:00 +02:00
plugins to ease reverse engineering tasks. Distributed mostly under LGPLv3,
each plugin can have different licenses (see r2 -L, rasm2 -L, ...).
2021-03-02 00:49:30 +01:00
2022-01-01 06:11:46 -06:00
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
2023-09-26 13:56:12 +02:00
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
2024-03-16 11:41:55 +01:00
locally or via a remote gdb/windbg servers. r2's wide architecture support allows
you to analyze, emulate, debug, modify, and disassemble any binary.
2018-06-24 01:38:05 +08:00
2021-05-24 23:25:11 +02:00
< p align = "center" >
< a href = "https://www.radare.org/" > < img src = "doc/images/shot.png" alt = "screenshot" align = "center" border = 0 width = "600px" > < / a >
< / p >
2019-09-08 20:19:03 +03:00
2022-01-01 06:11:46 -06:00
## Installation
2021-03-02 00:49:30 +01:00
2023-09-26 13:56:12 +02:00
The recommended way to install radare2 is via Git using acr/make or meson:
2022-01-01 06:11:46 -06:00
```sh
2021-05-24 23:25:11 +02:00
git clone https://github.com/radareorg/radare2
radare2/sys/install.sh
```
2020-12-17 11:37:42 +01:00
2023-09-26 13:56:12 +02:00
On Windows you may want to use the precompiled builds or the .bat files to compile if you have msvc:
2022-05-23 00:22:02 +02:00
2023-09-26 13:56:12 +02:00
```bat
2022-05-23 00:22:02 +02:00
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
```
2023-09-26 13:56:12 +02:00
* 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`
2022-05-23 00:22:02 +02:00
2023-09-26 13:56:12 +02:00
## Popular Plugins:
Using the `r2pm` tool you can browse and install many plugins and tools that use radare2.
* [esilsolve ](https://github.com/radareorg/esilsolve ): The symbolic execution plugin, based on esil and z3
* [iaito ](https://github.com/radareorg/iaito ): The official Qt graphical interface
* [keystone ](https://github.com/radareorg/radare2-extras/tree/master/keystone ) Assembler instructions using the Keystone library
2024-03-16 11:41:55 +01:00
* [r2ai ](https://github.com/radareorg/r2ai ) Run a Language Model in localhost with Llama inside r2!
2023-09-26 13:56:12 +02:00
* [r2dec ](https://github.com/wargio/r2dec-js ): A decompiler based on r2 written in JS, accessed with the `pdd` command
* [r2diaphora ](https://github.com/FernandoDoming/r2diaphora ): [Diaphora ](https://github.com/joxeankoret/diaphora )'s diffing engine working on top of radare2
* [r2frida ](https://github.com/nowsecure/r2frida ): The frida io plugin. Start r2 with `r2 frida://0` to use it
* [r2ghidra ](https://github.com/radareorg/r2ghidra ): The native ghidra decompiler plugin, accessed with the `pdg` command
* [r2papi ](https://github.com/radareorg/radare2-r2papi ) High level api on top of r2pipe
* [r2pipe ](https://github.com/radareorg/radare2-r2pipe ) Script radare2 from any programming language
* [r2poke ](https://github.com/radareorg/radare2-extras/tree/master/r2poke ) Integration with GNU/Poke for extended binary parsing capabilities
2023-10-08 21:07:04 +00:00
* [r2yara ](https://github.com/radareorg/r2yara ) Run Yara from r2 or use r2 primitives from Yara
2023-09-26 13:56:12 +02:00
* [radius2 ](https://github.com/nowsecure/radius2 ): A fast symbolic execution engine based on boolector and esil
2024-03-20 20:54:26 -04:00
* [r2sarif ](https://github.com/radareorg/radare2-extras/tree/master/sarif ) import/export SARIF documents, streamlining vulnerability reporting and visualization in binaries
2021-05-25 00:05:25 +02:00
2022-01-12 15:46:49 +01:00
## Usage
These are the first steps to use r2, read the book or find tutorials for more details
```sh
2023-02-17 01:34:34 +01:00
$ r2 /bin/ls # open file in read-only
> aaa # analyse the program (r2 -A)
2022-01-12 15:46:49 +01:00
> afl # list all functions (try aflt, aflm)
> px 32 # print 32 byte hexdump current block
2023-02-17 01:34:34 +01:00
> 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
2022-01-12 15:46:49 +01:00
> q # quit
```
2023-09-26 13:56:12 +02:00
Many plugins are included in r2 by default. But you can extend its capabilities
by using the [r2pm ](https://github.com/radareorg/radare2-pm ) package manager.
```sh
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
```
2022-01-01 06:11:46 -06:00
## Resources
2021-05-25 00:05:25 +02:00
2023-05-22 11:50:49 +02:00
* [Official Book ](https://book.rada.re ): Read about r2 usage
2022-08-18 20:51:06 +02:00
* [COMMUNITY.md ](COMMUNITY.md ): Community engagement and loose guidelines
2022-01-01 06:11:46 -06:00
* [CONTRIBUTING.md ](CONTRIBUTING.md ): Information about reporting issues and
2023-03-15 15:06:31 +01:00
contributing. See also [Contributing ](#contributing )
2022-08-18 20:51:06 +02:00
* [DEVELOPERS.md ](DEVELOPERS.md ): Development guidelines for r2
* [SECURITY.md ](SECURITY.md ): Instructions for reporting vulnerabilities
* [USAGE.md ](USAGE.md ): Some example commands
* [INSTALL.md ](INSTALL.md ): Installation instructions using make or meson
2022-01-01 06:11:46 -06:00
## Documentation
2024-04-27 06:42:47 +02:00
Learn more about r2 watching [youtube talks ](https://www.youtube.com/c/r2con ) from [r2con ](https://rada.re/con ). There are also many blogposts, slidedecks and the [official radare2 book ](https://book.rada.re ), but it's always a good idea to join any of the official chats and drop your questions or feedback there.
2022-01-01 06:11:46 -06:00
## Community
* [irc.libera.chat ](https://libera.chat ): `#radare` , `#radare_side`
* [Matrix ](https://matrix.to/#/#radare:matrix.org ): `#radare:matrix.org`
2024-03-16 11:31:04 +01:00
* Telegram: [Main ](https://t.me/radare ) and [Side ](https://t.me/radare_side ) channels
2024-04-27 06:42:47 +02:00
* Discord: [Server ](https://discord.gg/YBey7CR9jf )
2023-02-17 01:34:34 +01:00
* Mastodon: [@radareorg ](https://infosec.exchange/@radareorg )
2022-01-01 06:11:46 -06:00
* Website: [https://www.radare.org/ ](https://www.radare.org/ )
# Supported Platforms
2019-05-16 13:44:00 +02:00
2021-05-25 00:05:25 +02:00
## Operating Systems
2021-05-24 23:25:11 +02:00
2022-07-25 16:16:20 +03:00
Windows (since XP), Linux, Darwin, GNU/Hurd, Apple's {Mac,i,iPad,watch}OS, Android,
2024-04-27 06:42:47 +02:00
[Dragonfly, Net, Free, Open] BSD, Z/OS, QNX, SerenityOS, Solaris, AIX, Haiku, Vinix, FirefoxOS.
2019-05-16 13:44:00 +02:00
2018-06-24 01:38:05 +08:00
## Architectures
2023-05-22 11:50:49 +02:00
i386, x86-64, Alpha, ARM, AVR, BPF, MIPS, PowerPC, SPARC, RISC-V, SH, m68k,
2023-08-10 07:12:32 +03:00
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
2023-05-22 11:50:49 +02:00
Tricore, CHIP-8, LH5801, T8200, GameBoy, SNES, SPC700, MSP430, Xtensa, xcore,
2023-02-17 01:34:34 +01:00
NIOS II, Java, Dalvik, Pickle, WebAssembly, MSIL, EBC, TMS320 (c54x, c55x,
2023-05-22 11:50:49 +02:00
c55+, c64x), Hexagon, Brainfuck, Malbolge, whitespace, DCPU16, LANAI, lm32,
MCORE, mcs96, RSP, SuperH-4, VAX, KVX, Am29000, LOONGARCH, JDH8, s390x.
2018-06-24 01:38:05 +08:00
## File Formats
2023-05-22 11:50:49 +02:00
ELF, Mach-O, Fatmach-O, PE, PE+, MZ, COFF, XCOFF, OMF, TE, XBE, SEP64, BIOS/UEFI,
2023-11-15 18:46:17 +01:00
Dyldcache, DEX, ART, Java class, Android boot image, Plan9 executables, Amiga HUNK,
ZIMG, MBN/SBL bootloader, ELF coredump, MDMP (Windows minidump), PDP11, XTAC, CGC,
2023-05-22 11:50:49 +02:00
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,...
2018-06-24 01:38:05 +08:00
2021-05-25 00:05:25 +02:00
## Packaging Status
2023-03-14 20:17:05 +01:00
* [](https://snapcraft.io/radare2)
2021-05-25 00:05:25 +02:00
* [](https://repology.org/project/radare2/versions)
* [](https://repology.org/project/radare2/versions) [](https://repology.org/project/radare2/versions) [](https://repology.org/project/radare2/versions)
* [](https://repology.org/project/radare2/versions) [](https://repology.org/project/radare2/versions)
2023-01-18 16:00:15 +01:00
* [](https://repology.org/project/radare2/versions)
* [](https://repology.org/project/radare2/versions)
* [](https://repology.org/project/radare2/versions)
2022-05-27 10:42:45 +02:00
* [](https://repology.org/project/radare2/versions) [](https://repology.org/project/radare2/versions) [](https://repology.org/project/radare2/versions)
2021-05-25 00:05:25 +02:00
* [](https://repology.org/project/radare2/versions) [](https://repology.org/project/radare2/versions) [](https://repology.org/project/radare2/versions)
* [](https://repology.org/project/radare2/versions) [](https://repology.org/project/radare2/versions)
2022-05-27 10:02:11 +02:00
* [](https://repology.org/project/radare2/versions) [](https://repology.org/project/radare2/versions)
2023-01-17 11:32:42 +01:00
* [](https://repology.org/project/radare2/versions) [](https://repology.org/project/radare2/versions)
2021-05-25 00:05:25 +02:00
* [](https://repology.org/project/radare2/versions) [](https://repology.org/project/radare2/versions) [](https://repology.org/project/radare2/versions)
