Struct SecretKeyShare

pub struct SecretKeyShare(/* private fields */);

A secret key share.

Serde integration

SecretKeyShare implements Deserialize but not Serialize to avoid accidental serialization in insecure contexts. To enable both use the ::serde_impl::SerdeSecret wrapper which implements both Deserialize and Serialize.

Implementations

impl SecretKeyShare

pub fn from_mut(fr: &mut Fr) -> Self

Creates a new SecretKeyShare from a mutable reference to a field element. This constructor takes a reference to avoid any unnecessary stack copying/moving of secrets field elements. The field element will be copied bytewise onto the heap, the resulting Box is stored in the SecretKey which is then wrapped in a SecretKeyShare.

WARNING this constructor will overwrite the pointed to Fr element with zeros once it has been copied into a new SecretKeyShare.

pub fn public_key_share(&self) -> PublicKeyShare

Returns the matching public key share.

pub fn sign_g2<H: Into<G2Affine>>(&self, hash: H) -> SignatureShare

Signs the given element of G2.

pub fn sign<M: AsRef<[u8]>>(&self, msg: M) -> SignatureShare

Signs the given message.

pub fn decrypt_share(&self, ct: &Ciphertext) -> Option<DecryptionShare>

Returns a decryption share, or None, if the ciphertext isn’t valid.

pub fn decrypt_share_no_verify(&self, ct: &Ciphertext) -> DecryptionShare

Returns a decryption share, without validating the ciphertext.

pub fn reveal(&self) -> String

Generates a non-redacted debug string. This method differs from the Debug implementation in that it does leak the secret prime field element.

pub fn derive_child(&self, index: &[u8]) -> Self

Derives a child secret key share for a given index.

pub fn to_bytes(&self) -> [u8; 32]

Serializes to big endian bytes

pub fn from_bytes(bytes: [u8; 32]) -> Result<Self>

Deserializes from big endian bytes

Trait Implementations

impl Clone for SecretKeyShare

fn clone(&self) -> SecretKeyShare

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKeyShare

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

Formats the value using the given formatter.

impl Default for SecretKeyShare

fn default() -> SecretKeyShare

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SecretKeyShare

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Distribution<SecretKeyShare> for Standard

Can be used to create a new random instance of SecretKeyShare. This is only useful for testing purposes as such a key has not been derived from a SecretKeySet.

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> SecretKeyShare

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl Ord for SecretKeyShare

fn cmp(&self, other: &SecretKeyShare) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SecretKeyShare

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

fn partial_cmp(&self, other: &SecretKeyShare) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for SecretKeyShare

impl StructuralPartialEq for SecretKeyShare