Struct NetHsmAdminCredentials 

pub struct NetHsmAdminCredentials {
    iteration: u32,
    backup_passphrase: Passphrase,
    unlock_passphrase: Passphrase,
    administrators: Vec<FullCredentials>,
    namespace_administrators: Vec<FullCredentials>,
}

Administrative credentials.

Tracks the following credentials and passphrases:

• the backup passphrase of the backend,
• the unlock passphrase of the backend,
• the top-level administrator credentials of the backend,
• the namespace administrator credentials of the backend.

Note

The unlock and backup passphrase must be at least 10 characters long. The passphrases of top-level and namespace administrator accounts must be at least 10 characters long. The list of top-level administrator credentials must include an account with the username “admin”.

Fields

iteration: u32

backup_passphrase: Passphrase

unlock_passphrase: Passphrase

administrators: Vec<FullCredentials>

namespace_administrators: Vec<FullCredentials>

Implementations

impl NetHsmAdminCredentials

pub const BACKUP_PASSPHRASE_POLICY: PassphrasePolicy

The default PassphrasePolicy for a backup passphrase.

pub const UNLOCK_PASSPHRASE_POLICY: PassphrasePolicy

The default PassphrasePolicy for a backup passphrase.

pub const ADMIN_PASSPHRASE_POLICY: PassphrasePolicy

The default PassphrasePolicy for an admin passphrase.

pub fn new( iteration: u32, backup_passphrase: Passphrase, unlock_passphrase: Passphrase, administrators: Vec<FullCredentials>, namespace_administrators: Vec<FullCredentials>, ) -> Result<Self, Error>

Creates a new NetHsmAdminCredentials instance.

Examples

use nethsm::FullCredentials;
use signstar_config::nethsm::NetHsmAdminCredentials;

let creds = NetHsmAdminCredentials::new(
    1,
    "backup-passphrase-really-just-for-testing-i-promise".parse()?,
    "unlock-passphrase-really-just-for-testing-i-promise".parse()?,
    vec![FullCredentials::new(
        "admin".parse()?,
        "admin-passphrase-really-just-for-testing-i-promise".parse()?,
    )],
    vec![FullCredentials::new(
        "ns1~admin".parse()?,
        "ns1-admin-passphrase-really-just-for-testing-i-promise".parse()?,
    )],
)?;

pub fn unlock_passphrase(&self) -> &Passphrase

Returns the unlock passphrase.

pub fn administrators(&self) -> &[FullCredentials]

Returns the list of administrators.

pub fn default_administrator(&self) -> Result<&FullCredentials, Error>

Returns the default system-wide administrator “admin”.

Errors

Returns an error if no administrative account with the system-wide UserId “admin” is found.

pub fn namespace_administrators(&self) -> &[FullCredentials]

Returns the list of namespace administrators.

pub fn administrators_in_config( &self, config: &NetHsmConfig, ) -> Vec<&FullCredentials>

Returns the list of system-wide administrators, also present in a NetHsmConfig.

Retrieves the list of NetHsmUserMapping instances that represent system-wide administrators from config. Filters out all UserIds that cannot be matched and emits warnings for all unmatched ones.

pub fn namespace_administrators_in_config( &self, config: &NetHsmConfig, ) -> Vec<&FullCredentials>

Returns the list of namespace administrators, also present in a NetHsmConfig.

Retrieves the list of NetHsmUserMapping instances that represent namespace administrators from config. Filters out all UserIds that cannot be matched and emits warnings for all unmatched ones.

Trait Implementations

impl AdminCredentials for NetHsmAdminCredentials

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

Validates the NetHsmAdminCredentials.

Errors

Returns an error if

• there is no top-level administrator user,
• the default top-level administrator user (with the name “admin”) is missing,
• a user passphrase is too short,
• the backup passphrase is too short,
• or the unlock passphrase is too short.

fn iteration(&self) -> u32

Returns the iteration of the administrative credentials.

fn backup_passphrase(&self) -> &Passphrase

Returns the backup passphrase.

fn load(secrets_handling: AdministrativeSecretHandling) -> Result<Self, Error>

Loads an AdminCredentials from the default file location.

fn load_from_file( path: impl AsRef<Path>, secrets_handling: AdministrativeSecretHandling, ) -> Result<Self, Error>

Loads an AdminCredentials from file.

fn store( &self, secrets_handling: AdministrativeSecretHandling, ) -> Result<(), Error>

Stores the AdminCredentials as a file in the default location.

impl Clone for NetHsmAdminCredentials

fn clone(&self) -> NetHsmAdminCredentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NetHsmAdminCredentials

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

Formats the value using the given formatter.

impl Default for NetHsmAdminCredentials

fn default() -> NetHsmAdminCredentials

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NetHsmAdminCredentials

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for NetHsmAdminCredentials

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

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.