aboutsummaryrefslogtreecommitdiff
path: root/crates/arti/tests/cli_tests/hsc/key_util.rs
blob: 2ac20040dae43502cb4da0f19269fd72888dc6d2 (plain)
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
99
100
101
102
103
//! Helpers for testing the `arti hsc key` subcommand.

use std::{path::PathBuf, process::Output};

use assert_cmd::cargo::cargo_bin_cmd;

use crate::util::create_state_dir_entry;

/// A test onion address.
pub(super) const ONION_ADDR: &str =
    "fpqqmiwzqiv63jczrshh4qcmlxw6gujcai3arobq23wikt7hk7ojadid.onion";
/// Length of the onion address without ".onion" suffix.
pub(super) const ADDR_LEN: usize = 56;
/// Path to a test specific configuration for `arti hsc key`.
const CFG_PATH_KEY: &str = "./tests/testcases/hsc-common/conf/hsc.toml";

/// An `arti hsc key` subcommand.
#[derive(Debug, Clone, Copy, Eq, PartialEq, derive_more::Display)]
pub(crate) enum ArtiHscKeyCmd {
    /// If `generate` is true, passes `--generate no` to the `arti hsc key get` command.
    #[display("get")]
    Get { generate: bool },
    #[display("rotate")]
    Rotate,
    #[display("remove")]
    Remove,
}

/// A struct that represents the subcommand `hsc key`.
#[derive(Debug, Clone, Eq, PartialEq, derive_builder::Builder)]
pub(crate) struct KeyCmd {
    /// Path to the configuration file.
    ///
    /// Defaults to [`CFG_PATH_KEY`].
    #[builder(default = "CFG_PATH_KEY.into()")]
    config: String,
    /// `arti hsc key` subcommand.
    subcommand: ArtiHscKeyCmd,
    /// Path to the state directory to use.
    state_dir: PathBuf,
    /// When `true`, the `--batch` flag will be used, making the command run
    /// non-interactively (without accepting input from `stdin`)
    ///
    /// Defaults to `true`.
    #[builder(default = "true")]
    batch: bool,
    /// The value to write to the command's `stdin`.
    ///
    /// `arti hsc key {get, rotate, remove}` always require an onion address to be passed via `stdin`.
    ///
    /// Defaults to [`ONION_ADDR`].
    #[builder(default = "ONION_ADDR.into()")]
    stdin: String,
}

impl KeyCmd {
    /// Execute the command and return its output as an [`Output`].
    pub(crate) fn run(&self) -> std::io::Result<Output> {
        let path_to_state_dir = create_state_dir_entry(self.state_dir.to_string_lossy().as_ref());
        let mut cmd = cargo_bin_cmd!("arti");
        cmd.args([
            "-c",
            &self.config,
            "-o",
            &path_to_state_dir,
            "hsc",
            "key",
            &self.subcommand.to_string(),
        ]);
        if self.batch {
            cmd.arg("--batch");
        }
        match self.subcommand {
            ArtiHscKeyCmd::Get { generate } => {
                cmd.args(["--output", "-"]);
                if !generate {
                    cmd.args(["--generate", "no"]);
                }
            }
            ArtiHscKeyCmd::Rotate => {
                cmd.args(["--output", "-"]);
            }
            ArtiHscKeyCmd::Remove => {}
        }
        cmd.write_stdin(&*self.stdin);
        cmd.output()
    }

    /// Returns `true` if the state directory contains a client key for the service indicated by `addr`.
    pub(crate) fn keystore_contains_priv_key(&self, addr: &str) -> bool {
        let keystore_path = &self
            .state_dir
            .join("keystore/client")
            .join(&addr[..ADDR_LEN]);

        for f in keystore_path.read_dir().unwrap().flatten() {
            if f.file_name() == "ks_hsc_desc_enc.x25519_private" {
                return true;
            }
        }
        false
    }
}