1 Commits

Author SHA1 Message Date
LIAUD Corentin
4126c856d9 wip: feature-based 2025-08-17 10:46:40 +02:00
124 changed files with 848 additions and 1427 deletions

View File

@@ -35,4 +35,4 @@ jobs:
with: with:
files: | files: |
target/wheels/pyadb_client*.whl target/wheels/pyadb_client*.whl
target/wheels/pyadb_client*.tar.gz target/wheels/pyadb_client*.tar.gz

View File

@@ -18,12 +18,6 @@ jobs:
os: [ubuntu-latest, windows-latest, macos-latest] os: [ubuntu-latest, windows-latest, macos-latest]
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: Build project
- name: Set up Python run: cargo build --release --all-features
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Build project
run: cargo build --release --features rusb,mdns

View File

@@ -17,7 +17,7 @@ jobs:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- run: rustup component add clippy - run: rustup component add clippy
- name: Run clippy - name: Run clippy
run: cargo clippy --features rusb,mdns run: cargo clippy --all-features
fmt: fmt:
name: "fmt" name: "fmt"
@@ -33,7 +33,7 @@ jobs:
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: Run doc - name: Run doc
run: cargo doc --features rusb,mdns --no-deps run: cargo doc --all-features --no-deps
env: env:
RUSTDOCFLAGS: "-D warnings" RUSTDOCFLAGS: "-D warnings"
@@ -43,4 +43,4 @@ jobs:
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: Run tests - name: Run tests
run: cargo test --verbose --features rusb,mdns run: cargo test --verbose --all-features

View File

@@ -36,7 +36,7 @@ jobs:
CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }} CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
- name: Build release - name: Build release
run: cargo build -p adb_cli --release run: cargo build --all-features --release
- name: Rename binary - name: Rename binary
run: mv target/release/adb_cli target/release/adb_cli-linux run: mv target/release/adb_cli target/release/adb_cli-linux
@@ -69,7 +69,7 @@ jobs:
override: true override: true
- name: Build release - name: Build release
run: cargo build -p adb_cli --release run: cargo build --all-features --release
- name: Rename binary - name: Rename binary
run: mv target/release/adb_cli target/release/adb_cli-macos run: mv target/release/adb_cli target/release/adb_cli-macos
@@ -92,13 +92,8 @@ jobs:
toolchain: stable toolchain: stable
override: true override: true
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Build release - name: Build release
run: cargo build -p adb_cli --release run: cargo build --all-features --release
- name: Rename binary - name: Rename binary
run: Rename-Item -Path target/release/adb_cli.exe -NewName adb_cli-windows.exe run: Rename-Item -Path target/release/adb_cli.exe -NewName adb_cli-windows.exe

2
.gitignore vendored
View File

@@ -3,4 +3,4 @@ target
/.vscode /.vscode
venv venv
/.mypy_cache /.mypy_cache
pyadb_client/pyadb_client.pyi pyadb_client/pyadb_client.pyi

View File

@@ -1,5 +1,5 @@
[workspace] [workspace]
members = ["adb_cli", "adb_client", "examples/mdns", "pyadb_client"] members = ["adb_cli", "adb_client", "pyadb_client"]
resolver = "2" resolver = "2"
[workspace.package] [workspace.package]
@@ -9,7 +9,7 @@ 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.1.18" version = "2.1.16"
rust-version = "1.85.1" rust-version = "1.85.1"
# To build locally when working on a new release # To build locally when working on a new release

View File

@@ -49,12 +49,6 @@ 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).
## examples
Some examples are available in the `examples` directory:
- `examples/mdns`: mDNS device discovery example
## pyadb_client ## pyadb_client
Python wrapper using `adb_client` library to export classes usable directly from a Python environment. Python wrapper using `adb_client` library to export classes usable directly from a Python environment.

View File

@@ -11,11 +11,11 @@ rust-version.workspace = true
version.workspace = true version.workspace = true
[dependencies] [dependencies]
adb_client = { version = "^2.1.17", features = ["mdns", "rusb"] } adb_client = { version = "^2.0.0" }
anyhow = { version = "1.0.100" } anyhow = { version = "1.0.94" }
clap = { version = "4.5.51", features = ["derive"] } clap = { version = "4.5.23", features = ["derive"] }
env_logger = { version = "0.11.8" } env_logger = { version = "0.11.5" }
log = { version = "0.4.28" } 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

@@ -13,7 +13,7 @@ pub struct ADBTermios {
} }
impl ADBTermios { impl ADBTermios {
pub fn new(fd: &impl AsRawFd) -> Result<Self> { pub fn new(fd: impl AsRawFd) -> Result<Self> {
let mut new_termios = Termios::from_fd(fd.as_raw_fd())?; let mut new_termios = Termios::from_fd(fd.as_raw_fd())?;
let old_termios = new_termios; // Saves previous state let old_termios = new_termios; // Saves previous state
new_termios.c_lflag = 0; new_termios.c_lflag = 0;
@@ -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 dropping ADBTermios: {e}"); log::error!("Error while dropping ADBTermios: {e}")
} }
} }
} }

View File

@@ -1,4 +1,4 @@
use adb_client::emulator::ADBEmulatorDevice; use adb_client::ADBEmulatorDevice;
use crate::models::{EmuCommand, EmulatorCommand}; use crate::models::{EmuCommand, EmulatorCommand};

View File

@@ -1,7 +1,4 @@
use adb_client::{ use adb_client::{ADBServer, DeviceShort, MDNSBackend, Result, WaitForDeviceState};
Result,
server::{ADBServer, DeviceShort, MDNSBackend, WaitForDeviceState},
};
use crate::models::{HostCommand, MdnsCommand, ServerCommand}; use crate::models::{HostCommand, MdnsCommand, ServerCommand};
@@ -56,15 +53,12 @@ pub fn handle_host_commands(server_command: ServerCommand<HostCommand>) -> Resul
let server_status = adb_server.server_status()?; let server_status = adb_server.server_status()?;
match server_status.mdns_backend { match server_status.mdns_backend {
MDNSBackend::Unknown => log::info!("unknown mdns backend..."), MDNSBackend::Unknown => log::info!("unknown mdns backend..."),
MDNSBackend::Bonjour => { MDNSBackend::Bonjour => match check {
if check { true => log::info!("mdns daemon version [Bonjour]"),
log::info!("mdns daemon version [Bonjour]"); false => log::info!("ERROR: mdns daemon unavailable"),
} else { },
log::info!("ERROR: mdns daemon unavailable");
}
}
MDNSBackend::OpenScreen => { MDNSBackend::OpenScreen => {
log::info!("mdns daemon version [Openscreen discovery 0.0.0]"); log::info!("mdns daemon version [Openscreen discovery 0.0.0]")
} }
} }
} }

View File

@@ -1,6 +1,6 @@
use std::{fs::File, io::Write}; use std::{fs::File, io::Write};
use adb_client::server_device::ADBServerDevice; use adb_client::ADBServerDevice;
use anyhow::{Result, anyhow}; use anyhow::{Result, anyhow};
use crate::models::LocalDeviceCommand; use crate::models::LocalDeviceCommand;
@@ -14,7 +14,7 @@ pub fn handle_local_commands(
let features = device let features = device
.host_features()? .host_features()?
.iter() .iter()
.map(ToString::to_string) .map(|v| v.to_string())
.reduce(|a, b| format!("{a},{b}")) .reduce(|a, b| format!("{a},{b}"))
.ok_or(anyhow!("cannot list features"))?; .ok_or(anyhow!("cannot list features"))?;
log::info!("Available host features: {features}"); log::info!("Available host features: {features}");

View File

@@ -7,12 +7,9 @@ mod handlers;
mod models; mod models;
mod utils; mod utils;
use adb_client::ADBDeviceExt; use adb_client::{
use adb_client::mdns::MDNSDiscoveryService; ADBDeviceExt, ADBServer, ADBServerDevice, ADBTcpDevice, ADBUSBDevice, MDNSDiscoveryService,
use adb_client::server::ADBServer; };
use adb_client::server_device::ADBServerDevice;
use adb_client::tcp::ADBTcpDevice;
use adb_client::usb::ADBRusbDevice;
#[cfg(any(target_os = "linux", target_os = "macos"))] #[cfg(any(target_os = "linux", target_os = "macos"))]
use adb_termios::ADBTermios; use adb_termios::ADBTermios;
@@ -66,12 +63,12 @@ fn main() -> Result<()> {
MainCommand::Usb(usb_command) => { MainCommand::Usb(usb_command) => {
let device = match (usb_command.vendor_id, usb_command.product_id) { let device = match (usb_command.vendor_id, usb_command.product_id) {
(Some(vid), Some(pid)) => match usb_command.path_to_private_key { (Some(vid), Some(pid)) => match usb_command.path_to_private_key {
Some(pk) => ADBRusbDevice::new_with_custom_private_key(vid, pid, pk)?, Some(pk) => ADBUSBDevice::new_with_custom_private_key(vid, pid, pk)?,
None => ADBRusbDevice::new(vid, pid)?, None => ADBUSBDevice::new(vid, pid)?,
}, },
(None, None) => match usb_command.path_to_private_key { (None, None) => match usb_command.path_to_private_key {
Some(pk) => ADBRusbDevice::autodetect_with_custom_private_key(pk)?, Some(pk) => ADBUSBDevice::autodetect_with_custom_private_key(pk)?,
None => ADBRusbDevice::autodetect()?, None => ADBUSBDevice::autodetect()?,
}, },
_ => { _ => {
anyhow::bail!( anyhow::bail!(
@@ -82,10 +79,7 @@ fn main() -> Result<()> {
(device.boxed(), usb_command.commands) (device.boxed(), usb_command.commands)
} }
MainCommand::Tcp(tcp_command) => { MainCommand::Tcp(tcp_command) => {
let device = match tcp_command.path_to_private_key { let device = ADBTcpDevice::new(tcp_command.address)?;
Some(pk) => ADBTcpDevice::new_with_custom_private_key(tcp_command.address, pk)?,
None => ADBTcpDevice::new(tcp_command.address)?,
};
(device.boxed(), tcp_command.commands) (device.boxed(), tcp_command.commands)
} }
MainCommand::Mdns => { MainCommand::Mdns => {
@@ -100,7 +94,7 @@ fn main() -> Result<()> {
"Found device {} with addresses {:?}", "Found device {} with addresses {:?}",
device.fullname, device.fullname,
device.addresses device.addresses
); )
} }
return Ok(service.shutdown()?); return Ok(service.shutdown()?);
@@ -114,7 +108,7 @@ fn main() -> Result<()> {
// Using a scope here would call drop() too early.. // Using a scope here would call drop() too early..
#[cfg(any(target_os = "linux", target_os = "macos"))] #[cfg(any(target_os = "linux", target_os = "macos"))]
{ {
let mut adb_termios = ADBTermios::new(&std::io::stdin())?; let mut adb_termios = ADBTermios::new(std::io::stdin())?;
adb_termios.set_adb_termios()?; adb_termios.set_adb_termios()?;
device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()))?; device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()))?;
} }
@@ -124,7 +118,7 @@ fn main() -> Result<()> {
device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()))?; device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()))?;
} }
} else { } else {
let commands: Vec<&str> = commands.iter().map(String::as_str).collect(); let commands: Vec<&str> = commands.iter().map(|v| v.as_str()).collect();
device.shell_command(&commands, &mut std::io::stdout())?; device.shell_command(&commands, &mut std::io::stdout())?;
} }
} }
@@ -142,7 +136,7 @@ fn main() -> Result<()> {
} }
DeviceCommands::Reboot { reboot_type } => { DeviceCommands::Reboot { reboot_type } => {
log::info!("Reboots device in mode {reboot_type:?}"); log::info!("Reboots device in mode {reboot_type:?}");
device.reboot(reboot_type.into())?; device.reboot(reboot_type.into())?
} }
DeviceCommands::Push { filename, path } => { DeviceCommands::Push { filename, path } => {
let mut input = File::open(Path::new(&filename))?; let mut input = File::open(Path::new(&filename))?;

View File

@@ -19,7 +19,7 @@ pub enum DeviceCommands {
/// The package whose activity is to be invoked /// The package whose activity is to be invoked
#[clap(short = 'p', long = "package")] #[clap(short = 'p', long = "package")]
package: String, package: String,
/// The activity to be invoked itself, Usually it is `MainActivity` /// The activity to be invoked itself, Usually it is MainActivity
#[clap(short = 'a', long = "activity")] #[clap(short = 'a', long = "activity")]
activity: String, activity: String,
}, },

View File

@@ -1,6 +1,6 @@
use std::net::SocketAddrV4; use std::net::SocketAddrV4;
use adb_client::{RustADBError, server::WaitForDeviceTransport}; use adb_client::{RustADBError, WaitForDeviceTransport};
use clap::Parser; use clap::Parser;
fn parse_wait_for_device_device_transport( fn parse_wait_for_device_device_transport(

View File

@@ -1,15 +1,11 @@
use clap::Parser; use clap::Parser;
use std::net::SocketAddr; use std::net::SocketAddr;
use std::path::PathBuf;
use super::DeviceCommands; use super::DeviceCommands;
#[derive(Parser, Debug)] #[derive(Parser, Debug)]
pub struct TcpCommand { pub struct TcpCommand {
pub address: SocketAddr, pub address: SocketAddr,
/// 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)] #[clap(subcommand)]
pub commands: DeviceCommands, pub commands: DeviceCommands,
} }

View File

@@ -5,7 +5,10 @@
pub unsafe fn setup_logger(debug: bool) { pub unsafe fn setup_logger(debug: bool) {
// RUST_LOG variable has more priority then "--debug" flag // RUST_LOG variable has more priority then "--debug" flag
if std::env::var("RUST_LOG").is_err() { if std::env::var("RUST_LOG").is_err() {
let level = if debug { "trace" } else { "info" }; let level = match debug {
true => "trace",
false => "info",
};
unsafe { std::env::set_var("RUST_LOG", level) }; unsafe { std::env::set_var("RUST_LOG", level) };
} }

View File

@@ -10,60 +10,44 @@ repository.workspace = true
rust-version.workspace = true rust-version.workspace = true
version.workspace = true version.workspace = true
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[features] [features]
default = [] default = ["mdns"]
mdns = ["dep:mdns-sd"] mdns = ["dep:mdns-sd"]
rusb = ["dep:rsa", "dep:rusb"]
webusb = ["dep:webusb-web", "dep:rsa"]
[dependencies] [dependencies]
base64 = { version = "0.22.1" } base64 = { version = "0.22.1" }
bincode = { version = "2.0.1", features = ["serde"] } bincode = { version = "1.3.3" }
byteorder = { version = "1.5.0" } byteorder = { version = "1.5.0" }
chrono = { version = "0.4.42", default-features = false, features = ["std"] } chrono = { version = "0.4.40", default-features = false, features = ["std"] }
image = { version = "0.25.8", default-features = false } homedir = { version = "= 0.3.4" }
log = { version = "0.4.28" } image = { version = "0.25.5", default-features = false }
log = { version = "0.4.26" }
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.2", default-features = false, features = [ rcgen = { version = "0.13.1", default-features = false, features = [
"aws_lc_rs",
"pem", "pem",
"ring"
] } ] }
regex = { version = "1.12.2", features = ["perf", "std", "unicode"] } regex = { version = "1.11.1", features = ["perf", "std", "unicode"] }
rustls = { version = "0.23.33", default-features = false, features = ["logging", "ring", "std", "tls12"] } rsa = { version = "0.9.7" }
rustls-pki-types = { version = "1.12.0", features = ["web"] } rusb = { version = "0.9.4", features = ["vendored"] }
serde = { version = "1.0.228", features = ["derive"] } rustls = { version = "0.23.27" }
serde_repr = { version = "0.1.20" } rustls-pki-types = { version = "1.11.0" }
serde = { version = "1.0.216", features = ["derive"] }
serde_repr = { version = "0.1.19" }
sha1 = { version = "0.10.6", features = ["oid"] } sha1 = { version = "0.10.6", features = ["oid"] }
thiserror = { version = "2.0.17" } thiserror = { version = "2.0.7" }
######### # MDNS
# MDNS dependencies mdns-sd = { version = "0.13.9", default-features = false, optional = true, features = [
mdns-sd = { version = "0.17.0", default-features = false, features = [
"logging", "logging",
], optional = true } ] }
#########
#########
# USB-only dependencies
rsa = { version = "0.9.7", optional = true }
rusb = { version = "0.9.4", features = ["vendored"], optional = true }
#########
#########
# webusb dependencies
webusb-web = { version = "0.4.1", optional = true }
getrandom = { version = "0.2.16", features = ["js"], optional = true }
ring = { version = "0.17.14", features = ["wasm32_unknown_unknown_js"], optional = true }
[dev-dependencies] [dev-dependencies]
anyhow = { version = "1.0.100" } anyhow = { version = "1.0.93" }
criterion = { version = "0.7.0" } # Used for benchmarks criterion = { version = "0.6.0" } # Used for benchmarks
[[bench]] [[bench]]
harness = false harness = false

