binwalk README

The project's README from github.com/ReFirmLabs/binwalk. As one markdown file: README.md.

Binwalk v3

This is an updated version of the Binwalk firmware analysis tool, re-written in Rust for speed and accuracy.

binwalk v3

What does it do?

Binwalk can identify, and optionally extract, files and data that have been embedded inside of other files.

While its primary focus is firmware analysis, it supports a wide variety of file and data types.

Through entropy analysis, it can even help to identify unknown compression or encryption!

Binwalk can be customized and integrated into your own Rust projects.

How do I get it?

The easiest way to install Binwalk and all dependencies is to build a Docker image.

Binwalk can also be installed via the Rust package manager.

Or, you can compile from source!

How do I use it?

Usage is simple, analysis is fast, and results are detailed:

binwalk DIR-890L_AxFW110b07.bin

example output

Use --help, or check out the Wiki for more advanced options!

binwalk (ReFirmLabs/binwalk)

embedded-systems
Searching Database…

14.5K ·GitHub
What is this?Binwalk is a firmware analysis tool that can identify, and optionally extract, files and data that have been embedded inside other files.
Is this a command-line tool or a library?It's primarily a CLI tool for scanning and extracting files, but it is also designed to be embedded as a Rust library in your own projects.
Do I need Rust installed, or can I just use Docker?You only need Docker if you use the container image; otherwise you need Rust and Cargo to install the crate or build from source.
What kinds of files can it detect inside firmware?It supports a wide variety of file and data types beyond firmware-specific formats, scanning for embedded file signatures of any kind.
What is the entropy analysis feature for?It measures the randomness of data to help flag sections using unknown or unidentified compression or encryption, catching cases that signature-based scanning alone would miss.
What changed in this v3 rewrite?The original Python-based binwalk was completely rewritten in Rust to improve scanning speed and detection accuracy.
How do I run a scan?Point the binwalk binary at a target file and run it; use --help for the full list of options, and the project Wiki for advanced usage.
What are similar projects?pwndbg, radare2, PwnPad, PCILeechGen, rea, vol-rs, x64dbg, BLEhound
Creator
ReFirmLabs
Size
51.9 MB
Stars
14.5K
Age
12y
Commits · 90 Days