6 Commits

Author SHA1 Message Date
Corentin LIAUD
5b4be5d5cd feat: improve README.md 2025-09-03 20:53:57 +02:00
Corentin LIAUD
586964128f feat: improve modules ordering 2025-09-01 21:40:40 +02:00
Corentin LIAUD
042ca89f12 fix: python package build 2025-08-27 21:03:45 +02:00
Corentin LIAUD
c6b12008a8 breaking(feature): add usb feature 2025-08-27 21:00:11 +02:00
Corentin LIAUD
2bd0b2ca87 doc: add section in README.md 2025-08-27 19:44:59 +02:00
Corentin LIAUD
1589ee9da5 breaking(features): add mdns feature + example 2025-08-27 19:40:27 +02:00
115 changed files with 776 additions and 637 deletions

View File

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

View File

@@ -19,11 +19,5 @@ jobs:
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Build project
run: cargo build --release --all-features

View File

@@ -92,11 +92,6 @@ jobs:
toolchain: stable
override: true
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Build release
run: cargo build --all-features --release

2
.gitignore vendored
View File

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

View File

@@ -1,5 +1,5 @@
[workspace]
members = ["adb_cli", "adb_client", "pyadb_client"]
members = ["adb_cli", "adb_client", "examples/mdns", "pyadb_client"]
resolver = "2"
[workspace.package]
@@ -9,7 +9,7 @@ homepage = "https://github.com/cocool97/adb_client"
keywords = ["adb", "android", "tcp", "usb"]
license = "MIT"
repository = "https://github.com/cocool97/adb_client"
version = "2.1.18"
version = "2.1.16"
rust-version = "1.85.1"
# To build locally when working on a new release

View File

@@ -49,6 +49,12 @@ Provides a "real-world" usage example of this library.
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
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
[dependencies]
adb_client = { version = "^2.1.17" }
anyhow = { version = "1.0.100" }
clap = { version = "4.5.51", features = ["derive"] }
env_logger = { version = "0.11.8" }
log = { version = "0.4.28" }
adb_client = { version = "^2.0.0", features = ["mdns", "usb"] }
anyhow = { version = "1.0.94" }
clap = { version = "4.5.23", features = ["derive"] }
env_logger = { version = "0.11.5" }
log = { version = "0.4.26" }
[target.'cfg(unix)'.dependencies]
termios = { version = "0.3.3" }

View File

@@ -13,7 +13,7 @@ pub struct 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 old_termios = new_termios; // Saves previous state
new_termios.c_lflag = 0;
@@ -36,7 +36,7 @@ impl Drop for ADBTermios {
fn drop(&mut self) {
// Custom drop implementation, restores previous termios structure.
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::ADBEmulatorDevice;
use adb_client::emulator::ADBEmulatorDevice;
use crate::models::{EmuCommand, EmulatorCommand};

View File

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

View File

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

View File

@@ -7,9 +7,12 @@ mod handlers;
mod models;
mod utils;
use adb_client::{
ADBDeviceExt, ADBServer, ADBServerDevice, ADBTcpDevice, ADBUSBDevice, MDNSDiscoveryService,
};
use adb_client::ADBDeviceExt;
use adb_client::mdns::MDNSDiscoveryService;
use adb_client::server::ADBServer;
use adb_client::server_device::ADBServerDevice;
use adb_client::tcp::ADBTcpDevice;
use adb_client::usb::ADBUSBDevice;
#[cfg(any(target_os = "linux", target_os = "macos"))]
use adb_termios::ADBTermios;
@@ -79,10 +82,7 @@ fn main() -> Result<()> {
(device.boxed(), usb_command.commands)
}
MainCommand::Tcp(tcp_command) => {
let device = match tcp_command.path_to_private_key {
Some(pk) => ADBTcpDevice::new_with_custom_private_key(tcp_command.address, pk)?,
None => ADBTcpDevice::new(tcp_command.address)?,
};
let device = ADBTcpDevice::new(tcp_command.address)?;
(device.boxed(), tcp_command.commands)
}
MainCommand::Mdns => {
@@ -97,7 +97,7 @@ fn main() -> Result<()> {
"Found device {} with addresses {:?}",
device.fullname,
device.addresses
);
)
}
return Ok(service.shutdown()?);
@@ -111,7 +111,7 @@ fn main() -> Result<()> {
// Using a scope here would call drop() too early..
#[cfg(any(target_os = "linux", target_os = "macos"))]
{
let mut adb_termios = ADBTermios::new(&std::io::stdin())?;
let mut adb_termios = ADBTermios::new(std::io::stdin())?;
adb_termios.set_adb_termios()?;
device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()))?;
}
@@ -121,7 +121,7 @@ fn main() -> Result<()> {
device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()))?;
}
} 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())?;
}
}
@@ -139,7 +139,7 @@ fn main() -> Result<()> {
}
DeviceCommands::Reboot { reboot_type } => {
log::info!("Reboots device in mode {reboot_type:?}");
device.reboot(reboot_type.into())?;
device.reboot(reboot_type.into())?
}
DeviceCommands::Push { filename, path } => {
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
#[clap(short = 'p', long = "package")]
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")]
activity: String,
},

View File

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

View File

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

View File

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

View File

