Skip to content
A binary grep written in Rust.
Branch: master
Clone or download
Latest commit b3e3c4d Mar 22, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Initial commit. Jan 30, 2019
Cargo.lock Version 1.0.0. Mar 22, 2019
Cargo.toml Version 1.0.0. Mar 22, 2019

Bgrep - A binary grep written in Rust.

Bgrep is a grep spin that aims to support binary patterns and files. The key difference from its cousins is that it won't do line-wise matching. Therefore, you can match any byte pattern, including those that would span multiple lines.


bgrep [FLAGS] <pattern> [files]...

    -b, --byte-offset              Prints the byte offset of each match
    -l, --files-with-matches       Prints the name of the matched files (default output mode)
    -L, --files-without-matches    Prints the name of non-matched files
        --help                     Prints help information
    -i, --ignore-case              Case insensitive matching for ASCII alphabetic characters
    -v, --invert-match             Invert the sense of matching, to select non matching slices
    -h, --no-filename              Suppress the file names on output (default when there is a single file).
    -o, --only-matching            Prints the matched bytes of each match
    -n, --trim-ending-newline      If the file ends with a newline, disconsider the last byte
    -V, --version                  Prints version information
    -H, --with-filename            Print the file name for each match (default when there are multiple files).

Bgrep uses Rust's regex crate as engine. The regex syntax documentation can be found here. Bgrep disables unicode matching by default, but it can be enabled with the u regex pattern flag.



Ix |  0 1  2 3  4 5  6 7  8 9  A B  C D  E F | ASCII characters
00 | 0001 0203 0405 0607 0809 0A0B 0C0D 0E0F | ................
10 | 0000 0000 0000 0000 0000 0000 0000 0000 | ................
20 | 2021 2223 2425 2627 2829 2A2B 2C2D 2E2F |  !"#$%&'()*+,-./
30 | 0000 0000 0000 0000 0000 0000 0000 0000 | ................
40 | 4041 4243 4445 4647 4849 4A4B 4C4D 4E0A | @ABCDEFGHIJKLMN.

Get the offsets of a given pattern:

$ bgrep -b '\x00\x20|\x00\x40' file.bin

Get the matching bytes:

$ bgrep -o '\x40.+\x4d' file.bin

List non-matching files: (tac -rs . reverses the file)

$ tac -rs . file.bin | bgrep -L '\x4C\x4D' file.bin -

Get the offset of inverse matches:

$ bgrep -bv '\x00+' file.bin


Copyright © 2019 gahag.
All rights reserved.

This software may be modified and distributed under the terms of the BSD 3 Clause license. See the LICENSE file for details.

You can’t perform that action at this time.