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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
//! Unified [`Connection`] enum over the four TLS/DTLS connection engines.
//!
//! All eight per-(version, role) connection types live behind a single
//! state-machine-pump API: [`Connection::handshake`], [`feed`](Connection::feed),
//! [`pop`](Connection::pop), [`send`](Connection::send), and
//! [`recv`](Connection::recv). The variants are `pub(crate)` so the public API
//! is the methods only.
use alloc::boxed::Box;
use alloc::vec::Vec;
use core::time::Duration;
use crate::rng::{CryptoRng, RngCore};
use super::config::Config;
use super::error::Error;
use super::version::ProtocolVersion;
/// Type-erased RNG the public [`Connection`] hands to its engines: the
/// caller-supplied [`EntropySource`](super::config::EntropySource), wrapped so
/// it satisfies the `R: RngCore` bound the per-(version, role) engines are
/// generic over (the public enum itself cannot be generic).
///
/// There is deliberately no `OsRng` default — a sans-I/O engine takes entropy
/// as an input, so the caller must always supply a source via
/// [`ConfigBuilder::rng`](super::ConfigBuilder::rng). `OsRng` is just one
/// [`EntropySource`] the caller may choose to pass.
struct ConfigRng(alloc::sync::Arc<dyn super::config::EntropySource>);
impl RngCore for ConfigRng {
fn fill_bytes(&mut self, dest: &mut [u8]) {
self.0.fill(dest);
}
}
// The configured source is contractually a CSPRNG — the caller promises the
// `EntropySource` is cryptographically secure — so it is valid wherever the
// engines require `CryptoRng`.
impl CryptoRng for ConfigRng {}
/// The engine RNG for `cfg`. Errors with [`Error::MissingEntropySource`] when
/// the caller did not install one: the engine never falls back to a default.
fn config_rng(cfg: &Config) -> Result<ConfigRng, Error> {
match &cfg.rng {
Some(src) => Ok(ConfigRng(src.clone())),
None => Err(Error::MissingEntropySource),
}
}
/// Handshake progress, as observed from the uniform API.
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
pub enum HandshakeStatus {
/// The handshake is complete; application data may flow.
Complete,
/// The engine has nothing to emit; the caller should
/// [`feed`](Connection::feed) bytes from the peer — **or**, for an
/// [`SigningKey::External`](super::config::SigningKey::External) identity,
/// supply a pending external signature. Check
/// [`signature_request`](Connection::signature_request) before blocking on
/// a read: when it returns `Some`, the handshake is suspended awaiting a
/// `CertificateVerify` signature, not peer bytes.
WantRead,
/// The engine has wire bytes ready; the caller should drain them with
/// [`pop`](Connection::pop) and forward them to the peer.
WantWrite,
}
/// What [`Connection::drive`] needs next — the unified, key-agnostic drive
/// surface. Unlike [`HandshakeStatus`], this folds the signing device into the
/// same loop, so a caller services peer I/O *and* (transparently) a TPM/HSM
/// without ever branching on the kind of key behind [`Config::signer`].
///
/// `#[non_exhaustive]`: future drive reasons can be added without breaking
/// exhaustive matches.
#[non_exhaustive]
pub enum Step {
/// The engine needs bytes from the peer: read the socket and
/// [`feed`](Connection::feed) them.
WantRead,
/// The engine has wire bytes to send: [`pop`](Connection::pop) and write
/// them to the peer.
WantWrite,
/// The signing device needs servicing. If `Some`, wait on the
/// [`Readiness`](super::signer::Readiness) (sync: [`wait`](super::signer::Readiness::wait);
/// async: register its fd with your reactor), then call
/// [`drive`](Connection::drive) again. `None` means the op has no waitable
/// descriptor — just call `drive` again. In-process keys never yield this.
WantSigner(Option<super::signer::Readiness>),
/// The handshake is complete; application data may flow.
Complete,
}
/// A request for an external `CertificateVerify` signature, returned by
/// [`Connection::signature_request`]. The caller signs `message` under the
/// algorithm identified by `scheme` (the signature operation applies the
/// scheme's own hashing/padding) and resumes via
/// [`Connection::provide_signature`].
#[derive(Clone, PartialEq, Eq, Debug)]
pub struct SignatureRequest {
/// IANA `SignatureScheme` code point (RFC 8446 §4.2.3) negotiated for this
/// handshake — the algorithm the returned signature must use.
pub scheme: u16,
/// The exact bytes to sign: the TLS 1.3 `CertificateVerify` signature input
/// (the 64-octet pad, context string, `0x00`, and transcript hash).
pub message: Vec<u8>,
}
/// A unified TLS or DTLS connection (client or server, any supported
/// version).
///
/// Construct via [`Connection::client`] or [`Connection::server`], passing a
/// shared [`super::Config`]. The internal engine is picked from
/// `config.max_version`.
pub struct Connection {
inner: Engine,
/// Pending outbound DTLS datagrams; [`Connection::pop`] returns one per
/// call. Empty for TLS engines, which return their entire write buffer
/// in one call.
pending_dtls: alloc::collections::VecDeque<Vec<u8>>,
/// Transparent pluggable signer (from [`Config::signer`]), brokered by
/// [`Connection::drive`]. `None` when the identity signs in-process.
signer: Option<alloc::sync::Arc<dyn super::signer::HandshakeSigner>>,
/// The in-flight external signing operation, while [`Connection::drive`] is
/// waiting on the signer's device.
active_sign: Option<Box<dyn super::signer::SignOp>>,
}
#[allow(clippy::large_enum_variant)]
enum Engine {
/// TLS 1.3 client.
ClientTls13(Box<super::conn::ClientConnection>),
/// TLS 1.2 client.
ClientTls12(Box<super::conn::ClientConnection12>),
/// TLS 1.3 server.
ServerTls13(Box<super::conn::ServerConnection<ConfigRng>>),
/// TLS 1.2 server.
ServerTls12(Box<super::conn::ServerConnection12<ConfigRng>>),
/// DTLS 1.3 client.
ClientDtls13(Box<crate::dtls::DtlsClientConnection13>),
/// DTLS 1.2 client.
ClientDtls12(Box<crate::dtls::DtlsClientConnection12>),
/// DTLS 1.3 server.
ServerDtls13(Box<crate::dtls::DtlsServerConnection13<ConfigRng>>),
/// DTLS 1.2 server.
ServerDtls12(Box<crate::dtls::DtlsServerConnection12<ConfigRng>>),
}
impl Connection {
/// Build a client connection. Picks the engine from `config.max_version`.
pub fn client(config: &Config) -> Result<Self, Error> {
config.check_versions()?;
let inner = match config.max_version {
ProtocolVersion::TLSv1_3 => Engine::ClientTls13(Box::new(build_tls13_client(config)?)),
ProtocolVersion::TLSv1_2 => Engine::ClientTls12(Box::new(build_tls12_client(config)?)),
// The TLS 1.2 engine also drives the opt-in legacy path; a caller
// that tops out at TLS 1.0/1.1 still routes through it.
#[cfg(feature = "tls-legacy")]
ProtocolVersion::TLSv1_1 | ProtocolVersion::TLSv1_0 | ProtocolVersion::SSLv3 => {
Engine::ClientTls12(Box::new(build_tls12_client(config)?))
}
ProtocolVersion::DTLSv1_3 => {
Engine::ClientDtls13(Box::new(build_dtls13_client(config)?))
}
ProtocolVersion::DTLSv1_2 => {
Engine::ClientDtls12(Box::new(build_dtls12_client(config)?))
}
_ => return Err(Error::UnsupportedVersion),
};
Ok(Connection {
inner,
pending_dtls: alloc::collections::VecDeque::new(),
signer: config.signer.clone(),
active_sign: None,
})
}
/// Build a server connection. Picks the engine from `config.max_version`.
/// Requires `config.identity.is_some()`.
pub fn server(config: &Config) -> Result<Self, Error> {
config.check_versions()?;
if config.identity.is_none() {
return Err(Error::InappropriateState);
}
let inner = match config.max_version {
ProtocolVersion::TLSv1_3 => Engine::ServerTls13(Box::new(build_tls13_server(config)?)),
ProtocolVersion::TLSv1_2 => Engine::ServerTls12(Box::new(build_tls12_server(config)?)),
#[cfg(feature = "tls-legacy")]
ProtocolVersion::TLSv1_1 | ProtocolVersion::TLSv1_0 | ProtocolVersion::SSLv3 => {
Engine::ServerTls12(Box::new(build_tls12_server(config)?))
}
ProtocolVersion::DTLSv1_3 => {
Engine::ServerDtls13(Box::new(build_dtls13_server(config)?))
}
ProtocolVersion::DTLSv1_2 => {
Engine::ServerDtls12(Box::new(build_dtls12_server(config)?))
}
_ => return Err(Error::UnsupportedVersion),
};
Ok(Connection {
inner,
pending_dtls: alloc::collections::VecDeque::new(),
signer: config.signer.clone(),
active_sign: None,
})
}
/// Drive the handshake forward. Returns the next [`HandshakeStatus`].
pub fn handshake(&mut self) -> Result<HandshakeStatus, Error> {
if self.is_handshake_complete() {
return Ok(HandshakeStatus::Complete);
}
// Refill DTLS pending queue.
self.refill_dtls_pending();
if self.wants_write() {
Ok(HandshakeStatus::WantWrite)
} else {
Ok(HandshakeStatus::WantRead)
}
}
/// Drive the handshake forward, transparently brokering the identity
/// signature through the [`HandshakeSigner`](super::HandshakeSigner) installed via
/// [`ConfigBuilder::private_key`](super::ConfigBuilder::private_key).
///
/// This is the key-agnostic alternative to [`handshake`](Self::handshake):
/// the same loop drives an in-process key, a local TPM, or a network HSM,
/// because the signing device is folded into the returned [`Step`]. The
/// caller services peer I/O on `WantRead`/`WantWrite` exactly as with
/// `handshake`, and on `WantSigner` waits on the (opaque) device readiness
/// before calling `drive` again — it never touches the message, the
/// signature, or the device transport.
///
/// ```no_run
/// # use purecrypto::tls::{Connection, Step};
/// # fn run(conn: &mut Connection, sock: &mut std::net::TcpStream) -> std::io::Result<()> {
/// use std::io::{Read, Write};
/// let mut buf = [0u8; 16 * 1024];
/// loop {
/// match conn.drive().map_err(std::io::Error::other)? {
/// Step::WantWrite => sock.write_all(&conn.pop().map_err(std::io::Error::other)?)?,
/// Step::WantRead => {
/// let n = sock.read(&mut buf)?;
/// conn.feed(&buf[..n]).map_err(std::io::Error::other)?;
/// }
/// // Sync: block on the device fd. Async: register
/// // `r.as_raw_fd()` with your reactor and `.await` instead.
/// Step::WantSigner(Some(r)) => r.wait()?,
/// Step::WantSigner(None) => {} // no fd: just loop and re-drive
/// Step::Complete => break,
/// _ => {} // `Step` is #[non_exhaustive]
/// }
/// }
/// # Ok(())
/// # }
/// ```
pub fn drive(&mut self) -> Result<Step, Error> {
// If the engine has parked awaiting the identity signature, broker it
// through the installed HandshakeSigner rather than asking the caller.
if self.active_sign.is_none()
&& let Some(req) = self.signature_request()
{
let op = {
let signer = self.signer.as_ref().ok_or(Error::InappropriateState)?;
signer.start_sign(req.scheme, &req.message)?
};
self.active_sign = Some(op);
}
if self.active_sign.is_some() {
let progress = {
let op = self.active_sign.as_mut().expect("checked is_some");
op.resume()?
};
match progress {
super::signer::SignProgress::Pending => {
let readiness = self
.active_sign
.as_ref()
.expect("still in flight")
.readiness();
return Ok(Step::WantSigner(readiness));
}
super::signer::SignProgress::Done(sig) => {
self.active_sign = None;
self.provide_signature(sig)?;
// Fall through: provide_signature drove the engine, so the
// CertificateVerify + Finished records are now pending.
}
}
}
// Drain any buffered output before reporting completion. The engine
// marks the handshake complete as soon as it *builds* its last flight
// (e.g. the TLS 1.3 client's Finished), so `handshake()` — which checks
// completion first — would otherwise return `Complete` with that flight
// still in the buffer and the driver would stop without sending it,
// leaving the peer waiting forever. Prioritising the write here makes
// `drive` fully flush the final flight first.
if self.wants_write() {
self.refill_dtls_pending();
return Ok(Step::WantWrite);
}
match self.handshake()? {
HandshakeStatus::Complete => Ok(Step::Complete),
HandshakeStatus::WantWrite => Ok(Step::WantWrite),
HandshakeStatus::WantRead => Ok(Step::WantRead),
}
}
/// If the handshake is suspended awaiting an external `CertificateVerify`
/// signature (an [`SigningKey::External`](super::config::SigningKey::External)
/// identity), returns the [`SignatureRequest`] describing what to sign;
/// otherwise `None`.
///
/// Drive loop: after [`feed`](Self::feed) and draining [`pop`](Self::pop),
/// check this **before** blocking on a peer read. When it is `Some`, sign
/// `request.message` under `request.scheme` (on a TPM/HSM, synchronously or
/// `.await`ed) and call [`provide_signature`](Self::provide_signature); the
/// engine then emits the rest of its flight.
pub fn signature_request(&self) -> Option<SignatureRequest> {
let pending = match &self.inner {
Engine::ServerTls13(c) => c.pending_signature(),
Engine::ClientTls13(c) => c.pending_signature(),
Engine::ServerDtls13(c) => c.pending_signature(),
Engine::ServerDtls12(c) => c.pending_signature(),
_ => None,
};
pending.map(|(scheme, message)| SignatureRequest { scheme, message })
}
/// Resumes a handshake suspended by [`signature_request`](Self::signature_request),
/// supplying the externally-produced `CertificateVerify` signature.
///
/// # Errors
/// Returns [`Error::InappropriateState`] if the handshake is not currently
/// awaiting an external signature.
pub fn provide_signature(&mut self, signature: Vec<u8>) -> Result<(), Error> {
match &mut self.inner {
Engine::ServerTls13(c) => c.provide_signature(signature),
Engine::ClientTls13(c) => c.provide_signature(signature),
Engine::ServerDtls13(c) => c.provide_signature(signature),
Engine::ServerDtls12(c) => c.provide_signature(signature),
_ => Err(Error::InappropriateState),
}
}
/// Wire bytes from the peer into the engine. Returns the number of
/// bytes consumed.
pub fn feed(&mut self, wire_in: &[u8]) -> Result<usize, Error> {
match &mut self.inner {
Engine::ClientTls13(c) => {
c.read_tls(wire_in);
c.process_new_packets()?;
}
Engine::ClientTls12(c) => {
c.read_tls(wire_in);
c.process_new_packets()?;
}
Engine::ServerTls13(c) => {
c.read_tls(wire_in);
c.process_new_packets()?;
}
Engine::ServerTls12(c) => {
c.read_tls(wire_in);
c.process_new_packets()?;
}
Engine::ClientDtls12(c) => c.feed_datagram(wire_in)?,
Engine::ClientDtls13(c) => c.feed_datagram(wire_in)?,
Engine::ServerDtls12(c) => c.feed_datagram(wire_in)?,
Engine::ServerDtls13(c) => c.feed_datagram(wire_in)?,
}
// Eagerly pull DTLS datagrams into the buffer.
self.refill_dtls_pending();
Ok(wire_in.len())
}
/// Wire bytes the engine wants to send to the peer. For TLS, this is a
/// contiguous stream slice; for DTLS, this is one datagram per call.
pub fn pop(&mut self) -> Result<Vec<u8>, Error> {
let bytes: Vec<u8> = match &mut self.inner {
Engine::ClientTls13(c) => c.write_tls(),
Engine::ClientTls12(c) => c.write_tls(),
Engine::ServerTls13(c) => c.write_tls(),
Engine::ServerTls12(c) => c.write_tls(),
_ => {
// Refill if buffer empty, then pop the next datagram.
if self.pending_dtls.is_empty() {
let drained = match &mut self.inner {
Engine::ClientDtls12(c) => c.pop_outbound_datagrams(),
Engine::ClientDtls13(c) => c.pop_outbound_datagrams(),
Engine::ServerDtls12(c) => c.pop_outbound_datagrams(),
Engine::ServerDtls13(c) => c.pop_outbound_datagrams(),
_ => Vec::new(),
};
for dg in drained {
self.pending_dtls.push_back(dg);
}
}
self.pending_dtls.pop_front().unwrap_or_default()
}
};
Ok(bytes)
}
/// App bytes into the engine (post-handshake).
pub fn send(&mut self, app: &[u8]) -> Result<(), Error> {
match &mut self.inner {
Engine::ClientTls13(c) => c.send_application_data(app),
Engine::ClientTls12(c) => c.send_application_data(app),
Engine::ServerTls13(c) => c.send_application_data(app),
Engine::ServerTls12(c) => c.send_application_data(app),
Engine::ClientDtls12(c) => c.send(app),
Engine::ClientDtls13(c) => c.send(app),
Engine::ServerDtls12(c) => c.send(app),
Engine::ServerDtls13(c) => c.send(app),
}
}
/// App bytes out (post-handshake).
pub fn recv(&mut self) -> Result<Vec<u8>, Error> {
Ok(match &mut self.inner {
Engine::ClientTls13(c) => c.take_received_plaintext(),
Engine::ClientTls12(c) => c.take_received_plaintext(),
Engine::ServerTls13(c) => c.take_received_plaintext(),
Engine::ServerTls12(c) => c.take_received_plaintext(),
Engine::ClientDtls12(c) => c.take_received(),
Engine::ClientDtls13(c) => c.take_received(),
Engine::ServerDtls12(c) => c.take_received(),
Engine::ServerDtls13(c) => c.take_received(),
})
}
/// Accepted 0-RTT early-data plaintext out (server side).
///
/// Early data is **replayable by an active attacker** (RFC 8446 §8), so
/// it is quarantined away from [`recv`](Connection::recv) — `recv` only
/// ever returns data protected by the completed handshake. Drain the
/// replayable bytes explicitly here and only act on them when doing so
/// is idempotent. Returns an empty vector on client engines, on engines
/// without 0-RTT support, when the server did not accept early data, or
/// once the buffer has been drained.
pub fn take_early_data(&mut self) -> Result<Vec<u8>, Error> {
Ok(match &mut self.inner {
Engine::ServerTls13(c) => c.take_early_data(),
// No other engine accepts 0-RTT early data today.
_ => Vec::new(),
})
}
/// Close the connection, emitting a close_notify alert if the engine
/// supports it.
pub fn close(&mut self) -> Result<(), Error> {
match &mut self.inner {
Engine::ClientTls13(c) => c.send_close_notify(),
Engine::ClientTls12(c) => c.send_close_notify(),
Engine::ServerTls13(c) => c.send_close_notify(),
Engine::ServerTls12(c) => c.send_close_notify(),
// DTLS in this library does not emit an explicit close_notify
// through its public API; the connection is closed when freed.
_ => {}
}
Ok(())
}
/// True once the handshake has completed.
pub fn is_handshake_complete(&self) -> bool {
match &self.inner {
Engine::ClientTls13(c) => !c.is_handshaking(),
Engine::ClientTls12(c) => !c.is_handshaking(),
Engine::ServerTls13(c) => !c.is_handshaking(),
Engine::ServerTls12(c) => !c.is_handshaking(),
Engine::ClientDtls12(c) => c.is_handshake_complete(),
Engine::ClientDtls13(c) => c.is_handshake_complete(),
Engine::ServerDtls12(c) => c.is_handshake_complete(),
Engine::ServerDtls13(c) => c.is_handshake_complete(),
}
}
/// True once the peer's close_notify alert has been processed.
///
/// Distinguishes a graceful TLS shutdown from an abrupt transport
/// close: after transport EOF, `false` here means the peer (or an
/// active attacker injecting a TCP FIN/RST) cut the stream without
/// the RFC 8446 §6.1 / RFC 5246 §7.2.1 closure alert. Callers using
/// EOF-delimited application framing should treat that as a
/// truncation attack and reject the data.
///
/// Always `false` for DTLS engines — purecrypto's DTLS does not
/// exchange close_notify (datagram transports have no stream EOF to
/// authenticate; an application protocol signals its own end).
pub fn received_close_notify(&self) -> bool {
match &self.inner {
Engine::ClientTls13(c) => c.received_close_notify(),
Engine::ClientTls12(c) => c.received_close_notify(),
Engine::ServerTls13(c) => c.received_close_notify(),
Engine::ServerTls12(c) => c.received_close_notify(),
Engine::ClientDtls12(_)
| Engine::ClientDtls13(_)
| Engine::ServerDtls12(_)
| Engine::ServerDtls13(_) => false,
}
}
/// The negotiated wire version, if the handshake has progressed enough
/// to determine it.
pub fn negotiated_version(&self) -> Option<ProtocolVersion> {
match &self.inner {
Engine::ClientTls13(_) | Engine::ServerTls13(_) => Some(ProtocolVersion::TLSv1_3),
// The TLS 1.2 engine also drives the opt-in legacy versions, so it
// reports its own negotiated version (TLS 1.0/1.1 when lowered).
Engine::ClientTls12(c) => c.negotiated_protocol_version(),
Engine::ServerTls12(c) => c.negotiated_protocol_version(),
Engine::ClientDtls12(_) | Engine::ServerDtls12(_) => Some(ProtocolVersion::DTLSv1_2),
Engine::ClientDtls13(_) | Engine::ServerDtls13(_) => Some(ProtocolVersion::DTLSv1_3),
}
}
/// IANA cipher-suite identifier of the negotiated suite. `None`
/// until the handshake has advanced far enough to fix the suite
/// (ServerHello processed on the client, ClientHello processed on
/// the server).
pub fn negotiated_cipher_suite(&self) -> Option<u16> {
match &self.inner {
Engine::ClientTls13(c) => c.negotiated_cipher_suite(),
Engine::ClientTls12(c) => c.negotiated_cipher_suite(),
Engine::ServerTls13(c) => {
// The TLS 1.3 server tracks its suite internally; the
// existing public surface is `negotiated_suite()`-shaped
// (Option<CipherSuite>). Defer to the same accessor.
c.negotiated_cipher_suite()
}
Engine::ServerTls12(c) => c.negotiated_cipher_suite(),
Engine::ClientDtls13(c) => c.negotiated_cipher_suite(),
Engine::ServerDtls13(c) => c.negotiated_cipher_suite(),
Engine::ClientDtls12(c) => c.negotiated_cipher_suite(),
Engine::ServerDtls12(c) => c.negotiated_cipher_suite(),
}
}
/// The IANA name of the negotiated cipher suite, or `None` until the
/// suite is fixed. Returns the well-known strings for the suites
/// purecrypto negotiates (TLS 1.3 trio + the TLS 1.2 ECDHE-AEAD
/// set); unknown codes resolve to `"UNKNOWN"`.
pub fn negotiated_cipher_suite_name(&self) -> Option<&'static str> {
self.negotiated_cipher_suite().map(cipher_suite_name)
}
/// The negotiated ALPN protocol, if any.
pub fn alpn_selected(&self) -> Option<&[u8]> {
match &self.inner {
Engine::ClientTls13(c) => c.alpn_protocol(),
Engine::ClientTls12(c) => c.alpn_protocol(),
Engine::ServerTls13(c) => c.alpn_protocol(),
Engine::ServerTls12(c) => c.alpn_protocol(),
Engine::ClientDtls13(c) => c.alpn_protocol(),
_ => None,
}
}
/// Server-side: the SNI host_name the client offered in the ClientHello
/// `server_name` extension (RFC 6066 §3). `None` for client engines,
/// for DTLS engines (no SNI plumbing yet), or when the peer omitted the
/// extension. Available once the ClientHello has been processed.
pub fn peer_server_name(&self) -> Option<&str> {
match &self.inner {
Engine::ServerTls13(c) => c.peer_server_name(),
Engine::ServerTls12(c) => c.peer_server_name(),
_ => None,
}
}
/// The peer's certificate chain (leaf first, DER).
pub fn peer_certificates(&self) -> &[Vec<u8>] {
match &self.inner {
Engine::ClientTls13(c) => c.peer_certificates(),
Engine::ClientTls12(c) => c.peer_certificates(),
Engine::ServerTls13(c) => c.peer_certificates(),
Engine::ServerTls12(c) => c.peer_certificates(),
Engine::ClientDtls13(c) => c.peer_certificates(),
_ => &[],
}
}
/// DTLS: next retransmit timeout. None on TLS variants.
pub fn next_timeout(&self) -> Option<Duration> {
match &self.inner {
Engine::ClientDtls12(c) => c.next_timeout(),
Engine::ClientDtls13(c) => c.next_timeout(),
Engine::ServerDtls12(c) => c.next_timeout(),
Engine::ServerDtls13(c) => c.next_timeout(),
_ => None,
}
}
/// DTLS: notify the engine that the retransmit deadline has elapsed.
/// No-op on TLS variants.
pub fn on_timeout(&mut self, now: Duration) {
match &mut self.inner {
Engine::ClientDtls12(c) => c.on_timeout(now),
Engine::ClientDtls13(c) => c.on_timeout(now),
Engine::ServerDtls12(c) => c.on_timeout(now),
Engine::ServerDtls13(c) => c.on_timeout(now),
_ => {}
}
}
fn wants_write(&self) -> bool {
match &self.inner {
Engine::ClientTls13(c) => c.wants_write(),
Engine::ClientTls12(c) => c.wants_write(),
Engine::ServerTls13(c) => c.wants_write(),
Engine::ServerTls12(c) => c.wants_write(),
// DTLS: any pending datagram counts as wanting-write.
_ => !self.pending_dtls.is_empty(),
}
}
/// Drain new outbound datagrams from the DTLS engine into the pending
/// buffer. No-op for TLS variants.
fn refill_dtls_pending(&mut self) {
let drained: Vec<Vec<u8>> = match &mut self.inner {
Engine::ClientDtls12(c) => c.pop_outbound_datagrams(),
Engine::ClientDtls13(c) => c.pop_outbound_datagrams(),
Engine::ServerDtls12(c) => c.pop_outbound_datagrams(),
Engine::ServerDtls13(c) => c.pop_outbound_datagrams(),
_ => return,
};
for dg in drained {
self.pending_dtls.push_back(dg);
}
}
}
/// Maps an IANA cipher-suite wire code to its registered name. Covers
/// every suite this crate negotiates; unknown codes resolve to
/// `"UNKNOWN"` so the function is total.
fn cipher_suite_name(id: u16) -> &'static str {
match id {
0x1301 => "TLS_AES_128_GCM_SHA256",
0x1302 => "TLS_AES_256_GCM_SHA384",
0x1303 => "TLS_CHACHA20_POLY1305_SHA256",
0xC02B => "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
0xC02C => "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
0xC02F => "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
0xC030 => "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
0xCCA8 => "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256",
0xCCA9 => "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256",
// Opt-in legacy CBC suites (tls-legacy).
0x000A => "TLS_RSA_WITH_3DES_EDE_CBC_SHA",
0x002F => "TLS_RSA_WITH_AES_128_CBC_SHA",
0x0035 => "TLS_RSA_WITH_AES_256_CBC_SHA",
0x003C => "TLS_RSA_WITH_AES_128_CBC_SHA256",
0x003D => "TLS_RSA_WITH_AES_256_CBC_SHA256",
0xC012 => "TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA",
0xC013 => "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA",
0xC014 => "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA",
0xC027 => "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
0xC028 => "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA256",
_ => "UNKNOWN",
}
}
// ---- Engine builders --------------------------------------------------------
/// The client's intended server name, used for SNI and (when enabled) hostname
/// verification. A name is **required only when `verify_certificates` is on** —
/// without it there is nothing to check the peer certificate against, so a
/// missing name is a misconfiguration. With verification off (e.g. connecting to
/// a device by IP), the name is optional; an empty string means "no SNI, no
/// hostname check", which the engines honour by omitting the SNI extension.
fn client_server_name(cfg: &Config) -> Result<&str, Error> {
match cfg.server_name.as_deref() {
Some(name) => Ok(name),
None if !cfg.verify_certificates => Ok(""),
None => Err(Error::MissingServerName),
}
}
fn build_tls13_client(cfg: &Config) -> Result<super::conn::ClientConnection, Error> {
let mut cc = super::conn::ClientConfig::new(cfg.roots.clone_store());
cc.verify_certificates = cfg.verify_certificates;
cc.cipher_suites = cfg.cipher_suites.clone();
if !cfg.alpn_protocols.is_empty() {
cc = cc.with_alpn(cfg.alpn_protocols.clone());
}
if !cfg.crls.is_empty() {
cc = cc.with_crls(cfg.crls.clone_store());
}
if let Some(t) = cfg.verification_time.clone() {
cc.verification_time = Some(t);
}
if let Some(rsl) = cfg.record_size_limit {
cc = cc.with_record_size_limit(rsl);
}
cc = cc.with_signature_policy(cfg.signature_policy.clone());
if let Some(id) = &cfg.identity {
let cc_cfg = client_cert_from_signing(id);
if let Some(c) = cc_cfg {
cc = cc.with_client_cert(c);
}
}
cc = cc.with_server_cert_type_preference(cfg.server_cert_type_preference.clone());
cc = cc.with_client_cert_type_preference(cfg.client_cert_type_preference.clone());
for spki in &cfg.expected_raw_public_keys {
cc = cc.add_expected_raw_public_key(spki.clone());
}
cc.key_log = cfg.key_log.clone();
#[cfg(feature = "ech")]
{
cc.ech = cfg.ech.clone();
}
#[cfg(feature = "cert-compression")]
{
cc = cc.with_cert_compression_algorithms(cfg.cert_compression_algorithms.clone());
}
let server_name = client_server_name(cfg)?;
super::conn::ClientConnection::new(cc, server_name, &mut config_rng(cfg)?)
}
fn build_tls12_client(cfg: &Config) -> Result<super::conn::ClientConnection12, Error> {
let mut cc = super::conn::ClientConfig12::new(cfg.roots.clone_store());
cc.verify_certificates = cfg.verify_certificates;
cc.cipher_suites = cfg.cipher_suites.clone();
if !cfg.alpn_protocols.is_empty() {
cc = cc.with_alpn(cfg.alpn_protocols.clone());
}
if !cfg.crls.is_empty() {
cc = cc.with_crls(cfg.crls.clone_store());
}
if let Some(t) = cfg.verification_time.clone() {
cc = cc.with_verification_time(t);
}
if let Some(rsl) = cfg.record_size_limit {
cc = cc.with_record_size_limit(rsl);
}
cc = cc.with_signature_policy(cfg.signature_policy.clone());
cc = cc.with_require_ems(cfg.require_extended_master_secret);
if let Some(id) = &cfg.identity {
let cc_cfg = client_cert_from_signing(id);
if let Some(c) = cc_cfg {
cc = cc.with_client_cert(c);
}
}
cc.key_log = cfg.key_log.clone();
#[cfg(feature = "tls-legacy")]
{
cc = cc.with_min_version(cfg.min_version);
// The 1.2 engine caps at TLS 1.2; only propagate a lower max so a
// legacy-only caller offers `legacy_version` ≤ 1.1 and no AEAD suites.
if cfg.max_version.as_u16() < ProtocolVersion::TLSv1_2.as_u16() {
cc = cc.with_max_version(cfg.max_version);
}
}
let server_name = client_server_name(cfg)?;
super::conn::ClientConnection12::new(cc, server_name, &mut config_rng(cfg)?)
}
fn build_tls13_server(cfg: &Config) -> Result<super::conn::ServerConnection<ConfigRng>, Error> {
let id = cfg.identity.as_ref().ok_or(Error::InappropriateState)?;
let chain = id.cert_chain.clone();
let mut sc = match &id.key {
super::config::SigningKey::Rsa(k) => super::conn::ServerConfig::with_rsa(chain, k.clone()),
super::config::SigningKey::Ecdsa(k) => {
super::conn::ServerConfig::with_ecdsa(chain, k.clone())
}
super::config::SigningKey::Ed25519(k) => {
super::conn::ServerConfig::with_ed25519(chain, k.clone())
}
super::config::SigningKey::Ed448(k) => {
super::conn::ServerConfig::with_ed448(chain, k.clone())
}
super::config::SigningKey::MlDsa44(k) => {
super::conn::ServerConfig::with_mldsa44(chain, k.clone())
}
super::config::SigningKey::MlDsa65(k) => {
super::conn::ServerConfig::with_mldsa65(chain, k.clone())
}
super::config::SigningKey::MlDsa87(k) => {
super::conn::ServerConfig::with_mldsa87(chain, k.clone())
}
super::config::SigningKey::External { schemes } => {
super::conn::ServerConfig::with_external(chain, schemes.clone())
}
};
if !cfg.alpn_protocols.is_empty() {
sc = sc.with_alpn(cfg.alpn_protocols.clone());
}
if !cfg.crls.is_empty() {
sc = sc.with_crls(cfg.crls.clone_store());
}
if let Some(rsl) = cfg.record_size_limit {
sc = sc.with_record_size_limit(rsl);
}
if let Some(ca) = &cfg.client_auth {
sc = sc.with_client_auth(ca.roots.clone_store(), ca.required);
}
if let Some(tk) = cfg.ticket_key {
sc = sc.with_ticket_key(tk);
}
if cfg.max_early_data_size > 0 {
sc = sc.with_max_early_data(cfg.max_early_data_size);
}
#[cfg(feature = "std")]
if let Some(rw) = cfg.replay_window.clone() {
sc = sc.with_replay_window(rw);
}
if let Some(crl) = cfg.stapled_crl.clone() {
sc = sc.with_stapled_crl(crl);
}
if let Some(ocsp) = cfg.stapled_ocsp_response.clone() {
sc = sc.with_stapled_ocsp_response(ocsp);
}
sc = sc.with_server_cert_type_preference(cfg.server_cert_type_preference.clone());
sc = sc.with_client_cert_type_preference(cfg.client_cert_type_preference.clone());
if let Some(spki) = cfg.raw_public_key_spki.clone() {
sc = sc.with_raw_public_key_spki(spki);
}
sc = sc.with_signature_policy(cfg.signature_policy.clone());
#[cfg(feature = "cert-compression")]
{
sc = sc.with_cert_compression_algorithms(cfg.cert_compression_algorithms.clone());
}
#[cfg(feature = "ech")]
if let Some(ech) = cfg.ech_server.clone() {
sc = sc.with_ech_server(ech);
}
if let Some(g) = cfg.preferred_key_exchange_group {
sc = sc.with_preferred_key_exchange_group(g);
}
if let Some(t) = cfg.verification_time.clone() {
sc = sc.with_verification_time(t);
}
sc.key_log = cfg.key_log.clone();
Ok(super::conn::ServerConnection::new(sc, config_rng(cfg)?))
}
fn build_tls12_server(cfg: &Config) -> Result<super::conn::ServerConnection12<ConfigRng>, Error> {
let id = cfg.identity.as_ref().ok_or(Error::InappropriateState)?;
let chain = id.cert_chain.clone();
let mut sc = id
.key
.try_into_server_config_12(chain)
.ok_or(Error::UnsupportedVersion)?;
if !cfg.alpn_protocols.is_empty() {
sc = sc.with_alpn(cfg.alpn_protocols.clone());
}
if !cfg.crls.is_empty() {
sc = sc.with_crls(cfg.crls.clone_store());
}
if let Some(rsl) = cfg.record_size_limit {
sc = sc.with_record_size_limit(rsl);
}
if let Some(ca) = &cfg.client_auth {
sc = sc.with_client_auth(ca.roots.clone_store(), ca.required);
}
if let Some(tk) = cfg.ticket_key {
sc = sc.with_ticket_key(tk);
}
if let Some(ocsp) = cfg.stapled_ocsp_response.clone() {
sc = sc.with_stapled_ocsp_response(ocsp);
}
sc = sc.with_signature_policy(cfg.signature_policy.clone());
sc = sc.with_require_ems(cfg.require_extended_master_secret);
if let Some(t) = cfg.verification_time.clone() {
sc = sc.with_verification_time(t);
}
sc.key_log = cfg.key_log.clone();
#[cfg(feature = "tls-legacy")]
{
sc = sc.with_min_version(cfg.min_version);
}
Ok(super::conn::ServerConnection12::new(sc, config_rng(cfg)?))
}
fn build_dtls12_client(cfg: &Config) -> Result<crate::dtls::DtlsClientConnection12, Error> {
let server_name = client_server_name(cfg)?;
let mut dc = crate::dtls::ClientConfig12Internal::new(cfg.roots.clone_store(), server_name);
if !cfg.verify_certificates {
dc = dc.without_certificate_verification();
}
if !cfg.crls.is_empty() {
dc = dc.with_crls(cfg.crls.clone_store());
}
if let Some(t) = cfg.verification_time.clone() {
dc = dc.with_verification_time(t);
}
dc = dc.with_signature_policy(cfg.signature_policy.clone());
dc.key_log = cfg.key_log.clone();
Ok(crate::dtls::DtlsClientConnection12::new(
dc,
Vec::new(),
&mut config_rng(cfg)?,
))
}
fn build_dtls13_client(cfg: &Config) -> Result<crate::dtls::DtlsClientConnection13, Error> {
let server_name = client_server_name(cfg)?;
let mut dc = crate::dtls::ClientConfig13Internal::new(cfg.roots.clone_store(), server_name);
if !cfg.verify_certificates {
dc = dc.without_certificate_verification();
}
if !cfg.crls.is_empty() {
dc = dc.with_crls(cfg.crls.clone_store());
}
if let Some(t) = cfg.verification_time.clone() {
dc = dc.with_verification_time(t);
}
dc = dc.with_signature_policy(alloc::sync::Arc::new(cfg.signature_policy.clone()));
dc.max_record_size = cfg.max_record_size;
dc.key_log = cfg.key_log.clone();
Ok(crate::dtls::DtlsClientConnection13::new(
dc,
Vec::new(),
&mut config_rng(cfg)?,
))
}
fn build_dtls12_server(
cfg: &Config,
) -> Result<crate::dtls::DtlsServerConnection12<ConfigRng>, Error> {
let id = cfg.identity.as_ref().ok_or(Error::InappropriateState)?;
// RFC 6347 §4.2.1: the cookie exchange defeats blind amplification
// attacks. We refuse to construct a server that claims to require the
// exchange but cannot mint cookies — silently disabling cookies under a
// misconfiguration is the 50-100x DoS amplification vector. Fail-closed
// so the operator makes a deliberate choice.
if cfg.require_cookie && cfg.cookie_secret.is_none() {
return Err(Error::InappropriateState);
}
let chain = id.cert_chain.clone();
let mut sc = match &id.key {
super::config::SigningKey::Ecdsa(k) => {
crate::dtls::ServerConfig12Internal::with_ecdsa(chain, k.clone())
}
super::config::SigningKey::Rsa(k) => {
crate::dtls::ServerConfig12Internal::with_rsa(chain, k.clone())
}
super::config::SigningKey::External { schemes } => {
crate::dtls::ServerConfig12Internal::with_external(chain, schemes.clone())
}
// DTLS 1.2 mirrors TLS 1.2's scope: RSA + ECDSA only. Ed25519 and
// ML-DSA are not common in TLS 1.2 practice.
_ => return Err(Error::UnsupportedVersion),
};
if let Some(secret) = cfg.cookie_secret {
sc = sc.with_cookie_secret(secret);
}
if !cfg.require_cookie {
sc = sc.require_cookie_exchange(false);
}
sc.key_log = cfg.key_log.clone();
Ok(crate::dtls::DtlsServerConnection12::new(
alloc::sync::Arc::new(sc),
Vec::new(),
config_rng(cfg)?,
))
}
fn build_dtls13_server(
cfg: &Config,
) -> Result<crate::dtls::DtlsServerConnection13<ConfigRng>, Error> {
let id = cfg.identity.as_ref().ok_or(Error::InappropriateState)?;
// RFC 9147 §5.1: DTLS 1.3 retains the cookie-based stateless rejection
// for the same DoS-amplification reason. Mirror the fail-closed posture
// of `build_dtls12_server`.
if cfg.require_cookie && cfg.cookie_secret.is_none() {
return Err(Error::InappropriateState);
}
let chain = id.cert_chain.clone();
let server_key = id.key.to_server_key_13();
let mut sc = crate::dtls::ServerConfig13Internal::with_signing_key(chain, server_key);
if let Some(secret) = cfg.cookie_secret {
sc = sc.with_cookie_secret(secret);
}
if !cfg.require_cookie {
sc = sc.with_no_cookie();
}
sc.key_log = cfg.key_log.clone();
Ok(crate::dtls::DtlsServerConnection13::new(
alloc::sync::Arc::new(sc),
Vec::new(),
config_rng(cfg)?,
))
}
fn client_cert_from_signing(id: &super::config::Identity) -> Option<super::conn::ClientCertConfig> {
Some(match &id.key {
super::config::SigningKey::Rsa(k) => {
super::conn::ClientCertConfig::with_rsa(id.cert_chain.clone(), k.clone())
}
super::config::SigningKey::Ecdsa(k) => {
super::conn::ClientCertConfig::with_ecdsa(id.cert_chain.clone(), k.clone())
}
super::config::SigningKey::Ed25519(k) => {
super::conn::ClientCertConfig::with_ed25519(id.cert_chain.clone(), k.clone())
}
super::config::SigningKey::Ed448(k) => {
super::conn::ClientCertConfig::with_ed448(id.cert_chain.clone(), k.clone())
}
super::config::SigningKey::MlDsa44(k) => {
super::conn::ClientCertConfig::with_mldsa44(id.cert_chain.clone(), k.clone())
}
super::config::SigningKey::MlDsa65(k) => {
super::conn::ClientCertConfig::with_mldsa65(id.cert_chain.clone(), k.clone())
}
super::config::SigningKey::MlDsa87(k) => {
super::conn::ClientCertConfig::with_mldsa87(id.cert_chain.clone(), k.clone())
}
super::config::SigningKey::External { schemes } => {
super::conn::ClientCertConfig::with_external(id.cert_chain.clone(), schemes.clone())
}
})
}
#[cfg(test)]
mod tests {
use super::super::config::EntropySource;
use super::*;
use crate::ec::{BoxedEcdsaPrivateKey, CurveId};
use crate::hash::Sha256;
use crate::rng::HmacDrbg;
use crate::x509::{CertSigner, Certificate, DistinguishedName, Time, Validity};
/// Build a minimal DTLS server [`Config`] (P-256 ECDSA leaf, self-signed)
/// with `require_cookie` defaulted to true and `cookie_secret = None`.
fn dtls_server_cfg_without_cookie_secret(max_version: ProtocolVersion) -> Config {
let mut rng = HmacDrbg::<Sha256>::new(b"h3-dtls-cookie", b"nonce", &[]);
let key = BoxedEcdsaPrivateKey::generate(CurveId::P256, &mut rng);
let name = DistinguishedName::common_name("dtls.example");
let validity = Validity::new(
Time::utc(2024, 1, 1, 0, 0, 0),
Time::utc(2034, 1, 1, 0, 0, 0),
);
let cert = Certificate::self_signed_general(
&CertSigner::Ecdsa(&key),
&name,
&validity,
1,
false,
&["dtls.example"],
)
.unwrap();
Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(max_version, max_version)
.identity(
alloc::vec![cert.to_der().to_vec()],
super::super::config::SigningKey::Ecdsa(key),
)
.build()
}
// RFC 6347 §4.2.1 / RFC 9147 §5.1: the cookie exchange is the DoS-
// amplification mitigation. A server that intends to require it but
// forgot to wire a cookie secret used to silently downgrade to "no
// cookies" — the AND-combine of `require_cookie && cookie_secret`.
// Fail-closed: refuse to construct the engine.
#[test]
fn dtls_server_refuses_construction_without_cookie_secret() {
// DTLS 1.2 path.
let cfg = dtls_server_cfg_without_cookie_secret(ProtocolVersion::DTLSv1_2);
assert!(cfg.require_cookie);
assert!(cfg.cookie_secret.is_none());
match Connection::server(&cfg) {
Err(Error::InappropriateState) => {}
Err(e) => panic!("expected InappropriateState, got {e:?}"),
Ok(_) => panic!("DTLS 1.2 server must refuse construction"),
}
// DTLS 1.3 path.
let cfg = dtls_server_cfg_without_cookie_secret(ProtocolVersion::DTLSv1_3);
match Connection::server(&cfg) {
Err(Error::InappropriateState) => {}
Err(e) => panic!("expected InappropriateState, got {e:?}"),
Ok(_) => panic!("DTLS 1.3 server must refuse construction"),
}
// Explicit secret -> allowed.
let mut cfg = dtls_server_cfg_without_cookie_secret(ProtocolVersion::DTLSv1_3);
cfg.cookie_secret = Some([0x42u8; 32]);
assert!(Connection::server(&cfg).is_ok());
// Explicit opt-out (require_cookie = false) -> allowed.
let mut cfg = dtls_server_cfg_without_cookie_secret(ProtocolVersion::DTLSv1_3);
cfg.require_cookie = false;
assert!(Connection::server(&cfg).is_ok());
}
/// `server_name` is required only when certificate verification is on.
///
/// When verifying (audit F1), a missing name must be rejected at
/// construction rather than silently substituted — the old `"localhost"`
/// substitution was a footgun, since any local cert listing `localhost` as a
/// SAN would then satisfy verification for an unintended peer. But with
/// verification *off* there is nothing to verify against, so a name is
/// optional (e.g. connecting to a device by IP); the engines simply omit the
/// SNI extension. This holds across every TLS/DTLS engine path.
#[test]
fn client_server_name_required_only_when_verifying() {
for v in [
ProtocolVersion::TLSv1_3,
ProtocolVersion::TLSv1_2,
ProtocolVersion::DTLSv1_3,
ProtocolVersion::DTLSv1_2,
] {
// verify on (default) + no server_name → rejected at construction.
let cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(v, v)
.build();
assert!(cfg.verify_certificates && cfg.server_name.is_none());
match Connection::client(&cfg) {
Err(Error::MissingServerName) => {}
Err(e) => panic!("{v:?}: expected MissingServerName, got {e:?}"),
Ok(_) => panic!("{v:?}: verifying client must require server_name"),
}
// verify off + no server_name → allowed (no SNI, no hostname check).
let cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(v, v)
.verify_certificates(false)
.build();
assert!(cfg.server_name.is_none());
assert!(
Connection::client(&cfg).is_ok(),
"{v:?}: verify-off client must not require server_name"
);
// With an explicit server_name, construction succeeds either way.
let cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(v, v)
.verify_certificates(false)
.server_name("example.test")
.build();
assert!(Connection::client(&cfg).is_ok(), "{v:?}: explicit SNI ok");
}
}
/// A non-empty `cipher_suites` restriction that excludes every suite the
/// configured version supports must refuse construction. The old
/// behaviour silently fell back to the engine's full default set, so a
/// typo'd suite ID (or a list meant for the other protocol version)
/// re-enabled everything the caller had deliberately disabled.
#[test]
fn cipher_suite_restriction_with_no_match_fails_closed() {
let client_cfg = |max: ProtocolVersion, suites: &[u16]| {
Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(max, max)
.verify_certificates(false)
.server_name("example.test")
.cipher_suites(suites)
.build()
};
// A TLS-1.3-only list handed to the TLS 1.2 engine, and vice versa.
for (v, suites) in [
(ProtocolVersion::TLSv1_2, &[0x1301u16, 0x1302, 0x1303][..]),
(ProtocolVersion::TLSv1_3, &[0xC02Fu16, 0xC030][..]),
// A typo'd / unknown codepoint matching nothing at all.
(ProtocolVersion::TLSv1_3, &[0x1300u16][..]),
// Explicitly empty is a vacuous restriction, not "defaults".
(ProtocolVersion::TLSv1_2, &[][..]),
] {
match Connection::client(&client_cfg(v, suites)) {
Err(Error::NoUsableCipherSuites) => {}
Err(e) => panic!("{v:?}/{suites:?}: expected NoUsableCipherSuites, got {e:?}"),
Ok(_) => panic!("{v:?}/{suites:?}: empty intersection must fail closed"),
}
}
// A list that matches at least one suite of the engine's version
// range still constructs — extra IDs from the other version are
// simply not offered.
let cfg = client_cfg(ProtocolVersion::TLSv1_2, &[0x1301, 0xC02F]);
assert!(Connection::client(&cfg).is_ok(), "partial match must work");
let cfg = client_cfg(ProtocolVersion::TLSv1_3, &[0x1301, 0xC02F]);
assert!(Connection::client(&cfg).is_ok(), "partial match must work");
// Unset (None) keeps meaning "offer the defaults".
let cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.verify_certificates(false)
.server_name("example.test")
.build();
assert!(cfg.cipher_suites.is_none());
assert!(Connection::client(&cfg).is_ok());
}
/// `cipher_suite_name` covers every suite the negotiator can pick,
/// plus the unknown-fallback case.
#[test]
fn cipher_suite_name_table() {
assert_eq!(cipher_suite_name(0x1301), "TLS_AES_128_GCM_SHA256");
assert_eq!(cipher_suite_name(0x1302), "TLS_AES_256_GCM_SHA384");
assert_eq!(cipher_suite_name(0x1303), "TLS_CHACHA20_POLY1305_SHA256");
assert_eq!(
cipher_suite_name(0xC02B),
"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256"
);
assert_eq!(
cipher_suite_name(0xC02C),
"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"
);
assert_eq!(
cipher_suite_name(0xC02F),
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
);
assert_eq!(
cipher_suite_name(0xC030),
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
);
assert_eq!(
cipher_suite_name(0xCCA8),
"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256"
);
assert_eq!(
cipher_suite_name(0xCCA9),
"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256"
);
assert_eq!(cipher_suite_name(0xFFFF), "UNKNOWN");
}
/// Before any wire bytes are exchanged the suite is undetermined on
/// every engine variant. (Once the handshake progresses far enough
/// the existing per-engine loopback tests in `tls::conn::mod` /
/// `dtls::*` verify the positive case.)
#[test]
fn negotiated_cipher_suite_is_none_before_handshake() {
let mut rng = HmacDrbg::<Sha256>::new(b"suite-none", b"nonce", &[]);
let key = BoxedEcdsaPrivateKey::generate(CurveId::P256, &mut rng);
let validity = Validity::new(
Time::utc(2024, 1, 1, 0, 0, 0),
Time::utc(2034, 1, 1, 0, 0, 0),
);
let cert = Certificate::self_signed_general(
&CertSigner::Ecdsa(&key),
&DistinguishedName::common_name("suite.example"),
&validity,
1,
false,
&["suite.example"],
)
.unwrap();
// TLS 1.3 client (cipher selected from ServerHello — None
// before any bytes flow in).
let cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.tls_only()
.server_name("suite.example")
.build();
let client = Connection::client(&cfg).unwrap();
assert!(client.negotiated_cipher_suite().is_none());
assert!(client.negotiated_cipher_suite_name().is_none());
// TLS 1.3 server (cipher selected during ClientHello dispatch).
let cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.tls_only()
.identity(
alloc::vec![cert.to_der().to_vec()],
super::super::config::SigningKey::Ecdsa(key),
)
.build();
let server = Connection::server(&cfg).unwrap();
assert!(server.negotiated_cipher_suite().is_none());
}
/// A caller-supplied [`EntropySource`] (here an HMAC-DRBG behind a mutex)
/// must feed every server-side random draw — server random, ephemeral
/// (EC)DHE key, signature salts — so a full TLS 1.3 handshake completes
/// with `Config::rng` set instead of the default `OsRng`.
#[test]
fn server_drives_handshake_from_injected_entropy_source() {
struct DrbgSource(std::sync::Mutex<HmacDrbg<Sha256>>);
impl EntropySource for DrbgSource {
fn fill(&self, dest: &mut [u8]) {
self.0.lock().unwrap().fill_bytes(dest);
}
}
let mut kg = HmacDrbg::<Sha256>::new(b"rng-inject-leaf", b"nonce", &[]);
let key = BoxedEcdsaPrivateKey::generate(CurveId::P256, &mut kg);
let name = DistinguishedName::common_name("rng.example");
let validity = Validity::new(
Time::utc(2024, 1, 1, 0, 0, 0),
Time::utc(2034, 1, 1, 0, 0, 0),
);
let cert = Certificate::self_signed_general(
&CertSigner::Ecdsa(&key),
&name,
&validity,
1,
false,
&["rng.example"],
)
.unwrap();
let source: alloc::sync::Arc<dyn EntropySource> = alloc::sync::Arc::new(DrbgSource(
std::sync::Mutex::new(HmacDrbg::<Sha256>::new(b"entropy-source", b"nonce", &[])),
));
let server_cfg = Config::builder()
.tls_only()
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.identity(
alloc::vec![cert.to_der().to_vec()],
super::super::config::SigningKey::Ecdsa(key),
)
.rng(source)
.build();
let client_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.verify_certificates(false)
.server_name("rng.example")
.build();
let mut server = Connection::server(&server_cfg).unwrap();
let mut client = Connection::client(&client_cfg).unwrap();
// Pump client <-> server until both sides finish (TLS 1.3 is 1-RTT, so
// a handful of iterations is plenty).
for _ in 0..16 {
loop {
let out = client.pop().unwrap();
if out.is_empty() {
break;
}
server.feed(&out).unwrap();
}
loop {
let out = server.pop().unwrap();
if out.is_empty() {
break;
}
client.feed(&out).unwrap();
}
if client.is_handshake_complete() && server.is_handshake_complete() {
break;
}
}
assert!(
client.is_handshake_complete() && server.is_handshake_complete(),
"TLS 1.3 handshake must complete using the injected EntropySource"
);
}
/// The sans-I/O engine never invents entropy: a `Config` with no
/// `EntropySource` fails closed at construction rather than reaching for a
/// hidden `OsRng`. Covers both roles across TLS and DTLS.
#[test]
fn construction_requires_an_entropy_source() {
for v in [
ProtocolVersion::TLSv1_3,
ProtocolVersion::TLSv1_2,
ProtocolVersion::DTLSv1_3,
ProtocolVersion::DTLSv1_2,
] {
// Client: no rng, verification off + a name so server_name is not
// the failure → the missing entropy source must be what trips.
let client_cfg = Config::builder()
.versions(v, v)
.verify_certificates(false)
.server_name("rng.example")
.build();
assert!(client_cfg.rng.is_none());
assert!(matches!(
Connection::client(&client_cfg),
Err(Error::MissingEntropySource)
));
// Same config but WITH an OsRng source constructs fine.
let ok_cfg = Config::builder()
.versions(v, v)
.verify_certificates(false)
.server_name("rng.example")
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.build();
assert!(Connection::client(&ok_cfg).is_ok());
}
// Server path (TLS 1.3): an identity but no rng → MissingEntropySource.
let (key, leaf) = ecdsa_p256_identity();
let server_cfg = Config::builder()
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.identity(
alloc::vec![leaf],
super::super::config::SigningKey::Ecdsa(key),
)
.build();
assert!(matches!(
Connection::server(&server_cfg),
Err(Error::MissingEntropySource)
));
}
/// A self-signed ECDSA P-256 leaf + its key (seeded for reproducibility),
/// for external-signing tests. `cn` is used as both the subject CN and the
/// single DNS SAN.
fn ecdsa_identity(seed: &[u8], cn: &str) -> (BoxedEcdsaPrivateKey, Vec<u8>) {
let mut kg = HmacDrbg::<Sha256>::new(seed, b"nonce", &[]);
let key = BoxedEcdsaPrivateKey::generate(CurveId::P256, &mut kg);
let name = DistinguishedName::common_name(cn);
let validity = Validity::new(
Time::utc(2024, 1, 1, 0, 0, 0),
Time::utc(2034, 1, 1, 0, 0, 0),
);
let cert = Certificate::self_signed_general(
&CertSigner::Ecdsa(&key),
&name,
&validity,
1,
// A self-signed cert used as a client-auth trust anchor must be a CA.
true,
&[cn],
)
.unwrap();
(key, cert.to_der().to_vec())
}
/// A self-signed ECDSA P-256 leaf + its key, for external-signing tests.
fn ecdsa_p256_identity() -> (BoxedEcdsaPrivateKey, Vec<u8>) {
ecdsa_identity(b"ext-sign-leaf", "ext.example")
}
/// A TLS 1.3 server using `SigningKey::External` completes the handshake
/// when the caller fulfils the `signature_request` out-of-band (here with
/// an in-process ECDSA key standing in for an HSM). Completion implies the
/// client verified the externally-produced CertificateVerify, so the
/// suspend/resume produces a wire-valid signature.
#[test]
fn server_external_signing_round_trips() {
const ECDSA_SECP256R1_SHA256: u16 = 0x0403;
let (key, leaf) = ecdsa_p256_identity();
let server_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.identity(
alloc::vec![leaf],
super::super::config::SigningKey::External {
schemes: alloc::vec![ECDSA_SECP256R1_SHA256],
},
)
.build();
let client_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.verify_certificates(false)
.server_name("ext.example")
.build();
let mut server = Connection::server(&server_cfg).unwrap();
let mut client = Connection::client(&client_cfg).unwrap();
let mut signed = false;
for _ in 0..32 {
loop {
let out = client.pop().unwrap();
if out.is_empty() {
break;
}
server.feed(&out).unwrap();
}
// Fulfil a pending external signature: sign exactly as the in-process
// ECDSA path would (P-256 → ECDSA-SHA256, DER-encoded).
if let Some(req) = server.signature_request() {
assert_eq!(req.scheme, ECDSA_SECP256R1_SHA256);
let sig = key
.sign::<Sha256>(&req.message)
.unwrap()
.to_der(CurveId::P256);
server.provide_signature(sig).unwrap();
signed = true;
}
loop {
let out = server.pop().unwrap();
if out.is_empty() {
break;
}
client.feed(&out).unwrap();
}
if client.is_handshake_complete() && server.is_handshake_complete() {
break;
}
}
assert!(
signed,
"the server must have requested an external signature"
);
assert!(
client.is_handshake_complete() && server.is_handshake_complete(),
"external-signed TLS 1.3 handshake must complete and verify"
);
}
/// mTLS with an **external client** key: the client's `CertificateVerify`
/// is produced out-of-band via the suspend/resume API, and the server (which
/// requires and verifies client auth) completes the handshake — proving the
/// externally-produced client signature verified.
#[test]
fn client_mtls_external_signing_round_trips() {
const ECDSA_SECP256R1_SHA256: u16 = 0x0403;
let (server_key, server_leaf) = ecdsa_identity(b"mtls-server", "srv.example");
let (client_key, client_leaf) = ecdsa_identity(b"mtls-client", "cli.example");
// Server: inline identity; requires + verifies client auth against the
// client's self-signed cert as trust anchor.
let mut roots = crate::tls::RootCertStore::new();
roots.add_der(client_leaf.clone()).unwrap();
let server_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.identity(
alloc::vec![server_leaf],
super::super::config::SigningKey::Ecdsa(server_key),
)
.client_auth(crate::tls::ClientAuth::new(roots, true))
.build();
// Client: external identity; does not verify the server here.
let client_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.verify_certificates(false)
.server_name("srv.example")
.identity(
alloc::vec![client_leaf],
super::super::config::SigningKey::External {
schemes: alloc::vec![ECDSA_SECP256R1_SHA256],
},
)
.build();
let mut server = Connection::server(&server_cfg).unwrap();
let mut client = Connection::client(&client_cfg).unwrap();
let mut signed = false;
for _ in 0..32 {
loop {
let out = client.pop().unwrap();
if out.is_empty() {
break;
}
server.feed(&out).unwrap();
}
loop {
let out = server.pop().unwrap();
if out.is_empty() {
break;
}
client.feed(&out).unwrap();
}
// The client suspends to sign its own CertificateVerify.
if let Some(req) = client.signature_request() {
assert_eq!(req.scheme, ECDSA_SECP256R1_SHA256);
let sig = client_key
.sign::<Sha256>(&req.message)
.unwrap()
.to_der(CurveId::P256);
client.provide_signature(sig).unwrap();
signed = true;
}
if client.is_handshake_complete() && server.is_handshake_complete() {
break;
}
}
assert!(
signed,
"the client must have requested an external signature"
);
assert!(
client.is_handshake_complete() && server.is_handshake_complete(),
"external-signed client mTLS handshake must complete and verify"
);
}
/// A DTLS 1.3 server using `SigningKey::External` completes the handshake
/// when the caller fulfils `signature_request` out-of-band — the
/// suspend/resume path works over the datagram engine too.
#[test]
fn dtls13_server_external_signing_round_trips() {
const ECDSA_SECP256R1_SHA256: u16 = 0x0403;
let (key, leaf) = ecdsa_identity(b"dtls-ext", "dtls.example");
let mut server_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::DTLSv1_3, ProtocolVersion::DTLSv1_3)
.identity(
alloc::vec![leaf],
super::super::config::SigningKey::External {
schemes: alloc::vec![ECDSA_SECP256R1_SHA256],
},
)
.build();
// Keep the test single-round: skip the cookie exchange.
server_cfg.require_cookie = false;
let client_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::DTLSv1_3, ProtocolVersion::DTLSv1_3)
.verify_certificates(false)
.server_name("dtls.example")
.build();
let mut server = Connection::server(&server_cfg).unwrap();
let mut client = Connection::client(&client_cfg).unwrap();
let mut signed = false;
for _ in 0..64 {
loop {
let out = client.pop().unwrap();
if out.is_empty() {
break;
}
server.feed(&out).unwrap();
}
if let Some(req) = server.signature_request() {
assert_eq!(req.scheme, ECDSA_SECP256R1_SHA256);
let sig = key
.sign::<Sha256>(&req.message)
.unwrap()
.to_der(CurveId::P256);
server.provide_signature(sig).unwrap();
signed = true;
}
loop {
let out = server.pop().unwrap();
if out.is_empty() {
break;
}
client.feed(&out).unwrap();
}
if client.is_handshake_complete() && server.is_handshake_complete() {
break;
}
}
assert!(
signed,
"the DTLS server must have requested an external signature"
);
assert!(
client.is_handshake_complete() && server.is_handshake_complete(),
"external-signed DTLS 1.3 handshake must complete and verify"
);
}
/// DTLS 1.2 signs the `ServerKeyExchange` (not a CertificateVerify), so the
/// suspend/resume seam sits at a different point in the flight than 1.3.
/// Drive a full loopback handshake where the server's identity is an
/// `External` ECDSA key and the test "HSM" signs the SKE bytes out-of-band.
#[test]
fn dtls12_server_external_signing_round_trips() {
const ECDSA_SECP256R1_SHA256: u16 = 0x0403;
let (key, leaf) = ecdsa_identity(b"dtls12-ext", "dtls12.example");
let mut server_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::DTLSv1_2, ProtocolVersion::DTLSv1_2)
.identity(
alloc::vec![leaf],
super::super::config::SigningKey::External {
schemes: alloc::vec![ECDSA_SECP256R1_SHA256],
},
)
.build();
// Keep the test single-round: skip the cookie exchange.
server_cfg.require_cookie = false;
let client_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::DTLSv1_2, ProtocolVersion::DTLSv1_2)
.verify_certificates(false)
.server_name("dtls12.example")
.build();
let mut server = Connection::server(&server_cfg).unwrap();
let mut client = Connection::client(&client_cfg).unwrap();
let mut signed = false;
for _ in 0..64 {
loop {
let out = client.pop().unwrap();
if out.is_empty() {
break;
}
server.feed(&out).unwrap();
}
if let Some(req) = server.signature_request() {
assert_eq!(req.scheme, ECDSA_SECP256R1_SHA256);
let sig = key
.sign::<Sha256>(&req.message)
.unwrap()
.to_der(CurveId::P256);
server.provide_signature(sig).unwrap();
signed = true;
}
loop {
let out = server.pop().unwrap();
if out.is_empty() {
break;
}
client.feed(&out).unwrap();
}
if client.is_handshake_complete() && server.is_handshake_complete() {
break;
}
}
assert!(
signed,
"the DTLS 1.2 server must have requested an external signature"
);
assert!(
client.is_handshake_complete() && server.is_handshake_complete(),
"external-signed DTLS 1.2 handshake must complete and verify"
);
}
/// If the client offers no signature scheme the external key advertises,
/// the server aborts the handshake (handshake_failure) rather than stalling.
#[test]
fn server_external_signing_rejects_disjoint_schemes() {
// Advertise only an unassigned scheme no client ever offers, so the
// intersection with the ClientHello's signature_algorithms is empty.
const UNOFFERED: u16 = 0xFFFF;
let (_key, leaf) = ecdsa_p256_identity();
let server_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.identity(
alloc::vec![leaf],
super::super::config::SigningKey::External {
schemes: alloc::vec![UNOFFERED],
},
)
.build();
let client_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.verify_certificates(false)
.server_name("ext.example")
.build();
let mut server = Connection::server(&server_cfg).unwrap();
let mut client = Connection::client(&client_cfg).unwrap();
let ch = client.pop().unwrap();
// The server rejects the ClientHello: no scheme its key can produce was
// offered. It must error, not suspend awaiting a signature.
let res = server.feed(&ch);
assert!(
res.is_err(),
"disjoint signature schemes must fail the handshake"
);
assert!(server.signature_request().is_none());
}
/// `Connection::drive()` brokers an in-process key through the transparent
/// `HandshakeSigner` path (via `LocalSigner`) without ever yielding `WantSigner`:
/// the same loop a device key would use also completes a normal handshake.
#[test]
fn drive_with_local_signer_completes_without_signer_step() {
use super::super::signer::LocalSigner;
use alloc::sync::Arc;
let (key, leaf) = ecdsa_p256_identity();
let server_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.private_key(
alloc::vec![leaf],
Arc::new(LocalSigner::new(super::super::config::SigningKey::Ecdsa(
key,
))),
)
.build();
let client_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.verify_certificates(false)
.server_name("ext.example")
.build();
let mut server = Connection::server(&server_cfg).unwrap();
let mut client = Connection::client(&client_cfg).unwrap();
// Drive the server via drive(); the client via the plain loop.
let mut saw_signer_step = false;
for _ in 0..32 {
loop {
let out = client.pop().unwrap();
if out.is_empty() {
break;
}
server.feed(&out).unwrap();
}
// Pump the server with drive() until it needs peer bytes / is done.
loop {
match server.drive().unwrap() {
Step::WantWrite => {
let out = server.pop().unwrap();
if out.is_empty() {
break;
}
client.feed(&out).unwrap();
}
Step::WantSigner(_) => saw_signer_step = true,
Step::WantRead | Step::Complete => break,
}
}
if client.is_handshake_complete() && server.is_handshake_complete() {
break;
}
}
assert!(
!saw_signer_step,
"an in-process LocalSigner must never yield WantSigner"
);
assert!(client.is_handshake_complete() && server.is_handshake_complete());
}
/// A device-backed `HandshakeSigner` whose `SignOp` returns `Pending` once
/// (exposing a real, readable fd) before producing the signature drives a
/// full handshake through `drive()` — exercising the `WantSigner` path and
/// `Readiness::wait()`. The "device" is an in-process ECDSA key behind a
/// `UnixStream` whose peer end is pre-armed so `wait()` returns at once.
#[cfg(unix)]
#[test]
fn drive_with_device_signer_round_trips() {
use super::super::signer::{HandshakeSigner, Readiness, SignOp, SignProgress};
use alloc::sync::Arc;
use std::os::fd::{AsFd, AsRawFd};
use std::os::unix::net::UnixStream;
const ECDSA_SECP256R1_SHA256: u16 = 0x0403;
struct DeviceKey {
key: BoxedEcdsaPrivateKey,
}
struct DeviceOp {
key: BoxedEcdsaPrivateKey,
message: Vec<u8>,
// `near` is the fd we expose; `_far` keeps the peer end (and its
// pre-written byte) alive so `near` stays readable.
near: UnixStream,
_far: UnixStream,
polled: bool,
}
impl HandshakeSigner for DeviceKey {
fn schemes(&self) -> Vec<u16> {
alloc::vec![ECDSA_SECP256R1_SHA256]
}
fn start_sign(&self, _scheme: u16, message: &[u8]) -> Result<Box<dyn SignOp>, Error> {
use std::io::Write;
let (near, mut far) = UnixStream::pair().unwrap();
// Pre-arm: a byte already waiting makes `near` readable, so the
// test's wait() returns immediately (no real device latency).
far.write_all(b"x").unwrap();
Ok(Box::new(DeviceOp {
key: self.key.clone(),
message: message.to_vec(),
near,
_far: far,
polled: false,
}))
}
}
impl SignOp for DeviceOp {
fn resume(&mut self) -> Result<SignProgress, Error> {
if !self.polled {
// First step: not ready yet — make the caller wait.
self.polled = true;
return Ok(SignProgress::Pending);
}
let sig = self
.key
.sign::<Sha256>(&self.message)
.unwrap()
.to_der(CurveId::P256);
Ok(SignProgress::Done(sig))
}
fn readiness(&self) -> Option<Readiness> {
Some(Readiness::from_raw_fd(self.near.as_raw_fd()))
}
}
let (key, leaf) = ecdsa_p256_identity();
let server_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.private_key(alloc::vec![leaf], Arc::new(DeviceKey { key }))
.build();
let client_cfg = Config::builder()
.rng(alloc::sync::Arc::new(crate::rng::OsRng))
.versions(ProtocolVersion::TLSv1_3, ProtocolVersion::TLSv1_3)
.verify_certificates(false)
.server_name("ext.example")
.build();
let mut server = Connection::server(&server_cfg).unwrap();
let mut client = Connection::client(&client_cfg).unwrap();
let mut waited = false;
for _ in 0..32 {
loop {
let out = client.pop().unwrap();
if out.is_empty() {
break;
}
server.feed(&out).unwrap();
}
loop {
match server.drive().unwrap() {
Step::WantWrite => {
let out = server.pop().unwrap();
if out.is_empty() {
break;
}
client.feed(&out).unwrap();
}
Step::WantSigner(r) => {
if let Some(r) = r {
// Exercise the async-facing seam too: the std fd
// traits must yield the same valid descriptor an
// `AsyncFd`/`SourceFd` would register.
assert!(r.as_raw_fd() >= 0);
assert_eq!(r.as_fd().as_raw_fd(), r.as_raw_fd());
// Then the sync path: block until readable.
r.wait().unwrap();
waited = true;
}
}
Step::WantRead | Step::Complete => break,
}
}
if client.is_handshake_complete() && server.is_handshake_complete() {
break;
}
}
assert!(waited, "the device SignOp must have suspended on its fd");
assert!(
client.is_handshake_complete() && server.is_handshake_complete(),
"device-signed handshake must complete and verify"
);
}
}