This supports all features of Android sparse images, including holes, and CRC32 (both full image checksum and CRC32 chunks). Partial sparse images, like those included in GrapheneOS' new optimized factory images, can also be packed and unpacked with these new commands, unlike AOSP's simg2img and img2simg tools. This new functionality is not relevant for avbroot's main use case, but is useful for unpacking certain factory images for comparison with OTAs during troubleshooting. Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
Fuzzing
While avbroot's parsers are all memory-safe, it is still possible for panics or crashes to occur, for example due to excessive memory allocation, integer overflow, or division by zero. Fuzzing helps to identify these issues by randomizing inputs in a way that tries to increase code coverage.
Running the fuzzers
-
Install the cargo honggfuzz commands.
cargo install honggfuzz -
Pick a fuzz target to run. A fuzz target is the name of the source file in
src/bin/without the.rsextension.The list of targets can be queried programmatically with:
cargo read-manifest | jq -r '.targets[].name' -
Run the fuzzer.
cargo hfuzz run <fuzz target>This will run forever until it is manually killed. At the top of the screen, a summary section like the following is shown:
Iterations : 31,243 [31.24k] Mode [1/3] : Feedback Driven Dry Run [2486/4085] Target : hfuzz_target/x86_64-unknown-linux-gnu/release/bootimage Threads : 8, CPUs: 16, CPU%: 800% [50%/CPU] Speed : 36,126/sec [avg: 31,243] Crashes : 53 [unique: 1, blocklist: 0, verified: 0] Timeouts : 0 [1 sec] Corpus Size : 1,424, max: 24,576 bytes, init: 4,085 files Cov Update : 0 days 00 hrs 00 mins 00 secs ago Coverage : edge: 897/224,621 [0%] pc: 2 cmp: 34,736When a crash occurs, the
Crashescounter will increment and the input data that triggered the crash will be written tohfuzz_workspace/<fuzz target>/*.fuzz. New files are only written for unique crashes. -
If a crash occurs, run the following command to trigger the crash in a debugger.
cargo hfuzz run-debug <fuzz target> \ hfuzz_workspace/<fuzz_target>/<input file>.fuzzThis defaults to using
rust-lldb. To userust-gdbinstead, set theHFUZZ_DEBUGGERenvironment variable torust-gdb.Alternatively, just feed the input file to the appropriate avbroot command directly (eg.
avbroot boot info -i hfuzz_workspace/<fuzz_target>/<input file>.fuzzfor boot images).