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
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

use crate::macros::impl_spec_enum;

pub mod labels;

pub type LeafIndex = u32;
pub type SenderIndex = u32;
pub type Generation = u32;
pub type Epoch = u64;

pub const MLS_MIME_TYPE: &str = "message/mls";

/// MLS GREASE values to check implementation robustness
///
/// <https://www.rfc-editor.org/rfc/rfc9420.html#section-13.5>
pub const GREASE_VALUES: [u16; 15] = [
    0x0A0A, 0x1A1A, 0x2A2A, 0x3A3A, 0x4A4A, 0x5A5A, 0x6A6A, 0x7A7A, 0x8A8A, 0x9A9A, 0xAAAA, 0xBABA,
    0xCACA, 0xDADA, 0xEAEA,
];

#[derive(
    Debug,
    Clone,
    Copy,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Hash,
    Default,
    tls_codec::TlsSerialize,
    tls_codec::TlsDeserialize,
    tls_codec::TlsSize,
    strum::IntoStaticStr,
    strum::Display,
    strum::EnumString,
)]
#[cfg_attr(
    feature = "serde",
    derive(serde_repr::Serialize_repr, serde_repr::Deserialize_repr)
)]
#[repr(u16)]
#[non_exhaustive]
pub enum ProtocolVersion {
    Reserved = 0x0000,
    #[strum(serialize = "MLS 1.0")]
    #[default]
    Mls10 = 0x0001,
}

impl ProtocolVersion {
    #[must_use]
    pub fn all_without_spec_default() -> Vec<Self> {
        vec![Self::Mls10]
    }
}

impl_spec_enum! {
    CiphersuiteId(u16);
    serde_repr "u16";
    reserved_priv 0xF000..=0xFFFF => crate::MlsSpecError::InvalidPrivateRangeCiphersuite;
    default_range None;
    SPEC_RESERVED = 0x0000,
    MLS_128_DHKEMX25519_AES128GCM_SHA256_ED25519 = 0x0001,
    MLS_128_DHKEMP256_AES128GCM_SHA256_P256 = 0x0002,
    MLS_128_DHKEMX25519_CHACHA20POLY1305_SHA256_ED25519 = 0x0003,
    MLS_256_DHKEMX448_AES256GCM_SHA512_ED448 = 0x0004,
    MLS_256_DHKEMP521_AES256GCM_SHA512_P521 = 0x0005,
    MLS_256_DHKEMX448_CHACHA20POLY1305_SHA512_ED448 = 0x0006,
    MLS_256_DHKEMP384_AES256GCM_SHA384_P384 = 0x0007
}

impl Default for CiphersuiteId {
    fn default() -> Self {
        Self(Self::MLS_128_DHKEMX25519_AES128GCM_SHA256_ED25519)
    }
}

impl_spec_enum! {
    ExtensionType(u16);
    serde_repr "u16";
    reserved_priv 0xF000..=0xFFFF => crate::MlsSpecError::InvalidPrivateRangeExtensionType;
    default_range Some(0x0001..=0x0005);
    SPEC_RESERVED = 0x0000,
    APPLICATION_ID = 0x0001,
    RATCHET_TREE = 0x0002,
    REQUIRED_CAPABILITIES = 0x0003,
    EXTERNAL_PUB = 0x0004,
    EXTERNAL_SENDERS = 0x0005,
    #[cfg(feature = "draft-ietf-mls-extensions")]
    APPLICATION_DATA_DICTIONARY = crate::drafts::mls_extensions::EXTENSION_APP_DATA_DICT,
    #[cfg(feature = "draft-ietf-mls-extensions")]
    SUPPORTED_WIRE_FORMATS = crate::drafts::mls_extensions::EXTENSION_SUPPORTED_WIRE_FORMATS,
    #[cfg(feature = "draft-ietf-mls-extensions")]
    REQUIRED_WIRE_FORMATS = crate::drafts::mls_extensions::EXTENSION_REQUIRED_WIRE_FORMATS,
    #[cfg(feature = "draft-mahy-mls-ratchet-tree-options")]
    RATCHET_TREE_SOURCE_DOMAINS = crate::drafts::ratchet_tree_options::EXTENSION_RATCHET_TREE_SOURCE_DOMAINS,
    #[cfg(feature = "draft-mahy-mls-new-content-types")]
    SUPPORTED_CONTENT_TYPES = crate::drafts::new_content_types::EXTENSION_SUPPORTED_CONTENT_TYPES,
    #[cfg(feature = "draft-mahy-mls-new-content-types")]
    REQUIRED_CONTENT_TYPES = crate::drafts::new_content_types::EXTENSION_REQUIRED_CONTENT_TYPES
}

impl Default for ExtensionType {
    fn default() -> Self {
        Self(Self::SPEC_RESERVED)
    }
}

impl_spec_enum! {
    ProposalType(u16);
    serde_repr "u16";
    reserved_priv 0xF000..=0xFFFF => crate::MlsSpecError::InvalidPrivateRangeProposalType;
    default_range Some(0x0001..=0x0007);
    SPEC_RESERVED = 0x0000,
    ADD = 0x0001,
    UPDATE = 0x0002,
    REMOVE = 0x0003,
    PSK = 0x0004,
    REINIT = 0x0005,
    EXTERNAL_INIT = 0x0006,
    GROUP_CONTEXT_EXTENSIONS = 0x0007,
    #[cfg(feature = "draft-ietf-mls-extensions")]
    APP_DATA_UPDATE = crate::drafts::mls_extensions::PROPOSAL_APP_DATA_UPDATE,
    #[cfg(feature = "draft-ietf-mls-extensions")]
    APP_EPHEMERAL = crate::drafts::mls_extensions::PROPOSAL_APP_EPHEMERAL,
    #[cfg(feature = "draft-ietf-mls-extensions")]
    SELF_REMOVE = crate::drafts::mls_extensions::PROPOSAL_SELF_REMOVE
}

