tmkms 0.2.3

Tendermint Key Management System
Documentation 
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

mod generate;
mod help;
mod import;
mod list;

use abscissa::Callable;
use yubihsm;

use self::{
    generate::GenerateCommand, help::HelpCommand, import::ImportCommand, list::ListCommand,
};

/// Default key type to generate
pub const DEFAULT_KEY_TYPE: &str = "ed25519";

/// Default YubiHSM2 domain (internal partitioning)
pub const DEFAULT_DOMAINS: yubihsm::Domain = yubihsm::Domain::DOM1;

/// Default YubiHSM2 permissions for generated keys
pub const DEFAULT_CAPABILITIES: yubihsm::Capability = yubihsm::Capability::ASYMMETRIC_SIGN_EDDSA;

/// The `yubihsm keys` subcommand
#[derive(Debug, Options)]
pub enum KeysCommand {
    #[options(help = "generate an Ed25519 signing key inside the HSM device")]
    Generate(GenerateCommand),

    #[options(help = "show help for the 'yubihsm keys' subcommand")]
    Help(HelpCommand),

    #[options(help = "import validator signing key for the 'yubihsm keys' subcommand")]
    Import(ImportCommand),

    #[options(help = "list all suitable Ed25519 keys in the HSM")]
    List(ListCommand),
}

impl KeysCommand {
    /// Optional path to the configuration file
    pub(super) fn config_path(&self) -> Option<&str> {
        match self {
            KeysCommand::Generate(generate) => generate.config.as_ref().map(|s| s.as_ref()),
            KeysCommand::List(list) => list.config.as_ref().map(|s| s.as_ref()),
            KeysCommand::Import(import) => import.config.as_ref().map(|s| s.as_ref()),
            _ => None,
        }
    }
}

// TODO: refactor abscissa internally so this is all part of the proc macro
impl Callable for KeysCommand {
    /// Call the given command chosen via the CLI
    fn call(&self) {
        match self {
            KeysCommand::Generate(generate) => generate.call(),
            KeysCommand::Help(help) => help.call(),
            KeysCommand::Import(import) => import.call(),
            KeysCommand::List(list) => list.call(),
        }
    }
}

// TODO: custom derive in abscissa
impl_command!(KeysCommand);