Struct tmkms::commands::yubihsm::SetupCommand

pub struct SetupCommand {
    pub config: Option<PathBuf>,
    pub verbose: bool,
    pub print_only: bool,
    pub restore: bool,
    pub write_report: Option<PathBuf>,
}

The yubihsm setup subcommand: performs initial device provisioning including creation of initial authentication and wrap keys.

Fields

config: Option<PathBuf>

Path to configuration file

verbose: bool

Print debugging information

print_only: bool

Only print derived keys - do not reinitialize HSM

restore: bool

Restore an HSM from an existing 24-word remonic

write_report: Option<PathBuf>

Write a provisioning report as JSON to the given filename

Trait Implementations

impl Command for SetupCommand

fn name() -> &'static str

Name of this program as a string

fn description() -> &'static str

Description of this program

fn version() -> &'static str

Version of this program

fn authors() -> &'static str

Authors of this program

fn from_args<A>(into_args: A) -> Self where
    A: IntoIterator<Item = String>, 

Parse command-line arguments from a string iterator

fn from_env_args() -> Self

Parse command-line arguments from the environment

fn print_usage_and_exit(args: &[String]) -> !

Print usage information and exit

fn subcommand_usage(_command: &str) -> Option<Usage>

Get usage information for a particular subcommand (if available)

impl Debug for SetupCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SetupCommand

fn default() -> SetupCommand

Returns the "default value" for a type.

impl Options for SetupCommand

fn parse<__S: AsRef<str>>(_parser: &mut Parser<'_, __S>) -> Result<Self, Error>

Parses arguments until the given parser is exhausted or until an error is encountered.

fn command_name(&self) -> Option<&'static str>

Returns the name of a parsed command, if present.

fn help_requested(&self) -> bool

Returns whether the user supplied a "help" option to request usage information about the program or any contained subcommands.

fn parse_command<__S: AsRef<str>>(
    name: &str,
    _parser: &mut Parser<'_, __S>
) -> Result<Self, Error>

Parses options for the named command.

fn usage() -> &'static str

Returns a string showing usage and help for each supported option.

fn command_list() -> Option<&'static str>

Returns a string listing available commands and help text.

fn command_usage(_name: &str) -> Option<&'static str>

Returns a usage string for the named command.

fn parse_args<S>(args: &[S], style: ParsingStyle) -> Result<Self, Error> where
    S: AsRef<str>, 

Parses arguments received from the command line.

fn parse_args_or_exit(style: ParsingStyle) -> Self

Parses arguments from the environment.

fn parse_args_default_or_exit() -> Self

Parses arguments from the environment, using the default parsing style.

fn parse_args_default<S>(args: &[S]) -> Result<Self, Error> where
    S: AsRef<str>, 

Parses arguments received from the command line, using the default parsing style.

impl Runnable for SetupCommand

fn run(&self)

Perform initial YubiHSM dervice provisioning