1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
//! Services for handling JSON-RPC requests.
//!
//! Some methods send notifications to connected clients, see the
//! method's documentation for more details.
//!
//! Notifications sent to connected clients are sent as a tuple
//! of `String` event name followed by an arbitrary JSON `Value`
//! payload for the event.
//!
//! ## Methods
//!
//! These are the JSON-RPC methods clients may call; some methods will broadcast events to connected clients, see the documentation for each method for more information.
//!
//! ### Group.create
//!
//! * `label`: Human-friendly `String` label for the group.
//! * `parameters`: [Parameters](Parameters) for key generation and signing.
//!
//! Create a new group; the client that sends this method automatically joins the group.
//!
//! Returns the UUID for the group.
//!
//! ### Group.join
//!
//! * `group_id`: The `String` UUID for the group.
//!
//! Register the calling client as a member of the group.
//!
//! Returns the group object.
//!
//! ### Session.create
//! * `group_id`: The `String` UUID for the group.
//! * `kind`: The `String` kind of session (either `keygen` or `sign`).
//!
//! Create a new session.
//!
//! Returns the session object.
//!
//! ### Session.join
//!
//! * `group_id`: The `String` UUID for the group.
//! * `session_id`: The `String` UUID for the session.
//! * `kind`: The `String` kind of session (either `keygen` or `sign`).
//!
//! Join an existing session.
//!
//! Returns the session object.
//!
//! ### Session.signup
//!
//! * `group_id`: The `String` UUID for the group.
//! * `session_id`: The `String` UUID for the session.
//! * `kind`: The `String` kind of session (either `keygen` or `sign`).
//!
//! Register as a co-operating party for a session.
//!
//! When the required number of parties have signed up to a session a `sessionSignup` event is emitted to all the clients in the session. For key generation there must be `parties` clients in the session and for signing there must be `threshold + 1` clients registered for the session.
//!
//! Returns the party signup number.
//!
//! ### Session.load
//!
//! * `group_id`: The `String` UUID for the group.
//! * `session_id`: The `String` UUID for the session.
//! * `kind`: The `String` kind of session (must be `keygen`).
//! * `number`: The `u16` party signup number.
//!
//! Load a client into a given slot (party signup number). This is used to allow the party signup numbers allocated to saved key shares to be assigned and validated in the context of a session.
//!
//! The given `number` must be in range and must be an available slot.
//!
//! When the required number of `parties` have been allocated to a session a `sessionLoad` event is emitted to all the clients in the session.
//!
//! Returns the party signup number.
//!
//! ### Session.message
//!
//! * `group_id`: The `String` UUID for the group.
//! * `session_id`: The `String` UUID for the session.
//! * `kind`: The `String` kind of session (either `keygen` or `sign`).
//! * `message`: The message to broadcast or send peer to peer.
//!
//! Relay a message to all the other peers in the session (broadcast) or send directly to another peer.
//!
//! A `message` is treated as peer to peer when the `receiver` field is present which should be the party signup `number` for the peer.
//!
//! This method is a notification and does not return anything to the caller.
//!
//! ### Session.finish
//!
//! * `group_id`: The `String` UUID for the group.
//! * `session_id`: The `String` UUID for the session.
//! * `number`: The `u16` party signup number.
//!
//! Indicate the session has been finished for the calling client.
//!
//! When all the clients in a session have called this method the server will emit a `sessionClosed` event to all the clients in the session.
//!
//! This method is a notification and does not return anything to the caller.
//!
//! ### Notify.proposal
//!
//! * `group_id`: The `String` UUID for the group.
//! * `session_id`: The `String` UUID for the session.
//! * `proposal_id`: Unique identifier for the proposal.
//! * `message`: The message to be signed.
//!
//! Sends a signing proposal to *all other clients in the group*. The event emitted is `notifyProposal` and the payload is an object with `sessionId`, `proposalId` and the `message` to be signed.
//!
//! This method is a notification and does not return anything to the caller.
//!
//! ### Notify.signed
//!
//! * `group_id`: The `String` UUID for the group.
//! * `session_id`: The `String` UUID for the session.
//! * `value`: Opaque value for the signing result sent to non-participants.
//!
//! Sends a signing result to clients in the session that *did not participate* in the signing; the event name emitted is `notifySigned` and the payload is the `value` passed to this method.
//!
//! Client implementations should ensure this method is only called once when signing is complete.
//!
//! This method is a notification and does not return anything to the caller.
//!
use async_trait::async_trait;
use json_rpc2::{futures::*, Error, Request, Response, Result, RpcError};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::collections::HashMap;
use std::sync::Arc;
use thiserror::Error;
use tokio::sync::{Mutex, RwLock};
use uuid::Uuid;
use super::server::{
Group, Notification, Parameters, Session, SessionKind, State,
};
/// Error thrown by the JSON-RPC services.
#[derive(Debug, Error)]
pub enum ServiceError {
/// Error generated when a parties parameter is too small.
#[error("parties must be greater than one")]
PartiesTooSmall,
/// Error generated when a parties parameter is too small.
#[error("threshold must be greater than zero")]
ThresholdTooSmall,
/// Error generated when the threshold exceeds the parties.
#[error("threshold must be less than parties")]
ThresholdRange,
/// Error generated when a group has enough connections.
#[error("group {0} is full, cannot accept new connections")]
GroupFull(Uuid),
/// Error generated when a group does not exist.
#[error("group {0} does not exist")]
GroupDoesNotExist(Uuid),
/// Error generated when a session does not exist.
#[error("group {0} does not exist")]
SessionDoesNotExist(Uuid),
/// Error generated when a party number does not exist.
#[error("party {0} does not exist")]
PartyDoesNotExist(u16),
/// Error generated when a party number does not belong to the caller.
#[error("party {0} is not valid in this context")]
BadParty(u16),
/// Error generated when the receiver for a peer to peer message
/// does not exist.
#[error("receiver {0} for peer to peer message does not exist")]
BadPeerReceiver(u16),
/// Error generated when a client connection does not belong to
/// the specified group.
#[error("client {0} does not belong to the group {1}")]
BadConnection(usize, Uuid),
}
/// Error data indicating the connection should be closed.
pub const CLOSE_CONNECTION: &str = "close-connection";
/// Method to create a group.
pub const GROUP_CREATE: &str = "Group.create";
/// Method to join a group.
pub const GROUP_JOIN: &str = "Group.join";
/// Method to create a session.
pub const SESSION_CREATE: &str = "Session.create";
/// Method to join a session.
pub const SESSION_JOIN: &str = "Session.join";
/// Method to signup a session.
pub const SESSION_SIGNUP: &str = "Session.signup";
/// Method to load a party number into a session.
pub const SESSION_LOAD: &str = "Session.load";
/// Method to broadcast or relay a message peer to peer.
pub const SESSION_MESSAGE: &str = "Session.message";
/// Method to indicate a session is finished.
pub const SESSION_FINISH: &str = "Session.finish";
/// Method to notify of a proposal for signing.
pub const NOTIFY_PROPOSAL: &str = "Notify.proposal";
/// Method to notify a proposal has been signed.
pub const NOTIFY_SIGNED: &str = "Notify.signed";
/// Notification sent when a session has been created.
///
/// Used primarily during key generation so other connected
/// clients can automatically join the session.
pub const SESSION_CREATE_EVENT: &str = "sessionCreate";
/// Notification sent when all expected parties have signed
/// up to a session.
pub const SESSION_SIGNUP_EVENT: &str = "sessionSignup";
/// Notification sent when all parties have loaded a party signup
/// number into a session.
pub const SESSION_LOAD_EVENT: &str = "sessionLoad";
/// Notification sent to clients with broadcast or peer to peer messages.
pub const SESSION_MESSAGE_EVENT: &str = "sessionMessage";
/// Notification sent when a session has been marked as finished
/// by all participating clients.
pub const SESSION_CLOSED_EVENT: &str = "sessionClosed";
/// Notification sent when a proposal has been received.
pub const NOTIFY_PROPOSAL_EVENT: &str = "notifyProposal";
/// Notification sent when a proposal has been signed.
pub const NOTIFY_SIGNED_EVENT: &str = "notifySigned";
type GroupCreateParams = (String, Parameters);
type SessionCreateParams = (Uuid, SessionKind, Option<Value>);
type SessionJoinParams = (Uuid, Uuid, SessionKind);
type SessionSignupParams = (Uuid, Uuid, SessionKind);
type SessionLoadParams = (Uuid, Uuid, SessionKind, u16);
type SessionMessageParams = (Uuid, Uuid, SessionKind, Message);
type SessionFinishParams = (Uuid, Uuid, u16);
type NotifyProposalParams = (Uuid, Uuid, String, String);
type NotifySignedParams = (Uuid, Uuid, Value);
// Mimics the `Msg` struct
// from `round-based` but doesn't care
// about the `body` data.
#[derive(Serialize, Deserialize)]
struct Message {
round: u16,
sender: u16,
receiver: Option<u16>,
uuid: String,
body: serde_json::Value,
}
#[derive(Debug, Serialize)]
struct Proposal {
#[serde(rename = "sessionId")]
session_id: Uuid,
#[serde(rename = "proposalId")]
proposal_id: String,
message: String,
}
/// Service for replying to client requests.
pub struct ServiceHandler;
#[async_trait]
impl Service for ServiceHandler {
type Data = (usize, Arc<RwLock<State>>, Arc<Mutex<Option<Notification>>>);
async fn handle(
&self,
req: &Request,
ctx: &Self::Data,
) -> Result<Option<Response>> {
let response = match req.method() {
GROUP_CREATE => {
let (conn_id, state, _) = ctx;
let params: GroupCreateParams = req.deserialize()?;
let (label, parameters) = params;
// If parties is less than two then may as well
// use a standard single-party ECDSA private key
if parameters.parties <= 1 {
return Err(Error::from(Box::from(
ServiceError::PartiesTooSmall,
)));
// If threshold is zero then it only
// takes a single party to sign a request which
// defeats the point of MPC
} else if parameters.threshold == 0 {
return Err(Error::from(Box::from(
ServiceError::ThresholdTooSmall,
)));
// Threshold must be in range `(t + 1) <= n`
} else if parameters.threshold >= parameters.parties {
return Err(Error::from(Box::from(
ServiceError::ThresholdRange,
)));
}
let group =
Group::new(*conn_id, parameters.clone(), label.clone());
let res = serde_json::to_value(&group.uuid).unwrap();
let mut writer = state.write().await;
writer.groups.insert(group.uuid.clone(), group);
Some((req, res).into())
}
GROUP_JOIN => {
let (conn_id, state, _) = ctx;
let group_id: Uuid = req.deserialize()?;
let mut writer = state.write().await;
if let Some(group) = writer.groups.get_mut(&group_id) {
if group.clients.len() == group.params.parties as usize {
let error = ServiceError::GroupFull(group_id);
let err = RpcError::new(
error.to_string(),
Some(CLOSE_CONNECTION.to_string()),
);
Some((req, err).into())
} else {
if let None =
group.clients.iter().find(|c| *c == conn_id)
{
group.clients.push(*conn_id);
}
let res = serde_json::to_value(group).unwrap();
Some((req, res).into())
}
} else {
return Err(Error::from(Box::from(
ServiceError::GroupDoesNotExist(group_id),
)));
}
}
SESSION_CREATE => {
let (conn_id, state, notification) = ctx;
let params: SessionCreateParams = req.deserialize()?;
let (group_id, kind, value) = params;
let mut writer = state.write().await;
let group =
get_group_mut(&conn_id, &group_id, &mut writer.groups)?;
let session = Session::from((kind.clone(), value));
let key = session.uuid.clone();
group.sessions.insert(key, session.clone());
if let SessionKind::Keygen = kind {
let value =
serde_json::to_value((SESSION_CREATE_EVENT, &session))
.unwrap();
let response: Response = value.into();
// Notify everyone else in the group a session was created
let ctx = Notification::Group {
group_id,
filter: Some(vec![*conn_id]),
response,
};
let mut writer = notification.lock().await;
*writer = Some(ctx);
}
let res = serde_json::to_value(&session).unwrap();
Some((req, res).into())
}
SESSION_JOIN => {
let (conn_id, state, _) = ctx;
let params: SessionJoinParams = req.deserialize()?;
let (group_id, session_id, _kind) = params;
let mut writer = state.write().await;
let group =
get_group_mut(&conn_id, &group_id, &mut writer.groups)?;
if let Some(session) = group.sessions.get_mut(&session_id) {
let res = serde_json::to_value(&session).unwrap();
Some((req, res).into())
} else {
return Err(Error::from(Box::from(
ServiceError::SessionDoesNotExist(session_id),
)));
}
}
SESSION_SIGNUP => {
let (conn_id, state, notification) = ctx;
let params: SessionSignupParams = req.deserialize()?;
let (group_id, session_id, kind) = params;
let mut writer = state.write().await;
let group =
get_group_mut(&conn_id, &group_id, &mut writer.groups)?;
if let Some(session) = group.sessions.get_mut(&session_id) {
let party_number = session.signup(*conn_id);
tracing::info!(party_number, "session signup {}", conn_id);
// Enough parties are signed up to the session
if threshold(
&kind,
&group.params,
session.party_signups.len(),
) {
let value = serde_json::to_value((
SESSION_SIGNUP_EVENT,
&session_id,
))
.unwrap();
let response: Response = value.into();
let ctx = Notification::Session {
group_id,
session_id,
filter: None,
response,
};
let mut writer = notification.lock().await;
*writer = Some(ctx);
}
let res = serde_json::to_value(&party_number).unwrap();
Some((req, res).into())
} else {
return Err(Error::from(Box::from(
ServiceError::SessionDoesNotExist(session_id),
)));
}
}
// Load an existing party signup into the session
// this is used to support loading existing key shares.
SESSION_LOAD => {
let (conn_id, state, notification) = ctx;
let params: SessionLoadParams = req.deserialize()?;
let (group_id, session_id, kind, party_number) = params;
let mut writer = state.write().await;
let group =
get_group_mut(&conn_id, &group_id, &mut writer.groups)?;
if let Some(session) = group.sessions.get_mut(&session_id) {
let res = serde_json::to_value(&party_number).unwrap();
match session.load(&group.params, *conn_id, party_number) {
Ok(_) => {
// Enough parties are loaded into the session
if threshold(
&kind,
&group.params,
session.party_signups.len(),
) {
let value = serde_json::to_value((
SESSION_LOAD_EVENT,
&session_id,
))
.unwrap();
let response: Response = value.into();
let ctx = Notification::Session {
group_id,
session_id,
filter: None,
response,
};
let mut writer = notification.lock().await;
*writer = Some(ctx);
}
Some((req, res).into())
}
Err(err) => return Err(Error::from(Box::from(err))),
}
} else {
return Err(Error::from(Box::from(
ServiceError::SessionDoesNotExist(session_id),
)));
}
}
// Mark the session as finished for a party.
SESSION_FINISH => {
let (conn_id, state, notification) = ctx;
let params: SessionFinishParams = req.deserialize()?;
let (group_id, session_id, party_number) = params;
let mut writer = state.write().await;
let group =
get_group_mut(&conn_id, &group_id, &mut writer.groups)?;
if let Some(session) = group.sessions.get_mut(&session_id) {
let existing_signup = session
.party_signups
.iter()
.find(|(s, _)| s == &party_number);
if let Some((_, conn)) = existing_signup {
// The party number must belong to the caller
// which we check by comparing connection identifiers
if conn != conn_id {
return Err(Error::from(Box::from(
ServiceError::BadParty(party_number),
)));
}
session.finished.insert(party_number);
let mut signups = session
.party_signups
.iter()
.map(|(n, _)| n.clone())
.collect::<Vec<u16>>();
let mut completed = session
.finished
.iter()
.cloned()
.collect::<Vec<u16>>();
signups.sort();
completed.sort();
if signups == completed {
let value = serde_json::to_value((
SESSION_CLOSED_EVENT,
completed,
))
.unwrap();
let response: Response = value.into();
let ctx = Notification::Session {
group_id,
session_id,
filter: None,
response,
};
let mut writer = notification.lock().await;
*writer = Some(ctx);
}
Some(req.into())
} else {
return Err(Error::from(Box::from(
ServiceError::PartyDoesNotExist(party_number),
)));
}
} else {
return Err(Error::from(Box::from(
ServiceError::SessionDoesNotExist(session_id),
)));
}
}
SESSION_MESSAGE => {
let (conn_id, state, notification) = ctx;
let params: SessionMessageParams = req.deserialize()?;
let (group_id, session_id, _kind, msg) = params;
let reader = state.read().await;
// Check we have valid group / session
let (_group, session) = get_group_session(
&conn_id,
&group_id,
&session_id,
&reader.groups,
)?;
// Send direct to peer
if let Some(receiver) = &msg.receiver {
if let Some(s) =
session.party_signups.iter().find(|s| s.0 == *receiver)
{
let value =
serde_json::to_value((SESSION_MESSAGE_EVENT, msg))
.unwrap();
let response: Response = value.into();
let message = (s.1, response);
let ctx = Notification::Relay {
messages: vec![message],
};
let mut writer = notification.lock().await;
*writer = Some(ctx);
} else {
return Err(Error::from(Box::from(
ServiceError::BadPeerReceiver(*receiver),
)));
}
// Handle broadcast round
} else {
let value =
serde_json::to_value((SESSION_MESSAGE_EVENT, msg))
.unwrap();
let response: Response = value.clone().into();
let ctx = Notification::Session {
group_id,
session_id,
filter: Some(vec![*conn_id]),
response,
};
let mut writer = notification.lock().await;
*writer = Some(ctx);
}
// Must ACK so we indicate the service method exists
Some(req.into())
}
NOTIFY_PROPOSAL => {
let (conn_id, _state, notification) = ctx;
let params: NotifyProposalParams = req.deserialize()?;
let (group_id, session_id, proposal_id, message) = params;
let proposal = Proposal {
session_id,
proposal_id,
message,
};
let value =
serde_json::to_value((NOTIFY_PROPOSAL_EVENT, &proposal))
.unwrap();
let response: Response = value.into();
let ctx = Notification::Group {
group_id,
filter: Some(vec![*conn_id]),
response,
};
let mut writer = notification.lock().await;
*writer = Some(ctx);
// Must ACK so we indicate the service method exists
Some(req.into())
}
NOTIFY_SIGNED => {
let (conn_id, state, notification) = ctx;
let params: NotifySignedParams = req.deserialize()?;
let (group_id, session_id, value) = params;
let reader = state.read().await;
let (_group, session) = get_group_session(
&conn_id,
&group_id,
&session_id,
&reader.groups,
)?;
let participants = session
.party_signups
.iter()
.map(|(_, c)| c.clone())
.collect::<Vec<usize>>();
let value =
serde_json::to_value((NOTIFY_SIGNED_EVENT, value)).unwrap();
let response: Response = value.into();
let ctx = Notification::Group {
group_id,
filter: Some(participants),
response,
};
let mut writer = notification.lock().await;
*writer = Some(ctx);
// Must ACK so we indicate the service method exists
Some(req.into())
}
_ => None,
};
Ok(response)
}
}
fn get_group_mut<'a>(
conn_id: &usize,
group_id: &Uuid,
groups: &'a mut HashMap<Uuid, Group>,
) -> Result<&'a mut Group> {
if let Some(group) = groups.get_mut(group_id) {
// Verify connection is part of the group clients
if let Some(_) = group.clients.iter().find(|c| *c == conn_id) {
Ok(group)
} else {
return Err(Error::from(Box::from(ServiceError::BadConnection(
*conn_id,
group_id.clone(),
))));
}
} else {
return Err(Error::from(Box::from(ServiceError::GroupDoesNotExist(
group_id.clone(),
))));
}
}
fn get_group<'a>(
conn_id: &usize,
group_id: &Uuid,
groups: &'a HashMap<Uuid, Group>,
) -> Result<&'a Group> {
if let Some(group) = groups.get(group_id) {
// Verify connection is part of the group clients
if let Some(_) = group.clients.iter().find(|c| *c == conn_id) {
Ok(group)
} else {
return Err(Error::from(Box::from(ServiceError::BadConnection(
*conn_id,
group_id.clone(),
))));
}
} else {
return Err(Error::from(Box::from(ServiceError::GroupDoesNotExist(
group_id.clone(),
))));
}
}
fn get_group_session<'a>(
conn_id: &usize,
group_id: &Uuid,
session_id: &Uuid,
groups: &'a HashMap<Uuid, Group>,
) -> Result<(&'a Group, &'a Session)> {
let group = get_group(conn_id, group_id, groups)?;
if let Some(session) = group.sessions.get(session_id) {
Ok((group, session))
} else {
return Err(Error::from(Box::from(ServiceError::SessionDoesNotExist(
session_id.clone(),
))));
}
}
/// Helper to determine if we met a session party threshold.
fn threshold(
kind: &SessionKind,
params: &Parameters,
num_entries: usize,
) -> bool {
let parties = params.parties as usize;
let threshold = params.threshold as usize;
let required_num_entries = match kind {
SessionKind::Keygen => parties,
SessionKind::Sign => threshold + 1,
};
num_entries == required_num_entries
}