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 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::NetHsmAdminCredentials;

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

pub fn get_iteration(&self) -> u32

Returns the iteration.

pub fn get_backup_passphrase(&self) -> &str

Returns the backup passphrase.

pub fn get_unlock_passphrase(&self) -> &str

Returns the unlock passphrase.

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

Returns the list of administrators.

pub fn get_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 get_namespace_administrators(&self) -> &[FullCredentials]

Returns the list of namespace administrators.

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 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.