de-mls 3.0.0

Decentralized MLS — end-to-end encrypted group messaging with consensus-based membership management over gossipsub-like networks
Documentation
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
//! Pure consensus result application.
//!
//! Updates a [`Conversation`]'s proposal queues in response to a consensus
//! outcome. No I/O, no service calls. Score deltas for emergency outcomes
//! are derived alongside in [`crate::core::emergency_score_ops`].
//!
//! App-layer helpers that wire consensus events to the UI and transport
//! (`submit_proposal`, `cast_vote`, `relay_incoming_proposal`,
//! `forward_incoming_vote`) live in `crate::app::consensus_bridge`.

use prost::Message;
use tracing::info;

use crate::{
    core::{Conversation, CoreError},
    protos::de_mls::messages::v1::{
        ConversationUpdateRequest, RemoveMember, StewardElectionProposal, ViolationEvidence,
        ViolationType, conversation_update_request,
    },
};

/// Outcome of applying a consensus result to a conversation. Each variant
/// encodes exactly the follow-up the app caller must perform — no
/// independent boolean flags.
///
/// Score deltas for emergency outcomes are derived separately by
/// [`crate::core::emergency_score_ops`].
#[derive(Debug, Clone)]
pub enum ConsensusApplyResult {
    /// Nothing to fire. Election rejected, non-removal emergency, regular
    /// non-removal approval, removal deduped, or any rejection.
    NoAction,
    /// Election accepted. Caller validates the proposed list against the
    /// candidate pool, installs it, and exits Reelection.
    ElectionAccepted(StewardElectionProposal),
    /// Layer-3 `Deadlock` ECP accepted. Caller switches the handle's
    /// [`crate::core::OperatingMode`] to `Recovery` (any-member commit) and
    /// bypasses the inactivity timer. Cleared on the next accepted election.
    RecoveryModeOpened,
    /// `SCORE_BELOW_THRESHOLD` ECP accepted. The urgent-commit target is
    /// already set on the conversation; caller bypasses the inactivity
    /// timer so the urgent commit fires now and refreshes the steward
    /// list if `target` was on it.
    UrgentRemoval { target: Vec<u8> },
    /// Regular `RemoveMember` accepted and queued for the next commit.
    /// Caller refreshes the steward list if `target` was on it.
    QueuedRemoval { target: Vec<u8> },
}

