Struct YubiHsm2AdminCredentials 

pub struct YubiHsm2AdminCredentials {
    iteration: u32,
    backup_passphrase: Passphrase,
    administrators: Vec<Credentials>,
}

Administrative credentials for YubiHSM2 backends.

Tracks the following items:

• the minimum iteration for which the credentials should apply,
• the backup passphrase of the backend,
• the administrator credentials of the backend,

Note

There must be at least one set of [Credentials] in the list of administrators. The passphrases of administrator accounts must be at least Self::MINIMUM_PASSPHRASE_LENGTH_USER characters long. The backup passphrase must be at least Self::MINIMUM_PASSPHRASE_LENGTH_BACKUP characters long.

It is implied, that the administrator users of a YubiHSM2 backend have the necessary capabilities for the creation of other users and keys.

Fields

iteration: u32

backup_passphrase: Passphrase

administrators: Vec<Credentials>

Implementations

impl YubiHsm2AdminCredentials

pub const DEFAULT_ID: u16 = 1

The default ID on an unprovisioned YubiHSM2 device.

pub const DEFAULT_PASSPHRASE: &str = "password"

The default passphrase on an unprovisioned YubiHSM2 device.

pub const MINIMUM_PASSPHRASE_LENGTH_USER: usize = 8

The default passphrase on an unprovisioned YubiHSM2 device.

pub const MINIMUM_PASSPHRASE_LENGTH_BACKUP: usize = 10

The minimum length of a backup passphrase.

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

Creates a new YubiHsm2AdminCredentials.

Errors

Returns an error if

• there is no administrator user,
• a user passphrase is too short,
• or the backup passphrase is too short.

Trait Implementations

impl AdminCredentials for YubiHsm2AdminCredentials

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

Validates the YubiHsm2AdminCredentials.

Errors

Returns an error if

• there is no administrator user,
• a user passphrase is too short,
• or the backup 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 YubiHsm2AdminCredentials

fn clone(&self) -> YubiHsm2AdminCredentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YubiHsm2AdminCredentials

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

Formats the value using the given formatter.

impl Default for YubiHsm2AdminCredentials

fn default() -> YubiHsm2AdminCredentials

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for YubiHsm2AdminCredentials

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for YubiHsm2AdminCredentials

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

where __S: Serializer,

Serialize this value into the given Serde serializer.