414 lines
13 KiB
Rust
414 lines
13 KiB
Rust
// SPDX-License-Identifier: MIT
|
|
//! Read-only CV1835 preflight: source-OS fingerprint, root channel, partition
|
|
//! identity, held/golden backup hashes, free space and secure-region refusal.
|
|
//!
|
|
//! Every check runs over the network. A failure is reported, never repaired.
|
|
|
|
use crate::boards::cv1835::{Cv1835Plan, CvPlanError};
|
|
use crate::md5::md5_hex;
|
|
use crate::transport::{Remote, RemoteError};
|
|
use sha2::{Digest, Sha256};
|
|
use std::fs;
|
|
use std::path::{Path, PathBuf};
|
|
use std::time::Duration;
|
|
use thiserror::Error;
|
|
|
|
const P1_NAME: &str = "mmcblk0p1";
|
|
|
|
#[derive(Debug, Error)]
|
|
pub enum PreflightError {
|
|
#[error("preflight transport: {0}")]
|
|
Remote(#[from] RemoteError),
|
|
#[error("preflight I/O: {0}")]
|
|
Io(#[from] std::io::Error),
|
|
#[error("preflight plan: {0}")]
|
|
Plan(#[from] CvPlanError),
|
|
#[error("held backup {path} is {size} bytes, not 16 MiB")]
|
|
BackupSize { path: PathBuf, size: u64 },
|
|
#[error("held backup {0} has no readable md5")]
|
|
BackupUnreadable(PathBuf),
|
|
}
|
|
|
|
#[derive(Clone, Debug)]
|
|
pub struct Check {
|
|
pub name: &'static str,
|
|
pub ok: bool,
|
|
pub detail: String,
|
|
}
|
|
|
|
#[derive(Clone, Debug)]
|
|
pub struct BackupCheck {
|
|
pub path: PathBuf,
|
|
pub md5: String,
|
|
pub sha256: String,
|
|
pub matches_live: bool,
|
|
}
|
|
|
|
#[derive(Clone, Debug)]
|
|
pub struct PreflightReport {
|
|
pub host: String,
|
|
pub source_os: String,
|
|
pub kernel: String,
|
|
pub model: String,
|
|
pub root_method: String,
|
|
pub root_uid: String,
|
|
pub partition_device: String,
|
|
pub partition_size: u64,
|
|
pub live_md5: String,
|
|
pub held_backup: Option<BackupCheck>,
|
|
pub golden_md5: Option<String>,
|
|
pub free_bytes: u64,
|
|
pub boot0_present: bool,
|
|
pub checks: Vec<Check>,
|
|
}
|
|
|
|
impl PreflightReport {
|
|
pub fn ok(&self) -> bool {
|
|
self.checks.iter().all(|check| check.ok)
|
|
}
|
|
|
|
pub fn failures(&self) -> Vec<&Check> {
|
|
self.checks.iter().filter(|check| !check.ok).collect()
|
|
}
|
|
|
|
pub fn render(&self) -> String {
|
|
let mut out = String::new();
|
|
out.push_str(&format!("preflight {}\n", self.host));
|
|
out.push_str(&format!(
|
|
"source-os {} (kernel {})\n",
|
|
self.source_os, self.kernel
|
|
));
|
|
if !self.model.is_empty() {
|
|
out.push_str(&format!("model {}\n", self.model));
|
|
}
|
|
out.push_str(&format!(
|
|
"root {} (uid {})\n",
|
|
self.root_method, self.root_uid
|
|
));
|
|
out.push_str(&format!(
|
|
"partition {} {} B\n",
|
|
self.partition_device, self.partition_size
|
|
));
|
|
out.push_str(&format!("live p1 md5 {}\n", self.live_md5));
|
|
match &self.held_backup {
|
|
Some(backup) => out.push_str(&format!(
|
|
"held backup {} md5 {} ({})\n",
|
|
backup.path.display(),
|
|
backup.md5,
|
|
if backup.matches_live {
|
|
"matches live p1"
|
|
} else {
|
|
"differs from live p1"
|
|
}
|
|
)),
|
|
None => out.push_str("held backup none (install will create one before writing)\n"),
|
|
}
|
|
if let Some(golden) = &self.golden_md5 {
|
|
out.push_str(&format!("golden raw p1 md5 {golden}\n"));
|
|
}
|
|
out.push_str(&format!(
|
|
"free tmp {} MiB\n",
|
|
self.free_bytes / (1024 * 1024)
|
|
));
|
|
out.push_str(&format!(
|
|
"boot0 {} (never written)\n",
|
|
if self.boot0_present {
|
|
"present"
|
|
} else {
|
|
"not present"
|
|
}
|
|
));
|
|
for check in &self.checks {
|
|
out.push_str(&format!(
|
|
"check {} {}: {}\n",
|
|
check.name,
|
|
if check.ok { "ok" } else { "FAIL" },
|
|
check.detail
|
|
));
|
|
}
|
|
out.push_str(if self.ok() {
|
|
"result PASS\n"
|
|
} else {
|
|
"result FAIL (do not write)\n"
|
|
});
|
|
out
|
|
}
|
|
}
|
|
|
|
pub struct PreflightOptions<'a> {
|
|
pub host: &'a str,
|
|
pub held_backup: Option<&'a Path>,
|
|
pub check_golden: bool,
|
|
pub allow_unknown_source: bool,
|
|
}
|
|
|
|
pub fn preflight(
|
|
plan: &Cv1835Plan,
|
|
remote: &mut dyn Remote,
|
|
options: &PreflightOptions<'_>,
|
|
) -> Result<PreflightReport, PreflightError> {
|
|
let mut checks = Vec::new();
|
|
let fingerprint = remote.user_command(
|
|
"uname -r; echo __MODEL__; cat /proc/device-tree/model 2>/dev/null; echo; \
|
|
echo __RELEASE__; cat /etc/os-release 2>/dev/null; \
|
|
ls /etc/bos_version /etc/fw-info /etc/alkane-release /etc/ouros-release 2>/dev/null; \
|
|
test -x /nvdata/rroot && echo rroot; \
|
|
test -x /usr/sbin/update-daemon && echo update-daemon",
|
|
Duration::from_secs(20),
|
|
)?;
|
|
let text = String::from_utf8_lossy(&fingerprint).into_owned();
|
|
let mut sections = text.split("__MODEL__");
|
|
let kernel = sections.next().unwrap_or("").trim().to_owned();
|
|
let rest = sections.next().unwrap_or("");
|
|
let mut sections = rest.split("__RELEASE__");
|
|
let model = sections.next().unwrap_or("").trim().to_owned();
|
|
let release = sections.next().unwrap_or("");
|
|
let source_os = classify(&kernel, release, &text);
|
|
let source_ok = plan.source_os.is_empty()
|
|
|| plan.source_os.iter().any(|item| item == &source_os)
|
|
|| options.allow_unknown_source;
|
|
checks.push(Check {
|
|
name: "source-os",
|
|
ok: source_ok,
|
|
detail: format!(
|
|
"{source_os} (allowed: {})",
|
|
if plan.source_os.is_empty() {
|
|
"any".to_owned()
|
|
} else {
|
|
plan.source_os.join(", ")
|
|
}
|
|
),
|
|
});
|
|
|
|
let root_uid = String::from_utf8_lossy(&remote.root_command("id -u", Duration::from_secs(20))?)
|
|
.trim()
|
|
.to_owned();
|
|
checks.push(Check {
|
|
name: "root",
|
|
ok: root_uid == "0",
|
|
detail: format!("uid {root_uid}"),
|
|
});
|
|
|
|
let partition_device = plan.partition.device.clone();
|
|
let block = String::from_utf8_lossy(&remote.user_command(
|
|
&format!("test -b {partition_device} && echo block || echo missing"),
|
|
Duration::from_secs(15),
|
|
)?)
|
|
.trim()
|
|
.to_owned();
|
|
let size_out = remote.user_command(
|
|
&format!("cat /sys/class/block/{P1_NAME}/size 2>/dev/null || true"),
|
|
Duration::from_secs(15),
|
|
)?;
|
|
let sectors: u64 = String::from_utf8_lossy(&size_out)
|
|
.trim()
|
|
.parse()
|
|
.unwrap_or(0);
|
|
let partition_size = sectors.saturating_mul(512);
|
|
checks.push(Check {
|
|
name: "partition",
|
|
ok: block == "block" && partition_size == plan.partition.size,
|
|
detail: format!(
|
|
"{partition_device} {partition_size} B (plan {} B)",
|
|
plan.partition.size
|
|
),
|
|
});
|
|
|
|
let live = remote.root_command(
|
|
&format!("md5sum {partition_device}"),
|
|
Duration::from_secs(60),
|
|
)?;
|
|
let live_md5 = parse_digest(&live, 32).unwrap_or_else(|| "unreadable".to_owned());
|
|
checks.push(Check {
|
|
name: "live-p1-md5",
|
|
ok: live_md5.len() == 32,
|
|
detail: live_md5.clone(),
|
|
});
|
|
|
|
let commands = remote.user_command(
|
|
"for c in dd md5sum sync; do command -v $c >/dev/null 2>&1 && echo $c || echo missing:$c; done",
|
|
Duration::from_secs(15),
|
|
)?;
|
|
let commands_text = String::from_utf8_lossy(&commands).into_owned();
|
|
let missing: Vec<&str> = commands_text
|
|
.lines()
|
|
.filter_map(|line| line.strip_prefix("missing:"))
|
|
.collect();
|
|
checks.push(Check {
|
|
name: "commands",
|
|
ok: missing.is_empty(),
|
|
detail: if missing.is_empty() {
|
|
"dd, md5sum, sync present".to_owned()
|
|
} else {
|
|
format!("missing {}", missing.join(", "))
|
|
},
|
|
});
|
|
|
|
let free_bytes = free_bytes(remote)?;
|
|
checks.push(Check {
|
|
name: "free-space",
|
|
ok: free_bytes >= plan.min_free_bytes,
|
|
detail: format!(
|
|
"{} MiB at /tmp (plan {} MiB)",
|
|
free_bytes / (1024 * 1024),
|
|
plan.min_free_bytes / (1024 * 1024)
|
|
),
|
|
});
|
|
|
|
let boot0 = String::from_utf8_lossy(&remote.user_command(
|
|
"test -e /dev/mmcblk0boot0 && echo yes || echo no",
|
|
Duration::from_secs(15),
|
|
)?)
|
|
.trim()
|
|
.to_owned();
|
|
let boot0_present = boot0 == "yes";
|
|
checks.push(Check {
|
|
name: "secure-regions",
|
|
ok: !plan.partition.device.contains("boot0"),
|
|
detail: format!(
|
|
"boot0 {}; the write plan targets only {}",
|
|
if boot0_present { "present" } else { "absent" },
|
|
plan.partition.device
|
|
),
|
|
});
|
|
|
|
let mut held_backup = None;
|
|
if let Some(path) = options.held_backup {
|
|
let size = fs::metadata(path)?.len();
|
|
if size != plan.partition.size {
|
|
return Err(PreflightError::BackupSize {
|
|
path: path.to_path_buf(),
|
|
size,
|
|
});
|
|
}
|
|
let data = fs::read(path)?;
|
|
let md5 = md5_hex(&data);
|
|
let sha256: String = Sha256::digest(&data)
|
|
.iter()
|
|
.map(|byte| format!("{byte:02x}"))
|
|
.collect();
|
|
let matches_live = md5 == live_md5;
|
|
checks.push(Check {
|
|
name: "held-backup",
|
|
ok: true,
|
|
detail: format!(
|
|
"{} md5 {md5} ({})",
|
|
path.display(),
|
|
if matches_live {
|
|
"matches live p1"
|
|
} else {
|
|
"differs from live p1; restore will still write it"
|
|
}
|
|
),
|
|
});
|
|
held_backup = Some(BackupCheck {
|
|
path: path.to_path_buf(),
|
|
md5,
|
|
sha256,
|
|
matches_live,
|
|
});
|
|
}
|
|
|
|
let mut golden_md5 = None;
|
|
if options.check_golden {
|
|
let out = remote.root_command(
|
|
&format!(
|
|
"dd if=/dev/mmcblk0 skip={} count=32768 bs=512 2>/dev/null | md5sum",
|
|
plan.golden_lba_bytes / 512
|
|
),
|
|
Duration::from_secs(90),
|
|
)?;
|
|
if let Some(digest) = parse_digest(&out, 32) {
|
|
golden_md5 = Some(digest);
|
|
}
|
|
}
|
|
|
|
Ok(PreflightReport {
|
|
host: options.host.to_owned(),
|
|
source_os,
|
|
kernel,
|
|
model,
|
|
root_method: remote.root_method().to_owned(),
|
|
root_uid,
|
|
partition_device,
|
|
partition_size,
|
|
live_md5,
|
|
held_backup,
|
|
golden_md5,
|
|
free_bytes,
|
|
boot0_present,
|
|
checks,
|
|
})
|
|
}
|
|
|
|
pub(crate) fn classify(kernel: &str, release: &str, all: &str) -> String {
|
|
if all.contains("/etc/bos_version") || release.contains("Braiins") {
|
|
return "braiins".to_owned();
|
|
}
|
|
if all.contains("/etc/alkane-release") || kernel.starts_with("6.18") {
|
|
return "alkane".to_owned();
|
|
}
|
|
if all.contains("/etc/ouros-release") || kernel.contains("6.6.147") {
|
|
return "ouros".to_owned();
|
|
}
|
|
if all.contains("/etc/fw-info") || release.contains("Vnish") || release.contains("AnthillOS") {
|
|
return "vnish".to_owned();
|
|
}
|
|
if kernel.contains("4.9.38") || all.contains("update-daemon") || all.contains("rroot") {
|
|
return "stock-bitmain".to_owned();
|
|
}
|
|
"unknown".to_owned()
|
|
}
|
|
|
|
pub fn parse_digest(output: &[u8], length: usize) -> Option<String> {
|
|
let text = String::from_utf8_lossy(output);
|
|
text.split_whitespace()
|
|
.map(|token| token.trim().to_ascii_lowercase())
|
|
.find(|token| token.len() == length && token.bytes().all(|byte| byte.is_ascii_hexdigit()))
|
|
}
|
|
|
|
fn free_bytes(remote: &mut dyn Remote) -> Result<u64, RemoteError> {
|
|
let out = remote.user_command("df -k /tmp 2>/dev/null || df -k /", Duration::from_secs(15))?;
|
|
let text = String::from_utf8_lossy(&out);
|
|
for line in text.lines().rev() {
|
|
let fields: Vec<&str> = line.split_whitespace().collect();
|
|
if fields.len() >= 4 {
|
|
if let Ok(kib) = fields[3].parse::<u64>() {
|
|
return Ok(kib.saturating_mul(1024));
|
|
}
|
|
}
|
|
}
|
|
Ok(0)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn classifies_the_source_os() {
|
|
assert_eq!(
|
|
classify("4.9.38-tag-", "", "update-daemon\n"),
|
|
"stock-bitmain"
|
|
);
|
|
assert_eq!(
|
|
classify("4.9.38-tag-", "/etc/fw-info\n", "/etc/fw-info\n"),
|
|
"vnish"
|
|
);
|
|
assert_eq!(classify("6.6.147", "/etc/ouros-release\n", ""), "ouros");
|
|
assert_eq!(classify("6.18.48", "", ""), "alkane");
|
|
assert_eq!(classify("4.9.38", "", "/etc/bos_version\n"), "braiins");
|
|
assert_eq!(classify("5.10.0", "", ""), "unknown");
|
|
}
|
|
|
|
#[test]
|
|
fn parses_md5_from_md5sum_output() {
|
|
let output = b"3f43804f10ce256200bfc71e7fbdd9ee /dev/mmcblk0p1\n";
|
|
assert_eq!(
|
|
parse_digest(output, 32).as_deref(),
|
|
Some("3f43804f10ce256200bfc71e7fbdd9ee")
|
|
);
|
|
assert_eq!(parse_digest(b"not a digest\n", 32), None);
|
|
}
|
|
}
|