Secret

Struct Secret 

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

A 256-bit symmetric encryption key for content encryption

Each Secret is used to encrypt a single item (node or data blob) using ChaCha20-Poly1305 AEAD. The encrypted format is: nonce (12 bytes) || encrypted(hash(32 bytes) || plaintext) || tag (16 bytes). The BLAKE3 hash of the plaintext is prepended before encryption to enable content verification without full decryption (useful for filesystem sync operations).

§Examples

// Generate a new random secret
let secret = Secret::generate();

// Encrypt data
let plaintext = b"sensitive data";
let ciphertext = secret.encrypt(plaintext)?;

// Decrypt data
let recovered = secret.decrypt(&ciphertext)?;
assert_eq!(plaintext, &recovered[..]);

Implementations§

Source§

impl Secret

Source

pub fn generate() -> Self

Generate a new random secret using a cryptographically secure RNG

Source

pub fn from_slice(data: &[u8]) -> Result<Self, SecretError>

Create a secret from a byte slice

§Errors

Returns an error if the slice length is not exactly SECRET_SIZE bytes.

Source

pub fn bytes(&self) -> &[u8]

Get a reference to the secret key bytes

Source

pub fn encrypt(&self, data: &[u8]) -> Result<Vec<u8>, SecretError>

Encrypt data using ChaCha20-Poly1305 AEAD

The output format is: nonce (12 bytes) || encrypted(hash(32) || plaintext) || auth_tag (16 bytes). A BLAKE3 hash of the plaintext is computed and prepended to the data before encryption. A random nonce is generated for each encryption operation.

§Errors

Returns an error if encryption fails (should be rare, only on system RNG failure).

Source

pub fn decrypt(&self, data: &[u8]) -> Result<Vec<u8>, SecretError>

Decrypt data using ChaCha20-Poly1305 AEAD

Expects input in the format: nonce (12 bytes) || encrypted(hash(32) || plaintext) || auth_tag (16 bytes). Returns only the plaintext (hash is stripped but verified for integrity).

§Errors

Returns an error if:

  • Data is too short to contain a nonce
  • Authentication tag verification fails (data was tampered with or wrong key)
  • Decrypted data is too short to contain the hash header
  • Hash verification fails (data corruption)
Source

pub fn extract_plaintext_hash( &self, data: &[u8], ) -> Result<[u8; 32], SecretError>

Extract the BLAKE3 hash of the plaintext without decrypting the full content

This is useful for filesystem sync operations where you only need to compare content hashes without loading the entire file into memory.

§Errors

Returns an error if:

  • Data is too short to contain a nonce
  • Authentication tag verification fails (data was tampered with or wrong key)
  • Decrypted data is too short to contain the hash header
Source

pub fn encrypt_reader<R>(&self, reader: R) -> Result<impl Read, SecretError>
where R: Read,

Create an encrypted reader from a plaintext reader

This buffers all data in memory, encrypts it, and returns a reader over the encrypted data. Future optimization: implement true streaming encryption.

Source

pub fn decrypt_reader<R>(&self, reader: R) -> Result<impl Read, SecretError>
where R: Read,

Create a decrypted reader from an encrypted reader

This buffers all encrypted data in memory, decrypts it, and returns a reader over the plaintext. Future optimization: implement true streaming decryption.

Trait Implementations§

Source§

impl Clone for Secret

Source§

fn clone(&self) -> Secret

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Secret

Source§

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

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

impl Default for Secret

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Deref for Secret

Source§

type Target = [u8; 32]

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<'de> Deserialize<'de> for Secret

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<[u8; 32]> for Secret

Source§

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

Converts to this type from the input type.
Source§

impl PartialEq for Secret

Source§

fn eq(&self, other: &Secret) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Secret

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Secret

Auto Trait Implementations§

§

impl Freeze for Secret

§

impl RefUnwindSafe for Secret

§

impl Send for Secret

§

impl Sync for Secret

§

impl Unpin for Secret

§

impl UnwindSafe for Secret

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

Source§

fn compat(self) -> Compat<T>

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. Read more
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> RpcMessage for T
where T: Debug + Serialize + DeserializeOwned + Send + Sync + Unpin + 'static,