mls-spec 2.0.0

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

use crate::ToPrefixedLabel;

/// Labels for MLS DSA signature/verification.
///
/// <https://www.rfc-editor.org/rfc/rfc9420.html#section-5.1.2-4>
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Hash, strum::IntoStaticStr, strum::EnumString, strum::Display,
)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[repr(u8)]
pub enum SignatureLabel {
    FramedContentTBS,
    LeafNodeTBS,
    KeyPackageTBS,
    GroupInfoTBS,
    #[cfg(feature = "draft-ietf-mls-targeted-messages")]
    TargetedMessagesTBS,
    #[cfg(feature = "draft-ietf-mls-extensions")]
    CredentialBindingTBS,
    #[cfg(feature = "draft-kohbrok-mls-associated-parties")]
    AssociatedPartyEntryTBS,
    #[cfg(feature = "draft-mahy-mls-private-external")]
    ExternalEncryptionInfoTBS,
    #[cfg(feature = "draft-kohbrok-mls-leaf-operation-intents")]
    LeafOperationIntentTBS,
    #[cfg(feature = "test-vectors")]
    #[strum(serialize = "SignWithLabel")]
    TestVectorSignWithLabel,
}

impl ToPrefixedLabel for SignatureLabel {}

/// Labels for MLS HPKE contexts.
///
/// <https://www.rfc-editor.org/rfc/rfc9420.html#section-5.1.3-2>
#[derive(
    Debug,
    Clone,
    PartialEq,
    Eq,
    Hash,
    strum::IntoStaticStr,
    strum::EnumString,
    strum::Display,
    strum::AsRefStr,
)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[repr(u8)]
pub enum PublicKeyEncryptionLabel {
    UpdatePathNode,
    Welcome,
    #[cfg(feature = "draft-mahy-mls-semiprivatemessage")]
    SemiPrivateMessageReceiver,
    #[cfg(feature = "draft-mahy-mls-private-external")]
    PrivateExternalMessageContent,
    #[cfg(feature = "draft-ietf-mls-targeted-messages")]
    TargetedMessageData,
    #[cfg(feature = "test-vectors")]
    #[strum(serialize = "EncryptWithLabel")]
    TestVectorEncryptWithLabel,
}

impl ToPrefixedLabel for PublicKeyEncryptionLabel {}

/// Labels for MLS `HashReference`s, such as `KeyPackageRef`s or `ProposalRef`s
///
/// <https://www.rfc-editor.org/rfc/rfc9420.html#section-5.2>
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Hash, strum::IntoStaticStr, strum::EnumString, strum::Display,
)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[repr(u8)]
pub enum HashReferenceKind {
    #[strum(serialize = "KeyPackage Reference")]
    KeyPackageRef,
    #[strum(serialize = "Proposal Reference")]
    ProposalRef,
    #[cfg(feature = "draft-kohbrok-mls-leaf-operation-intents")]
    #[strum(serialize = "LeafNode Reference")]
    LeafNodeRef,
    #[cfg(feature = "test-vectors")]
    #[strum(serialize = "RefHash")]
    TestVectorRefHash,
}

impl ToPrefixedLabel for HashReferenceKind {}

/// Labels for MLS KDF derivations (i.e. domain separation)
///
/// <https://www.rfc-editor.org/rfc/rfc9420.html#section-8-13>
#[derive(
    Debug,
    Clone,
    PartialEq,
    Eq,
    Hash,
    strum::IntoStaticStr,
    strum::EnumString,
    strum::Display,
    strum::AsRefStr,
)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[repr(u8)]
#[strum(serialize_all = "lowercase")]
pub enum KdfLabelKind {
    Joiner,
    Welcome,
    Epoch,
    Init,
    #[strum(serialize = "sender data")]
    SenderData,
    Encryption,
    Exported,
    Exporter,
    External,
    Confirm,
    Membership,
    Resumption,
    Authentication,
    Application,
    Handshake,
    #[cfg(feature = "draft-mahy-mls-new-content-types")]
    Status,
    #[cfg(feature = "draft-mahy-mls-new-content-types")]
    Ephemeral,
    Tree,
    Nonce,
    Key,
    Secret,
    Path,
    Node,
    #[strum(serialize = "derived psk")]
    DerivedPsk,
    #[cfg(feature = "draft-ietf-mls-targeted-messages")]
    #[strum(serialize = "targeted message psk")]
    TargetedMessagePsk,
    #[cfg(feature = "draft-ietf-mls-targeted-messages")]
    #[strum(serialize = "targeted message sender auth data")]
    TargetedMessageSenderAuthData,
    #[cfg(feature = "draft-kohbrok-mls-associated-parties")]
    #[strum(serialize = "ap_epoch")]
    AssociatedPartyKeyScheduleEpochSecret,
    #[cfg(feature = "draft-kohbrok-mls-associated-parties")]
    #[strum(serialize = "ap_exporter")]
    AssociatedPartyKeyScheduleExporterSecret,
    #[cfg(feature = "draft-kohbrok-mls-associated-parties")]
    #[strum(serialize = "AP Secret")]
    AssociatedPartyEpochSecret,
    #[cfg(feature = "draft-kohbrok-mls-associated-parties")]
    #[strum(serialize = "AP Exporter Secret")]
    AssociatedPartySecret,
    #[cfg(feature = "draft-kohbrok-mls-associated-parties")]
    #[strum(serialize = "AP Commit Secret")]
    AssociatedPartyCommitSecret,
    #[cfg(feature = "draft-kohbrok-mls-associated-parties")]
    #[strum(serialize = "AP Commit Secret ID")]
    AssociatedPartyCommitSecretId,
    #[cfg(feature = "draft-kohbrok-mls-associated-parties")]
    #[strum(serialize = "AP Commit Base Secret")]
    AssociatedPartyCommitBaseSecret,
    #[cfg(feature = "draft-ietf-mls-extensions")]
    #[strum(serialize = "application_export")]
    ApplicationExportSecret,
    #[cfg(feature = "draft-mahy-mls-private-external")]
    #[strum(serialize = "external encryption")]
    ExternalEncryption,
    #[cfg(feature = "test-vectors")]
    #[strum(serialize = "DeriveTreeSecret")]
    TestVectorDeriveTreeSecret,
    #[cfg(feature = "test-vectors")]
    #[strum(serialize = "DeriveSecret")]
    TestVectorDeriveSecret,
    #[cfg(feature = "test-vectors")]
    #[strum(serialize = "ExpandWithLabel")]
    TestVectorExpandWithLabel,
    #[strum(serialize = "{0}")]
    Arbitrary(String),
}

impl ToPrefixedLabel for KdfLabelKind {
    fn to_prefixed_string(&self, protocol_version: crate::defs::ProtocolVersion) -> String {
        format!("{protocol_version} {self}")
    }
}