Binwalk supports Python 2.7 - 3.x. Although binwalk is slightly faster in Python 3,
the Python OpenGL bindings are still experimental for Python 3, so Python 2.7 is
recommended.
Binwalk supports Python 2.7 - 3.x. Although binwalk is slightly faster in Python 3, the Python OpenGL bindings are still experimental for Python 3, so Python 2.7 is recommended.
The following installation procedures assume that you are installing binwalk to
be run using Python 2.7. If you want to use binwalk in Python 3, some package
The following installation procedures assume that you are installing binwalk to be run using Python 2.7. If you want to use binwalk in Python 3, some package
names and installation procedures may differ slightly.
Installation
============
INSTALLATION
-----------------------------------------
Installation follows the typical configure/make process (standard development tools
such as gcc, make, and Python must be installed in order to build):
Installation follows the typical configure/make process (standard development tools such as gcc, make, and Python must be installed in order to build):
$ ./configure
$ make
$ sudo make install
Binwalk's core features will work out of the box without any additional dependencies.
However, to take advantage of binwalk's graphing and extraction capabilities, multiple
supporting utilities/packages need to be installed.
Binwalk's core features will work out of the box without any additional dependencies. However, to take advantage of binwalk's graphing and extraction capabilities, multiple supporting utilities/packages need to be installed.
To ease "dependency hell", a shell script named deps.sh is included which attempts to
install all required dependencies for Debian and RedHat based systems:
To ease "dependency hell", a shell script named `deps.sh` is included which attempts to install all required dependencies for Debian and RedHat based systems:
$ ./deps.sh
If you are running a different system, or prefer to install these dependencies manually,
see the DEPENDENCIES section below.
If you are running a different system, or prefer to install these dependencies manually, see the Dependencies section below.
Dependencies
============
DEPENDENCIES
-------------------------------------------
The following dependencies are only required for optional binwalk features, such as file extraction and graphing capabilities. Unless otherwise specified, these dependencies are available from most Linux package managers.
The following dependencies are only required for optional binwalk features, such as
file extraction and graphing capabilities. Unless otherwise specified, these
dependencies are available from most Linux package managers:
Binwalk uses [pyqtgraph](http://www.pyqtgraph.org) to generate graphs and visualizations; pyqtgraph requires the following Python modules:
libqt4-opengl
python-opengl
...
...
@@ -49,25 +37,27 @@ dependencies are available from most Linux package managers:
python-numpy
python-scipy
mtd-utils
zlib1g-dev
liblzma-dev
ncompress
gzip
bzip2
tar
arj
p7zip
p7zip-full
Binwalk relies on multiple external utilties in order to automatically extract/decompress files and data:
The following command will remove binwalk from your system. Note that this will *not*
remove utilities installed via deps.sh:
The following command will remove binwalk from your system. Note that this will *not* remove manually installed packages, or utilities installed via deps.sh:
@@ -14,11 +14,11 @@ Binwalk follows the standard Unix configure/make installation procedure:
$ make
$ sudo make install
For convenience, optional dependancies for automatic extraction and graphical visualizations can be installed by running the included `deps.sh` script:
For convenience, optional dependencies for automatic extraction and graphical visualizations can be installed by running the included `deps.sh` script:
$ ./deps.sh
If your system is not supported by deps.sh, or if you wish to manually install dependancies, see INSTALL.md.
If your system is not supported by deps.sh, or if you wish to manually install dependencies, see INSTALL.md.
For advanced installation options, see INSTALL.md.