Skip to main content

GetShareRequestMessage

Struct GetShareRequestMessage 

Source
pub struct GetShareRequestMessage {
    pub secret_id: Vec<u8>,
    pub share_version: i32,
    pub timestamp: Option<Timestamp>,
}
Expand description

GetShareRequestMessage requests a previously stored share from a Helper.

§Context

This message is used during the recovery flow, after pairing has been established (typically in recovery mode). Once a Helper has indicated which secret IDs and versions it holds, the Owner sends this request to retrieve specific shares.

§Semantics

The request identifies a share by:

  • secretId: the identifier of the protected secret
  • shareVersion: the version of the share distribution

The Helper is expected to locate the corresponding share and return it in a GetShareResponseMessage.

§Authorization Rules

The Helper MUST only process this request if it is received through a valid communication channel that is authorized to access the requested share. Specifically:

  • the request MUST originate from the same secretId channel, OR
  • the request MUST originate from a channel established in recovery mode and associated with the same user

Otherwise, the Helper MUST reject the request.

§Idempotency

This request is idempotent. Repeated requests for the same (secretId, shareVersion) pair SHOULD return the same result.

Fields§

§secret_id: Vec<u8>

Identifier of the secret for which the share is requested.

This is an opaque byte array (1 to 16 bytes) generated by the Owner when the secret is created. It uniquely identifies the secret within the context of the Owner and its Helpers.

§share_version: i32

Version of the share being requested.

Each time a secret is reshared (e.g., due to updates or changes in helper set), a new version is created. This field specifies which version of the share should be returned.

§timestamp: Option<Timestamp>

Timestamp indicating when this message was created.

This value is expressed in UTC and can be used for:

  • observability and logging
  • replay detection (in combination with sequence numbers)
  • timeout handling

Trait Implementations§

Source§

impl Clone for GetShareRequestMessage

Source§

fn clone(&self) -> GetShareRequestMessage

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 GetShareRequestMessage

Source§

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

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

impl Default for GetShareRequestMessage

Source§

fn default() -> Self

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

impl Hash for GetShareRequestMessage

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 Message for GetShareRequestMessage

Source§

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.
Source§

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message to a buffer. Read more
Source§

fn encode_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message to a newly allocated buffer.
Source§

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message with a length-delimiter to a buffer. Read more
Source§

fn encode_length_delimited_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.
Source§

fn decode(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes an instance of the message from a buffer. Read more
Source§

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes a length-delimited instance of the message from the buffer.
Source§

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self. Read more
Source§

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.
Source§

impl PartialEq for GetShareRequestMessage

Source§

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

Source§

impl StructuralPartialEq for GetShareRequestMessage

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.