use core::fmt::{self, Debug}; use std::{io::Read, sync::Arc, collections::HashMap}; use thiserror::Error; use zeroize::Zeroize; use group::{ ff::{Field, PrimeField}, GroupEncoding, }; mod schnorr; pub mod curve; use curve::Curve; pub mod key_gen; pub mod promote; pub mod algorithm; pub mod sign; pub mod tests; // Validate a map of serialized values to have the expected included participants pub(crate) fn validate_map( map: &HashMap, included: &[u16], ours: u16, ) -> Result<(), FrostError> { if (map.len() + 1) != included.len() { Err(FrostError::InvalidParticipantQuantity(included.len(), map.len() + 1))?; } for included in included { if *included == ours { if map.contains_key(included) { Err(FrostError::DuplicatedIndex(*included))?; } continue; } if !map.contains_key(included) { Err(FrostError::MissingParticipant(*included))?; } } Ok(()) } /// Parameters for a multisig // These fields can not be made public as they should be static #[derive(Clone, Copy, PartialEq, Eq, Debug)] pub struct FrostParams { /// Participants needed to sign on behalf of the group t: u16, /// Amount of participants n: u16, /// Index of the participant being acted for i: u16, } impl FrostParams { pub fn new(t: u16, n: u16, i: u16) -> Result { if (t == 0) || (n == 0) { Err(FrostError::ZeroParameter(t, n))?; } // When t == n, this shouldn't be used (MuSig2 and other variants of MuSig exist for a reason), // but it's not invalid to do so if t > n { Err(FrostError::InvalidRequiredQuantity(t, n))?; } if (i == 0) || (i > n) { Err(FrostError::InvalidParticipantIndex(n, i))?; } Ok(FrostParams { t, n, i }) } pub fn t(&self) -> u16 { self.t } pub fn n(&self) -> u16 { self.n } pub fn i(&self) -> u16 { self.i } } #[derive(Copy, Clone, Error, Debug)] pub enum FrostError { #[error("a parameter was 0 (required {0}, participants {1})")] ZeroParameter(u16, u16), #[error("too many participants (max {1}, got {0})")] TooManyParticipants(usize, u16), #[error("invalid amount of required participants (max {1}, got {0})")] InvalidRequiredQuantity(u16, u16), #[error("invalid participant index (0 < index <= {0}, yet index is {1})")] InvalidParticipantIndex(u16, u16), #[error("invalid signing set ({0})")] InvalidSigningSet(&'static str), #[error("invalid participant quantity (expected {0}, got {1})")] InvalidParticipantQuantity(usize, usize), #[error("duplicated participant index ({0})")] DuplicatedIndex(u16), #[error("missing participant {0}")] MissingParticipant(u16), #[error("invalid commitment (participant {0})")] InvalidCommitment(u16), #[error("invalid proof of knowledge (participant {0})")] InvalidProofOfKnowledge(u16), #[error("invalid share (participant {0})")] InvalidShare(u16), #[error("internal error ({0})")] InternalError(&'static str), } /// Calculate the lagrange coefficient for a signing set pub fn lagrange(i: u16, included: &[u16]) -> F { let mut num = F::one(); let mut denom = F::one(); for l in included { if i == *l { continue; } let share = F::from(u64::try_from(*l).unwrap()); num *= share; denom *= share - F::from(u64::try_from(i).unwrap()); } // Safe as this will only be 0 if we're part of the above loop // (which we have an if case to avoid) num * denom.invert().unwrap() } /// Core keys generated by performing a FROST keygen protocol #[derive(Clone, PartialEq, Eq, Zeroize)] pub struct FrostCore { /// FROST Parameters #[zeroize(skip)] params: FrostParams, /// Secret share key secret_share: C::F, /// Group key group_key: C::G, /// Verification shares #[zeroize(skip)] verification_shares: HashMap, } impl Drop for FrostCore { fn drop(&mut self) { self.zeroize() } } impl Debug for FrostCore { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_struct("FrostCore") .field("params", &self.params) .field("group_key", &self.group_key) .field("verification_shares", &self.verification_shares) .finish() } } impl FrostCore { pub(crate) fn new( params: FrostParams, secret_share: C::F, verification_shares: HashMap, ) -> FrostCore { #[cfg(debug_assertions)] validate_map(&verification_shares, &(0 ..= params.n).collect::>(), 0).unwrap(); let t = (1 ..= params.t).collect::>(); FrostCore { params, secret_share, group_key: t.iter().map(|i| verification_shares[i] * lagrange::(*i, &t)).sum(), verification_shares, } } pub fn params(&self) -> FrostParams { self.params } pub(crate) fn secret_share(&self) -> C::F { self.secret_share } pub fn group_key(&self) -> C::G { self.group_key } pub(crate) fn verification_shares(&self) -> HashMap { self.verification_shares.clone() } pub fn serialized_len(n: u16) -> usize { 8 + C::ID.len() + (3 * 2) + C::F_len() + C::G_len() + (usize::from(n) * C::G_len()) } pub fn serialize(&self) -> Vec { let mut serialized = Vec::with_capacity(FrostCore::::serialized_len(self.params.n)); serialized.extend(u32::try_from(C::ID.len()).unwrap().to_be_bytes()); serialized.extend(C::ID); serialized.extend(&self.params.t.to_be_bytes()); serialized.extend(&self.params.n.to_be_bytes()); serialized.extend(&self.params.i.to_be_bytes()); serialized.extend(self.secret_share.to_repr().as_ref()); for l in 1 ..= self.params.n { serialized.extend(self.verification_shares[&l].to_bytes().as_ref()); } serialized } pub fn deserialize(cursor: &mut R) -> Result, FrostError> { { let missing = FrostError::InternalError("FrostCore serialization is missing its curve"); let different = FrostError::InternalError("deserializing FrostCore for another curve"); let mut id_len = [0; 4]; cursor.read_exact(&mut id_len).map_err(|_| missing)?; if u32::try_from(C::ID.len()).unwrap().to_be_bytes() != id_len { Err(different)?; } let mut id = vec![0; C::ID.len()]; cursor.read_exact(&mut id).map_err(|_| missing)?; if id != C::ID { Err(different)?; } } let (t, n, i) = { let mut read_u16 = || { let mut value = [0; 2]; cursor .read_exact(&mut value) .map_err(|_| FrostError::InternalError("missing participant quantities"))?; Ok(u16::from_be_bytes(value)) }; (read_u16()?, read_u16()?, read_u16()?) }; let secret_share = C::read_F(cursor).map_err(|_| FrostError::InternalError("invalid secret share"))?; let mut verification_shares = HashMap::new(); for l in 1 ..= n { verification_shares.insert( l, C::read_G(cursor).map_err(|_| FrostError::InternalError("invalid verification share"))?, ); } Ok(FrostCore::new( FrostParams::new(t, n, i).map_err(|_| FrostError::InternalError("invalid parameters"))?, secret_share, verification_shares, )) } } /// FROST keys usable for signing #[derive(Clone, Debug, Zeroize)] pub struct FrostKeys { /// Core keys #[zeroize(skip)] core: Arc>, /// Offset applied to these keys pub(crate) offset: Option, } // Manually implement Drop due to https://github.com/RustCrypto/utils/issues/786 impl Drop for FrostKeys { fn drop(&mut self) { self.zeroize() } } // View of keys passable to algorithm implementations #[derive(Clone, Zeroize)] pub struct FrostView { group_key: C::G, #[zeroize(skip)] included: Vec, secret_share: C::F, #[zeroize(skip)] verification_shares: HashMap, } impl Drop for FrostView { fn drop(&mut self) { self.zeroize() } } impl FrostKeys { pub fn new(core: FrostCore) -> FrostKeys { FrostKeys { core: Arc::new(core), offset: None } } /// Offset the keys by a given scalar to allow for account and privacy schemes /// This offset is ephemeral and will not be included when these keys are serialized /// Keys offset multiple times will form a new offset of their sum /// Not IETF compliant pub fn offset(&self, offset: C::F) -> FrostKeys { let mut res = self.clone(); // Carry any existing offset // Enables schemes like Monero's subaddresses which have a per-subaddress offset and then a // one-time-key offset res.offset = Some(offset + res.offset.unwrap_or_else(C::F::zero)); res } pub fn params(&self) -> FrostParams { self.core.params } pub(crate) fn secret_share(&self) -> C::F { self.core.secret_share } /// Returns the group key with any offset applied pub fn group_key(&self) -> C::G { self.core.group_key + (C::generator() * self.offset.unwrap_or_else(C::F::zero)) } /// Returns all participants' verification shares without any offsetting pub(crate) fn verification_shares(&self) -> HashMap { self.core.verification_shares() } pub fn serialized_len(n: u16) -> usize { FrostCore::::serialized_len(n) } pub fn serialize(&self) -> Vec { self.core.serialize() } pub fn view(&self, included: &[u16]) -> Result, FrostError> { if (included.len() < self.params().t.into()) || (usize::from(self.params().n) < included.len()) { Err(FrostError::InvalidSigningSet("invalid amount of participants included"))?; } let offset_share = self.offset.unwrap_or_else(C::F::zero) * C::F::from(included.len().try_into().unwrap()).invert().unwrap(); let offset_verification_share = C::generator() * offset_share; Ok(FrostView { group_key: self.group_key(), secret_share: (self.secret_share() * lagrange::(self.params().i, included)) + offset_share, verification_shares: self .verification_shares() .iter() .map(|(l, share)| { (*l, (*share * lagrange::(*l, included)) + offset_verification_share) }) .collect(), included: included.to_vec(), }) } } impl FrostView { pub fn group_key(&self) -> C::G { self.group_key } pub fn included(&self) -> Vec { self.included.clone() } pub fn secret_share(&self) -> C::F { self.secret_share } pub fn verification_share(&self, l: u16) -> C::G { self.verification_shares[&l] } }