Struct SecretShare

pub struct SecretShare<C: Ciphersuite> { /* private fields */ }

A secret share generated by performing a (t-out-of-n) secret sharing scheme, generated by a dealer performing generate_with_dealer.

n is the total number of shares and t is the threshold required to reconstruct the secret; in this case we use Shamir’s secret sharing.

As a solution to the secret polynomial f (a ‘point’), the identifier is the x-coordinate, and the value is the y-coordinate.

To derive a FROST keypair, the receiver of the SecretShare must call .into(), which under the hood also performs validation.

Implementations

impl<C: Ciphersuite> SecretShare<C>

Auto-generated by derive_getters::Getters.

pub fn identifier(&self) -> &Identifier<C>

The participant identifier of this SecretShare.

pub fn signing_share(&self) -> &SigningShare<C>

Secret Key.

pub fn commitment(&self) -> &VerifiableSecretSharingCommitment<C>

The commitments to be distributed among signers.

impl<C> SecretShare<C>

where C: Ciphersuite,

pub fn new( identifier: Identifier<C>, signing_share: SigningShare<C>, commitment: VerifiableSecretSharingCommitment<C>, ) -> Self

Create a new SecretShare instance.

pub fn verify(&self) -> Result<(VerifyingShare<C>, VerifyingKey<C>), Error<C>>

Verifies that a secret share is consistent with a verifiable secret sharing commitment, and returns the derived group info for the participant (their public verification share, and the group public key) if successful.

This ensures that this participant’s share has been generated using the same mechanism as all other signing participants. Note that participants MUST ensure that they have the same view as all other participants of the commitment!

An implementation of vss_verify() from the spec. This also implements derive_group_info() from the spec (which is very similar), but only for this participant.

impl<C> SecretShare<C>

where C: Ciphersuite,

pub fn serialize(&self) -> Result<Vec<u8>, Error<C>>

Available on crate feature serialization only.

Serialize the struct into a Vec.

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

Available on crate feature serialization only.

Deserialize the struct from a slice of bytes.

Trait Implementations

impl<C: Clone + Ciphersuite> Clone for SecretShare<C>

fn clone(&self) -> SecretShare<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + Ciphersuite> Debug for SecretShare<C>

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

Formats the value using the given formatter.

impl<'de, C> Deserialize<'de> for SecretShare<C>

where C: Ciphersuite,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C: PartialEq + Ciphersuite> PartialEq for SecretShare<C>

fn eq(&self, other: &SecretShare<C>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<C> Serialize for SecretShare<C>

where C: Ciphersuite,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C> TryFrom<SecretShare<C>> for KeyPackage<C>

where C: Ciphersuite,

fn try_from(secret_share: SecretShare<C>) -> Result<Self, Error<C>>

Tries to verify a share and construct a KeyPackage from it.

When participants receive a SecretShare from the dealer, they MUST verify the integrity of the share before continuing on to transform it into a signing/verification keypair. Here, we assume that every participant has the same view of the commitment issued by the dealer, but implementations MUST make sure that all participants have a consistent view of this commitment in practice.

type Error = Error<C>

The type returned in the event of a conversion error.

impl<C: Ciphersuite> Zeroize for SecretShare<C>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<C: Eq + Ciphersuite> Eq for SecretShare<C>

impl<C: Ciphersuite> StructuralPartialEq for SecretShare<C>