signstar-common 0.3.0

Common components for Signstar libraries and command-line interfaces
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

//! Common components for any type of backend.

use std::collections::HashMap;

/// The [os-release] `ID` for Arch Linux.
///
/// [os-release]: https://man.archlinux.org/man/os-release.5
const OS_ARCH: &str = "arch";

/// The Unix groups required to connect to a YubiHSM2 backend on an Arch Linux system.
const ARCH_YUBIHSM2_GROUPS: &[&str] = &["_yubihsm2"];

/// The type of a supported HSM backend.
#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub enum BackendType {
    /// The NetHSM backend.
    NetHsm,

    /// The YubiHSM2 backend.
    YubiHsm2,
}

impl BackendType {
    /// Returns the required Unix groups for an operating system to connect to a given backend.
    ///
    /// The returned [`HashMap`] uses the `ID` of an OS in the [os-release] format as key.
    ///
    /// [os-release]: https://man.archlinux.org/man/os-release.5
    pub fn client_unix_groups(&self) -> HashMap<&str, &[&str]> {
        match self {
            Self::NetHsm => HashMap::new(),
            Self::YubiHsm2 => HashMap::from_iter([(OS_ARCH, ARCH_YUBIHSM2_GROUPS)]),
        }
    }
}