36 Commits

Author SHA1 Message Date
LIAUD Corentin
8b4602c62f chore: version 2.1.11 2025-04-13 16:40:48 +02:00
cocool97
e917a45670 feat: edition 2024 (#106) 2025-04-13 16:38:38 +02:00
cocool97
b0303ad544 feat(ci): add windows + macos build (#105)
* feat(ci): add windows + macos build
2025-04-13 16:24:49 +02:00
LIAUD Corentin
f3f95d92c2 chore: v2.1.10 2025-03-12 17:27:02 +01:00
Cendy
886adfa392 feat: adb custom path (#101)
---------

Co-authored-by: LIAUD Corentin <corentinliaud26@gmail.com>
2025-03-12 17:26:13 +01:00
LIAUD Corentin
cdf062c3e1 bump: version 2.1.9 2025-03-09 19:43:54 +01:00
cocool97
b8e3d02311 feat: do not show prompt on Windows (#98) 2025-03-09 19:42:39 +01:00
cocool97
1b7efc1cc6 feat: ADBServerDevice without serial (#97)
* feat: ADBServerDevice without serial

* chore: bump deps

* actions: improve build
2025-03-09 19:33:20 +01:00
cli
ad064a9f41 feat: add wait-for-device command (#96) 2025-03-07 17:01:26 +01:00
LIAUD Corentin
d0e0f46571 chore: version v2.1.8 2025-02-27 10:04:00 +01:00
Yohane
727f3a3eb4 Fix:Regex expression parsing usb incorrectly (#94) 2025-02-27 10:02:49 +01:00
Otto Zell
ab77db5cc8 Fix for android clients that do not expect encrypted connections (#93)
* Fix for adb clients that do not want encrypted connections

---------

Co-authored-by: Otto Zell <otto.zell@drivec.se>
Co-authored-by: LIAUD Corentin <corentinliaud26@gmail.com>
2025-02-27 09:54:04 +01:00
cocool97
1255f2b5d6 feat: improve python-build.yml (#92) 2025-02-11 15:26:19 +01:00
LIAUD Corentin
eb04f9064c chore: v2.1.7 2025-02-11 14:39:14 +01:00
LIAUD Corentin
69107e2333 fix(pyadb_client): add adb_client as a path dependency 2025-02-11 14:38:20 +01:00
LIAUD Corentin
17bb77a472 chore: v2.1.6 2025-02-11 14:12:28 +01:00
cocool97
f211023b24 feat: do not include rust files in python package (#91) 2025-02-11 14:03:24 +01:00
cli
728d9603dc fix(python): improve modules path (#88) 2025-02-06 16:53:29 +01:00
cocool97
00c387d85c feat: pyo3 stub generation (#87) 2025-02-06 11:25:07 +01:00
Andreas Tzionis
79d96d4c76 Implemented uninstall command (#86)
* implemented uninstall command
2025-01-29 20:17:28 +01:00
LIAUD Corentin
dc909ceda6 chore: v2.1.5 2025-01-24 15:06:24 +01:00
cocool97
cbba912483 fix: improve python package build (#85) 2025-01-24 15:00:36 +01:00
LIAUD Corentin
38d8384b98 fix: maturin non-interactive 2025-01-24 10:18:55 +01:00
cocool97
39591b6a0a ci: build python wheels (#84) 2025-01-24 10:11:51 +01:00
LIAUD Corentin
775b2421ec chore(ci): improve python build 2025-01-22 15:57:02 +01:00
LIAUD Corentin
62d16b70fb chore: version 2.1.0 2025-01-22 15:25:03 +01:00
cli
466d00e68a feat: Python package (#80)
* feat: create pyadb_client python package

* feat: add push / pull methods

* feat: add shell_command for USB

* feat(ci): add python package build
2025-01-22 15:22:36 +01:00
KFBI1706
144072ba1b fix: track_devices support multiple devices (#83) 2025-01-21 07:31:39 +01:00
LIAUD Corentin
331ef95530 chore: fix deps for adb_cli 2024-12-18 11:24:52 +01:00
LIAUD Corentin
61408cb470 chore: version 2.1.0 2024-12-18 11:12:56 +01:00
cli
c54942f25d feat: improve USB performances by storing endpoints (#79) 2024-12-18 10:55:40 +01:00
cli
3feda38cc3 core: bump deps + update README.md (#78) 2024-12-18 08:34:31 +01:00
cli
9002ecc0c8 chore: internal updates (#74)
* chore: update adb_client README.md

* chore(internal): add assert_command() method on ADBTransportMessage

* chore: minor internal changes

* chore: add server-only models
2024-12-13 14:08:48 +01:00
Stone
5a3ac68fce feat: do not detach kernel driver (#72) 2024-12-10 17:17:41 +01:00
cli
5dfd30cc5b breaking: make ADBDeviceExt dyn-compatible (#70)
* feat: make ADBDeviceExt dyn-compatible

* feat: clean CLI code
2024-12-06 17:47:38 +01:00
cli
66d124475d feat: add framebuffer method to USB/TCP direct devices (#69)
* feat: store local_id and remote_id in ADBMessageDevice
2024-12-03 13:55:12 +01:00
120 changed files with 1976 additions and 1367 deletions

2
.cargo/config.toml Normal file
View File

@@ -0,0 +1,2 @@
[target.aarch64-apple-darwin]
rustflags = ["-C", "link-arg=-undefined", "-C", "link-arg=dynamic_lookup"]

38
.github/workflows/python-build.yml vendored Normal file
View 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

View File

@@ -1,14 +1,22 @@
name: Rust - Build name: Rust - Build
on: [push, pull_request] on:
push:
branches:
- main
pull_request:
env: env:
CARGO_TERM_COLOR: always CARGO_TERM_COLOR: always
jobs: jobs:
build-release: build:
name: "build-release" name: "Build on ${{ matrix.os }}"
runs-on: ubuntu-latest runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: Build project - name: Build project

View File

@@ -1,6 +1,10 @@
name: Rust - Quality name: Rust - Quality
on: [push, pull_request] on:
push:
branches:
- main
pull_request:
env: env:
CARGO_TERM_COLOR: always CARGO_TERM_COLOR: always

View File

@@ -4,47 +4,101 @@ on:
release: release:
types: [created] types: [created]
env:
CARGO_TERM_COLOR: always
jobs: jobs:
create-release: release-linux:
name: Linux - Build and Publish
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: "Checkout repository" - uses: actions/checkout@v4
uses: actions/checkout@v4
- name: "Set up Rust" - name: Set up Rust
uses: actions-rs/toolchain@v1 uses: actions-rs/toolchain@v1
with: with:
toolchain: stable toolchain: stable
override: true override: true
- name: "Install dependencies" - name: Install dependencies
run: | run: |
sudo apt update sudo apt update
sudo apt install -y rpm sudo apt install -y rpm
cargo install cargo-deb cargo install cargo-deb
cargo install cargo-generate-rpm cargo install cargo-generate-rpm
- name: "build-release" - 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 run: cargo build --all-features --release
- name: "Build DEB package" - name: Rename binary
run: mv target/release/adb_cli target/release/adb_cli-linux
- name: Build DEB package
run: cargo deb -p adb_cli run: cargo deb -p adb_cli
- name: "Build RPM package" - name: Build RPM package
run: cargo generate-rpm -p adb_cli run: cargo generate-rpm -p adb_cli
- name: "Publish GitHub artefacts" - name: Upload Linux artifacts
uses: softprops/action-gh-release@v2 uses: softprops/action-gh-release@v2
with: with:
files: | files: |
target/debian/*.deb target/debian/*.deb
target/generate-rpm/*.rpm target/generate-rpm/*.rpm
target/release/adb_cli target/release/adb_cli-linux
- name: "Publish crates" release-macos:
run: | name: macOS - Build Binary
cargo publish -p adb_client --token ${CRATES_IO_TOKEN} runs-on: macos-13
cargo publish -p adb_cli --token ${CRATES_IO_TOKEN}
env: steps:
CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }} - 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
View File

@@ -1,3 +1,6 @@
target target
Cargo.lock /Cargo.lock
.vscode /.vscode
venv
/.mypy_cache
pyadb_client/pyadb_client.pyi

View File

@@ -1,15 +1,15 @@
[workspace] [workspace]
members = ["adb_cli", "adb_client"] members = ["adb_cli", "adb_client", "pyadb_client"]
resolver = "2" resolver = "2"
[workspace.package] [workspace.package]
authors = ["Corentin LIAUD"] authors = ["Corentin LIAUD"]
edition = "2021" edition = "2024"
homepage = "https://github.com/cocool97/adb_client" homepage = "https://github.com/cocool97/adb_client"
keywords = ["adb", "android", "tcp", "usb"] keywords = ["adb", "android", "tcp", "usb"]
license = "MIT" license = "MIT"
repository = "https://github.com/cocool97/adb_client" repository = "https://github.com/cocool97/adb_client"
version = "2.0.6" version = "2.1.11"
# To build locally when working on a new release # To build locally when working on a new release
[patch.crates-io] [patch.crates-io]

View File

@@ -30,6 +30,7 @@ Main features of this library:
- Over **TCP/IP** - Over **TCP/IP**
- Implements hidden `adb` features, like `framebuffer` - Implements hidden `adb` features, like `framebuffer`
- Highly configurable - Highly configurable
- Provides wrappers to use directly from Python code
- Easy to use ! - Easy to use !
## adb_client ## adb_client
@@ -41,12 +42,19 @@ Improved documentation available [here](./adb_client/README.md).
## adb_cli ## adb_cli
Rust binary providing an improved version of Google's official `adb` CLI, by using `adb_client` library. Rust binary providing an improved version of Google's official `adb` CLI, by using `adb_client` library.
Provides an usage example of the library. Provides a "real-world" usage example of this library.
Improved documentation available [here](./adb_cli/README.md). Improved documentation available [here](./adb_cli/README.md).
## pyadb_client
Python wrapper using `adb_client` library to export classes usable directly from a Python environment.
Improved documentation available [here](./pyadb_client/README.md)
## Related publications ## Related publications
- [Diving into ADB protocol internals (1/2)](https://www.synacktiv.com/publications/diving-into-adb-protocol-internals-12) - [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)
Some features may still be missing, all pull requests are welcome ! Some features may still be missing, all pull requests are welcome !

View File

@@ -10,11 +10,11 @@ repository.workspace = true
version.workspace = true version.workspace = true
[dependencies] [dependencies]
adb_client = { version = "2.0.5" } adb_client = { version = "^2.0.0" }
anyhow = { version = "1.0.89" } anyhow = { version = "1.0.94" }
clap = { version = "4.5.18", features = ["derive"] } clap = { version = "4.5.23", features = ["derive"] }
env_logger = { version = "0.11.5" } env_logger = { version = "0.11.5" }
log = { version = "0.4.22" } log = { version = "0.4.26" }
[target.'cfg(unix)'.dependencies] [target.'cfg(unix)'.dependencies]
termios = { version = "0.3.3" } termios = { version = "0.3.3" }

View File

@@ -18,38 +18,29 @@ Usage is quite simple, and tends to look like `adb`:
- To use ADB server as a proxy: - To use ADB server as a proxy:
```bash ```bash
user@laptop ~/adb_client (main)> adb_cli --help user@laptop ~/adb_client (main)> adb_cli local --help
Rust ADB (Android Debug Bridge) CLI Device related commands using server
Usage: adb_cli [OPTIONS] <COMMAND> Usage: adb_cli local [OPTIONS] <COMMAND>
Commands: Commands:
host-features List available server features
push Push a file on device
pull Pull a file from device
list List a directory on device
stat Stat a file specified on device
shell Spawn an interactive shell or run a list of commands on the device 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 reboot Reboot the device
install Install an APK on device
framebuffer Dump framebuffer of device framebuffer Dump framebuffer of device
host-features List available server features
list List a directory on device
logcat Get logs of device logcat Get logs of device
version Print current ADB version
kill Ask ADB server to quit immediately
devices List connected devices
track-devices Track new devices showing up
pair Pair device with a given code
connect Connect device over WI-FI
disconnect Disconnect device over WI-FI
sms Send a SMS with given phone number and given content
rotate Rotate device screen from 90°
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
Options: Options:
-d, --debug
-a, --address <ADDRESS> [default: 127.0.0.1:5037] -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 -s, --serial <SERIAL> Serial id of a specific device. Every request will be sent to this device
-h, --help Print help -h, --help Print help
-V, --version Print version
``` ```
- To interact directly with end devices - To interact directly with end devices

View File

@@ -2,7 +2,7 @@
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;
@@ -36,7 +36,7 @@ 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.
if let Err(e) = tcsetattr(self.fd, TCSANOW, &self.old_termios) { if let Err(e) = tcsetattr(self.fd, TCSANOW, &self.old_termios) {
log::error!("Error while droping ADBTermios: {e}") log::error!("Error while dropping ADBTermios: {e}")
} }
} }
} }

View File

@@ -1,12 +0,0 @@
use clap::Parser;
#[derive(Parser, Debug)]
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,
}

View File

@@ -1,46 +0,0 @@
use clap::Parser;
use std::path::PathBuf;
use crate::models::RebootTypeCommand;
#[derive(Parser, Debug)]
pub enum LocalCommand {
/// List available server features.
HostFeatures,
/// Push a file on device
Push { filename: String, path: String },
/// Pull a file from device
Pull { path: String, filename: String },
/// List a directory on device
List { path: String },
/// Stat a file specified on device
Stat { path: String },
/// Spawn an interactive shell or run a list of commands on the device
Shell { commands: Vec<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,
},
/// Dump framebuffer of device
Framebuffer { path: String },
/// Get logs of device
Logcat {
/// Path to output file (created if not exists)
path: Option<String>,
},
/// Install an APK on device
Install {
/// Path to APK file. Extension must be ".apk"
path: PathBuf,
},
}

View File

@@ -1,11 +0,0 @@
mod emu;
mod host;
mod local;
mod tcp;
mod usb;
pub use emu::EmuCommand;
pub use host::{HostCommand, MdnsCommand};
pub use local::LocalCommand;
pub use tcp::{TcpCommand, TcpCommands};
pub use usb::{UsbCommand, UsbCommands};

View File

@@ -1,56 +0,0 @@
use std::num::ParseIntError;
use std::path::PathBuf;
use clap::Parser;
use crate::models::RebootTypeCommand;
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: UsbCommands,
}
#[derive(Parser, Debug)]
pub enum UsbCommands {
/// 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,
},
}

View File

@@ -0,0 +1,20 @@
use adb_client::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(())
}

View File

@@ -0,0 +1,82 @@
use adb_client::{ADBServer, DeviceShort, MDNSBackend, Result, 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(())
}

View File

@@ -0,0 +1,35 @@
use std::{fs::File, io::Write};
use adb_client::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)?)
}
}
}

View 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;

View File

@@ -3,334 +3,80 @@
#[cfg(any(target_os = "linux", target_os = "macos"))] #[cfg(any(target_os = "linux", target_os = "macos"))]
mod adb_termios; mod adb_termios;
mod commands; mod handlers;
mod models; mod models;
mod utils;
use adb_client::{ use adb_client::{
ADBDeviceExt, ADBEmulatorDevice, ADBServer, ADBTcpDevice, ADBUSBDevice, DeviceShort, ADBDeviceExt, ADBServer, ADBServerDevice, ADBTcpDevice, ADBUSBDevice, MDNSDiscoveryService,
MDNSBackend, MDNSDiscoveryService,
}; };
use anyhow::{anyhow, Result};
#[cfg(any(target_os = "linux", target_os = "macos"))]
use adb_termios::ADBTermios;
use anyhow::Result;
use clap::Parser; use clap::Parser;
use commands::{EmuCommand, HostCommand, LocalCommand, MdnsCommand, TcpCommands, UsbCommands}; use handlers::{handle_emulator_commands, handle_host_commands, handle_local_commands};
use models::{Command, Opts}; use models::{DeviceCommands, LocalCommand, MainCommand, Opts};
use std::collections::HashMap;
use std::fs::File; use std::fs::File;
use std::io::Write; use std::io::Write;
use std::path::Path; use std::path::Path;
use utils::setup_logger;
fn main() -> Result<()> { fn main() -> Result<()> {
let opts = Opts::parse(); let opts = Opts::parse();
// RUST_LOG variable has more priority then "--debug" flag setup_logger(opts.debug);
if std::env::var("RUST_LOG").is_err() {
let level = match opts.debug {
true => "trace",
false => "info",
};
std::env::set_var("RUST_LOG", level); // 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);
}
// Setting default log level as "info" if not set let device = match server_command.serial {
if std::env::var("RUST_LOG").is_err() { Some(serial) => ADBServerDevice::new(serial, Some(server_command.address)),
std::env::set_var("RUST_LOG", "info"); None => ADBServerDevice::autodetect(Some(server_command.address)),
}
env_logger::init();
match opts.command {
Command::Local(local) => {
let mut adb_server = ADBServer::new(opts.address);
let mut device = match opts.serial {
Some(serial) => adb_server.get_device_by_name(&serial)?,
None => adb_server.get_device()?,
}; };
match local { match server_command.command {
LocalCommand::Pull { path, filename } => { LocalCommand::DeviceCommands(device_commands) => (device.boxed(), device_commands),
let mut output = File::create(Path::new(&filename))?; LocalCommand::LocalDeviceCommand(local_device_command) => {
device.pull(&path, &mut output)?; return handle_local_commands(device, local_device_command);
log::info!("Downloaded {path} as {filename}");
}
LocalCommand::Push { filename, path } => {
let mut input = File::open(Path::new(&filename))?;
device.push(&mut input, &path)?;
log::info!("Uploaded {filename} to {path}");
}
LocalCommand::List { path } => {
device.list(path)?;
}
LocalCommand::Stat { path } => {
let stat_response = device.stat(path)?;
println!("{}", stat_response);
}
LocalCommand::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 = adb_termios::ADBTermios::new(std::io::stdin())?;
adb_termios.set_adb_termios()?;
device.shell(std::io::stdin(), std::io::stdout())?;
}
#[cfg(not(any(target_os = "linux", target_os = "macos")))]
{
device.shell(std::io::stdin(), std::io::stdout())?;
}
} else {
device.shell_command(commands, std::io::stdout())?;
}
}
LocalCommand::Run { package, activity } => {
let output = device.run_activity(&package, &activity)?;
std::io::stdout().write_all(&output)?;
}
LocalCommand::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}");
}
LocalCommand::Reboot { reboot_type } => {
log::info!("Reboots device in mode {:?}", reboot_type);
device.reboot(reboot_type.into())?
}
LocalCommand::Framebuffer { path } => {
device.framebuffer(&path)?;
log::info!("Framebuffer dropped: {path}");
}
LocalCommand::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())
};
device.get_logs(writer)?;
}
LocalCommand::Install { path } => {
log::info!("Starting installation of APK {}...", path.display());
device.install(path)?;
} }
} }
} }
Command::Host(host) => { MainCommand::Usb(usb_command) => {
let mut adb_server = ADBServer::new(opts.address); let device = match (usb_command.vendor_id, usb_command.product_id) {
(Some(vid), Some(pid)) => match usb_command.path_to_private_key {
match host {
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()?);
}
}
}
Command::Emu(emu) => {
let mut emulator = match opts.serial {
Some(serial) => ADBEmulatorDevice::new(serial, None)?,
None => return Err(anyhow!("Serial must be set to use emulators !")),
};
match emu {
EmuCommand::Sms {
phone_number,
content,
} => {
emulator.send_sms(&phone_number, &content)?;
log::info!("SMS sent to {phone_number}");
}
EmuCommand::Rotate => emulator.rotate()?,
}
}
Command::Usb(usb) => {
let mut device = match (usb.vendor_id, usb.product_id) {
(Some(vid), Some(pid)) => match usb.path_to_private_key {
Some(pk) => ADBUSBDevice::new_with_custom_private_key(vid, pid, pk)?, Some(pk) => ADBUSBDevice::new_with_custom_private_key(vid, pid, pk)?,
None => ADBUSBDevice::new(vid, pid)?, None => ADBUSBDevice::new(vid, pid)?,
}, },
(None, None) => match usb_command.path_to_private_key {
(None, None) => match usb.path_to_private_key {
Some(pk) => ADBUSBDevice::autodetect_with_custom_private_key(pk)?, Some(pk) => ADBUSBDevice::autodetect_with_custom_private_key(pk)?,
None => ADBUSBDevice::autodetect()?, None => ADBUSBDevice::autodetect()?,
}, },
_ => { _ => {
anyhow::bail!("please either supply values for both the --vendor-id and --product-id flags or none."); anyhow::bail!(
"please either supply values for both the --vendor-id and --product-id flags or none."
);
} }
}; };
(device.boxed(), usb_command.commands)
match usb.commands {
UsbCommands::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 = adb_termios::ADBTermios::new(std::io::stdin())?;
adb_termios.set_adb_termios()?;
device.shell(std::io::stdin(), std::io::stdout())?;
}
#[cfg(not(any(target_os = "linux", target_os = "macos")))]
{
device.shell(std::io::stdin(), std::io::stdout())?;
}
} else {
device.shell_command(commands, std::io::stdout())?;
}
}
UsbCommands::Pull {
source,
destination,
} => {
let mut output = File::create(Path::new(&destination))?;
device.pull(&source, &mut output)?;
log::info!("Downloaded {source} as {destination}");
}
UsbCommands::Stat { path } => {
let stat_response = device.stat(&path)?;
println!("{}", stat_response);
}
UsbCommands::Reboot { reboot_type } => {
log::info!("Reboots device in mode {:?}", reboot_type);
device.reboot(reboot_type.into())?
}
UsbCommands::Push { filename, path } => {
let mut input = File::open(Path::new(&filename))?;
device.push(&mut input, &path)?;
log::info!("Uploaded {filename} to {path}");
}
UsbCommands::Run { package, activity } => {
let output = device.run_activity(&package, &activity)?;
std::io::stdout().write_all(&output)?;
}
UsbCommands::Install { path } => {
log::info!("Starting installation of APK {}...", path.display());
device.install(path)?;
}
}
} }
Command::Tcp(tcp) => { MainCommand::Tcp(tcp_command) => {
let mut device = ADBTcpDevice::new(tcp.address)?; let device = ADBTcpDevice::new(tcp_command.address)?;
(device.boxed(), tcp_command.commands)
match tcp.commands {
TcpCommands::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 = adb_termios::ADBTermios::new(std::io::stdin())?;
adb_termios.set_adb_termios()?;
device.shell(std::io::stdin(), std::io::stdout())?;
}
#[cfg(not(any(target_os = "linux", target_os = "macos")))]
{
device.shell(std::io::stdin(), std::io::stdout())?;
}
} else {
device.shell_command(commands, std::io::stdout())?;
}
}
TcpCommands::Pull {
source,
destination,
} => {
let mut output = File::create(Path::new(&destination))?;
device.pull(&source, &mut output)?;
log::info!("Downloaded {source} as {destination}");
}
TcpCommands::Stat { path } => {
let stat_response = device.stat(&path)?;
println!("{}", stat_response);
}
TcpCommands::Reboot { reboot_type } => {
log::info!("Reboots device in mode {:?}", reboot_type);
device.reboot(reboot_type.into())?
}
TcpCommands::Push { filename, path } => {
let mut input = File::open(Path::new(&filename))?;
device.push(&mut input, &path)?;
log::info!("Uploaded {filename} to {path}");
}
TcpCommands::Run { package, activity } => {
let output = device.run_activity(&package, &activity)?;
std::io::stdout().write_all(&output)?;
}
TcpCommands::Install { path } => {
log::info!("Starting installation of APK {}...", path.display());
device.install(path)?;
}
}
} }
Command::MdnsDiscovery => { MainCommand::Mdns => {
let mut service = MDNSDiscoveryService::new()?; let mut service = MDNSDiscoveryService::new()?;
let (tx, rx) = std::sync::mpsc::channel(); let (tx, rx) = std::sync::mpsc::channel();
@@ -345,7 +91,67 @@ fn main() -> Result<()> {
) )
} }
service.shutdown()?; 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}");
} }
} }

View File

@@ -1,19 +1,11 @@
use std::net::SocketAddr;
use std::path::PathBuf; use std::path::PathBuf;
use clap::Parser; use clap::Parser;
use crate::models::RebootTypeCommand; use super::RebootTypeCommand;
#[derive(Parser, Debug)] #[derive(Parser, Debug)]
pub struct TcpCommand { pub enum DeviceCommands {
pub address: SocketAddr,
#[clap(subcommand)]
pub commands: TcpCommands,
}
#[derive(Parser, Debug)]
pub enum TcpCommands {
/// Spawn an interactive shell or run a list of commands on the device /// Spawn an interactive shell or run a list of commands on the device
Shell { commands: Vec<String> }, Shell { commands: Vec<String> },
/// Pull a file from device /// Pull a file from device
@@ -41,4 +33,14 @@ pub enum TcpCommands {
/// Path to APK file. Extension must be ".apk" /// Path to APK file. Extension must be ".apk"
path: PathBuf, 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
View 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,
}

View File

@@ -1,7 +1,14 @@
use std::net::SocketAddrV4; use std::net::SocketAddrV4;
use adb_client::{RustADBError, WaitForDeviceTransport};
use clap::Parser; use clap::Parser;
fn parse_wait_for_device_device_transport(
value: &str,
) -> Result<WaitForDeviceTransport, RustADBError> {
WaitForDeviceTransport::try_from(value)
}
#[derive(Parser, Debug)] #[derive(Parser, Debug)]
pub enum HostCommand { pub enum HostCommand {
/// Print current ADB version. /// Print current ADB version.
@@ -28,6 +35,12 @@ pub enum HostCommand {
}, },
/// Display server status /// Display server status
ServerStatus, 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)] #[derive(Parser, Debug)]

View 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>,
},
}

View File

@@ -1,5 +1,17 @@
mod device;
mod emu;
mod host;
mod local;
mod opts; mod opts;
mod reboot_type; mod reboot_type;
mod tcp;
mod usb;
pub use opts::{Command, Opts}; 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 reboot_type::RebootTypeCommand;
pub use tcp::TcpCommand;
pub use usb::UsbCommand;

View File

@@ -1,36 +1,41 @@
use std::net::SocketAddrV4; use std::net::SocketAddrV4;
use clap::Parser; use clap::{Parser, Subcommand};
use crate::commands::{EmuCommand, HostCommand, LocalCommand, TcpCommand, UsbCommand}; use super::{EmulatorCommand, HostCommand, LocalCommand, TcpCommand, UsbCommand};
#[derive(Parser, Debug)] #[derive(Debug, Parser)]
#[clap(about, version, author)] #[clap(about, version, author)]
pub struct Opts { pub struct Opts {
#[clap(long = "debug")] #[clap(long = "debug")]
pub debug: bool, 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")] #[clap(short = 'a', long = "address", default_value = "127.0.0.1:5037")]
pub address: SocketAddrV4, pub address: SocketAddrV4,
/// Serial id of a specific device. Every request will be sent to this device. /// Serial id of a specific device. Every request will be sent to this device.
#[clap(short = 's', long = "serial")] #[clap(short = 's', long = "serial")]
pub serial: Option<String>, pub serial: Option<String>,
#[clap(subcommand)] #[clap(subcommand)]
pub command: Command, pub command: T,
}
#[derive(Parser, Debug)]
pub enum Command {
#[clap(flatten)]
Local(LocalCommand),
#[clap(flatten)]
Host(HostCommand),
/// Emulator specific commands
#[clap(subcommand)]
Emu(EmuCommand),
/// Device commands via USB, no server needed
Usb(UsbCommand),
/// Device commands via TCP, no server needed
Tcp(TcpCommand),
/// Discover devices over MDNS without using adb-server
MdnsDiscovery,
} }

11
adb_cli/src/models/tcp.rs Normal file
View 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
View 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,
}

13
adb_cli/src/utils.rs Normal file
View File

@@ -0,0 +1,13 @@
pub 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();
}

View File

@@ -13,26 +13,26 @@ version.workspace = true
base64 = { version = "0.22.1" } base64 = { version = "0.22.1" }
bincode = { version = "1.3.3" } bincode = { version = "1.3.3" }
byteorder = { version = "1.5.0" } byteorder = { version = "1.5.0" }
chrono = { version = "0.4.38" } chrono = { version = "0.4.40" }
homedir = { version = "0.3.4" } homedir = { version = "0.3.4" }
image = { version = "0.25.5" } image = { version = "0.25.5" }
lazy_static = { version = "1.5.0" } lazy_static = { version = "1.5.0" }
log = { version = "0.4.22" } log = { version = "0.4.26" }
mdns-sd = { version = "0.12.0" } mdns-sd = { version = "0.13.2" }
num-bigint = { version = "0.8.4", package = "num-bigint-dig" } num-bigint = { version = "0.8.4", package = "num-bigint-dig" }
num-traits = { version = "0.2.19" } num-traits = { version = "0.2.19" }
quick-protobuf = { version = "0.8.1" } quick-protobuf = { version = "0.8.1" }
rand = { version = "0.8.5" } rand = { version = "0.9.0" }
rcgen = { version = "0.13.1" } rcgen = { version = "0.13.1" }
regex = { version = "1.11.0", features = ["perf", "std", "unicode"] } regex = { version = "1.11.1", features = ["perf", "std", "unicode"] }
rsa = { version = "0.9.7" } rsa = { version = "0.9.7" }
rusb = { version = "0.9.4", features = ["vendored"] } rusb = { version = "0.9.4", features = ["vendored"] }
rustls = { version = "0.23.18" } rustls = { version = "0.23.22" }
rustls-pki-types = "1.10.0" rustls-pki-types = "1.11.0"
serde = { version = "1.0.210", features = ["derive"] } serde = { version = "1.0.216", features = ["derive"] }
serde_repr = { version = "0.1.19" } serde_repr = { version = "0.1.19" }
sha1 = { version = "0.10.6", features = ["oid"] } sha1 = { version = "0.10.6", features = ["oid"] }
thiserror = { version = "2.0.1" } thiserror = { version = "2.0.7" }
[dev-dependencies] [dev-dependencies]
anyhow = { version = "1.0.93" } anyhow = { version = "1.0.93" }

View File

@@ -2,7 +2,7 @@
[![MIT licensed](https://img.shields.io/crates/l/adb_client.svg)](./LICENSE-MIT) [![MIT licensed](https://img.shields.io/crates/l/adb_client.svg)](./LICENSE-MIT)
[![Documentation](https://docs.rs/adb_client/badge.svg)](https://docs.rs/adb_client) [![Documentation](https://docs.rs/adb_client/badge.svg)](https://docs.rs/adb_client)
![Crates.io Total Downloads](https://img.shields.io/crates/d/adb_client) [![Crates.io Total Downloads](https://img.shields.io/crates/d/adb_client)](https://crates.io/crates/adb_client)
Rust library implementing ADB protocol. Rust library implementing ADB protocol.
@@ -15,6 +15,20 @@ Add `adb_client` crate as a dependency by simply adding it to your `Cargo.toml`:
adb_client = "*" adb_client = "*"
``` ```
## 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>|
## Examples ## Examples
### Get available ADB devices ### Get available ADB devices
@@ -40,7 +54,7 @@ use adb_client::{ADBServer, ADBDeviceExt};
let mut server = ADBServer::default(); let mut server = ADBServer::default();
let mut device = server.get_device().expect("cannot get device"); let mut device = server.get_device().expect("cannot get device");
device.shell_command(["df", "-h"],std::io::stdout()); device.shell_command(&["df", "-h"], &mut std::io::stdout());
``` ```
#### Push a file to the device #### Push a file to the device
@@ -67,7 +81,7 @@ use adb_client::{ADBUSBDevice, ADBDeviceExt};
let vendor_id = 0x04e8; let vendor_id = 0x04e8;
let product_id = 0x6860; let product_id = 0x6860;
let mut device = ADBUSBDevice::new(vendor_id, product_id).expect("cannot find device"); let mut device = ADBUSBDevice::new(vendor_id, product_id).expect("cannot find device");
device.shell_command(["df", "-h"],std::io::stdout()); device.shell_command(&["df", "-h"], &mut std::io::stdout());
``` ```
#### (USB) Push a file to the device #### (USB) Push a file to the device
@@ -81,10 +95,10 @@ let vendor_id = 0x04e8;
let product_id = 0x6860; let product_id = 0x6860;
let mut device = ADBUSBDevice::new(vendor_id, product_id).expect("cannot find device"); let mut device = ADBUSBDevice::new(vendor_id, product_id).expect("cannot find device");
let mut input = File::open(Path::new("/tmp/f")).expect("Cannot open file"); let mut input = File::open(Path::new("/tmp/f")).expect("Cannot open file");
device.push(&mut input, "/data/local/tmp"); device.push(&mut input, &"/data/local/tmp");
``` ```
### (TCP) Get a shell from device #### (TCP) Get a shell from device
```rust no_run ```rust no_run
use std::net::{SocketAddr, IpAddr, Ipv4Addr}; use std::net::{SocketAddr, IpAddr, Ipv4Addr};
@@ -93,5 +107,5 @@ use adb_client::{ADBTcpDevice, ADBDeviceExt};
let device_ip = IpAddr::V4(Ipv4Addr::new(192, 168, 0, 10)); let device_ip = IpAddr::V4(Ipv4Addr::new(192, 168, 0, 10));
let device_port = 43210; let device_port = 43210;
let mut device = ADBTcpDevice::new(SocketAddr::new(device_ip, device_port)).expect("cannot find device"); let mut device = ADBTcpDevice::new(SocketAddr::new(device_ip, device_port)).expect("cannot find device");
device.shell(std::io::stdin(), std::io::stdout()); device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()));
``` ```

View File

@@ -1,31 +1,28 @@
use std::io::{Read, Write}; use std::io::{Cursor, Read, Write};
use std::path::Path; use std::path::Path;
use image::{ImageBuffer, ImageFormat, Rgba};
use crate::models::AdbStatResponse; use crate::models::AdbStatResponse;
use crate::{RebootType, Result}; use crate::{RebootType, Result};
/// Trait representing all features available on both [`crate::ADBServerDevice`] and [`crate::ADBUSBDevice`] /// Trait representing all features available on both [`crate::ADBServerDevice`] and [`crate::ADBUSBDevice`]
pub trait ADBDeviceExt { pub trait ADBDeviceExt {
/// Runs command in a shell on the device, and write its output and error streams into output. /// Runs command in a shell on the device, and write its output and error streams into output.
fn shell_command<S: ToString, W: Write>( fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()>;
&mut self,
command: impl IntoIterator<Item = S>,
output: W,
) -> Result<()>;
/// Starts an interactive shell session on the device. /// Starts an interactive shell session on the device.
/// Input data is read from reader and write to writer. /// Input data is read from reader and write to writer.
/// W has a 'static bound as it is internally used in a thread. fn shell(&mut self, reader: &mut dyn Read, writer: Box<(dyn Write + Send)>) -> Result<()>;
fn shell<R: Read, W: Write + Send + 'static>(&mut self, reader: R, writer: W) -> Result<()>;
/// Display the stat information for a remote file /// Display the stat information for a remote file
fn stat(&mut self, remote_path: &str) -> Result<AdbStatResponse>; fn stat(&mut self, remote_path: &str) -> Result<AdbStatResponse>;
/// Pull the remote file pointed to by `source` and write its contents into `output` /// Pull the remote file pointed to by `source` and write its contents into `output`
fn pull<A: AsRef<str>, W: Write>(&mut self, source: A, output: W) -> Result<()>; fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()>;
/// Push `stream` to `path` on the device. /// Push `stream` to `path` on the device.
fn push<R: Read, A: AsRef<str>>(&mut self, stream: R, path: A) -> Result<()>; fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()>;
/// Reboot the device using given reboot type /// Reboot the device using given reboot type
fn reboot(&mut self, reboot_type: RebootType) -> Result<()>; fn reboot(&mut self, reboot_type: RebootType) -> Result<()>;
@@ -34,7 +31,7 @@ pub trait ADBDeviceExt {
fn run_activity(&mut self, package: &str, activity: &str) -> Result<Vec<u8>> { fn run_activity(&mut self, package: &str, activity: &str) -> Result<Vec<u8>> {
let mut output = Vec::new(); let mut output = Vec::new();
self.shell_command( self.shell_command(
["am", "start", &format!("{package}/{package}.{activity}")], &["am", "start", &format!("{package}/{package}.{activity}")],
&mut output, &mut output,
)?; )?;
@@ -42,5 +39,38 @@ pub trait ADBDeviceExt {
} }
/// Install an APK pointed to by `apk_path` on device. /// Install an APK pointed to by `apk_path` on device.
fn install<P: AsRef<Path>>(&mut self, apk_path: P) -> Result<()>; 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)
}
} }

View File

@@ -2,21 +2,27 @@ use byteorder::{LittleEndian, ReadBytesExt};
use rand::Rng; use rand::Rng;
use std::io::{Cursor, Read, Seek}; use std::io::{Cursor, Read, Seek};
use crate::{constants::BUFFER_SIZE, ADBMessageTransport, AdbStatResponse, Result, RustADBError}; use crate::{ADBMessageTransport, AdbStatResponse, Result, RustADBError, constants::BUFFER_SIZE};
use super::{models::MessageSubcommand, ADBTransportMessage, MessageCommand}; use super::{ADBTransportMessage, MessageCommand, models::MessageSubcommand};
/// Generic structure representing an ADB device reachable over an [`ADBMessageTransport`]. /// Generic structure representing an ADB device reachable over an [`ADBMessageTransport`].
/// Structure is totally agnostic over which transport is truly used. /// Structure is totally agnostic over which transport is truly used.
#[derive(Debug)] #[derive(Debug)]
pub struct ADBMessageDevice<T: ADBMessageTransport> { pub struct ADBMessageDevice<T: ADBMessageTransport> {
transport: T, transport: T,
local_id: Option<u32>,
remote_id: Option<u32>,
} }
impl<T: ADBMessageTransport> ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBMessageDevice<T> {
/// Instantiate a new [`ADBMessageTransport`] /// Instantiate a new [`ADBMessageTransport`]
pub fn new(transport: T) -> Self { pub fn new(transport: T) -> Self {
Self { transport } Self {
transport,
local_id: None,
remote_id: None,
}
} }
pub(crate) fn get_transport(&mut self) -> &T { pub(crate) fn get_transport(&mut self) -> &T {
@@ -28,17 +34,13 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
} }
/// Receive a message and acknowledge it by replying with an `OKAY` command /// Receive a message and acknowledge it by replying with an `OKAY` command
pub(crate) fn recv_and_reply_okay( pub(crate) fn recv_and_reply_okay(&mut self) -> Result<ADBTransportMessage> {
&mut self,
local_id: u32,
remote_id: u32,
) -> Result<ADBTransportMessage> {
let message = self.transport.read_message()?; let message = self.transport.read_message()?;
self.transport.write_message(ADBTransportMessage::new( self.transport.write_message(ADBTransportMessage::new(
MessageCommand::Okay, MessageCommand::Okay,
local_id, self.get_local_id()?,
remote_id, self.get_remote_id()?,
"".into(), &[],
))?; ))?;
Ok(message) Ok(message)
} }
@@ -49,28 +51,20 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
message: ADBTransportMessage, message: ADBTransportMessage,
) -> Result<ADBTransportMessage> { ) -> Result<ADBTransportMessage> {
self.transport.write_message(message)?; self.transport.write_message(message)?;
let message = self.transport.read_message()?;
let received_command = message.header().command(); self.transport.read_message().and_then(|message| {
if received_command != MessageCommand::Okay { message.assert_command(MessageCommand::Okay)?;
return Err(RustADBError::ADBRequestFailed(format!( Ok(message)
"expected command OKAY after message, got {}", })
received_command
)));
}
Ok(message)
} }
pub(crate) fn recv_file<W: std::io::Write>( pub(crate) fn recv_file<W: std::io::Write>(
&mut self, &mut self,
local_id: u32,
remote_id: u32,
mut output: W, mut output: W,
) -> std::result::Result<(), RustADBError> { ) -> std::result::Result<(), RustADBError> {
let mut len: Option<u64> = None; let mut len: Option<u64> = None;
loop { loop {
let payload = self let payload = self.recv_and_reply_okay()?.into_payload();
.recv_and_reply_okay(local_id, remote_id)?
.into_payload();
let mut rdr = Cursor::new(&payload); let mut rdr = Cursor::new(&payload);
while rdr.position() != payload.len() as u64 { while rdr.position() != payload.len() as u64 {
match len.take() { match len.take() {
@@ -119,7 +113,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
MessageCommand::Write, MessageCommand::Write,
local_id, local_id,
remote_id, remote_id,
serialized_message, &serialized_message,
); );
self.send_and_expect_okay(message)?; self.send_and_expect_okay(message)?;
@@ -139,7 +133,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
MessageCommand::Write, MessageCommand::Write,
local_id, local_id,
remote_id, remote_id,
serialized_message, &serialized_message,
); );
self.send_and_expect_okay(message)?; self.send_and_expect_okay(message)?;
@@ -152,7 +146,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
return Err(RustADBError::ADBRequestFailed(format!( return Err(RustADBError::ADBRequestFailed(format!(
"Wrong command received {}", "Wrong command received {}",
c c
))) )));
} }
} }
} }
@@ -167,7 +161,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
MessageCommand::Write, MessageCommand::Write,
local_id, local_id,
remote_id, remote_id,
serialized_message, &serialized_message,
); );
self.send_and_expect_okay(message)?; self.send_and_expect_okay(message)?;
@@ -179,41 +173,25 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
} }
} }
pub(crate) fn begin_synchronization(&mut self) -> Result<(u32, u32)> { pub(crate) fn begin_synchronization(&mut self) -> Result<()> {
let sync_directive = "sync:\0"; self.open_session(b"sync:\0")?;
Ok(())
let mut rng = rand::thread_rng();
let message = ADBTransportMessage::new(
MessageCommand::Open,
rng.gen(), /* Our 'local-id' */
0,
sync_directive.into(),
);
let message = self.send_and_expect_okay(message)?;
let local_id = message.header().arg1();
let remote_id = message.header().arg0();
Ok((local_id, remote_id))
} }
pub(crate) fn stat_with_explicit_ids( pub(crate) fn stat_with_explicit_ids(&mut self, remote_path: &str) -> Result<AdbStatResponse> {
&mut self,
remote_path: &str,
local_id: u32,
remote_id: u32,
) -> Result<AdbStatResponse> {
let stat_buffer = MessageSubcommand::Stat.with_arg(remote_path.len() as u32); let stat_buffer = MessageSubcommand::Stat.with_arg(remote_path.len() as u32);
let message = ADBTransportMessage::new( let message = ADBTransportMessage::new(
MessageCommand::Write, MessageCommand::Write,
local_id, self.get_local_id()?,
remote_id, self.get_remote_id()?,
bincode::serialize(&stat_buffer).map_err(|_e| RustADBError::ConversionError)?, &bincode::serialize(&stat_buffer).map_err(|_e| RustADBError::ConversionError)?,
); );
self.send_and_expect_okay(message)?; self.send_and_expect_okay(message)?;
self.send_and_expect_okay(ADBTransportMessage::new( self.send_and_expect_okay(ADBTransportMessage::new(
MessageCommand::Write, MessageCommand::Write,
local_id, self.get_local_id()?,
remote_id, self.get_remote_id()?,
remote_path.into(), remote_path.as_bytes(),
))?; ))?;
let response = self.transport.read_message()?; let response = self.transport.read_message()?;
// Skip first 4 bytes as this is the literal "STAT". // Skip first 4 bytes as this is the literal "STAT".
@@ -222,15 +200,46 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
.map_err(|_e| RustADBError::ConversionError) .map_err(|_e| RustADBError::ConversionError)
} }
pub(crate) fn end_transaction(&mut self, local_id: u32, remote_id: u32) -> Result<()> { pub(crate) fn end_transaction(&mut self) -> Result<()> {
let quit_buffer = MessageSubcommand::Quit.with_arg(0u32); let quit_buffer = MessageSubcommand::Quit.with_arg(0u32);
self.send_and_expect_okay(ADBTransportMessage::new( self.send_and_expect_okay(ADBTransportMessage::new(
MessageCommand::Write, MessageCommand::Write,
local_id, self.get_local_id()?,
remote_id, self.get_remote_id()?,
bincode::serialize(&quit_buffer).map_err(|_e| RustADBError::ConversionError)?, &bincode::serialize(&quit_buffer).map_err(|_e| RustADBError::ConversionError)?,
))?; ))?;
let _discard_close = self.transport.read_message()?; let _discard_close = self.transport.read_message()?;
Ok(()) 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(),
))
}
} }

View File

@@ -1,18 +1,17 @@
use crate::{models::AdbStatResponse, ADBDeviceExt, ADBMessageTransport, RebootType, Result}; use crate::{ADBDeviceExt, ADBMessageTransport, RebootType, Result, models::AdbStatResponse};
use std::io::{Read, Write}; use std::{
io::{Read, Write},
path::Path,
};
use super::ADBMessageDevice; use super::ADBMessageDevice;
impl<T: ADBMessageTransport> ADBDeviceExt for ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBDeviceExt for ADBMessageDevice<T> {
fn shell_command<S: ToString, W: Write>( fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
&mut self,
command: impl IntoIterator<Item = S>,
output: W,
) -> Result<()> {
self.shell_command(command, output) self.shell_command(command, output)
} }
fn shell<R: Read, W: Write + Send + 'static>(&mut self, reader: R, writer: W) -> Result<()> { fn shell(&mut self, reader: &mut dyn Read, writer: Box<(dyn Write + Send)>) -> Result<()> {
self.shell(reader, writer) self.shell(reader, writer)
} }
@@ -20,11 +19,11 @@ impl<T: ADBMessageTransport> ADBDeviceExt for ADBMessageDevice<T> {
self.stat(remote_path) self.stat(remote_path)
} }
fn pull<A: AsRef<str>, W: Write>(&mut self, source: A, output: W) -> Result<()> { fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()> {
self.pull(source, output) self.pull(source, output)
} }
fn push<R: Read, A: AsRef<str>>(&mut self, stream: R, path: A) -> Result<()> { fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
self.push(stream, path) self.push(stream, path)
} }
@@ -32,7 +31,15 @@ impl<T: ADBMessageTransport> ADBDeviceExt for ADBMessageDevice<T> {
self.reboot(reboot_type) self.reboot(reboot_type)
} }
fn install<P: AsRef<std::path::Path>>(&mut self, apk_path: P) -> Result<()> { fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
self.install(apk_path) 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()
}
} }

View File

@@ -1,10 +1,11 @@
use std::net::SocketAddr; use std::io::Write;
use std::path::Path; use std::path::Path;
use std::{io::Read, net::SocketAddr};
use super::ADBTransportMessage;
use super::adb_message_device::ADBMessageDevice; use super::adb_message_device::ADBMessageDevice;
use super::models::MessageCommand; use super::models::MessageCommand;
use super::ADBTransportMessage; use crate::{ADBDeviceExt, ADBMessageTransport, ADBTransport, Result, TcpTransport};
use crate::{ADBDeviceExt, ADBMessageTransport, ADBTransport, Result, RustADBError, TcpTransport};
/// Represent a device reached and available over USB. /// Represent a device reached and available over USB.
#[derive(Debug)] #[derive(Debug)]
@@ -32,76 +33,86 @@ impl ADBTcpDevice {
MessageCommand::Cnxn, MessageCommand::Cnxn,
0x01000000, 0x01000000,
1048576, 1048576,
format!("host::{}\0", env!("CARGO_PKG_NAME")) format!("host::{}\0", env!("CARGO_PKG_NAME")).as_bytes(),
.as_bytes()
.to_vec(),
); );
self.get_transport_mut().write_message(message)?; self.get_transport_mut().write_message(message)?;
let message = self.get_transport_mut().read_message()?; let message = self.get_transport_mut().read_message()?;
// At this point, we should have received a STLS message // Check if client is requesting a secure connection and upgrade it if necessary
if message.header().command() != MessageCommand::Stls { match message.header().command() {
return Err(RustADBError::ADBRequestFailed(format!( MessageCommand::Stls => {
"Wrong command received {}", self.get_transport_mut()
message.header().command() .write_message(ADBTransportMessage::new(MessageCommand::Stls, 1, 0, &[]))?;
))); self.get_transport_mut().upgrade_connection()?;
}; log::debug!("Connection successfully upgraded from TCP to TLS");
}
let message = ADBTransportMessage::new(MessageCommand::Stls, 1, 0, vec![]); MessageCommand::Cnxn => {
log::debug!("Unencrypted connection established");
self.get_transport_mut().write_message(message)?; }
_ => {
// Upgrade TCP connection to TLS return Err(crate::RustADBError::WrongResponseReceived(
self.get_transport_mut().upgrade_connection()?; "Expected CNXN or STLS command".to_string(),
message.header().command().to_string(),
log::debug!("Connection successfully upgraded from TCP to TLS"); ));
}
}
Ok(()) Ok(())
} }
#[inline]
fn get_transport_mut(&mut self) -> &mut TcpTransport { fn get_transport_mut(&mut self) -> &mut TcpTransport {
self.inner.get_transport_mut() self.inner.get_transport_mut()
} }
} }
impl ADBDeviceExt for ADBTcpDevice { impl ADBDeviceExt for ADBTcpDevice {
fn shell_command<S: ToString, W: std::io::Write>( #[inline]
&mut self, fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
command: impl IntoIterator<Item = S>,
output: W,
) -> Result<()> {
self.inner.shell_command(command, output) self.inner.shell_command(command, output)
} }
fn shell<R: std::io::Read, W: std::io::Write + Send + 'static>( #[inline]
&mut self, fn shell(&mut self, reader: &mut dyn Read, writer: Box<(dyn Write + Send)>) -> Result<()> {
reader: R,
writer: W,
) -> Result<()> {
self.inner.shell(reader, writer) self.inner.shell(reader, writer)
} }
#[inline]
fn stat(&mut self, remote_path: &str) -> Result<crate::AdbStatResponse> { fn stat(&mut self, remote_path: &str) -> Result<crate::AdbStatResponse> {
self.inner.stat(remote_path) self.inner.stat(remote_path)
} }
fn pull<A: AsRef<str>, W: std::io::Write>(&mut self, source: A, output: W) -> Result<()> { #[inline]
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()> {
self.inner.pull(source, output) self.inner.pull(source, output)
} }
fn push<R: std::io::Read, A: AsRef<str>>(&mut self, stream: R, path: A) -> Result<()> { #[inline]
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
self.inner.push(stream, path) self.inner.push(stream, path)
} }
#[inline]
fn reboot(&mut self, reboot_type: crate::RebootType) -> Result<()> { fn reboot(&mut self, reboot_type: crate::RebootType) -> Result<()> {
self.inner.reboot(reboot_type) self.inner.reboot(reboot_type)
} }
fn install<P: AsRef<Path>>(&mut self, apk_path: P) -> Result<()> { #[inline]
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
self.inner.install(apk_path) 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 { impl Drop for ADBTcpDevice {

View File

@@ -1,6 +1,6 @@
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use crate::RustADBError; use crate::{Result, RustADBError};
use super::models::MessageCommand; use super::models::MessageCommand;
@@ -66,16 +66,16 @@ impl ADBTransportMessageHeader {
command_u32 ^ 0xFFFFFFFF command_u32 ^ 0xFFFFFFFF
} }
pub fn as_bytes(&self) -> Result<Vec<u8>, RustADBError> { pub fn as_bytes(&self) -> Result<Vec<u8>> {
bincode::serialize(&self).map_err(|_e| RustADBError::ConversionError) bincode::serialize(&self).map_err(|_e| RustADBError::ConversionError)
} }
} }
impl ADBTransportMessage { impl ADBTransportMessage {
pub fn new(command: MessageCommand, arg0: u32, arg1: u32, data: Vec<u8>) -> Self { pub fn new(command: MessageCommand, arg0: u32, arg1: u32, data: &[u8]) -> Self {
Self { Self {
header: ADBTransportMessageHeader::new(command, arg0, arg1, &data), header: ADBTransportMessageHeader::new(command, arg0, arg1, data),
payload: data, payload: data.to_vec(),
} }
} }
@@ -88,6 +88,18 @@ impl ADBTransportMessage {
&& ADBTransportMessageHeader::compute_crc32(&self.payload) == self.header.data_crc32 && 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 { pub fn header(&self) -> &ADBTransportMessageHeader {
&self.header &self.header
} }
@@ -104,7 +116,7 @@ impl ADBTransportMessage {
impl TryFrom<[u8; 24]> for ADBTransportMessageHeader { impl TryFrom<[u8; 24]> for ADBTransportMessageHeader {
type Error = RustADBError; type Error = RustADBError;
fn try_from(value: [u8; 24]) -> Result<Self, Self::Error> { fn try_from(value: [u8; 24]) -> Result<Self> {
bincode::deserialize(&value).map_err(|_e| RustADBError::ConversionError) bincode::deserialize(&value).map_err(|_e| RustADBError::ConversionError)
} }
} }

View File

@@ -1,7 +1,10 @@
use rusb::Device; use rusb::Device;
use rusb::DeviceDescriptor; use rusb::DeviceDescriptor;
use rusb::UsbContext; use rusb::UsbContext;
use rusb::constants::LIBUSB_CLASS_VENDOR_SPEC;
use std::fs::read_to_string; use std::fs::read_to_string;
use std::io::Read;
use std::io::Write;
use std::path::Path; use std::path::Path;
use std::path::PathBuf; use std::path::PathBuf;
use std::time::Duration; use std::time::Duration;
@@ -9,10 +12,10 @@ use std::time::Duration;
use super::adb_message_device::ADBMessageDevice; use super::adb_message_device::ADBMessageDevice;
use super::models::MessageCommand; use super::models::MessageCommand;
use super::{ADBRsaKey, ADBTransportMessage}; use super::{ADBRsaKey, ADBTransportMessage};
use crate::device::adb_transport_message::{AUTH_RSAPUBLICKEY, AUTH_SIGNATURE, AUTH_TOKEN};
use crate::ADBDeviceExt; use crate::ADBDeviceExt;
use crate::ADBMessageTransport; use crate::ADBMessageTransport;
use crate::ADBTransport; use crate::ADBTransport;
use crate::device::adb_transport_message::{AUTH_RSAPUBLICKEY, AUTH_SIGNATURE, AUTH_TOKEN};
use crate::{Result, RustADBError, USBTransport}; use crate::{Result, RustADBError, USBTransport};
pub fn read_adb_private_key<P: AsRef<Path>>(private_key_path: P) -> Result<Option<ADBRsaKey>> { pub fn read_adb_private_key<P: AsRef<Path>>(private_key_path: P) -> Result<Option<ADBRsaKey>> {
@@ -55,8 +58,6 @@ fn search_adb_devices() -> Result<Option<(u16, u16)>> {
} }
fn is_adb_device<T: UsbContext>(device: &Device<T>, des: &DeviceDescriptor) -> bool { fn is_adb_device<T: UsbContext>(device: &Device<T>, des: &DeviceDescriptor) -> bool {
const ADB_CLASS: u8 = 0xff;
const ADB_SUBCLASS: u8 = 0x42; const ADB_SUBCLASS: u8 = 0x42;
const ADB_PROTOCOL: u8 = 0x1; const ADB_PROTOCOL: u8 = 0x1;
@@ -75,7 +76,7 @@ fn is_adb_device<T: UsbContext>(device: &Device<T>, des: &DeviceDescriptor) -> b
let class = interface_des.class_code(); let class = interface_des.class_code();
let subcl = interface_des.sub_class_code(); let subcl = interface_des.sub_class_code();
if proto == ADB_PROTOCOL if proto == ADB_PROTOCOL
&& ((class == ADB_CLASS && subcl == ADB_SUBCLASS) && ((class == LIBUSB_CLASS_VENDOR_SPEC && subcl == ADB_SUBCLASS)
|| (class == BULK_CLASS && subcl == BULK_ADB_SUBCLASS)) || (class == BULK_CLASS && subcl == BULK_ADB_SUBCLASS))
{ {
return true; return true;
@@ -173,36 +174,27 @@ impl ADBUSBDevice {
MessageCommand::Cnxn, MessageCommand::Cnxn,
0x01000000, 0x01000000,
1048576, 1048576,
format!("host::{}\0", env!("CARGO_PKG_NAME")) format!("host::{}\0", env!("CARGO_PKG_NAME")).as_bytes(),
.as_bytes()
.to_vec(),
); );
self.get_transport_mut().write_message(message)?; self.get_transport_mut().write_message(message)?;
let message = self.get_transport_mut().read_message()?; let message = self.get_transport_mut().read_message()?;
message.assert_command(MessageCommand::Auth)?;
// At this point, we should have received either: // At this point, we should have receive an AUTH message with arg0 == 1
// - an AUTH message with arg0 == 1 let auth_message = match message.header().arg0() {
// - a CNXN message AUTH_TOKEN => message,
let auth_message = match message.header().command() { v => {
MessageCommand::Auth if message.header().arg0() == AUTH_TOKEN => message,
MessageCommand::Auth if message.header().arg0() != AUTH_TOKEN => {
return Err(RustADBError::ADBRequestFailed(
"Received AUTH message with type != 1".into(),
))
}
c => {
return Err(RustADBError::ADBRequestFailed(format!( return Err(RustADBError::ADBRequestFailed(format!(
"Wrong command received {}", "Received AUTH message with type != 1 ({v})"
c )));
)))
} }
}; };
let sign = self.private_key.sign(auth_message.into_payload())?; let sign = self.private_key.sign(auth_message.into_payload())?;
let message = ADBTransportMessage::new(MessageCommand::Auth, AUTH_SIGNATURE, 0, sign); let message = ADBTransportMessage::new(MessageCommand::Auth, AUTH_SIGNATURE, 0, &sign);
self.get_transport_mut().write_message(message)?; self.get_transport_mut().write_message(message)?;
@@ -219,71 +211,77 @@ impl ADBUSBDevice {
let mut pubkey = self.private_key.android_pubkey_encode()?.into_bytes(); let mut pubkey = self.private_key.android_pubkey_encode()?.into_bytes();
pubkey.push(b'\0'); pubkey.push(b'\0');
let message = ADBTransportMessage::new(MessageCommand::Auth, AUTH_RSAPUBLICKEY, 0, pubkey); let message = ADBTransportMessage::new(MessageCommand::Auth, AUTH_RSAPUBLICKEY, 0, &pubkey);
self.get_transport_mut().write_message(message)?; self.get_transport_mut().write_message(message)?;
let response = self let response = self
.get_transport_mut() .get_transport_mut()
.read_message_with_timeout(Duration::from_secs(10))?; .read_message_with_timeout(Duration::from_secs(10))
.and_then(|message| {
message.assert_command(MessageCommand::Cnxn)?;
Ok(message)
})?;
match response.header().command() { log::info!(
MessageCommand::Cnxn => log::info!( "Authentication OK, device info {}",
"Authentication OK, device info {}", String::from_utf8(response.into_payload())?
String::from_utf8(response.into_payload())? );
),
_ => {
return Err(RustADBError::ADBRequestFailed(format!(
"wrong response {}",
response.header().command()
)))
}
}
Ok(()) Ok(())
} }
#[inline]
fn get_transport_mut(&mut self) -> &mut USBTransport { fn get_transport_mut(&mut self) -> &mut USBTransport {
self.inner.get_transport_mut() self.inner.get_transport_mut()
} }
} }
impl ADBDeviceExt for ADBUSBDevice { impl ADBDeviceExt for ADBUSBDevice {
fn shell_command<S: ToString, W: std::io::Write>( #[inline]
&mut self, fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
command: impl IntoIterator<Item = S>,
output: W,
) -> Result<()> {
self.inner.shell_command(command, output) self.inner.shell_command(command, output)
} }
fn shell<R: std::io::Read, W: std::io::Write + Send + 'static>( #[inline]
&mut self, fn shell<'a>(&mut self, reader: &mut dyn Read, writer: Box<(dyn Write + Send)>) -> Result<()> {
reader: R,
writer: W,
) -> Result<()> {
self.inner.shell(reader, writer) self.inner.shell(reader, writer)
} }
#[inline]
fn stat(&mut self, remote_path: &str) -> Result<crate::AdbStatResponse> { fn stat(&mut self, remote_path: &str) -> Result<crate::AdbStatResponse> {
self.inner.stat(remote_path) self.inner.stat(remote_path)
} }
fn pull<A: AsRef<str>, W: std::io::Write>(&mut self, source: A, output: W) -> Result<()> { #[inline]
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()> {
self.inner.pull(source, output) self.inner.pull(source, output)
} }
fn push<R: std::io::Read, A: AsRef<str>>(&mut self, stream: R, path: A) -> Result<()> { #[inline]
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
self.inner.push(stream, path) self.inner.push(stream, path)
} }
#[inline]
fn reboot(&mut self, reboot_type: crate::RebootType) -> Result<()> { fn reboot(&mut self, reboot_type: crate::RebootType) -> Result<()> {
self.inner.reboot(reboot_type) self.inner.reboot(reboot_type)
} }
fn install<P: AsRef<Path>>(&mut self, apk_path: P) -> Result<()> { #[inline]
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
self.inner.install(apk_path) 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 { impl Drop for ADBUSBDevice {

View File

@@ -0,0 +1,98 @@
use std::io::{Cursor, Read};
use byteorder::{LittleEndian, ReadBytesExt};
use image::{ImageBuffer, Rgba};
use crate::{
ADBMessageTransport, Result, RustADBError,
device::{MessageCommand, adb_message_device::ADBMessageDevice},
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)
}
}

View File

@@ -1,43 +1,30 @@
use std::fs::File; use std::{fs::File, path::Path};
use rand::Rng; use rand::Rng;
use crate::{ use crate::{
device::{
adb_message_device::ADBMessageDevice, ADBTransportMessage, MessageCommand, MessageWriter,
},
utils::check_extension_is_apk,
ADBMessageTransport, Result, ADBMessageTransport, Result,
device::{MessageWriter, adb_message_device::ADBMessageDevice},
utils::check_extension_is_apk,
}; };
impl<T: ADBMessageTransport> ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn install<P: AsRef<std::path::Path>>(&mut self, apk_path: P) -> Result<()> { pub(crate) fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
let mut apk_file = File::open(&apk_path)?; let mut apk_file = File::open(apk_path)?;
check_extension_is_apk(&apk_path)?; check_extension_is_apk(apk_path)?;
let file_size = apk_file.metadata()?.len(); let file_size = apk_file.metadata()?.len();
let mut rng = rand::thread_rng(); let mut rng = rand::rng();
let local_id = rng.gen(); let local_id = rng.random();
let message = ADBTransportMessage::new( self.open_session(format!("exec:cmd package 'install' -S {}\0", file_size).as_bytes())?;
MessageCommand::Open,
local_id,
0,
format!("exec:cmd package 'install' -S {}\0", file_size)
.as_bytes()
.to_vec(),
);
self.get_transport_mut().write_message(message)?;
let response = self.get_transport_mut().read_message()?;
let remote_id = response.header().arg0();
let transport = self.get_transport().clone(); let transport = self.get_transport().clone();
let mut writer = MessageWriter::new(transport, local_id, remote_id); let mut writer = MessageWriter::new(transport, local_id, self.get_remote_id()?);
std::io::copy(&mut apk_file, &mut writer)?; std::io::copy(&mut apk_file, &mut writer)?;

View File

@@ -1,6 +1,8 @@
mod framebuffer;
mod install; mod install;
mod pull; mod pull;
mod push; mod push;
mod reboot; mod reboot;
mod shell; mod shell;
mod stat; mod stat;
mod uninstall;

View File

@@ -1,19 +1,19 @@
use std::io::Write; use std::io::Write;
use crate::{ use crate::{
device::{
adb_message_device::ADBMessageDevice, models::MessageSubcommand, ADBTransportMessage,
MessageCommand,
},
ADBMessageTransport, Result, RustADBError, ADBMessageTransport, Result, RustADBError,
device::{
ADBTransportMessage, MessageCommand, adb_message_device::ADBMessageDevice,
models::MessageSubcommand,
},
}; };
impl<T: ADBMessageTransport> ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn pull<A: AsRef<str>, W: Write>(&mut self, source: A, output: W) -> Result<()> { pub(crate) fn pull<A: AsRef<str>, W: Write>(&mut self, source: A, output: W) -> Result<()> {
let (local_id, remote_id) = self.begin_synchronization()?; self.begin_synchronization()?;
let source = source.as_ref(); let source = source.as_ref();
let adb_stat_response = self.stat_with_explicit_ids(source, local_id, remote_id)?; let adb_stat_response = self.stat_with_explicit_ids(source)?;
if adb_stat_response.file_perm == 0 { if adb_stat_response.file_perm == 0 {
return Err(RustADBError::UnknownResponseType( return Err(RustADBError::UnknownResponseType(
@@ -21,8 +21,11 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
)); ));
} }
let local_id = self.get_local_id()?;
let remote_id = self.get_remote_id()?;
self.get_transport_mut().write_message_with_timeout( self.get_transport_mut().write_message_with_timeout(
ADBTransportMessage::new(MessageCommand::Okay, local_id, remote_id, "".into()), ADBTransportMessage::new(MessageCommand::Okay, local_id, remote_id, &[]),
std::time::Duration::from_secs(4), std::time::Duration::from_secs(4),
)?; )?;
@@ -31,19 +34,19 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
bincode::serialize(&recv_buffer).map_err(|_e| RustADBError::ConversionError)?; bincode::serialize(&recv_buffer).map_err(|_e| RustADBError::ConversionError)?;
self.send_and_expect_okay(ADBTransportMessage::new( self.send_and_expect_okay(ADBTransportMessage::new(
MessageCommand::Write, MessageCommand::Write,
local_id, self.get_local_id()?,
remote_id, self.get_remote_id()?,
recv_buffer, &recv_buffer,
))?; ))?;
self.send_and_expect_okay(ADBTransportMessage::new( self.send_and_expect_okay(ADBTransportMessage::new(
MessageCommand::Write, MessageCommand::Write,
local_id, self.get_local_id()?,
remote_id, self.get_remote_id()?,
source.into(), source.as_bytes(),
))?; ))?;
self.recv_file(local_id, remote_id, output)?; self.recv_file(output)?;
self.end_transaction(local_id, remote_id)?; self.end_transaction()?;
Ok(()) Ok(())
} }
} }

View File

@@ -1,16 +1,16 @@
use std::io::Read; use std::io::Read;
use crate::{ use crate::{
device::{
adb_message_device::ADBMessageDevice, ADBTransportMessage, MessageCommand,
MessageSubcommand,
},
ADBMessageTransport, Result, RustADBError, ADBMessageTransport, Result, RustADBError,
device::{
ADBTransportMessage, MessageCommand, MessageSubcommand,
adb_message_device::ADBMessageDevice,
},
}; };
impl<T: ADBMessageTransport> ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn push<R: Read, A: AsRef<str>>(&mut self, stream: R, path: A) -> Result<()> { pub(crate) fn push<R: Read, A: AsRef<str>>(&mut self, stream: R, path: A) -> Result<()> {
let (local_id, remote_id) = self.begin_synchronization()?; self.begin_synchronization()?;
let path_header = format!("{},0777", path.as_ref()); let path_header = format!("{},0777", path.as_ref());
@@ -21,14 +21,14 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
self.send_and_expect_okay(ADBTransportMessage::new( self.send_and_expect_okay(ADBTransportMessage::new(
MessageCommand::Write, MessageCommand::Write,
local_id, self.get_local_id()?,
remote_id, self.get_remote_id()?,
send_buffer, &send_buffer,
))?; ))?;
self.push_file(local_id, remote_id, stream)?; self.push_file(self.get_local_id()?, self.get_remote_id()?, stream)?;
self.end_transaction(local_id, remote_id)?; self.end_transaction()?;
Ok(()) Ok(())
} }

View File

@@ -1,28 +1,14 @@
use rand::Rng;
use crate::{ use crate::{
device::{adb_message_device::ADBMessageDevice, ADBTransportMessage, MessageCommand}, ADBMessageTransport, RebootType, Result,
ADBMessageTransport, RebootType, Result, RustADBError, device::{MessageCommand, adb_message_device::ADBMessageDevice},
}; };
impl<T: ADBMessageTransport> ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn reboot(&mut self, reboot_type: RebootType) -> Result<()> { pub(crate) fn reboot(&mut self, reboot_type: RebootType) -> Result<()> {
let mut rng = rand::thread_rng(); self.open_session(format!("reboot:{}\0", reboot_type).as_bytes())?;
let message = ADBTransportMessage::new( self.get_transport_mut()
MessageCommand::Open, .read_message()
rng.gen(), // Our 'local-id' .and_then(|message| message.assert_command(MessageCommand::Okay))
0,
format!("reboot:{}\0", reboot_type).as_bytes().to_vec(),
);
self.get_transport_mut().write_message(message)?;
let message = self.get_transport_mut().read_message()?;
if message.header().command() != MessageCommand::Okay {
return Err(RustADBError::ADBShellNotSupported);
}
Ok(())
} }
} }

View File

@@ -1,38 +1,17 @@
use rand::Rng; use std::io::{ErrorKind, Read, Write};
use std::io::{Read, Write};
use crate::device::ShellMessageWriter;
use crate::Result; use crate::Result;
use crate::device::ShellMessageWriter;
use crate::{ use crate::{
device::{ADBMessageDevice, ADBTransportMessage, MessageCommand},
ADBMessageTransport, RustADBError, ADBMessageTransport, RustADBError,
device::{ADBMessageDevice, ADBTransportMessage, MessageCommand},
}; };
impl<T: ADBMessageTransport> ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBMessageDevice<T> {
/// Runs 'command' in a shell on the device, and write its output and error streams into [`output`]. /// Runs 'command' in a shell on the device, and write its output and error streams into output.
pub(crate) fn shell_command<S: ToString, W: Write>( pub(crate) fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
&mut self, let response = self.open_session(format!("shell:{}\0", command.join(" "),).as_bytes())?;
command: impl IntoIterator<Item = S>,
mut output: W,
) -> Result<()> {
let message = ADBTransportMessage::new(
MessageCommand::Open,
1,
0,
format!(
"shell:{}\0",
command
.into_iter()
.map(|v| v.to_string())
.collect::<Vec<_>>()
.join(" "),
)
.as_bytes()
.to_vec(),
);
self.get_transport_mut().write_message(message)?;
let response = self.get_transport_mut().read_message()?;
if response.header().command() != MessageCommand::Okay { if response.header().command() != MessageCommand::Okay {
return Err(RustADBError::ADBRequestFailed(format!( return Err(RustADBError::ADBRequestFailed(format!(
"wrong command {}", "wrong command {}",
@@ -54,27 +33,18 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
/// Starts an interactive shell session on the device. /// Starts an interactive shell session on the device.
/// Input data is read from [reader] and write to [writer]. /// Input data is read from [reader] and write to [writer].
/// [W] has a 'static bound as it is internally used in a thread. pub(crate) fn shell(
pub(crate) fn shell<R: Read, W: Write + Send + 'static>(
&mut self, &mut self,
mut reader: R, mut reader: &mut dyn Read,
mut writer: W, mut writer: Box<(dyn Write + Send)>,
) -> Result<()> { ) -> Result<()> {
let sync_directive = "shell:\0"; self.open_session(b"shell:\0")?;
let mut rng = rand::thread_rng();
let message = ADBTransportMessage::new(
MessageCommand::Open,
rng.gen(), /* Our 'local-id' */
0,
sync_directive.into(),
);
let message = self.send_and_expect_okay(message)?;
let local_id = message.header().arg1();
let remote_id = message.header().arg0();
let mut transport = self.get_transport().clone(); 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 // Reading thread, reads response from adbd
std::thread::spawn(move || -> Result<()> { std::thread::spawn(move || -> Result<()> {
loop { loop {
@@ -82,17 +52,17 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
// Acknowledge for more data // Acknowledge for more data
let response = let response =
ADBTransportMessage::new(MessageCommand::Okay, local_id, remote_id, vec![]); ADBTransportMessage::new(MessageCommand::Okay, local_id, remote_id, &[]);
transport.write_message(response)?; transport.write_message(response)?;
match message.header().command() { match message.header().command() {
MessageCommand::Write => {} MessageCommand::Write => {
writer.write_all(&message.into_payload())?;
writer.flush()?;
}
MessageCommand::Okay => continue, MessageCommand::Okay => continue,
_ => return Err(RustADBError::ADBShellNotSupported), _ => return Err(RustADBError::ADBShellNotSupported),
} }
writer.write_all(&message.into_payload())?;
writer.flush()?;
} }
}); });
@@ -102,7 +72,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
// Read from given reader (that could be stdin e.g), and write content to device adbd // 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) { if let Err(e) = std::io::copy(&mut reader, &mut shell_writer) {
match e.kind() { match e.kind() {
std::io::ErrorKind::BrokenPipe => return Ok(()), ErrorKind::BrokenPipe => return Ok(()),
_ => return Err(RustADBError::IOError(e)), _ => return Err(RustADBError::IOError(e)),
} }
} }

View File

@@ -1,12 +1,12 @@
use crate::{ use crate::{
device::adb_message_device::ADBMessageDevice, ADBMessageTransport, AdbStatResponse, Result, ADBMessageTransport, AdbStatResponse, Result, device::adb_message_device::ADBMessageDevice,
}; };
impl<T: ADBMessageTransport> ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn stat(&mut self, remote_path: &str) -> Result<AdbStatResponse> { pub(crate) fn stat(&mut self, remote_path: &str) -> Result<AdbStatResponse> {
let (local_id, remote_id) = self.begin_synchronization()?; self.begin_synchronization()?;
let adb_stat_response = self.stat_with_explicit_ids(remote_path, local_id, remote_id)?; let adb_stat_response = self.stat_with_explicit_ids(remote_path)?;
self.end_transaction(local_id, remote_id)?; self.end_transaction()?;
Ok(adb_stat_response) Ok(adb_stat_response)
} }
} }

View File

@@ -0,0 +1,19 @@
use crate::{ADBMessageTransport, Result, device::adb_message_device::ADBMessageDevice};
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn uninstall(&mut self, package_name: &str) -> Result<()> {
self.open_session(format!("exec:cmd package 'uninstall' {}\0", package_name).as_bytes())?;
let final_status = self.get_transport_mut().read_message()?;
match final_status.into_payload().as_slice() {
b"Success\n" => {
log::info!("Package {} successfully uninstalled", package_name);
Ok(())
}
d => Err(crate::RustADBError::ADBRequestFailed(String::from_utf8(
d.to_vec(),
)?)),
}
}
}

View File

@@ -1,4 +1,4 @@
use std::io::{ErrorKind, Write}; use std::io::{Error, ErrorKind, Result, Write};
use crate::ADBMessageTransport; use crate::ADBMessageTransport;
@@ -24,30 +24,25 @@ impl<T: ADBMessageTransport> MessageWriter<T> {
} }
impl<T: ADBMessageTransport> Write for MessageWriter<T> { impl<T: ADBMessageTransport> Write for MessageWriter<T> {
fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> { fn write(&mut self, buf: &[u8]) -> Result<usize> {
let message = ADBTransportMessage::new( let message =
MessageCommand::Write, ADBTransportMessage::new(MessageCommand::Write, self.local_id, self.remote_id, buf);
self.local_id,
self.remote_id,
buf.to_vec(),
);
self.transport self.transport
.write_message(message) .write_message(message)
.map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidData, e))?; .map_err(|e| Error::new(ErrorKind::InvalidData, e))?;
match self.transport.read_message() { match self.transport.read_message() {
Ok(response) => match response.header().command() { Ok(response) => {
MessageCommand::Okay => Ok(buf.len()), response
c => Err(std::io::Error::new( .assert_command(MessageCommand::Okay)
ErrorKind::Other, .map_err(|e| Error::new(ErrorKind::Other, e))?;
format!("wrong response received: {c}"), Ok(buf.len())
)), }
}, Err(e) => Err(Error::new(ErrorKind::Other, e)),
Err(e) => Err(std::io::Error::new(ErrorKind::Other, e)),
} }
} }
fn flush(&mut self) -> std::io::Result<()> { fn flush(&mut self) -> Result<()> {
Ok(()) Ok(())
} }
} }

View File

@@ -11,7 +11,7 @@ mod shell_message_writer;
use adb_message_device::ADBMessageDevice; use adb_message_device::ADBMessageDevice;
pub use adb_tcp_device::ADBTcpDevice; pub use adb_tcp_device::ADBTcpDevice;
pub use adb_transport_message::{ADBTransportMessage, ADBTransportMessageHeader}; pub use adb_transport_message::{ADBTransportMessage, ADBTransportMessageHeader};
pub use adb_usb_device::{get_default_adb_key_path, ADBUSBDevice}; pub use adb_usb_device::{ADBUSBDevice, get_default_adb_key_path};
pub use message_writer::MessageWriter; pub use message_writer::MessageWriter;
pub use models::{ADBRsaKey, MessageCommand, MessageSubcommand}; pub use models::{ADBRsaKey, MessageCommand, MessageSubcommand};
pub use shell_message_writer::ShellMessageWriter; pub use shell_message_writer::ShellMessageWriter;

View File

@@ -1,9 +1,8 @@
use crate::{Result, RustADBError}; use crate::{Result, RustADBError};
use base64::{engine::general_purpose::STANDARD, Engine}; use base64::{Engine, engine::general_purpose::STANDARD};
use num_bigint::{BigUint, ModInverse}; use num_bigint::{BigUint, ModInverse};
use num_traits::cast::ToPrimitive;
use num_traits::FromPrimitive; use num_traits::FromPrimitive;
use rand::rngs::OsRng; use num_traits::cast::ToPrimitive;
use rsa::pkcs8::DecodePrivateKey; use rsa::pkcs8::DecodePrivateKey;
use rsa::traits::PublicKeyParts; use rsa::traits::PublicKeyParts;
use rsa::{Pkcs1v15Sign, RsaPrivateKey}; use rsa::{Pkcs1v15Sign, RsaPrivateKey};
@@ -52,7 +51,7 @@ pub struct ADBRsaKey {
impl ADBRsaKey { impl ADBRsaKey {
pub fn new_random() -> Result<Self> { pub fn new_random() -> Result<Self> {
Ok(Self { Ok(Self {
private_key: RsaPrivateKey::new(&mut OsRng, ADB_PRIVATE_KEY_SIZE)?, private_key: RsaPrivateKey::new(&mut rsa::rand_core::OsRng, ADB_PRIVATE_KEY_SIZE)?,
}) })
} }

View File

@@ -6,18 +6,17 @@ use std::fmt::Display;
#[repr(u32)] #[repr(u32)]
pub enum MessageCommand { pub enum MessageCommand {
/// Connect to a device /// Connect to a device
Cnxn = 0x4e584e43, Cnxn = 0x4E584E43,
/// Close connection to a device /// Close connection to a device
Clse = 0x45534c43, Clse = 0x45534C43,
/// Device ask for authentication /// Device ask for authentication
Auth = 0x48545541, Auth = 0x48545541,
/// Open a data connection /// Open a data connection
Open = 0x4e45504f, Open = 0x4E45504F,
/// Write data to connection /// Write data to connection
Write = 0x45545257, Write = 0x45545257,
/// Server understood the message /// Server understood the message
Okay = 0x59414b4f, Okay = 0x59414B4F,
// Sync 0x434e5953
/// Start a connection using TLS /// Start a connection using TLS
Stls = 0x534C5453, Stls = 0x534C5453,
} }
@@ -29,10 +28,10 @@ pub enum MessageSubcommand {
Send = 0x444E4553, Send = 0x444E4553,
Recv = 0x56434552, Recv = 0x56434552,
Quit = 0x54495551, Quit = 0x54495551,
Fail = 0x4c494146, Fail = 0x4C494146,
Done = 0x454e4f44, Done = 0x454E4F44,
Data = 0x41544144, Data = 0x41544144,
List = 0x5453494c, List = 0x5453494C,
} }
#[derive(Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]

View File

@@ -2,7 +2,7 @@ use std::io::Write;
use crate::ADBMessageTransport; use crate::ADBMessageTransport;
use super::{models::MessageCommand, ADBTransportMessage}; use super::{ADBTransportMessage, models::MessageCommand};
/// [`Write`] trait implementation to hide underlying ADB protocol write logic for shell commands. /// [`Write`] trait implementation to hide underlying ADB protocol write logic for shell commands.
pub struct ShellMessageWriter<T: ADBMessageTransport> { pub struct ShellMessageWriter<T: ADBMessageTransport> {
@@ -23,12 +23,8 @@ impl<T: ADBMessageTransport> ShellMessageWriter<T> {
impl<T: ADBMessageTransport> Write for ShellMessageWriter<T> { impl<T: ADBMessageTransport> Write for ShellMessageWriter<T> {
fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> { fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
let message = ADBTransportMessage::new( let message =
MessageCommand::Write, ADBTransportMessage::new(MessageCommand::Write, self.local_id, self.remote_id, buf);
self.local_id,
self.remote_id,
buf.to_vec(),
);
self.transport self.transport
.write_message(message) .write_message(message)
.map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidData, e))?; .map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidData, e))?;

View File

@@ -65,10 +65,15 @@ impl TryFrom<ADBServerDevice> for ADBEmulatorDevice {
type Error = RustADBError; type Error = RustADBError;
fn try_from(value: ADBServerDevice) -> std::result::Result<Self, Self::Error> { fn try_from(value: ADBServerDevice) -> std::result::Result<Self, Self::Error> {
ADBEmulatorDevice::new( match &value.identifier {
value.identifier.clone(), Some(device_identifier) => ADBEmulatorDevice::new(
Some(*value.get_transport().get_socketaddr().ip()), 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(),
)),
}
} }
} }

View File

@@ -1,10 +1,8 @@
use crate::{models::ADBEmulatorCommand, ADBEmulatorDevice, Result}; use crate::{ADBEmulatorDevice, Result, emulator_device::ADBEmulatorCommand};
impl ADBEmulatorDevice { impl ADBEmulatorDevice {
/// Send a SMS to this emulator with given content with given phone number /// Send a SMS to this emulator with given content with given phone number
pub fn rotate(&mut self) -> Result<()> { pub fn rotate(&mut self) -> Result<()> {
let transport = self.connect()?; self.connect()?.send_command(ADBEmulatorCommand::Rotate)
transport.send_command(ADBEmulatorCommand::Rotate)?;
Ok(())
} }
} }

View File

@@ -1,13 +1,11 @@
use crate::{models::ADBEmulatorCommand, ADBEmulatorDevice, Result}; use crate::{ADBEmulatorDevice, Result, emulator_device::ADBEmulatorCommand};
impl ADBEmulatorDevice { impl ADBEmulatorDevice {
/// Send a SMS to this emulator with given content with given phone number /// 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<()> { pub fn send_sms(&mut self, phone_number: &str, content: &str) -> Result<()> {
let transport = self.connect()?; self.connect()?.send_command(ADBEmulatorCommand::Sms(
transport.send_command(ADBEmulatorCommand::Sms(
phone_number.to_string(), phone_number.to_string(),
content.to_string(), content.to_string(),
))?; ))
Ok(())
} }
} }

View File

@@ -1,3 +1,5 @@
mod adb_emulator_device; mod adb_emulator_device;
mod commands; mod commands;
mod models;
pub use adb_emulator_device::ADBEmulatorDevice; pub use adb_emulator_device::ADBEmulatorDevice;
pub(crate) use models::ADBEmulatorCommand;

View File

@@ -1,6 +1,6 @@
use std::fmt::Display; use std::fmt::Display;
pub(crate) enum ADBEmulatorCommand { pub enum ADBEmulatorCommand {
Authenticate(String), Authenticate(String),
Sms(String, String), Sms(String, String),
Rotate, Rotate,

View File

@@ -0,0 +1,2 @@
mod adb_emulator_command;
pub use adb_emulator_command::ADBEmulatorCommand;

View File

@@ -15,6 +15,9 @@ pub enum RustADBError {
/// Indicates that ADB server responded an unknown response type. /// Indicates that ADB server responded an unknown response type.
#[error("Unknown response type {0}")] #[error("Unknown response type {0}")]
UnknownResponseType(String), 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. /// Indicates that ADB server responses an unknown device state.
#[error("Unknown device state {0}")] #[error("Unknown device state {0}")]
UnknownDeviceState(String), UnknownDeviceState(String),
@@ -64,7 +67,7 @@ pub enum RustADBError {
#[error("Cannot get home directory")] #[error("Cannot get home directory")]
NoHomeDirectory, NoHomeDirectory,
/// Generic USB error /// Generic USB error
#[error(transparent)] #[error("USB Error: {0}")]
UsbError(#[from] rusb::Error), UsbError(#[from] rusb::Error),
/// USB device not found /// USB device not found
#[error("USB Device not found: {0} {1}")] #[error("USB Device not found: {0} {1}")]
@@ -114,6 +117,9 @@ pub enum RustADBError {
/// An error occurred while sending data to channel /// An error occurred while sending data to channel
#[error(transparent)] #[error(transparent)]
SendError(#[from] std::sync::mpsc::SendError<crate::MDNSDevice>), SendError(#[from] std::sync::mpsc::SendError<crate::MDNSDevice>),
/// An unknown transport has been provided
#[error("unknown transport: {0}")]
UnknownTransport(String),
} }
impl<T> From<std::sync::PoisonError<T>> for RustADBError { impl<T> From<std::sync::PoisonError<T>> for RustADBError {

View File

@@ -21,9 +21,7 @@ pub use device::{ADBTcpDevice, ADBUSBDevice};
pub use emulator_device::ADBEmulatorDevice; pub use emulator_device::ADBEmulatorDevice;
pub use error::{Result, RustADBError}; pub use error::{Result, RustADBError};
pub use mdns::*; pub use mdns::*;
pub use models::{ pub use models::{AdbStatResponse, RebootType};
AdbStatResponse, AdbVersion, DeviceLong, DeviceShort, DeviceState, MDNSBackend, RebootType,
};
pub use server::*; pub use server::*;
pub use server_device::ADBServerDevice; pub use server_device::ADBServerDevice;
pub use transports::*; pub use transports::*;

View File

@@ -33,19 +33,21 @@ impl MDNSDiscoveryService {
pub fn start(&mut self, sender: Sender<MDNSDevice>) -> Result<()> { pub fn start(&mut self, sender: Sender<MDNSDevice>) -> Result<()> {
let receiver = self.daemon.browse(ADB_SERVICE_NAME)?; let receiver = self.daemon.browse(ADB_SERVICE_NAME)?;
let handle: JoinHandle<Result<()>> = std::thread::spawn(move || loop { let handle: JoinHandle<Result<()>> = std::thread::spawn(move || {
while let Ok(event) = receiver.recv() { loop {
match event { while let Ok(event) = receiver.recv() {
ServiceEvent::SearchStarted(_) match event {
| ServiceEvent::ServiceRemoved(_, _) ServiceEvent::SearchStarted(_)
| ServiceEvent::ServiceFound(_, _) | ServiceEvent::ServiceRemoved(_, _)
| ServiceEvent::SearchStopped(_) => { | ServiceEvent::ServiceFound(_, _)
// Ignoring these events. We are only interesting in found devices | ServiceEvent::SearchStopped(_) => {
continue; // Ignoring these events. We are only interesting in found devices
} continue;
ServiceEvent::ServiceResolved(service_info) => { }
if let Err(e) = sender.send(MDNSDevice::from(service_info)) { ServiceEvent::ServiceResolved(service_info) => {
return Err(e.into()); if let Err(e) = sender.send(MDNSDevice::from(service_info)) {
return Err(e.into());
}
} }
} }
} }

View File

@@ -1,5 +1,7 @@
use std::fmt::Display; use std::fmt::Display;
use crate::{WaitForDeviceState, WaitForDeviceTransport};
use super::RebootType; use super::RebootType;
use std::net::SocketAddrV4; use std::net::SocketAddrV4;
@@ -20,7 +22,9 @@ pub(crate) enum AdbServerCommand {
MDNSServices, MDNSServices,
ServerStatus, ServerStatus,
ReconnectOffline, ReconnectOffline,
Uninstall(String),
Install(u64), Install(u64),
WaitForDevice(WaitForDeviceState, WaitForDeviceTransport),
// Local commands // Local commands
ShellCommand(String), ShellCommand(String),
Shell, Shell,
@@ -83,6 +87,15 @@ impl Display for AdbServerCommand {
} }
AdbServerCommand::Usb => write!(f, "usb:"), AdbServerCommand::Usb => write!(f, "usb:"),
AdbServerCommand::Install(size) => write!(f, "exec:cmd package 'install' -S {size}"), 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}"
)
}
} }
} }
} }

View 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)?,
})
}
}

View File

@@ -1,28 +1,15 @@
mod adb_emulator_command;
mod adb_request_status; mod adb_request_status;
mod adb_server_command; mod adb_server_command;
mod adb_stat_response; mod adb_stat_response;
mod adb_version; mod framebuffer_info;
mod device_long;
mod device_short;
mod device_state;
mod host_features; mod host_features;
mod mdns_services;
mod reboot_type; mod reboot_type;
mod server_status;
mod sync_command; mod sync_command;
pub(crate) use adb_emulator_command::ADBEmulatorCommand;
pub use adb_request_status::AdbRequestStatus; pub use adb_request_status::AdbRequestStatus;
pub(crate) use adb_server_command::AdbServerCommand; pub(crate) use adb_server_command::AdbServerCommand;
pub use adb_stat_response::AdbStatResponse; pub use adb_stat_response::AdbStatResponse;
pub use adb_version::AdbVersion; pub(crate) use framebuffer_info::{FrameBufferInfoV1, FrameBufferInfoV2};
pub use device_long::DeviceLong;
pub use device_short::DeviceShort;
pub use device_state::DeviceState;
pub use host_features::HostFeatures; pub use host_features::HostFeatures;
pub use mdns_services::MDNSServices;
pub use reboot_type::RebootType; pub use reboot_type::RebootType;
pub use server_status::MDNSBackend;
pub use server_status::ServerStatus;
pub use sync_command::SyncCommand; pub use sync_command::SyncCommand;

View File

@@ -15,6 +15,9 @@ pub struct ADBServer {
pub(crate) socket_addr: Option<SocketAddrV4>, pub(crate) socket_addr: Option<SocketAddrV4>,
/// adb-server start envs /// adb-server start envs
pub(crate) envs: HashMap<String, String>, 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 { impl ADBServer {
@@ -24,6 +27,44 @@ impl ADBServer {
transport: None, transport: None,
socket_addr: Some(address), socket_addr: Some(address),
envs: HashMap::new(), 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}"),
} }
} }
@@ -52,22 +93,7 @@ impl ADBServer {
}; };
if is_local_ip { if is_local_ip {
// ADB Server is local, we start it if not already running Self::start(&self.envs, &self.adb_path);
let mut command = Command::new("adb");
command.arg("start-server");
for (env_k, env_v) in self.envs.iter() {
command.env(env_k, env_v);
}
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}"),
}
} }
transport.connect()?; transport.connect()?;
@@ -79,7 +105,7 @@ impl ADBServer {
impl Drop for ADBServer { impl Drop for ADBServer {
fn drop(&mut self) { fn drop(&mut self) {
if let Some(ref mut transport) = &mut self.transport { if let Some(transport) = &mut self.transport {
let _ = transport.disconnect(); let _ = transport.disconnect();
} }
} }

View File

@@ -1,4 +1,4 @@
use crate::{models::AdbServerCommand, ADBServer, Result, RustADBError}; use crate::{ADBServer, Result, RustADBError, models::AdbServerCommand};
use std::net::SocketAddrV4; use std::net::SocketAddrV4;
impl ADBServer { impl ADBServer {

View File

@@ -1,8 +1,8 @@
use std::io::Read; use std::io::Read;
use crate::{ use crate::{
models::{AdbServerCommand, DeviceShort}, ADBEmulatorDevice, ADBServer, ADBServerDevice, DeviceLong, DeviceShort, Result, RustADBError,
ADBEmulatorDevice, ADBServer, ADBServerDevice, DeviceLong, Result, RustADBError, models::AdbServerCommand,
}; };
impl ADBServer { impl ADBServer {
@@ -97,7 +97,12 @@ impl ADBServer {
.get_raw_connection()? .get_raw_connection()?
.read_exact(&mut body)?; .read_exact(&mut body)?;
callback(DeviceShort::try_from(body)?)?; for device in body.split(|x| x.eq(&b'\n')) {
if device.is_empty() {
break;
}
callback(DeviceShort::try_from(device.to_vec())?)?;
}
} }
} }
} }

View File

@@ -1,4 +1,4 @@
use crate::{models::AdbServerCommand, ADBServer, Result, RustADBError}; use crate::{ADBServer, Result, RustADBError, models::AdbServerCommand};
use std::net::SocketAddrV4; use std::net::SocketAddrV4;
impl ADBServer { impl ADBServer {

View File

@@ -1,4 +1,4 @@
use crate::{models::AdbServerCommand, ADBServer, Result}; use crate::{ADBServer, Result, models::AdbServerCommand};
impl ADBServer { impl ADBServer {
/// Asks the ADB server to quit immediately. /// Asks the ADB server to quit immediately.

View File

@@ -1,8 +1,7 @@
use std::io::BufRead; use std::io::BufRead;
use crate::{ use crate::{
models::{AdbServerCommand, MDNSBackend, MDNSServices}, ADBServer, MDNSServices, Result, models::AdbServerCommand, server::models::MDNSBackend,
ADBServer, Result,
}; };
const OPENSCREEN_MDNS_BACKEND: &str = "ADB_MDNS_OPENSCREEN"; const OPENSCREEN_MDNS_BACKEND: &str = "ADB_MDNS_OPENSCREEN";

View File

@@ -7,3 +7,4 @@ mod pair;
mod reconnect; mod reconnect;
mod server_status; mod server_status;
mod version; mod version;
mod wait_for_device;

View File

@@ -1,4 +1,4 @@
use crate::{models::AdbServerCommand, ADBServer, Result}; use crate::{ADBServer, Result, models::AdbServerCommand};
impl ADBServer { impl ADBServer {
/// Reconnect the device /// Reconnect the device

View File

@@ -1,7 +1,4 @@
use crate::{ use crate::{ADBServer, Result, models::AdbServerCommand, server::models::ServerStatus};
models::{AdbServerCommand, ServerStatus},
ADBServer, Result,
};
impl ADBServer { impl ADBServer {
/// Check ADB server status /// Check ADB server status

View File

@@ -1,4 +1,4 @@
use crate::{models::AdbServerCommand, ADBServer, AdbVersion, Result}; use crate::{ADBServer, AdbVersion, Result, models::AdbServerCommand};
impl ADBServer { impl ADBServer {
/// Gets server's internal version number. /// Gets server's internal version number.

View File

@@ -0,0 +1,20 @@
use crate::{
ADBServer, Result, WaitForDeviceState, WaitForDeviceTransport, models::AdbServerCommand,
};
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()
}
}

View File

@@ -1,4 +1,6 @@
mod adb_server; mod adb_server;
mod commands; mod commands;
mod models;
pub use adb_server::ADBServer; pub use adb_server::ADBServer;
pub use models::*;

View File

@@ -6,7 +6,7 @@ use crate::{DeviceState, RustADBError};
use regex::bytes::Regex; use regex::bytes::Regex;
static DEVICES_LONG_REGEX: LazyLock<Regex> = LazyLock::new(|| { static DEVICES_LONG_REGEX: LazyLock<Regex> = LazyLock::new(|| {
Regex::new("^(?P<identifier>\\S+)\\s+(?P<state>\\w+) ((usb:(?P<usb1>.*)|(?P<usb2>\\d-\\d)) )?(product:(?P<product>\\w+) model:(?P<model>\\w+) device:(?P<device>\\w+) )?transport_id:(?P<transport_id>\\d+)$").expect("cannot build devices long regex") Regex::new(r"^(?P<identifier>\S+)\s+(?P<state>\w+)\s+(usb:(?P<usb1>\S+)|(?P<usb2>\S+))?\s*(product:(?P<product>\w+)\s+model:(?P<model>\w+)\s+device:(?P<device>\w+)\s+)?transport_id:(?P<transport_id>\d+)$").expect("cannot build devices long regex")
}); });
/// Represents a new device with more informations. /// Represents a new device with more informations.

View 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};

View File

@@ -91,14 +91,23 @@ impl Display for MDNSBackend {
/// Structure representing current server status /// Structure representing current server status
#[derive(Debug, Clone, Default, PartialEq)] #[derive(Debug, Clone, Default, PartialEq)]
pub struct ServerStatus { pub struct ServerStatus {
/// Currently active USB backend
pub usb_backend: UsbBackend, pub usb_backend: UsbBackend,
/// Is USB backend forced ?
pub usb_backend_forced: bool, pub usb_backend_forced: bool,
/// Currently active MDNS backend
pub mdns_backend: MDNSBackend, pub mdns_backend: MDNSBackend,
/// Is MDNS backend forced ?
pub mdns_backend_forced: bool, pub mdns_backend_forced: bool,
/// Server version
pub version: String, pub version: String,
/// Server build information
pub build: String, pub build: String,
/// Server executable absolute path
pub executable_absolute_path: String, pub executable_absolute_path: String,
/// Server logs absolute path
pub log_absolute_path: String, pub log_absolute_path: String,
/// OS server is running on
pub os: String, pub os: String,
} }

View 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"),
}
}
}

View File

@@ -1,43 +1,54 @@
use crate::{ADBTransport, Result, TCPServerTransport}; use crate::{ADBTransport, Result, TCPServerTransport, models::AdbServerCommand};
use std::net::SocketAddrV4; use std::net::SocketAddrV4;
/// Represents a device connected to the ADB server. /// Represents a device connected to the ADB server.
#[derive(Debug)] #[derive(Debug)]
pub struct ADBServerDevice { pub struct ADBServerDevice {
/// Unique device identifier. /// Unique device identifier.
pub identifier: String, pub identifier: Option<String>,
/// Internal [TCPServerTransport] /// Internal [TCPServerTransport]
transport: TCPServerTransport, pub(crate) transport: TCPServerTransport,
} }
impl ADBServerDevice { impl ADBServerDevice {
/// Instantiates a new [ADBServerDevice] /// Instantiates a new [ADBServerDevice], knowing its ADB identifier (as returned by `adb devices` command).
pub fn new(identifier: String, socket_addr: Option<SocketAddrV4>) -> Self { pub fn new(identifier: String, server_addr: Option<SocketAddrV4>) -> Self {
let transport = if let Some(addr) = socket_addr { let transport = TCPServerTransport::new_or_default(server_addr);
TCPServerTransport::new(addr)
} else {
TCPServerTransport::default()
};
Self { Self {
identifier, identifier: Some(identifier),
transport, transport,
} }
} }
pub(crate) fn get_transport(&self) -> &TCPServerTransport { /// Instantiates a new [ADBServerDevice], assuming only one is currently connected.
&self.transport pub fn autodetect(server_addr: Option<SocketAddrV4>) -> Self {
} let transport = TCPServerTransport::new_or_default(server_addr);
pub(crate) fn get_transport_mut(&mut self) -> &mut TCPServerTransport { Self {
&mut self.transport identifier: None,
transport,
}
} }
/// Connect to underlying transport /// Connect to underlying transport
pub(crate) fn connect(&mut self) -> Result<&mut TCPServerTransport> { pub(crate) fn connect(&mut self) -> Result<&mut TCPServerTransport> {
self.transport.connect()?; self.transport.connect()?;
Ok(self.get_transport_mut()) Ok(&mut self.transport)
}
/// Set device connection to use serial transport
pub(crate) fn set_serial_transport(&mut self) -> Result<()> {
let identifier = self.identifier.clone();
let transport = self.connect()?;
if let Some(serial) = identifier {
transport.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
} else {
transport.send_adb_request(AdbServerCommand::TransportAny)?;
}
Ok(())
} }
} }

View File

@@ -1,22 +1,18 @@
use std::{ use std::{
io::{Read, Write}, io::{ErrorKind, Read, Write},
path::Path, path::Path,
}; };
use crate::{ use crate::{
ADBDeviceExt, Result, RustADBError,
constants::BUFFER_SIZE, constants::BUFFER_SIZE,
models::{AdbServerCommand, AdbStatResponse, HostFeatures}, models::{AdbServerCommand, AdbStatResponse, HostFeatures},
ADBDeviceExt, Result, RustADBError,
}; };
use super::ADBServerDevice; use super::ADBServerDevice;
impl ADBDeviceExt for ADBServerDevice { impl ADBDeviceExt for ADBServerDevice {
fn shell_command<S: ToString, W: Write>( fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
&mut self,
command: impl IntoIterator<Item = S>,
mut output: W,
) -> Result<()> {
let supported_features = self.host_features()?; let supported_features = self.host_features()?;
if !supported_features.contains(&HostFeatures::ShellV2) if !supported_features.contains(&HostFeatures::ShellV2)
&& !supported_features.contains(&HostFeatures::Cmd) && !supported_features.contains(&HostFeatures::Cmd)
@@ -24,26 +20,14 @@ impl ADBDeviceExt for ADBServerDevice {
return Err(RustADBError::ADBShellNotSupported); return Err(RustADBError::ADBShellNotSupported);
} }
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial))?; self.transport
self.get_transport_mut() .send_adb_request(AdbServerCommand::ShellCommand(command.join(" ")))?;
.send_adb_request(AdbServerCommand::ShellCommand(
command
.into_iter()
.map(|v| v.to_string())
.collect::<Vec<_>>()
.join(" "),
))?;
const BUFFER_SIZE: usize = 4096;
loop { loop {
let mut buffer = [0; BUFFER_SIZE]; let mut buffer = [0; BUFFER_SIZE];
match self match self.transport.get_raw_connection()?.read(&mut buffer) {
.get_transport_mut()
.get_raw_connection()?
.read(&mut buffer)
{
Ok(size) => { Ok(size) => {
if size == 0 { if size == 0 {
return Ok(()); return Ok(());
@@ -62,10 +46,10 @@ impl ADBDeviceExt for ADBServerDevice {
self.stat(remote_path) self.stat(remote_path)
} }
fn shell<R: Read, W: Write + Send + 'static>( fn shell(
&mut self, &mut self,
mut reader: R, mut reader: &mut dyn Read,
mut writer: W, mut writer: Box<(dyn Write + Send)>,
) -> Result<()> { ) -> Result<()> {
let supported_features = self.host_features()?; let supported_features = self.host_features()?;
if !supported_features.contains(&HostFeatures::ShellV2) if !supported_features.contains(&HostFeatures::ShellV2)
@@ -74,13 +58,10 @@ impl ADBDeviceExt for ADBServerDevice {
return Err(RustADBError::ADBShellNotSupported); return Err(RustADBError::ADBShellNotSupported);
} }
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()? self.transport.send_adb_request(AdbServerCommand::Shell)?;
.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
self.get_transport_mut()
.send_adb_request(AdbServerCommand::Shell)?;
let mut read_stream = self.get_transport_mut().get_raw_connection()?.try_clone()?; let mut read_stream = self.transport.get_raw_connection()?.try_clone()?;
let mut write_stream = read_stream.try_clone()?; let mut write_stream = read_stream.try_clone()?;
@@ -107,7 +88,7 @@ impl ADBDeviceExt for ADBServerDevice {
// Read from given reader (that could be stdin e.g), and write content to server socket // Read from given reader (that could be stdin e.g), and write content to server socket
if let Err(e) = std::io::copy(&mut reader, &mut write_stream) { if let Err(e) = std::io::copy(&mut reader, &mut write_stream) {
match e.kind() { match e.kind() {
std::io::ErrorKind::BrokenPipe => return Ok(()), ErrorKind::BrokenPipe => return Ok(()),
_ => return Err(RustADBError::IOError(e)), _ => return Err(RustADBError::IOError(e)),
} }
} }
@@ -115,7 +96,7 @@ impl ADBDeviceExt for ADBServerDevice {
Ok(()) Ok(())
} }
fn pull<A: AsRef<str>, W: Write>(&mut self, source: A, mut output: W) -> Result<()> { fn pull(&mut self, source: &dyn AsRef<str>, mut output: &mut dyn Write) -> Result<()> {
self.pull(source, &mut output) self.pull(source, &mut output)
} }
@@ -123,11 +104,19 @@ impl ADBDeviceExt for ADBServerDevice {
self.reboot(reboot_type) self.reboot(reboot_type)
} }
fn push<R: Read, A: AsRef<str>>(&mut self, stream: R, path: A) -> Result<()> { fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
self.push(stream, path) self.push(stream, path)
} }
fn install<P: AsRef<Path>>(&mut self, apk_path: P) -> Result<()> { fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
self.install(apk_path) 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()
}
} }

View File

@@ -1,24 +1,20 @@
use crate::{models::AdbServerCommand, ADBServerDevice, Result}; use crate::{ADBServerDevice, Result, models::AdbServerCommand};
impl ADBServerDevice { impl ADBServerDevice {
/// Forward socket connection /// Forward socket connection
pub fn forward(&mut self, remote: String, local: String) -> Result<()> { pub fn forward(&mut self, remote: String, local: String) -> Result<()> {
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial.clone()))?;
self.get_transport_mut() self.transport
.proxy_connection(AdbServerCommand::Forward(remote, local), false) .proxy_connection(AdbServerCommand::Forward(remote, local), false)
.map(|_| ()) .map(|_| ())
} }
/// Remove all previously applied forward rules /// Remove all previously applied forward rules
pub fn forward_remove_all(&mut self) -> Result<()> { pub fn forward_remove_all(&mut self) -> Result<()> {
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial.clone()))?;
self.get_transport_mut() self.transport
.proxy_connection(AdbServerCommand::ForwardRemoveAll, false) .proxy_connection(AdbServerCommand::ForwardRemoveAll, false)
.map(|_| ()) .map(|_| ())
} }

View File

@@ -1,134 +1,23 @@
use std::{ use std::io::Read;
io::{Read, Seek, Write},
iter::Map,
path::Path,
slice::ChunksExact,
};
use byteorder::{LittleEndian, ReadBytesExt}; use byteorder::{LittleEndian, ReadBytesExt};
use image::{ImageBuffer, ImageFormat, Rgba}; use image::{ImageBuffer, Rgba};
use crate::{models::AdbServerCommand, utils, ADBServerDevice, Result, RustADBError}; use crate::{
ADBServerDevice, Result, RustADBError,
type U32ChunkIter<'a> = Map<ChunksExact<'a, u8>, fn(&[u8]) -> Result<u32>>; models::{AdbServerCommand, FrameBufferInfoV1, FrameBufferInfoV2},
};
fn read_next(chunks: &mut U32ChunkIter) -> Result<u32> {
chunks
.next()
.ok_or(RustADBError::FramebufferConversionError)?
}
#[derive(Debug)]
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(utils::u32_from_le);
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)]
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(utils::u32_from_le);
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)?,
})
}
}
impl ADBServerDevice { impl ADBServerDevice {
/// Dump framebuffer of this device into given ['path']
/// Big help from source code (<https://android.googlesource.com/platform/system/adb/+/refs/heads/main/framebuffer_service.cpp>)
pub fn framebuffer<P: AsRef<Path>>(&mut self, path: P) -> Result<()> {
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`.
pub fn framebuffer_bytes<W: Write + Seek>(&mut self, mut writer: W) -> Result<()> {
let img = self.framebuffer_inner()?;
Ok(img.write_to(&mut writer, ImageFormat::Png)?)
}
/// Inner method requesting framebuffer from Android device /// Inner method requesting framebuffer from Android device
fn framebuffer_inner(&mut self) -> Result<ImageBuffer<Rgba<u8>, Vec<u8>>> { pub(crate) fn framebuffer_inner(&mut self) -> Result<ImageBuffer<Rgba<u8>, Vec<u8>>> {
let serial: String = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
self.get_transport_mut() self.transport
.send_adb_request(AdbServerCommand::FrameBuffer)?; .send_adb_request(AdbServerCommand::FrameBuffer)?;
let version = self let version = self
.get_transport_mut() .transport
.get_raw_connection()? .get_raw_connection()?
.read_u32::<LittleEndian>()?; .read_u32::<LittleEndian>()?;
@@ -137,51 +26,49 @@ impl ADBServerDevice {
1 => { 1 => {
let mut buf = [0u8; std::mem::size_of::<FrameBufferInfoV1>()]; let mut buf = [0u8; std::mem::size_of::<FrameBufferInfoV1>()];
self.get_transport_mut() self.transport.get_raw_connection()?.read_exact(&mut buf)?;
.get_raw_connection()?
.read_exact(&mut buf)?;
let h: FrameBufferInfoV1 = buf.try_into()?; let framebuffer_info: FrameBufferInfoV1 = buf.try_into()?;
let mut data = vec![ let mut data = vec![
0_u8; 0_u8;
h.size framebuffer_info
.size
.try_into() .try_into()
.map_err(|_| RustADBError::ConversionError)? .map_err(|_| RustADBError::ConversionError)?
]; ];
self.get_transport_mut() self.transport.get_raw_connection()?.read_exact(&mut data)?;
.get_raw_connection()?
.read_exact(&mut data)?;
Ok( Ok(ImageBuffer::<Rgba<u8>, Vec<u8>>::from_vec(
ImageBuffer::<Rgba<u8>, Vec<u8>>::from_vec(h.width, h.height, data) framebuffer_info.width,
.ok_or_else(|| RustADBError::FramebufferConversionError)?, framebuffer_info.height,
data,
) )
.ok_or_else(|| RustADBError::FramebufferConversionError)?)
} }
// RGBX_8888 // RGBX_8888
2 => { 2 => {
let mut buf = [0u8; std::mem::size_of::<FrameBufferInfoV2>()]; let mut buf = [0u8; std::mem::size_of::<FrameBufferInfoV2>()];
self.get_transport_mut() self.transport.get_raw_connection()?.read_exact(&mut buf)?;
.get_raw_connection()?
.read_exact(&mut buf)?;
let h: FrameBufferInfoV2 = buf.try_into()?; let framebuffer_info: FrameBufferInfoV2 = buf.try_into()?;
let mut data = vec![ let mut data = vec![
0_u8; 0_u8;
h.size framebuffer_info
.size
.try_into() .try_into()
.map_err(|_| RustADBError::ConversionError)? .map_err(|_| RustADBError::ConversionError)?
]; ];
self.get_transport_mut() self.transport.get_raw_connection()?.read_exact(&mut data)?;
.get_raw_connection()?
.read_exact(&mut data)?;
Ok( Ok(ImageBuffer::<Rgba<u8>, Vec<u8>>::from_vec(
ImageBuffer::<Rgba<u8>, Vec<u8>>::from_vec(h.width, h.height, data) framebuffer_info.width,
.ok_or_else(|| RustADBError::FramebufferConversionError)?, framebuffer_info.height,
data,
) )
.ok_or_else(|| RustADBError::FramebufferConversionError)?)
} }
v => Err(RustADBError::UnimplementedFramebufferImageVersion(v)), v => Err(RustADBError::UnimplementedFramebufferImageVersion(v)),
} }

View File

@@ -1,17 +1,15 @@
use crate::{ use crate::{
models::{AdbServerCommand, HostFeatures},
ADBServerDevice, Result, ADBServerDevice, Result,
models::{AdbServerCommand, HostFeatures},
}; };
impl ADBServerDevice { impl ADBServerDevice {
/// Lists available ADB server features. /// Lists available ADB server features.
pub fn host_features(&mut self) -> Result<Vec<HostFeatures>> { pub fn host_features(&mut self) -> Result<Vec<HostFeatures>> {
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
let features = self let features = self
.get_transport_mut() .transport
.proxy_connection(AdbServerCommand::HostFeatures, true)?; .proxy_connection(AdbServerCommand::HostFeatures, true)?;
Ok(features Ok(features

View File

@@ -1,7 +1,7 @@
use std::{fs::File, io::Read, path::Path}; use std::{fs::File, io::Read, path::Path};
use crate::{ use crate::{
models::AdbServerCommand, server_device::ADBServerDevice, utils::check_extension_is_apk, Result, Result, models::AdbServerCommand, server_device::ADBServerDevice, utils::check_extension_is_apk,
}; };
impl ADBServerDevice { impl ADBServerDevice {
@@ -13,19 +13,17 @@ impl ADBServerDevice {
let file_size = apk_file.metadata()?.len(); let file_size = apk_file.metadata()?.len();
let serial: String = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
self.get_transport_mut() self.transport
.send_adb_request(AdbServerCommand::Install(file_size))?; .send_adb_request(AdbServerCommand::Install(file_size))?;
let mut raw_connection = self.get_transport_mut().get_raw_connection()?; let mut raw_connection = self.transport.get_raw_connection()?;
std::io::copy(&mut apk_file, &mut raw_connection)?; std::io::copy(&mut apk_file, &mut raw_connection)?;
let mut data = [0; 1024]; let mut data = [0; 1024];
let read_amount = self.get_transport().get_raw_connection()?.read(&mut data)?; let read_amount = self.transport.get_raw_connection()?.read(&mut data)?;
match &data[0..read_amount] { match &data[0..read_amount] {
b"Success\n" => { b"Success\n" => {

View File

@@ -1,6 +1,6 @@
use crate::{ use crate::{
models::{AdbServerCommand, SyncCommand},
ADBServerDevice, Result, ADBServerDevice, Result,
models::{AdbServerCommand, SyncCommand},
}; };
use byteorder::{ByteOrder, LittleEndian}; use byteorder::{ByteOrder, LittleEndian};
use std::{ use std::{
@@ -11,17 +11,13 @@ use std::{
impl ADBServerDevice { impl ADBServerDevice {
/// Lists files in path on the device. /// Lists files in path on the device.
pub fn list<A: AsRef<str>>(&mut self, path: A) -> Result<()> { pub fn list<A: AsRef<str>>(&mut self, path: A) -> Result<()> {
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
// Set device in SYNC mode // Set device in SYNC mode
self.get_transport_mut() self.transport.send_adb_request(AdbServerCommand::Sync)?;
.send_adb_request(AdbServerCommand::Sync)?;
// Send a list command // Send a list command
self.get_transport_mut() self.transport.send_sync_request(SyncCommand::List)?;
.send_sync_request(SyncCommand::List)?;
self.handle_list_command(path) self.handle_list_command(path)
} }
@@ -33,19 +29,17 @@ impl ADBServerDevice {
LittleEndian::write_u32(&mut len_buf, path.as_ref().len() as u32); LittleEndian::write_u32(&mut len_buf, path.as_ref().len() as u32);
// 4 bytes of command name is already sent by send_sync_request // 4 bytes of command name is already sent by send_sync_request
self.get_transport_mut() self.transport.get_raw_connection()?.write_all(&len_buf)?;
.get_raw_connection()?
.write_all(&len_buf)?;
// List send the string of the directory to list, and then the server send a list of files // List send the string of the directory to list, and then the server send a list of files
self.get_transport_mut() self.transport
.get_raw_connection()? .get_raw_connection()?
.write_all(path.as_ref().to_string().as_bytes())?; .write_all(path.as_ref().to_string().as_bytes())?;
// Reads returned status code from ADB server // Reads returned status code from ADB server
let mut response = [0_u8; 4]; let mut response = [0_u8; 4];
loop { loop {
self.get_transport_mut() self.transport
.get_raw_connection()? .get_raw_connection()?
.read_exact(&mut response)?; .read_exact(&mut response)?;
match str::from_utf8(response.as_ref())? { match str::from_utf8(response.as_ref())? {
@@ -57,7 +51,7 @@ impl ADBServerDevice {
let mut mod_time = [0_u8; 4]; let mut mod_time = [0_u8; 4];
let mut name_len = [0_u8; 4]; let mut name_len = [0_u8; 4];
let mut connection = self.get_transport_mut().get_raw_connection()?; let mut connection = self.transport.get_raw_connection()?;
connection.read_exact(&mut file_mod)?; connection.read_exact(&mut file_mod)?;
connection.read_exact(&mut file_size)?; connection.read_exact(&mut file_size)?;
connection.read_exact(&mut mod_time)?; connection.read_exact(&mut mod_time)?;

View File

@@ -51,6 +51,6 @@ impl<W: Write> Write for LogFilter<W> {
impl ADBServerDevice { impl ADBServerDevice {
/// Get logs from device /// Get logs from device
pub fn get_logs<W: Write>(&mut self, output: W) -> Result<()> { pub fn get_logs<W: Write>(&mut self, output: W) -> Result<()> {
self.shell_command(["exec logcat"], LogFilter::new(output)) self.shell_command(&["exec logcat"], &mut LogFilter::new(output))
} }
} }

View File

@@ -12,4 +12,5 @@ mod send;
mod stat; mod stat;
mod tcpip; mod tcpip;
mod transport; mod transport;
mod uninstall;
mod usb; mod usb;

View File

@@ -1,16 +1,14 @@
use crate::{ use crate::{
models::{AdbServerCommand, RebootType},
ADBServerDevice, Result, ADBServerDevice, Result,
models::{AdbServerCommand, RebootType},
}; };
impl ADBServerDevice { impl ADBServerDevice {
/// Reboots the device /// Reboots the device
pub fn reboot(&mut self, reboot_type: RebootType) -> Result<()> { pub fn reboot(&mut self, reboot_type: RebootType) -> Result<()> {
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
self.get_transport_mut() self.transport
.proxy_connection(AdbServerCommand::Reboot(reboot_type), false) .proxy_connection(AdbServerCommand::Reboot(reboot_type), false)
.map(|_| ()) .map(|_| ())
} }

View File

@@ -1,13 +1,11 @@
use crate::{models::AdbServerCommand, ADBServerDevice, Result}; use crate::{ADBServerDevice, Result, models::AdbServerCommand};
impl ADBServerDevice { impl ADBServerDevice {
/// Reconnect device /// Reconnect device
pub fn reconnect(&mut self) -> Result<()> { pub fn reconnect(&mut self) -> Result<()> {
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
self.get_transport_mut() self.transport
.proxy_connection(AdbServerCommand::Reconnect, false) .proxy_connection(AdbServerCommand::Reconnect, false)
.map(|_| ()) .map(|_| ())
} }

View File

@@ -1,7 +1,6 @@
use crate::{ use crate::{
constants, ADBServerDevice, Result, constants,
models::{AdbServerCommand, SyncCommand}, models::{AdbServerCommand, SyncCommand},
ADBServerDevice, Result,
}; };
use byteorder::{LittleEndian, ReadBytesExt}; use byteorder::{LittleEndian, ReadBytesExt};
use std::io::{BufReader, BufWriter, Read, Write}; use std::io::{BufReader, BufWriter, Read, Write};
@@ -70,18 +69,14 @@ impl<R: Read> Read for ADBRecvCommandReader<R> {
impl ADBServerDevice { impl ADBServerDevice {
/// Receives path to stream from the device. /// Receives path to stream from the device.
pub fn pull<A: AsRef<str>>(&mut self, path: A, stream: &mut dyn Write) -> Result<()> { pub fn pull(&mut self, path: &dyn AsRef<str>, stream: &mut dyn Write) -> Result<()> {
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
// Set device in SYNC mode // Set device in SYNC mode
self.get_transport_mut() self.transport.send_adb_request(AdbServerCommand::Sync)?;
.send_adb_request(AdbServerCommand::Sync)?;
// Send a recv command // Send a recv command
self.get_transport_mut() self.transport.send_sync_request(SyncCommand::Recv)?;
.send_sync_request(SyncCommand::Recv)?;
self.handle_recv_command(path, stream) self.handle_recv_command(path, stream)
} }
@@ -91,7 +86,7 @@ impl ADBServerDevice {
from: S, from: S,
output: &mut dyn Write, output: &mut dyn Write,
) -> Result<()> { ) -> Result<()> {
let mut raw_connection = self.get_transport().get_raw_connection()?; let mut raw_connection = self.transport.get_raw_connection()?;
let from_as_bytes = from.as_ref().as_bytes(); let from_as_bytes = from.as_ref().as_bytes();
let mut buffer = Vec::with_capacity(4 + from_as_bytes.len()); let mut buffer = Vec::with_capacity(4 + from_as_bytes.len());

View File

@@ -1,24 +1,20 @@
use crate::{models::AdbServerCommand, ADBServerDevice, Result}; use crate::{ADBServerDevice, Result, models::AdbServerCommand};
impl ADBServerDevice { impl ADBServerDevice {
/// Reverse socket connection /// Reverse socket connection
pub fn reverse(&mut self, remote: String, local: String) -> Result<()> { pub fn reverse(&mut self, remote: String, local: String) -> Result<()> {
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
self.get_transport_mut() self.transport
.proxy_connection(AdbServerCommand::Reverse(remote, local), false) .proxy_connection(AdbServerCommand::Reverse(remote, local), false)
.map(|_| ()) .map(|_| ())
} }
/// Remove all reverse rules /// Remove all reverse rules
pub fn reverse_remove_all(&mut self) -> Result<()> { pub fn reverse_remove_all(&mut self) -> Result<()> {
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial.clone()))?;
self.get_transport_mut() self.transport
.proxy_connection(AdbServerCommand::ReverseRemoveAll, false) .proxy_connection(AdbServerCommand::ReverseRemoveAll, false)
.map(|_| ()) .map(|_| ())
} }

View File

@@ -1,7 +1,6 @@
use crate::{ use crate::{
constants, ADBServerDevice, Result, RustADBError, constants,
models::{AdbRequestStatus, AdbServerCommand, SyncCommand}, models::{AdbRequestStatus, AdbServerCommand, SyncCommand},
ADBServerDevice, Result, RustADBError,
}; };
use std::{ use std::{
convert::TryInto, convert::TryInto,
@@ -45,17 +44,13 @@ impl ADBServerDevice {
/// Send stream to path on the device. /// Send stream to path on the device.
pub fn push<R: Read, A: AsRef<str>>(&mut self, stream: R, path: A) -> Result<()> { pub fn push<R: Read, A: AsRef<str>>(&mut self, stream: R, path: A) -> Result<()> {
log::info!("Sending data to {}", path.as_ref()); log::info!("Sending data to {}", path.as_ref());
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
// Set device in SYNC mode // Set device in SYNC mode
self.get_transport_mut() self.transport.send_adb_request(AdbServerCommand::Sync)?;
.send_adb_request(AdbServerCommand::Sync)?;
// Send a send command // Send a send command
self.get_transport_mut() self.transport.send_sync_request(SyncCommand::Send)?;
.send_sync_request(SyncCommand::Send)?;
self.handle_send_command(stream, path) self.handle_send_command(stream, path)
} }
@@ -64,7 +59,7 @@ impl ADBServerDevice {
// Append the permission flags to the filename // Append the permission flags to the filename
let to = to.as_ref().to_string() + ",0777"; let to = to.as_ref().to_string() + ",0777";
let mut raw_connection = self.get_transport_mut().get_raw_connection()?; let mut raw_connection = self.transport.get_raw_connection()?;
// The name of the command is already sent by get_transport()?.send_sync_request // The name of the command is already sent by get_transport()?.send_sync_request
let to_as_bytes = to.as_bytes(); let to_as_bytes = to.as_bytes();
@@ -99,7 +94,7 @@ impl ADBServerDevice {
match AdbRequestStatus::from_str(str::from_utf8(&request_status)?)? { match AdbRequestStatus::from_str(str::from_utf8(&request_status)?)? {
AdbRequestStatus::Fail => { AdbRequestStatus::Fail => {
// We can keep reading to get further details // We can keep reading to get further details
let length = self.get_transport_mut().get_body_length()?; let length = self.transport.get_body_length()?;
let mut body = vec![ let mut body = vec![
0; 0;
@@ -108,9 +103,7 @@ impl ADBServerDevice {
.map_err(|_| RustADBError::ConversionError)? .map_err(|_| RustADBError::ConversionError)?
]; ];
if length > 0 { if length > 0 {
self.get_transport() self.transport.get_raw_connection()?.read_exact(&mut body)?;
.get_raw_connection()?
.read_exact(&mut body)?;
} }
Err(RustADBError::ADBRequestFailed(String::from_utf8(body)?)) Err(RustADBError::ADBRequestFailed(String::from_utf8(body)?))

View File

@@ -3,8 +3,8 @@ use std::io::{Read, Write};
use byteorder::{ByteOrder, LittleEndian}; use byteorder::{ByteOrder, LittleEndian};
use crate::{ use crate::{
models::{AdbServerCommand, AdbStatResponse, SyncCommand},
ADBServerDevice, Result, RustADBError, ADBServerDevice, Result, RustADBError,
models::{AdbServerCommand, AdbStatResponse, SyncCommand},
}; };
impl ADBServerDevice { impl ADBServerDevice {
@@ -13,24 +13,20 @@ impl ADBServerDevice {
LittleEndian::write_u32(&mut len_buf, path.as_ref().len() as u32); LittleEndian::write_u32(&mut len_buf, path.as_ref().len() as u32);
// 4 bytes of command name is already sent by send_sync_request // 4 bytes of command name is already sent by send_sync_request
self.get_transport_mut() self.transport.get_raw_connection()?.write_all(&len_buf)?;
.get_raw_connection()? self.transport
.write_all(&len_buf)?;
self.get_transport_mut()
.get_raw_connection()? .get_raw_connection()?
.write_all(path.as_ref().to_string().as_bytes())?; .write_all(path.as_ref().to_string().as_bytes())?;
// Reads returned status code from ADB server // Reads returned status code from ADB server
let mut response = [0_u8; 4]; let mut response = [0_u8; 4];
self.get_transport_mut() self.transport
.get_raw_connection()? .get_raw_connection()?
.read_exact(&mut response)?; .read_exact(&mut response)?;
match std::str::from_utf8(response.as_ref())? { match std::str::from_utf8(response.as_ref())? {
"STAT" => { "STAT" => {
let mut data = [0_u8; 12]; let mut data = [0_u8; 12];
self.get_transport_mut() self.transport.get_raw_connection()?.read_exact(&mut data)?;
.get_raw_connection()?
.read_exact(&mut data)?;
Ok(data.into()) Ok(data.into())
} }
@@ -43,17 +39,13 @@ impl ADBServerDevice {
/// Stat file given as path on the device. /// Stat file given as path on the device.
pub fn stat<A: AsRef<str>>(&mut self, path: A) -> Result<AdbStatResponse> { pub fn stat<A: AsRef<str>>(&mut self, path: A) -> Result<AdbStatResponse> {
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
// Set device in SYNC mode // Set device in SYNC mode
self.get_transport_mut() self.transport.send_adb_request(AdbServerCommand::Sync)?;
.send_adb_request(AdbServerCommand::Sync)?;
// Send a "Stat" command // Send a "Stat" command
self.get_transport_mut() self.transport.send_sync_request(SyncCommand::Stat)?;
.send_sync_request(SyncCommand::Stat)?;
self.handle_stat_command(path) self.handle_stat_command(path)
} }

View File

@@ -1,13 +1,11 @@
use crate::{models::AdbServerCommand, ADBServerDevice, Result}; use crate::{ADBServerDevice, Result, models::AdbServerCommand};
impl ADBServerDevice { impl ADBServerDevice {
/// Set adb daemon to tcp/ip mode /// Set adb daemon to tcp/ip mode
pub fn tcpip(&mut self, port: u16) -> Result<()> { pub fn tcpip(&mut self, port: u16) -> Result<()> {
let serial = self.identifier.clone(); self.set_serial_transport()?;
self.connect()?
.send_adb_request(AdbServerCommand::TransportSerial(serial))?;
self.get_transport_mut() self.transport
.proxy_connection(AdbServerCommand::TcpIp(port), false) .proxy_connection(AdbServerCommand::TcpIp(port), false)
.map(|_| ()) .map(|_| ())
} }

View File

@@ -1,4 +1,4 @@
use crate::{models::AdbServerCommand, ADBServerDevice, Result}; use crate::{ADBServerDevice, Result, models::AdbServerCommand};
impl ADBServerDevice { impl ADBServerDevice {
/// Asks ADB server to switch the connection to either the device or emulator connect to/running on the host. Will fail if there is more than one such device/emulator available. /// Asks ADB server to switch the connection to either the device or emulator connect to/running on the host. Will fail if there is more than one such device/emulator available.

Some files were not shown because too many files have changed in this diff Show More