View File

@@ -16,26 +16,6 @@ Add `adb_client` crate as a dependency by simply adding it to your `Cargo.toml`:
adb_client = "*" adb_client = "*"
``` ```
## Crate features
| Feature | Description | Default? |
| :-----: | :---------------------------------------------: | :------: |
| `mdns` | Enables mDNS device discovery on local network. | No |
| `rusb` | Enables interactions with USB devices. | No |
To deactivate some features you can use the `default-features = false` option in your `Cargo.toml` file and manually specify the features you want to activate:
```toml
[dependencies]
adb_client = { version = "*" }
```
## Examples
Usage examples can be found in the `examples/` directory of this repository.
Some example are also provided in the various `README.md` files of modules.
## Benchmarks ## Benchmarks
Benchmarks run on `v2.0.6`, on a **Samsung S10 SM-G973F** device and an **Intel i7-1265U** CPU laptop Benchmarks run on `v2.0.6`, on a **Samsung S10 SM-G973F** device and an **Intel i7-1265U** CPU laptop
@@ -44,8 +24,89 @@ Benchmarks run on `v2.0.6`, on a **Samsung S10 SM-G973F** device and an **Intel
`ADBServerDevice` performs all operations by using adb server as a bridge. `ADBServerDevice` performs all operations by using adb server as a bridge.
| File size | Sample size | `ADBServerDevice` | `adb` | Difference | |File size|Sample size|`ADBServerDevice`|`adb`|Difference|
| :-------: | :---------: | :---------------: | :-------: | :------------------------------------: | |:-------:|:---------:|:----------:|:---:|:-----:|
| 10 MB | 100 | 350,79 ms | 356,30 ms | <div style="color:green">-1,57 %</div> | |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> | |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> | |1 GB|20|31,09 s|31,12 s|<div style="color:green">-0,10 %</div>|
## Examples
### Get available ADB devices
```rust no_run
use adb_client::ADBServer;
use std::net::{SocketAddrV4, Ipv4Addr};
// A custom server address can be provided
let server_ip = Ipv4Addr::new(127, 0, 0, 1);
let server_port = 5037;
let mut server = ADBServer::new(SocketAddrV4::new(server_ip, server_port));
server.devices();
```
### Using ADB server as bridge
#### Launch a command on device
```rust no_run
use adb_client::{ADBServer, ADBDeviceExt};
let mut server = ADBServer::default();
let mut device = server.get_device().expect("cannot get device");
device.shell_command(&["df", "-h"], &mut std::io::stdout());
```
#### Push a file to the device
```rust no_run
use adb_client::ADBServer;
use std::net::Ipv4Addr;
use std::fs::File;
use std::path::Path;
let mut server = ADBServer::default();
let mut device = server.get_device().expect("cannot get device");
let mut input = File::open(Path::new("/tmp/f")).expect("Cannot open file");
device.push(&mut input, "/data/local/tmp");
```
### Interact directly with end devices
#### (USB) Launch a command on device
```rust no_run
use adb_client::{ADBUSBDevice, ADBDeviceExt};
let vendor_id = 0x04e8;
let product_id = 0x6860;
let mut device = ADBUSBDevice::new(vendor_id, product_id).expect("cannot find device");
device.shell_command(&["df", "-h"], &mut std::io::stdout());
```
#### (USB) Push a file to the device
```rust no_run
use adb_client::{ADBUSBDevice, ADBDeviceExt};
use std::fs::File;
use std::path::Path;
let vendor_id = 0x04e8;
let product_id = 0x6860;
let mut device = ADBUSBDevice::new(vendor_id, product_id).expect("cannot find device");
let mut input = File::open(Path::new("/tmp/f")).expect("Cannot open file");
device.push(&mut input, &"/data/local/tmp");
```
#### (TCP) Get a shell from device
```rust no_run
use std::net::{SocketAddr, IpAddr, Ipv4Addr};
use adb_client::{ADBTcpDevice, ADBDeviceExt};
let device_ip = IpAddr::V4(Ipv4Addr::new(192, 168, 0, 10));
let device_port = 43210;
let mut device = ADBTcpDevice::new(SocketAddr::new(device_ip, device_port)).expect("cannot find device");
device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()));
```

View File

