ferritls-rustls 0.5.0

rustls CryptoProvider adapter backed by ferritls-core (pure Rust)
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
//! 密钥交换组:`SupportedKxGroup` / `ActiveKeyExchange` 适配。
//!
//! X25519 = 非批准;secp256r1/secp384r1 = 批准(但认证前 `fips()` 恒
//! `false`,见 lib.rs“fips() 语义”)。
//!
//! 私钥由 ferritls-core 的 OS 熵直读生成(批准模式的 DRBG 路径由
//! `CryptoProvider::secure_random` 与密钥生成入口的自检守卫覆盖;
//! ECDH 私钥生成熵需求为曲线阶长,风险敞口极小)。

use rustls::crypto::{ActiveKeyExchange, CompletedKeyExchange, SharedSecret, SupportedKxGroup};
use rustls::{Error as RustlsError, NamedGroup, PeerMisbehaved};

use ferritls_core::ecdh::{p256, p384, x25519};
use ferritls_core::mlkem;

/// 把 core 的共享秘密错误映射为 rustls 的 InvalidKeyShare。
fn map_dh_err(_: ferritls_core::Error) -> RustlsError {
    RustlsError::PeerMisbehaved(PeerMisbehaved::InvalidKeyShare)
}

/// X25519(RFC 7748)密钥交换组。
#[derive(Debug)]
pub struct X25519;

/// secp256r1(NIST P-256)密钥交换组。
#[derive(Debug)]
pub struct SecP256R1;

/// secp384r1(NIST P-384)密钥交换组。
#[derive(Debug)]
pub struct SecP384R1;

impl SupportedKxGroup for X25519 {
    fn start(&self) -> Result<Box<dyn ActiveKeyExchange>, RustlsError> {
        let sk = x25519::SecretKey::generate().map_err(map_dh_err)?;
        let pk = sk.public_key();
        Ok(Box::new(ActiveX25519 { sk, pk }))
    }

    fn name(&self) -> NamedGroup {
        NamedGroup::X25519
    }

    fn fips(&self) -> bool {
        // X25519 独立使用为非批准算法;即便认证后也不会在批准模式提供。
        false
    }
}

impl SupportedKxGroup for SecP256R1 {
    fn start(&self) -> Result<Box<dyn ActiveKeyExchange>, RustlsError> {
        let sk = p256::SecretKey::generate().map_err(map_dh_err)?;
        let pk = sk.public_key();
        Ok(Box::new(ActiveSecP256R1 { sk, pk }))
    }

    fn name(&self) -> NamedGroup {
        NamedGroup::secp256r1
    }

    fn fips(&self) -> bool {
        // 认证(阶段 C)落地前恒 false。
        false
    }
}

impl SupportedKxGroup for SecP384R1 {
    fn start(&self) -> Result<Box<dyn ActiveKeyExchange>, RustlsError> {
        let sk = p384::SecretKey::generate().map_err(map_dh_err)?;
        let pk = sk.public_key();
        Ok(Box::new(ActiveSecP384R1 { sk, pk }))
    }

    fn name(&self) -> NamedGroup {
        NamedGroup::secp384r1
    }

    fn fips(&self) -> bool {
        false
    }
}

/// 进行中的 X25519 密钥交换。
pub(crate) struct ActiveX25519 {
    sk: x25519::SecretKey,
    pk: [u8; 32],
}

/// 进行中的 P-256 密钥交换。
pub(crate) struct ActiveSecP256R1 {
    sk: p256::SecretKey,
    pk: [u8; p256::PUBLIC_KEY_LEN],
}

/// 进行中的 P-384 密钥交换。
pub(crate) struct ActiveSecP384R1 {
    sk: p384::SecretKey,
    pk: [u8; p384::PUBLIC_KEY_LEN],
}

impl std::fmt::Debug for ActiveX25519 {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str("ActiveX25519")
    }
}

impl std::fmt::Debug for ActiveSecP256R1 {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str("ActiveSecP256R1")
    }
}

impl std::fmt::Debug for ActiveSecP384R1 {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str("ActiveSecP384R1")
    }
}

impl ActiveKeyExchange for ActiveX25519 {
    fn complete(self: Box<Self>, peer_pub_key: &[u8]) -> Result<SharedSecret, RustlsError> {
        let ss = self.sk.diffie_hellman(peer_pub_key).map_err(map_dh_err)?;
        Ok(SharedSecret::from(ss.as_bytes().to_vec()))
    }

    fn pub_key(&self) -> &[u8] {
        &self.pk
    }

