Struct KeyPackage

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

A FROST keypair, which can be generated either by a trusted dealer or using a DKG.

When using a central dealer, SecretShares are distributed to participants, who then perform verification, before deriving KeyPackages, which they store to later use during signing.

Implementations

impl<C: Ciphersuite> KeyPackage<C>

Auto-generated by derive_getters::Getters.

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

Denotes the participant identifier each secret share key package is owned by.

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

This participant’s signing share. This is secret.

pub fn verifying_share(&self) -> &VerifyingShare<C>

This participant’s public key.

pub fn verifying_key(&self) -> &VerifyingKey<C>

The public verifying key that represents the entire group.

pub fn min_signers(&self) -> &u16

Get field min_signers from instance of KeyPackage.

impl<C> KeyPackage<C>

where C: Ciphersuite,

pub fn new( identifier: Identifier<C>, signing_share: SigningShare<C>, verifying_share: VerifyingShare<C>, verifying_key: VerifyingKey<C>, min_signers: u16, ) -> Self

Create a new KeyPackage instance.

impl<C> KeyPackage<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 KeyPackage<C>

fn clone(&self) -> KeyPackage<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 KeyPackage<C>

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

Formats the value using the given formatter.

impl<'de, C> Deserialize<'de> for KeyPackage<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 KeyPackage<C>

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

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