/// Apply a consensus result to the conversation's proposal queues.
///
/// Routes by proposal kind:
/// - **Election (accepted)** — returns [`ConsensusApplyResult::ElectionAccepted`].
/// - **`ScoreBelowThreshold` ECP (accepted)** — queues `RemoveMember(target)`
///   in the approved queue, sets the urgent-commit target, and returns
///   [`ConsensusApplyResult::UrgentRemoval`].
/// - **`Deadlock` ECP (accepted)** — returns
///   [`ConsensusApplyResult::RecoveryModeOpened`]. No approved-queue entry
///   (no MLS op to commit).
/// - **Other emergency (accepted)** — transient: briefly marked approved
///   then removed. Returns [`ConsensusApplyResult::NoAction`].
/// - **Regular `RemoveMember` (accepted)** — moved to the approved queue;
///   returns [`ConsensusApplyResult::QueuedRemoval`]. Duplicate-target
///   removals are deduped at insertion and return `NoAction`.
/// - **Other regular proposal (accepted)** — moved to the approved queue;
///   returns [`ConsensusApplyResult::NoAction`].
/// - **Rejected (any kind)** — dropped from the voting queue if we owned
///   it; returns [`ConsensusApplyResult::NoAction`].
pub fn apply_consensus_result(
    conversation: &mut Conversation,
    proposal_id: u32,
    approved: bool,
    payload: &[u8],
) -> Result<ConsensusApplyResult, CoreError> {
    let is_owner = conversation.is_owner_of_proposal(proposal_id);
    let request = ConversationUpdateRequest::decode(payload)?;
    let evidence = extract_emergency_evidence(&request).cloned();
    let is_emergency = evidence.is_some();

    if let Some(election) = extract_election_proposal(&request).cloned() {
        return Ok(apply_election_outcome(
            conversation,
            proposal_id,
            approved,
            election,
            is_owner,
        ));
    }

    // ── Emergency and regular proposals ──

    // Should the approved ECP transform into a RemoveMember?
    let transforms_to_removal =
        approved && is_emergency && evidence.as_ref().is_some_and(is_score_below_threshold);

    // Target for `approved_proposals` dedup and downstream steward-list refresh.
    let removal_target = pending_removal_target(
        &request,
        evidence.as_ref(),
        approved,
        is_emergency,
        transforms_to_removal,
    );

    // Two approvals from independent paths (self-leave + ban, ECP + ban, …)
    // can each carry `RemoveMember(target)` under different proposal ids.
    // MLS rejects a duplicate removal at commit time, so keep the first
    // entry and drop the second.
    if let Some(target) = &removal_target
        && conversation.is_pending_removal(target)
    {
        if is_owner {
            conversation.mark_proposal_as_rejected(proposal_id);
        }
        info!(
            proposal_id,
            target = ?target,
            "removal proposal deduped — target already queued for removal"
        );
        return Ok(ConsensusApplyResult::NoAction);
    }

    if approved {
        if is_owner {
            conversation.mark_proposal_as_approved(proposal_id);
            if transforms_to_removal {
                // Replace ECP with RemoveMember in approved queue (reuse proposal_id).
                let removal = removal_request_for(evidence.as_ref().unwrap());
                conversation.remove_approved_proposal(proposal_id);
                conversation.insert_approved_proposal(proposal_id, removal);
            } else if is_emergency {
                // Other emergencies don't produce MLS operations.
                conversation.remove_approved_proposal(proposal_id);
            }
        } else if transforms_to_removal {
            // Non-owner: insert RemoveMember directly (the ECP was never stored).
            let removal = removal_request_for(evidence.as_ref().unwrap());
            conversation.insert_approved_proposal(proposal_id, removal);
        } else if !is_emergency {
            // Regular proposal: add to approved queue for the next commit.
            conversation.insert_approved_proposal(proposal_id, request);
        }
    } else if is_owner {
        conversation.mark_proposal_as_rejected(proposal_id);
    }

    if let Some(ev) = evidence.as_ref() {
        if approved {
            info!(
                proposal_id,
                target = ?ev.target_member_id,
                creator = ?ev.creator_member_id,
                "emergency criteria proposal accepted"
            );
        } else {
            info!(
                proposal_id,
                creator = ?ev.creator_member_id,
                "emergency criteria proposal rejected"
            );
        }
    }

    if transforms_to_removal {
        // Fast removal: restrict the next commit to this target so it
        // doesn't drag along unrelated approved work.
        let target = evidence.as_ref().unwrap().target_member_id.clone();
        conversation.set_urgent_commit_target(target.clone());
        return Ok(ConsensusApplyResult::UrgentRemoval { target });
    }
    if evidence.as_ref().is_some_and(is_deadlock) && approved {
        // Layer 3: any member can produce the next commit.
        return Ok(ConsensusApplyResult::RecoveryModeOpened);
    }
    if let Some(target) = removal_target {
        return Ok(ConsensusApplyResult::QueuedRemoval { target });
    }
    Ok(ConsensusApplyResult::NoAction)
}

/// Election outcome — no MLS operation. YES hands the proposed list
/// back to the app for validation and install; NO drops the owner's
/// voting-queue entry.
fn apply_election_outcome(
    conversation: &mut Conversation,
    proposal_id: u32,
    approved: bool,
    election: StewardElectionProposal,
    is_owner: bool,
) -> ConsensusApplyResult {
    if approved {
        if is_owner {
            conversation.mark_proposal_as_approved(proposal_id);
            conversation.remove_approved_proposal(proposal_id);
        }
        info!(
            proposal_id,
            epoch = election.election_epoch,
            stewards = election.proposed_stewards.len(),
            "steward election proposal accepted"
        );
        ConsensusApplyResult::ElectionAccepted(election)
    } else {
        if is_owner {
            conversation.mark_proposal_as_rejected(proposal_id);
        }
        info!(proposal_id, "steward election proposal rejected");
        ConsensusApplyResult::NoAction
    }
}

/// Extract emergency evidence from a `ConversationUpdateRequest`, if present.
fn extract_emergency_evidence(req: &ConversationUpdateRequest) -> Option<&ViolationEvidence> {
    match &req.payload {
        Some(conversation_update_request::Payload::EmergencyCriteria(ec)) => ec.evidence.as_ref(),
        _ => None,
    }
}

