Enum SharingScheme 

#[non_exhaustive]
pub enum SharingScheme {
    RiteSssV1,
}

The secret sharing scheme a split_secret step names.

DSL vocabulary, like CertProfile: the author writes the name and the transcript records it. One scheme today. The enum exists so a second one (a prime field, a verifiable variant, codex32) is a variant rather than a flag, and so a name this build does not implement is refused at rite check.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

RiteSssV1

Shamir over GF(2^8), one polynomial per byte, the rite-sss/v1 share format.

Implementations

impl SharingScheme

pub fn as_str(self) -> &'static str

The name a ceremony writes and the transcript records.

pub fn max_shares(self) -> u8

The most shares a split under this scheme may make.

A policy limit rather than what the arithmetic allows: a share index is a byte, so rite-sss/v1 could evaluate 255 points, and 100 is a round number well past any split a room of custodians receives. Kept low on purpose, since raising it later costs nothing and lowering it would break a ceremony that ran. It also leaves the indexes SLIP-0039 reserves (254 for a digest, 255 for the secret) free for a scheme that wants them.

pub fn header_len(self) -> usize

The bytes in front of a share’s values: for rite-sss/v1, a version, a threshold and an index.

pub fn share_len(self, secret_len: usize) -> usize

The length in bytes of one share of a secret of secret_len bytes, as a sheet or a transport holds it: the header, then one byte per byte of the secret.

Trait Implementations

impl Clone for SharingScheme

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SharingScheme

impl Debug for SharingScheme

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SharingScheme

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SharingScheme

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

Formats the value using the given formatter.

impl Eq for SharingScheme

impl From<SharingScheme> for String

fn from(scheme: SharingScheme) -> Self

Converts to this type from the input type.

impl FromStr for SharingScheme

type Err = UnknownSharingScheme

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for SharingScheme

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SharingScheme

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SharingScheme

impl TryFrom<String> for SharingScheme

type Error = UnknownSharingScheme

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.