@@ -6,17 +6,14 @@ 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 an ADB device, currently used by: /// Trait representing all features available on both [`crate::ADBServerDevice`] and [`crate::ADBUSBDevice`]
/// - [`crate::server_device::ADBServerDevice`]
/// - [`crate::usb::ADBRusbDevice`]
/// - [`crate::tcp::ADBTcpDevice`]
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(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()>; fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> 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.
fn shell(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()>; fn shell(&mut self, reader: &mut dyn Read, writer: Box<(dyn Write + Send)>) -> 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>;

View File

@@ -0,0 +1 @@
pub const BUFFER_SIZE: usize = 65536;

View File

@@ -1,30 +1,10 @@
use crate::message_devices::adb_message_transport::ADBMessageTransport; use byteorder::{LittleEndian, ReadBytesExt};
use crate::message_devices::adb_rsa_key::ADBRsaKey; use rand::Rng;
use crate::message_devices::adb_transport_message::ADBTransportMessage;
use crate::message_devices::message_commands::{MessageCommand, MessageSubcommand};
use crate::message_devices::{AUTH_RSAPUBLICKEY, AUTH_SIGNATURE};
use crate::{AUTH_TOKEN, AdbStatResponse, Result, RustADBError};
use bincode::config::{Configuration, Fixint, LittleEndian, NoLimit};
use byteorder::ReadBytesExt;
use serde::Serialize;
use serde::de::DeserializeOwned;
use std::io::{Cursor, Read, Seek}; use std::io::{Cursor, Read, Seek};
use std::time::Duration;
const BUFFER_SIZE: usize = 65535; use crate::{ADBMessageTransport, AdbStatResponse, Result, RustADBError, constants::BUFFER_SIZE};
const BINCODE_CONFIG: Configuration<LittleEndian, Fixint, NoLimit> = bincode::config::legacy(); use super::{ADBTransportMessage, MessageCommand, models::MessageSubcommand};
pub(crate) fn bincode_serialize_to_vec<E: Serialize>(val: E) -> Result<Vec<u8>> {
bincode::serde::encode_to_vec(val, BINCODE_CONFIG).map_err(|_e| RustADBError::ConversionError)
}
pub(crate) fn bincode_deserialize_from_slice<D: DeserializeOwned>(data: &[u8]) -> Result<D> {
let (response, _) = bincode::serde::decode_from_slice(data, BINCODE_CONFIG)
.map_err(|_e| RustADBError::ConversionError)?;
Ok(response)
}
/// 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.
@@ -53,66 +33,6 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
&mut self.transport &mut self.transport
} }
pub(crate) fn auth_handshake(
&mut self,
message: ADBTransportMessage,
private_key: &ADBRsaKey,
) -> Result<()> {
match message.header().command() {
MessageCommand::Auth => {
log::debug!("Authentication required");
}
_ => return Ok(()),
}
// At this point, we should have received an AUTH message with arg0 == 1
let auth_message = match message.header().arg0() {
AUTH_TOKEN => message,
v => {
return Err(RustADBError::ADBRequestFailed(format!(
"Received AUTH message with type != 1 ({v})"
)));
}
};
let sign = private_key.sign(auth_message.into_payload())?;
let message = ADBTransportMessage::new(MessageCommand::Auth, AUTH_SIGNATURE, 0, &sign);
self.get_transport_mut().write_message(message)?;
let received_response = self.get_transport_mut().read_message()?;
if received_response.header().command() == MessageCommand::Cnxn {
log::info!(
"Authentication OK, device info {}",
String::from_utf8(received_response.into_payload())?
);
return Ok(());
}
let mut pubkey = private_key.android_pubkey_encode()?.into_bytes();
pubkey.push(b'\0');
let message = ADBTransportMessage::new(MessageCommand::Auth, AUTH_RSAPUBLICKEY, 0, &pubkey);
self.get_transport_mut().write_message(message)?;
let response = self
.get_transport_mut()
.read_message_with_timeout(Duration::from_secs(10))
.and_then(|message| {
message.assert_command(MessageCommand::Cnxn)?;
Ok(message)
})?;
log::info!(
"Authentication OK, device info {}",
String::from_utf8(response.into_payload())?
);
Ok(())
}
/// 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(&mut self) -> Result<ADBTransportMessage> { pub(crate) fn recv_and_reply_okay(&mut self) -> Result<ADBTransportMessage> {
let message = self.transport.read_message()?; let message = self.transport.read_message()?;
@@ -150,7 +70,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
match len.take() { match len.take() {
Some(0) | None => { Some(0) | None => {
rdr.seek_relative(4)?; rdr.seek_relative(4)?;
len.replace(u64::from(rdr.read_u32::<byteorder::LittleEndian>()?)); len.replace(rdr.read_u32::<LittleEndian>()? as u64);
} }
Some(length) => { Some(length) => {
let remaining_bytes = payload.len() as u64 - rdr.position(); let remaining_bytes = payload.len() as u64 - rdr.position();
@@ -166,7 +86,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
} }
} }
if Cursor::new(&payload[(payload.len() - 8)..(payload.len() - 4)]) if Cursor::new(&payload[(payload.len() - 8)..(payload.len() - 4)])
.read_u32::<byteorder::LittleEndian>()? .read_u32::<LittleEndian>()?
== MessageSubcommand::Done as u32 == MessageSubcommand::Done as u32
{ {
break; break;
@@ -181,11 +101,12 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
remote_id: u32, remote_id: u32,
mut reader: R, mut reader: R,
) -> std::result::Result<(), RustADBError> { ) -> std::result::Result<(), RustADBError> {
let mut buffer = vec![0; BUFFER_SIZE].into_boxed_slice(); let mut buffer = [0; BUFFER_SIZE];
let amount_read = reader.read(&mut buffer)?; let amount_read = reader.read(&mut buffer)?;
let subcommand_data = MessageSubcommand::Data.with_arg(u32::try_from(amount_read)?); let subcommand_data = MessageSubcommand::Data.with_arg(amount_read as u32);
let mut serialized_message = bincode_serialize_to_vec(&subcommand_data)?; let mut serialized_message =
bincode::serialize(&subcommand_data).map_err(|_e| RustADBError::ConversionError)?;
serialized_message.append(&mut buffer[..amount_read].to_vec()); serialized_message.append(&mut buffer[..amount_read].to_vec());
let message = ADBTransportMessage::new( let message = ADBTransportMessage::new(
@@ -198,14 +119,16 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
self.send_and_expect_okay(message)?; self.send_and_expect_okay(message)?;
loop { loop {
let mut buffer = vec![0; BUFFER_SIZE].into_boxed_slice(); let mut buffer = [0; BUFFER_SIZE];
match reader.read(&mut buffer) { match reader.read(&mut buffer) {
Ok(0) => { Ok(0) => {
// Currently file mtime is not forwarded // Currently file mtime is not forwarded
let subcommand_data = MessageSubcommand::Done.with_arg(0); let subcommand_data = MessageSubcommand::Done.with_arg(0);
let serialized_message = bincode_serialize_to_vec(&subcommand_data)?; let serialized_message = bincode::serialize(&subcommand_data)
.map_err(|_e| RustADBError::ConversionError)?;
let message = ADBTransportMessage::new( let message = ADBTransportMessage::new(
MessageCommand::Write, MessageCommand::Write,
local_id, local_id,
@@ -227,9 +150,10 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
} }
} }
Ok(size) => { Ok(size) => {
let subcommand_data = MessageSubcommand::Data.with_arg(u32::try_from(size)?); let subcommand_data = MessageSubcommand::Data.with_arg(size as u32);
let mut serialized_message = bincode_serialize_to_vec(&subcommand_data)?; let mut serialized_message = bincode::serialize(&subcommand_data)
.map_err(|_e| RustADBError::ConversionError)?;
serialized_message.append(&mut buffer[..size].to_vec()); serialized_message.append(&mut buffer[..size].to_vec());
let message = ADBTransportMessage::new( let message = ADBTransportMessage::new(
@@ -254,12 +178,12 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
} }
pub(crate) fn stat_with_explicit_ids(&mut self, remote_path: &str) -> Result<AdbStatResponse> { pub(crate) fn stat_with_explicit_ids(&mut self, remote_path: &str) -> Result<AdbStatResponse> {
let stat_buffer = MessageSubcommand::Stat.with_arg(u32::try_from(remote_path.len())?); let stat_buffer = MessageSubcommand::Stat.with_arg(remote_path.len() as u32);
let message = ADBTransportMessage::new( let message = ADBTransportMessage::new(
MessageCommand::Write, MessageCommand::Write,
self.get_local_id()?, self.get_local_id()?,
self.get_remote_id()?, self.get_remote_id()?,
&bincode_serialize_to_vec(&stat_buffer)?, &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(
@@ -271,8 +195,8 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
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".
// Interesting part starts right after // Interesting part starts right after
bincode::deserialize(&response.into_payload()[4..])
bincode_deserialize_from_slice(&response.into_payload()[4..]) .map_err(|_e| RustADBError::ConversionError)
} }
pub(crate) fn end_transaction(&mut self) -> Result<()> { pub(crate) fn end_transaction(&mut self) -> Result<()> {
@@ -281,16 +205,18 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
MessageCommand::Write, MessageCommand::Write,
self.get_local_id()?, self.get_local_id()?,
self.get_remote_id()?, self.get_remote_id()?,
&bincode_serialize_to_vec(&quit_buffer)?, &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> { pub(crate) fn open_session(&mut self, data: &[u8]) -> Result<ADBTransportMessage> {
let mut rng = rand::rng();
let message = ADBTransportMessage::new( let message = ADBTransportMessage::new(
MessageCommand::Open, MessageCommand::Open,
rand::random::<u32>(), // Our 'local-id' rng.random(), // Our 'local-id'
0, 0,
data, data,
); );

View File

@@ -1,21 +1,17 @@
use crate::{ use crate::{ADBDeviceExt, ADBMessageTransport, RebootType, Result, models::AdbStatResponse};
ADBDeviceExt, RebootType, Result,
message_devices::{
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
},
models::AdbStatResponse,
};
use std::{ use std::{
io::{Read, Write}, io::{Read, Write},
path::Path, path::Path,
}; };
use super::ADBMessageDevice;
impl<T: ADBMessageTransport> ADBDeviceExt for ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBDeviceExt for ADBMessageDevice<T> {
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> { fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
self.shell_command(command, output) self.shell_command(command, output)
} }
fn shell(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()> { fn shell(&mut self, reader: &mut dyn Read, writer: Box<(dyn Write + Send)>) -> Result<()> {
self.shell(reader, writer) self.shell(reader, writer)
} }

View File

@@ -1,47 +1,22 @@
use std::io::Write; use std::io::Write;
use std::path::{Path, PathBuf}; use std::path::Path;
use std::{io::Read, net::SocketAddr}; use std::{io::Read, net::SocketAddr};
use crate::message_devices::adb_message_device::ADBMessageDevice; use super::ADBTransportMessage;
use crate::message_devices::adb_message_transport::ADBMessageTransport; use super::adb_message_device::ADBMessageDevice;
use crate::message_devices::adb_rsa_key::ADBRsaKey; use super::models::MessageCommand;
use crate::message_devices::adb_transport_message::ADBTransportMessage; use crate::{ADBDeviceExt, ADBMessageTransport, ADBTransport, Result, TcpTransport};
use crate::message_devices::message_commands::MessageCommand;
use crate::tcp::tcp_transport::TcpTransport;
use crate::usb::read_adb_private_key;
use crate::utils::get_default_adb_key_path;
use crate::{ADBDeviceExt, ADBTransport, Result};
/// Represent a device reached and available over USB. /// Represent a device reached and available over USB.
#[derive(Debug)] #[derive(Debug)]
pub struct ADBTcpDevice { pub struct ADBTcpDevice {
private_key: ADBRsaKey,
inner: ADBMessageDevice<TcpTransport>, inner: ADBMessageDevice<TcpTransport>,
} }
impl ADBTcpDevice { impl ADBTcpDevice {
/// Instantiate a new [`ADBTcpDevice`] /// Instantiate a new [`ADBTcpDevice`]
pub fn new(address: SocketAddr) -> Result<Self> { pub fn new(address: SocketAddr) -> Result<Self> {
Self::new_with_custom_private_key(address, get_default_adb_key_path()?)
}
/// Instantiate a new [`ADBTcpDevice`] using a custom private key path
pub fn new_with_custom_private_key(
address: SocketAddr,
private_key_path: PathBuf,
) -> Result<Self> {
let private_key = if let Some(private_key) = read_adb_private_key(&private_key_path)? {
private_key
} else {
log::warn!(
"No private key found at path {}. Using a temporary random one.",
private_key_path.display()
);
ADBRsaKey::new_random()?
};
let mut device = Self { let mut device = Self {
private_key,
inner: ADBMessageDevice::new(TcpTransport::new(address)?), inner: ADBMessageDevice::new(TcpTransport::new(address)?),
}; };
@@ -56,8 +31,8 @@ impl ADBTcpDevice {
let message = ADBTransportMessage::new( let message = ADBTransportMessage::new(
MessageCommand::Cnxn, MessageCommand::Cnxn,
0x0100_0000, 0x01000000,
1_048_576, 1048576,
format!("host::{}\0", env!("CARGO_PKG_NAME")).as_bytes(), format!("host::{}\0", env!("CARGO_PKG_NAME")).as_bytes(),
); );
@@ -65,28 +40,26 @@ impl ADBTcpDevice {
let message = self.get_transport_mut().read_message()?; let message = self.get_transport_mut().read_message()?;
// Check if a client is requesting a secure connection and upgrade it if necessary // Check if client is requesting a secure connection and upgrade it if necessary
match message.header().command() { match message.header().command() {
MessageCommand::Stls => { MessageCommand::Stls => {
self.get_transport_mut() self.get_transport_mut()
.write_message(ADBTransportMessage::new(MessageCommand::Stls, 1, 0, &[]))?; .write_message(ADBTransportMessage::new(MessageCommand::Stls, 1, 0, &[]))?;
self.get_transport_mut().upgrade_connection()?; self.get_transport_mut().upgrade_connection()?;
log::debug!("Connection successfully upgraded from TCP to TLS"); log::debug!("Connection successfully upgraded from TCP to TLS");
Ok(())
} }
MessageCommand::Cnxn => { MessageCommand::Cnxn => {
log::debug!("Unencrypted connection established"); log::debug!("Unencrypted connection established");
Ok(())
} }
MessageCommand::Auth => { _ => {
log::debug!("Authentication required"); return Err(crate::RustADBError::WrongResponseReceived(
self.inner.auth_handshake(message, &self.private_key) "Expected CNXN or STLS command".to_string(),
message.header().command().to_string(),
));
} }
_ => Err(crate::RustADBError::WrongResponseReceived(
"Expected CNXN, STLS or AUTH command".to_string(),
message.header().command().to_string(),
)),
} }
Ok(())
} }
#[inline] #[inline]
@@ -102,7 +75,7 @@ impl ADBDeviceExt for ADBTcpDevice {
} }
#[inline] #[inline]
fn shell(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()> { fn shell(&mut self, reader: &mut dyn Read, writer: Box<(dyn Write + Send)>) -> Result<()> {
self.inner.shell(reader, writer) self.inner.shell(reader, writer)
} }

View File

@@ -1,9 +1,12 @@
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use crate::{ use crate::{Result, RustADBError};
Result, RustADBError,
message_devices::{adb_message_device, message_commands::MessageCommand}, use super::models::MessageCommand;
};
pub const AUTH_TOKEN: u32 = 1;
pub const AUTH_SIGNATURE: u32 = 2;
pub const AUTH_RSAPUBLICKEY: u32 = 3;
#[derive(Debug)] #[derive(Debug)]
pub struct ADBTransportMessage { pub struct ADBTransportMessage {
@@ -55,16 +58,16 @@ impl ADBTransportMessageHeader {
} }
pub(crate) fn compute_crc32(data: &[u8]) -> u32 { pub(crate) fn compute_crc32(data: &[u8]) -> u32 {
data.iter().map(|&x| u32::from(x)).sum() data.iter().map(|&x| x as u32).sum()
} }
fn compute_magic(command: MessageCommand) -> u32 { fn compute_magic(command: MessageCommand) -> u32 {
let command_u32 = command as u32; let command_u32 = command as u32;
command_u32 ^ 0xFFFF_FFFF command_u32 ^ 0xFFFFFFFF
} }
pub fn as_bytes(&self) -> Result<Vec<u8>> { pub fn as_bytes(&self) -> Result<Vec<u8>> {
adb_message_device::bincode_serialize_to_vec(self) bincode::serialize(&self).map_err(|_e| RustADBError::ConversionError)
} }
} }
@@ -114,6 +117,6 @@ impl TryFrom<[u8; 24]> for ADBTransportMessageHeader {
type Error = RustADBError; type Error = RustADBError;
fn try_from(value: [u8; 24]) -> Result<Self> { fn try_from(value: [u8; 24]) -> Result<Self> {
adb_message_device::bincode_deserialize_from_slice(&value) bincode::deserialize(&value).map_err(|_e| RustADBError::ConversionError)
} }
} }

View File

@@ -0,0 +1,308 @@
use rusb::Device;
use rusb::DeviceDescriptor;
use rusb::UsbContext;
use rusb::constants::LIBUSB_CLASS_VENDOR_SPEC;
use std::fs::read_to_string;
use std::io::Read;
use std::io::Write;
use std::path::Path;
use std::path::PathBuf;
use std::time::Duration;
use super::adb_message_device::ADBMessageDevice;
use super::models::MessageCommand;
use super::{ADBRsaKey, ADBTransportMessage};
use crate::ADBDeviceExt;
use crate::ADBMessageTransport;
use crate::ADBTransport;
use crate::device::adb_transport_message::{AUTH_RSAPUBLICKEY, AUTH_SIGNATURE, AUTH_TOKEN};
use crate::{Result, RustADBError, USBTransport};
pub fn read_adb_private_key<P: AsRef<Path>>(private_key_path: P) -> Result<Option<ADBRsaKey>> {
// Try to read the private key file from given path
// If the file is not found, return None
// If there is another error while reading the file, return this error
// Else, return the private key content
let pk = match read_to_string(private_key_path.as_ref()) {
Ok(pk) => pk,
Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(None),
Err(e) => return Err(e.into()),
};
match ADBRsaKey::new_from_pkcs8(&pk) {
Ok(pk) => Ok(Some(pk)),
Err(e) => Err(e),
}
}
/// Search for adb devices with known interface class and subclass values
pub fn search_adb_devices() -> Result<Option<(u16, u16)>> {
let mut found_devices = vec![];
for device in rusb::devices()?.iter() {
let Ok(des) = device.device_descriptor() else {
continue;
};
if is_adb_device(&device, &des) {
log::debug!(
"Autodetect device {:04x}:{:04x}",
des.vendor_id(),
des.product_id()
);
found_devices.push((des.vendor_id(), des.product_id()));
}
}
match (found_devices.first(), found_devices.get(1)) {
(None, _) => Ok(None),
(Some(identifiers), None) => Ok(Some(*identifiers)),
(Some((vid1, pid1)), Some((vid2, pid2))) => Err(RustADBError::DeviceNotFound(format!(
"Found two Android devices {vid1:04x}:{pid1:04x} and {vid2:04x}:{pid2:04x}",
))),
}
}
/// Check whether a device with given descriptor is an ADB device
pub fn is_adb_device<T: UsbContext>(device: &Device<T>, des: &DeviceDescriptor) -> bool {
const ADB_SUBCLASS: u8 = 0x42;
const ADB_PROTOCOL: u8 = 0x1;
// Some devices require choosing the file transfer mode
// for usb debugging to take effect.
const BULK_CLASS: u8 = 0xdc;
const BULK_ADB_SUBCLASS: u8 = 2;
for n in 0..des.num_configurations() {
let Ok(config_des) = device.config_descriptor(n) else {
continue;
};
for interface in config_des.interfaces() {
for interface_des in interface.descriptors() {
let proto = interface_des.protocol_code();
let class = interface_des.class_code();
let subcl = interface_des.sub_class_code();
if proto == ADB_PROTOCOL
&& ((class == LIBUSB_CLASS_VENDOR_SPEC && subcl == ADB_SUBCLASS)
|| (class == BULK_CLASS && subcl == BULK_ADB_SUBCLASS))
{
return true;
}
}
}
}
false
}
pub fn get_default_adb_key_path() -> Result<PathBuf> {
homedir::my_home()
.ok()
.flatten()
.map(|home| home.join(".android").join("adbkey"))
.ok_or(RustADBError::NoHomeDirectory)
}
/// Represent a device reached and available over USB.
#[derive(Debug)]
pub struct ADBUSBDevice {
private_key: ADBRsaKey,
inner: ADBMessageDevice<USBTransport>,
}
impl ADBUSBDevice {
/// Instantiate a new [`ADBUSBDevice`]
pub fn new(vendor_id: u16, product_id: u16) -> Result<Self> {
Self::new_with_custom_private_key(vendor_id, product_id, get_default_adb_key_path()?)
}
/// Instantiate a new [`ADBUSBDevice`] using a custom private key path
pub fn new_with_custom_private_key(
vendor_id: u16,
product_id: u16,
private_key_path: PathBuf,
) -> Result<Self> {
Self::new_from_transport_inner(USBTransport::new(vendor_id, product_id)?, private_key_path)
}
/// Instantiate a new [`ADBUSBDevice`] from a [`USBTransport`] and an optional private key path.
pub fn new_from_transport(
transport: USBTransport,
private_key_path: Option<PathBuf>,
) -> Result<Self> {
let private_key_path = match private_key_path {
Some(private_key_path) => private_key_path,
None => get_default_adb_key_path()?,
};
Self::new_from_transport_inner(transport, private_key_path)
}
fn new_from_transport_inner(
transport: USBTransport,
private_key_path: PathBuf,
) -> Result<Self> {
let private_key = match read_adb_private_key(&private_key_path)? {
Some(pk) => pk,
None => {
log::warn!(
"No private key found at path {}. Using a temporary random one.",
private_key_path.display()
);
ADBRsaKey::new_random()?
}
};
let mut s = Self {
private_key,
inner: ADBMessageDevice::new(transport),
};
s.connect()?;
Ok(s)
}
/// autodetect connected ADB devices and establish a connection with the first device found
pub fn autodetect() -> Result<Self> {
Self::autodetect_with_custom_private_key(get_default_adb_key_path()?)
}
/// autodetect connected ADB devices and establish a connection with the first device found using a custom private key path
pub fn autodetect_with_custom_private_key(private_key_path: PathBuf) -> Result<Self> {
match search_adb_devices()? {
Some((vendor_id, product_id)) => {
ADBUSBDevice::new_with_custom_private_key(vendor_id, product_id, private_key_path)
}
_ => Err(RustADBError::DeviceNotFound(
"cannot find USB devices matching the signature of an ADB device".into(),
)),
}
}
/// Send initial connect
pub fn connect(&mut self) -> Result<()> {
self.get_transport_mut().connect()?;
let message = ADBTransportMessage::new(
MessageCommand::Cnxn,
0x01000000,
1048576,
format!("host::{}\0", env!("CARGO_PKG_NAME")).as_bytes(),
);
self.get_transport_mut().write_message(message)?;
let message = self.get_transport_mut().read_message()?;
// If the device returned CNXN instead of AUTH it does not require authentication,
// so we can skip the auth steps.
if message.header().command() == MessageCommand::Cnxn {
return Ok(());
}
message.assert_command(MessageCommand::Auth)?;
// At this point, we should have receive an AUTH message with arg0 == 1
let auth_message = match message.header().arg0() {
AUTH_TOKEN => message,
v => {
return Err(RustADBError::ADBRequestFailed(format!(
"Received AUTH message with type != 1 ({v})"
)));
}
};
let sign = self.private_key.sign(auth_message.into_payload())?;
let message = ADBTransportMessage::new(MessageCommand::Auth, AUTH_SIGNATURE, 0, &sign);
self.get_transport_mut().write_message(message)?;
let received_response = self.get_transport_mut().read_message()?;
if received_response.header().command() == MessageCommand::Cnxn {
log::info!(
"Authentication OK, device info {}",
String::from_utf8(received_response.into_payload())?
);
return Ok(());
}
let mut pubkey = self.private_key.android_pubkey_encode()?.into_bytes();
pubkey.push(b'\0');
let message = ADBTransportMessage::new(MessageCommand::Auth, AUTH_RSAPUBLICKEY, 0, &pubkey);
self.get_transport_mut().write_message(message)?;
let response = self
.get_transport_mut()
.read_message_with_timeout(Duration::from_secs(10))
.and_then(|message| {
message.assert_command(MessageCommand::Cnxn)?;
Ok(message)
})?;
log::info!(
"Authentication OK, device info {}",
String::from_utf8(response.into_payload())?
);
Ok(())
}
#[inline]
fn get_transport_mut(&mut self) -> &mut USBTransport {
self.inner.get_transport_mut()
}
}
impl ADBDeviceExt for ADBUSBDevice {
#[inline]
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
self.inner.shell_command(command, output)
}
#[inline]
fn shell<'a>(&mut self, reader: &mut dyn Read, writer: Box<(dyn Write + Send)>) -> Result<()> {
self.inner.shell(reader, writer)
}
#[inline]
fn stat(&mut self, remote_path: &str) -> Result<crate::AdbStatResponse> {
self.inner.stat(remote_path)
}
#[inline]
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()> {
self.inner.pull(source, output)
}
#[inline]
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
self.inner.push(stream, path)
}
#[inline]
fn reboot(&mut self, reboot_type: crate::RebootType) -> Result<()> {
self.inner.reboot(reboot_type)
}
#[inline]
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
self.inner.install(apk_path)
}
#[inline]
fn uninstall(&mut self, package: &str) -> Result<()> {
self.inner.uninstall(package)
}
#[inline]
fn framebuffer_inner(&mut self) -> Result<image::ImageBuffer<image::Rgba<u8>, Vec<u8>>> {
self.inner.framebuffer_inner()
}
}
impl Drop for ADBUSBDevice {
fn drop(&mut self) {
// Best effort here
let _ = self.get_transport_mut().disconnect();
}
}

View File

@@ -4,11 +4,8 @@ use byteorder::{LittleEndian, ReadBytesExt};
use image::{ImageBuffer, Rgba}; use image::{ImageBuffer, Rgba};
use crate::{ use crate::{
Result, RustADBError, ADBMessageTransport, Result, RustADBError,
message_devices::{ device::{MessageCommand, adb_message_device::ADBMessageDevice},
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
message_commands::MessageCommand,
},
models::{FrameBufferInfoV1, FrameBufferInfoV2}, models::{FrameBufferInfoV1, FrameBufferInfoV2},
}; };
@@ -35,7 +32,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
payload_cursor.read_to_end(&mut framebuffer_data)?; payload_cursor.read_to_end(&mut framebuffer_data)?;
loop { loop {
if u32::try_from(framebuffer_data.len())? == framebuffer_info.size { if framebuffer_data.len() as u32 == framebuffer_info.size {
break; break;
} }
@@ -68,7 +65,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
payload_cursor.read_to_end(&mut framebuffer_data)?; payload_cursor.read_to_end(&mut framebuffer_data)?;
loop { loop {
if u32::try_from(framebuffer_data.len())? == framebuffer_info.size { if framebuffer_data.len() as u32 == framebuffer_info.size {
break; break;
} }

View File

@@ -1,11 +1,8 @@
use std::{fs::File, path::Path}; use std::{fs::File, path::Path};
use crate::{ use crate::{
Result, ADBMessageTransport, Result,
message_devices::{ device::{MessageWriter, adb_message_device::ADBMessageDevice},
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
commands::utils::MessageWriter,
},
utils::check_extension_is_apk, utils::check_extension_is_apk,
}; };

View File

@@ -6,4 +6,3 @@ mod reboot;
mod shell; mod shell;
mod stat; mod stat;
mod uninstall; mod uninstall;
mod utils;

View File

@@ -1,12 +1,10 @@
use std::io::Write; use std::io::Write;
use crate::{ use crate::{
Result, RustADBError, ADBMessageTransport, Result, RustADBError,
message_devices::{ device::{
adb_message_device::{self, ADBMessageDevice}, ADBTransportMessage, MessageCommand, adb_message_device::ADBMessageDevice,
adb_message_transport::ADBMessageTransport, models::MessageSubcommand,
adb_transport_message::ADBTransportMessage,
message_commands::{MessageCommand, MessageSubcommand},
}, },
}; };
@@ -31,8 +29,9 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
std::time::Duration::from_secs(4), std::time::Duration::from_secs(4),
)?; )?;
let recv_buffer = MessageSubcommand::Recv.with_arg(u32::try_from(source.len())?); let recv_buffer = MessageSubcommand::Recv.with_arg(source.len() as u32);
let recv_buffer = adb_message_device::bincode_serialize_to_vec(&recv_buffer)?; let recv_buffer =
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,
self.get_local_id()?, self.get_local_id()?,

View File

@@ -1,12 +1,10 @@
use std::io::Read; use std::io::Read;
use crate::{ use crate::{
Result, ADBMessageTransport, Result, RustADBError,
message_devices::{ device::{
adb_message_device::{self, ADBMessageDevice}, ADBTransportMessage, MessageCommand, MessageSubcommand,
adb_message_transport::ADBMessageTransport, adb_message_device::ADBMessageDevice,
adb_transport_message::ADBTransportMessage,
message_commands::{MessageCommand, MessageSubcommand},
}, },
}; };
@@ -16,8 +14,9 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
let path_header = format!("{},0777", path.as_ref()); let path_header = format!("{},0777", path.as_ref());
let send_buffer = MessageSubcommand::Send.with_arg(u32::try_from(path_header.len())?); let send_buffer = MessageSubcommand::Send.with_arg(path_header.len() as u32);
let mut send_buffer = adb_message_device::bincode_serialize_to_vec(&send_buffer)?; let mut send_buffer =
bincode::serialize(&send_buffer).map_err(|_e| RustADBError::ConversionError)?;
send_buffer.append(&mut path_header.as_bytes().to_vec()); send_buffer.append(&mut path_header.as_bytes().to_vec());
self.send_and_expect_okay(ADBTransportMessage::new( self.send_and_expect_okay(ADBTransportMessage::new(

View File

@@ -1,9 +1,6 @@
use crate::{ use crate::{
RebootType, Result, ADBMessageTransport, RebootType, Result,
message_devices::{ device::{MessageCommand, adb_message_device::ADBMessageDevice},
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
message_commands::MessageCommand,
},
}; };
impl<T: ADBMessageTransport> ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBMessageDevice<T> {

View File

@@ -1,12 +1,10 @@
use std::io::{ErrorKind, Read, Write}; use std::io::{ErrorKind, Read, Write};
use crate::Result;
use crate::device::ShellMessageWriter;
use crate::{ use crate::{
Result, RustADBError, ADBMessageTransport, RustADBError,
message_devices::{ device::{ADBMessageDevice, ADBTransportMessage, MessageCommand},
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
adb_transport_message::ADBTransportMessage, commands::utils::ShellMessageWriter,
message_commands::MessageCommand,
},
}; };
impl<T: ADBMessageTransport> ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBMessageDevice<T> {
@@ -38,7 +36,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn shell( pub(crate) fn shell(
&mut self, &mut self,
mut reader: &mut dyn Read, mut reader: &mut dyn Read,
mut writer: Box<dyn Write + Send>, mut writer: Box<(dyn Write + Send)>,
) -> Result<()> { ) -> Result<()> {
self.open_session(b"shell:\0")?; self.open_session(b"shell:\0")?;
@@ -62,7 +60,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
writer.write_all(&message.into_payload())?; writer.write_all(&message.into_payload())?;
writer.flush()?; writer.flush()?;
} }
MessageCommand::Okay => {} MessageCommand::Okay => continue,
_ => return Err(RustADBError::ADBShellNotSupported), _ => return Err(RustADBError::ADBShellNotSupported),
} }
} }

View File

@@ -1,8 +1,5 @@
use crate::{ use crate::{
AdbStatResponse, Result, ADBMessageTransport, AdbStatResponse, Result, device::adb_message_device::ADBMessageDevice,
message_devices::{
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
},
}; };
impl<T: ADBMessageTransport> ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBMessageDevice<T> {

View File

@@ -1,9 +1,4 @@
use crate::{ use crate::{ADBMessageTransport, Result, device::adb_message_device::ADBMessageDevice};
Result,
message_devices::{
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
},
};
impl<T: ADBMessageTransport> ADBMessageDevice<T> { impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn uninstall(&mut self, package_name: &str) -> Result<()> { pub(crate) fn uninstall(&mut self, package_name: &str) -> Result<()> {

View File

@@ -1,9 +1,8 @@
use std::io::{Error, ErrorKind, Result, Write}; use std::io::{Error, ErrorKind, Result, Write};
use crate::message_devices::{ use crate::ADBMessageTransport;
adb_message_transport::ADBMessageTransport, adb_transport_message::ADBTransportMessage,
message_commands::MessageCommand, use super::{ADBTransportMessage, MessageCommand};
};
/// [`Write`] trait implementation to hide underlying ADB protocol write logic. /// [`Write`] trait implementation to hide underlying ADB protocol write logic.
/// ///

View File

@@ -0,0 +1,19 @@
mod adb_message_device;
mod adb_message_device_commands;
mod adb_tcp_device;
mod adb_transport_message;
mod adb_usb_device;
mod commands;
mod message_writer;
mod models;
mod shell_message_writer;
use adb_message_device::ADBMessageDevice;
pub use adb_tcp_device::ADBTcpDevice;
pub use adb_transport_message::{ADBTransportMessage, ADBTransportMessageHeader};
pub use adb_usb_device::{
ADBUSBDevice, get_default_adb_key_path, is_adb_device, search_adb_devices,
};
pub use message_writer::MessageWriter;
pub use models::{ADBRsaKey, MessageCommand, MessageSubcommand};
pub use shell_message_writer::ShellMessageWriter;

View File

@@ -6,7 +6,6 @@ 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};
use std::fmt::Write;
const ADB_PRIVATE_KEY_SIZE: usize = 2048; const ADB_PRIVATE_KEY_SIZE: usize = 2048;
const ANDROID_PUBKEY_MODULUS_SIZE_WORDS: u32 = 64; const ANDROID_PUBKEY_MODULUS_SIZE_WORDS: u32 = 64;
@@ -93,16 +92,15 @@ impl ADBRsaKey {
.to_u32() .to_u32()
.ok_or(RustADBError::ConversionError)?; .ok_or(RustADBError::ConversionError)?;
Self::encode_public_key(adb_rsa_pubkey.into_bytes()) Ok(self.encode_public_key(adb_rsa_pubkey.into_bytes()))
} }
fn encode_public_key(pub_key: Vec<u8>) -> Result<String> { fn encode_public_key(&self, pub_key: Vec<u8>) -> String {
let mut encoded = STANDARD.encode(pub_key); let mut encoded = STANDARD.encode(pub_key);
encoded.push(' '); encoded.push(' ');
write!(encoded, "adb_client@{}", env!("CARGO_PKG_VERSION")) encoded.push_str(&format!("adb_client@{}", env!("CARGO_PKG_VERSION")));
.map_err(|_| RustADBError::ConversionError)?;
Ok(encoded) encoded
} }
pub fn sign(&self, msg: impl AsRef<[u8]>) -> Result<Vec<u8>> { pub fn sign(&self, msg: impl AsRef<[u8]>) -> Result<Vec<u8>> {

View File

@@ -6,32 +6,32 @@ use std::fmt::Display;
#[repr(u32)] #[repr(u32)]
pub enum MessageCommand { pub enum MessageCommand {
/// Connect to a device /// Connect to a device
Cnxn = 0x4E58_4E43, Cnxn = 0x4E584E43,
/// Close connection to a device /// Close connection to a device
Clse = 0x4553_4C43, Clse = 0x45534C43,
/// Device ask for authentication /// Device ask for authentication
Auth = 0x4854_5541, Auth = 0x48545541,
/// Open a data connection /// Open a data connection
Open = 0x4E45_504F, Open = 0x4E45504F,
/// Write data to connection /// Write data to connection
Write = 0x4554_5257, Write = 0x45545257,
/// Server understood the message /// Server understood the message
Okay = 0x5941_4B4F, Okay = 0x59414B4F,
/// Start a connection using TLS /// Start a connection using TLS
Stls = 0x534C_5453, Stls = 0x534C5453,
} }
#[derive(Debug, Eq, PartialEq, Copy, Clone, Serialize_repr, Deserialize_repr)] #[derive(Debug, Eq, PartialEq, Copy, Clone, Serialize_repr, Deserialize_repr)]
#[repr(u32)] #[repr(u32)]
pub enum MessageSubcommand { pub enum MessageSubcommand {
Stat = 0x5441_5453, Stat = 0x54415453,
Send = 0x444E_4553, Send = 0x444E4553,
Recv = 0x5643_4552, Recv = 0x56434552,
Quit = 0x5449_5551, Quit = 0x54495551,
Fail = 0x4C49_4146, Fail = 0x4C494146,
Done = 0x454E_4F44, Done = 0x454E4F44,
Data = 0x4154_4144, Data = 0x41544144,
List = 0x5453_494C, List = 0x5453494C,
} }
#[derive(Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]

View File

@@ -0,0 +1,5 @@
mod adb_rsa_key;
mod message_commands;
pub use adb_rsa_key::ADBRsaKey;
pub use message_commands::{MessageCommand, MessageSubcommand};

View File

@@ -1,9 +1,8 @@
use std::io::Write; use std::io::Write;
use crate::message_devices::{ use crate::ADBMessageTransport;
adb_message_transport::ADBMessageTransport, adb_transport_message::ADBTransportMessage,
message_commands::MessageCommand, 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> {

View File

@@ -3,10 +3,7 @@ use std::{
sync::LazyLock, sync::LazyLock,
}; };
use crate::{ use crate::{ADBServerDevice, ADBTransport, Result, RustADBError, TCPEmulatorTransport};
ADBTransport, Result, RustADBError, emulator::tcp_emulator_transport::TCPEmulatorTransport,
server_device::ADBServerDevice,
};
use regex::Regex; use regex::Regex;
static EMULATOR_REGEX: LazyLock<Regex> = LazyLock::new(|| { static EMULATOR_REGEX: LazyLock<Regex> = LazyLock::new(|| {
@@ -18,16 +15,16 @@ static EMULATOR_REGEX: LazyLock<Regex> = LazyLock::new(|| {
pub struct ADBEmulatorDevice { pub struct ADBEmulatorDevice {
/// Unique device identifier. /// Unique device identifier.
pub identifier: String, pub identifier: String,
/// Internal [`TCPEmulatorTransport`] /// Internal [TCPEmulatorTransport]
transport: TCPEmulatorTransport, transport: TCPEmulatorTransport,
} }
impl ADBEmulatorDevice { impl ADBEmulatorDevice {
/// Instantiates a new [`ADBEmulatorDevice`] /// Instantiates a new [ADBEmulatorDevice]
pub fn new(identifier: String, ip_address: Option<Ipv4Addr>) -> Result<Self> { pub fn new(identifier: String, ip_address: Option<Ipv4Addr>) -> Result<Self> {
let ip_address = match ip_address { let ip_address = match ip_address {
Some(ip_address) => ip_address, Some(ip_address) => ip_address,
None => Ipv4Addr::LOCALHOST, None => Ipv4Addr::new(127, 0, 0, 1),
}; };
let groups = EMULATOR_REGEX let groups = EMULATOR_REGEX

View File

@@ -1,7 +1,4 @@
use crate::{ use crate::{ADBEmulatorDevice, Result, emulator_device::ADBEmulatorCommand};
Result,
emulator::{ADBEmulatorCommand, ADBEmulatorDevice},
};
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

View File

@@ -1,7 +1,4 @@
use crate::{ use crate::{ADBEmulatorDevice, Result, emulator_device::ADBEmulatorCommand};
Result,
emulator::{ADBEmulatorCommand, ADBEmulatorDevice},
};
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

View File

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

View File

@@ -24,7 +24,8 @@ impl ADBEmulatorCommand {
pub(crate) fn skip_response_lines(&self) -> u8 { pub(crate) fn skip_response_lines(&self) -> u8 {
match self { match self {
ADBEmulatorCommand::Authenticate(_) => 1, ADBEmulatorCommand::Authenticate(_) => 1,
ADBEmulatorCommand::Sms(_, _) | ADBEmulatorCommand::Rotate => 0, ADBEmulatorCommand::Sms(_, _) => 0,
ADBEmulatorCommand::Rotate => 0,
} }
} }
} }

View File

@@ -42,9 +42,6 @@ pub enum RustADBError {
/// Indicates that an error occurred when converting a value. /// Indicates that an error occurred when converting a value.
#[error("Conversion error")] #[error("Conversion error")]
ConversionError, ConversionError,
/// Indicates an error with the integer conversion.
#[error(transparent)]
IntegerConversionError(#[from] std::num::TryFromIntError),
/// Remote ADB server does not support shell feature. /// Remote ADB server does not support shell feature.
#[error("Remote ADB server does not support shell feature")] #[error("Remote ADB server does not support shell feature")]
ADBShellNotSupported, ADBShellNotSupported,
@@ -64,14 +61,12 @@ pub enum RustADBError {
#[error("Unimplemented framebuffer image version: {0}")] #[error("Unimplemented framebuffer image version: {0}")]
UnimplementedFramebufferImageVersion(u32), UnimplementedFramebufferImageVersion(u32),
/// An error occurred while getting user's home directory /// An error occurred while getting user's home directory
#[error("Cannot get user home directory")] #[error(transparent)]
HomeError, HomeError(#[from] homedir::GetHomeError),
/// Cannot get home directory /// Cannot get home directory
#[error("Cannot get home directory")] #[error("Cannot get home directory")]
NoHomeDirectory, NoHomeDirectory,
/// Generic USB error /// Generic USB error
#[cfg(feature = "rusb")]
#[cfg_attr(docsrs, doc(cfg(feature = "rusb")))]
#[error("USB Error: {0}")] #[error("USB Error: {0}")]
UsbError(#[from] rusb::Error), UsbError(#[from] rusb::Error),
/// USB device not found /// USB device not found
@@ -90,8 +85,6 @@ pub enum RustADBError {
#[error(transparent)] #[error(transparent)]
Base64EncodeError(#[from] base64::EncodeSliceError), Base64EncodeError(#[from] base64::EncodeSliceError),
/// An error occurred with RSA engine /// An error occurred with RSA engine
#[cfg(any(feature = "rusb", feature = "webusb"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "rusb", feature = "webusb"))))]
#[error(transparent)] #[error(transparent)]
RSAError(#[from] rsa::errors::Error), RSAError(#[from] rsa::errors::Error),
/// Cannot convert given data from slice /// Cannot convert given data from slice
@@ -101,8 +94,6 @@ pub enum RustADBError {
#[error("wrong file extension: {0}")] #[error("wrong file extension: {0}")]
WrongFileExtension(String), WrongFileExtension(String),
/// An error occurred with PKCS8 data /// An error occurred with PKCS8 data
#[cfg(any(feature = "rusb", feature = "webusb"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "rusb", feature = "webusb"))))]
#[error("error with pkcs8: {0}")] #[error("error with pkcs8: {0}")]
RsaPkcs8Error(#[from] rsa::pkcs8::Error), RsaPkcs8Error(#[from] rsa::pkcs8::Error),
/// Error during certificate generation /// Error during certificate generation
@@ -122,12 +113,11 @@ pub enum RustADBError {
UpgradeError(String), UpgradeError(String),
/// An error occurred while getting mdns devices /// An error occurred while getting mdns devices
#[cfg(feature = "mdns")] #[cfg(feature = "mdns")]
#[cfg_attr(docsrs, doc(cfg(feature = "mdns")))]
#[error(transparent)] #[error(transparent)]
MDNSError(#[from] mdns_sd::Error), MDNSError(#[from] mdns_sd::Error),
/// An error occurred while sending data to channel /// An error occurred while sending data to channel
#[error("error sending data to channel")] #[error(transparent)]
SendError, SendError(#[from] std::sync::mpsc::SendError<crate::MDNSDevice>),
/// An unknown transport has been provided /// An unknown transport has been provided
#[error("unknown transport: {0}")] #[error("unknown transport: {0}")]
UnknownTransport(String), UnknownTransport(String),

View File

@@ -3,34 +3,27 @@
#![forbid(missing_debug_implementations)] #![forbid(missing_debug_implementations)]
#![forbid(missing_docs)] #![forbid(missing_docs)]
#![doc = include_str!("../README.md")] #![doc = include_str!("../README.md")]
// Feature `doc_cfg` is currently only available on nightly.
// It is activated when cfg `docsrs` is enabled.
// Documentation can be build locally using:
// `RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --no-deps --all-features`
#![cfg_attr(docsrs, feature(doc_cfg))]
mod adb_device_ext; mod adb_device_ext;
mod adb_transport; mod constants;
/// Emulator-related definitions mod device;
pub mod emulator; mod emulator_device;
mod error; mod error;
mod message_devices; #[cfg(feature = "mdns")]
mod mdns;
mod models; mod models;
mod server;
/// Server-related definitions mod server_device;
pub mod server; mod transports;
/// Device reachable by the server related definitions
pub mod server_device;
mod utils; mod utils;
/// MDNS-related definitions
#[cfg(feature = "mdns")]
#[cfg_attr(docsrs, doc(cfg(feature = "mdns")))]
pub mod mdns;
pub use adb_device_ext::ADBDeviceExt; pub use adb_device_ext::ADBDeviceExt;
use adb_transport::ADBTransport; pub use device::{ADBTcpDevice, ADBUSBDevice, is_adb_device, search_adb_devices};
pub use emulator_device::ADBEmulatorDevice;
pub use error::{Result, RustADBError}; pub use error::{Result, RustADBError};
pub use message_devices::*; #[cfg(feature = "mdns")]
pub use models::{AdbStatResponse, HostFeatures, RebootType}; pub use mdns::*;
pub use models::{AdbStatResponse, RebootType};
pub use server::*;
pub use server_device::ADBServerDevice;
pub use transports::*;

View File

@@ -1,7 +1,5 @@
use std::{collections::HashSet, net::IpAddr}; use std::{collections::HashSet, net::IpAddr};
use mdns_sd::{ResolvedService, ScopedIp};
/// Represent a device found from mdns search /// Represent a device found from mdns search
#[derive(Debug)] #[derive(Debug)]
pub struct MDNSDevice { pub struct MDNSDevice {
@@ -11,11 +9,11 @@ pub struct MDNSDevice {
pub addresses: HashSet<IpAddr>, pub addresses: HashSet<IpAddr>,
} }
impl From<Box<ResolvedService>> for MDNSDevice { impl From<mdns_sd::ServiceInfo> for MDNSDevice {
fn from(value: Box<ResolvedService>) -> Self { fn from(value: mdns_sd::ServiceInfo) -> Self {
Self { Self {
fullname: value.fullname, fullname: value.get_fullname().to_string(),
addresses: value.addresses.iter().map(ScopedIp::to_ip_addr).collect(), addresses: value.get_addresses().to_owned(),
} }
} }
} }

View File

@@ -1,7 +1,7 @@
use mdns_sd::{ServiceDaemon, ServiceEvent}; use mdns_sd::{ServiceDaemon, ServiceEvent};
use std::{sync::mpsc::Sender, thread::JoinHandle}; use std::{sync::mpsc::Sender, thread::JoinHandle};
use crate::{Result, RustADBError, mdns::MDNSDevice}; use crate::{MDNSDevice, Result, RustADBError};
const ADB_SERVICE_NAME: &str = "_adb-tls-connect._tcp.local."; const ADB_SERVICE_NAME: &str = "_adb-tls-connect._tcp.local.";
@@ -42,14 +42,12 @@ impl MDNSDiscoveryService {
| ServiceEvent::ServiceFound(_, _) | ServiceEvent::ServiceFound(_, _)
| ServiceEvent::SearchStopped(_) => { | ServiceEvent::SearchStopped(_) => {
// Ignoring these events. We are only interesting in found devices // Ignoring these events. We are only interesting in found devices
continue;
} }
ServiceEvent::ServiceResolved(service_info) => { ServiceEvent::ServiceResolved(service_info) => {
return sender if let Err(e) = sender.send(MDNSDevice::from(service_info)) {
.send(MDNSDevice::from(service_info)) return Err(e.into());
.map_err(|_| RustADBError::SendError); }
}
e => {
log::warn!("received unknown event type {e:?}");
} }
} }
} }

View File

@@ -1,4 +0,0 @@
mod message_writer;
mod shell_message_writer;
pub use message_writer::MessageWriter;
pub use shell_message_writer::ShellMessageWriter;

View File

@@ -1,17 +0,0 @@
/// USB-related definitions
pub mod usb;
/// Device reachable over TCP related definition
pub mod tcp;
pub(crate) const AUTH_TOKEN: u32 = 1;
pub(crate) const AUTH_SIGNATURE: u32 = 2;
pub(crate) const AUTH_RSAPUBLICKEY: u32 = 3;
mod adb_message_device;
mod adb_message_device_commands;
mod adb_message_transport;
mod adb_rsa_key;
mod adb_transport_message;
mod commands;
mod message_commands;

View File

@@ -1,13 +0,0 @@
# Examples
## Get a shell from device
```rust no_run
use std::net::{SocketAddr, IpAddr, Ipv4Addr};
use adb_client::{tcp::ADBTcpDevice, ADBDeviceExt};
let device_ip = IpAddr::V4(Ipv4Addr::new(192, 168, 0, 10));
let device_port = 43210;
let mut device = ADBTcpDevice::new(SocketAddr::new(device_ip, device_port)).expect("cannot find device");
device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()));
```

View File

@@ -1,6 +0,0 @@
#![doc = include_str!("./README.md")]
mod adb_tcp_device;
mod tcp_transport;
pub use adb_tcp_device::ADBTcpDevice;

View File

@@ -1,26 +0,0 @@
# Examples
## Launch a command on device
```rust no_run
use adb_client::{usb::ADBUSBDevice, ADBDeviceExt};
let vendor_id = 0x04e8;
let product_id = 0x6860;
let mut device = ADBUSBDevice::new(vendor_id, product_id).expect("cannot find device");
device.shell_command(&["df", "-h"], &mut std::io::stdout());
```
## Push a file to the device
```rust no_run
use adb_client::{usb::ADBUSBDevice, ADBDeviceExt};
use std::fs::File;
use std::path::Path;
let vendor_id = 0x04e8;
let product_id = 0x6860;
let mut device = ADBUSBDevice::new(vendor_id, product_id).expect("cannot find device");
let mut input = File::open("/tmp/file.txt").expect("Cannot open file");
device.push(&mut input, &"/data/local/tmp");
```

View File

@@ -1,100 +0,0 @@
use std::{
io::{Read, Write},
path::{Path, PathBuf},
};
use crate::{
ADBDeviceExt, Result, RustADBError,
usb::{RusbTransport, adb_usb_device::ADBUSBDevice, search_adb_devices},
utils::get_default_adb_key_path,
};
/// Implement Android USB device reachable over wired USB
#[derive(Debug)]
pub struct ADBRusbDevice {
inner: ADBUSBDevice<RusbTransport>,
}
impl ADBRusbDevice {
/// Instantiate a new [`ADBRusbDevice`]
pub fn new(vendor_id: u16, product_id: u16) -> Result<Self> {
Self::new_with_custom_private_key(vendor_id, product_id, get_default_adb_key_path()?)
}
/// Instantiate a new [`ADBRusbDevice`] using a custom private key path
pub fn new_with_custom_private_key(
vendor_id: u16,
product_id: u16,
private_key_path: PathBuf,
) -> Result<Self> {
let transport = RusbTransport::new(vendor_id, product_id)?;
Ok(Self {
inner: ADBUSBDevice::new_from_transport(transport, Some(private_key_path))?,
})
}
/// autodetect connected ADB devices and establish a connection with the first device found
pub fn autodetect() -> Result<Self> {
Self::autodetect_with_custom_private_key(get_default_adb_key_path()?)
}
/// autodetect connected ADB devices and establish a connection with the first device found using a custom private key path
pub fn autodetect_with_custom_private_key(private_key_path: PathBuf) -> Result<Self> {
match search_adb_devices()? {
Some((vendor_id, product_id)) => {
ADBRusbDevice::new_with_custom_private_key(vendor_id, product_id, private_key_path)
}
_ => Err(RustADBError::DeviceNotFound(
"cannot find USB devices matching the signature of an ADB device".into(),
)),
}
}
}
impl ADBDeviceExt for ADBRusbDevice {
#[inline]
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
self.inner.shell_command(command, output)
}
#[inline]
fn shell<'a>(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()> {
self.inner.shell(reader, writer)
}
#[inline]
fn stat(&mut self, remote_path: &str) -> Result<crate::AdbStatResponse> {
self.inner.stat(remote_path)
}
#[inline]
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()> {
self.inner.pull(source, output)
}
#[inline]
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
self.inner.push(stream, path)
}
#[inline]
fn reboot(&mut self, reboot_type: crate::RebootType) -> Result<()> {
self.inner.reboot(reboot_type)
}
#[inline]
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
self.inner.install(apk_path)
}
#[inline]
fn uninstall(&mut self, package: &str) -> Result<()> {
self.inner.uninstall(package)
}
#[inline]
fn framebuffer_inner(&mut self) -> Result<image::ImageBuffer<image::Rgba<u8>, Vec<u8>>> {
self.inner.framebuffer_inner()
}
}

View File

@@ -1,187 +0,0 @@
use std::io::Read;
use std::io::Write;
use std::path::{Path, PathBuf};
use std::time::Duration;
use crate::ADBDeviceExt;
use crate::AUTH_TOKEN;
use crate::Result;
use crate::RustADBError;
use crate::message_devices::AUTH_RSAPUBLICKEY;
use crate::message_devices::AUTH_SIGNATURE;
use crate::message_devices::adb_message_device::ADBMessageDevice;
use crate::message_devices::adb_message_transport::ADBMessageTransport;
use crate::message_devices::adb_rsa_key::ADBRsaKey;
use crate::message_devices::adb_transport_message::ADBTransportMessage;
use crate::message_devices::message_commands::MessageCommand;
use crate::usb::read_adb_private_key;
use crate::utils::get_default_adb_key_path;
/// Private struct implementing Android USB device logic, depending on a `ADBMessageTransport`.
#[derive(Debug)]
pub(crate) struct ADBUSBDevice<T: ADBMessageTransport> {
private_key: ADBRsaKey,
inner: ADBMessageDevice<T>,
}
impl<T: ADBMessageTransport> ADBUSBDevice<T> {
/// Instantiate a new [`ADBUSBDevice`] from a [`RusbTransport`] and an optional private key path.
pub fn new_from_transport(transport: T, private_key_path: Option<PathBuf>) -> Result<Self> {
let private_key_path = match private_key_path {
Some(private_key_path) => private_key_path,
None => get_default_adb_key_path()?,
};
Self::new_from_transport_inner(transport, &private_key_path)
}
fn new_from_transport_inner(transport: T, private_key_path: &PathBuf) -> Result<Self> {
let private_key = if let Some(private_key) = read_adb_private_key(private_key_path)? {
private_key
} else {
log::warn!(
"No private key found at path {}. Using a temporary random one.",
private_key_path.display()
);
ADBRsaKey::new_random()?
};
let mut s = Self {
private_key,
inner: ADBMessageDevice::new(transport),
};
s.connect()?;
Ok(s)
}
/// Send initial connect
pub fn connect(&mut self) -> Result<()> {
self.get_transport_mut().connect()?;
let message = ADBTransportMessage::new(
MessageCommand::Cnxn,
0x0100_0000,
1_048_576,
format!("host::{}\0", env!("CARGO_PKG_NAME")).as_bytes(),
);
self.get_transport_mut().write_message(message)?;
let message = self.get_transport_mut().read_message()?;
// If the device returned CNXN instead of AUTH it does not require authentication,
// so we can skip the auth steps.
if message.header().command() == MessageCommand::Cnxn {
return Ok(());
}
message.assert_command(MessageCommand::Auth)?;
// At this point, we should have receive an AUTH message with arg0 == 1
let auth_message = match message.header().arg0() {
AUTH_TOKEN => message,
v => {
return Err(RustADBError::ADBRequestFailed(format!(
"Received AUTH message with type != 1 ({v})"
)));
}
};
let sign = self.private_key.sign(auth_message.into_payload())?;
let message = ADBTransportMessage::new(MessageCommand::Auth, AUTH_SIGNATURE, 0, &sign);
self.get_transport_mut().write_message(message)?;
let received_response = self.get_transport_mut().read_message()?;
if received_response.header().command() == MessageCommand::Cnxn {
log::info!(
"Authentication OK, device info {}",
String::from_utf8(received_response.into_payload())?
);
return Ok(());
}
let mut pubkey = self.private_key.android_pubkey_encode()?.into_bytes();
pubkey.push(b'\0');
let message = ADBTransportMessage::new(MessageCommand::Auth, AUTH_RSAPUBLICKEY, 0, &pubkey);
self.get_transport_mut().write_message(message)?;
let response = self
.get_transport_mut()
.read_message_with_timeout(Duration::from_secs(10))
.and_then(|message| {
message.assert_command(MessageCommand::Cnxn)?;
Ok(message)
})?;
log::info!(
"Authentication OK, device info {}",
String::from_utf8(response.into_payload())?
);
Ok(())
}
#[inline]
pub(crate) fn get_transport_mut(&mut self) -> &mut T {
self.inner.get_transport_mut()
}
}
impl<T: ADBMessageTransport> ADBDeviceExt for ADBUSBDevice<T> {
#[inline]
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
self.inner.shell_command(command, output)
}
#[inline]
fn shell<'a>(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()> {
self.inner.shell(reader, writer)
}
#[inline]
fn stat(&mut self, remote_path: &str) -> Result<crate::AdbStatResponse> {
self.inner.stat(remote_path)
}
#[inline]
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()> {
self.inner.pull(source, output)
}
#[inline]
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
self.inner.push(stream, path)
}
#[inline]
fn reboot(&mut self, reboot_type: crate::RebootType) -> Result<()> {
self.inner.reboot(reboot_type)
}
#[inline]
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
self.inner.install(apk_path)
}
#[inline]
fn uninstall(&mut self, package: &str) -> Result<()> {
self.inner.uninstall(package)
}
#[inline]
fn framebuffer_inner(&mut self) -> Result<image::ImageBuffer<image::Rgba<u8>, Vec<u8>>> {
self.inner.framebuffer_inner()
}
}
impl<T: ADBMessageTransport> Drop for ADBUSBDevice<T> {
fn drop(&mut self) {
// Best effort here
let _ = self.get_transport_mut().disconnect();
}
}

View File

@@ -1,69 +0,0 @@
use std::{
io::{Read, Write},
path::Path,
};
use crate::{
ADBDeviceExt, Result,
usb::{WebUsbTransport, adb_usb_device::ADBUSBDevice},
};
/// Implement Android USB device reachable over wired USB
#[derive(Debug)]
pub struct ADBWebUsbDevice {
inner: ADBUSBDevice<WebUsbTransport>,
}
impl ADBWebUsbDevice {
/// Instantiate a new [`ADBRusb`]
pub fn new(_vendor_id: u16, _product_id: u16) -> Result<Self> {
todo!()
}
}
impl ADBDeviceExt for ADBWebUsbDevice {
#[inline]
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
self.inner.shell_command(command, output)
}
#[inline]
fn shell<'a>(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()> {
self.inner.shell(reader, writer)
}
#[inline]
fn stat(&mut self, remote_path: &str) -> Result<crate::AdbStatResponse> {
self.inner.stat(remote_path)
}
#[inline]
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()> {
self.inner.pull(source, output)
}
#[inline]
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
self.inner.push(stream, path)
}
#[inline]
fn reboot(&mut self, reboot_type: crate::RebootType) -> Result<()> {
self.inner.reboot(reboot_type)
}
#[inline]
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
self.inner.install(apk_path)
}
#[inline]
fn uninstall(&mut self, package: &str) -> Result<()> {
self.inner.uninstall(package)
}
#[inline]
fn framebuffer_inner(&mut self) -> Result<image::ImageBuffer<image::Rgba<u8>, Vec<u8>>> {
self.inner.framebuffer_inner()
}
}

View File

@@ -1,7 +0,0 @@
#[cfg(feature = "rusb")]
#[cfg_attr(docsrs, doc(cfg(feature = "rusb")))]
pub mod rusb_transport;
#[cfg(feature = "webusb")]
#[cfg_attr(docsrs, doc(cfg(feature = "webusb")))]
pub mod webusb_transport;

View File

@@ -1,48 +0,0 @@
use std::time::Duration;
use crate::{
Result,
adb_transport::ADBTransport,
message_devices::{
adb_message_transport::ADBMessageTransport, adb_transport_message::ADBTransportMessage,
},
};
/// Transport running on USB using `webusb` as a backend.
#[derive(Clone, Debug)]
pub struct WebUsbTransport {}
impl WebUsbTransport {
/// Instantiate a new [`WebUsbTransport`].
/// Only the first device with given vendor_id and product_id is returned.
pub fn new() -> Self {
WebUsbTransport {}
}
}
impl ADBTransport for WebUsbTransport {
fn connect(&mut self) -> crate::Result<()> {
todo!()
}
fn disconnect(&mut self) -> crate::Result<()> {
todo!()
}
}
impl ADBMessageTransport for WebUsbTransport {
fn read_message_with_timeout(
&mut self,
_read_timeout: Duration,
) -> Result<ADBTransportMessage> {
todo!()
}
fn write_message_with_timeout(
&mut self,
message: ADBTransportMessage,
write_timeout: std::time::Duration,
) -> Result<()> {
todo!()
}
}

View File

@@ -1,78 +0,0 @@
#![doc = include_str!("./README.md")]
/// Common USB constants for Android Debug Bridge
pub mod constants {
/// Standard Android vendor ID
pub const ANDROID_VENDOR_ID: u16 = 0x18d1;
/// Common ADB product IDs
pub mod product_ids {
/// ADB interface
pub const ADB: u16 = 0x4ee7;
/// ADB + MTP
pub const ADB_MTP: u16 = 0x4ee2;
/// ADB + RNDIS
pub const ADB_RNDIS: u16 = 0x4ee4;
/// Fastboot interface
pub const FASTBOOT: u16 = 0x4ee0;
}
/// USB class codes for ADB detection
pub mod class_codes {
/// ADB subclass code
pub const ADB_SUBCLASS: u8 = 0x42;
/// ADB protocol code
pub const ADB_PROTOCOL: u8 = 0x1;
/// Bulk transfer class
pub const BULK_CLASS: u8 = 0xdc;
/// Bulk ADB subclass
pub const BULK_ADB_SUBCLASS: u8 = 2;
}
}
// ###################################################
// rusb specific modules
#[cfg(feature = "rusb")]
mod adb_rusb_device;
// Device implementations
#[cfg(feature = "rusb")]
#[cfg_attr(docsrs, doc(cfg(feature = "rusb")))]
pub use adb_rusb_device::ADBRusbDevice;
// Transport implementations
#[cfg(feature = "rusb")]
#[cfg_attr(docsrs, doc(cfg(feature = "rusb")))]
pub use backends::rusb_transport::RusbTransport;
// ###################################################
// ###################################################
// webusb specific modules
#[cfg(feature = "webusb")]
mod adb_webusb_device;
// Device implementations
#[cfg(feature = "webusb")]
#[cfg_attr(docsrs, doc(cfg(feature = "webusb")))]
pub use adb_webusb_device::ADBWebUsbDevice;
// Transport implementations
#[cfg(feature = "webusb")]
#[cfg_attr(docsrs, doc(cfg(feature = "webusb")))]
pub use backends::webusb_transport::WebUsbTransport;
// ###################################################
mod backends;
mod utils;
#[cfg(any(feature = "rusb", feature = "webusb"))]
mod adb_usb_device;
// Utility functions
#[cfg(any(feature = "rusb", feature = "webusb"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "rusb", feature = "webusb"))))]
pub use utils::read_adb_private_key;
#[cfg(feature = "rusb")]
#[cfg_attr(docsrs, doc(cfg(feature = "rusb")))]
pub use utils::{is_adb_device, search_adb_devices};

View File

@@ -1,98 +0,0 @@
//! USB utilities that are independent of specific transport implementations
use crate::message_devices::adb_rsa_key::ADBRsaKey;
use crate::{Result, RustADBError};
use std::fs::read_to_string;
use std::path::Path;
#[cfg(feature = "rusb")]
use rusb::{Device, DeviceDescriptor, UsbContext};
#[cfg(feature = "rusb")]
use rusb::constants::LIBUSB_CLASS_VENDOR_SPEC;
use crate::usb::constants::class_codes::{
ADB_PROTOCOL, ADB_SUBCLASS, BULK_ADB_SUBCLASS, BULK_CLASS,
};
/// Read an ADB private key from a file path
///
/// Returns `Ok(None)` if the file doesn't exist, `Ok(Some(key))` if the key was successfully loaded,
/// or an error if there was a problem reading the file.
pub fn read_adb_private_key<P: AsRef<Path>>(private_key_path: P) -> Result<Option<ADBRsaKey>> {
// Try to read the private key file from given path
// If the file is not found, return None
// If there is another error while reading the file, return this error
// Else, return the private key content
let pk = match read_to_string(private_key_path.as_ref()) {
Ok(pk) => pk,
Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(None),
Err(e) => return Err(e.into()),
};
match ADBRsaKey::new_from_pkcs8(&pk) {
Ok(pk) => Ok(Some(pk)),
Err(e) => Err(e),
}
}
/// Search for ADB devices connected via USB
///
/// Returns the vendor_id and product_id of the first ADB device found,
/// or `None` if no devices are found.
#[cfg(feature = "rusb")]
pub fn search_adb_devices() -> Result<Option<(u16, u16)>> {
let mut found_devices = vec![];
for device in rusb::devices()?.iter() {
let Ok(des) = device.device_descriptor() else {
continue;
};
if is_adb_device(&device, &des) {
log::debug!(
"Autodetect device {:04x}:{:04x}",
des.vendor_id(),
des.product_id()
);
found_devices.push((des.vendor_id(), des.product_id()));
}
}
match (found_devices.first(), found_devices.get(1)) {
(None, _) => Ok(None),
(Some(identifiers), None) => Ok(Some(*identifiers)),
(Some((vid1, pid1)), Some((vid2, pid2))) => Err(RustADBError::DeviceNotFound(format!(
"Found two Android devices {vid1:04x}:{pid1:04x} and {vid2:04x}:{pid2:04x}",
))),
}
}
/// Check if a USB device is an ADB device
///
/// This function inspects the device descriptor and configuration to determine
/// if it's an Android Debug Bridge device.
#[cfg(feature = "rusb")]
pub fn is_adb_device<T: UsbContext>(device: &Device<T>, des: &DeviceDescriptor) -> bool {
// Some devices require choosing the file transfer mode
// for usb debugging to take effect.
for n in 0..des.num_configurations() {
let Ok(config_des) = device.config_descriptor(n) else {
continue;
};
for interface in config_des.interfaces() {
for interface_des in interface.descriptors() {
let proto = interface_des.protocol_code();
let class = interface_des.class_code();
let subcl = interface_des.sub_class_code();
if proto == ADB_PROTOCOL
&& ((class == LIBUSB_CLASS_VENDOR_SPEC && subcl == ADB_SUBCLASS)
|| (class == BULK_CLASS && subcl == BULK_ADB_SUBCLASS))
{
return true;
}
}
}
}
false
}

View File

@@ -1,10 +1,8 @@
use std::fmt::Display; use std::fmt::Display;
use crate::{ use crate::{WaitForDeviceState, WaitForDeviceTransport};
RebootType,
server::{WaitForDeviceState, WaitForDeviceTransport},
};
use super::RebootType;
use std::net::SocketAddrV4; use std::net::SocketAddrV4;
pub(crate) enum AdbServerCommand { pub(crate) enum AdbServerCommand {
@@ -20,7 +18,9 @@ pub(crate) enum AdbServerCommand {
Pair(SocketAddrV4, String), Pair(SocketAddrV4, String),
TransportAny, TransportAny,
TransportSerial(String), TransportSerial(String),
#[cfg(feature = "mdns")]
MDNSCheck, MDNSCheck,
#[cfg(feature = "mdns")]
MDNSServices, MDNSServices,
ServerStatus, ServerStatus,
ReconnectOffline, ReconnectOffline,
@@ -79,7 +79,9 @@ impl Display for AdbServerCommand {
write!(f, "reverse:forward:{remote};{local}") write!(f, "reverse:forward:{remote};{local}")
} }
AdbServerCommand::ReverseRemoveAll => write!(f, "reverse:killforward-all"), AdbServerCommand::ReverseRemoveAll => write!(f, "reverse:killforward-all"),
#[cfg(feature = "mdns")]
AdbServerCommand::MDNSCheck => write!(f, "host:mdns:check"), AdbServerCommand::MDNSCheck => write!(f, "host:mdns:check"),
#[cfg(feature = "mdns")]
AdbServerCommand::MDNSServices => write!(f, "host:mdns:services"), AdbServerCommand::MDNSServices => write!(f, "host:mdns:services"),
AdbServerCommand::ServerStatus => write!(f, "host:server-status"), AdbServerCommand::ServerStatus => write!(f, "host:server-status"),
AdbServerCommand::Reconnect => write!(f, "reconnect"), AdbServerCommand::Reconnect => write!(f, "reconnect"),

View File

@@ -1,11 +1,8 @@
use std::fmt::Display; use std::fmt::Display;
/// Available host features.
#[derive(Debug, PartialEq)] #[derive(Debug, PartialEq)]
pub enum HostFeatures { pub enum HostFeatures {
/// Shell version 2.
ShellV2, ShellV2,
/// Command.
Cmd, Cmd,
} }

View File

@@ -1,13 +1,15 @@
mod adb_request_status; mod adb_request_status;
mod adb_server_command;
mod adb_stat_response; mod adb_stat_response;
mod framebuffer_info; mod framebuffer_info;
mod host_features; mod host_features;
mod reboot_type; mod reboot_type;
mod sync_command; mod sync_command;
pub(crate) use adb_request_status::AdbRequestStatus; pub use adb_request_status::AdbRequestStatus;
pub(crate) use adb_server_command::AdbServerCommand;
pub use adb_stat_response::AdbStatResponse; pub use adb_stat_response::AdbStatResponse;
pub(crate) use framebuffer_info::{FrameBufferInfoV1, FrameBufferInfoV2}; pub(crate) use framebuffer_info::{FrameBufferInfoV1, FrameBufferInfoV2};
pub use host_features::HostFeatures; pub use host_features::HostFeatures;
pub use reboot_type::RebootType; pub use reboot_type::RebootType;
pub(crate) use sync_command::SyncCommand; pub use sync_command::SyncCommand;

View File

@@ -1,15 +0,0 @@
# Examples
## Get available ADB devices
```rust no_run
use adb_client::server::ADBServer;
use std::net::{SocketAddrV4, Ipv4Addr};
// A custom server address can be provided
let server_ip = Ipv4Addr::new(127, 0, 0, 1);
let server_port = 5037;
let mut server = ADBServer::new(SocketAddrV4::new(server_ip, server_port));
server.devices();
```

View File

@@ -1,7 +1,7 @@
use crate::ADBTransport; use crate::ADBTransport;
use crate::Result; use crate::Result;
use crate::RustADBError; use crate::RustADBError;
use crate::server::tcp_server_transport::TCPServerTransport; use crate::TCPServerTransport;
use std::collections::HashMap; use std::collections::HashMap;
use std::net::SocketAddrV4; use std::net::SocketAddrV4;
use std::process::Command; use std::process::Command;
@@ -9,7 +9,7 @@ use std::process::Command;
/// Represents an ADB Server /// Represents an ADB Server
#[derive(Debug, Default)] #[derive(Debug, Default)]
pub struct ADBServer { pub struct ADBServer {
/// Internal [`TcpStream`], lazily initialized /// Internal [TcpStream], lazily initialized
pub(crate) transport: Option<TCPServerTransport>, pub(crate) transport: Option<TCPServerTransport>,
/// Address to connect to /// Address to connect to
pub(crate) socket_addr: Option<SocketAddrV4>, pub(crate) socket_addr: Option<SocketAddrV4>,
@@ -21,7 +21,7 @@ pub struct ADBServer {
} }
impl ADBServer { impl ADBServer {
/// Instantiates a new [`ADBServer`] /// Instantiates a new [ADBServer]
pub fn new(address: SocketAddrV4) -> Self { pub fn new(address: SocketAddrV4) -> Self {
Self { Self {
transport: None, transport: None,
@@ -31,7 +31,7 @@ impl ADBServer {
} }
} }
/// Instantiates a new [`ADBServer`] with a custom adb path /// Instantiates a new [ADBServer] with a custom adb path
pub fn new_from_path(address: SocketAddrV4, adb_path: Option<String>) -> Self { pub fn new_from_path(address: SocketAddrV4, adb_path: Option<String>) -> Self {
Self { Self {
transport: None, transport: None,
@@ -46,7 +46,7 @@ impl ADBServer {
// ADB Server is local, we start it if not already running // ADB Server is local, we start it if not already running
let mut command = Command::new(adb_path.as_deref().unwrap_or("adb")); let mut command = Command::new(adb_path.as_deref().unwrap_or("adb"));
command.arg("start-server"); command.arg("start-server");
for (env_k, env_v) in envs { for (env_k, env_v) in envs.iter() {
command.env(env_k, env_v); command.env(env_k, env_v);
} }
@@ -61,7 +61,7 @@ impl ADBServer {
match child { match child {
Ok(mut child) => { Ok(mut child) => {
if let Err(e) = child.wait() { if let Err(e) = child.wait() {
log::error!("error while starting adb server: {e}"); log::error!("error while starting adb server: {e}")
} }
} }
Err(e) => log::error!("error while starting adb server: {e}"), Err(e) => log::error!("error while starting adb server: {e}"),

View File

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

View File

@@ -1,10 +1,8 @@
use std::io::Read; use std::io::Read;
use crate::{ use crate::{
Result, RustADBError, ADBEmulatorDevice, ADBServer, ADBServerDevice, DeviceLong, DeviceShort, Result, RustADBError,
emulator::ADBEmulatorDevice, models::AdbServerCommand,
server::{ADBServer, AdbServerCommand, DeviceLong, DeviceShort},
server_device::ADBServerDevice,
}; };
impl ADBServer { impl ADBServer {
@@ -71,12 +69,12 @@ impl ADBServer {
.filter(|d| d.identifier.as_str() == name) .filter(|d| d.identifier.as_str() == name)
.collect::<Vec<DeviceShort>>() .collect::<Vec<DeviceShort>>()
.len(); .len();
if nb_devices == 1 { if nb_devices != 1 {
Ok(ADBServerDevice::new(name.to_string(), self.socket_addr))
} else {
Err(RustADBError::DeviceNotFound(format!( Err(RustADBError::DeviceNotFound(format!(
"could not find device {name}" "could not find device {name}"
))) )))
} else {
Ok(ADBServerDevice::new(name.to_string(), self.socket_addr))
} }
} }

View File

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

View File

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

View File

@@ -1,12 +1,12 @@
use std::io::BufRead; use std::io::BufRead;
use crate::{ use crate::{
Result, ADBServer, MDNSServices, Result, models::AdbServerCommand, server::models::MDNSBackend,
server::{ADBServer, AdbServerCommand, MDNSServices, models::MDNSBackend},
}; };
const OPENSCREEN_MDNS_BACKEND: &str = "ADB_MDNS_OPENSCREEN"; const OPENSCREEN_MDNS_BACKEND: &str = "ADB_MDNS_OPENSCREEN";
#[cfg(feature = "mdns")]
impl ADBServer { impl ADBServer {
/// Check if mdns discovery is available /// Check if mdns discovery is available
pub fn mdns_check(&mut self) -> Result<bool> { pub fn mdns_check(&mut self) -> Result<bool> {

View File

@@ -2,6 +2,7 @@ mod connect;
mod devices; mod devices;
mod disconnect; mod disconnect;
mod kill; mod kill;
#[cfg(feature = "mdns")]
mod mdns; mod mdns;
mod pair; mod pair;
mod reconnect; mod reconnect;

View File

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

View File

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

View File

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

View File

@@ -1,6 +1,5 @@
use crate::{ use crate::{
Result, ADBServer, Result, WaitForDeviceState, WaitForDeviceTransport, models::AdbServerCommand,
server::{ADBServer, AdbServerCommand, WaitForDeviceState, WaitForDeviceTransport},
}; };
impl ADBServer { impl ADBServer {

View File

@@ -1,12 +1,6 @@
#![doc = include_str!("./README.md")]
mod adb_server; mod adb_server;
mod adb_server_command;
mod commands; mod commands;
mod models; mod models;
mod tcp_server_transport;
pub use adb_server::ADBServer; pub use adb_server::ADBServer;
pub(crate) use adb_server_command::AdbServerCommand;
pub use models::*; pub use models::*;
pub use tcp_server_transport::TCPServerTransport;

View File

@@ -15,7 +15,7 @@ pub struct AdbVersion {
} }
impl AdbVersion { impl AdbVersion {
/// Instantiates a new [`AdbVersion`]. /// Instantiates a new [AdbVersion].
pub fn new(minor: u32, revision: u32) -> Self { pub fn new(minor: u32, revision: u32) -> Self {
Self { Self {
major: 1, major: 1,

View File

@@ -2,8 +2,7 @@ use std::str::FromStr;
use std::sync::LazyLock; use std::sync::LazyLock;
use std::{fmt::Display, str}; use std::{fmt::Display, str};
use crate::RustADBError; use crate::{DeviceState, RustADBError};
use crate::server::DeviceState;
use regex::bytes::Regex; use regex::bytes::Regex;
static DEVICES_LONG_REGEX: LazyLock<Regex> = LazyLock::new(|| { static DEVICES_LONG_REGEX: LazyLock<Regex> = LazyLock::new(|| {
@@ -87,13 +86,15 @@ impl TryFrom<&[u8]> for DeviceLong {
None => "Unk".to_string(), None => "Unk".to_string(),
Some(device) => String::from_utf8(device.as_bytes().to_vec())?, Some(device) => String::from_utf8(device.as_bytes().to_vec())?,
}, },
transport_id: (str::from_utf8( transport_id: u32::from_str_radix(
groups str::from_utf8(
.name("transport_id") groups
.ok_or(RustADBError::RegexParsingError)? .name("transport_id")
.as_bytes(), .ok_or(RustADBError::RegexParsingError)?
)?) .as_bytes(),
.parse::<u32>()?, )?,
16,
)?,
}) })
} }
} }

View File

@@ -1,7 +1,7 @@
use regex::bytes::Regex; use regex::bytes::Regex;
use std::{fmt::Display, str::FromStr, sync::LazyLock}; use std::{fmt::Display, str::FromStr, sync::LazyLock};
use crate::{RustADBError, server::DeviceState}; use crate::{DeviceState, RustADBError};
static DEVICES_REGEX: LazyLock<Regex> = static DEVICES_REGEX: LazyLock<Regex> =
LazyLock::new(|| Regex::new("^(\\S+)\t(\\w+)\n?$").expect("Cannot build devices regex")); LazyLock::new(|| Regex::new("^(\\S+)\t(\\w+)\n?$").expect("Cannot build devices regex"));

View File

@@ -2,6 +2,7 @@ mod adb_version;
mod device_long; mod device_long;
mod device_short; mod device_short;
mod device_state; mod device_state;
#[cfg(feature = "mdns")]
mod mdns_services; mod mdns_services;
mod server_status; mod server_status;
mod wait_for_device; mod wait_for_device;
@@ -10,6 +11,7 @@ pub use adb_version::AdbVersion;
pub use device_long::DeviceLong; pub use device_long::DeviceLong;
pub use device_short::DeviceShort; pub use device_short::DeviceShort;
pub use device_state::DeviceState; pub use device_state::DeviceState;
#[cfg(feature = "mdns")]
pub use mdns_services::MDNSServices; pub use mdns_services::MDNSServices;
pub use server_status::{MDNSBackend, ServerStatus}; pub use server_status::{MDNSBackend, ServerStatus};
pub use wait_for_device::{WaitForDeviceState, WaitForDeviceTransport}; pub use wait_for_device::{WaitForDeviceState, WaitForDeviceTransport};

View File

@@ -48,11 +48,11 @@ impl Display for UsbBackend {
#[derive(Debug, Clone, PartialEq, Default)] #[derive(Debug, Clone, PartialEq, Default)]
pub enum MDNSBackend { pub enum MDNSBackend {
#[default] #[default]
/// `Unknown` /// Unknown
Unknown = 0, Unknown = 0,
/// `Bonjour` /// Bonjour
Bonjour = 1, Bonjour = 1,
/// `OpenScreen` /// OpenScreen
OpenScreen = 2, OpenScreen = 2,
} }

View File

@@ -2,7 +2,7 @@ use std::fmt::Display;
use crate::RustADBError; use crate::RustADBError;
#[derive(Clone, Debug, Default)] #[derive(Clone, Debug)]
/// List of available transports to wait for. /// List of available transports to wait for.
pub enum WaitForDeviceTransport { pub enum WaitForDeviceTransport {
/// USB transport /// USB transport
@@ -10,10 +10,15 @@ pub enum WaitForDeviceTransport {
/// Local transport /// Local transport
Local, Local,
/// Any transport (default value) /// Any transport (default value)
#[default]
Any, Any,
} }
impl Default for WaitForDeviceTransport {
fn default() -> Self {
Self::Any
}
}
impl Display for WaitForDeviceTransport { impl Display for WaitForDeviceTransport {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self { match self {

View File

@@ -1,25 +0,0 @@
# Examples
## Launch a command on device
```rust no_run
use adb_client::{server::ADBServer, ADBDeviceExt};
let mut server = ADBServer::default();
let mut device = server.get_device().expect("cannot get device");
device.shell_command(&["df", "-h"], &mut std::io::stdout());
```
## Push a file to the device
```rust no_run
use adb_client::server::ADBServer;
use std::net::Ipv4Addr;
use std::fs::File;
use std::path::Path;
let mut server = ADBServer::default();
let mut device = server.get_device().expect("cannot get device");
let mut input = File::open("/tmp/file.txt").expect("Cannot open file");
device.push(&mut input, "/data/local/tmp");
```

View File

@@ -1,7 +1,4 @@
use crate::{ use crate::{ADBTransport, Result, TCPServerTransport, models::AdbServerCommand};
ADBTransport, Result,
server::{AdbServerCommand, TCPServerTransport},
};
use std::net::SocketAddrV4; use std::net::SocketAddrV4;
/// Represents a device connected to the ADB server. /// Represents a device connected to the ADB server.
@@ -9,12 +6,12 @@ use std::net::SocketAddrV4;
pub struct ADBServerDevice { pub struct ADBServerDevice {
/// Unique device identifier. /// Unique device identifier.
pub identifier: Option<String>, pub identifier: Option<String>,
/// Internal [`TCPServerTransport`] /// Internal [TCPServerTransport]
pub(crate) transport: TCPServerTransport, pub(crate) transport: TCPServerTransport,
} }
impl ADBServerDevice { impl ADBServerDevice {
/// Instantiates a new [`ADBServerDevice`], knowing its ADB identifier (as returned by `adb devices` command). /// Instantiates a new [ADBServerDevice], knowing its ADB identifier (as returned by `adb devices` command).
pub fn new(identifier: String, server_addr: Option<SocketAddrV4>) -> Self { pub fn new(identifier: String, server_addr: Option<SocketAddrV4>) -> Self {
let transport = TCPServerTransport::new_or_default(server_addr); let transport = TCPServerTransport::new_or_default(server_addr);
@@ -24,7 +21,7 @@ impl ADBServerDevice {
} }
} }
/// Instantiates a new [`ADBServerDevice`], assuming only one is currently connected. /// Instantiates a new [ADBServerDevice], assuming only one is currently connected.
pub fn autodetect(server_addr: Option<SocketAddrV4>) -> Self { pub fn autodetect(server_addr: Option<SocketAddrV4>) -> Self {
let transport = TCPServerTransport::new_or_default(server_addr); let transport = TCPServerTransport::new_or_default(server_addr);

View File

@@ -5,14 +5,12 @@ use std::{
use crate::{ use crate::{
ADBDeviceExt, Result, RustADBError, ADBDeviceExt, Result, RustADBError,
models::{AdbStatResponse, HostFeatures}, constants::BUFFER_SIZE,
server::AdbServerCommand, models::{AdbServerCommand, AdbStatResponse, HostFeatures},
}; };
use super::ADBServerDevice; use super::ADBServerDevice;
const BUFFER_SIZE: usize = 65535;
impl ADBDeviceExt for ADBServerDevice { impl ADBDeviceExt for ADBServerDevice {
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> { fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
let supported_features = self.host_features()?; let supported_features = self.host_features()?;
@@ -27,14 +25,15 @@ impl ADBDeviceExt for ADBServerDevice {
self.transport self.transport
.send_adb_request(AdbServerCommand::ShellCommand(command.join(" ")))?; .send_adb_request(AdbServerCommand::ShellCommand(command.join(" ")))?;
let mut buffer = vec![0; BUFFER_SIZE].into_boxed_slice();
loop { loop {
let mut buffer = [0; BUFFER_SIZE];
match self.transport.get_raw_connection()?.read(&mut buffer) { match self.transport.get_raw_connection()?.read(&mut buffer) {
Ok(size) => { Ok(size) => {
if size == 0 { if size == 0 {
return Ok(()); return Ok(());
} else {
output.write_all(&buffer[..size])?;
} }
output.write_all(&buffer[..size])?;
} }
Err(e) => { Err(e) => {
return Err(RustADBError::IOError(e)); return Err(RustADBError::IOError(e));
@@ -50,7 +49,7 @@ impl ADBDeviceExt for ADBServerDevice {
fn shell( fn shell(
&mut self, &mut self,
mut reader: &mut dyn Read, mut reader: &mut dyn Read,
mut writer: Box<dyn Write + Send>, 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)
@@ -68,9 +67,8 @@ impl ADBDeviceExt for ADBServerDevice {
// Reading thread, reads response from adb-server // Reading thread, reads response from adb-server
std::thread::spawn(move || -> Result<()> { std::thread::spawn(move || -> Result<()> {
let mut buffer = vec![0; BUFFER_SIZE].into_boxed_slice();
loop { loop {
let mut buffer = [0; BUFFER_SIZE];
match read_stream.read(&mut buffer) { match read_stream.read(&mut buffer) {
Ok(0) => { Ok(0) => {
read_stream.shutdown(std::net::Shutdown::Both)?; read_stream.shutdown(std::net::Shutdown::Both)?;

View File

@@ -1,4 +1,4 @@
use crate::{Result, server::AdbServerCommand, server_device::ADBServerDevice}; use crate::{ADBServerDevice, Result, models::AdbServerCommand};
impl ADBServerDevice { impl ADBServerDevice {
/// Forward socket connection /// Forward socket connection

View File

@@ -4,10 +4,8 @@ use byteorder::{LittleEndian, ReadBytesExt};
use image::{ImageBuffer, Rgba}; use image::{ImageBuffer, Rgba};
use crate::{ use crate::{
Result, RustADBError, ADBServerDevice, Result, RustADBError,
models::{FrameBufferInfoV1, FrameBufferInfoV2}, models::{AdbServerCommand, FrameBufferInfoV1, FrameBufferInfoV2},
server::AdbServerCommand,
server_device::ADBServerDevice,
}; };
impl ADBServerDevice { impl ADBServerDevice {

View File

@@ -1,5 +1,6 @@
use crate::{ use crate::{
Result, models::HostFeatures, server::AdbServerCommand, server_device::ADBServerDevice, ADBServerDevice, Result,
models::{AdbServerCommand, HostFeatures},
}; };
impl ADBServerDevice { impl ADBServerDevice {

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::{
Result, server::AdbServerCommand, server_device::ADBServerDevice, utils::check_extension_is_apk, Result, models::AdbServerCommand, server_device::ADBServerDevice, utils::check_extension_is_apk,
}; };
impl ADBServerDevice { impl ADBServerDevice {

View File

@@ -1,5 +1,6 @@
use crate::{ use crate::{
Result, models::SyncCommand, server::AdbServerCommand, server_device::ADBServerDevice, ADBServerDevice, Result,
models::{AdbServerCommand, SyncCommand},
}; };
use byteorder::{ByteOrder, LittleEndian}; use byteorder::{ByteOrder, LittleEndian};
use std::{ use std::{
@@ -25,7 +26,7 @@ impl ADBServerDevice {
// 'DONE' directly without listing anything. // 'DONE' directly without listing anything.
fn handle_list_command<S: AsRef<str>>(&mut self, path: S) -> Result<()> { fn handle_list_command<S: AsRef<str>>(&mut self, path: S) -> Result<()> {
let mut len_buf = [0_u8; 4]; let mut len_buf = [0_u8; 4];
LittleEndian::write_u32(&mut len_buf, u32::try_from(path.as_ref().len())?); 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.transport.get_raw_connection()?.write_all(&len_buf)?; self.transport.get_raw_connection()?.write_all(&len_buf)?;

View File

@@ -1,6 +1,6 @@
use std::io::{self, Write}; use std::io::{self, Write};
use crate::{ADBDeviceExt, Result, server_device::ADBServerDevice}; use crate::{ADBDeviceExt, ADBServerDevice, Result};
struct LogFilter<W: Write> { struct LogFilter<W: Write> {
writer: W, writer: W,
@@ -23,26 +23,21 @@ impl<W: Write> LogFilter<W> {
impl<W: Write> Write for LogFilter<W> { impl<W: Write> Write for LogFilter<W> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> { fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
// Add newly received bytes to the internal buffer
self.buffer.extend_from_slice(buf); self.buffer.extend_from_slice(buf);
let mut processed = 0; let buf_clone = self.buffer.clone();
while let Some(pos) = self.buffer[processed..].iter().position(|&b| b == b'\n') { let mut lines = buf_clone.split_inclusive(|&byte| byte == b'\n').peekable();
// Found a newline, need to process it
let end = processed + pos + 1; // +1 to include the '\n'
let line = &self.buffer[processed..end];
if self.should_write(line) { while let Some(line) = lines.next() {
self.writer.write_all(line)?; if lines.peek().is_some() {
if self.should_write(line) {
self.writer.write_all(line)?;
}
} else {
// This is the last (unfinished) element, we keep it for next round
self.buffer = line.to_vec();
break;
} }
processed = end;
}
// Keep only remaining bytes after the last complete line
if processed > 0 {
self.buffer.copy_within(processed.., 0);
self.buffer.truncate(self.buffer.len() - processed);
} }
Ok(buf.len()) Ok(buf.len())

View File

@@ -1,4 +1,7 @@
use crate::{Result, models::RebootType, server::AdbServerCommand, server_device::ADBServerDevice}; use crate::{
ADBServerDevice, Result,
models::{AdbServerCommand, RebootType},
};
impl ADBServerDevice { impl ADBServerDevice {
/// Reboots the device /// Reboots the device

View File

@@ -1,4 +1,4 @@
use crate::{Result, server::AdbServerCommand, server_device::ADBServerDevice}; use crate::{ADBServerDevice, Result, models::AdbServerCommand};
impl ADBServerDevice { impl ADBServerDevice {
/// Reconnect device /// Reconnect device

View File

@@ -1,10 +1,11 @@
use crate::{ use crate::{
Result, models::SyncCommand, server::AdbServerCommand, server_device::ADBServerDevice, ADBServerDevice, Result, constants,
models::{AdbServerCommand, SyncCommand},
}; };
use byteorder::{LittleEndian, ReadBytesExt}; use byteorder::{LittleEndian, ReadBytesExt};
use std::io::{BufReader, BufWriter, Read, Write}; use std::io::{BufReader, BufWriter, Read, Write};
/// Internal structure wrapping a [`std::io::Read`] and hiding underlying protocol logic. /// Internal structure wrapping a [std::io::Read] and hiding underlying protocol logic.
struct ADBRecvCommandReader<R: Read> { struct ADBRecvCommandReader<R: Read> {
inner: R, inner: R,
remaining_data_bytes_to_read: usize, remaining_data_bytes_to_read: usize,
@@ -62,8 +63,6 @@ impl<R: Read> Read for ADBRecvCommandReader<R> {
} }
} }
const BUFFER_SIZE: usize = 65535;
impl ADBServerDevice { impl ADBServerDevice {
/// Receives path to stream from the device. /// Receives path to stream from the device.
pub fn pull(&mut self, path: &dyn AsRef<str>, stream: &mut dyn Write) -> Result<()> { pub fn pull(&mut self, path: &dyn AsRef<str>, stream: &mut dyn Write) -> Result<()> {
@@ -87,14 +86,14 @@ impl ADBServerDevice {
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());
buffer.extend_from_slice(&(u32::try_from(from.as_ref().len())?).to_le_bytes()); buffer.extend_from_slice(&(from.as_ref().len() as u32).to_le_bytes());
buffer.extend_from_slice(from_as_bytes); buffer.extend_from_slice(from_as_bytes);
raw_connection.write_all(&buffer)?; raw_connection.write_all(&buffer)?;
let reader = ADBRecvCommandReader::new(raw_connection); let reader = ADBRecvCommandReader::new(raw_connection);
std::io::copy( std::io::copy(
&mut BufReader::with_capacity(BUFFER_SIZE, reader), &mut BufReader::with_capacity(constants::BUFFER_SIZE, reader),
&mut BufWriter::with_capacity(BUFFER_SIZE, output), &mut BufWriter::with_capacity(constants::BUFFER_SIZE, output),
)?; )?;
// Connection should've been left in SYNC mode by now // Connection should've been left in SYNC mode by now

View File

@@ -1,4 +1,4 @@
use crate::{Result, server::AdbServerCommand, server_device::ADBServerDevice}; use crate::{ADBServerDevice, Result, models::AdbServerCommand};
impl ADBServerDevice { impl ADBServerDevice {
/// Reverse socket connection /// Reverse socket connection

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