Struct Keyring 

pub struct Keyring { /* private fields */ }

Runtime key rotation for one node, from Memberlist::keyring.

Every call acts on this node only. To rotate a cluster, run each step on every node and wait for it to finish everywhere before starting the next:

1. install the new key, so every node can read it;
2. use_key it, so every node sends with it;
3. remove the old key.

A node that falls a step behind looks dead to its peers until it catches up, and they count what they dropped as decrypt_failures in Stats. A node that runs without encryption refuses every call with Error::NotEncrypted. Key ids are safe to log; key bytes never are.

A handle is cheap to clone and keeps working only while the node runs: calls on a closed node fail with Error::Closed.

Implementations

impl Keyring

pub async fn install(&self, key: Key) -> Result<(), Error>

Adds key to the keys this node can decrypt with. Does nothing if it is installed.

pub async fn use_key(&self, key: Key) -> Result<(), Error>

Makes the installed key the one this node encrypts with. Every installed key still decrypts. Fails with Error::KeyNotInstalled for a key that was never installed.

Named use_key because use is a Rust keyword; Python spells it use.

pub async fn remove(&self, key: Key) -> Result<(), Error>

Drops key. Fails with Error::KeyInUse for the key this node encrypts with and Error::LastKey for the only one; a key that is not installed is already gone.

pub fn key_ids(&self) -> Vec<KeyId>

The ids of the installed keys, the one this node encrypts with first. Empty when the node runs without encryption. Never waits on the actor.

Trait Implementations

impl Clone for Keyring

fn clone(&self) -> Keyring

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keyring

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

Formats the value using the given formatter.