Module backend 

Backend handling for NetHsm.

Based on a NetHsm, NetHsmAdminCredentials and a Config this module offers the ability to populate a NetHsm backend with the help of the NetHsmBackend struct.

Using NetHsmBackend::sync all users and keys configured in a Config are created and adapted to changes upon re-run. The state representation can be found in the nethsm::state module.

Note

This module only works with data for the same iteration (i.e. the iteration of the NetHsmAdminCredentials and those of the NetHsm backend must match).

Structs

KeySetupComparison 🔒

Comparable components of a key setup between a NetHsm backend and a Signstar config.

KeyState 🔒

The state of a key in a NetHsmBackend.

NetHsmBackend

A NetHSM backend that provides full control over its data.

NetHsmBackendState

The state of a NetHsmBackend.

UserState 🔒

The state of a user in a NetHsmBackend.

Functions

add_namespace_admins 🔒

Sets up all N-Administrators and their respective namespaces.

add_namespaced_keys 🔒

Sets up all namespaced keys and tags them.

add_namespaced_non_administrative_users 🔒

Sets up all namespaced non-administrative users.

add_namespaced_openpgp_certificates 🔒

Adds OpenPGP certificates for namespaced keys that are used for OpenPGP signing.

add_non_administrative_users 🔒

Sets up all system-wide, non-administrative users based on provided credentials.

add_system_wide_admins 🔒

Creates all R-Administrators on a NetHsm.

add_system_wide_keys 🔒

Sets up all system-wide keys.

add_system_wide_openpgp_certificates 🔒

Adds OpenPGP certificates for system-wide keys that are used for OpenPGP signing.

compare_key_setups 🔒

Compares the key setups of a key from a Signstar config and that of a NetHSM backend.

get_first_available_namespace_admin 🔒

Retrieves the first available user in the [Administrator][UserRole::Administrator] (N-Administrator) role in a namespace.