    fn group(&self) -> NamedGroup {
        NamedGroup::X25519
    }
}

impl ActiveKeyExchange for ActiveSecP256R1 {
    fn complete(self: Box<Self>, peer_pub_key: &[u8]) -> Result<SharedSecret, RustlsError> {
        let ss = self.sk.diffie_hellman(peer_pub_key).map_err(map_dh_err)?;
        Ok(SharedSecret::from(ss.as_bytes().to_vec()))
    }

    fn pub_key(&self) -> &[u8] {
        &self.pk
    }

    fn group(&self) -> NamedGroup {
        NamedGroup::secp256r1
    }
}

impl ActiveKeyExchange for ActiveSecP384R1 {
    fn complete(self: Box<Self>, peer_pub_key: &[u8]) -> Result<SharedSecret, RustlsError> {
        let ss = self.sk.diffie_hellman(peer_pub_key).map_err(map_dh_err)?;
        Ok(SharedSecret::from(ss.as_bytes().to_vec()))
    }

    fn pub_key(&self) -> &[u8] {
        &self.pk
    }

    fn group(&self) -> NamedGroup {
        NamedGroup::secp384r1
    }
}

/// X25519MLKEM768(draft-ietf-tls-ecdhe-mlkem,codepoint 0x11EC)混合
/// 密钥交换组(M8.3)。
///
/// 角色与线格式(TLS 1.3,密钥交换数据依赖 ⇒ KEM 角色**不对称**):
/// - 客户端 = ML-KEM **解封装方**:`start()` 生成 (ek, dk) + X25519
///   ephemeral,share = ek(1184)‖X25519 pk(32) = 1216 B;
/// - 服务端 = ML-KEM **封装方**:走 [`SupportedKxGroup::start_and_complete`]
///   覆写——对客户端 ek 先做 FIPS 203 §7.2 封装密钥检查再封装,
///   share = ct(1088)‖X25519 pk(32) = 1120 B;
/// - 共享秘密 = ML-KEM ss(32) ‖ X25519 ss(32) = 64 B。
///
/// X25519 独立使用为非批准算法;本混合组是其进入批准模式配置的
/// 通道(SP 800-52r2 口径)。CMVP 认证前 `fips()` 恒 `false`。
#[derive(Debug)]
pub struct X25519Mlkem768;

/// 进行中的 X25519MLKEM768 客户端侧密钥交换(持有解封装密钥)。
pub(crate) struct ActiveX25519Mlkem768 {
    dk: mlkem::Mlkem768DecapsKey,
    sk: x25519::SecretKey,
    share: Vec<u8>,
}

impl SupportedKxGroup for X25519Mlkem768 {
    fn start(&self) -> Result<Box<dyn ActiveKeyExchange>, RustlsError> {
        let (ek, dk) = mlkem::generate_keypair().map_err(map_dh_err)?;
        let sk = x25519::SecretKey::generate().map_err(map_dh_err)?;
        let mut share = Vec::with_capacity(mlkem::EK_BYTES + 32);
        share.extend_from_slice(ek.as_bytes());
        share.extend_from_slice(&sk.public_key());
        Ok(Box::new(ActiveX25519Mlkem768 { dk, sk, share }))
    }

    fn start_and_complete(&self, peer_pub_key: &[u8]) -> Result<CompletedKeyExchange, RustlsError> {
        // 服务端:peer share = ek(1184) ‖ X25519 pk(32)
        let invalid = || RustlsError::PeerMisbehaved(PeerMisbehaved::InvalidKeyShare);
        if peer_pub_key.len() != mlkem::EK_BYTES + 32 {
            return Err(invalid());
        }
        // FIPS 203 §7.2 封装密钥检查(含模校验)在此发生
        let ek = mlkem::Mlkem768EncapsKey::from_bytes(&peer_pub_key[..mlkem::EK_BYTES])
            .map_err(|_| invalid())?;
        let (ct, ss_m) = mlkem::encapsulate(&ek).map_err(map_dh_err)?;
        let sk = x25519::SecretKey::generate().map_err(map_dh_err)?;
        let ss_x = self_x25519(&sk, &peer_pub_key[mlkem::EK_BYTES..])?;

        let mut secret = Vec::with_capacity(mlkem::SS_BYTES + 32);
        secret.extend_from_slice(ss_m.expose_bytes());
        secret.extend_from_slice(ss_x.as_bytes());
        let mut pub_key = Vec::with_capacity(mlkem::CT_BYTES + 32);
        pub_key.extend_from_slice(ct.as_bytes());
        pub_key.extend_from_slice(&sk.public_key());
        Ok(CompletedKeyExchange {
            group: NamedGroup::X25519MLKEM768,
            pub_key,
            secret: SharedSecret::from(secret),
        })
    }

