Compare commits
120 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5b4be5d5cd | ||
|
|
586964128f | ||
|
|
042ca89f12 | ||
|
|
c6b12008a8 | ||
|
|
2bd0b2ca87 | ||
|
|
1589ee9da5 | ||
|
|
d39e98695d | ||
|
|
34d5811420 | ||
|
|
86e28a6e25 | ||
|
|
9f113bdb93 | ||
|
|
8670d6db58 | ||
|
|
0732a0bbad | ||
|
|
b5673001ca | ||
|
|
81829c1523 | ||
|
|
b9d2b8374f | ||
|
|
5716784f5d | ||
|
|
b6ddc720d8 | ||
|
|
5438e53361 | ||
|
|
39a7f0a8cf | ||
|
|
4129d9d218 | ||
|
|
c23dca61d7 | ||
|
|
2bc338fdf5 | ||
|
|
728fb7da95 | ||
|
|
2e762400e5 | ||
|
|
c85c76228d | ||
|
|
e91a35b3ff | ||
|
|
8f979eff91 | ||
|
|
af51584736 | ||
|
|
864bde01f6 | ||
|
|
8361a0fe06 | ||
|
|
218ec3d679 | ||
|
|
4b817c0435 | ||
|
|
2dd30931f2 | ||
|
|
8b4602c62f | ||
|
|
e917a45670 | ||
|
|
b0303ad544 | ||
|
|
f3f95d92c2 | ||
|
|
886adfa392 | ||
|
|
cdf062c3e1 | ||
|
|
b8e3d02311 | ||
|
|
1b7efc1cc6 | ||
|
|
ad064a9f41 | ||
|
|
d0e0f46571 | ||
|
|
727f3a3eb4 | ||
|
|
ab77db5cc8 | ||
|
|
1255f2b5d6 | ||
|
|
eb04f9064c | ||
|
|
69107e2333 | ||
|
|
17bb77a472 | ||
|
|
f211023b24 | ||
|
|
728d9603dc | ||
|
|
00c387d85c | ||
|
|
79d96d4c76 | ||
|
|
dc909ceda6 | ||
|
|
cbba912483 | ||
|
|
38d8384b98 | ||
|
|
39591b6a0a | ||
|
|
775b2421ec | ||
|
|
62d16b70fb | ||
|
|
466d00e68a | ||
|
|
144072ba1b | ||
|
|
331ef95530 | ||
|
|
61408cb470 | ||
|
|
c54942f25d | ||
|
|
3feda38cc3 | ||
|
|
9002ecc0c8 | ||
|
|
5a3ac68fce | ||
|
|
5dfd30cc5b | ||
|
|
66d124475d | ||
|
|
8c382f0bde | ||
|
|
b933ab083f | ||
|
|
2f4d13bd29 | ||
|
|
9eeb8f7da8 | ||
|
|
152836fe54 | ||
|
|
507796887b | ||
|
|
2f08e5e16d | ||
|
|
6a2d652f60 | ||
|
|
b7ae0b1155 | ||
|
|
ec0ae681ac | ||
|
|
61ba07ecf0 | ||
|
|
c835f20263 | ||
|
|
b51965f5af | ||
|
|
66b0e4c71c | ||
|
|
cb23fd6155 | ||
|
|
d932e93d0b | ||
|
|
e60ae7434b | ||
|
|
005d864609 | ||
|
|
4d8e5d9367 | ||
|
|
cff0e68f46 | ||
|
|
266265ca35 | ||
|
|
479d2d9ade | ||
|
|
c53f5cc11b | ||
|
|
95fe89a12c | ||
|
|
e37b6d47cc | ||
|
|
d2d9ede8ab | ||
|
|
ed884b0d27 | ||
|
|
2f39c13355 | ||
|
|
488af2b9dd | ||
|
|
83d716d685 | ||
|
|
101fafe4ec | ||
|
|
251276c766 | ||
|
|
d00290c450 | ||
|
|
265971bd6d | ||
|
|
7abfa451d2 | ||
|
|
fbb65373a8 | ||
|
|
aa22472952 | ||
|
|
2919003a9b | ||
|
|
1a62105565 | ||
|
|
1805c60e32 | ||
|
|
24a6e49ab8 | ||
|
|
13b69120f5 | ||
|
|
a7b4cf7d80 | ||
|
|
1342b4c34a | ||
|
|
8a682f7472 | ||
|
|
3d3546106e | ||
|
|
c6ffa2ff6b | ||
|
|
f46c996095 | ||
|
|
6fe4905bb7 | ||
|
|
2a551182ec | ||
|
|
3c5efb2dae |
38
.github/workflows/python-build.yml
vendored
Normal file
38
.github/workflows/python-build.yml
vendored
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
name: Python - Build packages & Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
pull_request:
|
||||||
|
release:
|
||||||
|
types: [created]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build-python-packages:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Build Python stubs
|
||||||
|
run: cargo run --bin stub_gen
|
||||||
|
|
||||||
|
- name: Install Python build dependencies
|
||||||
|
run: pip install maturin==1.8.2
|
||||||
|
|
||||||
|
- name: Build Python packages
|
||||||
|
run: maturin build --sdist --release -m pyadb_client/Cargo.toml
|
||||||
|
|
||||||
|
- name: Publish Python packages
|
||||||
|
if: github.event_name == 'release' && github.event.action == 'created'
|
||||||
|
run: maturin publish -m pyadb_client/Cargo.toml --non-interactive
|
||||||
|
env:
|
||||||
|
MATURIN_PYPI_TOKEN: ${{ secrets.MATURIN_PYPI_TOKEN }}
|
||||||
|
|
||||||
|
- name: "Publish GitHub artefacts"
|
||||||
|
if: github.event_name == 'release' && github.event.action == 'created'
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
files: |
|
||||||
|
target/wheels/pyadb_client*.whl
|
||||||
|
target/wheels/pyadb_client*.tar.gz
|
||||||
23
.github/workflows/rust-build.yml
vendored
Normal file
23
.github/workflows/rust-build.yml
vendored
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
name: Rust - Build
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
env:
|
||||||
|
CARGO_TERM_COLOR: always
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: "Build on ${{ matrix.os }}"
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
os: [ubuntu-latest, windows-latest, macos-latest]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Build project
|
||||||
|
run: cargo build --release --all-features
|
||||||
46
.github/workflows/rust-quality.yml
vendored
Normal file
46
.github/workflows/rust-quality.yml
vendored
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
name: Rust - Quality
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
env:
|
||||||
|
CARGO_TERM_COLOR: always
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
clippy:
|
||||||
|
name: "clippy"
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- run: rustup component add clippy
|
||||||
|
- name: Run clippy
|
||||||
|
run: cargo clippy --all-features
|
||||||
|
|
||||||
|
fmt:
|
||||||
|
name: "fmt"
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Run formatter
|
||||||
|
run: cargo fmt --all --check
|
||||||
|
|
||||||
|
doc:
|
||||||
|
name: "doc"
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Run doc
|
||||||
|
run: cargo doc --all-features --no-deps
|
||||||
|
env:
|
||||||
|
RUSTDOCFLAGS: "-D warnings"
|
||||||
|
|
||||||
|
tests:
|
||||||
|
name: "tests"
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Run tests
|
||||||
|
run: cargo test --verbose --all-features
|
||||||
104
.github/workflows/rust-release.yml
vendored
Normal file
104
.github/workflows/rust-release.yml
vendored
Normal file
@@ -0,0 +1,104 @@
|
|||||||
|
name: Rust - Release creation
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [created]
|
||||||
|
|
||||||
|
env:
|
||||||
|
CARGO_TERM_COLOR: always
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release-linux:
|
||||||
|
name: Linux - Build and Publish
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Set up Rust
|
||||||
|
uses: actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain: stable
|
||||||
|
override: true
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
sudo apt update
|
||||||
|
sudo apt install -y rpm
|
||||||
|
cargo install cargo-deb
|
||||||
|
cargo install cargo-generate-rpm
|
||||||
|
|
||||||
|
- name: Publish crates
|
||||||
|
run: |
|
||||||
|
cargo publish -p adb_client --token ${CRATES_IO_TOKEN}
|
||||||
|
cargo publish -p adb_cli --token ${CRATES_IO_TOKEN}
|
||||||
|
env:
|
||||||
|
CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
|
||||||
|
|
||||||
|
- name: Build release
|
||||||
|
run: cargo build --all-features --release
|
||||||
|
|
||||||
|
- name: Rename binary
|
||||||
|
run: mv target/release/adb_cli target/release/adb_cli-linux
|
||||||
|
|
||||||
|
- name: Build DEB package
|
||||||
|
run: cargo deb -p adb_cli
|
||||||
|
|
||||||
|
- name: Build RPM package
|
||||||
|
run: cargo generate-rpm -p adb_cli
|
||||||
|
|
||||||
|
- name: Upload Linux artifacts
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
files: |
|
||||||
|
target/debian/*.deb
|
||||||
|
target/generate-rpm/*.rpm
|
||||||
|
target/release/adb_cli-linux
|
||||||
|
|
||||||
|
release-macos:
|
||||||
|
name: macOS - Build Binary
|
||||||
|
runs-on: macos-13
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Set up Rust
|
||||||
|
uses: actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain: stable
|
||||||
|
override: true
|
||||||
|
|
||||||
|
- name: Build release
|
||||||
|
run: cargo build --all-features --release
|
||||||
|
|
||||||
|
- name: Rename binary
|
||||||
|
run: mv target/release/adb_cli target/release/adb_cli-macos
|
||||||
|
|
||||||
|
- name: Upload macOS binary
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
files: target/release/adb_cli-macos
|
||||||
|
|
||||||
|
release-windows:
|
||||||
|
name: Windows - Build Binary
|
||||||
|
runs-on: windows-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Set up Rust
|
||||||
|
uses: actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain: stable
|
||||||
|
override: true
|
||||||
|
|
||||||
|
- name: Build release
|
||||||
|
run: cargo build --all-features --release
|
||||||
|
|
||||||
|
- name: Rename binary
|
||||||
|
run: Rename-Item -Path target/release/adb_cli.exe -NewName adb_cli-windows.exe
|
||||||
|
|
||||||
|
- name: Upload Windows binary
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
files: target/release/adb_cli-windows.exe
|
||||||
7
.gitignore
vendored
7
.gitignore
vendored
@@ -1,3 +1,6 @@
|
|||||||
target
|
target
|
||||||
Cargo.lock
|
/Cargo.lock
|
||||||
.vscode
|
/.vscode
|
||||||
|
venv
|
||||||
|
/.mypy_cache
|
||||||
|
pyadb_client/pyadb_client.pyi
|
||||||
|
|||||||
46
Cargo.toml
46
Cargo.toml
@@ -1,30 +1,24 @@
|
|||||||
[package]
|
[workspace]
|
||||||
description = "Rust ADB (Android Debug Bridge) client library"
|
members = ["adb_cli", "adb_client", "examples/mdns", "pyadb_client"]
|
||||||
edition = "2021"
|
resolver = "2"
|
||||||
keywords = ["adb", "android"]
|
|
||||||
|
[workspace.package]
|
||||||
|
authors = ["Corentin LIAUD"]
|
||||||
|
edition = "2024"
|
||||||
|
homepage = "https://github.com/cocool97/adb_client"
|
||||||
|
keywords = ["adb", "android", "tcp", "usb"]
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
name = "adb_client"
|
|
||||||
readme = "README.md"
|
|
||||||
repository = "https://github.com/cocool97/adb_client"
|
repository = "https://github.com/cocool97/adb_client"
|
||||||
version = "1.0.2"
|
version = "2.1.16"
|
||||||
|
rust-version = "1.85.1"
|
||||||
|
|
||||||
[lib]
|
# To build locally when working on a new release
|
||||||
name = "adb_client"
|
[patch.crates-io]
|
||||||
path = "src/lib.rs"
|
adb_client = { path = "./adb_client" }
|
||||||
|
|
||||||
[[example]]
|
[profile.release]
|
||||||
name = "adb_cli"
|
codegen-units = 1
|
||||||
path = "examples/adb_cli.rs"
|
debug-assertions = false
|
||||||
|
lto = "thin"
|
||||||
[dependencies]
|
opt-level = 'z'
|
||||||
byteorder = { version = "1.5.0" }
|
strip = true
|
||||||
chrono = { version = "0.4.38" }
|
|
||||||
lazy_static = { version = "1.5.0" }
|
|
||||||
regex = { version = "1.10.5", features = ["perf", "std", "unicode"] }
|
|
||||||
termios = { version = "0.3.3" }
|
|
||||||
thiserror = { version = "1.0.61" }
|
|
||||||
|
|
||||||
## Binary-only dependencies
|
|
||||||
## Marked as optional so that lib users do not depend on them
|
|
||||||
[dev-dependencies]
|
|
||||||
clap = { version = "4.5.4", features = ["derive"] }
|
|
||||||
|
|||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2023-2024 Corentin LIAUD
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
101
README.md
101
README.md
@@ -1,72 +1,69 @@
|
|||||||
# adb_client
|
<p align="center" style="text-align: center">
|
||||||
|
<img src="assets/logo.png" width="33%">
|
||||||
|
</p>
|
||||||
|
|
||||||
Android Debug Bridge (ADB) client implementation in pure Rust !
|
<p align="center">
|
||||||
|
<p align="center">Android Debug Bridge (ADB) client implementation in pure Rust !</p>
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://crates.io/crates/adb_client">
|
||||||
|
<img alt="crates.io" src="https://img.shields.io/crates/v/adb_client.svg"/>
|
||||||
|
</a>
|
||||||
|
<a href="https://crates.io/crates/adb_client">
|
||||||
|
<img alt="msrv" src="https://img.shields.io/crates/msrv/adb_client"/>
|
||||||
|
</a>
|
||||||
|
<a href="https://github.com/cocool97/adb_client/actions">
|
||||||
|
<img alt="ci status" src="https://github.com/cocool97/adb_client/actions/workflows/rust-build.yml/badge.svg"/>
|
||||||
|
</a>
|
||||||
|
<a href="https://deps.rs/repo/github/cocool97/adb_client">
|
||||||
|
<img alt="dependency status" src="https://deps.rs/repo/github/cocool97/adb_client/status.svg"/>
|
||||||
|
</a>
|
||||||
|
<a href="https://opensource.org/licenses/MIT">
|
||||||
|
<img alt="dependency status" src="https://img.shields.io/badge/License-MIT-yellow.svg"/>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
|
||||||
Main features :
|
Main features of this library:
|
||||||
|
|
||||||
- Full Rust, no need to use shell commands
|
- Full Rust, don't use `adb *` shell commands to interact with devices
|
||||||
- Currently only support server TCP/IP protocol
|
- Supports
|
||||||
|
- Using ADB server as a proxy (standard behavior when using `adb` CLI)
|
||||||
|
- Connecting directly to end devices (without using adb-server)
|
||||||
|
- Over **USB**
|
||||||
|
- Over **TCP/IP**
|
||||||
|
- Implements hidden `adb` features, like `framebuffer`
|
||||||
- Highly configurable
|
- Highly configurable
|
||||||
|
- Provides wrappers to use directly from Python code
|
||||||
- Easy to use !
|
- Easy to use !
|
||||||
|
|
||||||
## Examples
|
## adb_client
|
||||||
|
|
||||||
First declare `adb_client` as a dependency by simply adding this to your `Cargo.toml`:
|
Rust library implementing both ADB protocols (server and end-devices) and providing a high-level abstraction over the many supported commands.
|
||||||
|
|
||||||
```toml
|
Improved documentation available [here](./adb_client/README.md).
|
||||||
[dependencies]
|
|
||||||
adb_client = "*"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Launch a command on host device
|
## adb_cli
|
||||||
|
|
||||||
```rust
|
Rust binary providing an improved version of Google's official `adb` CLI, by using `adb_client` library.
|
||||||
use adb_client::AdbTcpConnection;
|
Provides a "real-world" usage example of this library.
|
||||||
use std::net::Ipv4Addr;
|
|
||||||
|
|
||||||
let mut connection = AdbTcpConnection::new(Ipv4Addr::from([127,0,0,1]), 5037).unwrap();
|
Improved documentation available [here](./adb_cli/README.md).
|
||||||
connection.shell_command(None, vec!["df", "-h"]);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Get available ADB devices
|
## examples
|
||||||
|
|
||||||
```rust
|
Some examples are available in the `examples` directory:
|
||||||
use adb_client::AdbTcpConnection;
|
|
||||||
use std::net::Ipv4Addr;
|
|
||||||
|
|
||||||
let mut connection = AdbTcpConnection::new(Ipv4Addr::from([127,0,0,1]), 5037).unwrap();
|
- `examples/mdns`: mDNS device discovery example
|
||||||
connection.devices();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Push a file to the device
|
## pyadb_client
|
||||||
|
|
||||||
```rust
|
Python wrapper using `adb_client` library to export classes usable directly from a Python environment.
|
||||||
use adb_client::AdbTcpConnection;
|
|
||||||
use std::net::Ipv4Addr;
|
|
||||||
use std::fs::File;
|
|
||||||
use std::path::Path;
|
|
||||||
|
|
||||||
let mut connection = AdbTcpConnection::new(Ipv4Addr::from([127,0,0,1]), 5037).unwrap();
|
Improved documentation available [here](./pyadb_client/README.md)
|
||||||
let mut input = File::open(Path::new(&filename)).unwrap();
|
|
||||||
connection.send(None, &mut input, &path)?;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Rust binary
|
## Related publications
|
||||||
|
|
||||||
This crate also provides a lightweight binary based on the `adb_client` crate. You can install it by running the following command :
|
- [Diving into ADB protocol internals (1/2)](https://www.synacktiv.com/publications/diving-into-adb-protocol-internals-12)
|
||||||
|
- [Diving into ADB protocol internals (2/2)](https://www.synacktiv.com/publications/diving-into-adb-protocol-internals-22)
|
||||||
|
|
||||||
```shell
|
Some features may still be missing, all pull requests are welcome !
|
||||||
cargo install adb_client --example adb_cli
|
|
||||||
```
|
|
||||||
|
|
||||||
## Missing features
|
|
||||||
|
|
||||||
- USB protocol
|
|
||||||
|
|
||||||
All pull requests are welcome !
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
- <https://developer.android.com/studio/command-line/adb>
|
|
||||||
|
|
||||||
- <https://github.com/cstyan/adbDocumentation>
|
|
||||||
|
|||||||
40
adb_cli/Cargo.toml
Normal file
40
adb_cli/Cargo.toml
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
[package]
|
||||||
|
authors.workspace = true
|
||||||
|
description = "Rust ADB (Android Debug Bridge) CLI"
|
||||||
|
edition.workspace = true
|
||||||
|
keywords.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
name = "adb_cli"
|
||||||
|
readme = "README.md"
|
||||||
|
repository.workspace = true
|
||||||
|
rust-version.workspace = true
|
||||||
|
version.workspace = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
adb_client = { version = "^2.0.0", features = ["mdns", "usb"] }
|
||||||
|
anyhow = { version = "1.0.94" }
|
||||||
|
clap = { version = "4.5.23", features = ["derive"] }
|
||||||
|
env_logger = { version = "0.11.5" }
|
||||||
|
log = { version = "0.4.26" }
|
||||||
|
|
||||||
|
[target.'cfg(unix)'.dependencies]
|
||||||
|
termios = { version = "0.3.3" }
|
||||||
|
|
||||||
|
#####################################
|
||||||
|
# Debian package build instructions #
|
||||||
|
#####################################
|
||||||
|
[package.metadata.deb]
|
||||||
|
assets = [
|
||||||
|
{ source = "target/release/adb_cli", dest = "usr/bin/", mode = "755" },
|
||||||
|
]
|
||||||
|
priority = "optional"
|
||||||
|
section = "utility"
|
||||||
|
|
||||||
|
##################################
|
||||||
|
# RPM package build instructions #
|
||||||
|
##################################
|
||||||
|
[package.metadata.generate-rpm]
|
||||||
|
assets = [
|
||||||
|
{ source = "target/release/adb_cli", dest = "/usr/bin/adb_cli", mode = "755" },
|
||||||
|
]
|
||||||
|
license = "MIT"
|
||||||
68
adb_cli/README.md
Normal file
68
adb_cli/README.md
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
# adb_cli
|
||||||
|
|
||||||
|
[](./LICENSE-MIT)
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
Rust binary providing an improved version of `adb` CLI.
|
||||||
|
|
||||||
|
## Rust binary
|
||||||
|
|
||||||
|
This crate provides a lightweight binary based on the `adb_client` crate. You can install it by running the following command :
|
||||||
|
|
||||||
|
```shell
|
||||||
|
cargo install adb_cli
|
||||||
|
```
|
||||||
|
|
||||||
|
Usage is quite simple, and tends to look like `adb`:
|
||||||
|
|
||||||
|
- To use ADB server as a proxy:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
user@laptop ~/adb_client (main)> adb_cli local --help
|
||||||
|
Device related commands using server
|
||||||
|
|
||||||
|
Usage: adb_cli local [OPTIONS] <COMMAND>
|
||||||
|
|
||||||
|
Commands:
|
||||||
|
shell Spawn an interactive shell or run a list of commands on the device
|
||||||
|
pull Pull a file from device
|
||||||
|
push Push a file on device
|
||||||
|
stat Stat a file on device
|
||||||
|
run Run an activity on device specified by the intent
|
||||||
|
reboot Reboot the device
|
||||||
|
install Install an APK on device
|
||||||
|
framebuffer Dump framebuffer of device
|
||||||
|
host-features List available server features
|
||||||
|
list List a directory on device
|
||||||
|
logcat Get logs of device
|
||||||
|
help Print this message or the help of the given subcommand(s)
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-a, --address <ADDRESS> [default: 127.0.0.1:5037]
|
||||||
|
-s, --serial <SERIAL> Serial id of a specific device. Every request will be sent to this device
|
||||||
|
-h, --help Print help
|
||||||
|
```
|
||||||
|
|
||||||
|
- To interact directly with end devices
|
||||||
|
|
||||||
|
```bash
|
||||||
|
user@laptop ~/adb_client (main)> adb_cli usb --help
|
||||||
|
Device commands via USB, no server needed
|
||||||
|
|
||||||
|
Usage: adb_cli usb [OPTIONS] --vendor-id <VID> --product-id <PID> <COMMAND>
|
||||||
|
|
||||||
|
Commands:
|
||||||
|
shell Spawn an interactive shell or run a list of commands on the device
|
||||||
|
pull Pull a file from device
|
||||||
|
push Push a file on device
|
||||||
|
stat Stat a file on device
|
||||||
|
reboot Reboot the device
|
||||||
|
help Print this message or the help of the given subcommand(s)
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-v, --vendor-id <VID> Hexadecimal vendor id of this USB device
|
||||||
|
-p, --product-id <PID> Hexadecimal product id of this USB device
|
||||||
|
-k, --private-key <PATH_TO_PRIVATE_KEY> Path to a custom private key to use for authentication
|
||||||
|
-h, --help Print help
|
||||||
|
```
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
|
#![cfg(any(target_os = "linux", target_os = "macos"))]
|
||||||
|
|
||||||
use std::os::unix::prelude::{AsRawFd, RawFd};
|
use std::os::unix::prelude::{AsRawFd, RawFd};
|
||||||
|
|
||||||
use termios::{tcsetattr, Termios, TCSANOW, VMIN, VTIME};
|
use termios::{TCSANOW, Termios, VMIN, VTIME, tcsetattr};
|
||||||
|
|
||||||
use crate::Result;
|
use crate::Result;
|
||||||
|
|
||||||
@@ -33,6 +35,8 @@ impl ADBTermios {
|
|||||||
impl Drop for ADBTermios {
|
impl Drop for ADBTermios {
|
||||||
fn drop(&mut self) {
|
fn drop(&mut self) {
|
||||||
// Custom drop implementation, restores previous termios structure.
|
// Custom drop implementation, restores previous termios structure.
|
||||||
tcsetattr(self.fd, TCSANOW, &self.old_termios).unwrap();
|
if let Err(e) = tcsetattr(self.fd, TCSANOW, &self.old_termios) {
|
||||||
|
log::error!("Error while dropping ADBTermios: {e}")
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
20
adb_cli/src/handlers/emulator_commands.rs
Normal file
20
adb_cli/src/handlers/emulator_commands.rs
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
use adb_client::emulator::ADBEmulatorDevice;
|
||||||
|
|
||||||
|
use crate::models::{EmuCommand, EmulatorCommand};
|
||||||
|
|
||||||
|
pub fn handle_emulator_commands(emulator_command: EmulatorCommand) -> anyhow::Result<()> {
|
||||||
|
let mut emulator = ADBEmulatorDevice::new(emulator_command.serial, None)?;
|
||||||
|
|
||||||
|
match emulator_command.command {
|
||||||
|
EmuCommand::Sms {
|
||||||
|
phone_number,
|
||||||
|
content,
|
||||||
|
} => {
|
||||||
|
emulator.send_sms(&phone_number, &content)?;
|
||||||
|
log::info!("SMS sent to {phone_number}");
|
||||||
|
}
|
||||||
|
EmuCommand::Rotate => emulator.rotate()?,
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
85
adb_cli/src/handlers/host_commands.rs
Normal file
85
adb_cli/src/handlers/host_commands.rs
Normal file
@@ -0,0 +1,85 @@
|
|||||||
|
use adb_client::{
|
||||||
|
Result,
|
||||||
|
server::{ADBServer, DeviceShort, MDNSBackend, WaitForDeviceState},
|
||||||
|
};
|
||||||
|
|
||||||
|
use crate::models::{HostCommand, MdnsCommand, ServerCommand};
|
||||||
|
|
||||||
|
pub fn handle_host_commands(server_command: ServerCommand<HostCommand>) -> Result<()> {
|
||||||
|
let mut adb_server = ADBServer::new(server_command.address);
|
||||||
|
|
||||||
|
match server_command.command {
|
||||||
|
HostCommand::Version => {
|
||||||
|
let version = adb_server.version()?;
|
||||||
|
log::info!("Android Debug Bridge version {version}");
|
||||||
|
log::info!("Package version {}-rust", std::env!("CARGO_PKG_VERSION"));
|
||||||
|
}
|
||||||
|
HostCommand::Kill => {
|
||||||
|
adb_server.kill()?;
|
||||||
|
}
|
||||||
|
HostCommand::Devices { long } => {
|
||||||
|
if long {
|
||||||
|
log::info!("List of devices attached (extended)");
|
||||||
|
for device in adb_server.devices_long()? {
|
||||||
|
log::info!("{device}");
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
log::info!("List of devices attached");
|
||||||
|
for device in adb_server.devices()? {
|
||||||
|
log::info!("{device}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
HostCommand::TrackDevices => {
|
||||||
|
let callback = |device: DeviceShort| {
|
||||||
|
log::info!("{device}");
|
||||||
|
Ok(())
|
||||||
|
};
|
||||||
|
log::info!("Live list of devices attached");
|
||||||
|
adb_server.track_devices(callback)?;
|
||||||
|
}
|
||||||
|
HostCommand::Pair { address, code } => {
|
||||||
|
adb_server.pair(address, code)?;
|
||||||
|
log::info!("Paired device {address}");
|
||||||
|
}
|
||||||
|
HostCommand::Connect { address } => {
|
||||||
|
adb_server.connect_device(address)?;
|
||||||
|
log::info!("Connected to {address}");
|
||||||
|
}
|
||||||
|
HostCommand::Disconnect { address } => {
|
||||||
|
adb_server.disconnect_device(address)?;
|
||||||
|
log::info!("Disconnected {address}");
|
||||||
|
}
|
||||||
|
HostCommand::Mdns { subcommand } => match subcommand {
|
||||||
|
MdnsCommand::Check => {
|
||||||
|
let check = adb_server.mdns_check()?;
|
||||||
|
let server_status = adb_server.server_status()?;
|
||||||
|
match server_status.mdns_backend {
|
||||||
|
MDNSBackend::Unknown => log::info!("unknown mdns backend..."),
|
||||||
|
MDNSBackend::Bonjour => match check {
|
||||||
|
true => log::info!("mdns daemon version [Bonjour]"),
|
||||||
|
false => log::info!("ERROR: mdns daemon unavailable"),
|
||||||
|
},
|
||||||
|
MDNSBackend::OpenScreen => {
|
||||||
|
log::info!("mdns daemon version [Openscreen discovery 0.0.0]")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
MdnsCommand::Services => {
|
||||||
|
log::info!("List of discovered mdns services");
|
||||||
|
for service in adb_server.mdns_services()? {
|
||||||
|
log::info!("{service}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
HostCommand::ServerStatus => {
|
||||||
|
log::info!("{}", adb_server.server_status()?);
|
||||||
|
}
|
||||||
|
HostCommand::WaitForDevice { transport } => {
|
||||||
|
log::info!("waiting for device to be connected...");
|
||||||
|
adb_server.wait_for_device(WaitForDeviceState::Device, transport)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
35
adb_cli/src/handlers/local_commands.rs
Normal file
35
adb_cli/src/handlers/local_commands.rs
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
use std::{fs::File, io::Write};
|
||||||
|
|
||||||
|
use adb_client::server_device::ADBServerDevice;
|
||||||
|
use anyhow::{Result, anyhow};
|
||||||
|
|
||||||
|
use crate::models::LocalDeviceCommand;
|
||||||
|
|
||||||
|
pub fn handle_local_commands(
|
||||||
|
mut device: ADBServerDevice,
|
||||||
|
local_device_commands: LocalDeviceCommand,
|
||||||
|
) -> Result<()> {
|
||||||
|
match local_device_commands {
|
||||||
|
LocalDeviceCommand::HostFeatures => {
|
||||||
|
let features = device
|
||||||
|
.host_features()?
|
||||||
|
.iter()
|
||||||
|
.map(|v| v.to_string())
|
||||||
|
.reduce(|a, b| format!("{a},{b}"))
|
||||||
|
.ok_or(anyhow!("cannot list features"))?;
|
||||||
|
log::info!("Available host features: {features}");
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
LocalDeviceCommand::List { path } => Ok(device.list(path)?),
|
||||||
|
LocalDeviceCommand::Logcat { path } => {
|
||||||
|
let writer: Box<dyn Write> = if let Some(path) = path {
|
||||||
|
let f = File::create(path)?;
|
||||||
|
Box::new(f)
|
||||||
|
} else {
|
||||||
|
Box::new(std::io::stdout())
|
||||||
|
};
|
||||||
|
Ok(device.get_logs(writer)?)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
7
adb_cli/src/handlers/mod.rs
Normal file
7
adb_cli/src/handlers/mod.rs
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
mod emulator_commands;
|
||||||
|
mod host_commands;
|
||||||
|
mod local_commands;
|
||||||
|
|
||||||
|
pub use emulator_commands::handle_emulator_commands;
|
||||||
|
pub use host_commands::handle_host_commands;
|
||||||
|
pub use local_commands::handle_local_commands;
|
||||||
168
adb_cli/src/main.rs
Normal file
168
adb_cli/src/main.rs
Normal file
@@ -0,0 +1,168 @@
|
|||||||
|
#![doc = include_str!("../README.md")]
|
||||||
|
|
||||||
|
#[cfg(any(target_os = "linux", target_os = "macos"))]
|
||||||
|
mod adb_termios;
|
||||||
|
|
||||||
|
mod handlers;
|
||||||
|
mod models;
|
||||||
|
mod utils;
|
||||||
|
|
||||||
|
use adb_client::ADBDeviceExt;
|
||||||
|
use adb_client::mdns::MDNSDiscoveryService;
|
||||||
|
use adb_client::server::ADBServer;
|
||||||
|
use adb_client::server_device::ADBServerDevice;
|
||||||
|
use adb_client::tcp::ADBTcpDevice;
|
||||||
|
use adb_client::usb::ADBUSBDevice;
|
||||||
|
|
||||||
|
#[cfg(any(target_os = "linux", target_os = "macos"))]
|
||||||
|
use adb_termios::ADBTermios;
|
||||||
|
|
||||||
|
use anyhow::Result;
|
||||||
|
use clap::Parser;
|
||||||
|
use handlers::{handle_emulator_commands, handle_host_commands, handle_local_commands};
|
||||||
|
use models::{DeviceCommands, LocalCommand, MainCommand, Opts};
|
||||||
|
use std::collections::HashMap;
|
||||||
|
use std::fs::File;
|
||||||
|
use std::io::Write;
|
||||||
|
use std::path::Path;
|
||||||
|
use utils::setup_logger;
|
||||||
|
|
||||||
|
fn main() -> Result<()> {
|
||||||
|
// This depends on `clap`
|
||||||
|
let opts = Opts::parse();
|
||||||
|
|
||||||
|
// SAFETY:
|
||||||
|
// We are assuming the entire process is single-threaded
|
||||||
|
// at this point.
|
||||||
|
// This seems true for the current version of `clap`,
|
||||||
|
// but there's no guarantee for future updates
|
||||||
|
unsafe { setup_logger(opts.debug) };
|
||||||
|
|
||||||
|
// Directly handling methods / commands that aren't linked to [`ADBDeviceExt`] trait.
|
||||||
|
// Other methods just have to create a concrete [`ADBDeviceExt`] instance, and return it.
|
||||||
|
// This instance will then be used to execute desired command.
|
||||||
|
let (mut device, commands) = match opts.command {
|
||||||
|
MainCommand::Host(server_command) => return Ok(handle_host_commands(server_command)?),
|
||||||
|
MainCommand::Emu(emulator_command) => return handle_emulator_commands(emulator_command),
|
||||||
|
MainCommand::Local(server_command) => {
|
||||||
|
// Must start server to communicate with device, but only if this is a local one.
|
||||||
|
let server_address_ip = server_command.address.ip();
|
||||||
|
if server_address_ip.is_loopback() || server_address_ip.is_unspecified() {
|
||||||
|
ADBServer::start(&HashMap::default(), &None);
|
||||||
|
}
|
||||||
|
|
||||||
|
let device = match server_command.serial {
|
||||||
|
Some(serial) => ADBServerDevice::new(serial, Some(server_command.address)),
|
||||||
|
None => ADBServerDevice::autodetect(Some(server_command.address)),
|
||||||
|
};
|
||||||
|
|
||||||
|
match server_command.command {
|
||||||
|
LocalCommand::DeviceCommands(device_commands) => (device.boxed(), device_commands),
|
||||||
|
LocalCommand::LocalDeviceCommand(local_device_command) => {
|
||||||
|
return handle_local_commands(device, local_device_command);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
MainCommand::Usb(usb_command) => {
|
||||||
|
let device = match (usb_command.vendor_id, usb_command.product_id) {
|
||||||
|
(Some(vid), Some(pid)) => match usb_command.path_to_private_key {
|
||||||
|
Some(pk) => ADBUSBDevice::new_with_custom_private_key(vid, pid, pk)?,
|
||||||
|
None => ADBUSBDevice::new(vid, pid)?,
|
||||||
|
},
|
||||||
|
(None, None) => match usb_command.path_to_private_key {
|
||||||
|
Some(pk) => ADBUSBDevice::autodetect_with_custom_private_key(pk)?,
|
||||||
|
None => ADBUSBDevice::autodetect()?,
|
||||||
|
},
|
||||||
|
_ => {
|
||||||
|
anyhow::bail!(
|
||||||
|
"please either supply values for both the --vendor-id and --product-id flags or none."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
(device.boxed(), usb_command.commands)
|
||||||
|
}
|
||||||
|
MainCommand::Tcp(tcp_command) => {
|
||||||
|
let device = ADBTcpDevice::new(tcp_command.address)?;
|
||||||
|
(device.boxed(), tcp_command.commands)
|
||||||
|
}
|
||||||
|
MainCommand::Mdns => {
|
||||||
|
let mut service = MDNSDiscoveryService::new()?;
|
||||||
|
|
||||||
|
let (tx, rx) = std::sync::mpsc::channel();
|
||||||
|
service.start(tx)?;
|
||||||
|
|
||||||
|
log::info!("Starting mdns discovery...");
|
||||||
|
while let Ok(device) = rx.recv() {
|
||||||
|
log::info!(
|
||||||
|
"Found device {} with addresses {:?}",
|
||||||
|
device.fullname,
|
||||||
|
device.addresses
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return Ok(service.shutdown()?);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
match commands {
|
||||||
|
DeviceCommands::Shell { commands } => {
|
||||||
|
if commands.is_empty() {
|
||||||
|
// Need to duplicate some code here as ADBTermios [Drop] implementation resets terminal state.
|
||||||
|
// Using a scope here would call drop() too early..
|
||||||
|
#[cfg(any(target_os = "linux", target_os = "macos"))]
|
||||||
|
{
|
||||||
|
let mut adb_termios = ADBTermios::new(std::io::stdin())?;
|
||||||
|
adb_termios.set_adb_termios()?;
|
||||||
|
device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()))?;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(not(any(target_os = "linux", target_os = "macos")))]
|
||||||
|
{
|
||||||
|
device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()))?;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
let commands: Vec<&str> = commands.iter().map(|v| v.as_str()).collect();
|
||||||
|
device.shell_command(&commands, &mut std::io::stdout())?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
DeviceCommands::Pull {
|
||||||
|
source,
|
||||||
|
destination,
|
||||||
|
} => {
|
||||||
|
let mut output = File::create(Path::new(&destination))?;
|
||||||
|
device.pull(&source, &mut output)?;
|
||||||
|
log::info!("Downloaded {source} as {destination}");
|
||||||
|
}
|
||||||
|
DeviceCommands::Stat { path } => {
|
||||||
|
let stat_response = device.stat(&path)?;
|
||||||
|
println!("{stat_response}");
|
||||||
|
}
|
||||||
|
DeviceCommands::Reboot { reboot_type } => {
|
||||||
|
log::info!("Reboots device in mode {reboot_type:?}");
|
||||||
|
device.reboot(reboot_type.into())?
|
||||||
|
}
|
||||||
|
DeviceCommands::Push { filename, path } => {
|
||||||
|
let mut input = File::open(Path::new(&filename))?;
|
||||||
|
device.push(&mut input, &path)?;
|
||||||
|
log::info!("Uploaded {filename} to {path}");
|
||||||
|
}
|
||||||
|
DeviceCommands::Run { package, activity } => {
|
||||||
|
let output = device.run_activity(&package, &activity)?;
|
||||||
|
std::io::stdout().write_all(&output)?;
|
||||||
|
}
|
||||||
|
DeviceCommands::Install { path } => {
|
||||||
|
log::info!("Starting installation of APK {}...", path.display());
|
||||||
|
device.install(&path)?;
|
||||||
|
}
|
||||||
|
DeviceCommands::Uninstall { package } => {
|
||||||
|
log::info!("Uninstalling the package {package}...");
|
||||||
|
device.uninstall(&package)?;
|
||||||
|
}
|
||||||
|
DeviceCommands::Framebuffer { path } => {
|
||||||
|
device.framebuffer(&path)?;
|
||||||
|
log::info!("Successfully dumped framebuffer at path {path}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
46
adb_cli/src/models/device.rs
Normal file
46
adb_cli/src/models/device.rs
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
use std::path::PathBuf;
|
||||||
|
|
||||||
|
use clap::Parser;
|
||||||
|
|
||||||
|
use super::RebootTypeCommand;
|
||||||
|
|
||||||
|
#[derive(Parser, Debug)]
|
||||||
|
pub enum DeviceCommands {
|
||||||
|
/// Spawn an interactive shell or run a list of commands on the device
|
||||||
|
Shell { commands: Vec<String> },
|
||||||
|
/// Pull a file from device
|
||||||
|
Pull { source: String, destination: String },
|
||||||
|
/// Push a file on device
|
||||||
|
Push { filename: String, path: String },
|
||||||
|
/// Stat a file on device
|
||||||
|
Stat { path: String },
|
||||||
|
/// Run an activity on device specified by the intent
|
||||||
|
Run {
|
||||||
|
/// The package whose activity is to be invoked
|
||||||
|
#[clap(short = 'p', long = "package")]
|
||||||
|
package: String,
|
||||||
|
/// The activity to be invoked itself, Usually it is MainActivity
|
||||||
|
#[clap(short = 'a', long = "activity")]
|
||||||
|
activity: String,
|
||||||
|
},
|
||||||
|
/// Reboot the device
|
||||||
|
Reboot {
|
||||||
|
#[clap(subcommand)]
|
||||||
|
reboot_type: RebootTypeCommand,
|
||||||
|
},
|
||||||
|
/// Install an APK on device
|
||||||
|
Install {
|
||||||
|
/// Path to APK file. Extension must be ".apk"
|
||||||
|
path: PathBuf,
|
||||||
|
},
|
||||||
|
/// Uninstall a package from the device
|
||||||
|
Uninstall {
|
||||||
|
/// Name of the package to uninstall
|
||||||
|
package: String,
|
||||||
|
},
|
||||||
|
/// Dump framebuffer of device
|
||||||
|
Framebuffer {
|
||||||
|
/// Framebuffer image destination path
|
||||||
|
path: String,
|
||||||
|
},
|
||||||
|
}
|
||||||
20
adb_cli/src/models/emu.rs
Normal file
20
adb_cli/src/models/emu.rs
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
use clap::{Parser, Subcommand};
|
||||||
|
|
||||||
|
#[derive(Debug, Parser)]
|
||||||
|
pub struct EmulatorCommand {
|
||||||
|
#[clap(short = 's', long = "serial")]
|
||||||
|
pub serial: String,
|
||||||
|
#[clap(subcommand)]
|
||||||
|
pub command: EmuCommand,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Subcommand)]
|
||||||
|
pub enum EmuCommand {
|
||||||
|
/// Send a SMS with given phone number and given content
|
||||||
|
Sms {
|
||||||
|
phone_number: String,
|
||||||
|
content: String,
|
||||||
|
},
|
||||||
|
/// Rotate device screen from 90°
|
||||||
|
Rotate,
|
||||||
|
}
|
||||||
52
adb_cli/src/models/host.rs
Normal file
52
adb_cli/src/models/host.rs
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
use std::net::SocketAddrV4;
|
||||||
|
|
||||||
|
use adb_client::{RustADBError, server::WaitForDeviceTransport};
|
||||||
|
use clap::Parser;
|
||||||
|
|
||||||
|
fn parse_wait_for_device_device_transport(
|
||||||
|
value: &str,
|
||||||
|
) -> Result<WaitForDeviceTransport, RustADBError> {
|
||||||
|
WaitForDeviceTransport::try_from(value)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Parser, Debug)]
|
||||||
|
pub enum HostCommand {
|
||||||
|
/// Print current ADB version.
|
||||||
|
Version,
|
||||||
|
/// Ask ADB server to quit immediately.
|
||||||
|
Kill,
|
||||||
|
/// List connected devices.
|
||||||
|
Devices {
|
||||||
|
#[clap(short = 'l', long = "long")]
|
||||||
|
long: bool,
|
||||||
|
},
|
||||||
|
/// Track new devices showing up.
|
||||||
|
TrackDevices,
|
||||||
|
/// Pair device with a given code
|
||||||
|
Pair { address: SocketAddrV4, code: String },
|
||||||
|
/// Connect device over WI-FI
|
||||||
|
Connect { address: SocketAddrV4 },
|
||||||
|
/// Disconnect device over WI-FI
|
||||||
|
Disconnect { address: SocketAddrV4 },
|
||||||
|
/// MDNS services
|
||||||
|
Mdns {
|
||||||
|
#[clap(subcommand)]
|
||||||
|
subcommand: MdnsCommand,
|
||||||
|
},
|
||||||
|
/// Display server status
|
||||||
|
ServerStatus,
|
||||||
|
/// Wait for a device, on optionally given transport
|
||||||
|
WaitForDevice {
|
||||||
|
/// Transport on which wait for devices
|
||||||
|
#[clap(short = 't', long = "transport", value_parser = parse_wait_for_device_device_transport)]
|
||||||
|
transport: Option<WaitForDeviceTransport>,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Parser, Debug)]
|
||||||
|
pub enum MdnsCommand {
|
||||||
|
/// Check mdns status
|
||||||
|
Check,
|
||||||
|
/// List mdns services available
|
||||||
|
Services,
|
||||||
|
}
|
||||||
24
adb_cli/src/models/local.rs
Normal file
24
adb_cli/src/models/local.rs
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
use clap::Parser;
|
||||||
|
|
||||||
|
use super::DeviceCommands;
|
||||||
|
|
||||||
|
#[derive(Parser, Debug)]
|
||||||
|
pub enum LocalCommand {
|
||||||
|
#[clap(flatten)]
|
||||||
|
DeviceCommands(DeviceCommands),
|
||||||
|
#[clap(flatten)]
|
||||||
|
LocalDeviceCommand(LocalDeviceCommand),
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Parser, Debug)]
|
||||||
|
pub enum LocalDeviceCommand {
|
||||||
|
/// List available server features.
|
||||||
|
HostFeatures,
|
||||||
|
/// List a directory on device
|
||||||
|
List { path: String },
|
||||||
|
/// Get logs of device
|
||||||
|
Logcat {
|
||||||
|
/// Path to output file (created if not exists)
|
||||||
|
path: Option<String>,
|
||||||
|
},
|
||||||
|
}
|
||||||
17
adb_cli/src/models/mod.rs
Normal file
17
adb_cli/src/models/mod.rs
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
mod device;
|
||||||
|
mod emu;
|
||||||
|
mod host;
|
||||||
|
mod local;
|
||||||
|
mod opts;
|
||||||
|
mod reboot_type;
|
||||||
|
mod tcp;
|
||||||
|
mod usb;
|
||||||
|
|
||||||
|
pub use device::DeviceCommands;
|
||||||
|
pub use emu::{EmuCommand, EmulatorCommand};
|
||||||
|
pub use host::{HostCommand, MdnsCommand};
|
||||||
|
pub use local::{LocalCommand, LocalDeviceCommand};
|
||||||
|
pub use opts::{MainCommand, Opts, ServerCommand};
|
||||||
|
pub use reboot_type::RebootTypeCommand;
|
||||||
|
pub use tcp::TcpCommand;
|
||||||
|
pub use usb::UsbCommand;
|
||||||
41
adb_cli/src/models/opts.rs
Normal file
41
adb_cli/src/models/opts.rs
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
use std::net::SocketAddrV4;
|
||||||
|
|
||||||
|
use clap::{Parser, Subcommand};
|
||||||
|
|
||||||
|
use super::{EmulatorCommand, HostCommand, LocalCommand, TcpCommand, UsbCommand};
|
||||||
|
|
||||||
|
#[derive(Debug, Parser)]
|
||||||
|
#[clap(about, version, author)]
|
||||||
|
pub struct Opts {
|
||||||
|
#[clap(long = "debug")]
|
||||||
|
pub debug: bool,
|
||||||
|
#[clap(subcommand)]
|
||||||
|
pub command: MainCommand,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Parser)]
|
||||||
|
pub enum MainCommand {
|
||||||
|
/// Server related commands
|
||||||
|
Host(ServerCommand<HostCommand>),
|
||||||
|
/// Device related commands using server
|
||||||
|
Local(ServerCommand<LocalCommand>),
|
||||||
|
/// Emulator related commands
|
||||||
|
Emu(EmulatorCommand),
|
||||||
|
/// USB device related commands
|
||||||
|
Usb(UsbCommand),
|
||||||
|
/// TCP device related commands
|
||||||
|
Tcp(TcpCommand),
|
||||||
|
/// MDNS discovery related commands
|
||||||
|
Mdns,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Parser)]
|
||||||
|
pub struct ServerCommand<T: Subcommand> {
|
||||||
|
#[clap(short = 'a', long = "address", default_value = "127.0.0.1:5037")]
|
||||||
|
pub address: SocketAddrV4,
|
||||||
|
/// Serial id of a specific device. Every request will be sent to this device.
|
||||||
|
#[clap(short = 's', long = "serial")]
|
||||||
|
pub serial: Option<String>,
|
||||||
|
#[clap(subcommand)]
|
||||||
|
pub command: T,
|
||||||
|
}
|
||||||
25
adb_cli/src/models/reboot_type.rs
Normal file
25
adb_cli/src/models/reboot_type.rs
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
use adb_client::RebootType;
|
||||||
|
use clap::Parser;
|
||||||
|
|
||||||
|
#[derive(Parser, Debug)]
|
||||||
|
pub enum RebootTypeCommand {
|
||||||
|
System,
|
||||||
|
Bootloader,
|
||||||
|
Recovery,
|
||||||
|
Sideload,
|
||||||
|
SideloadAutoReboot,
|
||||||
|
Fastboot,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<RebootTypeCommand> for RebootType {
|
||||||
|
fn from(value: RebootTypeCommand) -> Self {
|
||||||
|
match value {
|
||||||
|
RebootTypeCommand::System => RebootType::System,
|
||||||
|
RebootTypeCommand::Bootloader => RebootType::Bootloader,
|
||||||
|
RebootTypeCommand::Recovery => RebootType::Recovery,
|
||||||
|
RebootTypeCommand::Sideload => RebootType::Sideload,
|
||||||
|
RebootTypeCommand::SideloadAutoReboot => RebootType::SideloadAutoReboot,
|
||||||
|
RebootTypeCommand::Fastboot => RebootType::Fastboot,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
11
adb_cli/src/models/tcp.rs
Normal file
11
adb_cli/src/models/tcp.rs
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
use clap::Parser;
|
||||||
|
use std::net::SocketAddr;
|
||||||
|
|
||||||
|
use super::DeviceCommands;
|
||||||
|
|
||||||
|
#[derive(Parser, Debug)]
|
||||||
|
pub struct TcpCommand {
|
||||||
|
pub address: SocketAddr,
|
||||||
|
#[clap(subcommand)]
|
||||||
|
pub commands: DeviceCommands,
|
||||||
|
}
|
||||||
25
adb_cli/src/models/usb.rs
Normal file
25
adb_cli/src/models/usb.rs
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
use std::num::ParseIntError;
|
||||||
|
use std::path::PathBuf;
|
||||||
|
|
||||||
|
use clap::Parser;
|
||||||
|
|
||||||
|
use super::DeviceCommands;
|
||||||
|
|
||||||
|
fn parse_hex_id(id: &str) -> Result<u16, ParseIntError> {
|
||||||
|
u16::from_str_radix(id, 16)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Parser, Debug)]
|
||||||
|
pub struct UsbCommand {
|
||||||
|
/// Hexadecimal vendor id of this USB device
|
||||||
|
#[clap(short = 'v', long = "vendor-id", value_parser=parse_hex_id, value_name="VID")]
|
||||||
|
pub vendor_id: Option<u16>,
|
||||||
|
/// Hexadecimal product id of this USB device
|
||||||
|
#[clap(short = 'p', long = "product-id", value_parser=parse_hex_id, value_name="PID")]
|
||||||
|
pub product_id: Option<u16>,
|
||||||
|
/// Path to a custom private key to use for authentication
|
||||||
|
#[clap(short = 'k', long = "private-key")]
|
||||||
|
pub path_to_private_key: Option<PathBuf>,
|
||||||
|
#[clap(subcommand)]
|
||||||
|
pub commands: DeviceCommands,
|
||||||
|
}
|
||||||
17
adb_cli/src/utils.rs
Normal file
17
adb_cli/src/utils.rs
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
/// # Safety
|
||||||
|
///
|
||||||
|
/// This conditionally mutates the process' environment.
|
||||||
|
/// See [`std::env::set_var`] for more info.
|
||||||
|
pub unsafe fn setup_logger(debug: bool) {
|
||||||
|
// RUST_LOG variable has more priority then "--debug" flag
|
||||||
|
if std::env::var("RUST_LOG").is_err() {
|
||||||
|
let level = match debug {
|
||||||
|
true => "trace",
|
||||||
|
false => "info",
|
||||||
|
};
|
||||||
|
|
||||||
|
unsafe { std::env::set_var("RUST_LOG", level) };
|
||||||
|
}
|
||||||
|
|
||||||
|
env_logger::init();
|
||||||
|
}
|
||||||
65
adb_client/Cargo.toml
Normal file
65
adb_client/Cargo.toml
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
[package]
|
||||||
|
authors.workspace = true
|
||||||
|
description = "Rust ADB (Android Debug Bridge) client library"
|
||||||
|
edition.workspace = true
|
||||||
|
keywords.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
name = "adb_client"
|
||||||
|
readme = "README.md"
|
||||||
|
repository.workspace = true
|
||||||
|
rust-version.workspace = true
|
||||||
|
version.workspace = true
|
||||||
|
|
||||||
|
[package.metadata.docs.rs]
|
||||||
|
all-features = true
|
||||||
|
rustdoc-args = ["--cfg", "docsrs"]
|
||||||
|
|
||||||
|
[features]
|
||||||
|
default = []
|
||||||
|
mdns = ["dep:mdns-sd"]
|
||||||
|
usb = ["dep:rsa", "dep:rusb"]
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
base64 = { version = "0.22.1" }
|
||||||
|
bincode = { version = "1.3.3" }
|
||||||
|
byteorder = { version = "1.5.0" }
|
||||||
|
chrono = { version = "0.4.40", default-features = false, features = ["std"] }
|
||||||
|
homedir = { version = "= 0.3.4" }
|
||||||
|
image = { version = "0.25.5", default-features = false }
|
||||||
|
log = { version = "0.4.26" }
|
||||||
|
num-bigint = { version = "0.8.4", package = "num-bigint-dig" }
|
||||||
|
num-traits = { version = "0.2.19" }
|
||||||
|
quick-protobuf = { version = "0.8.1" }
|
||||||
|
rand = { version = "0.9.0" }
|
||||||
|
rcgen = { version = "0.13.1", default-features = false, features = [
|
||||||
|
"aws_lc_rs",
|
||||||
|
"pem",
|
||||||
|
] }
|
||||||
|
regex = { version = "1.11.1", features = ["perf", "std", "unicode"] }
|
||||||
|
rustls = { version = "0.23.27" }
|
||||||
|
rustls-pki-types = { version = "1.11.0" }
|
||||||
|
serde = { version = "1.0.216", features = ["derive"] }
|
||||||
|
serde_repr = { version = "0.1.19" }
|
||||||
|
sha1 = { version = "0.10.6", features = ["oid"] }
|
||||||
|
thiserror = { version = "2.0.7" }
|
||||||
|
|
||||||
|
#########
|
||||||
|
# MDNS-only dependencies
|
||||||
|
mdns-sd = { version = "0.13.9", default-features = false, features = [
|
||||||
|
"logging",
|
||||||
|
], optional = true }
|
||||||
|
#########
|
||||||
|
#########
|
||||||
|
# USB-only dependencies
|
||||||
|
rsa = { version = "0.9.7", optional = true }
|
||||||
|
rusb = { version = "0.9.4", features = ["vendored"], optional = true }
|
||||||
|
#########
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
anyhow = { version = "1.0.93" }
|
||||||
|
criterion = { version = "0.6.0" } # Used for benchmarks
|
||||||
|
|
||||||
|
[[bench]]
|
||||||
|
harness = false
|
||||||
|
name = "benchmark_adb_push"
|
||||||
|
path = "../benches/benchmark_adb_push.rs"
|
||||||
51
adb_client/README.md
Normal file
51
adb_client/README.md
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
# adb_client
|
||||||
|
|
||||||
|
[](./LICENSE-MIT)
|
||||||
|
[](https://docs.rs/adb_client)
|
||||||
|
[](https://crates.io/crates/adb_client)
|
||||||
|

|
||||||
|
|
||||||
|
Rust library implementing ADB protocol.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Add `adb_client` crate as a dependency by simply adding it to your `Cargo.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[dependencies]
|
||||||
|
adb_client = "*"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Crate features
|
||||||
|
|
||||||
|
| Feature | Description | Default? |
|
||||||
|
| :-----: | :---------------------------------------------: | :------: |
|
||||||
|
| `mdns` | Enables mDNS device discovery on local network. | No |
|
||||||
|
| `usb` | Enables interactions with USB devices. | No |
|
||||||
|
|
||||||
|
To deactivate some features you can use the `default-features = false` option in your `Cargo.toml` file and manually specify the features you want to activate:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[dependencies]
|
||||||
|
adb_client = { version = "*" }
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
Usage examples can be found in the `examples/` directory of this repository.
|
||||||
|
|
||||||
|
Some example are also provided in the various `README.md` files of modules.
|
||||||
|
|
||||||
|
## Benchmarks
|
||||||
|
|
||||||
|
Benchmarks run on `v2.0.6`, on a **Samsung S10 SM-G973F** device and an **Intel i7-1265U** CPU laptop
|
||||||
|
|
||||||
|
### `ADBServerDevice` push vs `adb push`
|
||||||
|
|
||||||
|
`ADBServerDevice` performs all operations by using adb server as a bridge.
|
||||||
|
|
||||||
|
| File size | Sample size | `ADBServerDevice` | `adb` | Difference |
|
||||||
|
| :-------: | :---------: | :---------------: | :-------: | :------------------------------------: |
|
||||||
|
| 10 MB | 100 | 350,79 ms | 356,30 ms | <div style="color:green">-1,57 %</div> |
|
||||||
|
| 500 MB | 50 | 15,60 s | 15,64 s | <div style="color:green">-0,25 %</div> |
|
||||||
|
| 1 GB | 20 | 31,09 s | 31,12 s | <div style="color:green">-0,10 %</div> |
|
||||||
76
adb_client/src/adb_device_ext.rs
Normal file
76
adb_client/src/adb_device_ext.rs
Normal file
@@ -0,0 +1,76 @@
|
|||||||
|
use std::io::{Cursor, Read, Write};
|
||||||
|
use std::path::Path;
|
||||||
|
|
||||||
|
use image::{ImageBuffer, ImageFormat, Rgba};
|
||||||
|
|
||||||
|
use crate::models::AdbStatResponse;
|
||||||
|
use crate::{RebootType, Result};
|
||||||
|
|
||||||
|
/// Trait representing all features available on both [`crate::server_device::ADBServerDevice`] and [`crate::usb::ADBUSBDevice`]
|
||||||
|
pub trait ADBDeviceExt {
|
||||||
|
/// Runs command in a shell on the device, and write its output and error streams into output.
|
||||||
|
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()>;
|
||||||
|
|
||||||
|
/// Starts an interactive shell session on the device.
|
||||||
|
/// Input data is read from reader and write to writer.
|
||||||
|
fn shell(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()>;
|
||||||
|
|
||||||
|
/// Display the stat information for a remote file
|
||||||
|
fn stat(&mut self, remote_path: &str) -> Result<AdbStatResponse>;
|
||||||
|
|
||||||
|
/// Pull the remote file pointed to by `source` and write its contents into `output`
|
||||||
|
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()>;
|
||||||
|
|
||||||
|
/// Push `stream` to `path` on the device.
|
||||||
|
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()>;
|
||||||
|
|
||||||
|
/// Reboot the device using given reboot type
|
||||||
|
fn reboot(&mut self, reboot_type: RebootType) -> Result<()>;
|
||||||
|
|
||||||
|
/// Run `activity` from `package` on device. Return the command output.
|
||||||
|
fn run_activity(&mut self, package: &str, activity: &str) -> Result<Vec<u8>> {
|
||||||
|
let mut output = Vec::new();
|
||||||
|
self.shell_command(
|
||||||
|
&["am", "start", &format!("{package}/{package}.{activity}")],
|
||||||
|
&mut output,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
Ok(output)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Install an APK pointed to by `apk_path` on device.
|
||||||
|
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()>;
|
||||||
|
|
||||||
|
/// Uninstall the package `package` from device.
|
||||||
|
fn uninstall(&mut self, package: &str) -> Result<()>;
|
||||||
|
|
||||||
|
/// Inner method requesting framebuffer from an Android device
|
||||||
|
fn framebuffer_inner(&mut self) -> Result<ImageBuffer<Rgba<u8>, Vec<u8>>>;
|
||||||
|
|
||||||
|
/// Dump framebuffer of this device into given path
|
||||||
|
fn framebuffer(&mut self, path: &dyn AsRef<Path>) -> Result<()> {
|
||||||
|
// Big help from AOSP source code (<https://android.googlesource.com/platform/system/adb/+/refs/heads/main/framebuffer_service.cpp>)
|
||||||
|
let img = self.framebuffer_inner()?;
|
||||||
|
Ok(img.save(path.as_ref())?)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Dump framebuffer of this device and return corresponding bytes.
|
||||||
|
///
|
||||||
|
/// Output data format is currently only `PNG`.
|
||||||
|
fn framebuffer_bytes(&mut self) -> Result<Vec<u8>> {
|
||||||
|
let img = self.framebuffer_inner()?;
|
||||||
|
let mut vec = Cursor::new(Vec::new());
|
||||||
|
img.write_to(&mut vec, ImageFormat::Png)?;
|
||||||
|
|
||||||
|
Ok(vec.into_inner())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Return a boxed instance representing this trait
|
||||||
|
fn boxed(self) -> Box<dyn ADBDeviceExt>
|
||||||
|
where
|
||||||
|
Self: Sized,
|
||||||
|
Self: 'static,
|
||||||
|
{
|
||||||
|
Box::new(self)
|
||||||
|
}
|
||||||
|
}
|
||||||
10
adb_client/src/adb_transport.rs
Normal file
10
adb_client/src/adb_transport.rs
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
use crate::Result;
|
||||||
|
|
||||||
|
/// Trait representing a transport usable by ADB protocol.
|
||||||
|
pub trait ADBTransport {
|
||||||
|
/// Initializes the connection to this transport.
|
||||||
|
fn connect(&mut self) -> Result<()>;
|
||||||
|
|
||||||
|
/// Shuts down the connection to this transport.
|
||||||
|
fn disconnect(&mut self) -> Result<()>;
|
||||||
|
}
|
||||||
87
adb_client/src/emulator/adb_emulator_device.rs
Normal file
87
adb_client/src/emulator/adb_emulator_device.rs
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
use std::{
|
||||||
|
net::{Ipv4Addr, SocketAddrV4},
|
||||||
|
sync::LazyLock,
|
||||||
|
};
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
ADBTransport, Result, RustADBError, emulator::tcp_emulator_transport::TCPEmulatorTransport,
|
||||||
|
server_device::ADBServerDevice,
|
||||||
|
};
|
||||||
|
use regex::Regex;
|
||||||
|
|
||||||
|
static EMULATOR_REGEX: LazyLock<Regex> = LazyLock::new(|| {
|
||||||
|
Regex::new("^emulator-(?P<port>\\d+)$").expect("wrong syntax for emulator regex")
|
||||||
|
});
|
||||||
|
|
||||||
|
/// Represents an emulator connected to the ADB server.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct ADBEmulatorDevice {
|
||||||
|
/// Unique device identifier.
|
||||||
|
pub identifier: String,
|
||||||
|
/// Internal [TCPEmulatorTransport]
|
||||||
|
transport: TCPEmulatorTransport,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBEmulatorDevice {
|
||||||
|
/// Instantiates a new [ADBEmulatorDevice]
|
||||||
|
pub fn new(identifier: String, ip_address: Option<Ipv4Addr>) -> Result<Self> {
|
||||||
|
let ip_address = match ip_address {
|
||||||
|
Some(ip_address) => ip_address,
|
||||||
|
None => Ipv4Addr::new(127, 0, 0, 1),
|
||||||
|
};
|
||||||
|
|
||||||
|
let groups = EMULATOR_REGEX
|
||||||
|
.captures(&identifier)
|
||||||
|
.ok_or(RustADBError::DeviceNotFound(format!(
|
||||||
|
"Device {identifier} is likely not an emulator"
|
||||||
|
)))?;
|
||||||
|
|
||||||
|
let port = groups
|
||||||
|
.name("port")
|
||||||
|
.ok_or(RustADBError::RegexParsingError)?
|
||||||
|
.as_str()
|
||||||
|
.parse::<u16>()?;
|
||||||
|
|
||||||
|
let socket_addr = SocketAddrV4::new(ip_address, port);
|
||||||
|
|
||||||
|
let transport = TCPEmulatorTransport::new(socket_addr);
|
||||||
|
Ok(Self {
|
||||||
|
identifier,
|
||||||
|
transport,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn get_transport_mut(&mut self) -> &mut TCPEmulatorTransport {
|
||||||
|
&mut self.transport
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Connect to underlying transport
|
||||||
|
pub(crate) fn connect(&mut self) -> Result<&mut TCPEmulatorTransport> {
|
||||||
|
self.transport.connect()?;
|
||||||
|
|
||||||
|
Ok(self.get_transport_mut())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<ADBServerDevice> for ADBEmulatorDevice {
|
||||||
|
type Error = RustADBError;
|
||||||
|
|
||||||
|
fn try_from(value: ADBServerDevice) -> std::result::Result<Self, Self::Error> {
|
||||||
|
match &value.identifier {
|
||||||
|
Some(device_identifier) => ADBEmulatorDevice::new(
|
||||||
|
device_identifier.clone(),
|
||||||
|
Some(*value.transport.get_socketaddr().ip()),
|
||||||
|
),
|
||||||
|
None => Err(RustADBError::DeviceNotFound(
|
||||||
|
"cannot connect to an emulator device without knowing its identifier".to_string(),
|
||||||
|
)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for ADBEmulatorDevice {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
// Best effort here
|
||||||
|
let _ = self.transport.disconnect();
|
||||||
|
}
|
||||||
|
}
|
||||||
2
adb_client/src/emulator/commands/mod.rs
Normal file
2
adb_client/src/emulator/commands/mod.rs
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
mod rotate;
|
||||||
|
mod sms;
|
||||||
11
adb_client/src/emulator/commands/rotate.rs
Normal file
11
adb_client/src/emulator/commands/rotate.rs
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
use crate::{
|
||||||
|
Result,
|
||||||
|
emulator::{ADBEmulatorCommand, ADBEmulatorDevice},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl ADBEmulatorDevice {
|
||||||
|
/// Send a SMS to this emulator with given content with given phone number
|
||||||
|
pub fn rotate(&mut self) -> Result<()> {
|
||||||
|
self.connect()?.send_command(ADBEmulatorCommand::Rotate)
|
||||||
|
}
|
||||||
|
}
|
||||||
14
adb_client/src/emulator/commands/sms.rs
Normal file
14
adb_client/src/emulator/commands/sms.rs
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
use crate::{
|
||||||
|
Result,
|
||||||
|
emulator::{ADBEmulatorCommand, ADBEmulatorDevice},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl ADBEmulatorDevice {
|
||||||
|
/// Send a SMS to this emulator with given content with given phone number
|
||||||
|
pub fn send_sms(&mut self, phone_number: &str, content: &str) -> Result<()> {
|
||||||
|
self.connect()?.send_command(ADBEmulatorCommand::Sms(
|
||||||
|
phone_number.to_string(),
|
||||||
|
content.to_string(),
|
||||||
|
))
|
||||||
|
}
|
||||||
|
}
|
||||||
7
adb_client/src/emulator/mod.rs
Normal file
7
adb_client/src/emulator/mod.rs
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
mod adb_emulator_device;
|
||||||
|
mod commands;
|
||||||
|
mod models;
|
||||||
|
mod tcp_emulator_transport;
|
||||||
|
|
||||||
|
pub use adb_emulator_device::ADBEmulatorDevice;
|
||||||
|
use models::ADBEmulatorCommand;
|
||||||
31
adb_client/src/emulator/models/adb_emulator_command.rs
Normal file
31
adb_client/src/emulator/models/adb_emulator_command.rs
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
use std::fmt::Display;
|
||||||
|
|
||||||
|
pub enum ADBEmulatorCommand {
|
||||||
|
Authenticate(String),
|
||||||
|
Sms(String, String),
|
||||||
|
Rotate,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for ADBEmulatorCommand {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
// Need to call `writeln!` because emulator commands are '\n' terminated
|
||||||
|
match self {
|
||||||
|
ADBEmulatorCommand::Authenticate(token) => writeln!(f, "auth {token}"),
|
||||||
|
ADBEmulatorCommand::Sms(phone_number, content) => {
|
||||||
|
writeln!(f, "sms send {phone_number} {content}")
|
||||||
|
}
|
||||||
|
ADBEmulatorCommand::Rotate => writeln!(f, "rotate"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBEmulatorCommand {
|
||||||
|
/// Return the number of lines to skip per command when checking its result
|
||||||
|
pub(crate) fn skip_response_lines(&self) -> u8 {
|
||||||
|
match self {
|
||||||
|
ADBEmulatorCommand::Authenticate(_) => 1,
|
||||||
|
ADBEmulatorCommand::Sms(_, _) => 0,
|
||||||
|
ADBEmulatorCommand::Rotate => 0,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
2
adb_client/src/emulator/models/mod.rs
Normal file
2
adb_client/src/emulator/models/mod.rs
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
mod adb_emulator_command;
|
||||||
|
pub use adb_emulator_command::ADBEmulatorCommand;
|
||||||
128
adb_client/src/emulator/tcp_emulator_transport.rs
Normal file
128
adb_client/src/emulator/tcp_emulator_transport.rs
Normal file
@@ -0,0 +1,128 @@
|
|||||||
|
use std::{
|
||||||
|
fs::File,
|
||||||
|
io::{BufRead, BufReader, Error, ErrorKind, Read, Write},
|
||||||
|
net::{SocketAddrV4, TcpStream},
|
||||||
|
};
|
||||||
|
|
||||||
|
use homedir::my_home;
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
Result, RustADBError, adb_transport::ADBTransport, emulator::models::ADBEmulatorCommand,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// Emulator transport running on top on TCP.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct TCPEmulatorTransport {
|
||||||
|
socket_addr: SocketAddrV4,
|
||||||
|
tcp_stream: Option<TcpStream>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TCPEmulatorTransport {
|
||||||
|
/// Instantiates a new instance of [TCPEmulatorTransport]
|
||||||
|
pub fn new(socket_addr: SocketAddrV4) -> Self {
|
||||||
|
Self {
|
||||||
|
socket_addr,
|
||||||
|
tcp_stream: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn get_raw_connection(&self) -> Result<&TcpStream> {
|
||||||
|
self.tcp_stream
|
||||||
|
.as_ref()
|
||||||
|
.ok_or(RustADBError::IOError(Error::new(
|
||||||
|
ErrorKind::NotConnected,
|
||||||
|
"not connected",
|
||||||
|
)))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Return authentication token stored in $HOME/.emulator_console_auth_token
|
||||||
|
pub fn get_authentication_token(&mut self) -> Result<String> {
|
||||||
|
let home = match my_home()? {
|
||||||
|
Some(home) => home,
|
||||||
|
None => return Err(RustADBError::NoHomeDirectory),
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut f = File::open(home.join(".emulator_console_auth_token"))?;
|
||||||
|
let mut token = String::new();
|
||||||
|
f.read_to_string(&mut token)?;
|
||||||
|
|
||||||
|
Ok(token)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Send an authenticate request to this emulator
|
||||||
|
pub fn authenticate(&mut self) -> Result<()> {
|
||||||
|
let token = self.get_authentication_token()?;
|
||||||
|
self.send_command(ADBEmulatorCommand::Authenticate(token))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Send an [ADBEmulatorCommand] to this emulator
|
||||||
|
pub(crate) fn send_command(&mut self, command: ADBEmulatorCommand) -> Result<()> {
|
||||||
|
let mut connection = self.get_raw_connection()?;
|
||||||
|
|
||||||
|
// Send command
|
||||||
|
connection.write_all(command.to_string().as_bytes())?;
|
||||||
|
|
||||||
|
// Check is an error occurred skipping lines depending on command
|
||||||
|
self.check_error(command.skip_response_lines())?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn check_error(&mut self, skipping: u8) -> Result<()> {
|
||||||
|
let mut reader = BufReader::new(self.get_raw_connection()?);
|
||||||
|
for _ in 0..skipping {
|
||||||
|
let mut line = String::new();
|
||||||
|
reader.read_line(&mut line)?;
|
||||||
|
if line.starts_with("KO:") {
|
||||||
|
return Err(RustADBError::ADBRequestFailed(line));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut line = String::new();
|
||||||
|
reader.read_line(&mut line)?;
|
||||||
|
|
||||||
|
match line.starts_with("OK") {
|
||||||
|
true => Ok(()),
|
||||||
|
false => Err(RustADBError::ADBRequestFailed(line)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBTransport for TCPEmulatorTransport {
|
||||||
|
fn disconnect(&mut self) -> Result<()> {
|
||||||
|
if let Some(conn) = &mut self.tcp_stream {
|
||||||
|
conn.shutdown(std::net::Shutdown::Both)?;
|
||||||
|
log::trace!("Disconnected from {}", conn.peer_addr()?);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Connect to current emulator and authenticate
|
||||||
|
fn connect(&mut self) -> Result<()> {
|
||||||
|
if self.tcp_stream.is_none() {
|
||||||
|
let stream = TcpStream::connect(self.socket_addr)?;
|
||||||
|
|
||||||
|
log::trace!("Successfully connected to {}", self.socket_addr);
|
||||||
|
|
||||||
|
self.tcp_stream = Some(stream.try_clone()?);
|
||||||
|
|
||||||
|
let mut reader = BufReader::new(stream);
|
||||||
|
|
||||||
|
// Android Console: Authentication required
|
||||||
|
// Android Console: type 'auth <auth_token>' to authenticate
|
||||||
|
// Android Console: you can find your <auth_token> in
|
||||||
|
// '/home/xxx/.emulator_console_auth_token'
|
||||||
|
for _ in 0..=4 {
|
||||||
|
let mut line = String::new();
|
||||||
|
reader.read_line(&mut line)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
self.authenticate()?;
|
||||||
|
|
||||||
|
log::trace!("Authentication successful");
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
137
adb_client/src/error.rs
Normal file
137
adb_client/src/error.rs
Normal file
@@ -0,0 +1,137 @@
|
|||||||
|
use thiserror::Error;
|
||||||
|
|
||||||
|
/// Custom Result type thrown by this crate.
|
||||||
|
pub type Result<T> = std::result::Result<T, RustADBError>;
|
||||||
|
|
||||||
|
/// Represents all error types that can be thrown by the crate.
|
||||||
|
#[derive(Error, Debug)]
|
||||||
|
pub enum RustADBError {
|
||||||
|
/// Indicates that an error occurred with I/O.
|
||||||
|
#[error(transparent)]
|
||||||
|
IOError(#[from] std::io::Error),
|
||||||
|
/// Indicates that an error occurred when sending ADB request.
|
||||||
|
#[error("ADB request failed - {0}")]
|
||||||
|
ADBRequestFailed(String),
|
||||||
|
/// Indicates that ADB server responded an unknown response type.
|
||||||
|
#[error("Unknown response type {0}")]
|
||||||
|
UnknownResponseType(String),
|
||||||
|
/// Indicated that an unexpected command has been received
|
||||||
|
#[error("Wrong response command received: {0}. Expected {1}")]
|
||||||
|
WrongResponseReceived(String, String),
|
||||||
|
/// Indicates that ADB server responses an unknown device state.
|
||||||
|
#[error("Unknown device state {0}")]
|
||||||
|
UnknownDeviceState(String),
|
||||||
|
/// Indicates that an error occurred during UTF-8 parsing.
|
||||||
|
#[error(transparent)]
|
||||||
|
Utf8StrError(#[from] std::str::Utf8Error),
|
||||||
|
/// Indicates that an error occurred during UTF-8 parsing.
|
||||||
|
#[error(transparent)]
|
||||||
|
Utf8StringError(#[from] std::string::FromUtf8Error),
|
||||||
|
/// Indicates that the provided address is not a correct IP address.
|
||||||
|
#[error(transparent)]
|
||||||
|
AddrParseError(#[from] std::net::AddrParseError),
|
||||||
|
/// Indicates an error with regexps.
|
||||||
|
#[error(transparent)]
|
||||||
|
RegexError(#[from] regex::Error),
|
||||||
|
/// Indicates that parsing regex did not worked.
|
||||||
|
#[error("Regex parsing error: missing field")]
|
||||||
|
RegexParsingError,
|
||||||
|
/// Indicates an error with the integer conversion.
|
||||||
|
#[error(transparent)]
|
||||||
|
ParseIntError(#[from] std::num::ParseIntError),
|
||||||
|
/// Indicates that an error occurred when converting a value.
|
||||||
|
#[error("Conversion error")]
|
||||||
|
ConversionError,
|
||||||
|
/// Remote ADB server does not support shell feature.
|
||||||
|
#[error("Remote ADB server does not support shell feature")]
|
||||||
|
ADBShellNotSupported,
|
||||||
|
/// Desired device has not been found
|
||||||
|
#[error("Device not found: {0}")]
|
||||||
|
DeviceNotFound(String),
|
||||||
|
/// Indicates that the device must be paired before attempting a connection over WI-FI
|
||||||
|
#[error("Device not paired before attempting to connect")]
|
||||||
|
ADBDeviceNotPaired,
|
||||||
|
/// An error occurred when getting device's framebuffer image
|
||||||
|
#[error(transparent)]
|
||||||
|
FramebufferImageError(#[from] image::error::ImageError),
|
||||||
|
/// An error occurred when converting framebuffer content
|
||||||
|
#[error("Cannot convert framebuffer into image")]
|
||||||
|
FramebufferConversionError,
|
||||||
|
/// Unimplemented framebuffer image version
|
||||||
|
#[error("Unimplemented framebuffer image version: {0}")]
|
||||||
|
UnimplementedFramebufferImageVersion(u32),
|
||||||
|
/// An error occurred while getting user's home directory
|
||||||
|
#[error(transparent)]
|
||||||
|
HomeError(#[from] homedir::GetHomeError),
|
||||||
|
/// Cannot get home directory
|
||||||
|
#[error("Cannot get home directory")]
|
||||||
|
NoHomeDirectory,
|
||||||
|
/// Generic USB error
|
||||||
|
#[cfg(feature = "usb")]
|
||||||
|
#[cfg_attr(docsrs, doc(cfg(feature = "usb")))]
|
||||||
|
#[error("USB Error: {0}")]
|
||||||
|
UsbError(#[from] rusb::Error),
|
||||||
|
/// USB device not found
|
||||||
|
#[error("USB Device not found: {0} {1}")]
|
||||||
|
USBDeviceNotFound(u16, u16),
|
||||||
|
/// No descriptor found
|
||||||
|
#[error("No USB descriptor found")]
|
||||||
|
USBNoDescriptorFound,
|
||||||
|
/// Integrity of the received message cannot be validated
|
||||||
|
#[error("Invalid integrity. Expected CRC32 {0}, got {1}")]
|
||||||
|
InvalidIntegrity(u32, u32),
|
||||||
|
/// Error while decoding base64 data
|
||||||
|
#[error(transparent)]
|
||||||
|
Base64DecodeError(#[from] base64::DecodeError),
|
||||||
|
/// Error while encoding base64 data
|
||||||
|
#[error(transparent)]
|
||||||
|
Base64EncodeError(#[from] base64::EncodeSliceError),
|
||||||
|
/// An error occurred with RSA engine
|
||||||
|
#[cfg(feature = "usb")]
|
||||||
|
#[cfg_attr(docsrs, doc(cfg(feature = "usb")))]
|
||||||
|
#[error(transparent)]
|
||||||
|
RSAError(#[from] rsa::errors::Error),
|
||||||
|
/// Cannot convert given data from slice
|
||||||
|
#[error(transparent)]
|
||||||
|
TryFromSliceError(#[from] std::array::TryFromSliceError),
|
||||||
|
/// Given path does not represent an APK
|
||||||
|
#[error("wrong file extension: {0}")]
|
||||||
|
WrongFileExtension(String),
|
||||||
|
/// An error occurred with PKCS8 data
|
||||||
|
#[cfg(feature = "usb")]
|
||||||
|
#[cfg_attr(docsrs, doc(cfg(feature = "usb")))]
|
||||||
|
#[error("error with pkcs8: {0}")]
|
||||||
|
RsaPkcs8Error(#[from] rsa::pkcs8::Error),
|
||||||
|
/// Error during certificate generation
|
||||||
|
#[error(transparent)]
|
||||||
|
CertificateGenerationError(#[from] rcgen::Error),
|
||||||
|
/// TLS Error
|
||||||
|
#[error(transparent)]
|
||||||
|
TLSError(#[from] rustls::Error),
|
||||||
|
/// PEM certificate error
|
||||||
|
#[error(transparent)]
|
||||||
|
PemCertError(#[from] rustls_pki_types::pem::Error),
|
||||||
|
/// Error while locking mutex
|
||||||
|
#[error("error while locking data")]
|
||||||
|
PoisonError,
|
||||||
|
/// Cannot upgrade connection from TCP to TLS
|
||||||
|
#[error("upgrade error: {0}")]
|
||||||
|
UpgradeError(String),
|
||||||
|
/// An error occurred while getting mdns devices
|
||||||
|
#[cfg(feature = "mdns")]
|
||||||
|
#[cfg_attr(docsrs, doc(cfg(feature = "mdns")))]
|
||||||
|
#[error(transparent)]
|
||||||
|
MDNSError(#[from] mdns_sd::Error),
|
||||||
|
/// An error occurred while sending data to channel
|
||||||
|
#[error("error sending data to channel")]
|
||||||
|
SendError,
|
||||||
|
/// An unknown transport has been provided
|
||||||
|
#[error("unknown transport: {0}")]
|
||||||
|
UnknownTransport(String),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T> From<std::sync::PoisonError<T>> for RustADBError {
|
||||||
|
fn from(_err: std::sync::PoisonError<T>) -> Self {
|
||||||
|
Self::PoisonError
|
||||||
|
}
|
||||||
|
}
|
||||||
36
adb_client/src/lib.rs
Normal file
36
adb_client/src/lib.rs
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
#![crate_type = "lib"]
|
||||||
|
#![forbid(unsafe_code)]
|
||||||
|
#![forbid(missing_debug_implementations)]
|
||||||
|
#![forbid(missing_docs)]
|
||||||
|
#![doc = include_str!("../README.md")]
|
||||||
|
// Feature `doc_cfg` is currently only available on nightly.
|
||||||
|
// It is activated when cfg `docsrs` is enabled.
|
||||||
|
// Documentation can be build locally using:
|
||||||
|
// `RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --no-deps --all-features`
|
||||||
|
#![cfg_attr(docsrs, feature(doc_cfg))]
|
||||||
|
|
||||||
|
mod adb_device_ext;
|
||||||
|
mod adb_transport;
|
||||||
|
/// Emulator-related definitions
|
||||||
|
pub mod emulator;
|
||||||
|
mod error;
|
||||||
|
mod message_devices;
|
||||||
|
mod models;
|
||||||
|
|
||||||
|
/// Server-related definitions
|
||||||
|
pub mod server;
|
||||||
|
|
||||||
|
/// Device reachable by the server related definitions
|
||||||
|
pub mod server_device;
|
||||||
|
mod utils;
|
||||||
|
|
||||||
|
/// MDNS-related definitions
|
||||||
|
#[cfg(feature = "mdns")]
|
||||||
|
#[cfg_attr(docsrs, doc(cfg(feature = "mdns")))]
|
||||||
|
pub mod mdns;
|
||||||
|
|
||||||
|
pub use adb_device_ext::ADBDeviceExt;
|
||||||
|
use adb_transport::ADBTransport;
|
||||||
|
pub use error::{Result, RustADBError};
|
||||||
|
pub use message_devices::*;
|
||||||
|
pub use models::{AdbStatResponse, HostFeatures, RebootType};
|
||||||
19
adb_client/src/mdns/mdns_device.rs
Normal file
19
adb_client/src/mdns/mdns_device.rs
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
use std::{collections::HashSet, net::IpAddr};
|
||||||
|
|
||||||
|
/// Represent a device found from mdns search
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct MDNSDevice {
|
||||||
|
/// Full device address when resolved
|
||||||
|
pub fullname: String,
|
||||||
|
/// Device IP addresses
|
||||||
|
pub addresses: HashSet<IpAddr>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<mdns_sd::ServiceInfo> for MDNSDevice {
|
||||||
|
fn from(value: mdns_sd::ServiceInfo) -> Self {
|
||||||
|
Self {
|
||||||
|
fullname: value.get_fullname().to_string(),
|
||||||
|
addresses: value.get_addresses().to_owned(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
75
adb_client/src/mdns/mdns_discovery.rs
Normal file
75
adb_client/src/mdns/mdns_discovery.rs
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
use mdns_sd::{ServiceDaemon, ServiceEvent};
|
||||||
|
use std::{sync::mpsc::Sender, thread::JoinHandle};
|
||||||
|
|
||||||
|
use crate::{Result, RustADBError, mdns::MDNSDevice};
|
||||||
|
|
||||||
|
const ADB_SERVICE_NAME: &str = "_adb-tls-connect._tcp.local.";
|
||||||
|
|
||||||
|
/// Structure holding responsibility over mdns discovery
|
||||||
|
pub struct MDNSDiscoveryService {
|
||||||
|
daemon: ServiceDaemon,
|
||||||
|
thread_handle: Option<JoinHandle<Result<()>>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl std::fmt::Debug for MDNSDiscoveryService {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
f.debug_struct("MDNSDiscoveryService")
|
||||||
|
.field("daemon", &self.daemon.get_metrics())
|
||||||
|
.field("handle", &self.thread_handle)
|
||||||
|
.finish()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl MDNSDiscoveryService {
|
||||||
|
/// Instantiate a new discovery service to find devices over mdns
|
||||||
|
pub fn new() -> Result<Self> {
|
||||||
|
Ok(MDNSDiscoveryService {
|
||||||
|
daemon: ServiceDaemon::new()?,
|
||||||
|
thread_handle: None,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Start discovery by spawning a new thread responsible of getting events.
|
||||||
|
pub fn start(&mut self, sender: Sender<MDNSDevice>) -> Result<()> {
|
||||||
|
let receiver = self.daemon.browse(ADB_SERVICE_NAME)?;
|
||||||
|
|
||||||
|
let handle: JoinHandle<Result<()>> = std::thread::spawn(move || {
|
||||||
|
loop {
|
||||||
|
while let Ok(event) = receiver.recv() {
|
||||||
|
match event {
|
||||||
|
ServiceEvent::SearchStarted(_)
|
||||||
|
| ServiceEvent::ServiceRemoved(_, _)
|
||||||
|
| ServiceEvent::ServiceFound(_, _)
|
||||||
|
| ServiceEvent::SearchStopped(_) => {
|
||||||
|
// Ignoring these events. We are only interesting in found devices
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
ServiceEvent::ServiceResolved(service_info) => {
|
||||||
|
return sender
|
||||||
|
.send(MDNSDevice::from(service_info))
|
||||||
|
.map_err(|_| RustADBError::SendError);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
self.thread_handle = Some(handle);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Shutdown discovery engines.
|
||||||
|
pub fn shutdown(&mut self) -> Result<()> {
|
||||||
|
match self.daemon.shutdown() {
|
||||||
|
Ok(_) => Ok(()),
|
||||||
|
Err(e) => match e {
|
||||||
|
mdns_sd::Error::Again => {
|
||||||
|
self.daemon.shutdown()?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
e => Err(RustADBError::MDNSError(e)),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
5
adb_client/src/mdns/mod.rs
Normal file
5
adb_client/src/mdns/mod.rs
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
mod mdns_device;
|
||||||
|
mod mdns_discovery;
|
||||||
|
|
||||||
|
pub use mdns_device::MDNSDevice;
|
||||||
|
pub use mdns_discovery::MDNSDiscoveryService;
|
||||||
251
adb_client/src/message_devices/adb_message_device.rs
Normal file
251
adb_client/src/message_devices/adb_message_device.rs
Normal file
@@ -0,0 +1,251 @@
|
|||||||
|
use byteorder::{LittleEndian, ReadBytesExt};
|
||||||
|
use rand::Rng;
|
||||||
|
use std::io::{Cursor, Read, Seek};
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
AdbStatResponse, Result, RustADBError,
|
||||||
|
message_devices::{
|
||||||
|
adb_message_transport::ADBMessageTransport,
|
||||||
|
adb_transport_message::ADBTransportMessage,
|
||||||
|
message_commands::{MessageCommand, MessageSubcommand},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const BUFFER_SIZE: usize = 65535;
|
||||||
|
|
||||||
|
/// Generic structure representing an ADB device reachable over an [`ADBMessageTransport`].
|
||||||
|
/// Structure is totally agnostic over which transport is truly used.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct ADBMessageDevice<T: ADBMessageTransport> {
|
||||||
|
transport: T,
|
||||||
|
local_id: Option<u32>,
|
||||||
|
remote_id: Option<u32>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
|
||||||
|
/// Instantiate a new [`ADBMessageTransport`]
|
||||||
|
pub fn new(transport: T) -> Self {
|
||||||
|
Self {
|
||||||
|
transport,
|
||||||
|
local_id: None,
|
||||||
|
remote_id: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn get_transport(&mut self) -> &T {
|
||||||
|
&self.transport
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn get_transport_mut(&mut self) -> &mut T {
|
||||||
|
&mut self.transport
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Receive a message and acknowledge it by replying with an `OKAY` command
|
||||||
|
pub(crate) fn recv_and_reply_okay(&mut self) -> Result<ADBTransportMessage> {
|
||||||
|
let message = self.transport.read_message()?;
|
||||||
|
self.transport.write_message(ADBTransportMessage::new(
|
||||||
|
MessageCommand::Okay,
|
||||||
|
self.get_local_id()?,
|
||||||
|
self.get_remote_id()?,
|
||||||
|
&[],
|
||||||
|
))?;
|
||||||
|
Ok(message)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Expect a message with an `OKAY` command after sending a message.
|
||||||
|
pub(crate) fn send_and_expect_okay(
|
||||||
|
&mut self,
|
||||||
|
message: ADBTransportMessage,
|
||||||
|
) -> Result<ADBTransportMessage> {
|
||||||
|
self.transport.write_message(message)?;
|
||||||
|
|
||||||
|
self.transport.read_message().and_then(|message| {
|
||||||
|
message.assert_command(MessageCommand::Okay)?;
|
||||||
|
Ok(message)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn recv_file<W: std::io::Write>(
|
||||||
|
&mut self,
|
||||||
|
mut output: W,
|
||||||
|
) -> std::result::Result<(), RustADBError> {
|
||||||
|
let mut len: Option<u64> = None;
|
||||||
|
loop {
|
||||||
|
let payload = self.recv_and_reply_okay()?.into_payload();
|
||||||
|
let mut rdr = Cursor::new(&payload);
|
||||||
|
while rdr.position() != payload.len() as u64 {
|
||||||
|
match len.take() {
|
||||||
|
Some(0) | None => {
|
||||||
|
rdr.seek_relative(4)?;
|
||||||
|
len.replace(rdr.read_u32::<LittleEndian>()? as u64);
|
||||||
|
}
|
||||||
|
Some(length) => {
|
||||||
|
let remaining_bytes = payload.len() as u64 - rdr.position();
|
||||||
|
if length < remaining_bytes {
|
||||||
|
std::io::copy(&mut rdr.by_ref().take(length), &mut output)?;
|
||||||
|
} else {
|
||||||
|
std::io::copy(&mut rdr.take(remaining_bytes), &mut output)?;
|
||||||
|
len.replace(length - remaining_bytes);
|
||||||
|
// this payload is now exhausted
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if Cursor::new(&payload[(payload.len() - 8)..(payload.len() - 4)])
|
||||||
|
.read_u32::<LittleEndian>()?
|
||||||
|
== MessageSubcommand::Done as u32
|
||||||
|
{
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn push_file<R: std::io::Read>(
|
||||||
|
&mut self,
|
||||||
|
local_id: u32,
|
||||||
|
remote_id: u32,
|
||||||
|
mut reader: R,
|
||||||
|
) -> std::result::Result<(), RustADBError> {
|
||||||
|
let mut buffer = [0; BUFFER_SIZE];
|
||||||
|
let amount_read = reader.read(&mut buffer)?;
|
||||||
|
let subcommand_data = MessageSubcommand::Data.with_arg(amount_read as u32);
|
||||||
|
|
||||||
|
let mut serialized_message =
|
||||||
|
bincode::serialize(&subcommand_data).map_err(|_e| RustADBError::ConversionError)?;
|
||||||
|
serialized_message.append(&mut buffer[..amount_read].to_vec());
|
||||||
|
|
||||||
|
let message = ADBTransportMessage::new(
|
||||||
|
MessageCommand::Write,
|
||||||
|
local_id,
|
||||||
|
remote_id,
|
||||||
|
&serialized_message,
|
||||||
|
);
|
||||||
|
|
||||||
|
self.send_and_expect_okay(message)?;
|
||||||
|
|
||||||
|
loop {
|
||||||
|
let mut buffer = [0; BUFFER_SIZE];
|
||||||
|
|
||||||
|
match reader.read(&mut buffer) {
|
||||||
|
Ok(0) => {
|
||||||
|
// Currently file mtime is not forwarded
|
||||||
|
let subcommand_data = MessageSubcommand::Done.with_arg(0);
|
||||||
|
|
||||||
|
let serialized_message = bincode::serialize(&subcommand_data)
|
||||||
|
.map_err(|_e| RustADBError::ConversionError)?;
|
||||||
|
|
||||||
|
let message = ADBTransportMessage::new(
|
||||||
|
MessageCommand::Write,
|
||||||
|
local_id,
|
||||||
|
remote_id,
|
||||||
|
&serialized_message,
|
||||||
|
);
|
||||||
|
|
||||||
|
self.send_and_expect_okay(message)?;
|
||||||
|
|
||||||
|
// Command should end with a Write => Okay
|
||||||
|
let received = self.transport.read_message()?;
|
||||||
|
match received.header().command() {
|
||||||
|
MessageCommand::Write => return Ok(()),
|
||||||
|
c => {
|
||||||
|
return Err(RustADBError::ADBRequestFailed(format!(
|
||||||
|
"Wrong command received {c}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(size) => {
|
||||||
|
let subcommand_data = MessageSubcommand::Data.with_arg(size as u32);
|
||||||
|
|
||||||
|
let mut serialized_message = bincode::serialize(&subcommand_data)
|
||||||
|
.map_err(|_e| RustADBError::ConversionError)?;
|
||||||
|
serialized_message.append(&mut buffer[..size].to_vec());
|
||||||
|
|
||||||
|
let message = ADBTransportMessage::new(
|
||||||
|
MessageCommand::Write,
|
||||||
|
local_id,
|
||||||
|
remote_id,
|
||||||
|
&serialized_message,
|
||||||
|
);
|
||||||
|
|
||||||
|
self.send_and_expect_okay(message)?;
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
return Err(RustADBError::IOError(e));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn begin_synchronization(&mut self) -> Result<()> {
|
||||||
|
self.open_session(b"sync:\0")?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn stat_with_explicit_ids(&mut self, remote_path: &str) -> Result<AdbStatResponse> {
|
||||||
|
let stat_buffer = MessageSubcommand::Stat.with_arg(remote_path.len() as u32);
|
||||||
|
let message = ADBTransportMessage::new(
|
||||||
|
MessageCommand::Write,
|
||||||
|
self.get_local_id()?,
|
||||||
|
self.get_remote_id()?,
|
||||||
|
&bincode::serialize(&stat_buffer).map_err(|_e| RustADBError::ConversionError)?,
|
||||||
|
);
|
||||||
|
self.send_and_expect_okay(message)?;
|
||||||
|
self.send_and_expect_okay(ADBTransportMessage::new(
|
||||||
|
MessageCommand::Write,
|
||||||
|
self.get_local_id()?,
|
||||||
|
self.get_remote_id()?,
|
||||||
|
remote_path.as_bytes(),
|
||||||
|
))?;
|
||||||
|
let response = self.transport.read_message()?;
|
||||||
|
// Skip first 4 bytes as this is the literal "STAT".
|
||||||
|
// Interesting part starts right after
|
||||||
|
bincode::deserialize(&response.into_payload()[4..])
|
||||||
|
.map_err(|_e| RustADBError::ConversionError)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn end_transaction(&mut self) -> Result<()> {
|
||||||
|
let quit_buffer = MessageSubcommand::Quit.with_arg(0u32);
|
||||||
|
self.send_and_expect_okay(ADBTransportMessage::new(
|
||||||
|
MessageCommand::Write,
|
||||||
|
self.get_local_id()?,
|
||||||
|
self.get_remote_id()?,
|
||||||
|
&bincode::serialize(&quit_buffer).map_err(|_e| RustADBError::ConversionError)?,
|
||||||
|
))?;
|
||||||
|
let _discard_close = self.transport.read_message()?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn open_session(&mut self, data: &[u8]) -> Result<ADBTransportMessage> {
|
||||||
|
let mut rng = rand::rng();
|
||||||
|
|
||||||
|
let message = ADBTransportMessage::new(
|
||||||
|
MessageCommand::Open,
|
||||||
|
rng.random(), // Our 'local-id'
|
||||||
|
0,
|
||||||
|
data,
|
||||||
|
);
|
||||||
|
self.get_transport_mut().write_message(message)?;
|
||||||
|
|
||||||
|
let response = self.get_transport_mut().read_message()?;
|
||||||
|
|
||||||
|
self.local_id = Some(response.header().arg1());
|
||||||
|
self.remote_id = Some(response.header().arg0());
|
||||||
|
|
||||||
|
Ok(response)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn get_local_id(&self) -> Result<u32> {
|
||||||
|
self.local_id.ok_or(RustADBError::ADBRequestFailed(
|
||||||
|
"connection not opened, no local_id".into(),
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn get_remote_id(&self) -> Result<u32> {
|
||||||
|
self.remote_id.ok_or(RustADBError::ADBRequestFailed(
|
||||||
|
"connection not opened, no remote_id".into(),
|
||||||
|
))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
use crate::{
|
||||||
|
ADBDeviceExt, RebootType, Result,
|
||||||
|
message_devices::{
|
||||||
|
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
|
||||||
|
},
|
||||||
|
models::AdbStatResponse,
|
||||||
|
};
|
||||||
|
use std::{
|
||||||
|
io::{Read, Write},
|
||||||
|
path::Path,
|
||||||
|
};
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> ADBDeviceExt for ADBMessageDevice<T> {
|
||||||
|
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
|
||||||
|
self.shell_command(command, output)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn shell(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()> {
|
||||||
|
self.shell(reader, writer)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn stat(&mut self, remote_path: &str) -> Result<AdbStatResponse> {
|
||||||
|
self.stat(remote_path)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()> {
|
||||||
|
self.pull(source, output)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
|
||||||
|
self.push(stream, path)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn reboot(&mut self, reboot_type: RebootType) -> Result<()> {
|
||||||
|
self.reboot(reboot_type)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
|
||||||
|
self.install(apk_path)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn uninstall(&mut self, package: &str) -> Result<()> {
|
||||||
|
self.uninstall(package)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn framebuffer_inner(&mut self) -> Result<image::ImageBuffer<image::Rgba<u8>, Vec<u8>>> {
|
||||||
|
self.framebuffer_inner()
|
||||||
|
}
|
||||||
|
}
|
||||||
32
adb_client/src/message_devices/adb_message_transport.rs
Normal file
32
adb_client/src/message_devices/adb_message_transport.rs
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
Result, adb_transport::ADBTransport,
|
||||||
|
message_devices::adb_transport_message::ADBTransportMessage,
|
||||||
|
};
|
||||||
|
|
||||||
|
const DEFAULT_READ_TIMEOUT: Duration = Duration::from_secs(u64::MAX);
|
||||||
|
const DEFAULT_WRITE_TIMEOUT: Duration = Duration::from_secs(2);
|
||||||
|
|
||||||
|
/// Trait representing a transport able to read and write messages.
|
||||||
|
pub trait ADBMessageTransport: ADBTransport + Clone + Send + 'static {
|
||||||
|
/// Read a message using given timeout on the underlying transport
|
||||||
|
fn read_message_with_timeout(&mut self, read_timeout: Duration) -> Result<ADBTransportMessage>;
|
||||||
|
|
||||||
|
/// Read data to underlying connection, using default timeout
|
||||||
|
fn read_message(&mut self) -> Result<ADBTransportMessage> {
|
||||||
|
self.read_message_with_timeout(DEFAULT_READ_TIMEOUT)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Write a message using given timeout on the underlying transport
|
||||||
|
fn write_message_with_timeout(
|
||||||
|
&mut self,
|
||||||
|
message: ADBTransportMessage,
|
||||||
|
write_timeout: Duration,
|
||||||
|
) -> Result<()>;
|
||||||
|
|
||||||
|
/// Write data to underlying connection, using default timeout
|
||||||
|
fn write_message(&mut self, message: ADBTransportMessage) -> Result<()> {
|
||||||
|
self.write_message_with_timeout(message, DEFAULT_WRITE_TIMEOUT)
|
||||||
|
}
|
||||||
|
}
|
||||||
116
adb_client/src/message_devices/adb_transport_message.rs
Normal file
116
adb_client/src/message_devices/adb_transport_message.rs
Normal file
@@ -0,0 +1,116 @@
|
|||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
use crate::{Result, RustADBError, message_devices::message_commands::MessageCommand};
|
||||||
|
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct ADBTransportMessage {
|
||||||
|
header: ADBTransportMessageHeader,
|
||||||
|
payload: Vec<u8>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Serialize, Deserialize)]
|
||||||
|
#[repr(C)]
|
||||||
|
pub struct ADBTransportMessageHeader {
|
||||||
|
command: MessageCommand, /* command identifier constant */
|
||||||
|
arg0: u32, /* first argument */
|
||||||
|
arg1: u32, /* second argument */
|
||||||
|
data_length: u32, /* length of payload (0 is allowed) */
|
||||||
|
data_crc32: u32, /* crc32 of data payload */
|
||||||
|
magic: u32, /* command ^ 0xffffffff */
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBTransportMessageHeader {
|
||||||
|
pub fn new(command: MessageCommand, arg0: u32, arg1: u32, data: &[u8]) -> Self {
|
||||||
|
Self {
|
||||||
|
command,
|
||||||
|
arg0,
|
||||||
|
arg1,
|
||||||
|
data_length: data.len() as u32,
|
||||||
|
data_crc32: Self::compute_crc32(data),
|
||||||
|
magic: Self::compute_magic(command),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn command(&self) -> MessageCommand {
|
||||||
|
self.command
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn arg0(&self) -> u32 {
|
||||||
|
self.arg0
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn arg1(&self) -> u32 {
|
||||||
|
self.arg1
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn data_length(&self) -> u32 {
|
||||||
|
self.data_length
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn data_crc32(&self) -> u32 {
|
||||||
|
self.data_crc32
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn compute_crc32(data: &[u8]) -> u32 {
|
||||||
|
data.iter().map(|&x| x as u32).sum()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn compute_magic(command: MessageCommand) -> u32 {
|
||||||
|
let command_u32 = command as u32;
|
||||||
|
command_u32 ^ 0xFFFFFFFF
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn as_bytes(&self) -> Result<Vec<u8>> {
|
||||||
|
bincode::serialize(&self).map_err(|_e| RustADBError::ConversionError)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBTransportMessage {
|
||||||
|
pub fn new(command: MessageCommand, arg0: u32, arg1: u32, data: &[u8]) -> Self {
|
||||||
|
Self {
|
||||||
|
header: ADBTransportMessageHeader::new(command, arg0, arg1, data),
|
||||||
|
payload: data.to_vec(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn from_header_and_payload(header: ADBTransportMessageHeader, payload: Vec<u8>) -> Self {
|
||||||
|
Self { header, payload }
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn check_message_integrity(&self) -> bool {
|
||||||
|
ADBTransportMessageHeader::compute_magic(self.header.command) == self.header.magic
|
||||||
|
&& ADBTransportMessageHeader::compute_crc32(&self.payload) == self.header.data_crc32
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn assert_command(&self, expected_command: MessageCommand) -> Result<()> {
|
||||||
|
let our_command = self.header().command();
|
||||||
|
if expected_command == our_command {
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
|
||||||
|
Err(RustADBError::WrongResponseReceived(
|
||||||
|
our_command.to_string(),
|
||||||
|
expected_command.to_string(),
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn header(&self) -> &ADBTransportMessageHeader {
|
||||||
|
&self.header
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn payload(&self) -> &Vec<u8> {
|
||||||
|
&self.payload
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn into_payload(self) -> Vec<u8> {
|
||||||
|
self.payload
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<[u8; 24]> for ADBTransportMessageHeader {
|
||||||
|
type Error = RustADBError;
|
||||||
|
|
||||||
|
fn try_from(value: [u8; 24]) -> Result<Self> {
|
||||||
|
bincode::deserialize(&value).map_err(|_e| RustADBError::ConversionError)
|
||||||
|
}
|
||||||
|
}
|
||||||
101
adb_client/src/message_devices/commands/framebuffer.rs
Normal file
101
adb_client/src/message_devices/commands/framebuffer.rs
Normal file
@@ -0,0 +1,101 @@
|
|||||||
|
use std::io::{Cursor, Read};
|
||||||
|
|
||||||
|
use byteorder::{LittleEndian, ReadBytesExt};
|
||||||
|
use image::{ImageBuffer, Rgba};
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
Result, RustADBError,
|
||||||
|
message_devices::{
|
||||||
|
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
|
||||||
|
message_commands::MessageCommand,
|
||||||
|
},
|
||||||
|
models::{FrameBufferInfoV1, FrameBufferInfoV2},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
|
||||||
|
pub(crate) fn framebuffer_inner(&mut self) -> Result<ImageBuffer<Rgba<u8>, Vec<u8>>> {
|
||||||
|
self.open_session(b"framebuffer:\0")?;
|
||||||
|
|
||||||
|
let response = self.recv_and_reply_okay()?;
|
||||||
|
|
||||||
|
let mut payload_cursor = Cursor::new(response.payload());
|
||||||
|
|
||||||
|
let version = payload_cursor.read_u32::<LittleEndian>()?;
|
||||||
|
|
||||||
|
let img = match version {
|
||||||
|
// RGBA_8888
|
||||||
|
1 => {
|
||||||
|
let mut buf = [0u8; std::mem::size_of::<FrameBufferInfoV1>()];
|
||||||
|
|
||||||
|
payload_cursor.read_exact(&mut buf)?;
|
||||||
|
|
||||||
|
let framebuffer_info: FrameBufferInfoV1 = buf.try_into()?;
|
||||||
|
|
||||||
|
let mut framebuffer_data = Vec::new();
|
||||||
|
payload_cursor.read_to_end(&mut framebuffer_data)?;
|
||||||
|
|
||||||
|
loop {
|
||||||
|
if framebuffer_data.len() as u32 == framebuffer_info.size {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
let response = self.recv_and_reply_okay()?;
|
||||||
|
|
||||||
|
framebuffer_data.extend_from_slice(&response.into_payload());
|
||||||
|
|
||||||
|
log::debug!(
|
||||||
|
"received framebuffer data. new size {}",
|
||||||
|
framebuffer_data.len()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
ImageBuffer::<Rgba<u8>, Vec<u8>>::from_vec(
|
||||||
|
framebuffer_info.width,
|
||||||
|
framebuffer_info.height,
|
||||||
|
framebuffer_data,
|
||||||
|
)
|
||||||
|
.ok_or_else(|| RustADBError::FramebufferConversionError)?
|
||||||
|
}
|
||||||
|
// RGBX_8888
|
||||||
|
2 => {
|
||||||
|
let mut buf = [0u8; std::mem::size_of::<FrameBufferInfoV2>()];
|
||||||
|
|
||||||
|
payload_cursor.read_exact(&mut buf)?;
|
||||||
|
|
||||||
|
let framebuffer_info: FrameBufferInfoV2 = buf.try_into()?;
|
||||||
|
|
||||||
|
let mut framebuffer_data = Vec::new();
|
||||||
|
payload_cursor.read_to_end(&mut framebuffer_data)?;
|
||||||
|
|
||||||
|
loop {
|
||||||
|
if framebuffer_data.len() as u32 == framebuffer_info.size {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
let response = self.recv_and_reply_okay()?;
|
||||||
|
|
||||||
|
framebuffer_data.extend_from_slice(&response.into_payload());
|
||||||
|
|
||||||
|
log::debug!(
|
||||||
|
"received framebuffer data. new size {}",
|
||||||
|
framebuffer_data.len()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
ImageBuffer::<Rgba<u8>, Vec<u8>>::from_vec(
|
||||||
|
framebuffer_info.width,
|
||||||
|
framebuffer_info.height,
|
||||||
|
framebuffer_data,
|
||||||
|
)
|
||||||
|
.ok_or_else(|| RustADBError::FramebufferConversionError)?
|
||||||
|
}
|
||||||
|
v => return Err(RustADBError::UnimplementedFramebufferImageVersion(v)),
|
||||||
|
};
|
||||||
|
|
||||||
|
self.get_transport_mut()
|
||||||
|
.read_message()
|
||||||
|
.and_then(|message| message.assert_command(MessageCommand::Clse))?;
|
||||||
|
|
||||||
|
Ok(img)
|
||||||
|
}
|
||||||
|
}
|
||||||
43
adb_client/src/message_devices/commands/install.rs
Normal file
43
adb_client/src/message_devices/commands/install.rs
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
use std::{fs::File, path::Path};
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
Result,
|
||||||
|
message_devices::{
|
||||||
|
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
|
||||||
|
commands::utils::MessageWriter,
|
||||||
|
},
|
||||||
|
utils::check_extension_is_apk,
|
||||||
|
};
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
|
||||||
|
pub(crate) fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
|
||||||
|
let mut apk_file = File::open(apk_path)?;
|
||||||
|
|
||||||
|
check_extension_is_apk(apk_path)?;
|
||||||
|
|
||||||
|
let file_size = apk_file.metadata()?.len();
|
||||||
|
|
||||||
|
self.open_session(format!("exec:cmd package 'install' -S {file_size}\0").as_bytes())?;
|
||||||
|
|
||||||
|
let transport = self.get_transport().clone();
|
||||||
|
|
||||||
|
let mut writer = MessageWriter::new(transport, self.get_local_id()?, self.get_remote_id()?);
|
||||||
|
|
||||||
|
std::io::copy(&mut apk_file, &mut writer)?;
|
||||||
|
|
||||||
|
let final_status = self.get_transport_mut().read_message()?;
|
||||||
|
|
||||||
|
match final_status.into_payload().as_slice() {
|
||||||
|
b"Success\n" => {
|
||||||
|
log::info!(
|
||||||
|
"APK file {} successfully installed",
|
||||||
|
apk_path.as_ref().display()
|
||||||
|
);
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
d => Err(crate::RustADBError::ADBRequestFailed(String::from_utf8(
|
||||||
|
d.to_vec(),
|
||||||
|
)?)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
9
adb_client/src/message_devices/commands/mod.rs
Normal file
9
adb_client/src/message_devices/commands/mod.rs
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
mod framebuffer;
|
||||||
|
mod install;
|
||||||
|
mod pull;
|
||||||
|
mod push;
|
||||||
|
mod reboot;
|
||||||
|
mod shell;
|
||||||
|
mod stat;
|
||||||
|
mod uninstall;
|
||||||
|
mod utils;
|
||||||
54
adb_client/src/message_devices/commands/pull.rs
Normal file
54
adb_client/src/message_devices/commands/pull.rs
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
use std::io::Write;
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
Result, RustADBError,
|
||||||
|
message_devices::{
|
||||||
|
adb_message_device::ADBMessageDevice,
|
||||||
|
adb_message_transport::ADBMessageTransport,
|
||||||
|
adb_transport_message::ADBTransportMessage,
|
||||||
|
message_commands::{MessageCommand, MessageSubcommand},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
|
||||||
|
pub(crate) fn pull<A: AsRef<str>, W: Write>(&mut self, source: A, output: W) -> Result<()> {
|
||||||
|
self.begin_synchronization()?;
|
||||||
|
let source = source.as_ref();
|
||||||
|
|
||||||
|
let adb_stat_response = self.stat_with_explicit_ids(source)?;
|
||||||
|
|
||||||
|
if adb_stat_response.file_perm == 0 {
|
||||||
|
return Err(RustADBError::UnknownResponseType(
|
||||||
|
"mode is 0: source file does not exist".to_string(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
let local_id = self.get_local_id()?;
|
||||||
|
let remote_id = self.get_remote_id()?;
|
||||||
|
|
||||||
|
self.get_transport_mut().write_message_with_timeout(
|
||||||
|
ADBTransportMessage::new(MessageCommand::Okay, local_id, remote_id, &[]),
|
||||||
|
std::time::Duration::from_secs(4),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let recv_buffer = MessageSubcommand::Recv.with_arg(source.len() as u32);
|
||||||
|
let recv_buffer =
|
||||||
|
bincode::serialize(&recv_buffer).map_err(|_e| RustADBError::ConversionError)?;
|
||||||
|
self.send_and_expect_okay(ADBTransportMessage::new(
|
||||||
|
MessageCommand::Write,
|
||||||
|
self.get_local_id()?,
|
||||||
|
self.get_remote_id()?,
|
||||||
|
&recv_buffer,
|
||||||
|
))?;
|
||||||
|
self.send_and_expect_okay(ADBTransportMessage::new(
|
||||||
|
MessageCommand::Write,
|
||||||
|
self.get_local_id()?,
|
||||||
|
self.get_remote_id()?,
|
||||||
|
source.as_bytes(),
|
||||||
|
))?;
|
||||||
|
|
||||||
|
self.recv_file(output)?;
|
||||||
|
self.end_transaction()?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
37
adb_client/src/message_devices/commands/push.rs
Normal file
37
adb_client/src/message_devices/commands/push.rs
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
use std::io::Read;
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
Result, RustADBError,
|
||||||
|
message_devices::{
|
||||||
|
adb_message_device::ADBMessageDevice,
|
||||||
|
adb_message_transport::ADBMessageTransport,
|
||||||
|
adb_transport_message::ADBTransportMessage,
|
||||||
|
message_commands::{MessageCommand, MessageSubcommand},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
|
||||||
|
pub(crate) fn push<R: Read, A: AsRef<str>>(&mut self, stream: R, path: A) -> Result<()> {
|
||||||
|
self.begin_synchronization()?;
|
||||||
|
|
||||||
|
let path_header = format!("{},0777", path.as_ref());
|
||||||
|
|
||||||
|
let send_buffer = MessageSubcommand::Send.with_arg(path_header.len() as u32);
|
||||||
|
let mut send_buffer =
|
||||||
|
bincode::serialize(&send_buffer).map_err(|_e| RustADBError::ConversionError)?;
|
||||||
|
send_buffer.append(&mut path_header.as_bytes().to_vec());
|
||||||
|
|
||||||
|
self.send_and_expect_okay(ADBTransportMessage::new(
|
||||||
|
MessageCommand::Write,
|
||||||
|
self.get_local_id()?,
|
||||||
|
self.get_remote_id()?,
|
||||||
|
&send_buffer,
|
||||||
|
))?;
|
||||||
|
|
||||||
|
self.push_file(self.get_local_id()?, self.get_remote_id()?, stream)?;
|
||||||
|
|
||||||
|
self.end_transaction()?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
17
adb_client/src/message_devices/commands/reboot.rs
Normal file
17
adb_client/src/message_devices/commands/reboot.rs
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
use crate::{
|
||||||
|
RebootType, Result,
|
||||||
|
message_devices::{
|
||||||
|
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
|
||||||
|
message_commands::MessageCommand,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
|
||||||
|
pub(crate) fn reboot(&mut self, reboot_type: RebootType) -> Result<()> {
|
||||||
|
self.open_session(format!("reboot:{reboot_type}\0").as_bytes())?;
|
||||||
|
|
||||||
|
self.get_transport_mut()
|
||||||
|
.read_message()
|
||||||
|
.and_then(|message| message.assert_command(MessageCommand::Okay))
|
||||||
|
}
|
||||||
|
}
|
||||||
84
adb_client/src/message_devices/commands/shell.rs
Normal file
84
adb_client/src/message_devices/commands/shell.rs
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
use std::io::{ErrorKind, Read, Write};
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
Result, RustADBError,
|
||||||
|
message_devices::{
|
||||||
|
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
|
||||||
|
adb_transport_message::ADBTransportMessage, commands::utils::ShellMessageWriter,
|
||||||
|
message_commands::MessageCommand,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
|
||||||
|
/// Runs 'command' in a shell on the device, and write its output and error streams into output.
|
||||||
|
pub(crate) fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
|
||||||
|
let response = self.open_session(format!("shell:{}\0", command.join(" "),).as_bytes())?;
|
||||||
|
|
||||||
|
if response.header().command() != MessageCommand::Okay {
|
||||||
|
return Err(RustADBError::ADBRequestFailed(format!(
|
||||||
|
"wrong command {}",
|
||||||
|
response.header().command()
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
loop {
|
||||||
|
let response = self.get_transport_mut().read_message()?;
|
||||||
|
if response.header().command() != MessageCommand::Write {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
output.write_all(&response.into_payload())?;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Starts an interactive shell session on the device.
|
||||||
|
/// Input data is read from [reader] and write to [writer].
|
||||||
|
pub(crate) fn shell(
|
||||||
|
&mut self,
|
||||||
|
mut reader: &mut dyn Read,
|
||||||
|
mut writer: Box<dyn Write + Send>,
|
||||||
|
) -> Result<()> {
|
||||||
|
self.open_session(b"shell:\0")?;
|
||||||
|
|
||||||
|
let mut transport = self.get_transport().clone();
|
||||||
|
|
||||||
|
let local_id = self.get_local_id()?;
|
||||||
|
let remote_id = self.get_remote_id()?;
|
||||||
|
|
||||||
|
// Reading thread, reads response from adbd
|
||||||
|
std::thread::spawn(move || -> Result<()> {
|
||||||
|
loop {
|
||||||
|
let message = transport.read_message()?;
|
||||||
|
|
||||||
|
// Acknowledge for more data
|
||||||
|
let response =
|
||||||
|
ADBTransportMessage::new(MessageCommand::Okay, local_id, remote_id, &[]);
|
||||||
|
transport.write_message(response)?;
|
||||||
|
|
||||||
|
match message.header().command() {
|
||||||
|
MessageCommand::Write => {
|
||||||
|
writer.write_all(&message.into_payload())?;
|
||||||
|
writer.flush()?;
|
||||||
|
}
|
||||||
|
MessageCommand::Okay => continue,
|
||||||
|
_ => return Err(RustADBError::ADBShellNotSupported),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
let transport = self.get_transport().clone();
|
||||||
|
let mut shell_writer = ShellMessageWriter::new(transport, local_id, remote_id);
|
||||||
|
|
||||||
|
// Read from given reader (that could be stdin e.g), and write content to device adbd
|
||||||
|
if let Err(e) = std::io::copy(&mut reader, &mut shell_writer) {
|
||||||
|
match e.kind() {
|
||||||
|
ErrorKind::BrokenPipe => return Ok(()),
|
||||||
|
_ => return Err(RustADBError::IOError(e)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
15
adb_client/src/message_devices/commands/stat.rs
Normal file
15
adb_client/src/message_devices/commands/stat.rs
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
use crate::{
|
||||||
|
AdbStatResponse, Result,
|
||||||
|
message_devices::{
|
||||||
|
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
|
||||||
|
pub(crate) fn stat(&mut self, remote_path: &str) -> Result<AdbStatResponse> {
|
||||||
|
self.begin_synchronization()?;
|
||||||
|
let adb_stat_response = self.stat_with_explicit_ids(remote_path)?;
|
||||||
|
self.end_transaction()?;
|
||||||
|
Ok(adb_stat_response)
|
||||||
|
}
|
||||||
|
}
|
||||||
24
adb_client/src/message_devices/commands/uninstall.rs
Normal file
24
adb_client/src/message_devices/commands/uninstall.rs
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
use crate::{
|
||||||
|
Result,
|
||||||
|
message_devices::{
|
||||||
|
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
|
||||||
|
pub(crate) fn uninstall(&mut self, package_name: &str) -> Result<()> {
|
||||||
|
self.open_session(format!("exec:cmd package 'uninstall' {package_name}\0").as_bytes())?;
|
||||||
|
|
||||||
|
let final_status = self.get_transport_mut().read_message()?;
|
||||||
|
|
||||||
|
match final_status.into_payload().as_slice() {
|
||||||
|
b"Success\n" => {
|
||||||
|
log::info!("Package {package_name} successfully uninstalled");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
d => Err(crate::RustADBError::ADBRequestFailed(String::from_utf8(
|
||||||
|
d.to_vec(),
|
||||||
|
)?)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
use std::io::{Error, ErrorKind, Result, Write};
|
||||||
|
|
||||||
|
use crate::message_devices::{
|
||||||
|
adb_message_transport::ADBMessageTransport, adb_transport_message::ADBTransportMessage,
|
||||||
|
message_commands::MessageCommand,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// [`Write`] trait implementation to hide underlying ADB protocol write logic.
|
||||||
|
///
|
||||||
|
/// Read received responses to check that message has been correctly received.
|
||||||
|
pub struct MessageWriter<T: ADBMessageTransport> {
|
||||||
|
transport: T,
|
||||||
|
local_id: u32,
|
||||||
|
remote_id: u32,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> MessageWriter<T> {
|
||||||
|
pub fn new(transport: T, local_id: u32, remote_id: u32) -> Self {
|
||||||
|
Self {
|
||||||
|
transport,
|
||||||
|
local_id,
|
||||||
|
remote_id,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> Write for MessageWriter<T> {
|
||||||
|
fn write(&mut self, buf: &[u8]) -> Result<usize> {
|
||||||
|
let message =
|
||||||
|
ADBTransportMessage::new(MessageCommand::Write, self.local_id, self.remote_id, buf);
|
||||||
|
self.transport
|
||||||
|
.write_message(message)
|
||||||
|
.map_err(|e| Error::new(ErrorKind::InvalidData, e))?;
|
||||||
|
|
||||||
|
match self.transport.read_message() {
|
||||||
|
Ok(response) => {
|
||||||
|
response
|
||||||
|
.assert_command(MessageCommand::Okay)
|
||||||
|
.map_err(Error::other)?;
|
||||||
|
Ok(buf.len())
|
||||||
|
}
|
||||||
|
Err(e) => Err(Error::other(e)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn flush(&mut self) -> Result<()> {
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
4
adb_client/src/message_devices/commands/utils/mod.rs
Normal file
4
adb_client/src/message_devices/commands/utils/mod.rs
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
mod message_writer;
|
||||||
|
mod shell_message_writer;
|
||||||
|
pub use message_writer::MessageWriter;
|
||||||
|
pub use shell_message_writer::ShellMessageWriter;
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
use std::io::Write;
|
||||||
|
|
||||||
|
use crate::message_devices::{
|
||||||
|
adb_message_transport::ADBMessageTransport, adb_transport_message::ADBTransportMessage,
|
||||||
|
message_commands::MessageCommand,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// [`Write`] trait implementation to hide underlying ADB protocol write logic for shell commands.
|
||||||
|
pub struct ShellMessageWriter<T: ADBMessageTransport> {
|
||||||
|
transport: T,
|
||||||
|
local_id: u32,
|
||||||
|
remote_id: u32,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> ShellMessageWriter<T> {
|
||||||
|
pub fn new(transport: T, local_id: u32, remote_id: u32) -> Self {
|
||||||
|
Self {
|
||||||
|
transport,
|
||||||
|
local_id,
|
||||||
|
remote_id,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T: ADBMessageTransport> Write for ShellMessageWriter<T> {
|
||||||
|
fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
|
||||||
|
let message =
|
||||||
|
ADBTransportMessage::new(MessageCommand::Write, self.local_id, self.remote_id, buf);
|
||||||
|
self.transport
|
||||||
|
.write_message(message)
|
||||||
|
.map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidData, e))?;
|
||||||
|
Ok(buf.len())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn flush(&mut self) -> std::io::Result<()> {
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
64
adb_client/src/message_devices/message_commands.rs
Normal file
64
adb_client/src/message_devices/message_commands.rs
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
use serde_repr::{Deserialize_repr, Serialize_repr};
|
||||||
|
use std::fmt::Display;
|
||||||
|
|
||||||
|
#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize_repr, Deserialize_repr)]
|
||||||
|
#[repr(u32)]
|
||||||
|
pub enum MessageCommand {
|
||||||
|
/// Connect to a device
|
||||||
|
Cnxn = 0x4E584E43,
|
||||||
|
/// Close connection to a device
|
||||||
|
Clse = 0x45534C43,
|
||||||
|
/// Device ask for authentication
|
||||||
|
Auth = 0x48545541,
|
||||||
|
/// Open a data connection
|
||||||
|
Open = 0x4E45504F,
|
||||||
|
/// Write data to connection
|
||||||
|
Write = 0x45545257,
|
||||||
|
/// Server understood the message
|
||||||
|
Okay = 0x59414B4F,
|
||||||
|
/// Start a connection using TLS
|
||||||
|
Stls = 0x534C5453,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Eq, PartialEq, Copy, Clone, Serialize_repr, Deserialize_repr)]
|
||||||
|
#[repr(u32)]
|
||||||
|
pub enum MessageSubcommand {
|
||||||
|
Stat = 0x54415453,
|
||||||
|
Send = 0x444E4553,
|
||||||
|
Recv = 0x56434552,
|
||||||
|
Quit = 0x54495551,
|
||||||
|
Fail = 0x4C494146,
|
||||||
|
Done = 0x454E4F44,
|
||||||
|
Data = 0x41544144,
|
||||||
|
List = 0x5453494C,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Serialize, Deserialize)]
|
||||||
|
pub struct SubcommandWithArg {
|
||||||
|
subcommand: MessageSubcommand,
|
||||||
|
arg: u32,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl MessageSubcommand {
|
||||||
|
pub fn with_arg(self, arg: u32) -> SubcommandWithArg {
|
||||||
|
SubcommandWithArg {
|
||||||
|
subcommand: self,
|
||||||
|
arg,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for MessageCommand {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
match self {
|
||||||
|
MessageCommand::Cnxn => write!(f, "CNXN"),
|
||||||
|
MessageCommand::Clse => write!(f, "CLSE"),
|
||||||
|
MessageCommand::Auth => write!(f, "AUTH"),
|
||||||
|
MessageCommand::Open => write!(f, "OPEN"),
|
||||||
|
MessageCommand::Write => write!(f, "WRTE"),
|
||||||
|
MessageCommand::Okay => write!(f, "OKAY"),
|
||||||
|
MessageCommand::Stls => write!(f, "STLS"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
14
adb_client/src/message_devices/mod.rs
Normal file
14
adb_client/src/message_devices/mod.rs
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
/// USB-related definitions
|
||||||
|
#[cfg(feature = "usb")]
|
||||||
|
#[cfg_attr(docsrs, doc(cfg(feature = "usb")))]
|
||||||
|
pub mod usb;
|
||||||
|
|
||||||
|
/// Device reachable over TCP related definition
|
||||||
|
pub mod tcp;
|
||||||
|
|
||||||
|
mod adb_message_device;
|
||||||
|
mod adb_message_device_commands;
|
||||||
|
mod adb_message_transport;
|
||||||
|
mod adb_transport_message;
|
||||||
|
mod commands;
|
||||||
|
mod message_commands;
|
||||||
13
adb_client/src/message_devices/tcp/README.md
Normal file
13
adb_client/src/message_devices/tcp/README.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# Examples
|
||||||
|
|
||||||
|
## Get a shell from device
|
||||||
|
|
||||||
|
```rust no_run
|
||||||
|
use std::net::{SocketAddr, IpAddr, Ipv4Addr};
|
||||||
|
use adb_client::{tcp::ADBTcpDevice, ADBDeviceExt};
|
||||||
|
|
||||||
|
let device_ip = IpAddr::V4(Ipv4Addr::new(192, 168, 0, 10));
|
||||||
|
let device_port = 43210;
|
||||||
|
let mut device = ADBTcpDevice::new(SocketAddr::new(device_ip, device_port)).expect("cannot find device");
|
||||||
|
device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()));
|
||||||
|
```
|
||||||
125
adb_client/src/message_devices/tcp/adb_tcp_device.rs
Normal file
125
adb_client/src/message_devices/tcp/adb_tcp_device.rs
Normal file
@@ -0,0 +1,125 @@
|
|||||||
|
use std::io::Write;
|
||||||
|
use std::path::Path;
|
||||||
|
use std::{io::Read, net::SocketAddr};
|
||||||
|
|
||||||
|
use crate::message_devices::adb_message_device::ADBMessageDevice;
|
||||||
|
use crate::message_devices::adb_message_transport::ADBMessageTransport;
|
||||||
|
use crate::message_devices::adb_transport_message::ADBTransportMessage;
|
||||||
|
use crate::message_devices::message_commands::MessageCommand;
|
||||||
|
use crate::tcp::tcp_transport::TcpTransport;
|
||||||
|
use crate::{ADBDeviceExt, ADBTransport, Result};
|
||||||
|
|
||||||
|
/// Represent a device reached and available over USB.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct ADBTcpDevice {
|
||||||
|
inner: ADBMessageDevice<TcpTransport>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBTcpDevice {
|
||||||
|
/// Instantiate a new [`ADBTcpDevice`]
|
||||||
|
pub fn new(address: SocketAddr) -> Result<Self> {
|
||||||
|
let mut device = Self {
|
||||||
|
inner: ADBMessageDevice::new(TcpTransport::new(address)?),
|
||||||
|
};
|
||||||
|
|
||||||
|
device.connect()?;
|
||||||
|
|
||||||
|
Ok(device)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Send initial connect
|
||||||
|
pub fn connect(&mut self) -> Result<()> {
|
||||||
|
self.get_transport_mut().connect()?;
|
||||||
|
|
||||||
|
let message = ADBTransportMessage::new(
|
||||||
|
MessageCommand::Cnxn,
|
||||||
|
0x01000000,
|
||||||
|
1048576,
|
||||||
|
format!("host::{}\0", env!("CARGO_PKG_NAME")).as_bytes(),
|
||||||
|
);
|
||||||
|
|
||||||
|
self.get_transport_mut().write_message(message)?;
|
||||||
|
|
||||||
|
let message = self.get_transport_mut().read_message()?;
|
||||||
|
|
||||||
|
// Check if client is requesting a secure connection and upgrade it if necessary
|
||||||
|
match message.header().command() {
|
||||||
|
MessageCommand::Stls => {
|
||||||
|
self.get_transport_mut()
|
||||||
|
.write_message(ADBTransportMessage::new(MessageCommand::Stls, 1, 0, &[]))?;
|
||||||
|
self.get_transport_mut().upgrade_connection()?;
|
||||||
|
log::debug!("Connection successfully upgraded from TCP to TLS");
|
||||||
|
}
|
||||||
|
MessageCommand::Cnxn => {
|
||||||
|
log::debug!("Unencrypted connection established");
|
||||||
|
}
|
||||||
|
_ => {
|
||||||
|
return Err(crate::RustADBError::WrongResponseReceived(
|
||||||
|
"Expected CNXN or STLS command".to_string(),
|
||||||
|
message.header().command().to_string(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn get_transport_mut(&mut self) -> &mut TcpTransport {
|
||||||
|
self.inner.get_transport_mut()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBDeviceExt for ADBTcpDevice {
|
||||||
|
#[inline]
|
||||||
|
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
|
||||||
|
self.inner.shell_command(command, output)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn shell(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()> {
|
||||||
|
self.inner.shell(reader, writer)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn stat(&mut self, remote_path: &str) -> Result<crate::AdbStatResponse> {
|
||||||
|
self.inner.stat(remote_path)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()> {
|
||||||
|
self.inner.pull(source, output)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
|
||||||
|
self.inner.push(stream, path)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn reboot(&mut self, reboot_type: crate::RebootType) -> Result<()> {
|
||||||
|
self.inner.reboot(reboot_type)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
|
||||||
|
self.inner.install(apk_path)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn uninstall(&mut self, package: &str) -> Result<()> {
|
||||||
|
self.inner.uninstall(package)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn framebuffer_inner(&mut self) -> Result<image::ImageBuffer<image::Rgba<u8>, Vec<u8>>> {
|
||||||
|
self.inner.framebuffer_inner()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for ADBTcpDevice {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
// Best effort here
|
||||||
|
let _ = self.get_transport_mut().disconnect();
|
||||||
|
}
|
||||||
|
}
|
||||||
6
adb_client/src/message_devices/tcp/mod.rs
Normal file
6
adb_client/src/message_devices/tcp/mod.rs
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
#![doc = include_str!("./README.md")]
|
||||||
|
|
||||||
|
mod adb_tcp_device;
|
||||||
|
mod tcp_transport;
|
||||||
|
|
||||||
|
pub use adb_tcp_device::ADBTcpDevice;
|
||||||
346
adb_client/src/message_devices/tcp/tcp_transport.rs
Normal file
346
adb_client/src/message_devices/tcp/tcp_transport.rs
Normal file
@@ -0,0 +1,346 @@
|
|||||||
|
use rcgen::{CertificateParams, KeyPair, PKCS_RSA_SHA256};
|
||||||
|
use rustls::{
|
||||||
|
ClientConfig, ClientConnection, KeyLogFile, SignatureScheme, StreamOwned,
|
||||||
|
client::danger::{HandshakeSignatureValid, ServerCertVerified, ServerCertVerifier},
|
||||||
|
pki_types::{CertificateDer, PrivatePkcs8KeyDer, pem::PemObject},
|
||||||
|
};
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
Result, RustADBError,
|
||||||
|
adb_transport::ADBTransport,
|
||||||
|
message_devices::{
|
||||||
|
adb_message_transport::ADBMessageTransport,
|
||||||
|
adb_transport_message::{ADBTransportMessage, ADBTransportMessageHeader},
|
||||||
|
message_commands::MessageCommand,
|
||||||
|
},
|
||||||
|
utils::get_default_adb_key_path,
|
||||||
|
};
|
||||||
|
use std::{
|
||||||
|
fs::read_to_string,
|
||||||
|
io::{Read, Write},
|
||||||
|
net::{Shutdown, SocketAddr, TcpStream},
|
||||||
|
ops::{Deref, DerefMut},
|
||||||
|
path::PathBuf,
|
||||||
|
sync::{Arc, Mutex},
|
||||||
|
time::Duration,
|
||||||
|
};
|
||||||
|
|
||||||
|
#[derive(Debug)]
|
||||||
|
enum CurrentConnection {
|
||||||
|
Tcp(TcpStream),
|
||||||
|
Tls(Box<StreamOwned<ClientConnection, TcpStream>>),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CurrentConnection {
|
||||||
|
fn set_read_timeout(&self, read_timeout: Duration) -> Result<()> {
|
||||||
|
match self {
|
||||||
|
CurrentConnection::Tcp(tcp_stream) => {
|
||||||
|
Ok(tcp_stream.set_read_timeout(Some(read_timeout))?)
|
||||||
|
}
|
||||||
|
CurrentConnection::Tls(stream_owned) => {
|
||||||
|
Ok(stream_owned.sock.set_read_timeout(Some(read_timeout))?)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn set_write_timeout(&self, write_timeout: Duration) -> Result<()> {
|
||||||
|
match self {
|
||||||
|
CurrentConnection::Tcp(tcp_stream) => {
|
||||||
|
Ok(tcp_stream.set_write_timeout(Some(write_timeout))?)
|
||||||
|
}
|
||||||
|
CurrentConnection::Tls(stream_owned) => {
|
||||||
|
Ok(stream_owned.sock.set_write_timeout(Some(write_timeout))?)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Read for CurrentConnection {
|
||||||
|
fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
|
||||||
|
match self {
|
||||||
|
CurrentConnection::Tcp(tcp_stream) => tcp_stream.read(buf),
|
||||||
|
CurrentConnection::Tls(tls_conn) => tls_conn.read(buf),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Write for CurrentConnection {
|
||||||
|
fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
|
||||||
|
match self {
|
||||||
|
CurrentConnection::Tcp(tcp_stream) => tcp_stream.write(buf),
|
||||||
|
CurrentConnection::Tls(tls_conn) => tls_conn.write(buf),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn flush(&mut self) -> std::io::Result<()> {
|
||||||
|
match self {
|
||||||
|
CurrentConnection::Tcp(tcp_stream) => tcp_stream.flush(),
|
||||||
|
CurrentConnection::Tls(tls_conn) => tls_conn.flush(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Transport running on USB
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
pub struct TcpTransport {
|
||||||
|
address: SocketAddr,
|
||||||
|
current_connection: Option<Arc<Mutex<CurrentConnection>>>,
|
||||||
|
private_key_path: PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn certificate_from_pk(key_pair: &KeyPair) -> Result<Vec<CertificateDer<'static>>> {
|
||||||
|
let certificate_params = CertificateParams::default();
|
||||||
|
let certificate = certificate_params.self_signed(key_pair)?;
|
||||||
|
Ok(vec![certificate.der().to_owned()])
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TcpTransport {
|
||||||
|
/// Instantiate a new [`TcpTransport`]
|
||||||
|
pub fn new(address: SocketAddr) -> Result<Self> {
|
||||||
|
Self::new_with_custom_private_key(address, get_default_adb_key_path()?)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Instantiate a new [`TcpTransport`] using a given private key
|
||||||
|
pub fn new_with_custom_private_key(
|
||||||
|
address: SocketAddr,
|
||||||
|
private_key_path: PathBuf,
|
||||||
|
) -> Result<Self> {
|
||||||
|
Ok(Self {
|
||||||
|
address,
|
||||||
|
current_connection: None,
|
||||||
|
private_key_path,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_current_connection(&self) -> Result<Arc<Mutex<CurrentConnection>>> {
|
||||||
|
self.current_connection
|
||||||
|
.as_ref()
|
||||||
|
.ok_or(RustADBError::IOError(std::io::Error::new(
|
||||||
|
std::io::ErrorKind::NotConnected,
|
||||||
|
"not connected",
|
||||||
|
)))
|
||||||
|
.cloned()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn upgrade_connection(&mut self) -> Result<()> {
|
||||||
|
let current_connection = match self.current_connection.clone() {
|
||||||
|
Some(current_connection) => current_connection,
|
||||||
|
None => {
|
||||||
|
return Err(RustADBError::UpgradeError(
|
||||||
|
"cannot upgrade a non-existing connection...".into(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
{
|
||||||
|
let mut current_conn_locked = current_connection.lock()?;
|
||||||
|
match current_conn_locked.deref() {
|
||||||
|
CurrentConnection::Tcp(tcp_stream) => {
|
||||||
|
// TODO: Check if we cannot be more precise
|
||||||
|
|
||||||
|
let pk_content = read_to_string(&self.private_key_path)?;
|
||||||
|
|
||||||
|
let key_pair =
|
||||||
|
KeyPair::from_pkcs8_pem_and_sign_algo(&pk_content, &PKCS_RSA_SHA256)?;
|
||||||
|
|
||||||
|
let certificate = certificate_from_pk(&key_pair)?;
|
||||||
|
let private_key = PrivatePkcs8KeyDer::from_pem_file(&self.private_key_path)?;
|
||||||
|
|
||||||
|
let mut client_config = ClientConfig::builder()
|
||||||
|
.dangerous()
|
||||||
|
.with_custom_certificate_verifier(Arc::new(NoCertificateVerification {}))
|
||||||
|
.with_client_auth_cert(certificate, private_key.into())?;
|
||||||
|
|
||||||
|
client_config.key_log = Arc::new(KeyLogFile::new());
|
||||||
|
|
||||||
|
let rc_config = Arc::new(client_config);
|
||||||
|
let server_name = self.address.ip().into();
|
||||||
|
let conn = ClientConnection::new(rc_config, server_name)?;
|
||||||
|
let owned = tcp_stream.try_clone()?;
|
||||||
|
let client = StreamOwned::new(conn, owned);
|
||||||
|
|
||||||
|
// Update current connection state to now use TLS protocol
|
||||||
|
*current_conn_locked = CurrentConnection::Tls(Box::new(client));
|
||||||
|
}
|
||||||
|
CurrentConnection::Tls(_) => {
|
||||||
|
return Err(RustADBError::UpgradeError(
|
||||||
|
"cannot upgrade a TLS connection...".into(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let message = self.read_message()?;
|
||||||
|
match message.header().command() {
|
||||||
|
MessageCommand::Cnxn => {
|
||||||
|
let device_infos = String::from_utf8(message.into_payload())?;
|
||||||
|
log::debug!("received device info: {device_infos}");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
c => Err(RustADBError::ADBRequestFailed(format!(
|
||||||
|
"Wrong command received {c}"
|
||||||
|
))),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBTransport for TcpTransport {
|
||||||
|
fn connect(&mut self) -> Result<()> {
|
||||||
|
let stream = TcpStream::connect(self.address)?;
|
||||||
|
self.current_connection = Some(Arc::new(Mutex::new(CurrentConnection::Tcp(stream))));
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn disconnect(&mut self) -> Result<()> {
|
||||||
|
log::debug!("disconnecting...");
|
||||||
|
if let Some(current_connection) = &self.current_connection {
|
||||||
|
let mut lock = current_connection.lock()?;
|
||||||
|
match lock.deref_mut() {
|
||||||
|
CurrentConnection::Tcp(tcp_stream) => {
|
||||||
|
let _ = tcp_stream.shutdown(Shutdown::Both);
|
||||||
|
}
|
||||||
|
CurrentConnection::Tls(tls_conn) => {
|
||||||
|
tls_conn.conn.send_close_notify();
|
||||||
|
let _ = tls_conn.sock.shutdown(Shutdown::Both);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBMessageTransport for TcpTransport {
|
||||||
|
fn read_message_with_timeout(
|
||||||
|
&mut self,
|
||||||
|
read_timeout: std::time::Duration,
|
||||||
|
) -> Result<ADBTransportMessage> {
|
||||||
|
let raw_connection_lock = self.get_current_connection()?;
|
||||||
|
let mut raw_connection = raw_connection_lock.lock()?;
|
||||||
|
|
||||||
|
raw_connection.set_read_timeout(read_timeout)?;
|
||||||
|
|
||||||
|
let mut data = [0; 24];
|
||||||
|
let mut total_read = 0;
|
||||||
|
loop {
|
||||||
|
total_read += raw_connection.read(&mut data[total_read..])?;
|
||||||
|
if total_read == data.len() {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let header = ADBTransportMessageHeader::try_from(data)?;
|
||||||
|
|
||||||
|
if header.data_length() != 0 {
|
||||||
|
let mut msg_data = vec![0_u8; header.data_length() as usize];
|
||||||
|
let mut total_read = 0;
|
||||||
|
loop {
|
||||||
|
total_read += raw_connection.read(&mut msg_data[total_read..])?;
|
||||||
|
if total_read == msg_data.capacity() {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let message = ADBTransportMessage::from_header_and_payload(header, msg_data);
|
||||||
|
|
||||||
|
// Check message integrity
|
||||||
|
if !message.check_message_integrity() {
|
||||||
|
return Err(RustADBError::InvalidIntegrity(
|
||||||
|
ADBTransportMessageHeader::compute_crc32(message.payload()),
|
||||||
|
message.header().data_crc32(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
return Ok(message);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(ADBTransportMessage::from_header_and_payload(header, vec![]))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn write_message_with_timeout(
|
||||||
|
&mut self,
|
||||||
|
message: ADBTransportMessage,
|
||||||
|
write_timeout: Duration,
|
||||||
|
) -> Result<()> {
|
||||||
|
let message_bytes = message.header().as_bytes()?;
|
||||||
|
let raw_connection_lock = self.get_current_connection()?;
|
||||||
|
let mut raw_connection = raw_connection_lock.lock()?;
|
||||||
|
|
||||||
|
raw_connection.set_write_timeout(write_timeout)?;
|
||||||
|
|
||||||
|
let mut total_written = 0;
|
||||||
|
loop {
|
||||||
|
total_written += raw_connection.write(&message_bytes[total_written..])?;
|
||||||
|
if total_written == message_bytes.len() {
|
||||||
|
raw_connection.flush()?;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let payload = message.into_payload();
|
||||||
|
if !payload.is_empty() {
|
||||||
|
let mut total_written = 0;
|
||||||
|
loop {
|
||||||
|
total_written += raw_connection.write(&payload[total_written..])?;
|
||||||
|
if total_written == payload.len() {
|
||||||
|
raw_connection.flush()?;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug)]
|
||||||
|
struct NoCertificateVerification;
|
||||||
|
|
||||||
|
impl ServerCertVerifier for NoCertificateVerification {
|
||||||
|
fn verify_server_cert(
|
||||||
|
&self,
|
||||||
|
_end_entity: &rustls::pki_types::CertificateDer<'_>,
|
||||||
|
_intermediates: &[rustls::pki_types::CertificateDer<'_>],
|
||||||
|
_server_name: &rustls::pki_types::ServerName<'_>,
|
||||||
|
_ocsp_response: &[u8],
|
||||||
|
_now: rustls::pki_types::UnixTime,
|
||||||
|
) -> std::result::Result<rustls::client::danger::ServerCertVerified, rustls::Error> {
|
||||||
|
Ok(ServerCertVerified::assertion())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn verify_tls12_signature(
|
||||||
|
&self,
|
||||||
|
_message: &[u8],
|
||||||
|
_cert: &rustls::pki_types::CertificateDer<'_>,
|
||||||
|
_dss: &rustls::DigitallySignedStruct,
|
||||||
|
) -> std::result::Result<rustls::client::danger::HandshakeSignatureValid, rustls::Error> {
|
||||||
|
Ok(HandshakeSignatureValid::assertion())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn verify_tls13_signature(
|
||||||
|
&self,
|
||||||
|
_message: &[u8],
|
||||||
|
_cert: &rustls::pki_types::CertificateDer<'_>,
|
||||||
|
_dss: &rustls::DigitallySignedStruct,
|
||||||
|
) -> std::result::Result<rustls::client::danger::HandshakeSignatureValid, rustls::Error> {
|
||||||
|
Ok(HandshakeSignatureValid::assertion())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn supported_verify_schemes(&self) -> Vec<rustls::SignatureScheme> {
|
||||||
|
vec![
|
||||||
|
SignatureScheme::RSA_PKCS1_SHA1,
|
||||||
|
SignatureScheme::ECDSA_SHA1_Legacy,
|
||||||
|
SignatureScheme::RSA_PKCS1_SHA256,
|
||||||
|
SignatureScheme::ECDSA_NISTP256_SHA256,
|
||||||
|
SignatureScheme::RSA_PKCS1_SHA384,
|
||||||
|
SignatureScheme::ECDSA_NISTP384_SHA384,
|
||||||
|
SignatureScheme::RSA_PKCS1_SHA512,
|
||||||
|
SignatureScheme::ECDSA_NISTP521_SHA512,
|
||||||
|
SignatureScheme::RSA_PSS_SHA256,
|
||||||
|
SignatureScheme::RSA_PSS_SHA384,
|
||||||
|
SignatureScheme::RSA_PSS_SHA512,
|
||||||
|
SignatureScheme::ED25519,
|
||||||
|
SignatureScheme::ED448,
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
26
adb_client/src/message_devices/usb/README.md
Normal file
26
adb_client/src/message_devices/usb/README.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# Examples
|
||||||
|
|
||||||
|
## Launch a command on device
|
||||||
|
|
||||||
|
```rust no_run
|
||||||
|
use adb_client::{usb::ADBUSBDevice, ADBDeviceExt};
|
||||||
|
|
||||||
|
let vendor_id = 0x04e8;
|
||||||
|
let product_id = 0x6860;
|
||||||
|
let mut device = ADBUSBDevice::new(vendor_id, product_id).expect("cannot find device");
|
||||||
|
device.shell_command(&["df", "-h"], &mut std::io::stdout());
|
||||||
|
```
|
||||||
|
|
||||||
|
## Push a file to the device
|
||||||
|
|
||||||
|
```rust no_run
|
||||||
|
use adb_client::{usb::ADBUSBDevice, ADBDeviceExt};
|
||||||
|
use std::fs::File;
|
||||||
|
use std::path::Path;
|
||||||
|
|
||||||
|
let vendor_id = 0x04e8;
|
||||||
|
let product_id = 0x6860;
|
||||||
|
let mut device = ADBUSBDevice::new(vendor_id, product_id).expect("cannot find device");
|
||||||
|
let mut input = File::open(Path::new("/tmp/file.txt")).expect("Cannot open file");
|
||||||
|
device.push(&mut input, &"/data/local/tmp");
|
||||||
|
```
|
||||||
174
adb_client/src/message_devices/usb/adb_rsa_key.rs
Normal file
174
adb_client/src/message_devices/usb/adb_rsa_key.rs
Normal file
@@ -0,0 +1,174 @@
|
|||||||
|
use crate::{Result, RustADBError};
|
||||||
|
use base64::{Engine, engine::general_purpose::STANDARD};
|
||||||
|
use num_bigint::{BigUint, ModInverse};
|
||||||
|
use num_traits::FromPrimitive;
|
||||||
|
use num_traits::cast::ToPrimitive;
|
||||||
|
use rsa::pkcs8::DecodePrivateKey;
|
||||||
|
use rsa::traits::PublicKeyParts;
|
||||||
|
use rsa::{Pkcs1v15Sign, RsaPrivateKey};
|
||||||
|
|
||||||
|
const ADB_PRIVATE_KEY_SIZE: usize = 2048;
|
||||||
|
const ANDROID_PUBKEY_MODULUS_SIZE_WORDS: u32 = 64;
|
||||||
|
|
||||||
|
#[repr(C)]
|
||||||
|
#[derive(Debug, Default)]
|
||||||
|
/// Internal ADB representation of a public key
|
||||||
|
struct ADBRsaInternalPublicKey {
|
||||||
|
pub modulus_size_words: u32,
|
||||||
|
pub n0inv: u32,
|
||||||
|
pub modulus: BigUint,
|
||||||
|
pub rr: Vec<u8>,
|
||||||
|
pub exponent: u32,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBRsaInternalPublicKey {
|
||||||
|
pub fn new(exponent: &BigUint, modulus: &BigUint) -> Result<Self> {
|
||||||
|
Ok(Self {
|
||||||
|
modulus_size_words: ANDROID_PUBKEY_MODULUS_SIZE_WORDS,
|
||||||
|
exponent: exponent.to_u32().ok_or(RustADBError::ConversionError)?,
|
||||||
|
modulus: modulus.clone(),
|
||||||
|
..Default::default()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn into_bytes(mut self) -> Vec<u8> {
|
||||||
|
let mut bytes: Vec<u8> = Vec::new();
|
||||||
|
bytes.append(&mut self.modulus_size_words.to_le_bytes().to_vec());
|
||||||
|
bytes.append(&mut self.n0inv.to_le_bytes().to_vec());
|
||||||
|
bytes.append(&mut self.modulus.to_bytes_le());
|
||||||
|
bytes.append(&mut self.rr);
|
||||||
|
bytes.append(&mut self.exponent.to_le_bytes().to_vec());
|
||||||
|
|
||||||
|
bytes
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone)]
|
||||||
|
pub struct ADBRsaKey {
|
||||||
|
private_key: RsaPrivateKey,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBRsaKey {
|
||||||
|
pub fn new_random() -> Result<Self> {
|
||||||
|
Ok(Self {
|
||||||
|
private_key: RsaPrivateKey::new(&mut rsa::rand_core::OsRng, ADB_PRIVATE_KEY_SIZE)?,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn new_from_pkcs8(pkcs8_content: &str) -> Result<Self> {
|
||||||
|
Ok(ADBRsaKey {
|
||||||
|
private_key: RsaPrivateKey::from_pkcs8_pem(pkcs8_content)?,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn android_pubkey_encode(&self) -> Result<String> {
|
||||||
|
// Helped from project: https://github.com/hajifkd/webadb
|
||||||
|
// Source code: https://android.googlesource.com/platform/system/core/+/refs/heads/main/libcrypto_utils/android_pubkey.cpp
|
||||||
|
// Useful function `android_pubkey_encode()`
|
||||||
|
let mut adb_rsa_pubkey =
|
||||||
|
ADBRsaInternalPublicKey::new(self.private_key.e(), self.private_key.n())?;
|
||||||
|
|
||||||
|
// r32 = 2 ^ 32
|
||||||
|
let r32 = BigUint::from_u64(1 << 32).ok_or(RustADBError::ConversionError)?;
|
||||||
|
|
||||||
|
// r = 2 ^ rsa_size = 2 ^ 2048
|
||||||
|
let r = set_bit(ADB_PRIVATE_KEY_SIZE)?;
|
||||||
|
|
||||||
|
// rr = r ^ 2 mod N
|
||||||
|
let rr = r.modpow(&BigUint::from(2u32), &adb_rsa_pubkey.modulus);
|
||||||
|
adb_rsa_pubkey.rr = rr.to_bytes_le();
|
||||||
|
|
||||||
|
// rem = N[0]
|
||||||
|
let rem = &adb_rsa_pubkey.modulus % &r32;
|
||||||
|
|
||||||
|
// n0inv = -1 / rem mod r32
|
||||||
|
let n0inv = rem
|
||||||
|
.mod_inverse(&r32)
|
||||||
|
.and_then(|v| v.to_biguint())
|
||||||
|
.ok_or(RustADBError::ConversionError)?;
|
||||||
|
|
||||||
|
// BN_sub(n0inv, r32, n0inv)
|
||||||
|
adb_rsa_pubkey.n0inv = (r32 - n0inv)
|
||||||
|
.to_u32()
|
||||||
|
.ok_or(RustADBError::ConversionError)?;
|
||||||
|
|
||||||
|
Ok(self.encode_public_key(adb_rsa_pubkey.into_bytes()))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn encode_public_key(&self, pub_key: Vec<u8>) -> String {
|
||||||
|
let mut encoded = STANDARD.encode(pub_key);
|
||||||
|
encoded.push(' ');
|
||||||
|
encoded.push_str(&format!("adb_client@{}", env!("CARGO_PKG_VERSION")));
|
||||||
|
|
||||||
|
encoded
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn sign(&self, msg: impl AsRef<[u8]>) -> Result<Vec<u8>> {
|
||||||
|
Ok(self
|
||||||
|
.private_key
|
||||||
|
.sign(Pkcs1v15Sign::new::<sha1::Sha1>(), msg.as_ref())?)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn set_bit(n: usize) -> Result<BigUint> {
|
||||||
|
BigUint::parse_bytes(
|
||||||
|
&{
|
||||||
|
let mut bits = vec![b'1'];
|
||||||
|
bits.append(&mut vec![b'0'; n]);
|
||||||
|
bits
|
||||||
|
}[..],
|
||||||
|
2,
|
||||||
|
)
|
||||||
|
.ok_or(RustADBError::ConversionError)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_pubkey_gen() {
|
||||||
|
const DEFAULT_PRIV_KEY: &'static str = r"-----BEGIN PRIVATE KEY-----
|
||||||
|
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQC4Dyn85cxDJnjM
|
||||||
|
uYXQl/w469MDKdlGdviLfmFMWeYLVfL2Mz1AVyvKqscrtlhbbgMQ/M+3lDvEdHS0
|
||||||
|
14RIGAwWRtrlTTmhLvM2/IO+eSKSYeCrCVc4KLG3E3WRryUXbs2ynA29xjTJVw+Z
|
||||||
|
xYxDyn/tAYPEyMm4v+HIJHcOtRzxtO2vjMJ2vBT/ywYxjhncXbFSO09q2E4XrHli
|
||||||
|
SIPyO82hZgCkpzTZRp+nyA17TYuV9++mvUr9lWH9RbC+o8EF3yitlBsE2uXr97EV
|
||||||
|
i2Qy8CE7FIxsihXlukppwKRuz+1rJrvmZPTn49ZS+sIS99WE9GoCpsyQvTpvehrM
|
||||||
|
SIDRsVZPAgMBAAECggEAWNXAzzXeS36zCSR1yILCknqHotw86Pyc4z7BGUe+dzQp
|
||||||
|
itiaNIaeNTgN3zQoGyDSzA0o+BLMcfo/JdVrHBy3IL1cAxYtvXTaoGxp7bGrlPk2
|
||||||
|
pXZhqVJCy/jRYtokzdWF5DHbk/+pFJA3kGE/XKzM54g2n/DFI61A/QdUiz2w1ZtI
|
||||||
|
vc5cM08EM8B/TSI3SeWB8zkh5SlIuLsFO2J2+tCak6PdFfKOVIrFv9dKJYLxx+59
|
||||||
|
+edZamw2EvNlnl/sewgUk0gaZvQKVf4ivHyM+KSHuV4RFfiLvGuVcyA6XhSjztsG
|
||||||
|
EA++jDHP5ib/Izes7UK09v9y7kow+z6vUtnDDQOvgQKBgQD8WWAn7FQt9aziCw19
|
||||||
|
gZynzHG1bXI7uuEVSneuA3UwJImmDu8W+Qb9YL9Dc2nV0M5pGGdXKi2jzq8gPar6
|
||||||
|
GPAmy7TOlov6Nm0pbMXTAfuovG+gIXxelp3US3FvyRupi0/7UQRRwvetFYbDFwJX
|
||||||
|
ydF5uEtZdGSHAjPeU5FLq6tBwQKBgQC6uN0JwwZn+eaxguyKOXvp0KykhFI0HI1A
|
||||||
|
MBDZ1uuKt6OW5+r9NeQtTLctGlNKVQ8wz+Wr0C/nLGIIv4lySS9WFyc5/FnFhDdy
|
||||||
|
LsEi6whcca4vq3jsMOukvQGFnERsou4LqBEI1Es7jjeeEq+/8WnNTi6Y1flZ6UAp
|
||||||
|
YAOeFI98DwKBgQDvyfHgHeajwZalOQF5qGb24AOQ9c4dyefGNnvhA/IgbCfMftZc
|
||||||
|
iwhETuGQM6R3A7KQFRtlrXOu+2BYD6Ffg8D37IwD3vRmL7+tJGoapwC/B0g+7nLi
|
||||||
|
4tZY+9Nv+LbrdbDry8GB+/UkKJdk3IFicCk4M5KOD1bTH5mwAtLHB/p1QQKBgDHi
|
||||||
|
k8M45GxA+p4wMUvYgb987bLiWyfq/N3KOaZJYhJkb4MwoLpXfIeRuFqHbvsr8GwF
|
||||||
|
DwIxE6s6U1KtAWaUIN5qPyOhxMYdRcbusNDIZCp2gKfhsuO/SiVwDYkJr8oqWVip
|
||||||
|
5SsrtJHLtBY6PdQVBkRAf/h7KiwYQfkL2suQCKmHAoGBAJAkYImBYPHuRcnSXikn
|
||||||
|
xGDK/moPvzs0CjdPlRcEN+Myy/G0FUrOaC0FcpNoJOdQSYz3F6URA4nX+zj6Ie7G
|
||||||
|
CNkECiepaGyquQaffwR1CAi8dH6biJjlTQWQPFcCLA0hvernWo3eaSfiL7fHyym+
|
||||||
|
ile69MHFENUePSpuRSiF3Z02
|
||||||
|
-----END PRIVATE KEY-----";
|
||||||
|
let priv_key =
|
||||||
|
ADBRsaKey::new_from_pkcs8(DEFAULT_PRIV_KEY).expect("cannot create rsa key from data");
|
||||||
|
let pub_key = priv_key
|
||||||
|
.android_pubkey_encode()
|
||||||
|
.expect("cannot encode public key");
|
||||||
|
let pub_key_adb = "\
|
||||||
|
QAAAAFH/pU9PVrHRgEjMGnpvOr2QzKYCavSE1fcSwvpS1uPn9GTmuyZr7c9up\
|
||||||
|
MBpSrrlFYpsjBQ7IfAyZIsVsffr5doEG5StKN8FwaO+sEX9YZX9Sr2m7/eVi0\
|
||||||
|
17Dcinn0bZNKekAGahzTvyg0hieawXTthqTztSsV3cGY4xBsv/FLx2woyv7bT\
|
||||||
|
xHLUOdyTI4b+4ycjEgwHtf8pDjMWZD1fJNMa9DZyyzW4XJa+RdRO3sSg4Vwmr\
|
||||||
|
4GGSInm+g/w28y6hOU3l2kYWDBhIhNe0dHTEO5S3z/wQA25bWLYrx6rKK1dAP\
|
||||||
|
TP28lUL5llMYX6L+HZG2SkD0+s4/JfQhbnMeCZDzOX8KQ+4ThLy/gDTqCSTjj\
|
||||||
|
ic8BykdUIqYPwAjBMgQwLOLY5WNJMpjGlFINRcCGhvFFZ73sJTLerECuV/Oae\
|
||||||
|
nFRcORwnGIRgMrYXj4tjmxJC7sq3cfNX96YIcSCDE9SZFdlKXVK8Jc4YMLGF3\
|
||||||
|
MI8k1KoTby34uaIyxPJvwM1WR4Rdj60fwMyikFXNaOR2fPteZ3UMBA7CMrOEm\
|
||||||
|
9iYjntyEppA4hQXIO1TWTzkA/Kfl1i67k5NuLIQdhPFEc5ox5IYVHusauPQ7d\
|
||||||
|
Awu6BlgK37TUn0JdK0Z6Z4RaEIaNiEI0d5CoP6zQKV2QQnlscYpdsaUW5t9/F\
|
||||||
|
LioVXPwrz0tx35JyIUZPPYwEAAQA= ";
|
||||||
|
assert_eq!(&pub_key[..pub_key_adb.len()], pub_key_adb);
|
||||||
|
}
|
||||||
307
adb_client/src/message_devices/usb/adb_usb_device.rs
Normal file
307
adb_client/src/message_devices/usb/adb_usb_device.rs
Normal file
@@ -0,0 +1,307 @@
|
|||||||
|
use rusb::Device;
|
||||||
|
use rusb::DeviceDescriptor;
|
||||||
|
use rusb::UsbContext;
|
||||||
|
use rusb::constants::LIBUSB_CLASS_VENDOR_SPEC;
|
||||||
|
use std::fs::read_to_string;
|
||||||
|
use std::io::Read;
|
||||||
|
use std::io::Write;
|
||||||
|
use std::path::Path;
|
||||||
|
use std::path::PathBuf;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use crate::ADBDeviceExt;
|
||||||
|
use crate::Result;
|
||||||
|
use crate::RustADBError;
|
||||||
|
use crate::adb_transport::ADBTransport;
|
||||||
|
use crate::message_devices::adb_message_device::ADBMessageDevice;
|
||||||
|
use crate::message_devices::adb_message_transport::ADBMessageTransport;
|
||||||
|
use crate::message_devices::adb_transport_message::ADBTransportMessage;
|
||||||
|
use crate::message_devices::message_commands::MessageCommand;
|
||||||
|
use crate::usb::adb_rsa_key::ADBRsaKey;
|
||||||
|
use crate::usb::usb_transport::USBTransport;
|
||||||
|
use crate::utils::get_default_adb_key_path;
|
||||||
|
|
||||||
|
const AUTH_TOKEN: u32 = 1;
|
||||||
|
const AUTH_SIGNATURE: u32 = 2;
|
||||||
|
const AUTH_RSAPUBLICKEY: u32 = 3;
|
||||||
|
|
||||||
|
pub fn read_adb_private_key<P: AsRef<Path>>(private_key_path: P) -> Result<Option<ADBRsaKey>> {
|
||||||
|
// Try to read the private key file from given path
|
||||||
|
// If the file is not found, return None
|
||||||
|
// If there is another error while reading the file, return this error
|
||||||
|
// Else, return the private key content
|
||||||
|
let pk = match read_to_string(private_key_path.as_ref()) {
|
||||||
|
Ok(pk) => pk,
|
||||||
|
Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(None),
|
||||||
|
Err(e) => return Err(e.into()),
|
||||||
|
};
|
||||||
|
|
||||||
|
match ADBRsaKey::new_from_pkcs8(&pk) {
|
||||||
|
Ok(pk) => Ok(Some(pk)),
|
||||||
|
Err(e) => Err(e),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Search for adb devices with known interface class and subclass values
|
||||||
|
pub fn search_adb_devices() -> Result<Option<(u16, u16)>> {
|
||||||
|
let mut found_devices = vec![];
|
||||||
|
for device in rusb::devices()?.iter() {
|
||||||
|
let Ok(des) = device.device_descriptor() else {
|
||||||
|
continue;
|
||||||
|
};
|
||||||
|
if is_adb_device(&device, &des) {
|
||||||
|
log::debug!(
|
||||||
|
"Autodetect device {:04x}:{:04x}",
|
||||||
|
des.vendor_id(),
|
||||||
|
des.product_id()
|
||||||
|
);
|
||||||
|
found_devices.push((des.vendor_id(), des.product_id()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
match (found_devices.first(), found_devices.get(1)) {
|
||||||
|
(None, _) => Ok(None),
|
||||||
|
(Some(identifiers), None) => Ok(Some(*identifiers)),
|
||||||
|
(Some((vid1, pid1)), Some((vid2, pid2))) => Err(RustADBError::DeviceNotFound(format!(
|
||||||
|
"Found two Android devices {vid1:04x}:{pid1:04x} and {vid2:04x}:{pid2:04x}",
|
||||||
|
))),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Check whether a device with given descriptor is an ADB device
|
||||||
|
pub fn is_adb_device<T: UsbContext>(device: &Device<T>, des: &DeviceDescriptor) -> bool {
|
||||||
|
const ADB_SUBCLASS: u8 = 0x42;
|
||||||
|
const ADB_PROTOCOL: u8 = 0x1;
|
||||||
|
|
||||||
|
// Some devices require choosing the file transfer mode
|
||||||
|
// for usb debugging to take effect.
|
||||||
|
const BULK_CLASS: u8 = 0xdc;
|
||||||
|
const BULK_ADB_SUBCLASS: u8 = 2;
|
||||||
|
|
||||||
|
for n in 0..des.num_configurations() {
|
||||||
|
let Ok(config_des) = device.config_descriptor(n) else {
|
||||||
|
continue;
|
||||||
|
};
|
||||||
|
for interface in config_des.interfaces() {
|
||||||
|
for interface_des in interface.descriptors() {
|
||||||
|
let proto = interface_des.protocol_code();
|
||||||
|
let class = interface_des.class_code();
|
||||||
|
let subcl = interface_des.sub_class_code();
|
||||||
|
if proto == ADB_PROTOCOL
|
||||||
|
&& ((class == LIBUSB_CLASS_VENDOR_SPEC && subcl == ADB_SUBCLASS)
|
||||||
|
|| (class == BULK_CLASS && subcl == BULK_ADB_SUBCLASS))
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
false
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Represent a device reached and available over USB.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct ADBUSBDevice {
|
||||||
|
private_key: ADBRsaKey,
|
||||||
|
inner: ADBMessageDevice<USBTransport>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBUSBDevice {
|
||||||
|
/// Instantiate a new [`ADBUSBDevice`]
|
||||||
|
pub fn new(vendor_id: u16, product_id: u16) -> Result<Self> {
|
||||||
|
Self::new_with_custom_private_key(vendor_id, product_id, get_default_adb_key_path()?)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Instantiate a new [`ADBUSBDevice`] using a custom private key path
|
||||||
|
pub fn new_with_custom_private_key(
|
||||||
|
vendor_id: u16,
|
||||||
|
product_id: u16,
|
||||||
|
private_key_path: PathBuf,
|
||||||
|
) -> Result<Self> {
|
||||||
|
Self::new_from_transport_inner(USBTransport::new(vendor_id, product_id)?, private_key_path)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Instantiate a new [`ADBUSBDevice`] from a [`USBTransport`] and an optional private key path.
|
||||||
|
pub fn new_from_transport(
|
||||||
|
transport: USBTransport,
|
||||||
|
private_key_path: Option<PathBuf>,
|
||||||
|
) -> Result<Self> {
|
||||||
|
let private_key_path = match private_key_path {
|
||||||
|
Some(private_key_path) => private_key_path,
|
||||||
|
None => get_default_adb_key_path()?,
|
||||||
|
};
|
||||||
|
|
||||||
|
Self::new_from_transport_inner(transport, private_key_path)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn new_from_transport_inner(
|
||||||
|
transport: USBTransport,
|
||||||
|
private_key_path: PathBuf,
|
||||||
|
) -> Result<Self> {
|
||||||
|
let private_key = match read_adb_private_key(&private_key_path)? {
|
||||||
|
Some(pk) => pk,
|
||||||
|
None => {
|
||||||
|
log::warn!(
|
||||||
|
"No private key found at path {}. Using a temporary random one.",
|
||||||
|
private_key_path.display()
|
||||||
|
);
|
||||||
|
ADBRsaKey::new_random()?
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut s = Self {
|
||||||
|
private_key,
|
||||||
|
inner: ADBMessageDevice::new(transport),
|
||||||
|
};
|
||||||
|
|
||||||
|
s.connect()?;
|
||||||
|
|
||||||
|
Ok(s)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// autodetect connected ADB devices and establish a connection with the first device found
|
||||||
|
pub fn autodetect() -> Result<Self> {
|
||||||
|
Self::autodetect_with_custom_private_key(get_default_adb_key_path()?)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// autodetect connected ADB devices and establish a connection with the first device found using a custom private key path
|
||||||
|
pub fn autodetect_with_custom_private_key(private_key_path: PathBuf) -> Result<Self> {
|
||||||
|
match search_adb_devices()? {
|
||||||
|
Some((vendor_id, product_id)) => {
|
||||||
|
ADBUSBDevice::new_with_custom_private_key(vendor_id, product_id, private_key_path)
|
||||||
|
}
|
||||||
|
_ => Err(RustADBError::DeviceNotFound(
|
||||||
|
"cannot find USB devices matching the signature of an ADB device".into(),
|
||||||
|
)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Send initial connect
|
||||||
|
pub fn connect(&mut self) -> Result<()> {
|
||||||
|
self.get_transport_mut().connect()?;
|
||||||
|
|
||||||
|
let message = ADBTransportMessage::new(
|
||||||
|
MessageCommand::Cnxn,
|
||||||
|
0x01000000,
|
||||||
|
1048576,
|
||||||
|
format!("host::{}\0", env!("CARGO_PKG_NAME")).as_bytes(),
|
||||||
|
);
|
||||||
|
|
||||||
|
self.get_transport_mut().write_message(message)?;
|
||||||
|
|
||||||
|
let message = self.get_transport_mut().read_message()?;
|
||||||
|
// If the device returned CNXN instead of AUTH it does not require authentication,
|
||||||
|
// so we can skip the auth steps.
|
||||||
|
if message.header().command() == MessageCommand::Cnxn {
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
message.assert_command(MessageCommand::Auth)?;
|
||||||
|
|
||||||
|
// At this point, we should have receive an AUTH message with arg0 == 1
|
||||||
|
let auth_message = match message.header().arg0() {
|
||||||
|
AUTH_TOKEN => message,
|
||||||
|
v => {
|
||||||
|
return Err(RustADBError::ADBRequestFailed(format!(
|
||||||
|
"Received AUTH message with type != 1 ({v})"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let sign = self.private_key.sign(auth_message.into_payload())?;
|
||||||
|
|
||||||
|
let message = ADBTransportMessage::new(MessageCommand::Auth, AUTH_SIGNATURE, 0, &sign);
|
||||||
|
|
||||||
|
self.get_transport_mut().write_message(message)?;
|
||||||
|
|
||||||
|
let received_response = self.get_transport_mut().read_message()?;
|
||||||
|
|
||||||
|
if received_response.header().command() == MessageCommand::Cnxn {
|
||||||
|
log::info!(
|
||||||
|
"Authentication OK, device info {}",
|
||||||
|
String::from_utf8(received_response.into_payload())?
|
||||||
|
);
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut pubkey = self.private_key.android_pubkey_encode()?.into_bytes();
|
||||||
|
pubkey.push(b'\0');
|
||||||
|
|
||||||
|
let message = ADBTransportMessage::new(MessageCommand::Auth, AUTH_RSAPUBLICKEY, 0, &pubkey);
|
||||||
|
|
||||||
|
self.get_transport_mut().write_message(message)?;
|
||||||
|
|
||||||
|
let response = self
|
||||||
|
.get_transport_mut()
|
||||||
|
.read_message_with_timeout(Duration::from_secs(10))
|
||||||
|
.and_then(|message| {
|
||||||
|
message.assert_command(MessageCommand::Cnxn)?;
|
||||||
|
Ok(message)
|
||||||
|
})?;
|
||||||
|
|
||||||
|
log::info!(
|
||||||
|
"Authentication OK, device info {}",
|
||||||
|
String::from_utf8(response.into_payload())?
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn get_transport_mut(&mut self) -> &mut USBTransport {
|
||||||
|
self.inner.get_transport_mut()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBDeviceExt for ADBUSBDevice {
|
||||||
|
#[inline]
|
||||||
|
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
|
||||||
|
self.inner.shell_command(command, output)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn shell<'a>(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()> {
|
||||||
|
self.inner.shell(reader, writer)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn stat(&mut self, remote_path: &str) -> Result<crate::AdbStatResponse> {
|
||||||
|
self.inner.stat(remote_path)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()> {
|
||||||
|
self.inner.pull(source, output)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
|
||||||
|
self.inner.push(stream, path)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn reboot(&mut self, reboot_type: crate::RebootType) -> Result<()> {
|
||||||
|
self.inner.reboot(reboot_type)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
|
||||||
|
self.inner.install(apk_path)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn uninstall(&mut self, package: &str) -> Result<()> {
|
||||||
|
self.inner.uninstall(package)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn framebuffer_inner(&mut self) -> Result<image::ImageBuffer<image::Rgba<u8>, Vec<u8>>> {
|
||||||
|
self.inner.framebuffer_inner()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for ADBUSBDevice {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
// Best effort here
|
||||||
|
let _ = self.get_transport_mut().disconnect();
|
||||||
|
}
|
||||||
|
}
|
||||||
8
adb_client/src/message_devices/usb/mod.rs
Normal file
8
adb_client/src/message_devices/usb/mod.rs
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
#![doc = include_str!("./README.md")]
|
||||||
|
|
||||||
|
mod adb_rsa_key;
|
||||||
|
mod adb_usb_device;
|
||||||
|
mod usb_transport;
|
||||||
|
|
||||||
|
pub use adb_usb_device::ADBUSBDevice;
|
||||||
|
pub use usb_transport::USBTransport;
|
||||||
268
adb_client/src/message_devices/usb/usb_transport.rs
Normal file
268
adb_client/src/message_devices/usb/usb_transport.rs
Normal file
@@ -0,0 +1,268 @@
|
|||||||
|
use std::{sync::Arc, time::Duration};
|
||||||
|
|
||||||
|
use rusb::{
|
||||||
|
Device, DeviceHandle, Direction, GlobalContext, TransferType,
|
||||||
|
constants::LIBUSB_CLASS_VENDOR_SPEC,
|
||||||
|
};
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
Result, RustADBError,
|
||||||
|
adb_transport::ADBTransport,
|
||||||
|
message_devices::{
|
||||||
|
adb_message_transport::ADBMessageTransport,
|
||||||
|
adb_transport_message::{ADBTransportMessage, ADBTransportMessageHeader},
|
||||||
|
message_commands::MessageCommand,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
struct Endpoint {
|
||||||
|
iface: u8,
|
||||||
|
address: u8,
|
||||||
|
max_packet_size: usize,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Transport running on USB
|
||||||
|
#[derive(Debug, Clone)]
|
||||||
|
pub struct USBTransport {
|
||||||
|
device: Device<GlobalContext>,
|
||||||
|
handle: Option<Arc<DeviceHandle<GlobalContext>>>,
|
||||||
|
read_endpoint: Option<Endpoint>,
|
||||||
|
write_endpoint: Option<Endpoint>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl USBTransport {
|
||||||
|
/// Instantiate a new [`USBTransport`].
|
||||||
|
/// Only the first device with given vendor_id and product_id is returned.
|
||||||
|
pub fn new(vendor_id: u16, product_id: u16) -> Result<Self> {
|
||||||
|
for device in rusb::devices()?.iter() {
|
||||||
|
if let Ok(descriptor) = device.device_descriptor() {
|
||||||
|
if descriptor.vendor_id() == vendor_id && descriptor.product_id() == product_id {
|
||||||
|
return Ok(Self::new_from_device(device));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Err(RustADBError::DeviceNotFound(format!(
|
||||||
|
"cannot find USB device with vendor_id={vendor_id} and product_id={product_id}",
|
||||||
|
)))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Instantiate a new [`USBTransport`] from a [`rusb::Device`].
|
||||||
|
///
|
||||||
|
/// Devices can be enumerated using [`rusb::devices()`] and then filtered out to get desired device.
|
||||||
|
pub fn new_from_device(rusb_device: rusb::Device<GlobalContext>) -> Self {
|
||||||
|
Self {
|
||||||
|
device: rusb_device,
|
||||||
|
handle: None,
|
||||||
|
read_endpoint: None,
|
||||||
|
write_endpoint: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn get_raw_connection(&self) -> Result<Arc<DeviceHandle<GlobalContext>>> {
|
||||||
|
self.handle
|
||||||
|
.as_ref()
|
||||||
|
.ok_or(RustADBError::IOError(std::io::Error::new(
|
||||||
|
std::io::ErrorKind::NotConnected,
|
||||||
|
"not connected",
|
||||||
|
)))
|
||||||
|
.cloned()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_read_endpoint(&self) -> Result<Endpoint> {
|
||||||
|
self.read_endpoint
|
||||||
|
.as_ref()
|
||||||
|
.ok_or(RustADBError::IOError(std::io::Error::new(
|
||||||
|
std::io::ErrorKind::NotConnected,
|
||||||
|
"no read endpoint setup",
|
||||||
|
)))
|
||||||
|
.cloned()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_write_endpoint(&self) -> Result<&Endpoint> {
|
||||||
|
self.write_endpoint
|
||||||
|
.as_ref()
|
||||||
|
.ok_or(RustADBError::IOError(std::io::Error::new(
|
||||||
|
std::io::ErrorKind::NotConnected,
|
||||||
|
"no write endpoint setup",
|
||||||
|
)))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn configure_endpoint(handle: &DeviceHandle<GlobalContext>, endpoint: &Endpoint) -> Result<()> {
|
||||||
|
handle.claim_interface(endpoint.iface)?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn find_endpoints(&self, handle: &DeviceHandle<GlobalContext>) -> Result<(Endpoint, Endpoint)> {
|
||||||
|
let mut read_endpoint: Option<Endpoint> = None;
|
||||||
|
let mut write_endpoint: Option<Endpoint> = None;
|
||||||
|
|
||||||
|
for n in 0..handle.device().device_descriptor()?.num_configurations() {
|
||||||
|
let config_desc = match handle.device().config_descriptor(n) {
|
||||||
|
Ok(c) => c,
|
||||||
|
Err(_) => continue,
|
||||||
|
};
|
||||||
|
|
||||||
|
for interface in config_desc.interfaces() {
|
||||||
|
for interface_desc in interface.descriptors() {
|
||||||
|
for endpoint_desc in interface_desc.endpoint_descriptors() {
|
||||||
|
if endpoint_desc.transfer_type() == TransferType::Bulk
|
||||||
|
&& interface_desc.class_code() == LIBUSB_CLASS_VENDOR_SPEC
|
||||||
|
&& interface_desc.sub_class_code() == 0x42
|
||||||
|
&& interface_desc.protocol_code() == 0x01
|
||||||
|
{
|
||||||
|
let endpoint = Endpoint {
|
||||||
|
iface: interface_desc.interface_number(),
|
||||||
|
address: endpoint_desc.address(),
|
||||||
|
max_packet_size: endpoint_desc.max_packet_size() as usize,
|
||||||
|
};
|
||||||
|
match endpoint_desc.direction() {
|
||||||
|
Direction::In => {
|
||||||
|
if let Some(write_endpoint) = write_endpoint {
|
||||||
|
return Ok((endpoint, write_endpoint));
|
||||||
|
} else {
|
||||||
|
read_endpoint = Some(endpoint);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Direction::Out => {
|
||||||
|
if let Some(read_endpoint) = read_endpoint {
|
||||||
|
return Ok((read_endpoint, endpoint));
|
||||||
|
} else {
|
||||||
|
write_endpoint = Some(endpoint);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Err(RustADBError::USBNoDescriptorFound)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn write_bulk_data(&self, data: &[u8], timeout: Duration) -> Result<()> {
|
||||||
|
let endpoint = self.get_write_endpoint()?;
|
||||||
|
let handle = self.get_raw_connection()?;
|
||||||
|
let max_packet_size = endpoint.max_packet_size;
|
||||||
|
|
||||||
|
let mut offset = 0;
|
||||||
|
let data_len = data.len();
|
||||||
|
while offset < data_len {
|
||||||
|
let end = (offset + max_packet_size).min(data_len);
|
||||||
|
let write_amount = handle.write_bulk(endpoint.address, &data[offset..end], timeout)?;
|
||||||
|
offset += write_amount;
|
||||||
|
|
||||||
|
log::trace!("wrote chunk of size {write_amount} - {offset}/{data_len}",)
|
||||||
|
}
|
||||||
|
|
||||||
|
if offset % max_packet_size == 0 {
|
||||||
|
log::trace!("must send final zero-length packet");
|
||||||
|
handle.write_bulk(endpoint.address, &[], timeout)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBTransport for USBTransport {
|
||||||
|
fn connect(&mut self) -> crate::Result<()> {
|
||||||
|
let device = self.device.open()?;
|
||||||
|
|
||||||
|
let (read_endpoint, write_endpoint) = self.find_endpoints(&device)?;
|
||||||
|
|
||||||
|
Self::configure_endpoint(&device, &read_endpoint)?;
|
||||||
|
log::debug!("got read endpoint: {read_endpoint:?}");
|
||||||
|
self.read_endpoint = Some(read_endpoint);
|
||||||
|
|
||||||
|
Self::configure_endpoint(&device, &write_endpoint)?;
|
||||||
|
log::debug!("got write endpoint: {write_endpoint:?}");
|
||||||
|
self.write_endpoint = Some(write_endpoint);
|
||||||
|
|
||||||
|
self.handle = Some(Arc::new(device));
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn disconnect(&mut self) -> crate::Result<()> {
|
||||||
|
let message = ADBTransportMessage::new(MessageCommand::Clse, 0, 0, &[]);
|
||||||
|
if let Err(e) = self.write_message(message) {
|
||||||
|
log::error!("error while sending CLSE message: {e}");
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(handle) = &self.handle {
|
||||||
|
let endpoint = self.read_endpoint.as_ref().or(self.write_endpoint.as_ref());
|
||||||
|
if let Some(endpoint) = &endpoint {
|
||||||
|
match handle.release_interface(endpoint.iface) {
|
||||||
|
Ok(()) => log::debug!("succesfully released interface"),
|
||||||
|
Err(e) => log::error!("error while release interface: {e}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBMessageTransport for USBTransport {
|
||||||
|
fn write_message_with_timeout(
|
||||||
|
&mut self,
|
||||||
|
message: ADBTransportMessage,
|
||||||
|
timeout: Duration,
|
||||||
|
) -> Result<()> {
|
||||||
|
let message_bytes = message.header().as_bytes()?;
|
||||||
|
self.write_bulk_data(&message_bytes, timeout)?;
|
||||||
|
|
||||||
|
log::trace!("successfully write header: {} bytes", message_bytes.len());
|
||||||
|
|
||||||
|
let payload = message.into_payload();
|
||||||
|
if !payload.is_empty() {
|
||||||
|
self.write_bulk_data(&payload, timeout)?;
|
||||||
|
log::trace!("successfully write payload: {} bytes", payload.len());
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn read_message_with_timeout(&mut self, timeout: Duration) -> Result<ADBTransportMessage> {
|
||||||
|
let endpoint = self.get_read_endpoint()?;
|
||||||
|
let handle = self.get_raw_connection()?;
|
||||||
|
let max_packet_size = endpoint.max_packet_size;
|
||||||
|
|
||||||
|
let mut data = [0u8; 24];
|
||||||
|
let mut offset = 0;
|
||||||
|
while offset < data.len() {
|
||||||
|
let end = (offset + max_packet_size).min(data.len());
|
||||||
|
let chunk = &mut data[offset..end];
|
||||||
|
offset += handle.read_bulk(endpoint.address, chunk, timeout)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
let header = ADBTransportMessageHeader::try_from(data)?;
|
||||||
|
log::trace!("received header {header:?}");
|
||||||
|
|
||||||
|
if header.data_length() != 0 {
|
||||||
|
let mut msg_data = vec![0_u8; header.data_length() as usize];
|
||||||
|
let mut offset = 0;
|
||||||
|
while offset < msg_data.len() {
|
||||||
|
let end = (offset + max_packet_size).min(msg_data.len());
|
||||||
|
let chunk = &mut msg_data[offset..end];
|
||||||
|
offset += handle.read_bulk(endpoint.address, chunk, timeout)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
let message = ADBTransportMessage::from_header_and_payload(header, msg_data);
|
||||||
|
|
||||||
|
// Check message integrity
|
||||||
|
if !message.check_message_integrity() {
|
||||||
|
return Err(RustADBError::InvalidIntegrity(
|
||||||
|
ADBTransportMessageHeader::compute_crc32(message.payload()),
|
||||||
|
message.header().data_crc32(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
return Ok(message);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(ADBTransportMessage::from_header_and_payload(header, vec![]))
|
||||||
|
}
|
||||||
|
}
|
||||||
47
adb_client/src/models/adb_stat_response.rs
Normal file
47
adb_client/src/models/adb_stat_response.rs
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
use byteorder::ByteOrder;
|
||||||
|
use chrono::{DateTime, Utc};
|
||||||
|
use std::{
|
||||||
|
fmt::Display,
|
||||||
|
time::{Duration, UNIX_EPOCH},
|
||||||
|
};
|
||||||
|
|
||||||
|
use byteorder::LittleEndian;
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
/// Represents a `stat` response
|
||||||
|
#[derive(Debug, Deserialize, Serialize)]
|
||||||
|
pub struct AdbStatResponse {
|
||||||
|
/// File permissions
|
||||||
|
pub file_perm: u32,
|
||||||
|
/// File size, in bytes
|
||||||
|
pub file_size: u32,
|
||||||
|
/// File modification time
|
||||||
|
pub mod_time: u32,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<[u8; 12]> for AdbStatResponse {
|
||||||
|
fn from(value: [u8; 12]) -> Self {
|
||||||
|
Self {
|
||||||
|
file_perm: LittleEndian::read_u32(&value[0..4]),
|
||||||
|
file_size: LittleEndian::read_u32(&value[4..8]),
|
||||||
|
mod_time: LittleEndian::read_u32(&value[8..]),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for AdbStatResponse {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
let d = UNIX_EPOCH + Duration::from_secs(self.mod_time.into());
|
||||||
|
// Create DateTime from SystemTime
|
||||||
|
let datetime = DateTime::<Utc>::from(d);
|
||||||
|
|
||||||
|
writeln!(f, "File permissions: {}", self.file_perm)?;
|
||||||
|
writeln!(f, "File size: {} bytes", self.file_size)?;
|
||||||
|
write!(
|
||||||
|
f,
|
||||||
|
"Modification time: {}",
|
||||||
|
datetime.format("%Y-%m-%d %H:%M:%S.%f %Z")
|
||||||
|
)?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
97
adb_client/src/models/framebuffer_info.rs
Normal file
97
adb_client/src/models/framebuffer_info.rs
Normal file
@@ -0,0 +1,97 @@
|
|||||||
|
use std::{iter::Map, slice::ChunksExact};
|
||||||
|
|
||||||
|
use byteorder::{ByteOrder, LittleEndian};
|
||||||
|
|
||||||
|
use crate::{Result, RustADBError};
|
||||||
|
|
||||||
|
type U32ChunkIter<'a> = Map<ChunksExact<'a, u8>, fn(&[u8]) -> Result<u32>>;
|
||||||
|
|
||||||
|
fn read_next(chunks: &mut U32ChunkIter) -> Result<u32> {
|
||||||
|
chunks
|
||||||
|
.next()
|
||||||
|
.ok_or(RustADBError::FramebufferConversionError)?
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub(crate) struct FrameBufferInfoV1 {
|
||||||
|
pub _bpp: u32,
|
||||||
|
pub size: u32,
|
||||||
|
pub width: u32,
|
||||||
|
pub height: u32,
|
||||||
|
pub _red_offset: u32,
|
||||||
|
pub _red_length: u32,
|
||||||
|
pub _blue_offset: u32,
|
||||||
|
pub _blue_length: u32,
|
||||||
|
pub _green_offset: u32,
|
||||||
|
pub _green_length: u32,
|
||||||
|
pub _alpha_offset: u32,
|
||||||
|
pub _alpha_length: u32,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<[u8; std::mem::size_of::<Self>()]> for FrameBufferInfoV1 {
|
||||||
|
type Error = RustADBError;
|
||||||
|
|
||||||
|
fn try_from(
|
||||||
|
value: [u8; std::mem::size_of::<Self>()],
|
||||||
|
) -> std::result::Result<Self, Self::Error> {
|
||||||
|
let mut chunks: U32ChunkIter = value.chunks_exact(4).map(|v| Ok(LittleEndian::read_u32(v)));
|
||||||
|
|
||||||
|
Ok(Self {
|
||||||
|
_bpp: read_next(&mut chunks)?,
|
||||||
|
size: read_next(&mut chunks)?,
|
||||||
|
width: read_next(&mut chunks)?,
|
||||||
|
height: read_next(&mut chunks)?,
|
||||||
|
_red_offset: read_next(&mut chunks)?,
|
||||||
|
_red_length: read_next(&mut chunks)?,
|
||||||
|
_blue_offset: read_next(&mut chunks)?,
|
||||||
|
_blue_length: read_next(&mut chunks)?,
|
||||||
|
_green_offset: read_next(&mut chunks)?,
|
||||||
|
_green_length: read_next(&mut chunks)?,
|
||||||
|
_alpha_offset: read_next(&mut chunks)?,
|
||||||
|
_alpha_length: read_next(&mut chunks)?,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub(crate) struct FrameBufferInfoV2 {
|
||||||
|
pub _bpp: u32,
|
||||||
|
pub _color_space: u32,
|
||||||
|
pub size: u32,
|
||||||
|
pub width: u32,
|
||||||
|
pub height: u32,
|
||||||
|
pub _red_offset: u32,
|
||||||
|
pub _red_length: u32,
|
||||||
|
pub _blue_offset: u32,
|
||||||
|
pub _blue_length: u32,
|
||||||
|
pub _green_offset: u32,
|
||||||
|
pub _green_length: u32,
|
||||||
|
pub _alpha_offset: u32,
|
||||||
|
pub _alpha_length: u32,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<[u8; std::mem::size_of::<Self>()]> for FrameBufferInfoV2 {
|
||||||
|
type Error = RustADBError;
|
||||||
|
|
||||||
|
fn try_from(
|
||||||
|
value: [u8; std::mem::size_of::<Self>()],
|
||||||
|
) -> std::result::Result<Self, Self::Error> {
|
||||||
|
let mut chunks: U32ChunkIter = value.chunks_exact(4).map(|v| Ok(LittleEndian::read_u32(v)));
|
||||||
|
|
||||||
|
Ok(Self {
|
||||||
|
_bpp: read_next(&mut chunks)?,
|
||||||
|
_color_space: read_next(&mut chunks)?,
|
||||||
|
size: read_next(&mut chunks)?,
|
||||||
|
width: read_next(&mut chunks)?,
|
||||||
|
height: read_next(&mut chunks)?,
|
||||||
|
_red_offset: read_next(&mut chunks)?,
|
||||||
|
_red_length: read_next(&mut chunks)?,
|
||||||
|
_blue_offset: read_next(&mut chunks)?,
|
||||||
|
_blue_length: read_next(&mut chunks)?,
|
||||||
|
_green_offset: read_next(&mut chunks)?,
|
||||||
|
_green_length: read_next(&mut chunks)?,
|
||||||
|
_alpha_offset: read_next(&mut chunks)?,
|
||||||
|
_alpha_length: read_next(&mut chunks)?,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,8 +1,11 @@
|
|||||||
use std::fmt::Display;
|
use std::fmt::Display;
|
||||||
|
|
||||||
|
/// Available host features.
|
||||||
#[derive(Debug, PartialEq)]
|
#[derive(Debug, PartialEq)]
|
||||||
pub enum HostFeatures {
|
pub enum HostFeatures {
|
||||||
|
/// Shell version 2.
|
||||||
ShellV2,
|
ShellV2,
|
||||||
|
/// Command.
|
||||||
Cmd,
|
Cmd,
|
||||||
}
|
}
|
||||||
|
|
||||||
13
adb_client/src/models/mod.rs
Normal file
13
adb_client/src/models/mod.rs
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
mod adb_request_status;
|
||||||
|
mod adb_stat_response;
|
||||||
|
mod framebuffer_info;
|
||||||
|
mod host_features;
|
||||||
|
mod reboot_type;
|
||||||
|
mod sync_command;
|
||||||
|
|
||||||
|
pub(crate) use adb_request_status::AdbRequestStatus;
|
||||||
|
pub use adb_stat_response::AdbStatResponse;
|
||||||
|
pub(crate) use framebuffer_info::{FrameBufferInfoV1, FrameBufferInfoV2};
|
||||||
|
pub use host_features::HostFeatures;
|
||||||
|
pub use reboot_type::RebootType;
|
||||||
|
pub(crate) use sync_command::SyncCommand;
|
||||||
@@ -13,6 +13,8 @@ pub enum RebootType {
|
|||||||
Sideload,
|
Sideload,
|
||||||
/// Same as `Sideload` but reboots after sideloading
|
/// Same as `Sideload` but reboots after sideloading
|
||||||
SideloadAutoReboot,
|
SideloadAutoReboot,
|
||||||
|
/// Reboots to fastboot
|
||||||
|
Fastboot,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Display for RebootType {
|
impl Display for RebootType {
|
||||||
@@ -23,6 +25,7 @@ impl Display for RebootType {
|
|||||||
RebootType::Recovery => write!(f, "recovery"),
|
RebootType::Recovery => write!(f, "recovery"),
|
||||||
RebootType::Sideload => write!(f, "sideload"),
|
RebootType::Sideload => write!(f, "sideload"),
|
||||||
RebootType::SideloadAutoReboot => write!(f, "sideload-auto-reboot"),
|
RebootType::SideloadAutoReboot => write!(f, "sideload-auto-reboot"),
|
||||||
|
RebootType::Fastboot => write!(f, "fastboot"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
15
adb_client/src/server/README.md
Normal file
15
adb_client/src/server/README.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# Examples
|
||||||
|
|
||||||
|
## Get available ADB devices
|
||||||
|
|
||||||
|
```rust no_run
|
||||||
|
use adb_client::server::ADBServer;
|
||||||
|
use std::net::{SocketAddrV4, Ipv4Addr};
|
||||||
|
|
||||||
|
// A custom server address can be provided
|
||||||
|
let server_ip = Ipv4Addr::new(127, 0, 0, 1);
|
||||||
|
let server_port = 5037;
|
||||||
|
|
||||||
|
let mut server = ADBServer::new(SocketAddrV4::new(server_ip, server_port));
|
||||||
|
server.devices();
|
||||||
|
```
|
||||||
112
adb_client/src/server/adb_server.rs
Normal file
112
adb_client/src/server/adb_server.rs
Normal file
@@ -0,0 +1,112 @@
|
|||||||
|
use crate::ADBTransport;
|
||||||
|
use crate::Result;
|
||||||
|
use crate::RustADBError;
|
||||||
|
use crate::server::tcp_server_transport::TCPServerTransport;
|
||||||
|
use std::collections::HashMap;
|
||||||
|
use std::net::SocketAddrV4;
|
||||||
|
use std::process::Command;
|
||||||
|
|
||||||
|
/// Represents an ADB Server
|
||||||
|
#[derive(Debug, Default)]
|
||||||
|
pub struct ADBServer {
|
||||||
|
/// Internal [TcpStream], lazily initialized
|
||||||
|
pub(crate) transport: Option<TCPServerTransport>,
|
||||||
|
/// Address to connect to
|
||||||
|
pub(crate) socket_addr: Option<SocketAddrV4>,
|
||||||
|
/// adb-server start envs
|
||||||
|
pub(crate) envs: HashMap<String, String>,
|
||||||
|
/// Path to adb binary
|
||||||
|
/// If not set, will use adb from PATH
|
||||||
|
pub(crate) adb_path: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ADBServer {
|
||||||
|
/// Instantiates a new [ADBServer]
|
||||||
|
pub fn new(address: SocketAddrV4) -> Self {
|
||||||
|
Self {
|
||||||
|
transport: None,
|
||||||
|
socket_addr: Some(address),
|
||||||
|
envs: HashMap::new(),
|
||||||
|
adb_path: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Instantiates a new [ADBServer] with a custom adb path
|
||||||
|
pub fn new_from_path(address: SocketAddrV4, adb_path: Option<String>) -> Self {
|
||||||
|
Self {
|
||||||
|
transport: None,
|
||||||
|
socket_addr: Some(address),
|
||||||
|
envs: HashMap::new(),
|
||||||
|
adb_path,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Start an instance of `adb-server`
|
||||||
|
pub fn start(envs: &HashMap<String, String>, adb_path: &Option<String>) {
|
||||||
|
// ADB Server is local, we start it if not already running
|
||||||
|
let mut command = Command::new(adb_path.as_deref().unwrap_or("adb"));
|
||||||
|
command.arg("start-server");
|
||||||
|
for (env_k, env_v) in envs.iter() {
|
||||||
|
command.env(env_k, env_v);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(target_os = "windows")]
|
||||||
|
{
|
||||||
|
use std::os::windows::process::CommandExt;
|
||||||
|
// Do not show a prompt on Windows
|
||||||
|
command.creation_flags(0x08000000);
|
||||||
|
}
|
||||||
|
|
||||||
|
let child = command.spawn();
|
||||||
|
match child {
|
||||||
|
Ok(mut child) => {
|
||||||
|
if let Err(e) = child.wait() {
|
||||||
|
log::error!("error while starting adb server: {e}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(e) => log::error!("error while starting adb server: {e}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns the current selected transport
|
||||||
|
pub(crate) fn get_transport(&mut self) -> Result<&mut TCPServerTransport> {
|
||||||
|
self.transport
|
||||||
|
.as_mut()
|
||||||
|
.ok_or(RustADBError::IOError(std::io::Error::new(
|
||||||
|
std::io::ErrorKind::NotConnected,
|
||||||
|
"server connection not initialized",
|
||||||
|
)))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Connect to underlying transport
|
||||||
|
pub(crate) fn connect(&mut self) -> Result<&mut TCPServerTransport> {
|
||||||
|
let mut is_local_ip = false;
|
||||||
|
let mut transport = if let Some(addr) = &self.socket_addr {
|
||||||
|
let ip = addr.ip();
|
||||||
|
if ip.is_loopback() || ip.is_unspecified() {
|
||||||
|
is_local_ip = true;
|
||||||
|
}
|
||||||
|
TCPServerTransport::new(*addr)
|
||||||
|
} else {
|
||||||
|
is_local_ip = true;
|
||||||
|
TCPServerTransport::default()
|
||||||
|
};
|
||||||
|
|
||||||
|
if is_local_ip {
|
||||||
|
Self::start(&self.envs, &self.adb_path);
|
||||||
|
}
|
||||||
|
|
||||||
|
transport.connect()?;
|
||||||
|
self.transport = Some(transport);
|
||||||
|
|
||||||
|
self.get_transport()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for ADBServer {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
if let Some(transport) = &mut self.transport {
|
||||||
|
let _ = transport.disconnect();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
114
adb_client/src/server/adb_server_command.rs
Normal file
114
adb_client/src/server/adb_server_command.rs
Normal file
@@ -0,0 +1,114 @@
|
|||||||
|
use std::fmt::Display;
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
RebootType,
|
||||||
|
server::{WaitForDeviceState, WaitForDeviceTransport},
|
||||||
|
};
|
||||||
|
|
||||||
|
use std::net::SocketAddrV4;
|
||||||
|
|
||||||
|
pub(crate) enum AdbServerCommand {
|
||||||
|
// Host commands
|
||||||
|
Version,
|
||||||
|
Kill,
|
||||||
|
Devices,
|
||||||
|
DevicesLong,
|
||||||
|
TrackDevices,
|
||||||
|
HostFeatures,
|
||||||
|
Connect(SocketAddrV4),
|
||||||
|
Disconnect(SocketAddrV4),
|
||||||
|
Pair(SocketAddrV4, String),
|
||||||
|
TransportAny,
|
||||||
|
TransportSerial(String),
|
||||||
|
MDNSCheck,
|
||||||
|
MDNSServices,
|
||||||
|
ServerStatus,
|
||||||
|
ReconnectOffline,
|
||||||
|
Uninstall(String),
|
||||||
|
Install(u64),
|
||||||
|
WaitForDevice(WaitForDeviceState, WaitForDeviceTransport),
|
||||||
|
// Local commands
|
||||||
|
ShellCommand(String),
|
||||||
|
Shell,
|
||||||
|
FrameBuffer,
|
||||||
|
Sync,
|
||||||
|
Reboot(RebootType),
|
||||||
|
Forward(String, String),
|
||||||
|
ForwardRemoveAll,
|
||||||
|
Reverse(String, String),
|
||||||
|
ReverseRemoveAll,
|
||||||
|
Reconnect,
|
||||||
|
TcpIp(u16),
|
||||||
|
Usb,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for AdbServerCommand {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
match self {
|
||||||
|
AdbServerCommand::Version => write!(f, "host:version"),
|
||||||
|
AdbServerCommand::Kill => write!(f, "host:kill"),
|
||||||
|
AdbServerCommand::Devices => write!(f, "host:devices"),
|
||||||
|
AdbServerCommand::DevicesLong => write!(f, "host:devices-l"),
|
||||||
|
AdbServerCommand::Sync => write!(f, "sync:"),
|
||||||
|
AdbServerCommand::TrackDevices => write!(f, "host:track-devices"),
|
||||||
|
AdbServerCommand::TransportAny => write!(f, "host:transport-any"),
|
||||||
|
AdbServerCommand::TransportSerial(serial) => write!(f, "host:transport:{serial}"),
|
||||||
|
AdbServerCommand::ShellCommand(command) => match std::env::var("TERM") {
|
||||||
|
Ok(term) => write!(f, "shell,TERM={term},raw:{command}"),
|
||||||
|
Err(_) => write!(f, "shell,raw:{command}"),
|
||||||
|
},
|
||||||
|
AdbServerCommand::Shell => match std::env::var("TERM") {
|
||||||
|
Ok(term) => write!(f, "shell,TERM={term},raw:"),
|
||||||
|
Err(_) => write!(f, "shell,raw:"),
|
||||||
|
},
|
||||||
|
AdbServerCommand::HostFeatures => write!(f, "host:features"),
|
||||||
|
AdbServerCommand::Reboot(reboot_type) => {
|
||||||
|
write!(f, "reboot:{reboot_type}")
|
||||||
|
}
|
||||||
|
AdbServerCommand::Connect(addr) => write!(f, "host:connect:{addr}"),
|
||||||
|
AdbServerCommand::Disconnect(addr) => write!(f, "host:disconnect:{addr}"),
|
||||||
|
AdbServerCommand::Pair(addr, code) => {
|
||||||
|
write!(f, "host:pair:{code}:{addr}")
|
||||||
|
}
|
||||||
|
AdbServerCommand::FrameBuffer => write!(f, "framebuffer:"),
|
||||||
|
AdbServerCommand::Forward(remote, local) => {
|
||||||
|
write!(f, "host:forward:{local};{remote}")
|
||||||
|
}
|
||||||
|
AdbServerCommand::ForwardRemoveAll => write!(f, "host:killforward-all"),
|
||||||
|
AdbServerCommand::Reverse(remote, local) => {
|
||||||
|
write!(f, "reverse:forward:{remote};{local}")
|
||||||
|
}
|
||||||
|
AdbServerCommand::ReverseRemoveAll => write!(f, "reverse:killforward-all"),
|
||||||
|
AdbServerCommand::MDNSCheck => write!(f, "host:mdns:check"),
|
||||||
|
AdbServerCommand::MDNSServices => write!(f, "host:mdns:services"),
|
||||||
|
AdbServerCommand::ServerStatus => write!(f, "host:server-status"),
|
||||||
|
AdbServerCommand::Reconnect => write!(f, "reconnect"),
|
||||||
|
AdbServerCommand::ReconnectOffline => write!(f, "host:reconnect-offline"),
|
||||||
|
AdbServerCommand::TcpIp(port) => {
|
||||||
|
write!(f, "tcpip:{port}")
|
||||||
|
}
|
||||||
|
AdbServerCommand::Usb => write!(f, "usb:"),
|
||||||
|
AdbServerCommand::Install(size) => write!(f, "exec:cmd package 'install' -S {size}"),
|
||||||
|
AdbServerCommand::Uninstall(package) => {
|
||||||
|
write!(f, "exec:cmd package 'uninstall' {package}")
|
||||||
|
}
|
||||||
|
AdbServerCommand::WaitForDevice(wait_for_device_state, wait_for_device_transport) => {
|
||||||
|
write!(
|
||||||
|
f,
|
||||||
|
"host:wait-for-{wait_for_device_transport}-{wait_for_device_state}"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_pair_command() {
|
||||||
|
let host = "192.168.0.197:34783";
|
||||||
|
let code = "091102";
|
||||||
|
let code_u32 = code.parse::<u32>().expect("cannot parse u32");
|
||||||
|
let pair = AdbServerCommand::Pair(host.parse().expect("cannot parse host"), code.into());
|
||||||
|
|
||||||
|
assert_eq!(pair.to_string(), format!("host:pair:{code}:{host}"));
|
||||||
|
assert_ne!(pair.to_string(), format!("host:pair:{code_u32}:{host}"))
|
||||||
|
}
|
||||||
20
adb_client/src/server/commands/connect.rs
Normal file
20
adb_client/src/server/commands/connect.rs
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
use crate::{
|
||||||
|
Result, RustADBError,
|
||||||
|
server::{ADBServer, AdbServerCommand},
|
||||||
|
};
|
||||||
|
use std::net::SocketAddrV4;
|
||||||
|
|
||||||
|
impl ADBServer {
|
||||||
|
/// Connect device over tcp with address and port
|
||||||
|
pub fn connect_device(&mut self, address: SocketAddrV4) -> Result<()> {
|
||||||
|
let response = self
|
||||||
|
.connect()?
|
||||||
|
.proxy_connection(AdbServerCommand::Connect(address), true)?;
|
||||||
|
|
||||||
|
match String::from_utf8(response) {
|
||||||
|
Ok(s) if s.starts_with("connected to") => Ok(()),
|
||||||
|
Ok(s) => Err(RustADBError::ADBRequestFailed(s)),
|
||||||
|
Err(e) => Err(e.into()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
125
adb_client/src/server/commands/devices.rs
Normal file
125
adb_client/src/server/commands/devices.rs
Normal file
@@ -0,0 +1,125 @@
|
|||||||
|
use std::io::Read;
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
Result, RustADBError,
|
||||||
|
emulator::ADBEmulatorDevice,
|
||||||
|
server::{ADBServer, AdbServerCommand, DeviceLong, DeviceShort},
|
||||||
|
server_device::ADBServerDevice,
|
||||||
|
};
|
||||||
|
|
||||||
|
impl ADBServer {
|
||||||
|
/// Gets a list of connected devices.
|
||||||
|
pub fn devices(&mut self) -> Result<Vec<DeviceShort>> {
|
||||||
|
let devices = self
|
||||||
|
.connect()?
|
||||||
|
.proxy_connection(AdbServerCommand::Devices, true)?;
|
||||||
|
|
||||||
|
let mut vec_devices: Vec<DeviceShort> = vec![];
|
||||||
|
for device in devices.split(|x| x.eq(&b'\n')) {
|
||||||
|
if device.is_empty() {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
vec_devices.push(DeviceShort::try_from(device.to_vec())?);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(vec_devices)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Gets an extended list of connected devices including the device paths in the state.
|
||||||
|
pub fn devices_long(&mut self) -> Result<Vec<DeviceLong>> {
|
||||||
|
let devices_long = self
|
||||||
|
.connect()?
|
||||||
|
.proxy_connection(AdbServerCommand::DevicesLong, true)?;
|
||||||
|
|
||||||
|
let mut vec_devices: Vec<DeviceLong> = vec![];
|
||||||
|
for device in devices_long.split(|x| x.eq(&b'\n')) {
|
||||||
|
if device.is_empty() {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
vec_devices.push(DeviceLong::try_from(device)?);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(vec_devices)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get a device, assuming that only this device is connected.
|
||||||
|
pub fn get_device(&mut self) -> Result<ADBServerDevice> {
|
||||||
|
let mut devices = self.devices()?.into_iter();
|
||||||
|
match devices.next() {
|
||||||
|
Some(device) => match devices.next() {
|
||||||
|
Some(_) => Err(RustADBError::DeviceNotFound(
|
||||||
|
"too many devices connected".to_string(),
|
||||||
|
)),
|
||||||
|
None => Ok(ADBServerDevice::new(device.identifier, self.socket_addr)),
|
||||||
|
},
|
||||||
|
None => Err(RustADBError::DeviceNotFound(
|
||||||
|
"no device connected".to_string(),
|
||||||
|
)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get a device matching the given name, if existing.
|
||||||
|
/// - There is no device connected => Error
|
||||||
|
/// - There is a single device connected => Ok
|
||||||
|
/// - There are more than 1 device connected => Error
|
||||||
|
pub fn get_device_by_name(&mut self, name: &str) -> Result<ADBServerDevice> {
|
||||||
|
let nb_devices = self
|
||||||
|
.devices()?
|
||||||
|
.into_iter()
|
||||||
|
.filter(|d| d.identifier.as_str() == name)
|
||||||
|
.collect::<Vec<DeviceShort>>()
|
||||||
|
.len();
|
||||||
|
if nb_devices != 1 {
|
||||||
|
Err(RustADBError::DeviceNotFound(format!(
|
||||||
|
"could not find device {name}"
|
||||||
|
)))
|
||||||
|
} else {
|
||||||
|
Ok(ADBServerDevice::new(name.to_string(), self.socket_addr))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Tracks new devices showing up.
|
||||||
|
pub fn track_devices(&mut self, callback: impl Fn(DeviceShort) -> Result<()>) -> Result<()> {
|
||||||
|
self.connect()?
|
||||||
|
.send_adb_request(AdbServerCommand::TrackDevices)?;
|
||||||
|
|
||||||
|
loop {
|
||||||
|
let length = self.get_transport()?.get_hex_body_length()?;
|
||||||
|
|
||||||
|
if length > 0 {
|
||||||
|
let mut body = vec![
|
||||||
|
0;
|
||||||
|
length
|
||||||
|
.try_into()
|
||||||
|
.map_err(|_| RustADBError::ConversionError)?
|
||||||
|
];
|
||||||
|
self.get_transport()?
|
||||||
|
.get_raw_connection()?
|
||||||
|
.read_exact(&mut body)?;
|
||||||
|
|
||||||
|
for device in body.split(|x| x.eq(&b'\n')) {
|
||||||
|
if device.is_empty() {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
callback(DeviceShort::try_from(device.to_vec())?)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get an emulator, assuming that only this device is connected.
|
||||||
|
pub fn get_emulator_device(&mut self) -> Result<ADBEmulatorDevice> {
|
||||||
|
let device = self.get_device()?;
|
||||||
|
|
||||||
|
ADBEmulatorDevice::try_from(device)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get an emulator by its name
|
||||||
|
pub fn get_emulator_device_by_name(&mut self, name: &str) -> Result<ADBEmulatorDevice> {
|
||||||
|
let device = self.get_device_by_name(name)?;
|
||||||
|
|
||||||
|
ADBEmulatorDevice::try_from(device)
|
||||||
|
}
|
||||||
|
}
|
||||||
20
adb_client/src/server/commands/disconnect.rs
Normal file
20
adb_client/src/server/commands/disconnect.rs
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
use crate::{
|
||||||
|
Result, RustADBError,
|
||||||
|
server::{ADBServer, AdbServerCommand},
|
||||||
|
};
|
||||||
|
use std::net::SocketAddrV4;
|
||||||
|
|
||||||
|
impl ADBServer {
|
||||||
|
/// Connect device over tcp with address and port
|
||||||
|
pub fn disconnect_device(&mut self, address: SocketAddrV4) -> Result<()> {
|
||||||
|
let response = self
|
||||||
|
.connect()?
|
||||||
|
.proxy_connection(AdbServerCommand::Disconnect(address), true)?;
|
||||||
|
|
||||||
|
match String::from_utf8(response) {
|
||||||
|
Ok(s) if s.starts_with("disconnected") => Ok(()),
|
||||||
|
Ok(s) => Err(RustADBError::ADBRequestFailed(s)),
|
||||||
|
Err(e) => Err(e.into()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
13
adb_client/src/server/commands/kill.rs
Normal file
13
adb_client/src/server/commands/kill.rs
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
use crate::{
|
||||||
|
Result,
|
||||||
|
server::{ADBServer, AdbServerCommand},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl ADBServer {
|
||||||
|
/// Asks the ADB server to quit immediately.
|
||||||
|
pub fn kill(&mut self) -> Result<()> {
|
||||||
|
self.connect()?
|
||||||
|
.proxy_connection(AdbServerCommand::Kill, false)
|
||||||
|
.map(|_| ())
|
||||||
|
}
|
||||||
|
}
|
||||||
62
adb_client/src/server/commands/mdns.rs
Normal file
62
adb_client/src/server/commands/mdns.rs
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
use std::io::BufRead;
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
Result,
|
||||||
|
server::{ADBServer, AdbServerCommand, MDNSServices, models::MDNSBackend},
|
||||||
|
};
|
||||||
|
|
||||||
|
const OPENSCREEN_MDNS_BACKEND: &str = "ADB_MDNS_OPENSCREEN";
|
||||||
|
|
||||||
|
impl ADBServer {
|
||||||
|
/// Check if mdns discovery is available
|
||||||
|
pub fn mdns_check(&mut self) -> Result<bool> {
|
||||||
|
let response = self
|
||||||
|
.connect()?
|
||||||
|
.proxy_connection(AdbServerCommand::MDNSCheck, true)?;
|
||||||
|
|
||||||
|
match String::from_utf8(response) {
|
||||||
|
Ok(s) if s.starts_with("mdns daemon version") => Ok(true),
|
||||||
|
Ok(_) => Ok(false),
|
||||||
|
Err(e) => Err(e.into()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// List all discovered mdns services
|
||||||
|
pub fn mdns_services(&mut self) -> Result<Vec<MDNSServices>> {
|
||||||
|
let services = self
|
||||||
|
.connect()?
|
||||||
|
.proxy_connection(AdbServerCommand::MDNSServices, true)?;
|
||||||
|
|
||||||
|
let mut vec_services: Vec<MDNSServices> = vec![];
|
||||||
|
for service in services.lines() {
|
||||||
|
match service {
|
||||||
|
Ok(service) => {
|
||||||
|
vec_services.push(MDNSServices::try_from(service.as_bytes())?);
|
||||||
|
}
|
||||||
|
Err(e) => log::error!("{e}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(vec_services)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Check if specified backend mdns service is used, otherwise restart adb server with envs
|
||||||
|
pub fn mdns_force_backend(&mut self, backend: MDNSBackend) -> Result<()> {
|
||||||
|
let server_status = self.server_status()?;
|
||||||
|
if server_status.mdns_backend != backend {
|
||||||
|
self.kill()?;
|
||||||
|
self.envs.insert(
|
||||||
|
OPENSCREEN_MDNS_BACKEND.to_string(),
|
||||||
|
(if backend == MDNSBackend::OpenScreen {
|
||||||
|
"1"
|
||||||
|
} else {
|
||||||
|
"0"
|
||||||
|
})
|
||||||
|
.to_string(),
|
||||||
|
);
|
||||||
|
self.connect()?;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
10
adb_client/src/server/commands/mod.rs
Normal file
10
adb_client/src/server/commands/mod.rs
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
mod connect;
|
||||||
|
mod devices;
|
||||||
|
mod disconnect;
|
||||||
|
mod kill;
|
||||||
|
mod mdns;
|
||||||
|
mod pair;
|
||||||
|
mod reconnect;
|
||||||
|
mod server_status;
|
||||||
|
mod version;
|
||||||
|
mod wait_for_device;
|
||||||
20
adb_client/src/server/commands/pair.rs
Normal file
20
adb_client/src/server/commands/pair.rs
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
use crate::{
|
||||||
|
Result, RustADBError,
|
||||||
|
server::{ADBServer, AdbServerCommand},
|
||||||
|
};
|
||||||
|
use std::net::SocketAddrV4;
|
||||||
|
|
||||||
|
impl ADBServer {
|
||||||
|
/// Pair device on a specific port with a generated 'code'
|
||||||
|
pub fn pair(&mut self, address: SocketAddrV4, code: String) -> Result<()> {
|
||||||
|
let response = self
|
||||||
|
.connect()?
|
||||||
|
.proxy_connection(AdbServerCommand::Pair(address, code), true)?;
|
||||||
|
|
||||||
|
match String::from_utf8(response) {
|
||||||
|
Ok(s) if s.starts_with("Successfully paired to") => Ok(()),
|
||||||
|
Ok(s) => Err(RustADBError::ADBRequestFailed(s)),
|
||||||
|
Err(e) => Err(e.into()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
13
adb_client/src/server/commands/reconnect.rs
Normal file
13
adb_client/src/server/commands/reconnect.rs
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
use crate::{
|
||||||
|
Result,
|
||||||
|
server::{ADBServer, AdbServerCommand},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl ADBServer {
|
||||||
|
/// Reconnect the device
|
||||||
|
pub fn reconnect_offline(&mut self) -> Result<()> {
|
||||||
|
self.connect()?
|
||||||
|
.proxy_connection(AdbServerCommand::ReconnectOffline, false)
|
||||||
|
.map(|_| ())
|
||||||
|
}
|
||||||
|
}
|
||||||
15
adb_client/src/server/commands/server_status.rs
Normal file
15
adb_client/src/server/commands/server_status.rs
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
use crate::{
|
||||||
|
Result,
|
||||||
|
server::{ADBServer, AdbServerCommand, models::ServerStatus},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl ADBServer {
|
||||||
|
/// Check ADB server status
|
||||||
|
pub fn server_status(&mut self) -> Result<ServerStatus> {
|
||||||
|
let status = self
|
||||||
|
.connect()?
|
||||||
|
.proxy_connection(AdbServerCommand::ServerStatus, true)?;
|
||||||
|
|
||||||
|
ServerStatus::try_from(status)
|
||||||
|
}
|
||||||
|
}
|
||||||
15
adb_client/src/server/commands/version.rs
Normal file
15
adb_client/src/server/commands/version.rs
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
use crate::{
|
||||||
|
Result,
|
||||||
|
server::{ADBServer, AdbServerCommand, AdbVersion},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl ADBServer {
|
||||||
|
/// Gets server's internal version number.
|
||||||
|
pub fn version(&mut self) -> Result<AdbVersion> {
|
||||||
|
let version = self
|
||||||
|
.connect()?
|
||||||
|
.proxy_connection(AdbServerCommand::Version, true)?;
|
||||||
|
|
||||||
|
AdbVersion::try_from(version)
|
||||||
|
}
|
||||||
|
}
|
||||||
21
adb_client/src/server/commands/wait_for_device.rs
Normal file
21
adb_client/src/server/commands/wait_for_device.rs
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
use crate::{
|
||||||
|
Result,
|
||||||
|
server::{ADBServer, AdbServerCommand, WaitForDeviceState, WaitForDeviceTransport},
|
||||||
|
};
|
||||||
|
|
||||||
|
impl ADBServer {
|
||||||
|
/// Wait for a device in a given state to be connected
|
||||||
|
pub fn wait_for_device(
|
||||||
|
&mut self,
|
||||||
|
state: WaitForDeviceState,
|
||||||
|
transport: Option<WaitForDeviceTransport>,
|
||||||
|
) -> Result<()> {
|
||||||
|
let transport = transport.unwrap_or_default();
|
||||||
|
|
||||||
|
self.connect()?
|
||||||
|
.send_adb_request(AdbServerCommand::WaitForDevice(state, transport))?;
|
||||||
|
|
||||||
|
// Server should respond with an "OKAY" response
|
||||||
|
self.get_transport()?.read_adb_response()
|
||||||
|
}
|
||||||
|
}
|
||||||
12
adb_client/src/server/mod.rs
Normal file
12
adb_client/src/server/mod.rs
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
#![doc = include_str!("./README.md")]
|
||||||
|
|
||||||
|
mod adb_server;
|
||||||
|
mod adb_server_command;
|
||||||
|
mod commands;
|
||||||
|
mod models;
|
||||||
|
mod tcp_server_transport;
|
||||||
|
|
||||||
|
pub use adb_server::ADBServer;
|
||||||
|
pub(crate) use adb_server_command::AdbServerCommand;
|
||||||
|
pub use models::*;
|
||||||
|
pub use tcp_server_transport::TCPServerTransport;
|
||||||
@@ -1,11 +1,16 @@
|
|||||||
use std::str::FromStr;
|
use std::str::FromStr;
|
||||||
|
use std::sync::LazyLock;
|
||||||
use std::{fmt::Display, str};
|
use std::{fmt::Display, str};
|
||||||
|
|
||||||
|
use crate::RustADBError;
|
||||||
|
use crate::server::DeviceState;
|
||||||
use regex::bytes::Regex;
|
use regex::bytes::Regex;
|
||||||
|
|
||||||
use crate::{DeviceState, RustADBError};
|
static DEVICES_LONG_REGEX: LazyLock<Regex> = LazyLock::new(|| {
|
||||||
|
Regex::new(r"^(?P<identifier>\S+)\s+(?P<state>\w+)\s+(usb:(?P<usb1>\S+)|(?P<usb2>\S+))?\s*(product:(?P<product>\S+)\s+model:(?P<model>\w+)\s+device:(?P<device>\S+)\s+)?transport_id:(?P<transport_id>\d+)$").expect("cannot build devices long regex")
|
||||||
|
});
|
||||||
|
|
||||||
/// Represents a new device with more informations helded.
|
/// Represents a new device with more informations.
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
pub struct DeviceLong {
|
pub struct DeviceLong {
|
||||||
/// Unique device identifier.
|
/// Unique device identifier.
|
||||||
@@ -40,15 +45,12 @@ impl Display for DeviceLong {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl TryFrom<Vec<u8>> for DeviceLong {
|
impl TryFrom<&[u8]> for DeviceLong {
|
||||||
type Error = RustADBError;
|
type Error = RustADBError;
|
||||||
|
|
||||||
// TODO: Prevent regex compilation every call to try_from()
|
fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
|
||||||
fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
|
let groups = DEVICES_LONG_REGEX
|
||||||
let parse_regex = Regex::new("^(?P<identifier>\\w+)\\s+(?P<state>\\w+) usb:(?P<usb>.*) (product:(?P<product>\\w+) model:(?P<model>\\w+) device:(?P<device>\\w+) )?transport_id:(?P<transport_id>\\d+)$")?;
|
.captures(value)
|
||||||
|
|
||||||
let groups = parse_regex
|
|
||||||
.captures(&value)
|
|
||||||
.ok_or(RustADBError::RegexParsingError)?;
|
.ok_or(RustADBError::RegexParsingError)?;
|
||||||
|
|
||||||
Ok(DeviceLong {
|
Ok(DeviceLong {
|
||||||
@@ -66,13 +68,13 @@ impl TryFrom<Vec<u8>> for DeviceLong {
|
|||||||
.as_bytes()
|
.as_bytes()
|
||||||
.to_vec(),
|
.to_vec(),
|
||||||
)?)?,
|
)?)?,
|
||||||
usb: String::from_utf8(
|
usb: match groups.name("usb1") {
|
||||||
groups
|
None => match groups.name("usb2") {
|
||||||
.name("usb")
|
None => "Unk".to_string(),
|
||||||
.ok_or(RustADBError::RegexParsingError)?
|
Some(usb) => String::from_utf8(usb.as_bytes().to_vec())?,
|
||||||
.as_bytes()
|
},
|
||||||
.to_vec(),
|
Some(usb) => String::from_utf8(usb.as_bytes().to_vec())?,
|
||||||
)?,
|
},
|
||||||
product: match groups.name("product") {
|
product: match groups.name("product") {
|
||||||
None => "Unk".to_string(),
|
None => "Unk".to_string(),
|
||||||
Some(product) => String::from_utf8(product.as_bytes().to_vec())?,
|
Some(product) => String::from_utf8(product.as_bytes().to_vec())?,
|
||||||
@@ -97,3 +99,17 @@ impl TryFrom<Vec<u8>> for DeviceLong {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_static_devices_long() {
|
||||||
|
let inputs = [
|
||||||
|
"7a5158f05122195aa device 1-5 product:gts210vewifixx model:SM_T813 device:gts210vewifi transport_id:4",
|
||||||
|
"n311r05e device usb:0-1.5 product:alioth model:M2012K11AC device:alioth transport_id:58",
|
||||||
|
"192.168.100.192:5555 device product:alioth model:M2012K11AC device:alioth transport_id:97",
|
||||||
|
"emulator-5554 device product:sdk_gphone64_arm64 model:sdk_gphone64_arm64 device:emu64a transport_id:101",
|
||||||
|
"QQ20131020250511 device 20-4 product:NOH-AN00 model:NOH_AN00 device:HWNOH transport_id:3",
|
||||||
|
];
|
||||||
|
for input in inputs {
|
||||||
|
DeviceLong::try_from(input.as_bytes()).expect(&format!("cannot parse input: '{input}'"));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,35 +1,35 @@
|
|||||||
use lazy_static::lazy_static;
|
|
||||||
use regex::bytes::Regex;
|
use regex::bytes::Regex;
|
||||||
use std::{fmt::Display, str::FromStr};
|
use std::{fmt::Display, str::FromStr, sync::LazyLock};
|
||||||
|
|
||||||
use crate::{DeviceState, RustADBError};
|
use crate::{RustADBError, server::DeviceState};
|
||||||
|
|
||||||
lazy_static! {
|
static DEVICES_REGEX: LazyLock<Regex> =
|
||||||
static ref DEVICES_REGEX: Regex = Regex::new("^(\\S+)\t(\\w+)\n?$").unwrap();
|
LazyLock::new(|| Regex::new("^(\\S+)\t(\\w+)\n?$").expect("Cannot build devices regex"));
|
||||||
}
|
|
||||||
|
|
||||||
/// Represents a device connected to the ADB server.
|
/// Represents a device connected to the ADB server.
|
||||||
#[derive(Debug)]
|
#[derive(Debug, Clone)]
|
||||||
pub struct Device {
|
pub struct DeviceShort {
|
||||||
/// Unique device identifier.
|
/// Unique device identifier.
|
||||||
pub identifier: String,
|
pub identifier: String,
|
||||||
/// Connection state of the device.
|
/// Connection state of the device.
|
||||||
pub state: DeviceState,
|
pub state: DeviceState,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Display for Device {
|
impl Display for DeviceShort {
|
||||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
write!(f, "{}\t{}", self.identifier, self.state)
|
write!(f, "{}\t{}", self.identifier, self.state)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl TryFrom<Vec<u8>> for Device {
|
impl TryFrom<Vec<u8>> for DeviceShort {
|
||||||
type Error = RustADBError;
|
type Error = RustADBError;
|
||||||
|
|
||||||
fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
|
fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
|
||||||
// Optional final '\n' is used to match TrackDevices inputs
|
// Optional final '\n' is used to match TrackDevices inputs
|
||||||
let groups = DEVICES_REGEX.captures(&value).unwrap();
|
let groups = DEVICES_REGEX
|
||||||
Ok(Device {
|
.captures(&value)
|
||||||
|
.ok_or(RustADBError::RegexParsingError)?;
|
||||||
|
Ok(DeviceShort {
|
||||||
identifier: String::from_utf8(
|
identifier: String::from_utf8(
|
||||||
groups
|
groups
|
||||||
.get(1)
|
.get(1)
|
||||||
@@ -3,7 +3,7 @@ use std::{fmt::Display, str::FromStr};
|
|||||||
use crate::RustADBError;
|
use crate::RustADBError;
|
||||||
|
|
||||||
/// Represents the connection state of the device.
|
/// Represents the connection state of the device.
|
||||||
#[derive(Debug)]
|
#[derive(Debug, Clone)]
|
||||||
pub enum DeviceState {
|
pub enum DeviceState {
|
||||||
/// The device is not connected to adb or is not responding.
|
/// The device is not connected to adb or is not responding.
|
||||||
Offline,
|
Offline,
|
||||||
@@ -15,6 +15,22 @@ pub enum DeviceState {
|
|||||||
Authorizing,
|
Authorizing,
|
||||||
/// The device is unauthorized.
|
/// The device is unauthorized.
|
||||||
Unauthorized,
|
Unauthorized,
|
||||||
|
/// Haven't received a response from the device yet.
|
||||||
|
Connecting,
|
||||||
|
/// Insufficient permissions to communicate with the device.
|
||||||
|
NoPerm,
|
||||||
|
/// USB device detached from the adb server (known but not opened/claimed).
|
||||||
|
Detached,
|
||||||
|
/// Device running fastboot OS (fastboot) or userspace fastboot (fastbootd).
|
||||||
|
Bootloader,
|
||||||
|
/// What a device sees from its end of a Transport (adb host).
|
||||||
|
Host,
|
||||||
|
/// Device with bootloader loaded but no ROM OS loaded (adbd).
|
||||||
|
Recovery,
|
||||||
|
/// Device running Android OS Sideload mode (minadbd sideload mode).
|
||||||
|
Sideload,
|
||||||
|
/// Device running Android OS Rescue mode (minadbd rescue mode).
|
||||||
|
Rescue,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Display for DeviceState {
|
impl Display for DeviceState {
|
||||||
@@ -25,6 +41,14 @@ impl Display for DeviceState {
|
|||||||
DeviceState::NoDevice => write!(f, "no device"),
|
DeviceState::NoDevice => write!(f, "no device"),
|
||||||
DeviceState::Authorizing => write!(f, "authorizing"),
|
DeviceState::Authorizing => write!(f, "authorizing"),
|
||||||
DeviceState::Unauthorized => write!(f, "unauthorized"),
|
DeviceState::Unauthorized => write!(f, "unauthorized"),
|
||||||
|
DeviceState::Connecting => write!(f, "connecting"),
|
||||||
|
DeviceState::NoPerm => write!(f, "noperm"),
|
||||||
|
DeviceState::Detached => write!(f, "detached"),
|
||||||
|
DeviceState::Bootloader => write!(f, "bootloader"),
|
||||||
|
DeviceState::Host => write!(f, "host"),
|
||||||
|
DeviceState::Recovery => write!(f, "recovery"),
|
||||||
|
DeviceState::Sideload => write!(f, "sideload"),
|
||||||
|
DeviceState::Rescue => write!(f, "rescue"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -40,6 +64,14 @@ impl FromStr for DeviceState {
|
|||||||
"no device" => Ok(Self::NoDevice),
|
"no device" => Ok(Self::NoDevice),
|
||||||
"authorizing" => Ok(Self::Authorizing),
|
"authorizing" => Ok(Self::Authorizing),
|
||||||
"unauthorized" => Ok(Self::Unauthorized),
|
"unauthorized" => Ok(Self::Unauthorized),
|
||||||
|
"connecting" => Ok(Self::Connecting),
|
||||||
|
"noperm" => Ok(Self::NoPerm),
|
||||||
|
"detached" => Ok(Self::Detached),
|
||||||
|
"bootloader" => Ok(Self::Bootloader),
|
||||||
|
"host" => Ok(Self::Host),
|
||||||
|
"recovery" => Ok(Self::Recovery),
|
||||||
|
"sideload" => Ok(Self::Sideload),
|
||||||
|
"rescue" => Ok(Self::Rescue),
|
||||||
_ => Err(RustADBError::UnknownDeviceState(lowercased)),
|
_ => Err(RustADBError::UnknownDeviceState(lowercased)),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
64
adb_client/src/server/models/mdns_services.rs
Normal file
64
adb_client/src/server/models/mdns_services.rs
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
use regex::bytes::Regex;
|
||||||
|
use std::net::SocketAddrV4;
|
||||||
|
use std::sync::LazyLock;
|
||||||
|
use std::{fmt::Display, str::FromStr};
|
||||||
|
|
||||||
|
use crate::RustADBError;
|
||||||
|
|
||||||
|
static MDNS_SERVICES_REGEX: LazyLock<Regex> = LazyLock::new(|| {
|
||||||
|
Regex::new("^(\\S+)\t(\\S+)\t([\\d\\.]+:\\d+)\n?$").expect("Cannot build mdns services regex")
|
||||||
|
});
|
||||||
|
|
||||||
|
/// Represents MDNS Services
|
||||||
|
#[derive(Debug, Clone)]
|
||||||
|
pub struct MDNSServices {
|
||||||
|
/// Service name
|
||||||
|
pub service_name: String,
|
||||||
|
/// Reg type
|
||||||
|
pub reg_type: String,
|
||||||
|
/// IP addr with port
|
||||||
|
pub socket_v4: SocketAddrV4,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for MDNSServices {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
write!(
|
||||||
|
f,
|
||||||
|
"{}\t{}\t{}",
|
||||||
|
self.service_name, self.reg_type, self.socket_v4
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<&[u8]> for MDNSServices {
|
||||||
|
type Error = RustADBError;
|
||||||
|
|
||||||
|
fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
|
||||||
|
let groups = MDNS_SERVICES_REGEX
|
||||||
|
.captures(value)
|
||||||
|
.ok_or(RustADBError::RegexParsingError)?;
|
||||||
|
Ok(MDNSServices {
|
||||||
|
service_name: String::from_utf8(
|
||||||
|
groups
|
||||||
|
.get(1)
|
||||||
|
.ok_or(RustADBError::RegexParsingError)?
|
||||||
|
.as_bytes()
|
||||||
|
.to_vec(),
|
||||||
|
)?,
|
||||||
|
reg_type: String::from_utf8(
|
||||||
|
groups
|
||||||
|
.get(2)
|
||||||
|
.ok_or(RustADBError::RegexParsingError)?
|
||||||
|
.as_bytes()
|
||||||
|
.to_vec(),
|
||||||
|
)?,
|
||||||
|
socket_v4: SocketAddrV4::from_str(&String::from_utf8(
|
||||||
|
groups
|
||||||
|
.get(3)
|
||||||
|
.ok_or(RustADBError::RegexParsingError)?
|
||||||
|
.as_bytes()
|
||||||
|
.to_vec(),
|
||||||
|
)?)?,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
15
adb_client/src/server/models/mod.rs
Normal file
15
adb_client/src/server/models/mod.rs
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
mod adb_version;
|
||||||
|
mod device_long;
|
||||||
|
mod device_short;
|
||||||
|
mod device_state;
|
||||||
|
mod mdns_services;
|
||||||
|
mod server_status;
|
||||||
|
mod wait_for_device;
|
||||||
|
|
||||||
|
pub use adb_version::AdbVersion;
|
||||||
|
pub use device_long::DeviceLong;
|
||||||
|
pub use device_short::DeviceShort;
|
||||||
|
pub use device_state::DeviceState;
|
||||||
|
pub use mdns_services::MDNSServices;
|
||||||
|
pub use server_status::{MDNSBackend, ServerStatus};
|
||||||
|
pub use wait_for_device::{WaitForDeviceState, WaitForDeviceTransport};
|
||||||
167
adb_client/src/server/models/server_status.rs
Normal file
167
adb_client/src/server/models/server_status.rs
Normal file
@@ -0,0 +1,167 @@
|
|||||||
|
use quick_protobuf::{BytesReader, MessageRead};
|
||||||
|
|
||||||
|
use std::fmt::Display;
|
||||||
|
|
||||||
|
use crate::RustADBError;
|
||||||
|
|
||||||
|
#[derive(Debug, PartialEq, Default, Eq, Clone, Copy)]
|
||||||
|
pub enum UsbBackend {
|
||||||
|
#[default]
|
||||||
|
Unknown = 0,
|
||||||
|
Native = 1,
|
||||||
|
LibUSB = 2,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<i32> for UsbBackend {
|
||||||
|
fn from(i: i32) -> Self {
|
||||||
|
match i {
|
||||||
|
0 => UsbBackend::Unknown,
|
||||||
|
1 => UsbBackend::Native,
|
||||||
|
2 => UsbBackend::LibUSB,
|
||||||
|
_ => Self::default(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'a> From<&'a str> for UsbBackend {
|
||||||
|
fn from(s: &'a str) -> Self {
|
||||||
|
match s {
|
||||||
|
"UNKNOWN_USB" => UsbBackend::Unknown,
|
||||||
|
"NATIVE" => UsbBackend::Native,
|
||||||
|
"LIBUSB" => UsbBackend::LibUSB,
|
||||||
|
_ => Self::default(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for UsbBackend {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
match self {
|
||||||
|
UsbBackend::Unknown => write!(f, "UNKNOWN_USB"),
|
||||||
|
UsbBackend::Native => write!(f, "NATIVE"),
|
||||||
|
UsbBackend::LibUSB => write!(f, "LIBUSB"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// MDNS Backend Status
|
||||||
|
#[derive(Debug, Clone, PartialEq, Default)]
|
||||||
|
pub enum MDNSBackend {
|
||||||
|
#[default]
|
||||||
|
/// Unknown
|
||||||
|
Unknown = 0,
|
||||||
|
/// Bonjour
|
||||||
|
Bonjour = 1,
|
||||||
|
/// OpenScreen
|
||||||
|
OpenScreen = 2,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<i32> for MDNSBackend {
|
||||||
|
fn from(i: i32) -> Self {
|
||||||
|
match i {
|
||||||
|
0 => MDNSBackend::Unknown,
|
||||||
|
1 => MDNSBackend::Bonjour,
|
||||||
|
2 => MDNSBackend::OpenScreen,
|
||||||
|
_ => Self::default(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'a> From<&'a str> for MDNSBackend {
|
||||||
|
fn from(s: &'a str) -> Self {
|
||||||
|
match s {
|
||||||
|
"UNKNOWN_MDNS" => MDNSBackend::Unknown,
|
||||||
|
"BONJOUR" => MDNSBackend::Bonjour,
|
||||||
|
"OPENSCREEN" => MDNSBackend::OpenScreen,
|
||||||
|
_ => Self::default(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for MDNSBackend {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
match self {
|
||||||
|
MDNSBackend::Unknown => write!(f, "UNKNOWN_MDNS"),
|
||||||
|
MDNSBackend::Bonjour => write!(f, "BONJOUR"),
|
||||||
|
MDNSBackend::OpenScreen => write!(f, "OPENSCREEN"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Structure representing current server status
|
||||||
|
#[derive(Debug, Clone, Default, PartialEq)]
|
||||||
|
pub struct ServerStatus {
|
||||||
|
/// Currently active USB backend
|
||||||
|
pub usb_backend: UsbBackend,
|
||||||
|
/// Is USB backend forced ?
|
||||||
|
pub usb_backend_forced: bool,
|
||||||
|
/// Currently active MDNS backend
|
||||||
|
pub mdns_backend: MDNSBackend,
|
||||||
|
/// Is MDNS backend forced ?
|
||||||
|
pub mdns_backend_forced: bool,
|
||||||
|
/// Server version
|
||||||
|
pub version: String,
|
||||||
|
/// Server build information
|
||||||
|
pub build: String,
|
||||||
|
/// Server executable absolute path
|
||||||
|
pub executable_absolute_path: String,
|
||||||
|
/// Server logs absolute path
|
||||||
|
pub log_absolute_path: String,
|
||||||
|
/// OS server is running on
|
||||||
|
pub os: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'a> MessageRead<'a> for ServerStatus {
|
||||||
|
fn from_reader(r: &mut BytesReader, bytes: &'a [u8]) -> quick_protobuf::Result<Self> {
|
||||||
|
let mut msg = Self::default();
|
||||||
|
while !r.is_eof() {
|
||||||
|
match r.next_tag(bytes) {
|
||||||
|
Ok(8) => msg.usb_backend = r.read_enum(bytes)?,
|
||||||
|
Ok(16) => msg.usb_backend_forced = r.read_bool(bytes)?,
|
||||||
|
Ok(24) => msg.mdns_backend = r.read_enum(bytes)?,
|
||||||
|
Ok(32) => msg.mdns_backend_forced = r.read_bool(bytes)?,
|
||||||
|
Ok(42) => msg.version = r.read_string(bytes)?.to_string(),
|
||||||
|
Ok(50) => msg.build = r.read_string(bytes)?.to_string(),
|
||||||
|
Ok(58) => msg.executable_absolute_path = r.read_string(bytes)?.to_string(),
|
||||||
|
Ok(66) => msg.log_absolute_path = r.read_string(bytes)?.to_string(),
|
||||||
|
Ok(74) => msg.os = r.read_string(bytes)?.to_string(),
|
||||||
|
Ok(t) => {
|
||||||
|
r.read_unknown(bytes, t)?;
|
||||||
|
}
|
||||||
|
Err(e) => return Err(e),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(msg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for ServerStatus {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
writeln!(f, "usb_backend: {}", self.usb_backend)?;
|
||||||
|
if self.usb_backend_forced {
|
||||||
|
writeln!(f, "usb_backend_forced: {}", self.usb_backend_forced)?;
|
||||||
|
}
|
||||||
|
writeln!(f, "mdns_backend: {}", self.mdns_backend)?;
|
||||||
|
if self.mdns_backend_forced {
|
||||||
|
writeln!(f, "mdns_backend_forced: {}", self.mdns_backend_forced)?;
|
||||||
|
}
|
||||||
|
writeln!(f, "version: \"{}\"", self.version)?;
|
||||||
|
writeln!(f, "build: \"{}\"", self.build)?;
|
||||||
|
writeln!(
|
||||||
|
f,
|
||||||
|
"executable_absolute_path: \"{}\"",
|
||||||
|
self.executable_absolute_path
|
||||||
|
)?;
|
||||||
|
writeln!(f, "log_absolute_path: \"{}\"", self.log_absolute_path)?;
|
||||||
|
writeln!(f, "os: \"{}\"", self.os)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<Vec<u8>> for ServerStatus {
|
||||||
|
type Error = RustADBError;
|
||||||
|
|
||||||
|
fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
|
||||||
|
let mut reader = BytesReader::from_bytes(&value);
|
||||||
|
ServerStatus::from_reader(&mut reader, &value).map_err(|_| RustADBError::ConversionError)
|
||||||
|
}
|
||||||
|
}
|
||||||
67
adb_client/src/server/models/wait_for_device.rs
Normal file
67
adb_client/src/server/models/wait_for_device.rs
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
use std::fmt::Display;
|
||||||
|
|
||||||
|
use crate::RustADBError;
|
||||||
|
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
/// List of available transports to wait for.
|
||||||
|
pub enum WaitForDeviceTransport {
|
||||||
|
/// USB transport
|
||||||
|
Usb,
|
||||||
|
/// Local transport
|
||||||
|
Local,
|
||||||
|
/// Any transport (default value)
|
||||||
|
Any,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for WaitForDeviceTransport {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self::Any
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for WaitForDeviceTransport {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
match self {
|
||||||
|
WaitForDeviceTransport::Usb => write!(f, "usb"),
|
||||||
|
WaitForDeviceTransport::Local => write!(f, "local"),
|
||||||
|
WaitForDeviceTransport::Any => write!(f, "any"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<&str> for WaitForDeviceTransport {
|
||||||
|
type Error = RustADBError;
|
||||||
|
|
||||||
|
fn try_from(value: &str) -> Result<Self, Self::Error> {
|
||||||
|
match value {
|
||||||
|
"usb" => Ok(Self::Usb),
|
||||||
|
"local" => Ok(Self::Local),
|
||||||
|
"any" => Ok(Self::Any),
|
||||||
|
t => Err(RustADBError::UnknownTransport(t.to_string())),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug)]
|
||||||
|
/// List of available states to wait for.
|
||||||
|
pub enum WaitForDeviceState {
|
||||||
|
/// Device in "device" state
|
||||||
|
Device,
|
||||||
|
/// Device in "recovery" state
|
||||||
|
Recovery,
|
||||||
|
/// Device in "sideload" state
|
||||||
|
Sideload,
|
||||||
|
/// Device in "bootloader" state
|
||||||
|
Bootloader,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for WaitForDeviceState {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
match self {
|
||||||
|
WaitForDeviceState::Device => write!(f, "device"),
|
||||||
|
WaitForDeviceState::Recovery => write!(f, "recovery"),
|
||||||
|
WaitForDeviceState::Sideload => write!(f, "sideload"),
|
||||||
|
WaitForDeviceState::Bootloader => write!(f, "bootloader"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user