https://github.com/netromdk/dispar

Dispar - Cross-platform Disassemling binary Parser
https://github.com/netromdk/dispar

binary-analysis cmake cpp17 cross-platform disassembler mach-o parser qt5 reverse-engineering

Last synced: 12 days ago
JSON representation

Dispar - Cross-platform Disassemling binary Parser

• Host: GitHub
• URL: https://github.com/netromdk/dispar
• Owner: netromdk
• License: mit
• Created: 2016-09-15T15:54:13.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-11-21T12:08:03.000Z (about 3 years ago)
• Last Synced: 2024-12-19T20:20:00.749Z (22 days ago)
• Topics: binary-analysis, cmake, cpp17, cross-platform, disassembler, mach-o, parser, qt5, reverse-engineering
• Language: C++
• Homepage:
• Size: 3.73 MB
• Stars: 20
• Watchers: 6
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Test](https://github.com/netromdk/dispar/actions/workflows/test.yml/badge.svg)](https://github.com/netromdk/dispar/actions/)

[![Clang Sanitizers](https://github.com/netromdk/dispar/actions/workflows/test-sanitizers.yml/badge.svg)](https://github.com/netromdk/dispar/actions/)

[![CodeQL](https://github.com/netromdk/dispar/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/netromdk/dispar/security/code-scanning/)

# dispar

Dispar is short for "[Dis]assemling binary [Par]ser" written in C++17. The whole concept of the project is to load binaries, like executables, libraries, core dumps etc., and do analysis of their structure and data; most notably their strings, symbols, and functions. Currently, it supports only 32+64 bit [Mach-O](https://en.wikipedia.org/wiki/Mach-O) binaries (including [universal binaries](https://en.wikipedia.org/wiki/Universal_binary)) but there are plans for supporting [ELF](https://en.wikipedia.org/wiki/Executable_and_Linkable_Format) and [PE/PE+](https://en.wikipedia.org/wiki/Portable_Executable) later on.

# Table of Contents

* [Screenshots](#screenshots)

* [Dependencies](#dependencies)

  * [External](#external)

  * [Internal](#internal)

* [Building The Program](#building-the-program)

* [Testing](#testing)

* [Contributing](#contributing)

* [Advanced Topics](#advanced-topics)

# Screenshots

![General usage](screenshots/general.png)

![Disassembly editor](screenshots/disasm-editor.png)

![Hex usage](screenshots/hex-editor.png)

# Dependencies

There are both external and internal libraries and tools required to build and run this program.

## External

* CMake 3.12+

* Qt 5.15+

  * QtCore

  * QtGui

  * QtWidgets

  * QtPrintSupport (macOS only)

  * QtDBus (macOS and Linux)

  * QtXcbQpa (Linux only)

  * Arch-specific platform plugin: libqcocoa.dylib, qwindows.dll, or libqxcb.so

  * Arch-specific platform style: libqmacstyle.dylib, qwindowsvistastyle.dll

* Clang, llvm-profdata, and llvm-cov 4+ (for code coverage)

* Clang, scan-build 4+ (for static analysis)

## Internal

Located in the [lib](lib) folder:

* [Capstone](https://github.com/aquynh/capstone) (disassembler)

* [libiberty](https://github.com/gcc-mirror/gcc/tree/master/libiberty) (demangling)

# Building The Program

```

% ./init_repo.sh        # Only needed after first git clone!

% mkdir build

% cd build

% cmake ..

% make

```

This will create the dispar executable in "./bin/".

**NOTE: In the following all cmake invocations assume they're being run from the "./build" folder!**

# Testing

A suite of software tests can be run like this:

```

% cmake -DBUILD_TESTS=ON .

% make

% ctest

```

# Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

# Advanced Topics

See [ADVANCED.md](ADVANCED.md).