Skip to main content

MasterKey

Struct MasterKey 

Source
pub struct MasterKey(/* private fields */);
Expand description

Implementations§

Source§

impl MasterKey

Source

pub const fn from_bytes(bytes: [u8; 32]) -> Self

Construct from explicit bytes. The agent must keep the bytes confidential; the wrapper offers no extra protection beyond not implementing Debug or Display.

Source

pub fn from_file(path: impl AsRef<Path>) -> Result<Self>

Read a 32-byte master key from path.

Source

pub fn from_keyring() -> Result<Self>

Look up the master key in the OS keyring under (vibesurfer, default). Reads the entry as a hex string so it round-trips through cross-platform secret stores that don’t tolerate raw bytes.

Source

pub fn resolve(fallback_path: impl AsRef<Path>) -> Result<Self>

Try the OS keyring first; fall back to path. Errors only if both fail.

Source

pub fn generate() -> Result<Self>

Generate a fresh random key from the system CSPRNG.

Source

pub fn write_to_file(&self, path: impl AsRef<Path>) -> Result<()>

Persist the key as 32 raw bytes at path. Caller is responsible for chmod-ing the file (typically 0600) and for ensuring the destination directory exists.

Source

pub fn write_to_keyring(&self) -> Result<()>

Persist the key into the OS keyring as a hex string.

Trait Implementations§

Source§

impl Clone for MasterKey

Source§

fn clone(&self) -> MasterKey

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 MasterKey

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.