163 Commits

Author SHA1 Message Date
Corentin LIAUD
e111d03e4d chore(gh_actions): add build template jobs 2025-12-27 10:33:18 +01:00
Corentin LIAUD
0e24117678 fix(clippy): clippy warnings in tests 2025-12-27 10:05:52 +01:00
Corentin LIAUD
8e89aa0d6e chore(gh_actions): use own template 2025-12-26 17:00:46 +01:00
Corentin LIAUD
f0ed96cbd5 feat(gh): add pyadb_client build on arm64 2025-12-26 12:45:11 +01:00
cocool97
e2e1ae1202 Merge pull request #156 from cocool97/mdns-feature
feat(mdns): add feature flag + example
2025-12-26 12:24:00 +01:00
Corentin LIAUD
4f26ebfe29 fix: improve workflow 2025-12-26 12:19:44 +01:00
Corentin LIAUD
2a7c9bdc57 feat(mdns): add feature flag + example 2025-12-26 12:09:02 +01:00
Corentin LIAUD
d06b157255 chore: clippy improvements 2025-12-26 11:19:46 +01:00
Corentin LIAUD
947964163b fix(adb_client): image crate had no output format by default 2025-12-26 11:12:32 +01:00
Corentin LIAUD
5075e09d0e chore(adb_cli): improve error message in case of error 2025-12-26 11:12:08 +01:00
cocool97
f1d3f8d5f2 Merge pull request #155 from cocool97/sessions
feat: Track individual sessions (local and remote id) for each operation
2025-12-26 10:57:31 +01:00
Corentin LIAUD
9016b7fab4 chore: minor code improvements 2025-12-26 10:53:26 +01:00
Corentin LIAUD
558ef4df7f Track individual sessions (local and remote id) for each operation
This allows multiple operations to be performed simultaneously