    fn name(&self) -> NamedGroup {
        NamedGroup::X25519MLKEM768
    }

    fn fips(&self) -> bool {
        // 认证(阶段 C)落地前恒 false(AGENTS.md 规则 3)。
        false
    }
}

impl ActiveKeyExchange for ActiveX25519Mlkem768 {
    fn complete(self: Box<Self>, peer_pub_key: &[u8]) -> Result<SharedSecret, RustlsError> {
        // 客户端:服务端 share = ct(1088) ‖ X25519 pk(32);密文长度
        // 不符必须中止(draft-ietf-tls-ecdhe-mlkem §3)。
        let invalid = || RustlsError::PeerMisbehaved(PeerMisbehaved::InvalidKeyShare);
        if peer_pub_key.len() != mlkem::CT_BYTES + 32 {
            return Err(invalid());
        }
        let ct = mlkem::Mlkem768Ciphertext::from_bytes(&peer_pub_key[..mlkem::CT_BYTES])
            .map_err(|_| invalid())?;
        let ss_m = mlkem::decapsulate(&self.dk, &ct);
        let ss_x = self_x25519(&self.sk, &peer_pub_key[mlkem::CT_BYTES..])?;

        let mut secret = Vec::with_capacity(mlkem::SS_BYTES + 32);
        secret.extend_from_slice(ss_m.expose_bytes());
        secret.extend_from_slice(ss_x.as_bytes());
        Ok(SharedSecret::from(secret))
    }

    fn pub_key(&self) -> &[u8] {
        &self.share
    }

    fn group(&self) -> NamedGroup {
        NamedGroup::X25519MLKEM768
    }
}

fn self_x25519(sk: &x25519::SecretKey, peer: &[u8]) -> Result<x25519::SharedSecret, RustlsError> {
    sk.diffie_hellman(peer).map_err(map_dh_err)
}

/// X25519 组单例。
pub static X25519_GROUP: &dyn SupportedKxGroup = &X25519;
/// P-256 组单例。
pub static SECP256R1_GROUP: &dyn SupportedKxGroup = &SecP256R1;
/// P-384 组单例。
pub static SECP384R1_GROUP: &dyn SupportedKxGroup = &SecP384R1;

/// X25519MLKEM768 混合组单例(默认列表首项:PQ 优先,同主流
/// provider/浏览器实践;1216 B ClientHello share)。
pub static X25519MLKEM768_GROUP: &dyn SupportedKxGroup = &X25519Mlkem768;

/// 默认(非批准模式)密钥交换组清单;顺序即偏好——X25519MLKEM768
/// 混合优先,其后纯 ML-KEM(768/1024/512)与经典组。注意 rustls 会
/// 为清单内**每个**组在 ClientHello 里发 key share:全清单 share 约
/// 4.8 KB(1216 + 1184 + 1568 + 800 + 32 B),只需子集的用户可自行
/// 装配 provider(`CryptoProvider` 字段公开)。
pub static ALL_KX_GROUPS: &[&'static dyn SupportedKxGroup] = &[
    &X25519Mlkem768,
    &Mlkem768,
    &Mlkem1024,
    &Mlkem512,
    &X25519,
    &SecP256R1,
    &SecP384R1,
];

/// 批准模式密钥交换组清单:ML-KEM 全部三个参数集(FIPS 203 批准;
/// 纯组与 X25519MLKEM768 混合——X25519 进批准模式的通道)+ 经典
/// P-256/P-384;无独立 X25519(SP 800-52r2 口径)。
pub static FIPS_KX_GROUPS: &[&'static dyn SupportedKxGroup] = &[
    &X25519Mlkem768,
    &Mlkem768,
    &Mlkem1024,
    &Mlkem512,
    &SecP256R1,
    &SecP384R1,
];

// ---------------------------------------------------------------------------
// 纯 ML-KEM 组(draft-ietf-tls-mlkem-key-agreement,0x0200–0x0202)
// ---------------------------------------------------------------------------

