diff --git a/binhop/.gitignore b/.gitignore similarity index 100% rename from binhop/.gitignore rename to .gitignore diff --git a/binhop/LICENSE b/LICENSE similarity index 100% rename from binhop/LICENSE rename to LICENSE diff --git a/README.md b/README.md new file mode 100644 index 0000000..1cbeb10 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +
+Binhop Logo + +# binhop + +binhop is a **file carving visualizer**, powered by binwalk. + +It makes clear what parts of a blob can be extracted, so you can +take action on the parts that didn't.
+binhop relies entirely on a functioning installation of binwalk. + +[Usage](#usage) • +[Installation](#installation) • +[Contributing](#contributing) • +[License](#license) +
+ +## Usage + +To use the script, run the following command: + +``` +binhop +``` + +Alternatively, you can run binhop on data from STDIN like so: + +``` +binhop < +``` + +## Installation + +To use this script, you need Python 3 and a functioning and "recent" version of `binwalk` installed on your system. You'll probably also want to install optional `binwalk` dependencies such as `sasquatch`, `jefferson`, and others. You can learn how to do that in the [binwalk documentation](https://github.com/ReFirmLabs/binwalk/blob/master/INSTALL.md). + +When that's done, install the Python dependencies for `binhop`, running something like: + +``` +git clone https://github.com/darrylnixon/binhop.git +cd binhop +pip install -r requirements.txt +pip install . +``` + +## Contributing + +If you would like to contribute to this project, feel free to submit a pull request or open an issue on GitHub. + +This tool was written as part of my coursework for CSC 842 - Security Tool Development at Dakota State University. Consequently, I may choose not to maintain this tool beyond the length of the course, but have selected a license that enables open contributions in any case. + +## License + +This project is licensed under the GPLv3 License, because it's important to give back. See the `LICENSE` file for details. \ No newline at end of file diff --git a/binhop/binhop/__init__.py b/binhop/__init__.py similarity index 100% rename from binhop/binhop/__init__.py rename to binhop/__init__.py diff --git a/binhop/binhop/binhop.py b/binhop/binhop.py similarity index 100% rename from binhop/binhop/binhop.py rename to binhop/binhop.py diff --git a/binhop/binhop/core.py b/binhop/core.py similarity index 100% rename from binhop/binhop/core.py rename to binhop/core.py diff --git a/doc/binhop.png b/doc/binhop.png new file mode 100644 index 0000000..449e708 Binary files /dev/null and b/doc/binhop.png differ diff --git a/binhop/requirements.txt b/requirements.txt similarity index 100% rename from binhop/requirements.txt rename to requirements.txt diff --git a/binhop/setup.py b/setup.py similarity index 100% rename from binhop/setup.py rename to setup.py