@@ -10,34 +10,54 @@ repository.workspace = true
rust-version.workspace = true
version.workspace = true
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[features]
default = []
mdns = ["dep:mdns-sd"]
usb = ["dep:rsa", "dep:rusb"]
[dependencies]
base64 = { version = "0.22.1" }
bincode = { version = "2.0.1", features = ["serde"] }
bincode = { version = "1.3.3" }
byteorder = { version = "1.5.0" }
chrono = { version = "0.4.42", default-features = false, features = ["std"] }
image = { version = "0.25.8", default-features = false }
log = { version = "0.4.28" }
mdns-sd = { version = "0.17.0", default-features = false, features = [
"logging",
] }
num-bigint = { version = "0.8.5", package = "num-bigint-dig" }
chrono = { version = "0.4.40", default-features = false, features = ["std"] }
homedir = { version = "= 0.3.4" }
image = { version = "0.25.5", default-features = false }
log = { version = "0.4.26" }
num-bigint = { version = "0.8.4", package = "num-bigint-dig" }
num-traits = { version = "0.2.19" }
quick-protobuf = { version = "0.8.1" }
rand = { version = "0.9.2" }
rcgen = { version = "0.14.5" }
regex = { version = "1.12.2", features = ["perf", "std", "unicode"] }
rsa = { version = "0.9.8" }
rusb = { version = "0.9.4", features = ["vendored"] }
rustls = { version = "0.23.35" }
rustls-pki-types = { version = "1.13.0" }
serde = { version = "1.0.228", features = ["derive"] }
serde_repr = { version = "0.1.20" }
rand = { version = "0.9.0" }
rcgen = { version = "0.13.1", default-features = false, features = [
"aws_lc_rs",
"pem",
] }
regex = { version = "1.11.1", features = ["perf", "std", "unicode"] }
rustls = { version = "0.23.27" }
rustls-pki-types = { version = "1.11.0" }
serde = { version = "1.0.216", features = ["derive"] }
serde_repr = { version = "0.1.19" }
sha1 = { version = "0.10.6", features = ["oid"] }
thiserror = { version = "2.0.17" }
thiserror = { version = "2.0.7" }
#########
# MDNS-only dependencies
mdns-sd = { version = "0.13.9", default-features = false, features = [
"logging",
], optional = true }
#########
#########
# USB-only dependencies
rsa = { version = "0.9.7", optional = true }
rusb = { version = "0.9.4", features = ["vendored"], optional = true }
#########
[dev-dependencies]
anyhow = { version = "1.0.100" }
criterion = { version = "0.7.0" } # Used for benchmarks
anyhow = { version = "1.0.93" }
criterion = { version = "0.6.0" } # Used for benchmarks
[[bench]]
harness = false

View File

@@ -16,6 +16,26 @@ Add `adb_client` crate as a dependency by simply adding it to your `Cargo.toml`:
adb_client = "*"
```
## Crate features
| Feature | Description | Default? |
| :-----: | :---------------------------------------------: | :------: |
| `mdns` | Enables mDNS device discovery on local network. | No |
| `usb` | Enables interactions with USB devices. | No |
To deactivate some features you can use the `default-features = false` option in your `Cargo.toml` file and manually specify the features you want to activate:
```toml
[dependencies]
adb_client = { version = "*" }
```
## Examples
Usage examples can be found in the `examples/` directory of this repository.
Some example are also provided in the various `README.md` files of modules.
## Benchmarks
Benchmarks run on `v2.0.6`, on a **Samsung S10 SM-G973F** device and an **Intel i7-1265U** CPU laptop
@@ -24,89 +44,8 @@ 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.
|File size|Sample size|`ADBServerDevice`|`adb`|Difference|
|:-------:|:---------:|:----------:|:---:|:-----:|
|10 MB|100|350,79 ms|356,30 ms|<div style="color:green">-1,57 %</div>|
|500 MB|50|15,60 s|15,64 s|<div style="color:green">-0,25 %</div>|
|1 GB|20|31,09 s|31,12 s|<div style="color:green">-0,10 %</div>|
## Examples
### 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()));
```
| File size | Sample size | `ADBServerDevice` | `adb` | Difference |
| :-------: | :---------: | :---------------: | :-------: | :------------------------------------: |
| 10 MB | 100 | 350,79 ms | 356,30 ms | <div style="color:green">-1,57 %</div> |
| 500 MB | 50 | 15,60 s | 15,64 s | <div style="color:green">-0,25 %</div> |
| 1 GB | 20 | 31,09 s | 31,12 s | <div style="color:green">-0,10 %</div> |

View File

