Compare commits

...

285 Commits

Author SHA1 Message Date
Andrew Gunnerson f4e5c55fe9 Version 3.23.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-09-30 20:39:13 -04:00
Andrew Gunnerson 850ce86388 CHANGELOG.md: Add entry for PR #520
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-09-30 20:16:31 -04:00
Andrew Gunnerson c16636a68c Update dependencies
The only breaking changes are a few types from lzma-rust2 being renamed.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-09-30 20:15:20 -04:00
Andrew Gunnerson 26812cd43a CHANGELOG.md: Add entry for PR #519
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-09-30 20:08:55 -04:00
Andrew Gunnerson 135cd320ce Bump Magisk version upper bound to 30400
30300 introduced a new RECOVERYMODE config option, which we
unconditionally disable because we never patch init_boot.cpio within
the vendor_boot image.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-09-30 20:07:34 -04:00
Andrew Gunnerson 919f621833 CHANGELOG.md: Add entry for PR #517
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-09-21 19:03:34 -04:00
Andrew Gunnerson 2c1d86cd96 deny.toml: Remove outdated override for ring license
Issue: #516

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-09-21 18:52:15 -04:00
Andrew Gunnerson 91074ae4c8 Update dependencies and fix clippy 1.90 lints
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-09-21 18:51:25 -04:00
Andrew Gunnerson a5c628b66f Version 3.22.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-27 23:47:22 -04:00
Andrew Gunnerson 156c96d3d4 CHANGELOG.md: Add entry for PR #512
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-27 23:46:31 -04:00
Andrew Gunnerson 2460d1807d Update dependencies
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-27 23:24:42 -04:00
Andrew Gunnerson 728d333951 CHANGELOG.md: Add entry for PR #511
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-27 23:11:10 -04:00
Andrew Gunnerson 39661a994d Cargo.toml: Specify minimum supported toolchain version
Fixes: #506

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-27 23:08:58 -04:00
Andrew Gunnerson d6b19b69f7 CHANGELOG.md: Add entry for PR #510
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-27 22:58:44 -04:00
Andrew Gunnerson 96806cba36 cli: Allow skipping unpacking of images
This is useful if the file format metadata is the only thing that the
user needs.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-27 22:54:44 -04:00
Andrew Gunnerson 5c474a1e98 CHANGELOG.md: Add entry for PR #509
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-27 22:40:38 -04:00
Andrew Gunnerson 4cf546e5ca cli/payload: Compute CoW size estimates during packing
This was overlooked during the initial implementation. Payload images
using VABC, but without CoW size estimates, are unflashable outside of
recovery.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-27 22:06:44 -04:00
Andrew Gunnerson 8f71b61b21 Version 3.21.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 21:18:59 -04:00
Andrew Gunnerson fa8d9eb58c CHANGELOG.md: Add entry for PR #505
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 20:15:19 -04:00
Andrew Gunnerson 39afcf485f Fix clippy lints
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 20:14:52 -04:00
Andrew Gunnerson a3eb8284c8 CHANGELOG.md: Add entry for PR #504
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 20:08:01 -04:00
Andrew Gunnerson e2708d39dd format/payload: Make compression factor required only for CoW v3
It turns out that even though newer versions of delta_generator set this
field for CoW v2 (unused), older versions did not.

Fixes: #493

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 20:03:33 -04:00
Andrew Gunnerson a5f13826e7 CHANGELOG.md: Add entry for PR #503
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 19:21:42 -04:00
Andrew Gunnerson 963456c194 patch/boot: Replace function pointers with opener trait
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 19:19:55 -04:00
Andrew Gunnerson 842a2feb88 CHANGELOG.md: Add entry for PR #502
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 19:02:00 -04:00
Andrew Gunnerson 8bb1f771af format/payload: Remove unnecessary function pointer in extract_images()
The list of output files that are needed are known beforehand. There's
no need to dynamically open them.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 18:47:05 -04:00
Andrew Gunnerson ab51654dad CHANGELOG.md: Add entry for PR #498
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 18:43:26 -04:00
Andrew Gunnerson d75b87d3df Update dependencies
The e2e checksums were updated because the new lzma-rust2 version has
slight differences in compression ratio.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 18:18:39 -04:00
Andrew Gunnerson 73e0404662 CHANGELOG.md: Add entry for PR #501
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 18:18:27 -04:00
Andrew Gunnerson ebb4f18add Use try_for_each where possible (round 2)
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 18:17:46 -04:00
Andrew Gunnerson bee8d80df0 CHANGELOG.md: Add entry for PR #500
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 18:12:08 -04:00
Andrew Gunnerson fdb19e3b97 format/payload: Use dynamic dispatch for large functions
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 17:54:05 -04:00
Andrew Gunnerson cef29fd280 CHANGELOG.md: Add entry for PR #499
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 17:18:00 -04:00
Andrew Gunnerson 58155513af format/payload: Fix out-of-order multithreaded writes
This was a regression from d874921a69.
extract_images()'s open_output parameter was requesting a WriteSeek
instead of a WriteAt, so it received multiple instances of Arc<File>
all with the same underlying File (and file offset).

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-23 17:08:23 -04:00
Andrew Gunnerson 01cdd0b0d3 CHANGELOG.md: Add entry for PR #497
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-22 22:37:07 -04:00
Andrew Gunnerson e39d023855 format/cpio: Fix integer underflow panic in debug builds
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-22 22:35:48 -04:00
Andrew Gunnerson 05c86af298 CHANGELOG.md: Add entry for PR #496
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-22 22:21:45 -04:00
Andrew Gunnerson 759ed7fae5 Use try_for_each where possible
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-22 22:11:32 -04:00
Andrew Gunnerson f6aac1c12f deny.toml: Remove unused git repo URL
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-22 22:07:31 -04:00
Andrew Gunnerson e5b754c786 CHANGELOG.md: Add entry for PR #495
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-22 22:07:31 -04:00
Andrew Gunnerson d874921a69 Replace file reopen concept with ReadAt/WriteAt traits
File reopening was conflating ownership of file-like types with the fact
that they support parallel reads and writes at arbitrary offsets.

The Reopen trait has now been replaced with ReadAt and WriteAt traits,
which are implemented for types that support parallel I/O. If a type
compatible with the standard Read/Write/Seek traits is needed, a new
UserPosFile type can act as the bridge by storing its own userspace file
offset. For the opposite bridge, there's MutexFile, which implements
ReadAt/WriteAt by using locks to make the operations sequential. This is
only really used in the tests though.

This eliminates the need for the PSeekFile and SharedCursor types. The
standard File and Cursor types can be used instead, and if shared
ownership is needed, Arc can be used.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-22 22:07:11 -04:00
Andrew Gunnerson 390dce5f0c CHANGELOG.md: Add entry for PR #492
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-21 18:57:08 -04:00
Andrew Gunnerson 6d939bda25 Use seek_relative where possible
This will not make a meaningful performance difference for our use case,
but does not make things any more complex either.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-21 18:55:21 -04:00
Andrew Gunnerson a40d6ea379 CHANGELOG.md: Add entry for PR #489
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-21 00:50:00 -04:00
Andrew Gunnerson 7d0bb378a6 Switch to rawzip crate for zip file handling
rawzip is a lower-level zip file library that is much more suited for
avbroot's use case. Its speed improvements aren't too important since
OTAs only have a handful of files, but it is a simpler layer of
abstraction and exposes more about zip file internals. We also no longer
need to maintain a perpetual fork of the zip library.

The only caveat is that rawzip (much like avbroot) is built around
writing zip files in a streaming fashion. To support `--zip-mode
seekable`, the output file is post-processed to copy the relevant data
descriptor fields to the local header. The unused data descriptors
remain in the file to avoid needing to shift file data, but this does
not violate the spec and Android's libziparchive accepts it just fine.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-20 21:12:27 -04:00
Andrew Gunnerson 3ed38b8d29 ci.yml: Set RUSTDOCFLAGS to statically link doctests
Prior to Rust 1.89, these tests were just skipped when cross-compiling.
Now, they are actually compiled and ran. Unfortunately, doctests don't
use the normal RUSTFLAGS environment variable, so we also need to set
RUSTDOCFLAGS or else the resulting dynamically linked executable will
fail to run on a non-Android host.

Upstream change: https://github.com/rust-lang/cargo/pull/15462

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-19 20:13:56 -04:00
Ivan 0717981d62 README.ru.md: Update translation
* https://github.com/chenxiaolong/avbroot/commit/f393d7adc42e43b2857a60c3b5fd404b14f042c4
* https://github.com/chenxiaolong/avbroot/commit/2f964bf113512bd7ff33eb3e47116305a262e9fc
* https://github.com/chenxiaolong/avbroot/commit/a2fe6fc9d882d4fd955d03b3a2046c5a41d5840c
* https://github.com/chenxiaolong/avbroot/commit/2683781737230b98172de335a6597363c6d71ff2

Signed-off-by: Ivan <reddxae@proton.me>
2025-08-14 12:20:38 +03:00
Ivan 556f86e4df README.md: Use "device" as a generic reference, clarifying & style improvements
* Use "device" as a generic reference instead of "phone" throughout the project description as more than just phones can support custom AVB functionality.
* Finalize the clarification on signing key generation in the initial setup section introduced by commit https://github.com/chenxiaolong/avbroot/commit/2f964bf113512bd7ff33eb3e47116305a262e9fc.
* The "warning" in the merging snapshots section is marked in bold and uppercase, aligning with the rest of the text, while less important "notes" don't stand out in the same way.

Signed-off-by: Ivan <reddxae@proton.me>
2025-08-14 12:19:38 +03:00
Andrew Gunnerson c019ccad1c Version 3.20.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-10 22:35:40 -04:00
Andrew Gunnerson 192e737dd3 CHANGELOG.md: Add entry for PR #487
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-10 22:24:42 -04:00
Andrew Gunnerson 339267149f Update dependencies and fix clippy lints
if-let chains!

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-10 22:21:24 -04:00
Andrew Gunnerson 21c2536759 CHANGELOG.md: Add entry for PR #486
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-10 22:10:31 -04:00
Andrew Gunnerson 185f02c209 cli/avb: verify-device: Use bootloader's reported key digest by default
This removes the need for the user to explicitly specify a public key to
verify against.

Issue: #482

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-10 22:03:09 -04:00
Andrew Gunnerson a8908d6d06 CHANGELOG.md: Add entry for PR #485
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-10 21:57:42 -04:00
Andrew Gunnerson 2683781737 cli/avb: Add new subcommand to verify device partitions
This adds a new `avbroot avb verify-device` subcommand, which is just
like the normal `verify` subcommand, except it reads the actual
partitions on the device. This is only available with the Android build
of avbroot since it needs to run on the actual device.

Fixes: #482

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-10 21:24:28 -04:00
Andrew Gunnerson 44b90936bf CHANGELOG.md: Add entry for PR #484
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-10 19:59:41 -04:00
Andrew Gunnerson d7369e73e9 Remove cap-std and cap-tempfile dependencies
There is not much benefit for our use case to have kernel-level
openat-style sandboxing of paths. We already check all untrusted paths
for safety and the sandboxing prevented the use of symlinks that point
outside of the parent directory of specified paths.

This commit also moves the path safety checks to the util module to
avoid having multiple implementations spread out everywhere.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-10 19:50:43 -04:00
Andrew Gunnerson bb5c97ea1b CHANGELOG.md: Add entry for PR #483
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-10 16:35:40 -04:00
Andrew Gunnerson ac95660e23 Switch to rust-lzma2 for XZ compression/decompression
The performance, both in CPU time and compression ratios, is very
comparable to liblzma. This lets us drop the last remaining
compression-related dependency written in C.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-10 16:20:41 -04:00
Andrew Gunnerson 2bac85f080 Version 3.19.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-07 23:23:18 -04:00
Andrew Gunnerson fa99a3bb98 CHANGELOG.md: Add entry for PR #479
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-07 23:20:12 -04:00
Andrew Gunnerson 0d5bc574b2 cli/ota: Re-sign signed image when header verification fails
Previously, unless forced, `avbroot avb pack` would only re-sign an
image if the packing process changed the header (eg. root digest).
However, this isn't sufficient when packing an image after the user
modifies avb.toml manually. This is especially the case when packing a
vbmeta image, which never triggered the old check because it does not
contain a raw image.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-07 23:14:06 -04:00
Andrew Gunnerson e34c48c92b CHANGELOG.md: Add entry for PR #478
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-07 23:13:47 -04:00
Andrew Gunnerson 8ea08ef98c cli/avb: Warn when verifying image with insecure flags
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-07 23:10:24 -04:00
Andrew Gunnerson 779b1116e1 CHANGELOG.md: Add entry for PR #477
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-07 23:09:24 -04:00
Andrew Gunnerson 821c5fe088 format/avb: Fix verifying unsigned AVB images
Previously, Header::verify() tried to always decode the public_key
field, even if the header was unsigned. This prevented verifying
unsigned images with `avbroot avb verify`. Verifying unsigned images
referenced by signed images was unaffected.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-07 23:04:01 -04:00
Andrew Gunnerson 6a1da333eb Version 3.18.1
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-07 01:53:44 -04:00
Andrew Gunnerson 256483d248 CHANGELOG.md: Add entry for PR #476
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-07 01:53:25 -04:00
Andrew Gunnerson 2314c371a8 sparse: Fix u32 overflow when unpacking files with large holes
CHUNK_TYPE_RAW is the only chunk type that's guaranteed to not overflow
a u32 when its number of blocks is multiplied by the block size.
CHUNK_TYPE_FILL and CHUNK_TYPE_DONT_CARE require a u64.

Issue: #472

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-07 01:36:22 -04:00
Andrew Gunnerson 59cf37faaf Version 3.18.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-06 21:41:13 -04:00
Andrew Gunnerson 36269acd7b CHANGELOG.md: Add entry for PR #475
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-06 21:37:45 -04:00
Andrew Gunnerson 6aacc5a76c Update dependencies
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-06 21:33:54 -04:00
Andrew Gunnerson bd4ebde403 CHANGELOG.md: Add entry for PR #474
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-06 21:30:23 -04:00
Andrew Gunnerson ffdae0bf88 Bump Magisk version upper bound to 30300
There are no breaking changes.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-06 21:28:33 -04:00
Andrew Gunnerson 8282f8087c CHANGELOG.md: Add entry for PR #473
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-06 21:27:46 -04:00
Andrew Gunnerson 6b11cd8af2 Allow using SHA-1 as AVB hash algorithm
Previously, we automatically promoted SHA-1 to SHA-256 because SHA-1 is
insecure, but there are devices that don't support SHA-256. It's safer
to just keep using the original hash algorithm.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-06 21:17:21 -04:00
Andrew Gunnerson f610f3b794 CHANGELOG.md: Add entry for PR #470
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-08-06 21:14:26 -04:00
Andrew Gunnerson b8d022d52c format/ota: Make property files verification more lenient
Previously, we computed the expected property files string (based on
AOSP's rules) and checked if the string in the OTA metadata was a
byte-for-byte match. This would fail for OTAs with strings that differ
from how AOSP generates them. This could be additional files or just
different ordering of the entries.

This commit changes the approach to just verify that the property file
entries is a valid subset of the zip file entries. We no longer try to
compute the expected value.

This does not change what avbroot generates when patching an OTA. Newly
generated property files strings always follow AOSP's rules.

Fixes: #469

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-07-22 20:49:05 -04:00
Andrew Gunnerson cd38217111 Version 3.17.2
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-07-03 14:48:16 -04:00
Andrew Gunnerson c8d548d224 CHANGELOG.md: Add entry for PR #468
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-07-03 14:31:59 -04:00
Andrew Gunnerson 9ad430ac7f Bump Magisk version upper bound to 30200
There are no breaking changes.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-07-03 14:30:50 -04:00
Andrew Gunnerson 8ca4eb5ad9 Version 3.17.1
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-07-01 19:07:13 -04:00
Andrew Gunnerson e2b1ccb7a1 CHANGELOG.md: Add entry for PR #467
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-07-01 19:06:37 -04:00
Andrew Gunnerson 71a31ae01b Bump Magisk version upper bound to 30100
There are no breaking changes.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-07-01 18:55:14 -04:00
Andrew Gunnerson 83d7ffbc5e CHANGELOG.md: Add entry for PR #464
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-06-19 20:20:54 -04:00
Andrew Gunnerson e397998d9e Update dependencies
The zip crate gained support for streaming writes in its master branch,
so we can finally upgrade from our ancient fork of it. The new
implementation is done a bit differently, with seekable writers having
the ZipWriter<W> type and streaming writers having the
ZipWriter<StreamWriter<W>> type. This forces us to add a new wrapper
type since we have to switch between them at runtime.

We still need to maintain a (hopefully temporary) fork of the crate due
to a few issues:

1. There's no way to get the original underlying writer instance back
   after finalizing a streaming zip. A fix for this has been submitted
   upstream:
   https://github.com/zip-rs/zip2/pull/367

2. The streaming writes implementation does not include the magic
   signature for data descriptors. While the zip spec says the magic
   value is optional and parsers should not require it, older versions
   of Android's libziparchive do. A fix for this has been submitted
   upstream:
   https://github.com/zip-rs/zip2/pull/368

3. There is currently no way to get the data offset of zip entries.
   avbroot requires this to fill in the OTA metadata's "property files"
   entries, which Android uses to read file data without parsing the zip
   file structures.

This new zip update produces files that are slightly different to
before. The "version made by" and "version needed to extract" fields are
now set to their minimum possible values. Previously, the zip crate was
hardcoded to use versions 4.6 and 2.0, respectively.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-06-19 18:55:08 -04:00
Andrew Gunnerson 8ef22508f5 CHANGELOG.md: Add entry for PR #463
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-06-19 18:49:32 -04:00
Andrew Gunnerson bf42a6a75c e2e: Split streaming and seekable work directories
Makes troubleshooting easier when files aren't being overwritten.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-06-19 17:49:00 -04:00
lefuglyduck a2fe6fc9d8 Update README.md
Clarify the updates section so it doesn't "loop back" to the usage section. 

Signed-off-by: lefuglyduck <31975903+lefuglyduck@users.noreply.github.com>
2025-06-12 16:12:13 -07:00
lefuglyduck faeb1fe988 Update README.md
Minor grammatical change.

Signed-off-by: lefuglyduck <31975903+lefuglyduck@users.noreply.github.com>
2025-06-12 17:53:52 -04:00
Andrew Gunnerson f1b2c6f468 Merge PR #458
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-06-12 17:51:40 -04:00
lefuglyduck 2f964bf113 Update README.md
Clarify step 3 of usage section.

Signed-off-by: lefuglyduck <31975903+lefuglyduck@users.noreply.github.com>
2025-06-11 22:36:24 -07:00
Andrew Gunnerson f393d7adc4 README.md: Add warning about post-installation snapshot merge operation
Issue: #454

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-06-08 17:00:21 -04:00
Andrew Gunnerson 72a1c3f216 Version 3.17.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-31 12:00:31 -04:00
Andrew Gunnerson 2db8d3826e CHANGELOG.md: Add entry for PR #453
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-31 10:26:46 -04:00
Andrew Gunnerson 1448e55205 Update dependencies
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-31 10:21:14 -04:00
Andrew Gunnerson b3862a9c4a CHANGELOG.md: Add entry for PR #452
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-31 10:18:11 -04:00
Andrew Gunnerson 088db04673 ota: Reserve 16 bytes for OTA metadata property files
Our previous limit was 15 bytes for the <offset>:<size> placeholder,
matching AOSP's ota_utils.py. Since the size of metadata.pb is almost
always 4 digits, this leaves 10 digits for the offset, which isn't
enough for large OTAs. AOSP never actually hits the limit because it
puts metadata and metadata.pb at the beginning of the output zip file.
We put the files at the end of the zip since we do streaming writes.

Fixes: #451

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-31 10:16:45 -04:00
Andrew Gunnerson b1410c869d Version 3.16.1
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-19 22:54:52 -04:00
Andrew Gunnerson dd6eaf8e78 CHANGELOG.md: Add entry for PR #449
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-19 22:50:59 -04:00
Andrew Gunnerson 0eac8e6614 Update dependencies
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-19 22:37:32 -04:00
Andrew Gunnerson 8a4f90176e CHANGELOG.md: Add entry for PR #448
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-19 22:33:01 -04:00
Andrew Gunnerson bd166594e2 Bump Magisk version upper bound to 29100
There are no breaking changes.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-19 22:31:34 -04:00
Andrew Gunnerson 19129ae927 Version 3.16.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-04 18:15:02 -04:00
Andrew Gunnerson fb2aaed042 CHANGELOG.md: Add entry for PR #446
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-04 18:14:25 -04:00
Andrew Gunnerson 182d937d34 Update all dependencies
This also fixes a number of disabled-by-default clippy warnings and
updates the Rust edition to 2024.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-04 18:06:59 -04:00
Andrew Gunnerson 113bdec6dc CHANGELOG.md: Add entry for PR #445
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-04 16:57:03 -04:00
Andrew Gunnerson 1f0d012ac0 e2e: Fix incorrect metadata when generating a non-CoW-V2 payload
It was hardcoded to set the CoW version to v2 in the payload manifest.
This commit also updates the pixel_v2 profile to disable VABC so that
scenario gets tested. The pixel_v3 profile now uses CoW v2 with gz.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-04 16:55:38 -04:00
Andrew Gunnerson e4fbe00ea2 CHANGELOG.md: Add entry for PR #444
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-04 16:29:40 -04:00
Andrew Gunnerson ad0b3d5aa8 payload: Add support for custom CoW compression levels
No known device uses this functionality, but AOSP supports it, so we
should too.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-03 23:34:25 -04:00
Andrew Gunnerson f4394b0c21 CHANGELOG.md: Add entry for PR #443
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-03 23:03:44 -04:00
Andrew Gunnerson 9dd98fd715 payload: Add support for uncompressed CoW and fix more estimation bugs
No known device uses this, but it's very useful for testing that our
overhead calculation is identical to AOSP's. A few more bugs were found
in our overhead calculation logic:

* The CowHeaderV3 size was missing the original CowHeader (v2) fields
  that are supposed to be included due to inheritance in the C++ class.
* The additional 1% overhead was incorrectly calculated against the
  initial CoW estimate before static overhead for CoW headers was added.
* The V3 num_ops estimation did not set a minimum of 25 to match
  delta_generator.
* The V2 size estimation did not take into account that a cluster of CoW
  operations cannot be truncated. It must be a multiple of cluster_ops
  (200 for avbroot).

With these fixes, the CoW estimation when compression is disabled
matches AOSP exactly. This means all the overhead calculation is now
correct and the only difference when compression is enabled is in the
compression ratios of the various lz4/gz implementations.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-03 22:59:15 -04:00
Andrew Gunnerson b6e3c68241 CHANGELOG.md: Add entry for PR #442
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-03 20:39:57 -04:00
Andrew Gunnerson 6fee5346bb payload: Add support for CoW version 3
AOSP has long supported CoW version 3, but it wasn't used by the stock
OS on any Pixel devices until the new Pixel 9a.

CoW version 3 is fundamentally similar to version 2, though with
differences in the main header and how the operation headers are stored.
The compression is no longer done in fixed-size chunks equal to the
block size. Instead, the payload specifies a "compression factor", which
is the maximum chunk size to pass to the compressor. The actual chunk
size is the largest power of 2 <= the compression factor and the
remaining input size. Additionally, for version 3, the payload stores an
additional estimate_op_count_max field containing the number of CoW
operations.

While working on support for version 3, a few bugs in the version 2
estimation logic were found and fixed:

* The cluster_ops * sizeof(CowOperationV2) overhead incorrectly
  assumed that cluster_ops was a constant 200 instead of the actual
  number of CoW operations.
* The overhead did not account for kCowLabelOp headers, which
  delta_generator emits once for every InstallOperation in the payload.
* The overhead did not account for kCowClusterOp headers, which batch
  CoW operations into groups of 200.
* The overhead did not account for the CowFooter.

The version 3 overhead is much simpler and easier to calculate compared
to version 2.

Fixes: #441

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-05-03 20:28:50 -04:00
Ivan 7d786150cf README.ru.md: update translation
* https://github.com/chenxiaolong/avbroot/commit/de433a27245adb26e578bdeb34a404552c79ea85
* https://github.com/chenxiaolong/avbroot/commit/5d66774d131505928b31e1968da0498732ac28ab
* https://github.com/chenxiaolong/avbroot/commit/b922f0d23ce841ac0bd14bfd33da46273f183f68
2025-04-21 19:51:43 +03:00
Andrew Gunnerson b922f0d23c README.md: Deemphasize rooting in project description
While avbroot initially started as a way to allow a rooted boot image to
be used with a locked bootloader, it has evolved much since then.
Nowadays, many folks use it to make modifications to their OTAs that
don't involve enabling root access. avbroot also has many subcommands
for packing and unpacking various Android image formats that people use
without ever using avbroot's main OTA patching functionality.

This commit updates the project description to reflect this and
simplifies the wording a bit.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-04-18 20:51:54 -04:00
Andrew Gunnerson 1f2b2170b3 CHANGELOG.md: Fix incorrect link to VABC compression algorithm documentation
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-04-11 21:13:17 -04:00
Andrew Gunnerson da124e4e05 Version 3.15.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-04-06 00:09:21 -04:00
Andrew Gunnerson 7b778515d1 CHANGELOG.md: Add entry for PR #439
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-04-06 00:02:48 -04:00
Andrew Gunnerson 98745afe33 Update dependencies
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-04-05 23:54:20 -04:00
Andrew Gunnerson a47c501211 CHANGELOG.md: Add entry for PR #438
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-04-05 23:53:50 -04:00
Andrew Gunnerson f2e47a65d4 Switch back to ring
This reverts commit e929ecbe44.

Ring is back to being maintained again, so let's switch back to it since
it has fewer build dependencies and is much faster to compile.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-04-05 23:52:53 -04:00
Andrew Gunnerson e11ddd2ba7 CHANGELOG.md: Add entry for PR #437
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-04-05 23:38:51 -04:00
Andrew Gunnerson 5d66774d13 Add support for changing VABC CoW compression algorithm
Devices that launch with Android <14 generally use gzip as the CoW
compression algorithm. This never changes because future full OTAs
always need to be installable from the version of Android the device
launched with.

However, for users that don't care about the upgrade path from old
versions of Android, a new --vabc-algo option can be used to switch from
gz to lz4 compression. This can cut down the OTA installation time by
more than 2/3rds when installing via a custom OTA updater app. On my
Pixel Tablet, the installation time for the update_engine DOWNLOADING
phase decreased from 32:05 to 9:41. Note that this has absolutely no
effect on the performance when sideloading from recovery mode because
that does not use CoW.

When this new option is used, all dynamic partitions need to be
extracted from the OTA during patching so that the CoW estimates can be
recomputed. This will slow down the patching process and use up more
temporary disk space.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-04-05 23:06:13 -04:00
Andrew Gunnerson 3f09a506a0 Version 3.14.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-23 19:27:05 -04:00
Andrew Gunnerson 4664f8ea37 CHANGELOG.md: Add entry for PR #435
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-23 19:26:29 -04:00
Andrew Gunnerson 796e2a4fa2 Update dependencies
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-23 19:17:15 -04:00
Andrew Gunnerson e6b60d5d0f CHANGELOG.md: Add entry for PR #434
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-23 19:02:39 -04:00
Andrew Gunnerson e8cb4a8d53 Fix incorrect compression input for gzip CoW size estimation
Instead of compressing the 64 MiB input in 2 MiB chunks, each loop
iteration was compressing the full 64 MiB. This massively slowed down
the patching process from seconds to potentially hours and would
temporarily waste a bunch of space during OTA installation.

Fixes: #433

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-23 18:50:44 -04:00
Andrew Gunnerson b2d280eb20 CHANGELOG.md: Add entry for PR #430
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-13 20:23:48 -04:00
Andrew Gunnerson e2dc5174b4 format/ota: Decouple OTA signature parsing from verification
This way, we can fail hard for parsing errors, but not for verification
errors in `avbroot ota verify`.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-13 20:22:16 -04:00
Andrew Gunnerson 80c47e9a02 CHANGELOG.md: Add entry for PR #429
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-13 19:49:54 -04:00
Andrew Gunnerson 65ba3ad5cc Fix clippy 1.85 warnings
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-13 19:48:32 -04:00
Andrew Gunnerson a7438876ce CHANGELOG.md: Add entry for PR #428
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-13 19:38:16 -04:00
Andrew Gunnerson c039901a85 cli/ota: Improve ota verify otacerts.zip handling
* Try to avoid fail-fast behavior to show as many errors as possible.
  Parsing errors always fail immediately, but verification errors don't.
* Move the recovery otacerts.zip check to the end to let more important
  checks run first.
* Improve error message when otacerts.zip does not contain the signing
  certificate for the OTA to make it clear the issue is not that the zip
  contains no certificates at all.
* Always run the recovery otacerts.zip check, but just log the error as
  a warning when running with --skip-recovery-ota-cert.
* Fix unformatted error context string when parsing a boot image's
  otacerts.zip file fails.

Discussion: #426

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-13 19:34:42 -04:00
Andrew Gunnerson 0cdc7172dd Version 3.13.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-12 18:39:59 -04:00
Andrew Gunnerson 1296275418 CHANGELOG.md: Add entry for PR #427
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-12 18:38:43 -04:00
Andrew Gunnerson a62d0a5c91 Update dependencies
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-12 18:25:35 -04:00
Andrew Gunnerson de433a2724 README.md: Clarify what --skip-{system,recovery}-ota-cert affects
Discussion: #426

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-03-12 18:07:17 -04:00
Andrew Gunnerson c08af33343 CHANGELOG.md: Add entry for PR #425
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-24 21:17:44 -05:00
Andrew Gunnerson e224884591 format/lp: Relax validation checks to parse on-device super partition
There are two documented behaviors in liblp that are violated with the
on-disk super partition layout after a virtual A/B CoW merge:

1. The partition name includes a `-` due to the `-cow` suffix. This is
   not meant to be a valid character.
2. The extent list is likely to have many gaps and not be sorted. The
   format documentation says that gaps are not allowed.

This commit updates avbroot's LP parser to be less strict so that it can
load real on-device super partitions. The extent allocator for the
`pack` subcommand remains unchanged though, so avbroot will always
produce LP images with sorted, gapless extents.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-24 21:05:28 -05:00
Andrew Gunnerson a525fc4550 CHANGELOG.md: Add entry for PR #424
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-21 21:34:30 -05:00
Andrew Gunnerson 8c6b0fdfc5 cli/ota: Discard unmodified system image temp file earlier
This is the same optimization as is currently done for boot images.
There's no reason to keep the temp file around for the entire patching
process if it's unmodified and we're not going to be copying its data
into the payload.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-21 21:23:10 -05:00
Andrew Gunnerson 36d4ed19ad CHANGELOG.md: Add entry for PR #423
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-21 21:18:12 -05:00
Andrew Gunnerson f9b06b33e6 cli/ota: Fix incorrect unprotected partition warning with --skip-system-ota-cert
The filtering out of partitions was done at the wrong scope, causing
avbroot to warn that extracted-but-unmodified partitions were not
protected by AVB. We never encountered this before because the system
image was always patched and unmodified boot images got filtered out at
an earlier phase during patching.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-21 21:00:59 -05:00
Andrew Gunnerson 620c873be5 CHANGELOG.md: Add entry for PR #422
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-21 21:00:20 -05:00
Andrew Gunnerson e929ecbe44 Replace ring with aws-lc
The author of ring recently announced that the library is no longer
being maintained and fixes for security issues may be significantly
delayed. Big thanks to Brian Smith for creating and maintaining the
library for so long!

This commit replaces ring with aws-lc, a cryptography library maintained
by Amazon AWS. It seems to be well-regarded and is used by high-profile
projects like rustls. It is also API-compatible with ring, so it is
effectively a drop-in replacement.

Unfortunately, we still cannot switch back to the RustCrypto SHA1 and
SHA2 implementations because they are still significantly slower than
ring and aws-lc on systems that do not support the SHA-NI extensions.

https://rustsec.org/advisories/RUSTSEC-2025-0007

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-21 20:44:19 -05:00
Andrew Gunnerson 31685713ef CHANGELOG.md: Add entry for PR #421
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-21 19:33:58 -05:00
Andrew Gunnerson 0dab7aa32c Switch to stable bzip2-rs release and use zlib-rs flate2 backend
* There is now a stable release of bzip2-rs with the fix for both the C
  and Rust versions of bzip2 being compiled.

* The zlib-rs deflate implementation is faster than the default
  miniz_oxide. Changing this requires updating the checksums in the e2e
  tests due to slight differences in compression levels between the two
  implementations.

* Temporarily silence RUSTSEC-2025-0007 to avoid blocking CI. The ring
  library is no longer maintained.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-21 19:27:18 -05:00
Ivan ba6c1b1400 README.ru.md: update translation
* https://github.com/chenxiaolong/avbroot/commit/c198646c7c9b3eb8013dca43df6df8502e619e3c
* https://github.com/chenxiaolong/avbroot/commit/d4eb231dd49e7e6c7320135785cde7cd57634a50
* https://github.com/chenxiaolong/avbroot/commit/1484cd47c354197e1179a554f9f001020297aac8
* https://github.com/chenxiaolong/avbroot/commit/84fa6c6bc63b62d1b3b96dcb50b18b13dea0076f

Signed-off-by: Ivan <reddxae@proton.me>
2025-02-11 14:20:11 +03:00
Andrew Gunnerson 1ecbf1144d CHANGELOG.md: Add entry for PR #418
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-09 21:59:13 -05:00
Andrew Gunnerson 84fa6c6bc6 Add option to skip replacing OTA cert in system image
This is analogous to the existing --skip-recovery-ota-cert option,
except for the system image.

Discussion: #417

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-09 21:42:18 -05:00
Andrew Gunnerson 15b7db4631 CHANGELOG.md: Add entry for PR #415
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-04 00:16:38 -05:00
Andrew Gunnerson 1d9c1574da lp: Stop checking for zeroed first block
AOSP says that for non-empty images, the first 4 KiB block is supposed
to be filled with zeros to prevent it from being interpreted as an old
BIOS boot sector. The previous implementation relied on that to
distinguish between empty and non-empty images. However, Samsung decided
to use this region for their own SignerVer02 structure, so the heuristic
doesn't work.

AOSP's liblp tries to parse the input file as an empty image before
falling back to parsing as a normal image. We'll do the same.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-02-04 00:13:27 -05:00
Andrew Gunnerson 43db728b9d Version 3.12.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-01-26 18:20:06 -05:00
Andrew Gunnerson fbe9f629ab CHANGELOG.md: Add entry for PR #411
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-01-26 18:11:40 -05:00
Andrew Gunnerson 80d5f19223 Update dependencies
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-01-26 18:10:42 -05:00
Andrew Gunnerson cff5ac6b2e CHANGELOG.md: Add entry for PR #410
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-01-26 18:04:35 -05:00
Andrew Gunnerson 2e3b5db9fe cli/key: Rename extract-avb to encode-avb
For consistency with decode-avb. The old syntax will remain supported
indefinitely for backwards compatibility.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-01-26 18:01:24 -05:00
Andrew Gunnerson 58a279f3a4 CHANGELOG.md: Add entry for PR #409
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-01-26 17:53:08 -05:00
Andrew Gunnerson 1484cd47c3 cli/ota: Add support for extracting OTA certificate and AVB public key
This also adds a new --none option so that these two components can be
extracted without extracting any partition images.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-01-26 17:50:09 -05:00
Andrew Gunnerson 2ee38b716b CHANGELOG.md: Add entry for PR #408
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-01-26 16:48:08 -05:00
Andrew Gunnerson d4eb231dd4 cli/ota: Add support for extracting specific images
Previously, we only supported extracting all images or the subset of
images that could potentially be patched by avbroot. This was
unnecessarily slow if the user only needed to extract a specific image.

This commit also deprecates and hides the `--boot-only` option, though
the functionality will remain indefinitely.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2025-01-26 16:43:35 -05:00
Andrew Gunnerson cf064e145d Version 3.11.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-25 20:05:57 -05:00
Andrew Gunnerson 3b0c97a93d CHANGELOG.md: Add entry for PR #404
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-25 20:05:30 -05:00
Andrew Gunnerson 2d4f08f48b Update dependencies
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-25 19:56:02 -05:00
Andrew Gunnerson a753304dff CHANGELOG.md: Add entry for PR #403
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-25 19:39:42 -05:00
Andrew Gunnerson 9480e2ffa4 cpio: Read and write entire header at once
Avoids doing 14 small reads per cpio entry.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-25 19:37:58 -05:00
Andrew Gunnerson 140d0ddd8b CHANGELOG.md: Add entry for PR #402
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-25 15:08:11 -05:00
Andrew Gunnerson e0b114cf71 Switch to upstream master branch of bzip2-rs
The only remaining fix from our fork has been merged. This can be
switched to a stable release after the next release.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-25 14:59:44 -05:00
Andrew Gunnerson 78449f686d CHANGELOG.md: Add entry for PR #401
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-25 14:54:51 -05:00
Andrew Gunnerson a2fb807803 Remove all uses of implicit error propagation
Implicit error propagation was originally used because it was convenient
and made it easy to just bubble up errors via the ? operator without
thinking. However, there have been too many situations where this
resulted in error messages that were completely useless in
troubleshooting the problem. "I/O error", even with a specific reason
attached, is useless where there are potentially hundreds of operations
where I/O can fail.

I no longer think implicit error propagation is a good idea, so this
commit removes every single use of #[from] in every custom error type.
There are now many more error variants, allowing more context to be
attached to the underlying errors.

Previously, it was easy to encounter error messages like:

    Caused by:
        0: Failed to patch payload: payload.bin
        1: Failed to patch boot images: boot, init_boot, vendor_boot
        2: Boot image error
        3: I/O error
        4: failed to fill whole buffer

This is a terrible error message because it doesn't mention which of the
3 boot images failed to parse, nor does it mention during which I/O
operation it encountered EOF. With this commit, this sort of information
is now included. For example, if the boot image happened to be truncated
in the middle of the ramdisk, the error message would now be:

    Caused by:
        0: Failed to patch payload: payload.bin
        1: Failed to patch boot images: boot, init_boot, vendor_boot
        2: Failed to load boot image: init_boot
        3: Failed to read boot image data: Boot::V3::ramdisk
        4: failed to fill whole buffer

Changes:

* Remove all uses of #[from] from thiserror-derived error types.
* Errors during parsing and serialization of RSA private keys, RSA
  public keys, and X509 certificates now include the file path.
* Removed unnecessary uses of BufReader and BufWriter when reading and
  writing RSA private keys, RSA public keys, and X509 certificates,
  since they need to be fully read into memory anyway.
* Use ReadFixedSizeExt instead of read_exact() where possible.
* Use &'static str instead of String in error fields where all possible
  values are known at compile-time to avoid unnecessary heap allocation.
* Use ok_or() instead of ok_or_else() to construct errors when the error
  variant uses known data and does not require heap allocation.
* Using DebugString instead of String in error variants that store a
  preformatted debug string.

While working on this commit, an unrelated bug was found and fixed:

* Fix vendor v4 boot images that were truncated within the padding
  following the bootconfig section being treated as valid.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-25 02:34:17 -05:00
Andrew Gunnerson 6de5cb783a CHANGELOG.md: Add entry for PR #398
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-11 22:09:03 -05:00
Andrew Gunnerson 12d6f7f78c util: Wrap std's range types instead of inventing our own
This makes the type potentially more useful outside of just our current
use case of just error messages. Ranges where the starting value is
exclusive are no longer supported, but weren't used anyway.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-11 21:56:13 -05:00
Andrew Gunnerson 3c0a77df21 CHANGELOG.md: Add entry for PR #397
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-11 21:28:20 -05:00
Andrew Gunnerson d1b6bce227 Update bzip2-rs to 0.5.0 and switch to Rust backend implementation
The bzip2-rs library now has a new maintainer (same folks that maintain
the sudo-rs project). Version 0.5.0 was recently released, which
includes some much needed bug fixes, but is missing one final one, so we
still need to keep our fork for now.

This commit also switches the backend implementation from the official C
implementation to a Rust implementation maintained by the bzip2-rs
folks. This leaves xz as the only C dependency remaining in avbroot.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-11 20:23:40 -05:00
Andrew Gunnerson 10e0748d18 CHANGELOG.md: Add entry for PR #395
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-11 03:58:28 -05:00
Andrew Gunnerson 9cf63c7036 Treat Magisk versions newer than latest as supporting all features
Previously, when patching with a Magisk version newer than the latest
supported version and using --ignore-magisk-warnings, the upper bound of
VER_PREINIT_DEVICE and VER_XZ_BACKUP would prevent those features from
being used. It makes more sense to assume that a newer version supports
all the same features as the latest supported version instead.

Issue: #393

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-11 03:53:11 -05:00
Andrew Gunnerson 291b3c887b CHANGELOG.md: Add entry for PR #394
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-11 00:01:39 -05:00
Andrew Gunnerson 5d7eb13fbc Fix crash when ignoring warning about missing preinit device
MagiskRootPatcher was previously assuming that there is a preinit device
value if the Magisk version requires it.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-10 23:58:36 -05:00
Andrew Gunnerson 05cd74719e Version 3.10.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-08 19:20:39 -05:00
Andrew Gunnerson 7e0d5584d9 CHANGELOG.md: Add entry for PR #392
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-08 19:01:08 -05:00
Andrew Gunnerson b351d47f28 Update dependencies and fix most pedantic clippy warnings
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-08 18:46:40 -05:00
Andrew Gunnerson 421b0a5207 CHANGELOG.md: Add entry for PR #391
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-08 17:14:21 -05:00
Andrew Gunnerson cad08a6a2f Add support for Magisk 28100
There is nothing new that breaks compatibility with avbroot.

Fixes: #389

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-08 02:21:05 -05:00
Andrew Gunnerson 0a32dfaec3 CHANGELOG.md: Add entry for PR #390
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-08 02:19:46 -05:00
Andrew Gunnerson b03b2ade6a Improve parser error messages
* Remove the ReadString trait and perform UTF-8 conversions explicitly.
  UTF-8 conversion errors are now individual errors instead of being
  hidden in an Io error.
* Add new IntOutOfBounds errors that include the actual field value and
  the range of values that are valid for the field. Integer casting also
  uses this error type where possible.
* Replace remaining uses of FieldOutOfBounds with IntOverflow, which is
  returned when checked arithmetic fails. For code simplicity, it does
  not store intermediate values.
* Replace ReadFieldError and WriteFieldError with the generic Io error
  to simplify the code. They were used inconsistently anyway.
* Use fully qualified field names in avb and bootimage error messages
  since the same name frequently appears in multiple structs.
* Replace InvalidFieldValue with more specific errors in bootimage.
* Replace all stringly-typed errors in lp and sparse with (very)
  specific errors.
* Fix the wording in a number of errors.
* Add new ReadFixedSizeExt trait for reading fixed size arrays and vecs
  from Read types.
* Remove some fallible casts from u32 to usize and from usize to u64.
  avbroot only supports 32-bit and 64-bit systems anyway.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-08 02:08:28 -05:00
Andrew Gunnerson c198646c7c Add documentation for Android 16's developer switch for 16K page size kernels
avbroot will not support patching these internal OTAs because it
requires modifying filesystems and creating incremental OTAs. However,
it should be possible to do this manually if someone really wants to try
out a 16K page size kernel.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-06 18:09:34 -05:00
Andrew Gunnerson d815a78e9a CHANGELOG.md: Add entry for PR #386
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 17:47:31 -05:00
Andrew Gunnerson 99c5800f96 Update dependencies and pin Github Actions actions to specific commits
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 17:42:35 -05:00
Andrew Gunnerson c801fbb069 CHANGELOG.md: Add entry for PR #385
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 17:37:54 -05:00
Andrew Gunnerson 0b250086a3 protobuf: Update update_metadata.proto from AOSP
Neither of the two new fields need any special handling in avbroot. This
just allows us to preserve the values from the original OTA.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 17:33:34 -05:00
Andrew Gunnerson f6c6c8ab40 CHANGELOG.md: Add entry for PR #384
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 17:27:38 -05:00
Andrew Gunnerson 5c353a5f42 Remove unused byteorder crate
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 17:04:57 -05:00
Andrew Gunnerson ad932ed445 sparse: Switch to read_from_io()/write_to_io()
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 17:04:44 -05:00
Andrew Gunnerson d04d5451dc stream: Remove unused padded string functions
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 17:04:30 -05:00
Andrew Gunnerson 1d5db9f731 bootimage: Switch to zerocopy
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 17:04:28 -05:00
Andrew Gunnerson 409b9298a5 avb: Switch to zerocopy
This commit also fixes a bug where avb::Header::release_string was
allowed to take the full 48-bytes, which was incorrect because libavb
expects the field to be NULL-terminated. This was not a problem in
practice because the release string is usually short and even if it
wasn't, the 80 reserved bytes that immediately follow it are all zeros.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 17:01:43 -05:00
Andrew Gunnerson 516238d907 hashtree: Switch to zerocopy
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 16:59:56 -05:00
Andrew Gunnerson 39d5fbf76d payload: Switch to zerocopy
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 16:58:35 -05:00
Andrew Gunnerson 20f5bdacc7 compression: Switch to zerocopy
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 16:58:08 -05:00
Andrew Gunnerson 5b8eefa867 fec: Switch to zerocopy
This commit also adds support for parsing FEC images with unknown extra
custom fields.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 16:57:55 -05:00
Andrew Gunnerson b2610fa0e9 Update zerocopy to 0.8.11
>=0.8.10 is needed for the new read_from_io()/write_to_io() helper
functions.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 16:57:39 -05:00
Andrew Gunnerson 8a5550a43c Add new traits for zero padding and unpadding strings
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-12-01 16:56:55 -05:00
Ivan Katrovsky e16f4c7fa7 README.ru.md: update translation
* https://github.com/chenxiaolong/avbroot/commit/10c425dedea262678fda3c0c097b82fdf4352f08
2024-11-13 17:54:14 +03:00
Andrew Gunnerson 983e6c40a5 Version 3.9.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-11 20:04:59 -05:00
Andrew Gunnerson 8729854727 CHANGELOG.md: Add entry for PR #377
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-11 19:55:44 -05:00
Andrew Gunnerson 0d1beb7734 Update dependencies
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-11 19:54:50 -05:00
Andrew Gunnerson 2cd0d69238 CHANGELOG.md: Add entry for PR #376
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-11 19:43:50 -05:00
Andrew Gunnerson c0e65264e5 sparse: Allow parsing files with unknown fields
The official AOSP implementation does, so we should too. This allows
unpacking Samsung's sparse images, which have an extra 4 bytes in both
the file header and chunk headers.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-11 19:41:27 -05:00
Andrew Gunnerson 37b15a2b6a CHANGELOG.md: Add entry for PR #374
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-08 17:38:56 -05:00
Andrew Gunnerson e4994fbe98 format/payload: Allow verifying signatures without an unpadded size
Older OTAs created before the payload metadata format supported EC
signatures will not have the `unpadded_signature_size` field set. In
this case, we'll just use the full length of `data`, which is what
update_engine also does.

Issue: #366

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-08 17:38:28 -05:00
Andrew Gunnerson cf1bacab30 CHANGELOG.md: Add entry for PR #373
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-08 17:27:24 -05:00
Andrew Gunnerson 4832121160 format/ota: Allow verifying OTAs without metadata.pb
While patched OTAs produced by avbroot always include the protobuf
version of the OTA metadata, the original OTA may not. Verifying those
with `avbroot ota verify` is a valid use case.

Issue: #366

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-08 17:25:00 -05:00
Andrew Gunnerson c614e61744 CHANGELOG.md: Add entry for PR #371
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-07 22:13:45 -05:00
Andrew Gunnerson 9ebce1666c Add option to skip verifying recovery's OTA cert too
Issue: #366

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-07 22:04:11 -05:00
Andrew Gunnerson fb34198ffc CHANGELOG.md: Add entry for PR #370
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-05 18:00:13 -05:00
Andrew Gunnerson 4a5eab4ba0 crypto: Fix minor clippy warning
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-05 17:59:26 -05:00
Andrew Gunnerson 1e1818ad8f CHANGELOG.md: Add entry for PR #369
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-05 17:58:59 -05:00
Andrew Gunnerson 3f25ad7c76 Add more context for avb::Header::set_algo_for_key() calls
Previously, it was not always obvious which key was problematic.

Issue: #366

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-05 17:53:01 -05:00
Andrew Gunnerson 37e28eb040 CHANGELOG.md: Add entry for PR #367
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-05 17:51:41 -05:00
Andrew Gunnerson ce87757fd1 patch/boot: Avoid loading boot images when there are no patchers
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-05 09:30:04 -05:00
Andrew Gunnerson 10c425dede Add option to skip inserting OTA cert into recovery image
Issue: #366

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-05 09:30:03 -05:00
Andrew Gunnerson 8a0d147993 CHANGELOG.md: Add entry for PR #368
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-04 18:54:23 -05:00
Andrew Gunnerson 062aa21485 Update dependencies
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-11-04 18:32:58 -05:00
Andrew Gunnerson 7ffeb5e5cb Version 3.8.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-10-13 22:25:18 -04:00
Andrew Gunnerson a9a1aa55e9 CHANGELOG.md: Add entry for PR #364
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-10-13 22:18:58 -04:00
Andrew Gunnerson 0ca2872111 Update dependencies
zerocopy 0.8 is the only dependency with breaking changes.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-10-13 22:16:59 -04:00
Andrew Gunnerson a403c26b54 CHANGELOG.md: Add entry for PR #363
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-10-13 21:36:47 -04:00
Andrew Gunnerson 4afa1d1ba6 cli/avb: Add subcommand for computing vbmeta digest
This computes the special SHA256 digest that is equal to the
ro.boot.vbmeta.digest property value on a real device.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-10-13 21:29:04 -04:00
Andrew Gunnerson 9f669bc53e Version 3.7.1
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-10-10 18:12:48 -04:00
Andrew Gunnerson fc89159f09 CHANGELOG.md: Add entry for PR #362
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-10-10 18:04:25 -04:00
Andrew Gunnerson 18f43a0e57 Add support for Magisk 28000
There is nothing new that isn't already supported.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-10-10 18:03:04 -04:00
Andrew Gunnerson af7262a0d2 cli/sparse: Fix clippy warning on non-Linux/Android builds
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-09-22 21:21:11 -04:00
Andrew Gunnerson 5a7885674e ci.yml: Use target name in Rust cache key
Otherwise, the x86_64-unknown-linux-gnu build running on Ubuntu 22.04
can use the cache from the aarch64-linux-android31 build that originally
ran on Ubuntu 24.04. This fails due to some cached components having
been compiled against a newer version of glibc.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-09-22 21:13:33 -04:00
Andrew Gunnerson c974ab5ec3 Use Rust conventional comment style for license headers
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-09-22 14:58:01 -04:00
Andrew Gunnerson 02ae9cd0e3 Version 3.7.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-09-21 18:42:42 -04:00
Andrew Gunnerson 9c92d32a80 CHANGELOG.md: Add entry for PR #357
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-09-21 18:42:19 -04:00
Andrew Gunnerson 296df25fb9 Ensure that PrepatchedImagePatcher runs before other patchers
On older devices, like the Pixel 4a, where `boot` is used for both
Android and recovery mode, the image will be patched by OtaCertPatcher
and PrepatchedImagePatcher. OtaCertPatcher was always set to run first,
so when PrepatchedImagePatcher used the user-supplied image as-is, prior
modifications got wiped out. This made is so users could no longer flash
further patched OTAs.

This is an unfortunate regression that was introduced in avbroot 2.0.0.
The e2e tests never caught this issue because the --prepatched test was
being fed the boot image previously patched by --magisk. That already
had valid certs so the result of OtaCertPatcher's modifications being
lost were not visible. This commit also fixes the e2e tests so that this
type of issue will be caught in the future.

Fixes: #356

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-09-21 18:17:46 -04:00
Andrew Gunnerson 352352b4d4 CHANGELOG.md: Add entry for PR #355
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-09-15 20:06:57 -04:00
Andrew Gunnerson e28ef42c0e Switch to passterm library for password prompts
This library behaves exactly the same as rpassword, but has zero
dependencies so we no longer need to pull in the ancient windows-sys
0.48.x libraries.

We still transitively depend on both windows-sys 0.52.x and 0.59.x
though.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-09-15 17:46:52 -04:00
Andrew Gunnerson 5775c86e5b CHANGELOG.md: Add entry for PR #354
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-09-15 16:19:31 -04:00
Andrew Gunnerson 3dc8e07c0f cli/payload: Allow inspecting delta payloads
The pack and unpack commands can never support delta payloads, but
there's no reason not to allow the repack and info commands to read
them.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-09-15 16:12:17 -04:00
Andrew Gunnerson 040dcd1a5c Return ExitCode from main
std::process::exit() calls the exit syscall, which doesn't run
destructors. It doesn't matter for avbroot, but better to use ExitCode
anyway.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-09-01 22:36:41 -04:00
Andrew Gunnerson 41a578975f CHANGELOG.md: Add entry for PR #347
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-09-01 02:23:05 -04:00
Andrew Gunnerson e9638d25b0 Add support for packing and unpacking Android sparse images
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>
2024-09-01 02:14:11 -04:00
Andrew Gunnerson e25080ddef Merge pull request #346 from bugreportion/patch-1
README.ru.md: update translation
2024-08-31 12:43:48 -04:00
Ivan Katrovsky 0e7d778cf5 README.ru.md: update translation
* https://github.com/chenxiaolong/avbroot/commit/8e52a9cf8c6f3bd6ea281d93364ac3cb9eddd806
* https://github.com/chenxiaolong/avbroot/commit/4a1dab40694b50cc4b914ff9bbfc869344afed9c
* https://github.com/chenxiaolong/avbroot/commit/24320d4fae309cd4f19a8ccff0ab923905d04e8f
* https://github.com/chenxiaolong/avbroot/commit/7113fb32efc9d1db5c76529d28317fcd3e42ebcb
* https://github.com/chenxiaolong/avbroot/commit/8ca1a289a8111da76ac0cc25ec64fdb2b051f643

Signed-off-by: Ivan Katrovsky <notbugreporter@proton.me>
2024-08-31 02:52:50 +03:00
Andrew Gunnerson 8ca1a289a8 README.md: Split setting ANDROID_PRODUCT_OUT env var to separate step
Also add examples for powershell and cmd instead of assuming bash
syntax.

Fixes: #340

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-30 19:12:56 -04:00
Andrew Gunnerson dfbc2f807f CHANGELOG.md: Add entry for PR #343
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-28 18:37:45 -04:00
Andrew Gunnerson e55cf3d679 lp: Sparse files are not required when packing and unpacking empty images
Empty images don't contain any extent metadata so the partition sizes
are just discarded.

Don't write parsers when you're tired, folks!

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-28 18:30:57 -04:00
Andrew Gunnerson 7c38c5609b CHANGELOG.md: Add entry for PR #342
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-27 23:57:59 -04:00
Andrew Gunnerson 13c910274e Add support for packing and unpacking logical partition images
This supports both empty and normal LP images, including those that span
multiple files/devices.

Currently, repacked files are semantically equivalent, but not exactly
identical. avbroot's data structure for the metadata does not preserve
the arbitrary partition ordering of the LP image. Instead, to make the
API a bit nicer, it only preserves the relative partition ordering
within partition groups.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-27 23:32:29 -04:00
Andrew Gunnerson dd40f64918 CHANGELOG.md: Add entry for PR #337
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-20 21:37:57 -04:00
Andrew Gunnerson 7113fb32ef Add support for outputting zip files with no data descriptors
This commit adds a new `--zip-mode` parameter to `avbroot ota patch` to
control whether the patched OTA zip is written with data descriptors or
not. By default, the `streaming` mode is used, which matches the current
behavior where the zip is hashed for signing as it is being written. The
new `seekable` mode fully writes the zip before rereading it to hash the
contents.

The new mode is useful for devices with broken zip parsers that fail to
properly handle data descriptors.

All of the end-to-end tests have been duplicated to test both modes.

Adding the seekable mode necessitated a couple other changes:

* BufWriter is no longer used. Type erasure is very painful in Rust, so
  we need to keep the writer types the same for both the streaming and
  seekable modes. BufWriter is unusable in the seekable mode because we
  need to be able to read back what was written, which isn't supported.

* HolePunchingWriter has been removed. It was a simple way to produce
  sparse files by seeking whenever a write buffer consists fully of
  zeros. When combined with BufWriter, there was previously never a
  situation where this was undesirable. However, with the new seekable
  mode and the zip library's pattern of writing one field at a time, the
  final 2 zero bytes (representing an empty archive comment) is never
  written and the file size is not increased either.

  Removing this is not a big deal since we no longer use stripped OTAs
  for the end-to-end tests. Those were really the only OTAs that
  benefitted from sparse files. A real OTA has very few zero bytes due
  to compression.

Issue: #328

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-20 21:31:33 -04:00
Andrew Gunnerson 9c9d656ea2 CHANGELOG.md: Add entry for PR #336
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-19 15:03:26 -04:00
Andrew Gunnerson e06674a7f0 Print a useful error message when there's no TTY for a password prompt
ENXIO (No such device or address) and ENOTTY (Inappropriate ioctl for
device) are not very user-friendly error messages.

Issue: https://github.com/chenxiaolong/my-avbroot-setup/issues/2

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-19 14:57:46 -04:00
Andrew Gunnerson cf5ef13e47 Version 3.6.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-19 00:03:38 -04:00
Andrew Gunnerson 5fada419cb CHANGELOG.md: Add entry for PR #335
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-19 00:03:05 -04:00
Andrew Gunnerson eeea9f41b4 cli/args: Use tracing::Level directly
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-18 23:58:11 -04:00
Andrew Gunnerson 0bebf120c6 CHANGELOG.md: Add entry for PR #334
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-18 23:57:40 -04:00
Andrew Gunnerson 264c602fdb cli/ota: Remove unnecessary mutex
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-18 23:49:41 -04:00
Andrew Gunnerson 343e2e279c CHANGELOG.md: Add entry for PR #333
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-18 23:44:45 -04:00
Andrew Gunnerson 59ca759262 Add support for gzip VABC algorithm
Older devices, like the Pixel 4a 5G (bramble) use gzip instead of lz4.

This commit also reworks the CoW size estimate calculation to add the
same constant headroom that AOSP's delta_generator adds. Previously,
avbroot was already adding an additional 1% to account for differences
in compression ratios across compression library implementations. This
papered over the issue for large partitions, but small partitions could
still have a CoW size estimate that's too small. Adding the constant
headroom prevents ENOSPC when flashing those partitions.

Fixes: #332

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-18 23:33:43 -04:00
Andrew Gunnerson 83ab475c11 Version 3.5.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-15 20:45:04 -04:00
Andrew Gunnerson fe54640029 CHANGELOG.md: Add entry for PR #331
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-15 20:44:32 -04:00
Andrew Gunnerson fec1840a5f Add subcommands for packing and unpacking payload binaries
Some devices have "full" OTAs where the payload is missing the recovery
partition. These subcommands make it possible to manually add back the
missing image. Given the strict requirements for how the OTA zip is laid
out and signed, users can't just replace payload.bin in a zip and call
it a day, but it's sufficient for feeding a modified input to
`avbroot ota patch`.

Issue: #328

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-15 20:38:52 -04:00
Andrew Gunnerson 395f6934ff CHANGELOG.md: Add entry for PR #329
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-14 22:07:47 -04:00
Andrew Gunnerson a83b2fbfa9 Update dependencies
prost and protox have breaking changes, but none that affect avbroot.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-08-14 21:06:21 -04:00
Andrew Gunnerson e18ef20e4d Version 3.4.1
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-07-28 18:04:20 -04:00
Andrew Gunnerson b140620ed3 CHANGELOG.md: Add entry for PR #323
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-07-28 18:03:16 -04:00
Andrew Gunnerson dd9d8959fd Add support for Magisk 27006
Version 27006 now requires init-ld to be included in the ramdisk.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-07-28 17:58:13 -04:00
Andrew Gunnerson 9a7cece973 CHANGELOG.md: Add entry for PR #321
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-07-15 21:44:29 -04:00
Andrew Gunnerson aac3aded78 Update all dependencies
Version 1.6.0 of the bytes library was yanked. There's no vulnerability
that impacts avbroot, but it was tripping the cargo-deny checks.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-07-15 21:32:14 -04:00
Andrew Gunnerson 24320d4fae README.md: Move signature verification instructions to shared repo
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-07-14 18:23:55 -04:00
Ivan Katrovsky 6800ae073e README.ru.md: update translation
Sync with https://github.com/chenxiaolong/avbroot/commit/4d90ee2ac6223ec9e4ca1b1b77d84973ad90cd75

Signed-off-by: Ivan Katrovsky <notbugreporter@proton.me>
2024-07-06 02:37:41 -04:00
Andrew Gunnerson 4d90ee2ac6 README.md: Document that uninstalling Magisk will also flash an unsigned boot image
Closes: #318

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-07-05 19:45:27 -04:00
Ivan Katrovsky 6b087c0844 README.ru.md: update translation
Sync with https://github.com/chenxiaolong/avbroot/commit/d384a8a99bda591a6299f8f76f693eeb1725cb0f

Signed-off-by: Ivan Katrovsky <notbugreporter@proton.me>
2024-07-05 15:46:26 +03:00
Andrew Gunnerson d384a8a99b README.md: Document that fastboot >=34 is required
Older versions of fastboot have bugs that cause the reboot to fastbootd
mode to be skipped, causing failures when flashing dynamic partitions.

Fixes: #314

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-07-04 16:20:22 -04:00
Andrew Gunnerson bc358c62af Version 3.4.0
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-06-26 19:52:44 -04:00
Andrew Gunnerson fc05cb901a CHANGELOG.md: Add entry for PR #312
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-06-26 19:52:11 -04:00
Andrew Gunnerson 031ac8aa31 cli/avb: Add --public-key option for extract-avb subcommand
Issue: #312

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-06-26 19:46:24 -04:00
Andrew Gunnerson 4a1dab4069 Add support for signing with an external program
By default, the helper program is invoked in a way that is compatible
with avbtool's --signing_helper. However, the arguments have been
extended slightly to allow passing in the passphrase file or environment
variable for non-interactive use.

Fixes: #310

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-06-26 19:46:22 -04:00
Andrew Gunnerson bf885e40cf CHANGELOG.md: Add entry for PR #311
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-06-24 18:15:49 -04:00
Andrew Gunnerson c2a441cf78 avb: AlgorithmType: Fail on unknown key types
This is never reachable due to additional checks in every code path that
invokes sign() and verify(), but still better to be correct.

Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
2024-06-24 17:54:50 -04:00
74 changed files with 15300 additions and 4790 deletions
+13 -10
View File
@@ -18,6 +18,8 @@ jobs:
CARGO_TERM_COLOR: always
# https://github.com/rust-lang/rust/issues/78210
RUSTFLAGS: -C strip=symbols -C target-feature=+crt-static
# https://github.com/rust-lang/cargo/pull/15462
RUSTDOCFLAGS: -C target-feature=+crt-static
TARGETS: ${{ join(matrix.artifact.targets, ' ') || matrix.artifact.name }}
ANDROID_API: ${{ matrix.artifact.android_api }}
strategy:
@@ -34,15 +36,14 @@ jobs:
- aarch64-apple-darwin
- x86_64-apple-darwin
combine: lipo
# ubuntu-latest is not 24.04 yet and 22.04's qemu-user-static segfaults.
- os: ubuntu-24.04
- os: ubuntu-latest
name: aarch64-linux-android31
targets:
- aarch64-linux-android
android_api: '31'
steps:
- name: Check out repository
uses: actions/checkout@v4
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
# For git describe
fetch-depth: 0
@@ -65,7 +66,7 @@ jobs:
run: |
cargo install \
--git https://github.com/chenxiaolong/cargo-android \
--tag v0.1.1
--tag v0.1.3
- name: Get version
id: get_version
@@ -84,14 +85,16 @@ jobs:
done
- name: Cache Rust dependencies
uses: Swatinem/rust-cache@v2
uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1
with:
key: ${{ matrix.artifact.name }}
- name: Clippy
shell: bash
run: |
for target in ${TARGETS}; do
cargo android \
clippy --release --workspace --features static \
clippy --release --workspace \
--target "${target}"
done
@@ -100,7 +103,7 @@ jobs:
run: |
for target in ${TARGETS}; do
cargo android \
build --release --workspace --features static \
build --release --workspace \
--target "${target}"
done
@@ -109,7 +112,7 @@ jobs:
run: |
for target in ${TARGETS}; do
cargo android \
test --release --workspace --features static \
test --release --workspace \
--target "${target}"
done
@@ -118,7 +121,7 @@ jobs:
run: |
for target in ${TARGETS}; do
cargo android \
run --release -p e2e --features static \
run --release -p e2e \
--target "${target}" \
-- test -a -c e2e/e2e.toml
done
@@ -153,7 +156,7 @@ jobs:
run: cp LICENSE README.md target/output/
- name: Archive executable
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
name: avbroot-${{ steps.get_version.outputs.version }}-${{ matrix.artifact.name }}
path: |
+2 -3
View File
@@ -1,4 +1,3 @@
---
name: cargo-deny
on:
push:
@@ -11,7 +10,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Run cargo-deny
uses: EmbarkStudios/cargo-deny-action@v1
uses: EmbarkStudios/cargo-deny-action@f2ba7abc2abebaf185c833c3961145a3c275caad # v2.0.13
+2 -3
View File
@@ -1,4 +1,3 @@
---
name: Github Release
on:
push:
@@ -25,10 +24,10 @@ jobs:
echo "version=${version}" >> "${GITHUB_OUTPUT}"
- name: Check out repository
uses: actions/checkout@v4
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Create release
uses: softprops/action-gh-release@v2
uses: softprops/action-gh-release@6cbd405e2c4e67a21c47fa9e383d020e4e28b836 # v2.3.3
with:
tag_name: v${{ steps.get_version.outputs.version }}
name: Version ${{ steps.get_version.outputs.version }}
+312
View File
@@ -7,6 +7,194 @@
to update the actual links at the bottom of the file.
-->
### Version 3.23.0
* Update dependencies and fix Rust 1.90 clippy lints ([PR #517], [PR #520])
* Add support for Magisk 30300 ([PR #519])
### Version 3.22.0
* Fix CoW size estimates not being set when running `avbroot payload pack` ([PR #509])
* Add support for only unpacking metadata in `avbroot {avb,boot,cpio,lp,payload} unpack` ([PR #510])
* Specify minimum supported compiler version for building from source ([PR #511])
* Update dependencies ([PR #512])
### Version 3.21.0
* Switch to using rawzip for zip parsing and writing ([PR #489])
* Various code improvements ([PR #492], [PR #495], [PR #496], [PR #497], [PR #499], [PR #500], [PR #501], [PR #502], [PR #503], [PR #505])
* Update dependencies ([PR #498])
* Fix patching older OTAs with payloads using CoW v2 without the compression factor field ([Issue #493], [PR #504])
### Version 3.20.0
* Switch to using lzma-rust2 for XZ compression and decompression ([PR #483])
* Remove cap-std and cap-tempfile dependencies ([PR #484])
* Add new `avbroot avb verify-device` command to verify the signatures on the actual device ([Issue #482], [PR #485], [PR #486])
* This is only available in the Android build of avbroot.
* Update dependencies and fix new Rust 1.89 clippy lints ([PR #487])
### Version 3.19.0
* Allow verifying hashes of unsigned images with `avbroot avb verify` ([PR #477])
* Warn when verifying image containing insecure flags field with `avbroot avb verify` ([PR #478])
* Force re-signing of signed images in `avbroot avb pack` when fields were changed externally ([PR #479])
### Version 3.18.1
* Fix output file corruption in `avbroot sparse unpack` when unpacking a sparse file with holes larger than 2^32 ([Issue #472], [PR #476])
### Version 3.18.0
* Make OTA metadata property file field validation more lenient ([Issue #469], [PR #470])
* Fixes `avbroot ota verify` for stock OTAs that include extra zip file entries in the metadata
* Remove automatic promotion of insecure SHA-1 AVB hash algorithm to SHA-256 ([Issue #366], [Issue #469], [PR #473])
* There are insecure devices that don't support SHA-256 and won't boot with it.
* The original feature was a bandaid for OnePlus devices to make them a tiny bit more secure. They used SHA-256 for every partition except `system`. However, OnePlus no longer supports custom AVB keys anyway, so this feature is going away.
* Add support for Magisk 30200 ([PR #474])
* Update dependencies ([PR #475])
### Version 3.17.2
* Add support for Magisk 30100 ([PR #468])
### Version 3.17.1
* Update end-to-end tests to place streaming and seekable OTAs in separate directories for easier troubleshooting ([PR #463])
* Update dependencies ([PR #464])
* Add support for Magisk 30000 ([PR #467])
### Version 3.17.0
* Fix reserved space error when patching OTA zips larger than ~10 GB ([Issue #451], [PR #452])
* Update dependencies ([PR #453])
### Version 3.16.1
* Add support for Magisk 29000 ([PR #448])
* Update dependencies ([PR #449])
### Version 3.16.0
* Add support for CoW version 3 for virtual A/B ([Issue #441], [PR #442], [PR #445])
* This was recently introduced with the Pixel 9a. Previous devices all used CoW version 2.
* Add support for uncompressed CoW for virtual A/B ([PR #443])
* This is not used on actual devices, but is very useful for testing the CoW estimation logic.
* All differences between avbroot's and AOSP delta_generator's estimation logic are now fixed.
* Add support for custom CoW compression levels for virtual A/B ([PR #444])
* This is also not used on actual devices, but is supported by AOSP, so avbroot should support it too.
* Update dependencies ([PR #446])
### Version 3.15.0
* Add support for changing the virtual A/B compression algorithm ([PR #437])
* For devices that launched with Android <14, `--vabc-algo lz4` can significantly increase OTA installation speed when using a custom OTA updater app (with caveats). There is no difference when sideloading from recovery mode.
* See [the documentation](./README.md#changing-virtual-ab-cow-compression-algorithm) for more details.
* Switch back to the ring library now that it is maintained again ([PR #438])
* Update dependencies ([PR #439])
### Version 3.14.0
* Report as many errors as possible before failing in `avbroot ota verify` and improve error messages ([Discussion #426], [PR #428], [PR #430])
* Fix new clippy warnings introduced in Rust 1.85 ([PR #429])
* Fix massive performance regression introduced in 3.13.0 for OTAs that use gzip for virtual A/B CoW compression ([Issue #433], [PR #434])
* Update dependencies ([PR #435])
### Version 3.13.0
* Fix parsing Samsung `super.img` files in `avbroot lp` due to Samsung putting their own data structures in a region that's supposed to be filled with zeros ([PR #415])
* Add advanced option to skip replacing the OTA certificate in the system image ([Discussion #417], [PR #418])
* Switch to stable bzip2-rs release and use zlib-rs as the backend for flate2 ([PR #421])
* Switch to the aws-lc cryptography library for SHA1 and SHA2 hashing ([PR #422])
* The ring library is no longer maintained
* Fix incorrect `Partitions aren't protected by AVB: system` warning when using `--skip-system-ota-cert` ([PR #423])
* Discard unneeded temp file sooner when using `--skip-system-ota-cert` ([PR #424])
* Make `avbroot lp`'s parser less strict so that it can load on-device `super` partitions ([PR #425])
* The on-disk layout on virtual A/B devices violates some requirements stated in AOSP's documentation
* Update dependencies ([PR #427])
### Version 3.12.0
* Add new `-p <name>` option to `avbroot ota extract` for extracting specific partitions ([PR #408])
* Deprecate the `--boot-only` option in `avbroot ota extract` ([PR #408])
* The option will remain indefinitely for backwards compatibility, but is hidden from `--help`
* Add support for extracting the embedded OTA certificate and AVB public key in `avbroot ota extract` ([PR #409])
* Rename `avbroot key extract-avb` to `avbroot key encode-avb` for consistency with `avbroot key decode-avb` ([PR #410])
* The old syntax will remain supported indefinitely for backwards compatibility, but is hidden from `--help`
* Update dependencies ([PR #411])
### Version 3.11.0
* Fix crash when ignoring warning about `--magisk-preinit-device` not being specified ([PR #394])
* When using `--ignore-magisk-warnings`, assume that unsupported Magisk versions newer than the latest supported version are capable of all features ([Issue #393], [PR #395])
* Update bzip2-rs and switch to the Rust backend ([PR #397], [PR #402])
* Minor code cleanup for custom integer range type ([PR #398])
* Improve errors to make them less ambiguous about what went wrong ([PR #401])
* Fix bug where a vendor v4 boot image that was truncated in the bootconfig padding section would be accepted as valid ([PR #401])
* Avoid performing many small I/O operations when reading and writing cpio archives ([PR #403])
* Update dependencies ([PR #404])
### Version 3.10.0
* Switch to using zerocopy library for all binary file format parsers ([PR #384])
* Update to latest AOSP protobuf schema for the `payload.bin` metadata file format ([PR #385])
* Update dependencies and pin Github Actions actions to specific commits ([PR #386], [PR #392])
* Improve error messages from file format parsers ([PR #390])
* Add support for Magisk 28100 ([PR #391])
### Version 3.9.0
* Update all dependencies ([PR #368], [PR #377])
* Add advanced option to skip replacing the OTA certificate in the recovery image ([Issue #366], [PR #367], [PR #371])
* Improve error message when an incompatible RSA key is used for AVB signing ([Issue #366], [PR #369])
* Fix clippy warnings ([PR #370])
* Allow `avbroot ota verify` to verify OTAs that lack `META-INF/com/android/metadata.pb` ([Issue #366], [PR #373])
* Allow `avbroot ota verify` to verify OTAs where the payload signature does not set `unpadded_signature_size` ([Issue #366], [PR #374])
* Allow `avbroot sparse` to parse sparse images with unknown fields (matches AOSP implementation) ([PR #376])
### Version 3.8.0
* Add `avbroot avb digest` subcommand for computing the special vbmeta digest ([PR #363])
* Update all dependencies ([PR #364])
### Version 3.7.1
* Add support for Magisk 28000 ([PR #362])
### Version 3.7.0
* Fix a nasty regression since version 2.0.0 where recovery mode's `otacerts.zip` modifications were lost when using `--prepatched` with Magisk on some older devices, like the Pixel 4a ([Issue #356], [PR #357])
* This affected older devices without `vendor_boot` or `recovery` partitions.
* **This caused sideloading patched OTA updates from recovery mode to break on the affected devices.** To fix the problem without wiping the device and starting fresh, please follow the [steps in the PR](https://github.com/chenxiaolong/avbroot/pull/357#issuecomment-2365343050).
* Print a useful error message when trying to prompt for a passphrase without an interactive terminal ([PR #336])
* Add a new `--zip-mode seekable` option to allow writing OTA zip files without data descriptors ([Issue #328], [PR #337])
* Add new commands for packing and unpacking logical partition images (`super.img`) ([PR #342], [PR #343])
* Add new commands for packing and unpacking Android sparse images ([PR #347])
* Allow `avbroot payload repack` and `avbroot payload info` commands to read delta payloads ([PR #354])
* Switch to passterm library for password prompts ([PR #355])
### Version 3.6.0
* Add support for gzip compression when computing CoW size estimates ([Issue #332], [PR #333])
* This allows `--replace` to successfully replace dynamic partitions on legacy devices, like the Pixel 4a 5G
* Minor code cleanup ([PR #334], [PR #335])
### Version 3.5.0
* Update all dependencies ([PR #329])
* Add new unpack and pack commands for `payload.bin` files ([Issue #328], [PR #331])
### Version 3.4.1
* Update all dependencies ([PR #321])
* Add support for Magisk 27006 ([PR #323])
### Version 3.4.0
* Fix (unreachable) minor error handling logic when attempting to use unsupported AVB signing algorithms ([PR #311])
* Add support for performing signing operations with external programs ([Issue #310], [PR #312])
* See the linked issue for an example of how to sign with a Yubikey.
### Version 3.3.0
* Recompute CoW size estimate when replacing dynamic partitions ([Issue #306], [PR #307])
@@ -198,6 +386,8 @@ Behind-the-scenes changes:
[Discussion #235]: https://github.com/chenxiaolong/avbroot/discussions/235
[Discussion #286]: https://github.com/chenxiaolong/avbroot/discussions/286
[Discussion #294]: https://github.com/chenxiaolong/avbroot/discussions/294
[Discussion #417]: https://github.com/chenxiaolong/avbroot/discussions/417
[Discussion #426]: https://github.com/chenxiaolong/avbroot/discussions/426
[Issue #138]: https://github.com/chenxiaolong/avbroot/issues/138
[Issue #144]: https://github.com/chenxiaolong/avbroot/issues/144
[Issue #145]: https://github.com/chenxiaolong/avbroot/issues/145
@@ -218,6 +408,19 @@ Behind-the-scenes changes:
[Issue #291]: https://github.com/chenxiaolong/avbroot/issues/291
[Issue #301]: https://github.com/chenxiaolong/avbroot/issues/301
[Issue #306]: https://github.com/chenxiaolong/avbroot/issues/306
[Issue #310]: https://github.com/chenxiaolong/avbroot/issues/310
[Issue #328]: https://github.com/chenxiaolong/avbroot/issues/328
[Issue #332]: https://github.com/chenxiaolong/avbroot/issues/332
[Issue #356]: https://github.com/chenxiaolong/avbroot/issues/356
[Issue #366]: https://github.com/chenxiaolong/avbroot/issues/366
[Issue #393]: https://github.com/chenxiaolong/avbroot/issues/393
[Issue #433]: https://github.com/chenxiaolong/avbroot/issues/433
[Issue #441]: https://github.com/chenxiaolong/avbroot/issues/441
[Issue #451]: https://github.com/chenxiaolong/avbroot/issues/451
[Issue #469]: https://github.com/chenxiaolong/avbroot/issues/469
[Issue #472]: https://github.com/chenxiaolong/avbroot/issues/472
[Issue #482]: https://github.com/chenxiaolong/avbroot/issues/482
[Issue #493]: https://github.com/chenxiaolong/avbroot/issues/493
[PR #130]: https://github.com/chenxiaolong/avbroot/pull/130
[PR #132]: https://github.com/chenxiaolong/avbroot/pull/132
[PR #133]: https://github.com/chenxiaolong/avbroot/pull/133
@@ -309,3 +512,112 @@ Behind-the-scenes changes:
[PR #304]: https://github.com/chenxiaolong/avbroot/pull/304
[PR #307]: https://github.com/chenxiaolong/avbroot/pull/307
[PR #309]: https://github.com/chenxiaolong/avbroot/pull/309
[PR #311]: https://github.com/chenxiaolong/avbroot/pull/311
[PR #312]: https://github.com/chenxiaolong/avbroot/pull/312
[PR #321]: https://github.com/chenxiaolong/avbroot/pull/321
[PR #323]: https://github.com/chenxiaolong/avbroot/pull/323
[PR #329]: https://github.com/chenxiaolong/avbroot/pull/329
[PR #331]: https://github.com/chenxiaolong/avbroot/pull/331
[PR #333]: https://github.com/chenxiaolong/avbroot/pull/333
[PR #334]: https://github.com/chenxiaolong/avbroot/pull/334
[PR #335]: https://github.com/chenxiaolong/avbroot/pull/335
[PR #336]: https://github.com/chenxiaolong/avbroot/pull/336
[PR #337]: https://github.com/chenxiaolong/avbroot/pull/337
[PR #342]: https://github.com/chenxiaolong/avbroot/pull/342
[PR #343]: https://github.com/chenxiaolong/avbroot/pull/343
[PR #347]: https://github.com/chenxiaolong/avbroot/pull/347
[PR #354]: https://github.com/chenxiaolong/avbroot/pull/354
[PR #355]: https://github.com/chenxiaolong/avbroot/pull/355
[PR #357]: https://github.com/chenxiaolong/avbroot/pull/357
[PR #362]: https://github.com/chenxiaolong/avbroot/pull/362
[PR #363]: https://github.com/chenxiaolong/avbroot/pull/363
[PR #364]: https://github.com/chenxiaolong/avbroot/pull/364
[PR #367]: https://github.com/chenxiaolong/avbroot/pull/367
[PR #368]: https://github.com/chenxiaolong/avbroot/pull/368
[PR #369]: https://github.com/chenxiaolong/avbroot/pull/369
[PR #370]: https://github.com/chenxiaolong/avbroot/pull/370
[PR #371]: https://github.com/chenxiaolong/avbroot/pull/371
[PR #373]: https://github.com/chenxiaolong/avbroot/pull/373
[PR #374]: https://github.com/chenxiaolong/avbroot/pull/374
[PR #376]: https://github.com/chenxiaolong/avbroot/pull/376
[PR #377]: https://github.com/chenxiaolong/avbroot/pull/377
[PR #384]: https://github.com/chenxiaolong/avbroot/pull/384
[PR #385]: https://github.com/chenxiaolong/avbroot/pull/385
[PR #386]: https://github.com/chenxiaolong/avbroot/pull/386
[PR #390]: https://github.com/chenxiaolong/avbroot/pull/390
[PR #391]: https://github.com/chenxiaolong/avbroot/pull/391
[PR #392]: https://github.com/chenxiaolong/avbroot/pull/392
[PR #394]: https://github.com/chenxiaolong/avbroot/pull/394
[PR #395]: https://github.com/chenxiaolong/avbroot/pull/395
[PR #397]: https://github.com/chenxiaolong/avbroot/pull/397
[PR #398]: https://github.com/chenxiaolong/avbroot/pull/398
[PR #401]: https://github.com/chenxiaolong/avbroot/pull/401
[PR #402]: https://github.com/chenxiaolong/avbroot/pull/402
[PR #403]: https://github.com/chenxiaolong/avbroot/pull/403
[PR #404]: https://github.com/chenxiaolong/avbroot/pull/404
[PR #408]: https://github.com/chenxiaolong/avbroot/pull/408
[PR #409]: https://github.com/chenxiaolong/avbroot/pull/409
[PR #410]: https://github.com/chenxiaolong/avbroot/pull/410
[PR #411]: https://github.com/chenxiaolong/avbroot/pull/411
[PR #415]: https://github.com/chenxiaolong/avbroot/pull/415
[PR #418]: https://github.com/chenxiaolong/avbroot/pull/418
[PR #421]: https://github.com/chenxiaolong/avbroot/pull/421
[PR #422]: https://github.com/chenxiaolong/avbroot/pull/422
[PR #423]: https://github.com/chenxiaolong/avbroot/pull/423
[PR #424]: https://github.com/chenxiaolong/avbroot/pull/424
[PR #425]: https://github.com/chenxiaolong/avbroot/pull/425
[PR #427]: https://github.com/chenxiaolong/avbroot/pull/427
[PR #428]: https://github.com/chenxiaolong/avbroot/pull/428
[PR #429]: https://github.com/chenxiaolong/avbroot/pull/429
[PR #430]: https://github.com/chenxiaolong/avbroot/pull/430
[PR #434]: https://github.com/chenxiaolong/avbroot/pull/434
[PR #435]: https://github.com/chenxiaolong/avbroot/pull/435
[PR #437]: https://github.com/chenxiaolong/avbroot/pull/437
[PR #438]: https://github.com/chenxiaolong/avbroot/pull/438
[PR #439]: https://github.com/chenxiaolong/avbroot/pull/439
[PR #442]: https://github.com/chenxiaolong/avbroot/pull/442
[PR #443]: https://github.com/chenxiaolong/avbroot/pull/443
[PR #444]: https://github.com/chenxiaolong/avbroot/pull/444
[PR #445]: https://github.com/chenxiaolong/avbroot/pull/445
[PR #446]: https://github.com/chenxiaolong/avbroot/pull/446
[PR #448]: https://github.com/chenxiaolong/avbroot/pull/448
[PR #449]: https://github.com/chenxiaolong/avbroot/pull/449
[PR #452]: https://github.com/chenxiaolong/avbroot/pull/452
[PR #453]: https://github.com/chenxiaolong/avbroot/pull/453
[PR #463]: https://github.com/chenxiaolong/avbroot/pull/463
[PR #464]: https://github.com/chenxiaolong/avbroot/pull/464
[PR #467]: https://github.com/chenxiaolong/avbroot/pull/467
[PR #468]: https://github.com/chenxiaolong/avbroot/pull/468
[PR #470]: https://github.com/chenxiaolong/avbroot/pull/470
[PR #473]: https://github.com/chenxiaolong/avbroot/pull/473
[PR #474]: https://github.com/chenxiaolong/avbroot/pull/474
[PR #475]: https://github.com/chenxiaolong/avbroot/pull/475
[PR #476]: https://github.com/chenxiaolong/avbroot/pull/476
[PR #477]: https://github.com/chenxiaolong/avbroot/pull/477
[PR #478]: https://github.com/chenxiaolong/avbroot/pull/478
[PR #479]: https://github.com/chenxiaolong/avbroot/pull/479
[PR #483]: https://github.com/chenxiaolong/avbroot/pull/483
[PR #484]: https://github.com/chenxiaolong/avbroot/pull/484
[PR #485]: https://github.com/chenxiaolong/avbroot/pull/485
[PR #486]: https://github.com/chenxiaolong/avbroot/pull/486
[PR #487]: https://github.com/chenxiaolong/avbroot/pull/487
[PR #489]: https://github.com/chenxiaolong/avbroot/pull/489
[PR #492]: https://github.com/chenxiaolong/avbroot/pull/492
[PR #495]: https://github.com/chenxiaolong/avbroot/pull/495
[PR #496]: https://github.com/chenxiaolong/avbroot/pull/496
[PR #497]: https://github.com/chenxiaolong/avbroot/pull/497
[PR #498]: https://github.com/chenxiaolong/avbroot/pull/498
[PR #499]: https://github.com/chenxiaolong/avbroot/pull/499
[PR #500]: https://github.com/chenxiaolong/avbroot/pull/500
[PR #501]: https://github.com/chenxiaolong/avbroot/pull/501
[PR #502]: https://github.com/chenxiaolong/avbroot/pull/502
[PR #503]: https://github.com/chenxiaolong/avbroot/pull/503
[PR #504]: https://github.com/chenxiaolong/avbroot/pull/504
[PR #505]: https://github.com/chenxiaolong/avbroot/pull/505
[PR #509]: https://github.com/chenxiaolong/avbroot/pull/509
[PR #510]: https://github.com/chenxiaolong/avbroot/pull/510
[PR #511]: https://github.com/chenxiaolong/avbroot/pull/511
[PR #512]: https://github.com/chenxiaolong/avbroot/pull/512
[PR #517]: https://github.com/chenxiaolong/avbroot/pull/517
[PR #519]: https://github.com/chenxiaolong/avbroot/pull/519
[PR #520]: https://github.com/chenxiaolong/avbroot/pull/520
Generated
+664 -610
View File
File diff suppressed because it is too large Load Diff
+12 -2
View File
@@ -4,7 +4,17 @@ members = ["avbroot", "e2e", "fuzz", "xtask"]
resolver = "2"
[workspace.package]
version = "3.3.0"
version = "3.23.0"
license = "GPL-3.0-only"
edition = "2021"
edition = "2024"
repository = "https://github.com/chenxiaolong/avbroot"
publish = false
rust-version = "1.88.0"
[workspace.lints.clippy]
cast_lossless = "deny"
missing_fields_in_debug = "warn"
redundant_clone = "deny"
[workspace.lints.rust]
unexpected_cfgs = { level = "warn", check-cfg = ['cfg(fuzzing)'] }
+146 -3
View File
@@ -30,8 +30,6 @@ This subcommand packs a new AVB image from the `avb.toml` file and, for appended
* To force an image to be signed, use `--key <path> --force`.
* To force an image to be unsigned, use `--force` without specifying `--key`.
Note that if the image is an appended image and its hash or hash tree descriptor uses an insecure algorithm, like `sha1`, then it will automatically be promoted to `sha256`.
By default, for appended vbmeta images, the output image size will match the size of the original image that was unpacked. This size is specified by the `image_size` field in `avb.toml`. If the image is resizable (eg. `system`), then passing in `--recompute-size` will cause the `image_size` field to be ignored and the smallest possible output file that fits the raw image and AVB metadata will be built. This avoids wasting space if `raw.img` shrunk or allows the packing to work at all if `raw.img` grew. **Do not use this option for non-resizable images** (eg. `boot`) or else the device won't be able to boot.
When packing an image, several of the fields in `avb.toml` may potentially be recomputed. To write a TOML file containing the new values, use `--output-info <output TOML>`. It is safe to overwrite the existing `avb.toml` if desired.
@@ -60,12 +58,33 @@ This subcommand shows all of the vbmeta header and footer fields. `vbmeta` parti
avbroot avb verify -i <root vbmeta image> -p <public key>
```
This subcommand verifies the vbmeta header signature and the hashes for all vbmeta descriptors (including hash tree descriptors). If the vbmeta image has a chain descriptor for another partition, that partition image will be verified as well (recursively). All partitions are expected to be in the same directory as the vbmeta image being verified.
This subcommand verifies the vbmeta header signature and the hashes for all vbmeta descriptors (including hash tree descriptors). If the vbmeta image has a chain descriptor for another partition, that partition image will be verified as well (recursively). All images are expected to be in the same directory as the vbmeta image being verified. Missing images are ignored by default because the vbmeta images in some OTAs reference partitions that only exist on a real device. `--fail-if-missing` can be used to override this.
If `-p` is omitted, the signatures and hashes are checked only for validity, not that they are trusted.
By default, this command will not write to any file and fails if an image is corrupt or invalid. To attempt to repair corrupted dm-verity images, pass in `--repair`.
### Verifying AVB hashes and signatures on device
```bash
# Run from a root adb shell:
avbroot avb verify-device [-p <public key>]
```
This subcommand is like `avbroot avb verify`, except that it verifies the actual partitions on the device instead of a directory of image files. This is only available in the Android build of avbroot.
If `-p` is omitted, the signatures are verified against the public key SHA-256 digest reported by the bootloader. This is the same digest shown on screen every time the device boots.
### Computing vbmeta digest
```bash
avbroot avb digest -i <root vbmeta image>
```
This subcommand computes the vbmeta digest, which is defined as the SHA256 digest of the root vbmeta partition's header, followed by the chained partitions' headers (if any) in the order that they are listed. Chained partitions more than one level deep are ignored.
This digest is equal to the value of the `ro.boot.vbmeta.digest` property or the `RootOfTrust.verifiedBootHash` hardware attestation field.
## `avbroot boot`
### Unpacking a boot image
@@ -253,8 +272,88 @@ avbroot hash-tree verify -i <input data file> -H <input hash tree file>
This will check if the input file has any corrupted blocks. Currently, the command cannot report which specific blocks are corrupted, only whether the file is valid.
## `avbroot lp`
This set of commands is for working with LP (logical partition) images. These are the containers for dynamically-allocated partitions, like `system`. All LP images are supported:
* Empty images: These are the `super_empty.img` images in the factory images for newer Google Pixel devices. They define the layout of the `super` partition, but don't contain any actual data. They also do not contain a backup copy of the metadata. As an optimization, `fastboot` can fill in the actual data during flashing to avoid needing to reboot to fastbootd mode.
* Normal images backed by a single device: These are standalone `super.img` images and are how logical partitions are physically stored on disk in most newer devices. They contain a backup copy of all metadata as well as actual partition data.
* Normal images backed by multiple devices: These are images split across multiple files/partitions and are used on devices where support for LP was retrofitted. For example, the LP setup on newer Android builds for the Google Pixel 3a XL reuse the legacy `system` and `vendor` partitions because there is no `super` partition. These are similar to the single-file LP setups, except that data can be stored across all of the LP images. However, the metadata is only stored on the first LP image.
### Unpacking an LP image
```bash
avbroot lp unpack -i <input LP image> [-i <input LP image>]...
```
This subcommand unpacks the LP metadata to `lp.toml` and the partition images to the `lp_images` directory (for normal images).
If there are multiple images, they must be specified in order. If the order is not known, run `avbroot lp info` on each of the images. The one that successfully parses is the first image and the `block_devices` field in the output specifies the full ordering.
An LP image can have multiple slots. If the LP image originated from a factory image or OTA, all slots are likely identical. If the LP image was dumped from a real device that installed OTA updates in the past, the slots may differ. If the slots are not identical, then the `--slot` option is required to specify which slot to unpack.
### Packing an LP image
```bash
avbroot lp pack -o <output LP image> [-o <output LP image>]...
```
This subcommand packs a new LP image from the `lp.toml` file and `lp_images` directory (for normal images). Any `.img` files in the `lp_images` directory that don't have a corresponding entry in `lp.toml` are silently ignored.
All metadata slots in the newly packed LP image will be identical.
### Repacking an LP image
```bash
avbroot lp repack -i <input LP image> [-i <input LP image>]... -o <output LP image> [-o <output LP image>]...
```
This subcommand is logically equivalent to `avbroot lp unpack` followed by `avbroot lp pack`, except more efficient. Instead of unpacking and packing all partition images, the raw data is directly copied from the old LP image to the new LP image.
When `--slot` is specified, this is useful for discarding unwanted metadata slots and the partition data exclusive to them.
### Showing LP image metadata
```bash
avbroot lp info -i <first LP image>
```
This subcommand shows the LP image metadata, including all metadata slots. If there are multiple images, only the first one is needed because it is the only one that stores the metadata.
## `avbroot payload`
This set of commands is for working with payload binary files (`payload.bin`). The `unpack` and `pack` commands can only work with full payloads because they require the complete data to be available, but the `repack` and `info` commands also work with delta payloads.
### Unpacking a payload binary
```bash
avbroot payload unpack -i <input payload>
```
This subcommand unpacks the payload header information to `payload.toml` and the partition images to the `payload_images` directory.
Only full payload binaries can be unpacked. Delta payload binaries from incremental OTAs are not supported.
### Packing a payload binary
```bash
avbroot payload pack -o <output payload> --key <OTA private key>
```
This subcommand packs a new payload binary from the `payload.toml` file and `payload_images` directory. Any `.img` files in the `payload_images` directory that don't have a corresponding entry in `payload.toml` are silently ignored.
Packing a payload binary requires compressing all of the partition images, which is very CPU intensive. If re-signing an existing payload binary without making any other modifications is all that's needed, use the `repack` subcommand instead.
### Repacking a payload binary
```bash
avbroot payload repack -i <input payload> -o <output payload> --key <OTA private key>
```
This subcommand is logically equivalent to `avbroot payload unpack` followed by `avbroot payload pack`, except significantly more efficient. Instead of decompressing and recompressing all partition images, the raw data is directly copied from the input payload binary.
This is useful for re-signing a payload binary without making any other changes.
### Showing payload header information
```bash
@@ -262,3 +361,47 @@ avbroot payload info -i <payload>
```
This subcommand shows all of the payload header fields (which will likely be extremely long).
## `avbroot sparse`
This set of commands is for working with Android sparse images. All features of the file format are supported, including hole chunks and CRC32 checksums.
### Unpacking a sparse image
```bash
avbroot sparse unpack -o <input sparse image> -o <output raw image>
```
This subcommand unpacks a sparse image to a raw image. If the sparse image contains CRC32 checksums, they will be validated during unpacking. If the sparse image contains holes, the output image will be created as a native sparse file.
Certain fastboot factory images may have multiple sparse images, like `super_1.img`, `super_2.img`, etc., where they all touch a disjoint set of regions on the same partition. These can be unpacked by running this subcommand for each sparse image and specifying the `--preserve` option along with using the same output file. This preserves the existing data in the output file when unpacking each sparse image.
### Packing a sparse image
```bash
avbroot sparse pack -i <input raw image> -o <output sparse image>
```
This subcommand packs a new sparse image from a raw image. The default block size is 4096 bytes, which can be changed with the `--block-size` option.
By default, this will pack the entire input file. However, on Linux, there is an optimization where all holes in the input file, if it is a native sparse file, will be stored as hole chunks instead of `0`-filled chunks in the output sparse image.
To pack a partial sparse image, such as those used in the special fastboot factory images mentioned above, pass in `--region <start> <end>`. This option can be specified multiple times to pack multiple regions.
Unlike AOSP's `img2simg` tool, which never writes CRC32 checksums, this subcommand will write checksums if the input file has no holes and the entire file is being packed.
### Repacking a sparse image
```bash
avbroot sparse repack -i <input sparse image> -o <output sparse image>
```
This subcommand is logically equivalent to `avbroot sparse unpack` followed by `avbroot sparse pack`, except more efficient. This is useful for roundtrip testing of avbroot's sparse file parser.
### Showing sparse image metadata
```bash
avbroot sparse info -i <input sparse image>
```
This subcommand shows the sparse image metadata, including the header and all chunks.
+180 -46
View File
@@ -2,12 +2,10 @@
(This page is also available in: [Russian (Русский)](./README.ru.md).)
avbroot is a program for patching Android A/B-style OTA images for root access while preserving AVB (Android Verified Boot) using custom signing keys. It is compatible with both Magisk and KernelSU. If desired, it can also just re-sign an OTA without enabling root access.
avbroot is a tool for modifying Android A/B OTA images reproducibly and re-signing them with custom keys. It also includes a [collection of subcommands](./README.extra.md) for packing and unpacking numerous Android image formats.
Having a good understanding of how AVB and A/B OTAs work is recommended prior to using avbroot. At the very least, please make sure the [warnings and caveats](#warnings-and-caveats) are well-understood to avoid the risk of hard bricking.
**NOTE:** avbroot 2.0 has been rewritten in Rust and no longer relies on any AOSP code. The CLI is fully backwards compatible, but the old Python implementation can be found in the `python` branch if needed.
## Requirements
* Only devices that use modern A/B partitioning are supported. This is the case for most non-Samsung devices launched with Android 10 or newer. To check if a device uses this partitioning scheme, open the OTA zip file and check that:
@@ -23,7 +21,7 @@ Having a good understanding of how AVB and A/B OTAs work is recommended prior to
avbroot applies the following patches to the partition images:
* The `boot` or `init_boot` image, depending on device, is patched to enable root access. For Magisk, the patch is equivalent to what would be normally done by the Magisk app.
* The `boot` or `init_boot` image, depending on device, is patched to enable root access if requested.
* The `boot`, `recovery`, or `vendor_boot` image, depending on device, is patched to replace the OTA signature verification certificates with the custom OTA signing certificate. This allows future patched OTAs to be sideloaded from recovery mode after the bootloader has been locked. It also prevents accidental flashing of the original unpatched OTA.
@@ -31,11 +29,15 @@ avbroot applies the following patches to the partition images:
## Warnings and Caveats
* **Always leave the `OEM unlocking` checkbox enabled when using a locked bootloader with root.** This is critically important. Root access allows the boot partition to potentially be overwritten, either accidentally or intentionally, with an image that is not properly signed. In this scenario, if the checkbox is turned off, both the OS and recovery mode will be made unbootable and `fastboot flashing unlock` will not be allowed. This effectively renders the device **_hard bricked_**.
* **Always leave the `OEM unlocking` checkbox enabled when using a locked bootloader while rooted.** This is critically important. Root access allows the boot partition to potentially be overwritten, either accidentally or intentionally, with an image that is not properly signed. In this scenario, if the checkbox is turned off, both the OS and recovery mode will be made unbootable and `fastboot flashing unlock` will not be allowed. This effectively renders the device **_hard bricked_**.
Repeat: **_ALWAYS leave `OEM unlocking` enabled if rooted._**
* Any operation that causes an improperly-signed boot image to be flashed will result in the device being unbootable and unrecoverable without unlocking the bootloader again (and thus, triggering a data wipe). This includes the `Direct install` method for updating Magisk. Magisk updates **must** be done by repatching the OTA, not via the app.
* Any operation that causes an improperly-signed boot image to be flashed will result in the device being unbootable and unrecoverable without unlocking the bootloader again (and thus, triggering a data wipe). A couple ways an improperly-signed boot image could be flashed include:
* The `Direct install` method for updating Magisk. Magisk updates **must** be done by repatching the OTA, not via the app.
* The `Uninstall Magisk` feature in Magisk. If root access is no longer needed, Magisk **must** be removed by repatching the OTA with the `--rootless` option, not via the app.
If the boot image is ever modified, **do not reboot**. [Open an issue](https://github.com/chenxiaolong/avbroot/issues/new) for support and be very clear about what steps were done that lead to the situation. If Android is still running and root access works, it might be possible to recover without wiping and starting over.
@@ -49,6 +51,8 @@ avbroot applies the following patches to the partition images:
3. Follow the steps to [generate signing keys](#generating-keys).
Skip this step if you're updating Android, Magisk, or KernelSU after you've already performed an [initial setup](#initial-setup). There's no need to generate new signing keys for [updates](#updates): any further updates must use the keys that were created during the initial setup.
4. Patch the OTA zip. The base command is:
```bash
@@ -117,7 +121,7 @@ When patching OTAs for multiple devices, generating unique keys for each device
2. Convert the public key portion of the AVB signing key to the AVB public key metadata format. This is the format that the bootloader requires when setting the custom root of trust.
```bash
avbroot key extract-avb -k avb.key -o avb_pkmd.bin
avbroot key encode-avb -k avb.key -o avb_pkmd.bin
```
3. Generate a self-signed certificate for the OTA signing key. This is used by recovery to verify OTA updates when sideloading.
@@ -126,21 +130,27 @@ When patching OTAs for multiple devices, generating unique keys for each device
avbroot key generate-cert -k ota.key -o ota.crt
```
The commands above are provided for convenience. avbroot is compatible with any standard PKCS8-encoded 4096-bit RSA private key and PEM-encoded X509 certificate, like those generated by openssl.
The commands above are provided for convenience. avbroot is compatible with any standard PKCS#8-encoded 4096-bit RSA private key and PEM-encoded X509 certificate, like those generated by openssl.
If you lose your AVB or OTA signing key, you will no longer be able to sign new OTA zips. You will have to generate new signing keys and unlock your bootloader again (triggering a data wipe). Follow the [Usage section](#usage) as if doing an initial setup.
## Initial setup
1. Reboot into fastboot mode and unlock the bootloader if it isn't already unlocked. This will trigger a data wipe.
1. Make sure that the version of fastboot is 34 or newer. Older versions have bugs that prevent the `fastboot flashall` command (required later) from working properly.
```bash
fastboot --version
```
2. Reboot into fastboot mode and unlock the bootloader if it isn't already unlocked. This will trigger a data wipe.
```bash
fastboot flashing unlock
```
2. When setting things up for the first time, the device must already be running the correct OS. Flash the original unpatched OTA if needed.
3. When setting things up for the first time, the device must already be running the correct OS. Flash the original unpatched OTA if needed.
3. Extract the partition images from the patched OTA that are different from the original.
4. Extract the partition images from the patched OTA that are different from the original.
```bash
avbroot ota extract \
@@ -151,17 +161,37 @@ If you lose your AVB or OTA signing key, you will no longer be able to sign new
If you prefer to extract and flash all OS partitions just to be safe, pass in `--all`.
4. Flash the partition images that were extracted.
5. Set the `ANDROID_PRODUCT_OUT` environment variable to the directory containing the extracted files.
For sh/bash/zsh (Linux, macOS, WSL):
```bash
ANDROID_PRODUCT_OUT=extracted fastboot flashall --skip-reboot
export ANDROID_PRODUCT_OUT=extracted
```
For PowerShell (Windows):
```powershell
$env:ANDROID_PRODUCT_OUT = "extracted"
```
For cmd (Windows):
```bat
set ANDROID_PRODUCT_OUT=extracted
```
6. Flash the partition images that were extracted.
```bash
fastboot flashall --skip-reboot
```
Note that this only flashes the OS partitions. The bootloader and modem/radio partitions are left untouched due to fastboot limitations. If they are not already up to date or if unsure, after fastboot completes, follow the steps in the [updates section](#updates) to sideload the patched OTA once. Sideloading OTAs always ensures that all partitions are up to date.
Alternatively, for Pixel devices, running `flash-base.sh` from the factory image will also update the bootloader and modem.
5. Set up the custom AVB public key in the bootloader after rebooting from fastbootd to bootloader.
7. Set up the custom AVB public key in the bootloader after rebooting from fastbootd to bootloader.
```bash
fastboot reboot-bootloader
@@ -169,7 +199,7 @@ If you lose your AVB or OTA signing key, you will no longer be able to sign new
fastboot flash avb_custom_key /path/to/avb_pkmd.bin
```
6. **[Optional]** Before locking the bootloader, reboot into Android once to confirm that everything is properly signed.
8. **[Optional]** Before locking the bootloader, reboot into Android once to confirm that everything is properly signed.
Install the Magisk or KernelSU app and run the following command:
@@ -183,7 +213,9 @@ If you lose your AVB or OTA signing key, you will no longer be able to sign new
init: [libfs_avb]Returning avb_handle with status: Success
```
7. Reboot back into fastboot and lock the bootloader. This will trigger a data wipe again.
Alternatively, the Android build of avbroot can also be used to [verify the partitions on the device](./README.extra.md#verifying-avb-hashes-and-signatures-on-device).
9. Reboot back into fastboot and lock the bootloader. This will trigger a data wipe again.
```bash
fastboot flashing lock
@@ -195,21 +227,25 @@ If you lose your AVB or OTA signing key, you will no longer be able to sign new
**WARNING**: If you are flashing CalyxOS, the setup wizard will [automatically turn off the `OEM unlocking` switch](https://github.com/CalyxOS/platform_packages_apps_SetupWizard/blob/7d2df25cedcbff83ddb608e628f9d97b38259c26/src/org/lineageos/setupwizard/SetupWizardApp.java#L135-L140). Make sure to manually reenable it again from Android's developer settings. Consider using the [`OEMUnlockOnBoot` module](https://github.com/chenxiaolong/OEMUnlockOnBoot) to automatically ensure OEM unlocking is enabled on every boot.
8. That's it! To install future OS, Magisk, or KernelSU updates, see the [next section](#updates).
10. That's it! To update the OS, Magisk, or KernelSU see the [next section](#updates).
## Updates
Updates to Android, Magisk, and KernelSU are all done the same way by patching (or repatching) the OTA.
Updates to Android, Magisk, and KernelSU are all done the same way: by patching (or repatching) the OTA.
1. If Magisk or KernelSU is being updated, first install their new `.apk`. If you happen to open the app, make sure it **does not** flash the boot image. Cancel the boot image update prompts if needed.
1. Generate a new patched OTA by following the steps in the [usage section](#usage).
2. Follow the step in the [usage section](#usage) to patch the new OTA.
2. If Magisk or KernelSU is being updated, first install their new `.apk`. If you happen to open the app, make sure it **does not** flash the boot image. Cancel the boot image update prompts if needed.
3. Reboot to recovery mode. If the screen is stuck at a `No command` message, press the volume up button once while holding down the power button.
4. Sideload the patched OTA with `adb sideload`.
5. That's it!
5. Restart your device. Note that the device will likely take longer than usual to start on the first boot after an OS update (a few minutes in some cases).
**WARNING**: Due to how virtual A/B works, there is a snapshot merge operation that Android runs invisibly in the background after installing an OTA and rebooting. During the snapshot merge process, it's not possible to sideload another OTA from recovery mode. Avoid doing anything that could result in a boot loop (eg. installing modules) until this process is complete because there is no way to recover, aside from unlocking the bootloader (and wiping) again.
The status can be found by running `adb logcat -v color -s update_engine`. Alternatively, if [Custota](https://github.com/chenxiaolong/Custota) is installed (even if it's not configured to point to a custom OTA server), it will show a notification until the snapshot merge operation completes.
## Reverting to stock firmware
@@ -267,8 +303,7 @@ Magisk versions 25211 and newer require a writable partition for storing custom
```bash
avbroot ota extract \
--input /path/to/ota.zip \
--directory . \
--boot-only
--partition <name> # init_boot or boot, depending on device
```
2. Patch the boot image via the Magisk app. This **MUST** be done on the target device or a device of the same model! The partition name will be incorrect if patched from Magisk on a different device model.
@@ -355,6 +390,29 @@ Note that avbroot will validate that the prepatched image is compatible with the
avbroot can be used for just re-signing an OTA by specifying `--rootless` instead of `--magisk`/`--prepatched`. With this option, the patched OTA will not be rooted. The only modification applied is the replacement of the OTA verification certificate so that the OS can be upgraded with future (patched) OTAs.
### Skipping OTA certificate patches
avbroot can skip modifying `otacerts.zip` with the `--skip-system-ota-cert` and `--skip-recovery-ota-cert` options. **Do not use these unless you have a good reason to do so.**
When `--skip-system-ota-cert` is used, the OTA certificates in the `system` partition will not be modified. This prevents custom OTA updater apps from installing further patched OTAs while booted into Android.
When `--skip-recovery-ota-cert` is used, the OTA certificates in the `vendor_boot` or `recovery` partition will not be modified. **This prevents sideloading further patched OTAs from recovery mode.**
If `--skip-recovery-ota-cert` is used because the OTA certificate was already manually added to the boot image, then [verifying the patched OTA](#verifying-otas) afterwards is recommended to ensure that it was properly done. The verification process is only capable of checking the boot image's copy of the OTA certificates, not the system image's copy of them.
### Skipping all patches
To have avbroot make the absolute minimal changes:
* Specify `--skip-system-ota-cert`
* Specify `--skip-recovery-ota-cert`
* Specify `--rootless`
* Omit `--dsu`
This will re-sign the `vbmeta` partition and the OTA with the custom keys, but leave all other partitions untouched.
**This should only be used for advanced troubleshooting.** Without the OTA certificate patches, the resulting OTA will not be able to install further updates.
### Replacing partitions
avbroot supports replacing entire partitions in the OTA, even partitions that are not boot images (eg. `vendor_dlkm`). A partition can be replaced by passing in `--replace <partition name> /path/to/partition.img`.
@@ -379,6 +437,18 @@ Verified boot is disabled by vbmeta's header flags: 0x3
To forcibly enable AVB (by clearing the flags), pass in `--clear-vbmeta-flags`.
### Changing virtual A/B CoW compression algorithm
The virtual A/B CoW compression algorithm can be changed by passing in `--vabc-algo <algo>` with `gz` or `lz4`. OTAs normally use an algorithm that is compatible with the initial version of Android shipped on the device.
* Devices launching with Android 12 support `gz` and `brotli` (unsupported by avbroot)
* Devices launching with Android 14 support `lz4`
* Devices launching with Android 15 support `zstd` (unsupported by avbroot)
Picking a fast algorithm, like lz4, can speed up OTA installation significantly when installing via a custom OTA updater app. However, there is no performance difference when sideloading an OTA from recovery mode.
Note that the currently running version of Android must support the specified compression algorithm or else the OTA will fail to install. For example, trying to install an Android 14 OTA that uses lz4 CoW compression will fail if the running system is Android 13.
### Non-interactive use
avbroot prompts for the private key passphrases interactively by default. To run avbroot non-interactively, either:
@@ -415,17 +485,99 @@ avbroot prompts for the private key passphrases interactively by default. To run
* Use unencrypted private keys. This is strongly discouraged.
### Extracting the entire OTA
### Extracting an OTA
To extract all images contained within the OTA's `payload.bin`, run:
To extract the partition images contained within an OTA's `payload.bin`, run:
```bash
avbroot ota extract \
--input /path/to/ota.zip \
--directory extracted \
--all
--directory extracted
```
By default, this only extracts the images that could potentially be patched by avbroot. To extract all images, use the `--all` option. To extract specific images, use the `--partition <name>` option, which can be specified multiple times.
This command also supports extracting the embedded OTA certificate and AVB public key using the `--cert-ota` and `--public-key-avb` options. To extract only these components, pass in `--none` to skip extracting partition images.
### Zip write mode
By default, avbroot uses streaming writes for the output OTA during patching. This means it computes the sha256 digest for the digital signature as the file is being written. This mode causes the zip file to contain data descriptors, which is part of the zip standard and works on the vast majority of devices. However, some devices may have broken zip file parsers and fail to properly read OTA zip files containing data descriptors. If this is the case, pass in `--zip-mode seekable` when patching.
The seekable mode writes zip files without data descriptors, but as the name implies, requires seeking around the file instead of writing it sequentially. The sha256 digest for the digital signature is computed after the zip file has been fully written.
### Signing with an external program
avbroot supports delegating all RSA signing operations to an external program with the `--signing-helper` option. When using this option, the `--key-avb` and `--key-ota` options must be given a public key instead of a private key.
For each signing operation, avbroot will invoke the program with:
```bash
<helper> <algorithm> <public key>
```
The algorithm is one of `SHA{256,512}_RSA{2048,4096}` and the public key is what was passed to avbroot. The program can use the public key to find the corresponding private key (eg. on a hardware security module). avbroot will write a PKCS#1 v1.5 padded digest to `stdin` and the helper program is expected to perform a raw RSA signing operation and write the raw signature (octet string matching key size) to `stdout`.
By default, this behavior is compatible with the `--signing_helper` option in AOSP's avbtool. However, avbroot additionally extends the arguments to support non-interactive use. If `--pass-{avb,ota}-file` or `--pass-{avb,ota}-env-var` are used, then the helper program will be invoked with two additional arguments that point to the password file or environment variable.
```bash
<helper> <algorithm> <public key> file <pass file>
# or
<helper> <algorithm> <public key> env <env file>
```
Note that avbroot will verify the signature returned by helper program against the public key. This ensures that the patching process will fail appropriately if the wrong private key was used.
### 16K page size developer option
On recent devices running Android 16 and newer, there may be an option in Android's developer options to switch to a 16K page size kernel. This will not work when running an avbroot-patched OS. The switch internally works by flashing incremental OTAs:
* `/vendor/boot_otas/boot_ota_16k.zip` to switch to the 16K page size kernel (requires the `boot` partition to be currently flashed with the 4K kernel)
* `/vendor/boot_otas/boot_ota_4k.zip` to switch to the 4K page size kernel (requires the `boot` partition to be currently flashed with the 16K kernel)
These `boot_otas` are unflashable when running an avbroot-patched OS because the `payload.bin` inside of them are signed by the OEM's key. These are also not proper OTA files. They don't contain any OTA metadata and the zip file itself is not signed. It's nothing more than a plain old zip file that stores a signed `payload.bin`.
There are no plans to add support for patching these `boot_otas`. It requires support for modifying filesystems and handling incremental OTAs, both of which are very non-trivial.
Folks who are determined to make this work anyway can try these manual steps to sign these `boot_otas` with your own key. Since the incremental OTAs are not being regenerated, the `boot` partition must be left unmodified when running `avbroot ota patch`.
1. Unpack `vendor.img` with avbroot and [afsr](https://github.com/chenxiaolong/afsr).
```bash
avbroot avb unpack -i vendor.img
afsr unpack -i raw.img
```
2. Extract `payload.bin` from `boot_otas/boot_ota_16k.zip`.
3. Re-sign `payload.bin` with your OTA key.
```bash
avbroot payload repack \
-i payload.bin.orig \
-o payload.bin \
-k ota.key \
--output-properties payload_properties.txt
```
4. Create a new zip of `payload.bin` and `payload_properties.txt`. The files must be stored uncompressed (eg. with `zip -0`).
5. Repeat the procedure for `boot_otas/boot_ota_4k.zip`.
6. Repack `vendor.img` and sign it with your AVB key.
```bash
afsr pack -o raw.img
avbroot avb pack -o vendor.img -k avb.key --recompute-size
```
7. Patch the (normal) OTA with:
```bash
avbroot ota patch \
--replace vendor <modified vendor> \
<normal arguments...>
```
## Building from source
Make sure the [Rust toolchain](https://www.rust-lang.org/) is installed. Then run:
@@ -438,8 +590,6 @@ The output binary is written to `target/release/avbroot`.
Debug builds work too, but they will run significantly slower (in the sha256 computations) due to compiler optimizations being turned off.
By default, the executable links to the system's bzip2 and liblzma libraries, which are the only external libraries avbroot depends on. To compile and statically link these two libraries, pass in `--features static`.
### Android cross-compilation
To cross-compile for Android, install [cargo-android](https://github.com/chenxiaolong/cargo-android) and use the `cargo android` wrapper. To make a release build for aarch64, run:
@@ -452,23 +602,7 @@ It is possible to run the tests if the host is running Linux, qemu-user-static i
## Verifying digital signatures
First, save the public key to a file listing the keys to be trusted. This is the same key listed in [the author's profile](https://github.com/chenxiaolong/).
```bash
echo 'avbroot ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDOe6/tBnO7xZhAWXRj3ApUYgn+XZ0wnQiXM8B7tPgv4' > avbroot_trusted_keys
```
Then, verify the signature of the zip file using the list of trusted keys.
```bash
ssh-keygen -Y verify -f avbroot_trusted_keys -I avbroot -n file -s <file>.zip.sig < <file>.zip
```
If the file is successfully verified, the output will be:
```
Good "file" signature for avbroot with ED25519 key SHA256:Ct0HoRyrFLrnF9W+A/BKEiJmwx7yWkgaW/JvghKrboA
```
To verify the digital signatures of the downloads, follow [the steps here](https://github.com/chenxiaolong/chenxiaolong/blob/master/VERIFY_SSH_SIGNATURES.md).
## Contributing
+196 -54
View File
@@ -1,14 +1,12 @@
# avbroot
avbroot это программа для модификации OTA-образов Android A/B-формата с целью получения root-прав при сохранении прохождения AVB (Android Verified Boot) с использованием кастомных (пользовательских) ключей подписи. Она совместима как с Magisk, так и с KernelSU. При необходимости можно просто переподписать OTA, без получения root-доступа.
avbroot это утилита для воспроизводимой модификации OTA-образов Android A/B-формата и их переподписания пользовательскими ключами. Она также включает в себя [набор подкоманд](./README.extra.md) для упаковки и распаковки образов Android различных форматов.
Прежде чем использовать avbroot, рекомендуется иметь хорошее понимание того, как работают AVB и OTA в формате A/B. Как минимум, следует ознакомиться с [разделом предостережений,](#предостережения) чтобы избежать хардбрика устройства.
**ПРИМЕЧАНИЕ:** avbroot 2.0 была переписана на Rust и больше не имеет в основе никакого кода AOSP, а CLI полностью обратно совместим. Тем не менее, старую реализацию на Python можно найти в одноименной ветке `python`.
## Требования
* Поддерживаются только устройства, использующие современную A/B-разметку. Это большинство девайсов, выпускаемых с Android 10 и новее (за исключением устройств от Samsung). Чтобы проверить, использует ли ваш телефон необходимую схему разметки, откройте zip-архив OTA и проверьте:
* Поддерживаются только устройства, использующие современную A/B-разметку. Это большинство девайсов, выпускаемых с Android 10 и новее (за исключением устройств от Samsung). Чтобы проверить, использует ли ваше устройство необходимую схему разметки, откройте zip-архив OTA и проверьте:
* наличие файла `payload.bin` (обычно находится в корне архива)
* наличие файла `META-INF/com/android/metadata` (Android 10-11) или `META-INF/com/android/metadata.pb` (Android 12+)
@@ -21,7 +19,7 @@ avbroot – это программа для модификации OTA-обра
avbroot модифицирует следующие образы:
* `boot` или `init_boot`, в зависимости от устройства, модифицируется для получения root-доступа. В случае с Magisk, патч будет эквивалентен тому, что производится в самом приложении Magisk.
* `boot` или `init_boot`, в зависимости от устройства, модифицируется для получения root-доступа, если это запрашивается.
* `boot`, `recovery` или `vendor_boot`, в зависимости от устройства, модифицируется для замены сертификата проверки подписи OTA на пользовательский. Это позволяет устанавливать будущие пропатченные OTA через режим Recovery уже после блокировки загрузчика, то есть в качестве обновления. Также это предотвращает случайную установку оригинального непропатченного OTA.
@@ -33,13 +31,17 @@ avbroot модифицирует следующие образы:
Повторюсь: **_ВСЕГДА оставляйте `Заводскую разблокировку` включенной при наличии root-прав._**
* Любая операция, приводящая к прошивке некорректно подписанного загрузочного образа, приведет к тому, что устройство больше не сможет загрузиться в систему/режим Recovery, а для его восстановления потребуется повторная разблокировка загрузчика (и, следовательно, стирание всех пользовательских данных). Это же относится и к методу `Прямой установки` для обновления Magisk. Обновление Magisk **должно выполняться только путем обновления OTA,** а не через Magisk Manager.
* Любая операция, приводящая к прошивке некорректно подписанного загрузочного образа, приведет к тому, что устройство больше не сможет загрузиться в систему/режим Recovery, а для его восстановления потребуется повторная разблокировка загрузчика (и, следовательно, стирание всех пользовательских данных). К подобным операциям в том числе относятся:
* Метод `Прямой установки` для обновления Magisk. Magisk можно обновлять **только путем репатчинга OTA,** но не через его приложение.
* Функция `Удаление Magisk` в приложении Magisk. Если вам больше не нужен root-доступ, Magisk **должен быть удален путем репатчинга OTA** с использованием параметра `--rootless`, но не через его приложение.
Если в загрузочный раздел были внесены какие-либо изменения, **не перезагружайтесь**. Обратитесь за помощью, [открыв Issue,](https://github.com/chenxiaolong/avbroot/issues/new) и четко разъясните, какие конкретные действия привели к возникновению такой ситуации. Если Android всё еще работает и доступ к root-правам сохранился – вероятно, получится откатить изменения до исходного состояния, не стирая ваши данные.
## Использование
1. Убедитесь, что вы ознакомились и поняли указанные выше [предостережения.](#предостережения)
1. Убедитесь, что вы ознакомились и поняли указанные выше [предостережения.](#предостережения)
2. Скачайте последнюю версию со страницы [релизов.](https://github.com/chenxiaolong/avbroot/releases) Чтобы сверить цифровую подпись, см. раздел [проверки цифровых подписей.](#проверка-цифровых-подписей)
@@ -47,6 +49,8 @@ avbroot модифицирует следующие образы:
3. [Сгенерируйте ключи подписи.](#генерация-ключей)
Пропустите этот шаг, если вы обновляете Android, Magisk или KernelSU уже после выполнения [первоначальной настройки](#первоначальная-настройка). Повторная генерация ключей подписи для [обновлений](#обновления) не требуется: для всех последующих обновлений должны использоваться те ключи, что были созданы при первоначальной настройке.
4. Пропатчите ОТА-архив с помощью команды:
```bash
@@ -103,7 +107,7 @@ avbroot модифицирует следующие образы:
Первые два компонента подписываются ключом AVB, а последние два – ключом OTA. Можно использовать один и тот же ключ, однако в следующих шагах описано, как сгенерировать два отдельных.
Если вы патчите OTA сразу для нескольких устройств, настоятельно рекомендуется генерировать уникальные ключи для каждого девайса – так вы защитите себя от случайной прошивки неподходящего OTA для другого телефона.
Если вы патчите OTA сразу для нескольких устройств, настоятельно рекомендуется генерировать уникальные ключи для каждого девайса – так вы защитите себя от случайной прошивки неподходящего OTA.
1. Сгенерируйте ключи подписи для AVB и OTA.
@@ -115,30 +119,36 @@ avbroot модифицирует следующие образы:
2. Преобразуйте публичную часть ключа подписи AVB в формат метаданных публичного ключа AVB. Именно этот формат используется в загрузчике устройства для установки пользовательского ключа.
```bash
avbroot key extract-avb -k avb.key -o avb_pkmd.bin
avbroot key encode-avb -k avb.key -o avb_pkmd.bin
```
3. Сгенерируйте самоподписанный сертификат для ключа подписи OTA. Он используется режимом Recovery для проверки подписи OTA при сайдлоадинге обновления.
3. Сгенерируйте самоподписанный сертификат для ключа подписи OTA. Он используется режимом Recovery для проверки подписи OTA при установке обновления.
```bash
avbroot key generate-cert -k ota.key -o ota.crt
```
avbroot совместим с любым стандартным 4096-битным приватным ключом RSA в кодировке PKCS8 и сертификатом X509 в кодировке PEM, например с теми, которые генерируются openssl.
avbroot совместим с любым стандартным 4096-битным приватным ключом RSA в кодировке PKCS#8 и сертификатом X509 в кодировке PEM, например с теми, которые генерируются openssl.
Если вы потеряете ключ(-и) подписи AVB или OTA, вы больше не сможете подписывать новые OTA-архивы. Придется генерировать новые ключи подписи и разблокировать загрузчик (что приведет к стиранию всех данных). В таком случае возвращайтесь к инструкции в разделе [использования.](#использование)
## Первоначальная настройка
1. Перезагрузитесь в режим fastboot и разблокируйте загрузчик, если не сделали этого ранее. Это приведет к стиранию всех пользовательских данных.
1. Убедитесь, что вы используете утилиту fastboot версии 34 или новее. Предыдущие версии содержат баги, что не позволяют команде `fastboot flashall` (которая понадобится по ходу инструкции) работать правильно.
```bash
fastboot --version
```
2. Перезагрузитесь в режим fastboot и разблокируйте загрузчик, если не сделали этого ранее. Это приведет к стиранию всех пользовательских данных.
```bash
fastboot flashing unlock
```
2. Перед первой установкой, на устройстве уже должна быть установлена в оригинальном виде та прошивка, пропатченную версию которой вы собираетесь ставить. Если это не так, сначала установите оригинальную непропатченную OTA.
3. Перед первой установкой, на устройстве уже должна быть установлена в оригинальном виде та прошивка, пропатченную версию которой вы собираетесь ставить. Если это не так, сначала установите оригинальную непропатченную OTA.
3. Извлекаем из пропатченного OTA модифицированные образы:
4. Извлекаем из пропатченного OTA модифицированные образы:
```bash
avbroot ota extract \
@@ -149,17 +159,37 @@ avbroot совместим с любым стандартным 4096-битны
Если вы на всякий случай хотите прошить вообще все разделы из ОТА, извлечь их можно, указав аргумент `--all`.
4. Прошейте извлеченные образы разделов.
5. Установите переменную окружения `ANDROID_PRODUCT_OUT`, указав директорию с извлеченными файлами.
Для sh/bash/zsh (Linux, macOS, WSL):
```bash
ANDROID_PRODUCT_OUT=extracted fastboot flashall --skip-reboot
export ANDROID_PRODUCT_OUT=extracted
```
Обратите внимание, что так прошиваются лишь те образы, что относятся к системе. Разделы загрузчика и модема же остаются нетронутыми из-за ограничений fastboot. Если они не обновлены до необходимой версии, или вы не уверены в этом, после прошивки перейдите к пункту [обновлений](#обновления) и установите пропатченный OTA-архив сайдлоадом в режиме Recovery. Прошивка полного OTA гарантирует, что абсолютно все разделы будут обновлены.
Для PowerShell (Windows):
```powershell
$env:ANDROID_PRODUCT_OUT = "extracted"
```
Для cmd (Командная строка или Терминал) (Windows):
```bat
set ANDROID_PRODUCT_OUT=extracted
```
6. Прошейте извлеченные образы разделов.
```bash
fastboot flashall --skip-reboot
```
Обратите внимание, что так прошиваются лишь те образы, что относятся к системе. Разделы загрузчика и модема же остаются нетронутыми из-за ограничений fastboot. Если они не обновлены до необходимой версии, или вы не уверены в этом, после прошивки перейдите к пункту [обновлений](#обновления) и установите пропатченный OTA в режиме Recovery. Прошивка полного OTA гарантирует, что абсолютно все разделы будут обновлены.
Для устройств Pixel есть ещё один вариант: запуск скрипта `flash-base.sh` из папки заводских образов (factory images) обновит загрузчик и модем.
5. После перезагрузки из fastbootd в загрузчик (bootloader), установите пользовательский публичный ключ AVB в загрузчик:
7. После перезагрузки из fastbootd в загрузчик (bootloader), установите пользовательский публичный ключ AVB в загрузчик:
```bash
fastboot reboot-bootloader
@@ -167,7 +197,7 @@ avbroot совместим с любым стандартным 4096-битны
fastboot flash avb_custom_key /путь/к/avb_pkmd.bin
```
6. **[Опционально]** Перед блокировкой загрузчика загрузитесь в систему, дабы убедиться, что все подписано правильно.
8. **[Опционально]** Перед блокировкой загрузчика загрузитесь в систему, дабы убедиться, что все подписано правильно.
Установите приложение Magisk или KernelSU и выполните следующую команду:
@@ -181,7 +211,9 @@ avbroot совместим с любым стандартным 4096-битны
init: [libfs_avb]Returning avb_handle with status: Success
```
7. Перезагрузитесь в fastboot и заблокируйте загрузчик. Это снова приведет к стиранию данных.
Как ещё один вариант, Android-версию avbroot также можно использовать для [проверки разделов на устройстве](./README.extra.md#verifying-avb-hashes-and-signatures-on-device).
9. Перезагрузитесь в fastboot и заблокируйте загрузчик. Это снова приведет к стиранию данных.
```bash
fastboot flashing lock
@@ -193,21 +225,25 @@ avbroot совместим с любым стандартным 4096-битны
**ПРЕДУПРЕЖДЕНИЕ**: Если вы прошили CalyxOS, мастер настройки [автоматически отключит опцию `Заводской разблокировки`.](https://github.com/CalyxOS/platform_packages_apps_SetupWizard/blob/7d2df25cedcbff83ddb608e628f9d97b38259c26/src/org/lineageos/setupwizard/SetupWizardApp.java#L135-L140) Не забудьте снова включить её вручную в настройках для разработчиков. Для перестраховки можете использовать [модуль `OEMUnlockOnBoot`,](https://github.com/chenxiaolong/OEMUnlockOnBoot) который автоматически включает пункт Заводской разблокировки при каждом запуске системы.
8. Готово. Установка последующих обновлений системы, Magisk или KernelSU, описывается в [следующем разделе.](#обновления)
10. Готово! Установка последующих обновлений системы, Magisk или KernelSU, описывается в [следующем разделе.](#обновления)
## Обновления
Обновления Android, Magisk и KernelSU выполняются одинаково – исключительно путем обновления или репатчинга того же самого OTA.
1. Если Magisk или KernelSU обновились, сначала установите их новый `.apk`. Если вы случайно открыли приложение после обновления, убедитесь, что оно не начало прошивать загрузочный образ. Если появится предложение обновить сам загрузочный образ – отклоните его.
1. Сгенерируйте новый пропатченный OTA согласно инструкции в разделе [использования.](#использование)
2. Следуйте инструкции в разделе [использования,](#использование) чтобы пропатчить OTA уже с новым .apk Magisk'а/предварительно пропатченным образом с Magisk или KernelSU.
2. Если обновляется Magisk или KernelSU, сначала установите их новый `.apk`. Если вы случайно открыли приложение, убедитесь, что оно **не начало** прошивать загрузочный образ. Если в самом приложении появится предложение обновить загрузочный образ, отклоните его.
3. Перезагрузитесь в режим Recovery. Если устройство повисло на сплеше с сообщением "No command", удерживайте кнопку питания, а затем нажмите кнопку увеличения громкости один раз.
4. Обновитесь (Apply update from adb → `adb sideload <ota.zip.patched>`).
5. Готово!
5. Перезагрузите устройство. Обратите внимание, что при первом запуске после обновления ОС устройство может загружаться дольше обычного (иногда до нескольких минут).
**ПРЕДУПРЕЖДЕНИЕ**: В силу специфики работы виртуального A/B в Android, сразу после установки OTA и перезагрузки, в фоновом режиме незаметно запускается операция слияния снапшотов. Во время этого процесса невозможно установить другой OTA через режим Recovery. Пока продолжается слияние снапшотов, избегайте любых действий, которые могут привести к бутлупу (например, установка модулей), поскольку в случае сбоя восстановить устройство получится только повторно разблокировав загрузчик, стирая все данные.
Узнать текущий статус процесса можно, выполнив команду: `adb logcat -v color -s update_engine`. Дополнительно, если установлено [Custota](https://github.com/chenxiaolong/Custota) (даже если оно не настроено на использование пользовательского OTA-сервера), приложение будет отображать соответствующее уведомление до завершения операции слияния снапшота.
## Возврат на заводскую прошивку
@@ -225,11 +261,11 @@ avbroot совместим с любым стандартным 4096-битны
## OTA-обновления
avbroot заменяет `/system/etc/security/otacerts.zip` в разделах системы и Recovery на новый архив, содержащий пользовательский сертификат подписи OTA. Это предотвращает случайную установку непропатченных OTA как при загрузке в Android, так и при сайдлоадинге через Recovery.
avbroot заменяет `/system/etc/security/otacerts.zip` в разделах системы и Recovery на новый архив, содержащий пользовательский сертификат подписи OTA. Это предотвращает случайную установку непропатченных OTA как из-под загруженной системы, так и при прошивке через Recovery.
Рекомендуется отключить приложение обновлений системы, чтобы оно не пыталось установить непропатченные OTA:
Рекомендуется отключить системное приложение для обновлений, чтобы оно не пыталось установить непропатченные OTA:
* Стоковая прошивка: Отключите `Автоматические обновления системы` (Automatic system updates в англ.) в настройках для разработчиков.
* Стоковая (заводская) прошивка: Отключите `Автоматические обновления системы` (Automatic system updates в англ.) в настройках для разработчиков.
* Кастомная прошивка: Отключите приложение обновлений системы (или запретите ему доступ к Интернету) через Настройки -> Приложения -> Все приложения -> (меню/три точки) -> Показать системные -> (найдите приложение обновлений, например Обновления системы/Updater).
Это особенно важно для некоторых кастомных прошивок, поскольку их фирменное приложение для обновления системы может уйти в бесконечный цикл, загружая OTA-обновление, а затем повторяя попытку загрузки и установки при неудачной проверке подписи.
@@ -265,6 +301,7 @@ Magisk версии 25211 и новее требует наличие разде
--input /path/to/ota.zip \
--directory . \
--boot-only
--partition <название раздела> # init_boot или boot, в зависимости от устройства
```
2. Теперь нужно пропатчить загрузочный образ с помощью приложения Magisk. Это **ДОЛЖНО** быть сделано именно на целевом устройстве или устройстве той же модели! Имя раздела будет неверным и не подойдет, если пропатчить образ на устройстве иной модели.
@@ -286,7 +323,7 @@ Magisk версии 25211 и новее требует наличие разде
Теперь, когда имя раздела известно, его нужно указать avbroot с помощью команды `--magisk-preinit-device <имя>`. Имя раздела стоит запомнить или сохранить где-нибудь на будущее, оно вряд ли изменится при обновлении Magisk.
Если запустить приложение Magisk на целевом устройстве невозможно (например, телефон не загружается), пропатчите OTA с аргументом `--ignore-magisk-warnings` и прошейте его. Затем выполните указанные выше шаги и повторно пропатчите OTA, но уже с указанием аргумента `--magisk-preinit-device <имя>`.
Если запустить приложение Magisk на целевом устройстве невозможно (например, оно не загружается), пропатчите OTA с аргументом `--ignore-magisk-warnings` и прошейте его. Затем выполните указанные выше шаги и повторно пропатчите OTA, но уже с указанием аргумента `--magisk-preinit-device <имя>`.
## Проверка OTA
@@ -347,15 +384,38 @@ avbroot может подменить используемый загрузоч
Обратите внимание, что avbroot проверяет совместимость предварительно пропатченного образа с оригинальным. Например, если поля заголовка образа не совпадают, или вовсе указан иной, незагрузочный образ, то процесс патча будет прерван. Эти проверки, конечно, ничего не гарантируют, но должны предостеречь от случайного использования некорректного образа. Чтобы обойти базовые проверки безопасности, укажите аргумент `--ignore-prepatched-compat`. Если вы хотите убрать вообще все проверки (чего делать крайне не рекомендуется), укажите его дважды.
### Пропуск патчей для root-доступа
### Пропуск патча для root-доступа
avbroot можно использовать для простого переподписания OTA, указав аргумент `--rootless` вместо `--magisk`/`--prepatched`. В таком случае пропатченный OTA не будет рутирован. Единственная модификация, которая будет применена – это замена сертификата проверки OTA, чтобы систему можно было обновлять с помощью будущих пропатченных OTA.
### Подмена разделов
### Пропуск патчинга сертификата OTA
avbroot поддерживает подмену целых образов в OTA, даже тех, что не являются загрузочными (например, `vendor_dlkm`). Образ можно заменить, указав аргумент `--replace <имя раздела> /путь/к/образу.img`.
Вы можете пропустить изменение otacerts.zip, используя аргументы `--skip-system-ota-cert` и `--skip-recovery-ota-cert`. **Не используйте их без веской причины.**
Единственное, что меняется – это то, откуда считывается раздел. При использовании `--replace` вместо использования образа раздела из оригинального `payload.bin` в OTA, он берется напрямую по указанному вами пути. Таким образом, заменяющие образы разделов должны иметь правильные колонтитулы vbmeta, соответствующие оригинальным.
При использовании `--skip-system-ota-cert`, сертификаты OTA в образе `system` изменены не будут. Это не позволит сторонним приложениям для OTA-обновлений устанавливать будущие пропатченные OTA из-под загруженной системы.
При использовании `--skip-recovery-ota-cert`, сертификаты OTA в образах `vendor_boot` или `recovery` изменены не будут. **Это не позволит устанавливать будущие пропатченные OTA в режиме Recovery.**
Если вы используете аргумент `--skip-recovery-ota-cert`, потому что уже добавили сертификат OTA в загрузочный образ вручную, рекомендуетcя [проверить пропатченный OTA](#проверка-ota), дабы удостовериться, что замена произведена корректно. Процесс верификации проверяет только копию сертификатов OTA в загрузочном образе, не проверяя копию в образе системы.
### Пропуск всех патчей
Чтобы внести самый минимум изменений, укажите аргументы:
* `--skip-system-ota-cert`
* `--skip-recovery-ota-cert`
* `--rootless`
* не используйте аргумент `--dsu`.
Так, пользовательскими ключами будут переподписаны лишь образ `vbmeta` и OTA, остальные разделы останутся нетронутыми.
**Это следует использовать только для устранения неполадок.** Без патчей сертификатов, поверх полученного OTA не получится установить никакие обновления.
### Подмена образов
avbroot поддерживает подмену целых образов в OTA, даже тех, что не являются загрузочными (например, `vendor_dlkm`). Образ можно заменить, используя аргумент `--replace <имя раздела> /путь/к/образу.img`.
Единственное, что меняется – это то, откуда считывается файл. При использовании `--replace` вместо образа раздела из оригинального `payload.bin` в OTA, он берется напрямую по указанному вами пути. Заменяющие образы разделов должны иметь правильные колонтитулы vbmeta, соответствующие оригинальным.
Это не влияет на ход применения пачтей. Например, при использовании Magisk, патч получения root-прав применяется к загрузочному образу одинаково, независимо от того, был ли он получен из оригинального `payload.bin` или это файл, указанный через `--replace`.
@@ -369,6 +429,18 @@ Verified boot is disabled by vbmeta's header flags: 0x3
Чтобы принудительно включить AVB (очистив флаги), укажите аргумент `--clear-vbmeta-flags`.
### Изменение алгоритма CoW сжатия для вирутального A/B
Алгоритм CoW (copy-on-write) сжатия для виртуального A/B можно изменить, используя аргумент `--vabc-algo <алгоритм>`, указав `gz` или `lz4`. Как правило, по умолчанию OTA использует алгоритм, который совместим с изначальной версией Android, на которой поставлялось устройство.
* Девайсы, поставляемые с Android 12, поддерживают `gz` и `brotli` (последний не поддерживается avbroot)
* Девайсы, поставляемые с Android 14, поддерживают `lz4`
* Девайсы, поставляемые с Android 15, поддерживают `zstd` (не поддерживается avbroot)
Выбор быстрого алгоритма, такого как lz4, может значительно ускорить установку OTA из-под системы (при использованием стороннего приложения для OTA-обновлений). Однако, при установке OTA в режиме Recovery, разницы в скорости не будет.
Обратите внимание, что текущая используемая версия Android должна поддерживать выбранный алгоритм сжатия. В противном случае установка завершится ошибкой. Например, попытка установить OTA-обновление с Android 14, использующее алгоритм lz4, приведет к ошибке, если установка производится из-под Android 13.
### Использование в неинтерактивном режиме
По умолчанию avbroot интерактивно запрашивает пароли к приватным ключам. Чтобы запустить avbroot в неинтерактивном режиме, можно:
@@ -405,17 +477,95 @@ Verified boot is disabled by vbmeta's header flags: 0x3
* Использовать незашифрованные приватные ключи. Крайне не рекомендуется.
### Извлечение всей OTA
### Извлечение образов из OTA
Чтобы извлечь все образы, содержащиеся в `payload.bin`, используйте команду:
Чтобы извлечь образы разделов, содержащихся в `payload.bin`, используйте команду:
```bash
avbroot ota extract \
--input /путь/к/ota.zip \
--directory extracted \
--all
--directory extracted
```
По умолчанию извлекаются только те образы, которые потенциально могут быть пропатчены с помощью avbroot. Чтобы извлечь все образы, используйте опцию `--all`. Для извлечения конкретных образов используйте опцию `--partition <название раздела>`, которую можно указать несколько раз.
Эта команда также поддерживает извлечение встроенного сертификата OTA и публичного ключа AVB с помощью опций `--cert-ota` и `--public-key-avb`. Чтобы извлечь только эти компоненты, укажите аргумент `--none`, чтобы пропустить извлечение образов разделов.
### Режим записи ZIP
По умолчанию, avbroot использует потоковую запись для вывода OTA во время патчинга. Это означает, что он вычисляет дайджест sha256 для цифровой подписи одновременно с записью файла. Такой режим приводит к тому, что в ZIP-файле появляются описатели данных, что является частью стандарта ZIP и работает на подавляющем большинстве устройств. Однако некоторые устройства могут иметь некорректно работающие парсеры ZIP-файлов и не смогут правильно прочитать ZIP-файлы OTA, содержащие описатели данных. Если это так, используйте опцию `--zip-mode seekable` при патчинге.
Режим seekable записывает ZIP-файлы без описателей данных, но, как следует из названия, требует перемещения по файлу, вместо последовательной записи. Дайджест sha256 для цифровой подписи вычисляется после того, как ZIP-файл был полностью записан.
### Подписание с использованием внешней программы
avbroot поддерживает делегирование всех операций подписания RSA внешней программе с помощью опции `--signing-helper`. При использовании этой опции, для `--key-avb` и `--key-ota` должен быть указан публичный ключ вместо приватного.
Для каждой операции подписания, avbroot будет вызывать программу с параметрами:
```bash
<helper> <algorithm> <public key>
```
Алгоритм (`<algorithm>`) — это один из `SHA{256,512}_RSA{2048,4096}`, а публичный ключ (`<public key>`) — это тот, что был передан в avbroot. Внешняя программа может использовать публичный ключ для поиска соответствующего приватного ключа (например, на аппаратном модуле безопасности). avbroot запишет дайджест, отформатированный по PKCS#1 v1.5, в `stdin`, а внешняя программа должна выполнить операцию сырого подписания RSA и записать сырую подпись (октетная строка, соответствующая размеру ключа) в `stdout`.
По умолчанию, это поведение совместимо с опцией `--signing_helper` в avbtool от AOSP. Однако avbroot дополнительно расширяет аргументы для поддержки неинтерактивного использования. Если используются опции `--pass-{avb,ota}-file` или `--pass-{avb,ota}-env-var`, то внешняя программа будет вызвана с двумя дополнительными аргументами, указывающими на файл пароля или переменную окружения.
```bash
<helper> <algorithm> <public key> file <pass file>
# или
<helper> <algorithm> <public key> env <env file>
```
Обратите внимание, что avbroot проверит подпись, возвращенную внешней программой, на соответствие с публичным ключом. Это гарантирует, что процесс патчинга завершится ошибкой, если был использован неправильный приватный ключ.
### Размер страницы 16 КБ в настройках для разработчиков
На современных устройствах с Android 16 и выше, в настройках для разработчиков может появиться опция переключения на ядро с размером страницы 16 КБ. Однако, эта функция не будет работать в системе, пропатченной с помощью avbroot, поскольку переключение данной настройки осуществляется путём установки инкрементальной OTA:
* `/vendor/boot_otas/boot_ota_16k.zip` — используется для переключения на ядро с размером страницы 16 КБ (в разделе `boot` уже должно быть прошито ядро с размером страницы 4K)
* `/vendor/boot_otas/boot_ota_4k.zip` — используется для переключения на ядро с размером страницы 4 КБ (в разделе `boot` уже должно быть прошито ядро с размером страницы 16K)
Эти файлы (в `boot_otas`) невозможно прошить на системе, пропатченной avbroot, потому что `payload.bin` внутри них подписан ключом производителя. Кроме того, это неполноценные OTA-файлы: у них нет метаданных, характерных для OTA, а сам zip-файл не подписан. Это просто обычный архив, который содержит подписанный `payload.bin`.
Поддержка `boot_otas` не планируется. Это потребует реализации функционала для модификации ФС в инкрементальных OTA и их дальнейшей обработки, что сделать очень непросто.
Если вы всё же хотите завести эту функцию, можно попробовать вручную подписать файлы в `boot_otas` собственным ключом. Поскольку инкрементальные OTA не пересоздаются, раздел `boot` должен оставаться без изменений во время выполнения команды `avbroot ota patch`.
1. Распакуйте `vendor.img` с помощью avbroot и [afsr](https://github.com/chenxiaolong/afsr):
```bash
avbroot avb unpack -i vendor.img
afsr unpack -i raw.img
```
2. Извлеките `payload.bin` из `boot_otas/boot_ota_16k.zip`.
3. Переподпишите `payload.bin` вашим OTA-ключом:
```bash
avbroot payload repack \
-i payload.bin.orig \
-o payload.bin \
-k ota.key \
--output-properties payload_properties.txt
```
4. Создайте новый zip, включающий `payload.bin` и `payload_properties.txt`. Файлы должны быть добавлены без сжатия (например, с помощью `zip -0`).
5. Повторите эту процедуру для `boot_otas/boot_ota_4k.zip`.
6. Соберите `vendor.img` обратно и подпишите его вашим AVB-ключом:
```bash
afsr pack -o raw.img
avbroot avb pack -o vendor.img -k avb.key --recompute-size
```
7. Пропатчите обычный OTA-архив с прошивкой, подменив `vendor` на модифицированный образ:
```bash
avbroot ota patch \
--replace vendor <модифицированный vendor.img> \
<дальше указываются аргументы, как при обычном патчинге>
```
## Сборка из исходного кода
Убедитесь, что у вас установлен [набор инструментов Rust.](https://www.rust-lang.org/ru/) Затем выполните:
@@ -428,27 +578,19 @@ cargo build --release
Дебаг-сборки тоже работают, но они будут работать значительно медленнее (в вычислениях sha256), потому что оптимизации компилятора отключены.
По умолчанию исполняемый файл ссылается на системные библиотеки bzip2 и liblzma, от которых зависит avbroot. Чтобы скомпилировать и статически связать эти две библиотеки, укажите аргумент `--features static`.
### Кросс-компиляция на Android
Чтобы использовать кросс-компиляцию на Android, установите [cargo-android](https://github.com/chenxiaolong/cargo-android) и воспользуйтесь оболочкой `cargo android`. Чтобы создать релизную сборку для aarch64, выполните:
```bash
cargo android build --release --target aarch64-linux-android
```
Возможно выполнение тестов, если хост работает под управлением Linux, установлен qemu-user-static, а исполняемый файл собран с `RUSTFLAGS=-C target-feature=+crt-static` и `--features static`.
## Проверка цифровых подписей
Сначала сохраните открытый ключ в файл, перечисляющий ключи, которым можно доверять. Это тот же ключ, который указан [в профиле автора.](https://github.com/chenxiaolong/)
```bash
echo 'avbroot ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDOe6/tBnO7xZhAWXRj3ApUYgn+XZ0wnQiXM8B7tPgv4' > avbroot_trusted_keys
```
Затем проверьте подпись zip-файла, используя список доверенных ключей.
```bash
ssh-keygen -Y verify -f avbroot_trusted_keys -I avbroot -n file -s <file>.zip.sig < <file>.zip
```
Если файл успешно проверен, вывод будет следующим:
```
Good "file" signature for avbroot with ED25519 key SHA256:Ct0HoRyrFLrnF9W+A/BKEiJmwx7yWkgaW/JvghKrboA
```
Чтобы проверить цифровые подписи, [следуйте этой инструкции.](https://github.com/chenxiaolong/chenxiaolong/blob/master/VERIFY_SSH_SIGNATURES.md)
## Вклад
+30 -32
View File
@@ -4,78 +4,76 @@ version.workspace = true
license.workspace = true
edition.workspace = true
repository.workspace = true
publish = false
publish.workspace = true
rust-version.workspace = true
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
anyhow = "1.0.75"
base64 = "0.22.1"
bitflags = "2.4.1"
bitflags = { version = "2.4.1", features = ["serde"] }
bstr = "1.6.2"
byteorder = "1.4.3"
cap-std = "3.0.0"
cap-tempfile = "3.0.0"
bzip2 = "0.6.0"
clap = { version = "4.4.1", features = ["derive"] }
clap_complete = "4.4.0"
cms = { version = "0.2.2", features = ["std"] }
# We can't upgrade to 0.10.0 until x509-cert updates it too, since it's part of
# the public API.
const-oid = "0.9.5"
crc32fast = "1.4.2"
ctrlc = "3.4.0"
flate2 = "1.0.27"
dlv-list = "0.6.0"
flate2 = { version = "1.0.29", features = ["zlib-rs"] }
gf256 = { version = "0.3.0", features = ["rs"] }
hex = { version = "0.4.3", features = ["serde"] }
liblzma = "0.3.0"
lz4_flex = "0.11.1"
lzma-rust2 = "0.14.2"
memchr = "2.6.0"
num-bigint-dig = "0.8.4"
num-traits = "0.2.16"
phf = { version = "0.11.2", features = ["macros"] }
passterm = "2.0.3"
phf = { version = "0.13.1", features = ["macros"] }
pkcs8 = { version = "0.10.2", features = ["encryption", "pem"] }
prost = "0.12.1"
prost = "0.14.1"
# We can't upgrade to 0.9.0 until rsa updates its rand_core dependency.
rand = "0.8.5"
rawzip = "0.4.0"
rayon = "1.7.0"
regex = { version = "1.9.4", default-features = false, features = ["perf", "std"] }
# We use ring instead of sha2 for sha256 digest computation of large files
# because sha2 is significantly slower on older x86_64 CPUs without the SHA-NI
# instructions. sha2 is still used for signing purposes.
# https://github.com/RustCrypto/hashes/issues/327
ring = "0.17.0"
rpassword = "7.2.0"
ring = "0.17.14"
rsa = { version = "0.9.2", features = ["sha1", "sha2"] }
serde = { version = "1.0.188", features = ["derive"] }
sha1 = "0.10.5"
sha2 = "0.10.7"
tempfile = "3.8.0"
thiserror = "1.0.47"
toml_edit = { version = "0.22.9", features = ["serde"] }
thiserror = "2.0.3"
toml_edit = { version = "0.23.3", features = ["serde"] }
topological-sort = "0.2.2"
tracing = "0.1.40"
tracing-subscriber = "0.3.18"
x509-cert = { version = "0.2.4", features = ["builder"] }
# There are multiple upstream bugs that cause infinite loops in the Drop
# implementation of write::BzDecoder. Unfortunately, the project is no longer
# maintained, so we have to maintain our own fork with the necessary fixes.
[dependencies.bzip2]
git = "https://github.com/chenxiaolong/bzip2-rs"
rev = "6e0f9836ec87b19261461b6cc1772e14aff8e851"
# https://github.com/zip-rs/zip/pull/383
[dependencies.zip]
git = "https://github.com/chenxiaolong/zip"
rev = "989101f9384b9e94e36e6e9e0f51908fdf98bde6"
default-features = false
features = ["deflate"]
zerocopy = { version = "0.8.10", features = ["std"] }
zerocopy-derive = "0.8.5"
[target.'cfg(unix)'.dependencies]
rustix = { version = "0.38.9", default-features = false, features = ["process"] }
libc = "0.2.158"
rustix = { version = "1.0.3", default-features = false, features = ["process"] }
[target.'cfg(target_os = "android")'.dependencies]
system-properties = { git = "https://github.com/chenxiaolong/system-properties", tag = "v0.2.1" }
[build-dependencies]
prost-build = "0.12.1"
protox = "0.6.0"
constcat = "0.6.0"
prost-build = "0.14.1"
protox = "0.9.0"
[dev-dependencies]
assert_matches = "1.5.0"
[features]
static = ["bzip2/static", "liblzma/static"]
[lints]
workspace = true
+56 -4
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{env, ffi::OsStr, fs, io, path::Path};
@@ -30,8 +28,62 @@ fn main() {
let file_descriptors = protox::compile(&protos, [&in_dir]).unwrap();
const CUE_AI: &str = ".chromeos_update_engine.ApexInfo";
const CUE_DAM: &str = ".chromeos_update_engine.DeltaArchiveManifest";
const CUE_DPG: &str = ".chromeos_update_engine.DynamicPartitionGroup";
const CUE_DPM: &str = ".chromeos_update_engine.DynamicPartitionMetadata";
const CUE_PU: &str = ".chromeos_update_engine.PartitionUpdate";
const CUE_VABCFS: &str = ".chromeos_update_engine.VABCFeatureSet";
const DERIVE_SERDE: &str = "#[derive(serde::Deserialize, serde::Serialize)]";
const SERDE_DEFAULT: &str = "#[serde(default)]";
const SERDE_SKIP: &str = "#[serde(skip)]";
const SERDE_SKIP_IF_VEC_EMPTY: &str = "#[serde(skip_serializing_if = \"Vec::is_empty\")]";
use constcat::concat as c;
prost_build::Config::new()
.btree_map(["."])
// Allow deserializing and serializing the types we care about.
.type_attribute(CUE_AI, DERIVE_SERDE)
.type_attribute(CUE_DAM, DERIVE_SERDE)
.type_attribute(CUE_DPG, DERIVE_SERDE)
.type_attribute(CUE_DPM, DERIVE_SERDE)
.type_attribute(CUE_PU, DERIVE_SERDE)
.type_attribute(CUE_VABCFS, DERIVE_SERDE)
// Allow default-initializing all fields.
.type_attribute(CUE_AI, SERDE_DEFAULT)
.type_attribute(CUE_DAM, SERDE_DEFAULT)
.type_attribute(CUE_DPG, SERDE_DEFAULT)
.type_attribute(CUE_DPM, SERDE_DEFAULT)
.type_attribute(CUE_PU, SERDE_DEFAULT)
.type_attribute(CUE_VABCFS, SERDE_DEFAULT)
// Don't serialize fields that define the structure of the payload
// binary and that we recompute during packing.
.field_attribute(c!(CUE_DAM, ".signatures_offset"), SERDE_SKIP)
.field_attribute(c!(CUE_DAM, ".signatures_size"), SERDE_SKIP)
.field_attribute(c!(CUE_PU, ".operations"), SERDE_SKIP)
.field_attribute(c!(CUE_PU, ".estimate_cow_size"), SERDE_SKIP)
.field_attribute(c!(CUE_PU, ".old_partition_info"), SERDE_SKIP)
.field_attribute(c!(CUE_PU, ".new_partition_info"), SERDE_SKIP)
// Don't serialize AVB 1.0 fields.
.field_attribute(c!(CUE_PU, ".hash_tree_data_extent"), SERDE_SKIP)
.field_attribute(c!(CUE_PU, ".hash_tree_extent"), SERDE_SKIP)
.field_attribute(c!(CUE_PU, ".hash_tree_algorithm"), SERDE_SKIP)
.field_attribute(c!(CUE_PU, ".hash_tree_salt"), SERDE_SKIP)
.field_attribute(c!(CUE_PU, ".fec_data_extent"), SERDE_SKIP)
.field_attribute(c!(CUE_PU, ".fec_extent"), SERDE_SKIP)
.field_attribute(c!(CUE_PU, ".fec_roots"), SERDE_SKIP)
// Don't serialize fields for incremental OTAs.
.field_attribute(c!(CUE_PU, ".merge_operations"), SERDE_SKIP)
// Don't serialize fields for vendor-signed images, which update_engine
// doesn't support anyway.
.field_attribute(c!(CUE_PU, ".new_partition_signature"), SERDE_SKIP)
// Don't serialize empty lists.
.field_attribute(c!(CUE_DAM, ".apex_info"), SERDE_SKIP_IF_VEC_EMPTY)
.field_attribute(c!(CUE_DAM, ".partitions"), SERDE_SKIP_IF_VEC_EMPTY)
.field_attribute(c!(CUE_DPG, ".partition_names"), SERDE_SKIP_IF_VEC_EMPTY)
.field_attribute(c!(CUE_DPM, ".groups"), SERDE_SKIP_IF_VEC_EMPTY)
.compile_fds(file_descriptors)
.unwrap();
}
+8
View File
@@ -316,6 +316,10 @@ message PartitionUpdate {
// as a hint. If set to 0, libsnapshot should use alternative
// methods for estimating size.
optional uint64 estimate_cow_size = 19;
// Information about the cow used by Cow Writer to specify
// number of cow operations to be written
optional uint64 estimate_op_count_max = 20;
}
message DynamicPartitionGroup {
@@ -368,6 +372,10 @@ message DynamicPartitionMetadata {
// A collection of knobs to tune Virtual AB Compression
optional VABCFeatureSet vabc_feature_set = 6;
// Max bytes to be compressed at once during ota. Options: 4k, 8k, 16k, 32k,
// 64k, 128k
optional uint64 compression_factor = 7;
}
// Definition has been duplicated from
+16 -44
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
fmt,
@@ -12,10 +10,10 @@ use std::{
use anyhow::Result;
use clap::{Parser, Subcommand, ValueEnum};
use tracing::{debug, Level};
use tracing::{Level, debug};
use tracing_subscriber::fmt::{format::Writer, time::FormatTime};
use crate::cli::{avb, boot, completion, cpio, fec, hashtree, key, ota, payload};
use crate::cli::{avb, boot, completion, cpio, fec, hashtree, key, lp, ota, payload, sparse};
#[allow(clippy::large_enum_variant)]
#[derive(Debug, Subcommand)]
@@ -27,49 +25,21 @@ pub enum Command {
Fec(fec::FecCli),
HashTree(hashtree::HashTreeCli),
Key(key::KeyCli),
Lp(lp::LpCli),
Ota(ota::OtaCli),
Payload(payload::PayloadCli),
Sparse(sparse::SparseCli),
/// (Deprecated: Use `avbroot ota patch` instead.)
#[command(hide = true)]
Patch(ota::PatchCli),
/// (Deprecated: Use `avbroot ota extract` instead.)
#[command(hide = true)]
Extract(ota::ExtractCli),
/// (Deprecated: Use `avbroot boot magisk-info` instead.)
#[command(hide = true)]
MagiskInfo(boot::MagiskInfoCli),
}
#[derive(Debug, Clone, Copy, ValueEnum)]
pub enum LogLevel {
Trace,
Debug,
Info,
Warn,
Error,
}
impl LogLevel {
fn as_level(self) -> Level {
match self {
Self::Trace => Level::TRACE,
Self::Debug => Level::DEBUG,
Self::Info => Level::INFO,
Self::Warn => Level::WARN,
Self::Error => Level::ERROR,
}
}
}
impl Default for LogLevel {
fn default() -> Self {
Self::Info
}
}
impl fmt::Display for LogLevel {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(self.to_possible_value().ok_or(fmt::Error)?.get_name())
}
}
#[derive(Debug, Clone, Copy, ValueEnum)]
pub enum LogFormat {
Short,
@@ -96,8 +66,8 @@ pub struct Cli {
pub command: Command,
/// Lowest log message severity to output.
#[arg(long, global = true, value_name = "LEVEL", default_value_t)]
pub log_level: LogLevel,
#[arg(long, global = true, value_name = "LEVEL", default_value_t = Level::INFO)]
pub log_level: Level,
/// Output format for log messages.
#[arg(long, global = true, value_name = "FORMAT", default_value_t)]
@@ -124,11 +94,11 @@ impl FormatTime for ShortUptime {
}
}
pub fn init_logging(log_level: LogLevel, log_format: LogFormat) {
pub fn init_logging(log_level: Level, log_format: LogFormat) {
let builder = tracing_subscriber::fmt()
.with_writer(io::stderr)
.with_ansi(io::stderr().is_terminal())
.with_max_level(log_level.as_level());
.with_max_level(log_level);
match log_format {
LogFormat::Short => {
@@ -163,8 +133,10 @@ pub fn main(logging_initialized: &AtomicBool, cancel_signal: &AtomicBool) -> Res
Command::Fec(c) => fec::fec_main(&c, cancel_signal),
Command::HashTree(c) => hashtree::hash_tree_main(&c, cancel_signal),
Command::Key(c) => key::key_main(&c),
Command::Lp(c) => lp::lp_main(&c, cancel_signal),
Command::Ota(c) => ota::ota_main(&c, cancel_signal),
Command::Payload(c) => payload::payload_main(&c),
Command::Payload(c) => payload::payload_main(&c, cancel_signal),
Command::Sparse(c) => sparse::sparse_main(&c, cancel_signal),
// Deprecated aliases.
Command::Patch(c) => ota::patch_subcommand(&c, cancel_signal),
Command::Extract(c) => ota::extract_subcommand(&c, cancel_signal),
+417 -147
View File
@@ -1,36 +1,31 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
collections::{HashMap, HashSet},
ffi::{OsStr, OsString},
fs::{self, File},
io::{self, BufReader, BufWriter, Seek, SeekFrom, Write},
ffi::OsString,
fmt,
fs::{self, File, OpenOptions},
io::{self, BufReader, BufWriter, Cursor, Seek, SeekFrom, Write},
path::{Path, PathBuf},
str,
sync::atomic::AtomicBool,
};
use anyhow::{anyhow, bail, Context, Result};
use cap_std::{
ambient_authority,
fs::{Dir, OpenOptions},
};
use anyhow::{Context, Result, anyhow, bail};
use clap::{Args, Parser, Subcommand};
use rayon::prelude::{IntoParallelRefIterator, ParallelIterator};
use rsa::RsaPublicKey;
use serde::{Deserialize, Serialize};
use tracing::{debug_span, info, warn, Span};
use sha2::{Digest, Sha256};
use tracing::{Span, debug_span, info, warn};
use crate::{
crypto::{self, PassphraseSource},
crypto::{self, PassphraseSource, RsaSigningKey},
format::avb::{
self, AlgorithmType, AppendedDescriptorMut, AppendedDescriptorRef, Descriptor, Footer,
HashTreeDescriptor, Header, KernelCmdlineDescriptor,
},
stream::{self, PSeekFile, Reopen},
stream::{self, ReadFixedSizeExt, ToWriter, UserPosFile, check_cancel},
util,
};
@@ -57,7 +52,7 @@ fn read_avb_image(path: &Path) -> Result<(AvbInfo, BufReader<File>)> {
Ok((info, reader))
}
fn write_avb_image(file: PSeekFile, info: &mut AvbInfo, recompute_size: bool) -> Result<()> {
fn write_avb_image(file: &File, info: &mut AvbInfo, recompute_size: bool) -> Result<()> {
let mut writer = BufWriter::new(file);
info.image_size = if let Some(f) = &mut info.footer {
@@ -98,18 +93,6 @@ fn write_info(path: &Path, info: &AvbInfo) -> Result<()> {
Ok(())
}
/// Packing with insecure algorithms is intentionally not supported, so promote
/// to a secure algorithm if needed.
fn promote_insecure_hash_algorithm(algorithm: &mut String) {
const INSECURE_ALGORITHMS: &[&str] = &["sha1"];
const NEW_ALGORITHM: &str = "sha256";
if INSECURE_ALGORITHMS.contains(&algorithm.as_str()) {
warn!("Changing insecure hash algorithm {algorithm} to {NEW_ALGORITHM}");
NEW_ALGORITHM.clone_into(algorithm);
}
}
/// Copy `size` bytes from `reader` into a new file `path` that's opened as
/// both readable and writable.
fn write_raw(
@@ -117,14 +100,13 @@ fn write_raw(
reader: &mut BufReader<File>,
size: u64,
cancel_signal: &AtomicBool,
) -> Result<PSeekFile> {
) -> Result<File> {
let file = fs::OpenOptions::new()
.read(true)
.write(true)
.create(true)
.truncate(true)
.open(path)
.map(PSeekFile::new)
.with_context(|| format!("Failed to open raw image for writing: {path:?}"))?;
let mut writer = BufWriter::new(file);
@@ -149,7 +131,7 @@ fn write_raw_and_verify(
info: &AvbInfo,
ignore_invalid: bool,
cancel_signal: &AtomicBool,
) -> Result<PSeekFile> {
) -> Result<File> {
let f = info.footer.as_ref().expect("Not an appended image");
let descriptor = info.header.appended_descriptor()?;
@@ -163,7 +145,7 @@ fn write_raw_and_verify(
let raw_file = write_raw(path, reader, copy_size, cancel_signal)?;
let result = verify_and_repair(None, raw_file.reopen()?, descriptor, true, cancel_signal);
let result = verify_and_repair(None, &raw_file, descriptor, true, cancel_signal);
// Chop off the old hash tree and FEC data.
raw_file.set_len(f.original_image_size)?;
@@ -186,7 +168,7 @@ fn write_raw_and_update(
reader: &mut BufReader<File>,
info: &mut AvbInfo,
cancel_signal: &AtomicBool,
) -> Result<PSeekFile> {
) -> Result<File> {
assert!(info.footer.is_some(), "Not an appended image");
let image_size = reader
@@ -197,13 +179,11 @@ fn write_raw_and_update(
match info.header.appended_descriptor_mut()? {
AppendedDescriptorMut::HashTree(d) => {
promote_insecure_hash_algorithm(&mut d.hash_algorithm);
d.image_size = image_size;
d.update(&raw_file, &raw_file, None, cancel_signal)
d.update(&raw_file, None, cancel_signal)
.context("Failed to update hash tree descriptor")?;
}
AppendedDescriptorMut::Hash(d) => {
promote_insecure_hash_algorithm(&mut d.hash_algorithm);
d.image_size = image_size;
raw_file.rewind()?;
d.update(&mut raw_file, cancel_signal)
@@ -315,14 +295,13 @@ fn update_dm_verity_cmdline(info: &mut AvbInfo) -> Result<bool> {
};
for d in &mut info.header.descriptors {
if let Descriptor::KernelCmdline(d) = d {
if d.flags & KernelCmdlineDescriptor::FLAG_USE_ONLY_IF_HASHTREE_NOT_DISABLED != 0
&& d.cmdline.starts_with("dm=")
&& d.cmdline != new_cmdline
{
d.cmdline = new_cmdline;
return Ok(true);
}
if let Descriptor::KernelCmdline(d) = d
&& d.flags & KernelCmdlineDescriptor::FLAG_USE_ONLY_IF_HASHTREE_NOT_DISABLED != 0
&& d.cmdline.starts_with("dm=")
&& d.cmdline != new_cmdline
{
d.cmdline = new_cmdline;
return Ok(true);
}
}
@@ -342,7 +321,13 @@ fn sign_or_clear(info: &mut AvbInfo, orig_header: &Header, key_group: &KeyGroup)
}
let originally_signed = !info.header.signature.is_empty();
let mut sign_action = if originally_signed && &info.header != orig_header {
let sign_action = if key_group.force {
if key_group.key.is_some() {
SignAction::Sign
} else {
SignAction::Clear
}
} else if originally_signed && (&info.header != orig_header || info.header.verify().is_err()) {
SignAction::Sign
} else {
// If the original image was signed, we can preserve the existing
@@ -351,14 +336,6 @@ fn sign_or_clear(info: &mut AvbInfo, orig_header: &Header, key_group: &KeyGroup)
SignAction::None
};
if key_group.force {
sign_action = if key_group.key.is_some() {
SignAction::Sign
} else {
SignAction::Clear
};
}
match sign_action {
SignAction::None => {
if originally_signed {
@@ -383,12 +360,28 @@ fn sign_or_clear(info: &mut AvbInfo, orig_header: &Header, key_group: &KeyGroup)
key_group.pass_file.as_deref(),
key_group.pass_env_var.as_deref(),
);
let private_key = crypto::read_pem_key_file(key_path, &source)
.with_context(|| format!("Failed to load key: {key_path:?}"))?;
let signing_key = if let Some(helper) = &key_group.signing_helper {
let public_key = crypto::read_pem_public_key_file(key_path)
.with_context(|| format!("Failed to load key: {key_path:?}"))?;
RsaSigningKey::External {
program: helper.clone(),
public_key_file: key_path.clone(),
public_key,
passphrase_source: source,
}
} else {
let private_key = crypto::read_pem_key_file(key_path, &source)
.with_context(|| format!("Failed to load key: {key_path:?}"))?;
RsaSigningKey::Internal(private_key)
};
info.header.set_algo_for_key(&private_key)?;
info.header
.sign(&private_key)
.set_algo_for_key(&signing_key)
.context("Failed to set signature algorithm")?;
info.header
.sign(&signing_key)
.context("Failed to sign new AVB header")?;
}
SignAction::Clear => {
@@ -413,22 +406,82 @@ fn display_info(display: &DisplayGroup, info: &AvbInfo) {
}
}
/// Ensure that the partition name won't cause directory traversals.
fn ensure_name_is_safe(name: &str) -> Result<()> {
if Path::new(name).file_name() != Some(OsStr::new(name)) {
bail!("Unsafe partition name: {name}");
#[derive(Debug, Clone)]
struct SearchPath {
dir: PathBuf,
suffix: String,
}
impl fmt::Display for SearchPath {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{:?} (suffix: {:?})", self.dir, self.suffix)
}
}
#[derive(Debug, Clone, Default)]
pub struct ImageOpener {
search: Vec<SearchPath>,
}
impl ImageOpener {
pub fn new() -> Self {
Self::default()
}
Ok(())
pub fn with_dir(dir: impl Into<PathBuf>) -> Self {
let mut result = Self::new();
result.add_dir(dir, ".img");
result
}
pub fn add_dir(&mut self, dir: impl Into<PathBuf>, suffix: impl Into<String>) {
self.search.push(SearchPath {
dir: dir.into(),
suffix: suffix.into(),
});
}
fn open(&self, name: &str, options: &OpenOptions) -> io::Result<(PathBuf, File)> {
for search in &self.search {
let path = util::path_join_single(&search.dir, format!("{name}{}", search.suffix))
.map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
match options.open(&path) {
Ok(f) => return Ok((path, f)),
Err(e) if e.kind() == io::ErrorKind::NotFound => continue,
Err(e) => {
return Err(io::Error::new(
e.kind(),
format!("Failed to open for reading: {path:?}: {e}"),
));
}
}
}
Err(io::Error::new(
io::ErrorKind::NotFound,
format!(
"Failed to find {name:?} image in: {}",
util::join(&self.search, ", "),
),
))
}
}
#[derive(Debug, Clone)]
pub enum TrustMethod {
Key(RsaPublicKey),
KeyDigest([u8; 32]),
Anything,
}
/// Recursively verify an image's vbmeta header and all of the chained images.
/// `seen` is used to prevent cycles. `descriptors` will contain all of the hash
/// and hash tree descriptors that need to be verified.
pub fn verify_headers(
directory: &Dir,
opener: &ImageOpener,
name: &str,
expected_key: Option<&RsaPublicKey>,
trust_method: &TrustMethod,
seen: &mut HashSet<String>,
descriptors: &mut HashMap<String, Descriptor>,
) -> Result<()> {
@@ -436,12 +489,7 @@ pub fn verify_headers(
return Ok(());
}
ensure_name_is_safe(name)?;
let path = format!("{name}.img");
let raw_reader = directory
.open(&path)
.with_context(|| format!("Failed to open for reading: {path:?}"))?;
let (path, raw_reader) = opener.open(name, OpenOptions::new().read(true))?;
let (header, _, _) = avb::load_image(BufReader::new(raw_reader))
.with_context(|| format!("Failed to load vbmeta structures: {path:?}"))?;
@@ -453,19 +501,36 @@ pub fn verify_headers(
if let Some(k) = &public_key {
let prefix = format!("{name} has a signed vbmeta header");
if let Some(e) = expected_key {
if k == e {
info!("{prefix}");
} else {
bail!("{prefix}, but is signed by an untrusted key");
match trust_method {
TrustMethod::Key(expected) => {
if k == expected {
info!("{prefix}");
} else {
bail!("{prefix}, but is signed by an untrusted key");
}
}
TrustMethod::KeyDigest(expected_sha256) => {
let encoded = avb::encode_public_key(k)?;
let digest = Sha256::digest(&encoded);
if digest.as_slice() == expected_sha256 {
info!("{prefix}");
} else {
bail!("{prefix}, but is signed by an untrusted key");
}
}
TrustMethod::Anything => {
warn!("{prefix}, but parent does not list a trusted key");
}
} else {
warn!("{prefix}, but parent does not list a trusted key");
}
} else {
info!("{name} has an unsigned vbmeta header");
}
if header.flags != 0 {
warn!("{name} has insecure flags: {:#x}", header.flags);
}
for descriptor in &header.descriptors {
let Some(target_name) = descriptor.partition_name() else {
continue;
@@ -485,8 +550,9 @@ pub fn verify_headers(
let target_key = avb::decode_public_key(&d.public_key).with_context(|| {
format!("Failed to decode chained public key for: {target_name}")
})?;
let target_trust = TrustMethod::Key(target_key);
verify_headers(directory, target_name, Some(&target_key), seen, descriptors)?;
verify_headers(opener, target_name, &target_trust, seen, descriptors)?;
}
_ => {}
}
@@ -501,30 +567,27 @@ pub fn verify_headers(
/// work.
fn verify_and_repair(
name: Option<&str>,
mut file: PSeekFile,
file: &File,
descriptor: AppendedDescriptorRef,
repair: bool,
cancel_signal: &AtomicBool,
) -> Result<()> {
let _span = debug_span!("image", name = name.unwrap_or_default()).entered();
let suffix = match name {
Some(n) => format!(" for: {n}"),
None => String::new(),
};
let suffix = name.map_or_else(String::new, |n| format!(" for: {n}"));
match descriptor {
AppendedDescriptorRef::HashTree(d) => {
info!("Verifying hash tree descriptor{suffix}");
match d.verify(&file, cancel_signal) {
Err(e @ avb::Error::HashTree(_)) if repair => {
Err(e @ avb::Error::HashTreeVerify(_)) if repair => {
warn!("Failed to verify hash tree descriptor{suffix}: {e}");
warn!("Attempting to repair using FEC data{suffix}");
d.repair(&file, &file, cancel_signal)
d.repair(&file, cancel_signal)
.with_context(|| format!("Failed to repair data{suffix}"))?;
d.verify(&file, cancel_signal).map(|_| {
d.verify(&file, cancel_signal).inspect(|()| {
info!("Successfully repaired data{suffix}");
})
}
@@ -535,8 +598,7 @@ fn verify_and_repair(
AppendedDescriptorRef::Hash(d) => {
info!("Verifying hash descriptor{suffix}");
file.rewind()?;
d.verify(file, cancel_signal)
d.verify(UserPosFile::new(file), cancel_signal)
.with_context(|| format!("Failed to verify hash descriptor{suffix}"))?;
}
}
@@ -547,45 +609,124 @@ fn verify_and_repair(
/// Verify hash and hash tree descriptor digests and FEC data against their
/// corresponding input files.
pub fn verify_descriptors(
directory: &Dir,
opener: &ImageOpener,
descriptors: &HashMap<String, Descriptor>,
repair: bool,
allow_missing: bool,
cancel_signal: &AtomicBool,
) -> Result<()> {
let parent_span = Span::current();
descriptors
.par_iter()
.map(|(name, descriptor)| {
let _span = parent_span.enter();
let mut options = OpenOptions::new();
options.read(true);
options.write(repair);
let path = format!("{name}.img");
let file = match directory
.open_with(&path, OpenOptions::new().read(true).write(repair))
.map(|f| PSeekFile::new(f.into_std()))
{
Ok(f) => f,
// Some devices, like bluejay, have vbmeta descriptors that
// refer to partitions that exist on the device, but not in the
// OTA.
Err(e) if e.kind() == io::ErrorKind::NotFound => {
warn!("Partition image does not exist: {path:?}");
return Ok(());
}
Err(e) => {
Err(e).with_context(|| format!("Failed to open for reading: {path:?}"))?
}
};
descriptors.par_iter().try_for_each(|(name, descriptor)| {
let _span = parent_span.enter();
verify_and_repair(
Some(name),
file,
descriptor.try_into()?,
repair,
let file = match opener.open(name, &options) {
Ok((_, f)) => f,
// Some devices, like bluejay, have vbmeta descriptors that refer to
// partitions that exist on the device, but not in the OTA.
Err(e) if e.kind() == io::ErrorKind::NotFound && allow_missing => {
warn!("{e}");
return Ok(());
}
Err(e) => return Err(e.into()),
};
verify_and_repair(
Some(name),
&file,
descriptor.try_into()?,
repair,
cancel_signal,
)
})
}
fn compute_digest_recursive(
directory: &Path,
name: &str,
context: &mut ring::digest::Context,
max_depth: u8,
seen: &mut HashSet<String>,
cancel_signal: &AtomicBool,
) -> Result<()> {
if max_depth == 0 {
return Ok(());
}
check_cancel(cancel_signal)?;
seen.insert(name.to_owned());
let path = util::path_join_single(directory, format!("{name}.img"))?;
let mut raw_reader = File::open(&path)
.map(BufReader::new)
.with_context(|| format!("Failed to open for reading: {path:?}"))?;
let (header, footer, _) = avb::load_image(&mut raw_reader)
.with_context(|| format!("Failed to load vbmeta structures: {path:?}"))?;
// We don't have a good way to get the length of the header, so we serialize
// what we just parsed and compare it to the raw file so ensure that the
// round-tripped data is identical.
let raw_header = {
let mut writer = Cursor::new(Vec::new());
header
.to_writer(&mut writer)
.with_context(|| format!("Failed to serialize header: {path:?}"))?;
writer.into_inner()
};
let header_offset = footer.map(|f| f.vbmeta_offset).unwrap_or_default();
raw_reader
.seek(SeekFrom::Start(header_offset))
.with_context(|| format!("Failed to seek file: {path:?}"))?;
let raw_header_orig = raw_reader
.read_vec_exact(raw_header.len())
.with_context(|| format!("Failed to reread AVB header: {path:?}"))?;
if raw_header != raw_header_orig {
bail!("Serialized header does not match original header: {path:?}");
}
context.update(&raw_header);
for descriptor in &header.descriptors {
if let avb::Descriptor::ChainPartition(d) = descriptor {
compute_digest_recursive(
directory,
&d.partition_name,
context,
max_depth - 1,
seen,
cancel_signal,
)
})
.collect()
)?;
}
}
Ok(())
}
/// Compute the vbmeta digest. This is defined as the digest of the header in
/// the root vbmeta image, followed by the headers in the immediate chained
/// partitions. This digest is not defined to be recursive, so headers of
/// chained partitions more than one level deep are ignored.
pub fn compute_digest(
directory: &Path,
name: &str,
cancel_signal: &AtomicBool,
) -> Result<[u8; 32]> {
let mut seen = HashSet::<String>::new();
let mut context = ring::digest::Context::new(&ring::digest::SHA256);
compute_digest_recursive(directory, name, &mut context, 2, &mut seen, cancel_signal)?;
let digest = context.finish();
Ok(digest.as_ref().try_into().unwrap())
}
fn unpack_subcommand(cli: &UnpackCli, cancel_signal: &AtomicBool) -> Result<()> {
@@ -594,7 +735,7 @@ fn unpack_subcommand(cli: &UnpackCli, cancel_signal: &AtomicBool) -> Result<()>
write_info(&cli.output_info, &info)?;
if info.footer.is_some() {
if info.footer.is_some() && !cli.no_output_raw {
write_raw_and_verify(
&cli.output_raw,
&mut reader,
@@ -625,13 +766,12 @@ fn pack_subcommand(cli: &PackCli, cancel_signal: &AtomicBool) -> Result<()> {
file
} else {
File::create(&cli.output)
.map(PSeekFile::new)
.with_context(|| format!("Failed to open output for writing: {:?}", cli.output))?
};
sign_or_clear(&mut info, &orig_header, &cli.key)?;
write_avb_image(file, &mut info, cli.recompute_size)?;
write_avb_image(&file, &mut info, cli.recompute_size)?;
// We display the info at the very end after both the header and footer are
// updated so that incorrect/incomplete information isn't shown.
@@ -654,8 +794,7 @@ fn repack_subcommand(cli: &RepackCli, cancel_signal: &AtomicBool) -> Result<()>
// Write new hash tree and FEC data instead of copying the original.
// There could have been errors in the original FEC data itself.
if let AppendedDescriptorMut::HashTree(d) = info.header.appended_descriptor_mut()? {
promote_insecure_hash_algorithm(&mut d.hash_algorithm);
d.update(&file, &file, None, cancel_signal)?;
d.update(&file, None, cancel_signal)?;
}
update_dm_verity_cmdline(&mut info)?;
@@ -663,13 +802,12 @@ fn repack_subcommand(cli: &RepackCli, cancel_signal: &AtomicBool) -> Result<()>
file
} else {
File::create(&cli.output)
.map(PSeekFile::new)
.with_context(|| format!("Failed to open for writing: {:?}", cli.output))?
};
sign_or_clear(&mut info, &orig_header, &cli.key)?;
write_avb_image(file, &mut info, false)?;
write_avb_image(&file, &mut info, false)?;
// We display the info at the very end after both the header and footer are
// updated so that incorrect/incomplete information isn't shown.
@@ -685,21 +823,40 @@ fn info_subcommand(cli: &InfoCli) -> Result<()> {
Ok(())
}
fn verify_subcommand(cli: &VerifyCli, cancel_signal: &AtomicBool) -> Result<()> {
let public_key = if let Some(p) = &cli.public_key {
fn verify_internal(
public_key_path: Option<&Path>,
public_key_digest: Option<[u8; 32]>,
opener: &ImageOpener,
name: &str,
repair: bool,
allow_missing: bool,
cancel_signal: &AtomicBool,
) -> Result<()> {
let trust_method = if let Some(p) = public_key_path {
let data = fs::read(p).with_context(|| format!("Failed to read file: {p:?}"))?;
let key = avb::decode_public_key(&data)
.with_context(|| format!("Failed to decode public key: {p:?}"))?;
Some(key)
TrustMethod::Key(key)
} else if let Some(d) = public_key_digest {
TrustMethod::KeyDigest(d)
} else {
None
TrustMethod::Anything
};
let authority = ambient_authority();
let parent_path = util::parent_path(&cli.input);
let directory = Dir::open_ambient_dir(parent_path, authority)
.with_context(|| format!("Failed to open directory: {parent_path:?}"))?;
let mut seen = HashSet::<String>::new();
let mut descriptors = HashMap::<String, Descriptor>::new();
verify_headers(opener, name, &trust_method, &mut seen, &mut descriptors)?;
verify_descriptors(opener, &descriptors, repair, allow_missing, cancel_signal)?;
info!("Successfully verified all vbmeta signatures and hashes");
Ok(())
}
fn verify_subcommand(cli: &VerifyCli, cancel_signal: &AtomicBool) -> Result<()> {
let directory = util::parent_path(&cli.input);
let name = cli
.input
.file_stem()
@@ -707,19 +864,73 @@ fn verify_subcommand(cli: &VerifyCli, cancel_signal: &AtomicBool) -> Result<()>
.to_str()
.ok_or_else(|| anyhow!("Invalid UTF-8: {:?}", cli.input))?;
let mut seen = HashSet::<String>::new();
let mut descriptors = HashMap::<String, Descriptor>::new();
let opener = ImageOpener::with_dir(directory);
verify_headers(
&directory,
verify_internal(
cli.public_key.as_deref(),
None,
&opener,
name,
public_key.as_ref(),
&mut seen,
&mut descriptors,
)?;
verify_descriptors(&directory, &descriptors, cli.repair, cancel_signal)?;
cli.repair,
!cli.fail_if_missing,
cancel_signal,
)
}
info!("Successfully verified all vbmeta signatures and hashes");
#[cfg(target_os = "android")]
fn get_required_property(name: &str) -> Result<String> {
system_properties::read(name)
.with_context(|| format!("Failed to query property: {name}"))?
.ok_or_else(|| anyhow!("Property is not set: {name}"))
}
#[cfg(target_os = "android")]
fn verify_device_subcommand(cli: &VerifyDeviceCli, cancel_signal: &AtomicBool) -> Result<()> {
let slot_suffix = get_required_property("ro.boot.slot_suffix")?;
// Use the bootloader's public key digest if no key is specified. This is
// what the user flashed for avb_custom_key.
let public_key_digest = if cli.public_key.is_none() {
let hex_digest = get_required_property("ro.boot.vbmeta.public_key_digest")?;
let mut digest = [0u8; 32];
hex::decode_to_slice(&hex_digest, &mut digest)
.with_context(|| format!("Invalid public key digest: {hex_digest}"))?;
info!("Verifying against bootloader public key digest: {hex_digest}");
Some(digest)
} else {
None
};
let mut opener = ImageOpener::new();
opener.add_dir("/dev/block/by-name", &slot_suffix);
opener.add_dir("/dev/block/mapper", &slot_suffix);
verify_internal(
cli.public_key.as_deref(),
public_key_digest,
&opener,
&cli.partition,
false,
false,
cancel_signal,
)
}
fn digest_subcommand(cli: &DigestCli, cancel_signal: &AtomicBool) -> Result<()> {
let directory = util::parent_path(&cli.input);
let name = cli
.input
.file_stem()
.with_context(|| format!("Path is not a file: {:?}", cli.input))?
.to_str()
.ok_or_else(|| anyhow!("Invalid UTF-8: {:?}", cli.input))?;
let digest = compute_digest(directory, name, cancel_signal)?;
println!("{}", hex::encode(digest));
Ok(())
}
@@ -731,6 +942,9 @@ pub fn avb_main(cli: &AvbCli, cancel_signal: &AtomicBool) -> Result<()> {
AvbCommand::Repack(c) => repack_subcommand(c, cancel_signal),
AvbCommand::Info(c) => info_subcommand(c),
AvbCommand::Verify(c) => verify_subcommand(c, cancel_signal),
#[cfg(target_os = "android")]
AvbCommand::VerifyDevice(c) => verify_device_subcommand(c, cancel_signal),
AvbCommand::Digest(c) => digest_subcommand(c, cancel_signal),
}
}
@@ -743,12 +957,15 @@ struct DisplayGroup {
#[derive(Debug, Args)]
struct KeyGroup {
/// Path to private key for signing.
/// Path to signing key.
///
/// A private key is needed if packing an image where the original header
/// A signing key is needed if packing an image where the original header
/// was signed and the header needs to be modified (eg. for a new checksum).
/// If the header was originally not signed, then the private key is not
/// If the header was originally not signed, then the signing key is not
/// used, unless --force is specified.
///
/// This should normally be a private key. However, if --signing-helper is
/// used, then it should be a public key instead.
#[arg(short, long, value_name = "FILE", value_parser)]
key: Option<PathBuf>,
@@ -768,6 +985,15 @@ struct KeyGroup {
/// File containing private key passphrase.
#[arg(long, value_name = "FILE", value_parser, group = "pass")]
pass_file: Option<PathBuf>,
/// External program for signing.
///
/// If this option is specified, then --key must refer to a public key. The
/// program will be invoked as:
///
/// <program> <algo> <public key> [file <pass file>|env <pass env>]
#[arg(long, value_name = "PROGRAM", value_parser)]
signing_helper: Option<PathBuf>,
}
/// Unpack an AVB image.
@@ -799,6 +1025,10 @@ struct UnpackCli {
#[arg(long, value_name = "FILE", value_parser, default_value = "raw.img")]
output_raw: PathBuf,
/// Do not output raw image.
#[arg(long, conflicts_with = "output_raw")]
no_output_raw: bool,
/// Ignore invalid digests or FEC data.
#[arg(long)]
ignore_invalid: bool,
@@ -921,6 +1151,43 @@ struct VerifyCli {
/// Only images with hash tree descriptors can contain FEC data.
#[arg(short, long)]
repair: bool,
/// Fail if a referenced image is missing.
///
/// Missing images are ignored by default because some OTAs contain vbmeta
/// images referencing partitions that only exist on the real device.
#[arg(long)]
fail_if_missing: bool,
}
/// Verify vbmeta signatures for the currently booted system.
///
/// This behaves like the `verify` subcommand, except that it checks the actual
/// partitions that this device is currently booted from.
#[cfg(target_os = "android")]
#[derive(Debug, Parser)]
struct VerifyDeviceCli {
/// Path to public key in AVB binary format.
///
/// If this is not specified, the signatures can only be checked for
/// validity, not whether they are trusted.
#[arg(short, long, value_name = "FILE", value_parser)]
public_key: Option<PathBuf>,
/// Partition to recursively verify.
#[arg(short = 'P', long, value_name = "NAME", default_value = "vbmeta")]
partition: String,
}
/// Compute the vbmeta digest.
///
/// This value is equal to what is reported by the ro.boot.vbmeta.digest
/// property on a real device.
#[derive(Debug, Parser)]
struct DigestCli {
/// Path to input AVB image.
#[arg(short, long, value_name = "FILE", value_parser)]
input: PathBuf,
}
#[derive(Debug, Subcommand)]
@@ -931,6 +1198,9 @@ enum AvbCommand {
#[command(alias = "dump")]
Info(InfoCli),
Verify(VerifyCli),
#[cfg(target_os = "android")]
VerifyDevice(VerifyDeviceCli),
Digest(DigestCli),
}
/// Pack, unpack, and inspect AVB-protected images.
+55 -15
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
fs::{self, File},
@@ -9,7 +7,7 @@ use std::{
path::{Path, PathBuf},
};
use anyhow::{bail, Context, Result};
use anyhow::{Context, Result, bail};
use clap::{Parser, Subcommand};
use crate::{
@@ -166,30 +164,44 @@ fn unpack_subcommand(boot_cli: &BootCli, cli: &UnpackCli) -> Result<()> {
}
}
if let Some(data) = kernel {
if let Some(data) = kernel
&& !cli.no_output_kernel
{
write_data_if_not_empty(&cli.output_kernel, data)?;
}
if let Some(data) = second {
if let Some(data) = second
&& !cli.no_output_second
{
write_data_if_not_empty(&cli.output_second, data)?;
}
if let Some(data) = recovery_dtbo {
if let Some(data) = recovery_dtbo
&& !cli.no_output_recovery_dtbo
{
write_data_if_not_empty(&cli.output_recovery_dtbo, data)?;
}
if let Some(data) = dtb {
if let Some(data) = dtb
&& !cli.no_output_dtb
{
write_data_if_not_empty(&cli.output_dtb, data)?;
}
if let Some(header) = vts_signature {
if let Some(header) = vts_signature
&& !cli.no_output_vts_signature
{
write_avb_header(&cli.output_vts_signature, header)?;
}
if let Some(text) = bootconfig {
if let Some(text) = bootconfig
&& !cli.no_output_bootconfig
{
write_text_if_not_empty(&cli.output_bootconfig, text)?;
}
for (i, data) in ramdisks.iter().enumerate() {
let mut path = cli.output_ramdisk_prefix.as_os_str().to_owned();
path.push(i.to_string());
if !cli.no_output_ramdisk {
for (i, data) in ramdisks.iter().enumerate() {
let mut path = cli.output_ramdisk_prefix.as_os_str().to_owned();
path.push(i.to_string());
write_data_if_not_empty(Path::new(&path), data)?;
write_data_if_not_empty(Path::new(&path), data)?;
}
}
Ok(())
@@ -341,6 +353,10 @@ struct UnpackCli {
#[arg(long, value_name = "FILE", value_parser, default_value = "kernel.img")]
output_kernel: PathBuf,
/// Do not output kernel image.
#[arg(long, conflicts_with = "output_kernel")]
no_output_kernel: bool,
/// Path prefix for output ramdisk images.
#[arg(
long,
@@ -350,10 +366,18 @@ struct UnpackCli {
)]
output_ramdisk_prefix: PathBuf,
/// Do not output ramdisk images.
#[arg(long, conflicts_with = "output_ramdisk_prefix")]
no_output_ramdisk: bool,
/// Path to output second stage bootloader image.
#[arg(long, value_name = "FILE", value_parser, default_value = "second.img")]
output_second: PathBuf,
/// Do not output second stage bootloader image.
#[arg(long, conflicts_with = "output_second")]
no_output_second: bool,
/// Path to output recovery dtbo/acpio image.
#[arg(
long,
@@ -363,10 +387,18 @@ struct UnpackCli {
)]
output_recovery_dtbo: PathBuf,
/// Do not output recovery dtbo/acpio image.
#[arg(long, conflicts_with = "output_recovery_dtbo")]
no_output_recovery_dtbo: bool,
/// Path to output device tree blob image.
#[arg(long, value_name = "FILE", value_parser, default_value = "dtb.img")]
output_dtb: PathBuf,
/// Do not output device tree blob image.
#[arg(long, conflicts_with = "output_dtb")]
no_output_dtb: bool,
/// Path to output VTS signature.
#[arg(
long,
@@ -376,6 +408,10 @@ struct UnpackCli {
)]
output_vts_signature: PathBuf,
/// Do not output VTS signature.
#[arg(long, conflicts_with = "output_vts_signature")]
no_output_vts_signature: bool,
/// Path to output bootconfig text.
#[arg(
long,
@@ -384,6 +420,10 @@ struct UnpackCli {
default_value = "bootconfig.txt"
)]
output_bootconfig: PathBuf,
/// Do not output bootconfig text.
#[arg(long, conflicts_with = "output_bootconfig")]
no_output_bootconfig: bool,
}
/// Pack a boot image.
+2 -4
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::io;
+34 -38
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
fs::{self, File},
@@ -11,9 +9,8 @@ use std::{
sync::atomic::AtomicBool,
};
use anyhow::{anyhow, Context, Result};
use anyhow::{Context, Result, anyhow};
use bstr::ByteSlice;
use cap_std::{ambient_authority, fs::Dir};
use clap::{Parser, Subcommand};
use num_traits::ToPrimitive;
use serde::{Deserialize, Serialize};
@@ -93,17 +90,17 @@ fn write_info(path: &Path, info: &CpioInfo) -> Result<()> {
/// Open reader to the corresponding file inside the tree if the entry is a
/// regular file. Unsafe paths will result in an error.
fn open_tree_file(tree: &Dir, entry: &CpioEntry) -> Result<Option<(BufReader<File>, u32)>> {
fn open_tree_file(tree: &Path, entry: &CpioEntry) -> Result<Option<(BufReader<File>, u32)>> {
if entry.file_type == CpioEntryType::Regular {
let path = entry
let sub_path = entry
.path
.as_bstr()
.to_path()
.with_context(|| format!("Invalid entry path: {:?}", entry.path.as_bstr()))?;
let path = util::path_join(tree, sub_path)?;
let mut reader = tree
.open(path)
.map(|f| BufReader::new(f.into_std()))
let mut reader = File::open(&path)
.map(BufReader::new)
.with_context(|| format!("Failed to open for reading: {path:?}"))?;
let file_size = reader
@@ -124,21 +121,21 @@ fn open_tree_file(tree: &Dir, entry: &CpioEntry) -> Result<Option<(BufReader<Fil
/// Open writer to the corresponding file inside the tree if the entry is a
/// regular file. Intermediate directories are automatically created as needed.
/// Unsafe paths will result in an error.
fn create_tree_file(tree: &Dir, entry: &CpioEntry) -> Result<Option<BufWriter<File>>> {
fn create_tree_file(tree: &Path, entry: &CpioEntry) -> Result<Option<BufWriter<File>>> {
if entry.file_type == CpioEntryType::Regular {
let path = entry
let sub_path = entry
.path
.as_bstr()
.to_path()
.with_context(|| format!("Invalid entry path: {:?}", entry.path.as_bstr()))?;
let parent = util::parent_path(path);
let path = util::path_join(tree, sub_path)?;
let parent = util::parent_path(&path);
tree.create_dir_all(parent)
fs::create_dir_all(parent)
.with_context(|| format!("Failed to create directory: {parent:?}"))?;
let writer = tree
.create(path)
.map(|f| BufWriter::new(f.into_std()))
let writer = File::create(&path)
.map(BufWriter::new)
.with_context(|| format!("Failed to open for writing: {path:?}"))?;
Ok(Some(writer))
@@ -173,25 +170,24 @@ fn unpack_subcommand(
display_format(cpio_cli, format);
let authority = ambient_authority();
Dir::create_ambient_dir_all(&cli.output_tree, authority)
.with_context(|| format!("Failed to create directory: {:?}", cli.output_tree))?;
let tree = Dir::open_ambient_dir(&cli.output_tree, authority)
.with_context(|| format!("Failed to open directory: {:?}", cli.output_tree))?;
if !cli.no_output_tree {
fs::create_dir_all(&cli.output_tree)
.with_context(|| format!("Failed to create directory: {:?}", cli.output_tree))?;
while let Some(entry) = reader.next_entry().context("Failed to read cpio entry")? {
display_entry(cpio_cli, &entry);
while let Some(entry) = reader.next_entry().context("Failed to read cpio entry")? {
display_entry(cpio_cli, &entry);
if let Some(mut writer) = create_tree_file(&tree, &entry)? {
let file_size = entry.data.size()?;
if let Some(mut writer) = create_tree_file(&cli.output_tree, &entry)? {
let file_size = entry.data.size()?;
stream::copy_n(&mut reader, &mut writer, file_size.into(), cancel_signal)
.context("Failed to copy data")?;
stream::copy_n(&mut reader, &mut writer, file_size.into(), cancel_signal)
.context("Failed to copy data")?;
writer.into_inner().context("Failed to flush data")?;
writer.into_inner().context("Failed to flush data")?;
}
info.entries.push(entry);
}
info.entries.push(entry);
}
write_info(&cli.output_info, &info)?;
@@ -211,12 +207,8 @@ fn pack_subcommand(cpio_cli: &CpioCli, cli: &PackCli, cancel_signal: &AtomicBool
cpio::assign_inodes(&mut info.entries, true)?;
let authority = ambient_authority();
let tree = Dir::open_ambient_dir(&cli.input_tree, authority)
.with_context(|| format!("Failed to open directory: {:?}", cli.input_tree))?;
for entry in &mut info.entries {
let out = open_tree_file(&tree, entry)?;
let out = open_tree_file(&cli.input_tree, entry)?;
if let Some((_, file_size)) = &out {
entry.data = CpioEntryData::Size(*file_size);
@@ -303,13 +295,17 @@ struct UnpackCli {
#[arg(short, long, value_name = "FILE", value_parser)]
input: PathBuf,
/// Path to output cpio info TOML.
/// Path to output info TOML.
#[arg(long, value_name = "FILE", value_parser, default_value = "cpio.toml")]
output_info: PathBuf,
/// Path to output files directory.
#[arg(long, value_name = "DIR", value_parser, default_value = "cpio_tree")]
output_tree: PathBuf,
/// Do not output files.
#[arg(long, conflicts_with = "output_tree")]
no_output_tree: bool,
}
/// Pack a cpio archive.
+5 -11
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
fs::{File, OpenOptions},
@@ -15,15 +13,14 @@ use clap::{Parser, Subcommand};
use crate::{
format::fec::FecImage,
stream::{FromReader, PSeekFile, ToWriter},
stream::{FromReader, ToWriter},
};
fn open_input(path: &Path, rw: bool) -> Result<PSeekFile> {
fn open_input(path: &Path, rw: bool) -> Result<File> {
OpenOptions::new()
.read(true)
.write(rw)
.open(path)
.map(PSeekFile::new)
.with_context(|| format!("Failed to open file: {path:?}"))
}
@@ -93,10 +90,7 @@ fn repair_subcommand(cli: &RepairCli, cancel_signal: &AtomicBool) -> Result<()>
let input = open_input(&cli.input, true)?;
let fec = read_fec(&cli.fec)?;
// The separate buffered readers and writers are safe because the function
// guarantees that every thread touches disjoint offsets and every offset is
// read and written at most once.
fec.repair(&input, &input, cancel_signal)
fec.repair(&input, cancel_signal)
.context("Failed to repair file")?;
Ok(())
+4 -7
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
fs::{File, OpenOptions},
@@ -15,15 +13,14 @@ use clap::{Parser, Subcommand};
use crate::{
format::hashtree::HashTreeImage,
stream::{FromReader, PSeekFile, ToWriter},
stream::{FromReader, ToWriter},
};
fn open_input(path: &Path, rw: bool) -> Result<PSeekFile> {
fn open_input(path: &Path, rw: bool) -> Result<File> {
OpenOptions::new()
.read(true)
.write(rw)
.open(path)
.map(PSeekFile::new)
.with_context(|| format!("Failed to open file: {path:?}"))
}
+16 -8
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
ffi::OsString,
@@ -48,13 +46,16 @@ pub fn key_main(cli: &KeyCli) -> Result<()> {
crypto::write_pem_cert_file(&c.output, &cert)
.with_context(|| format!("Failed to write certificate: {:?}", c.output))?;
}
KeyCommand::ExtractAvb(c) => {
KeyCommand::ExtractAvb(c) | KeyCommand::EncodeAvb(c) => {
let public_key = if let Some(p) = &c.input.key {
let passphrase = get_passphrase_source(&c.passphrase, p);
let private_key = crypto::read_pem_key_file(p, &passphrase)
.with_context(|| format!("Failed to load key: {p:?}"))?;
private_key.to_public_key()
} else if let Some(p) = &c.input.public_key {
crypto::read_pem_public_key_file(p)
.with_context(|| format!("Failed to load public key: {p:?}"))?
} else if let Some(p) = &c.input.cert {
let certificate = crypto::read_pem_cert_file(p)
.with_context(|| format!("Failed to load certificate: {p:?}"))?;
@@ -93,6 +94,10 @@ struct PublicKeyInputGroup {
#[arg(short, long, value_name = "FILE", value_parser)]
key: Option<PathBuf>,
/// Path to public key.
#[arg(short, long, value_name = "FILE", value_parser, conflicts_with_all = ["pass_env_var", "pass_file"])]
public_key: Option<PathBuf>,
/// Path to certificate.
#[arg(short, long, value_name = "FILE", value_parser, conflicts_with_all = ["pass_env_var", "pass_file"])]
cert: Option<PathBuf>,
@@ -145,12 +150,12 @@ struct GenerateCertCli {
validity: u64,
}
/// Extract the AVB public key from a private key or certificate.
/// Convert a key or certificate to an AVB-encoded public key.
///
/// The public key is stored in both the private key and the certificate. Either
/// one can be used interchangeably.
#[derive(Debug, Parser)]
struct ExtractAvbCli {
struct EncodeAvbCli {
/// Path to output AVB public key.
#[arg(short, long, value_name = "FILE", value_parser)]
output: PathBuf,
@@ -178,7 +183,10 @@ struct DecodeAvbCli {
enum KeyCommand {
GenerateKey(GenerateKeyCli),
GenerateCert(GenerateCertCli),
ExtractAvb(ExtractAvbCli),
/// (Deprecated: Use `avbroot key encode-avb` instead.)
#[command(hide = true)]
ExtractAvb(EncodeAvbCli),
EncodeAvb(EncodeAvbCli),
DecodeAvb(DecodeAvbCli),
}
+642
View File
@@ -0,0 +1,642 @@
// SPDX-FileCopyrightText: 2024-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
fs::{self, File},
io::{Seek, SeekFrom},
path::{Path, PathBuf},
sync::atomic::AtomicBool,
};
use anyhow::{Context, Result, bail};
use clap::{CommandFactory, Parser, Subcommand};
use rayon::iter::{
IndexedParallelIterator, IntoParallelIterator, IntoParallelRefIterator, ParallelIterator,
};
use crate::{
format::lp::{Extent, ExtentType, ImageType, Metadata, SECTOR_SIZE},
stream::{self, FromReader, ToWriter, UserPosFile},
util,
};
fn open_lp_inputs(paths: &[impl AsRef<Path>]) -> Result<(Vec<File>, Metadata)> {
let inputs = paths
.iter()
.map(|p| {
let p = p.as_ref();
File::open(p).with_context(|| format!("Failed to open LP image for reading: {p:?}"))
})
.collect::<Result<Vec<_>>>()?;
let metadata = Metadata::from_reader(&inputs[0])
.with_context(|| format!("Failed to parse LP image metadata: {:?}", paths[0].as_ref()))?;
Ok((inputs, metadata))
}
fn open_lp_outputs(paths: &[impl AsRef<Path>]) -> Result<Vec<File>> {
paths
.iter()
.map(|p| {
let p = p.as_ref();
File::create(p).with_context(|| format!("Failed to open LP image for writing: {p:?}"))
})
.collect::<Result<Vec<_>>>()
}
fn read_info(path: &Path) -> Result<Metadata> {
let data = fs::read_to_string(path)
.with_context(|| format!("Failed to read metadata info TOML: {path:?}"))?;
let info = toml_edit::de::from_str(&data)
.with_context(|| format!("Failed to parse metadata info TOML: {path:?}"))?;
Ok(info)
}
fn write_info(path: &Path, metadata: &Metadata) -> Result<()> {
let data = toml_edit::ser::to_string_pretty(metadata)
.with_context(|| format!("Failed to serialize metadata info TOML: {path:?}"))?;
fs::write(path, data)
.with_context(|| format!("Failed to write metadata info TOML: {path:?}"))?;
Ok(())
}
fn display_metadata(cli: &LpCli, metadata: &Metadata) {
if !cli.quiet {
println!("{metadata:#?}");
}
}
struct CopyExtent {
device_index: usize,
lp_offset: u64,
out_offset: u64,
size: u64,
}
/// Split extents into smaller ones for parallelization.
fn split_extents(extents: &[Extent]) -> Vec<CopyExtent> {
// 64 MiB is the smallest size we'll parallelize by.
const CHUNK_SIZE: u64 = 64 * 1024 * 1024;
let mut result = vec![];
let mut out_offset = 0;
for extent in extents {
let mut remain = extent.num_sectors * u64::from(SECTOR_SIZE);
match extent.extent_type {
ExtentType::Linear {
start_sector,
block_device_index,
} => {
let mut lp_offset = start_sector * u64::from(SECTOR_SIZE);
// 64 MiB is the smallest size we'll parallelize by.
let num_chunks = remain.div_ceil(64 * 1024 * 1024);
for _ in 0..num_chunks {
let chunk_size = CHUNK_SIZE.min(remain);
result.push(CopyExtent {
device_index: block_device_index,
out_offset,
lp_offset,
size: chunk_size,
});
out_offset += chunk_size;
lp_offset += chunk_size;
remain -= chunk_size;
}
}
ExtentType::Zero => out_offset += remain,
}
}
result
}
/// Use the CLI-specified slot or automatically select one if all slots are
/// identical.
fn get_slot_number(metadata: &Metadata, cli_slot: Option<u32>) -> Result<usize> {
if let Some(n) = cli_slot {
let n = n as usize;
if n >= metadata.slots.len() {
bail!("Slot out of range: {n}");
}
Ok(n)
} else {
if metadata.slots.windows(2).any(|w| w[0] != w[1]) {
bail!("A slot must be specified because they are not all identical");
}
Ok(0)
}
}
/// Remove all slots aside from the specified one and return the old slot count.
fn retain_slot(metadata: &mut Metadata, slot: usize) -> usize {
let slot_count = metadata.slots.len();
metadata.slots.swap(0, slot);
metadata.slots.truncate(1);
slot_count
}
/// Duplicate the first slot until the required number of slots is reached.
fn fill_slots(metadata: &mut Metadata) {
let required = match metadata.image_type {
ImageType::Normal => metadata.metadata_slot_count as usize,
ImageType::Empty => 1,
};
for _ in metadata.slots.len()..required {
metadata.slots.extend_from_within(0..=0);
}
}
fn unpack_subcommand(lp_cli: &LpCli, cli: &UnpackCli, cancel_signal: &AtomicBool) -> Result<()> {
let inputs = cli
.input
.iter()
.map(|p| {
File::open(p).with_context(|| format!("Failed to open LP image for reading: {p:?}"))
})
.collect::<Result<Vec<_>>>()?;
let mut metadata = Metadata::from_reader(&inputs[0])
.with_context(|| format!("Failed to read LP image metadata: {:?}", cli.input[0]))?;
// Display and write only the selected slot.
let slot_number = get_slot_number(&metadata, cli.slot)?;
retain_slot(&mut metadata, slot_number);
display_metadata(lp_cli, &metadata);
write_info(&cli.output_info, &metadata)?;
// For empty images, there's no data to unpack.
if metadata.image_type == ImageType::Empty || cli.no_output_images {
return Ok(());
}
fs::create_dir_all(&cli.output_images)
.with_context(|| format!("Failed to create directory: {:?}", cli.output_images))?;
let slot = &metadata.slots[0];
if slot.block_devices.len() != inputs.len() {
bail!(
"Need {} input images, but have {}",
slot.block_devices.len(),
inputs.len(),
);
}
// Preopen all image output files.
let mut paths = vec![];
let mut files = vec![];
for group in &slot.groups {
let mut group_paths = vec![];
let mut group_files = vec![];
for partition in &group.partitions {
// A partition name with unsafe characters fails during parsing.
let path =
util::path_join_single(&cli.output_images, format!("{}.img", partition.name))?;
let file = File::create(&path)
.with_context(|| format!("Failed to open for writing: {path:?}"))?;
file.set_len(partition.size()?)
.with_context(|| format!("Failed to truncate file: {path:?}"))?;
group_paths.push(path);
group_files.push(file);
}
paths.push(group_paths);
files.push(group_files);
}
slot.groups
.par_iter()
.enumerate()
// Flatten grouped partitions.
.flat_map(|(g_index, g)| {
g.partitions
.par_iter()
.enumerate()
.map(move |(p_index, p)| (g_index, p_index, p))
})
// Flatten extents in all partitions and split them to smaller chunks
// for better parallelism.
.flat_map(|(g_index, p_index, p)| {
split_extents(&p.extents)
.into_par_iter()
.map(move |e| (g_index, p_index, e))
})
.try_for_each(|(g_index, p_index, extent)| {
let mut reader = UserPosFile::new(&inputs[extent.device_index]);
let mut writer = UserPosFile::new(&files[g_index][p_index]);
let r_path = &cli.input[extent.device_index];
let w_path = &paths[g_index][p_index];
reader
.seek(SeekFrom::Start(extent.lp_offset))
.with_context(|| format!("Failed to seek file: {r_path:?}"))?;
writer
.seek(SeekFrom::Start(extent.out_offset))
.with_context(|| format!("Failed to seek file: {w_path:?}"))?;
stream::copy_n(&mut reader, &mut writer, extent.size, cancel_signal)
.with_context(|| format!("Failed to copy extent: {r_path:?} -> {w_path:?}"))?;
Ok(())
})
}
fn pack_subcommand(lp_cli: &LpCli, cli: &PackCli, cancel_signal: &AtomicBool) -> Result<()> {
let mut metadata = read_info(&cli.input_info)?;
if metadata.slots.len() != 1 {
bail!("There must be exactly one metadata slot");
}
let slot = &mut metadata.slots[0];
let mut outputs = open_lp_outputs(&cli.output)?;
if slot.block_devices.len() != outputs.len() {
bail!(
"Need {} output images, but have {}",
slot.block_devices.len(),
outputs.len(),
);
}
if metadata.image_type == ImageType::Normal {
for (i, (block_device, output)) in slot.block_devices.iter().zip(&outputs).enumerate() {
output
.set_len(block_device.size)
.with_context(|| format!("Failed to truncate file: {:?}", cli.output[i]))?;
}
}
// Preopen all image input files.
let mut paths = vec![];
let mut files = vec![];
if metadata.image_type == ImageType::Normal {
for group in &mut slot.groups {
let mut group_paths = vec![];
let mut group_files = vec![];
for partition in &mut group.partitions {
let path =
util::path_join_single(&cli.input_images, format!("{}.img", partition.name))?;
let mut file = File::open(&path)
.with_context(|| format!("Failed to open for reading: {path:?}"))?;
let size = file
.seek(SeekFrom::End(0))
.with_context(|| format!("Failed to seek file: {path:?}"))?;
if size % u64::from(SECTOR_SIZE) != 0 {
bail!("File size is not {SECTOR_SIZE}B aligned: {size}: {path:?}");
}
// This will be filled out properly later during reallocation.
partition.extents.push(Extent {
num_sectors: size / u64::from(SECTOR_SIZE),
extent_type: ExtentType::Linear {
start_sector: 0,
block_device_index: 0,
},
});
group_paths.push(path);
group_files.push(file);
}
paths.push(group_paths);
files.push(group_files);
}
// Now that we have all the partition sizes, actually allocate extents
// for them on the block devices.
slot.reallocate_extents()
.context("Failed to allocate extents")?;
}
// Display only the selected slot and make the rest identical.
let _ = slot;
display_metadata(lp_cli, &metadata);
fill_slots(&mut metadata);
let slot = &metadata.slots[0];
// Write the new metadata.
metadata
.to_writer(&mut outputs[0])
.with_context(|| format!("Failed to write LP image metadata: {:?}", cli.output[0]))?;
// For empty images, there's no data to pack.
if metadata.image_type == ImageType::Empty {
return Ok(());
}
slot.groups
.par_iter()
.enumerate()
// Flatten grouped partitions.
.flat_map(|(g_index, g)| {
g.partitions
.par_iter()
.enumerate()
.map(move |(p_index, p)| (g_index, p_index, p))
})
// Flatten extents in all partitions and split them to smaller chunks
// for better parallelism.
.flat_map(|(g_index, p_index, p)| {
split_extents(&p.extents)
.into_par_iter()
.map(move |e| (g_index, p_index, e))
})
.try_for_each(|(g_index, p_index, extent)| {
let mut reader = UserPosFile::new(&files[g_index][p_index]);
let mut writer = UserPosFile::new(&outputs[extent.device_index]);
let r_path = &paths[g_index][p_index];
let w_path = &cli.output[extent.device_index];
reader
.seek(SeekFrom::Start(extent.out_offset))
.with_context(|| format!("Failed to seek file: {r_path:?}"))?;
writer
.seek(SeekFrom::Start(extent.lp_offset))
.with_context(|| format!("Failed to seek file: {w_path:?}"))?;
stream::copy_n(&mut reader, &mut writer, extent.size, cancel_signal)
.with_context(|| format!("Failed to copy extent: {r_path:?} -> {w_path:?}"))?;
Ok(())
})
}
fn repack_subcommand(lp_cli: &LpCli, cli: &RepackCli, cancel_signal: &AtomicBool) -> Result<()> {
// Show a clap-style error if the number of inputs and outputs aren't equal.
if cli.input.len() != cli.output.len() {
let (arg_id, actual_len, expected_len) = if cli.input.len() < cli.output.len() {
("input", cli.input.len(), cli.output.len())
} else {
("output", cli.output.len(), cli.input.len())
};
let mut command = RepackCli::command();
command.build();
let arg = command
.get_arguments()
.find(|a| a.get_id() == arg_id)
.expect("argument not found");
let mut error =
clap::Error::new(clap::error::ErrorKind::WrongNumberOfValues).with_cmd(&command);
error.insert(
clap::error::ContextKind::InvalidArg,
clap::error::ContextValue::String(arg.to_string()),
);
error.insert(
clap::error::ContextKind::ActualNumValues,
clap::error::ContextValue::Number(actual_len as isize),
);
error.insert(
clap::error::ContextKind::ExpectedNumValues,
clap::error::ContextValue::Number(expected_len as isize),
);
// We don't show the usage because only Command::_build_subcommand() can
// create an appropriate Command instance for showing the subcommand
// usage and there's no way to call that, directly or indirectly.
error.exit();
}
let (inputs, mut metadata) = open_lp_inputs(&cli.input)?;
let mut outputs = open_lp_outputs(&cli.output)?;
// Display only the selected slot and make the rest identical.
let slot_number = get_slot_number(&metadata, cli.slot)?;
retain_slot(&mut metadata, slot_number);
display_metadata(lp_cli, &metadata);
fill_slots(&mut metadata);
let slot = &metadata.slots[0];
if slot.block_devices.len() != inputs.len() {
bail!(
"Need {} images, but have {}",
slot.block_devices.len(),
inputs.len(),
);
}
// Write the new metadata.
metadata
.to_writer(&mut outputs[0])
.with_context(|| format!("Failed to write LP image metadata: {:?}", cli.output[0]))?;
// Explicitly set the file size in case there are dm-zero extents, which are
// ignored below.
if metadata.image_type == ImageType::Normal {
for (i, (block_device, output)) in slot.block_devices.iter().zip(&outputs).enumerate() {
output
.set_len(block_device.size)
.with_context(|| format!("Failed to truncate file: {:?}", cli.output[i]))?;
}
}
slot.groups
.par_iter()
// Flatten grouped partitions.
.flat_map(|group| &group.partitions)
// Flatten extents in all partitions and split them to smaller chunks
// for better parallelism.
.flat_map(|partition| split_extents(&partition.extents))
.try_for_each(|extent| {
let mut reader = UserPosFile::new(&inputs[extent.device_index]);
let mut writer = UserPosFile::new(&outputs[extent.device_index]);
let r_path = &cli.input[extent.device_index];
let w_path = &cli.output[extent.device_index];
reader
.seek(SeekFrom::Start(extent.lp_offset))
.with_context(|| format!("Failed to seek file: {r_path:?}"))?;
writer
.seek(SeekFrom::Start(extent.lp_offset))
.with_context(|| format!("Failed to seek file: {w_path:?}"))?;
stream::copy_n(&mut reader, &mut writer, extent.size, cancel_signal)
.with_context(|| format!("Failed to copy extent: {r_path:?} -> {w_path:?}"))?;
Ok(())
})
}
fn info_subcommand(lp_cli: &LpCli, cli: &InfoCli) -> Result<()> {
let (_, metadata) = open_lp_inputs(&[&cli.input])?;
// Unlike the other subcommands, we show all metadata slots here.
display_metadata(lp_cli, &metadata);
Ok(())
}
pub fn lp_main(cli: &LpCli, cancel_signal: &AtomicBool) -> Result<()> {
match &cli.command {
LpCommand::Unpack(c) => unpack_subcommand(cli, c, cancel_signal),
LpCommand::Pack(c) => pack_subcommand(cli, c, cancel_signal),
LpCommand::Repack(c) => repack_subcommand(cli, c, cancel_signal),
LpCommand::Info(c) => info_subcommand(cli, c),
}
}
/// Unpack an LP image.
///
/// The LP image metadata is written to the info TOML file. For normal images,
/// each partition is extracted to `<partition name>.img` in the output images
/// directory. For empty images, the output images directory is unused.
///
/// If any partition names are unsafe to use in a path, the extraction process
/// will fail and exit. Extracted files are never written outside of the tree
/// directory, even if an external process tries to interfere.
#[derive(Debug, Parser)]
struct UnpackCli {
/// Path to input LP images.
///
/// If there are multiple images, they must be specified in order. If the
/// order is unknown, run `avbroot lp info` against the `super` image and
/// look at the `block_devices` field.
#[arg(short, long, value_name = "FILE", value_parser, required = true)]
input: Vec<PathBuf>,
/// Path to output info TOML.
#[arg(long, value_name = "FILE", value_parser, default_value = "lp.toml")]
output_info: PathBuf,
/// Path to output images directory.
#[arg(long, value_name = "DIR", value_parser, default_value = "lp_images")]
output_images: PathBuf,
/// Do not output images.
#[arg(long, conflicts_with = "output_images")]
no_output_images: bool,
/// The LP metadata slot to use.
///
/// This slot is the only slot where data extents are copied from. Any data
/// referenced exclusively by other slots (if any) will be ignored.
///
/// This option is required if not all slots are identical.
#[arg(short, long)]
slot: Option<u32>,
}
/// Pack an LP image.
///
/// For normal images, the number of metadata slots written is equal to the
/// `metadata_slot_count` value in the info TOML. Each slot has identical
/// metadata. It is not possible to write multiple slots with different metadata
/// using this tool. For empty images, only a single slot is written, regardless
/// of the value of `metadata_slot_count`, as required by the file format.
///
/// The new LP image will *only* contain images listed in the info TOML file and
/// they are added in the order listed. The input images directory is not used
/// when packing an empty image.
#[derive(Debug, Parser)]
struct PackCli {
/// Path to output LP images.
///
/// If there are multiple images, they must be specified in the same order
/// as the block device entries are listed in the info TOML.
#[arg(short, long, value_name = "FILE", value_parser, required = true)]
output: Vec<PathBuf>,
/// Path to input info TOML.
#[arg(long, value_name = "FILE", value_parser, default_value = "lp.toml")]
input_info: PathBuf,
/// Path to input images directory.
#[arg(long, value_name = "DIR", value_parser, default_value = "lp_images")]
input_images: PathBuf,
}
/// Repack an LP image.
///
/// This command is equivalent to running `unpack` and `pack`, except without
/// storing the unpacked data to disk.
#[derive(Debug, Parser)]
struct RepackCli {
/// Path to input LP images.
///
/// If there are multiple images, they must be specified in order. If the
/// order is unknown, run `avbroot lp info` against the `super` image and
/// look at the `block_devices` field.
#[arg(short, long, value_name = "FILE", value_parser, required = true)]
input: Vec<PathBuf>,
/// Path to output LP images.
///
/// The number of output images must equal the number of input images.
#[arg(short, long, value_name = "FILE", value_parser, required = true)]
output: Vec<PathBuf>,
/// The LP metadata slot to use.
///
/// This slot is the only slot where data extents are copied to the output
/// images. Any data referenced exclusively by other slots (if any) will be
/// ignored.
///
/// This option is required if not all slots are identical.
#[arg(short, long)]
slot: Option<u32>,
}
/// Display LP image metadata.
#[derive(Debug, Parser)]
struct InfoCli {
/// Path to input LP image.
///
/// If there are multiple images, this should refer to the first one, which
/// is usually the `super` image. The other images are not needed when
/// inspecting the metadata because the metadata is only stored in the first
/// image.
#[arg(short, long, value_name = "FILE", value_parser)]
input: PathBuf,
}
#[derive(Debug, Subcommand)]
enum LpCommand {
Unpack(UnpackCli),
Pack(PackCli),
Repack(RepackCli),
Info(InfoCli),
}
/// Pack, unpack, and inspect LP images.
#[derive(Debug, Parser)]
pub struct LpCli {
#[command(subcommand)]
command: LpCommand,
/// Don't print LP metadata information.
#[arg(short, long, global = true)]
quiet: bool,
}
+4 -4
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
pub mod args;
pub mod avb;
@@ -11,5 +9,7 @@ pub mod cpio;
pub mod fec;
pub mod hashtree;
pub mod key;
pub mod lp;
pub mod ota;
pub mod payload;
pub mod sparse;
+1010 -490
View File
File diff suppressed because it is too large Load Diff
+450 -17
View File
@@ -1,33 +1,459 @@
/*
* SPDX-FileCopyrightText: 2024 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2024-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{fs::File, io::BufReader, path::PathBuf};
use std::{
collections::HashMap,
ffi::OsString,
fs::{self, File},
io::{BufReader, BufWriter, Seek, SeekFrom},
path::{Path, PathBuf},
sync::{Arc, atomic::AtomicBool},
};
use anyhow::{Context, Result};
use clap::{Parser, Subcommand};
use anyhow::{Context, Result, anyhow, bail};
use clap::{Args, Parser, Subcommand};
use tracing::info;
use crate::{format::payload::PayloadHeader, stream::FromReader};
use crate::{
cli::ota,
crypto::{self, PassphraseSource, RsaSigningKey},
format::payload::{PayloadHeader, PayloadWriter},
stream::{self, FromReader},
util,
};
fn info_subcommand(cli: &InfoCli) -> Result<()> {
let mut reader = File::open(&cli.input)
fn open_reader(path: &Path, allow_delta: bool) -> Result<(BufReader<File>, PayloadHeader)> {
let mut reader = File::open(path)
.map(BufReader::new)
.with_context(|| format!("Failed to open payload: {:?}", cli.input))?;
.with_context(|| format!("Failed to open payload for reading: {path:?}"))?;
let header = PayloadHeader::from_reader(&mut reader)
.with_context(|| format!("Failed to read payload: {:?}", cli.input))?;
.with_context(|| format!("Failed to read payload header: {path:?}"))?;
if !allow_delta && !header.is_full_ota() {
bail!("Payload is a delta OTA, not a full OTA");
}
println!("{header:#?}");
Ok((reader, header))
}
fn open_writer(
path: &Path,
header: PayloadHeader,
key: RsaSigningKey,
) -> Result<PayloadWriter<BufWriter<File>>> {
let writer = File::create(path)
.map(BufWriter::new)
.with_context(|| format!("Failed to open payload for writing: {path:?}"))?;
let payload_writer = PayloadWriter::new(writer, header, key)
.with_context(|| format!("Failed to write payload header: {path:?}"))?;
Ok(payload_writer)
}
fn read_info(path: &Path) -> Result<PayloadHeader> {
let data = fs::read_to_string(path)
.with_context(|| format!("Failed to read payload info TOML: {path:?}"))?;
let info = toml_edit::de::from_str(&data)
.with_context(|| format!("Failed to parse payload info TOML: {path:?}"))?;
Ok(info)
}
fn write_info(path: &Path, manifest: &PayloadHeader) -> Result<()> {
let data = toml_edit::ser::to_string_pretty(manifest)
.with_context(|| format!("Failed to serialize payload info TOML: {path:?}"))?;
fs::write(path, data)
.with_context(|| format!("Failed to write payload info TOML: {path:?}"))?;
Ok(())
}
pub fn payload_main(cli: &PayloadCli) -> Result<()> {
match &cli.command {
PayloadCommand::Info(c) => info_subcommand(c),
fn display_header(cli: &PayloadCli, header: &PayloadHeader) {
if !cli.quiet {
println!("{header:#?}");
}
}
fn load_key(group: &KeyGroup) -> Result<RsaSigningKey> {
let source = PassphraseSource::new(
&group.key,
group.pass_file.as_deref(),
group.pass_env_var.as_deref(),
);
let signing_key = if let Some(helper) = &group.signing_helper {
let public_key = crypto::read_pem_public_key_file(&group.key)
.with_context(|| format!("Failed to load key: {:?}", group.key))?;
RsaSigningKey::External {
program: helper.clone(),
public_key_file: group.key.clone(),
public_key,
passphrase_source: source,
}
} else {
let private_key = crypto::read_pem_key_file(&group.key, &source)
.with_context(|| format!("Failed to load key: {:?}", group.key))?;
RsaSigningKey::Internal(private_key)
};
Ok(signing_key)
}
fn unpack_subcommand(
payload_cli: &PayloadCli,
cli: &UnpackCli,
cancel_signal: &AtomicBool,
) -> Result<()> {
let (mut reader, header) = open_reader(&cli.input, false)?;
let payload_size = reader
.seek(SeekFrom::End(0))
.with_context(|| format!("Failed to get file size: {:?}", cli.input))?;
display_header(payload_cli, &header);
write_info(&cli.output_info, &header)?;
if !cli.no_output_images {
fs::create_dir_all(&cli.output_images)
.with_context(|| format!("Failed to create directory: {:?}", cli.output_images))?;
ota::extract_payload(
&reader.into_inner(),
&cli.output_images,
0,
payload_size,
&header,
&header
.manifest
.partitions
.iter()
.map(|p| &p.partition_name)
.cloned()
.collect(),
cancel_signal,
)?;
}
Ok(())
}
fn pack_subcommand(
payload_cli: &PayloadCli,
cli: &PackCli,
cancel_signal: &AtomicBool,
) -> Result<()> {
let signing_key = load_key(&cli.key)?;
let mut header = read_info(&cli.input_info)?;
// Pre-open all of the image files.
let input_files = header
.manifest
.partitions
.iter()
.map(|p| {
let path =
util::path_join_single(&cli.input_images, format!("{}.img", p.partition_name))?;
let file = File::open(&path)
.map(Arc::new)
.with_context(|| format!("Failed to open file: {path:?}"))?;
Ok((p.partition_name.clone(), file))
})
.collect::<Result<HashMap<_, _>>>()?;
for (name, input_file) in &input_files {
let Some(dpm) = &header.manifest.dynamic_partition_metadata else {
continue;
};
if !dpm.groups.iter().any(|g| g.partition_names.contains(name)) {
continue;
}
header
.manifest
.partitions
.iter_mut()
.find(|p| p.partition_name == *name)
.unwrap()
.estimate_cow_size = Some(0);
ota::recow_image(name, input_file, &mut header, cancel_signal)?;
}
// Compress the images and compute the list of install operations for
// insertion into the payload header. The compressed data is stored in new
// temp files and the original input files are dropped.
let mut compressed_files = input_files
.into_iter()
.map(|(name, mut input_file)| {
ota::compress_image(&name, &mut input_file, &mut header, None, cancel_signal)
.with_context(|| format!("Failed to compress image: {name}"))?;
Ok((name, input_file))
})
.collect::<Result<HashMap<_, _>>>()?;
info!("Generating new OTA payload");
// Now we can write the actual payload. With everything precomputed, this is
// mostly just a simple copy.
let mut payload_writer = open_writer(&cli.output, header.clone(), signing_key)?;
while payload_writer
.begin_next_operation()
.context("Failed to begin next payload blob entry")?
{
let name = payload_writer.partition().unwrap().partition_name.clone();
let operation = payload_writer.operation().unwrap();
let Some(data_length) = operation.data_length else {
// Otherwise, this is a ZERO/DISCARD operation.
continue;
};
let pi = payload_writer.partition_index().unwrap();
let oi = payload_writer.operation_index().unwrap();
let orig_partition = &header.manifest.partitions[pi];
let orig_operation = &orig_partition.operations[oi];
let data_offset = orig_operation
.data_offset
.ok_or_else(|| anyhow!("Missing data_offset in partition #{pi} operation #{oi}"))?;
// The compressed chunks are laid out sequentially and data_offset is
// set to the offset within that file.
let Some(input_file) = compressed_files.get_mut(&name) else {
unreachable!("Compressed data not found for image: {name}");
};
input_file
.seek(SeekFrom::Start(data_offset))
.with_context(|| format!("Failed to seek image: {name}"))?;
stream::copy_n(input_file, &mut payload_writer, data_length, cancel_signal)
.with_context(|| format!("Failed to copy from replacement image: {name}"))?;
}
let (_, header, properties, _) = payload_writer
.finish()
.context("Failed to finalize payload")?;
// Display the header information now that it has been finalized.
display_header(payload_cli, &header);
// Optionally, write payload_properties.txt.
if let Some(path) = &cli.output_properties {
fs::write(path, properties)
.with_context(|| format!("Failed to write payload properties: {path:?}"))?;
}
Ok(())
}
fn repack_subcommand(
payload_cli: &PayloadCli,
cli: &RepackCli,
cancel_signal: &AtomicBool,
) -> Result<()> {
let signing_key = load_key(&cli.key)?;
let (mut reader, header) = open_reader(&cli.input, true)?;
info!("Generating new OTA payload");
let mut payload_writer = open_writer(&cli.output, header.clone(), signing_key)?;
while payload_writer
.begin_next_operation()
.context("Failed to begin next payload blob entry")?
{
let name = payload_writer.partition().unwrap().partition_name.clone();
let operation = payload_writer.operation().unwrap();
let Some(data_length) = operation.data_length else {
// Otherwise, this is a ZERO/DISCARD operation.
continue;
};
let pi = payload_writer.partition_index().unwrap();
let oi = payload_writer.operation_index().unwrap();
let orig_partition = &header.manifest.partitions[pi];
let orig_operation = &orig_partition.operations[oi];
let data_offset = orig_operation
.data_offset
.ok_or_else(|| anyhow!("Missing data_offset in partition #{pi} operation #{oi}"))?;
// Directly copy blobs from the original payload.
let data_offset = data_offset
.checked_add(header.blob_offset)
.ok_or_else(|| anyhow!("data_offset overflow in partition #{pi} operation #{oi}"))?;
reader
.seek(SeekFrom::Start(data_offset))
.with_context(|| format!("Failed to seek original payload to {data_offset}"))?;
stream::copy_n(&mut reader, &mut payload_writer, data_length, cancel_signal)
.with_context(|| format!("Failed to copy from original payload: {name}"))?;
}
let (_, header, properties, _) = payload_writer
.finish()
.context("Failed to finalize payload")?;
// Display the header information now that it has been finalized.
display_header(payload_cli, &header);
// Optionally, write payload_properties.txt.
if let Some(path) = &cli.output_properties {
fs::write(path, properties)
.with_context(|| format!("Failed to write payload properties: {path:?}"))?;
}
Ok(())
}
fn info_subcommand(payload_cli: &PayloadCli, cli: &InfoCli) -> Result<()> {
let (_, header) = open_reader(&cli.input, true)?;
display_header(payload_cli, &header);
Ok(())
}
pub fn payload_main(cli: &PayloadCli, cancel_signal: &AtomicBool) -> Result<()> {
match &cli.command {
PayloadCommand::Unpack(c) => unpack_subcommand(cli, c, cancel_signal),
PayloadCommand::Pack(c) => pack_subcommand(cli, c, cancel_signal),
PayloadCommand::Repack(c) => repack_subcommand(cli, c, cancel_signal),
PayloadCommand::Info(c) => info_subcommand(cli, c),
}
}
#[derive(Debug, Args)]
struct KeyGroup {
/// Path to signing key.
///
/// This should normally be a private key. However, if --signing-helper is
/// used, then it should be a public key instead.
#[arg(short, long, value_name = "FILE", value_parser)]
key: PathBuf,
/// Environment variable containing private key passphrase.
#[arg(long, value_name = "ENV_VAR", value_parser, group = "pass")]
pass_env_var: Option<OsString>,
/// File containing private key passphrase.
#[arg(long, value_name = "FILE", value_parser, group = "pass")]
pass_file: Option<PathBuf>,
/// External program for signing.
///
/// If this option is specified, then --key must refer to a public key. The
/// program will be invoked as:
///
/// <program> <algo> <public key> [file <pass file>|env <pass env>]
#[arg(long, value_name = "PROGRAM", value_parser)]
signing_helper: Option<PathBuf>,
}
/// Unpack a payload binary.
///
/// Each partition is extracted to `<partition name>.img` in the output images
/// directory. The payload header metadata is written to the info TOML file.
///
/// If any partition names are unsafe to use in a path, the extraction process
/// will fail and exit. Extracted files are never written outside of the tree
/// directory, even if an external process tries to interfere.
#[derive(Debug, Parser)]
struct UnpackCli {
/// Path to input payload binary.
#[arg(short, long, value_name = "FILE", value_parser)]
input: PathBuf,
/// Path to output info TOML.
#[arg(
long,
value_name = "FILE",
value_parser,
default_value = "payload.toml"
)]
output_info: PathBuf,
/// Path to output images directory.
#[arg(
long,
value_name = "DIR",
value_parser,
default_value = "payload_images"
)]
output_images: PathBuf,
/// Do not output images.
#[arg(long, conflicts_with = "output_images")]
no_output_images: bool,
}
/// Pack a payload binary.
///
/// The new payload binary will *only* contain images listed in the info TOML
/// file. Extra images in the input images directory that aren't listed will be
/// silently ignored. Images are added to the payload in the order that they are
/// listed in the info TOML file.
#[derive(Debug, Parser)]
struct PackCli {
/// Path to output payload binary.
#[arg(short, long, value_name = "FILE", value_parser)]
output: PathBuf,
/// Path to output payload properties file.
#[arg(short, long, value_name = "FILE", value_parser)]
output_properties: Option<PathBuf>,
/// Path to input info TOML.
#[arg(
long,
value_name = "FILE",
value_parser,
default_value = "payload.toml"
)]
input_info: PathBuf,
/// Path to input images directory.
#[arg(
long,
value_name = "DIR",
value_parser,
default_value = "payload_images"
)]
input_images: PathBuf,
#[command(flatten)]
key: KeyGroup,
}
/// Repack a payload binary.
///
/// This command is equivalent to running `unpack` and `pack`, except without
/// storing the unpacked data to disk nor recompressing the partition images.
#[derive(Debug, Parser)]
struct RepackCli {
/// Path to input payload binary.
#[arg(short, long, value_name = "FILE", value_parser)]
input: PathBuf,
/// Path to output payload binary.
#[arg(short, long, value_name = "FILE", value_parser)]
output: PathBuf,
/// Path to output payload properties file.
#[arg(short, long, value_name = "FILE", value_parser)]
output_properties: Option<PathBuf>,
#[command(flatten)]
key: KeyGroup,
}
/// Display payload information.
#[derive(Debug, Parser)]
struct InfoCli {
@@ -38,12 +464,19 @@ struct InfoCli {
#[derive(Debug, Subcommand)]
enum PayloadCommand {
Unpack(UnpackCli),
Pack(PackCli),
Repack(RepackCli),
Info(InfoCli),
}
/// Inspect OTA payloads.
/// Pack, unpack, and inspect OTA payloads.
#[derive(Debug, Parser)]
pub struct PayloadCli {
#[command(subcommand)]
command: PayloadCommand,
/// Don't print payload header information.
#[arg(short, long, global = true)]
quiet: bool,
}
+631
View File
@@ -0,0 +1,631 @@
// SPDX-FileCopyrightText: 2024-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
fmt,
fs::{File, OpenOptions},
io::{Read, Seek, SeekFrom, Write},
ops::Range,
path::{Path, PathBuf},
sync::atomic::AtomicBool,
};
use anyhow::{Context, Result, anyhow, bail};
use clap::{Parser, Subcommand};
use crc32fast::Hasher;
use zerocopy::{IntoBytes, little_endian};
use crate::{
format::{
padding,
sparse::{
self, Chunk, ChunkBounds, ChunkData, ChunkList, CrcMode, Header, SparseReader,
SparseWriter,
},
},
stream,
};
struct CompactView<'a, T>(&'a [T]);
impl<T: fmt::Debug> fmt::Debug for CompactView<'_, T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut list = f.debug_list();
for item in self.0 {
// No alternate mode for no inner newlines.
list.entry(&format_args!("{item:?}"));
}
list.finish()
}
}
#[derive(Clone)]
struct Metadata {
header: Header,
chunks: Vec<Chunk>,
}
impl fmt::Debug for Metadata {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Metadata")
.field("header", &self.header)
.field("chunks", &CompactView(&self.chunks))
.finish()
}
}
fn open_reader(path: &Path) -> Result<File> {
File::open(path).with_context(|| format!("Failed to open for reading: {path:?}"))
}
fn open_writer(path: &Path, truncate: bool) -> Result<File> {
OpenOptions::new()
.write(true)
.create(true)
.truncate(truncate)
.open(path)
.with_context(|| format!("Failed to open for writing: {path:?}"))
}
fn display_metadata(cli: &SparseCli, metadata: &Metadata) {
if !cli.quiet {
println!("{metadata:#?}");
}
}
/// Splits large data chunks to ensure that none exceed 64 MiB. This is not
/// necessary in most cases, but is kept to match the behavior of AOSP's
/// libsparse.
fn split_chunks(chunks: &[Chunk], block_size: u32) -> Vec<Chunk> {
const MAX_BYTES: u32 = 64 * 1024 * 1024;
let max_blocks_per_chunk = MAX_BYTES / block_size;
let mut result = vec![];
for mut chunk in chunks.iter().copied() {
if chunk.data == ChunkData::Data {
while chunk.bounds.len() > max_blocks_per_chunk {
result.push(Chunk {
bounds: ChunkBounds {
start: chunk.bounds.start,
end: chunk.bounds.start + max_blocks_per_chunk,
},
data: chunk.data,
});
chunk.bounds.start += max_blocks_per_chunk;
}
}
result.push(chunk);
}
result
}
/// [Linux only] Find allocated regions of the file. This avoids needing to read
/// unused portions of the file if it is a native sparse file.
#[cfg(any(target_os = "linux", target_os = "android"))]
fn find_allocated_regions(
path: &Path,
reader: &File,
cancel_signal: &AtomicBool,
) -> Result<Vec<Range<u64>>> {
use rustix::{fs::SeekFrom, io::Errno};
let mut result = vec![];
let mut start;
let mut end = 0;
loop {
stream::check_cancel(cancel_signal)?;
start = match rustix::fs::seek(reader, SeekFrom::Data(end)) {
Ok(offset) => offset,
Err(e) if e == Errno::NXIO => break,
Err(e) => return Err(e).with_context(|| format!("Failed to seek to data: {path:?}")),
};
end = rustix::fs::seek(reader, SeekFrom::Hole(start))
.with_context(|| format!("Failed to seek to hole: {path:?}"))?;
result.push(start..end);
}
Ok(result)
}
/// Compute chunk boundaries for the list of potentially overlapping file byte
/// regions. If `exact_bounds` is true, then the regions must be block-aligned.
/// Otherwise, the lower boundaries are aligned down and the upper boundaries
/// are aligned up.
fn get_chunks_for_regions(
block_size: u32,
file_size: u64,
file_regions: &[Range<u64>],
exact_bounds: bool,
) -> Result<(u32, Vec<ChunkBounds>)> {
let block_size_64 = u64::from(block_size);
let file_blocks: u32 = (file_size / u64::from(block_size))
.try_into()
.map_err(|_| anyhow!("File size {file_size} too large for block size {block_size}"))?;
let mut chunk_list = ChunkList::new();
chunk_list.set_len(file_blocks);
for region in file_regions {
let mut start_byte = region.start;
let mut end_byte = region.end;
if exact_bounds {
if start_byte % block_size_64 != 0 || end_byte % block_size_64 != 0 {
bail!("File region bounds are not block-aligned: {region:?}");
}
} else {
start_byte = start_byte / block_size_64 * block_size_64;
end_byte = padding::round(end_byte, block_size_64).unwrap();
}
let start_block: u32 = (start_byte / block_size_64).try_into().map_err(|_| {
anyhow!("Region start offset {start_byte} too large for block size {block_size}")
})?;
let end_block: u32 = (end_byte / block_size_64).try_into().map_err(|_| {
anyhow!("Region end offset {end_byte} too large for block size {block_size}")
})?;
chunk_list.insert_data(ChunkBounds {
start: start_block,
end: end_block,
});
}
let chunks = chunk_list.iter_allocated().map(|c| c.bounds).collect();
Ok((file_blocks, chunks))
}
/// Compute the sparse [`Chunk`]s needed to cover the specified regions.
fn compute_chunks(
path: &Path,
reader: &mut File,
block_size: u32,
file_blocks: u32,
block_regions: &[ChunkBounds],
cancel_signal: &AtomicBool,
) -> Result<(ChunkList, u32)> {
let mut chunk_list = ChunkList::new();
let mut hasher = Some(Hasher::new());
let mut buf = vec![0u8; block_size as usize];
let mut block = 0;
chunk_list.set_len(file_blocks);
for bounds in block_regions {
if bounds.start != block {
// Not contiguous so we cannot compute the checksum.
hasher = None;
}
let offset = u64::from(bounds.start) * u64::from(block_size);
reader
.seek(SeekFrom::Start(offset))
.with_context(|| format!("Failed to seek file: {path:?}"))?;
for block in *bounds {
stream::check_cancel(cancel_signal)?;
reader
.read_exact(&mut buf)
.with_context(|| format!("Failed to read full block: {path:?}"))?;
if let Some(h) = &mut hasher {
h.update(&buf);
}
let new_bounds = ChunkBounds {
start: block,
end: block + 1,
};
if buf.chunks_exact(4).all(|c| c == &buf[..4]) {
let fill_value = u32::from_le_bytes(buf[..4].try_into().unwrap());
chunk_list.insert_fill(new_bounds, fill_value);
} else {
chunk_list.insert_data(new_bounds);
}
}
block = bounds.end;
}
if block != file_blocks {
hasher = None;
}
let crc32 = hasher.map(|h| h.finalize()).unwrap_or_default();
Ok((chunk_list, crc32))
}
fn unpack_subcommand(
sparse_cli: &SparseCli,
cli: &UnpackCli,
cancel_signal: &AtomicBool,
) -> Result<()> {
let reader = open_reader(&cli.input)?;
let mut sparse_reader = SparseReader::new(reader, CrcMode::Validate)
.with_context(|| format!("Failed to read sparse file: {:?}", cli.input))?;
let mut metadata = Metadata {
header: sparse_reader.header(),
chunks: vec![],
};
let mut writer = open_writer(&cli.output, !cli.preserve)?;
if cli.preserve {
let expected_size =
u64::from(metadata.header.num_blocks) * u64::from(metadata.header.block_size);
let file_size = writer
.seek(SeekFrom::End(0))
.with_context(|| format!("Failed to get file size: {:?}", cli.output))?;
if file_size < expected_size {
writer
.set_len(expected_size)
.with_context(|| format!("Failed to set file size: {:?}", cli.output))?;
}
writer
.seek(SeekFrom::Start(0))
.with_context(|| format!("Failed to seek file: {:?}", cli.output))?;
}
while let Some(chunk) = sparse_reader
.next_chunk()
.with_context(|| format!("Failed to read chunk: {:?}", cli.input))?
{
match chunk.data {
ChunkData::Fill(value) => {
let fill_value = little_endian::U32::from(value);
let buf = vec![fill_value; metadata.header.block_size as usize / 4];
for _ in chunk.bounds {
stream::check_cancel(cancel_signal)?;
writer
.write_all(buf.as_bytes())
.with_context(|| format!("Failed to write data: {:?}", cli.output))?;
}
}
ChunkData::Data => {
// This cannot overflow.
let to_copy = chunk.bounds.len() * metadata.header.block_size;
stream::copy_n(
&mut sparse_reader,
&mut writer,
to_copy.into(),
cancel_signal,
)
.with_context(|| {
format!("Failed to copy data: {:?} -> {:?}", cli.input, cli.output)
})?;
}
ChunkData::Hole => {
// Unlike ChunkData::Data, this can overflow a u32.
let to_skip = i64::from(chunk.bounds.len()) * i64::from(metadata.header.block_size);
writer
.seek_relative(to_skip)
.with_context(|| format!("Failed to seek file: {:?}", cli.output))?;
}
ChunkData::Crc32(_) => {}
}
metadata.chunks.push(chunk);
}
display_metadata(sparse_cli, &metadata);
sparse_reader
.finish()
.with_context(|| format!("Failed to finalize reader: {:?}", cli.input))?;
Ok(())
}
fn pack_subcommand(
sparse_cli: &SparseCli,
cli: &PackCli,
cancel_signal: &AtomicBool,
) -> Result<()> {
if cli.block_size == 0 || cli.block_size % 4 != 0 {
bail!(
"Block size must be a non-zero multiple of 4: {}",
cli.block_size,
);
}
let mut reader = open_reader(&cli.input)?;
let file_size = reader
.seek(SeekFrom::End(0))
.with_context(|| format!("Failed to get file size: {:?}", cli.input))?;
if file_size % u64::from(cli.block_size) != 0 {
bail!(
"File size {file_size} is not a multiple of block size {}",
cli.block_size,
);
}
// Compute the byte regions to pack into the sparse file.
let (file_regions, exact_bounds) = if !cli.region.is_empty() {
let regions = cli
.region
.chunks_exact(2)
.map(|c| c[0]..c[1])
.collect::<Vec<_>>();
(regions, false)
} else {
#[cfg(any(target_os = "linux", target_os = "android"))]
{
let regions = find_allocated_regions(&cli.input, &reader, cancel_signal)?;
(regions, false)
}
#[cfg(not(any(target_os = "linux", target_os = "android")))]
{
#[allow(clippy::single_range_in_vec_init)]
(vec![0..file_size], true)
}
};
// Get the file regions as non-overlapping and sorted block regions.
let (file_blocks, block_regions) =
get_chunks_for_regions(cli.block_size, file_size, &file_regions, exact_bounds)?;
// Compute the checksum (if possible) and the list of actual chunks.
let (chunk_list, crc32) = compute_chunks(
&cli.input,
&mut reader,
cli.block_size,
file_blocks,
&block_regions,
cancel_signal,
)?;
let chunks = split_chunks(&chunk_list.to_chunks(), cli.block_size);
let metadata = Metadata {
header: Header {
major_version: sparse::MAJOR_VERSION,
minor_version: sparse::MINOR_VERSION,
block_size: cli.block_size,
num_blocks: chunk_list.len(),
// This can't overflow because the number of chunks is always
// smaller than the number of blocks (because we don't add CRC32
// chunks).
num_chunks: chunks.len() as u32,
// This will be zero if the regions don't span the entire file.
crc32,
},
chunks,
};
display_metadata(sparse_cli, &metadata);
let writer = open_writer(&cli.output, true)?;
let mut sparse_writer = SparseWriter::new(writer, metadata.header)
.with_context(|| format!("Failed to initialize sparse file: {:?}", cli.output))?;
for chunk in metadata.chunks {
sparse_writer
.start_chunk(chunk)
.with_context(|| format!("Failed to start chunk: {:?}", cli.output))?;
if chunk.data == ChunkData::Data {
let offset = u64::from(chunk.bounds.start) * u64::from(cli.block_size);
reader
.seek(SeekFrom::Start(offset))
.with_context(|| format!("Failed to seek file: {:?}", cli.input))?;
let to_copy = u64::from(chunk.bounds.len()) * u64::from(cli.block_size);
stream::copy_n(&mut reader, &mut sparse_writer, to_copy, cancel_signal).with_context(
|| format!("Failed to copy data: {:?} -> {:?}", cli.input, cli.output),
)?;
}
}
sparse_writer
.finish()
.with_context(|| format!("Failed to finalize writer: {:?}", cli.output))?;
Ok(())
}
fn repack_subcommand(
sparse_cli: &SparseCli,
cli: &RepackCli,
cancel_signal: &AtomicBool,
) -> Result<()> {
let reader = open_reader(&cli.input)?;
let mut sparse_reader = SparseReader::new_seekable(reader, CrcMode::Validate)
.with_context(|| format!("Failed to read sparse file: {:?}", cli.input))?;
let mut metadata = Metadata {
header: sparse_reader.header(),
chunks: vec![],
};
let writer = open_writer(&cli.output, true)?;
let mut sparse_writer = SparseWriter::new(writer, metadata.header)
.with_context(|| format!("Failed to initialize sparse file: {:?}", cli.output))?;
while let Some(chunk) = sparse_reader
.next_chunk()
.with_context(|| format!("Failed to read chunk: {:?}", cli.input))?
{
sparse_writer
.start_chunk(chunk)
.with_context(|| format!("Failed to start chunk: {:?}", cli.output))?;
if chunk.data == ChunkData::Data {
// This cannot overflow.
let to_copy = chunk.bounds.len() * metadata.header.block_size;
stream::copy_n(
&mut sparse_reader,
&mut sparse_writer,
to_copy.into(),
cancel_signal,
)
.with_context(|| format!("Failed to copy data: {:?} -> {:?}", cli.input, cli.output))?;
}
metadata.chunks.push(chunk);
}
display_metadata(sparse_cli, &metadata);
sparse_reader
.finish()
.with_context(|| format!("Failed to finalize reader: {:?}", cli.input))?;
sparse_writer
.finish()
.with_context(|| format!("Failed to finalize writer: {:?}", cli.output))?;
Ok(())
}
fn info_subcommand(sparse_cli: &SparseCli, cli: &InfoCli) -> Result<()> {
let reader = open_reader(&cli.input)?;
let mut sparse_reader = SparseReader::new_seekable(reader, CrcMode::Ignore)
.with_context(|| format!("Failed to read sparse file: {:?}", cli.input))?;
let mut metadata = Metadata {
header: sparse_reader.header(),
chunks: vec![],
};
while let Some(chunk) = sparse_reader
.next_chunk()
.with_context(|| format!("Failed to read chunk: {:?}", cli.input))?
{
metadata.chunks.push(chunk);
}
display_metadata(sparse_cli, &metadata);
Ok(())
}
pub fn sparse_main(cli: &SparseCli, cancel_signal: &AtomicBool) -> Result<()> {
match &cli.command {
SparseCommand::Unpack(c) => unpack_subcommand(cli, c, cancel_signal),
SparseCommand::Pack(c) => pack_subcommand(cli, c, cancel_signal),
SparseCommand::Repack(c) => repack_subcommand(cli, c, cancel_signal),
SparseCommand::Info(c) => info_subcommand(cli, c),
}
}
/// Unpack a sparse image.
#[derive(Debug, Parser)]
struct UnpackCli {
/// Path to input sparse image.
#[arg(short, long, value_name = "FILE", value_parser)]
input: PathBuf,
/// Path to output raw image.
#[arg(short, long, value_name = "FILE", value_parser)]
output: PathBuf,
/// Preserve existing data in the output file.
///
/// This is useful when unpacking multiple sparse files into a single output
/// file because they contain disjoint blocks of data.
#[arg(long)]
preserve: bool,
}
/// Pack a sparse image.
#[derive(Debug, Parser)]
struct PackCli {
/// Path to output sparse image.
///
/// If `--region` is not used and the input file is not a (native) sparse
/// file on Linux, then the output sparse image is written with a CRC32
/// checksum in the header.
#[arg(short, long, value_name = "FILE", value_parser)]
output: PathBuf,
/// Path to input raw image.
///
/// On Linux, if this is a (native) sparse file, then the unallocated
/// sections of the file will be skipped and will be stored in the output
/// file as hole chunks.
#[arg(short, long, value_name = "FILE", value_parser)]
input: PathBuf,
/// Block size.
#[arg(short, long, value_name = "BYTES", default_value_t = 4096)]
block_size: u32,
/// Pack certain byte regions from the file.
///
/// The start offset will be aligned down to the block size and the end
/// offset will be aligned up. This option can be specified any number of
/// times and in any order. Overlapping regions are allowed.
///
/// Unused regions will be stored in the sparse file as hole chunks.
#[arg(short, long, value_names = ["START", "END"], num_args = 2)]
region: Vec<u64>,
}
/// Repack a sparse image.
///
/// This command is equivalent to running `unpack` and `pack`, except without
/// storing the unpacked data to disk.
#[derive(Debug, Parser)]
struct RepackCli {
/// Path to input sparse image.
#[arg(short, long, value_name = "FILE", value_parser)]
input: PathBuf,
/// Path to output sparse image.
#[arg(short, long, value_name = "FILE", value_parser)]
output: PathBuf,
}
/// Display sparse image metadata.
#[derive(Debug, Parser)]
struct InfoCli {
/// Path to input sparse image.
#[arg(short, long, value_name = "FILE", value_parser)]
input: PathBuf,
}
#[derive(Debug, Subcommand)]
enum SparseCommand {
Unpack(UnpackCli),
Pack(PackCli),
Repack(RepackCli),
Info(InfoCli),
}
/// Pack, unpack, and inspect sparse images.
#[derive(Debug, Parser)]
pub struct SparseCli {
#[command(subcommand)]
command: SparseCommand,
/// Don't print sparse image metadata.
#[arg(short, long, global = true)]
quiet: bool,
}
+412 -92
View File
@@ -1,14 +1,13 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
env::{self, VarError},
ffi::{OsStr, OsString},
fs::{self, File, OpenOptions},
io::{self, BufReader, BufWriter, Read, Write},
io::{self, Read, Write},
path::{Path, PathBuf},
process::{Command, ExitStatus, Stdio},
time::Duration,
};
@@ -20,54 +19,123 @@ use cms::{
SignedData, SignerIdentifier, SignerInfo, SignerInfos,
},
};
use passterm::PromptError;
use pkcs8::{
DecodePrivateKey, DecodePublicKey, EncodePrivateKey, EncodePublicKey, EncryptedPrivateKeyInfo,
LineEnding, PrivateKeyInfo,
pkcs5::{pbes2, scrypt},
DecodePrivateKey, EncodePrivateKey, EncodePublicKey, EncryptedPrivateKeyInfo, LineEnding,
PrivateKeyInfo,
};
use rand::RngCore;
use rsa::{pkcs1v15::SigningKey, Pkcs1v15Sign, RsaPrivateKey, RsaPublicKey};
use sha2::Sha256;
use rsa::{
Pkcs1v15Sign, RsaPrivateKey, RsaPublicKey, pkcs1v15::SigningKey, traits::PublicKeyParts,
};
use serde::{Deserialize, Serialize};
use sha1::Sha1;
use sha2::{Digest, Sha256, Sha512};
use thiserror::Error;
use x509_cert::{
Certificate,
builder::{Builder, CertificateBuilder, Profile},
der::{pem::PemLabel, referenced::OwnedToRef, Any, Decode, DecodePem, EncodePem},
der::{Any, Decode, DecodePem, EncodePem, pem::PemLabel, referenced::OwnedToRef},
serial_number::SerialNumber,
spki::{AlgorithmIdentifierOwned, SubjectPublicKeyInfoOwned},
time::Validity,
Certificate,
};
use crate::util::DebugString;
#[derive(Debug, Error)]
pub enum Error {
#[error("Signature algorithm not supported: {0:?}")]
UnsupportedAlgorithm(SignatureAlgorithm),
#[error("RSA key size ({}) not supported", .0 * 8)]
UnsupportedKeySize(usize),
#[error("Invalid digest length ({0} bytes) for {1:?}")]
InvalidDigestLength(usize, SignatureAlgorithm),
#[error("Invalid signature length ({0} bytes) for {1:?}")]
InvalidSignatureLength(usize, SignatureAlgorithm),
#[error("Failed to run command: {0:?}")]
CommandSpawn(DebugString, #[source] io::Error),
#[error("Command failed with status: {1}: {0:?}")]
CommandExecution(DebugString, ExitStatus),
#[error("Signature from signing helper does not match public key: {0:?}")]
SigningHelperBadSignature(PathBuf),
#[error("Passphrase prompt requires an interactive terminal")]
NotInteractive(#[source] io::Error),
#[error("Failed to prompt for passphrase")]
PassphrasePrompt(#[source] PromptError),
#[error("Passphrases do not match")]
ConfirmPassphrase,
#[error("Failed to read environment variable: {0:?}")]
InvalidEnvVar(OsString, #[source] VarError),
#[error("PEM has start tag, but no end tag")]
PemNoEndTag,
#[error("Failed to load encrypted private key")]
#[error("Failed to load encrypted RSA private key")]
LoadKeyEncrypted(#[source] pkcs8::Error),
#[error("Failed to load unencrypted private key")]
#[error("Failed to load unencrypted RSA private key")]
LoadKeyUnencrypted(#[source] pkcs8::Error),
#[error("Failed to save encrypted private key")]
#[error("Failed to save encrypted RSA private key")]
SaveKeyEncrypted(#[source] pkcs8::Error),
#[error("Failed to save unencrypted private key")]
#[error("Failed to save unencrypted RSA private key")]
SaveKeyUnencrypted(#[source] pkcs8::Error),
#[error("X509 error")]
X509(#[from] x509_cert::builder::Error),
#[error("SPKI error")]
Spki(#[from] pkcs8::spki::Error),
#[error("DER error")]
Der(#[from] x509_cert::der::Error),
#[error("RSA error")]
Rsa(#[from] rsa::Error),
#[error("I/O error")]
Io(#[from] io::Error),
#[error("Failed to load RSA public key")]
LoadPubKey(#[source] pkcs8::spki::Error),
#[error("Failed to save RSA public key")]
SavePubKey(#[source] pkcs8::spki::Error),
#[error("Failed to load X509 certificate")]
LoadCert(#[source] x509_cert::der::Error),
#[error("Failed to save X509 certificate")]
SaveCert(#[source] x509_cert::der::Error),
#[error("Failed to generate RSA key")]
RsaGenerate(#[source] Box<rsa::Error>),
#[error("Failed to RSA sign digest")]
RsaSign(#[source] Box<rsa::Error>),
#[error("Failed to RSA verify signature")]
RsaVerify(#[source] Box<rsa::Error>),
#[error("Failed to generate X509 certificate")]
CertGenerate(#[source] x509_cert::builder::Error),
#[error("Invalid parameters for X509 certificate generation")]
CertParams(#[source] x509_cert::der::Error),
#[error("Failed to CMS sign digest")]
CmsSign(#[source] x509_cert::der::Error),
#[error("Failed to parse CMS signature")]
CmsParse(#[source] x509_cert::der::Error),
#[error("Failed to read file: {0:?}")]
ReadFile(PathBuf, #[source] io::Error),
#[error("Failed to write file: {0:?}")]
WriteFile(PathBuf, #[source] io::Error),
}
type Result<T> = std::result::Result<T, Error>;
#[derive(Clone, Copy, Debug, Eq, PartialEq, Deserialize, Serialize)]
pub enum SignatureAlgorithm {
Sha1WithRsa,
Sha256WithRsa,
Sha512WithRsa,
}
impl SignatureAlgorithm {
/// Length of digest required by the signing algorithm.
pub fn digest_len(self) -> usize {
match self {
Self::Sha1WithRsa => Sha1::output_size(),
Self::Sha256WithRsa => Sha256::output_size(),
Self::Sha512WithRsa => Sha512::output_size(),
}
}
/// Compute the digest of the specified data.
pub fn hash(self, data: &[u8]) -> Vec<u8> {
match self {
Self::Sha1WithRsa => Sha1::digest(data).to_vec(),
Self::Sha256WithRsa => Sha256::digest(data).to_vec(),
Self::Sha512WithRsa => Sha512::digest(data).to_vec(),
}
}
}
#[derive(Clone)]
pub enum PassphraseSource {
Prompt(String),
EnvVar(OsString),
@@ -76,6 +144,7 @@ pub enum PassphraseSource {
impl PassphraseSource {
pub fn new(key_file: &Path, pass_file: Option<&Path>, env_var: Option<&OsStr>) -> Self {
#[allow(clippy::option_if_let_else)]
if let Some(v) = env_var {
Self::EnvVar(v.to_owned())
} else if let Some(p) = pass_file {
@@ -85,13 +154,33 @@ impl PassphraseSource {
}
}
fn prompt(prompt: &str) -> Result<String> {
match passterm::prompt_password_tty(Some(prompt)) {
Ok(p) => Ok(p),
Err(e) => {
#[cfg(unix)]
if let PromptError::IOError(io_e) = e {
if let Some(errno) = io_e.raw_os_error()
&& (errno == libc::ENXIO || errno == libc::ENOTTY)
{
return Err(Error::NotInteractive(io_e));
}
return Err(Error::PassphrasePrompt(PromptError::IOError(io_e)));
}
Err(Error::PassphrasePrompt(e))
}
}
}
pub fn acquire(&self, confirm: bool) -> Result<String> {
let passphrase = match self {
Self::Prompt(p) => {
let first = rpassword::prompt_password(p)?;
let first = Self::prompt(p)?;
if confirm {
let second = rpassword::prompt_password("Confirm: ")?;
let second = Self::prompt("Confirm: ")?;
if first != second {
return Err(Error::ConfirmPassphrase);
@@ -101,8 +190,9 @@ impl PassphraseSource {
first
}
Self::EnvVar(v) => env::var(v).map_err(|e| Error::InvalidEnvVar(v.clone(), e))?,
Self::File(p) => fs::read_to_string(p)?
.trim_end_matches(&['\r', '\n'])
Self::File(p) => fs::read_to_string(p)
.map_err(|e| Error::ReadFile(p.clone(), e))?
.trim_end_matches(['\r', '\n'])
.to_owned(),
};
@@ -110,12 +200,197 @@ impl PassphraseSource {
}
}
fn check_key_size(size: usize) -> Result<()> {
// RustCrypto does not support 8192-bit keys.
if size > 4096 / 8 {
return Err(Error::UnsupportedKeySize(size));
}
Ok(())
}
/// Copied from rsa-0.9.6 since the function is not exported.
fn pkcs1v15_sign_pad(prefix: &[u8], hashed: &[u8], k: usize) -> rsa::Result<Vec<u8>> {
let hash_len = hashed.len();
let t_len = prefix.len() + hashed.len();
if k < t_len + 11 {
return Err(rsa::Error::MessageTooLong);
}
// EM = 0x00 || 0x01 || PS || 0x00 || T
let mut em = vec![0xff; k];
em[0] = 0;
em[1] = 1;
em[k - t_len - 1] = 0;
em[k - t_len..k - hash_len].copy_from_slice(prefix);
em[k - hash_len..k].copy_from_slice(hashed);
Ok(em)
}
#[derive(Clone)]
pub enum RsaSigningKey {
Internal(RsaPrivateKey),
External {
program: PathBuf,
public_key_file: PathBuf,
public_key: RsaPublicKey,
passphrase_source: PassphraseSource,
},
}
impl RsaSigningKey {
/// Size of key in bytes.
pub fn size(&self) -> usize {
match self {
Self::Internal(key) => key.size(),
Self::External { public_key, .. } => public_key.size(),
}
}
/// Get the public key portion of the signing key.
pub fn to_public_key(&self) -> RsaPublicKey {
match self {
Self::Internal(key) => key.to_public_key(),
Self::External { public_key, .. } => public_key.clone(),
}
}
/// Sign the digest with the specified signature algorithm.
pub fn sign(&self, algo: SignatureAlgorithm, digest: &[u8]) -> Result<Vec<u8>> {
if digest.len() != algo.digest_len() {
return Err(Error::InvalidDigestLength(digest.len(), algo));
}
check_key_size(self.size())?;
let scheme = match algo {
// We don't support signing with insecure algorithms.
SignatureAlgorithm::Sha1WithRsa => return Err(Error::UnsupportedAlgorithm(algo)),
SignatureAlgorithm::Sha256WithRsa => Pkcs1v15Sign::new::<Sha256>(),
SignatureAlgorithm::Sha512WithRsa => Pkcs1v15Sign::new::<Sha512>(),
};
match self {
Self::Internal(key) => key
.sign(scheme, digest)
.map_err(|e| Error::RsaSign(Box::new(e))),
Self::External {
program,
public_key,
public_key_file,
passphrase_source,
} => {
let key_bits = public_key.size() * 8;
let algo_str = match algo {
SignatureAlgorithm::Sha1WithRsa => unreachable!(),
SignatureAlgorithm::Sha256WithRsa => format!("SHA256_RSA{key_bits}"),
SignatureAlgorithm::Sha512WithRsa => format!("SHA512_RSA{key_bits}"),
};
let mut command = Command::new(program);
command.arg(algo_str);
command.arg(public_key_file);
match passphrase_source {
PassphraseSource::Prompt(_) => {}
PassphraseSource::EnvVar(v) => {
command.arg("env");
command.arg(v);
}
PassphraseSource::File(p) => {
command.arg("file");
command.arg(p);
}
}
command.stdin(Stdio::piped());
command.stdout(Stdio::piped());
command.stderr(Stdio::inherit());
let mut child = command
.spawn()
.map_err(|e| Error::CommandSpawn(DebugString::new(&command), e))?;
// We don't bother with spawning a thread. The pipe capacity on
// all major OSs is significantly larger than the digest, so we
// don't risk deadlocking even if the process doesn't read from
// stdin.
//
// Pipe capacities:
// * Linux: 64 KiB
// * macOS: 4 KiB, 16 KiB (usually), or 64 KiB
// * Windows: 4 KiB
let padded_digest = pkcs1v15_sign_pad(&scheme.prefix, digest, public_key.size())
.map_err(|e| Error::RsaSign(Box::new(e)))?;
child
.stdin
.as_mut()
.unwrap()
.write_all(&padded_digest)
.map_err(|e| Error::WriteFile("<signing helper stdin>".into(), e))?;
let child = child
.wait_with_output()
.map_err(|e| Error::CommandSpawn(DebugString::new(&command), e))?;
if !child.status.success() {
return Err(Error::CommandExecution(
DebugString::new(&command),
child.status,
));
} else if child.stdout.len() != self.size() {
return Err(Error::InvalidSignatureLength(child.stdout.len(), algo));
}
// Check that the helper signed with the proper key.
if let Err(e) = self.to_public_key().verify_sig(algo, digest, &child.stdout) {
return match e {
Error::RsaVerify(_) => {
Err(Error::SigningHelperBadSignature(public_key_file.clone()))
}
e => Err(e),
};
}
Ok(child.stdout)
}
}
}
}
pub trait RsaPublicKeyExt {
fn verify_sig(&self, algo: SignatureAlgorithm, digest: &[u8], signature: &[u8]) -> Result<()>;
}
impl RsaPublicKeyExt for RsaPublicKey {
/// Verify the signature against the specified key.
fn verify_sig(&self, algo: SignatureAlgorithm, digest: &[u8], signature: &[u8]) -> Result<()> {
// Check this explicitly so we can provide a better error message.
if digest.len() != algo.digest_len() {
return Err(Error::InvalidDigestLength(digest.len(), algo));
}
check_key_size(self.size())?;
let scheme = match algo {
SignatureAlgorithm::Sha1WithRsa => Pkcs1v15Sign::new::<Sha1>(),
SignatureAlgorithm::Sha256WithRsa => Pkcs1v15Sign::new::<Sha256>(),
SignatureAlgorithm::Sha512WithRsa => Pkcs1v15Sign::new::<Sha512>(),
};
self.verify(scheme, digest, signature)
.map_err(|e| Error::RsaVerify(Box::new(e)))
}
}
/// Generate an 4096-bit RSA key pair.
pub fn generate_rsa_key_pair() -> Result<RsaPrivateKey> {
let mut rng = rand::thread_rng();
// avbroot supports 4096-bit keys only.
let key = RsaPrivateKey::new(&mut rng, 4096)?;
let key = RsaPrivateKey::new(&mut rng, 4096).map_err(|e| Error::RsaGenerate(Box::new(e)))?;
Ok(key)
}
@@ -127,20 +402,27 @@ pub fn generate_cert(
validity: Duration,
subject: &str,
) -> Result<Certificate> {
let public_key_der = key.to_public_key().to_public_key_der()?;
let public_key_der = key
.to_public_key()
.to_public_key_der()
.map_err(Error::SavePubKey)?;
let signing_key = SigningKey::<Sha256>::new(key.clone());
let builder = CertificateBuilder::new(
Profile::Root,
SerialNumber::from(serial),
Validity::from_now(validity)?,
subject.parse()?,
SubjectPublicKeyInfoOwned::from_der(public_key_der.as_bytes())?,
Validity::from_now(validity).map_err(Error::CertParams)?,
subject.parse().map_err(Error::CertParams)?,
SubjectPublicKeyInfoOwned::from_der(public_key_der.as_bytes())
.map_err(Error::CertParams)?,
&signing_key,
)?;
)
.map_err(Error::CertGenerate)?;
let mut rng = rand::thread_rng();
let cert = builder.build_with_rng(&mut rng)?;
let cert = builder
.build_with_rng(&mut rng)
.map_err(Error::CertGenerate)?;
Ok(cert)
}
@@ -193,62 +475,92 @@ fn reformat_pem(data: &[u8]) -> Result<Vec<u8>> {
}
/// Read PEM-encoded certificate from a reader.
pub fn read_pem_cert(mut reader: impl Read) -> Result<Certificate> {
pub fn read_pem_cert(path: &Path, mut reader: impl Read) -> Result<Certificate> {
let mut data = vec![];
reader.read_to_end(&mut data)?;
reader
.read_to_end(&mut data)
.map_err(|e| Error::ReadFile(path.to_owned(), e))?;
let data = reformat_pem(&data)?;
let certificate = Certificate::from_pem(data)?;
let certificate = Certificate::from_pem(data).map_err(Error::LoadCert)?;
Ok(certificate)
}
/// Write PEM-encoded certificate to a writer.
pub fn write_pem_cert(mut writer: impl Write, cert: &Certificate) -> Result<()> {
let data = cert.to_pem(LineEnding::LF)?;
pub fn write_pem_cert(path: &Path, mut writer: impl Write, cert: &Certificate) -> Result<()> {
let data = cert.to_pem(LineEnding::LF).map_err(Error::SaveCert)?;
writer.write_all(data.as_bytes())?;
writer
.write_all(data.as_bytes())
.map_err(|e| Error::WriteFile(path.to_owned(), e))?;
Ok(())
}
/// Read PEM-encoded certificate from a file.
pub fn read_pem_cert_file(path: &Path) -> Result<Certificate> {
let file = File::open(path)?;
let reader = BufReader::new(file);
let reader = File::open(path).map_err(|e| Error::ReadFile(path.to_owned(), e))?;
read_pem_cert(reader)
read_pem_cert(path, reader)
}
/// Write PEM-encoded certificate to a file.
pub fn write_pem_cert_file(path: &Path, cert: &Certificate) -> Result<()> {
let file = File::create(path)?;
let writer = BufWriter::new(file);
let writer = File::create(path).map_err(|e| Error::WriteFile(path.to_owned(), e))?;
write_pem_cert(writer, cert)
write_pem_cert(path, writer, cert)
}
/// Read PEM-encoded PKCS8 public key from a reader.
pub fn read_pem_public_key(path: &Path, mut reader: impl Read) -> Result<RsaPublicKey> {
let mut data = String::new();
reader
.read_to_string(&mut data)
.map_err(|e| Error::ReadFile(path.to_owned(), e))?;
let key = RsaPublicKey::from_public_key_pem(&data).map_err(Error::LoadPubKey)?;
Ok(key)
}
/// Write PEM-encoded PKCS8 public key to a writer.
pub fn write_pem_public_key(mut writer: impl Write, key: &RsaPublicKey) -> Result<()> {
let data = key.to_public_key_pem(LineEnding::LF)?;
pub fn write_pem_public_key(path: &Path, mut writer: impl Write, key: &RsaPublicKey) -> Result<()> {
let data = key
.to_public_key_pem(LineEnding::LF)
.map_err(Error::SavePubKey)?;
writer.write_all(data.as_bytes())?;
writer
.write_all(data.as_bytes())
.map_err(|e| Error::WriteFile(path.to_owned(), e))?;
Ok(())
}
/// Read PEM-encoded PKCS8 public key from a file.
pub fn read_pem_public_key_file(path: &Path) -> Result<RsaPublicKey> {
let reader = File::open(path).map_err(|e| Error::ReadFile(path.to_owned(), e))?;
read_pem_public_key(path, reader)
}
/// Write PEM-encoded PKCS8 public key to a file.
pub fn write_pem_public_key_file(path: &Path, key: &RsaPublicKey) -> Result<()> {
let file = File::create(path)?;
let writer = BufWriter::new(file);
let writer = File::create(path).map_err(|e| Error::WriteFile(path.to_owned(), e))?;
write_pem_public_key(writer, key)
write_pem_public_key(path, writer, key)
}
/// Read PEM-encoded PKCS8 private key from a reader.
pub fn read_pem_key(mut reader: impl Read, source: &PassphraseSource) -> Result<RsaPrivateKey> {
pub fn read_pem_key(
path: &Path,
mut reader: impl Read,
source: &PassphraseSource,
) -> Result<RsaPrivateKey> {
let mut data = String::new();
reader.read_to_string(&mut data)?;
reader
.read_to_string(&mut data)
.map_err(|e| Error::ReadFile(path.to_owned(), e))?;
if data.contains("ENCRYPTED") {
let passphrase = source.acquire(false)?;
@@ -261,6 +573,7 @@ pub fn read_pem_key(mut reader: impl Read, source: &PassphraseSource) -> Result<
/// Write PEM-encoded PKCS8 private key to a writer.
pub fn write_pem_key(
path: &Path,
mut writer: impl Write,
key: &RsaPrivateKey,
source: &PassphraseSource,
@@ -303,20 +616,24 @@ pub fn write_pem_key(
.encrypt_with_params(pbes2_params, passphrase)
.map_err(Error::SaveKeyEncrypted)?;
secret_doc.to_pem(EncryptedPrivateKeyInfo::PEM_LABEL, LineEnding::LF)?
secret_doc
.to_pem(EncryptedPrivateKeyInfo::PEM_LABEL, LineEnding::LF)
.map_err(pkcs8::Error::Asn1)
.map_err(Error::SaveKeyEncrypted)?
};
writer.write_all(data.as_bytes())?;
writer
.write_all(data.as_bytes())
.map_err(|e| Error::WriteFile(path.to_owned(), e))?;
Ok(())
}
/// Read PEM-encoded PKCS8 private key from a file.
pub fn read_pem_key_file(path: &Path, source: &PassphraseSource) -> Result<RsaPrivateKey> {
let file = File::open(path)?;
let reader = BufReader::new(file);
let reader = File::open(path).map_err(|e| Error::ReadFile(path.to_owned(), e))?;
read_pem_key(reader, source)
read_pem_key(path, reader, source)
}
/// Save PEM-encoded PKCS8 private key to a file.
@@ -336,22 +653,24 @@ pub fn write_pem_key_file(
options.mode(0o600);
}
let file = options.open(path)?;
let writer = BufWriter::new(file);
let writer = options
.open(path)
.map_err(|e| Error::WriteFile(path.to_owned(), e))?;
write_pem_key(writer, key, source)
write_pem_key(path, writer, key, source)
}
/// Get the RSA public key from a certificate.
pub fn get_public_key(cert: &Certificate) -> Result<RsaPublicKey> {
let public_key =
RsaPublicKey::try_from(cert.tbs_certificate.subject_public_key_info.owned_to_ref())?;
RsaPublicKey::try_from(cert.tbs_certificate.subject_public_key_info.owned_to_ref())
.map_err(Error::LoadPubKey)?;
Ok(public_key)
}
/// Check if a certificate matches a private key.
pub fn cert_matches_key(cert: &Certificate, key: &RsaPrivateKey) -> Result<bool> {
pub fn cert_matches_key(cert: &Certificate, key: &RsaSigningKey) -> Result<bool> {
let public_key = get_public_key(cert)?;
Ok(key.to_public_key() == public_key)
@@ -359,27 +678,26 @@ pub fn cert_matches_key(cert: &Certificate, key: &RsaPrivateKey) -> Result<bool>
/// Parse a CMS [`SignedData`] structure from raw DER-encoded data.
pub fn parse_cms(data: &[u8]) -> Result<SignedData> {
let ci = ContentInfo::from_der(data)?;
let sd = ci.content.decode_as::<SignedData>()?;
let ci = ContentInfo::from_der(data).map_err(Error::CmsParse)?;
let sd = ci
.content
.decode_as::<SignedData>()
.map_err(Error::CmsParse)?;
Ok(sd)
}
/// Get a list of all standard X509 certificates contained within a
/// Get an iterator to all standard X509 certificates contained within a
/// [`SignedData`] structure.
pub fn get_cms_certs(sd: &SignedData) -> Vec<Certificate> {
sd.certificates.as_ref().map_or_else(Vec::new, |certs| {
certs
.0
.iter()
.filter_map(|cc| {
if let CertificateChoices::Certificate(c) = cc {
Some(c.clone())
} else {
None
}
})
.collect()
pub fn iter_cms_certs(sd: &SignedData) -> impl Iterator<Item = &Certificate> {
sd.certificates.iter().flat_map(|certs| {
certs.0.iter().filter_map(|cc| {
if let CertificateChoices::Certificate(c) = cc {
Some(c)
} else {
None
}
})
})
}
@@ -389,12 +707,11 @@ pub fn get_cms_certs(sd: &SignedData) -> Vec<Certificate> {
/// a transport mechanism for a raw signature. Thus, we need to ensure that the
/// signature covers nothing but the raw data.
pub fn cms_sign_external(
key: &RsaPrivateKey,
key: &RsaSigningKey,
cert: &Certificate,
digest: &[u8],
) -> Result<ContentInfo> {
let scheme = Pkcs1v15Sign::new::<Sha256>();
let signature = key.sign(scheme, digest)?;
let signature = key.sign(SignatureAlgorithm::Sha256WithRsa, digest)?;
let digest_algorithm = AlgorithmIdentifierOwned {
oid: const_oid::db::rfc5912::ID_SHA_256,
@@ -403,14 +720,16 @@ pub fn cms_sign_external(
let signed_data = SignedData {
version: CmsVersion::V1,
digest_algorithms: DigestAlgorithmIdentifiers::try_from(vec![digest_algorithm.clone()])?,
digest_algorithms: DigestAlgorithmIdentifiers::try_from(vec![digest_algorithm.clone()])
.map_err(Error::CmsSign)?,
encap_content_info: EncapsulatedContentInfo {
econtent_type: const_oid::db::rfc5911::ID_DATA,
econtent: None,
},
certificates: Some(CertificateSet::try_from(vec![
CertificateChoices::Certificate(cert.clone()),
])?),
certificates: Some(
CertificateSet::try_from(vec![CertificateChoices::Certificate(cert.clone())])
.map_err(Error::CmsSign)?,
),
crls: None,
signer_infos: SignerInfos::try_from(vec![SignerInfo {
version: CmsVersion::V1,
@@ -424,14 +743,15 @@ pub fn cms_sign_external(
oid: const_oid::db::rfc5912::SHA_256_WITH_RSA_ENCRYPTION,
parameters: None,
},
signature: SignatureValue::new(signature)?,
signature: SignatureValue::new(signature).map_err(Error::CmsSign)?,
unsigned_attrs: None,
}])?,
}])
.map_err(Error::CmsSign)?,
};
let signed_data = ContentInfo {
content_type: const_oid::db::rfc5911::ID_SIGNED_DATA,
content: Any::encode_from(&signed_data)?,
content: Any::encode_from(&signed_data).map_err(Error::CmsSign)?,
};
Ok(signed_data)
+4 -6
View File
@@ -1,12 +1,10 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{fmt, marker::PhantomData};
use bstr::{ByteSlice, ByteVec};
use serde::{de::Visitor, Deserializer, Serializer};
use serde::{Deserializer, Serializer, de::Visitor};
use thiserror::Error;
#[derive(Clone, Debug, Error)]
@@ -68,7 +66,7 @@ where
{
struct EscapedStrVisitor<T>(PhantomData<T>);
impl<'de, T> Visitor<'de> for EscapedStrVisitor<T>
impl<T> Visitor<'_> for EscapedStrVisitor<T>
where
T: FromEscaped,
<T as FromEscaped>::Error: fmt::Display,
+856 -604
View File
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
+72 -37
View File
@@ -1,21 +1,20 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::io::{self, Read, Seek, Write};
use byteorder::{LittleEndian, WriteBytesExt};
use flate2::{read::GzDecoder, write::GzEncoder, Compression};
use liblzma::{
read::XzDecoder,
stream::{Check, Stream},
write::XzEncoder,
use flate2::{
Compression,
read::{DeflateDecoder, GzDecoder},
write::{DeflateEncoder, GzEncoder},
};
use lz4_flex::frame::FrameDecoder;
use lzma_rust2::{CheckType, XzOptions, XzReader, XzWriter};
use serde::{Deserialize, Serialize};
use thiserror::Error;
use crate::stream::ReadFixedSizeExt;
static GZIP_MAGIC: &[u8; 2] = b"\x1f\x8b";
static LZ4_LEGACY_MAGIC: &[u8; 4] = b"\x02\x21\x4c\x18";
static XZ_MAGIC: &[u8; 6] = b"\xfd\x37\x7a\x58\x5a\x00";
@@ -24,10 +23,12 @@ static XZ_MAGIC: &[u8; 6] = b"\xfd\x37\x7a\x58\x5a\x00";
pub enum Error {
#[error("Unknown compression format")]
UnknownFormat,
#[error("XZ stream error")]
XzStream(#[from] liblzma::stream::Error),
#[error("I/O error")]
Io(#[from] io::Error),
#[error("I/O error when autodetecting compression format")]
AutoDetect(#[source] io::Error),
#[error("Failed to initialize legacy LZ4 encoder")]
Lz4Init(#[source] io::Error),
#[error("Failed to initialize XZ encoder")]
XzInit(#[source] io::Error),
}
type Result<T> = std::result::Result<T, Error>;
@@ -61,7 +62,7 @@ impl<W: Write> Lz4LegacyEncoder<W> {
let compressed = lz4_flex::block::compress(&self.buf[..self.n_filled]);
let writer = self.writer.as_mut().unwrap();
writer.write_u32::<LittleEndian>(compressed.len() as u32)?;
writer.write_all(&(compressed.len() as u32).to_le_bytes())?;
writer.write_all(&compressed)?;
self.n_filled = 0;
@@ -108,6 +109,7 @@ impl<W: Write> Write for Lz4LegacyEncoder<W> {
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
pub enum CompressedFormat {
None,
Deflate,
Gzip,
Lz4Legacy,
Xz,
@@ -115,34 +117,29 @@ pub enum CompressedFormat {
pub enum CompressedReader<R: Read> {
None(R),
/// Not autodetected.
Deflate(DeflateDecoder<R>),
Gzip(GzDecoder<R>),
Lz4(FrameDecoder<R>),
Xz(XzDecoder<R>),
/// Boxed because the [`XzReader`] is nearly 4 KiB.
Xz(Box<XzReader<R>>),
}
impl<R: Read + Seek> CompressedReader<R> {
pub fn new(mut reader: R, raw_if_unknown: bool) -> Result<Self> {
let mut magic = [0u8; 6];
reader.read_exact(&mut magic)?;
reader.rewind()?;
if &magic[0..2] == GZIP_MAGIC {
Ok(Self::Gzip(GzDecoder::new(reader)))
} else if &magic[0..4] == LZ4_LEGACY_MAGIC {
Ok(Self::Lz4(FrameDecoder::new(reader)))
} else if &magic == XZ_MAGIC {
Ok(Self::Xz(XzDecoder::new(reader)))
} else if raw_if_unknown {
Ok(Self::None(reader))
} else {
Err(Error::UnknownFormat)
impl<R: Read> CompressedReader<R> {
pub fn with_format(reader: R, format: CompressedFormat) -> Self {
match format {
CompressedFormat::None => Self::None(reader),
CompressedFormat::Deflate => Self::Deflate(DeflateDecoder::new(reader)),
CompressedFormat::Gzip => Self::Gzip(GzDecoder::new(reader)),
CompressedFormat::Lz4Legacy => Self::Lz4(FrameDecoder::new(reader)),
CompressedFormat::Xz => Self::Xz(Box::new(XzReader::new(reader, false))),
}
}
pub fn format(&self) -> CompressedFormat {
match self {
Self::None(_) => CompressedFormat::None,
Self::Deflate(_) => CompressedFormat::Deflate,
Self::Gzip(_) => CompressedFormat::Gzip,
Self::Lz4(_) => CompressedFormat::Lz4Legacy,
Self::Xz(_) => CompressedFormat::Xz,
@@ -152,6 +149,7 @@ impl<R: Read + Seek> CompressedReader<R> {
pub fn into_inner(self) -> R {
match self {
Self::None(r) => r,
Self::Deflate(r) => r.into_inner(),
Self::Gzip(r) => r.into_inner(),
Self::Lz4(r) => r.into_inner(),
Self::Xz(r) => r.into_inner(),
@@ -159,10 +157,31 @@ impl<R: Read + Seek> CompressedReader<R> {
}
}
impl<R: Read + Seek> CompressedReader<R> {
pub fn new(mut reader: R, raw_if_unknown: bool) -> Result<Self> {
let magic = reader.read_array_exact::<6>().map_err(Error::AutoDetect)?;
reader.rewind().map_err(Error::AutoDetect)?;
if &magic[0..2] == GZIP_MAGIC {
Ok(Self::Gzip(GzDecoder::new(reader)))
} else if &magic[0..4] == LZ4_LEGACY_MAGIC {
Ok(Self::Lz4(FrameDecoder::new(reader)))
} else if &magic == XZ_MAGIC {
Ok(Self::Xz(Box::new(XzReader::new(reader, false))))
} else if raw_if_unknown {
Ok(Self::None(reader))
} else {
Err(Error::UnknownFormat)
}
}
}
impl<R: Read> Read for CompressedReader<R> {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
match self {
Self::None(r) => r.read(buf),
Self::Deflate(r) => r.read(buf),
Self::Gzip(r) => r.read(buf),
Self::Lz4(r) => r.read(buf),
Self::Xz(r) => r.read(buf),
@@ -170,25 +189,37 @@ impl<R: Read> Read for CompressedReader<R> {
}
}
#[allow(clippy::large_enum_variant)]
pub enum CompressedWriter<W: Write> {
None(W),
Deflate(DeflateEncoder<W>),
Gzip(GzEncoder<W>),
Lz4Legacy(Lz4LegacyEncoder<W>),
Xz(XzEncoder<W>),
Xz(XzWriter<W>),
}
impl<W: Write> CompressedWriter<W> {
pub fn new(writer: W, format: CompressedFormat) -> Result<Self> {
match format {
CompressedFormat::None => Ok(Self::None(writer)),
CompressedFormat::Deflate => Ok(Self::Deflate(DeflateEncoder::new(
writer,
Compression::default(),
))),
CompressedFormat::Gzip => {
Ok(Self::Gzip(GzEncoder::new(writer, Compression::default())))
}
CompressedFormat::Lz4Legacy => Ok(Self::Lz4Legacy(Lz4LegacyEncoder::new(writer)?)),
CompressedFormat::Lz4Legacy => {
let encoder = Lz4LegacyEncoder::new(writer).map_err(Error::Lz4Init)?;
Ok(Self::Lz4Legacy(encoder))
}
CompressedFormat::Xz => {
// Some kernels are compiled without support for the default CRC64.
let stream = Stream::new_easy_encoder(6, Check::Crc32)?;
Ok(Self::Xz(XzEncoder::new_stream(writer, stream)))
let mut options = XzOptions::with_preset(6);
options.set_check_sum_type(CheckType::Crc32);
let xz_writer = XzWriter::new(writer, options).map_err(Error::XzInit)?;
Ok(Self::Xz(xz_writer))
}
}
}
@@ -196,6 +227,7 @@ impl<W: Write> CompressedWriter<W> {
pub fn format(&self) -> CompressedFormat {
match self {
Self::None(_) => CompressedFormat::None,
Self::Deflate(_) => CompressedFormat::Deflate,
Self::Gzip(_) => CompressedFormat::Gzip,
Self::Lz4Legacy(_) => CompressedFormat::Lz4Legacy,
Self::Xz(_) => CompressedFormat::Xz,
@@ -205,6 +237,7 @@ impl<W: Write> CompressedWriter<W> {
pub fn finish(self) -> io::Result<W> {
match self {
Self::None(w) => Ok(w),
Self::Deflate(w) => w.finish(),
Self::Gzip(w) => w.finish(),
Self::Lz4Legacy(w) => w.finish(),
Self::Xz(w) => w.finish(),
@@ -216,6 +249,7 @@ impl<W: Write> Write for CompressedWriter<W> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
match self {
Self::None(w) => w.write(buf),
Self::Deflate(w) => w.write(buf),
Self::Gzip(w) => w.write(buf),
Self::Lz4Legacy(w) => w.write(buf),
Self::Xz(w) => w.write(buf),
@@ -225,6 +259,7 @@ impl<W: Write> Write for CompressedWriter<W> {
fn flush(&mut self) -> io::Result<()> {
match self {
Self::None(w) => w.flush(),
Self::Deflate(w) => w.flush(),
Self::Gzip(w) => w.flush(),
Self::Lz4Legacy(w) => w.flush(),
Self::Xz(w) => w.flush(),
+164 -108
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
collections::{HashMap, HashSet},
@@ -15,6 +13,8 @@ use bstr::ByteSlice;
use num_traits::{ToPrimitive, Zero};
use serde::{Deserialize, Serialize};
use thiserror::Error;
use zerocopy::{FromBytes, IntoBytes};
use zerocopy_derive::{FromBytes, Immutable, IntoBytes, KnownLayout, Unaligned};
use crate::{
escape,
@@ -50,55 +50,92 @@ const VEC_CAP_THRESHOLD: usize = 16384;
pub enum Error {
#[error("Unknown magic: {0:?}")]
UnknownMagic([u8; 6]),
#[error("Path is not NULL-terminated: {:?}", .0.as_bstr())]
PathNotNullTerminated(Vec<u8>),
#[error("Hard links are not supported: {:?}", .0.as_bstr())]
HardLinksNotSupported(Vec<u8>),
#[error("Entry of type {0} should not have data: {:?}", .1.as_bstr())]
#[error("Entry of type {0} should not have data: {path:?}", path = .1.as_bstr())]
EntryHasData(CpioEntryType, Vec<u8>),
#[error("No inodes available for device {0:x},{1:x}")]
DeviceFull(u32, u32),
#[error("{0:?} field exceeds integer bounds")]
IntegerTooLarge(&'static str),
#[error("I/O error")]
Io(#[from] io::Error),
#[error("No inodes available for device {major:x},{minor:x}")]
DeviceFull { major: u32, minor: u32 },
#[error("{0:?} overflowed integer bounds during calculations")]
IntOverflow(&'static str),
#[error("{0:?} contains invalid hex integer")]
InvalidHexInt(&'static str, #[source] InvalidHexCharError),
#[error("Failed to read cpio data: {0}")]
DataRead(&'static str, #[source] io::Error),
#[error("Failed to write cpio data: {0}")]
DataWrite(&'static str, #[source] io::Error),
}
type Result<T> = std::result::Result<T, Error>;
/// Read u32 formatted as an ASCII 8-char wide hex string.
fn read_int(mut reader: impl Read) -> io::Result<u32> {
let mut buf = [0u8; 8];
reader.read_exact(&mut buf)?;
#[derive(Debug, Error)]
#[error("{0:?}: Invalid hex char: {1:?}")]
pub struct InvalidHexCharError(RawHexU32, char);
let mut value = 0;
/// ASCII-encoded hex integer value used in cpio header fields.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(C, packed)]
struct RawHexU32([u8; 8]);
for b in buf {
let c = b as char;
let digit = c.to_digit(16).ok_or_else(|| {
io::Error::new(
io::ErrorKind::InvalidData,
format!("{:?}: Invalid hex char: {c}", buf.as_bstr()),
)
})?;
value <<= 4;
value |= digit;
impl fmt::Debug for RawHexU32 {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{:?}", self.0.as_bstr())
}
Ok(value)
}
/// Write u32 formatted as an ASCII 8-char wide hex string.
fn write_int(mut writer: impl Write, mut value: u32) -> io::Result<()> {
let mut buf = [b'0'; 8];
let mut index = 7;
#[allow(clippy::fallible_impl_from)]
impl From<u32> for RawHexU32 {
fn from(mut value: u32) -> Self {
let mut buf = [b'0'; 8];
while value != 0 {
buf[index] = char::from_digit(value & 0xf, 16).unwrap() as u8;
value >>= 4;
index -= 1;
for c in buf.iter_mut().rev() {
*c = char::from_digit(value & 0xf, 16).unwrap() as u8;
value >>= 4;
}
Self(buf)
}
}
writer.write_all(&buf)
impl TryFrom<RawHexU32> for u32 {
type Error = InvalidHexCharError;
fn try_from(raw_value: RawHexU32) -> std::result::Result<Self, Self::Error> {
let mut value = 0;
for b in raw_value.0 {
let c = b as char;
let digit = c.to_digit(16).ok_or(InvalidHexCharError(raw_value, c))?;
value <<= 4;
value |= digit;
}
Ok(value)
}
}
/// Raw on-disk layout for the cpio header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(C, packed)]
struct RawHeader {
/// Magic value. This should be equal to [`MAGIC_NEW`] or [`MAGIC_NEW_CRC`].
magic: [u8; 6],
inode: RawHexU32,
mode: RawHexU32,
uid: RawHexU32,
gid: RawHexU32,
nlink: RawHexU32,
mtime: RawHexU32,
file_size: RawHexU32,
dev_maj: RawHexU32,
dev_min: RawHexU32,
rdev_maj: RawHexU32,
rdev_min: RawHexU32,
path_size: RawHexU32,
crc32: RawHexU32,
}
/// Read a chunk of bytes from the reader. If `size` is less than
@@ -213,17 +250,14 @@ impl CpioEntryData {
pub fn size(&self) -> Result<u32> {
let size = match self {
Self::Size(s) => *s,
Self::Data(d) => d
.len()
.to_u32()
.ok_or_else(|| Error::IntegerTooLarge("data_size"))?,
Self::Data(d) => d.len().to_u32().ok_or(Error::IntOverflow("data_size"))?,
};
Ok(size)
}
fn is_size(&self) -> bool {
matches!(self, CpioEntryData::Size(_))
matches!(self, Self::Size(_))
}
}
@@ -391,41 +425,45 @@ impl<R: Read> FromReader<R> for CpioEntry {
fn from_reader(reader: R) -> Result<Self> {
let mut reader = CountingReader::new(reader);
let mut magic = [0u8; 6];
reader.read_exact(&mut magic)?;
let header =
RawHeader::read_from_io(&mut reader).map_err(|e| Error::DataRead("header", e))?;
if magic != *MAGIC_NEW && magic != *MAGIC_NEW_CRC {
return Err(Error::UnknownMagic(magic));
if header.magic != *MAGIC_NEW && header.magic != *MAGIC_NEW_CRC {
return Err(Error::UnknownMagic(header.magic));
}
let inode = read_int(&mut reader)?;
let mode = read_int(&mut reader)?;
let uid = read_int(&mut reader)?;
let gid = read_int(&mut reader)?;
let nlink = read_int(&mut reader)?;
let mtime = read_int(&mut reader)?;
let file_size = read_int(&mut reader)?;
let dev_maj = read_int(&mut reader)?;
let dev_min = read_int(&mut reader)?;
let rdev_maj = read_int(&mut reader)?;
let rdev_min = read_int(&mut reader)?;
let path_size = read_int(&mut reader)?;
let crc32 = read_int(&mut reader)?;
macro_rules! get_field {
($name:ident) => {
let $name = u32::try_from(header.$name)
.map_err(|e| Error::InvalidHexInt(stringify!($name), e))?;
};
}
get_field!(inode);
get_field!(mode);
get_field!(uid);
get_field!(gid);
get_field!(nlink);
get_field!(mtime);
get_field!(file_size);
get_field!(dev_maj);
get_field!(dev_min);
get_field!(rdev_maj);
get_field!(rdev_min);
get_field!(path_size);
get_field!(crc32);
let mut path = read_data(
&mut reader,
path_size.to_usize().unwrap(),
&AtomicBool::new(false),
)?;
)
.map_err(|e| Error::DataRead("path", e))?;
if path.last() != Some(&b'\0') {
return Err(io::Error::new(
io::ErrorKind::InvalidData,
"Filename is not NULL-terminated",
)
.into());
return Err(Error::PathNotNullTerminated(path));
}
path.pop();
padding::read_discard(&mut reader, 4)?;
padding::read_discard(&mut reader, 4).map_err(|e| Error::DataRead("path_padding", e))?;
let file_type = CpioEntryType::from_mode(mode);
let data = match file_type {
@@ -437,8 +475,10 @@ impl<R: Read> FromReader<R> for CpioEntry {
&mut reader,
file_size.to_usize().unwrap(),
&AtomicBool::new(false),
)?;
padding::read_discard(&mut reader, 4)?;
)
.map_err(|e| Error::DataRead("content", e))?;
padding::read_discard(&mut reader, 4)
.map_err(|e| Error::DataRead("content_padding", e))?;
CpioEntryData::Data(content)
}
@@ -477,7 +517,7 @@ impl<W: Write> ToWriter<W> for CpioEntry {
.len()
.checked_add(1)
.and_then(|s| s.to_u32())
.ok_or_else(|| Error::IntegerTooLarge("path_size"))?;
.ok_or(Error::IntOverflow("path_size"))?;
let file_size = self.data.size()?;
if file_size != 0
@@ -487,35 +527,47 @@ impl<W: Write> ToWriter<W> for CpioEntry {
return Err(Error::EntryHasData(self.file_type, self.path.clone()));
}
if self.crc32 == 0 {
writer.write_all(MAGIC_NEW)?;
} else {
writer.write_all(MAGIC_NEW_CRC)?;
}
let mode = self.file_type.to_mode() | u32::from(self.file_mode & 0o7777);
write_int(&mut writer, self.inode)?;
write_int(&mut writer, mode)?;
write_int(&mut writer, self.uid)?;
write_int(&mut writer, self.gid)?;
write_int(&mut writer, self.nlink)?;
write_int(&mut writer, self.mtime)?;
write_int(&mut writer, file_size)?;
write_int(&mut writer, self.dev_maj)?;
write_int(&mut writer, self.dev_min)?;
write_int(&mut writer, self.rdev_maj)?;
write_int(&mut writer, self.rdev_min)?;
write_int(&mut writer, path_size)?;
write_int(&mut writer, self.crc32)?;
let raw_header = RawHeader {
magic: if self.crc32 == 0 {
*MAGIC_NEW
} else {
*MAGIC_NEW_CRC
},
inode: self.inode.into(),
mode: mode.into(),
uid: self.uid.into(),
gid: self.gid.into(),
nlink: self.nlink.into(),
mtime: self.mtime.into(),
file_size: file_size.into(),
dev_maj: self.dev_maj.into(),
dev_min: self.dev_min.into(),
rdev_maj: self.rdev_maj.into(),
rdev_min: self.rdev_min.into(),
path_size: path_size.into(),
crc32: self.crc32.into(),
};
writer.write_all(&self.path)?;
writer.write_zeros_exact(1)?;
padding::write_zeros(&mut writer, 4)?;
raw_header
.write_to_io(&mut writer)
.map_err(|e| Error::DataWrite("header", e))?;
writer
.write_all(&self.path)
.map_err(|e| Error::DataWrite("path", e))?;
writer
.write_zeros_exact(1)
.map_err(|e| Error::DataWrite("path", e))?;
padding::write_zeros(&mut writer, 4).map_err(|e| Error::DataWrite("path_padding", e))?;
if let CpioEntryData::Data(d) = &self.data {
writer.write_all(d)?;
padding::write_zeros(&mut writer, 4)?;
writer
.write_all(d)
.map_err(|e| Error::DataWrite("content", e))?;
padding::write_zeros(&mut writer, 4)
.map_err(|e| Error::DataWrite("content_padding", e))?;
}
Ok(())
@@ -559,7 +611,8 @@ impl<R: Read> CpioReader<R> {
return Ok(None);
}
self.skip_data()?;
self.skip_data()
.map_err(|e| Error::DataRead("content", e))?;
let entry = CpioEntry::from_reader(&mut self.reader)?;
@@ -624,7 +677,8 @@ impl<W: Write> CpioWriter<W> {
}
pub fn start_entry(&mut self, entry: &CpioEntry) -> Result<()> {
self.finish_entry()?;
self.finish_entry()
.map_err(|e| Error::DataWrite("content", e))?;
entry.to_writer(&mut self.writer)?;
@@ -638,13 +692,15 @@ impl<W: Write> CpioWriter<W> {
}
pub fn finish(mut self) -> Result<W> {
self.finish_entry()?;
self.finish_entry()
.map_err(|e| Error::DataWrite("content", e))?;
self.start_entry(&CpioEntry::new_trailer())?;
// Pad until the end of the block.
if self.pad_to_block_size {
padding::write_zeros(&mut self.writer, IO_BLOCK_SIZE)?;
padding::write_zeros(&mut self.writer, IO_BLOCK_SIZE)
.map_err(|e| Error::DataWrite("block_padding", e))?;
}
Ok(self.writer.finish().0)
@@ -682,14 +738,15 @@ pub fn load(
let mut entries = vec![];
while let Some(mut entry) = cpio_reader.next_entry()? {
stream::check_cancel(cancel_signal)?;
stream::check_cancel(cancel_signal).map_err(|e| Error::DataRead("entry", e))?;
if entry.file_type != CpioEntryType::Directory && entry.nlink > 1 {
return Err(Error::HardLinksNotSupported(entry.path.clone()));
return Err(Error::HardLinksNotSupported(entry.path));
}
if let CpioEntryData::Size(s) = entry.data {
let data = read_data(&mut cpio_reader, s.to_usize().unwrap(), cancel_signal)?;
let data = read_data(&mut cpio_reader, s.to_usize().unwrap(), cancel_signal)
.map_err(|e| Error::DataWrite("data", e))?;
entry.data = CpioEntryData::Data(data);
}
@@ -712,11 +769,7 @@ pub fn sort(entries: &mut [CpioEntry]) {
/// 300000.
pub fn assign_inodes(entries: &mut [CpioEntry], missing_only: bool) -> Result<()> {
fn next_non_zero(i: u32) -> u32 {
if i == u32::MAX {
1
} else {
i.wrapping_add(1)
}
if i == u32::MAX { 1 } else { i.wrapping_add(1) }
}
// (dev maj, dev min) -> (inode set, last assigned inode)
@@ -745,7 +798,10 @@ pub fn assign_inodes(entries: &mut [CpioEntry], missing_only: bool) -> Result<()
while set.contains(&unused) {
if unused == *last {
return Err(Error::DeviceFull(entry.dev_maj, entry.dev_min));
return Err(Error::DeviceFull {
major: entry.dev_maj,
minor: entry.dev_min,
});
}
unused = next_non_zero(unused);
@@ -769,7 +825,7 @@ pub fn save(
let mut cpio_writer = CpioWriter::new(writer, pad_to_block_size);
for entry in entries {
stream::check_cancel(cancel_signal)?;
stream::check_cancel(cancel_signal).map_err(|e| Error::DataWrite("entry", e))?;
cpio_writer.start_entry(entry)?;
// CpioEntryData::Data will have already been written.
+170 -160
View File
@@ -1,33 +1,35 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
collections::HashSet,
fmt,
io::{self, Cursor, Read, Seek, SeekFrom, Write},
io::{self, Read, SeekFrom, Write},
mem,
ops::Range,
sync::atomic::AtomicBool,
};
use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use num_traits::ToPrimitive;
use rayon::{
prelude::{IndexedParallelIterator, ParallelIterator},
slice::{ParallelSlice, ParallelSliceMut},
};
use thiserror::Error;
use zerocopy::{FromBytes, IntoBytes, little_endian};
use zerocopy_derive::{FromBytes, Immutable, IntoBytes, KnownLayout, Unaligned};
use crate::{
format::verityrs,
stream::{self, FromReader, ReadSeekReopen, ToWriter, WriteSeekReopen, WriteZerosExt},
util::{self, NumBytes},
stream::{
self, FromReader, ReadAt, ReadSeek, ReadWriteAt, ReadWriteSeek, ToWriter, UserPosFile,
WriteSeek, WriteZerosExt,
},
util::{self, NumBytes, OutOfBoundsError},
};
// Not to be confused with the 255-byte RS block size.
const FEC_BLOCK_SIZE: usize = 4096;
const FEC_HEADER_SIZE: usize = 60;
const FEC_MAGIC: u32 = 0xFECFECFE;
const FEC_VERSION: u32 = 0;
@@ -66,9 +68,15 @@ pub enum Error {
#[error("Expected FEC digest {expected}, but have {actual}")]
InvalidFecDigest { expected: String, actual: String },
#[error("{0:?} field is out of bounds")]
FieldOutOfBounds(&'static str),
#[error("I/O error")]
Io(#[from] io::Error),
IntOutOfBounds(&'static str, #[source] OutOfBoundsError),
#[error("{0:?} overflowed integer bounds during calculations")]
IntOverflow(&'static str),
#[error("Failed to get input file size")]
InputSize(#[source] io::Error),
#[error("Failed to read FEC data: {0}")]
DataRead(&'static str, #[source] io::Error),
#[error("Failed to write FEC data: {0}")]
DataWrite(&'static str, #[source] io::Error),
}
type Result<T> = std::result::Result<T, Error>;
@@ -96,7 +104,7 @@ impl Codeword {
&mut self.data[..usize::from(self.rs_k)]
}
fn parity(&mut self) -> &[u8] {
fn parity(&self) -> &[u8] {
&self.data[usize::from(self.rs_k)..]
}
@@ -157,10 +165,11 @@ impl Fec {
input: file_size,
block: block_size,
});
} else if block_size > FEC_MAX_BLOCK_SIZE {
return Err(Error::FieldOutOfBounds("block_size"));
}
util::check_bounds(block_size, ..=FEC_MAX_BLOCK_SIZE)
.map_err(|e| Error::IntOutOfBounds("block_size", e))?;
let rs_k = 255 - parity;
if !verityrs::FN_ENCODE.contains_key(&rs_k) {
return Err(Error::UnsupportedParity(parity));
@@ -174,11 +183,11 @@ impl Fec {
.checked_mul(u64::from(parity))
.and_then(|s| s.checked_mul(u64::from(block_size)))
.and_then(|s| s.to_usize())
.ok_or_else(|| Error::FieldOutOfBounds("fec_data_size"))?;
.ok_or(Error::IntOverflow("fec_data_size"))?;
rounds
.checked_mul(u64::from(rs_k))
.and_then(|s| s.checked_mul(u64::from(block_size)))
.ok_or_else(|| Error::FieldOutOfBounds("fec_grid_size"))?;
.ok_or(Error::IntOverflow("fec_grid_size"))?;
Ok(Self {
file_size,
@@ -212,9 +221,8 @@ impl Fec {
fn rounds_for_ranges(&self, ranges: &[Range<u64>]) -> Result<HashSet<u64>> {
let ranges = util::merge_overlapping(ranges);
if let Some(last) = ranges.last() {
if last.end > self.file_size {
return Err(Error::FieldOutOfBounds("ranges"));
}
util::check_bounds(last.end, ..=self.file_size)
.map_err(|e| Error::IntOutOfBounds("ranges", e))?;
}
let block_size = u64::from(self.block_size);
@@ -241,7 +249,7 @@ impl Fec {
/// slice in the file offset grid.
fn read_seq_block(
&self,
mut reader: impl Read + Seek,
reader: &mut dyn ReadSeek,
offset: u64,
buf: &mut [u8],
) -> io::Result<()> {
@@ -269,7 +277,7 @@ impl Fec {
/// slice in the file offset grid.
fn write_seq_block(
&self,
mut writer: impl Write + Seek,
writer: &mut dyn WriteSeek,
offset: u64,
buf: &[u8],
) -> io::Result<()> {
@@ -292,7 +300,7 @@ impl Fec {
/// Read the nth round from the file. The data is laid out sequentially
/// (row-by-row).
fn read_round(&self, mut reader: impl Read + Seek, round: u64) -> io::Result<Vec<u8>> {
fn read_round(&self, reader: &mut dyn ReadSeek, round: u64) -> io::Result<Vec<u8>> {
let mut grid = vec![0u8; usize::from(self.rs_k) * self.block_size as usize];
for row in 0..self.rs_k {
@@ -302,7 +310,7 @@ impl Fec {
let row_end = row_start + self.block_size as usize;
let row_slice = &mut grid[row_start..row_end];
self.read_seq_block(&mut reader, interleaved_offset, row_slice)?;
self.read_seq_block(reader, interleaved_offset, row_slice)?;
}
Ok(grid)
@@ -310,12 +318,7 @@ impl Fec {
/// Write the nth round to the file. The data is expected to be laid out
/// sequentially (row-by-row).
fn write_round(
&self,
mut writer: impl Write + Seek,
round: u64,
grid: &[u8],
) -> io::Result<()> {
fn write_round(&self, writer: &mut dyn WriteSeek, round: u64, grid: &[u8]) -> io::Result<()> {
for row in 0..self.rs_k {
let interleaved_offset =
round * u64::from(self.rs_k) * u64::from(self.block_size) + u64::from(row);
@@ -323,7 +326,7 @@ impl Fec {
let row_end = row_start + self.block_size as usize;
let row_slice = &grid[row_start..row_end];
self.write_seq_block(&mut writer, interleaved_offset, row_slice)?;
self.write_seq_block(writer, interleaved_offset, row_slice)?;
}
Ok(())
@@ -353,7 +356,7 @@ impl Fec {
/// Generate FEC data for a single round.
fn generate_one_round(
&self,
reader: impl Read + Seek,
reader: &mut dyn ReadSeek,
round: u64,
fec: &mut [u8],
) -> Result<()> {
@@ -363,7 +366,9 @@ impl Fec {
"FEC buffer length does not match block size",
);
let grid = self.read_round(reader, round)?;
let grid = self
.read_round(reader, round)
.map_err(|e| Error::DataRead("round", e))?;
let encode = verityrs::FN_ENCODE[&self.rs_k];
let parity = usize::from(self.parity());
@@ -377,14 +382,16 @@ impl Fec {
}
/// Verify file data for a single round.
fn verify_one_round(&self, reader: impl Read + Seek, round: u64, fec: &[u8]) -> Result<()> {
fn verify_one_round(&self, reader: &mut dyn ReadSeek, round: u64, fec: &[u8]) -> Result<()> {
assert_eq!(
fec.len(),
usize::from(self.parity()) * self.block_size as usize,
"FEC buffer length does not match block size",
);
let grid = self.read_round(reader, round)?;
let grid = self
.read_round(reader, round)
.map_err(|e| Error::DataRead("round", e))?;
let is_correct = verityrs::FN_IS_CORRECT[&self.rs_k];
let parity = usize::from(self.parity());
@@ -403,8 +410,7 @@ impl Fec {
/// Repair file data for a single round.
fn repair_one_round(
&self,
reader: impl Read + Seek,
writer: impl Write + Seek,
file: &mut dyn ReadWriteSeek,
round: u64,
fec: &[u8],
) -> Result<u64> {
@@ -414,7 +420,9 @@ impl Fec {
"FEC buffer length does not match block size",
);
let mut grid = self.read_round(reader, round)?;
let mut grid = self
.read_round(file, round)
.map_err(|e| Error::DataRead("round", e))?;
let correct_errors = verityrs::FN_CORRECT_ERRORS[&self.rs_k];
let parity = usize::from(self.parity());
let mut num_corrected = 0;
@@ -432,7 +440,8 @@ impl Fec {
}
if num_corrected > 0 {
self.write_round(writer, round, &grid)?;
self.write_round(file, round, &grid)
.map_err(|e| Error::DataWrite("round", e))?;
}
Ok(num_corrected)
@@ -444,7 +453,7 @@ impl Fec {
/// This function is multithreaded and uses rayon's global thread pool.
pub fn generate(
&self,
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
cancel_signal: &AtomicBool,
) -> Result<Vec<u8>> {
let fec_size = self.fec_size();
@@ -452,13 +461,12 @@ impl Fec {
fec.par_chunks_exact_mut(fec_size / self.rounds as usize)
.enumerate()
.map(|(round, buf)| -> Result<()> {
stream::check_cancel(cancel_signal)?;
.try_for_each(|(round, buf)| -> Result<()> {
stream::check_cancel(cancel_signal).map_err(|e| Error::DataRead("(init)", e))?;
let reader = input.reopen_boxed()?;
self.generate_one_round(reader, round as u64, buf)
})
.collect::<Result<()>>()?;
let mut reader = UserPosFile::new(input);
self.generate_one_round(&mut reader, round as u64, buf)
})?;
Ok(fec)
}
@@ -468,7 +476,7 @@ impl Fec {
/// This function is multithreaded and uses rayon's global thread pool.
pub fn update(
&self,
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
ranges: &[Range<u64>],
fec: &mut [u8],
cancel_signal: &AtomicBool,
@@ -487,15 +495,12 @@ impl Fec {
fec.par_chunks_exact_mut(fec_size / self.rounds as usize)
.enumerate()
.filter(|(round, _)| rounds_to_update.contains(&(*round as u64)))
.map(|(round, buf)| -> Result<()> {
stream::check_cancel(cancel_signal)?;
.try_for_each(|(round, buf)| -> Result<()> {
stream::check_cancel(cancel_signal).map_err(|e| Error::DataRead("(init)", e))?;
let reader = input.reopen_boxed()?;
self.generate_one_round(reader, round as u64, buf)
let mut reader = UserPosFile::new(input);
self.generate_one_round(&mut reader, round as u64, buf)
})
.collect::<Result<()>>()?;
Ok(())
}
/// Verify that the file contains no errors. This is significantly faster
@@ -505,7 +510,7 @@ impl Fec {
/// This function is multithreaded and uses rayon's global thread pool.
pub fn verify(
&self,
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
fec: &[u8],
cancel_signal: &AtomicBool,
) -> Result<()> {
@@ -520,15 +525,12 @@ impl Fec {
fec.par_chunks_exact(fec_size / self.rounds as usize)
.enumerate()
.map(|(round, buf)| -> Result<()> {
stream::check_cancel(cancel_signal)?;
.try_for_each(|(round, buf)| -> Result<()> {
stream::check_cancel(cancel_signal).map_err(|e| Error::DataRead("(init)", e))?;
let reader = input.reopen_boxed()?;
self.verify_one_round(reader, round as u64, buf)
let mut reader = UserPosFile::new(input);
self.verify_one_round(&mut reader, round as u64, buf)
})
.collect::<Result<()>>()?;
Ok(())
}
/// Repair the file. Up to `parity / 2` bytes per codeword can be repaired.
@@ -544,8 +546,7 @@ impl Fec {
/// This function is multithreaded and uses rayon's global thread pool.
pub fn repair(
&self,
input: &(dyn ReadSeekReopen + Sync),
output: &(dyn WriteSeekReopen + Sync),
file: &(dyn ReadWriteAt + Sync),
fec: &[u8],
cancel_signal: &AtomicBool,
) -> Result<u64> {
@@ -562,20 +563,37 @@ impl Fec {
.par_chunks_exact(fec_size / self.rounds as usize)
.enumerate()
.map(|(round, buf)| -> Result<u64> {
stream::check_cancel(cancel_signal)?;
stream::check_cancel(cancel_signal).map_err(|e| Error::DataRead("(init)", e))?;
let reader = input.reopen_boxed()?;
let writer = output.reopen_boxed()?;
self.repair_one_round(reader, writer, round as u64, buf)
let mut file = UserPosFile::new(file);
self.repair_one_round(&mut file, round as u64, buf)
})
.collect::<Result<Vec<u64>>>()?
.into_iter()
.sum();
.try_reduce(|| 0, |prev, cur| Ok(prev + cur))?;
Ok(num_corrected)
}
}
/// Raw on-disk layout for the FEC image header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(C, packed)]
struct RawHeader {
/// Magic value. This should be equal to [`FEC_MAGIC`].
magic: little_endian::U32,
/// Image version. This should be equal to [`FEC_VERSION`].
version: little_endian::U32,
/// Size of this [`RawHeader`].
header_size: little_endian::U32,
/// Number of parity bytes per 255-byte Reed-Solomon codeword.
parity: little_endian::U32,
/// Size of the FEC data.
fec_size: little_endian::U32,
/// Size of the actual data.
data_size: little_endian::U64,
/// SHA-256 digest of the FEC data.
digest: [u8; 32],
}
/// A type for reading and writing AOSP's standalone FEC image format.
///
/// The FEC data parser in this implementation is strict. All header fields,
@@ -602,14 +620,11 @@ impl FecImage {
/// Generate FEC data for a file. `parity` is the number of parity bytes per
/// 255-byte Reed-Solomon codeword.
pub fn generate(
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
parity: u8,
cancel_signal: &AtomicBool,
) -> Result<Self> {
let data_size = {
let mut file = input.reopen_boxed()?;
file.seek(SeekFrom::End(0))?
};
let data_size = input.file_len().map_err(Error::InputSize)?;
let fec = Fec::new(data_size, FEC_BLOCK_SIZE as u32, parity)?;
let fec_data = fec.generate(input, cancel_signal)?;
@@ -623,7 +638,7 @@ impl FecImage {
/// Update FEC data coreesponding to the specified file ranges.
pub fn update(
&mut self,
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
ranges: &[Range<u64>],
cancel_signal: &AtomicBool,
) -> Result<()> {
@@ -633,11 +648,7 @@ impl FecImage {
/// Check that a file contains no errors. This is significantly faster than
/// [`Self::repair()`] if performing a repair is not necessary.
pub fn verify(
&self,
input: &(dyn ReadSeekReopen + Sync),
cancel_signal: &AtomicBool,
) -> Result<()> {
pub fn verify(&self, input: &(dyn ReadAt + Sync), cancel_signal: &AtomicBool) -> Result<()> {
let fec = Fec::new(self.data_size, FEC_BLOCK_SIZE as u32, self.parity)?;
fec.verify(input, &self.fec, cancel_signal)
}
@@ -653,42 +664,34 @@ impl FecImage {
/// possible for there to be a false positive where the corrupted codeword
/// is "corrected" into an incorrect value. FEC error detection is not a
/// replacement for cryptographically secure digests.
///
/// The inputs and outputs should point to the same underlying file because
/// only regions where errors are corrected are written. It is guaranteed
/// that multiple threads will always read and write disjoint file offsets.
pub fn repair(
&self,
input: &(dyn ReadSeekReopen + Sync),
output: &(dyn WriteSeekReopen + Sync),
file: &(dyn ReadWriteAt + Sync),
cancel_signal: &AtomicBool,
) -> Result<u64> {
let fec = Fec::new(self.data_size, FEC_BLOCK_SIZE as u32, self.parity)?;
fec.repair(input, output, &self.fec, cancel_signal)
fec.repair(file, &self.fec, cancel_signal)
}
/// Build one instance of the FEC header. The caller is responsible for
/// writing it to both of the header locations at the end of the file.
fn build_header(&self) -> Result<[u8; FEC_HEADER_SIZE]> {
let fec_size = self
.fec
.len()
.to_u32()
.ok_or_else(|| Error::FieldOutOfBounds("fec_size"))?;
let mut writer = Cursor::new([0u8; FEC_HEADER_SIZE]);
fn build_header(&self) -> Result<RawHeader> {
let fec_size: u32 =
util::try_cast(self.fec.len()).map_err(|e| Error::IntOutOfBounds("fec_size", e))?;
let digest = ring::digest::digest(&ring::digest::SHA256, &self.fec);
writer.write_u32::<LittleEndian>(FEC_MAGIC)?;
writer.write_u32::<LittleEndian>(FEC_VERSION)?;
writer.write_u32::<LittleEndian>(FEC_HEADER_SIZE as u32)?;
writer.write_u32::<LittleEndian>(self.parity.into())?;
writer.write_u32::<LittleEndian>(fec_size)?;
writer.write_u64::<LittleEndian>(self.data_size)?;
writer.write_all(digest.as_ref())?;
let header = RawHeader {
magic: FEC_MAGIC.into(),
version: FEC_VERSION.into(),
header_size: (mem::size_of::<RawHeader>() as u32).into(),
parity: u32::from(self.parity).into(),
fec_size: fec_size.into(),
data_size: self.data_size.into(),
digest: digest.as_ref().try_into().unwrap(),
};
Ok(writer.into_inner())
Ok(header)
}
}
@@ -699,48 +702,47 @@ impl<R: Read> FromReader<R> for FecImage {
// Avoid requiring seekable readers since we need to read everything
// into memory anyway.
let mut fec = Vec::new();
reader.read_to_end(&mut fec)?;
reader
.read_to_end(&mut fec)
.map_err(|e| Error::DataRead("fec", e))?;
if fec.len() < FEC_BLOCK_SIZE {
return Err(Error::DataTooSmall);
}
// Make sure both headers match.
let header1_offset = fec.len() - FEC_BLOCK_SIZE;
let header2_offset = fec.len() - FEC_HEADER_SIZE;
let header1_raw = &fec[header1_offset..header1_offset + FEC_HEADER_SIZE];
let header2_raw = &fec[header2_offset..header2_offset + FEC_HEADER_SIZE];
let (header, _) =
RawHeader::ref_from_prefix(&fec[header1_offset..]).map_err(|_| Error::DataTooSmall)?;
let header_size = header.header_size.get() as usize;
if header_size > FEC_BLOCK_SIZE / 2 {
// ref_from_prefix() already handles the "too small" case.
return Err(Error::InvalidHeaderSize(header.header_size.get()));
}
let header2_offset = fec.len() - header_size;
// Make sure both headers match, accounting for potential custom fields.
let header1_raw = &fec[header1_offset..][..header_size];
let header2_raw = &fec[header2_offset..][..header_size];
if header1_raw != header2_raw {
return Err(Error::HeadersDifferent);
}
let mut header_reader = Cursor::new(header1_raw);
let magic = header_reader.read_u32::<LittleEndian>()?;
if magic != FEC_MAGIC {
return Err(Error::InvalidHeaderMagic(magic));
if header.magic != FEC_MAGIC {
return Err(Error::InvalidHeaderMagic(header.magic.get()));
}
let version = header_reader.read_u32::<LittleEndian>()?;
if version != FEC_VERSION {
return Err(Error::UnsupportedHeaderVersion(version));
if header.version != FEC_VERSION {
return Err(Error::UnsupportedHeaderVersion(header.version.get()));
}
let header_size = header_reader.read_u32::<LittleEndian>()?;
if header_size != FEC_HEADER_SIZE as u32 {
return Err(Error::InvalidHeaderSize(header_size));
}
let parity: u8 =
util::try_cast(header.parity.get()).map_err(|e| Error::IntOutOfBounds("parity", e))?;
let parity = header_reader
.read_u32::<LittleEndian>()?
.to_u8()
.ok_or_else(|| Error::FieldOutOfBounds("parity"))?;
let fec_size = header_reader
.read_u32::<LittleEndian>()?
.to_usize()
.ok_or_else(|| Error::FieldOutOfBounds("fec_size"))?;
let fec_size = header.fec_size.get() as usize;
let actual_fec_size = fec.len() - FEC_BLOCK_SIZE;
if fec_size != actual_fec_size {
return Err(Error::InvalidHeaderFecSize {
@@ -749,25 +751,22 @@ impl<R: Read> FromReader<R> for FecImage {
});
}
let input_size = header_reader.read_u64::<LittleEndian>()?;
let data_size = header.data_size.get();
let mut digest = [0u8; 32];
header_reader.read_exact(&mut digest)?;
// Chop off headers.
fec.resize(fec_size, 0);
let actual_digest = ring::digest::digest(&ring::digest::SHA256, &fec);
if digest != actual_digest.as_ref() {
let actual_digest = ring::digest::digest(&ring::digest::SHA256, &fec[..fec_size]);
if header.digest != actual_digest.as_ref() {
return Err(Error::InvalidFecDigest {
expected: hex::encode(digest),
expected: hex::encode(header.digest),
actual: hex::encode(actual_digest),
});
}
// Chop off headers.
fec.resize(fec_size, 0);
Ok(Self {
fec,
data_size: input_size,
data_size,
parity,
})
}
@@ -779,10 +778,18 @@ impl<W: Write> ToWriter<W> for FecImage {
fn to_writer(&self, mut writer: W) -> Result<()> {
let header = self.build_header()?;
writer.write_all(&self.fec)?;
writer.write_all(&header)?;
writer.write_zeros_exact((FEC_BLOCK_SIZE - 2 * FEC_HEADER_SIZE) as u64)?;
writer.write_all(&header)?;
writer
.write_all(&self.fec)
.map_err(|e| Error::DataWrite("fec_data", e))?;
header
.write_to_io(&mut writer)
.map_err(|e| Error::DataWrite("fec_header_1", e))?;
writer
.write_zeros_exact((FEC_BLOCK_SIZE - 2 * header.as_bytes().len()) as u64)
.map_err(|e| Error::DataWrite("fec_header_padding", e))?;
header
.write_to_io(&mut writer)
.map_err(|e| Error::DataWrite("fec_header_2", e))?;
Ok(())
}
@@ -791,14 +798,14 @@ impl<W: Write> ToWriter<W> for FecImage {
#[cfg(test)]
mod tests {
use std::{
io::Seek,
sync::{atomic::AtomicBool, Arc},
io::{Cursor, Seek},
sync::{Arc, atomic::AtomicBool},
};
use assert_matches::assert_matches;
use rand::RngCore;
use crate::stream::SharedCursor;
use crate::stream::MutexFile;
use super::*;
@@ -827,7 +834,7 @@ mod tests {
);
}
fn corrupt_byte(file: &mut SharedCursor, offset: u64) {
fn corrupt_byte(file: &mut UserPosFile<&MutexFile<Cursor<Vec<u8>>>>, offset: u64) {
let mut buf = [0u8; 1];
file.seek(SeekFrom::Start(offset)).unwrap();
@@ -846,11 +853,13 @@ mod tests {
// Generate data big enough to span multiple rounds, but don't fill the
// offset grid to ensure that the out-of-bounds-is-0 behavior works.
let size = usize::from(rs_k) * block_size as usize * 3 - block_size as usize;
let mut file = SharedCursor::default();
let file = MutexFile::new(Cursor::new(Vec::new()));
let mut pos_file = UserPosFile::new(&file);
let orig_digest = {
let mut buf = vec![0u8; size];
rand::thread_rng().fill_bytes(&mut buf);
file.write_all(&buf).unwrap();
pos_file.write_all(&buf).unwrap();
ring::digest::digest(&ring::digest::SHA256, &buf)
};
@@ -866,7 +875,7 @@ mod tests {
fec.verify(&file, &fec_data, &cancel_signal).unwrap();
// Verify that errors are detected.
corrupt_byte(&mut file, 0);
corrupt_byte(&mut pos_file, 0);
assert_matches!(
fec.verify(&file, &fec_data, &cancel_signal),
Err(Error::HasErrors)
@@ -874,24 +883,24 @@ mod tests {
// Corrupt one byte in every single codeword.
for offset in 1..num_codewords {
corrupt_byte(&mut file, offset as u64);
corrupt_byte(&mut pos_file, offset as u64);
}
// Verify that all the single-byte errors can be fixed. We don't test
// for Error::TooManyErrors because of the chance of false positives due
// to the nature of RS.
fec.repair(&file, &file, &fec_data, &cancel_signal).unwrap();
fec.repair(&file, &fec_data, &cancel_signal).unwrap();
let repaired_digest = {
let mut buf = Vec::new();
file.rewind().unwrap();
file.read_to_end(&mut buf).unwrap();
pos_file.rewind().unwrap();
pos_file.read_to_end(&mut buf).unwrap();
ring::digest::digest(&ring::digest::SHA256, &buf)
};
assert_eq!(repaired_digest.as_ref(), orig_digest.as_ref());
// Intentionally update some data.
corrupt_byte(&mut file, 0);
corrupt_byte(&mut pos_file, 0);
let mut fec_data_updated = fec_data.clone();
let fec_data = fec.generate(&file, &cancel_signal).unwrap();
fec.update(&file, &[0..1], &mut fec_data_updated, &cancel_signal)
@@ -913,11 +922,12 @@ mod tests {
fn round_trip_image() {
let cancel_signal = Arc::new(AtomicBool::new(false));
let mut file = SharedCursor::default();
let file = MutexFile::new(Cursor::new(Vec::new()));
{
let mut buf = [0u8; FEC_BLOCK_SIZE];
rand::thread_rng().fill_bytes(&mut buf);
file.write_all(&buf).unwrap();
UserPosFile::new(&file).write_all(&buf).unwrap();
}
let image = FecImage::generate(&file, 2, &cancel_signal).unwrap();
+156 -127
View File
@@ -1,29 +1,31 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
fmt,
io::{self, Cursor, Read, SeekFrom, Write},
io::{self, Cursor, Read, Seek, SeekFrom, Write},
ops::Range,
str,
sync::atomic::AtomicBool,
};
use bstr::ByteSlice;
use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use num_traits::ToPrimitive;
use rayon::{
iter::{IndexedParallelIterator, ParallelIterator},
slice::ParallelSliceMut,
};
use ring::digest::{Algorithm, Context};
use thiserror::Error;
use zerocopy::{FromBytes, IntoBytes, little_endian};
use zerocopy_derive::{FromBytes, Immutable, IntoBytes, KnownLayout, Unaligned};
use crate::{
format::{avb, padding},
stream::{self, FromReader, ReadSeekReopen, ReadStringExt, ToWriter, WriteStringExt},
util::{self, NumBytes},
format::{
avb,
padding::{self, ZeroPadding},
},
stream::{self, FromReader, ReadAt, ReadFixedSizeExt, ToWriter, UserPosFile},
util::{self, NumBytes, OutOfBoundsError},
};
#[derive(Debug, Error)]
@@ -42,12 +44,20 @@ pub enum Error {
InvalidHeaderMagic([u8; 16]),
#[error("Invalid hash tree header version: {0}")]
InvalidHeaderVersion(u16),
#[error("Hashing algorithm not supported: {0:?}")]
UnsupportedHashAlgorithm(String),
#[error("Hashing algorithm not supported: {:?}", .0.as_bstr())]
UnsupportedHashAlgorithm(Vec<u8>),
#[error("{0:?} field is out of bounds")]
FieldOutOfBounds(&'static str),
#[error("I/O error")]
Io(#[from] io::Error),
IntOutOfBounds(&'static str, #[source] OutOfBoundsError),
#[error("{0:?} overflowed integer bounds during calculations")]
IntOverflow(&'static str),
#[error("Failed to get input file size")]
InputSize(#[source] io::Error),
#[error("Failed to compute hash tree of input file")]
InputDigest(#[source] io::Error),
#[error("Failed to read hash tree data: {0}")]
DataRead(&'static str, #[source] io::Error),
#[error("Failed to write hash tree data: {0}")]
DataWrite(&'static str, #[source] io::Error),
}
type Result<T> = std::result::Result<T, Error>;
@@ -83,13 +93,12 @@ impl HashTree {
level_size = blocks
.checked_mul(digest_size as u64)
.and_then(|s| padding::round(s, u64::from(self.block_size)))
.ok_or_else(|| Error::FieldOutOfBounds("level_size"))?;
.ok_or(Error::IntOverflow("level_size"))?;
// Depending on the chosen block size, the original file size could
// overflow a usize without the first level's size doing the same.
let level_size_usize = level_size
.to_usize()
.ok_or_else(|| Error::FieldOutOfBounds("level_size"))?;
let level_size_usize: usize =
util::try_cast(level_size).map_err(|e| Error::IntOutOfBounds("level_size", e))?;
ranges.push(0..level_size_usize);
}
@@ -111,9 +120,8 @@ impl HashTree {
fn blocks_for_ranges(&self, image_size: u64, ranges: &[Range<u64>]) -> Result<Vec<Range<u64>>> {
let ranges = util::merge_overlapping(ranges);
if let Some(last) = ranges.last() {
if last.end > image_size {
return Err(Error::FieldOutOfBounds("ranges"));
}
util::check_bounds(last.end, ..=image_size)
.map_err(|e| Error::IntOutOfBounds("ranges", e))?;
}
let block_size = u64::from(self.block_size);
@@ -181,13 +189,13 @@ impl HashTree {
/// Hash one full level in parallel.
fn hash_one_level_parallel(
&self,
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
size: u64,
level_data: &mut [u8],
cancel_signal: &AtomicBool,
) -> io::Result<()> {
assert!(
size > self.block_size as u64,
size > u64::from(self.block_size),
"Images smaller than block size must use a normal hash",
);
@@ -199,26 +207,23 @@ impl HashTree {
level_data
.par_chunks_mut(digest_size * multiplier as usize)
.enumerate()
.map(|(chunk, out_data)| -> io::Result<()> {
.try_for_each(|(chunk, out_data)| -> io::Result<()> {
let digests = out_data.len() / digest_size;
let in_start = (chunk as u64) * multiplier * u64::from(self.block_size);
let in_size = ((digests as u64) * u64::from(self.block_size)).min(size - in_start);
let mut reader = input.reopen_boxed()?;
let mut reader = UserPosFile::new(input);
reader.seek(SeekFrom::Start(in_start))?;
self.hash_partial_level(reader, in_size, out_data, cancel_signal)
})
.collect::<io::Result<()>>()?;
Ok(())
}
/// Update parts of the hash tree level corresponding to the specified
/// blocks.
fn hash_partial_level_parallel(
&self,
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
size: u64,
block_ranges: &[Range<u64>],
level_data: &mut [u8],
@@ -231,18 +236,15 @@ impl HashTree {
.par_chunks_exact_mut(digest_size)
.enumerate()
.filter(|(chunk, _)| util::ranges_contains(block_ranges, &(*chunk as u64)))
.map(|(chunk, out_data)| -> io::Result<()> {
.try_for_each(|(chunk, out_data)| -> io::Result<()> {
let in_start = (chunk as u64) * u64::from(self.block_size);
let in_size = u64::from(self.block_size).min(size - in_start);
let mut reader = input.reopen_boxed()?;
let mut reader = UserPosFile::new(input);
reader.seek(SeekFrom::Start(in_start))?;
self.hash_partial_level(reader, in_size, out_data, cancel_signal)
})
.collect::<io::Result<()>>()?;
Ok(())
}
/// Compute the hash tree and return the root digest. If `ranges` is
@@ -253,7 +255,7 @@ impl HashTree {
/// offset of the leaf layer of the tree must equal `hash_tree_data`'s size.
fn calculate(
&self,
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
image_size: u64,
ranges: Option<&[Range<u64>]>,
level_offsets: &[Range<usize>],
@@ -262,9 +264,10 @@ impl HashTree {
) -> Result<Vec<u8>> {
// Small files are hashed directly.
if image_size <= u64::from(self.block_size) {
let mut reader = input.reopen_boxed()?;
let mut buf = vec![0u8; image_size as usize];
reader.read_exact(&mut buf)?;
let mut reader = UserPosFile::new(input);
let buf = reader
.read_vec_exact(image_size as usize)
.map_err(Error::InputDigest)?;
let mut context = self.salted_context.clone();
context.update(&buf);
@@ -289,7 +292,8 @@ impl HashTree {
prev_size as u64,
level_data,
cancel_signal,
)?;
)
.map_err(Error::InputDigest)?;
} else if let Some(r) = ranges {
// Read partial blocks from file.
let block_ranges = self.blocks_for_ranges(image_size, r)?;
@@ -300,10 +304,12 @@ impl HashTree {
&block_ranges,
level_data,
cancel_signal,
)?;
)
.map_err(Error::InputDigest)?;
} else {
// Read entire file.
self.hash_one_level_parallel(input, image_size, level_data, cancel_signal)?;
self.hash_one_level_parallel(input, image_size, level_data, cancel_signal)
.map_err(Error::InputDigest)?;
}
// No need to explicitly ensure the level is padded to the block
@@ -322,12 +328,12 @@ impl HashTree {
/// hash tree data.
pub fn generate(
&self,
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
image_size: u64,
cancel_signal: &AtomicBool,
) -> Result<(Vec<u8>, Vec<u8>)> {
let offsets = self.compute_level_offsets(image_size)?;
let hash_tree_size = offsets.first().map(|r| r.end).unwrap_or(0);
let hash_tree_size = offsets.first().map_or(0, |r| r.end);
let mut hash_tree_data = vec![0u8; hash_tree_size];
let root_digest = self.calculate(
@@ -346,14 +352,14 @@ impl HashTree {
/// Returns the new root digest.
pub fn update(
&self,
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
image_size: u64,
ranges: &[Range<u64>],
hash_tree_data: &mut [u8],
cancel_signal: &AtomicBool,
) -> Result<Vec<u8>> {
let offsets = self.compute_level_offsets(image_size)?;
let hash_tree_size = offsets.first().map(|r| r.end).unwrap_or(0);
let hash_tree_size = offsets.first().map_or(0, |r| r.end);
if hash_tree_data.len() != hash_tree_size {
return Err(Error::InvalidHashTreeSize {
input: image_size,
@@ -375,14 +381,14 @@ impl HashTree {
/// Verify that the file contains no errors.
pub fn verify(
&self,
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
image_size: u64,
root_digest: &[u8],
hash_tree_data: &[u8],
cancel_signal: &AtomicBool,
) -> Result<()> {
let offsets = self.compute_level_offsets(image_size)?;
let hash_tree_size = offsets.first().map(|r| r.end).unwrap_or(0);
let hash_tree_size = offsets.first().map_or(0, |r| r.end);
if hash_tree_data.len() != hash_tree_size {
return Err(Error::InvalidHashTreeSize {
input: image_size,
@@ -417,6 +423,28 @@ impl HashTree {
}
}
/// Raw on-disk layout for our custom hash tree image header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(C, packed)]
struct RawHeader {
/// Magic value. This should be equal to [`HashTreeImage::MAGIC`].
magic: [u8; 16],
/// Image version. This should be equal to [`HashTreeImage::VERSION`].
version: little_endian::U16,
/// Size of the actual data.
image_size: little_endian::U64,
/// Block size.
block_size: little_endian::U32,
/// Hash algorithm.
algorithm: [u8; 16],
/// Salt size.
salt_size: little_endian::U16,
/// Root digest size.
root_digest_size: little_endian::U16,
/// Hash tree size.
hash_tree_size: little_endian::U32,
}
/// A type for reading and writing a custom hash tree image format.
///
/// File format:
@@ -444,6 +472,7 @@ pub struct HashTreeImage {
impl fmt::Debug for HashTreeImage {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("HashTreeImage")
.field("image_size", &self.image_size)
.field("block_size", &self.block_size)
.field("algorithm", &self.algorithm)
.field("salt", &hex::encode(&self.salt))
@@ -457,25 +486,22 @@ impl HashTreeImage {
const MAGIC: &'static [u8; 16] = b"avbroot!hashtree";
const VERSION: u16 = 1;
pub fn ring_algorithm(name: &str) -> Result<&'static Algorithm> {
avb::ring_algorithm(name, false)
.map_err(|_| Error::UnsupportedHashAlgorithm(name.to_owned()))
fn digest_algorithm(name: &str) -> Result<&'static Algorithm> {
avb::digest_algorithm(name)
.map_err(|_| Error::UnsupportedHashAlgorithm(name.to_owned().into_bytes()))
}
/// Generate hash tree data for a file.
pub fn generate(
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
block_size: u32,
algorithm: &str,
salt: &[u8],
cancel_signal: &AtomicBool,
) -> Result<Self> {
let image_size = {
let mut file = input.reopen_boxed()?;
file.seek(SeekFrom::End(0))?
};
let ring_algorithm = Self::ring_algorithm(algorithm)?;
let hash_tree = HashTree::new(block_size, ring_algorithm, salt);
let image_size = input.file_len().map_err(Error::InputSize)?;
let digest_algorithm = Self::digest_algorithm(algorithm)?;
let hash_tree = HashTree::new(block_size, digest_algorithm, salt);
let (root_digest, hash_tree_data) = hash_tree.generate(input, image_size, cancel_signal)?;
Ok(Self {
@@ -491,12 +517,12 @@ impl HashTreeImage {
/// Update hash tree data coreesponding to the specified file ranges.
pub fn update(
&mut self,
input: &(dyn ReadSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
ranges: &[Range<u64>],
cancel_signal: &AtomicBool,
) -> Result<()> {
let ring_algorithm = Self::ring_algorithm(&self.algorithm)?;
let hash_tree = HashTree::new(self.block_size, ring_algorithm, &self.salt);
let digest_algorithm = Self::digest_algorithm(&self.algorithm)?;
let hash_tree = HashTree::new(self.block_size, digest_algorithm, &self.salt);
self.root_digest = hash_tree.update(
input,
@@ -510,13 +536,9 @@ impl HashTreeImage {
}
/// Check that a file contains no errors.
pub fn verify(
&self,
input: &(dyn ReadSeekReopen + Sync),
cancel_signal: &AtomicBool,
) -> Result<()> {
let ring_algorithm = Self::ring_algorithm(&self.algorithm)?;
let hash_tree = HashTree::new(self.block_size, ring_algorithm, &self.salt);
pub fn verify(&self, input: &(dyn ReadAt + Sync), cancel_signal: &AtomicBool) -> Result<()> {
let digest_algorithm = Self::digest_algorithm(&self.algorithm)?;
let hash_tree = HashTree::new(self.block_size, digest_algorithm, &self.salt);
hash_tree.verify(
input,
@@ -532,40 +554,37 @@ impl<R: Read> FromReader<R> for HashTreeImage {
type Error = Error;
fn from_reader(mut reader: R) -> Result<Self> {
let mut magic = [0u8; 16];
reader.read_exact(&mut magic)?;
if magic != *Self::MAGIC {
return Err(Error::InvalidHeaderMagic(magic));
let header =
RawHeader::read_from_io(&mut reader).map_err(|e| Error::DataRead("header", e))?;
if header.magic != *Self::MAGIC {
return Err(Error::InvalidHeaderMagic(header.magic));
}
let version = reader.read_u16::<LittleEndian>()?;
if version != Self::VERSION {
return Err(Error::InvalidHeaderVersion(version));
if header.version != Self::VERSION {
return Err(Error::InvalidHeaderVersion(header.version.get()));
}
let image_size = reader.read_u64::<LittleEndian>()?;
let block_size = reader.read_u32::<LittleEndian>()?;
let algorithm = reader.read_string_padded(16)?;
let salt_size = reader.read_u16::<LittleEndian>()?;
let root_digest_size = reader.read_u16::<LittleEndian>()?;
let hash_tree_size = reader
.read_u32::<LittleEndian>()?
.to_usize()
.ok_or_else(|| Error::FieldOutOfBounds("hash_tree_size"))?;
let algorithm = header.algorithm.trim_end_padding();
let algorithm = str::from_utf8(algorithm)
.map_err(|_| Error::UnsupportedHashAlgorithm(algorithm.to_vec()))?;
let mut salt = vec![0u8; usize::from(salt_size)];
reader.read_exact(&mut salt)?;
let salt = reader
.read_vec_exact(usize::from(header.salt_size))
.map_err(|e| Error::DataRead("header", e))?;
let mut root_digest = vec![0u8; usize::from(root_digest_size)];
reader.read_exact(&mut root_digest)?;
let root_digest = reader
.read_vec_exact(usize::from(header.root_digest_size))
.map_err(|e| Error::DataRead("root_digest", e))?;
let mut hash_tree = vec![0u8; hash_tree_size];
reader.read_exact(&mut hash_tree)?;
let hash_tree = reader
.read_vec_exact(header.hash_tree_size.get() as usize)
.map_err(|e| Error::DataRead("hash_tree", e))?;
Ok(Self {
image_size,
block_size,
algorithm,
image_size: header.image_size.get(),
block_size: header.block_size.get(),
algorithm: algorithm.to_owned(),
salt,
root_digest,
hash_tree,
@@ -577,33 +596,42 @@ impl<W: Write> ToWriter<W> for HashTreeImage {
type Error = Error;
fn to_writer(&self, mut writer: W) -> Result<()> {
let salt_size = self
.salt
.len()
.to_u16()
.ok_or_else(|| Error::FieldOutOfBounds("salt_size"))?;
let root_digest_size = self
.root_digest
.len()
.to_u16()
.ok_or_else(|| Error::FieldOutOfBounds("root_digest_size"))?;
let hash_tree_size = self
.hash_tree
.len()
.to_u32()
.ok_or_else(|| Error::FieldOutOfBounds("hash_tree_size"))?;
let algorithm = self
.algorithm
.as_bytes()
.to_padded_array::<16>()
.ok_or_else(|| Error::UnsupportedHashAlgorithm(self.algorithm.as_bytes().to_vec()))?;
writer.write_all(Self::MAGIC)?;
writer.write_u16::<LittleEndian>(Self::VERSION)?;
writer.write_u64::<LittleEndian>(self.image_size)?;
writer.write_u32::<LittleEndian>(self.block_size)?;
writer.write_string_padded(&self.algorithm, 16)?;
writer.write_u16::<LittleEndian>(salt_size)?;
writer.write_u16::<LittleEndian>(root_digest_size)?;
writer.write_u32::<LittleEndian>(hash_tree_size)?;
writer.write_all(&self.salt)?;
writer.write_all(&self.root_digest)?;
writer.write_all(&self.hash_tree)?;
let salt_size: u16 =
util::try_cast(self.salt.len()).map_err(|e| Error::IntOutOfBounds("salt_size", e))?;
let root_digest_size: u16 = util::try_cast(self.root_digest.len())
.map_err(|e| Error::IntOutOfBounds("root_digest_size", e))?;
let hash_tree_size: u32 = util::try_cast(self.hash_tree.len())
.map_err(|e| Error::IntOutOfBounds("hash_tree_size", e))?;
let header = RawHeader {
magic: *Self::MAGIC,
version: Self::VERSION.into(),
image_size: self.image_size.into(),
block_size: self.block_size.into(),
algorithm,
salt_size: salt_size.into(),
root_digest_size: root_digest_size.into(),
hash_tree_size: hash_tree_size.into(),
};
header
.write_to_io(&mut writer)
.map_err(|e| Error::DataWrite("header", e))?;
writer
.write_all(&self.salt)
.map_err(|e| Error::DataWrite("salt", e))?;
writer
.write_all(&self.root_digest)
.map_err(|e| Error::DataWrite("root_digest", e))?;
writer
.write_all(&self.hash_tree)
.map_err(|e| Error::DataWrite("hash_tree", e))?;
Ok(())
}
@@ -615,7 +643,7 @@ mod tests {
use assert_matches::assert_matches;
use crate::stream::SharedCursor;
use crate::stream::MutexFile;
use super::*;
@@ -648,7 +676,7 @@ mod tests {
);
assert_matches!(
hash_tree.blocks_for_ranges(16384, &[0..16385]),
Err(Error::FieldOutOfBounds(_))
Err(Error::IntOutOfBounds(_, _))
);
}
@@ -656,7 +684,8 @@ mod tests {
fn generate_update_verify() {
let cancel_signal = AtomicBool::new(false);
let hash_tree = HashTree::new(64, &ring::digest::SHA256, b"Salt");
let mut input = SharedCursor::new();
let input = MutexFile::new(Cursor::new(Vec::new()));
let mut pos_input = UserPosFile::new(&input);
// Try input smaller than one block.
let (root_digest, hash_tree_data) = hash_tree.generate(&input, 0, &cancel_signal).unwrap();
@@ -673,7 +702,7 @@ mod tests {
// Try larger input that spans multiple blocks are results in an actual
// hash tree being created.
input.write_all(&b"Data".repeat(25)).unwrap();
pos_input.write_all(&b"Data".repeat(25)).unwrap();
let (root_digest, mut hash_tree_data) =
hash_tree.generate(&input, 100, &cancel_signal).unwrap();
@@ -697,8 +726,8 @@ mod tests {
);
// Change some data and update the hash tree.
input.rewind().unwrap();
input.write_all(b"Changed").unwrap();
pos_input.rewind().unwrap();
pos_input.write_all(b"Changed").unwrap();
let root_digest = hash_tree
.update(&input, 100, &[0..7], &mut hash_tree_data, &cancel_signal)
@@ -734,8 +763,8 @@ mod tests {
.unwrap();
// But not if the data is corrupted.
input.rewind().unwrap();
input.write_all(b"Bad").unwrap();
pos_input.rewind().unwrap();
pos_input.write_all(b"Bad").unwrap();
hash_tree
.verify(&input, 100, &root_digest, &hash_tree_data, &cancel_signal)
File diff suppressed because it is too large Load Diff
+5 -4
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
pub mod avb;
pub mod bootimage;
@@ -9,7 +7,10 @@ pub mod compression;
pub mod cpio;
pub mod fec;
pub mod hashtree;
pub mod lp;
pub mod ota;
pub mod padding;
pub mod payload;
pub mod sparse;
pub mod verityrs;
pub mod zip;
+780 -270
View File
File diff suppressed because it is too large Load Diff
+34 -4
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::io::{self, Read, Seek, Write};
@@ -47,3 +45,35 @@ pub fn write_zeros(mut writer: impl Write + Seek, page_size: u64) -> io::Result<
Ok(padding)
}
pub trait ZeroPadding {
/// Trim trailing zeros. Intermediate zeros before the last non-zero byte
/// are kept.
fn trim_end_padding(&self) -> &[u8];
/// Return the slice as an array padded with zeros at the end.
fn to_padded_array<const N: usize>(&self) -> Option<[u8; N]>;
}
impl ZeroPadding for [u8] {
fn trim_end_padding(&self) -> &[u8] {
let first_ending_zero = self
.iter()
.rposition(|b| *b != 0)
.map(|pos| pos + 1)
.unwrap_or_default();
&self[..first_ending_zero]
}
fn to_padded_array<const N: usize>(&self) -> Option<[u8; N]> {
if self.len() > N {
return None;
}
let mut result = [0u8; N];
result[..self.len()].copy_from_slice(self);
Some(result)
}
}
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
+2 -4
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
// The gf256 library uses compile-time proc macro code generation. Since
// dm-verity supports RS(255, 231) through RS(255, 253), we'll generate RS
+494
View File
@@ -0,0 +1,494 @@
// SPDX-FileCopyrightText: 2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
cmp::Ordering,
io::{self, Cursor, Read, Seek, SeekFrom, Write},
};
use bstr::ByteSlice;
use rawzip::{
CompressionMethod, RECOMMENDED_BUFFER_SIZE, ReaderAt, ZipArchive, ZipEntries, ZipEntry,
ZipFileHeaderRecord, ZipLocator, ZipReader, ZipSliceArchive, ZipSliceEntries, ZipSliceEntry,
ZipSliceVerifier, ZipVerifier,
extra_fields::{ExtraFieldId, ExtraFields},
};
use zerocopy::{FromZeros, IntoBytes, little_endian};
use zerocopy_derive::{FromBytes, Immutable, IntoBytes, KnownLayout, Unaligned};
use crate::{
format::compression::{self, CompressedFormat, CompressedReader, CompressedWriter},
stream::ReadAt,
};
pub trait ZipFileHeaderRecordExt<'a> {
fn file_path_utf8(&self) -> Result<&'a str, rawzip::Error>;
}
impl<'a> ZipFileHeaderRecordExt<'a> for ZipFileHeaderRecord<'a> {
fn file_path_utf8(&self) -> Result<&'a str, rawzip::Error> {
str::from_utf8(self.file_path().as_bytes())
.map_err(|e| rawzip::ErrorKind::InvalidUtf8(e).into())
}
}
/// Validate that the current entry's compressed data range does not overlap
/// previously visited entries' ranges. This approach is identical to what
/// rawzip recommends in their examples.
fn validate_and_add_range(
compressed_ranges: &mut Vec<(u64, u64)>,
current_range: (u64, u64),
path: &[u8],
) -> Result<(), rawzip::Error> {
let (current_start, current_end) = current_range;
let insert_pos = compressed_ranges
.binary_search_by_key(&current_start, |&(start, _)| start)
.unwrap_or_else(|pos| pos);
if insert_pos > 0 {
let (prev_start, prev_end) = compressed_ranges[insert_pos - 1];
if prev_end > current_start {
return Err(rawzip::ErrorKind::InvalidInput {
msg: format!("{:?} ({current_start}..{current_end}) overlaps previous range ({prev_start}..{prev_end})", path.as_bstr()),
}.into());
}
}
if insert_pos < compressed_ranges.len() {
let (next_start, next_end) = compressed_ranges[insert_pos];
if current_end > next_start {
return Err(rawzip::ErrorKind::InvalidInput {
msg: format!("{:?} ({current_start}..{current_end}) overlaps next range ({next_start}..{next_end})", path.as_bstr()),
}.into());
}
}
compressed_ranges.insert(insert_pos, current_range);
Ok(())
}
/// Validate that the entry's compression ratio is not excessively large, based
/// on a constant factor for [`CompressionMethod::Deflate`]. This approach is
/// identical to what rawzip recommends in their examples.
fn validate_compression_ratio(
compressed_size: u64,
uncompressed_size: u64,
path: &[u8],
) -> Result<(), rawzip::Error> {
if compressed_size > 0 && uncompressed_size / compressed_size > 1032 {
#[allow(clippy::cast_precision_loss)]
return Err(rawzip::ErrorKind::InvalidInput {
msg: format!(
"{:?} has excessively large compression ratio: {})",
path.as_bstr(),
uncompressed_size as f64 / compressed_size as f64,
),
}
.into());
}
Ok(())
}
#[derive(Debug)]
pub struct ZipEntriesSafe<'archive, 'buf, R> {
archive: &'archive ZipArchive<R>,
entries: ZipEntries<'archive, 'buf, R>,
compressed_ranges: Vec<(u64, u64)>,
}
impl<R: ReaderAt> ZipEntriesSafe<'_, '_, R> {
#[inline]
pub fn next_entry(
&mut self,
) -> Result<Option<(ZipFileHeaderRecord<'_>, ZipEntry<'_, R>)>, rawzip::Error> {
let cd_entry = self.entries.next_entry()?;
let Some(cd_entry) = cd_entry else {
return Ok(None);
};
validate_compression_ratio(
cd_entry.compressed_size_hint(),
cd_entry.uncompressed_size_hint(),
cd_entry.file_path().as_ref(),
)?;
let entry = self.archive.get_entry(cd_entry.wayfinder())?;
validate_and_add_range(
&mut self.compressed_ranges,
entry.compressed_data_range(),
cd_entry.file_path().as_ref(),
)?;
Ok(Some((cd_entry, entry)))
}
}
pub trait ZipEntriesSafeExt<R> {
fn entries_safe<'archive, 'buf>(
&'archive self,
buffer: &'buf mut [u8],
) -> ZipEntriesSafe<'archive, 'buf, R>;
}
impl<R> ZipEntriesSafeExt<R> for ZipArchive<R> {
fn entries_safe<'archive, 'buf>(
&'archive self,
buffer: &'buf mut [u8],
) -> ZipEntriesSafe<'archive, 'buf, R> {
let entries = self.entries(buffer);
ZipEntriesSafe {
archive: self,
entries,
compressed_ranges: Vec::new(),
}
}
}
impl<R, T: ZipEntriesSafeExt<R>> ZipEntriesSafeExt<R> for &T {
fn entries_safe<'archive, 'buf>(
&'archive self,
buffer: &'buf mut [u8],
) -> ZipEntriesSafe<'archive, 'buf, R> {
(**self).entries_safe(buffer)
}
}
impl<R, T: ZipEntriesSafeExt<R>> ZipEntriesSafeExt<R> for &mut T {
fn entries_safe<'archive, 'buf>(
&'archive self,
buffer: &'buf mut [u8],
) -> ZipEntriesSafe<'archive, 'buf, R> {
(**self).entries_safe(buffer)
}
}
#[derive(Debug)]
pub struct ZipSliceEntriesSafe<'data, T: AsRef<[u8]>> {
archive: &'data ZipSliceArchive<T>,
entries: ZipSliceEntries<'data>,
compressed_ranges: Vec<(u64, u64)>,
}
impl<'data, T: AsRef<[u8]>> ZipSliceEntriesSafe<'data, T> {
#[inline]
pub fn next_entry(
&mut self,
) -> Result<Option<(ZipFileHeaderRecord<'data>, ZipSliceEntry<'data>)>, rawzip::Error> {
let cd_entry = self.entries.next_entry()?;
let Some(cd_entry) = cd_entry else {
return Ok(None);
};
validate_compression_ratio(
cd_entry.compressed_size_hint(),
cd_entry.uncompressed_size_hint(),
cd_entry.file_path().as_ref(),
)?;
let entry = self.archive.get_entry(cd_entry.wayfinder())?;
validate_and_add_range(
&mut self.compressed_ranges,
entry.compressed_data_range(),
cd_entry.file_path().as_ref(),
)?;
Ok(Some((cd_entry, entry)))
}
}
pub trait ZipSliceEntriesSafeExt<T: AsRef<[u8]>> {
fn entries_safe(&self) -> ZipSliceEntriesSafe<'_, T>;
}
impl<T: AsRef<[u8]>> ZipSliceEntriesSafeExt<T> for ZipSliceArchive<T> {
fn entries_safe(&self) -> ZipSliceEntriesSafe<'_, T> {
let entries = self.entries();
ZipSliceEntriesSafe {
archive: self,
entries,
compressed_ranges: Vec::new(),
}
}
}
impl<T: AsRef<[u8]>, U: ZipSliceEntriesSafeExt<T>> ZipSliceEntriesSafeExt<T> for &U {
fn entries_safe(&self) -> ZipSliceEntriesSafe<'_, T> {
(**self).entries_safe()
}
}
impl<T: AsRef<[u8]>, U: ZipSliceEntriesSafeExt<T>> ZipSliceEntriesSafeExt<T> for &mut U {
fn entries_safe(&self) -> ZipSliceEntriesSafe<'_, T> {
(**self).entries_safe()
}
}
fn compression_method_to_format(
compression_method: CompressionMethod,
) -> Result<CompressedFormat, rawzip::Error> {
match compression_method {
CompressionMethod::Store => Ok(CompressedFormat::None),
CompressionMethod::Deflate => Ok(CompressedFormat::Deflate),
c => Err(rawzip::ErrorKind::InvalidInput {
msg: format!("Unsupported compression method: {c:?}"),
}
.into()),
}
}
pub fn compressed_reader<'archive, R: ReaderAt>(
entry: &ZipEntry<'archive, R>,
compression_method: CompressionMethod,
) -> Result<CompressedReader<ZipReader<&'archive R>>, rawzip::Error> {
let format = compression_method_to_format(compression_method)?;
Ok(CompressedReader::with_format(entry.reader(), format))
}
pub fn compressed_slice_reader<'archive>(
entry: &ZipSliceEntry<'archive>,
compression_method: CompressionMethod,
) -> Result<CompressedReader<Cursor<&'archive [u8]>>, rawzip::Error> {
let format = compression_method_to_format(compression_method)?;
let raw_reader = Cursor::new(entry.data());
Ok(CompressedReader::with_format(raw_reader, format))
}
pub fn verifying_reader<'archive, R: ReaderAt>(
entry: &ZipEntry<'archive, R>,
compression_method: CompressionMethod,
) -> Result<ZipVerifier<CompressedReader<ZipReader<&'archive R>>, &'archive R>, rawzip::Error> {
compressed_reader(entry, compression_method).map(|r| entry.verifying_reader(r))
}
pub fn verifying_slice_reader<'archive>(
entry: &ZipSliceEntry<'archive>,
compression_method: CompressionMethod,
) -> Result<ZipSliceVerifier<CompressedReader<Cursor<&'archive [u8]>>>, rawzip::Error> {
compressed_slice_reader(entry, compression_method).map(|r| entry.verifying_reader(r))
}
pub fn compressed_writer<W: Write>(
writer: W,
compression_method: CompressionMethod,
) -> Result<CompressedWriter<W>, rawzip::Error> {
use compression::Error;
let format = compression_method_to_format(compression_method)?;
match CompressedWriter::new(writer, format) {
Ok(w) => Ok(w),
Err(Error::Lz4Init(e) | Error::XzInit(e)) => Err(e.into()),
Err(Error::UnknownFormat | Error::AutoDetect(_)) => unreachable!(),
}
}
pub trait ZipArchiveReadAtExt {
fn from_read_at<R: ReadAt>(
file: R,
buffer: &mut [u8],
) -> Result<ZipArchive<ReaderAtWrapper<R>>, rawzip::Error> {
let end_offset = file.file_len()?;
ZipLocator::new()
.locate_in_reader(ReaderAtWrapper(file), buffer, end_offset)
.map_err(|(_, e)| e)
}
}
impl ZipArchiveReadAtExt for ZipArchive<()> {}
pub struct ReaderAtWrapper<R: ReadAt>(R);
impl<R: ReadAt> ReaderAt for ReaderAtWrapper<R> {
fn read_at(&self, buf: &mut [u8], offset: u64) -> io::Result<usize> {
ReadAt::read_at(&self.0, buf, offset)
}
}
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(C, packed)]
struct ZipLocalHeader {
signature: little_endian::U32,
version_needed: little_endian::U16,
flags: little_endian::U16,
compression_method: little_endian::U16,
last_mod_time: little_endian::U16,
last_mod_date: little_endian::U16,
crc32: little_endian::U32,
compressed_size: little_endian::U32,
uncompressed_size: little_endian::U32,
file_name_len: little_endian::U16,
extra_field_len: little_endian::U16,
}
/// Convert a streaming zip into a non-streaming one. If any entry uses ZIP64,
/// the local header must contain an [`ExtraFieldId::ANDROID_ZIP_ALIGNMENT`]
/// extra field with sufficient size (16 bytes to be safe). This is used as
/// reserved space for creating a new [`ExtraFieldId::ZIP64`] extra field. Any
/// leftover space must be at least 4 bytes so that a new extra field can
/// consume the space. The existing data descriptor will remain in the gap
/// between entries and data will not be shifted.
pub fn make_non_streaming(file: impl Read + Write + Seek) -> Result<(), rawzip::Error> {
// rawzip currently does not expose the CRC32 value, so we'll have to read
// it ourselves.
struct EntryInfo {
local_header_offset: u64,
central_header_offset: u64,
crc32: u32,
compressed_size: u64,
uncompressed_size: u64,
local_extra_fields: Vec<u8>,
}
let mut to_update = vec![];
let mut central_buffer = vec![0u8; RECOMMENDED_BUFFER_SIZE];
let mut local_buffer = vec![0u8; RECOMMENDED_BUFFER_SIZE];
let archive = ZipArchive::from_seekable(file, &mut central_buffer)?;
let mut entries = archive.entries_safe(&mut central_buffer);
while let Some((cd_entry, entry)) = entries.next_entry()? {
let wf = cd_entry.wayfinder();
let local_header = entry.local_header(&mut local_buffer)?;
to_update.push(EntryInfo {
local_header_offset: cd_entry.local_header_offset(),
central_header_offset: cd_entry.central_directory_offset(),
crc32: cd_entry.crc32(),
compressed_size: wf.compressed_size_hint(),
uncompressed_size: wf.uncompressed_size_hint(),
local_extra_fields: local_header.extra_fields().remaining_bytes().to_vec(),
});
}
let mut file = archive.into_inner().into_inner();
for entry in to_update {
// Clear the central header's streaming flag.
let mut central_flags = little_endian::U16::new(0);
file.seek(SeekFrom::Start(entry.central_header_offset + 8))?;
file.read_exact(central_flags.as_mut_bytes())?;
central_flags &= !0x8;
file.seek_relative(-(central_flags.as_bytes().len() as i64))?;
file.write_all(central_flags.as_bytes())?;
file.seek(SeekFrom::Start(entry.local_header_offset))?;
let mut local_header = ZipLocalHeader::new_zeroed();
file.read_exact(local_header.as_mut_bytes())?;
// Clear the local header's streaming flag.
local_header.flags &= !0x8;
// Remove dependency on the data descriptor.
local_header.crc32.set(entry.crc32);
let compressed_is_zip64 = entry.compressed_size >= 0xffffffff;
let uncompressed_is_zip64 = entry.uncompressed_size >= 0xffffffff;
if compressed_is_zip64 {
local_header.compressed_size.set(0xffffffff);
} else {
local_header
.compressed_size
.set(entry.compressed_size as u32);
}
if uncompressed_is_zip64 {
local_header.uncompressed_size.set(0xffffffff);
} else {
local_header
.uncompressed_size
.set(entry.uncompressed_size as u32);
}
file.seek_relative(-(local_header.as_bytes().len() as i64))?;
file.write_all(local_header.as_bytes())?;
file.seek_relative(i64::from(local_header.file_name_len.get()))?;
if !compressed_is_zip64 && !uncompressed_is_zip64 {
continue;
}
let mut extra_fields = Vec::with_capacity(entry.local_extra_fields.len());
let mut patched_placeholder = false;
for (id, data) in ExtraFields::new(&entry.local_extra_fields) {
if id == ExtraFieldId::ANDROID_ZIP_ALIGNMENT {
let zip64_len =
8 * (usize::from(compressed_is_zip64) + usize::from(uncompressed_is_zip64));
// Any unused space needs to be at least 4 bytes, so we can
// properly write a new extra field for padding.
let have_needed_space = match data.len().cmp(&zip64_len) {
Ordering::Less => false,
Ordering::Equal => true,
Ordering::Greater => data.len() - zip64_len >= 4,
};
if !have_needed_space {
return Err(rawzip::ErrorKind::InvalidInput {
msg: format!(
"Invalid reserved ZIP64 local extra field size: {}",
data.len()
),
}
.into());
}
// The order is indeed backwards compared to the header
// fields (APPNOTE 4.5.3).
extra_fields.extend_from_slice(&ExtraFieldId::ZIP64.as_u16().to_le_bytes());
extra_fields.extend_from_slice(&(zip64_len as u16).to_le_bytes());
if uncompressed_is_zip64 {
extra_fields.extend_from_slice(&entry.uncompressed_size.to_le_bytes());
}
if compressed_is_zip64 {
extra_fields.extend_from_slice(&entry.compressed_size.to_le_bytes());
}
// Keep using ANDROID_ZIP_ALIGNMENT for padding.
if data.len() > zip64_len {
let padding_len = data.len() - zip64_len - 4;
extra_fields.extend_from_slice(&id.as_u16().to_le_bytes());
extra_fields.extend_from_slice(&(padding_len as u16).to_le_bytes());
extra_fields.resize(extra_fields.len() + padding_len, 0);
}
patched_placeholder = true;
} else if id == ExtraFieldId::ZIP64 {
return Err(rawzip::ErrorKind::InvalidInput {
msg: "Unexpected ZIP64 extra field present".to_owned(),
}
.into());
} else {
extra_fields.extend_from_slice(&id.as_u16().to_le_bytes());
extra_fields.extend_from_slice(&(data.len() as u16).to_le_bytes());
extra_fields.extend_from_slice(data);
}
}
assert_eq!(extra_fields.len(), entry.local_extra_fields.len());
if !patched_placeholder {
return Err(rawzip::ErrorKind::InvalidInput {
msg: "ZIP64 required, but no placeholder extra field found".to_owned(),
}
.into());
}
file.write_all(&extra_fields)?;
}
Ok(())
}
+2 -4
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
//! Since avbroot is primarily an application and not a library, the semver
//! versioning covers the CLI only. All Rust APIs can change at any time, even
+11 -10
View File
@@ -1,18 +1,19 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::sync::{
atomic::{AtomicBool, Ordering},
Arc,
use std::{
process::ExitCode,
sync::{
Arc,
atomic::{AtomicBool, Ordering},
},
};
use tracing::error;
static LOGGING_INITIALIZED: AtomicBool = AtomicBool::new(false);
fn main() {
fn main() -> ExitCode {
// Set up a cancel signal so we can properly clean up any temporary files.
let cancel_signal = Arc::new(AtomicBool::new(false));
{
@@ -25,14 +26,14 @@ fn main() {
}
match avbroot::cli::args::main(&LOGGING_INITIALIZED, &cancel_signal) {
Ok(_) => {}
Ok(()) => ExitCode::SUCCESS,
Err(e) => {
if LOGGING_INITIALIZED.load(Ordering::SeqCst) {
error!("{e:?}");
} else {
eprintln!("{e:?}");
}
std::process::exit(1);
ExitCode::FAILURE
}
}
}
+4 -6
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
//! Hack to format an integer as an octal string because toml_edit can't output
//! octal-formatted integers and many other toml parsers can't parse it either.
@@ -12,7 +10,7 @@ use std::{
};
use num_traits::{Num, PrimInt};
use serde::{de::Visitor, Deserializer, Serializer};
use serde::{Deserializer, Serializer, de::Visitor};
pub fn serialize<S, T>(data: &T, serializer: S) -> Result<S::Ok, S::Error>
where
@@ -30,7 +28,7 @@ where
{
struct OctalStrVisitor<T>(PhantomData<T>);
impl<'de, T> Visitor<'de> for OctalStrVisitor<T>
impl<T> Visitor<'_> for OctalStrVisitor<T>
where
T: PrimInt,
<T as Num>::FromStrRadixErr: fmt::Display,
+423 -257
View File
File diff suppressed because it is too large Load Diff
+2 -4
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
pub mod boot;
pub mod otacert;
+41 -26
View File
@@ -1,17 +1,18 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{borrow::Cow, cmp::Ordering, io::Cursor};
use std::{borrow::Cow, cmp::Ordering, io::Cursor, path::Path};
use bitflags::bitflags;
use rawzip::{CompressionMethod, ZipArchiveWriter};
use thiserror::Error;
use tracing::trace;
use x509_cert::{der::asn1::BitString, Certificate};
use zip::{result::ZipError, write::FileOptions, CompressionMethod, ZipWriter};
use x509_cert::{Certificate, der::asn1::BitString};
use crate::{crypto, format::ota};
use crate::{
crypto,
format::{ota, zip},
};
#[derive(Debug, Error)]
pub enum Error {
@@ -19,12 +20,10 @@ pub enum Error {
ZipTooSmall(usize),
#[error("New otacerts.zip is too large to fit in {0} bytes")]
ZipTooLarge(usize),
#[error("Crypto error")]
Crypto(#[from] crypto::Error),
#[error("x509 DER error")]
Der(#[from] x509_cert::der::Error),
#[error("Zip error")]
Zip(#[from] ZipError),
#[error("Failed to write otacerts zip")]
ZipWrite(#[source] rawzip::Error),
#[error("Failed to write certificate to otacerts zip")]
CertWrite(#[source] crypto::Error),
}
type Result<T> = std::result::Result<T, Error>;
@@ -75,16 +74,23 @@ bitflags! {
/// Create an `otacerts.zip` file containing the specified certificate.
pub fn create_zip(cert: &Certificate, flags: OtaCertBuildFlags) -> Result<Vec<u8>> {
let raw_writer = Cursor::new(Vec::new());
let mut writer = ZipWriter::new(raw_writer);
let mut writer = ZipArchiveWriter::new(raw_writer);
let compression_method = if flags.contains(OtaCertBuildFlags::COMPRESS_DEFLATE) {
CompressionMethod::Deflated
CompressionMethod::Deflate
} else {
CompressionMethod::Stored
CompressionMethod::Store
};
let options = FileOptions::default().compression_method(compression_method);
writer.start_file("ota.x509.pem", options)?;
let name = "ota.x509.pem";
let (entry_writer, data_config) = writer
.new_file(name)
.compression_method(compression_method)
.start()
.map_err(Error::ZipWrite)?;
let compressed_writer =
zip::compressed_writer(entry_writer, compression_method).map_err(Error::ZipWrite)?;
let mut data_writer = data_config.wrap(compressed_writer);
let cert = if flags.is_empty() {
Cow::Borrowed(cert)
@@ -92,12 +98,14 @@ pub fn create_zip(cert: &Certificate, flags: OtaCertBuildFlags) -> Result<Vec<u8
let mut modified = cert.clone();
if flags.contains(OtaCertBuildFlags::REMOVE_SIGNATURE) {
modified.signature = BitString::from_bytes(&[])?;
// An empty ASN.1 bit string is always valid.
modified.signature =
BitString::from_bytes(&[]).expect("Empty ASN.1 bit string was invalid");
}
if flags.contains(OtaCertBuildFlags::REMOVE_EXTENSIONS) {
if let Some(extensions) = &mut modified.tbs_certificate.extensions {
extensions.clear();
}
if flags.contains(OtaCertBuildFlags::REMOVE_EXTENSIONS)
&& let Some(extensions) = &mut modified.tbs_certificate.extensions
{
extensions.clear();
}
if flags.contains(OtaCertBuildFlags::REMOVE_ISSUER) {
modified.tbs_certificate.issuer.0.clear();
@@ -111,9 +119,16 @@ pub fn create_zip(cert: &Certificate, flags: OtaCertBuildFlags) -> Result<Vec<u8
Cow::Owned(modified)
};
crypto::write_pem_cert(&mut writer, &cert)?;
crypto::write_pem_cert(Path::new(name), &mut data_writer, &cert).map_err(Error::CertWrite)?;
let raw_writer = writer.finish()?;
data_writer
.finish()
.and_then(|(w, d)| w.finish()?.finish(d))
.map_err(Error::ZipWrite)?;
let mut raw_writer = writer.finish().map_err(Error::ZipWrite)?;
zip::make_non_streaming(&mut raw_writer).map_err(Error::ZipWrite)?;
Ok(raw_writer.into_inner())
}
+72 -73
View File
@@ -1,29 +1,28 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
io::{self, Cursor, SeekFrom},
io::{self, Seek, SeekFrom, Write},
ops::Range,
sync::atomic::AtomicBool,
};
use memchr::memmem;
use rawzip::ZipArchive;
use rayon::iter::{IntoParallelIterator, ParallelIterator};
use rsa::RsaPrivateKey;
use thiserror::Error;
use tracing::{debug, debug_span, trace, Span};
use tracing::{Span, debug, debug_span, trace};
use x509_cert::Certificate;
use zip::ZipArchive;
use crate::{
crypto::RsaSigningKey,
format::{
avb::{self, AppendedDescriptorMut, Footer},
ota,
zip::{ZipFileHeaderRecordExt, ZipSliceEntriesSafeExt},
},
patch::otacert,
stream::{self, ReadSeekReopen, SectionReader, WriteSeekReopen},
stream::{self, ReadFixedSizeExt, ReadWriteAt, UserPosFile},
util,
};
@@ -35,14 +34,16 @@ pub enum Error {
NoFooter,
#[error("No hash tree descriptor found in vbmeta header")]
NoHashTreeDescriptor,
#[error("{0:?} field is out of bounds")]
FieldOutOfBounds(&'static str),
#[error("AVB error")]
Avb(#[from] avb::Error),
#[error("OTA certificate error")]
OtaCert(#[from] otacert::Error),
#[error("I/O error")]
Io(#[from] io::Error),
#[error("{0:?} overflowed integer bounds during calculations")]
IntOverflow(&'static str),
#[error("Failed to update AVB header")]
AvbUpdate(#[source] avb::Error),
#[error("Failed to generate replacement otacerts zip")]
OtaCertZip(#[source] otacert::Error),
#[error("Failed to read image data")]
ReadData(#[source] io::Error),
#[error("Failed to write image data")]
WriteData(#[source] io::Error),
}
type Result<T> = std::result::Result<T, Error>;
@@ -68,25 +69,28 @@ fn find_zip_bounds(data: &[u8], eocd_offset: usize) -> Option<Range<usize>> {
trace!("Found zip bounds: {:?}", start..end);
let reader = SectionReader::new(Cursor::new(data), start as u64, (end - start) as u64).ok()?;
let mut zip_reader = ZipArchive::new(reader).ok()?;
let archive = ZipArchive::from_slice(&data[start..end]).ok()?;
let mut entries = archive.entries_safe();
let mut matches = 0;
if zip_reader.is_empty() {
while let Some((cd_entry, _)) = entries.next_entry().ok()? {
let path = cd_entry.file_path_utf8().ok()?;
if !path.ends_with(".x509.pem") {
// otacerts.zip files only contain files named this way.
trace!("Excluded due to invalid name: {path:?}");
return None;
}
matches += 1;
}
if matches == 0 {
// otacerts.zip files contain at least one cert.
trace!("Zip is empty");
return None;
}
for index in 0..zip_reader.len() {
let entry = zip_reader.by_index_raw(index).ok()?;
if !entry.name().ends_with(".x509.pem") {
// otacerts.zip files only contain files named this way.
trace!("Excluded due to invalid name: {:?}", entry.name());
return None;
}
}
debug!("Found otacerts.zip candidate");
// There's one or more entries and every one is named *.x509.pem.
@@ -96,8 +100,7 @@ fn find_zip_bounds(data: &[u8], eocd_offset: usize) -> Option<Range<usize>> {
/// Replace `otacerts.zip` with a new one containing the new certificate, but
/// padded to the same size. If the new zip is too large, the certificate will
/// be modified to remove unnecessary components until it fits. All operations
/// run in parallel where possible. The input and output must refer to the same
/// file and will be reopened from multiple threads.
/// run in parallel where possible.
///
/// Returns two sorted and non-overlapping lists of byte ranges that were
/// modified. The first list are the byte regions within the filesystem data
@@ -108,10 +111,9 @@ fn find_zip_bounds(data: &[u8], eocd_offset: usize) -> Option<Range<usize>> {
/// modified.
#[allow(clippy::type_complexity)]
pub fn patch_system_image(
input: &(dyn ReadSeekReopen + Sync),
output: &(dyn WriteSeekReopen + Sync),
raw_file: &(dyn ReadWriteAt + Sync),
certificate: &Certificate,
key: &RsaPrivateKey,
key: &RsaSigningKey,
cancel_signal: &AtomicBool,
) -> Result<(Vec<Range<u64>>, Vec<Range<u64>>)> {
// This must be a multiple of normal filesystem block sizes (eg. 4 KiB).
@@ -121,11 +123,14 @@ pub fn patch_system_image(
let parent_span = Span::current();
let (mut header, footer, image_size) = avb::load_image(input.reopen_boxed()?)?;
let (mut header, footer, image_size) =
avb::load_image(UserPosFile::new(raw_file)).map_err(Error::AvbUpdate)?;
let Some(mut footer) = footer else {
return Err(Error::NoFooter);
};
let AppendedDescriptorMut::HashTree(descriptor) = header.appended_descriptor_mut()? else {
let AppendedDescriptorMut::HashTree(descriptor) =
header.appended_descriptor_mut().map_err(Error::AvbUpdate)?
else {
return Err(Error::NoHashTreeDescriptor);
};
@@ -135,17 +140,18 @@ pub fn patch_system_image(
let modified_ranges = (0..num_chunks)
.into_par_iter()
.map(|chunk| -> Result<Vec<Range<u64>>> {
stream::check_cancel(cancel_signal)?;
stream::check_cancel(cancel_signal).map_err(Error::ReadData)?;
let offset = chunk * CHUNK_SIZE;
let size = CHUNK_SIZE.min(footer.original_image_size - offset);
let mut buf = vec![0u8; size as usize];
let mut reader = input.reopen_boxed()?;
reader.seek(SeekFrom::Start(offset))?;
reader.read_exact(&mut buf)?;
let mut file = UserPosFile::new(raw_file);
file.seek(SeekFrom::Start(offset))
.map_err(Error::ReadData)?;
let buf = file
.read_vec_exact(size as usize)
.map_err(Error::ReadData)?;
let mut writer = output.reopen_boxed()?;
let mut ranges = Vec::<Range<u64>>::new();
for eocd_offset_rel in memmem::find_iter(&buf, ota::ZIP_EOCD_MAGIC) {
@@ -157,14 +163,16 @@ pub fn patch_system_image(
};
let zip_size = bounds_rel.end - bounds_rel.start;
let new_zip = otacert::create_zip_with_size(certificate, zip_size)?;
let new_zip = otacert::create_zip_with_size(certificate, zip_size)
.map_err(Error::OtaCertZip)?;
let bounds = offset + bounds_rel.start as u64..offset + bounds_rel.end as u64;
stream::check_cancel(cancel_signal)?;
stream::check_cancel(cancel_signal).map_err(Error::WriteData)?;
writer.seek(SeekFrom::Start(bounds.start))?;
writer.write_all(&new_zip)?;
file.seek(SeekFrom::Start(bounds.start))
.map_err(Error::WriteData)?;
file.write_all(&new_zip).map_err(Error::WriteData)?;
ranges.push(bounds);
}
@@ -180,36 +188,27 @@ pub fn patch_system_image(
return Err(Error::OldZipNotFound);
}
let update_ranges = if descriptor.hash_algorithm == "sha1" {
// Promote to a secure algorithm. SHA1 is allowed for verification only.
// The entire hash tree and FEC data will need to be recomputed.
let new_algorithm = "sha256".to_owned();
// Only need to update the hash tree and FEC data corresponding to the
// modified regions.
let update_ranges = Some(modified_ranges.as_slice());
debug!(
"Changing insecure hash algorithm {} to {new_algorithm}",
descriptor.hash_algorithm,
);
descriptor.hash_algorithm = new_algorithm;
None
} else {
// Only need to update the hash tree and FEC data corresponding to the
// modified regions.
Some(modified_ranges.as_slice())
};
descriptor.update(input, output, update_ranges, cancel_signal)?;
descriptor
.update(raw_file, update_ranges, cancel_signal)
.map_err(Error::AvbUpdate)?;
if !header.public_key.is_empty() {
debug!("Signing system image");
header.set_algo_for_key(key)?;
header.sign(key)?;
header.set_algo_for_key(key).map_err(Error::AvbUpdate)?;
header.sign(key).map_err(Error::AvbUpdate)?;
}
let writer = output.reopen_boxed()?;
avb::write_appended_image(writer, &header, &mut footer, Some(image_size))?;
let file = UserPosFile::new(raw_file);
avb::write_appended_image(file, &header, &mut footer, Some(image_size))
.map_err(Error::AvbUpdate)?;
let AppendedDescriptorMut::HashTree(descriptor) = header.appended_descriptor_mut()? else {
let AppendedDescriptorMut::HashTree(descriptor) =
header.appended_descriptor_mut().map_err(Error::AvbUpdate)?
else {
return Err(Error::NoHashTreeDescriptor);
};
@@ -217,15 +216,15 @@ pub fn patch_system_image(
let hash_tree_end = descriptor
.tree_offset
.checked_add(descriptor.tree_size)
.ok_or_else(|| Error::FieldOutOfBounds("hash_tree_end"))?;
.ok_or(Error::IntOverflow("hash_tree_end"))?;
let fec_data_end = descriptor
.fec_offset
.checked_add(descriptor.fec_size)
.ok_or_else(|| Error::FieldOutOfBounds("fec_data_end"))?;
.ok_or(Error::IntOverflow("fec_data_end"))?;
let header_end = footer
.vbmeta_offset
.checked_add(footer.vbmeta_size)
.ok_or_else(|| Error::FieldOutOfBounds("avb_end"))?;
.ok_or(Error::IntOverflow("avb_end"))?;
let footer_start = image_size - Footer::SIZE as u64;
let other_ranges = util::merge_overlapping(&[
+4
View File
@@ -1,3 +1,7 @@
#![allow(clippy::all)]
#![allow(clippy::nursery)]
#![allow(clippy::pedantic)]
pub mod build {
pub mod tools {
pub mod releasetools {
+320 -327
View File
@@ -1,56 +1,46 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
fs::File,
io::{self, BufReader, BufWriter, Cursor, Read, Seek, SeekFrom, Write},
io::{self, Read, Seek, SeekFrom, Write},
sync::{
Arc, Mutex,
atomic::{AtomicBool, Ordering},
Arc, Mutex, RwLock,
},
};
use bstr::ByteSlice;
use num_traits::ToPrimitive;
use ring::digest::Context;
use crate::util;
/// A trait for seekable readers. This is only needed because `dyn Read + Seek`
/// is not a valid construct in Rust yet.
pub trait ReadSeek: Read + Seek {}
/// This is only needed because `dyn Read + Seek` is not a valid construct in
/// Rust yet.
pub trait ReadSeek: Read + Seek {
// https://github.com/rust-lang/rust/issues/145752
fn issue_145752(&self) {}
}
impl<R: Read + Seek> ReadSeek for R {}
/// A trait for seekable writers. This is only needed because `dyn Write + Seek`
/// is not a valid construct in Rust yet.
pub trait WriteSeek: Write + Seek {}
/// This is only needed because `dyn Write + Seek` is not a valid construct in
/// Rust yet.
pub trait WriteSeek: Write + Seek {
// https://github.com/rust-lang/rust/issues/145752
fn issue_145752(&self) {}
}
impl<W: Write + Seek> WriteSeek for W {}
/// A trait for seekable and reopenable readers.
pub trait ReadSeekReopen: ReadSeek {
fn reopen_boxed(&self) -> io::Result<Box<dyn ReadSeek>>;
/// This is only needed because `dyn Read + Write + Seek` is not a valid
/// construct in Rust yet.
pub trait ReadWriteSeek: ReadSeek + WriteSeek {
// https://github.com/rust-lang/rust/issues/145752
fn issue_145752(&self) {}
}
impl<R: ReadSeek + Reopen + 'static> ReadSeekReopen for R {
fn reopen_boxed(&self) -> io::Result<Box<dyn ReadSeek>> {
Ok(Box::new(self.reopen()?))
}
}
/// A trait for seekable and reopenable writers.
pub trait WriteSeekReopen: WriteSeek {
fn reopen_boxed(&self) -> io::Result<Box<dyn WriteSeek>>;
}
impl<W: WriteSeek + Reopen + 'static> WriteSeekReopen for W {
fn reopen_boxed(&self) -> io::Result<Box<dyn WriteSeek>> {
Ok(Box::new(self.reopen()?))
}
}
impl<W: ReadSeek + WriteSeek> ReadWriteSeek for W {}
/// Common function for reading a structure from a reader.
pub trait FromReader<R: Read>: Sized {
@@ -124,94 +114,147 @@ impl<W: Write> WriteZerosExt for W {
}
}
/// Extensions for readers to read strings.
pub trait ReadStringExt {
/// Read exact sized string.
fn read_string_exact(&mut self, size: usize) -> io::Result<String>;
/// Extensions for readers to read fixed-size buffers.
pub trait ReadFixedSizeExt {
/// Read fixed-size array.
fn read_array_exact<const N: usize>(&mut self) -> io::Result<[u8; N]>;
/// Read string with maximum size and trim trailing zeros.
fn read_string_padded(&mut self, max_size: usize) -> io::Result<String>;
/// Read fixed-sized [`Vec`].
fn read_vec_exact(&mut self, size: usize) -> io::Result<Vec<u8>>;
}
impl<R: Read> ReadStringExt for R {
fn read_string_exact(&mut self, size: usize) -> io::Result<String> {
impl<R: Read> ReadFixedSizeExt for R {
fn read_array_exact<const N: usize>(&mut self) -> io::Result<[u8; N]> {
let mut buf = [0u8; N];
self.read_exact(&mut buf)?;
Ok(buf)
}
fn read_vec_exact(&mut self, size: usize) -> io::Result<Vec<u8>> {
let mut buf = vec![0u8; size];
self.read_exact(&mut buf)?;
String::from_utf8(buf).map_err(|e| {
io::Error::new(
io::ErrorKind::InvalidData,
format!("Invalid UTF-8: {:?}: {e}", e.as_bytes().as_bstr()),
)
})
}
fn read_string_padded(&mut self, max_size: usize) -> io::Result<String> {
let mut buf = vec![0u8; max_size];
self.read_exact(&mut buf)?;
let after_last_non_zero = buf
.iter()
.rev()
.position(|&b| b != 0)
.map_or(0, |i| buf.len() - i);
buf.resize(after_last_non_zero, 0);
buf.shrink_to_fit();
String::from_utf8(buf).map_err(|e| {
io::Error::new(
io::ErrorKind::InvalidData,
format!("Invalid UTF-8: {:?}: {e}", e.as_bytes().as_bstr()),
)
})
Ok(buf)
}
}
/// Extensions for writers to write strings.
pub trait WriteStringExt {
fn write_string_padded(&mut self, data: &str, max_size: usize) -> io::Result<()>;
/// Extensions for file-like types to query the file size. No guarantees are
/// made about the state of the underlying file position after performing any
/// operation.
pub trait FileLen {
fn file_len(&self) -> io::Result<u64>;
}
impl<W: Write> WriteStringExt for W {
fn write_string_padded(&mut self, data: &str, max_size: usize) -> io::Result<()> {
if data.len() > max_size {
macro_rules! file_len_blanket_impl {
($type:ty) => {
impl<F: ?Sized + FileLen> FileLen for $type {
fn file_len(&self) -> io::Result<u64> {
(**self).file_len()
}
}
};
}
file_len_blanket_impl!(&F);
file_len_blanket_impl!(Arc<F>);
file_len_blanket_impl!(Box<F>);
/// Extensions for file-like types that support multi-threaded reads at specific
/// offsets. No guarantees are made about the state of underlying file position
/// after performing any operation.
pub trait ReadAt: FileLen {
fn read_at(&self, buf: &mut [u8], offset: u64) -> io::Result<usize>;
fn read_exact_at(&self, buf: &mut [u8], offset: u64) -> io::Result<()> {
let n = self.read_at(buf, offset)?;
if n != buf.len() {
return Err(io::Error::new(
io::ErrorKind::InvalidInput,
format!("{data:?} exceeds maximum size of {max_size} bytes"),
io::ErrorKind::UnexpectedEof,
format!(
"Expected to read {} bytes at {offset}, but reached EOF after {n} bytes",
buf.len(),
),
));
}
self.write_all(data.as_bytes())?;
let num_zeros = (max_size - data.len()) as u64;
self.write_zeros_exact(num_zeros)?;
Ok(())
}
}
/// Extensions for file-like types to reopen themselves.
pub trait Reopen: Sized {
/// Open a new handle to the same file. The new handle is independently
/// seekable and the file offset is initially set to 0.
fn reopen(&self) -> io::Result<Self>;
macro_rules! read_at_blanket_impl {
($type:ty) => {
impl<R: ?Sized + ReadAt> ReadAt for $type {
fn read_at(&self, buf: &mut [u8], offset: u64) -> io::Result<usize> {
(**self).read_at(buf, offset)
}
fn read_exact_at(&self, buf: &mut [u8], offset: u64) -> io::Result<()> {
(**self).read_exact_at(buf, offset)
}
}
};
}
impl<R: Read + Reopen> Reopen for BufReader<R> {
fn reopen(&self) -> io::Result<Self> {
Ok(BufReader::new(self.get_ref().reopen()?))
read_at_blanket_impl!(&R);
read_at_blanket_impl!(Arc<R>);
read_at_blanket_impl!(Box<R>);
/// Extensions for file-like types that support multi-threaded writes at
/// specific offsets. The behavior is unspecified if writes would overlap. No
/// guarantees are made about the state of the underlying file position after
/// performing any operation.
pub trait WriteAt: FileLen {
fn write_at(&self, buf: &[u8], offset: u64) -> io::Result<usize>;
fn write_all_at(&self, buf: &[u8], offset: u64) -> io::Result<()> {
let n = self.write_at(buf, offset)?;
if n != buf.len() {
return Err(io::Error::new(
io::ErrorKind::UnexpectedEof,
format!(
"Expected to write {} bytes at {offset}, but reached EOF after {n} bytes",
buf.len(),
),
));
}
Ok(())
}
fn file_flush(&self) -> io::Result<()>;
}
impl<W: Write + Reopen> Reopen for BufWriter<W> {
fn reopen(&self) -> io::Result<Self> {
Ok(BufWriter::new(self.get_ref().reopen()?))
}
macro_rules! write_at_blanket_impl {
($type:ty) => {
impl<W: ?Sized + WriteAt> WriteAt for $type {
fn write_at(&self, buf: &[u8], offset: u64) -> io::Result<usize> {
(**self).write_at(buf, offset)
}
fn write_all_at(&self, buf: &[u8], offset: u64) -> io::Result<()> {
(**self).write_all_at(buf, offset)
}
fn file_flush(&self) -> io::Result<()> {
(**self).file_flush()
}
}
};
}
write_at_blanket_impl!(&W);
write_at_blanket_impl!(Arc<W>);
write_at_blanket_impl!(Box<W>);
/// This is only needed because `dyn ReadAt + WriteAt` is not a valid construct
/// in Rust yet.
pub trait ReadWriteAt: ReadAt + WriteAt {
// https://github.com/rust-lang/rust/issues/145752
fn issue_145752(&self) {}
}
impl<F: ReadAt + WriteAt> ReadWriteAt for F {}
/// A reader wrapper that implements [`Seek`], but only for reporting the
/// current file position.
pub struct CountingReader<R: Read> {
pub struct CountingReader<R> {
inner: R,
offset: u64,
}
@@ -249,7 +292,7 @@ impl<R: Read> Seek for CountingReader<R> {
/// A writer wrapper that implements [`Seek`], but only for reporting the
/// current file position.
pub struct CountingWriter<W: Write> {
pub struct CountingWriter<W> {
inner: W,
offset: u64,
}
@@ -290,7 +333,7 @@ impl<W: Write> Seek for CountingWriter<W> {
}
/// A reader wrapper that hashes data as it's being read.
pub struct HashingReader<R: Read> {
pub struct HashingReader<R> {
inner: R,
context: Context,
}
@@ -314,7 +357,7 @@ impl<R: Read> Read for HashingReader<R> {
}
/// A writer wrapper that hashes data as it's being written.
pub struct HashingWriter<W: Write> {
pub struct HashingWriter<W> {
inner: W,
context: Context,
}
@@ -342,7 +385,7 @@ impl<W: Write> Write for HashingWriter<W> {
}
/// A reader wrapper that only allows reading a specific section of a file.
pub struct SectionReader<R: Read + Seek> {
pub struct SectionReader<R> {
inner: R,
start: u64,
size: u64,
@@ -366,14 +409,6 @@ impl<R: Read + Seek> SectionReader<R> {
}
}
impl<R: Read + Seek + Reopen> Reopen for SectionReader<R> {
fn reopen(&self) -> io::Result<Self> {
let inner = self.inner.reopen()?;
Self::new(inner, self.start, self.size)
}
}
impl<R: Read + Seek> Read for SectionReader<R> {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
let to_read = self.size.saturating_sub(self.pos).min(buf.len() as u64) as usize;
@@ -416,125 +451,179 @@ impl<R: Read + Seek> Seek for SectionReader<R> {
}
}
/// A writer wrapper that seeks instead of writing when a write buffer consists
/// solely of zeros.
#[derive(Debug)]
pub struct HolePunchingWriter<W: Write + Seek> {
inner: W,
/// A reader wrapper that only allows reading a specific section of a file.
pub struct SectionReaderAt<R> {
inner: R,
start: u64,
size: u64,
}
impl<W: Write + Seek> HolePunchingWriter<W> {
pub fn new(inner: W) -> Self {
Self { inner }
impl<R: ReadAt> SectionReaderAt<R> {
pub fn new(inner: R, start: u64, size: u64) -> io::Result<Self> {
Ok(Self { inner, start, size })
}
pub fn into_inner(self) -> W {
pub fn into_inner(self) -> R {
self.inner
}
}
impl<W: Write + Seek> Write for HolePunchingWriter<W> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
if util::is_zero(buf) {
self.inner.seek(SeekFrom::Current(buf.len() as i64))?;
Ok(buf.len())
} else {
self.inner.write(buf)
}
}
fn flush(&mut self) -> io::Result<()> {
self.inner.flush()
impl<R> FileLen for SectionReaderAt<R> {
fn file_len(&self) -> io::Result<u64> {
Ok(self.size)
}
}
/// A file wrapper that uses a userspace file offset. A reopened instance uses
/// the same underlying kernel file descriptor, but a new userspace file offset,
/// initially set to 0.
#[derive(Debug)]
pub struct PSeekFile {
// The lock is needed because flush() takes a `&mut self`.
file: Arc<RwLock<File>>,
offset: u64,
impl<R: ReadAt> ReadAt for SectionReaderAt<R> {
fn read_at(&self, buf: &mut [u8], offset: u64) -> io::Result<usize> {
let to_read = self.size.saturating_sub(offset).min(buf.len() as u64) as usize;
self.inner.read_at(&mut buf[..to_read], self.start + offset)
}
}
impl PSeekFile {
pub fn new(file: File) -> Self {
Self {
file: Arc::new(RwLock::new(file)),
offset: 0,
}
}
pub fn set_len(&self, size: u64) -> io::Result<()> {
let file_locked = self.file.read().unwrap();
file_locked.set_len(size)
}
/// Regular files support parallel reads.
impl ReadAt for File {
/// Read data from offset. The kernel's file position *will* be changed.
#[cfg(windows)]
fn read_at(&self, buf: &mut [u8]) -> io::Result<usize> {
fn read_at(&self, buf: &mut [u8], offset: u64) -> io::Result<usize> {
use std::os::windows::fs::FileExt;
self.file.read().unwrap().seek_read(buf, self.offset)
FileExt::seek_read(self, buf, offset)
}
/// Read data from offset. The kernel's file position will *not* be changed.
#[cfg(unix)]
fn read_at(&self, buf: &mut [u8]) -> io::Result<usize> {
fn read_at(&self, buf: &mut [u8], offset: u64) -> io::Result<usize> {
use std::os::unix::fs::FileExt;
self.file.read().unwrap().read_at(buf, self.offset)
FileExt::read_at(self, buf, offset)
}
}
/// Regular files support parallel writes.
impl WriteAt for File {
/// Write data to offset. The kernel's file position *will* be changed.
#[cfg(windows)]
fn write_at(&self, buf: &[u8]) -> io::Result<usize> {
fn write_at(&self, buf: &[u8], offset: u64) -> io::Result<usize> {
use std::os::windows::fs::FileExt;
self.file.read().unwrap().seek_write(buf, self.offset)
FileExt::seek_write(self, buf, offset)
}
/// Write data to offset. The kernel's file position will *not* be changed.
#[cfg(unix)]
fn write_at(&self, buf: &[u8]) -> io::Result<usize> {
fn write_at(&self, buf: &[u8], offset: u64) -> io::Result<usize> {
use std::os::unix::fs::FileExt;
self.file.read().unwrap().write_at(buf, self.offset)
FileExt::write_at(self, buf, offset)
}
fn file_flush(&self) -> io::Result<()> {
(&*self).flush()
}
}
impl Reopen for PSeekFile {
fn reopen(&self) -> io::Result<Self> {
Ok(Self {
file: self.file.clone(),
offset: 0,
})
impl FileLen for File {
fn file_len(&self) -> io::Result<u64> {
(&*self).seek(SeekFrom::End(0))
}
}
impl Read for PSeekFile {
/// A file wrapper that implements [`ReadAt`] and [`WriteAt`] on top of
/// [`Read`], [`Write`], and [`Seek`] via a mutex that makes operations
/// single-threaded. This is the inverse of [`UserPosFile`].
pub struct MutexFile<F>(Mutex<F>);
impl<F> MutexFile<F> {
pub fn new(file: F) -> Self {
Self(Mutex::new(file))
}
pub fn into_inner(self) -> F {
self.0.into_inner().unwrap()
}
}
impl<F: Seek> FileLen for MutexFile<F> {
fn file_len(&self) -> io::Result<u64> {
let mut inner = self.0.lock().unwrap();
inner.seek(SeekFrom::End(0))
}
}
impl<F: Read + Seek> ReadAt for MutexFile<F> {
fn read_at(&self, buf: &mut [u8], offset: u64) -> io::Result<usize> {
let mut inner = self.0.lock().unwrap();
let pos = inner.stream_position()?;
inner.seek(SeekFrom::Start(offset))?;
let result = inner.read(buf);
inner.seek(SeekFrom::Start(pos))?;
result
}
}
impl<F: Write + Seek> WriteAt for MutexFile<F> {
fn write_at(&self, buf: &[u8], offset: u64) -> io::Result<usize> {
let mut inner = self.0.lock().unwrap();
let pos = inner.stream_position()?;
inner.seek(SeekFrom::Start(offset))?;
let result = inner.write(buf);
inner.seek(SeekFrom::Start(pos))?;
result
}
fn file_flush(&self) -> io::Result<()> {
let mut inner = self.0.lock().unwrap();
inner.flush()
}
}
/// A file wrapper than implements the standard [`Read`], [`Write`], and
/// [`Seek`] traits on top of [`ReadAt`] and [`WriteAt`]. The file position is
/// unique for every instance, even if the underlying file is shared. This is
/// the inverse of [`MutexFile`].
pub struct UserPosFile<F> {
file: F,
offset: u64,
}
impl<F> UserPosFile<F> {
pub fn new(file: F) -> Self {
Self { file, offset: 0 }
}
}
impl<F: ReadAt> Read for UserPosFile<F> {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
let n = self.read_at(buf)?;
let n = self.file.read_at(buf, self.offset)?;
self.offset += n as u64;
Ok(n)
}
}
impl Write for PSeekFile {
impl<F: WriteAt> Write for UserPosFile<F> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
let n = self.write_at(buf)?;
let n = self.file.write_at(buf, self.offset)?;
self.offset += n as u64;
Ok(n)
}
fn flush(&mut self) -> io::Result<()> {
self.file.write().unwrap().flush()
self.file.file_flush()
}
}
impl Seek for PSeekFile {
impl<F: FileLen> Seek for UserPosFile<F> {
fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
self.offset = match pos {
SeekFrom::Start(o) => o,
SeekFrom::End(o) => {
let file_size = self.file.read().unwrap().metadata()?.len();
let file_size = self.file.file_len()?;
file_size
.to_i64()
.and_then(|s| s.checked_add(o))
@@ -563,72 +652,6 @@ impl Seek for PSeekFile {
}
}
/// A small wrapper around a [`Cursor`] that allows multiple instances to share
/// the same underlying file. All reads, writes, and seeks are single-threaded.
/// This is useful for scenarios where data needs to be copied from multiple
/// readers into different parts of the same [`SharedCursor`] writer and the
/// read operation is significantly more expensive than the write operation (eg.
/// due to decompression).
#[derive(Default)]
pub struct SharedCursor {
inner: Arc<Mutex<Cursor<Vec<u8>>>>,
offset: u64,
}
impl SharedCursor {
pub fn new() -> Self {
Self {
..Default::default()
}
}
}
impl Reopen for SharedCursor {
fn reopen(&self) -> io::Result<Self> {
Ok(Self {
inner: self.inner.clone(),
offset: 0,
})
}
}
impl Read for SharedCursor {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
let mut inner = self.inner.lock().unwrap();
inner.seek(SeekFrom::Start(self.offset))?;
let n = inner.read(buf)?;
self.offset += n as u64;
Ok(n)
}
}
impl Write for SharedCursor {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
let mut inner = self.inner.lock().unwrap();
inner.seek(SeekFrom::Start(self.offset))?;
let n = inner.write(buf)?;
self.offset += n as u64;
Ok(n)
}
fn flush(&mut self) -> io::Result<()> {
let mut inner = self.inner.lock().unwrap();
inner.flush()
}
}
impl Seek for SharedCursor {
fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
let mut inner = self.inner.lock().unwrap();
self.offset = inner.seek(pos)?;
Ok(self.offset)
}
}
/// Returns an I/O error with the [`io::ErrorKind::Interrupted`] type if
/// `cancel_signal` is true. This should be called frequently in I/O loops for
/// cancellation to be responsive.
@@ -683,12 +706,14 @@ pub fn copy_n(
copy_n_inspect(reader, writer, size, |_| {}, cancel_signal)
}
/// Copy data from `reader` to `writer` until `reader` reaches EOF. If `writer`
/// reaches EOF before `reader` does, an error is returned. The operation is
/// cancelled on the next loop iteration if `cancel_signal` is set to `true`.
pub fn copy(
/// Copy data from `reader` to `writer` until `reader` reaches EOF, invoking
/// `inspect` after every buffer read iteration. If `writer` reaches EOF before
/// `reader` does, an error is returned. The operation is cancelled on the next
/// loop iteration if `cancel_signal` is set to `true`.
pub fn copy_inspect(
mut reader: impl Read,
mut writer: impl Write,
mut inspect: impl FnMut(&[u8]),
cancel_signal: &AtomicBool,
) -> io::Result<u64> {
let mut buf = [0u8; 16384];
@@ -702,6 +727,8 @@ pub fn copy(
break;
}
inspect(&buf[..n]);
writer.write_all(&buf[..n])?;
copied += n as u64;
@@ -710,6 +737,11 @@ pub fn copy(
Ok(copied)
}
/// Copy data from `reader` to `writer` until `reader` reaches EOF.
pub fn copy(reader: impl Read, writer: impl Write, cancel_signal: &AtomicBool) -> io::Result<u64> {
copy_inspect(reader, writer, |_| {}, cancel_signal)
}
#[cfg(test)]
mod tests {
use std::{
@@ -719,11 +751,9 @@ mod tests {
use ring::digest::Context;
use super::{
CountingReader, CountingWriter, HashingReader, HashingWriter, HolePunchingWriter,
PSeekFile, ReadDiscardExt, ReadStringExt, Reopen, SectionReader, SharedCursor,
WriteStringExt, WriteZerosExt,
};
use crate::stream::FileLen;
use super::*;
const FOOBAR_SHA256: [u8; 32] = [
0xc3, 0xab, 0x8f, 0xf1, 0x37, 0x20, 0xe8, 0xad, 0x90, 0x47, 0xdd, 0x39, 0x46, 0x6b, 0x3c,
@@ -759,32 +789,6 @@ mod tests {
assert_eq!(&writer.into_inner(), b"\0\0foo\0");
}
#[test]
fn read_string() {
let mut reader = Cursor::new(b"foo\0\0bar\0\0");
assert_eq!(reader.read_string_exact(3).unwrap(), "foo");
assert_eq!(reader.read_string_exact(0).unwrap(), "");
reader.rewind().unwrap();
assert_eq!(reader.read_string_padded(3).unwrap(), "foo");
reader.rewind().unwrap();
assert_eq!(reader.read_string_padded(10).unwrap(), "foo\0\0bar");
}
#[test]
fn write_string() {
let mut writer = Cursor::new([0xffu8; 8]);
writer.write_string_padded("foobar", 8).unwrap();
assert_eq!(writer.get_ref(), b"foobar\0\0");
writer.rewind().unwrap();
writer.write_string_padded("foobarhi", 8).unwrap();
assert_eq!(writer.get_ref(), b"foobarhi");
}
#[test]
fn counting_reader() {
let raw_reader = Cursor::new(b"foobar");
@@ -874,7 +878,7 @@ mod tests {
assert_eq!(&buf[..4], b"nner");
buf = *b"\0\0\0\0\0";
reader.seek(SeekFrom::Current(-5)).unwrap();
reader.seek_relative(-5).unwrap();
reader.read_exact(&mut buf[..3]).unwrap();
assert_eq!(&buf[..3], b"inn");
@@ -883,109 +887,98 @@ mod tests {
}
#[test]
fn hole_punching_writer() {
let raw_writer = Cursor::new(b"foobar foobar".to_owned());
let mut writer = HolePunchingWriter::new(raw_writer);
fn section_reader_at() {
let raw_reader = MutexFile::new(Cursor::new(b"fooinnerbar"));
let reader = SectionReaderAt::new(raw_reader, 3, 5).unwrap();
writer.write_all(b"hello").unwrap();
writer.write_all(b"").unwrap();
writer.write_all(b"\0").unwrap();
writer.write_all(b"\0\0").unwrap();
writer.write_all(b"world").unwrap();
let mut buf = [0u8; 5];
reader.read_exact_at(&mut buf[3..5], 3).unwrap();
reader.read_exact_at(&mut buf[..3], 0).unwrap();
assert_eq!(&buf, b"inner");
let raw_writer = writer.into_inner();
assert_eq!(&raw_writer.into_inner(), b"hellor fworld");
}
#[test]
fn pseek_file() {
let raw_file = tempfile::tempfile().unwrap();
let mut a = PSeekFile::new(raw_file);
let mut b = a.reopen().unwrap();
let mut c = b.reopen().unwrap();
b.write_all(b"foobar").unwrap();
c.write_all(b"hello").unwrap();
b.write_all(b"world").unwrap();
c.seek(SeekFrom::Start(0)).unwrap();
c.write_all(b"hi").unwrap();
let mut buf = [0u8; 11];
a.read_exact(&mut buf).unwrap();
assert_eq!(&buf, b"hillorworld");
let n = a.read_discard(1).unwrap();
let n = reader.read_at(&mut buf, 5).unwrap();
assert_eq!(n, 0);
}
#[test]
fn shared_cursor() {
let mut a = SharedCursor::default();
let mut b = a.reopen().unwrap();
let mut c = b.reopen().unwrap();
fn mutex_file() {
let file = MutexFile::new(Cursor::new(Vec::new()));
assert_eq!(file.file_len().unwrap(), 0);
b.write_all(b"foobar").unwrap();
c.write_all(b"hello").unwrap();
b.write_all(b"world").unwrap();
c.seek(SeekFrom::Start(0)).unwrap();
c.write_all(b"hi").unwrap();
file.write_all_at(b"bar", 3).unwrap();
assert_eq!(file.file_len().unwrap(), 6);
let mut buf = [0u8; 11];
a.read_exact(&mut buf).unwrap();
assert_eq!(&buf, b"hillorworld");
file.write_all_at(b"foo", 0).unwrap();
assert_eq!(file.file_len().unwrap(), 6);
let n = a.read_discard(1).unwrap();
assert_eq!(n, 0);
let data = file.into_inner().into_inner();
assert_eq!(data, b"foobar");
}
#[test]
fn copy() {
fn user_pos_file() {
let mut raw_file = tempfile::tempfile().unwrap();
raw_file.write_all(b"foobar").unwrap();
let mut file = UserPosFile::new(raw_file);
let mut buf = [0u8; 3];
file.rewind().unwrap();
file.read_exact(&mut buf).unwrap();
assert_eq!(&buf, b"foo");
let pos = file.seek(SeekFrom::End(-3)).unwrap();
assert_eq!(pos, 3);
file.read_exact(&mut buf).unwrap();
assert_eq!(&buf, b"bar");
}
#[test]
fn copy_functions() {
let cancel_signal = AtomicBool::new(false);
let mut reader = Cursor::new(b"foobar");
let mut writer = Cursor::new([0u8; 6]);
super::copy_n_inspect(&mut reader, &mut writer, 6, |_| {}, &cancel_signal).unwrap();
copy_n(&mut reader, &mut writer, 6, &cancel_signal).unwrap();
assert_eq!(writer.get_ref(), b"foobar");
// Reader early EOF.
reader.seek(SeekFrom::Start(3)).unwrap();
writer.rewind().unwrap();
let err =
super::copy_n_inspect(&mut reader, &mut writer, 6, |_| {}, &cancel_signal).unwrap_err();
let err = copy_n(&mut reader, &mut writer, 6, &cancel_signal).unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::UnexpectedEof);
// Writer early EOF.
reader.rewind().unwrap();
writer.seek(SeekFrom::Start(3)).unwrap();
let err =
super::copy_n_inspect(&mut reader, &mut writer, 6, |_| {}, &cancel_signal).unwrap_err();
let err = copy_n(&mut reader, &mut writer, 6, &cancel_signal).unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::WriteZero);
reader.rewind().unwrap();
writer.rewind().unwrap();
let n = super::copy(&mut reader, &mut writer, &cancel_signal).unwrap();
let n = copy(&mut reader, &mut writer, &cancel_signal).unwrap();
assert_eq!(n, 6);
assert_eq!(writer.get_ref(), b"foobar");
// Reader early EOF.
reader.seek(SeekFrom::Start(3)).unwrap();
writer.rewind().unwrap();
let n = super::copy(&mut reader, &mut writer, &cancel_signal).unwrap();
let n = copy(&mut reader, &mut writer, &cancel_signal).unwrap();
assert_eq!(n, 3);
// Writer early EOF.
reader.rewind().unwrap();
writer.seek(SeekFrom::Start(3)).unwrap();
let err = super::copy(&mut reader, &mut writer, &cancel_signal).unwrap_err();
let err = copy(&mut reader, &mut writer, &cancel_signal).unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::WriteZero);
reader.rewind().unwrap();
writer.rewind().unwrap();
cancel_signal.store(true, Ordering::SeqCst);
let err =
super::copy_n_inspect(&mut reader, &mut writer, 6, |_| {}, &cancel_signal).unwrap_err();
let err = copy_n(&mut reader, &mut writer, 6, &cancel_signal).unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::Interrupted);
let err = super::copy(&mut reader, &mut writer, &cancel_signal).unwrap_err();
let err = copy(&mut reader, &mut writer, &cancel_signal).unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::Interrupted);
}
}
+426 -29
View File
@@ -1,11 +1,18 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{cmp::Ordering, fmt, ops::Range, path::Path};
use std::{
cmp::Ordering,
fmt::{self, Display},
mem,
ops::{
Bound, Range, RangeBounds, RangeFrom, RangeFull, RangeInclusive, RangeTo, RangeToInclusive,
},
path::{Component, Path, PathBuf},
};
use num_traits::PrimInt;
use num_traits::{NumCast, PrimInt};
use thiserror::Error;
pub const ZEROS: [u8; 16384] = [0u8; 16384];
@@ -23,6 +30,263 @@ impl<T: PrimInt + fmt::Debug> fmt::Debug for NumBytes<T> {
}
}
/// Stores a precomputed [`Debug`] string.
#[derive(Clone)]
pub struct DebugString(String);
impl DebugString {
pub fn new(value: impl fmt::Debug) -> Self {
Self(format!("{value:?}"))
}
}
impl fmt::Debug for DebugString {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(&self.0)
}
}
#[derive(Clone, Hash, PartialEq, Eq)]
pub enum AnyRange<T> {
Range(Range<T>),
RangeFrom(RangeFrom<T>),
RangeFull(RangeFull),
RangeInclusive(RangeInclusive<T>),
RangeTo(RangeTo<T>),
RangeToInclusive(RangeToInclusive<T>),
}
impl<T> AnyRange<T> {
pub fn with_bounds(start: Bound<T>, end: Bound<T>) -> Option<Self> {
let result = match (start, end) {
(Bound::Included(s), Bound::Excluded(e)) => Self::Range(s..e),
(Bound::Included(s), Bound::Unbounded) => Self::RangeFrom(s..),
(Bound::Unbounded, Bound::Unbounded) => Self::RangeFull(..),
(Bound::Included(s), Bound::Included(e)) => Self::RangeInclusive(s..=e),
(Bound::Unbounded, Bound::Excluded(e)) => Self::RangeTo(..e),
(Bound::Unbounded, Bound::Included(e)) => Self::RangeToInclusive(..=e),
(Bound::Excluded(_), _) => return None,
};
Some(result)
}
}
impl<T: PartialOrd<T>> AnyRange<T> {
pub fn contains<U>(&self, item: &U) -> bool
where
T: PartialOrd<U>,
U: ?Sized + PartialOrd<T>,
{
<Self as RangeBounds<T>>::contains(self, item)
}
}
impl<T: fmt::Debug> fmt::Debug for AnyRange<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Range(r) => r.fmt(f),
Self::RangeFrom(r) => r.fmt(f),
Self::RangeFull(r) => r.fmt(f),
Self::RangeInclusive(r) => r.fmt(f),
Self::RangeTo(r) => r.fmt(f),
Self::RangeToInclusive(r) => r.fmt(f),
}
}
}
impl<T> RangeBounds<T> for AnyRange<T> {
fn start_bound(&self) -> Bound<&T> {
match self {
Self::Range(r) => r.start_bound(),
Self::RangeFrom(r) => r.start_bound(),
Self::RangeFull(r) => r.start_bound(),
Self::RangeInclusive(r) => r.start_bound(),
Self::RangeTo(r) => r.start_bound(),
Self::RangeToInclusive(r) => r.start_bound(),
}
}
fn end_bound(&self) -> Bound<&T> {
match self {
Self::Range(r) => r.end_bound(),
Self::RangeFrom(r) => r.end_bound(),
Self::RangeFull(r) => r.end_bound(),
Self::RangeInclusive(r) => r.end_bound(),
Self::RangeTo(r) => r.end_bound(),
Self::RangeToInclusive(r) => r.end_bound(),
}
}
}
impl<T> From<Range<T>> for AnyRange<T> {
fn from(value: Range<T>) -> Self {
Self::Range(value)
}
}
impl<T> From<RangeFrom<T>> for AnyRange<T> {
fn from(value: RangeFrom<T>) -> Self {
Self::RangeFrom(value)
}
}
impl<T> From<RangeFull> for AnyRange<T> {
fn from(value: RangeFull) -> Self {
Self::RangeFull(value)
}
}
impl<T> From<RangeInclusive<T>> for AnyRange<T> {
fn from(value: RangeInclusive<T>) -> Self {
Self::RangeInclusive(value)
}
}
impl<T> From<RangeTo<T>> for AnyRange<T> {
fn from(value: RangeTo<T>) -> Self {
Self::RangeTo(value)
}
}
impl<T> From<RangeToInclusive<T>> for AnyRange<T> {
fn from(value: RangeToInclusive<T>) -> Self {
Self::RangeToInclusive(value)
}
}
/// A non-generic type that can represent any 64-bit or smaller primitive
/// integer.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum LargeInt {
Signed(i64),
Unsigned(u64),
}
impl fmt::Display for LargeInt {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Signed(n) => n.fmt(f),
Self::Unsigned(n) => n.fmt(f),
}
}
}
/// A non-generic type that can represent any 64-bit or smaller primitive
/// integer range.
#[derive(Clone, PartialEq, Eq)]
pub enum LargeIntRange {
Signed(AnyRange<i64>),
Unsigned(AnyRange<u64>),
}
impl fmt::Debug for LargeIntRange {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Signed(r) => r.fmt(f),
Self::Unsigned(r) => r.fmt(f),
}
}
}
/// An error returned when a value is not within a specific range.
#[derive(Clone, Debug, Error)]
#[error("Integer value {value} not in bounds: {range:?}")]
pub struct OutOfBoundsError {
value: LargeInt,
range: LargeIntRange,
}
/// Verify that `value` is within `bounds` and then return `value` if it is.
pub fn check_bounds<T: PrimInt>(
value: T,
range: impl Into<AnyRange<T>>,
) -> Result<T, OutOfBoundsError> {
const {
assert!(
mem::size_of::<T>() <= 8,
"Integer must be 64 bits or smaller"
);
}
let range = range.into();
if !range.contains(&value) {
let value = if T::min_value() != T::zero() {
LargeInt::Signed(NumCast::from(value).unwrap())
} else {
LargeInt::Unsigned(NumCast::from(value).unwrap())
};
let range = if T::min_value() != T::zero() {
let start = match range.start_bound() {
Bound::Excluded(n) => Bound::Excluded(NumCast::from(*n).unwrap()),
Bound::Included(n) => Bound::Included(NumCast::from(*n).unwrap()),
Bound::Unbounded => Bound::Unbounded,
};
let end = match range.end_bound() {
Bound::Excluded(n) => Bound::Excluded(NumCast::from(*n).unwrap()),
Bound::Included(n) => Bound::Included(NumCast::from(*n).unwrap()),
Bound::Unbounded => Bound::Unbounded,
};
LargeIntRange::Signed(AnyRange::with_bounds(start, end).unwrap())
} else {
let start = match range.start_bound() {
Bound::Excluded(n) => Bound::Excluded(NumCast::from(*n).unwrap()),
Bound::Included(n) => Bound::Included(NumCast::from(*n).unwrap()),
Bound::Unbounded => Bound::Unbounded,
};
let end = match range.end_bound() {
Bound::Excluded(n) => Bound::Excluded(NumCast::from(*n).unwrap()),
Bound::Included(n) => Bound::Included(NumCast::from(*n).unwrap()),
Bound::Unbounded => Bound::Unbounded,
};
LargeIntRange::Unsigned(AnyRange::with_bounds(start, end).unwrap())
};
return Err(OutOfBoundsError { value, range });
}
Ok(value)
}
/// Try to cast `value` to primitive integer type `T`. If it does not fit, the
/// error will indicate the valid range of values.
pub fn try_cast<T: PrimInt, V: PrimInt>(value: V) -> Result<T, OutOfBoundsError> {
const {
assert!(
mem::size_of::<T>() <= 8,
"Integer must be 64 bits or smaller"
);
}
NumCast::from(value).ok_or_else(|| {
let value = if V::min_value() != V::zero() {
LargeInt::Signed(NumCast::from(value).unwrap())
} else {
LargeInt::Unsigned(NumCast::from(value).unwrap())
};
let range = if T::min_value() != T::zero() {
let min = NumCast::from(T::min_value()).unwrap();
let max = NumCast::from(T::max_value()).unwrap();
LargeIntRange::Signed((min..=max).into())
} else {
let min = NumCast::from(T::min_value()).unwrap();
let max = NumCast::from(T::max_value()).unwrap();
LargeIntRange::Unsigned((min..=max).into())
};
OutOfBoundsError { value, range }
})
}
/// Check if a byte slice is all zeros.
pub fn is_zero(mut buf: &[u8]) -> bool {
while !buf.is_empty() {
@@ -40,15 +304,76 @@ pub fn is_zero(mut buf: &[u8]) -> bool {
/// Get the non-empty parent of a path. If the path has no parent in the string,
/// then `.` is returned. This does not perform any filesystem operations.
pub fn parent_path(path: &Path) -> &Path {
if let Some(parent) = path.parent() {
if !parent.as_os_str().is_empty() {
return parent;
}
if let Some(parent) = path.parent()
&& !parent.as_os_str().is_empty()
{
return parent;
}
Path::new(".")
}
/// Path safety-related errors.
#[derive(Clone, Debug, Error)]
pub enum PathSafetyError {
#[error("Path contains multiple components: {0:?}")]
NotSingle(PathBuf),
#[error("Path contains '..': {0:?}")]
HasDotDot(PathBuf),
}
/// Join `parent` with `child`, disallowing unsafe child paths. Absolute child
/// paths are converted into relative paths and `..` components result in an
/// error.
pub fn path_join(
parent: impl AsRef<Path>,
child: impl AsRef<Path>,
) -> Result<PathBuf, PathSafetyError> {
fn inner(parent: &Path, child: &Path) -> Result<PathBuf, PathSafetyError> {
let mut result = parent.to_owned();
for component in child.components() {
match component {
// Make absolute paths relative.
Component::Prefix(_) | Component::RootDir | Component::CurDir => continue,
// Unsafe path. We block this even if it wouldn't escape the parent.
Component::ParentDir => {
return Err(PathSafetyError::HasDotDot(child.to_path_buf()));
}
Component::Normal(os_str) => result.push(os_str),
}
}
Ok(result)
}
inner(parent.as_ref(), child.as_ref())
}
/// Ensure that the path has no directory components.
pub fn path_ensure_single(name: impl AsRef<Path>) -> Result<(), PathSafetyError> {
fn inner(name: &Path) -> Result<(), PathSafetyError> {
// Path::file_name() already checks for `.` and `..`.
if name.file_name() != Some(name.as_os_str()) {
return Err(PathSafetyError::NotSingle(name.to_path_buf()));
}
Ok(())
}
inner(name.as_ref())
}
/// Like [`path_join`], but ensures that the child path contains no directory
/// components with [`path_ensure_single`].
pub fn path_join_single(
parent: impl AsRef<Path>,
child: impl AsRef<Path>,
) -> Result<PathBuf, PathSafetyError> {
path_ensure_single(child.as_ref())?;
path_join(parent.as_ref(), child.as_ref())
}
/// Sort and merge overlapping intervals.
pub fn merge_overlapping<T>(sections: &[Range<T>]) -> Vec<Range<T>>
where
@@ -62,11 +387,11 @@ where
for section in sections {
if section.start >= section.end {
continue;
} else if let Some(last) = result.last_mut() {
if section.start <= last.end {
last.end = last.end.max(section.end);
continue;
}
} else if let Some(last) = result.last_mut()
&& section.start <= last.end
{
last.end = last.end.max(section.end);
continue;
}
result.push(section);
@@ -115,29 +440,101 @@ where
.is_ok()
}
/// Join arbitrary displayable items with a separator.
pub fn join(into_iter: impl IntoIterator<Item = impl Display>, sep: &str) -> String {
use std::fmt::Write;
let mut result = String::new();
for (i, item) in into_iter.into_iter().enumerate() {
if i > 0 {
result.push_str(sep);
}
write!(result, "{item}").expect("Failed to allocate");
}
result
}
/// Sort arbitrary sequence of sortable items.
pub fn sort<T: Ord>(iter: impl Iterator<Item = T>) -> Vec<T> {
let mut items = iter.collect::<Vec<_>>();
items.sort();
items
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_any_range() {
let range = AnyRange::with_bounds(Bound::Included(0), Bound::Excluded(1)).unwrap();
assert_eq!(range, AnyRange::from(0..1));
let range = AnyRange::with_bounds(Bound::Included(0), Bound::Unbounded).unwrap();
assert_eq!(range, AnyRange::from(0..));
let range = AnyRange::<i32>::with_bounds(Bound::Unbounded, Bound::Unbounded).unwrap();
assert_eq!(range, AnyRange::from(..));
let range = AnyRange::with_bounds(Bound::Included(0), Bound::Included(1)).unwrap();
assert_eq!(range, AnyRange::from(0..=1));
let range = AnyRange::with_bounds(Bound::Unbounded, Bound::Excluded(1)).unwrap();
assert_eq!(range, AnyRange::from(..1));
let range = AnyRange::with_bounds(Bound::Unbounded, Bound::Included(1)).unwrap();
assert_eq!(range, AnyRange::from(..=1));
}
#[test]
fn test_check_bounds() {
check_bounds(i64::MIN, ..).unwrap();
check_bounds(i64::MAX, ..).unwrap();
check_bounds(u64::MIN, ..).unwrap();
check_bounds(u64::MAX, ..).unwrap();
check_bounds(0, -1..=1).unwrap();
let err = check_bounds(i8::MAX, 0..=0).unwrap_err();
assert_eq!(err.value, LargeInt::Signed(127));
assert_eq!(err.range, LargeIntRange::Signed(AnyRange::from(0..=0)));
let err = check_bounds(u8::MAX, 0..=0).unwrap_err();
assert_eq!(err.value, LargeInt::Unsigned(255));
assert_eq!(err.range, LargeIntRange::Unsigned(AnyRange::from(0..=0)));
}
#[test]
fn test_try_cast() {
let value: u8 = try_cast(255u16).unwrap();
assert_eq!(value, 255);
let err = try_cast::<i8, _>(256u16).unwrap_err();
assert_eq!(err.value, LargeInt::Unsigned(256));
assert_eq!(err.range, LargeIntRange::Signed(AnyRange::from(-128..=127)));
}
#[test]
fn test_ranges_overlaps() {
assert_eq!(ranges_overlaps(&[0..4], &(0..0)), false);
assert_eq!(ranges_overlaps(&[0..4], &(0..4)), true);
assert_eq!(ranges_overlaps(&[0..4], &(1..4)), true);
assert_eq!(ranges_overlaps(&[0..4], &(0..3)), true);
assert_eq!(ranges_overlaps(&[0..4], &(4..5)), false);
assert_eq!(ranges_overlaps(&[5..8], &(5..9)), true);
assert_eq!(ranges_overlaps(&[5..8], &(4..8)), true);
assert_eq!(ranges_overlaps(&[5..8], &(4..9)), true);
assert_eq!(ranges_overlaps(&[0..4, 5..8], &(4..5)), true);
assert_eq!(ranges_overlaps(&[0..4, 5..8], &(0..9)), true);
assert!(!ranges_overlaps(&[0..4], &(0..0)));
assert!(ranges_overlaps(&[0..4], &(0..4)));
assert!(ranges_overlaps(&[0..4], &(1..4)));
assert!(ranges_overlaps(&[0..4], &(0..3)));
assert!(!ranges_overlaps(&[0..4], &(4..5)));
assert!(ranges_overlaps(&[5..8], &(5..9)));
assert!(ranges_overlaps(&[5..8], &(4..8)));
assert!(ranges_overlaps(&[5..8], &(4..9)));
assert!(ranges_overlaps(&[0..4, 5..8], &(4..5)));
assert!(ranges_overlaps(&[0..4, 5..8], &(0..9)));
}
#[test]
fn test_ranges_contains() {
assert_eq!(ranges_contains(&[0..4], &0), true);
assert_eq!(ranges_contains(&[0..4], &4), false);
assert_eq!(ranges_contains(&[0..4, 5..8], &4), false);
assert_eq!(ranges_contains(&[0..4, 5..8], &6), true);
assert!(ranges_contains(&[0..4], &0));
assert!(!ranges_contains(&[0..4], &4));
assert!(!ranges_contains(&[0..4, 5..8], &4));
assert!(ranges_contains(&[0..4, 5..8], &6));
}
}
+45 -43
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
io::{Cursor, Read, Seek, Write},
@@ -14,15 +12,16 @@ use rsa::RsaPrivateKey;
use avbroot::{
self,
crypto::RsaSigningKey,
format::avb::{
self, AlgorithmType, AppendedDescriptorMut, AppendedDescriptorRef,
ChainPartitionDescriptor, Descriptor, Footer, HashDescriptor, HashTreeDescriptor, Header,
KernelCmdlineDescriptor, PropertyDescriptor,
},
stream::SharedCursor,
stream::{MutexFile, UserPosFile},
};
fn get_test_key() -> RsaPrivateKey {
fn get_test_key() -> RsaSigningKey {
let data = include_str!(concat!(
env!("CARGO_WORKSPACE_DIR"),
"/e2e/keys/TEST_KEY_DO_NOT_USE_avb.key",
@@ -32,7 +31,8 @@ fn get_test_key() -> RsaPrivateKey {
"/e2e/keys/TEST_KEY_DO_NOT_USE_avb.passphrase",
));
RsaPrivateKey::from_pkcs8_encrypted_pem(data, passphrase.trim_end()).unwrap()
let key = RsaPrivateKey::from_pkcs8_encrypted_pem(data, passphrase.trim_end()).unwrap();
RsaSigningKey::Internal(key)
}
fn repeat_str(s: &str, max_len: usize) -> String {
@@ -118,7 +118,7 @@ fn round_trip_root_image() {
rollback_index: 1677974400,
flags: 0,
rollback_index_location: 0,
release_string: repeat_str("MaxLength", 48),
release_string: repeat_str("MaxLength", 47),
reserved: repeat_array(&[0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef]),
};
@@ -136,11 +136,11 @@ fn round_trip_root_image() {
assert_eq!(
ring::digest::digest(&ring::digest::SHA512, &data).as_ref(),
[
0xc4, 0xa5, 0xda, 0x3e, 0x09, 0xa2, 0xc8, 0x70, 0xcb, 0xf0, 0x96, 0x79, 0x0e, 0x1e,
0x80, 0xae, 0x5e, 0x37, 0x81, 0x27, 0x24, 0xc3, 0x6c, 0xa9, 0x42, 0x9e, 0x2c, 0xb1,
0x81, 0xad, 0xce, 0xee, 0x8d, 0x4f, 0x76, 0x45, 0x54, 0xc1, 0x31, 0x6a, 0xa7, 0x81,
0x5c, 0x59, 0xa8, 0xe8, 0x76, 0xab, 0xed, 0x5b, 0x07, 0x07, 0x38, 0xdd, 0x09, 0x86,
0x05, 0x39, 0x23, 0x2d, 0x7b, 0xcc, 0x57, 0x06,
0x3b, 0x01, 0xf6, 0x04, 0x04, 0x6e, 0x6f, 0x60, 0x9c, 0xb0, 0x8b, 0x8a, 0x43, 0xf7,
0x91, 0x2e, 0xc4, 0x1b, 0xc0, 0x7f, 0xa1, 0xe4, 0xe6, 0x59, 0x14, 0x08, 0xbe, 0x83,
0xae, 0x0a, 0x0f, 0x0a, 0x4a, 0x15, 0x91, 0x0e, 0x4d, 0x18, 0x31, 0x48, 0x20, 0xe8,
0x44, 0x62, 0x07, 0x98, 0x43, 0x30, 0xee, 0x2d, 0x20, 0x28, 0xc3, 0x94, 0xc6, 0x0e,
0x86, 0xa3, 0xa7, 0x17, 0x36, 0xfd, 0x50, 0x7c,
],
);
@@ -186,7 +186,7 @@ fn round_trip_appended_hash_image() {
rollback_index: 1677974400,
flags: 0,
rollback_index_location: 0,
release_string: repeat_str("MaxLength", 48),
release_string: repeat_str("MaxLength", 47),
reserved: repeat_array(&[0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef]),
};
let mut footer = Footer {
@@ -235,11 +235,11 @@ fn round_trip_appended_hash_image() {
assert_eq!(
ring::digest::digest(&ring::digest::SHA512, &data).as_ref(),
[
0x09, 0x98, 0x0c, 0x9d, 0x11, 0x50, 0xde, 0xb1, 0x55, 0x3b, 0x00, 0x76, 0xbe, 0x25,
0xfd, 0xe6, 0x46, 0x22, 0xbd, 0x9a, 0x05, 0x86, 0xea, 0x07, 0x4d, 0x8f, 0x7b, 0x15,
0x36, 0x20, 0x0d, 0xf0, 0x7e, 0x96, 0xd2, 0x58, 0xde, 0xf2, 0xa6, 0x91, 0x6d, 0x01,
0x7b, 0x03, 0x96, 0x70, 0xf8, 0x3b, 0x76, 0x74, 0xf0, 0xbf, 0x47, 0xe0, 0xd2, 0xd4,
0x5d, 0xbf, 0xb7, 0x9c, 0xf5, 0xf8, 0xaf, 0x3c,
0x91, 0x38, 0x61, 0xc0, 0x68, 0x2a, 0x8b, 0xd8, 0x01, 0xa6, 0xe4, 0x4c, 0x1d, 0x27,
0x93, 0x1b, 0xa4, 0x63, 0xd1, 0xbb, 0xf1, 0x64, 0x05, 0xf2, 0xa1, 0xa0, 0xb3, 0x35,
0xe1, 0xc5, 0xac, 0x4f, 0x98, 0xb3, 0x0a, 0xed, 0xfc, 0xee, 0xa2, 0x6a, 0x77, 0xf4,
0xe5, 0x69, 0xa0, 0xcd, 0x7a, 0xd1, 0xfe, 0x1d, 0x07, 0xd1, 0x25, 0xc6, 0x22, 0xe0,
0x25, 0xcb, 0xe9, 0x75, 0x50, 0xe4, 0xae, 0x59,
],
);
@@ -294,7 +294,7 @@ fn round_trip_appended_hash_tree_image_fixed_size() {
rollback_index: 1677974400,
flags: 0,
rollback_index_location: 0,
release_string: repeat_str("MaxLength", 48),
release_string: repeat_str("MaxLength", 47),
reserved: repeat_array(&[0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef]),
};
let mut footer = Footer {
@@ -306,16 +306,17 @@ fn round_trip_appended_hash_tree_image_fixed_size() {
reserved: repeat_array(&[0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef]),
};
let mut writer = SharedCursor::default();
let writer = MutexFile::new(Cursor::new(Vec::new()));
let mut pos_writer = UserPosFile::new(&writer);
let cancel_signal = AtomicBool::new(false);
// Write the raw partition data.
writer.write_all(&raw_data).unwrap();
pos_writer.write_all(&raw_data).unwrap();
// Generate and write the hash tree and FEC data.
match header.appended_descriptor_mut().unwrap() {
AppendedDescriptorMut::HashTree(d) => {
d.update(&writer, &writer, None, &cancel_signal).unwrap();
d.update(&writer, None, &cancel_signal).unwrap();
}
AppendedDescriptorMut::Hash(_) => panic!("Expected hash tree descriptor"),
}
@@ -334,20 +335,20 @@ fn round_trip_appended_hash_tree_image_fixed_size() {
assert_eq!(header.verify().unwrap().unwrap(), key.to_public_key());
// Write vbmeta structures.
avb::write_appended_image(&mut writer, &header, &mut footer, Some(image_size)).unwrap();
avb::write_appended_image(&mut pos_writer, &header, &mut footer, Some(image_size)).unwrap();
let mut data = Vec::new();
writer.rewind().unwrap();
writer.read_to_end(&mut data).unwrap();
pos_writer.rewind().unwrap();
pos_writer.read_to_end(&mut data).unwrap();
// Verify checksum of the output.
assert_eq!(
ring::digest::digest(&ring::digest::SHA512, &data).as_ref(),
[
0xb5, 0x56, 0x65, 0x81, 0x5a, 0x16, 0x65, 0xa9, 0xa6, 0xc6, 0x9e, 0x41, 0x89, 0x9f,
0xe9, 0xbc, 0xea, 0x59, 0x4d, 0x14, 0x8a, 0x9e, 0x2b, 0x13, 0xa0, 0x3a, 0x8e, 0xd4,
0x59, 0xcd, 0x74, 0xe7, 0x99, 0xbd, 0xa3, 0x58, 0x4b, 0x84, 0xf2, 0x04, 0xe2, 0x12,
0x48, 0xfe, 0x4f, 0x67, 0x1f, 0x2a, 0xaa, 0x22, 0x51, 0x19, 0x83, 0x95, 0xa8, 0x03,
0xf5, 0x87, 0x12, 0x05, 0x8e, 0x14, 0xd9, 0xbd
0x92, 0xdd, 0x4d, 0xc5, 0xb0, 0x5b, 0x4f, 0x65, 0x97, 0x5a, 0x72, 0x66, 0xde, 0x82,
0xc2, 0x2f, 0x33, 0x86, 0x8b, 0x65, 0x67, 0x80, 0x1d, 0xca, 0xd6, 0x2c, 0xfc, 0xca,
0xaf, 0x4c, 0x56, 0x64, 0x3a, 0xd1, 0x06, 0x01, 0xda, 0x2e, 0x05, 0x67, 0xd1, 0x01,
0xe3, 0xcb, 0x7b, 0x1e, 0xeb, 0x05, 0x89, 0xeb, 0x80, 0xcc, 0x17, 0x0c, 0x24, 0x73,
0x0d, 0xcb, 0x36, 0xfa, 0x17, 0xbd, 0x20, 0x7e,
],
);
@@ -401,7 +402,7 @@ fn round_trip_appended_hash_tree_image_minimum_size() {
rollback_index: 1677974400,
flags: 0,
rollback_index_location: 0,
release_string: repeat_str("MaxLength", 48),
release_string: repeat_str("MaxLength", 47),
reserved: repeat_array(&[0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef]),
};
let mut footer = Footer {
@@ -413,16 +414,17 @@ fn round_trip_appended_hash_tree_image_minimum_size() {
reserved: repeat_array(&[0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef]),
};
let mut writer = SharedCursor::default();
let writer = MutexFile::new(Cursor::new(Vec::new()));
let mut pos_writer = UserPosFile::new(&writer);
let cancel_signal = AtomicBool::new(false);
// Write the raw partition data.
writer.write_all(&raw_data).unwrap();
pos_writer.write_all(&raw_data).unwrap();
// Generate and write the hash tree and FEC data.
match header.appended_descriptor_mut().unwrap() {
AppendedDescriptorMut::HashTree(d) => {
d.update(&writer, &writer, None, &cancel_signal).unwrap();
d.update(&writer, None, &cancel_signal).unwrap();
}
AppendedDescriptorMut::Hash(_) => panic!("Expected hash tree descriptor"),
}
@@ -441,20 +443,20 @@ fn round_trip_appended_hash_tree_image_minimum_size() {
assert_eq!(header.verify().unwrap().unwrap(), key.to_public_key());
// Write vbmeta structures.
avb::write_appended_image(&mut writer, &header, &mut footer, None).unwrap();
avb::write_appended_image(&mut pos_writer, &header, &mut footer, None).unwrap();
let mut data = Vec::new();
writer.rewind().unwrap();
writer.read_to_end(&mut data).unwrap();
pos_writer.rewind().unwrap();
pos_writer.read_to_end(&mut data).unwrap();
// Verify checksum of the output.
assert_eq!(
ring::digest::digest(&ring::digest::SHA512, &data).as_ref(),
[
0xd6, 0x69, 0x19, 0x6a, 0x36, 0xc8, 0x1c, 0xe9, 0xc4, 0x85, 0xbe, 0xff, 0x43, 0xb1,
0x9f, 0xd4, 0x1d, 0x6c, 0xf9, 0xd2, 0xf3, 0xa6, 0x5f, 0x66, 0x41, 0xd5, 0xf3, 0xfd,
0x28, 0xdb, 0x14, 0x67, 0xc6, 0xa8, 0xef, 0xc4, 0xd4, 0x67, 0x6c, 0xb8, 0x66, 0xbb,
0x56, 0x5a, 0x4a, 0xf5, 0xd8, 0x92, 0x7c, 0x42, 0xbc, 0x47, 0xdb, 0x94, 0x38, 0x15,
0x4b, 0x2d, 0xd0, 0x28, 0x1f, 0xd1, 0x45, 0xa9,
0xcf, 0x6b, 0x90, 0xcf, 0x77, 0x76, 0x62, 0x12, 0xc2, 0x22, 0xe6, 0xd5, 0x5b, 0xab,
0x82, 0xd8, 0x6c, 0x93, 0xa3, 0x35, 0x5b, 0x77, 0xe0, 0x38, 0x12, 0x48, 0x90, 0x0c,
0xee, 0xbf, 0x95, 0x31, 0xff, 0xc7, 0xf5, 0xb9, 0x4f, 0x18, 0x57, 0x46, 0x37, 0xbb,
0xce, 0x7b, 0xa7, 0x26, 0x18, 0x5a, 0x3c, 0x41, 0xb2, 0x2e, 0xb7, 0x86, 0x51, 0xdc,
0xf6, 0x26, 0x86, 0xf3, 0xc7, 0x96, 0x23, 0xed,
],
);
+6 -6
View File
@@ -1,12 +1,11 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::io::Cursor;
use avbroot::{
self,
crypto::RsaSigningKey,
format::{
avb::{AlgorithmType, Descriptor, HashDescriptor, Header},
bootimage::{
@@ -19,7 +18,7 @@ use avbroot::{
use pkcs8::DecodePrivateKey;
use rsa::RsaPrivateKey;
fn get_test_key() -> RsaPrivateKey {
fn get_test_key() -> RsaSigningKey {
let data = include_str!(concat!(
env!("CARGO_WORKSPACE_DIR"),
"/e2e/keys/TEST_KEY_DO_NOT_USE_avb.key",
@@ -29,7 +28,8 @@ fn get_test_key() -> RsaPrivateKey {
"/e2e/keys/TEST_KEY_DO_NOT_USE_avb.passphrase",
));
RsaPrivateKey::from_pkcs8_encrypted_pem(data, passphrase.trim_end()).unwrap()
let key = RsaPrivateKey::from_pkcs8_encrypted_pem(data, passphrase.trim_end()).unwrap();
RsaSigningKey::Internal(key)
}
fn repeat(s: &str, max_len: usize) -> String {
+2 -4
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::io::{Cursor, Read, Seek, Write};
+2 -4
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::io::{self, Cursor};
+426
View File
@@ -0,0 +1,426 @@
// SPDX-FileCopyrightText: 2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{io::Cursor, num::NonZeroU64};
use avbroot::{
format::lp::{
BlockDevice, BlockDeviceFlags, Extent, ExtentType, HeaderFlags, ImageType, Metadata,
MetadataSlot, Partition, PartitionAttributes, PartitionGroup, PartitionGroupFlags,
},
stream::{FromReader, ToWriter},
};
fn round_trip(metadata: &Metadata, sha512: &[u8; 64]) {
let mut writer = Cursor::new(Vec::new());
metadata.to_writer(&mut writer).unwrap();
let data = writer.into_inner();
assert_eq!(
ring::digest::digest(&ring::digest::SHA512, &data).as_ref(),
sha512,
);
let mut reader = Cursor::new(&data);
let new_metadata = Metadata::from_reader(&mut reader).unwrap();
assert_eq!(&new_metadata, metadata);
}
#[test]
fn round_trip_empty_image() {
// Layout from Google Pixel 9 Pro XL stock factory image:
// komodo-ad1a.240530.047-factory-bb04e484.zip -> super_empty.img
let metadata = Metadata {
image_type: ImageType::Empty,
metadata_max_size: 65536,
metadata_slot_count: 3,
logical_block_size: 4096,
slots: vec![MetadataSlot {
major_version: 10,
minor_version: 2,
groups: vec![
PartitionGroup {
name: "default".into(),
flags: PartitionGroupFlags::empty(),
maximum_size: None,
partitions: vec![],
},
PartitionGroup {
name: "google_dynamic_partitions_a".into(),
flags: PartitionGroupFlags::empty(),
maximum_size: NonZeroU64::new(8527020032),
partitions: vec![
Partition {
name: "system_a".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "system_dlkm_a".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "system_ext_a".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "product_a".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "vendor_a".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "vendor_dlkm_a".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
],
},
PartitionGroup {
name: "google_dynamic_partitions_b".into(),
flags: PartitionGroupFlags::empty(),
maximum_size: NonZeroU64::new(8527020032),
partitions: vec![
Partition {
name: "system_b".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "system_dlkm_b".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "system_ext_b".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "product_b".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "vendor_b".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "vendor_dlkm_b".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
],
},
],
block_devices: vec![BlockDevice {
first_logical_sector: 2048,
alignment: 1048576,
alignment_offset: 0,
size: 8531214336,
partition_name: "super".into(),
flags: BlockDeviceFlags::empty(),
}],
flags: HeaderFlags::VIRTUAL_AB_DEVICE,
}],
};
// This is semantically equivalent, but not identical. The Metadata data
// structure only retains the order of partitions within a group, but not
// globally. This checksum is meant to protect against unintended future
// changes.
let sha512 = [
0xfa, 0xdf, 0xf2, 0xb6, 0x74, 0xec, 0x78, 0x7d, 0x0f, 0x7d, 0x17, 0x54, 0xcf, 0x1b, 0x53,
0x13, 0x66, 0x13, 0x5e, 0x8e, 0xcc, 0x84, 0xa2, 0x63, 0xaf, 0x0d, 0x68, 0x96, 0xc6, 0x40,
0x4e, 0x83, 0xe4, 0xe9, 0xef, 0x61, 0xdc, 0x2a, 0x25, 0x5f, 0xa2, 0x7d, 0x29, 0x0b, 0xb6,
0x26, 0x93, 0x59, 0xc9, 0xa8, 0x56, 0x3b, 0x3d, 0x3d, 0x15, 0x6b, 0xee, 0x78, 0x56, 0x78,
0xa1, 0x83, 0x6d, 0x70,
];
round_trip(&metadata, &sha512);
}
#[test]
fn round_trip_normal_image() {
// Layout from Google Pixel 9 Pro XL GrapheneOS factory image:
// komodo-install-2024082500.zip -> super_1.img
let slot = MetadataSlot {
major_version: 10,
minor_version: 2,
groups: vec![
PartitionGroup {
name: "default".into(),
flags: PartitionGroupFlags::empty(),
maximum_size: None,
partitions: vec![],
},
PartitionGroup {
name: "google_dynamic_partitions_a".into(),
flags: PartitionGroupFlags::empty(),
maximum_size: NonZeroU64::new(8527020032),
partitions: vec![
Partition {
name: "system_a".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![Extent {
num_sectors: 2465952,
extent_type: ExtentType::Linear {
start_sector: 2048,
block_device_index: 0,
},
}],
},
Partition {
name: "system_dlkm_a".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![Extent {
num_sectors: 23720,
extent_type: ExtentType::Linear {
start_sector: 2469888,
block_device_index: 0,
},
}],
},
Partition {
name: "system_ext_a".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![Extent {
num_sectors: 786144,
extent_type: ExtentType::Linear {
start_sector: 2494464,
block_device_index: 0,
},
}],
},
Partition {
name: "product_a".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![Extent {
num_sectors: 1396432,
extent_type: ExtentType::Linear {
start_sector: 3280896,
block_device_index: 0,
},
}],
},
Partition {
name: "vendor_a".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![Extent {
num_sectors: 1959024,
extent_type: ExtentType::Linear {
start_sector: 4677632,
block_device_index: 0,
},
}],
},
Partition {
name: "vendor_dlkm_a".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![Extent {
num_sectors: 55008,
extent_type: ExtentType::Linear {
start_sector: 6637568,
block_device_index: 0,
},
}],
},
],
},
PartitionGroup {
name: "google_dynamic_partitions_b".into(),
flags: PartitionGroupFlags::empty(),
maximum_size: NonZeroU64::new(8527020032),
partitions: vec![
Partition {
name: "system_b".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "system_dlkm_b".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "system_ext_b".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "product_b".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "vendor_b".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
Partition {
name: "vendor_dlkm_b".into(),
attributes: PartitionAttributes::READONLY,
extents: vec![],
},
],
},
],
block_devices: vec![BlockDevice {
first_logical_sector: 2048,
alignment: 1048576,
alignment_offset: 0,
size: 8531214336,
partition_name: "super".into(),
flags: BlockDeviceFlags::empty(),
}],
flags: HeaderFlags::VIRTUAL_AB_DEVICE,
};
let metadata = Metadata {
image_type: ImageType::Normal,
metadata_max_size: 65536,
metadata_slot_count: 3,
logical_block_size: 4096,
slots: vec![slot; 3],
};
// This is semantically equivalent, but not identical. The Metadata data
// structure only retains the order of partitions within a group, but not
// globally. This checksum is meant to protect against unintended future
// changes.
let sha512 = [
0x3b, 0xad, 0xd4, 0x22, 0xa1, 0x5a, 0xc5, 0xdf, 0x72, 0x7d, 0x92, 0x35, 0x04, 0x8a, 0x75,
0xd9, 0x33, 0x0d, 0xaa, 0x9e, 0x97, 0xd4, 0x13, 0x28, 0x5e, 0x0f, 0x12, 0x0c, 0xf2, 0xb3,
0xdc, 0x35, 0x89, 0x65, 0x40, 0xb0, 0x67, 0xb1, 0x54, 0x09, 0x52, 0x3e, 0x78, 0x3d, 0x3f,
0xa7, 0xf7, 0xa0, 0x77, 0xa8, 0xfc, 0xb7, 0x93, 0x19, 0xcd, 0x43, 0xea, 0x9a, 0x74, 0x65,
0x54, 0x3c, 0xaa, 0x12,
];
round_trip(&metadata, &sha512);
}
#[test]
fn round_trip_retrofit_image() {
// Layout from Google Pixel 3a XL stock factory image:
// bonito-ota-sp2a.220505.008-37a410d5.zip -> system.img
let slot = MetadataSlot {
major_version: 10,
minor_version: 0,
groups: vec![
PartitionGroup {
name: "default".into(),
flags: PartitionGroupFlags::empty(),
maximum_size: None,
partitions: vec![],
},
PartitionGroup {
name: "google_dynamic_partitions".into(),
flags: PartitionGroupFlags::SLOT_SUFFIXED,
maximum_size: NonZeroU64::new(4068474880),
partitions: vec![
Partition {
name: "system".into(),
attributes: PartitionAttributes::READONLY
| PartitionAttributes::SLOT_SUFFIXED,
extents: vec![Extent {
num_sectors: 1757416,
extent_type: ExtentType::Linear {
start_sector: 2048,
block_device_index: 0,
},
}],
},
Partition {
name: "vendor".into(),
attributes: PartitionAttributes::READONLY
| PartitionAttributes::SLOT_SUFFIXED,
extents: vec![Extent {
num_sectors: 991848,
extent_type: ExtentType::Linear {
start_sector: 1761280,
block_device_index: 0,
},
}],
},
Partition {
name: "product".into(),
attributes: PartitionAttributes::READONLY
| PartitionAttributes::SLOT_SUFFIXED,
extents: vec![
Extent {
num_sectors: 3627008,
extent_type: ExtentType::Linear {
start_sector: 2754560,
block_device_index: 0,
},
},
Extent {
num_sectors: 538240,
extent_type: ExtentType::Linear {
start_sector: 2048,
block_device_index: 1,
},
},
],
},
Partition {
name: "system_ext".into(),
attributes: PartitionAttributes::READONLY
| PartitionAttributes::SLOT_SUFFIXED,
extents: vec![Extent {
num_sectors: 490744,
extent_type: ExtentType::Linear {
start_sector: 540672,
block_device_index: 1,
},
}],
},
],
},
],
block_devices: vec![
BlockDevice {
first_logical_sector: 2048,
alignment: 1048576,
alignment_offset: 0,
size: 3267362816,
partition_name: "system".into(),
flags: BlockDeviceFlags::SLOT_SUFFIXED,
},
BlockDevice {
first_logical_sector: 2048,
alignment: 1048576,
alignment_offset: 0,
size: 805306368,
partition_name: "vendor".into(),
flags: BlockDeviceFlags::SLOT_SUFFIXED,
},
],
flags: HeaderFlags::empty(),
};
let metadata = Metadata {
image_type: ImageType::Normal,
metadata_max_size: 65536,
metadata_slot_count: 2,
logical_block_size: 4096,
slots: vec![slot; 2],
};
// First 274432 bytes of system.img. Unlike the other test cases, this is
// identical to the original image because there is only one partition group
// with partitions, so the group-level ordering is the same as the global
// ordering.
let sha512 = [
0xb9, 0x97, 0xf5, 0x83, 0x39, 0x37, 0x90, 0x0a, 0xb6, 0x46, 0xdd, 0x27, 0x57, 0xf1, 0xf3,
0xbd, 0x8f, 0xc4, 0x63, 0x07, 0x6f, 0xf4, 0x19, 0xc0, 0x02, 0x28, 0x48, 0x99, 0x54, 0xbb,
0xb3, 0xbf, 0x67, 0x95, 0xc4, 0xa7, 0x99, 0xf4, 0xa9, 0xc4, 0xf4, 0x1d, 0xf7, 0x59, 0x28,
0xeb, 0xbc, 0x85, 0x46, 0xd1, 0x7d, 0x65, 0x0f, 0xbe, 0x21, 0xf6, 0xf2, 0xa2, 0x20, 0x5b,
0xda, 0xde, 0xfa, 0x50,
];
round_trip(&metadata, &sha512);
}
+171
View File
@@ -0,0 +1,171 @@
// SPDX-FileCopyrightText: 2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::io::{Cursor, Read, Write};
use avbroot::format::sparse::{
self, Chunk, ChunkBounds, ChunkData, CrcMode, Header, SparseReader, SparseWriter,
};
#[derive(Clone, Copy)]
struct TestChunk {
chunk: Chunk,
data: &'static [u8],
}
fn round_trip(block_size: u32, crc32: u32, test_chunks: &[TestChunk], sha512: &[u8; 64]) {
let num_blocks = test_chunks.iter().map(|d| d.chunk.bounds.len()).sum();
let header = Header {
major_version: sparse::MAJOR_VERSION,
minor_version: sparse::MINOR_VERSION,
block_size,
num_blocks,
num_chunks: test_chunks.len() as u32,
crc32,
};
let writer = Cursor::new(Vec::new());
let mut sparse_writer = SparseWriter::new(writer, header).unwrap();
for test_chunk in test_chunks {
sparse_writer.start_chunk(test_chunk.chunk).unwrap();
if !test_chunk.data.is_empty() {
sparse_writer.write_all(test_chunk.data).unwrap();
}
}
let writer = sparse_writer.finish().unwrap();
let data = writer.into_inner();
assert_eq!(
ring::digest::digest(&ring::digest::SHA512, &data).as_ref(),
sha512,
);
let reader = Cursor::new(&data);
let mut sparse_reader = SparseReader::new(reader, CrcMode::Validate).unwrap();
assert_eq!(sparse_reader.header(), header);
let mut test_chunks_iter = test_chunks.iter();
while let Some(chunk) = sparse_reader.next_chunk().unwrap() {
let test_chunk = test_chunks_iter.next().unwrap();
assert_eq!(chunk, test_chunk.chunk);
if !test_chunk.data.is_empty() {
let mut buf = vec![];
sparse_reader.read_to_end(&mut buf).unwrap();
assert_eq!(buf, test_chunk.data);
}
}
assert!(test_chunks_iter.next().is_none());
}
#[test]
fn round_trip_full_image() {
let block_size = 8;
let file_crc32 = 0xf6e23567;
let test_chunks = [
TestChunk {
chunk: Chunk {
bounds: ChunkBounds { start: 0, end: 1 },
data: ChunkData::Data,
},
data: b"\x00\x01\x02\x03\x04\x05\x06\x07",
},
TestChunk {
chunk: Chunk {
bounds: ChunkBounds { start: 1, end: 1 },
data: ChunkData::Crc32(0x88aa689f),
},
data: b"",
},
TestChunk {
chunk: Chunk {
bounds: ChunkBounds { start: 1, end: 2 },
data: ChunkData::Fill(0x01234567),
},
data: b"",
},
TestChunk {
chunk: Chunk {
bounds: ChunkBounds { start: 2, end: 3 },
data: ChunkData::Data,
},
data: b"\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f",
},
TestChunk {
chunk: Chunk {
bounds: ChunkBounds { start: 3, end: 3 },
data: ChunkData::Crc32(0xf6e23567),
},
data: b"",
},
];
let sha512 = [
0x19, 0x5f, 0xa7, 0xdb, 0x18, 0xc6, 0xb9, 0x0e, 0xce, 0x4b, 0x4f, 0x35, 0x36, 0x79, 0x46,
0x02, 0x7a, 0x45, 0x66, 0x63, 0x0e, 0xd9, 0x76, 0x93, 0x2b, 0x88, 0xe2, 0xbc, 0x0b, 0xd9,
0x1f, 0x21, 0x51, 0x92, 0x00, 0x2e, 0xe3, 0xa2, 0xff, 0x24, 0xea, 0xef, 0x24, 0xd5, 0x24,
0xf0, 0x46, 0xf3, 0x10, 0x32, 0xf4, 0xa6, 0x3b, 0x9d, 0xcd, 0xc5, 0x57, 0xf4, 0xc0, 0xe8,
0x01, 0xe8, 0x1d, 0xb3,
];
round_trip(block_size, file_crc32, &test_chunks, &sha512);
}
#[test]
fn round_trip_partial_image() {
let block_size = 8;
let file_crc32 = 0;
let test_chunks = [
TestChunk {
chunk: Chunk {
bounds: ChunkBounds { start: 0, end: 1 },
data: ChunkData::Hole,
},
data: b"",
},
TestChunk {
chunk: Chunk {
bounds: ChunkBounds { start: 1, end: 2 },
data: ChunkData::Data,
},
data: b"\x00\x01\x02\x03\x04\x05\x06\x07",
},
TestChunk {
chunk: Chunk {
bounds: ChunkBounds { start: 2, end: 3 },
data: ChunkData::Hole,
},
data: b"",
},
TestChunk {
chunk: Chunk {
bounds: ChunkBounds { start: 3, end: 4 },
data: ChunkData::Data,
},
data: b"\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f",
},
TestChunk {
chunk: Chunk {
bounds: ChunkBounds { start: 4, end: 5 },
data: ChunkData::Hole,
},
data: b"",
},
];
let sha512 = [
0xee, 0x07, 0xc5, 0x4d, 0x85, 0xee, 0x69, 0x91, 0x61, 0x07, 0x10, 0xed, 0xec, 0x13, 0x5e,
0xfb, 0xc3, 0x7d, 0xcf, 0x1f, 0x2a, 0x13, 0xf0, 0xb6, 0x85, 0xb4, 0xee, 0xe9, 0xd7, 0xa1,
0x12, 0x79, 0x14, 0x16, 0x30, 0x7a, 0x81, 0xf9, 0x4f, 0x72, 0xb2, 0xdd, 0x33, 0xbe, 0x5d,
0x55, 0x70, 0xa9, 0xe3, 0x94, 0x29, 0x40, 0x29, 0x8f, 0x35, 0x23, 0xf8, 0x78, 0x7f, 0xfe,
0xd6, 0x4b, 0x60, 0x16,
];
round_trip(block_size, file_crc32, &test_chunks, &sha512);
}
+7 -14
View File
@@ -33,18 +33,12 @@ allow = [
"Apache-2.0",
"Apache-2.0 WITH LLVM-exception",
"BSD-3-Clause",
"GPL-3.0",
"bzip2-1.0.6",
"GPL-3.0-only",
"ISC",
"MIT",
"OpenSSL",
"Unicode-DFS-2016",
]
[[licenses.clarify]]
name = "ring"
expression = "MIT AND ISC AND OpenSSL"
license-files = [
{ path = "LICENSE", hash = 0xbd0eed23 },
"Unicode-3.0",
"Zlib",
]
[bans]
@@ -62,14 +56,13 @@ include-workspace = true
bypass = [
# Copies of unmodified crashwrangler objects for old macOS versions.
{ name = "honggfuzz", allow-globs = ["honggfuzz/third_party/mac/CrashReport_*.o"] },
# Test files for liblzma's test suite
{ name = "liblzma-sys", allow-globs = ["xz/tests/compress_prepared_bcj_*"] },
# Only used in tests.
{ name = "libloading", allow-globs = ["tests/nagisa*.dll"] },
]
[sources]
unknown-registry = "deny"
unknown-git = "deny"
allow-git = [
"https://github.com/chenxiaolong/bzip2-rs",
"https://github.com/chenxiaolong/zip",
"https://github.com/chenxiaolong/system-properties",
]
+8 -12
View File
@@ -4,7 +4,8 @@ version.workspace = true
license.workspace = true
edition.workspace = true
repository.workspace = true
publish = false
publish.workspace = true
rust-version.workspace = true
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -14,21 +15,16 @@ avbroot = { path = "../avbroot" }
clap = { version = "4.4.1", features = ["derive"] }
ctrlc = "3.4.0"
hex = { version = "0.4.3", features = ["serde"] }
ring = "0.17.0"
rsa = "0.9.6"
rawzip = "0.4.0"
ring = "0.17.14"
rsa = { version = "0.9.6", features = ["hazmat"] }
serde = { version = "1.0.188", features = ["derive"] }
tempfile = "3.8.0"
toml_edit = { version = "0.22.9", features = ["serde"] }
toml_edit = { version = "0.23.3", features = ["serde"] }
topological-sort = "0.2.2"
tracing = "0.1.40"
tracing-subscriber = "0.3.18"
x509-cert = "0.2.5"
# https://github.com/zip-rs/zip/pull/383
[dependencies.zip]
git = "https://github.com/chenxiaolong/zip"
rev = "989101f9384b9e94e36e6e9e0f51908fdf98bde6"
default-features = false
[features]
static = ["avbroot/static"]
[lints]
workspace = true
+45 -12
View File
@@ -12,6 +12,12 @@ security_patch_level = "2024-01-01"
# Google Pixel 7 Pro
# What's unique: init_boot (boot v4) + vendor_boot (vendor v4)
[profile.pixel_v4_gki.vabc]
# CoW v3 is used starting with the Google Pixel 9a.
version = { V3 = { compression_factor = 65536 } }
algo = { kind = "Lz4" }
force_compression_factor = false
[profile.pixel_v4_gki.partitions.boot]
avb.signed = true
data.type = "boot"
@@ -45,13 +51,23 @@ data.type = "boot"
data.version = "vendor_v4"
data.ramdisks = [["otacerts", "first_stage", "dsu_key_dir"]]
[profile.pixel_v4_gki.hashes]
original = "6b140c378d21eae2fa4fc581bce13a689b21bd32f5fba865698d1fd322f2f8c6"
patched = "f00e9745f90754be28ce8355501d876759cd8336451e4c3633908fbb4217b422"
[profile.pixel_v4_gki.hashes_streaming]
original = "ea96196191e3a4133db4aff45d47aa3468514e29e0a724faac8081cbf4adf808"
patched = "357a448d1a7505b2308ce1c2d19b063e606c60e7349784913a48cdc3f6d50aa4"
[profile.pixel_v4_gki.hashes_seekable]
original = "f6615ae355eba38689d24aa535981d09175d4832e7c65c04cdd89aa95d21f09d"
patched = "9195ba963d9897af2f0821ff6051c1efe3fe130055b7936bedf2cd189998fd89"
# Google Pixel 6a
# What's unique: boot (boot v4, no ramdisk) + vendor_boot (vendor v4, 2 ramdisks)
[profile.pixel_v4_non_gki.vabc]
version = "V2"
algo = { kind = "Lz4" }
# delta_generator sets it for v2, even though it's not used.
force_compression_factor = true
[profile.pixel_v4_non_gki.partitions.boot]
avb.signed = true
data.type = "boot"
@@ -79,13 +95,22 @@ data.type = "boot"
data.version = "vendor_v4"
data.ramdisks = [["init", "otacerts", "first_stage", "dsu_key_dir"], ["dlkm"]]
[profile.pixel_v4_non_gki.hashes]
original = "31963e6f81986c6686111f50e36b89e4d85ee5c02bc8e5ecd560528bc98d6fe7"
patched = "43959409034dbb9aa0a605d7c5c0e7885012bbcd63510ec87d8e97015b37a746"
[profile.pixel_v4_non_gki.hashes_streaming]
original = "cb2a2e406d2b4c68c8a38f819256a10ada0ed5a4732822bec35bdf7bcdc458eb"
patched = "12f15d29fceeb18af14c9a805de3aedb7f270fe8ec316d9d0fe37fb0c667eacd"
[profile.pixel_v4_non_gki.hashes_seekable]
original = "9450c212c34fe55453b52345c7cc22f72397dc80d9ddc792eafc20b461c2afc9"
patched = "5018c579df9608f9dfe3add2afd8b176de61ba267376cf3a3e422ecc9d3dd112"
# Google Pixel 4a 5G
# What's unique: boot (boot v3) + vendor_boot (vendor v3)
[profile.pixel_v3.vabc]
version = "V2"
algo = { kind = "Gz" }
force_compression_factor = false
[profile.pixel_v3.partitions.boot]
avb.signed = true
data.type = "boot"
@@ -114,9 +139,13 @@ data.type = "boot"
data.version = "vendor_v3"
data.ramdisks = [["otacerts", "first_stage", "dsu_key_dir"]]
[profile.pixel_v3.hashes]
original = "e684aacb54464098c1b8e3f499efe35dff10ea792e89d71a83404620d0108b3e"
patched = "08e03ec327bf5bd841b91ad8d53028c3439a1722b423aaaac6cc0ceee4ef66b1"
[profile.pixel_v3.hashes_streaming]
original = "4b864b906a13ec98b1d6c3440a5eca7404ec63d073080e80a3b84afabcbd2fa2"
patched = "a9077fe32dee8eb7a0369c1334d8f3378ae8044814ae04da700f33294b12a4d8"
[profile.pixel_v3.hashes_seekable]
original = "e0e93ee11de56992f3a5f543858c1d11858b4deb76a91a4caf4fb0f3f34be855"
patched = "8730b398367179a0be092a67e4714f09c2267c656fe3e42ec1f8b43bb3a28634"
# Google Pixel 4a
# What's unique: boot (boot v2)
@@ -143,6 +172,10 @@ avb.signed = true
data.type = "vbmeta"
data.deps = ["system"]
[profile.pixel_v2.hashes]
original = "ee9568797d9195985f14753b89949d8ebb08c8863a32eceeeec6e8d94661b1cf"
patched = "5e265094d4164cedde8f483911c58860f6008b314dc8e5ed3b44deb53fbb2f96"
[profile.pixel_v2.hashes_streaming]
original = "abc0ad7f80020018101437c2494d6564a877df663d208a123267fc100734c175"
patched = "b1876455f5be9d5b6eafc598a017ad10e5e76339137f8b29777097ab19cdc3b0"
[profile.pixel_v2.hashes_seekable]
original = "57d4ac5ab7d362a593f3c02f3d2044b5400c10db0f732741a2d18e025d4231ec"
patched = "40d7674be14e19747e7ead118e0f4faf50880c638dfb4bfc0d0154b0e9202d3f"
+32 -9
View File
@@ -1,12 +1,11 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::path::PathBuf;
use std::{ffi::OsString, path::PathBuf};
use avbroot::cli::args::{LogFormat, LogLevel};
use clap::{Args, Parser, Subcommand};
use avbroot::cli::args::LogFormat;
use clap::{Args, Parser, Subcommand, ValueEnum};
use tracing::Level;
#[derive(Debug, Args)]
pub struct ProfileGroup {
@@ -69,10 +68,34 @@ pub struct Cli {
pub command: Command,
/// Lowest log message severity to output.
#[arg(long, global = true, value_name = "LEVEL", default_value_t)]
pub log_level: LogLevel,
#[arg(long, global = true, value_name = "LEVEL", default_value_t = Level::INFO)]
pub log_level: Level,
/// Output format for log messages.
#[arg(long, global = true, value_name = "FORMAT", default_value_t = LogFormat::Medium)]
pub log_format: LogFormat,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, ValueEnum)]
pub enum PassSource {
Env,
File,
}
#[derive(Debug, Parser)]
pub struct HelperCli {
/// Signature algorithm.
pub algorithm: String,
/// Public key.
#[arg(value_name = "FILE", value_parser)]
pub public_key: PathBuf,
/// Non-interactive password source.
#[arg(value_name = "SOURCE")]
pub pass_source: PassSource,
/// Non-interactive password source value.
#[arg(value_name = "VALUE", value_parser)]
pub pass_source_value: OsString,
}
+27 -18
View File
@@ -1,15 +1,14 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{collections::BTreeMap, fs, path::Path};
use anyhow::{Context, Result};
use avbroot::format::payload::{CowVersion, VabcAlgo};
use serde::{Deserialize, Serialize};
use toml_edit::DocumentMut;
#[derive(Serialize, Deserialize)]
#[derive(Clone, Copy, Serialize, Deserialize)]
pub struct Sha256Hash(
#[serde(
serialize_with = "hex::serialize",
@@ -18,7 +17,7 @@ pub struct Sha256Hash(
pub [u8; 32],
);
#[derive(Serialize, Deserialize)]
#[derive(Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct OtaInfo {
pub device: String,
@@ -30,7 +29,7 @@ pub struct OtaInfo {
pub security_patch_level: String,
}
#[derive(Serialize, Deserialize)]
#[derive(Clone, Copy, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Avb {
pub signed: bool,
@@ -56,7 +55,7 @@ pub enum BootVersion {
VendorV4,
}
#[derive(Serialize, Deserialize)]
#[derive(Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct BootData {
pub version: BootVersion,
@@ -72,19 +71,19 @@ pub enum DmVerityContent {
SystemOtacerts,
}
#[derive(Serialize, Deserialize)]
#[derive(Clone, Copy, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct DmVerityData {
pub content: DmVerityContent,
}
#[derive(Serialize, Deserialize)]
#[derive(Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct VbmetaData {
pub deps: Vec<String>,
}
#[derive(Serialize, Deserialize)]
#[derive(Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum Data {
Boot(BootData),
@@ -92,28 +91,38 @@ pub enum Data {
Vbmeta(VbmetaData),
}
#[derive(Serialize, Deserialize)]
#[derive(Clone, Copy, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Hashes {
pub original: Sha256Hash,
pub patched: Sha256Hash,
}
#[derive(Serialize, Deserialize)]
#[derive(Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Partition {
pub avb: Avb,
pub data: Data,
}
#[derive(Serialize, Deserialize)]
#[derive(Clone, Copy, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Profile {
pub partitions: BTreeMap<String, Partition>,
pub hashes: Hashes,
pub struct VabcSettings {
pub version: CowVersion,
pub algo: VabcAlgo,
pub force_compression_factor: bool,
}
#[derive(Serialize, Deserialize)]
#[derive(Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Profile {
pub vabc: Option<VabcSettings>,
pub partitions: BTreeMap<String, Partition>,
pub hashes_streaming: Hashes,
pub hashes_seekable: Hashes,
}
#[derive(Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Config {
pub ota_info: OtaInfo,
+450 -214
View File
File diff suppressed because it is too large Load Diff
+5 -1
View File
@@ -4,7 +4,8 @@ version.workspace = true
license.workspace = true
edition.workspace = true
repository.workspace = true
publish = false
publish.workspace = true
rust-version.workspace = true
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -16,3 +17,6 @@ publish = false
[target.'cfg(unix)'.dependencies]
avbroot = { path = "../avbroot" }
honggfuzz = "0.5.55"
[lints]
workspace = true
+3
View File
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
#[cfg(not(windows))]
mod fuzz {
use std::io::Cursor;
+3
View File
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
#[cfg(not(windows))]
mod fuzz {
use std::io::Cursor;
+3
View File
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
#[cfg(not(windows))]
mod fuzz {
use std::{io::Cursor, sync::atomic::AtomicBool};
+8 -3
View File
@@ -1,10 +1,13 @@
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
#[cfg(not(windows))]
mod fuzz {
use std::{io::Cursor, sync::atomic::AtomicBool};
use avbroot::{
format::fec::FecImage,
stream::{FromReader, SharedCursor, WriteZerosExt},
stream::{FromReader, MutexFile, UserPosFile, WriteZerosExt},
};
use honggfuzz::fuzz;
@@ -15,12 +18,14 @@ mod fuzz {
let reader = Cursor::new(data);
if let Ok(fec) = FecImage::from_reader(reader) {
let mut input = SharedCursor::new();
let input = MutexFile::new(Cursor::new(Vec::new()));
// Allow verify() to get further, but don't blow up the host
// with excessive memory usage.
if fec.data_size < 64 * 1024 * 1024 {
input.write_zeros_exact(fec.data_size).unwrap();
UserPosFile::new(&input)
.write_zeros_exact(fec.data_size)
.unwrap();
}
let _ = fec.verify(&input, &cancel_signal);
+24
View File
@@ -0,0 +1,24 @@
// SPDX-FileCopyrightText: 2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
#[cfg(not(windows))]
mod fuzz {
use std::io::Cursor;
use avbroot::{format::lp::Metadata, stream::FromReader};
use honggfuzz::fuzz;
pub fn main() {
loop {
fuzz!(|data: &[u8]| {
let reader = Cursor::new(data);
let _ = Metadata::from_reader(reader);
});
}
}
}
fn main() {
#[cfg(not(windows))]
fuzz::main();
}
+30
View File
@@ -0,0 +1,30 @@
// SPDX-FileCopyrightText: 2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
#[cfg(not(windows))]
mod fuzz {
use std::io::{self, Cursor};
use avbroot::format::sparse::{ChunkData, CrcMode, SparseReader};
use honggfuzz::fuzz;
pub fn main() {
loop {
fuzz!(|data: &[u8]| {
let reader = Cursor::new(data);
if let Ok(mut sparse_reader) = SparseReader::new(reader, CrcMode::Ignore) {
while let Ok(Some(chunk)) = sparse_reader.next_chunk() {
if chunk.data == ChunkData::Data {
let _ = io::copy(&mut sparse_reader, &mut io::sink());
}
}
}
});
}
}
}
fn main() {
#[cfg(not(windows))]
fuzz::main();
}
+6 -2
View File
@@ -4,7 +4,8 @@ version.workspace = true
license.workspace = true
edition.workspace = true
repository.workspace = true
publish = false
publish.workspace = true
rust-version.workspace = true
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -12,4 +13,7 @@ publish = false
anyhow = "1.0.75"
clap = { version = "4.4.1", features = ["derive"] }
regex = { version = "1.9.4", default-features = false, features = ["perf", "std"] }
toml_edit = "0.22.9"
toml_edit = "0.23.3"
[lints]
workspace = true
+5 -7
View File
@@ -1,17 +1,15 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
collections::BTreeMap,
fmt,
fmt::{self, Write as _},
fs::{self, File},
io::{BufRead, BufReader},
path::Path,
};
use anyhow::{anyhow, bail, Result};
use anyhow::{Result, anyhow, bail};
use regex::Regex;
use crate::WORKSPACE_DIR;
@@ -110,7 +108,7 @@ fn update_changelog_links(path: &Path, base_url: &str) -> Result<()> {
}
for (link_ref, link) in links {
result.push_str(&format!("{link_ref}: {link}\n"));
let _ = writeln!(result, "{link_ref}: {link}");
}
fs::write(path, result)?;
+2 -4
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
mod changelog;
mod version;
+4 -6
View File
@@ -1,7 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
* SPDX-License-Identifier: GPL-3.0-only
*/
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
fs::{self, File},
@@ -9,9 +7,9 @@ use std::{
path::Path,
};
use anyhow::{bail, Result};
use anyhow::{Result, bail};
use clap::Parser;
use toml_edit::{value, DocumentMut};
use toml_edit::{DocumentMut, value};
use crate::WORKSPACE_DIR;