Struct MasterKey 

pub struct MasterKey(/* private fields */);

The repository key.

Deliberately has no Debug, Display or Clone: the only ways out are MasterKey::expose_bytes, whose name is meant to be uncomfortable at a call site, and the derivations below.

Implementations

impl MasterKey

pub fn generate() -> Result<Self>

Draws a fresh key from the operating system’s entropy source.

Errors

Error::Entropy when the platform refuses to provide randomness. Falling back to anything weaker would be worse than failing.

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

Wraps key material that came from a key file.

pub fn expose_bytes(&self) -> &[u8; 32]

The raw key material.

Named to make every call site read like the disclosure it is. Only the key file writer and export-key have any business calling it.

pub fn key_id(&self) -> [u8; 8]

The fingerprint stored in every encrypted file’s header.

Identifies the key, not the suite, so it survives a future change of cipher and keeps unlock and export-key working across one.

Panics

Never in practice: KEY_ID_LEN is eight bytes against HKDF’s ceiling of 8160, so the expansion cannot fail. Handing back half-derived material instead would put a wrong key_id into a file header for good.

pub fn suite_key(&self, suite: u8) -> Result<SuiteKey>

The working key for suite.

Errors

Error::Format for a suite this build cannot key.

Trait Implementations

impl Drop for MasterKey

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Zeroize for MasterKey

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.