Share

Struct Share 

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

A cryptographic share that securely wraps a secret for a specific recipient

A Share contains an ephemeral public key and an AES-KW wrapped secret. Only the intended recipient (whose public key was used during creation) can recover the secret.

§Wire Format

[ ephemeral_pubkey: 32 bytes ][ wrapped_secret: 40 bytes ]

§Examples

// Alice wants to share a bucket secret with Bob
let bucket_secret = Secret::generate();
let bob_pubkey = bob_secret_key.public();

// Alice creates a share for Bob
let share = Share::new(&bucket_secret, &bob_pubkey)?;

// Bob can recover the secret using his private key
let recovered_secret = share.recover(&bob_secret_key)?;
assert_eq!(bucket_secret, recovered_secret);

Implementations§

Source§

impl Share

Source

pub fn from_hex(hex: &str) -> Result<Self, ShareError>

Parse a share from a hexadecimal string

Accepts both plain hex and “0x”-prefixed hex strings.

Source

pub fn to_hex(&self) -> String

Convert share to hexadecimal string

Source

pub fn new(secret: &Secret, recipient: &PublicKey) -> Result<Self, ShareError>

Create a new share that wraps a secret for a specific recipient

This uses ECDH + AES Key Wrap to securely share the secret:

  1. Generates an ephemeral Ed25519 keypair
  2. Converts both keys to X25519 for ECDH
  3. Performs ECDH to derive a shared secret
  4. Uses AES-KW to wrap the secret with the shared secret
  5. Returns a Share containing [ephemeral_pubkey || wrapped_secret]
§Arguments
  • secret - The secret to share (e.g., a bucket encryption key)
  • recipient - The public key of the intended recipient
§Errors

Returns an error if key conversion or encryption fails.

Source

pub fn recover( &self, recipient_secret: &SecretKey, ) -> Result<Secret, ShareError>

Recover the wrapped secret using the recipient’s private key

This reverses the wrapping process:

  1. Extracts the ephemeral public key from the Share
  2. Converts keys to X25519 for ECDH
  3. Performs ECDH to derive the same shared secret
  4. Uses AES-KW to unwrap the secret
§Arguments
  • recipient_secret - The recipient’s private key (must match the public key used in new)
§Errors

Returns an error if:

  • Key conversion fails
  • AES-KW unwrapping fails (wrong key or corrupted data)
  • Unwrapped secret has incorrect size
§Security Note

If this function returns an error, it means either the Share was created for a different recipient, the data was corrupted, or an attacker tampered with it.

Source

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

Get a reference to the raw share bytes

Trait Implementations§

Source§

impl Clone for Share

Source§

fn clone(&self) -> Share

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 Share

Source§

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

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

impl Default for Share

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Share

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; 72]> for Share

Source§

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

Converts to this type from the input type.
Source§

impl From<Share> for [u8; 72]

Source§

fn from(share: Share) -> Self

Converts to this type from the input type.
Source§

impl Hash for Share

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Share

Source§

fn eq(&self, other: &Share) -> 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 Share

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 TryFrom<&[u8]> for Share

Source§

type Error = ShareError

The type returned in the event of a conversion error.
Source§

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl Copy for Share

Source§

impl Eq for Share

Source§

impl StructuralPartialEq for Share

Auto Trait Implementations§

§

impl Freeze for Share

§

impl RefUnwindSafe for Share

§

impl Send for Share

§

impl Sync for Share

§

impl Unpin for Share

§

impl UnwindSafe for Share

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> 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<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,