Skip to main content

LocalKeyCipher

Struct LocalKeyCipher 

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

The single-user reference cipher: a local 256-bit ChaCha20-Poly1305 key.

Genuinely linearizable-free confidentiality + integrity for the personal multi-device case. NOT a login-derived or org-distributed key — see the module’s key-distribution follow-up.

Implementations§

Source§

impl LocalKeyCipher

Source

pub fn from_key(key: [u8; 32]) -> Self

Build a cipher over an explicit 256-bit key.

Source

pub fn generate() -> Self

Mint a fresh random key (OS CSPRNG). Not persisted — pair with Self::key_hex to store it, or use Self::load_or_generate.

Source

pub fn key_hex(&self) -> String

The key as 64 hex chars (for persistence). Handle as a secret.

Source

pub fn from_key_hex(hex: &str) -> Result<Self, CryptoError>

Parse a 64-hex-char key.

Source

pub fn load_or_generate(path: &Path) -> Result<Self, CryptoError>

Load the key from path, or mint + persist a new one there (0600 on unix). The single-user “the key lives on my devices” story — a device gets the key out of band (copy the file / a recovery phrase); this is the local reference, not the login-derived distribution (the follow-up).

Trait Implementations§

Source§

impl Clone for LocalKeyCipher

Source§

fn clone(&self) -> LocalKeyCipher

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 LocalKeyCipher

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for LocalKeyCipher

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. Read more
Source§

impl PayloadCipher for LocalKeyCipher

Source§

fn encrypt(&self, plaintext: &Value) -> Result<Value, CryptoError>

Encrypt a cleartext payload into a ciphertext Envelope (as a Value).
Source§

fn decrypt(&self, envelope: &Value) -> Result<Value, CryptoError>

Recover the cleartext payload from a ciphertext Envelope. Fails (CryptoError::Decrypt) on a wrong key or any tamper.

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more