impl ProposalType {
    #[inline]
    pub fn is_allowed_in_external_proposals(&self) -> bool {
        #[allow(unused_mut)]
        let mut allowed = matches!(
            self.0,
            Self::ADD | Self::REMOVE | Self::PSK | Self::REINIT | Self::GROUP_CONTEXT_EXTENSIONS
        );

        #[cfg(feature = "draft-ietf-mls-extensions")]
        {
            allowed |= matches!(self.0, Self::APP_DATA_UPDATE | Self::APP_EPHEMERAL);
        }

        allowed
    }

    #[inline]
    pub fn needs_update_path(&self) -> bool {
        #[allow(unused_mut)]
        let mut needs_update_path = matches!(
            self.0,
            Self::UPDATE | Self::REMOVE | Self::EXTERNAL_INIT | Self::GROUP_CONTEXT_EXTENSIONS
        );

        #[cfg(feature = "draft-ietf-mls-extensions")]
        {
            needs_update_path |= matches!(self.0, Self::SELF_REMOVE);
        }

        needs_update_path
    }
}

impl_spec_enum! {
    CredentialType(u16);
    serde_repr "u16";
    reserved_priv 0xF000..=0xFFFF => crate::MlsSpecError::InvalidPrivateRangeCredentialType;
    default_range None;
    SPEC_RESERVED = 0x0000,
    BASIC = 0x0001,
    X509 = 0x0002,
    #[cfg(feature = "draft-ietf-mls-extensions")]
    MULTI_CREDENTIAL = crate::drafts::mls_extensions::multi_credentials::MULTI_CREDENTIAL,
    #[cfg(feature = "draft-ietf-mls-extensions")]
    WEAK_MULTI_CREDENTIAL= crate::drafts::mls_extensions::multi_credentials::WEAK_MULTI_CREDENTIAL,
    #[cfg(feature = "draft-mahy-mls-sd-cwt-credential")]
    SD_CWT_CREDENTIAL = crate::drafts::sd_cwt_credential::CREDENTIAL_SD_CWT,
    #[cfg(feature = "draft-mahy-mls-sd-cwt-credential")]
    SD_JWT_CREDENTIAL = crate::drafts::sd_cwt_credential::CREDENTIAL_SD_JWT
}

impl Default for CredentialType {
    fn default() -> Self {
        Self(Self::BASIC)
    }
}

impl_spec_enum! {
    WireFormat(u16);
    serde_repr "u16";
    reserved_priv 0xF000..=0xFFFF => crate::MlsSpecError::InvalidPrivateRangeWireFormat;
    default_range None;
    SPEC_RESERVED = 0x0000,
    MLS_PUBLIC_MESSAGE = 0x0001,
    MLS_PRIVATE_MESSAGE = 0x0002,
    MLS_WELCOME = 0x0003,
    MLS_GROUP_INFO = 0x0004,
    MLS_KEY_PACKAGE = 0x0005,
    #[cfg(feature = "draft-ietf-mls-targeted-messages")]
    MLS_TARGETED_MESSAGE = crate::drafts::targeted_messages::WIRE_FORMAT_MLS_TARGETED_MESSAGE,
    #[cfg(feature = "draft-mahy-mls-semiprivatemessage")]
    MLS_SEMIPRIVATE_MESSAGE = crate::drafts::semiprivate_message::WIRE_FORMAT_MLS_SEMIPRIVATE_MESSAGE,
    #[cfg(feature = "draft-mularczyk-mls-splitcommit")]
    MLS_SPLIT_COMMIT = crate::drafts::split_commit::WIRE_FORMAT_MLS_SPLIT_COMMIT,
    #[cfg(feature = "draft-pham-mls-additional-wire-formats")]
    MLS_MESSAGE_WITHOUT_AAD = crate::drafts::additional_wire_formats::WIRE_FORMAT_MLS_MESSAGE_WITHOUT_AAD,
    #[cfg(feature = "draft-mahy-mls-private-external")]
    MLS_PRIVATE_EXTERNAL_MESSAGE = crate::drafts::private_external::WIRE_FORMAT_MLS_PRIVATE_EXTERNAL_MESSAGE,
    #[cfg(feature = "draft-kohbrok-mls-leaf-operation-intents")]
    MLS_LEAF_OPERATION_INTENT = crate::drafts::leaf_operation_intents::WIRE_FORMAT_MLS_LEAF_OPERATION_INTENT
}

#[derive(
    Debug,
    Clone,
    PartialEq,
    Eq,
    Hash,
    tls_codec::TlsSerialize,
    tls_codec::TlsDeserialize,
    tls_codec::TlsSize,
)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Capabilities {
    pub versions: Vec<ProtocolVersion>,
    pub ciphersuites: Vec<CiphersuiteId>,
    pub extensions: Vec<ExtensionType>,
    pub proposals: Vec<ProposalType>,
    pub credentials: Vec<CredentialType>,
}