Skip to main content

KeyVault

Struct KeyVault 

Source
pub struct KeyVault { /* private fields */ }
Expand description

In-memory key vault.

The vault is the entry point for everything key-vault does. Application code constructs one via KeyVaultBuilder, hands it RawKey values to be fragmented, and (in later phases) receives KeyHandles in return. The vault itself is cheap to clone (it is Arc-backed internally) and safe to share across threads.

In Phase 0.3 the vault exposes KeyVault::fragment and KeyVault::defragment convenience methods that route through the configured normalizer and StandardFragmenter. The full named-key registry arrives in Phase 0.9.

Implementations§

Source§

impl KeyVault

Source

pub fn is_locked_out(&self) -> bool

Returns true if the vault is in lock-out state.

Lock-out is the SecurityMonitor’s response to repeated failures: once the threshold is crossed, access to every key in the vault is denied until the configured recovery condition is met. In Phase 0.2 the lock-out flag exists but is never set; Phase 0.8 connects it to monitor events.

Source

pub fn config(&self) -> &VaultConfig

Snapshot of the vault’s configuration.

Source

pub fn fragment(&self, key: &RawKey) -> Result<Fragments>

Fragment a raw key through the configured normalizer, codex, and fragmenter.

The returned Fragments is opaque; pass it back to KeyVault::defragment to recover the (normalized + codex-encoded) bytes inverse-transformed.

§Pipeline
key → blake3_normalize (optional) → codex.encode (optional) → fragmenter.fragment → Fragments
§Errors

Returns whatever the underlying FragmentStrategy surfaces — in practice an Error::Fragment for a zero-length input.

Source

pub fn defragment(&self, fragments: &Fragments) -> Result<RawKey>

Reassemble fragments produced by KeyVault::fragment.

Inverts the codex transformation (if configured) so the recovered bytes are the normalized key (or the original raw key if normalization is off). Defragmentation itself is delegated to the configured FragmentStrategy.

§Errors

Returns Error::Defragment when the supplied fragments do not match the configured fragmenter’s layout.

Trait Implementations§

Source§

impl Clone for KeyVault

Source§

fn clone(&self) -> KeyVault

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KeyVault

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.