Struct StoreKeyring 

pub struct StoreKeyring { /* private fields */ }

Every store and circle key this device has opened, including older keys (§12.2). Cloning lets in-memory custody keep its copy while returning an unlocked one.

Implementations

impl StoreKeyring

pub fn new(key: StoreKey) -> Self

Start with one opened store key. A keyring always holds a store key.

pub fn insert_store_key(&mut self, key: StoreKey) -> Result<(), MaterialError>

Keep an opened store key; a different key at the same id is an error.

pub fn insert_circle_key(&mut self, key: CircleKey) -> Result<(), MaterialError>

Keep an opened circle key, retaining its earlier keys too (§15.5).

pub fn store_key(&self, key: KeyId) -> Result<&StoreKey, MaterialError>

An opened store key by identity, so older writes still open (§12.2).

pub fn store_key_ids(&self) -> impl Iterator<Item = KeyId> + '_

All held store-key identities, including keys preceding a member’s join.

pub fn circle_key_ids( &self, circle: CircleId, ) -> impl Iterator<Item = KeyId> + '_

All held keys for a circle, including concurrent and historical rotations.

pub fn circle_key( &self, circle: CircleId, key: KeyId, ) -> Result<&CircleKey, MaterialError>

An opened circle key by its circle and identity (§15.5).

pub fn to_secret_bytes(&self) -> SecretBytes

Encode every opened key for custody. The returned bytes remain secret.

pub fn from_secret_bytes(bytes: &[u8]) -> Result<Self, MaterialError>

Decode custody bytes, rejecting malformed, duplicate or empty keyrings.

Trait Implementations

impl Clone for StoreKeyring

fn clone(&self) -> StoreKeyring

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoreKeyring

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

Formats the value using the given formatter.

impl KeyMaterial for StoreKeyring

const ENTRY: &'static str = "store-keys"

The keychain entry and passphrase file entry it is kept under.

const FILE: StoreFile = StoreFile::StoreKeys

The store file a passphrase custody seals it in.

fn to_secret_bytes(&self) -> SecretBytes

Encode it for custody.

fn from_secret_bytes(bytes: &[u8]) -> Result<Self, MaterialError>

Decode what to_secret_bytes encoded.