augur 0.1.1

Vulnerability research assistant that extracts strings and related pseudo-code from a binary file.
docs.rs failed to build augur-0.1.1
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: augur-0.9.1

augur

build doc

"In fact I've actually triggered buffer overflows by just entering my real name."

-- A.

Augur is a blazing fast IDA Pro headless plugin that extracts strings and related pseudo-code from a binary file. It stores pseudo-code of functions that reference strings in an organized directory tree.

Features

  • Blazing fast, headless user experience courtesy of IDA Pro 9 and Binarly's idalib Rust bindings.
  • Support for binary targets for any architecture implemented by IDA Pro's Hex-Rays decompiler.
  • Decompilation feature based on the decompile_to_file API exported by haruspex.
  • Pseudo-code of each function that references a specific string is stored in a separate directory.

Blog post

See also

Installing

The easiest way to get the latest release is via crates.io:

  1. Download, install, and configure IDA Pro (see https://hex-rays.com/ida-pro).
  2. Download and extract the IDA SDK (see https://docs.hex-rays.com/developer-guide).
  3. Install augur as follows:
    $ export IDASDKDIR=/path/to/idasdk90
    $ export IDADIR=/path/to/ida # if not set, the build script will check common locations
    $ cargo install augur
    

Compiling

Alternatively, you can build from source:

  1. Download, install, and configure IDA Pro (see https://hex-rays.com/ida-pro).
  2. Download and extract the IDA SDK (see https://docs.hex-rays.com/developer-guide).
  3. Compile augur as follows:
    $ git clone https://github.com/0xdea/augur
    $ cd augur
    $ export IDASDKDIR=/path/to/idasdk90 # or edit .cargo/config.toml
    $ export IDADIR=/path/to/ida # if not set, the build script will check common locations
    $ cargo build --release
    

Usage

  1. Make sure IDA Pro is properly configured with a valid license.
  2. Run augur as follows:
    $ augur <binary_file>
    
  3. Find the extracted pseudo-code of each decompiled function in the binary_file.str directory, organized by string:
    $ vim <binary_file>.str
    $ code <binary_file>.str
    

Tested with

  • IDA Pro 9.0.241217 on macOS arm64 and Linux x64.

Note: only the unix target family is currently supported, check idalib documentation if you want to port it yourself to windows (or wasm).

Changelog

TODO