openmls 0.8.1

A Rust implementation of the Messaging Layer Security (MLS) protocol, as defined in RFC 9420.
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

//! ## Tree Operations
//!
//! Format:
//! ```text
//! {
//!     // Chosen by the generator
//!     "tree_before": /* hex-encoded TLS-serialized ratchet tree */,
//!     "proposal": /* hex-encoded TLS-serialized Proposal */,
//!     "proposal_sender": /* uint32 */,
//!   
//!     // Computed values
//!     "tree_after": /* hex-encoded TLS-serialized ratchet tree */,
//! }
//! ```
//!
//! The type of `proposal` is either `add`, `remove` or `update`.
//!
//! Verification:
//! * Compute `candidate_tree_after` by applying `proposal` sent by the member
//!   with index `proposal_sender` to `tree_before`.
//! * Verify that serialized `candidate_tree_after` matches the provided `tree_after`
//!   value.

use ::serde::Deserialize;
use openmls_traits::OpenMlsProvider;
use tls_codec::{Deserialize as TlsDeserializeTrait, Serialize};

use crate::{
    binary_tree::LeafNodeIndex,
    ciphersuite::{Mac, Secret},
    extensions::Extensions,
    framing::Sender,
    group::{
        proposal_store::{ProposalQueue, QueuedProposal},
        GroupContext, GroupEpoch, GroupId, PublicGroup,
    },
    messages::{proposals::Proposal, proposals_in::ProposalIn, ConfirmationTag},
    test_utils::*,
    treesync::{node::NodeIn, RatchetTree, RatchetTreeIn, TreeSync},
};

#[derive(Deserialize)]
struct TestElement {
    cipher_suite: u16,
    #[serde(with = "hex")]
    tree_before: Vec<u8>,
    #[serde(with = "hex")]
    proposal: Vec<u8>,
    proposal_sender: u32,
    #[serde(with = "hex")]
    tree_after: Vec<u8>,
    #[serde(with = "hex")]
    tree_hash_after: Vec<u8>,
    #[serde(with = "hex")]
    tree_hash_before: Vec<u8>,
}

fn run_test_vector(test: TestElement, provider: &impl OpenMlsProvider) -> Result<(), String> {
    let ciphersuite = Ciphersuite::try_from(test.cipher_suite).unwrap();

    let group_id = GroupId::random(provider.rand());

    let nodes = Vec::<Option<NodeIn>>::tls_deserialize_exact(test.tree_before).unwrap();

    let ratchet_tree = RatchetTree::from(RatchetTreeIn::from_nodes(nodes));

    let tree_before = TreeSync::from_ratchet_tree(provider.crypto(), ciphersuite, ratchet_tree)
        .map_err(|e| format!("Error while creating tree sync: {e:?}"))?;

    let tree_hash_before = tree_before.tree_hash();
    assert_eq!(test.tree_hash_before, tree_hash_before);

    let group_context = GroupContext::new(
        ciphersuite,
        group_id,
        GroupEpoch::from(0),
        vec![],
        vec![],
        Extensions::empty(),
    );
    let initial_confirmation_tag = ConfirmationTag(
        Mac::new(
            provider.crypto(),
            ciphersuite,
            &Secret::random(ciphersuite, provider.rand()).unwrap(),
            &[],
        )
        .unwrap(),
    );

    let mut group = PublicGroup::new(
        provider.crypto(),
        tree_before,
        group_context,
        initial_confirmation_tag,
    )
    .unwrap();

    let mut proposal_queue = ProposalQueue::default();

    let proposal_in = ProposalIn::tls_deserialize_exact(test.proposal).unwrap();

    let proposal = Proposal::from(proposal_in);

    let queued_proposal = QueuedProposal::from_proposal_and_sender(
        ciphersuite,
        provider.crypto(),
        proposal,
        &Sender::Member(LeafNodeIndex::new(test.proposal_sender)),
    )
    .unwrap();

    proposal_queue.add(queued_proposal);

    let mut diff = group.empty_diff();

    let apply_proposal_values = diff.apply_proposals(&proposal_queue, None).unwrap();
    diff.update_group_context(provider.crypto(), apply_proposal_values.extensions.clone())
        .unwrap();

    let staged_diff = diff
        .into_staged_diff(provider.crypto(), ciphersuite)
        .unwrap();

    group.merge_diff(staged_diff);

    let tree_after = group
        .export_ratchet_tree()
        .tls_serialize_detached()
        .unwrap();

    assert_eq!(test.tree_after, tree_after);

    let tree_hash_after = group.group_context().tree_hash();
    assert_eq!(test.tree_hash_after, tree_hash_after);

    Ok(())
}

#[openmls_test::openmls_test]
fn read_test_vectors_tree_operations() {
    let provider = &Provider::default();
    let _ = pretty_env_logger::try_init();
    log::debug!("Reading test vectors ...");

    let tests: Vec<TestElement> = read_json!("../../../../test_vectors/tree-operations.json");

    for test_vector in tests {
        match run_test_vector(test_vector, provider) {
            Ok(_) => {}
            Err(e) => panic!("Error while checking tree operations test vector.\n{e:?}"),
        }
    }
    log::trace!("Finished test vector verification");
}