voa 0.7.3

Command line interface and library for interacting with the File Hierarchy for the Verification of OS Artifacts (VOA)
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
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
104

//! Command line interface handling for the `voa` executable.

mod config;
mod import;
mod list;
mod verify;

use clap::{Parser, ValueEnum};
use clap_verbosity_flag::Verbosity;
pub use config::ConfigCommand;
use import::ImportCommand;
use list::ListCommand;

use crate::cli::verify::VerifyCommand;

/// Output format for `voa` commands with data output.
#[derive(Clone, Debug, Default, strum::Display, ValueEnum)]
#[strum(serialize_all = "kebab-case")]
pub enum OutputFormat {
    /// The JSON output format.
    Json,

    /// The default text output format.
    #[default]
    Text,
}

/// The top-level command line interface for the `voa` executable.
#[derive(Debug, Parser)]
#[command(
    about = "Command line interface for interacting with VOA hierarchies",
    author,
    long_about = None,
    version,
)]
pub struct Cli {
    /// The verbosity of the command.
    #[command(flatten)]
    pub verbosity: Verbosity,

    /// The commands of the `voa` executable.
    #[command(subcommand)]
    pub command: Command,
}

/// A command of the `voa` executable.
#[derive(Debug, Parser)]
#[command(about, author, version)]
pub enum Command {
    /// The config subcommand.
    #[command(
        about = "Interact with the VOA configuration for technology backends.",
        subcommand
    )]
    Config(ConfigCommand),

    /// The import subcommand.
    #[command(
        about = "Import a single verifier into a VOA hierarchy.",
        long_about = r#"Import a single verifier into a VOA hierarchy.

By default a single verifier is expected on stdin.
Using the "-i"/"--input" option a specific directory or file can be selected for import instead.

The verifier is written to the user's writable, persistent VOA load path, e.g.:

- "~/.config/voa/": for users with uid >= 1000.
  Note, that "voa import" respects the XDG Base Directory Specification and the "XDG_CONFIG_HOME" environment variable.
  The above serves as default example.
- "/etc/voa/": for users with uid < 1000

When using the "-r"/"--runtime" option, the verifier is written to the user's writable, ephemeral VOA load path instead, e.g.:

- "/run/user/$(id -u)/voa/": for users with uid >= 1000.
  Note, that "voa import" respects the XDG Base Directory Specification and the "XDG_RUNTIME_DIR" environment variable.
  The above serves as default example.
- "/run/voa": for users with uid < 1000

The verifier can be written to another, specific VOA base path using the "-b"/"--base-path" option."#
    )]
    Import(ImportCommand),

    /// The list subcommand.
    #[command(
        about = "List all verifiers in VOA that match provided identifiers.",
        long_about = r#"List all verifiers in VOA that match provided identifiers.

By default the "os" and "purpose" identifiers have to be provided for a search.
Optionally, the "context" and "technology" identifier can be provided for more fine-grained search results.
"#
    )]
    List(ListCommand),

    /// The verify subcommand.
    #[command(
        about = "Verify a file using suitable verifiers and signatures.",
        long_about = "Verify a file using suitable verifiers and signatures.

Returns a status message on stdout.

Returns a non-zero exit code and an error message on stderr, if the verification of one or more signature files fails."
    )]
    Verify(VerifyCommand),
}