feat: impl parts of diagnostics and mobilebackup2 (#20)

* feat: add udid cache to idevice

* feat: impl diagnostics

* feat: impl mobilebackup2

* docs: update README.md

* fix: make clippy happy

* fix: make linux clippy happy

* fix: make linux clippy happy again

* fix: make clippy happy again

* fix: small updates
This commit is contained in:
Ylarod
2025-08-13 21:41:48 +08:00
committed by GitHub
parent 5477571a80
commit 0bb5deada8
9 changed files with 2234 additions and 5 deletions

562
tools/src/mobilebackup2.rs Normal file
View File

@@ -0,0 +1,562 @@
// Jackson Coxson
// Mobile Backup 2 tool for iOS devices
use clap::{Arg, Command};
use idevice::{mobilebackup2::{MobileBackup2Client, RestoreOptions}, IdeviceService};
use plist::Dictionary;
use std::fs;
use std::io::{Read, Write};
use std::path::Path;
mod common;
#[tokio::main]
async fn main() {
env_logger::init();
let matches = Command::new("mobilebackup2")
.about("Mobile Backup 2 tool for iOS devices")
.arg(
Arg::new("host")
.long("host")
.value_name("HOST")
.help("IP address of the device"),
)
.arg(
Arg::new("pairing_file")
.long("pairing-file")
.value_name("PATH")
.help("Path to the pairing file"),
)
.arg(
Arg::new("udid")
.value_name("UDID")
.help("UDID of the device (overrides host/pairing file)")
.index(1),
)
.arg(
Arg::new("about")
.long("about")
.help("Show about information")
.action(clap::ArgAction::SetTrue),
)
.subcommand(
Command::new("info")
.about("Get backup information from a local backup directory")
.arg(Arg::new("dir").long("dir").value_name("DIR").required(true))
.arg(Arg::new("source").long("source").value_name("SOURCE").help("Source identifier (defaults to current UDID)"))
)
.subcommand(
Command::new("list")
.about("List files of the last backup from a local backup directory")
.arg(Arg::new("dir").long("dir").value_name("DIR").required(true))
.arg(Arg::new("source").long("source").value_name("SOURCE"))
)
.subcommand(
Command::new("backup")
.about("Start a backup operation")
.arg(
Arg::new("dir")
.long("dir")
.value_name("DIR")
.help("Backup directory on host")
.required(true),
)
.arg(
Arg::new("target")
.long("target")
.value_name("TARGET")
.help("Target identifier for the backup"),
)
.arg(
Arg::new("source")
.long("source")
.value_name("SOURCE")
.help("Source identifier for the backup"),
),
)
.subcommand(
Command::new("restore")
.about("Restore from a local backup directory (DeviceLink)")
.arg(Arg::new("dir").long("dir").value_name("DIR").required(true))
.arg(Arg::new("source").long("source").value_name("SOURCE").help("Source UDID; defaults to current device UDID"))
.arg(Arg::new("password").long("password").value_name("PWD").help("Backup password if encrypted"))
.arg(Arg::new("no-reboot").long("no-reboot").action(clap::ArgAction::SetTrue))
.arg(Arg::new("no-copy").long("no-copy").action(clap::ArgAction::SetTrue))
.arg(Arg::new("no-settings").long("no-settings").action(clap::ArgAction::SetTrue))
.arg(Arg::new("system").long("system").action(clap::ArgAction::SetTrue))
.arg(Arg::new("remove").long("remove").action(clap::ArgAction::SetTrue))
)
.subcommand(
Command::new("unback")
.about("Unpack a complete backup to device hierarchy")
.arg(Arg::new("dir").long("dir").value_name("DIR").required(true))
.arg(Arg::new("source").long("source").value_name("SOURCE"))
.arg(Arg::new("password").long("password").value_name("PWD"))
)
.subcommand(
Command::new("extract")
.about("Extract a file from a previous backup")
.arg(Arg::new("dir").long("dir").value_name("DIR").required(true))
.arg(Arg::new("source").long("source").value_name("SOURCE"))
.arg(Arg::new("domain").long("domain").value_name("DOMAIN").required(true))
.arg(Arg::new("path").long("path").value_name("REL_PATH").required(true))
.arg(Arg::new("password").long("password").value_name("PWD"))
)
.subcommand(
Command::new("change-password")
.about("Change backup password")
.arg(Arg::new("dir").long("dir").value_name("DIR").required(true))
.arg(Arg::new("old").long("old").value_name("OLD"))
.arg(Arg::new("new").long("new").value_name("NEW"))
)
.subcommand(
Command::new("erase-device")
.about("Erase the device via mobilebackup2")
.arg(Arg::new("dir").long("dir").value_name("DIR").required(true))
)
.subcommand(Command::new("freespace").about("Get free space information"))
.subcommand(Command::new("encryption").about("Check backup encryption status"))
.get_matches();
if matches.get_flag("about") {
println!("mobilebackup2 - manage device backups using Mobile Backup 2 service");
println!("Copyright (c) 2025 Jackson Coxson");
return;
}
let udid = matches.get_one::<String>("udid");
let host = matches.get_one::<String>("host");
let pairing_file = matches.get_one::<String>("pairing_file");
let provider = match common::get_provider(udid, host, pairing_file, "mobilebackup2-jkcoxson").await
{
Ok(p) => p,
Err(e) => {
eprintln!("Error creating provider: {e}");
return;
}
};
let mut backup_client = match MobileBackup2Client::connect(&*provider).await {
Ok(client) => client,
Err(e) => {
eprintln!("Unable to connect to mobilebackup2 service: {e}");
return;
}
};
match matches.subcommand() {
Some(("info", sub)) => {
let dir = sub.get_one::<String>("dir").unwrap();
let source = sub.get_one::<String>("source").map(|s| s.as_str());
match backup_client.info_from_path(Path::new(dir), source).await {
Ok(dict) => {
println!("Backup Information:");
for (k, v) in dict { println!(" {k}: {v:?}"); }
}
Err(e) => eprintln!("Failed to get info: {e}"),
}
}
Some(("list", sub)) => {
let dir = sub.get_one::<String>("dir").unwrap();
let source = sub.get_one::<String>("source").map(|s| s.as_str());
match backup_client.list_from_path(Path::new(dir), source).await {
Ok(dict) => {
println!("List Response:");
for (k, v) in dict { println!(" {k}: {v:?}"); }
}
Err(e) => eprintln!("Failed to list: {e}"),
}
}
Some(("backup", sub_matches)) => {
let target = sub_matches.get_one::<String>("target").map(|s| s.as_str());
let source = sub_matches.get_one::<String>("source").map(|s| s.as_str());
let dir = sub_matches.get_one::<String>("dir").expect("dir is required");
println!("Starting backup operation...");
let res = backup_client
.send_request("Backup", target, source, None::<Dictionary>)
.await;
if let Err(e) = res {
eprintln!("Failed to send backup request: {e}");
} else if let Err(e) = process_dl_loop(&mut backup_client, Path::new(dir)).await {
eprintln!("Backup failed during DL loop: {e}");
} else {
println!("Backup flow finished");
}
}
Some(("restore", sub)) => {
let dir = sub.get_one::<String>("dir").unwrap();
let source = sub.get_one::<String>("source").map(|s| s.as_str());
let mut ropts = RestoreOptions::new();
if sub.get_flag("no-reboot") { ropts = ropts.with_reboot(false); }
if sub.get_flag("no-copy") { ropts = ropts.with_copy(false); }
if sub.get_flag("no-settings") { ropts = ropts.with_preserve_settings(false); }
if sub.get_flag("system") { ropts = ropts.with_system_files(true); }
if sub.get_flag("remove") { ropts = ropts.with_remove_items_not_restored(true); }
if let Some(pw) = sub.get_one::<String>("password") { ropts = ropts.with_password(pw); }
match backup_client.restore_from_path(Path::new(dir), source, Some(ropts)).await {
Ok(_) => println!("Restore flow finished"),
Err(e) => eprintln!("Restore failed: {e}"),
}
}
Some(("unback", sub)) => {
let dir = sub.get_one::<String>("dir").unwrap();
let source = sub.get_one::<String>("source").map(|s| s.as_str());
let password = sub.get_one::<String>("password").map(|s| s.as_str());
match backup_client.unback_from_path(Path::new(dir), password, source).await {
Ok(_) => println!("Unback finished"),
Err(e) => eprintln!("Unback failed: {e}"),
}
}
Some(("extract", sub)) => {
let dir = sub.get_one::<String>("dir").unwrap();
let source = sub.get_one::<String>("source").map(|s| s.as_str());
let domain = sub.get_one::<String>("domain").unwrap();
let rel = sub.get_one::<String>("path").unwrap();
let password = sub.get_one::<String>("password").map(|s| s.as_str());
match backup_client.extract_from_path(domain, rel, Path::new(dir), password, source).await {
Ok(_) => println!("Extract finished"),
Err(e) => eprintln!("Extract failed: {e}"),
}
}
Some(("change-password", sub)) => {
let dir = sub.get_one::<String>("dir").unwrap();
let old = sub.get_one::<String>("old").map(|s| s.as_str());
let newv = sub.get_one::<String>("new").map(|s| s.as_str());
match backup_client.change_password_from_path(Path::new(dir), old, newv).await {
Ok(_) => println!("Change password finished"),
Err(e) => eprintln!("Change password failed: {e}"),
}
}
Some(("erase-device", sub)) => {
let dir = sub.get_one::<String>("dir").unwrap();
match backup_client.erase_device_from_path(Path::new(dir)).await {
Ok(_) => println!("Erase device command sent"),
Err(e) => eprintln!("Erase device failed: {e}"),
}
}
Some(("freespace", _)) => {
match backup_client.get_freespace().await {
Ok(freespace) => {
let freespace_gb = freespace as f64 / (1024.0 * 1024.0 * 1024.0);
println!("Free space: {freespace} bytes ({freespace_gb:.2} GB)");
}
Err(e) => eprintln!("Failed to get free space: {e}"),
}
}
Some(("encryption", _)) => {
match backup_client.check_backup_encryption().await {
Ok(is_encrypted) => {
println!("Backup encryption: {}", if is_encrypted { "Enabled" } else { "Disabled" });
}
Err(e) => eprintln!("Failed to check backup encryption: {e}"),
}
}
_ => {
println!("No subcommand provided. Use --help for available commands.");
}
}
// Disconnect from the service
if let Err(e) = backup_client.disconnect().await {
eprintln!("Warning: Failed to disconnect cleanly: {e}");
}
}
use idevice::services::mobilebackup2::{
DL_CODE_ERROR_LOCAL as CODE_ERROR_LOCAL,
DL_CODE_FILE_DATA as CODE_FILE_DATA,
DL_CODE_SUCCESS as CODE_SUCCESS,
};
async fn process_dl_loop(
client: &mut MobileBackup2Client,
host_dir: &Path,
) -> Result<Option<Dictionary>, idevice::IdeviceError> {
loop {
let (tag, value) = client.receive_dl_message().await?;
match tag.as_str() {
"DLMessageDownloadFiles" => {
handle_download_files(client, &value, host_dir).await?;
}
"DLMessageUploadFiles" => {
handle_upload_files(client, &value, host_dir).await?;
}
"DLMessageGetFreeDiskSpace" => {
// Minimal implementation: report unknown/zero with success
client
.send_status_response(0, None, Some(plist::Value::Integer(0u64.into())))
.await?;
}
"DLContentsOfDirectory" => {
// Minimal: return empty listing
let empty = plist::Value::Dictionary(Dictionary::new());
client.send_status_response(0, None, Some(empty)).await?;
}
"DLMessageCreateDirectory" => {
let status = create_directory_from_message(&value, host_dir);
client
.send_status_response(status, None, None)
.await?;
}
"DLMessageMoveFiles" | "DLMessageMoveItems" => {
let status = move_files_from_message(&value, host_dir);
client
.send_status_response(status, None, Some(plist::Value::Dictionary(Dictionary::new())))
.await?;
}
"DLMessageRemoveFiles" | "DLMessageRemoveItems" => {
let status = remove_files_from_message(&value, host_dir);
client
.send_status_response(status, None, Some(plist::Value::Dictionary(Dictionary::new())))
.await?;
}
"DLMessageCopyItem" => {
let status = copy_item_from_message(&value, host_dir);
client
.send_status_response(status, None, Some(plist::Value::Dictionary(Dictionary::new())))
.await?;
}
"DLMessageProcessMessage" => {
// Final status/content: return inner dict
if let plist::Value::Array(arr) = value
&& let Some(plist::Value::Dictionary(dict)) = arr.get(1)
{
return Ok(Some(dict.clone()));
}
return Ok(None);
}
"DLMessageDisconnect" => {
return Ok(None);
}
other => {
eprintln!("Unsupported DL message: {other}");
client
.send_status_response(-1, Some("Operation not supported"), None)
.await?;
}
}
}
}
async fn handle_download_files(
client: &mut MobileBackup2Client,
dl_value: &plist::Value,
host_dir: &Path,
) -> Result<(), idevice::IdeviceError> {
// dl_value is an array: ["DLMessageDownloadFiles", [paths...], progress?]
let mut err_any = false;
if let plist::Value::Array(arr) = dl_value
&& arr.len() >= 2
&& let Some(plist::Value::Array(files)) = arr.get(1)
{
for pv in files {
if let Some(path) = pv.as_string()
&& let Err(e) = send_single_file(client, host_dir, path).await
{
eprintln!("Failed to send file {path}: {e}");
err_any = true;
}
}
}
// terminating zero dword
client
.idevice
.send_raw(&0u32.to_be_bytes())
.await?;
// status response
if err_any {
client
.send_status_response(-13, Some("Multi status"), Some(plist::Value::Dictionary(Dictionary::new())))
.await
} else {
client
.send_status_response(0, None, Some(plist::Value::Dictionary(Dictionary::new())))
.await
}
}
async fn send_single_file(
client: &mut MobileBackup2Client,
host_dir: &Path,
rel_path: &str,
) -> Result<(), idevice::IdeviceError> {
let full = host_dir.join(rel_path);
let path_bytes = rel_path.as_bytes().to_vec();
let nlen = (path_bytes.len() as u32).to_be_bytes();
client.idevice.send_raw(&nlen).await?;
client.idevice.send_raw(&path_bytes).await?;
let mut f = match std::fs::File::open(&full) {
Ok(f) => f,
Err(e) => {
// send error
let desc = e.to_string();
let size = (desc.len() as u32 + 1).to_be_bytes();
let mut hdr = Vec::with_capacity(5);
hdr.extend_from_slice(&size);
hdr.push(CODE_ERROR_LOCAL);
client.idevice.send_raw(&hdr).await?;
client.idevice.send_raw(desc.as_bytes()).await?;
return Ok(());
}
};
let mut buf = [0u8; 32768];
loop {
let read = f.read(&mut buf).unwrap_or(0);
if read == 0 {
break;
}
let size = ((read as u32) + 1).to_be_bytes();
let mut hdr = Vec::with_capacity(5);
hdr.extend_from_slice(&size);
hdr.push(CODE_FILE_DATA);
client.idevice.send_raw(&hdr).await?;
client.idevice.send_raw(&buf[..read]).await?;
}
// success trailer
let mut ok = [0u8; 5];
ok[..4].copy_from_slice(&1u32.to_be_bytes());
ok[4] = CODE_SUCCESS;
client.idevice.send_raw(&ok).await?;
Ok(())
}
async fn handle_upload_files(
client: &mut MobileBackup2Client,
_dl_value: &plist::Value,
host_dir: &Path,
) -> Result<(), idevice::IdeviceError> {
// Minimal receiver: read pairs of (dir, filename) and block stream
// Receive dir name
loop {
let dlen = read_be_u32(client).await?;
if dlen == 0 {
break;
}
let dname = read_exact_string(client, dlen as usize).await?;
let flen = read_be_u32(client).await?;
if flen == 0 {
break;
}
let fname = read_exact_string(client, flen as usize).await?;
let dst = host_dir.join(&fname);
if let Some(parent) = dst.parent() {
let _ = fs::create_dir_all(parent);
}
let mut file = std::fs::File::create(&dst).map_err(|e| idevice::IdeviceError::InternalError(e.to_string()))?;
loop {
let nlen = read_be_u32(client).await?;
if nlen == 0 {
break;
}
let code = read_one(client).await?;
if code == CODE_FILE_DATA {
let size = (nlen - 1) as usize;
let data = read_exact(client, size).await?;
file.write_all(&data).map_err(|e| idevice::IdeviceError::InternalError(e.to_string()))?;
} else {
let _ = read_exact(client, (nlen - 1) as usize).await?;
}
}
let _ = dname; // not used
}
client
.send_status_response(0, None, Some(plist::Value::Dictionary(Dictionary::new())))
.await
}
async fn read_be_u32(client: &mut MobileBackup2Client) -> Result<u32, idevice::IdeviceError> {
let buf = client.idevice.read_raw(4).await?;
Ok(u32::from_be_bytes([buf[0], buf[1], buf[2], buf[3]]))
}
async fn read_one(client: &mut MobileBackup2Client) -> Result<u8, idevice::IdeviceError> {
let buf = client.idevice.read_raw(1).await?;
Ok(buf[0])
}
async fn read_exact(client: &mut MobileBackup2Client, size: usize) -> Result<Vec<u8>, idevice::IdeviceError> {
client.idevice.read_raw(size).await
}
async fn read_exact_string(client: &mut MobileBackup2Client, size: usize) -> Result<String, idevice::IdeviceError> {
let buf = client.idevice.read_raw(size).await?;
Ok(String::from_utf8_lossy(&buf).to_string())
}
fn create_directory_from_message(dl_value: &plist::Value, host_dir: &Path) -> i64 {
if let plist::Value::Array(arr) = dl_value
&& arr.len() >= 2
&& let Some(plist::Value::String(dir)) = arr.get(1)
{
let path = host_dir.join(dir);
return match fs::create_dir_all(&path) {
Ok(_) => 0,
Err(_) => -1,
};
}
-1
}
fn move_files_from_message(dl_value: &plist::Value, host_dir: &Path) -> i64 {
if let plist::Value::Array(arr) = dl_value
&& arr.len() >= 2
&& let Some(plist::Value::Dictionary(map)) = arr.get(1)
{
for (from, to_v) in map.iter() {
if let Some(to) = to_v.as_string() {
let old = host_dir.join(from);
let newp = host_dir.join(to);
if let Some(parent) = newp.parent() {
let _ = fs::create_dir_all(parent);
}
if fs::rename(&old, &newp).is_err() {
return -1;
}
}
}
return 0;
}
-1
}
fn remove_files_from_message(dl_value: &plist::Value, host_dir: &Path) -> i64 {
if let plist::Value::Array(arr) = dl_value
&& arr.len() >= 2
&& let Some(plist::Value::Array(items)) = arr.get(1)
{
for it in items {
if let Some(p) = it.as_string() {
let path = host_dir.join(p);
if path.is_dir() {
if fs::remove_dir_all(&path).is_err() { return -1; }
} else if path.exists() && fs::remove_file(&path).is_err() {
return -1;
}
}
}
return 0;
}
-1
}
fn copy_item_from_message(dl_value: &plist::Value, host_dir: &Path) -> i64 {
if let plist::Value::Array(arr) = dl_value
&& arr.len() >= 3
&& let (Some(plist::Value::String(src)), Some(plist::Value::String(dst))) = (arr.get(1), arr.get(2))
{
let from = host_dir.join(src);
let to = host_dir.join(dst);
if let Some(parent) = to.parent() { let _ = fs::create_dir_all(parent); }
if from.is_dir() {
// shallow copy: create dir
return match fs::create_dir_all(&to) { Ok(_) => 0, Err(_) => -1 };
} else {
return match fs::copy(&from, &to) { Ok(_) => 0, Err(_) => -1 };
}
}
-1
}