Co-authored-by: gaykitty
2025-12-26 10:41:21 +01:00
Corentin LIAUD
989ba34a20 chore: clippy lints + v2.1.19 2025-12-23 21:14:21 +01:00
cocool97
da3423bc4a Merge pull request #116 from wxitcode/feat/115
feat: add Shell v2 protocol when the host supports Shell v2.
2025-12-23 21:09:20 +01:00
Corentin LIAUD
44742ada24 chore: add shell_v2 logging 2025-12-23 21:03:19 +01:00
LIAUD Corentin
dc05e85147 fix: inverted command & args 2025-12-23 20:56:24 +01:00
wxitcode
3f1a529c2b Refactor shell command handling to support v2 2025-12-23 20:54:59 +01:00
wxitcode
c3e4ea9eb8 feat: add Shell v2 protocol when the host supports Shell v2. 2025-12-23 20:54:57 +01:00
cocool97
22ceceb26a Merge pull request #103 from J05HM0N5TER/adb-list
feat: adb list
2025-12-23 20:53:26 +01:00
Corentin LIAUD
ed242808aa feat: rebase from main branch 2025-12-23 20:48:09 +01:00
J05HM0N5TER
c49378182e feat: adb list fixes 2025-12-23 20:38:41 +01:00
LIAUD Corentin
7fbea238c0 fix: remove duplicate list command 2025-12-23 20:38:39 +01:00
J05HM0N5TER
757b0f9523 feat: adb list
ADB List (ls) for both direct device communication and for communication though the adb server.
2025-12-23 20:38:31 +01:00
Himadri Bhattacharjee
d7dbc76727 Acknowledge shell_command response with OKAY messages for long responses (#154)
* fix: acknowledge write commands to continue partial data streams

* fix: read spurious close messages with a small timeout

* fix: clippy in CI not erro'ing on warnings

* breaking: bump msrv to 1.91.0

* fix: handle as many spurious CLSE messages as possible

---------

Co-authored-by: Corentin LIAUD <corentinliaud26@gmail.com>
2025-12-23 09:16:12 +01:00
Corentin LIAUD
739b3e1cee breaking: bump msrv to 1.91.0 2025-12-22 20:20:21 +01:00
Corentin LIAUD
4193779cd4 fix: clippy in CI not erro'ing on warnings 2025-12-22 19:32:22 +01:00
Corentin LIAUD
1564e99aa7 feat: improve error management in adb_cli
- adds an explicit error message when error needs to be filled with an
  issue
- remove anyhow dependency in adb_cli
- update deps
2025-12-12 19:30:05 +01:00
Pieter
c9d5df55d4 doc: adb_tcp_device.rs usb to tcp 2025-11-15 05:36:46 +01:00
Corentin LIAUD
36097fdc07 fix: windows release build 2025-11-07 14:41:09 +01:00
Corentin LIAUD
4ab0b01e37 chore: v2.1.18 2025-11-07 14:33:19 +01:00
Corentin LIAUD
ee3d879744 chore: v2.1.18 2025-11-07 14:20:17 +01:00
Corentin LIAUD
31d5388ffa feat(pyadb_client): bump min python version to 3.10 2025-11-07 14:18:37 +01:00
Corentin LIAUD
f108b5ed5f chore(bincode): bump 2025-11-06 08:55:41 +01:00
Corentin LIAUD
46c8c54751 chore(deps): updates 2025-11-06 08:15:11 +01:00
Koji AGAWA
f616373ae2 refactor(adb_client): Simplify command handling in adb_tcp_device.rs by reducing explicit return statements 2025-11-06 08:00:43 +01:00
Koji AGAWA
c83df4309f refactor(adb_client): Extract common AUTH handshake logic to a reusable method in adb_message_device.rs 2025-11-06 08:00:43 +01:00
Koji AGAWA
88526aa943 feat(adb_client): Add support for AUTH in the TCP device 2025-11-06 08:00:43 +01:00
Koji AGAWA
8cce59193c deps(adb_client): use ring rather than aws_lc_rs in rcgen 2025-11-06 07:47:59 +01:00
Corentin LIAUD
e0b6bb0139 chore: cargo clippy -- -W clippy::pedantic 2025-10-19 14:58:35 +02:00
Corentin LIAUD
373a5265a0 chore: v2.1.17 2025-09-21 11:42:58 +02:00
yohane
060e43590d Fix:Regex expression parsing transport incorrectly 2025-09-21 11:37:37 +02:00
Corentin LIAUD
f51ba984ca impr: further improve LogFilter by removing split_inclusive 2025-09-21 11:29:05 +02:00
0vercl0k
66ebc8a030 Reword logic in LogFilter::write to avoid cloning the internal buffer 2025-09-21 11:29:05 +02:00
LIAUD Corentin
d39e98695d fix: wrong msrv badges url 2025-08-03 17:38:11 +02:00
LIAUD Corentin
34d5811420 chore: version 2.1.16 2025-08-03 17:32:50 +02:00
LIAUD Corentin
86e28a6e25 chore: add msrv badges 2025-08-03 17:31:24 +02:00
LIAUD Corentin
9f113bdb93 chore: add msrv + fix clippy lints 2025-08-03 17:27:54 +02:00
cocool97
8670d6db58 fix: use random adb key if not existing (#130) 2025-08-03 17:08:15 +02:00
LIAUD Corentin
0732a0bbad chore: v2.1.15 2025-07-27 20:20:57 +02:00
cocool97
b5673001ca feat: make search_adb_devices and is_adb_device public (#129) 2025-07-27 20:19:03 +02:00
LIAUD Corentin
81829c1523 chore: v2.1.14 2025-07-07 08:21:22 +02:00
LIAUD Corentin
b9d2b8374f dep(homedir): fix to 0.3.4 to fix windows build 2025-07-06 20:00:24 +02:00
LIAUD Corentin
5716784f5d deps(homedir): fix version 0.3.5 because of hard rust 1.88 dep 2025-07-06 19:42:15 +02:00
LIAUD Corentin
b6ddc720d8 chore(clippy): run linter 2025-07-06 19:41:58 +02:00
Sashanoraa
5438e53361 Support devices that don't do auth (#124) 2025-07-06 19:34:34 +02:00
cocool97
39a7f0a8cf chore: bump criterion + pyo3 (#122) 2025-05-24 14:56:34 +02:00
LIAUD Corentin
4129d9d218 chore: v2.1.13 2025-05-12 19:48:19 +02:00
alesharik
c23dca61d7 feat: add fastboot reboot type (#119)
* feat: add fastboot reboot type

* feat: add fastboot command to cli

---------

Co-authored-by: LIAUD Corentin <corentinliaud26@gmail.com>
2025-05-12 19:47:56 +02:00
LIAUD Corentin
2bc338fdf5 fix: add missing chrono "std" feature 2025-05-11 14:45:50 +02:00
wxitcode
728fb7da95 fix: device long parse error issue (#118)
* fix: device long parse error issue

* test: add device_long unit tests

* fix: prevent copy when parsing DeviceLong

---------

Co-authored-by: LIAUD Corentin <corentinliaud26@gmail.com>
2025-05-11 14:02:19 +02:00
LIAUD Corentin
2e762400e5 fix: reduce dependencies (#112)
- Reduce tree from 349 to 210.
- Remove unused lazy_static dependency
2025-05-09 19:37:25 +02:00
LIAUD Corentin
c85c76228d chore: version v2.1.12 2025-05-01 12:49:35 +02:00
LIAUD Corentin
e91a35b3ff chore: remove useless .cargo/config.toml file 2025-05-01 12:48:44 +02:00
LIAUD Corentin
8f979eff91 chore: improve pyadb_client README.md 2025-05-01 12:48:44 +02:00
LIAUD Corentin
af51584736 fix: #108 2025-05-01 12:48:44 +02:00
LIAUD Corentin
864bde01f6 feat: add zero-length packet if final_packet_size % endpoint_max_packet_size == 0 2025-05-01 12:48:44 +02:00
LIAUD Corentin
8361a0fe06 fix: implement Drop for USBTransport 2025-05-01 12:48:44 +02:00
LIAUD Corentin
218ec3d679 feat: add more trace info 2025-05-01 12:48:44 +02:00
LIAUD Corentin
4b817c0435 chore: remove unused feature 2025-05-01 12:48:44 +02:00
Ricardo Fernández Serrata
2dd30931f2 docs(logger): setup_logger safety assumptions (#107) 2025-04-22 08:59:23 +02:00
LIAUD Corentin
8b4602c62f chore: version 2.1.11 2025-04-13 16:40:48 +02:00
cocool97
e917a45670 feat: edition 2024 (#106) 2025-04-13 16:38:38 +02:00
cocool97
b0303ad544 feat(ci): add windows + macos build (#105)
* feat(ci): add windows + macos build
2025-04-13 16:24:49 +02:00
LIAUD Corentin
f3f95d92c2 chore: v2.1.10 2025-03-12 17:27:02 +01:00
Cendy
886adfa392 feat: adb custom path (#101)
---------

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

* chore: bump deps

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

---------

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

* feat: add push / pull methods

* feat: add shell_command for USB

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

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

* chore: minor internal changes

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

* feat: clean CLI code
2024-12-06 17:47:38 +01:00
cli
66d124475d feat: add framebuffer method to USB/TCP direct devices (#69)
* feat: store local_id and remote_id in ADBMessageDevice
2024-12-03 13:55:12 +01:00
cocool97
8c382f0bde feat: add mdns devices discovery (#54)
* feat: add mdns devices discovery

---------

Co-authored-by: Jinke <164604729+JinkeJ@users.noreply.github.com>
2024-12-01 18:39:07 +01:00
cocool97
b933ab083f feat: add benches (#58)
* feat: add benches
2024-11-30 11:34:35 +01:00
cli
2f4d13bd29 feat: create an USBTransport from a rusb::Device (#66)
This allows to be more flexible on USB device we want to connect to,
without making public API to complex
2024-11-30 10:21:21 +01:00
cli
9eeb8f7da8 feat: add direct devices TLS support; refactoring (#64)
* feat: massive internal refactoring

* feat: fix doc + add 'doc' github action

* feat: improve code; add TLS

---------

Co-authored-by: LIAUD Corentin <corentinliaud26@gmail.com>
2024-11-29 13:30:03 +01:00
cocool97
152836fe54 feat: add framebuffer_bytes method (#61)
* feat: add `framebuffer_bytes` method
2024-11-18 17:15:11 +01:00
cocool97
507796887b feat: rework USB auth (#60)
* feat: rework USB auth

* ci: run clippy with `--all-features`
2024-11-18 14:43:40 +01:00
cocool97
2f08e5e16d fix: pub export AdbStatResponse (#59)
* chore: clarify licensing

* fix: pub export AdbStatResponse
2024-11-17 18:16:20 +01:00
LIAUD Corentin
6a2d652f60 chore: version 2.0.3 2024-11-14 20:56:19 +01:00
cocool97
b7ae0b1155 feat: add install command (tcp + usb) (#56) 2024-11-14 20:48:12 +01:00
MahieDev
ec0ae681ac fix: underflow in recv (#53)
* fix: read length
2024-11-10 12:58:28 +01:00
LIAUD Corentin
61ba07ecf0 fix: minor improvments 2024-11-09 14:00:23 +01:00
Himadri Bhattacharjee
c835f20263 feat: add run_activity method and default impl for ADBDeviceExt 2024-11-09 14:00:23 +01:00
Himadri Bhattacharjee
b51965f5af feat: add adb run command with activitymanager
### Changes
- `LocalCommand` and `USBCommand` now have respective variants for "run"
- Both these impls run the shell command `am start INTENT`
2024-11-09 14:00:23 +01:00
LIAUD Corentin
66b0e4c71c license: remove license-file in favor of license 2024-11-09 13:40:59 +01:00
LIAUD Corentin
cb23fd6155 ci: add publish on crates.io 2024-11-05 08:03:33 +01:00
Rohit Sangwan
d932e93d0b Add Forward and Reverse commands 2024-11-04 08:01:54 +01:00
LIAUD Corentin
e60ae7434b ci: deb + rpm + binary upload on new release 2024-11-02 18:06:17 +01:00
LIAUD Corentin
005d864609 chore: add license file 2024-11-02 18:06:17 +01:00
LIAUD Corentin
4d8e5d9367 chore: version 2.0.1 2024-10-31 16:05:19 +01:00
Himadri Bhattacharjee
cff0e68f46 feat: autodetect an ADB device when no vendor or product ID is specified (#44)
* feat: autodetect an ADB device when no vendor or product ID is specified

### Changes

- Added methods `autodetect` to `autodetect_with_custom_private_key` to
`ADBUSBDevice`
- Added private functions to check if a usb device has the signature of
an ADB device
- Made the `vendor_id` and `product_id` USB arguments optional and
default to aforementioned methods

* fix: improve github actions workflows

---------

Co-authored-by: LIAUD Corentin <corentinliaud26@gmail.com>
2024-10-31 16:00:13 +01:00
LIAUD Corentin
266265ca35 feat: v2.0.0 2024-10-25 18:13:11 +02:00
cocool97
479d2d9ade Support devices over usb (#40)
* feat: device interactions over USB (shell, push, pull, reboot for now)

* feat: parse vid and pid from hex as seen in lsusb output (#32)

* usb: Read RSA keypair from user home or generate them (#34)

* feat read keypair from user home or generate ephemeral ones
---------

Co-authored-by: LIAUD Corentin <corentin.liaud@orange.fr>
Co-authored-by: Himadri Bhattacharjee <107522312+lavafroth@users.noreply.github.com>
2024-10-25 18:09:41 +02:00
LIAUD Corentin
c53f5cc11b feat: update workflow 2024-10-24 12:21:29 +02:00
Jinke
95fe89a12c Fix RegexParsingError when parsing device list (#37) 2024-10-11 15:43:51 +02:00
cocool97
e37b6d47cc feat: add github actions (#39) 2024-10-11 15:33:00 +02:00
cocool97
d2d9ede8ab feat: add logo + rework README.md (#38) 2024-10-10 16:41:16 +02:00
cocool97
ed884b0d27 feat: should make crate usable on Windows (#35)
Co-authored-by: LIAUD Corentin <corentin.liaud@orange.fr>
2024-10-01 19:39:25 +02:00
LIAUD Corentin
2f39c13355 feat: v1.0.7 2024-09-28 21:30:44 +02:00
LIAUD Corentin
488af2b9dd feat: improve performances of recv & send 2024-09-28 21:29:09 +02:00
LIAUD Corentin
83d716d685 release: 1.0.6 2024-09-13 13:56:42 +02:00
Samuel Cavalcanti
101fafe4ec Fix pairing (#30)
* fix: pairing code that starts with 0

* feat: add`no_run` end `std::io::stdout` to pass in examples
---------

Co-authored-by: LIAUD Corentin <corentin.liaud@orange.fr>
2024-09-13 13:49:46 +02:00
LIAUD Corentin
251276c766 feat: add logcat + log crate 2024-09-05 16:54:39 +02:00
LIAUD Corentin
d00290c450 feat: release adb_cli version 1.0.4 2024-08-09 17:25:53 +02:00
LIAUD Corentin
265971bd6d bump: version 1.0.4 2024-08-09 17:20:57 +02:00
LIAUD Corentin
7abfa451d2 feat: add emu commands interface 2024-08-09 15:32:51 +02:00
LIAUD Corentin
fbb65373a8 fix: windows server start 2024-08-02 10:51:44 +02:00
LIAUD Corentin
aa22472952 feat: license; start server if not running 2024-08-02 10:49:22 +02:00
LIAUD Corentin
2919003a9b feat: add framebuffer command 2024-07-19 14:09:10 +02:00
LIAUD Corentin
1a62105565 feat: remove serial param from functions 2024-07-17 21:48:24 +02:00
LIAUD Corentin
1805c60e32 feat: add disconnect + rework with new archi 2024-07-17 20:43:11 +02:00
Valentin MILLET
24a6e49ab8 Remove useless error when connecting device 2024-07-17 20:43:11 +02:00
Valentin MILLET
13b69120f5 Fix regex for displaying devices in long format with IP:PORT 2024-07-17 20:43:11 +02:00
Valentin MILLET
a7b4cf7d80 Add pair and connect command 2024-07-17 20:43:11 +02:00
LIAUD Corentin
1342b4c34a feat: rework interface to add new transports 2024-07-17 20:07:52 +02:00
LIAUD Corentin
8a682f7472 feat: improve TCP connection management 2024-07-15 16:31:57 +02:00
LIAUD Corentin
3d3546106e feat: add AdbTcpConnection::new_with_default method 2024-07-15 15:25:21 +02:00
LIAUD Corentin
c6ffa2ff6b fix: Error message handling when FAIL 2024-07-15 10:33:51 +02:00
LIAUD Corentin
f46c996095 release: v1.0.3 2024-07-13 19:02:52 +02:00
LIAUD Corentin
6fe4905bb7 fix: Error when reusing same connection 2024-07-13 19:01:15 +02:00
LIAUD Corentin
2a551182ec fix: README.md 2024-07-13 19:01:15 +02:00
LIAUD Corentin
3c5efb2dae fix: fix stdin read when using shell function 2024-07-13 19:01:15 +02:00
LIAUD Corentin
11d8621934 feat: clippy + bump deps 2024-06-29 12:56:34 +02:00
LIAUD Corentin
787b7b02fd fix: split get_body_length() into two methods 2024-06-29 12:37:22 +02:00
Daerckdev
b9b5c57f9d fix: get_body_length needs to handle hex length too 2024-06-20 14:28:49 +02:00
Daerckdev
84431f169f remove duplicate code 2024-06-20 14:02:54 +02:00
Daerckdev
08e9f4f512 fix: get_body_lenght method did not read bytes correctly 2024-06-20 13:16:38 +02:00
157 changed files with 7176 additions and 1227 deletions

65
.github/workflows/python-build.yml vendored Normal file
View File

@@ -0,0 +1,65 @@
name: Python - Build packages & Release
on:
push:
branches:
- main
pull_request:
release:
types: [created]
jobs:
# ============================
# BUILD (multi-architecture)
# ============================
build-python-packages:
strategy:
fail-fast: false
matrix:
arch: [x86_64, arm64]
runs-on: ${{ matrix.arch == 'arm64' && 'ubuntu-24.04-arm' || 'ubuntu-latest' }}
steps:
- uses: actions/checkout@v4
- name: Build Python stubs
run: cargo run --bin stub_gen
- name: Install Python build dependencies
run: pip install maturin==1.8.2
- name: Build Python packages
run: maturin build --sdist --release -m pyadb_client/Cargo.toml
- name: Upload wheels as artifacts
uses: actions/upload-artifact@v4
with:
name: wheels-${{ matrix.arch }}
path: target/wheels/*
if-no-files-found: error
# ================================
# PUBLISH (release creation only)
# ================================
publish:
name: Publish to PyPI & GitHub Release
if: github.event_name == 'release' && github.event.action == 'created'
needs: build-python-packages
runs-on: ubuntu-latest
steps:
- name: Download all wheels
uses: actions/download-artifact@v4
with:
path: wheels
- name: Publish Python packages to PyPI
run: maturin publish wheels/**/*.whl --non-interactive
env:
MATURIN_PYPI_TOKEN: ${{ secrets.MATURIN_PYPI_TOKEN }}
- name: Publish GitHub release artifacts
uses: softprops/action-gh-release@v2
with:
files: wheels/**/*.*

11
.github/workflows/rust-build.yml vendored Normal file
View File

@@ -0,0 +1,11 @@
name: Rust - Build
on:
push:
branches:
- main
pull_request:
jobs:
build-release:
uses: cocool97/action_templates/.github/workflows/rust-build.yml@main

11
.github/workflows/rust-quality.yml vendored Normal file
View File

@@ -0,0 +1,11 @@
name: Rust - Quality
on:
push:
branches:
- main
pull_request:
jobs:
quality:
uses: cocool97/action_templates/.github/workflows/rust-quality.yml@main

109
.github/workflows/rust-release.yml vendored Normal file
View File

@@ -0,0 +1,109 @@
name: Rust - Release creation
on:
release:
types: [created]
env:
CARGO_TERM_COLOR: always
jobs:
release-linux:
name: Linux - Build and Publish
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true
- name: Install dependencies
run: |
sudo apt update
sudo apt install -y rpm
cargo install cargo-deb
cargo install cargo-generate-rpm
- name: Publish crates
run: |
cargo publish -p adb_client --token ${CRATES_IO_TOKEN}
cargo publish -p adb_cli --token ${CRATES_IO_TOKEN}
env:
CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
- name: Build release
run: cargo build -p adb_cli --release
- name: Rename binary
run: cp target/release/adb_cli target/release/adb_cli-linux
- name: Build DEB package
run: cargo deb -p adb_cli
- name: Build RPM package
run: cargo generate-rpm -p adb_cli
- name: Upload Linux artifacts
uses: softprops/action-gh-release@v2
with:
files: |
target/debian/*.deb
target/generate-rpm/*.rpm
target/release/adb_cli-linux
release-macos:
name: macOS - Build Binary
runs-on: macos-13
steps:
- uses: actions/checkout@v4
- name: Set up Rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true
- name: Build release
run: cargo build -p adb_cli --release
- name: Rename binary
run: cp target/release/adb_cli target/release/adb_cli-macos
- name: Upload macOS binary
uses: softprops/action-gh-release@v2
with:
files: target/release/adb_cli-macos
release-windows:
name: Windows - Build Binary
runs-on: windows-latest
steps:
- uses: actions/checkout@v4
- name: Set up Rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Build release
run: cargo build -p adb_cli --release
- name: Rename binary
run: Rename-Item -Path target/release/adb_cli.exe -NewName adb_cli-windows.exe
- name: Upload Windows binary
uses: softprops/action-gh-release@v2
with:
files: target/release/adb_cli-windows.exe

7
.gitignore vendored
View File

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

View File

@@ -1,30 +1,24 @@
[package]
description = "Rust ADB (Android Debug Bridge) client library"
edition = "2021"
keywords = ["adb", "android"]
[workspace]
members = ["adb_cli", "adb_client", "pyadb_client", "examples/mdns"]
resolver = "2"
[workspace.package]
authors = ["Corentin LIAUD"]
edition = "2024"
homepage = "https://github.com/cocool97/adb_client"
keywords = ["adb", "android", "tcp", "usb"]
license = "MIT"
name = "adb_client"
readme = "README.md"
repository = "https://github.com/cocool97/adb_client"
version = "1.0.1"
version = "2.1.19"
rust-version = "1.91.0"
[lib]
name = "adb_client"
path = "src/lib.rs"
# To build locally when working on a new release
[patch.crates-io]
adb_client = { path = "./adb_client" }
[[example]]
name = "adb_cli"
path = "examples/adb_cli.rs"
[dependencies]
byteorder = { version = "1.5.0" }
chrono = { version = "0.4.37" }
lazy_static = { version = "1.4.0" }
regex = { version = "1.10.4", features = ["perf", "std", "unicode"] }
termios = { version = "0.3.3" }
thiserror = { version = "1.0.58" }
## Binary-only dependencies
## Marked as optional so that lib users do not depend on them
[dev-dependencies]
clap = { version = "4.5.4", features = ["derive"] }
[profile.release]
codegen-units = 1
debug-assertions = false
lto = "thin"
opt-level = 'z'
strip = true

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023-2024 Corentin LIAUD
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

101
README.md
View File

@@ -1,72 +1,69 @@
# adb_client
<p align="center" style="text-align: center">
<img src="assets/logo.png" width="33%">
</p>
Android Debug Bridge (ADB) client implementation in pure Rust !
<p align="center">
<p align="center">Android Debug Bridge (ADB) client implementation in pure Rust !</p>
<p align="center">
<a href="https://crates.io/crates/adb_client">
<img alt="crates.io" src="https://img.shields.io/crates/v/adb_client.svg"/>
</a>
<a href="https://crates.io/crates/adb_client">
<img alt="msrv" src="https://img.shields.io/crates/msrv/adb_client"/>
</a>
<a href="https://github.com/cocool97/adb_client/actions">
<img alt="ci status" src="https://github.com/cocool97/adb_client/actions/workflows/rust-build.yml/badge.svg"/>
</a>
<a href="https://deps.rs/repo/github/cocool97/adb_client">
<img alt="dependency status" src="https://deps.rs/repo/github/cocool97/adb_client/status.svg"/>
</a>
<a href="https://opensource.org/licenses/MIT">
<img alt="dependency status" src="https://img.shields.io/badge/License-MIT-yellow.svg"/>
</a>
</p>
</p>
Main features :
Main features of this library:
- Full Rust, no need to use shell commands
- Currently only support server TCP/IP protocol
- Full Rust, don't use `adb *` shell commands to interact with devices
- Supports
- Using ADB server as a proxy (standard behavior when using `adb` CLI)
- Connecting directly to end devices (without using adb-server)
- Over **USB**
- Over **TCP/IP**
- Implements hidden `adb` features, like `framebuffer`
- Highly configurable
- Provides wrappers to use directly from Python code
- Easy to use !
## Examples
## adb_client
First declare `adb_client` as a dependency by simply adding this to your `Cargo.toml`:
Rust library implementing both ADB protocols (server and end-devices) and providing a high-level abstraction over the many supported commands.
```toml
[dependencies]
adb_client = "*"
```
Improved documentation available [here](./adb_client/README.md).
### Launch a command on host device
## examples
```rust
use adb_client::AdbTcpConnection;
use std::net::Ipv4Addr;
Some examples showing of to use this library are available in the `examples` directory:
let mut connection = AdbTcpConnection::new(Ipv4Addr::from([127,0,0,1]), 5037).unwrap();
connection.shell_command(None, vec!["df", "-h"]);
```
- `examples/mdns`: mDNS device discovery
### Get available ADB devices
## adb_cli
```rust
use adb_client::AdbTcpConnection;
use std::net::Ipv4Addr;
Rust binary providing an improved version of Google's official `adb` CLI, by using `adb_client` library.
Provides a "real-world" usage example of this library.
let mut connection = AdbTcpConnection::new(Ipv4Addr::from([127,0,0,1]), 5037).unwrap();
connection.devices();
```
Improved documentation available [here](./adb_cli/README.md).
### Push a file to the device
## pyadb_client
```rust
use adb_client::AdbTcpConnection;
use std::net::Ipv4Addr;
use std::fs::File;
use std::path::Path;
Python wrapper using `adb_client` library to export classes usable directly from a Python environment.
let mut connection = AdbTcpConnection::new(Ipv4Addr::from([127,0,0,1]), 5037).unwrap();
let mut input = File::open(Path::new(&filename)).unwrap();
connection.send(None, &mut input, &path)?;
```
Improved documentation available [here](./pyadb_client/README.md)
## Rust binary
## Related publications
This crate also provides a lightweight binary based on the `adb_client` crate. You can install it by running the following command :
- [Diving into ADB protocol internals (1/2)](https://www.synacktiv.com/publications/diving-into-adb-protocol-internals-12)
- [Diving into ADB protocol internals (2/2)](https://www.synacktiv.com/publications/diving-into-adb-protocol-internals-22)
```shell
cargo install adb_client --example adb_cli
```
## Missing features
- USB protocol
All pull requests are welcome !
## Documentation
- <https://developer.android.com/studio/command-line/adb>
- <https://github.com/cstyan/adbDocumentation>
Some features may still be missing, all pull requests are welcome !

39
adb_cli/Cargo.toml Normal file
View File

@@ -0,0 +1,39 @@
[package]
authors.workspace = true
description = "Rust ADB (Android Debug Bridge) CLI"
edition.workspace = true
keywords.workspace = true
license.workspace = true
name = "adb_cli"
readme = "README.md"
repository.workspace = true
rust-version.workspace = true
version.workspace = true
[dependencies]
adb_client = { version = "^2.1.19", features = ["mdns"] }
clap = { version = "4.5.53", features = ["derive"] }
env_logger = { version = "0.11.8" }
log = { version = "0.4.29" }
[target.'cfg(unix)'.dependencies]
termios = { version = "0.3.3" }
#####################################
# Debian package build instructions #
#####################################
[package.metadata.deb]
assets = [
{ source = "target/release/adb_cli", dest = "usr/bin/", mode = "755" },
]
priority = "optional"
section = "utility"
##################################
# RPM package build instructions #
##################################
[package.metadata.generate-rpm]
assets = [
{ source = "target/release/adb_cli", dest = "/usr/bin/adb_cli", mode = "755" },
]
license = "MIT"

68
adb_cli/README.md Normal file
View File

@@ -0,0 +1,68 @@
# `adb_cli`
[![MIT licensed](https://img.shields.io/crates/l/adb_cli.svg)](./LICENSE-MIT)
![Crates.io Total Downloads](https://img.shields.io/crates/d/adb_cli)
![MSRV](https://img.shields.io/crates/msrv/adb_cli)
Rust binary providing an improved version of `adb` CLI.
## Rust binary
This crate provides a lightweight binary based on the `adb_client` crate. You can install it by running the following command :
```shell
cargo install adb_cli
```
Usage is quite simple, and tends to look like `adb`:
- To use ADB server as a proxy:
```bash
user@laptop ~/adb_client (main)> adb_cli local --help
Device related commands using server
Usage: adb_cli local [OPTIONS] <COMMAND>
Commands:
shell Spawn an interactive shell or run a list of commands on the device
pull Pull a file from device
push Push a file on device
stat Stat a file on device
run Run an activity on device specified by the intent
reboot Reboot the device
install Install an APK on device
framebuffer Dump framebuffer of device
host-features List available server features
list List a directory on device
logcat Get logs of device
help Print this message or the help of the given subcommand(s)
Options:
-a, --address <ADDRESS> [default: 127.0.0.1:5037]
-s, --serial <SERIAL> Serial id of a specific device. Every request will be sent to this device
-h, --help Print help
```
- To interact directly with end devices
```bash
user@laptop ~/adb_client (main)> adb_cli usb --help
Device commands via USB, no server needed
Usage: adb_cli usb [OPTIONS] --vendor-id <VID> --product-id <PID> <COMMAND>
Commands:
shell Spawn an interactive shell or run a list of commands on the device
pull Pull a file from device
push Push a file on device
stat Stat a file on device
reboot Reboot the device
help Print this message or the help of the given subcommand(s)
Options:
-v, --vendor-id <VID> Hexadecimal vendor id of this USB device
-p, --product-id <PID> Hexadecimal product id of this USB device
-k, --private-key <PATH_TO_PRIVATE_KEY> Path to a custom private key to use for authentication
-h, --help Print help
```

View File

@@ -1,8 +1,10 @@
#![cfg(any(target_os = "linux", target_os = "macos"))]
use std::os::unix::prelude::{AsRawFd, RawFd};
use termios::{tcsetattr, Termios, TCSANOW, VMIN, VTIME};
use termios::{TCSANOW, Termios, VMIN, VTIME, tcsetattr};
use crate::Result;
use crate::models::{ADBCliError, ADBCliResult};
pub struct ADBTermios {
fd: RawFd,
@@ -11,7 +13,7 @@ pub struct ADBTermios {
}
impl ADBTermios {
pub fn new(fd: impl AsRawFd) -> Result<Self> {
pub fn new(fd: &impl AsRawFd) -> Result<Self, ADBCliError> {
let mut new_termios = Termios::from_fd(fd.as_raw_fd())?;
let old_termios = new_termios; // Saves previous state
new_termios.c_lflag = 0;
@@ -25,7 +27,7 @@ impl ADBTermios {
})
}
pub fn set_adb_termios(&mut self) -> Result<()> {
pub fn set_adb_termios(&mut self) -> ADBCliResult<()> {
Ok(tcsetattr(self.fd, TCSANOW, &self.new_termios)?)
}
}
@@ -33,6 +35,8 @@ impl ADBTermios {
impl Drop for ADBTermios {
fn drop(&mut self) {
// Custom drop implementation, restores previous termios structure.
tcsetattr(self.fd, TCSANOW, &self.old_termios).unwrap();
if let Err(e) = tcsetattr(self.fd, TCSANOW, &self.old_termios) {
log::error!("Error while dropping ADBTermios: {e}");
}
}
}

View File

@@ -0,0 +1,20 @@
use adb_client::ADBEmulatorDevice;
use crate::models::{ADBCliResult, EmuCommand, EmulatorCommand};
pub fn handle_emulator_commands(emulator_command: EmulatorCommand) -> ADBCliResult<()> {
let mut emulator = ADBEmulatorDevice::new(emulator_command.serial, None)?;
match emulator_command.command {
EmuCommand::Sms {
phone_number,
content,
} => {
emulator.send_sms(&phone_number, &content)?;
log::info!("SMS sent to {phone_number}");
}
EmuCommand::Rotate => emulator.rotate()?,
}
Ok(())
}

View File

@@ -0,0 +1,85 @@
use adb_client::{ADBServer, DeviceShort, MDNSBackend, Result, WaitForDeviceState};
use crate::models::{HostCommand, MdnsCommand, ServerCommand};
pub fn handle_host_commands(server_command: ServerCommand<HostCommand>) -> Result<()> {
let mut adb_server = ADBServer::new(server_command.address);
match server_command.command {
HostCommand::Version => {
let version = adb_server.version()?;
log::info!("Android Debug Bridge version {version}");
log::info!("Package version {}-rust", std::env!("CARGO_PKG_VERSION"));
}
HostCommand::Kill => {
adb_server.kill()?;
}
HostCommand::Devices { long } => {
if long {
log::info!("List of devices attached (extended)");
for device in adb_server.devices_long()? {
log::info!("{device}");
}
} else {
log::info!("List of devices attached");
for device in adb_server.devices()? {
log::info!("{device}");
}
}
}
HostCommand::TrackDevices => {
let callback = |device: DeviceShort| {
log::info!("{device}");
Ok(())
};
log::info!("Live list of devices attached");
adb_server.track_devices(callback)?;
}
HostCommand::Pair { address, code } => {
adb_server.pair(address, code)?;
log::info!("Paired device {address}");
}
HostCommand::Connect { address } => {
adb_server.connect_device(address)?;
log::info!("Connected to {address}");
}
HostCommand::Disconnect { address } => {
adb_server.disconnect_device(address)?;
log::info!("Disconnected {address}");
}
HostCommand::Mdns { subcommand } => match subcommand {
MdnsCommand::Check => {
let check = adb_server.mdns_check()?;
let server_status = adb_server.server_status()?;
match server_status.mdns_backend {
MDNSBackend::Unknown => log::info!("unknown mdns backend..."),
MDNSBackend::Bonjour => {
if check {
log::info!("mdns daemon version [Bonjour]");
} else {
log::info!("ERROR: mdns daemon unavailable");
}
}
MDNSBackend::OpenScreen => {
log::info!("mdns daemon version [Openscreen discovery 0.0.0]");
}
}
}
MdnsCommand::Services => {
log::info!("List of discovered mdns services");
for service in adb_server.mdns_services()? {
log::info!("{service}");
}
}
},
HostCommand::ServerStatus => {
log::info!("{}", adb_server.server_status()?);
}
HostCommand::WaitForDevice { transport } => {
log::info!("waiting for device to be connected...");
adb_server.wait_for_device(WaitForDeviceState::Device, transport)?;
}
}
Ok(())
}

View File

@@ -0,0 +1,33 @@
use std::{fs::File, io::Write};
use crate::ADBCliResult;
use crate::models::LocalDeviceCommand;
use adb_client::ADBServerDevice;
pub fn handle_local_commands(
mut device: ADBServerDevice,
local_device_commands: LocalDeviceCommand,
) -> ADBCliResult<()> {
match local_device_commands {
LocalDeviceCommand::HostFeatures => {
let features = device
.host_features()?
.iter()
.map(ToString::to_string)
.reduce(|a, b| format!("{a},{b}"))
.unwrap_or_default();
log::info!("Available host features: {features}");
Ok(())
}
LocalDeviceCommand::Logcat { path } => {
let writer: Box<dyn Write> = if let Some(path) = path {
let f = File::create(path)?;
Box::new(f)
} else {
Box::new(std::io::stdout())
};
Ok(device.get_logs(writer)?)
}
}
}

View File

@@ -0,0 +1,7 @@
mod emulator_commands;
mod host_commands;
mod local_commands;
pub use emulator_commands::handle_emulator_commands;
pub use host_commands::handle_host_commands;
pub use local_commands::handle_local_commands;

201
adb_cli/src/main.rs Normal file
View File

@@ -0,0 +1,201 @@
#![doc = include_str!("../README.md")]
#[cfg(any(target_os = "linux", target_os = "macos"))]
mod adb_termios;
mod handlers;
mod models;
mod utils;
use adb_client::{
ADBDeviceExt, ADBListItemType, ADBServer, ADBServerDevice, ADBTcpDevice, ADBUSBDevice,
mdns::MDNSDiscoveryService,
};
#[cfg(any(target_os = "linux", target_os = "macos"))]
use adb_termios::ADBTermios;
use clap::Parser;
use handlers::{handle_emulator_commands, handle_host_commands, handle_local_commands};
use models::{DeviceCommands, LocalCommand, MainCommand, Opts};
use std::collections::HashMap;
use std::fs::File;
use std::io::Write;
use std::path::Path;
use std::process::ExitCode;
use utils::setup_logger;
use crate::models::{ADBCliError, ADBCliResult};
fn run_command(mut device: Box<dyn ADBDeviceExt>, command: DeviceCommands) -> ADBCliResult<()> {
match command {
DeviceCommands::Shell { commands } => {
if commands.is_empty() {
// Need to duplicate some code here as ADBTermios [Drop] implementation resets terminal state.
// Using a scope here would call drop() too early..
#[cfg(any(target_os = "linux", target_os = "macos"))]
{
let mut adb_termios = ADBTermios::new(&std::io::stdin())?;
adb_termios.set_adb_termios()?;
device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()))?;
}
#[cfg(not(any(target_os = "linux", target_os = "macos")))]
{
device.shell(&mut std::io::stdin(), Box::new(std::io::stdout()))?;
}
} else {
let commands: Vec<&str> = commands.iter().map(String::as_str).collect();
device.shell_command(&commands, &mut std::io::stdout())?;
}
}
DeviceCommands::Pull {
source,
destination,
} => {
let mut output = File::create(Path::new(&destination))?;
device.pull(&source, &mut output)?;
log::info!("Downloaded {source} as {destination}");
}
DeviceCommands::Stat { path } => {
let stat_response = device.stat(&path)?;
println!("{stat_response}");
}
DeviceCommands::Reboot { reboot_type } => {
log::info!("Reboots device in mode {reboot_type:?}");
device.reboot(reboot_type.into())?;
}
DeviceCommands::Push { filename, path } => {
let mut input = File::open(Path::new(&filename))?;
device.push(&mut input, &path)?;
log::info!("Uploaded {filename} to {path}");
}
DeviceCommands::Run { package, activity } => {
let output = device.run_activity(&package, &activity)?;
std::io::stdout().write_all(&output)?;
}
DeviceCommands::Install { path } => {
log::info!("Starting installation of APK {}...", path.display());
device.install(&path)?;
}
DeviceCommands::Uninstall { package } => {
log::info!("Uninstalling the package {package}...");
device.uninstall(&package)?;
}
DeviceCommands::Framebuffer { path } => {
device.framebuffer(&path)?;
log::info!("Successfully dumped framebuffer at path {path}");
}
DeviceCommands::List { path } => {
let dirs = device.list(&path)?;
for dir in dirs {
let list_item_type = match dir.item_type {
ADBListItemType::File => "File".to_string(),
ADBListItemType::Directory => "Directory".to_string(),
ADBListItemType::Symlink => "Symlink".to_string(),
};
log::info!(
"type: {}, name: {}, time: {}, size: {}, permissions: {:#o}",
list_item_type,
dir.name,
dir.time,
dir.size,
dir.permissions
);
}
}
}
Ok(())
}
fn main() -> ExitCode {
if let Err(err) = inner_main() {
log::error!("{err}");
return ExitCode::FAILURE;
}
ExitCode::SUCCESS
}
fn inner_main() -> ADBCliResult<()> {
// This depends on `clap`
let opts = Opts::parse();
setup_logger(opts.debug);
// Directly handling methods / commands that aren't linked to [`ADBDeviceExt`] trait.
// Other methods just have to create a concrete [`ADBDeviceExt`] instance, and return it.
// This instance will then be used to execute desired command.
let (device, commands) = match opts.command {
MainCommand::Host(server_command) => return Ok(handle_host_commands(server_command)?),
MainCommand::Emu(emulator_command) => return handle_emulator_commands(emulator_command),
MainCommand::Local(server_command) => {
// Must start server to communicate with device, but only if this is a local one.
let server_address_ip = server_command.address.ip();
if server_address_ip.is_loopback() || server_address_ip.is_unspecified() {
ADBServer::start(&HashMap::default(), &None);
}
let device = match server_command.serial {
Some(serial) => ADBServerDevice::new(serial, Some(server_command.address)),
None => ADBServerDevice::autodetect(Some(server_command.address)),
};
match server_command.command {
LocalCommand::DeviceCommands(device_commands) => (device.boxed(), device_commands),
LocalCommand::LocalDeviceCommand(local_device_command) => {
return handle_local_commands(device, local_device_command);
}
}
}
MainCommand::Usb(usb_command) => {
let device = match (usb_command.vendor_id, usb_command.product_id) {
(Some(vid), Some(pid)) => match usb_command.path_to_private_key {
Some(pk) => ADBUSBDevice::new_with_custom_private_key(vid, pid, pk)?,
None => ADBUSBDevice::new(vid, pid)?,
},
(None, None) => match usb_command.path_to_private_key {
Some(pk) => ADBUSBDevice::autodetect_with_custom_private_key(pk)?,
None => ADBUSBDevice::autodetect()?,
},
_ => {
return Err(ADBCliError::Standard(
"cannot specify flags --vendor-id without --product-id or vice versa"
.into(),
));
}
};
(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)?,
};
(device.boxed(), tcp_command.commands)
}
MainCommand::Mdns => {
let mut service = MDNSDiscoveryService::new()?;
let (tx, rx) = std::sync::mpsc::channel();
service.start(tx)?;
log::info!("Starting mdns discovery...");
while let Ok(device) = rx.recv() {
log::info!(
"Found device fullname='{}' with ipv4 addresses={:?} and ipv6 addresses={:?}",
device.fullname,
device.ipv4_addresses(),
device.ipv6_addresses()
);
}
return Ok(service.shutdown()?);
}
};
run_command(device, commands)?;
Ok(())
}

View File

@@ -0,0 +1,84 @@
use std::fmt::Display;
use adb_client::RustADBError;
pub type ADBCliResult<T> = Result<T, ADBCliError>;
pub enum ADBCliError {
Standard(Box<dyn std::error::Error>),
MayNeedAnIssue(Box<dyn std::error::Error>),
}
impl Display for ADBCliError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
ADBCliError::Standard(error) => write!(f, "{error}"),
ADBCliError::MayNeedAnIssue(error) => {
write!(
f,
r"Error: {error}
An unexpected error occurred and may indicate a bug.
Please report this issue on the project repository (including steps to reproduce if possible): https://github.com/cocool97/adb_client/issues.",
)
}
}
}
}
impl From<std::io::Error> for ADBCliError {
fn from(value: std::io::Error) -> Self {
// We do not consider adb_cli related `std::io::error` as critical
Self::Standard(Box::new(value))
}
}
impl From<adb_client::RustADBError> for ADBCliError {
fn from(value: adb_client::RustADBError) -> Self {
let value = Box::new(value);
match value.as_ref() {
// List of [`RustADBError`] that may need an issue as abnormal
RustADBError::RegexParsingError
| RustADBError::WrongResponseReceived(_, _)
| RustADBError::FramebufferImageError(_)
| RustADBError::FramebufferConversionError
| RustADBError::UnimplementedFramebufferImageVersion(_)
| RustADBError::IOError(_)
| RustADBError::ADBRequestFailed(_)
| RustADBError::UnknownDeviceState(_)
| RustADBError::Utf8StrError(_)
| RustADBError::Utf8StringError(_)
| RustADBError::RegexError(_)
| RustADBError::ParseIntError(_)
| RustADBError::ConversionError
| RustADBError::IntegerConversionError(_)
| RustADBError::HomeError
| RustADBError::NoHomeDirectory
| RustADBError::UsbError(_)
| RustADBError::InvalidIntegrity(_, _)
| RustADBError::Base64DecodeError(_)
| RustADBError::Base64EncodeError(_)
| RustADBError::RSAError(_)
| RustADBError::TryFromSliceError(_)
| RustADBError::RsaPkcs8Error(_)
| RustADBError::CertificateGenerationError(_)
| RustADBError::TLSError(_)
| RustADBError::PemCertError(_)
| RustADBError::PoisonError
| RustADBError::UpgradeError(_)
| RustADBError::MDNSError(_)
| RustADBError::SendError
| RustADBError::UnknownFileMode(_)
| RustADBError::UnknownTransport(_) => Self::MayNeedAnIssue(value),
// List of [`RustADBError`] that may occur in standard contexts and therefore do not require for issues
RustADBError::ADBDeviceNotPaired
| RustADBError::UnknownResponseType(_)
| RustADBError::DeviceNotFound(_)
| RustADBError::USBNoDescriptorFound
| RustADBError::ADBShellNotSupported
| RustADBError::USBDeviceNotFound(_, _)
| RustADBError::WrongFileExtension(_)
| RustADBError::AddrParseError(_) => Self::Standard(value),
}
}
}

View File

@@ -0,0 +1,51 @@
use std::path::PathBuf;
use clap::Parser;
use super::RebootTypeCommand;
#[derive(Parser, Debug)]
pub enum DeviceCommands {
/// Spawn an interactive shell or run a list of commands on the device
Shell { commands: Vec<String> },
/// Pull a file from device
Pull { source: String, destination: String },
/// Push a file on device
Push { filename: String, path: String },
/// Stat a file on device
Stat { path: String },
/// Run an activity on device specified by the intent
Run {
/// The package whose activity is to be invoked
#[clap(short = 'p', long = "package")]
package: String,
/// The activity to be invoked itself, Usually it is `MainActivity`
#[clap(short = 'a', long = "activity")]
activity: String,
},
/// Reboot the device
Reboot {
#[clap(subcommand)]
reboot_type: RebootTypeCommand,
},
/// Install an APK on device
Install {
/// Path to APK file. Extension must be ".apk"
path: PathBuf,
},
/// Uninstall a package from the device
Uninstall {
/// Name of the package to uninstall
package: String,
},
/// Dump framebuffer of device
Framebuffer {
/// Framebuffer image destination path
path: String,
},
/// List files on device
List {
/// Path to list files from
path: String,
},
}

20
adb_cli/src/models/emu.rs Normal file
View File

@@ -0,0 +1,20 @@
use clap::{Parser, Subcommand};
#[derive(Debug, Parser)]
pub struct EmulatorCommand {
#[clap(short = 's', long = "serial")]
pub serial: String,
#[clap(subcommand)]
pub command: EmuCommand,
}
#[derive(Debug, Subcommand)]
pub enum EmuCommand {
/// Send a SMS with given phone number and given content
Sms {
phone_number: String,
content: String,
},
/// Rotate device screen from 90°
Rotate,
}

View File

@@ -0,0 +1,52 @@
use std::{net::SocketAddrV4, str::FromStr};
use adb_client::{RustADBError, WaitForDeviceTransport};
use clap::Parser;
fn parse_wait_for_device_device_transport(
value: &str,
) -> Result<WaitForDeviceTransport, RustADBError> {
WaitForDeviceTransport::from_str(value)
}
#[derive(Parser, Debug)]
pub enum HostCommand {
/// Print current ADB version.
Version,
/// Ask ADB server to quit immediately.
Kill,
/// List connected devices.
Devices {
#[clap(short = 'l', long = "long")]
long: bool,
},
/// Track new devices showing up.
TrackDevices,
/// Pair device with a given code
Pair { address: SocketAddrV4, code: String },
/// Connect device over WI-FI
Connect { address: SocketAddrV4 },
/// Disconnect device over WI-FI
Disconnect { address: SocketAddrV4 },
/// MDNS services
Mdns {
#[clap(subcommand)]
subcommand: MdnsCommand,
},
/// Display server status
ServerStatus,
/// Wait for a device, on optionally given transport
WaitForDevice {
/// Transport on which wait for devices
#[clap(short = 't', long = "transport", value_parser = parse_wait_for_device_device_transport)]
transport: Option<WaitForDeviceTransport>,
},
}
#[derive(Parser, Debug)]
pub enum MdnsCommand {
/// Check mdns status
Check,
/// List mdns services available
Services,
}

View File

@@ -0,0 +1,22 @@
use clap::Parser;
use super::DeviceCommands;
#[derive(Parser, Debug)]
pub enum LocalCommand {
#[clap(flatten)]
DeviceCommands(DeviceCommands),
#[clap(flatten)]
LocalDeviceCommand(LocalDeviceCommand),
}
#[derive(Parser, Debug)]
pub enum LocalDeviceCommand {
/// List available server features.
HostFeatures,
/// Get logs of device
Logcat {
/// Path to output file (created if not exists)
path: Option<String>,
},
}

19
adb_cli/src/models/mod.rs Normal file
View File

@@ -0,0 +1,19 @@
mod adb_cli_error;
mod device;
mod emu;
mod host;
mod local;
mod opts;
mod reboot_type;
mod tcp;
mod usb;
pub use adb_cli_error::{ADBCliError, ADBCliResult};
pub use device::DeviceCommands;
pub use emu::{EmuCommand, EmulatorCommand};
pub use host::{HostCommand, MdnsCommand};
pub use local::{LocalCommand, LocalDeviceCommand};
pub use opts::{MainCommand, Opts, ServerCommand};
pub use reboot_type::RebootTypeCommand;
pub use tcp::TcpCommand;
pub use usb::UsbCommand;

View File

@@ -0,0 +1,41 @@
use std::net::SocketAddrV4;
use clap::{Parser, Subcommand};
use super::{EmulatorCommand, HostCommand, LocalCommand, TcpCommand, UsbCommand};
#[derive(Debug, Parser)]
#[clap(about, version, author)]
pub struct Opts {
#[clap(long = "debug")]
pub debug: bool,
#[clap(subcommand)]
pub command: MainCommand,
}
#[derive(Debug, Parser)]
pub enum MainCommand {
/// Server related commands
Host(ServerCommand<HostCommand>),
/// Device related commands using server
Local(ServerCommand<LocalCommand>),
/// Emulator related commands
Emu(EmulatorCommand),
/// USB device related commands
Usb(UsbCommand),
/// TCP device related commands
Tcp(TcpCommand),
/// MDNS discovery related commands
Mdns,
}
#[derive(Debug, Parser)]
pub struct ServerCommand<T: Subcommand> {
#[clap(short = 'a', long = "address", default_value = "127.0.0.1:5037")]
pub address: SocketAddrV4,
/// Serial id of a specific device. Every request will be sent to this device.
#[clap(short = 's', long = "serial")]
pub serial: Option<String>,
#[clap(subcommand)]
pub command: T,
}

View File

@@ -0,0 +1,25 @@
use adb_client::RebootType;
use clap::Parser;
#[derive(Parser, Debug)]
pub enum RebootTypeCommand {
System,
Bootloader,
Recovery,
Sideload,
SideloadAutoReboot,
Fastboot,
}
impl From<RebootTypeCommand> for RebootType {
fn from(value: RebootTypeCommand) -> Self {
match value {
RebootTypeCommand::System => RebootType::System,
RebootTypeCommand::Bootloader => RebootType::Bootloader,
RebootTypeCommand::Recovery => RebootType::Recovery,
RebootTypeCommand::Sideload => RebootType::Sideload,
RebootTypeCommand::SideloadAutoReboot => RebootType::SideloadAutoReboot,
RebootTypeCommand::Fastboot => RebootType::Fastboot,
}
}
}

15
adb_cli/src/models/tcp.rs Normal file
View File

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

25
adb_cli/src/models/usb.rs Normal file
View File

@@ -0,0 +1,25 @@
use std::num::ParseIntError;
use std::path::PathBuf;
use clap::Parser;
use super::DeviceCommands;
fn parse_hex_id(id: &str) -> Result<u16, ParseIntError> {
u16::from_str_radix(id, 16)
}
#[derive(Parser, Debug)]
pub struct UsbCommand {
/// Hexadecimal vendor id of this USB device
#[clap(short = 'v', long = "vendor-id", value_parser=parse_hex_id, value_name="VID")]
pub vendor_id: Option<u16>,
/// Hexadecimal product id of this USB device
#[clap(short = 'p', long = "product-id", value_parser=parse_hex_id, value_name="PID")]
pub product_id: Option<u16>,
/// Path to a custom private key to use for authentication
#[clap(short = 'k', long = "private-key")]
pub path_to_private_key: Option<PathBuf>,
#[clap(subcommand)]
pub commands: DeviceCommands,
}

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

@@ -0,0 +1,9 @@
use env_logger::{Builder, Env};
/// Sets up appropriate logger level:
/// - if `RUST_LOG` environment variable is set, use its value
/// - else, use `debug` CLI option
pub fn setup_logger(debug: bool) {
Builder::from_env(Env::default().default_filter_or(if debug { "debug" } else { "info" }))
.init();
}

57
adb_client/Cargo.toml Normal file
View File

@@ -0,0 +1,57 @@
[package]
authors.workspace = true
description = "Rust ADB (Android Debug Bridge) client library"
edition.workspace = true
keywords.workspace = true
license.workspace = true
name = "adb_client"
readme = "README.md"
repository.workspace = true
rust-version.workspace = true
version.workspace = true
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[features]
default = []
mdns = ["dep:mdns-sd"]
[dependencies]
base64 = { version = "0.22.1" }
bincode = { version = "2.0.1", features = ["serde"] }
byteorder = { version = "1.5.0" }
chrono = { version = "0.4.42", default-features = false, features = ["std"] }
image = { version = "0.25.9", default-features = false, features = ["png"] }
log = { version = "0.4.29" }
num-bigint = { version = "0.8.6", 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.6" }
regex = { version = "1.12.2", features = ["perf", "std", "unicode"] }
rsa = { version = "0.9.9" }
rusb = { version = "0.9.4", features = ["vendored"] }
rustls = { version = "0.23.35" }
rustls-pki-types = { version = "1.13.2" }
serde = { version = "1.0.228", features = ["derive"] }
serde_repr = { version = "0.1.20" }
sha1 = { version = "0.10.6", features = ["oid"] }
thiserror = { version = "2.0.17" }
#########
# `mdns` feature-specific dependencies
mdns-sd = { version = "0.17.1", default-features = false, features = [
"logging",
], optional = true }
#########
[dev-dependencies]
anyhow = { version = "1.0.100" }
criterion = { version = "0.7.0" } # Used for benchmarks
[[bench]]
harness = false
name = "benchmark_adb_push"
path = "../benches/benchmark_adb_push.rs"

125
adb_client/README.md Normal file
View File

@@ -0,0 +1,125 @@
# `adb_client`
[![MIT licensed](https://img.shields.io/crates/l/adb_client.svg)](./LICENSE-MIT)
[![Documentation](https://docs.rs/adb_client/badge.svg)](https://docs.rs/adb_client)
[![Crates.io Total Downloads](https://img.shields.io/crates/d/adb_client)](https://crates.io/crates/adb_client)
![MSRV](https://img.shields.io/crates/msrv/adb_client)
Rust library implementing ADB protocol.
## Installation
Add `adb_client` crate as a dependency by simply adding it to your `Cargo.toml`:
```toml
[dependencies]
adb_client = "*"
```
## Crate features
| Feature | Description | Default? |
| :-----: | :---------------------------------------------: | :------: |
| `mdns` | Enables mDNS device discovery on local network. | No |
To deactivate some default 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 = "*", default-features = false, features = ["mdns"] }
```
## Benchmarks
Benchmarks run on `v2.0.6`, on a **Samsung S10 SM-G973F** device and an **Intel i7-1265U** CPU laptop
### `ADBServerDevice` push vs `adb push`
`ADBServerDevice` performs all operations by using adb server as a bridge.
| File size | Sample size | `ADBServerDevice` | `adb` | Difference |
| :-------: | :---------: | :---------------: | :-------: | :------------------------------------: |
| 10 MB | 100 | 350,79 ms | 356,30 ms | <div style="color:green">-1,57 %</div> |
| 500 MB | 50 | 15,60 s | 15,64 s | <div style="color:green">-0,25 %</div> |
| 1 GB | 20 | 31,09 s | 31,12 s | <div style="color:green">-0,10 %</div> |
## Examples
### 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

@@ -0,0 +1,81 @@
use std::io::{Cursor, Read, Write};
use std::path::Path;
use image::{ImageBuffer, ImageFormat, Rgba};
use crate::models::AdbStatResponse;
use crate::{ADBListItem, RebootType, Result};
/// Trait representing all features available on both [`crate::ADBServerDevice`] and [`crate::ADBUSBDevice`]
pub trait ADBDeviceExt {
/// Runs command in a shell on the device, and write its output and error streams into output.
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()>;
/// Starts an interactive shell session on the device.
/// Input data is read from reader and write to writer.
fn shell(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()>;
/// Display the stat information for a remote file
fn stat(&mut self, remote_path: &str) -> Result<AdbStatResponse>;
/// Pull the remote file pointed to by `source` and write its contents into `output`
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()>;
/// Push `stream` to `path` on the device.
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()>;
/// List the items in a directory on the device
fn list(&mut self, path: &dyn AsRef<str>) -> Result<Vec<ADBListItem>>;
/// Reboot the device using given reboot type
fn reboot(&mut self, reboot_type: RebootType) -> Result<()>;
/// Run `activity` from `package` on device. Return the command output.
fn run_activity(&mut self, package: &str, activity: &str) -> Result<Vec<u8>> {
let mut output = Vec::new();
self.shell_command(
&["am", "start", &format!("{package}/{package}.{activity}")],
&mut output,
)?;
Ok(output)
}
/// Install an APK pointed to by `apk_path` on device.
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()>;
/// Uninstall the package `package` from device.
fn uninstall(&mut self, package: &str) -> Result<()>;
/// Inner method requesting framebuffer from an Android device
fn framebuffer_inner(&mut self) -> Result<ImageBuffer<Rgba<u8>, Vec<u8>>>;
/// Dump framebuffer of this device into given path.
///
/// Output data format is currently only `PNG`.
fn framebuffer(&mut self, path: &dyn AsRef<Path>) -> Result<()> {
// Big help from AOSP source code (<https://android.googlesource.com/platform/system/adb/+/refs/heads/main/framebuffer_service.cpp>)
let img = self.framebuffer_inner()?;
Ok(img.save(path.as_ref())?)
}
/// Dump framebuffer of this device and return corresponding bytes.
///
/// Output data format is currently only `PNG`.
fn framebuffer_bytes(&mut self) -> Result<Vec<u8>> {
let img = self.framebuffer_inner()?;
let mut vec = Cursor::new(Vec::new());
img.write_to(&mut vec, ImageFormat::Png)?;
Ok(vec.into_inner())
}
/// Return a boxed instance representing this trait
fn boxed(self) -> Box<dyn ADBDeviceExt>
where
Self: Sized,
Self: 'static,
{
Box::new(self)
}
}

View File

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

View File

@@ -0,0 +1,317 @@
use super::{ADBRsaKey, ADBTransportMessage, MessageCommand, models::MessageSubcommand};
use crate::device::adb_transport_message::{AUTH_RSAPUBLICKEY, AUTH_SIGNATURE, AUTH_TOKEN};
use crate::device::models::ADBSession;
use crate::{ADBMessageTransport, AdbStatResponse, Result, RustADBError, constants::BUFFER_SIZE};
use bincode::config::{Configuration, Fixint, LittleEndian, NoLimit};
use byteorder::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();
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`].
/// Structure is totally agnostic over which transport is truly used.
#[derive(Debug)]
pub struct ADBMessageDevice<T: ADBMessageTransport> {
transport: T,
}
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
/// Instantiate a new [`ADBMessageTransport`]
pub fn new(transport: T) -> Self {
Self { transport }
}
pub(crate) fn get_transport(&mut self) -> &T {
&self.transport
}
pub(crate) fn get_transport_mut(&mut self) -> &mut 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,
session: ADBSession,
) -> Result<ADBTransportMessage> {
let message = self.transport.read_message()?;
self.transport.write_message(ADBTransportMessage::new(
MessageCommand::Okay,
session.local_id(),
session.remote_id(),
&[],
))?;
Ok(message)
}
/// Expect a message with an `OKAY` command after sending a message.
pub(crate) fn send_and_expect_okay(
&mut self,
message: ADBTransportMessage,
) -> Result<ADBTransportMessage> {
self.transport.write_message(message)?;
self.transport.read_message().and_then(|message| {
message.assert_command(MessageCommand::Okay)?;
Ok(message)
})
}
pub(crate) fn recv_file<W: std::io::Write>(
&mut self,
session: ADBSession,
mut output: W,
) -> std::result::Result<(), RustADBError> {
let mut len: Option<u64> = None;
loop {
let payload = self.recv_and_reply_okay(session)?.into_payload();
let mut rdr = Cursor::new(&payload);
while rdr.position() != payload.len() as u64 {
match len.take() {
Some(0) | None => {
rdr.seek_relative(4)?;
len.replace(u64::from(rdr.read_u32::<byteorder::LittleEndian>()?));
}
Some(length) => {
let remaining_bytes = payload.len() as u64 - rdr.position();
if length < remaining_bytes {
std::io::copy(&mut rdr.by_ref().take(length), &mut output)?;
} else {
std::io::copy(&mut rdr.take(remaining_bytes), &mut output)?;
len.replace(length - remaining_bytes);
// this payload is now exhausted
break;
}
}
}
}
if Cursor::new(&payload[(payload.len() - 8)..(payload.len() - 4)])
.read_u32::<byteorder::LittleEndian>()?
== MessageSubcommand::Done as u32
{
break;
}
}
Ok(())
}
pub(crate) fn push_file<R: std::io::Read>(
&mut self,
session: ADBSession,
mut reader: R,
) -> std::result::Result<(), RustADBError> {
let mut buffer = vec![0; BUFFER_SIZE].into_boxed_slice();
let amount_read = reader.read(&mut buffer)?;
let subcommand_data = MessageSubcommand::Data.with_arg(u32::try_from(amount_read)?);
let mut serialized_message = bincode_serialize_to_vec(&subcommand_data)?;
serialized_message.append(&mut buffer[..amount_read].to_vec());
let message = ADBTransportMessage::new(
MessageCommand::Write,
session.local_id(),
session.remote_id(),
&serialized_message,
);
self.send_and_expect_okay(message)?;
loop {
let mut buffer = vec![0; BUFFER_SIZE].into_boxed_slice();
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 message = ADBTransportMessage::new(
MessageCommand::Write,
session.local_id(),
session.remote_id(),
&serialized_message,
);
self.send_and_expect_okay(message)?;
// Command should end with a Write => Okay
let received = self.transport.read_message()?;
match received.header().command() {
MessageCommand::Write => return Ok(()),
c => {
return Err(RustADBError::ADBRequestFailed(format!(
"Wrong command received {c}"
)));
}
}
}
Ok(size) => {
let subcommand_data = MessageSubcommand::Data.with_arg(u32::try_from(size)?);
let mut serialized_message = bincode_serialize_to_vec(&subcommand_data)?;
serialized_message.append(&mut buffer[..size].to_vec());
let message = ADBTransportMessage::new(
MessageCommand::Write,
session.local_id(),
session.remote_id(),
&serialized_message,
);
self.send_and_expect_okay(message)?;
}
Err(e) => {
return Err(RustADBError::IOError(e));
}
}
}
}
pub(crate) fn begin_synchronization(&mut self) -> Result<ADBSession> {
self.open_session(b"sync:\0")
}
pub(crate) fn stat_with_explicit_ids(
&mut self,
session: ADBSession,
remote_path: &str,
) -> Result<AdbStatResponse> {
let stat_buffer = MessageSubcommand::Stat.with_arg(u32::try_from(remote_path.len())?);
let message = ADBTransportMessage::new(
MessageCommand::Write,
session.local_id(),
session.remote_id(),
&bincode_serialize_to_vec(&stat_buffer)?,
);
self.send_and_expect_okay(message)?;
self.send_and_expect_okay(ADBTransportMessage::new(
MessageCommand::Write,
session.local_id(),
session.remote_id(),
remote_path.as_bytes(),
))?;
let response = self.transport.read_message()?;
// Skip first 4 bytes as this is the literal "STAT".
// Interesting part starts right after
bincode_deserialize_from_slice(&response.into_payload()[4..])
}
pub(crate) fn end_transaction(&mut self, session: ADBSession) -> Result<()> {
let quit_buffer = MessageSubcommand::Quit.with_arg(0u32);
self.send_and_expect_okay(ADBTransportMessage::new(
MessageCommand::Write,
session.local_id(),
session.remote_id(),
&bincode_serialize_to_vec(&quit_buffer)?,
))?;
let _discard_close = self.transport.read_message()?;
Ok(())
}
pub(crate) fn open_session(&mut self, data: &[u8]) -> Result<ADBSession> {
let mut rng = rand::rng();
let local_id: u32 = rng.random();
let message = ADBTransportMessage::new(
MessageCommand::Open,
local_id, // Our 'local-id'
0,
data,
);
self.get_transport_mut().write_message(message)?;
let response = self.get_transport_mut().read_message()?;
if response.header().command() != MessageCommand::Okay {
return Err(RustADBError::ADBRequestFailed(format!(
"Open session failed: got {} in respone instead of OKAY",
response.header().command()
)));
}
if response.header().arg1() != local_id {
return Err(RustADBError::ADBRequestFailed(format!(
"Open session failed: respones used {} for our local_id instead of {local_id}",
response.header().arg1()
)));
}
Ok(ADBSession::new(local_id, response.header().arg0()))
}
}

View File

@@ -0,0 +1,49 @@
use crate::{ADBDeviceExt, ADBMessageTransport, RebootType, Result, 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)
}
fn shell(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()> {
self.shell(reader, writer)
}
fn stat(&mut self, remote_path: &str) -> Result<AdbStatResponse> {
self.stat(remote_path)
}
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()> {
self.pull(source, output)
}
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
self.push(stream, path)
}
fn reboot(&mut self, reboot_type: RebootType) -> Result<()> {
self.reboot(reboot_type)
}
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
self.install(apk_path)
}
fn uninstall(&mut self, package: &str) -> Result<()> {
self.uninstall(package)
}
fn framebuffer_inner(&mut self) -> Result<image::ImageBuffer<image::Rgba<u8>, Vec<u8>>> {
self.framebuffer_inner()
}
fn list(&mut self, path: &dyn AsRef<str>) -> Result<Vec<crate::ADBListItem>> {
self.list(path)
}
}

View File

@@ -0,0 +1,150 @@
use std::io::Write;
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};
/// Represent a device reached and available over TCP.
#[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<P: AsRef<Path>>(
address: SocketAddr,
private_key_path: P,
) -> 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.as_ref().display()
);
ADBRsaKey::new_random()?
};
let mut device = Self {
private_key,
inner: ADBMessageDevice::new(TcpTransport::new(address)?),
};
device.connect()?;
Ok(device)
}
/// Send initial connect
pub fn connect(&mut self) -> Result<()> {
self.get_transport_mut().connect()?;
let message = ADBTransportMessage::new(
MessageCommand::Cnxn,
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()?;
// Check if a 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)
}
_ => Err(crate::RustADBError::WrongResponseReceived(
"Expected CNXN, STLS or AUTH command".to_string(),
message.header().command().to_string(),
)),
}
}
#[inline]
fn get_transport_mut(&mut self) -> &mut TcpTransport {
self.inner.get_transport_mut()
}
}
impl ADBDeviceExt for ADBTcpDevice {
#[inline]
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
self.inner.shell_command(command, output)
}
#[inline]
fn shell(&mut self, reader: &mut dyn Read, writer: Box<dyn Write + Send>) -> Result<()> {
self.inner.shell(reader, writer)
}
#[inline]
fn stat(&mut self, remote_path: &str) -> Result<crate::AdbStatResponse> {
self.inner.stat(remote_path)
}
#[inline]
fn pull(&mut self, source: &dyn AsRef<str>, output: &mut dyn Write) -> Result<()> {
self.inner.pull(source, output)
}
#[inline]
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
self.inner.push(stream, path)
}
#[inline]
fn reboot(&mut self, reboot_type: crate::RebootType) -> Result<()> {
self.inner.reboot(reboot_type)
}
#[inline]
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
self.inner.install(apk_path)
}
#[inline]
fn uninstall(&mut self, package: &str) -> Result<()> {
self.inner.uninstall(package)
}
#[inline]
fn framebuffer_inner(&mut self) -> Result<image::ImageBuffer<image::Rgba<u8>, Vec<u8>>> {
self.inner.framebuffer_inner()
}
fn list(&mut self, path: &dyn AsRef<str>) -> Result<Vec<crate::ADBListItem>> {
self.inner.list(path)
}
}
impl Drop for ADBTcpDevice {
fn drop(&mut self) {
// Best effort here
let _ = self.get_transport_mut().disconnect();
}
}

View File

@@ -0,0 +1,122 @@
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;
#[derive(Debug)]
pub struct ADBTransportMessage {
header: ADBTransportMessageHeader,
payload: Vec<u8>,
}
#[derive(Debug, Serialize, Deserialize)]
#[repr(C)]
pub struct ADBTransportMessageHeader {
command: MessageCommand, /* command identifier constant */
arg0: u32, /* first argument */
arg1: u32, /* second argument */
data_length: u32, /* length of payload (0 is allowed) */
data_crc32: u32, /* crc32 of data payload */
magic: u32, /* command ^ 0xffffffff */
}
impl ADBTransportMessageHeader {
pub fn new(command: MessageCommand, arg0: u32, arg1: u32, data: &[u8]) -> Self {
Self {
command,
arg0,
arg1,
data_length: data.len() as u32,
data_crc32: Self::compute_crc32(data),
magic: Self::compute_magic(command),
}
}
pub fn command(&self) -> MessageCommand {
self.command
}
pub fn arg0(&self) -> u32 {
self.arg0
}
pub fn arg1(&self) -> u32 {
self.arg1
}
pub fn data_length(&self) -> u32 {
self.data_length
}
pub fn data_crc32(&self) -> u32 {
self.data_crc32
}
pub(crate) fn compute_crc32(data: &[u8]) -> u32 {
data.iter().map(|&x| u32::from(x)).sum()
}
fn compute_magic(command: MessageCommand) -> u32 {
let command_u32 = command as u32;
command_u32 ^ 0xFFFF_FFFF
}
pub fn as_bytes(&self) -> Result<Vec<u8>> {
adb_message_device::bincode_serialize_to_vec(self)
}
}
impl ADBTransportMessage {
pub fn new(command: MessageCommand, arg0: u32, arg1: u32, data: &[u8]) -> Self {
Self {
header: ADBTransportMessageHeader::new(command, arg0, arg1, data),
payload: data.to_vec(),
}
}
pub fn from_header_and_payload(header: ADBTransportMessageHeader, payload: Vec<u8>) -> Self {
Self { header, payload }
}
pub fn check_message_integrity(&self) -> bool {
ADBTransportMessageHeader::compute_magic(self.header.command) == self.header.magic
&& ADBTransportMessageHeader::compute_crc32(&self.payload) == self.header.data_crc32
}
pub fn assert_command(&self, expected_command: MessageCommand) -> Result<()> {
let our_command = self.header().command();
if expected_command == our_command {
return Ok(());
}
Err(RustADBError::WrongResponseReceived(
our_command.to_string(),
expected_command.to_string(),
))
}
pub fn header(&self) -> &ADBTransportMessageHeader {
&self.header
}
pub fn payload(&self) -> &Vec<u8> {
&self.payload
}
pub fn into_payload(self) -> Vec<u8> {
self.payload
}
}
impl TryFrom<[u8; 24]> for ADBTransportMessageHeader {
type Error = RustADBError;
fn try_from(value: [u8; 24]) -> Result<Self> {
adb_message_device::bincode_deserialize_from_slice(&value)
}
}

View File

@@ -0,0 +1,261 @@
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 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};
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> {
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 {
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<P: AsRef<Path>>(
vendor_id: u16,
product_id: u16,
private_key_path: P,
) -> 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<P: AsRef<Path>>(
transport: USBTransport,
private_key_path: P,
) -> 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.as_ref().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,
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)?;
self.inner.auth_handshake(message, &self.private_key)
}
#[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()
}
fn list(&mut self, path: &dyn AsRef<str>) -> Result<Vec<crate::ADBListItem>> {
self.inner.list(path)
}
}
impl Drop for ADBUSBDevice {
fn drop(&mut self) {
// Best effort here
let _ = self.get_transport_mut().disconnect();
}
}

View File

@@ -0,0 +1,98 @@
use std::io::{Cursor, Read};
use byteorder::{LittleEndian, ReadBytesExt};
use image::{ImageBuffer, Rgba};
use crate::{
ADBMessageTransport, Result, RustADBError,
device::{MessageCommand, adb_message_device::ADBMessageDevice},
models::{FrameBufferInfoV1, FrameBufferInfoV2},
};
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn framebuffer_inner(&mut self) -> Result<ImageBuffer<Rgba<u8>, Vec<u8>>> {
let session = self.open_session(b"framebuffer:\0")?;
let response = self.recv_and_reply_okay(session)?;
let mut payload_cursor = Cursor::new(response.payload());
let version = payload_cursor.read_u32::<LittleEndian>()?;
let img = match version {
// RGBA_8888
1 => {
let mut buf = [0u8; std::mem::size_of::<FrameBufferInfoV1>()];
payload_cursor.read_exact(&mut buf)?;
let framebuffer_info: FrameBufferInfoV1 = buf.try_into()?;
let mut framebuffer_data = Vec::new();
payload_cursor.read_to_end(&mut framebuffer_data)?;
loop {
if u32::try_from(framebuffer_data.len())? == framebuffer_info.size {
break;
}
let response = self.recv_and_reply_okay(session)?;
framebuffer_data.extend_from_slice(&response.into_payload());
log::debug!(
"received framebuffer data. new size {}",
framebuffer_data.len()
);
}
ImageBuffer::<Rgba<u8>, Vec<u8>>::from_vec(
framebuffer_info.width,
framebuffer_info.height,
framebuffer_data,
)
.ok_or_else(|| RustADBError::FramebufferConversionError)?
}
// RGBX_8888
2 => {
let mut buf = [0u8; std::mem::size_of::<FrameBufferInfoV2>()];
payload_cursor.read_exact(&mut buf)?;
let framebuffer_info: FrameBufferInfoV2 = buf.try_into()?;
let mut framebuffer_data = Vec::new();
payload_cursor.read_to_end(&mut framebuffer_data)?;
loop {
if u32::try_from(framebuffer_data.len())? == framebuffer_info.size {
break;
}
let response = self.recv_and_reply_okay(session)?;
framebuffer_data.extend_from_slice(&response.into_payload());
log::debug!(
"received framebuffer data. new size {}",
framebuffer_data.len()
);
}
ImageBuffer::<Rgba<u8>, Vec<u8>>::from_vec(
framebuffer_info.width,
framebuffer_info.height,
framebuffer_data,
)
.ok_or_else(|| RustADBError::FramebufferConversionError)?
}
v => return Err(RustADBError::UnimplementedFramebufferImageVersion(v)),
};
self.get_transport_mut()
.read_message()
.and_then(|message| message.assert_command(MessageCommand::Clse))?;
Ok(img)
}
}

View File

@@ -0,0 +1,41 @@
use std::{fs::File, path::Path};
use crate::{
ADBMessageTransport, Result,
device::{MessageWriter, adb_message_device::ADBMessageDevice},
utils::check_extension_is_apk,
};
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
let mut apk_file = File::open(apk_path)?;
check_extension_is_apk(apk_path)?;
let file_size = apk_file.metadata()?.len();
let session =
self.open_session(format!("exec:cmd package 'install' -S {file_size}\0").as_bytes())?;
let transport = self.get_transport().clone();
let mut writer = MessageWriter::new(transport, session.local_id(), session.remote_id());
std::io::copy(&mut apk_file, &mut writer)?;
let final_status = self.get_transport_mut().read_message()?;
match final_status.into_payload().as_slice() {
b"Success\n" => {
log::info!(
"APK file {} successfully installed",
apk_path.as_ref().display()
);
Ok(())
}
d => Err(crate::RustADBError::ADBRequestFailed(String::from_utf8(
d.to_vec(),
)?)),
}
}
}

View File

@@ -0,0 +1,177 @@
use crate::{
ADBListItem, ADBListItemType, ADBMessageTransport, Result, RustADBError,
device::{
ADBTransportMessage, MessageCommand, MessageSubcommand,
adb_message_device::{ADBMessageDevice, bincode_serialize_to_vec},
},
};
use byteorder::ByteOrder;
use byteorder::LittleEndian;
use std::str;
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
/// List the entries in the given directory on the device.
/// note: path uses internal file paths, so Documents is at /storage/emulated/0/Documents
pub(crate) fn list<A: AsRef<str>>(&mut self, path: A) -> Result<Vec<ADBListItem>> {
let session = self.begin_synchronization()?;
let output = self.handle_list(path, session.local_id(), session.remote_id());
self.end_transaction(session)?;
output
}
/// Request amount of bytes from transport, potentially across payloads
///
/// This automatically request a new payload by sending back "Okay" and waiting for the next payload
/// It reads the request bytes across the existing payload, and if there is not enough bytes left,
/// reads the rest from the next payload
///
/// Current index
/// ┼───────────────┼ Requested
/// ┌─────────────┐
/// ┌───────────────┼───────┐ │
/// └───────────────────────┘
/// Current └─────┘
/// payload Wanted in
/// Next payload
fn read_bytes_from_transport(
requested_bytes: usize,
current_index: &mut usize,
transport: &mut T,
payload: &mut Vec<u8>,
local_id: u32,
remote_id: u32,
) -> Result<Vec<u8>> {
if *current_index + requested_bytes <= payload.len() {
// if there is enough bytes in this payload
// Copy from existing payload
let slice = &payload[*current_index..*current_index + requested_bytes];
*current_index += requested_bytes;
Ok(slice.to_vec())
} else {
// Read the rest of the existing payload, then continue with the next message
let mut slice = Vec::new();
let bytes_read_from_existing_payload = payload.len() - *current_index;
slice.extend_from_slice(
&payload[*current_index..*current_index + bytes_read_from_existing_payload],
);
// Request the next message
let send_message =
ADBTransportMessage::new(MessageCommand::Okay, local_id, remote_id, &[]);
transport.write_message(send_message)?;
// Read the new message
*payload = transport.read_message()?.into_payload();
let bytes_read_from_new_payload = requested_bytes - bytes_read_from_existing_payload;
slice.extend_from_slice(&payload[..bytes_read_from_new_payload]);
*current_index = bytes_read_from_new_payload;
Ok(slice)
}
}
fn handle_list<A: AsRef<str>>(
&mut self,
path: A,
local_id: u32,
remote_id: u32,
) -> Result<Vec<ADBListItem>> {
// TODO: use LIS2 to support files over 2.14 GB in size.
// SEE: https://github.com/cstyan/adbDocumentation?tab=readme-ov-file#adb-list
{
let mut len_buf = Vec::from([0_u8; 4]);
LittleEndian::write_u32(&mut len_buf, u32::try_from(path.as_ref().len())?);
let subcommand_data = MessageSubcommand::List;
let mut serialized_message = bincode_serialize_to_vec(subcommand_data)
.map_err(|_e| RustADBError::ConversionError)?;
serialized_message.append(&mut len_buf);
let mut path_bytes: Vec<u8> = Vec::from(path.as_ref().as_bytes());
serialized_message.append(&mut path_bytes);
let message = ADBTransportMessage::new(
MessageCommand::Write,
local_id,
remote_id,
&serialized_message,
);
self.send_and_expect_okay(message)?;
}
let mut list_items = Vec::new();
let transport = self.get_transport_mut();
let mut payload = transport.read_message()?.into_payload();
let mut current_index = 0;
loop {
// Loop though the response for all the entries
const STATUS_CODE_LENGTH_IN_BYTES: usize = 4;
let status_code = Self::read_bytes_from_transport(
STATUS_CODE_LENGTH_IN_BYTES,
&mut current_index,
transport,
&mut payload,
local_id,
remote_id,
)?;
match str::from_utf8(&status_code)? {
"DENT" => {
// Read the file mode, size, mod time and name length in one go, since all their sizes are predictable
const U32_SIZE_IN_BYTES: usize = 4;
const SIZE_OF_METADATA: usize = U32_SIZE_IN_BYTES * 4;
let metadata = Self::read_bytes_from_transport(
SIZE_OF_METADATA,
&mut current_index,
transport,
&mut payload,
local_id,
remote_id,
)?;
let mode = metadata[..U32_SIZE_IN_BYTES].to_vec();
let size = metadata[U32_SIZE_IN_BYTES..2 * U32_SIZE_IN_BYTES].to_vec();
let time = metadata[2 * U32_SIZE_IN_BYTES..3 * U32_SIZE_IN_BYTES].to_vec();
let name_len = metadata[3 * U32_SIZE_IN_BYTES..4 * U32_SIZE_IN_BYTES].to_vec();
let mode = LittleEndian::read_u32(&mode);
let size = LittleEndian::read_u32(&size);
let time = LittleEndian::read_u32(&time);
let name_len = LittleEndian::read_u32(&name_len) as usize;
// Read the file name, since it requires the length from the name_len
let name_buf = Self::read_bytes_from_transport(
name_len,
&mut current_index,
transport,
&mut payload,
local_id,
remote_id,
)?;
let name = String::from_utf8(name_buf)?;
// First 9 bits are the file permissions
let permissions = mode & 0b1_1111_1111;
// Bits 14 to 16 are the file type
let item_type = match (mode >> 13) & 0b111 {
0b010 => ADBListItemType::Directory,
0b100 => ADBListItemType::File,
0b101 => ADBListItemType::Symlink,
type_code => return Err(RustADBError::UnknownFileMode(type_code)),
};
let entry = ADBListItem {
item_type,
name,
time,
size,
permissions,
};
list_items.push(entry);
}
"DONE" => {
return Ok(list_items);
}
x => log::error!("Got an unknown response {x}"),
}
}
}
}

View File

@@ -0,0 +1,9 @@
mod framebuffer;
mod install;
mod list;
mod pull;
mod push;
mod reboot;
mod shell;
mod stat;
mod uninstall;

View File

@@ -0,0 +1,54 @@
use std::io::Write;
use crate::{
ADBMessageTransport, Result, RustADBError,
device::{
ADBTransportMessage, MessageCommand,
adb_message_device::{self, ADBMessageDevice},
models::MessageSubcommand,
},
};
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn pull<A: AsRef<str>, W: Write>(&mut self, source: A, output: W) -> Result<()> {
let session = self.begin_synchronization()?;
let source = source.as_ref();
let adb_stat_response = self.stat_with_explicit_ids(session, source)?;
if adb_stat_response.file_perm == 0 {
return Err(RustADBError::UnknownResponseType(
"mode is 0: source file does not exist".to_string(),
));
}
self.get_transport_mut().write_message_with_timeout(
ADBTransportMessage::new(
MessageCommand::Okay,
session.local_id(),
session.remote_id(),
&[],
),
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)?;
self.send_and_expect_okay(ADBTransportMessage::new(
MessageCommand::Write,
session.local_id(),
session.remote_id(),
&recv_buffer,
))?;
self.send_and_expect_okay(ADBTransportMessage::new(
MessageCommand::Write,
session.local_id(),
session.remote_id(),
source.as_bytes(),
))?;
self.recv_file(session, output)?;
self.end_transaction(session)?;
Ok(())
}
}

View File

@@ -0,0 +1,33 @@
use std::io::Read;
use crate::{
ADBMessageTransport, Result,
device::{
ADBTransportMessage, MessageCommand, MessageSubcommand,
adb_message_device::{self, ADBMessageDevice},
},
};
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn push<R: Read, A: AsRef<str>>(&mut self, stream: R, path: A) -> Result<()> {
let session = self.begin_synchronization()?;
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)?;
send_buffer.append(&mut path_header.as_bytes().to_vec());
self.send_and_expect_okay(ADBTransportMessage::new(
MessageCommand::Write,
session.local_id(),
session.remote_id(),
&send_buffer,
))?;
self.push_file(session, stream)?;
self.end_transaction(session)?;
Ok(())
}
}

View File

@@ -0,0 +1,14 @@
use crate::{
ADBMessageTransport, RebootType, Result,
device::{MessageCommand, adb_message_device::ADBMessageDevice},
};
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
pub(crate) fn reboot(&mut self, reboot_type: RebootType) -> Result<()> {
self.open_session(format!("reboot:{reboot_type}\0").as_bytes())?;
self.get_transport_mut()
.read_message()
.and_then(|message| message.assert_command(MessageCommand::Okay))
}
}

View File

@@ -0,0 +1,96 @@
use std::io::{ErrorKind, Read, Write};
use std::time::Duration;
use crate::Result;
use crate::device::ShellMessageWriter;
use crate::{
ADBMessageTransport, RustADBError,
device::{ADBMessageDevice, ADBTransportMessage, MessageCommand},
};
impl<T: ADBMessageTransport> ADBMessageDevice<T> {
/// Runs 'command' in a shell on the device, and write its output and error streams into output.
pub(crate) fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
let session = self.open_session(format!("shell:{}\0", command.join(" "),).as_bytes())?;
let mut transport = self.get_transport().clone();
loop {
let message = transport.read_message()?;
let command = message.header().command();
if command == MessageCommand::Clse {
break;
}
self.get_transport_mut()
.write_message(ADBTransportMessage::new(
MessageCommand::Okay,
session.local_id(),
session.remote_id(),
&[],
))?;
output.write_all(&message.into_payload())?;
}
// some devices will repeat the trailing CLSE command to ensure
// the client has acknowledged it. Read them quickly if present.
while let Ok(_discard_close_message) =
transport.read_message_with_timeout(Duration::from_millis(20))
{}
Ok(())
}
/// Starts an interactive shell session on the device.
/// Input data is read from [reader] and write to [writer].
pub(crate) fn shell(
&mut self,
mut reader: &mut dyn Read,
mut writer: Box<dyn Write + Send>,
) -> Result<()> {
let session = self.open_session(b"shell:\0")?;
let mut transport = self.get_transport().clone();
// Reading thread, reads response from adbd
std::thread::spawn(move || -> Result<()> {
loop {
let message = transport.read_message()?;
// Acknowledge for more data
let response = ADBTransportMessage::new(
MessageCommand::Okay,
session.local_id(),
session.remote_id(),
&[],
);
transport.write_message(response)?;
match message.header().command() {
MessageCommand::Write => {
writer.write_all(&message.into_payload())?;
writer.flush()?;
}
MessageCommand::Okay => {}
_ => return Err(RustADBError::ADBShellNotSupported),
}
}
});
let transport = self.get_transport().clone();
let mut shell_writer =
ShellMessageWriter::new(transport, session.local_id(), session.remote_id());
// Read from given reader (that could be stdin e.g), and write content to device adbd
if let Err(e) = std::io::copy(&mut reader, &mut shell_writer) {
match e.kind() {
ErrorKind::BrokenPipe => return Ok(()),
_ => return Err(RustADBError::IOError(e)),
}
}
Ok(())
}
}

View File

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

View File

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

View File

@@ -0,0 +1,48 @@
use std::io::{Error, ErrorKind, Result, Write};
use crate::ADBMessageTransport;
use super::{ADBTransportMessage, MessageCommand};
/// [`Write`] trait implementation to hide underlying ADB protocol write logic.
///
/// Read received responses to check that message has been correctly received.
pub struct MessageWriter<T: ADBMessageTransport> {
transport: T,
local_id: u32,
remote_id: u32,
}
impl<T: ADBMessageTransport> MessageWriter<T> {
pub fn new(transport: T, local_id: u32, remote_id: u32) -> Self {
Self {
transport,
local_id,
remote_id,
}
}
}
impl<T: ADBMessageTransport> Write for MessageWriter<T> {
fn write(&mut self, buf: &[u8]) -> Result<usize> {
let message =
ADBTransportMessage::new(MessageCommand::Write, self.local_id, self.remote_id, buf);
self.transport
.write_message(message)
.map_err(|e| Error::new(ErrorKind::InvalidData, e))?;
match self.transport.read_message() {
Ok(response) => {
response
.assert_command(MessageCommand::Okay)
.map_err(Error::other)?;
Ok(buf.len())
}
Err(e) => Err(Error::other(e)),
}
}
fn flush(&mut self) -> Result<()> {
Ok(())
}
}

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

@@ -0,0 +1,176 @@
use crate::{Result, RustADBError};
use base64::{Engine, engine::general_purpose::STANDARD};
use num_bigint::{BigUint, ModInverse};
use num_traits::FromPrimitive;
use num_traits::cast::ToPrimitive;
use rsa::pkcs8::DecodePrivateKey;
use rsa::traits::PublicKeyParts;
use rsa::{Pkcs1v15Sign, RsaPrivateKey};
use std::fmt::Write;
const ADB_PRIVATE_KEY_SIZE: usize = 2048;
const ANDROID_PUBKEY_MODULUS_SIZE_WORDS: u32 = 64;
#[repr(C)]
#[derive(Debug, Default)]
/// Internal ADB representation of a public key
struct ADBRsaInternalPublicKey {
pub modulus_size_words: u32,
pub n0inv: u32,
pub modulus: BigUint,
pub rr: Vec<u8>,
pub exponent: u32,
}
impl ADBRsaInternalPublicKey {
pub fn new(exponent: &BigUint, modulus: &BigUint) -> Result<Self> {
Ok(Self {
modulus_size_words: ANDROID_PUBKEY_MODULUS_SIZE_WORDS,
exponent: exponent.to_u32().ok_or(RustADBError::ConversionError)?,
modulus: modulus.clone(),
..Default::default()
})
}
pub fn into_bytes(mut self) -> Vec<u8> {
let mut bytes: Vec<u8> = Vec::new();
bytes.append(&mut self.modulus_size_words.to_le_bytes().to_vec());
bytes.append(&mut self.n0inv.to_le_bytes().to_vec());
bytes.append(&mut self.modulus.to_bytes_le());
bytes.append(&mut self.rr);
bytes.append(&mut self.exponent.to_le_bytes().to_vec());
bytes
}
}
#[derive(Debug, Clone)]
pub struct ADBRsaKey {
private_key: RsaPrivateKey,
}
impl ADBRsaKey {
pub fn new_random() -> Result<Self> {
Ok(Self {
private_key: RsaPrivateKey::new(&mut rsa::rand_core::OsRng, ADB_PRIVATE_KEY_SIZE)?,
})
}
pub fn new_from_pkcs8(pkcs8_content: &str) -> Result<Self> {
Ok(ADBRsaKey {
private_key: RsaPrivateKey::from_pkcs8_pem(pkcs8_content)?,
})
}
pub fn android_pubkey_encode(&self) -> Result<String> {
// Helped from project: https://github.com/hajifkd/webadb
// Source code: https://android.googlesource.com/platform/system/core/+/refs/heads/main/libcrypto_utils/android_pubkey.cpp
// Useful function `android_pubkey_encode()`
let mut adb_rsa_pubkey =
ADBRsaInternalPublicKey::new(self.private_key.e(), self.private_key.n())?;
// r32 = 2 ^ 32
let r32 = BigUint::from_u64(1 << 32).ok_or(RustADBError::ConversionError)?;
// r = 2 ^ rsa_size = 2 ^ 2048
let r = set_bit(ADB_PRIVATE_KEY_SIZE)?;
// rr = r ^ 2 mod N
let rr = r.modpow(&BigUint::from(2u32), &adb_rsa_pubkey.modulus);
adb_rsa_pubkey.rr = rr.to_bytes_le();
// rem = N[0]
let rem = &adb_rsa_pubkey.modulus % &r32;
// n0inv = -1 / rem mod r32
let n0inv = rem
.mod_inverse(&r32)
.and_then(|v| v.to_biguint())
.ok_or(RustADBError::ConversionError)?;
// BN_sub(n0inv, r32, n0inv)
adb_rsa_pubkey.n0inv = (r32 - n0inv)
.to_u32()
.ok_or(RustADBError::ConversionError)?;
Self::encode_public_key(adb_rsa_pubkey.into_bytes())
}
fn encode_public_key(pub_key: Vec<u8>) -> Result<String> {
let mut encoded = STANDARD.encode(pub_key);
encoded.push(' ');
write!(encoded, "adb_client@{}", env!("CARGO_PKG_VERSION"))
.map_err(|_| RustADBError::ConversionError)?;
Ok(encoded)
}
pub fn sign(&self, msg: impl AsRef<[u8]>) -> Result<Vec<u8>> {
Ok(self
.private_key
.sign(Pkcs1v15Sign::new::<sha1::Sha1>(), msg.as_ref())?)
}
}
fn set_bit(n: usize) -> Result<BigUint> {
BigUint::parse_bytes(
&{
let mut bits = vec![b'1'];
bits.append(&mut vec![b'0'; n]);
bits
}[..],
2,
)
.ok_or(RustADBError::ConversionError)
}
#[test]
fn test_pubkey_gen() {
const DEFAULT_PRIV_KEY: &str = r"-----BEGIN PRIVATE KEY-----
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQC4Dyn85cxDJnjM
uYXQl/w469MDKdlGdviLfmFMWeYLVfL2Mz1AVyvKqscrtlhbbgMQ/M+3lDvEdHS0
14RIGAwWRtrlTTmhLvM2/IO+eSKSYeCrCVc4KLG3E3WRryUXbs2ynA29xjTJVw+Z
xYxDyn/tAYPEyMm4v+HIJHcOtRzxtO2vjMJ2vBT/ywYxjhncXbFSO09q2E4XrHli
SIPyO82hZgCkpzTZRp+nyA17TYuV9++mvUr9lWH9RbC+o8EF3yitlBsE2uXr97EV
i2Qy8CE7FIxsihXlukppwKRuz+1rJrvmZPTn49ZS+sIS99WE9GoCpsyQvTpvehrM
SIDRsVZPAgMBAAECggEAWNXAzzXeS36zCSR1yILCknqHotw86Pyc4z7BGUe+dzQp
itiaNIaeNTgN3zQoGyDSzA0o+BLMcfo/JdVrHBy3IL1cAxYtvXTaoGxp7bGrlPk2
pXZhqVJCy/jRYtokzdWF5DHbk/+pFJA3kGE/XKzM54g2n/DFI61A/QdUiz2w1ZtI
vc5cM08EM8B/TSI3SeWB8zkh5SlIuLsFO2J2+tCak6PdFfKOVIrFv9dKJYLxx+59
+edZamw2EvNlnl/sewgUk0gaZvQKVf4ivHyM+KSHuV4RFfiLvGuVcyA6XhSjztsG
EA++jDHP5ib/Izes7UK09v9y7kow+z6vUtnDDQOvgQKBgQD8WWAn7FQt9aziCw19
gZynzHG1bXI7uuEVSneuA3UwJImmDu8W+Qb9YL9Dc2nV0M5pGGdXKi2jzq8gPar6
GPAmy7TOlov6Nm0pbMXTAfuovG+gIXxelp3US3FvyRupi0/7UQRRwvetFYbDFwJX
ydF5uEtZdGSHAjPeU5FLq6tBwQKBgQC6uN0JwwZn+eaxguyKOXvp0KykhFI0HI1A
MBDZ1uuKt6OW5+r9NeQtTLctGlNKVQ8wz+Wr0C/nLGIIv4lySS9WFyc5/FnFhDdy
LsEi6whcca4vq3jsMOukvQGFnERsou4LqBEI1Es7jjeeEq+/8WnNTi6Y1flZ6UAp
YAOeFI98DwKBgQDvyfHgHeajwZalOQF5qGb24AOQ9c4dyefGNnvhA/IgbCfMftZc
iwhETuGQM6R3A7KQFRtlrXOu+2BYD6Ffg8D37IwD3vRmL7+tJGoapwC/B0g+7nLi
4tZY+9Nv+LbrdbDry8GB+/UkKJdk3IFicCk4M5KOD1bTH5mwAtLHB/p1QQKBgDHi
k8M45GxA+p4wMUvYgb987bLiWyfq/N3KOaZJYhJkb4MwoLpXfIeRuFqHbvsr8GwF
DwIxE6s6U1KtAWaUIN5qPyOhxMYdRcbusNDIZCp2gKfhsuO/SiVwDYkJr8oqWVip
5SsrtJHLtBY6PdQVBkRAf/h7KiwYQfkL2suQCKmHAoGBAJAkYImBYPHuRcnSXikn
xGDK/moPvzs0CjdPlRcEN+Myy/G0FUrOaC0FcpNoJOdQSYz3F6URA4nX+zj6Ie7G
CNkECiepaGyquQaffwR1CAi8dH6biJjlTQWQPFcCLA0hvernWo3eaSfiL7fHyym+
ile69MHFENUePSpuRSiF3Z02
-----END PRIVATE KEY-----";
let priv_key =
ADBRsaKey::new_from_pkcs8(DEFAULT_PRIV_KEY).expect("cannot create rsa key from data");
let pub_key = priv_key
.android_pubkey_encode()
.expect("cannot encode public key");
let pub_key_adb = "\
QAAAAFH/pU9PVrHRgEjMGnpvOr2QzKYCavSE1fcSwvpS1uPn9GTmuyZr7c9up\
MBpSrrlFYpsjBQ7IfAyZIsVsffr5doEG5StKN8FwaO+sEX9YZX9Sr2m7/eVi0\
17Dcinn0bZNKekAGahzTvyg0hieawXTthqTztSsV3cGY4xBsv/FLx2woyv7bT\
xHLUOdyTI4b+4ycjEgwHtf8pDjMWZD1fJNMa9DZyyzW4XJa+RdRO3sSg4Vwmr\
4GGSInm+g/w28y6hOU3l2kYWDBhIhNe0dHTEO5S3z/wQA25bWLYrx6rKK1dAP\
TP28lUL5llMYX6L+HZG2SkD0+s4/JfQhbnMeCZDzOX8KQ+4ThLy/gDTqCSTjj\
ic8BykdUIqYPwAjBMgQwLOLY5WNJMpjGlFINRcCGhvFFZ73sJTLerECuV/Oae\
nFRcORwnGIRgMrYXj4tjmxJC7sq3cfNX96YIcSCDE9SZFdlKXVK8Jc4YMLGF3\
MI8k1KoTby34uaIyxPJvwM1WR4Rdj60fwMyikFXNaOR2fPteZ3UMBA7CMrOEm\
9iYjntyEppA4hQXIO1TWTzkA/Kfl1i67k5NuLIQdhPFEc5ox5IYVHusauPQ7d\
Awu6BlgK37TUn0JdK0Z6Z4RaEIaNiEI0d5CoP6zQKV2QQnlscYpdsaUW5t9/F\
LioVXPwrz0tx35JyIUZPPYwEAAQA= ";
assert_eq!(&pub_key[..pub_key_adb.len()], pub_key_adb);
}

View File

@@ -0,0 +1,23 @@
/// Represent a session between an `ADBDevice` and remote `adbd`.
#[derive(Debug, Clone, Copy)]
pub(crate) struct ADBSession {
local_id: u32,
remote_id: u32,
}
impl ADBSession {
pub fn new(local_id: u32, remote_id: u32) -> Self {
Self {
local_id,
remote_id,
}
}
pub fn local_id(self) -> u32 {
self.local_id
}
pub fn remote_id(self) -> u32 {
self.remote_id
}
}

View File

@@ -0,0 +1,64 @@
use serde::{Deserialize, Serialize};
use serde_repr::{Deserialize_repr, Serialize_repr};
use std::fmt::Display;
#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize_repr, Deserialize_repr)]
#[repr(u32)]
pub enum MessageCommand {
/// Connect to a device
Cnxn = 0x4E58_4E43,
/// Close connection to a device
Clse = 0x4553_4C43,
/// Device ask for authentication
Auth = 0x4854_5541,
/// Open a data connection
Open = 0x4E45_504F,
/// Write data to connection
Write = 0x4554_5257,
/// Server understood the message
Okay = 0x5941_4B4F,
/// Start a connection using TLS
Stls = 0x534C_5453,
}
#[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,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SubcommandWithArg {
subcommand: MessageSubcommand,
arg: u32,
}
impl MessageSubcommand {
pub fn with_arg(self, arg: u32) -> SubcommandWithArg {
SubcommandWithArg {
subcommand: self,
arg,
}
}
}
impl Display for MessageCommand {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
MessageCommand::Cnxn => write!(f, "CNXN"),
MessageCommand::Clse => write!(f, "CLSE"),
MessageCommand::Auth => write!(f, "AUTH"),
MessageCommand::Open => write!(f, "OPEN"),
MessageCommand::Write => write!(f, "WRTE"),
MessageCommand::Okay => write!(f, "OKAY"),
MessageCommand::Stls => write!(f, "STLS"),
}
}
}

View File

@@ -0,0 +1,7 @@
mod adb_rsa_key;
mod adb_session;
mod message_commands;
pub use adb_rsa_key::ADBRsaKey;
pub(crate) use adb_session::ADBSession;
pub use message_commands::{MessageCommand, MessageSubcommand};

View File

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

View File

@@ -0,0 +1,84 @@
use std::{
net::{Ipv4Addr, SocketAddrV4},
sync::LazyLock,
};
use crate::{ADBServerDevice, ADBTransport, Result, RustADBError, TCPEmulatorTransport};
use regex::Regex;
static EMULATOR_REGEX: LazyLock<Regex> = LazyLock::new(|| {
Regex::new("^emulator-(?P<port>\\d+)$").expect("wrong syntax for emulator regex")
});
/// Represents an emulator connected to the ADB server.
#[derive(Debug)]
pub struct ADBEmulatorDevice {
/// Unique device identifier.
pub identifier: String,
/// Internal [`TCPEmulatorTransport`]
transport: TCPEmulatorTransport,
}
impl ADBEmulatorDevice {
/// Instantiates a new [`ADBEmulatorDevice`]
pub fn new(identifier: String, ip_address: Option<Ipv4Addr>) -> Result<Self> {
let ip_address = match ip_address {
Some(ip_address) => ip_address,
None => Ipv4Addr::LOCALHOST,
};
let groups = EMULATOR_REGEX
.captures(&identifier)
.ok_or(RustADBError::DeviceNotFound(format!(
"Device {identifier} is likely not an emulator"
)))?;
let port = groups
.name("port")
.ok_or(RustADBError::RegexParsingError)?
.as_str()
.parse::<u16>()?;
let socket_addr = SocketAddrV4::new(ip_address, port);
let transport = TCPEmulatorTransport::new(socket_addr);
Ok(Self {
identifier,
transport,
})
}
pub(crate) fn get_transport_mut(&mut self) -> &mut TCPEmulatorTransport {
&mut self.transport
}
/// Connect to underlying transport
pub(crate) fn connect(&mut self) -> Result<&mut TCPEmulatorTransport> {
self.transport.connect()?;
Ok(self.get_transport_mut())
}
}
impl TryFrom<ADBServerDevice> for ADBEmulatorDevice {
type Error = RustADBError;
fn try_from(value: ADBServerDevice) -> std::result::Result<Self, Self::Error> {
match &value.identifier {
Some(device_identifier) => ADBEmulatorDevice::new(
device_identifier.clone(),
Some(*value.transport.get_socketaddr().ip()),
),
None => Err(RustADBError::DeviceNotFound(
"cannot connect to an emulator device without knowing its identifier".to_string(),
)),
}
}
}
impl Drop for ADBEmulatorDevice {
fn drop(&mut self) {
// Best effort here
let _ = self.transport.disconnect();
}
}

View File

@@ -0,0 +1,2 @@
mod rotate;
mod sms;

View File

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

View File

@@ -0,0 +1,11 @@
use crate::{ADBEmulatorDevice, Result, emulator_device::ADBEmulatorCommand};
impl ADBEmulatorDevice {
/// Send a SMS to this emulator with given content with given phone number
pub fn send_sms(&mut self, phone_number: &str, content: &str) -> Result<()> {
self.connect()?.send_command(&ADBEmulatorCommand::Sms(
phone_number.to_string(),
content.to_string(),
))
}
}

View File

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

View File

@@ -0,0 +1,30 @@
use std::fmt::Display;
pub enum ADBEmulatorCommand {
Authenticate(String),
Sms(String, String),
Rotate,
}
impl Display for ADBEmulatorCommand {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
// Need to call `writeln!` because emulator commands are '\n' terminated
match self {
ADBEmulatorCommand::Authenticate(token) => writeln!(f, "auth {token}"),
ADBEmulatorCommand::Sms(phone_number, content) => {
writeln!(f, "sms send {phone_number} {content}")
}
ADBEmulatorCommand::Rotate => writeln!(f, "rotate"),
}
}
}
impl ADBEmulatorCommand {
/// Return the number of lines to skip per command when checking its result
pub(crate) fn skip_response_lines(&self) -> u8 {
match self {
ADBEmulatorCommand::Authenticate(_) => 1,
ADBEmulatorCommand::Sms(_, _) | ADBEmulatorCommand::Rotate => 0,
}
}
}

View File

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

137
adb_client/src/error.rs Normal file
View File

@@ -0,0 +1,137 @@
use thiserror::Error;
/// Custom Result type thrown by this crate.
pub type Result<T> = std::result::Result<T, RustADBError>;
/// Represents all error types that can be thrown by the crate.
#[derive(Error, Debug)]
pub enum RustADBError {
/// Indicates that an error occurred with I/O.
#[error(transparent)]
IOError(#[from] std::io::Error),
/// Indicates that an error occurred when sending ADB request.
#[error("ADB request failed - {0}")]
ADBRequestFailed(String),
/// Indicates that ADB server responded an unknown response type.
#[error("Unknown response type {0}")]
UnknownResponseType(String),
/// Indicated that an unexpected command has been received
#[error("Wrong response command received: {0}. Expected {1}")]
WrongResponseReceived(String, String),
/// Indicates that ADB server responses an unknown device state.
#[error("Unknown device state {0}")]
UnknownDeviceState(String),
/// Indicates that an error occurred during UTF-8 parsing.
#[error(transparent)]
Utf8StrError(#[from] std::str::Utf8Error),
/// Indicates that an error occurred during UTF-8 parsing.
#[error(transparent)]
Utf8StringError(#[from] std::string::FromUtf8Error),
/// Indicates that the provided address is not a correct IP address.
#[error(transparent)]
AddrParseError(#[from] std::net::AddrParseError),
/// Indicates an error with regexps.
#[error(transparent)]
RegexError(#[from] regex::Error),
/// Indicates that parsing regex did not worked.
#[error("Regex parsing error: missing field")]
RegexParsingError,
/// Indicates an error with the integer conversion.
#[error(transparent)]
ParseIntError(#[from] std::num::ParseIntError),
/// Indicates that an error occurred when converting a value.
#[error("Conversion error")]
ConversionError,
/// 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,
/// Desired device has not been found
#[error("Device not found: {0}")]
DeviceNotFound(String),
/// Indicates that the device must be paired before attempting a connection over WI-FI
#[error("Device not paired before attempting to connect")]
ADBDeviceNotPaired,
/// An error occurred when getting device's framebuffer image
#[error(transparent)]
FramebufferImageError(#[from] image::error::ImageError),
/// An error occurred when converting framebuffer content
#[error("Cannot convert framebuffer into image")]
FramebufferConversionError,
/// Unimplemented framebuffer image version
#[error("Unimplemented framebuffer image version: {0}")]
UnimplementedFramebufferImageVersion(u32),
/// An error occurred while getting user's home directory
#[error("Cannot get user home directory")]
HomeError,
/// Cannot get home directory
#[error("Cannot get home directory")]
NoHomeDirectory,
/// Generic USB error
#[error("USB Error: {0}")]
UsbError(#[from] rusb::Error),
/// USB device not found
#[error("USB Device not found: {0} {1}")]
USBDeviceNotFound(u16, u16),
/// No descriptor found
#[error("No USB descriptor found")]
USBNoDescriptorFound,
/// Integrity of the received message cannot be validated
#[error("Invalid integrity. Expected CRC32 {0}, got {1}")]
InvalidIntegrity(u32, u32),
/// Error while decoding base64 data
#[error(transparent)]
Base64DecodeError(#[from] base64::DecodeError),
/// Error while encoding base64 data
#[error(transparent)]
Base64EncodeError(#[from] base64::EncodeSliceError),
/// An error occurred with RSA engine
#[error(transparent)]
RSAError(#[from] rsa::errors::Error),
/// Cannot convert given data from slice
#[error(transparent)]
TryFromSliceError(#[from] std::array::TryFromSliceError),
/// Given path does not represent an APK
#[error("wrong file extension: {0}")]
WrongFileExtension(String),
/// An error occurred with PKCS8 data
#[error("error with pkcs8: {0}")]
RsaPkcs8Error(#[from] rsa::pkcs8::Error),
/// Error during certificate generation
#[error(transparent)]
CertificateGenerationError(#[from] rcgen::Error),
/// TLS Error
#[error(transparent)]
TLSError(#[from] rustls::Error),
/// PEM certificate error
#[error(transparent)]
PemCertError(#[from] rustls_pki_types::pem::Error),
/// Error while locking mutex
#[error("error while locking data")]
PoisonError,
/// Cannot upgrade connection from TCP to TLS
#[error("upgrade error: {0}")]
UpgradeError(String),
/// An error occurred while getting mdns devices
#[cfg(feature = "mdns")]
#[cfg_attr(docsrs, doc(cfg(feature = "mdns")))]
#[error(transparent)]
MDNSError(#[from] mdns_sd::Error),
/// An error occurred while sending data to channel
#[error("error sending data to channel")]
SendError,
/// An unknown transport has been provided
#[error("unknown transport: {0}")]
UnknownTransport(String),
/// An unknown file mode was encountered in list
#[error("Unknown file mode {0}")]
UnknownFileMode(u32),
}
impl<T> From<std::sync::PoisonError<T>> for RustADBError {
fn from(_err: std::sync::PoisonError<T>) -> Self {
Self::PoisonError
}
}

36
adb_client/src/lib.rs Normal file
View File

@@ -0,0 +1,36 @@
#![crate_type = "lib"]
#![forbid(unsafe_code)]
#![forbid(missing_debug_implementations)]
#![forbid(missing_docs)]
#![doc = include_str!("../README.md")]
// Feature `doc_cfg` is currently only available on nightly builds.
// 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 error;
/// MDNS-related definitions
#[cfg(feature = "mdns")]
#[cfg_attr(docsrs, doc(cfg(feature = "mdns")))]
pub mod mdns;
mod models;
mod server;
mod server_device;
mod transports;
mod utils;
pub use adb_device_ext::ADBDeviceExt;
pub use device::{ADBTcpDevice, ADBUSBDevice, is_adb_device, search_adb_devices};
pub use emulator_device::ADBEmulatorDevice;
pub use error::{Result, RustADBError};
pub use models::{ADBListItem, ADBListItemType, AdbStatResponse, RebootType};
pub use server::*;
pub use server_device::ADBServerDevice;
pub use transports::*;

View File

@@ -0,0 +1,69 @@
use std::{
collections::HashSet,
fmt::Display,
net::{IpAddr, Ipv4Addr, Ipv6Addr},
};
use mdns_sd::{ResolvedService, ScopedIp};
/// Represent a device found from mdns search
#[derive(Debug)]
pub struct MDNSDevice {
/// Full device address when resolved
pub fullname: String,
/// Device IP addresses
addresses: HashSet<IpAddr>,
}
impl MDNSDevice {
/// Return all adresses linked to this device
#[must_use]
pub fn addresses(&self) -> HashSet<IpAddr> {
self.addresses.clone()
}
/// Return all IPv4 addresses linked to this device
#[must_use]
pub fn ipv4_addresses(&self) -> HashSet<Ipv4Addr> {
self.addresses
.iter()
.filter_map(|addr| match addr {
IpAddr::V4(addr) => Some(addr),
IpAddr::V6(_) => None,
})
.copied()
.collect()
}
/// Return all IPv6 addresses linked to this device
#[must_use]
pub fn ipv6_addresses(&self) -> HashSet<Ipv6Addr> {
self.addresses
.iter()
.filter_map(|addr| match addr {
IpAddr::V4(_) => None,
IpAddr::V6(addr) => Some(addr),
})
.copied()
.collect()
}
}
impl From<Box<ResolvedService>> for MDNSDevice {
fn from(value: Box<ResolvedService>) -> Self {
Self {
fullname: value.fullname,
addresses: value.addresses.iter().map(ScopedIp::to_ip_addr).collect(),
}
}
}
impl Display for MDNSDevice {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
writeln!(f, "Device fullname: {}", self.fullname)?;
writeln!(f, "IPv4 Addresses: {:?}", self.ipv4_addresses())?;
write!(f, "IPv6 Addresses: {:?}", self.ipv6_addresses())?;
Ok(())
}
}

View File

@@ -0,0 +1,78 @@
use mdns_sd::{ServiceDaemon, ServiceEvent};
use std::{sync::mpsc::Sender, thread::JoinHandle};
use super::MDNSDevice;
use crate::{Result, RustADBError};
const ADB_SERVICE_NAME: &str = "_adb-tls-connect._tcp.local.";
/// Structure holding responsibility over mdns discovery
pub struct MDNSDiscoveryService {
daemon: ServiceDaemon,
thread_handle: Option<JoinHandle<Result<()>>>,
}
impl std::fmt::Debug for MDNSDiscoveryService {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("MDNSDiscoveryService")
.field("daemon", &self.daemon.get_metrics())
.field("handle", &self.thread_handle)
.finish()
}
}
impl MDNSDiscoveryService {
/// Instantiate a new discovery service to find devices over mdns
pub fn new() -> Result<Self> {
Ok(MDNSDiscoveryService {
daemon: ServiceDaemon::new()?,
thread_handle: None,
})
}
/// Start discovery by spawning a new background thread responsible of getting events.
pub fn start(&mut self, sender: Sender<MDNSDevice>) -> Result<()> {
let receiver = self.daemon.browse(ADB_SERVICE_NAME)?;
let handle: JoinHandle<Result<()>> = std::thread::spawn(move || {
loop {
while let Ok(event) = receiver.recv() {
match event {
ServiceEvent::SearchStarted(_)
| ServiceEvent::ServiceRemoved(_, _)
| ServiceEvent::ServiceFound(_, _)
| ServiceEvent::SearchStopped(_) => {
// Ignoring these events. We are only interesting in found devices
}
ServiceEvent::ServiceResolved(service_info) => {
sender
.send(MDNSDevice::from(service_info))
.map_err(|_| RustADBError::SendError)?;
}
e => {
log::warn!("received unknown event type {e:?}");
}
}
}
}
});
self.thread_handle = Some(handle);
Ok(())
}
/// Shutdown discovery engines.
pub fn shutdown(&mut self) -> Result<()> {
match self.daemon.shutdown() {
Ok(_) => Ok(()),
Err(e) => match e {
mdns_sd::Error::Again => {
self.daemon.shutdown()?;
Ok(())
}
e => Err(RustADBError::MDNSError(e)),
},
}
}
}

View File

@@ -0,0 +1,5 @@
mod mdns_device;
mod mdns_discovery;
pub use mdns_device::MDNSDevice;
pub use mdns_discovery::MDNSDiscoveryService;

View File

@@ -0,0 +1,116 @@
use std::fmt::Display;
use crate::{WaitForDeviceState, WaitForDeviceTransport};
use super::RebootType;
use std::net::SocketAddrV4;
pub(crate) enum AdbServerCommand {
// Host commands
Version,
Kill,
Devices,
DevicesLong,
TrackDevices,
HostFeatures,
Connect(SocketAddrV4),
Disconnect(SocketAddrV4),
Pair(SocketAddrV4, String),
TransportAny,
TransportSerial(String),
MDNSCheck,
MDNSServices,
ServerStatus,
ReconnectOffline,
Uninstall(String),
Install(u64),
WaitForDevice(WaitForDeviceState, WaitForDeviceTransport),
// Local commands
ShellCommand(String, Vec<String>),
Shell,
FrameBuffer,
Sync,
Reboot(RebootType),
Forward(String, String),
ForwardRemoveAll,
Reverse(String, String),
ReverseRemoveAll,
Reconnect,
TcpIp(u16),
Usb,
}
impl Display for AdbServerCommand {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
AdbServerCommand::Version => write!(f, "host:version"),
AdbServerCommand::Kill => write!(f, "host:kill"),
AdbServerCommand::Devices => write!(f, "host:devices"),
AdbServerCommand::DevicesLong => write!(f, "host:devices-l"),
AdbServerCommand::Sync => write!(f, "sync:"),
AdbServerCommand::TrackDevices => write!(f, "host:track-devices"),
AdbServerCommand::TransportAny => write!(f, "host:transport-any"),
AdbServerCommand::TransportSerial(serial) => write!(f, "host:transport:{serial}"),
AdbServerCommand::ShellCommand(command, args) => {
let args_s = args.join(",");
write!(
f,
"shell{}{args_s},raw:{command}",
if args.is_empty() { "" } else { "," }
)
}
AdbServerCommand::Shell => match std::env::var("TERM") {
Ok(term) => write!(f, "shell,TERM={term},raw:"),
Err(_) => write!(f, "shell,raw:"),
},
AdbServerCommand::HostFeatures => write!(f, "host:features"),
AdbServerCommand::Reboot(reboot_type) => {
write!(f, "reboot:{reboot_type}")
}
AdbServerCommand::Connect(addr) => write!(f, "host:connect:{addr}"),
AdbServerCommand::Disconnect(addr) => write!(f, "host:disconnect:{addr}"),
AdbServerCommand::Pair(addr, code) => {
write!(f, "host:pair:{code}:{addr}")
}
AdbServerCommand::FrameBuffer => write!(f, "framebuffer:"),
AdbServerCommand::Forward(remote, local) => {
write!(f, "host:forward:{local};{remote}")
}
AdbServerCommand::ForwardRemoveAll => write!(f, "host:killforward-all"),
AdbServerCommand::Reverse(remote, local) => {
write!(f, "reverse:forward:{remote};{local}")
}
AdbServerCommand::ReverseRemoveAll => write!(f, "reverse:killforward-all"),
AdbServerCommand::MDNSCheck => write!(f, "host:mdns:check"),
AdbServerCommand::MDNSServices => write!(f, "host:mdns:services"),
AdbServerCommand::ServerStatus => write!(f, "host:server-status"),
AdbServerCommand::Reconnect => write!(f, "reconnect"),
AdbServerCommand::ReconnectOffline => write!(f, "host:reconnect-offline"),
AdbServerCommand::TcpIp(port) => {
write!(f, "tcpip:{port}")
}
AdbServerCommand::Usb => write!(f, "usb:"),
AdbServerCommand::Install(size) => write!(f, "exec:cmd package 'install' -S {size}"),
AdbServerCommand::Uninstall(package) => {
write!(f, "exec:cmd package 'uninstall' {package}")
}
AdbServerCommand::WaitForDevice(wait_for_device_state, wait_for_device_transport) => {
write!(
f,
"host:wait-for-{wait_for_device_transport}-{wait_for_device_state}"
)
}
}
}
}
#[test]
fn test_pair_command() {
let host = "192.168.0.197:34783";
let code = "091102";
let code_u32 = code.parse::<u32>().expect("cannot parse u32");
let pair = AdbServerCommand::Pair(host.parse().expect("cannot parse host"), code.into());
assert_eq!(pair.to_string(), format!("host:pair:{code}:{host}"));
assert_ne!(pair.to_string(), format!("host:pair:{code_u32}:{host}"))
}

View File

@@ -0,0 +1,47 @@
use byteorder::ByteOrder;
use chrono::{DateTime, Utc};
use std::{
fmt::Display,
time::{Duration, UNIX_EPOCH},
};
use byteorder::LittleEndian;
use serde::{Deserialize, Serialize};
/// Represents a `stat` response
#[derive(Debug, Deserialize, Serialize)]
pub struct AdbStatResponse {
/// File permissions
pub file_perm: u32,
/// File size, in bytes
pub file_size: u32,
/// File modification time
pub mod_time: u32,
}
impl From<[u8; 12]> for AdbStatResponse {
fn from(value: [u8; 12]) -> Self {
Self {
file_perm: LittleEndian::read_u32(&value[0..4]),
file_size: LittleEndian::read_u32(&value[4..8]),
mod_time: LittleEndian::read_u32(&value[8..]),
}
}
}
impl Display for AdbStatResponse {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let d = UNIX_EPOCH + Duration::from_secs(self.mod_time.into());
// Create DateTime from SystemTime
let datetime = DateTime::<Utc>::from(d);
writeln!(f, "File permissions: {}", self.file_perm)?;
writeln!(f, "File size: {} bytes", self.file_size)?;
write!(
f,
"Modification time: {}",
datetime.format("%Y-%m-%d %H:%M:%S.%f %Z")
)?;
Ok(())
}
}

View File

@@ -0,0 +1,97 @@
use std::{iter::Map, slice::ChunksExact};
use byteorder::{ByteOrder, LittleEndian};
use crate::{Result, RustADBError};
type U32ChunkIter<'a> = Map<ChunksExact<'a, u8>, fn(&[u8]) -> Result<u32>>;
fn read_next(chunks: &mut U32ChunkIter) -> Result<u32> {
chunks
.next()
.ok_or(RustADBError::FramebufferConversionError)?
}
#[derive(Debug)]
pub(crate) struct FrameBufferInfoV1 {
pub _bpp: u32,
pub size: u32,
pub width: u32,
pub height: u32,
pub _red_offset: u32,
pub _red_length: u32,
pub _blue_offset: u32,
pub _blue_length: u32,
pub _green_offset: u32,
pub _green_length: u32,
pub _alpha_offset: u32,
pub _alpha_length: u32,
}
impl TryFrom<[u8; std::mem::size_of::<Self>()]> for FrameBufferInfoV1 {
type Error = RustADBError;
fn try_from(
value: [u8; std::mem::size_of::<Self>()],
) -> std::result::Result<Self, Self::Error> {
let mut chunks: U32ChunkIter = value.chunks_exact(4).map(|v| Ok(LittleEndian::read_u32(v)));
Ok(Self {
_bpp: read_next(&mut chunks)?,
size: read_next(&mut chunks)?,
width: read_next(&mut chunks)?,
height: read_next(&mut chunks)?,
_red_offset: read_next(&mut chunks)?,
_red_length: read_next(&mut chunks)?,
_blue_offset: read_next(&mut chunks)?,
_blue_length: read_next(&mut chunks)?,
_green_offset: read_next(&mut chunks)?,
_green_length: read_next(&mut chunks)?,
_alpha_offset: read_next(&mut chunks)?,
_alpha_length: read_next(&mut chunks)?,
})
}
}
#[derive(Debug)]
pub(crate) struct FrameBufferInfoV2 {
pub _bpp: u32,
pub _color_space: u32,
pub size: u32,
pub width: u32,
pub height: u32,
pub _red_offset: u32,
pub _red_length: u32,
pub _blue_offset: u32,
pub _blue_length: u32,
pub _green_offset: u32,
pub _green_length: u32,
pub _alpha_offset: u32,
pub _alpha_length: u32,
}
impl TryFrom<[u8; std::mem::size_of::<Self>()]> for FrameBufferInfoV2 {
type Error = RustADBError;
fn try_from(
value: [u8; std::mem::size_of::<Self>()],
) -> std::result::Result<Self, Self::Error> {
let mut chunks: U32ChunkIter = value.chunks_exact(4).map(|v| Ok(LittleEndian::read_u32(v)));
Ok(Self {
_bpp: read_next(&mut chunks)?,
_color_space: read_next(&mut chunks)?,
size: read_next(&mut chunks)?,
width: read_next(&mut chunks)?,
height: read_next(&mut chunks)?,
_red_offset: read_next(&mut chunks)?,
_red_length: read_next(&mut chunks)?,
_blue_offset: read_next(&mut chunks)?,
_blue_length: read_next(&mut chunks)?,
_green_offset: read_next(&mut chunks)?,
_green_length: read_next(&mut chunks)?,
_alpha_offset: read_next(&mut chunks)?,
_alpha_length: read_next(&mut chunks)?,
})
}
}

View File

@@ -0,0 +1,25 @@
#[derive(Debug, Eq, PartialEq, Ord, PartialOrd)]
/// A list entry on the remote device
pub struct ADBListItem {
/// The name of the file, not the path
pub name: String,
/// The unix time stamp of when it was last modified
pub time: u32,
/// The unix mode of the file, used for permissions and special bits
pub permissions: u32,
/// The size of the file
pub size: u32,
/// The type of item this is, file, directory or symlink
pub item_type: ADBListItemType,
}
#[derive(Debug, Eq, PartialEq, Ord, PartialOrd)]
/// The different types of item that the list item can be
pub enum ADBListItemType {
/// The entry is a file
File,
/// The entry is a directory
Directory,
/// The entry is a symlink
Symlink,
}

View File

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

View File

@@ -13,6 +13,8 @@ pub enum RebootType {
Sideload,
/// Same as `Sideload` but reboots after sideloading
SideloadAutoReboot,
/// Reboots to fastboot
Fastboot,
}
impl Display for RebootType {
@@ -23,6 +25,7 @@ impl Display for RebootType {
RebootType::Recovery => write!(f, "recovery"),
RebootType::Sideload => write!(f, "sideload"),
RebootType::SideloadAutoReboot => write!(f, "sideload-auto-reboot"),
RebootType::Fastboot => write!(f, "fastboot"),
}
}
}

View File

@@ -0,0 +1,23 @@
use std::fmt::Display;
pub enum SyncCommand {
/// List files in a folder
List,
/// Receive a file from the device
Recv,
/// Send a file to the device
Send,
// Stat a file
Stat,
}
impl Display for SyncCommand {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
SyncCommand::List => write!(f, "LIST"),
SyncCommand::Recv => write!(f, "RECV"),
SyncCommand::Send => write!(f, "SEND"),
SyncCommand::Stat => write!(f, "STAT"),
}
}
}

View File

@@ -0,0 +1,114 @@
use crate::ADBTransport;
use crate::Result;
use crate::RustADBError;
use crate::TCPServerTransport;
use std::collections::HashMap;
use std::net::SocketAddrV4;
use std::process::Command;
/// Represents an ADB Server
#[derive(Debug, Default)]
pub struct ADBServer {
/// Internal [`TcpStream`], lazily initialized
pub(crate) transport: Option<TCPServerTransport>,
/// Address to connect to
pub(crate) socket_addr: Option<SocketAddrV4>,
/// adb-server start envs
pub(crate) envs: HashMap<String, String>,
/// Path to adb binary
/// If not set, will use adb from PATH
pub(crate) adb_path: Option<String>,
}
impl ADBServer {
/// Instantiates a new [`ADBServer`]
#[must_use]
pub fn new(address: SocketAddrV4) -> Self {
Self {
transport: None,
socket_addr: Some(address),
envs: HashMap::new(),
adb_path: None,
}
}
/// Instantiates a new [`ADBServer`] with a custom adb path
#[must_use]
pub fn new_from_path(address: SocketAddrV4, adb_path: Option<String>) -> Self {
Self {
transport: None,
socket_addr: Some(address),
envs: HashMap::new(),
adb_path,
}
}
/// Start an instance of `adb-server`
pub fn start(envs: &HashMap<String, String>, adb_path: &Option<String>) {
// ADB Server is local, we start it if not already running
let mut command = Command::new(adb_path.as_deref().unwrap_or("adb"));
command.arg("start-server");
for (env_k, env_v) in envs {
command.env(env_k, env_v);
}
#[cfg(target_os = "windows")]
{
use std::os::windows::process::CommandExt;
// Do not show a prompt on Windows
command.creation_flags(0x08000000);
}
let child = command.spawn();
match child {
Ok(mut child) => {
if let Err(e) = child.wait() {
log::error!("error while starting adb server: {e}");
}
}
Err(e) => log::error!("error while starting adb server: {e}"),
}
}
/// Returns the current selected transport
pub(crate) fn get_transport(&mut self) -> Result<&mut TCPServerTransport> {
self.transport
.as_mut()
.ok_or(RustADBError::IOError(std::io::Error::new(
std::io::ErrorKind::NotConnected,
"server connection not initialized",
)))
}
/// Connect to underlying transport
pub(crate) fn connect(&mut self) -> Result<&mut TCPServerTransport> {
let mut is_local_ip = false;
let mut transport = if let Some(addr) = &self.socket_addr {
let ip = addr.ip();
if ip.is_loopback() || ip.is_unspecified() {
is_local_ip = true;
}
TCPServerTransport::new(*addr)
} else {
is_local_ip = true;
TCPServerTransport::default()
};
if is_local_ip {
Self::start(&self.envs, &self.adb_path);
}
transport.connect()?;
self.transport = Some(transport);
self.get_transport()
}
}
impl Drop for ADBServer {
fn drop(&mut self) {
if let Some(transport) = &mut self.transport {
let _ = transport.disconnect();
}
}
}

View File

@@ -0,0 +1,17 @@
use crate::{ADBServer, Result, RustADBError, models::AdbServerCommand};
use std::net::SocketAddrV4;
impl ADBServer {
/// Connect device over tcp with address and port
pub fn connect_device(&mut self, address: SocketAddrV4) -> Result<()> {
let response = self
.connect()?
.proxy_connection(AdbServerCommand::Connect(address), true)?;
match String::from_utf8(response) {
Ok(s) if s.starts_with("connected to") => Ok(()),
Ok(s) => Err(RustADBError::ADBRequestFailed(s)),
Err(e) => Err(e.into()),
}
}
}

View File

@@ -0,0 +1,123 @@
use std::io::Read;
use crate::{
ADBEmulatorDevice, ADBServer, ADBServerDevice, DeviceLong, DeviceShort, Result, RustADBError,
models::AdbServerCommand,
};
impl ADBServer {
/// Gets a list of connected devices.
pub fn devices(&mut self) -> Result<Vec<DeviceShort>> {
let devices = self
.connect()?
.proxy_connection(AdbServerCommand::Devices, true)?;
let mut vec_devices: Vec<DeviceShort> = vec![];
for device in devices.split(|x| x.eq(&b'\n')) {
if device.is_empty() {
break;
}
vec_devices.push(DeviceShort::try_from(device.to_vec())?);
}
Ok(vec_devices)
}
/// Gets an extended list of connected devices including the device paths in the state.
pub fn devices_long(&mut self) -> Result<Vec<DeviceLong>> {
let devices_long = self
.connect()?
.proxy_connection(AdbServerCommand::DevicesLong, true)?;
let mut vec_devices: Vec<DeviceLong> = vec![];
for device in devices_long.split(|x| x.eq(&b'\n')) {
if device.is_empty() {
break;
}
vec_devices.push(DeviceLong::try_from(device)?);
}
Ok(vec_devices)
}
/// Get a device, assuming that only this device is connected.
pub fn get_device(&mut self) -> Result<ADBServerDevice> {
let mut devices = self.devices()?.into_iter();
match devices.next() {
Some(device) => match devices.next() {
Some(_) => Err(RustADBError::DeviceNotFound(
"too many devices connected".to_string(),
)),
None => Ok(ADBServerDevice::new(device.identifier, self.socket_addr)),
},
None => Err(RustADBError::DeviceNotFound(
"no device connected".to_string(),
)),
}
}
/// Get a device matching the given name, if existing.
/// - There is no device connected => Error
/// - There is a single device connected => Ok
/// - There are more than 1 device connected => Error
pub fn get_device_by_name(&mut self, name: &str) -> Result<ADBServerDevice> {
let nb_devices = self
.devices()?
.into_iter()
.filter(|d| d.identifier.as_str() == name)
.collect::<Vec<DeviceShort>>()
.len();
if nb_devices == 1 {
Ok(ADBServerDevice::new(name.to_string(), self.socket_addr))
} else {
Err(RustADBError::DeviceNotFound(format!(
"could not find device {name}"
)))
}
}
/// Tracks new devices showing up.
pub fn track_devices(&mut self, callback: impl Fn(DeviceShort) -> Result<()>) -> Result<()> {
self.connect()?
.send_adb_request(AdbServerCommand::TrackDevices)?;
loop {
let length = self.get_transport()?.get_hex_body_length()?;
if length > 0 {
let mut body = vec![
0;
length
.try_into()
.map_err(|_| RustADBError::ConversionError)?
];
self.get_transport()?
.get_raw_connection()?
.read_exact(&mut body)?;
for device in body.split(|x| x.eq(&b'\n')) {
if device.is_empty() {
break;
}
callback(DeviceShort::try_from(device.to_vec())?)?;
}
}
}
}
/// Get an emulator, assuming that only this device is connected.
pub fn get_emulator_device(&mut self) -> Result<ADBEmulatorDevice> {
let device = self.get_device()?;
ADBEmulatorDevice::try_from(device)
}
/// Get an emulator by its name
pub fn get_emulator_device_by_name(&mut self, name: &str) -> Result<ADBEmulatorDevice> {
let device = self.get_device_by_name(name)?;
ADBEmulatorDevice::try_from(device)
}
}

View File

@@ -0,0 +1,17 @@
use crate::{ADBServer, Result, RustADBError, models::AdbServerCommand};
use std::net::SocketAddrV4;
impl ADBServer {
/// Connect device over tcp with address and port
pub fn disconnect_device(&mut self, address: SocketAddrV4) -> Result<()> {
let response = self
.connect()?
.proxy_connection(AdbServerCommand::Disconnect(address), true)?;
match String::from_utf8(response) {
Ok(s) if s.starts_with("disconnected") => Ok(()),
Ok(s) => Err(RustADBError::ADBRequestFailed(s)),
Err(e) => Err(e.into()),
}
}
}

View File

@@ -0,0 +1,10 @@
use crate::{ADBServer, Result, models::AdbServerCommand};
impl ADBServer {
/// Asks the ADB server to quit immediately.
pub fn kill(&mut self) -> Result<()> {
self.connect()?
.proxy_connection(AdbServerCommand::Kill, false)
.map(|_| ())
}
}

View File

@@ -0,0 +1,61 @@
use std::io::BufRead;
use crate::{
ADBServer, MDNSServices, Result, models::AdbServerCommand, server::models::MDNSBackend,
};
const OPENSCREEN_MDNS_BACKEND: &str = "ADB_MDNS_OPENSCREEN";
impl ADBServer {
/// Check if mdns discovery is available
pub fn mdns_check(&mut self) -> Result<bool> {
let response = self
.connect()?
.proxy_connection(AdbServerCommand::MDNSCheck, true)?;
match String::from_utf8(response) {
Ok(s) if s.starts_with("mdns daemon version") => Ok(true),
Ok(_) => Ok(false),
Err(e) => Err(e.into()),
}
}
/// List all discovered mdns services
pub fn mdns_services(&mut self) -> Result<Vec<MDNSServices>> {
let services = self
.connect()?
.proxy_connection(AdbServerCommand::MDNSServices, true)?;
let mut vec_services: Vec<MDNSServices> = vec![];
for service in services.lines() {
match service {
Ok(service) => {
vec_services.push(MDNSServices::try_from(service.as_bytes())?);
}
Err(e) => log::error!("{e}"),
}
}
Ok(vec_services)
}
/// Check if specified backend mdns service is used, otherwise restart adb server with envs
pub fn mdns_force_backend(&mut self, backend: MDNSBackend) -> Result<()> {
let server_status = self.server_status()?;
if server_status.mdns_backend != backend {
self.kill()?;
self.envs.insert(
OPENSCREEN_MDNS_BACKEND.to_string(),
(if backend == MDNSBackend::OpenScreen {
"1"
} else {
"0"
})
.to_string(),
);
self.connect()?;
}
Ok(())
}
}

View File

@@ -0,0 +1,10 @@
mod connect;
mod devices;
mod disconnect;
mod kill;
mod mdns;
mod pair;
mod reconnect;
mod server_status;
mod version;
mod wait_for_device;

View File

@@ -0,0 +1,18 @@
use crate::models::AdbServerCommand;
use crate::{ADBServer, Result, RustADBError};
use std::net::SocketAddrV4;
impl ADBServer {
/// Pair device on a specific port with a generated 'code'
pub fn pair(&mut self, address: SocketAddrV4, code: String) -> Result<()> {
let response = self
.connect()?
.proxy_connection(AdbServerCommand::Pair(address, code), true)?;
match String::from_utf8(response) {
Ok(s) if s.starts_with("Successfully paired to") => Ok(()),
Ok(s) => Err(RustADBError::ADBRequestFailed(s)),
Err(e) => Err(e.into()),
}
}
}

View File

@@ -0,0 +1,10 @@
use crate::{ADBServer, Result, models::AdbServerCommand};
impl ADBServer {
/// Reconnect the device
pub fn reconnect_offline(&mut self) -> Result<()> {
self.connect()?
.proxy_connection(AdbServerCommand::ReconnectOffline, false)
.map(|_| ())
}
}

View File

@@ -0,0 +1,12 @@
use crate::{ADBServer, Result, models::AdbServerCommand, server::models::ServerStatus};
impl ADBServer {
/// Check ADB server status
pub fn server_status(&mut self) -> Result<ServerStatus> {
let status = self
.connect()?
.proxy_connection(AdbServerCommand::ServerStatus, true)?;
ServerStatus::try_from(status)
}
}

View File

@@ -0,0 +1,12 @@
use crate::{ADBServer, AdbVersion, Result, models::AdbServerCommand};
impl ADBServer {
/// Gets server's internal version number.
pub fn version(&mut self) -> Result<AdbVersion> {
let version = self
.connect()?
.proxy_connection(AdbServerCommand::Version, true)?;
AdbVersion::try_from(version)
}
}

View File

@@ -0,0 +1,20 @@
use crate::{
ADBServer, Result, WaitForDeviceState, WaitForDeviceTransport, models::AdbServerCommand,
};
impl ADBServer {
/// Wait for a device in a given state to be connected
pub fn wait_for_device(
&mut self,
state: WaitForDeviceState,
transport: Option<WaitForDeviceTransport>,
) -> Result<()> {
let transport = transport.unwrap_or_default();
self.connect()?
.send_adb_request(AdbServerCommand::WaitForDevice(state, transport))?;
// Server should respond with an "OKAY" response
self.get_transport()?.read_adb_response()
}
}

View File

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

View File

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

View File

@@ -1,11 +1,15 @@
use std::str::FromStr;
use std::sync::LazyLock;
use std::{fmt::Display, str};
use crate::{DeviceState, RustADBError};
use regex::bytes::Regex;
use crate::{DeviceState, RustADBError};
static DEVICES_LONG_REGEX: LazyLock<Regex> = LazyLock::new(|| {
Regex::new(r"^(?P<identifier>\S+)\s+(?P<state>\w+)\s+(usb:(?P<usb1>\S+)|(?P<usb2>\S+))?\s*(product:(?P<product>\S+)\s+model:(?P<model>\w+)\s+device:(?P<device>\S+)\s+)?transport_id:(?P<transport_id>\d+)$").expect("cannot build devices long regex")
});
/// Represents a new device with more informations helded.
/// Represents a new device with more informations.
#[derive(Debug)]
pub struct DeviceLong {
/// Unique device identifier.
@@ -40,15 +44,12 @@ impl Display for DeviceLong {
}
}
impl TryFrom<Vec<u8>> for DeviceLong {
impl TryFrom<&[u8]> for DeviceLong {
type Error = RustADBError;
// TODO: Prevent regex compilation every call to try_from()
fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
let parse_regex = Regex::new("^(?P<identifier>\\w+)\\s+(?P<state>\\w+) usb:(?P<usb>.*) (product:(?P<product>\\w+) model:(?P<model>\\w+) device:(?P<device>\\w+) )?transport_id:(?P<transport_id>\\d+)$")?;
let groups = parse_regex
.captures(&value)
fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
let groups = DEVICES_LONG_REGEX
.captures(value)
.ok_or(RustADBError::RegexParsingError)?;
Ok(DeviceLong {
@@ -66,13 +67,13 @@ impl TryFrom<Vec<u8>> for DeviceLong {
.as_bytes()
.to_vec(),
)?)?,
usb: String::from_utf8(
groups
.name("usb")
.ok_or(RustADBError::RegexParsingError)?
.as_bytes()
.to_vec(),
)?,
usb: match groups.name("usb1") {
None => match groups.name("usb2") {
None => "Unk".to_string(),
Some(usb) => String::from_utf8(usb.as_bytes().to_vec())?,
},
Some(usb) => String::from_utf8(usb.as_bytes().to_vec())?,
},
product: match groups.name("product") {
None => "Unk".to_string(),
Some(product) => String::from_utf8(product.as_bytes().to_vec())?,
@@ -85,15 +86,28 @@ impl TryFrom<Vec<u8>> for DeviceLong {
None => "Unk".to_string(),
Some(device) => String::from_utf8(device.as_bytes().to_vec())?,
},
transport_id: u32::from_str_radix(
str::from_utf8(
groups
.name("transport_id")
.ok_or(RustADBError::RegexParsingError)?
.as_bytes(),
)?,
16,
)?,
transport_id: (str::from_utf8(
groups
.name("transport_id")
.ok_or(RustADBError::RegexParsingError)?
.as_bytes(),
)?)
.parse::<u32>()?,
})
}
}
#[test]
fn test_static_devices_long() {
let inputs = [
"7a5158f05122195aa device 1-5 product:gts210vewifixx model:SM_T813 device:gts210vewifi transport_id:4",
"n311r05e device usb:0-1.5 product:alioth model:M2012K11AC device:alioth transport_id:58",
"192.168.100.192:5555 device product:alioth model:M2012K11AC device:alioth transport_id:97",
"emulator-5554 device product:sdk_gphone64_arm64 model:sdk_gphone64_arm64 device:emu64a transport_id:101",
"QQ20131020250511 device 20-4 product:NOH-AN00 model:NOH_AN00 device:HWNOH transport_id:3",
];
for input in inputs {
DeviceLong::try_from(input.as_bytes())
.unwrap_or_else(|_| panic!("cannot parse input: '{input}'"));
}
}

View File

@@ -1,35 +1,35 @@
use lazy_static::lazy_static;
use regex::bytes::Regex;
use std::{fmt::Display, str::FromStr};
use std::{fmt::Display, str::FromStr, sync::LazyLock};
use crate::{DeviceState, RustADBError};
lazy_static! {
static ref DEVICES_REGEX: Regex = Regex::new("^(\\S+)\t(\\w+)\n?$").unwrap();
}
static DEVICES_REGEX: LazyLock<Regex> =
LazyLock::new(|| Regex::new("^(\\S+)\t(\\w+)\n?$").expect("Cannot build devices regex"));
/// Represents a device connected to the ADB server.
#[derive(Debug)]
pub struct Device {
#[derive(Debug, Clone)]
pub struct DeviceShort {
/// Unique device identifier.
pub identifier: String,
/// Connection state of the device.
pub state: DeviceState,
}
impl Display for Device {
impl Display for DeviceShort {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}\t{}", self.identifier, self.state)
}
}
impl TryFrom<Vec<u8>> for Device {
impl TryFrom<Vec<u8>> for DeviceShort {
type Error = RustADBError;
fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
// Optional final '\n' is used to match TrackDevices inputs
let groups = DEVICES_REGEX.captures(&value).unwrap();
Ok(Device {
let groups = DEVICES_REGEX
.captures(&value)
.ok_or(RustADBError::RegexParsingError)?;
Ok(DeviceShort {
identifier: String::from_utf8(
groups
.get(1)

View File

@@ -3,7 +3,7 @@ use std::{fmt::Display, str::FromStr};
use crate::RustADBError;
/// Represents the connection state of the device.
#[derive(Debug)]
#[derive(Debug, Clone)]
pub enum DeviceState {
/// The device is not connected to adb or is not responding.
Offline,
@@ -15,6 +15,22 @@ pub enum DeviceState {
Authorizing,
/// The device is unauthorized.
Unauthorized,
/// Haven't received a response from the device yet.
Connecting,
/// Insufficient permissions to communicate with the device.
NoPerm,
/// USB device detached from the adb server (known but not opened/claimed).
Detached,
/// Device running fastboot OS (fastboot) or userspace fastboot (fastbootd).
Bootloader,
/// What a device sees from its end of a Transport (adb host).
Host,
/// Device with bootloader loaded but no ROM OS loaded (adbd).
Recovery,
/// Device running Android OS Sideload mode (minadbd sideload mode).
Sideload,
/// Device running Android OS Rescue mode (minadbd rescue mode).
Rescue,
}
impl Display for DeviceState {
@@ -25,6 +41,14 @@ impl Display for DeviceState {
DeviceState::NoDevice => write!(f, "no device"),
DeviceState::Authorizing => write!(f, "authorizing"),
DeviceState::Unauthorized => write!(f, "unauthorized"),
DeviceState::Connecting => write!(f, "connecting"),
DeviceState::NoPerm => write!(f, "noperm"),
DeviceState::Detached => write!(f, "detached"),
DeviceState::Bootloader => write!(f, "bootloader"),
DeviceState::Host => write!(f, "host"),
DeviceState::Recovery => write!(f, "recovery"),
DeviceState::Sideload => write!(f, "sideload"),
DeviceState::Rescue => write!(f, "rescue"),
}
}
}
@@ -40,6 +64,14 @@ impl FromStr for DeviceState {
"no device" => Ok(Self::NoDevice),
"authorizing" => Ok(Self::Authorizing),
"unauthorized" => Ok(Self::Unauthorized),
"connecting" => Ok(Self::Connecting),
"noperm" => Ok(Self::NoPerm),
"detached" => Ok(Self::Detached),
"bootloader" => Ok(Self::Bootloader),
"host" => Ok(Self::Host),
"recovery" => Ok(Self::Recovery),
"sideload" => Ok(Self::Sideload),
"rescue" => Ok(Self::Rescue),
_ => Err(RustADBError::UnknownDeviceState(lowercased)),
}
}

View File

@@ -0,0 +1,64 @@
use regex::bytes::Regex;
use std::net::SocketAddrV4;
use std::sync::LazyLock;
use std::{fmt::Display, str::FromStr};
use crate::RustADBError;
static MDNS_SERVICES_REGEX: LazyLock<Regex> = LazyLock::new(|| {
Regex::new("^(\\S+)\t(\\S+)\t([\\d\\.]+:\\d+)\n?$").expect("Cannot build mdns services regex")
});
/// Represents MDNS Services
#[derive(Debug, Clone)]
pub struct MDNSServices {
/// Service name
pub service_name: String,
/// Reg type
pub reg_type: String,
/// IP addr with port
pub socket_v4: SocketAddrV4,
}
impl Display for MDNSServices {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}\t{}\t{}",
self.service_name, self.reg_type, self.socket_v4
)
}
}
impl TryFrom<&[u8]> for MDNSServices {
type Error = RustADBError;
fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
let groups = MDNS_SERVICES_REGEX
.captures(value)
.ok_or(RustADBError::RegexParsingError)?;
Ok(MDNSServices {
service_name: String::from_utf8(
groups
.get(1)
.ok_or(RustADBError::RegexParsingError)?
.as_bytes()
.to_vec(),
)?,
reg_type: String::from_utf8(
groups
.get(2)
.ok_or(RustADBError::RegexParsingError)?
.as_bytes()
.to_vec(),
)?,
socket_v4: SocketAddrV4::from_str(&String::from_utf8(
groups
.get(3)
.ok_or(RustADBError::RegexParsingError)?
.as_bytes()
.to_vec(),
)?)?,
})
}
}

View File

@@ -0,0 +1,15 @@
mod adb_version;
mod device_long;
mod device_short;
mod device_state;
mod mdns_services;
mod server_status;
mod wait_for_device;
pub use adb_version::AdbVersion;
pub use device_long::DeviceLong;
pub use device_short::DeviceShort;
pub use device_state::DeviceState;
pub use mdns_services::MDNSServices;
pub use server_status::{MDNSBackend, ServerStatus};
pub use wait_for_device::{WaitForDeviceState, WaitForDeviceTransport};

View File

@@ -0,0 +1,167 @@
use quick_protobuf::{BytesReader, MessageRead};
use std::fmt::Display;
use crate::RustADBError;
#[derive(Debug, PartialEq, Default, Eq, Clone, Copy)]
pub enum UsbBackend {
#[default]
Unknown = 0,
Native = 1,
LibUSB = 2,
}
impl From<i32> for UsbBackend {
fn from(i: i32) -> Self {
match i {
0 => UsbBackend::Unknown,
1 => UsbBackend::Native,
2 => UsbBackend::LibUSB,
_ => Self::default(),
}
}
}
impl<'a> From<&'a str> for UsbBackend {
fn from(s: &'a str) -> Self {
match s {
"UNKNOWN_USB" => UsbBackend::Unknown,
"NATIVE" => UsbBackend::Native,
"LIBUSB" => UsbBackend::LibUSB,
_ => Self::default(),
}
}
}
impl Display for UsbBackend {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
UsbBackend::Unknown => write!(f, "UNKNOWN_USB"),
UsbBackend::Native => write!(f, "NATIVE"),
UsbBackend::LibUSB => write!(f, "LIBUSB"),
}
}
}
/// MDNS Backend Status
#[derive(Debug, Clone, PartialEq, Default)]
pub enum MDNSBackend {
#[default]
/// `Unknown`
Unknown = 0,
/// `Bonjour`
Bonjour = 1,
/// `OpenScreen`
OpenScreen = 2,
}
impl From<i32> for MDNSBackend {
fn from(i: i32) -> Self {
match i {
0 => MDNSBackend::Unknown,
1 => MDNSBackend::Bonjour,
2 => MDNSBackend::OpenScreen,
_ => Self::default(),
}
}
}
impl<'a> From<&'a str> for MDNSBackend {
fn from(s: &'a str) -> Self {
match s {
"UNKNOWN_MDNS" => MDNSBackend::Unknown,
"BONJOUR" => MDNSBackend::Bonjour,
"OPENSCREEN" => MDNSBackend::OpenScreen,
_ => Self::default(),
}
}
}
impl Display for MDNSBackend {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
MDNSBackend::Unknown => write!(f, "UNKNOWN_MDNS"),
MDNSBackend::Bonjour => write!(f, "BONJOUR"),
MDNSBackend::OpenScreen => write!(f, "OPENSCREEN"),
}
}
}
/// Structure representing current server status
#[derive(Debug, Clone, Default, PartialEq)]
pub struct ServerStatus {
/// Currently active USB backend
pub usb_backend: UsbBackend,
/// Is USB backend forced ?
pub usb_backend_forced: bool,
/// Currently active MDNS backend
pub mdns_backend: MDNSBackend,
/// Is MDNS backend forced ?
pub mdns_backend_forced: bool,
/// Server version
pub version: String,
/// Server build information
pub build: String,
/// Server executable absolute path
pub executable_absolute_path: String,
/// Server logs absolute path
pub log_absolute_path: String,
/// OS server is running on
pub os: String,
}
impl<'a> MessageRead<'a> for ServerStatus {
fn from_reader(r: &mut BytesReader, bytes: &'a [u8]) -> quick_protobuf::Result<Self> {
let mut msg = Self::default();
while !r.is_eof() {
match r.next_tag(bytes) {
Ok(8) => msg.usb_backend = r.read_enum(bytes)?,
Ok(16) => msg.usb_backend_forced = r.read_bool(bytes)?,
Ok(24) => msg.mdns_backend = r.read_enum(bytes)?,
Ok(32) => msg.mdns_backend_forced = r.read_bool(bytes)?,
Ok(42) => msg.version = r.read_string(bytes)?.to_string(),
Ok(50) => msg.build = r.read_string(bytes)?.to_string(),
Ok(58) => msg.executable_absolute_path = r.read_string(bytes)?.to_string(),
Ok(66) => msg.log_absolute_path = r.read_string(bytes)?.to_string(),
Ok(74) => msg.os = r.read_string(bytes)?.to_string(),
Ok(t) => {
r.read_unknown(bytes, t)?;
}
Err(e) => return Err(e),
}
}
Ok(msg)
}
}
impl Display for ServerStatus {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
writeln!(f, "usb_backend: {}", self.usb_backend)?;
if self.usb_backend_forced {
writeln!(f, "usb_backend_forced: {}", self.usb_backend_forced)?;
}
writeln!(f, "mdns_backend: {}", self.mdns_backend)?;
if self.mdns_backend_forced {
writeln!(f, "mdns_backend_forced: {}", self.mdns_backend_forced)?;
}
writeln!(f, "version: \"{}\"", self.version)?;
writeln!(f, "build: \"{}\"", self.build)?;
writeln!(
f,
"executable_absolute_path: \"{}\"",
self.executable_absolute_path
)?;
writeln!(f, "log_absolute_path: \"{}\"", self.log_absolute_path)?;
writeln!(f, "os: \"{}\"", self.os)
}
}
impl TryFrom<Vec<u8>> for ServerStatus {
type Error = RustADBError;
fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
let mut reader = BytesReader::from_bytes(&value);
ServerStatus::from_reader(&mut reader, &value).map_err(|_| RustADBError::ConversionError)
}
}

View File

@@ -0,0 +1,62 @@
use std::{fmt::Display, str::FromStr};
use crate::RustADBError;
#[derive(Clone, Debug, Default)]
/// List of available transports to wait for.
pub enum WaitForDeviceTransport {
/// USB transport
Usb,
/// Local transport
Local,
/// Any transport (default value)
#[default]
Any,
}
impl Display for WaitForDeviceTransport {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
WaitForDeviceTransport::Usb => write!(f, "usb"),
WaitForDeviceTransport::Local => write!(f, "local"),
WaitForDeviceTransport::Any => write!(f, "any"),
}
}
}
impl FromStr for WaitForDeviceTransport {
type Err = RustADBError;
fn from_str(value: &str) -> Result<Self, Self::Err> {
match value {
"usb" => Ok(Self::Usb),
"local" => Ok(Self::Local),
"any" => Ok(Self::Any),
t => Err(RustADBError::UnknownTransport(t.to_string())),
}
}
}
#[derive(Debug)]
/// List of available states to wait for.
pub enum WaitForDeviceState {
/// Device in "device" state
Device,
/// Device in "recovery" state
Recovery,
/// Device in "sideload" state
Sideload,
/// Device in "bootloader" state
Bootloader,
}
impl Display for WaitForDeviceState {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
WaitForDeviceState::Device => write!(f, "device"),
WaitForDeviceState::Recovery => write!(f, "recovery"),
WaitForDeviceState::Sideload => write!(f, "sideload"),
WaitForDeviceState::Bootloader => write!(f, "bootloader"),
}
}
}

View File

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

View File

@@ -0,0 +1,142 @@
use std::{
io::{ErrorKind, Read, Write},
path::Path,
};
use crate::{
ADBDeviceExt, Result, RustADBError,
constants::BUFFER_SIZE,
models::{AdbServerCommand, AdbStatResponse, HostFeatures},
};
use super::ADBServerDevice;
impl ADBDeviceExt for ADBServerDevice {
fn shell_command(&mut self, command: &[&str], output: &mut dyn Write) -> Result<()> {
let supported_features = self.host_features()?;
if !supported_features.contains(&HostFeatures::ShellV2)
&& !supported_features.contains(&HostFeatures::Cmd)
{
return Err(RustADBError::ADBShellNotSupported);
}
self.set_serial_transport()?;
// Prepare shell command arguments
let mut args = Vec::new();
let command_string = command.join(" ");
// Add v2 mode if supported
if supported_features.contains(&HostFeatures::ShellV2) {
log::debug!("using shell_v2 feature");
args.push("v2".to_string());
}
// Include terminal information if available
if let Ok(term) = std::env::var("TERM") {
args.push(format!("TERM={term}"));
}
// Send the request
self.transport
.send_adb_request(AdbServerCommand::ShellCommand(command_string, args))?;
let mut buffer = vec![0; BUFFER_SIZE].into_boxed_slice();
loop {
match self.transport.get_raw_connection()?.read(&mut buffer) {
Ok(size) => {
if size == 0 {
return Ok(());
}
output.write_all(&buffer[..size])?;
}
Err(e) => {
return Err(RustADBError::IOError(e));
}
}
}
}
fn stat(&mut self, remote_path: &str) -> Result<AdbStatResponse> {
self.stat(remote_path)
}
fn shell(
&mut self,
mut reader: &mut dyn Read,
mut writer: Box<dyn Write + Send>,
) -> Result<()> {
let supported_features = self.host_features()?;
if !supported_features.contains(&HostFeatures::ShellV2)
&& !supported_features.contains(&HostFeatures::Cmd)
{
return Err(RustADBError::ADBShellNotSupported);
}
self.set_serial_transport()?;
self.transport.send_adb_request(AdbServerCommand::Shell)?;
let mut read_stream = self.transport.get_raw_connection()?.try_clone()?;
let mut write_stream = read_stream.try_clone()?;
// Reading thread, reads response from adb-server
std::thread::spawn(move || -> Result<()> {
let mut buffer = vec![0; BUFFER_SIZE].into_boxed_slice();
loop {
match read_stream.read(&mut buffer) {
Ok(0) => {
read_stream.shutdown(std::net::Shutdown::Both)?;
return Ok(());
}
Ok(size) => {
writer.write_all(&buffer[..size])?;
writer.flush()?;
}
Err(e) => {
return Err(RustADBError::IOError(e));
}
}
}
});
// Read from given reader (that could be stdin e.g), and write content to server socket
if let Err(e) = std::io::copy(&mut reader, &mut write_stream) {
match e.kind() {
ErrorKind::BrokenPipe => return Ok(()),
_ => return Err(RustADBError::IOError(e)),
}
}
Ok(())
}
fn pull(&mut self, source: &dyn AsRef<str>, mut output: &mut dyn Write) -> Result<()> {
self.pull(source, &mut output)
}
fn reboot(&mut self, reboot_type: crate::RebootType) -> Result<()> {
self.reboot(reboot_type)
}
fn push(&mut self, stream: &mut dyn Read, path: &dyn AsRef<str>) -> Result<()> {
self.push(stream, path)
}
fn install(&mut self, apk_path: &dyn AsRef<Path>) -> Result<()> {
self.install(apk_path)
}
fn uninstall(&mut self, package: &str) -> Result<()> {
self.uninstall(package)
}
fn framebuffer_inner(&mut self) -> Result<image::ImageBuffer<image::Rgba<u8>, Vec<u8>>> {
self.framebuffer_inner()
}
fn list(&mut self, path: &dyn AsRef<str>) -> Result<Vec<crate::ADBListItem>> {
self.list(path)
}
}

View File

@@ -0,0 +1,21 @@
use crate::{ADBServerDevice, Result, models::AdbServerCommand};
impl ADBServerDevice {
/// Forward socket connection
pub fn forward(&mut self, remote: String, local: String) -> Result<()> {
self.set_serial_transport()?;
self.transport
.proxy_connection(AdbServerCommand::Forward(remote, local), false)
.map(|_| ())
}
/// Remove all previously applied forward rules
pub fn forward_remove_all(&mut self) -> Result<()> {
self.set_serial_transport()?;
self.transport
.proxy_connection(AdbServerCommand::ForwardRemoveAll, false)
.map(|_| ())
}
}

View File

@@ -0,0 +1,76 @@
use std::io::Read;
use byteorder::{LittleEndian, ReadBytesExt};
use image::{ImageBuffer, Rgba};
use crate::{
ADBServerDevice, Result, RustADBError,
models::{AdbServerCommand, FrameBufferInfoV1, FrameBufferInfoV2},
};
impl ADBServerDevice {
/// Inner method requesting framebuffer from Android device
pub(crate) fn framebuffer_inner(&mut self) -> Result<ImageBuffer<Rgba<u8>, Vec<u8>>> {
self.set_serial_transport()?;
self.transport
.send_adb_request(AdbServerCommand::FrameBuffer)?;
let version = self
.transport
.get_raw_connection()?
.read_u32::<LittleEndian>()?;
match version {
// RGBA_8888
1 => {
let mut buf = [0u8; std::mem::size_of::<FrameBufferInfoV1>()];
self.transport.get_raw_connection()?.read_exact(&mut buf)?;
let framebuffer_info: FrameBufferInfoV1 = buf.try_into()?;
let mut data = vec![
0_u8;
framebuffer_info
.size
.try_into()
.map_err(|_| RustADBError::ConversionError)?
];
self.transport.get_raw_connection()?.read_exact(&mut data)?;
Ok(ImageBuffer::<Rgba<u8>, Vec<u8>>::from_vec(
framebuffer_info.width,
framebuffer_info.height,
data,
)
.ok_or_else(|| RustADBError::FramebufferConversionError)?)
}
// RGBX_8888
2 => {
let mut buf = [0u8; std::mem::size_of::<FrameBufferInfoV2>()];
self.transport.get_raw_connection()?.read_exact(&mut buf)?;
let framebuffer_info: FrameBufferInfoV2 = buf.try_into()?;
let mut data = vec![
0_u8;
framebuffer_info
.size
.try_into()
.map_err(|_| RustADBError::ConversionError)?
];
self.transport.get_raw_connection()?.read_exact(&mut data)?;
Ok(ImageBuffer::<Rgba<u8>, Vec<u8>>::from_vec(
framebuffer_info.width,
framebuffer_info.height,
data,
)
.ok_or_else(|| RustADBError::FramebufferConversionError)?)
}
v => Err(RustADBError::UnimplementedFramebufferImageVersion(v)),
}
}
}

View File

@@ -0,0 +1,20 @@
use crate::{
ADBServerDevice, Result,
models::{AdbServerCommand, HostFeatures},
};
impl ADBServerDevice {
/// Lists available ADB server features.
pub fn host_features(&mut self) -> Result<Vec<HostFeatures>> {
self.set_serial_transport()?;
let features = self
.transport
.proxy_connection(AdbServerCommand::HostFeatures, true)?;
Ok(features
.split(|x| x.eq(&b','))
.filter_map(|v| HostFeatures::try_from(v).ok())
.collect())
}
}

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