mirror of
https://github.com/EFForg/rayhunter.git
synced 2026-05-05 03:29:07 -07:00
Install to /cache/rayhunter-data for tplink, add --data-dir parameter
This fixes several space-related issues at once. We have observed the following phenomenon on TP-Link, Orbic and Moxee: - Filling /data bricks the device (broken wifi, broken rndis, broken display) - Filling /cache does not (it only bricks rayhunter if it's installed there, and it might break firmware updates) Therefore it would make sense to store the entire rayhunter installation in /cache. This is a great idea for TP-Link and Moxee, because /cache is significantly larger than /data. However, on Orbic, /data is significantly larger than /cache! This PR refactors orbic-network and tplink to use a shared codepath for setting up the data directory. A symlink is created at /data/rayhunter, and what it points to is device-specific: - Orbic will have its data at `/data/rayhunter-data` - There is a new alias `installer moxee` that overrides this to `/cache/rayhunter-data` - TP-Link will have its data at /cache/rayhunter-data when there's no SD card, and /media/whatever when there is one. In all cases, existing data is migrated to the new location. The user can switch back and forth between two values of --data-dir and the data will be moved over every time. This PR has one huge wart, and that is that the USB installer for Orbic remains untouched. The annoying reason for this is that the DeviceConnection trait is insufficient to reflect all the different kinds of shells you can have over USB: adb with fakeroot, and serial with real root. I think it's not possible to create the right directories with 'rootshell -c'. I'm thinking of spawning a telnet server over serial, so that we can just do telnet again, but this is for another time.
This commit is contained in:
committed by
Will Greenberg
parent
83664e23f2
commit
3e38f500a9
@@ -1,9 +1,9 @@
|
||||
use std::future::Future;
|
||||
use std::net::SocketAddr;
|
||||
|
||||
use anyhow::Result;
|
||||
use anyhow::{Result, bail};
|
||||
|
||||
use crate::output::println;
|
||||
use crate::output::{print, println};
|
||||
|
||||
/// Abstraction for device communication (telnet or ADB)
|
||||
pub trait DeviceConnection {
|
||||
@@ -23,13 +23,14 @@ pub async fn file_exists<C: DeviceConnection>(conn: &mut C, path: &str) -> bool
|
||||
.unwrap_or(false)
|
||||
}
|
||||
|
||||
/// Shared config installation logic
|
||||
/// Shared config installation logic. Installs to /data/rayhunter/config.toml which resolves
|
||||
/// through the symlink to the actual data directory.
|
||||
pub async fn install_config<C: DeviceConnection>(
|
||||
conn: &mut C,
|
||||
config_path: &str,
|
||||
device_type: &str,
|
||||
reset_config: bool,
|
||||
) -> Result<()> {
|
||||
let config_path = "/data/rayhunter/config.toml";
|
||||
if reset_config || !file_exists(conn, config_path).await {
|
||||
let config = crate::CONFIG_TOML.replace(
|
||||
r#"#device = "orbic""#,
|
||||
@@ -42,6 +43,112 @@ pub async fn install_config<C: DeviceConnection>(
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Check if a directory exists using a DeviceConnection
|
||||
pub async fn dir_exists<C: DeviceConnection>(conn: &mut C, path: &str) -> bool {
|
||||
conn.run_command(&format!("test -d {path} && echo exists || echo missing"))
|
||||
.await
|
||||
.map(|output| output.contains("exists"))
|
||||
.unwrap_or(false)
|
||||
}
|
||||
|
||||
/// Check if a path is a symlink using a DeviceConnection
|
||||
pub async fn is_symlink<C: DeviceConnection>(conn: &mut C, path: &str) -> bool {
|
||||
conn.run_command(&format!("test -L {path} && echo yes || echo no"))
|
||||
.await
|
||||
.map(|output| output.contains("yes"))
|
||||
.unwrap_or(false)
|
||||
}
|
||||
|
||||
/// Read the target of a symlink using a DeviceConnection
|
||||
pub async fn readlink<C: DeviceConnection>(conn: &mut C, path: &str) -> Result<String> {
|
||||
// Use a prefix marker to find the actual output line, since some shells (TP-Link) echo
|
||||
// back the command and run_command appends protocol lines.
|
||||
let output = conn
|
||||
.run_command(&format!("echo RL:$(readlink {path})"))
|
||||
.await?;
|
||||
let result = output
|
||||
.lines()
|
||||
.find_map(|line| line.trim().strip_prefix("RL:"))
|
||||
.unwrap_or("")
|
||||
.to_string();
|
||||
Ok(result)
|
||||
}
|
||||
|
||||
/// Set up the data directory at `data_dir` and create a symlink from `/data/rayhunter` to it.
|
||||
///
|
||||
/// Handles migration from old locations:
|
||||
/// - If `/data/rayhunter` is a real directory, moves its contents to `data_dir`
|
||||
/// - If `/data/rayhunter` is a symlink to a different location, moves from the old target
|
||||
/// - If `/data/rayhunter` doesn't exist, just creates the symlink
|
||||
/// - If `/data/rayhunter` is a symlink to `data_dir`, does nothing
|
||||
pub async fn setup_data_directory<C: DeviceConnection>(conn: &mut C, data_dir: &str) -> Result<()> {
|
||||
if data_dir == "/data/rayhunter" {
|
||||
bail!("data_dir must not be /data/rayhunter");
|
||||
}
|
||||
|
||||
// Determine where old data lives, if anywhere
|
||||
let old_data_source = if is_symlink(conn, "/data/rayhunter").await {
|
||||
let current_target = readlink(conn, "/data/rayhunter").await?;
|
||||
if current_target == data_dir {
|
||||
println!("Data directory already configured at {data_dir}");
|
||||
return Ok(());
|
||||
}
|
||||
conn.run_command("rm -f /data/rayhunter").await?;
|
||||
// The old symlink target is where data actually lives
|
||||
if dir_exists(conn, ¤t_target).await {
|
||||
Some(current_target)
|
||||
} else {
|
||||
None
|
||||
}
|
||||
} else if dir_exists(conn, "/data/rayhunter").await {
|
||||
if dir_exists(conn, data_dir).await {
|
||||
bail!("Both /data/rayhunter and {data_dir} exist and are directories.");
|
||||
}
|
||||
// Real directory (pre-migration Orbic state)
|
||||
Some("/data/rayhunter".to_string())
|
||||
} else {
|
||||
None
|
||||
};
|
||||
|
||||
// Migrate old data if present
|
||||
if let Some(old_source) = &old_data_source {
|
||||
// Stop rayhunter-daemon so it doesn't write during migration.
|
||||
// The device will be rebooted at the end of installation anyway.
|
||||
print!("Stopping rayhunter-daemon ... ");
|
||||
let _ = conn
|
||||
.run_command("/etc/init.d/rayhunter_daemon stop 2>/dev/null; true")
|
||||
.await;
|
||||
println!("ok");
|
||||
|
||||
print!("Migrating data from {old_source} to {data_dir} ... ");
|
||||
|
||||
// mv old data into its place. If source and destination are on the same filesystem,
|
||||
// this is an instant rename.
|
||||
// XXX: DeviceConnection::run_command does not expose the exit code of the ran command. It
|
||||
// probably should, or a utility for it should exist?
|
||||
let mv_output = conn
|
||||
.run_command(&format!("mv {old_source} {data_dir} && echo MV_OK"))
|
||||
.await?;
|
||||
if mv_output.contains("MV_OK") {
|
||||
println!("ok");
|
||||
} else {
|
||||
bail!("Failed to move data from {old_source} to {data_dir}:\n{mv_output}");
|
||||
}
|
||||
} else {
|
||||
// No migration needed, just ensure the target directory exists
|
||||
conn.run_command(&format!("mkdir -p {data_dir}")).await?;
|
||||
}
|
||||
|
||||
// Create the symlink
|
||||
print!("Creating symlink /data/rayhunter -> {data_dir} ... ");
|
||||
conn.run_command("mkdir -p /data").await?;
|
||||
conn.run_command(&format!("ln -sf {data_dir} /data/rayhunter"))
|
||||
.await?;
|
||||
println!("ok");
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Telnet-based connection wrapper
|
||||
pub struct TelnetConnection {
|
||||
pub addr: SocketAddr,
|
||||
|
||||
Reference in New Issue
Block a user