@@ -6,7 +6,7 @@ use image::{ImageBuffer, ImageFormat, Rgba};
use crate::models::AdbStatResponse;
use crate::{RebootType, Result};
/// Trait representing all features available on both [`crate::ADBServerDevice`] and [`crate::ADBUSBDevice`]
/// Trait representing all features available on both [`crate::server_device::ADBServerDevice`] and [`crate::usb::ADBUSBDevice`]
pub trait ADBDeviceExt {
/// Runs command in a shell on the device, and write its output and error streams into output.
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()>;

View File

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

View File

@@ -1,19 +0,0 @@
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

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

View File

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

View File

@@ -1,4 +1,7 @@
use crate::{ADBEmulatorDevice, Result, emulator_device::ADBEmulatorCommand};
use crate::{
Result,
emulator::{ADBEmulatorCommand, ADBEmulatorDevice},
};
impl ADBEmulatorDevice {
/// Send a SMS to this emulator with given content with given phone number

View File

@@ -1,4 +1,7 @@
use crate::{ADBEmulatorDevice, Result, emulator_device::ADBEmulatorCommand};
use crate::{
Result,
emulator::{ADBEmulatorCommand, ADBEmulatorDevice},
};
impl ADBEmulatorDevice {
/// Send a SMS to this emulator with given content with given phone number

View File

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

View File

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

View File

@@ -4,8 +4,11 @@ use std::{
net::{SocketAddrV4, TcpStream},
};
use super::ADBTransport;
use crate::{Result, RustADBError, emulator_device::ADBEmulatorCommand};
use homedir::my_home;
use crate::{
Result, RustADBError, adb_transport::ADBTransport, emulator::models::ADBEmulatorCommand,
};
/// Emulator transport running on top on TCP.
#[derive(Debug)]
@@ -15,7 +18,7 @@ pub struct TCPEmulatorTransport {
}
impl TCPEmulatorTransport {
/// Instantiates a new instance of [`TCPEmulatorTransport`]
/// Instantiates a new instance of [TCPEmulatorTransport]
pub fn new(socket_addr: SocketAddrV4) -> Self {
Self {
socket_addr,
@@ -32,10 +35,11 @@ impl TCPEmulatorTransport {
)))
}
/// Return authentication token stored in `$HOME/.emulator_console_auth_token`
/// Return authentication token stored in $HOME/.emulator_console_auth_token
pub fn get_authentication_token(&mut self) -> Result<String> {
let Some(home) = std::env::home_dir() else {
return Err(RustADBError::NoHomeDirectory);
let home = match my_home()? {
Some(home) => home,
None => return Err(RustADBError::NoHomeDirectory),
};
let mut f = File::open(home.join(".emulator_console_auth_token"))?;
@@ -51,7 +55,7 @@ impl TCPEmulatorTransport {
self.send_command(ADBEmulatorCommand::Authenticate(token))
}
/// Send an [`ADBEmulatorCommand`] to this emulator
/// Send an [ADBEmulatorCommand] to this emulator
pub(crate) fn send_command(&mut self, command: ADBEmulatorCommand) -> Result<()> {
let mut connection = self.get_raw_connection()?;
@@ -77,11 +81,10 @@ impl TCPEmulatorTransport {
let mut line = String::new();
reader.read_line(&mut line)?;
if line.starts_with("OK") {
return Ok(());
match line.starts_with("OK") {
true => Ok(()),
false => Err(RustADBError::ADBRequestFailed(line)),
}
Err(RustADBError::ADBRequestFailed(line))
}
}

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,26 +1,17 @@
use super::{ADBRsaKey, ADBTransportMessage, MessageCommand, models::MessageSubcommand};
use crate::device::adb_transport_message::{AUTH_RSAPUBLICKEY, AUTH_SIGNATURE, AUTH_TOKEN};
use crate::{ADBMessageTransport, AdbStatResponse, Result, RustADBError, constants::BUFFER_SIZE};
use bincode::config::{Configuration, Fixint, LittleEndian, NoLimit};
use byteorder::ReadBytesExt;
use byteorder::{LittleEndian, ReadBytesExt};
use rand::Rng;
use serde::Serialize;
use serde::de::DeserializeOwned;
use std::io::{Cursor, Read, Seek};
use std::time::Duration;
const BINCODE_CONFIG: Configuration<LittleEndian, Fixint, NoLimit> = bincode::config::legacy();
use crate::{
AdbStatResponse, Result, RustADBError,
message_devices::{
adb_message_transport::ADBMessageTransport,
adb_transport_message::ADBTransportMessage,
message_commands::{MessageCommand, 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)
}
const BUFFER_SIZE: usize = 65535;
/// Generic structure representing an ADB device reachable over an [`ADBMessageTransport`].
/// Structure is totally agnostic over which transport is truly used.
@@ -49,66 +40,6 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
&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
pub(crate) fn recv_and_reply_okay(&mut self) -> Result<ADBTransportMessage> {
let message = self.transport.read_message()?;
@@ -146,7 +77,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
match len.take() {
Some(0) | None => {
rdr.seek_relative(4)?;
len.replace(u64::from(rdr.read_u32::<byteorder::LittleEndian>()?));
len.replace(rdr.read_u32::<LittleEndian>()? as u64);
}
Some(length) => {
let remaining_bytes = payload.len() as u64 - rdr.position();
@@ -162,7 +93,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
}
}
if Cursor::new(&payload[(payload.len() - 8)..(payload.len() - 4)])
.read_u32::<byteorder::LittleEndian>()?
.read_u32::<LittleEndian>()?
== MessageSubcommand::Done as u32
{
break;
@@ -177,11 +108,12 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
remote_id: u32,
mut reader: R,
) -> 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 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());
let message = ADBTransportMessage::new(
@@ -194,14 +126,16 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
self.send_and_expect_okay(message)?;
loop {
let mut buffer = vec![0; BUFFER_SIZE].into_boxed_slice();
let mut buffer = [0; BUFFER_SIZE];
match reader.read(&mut buffer) {
Ok(0) => {
// Currently file mtime is not forwarded
let subcommand_data = MessageSubcommand::Done.with_arg(0);
let serialized_message = bincode_serialize_to_vec(&subcommand_data)?;
let serialized_message = bincode::serialize(&subcommand_data)
.map_err(|_e| RustADBError::ConversionError)?;
let message = ADBTransportMessage::new(
MessageCommand::Write,
local_id,
@@ -223,9 +157,10 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
}
}
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());
let message = ADBTransportMessage::new(
@@ -250,12 +185,12 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
}
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(
MessageCommand::Write,
self.get_local_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(ADBTransportMessage::new(
@@ -267,8 +202,8 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
let response = self.transport.read_message()?;
// Skip first 4 bytes as this is the literal "STAT".
// Interesting part starts right after
bincode_deserialize_from_slice(&response.into_payload()[4..])
bincode::deserialize(&response.into_payload()[4..])
.map_err(|_e| RustADBError::ConversionError)
}
pub(crate) fn end_transaction(&mut self) -> Result<()> {
@@ -277,7 +212,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
MessageCommand::Write,
self.get_local_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()?;
Ok(())

View File

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

View File

@@ -1,7 +1,9 @@
use std::time::Duration;
use super::ADBTransport;
use crate::{Result, device::ADBTransportMessage};
use crate::{
Result, adb_transport::ADBTransport,
message_devices::adb_transport_message::ADBTransportMessage,
};
const DEFAULT_READ_TIMEOUT: Duration = Duration::from_secs(u64::MAX);
const DEFAULT_WRITE_TIMEOUT: Duration = Duration::from_secs(2);

View File

@@ -1,12 +1,6 @@
use serde::{Deserialize, Serialize};
use crate::{Result, RustADBError, device::adb_message_device};
use super::models::MessageCommand;
pub const AUTH_TOKEN: u32 = 1;
pub const AUTH_SIGNATURE: u32 = 2;
pub const AUTH_RSAPUBLICKEY: u32 = 3;
use crate::{Result, RustADBError, message_devices::message_commands::MessageCommand};
#[derive(Debug)]
pub struct ADBTransportMessage {
@@ -58,16 +52,16 @@ impl ADBTransportMessageHeader {
}
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 {
let command_u32 = command as u32;
command_u32 ^ 0xFFFF_FFFF
command_u32 ^ 0xFFFFFFFF
}
pub fn as_bytes(&self) -> Result<Vec<u8>> {
adb_message_device::bincode_serialize_to_vec(self)
bincode::serialize(&self).map_err(|_e| RustADBError::ConversionError)
}
}
@@ -117,6 +111,6 @@ impl TryFrom<[u8; 24]> for ADBTransportMessageHeader {
type Error = RustADBError;
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

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

View File

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

View File

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

View File

@@ -1,11 +1,12 @@
use std::io::Write;
use crate::{
ADBMessageTransport, Result, RustADBError,
device::{
ADBTransportMessage, MessageCommand,
adb_message_device::{self, ADBMessageDevice},
models::MessageSubcommand,
Result, RustADBError,
message_devices::{
adb_message_device::ADBMessageDevice,
adb_message_transport::ADBMessageTransport,
adb_transport_message::ADBTransportMessage,
message_commands::{MessageCommand, MessageSubcommand},
},
};
@@ -30,8 +31,9 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
std::time::Duration::from_secs(4),
)?;
let recv_buffer = MessageSubcommand::Recv.with_arg(u32::try_from(source.len())?);
let recv_buffer = adb_message_device::bincode_serialize_to_vec(&recv_buffer)?;
let recv_buffer = MessageSubcommand::Recv.with_arg(source.len() as u32);
let recv_buffer =
bincode::serialize(&recv_buffer).map_err(|_e| RustADBError::ConversionError)?;
self.send_and_expect_okay(ADBTransportMessage::new(
MessageCommand::Write,
self.get_local_id()?,

View File

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

View File

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

View File

@@ -1,10 +1,12 @@
use std::io::{ErrorKind, Read, Write};
use crate::Result;
use crate::device::ShellMessageWriter;
use crate::{
ADBMessageTransport, RustADBError,
device::{ADBMessageDevice, ADBTransportMessage, MessageCommand},
Result, RustADBError,
message_devices::{
adb_message_device::ADBMessageDevice, adb_message_transport::ADBMessageTransport,
adb_transport_message::ADBTransportMessage, commands::utils::ShellMessageWriter,
message_commands::MessageCommand,
},
};
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
@@ -60,7 +62,7 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
writer.write_all(&message.into_payload())?;
writer.flush()?;
}
MessageCommand::Okay => {}
MessageCommand::Okay => continue,
_ => return Err(RustADBError::ADBShellNotSupported),
}
}

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,8 +1,9 @@
use std::io::Write;
use crate::ADBMessageTransport;
use super::{ADBTransportMessage, models::MessageCommand};
use crate::message_devices::{
adb_message_transport::ADBMessageTransport, adb_transport_message::ADBTransportMessage,
message_commands::MessageCommand,
};
/// [`Write`] trait implementation to hide underlying ADB protocol write logic for shell commands.
pub struct ShellMessageWriter<T: ADBMessageTransport> {

View File

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

View File

@@ -0,0 +1,14 @@
/// USB-related definitions
#[cfg(feature = "usb")]
#[cfg_attr(docsrs, doc(cfg(feature = "usb")))]
pub mod usb;
/// Device reachable over TCP related definition
pub mod tcp;
mod adb_message_device;
mod adb_message_device_commands;
mod adb_message_transport;
mod adb_transport_message;
mod commands;
mod message_commands;

View File

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

View File

@@ -1,43 +1,24 @@
use std::io::Write;
use std::path::{Path, PathBuf};
use std::path::Path;
use std::{io::Read, net::SocketAddr};
use super::adb_message_device::ADBMessageDevice;
use super::models::MessageCommand;
use super::{ADBRsaKey, ADBTransportMessage, get_default_adb_key_path};
use crate::device::adb_usb_device::read_adb_private_key;
use crate::{ADBDeviceExt, ADBMessageTransport, ADBTransport, Result, TcpTransport};
use crate::message_devices::adb_message_device::ADBMessageDevice;
use crate::message_devices::adb_message_transport::ADBMessageTransport;
use crate::message_devices::adb_transport_message::ADBTransportMessage;
use crate::message_devices::message_commands::MessageCommand;
use crate::tcp::tcp_transport::TcpTransport;
use crate::{ADBDeviceExt, ADBTransport, Result};
/// Represent a device reached and available over USB.
#[derive(Debug)]
pub struct ADBTcpDevice {
private_key: ADBRsaKey,
inner: ADBMessageDevice<TcpTransport>,
}
impl ADBTcpDevice {
/// Instantiate a new [`ADBTcpDevice`]
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 {
private_key,
inner: ADBMessageDevice::new(TcpTransport::new(address)?),
};
@@ -52,8 +33,8 @@ impl ADBTcpDevice {
let message = ADBTransportMessage::new(
MessageCommand::Cnxn,
0x0100_0000,
1_048_576,
0x01000000,
1048576,
format!("host::{}\0", env!("CARGO_PKG_NAME")).as_bytes(),
);
@@ -61,28 +42,26 @@ impl ADBTcpDevice {
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() {
MessageCommand::Stls => {
self.get_transport_mut()
.write_message(ADBTransportMessage::new(MessageCommand::Stls, 1, 0, &[]))?;
self.get_transport_mut().upgrade_connection()?;
log::debug!("Connection successfully upgraded from TCP to TLS");
Ok(())
}
MessageCommand::Cnxn => {
log::debug!("Unencrypted connection established");
Ok(())
}
MessageCommand::Auth => {
log::debug!("Authentication required");
self.inner.auth_handshake(message, &self.private_key)
_ => {
return Err(crate::RustADBError::WrongResponseReceived(
"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]

View File

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

View File

@@ -5,17 +5,21 @@ use rustls::{
pki_types::{CertificateDer, PrivatePkcs8KeyDer, pem::PemObject},
};
use super::{ADBMessageTransport, ADBTransport};
use crate::{
Result, RustADBError,
device::{
ADBTransportMessage, ADBTransportMessageHeader, MessageCommand, get_default_adb_key_path,
adb_transport::ADBTransport,
message_devices::{
adb_message_transport::ADBMessageTransport,
adb_transport_message::{ADBTransportMessage, ADBTransportMessageHeader},
message_commands::MessageCommand,
},
utils::get_default_adb_key_path,
};
use std::{
fs::read_to_string,
io::{Read, Write},
net::{Shutdown, SocketAddr, TcpStream},
ops::{Deref, DerefMut},
path::PathBuf,
sync::{Arc, Mutex},
time::Duration,
@@ -119,15 +123,18 @@ impl TcpTransport {
}
pub(crate) fn upgrade_connection(&mut self) -> Result<()> {
let Some(current_connection) = self.current_connection.clone() else {
return Err(RustADBError::UpgradeError(
"cannot upgrade a non-existing connection...".into(),
));
let current_connection = match self.current_connection.clone() {
Some(current_connection) => current_connection,
None => {
return Err(RustADBError::UpgradeError(
"cannot upgrade a non-existing connection...".into(),
));
}
};
{
let mut current_conn_locked = current_connection.lock()?;
match &*current_conn_locked {
match current_conn_locked.deref() {
CurrentConnection::Tcp(tcp_stream) => {
// TODO: Check if we cannot be more precise
@@ -188,7 +195,7 @@ impl ADBTransport for TcpTransport {
log::debug!("disconnecting...");
if let Some(current_connection) = &self.current_connection {
let mut lock = current_connection.lock()?;
match &mut *lock {
match lock.deref_mut() {
CurrentConnection::Tcp(tcp_stream) => {
let _ = tcp_stream.shutdown(Shutdown::Both);
}
@@ -207,7 +214,7 @@ impl ADBMessageTransport for TcpTransport {
fn read_message_with_timeout(
&mut self,
read_timeout: std::time::Duration,
) -> Result<crate::device::ADBTransportMessage> {
) -> Result<ADBTransportMessage> {
let raw_connection_lock = self.get_current_connection()?;
let mut raw_connection = raw_connection_lock.lock()?;

View File

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

View File

@@ -6,7 +6,6 @@ use num_traits::cast::ToPrimitive;
use rsa::pkcs8::DecodePrivateKey;
use rsa::traits::PublicKeyParts;
use rsa::{Pkcs1v15Sign, RsaPrivateKey};
use std::fmt::Write;
const ADB_PRIVATE_KEY_SIZE: usize = 2048;
const ANDROID_PUBKEY_MODULUS_SIZE_WORDS: u32 = 64;
@@ -93,16 +92,15 @@ impl ADBRsaKey {
.to_u32()
.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);
encoded.push(' ');
write!(encoded, "adb_client@{}", env!("CARGO_PKG_VERSION"))
.map_err(|_| RustADBError::ConversionError)?;
encoded.push_str(&format!("adb_client@{}", env!("CARGO_PKG_VERSION")));
Ok(encoded)
encoded
}
pub fn sign(&self, msg: impl AsRef<[u8]>) -> Result<Vec<u8>> {

View File

@@ -7,14 +7,23 @@ 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::{Result, RustADBError, USBTransport};
use crate::Result;
use crate::RustADBError;
use crate::adb_transport::ADBTransport;
use crate::message_devices::adb_message_device::ADBMessageDevice;
use crate::message_devices::adb_message_transport::ADBMessageTransport;
use crate::message_devices::adb_transport_message::ADBTransportMessage;
use crate::message_devices::message_commands::MessageCommand;
use crate::usb::adb_rsa_key::ADBRsaKey;
use crate::usb::usb_transport::USBTransport;
use crate::utils::get_default_adb_key_path;
const AUTH_TOKEN: u32 = 1;
const AUTH_SIGNATURE: u32 = 2;
const AUTH_RSAPUBLICKEY: u32 = 3;
pub fn read_adb_private_key<P: AsRef<Path>>(private_key_path: P) -> Result<Option<ADBRsaKey>> {
// Try to read the private key file from given path
@@ -90,12 +99,6 @@ pub fn is_adb_device<T: UsbContext>(device: &Device<T>, des: &DeviceDescriptor)
false
}
pub fn get_default_adb_key_path() -> Result<PathBuf> {
std::env::home_dir()
.map(|home| home.join(".android").join("adbkey"))
.ok_or(RustADBError::NoHomeDirectory)
}
/// Represent a device reached and available over USB.
#[derive(Debug)]
pub struct ADBUSBDevice {
@@ -115,7 +118,7 @@ impl ADBUSBDevice {
product_id: u16,
private_key_path: PathBuf,
) -> Result<Self> {
Self::new_from_transport_inner(USBTransport::new(vendor_id, product_id)?, &private_key_path)
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.
@@ -128,21 +131,22 @@ impl ADBUSBDevice {
None => get_default_adb_key_path()?,
};
Self::new_from_transport_inner(transport, &private_key_path)
Self::new_from_transport_inner(transport, private_key_path)
}
fn new_from_transport_inner(
transport: USBTransport,
private_key_path: &PathBuf,
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 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 {
@@ -178,8 +182,8 @@ impl ADBUSBDevice {
let message = ADBTransportMessage::new(
MessageCommand::Cnxn,
0x0100_0000,
1_048_576,
0x01000000,
1048576,
format!("host::{}\0", env!("CARGO_PKG_NAME")).as_bytes(),
);
@@ -191,9 +195,55 @@ impl ADBUSBDevice {
if message.header().command() == MessageCommand::Cnxn {
return Ok(());
}
message.assert_command(MessageCommand::Auth)?;
self.inner.auth_handshake(message, &self.private_key)
// 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]

View File

@@ -0,0 +1,8 @@
#![doc = include_str!("./README.md")]
mod adb_rsa_key;
mod adb_usb_device;
mod usb_transport;
pub use adb_usb_device::ADBUSBDevice;
pub use usb_transport::USBTransport;

View File

@@ -5,10 +5,14 @@ use rusb::{
constants::LIBUSB_CLASS_VENDOR_SPEC,
};
use super::{ADBMessageTransport, ADBTransport};
use crate::{
Result, RustADBError,
device::{ADBTransportMessage, ADBTransportMessageHeader, MessageCommand},
adb_transport::ADBTransport,
message_devices::{
adb_message_transport::ADBMessageTransport,
adb_transport_message::{ADBTransportMessage, ADBTransportMessageHeader},
message_commands::MessageCommand,
},
};
#[derive(Clone, Debug)]
@@ -29,7 +33,7 @@ pub struct USBTransport {
impl USBTransport {
/// Instantiate a new [`USBTransport`].
/// Only the first device with given `vendor_id` and `product_id` is returned.
/// Only the first device with given vendor_id and product_id is returned.
pub fn new(vendor_id: u16, product_id: u16) -> Result<Self> {
for device in rusb::devices()?.iter() {
if let Ok(descriptor) = device.device_descriptor() {
@@ -90,13 +94,14 @@ impl USBTransport {
Ok(())
}
fn find_endpoints(handle: &DeviceHandle<GlobalContext>) -> Result<(Endpoint, Endpoint)> {
fn find_endpoints(&self, handle: &DeviceHandle<GlobalContext>) -> Result<(Endpoint, Endpoint)> {
let mut read_endpoint: Option<Endpoint> = None;
let mut write_endpoint: Option<Endpoint> = None;
for n in 0..handle.device().device_descriptor()?.num_configurations() {
let Ok(config_desc) = handle.device().config_descriptor(n) else {
continue;
let config_desc = match handle.device().config_descriptor(n) {
Ok(c) => c,
Err(_) => continue,
};
for interface in config_desc.interfaces() {
@@ -116,14 +121,16 @@ impl USBTransport {
Direction::In => {
if let Some(write_endpoint) = write_endpoint {
return Ok((endpoint, write_endpoint));
} else {
read_endpoint = Some(endpoint);
}
read_endpoint = Some(endpoint);
}
Direction::Out => {
if let Some(read_endpoint) = read_endpoint {
return Ok((read_endpoint, endpoint));
} else {
write_endpoint = Some(endpoint);
}
write_endpoint = Some(endpoint);
}
}
}
@@ -147,7 +154,7 @@ impl USBTransport {
let write_amount = handle.write_bulk(endpoint.address, &data[offset..end], timeout)?;
offset += write_amount;
log::trace!("wrote chunk of size {write_amount} - {offset}/{data_len}",);
log::trace!("wrote chunk of size {write_amount} - {offset}/{data_len}",)
}
if offset % max_packet_size == 0 {
@@ -163,7 +170,7 @@ impl ADBTransport for USBTransport {
fn connect(&mut self) -> crate::Result<()> {
let device = self.device.open()?;
let (read_endpoint, write_endpoint) = Self::find_endpoints(&device)?;
let (read_endpoint, write_endpoint) = self.find_endpoints(&device)?;
Self::configure_endpoint(&device, &read_endpoint)?;
log::debug!("got read endpoint: {read_endpoint:?}");

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,8 +1,10 @@
use std::fmt::Display;
use crate::{WaitForDeviceState, WaitForDeviceTransport};
use crate::{
RebootType,
server::{WaitForDeviceState, WaitForDeviceTransport},
};
use super::RebootType;
use std::net::SocketAddrV4;
pub(crate) enum AdbServerCommand {

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -4,11 +4,12 @@ use std::str::FromStr;
use byteorder::{ByteOrder, LittleEndian};
use crate::ADBTransport;
use crate::models::{AdbRequestStatus, SyncCommand};
use crate::{ADBTransport, models::AdbServerCommand};
use crate::server::AdbServerCommand;
use crate::{Result, RustADBError};
const DEFAULT_SERVER_IP: Ipv4Addr = Ipv4Addr::LOCALHOST;
const DEFAULT_SERVER_IP: Ipv4Addr = Ipv4Addr::new(127, 0, 0, 1);
const DEFAULT_SERVER_PORT: u16 = 5037;
/// Server transport running on top on TCP
@@ -25,7 +26,7 @@ impl Default for TCPServerTransport {
}
impl TCPServerTransport {
/// Instantiates a new instance of [`TCPServerTransport`]
/// Instantiates a new instance of [TCPServerTransport]
pub fn new(socket_addr: SocketAddrV4) -> Self {
Self {
socket_addr,
@@ -33,7 +34,7 @@ impl TCPServerTransport {
}
}
/// Instantiate a new instance of [`TCPServerTransport`] using given address, or default if not specified.
/// Instantiate a new instance of [TCPServerTransport] using given address, or default if not specified.
pub fn new_or_default(socket_addr: Option<SocketAddrV4>) -> Self {
match socket_addr {
Some(s) => Self::new(s),
@@ -41,7 +42,7 @@ impl TCPServerTransport {
}
}
/// Get underlying [`SocketAddrV4`]
/// Get underlying [SocketAddrV4]
pub fn get_socketaddr(&self) -> SocketAddrV4 {
self.socket_addr
}
@@ -89,7 +90,7 @@ impl TCPServerTransport {
)?)
}
/// Send the given [`SyncCommand`] to ADB server, and checks that the request has been taken in consideration.
/// Send the given [SyncCommand] to ADB server, and checks that the request has been taken in consideration.
pub(crate) fn send_sync_request(&mut self, command: SyncCommand) -> Result<()> {
// First 4 bytes are the name of the command we want to send
// (e.g. "SEND", "RECV", "STAT", "LIST")
@@ -98,7 +99,7 @@ impl TCPServerTransport {
.write_all(command.to_string().as_bytes())?)
}
/// Gets the body length from a `LittleEndian` value
/// Gets the body length from a LittleEndian value
pub(crate) fn get_body_length(&self) -> Result<u32> {
let length_buffer = self.read_body_length()?;
Ok(LittleEndian::read_u32(&length_buffer))
@@ -112,8 +113,8 @@ impl TCPServerTransport {
Ok(length_buffer)
}
/// Send the given [`AdbCommand`] to ADB server, and checks that the request has been taken in consideration.
/// If an error occurred, a [`RustADBError`] is returned with the response error string.
/// Send the given [AdbCommand] to ADB server, and checks that the request has been taken in consideration.
/// If an error occurred, a [RustADBError] is returned with the response error string.
pub(crate) fn send_adb_request(&mut self, command: AdbServerCommand) -> Result<()> {
let adb_command_string = command.to_string();
let adb_request = format!("{:04x}{}", adb_command_string.len(), adb_command_string);

View File

@@ -0,0 +1,25 @@
# 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(Path::new("/tmp/file.txt")).expect("Cannot open file");
device.push(&mut input, "/data/local/tmp");
```

View File

@@ -1,4 +1,7 @@
use crate::{ADBTransport, Result, TCPServerTransport, models::AdbServerCommand};
use crate::{
ADBTransport, Result,
server::{AdbServerCommand, TCPServerTransport},
};
use std::net::SocketAddrV4;
/// Represents a device connected to the ADB server.
@@ -6,12 +9,12 @@ use std::net::SocketAddrV4;
pub struct ADBServerDevice {
/// Unique device identifier.
pub identifier: Option<String>,
/// Internal [`TCPServerTransport`]
/// Internal [TCPServerTransport]
pub(crate) transport: TCPServerTransport,
}
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 {
let transport = TCPServerTransport::new_or_default(server_addr);
@@ -21,7 +24,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 {
let transport = TCPServerTransport::new_or_default(server_addr);

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,7 +1,7 @@
use std::{fs::File, io::Read, path::Path};
use crate::{
Result, models::AdbServerCommand, server_device::ADBServerDevice, utils::check_extension_is_apk,
Result, server::AdbServerCommand, server_device::ADBServerDevice, utils::check_extension_is_apk,
};
impl ADBServerDevice {

View File

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

View File

@@ -1,6 +1,6 @@
use std::io::{self, Write};
use crate::{ADBDeviceExt, ADBServerDevice, Result};
use crate::{ADBDeviceExt, Result, server_device::ADBServerDevice};
struct LogFilter<W: Write> {
writer: W,
@@ -23,26 +23,21 @@ impl<W: Write> LogFilter<W> {
impl<W: Write> Write for LogFilter<W> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
// Add newly received bytes to the internal buffer
self.buffer.extend_from_slice(buf);
let mut processed = 0;
while let Some(pos) = self.buffer[processed..].iter().position(|&b| b == b'\n') {
// Found a newline, need to process it
let end = processed + pos + 1; // +1 to include the '\n'
let line = &self.buffer[processed..end];
let buf_clone = self.buffer.clone();
let mut lines = buf_clone.split_inclusive(|&byte| byte == b'\n').peekable();
if self.should_write(line) {
self.writer.write_all(line)?;
while let Some(line) = lines.next() {
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())

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,6 +1,8 @@
use crate::{
ADBServerDevice, Result, RustADBError, constants,
models::{AdbRequestStatus, AdbServerCommand, SyncCommand},
Result, RustADBError,
models::{AdbRequestStatus, SyncCommand},
server::AdbServerCommand,
server_device::ADBServerDevice,
};
use std::{
convert::TryInto,
@@ -9,7 +11,7 @@ use std::{
time::SystemTime,
};
/// Internal structure wrapping a [`std::io::Write`] and hiding underlying protocol logic.
/// Internal structure wrapping a [std::io::Write] and hiding underlying protocol logic.
struct ADBSendCommandWriter<W: Write> {
inner: W,
}
@@ -40,6 +42,8 @@ impl<W: Write> Write for ADBSendCommandWriter<W> {
}
}
const BUFFER_SIZE: usize = 65535;
impl ADBServerDevice {
/// Send stream to path on the device.
pub fn push<R: Read, A: AsRef<str>>(&mut self, stream: R, path: A) -> Result<()> {
@@ -64,23 +68,22 @@ impl ADBServerDevice {
// The name of the command is already sent by get_transport()?.send_sync_request
let to_as_bytes = to.as_bytes();
let mut buffer = Vec::with_capacity(4 + to_as_bytes.len());
buffer.extend_from_slice(&(u32::try_from(to.len())?).to_le_bytes());
buffer.extend_from_slice(&(to.len() as u32).to_le_bytes());
buffer.extend_from_slice(to_as_bytes);
raw_connection.write_all(&buffer)?;
let writer = ADBSendCommandWriter::new(raw_connection);
std::io::copy(
&mut BufReader::with_capacity(constants::BUFFER_SIZE, input),
&mut BufWriter::with_capacity(constants::BUFFER_SIZE, writer),
&mut BufReader::with_capacity(BUFFER_SIZE, input),
&mut BufWriter::with_capacity(BUFFER_SIZE, writer),
)?;
// Copy is finished, we can now notify as finished
// Have to send DONE + file mtime
let Ok(last_modified) = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH) else {
return Err(RustADBError::ADBRequestFailed(
"SystemTime before UNIX EPOCH!".into(),
));
let last_modified = match SystemTime::now().duration_since(SystemTime::UNIX_EPOCH) {
Ok(n) => n,
Err(_) => panic!("SystemTime before UNIX EPOCH!"),
};
let mut done_buffer = Vec::with_capacity(8);

View File

@@ -3,14 +3,14 @@ use std::io::{Read, Write};
use byteorder::{ByteOrder, LittleEndian};
use crate::{
ADBServerDevice, Result, RustADBError,
models::{AdbServerCommand, AdbStatResponse, SyncCommand},
AdbStatResponse, Result, RustADBError, models::SyncCommand, server::AdbServerCommand,
server_device::ADBServerDevice,
};
impl ADBServerDevice {
fn handle_stat_command<S: AsRef<str>>(&mut self, path: S) -> Result<AdbStatResponse> {
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
self.transport.get_raw_connection()?.write_all(&len_buf)?;

View File

@@ -1,4 +1,4 @@
use crate::{ADBServerDevice, Result, models::AdbServerCommand};
use crate::{Result, server::AdbServerCommand, server_device::ADBServerDevice};
impl ADBServerDevice {
/// Set adb daemon to tcp/ip mode

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