seednaut 0.1.1

A command-line utility for inspecting, verifying, and extracting Seedvault Android backups
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

use clap::{ArgAction, Args, Parser, Subcommand};
use color_print::cstr;
use std::path::PathBuf;

#[cfg(not(target_os = "windows"))]
const EXAMPLES: &str = cstr!(
    "<bold><underline>Interactive mode:</underline></bold>
  Run without arguments or with a single path argument to enter interactive mode.

<bold><underline>Examples:</underline></bold>
  seednaut
  seednaut list /path/to/backup
  echo $MY_MNEMONIC | seednaut list /path/to/backup
  seednaut inspect \"/path/to/other backup\" 1 3
  seednaut verify /path/to/backup
  seednaut help extract
  seednaut extract /path/to/backup --match \"camera\" --export --out ./restore
"
);

#[cfg(target_os = "windows")]
const EXAMPLES: &str = cstr!(
    "<bold><underline>Interactive mode:</underline></bold>
  Run without arguments or with a single path argument to enter interactive mode.

<bold><underline>Examples:</underline></bold>
  seednaut
  seednaut list C:\\path\\to\\backup
  echo %MY_MNEMONIC% | seednaut list C:\\path\\to\\backup
  seednaut inspect \"C:\\path\\to\\other backup\" 1 3
  seednaut verify C:\\path\\to\\backup
  seednaut help extract
  seednaut extract C:\\path\\to\\backup --match \"camera\" --export --out .\\restore
"
);

/// A tool to inspect and extract SeedVault v2 (app) and v0 (file) backups.
///
/// The 12-word mnemonic phrase is required to decrypt the backup. It can be
/// provided through an interactive prompt or piped via stdin.
#[derive(Parser, Debug)]
#[command(author, version, about)]
#[command(disable_help_flag = true)]
#[command(after_help = EXAMPLES)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Command,

    /// Print help
    #[arg(long, short, action = ArgAction::HelpLong)]
    pub help: Option<bool>,
}

#[derive(Subcommand, Debug, Clone)]
pub enum Command {
    /// List available snapshots
    #[command(arg_required_else_help = true)]
    List(SnapshotSelector),
    /// Inspect the contents of snapshots (packages, files)
    #[command(arg_required_else_help = true)]
    Inspect(SnapshotSelector),
    /// Verify the integrity of all chunks in snapshots
    #[command(arg_required_else_help = true)]
    Verify(SnapshotSelector),
    /// Extract files and data from snapshots
    #[command(arg_required_else_help = true)]
    Extract(ExtractArgs),
}

/// Arguments for selecting one or more snapshots.
#[derive(Args, Debug, Clone)]
pub struct SnapshotSelector {
    /// The input path (snapshot file or directory)
    pub path: PathBuf,

    /// Indices of snapshots to target. If omitted, all snapshots are targeted.
    #[arg(required = false)]
    pub snapshots: Vec<u32>,
}

/// Arguments for the 'extract' command.
#[derive(Args, Debug, Clone)]
pub struct ExtractArgs {
    #[command(flatten)]
    pub selector: SnapshotSelector,

    /// Output directory for extracted files
    #[arg(short, long = "out")]
    pub out_dir: PathBuf,

    /// Regex to filter packages or file paths for extraction
    #[arg(short = 'm', long = "match")]
    pub pattern_str: Option<String>,

    /// Unpack archives (.tar) and convert databases (.db) to a readable format
    #[arg(short, long)]
    pub export: bool,
}