Enum NetHsmUserMapping 

pub enum NetHsmUserMapping {
    Admin(UserId),
    Backup {
        backend_user: SystemWideUserId,
        ssh_authorized_key: AuthorizedKeyEntry,
        system_user: SystemUserId,
    },
    HermeticMetrics {
        backend_users: NetHsmMetricsUsers,
        system_user: SystemUserId,
    },
    Metrics {
        backend_users: NetHsmMetricsUsers,
        ssh_authorized_key: AuthorizedKeyEntry,
        system_user: SystemUserId,
    },
    Signing {
        backend_user: UserId,
        signing_key_id: KeyId,
        key_setup: SigningKeySetup,
        ssh_authorized_key: AuthorizedKeyEntry,
        system_user: SystemUserId,
        tag: String,
    },
}

User and data mapping between system users and NetHSM users.

Variants

Admin(UserId)

A NetHsm user in the Administrator role, without a system user mapped to it.

Backup

A system user, with SSH access, mapped to a system-wide NetHSM user in the Backup role.

Fields

backend_user: SystemWideUserId

The name of the NetHSM user.

ssh_authorized_key: AuthorizedKeyEntry

The SSH public key used for connecting to the system_user.

system_user: SystemUserId

The name of the system user.

HermeticMetrics

A system user, without SSH access, mapped to a system-wide NetHSM user in the Metrics role and one or more NetHsm users in the Operator role with read-only access to zero or more keys.

Fields

backend_users: NetHsmMetricsUsers

The NetHSM users in the [Metrics][UserRole::Metrics] and [operator][UserRole::Operator] role.

system_user: SystemUserId

The name of the system user.

Metrics

A system user, with SSH access, mapped to a system-wide NetHSM user in the Metrics role and n users in the Operator role with read-only access to zero or more keys.

Fields

backend_users: NetHsmMetricsUsers

The NetHSM users in the [Metrics][UserRole::Metrics] and [operator][UserRole::Operator] role.

ssh_authorized_key: AuthorizedKeyEntry

The SSH public key used for connecting to the system_user.

system_user: SystemUserId

The name of the system user.

Signing

A system user, with SSH access, mapped to a NetHSM user in the Operator role with access to a single signing key.

Signing key and NetHSM user are mapped using a tag.

Fields

backend_user: UserId

The name of the NetHSM user.

signing_key_id: KeyId

The ID of the NetHSM key.

key_setup: SigningKeySetup

The setup of a NetHSM key.

ssh_authorized_key: AuthorizedKeyEntry

The SSH public key used for connecting to the system_user.

system_user: SystemUserId

The name of the system user.

tag: String

The tag used for the user and the signing key on the NetHSM.

Implementations

impl NetHsmUserMapping

pub fn namespaces(&self) -> Vec<&NamespaceId>

Returns the list of [NamespaceId]s associated with this NetHsmUserMapping.

pub fn tag(&self, namespace: Option<&NamespaceId>) -> Option<&str>

Returns the optional tag used in the NetHsmUserMapping.

Note

Only NetHsmUserMapping::Signing can have a tag.

pub fn nethsm_user_ids(&self) -> Vec<UserId>

Returns the list of [UserId] objects associated with this NetHsmUserMapping.

pub fn nethsm_user_data<'a>(&'a self) -> HashSet<NetHsmUserData<'a>>

Returns the list of NetHsmUserData objects associated with this NetHsmUserMapping.

pub fn nethsm_user_key_data<'a>( &'a self, filter: NetHsmUserKeysFilter, ) -> Option<NetHsmUserKeyData<'a>>

Returns a filtered list of NetHsmUserKeyData objects from this NetHsmUserMapping.

Based on a NetHsmUserKeysFilter it is possible to target only namespaced or system-wide, or all user mappings that have associated key configs.

Trait Implementations

impl Clone for NetHsmUserMapping

fn clone(&self) -> NetHsmUserMapping

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NetHsmUserMapping

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NetHsmUserMapping

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for NetHsmUserMapping

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl MappingAuthorizedKeyEntry for NetHsmUserMapping

fn authorized_key_entry(&self) -> Option<&AuthorizedKeyEntry>

Returns an optional SSH authorized_keys entry.

impl<'a> MappingBackendDomain<NetHsmConfigDomainFilter<'a>> for NetHsmUserMapping

fn backend_domain( &self, filter: Option<&NetHsmConfigDomainFilter<'_>>, ) -> Option<String>

Returns the optional tag of the NetHsmUserMapping.

Note

Delegates to NetHsmUserMapping::tag.

impl<'a> MappingBackendKeyId<NetHsmBackendKeyIdFilter<'a>> for NetHsmUserMapping

fn backend_key_id( &self, filter: &NetHsmBackendKeyIdFilter<'a>, ) -> Option<String>

Returns an optional String representing a backend key ID according to a filter.

impl MappingBackendUserIds for NetHsmUserMapping

fn backend_user_ids(&self, filter: BackendUserIdFilter) -> Vec<String>

Returns a list of Strings representing backend User IDs according to a filter.

fn backend_user_with_passphrase( &self, name: &str, passphrase: Passphrase, ) -> Result<Box<dyn UserWithPassphrase>, Error>

Returns a specific UserWithPassphrase implementation for a backend user.

fn backend_users_with_new_passphrase( &self, filter: BackendUserIdFilter, ) -> Vec<Box<dyn UserWithPassphrase>>

Returns a list of UserWithPassphrase implementations according to a filter.

impl MappingBackendUserSecrets for NetHsmUserMapping

fn create_non_admin_backend_user_secrets( &self, secret_handling: NonAdministrativeSecretHandling, ) -> Result<Option<Vec<Box<dyn UserWithPassphrase>>>, Error>

Creates on-disk secrets for non-administrative backend users of the mapping.

fn load_non_admin_backend_user_secrets( &self, secret_handling: NonAdministrativeSecretHandling, filter: NonAdminBackendUserIdFilter, ) -> Result<Option<Vec<Box<dyn UserWithPassphrase>>>, Error>

Loads secrets from on-disk files for each non-administrative backend user matching a filter.

impl MappingSystemUserId for NetHsmUserMapping

fn system_user_id(&self) -> Option<&SystemUserId>

Returns a reference to the SystemUserId.

fn system_user_id_as_existing_unix_user(&self) -> Result<Option<User>, Error>

Returns the tracked system user ID as [User] if it exists.

fn system_user_id_as_current_unix_user(&self) -> Result<Option<User>, Error>

Returns the tracked system user ID as the current [User] if it exists.

impl Ord for NetHsmUserMapping

fn cmp(&self, other: &NetHsmUserMapping) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for NetHsmUserMapping

fn eq(&self, other: &NetHsmUserMapping) -> 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 PartialOrd for NetHsmUserMapping

fn partial_cmp(&self, other: &NetHsmUserMapping) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for NetHsmUserMapping

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for NetHsmUserMapping

impl StructuralPartialEq for NetHsmUserMapping