Skip to main content

HostConfiguration

signstar_configure::host::base

Struct HostConfiguration 

Source 
pub struct HostConfiguration<'config> {
    config: &'config Config,
}
Expand description

Signstar host configuration.

Manages the synchronization of HSM backends with the Signstar configuration, as well as the configuration of non-administrative users and their credentials for their respective backends.

Fields§

§config: &'config Config

The Signstar configuration.

Implementations§

Source§

impl<'config> HostConfiguration<'config>

Source

pub fn sync(&self) -> Result<ConfigurationResult, Error>

Syncs the Signstar host with its configuration.

§Errors

Returns an error, if

  • the syncing of NetHSM backends fails
  • the syncing of YubiHSM2 backends fails
Source§

impl<'config> HostConfiguration<'config>

Source

pub fn new(config: &'config Config) -> Self

Creates a new HostConfiguration from a Config.

Source

pub fn config(&self) -> &Config

Returns a reference to the Config.

Source§

impl<'config> HostConfiguration<'config>

Source

fn load_nethsm_admin_credentials(&self) -> Result<NetHsmAdminCredentials, Error>

Loads NetHsmAdminCredentials.

§Errors

Returns an error if NetHsmAdminCredentials::load fails.

Source

fn available_nethsm_connections(config: &NetHsmConfig) -> Vec<NetHsm>

Returns the list of available connections to NetHSM backends.

Source

fn provisioned_nethsm_connections(config: &NetHsmConfig) -> Vec<&Connection>

Returns the list of provisioned NetHSM backend connections.

Source

fn create_nethsm_non_admin_credentials( &self, ) -> Result<Vec<FullCredentials>, Error>

Creates new credentials for all non-administrative NetHSM backend users.

§Errors

Returns an error, if the non-administrative credentials for a specific user cannot be created.

Source

fn sync_nethsm_backends( &self, available_connections: Vec<NetHsm>, admin_credentials: &NetHsmAdminCredentials, user_credentials: &[FullCredentials], ) -> Result<(), Error>

Syncs all available NetHSM backends.

Returns early success, if there is no NetHSM section in the Signstar config.

§Errors

Returns an error, if

Source

pub fn sync_nethsm(&self) -> Result<ConfigurationResult, Error>

Syncs the states of all available NetHSM backends with that of the Signstar configuration.

§Errors

Returns an error, if

  • the creation of non-administrative credentials fails
  • the syncing of the backend fails
Source§

impl<'config> HostConfiguration<'config>

Source

fn load_yubihsm2_admin_credentials( &self, ) -> Result<YubiHsm2AdminCredentials, Error>

Loads YubiHsm2AdminCredentials.

§Errors

Returns an error if YubiHsm2AdminCredentials::load fails.

Source

fn create_yubihsm2_non_admin_credentials( &self, ) -> Result<Vec<Credentials>, Error>

Creates new credentials for all non-administrative YubiHSM2 backend users.

§Errors

Returns an error, if the non-administrative credentials for a specific user cannot be created.

Source

fn available_yubihsm2_connections(config: &YubiHsm2Config) -> Vec<Connector>

Returns the list of available connections to YubiHSM2 backends.

Source

fn provisioned_yubihsm2_connections(config: &YubiHsm2Config) -> Vec<&Connection>

Returns the list of provisioned YubiHSM2 backend connections.

Source

fn sync_yubihsm2_backends( &self, available_connections: Vec<Connector>, admin_credentials: &YubiHsm2AdminCredentials, user_credentials: &[Credentials], ) -> Result<(), Error>

Syncs all available YubiHSM2 backends.

Returns early success, if there is no YubiHSM2 section in the Signstar config.

§Errors

Returns an error, if

Source

pub fn sync_yubihsm2(&self) -> Result<ConfigurationResult, Error>

Syncs the states of all available YubiHSM2 backends with that of the Signstar configuration.

§Errors

Returns an error, if

  • the creation of non-administrative credentials fails
  • the syncing of the backend fails

Trait Implementations§

Source§

impl<'config> Debug for HostConfiguration<'config>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'config> Freeze for HostConfiguration<'config>

§

impl<'config> RefUnwindSafe for HostConfiguration<'config>

§

impl<'config> Send for HostConfiguration<'config>

§

impl<'config> Sync for HostConfiguration<'config>

§

impl<'config> Unpin for HostConfiguration<'config>

§

impl<'config> UnsafeUnpin for HostConfiguration<'config>

§

impl<'config> UnwindSafe for HostConfiguration<'config>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V