Skip to main content

ShareEnvelope

Struct ShareEnvelope 

Source
pub struct ShareEnvelope {
    pub version: u8,
    pub scheme: String,
    pub quorum_id: String,
    pub party_idx: u32,
    pub threshold: u32,
    pub party_count: u32,
    pub share_data: Vec<u8>,
    pub integrity_tag: [u8; 32],
}
Expand description

A versioned, integrity-protected threshold share envelope.

Fields§

§version: u8

Envelope format version (currently 1).

§scheme: String

Threshold scheme (e.g., “CMP20”, “FROST-P256”, “GG18”).

§quorum_id: String

Quorum identifier this share belongs to.

§party_idx: u32

Party index (1-based, per DKG convention).

§threshold: u32

Threshold T.

§party_count: u32

Total party count N.

§share_data: Vec<u8>

Scheme-specific share bytes (opaque to the envelope).

§integrity_tag: [u8; 32]

HMAC-SHA256 of all the above fields (keyed with the master key).

Implementations§

Source§

impl ShareEnvelope

Create a new share envelope wrapping scheme-specific share bytes. The integrity tag is computed as HMAC-SHA256 over the envelope fields using integrity_key as the HMAC key.

Source

pub fn wrap( scheme: &str, quorum_id: &str, party_idx: u32, threshold: u32, party_count: u32, share_data: Vec<u8>, integrity_key: &[u8], ) -> Result<Self, EnvelopeError>

Wrap scheme-specific share bytes into a versioned envelope.

Source

pub fn verify(&self, integrity_key: &[u8]) -> Result<(), EnvelopeError>

Verify the integrity tag matches the envelope contents. Uses constant-time comparison to prevent timing side-channels.

Source

pub fn unwrap(&self, integrity_key: &[u8]) -> Result<Vec<u8>, EnvelopeError>

Extract the share data (after verifying integrity).

Source

pub fn to_bytes(&self) -> Result<Vec<u8>, EnvelopeError>

Serialize to JSON bytes.

Source

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

Deserialize from JSON bytes.

Trait Implementations§

Source§

impl Clone for ShareEnvelope

Source§

fn clone(&self) -> ShareEnvelope

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 ShareEnvelope

Source§

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

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

impl<'de> Deserialize<'de> for ShareEnvelope

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 Serialize for ShareEnvelope

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

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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.