2025-11-04 10:20:17 -05:00
|
|
|
#![cfg_attr(docsrs, feature(doc_cfg))]
|
2025-08-18 01:24:40 -04:00
|
|
|
#![doc = include_str!("../README.md")]
|
|
|
|
|
#![no_std]
|
|
|
|
|
|
|
|
|
|
use core::ops::{Deref, DerefMut};
|
|
|
|
|
extern crate alloc;
|
|
|
|
|
use alloc::vec::Vec;
|
|
|
|
|
|
|
|
|
|
use zeroize::Zeroizing;
|
|
|
|
|
|
Smash the singular `Ciphersuite` trait into multiple
This helps identify where the various functionalities are used, or rather, not
used. The `Ciphersuite` trait present in `patches/ciphersuite`, facilitating
the entire FCMP++ tree, only requires the markers _and_ canonical point
decoding. I've opened a PR to upstream such a trait into `group`
(https://github.com/zkcrypto/group/pull/68).
`WrappedGroup` is still justified for as long as `Group::generator` exists.
Moving `::generator()` to its own trait, on an independent structure (upstream)
would be massively appreciated. @tarcieri also wanted to update from
`fn generator()` to `const GENERATOR`, which would encourage further discussion
on https://github.com/zkcrypto/group/issues/32 and
https://github.com/zkcrypto/group/issues/45, which have been stagnant.
The `Id` trait is occasionally used yet really should be first off the chopping
block.
Finally, `WithPreferredHash` is only actually used around a third of the time,
which more than justifies it being a separate trait.
---
Updates `dalek_ff_group::Scalar` to directly re-export
`curve25519_dalek::Scalar`, as without issue. `dalek_ff_group::RistrettoPoint`
also could be replaced with an export of `curve25519_dalek::RistrettoPoint`,
yet the coordinator relies on how we implemented `Hash` on it for the hell of
it so it isn't worth it at this time. `dalek_ff_group::EdwardsPoint` can't be
replaced for an re-export of `curve25519_dalek::SubgroupPoint` as it doesn't
implement `zeroize`, `subtle` traits within a released, non-yanked version.
Relevance to https://github.com/serai-dex/serai/issues/201 and
https://github.com/dalek-cryptography/curve25519-dalek/issues/811#issuecomment-3247732746.
Also updates the `Ristretto` ciphersuite to prefer `Blake2b-512` over
`SHA2-512`. In order to maintain compliance with FROST's IETF standard,
`modular-frost` defines its own ciphersuite for Ristretto which still uses
`SHA2-512`.
2025-09-03 12:25:37 -04:00
|
|
|
use ciphersuite::{GroupIo, Id};
|
2025-08-18 01:24:40 -04:00
|
|
|
|
|
|
|
|
pub use dkg::*;
|
|
|
|
|
|
|
|
|
|
/// Errors encountered when recovering a secret-shared key from a collection of
|
|
|
|
|
/// `dkg::ThresholdKeys`.
|
|
|
|
|
#[derive(Clone, PartialEq, Eq, Debug, thiserror::Error)]
|
|
|
|
|
pub enum RecoveryError {
|
|
|
|
|
/// No keys were provided.
|
|
|
|
|
#[error("no keys provided")]
|
|
|
|
|
NoKeysProvided,
|
|
|
|
|
/// Not enough keys were provided.
|
|
|
|
|
#[error("not enough keys provided (threshold required {required}, provided {provided})")]
|
|
|
|
|
NotEnoughKeysProvided { required: u16, provided: usize },
|
|
|
|
|
/// The keys had inconsistent parameters.
|
|
|
|
|
#[error("keys had inconsistent parameters")]
|
|
|
|
|
InconsistentParameters,
|
|
|
|
|
/// The keys are from distinct secret-sharing sessions or otherwise corrupt.
|
|
|
|
|
#[error("recovery failed")]
|
|
|
|
|
Failure,
|
|
|
|
|
/// An error propagated from the underlying `dkg` crate.
|
|
|
|
|
#[error("error from dkg ({0})")]
|
|
|
|
|
DkgError(DkgError),
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Recover a shared secret from a collection of `dkg::ThresholdKeys`.
|
Smash the singular `Ciphersuite` trait into multiple
This helps identify where the various functionalities are used, or rather, not
used. The `Ciphersuite` trait present in `patches/ciphersuite`, facilitating
the entire FCMP++ tree, only requires the markers _and_ canonical point
decoding. I've opened a PR to upstream such a trait into `group`
(https://github.com/zkcrypto/group/pull/68).
`WrappedGroup` is still justified for as long as `Group::generator` exists.
Moving `::generator()` to its own trait, on an independent structure (upstream)
would be massively appreciated. @tarcieri also wanted to update from
`fn generator()` to `const GENERATOR`, which would encourage further discussion
on https://github.com/zkcrypto/group/issues/32 and
https://github.com/zkcrypto/group/issues/45, which have been stagnant.
The `Id` trait is occasionally used yet really should be first off the chopping
block.
Finally, `WithPreferredHash` is only actually used around a third of the time,
which more than justifies it being a separate trait.
---
Updates `dalek_ff_group::Scalar` to directly re-export
`curve25519_dalek::Scalar`, as without issue. `dalek_ff_group::RistrettoPoint`
also could be replaced with an export of `curve25519_dalek::RistrettoPoint`,
yet the coordinator relies on how we implemented `Hash` on it for the hell of
it so it isn't worth it at this time. `dalek_ff_group::EdwardsPoint` can't be
replaced for an re-export of `curve25519_dalek::SubgroupPoint` as it doesn't
implement `zeroize`, `subtle` traits within a released, non-yanked version.
Relevance to https://github.com/serai-dex/serai/issues/201 and
https://github.com/dalek-cryptography/curve25519-dalek/issues/811#issuecomment-3247732746.
Also updates the `Ristretto` ciphersuite to prefer `Blake2b-512` over
`SHA2-512`. In order to maintain compliance with FROST's IETF standard,
`modular-frost` defines its own ciphersuite for Ristretto which still uses
`SHA2-512`.
2025-09-03 12:25:37 -04:00
|
|
|
pub fn recover_key<C: GroupIo + Id>(
|
2025-08-18 01:24:40 -04:00
|
|
|
keys: &[ThresholdKeys<C>],
|
|
|
|
|
) -> Result<Zeroizing<C::F>, RecoveryError> {
|
|
|
|
|
let included = keys.iter().map(|keys| keys.params().i()).collect::<Vec<_>>();
|
|
|
|
|
|
|
|
|
|
let keys_len = keys.len();
|
|
|
|
|
let mut keys = keys.iter();
|
|
|
|
|
let first_keys = keys.next().ok_or(RecoveryError::NoKeysProvided)?;
|
|
|
|
|
{
|
|
|
|
|
let t = first_keys.params().t();
|
|
|
|
|
if keys_len < usize::from(t) {
|
|
|
|
|
Err(RecoveryError::NotEnoughKeysProvided { required: t, provided: keys_len })?;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
{
|
|
|
|
|
let first_params = (
|
|
|
|
|
first_keys.params().t(),
|
|
|
|
|
first_keys.params().n(),
|
|
|
|
|
first_keys.group_key(),
|
|
|
|
|
first_keys.current_scalar(),
|
|
|
|
|
first_keys.current_offset(),
|
|
|
|
|
);
|
|
|
|
|
for keys in keys.clone() {
|
|
|
|
|
let params = (
|
|
|
|
|
keys.params().t(),
|
|
|
|
|
keys.params().n(),
|
|
|
|
|
keys.group_key(),
|
|
|
|
|
keys.current_scalar(),
|
|
|
|
|
keys.current_offset(),
|
|
|
|
|
);
|
|
|
|
|
if params != first_params {
|
|
|
|
|
Err(RecoveryError::InconsistentParameters)?;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let mut res: Zeroizing<_> =
|
|
|
|
|
first_keys.view(included.clone()).map_err(RecoveryError::DkgError)?.secret_share().clone();
|
|
|
|
|
for keys in keys {
|
|
|
|
|
*res.deref_mut() +=
|
|
|
|
|
keys.view(included.clone()).map_err(RecoveryError::DkgError)?.secret_share().deref();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (C::generator() * res.deref()) != first_keys.group_key() {
|
|
|
|
|
Err(RecoveryError::Failure)?;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Ok(res)
|
|
|
|
|
}
|