diff --git a/README.md b/README.md index a5eb825..0fd77e1 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,34 @@ # elfparser-ng -Multiplatform CLI and GUI tool to show information about ELF files. +Multiplatform command-line and graphical tool to analyze (suspicious) ELF files. This is an authorized, maintained fork of the great [ELF Parser](https://elfparser.com). -![gui](assets/elfparser-ng.png) -![cli](assets/elfparser-ng-cli.png) +## Features -This project aims to keep the great [elfparser](https://github.com/jacob-baines/elfparser) alive. Plans include updating and adding new features to it. +* File hashes (MD5, SHA-1, and SHA-256). +* File entropy. +* ELF headers, sections and segments parsing. +* ELF symbols. +* Hex Dump. +* Capabilities detection. +* Scoring system. -## What problem are you trying to solve? +## Installing -Keep one of the few multiplatform graphical tool to parse ELF files up to date and improve it with new features. +You can download a pre-compiled release from the [Releases](https://github.com/mentebinaria/elfparser-ng/releases) section and use it. -## Features +## Screnshots -* Parse ELF headers and segments. -* Show symbols. -* Hex Dump. -* Calculate file's entropy. +### Main window -## Installing +![main](assets/gui-win-main.png) + +### Segments + +![segments](assets/gui-win-segments.png) -You can just download a pre-compiled release from the [Releases](https://github.com/mentebinaria/elfparser-ng/releases) section and use it. +### Capabilities + +![capabilities](assets/gui-win-capabilities.png) ## Building @@ -32,7 +40,7 @@ To build on Windows, set the `option(windows "Enable Windows build." OFF` to `ON ### Compile Targets -ELF Parser has a number of compilation targets that can be configured by CMakeLists.txt. The targets are: +elfparser-ng has a number of compilation targets configurable in `CMakeLists.txt` file: * Unit tests * CLI build @@ -40,8 +48,10 @@ ELF Parser has a number of compilation targets that can be configured by CMakeLi ### Dependencies -[Boost](http://robots.uc3m.es/installation-guides/install-boost.html#install-boost-windows) -> sudo apt-get install libboost-all-dev +* Boost +* Qt5 + +In Debian-based Linux distros, you can install them with: -[Qt5](https://www.qt.io/download-open-source) -> sudo apt-get install build-essential qtcreator qt5-default qtdeclarative5-dev + apt-get install libboost-all-dev build-essential \ + qtcreator qt5-default qtdeclarative5-dev diff --git a/assets/elfparser-ng-cli.png b/assets/elfparser-ng-cli.png deleted file mode 100644 index 1f2a2e6..0000000 Binary files a/assets/elfparser-ng-cli.png and /dev/null differ diff --git a/assets/elfparser-ng.png b/assets/elfparser-ng.png deleted file mode 100644 index ae3f655..0000000 Binary files a/assets/elfparser-ng.png and /dev/null differ diff --git a/assets/gui-win-capabilities.png b/assets/gui-win-capabilities.png new file mode 100644 index 0000000..891ea82 Binary files /dev/null and b/assets/gui-win-capabilities.png differ diff --git a/assets/gui-win-main.png b/assets/gui-win-main.png new file mode 100644 index 0000000..5a381a5 Binary files /dev/null and b/assets/gui-win-main.png differ diff --git a/assets/gui-win-segments.png b/assets/gui-win-segments.png new file mode 100644 index 0000000..9eec914 Binary files /dev/null and b/assets/gui-win-segments.png differ