-
Notifications
You must be signed in to change notification settings - Fork 27
/
contribute.rs
395 lines (361 loc) · 12.8 KB
/
contribute.rs
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
use crate::{
io::{write_json_file, TranscriptIoError},
keys::{SharedKeys, Signature, SignatureError},
lobby::SharedLobbyState,
receipt::Receipt,
storage::{PersistentStorage, StorageError},
Engine, Options, SessionId, SharedCeremonyStatus, SharedTranscript,
};
use axum::{
response::{IntoResponse, Response},
Extension, Json,
};
use axum_extra::response::ErasedJson;
use http::StatusCode;
use kzg_ceremony_crypto::{BatchContribution, CeremoniesError, ErrorCode};
use serde::Serialize;
use std::sync::atomic::Ordering;
use strum::IntoStaticStr;
use thiserror::Error;
use tokio::task::JoinError;
use tracing::error;
#[derive(Serialize)]
pub struct ContributeReceipt {
receipt: String,
signature: Signature,
}
impl IntoResponse for ContributeReceipt {
fn into_response(self) -> Response {
(StatusCode::OK, ErasedJson::pretty(self)).into_response()
}
}
#[derive(Debug, Error, IntoStaticStr)]
pub enum ContributeError {
#[error("not your turn to participate")]
NotUsersTurn,
#[error("contribution invalid: {0}")]
InvalidContribution(#[from] CeremoniesError),
#[error("receipt signing error: {0}")]
ReceiptSigning(SignatureError),
#[error("storage error: {0}")]
StorageError(#[from] StorageError),
#[error("Transcript IO error: {0}")]
TranscriptIOError(#[from] TranscriptIoError),
#[error("background task error: {0}")]
TaskError(#[from] JoinError),
}
impl ErrorCode for ContributeError {
fn to_error_code(&self) -> String {
format!("ContributeError::{}", <&str>::from(self))
}
}
#[allow(clippy::too_many_arguments)]
pub async fn contribute(
session_id: SessionId,
Json(contribution): Json<BatchContribution>,
Extension(lobby_state): Extension<SharedLobbyState>,
Extension(options): Extension<Options>,
Extension(shared_transcript): Extension<SharedTranscript>,
Extension(storage): Extension<PersistentStorage>,
Extension(num_contributions): Extension<SharedCeremonyStatus>,
Extension(keys): Extension<SharedKeys>,
) -> Result<ContributeReceipt, ContributeError> {
// Handle the contribution in the background, so that request cancelation
// doesn't interrupt it.
let res = tokio::spawn(async move {
let id_token = lobby_state
.begin_contributing(&session_id)
.await
.map_err(|_| ContributeError::NotUsersTurn)?
.token;
let result = {
let mut transcript = shared_transcript.write().await;
transcript
.verify_add::<Engine>(contribution.clone(), id_token.identity.clone())
.map_err(ContributeError::InvalidContribution)
};
if let Err(e) = result {
lobby_state.clear_current_contributor().await;
storage
.expire_contribution(&id_token.unique_identifier())
.await?;
return Err(e);
}
let result = write_json_file(
options.transcript_file,
options.transcript_in_progress_file,
shared_transcript,
)
.await;
lobby_state.clear_current_contributor().await;
storage.finish_contribution(&session_id.0).await?;
if let Err(e) = result {
error!("failed to write transcript: {}", e);
return Err(ContributeError::TranscriptIOError(e));
}
num_contributions.fetch_add(1, Ordering::Relaxed);
let receipt = Receipt {
identity: id_token.identity,
witness: contribution.receipt(),
};
let (signed_msg, signature) = receipt
.sign(&keys)
.await
.map_err(ContributeError::ReceiptSigning)?;
Ok(ContributeReceipt {
receipt: signed_msg,
signature,
})
})
.await
.unwrap_or_else(|e| Err(ContributeError::TaskError(e)));
if let Err(err) = &res {
if matches!(
err,
ContributeError::ReceiptSigning(_)
| ContributeError::StorageError(_)
| ContributeError::TaskError(_)
) {
error!(?err, "unexpected error recording contribution");
}
}
res
}
pub async fn contribute_abort(
session_id: SessionId,
Extension(lobby_state): Extension<SharedLobbyState>,
Extension(storage): Extension<PersistentStorage>,
) -> Result<(), ContributeError> {
// Abort the contribution in the background,
// so that request cancelation doesn't interrupt it inbetween the lobby_state
// and storage calls.
tokio::spawn(async move {
lobby_state
.abort_contribution(&session_id)
.await
.map_err(|_| ContributeError::NotUsersTurn)?;
storage.expire_contribution(&session_id.0).await?;
Ok(())
})
.await
.unwrap_or_else(|e| Err(ContributeError::TaskError(e)))
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{
api::v1::{
contribute::ContributeError,
lobby::{try_contribute, TryContributeError, TryContributeResponse},
},
contribute,
io::read_json_file,
keys,
keys::SharedKeys,
lobby::SharedLobbyState,
storage::storage_client,
test_util::{create_test_session_info, test_options},
tests::{invalid_contribution, test_transcript, valid_contribution},
Keys, SessionId,
};
use axum::{Extension, Json};
use clap::Parser;
use kzg_ceremony_crypto::{signature::identity::Identity, BatchTranscript};
use std::{
sync::{atomic::AtomicUsize, Arc},
time::Duration,
};
use tokio::sync::RwLock;
fn shared_keys() -> SharedKeys {
let options = keys::Options::parse_from(Vec::<&str>::new());
Arc::new(Keys::new(&options).unwrap())
}
#[tokio::test]
async fn rejects_out_of_turn_contribution() {
let opts = test_options();
let db = storage_client(&opts.storage).await.unwrap();
let lobby_state = SharedLobbyState::new(opts.lobby.clone());
let transcript = test_transcript();
let contrbution = valid_contribution(&transcript, 1);
let result = contribute(
SessionId::new(),
Json(contrbution),
Extension(lobby_state),
Extension(opts),
Extension(Arc::new(RwLock::new(transcript))),
Extension(db),
Extension(Arc::new(AtomicUsize::new(0))),
Extension(shared_keys()),
)
.await;
assert!(matches!(result, Err(ContributeError::NotUsersTurn)));
}
#[tokio::test]
async fn rejects_invalid_contribution() {
let opts = test_options();
let db = storage_client(&opts.storage).await.unwrap();
let lobby_state = SharedLobbyState::new(opts.lobby.clone());
let participant = SessionId::new();
lobby_state
.insert_session(participant.clone(), create_test_session_info(100))
.await
.unwrap();
lobby_state.enter_lobby(&participant).await.unwrap();
lobby_state
.set_current_contributor(&participant, opts.lobby.compute_deadline, db.clone())
.await
.unwrap();
let transcript = test_transcript();
let contribution = invalid_contribution(&transcript, 1);
let result = contribute(
participant,
Json(contribution),
Extension(lobby_state),
Extension(opts),
Extension(Arc::new(RwLock::new(transcript))),
Extension(db),
Extension(Arc::new(AtomicUsize::new(0))),
Extension(shared_keys()),
)
.await;
assert!(matches!(
result,
Err(ContributeError::InvalidContribution(_))
));
}
#[tokio::test]
async fn accepts_valid_contribution() {
let cfg = test_options();
let keys = shared_keys();
let lobby_state = SharedLobbyState::new(cfg.lobby.clone());
let participant = SessionId::new();
let db = storage_client(&cfg.storage).await.unwrap();
let transcript = test_transcript();
let contribution_1 = valid_contribution(&transcript, 1);
let transcript_1 = {
let mut transcript = transcript.clone();
transcript
.verify_add::<Engine>(contribution_1.clone(), Identity::Github {
id: 1234,
username: "test_user".to_string(),
})
.unwrap();
transcript
};
let contribution_2 = valid_contribution(&transcript_1, 2);
let transcript_2 = {
let mut transcript = transcript_1.clone();
transcript
.verify_add::<Engine>(contribution_2.clone(), Identity::Github {
id: 1234,
username: "test_user".to_string(),
})
.unwrap();
transcript
};
let shared_transcript = Arc::new(RwLock::new(transcript));
lobby_state
.insert_session(participant.clone(), create_test_session_info(100))
.await
.unwrap();
lobby_state.enter_lobby(&participant).await.unwrap();
lobby_state
.set_current_contributor(&participant, cfg.lobby.compute_deadline, db.clone())
.await
.unwrap();
let result = contribute(
participant.clone(),
Json(contribution_1),
Extension(lobby_state.clone()),
Extension(cfg.clone()),
Extension(shared_transcript.clone()),
Extension(db.clone()),
Extension(Arc::new(AtomicUsize::new(0))),
Extension(keys.clone()),
)
.await;
assert!(matches!(result, Ok(_)));
let transcript = read_json_file::<BatchTranscript>(cfg.transcript_file.clone())
.await
.unwrap();
assert_eq!(transcript, transcript_1);
lobby_state
.insert_session(participant.clone(), create_test_session_info(100))
.await
.unwrap();
lobby_state.enter_lobby(&participant).await.unwrap();
lobby_state
.set_current_contributor(&participant, cfg.lobby.compute_deadline, db.clone())
.await
.unwrap();
let result = contribute(
participant.clone(),
Json(contribution_2),
Extension(lobby_state),
Extension(cfg.clone()),
Extension(shared_transcript.clone()),
Extension(db.clone()),
Extension(Arc::new(AtomicUsize::new(0))),
Extension(keys.clone()),
)
.await;
assert!(matches!(result, Ok(_)));
let transcript = read_json_file::<BatchTranscript>(cfg.transcript_file.clone())
.await
.unwrap();
assert_eq!(transcript, transcript_2);
}
#[tokio::test]
async fn aborts_contribution() {
let opts = test_options();
let lobby_state = SharedLobbyState::new(opts.lobby.clone());
let transcript = Arc::new(RwLock::new(test_transcript()));
let db = storage_client(&opts.storage).await.unwrap();
let session_id = SessionId::new();
let other_session_id = SessionId::new();
lobby_state
.insert_session(session_id.clone(), create_test_session_info(100))
.await
.unwrap();
lobby_state.enter_lobby(&session_id).await.unwrap();
lobby_state
.insert_session(other_session_id.clone(), create_test_session_info(100))
.await
.unwrap();
lobby_state.enter_lobby(&other_session_id).await.unwrap();
lobby_state
.set_current_contributor(&session_id, opts.lobby.compute_deadline, db.clone())
.await
.unwrap();
let contribution_in_progress_response = try_contribute(
other_session_id.clone(),
Extension(lobby_state.clone()),
Extension(db.clone()),
Extension(transcript.clone()),
Extension(test_options()),
)
.await;
assert!(matches!(
contribution_in_progress_response,
Err(TryContributeError::AnotherContributionInProgress)
));
contribute_abort(
session_id,
Extension(lobby_state.clone()),
Extension(db.clone()),
)
.await
.unwrap();
tokio::time::pause();
tokio::time::advance(Duration::from_secs(30)).await;
let success_response = try_contribute(
other_session_id.clone(),
Extension(lobby_state.clone()),
Extension(db.clone()),
Extension(transcript.clone()),
Extension(test_options()),
)
.await;
assert!(matches!(success_response, Ok(TryContributeResponse { .. })));
}
}