HexDig

🔍 HexDig is a fast, extensible tool for scanning, inspecting, and extracting embedded data from binary files and firmware images.

Inspired by tools like binwalk, HexDig focuses on modern workflows, clear output, and hackable internals—making it ideal for reverse engineers, firmware analysts, and security researchers.

---

✨ Features

• 🧠 Scan binary files for embedded file signatures

• 🧩 Identify compressed data, file systems, and common firmware formats

• 📦 Extract discovered data automatically or selectively

• 🧪 Analyze raw binaries and hex-level structures

• ⚡ Fast scanning with minimal dependencies

• 🔌 Plugin-friendly architecture (WIP)

---

🚀 Installation

From source

git clone https://github.com/gcarmix/hexdig.git

cd hexdig

mkdir build

cd build

cmake ..

make -j8

sudo make install

Installation instructions may change as HexDig evolves.

Packaging support (pip, cargo, apt, etc.) is planned.

---

🛠 Usage

Basic scan

hexdig firmware.bin

Scan with extraction

hexdig -e firmware.bin

Show detailed output

hexdig -v firmware.bin

---

📄 Example Output

* ../inputs/openwrt-18.06.3-mediatek-mt7623-7623n-bananapi-bpi-r2-initramfs-kernel.bin
└── [0x0000] UIMAGE (length=4259578)
    Source: ../inputs/openwrt-18.06.3-mediatek-mt7623-7623n-bananapi-bpi-r2-initramfs-kernel.bin  
    Info: UImage: ARM OpenWrt Linux-4.14.128, timestamp=2019-06-21
          12:17:25 UTC, OS=Linux, CPU=ARM, Type=Kernel,
          Compression=None
    ├── [0x3c38] XZ (length=4220724)
    │   Source: extractions/openwrt-18.06.3-mediatek-mt7623-7623n-bananapi-bpi-r2-initramfs-kernel.bin.extracted/0/ARM OpenWrt Linux-4.14.128.bin
    │   Info: XZ compressed stream, total size: 4220724 bytes
    └── [0x40a3ac] DTB (length=23434)
        Source: extractions/openwrt-18.06.3-mediatek-mt7623-7623n-bananapi-bpi-r2-initramfs-kernel.bin.extracted/0/ARM OpenWrt Linux-4.14.128.bin
        Info: Device Tree Blob

---

🔧 Configuration

HexDig supports configuration via:

• Command-line flags

• Environment variables (planned)

• Config file support (planned)

Run hexdig --help for all available options.

---

🧩 Supported Parsers

• AES
• ARJ
• BMP
• BZIP2
• CAB
• CPIO
• CRAMFS
• CRC
• DTB
• ELF
• FAT
• GIF
• GZIP
• JPG
• Linux
• LZMA
• MBR
• PDF
• PE
• PNG
• RAR
• ROMFS
• 7Z
• SquashFS
• TAR
• UImage
• XZ
• ZIP

More formats are continuously being added.

---

🧪 Development Status

⚠️ HexDig is under active development.

APIs, output formats, and features may change.

Contributions, feedback, and testing are very welcome.

---

🤝 Contributing

Contributions are encouraged!

1. Fork the repository

2. Create a feature branch

3. Commit your changes

4. Open a pull request

Please include:

• Clear commit messages

• Tests when applicable

• Documentation updates for new features

---

📜 License

HexDig is released under the GPL-3.0 License.

See the LICENSE file for details.

---

🙏 Acknowledgements

• Inspired by binwalk

• Thanks to the firmware reverse-engineering and open-source security communities

---

📫 Contact

Have ideas, bugs, or feature requests?

Open an issue or start a discussion on GitHub.

Happy digging 🧑‍💻