Struct KeyManager

pub struct KeyManager<T, D>
where
    D: Delegate<Id = T::Id, Address = <T::Resolver as AddressResolver>::ResolvedAddress>,
    T: Transport,
{ /* private fields */ }

Available on crate feature encryption only.

KeyManager encapsulates all functionality within Serf for handling encryption keyring changes across a cluster.

Implementations

impl<T, D> KeyManager<T, D>

where D: Delegate<Id = T::Id, Address = <T::Resolver as AddressResolver>::ResolvedAddress>, T: Transport,

pub async fn install_key( &self, key: SecretKey, opts: Option<KeyRequestOptions>, ) -> Result<KeyResponse<T::Id>, Error<T, D>>

Handles broadcasting a query to all members and gathering responses from each of them, returning a list of messages from each node and any applicable error conditions.

pub async fn use_key( &self, key: SecretKey, opts: Option<KeyRequestOptions>, ) -> Result<KeyResponse<T::Id>, Error<T, D>>

Handles broadcasting a primary key change to all members in the cluster, and gathering any response messages. If successful, there should be an empty KeyResponse returned.

pub async fn remove_key( &self, key: SecretKey, opts: Option<KeyRequestOptions>, ) -> Result<KeyResponse<T::Id>, Error<T, D>>

Handles broadcasting a key to the cluster for removal. Each member will receive this event, and if they have the key in their keyring, remove it. If any errors are encountered, RemoveKey will collect and relay them.

pub async fn list_keys(&self) -> Result<KeyResponse<T::Id>, Error<T, D>>

Used to collect installed keys from members in a Serf cluster and return an aggregated list of all installed keys. This is useful to operators to ensure that there are no lingering keys installed on any agents. Since having multiple keys installed can cause performance penalties in some cases, it’s important to verify this information and remove unneeded keys.