Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crazystylus/otadump
Extract partitions from Android OTA files.
https://github.com/crazystylus/otadump
android hacktoberfest rust
Last synced: 8 days ago
JSON representation
Extract partitions from Android OTA files.
- Host: GitHub
- URL: https://github.com/crazystylus/otadump
- Owner: crazystylus
- License: mit
- Created: 2023-03-13T18:08:46.000Z (over 1 year ago)
- Default Branch: mainline
- Last Pushed: 2024-09-29T05:11:48.000Z (about 1 month ago)
- Last Synced: 2024-10-23T06:09:10.751Z (15 days ago)
- Topics: android, hacktoberfest, rust
- Language: Rust
- Homepage:
- Size: 1.56 MB
- Stars: 134
- Watchers: 5
- Forks: 18
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# otadump
[![crates.io][crates.io-badge]][crates.io]
**`otadump` helps you extract partitions from Android OTA files.**
Partitions can be individually flashed to your device using `fastboot`.
Compared to other tools, `otadump` is significantly faster and handles file
verification - no fear of a bad OTA file bricking your device.
![Demo][demo]
## Features
| | [crazystylus/otadump] | [ssut/payload-dumper-go] | [vm03/payload_dumper] |
| ---------------------------- | --------------------- | ------------------------ | ----------------------------------------- |
| Input file verification | ✔ | ✔ | |
| Output file verification | ✔ | | |
| Extract selective partitions | ✔ | ✔ | ✔ |
| Parallelized extraction | ✔ | ✔ | |
| Runs directly on .zip files | ✔ | ✔ | |
| Incremental OTA support | | | [Partial][payload_dumper-incremental-ota] |
## Benchmarks
Comparing the time taken to extract all partitions from a few sample files
(lower is better):
![Benchmarks][benchmarks]
**Note:** `otadump` was run with args `--no-verify -c 12` and `payload-dumper-go` was run with args `-c 12`
System specifications:
- Processor: AMD Ryzen 5 5600X (12) @ 3.700GHz
- RAM: 16 GiB
- OS: Pop!_OS 22.04 / Linux 6.0.6
- SSD: Samsung 970 EVO 250GB
## Installation
### macOS / Linux
Install a pre-built binary:
```sh
curl -sS https://raw.githubusercontent.com/crazystylus/otadump/mainline/install.sh | bash
```
Otherwise, using Cargo:
```sh
# Needs LZMA, Protobuf and pkg-config libraries installed.
# - On macOS: brew install protobuf xz pkg-config
# - On Debian / Ubuntu: apt install liblzma-dev protobuf-compiler pkg-config
cargo install --locked otadump
```
### Windows
Download the pre-built binary from the [Releases] page. Extract it and run the
`otadump.exe` file.
## Usage
Run the following command in your terminal:
```sh
# Run directly on .zip file.
otadump ota.zip
# Run on payload.bin file.
otadump payload.bin
```
## Contributors
- [Kartik Sharma][crazystylus]
- [Ajeet D'Souza][ajeetdsouza]
[ajeetdsouza]: https://github.com/ajeetdsouza
[benchmarks]: contrib/benchmarks.svg
[crates.io-badge]: https://img.shields.io/crates/v/otadump?logo=rust&logoColor=white&style=flat-square
[crates.io]: https://crates.io/crates/otadump
[crazystylus]: https://github.com/crazystylus
[crazystylus/otadump]: https://github.com/crazystylus/otadump
[demo]: contrib/demo.gif
[payload_dumper-incremental-ota]: https://github.com/vm03/payload_dumper/issues/53
[releases]: https://github.com/crazystylus/otadump/releases
[ssut/payload-dumper-go]: https://github.com/ssut/payload-dumper-go
[vm03/payload_dumper]: https://github.com/vm03/payload_dumper