/// Extract a steward election proposal from a `ConversationUpdateRequest`, if present.
fn extract_election_proposal(req: &ConversationUpdateRequest) -> Option<&StewardElectionProposal> {
    match &req.payload {
        Some(conversation_update_request::Payload::StewardElection(se)) => Some(se),
        _ => None,
    }
}

/// Check whether evidence is a `SCORE_BELOW_THRESHOLD` violation.
fn is_score_below_threshold(evidence: &ViolationEvidence) -> bool {
    ViolationType::try_from(evidence.violation_type) == Ok(ViolationType::ScoreBelowThreshold)
}

/// Check whether evidence is the `DEADLOCK` (Layer 3 anti-deadlock) signal.
fn is_deadlock(evidence: &ViolationEvidence) -> bool {
    ViolationType::try_from(evidence.violation_type) == Ok(ViolationType::Deadlock)
}

/// Build a `RemoveMember` `ConversationUpdateRequest` for the target in score-below-threshold evidence.
fn removal_request_for(evidence: &ViolationEvidence) -> ConversationUpdateRequest {
    ConversationUpdateRequest {
        payload: Some(conversation_update_request::Payload::RemoveMember(
            RemoveMember {
                identity: evidence.target_member_id.clone(),
            },
        )),
    }
}

/// Identity this approval would queue for removal in `approved_proposals`,
/// if any. Covers a direct `RemoveMember` request and a score-below-threshold
/// ECP that transforms into one. Returns `None` for elections, non-removal
/// emergencies, non-removal regular proposals, and rejections.
fn pending_removal_target(
    request: &ConversationUpdateRequest,
    evidence: Option<&ViolationEvidence>,
    approved: bool,
    is_emergency: bool,
    transforms_to_removal: bool,
) -> Option<Vec<u8>> {
    if !approved {
        return None;
    }
    if transforms_to_removal {
        return evidence.map(|ev| ev.target_member_id.clone());
    }
    if is_emergency {
        return None;
    }
    match request.payload.as_ref() {
        Some(conversation_update_request::Payload::RemoveMember(r)) => Some(r.identity.clone()),
        _ => None,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::core::steward_list::{StewardList, StewardListConfig};
    use crate::protos::de_mls::messages::v1::{
        ConversationUpdateRequest, StewardElectionProposal, conversation_update_request,
    };
    use prost::Message;

    fn member(id: u8) -> Vec<u8> {
        vec![id; 20]
    }

    fn members(ids: &[u8]) -> Vec<Vec<u8>> {
        ids.iter().map(|&id| member(id)).collect()
    }

    fn election_request(stewards: Vec<Vec<u8>>, epoch: u64) -> ConversationUpdateRequest {
        ConversationUpdateRequest {
            payload: Some(conversation_update_request::Payload::StewardElection(
                StewardElectionProposal {
                    proposed_stewards: stewards,
                    election_epoch: epoch,
                    retry_round: 0,
                },
            )),
        }
    }

    /// YES on an election the local node owns returns the accepted proposal
    /// and doesn't leave the proposal in the approved queue.
    #[test]
    fn election_yes_owner_returns_outcome_and_clears_queue() {
        let config = StewardListConfig::new(2, 5).unwrap();
        let mut conversation = Conversation::new("test-conversation");
        let mems = members(&[1, 2, 3, 4, 5]);
        let sn = mems.len().min(config.sn_max);
        let list = StewardList::generate(10, b"test-conversation", &mems, sn, config, 0).unwrap();
        let request = election_request(list.members().to_vec(), 10);

        let proposal_id = 42;
        conversation.store_voting_proposal(proposal_id, request.clone());

        let result = apply_consensus_result(
            &mut conversation,
            proposal_id,
            true,
            &request.encode_to_vec(),
        )
        .unwrap();

        let ConsensusApplyResult::ElectionAccepted(outcome) = result else {
            panic!("expected ElectionAccepted, got {result:?}");
        };
        assert_eq!(outcome.election_epoch, 10);
        assert_eq!(outcome.proposed_stewards.len(), 5);
        assert_eq!(conversation.approved_proposals_count(), 0);
    }

    /// NO on an election returns NoAction and leaves the approved queue empty.
    #[test]
    fn election_no_returns_no_action() {
        let mut conversation = Conversation::new("test-conversation");
        let request = election_request(vec![member(1), member(2)], 10);

        let proposal_id = 43;
        conversation.store_voting_proposal(proposal_id, request.clone());

        let result = apply_consensus_result(
            &mut conversation,
            proposal_id,
            false,
            &request.encode_to_vec(),
        )
        .unwrap();

        assert!(matches!(result, ConsensusApplyResult::NoAction));
        assert_eq!(conversation.approved_proposals_count(), 0);
    }

    /// YES on an election the local node *doesn't* own still returns the outcome
    /// (non-owner path), and doesn't touch any proposal queues.
    #[test]
    fn election_yes_nonowner_returns_outcome_without_queue_side_effects() {
        let mut conversation = Conversation::new("test-conversation");
        let request = election_request(vec![member(1), member(2), member(3)], 5);

        let proposal_id = 44;
        let result = apply_consensus_result(
            &mut conversation,
            proposal_id,
            true,
            &request.encode_to_vec(),
        )
        .unwrap();

        let ConsensusApplyResult::ElectionAccepted(outcome) = result else {
            panic!("expected ElectionAccepted, got {result:?}");
        };
        assert_eq!(outcome.election_epoch, 5);
        assert_eq!(outcome.proposed_stewards.len(), 3);
        assert_eq!(conversation.approved_proposals_count(), 0);
    }

    fn remove_request(target: Vec<u8>) -> ConversationUpdateRequest {
        ConversationUpdateRequest {
            payload: Some(conversation_update_request::Payload::RemoveMember(
                RemoveMember { identity: target },
            )),
        }
    }

    /// A second `RemoveMember(target)` arriving via consensus is dropped
    /// when an entry for the same target is already in `approved_proposals`.
    #[test]
    fn removal_deduped_when_target_already_pending() {
        let mut conversation = Conversation::new("test-conversation");
        let target = member(7);

        // First removal — non-owner path inserts straight into approved.
        let first_id = 10;
        let request = remove_request(target.clone());
        let first_result =
            apply_consensus_result(&mut conversation, first_id, true, &request.encode_to_vec())
                .unwrap();
        assert!(matches!(
            first_result,
            ConsensusApplyResult::QueuedRemoval { .. }
        ));
        assert_eq!(conversation.approved_proposals_count(), 1);

        // Second removal for the same target arrives under a different id.
        let second_id = 11;
        let request = remove_request(target.clone());
        let result =
            apply_consensus_result(&mut conversation, second_id, true, &request.encode_to_vec())
                .unwrap();

        assert!(matches!(result, ConsensusApplyResult::NoAction));
        assert_eq!(
            conversation.approved_proposals_count(),
            1,
            "duplicate removal must not stack a second entry"
        );
        assert!(conversation.approved_proposals().contains_key(&first_id));
        assert!(!conversation.approved_proposals().contains_key(&second_id));
    }

    /// Owner-side dedup: the duplicate clears its voting-queue entry so the
    /// queue does not retain an outcome we deliberately discarded.
    #[test]
    fn removal_dedup_clears_owner_voting_entry() {
        let mut conversation = Conversation::new("test-conversation");
        let target = member(7);

        // Pre-existing approved removal from an unrelated path.
        let pending_id = 20;
        let pending = remove_request(target.clone());
        conversation.insert_approved_proposal(pending_id, pending);

        // This user submits their own removal and it passes consensus.
        let owner_id = 21;
        let owner_request = remove_request(target.clone());
        conversation.store_voting_proposal(owner_id, owner_request.clone());

        let result = apply_consensus_result(
            &mut conversation,
            owner_id,
            true,
            &owner_request.encode_to_vec(),
        )
        .unwrap();

        assert!(matches!(result, ConsensusApplyResult::NoAction));
        assert_eq!(conversation.approved_proposals_count(), 1);
        assert!(conversation.approved_proposals().contains_key(&pending_id));
        assert!(
            !conversation.is_owner_of_proposal(owner_id),
            "duplicate must be cleared from voting queue"
        );
    }

    fn score_below_threshold_request(
        target: Vec<u8>,
        creator: Vec<u8>,
    ) -> ConversationUpdateRequest {
        ViolationEvidence::score_below_threshold(target, 0, -10)
            .with_creator(creator)
            .into_update_request()
            .unwrap()
    }

    #[test]
    fn ecp_score_below_threshold_yes_returns_urgent_removal() {
        let mut conversation = Conversation::new("urgent-yes");
        let target = member(7);

        let request = score_below_threshold_request(target.clone(), member(1));
        let payload = request.encode_to_vec();

        let result = apply_consensus_result(&mut conversation, 100, true, &payload).unwrap();

        let ConsensusApplyResult::UrgentRemoval { target: out_target } = result else {
            panic!("expected UrgentRemoval, got {result:?}");
        };
        assert_eq!(out_target, target);
        assert_eq!(
            conversation.urgent_commit_target(),
            Some(target.as_slice()),
            "urgent-commit target must be set on the conversation"
        );
        assert_eq!(
            conversation.approved_proposals_count(),
            1,
            "RemoveMember queued"
        );
    }

    #[test]
    fn ecp_score_below_threshold_no_does_not_mark_urgent() {
        let mut conversation = Conversation::new("urgent-no");
        let request = score_below_threshold_request(member(7), member(1));
        let payload = request.encode_to_vec();

        let result = apply_consensus_result(&mut conversation, 101, false, &payload).unwrap();

        assert!(matches!(result, ConsensusApplyResult::NoAction));
        assert!(conversation.urgent_commit_target().is_none());
        assert_eq!(conversation.approved_proposals_count(), 0);
    }

    fn deadlock_request(creator: Vec<u8>) -> ConversationUpdateRequest {
        ViolationEvidence::deadlock(0)
            .with_creator(creator)
            .into_update_request()
            .unwrap()
    }

    #[test]
    fn ecp_deadlock_yes_returns_recovery_mode_opened() {
        let mut conversation = Conversation::new("deadlock-yes");

        let request = deadlock_request(member(1));
        let payload = request.encode_to_vec();
        let result = apply_consensus_result(&mut conversation, 200, true, &payload).unwrap();

        assert!(matches!(result, ConsensusApplyResult::RecoveryModeOpened));
        assert_eq!(
            conversation.approved_proposals_count(),
            0,
            "Deadlock has no specific target — no RemoveMember queued"
        );
        assert!(conversation.urgent_commit_target().is_none());
    }

    #[test]
    fn ecp_deadlock_no_returns_no_action() {
        let mut conversation = Conversation::new("deadlock-no");

        let request = deadlock_request(member(1));
        let payload = request.encode_to_vec();
        let result = apply_consensus_result(&mut conversation, 201, false, &payload).unwrap();

        assert!(matches!(result, ConsensusApplyResult::NoAction));
    }

    /// A regular (non-emergency) `RemoveMember` reached via consensus YES
    /// enqueues into `approved_proposals` and produces no score ops.
    #[test]
    fn regular_remove_member_enqueues_without_score_ops() {
        let mut conversation = Conversation::new("regular-yes");
        let target = member(7);

        let request = remove_request(target.clone());
        let payload = request.encode_to_vec();

        let proposal_id = 70;
        conversation.store_voting_proposal(proposal_id, request);

        apply_consensus_result(&mut conversation, proposal_id, true, &payload).unwrap();

        assert!(crate::core::emergency_score_ops(&payload, true).is_empty());
        assert_eq!(conversation.approved_proposals_count(), 1);
    }

    /// `apply_consensus_result` returns an error when the payload bytes
    /// do not decode as a `ConversationUpdateRequest`.
    #[test]
    fn invalid_payload_returns_error() {
        let mut conversation = Conversation::new("invalid-payload");
        let result = apply_consensus_result(&mut conversation, 999, true, &[0xFF, 0xFF]);
        assert!(result.is_err());
    }

    /// A non-score emergency (e.g. `BrokenCommit`) approved by consensus
    /// is consumed without queuing a `RemoveMember` — only score-below-
    /// threshold ECPs transform into a removal.
    #[test]
    fn regular_emergency_yes_does_not_queue_remove_member() {
        let mut conversation = Conversation::new("no-transform");
        let creator = member(1);
        let target = member(7);

        let request = ViolationEvidence::broken_commit(target, 0, Vec::<u8>::new())
            .with_creator(creator)
            .into_update_request()
            .unwrap();
        let payload = request.encode_to_vec();

        let proposal_id = 300;
        conversation.store_voting_proposal(proposal_id, request);

        apply_consensus_result(&mut conversation, proposal_id, true, &payload).unwrap();

        assert_eq!(
            conversation.approved_proposals_count(),
            0,
            "regular emergencies are consumed, not transformed to RemoveMember"
        );
    }
}