Crate nethsm_config

Source
Expand description

A library for working with application configuration files for Nitrokey NetHSM devices

Provides configuration file management for custom applications designed around working with Nitrokey NetHSM devices or containers. Configuration settings allow for individualizing the configuration use and its use-cases (interactive or non-interactive).

A module for interactive prompts provides extra convenience around creating applications that may request further data from their users interactively.

ยงExamples

use nethsm::{ConnectionSecurity, UserRole};
use nethsm_config::{Config, ConfigCredentials, ConfigInteractivity, ConfigSettings};

// a configuration for a non-interactive application called "my_app"
let config_settings = ConfigSettings::new(
    "my_app".to_string(),
    ConfigInteractivity::NonInteractive,
    None,
);

// let's assume a custom configuration file path
let tmpfile = testdir::testdir!().join("my_app.conf");
let config = Config::new(config_settings, Some(&tmpfile))?;

// add a first device to commnicate with
config.add_device(
    "nethsm1".to_string(),
    "https://example.org/api/v1".parse()?,
    ConnectionSecurity::Unsafe,
)?;

// add credentials to communicate with the the device
config.add_credentials(
    "nethsm1".to_string(),
    ConfigCredentials::new(
        UserRole::Administrator,
        "admin1".parse()?,
        Some("my-passphrase".to_string()),
    ),
)?;

// write configuration to file
config.store(Some(&tmpfile))?;

Modulesยง

config ๐Ÿ”’
credentials ๐Ÿ”’
prompt ๐Ÿ”’

Structsยง

Config
A configuration for NetHSM devices
ConfigCredentials
A set of credentials for a [NetHsm][nethsm::NetHsm]
ConfigName
The name of a configuration
ConfigSettings
The settings for a Config
DeviceConfig
The configuration for a [NetHsm]
UserPrompt
Username prompt

Enumsยง

ConfigInteractivity
The interactivity of a configuration
Error
Errors related to configuration
PassphrasePrompt
Passphrase prompt