Binwalk-python

This is a python SDK for using Binwalk (which is now a Rust project). You can install this library from PyPI.

Installation

Install via pip

pip install binwalk-python-sdk

Quickstart

1. Run a basic scan using the scan endpoint:

from pybinwalk import scan

result = basic_scan(image_path)
print(type(result))
# List

2. Run an extraction on a binary and save the results to a specified directory:

from pybinwalk import extract

in_bin = "/path/to/input/binary"
out_dir = "/path/to/output/DIR"

result = extract(in_bin, out_dir)

3. Install dependencies for your OS (currently supports Linux) using the Manager:

from pybinwalk import Manager

Manager(stream=True).handle_deps()		# This produces a verbose streaming log as it installs all dependencies