/// 宏展开三个纯 ML-KEM `SupportedKxGroup`。角色与线格式(KEM 角色与
/// 混合组同构,仅去掉 X25519 分量):
/// - 客户端 = 解封装方:share = ek(800/1184/1568 B);
/// - 服务端 = 封装方:`start_and_complete` 覆写 + FIPS 203 §7.2 封装
///   密钥检查,share = ct(768/1088/1568 B);
/// - 共享秘密 = ss(32 B)。
macro_rules! mlkem_pure_group {
    ($group:ident, $active:ident, $sname:ident, $set:ident, $ng:expr, $doc:expr) => {
        #[doc = $doc]
        #[derive(Debug)]
        pub struct $group;

        /// 进行中的纯 ML-KEM 客户端侧密钥交换(持有解封装密钥)。
        pub(crate) struct $active {
            dk: ferritls_core::mlkem::$set::DecapsKey,
            share: Vec<u8>,
        }

        impl std::fmt::Debug for $active {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                f.write_str(stringify!($active))
            }
        }

        impl SupportedKxGroup for $group {
            fn start(&self) -> Result<Box<dyn ActiveKeyExchange>, RustlsError> {
                let (ek, dk) =
                    ferritls_core::mlkem::$set::generate_keypair().map_err(map_dh_err)?;
                let share = ek.as_bytes().to_vec();
                Ok(Box::new($active { dk, share }))
            }

            fn start_and_complete(
                &self,
                peer_pub_key: &[u8],
            ) -> Result<CompletedKeyExchange, RustlsError> {
                // 服务端:peer share = ek
                let invalid = || RustlsError::PeerMisbehaved(PeerMisbehaved::InvalidKeyShare);
                if peer_pub_key.len() != ferritls_core::mlkem::$set::EK_BYTES {
                    return Err(invalid());
                }
                // FIPS 203 §7.2 封装密钥检查(含模校验)在此发生
                let ek = ferritls_core::mlkem::$set::EncapsKey::from_bytes(peer_pub_key)
                    .map_err(|_| invalid())?;
                let (ct, ss) = ferritls_core::mlkem::$set::encapsulate(&ek).map_err(map_dh_err)?;
                Ok(CompletedKeyExchange {
                    group: $ng,
                    pub_key: ct.as_bytes().to_vec(),
                    secret: SharedSecret::from(ss.expose_bytes().to_vec()),
                })
            }

            fn name(&self) -> NamedGroup {
                $ng
            }

            fn fips(&self) -> bool {
                // 认证(阶段 C)落地前恒 false(AGENTS.md 规则 3)。
                false
            }
        }

        impl ActiveKeyExchange for $active {
            fn complete(self: Box<Self>, peer_pub_key: &[u8]) -> Result<SharedSecret, RustlsError> {
                // 客户端:服务端 share = ct;密文长度不符必须中止
                let invalid = || RustlsError::PeerMisbehaved(PeerMisbehaved::InvalidKeyShare);
                if peer_pub_key.len() != ferritls_core::mlkem::$set::CT_BYTES {
                    return Err(invalid());
                }
                let ct = ferritls_core::mlkem::$set::Ciphertext::from_bytes(peer_pub_key)
                    .map_err(|_| invalid())?;
                let ss = ferritls_core::mlkem::$set::decapsulate(&self.dk, &ct);
                Ok(SharedSecret::from(ss.expose_bytes().to_vec()))
            }

            fn pub_key(&self) -> &[u8] {
                &self.share
            }

            fn group(&self) -> NamedGroup {
                $ng
            }
        }

        #[doc = concat!(stringify!($group), " 组单例。")]
        pub static $sname: &dyn SupportedKxGroup = &$group;
    };
}

mlkem_pure_group!(
    Mlkem512,
    ActiveMlkem512,
    MLKEM512_GROUP,
    k512,
    NamedGroup::MLKEM512,
    "MLKEM512(draft-ietf-tls-mlkem-key-agreement,codepoint 0x0200)纯\nML-KEM 密钥交换组(M8.4):Cat 1 参数集(k = 2,η₁ = 3)。"
);
mlkem_pure_group!(
    Mlkem768,
    ActiveMlkem768,
    MLKEM768_GROUP,
    k768,
    NamedGroup::MLKEM768,
    "MLKEM768(draft-ietf-tls-mlkem-key-agreement,codepoint 0x0201)纯\nML-KEM 密钥交换组(M8.4):Cat 3 参数集(k = 3)。"
);
mlkem_pure_group!(
    Mlkem1024,
    ActiveMlkem1024,
    MLKEM1024_GROUP,
    k1024,
    NamedGroup::MLKEM1024,
    "MLKEM1024(draft-ietf-tls-mlkem-key-agreement,codepoint 0x0202)纯\nML-KEM 密钥交换组(M8.4):Cat 5 参数集(k = 4,du = 11)。"
);