ROPgadget 工具技术文档

1. 安装指南

1.1 通过 PyPi 安装

最简单的安装方式是通过 PyPi 安装 ROPgadget：

$ sudo apt install python3-pip
$ sudo -H python3 -m pip install ROPgadget
$ ROPgadget --help

1.2 从源码安装

如果你选择从源码安装 ROPgadget，首先需要安装 Capstone 库：

$ sudo apt install python3-pip
$ sudo -H python3 -m pip install capstone

Capstone 支持多平台（Windows、iOS、Android、Cygwin 等）。对于跨平台编译，请参考 Capstone 的编译文档。

安装完 Capstone 后，你可以选择以下两种方式使用 ROPgadget：

1. 作为独立工具使用：

   $ python3 ROPgadget.py --help
   

2. 安装到 Python 的 site-packages 库中，并从 $PATH 中执行：

   $ sudo -H python3 setup.py install
   $ ROPgadget --help
   

2. 项目使用说明

ROPgadget 是一个用于在二进制文件中搜索 gadgets 的工具，主要用于 ROP（Return-Oriented Programming）漏洞利用。它支持多种文件格式和架构。

2.1 基本用法

usage: ROPgadget.py [-h] [-v] [-c] [--binary <binary>] [--opcode <opcodes>]
                    [--string <string>] [--memstr <string>] [--depth <nbyte>]
                    [--only <key>] [--filter <key>] [--range <start-end>]
                    [--badbytes <byte>] [--rawArch <arch>] [--rawMode <mode>]
                    [--rawEndian <endian>] [--re <re>] [--offset <hexaddr>]
                    [--ropchain] [--thumb] [--console] [--norop] [--nojop]
                    [--callPreceded] [--nosys] [--multibr] [--all] [--noinstr]
                    [--dump] [--silent] [--align ALIGN] [--mipsrop <rtype>]

2.2 参数说明

• -h, --help：显示帮助信息并退出。
• -v, --version：显示 ROPgadget 的版本。
• -c, --checkUpdate：检查是否有新版本可用。
• --binary <binary>：指定要分析的二进制文件。
• --opcode <opcodes>：在可执行段中搜索指定的操作码。
• --string <string>：在可读段中搜索指定的字符串。
• --memstr <string>：在所有可读段中搜索每个字节。
• --depth <nbyte>：设置搜索深度（默认 10）。
• --only <key>：仅显示特定的指令。
• --filter <key>：过滤掉特定的指令。
• --range <start-end>：在两个地址之间搜索（格式为 0x...-0x...）。
• --badbytes <byte>：拒绝包含特定字节的 gadgets。
• --rawArch <arch>：为 raw 文件指定架构（如 x86、arm、arm64 等）。
• --rawMode <mode>：为 raw 文件指定模式（如 32、64、arm、thumb 等）。
• --rawEndian <endian>：为 raw 文件指定字节序（little 或 big）。
• --re <re>：使用正则表达式进行搜索。
• --offset <hexaddr>：为 gadgets 地址指定偏移量。
• --ropchain：启用 ROP 链生成。
• --thumb：使用 thumb 模式进行搜索（仅 ARM 架构）。
• --console：使用交互式控制台进行搜索。
• --norop：禁用 ROP 搜索引擎。
• --nojop：禁用 JOP 搜索引擎。
• --callPreceded：仅显示被 call 指令预先调用的 gadgets。
• --nosys：禁用 SYS 搜索引擎。
• --multibr：启用多分支 gadgets。
• --all：禁用去重功能。
• --noinstr：禁用 gadgets 指令的打印。
• --dump：输出 gadgets 的字节。
• --silent：禁用分析过程中的 gadgets 打印。
• --align ALIGN：对齐 gadgets 地址（以字节为单位）。
• --mipsrop <rtype>：MIPS 有用 gadgets 查找器（如 stackfinder、system、tails 等）。

2.3 示例

ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --ropchain
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --depth 3
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --string "main"
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --string "m..n"
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --opcode c9c3
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --only "mov|ret"
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --only "mov|pop|xor|ret"
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --filter "xchg|add|sub|cmov.*"
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --norop --nosys
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --range 0x08041000-0x08042000
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --string main --range 0x080c9aaa-0x080c9aba
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --memstr "/bin/sh"
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --console
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-x86 --badbytes "00|01-1f|7f|42"
ROPgadget.py --binary ./test-suite-binaries/Linux_lib64.so --offset 0xdeadbeef00000000
ROPgadget.py --binary ./test-suite-binaries/elf-ARMv7-ls --depth 5
ROPgadget.py --binary ./test-suite-binaries/elf-ARM64-bash --depth 5
ROPgadget.py --binary ./test-suite-binaries/raw-x86.raw --rawArch=x86 --rawMode=32
ROPgadget.py --binary ./test-suite-binaries/elf-Linux-RISCV_64 --depth 8

3. 项目 API 使用文档

ROPgadget 主要通过命令行接口进行操作，没有提供直接的编程 API。用户可以通过命令行参数来控制工具的行为，如搜索 gadgets、生成 ROP 链等。

4. 项目安装方式

4.1 通过 PyPi 安装

$ sudo apt install python3-pip
$ sudo -H python3 -m pip install ROPgadget

4.2 从源码安装

$ sudo apt install python3-pip
$ sudo -H python3 -m pip install capstone
$ sudo -H python3 setup.py install

通过以上步骤，你可以成功安装并使用 ROPgadget 工具。