[pull] master from ReFirmLabs:master

.gitattributes

@@ -1,3 +1,4 @@
 * text eol=lf
 *.md text eol=lf
-*.png binary
+*.png binary
+*.bin binary

.github/workflows/quality.yaml

@@ -38,3 +38,28 @@ jobs:
 
       - name: Formatting (rustfmt)
         run: cargo fmt -- --check
+
+  lint:
+    name: Lint (clippy)
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        platform:
+          - target: x86_64-unknown-linux-gnu
+
+    steps:
+      - name: Code checkout
+        uses: actions/checkout@v4
+
+      - name: Install Rust toolchain (stable)
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          target: ${{ matrix.platform.target }}
+          components: clippy
+
+      - name: Clippy (all crates)
+        run: cargo clippy --locked --target=${{ matrix.platform.target }} --workspace --all-targets -- -D warnings
+
+      - name: Check build did not modify any files
+        run: test -z "$(git status --porcelain)"

CARGO_README.md

@@ -0,0 +1,28 @@
+# binwalk
+
+A Rust implementation of the Binwalk firmware analysis tool.
+
+## System Requirements
+
+Building requires the following system packages:
+
+```
+build-essential libfontconfig1-dev liblzma-dev
+```
+
+## Example
+
+```
+use binwalk::Binwalk;
+
+// Create a new Binwalk instance
+let binwalker = Binwalk::new();
+
+// Read in the data to analyze
+let file_data = std::fs::read("/tmp/firmware.bin").expect("Failed to read from file");
+
+// Scan the file data and print the results
+for result in binwalker.scan(&file_data) {
+    println!("{:#?}", result);
+}
+```

Cargo.toml

@@ -1,8 +1,13 @@
 [package]
 name = "binwalk"
-version = "3.1.0"
+version = "3.1.1"
 edition = "2021"
 authors = ["Craig Heffner <[email protected]>"]
+license = "MIT"
+readme = "CARGO_README.md"
+repository = "https://github.com/ReFirmLabs/binwalk"
+description = "Analyzes data for embedded file types"
+keywords = ["binwalk", "firmware", "analysis"]
 
 [dependencies]
 log = "0.4.22"
@@ -13,17 +18,22 @@ entropy = "0.4.2"
 colored = "2.1.0"
 termsize = "0.1"
 crc32-v2 = "0.0.4"
+crc32c = "0.6.8"
 plotters = "0.3.6"
 xz2 = "0.1.7"
 bzip2 = "0.4.4"
 threadpool = "1.8.1"
 serde_json = "1.0"
 env_logger = "0.11.5"
 flate2 = "1.0.34"
+adler32 = "1.2.0"
+md5 = "0.7.0"
+miniz_oxide = "0.8.0"
 aho-corasick = "1.1.3"
 serde = { version = "1.0", features = ["derive"]}
 clap = { version = "4.5.16", features = ["derive"] }
 xxhash-rust = { version = "0.8.12", features = ["xxh32"] }
+hex = "0.4.3"
 
 [dependencies.uuid]
 version = "1.10.0"
@@ -33,3 +43,5 @@ features = [
     "macro-diagnostics", # Enable better diagnostics for compile-time UUIDs
 ]
 
+[profile.release]
+lto = true

Dockerfile

@@ -1,32 +1,41 @@
 FROM ubuntu:24.04
 
+ARG BINWALK_INSTALL_DIR="/tmp/binwalk"
+ARG DEFAULT_WORKING_DIR="/analysis"
+
 WORKDIR /tmp
 
-# Update apt and install git
-RUN apt-get update && apt-get upgrade -y && apt-get install -y git
+# Update apt
+RUN apt-get update && apt-get upgrade -y
 
-# Pull down latest Binwalk code
-RUN git clone https://github.com/ReFirmLabs/binwalk.git
+# Copy over the Binwalk build directory
+RUN mkdir -p ${BINWALK_INSTALL_DIR}
+COPY . ${BINWALK_INSTALL_DIR}
 
 # Allow pip to install packages system-wide
 RUN mkdir -p $HOME/.config/pip && echo "[global]" > $HOME/.config/pip/pip.conf && echo "break-system-packages = true" >> $HOME/.config/pip/pip.conf
 
 # Install all system dependencies
