mls-spec 3.0.0-pre.1

This crate is a repository of MLS / RFC9420-related data structures.
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

use crate::{
    SensitiveBytes, defs::LeafIndex, group::welcome::Welcome, messages::MlsMessage, tree::TreeNode,
};

///
/// ```notrust,ignore
/// struct {
///     opaque hash_value;
/// } CopathHash;
/// ```
///
#[derive(Debug, Clone, PartialEq, Eq, Default, thalassa::TlsplAll)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct CopathHash<'a> {
    pub hash_value: SensitiveBytes<'a>,
}

///
/// ```notrust,ignore
/// struct {
///   uint32 leaf_index;
///   uint32 n_leaves;
///   optional<Node> direct_path_nodes<V>;
///   CopathHash copath_hashes<V>;
/// } MembershipProof;
/// ```
///
#[derive(Debug, Clone, PartialEq, Eq, Default, thalassa::TlsplAll)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct MembershipProof<'a> {
    pub leaf_index: LeafIndex,
    pub n_leaves: u32,
    pub direct_path_nodes: Vec<Option<TreeNode<'a>>>,
    pub copath_hashes: Vec<CopathHash<'a>>,
}

///
/// ```notrust,ignore
/// struct {
///     T message;
///     MembershipProof sender_membership_proof;
/// } SenderAuthenticatedMessage<T>;
/// ```
///
#[derive(Debug, Clone, PartialEq, Eq, thalassa::TlsplAll)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct SenderAuthenticatedMessage<'a, T> {
    pub message: T,
    pub sender_membership_proof: MembershipProof<'a>,
}

///
/// ```notrust,ignore
/// struct {
///     SenderAuthenticated<Welcome> welcome;
///     MembershipProof joiner_membership_proof;
/// } AnnotatedWelcome;
/// ```
///
#[derive(Debug, Clone, PartialEq, Eq, thalassa::TlsplAll)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct AnnotatedWelcome<'a> {
    pub welcome: SenderAuthenticatedMessage<'a, Welcome<'a>>,
    pub joiner_membership_proof: MembershipProof<'a>,
}

///
/// ```notrust,ignore
/// struct {
///     MLSMessage commit;
///     optional<MembershipProof> sender_membership_proof;
///
///     opaque tree_hash_after<V>;
///     optional<uint32> resolution_index;
///
///     MembershipProof sender_membership_proof_after;
///     MembershipProof receiver_membership_proof_after;
/// } AnnotatedCommit;
/// ```
///
#[derive(Debug, Clone, PartialEq, Eq, thalassa::TlsplAll)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct AnnotatedCommit<'a> {
    pub commit: MlsMessage<'a>,
    pub sender_membership_proof: Option<MembershipProof<'a>>,
    pub tree_hash_after: SensitiveBytes<'a>,
    pub resolution_index: Option<u32>,
    pub sender_membership_proof_after: MembershipProof<'a>,
    pub receiver_membership_proof_after: MembershipProof<'a>,
}