Struct Config 

pub struct Config {
    system: SystemConfig,
    nethsm: Option<NetHsmConfig>,
    yubihsm2: Option<YubiHsm2Config>,
}

The configuration of a Signstar system.

Tracks system-wide configuration items, as well as configurations for specific backends.

Fields

system: SystemConfig

System configuration object.

nethsm: Option<NetHsmConfig>

Optional configuration object for NetHSM backends.

Note

Only supported when using the nethsm feature.

yubihsm2: Option<YubiHsm2Config>

Optional configuration object for YubiHSM2 backends.

Note

Only supported when using the yubihsm2 feature.

Implementations

impl Config

pub fn user_backend_connection( &self, user: &SystemUserId, ) -> Option<UserBackendConnection>

Returns the optional UserBackendConnection matching a SystemUserId.

pub fn user_backend_connections( &self, filters: &[UserBackendConnectionFilter], ) -> Vec<UserBackendConnection>

Returns a list of UserBackendConnection objects matching a set of filters.

If no filters are provided, returns all available UserBackendConnection objects of all backends.

Beyond filtering for specific backend types, it is possible to only return administrative or non-administrative objects.

impl Config

pub const DEFAULT_CONFIG_DIR: &str = "/usr/share/signstar/"

The default config directory below “/usr/”.

pub const RUN_OVERRIDE_CONFIG_DIR: &str = "/run/signstar/"

The override config directory below “/run/”.

pub const ETC_OVERRIDE_CONFIG_DIR: &str = "/etc/signstar/"

The override config directory below “/etc/”.

pub const CONFIG_NAME: &str = "config"

The configuration file name (without file type suffix).

pub fn default_system_path() -> PathBuf

Returns the default location of the Signstar configuration file on a system.

pub fn first_existing_system_path() -> Result<PathBuf, Error>

Returns the first found path of a Signstar configuratino on the system.

Errors

Returns an error if no configuration file is found.

pub fn list_config_dirs() -> Vec<PathBuf>

Returns the list of supported directory paths in which configuration files may reside.

The returned list of paths is sorted in increasing precedence.

pub fn list_config_file_paths() -> Vec<PathBuf>

Returns the list of supported configuration file paths.

The returned list of paths is sorted in increasing precedence.

fn from_yaml_str(s: &str) -> Result<Self, Error>

Creates a new Config from a string slice containing YAML data.

Errors

Returns an error if deserialization or validation fails.

fn from_yaml_file(path: impl AsRef<Path>) -> Result<Self, Error>

Creates a new Config from a file containing YAML data.

Errors

Returns an error if

• the file does not exist
• deserialization or validation fails.

pub fn from_file_path(path: impl AsRef<Path>) -> Result<Self, Error>

Creates a new Config from a file path.

Errors

Returns an error if

• path has no file extension
• path does not use one of the supported file extensions
• creating a Config from the data fails
• validating a Config created from the data fails

pub fn from_system_path() -> Result<Self, Error>

Creates a new Config from the first found Signstar configuration file path on the system.

Note

Uses Config::first_existing_system_path to determine the first existing Signstar configuration file path.

Errors

Returns an error if Config creation from the found path fails.

pub fn to_yaml_string(&self) -> Result<String, Error>

Serializes self as a YAML string.

Errors

Returns an error if serialization fails.

pub fn system(&self) -> &SystemConfig

Returns a reference to the SystemConfig.

pub fn nethsm(&self) -> Option<&NetHsmConfig>

Returns a reference to the NetHsmConfig.

pub fn yubihsm2(&self) -> Option<&YubiHsm2Config>

Returns a reference to the YubiHsm2Config.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConfigAuthorizedKeyEntries for Config

fn authorized_key_entries(&self) -> HashSet<&AuthorizedKeyEntry>

Returns the list of all AuthorizedKeyEntrys.

impl<'a> ConfigSystemUserData<'a> for Config

fn system_user_data(&'a self) -> HashSet<SystemUserData<'a>>

Returns the list of all SystemUserData.

impl ConfigSystemUserIds for Config

fn system_user_ids(&self) -> HashSet<&SystemUserId>

Returns the list of all SystemUserIds.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Config

impl<'a> From<&'a Config> for SystemUserConfigState<'a>

fn from(value: &'a Config) -> Self

Converts to this type from the input type.

impl FromStr for Config

fn from_str(s: &str) -> Result<Self, Self::Err>

Creates a new Config from a string slice containing valid YAML.

Errors

Returns an error if no Config can be created from s.

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config

impl TryFrom<&Config> for NetHsmAdminCredentials

fn try_from(config: &Config) -> Result<Self, Self::Error>

Creates a new NetHsmAdminCredentials from a Config.

Note

This generates a new backup passphrase and administrative passphrases, adhering to the hardcoded passphrase policies (e.g. minimum length).

Errors

Returns an error, if

• config does not contain a NetHsmConfig
• NetHsmAdminCredentials::new fails on the generated data

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<&Config> for YubiHsm2AdminCredentials

fn try_from(config: &Config) -> Result<Self, Self::Error>

Creates a new YubiHsm2AdminCredentials from a Config.

Note

This generates a new backup passphrase and administrative passphrases, adhering to the hardcoded passphrase policies (e.g. minimum length).

Errors

Returns an error, if

• config does not contain a YubiHsm2Config
• YubiHsm2AdminCredentials::new fails on the generated data

type Error = Error

The type returned in the event of a conversion error.

impl Validate for Config

type Context = ()

A user-provided context.

fn validate_into( &self, __garde_user_ctx: &Self::Context, __garde_path: &mut dyn FnMut() -> Path, __garde_report: &mut Report, )

Validates Self, aggregating all validation errors into Report.

fn validate(&self) -> Result<(), Report>

where Self::Context: Default,

Validates Self, returning an Err with an aggregate of all errors if the validation failed.

fn validate_with(&self, ctx: &Self::Context) -> Result<(), Report>

Validates Self, returning an Err with an aggregate of all errors if the validation failed.