-RUN /tmp/binwalk/dependencies/ubuntu.sh
+RUN ${BINWALK_INSTALL_DIR}/dependencies/ubuntu.sh
 
 # Install Rust
 RUN curl https://sh.rustup.rs -sSf | sh -s -- -y
 
 # Build and install Binwalk
-RUN cd /tmp/binwalk && /root/.cargo/bin/cargo build --release && cp ./target/release/binwalk /usr/local/bin/binwalk
+RUN cd ${BINWALK_INSTALL_DIR} && /root/.cargo/bin/cargo build --release && cp ./target/release/binwalk /usr/local/bin/binwalk
 
 # Clean up binwalk build directory
-RUN rm -rf /tmp/binwalk
+RUN rm -rf ${BINWALK_INSTALL_DIR}
 
-RUN useradd -m -u 1337 -s /sbin/nologin appuser
+# Create the working directory
+RUN mkdir -p ${DEFAULT_WORKING_DIR} && chmod 777 ${DEFAULT_WORKING_DIR}
+WORKDIR ${DEFAULT_WORKING_DIR}
 
-WORKDIR /home/appuser
+# Run as the default ubuntu user
+USER ubuntu
 
-USER appuser
+# Enable this environment variable to remove extractor top-level symlink,
+# as the symlink target path in the docker environment will not match that of the host.
+ENV BINWALK_RM_EXTRACTION_SYMLINK=1
 
 ENTRYPOINT [ "binwalk" ]

README.md

@@ -1,8 +1,6 @@
 # Binwalk v3
 
-This is an updated version of the Binwalk firmware analysis tool.
-
-It has been re-written in Rust, and is currently in the beta testing phase.
+This is an updated version of the Binwalk firmware analysis tool, re-written in Rust for speed and accuracy.
 
 ![binwalk v3](images/binwalk_animated.svg)
 
@@ -20,6 +18,8 @@ Binwalk can be customized and [integrated](https://github.com/ReFirmLabs/binwalk
 
 The easiest way to install Binwalk and all dependencies is to [build a Docker image](https://github.com/ReFirmLabs/binwalk/wiki/Building-A-Binwalk-Docker-Image).
 
+Binwalk can also be [installed](https://github.com/ReFirmLabs/binwalk/wiki/Cargo-Installation) via the Rust package manager.
+
 Or, you can [compile from source](https://github.com/ReFirmLabs/binwalk/wiki/Compile-From-Source)!
 
 ## How do I use it?

dependencies/src.sh

@@ -30,12 +30,11 @@ make install
 cd /tmp
 rm -rf /tmp/dmg2img
 
-# Install srec2bin
-mkdir /tmp/srec
-cd /tmp/srec
-wget http://www.goffart.co.uk/s-record/download/srec_151_src.zip
-unzip srec_151_src.zip
-make
-cp srec2bin /usr/local/bin/
+# Install latest version of 7z (static) for APFS support
+mkdir /tmp/7z
+cd /tmp/7z
+wget https://www.7-zip.org/a/7z2408-linux-x64.tar.xz
+tar -xf 7z2408-linux-x64.tar.xz
+cp 7zzs /usr/local/bin/
 cd /tmp
-rm -rf /tmp/srec
+rm -rf /tmp/7z

dependencies/ubuntu.sh

@@ -5,18 +5,18 @@ SCRIPT_DIRECTORY=$(dirname -- "$( readlink -f -- "$0"; )")
 
 # Install dependencies from apt repository
 DEBIAN_FRONTEND=noninteractive TZ=Etc/UTC apt-get -y install \
-    p7zip-full \
+    7zip \
     zstd \
-    unzip \
+    srecord \
     tar \
+    unzip \
     sleuthkit \
     cabextract \
     curl \
     wget \
     git \
     lz4 \
     lzop \
-    device-tree-compiler \
     unrar \
     unyaffs \
     python3-pip \