Compare commits

...

137 Commits

Author SHA1 Message Date
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
52 changed files with 4744 additions and 2687 deletions
+9 -8
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,8 +36,7 @@ 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
@@ -84,7 +85,7 @@ jobs:
done
- name: Cache Rust dependencies
uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2.7.7
uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2.8.0
with:
key: ${{ matrix.artifact.name }}
@@ -93,7 +94,7 @@ jobs:
run: |
for target in ${TARGETS}; do
cargo android \
clippy --release --workspace --features static \
clippy --release --workspace \
--target "${target}"
done
@@ -102,7 +103,7 @@ jobs:
run: |
for target in ${TARGETS}; do
cargo android \
build --release --workspace --features static \
build --release --workspace \
--target "${target}"
done
@@ -111,7 +112,7 @@ jobs:
run: |
for target in ${TARGETS}; do
cargo android \
test --release --workspace --features static \
test --release --workspace \
--target "${target}"
done
@@ -120,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
@@ -155,7 +156,7 @@ jobs:
run: cp LICENSE README.md target/output/
- name: Archive executable
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
name: avbroot-${{ steps.get_version.outputs.version }}-${{ matrix.artifact.name }}
path: |
+1 -1
View File
@@ -13,4 +13,4 @@ jobs:
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Run cargo-deny
uses: EmbarkStudios/cargo-deny-action@e2f4ede4a4e60ea15ff31bc0647485d80c66cfba # v2.0.4
uses: EmbarkStudios/cargo-deny-action@30f817c6f72275c6d54dc744fbca09ebc958599f # v2.0.12
+1 -1
View File
@@ -27,7 +27,7 @@ jobs:
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Create release
uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda # v2.2.1
uses: softprops/action-gh-release@72f2c25fcb47643c292f7107632f7a47c1df5cd8 # v2.3.2
with:
tag_name: v${{ steps.get_version.outputs.version }}
name: Version ${{ steps.get_version.outputs.version }}
+158
View File
@@ -7,6 +7,100 @@
to update the actual links at the bottom of the file.
-->
### 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])
@@ -280,6 +374,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
@@ -306,6 +402,13 @@ Behind-the-scenes changes:
[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
@@ -444,3 +547,58 @@ Behind-the-scenes changes:
[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
Generated
+539 -461
View File
File diff suppressed because it is too large Load Diff
+2 -2
View File
@@ -4,9 +4,9 @@ members = ["avbroot", "e2e", "fuzz", "xtask"]
resolver = "2"
[workspace.package]
version = "3.12.0"
version = "3.21.0"
license = "GPL-3.0-only"
edition = "2021"
edition = "2024"
repository = "https://github.com/chenxiaolong/avbroot"
[workspace.lints.clippy]
+12 -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,23 @@ 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
+48 -15
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,7 +29,7 @@ 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._**
@@ -53,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
@@ -213,6 +213,8 @@ 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
```
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
@@ -225,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.
10. 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
@@ -384,11 +390,28 @@ 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 recovery OTA certificate patches
### Skipping OTA certificate patches
avbroot can skip modifying `otacerts.zip` in the recovery image with the `--skip-recovery-ota-cert` option. **Do not do this unless you have a good reason to do so.** (For example, if you've already manually inserted the OTA certificate into a boot image specified with `--prepatched` or `--replace`.) When this option is used with `--rootless` (and `--dsu` is not specified), then no modifications are performed on any boot image besides ensuring they are properly signed.
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 manually adding the OTA certificate to a boot image, [verifying the patched OTA](#verifying-otas) afterwards is recommended to ensure that it was properly done.
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
@@ -414,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:
@@ -555,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:
+111 -27
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.
@@ -51,6 +49,8 @@ avbroot модифицирует следующие образы:
3. [Сгенерируйте ключи подписи.](#генерация-ключей)
Пропустите этот шаг, если вы обновляете Android, Magisk или KernelSU уже после выполнения [первоначальной настройки](#первоначальная-настройка). Повторная генерация ключей подписи для [обновлений](#обновления) не требуется: для всех последующих обновлений должны использоваться те ключи, что были созданы при первоначальной настройке.
4. Пропатчите ОТА-архив с помощью команды:
```bash
@@ -107,7 +107,7 @@ avbroot модифицирует следующие образы:
Первые два компонента подписываются ключом AVB, а последние два – ключом OTA. Можно использовать один и тот же ключ, однако в следующих шагах описано, как сгенерировать два отдельных.
Если вы патчите OTA сразу для нескольких устройств, настоятельно рекомендуется генерировать уникальные ключи для каждого девайса – так вы защитите себя от случайной прошивки неподходящего OTA для другого телефона.
Если вы патчите OTA сразу для нескольких устройств, настоятельно рекомендуется генерировать уникальные ключи для каждого девайса – так вы защитите себя от случайной прошивки неподходящего OTA.
1. Сгенерируйте ключи подписи для AVB и OTA.
@@ -122,7 +122,7 @@ avbroot модифицирует следующие образы:
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
@@ -185,7 +185,7 @@ avbroot совместим с любым стандартным 4096-битны
fastboot flashall --skip-reboot
```
Обратите внимание, что так прошиваются лишь те образы, что относятся к системе. Разделы загрузчика и модема же остаются нетронутыми из-за ограничений fastboot. Если они не обновлены до необходимой версии, или вы не уверены в этом, после прошивки перейдите к пункту [обновлений](#обновления) и установите пропатченный OTA-архив сайдлоадом в режиме Recovery. Прошивка полного OTA гарантирует, что абсолютно все разделы будут обновлены.
Обратите внимание, что так прошиваются лишь те образы, что относятся к системе. Разделы загрузчика и модема же остаются нетронутыми из-за ограничений fastboot. Если они не обновлены до необходимой версии, или вы не уверены в этом, после прошивки перейдите к пункту [обновлений](#обновления) и установите пропатченный OTA в режиме Recovery. Прошивка полного OTA гарантирует, что абсолютно все разделы будут обновлены.
Для устройств Pixel есть ещё один вариант: запуск скрипта `flash-base.sh` из папки заводских образов (factory images) обновит загрузчик и модем.
@@ -211,6 +211,8 @@ avbroot совместим с любым стандартным 4096-битны
init: [libfs_avb]Returning avb_handle with status: Success
```
Как ещё один вариант, Android-версию avbroot также можно использовать для [проверки разделов на устройстве](./README.extra.md#verifying-avb-hashes-and-signatures-on-device).
9. Перезагрузитесь в fastboot и заблокируйте загрузчик. Это снова приведет к стиранию данных.
```bash
@@ -229,15 +231,19 @@ avbroot совместим с любым стандартным 4096-битны
Обновления 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-сервера), приложение будет отображать соответствующее уведомление до завершения операции слияния снапшота.
## Возврат на заводскую прошивку
@@ -255,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-обновление, а затем повторяя попытку загрузки и установки при неудачной проверке подписи.
@@ -295,6 +301,7 @@ Magisk версии 25211 и новее требует наличие разде
--input /path/to/ota.zip \
--directory . \
--boot-only
--partition <название раздела> # init_boot или boot, в зависимости от устройства
```
2. Теперь нужно пропатчить загрузочный образ с помощью приложения Magisk. Это **ДОЛЖНО** быть сделано именно на целевом устройстве или устройстве той же модели! Имя раздела будет неверным и не подойдет, если пропатчить образ на устройстве иной модели.
@@ -316,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
@@ -381,17 +388,34 @@ avbroot может подменить используемый загрузоч
avbroot можно использовать для простого переподписания OTA, указав аргумент `--rootless` вместо `--magisk`/`--prepatched`. В таком случае пропатченный OTA не будет рутирован. Единственная модификация, которая будет применена – это замена сертификата проверки OTA, чтобы систему можно было обновлять с помощью будущих пропатченных OTA.
### Пропуск патчинга сертификата OTA в разделе Recovery
### Пропуск патчинга сертификата OTA
avbroot может пропустить изменение файла `otacerts.zip` в разделе Recovery с помощью опции `--skip-recovery-ota-cert`. **Не используйте эту функцию, если на то нет веской причины.** (Например, если вы уже самостоятельно встроили сертификат OTA в загрузочный образ (`boot.img`) и передаете его программе через опции `--prepatched` или `--replace`.) Если эта опция применяется совместно с `--rootless` (и без указания параметра `--dsu`), то в загрузочный образ не будут внесены никакие изменения, кроме обеспечения его корректной подписи.
Вы можете пропустить изменение otacerts.zip, используя аргументы `--skip-system-ota-cert` и `--skip-recovery-ota-cert`. **Не используйте их без веской причины.**
Если вы вручную добавили сертификат OTA в загрузочный образ, рекомендуем [предварительно проверить пропатченный OTA.](#проверка-ota)
При использовании `--skip-system-ota-cert`, сертификаты OTA в образе `system` изменены не будут. Это не позволит сторонним приложениям для OTA-обновлений устанавливать будущие пропатченные OTA из-под загруженной системы.
### Подмена разделов
При использовании `--skip-recovery-ota-cert`, сертификаты OTA в образах `vendor_boot` или `recovery` изменены не будут. **Это не позволит устанавливать будущие пропатченные OTA в режиме Recovery.**
avbroot поддерживает подмену целых образов в OTA, даже тех, что не являются загрузочными (например, `vendor_dlkm`). Образ можно заменить, указав аргумент `--replace <имя раздела> /путь/к/образу.img`.
Если вы используете аргумент `--skip-recovery-ota-cert`, потому что уже добавили сертификат OTA в загрузочный образ вручную, рекомендуетcя [проверить пропатченный OTA](#проверка-ota), дабы удостовериться, что замена произведена корректно. Процесс верификации проверяет только копию сертификатов OTA в загрузочном образе, не проверяя копию в образе системы.
Единственное, что меняется – это то, откуда считывается раздел. При использовании `--replace` вместо использования образа раздела из оригинального `payload.bin` в OTA, он берется напрямую по указанному вами пути. Таким образом, заменяющие образы разделов должны иметь правильные колонтитулы vbmeta, соответствующие оригинальным.
### Пропуск всех патчей
Чтобы внести самый минимум изменений, укажите аргументы:
* `--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`.
@@ -405,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 в неинтерактивном режиме, можно:
@@ -441,17 +477,20 @@ 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` при патчинге.
@@ -480,6 +519,53 @@ avbroot поддерживает делегирование всех опера
Обратите внимание, что 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/) Затем выполните:
@@ -492,8 +578,6 @@ cargo build --release
Дебаг-сборки тоже работают, но они будут работать значительно медленнее (в вычислениях sha256), потому что оптимизации компилятора отключены.
По умолчанию исполняемый файл ссылается на системные библиотеки bzip2 и liblzma, от которых зависит avbroot. Чтобы скомпилировать и статически связать эти две библиотеки, укажите аргумент `--features static`.
### Кросс-компиляция на Android
Чтобы использовать кросс-компиляцию на Android, установите [cargo-android](https://github.com/chenxiaolong/cargo-android) и воспользуйтесь оболочкой `cargo android`. Чтобы создать релизную сборку для aarch64, выполните:
+18 -30
View File
@@ -13,43 +13,45 @@ anyhow = "1.0.75"
base64 = "0.22.1"
bitflags = { version = "2.4.1", features = ["serde"] }
bstr = "1.6.2"
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"
dlv-list = "0.6.0"
flate2 = "1.0.27"
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.10.0"
memchr = "2.6.0"
miniz_oxide = "0.8.0"
num-bigint-dig = "0.8.4"
num-traits = "0.2.16"
passterm = "2.0.3"
phf = { version = "0.11.2", features = ["macros"] }
phf = { version = "0.12.1", features = ["macros"] }
pkcs8 = { version = "0.10.2", features = ["encryption", "pem"] }
prost = "0.13.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"
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 = "2.0.3"
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"
@@ -57,34 +59,20 @@ x509-cert = { version = "0.2.4", features = ["builder"] }
zerocopy = { version = "0.8.10", features = ["std"] }
zerocopy-derive = "0.8.5"
# Waiting for next stable release.
[dependencies.bzip2]
git = "https://github.com/trifectatechfoundation/bzip2-rs"
rev = "09a87db73c0517a9715ab3fd96fbe4961d545aee"
default-features = false
features = ["libbz2-rs-sys"]
# https://github.com/zip-rs/zip/pull/383
[dependencies.zip]
git = "https://github.com/chenxiaolong/zip"
rev = "989101f9384b9e94e36e6e9e0f51908fdf98bde6"
default-features = false
features = ["deflate"]
[target.'cfg(unix)'.dependencies]
libc = "0.2.158"
rustix = { version = "0.38.9", default-features = false, features = ["process"] }
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]
constcat = "0.5.0"
prost-build = "0.13.1"
protox = "0.7.0"
constcat = "0.6.0"
prost-build = "0.14.1"
protox = "0.9.0"
[dev-dependencies]
assert_matches = "1.5.0"
[features]
static = ["liblzma/static"]
[lints]
workspace = true
+1 -1
View File
@@ -10,7 +10,7 @@ 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, lp, ota, payload, sparse};
+269 -138
View File
@@ -1,25 +1,23 @@
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
collections::{HashMap, HashSet},
ffi::{OsStr, OsString},
fs::{self, File},
ffi::OsString,
fmt,
fs::{self, File, OpenOptions},
io::{self, BufReader, BufWriter, Cursor, Seek, SeekFrom, Write},
path::{Path, PathBuf},
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, RsaSigningKey},
@@ -27,7 +25,7 @@ use crate::{
self, AlgorithmType, AppendedDescriptorMut, AppendedDescriptorRef, Descriptor, Footer,
HashTreeDescriptor, Header, KernelCmdlineDescriptor,
},
stream::{self, check_cancel, PSeekFile, ReadFixedSizeExt, Reopen, ToWriter},
stream::{self, ReadFixedSizeExt, ToWriter, UserPosFile, check_cancel},
util,
};
@@ -54,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 {
@@ -95,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(
@@ -114,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);
@@ -146,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()?;
@@ -160,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)?;
@@ -183,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
@@ -194,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)
@@ -312,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);
}
}
@@ -345,7 +327,7 @@ fn sign_or_clear(info: &mut AvbInfo, orig_header: &Header, key_group: &KeyGroup)
} else {
SignAction::Clear
}
} else if originally_signed && &info.header != orig_header {
} 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
@@ -424,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<()> {
@@ -447,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:?}"))?;
@@ -464,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;
@@ -496,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)?;
}
_ => {}
}
@@ -512,7 +567,7 @@ pub fn verify_headers(
/// work.
fn verify_and_repair(
name: Option<&str>,
mut file: PSeekFile,
file: &File,
descriptor: AppendedDescriptorRef,
repair: bool,
cancel_signal: &AtomicBool,
@@ -529,7 +584,7 @@ fn verify_and_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).inspect(|()| {
@@ -543,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}"))?;
}
}
@@ -555,49 +609,44 @@ 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,
cancel_signal,
)
})
.collect()
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: &Dir,
directory: &Path,
name: &str,
context: &mut ring::digest::Context,
max_depth: u8,
@@ -612,11 +661,8 @@ fn compute_digest_recursive(
seen.insert(name.to_owned());
ensure_name_is_safe(name)?;
let path = format!("{name}.img");
let mut raw_reader = directory
.open(&path)
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)
@@ -668,7 +714,11 @@ fn compute_digest_recursive(
/// 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: &Dir, name: &str, cancel_signal: &AtomicBool) -> Result<[u8; 32]> {
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);
@@ -716,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.
@@ -745,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)?;
@@ -754,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.
@@ -776,50 +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 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 mut seen = HashSet::<String>::new();
let mut descriptors = HashMap::<String, Descriptor>::new();
verify_headers(
&directory,
name,
public_key.as_ref(),
&mut seen,
&mut descriptors,
)?;
verify_descriptors(&directory, &descriptors, cli.repair, cancel_signal)?;
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 digest_subcommand(cli: &DigestCli, cancel_signal: &AtomicBool) -> Result<()> {
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:?}"))?;
fn verify_subcommand(cli: &VerifyCli, cancel_signal: &AtomicBool) -> Result<()> {
let directory = util::parent_path(&cli.input);
let name = cli
.input
.file_stem()
@@ -827,7 +864,71 @@ fn digest_subcommand(cli: &DigestCli, cancel_signal: &AtomicBool) -> Result<()>
.to_str()
.ok_or_else(|| anyhow!("Invalid UTF-8: {:?}", cli.input))?;
let digest = compute_digest(&directory, name, cancel_signal)?;
let opener = ImageOpener::with_dir(directory);
verify_internal(
cli.public_key.as_deref(),
None,
&opener,
name,
cli.repair,
!cli.fail_if_missing,
cancel_signal,
)
}
#[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));
@@ -841,6 +942,8 @@ 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),
}
}
@@ -1044,6 +1147,32 @@ 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.
@@ -1065,6 +1194,8 @@ enum AvbCommand {
#[command(alias = "dump")]
Info(InfoCli),
Verify(VerifyCli),
#[cfg(target_os = "android")]
VerifyDevice(VerifyDeviceCli),
Digest(DigestCli),
}
+1 -1
View File
@@ -7,7 +7,7 @@ use std::{
path::{Path, PathBuf},
};
use anyhow::{bail, Context, Result};
use anyhow::{Context, Result, bail};
use clap::{Parser, Subcommand};
use crate::{
+17 -25
View File
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
@@ -9,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};
@@ -91,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
@@ -122,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))
@@ -171,16 +170,13 @@ fn unpack_subcommand(
display_format(cpio_cli, format);
let authority = ambient_authority();
Dir::create_ambient_dir_all(&cli.output_tree, authority)
fs::create_dir_all(&cli.output_tree)
.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))?;
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)? {
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)
@@ -209,12 +205,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);
+4 -8
View File
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
@@ -13,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:?}"))
}
@@ -91,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(())
+3 -4
View File
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
@@ -13,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:?}"))
}
+29 -67
View File
@@ -1,16 +1,14 @@
// SPDX-FileCopyrightText: 2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2024-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
ffi::OsStr,
fs::{self, File},
io::{Seek, SeekFrom},
path::{Path, PathBuf},
sync::atomic::AtomicBool,
};
use anyhow::{bail, Context, Result};
use cap_std::{ambient_authority, fs::Dir};
use anyhow::{Context, Result, bail};
use clap::{CommandFactory, Parser, Subcommand};
use rayon::iter::{
IndexedParallelIterator, IntoParallelIterator, IntoParallelRefIterator, ParallelIterator,
@@ -18,36 +16,33 @@ use rayon::iter::{
use crate::{
format::lp::{Extent, ExtentType, ImageType, Metadata, SECTOR_SIZE},
stream::{self, FromReader, PSeekFile, Reopen, ToWriter},
stream::{self, FromReader, ToWriter, UserPosFile},
util,
};
fn open_lp_inputs(paths: &[impl AsRef<Path>]) -> Result<(Vec<PSeekFile>, Metadata)> {
let mut inputs = paths
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)
.map(PSeekFile::new)
.with_context(|| format!("Failed to open LP image for reading: {p:?}"))
File::open(p).with_context(|| format!("Failed to open LP image for reading: {p:?}"))
})
.collect::<Result<Vec<_>>>()?;
let metadata = Metadata::from_reader(&mut inputs[0])
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<PSeekFile>> {
fn open_lp_outputs(paths: &[impl AsRef<Path>]) -> Result<Vec<File>> {
paths
.iter()
.map(|p| {
let p = p.as_ref();
File::create(p)
.map(PSeekFile::new)
.with_context(|| format!("Failed to open LP image for writing: {p:?}"))
File::create(p).with_context(|| format!("Failed to open LP image for writing: {p:?}"))
})
.collect::<Result<Vec<_>>>()
}
@@ -166,17 +161,15 @@ fn fill_slots(metadata: &mut Metadata) {
}
fn unpack_subcommand(lp_cli: &LpCli, cli: &UnpackCli, cancel_signal: &AtomicBool) -> Result<()> {
let mut inputs = cli
let inputs = cli
.input
.iter()
.map(|p| {
File::open(p)
.map(PSeekFile::new)
.with_context(|| format!("Failed to open LP image for reading: {p:?}"))
File::open(p).with_context(|| format!("Failed to open LP image for reading: {p:?}"))
})
.collect::<Result<Vec<_>>>()?;
let mut metadata = Metadata::from_reader(&mut inputs[0])
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.
@@ -190,11 +183,8 @@ fn unpack_subcommand(lp_cli: &LpCli, cli: &UnpackCli, cancel_signal: &AtomicBool
return Ok(());
}
let authority = ambient_authority();
Dir::create_ambient_dir_all(&cli.output_images, authority)
fs::create_dir_all(&cli.output_images)
.with_context(|| format!("Failed to create directory: {:?}", cli.output_images))?;
let directory = Dir::open_ambient_dir(&cli.output_images, authority)
.with_context(|| format!("Failed to open directory: {:?}", cli.output_images))?;
let slot = &metadata.slots[0];
@@ -216,11 +206,10 @@ fn unpack_subcommand(lp_cli: &LpCli, cli: &UnpackCli, cancel_signal: &AtomicBool
for partition in &group.partitions {
// A partition name with unsafe characters fails during parsing.
let path = format!("{}.img", partition.name);
let path =
util::path_join_single(&cli.output_images, format!("{}.img", partition.name))?;
let file = directory
.create(&path)
.map(|f| PSeekFile::new(f.into_std()))
let file = File::create(&path)
.with_context(|| format!("Failed to open for writing: {path:?}"))?;
file.set_len(partition.size()?)
@@ -251,10 +240,9 @@ fn unpack_subcommand(lp_cli: &LpCli, cli: &UnpackCli, cancel_signal: &AtomicBool
.into_par_iter()
.map(move |e| (g_index, p_index, e))
})
.map(|(g_index, p_index, extent)| {
// Never fails for PSeekFiles.
let mut reader = inputs[extent.device_index].reopen()?;
let mut writer = files[g_index][p_index].reopen()?;
.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];
@@ -271,9 +259,6 @@ fn unpack_subcommand(lp_cli: &LpCli, cli: &UnpackCli, cancel_signal: &AtomicBool
Ok(())
})
.collect::<Result<()>>()?;
Ok(())
}
fn pack_subcommand(lp_cli: &LpCli, cli: &PackCli, cancel_signal: &AtomicBool) -> Result<()> {
@@ -303,35 +288,20 @@ fn pack_subcommand(lp_cli: &LpCli, cli: &PackCli, cancel_signal: &AtomicBool) ->
}
}
for group in &slot.groups {
for partition in &group.partitions {
let name = &partition.name;
if Path::new(name).file_name() != Some(OsStr::new(name)) {
bail!("Unsafe partition name: {name}");
}
}
}
// Preopen all image input files.
let mut paths = vec![];
let mut files = vec![];
if metadata.image_type == ImageType::Normal {
let authority = ambient_authority();
let directory = Dir::open_ambient_dir(&cli.input_images, authority)
.with_context(|| format!("Failed to open directory: {:?}", cli.input_images))?;
for group in &mut slot.groups {
let mut group_paths = vec![];
let mut group_files = vec![];
for partition in &mut group.partitions {
let path = format!("{}.img", partition.name);
let path =
util::path_join_single(&cli.input_images, format!("{}.img", partition.name))?;
let mut file = directory
.open(&path)
.map(|f| PSeekFile::new(f.into_std()))
let mut file = File::open(&path)
.with_context(|| format!("Failed to open for reading: {path:?}"))?;
let size = file
@@ -398,10 +368,9 @@ fn pack_subcommand(lp_cli: &LpCli, cli: &PackCli, cancel_signal: &AtomicBool) ->
.into_par_iter()
.map(move |e| (g_index, p_index, e))
})
.map(|(g_index, p_index, extent)| {
// Never fails for PSeekFiles.
let mut reader = files[g_index][p_index].reopen()?;
let mut writer = outputs[extent.device_index].reopen()?;
.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];
@@ -418,9 +387,6 @@ fn pack_subcommand(lp_cli: &LpCli, cli: &PackCli, cancel_signal: &AtomicBool) ->
Ok(())
})
.collect::<Result<()>>()?;
Ok(())
}
fn repack_subcommand(lp_cli: &LpCli, cli: &RepackCli, cancel_signal: &AtomicBool) -> Result<()> {
@@ -503,10 +469,9 @@ fn repack_subcommand(lp_cli: &LpCli, cli: &RepackCli, cancel_signal: &AtomicBool
// Flatten extents in all partitions and split them to smaller chunks
// for better parallelism.
.flat_map(|partition| split_extents(&partition.extents))
.map(|extent| {
// Never fails for PSeekFiles.
let mut reader = inputs[extent.device_index].reopen()?;
let mut writer = outputs[extent.device_index].reopen()?;
.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];
@@ -523,9 +488,6 @@ fn repack_subcommand(lp_cli: &LpCli, cli: &RepackCli, cancel_signal: &AtomicBool
Ok(())
})
.collect::<Result<()>>()?;
Ok(())
}
fn info_subcommand(lp_cli: &LpCli, cli: &InfoCli) -> Result<()> {
+788 -456
View File
File diff suppressed because it is too large Load Diff
+13 -28
View File
@@ -1,17 +1,16 @@
// SPDX-FileCopyrightText: 2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2024-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
collections::HashMap,
ffi::{OsStr, OsString},
ffi::OsString,
fs::{self, File},
io::{BufReader, BufWriter, Seek, SeekFrom},
path::{Path, PathBuf},
sync::atomic::AtomicBool,
sync::{Arc, atomic::AtomicBool},
};
use anyhow::{anyhow, bail, Context, Result};
use cap_std::{ambient_authority, fs::Dir};
use anyhow::{Context, Result, anyhow, bail};
use clap::{Args, Parser, Subcommand};
use tracing::info;
@@ -19,7 +18,8 @@ use crate::{
cli::ota,
crypto::{self, PassphraseSource, RsaSigningKey},
format::payload::{PayloadHeader, PayloadWriter},
stream::{self, FromReader, PSeekFile},
stream::{self, FromReader},
util,
};
fn open_reader(path: &Path, allow_delta: bool) -> Result<(BufReader<File>, PayloadHeader)> {
@@ -113,15 +113,12 @@ fn unpack_subcommand(
write_info(&cli.output_info, &header)?;
let authority = ambient_authority();
Dir::create_ambient_dir_all(&cli.output_images, authority)
fs::create_dir_all(&cli.output_images)
.with_context(|| format!("Failed to create directory: {:?}", cli.output_images))?;
let directory = Dir::open_ambient_dir(&cli.output_images, authority)
.with_context(|| format!("Failed to open directory: {:?}", cli.output_images))?;
ota::extract_payload(
&PSeekFile::new(reader.into_inner()),
&directory,
&reader.into_inner(),
&cli.output_images,
0,
payload_size,
&header,
@@ -147,28 +144,16 @@ fn pack_subcommand(
let mut header = read_info(&cli.input_info)?;
let authority = ambient_authority();
let directory = Dir::open_ambient_dir(&cli.input_images, authority)
.with_context(|| format!("Failed to open directory: {:?}", cli.input_images))?;
for p in &header.manifest.partitions {
let name = &p.partition_name;
if Path::new(name).file_name() != Some(OsStr::new(name)) {
bail!("Unsafe partition name: {name}");
}
}
// Pre-open all of the image files.
let input_files = header
.manifest
.partitions
.iter()
.map(|p| {
let path = format!("{}.img", p.partition_name);
let file = directory
.open(&path)
.map(|f| PSeekFile::new(f.into_std()))
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))
+8 -8
View File
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: 2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2024-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
@@ -10,10 +10,10 @@ use std::{
sync::atomic::AtomicBool,
};
use anyhow::{anyhow, bail, Context, Result};
use anyhow::{Context, Result, anyhow, bail};
use clap::{Parser, Subcommand};
use crc32fast::Hasher;
use zerocopy::{little_endian, IntoBytes};
use zerocopy::{IntoBytes, little_endian};
use crate::{
format::{
@@ -122,13 +122,13 @@ fn find_allocated_regions(
loop {
stream::check_cancel(cancel_signal)?;
start = match rustix::fs::seek(reader, SeekFrom::Data(end as i64)) {
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 as i64))
end = rustix::fs::seek(reader, SeekFrom::Hole(start))
.with_context(|| format!("Failed to seek to hole: {path:?}"))?;
result.push(start..end);
@@ -317,11 +317,11 @@ fn unpack_subcommand(
})?;
}
ChunkData::Hole => {
// This cannot overflow.
let to_skip = chunk.bounds.len() * metadata.header.block_size;
// Unlike ChunkData::Data, this can overflow a u32.
let to_skip = i64::from(chunk.bounds.len()) * i64::from(metadata.header.block_size);
writer
.seek(SeekFrom::Current(to_skip.into()))
.seek_relative(to_skip)
.with_context(|| format!("Failed to seek file: {:?}", cli.output))?;
}
ChunkData::Crc32(_) => {}
+9 -8
View File
@@ -21,25 +21,25 @@ use cms::{
};
use passterm::PromptError;
use pkcs8::{
pkcs5::{pbes2, scrypt},
DecodePrivateKey, DecodePublicKey, EncodePrivateKey, EncodePublicKey, EncryptedPrivateKeyInfo,
LineEnding, PrivateKeyInfo,
pkcs5::{pbes2, scrypt},
};
use rand::RngCore;
use rsa::{
pkcs1v15::SigningKey, traits::PublicKeyParts, Pkcs1v15Sign, RsaPrivateKey, RsaPublicKey,
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;
@@ -144,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 {
@@ -159,10 +160,10 @@ impl PassphraseSource {
Err(e) => {
#[cfg(unix)]
if let PromptError::IOError(io_e) = e {
if let Some(errno) = io_e.raw_os_error() {
if errno == libc::ENXIO || errno == libc::ENOTTY {
return Err(Error::NotInteractive(io_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)));
+1 -1
View File
@@ -4,7 +4,7 @@
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)]
+71 -89
View File
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
@@ -14,10 +14,10 @@ use bstr::ByteSlice;
use num_bigint_dig::{ModInverse, ToBigInt};
use num_traits::{Pow, ToPrimitive};
use ring::digest::{Algorithm, Context};
use rsa::{traits::PublicKeyParts, BigUint, RsaPublicKey};
use rsa::{BigUint, RsaPublicKey, traits::PublicKeyParts};
use serde::{Deserialize, Serialize};
use thiserror::Error;
use zerocopy::{big_endian, FromBytes, IntoBytes};
use zerocopy::{FromBytes, IntoBytes, big_endian};
use zerocopy_derive::{FromBytes, Immutable, IntoBytes, KnownLayout, Unaligned};
use crate::{
@@ -29,8 +29,8 @@ use crate::{
padding::{self, ZeroPadding},
},
stream::{
self, CountingReader, CountingWriter, FromReader, ReadFixedSizeExt, ReadSeekReopen,
ToWriter, WriteSeekReopen, WriteZerosExt,
self, CountingReader, CountingWriter, FromReader, ReadAt, ReadFixedSizeExt, ReadWriteAt,
ToWriter, UserPosFile, WriteZerosExt,
},
util::{self, OutOfBoundsError},
};
@@ -149,10 +149,6 @@ pub enum Error {
FecVerify(#[source] fec::Error),
#[error("Failed to repair file with FEC data")]
FecRepair(#[source] fec::Error),
#[error("Failed to reopen input file")]
InputReopen(#[source] io::Error),
#[error("Failed to reopen output file")]
OutputReopen(#[source] io::Error),
#[error("Failed to compute hash of input file")]
InputDigest(#[source] io::Error),
#[error("Failed to read AVB data: {0}")]
@@ -163,9 +159,9 @@ pub enum Error {
type Result<T> = std::result::Result<T, Error>;
pub(crate) fn ring_algorithm(name: &str, for_verify: bool) -> Result<&'static Algorithm> {
pub(crate) fn digest_algorithm(name: &str) -> Result<&'static Algorithm> {
match name {
"sha1" if for_verify => Ok(&ring::digest::SHA1_FOR_LEGACY_USE_ONLY),
"sha1" => Ok(&ring::digest::SHA1_FOR_LEGACY_USE_ONLY),
"sha256" => Ok(&ring::digest::SHA256),
"sha512" => Ok(&ring::digest::SHA512),
a => Err(Error::UnsupportedHashAlgorithm(a.to_owned())),
@@ -292,7 +288,7 @@ trait DescriptorTag {
/// Raw on-disk layout for the AVB property descriptor after the prefix.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawPropertyDescriptor {
key_size: big_endian::U64,
value_size: big_endian::U64,
@@ -395,7 +391,7 @@ impl<W: Write> ToWriter<W> for PropertyDescriptor {
/// Raw on-disk layout for the AVB hash tree descriptor after the prefix.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawHashTreeDescriptor {
dm_verity_version: big_endian::U32,
image_size: big_endian::U64,
@@ -510,10 +506,7 @@ impl HashTreeDescriptor {
/// Update the root hash, hash tree, and FEC data. The hash tree and FEC
/// data will be written immediately following the image data at offset
/// [`Self::image_size`]. Both `open_input` and `open_output` may be called
/// from multiple threads and must return independently seekable handles to
/// the same file. It is guaranteed that every thread will read and write
/// disjoint file offsets.
/// [`Self::image_size`].
///
/// If `ranges` is [`Option::None`], then the hash tree and FEC data are
/// updated for the whole while. Due to the nature of the file access
@@ -525,42 +518,37 @@ impl HashTreeDescriptor {
/// that what is specified in order to perform the computations.
///
/// The fields in this instance are updated atomically. No fields are
/// updated if an error occurs. The input file can be restored back to its
/// updated if an error occurs. The file can be restored back to its
/// original state by truncating it to [`Self::image_size`].
pub fn update(
&mut self,
input: &(dyn ReadSeekReopen + Sync),
output: &(dyn WriteSeekReopen + Sync),
file: &(dyn ReadWriteAt + Sync),
ranges: Option<&[Range<u64>]>,
cancel_signal: &AtomicBool,
) -> Result<()> {
let algorithm = ring_algorithm(&self.hash_algorithm, false)?;
let mut pos_file = UserPosFile::new(file);
let algorithm = digest_algorithm(&self.hash_algorithm)?;
let hash_tree = HashTree::new(self.data_block_size, algorithm, &self.salt);
let tree_offset = self.image_size;
let (root_digest, hash_tree_data) = match ranges {
Some(r) => {
let mut reader = input.reopen_boxed().map_err(Error::InputReopen)?;
reader
.seek(SeekFrom::Start(self.tree_offset))
pos_file
.seek(SeekFrom::Start(tree_offset))
.map_err(|e| Error::DataRead("HashTree::tree_data", e))?;
let mut hash_tree_data = reader
let mut hash_tree_data = pos_file
.read_vec_exact(self.tree_size as usize)
.map_err(|e| Error::DataRead("HashTree::tree_data", e))?;
let root_digest = hash_tree
.update(
input,
self.image_size,
r,
&mut hash_tree_data,
cancel_signal,
)
.update(file, self.image_size, r, &mut hash_tree_data, cancel_signal)
.map_err(Error::HashTreeUpdate)?;
(root_digest, hash_tree_data)
}
None => hash_tree
.generate(input, self.image_size, cancel_signal)
.generate(file, self.image_size, cancel_signal)
.map_err(Error::HashTreeGenerate)?,
};
@@ -569,11 +557,10 @@ impl HashTreeDescriptor {
let tree_size = hash_tree_data.len() as u64;
let mut writer = output.reopen_boxed().map_err(Error::OutputReopen)?;
writer
.seek(SeekFrom::Start(self.image_size))
pos_file
.seek(SeekFrom::Start(tree_offset))
.map_err(|e| Error::DataWrite("HashTree::tree_data", e))?;
writer
pos_file
.write_all(&hash_tree_data)
.map_err(|e| Error::DataWrite("HashTree::tree_data", e))?;
@@ -588,66 +575,62 @@ impl HashTreeDescriptor {
let parity: u8 = util::try_cast(self.fec_num_roots)
.map_err(|e| Error::IntOutOfBounds("HashTree::fec_num_roots", e))?;
let fec_offset = tree_offset + tree_size;
let fec_data = if let Some(r) = ranges {
let mut r_with_hash_tree = r.to_vec();
r_with_hash_tree.push(self.tree_offset..self.tree_offset + tree_size);
r_with_hash_tree.push(tree_offset..tree_offset + tree_size);
let (fec, fec_size) = self.get_fec()?;
let mut reader = input.reopen_boxed().map_err(Error::InputReopen)?;
reader
.seek(SeekFrom::Start(self.fec_offset))
pos_file
.seek(SeekFrom::Start(fec_offset))
.map_err(|e| Error::DataRead("HashTree::fec_data", e))?;
let mut fec_data = reader
let mut fec_data = pos_file
.read_vec_exact(fec_size)
.map_err(|e| Error::DataRead("HashTree::fec_data", e))?;
fec.update(input, &r_with_hash_tree, &mut fec_data, cancel_signal)
fec.update(file, &r_with_hash_tree, &mut fec_data, cancel_signal)
.map_err(Error::FecUpdate)?;
fec_data
} else {
// The FEC covers the hash tree as well.
let fec = Fec::new(self.image_size + tree_size, self.data_block_size, parity)
.map_err(Error::FecInit)?;
fec.generate(input, cancel_signal)
let fec =
Fec::new(fec_offset, self.data_block_size, parity).map_err(Error::FecInit)?;
fec.generate(file, cancel_signal)
.map_err(Error::FecGenerate)?
};
// Already seeked to FEC.
writer
pos_file
.seek(SeekFrom::Start(fec_offset))
.map_err(|e| Error::DataWrite("HashTree::fec_data", e))?;
pos_file
.write_all(&fec_data)
.map_err(|e| Error::DataWrite("HashTree::fec_data", e))?;
self.fec_offset = self.image_size + tree_size;
self.fec_offset = fec_offset;
self.fec_size = fec_data.len() as u64;
}
self.tree_offset = self.image_size;
self.tree_offset = tree_offset;
self.tree_size = tree_size;
self.root_digest = root_digest;
Ok(())
}
/// Verify the root hash, hash tree, and FEC data. `open_input` will be
/// called from multiple threads and must return independently seekable
/// handles to the same file.
pub fn verify(
&self,
input: &(dyn ReadSeekReopen + Sync),
cancel_signal: &AtomicBool,
) -> Result<()> {
/// Verify the root hash, hash tree, and FEC data.
pub fn verify(&self, input: &(dyn ReadAt + Sync), cancel_signal: &AtomicBool) -> Result<()> {
self.check_offsets()?;
let algorithm = ring_algorithm(&self.hash_algorithm, true)?;
let algorithm = digest_algorithm(&self.hash_algorithm)?;
util::check_bounds(self.tree_size, ..=HASH_TREE_MAX_SIZE)
.map_err(|e| Error::IntOutOfBounds("HashTree::tree_size", e))?;
let mut reader = input.reopen_boxed().map_err(Error::InputReopen)?;
let mut reader = UserPosFile::new(input);
reader
.seek(SeekFrom::Start(self.tree_offset))
.map_err(|e| Error::DataRead("HashTree::tree_data", e))?;
@@ -684,9 +667,7 @@ impl HashTreeDescriptor {
Ok(())
}
/// Try to repair errors in the input file using the FEC data. Both
/// `open_input` and `open_output` may be called from multiple threads and
/// must return independently seekable handles to the same file.
/// Try to repair errors in the input file using the FEC data.
///
/// Due to the nature of FEC, when there are too many errors, it's possible
/// for the data to be miscorrected to a "valid" state. [`Self::verify()`]
@@ -694,8 +675,7 @@ impl HashTreeDescriptor {
/// actually valid.
pub fn repair(
&self,
input: &(dyn ReadSeekReopen + Sync),
output: &(dyn WriteSeekReopen + Sync),
file: &(dyn ReadWriteAt + Sync),
cancel_signal: &AtomicBool,
) -> Result<()> {
self.check_offsets()?;
@@ -705,7 +685,7 @@ impl HashTreeDescriptor {
return Err(Error::FecMissing);
}
let mut reader = input.reopen_boxed().map_err(Error::InputReopen)?;
let mut reader = UserPosFile::new(file);
reader
.seek(SeekFrom::Start(self.fec_offset))
.map_err(|e| Error::DataRead("HashTree::fec_data", e))?;
@@ -717,7 +697,7 @@ impl HashTreeDescriptor {
.read_vec_exact(fec_size)
.map_err(|e| Error::DataRead("HashTree::fec_data", e))?;
fec.repair(input, output, &fec_data, cancel_signal)
fec.repair(file, &fec_data, cancel_signal)
.map_err(Error::FecRepair)?;
Ok(())
@@ -860,7 +840,7 @@ impl<W: Write> ToWriter<W> for HashTreeDescriptor {
/// Raw on-disk layout for the AVB hash descriptor after the prefix.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawHashDescriptor {
image_size: big_endian::U64,
hash_algorithm: [u8; 32],
@@ -903,10 +883,9 @@ impl HashDescriptor {
fn calculate(
&self,
reader: impl Read,
for_verify: bool,
cancel_signal: &AtomicBool,
) -> Result<ring::digest::Digest> {
let algorithm = ring_algorithm(&self.hash_algorithm, for_verify)?;
let algorithm = digest_algorithm(&self.hash_algorithm)?;
let mut context = Context::new(algorithm);
context.update(&self.salt);
@@ -924,14 +903,14 @@ impl HashDescriptor {
/// Update the root hash from the input reader's contents.
pub fn update(&mut self, reader: impl Read, cancel_signal: &AtomicBool) -> Result<()> {
let digest = self.calculate(reader, false, cancel_signal)?;
let digest = self.calculate(reader, cancel_signal)?;
self.root_digest = digest.as_ref().to_vec();
Ok(())
}
/// Verify the root hash against the input reader.
pub fn verify(&self, reader: impl Read, cancel_signal: &AtomicBool) -> Result<()> {
let digest = self.calculate(reader, true, cancel_signal)?;
let digest = self.calculate(reader, cancel_signal)?;
if self.root_digest != digest.as_ref() {
return Err(Error::InvalidRootDigest {
@@ -1065,7 +1044,7 @@ impl<W: Write> ToWriter<W> for HashDescriptor {
/// Raw on-disk layout for the AVB kernel command line descriptor after the
/// prefix.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawKernelCmdlineDescriptor {
flags: big_endian::U32,
cmdline_len: big_endian::U32,
@@ -1139,7 +1118,7 @@ impl<W: Write> ToWriter<W> for KernelCmdlineDescriptor {
/// Raw on-disk layout for the AVB chain partition descriptor after the prefix.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawChainPartitionDescriptor {
rollback_index_location: big_endian::U32,
partition_name_len: big_endian::U32,
@@ -1258,7 +1237,7 @@ impl<W: Write> ToWriter<W> for ChainPartitionDescriptor {
/// Raw on-disk layout for the AVB descriptor prefix.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawDescriptor {
tag: big_endian::U64,
num_bytes_following: big_endian::U64,
@@ -1458,7 +1437,7 @@ impl<'a> TryFrom<&'a mut Descriptor> for AppendedDescriptorMut<'a> {
/// Raw on-disk layout for the AVB header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawHeader {
/// Magic value. This should be equal to [`HEADER_MAGIC`].
magic: [u8; 4],
@@ -1658,7 +1637,7 @@ impl Header {
/// Get the first hash or hash tree descriptor if there is only one. This is
/// the case for appended AVB images.
pub fn appended_descriptor(&self) -> Result<AppendedDescriptorRef> {
pub fn appended_descriptor(&self) -> Result<AppendedDescriptorRef<'_>> {
let mut result = None;
for descriptor in &self.descriptors {
@@ -1684,7 +1663,7 @@ impl Header {
/// Get the first hash or hash tree descriptor if there is only one. This is
/// the case for appended AVB images.
pub fn appended_descriptor_mut(&mut self) -> Result<AppendedDescriptorMut> {
pub fn appended_descriptor_mut(&mut self) -> Result<AppendedDescriptorMut<'_>> {
let mut result = None;
for descriptor in &mut self.descriptors {
@@ -1759,16 +1738,20 @@ impl Header {
/// and return the public key. If the header is not signed, then `None` is
/// returned.
pub fn verify(&self) -> Result<Option<RsaPublicKey>> {
// Reconstruct the public key.
let public_key = decode_public_key(&self.public_key)?;
if self.public_key.len() != self.algorithm_type.public_key_len() {
return Err(Error::IncorrectKeySize(
public_key.size(),
self.public_key.len(),
self.algorithm_type,
));
}
if self.algorithm_type == AlgorithmType::None {
return Ok(None);
}
// Reconstruct the public key.
let public_key = decode_public_key(&self.public_key)?;
let mut without_auth_writer = Cursor::new(Vec::new());
self.to_writer_internal(&mut without_auth_writer, true)?;
let without_auth = without_auth_writer.into_inner();
@@ -1927,7 +1910,7 @@ impl<W: Write> ToWriter<W> for Header {
/// Raw on-disk layout for the AVB footer.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawFooter {
/// Magic value. This should be equal to [`FOOTER_MAGIC`].
magic: [u8; 4],
@@ -2015,10 +1998,9 @@ impl<W: Write> ToWriter<W> for Footer {
/// Raw on-disk layout for the AVB binary public key header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawPublicKey {
key_num_bits: big_endian::U32,
#[expect(unused)]
n0inv: big_endian::U32,
}
@@ -2176,10 +2158,10 @@ pub fn write_appended_image(
.and_then(|s| s.checked_add(header_padding))
.ok_or(Error::IntOverflow("Appended::header_end_padded"))?;
if let Some(s) = image_size {
if header_end_padded > s {
return Err(Error::TooSmallForHeader(s));
}
if let Some(s) = image_size
&& header_end_padded > s
{
return Err(Error::TooSmallForHeader(s));
}
writer
+22 -32
View File
@@ -13,7 +13,7 @@ use num_traits::ToPrimitive;
use ring::digest::Context;
use serde::{Deserialize, Serialize};
use thiserror::Error;
use zerocopy::{little_endian, FromBytes, IntoBytes};
use zerocopy::{FromBytes, IntoBytes, little_endian};
use zerocopy_derive::{FromBytes, Immutable, IntoBytes, KnownLayout, Unaligned};
use crate::{
@@ -117,7 +117,7 @@ pub trait BootImageExt {
/// Raw on-disk layout for the v0 image header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawV0 {
/// Magic value. This should be equal to [`BOOT_MAGIC`].
magic: [u8; 8],
@@ -139,7 +139,7 @@ struct RawV0 {
/// Raw on-disk layout for the extra v1 image header fields.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawV1Extra {
recovery_dtbo_size: little_endian::U32,
recovery_dtbo_offset: little_endian::U64,
@@ -148,7 +148,7 @@ struct RawV1Extra {
/// Raw on-disk layout for the extra v2 image header fields.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawV2Extra {
dtb_size: little_endian::U32,
dtb_addr: little_endian::U64,
@@ -269,6 +269,7 @@ impl fmt::Display for BootImageV0Through2 {
impl BootImageExt for BootImageV0Through2 {
fn header_version(&self) -> u32 {
#[allow(clippy::bool_to_int_with_if)]
if self.v2_extra.is_some() {
2
} else if self.v1_extra.is_some() {
@@ -386,14 +387,13 @@ impl<R: Read> FromReader<R> for BootImageV0Through2 {
None
};
if let Some(v1) = &v1_data {
if reader
if let Some(v1) = &v1_data
&& reader
.stream_position()
.map_err(|e| Error::DataRead("Boot::V1::header_size", e))?
!= u64::from(v1.header_size)
{
return Err(Error::InvalidHeaderSize(v1.header_size));
}
{
return Err(Error::InvalidHeaderSize(v1.header_size));
}
padding::read_discard(&mut reader, page_size.into())
@@ -595,7 +595,7 @@ impl<W: Write> ToWriter<W> for BootImageV0Through2 {
/// Raw on-disk layout for the v3 image header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawV3 {
/// Magic value. This should be equal to [`BOOT_MAGIC`].
magic: [u8; 8],
@@ -610,7 +610,7 @@ struct RawV3 {
/// Raw on-disk layout for the extra v4 image header fields.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawV4Extra {
signature_size: little_endian::U32,
}
@@ -668,11 +668,7 @@ impl fmt::Display for BootImageV3Through4 {
impl BootImageExt for BootImageV3Through4 {
fn header_version(&self) -> u32 {
if self.v4_extra.is_some() {
4
} else {
3
}
if self.v4_extra.is_some() { 4 } else { 3 }
}
fn header_size(&self) -> u32 {
@@ -873,14 +869,12 @@ impl BootImageV3Through4 {
padding::write_zeros(&mut writer, PAGE_SIZE.into())
.map_err(|e| Error::DataWrite("Boot::V3::ramdisk_padding", e))?;
if !skip_v4_sig {
if let Some(sig) = v4_signature {
writer
.write_all(&sig)
.map_err(|e| Error::DataWrite("Boot::V4::signature", e))?;
padding::write_zeros(&mut writer, PAGE_SIZE.into())
.map_err(|e| Error::DataWrite("Boot::V4::signature_padding", e))?;
}
if !skip_v4_sig && let Some(sig) = v4_signature {
writer
.write_all(&sig)
.map_err(|e| Error::DataWrite("Boot::V4::signature", e))?;
padding::write_zeros(&mut writer, PAGE_SIZE.into())
.map_err(|e| Error::DataWrite("Boot::V4::signature_padding", e))?;
}
Ok(())
@@ -961,7 +955,7 @@ impl<W: Write> ToWriter<W> for BootImageV3Through4 {
/// Raw on-disk layout for the vendor v3 image header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawVendorV3 {
/// Magic value. This should be equal to [`VENDOR_BOOT_MAGIC`].
magic: [u8; 8],
@@ -980,7 +974,7 @@ struct RawVendorV3 {
/// Raw on-disk layout for the extra vendor v4 image header fields.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawVendorV4Extra {
vendor_ramdisk_table_size: little_endian::U32,
vendor_ramdisk_table_entry_num: little_endian::U32,
@@ -990,7 +984,7 @@ struct RawVendorV4Extra {
/// Raw on-disk layout for the vendor v4 ramdisk table entry.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawVendorV4RamdiskTableEntry {
ramdisk_size: little_endian::U32,
ramdisk_offset: little_endian::U32,
@@ -1093,11 +1087,7 @@ impl fmt::Display for VendorBootImageV3Through4 {
impl BootImageExt for VendorBootImageV3Through4 {
fn header_version(&self) -> u32 {
if self.v4_extra.is_some() {
4
} else {
3
}
if self.v4_extra.is_some() { 4 } else { 3 }
}
fn header_size(&self) -> u32 {
+62 -30
View File
@@ -1,15 +1,15 @@
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::io::{self, Read, Seek, Write};
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;
@@ -28,7 +28,7 @@ pub enum Error {
#[error("Failed to initialize legacy LZ4 encoder")]
Lz4Init(#[source] io::Error),
#[error("Failed to initialize XZ encoder")]
XzInit(#[source] liblzma::stream::Error),
XzInit(#[source] io::Error),
}
type Result<T> = std::result::Result<T, Error>;
@@ -109,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,
@@ -116,9 +117,44 @@ 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> 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,
}
}
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(),
}
}
}
impl<R: Read + Seek> CompressedReader<R> {
@@ -132,37 +168,20 @@ impl<R: Read + Seek> CompressedReader<R> {
} 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)))
Ok(Self::Xz(Box::new(XZReader::new(reader, false))))
} else if raw_if_unknown {
Ok(Self::None(reader))
} else {
Err(Error::UnknownFormat)
}
}
pub fn format(&self) -> CompressedFormat {
match self {
Self::None(_) => CompressedFormat::None,
Self::Gzip(_) => CompressedFormat::Gzip,
Self::Lz4(_) => CompressedFormat::Lz4Legacy,
Self::Xz(_) => CompressedFormat::Xz,
}
}
pub fn into_inner(self) -> R {
match self {
Self::None(r) => r,
Self::Gzip(r) => r.into_inner(),
Self::Lz4(r) => r.into_inner(),
Self::Xz(r) => r.into_inner(),
}
}
}
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,17 +189,23 @@ 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())))
}
@@ -190,8 +215,11 @@ impl<W: Write> CompressedWriter<W> {
}
CompressedFormat::Xz => {
// Some kernels are compiled without support for the default CRC64.
let stream = Stream::new_easy_encoder(6, Check::Crc32).map_err(Error::XzInit)?;
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))
}
}
}
@@ -199,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,
@@ -208,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(),
@@ -219,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),
@@ -228,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(),
+5 -11
View File
@@ -76,7 +76,7 @@ pub struct InvalidHexCharError(RawHexU32, char);
/// ASCII-encoded hex integer value used in cpio header fields.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawHexU32([u8; 8]);
impl fmt::Debug for RawHexU32 {
@@ -89,12 +89,10 @@ impl fmt::Debug for RawHexU32 {
impl From<u32> for RawHexU32 {
fn from(mut value: u32) -> Self {
let mut buf = [b'0'; 8];
let mut index = 7;
while value != 0 {
buf[index] = char::from_digit(value & 0xf, 16).unwrap() as u8;
for c in buf.iter_mut().rev() {
*c = char::from_digit(value & 0xf, 16).unwrap() as u8;
value >>= 4;
index -= 1;
}
Self(buf)
@@ -121,7 +119,7 @@ impl TryFrom<RawHexU32> for u32 {
/// Raw on-disk layout for the cpio header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawHeader {
/// Magic value. This should be equal to [`MAGIC_NEW`] or [`MAGIC_NEW_CRC`].
magic: [u8; 6],
@@ -771,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)
+64 -89
View File
@@ -1,10 +1,10 @@
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
collections::HashSet,
fmt,
io::{self, Read, Seek, SeekFrom, Write},
io::{self, Read, SeekFrom, Write},
mem,
ops::Range,
sync::atomic::AtomicBool,
@@ -16,12 +16,15 @@ use rayon::{
slice::{ParallelSlice, ParallelSliceMut},
};
use thiserror::Error;
use zerocopy::{little_endian, FromBytes, IntoBytes};
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},
stream::{
self, FromReader, ReadAt, ReadSeek, ReadWriteAt, ReadWriteSeek, ToWriter, UserPosFile,
WriteSeek, WriteZerosExt,
},
util::{self, NumBytes, OutOfBoundsError},
};
@@ -68,10 +71,8 @@ pub enum Error {
IntOutOfBounds(&'static str, #[source] OutOfBoundsError),
#[error("{0:?} overflowed integer bounds during calculations")]
IntOverflow(&'static str),
#[error("Failed to reopen input file")]
InputReopen(#[source] io::Error),
#[error("Failed to reopen output file")]
OutputReopen(#[source] io::Error),
#[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}")]
@@ -248,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<()> {
@@ -276,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<()> {
@@ -299,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 {
@@ -309,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)
@@ -317,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);
@@ -330,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(())
@@ -360,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<()> {
@@ -386,7 +382,7 @@ 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,
@@ -414,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> {
@@ -426,7 +421,7 @@ impl Fec {
);
let mut grid = self
.read_round(reader, round)
.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());
@@ -445,7 +440,7 @@ 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))?;
}
@@ -458,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();
@@ -466,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).map_err(Error::InputReopen)?;
.try_for_each(|(round, buf)| -> Result<()> {
stream::check_cancel(cancel_signal).map_err(|e| Error::DataRead("(init)", e))?;
let reader = input.reopen_boxed().map_err(Error::InputReopen)?;
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)
}
@@ -482,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,
@@ -501,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).map_err(Error::InputReopen)?;
.try_for_each(|(round, buf)| -> Result<()> {
stream::check_cancel(cancel_signal).map_err(|e| Error::DataRead("(init)", e))?;
let reader = input.reopen_boxed().map_err(Error::InputReopen)?;
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
@@ -519,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<()> {
@@ -534,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).map_err(Error::InputReopen)?;
.try_for_each(|(round, buf)| -> Result<()> {
stream::check_cancel(cancel_signal).map_err(|e| Error::DataRead("(init)", e))?;
let reader = input.reopen_boxed().map_err(Error::InputReopen)?;
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.
@@ -558,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> {
@@ -576,15 +563,12 @@ impl Fec {
.par_chunks_exact(fec_size / self.rounds as usize)
.enumerate()
.map(|(round, buf)| -> Result<u64> {
stream::check_cancel(cancel_signal).map_err(Error::InputReopen)?;
stream::check_cancel(cancel_signal).map_err(|e| Error::DataRead("(init)", e))?;
let reader = input.reopen_boxed().map_err(Error::InputReopen)?;
let writer = output.reopen_boxed().map_err(Error::OutputReopen)?;
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)
}
@@ -592,7 +576,7 @@ impl Fec {
/// Raw on-disk layout for the FEC image header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawHeader {
/// Magic value. This should be equal to [`FEC_MAGIC`].
magic: little_endian::U32,
@@ -636,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 = input
.reopen_boxed()
.and_then(|mut f| f.seek(SeekFrom::End(0)))
.map_err(Error::InputReopen)?;
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)?;
@@ -657,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<()> {
@@ -667,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)
}
@@ -687,18 +664,13 @@ 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
@@ -827,13 +799,13 @@ impl<W: Write> ToWriter<W> for FecImage {
mod tests {
use std::{
io::{Cursor, Seek},
sync::{atomic::AtomicBool, Arc},
sync::{Arc, atomic::AtomicBool},
};
use assert_matches::assert_matches;
use rand::RngCore;
use crate::stream::SharedCursor;
use crate::stream::MutexFile;
use super::*;
@@ -862,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();
@@ -881,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)
};
@@ -901,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)
@@ -909,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)
@@ -948,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();
+37 -49
View File
@@ -3,7 +3,7 @@
use std::{
fmt,
io::{self, Cursor, Read, SeekFrom, Write},
io::{self, Cursor, Read, Seek, SeekFrom, Write},
ops::Range,
str,
sync::atomic::AtomicBool,
@@ -16,7 +16,7 @@ use rayon::{
};
use ring::digest::{Algorithm, Context};
use thiserror::Error;
use zerocopy::{little_endian, FromBytes, IntoBytes};
use zerocopy::{FromBytes, IntoBytes, little_endian};
use zerocopy_derive::{FromBytes, Immutable, IntoBytes, KnownLayout, Unaligned};
use crate::{
@@ -24,7 +24,7 @@ use crate::{
avb,
padding::{self, ZeroPadding},
},
stream::{self, FromReader, ReadFixedSizeExt, ReadSeekReopen, ToWriter},
stream::{self, FromReader, ReadAt, ReadFixedSizeExt, ToWriter, UserPosFile},
util::{self, NumBytes, OutOfBoundsError},
};
@@ -50,8 +50,8 @@ pub enum Error {
IntOutOfBounds(&'static str, #[source] OutOfBoundsError),
#[error("{0:?} overflowed integer bounds during calculations")]
IntOverflow(&'static str),
#[error("Failed to reopen input file")]
InputReopen(#[source] io::Error),
#[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}")]
@@ -189,7 +189,7 @@ 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,
@@ -207,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],
@@ -239,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
@@ -261,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>],
@@ -270,7 +264,7 @@ impl HashTree {
) -> Result<Vec<u8>> {
// Small files are hashed directly.
if image_size <= u64::from(self.block_size) {
let mut reader = input.reopen_boxed().map_err(Error::InputReopen)?;
let mut reader = UserPosFile::new(input);
let buf = reader
.read_vec_exact(image_size as usize)
.map_err(Error::InputDigest)?;
@@ -334,7 +328,7 @@ 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>)> {
@@ -358,7 +352,7 @@ 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],
@@ -387,7 +381,7 @@ 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],
@@ -431,7 +425,7 @@ impl HashTree {
/// Raw on-disk layout for our custom hash tree image header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawHeader {
/// Magic value. This should be equal to [`HashTreeImage::MAGIC`].
magic: [u8; 16],
@@ -492,25 +486,22 @@ impl HashTreeImage {
const MAGIC: &'static [u8; 16] = b"avbroot!hashtree";
const VERSION: u16 = 1;
fn ring_algorithm(name: &str) -> Result<&'static Algorithm> {
avb::ring_algorithm(name, false)
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 = input
.reopen_boxed()
.and_then(|mut f| f.seek(SeekFrom::End(0)))
.map_err(Error::InputReopen)?;
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 {
@@ -526,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,
@@ -545,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,
@@ -656,7 +643,7 @@ mod tests {
use assert_matches::assert_matches;
use crate::stream::SharedCursor;
use crate::stream::MutexFile;
use super::*;
@@ -697,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();
@@ -714,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();
@@ -738,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)
@@ -775,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)
+61 -63
View File
@@ -1,8 +1,7 @@
// SPDX-FileCopyrightText: 2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2024-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
cmp::Ordering,
fmt,
io::{self, Read, Seek, Write},
mem,
@@ -14,7 +13,7 @@ use bitflags::bitflags;
use bstr::ByteSlice;
use serde::{Deserialize, Serialize};
use thiserror::Error;
use zerocopy::{byteorder::little_endian, FromBytes, FromZeros, Immutable, IntoBytes};
use zerocopy::{FromBytes, FromZeros, Immutable, IntoBytes, byteorder::little_endian};
use zerocopy_derive::{FromBytes, Immutable, IntoBytes, KnownLayout, Unaligned};
use crate::{
@@ -22,7 +21,7 @@ use crate::{
stream::{
CountingReader, FromReader, ReadDiscardExt, ReadFixedSizeExt, ToWriter, WriteZerosExt,
},
util::{self, is_zero, DebugString},
util::{self, DebugString, is_zero},
};
/// Magic value for [`RawGeometry::magic`].
@@ -152,10 +151,8 @@ pub enum Error {
ExtentTypeZeroNotEmpty { index: usize },
#[error("Extent #{index}: Invalid type: {extent_type}")]
ExtentInvalidType { index: usize, extent_type: u32 },
#[error("Extent #{index}: Overlaps previous extent")]
ExtentOverlapsPrevious { index: usize },
#[error("Extent #{index}: Earlier block device index than previous extent")]
ExtentDeviceNotConsecutive { index: usize },
#[error("Extent #{index}: Overlaps another extent: #{other}")]
ExtentOverlapsAnother { index: usize, other: usize },
#[error("Extent #{index}: Block device index too large")]
ExtentDeviceIndexTooLarge { index: usize },
// Partition group errors.
@@ -253,7 +250,7 @@ impl PartitionAttributes {
/// Raw on-disk layout for the metadata geometry.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawGeometry {
/// Magic value. This should be equal to [`GEOMETRY_MAGIC`].
magic: little_endian::U32,
@@ -335,7 +332,7 @@ impl RawGeometry {
/// Raw on-disk layout for a table descriptor within a [`RawHeader`].
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawTableDescriptor {
/// Offset relative to the end of the [`RawHeader`].
offset: little_endian::U32,
@@ -394,7 +391,7 @@ impl RawTableDescriptor {
/// Raw on-disk layout for the metadata header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawHeader {
/// Magic value. This should be equal to [`HEADER_MAGIC`].
magic: little_endian::U32,
@@ -572,7 +569,7 @@ impl RawHeader {
/// A potentially invalid raw partition name string.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct PartitionName([u8; 36]);
impl fmt::Debug for PartitionName {
@@ -598,17 +595,15 @@ impl PartitionName {
fn validate(&self) -> Result<()> {
let (prefix, suffix) = self.split();
let mut has_alnum = false;
for b in prefix {
match b {
b'a'..=b'z' | b'A'..=b'Z' | b'0'..=b'9' => has_alnum = true,
b'_' => {}
_ => return Err(Error::PartitionNameInvalid(DebugString::new(self))),
}
}
// AOSP liblp's metadata_format.h says "Characters may only be
// alphanumeric or _", but AOSP creates partitions named like
// "system_b-cow".
let prefix_valid = prefix
.iter()
.all(|b| matches!(*b, b'a'..=b'z' | b'A'..=b'Z' | b'0'..=b'9' | b'_' | b'-'));
if has_alnum && is_zero(suffix) {
if prefix_valid && is_zero(suffix) {
Ok(())
} else {
Err(Error::PartitionNameInvalid(DebugString::new(self)))
@@ -644,7 +639,7 @@ impl FromStr for PartitionName {
/// Raw on-disk layout for an entry in the logical partitions table.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawPartition {
/// Partition name in ASCII. This must be unique across all partitions.
name: PartitionName,
@@ -706,7 +701,7 @@ impl RawPartition {
.first_extent_index
.get()
.checked_add(self.num_extents.get())
.map_or(true, |n| n as usize > extents.len())
.is_none_or(|n| n as usize > extents.len())
{
return Err(Error::PartitionExtentIndicesTooLarge {
name: DebugString::new(self.name),
@@ -735,7 +730,7 @@ impl RawPartition {
/// Raw on-disk layout for an entry in the extent table.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawExtent {
/// Number of [`SECTOR_SIZE`]-byte sectors in this extent.
num_sectors: little_endian::U64,
@@ -817,7 +812,7 @@ impl RawExtent {
return Err(Error::ExtentInvalidType {
index,
extent_type: n,
})
});
}
}
@@ -827,7 +822,7 @@ impl RawExtent {
/// Raw on-disk layout for an entry in the partition groups table.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawPartitionGroup {
/// Partition group name in ASCII. This must be unique across all groups.
name: PartitionName,
@@ -894,7 +889,7 @@ impl RawPartitionGroup {
/// Raw on-disk layout for an entry in the block devices table.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawBlockDevice {
/// The first [`SECTOR_SIZE`]-byte sector where actual data for the logical
/// partitions can be allocated.
@@ -1010,23 +1005,29 @@ impl RawMetadataSlot {
extent.validate(i, &self.block_devices)?;
}
// Ensure that all extents are in increasing order and not overlapping.
let mut iter = self
// Ensure that all extents are not overlapping. We have to sort here
// because the extents may not be in order when loading the super
// partition on an actual device. Also, AOSP liblp's `metadata_format.h`
// says "Gaps between extents are not allowed", but AOSP frequently
// creates this situation after a virtual A/B CoW merge.
let mut sorted_extents = self
.extents
.iter()
.filter(|e| e.target_type.get() == RawExtent::TARGET_TYPE_LINEAR)
.enumerate();
while let (Some((_, a)), Some((i, b))) = (iter.next(), iter.next()) {
match a.target_source.get().cmp(&b.target_source.get()) {
Ordering::Equal => {
if a.target_data.get() + a.num_sectors.get() > b.target_data.get() {
return Err(Error::ExtentOverlapsPrevious { index: i });
}
}
Ordering::Greater => {
return Err(Error::ExtentDeviceNotConsecutive { index: i });
}
Ordering::Less => {}
.enumerate()
.filter(|(_, e)| e.target_type.get() == RawExtent::TARGET_TYPE_LINEAR)
.collect::<Vec<_>>();
sorted_extents.sort_by_key(|(_, e)| (e.target_source, e.target_data));
for window in sorted_extents.windows(2) {
let ((a_i, a), (b_i, b)) = (window[0], window[1]);
if a.target_source == b.target_source
&& a.target_data.get() + a.num_sectors.get() > b.target_data.get()
{
return Err(Error::ExtentOverlapsAnother {
index: b_i,
other: a_i,
});
}
}
@@ -1060,14 +1061,19 @@ impl RawMetadata {
.read_exact(&mut buf)
.map_err(|e| Error::DataRead("geometry", e))?;
let image_type = if util::is_zero(&buf) {
ImageType::Normal
} else {
ImageType::Empty
};
// For non-empty images, AOSP says the first block is supposed to be
// filled with zeros, but Samsung puts their own SignerVer02 structure
// in there, so we can't rely on that.
let mut geometry = RawGeometry::ref_from_prefix(&buf).unwrap().0;
let geometry = match image_type {
ImageType::Normal => {
let image_type = match geometry.validate() {
Ok(()) => {
// This is an empty image for use with fastboot. These have no
// extra padding at the beginning of the file nor backup copies
// of the geometry and metadata structs.
ImageType::Empty
}
Err(Error::GeometryInvalidMagic(_)) => {
// This is an normal non-empty image, which has extra padding at
// the beginning to avoid having the geometry struct interpreted
// as a boot sector.
@@ -1077,7 +1083,7 @@ impl RawMetadata {
.read_exact(&mut buf)
.map_err(|e| Error::DataRead("geometry_primary", e))?;
let mut geometry = RawGeometry::ref_from_prefix(&buf).unwrap().0;
geometry = RawGeometry::ref_from_prefix(&buf).unwrap().0;
if geometry.validate().is_ok() {
// Skip the backup copy.
@@ -1094,17 +1100,9 @@ impl RawMetadata {
geometry.validate()?;
}
geometry
}
ImageType::Empty => {
// This is an empty image for use with fastboot. These have no
// extra padding at the beginning of the file nor backup copies
// of the geometry and metadata structs.
let geometry = RawGeometry::ref_from_prefix(&buf).unwrap().0;
geometry.validate()?;
geometry
ImageType::Normal
}
Err(e) => return Err(e),
};
Ok((image_type, geometry.to_owned()))
@@ -1642,7 +1640,7 @@ impl TryFrom<&RawMetadataSlot> for MetadataSlot {
type Error = Error;
fn try_from(raw_slot: &RawMetadataSlot) -> Result<Self> {
let mut slot = MetadataSlot {
let mut slot = Self {
major_version: raw_slot.header.major_version.get(),
minor_version: raw_slot.header.minor_version.get(),
groups: Vec::with_capacity(raw_slot.groups.len()),
@@ -1722,7 +1720,7 @@ impl TryFrom<&MetadataSlot> for RawMetadataSlot {
fn try_from(slot: &MetadataSlot) -> Result<Self> {
let header_size = RawHeader::size_for_version(slot.major_version, slot.minor_version);
let mut raw_slot = RawMetadataSlot {
let mut raw_slot = Self {
header: RawHeader {
magic: HEADER_MAGIC.into(),
major_version: slot.major_version.into(),
@@ -1939,7 +1937,7 @@ impl TryFrom<&Metadata> for RawMetadata {
// We only do the bare minimum calculations needed here to fill out the
// raw fields. There is no semantic validation.
let mut raw_metadata = RawMetadata {
let mut raw_metadata = Self {
image_type: metadata.image_type,
geometry: RawGeometry {
magic: GEOMETRY_MAGIC.into(),
+2 -1
View File
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
pub mod avb;
@@ -13,3 +13,4 @@ pub mod padding;
pub mod payload;
pub mod sparse;
pub mod verityrs;
pub mod zip;
+421 -239
View File
@@ -2,29 +2,36 @@
// SPDX-License-Identifier: GPL-3.0-only
use std::{
borrow::Cow,
cmp::Ordering,
collections::BTreeMap,
fmt,
fmt::{self, Write as _},
io::{self, Cursor, Read, Seek, SeekFrom, Write},
iter,
path::Path,
str::FromStr,
sync::atomic::AtomicBool,
};
use clap::ValueEnum;
use cms::signed_data::SignedData;
use const_oid::{db::rfc5912, ObjectIdentifier};
use const_oid::{ObjectIdentifier, db::rfc5912};
use memchr::memmem;
use prost::Message;
use ring::digest::Context;
use rawzip::{CompressionMethod, RECOMMENDED_BUFFER_SIZE, ZipArchive, ZipArchiveWriter};
use ring::digest::{Algorithm, Context};
use thiserror::Error;
use x509_cert::{der::Encode, Certificate};
use zip::{result::ZipError, write::FileOptions, CompressionMethod, ZipArchive, ZipWriter};
use x509_cert::{Certificate, der::Encode};
use crate::{
crypto::{self, RsaPublicKeyExt, RsaSigningKey, SignatureAlgorithm},
format::payload::{self, PayloadHeader},
protobuf::build::tools::releasetools::{ota_metadata::OtaType, OtaMetadata},
format::{
payload::{self, PayloadHeader},
zip::{self, ZipEntriesSafeExt, ZipFileHeaderRecordExt},
},
protobuf::build::tools::releasetools::{OtaMetadata, ota_metadata::OtaType},
stream::{self, FromReader, HashingReader, HashingWriter, ReadFixedSizeExt},
util,
};
pub const PATH_METADATA: &str = "META-INF/com/android/metadata";
@@ -70,8 +77,12 @@ pub enum Error {
InvalidLegacyMetadataLine(String),
#[error("Unsupported legacy metadata field: {key:?} = {value:?}")]
UnsupportedLegacyMetadataField { key: String, value: String },
#[error("Expected entry offsets {expected:?}, but have {actual:?}")]
MismatchedPropertyFiles { expected: String, actual: String },
#[error("Mismatched {key:?} entry offsets: zip only: {zip_only:?}, prop only: {prop_only:?}")]
MismatchedPropertyFiles {
key: String,
zip_only: String,
prop_only: String,
},
#[error("Property files {value:?} exceed {reserved} byte reserved space")]
InsufficientReservedSpace { value: String, reserved: usize },
#[error("Invalid property file entry: {0:?}")]
@@ -81,17 +92,21 @@ pub enum Error {
#[error("Failed to decode OTA metadata protobuf message")]
MetadataDecode(#[source] prost::DecodeError),
#[error("Failed to open zip file")]
ZipOpen(#[source] ZipError),
ZipOpen(#[source] rawzip::Error),
#[error("Failed to list zip entries")]
ZipEntryList(#[source] rawzip::Error),
#[error("Missing zip entry: {0:?}")]
ZipEntryMissing(Cow<'static, str>),
#[error("Failed to open zip entry: {0:?}")]
ZipEntryOpen(&'static str, #[source] ZipError),
ZipEntryOpen(Cow<'static, str>, #[source] rawzip::Error),
#[error("Failed to start new zip entry: {0:?}")]
ZipEntryStart(&'static str, #[source] ZipError),
ZipEntryStart(Cow<'static, str>, #[source] rawzip::Error),
#[error("Failed to read zip entry: {0:?}")]
ZipEntryRead(&'static str, #[source] io::Error),
ZipEntryRead(Cow<'static, str>, #[source] io::Error),
#[error("Failed to write zip entry: {0:?}")]
ZipEntryWrite(&'static str, #[source] io::Error),
#[error("Failed to open zip entry #{0}")]
ZipIndexOpen(usize, #[source] ZipError),
ZipEntryWrite(Cow<'static, str>, #[source] io::Error),
#[error("Failed to finalize zip entry: {0:?}")]
ZipEntryFinish(Cow<'static, str>, #[source] rawzip::Error),
#[error("Failed to load OTA certificate")]
OtaCertLoad(#[source] crypto::Error),
#[error("Failed to extract public key from OTA certificate")]
@@ -110,6 +125,8 @@ pub enum Error {
DataRead(&'static str, #[source] io::Error),
#[error("Failed to write OTA data: {0}")]
DataWrite(&'static str, #[source] io::Error),
#[error("Failed to convert to non-streaming zip")]
MakeNonStreaming(#[source] rawzip::Error),
}
type Result<T> = std::result::Result<T, Error>;
@@ -280,16 +297,48 @@ fn serialize_metadata(metadata: &OtaMetadata) -> (String, Vec<u8>) {
#[derive(Clone, Debug)]
pub struct ZipEntry {
pub name: String,
pub path: String,
pub offset: u64,
pub size: u64,
}
/// Parse OTA property files string.
pub fn parse_property_files(data: &str) -> Result<Vec<ZipEntry>> {
let mut result = vec![];
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct PropEntry {
name: String,
pub offset: u64,
pub size: u64,
}
for entry in data.trim_end().split(',') {
impl PropEntry {
pub fn new(path: &str, offset: u64, size: u64) -> Self {
Self {
name: property_file_name(path).to_owned(),
offset,
size,
}
}
pub fn name(&self) -> &str {
&self.name
}
}
impl From<&ZipEntry> for PropEntry {
fn from(entry: &ZipEntry) -> Self {
Self::new(&entry.path, entry.offset, entry.size)
}
}
impl fmt::Display for PropEntry {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}:{}:{}", self.name, self.offset, self.size)
}
}
impl FromStr for PropEntry {
type Err = Error;
fn from_str(entry: &str) -> Result<Self> {
let mut pieces = entry.split(':');
let name = pieces
@@ -309,38 +358,63 @@ pub fn parse_property_files(data: &str) -> Result<Vec<ZipEntry>> {
return Err(Error::InvalidPropertyFileEntry(entry.to_owned()));
}
result.push(ZipEntry { name, offset, size });
Ok(Self { name, offset, size })
}
}
/// Parse OTA property files string.
pub fn parse_property_files(data: &str) -> Result<Vec<PropEntry>> {
let mut result = vec![];
for entry in data.trim_end().split(',') {
result.push(entry.parse()?);
}
Ok(result)
}
/// Get the filename for use in property files entries.
fn property_file_name(path: &str) -> &str {
path.rsplit_once('/').map_or(path, |p| p.1)
}
/// Compute the property files entries listing the offsets and sizes to every
/// zip entry.
fn compute_property_files(
pf_name: &str,
entries: &[ZipEntry],
entries: &[PropEntry],
max_length: Option<usize>,
want_pb: bool,
) -> Result<String> {
let compute = |path: &'static str| -> Result<String> {
// AOSP's ota_utils.py reserves 15 bytes for the `<offset>:<size>`
// placeholder. Since the size of `metadata.pb` is almost always 4 digits,
// this prevents the offset from exceeding 10 digits. In the wild, there are
// OTA files larger than 10 GB. With ota_utils.py, this limit is never
// reached because it puts the OTA metadata files at the beginning of the
// zip. However, avbroot needs to put them at the end due to streaming
// writes, so we reserve an additional byte to allow offsets <100 GB.
const RESERVATION_SIZE: usize = 16;
let mut buf = String::new();
let mut append = |path: &'static str| -> Result<()> {
let name = property_file_name(path);
let entry = entries
.iter()
.find(|e| e.name == path)
.find(|e| e.name == name)
.ok_or(Error::MissingZipEntry(path))?;
let name = path.rsplit_once('/').map_or(path, |p| p.1);
Ok(format!("{name}:{}:{}", entry.offset, entry.size))
let _ = write!(&mut buf, "{entry},");
Ok(())
};
let mut tokens = vec![];
if pf_name == PF_NAME {
tokens.push(compute(NAME_PAYLOAD_METADATA)?);
append(NAME_PAYLOAD_METADATA)?;
}
for path in [PATH_PAYLOAD, PATH_PROPERTIES] {
tokens.push(compute(path)?);
append(path)?;
}
for path in [
@@ -349,44 +423,51 @@ fn compute_property_files(
"care_map.txt",
"compatibility.zip",
] {
if let Ok(token) = compute(path) {
tokens.push(token);
}
// These are optional.
let _ = append(path);
}
if max_length.is_none() {
tokens.push(format!("metadata:{}", " ".repeat(15)));
buf.push_str(property_file_name(PATH_METADATA));
buf.push(':');
buf.extend(iter::repeat_n(' ', RESERVATION_SIZE));
buf.push(',');
if want_pb {
tokens.push(format!("metadata.pb:{}", " ".repeat(15)));
buf.push_str(property_file_name(PATH_METADATA_PB));
buf.push(':');
buf.extend(iter::repeat_n(' ', RESERVATION_SIZE));
buf.push(',');
}
} else {
tokens.push(compute(PATH_METADATA)?);
append(PATH_METADATA)?;
if want_pb {
tokens.push(compute(PATH_METADATA_PB)?);
append(PATH_METADATA_PB)?;
}
}
let mut joined = tokens.join(",");
// Strip final trailing comma.
buf.pop();
if let Some(l) = max_length {
if joined.len() > l {
if buf.len() > l {
return Err(Error::InsufficientReservedSpace {
value: joined,
value: buf,
reserved: l,
});
}
let remain = l - joined.len();
joined.extend(iter::repeat(' ').take(remain));
let remain = l - buf.len();
buf.extend(iter::repeat_n(' ', remain));
}
Ok(joined)
Ok(buf)
}
// Add fake payload_metadata.bin entry, covering the header + header signature
// regions of the payload.
fn add_payload_metadata_entry(
entries: &mut Vec<ZipEntry>,
entries: &mut Vec<PropEntry>,
payload_metadata_size: u64,
) -> Result<()> {
let payload_offset = entries
@@ -394,11 +475,11 @@ fn add_payload_metadata_entry(
.find(|e| e.name == PATH_PAYLOAD)
.ok_or(Error::MissingZipEntry(PATH_PAYLOAD))?
.offset;
entries.push(ZipEntry {
name: NAME_PAYLOAD_METADATA.to_owned(),
offset: payload_offset,
size: payload_metadata_size,
});
entries.push(PropEntry::new(
NAME_PAYLOAD_METADATA,
payload_offset,
payload_metadata_size,
));
Ok(())
}
@@ -426,17 +507,39 @@ impl fmt::Display for ZipMode {
/// directory would start.
pub fn add_metadata(
zip_entries: &[ZipEntry],
zip_writer: &mut ZipWriter<impl Write>,
zip_writer: &mut ZipArchiveWriter<impl Write>,
next_offset: u64,
metadata: &OtaMetadata,
payload_metadata_size: u64,
zip_mode: ZipMode,
) -> Result<OtaMetadata> {
let mut metadata = metadata.clone();
let options = FileOptions::default().compression_method(CompressionMethod::Stored);
fn write_entry(
archive: &mut ZipArchiveWriter<impl Write>,
path: &'static str,
data: &[u8],
) -> Result<(u64, u64)> {
let (entry_writer, data_config) = archive
.new_file(path)
.start()
.map_err(|e| Error::ZipEntryStart(path.into(), e))?;
let data_offset = entry_writer.stream_offset();
let mut data_writer = data_config.wrap(entry_writer);
let mut zip_entries = zip_entries.to_owned();
add_payload_metadata_entry(&mut zip_entries, payload_metadata_size)?;
data_writer
.write_all(data)
.map_err(|e| Error::ZipEntryWrite(path.into(), e))?;
let data_size = data_writer
.finish()
.and_then(|(w, d)| w.finish(d))
.map_err(|e| Error::ZipEntryFinish(path.into(), e))?;
Ok((data_offset, data_size))
}
let mut metadata = metadata.clone();
let mut prop_entries = zip_entries.iter().map(PropEntry::from).collect();
add_payload_metadata_entry(&mut prop_entries, payload_metadata_size)?;
// Compute initial property files with reserved space as placeholders to
// store the self-referential metadata entries later.
@@ -444,7 +547,7 @@ pub fn add_metadata(
for pf in [PF_NAME, PF_STREAMING_NAME] {
metadata.property_files.insert(
pf.to_owned(),
compute_property_files(pf, &zip_entries, None, true)?,
compute_property_files(pf, &prop_entries, None, true)?,
);
}
@@ -452,73 +555,41 @@ pub fn add_metadata(
let (temp_legacy_offset, temp_modern_offset) = {
let (legacy_raw, modern_raw) = serialize_metadata(&metadata);
let raw_writer = Cursor::new(Vec::new());
let mut writer = match zip_mode {
ZipMode::Streaming => ZipWriter::new_streaming(raw_writer),
ZipMode::Seekable => ZipWriter::new(raw_writer),
};
// Note that we don't need to worry about the offsets changing based on
// the zip writing mode (streaming vs. seekable). Currently, we always
// include data descriptors and do post-processing to copy the fields
// into the local header without shifting the data.
let mut writer = ZipArchiveWriter::new(raw_writer);
writer
.start_file_with_extra_data(PATH_METADATA, options)
.map_err(|e| Error::ZipEntryStart(PATH_METADATA, e))?;
let legacy_offset = writer
.end_extra_data()
.map_err(|e| Error::ZipEntryStart(PATH_METADATA, e))?;
writer
.write_all(legacy_raw.as_bytes())
.map_err(|e| Error::ZipEntryWrite(PATH_METADATA, e))?;
let (legacy_offset, legacy_size) =
write_entry(&mut writer, PATH_METADATA, legacy_raw.as_bytes())?;
let (modern_offset, modern_size) = write_entry(&mut writer, PATH_METADATA_PB, &modern_raw)?;
writer
.start_file_with_extra_data(PATH_METADATA_PB, options)
.map_err(|e| Error::ZipEntryStart(PATH_METADATA_PB, e))?;
let modern_offset = writer
.end_extra_data()
.map_err(|e| Error::ZipEntryStart(PATH_METADATA_PB, e))?;
writer
.write_all(&modern_raw)
.map_err(|e| Error::ZipEntryWrite(PATH_METADATA_PB, e))?;
zip_entries.push(ZipEntry {
name: PATH_METADATA.to_owned(),
offset: next_offset + legacy_offset,
size: legacy_raw.len() as u64,
});
zip_entries.push(ZipEntry {
name: PATH_METADATA_PB.to_owned(),
offset: next_offset + modern_offset,
size: modern_raw.len() as u64,
});
prop_entries.push(PropEntry::new(
PATH_METADATA,
next_offset + legacy_offset,
legacy_size,
));
prop_entries.push(PropEntry::new(
PATH_METADATA_PB,
next_offset + modern_offset,
modern_size,
));
(next_offset + legacy_offset, next_offset + modern_offset)
};
// Compute the final property files using the offsets of the fake entries.
for (key, value) in &mut metadata.property_files {
*value = compute_property_files(key, &zip_entries, Some(value.len()), true)?;
*value = compute_property_files(key, &prop_entries, Some(value.len()), true)?;
}
// Add the final metadata files to the real zip.
{
let (legacy_raw, modern_raw) = serialize_metadata(&metadata);
zip_writer
.start_file_with_extra_data(PATH_METADATA, options)
.map_err(|e| Error::ZipEntryStart(PATH_METADATA, e))?;
let legacy_offset = zip_writer
.end_extra_data()
.map_err(|e| Error::ZipEntryStart(PATH_METADATA, e))?;
zip_writer
.write_all(legacy_raw.as_bytes())
.map_err(|e| Error::ZipEntryWrite(PATH_METADATA, e))?;
zip_writer
.start_file_with_extra_data(PATH_METADATA_PB, options)
.map_err(|e| Error::ZipEntryStart(PATH_METADATA_PB, e))?;
let modern_offset = zip_writer
.end_extra_data()
.map_err(|e| Error::ZipEntryStart(PATH_METADATA_PB, e))?;
zip_writer
.write_all(&modern_raw)
.map_err(|e| Error::ZipEntryWrite(PATH_METADATA_PB, e))?;
let (legacy_offset, _) = write_entry(zip_writer, PATH_METADATA, legacy_raw.as_bytes())?;
let (modern_offset, _) = write_entry(zip_writer, PATH_METADATA_PB, &modern_raw)?;
assert_eq!(legacy_offset, temp_legacy_offset);
assert_eq!(modern_offset, temp_modern_offset);
@@ -533,31 +604,81 @@ pub fn verify_metadata(
metadata: &OtaMetadata,
payload_metadata_size: u64,
) -> Result<()> {
let mut zip_reader = ZipArchive::new(reader).map_err(Error::ZipOpen)?;
let mut buffer = vec![0u8; RECOMMENDED_BUFFER_SIZE];
let archive = ZipArchive::from_seekable(reader, &mut buffer).map_err(Error::ZipOpen)?;
let mut zip_entries = vec![];
for i in 0..zip_reader.len() {
let entry = zip_reader
.by_index(i)
.map_err(|e| Error::ZipIndexOpen(i, e))?;
zip_entries.push(ZipEntry {
name: entry.name().to_owned(),
offset: entry.data_start(),
size: entry.size(),
});
let mut entries = archive.entries_safe(&mut buffer);
while let Some((cd_entry, entry)) = entries.next_entry().map_err(Error::ZipEntryList)? {
if cd_entry.compression_method() != CompressionMethod::Store {
continue;
}
let Ok(path) = cd_entry.file_path_utf8() else {
continue;
};
let range = entry.compressed_data_range();
zip_entries.push(PropEntry::new(path, range.0, range.1 - range.0));
}
add_payload_metadata_entry(&mut zip_entries, payload_metadata_size)?;
let metadata_pb = zip_entries.iter().find(|e| e.name == PATH_METADATA_PB);
zip_entries.sort_by(|a, b| a.name.cmp(&b.name));
for (key, value) in &metadata.property_files {
let new_value =
compute_property_files(key, &zip_entries, Some(value.len()), metadata_pb.is_some())?;
if *value != new_value {
let mut prop_entries = parse_property_files(value)?;
prop_entries.sort_by(|a, b| a.name.cmp(&b.name));
// Check that this is a subset of the actual entries.
let mut zip_iter = zip_entries.iter().peekable();
let mut prop_iter = prop_entries.iter().peekable();
let mut zip_only = vec![];
let mut prop_only = vec![];
loop {
match (zip_iter.peek(), prop_iter.peek()) {
(Some(&zip), Some(&prop)) => match zip.name.cmp(&prop.name) {
Ordering::Less => {
// Exists in zip, but not in property files.
zip_iter.next();
}
Ordering::Equal => {
// If the zip had multiple files with the same filename,
// but in different directories, this will fail.
if zip != prop {
zip_only.push(zip);
prop_only.push(prop);
}
zip_iter.next();
prop_iter.next();
}
Ordering::Greater => {
// Exists in property files, but not in zip.
prop_only.push(prop);
prop_iter.next();
}
},
(Some(_), None) => {
// Exists in zip, but not in property files.
zip_iter.next();
}
(None, Some(prop)) => {
// Exists in property files, but not in zip.
prop_only.push(prop);
prop_iter.next();
}
(None, None) => break,
}
}
if !zip_only.is_empty() || !prop_only.is_empty() {
return Err(Error::MismatchedPropertyFiles {
expected: value.clone(),
actual: new_value,
key: key.clone(),
zip_only: util::join(zip_only.into_iter().map(|e| e.to_string()), ","),
prop_only: util::join(prop_only.into_iter().map(|e| e.to_string()), ","),
});
}
}
@@ -566,14 +687,14 @@ pub fn verify_metadata(
}
#[derive(Clone, Debug)]
pub struct OtaSignature {
struct RawOtaSignature {
/// Decoded CMS structure.
pub signed_data: SignedData,
signed_data: SignedData,
/// Length of the file (from the beginning) that's covered by the signature.
pub hashed_size: u64,
hashed_size: u64,
}
impl OtaSignature {
impl RawOtaSignature {
pub fn embedded_cert(&self) -> Result<&Certificate> {
let mut iter = crypto::iter_cms_certs(&self.signed_data);
@@ -589,15 +710,113 @@ impl OtaSignature {
}
}
#[derive(Clone, Debug)]
pub struct OtaSignature {
pub cert: Certificate,
pub digest_algo: &'static Algorithm,
pub sig_algo: SignatureAlgorithm,
pub sig: Vec<u8>,
pub data_size: u64,
}
impl TryFrom<RawOtaSignature> for OtaSignature {
type Error = Error;
fn try_from(raw_ota_sig: RawOtaSignature) -> Result<Self> {
let cert = raw_ota_sig.embedded_cert()?;
// Make sure this is a signature scheme we can handle. There's currently
// no Rust library to verify arbitrary CMS signatures for large files
// without fully reading them into memory.
let signers_len = raw_ota_sig.signed_data.signer_infos.0.len();
if signers_len != 1 {
return Err(Error::NotOneCmsSignerInfo(signers_len));
}
let signer = raw_ota_sig.signed_data.signer_infos.0.get(0).unwrap();
if signer.digest_alg.oid != rfc5912::ID_SHA_256
&& signer.digest_alg.oid != rfc5912::ID_SHA_1
{
return Err(Error::UnsupportedDigestAlgorithm(signer.digest_alg.oid));
} else if signer.signature_algorithm.oid != rfc5912::RSA_ENCRYPTION
&& signer.signature_algorithm.oid != rfc5912::SHA_256_WITH_RSA_ENCRYPTION
{
return Err(Error::UnsupportedSignatureAlgorithm(
signer.signature_algorithm.oid,
));
}
// We support SHA1 for verification only.
let (digest_algo, sig_algo) = if signer.digest_alg.oid == rfc5912::ID_SHA_256 {
(&ring::digest::SHA256, SignatureAlgorithm::Sha256WithRsa)
} else {
(
&ring::digest::SHA1_FOR_LEGACY_USE_ONLY,
SignatureAlgorithm::Sha1WithRsa,
)
};
Ok(Self {
cert: cert.clone(),
digest_algo,
sig_algo,
sig: signer.signature.as_bytes().to_vec(),
data_size: raw_ota_sig.hashed_size,
})
}
}
impl OtaSignature {
/// Verify an OTA zip against its embedded certificate. This function makes
/// no assertion about whether the certificate is actually trusted.
///
/// CMS signed attributes are intentionally not supported because AOSP
/// recovery does not support them either. It expects the CMS [`SignedData`]
/// structure to be used for nothing more than a raw signature transport
/// mechanism.
pub fn verify_ota(
&self,
mut reader: impl Read + Seek,
cancel_signal: &AtomicBool,
) -> Result<()> {
let public_key = crypto::get_public_key(&self.cert).map_err(Error::OtaCertExtractPubKey)?;
// Manually hash the parts of the file covered by the signature.
reader
.seek(SeekFrom::Start(0))
.map_err(|e| Error::DataRead("raw_data", e))?;
let mut hashing_reader = HashingReader::new(reader, Context::new(self.digest_algo));
stream::copy_n(
&mut hashing_reader,
io::sink(),
self.data_size,
cancel_signal,
)
.map_err(|e| Error::DataRead("raw_data", e))?;
let (_, context) = hashing_reader.finish();
let digest = context.finish();
// Verify the signature against the public key.
public_key
.verify_sig(self.sig_algo, digest.as_ref(), &self.sig)
.map_err(Error::CmsVerify)?;
Ok(())
}
}
/// Parse the CMS signature from the OTA zip comment. This does not perform any
/// parsing of zip data structures.
pub fn parse_ota_sig(mut reader: impl Read + Seek) -> Result<OtaSignature> {
fn parse_raw_ota_sig(mut reader: impl Read + Seek) -> Result<RawOtaSignature> {
let file_size = reader
.seek(SeekFrom::End(0))
.map_err(|e| Error::DataRead("file_size", e))?;
reader
.seek(SeekFrom::Current(-6))
.seek_relative(-6)
.map_err(|e| Error::DataRead("footer", e))?;
let footer = reader
.read_array_exact::<6>()
@@ -642,77 +861,16 @@ pub fn parse_ota_sig(mut reader: impl Read + Seek) -> Result<OtaSignature> {
// length field.
let hashed_size = file_size - 2 - u64::from(comment_size);
Ok(OtaSignature {
Ok(RawOtaSignature {
signed_data,
hashed_size,
})
}
/// Verify an OTA zip against its embedded certificates. This function makes no
/// assertion about whether the certificate is actually trusted. Returns the
/// embedded certificate.
///
/// CMS signed attributes are intentionally not supported because AOSP recovery
/// does not support them either. It expects the CMS [`SignedData`] structure to
/// be used for nothing more than a raw signature transport mechanism.
pub fn verify_ota(mut reader: impl Read + Seek, cancel_signal: &AtomicBool) -> Result<Certificate> {
let ota_sig = parse_ota_sig(&mut reader)?;
let cert = ota_sig.embedded_cert()?;
let public_key = crypto::get_public_key(cert).map_err(Error::OtaCertExtractPubKey)?;
// Make sure this is a signature scheme we can handle. There's currently no
// Rust library to verify arbitrary CMS signatures for large files without
// fully reading them into memory.
let signers_len = ota_sig.signed_data.signer_infos.0.len();
if signers_len != 1 {
return Err(Error::NotOneCmsSignerInfo(signers_len));
}
let signer = ota_sig.signed_data.signer_infos.0.get(0).unwrap();
if signer.digest_alg.oid != rfc5912::ID_SHA_256 && signer.digest_alg.oid != rfc5912::ID_SHA_1 {
return Err(Error::UnsupportedDigestAlgorithm(signer.digest_alg.oid));
} else if signer.signature_algorithm.oid != rfc5912::RSA_ENCRYPTION
&& signer.signature_algorithm.oid != rfc5912::SHA_256_WITH_RSA_ENCRYPTION
{
return Err(Error::UnsupportedSignatureAlgorithm(
signer.signature_algorithm.oid,
));
}
// Manually hash the parts of the file covered by the signature.
reader
.seek(SeekFrom::Start(0))
.map_err(|e| Error::DataRead("raw_data", e))?;
// We support SHA1 for verification only.
let (algorithm, algo) = if signer.digest_alg.oid == rfc5912::ID_SHA_256 {
(&ring::digest::SHA256, SignatureAlgorithm::Sha256WithRsa)
} else {
(
&ring::digest::SHA1_FOR_LEGACY_USE_ONLY,
SignatureAlgorithm::Sha1WithRsa,
)
};
let mut hashing_reader = HashingReader::new(reader, Context::new(algorithm));
stream::copy_n(
&mut hashing_reader,
io::sink(),
ota_sig.hashed_size,
cancel_signal,
)
.map_err(|e| Error::DataRead("raw_data", e))?;
let (_, context) = hashing_reader.finish();
let digest = context.finish();
// Verify the signature against the public key.
public_key
.verify_sig(algo, digest.as_ref(), signer.signature.as_bytes())
.map_err(Error::CmsVerify)?;
Ok(cert.clone())
/// Parse the signature information from the CMS signature embedded in the OTA
/// zip archive comment.
pub fn parse_ota_sig(reader: impl Read + Seek) -> Result<OtaSignature> {
parse_raw_ota_sig(reader)?.try_into()
}
/// Get and parse the protobuf-encoded OTA metadata, the PEM-encoded otacert,
@@ -720,54 +878,73 @@ pub fn verify_ota(mut reader: impl Read + Seek, cancel_signal: &AtomicBool) -> R
pub fn parse_zip_ota_info(
reader: impl Read + Seek,
) -> Result<(OtaMetadata, Certificate, PayloadHeader, String)> {
let mut zip = ZipArchive::new(reader).map_err(Error::ZipOpen)?;
let mut buffer = vec![0u8; RECOMMENDED_BUFFER_SIZE];
let archive = ZipArchive::from_seekable(reader, &mut buffer).map_err(Error::ZipOpen)?;
let metadata = match zip.by_name(PATH_METADATA_PB) {
Ok(mut entry) => {
let mut metadata_modern = None;
let mut metadata_legacy = None;
let mut certificate = None;
let mut header = None;
let mut properties = None;
let mut entries = archive.entries_safe(&mut buffer);
while let Some((cd_entry, entry)) = entries.next_entry().map_err(Error::ZipEntryList)? {
let path = cd_entry.file_path_utf8().map_err(Error::ZipEntryList)?;
if path == PATH_METADATA_PB {
let mut reader = zip::verifying_reader(&entry, cd_entry.compression_method())
.map_err(|e| Error::ZipEntryOpen(PATH_METADATA_PB.into(), e))?;
let mut buf = Vec::new();
entry
reader
.read_to_end(&mut buf)
.map_err(|e| Error::ZipEntryRead(PATH_METADATA_PB, e))?;
parse_protobuf_metadata(&buf)?
}
e @ Err(ZipError::FileNotFound) => {
drop(e);
let mut entry = zip
.by_name(PATH_METADATA)
.map_err(|e| Error::ZipEntryOpen(PATH_METADATA, e))?;
.map_err(|e| Error::ZipEntryRead(PATH_METADATA_PB.into(), e))?;
metadata_modern = Some(parse_protobuf_metadata(&buf)?);
} else if path == PATH_METADATA {
let mut reader = zip::verifying_reader(&entry, cd_entry.compression_method())
.map_err(|e| Error::ZipEntryOpen(PATH_METADATA.into(), e))?;
let mut buf = String::new();
entry
reader
.read_to_string(&mut buf)
.map_err(|e| Error::ZipEntryRead(PATH_METADATA, e))?;
parse_legacy_metadata(&buf)?
.map_err(|e| Error::ZipEntryRead(PATH_METADATA.into(), e))?;
metadata_legacy = Some(parse_legacy_metadata(&buf)?);
} else if path == PATH_OTACERT {
let reader = zip::verifying_reader(&entry, cd_entry.compression_method())
.map_err(|e| Error::ZipEntryOpen(PATH_OTACERT.into(), e))?;
certificate = Some(
crypto::read_pem_cert(Path::new(PATH_OTACERT), reader)
.map_err(Error::OtaCertLoad)?,
);
} else if path == PATH_PAYLOAD {
// No CRC validation because we only read the header.
let reader = zip::compressed_reader(&entry, cd_entry.compression_method())
.map_err(|e| Error::ZipEntryOpen(PATH_PAYLOAD.into(), e))?;
header = Some(PayloadHeader::from_reader(reader).map_err(Error::PayloadLoad)?);
} else if path == PATH_PROPERTIES {
let mut reader = zip::verifying_reader(&entry, cd_entry.compression_method())
.map_err(|e| Error::ZipEntryOpen(PATH_PROPERTIES.into(), e))?;
let mut buf = String::new();
reader
.read_to_string(&mut buf)
.map_err(|e| Error::ZipEntryRead(PATH_PROPERTIES.into(), e))?;
properties = Some(buf);
}
Err(e) => return Err(Error::ZipEntryOpen(PATH_METADATA_PB, e)),
};
}
let certificate = {
let entry = zip
.by_name(PATH_OTACERT)
.map_err(|e| Error::ZipEntryOpen(PATH_OTACERT, e))?;
crypto::read_pem_cert(Path::new(PATH_OTACERT), entry).map_err(Error::OtaCertLoad)?
};
let header = {
let entry = zip
.by_name(PATH_PAYLOAD)
.map_err(|e| Error::ZipEntryOpen(PATH_PAYLOAD, e))?;
PayloadHeader::from_reader(entry).map_err(Error::PayloadLoad)?
};
let properties = {
let mut entry = zip
.by_name(PATH_PROPERTIES)
.map_err(|e| Error::ZipEntryOpen(PATH_PROPERTIES, e))?;
let mut buf = String::new();
entry
.read_to_string(&mut buf)
.map_err(|e| Error::ZipEntryRead(PATH_PROPERTIES, e))?;
buf
};
let metadata = metadata_modern
.or(metadata_legacy)
.ok_or_else(|| Error::ZipEntryMissing(PATH_METADATA_PB.into()))?;
let certificate = certificate.ok_or_else(|| Error::ZipEntryMissing(PATH_OTACERT.into()))?;
let header = header.ok_or_else(|| Error::ZipEntryMissing(PATH_PAYLOAD.into()))?;
let properties = properties.ok_or_else(|| Error::ZipEntryMissing(PATH_PROPERTIES.into()))?;
Ok((metadata, certificate, header, properties))
}
@@ -927,6 +1104,11 @@ impl<W: Read + Write + Seek> SeekableSigningWriter<W> {
cert: &Certificate,
cancel_signal: &AtomicBool,
) -> Result<W> {
// We always write a streaming zip because that is what rawzip supports.
// Convert it to not be streaming. This will leave the data descriptors
// behind, but that is fine.
zip::make_non_streaming(&mut self.inner).map_err(Error::MakeNonStreaming)?;
let file_size = self
.seek(SeekFrom::End(0))
.map_err(|e| Error::DataRead("file_size", e))?;
+509 -169
View File
@@ -1,22 +1,22 @@
// SPDX-FileCopyrightText: 2022-2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2022-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
collections::{HashMap, HashSet},
fmt,
io::{self, Cursor, Read, Seek, SeekFrom, Write},
ops::Range,
num::NonZeroU32,
ops::{Add, Range},
str::FromStr,
sync::atomic::AtomicBool,
};
use base64::engine::general_purpose::STANDARD;
use base64::Engine;
use base64::engine::general_purpose::STANDARD;
use bzip2::write::BzDecoder;
use liblzma::{
stream::{Check, Stream},
write::XzDecoder,
write::XzEncoder,
};
use flate2::{Compression, write::GzEncoder};
use lzma_rust2::{CheckType, XZOptions, XZReader, XZWriter};
use num_traits::CheckedAdd;
use prost::Message;
use rayon::{
iter::{IndexedParallelIterator, IntoParallelRefMutIterator},
@@ -26,18 +26,18 @@ use ring::digest::{Context, Digest};
use serde::{Deserialize, Serialize};
use thiserror::Error;
use x509_cert::Certificate;
use zerocopy::{big_endian, FromBytes, IntoBytes};
use zerocopy::{FromBytes, IntoBytes, big_endian};
use zerocopy_derive::{FromBytes, Immutable, IntoBytes, KnownLayout, Unaligned};
use crate::{
crypto::{self, RsaPublicKeyExt, RsaSigningKey, SignatureAlgorithm},
protobuf::chromeos_update_engine::{
install_operation::Type, signatures::Signature, DeltaArchiveManifest, Extent,
InstallOperation, PartitionInfo, PartitionUpdate, Signatures,
DeltaArchiveManifest, Extent, InstallOperation, PartitionInfo, PartitionUpdate, Signatures,
install_operation::Type, signatures::Signature,
},
stream::{
self, CountingReader, FromReader, HashingWriter, ReadDiscardExt, ReadFixedSizeExt,
ReadSeekReopen, WriteSeek, WriteSeekReopen,
self, CountingReader, FromReader, HashingReader, HashingWriter, ReadAt, ReadDiscardExt,
ReadFixedSizeExt, ReadSeek, UserPosFile, WriteAt, WriteSeek,
},
util::{self, OutOfBoundsError},
};
@@ -47,6 +47,11 @@ const PAYLOAD_VERSION: u64 = 2;
const MANIFEST_MAX_SIZE: usize = 4 * 1024 * 1024;
/// Size of each extent. This matches what AOSP's delta_generator does. We also
/// require this to be a multiple of the block size and a multiple of the
/// maximum CoW compression chunk size.
const CHUNK_SIZE: u64 = 2 * 1024 * 1024;
#[derive(Debug, Error)]
pub enum Error {
#[error("Unknown magic: {0:?}")]
@@ -76,6 +81,10 @@ pub enum Error {
expected: Option<String>,
actual: String,
},
#[error("Invalid block size: {0}")]
InvalidBlockSize(u32),
#[error("Invalid maximum CoW compression chunk size: {0}")]
InvalidMaxCompressionChunkSize(u32),
#[error("Size of {name} ({size}) is not aligned to the block size ({block_size})")]
InvalidPartitionSize {
name: String,
@@ -108,21 +117,21 @@ pub enum Error {
DataWrite(&'static str, #[source] io::Error),
#[error("Expected {expected} bytes, but only wrote {actual} bytes")]
UnwrittenData { actual: u64, expected: u64 },
#[error("I/O error when applying {op_type:?} operation for {num_blocks} blocks starting at {start_block}")]
#[error(
"I/O error when applying {op_type:?} operation for {num_blocks} blocks starting at {start_block}"
)]
OperationApply {
op_type: Type,
start_block: u64,
num_blocks: u64,
source: io::Error,
},
#[error("Failed to reopen payload")]
PayloadReopen(#[source] io::Error),
#[error("Failed to open input file for partition: {0}")]
InputOpen(String, #[source] io::Error),
#[error("Failed to open output file for partition: {0}")]
OutputOpen(String, #[source] io::Error),
#[error("Failed to get input file size for partition: {0}")]
InputSize(String, #[source] io::Error),
#[error("Failed to GZ compress partition image chunk")]
GzCompress(#[source] io::Error),
#[error("Failed to initialize XZ encoder")]
XzInit(#[source] liblzma::stream::Error),
XzInit(#[source] io::Error),
#[error("Failed to XZ compress partition image chunk")]
XzCompress(#[source] io::Error),
#[error("Failed to read uncompressed input partition image chunk")]
@@ -135,7 +144,7 @@ type Result<T> = std::result::Result<T, Error>;
/// Raw on-disk layout for the payload header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawHeader {
/// Magic value. This should be equal to [`PAYLOAD_MAGIC`].
magic: [u8; 4],
@@ -579,12 +588,12 @@ impl<W: Write> Write for PayloadWriter<W> {
/// Verify the payload signatures using the specified certificate and check that
/// the digests in `payload_properties.txt` are correct.
pub fn verify_payload(
mut reader: impl Read + Seek,
reader: &mut dyn ReadSeek,
cert: &Certificate,
properties_raw: &str,
cancel_signal: &AtomicBool,
) -> Result<()> {
let header = PayloadHeader::from_reader(&mut reader)?;
let header = PayloadHeader::from_reader(&mut *reader)?;
reader.rewind().map_err(|e| Error::DataRead("header", e))?;
let payload_signatures_offset = header
@@ -604,7 +613,7 @@ pub fn verify_payload(
// Read from the beginning to the metadata signature.
let metadata_size = header.blob_offset - u64::from(header.metadata_signature_size);
stream::copy_n_inspect(
&mut reader,
&mut *reader,
io::sink(),
metadata_size,
|data| {
@@ -621,7 +630,7 @@ pub fn verify_payload(
let mut writer = Cursor::new(Vec::new());
stream::copy_n_inspect(
&mut reader,
&mut *reader,
&mut writer,
header.metadata_signature_size.into(),
|data| h_full.update(data),
@@ -651,7 +660,7 @@ pub fn verify_payload(
// Read (and discard) all the payload blobs.
stream::copy_n_inspect(
&mut reader,
&mut *reader,
io::sink(),
payload_signatures_offset,
|data| {
@@ -679,7 +688,7 @@ pub fn verify_payload(
let mut writer = Cursor::new(Vec::new());
stream::copy_n_inspect(
&mut reader,
&mut *reader,
&mut writer,
payload_signatures_size,
|data| h_full.update(data),
@@ -724,8 +733,8 @@ pub fn verify_payload(
/// Apply a partition operation from `reader` to `writer`.
pub fn apply_operation(
mut reader: impl Read + Seek,
mut writer: impl Write + Seek,
reader: &mut dyn ReadSeek,
writer: &mut dyn WriteSeek,
block_size: u32,
blob_offset: u64,
op: &InstallOperation,
@@ -761,7 +770,7 @@ pub fn apply_operation(
Type::Zero | Type::Discard => {
stream::copy_n_inspect(
io::repeat(0),
&mut writer,
&mut *writer,
out_data_length,
|data| hasher.update(data),
cancel_signal,
@@ -780,8 +789,8 @@ pub fn apply_operation(
match other {
Type::Replace => {
stream::copy_n_inspect(
&mut reader,
&mut writer,
&mut *reader,
&mut *writer,
data_length,
|data| hasher.update(data),
cancel_signal,
@@ -789,9 +798,9 @@ pub fn apply_operation(
.map_err(error_fn)?;
}
Type::ReplaceBz => {
let mut decoder = BzDecoder::new(&mut writer);
let mut decoder = BzDecoder::new(&mut *writer);
stream::copy_n_inspect(
&mut reader,
&mut *reader,
&mut decoder,
data_length,
|data| hasher.update(data),
@@ -801,16 +810,15 @@ pub fn apply_operation(
.map_err(error_fn)?;
}
Type::ReplaceXz => {
let mut decoder = XzDecoder::new(&mut writer);
stream::copy_n_inspect(
&mut reader,
&mut decoder,
data_length,
|data| hasher.update(data),
cancel_signal,
)
.and_then(|()| decoder.finish())
.map_err(error_fn)?;
// lzma_rust2 does not have a Write API, so we limit the
// reader and read till EOF.
let limited_reader = (&mut *reader).take(data_length);
let hashing_reader = HashingReader::new(limited_reader, hasher);
let mut decoder = XZReader::new(hashing_reader, false);
stream::copy(&mut decoder, &mut *writer, cancel_signal)
.map_err(error_fn)?;
(_, hasher) = decoder.into_inner().finish();
}
_ => return Err(Error::UnsupportedOperation(op.r#type())),
}
@@ -832,11 +840,10 @@ pub fn apply_operation(
}
/// Extract the specified image from the payload. This is done multithreaded and
/// uses rayon's global thread pool. Both the `payload` and `output` streams
/// will be reopened from multiple threads.
/// uses rayon's global thread pool.
pub fn extract_image(
payload: &(dyn ReadSeekReopen + Sync),
output: &(dyn WriteSeekReopen + Sync),
payload: &(dyn ReadAt + Sync),
output: &(dyn WriteAt + Sync),
header: &PayloadHeader,
partition_name: &str,
cancel_signal: &AtomicBool,
@@ -848,40 +855,28 @@ pub fn extract_image(
.find(|p| p.partition_name == partition_name)
.ok_or_else(|| Error::MissingPartition(partition_name.to_owned()))?;
partition
.operations
.par_iter()
.map(|op| -> Result<()> {
let reader = payload.reopen_boxed().map_err(Error::PayloadReopen)?;
let writer = output
.reopen_boxed()
.map_err(|e| Error::OutputOpen(partition_name.to_owned(), e))?;
apply_operation(
reader,
writer,
header.manifest.block_size(),
header.blob_offset,
op,
cancel_signal,
)?;
Ok(())
})
.collect::<Result<_>>()
partition.operations.par_iter().try_for_each(|op| {
apply_operation(
&mut UserPosFile::new(payload),
&mut UserPosFile::new(output),
header.manifest.block_size(),
header.blob_offset,
op,
cancel_signal,
)
})
}
/// Extract the specified partition images from the payload into writers. This
/// is done multithreaded and uses rayon's global thread pool. `open_payload`
/// and `open_output` will be called from multiple threads.
pub fn extract_images<'a>(
payload: &(dyn ReadSeekReopen + Sync),
open_output: impl Fn(&str) -> io::Result<Box<dyn WriteSeek>> + Sync,
/// is done multithreaded and uses rayon's global thread pool.
pub fn extract_images<'name, 'file>(
payload: &(dyn ReadAt + Sync),
outputs: impl IntoIterator<Item = (&'name str, &'file (dyn WriteAt + Sync))>,
header: &PayloadHeader,
partition_names: impl IntoIterator<Item = &'a str>,
cancel_signal: &AtomicBool,
) -> Result<()> {
let mut remaining = partition_names.into_iter().collect::<HashSet<_>>();
let outputs = outputs.into_iter().collect::<HashMap<_, _>>();
let mut remaining = outputs.keys().copied().collect::<HashSet<_>>();
// We parallelize at the operation level or else one thread might get stuck
// processing a giant image.
let mut operations = vec![];
@@ -901,24 +896,23 @@ pub fn extract_images<'a>(
operations
.into_par_iter()
.map(|(name, op)| -> Result<()> {
let reader = payload.reopen_boxed().map_err(Error::PayloadReopen)?;
let writer = open_output(name).map_err(|e| Error::OutputOpen(name.to_owned(), e))?;
.try_for_each(|(name, op)| -> Result<()> {
let mut reader = UserPosFile::new(payload);
let mut writer = UserPosFile::new(&outputs[name]);
apply_operation(
reader,
writer,
&mut reader,
&mut writer,
header.manifest.block_size(),
header.blob_offset,
op,
cancel_signal,
)?;
Ok(())
)
})
.collect()
}
/// Compress raw data into a chunk to be used with a [`Type::ReplaceXz`]
/// [`InstallOperation`].
fn compress_chunk(raw_data: &[u8], cancel_signal: &AtomicBool) -> Result<(Vec<u8>, Digest)> {
let reader = Cursor::new(raw_data);
let writer = Cursor::new(Vec::new());
@@ -928,8 +922,9 @@ fn compress_chunk(raw_data: &[u8], cancel_signal: &AtomicBool) -> Result<(Vec<u8
// decompression. Also, we intentionally pick the lowest compression level
// since we primarily care about squishing zeros. The non-zero portions of
// boot images are usually already-compressed kernels and ramdisks.
let stream = Stream::new_easy_encoder(0, Check::None).map_err(Error::XzInit)?;
let mut xz_writer = XzEncoder::new_stream(hashing_writer, stream);
let mut options = XZOptions::with_preset(0);
options.set_check_sum_type(CheckType::None);
let mut xz_writer = XZWriter::new(hashing_writer, options).map_err(Error::XzInit)?;
stream::copy_n(reader, &mut xz_writer, raw_data.len() as u64, cancel_signal)
.map_err(Error::XzCompress)?;
@@ -943,51 +938,397 @@ fn compress_chunk(raw_data: &[u8], cancel_signal: &AtomicBool) -> Result<(Vec<u8
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Deserialize, Serialize)]
pub enum VabcAlgo {
Lz4,
Gzip,
pub enum CowVersion {
V2,
V3 {
/// The maximum number of bytes to compress at a time.
compression_factor: u32,
},
}
impl VabcAlgo {
pub fn new(name: &str) -> Option<Self> {
match name {
"lz4" => Some(Self::Lz4),
"gz" => Some(Self::Gzip),
_ => None,
impl CowVersion {
fn compression_factor(self) -> Option<u32> {
match self {
Self::V2 => None,
Self::V3 { compression_factor } => Some(compression_factor),
}
}
fn compressed_size(self, mut raw_data: &[u8], block_size: u32) -> u64 {
let mut total = 0;
/// Compute the size overhead required to store the headers and footers
/// needed for this version of the on-disk CoW format.
fn size_overhead(self, cow_replace_ops: u64, payload_install_ops: u64) -> u64 {
const BUFFER_REGION_DEFAULT_SIZE: u64 = 2 * 1024 * 1024;
const CLUSTER_OPS: u64 = 200;
const NUM_RESUME_POINTS: u64 = 4;
const SIZEOF_COW_FOOTER_V2: u64 = 84;
const SIZEOF_COW_HEADER_V2: u64 = 38;
const SIZEOF_COW_HEADER_V3: u64 = SIZEOF_COW_HEADER_V2 + 40;
const SIZEOF_COW_OPERATION_V2: u64 = 20;
const SIZEOF_COW_OPERATION_V3: u64 = 16;
const SIZEOF_RESUME_POINT_V3: u64 = 16;
while !raw_data.is_empty() {
let n = raw_data.len().min(block_size as usize);
let compressed = match self {
Self::Lz4 => lz4_flex::block::compress(&raw_data[..n]),
// We use the miniz_oxide backend for flate2, but flate2 doesn't
// expose a nice function for compressing to a vec, so just use
// miniz_oxide directly.
Self::Gzip => miniz_oxide::deflate::compress_to_vec_zlib(&raw_data[..n], 9),
};
let mut overhead = 0;
total += compressed.len().min(n) as u64;
match self {
Self::V2 => {
// sizeof(CowHeader).
// AOSP: CowWriterV2::InitPos()
overhead += SIZEOF_COW_HEADER_V2;
raw_data = &raw_data[n..];
// header_.buffer_size. update_engine uses the default value.
// AOSP: CowWriterV2::InitPos()
overhead += BUFFER_REGION_DEFAULT_SIZE;
// Add all the CoW operation headers:
//
// - There is a kCowReplaceOp for each compressed chunk.
// - There is a kCowLabelOp for each InstallOperation in the
// payload. This is added by delta_generator in CowDryRun().
// - There is a kCowClusterOp at the end of each cluster of
// operations (which includes the kCowClusterOp itself). The
// cluster size used to be 200, but was changed to 1024 in
// 5e8e488c13cbff9e0a305ce7c22fd6a13aabb886. We'll use the
// smaller value because it's better to overestimate.
//
// AOSP: CowWriterV2::EmitClusterIfNeeded()
let cow_label_ops = payload_install_ops;
let cow_cluster_ops = (cow_replace_ops + cow_label_ops).div_ceil(CLUSTER_OPS - 1);
// A cluster cannot be truncated, so round up to the nearest
// cluster boundary.
// AOSP: CowWriterV2::AddOperation()
overhead += cow_cluster_ops * CLUSTER_OPS * SIZEOF_COW_OPERATION_V2;
// sizeof(CowFooter).
// AOSP: CowWriterV2::GetCowSizeInfo()
overhead += SIZEOF_COW_FOOTER_V2;
}
Self::V3 { .. } => {
// AOSP: CowWriterV3::OpenForWrite() -> GetDataOffset()
overhead += SIZEOF_COW_HEADER_V3;
overhead += BUFFER_REGION_DEFAULT_SIZE;
overhead += NUM_RESUME_POINTS * SIZEOF_RESUME_POINT_V3;
// Add an operation header (sizeof(CowOperationV3)) for each
// chunk of compressed data.
// AOSP: CowWriterV3::WriteOperation()
overhead += cow_replace_ops * SIZEOF_COW_OPERATION_V3;
}
}
total
overhead
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum ChunkingMethod {
/// Compress data in block sized chunks each iteration.
Exact,
/// Compress data in chunks where each chunk is sized at the largest power
/// of 2 that's `<=` the specified size and the remaining input size.
MaxPowerOf2(NonZeroU32),
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
struct ChunkingParams {
block_size: u32,
method: ChunkingMethod,
}
impl ChunkingParams {
fn chunk_size(self, num_blocks: u64) -> u32 {
match self.method {
ChunkingMethod::Exact => self.block_size,
ChunkingMethod::MaxPowerOf2(max_chunk_size) => {
assert!(
max_chunk_size.is_power_of_two() && max_chunk_size.get() % self.block_size == 0
);
let mut chunk_size = max_chunk_size.get();
while chunk_size > self.block_size {
let min_blocks = chunk_size / self.block_size;
if num_blocks >= u64::from(min_blocks) {
return chunk_size;
}
chunk_size >>= 1;
}
self.block_size
}
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct CowEstimate {
/// Size of estimate in bytes.
pub size: u64,
/// Number of CoW operations (v3 only).
pub num_ops: u64,
}
impl CowEstimate {
/// Add fudge factor to account for overhead.
fn fudged(&self, payload_install_ops: u64, cow_version: CowVersion) -> Option<Self> {
let version_overhead = cow_version.size_overhead(self.num_ops, payload_install_ops);
let mut size = self.size.checked_add(version_overhead)?;
// delta_generator adds 1% overhead to the original CoW size estimate,
// even if compression is disabled. We'll do the same too. For the
// compressed scenario, we rely on this more because lz4_flex and
// zlib-rs usually compress better than the lz4 and zlib implementations
// used by libsnapshot_cow.
size += size / 100;
// AOSP: PartitionProcessor::Run()
let num_ops = self.num_ops.max(25);
Some(Self { size, num_ops })
}
}
impl Add for CowEstimate {
type Output = Self;
fn add(self, rhs: Self) -> Self::Output {
Self {
size: self.size + rhs.size,
num_ops: self.num_ops + rhs.num_ops,
}
}
}
impl CheckedAdd for CowEstimate {
fn checked_add(&self, rhs: &Self) -> Option<Self> {
Some(Self {
size: self.size.checked_add(rhs.size)?,
num_ops: self.num_ops.checked_add(rhs.num_ops)?,
})
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Deserialize, Serialize)]
pub enum VabcAlgoKind {
None,
Lz4,
Gz,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Deserialize, Serialize)]
pub struct VabcAlgo {
/// Compression algorithm.
pub kind: VabcAlgoKind,
/// Compression level. AOSP allows this to be present even if the algorithm
/// can't use it.
pub level: Option<u32>,
}
impl VabcAlgo {
/// Compute the compressed size of the raw data when split into chunks based
/// on the specified [`ChunkingParams`]. The length of `raw_data` must be a
/// multiple of the block size or else this will panic. The compressed data
/// for each chunk is temporarily stored in memory, but discarded after each
/// loop iteration.
fn compressed_size(self, mut raw_data: &[u8], chunking: ChunkingParams) -> Result<CowEstimate> {
assert!(raw_data.len() as u64 % u64::from(chunking.block_size) == 0);
let mut size = 0;
let mut num_ops = 0;
while !raw_data.is_empty() {
let num_blocks = raw_data.len() as u64 / u64::from(chunking.block_size);
let chunk_size = chunking.chunk_size(num_blocks) as usize;
let (chunk, remaining) = raw_data.split_at(chunk_size);
// This should match CompressWorker::GetDefaultCompressionLevel() in
// AOSP's libsnapshot.
//
// CoW v3 uses the raw data instead of the compressed data if the
// raw data is smaller. Because we use a different implementation of
// the compression algorithms, we don't implement this. It's safer
// to just overestimate and use the (larger) compressed size.
size += match self.kind {
VabcAlgoKind::None => chunk_size as u64,
VabcAlgoKind::Lz4 => lz4_flex::block::compress(chunk).len() as u64,
VabcAlgoKind::Gz => {
let level = self.level.map_or(Compression::best(), Compression::new);
let mut encoder = GzEncoder::new(Vec::new(), level);
encoder.write_all(chunk).map_err(Error::GzCompress)?;
encoder.finish().map_err(Error::GzCompress)?.len() as u64
}
};
num_ops += 1;
raw_data = remaining;
}
Ok(CowEstimate { size, num_ops })
}
}
impl fmt::Display for VabcAlgo {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Lz4 => f.write_str("lz4"),
Self::Gzip => f.write_str("gz"),
let name = match self.kind {
VabcAlgoKind::None => "none",
VabcAlgoKind::Lz4 => "lz4",
VabcAlgoKind::Gz => "gz",
};
f.write_str(name)?;
if let Some(level) = self.level {
write!(f, ",{level}")?;
}
Ok(())
}
}
#[derive(Clone, Debug, Error)]
#[error("Invalid VABC algorithm: {0:?} (must be {{none|lz4|gz}}[,<level>])")]
pub struct InvalidVabcAlgo(String);
impl FromStr for VabcAlgo {
type Err = InvalidVabcAlgo;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
let (prefix, suffix) = s.split_once(',').unwrap_or((s, ""));
// AOSP allows any algorithm to accept a level, even if it's unused.
let level = if !suffix.is_empty() {
Some(suffix.parse().map_err(|_| InvalidVabcAlgo(s.to_owned()))?)
} else {
None
};
let kind = match prefix {
"" | "none" => VabcAlgoKind::None,
"lz4" => VabcAlgoKind::Lz4,
"gz" => VabcAlgoKind::Gz,
_ => return Err(InvalidVabcAlgo(s.to_owned())),
};
Ok(Self { kind, level })
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct VabcParams {
/// CoW on-disk format version.
pub version: CowVersion,
/// CoW compression algorithm.
pub algo: VabcAlgo,
}
/// Ensure that the partition size is aligned to the block size and that the
/// block size and compression factor are factors of our [`CHUNK_SIZE`].
fn validate_partition_size(
partition_name: &str,
file_size: u64,
block_size: u32,
compression_factor: Option<u32>,
) -> Result<()> {
if block_size == 0 || !block_size.is_power_of_two() || CHUNK_SIZE % u64::from(block_size) != 0 {
return Err(Error::InvalidBlockSize(block_size));
}
if let Some(factor) = compression_factor
&& (factor == 0 || !factor.is_power_of_two() || CHUNK_SIZE % u64::from(factor) != 0)
{
return Err(Error::InvalidMaxCompressionChunkSize(factor));
}
if file_size % u64::from(block_size) != 0 {
return Err(Error::InvalidPartitionSize {
name: partition_name.to_owned(),
size: file_size,
block_size,
});
}
Ok(())
}
/// Compute the VABC CoW size estimate. For a more accurate size estimate with
/// CoW version 2, `payload_install_ops` must be equal to the number of
/// [`InstallOperation`]s in the payload. The caller must update
/// [`PartitionUpdate::estimate_cow_size`] and
/// [`PartitionUpdate::estimate_op_count_max`] or else update_engine may fail to
/// flash the partition due to running out of space on the CoW block device.
pub fn compute_cow_estimate(
input: &(dyn ReadAt + Sync),
payload_install_ops: u64,
partition_name: &str,
block_size: u32,
vabc_params: VabcParams,
cancel_signal: &AtomicBool,
) -> Result<CowEstimate> {
let file_size = input
.file_len()
.map_err(|e| Error::InputSize(partition_name.to_owned(), e))?;
let final_chunk_different = file_size % CHUNK_SIZE != 0;
validate_partition_size(
partition_name,
file_size,
block_size,
vabc_params.version.compression_factor(),
)?;
let chunking = ChunkingParams {
block_size,
method: match vabc_params.version {
CowVersion::V2 => ChunkingMethod::Exact,
CowVersion::V3 { compression_factor } => {
// validate_partition_size() already validated that it is not 0.
ChunkingMethod::MaxPowerOf2(compression_factor.try_into().unwrap())
}
},
};
let chunks_total = file_size.div_ceil(CHUNK_SIZE);
let initial_estimate = (0..chunks_total)
.into_par_iter()
.map(|chunk| -> Result<CowEstimate> {
let data = (|| {
let mut reader = UserPosFile::new(input);
reader.seek(SeekFrom::Start(chunk * CHUNK_SIZE))?;
let chunk_size = if final_chunk_different && chunk == chunks_total - 1 {
file_size % CHUNK_SIZE
} else {
CHUNK_SIZE
};
stream::check_cancel(cancel_signal)?;
reader.read_vec_exact(chunk_size as usize)
})()
.map_err(Error::ChunkRead)?;
vabc_params.algo.compressed_size(&data, chunking)
})
.try_fold(
CowEstimate::default,
|total, chunk_estimate| -> Result<CowEstimate> {
total
.checked_add(&chunk_estimate?)
.ok_or(Error::IntOverflow("initial_estimate"))
},
)
.try_reduce(CowEstimate::default, |total, partial| {
total
.checked_add(&partial)
.ok_or(Error::IntOverflow("initial_estimate"))
})?;
initial_estimate
.fudged(payload_install_ops, vabc_params.version)
.ok_or(Error::IntOverflow("fudged_estimate"))
}
/// Compress the image and return the corresponding information to insert into
/// the payload manifest's [`PartitionUpdate`] instance. The uncompressed data
/// is split into 2 MiB chunks, which are read and compressed in parallel, and
@@ -996,41 +1337,45 @@ impl fmt::Display for VabcAlgo {
/// update [`InstallOperation::data_offset`] in each operation manually because
/// the initial values are relative to 0.
///
/// If `vabc_algo` is set, the VABC CoW v2 size estimate will be computed. The
/// caller must update [`PartitionUpdate::estimate_cow_size`] with this value or
/// else update_engine may fail to flash the partition due to running out of
/// space on the CoW block device. CoW v2 + other algorithms and also CoW v3 are
/// currently unsupported because there currently are no known OTAs that use
/// those configurations.
/// If `vabc_algo` is set, the VABC CoW size estimate will also be computed.
/// This is more efficient than separately calling [`compute_cow_estimate`]
/// since the input does not need to be read twice.
pub fn compress_image(
input: &(dyn ReadSeekReopen + Sync),
output: &(dyn WriteSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
output: &(dyn WriteAt + Sync),
partition_name: &str,
block_size: u32,
vabc_algo: Option<VabcAlgo>,
vabc_params: Option<VabcParams>,
cancel_signal: &AtomicBool,
) -> Result<(PartitionInfo, Vec<InstallOperation>, Option<u64>)> {
const CHUNK_SIZE: u64 = 2 * 1024 * 1024;
) -> Result<(PartitionInfo, Vec<InstallOperation>, Option<CowEstimate>)> {
const CHUNK_GROUP: u64 = 32;
let file_size = input
.reopen_boxed()
.and_then(|mut r| r.seek(SeekFrom::End(0)))
.map_err(|e| Error::InputOpen(partition_name.to_owned(), e))?;
.file_len()
.map_err(|e| Error::InputSize(partition_name.to_owned(), e))?;
let final_chunk_different = file_size % CHUNK_SIZE != 0;
if file_size % u64::from(block_size) != 0 || CHUNK_SIZE % u64::from(block_size) != 0 {
return Err(Error::InvalidPartitionSize {
name: partition_name.to_owned(),
size: file_size,
block_size,
});
}
validate_partition_size(
partition_name,
file_size,
block_size,
vabc_params.and_then(|p| p.version.compression_factor()),
)?;
let chunking = ChunkingParams {
block_size,
method: match vabc_params.map(|p| p.version) {
Some(CowVersion::V3 { compression_factor }) => {
ChunkingMethod::MaxPowerOf2(compression_factor.try_into().unwrap())
}
_ => ChunkingMethod::Exact,
},
};
let chunks_total = file_size.div_ceil(CHUNK_SIZE);
let mut bytes_compressed = 0;
let mut bytes_compressed = 0u64;
let mut context_uncompressed = Context::new(&ring::digest::SHA256);
let mut cow_estimate = 0;
let mut initial_estimate = CowEstimate::default();
let mut operations = vec![];
// Read the file one group at a time. This allows for some parallelization
@@ -1043,7 +1388,7 @@ pub fn compress_image(
let uncompressed_data_group = (chunks_done..chunks_done + chunks_group)
.into_par_iter()
.map(|chunk| -> io::Result<(u64, Vec<u8>)> {
let mut reader = input.reopen_boxed()?;
let mut reader = UserPosFile::new(input);
let offset = reader.seek(SeekFrom::Start(chunk * CHUNK_SIZE))?;
let chunk_size = if final_chunk_different && chunk == chunks_total - 1 {
@@ -1067,10 +1412,12 @@ pub fn compress_image(
let mut compressed_data_group = uncompressed_data_group
.into_par_iter()
.map(
|(raw_offset, raw_data)| -> Result<(Vec<u8>, InstallOperation, u64)> {
|(raw_offset, raw_data)| -> Result<(Vec<u8>, InstallOperation, CowEstimate)> {
let (data, digest_compressed) = compress_chunk(&raw_data, cancel_signal)?;
let cow_size =
vabc_algo.map_or(0, |a| a.compressed_size(&raw_data, block_size));
let cow_estimate = vabc_params
.map(|p| p.algo.compressed_size(&raw_data, chunking))
.transpose()?
.unwrap_or_default();
let extent = Extent {
start_block: Some(raw_offset / u64::from(block_size)),
@@ -1083,21 +1430,25 @@ pub fn compress_image(
operation.dst_extents.push(extent);
operation.data_sha256_hash = Some(digest_compressed.as_ref().to_vec());
Ok((data, operation, cow_size))
Ok((data, operation, cow_estimate))
},
)
.collect::<Result<Vec<_>>>()?;
for (data, operation, cow_size) in &mut compressed_data_group {
for (data, operation, cow_estimate) in &mut compressed_data_group {
operation.data_offset = Some(bytes_compressed);
bytes_compressed += data.len() as u64;
cow_estimate += *cow_size;
bytes_compressed = bytes_compressed
.checked_add(data.len() as u64)
.ok_or(Error::IntOverflow("bytes_compressed"))?;
initial_estimate = initial_estimate
.checked_add(cow_estimate)
.ok_or(Error::IntOverflow("initial_estimate"))?;
}
let group_operations = compressed_data_group
.into_par_iter()
.map(|(data, operation, _)| -> io::Result<InstallOperation> {
let mut writer = output.reopen_boxed()?;
let mut writer = UserPosFile::new(output);
writer.seek(SeekFrom::Start(operation.data_offset.unwrap()))?;
writer.write_all(&data)?;
@@ -1115,25 +1466,12 @@ pub fn compress_image(
hash: Some(digest_uncompressed.as_ref().to_vec()),
};
let cow_estimate = if vabc_algo.is_some() {
// lz4_flex and miniz_oxide usually compress better than the lz4 and
// zlib implementations used by libsnapshot_cow. Make up for this by
// adding percentage-based overhead.
cow_estimate += cow_estimate / 100;
// We also need to account for constant overhead, especially with
// smaller partitions. We can match what delta_generator normally adds
// in CowWriterV2::InitPos() exactly. Since we only ever create full
// OTAs, we can assume that all CoW operations are kCowReplaceOp.
// sizeof(CowHeader).
cow_estimate += 38;
// header_.buffer_size (equal to BUFFER_REGION_DEFAULT_SIZE).
cow_estimate += 2 * 1024 * 1024;
// CowOptions::cluster_ops * sizeof(CowOperationV2).
cow_estimate += 200 * 20;
Some(cow_estimate)
let cow_estimate = if let Some(p) = vabc_params {
Some(
initial_estimate
.fudged(operations.len() as u64, p.version)
.ok_or(Error::IntOverflow("fudged_estimate"))?,
)
} else {
None
};
@@ -1179,8 +1517,8 @@ fn extents_sorted(operations: &[InstallOperation]) -> bool {
///
/// Returns the ranges of indices of `operations` that were updated.
pub fn compress_modified_image(
input: &(dyn ReadSeekReopen + Sync),
output: &(dyn WriteSeekReopen + Sync),
input: &(dyn ReadAt + Sync),
output: &(dyn WriteAt + Sync),
block_size: u32,
partition_info: &mut PartitionInfo,
operations: &mut [InstallOperation],
@@ -1229,7 +1567,7 @@ pub fn compress_modified_image(
let extents_size: usize = util::try_cast(extents_size)
.map_err(|e| Error::IntOutOfBounds("extents_size", e))?;
let mut reader = input.reopen_boxed().map_err(Error::ChunkRead)?;
let mut reader = UserPosFile::new(input);
reader
.seek(SeekFrom::Start(extents_start))
.map_err(Error::ChunkRead)?;
@@ -1276,10 +1614,12 @@ pub fn compress_modified_image(
let modified_group_operations = compressed_data_group
.into_par_iter()
.map(|(data, i, operation)| {
let mut writer = output.reopen_boxed()?;
let mut writer = UserPosFile::new(output);
writer.seek(SeekFrom::Start(operation.data_offset.unwrap()))?;
writer.write_all(&data)?;
// Clippy doesn't know we're returning a Range.
#[allow(clippy::range_plus_one)]
Ok(i..i + 1)
})
.collect::<io::Result<Vec<_>>>()
+23 -20
View File
@@ -1,9 +1,9 @@
// SPDX-FileCopyrightText: 2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2024-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
fmt,
io::{self, Read, Seek, SeekFrom, Write},
io::{self, Read, Seek, Write},
mem,
ops::Range,
};
@@ -11,7 +11,7 @@ use std::{
use crc32fast::Hasher;
use dlv_list::{Index, VecList};
use thiserror::Error;
use zerocopy::{byteorder::little_endian, FromBytes, IntoBytes};
use zerocopy::{FromBytes, IntoBytes, byteorder::little_endian};
use zerocopy_derive::{FromBytes, Immutable, IntoBytes, KnownLayout, Unaligned};
use crate::stream::ReadDiscardExt;
@@ -106,7 +106,7 @@ type Result<T> = std::result::Result<T, Error>;
/// Raw on-disk layout for the header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawHeader {
/// Magic value. This should be equal to [`HEADER_MAGIC`].
magic: little_endian::U32,
@@ -159,7 +159,7 @@ impl RawHeader {
return Err(Error::UnsupportedMajorVersion(self.major_version.get()));
}
if self.file_hdr_sz.get() < mem::size_of::<RawHeader>() as u16 {
if self.file_hdr_sz.get() < mem::size_of::<Self>() as u16 {
return Err(Error::InvalidFileHeaderSize(self.file_hdr_sz.get()));
} else if self.chunk_hdr_sz.get() < mem::size_of::<RawChunk>() as u16 {
return Err(Error::InvalidChunkHeaderSize(self.chunk_hdr_sz.get()));
@@ -173,7 +173,7 @@ impl RawHeader {
}
fn excess_raw_header_bytes(&self) -> u16 {
self.file_hdr_sz.get() - mem::size_of::<RawHeader>() as u16
self.file_hdr_sz.get() - mem::size_of::<Self>() as u16
}
fn excess_raw_chunk_bytes(&self) -> u16 {
@@ -183,7 +183,7 @@ impl RawHeader {
/// Raw on-disk layout for the chunk header.
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(packed)]
#[repr(C, packed)]
struct RawChunk {
/// Chunk type. Must be [`CHUNK_TYPE_RAW`], [`CHUNK_TYPE_FILL`],
/// [`CHUNK_TYPE_DONT_CARE`], or [`CHUNK_TYPE_CRC32`].
@@ -225,7 +225,7 @@ impl RawChunk {
return Err(Error::InvalidChunkType {
index,
chunk_type: t,
})
});
}
};
@@ -374,6 +374,9 @@ impl fmt::Debug for ChunkData {
/// metadata they contain.
#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Chunk {
/// When [`Self::data`] is [`ChunkData::Data`], this is guaranteed to not
/// exceed the bounds of [`u32`] when multiplied by [`Header::block_size`].
/// For other types of data, a 64-bit signed or unsigned integer is needed.
pub bounds: ChunkBounds,
pub data: ChunkData,
}
@@ -519,11 +522,11 @@ impl ChunkList {
// entire list every time.
let mut insert_before = self.chunks.front_index();
if let Some(last_used) = self.last_used {
if chunk.bounds.start >= self.chunks.get(last_used).unwrap().bounds.start {
// The new chunk starts after the last used chunk.
insert_before = Some(last_used);
}
if let Some(last_used) = self.last_used
&& chunk.bounds.start >= self.chunks.get(last_used).unwrap().bounds.start
{
// The new chunk starts after the last used chunk.
insert_before = Some(last_used);
}
while let Some(index) = insert_before {
@@ -669,7 +672,7 @@ fn hash_fill_chunk(
/// A type for reading sparse files.
pub struct SparseReader<R> {
inner: R,
seek: Option<fn(&mut R, SeekFrom) -> io::Result<u64>>,
seek_relative: Option<fn(&mut R, i64) -> io::Result<()>>,
header: RawHeader,
/// Starting block for next chunk.
block: u32,
@@ -686,7 +689,7 @@ impl<R: Read + Seek> SparseReader<R> {
/// efficiently skipped without reading them.
pub fn new_seekable(inner: R, crc_mode: CrcMode) -> Result<Self> {
let mut result = Self::new(inner, crc_mode)?;
result.seek = Some(Seek::seek);
result.seek_relative = Some(Seek::seek_relative);
Ok(result)
}
}
@@ -707,7 +710,7 @@ impl<R: Read> SparseReader<R> {
Ok(Self {
inner,
seek: None,
seek_relative: None,
header,
block: 0,
chunk: 0,
@@ -741,12 +744,12 @@ impl<R: Read> SparseReader<R> {
/// perform its own verification.
pub fn next_chunk(&mut self) -> Result<Option<Chunk>> {
if self.data_remain != 0 {
if let Some(seek) = self.seek {
if let Some(seek_relative) = self.seek_relative {
if self.hasher.is_some() {
return Err(Error::Crc32RandomRead);
}
seek(&mut self.inner, SeekFrom::Current(self.data_remain.into()))
seek_relative(&mut self.inner, self.data_remain.into())
.map_err(|e| Error::DataRead("data_remain", e))?;
self.data_remain = 0;
} else {
@@ -811,7 +814,7 @@ impl<R: Read> SparseReader<R> {
data = ChunkData::Crc32(expected.get());
}
_ => unreachable!(),
};
}
let chunk = Chunk {
bounds: ChunkBounds {
@@ -1023,7 +1026,7 @@ impl<W: Write> Write for SparseWriter<W> {
#[cfg(test)]
mod tests {
use super::{Chunk, ChunkBounds, ChunkData, ChunkList};
use super::*;
#[test]
fn chunk_list_merge() {
+516
View File
@@ -0,0 +1,516 @@
// 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,
}
#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
#[repr(C, packed)]
struct ZipCentralHeader {
pub signature: little_endian::U32,
pub version_made_by: little_endian::U16,
pub version_needed: little_endian::U16,
pub flags: little_endian::U16,
pub compression_method: little_endian::U16,
pub last_mod_time: little_endian::U16,
pub last_mod_date: little_endian::U16,
pub crc32: little_endian::U32,
pub compressed_size: little_endian::U32,
pub uncompressed_size: little_endian::U32,
pub file_name_len: little_endian::U16,
pub extra_field_len: little_endian::U16,
pub file_comment_len: little_endian::U16,
pub disk_number_start: little_endian::U16,
pub internal_file_attrs: little_endian::U16,
pub external_file_attrs: little_endian::U32,
pub local_header_offset: little_endian::U32,
}
/// 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(())
}
+1 -1
View File
@@ -4,8 +4,8 @@
use std::{
process::ExitCode,
sync::{
atomic::{AtomicBool, Ordering},
Arc,
atomic::{AtomicBool, Ordering},
},
};
+1 -1
View File
@@ -10,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
+207 -141
View File
@@ -1,7 +1,8 @@
// SPDX-FileCopyrightText: 2022-2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2022-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
borrow::Cow,
cmp::Ordering,
collections::{HashMap, HashSet},
fmt::Write,
@@ -15,18 +16,15 @@ use std::{
};
use bstr::ByteSlice;
use liblzma::{
stream::{Check, Stream},
write::XzEncoder,
};
use lzma_rust2::{CheckType, XZOptions, XZWriter};
use rawzip::{RECOMMENDED_BUFFER_SIZE, ZipArchive};
use rayon::iter::{IntoParallelRefIterator, IntoParallelRefMutIterator, ParallelIterator};
use regex::bytes::Regex;
use ring::digest::Context;
use rsa::RsaPublicKey;
use thiserror::Error;
use tracing::{debug, debug_span, trace, warn, Span};
use tracing::{Span, debug, debug_span, trace, warn};
use x509_cert::Certificate;
use zip::{result::ZipError, ZipArchive};
use crate::{
crypto::{self, RsaSigningKey},
@@ -35,9 +33,11 @@ use crate::{
bootimage::{self, BootImage, BootImageExt, RamdiskMeta},
compression::{self, CompressedFormat, CompressedReader, CompressedWriter},
cpio::{self, CpioEntry, CpioEntryData},
zip::{self, ZipEntriesSafeExt, ZipFileHeaderRecordExt, ZipSliceEntriesSafeExt},
},
patch::otacert::{self, OtaCertBuildFlags},
stream::{self, FromReader, HashingWriter, ReadSeek, SectionReader, ToWriter, WriteSeek},
util,
};
#[derive(Debug, Error)]
@@ -83,17 +83,19 @@ pub enum Error {
#[error("Failed to generate replacement otacerts zip")]
OtaCertZip(#[source] otacert::Error),
#[error("Failed to initialize XZ encoder")]
XzInit(#[source] liblzma::stream::Error),
XzInit(#[source] io::Error),
#[error("Failed to XZ compress entry: {:?}", .0.as_bstr())]
XzCompress(Vec<u8>, #[source] io::Error),
#[error("Failed to open zip file: {0:?}")]
ZipOpen(PathBuf, #[source] ZipError),
ZipOpen(PathBuf, #[source] rawzip::Error),
#[error("Failed to list zip entries")]
ZipEntryList(#[source] rawzip::Error),
#[error("Missing zip entry: {0:?}")]
ZipEntryMissing(Cow<'static, str>),
#[error("Failed to open zip entry: {0:?}")]
ZipEntryOpen(&'static str, #[source] ZipError),
ZipEntryOpen(Cow<'static, str>, #[source] rawzip::Error),
#[error("Failed to read zip entry: {0:?}")]
ZipEntryRead(&'static str, #[source] io::Error),
#[error("Failed to open zip entry #{0}")]
ZipIndexOpen(usize, #[source] ZipError),
ZipEntryRead(Cow<'static, str>, #[source] io::Error),
#[error("Failed to open file: {0:?}")]
FileOpen(PathBuf, #[source] io::Error),
}
@@ -194,7 +196,7 @@ impl MagiskRootPatcher {
// replaced by PREINITDEVICE
// - Versions newer than the latest supported version are assumed to support
// the same features as the latest version
const VERS_SUPPORTED: &'static [Range<u32>] = &[25102..25207, 25211..28200];
const VERS_SUPPORTED: &'static [Range<u32>] = &[25102..25207, 25211..30300];
const VER_PREINIT_DEVICE: RangeFrom<u32> = 25211..;
const VER_RANDOM_SEED: Range<u32> = 25211..26103;
const VER_PATCH_VBMETA: Range<u32> = Self::VERS_SUPPORTED[0].start..26202;
@@ -256,41 +258,54 @@ impl MagiskRootPatcher {
})
}
fn get_version(path: &Path) -> Result<u32> {
let reader = File::open(path)
.map(BufReader::new)
.map_err(|e| Error::FileOpen(path.to_owned(), e))?;
let mut zip = ZipArchive::new(reader).map_err(|e| Error::ZipOpen(path.to_owned(), e))?;
let entry = zip
.by_name(Self::ZIP_UTIL_FUNCTIONS)
.map_err(|e| Error::ZipEntryOpen(Self::ZIP_UTIL_FUNCTIONS, e))?;
let mut entry = BufReader::new(entry);
let mut line = String::new();
fn get_version(apk_path: &Path) -> Result<u32> {
let file = File::open(apk_path).map_err(|e| Error::FileOpen(apk_path.to_owned(), e))?;
let mut buffer = vec![0u8; RECOMMENDED_BUFFER_SIZE];
let archive = ZipArchive::from_file(file, &mut buffer)
.map_err(|e| Error::ZipOpen(apk_path.to_owned(), e))?;
let mut entries = archive.entries_safe(&mut buffer);
loop {
line.clear();
let n = entry
.read_line(&mut line)
.map_err(|e| Error::ZipEntryRead(Self::ZIP_UTIL_FUNCTIONS, e))?;
if n == 0 {
return Err(Error::FindMagiskVersion(path.to_owned()));
while let Some((cd_entry, entry)) = entries.next_entry().map_err(Error::ZipEntryList)? {
let path = cd_entry.file_path_utf8().map_err(Error::ZipEntryList)?;
if path != Self::ZIP_UTIL_FUNCTIONS {
continue;
}
if let Some(suffix) = line.trim_end().strip_prefix("MAGISK_VER_CODE=") {
trace!("Magisk version code line: {line:?}");
let mut reader = zip::verifying_reader(&entry, cd_entry.compression_method())
.map(BufReader::new)
.map_err(|e| Error::ZipEntryOpen(Self::ZIP_UTIL_FUNCTIONS.into(), e))?;
let mut line = String::new();
let version = suffix
.parse()
.map_err(|e| Error::ParseMagiskVersion(suffix.to_owned(), e))?;
return Ok(version);
loop {
line.clear();
let n = reader
.read_line(&mut line)
.map_err(|e| Error::ZipEntryRead(Self::ZIP_UTIL_FUNCTIONS.into(), e))?;
if n == 0 {
return Err(Error::FindMagiskVersion(apk_path.to_owned()));
}
if let Some(suffix) = line.trim_end().strip_prefix("MAGISK_VER_CODE=") {
trace!("Magisk version code line: {line:?}");
let version = suffix
.parse()
.map_err(|e| Error::ParseMagiskVersion(suffix.to_owned(), e))?;
return Ok(version);
}
}
}
Err(Error::ZipEntryMissing(Self::ZIP_UTIL_FUNCTIONS.into()))
}
fn xz_compress(name: &[u8], reader: impl Read, cancel_signal: &AtomicBool) -> Result<Vec<u8>> {
let stream = Stream::new_easy_encoder(9, Check::Crc32).map_err(Error::XzInit)?;
let mut options = XZOptions::with_preset(9);
options.set_check_sum_type(CheckType::None);
let raw_writer = Cursor::new(Vec::new());
let mut writer = XzEncoder::new_stream(raw_writer, stream);
let mut writer = XZWriter::new(raw_writer, options).map_err(Error::XzInit)?;
let raw_writer = stream::copy(reader, &mut writer, cancel_signal)
.and_then(|_| writer.finish())
@@ -378,14 +393,12 @@ impl MagiskRootPatcher {
let mut new_data = None;
if xz_compress {
if let CpioEntryData::Data(data) = &old_entry.data {
new_path.extend(b".xz");
if xz_compress && let CpioEntryData::Data(data) = &old_entry.data {
new_path.extend(b".xz");
let reader = Cursor::new(data);
let buf = Self::xz_compress(&new_path, reader, cancel_signal)?;
new_data = Some(CpioEntryData::Data(buf));
}
let reader = Cursor::new(data);
let buf = Self::xz_compress(&new_path, reader, cancel_signal)?;
new_data = Some(CpioEntryData::Data(buf));
}
new_entries.push(CpioEntry {
@@ -432,18 +445,12 @@ impl BootImagePatch for MagiskRootPatcher {
targets.push("init_boot");
} else if boot_images.contains_key("boot") {
targets.push("boot");
};
}
Ok(targets)
}
fn patch(&self, boot_image: &mut BootImage, cancel_signal: &AtomicBool) -> Result<()> {
let zip_reader = File::open(&self.apk_path)
.map(BufReader::new)
.map_err(|e| Error::FileOpen(self.apk_path.clone(), e))?;
let mut zip =
ZipArchive::new(zip_reader).map_err(|e| Error::ZipOpen(self.apk_path.clone(), e))?;
// Load the first ramdisk. If it doesn't exist, we have to generate one
// from scratch.
let ramdisk = match boot_image {
@@ -469,60 +476,95 @@ impl BootImagePatch for MagiskRootPatcher {
// Delete the original init.
entries.retain(|e| e.path != b"init");
// Add magiskinit.
{
let mut zip_entry = zip
.by_name(Self::ZIP_MAGISKINIT)
.map_err(|e| Error::ZipEntryOpen(Self::ZIP_MAGISKINIT, e))?;
let mut data = vec![];
zip_entry
.read_to_end(&mut data)
.map_err(|e| Error::ZipEntryRead(Self::ZIP_MAGISKINIT, e))?;
let file =
File::open(&self.apk_path).map_err(|e| Error::FileOpen(self.apk_path.clone(), e))?;
let mut buffer = vec![0u8; RECOMMENDED_BUFFER_SIZE];
let archive = ZipArchive::from_file(file, &mut buffer)
.map_err(|e| Error::ZipOpen(self.apk_path.clone(), e))?;
let mut zip_entries = archive.entries_safe(&mut buffer);
let mut found_magiskinit = false;
let mut found_libmagisk = false;
while let Some((cd_entry, entry)) = zip_entries.next_entry().map_err(Error::ZipEntryList)? {
let path = cd_entry.file_path_utf8().map_err(Error::ZipEntryList)?;
// magiskinit is the only entry that is not xz-compressed.
if path == Self::ZIP_MAGISKINIT {
let mut reader = zip::verifying_reader(&entry, cd_entry.compression_method())
.map_err(|e| Error::ZipEntryOpen(Self::ZIP_MAGISKINIT.into(), e))?;
let mut data = vec![];
reader
.read_to_end(&mut data)
.map_err(|e| Error::ZipEntryRead(Self::ZIP_MAGISKINIT.into(), e))?;
entries.push(CpioEntry::new_file(
b"init",
0o750,
CpioEntryData::Data(data),
));
found_magiskinit = true;
continue;
}
// Keep a 'static version of the zip path.
let (path, cpio_path): (_, &[u8]) = match path {
// Newer Magisk versions only include a single binary for the
// target ABI in the ramdisk. This was introduced in commit
// fb5ee86615ed3df830e8538f8b39b1b133caea34.
p if p == Self::ZIP_LIBMAGISK => {
debug!("Single libmagisk");
found_libmagisk = true;
(Self::ZIP_LIBMAGISK, b"overlay.d/sbin/magisk.xz")
}
// Older Magisk versions include the 64-bit binary and,
// optionally, the 32-bit binary if the device supports it. We
// unconditionally include the magisk32 because the boot image
// itself doesn't have sufficient information to determine if a
// device is 64-bit only.
p if p == Self::ZIP_LIBMAGISK32 => {
debug!("Split libmagisk32");
found_libmagisk = true;
(Self::ZIP_LIBMAGISK32, b"overlay.d/sbin/magisk32.xz")
}
p if p == Self::ZIP_LIBMAGISK64 => {
debug!("Split libmagisk64");
found_libmagisk = true;
(Self::ZIP_LIBMAGISK64, b"overlay.d/sbin/magisk64.xz")
}
// The stub apk was introduced in commit
// ad0e6511e11ebec65aa9b5b916e1397342850319.
p if p == Self::ZIP_STUB => {
debug!("Magisk stub found");
(Self::ZIP_STUB, b"overlay.d/sbin/stub.xz")
}
// init-ld was introduced in commit
// 33aebb59763b6ec27209563035303700e998633d.
p if p == Self::ZIP_INIT_LD => {
debug!("Magisk init-ld found");
(Self::ZIP_INIT_LD, b"overlay.d/sbin/init-ld.xz")
}
_ => continue,
};
let reader = zip::verifying_reader(&entry, cd_entry.compression_method())
.map_err(|e| Error::ZipEntryOpen(path.into(), e))?;
let buf = Self::xz_compress(path.as_bytes(), reader, cancel_signal)?;
entries.push(CpioEntry::new_file(
b"init",
0o750,
CpioEntryData::Data(data),
cpio_path,
0o644,
CpioEntryData::Data(buf),
));
}
let mut xz_files = HashMap::<&str, &[u8]>::new();
if zip.file_names().any(|n| n == Self::ZIP_LIBMAGISK) {
// Newer Magisk versions only include a single binary for the target
// ABI in the ramdisk. fb5ee86615ed3df830e8538f8b39b1b133caea34.
debug!("Single libmagisk");
xz_files.insert(Self::ZIP_LIBMAGISK, b"overlay.d/sbin/magisk.xz");
} else {
// Older Magisk versions include the 64-bit binary and, optionally,
// the 32-bit binary if the device supports it. We unconditionally
// include the magisk32 because the boot image itself doesn't have
// sufficient information to determine if a device is 64-bit only.
debug!("Split libmagisk32/libmagisk64");
xz_files.insert(Self::ZIP_LIBMAGISK32, b"overlay.d/sbin/magisk32.xz");
xz_files.insert(Self::ZIP_LIBMAGISK64, b"overlay.d/sbin/magisk64.xz");
}
// Add stub apk, which only exists after Magisk commit
// ad0e6511e11ebec65aa9b5b916e1397342850319.
if zip.file_names().any(|n| n == Self::ZIP_STUB) {
debug!("Magisk stub found");
xz_files.insert(Self::ZIP_STUB, b"overlay.d/sbin/stub.xz");
}
// Add init-ld, which only exists after Magisk commit
// 33aebb59763b6ec27209563035303700e998633d
if zip.file_names().any(|n| n == Self::ZIP_INIT_LD) {
debug!("Magisk init-ld found");
xz_files.insert(Self::ZIP_INIT_LD, b"overlay.d/sbin/init-ld.xz");
}
for (source, target) in xz_files {
let reader = zip
.by_name(source)
.map_err(|e| Error::ZipEntryOpen(source, e))?;
let buf = Self::xz_compress(source.as_bytes(), reader, cancel_signal)?;
entries.push(CpioEntry::new_file(target, 0o644, CpioEntryData::Data(buf)));
if !found_magiskinit {
return Err(Error::ZipEntryMissing(Self::ZIP_MAGISKINIT.into()));
} else if !found_libmagisk {
return Err(Error::ZipEntryMissing(Self::ZIP_LIBMAGISK.into()));
}
// Create Magisk .backup directory structure.
@@ -544,10 +586,10 @@ impl BootImagePatch for MagiskRootPatcher {
magisk_config.push_str("RECOVERYMODE=false\n");
if Self::VER_PREINIT_DEVICE.contains(&self.version) {
if let Some(device) = &self.preinit_device {
writeln!(&mut magisk_config, "PREINITDEVICE={device}").unwrap();
}
if Self::VER_PREINIT_DEVICE.contains(&self.version)
&& let Some(device) = &self.preinit_device
{
writeln!(&mut magisk_config, "PREINITDEVICE={device}").unwrap();
}
// Magisk normally saves the original SHA1 digest in its config file. It
@@ -604,7 +646,7 @@ pub struct OtaCertPatcher {
}
impl OtaCertPatcher {
const OTACERTS_PATH: &'static [u8] = b"system/etc/security/otacerts.zip";
const OTACERTS_PATH: &'static str = "system/etc/security/otacerts.zip";
pub fn new(cert: Certificate) -> Self {
Self { cert }
@@ -630,29 +672,33 @@ impl OtaCertPatcher {
}
let (entries, _) = load_ramdisk(ramdisk, cancel_signal)?;
let Some(entry) = entries.iter().find(|e| e.path == Self::OTACERTS_PATH) else {
let Some(entry) = entries
.iter()
.find(|e| e.path == Self::OTACERTS_PATH.as_bytes())
else {
continue;
};
let CpioEntryData::Data(data) = &entry.data else {
continue;
};
let mut zip = ZipArchive::new(Cursor::new(&data)).map_err(|e| {
Error::ZipOpen(str::from_utf8(Self::OTACERTS_PATH).unwrap().into(), e)
})?;
let archive = ZipArchive::from_slice(data)
.map_err(|e| Error::ZipOpen(Self::OTACERTS_PATH.into(), e))?;
let mut entries = archive.entries_safe();
for index in 0..zip.len() {
let zip_entry = zip
.by_index(index)
.map_err(|e| Error::ZipIndexOpen(index, e))?;
if !zip_entry.name().ends_with(".x509.pem") {
debug!("Skipping invalid entry path: {}", zip_entry.name());
while let Some((cd_entry, entry)) = entries.next_entry().map_err(Error::ZipEntryList)? {
let path = cd_entry.file_path_utf8().map_err(Error::ZipEntryList)?;
if !path.ends_with(".x509.pem") {
debug!("Skipping invalid entry path: {path:?}");
continue;
}
let path = PathBuf::from(zip_entry.name());
let reader = zip::verifying_slice_reader(&entry, cd_entry.compression_method())
.map_err(|e| Error::ZipEntryOpen(path.to_owned().into(), e))?;
let certificate =
crypto::read_pem_cert(&path, zip_entry).map_err(Error::OtaCertLoad)?;
crypto::read_pem_cert(Path::new(path), reader).map_err(Error::OtaCertLoad)?;
certificates.push(certificate);
}
}
@@ -666,7 +712,10 @@ impl OtaCertPatcher {
cancel_signal: &AtomicBool,
) -> Result<bool> {
let (mut entries, ramdisk_format) = load_ramdisk(ramdisk, cancel_signal)?;
let Some(entry) = entries.iter_mut().find(|e| e.path == Self::OTACERTS_PATH) else {
let Some(entry) = entries
.iter_mut()
.find(|e| e.path == Self::OTACERTS_PATH.as_bytes())
else {
return Ok(false);
};
@@ -707,7 +756,10 @@ impl BootImagePatch for OtaCertPatcher {
let (entries, _) = load_ramdisk(ramdisk, cancel_signal)
.map_err(|e| TargetsError::Load(name.to_owned(), e))?;
if entries.iter().any(|e| e.path == Self::OTACERTS_PATH) {
if entries
.iter()
.any(|e| e.path == Self::OTACERTS_PATH.as_bytes())
{
targets.push(name);
continue 'outer;
}
@@ -742,7 +794,7 @@ impl BootImagePatch for OtaCertPatcher {
// out of future updates if the OTA certificate mechanism has changed.
Err(Error::Validation(format!(
"No ramdisk contains {:?}",
Self::OTACERTS_PATH.as_bstr(),
Self::OTACERTS_PATH,
)))
}
}
@@ -781,7 +833,7 @@ impl DsuPubKeyPatcher {
e.data = data;
} else {
entries.push(CpioEntry::new_file(Self::AVBROOT_KEY_PATH, 0o644, data));
};
}
*ramdisk = save_ramdisk(&entries, ramdisk_format, cancel_signal)?;
@@ -930,16 +982,17 @@ impl PrepatchedImagePatcher {
return Ok(None);
};
let kmi_version = captures
.iter()
// Capture #0 is the entire match.
.skip(1)
.flatten()
.map(|c| c.as_bytes())
// Our regex only matches ASCII bytes.
.map(|c| std::str::from_utf8(c).unwrap())
.collect::<Vec<_>>()
.join("-");
let kmi_version = util::join(
captures
.iter()
// Capture #0 is the entire match.
.skip(1)
.flatten()
.map(|c| c.as_bytes())
// Our regex only matches ASCII bytes.
.map(|c| std::str::from_utf8(c).unwrap()),
"-",
);
Ok(Some(kmi_version))
}
@@ -971,7 +1024,7 @@ impl BootImagePatch for PrepatchedImagePatcher {
targets.push("init_boot");
} else if boot_images.contains_key("boot") {
targets.push("boot");
};
}
Ok(targets)
}
@@ -1211,9 +1264,20 @@ fn save_boot_image(
Ok(())
}
pub trait BootImageOpener {
fn open_original(&self, name: &str) -> io::Result<Box<dyn ReadSeek + Sync>>;
fn open_replacement(&self, name: &str) -> io::Result<Box<dyn WriteSeek + Sync>> {
Err(io::Error::new(
io::ErrorKind::NotFound,
format!("{name} boot image not found"),
))
}
}
pub fn load_boot_images<'a>(
names: &[&'a str],
open_input: impl Fn(&str) -> io::Result<Box<dyn ReadSeek>> + Sync,
opener: &(dyn BootImageOpener + Sync),
) -> TargetsResult<HashMap<&'a str, BootImageInfo>> {
let parent_span = Span::current();
@@ -1221,8 +1285,9 @@ pub fn load_boot_images<'a>(
.par_iter()
.map(|&name| {
let _span = debug_span!(parent: &parent_span, "image", name).entered();
let mut reader =
open_input(name).map_err(|e| TargetsError::Open(name.to_owned(), e))?;
let mut reader = opener
.open_original(name)
.map_err(|e| TargetsError::Open(name.to_owned(), e))?;
let info =
load_boot_image(&mut reader).map_err(|e| TargetsError::Load(name.to_owned(), e))?;
@@ -1239,8 +1304,7 @@ pub fn load_boot_images<'a>(
/// be opened from multiple threads, but at most once each.
pub fn patch_boot_images<'a>(
names: &[&'a str],
open_input: impl Fn(&str) -> io::Result<Box<dyn ReadSeek>> + Sync,
open_output: impl Fn(&str) -> io::Result<Box<dyn WriteSeek>> + Sync,
opener: &(dyn BootImageOpener + Sync),
key: &RsaSigningKey,
patchers: &[Box<dyn BootImagePatch + Sync>],
cancel_signal: &AtomicBool,
@@ -1253,7 +1317,7 @@ pub fn patch_boot_images<'a>(
}
// Preparse all images. Some patchers need to inspect every candidate.
let mut images = load_boot_images(names, open_input)?;
let mut images = load_boot_images(names, opener)?;
// Find the targets that each patcher wants to patch.
let all_targets = patchers
@@ -1304,7 +1368,9 @@ pub fn patch_boot_images<'a>(
// Resign and write new images.
groups.par_iter_mut().try_for_each(|(&name, (info, _))| {
let _span = debug_span!(parent: &parent_span, "image", name).entered();
let mut writer = open_output(name).map_err(|e| TargetsError::Open(name.to_owned(), e))?;
let mut writer = opener
.open_replacement(name)
.map_err(|e| TargetsError::Open(name.to_owned(), e))?;
save_boot_image(&mut writer, info, key).map_err(|e| TargetsError::Save(name.to_owned(), e))
})?;
+32 -16
View File
@@ -1,15 +1,18 @@
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
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 {
@@ -18,7 +21,7 @@ pub enum Error {
#[error("New otacerts.zip is too large to fit in {0} bytes")]
ZipTooLarge(usize),
#[error("Failed to write otacerts zip")]
ZipWrite(#[source] ZipError),
ZipWrite(#[source] rawzip::Error),
#[error("Failed to write certificate to otacerts zip")]
CertWrite(#[source] crypto::Error),
}
@@ -71,17 +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);
let name = "ota.x509.pem";
writer.start_file(name, options).map_err(Error::ZipWrite)?;
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)
@@ -93,10 +102,10 @@ pub fn create_zip(cert: &Certificate, flags: OtaCertBuildFlags) -> Result<Vec<u8
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();
@@ -110,9 +119,16 @@ pub fn create_zip(cert: &Certificate, flags: OtaCertBuildFlags) -> Result<Vec<u8
Cow::Owned(modified)
};
crypto::write_pem_cert(Path::new(name), &mut writer, &cert).map_err(Error::CertWrite)?;
crypto::write_pem_cert(Path::new(name), &mut data_writer, &cert).map_err(Error::CertWrite)?;
let raw_writer = writer.finish().map_err(Error::ZipWrite)?;
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())
}
+36 -52
View File
@@ -1,27 +1,28 @@
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// 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 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, ReadFixedSizeExt, ReadSeekReopen, SectionReader, WriteSeekReopen},
stream::{self, ReadFixedSizeExt, ReadWriteAt, UserPosFile},
util,
};
@@ -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,8 +111,7 @@ 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: &RsaSigningKey,
cancel_signal: &AtomicBool,
@@ -122,8 +124,7 @@ pub fn patch_system_image(
let parent_span = Span::current();
let (mut header, footer, image_size) =
avb::load_image(input.reopen_boxed().map_err(Error::ReadData)?)
.map_err(Error::AvbUpdate)?;
avb::load_image(UserPosFile::new(raw_file)).map_err(Error::AvbUpdate)?;
let Some(mut footer) = footer else {
return Err(Error::NoFooter);
};
@@ -144,15 +145,13 @@ pub fn patch_system_image(
let offset = chunk * CHUNK_SIZE;
let size = CHUNK_SIZE.min(footer.original_image_size - offset);
let mut reader = input.reopen_boxed().map_err(Error::ReadData)?;
reader
.seek(SeekFrom::Start(offset))
let mut file = UserPosFile::new(raw_file);
file.seek(SeekFrom::Start(offset))
.map_err(Error::ReadData)?;
let buf = reader
let buf = file
.read_vec_exact(size as usize)
.map_err(Error::ReadData)?;
let mut writer = output.reopen_boxed().map_err(Error::WriteData)?;
let mut ranges = Vec::<Range<u64>>::new();
for eocd_offset_rel in memmem::find_iter(&buf, ota::ZIP_EOCD_MAGIC) {
@@ -171,10 +170,9 @@ pub fn patch_system_image(
stream::check_cancel(cancel_signal).map_err(Error::WriteData)?;
writer
.seek(SeekFrom::Start(bounds.start))
file.seek(SeekFrom::Start(bounds.start))
.map_err(Error::WriteData)?;
writer.write_all(&new_zip).map_err(Error::WriteData)?;
file.write_all(&new_zip).map_err(Error::WriteData)?;
ranges.push(bounds);
}
@@ -190,26 +188,12 @@ 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();
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())
};
// Only need to update the hash tree and FEC data corresponding to the
// modified regions.
let update_ranges = Some(modified_ranges.as_slice());
descriptor
.update(input, output, update_ranges, cancel_signal)
.update(raw_file, update_ranges, cancel_signal)
.map_err(Error::AvbUpdate)?;
if !header.public_key.is_empty() {
@@ -218,8 +202,8 @@ pub fn patch_system_image(
header.sign(key).map_err(Error::AvbUpdate)?;
}
let writer = output.reopen_boxed().map_err(Error::WriteData)?;
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) =
+1
View File
@@ -1,3 +1,4 @@
#![allow(clippy::all)]
#![allow(clippy::nursery)]
#![allow(clippy::pedantic)]
+315 -200
View File
@@ -1,12 +1,12 @@
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// 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,
},
};
@@ -15,39 +15,32 @@ 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 {
@@ -144,25 +137,121 @@ impl<R: Read> ReadFixedSizeExt for R {
}
}
/// 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>;
/// 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<R: Read + Reopen> Reopen for BufReader<R> {
fn reopen(&self) -> io::Result<Self> {
Ok(Self::new(self.get_ref().reopen()?))
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::UnexpectedEof,
format!(
"Expected to read {} bytes at {offset}, but reached EOF after {n} bytes",
buf.len(),
),
));
}
Ok(())
}
}
impl<W: Write + Reopen> Reopen for BufWriter<W> {
fn reopen(&self) -> io::Result<Self> {
Ok(Self::new(self.get_ref().reopen()?))
}
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)
}
}
};
}
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<()>;
}
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> {
@@ -320,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;
@@ -370,93 +451,179 @@ impl<R: Read + Seek> Seek for SectionReader<R> {
}
}
/// 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,
/// A reader wrapper that only allows reading a specific section of a file.
pub struct SectionReaderAt<R> {
inner: R,
start: u64,
size: u64,
}
impl PSeekFile {
pub fn new(file: File) -> Self {
Self {
file: Arc::new(RwLock::new(file)),
offset: 0,
}
impl<R: ReadAt> SectionReaderAt<R> {
pub fn new(inner: R, start: u64, size: u64) -> io::Result<Self> {
Ok(Self { inner, start, size })
}
pub fn set_len(&self, size: u64) -> io::Result<()> {
let file_locked = self.file.read().unwrap();
file_locked.set_len(size)
pub fn into_inner(self) -> R {
self.inner
}
}
impl<R> FileLen for SectionReaderAt<R> {
fn file_len(&self) -> io::Result<u64> {
Ok(self.size)
}
}
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)
}
}
/// 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))
@@ -485,70 +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()
}
}
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.
@@ -603,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];
@@ -622,6 +727,8 @@ pub fn copy(
break;
}
inspect(&buf[..n]);
writer.write_all(&buf[..n])?;
copied += n as u64;
@@ -630,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::{
@@ -639,10 +751,9 @@ mod tests {
use ring::digest::Context;
use super::{
CountingReader, CountingWriter, HashingReader, HashingWriter, PSeekFile, ReadDiscardExt,
Reopen, SectionReader, SharedCursor, 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,
@@ -767,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");
@@ -776,94 +887,98 @@ mod tests {
}
#[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();
fn section_reader_at() {
let raw_reader = MutexFile::new(Cursor::new(b"fooinnerbar"));
let reader = SectionReaderAt::new(raw_reader, 3, 5).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; 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 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);
}
}
+98 -12
View File
@@ -1,13 +1,14 @@
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
cmp::Ordering,
fmt, mem,
fmt::{self, Display},
mem,
ops::{
Bound, Range, RangeBounds, RangeFrom, RangeFull, RangeInclusive, RangeTo, RangeToInclusive,
},
path::Path,
path::{Component, Path, PathBuf},
};
use num_traits::{NumCast, PrimInt};
@@ -303,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
@@ -325,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);
@@ -378,6 +440,30 @@ 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::*;
+16 -14
View File
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
use std::{
@@ -18,7 +18,7 @@ use avbroot::{
ChainPartitionDescriptor, Descriptor, Footer, HashDescriptor, HashTreeDescriptor, Header,
KernelCmdlineDescriptor, PropertyDescriptor,
},
stream::SharedCursor,
stream::{MutexFile, UserPosFile},
};
fn get_test_key() -> RsaSigningKey {
@@ -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,10 +335,10 @@ 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!(
@@ -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,10 +443,10 @@ 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!(
+4 -3
View File
@@ -37,8 +37,8 @@ allow = [
"GPL-3.0",
"ISC",
"MIT",
"OpenSSL",
"Unicode-3.0",
"Zlib",
]
[[licenses.clarify]]
@@ -63,12 +63,13 @@ include-workspace = true
bypass = [
# Copies of unmodified crashwrangler objects for old macOS versions.
{ name = "honggfuzz", allow-globs = ["honggfuzz/third_party/mac/CrashReport_*.o"] },
# Only used in tests.
{ name = "libloading", allow-globs = ["tests/nagisa*.dll"] },
]
[sources]
unknown-registry = "deny"
unknown-git = "deny"
allow-git = [
"https://github.com/chenxiaolong/zip",
"https://github.com/trifectatechfoundation/bzip2-rs",
"https://github.com/chenxiaolong/system-properties",
]
+3 -11
View File
@@ -14,24 +14,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"
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
+30 -25
View File
@@ -12,8 +12,11 @@ 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_algo = "Lz4"
[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
@@ -49,18 +52,21 @@ data.version = "vendor_v4"
data.ramdisks = [["otacerts", "first_stage", "dsu_key_dir"]]
[profile.pixel_v4_gki.hashes_streaming]
original = "c00f891f941f3dddb28966f7b07f3acea773bee104dace82b37c2d1341f09422"
patched = "ce9d8ee97828d233809742a5d3f23aa27b042675b1935ca9e3df0592c55788fd"
original = "ea96196191e3a4133db4aff45d47aa3468514e29e0a724faac8081cbf4adf808"
patched = "357a448d1a7505b2308ce1c2d19b063e606c60e7349784913a48cdc3f6d50aa4"
[profile.pixel_v4_gki.hashes_seekable]
original = "96a6c366b5de1c3b10d4d6cb4ca503c83ac4cd9ca952a965cceb041990ba7022"
patched = "e7b4609ba7a23609211dcae143bc43f091f286fbbb3a9301c02ee25614d35deb"
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_algo = "Lz4"
[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
@@ -90,18 +96,20 @@ data.version = "vendor_v4"
data.ramdisks = [["init", "otacerts", "first_stage", "dsu_key_dir"], ["dlkm"]]
[profile.pixel_v4_non_gki.hashes_streaming]
original = "4d692bc777b568b0626d3c08d2e6f83f1b472db5ad903486daaec6a78d0cc26e"
patched = "e27673e4f30933710c11d51f0e73849068cbe9bc9f54e6076bdd93f9a5c8ea0a"
original = "cb2a2e406d2b4c68c8a38f819256a10ada0ed5a4732822bec35bdf7bcdc458eb"
patched = "12f15d29fceeb18af14c9a805de3aedb7f270fe8ec316d9d0fe37fb0c667eacd"
[profile.pixel_v4_non_gki.hashes_seekable]
original = "ea27ecd9718c17b63400b2548680bb3cee93ce63b4fc44ff9654ca0d9c5372a8"
patched = "3456b14e014cf565a808a9e834d9105a23539f07b2c460db19c9384aadbc3b93"
original = "9450c212c34fe55453b52345c7cc22f72397dc80d9ddc792eafc20b461c2afc9"
patched = "5018c579df9608f9dfe3add2afd8b176de61ba267376cf3a3e422ecc9d3dd112"
# Google Pixel 4a 5G
# What's unique: boot (boot v3) + vendor_boot (vendor v3)
[profile.pixel_v3]
vabc_algo = "Lz4"
[profile.pixel_v3.vabc]
version = "V2"
algo = { kind = "Gz" }
force_compression_factor = false
[profile.pixel_v3.partitions.boot]
avb.signed = true
@@ -132,19 +140,16 @@ data.version = "vendor_v3"
data.ramdisks = [["otacerts", "first_stage", "dsu_key_dir"]]
[profile.pixel_v3.hashes_streaming]
original = "f432dc7931520feb238474aa707dd5299747562ffe6129f3f763b5f11ac473ab"
patched = "3850a2e73bd783a1ec4a70c59f37d2374e017c20df7ab4b591182b14d187c18e"
original = "4b864b906a13ec98b1d6c3440a5eca7404ec63d073080e80a3b84afabcbd2fa2"
patched = "a9077fe32dee8eb7a0369c1334d8f3378ae8044814ae04da700f33294b12a4d8"
[profile.pixel_v3.hashes_seekable]
original = "7d29ecc6780953c22052a576b8dc85066c8667a875e918a786a08ff4545b47d1"
patched = "9f6342940b7cfbeb27b0567f006bb35cbee910ef038ec535403c662d5252ca71"
original = "e0e93ee11de56992f3a5f543858c1d11858b4deb76a91a4caf4fb0f3f34be855"
patched = "8730b398367179a0be092a67e4714f09c2267c656fe3e42ec1f8b43bb3a28634"
# Google Pixel 4a
# What's unique: boot (boot v2)
[profile.pixel_v2]
vabc_algo = "Gzip"
[profile.pixel_v2.partitions.boot]
avb.signed = false
data.type = "boot"
@@ -168,9 +173,9 @@ data.type = "vbmeta"
data.deps = ["system"]
[profile.pixel_v2.hashes_streaming]
original = "1b45235b58054009cc496f6c3ee11d3dc16ed5c388c861761e26a6fce83103a0"
patched = "193b2dc70dd465d686f35c7b7f74d2cc1b06a55e48cf5c2e4df0f667e03032fc"
original = "abc0ad7f80020018101437c2494d6564a877df663d208a123267fc100734c175"
patched = "b1876455f5be9d5b6eafc598a017ad10e5e76339137f8b29777097ab19cdc3b0"
[profile.pixel_v2.hashes_seekable]
original = "52284308fae10cbaf09ade14e92f3bbe6149751a42bff15432982fcef8d890ab"
patched = "7ad74ac87ddcaf34938017e6149a646041d70926e31ecda93e156e9397467b3b"
original = "57d4ac5ab7d362a593f3c02f3d2044b5400c10db0f732741a2d18e025d4231ec"
patched = "40d7674be14e19747e7ead118e0f4faf50880c638dfb4bfc0d0154b0e9202d3f"
+22 -14
View File
@@ -1,14 +1,14 @@
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// 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::VabcAlgo;
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",
@@ -17,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,
@@ -29,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,
@@ -55,7 +55,7 @@ pub enum BootVersion {
VendorV4,
}
#[derive(Serialize, Deserialize)]
#[derive(Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct BootData {
pub version: BootVersion,
@@ -71,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),
@@ -91,30 +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 VabcSettings {
pub version: CowVersion,
pub algo: VabcAlgo,
pub force_compression_factor: bool,
}
#[derive(Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Profile {
pub vabc_algo: Option<VabcAlgo>,
pub vabc: Option<VabcSettings>,
pub partitions: BTreeMap<String, Partition>,
pub hashes_streaming: Hashes,
pub hashes_seekable: Hashes,
}
#[derive(Serialize, Deserialize)]
#[derive(Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Config {
pub ota_info: OtaInfo,
+130 -101
View File
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: 2023-2024 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023 Pascal Roeleven
// SPDX-License-Identifier: GPL-3.0-only
@@ -14,12 +14,12 @@ use std::{
path::{Path, PathBuf},
slice,
sync::{
atomic::{AtomicBool, Ordering},
Arc,
atomic::{AtomicBool, Ordering},
},
};
use anyhow::{anyhow, bail, Context, Result};
use anyhow::{Context, Result, anyhow, bail};
use avbroot::{
cli::ota::{ExtractCli, PatchCli, VerifyCli},
crypto::{self, PassphraseSource, RsaSigningKey},
@@ -36,24 +36,26 @@ use avbroot::{
cpio::{self, CpioEntry, CpioEntryData},
ota::{self, SigningWriter, ZipEntry, ZipMode},
padding,
payload::{self, PayloadHeader, PayloadWriter},
payload::{self, CowVersion, PayloadHeader, PayloadWriter, VabcParams},
zip,
},
patch::otacert::{self, OtaCertBuildFlags},
protobuf::{
build::tools::releasetools::{ota_metadata::OtaType, DeviceState, OtaMetadata},
build::tools::releasetools::{DeviceState, OtaMetadata, ota_metadata::OtaType},
chromeos_update_engine::{
DeltaArchiveManifest, DynamicPartitionGroup, DynamicPartitionMetadata, PartitionUpdate,
},
},
stream::{self, CountingWriter, FromReader, HashingReader, PSeekFile, Reopen, ToWriter},
stream::{self, FromReader, HashingReader, ToWriter},
util,
};
use clap::Parser;
use rsa::{rand_core::OsRng, traits::PublicKeyParts, BigUint};
use rawzip::{CompressionMethod, ZipArchiveWriter};
use rsa::{BigUint, rand_core::OsRng, traits::PublicKeyParts};
use tempfile::TempDir;
use topological_sort::TopologicalSort;
use tracing::{info, info_span};
use x509_cert::Certificate;
use zip::{write::FileOptions, CompressionMethod, ZipWriter};
use crate::{
cli::{Cli, Command, HelperCli, ListCli, PassSource, ProfileGroup, TestCli},
@@ -95,15 +97,15 @@ fn verify_hash(path: &Path, sha256: &[u8; 32], cancel_signal: &AtomicBool) -> Re
}
fn append_avb(
file: &mut PSeekFile,
file: &File,
name: &str,
avb: &Avb,
avb: Avb,
hash_tree: bool,
ota_info: &OtaInfo,
key_avb: &RsaSigningKey,
cancel_signal: &AtomicBool,
) -> Result<()> {
let image_size = file.seek(SeekFrom::End(0))?;
let image_size = (&*file).seek(SeekFrom::End(0))?;
let salt = ring::digest::digest(&ring::digest::SHA256, b"avbroot");
let descriptors = vec![
if hash_tree {
@@ -125,7 +127,7 @@ fn append_avb(
reserved: [0u8; 60],
};
descriptor.update(file, file, None, cancel_signal)?;
descriptor.update(file, None, cancel_signal)?;
Descriptor::HashTree(descriptor)
} else {
@@ -139,8 +141,8 @@ fn append_avb(
reserved: [0u8; 60],
};
file.rewind()?;
descriptor.update(&mut *file, cancel_signal)?;
(&*file).rewind()?;
descriptor.update(file, cancel_signal)?;
Descriptor::Hash(descriptor)
},
@@ -188,7 +190,7 @@ fn append_avb(
reserved: Default::default(),
};
let eof_size = file.seek(SeekFrom::End(0))?;
let eof_size = (&*file).seek(SeekFrom::End(0))?;
let full_image_size = eof_size
.checked_add(8192)
.and_then(|s| padding::round(s, 4096))
@@ -293,9 +295,9 @@ fn create_ramdisk(
#[allow(clippy::too_many_arguments)]
fn create_boot_image(
file: &mut PSeekFile,
file: &File,
name: &str,
avb: &Avb,
avb: Avb,
boot_data: &BootData,
ota_info: &OtaInfo,
key_avb: &RsaSigningKey,
@@ -374,7 +376,7 @@ fn create_boot_image(
.ramdisks
.iter()
.map(|c_list| {
if c_list.iter().any(|c| *c == RamdiskContent::Dlkm) {
if c_list.contains(&RamdiskContent::Dlkm) {
RamdiskMeta {
ramdisk_type: bootimage::VENDOR_RAMDISK_TYPE_DLKM,
ramdisk_name: "dlkm".to_owned(),
@@ -410,7 +412,7 @@ fn create_boot_image(
}
};
boot_image.to_writer(&mut *file)?;
boot_image.to_writer(file)?;
append_avb(file, name, avb, false, ota_info, key_avb, cancel_signal)
.with_context(|| format!("Failed to append AVB metadata for {name}"))?;
@@ -420,10 +422,10 @@ fn create_boot_image(
#[allow(clippy::too_many_arguments)]
fn create_dm_verity_image(
file: &mut PSeekFile,
file: &File,
name: &str,
avb: &Avb,
dm_verity_data: &DmVerityData,
avb: Avb,
dm_verity_data: DmVerityData,
ota_info: &OtaInfo,
key_avb: &RsaSigningKey,
cert_ota: &Certificate,
@@ -431,16 +433,16 @@ fn create_dm_verity_image(
) -> Result<()> {
match dm_verity_data.content {
DmVerityContent::SystemOtacerts => {
file.write_all(b"arbitrary_prefix")?;
(&*file).write_all(b"arbitrary_prefix")?;
let data = otacert::create_zip(cert_ota, OtaCertBuildFlags::empty())?;
file.write_all(&data)?;
(&*file).write_all(&data)?;
file.write_all(b"arbitrary_suffix")?;
(&*file).write_all(b"arbitrary_suffix")?;
}
}
padding::write_zeros(&mut *file, 4096)?;
padding::write_zeros(file, 4096)?;
append_avb(file, name, avb, true, ota_info, key_avb, cancel_signal)
.with_context(|| format!("Failed to append AVB metadata for {name}"))?;
@@ -449,19 +451,18 @@ fn create_dm_verity_image(
}
fn create_vbmeta_image(
file: &mut PSeekFile,
file: &File,
name: &str,
avb: &Avb,
avb: Avb,
vbmeta_data: &VbmetaData,
inputs: &BTreeMap<String, PSeekFile>,
inputs: &BTreeMap<String, File>,
key: &RsaSigningKey,
) -> Result<()> {
let mut descriptors = Vec::new();
for dep in &vbmeta_data.deps {
let reader = inputs[dep].reopen()?;
let (child_header, _, _) =
avb::load_image(reader).with_context(|| format!("Failed to parse AVB image: {dep}"))?;
let (child_header, _, _) = avb::load_image(&inputs[dep])
.with_context(|| format!("Failed to parse AVB image: {dep}"))?;
if child_header.public_key.is_empty() {
descriptors.extend(child_header.descriptors);
@@ -509,7 +510,7 @@ fn create_partition_images(
key_avb: &RsaSigningKey,
cert_ota: &Certificate,
cancel_signal: &AtomicBool,
) -> Result<BTreeMap<String, PSeekFile>> {
) -> Result<BTreeMap<String, File>> {
let mut topo = TopologicalSort::<&String>::new();
for (name, partition) in partitions {
@@ -528,16 +529,15 @@ fn create_partition_images(
};
let partition = &partitions[name];
let mut file = tempfile::tempfile()
.map(PSeekFile::new)
let file = tempfile::tempfile()
.with_context(|| format!("Failed to create temp file for {name}"))?;
match &partition.data {
Data::Boot(data) => {
create_boot_image(
&mut file,
&file,
name,
&partition.avb,
partition.avb,
data,
ota_info,
key_avb,
@@ -548,10 +548,10 @@ fn create_partition_images(
}
Data::DmVerity(data) => {
create_dm_verity_image(
&mut file,
&file,
name,
&partition.avb,
data,
partition.avb,
*data,
ota_info,
key_avb,
cert_ota,
@@ -560,7 +560,7 @@ fn create_partition_images(
.with_context(|| format!("Failed to create dm-verity image: {name}"))?;
}
Data::Vbmeta(data) => {
create_vbmeta_image(&mut file, name, &partition.avb, data, &files, key_avb)
create_vbmeta_image(&file, name, partition.avb, data, &files, key_avb)
.with_context(|| format!("Failed to create vbmeta image: {name}"))?;
}
}
@@ -574,7 +574,7 @@ fn create_partition_images(
fn create_payload(
writer: impl Write,
partitions: &BTreeMap<String, Partition>,
inputs: &BTreeMap<String, PSeekFile>,
inputs: &BTreeMap<String, File>,
ota_info: &OtaInfo,
profile: &Profile,
key_ota: &RsaSigningKey,
@@ -587,24 +587,30 @@ fn create_payload(
.collect::<Vec<_>>();
let mut payload_partitions = vec![];
let mut compressed = BTreeMap::<&String, PSeekFile>::new();
let mut compressed = BTreeMap::<&String, File>::new();
for (name, file) in inputs {
let writer = tempfile::tempfile()
.map(PSeekFile::new)
.with_context(|| format!("Failed to create temp file for: {name}"))?;
let vabc_algo = if dynamic_partitions_names.contains(name) {
profile.vabc_algo
let vabc_params = if dynamic_partitions_names.contains(name) {
profile.vabc.map(|v| VabcParams {
version: v.version,
algo: v.algo,
})
} else {
None
};
let (partition_info, operations, cow_estimate) =
payload::compress_image(file, &writer, name, 4096, vabc_algo, cancel_signal)?;
payload::compress_image(file, &writer, name, 4096, vabc_params, cancel_signal)?;
compressed.insert(name, writer);
let is_v3 = profile
.vabc
.is_some_and(|e| matches!(e.version, CowVersion::V3 { .. }));
payload_partitions.push(PartitionUpdate {
partition_name: name.clone(),
run_postinstall: None,
@@ -624,8 +630,8 @@ fn create_payload(
fec_roots: None,
version: None,
merge_operations: vec![],
estimate_cow_size: cow_estimate,
estimate_op_count_max: None,
estimate_cow_size: cow_estimate.map(|e| e.size),
estimate_op_count_max: cow_estimate.and_then(|e| is_v3.then_some(e.num_ops)),
});
}
@@ -645,11 +651,19 @@ fn create_payload(
partition_names: dynamic_partitions_names,
}],
snapshot_enabled: Some(true),
vabc_enabled: Some(true),
vabc_compression_param: profile.vabc_algo.map(|a| a.to_string()),
cow_version: Some(2),
// Everything below is meant to be unset if VABC is not
// supported.
vabc_enabled: profile.vabc.map(|_| true),
vabc_compression_param: profile.vabc.map(|v| v.algo.to_string()),
cow_version: profile.vabc.map(|v| match v.version {
CowVersion::V2 => 2,
CowVersion::V3 { .. } => 3,
}),
vabc_feature_set: None,
compression_factor: None,
compression_factor: profile.vabc.and_then(|v| match v.version {
CowVersion::V2 => v.force_compression_factor.then_some(64 * 1024),
CowVersion::V3 { compression_factor } => Some(compression_factor.into()),
}),
}),
partial_update: None,
apex_info: vec![],
@@ -725,42 +739,32 @@ fn create_ota(
.truncate(true)
.open(output)
.with_context(|| format!("Failed to open for writing: {output:?}"))?;
let mut zip_writer = match zip_mode {
ZipMode::Streaming => {
let signing_writer = SigningWriter::new_streaming(raw_writer);
ZipWriter::new_streaming(signing_writer)
}
ZipMode::Seekable => {
let signing_writer = SigningWriter::new_seekable(raw_writer);
ZipWriter::new(signing_writer)
}
let signing_writer = match zip_mode {
ZipMode::Streaming => SigningWriter::new_streaming(raw_writer),
ZipMode::Seekable => SigningWriter::new_seekable(raw_writer),
};
let options = FileOptions::default()
.compression_method(CompressionMethod::Stored)
.large_file(false);
let mut zip_writer = ZipArchiveWriter::new(signing_writer);
let mut entries = vec![];
let mut properties = None;
let mut payload_metadata_size = None;
for path in [ota::PATH_OTACERT, ota::PATH_PAYLOAD, ota::PATH_PROPERTIES] {
// All remaining entries are written immediately.
zip_writer
.start_file_with_extra_data(path, options)
let (entry_writer, data_config) = zip_writer
.new_file(path)
.start()
.with_context(|| format!("Failed to begin new zip entry: {path}"))?;
let offset = zip_writer
.end_extra_data()
.with_context(|| format!("Failed to end new zip entry: {path}"))?;
let mut writer = CountingWriter::new(&mut zip_writer);
let offset = entry_writer.stream_offset();
let mut data_writer = data_config.wrap(entry_writer);
match path {
ota::PATH_OTACERT => {
crypto::write_pem_cert(Path::new(path), &mut writer, cert_ota)
crypto::write_pem_cert(Path::new(path), &mut data_writer, cert_ota)
.with_context(|| format!("Failed to write entry: {path}"))?;
}
ota::PATH_PAYLOAD => {
let (p, m) = create_payload(
&mut writer,
&mut data_writer,
&profile.partitions,
&inputs,
ota_info,
@@ -774,18 +778,20 @@ fn create_ota(
payload_metadata_size = Some(m);
}
ota::PATH_PROPERTIES => {
writer
data_writer
.write_all(properties.as_ref().unwrap().as_bytes())
.with_context(|| format!("Failed to write payload properties: {path}"))?;
}
_ => unreachable!(),
}
// Cannot fail.
let size = writer.stream_position()?;
let size = data_writer
.finish()
.and_then(|(w, d)| w.finish(d))
.with_context(|| format!("Failed to finalize zip entry: {path}"))?;
entries.push(ZipEntry {
name: path.to_owned(),
path: path.to_owned(),
offset,
size,
});
@@ -819,18 +825,15 @@ fn create_ota(
spl_downgrade: false,
};
let data_descriptor_size = match zip_mode {
ZipMode::Streaming => 16,
ZipMode::Seekable => 0,
};
let next_offset = zip_writer.stream_offset();
ota::add_metadata(
&entries,
&mut zip_writer,
// Offset where next entry would begin.
entries.last().map(|e| e.offset + e.size).unwrap() + data_descriptor_size,
next_offset,
&metadata,
payload_metadata_size.unwrap(),
zip_mode,
)
.context("Failed to write new OTA metadata")?;
@@ -848,12 +851,19 @@ fn create_ota(
}
fn create_fake_magisk(output: &Path) -> Result<()> {
let raw_writer =
File::create(output).with_context(|| format!("Failed to open for writing: {output:?}"))?;
let mut zip_writer = ZipWriter::new(raw_writer);
let raw_writer = OpenOptions::new()
.read(true)
.write(true)
.create(true)
.truncate(true)
.open(output)
.with_context(|| format!("Failed to open for writing: {output:?}"))?;
let mut zip_writer = ZipArchiveWriter::new(raw_writer);
let compression_method = CompressionMethod::Deflate;
for path in [
"assets/stub.apk",
"assets/util_functions.sh",
"lib/arm64-v8a/libinit-ld.so",
"lib/arm64-v8a/libmagisk64.so",
"lib/arm64-v8a/libmagiskinit.so",
@@ -867,13 +877,31 @@ fn create_fake_magisk(output: &Path) -> Result<()> {
"lib/x86_64/libmagisk64.so",
"lib/x86_64/libmagiskinit.so",
] {
zip_writer.start_file(path, FileOptions::default())?;
write!(zip_writer, "dummy contents for {path}")?;
let (entry_writer, data_config) = zip_writer
.new_file(path)
.compression_method(compression_method)
.start()
.with_context(|| format!("Failed to begin new zip entry: {path}"))?;
let compressed_writer = zip::compressed_writer(entry_writer, compression_method)
.with_context(|| format!("Failed to begin new zip entry: {path}"))?;
let mut data_writer = data_config.wrap(compressed_writer);
if path == "assets/util_functions.sh" {
// avbroot looks for the version number in this file.
data_writer.write_all(b"MAGISK_VER_CODE=27000\n")?;
} else {
write!(data_writer, "dummy contents for {path}")?;
}
data_writer
.finish()
.and_then(|(w, d)| w.finish()?.finish(d))?;
}
// avbroot looks for the version number in this file.
zip_writer.start_file("assets/util_functions.sh", FileOptions::default())?;
zip_writer.write_all(b"MAGISK_VER_CODE=27000\n")?;
let raw_writer = zip_writer.finish()?;
zip::make_non_streaming(raw_writer)
.with_context(|| format!("Failed to convert to non-streaming zip: {output:?}"))?;
Ok(())
}
@@ -1127,7 +1155,7 @@ fn clean_boot_image_certs(path: &Path, cancel_signal: &AtomicBool) -> Result<()>
.iter_mut()
.find(|e| e.path == b"system/etc/security/otacerts.zip")
{
let mut zip_writer = ZipWriter::new(Cursor::new(Vec::new()));
let zip_writer = ZipArchiveWriter::new(Cursor::new(Vec::new()));
let empty_zip = zip_writer.finish()?.into_inner();
entry.data = CpioEntryData::Data(empty_zip);
@@ -1189,6 +1217,7 @@ fn test_subcommand(cli: &TestCli, cancel_signal: &AtomicBool) -> Result<()> {
Some(_) => None,
None => Some(TempDir::new().context("Failed to create temp directory")?),
};
#[allow(clippy::option_if_let_else)]
let work_dir = match &cli.config.work_dir {
Some(w) => w.as_path(),
None => work_temp_dir.as_ref().unwrap().path(),
@@ -1208,10 +1237,6 @@ fn test_subcommand(cli: &TestCli, cancel_signal: &AtomicBool) -> Result<()> {
];
for name in profiles {
if Path::new(name).file_name() != Some(OsStr::new(name)) {
bail!("Unsafe profile name: {name}");
}
let profile = &config.profile[name];
for (zip_mode, hashes) in [
@@ -1220,8 +1245,9 @@ fn test_subcommand(cli: &TestCli, cancel_signal: &AtomicBool) -> Result<()> {
] {
let _span = info_span!("profile", name, %zip_mode).entered();
// Can't used NamedTempFile because avbroot does atomic replaces.
let profile_dir = work_dir.join(name);
// Can't use NamedTempFile because avbroot does atomic replaces.
let mut profile_dir = util::path_join_single(work_dir, name)?;
profile_dir.push(zip_mode.to_string());
let out_original = profile_dir.join("ota.zip");
let out_magisk = profile_dir.join("ota_magisk.zip");
let out_prepatched = profile_dir.join("ota_prepatched.zip");
@@ -1324,7 +1350,7 @@ fn helper_mode() -> Result<()> {
let cli = HelperCli::parse();
let private_key_path = {
let parent = cli.public_key.parent().unwrap_or(Path::new("."));
let parent = cli.public_key.parent().unwrap_or_else(|| Path::new("."));
let name = cli
.public_key
.file_name()
@@ -1398,7 +1424,10 @@ fn main() -> Result<()> {
if env::var_os(ENV_HELPER_MODE).is_some() {
return helper_mode();
}
env::set_var(ENV_HELPER_MODE, "true");
// SAFETY: No multithreading at this point.
unsafe {
env::set_var(ENV_HELPER_MODE, "true");
}
// Set up a cancel signal so we can properly clean up any temporary files.
let cancel_signal = Arc::new(AtomicBool::new(false));
+6 -4
View File
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// SPDX-FileCopyrightText: 2023-2025 Andrew Gunnerson
// SPDX-License-Identifier: GPL-3.0-only
#[cfg(not(windows))]
@@ -7,7 +7,7 @@ mod fuzz {
use avbroot::{
format::fec::FecImage,
stream::{FromReader, SharedCursor, WriteZerosExt},
stream::{FromReader, MutexFile, UserPosFile, WriteZerosExt},
};
use honggfuzz::fuzz;
@@ -18,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);
+1 -1
View File
@@ -12,7 +12,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
+4 -4
View File
@@ -1,15 +1,15 @@
// SPDX-FileCopyrightText: 2023 Andrew Gunnerson
// 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;
@@ -108,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 -2
View File
@@ -7,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;