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
// Copyright 2020 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//! Parsing and serialization for DHCPv6 messages.
use {
mdns::protocol::{Domain, ParseError as MdnsParseError},
net_types::ip::{IpAddress as _, Ipv6Addr, PrefixTooLongError, Subnet},
num_derive::FromPrimitive,
packet::{
records::{
ParsedRecord, RecordBuilder, RecordParseResult, RecordSequenceBuilder, Records,
RecordsImpl, RecordsImplLayout,
},
BufferView, BufferViewMut, InnerPacketBuilder, ParsablePacket, ParseMetadata,
},
std::{convert::Infallible as Never, mem, slice::Iter, str},
thiserror::Error,
uuid::Uuid,
zerocopy::{
byteorder::network_endian::{U16, U32},
AsBytes, ByteSlice, FromBytes, FromZeros, NoCell, Ref, Unaligned,
},
};
/// A DHCPv6 packet parsing error.
#[allow(missing_docs)]
#[derive(Debug, Error, PartialEq)]
pub enum ParseError {
#[error("invalid message type: {}", _0)]
InvalidMessageType(u8),
#[error("invalid option code: {}", _0)]
InvalidOpCode(u16),
#[error("invalid option length {} for option code {:?}", _1, _0)]
InvalidOpLen(OptionCode, usize),
#[error("invalid status code: {}", _0)]
InvalidStatusCode(u16),
#[error("invalid error status code: {}", _0)]
InvalidErrorStatusCode(u16),
#[error("buffer exhausted while more bytes are expected")]
BufferExhausted,
#[error("failed to parse domain {:?}", _0)]
DomainParseError(MdnsParseError),
#[error("failed to parse UTF8 string: {:?}", _0)]
Utf8Error(#[from] str::Utf8Error),
}
impl From<Never> for ParseError {
fn from(err: Never) -> ParseError {
match err {}
}
}
/// A DHCPv6 message type as defined in [RFC 8415, Section 7.3].
///
/// [RFC 8415, Section 7.3]: https://tools.ietf.org/html/rfc8415#section-7.3
#[allow(missing_docs)]
#[derive(Debug, PartialEq, FromPrimitive, AsBytes, NoCell, Copy, Clone)]
#[repr(u8)]
pub enum MessageType {
Solicit = 1,
Advertise = 2,
Request = 3,
Confirm = 4,
Renew = 5,
Rebind = 6,
Reply = 7,
Release = 8,
Decline = 9,
Reconfigure = 10,
InformationRequest = 11,
RelayForw = 12,
RelayRepl = 13,
}
impl From<MessageType> for u8 {
fn from(t: MessageType) -> u8 {
t as u8
}
}
impl TryFrom<u8> for MessageType {
type Error = ParseError;
fn try_from(b: u8) -> Result<MessageType, ParseError> {
<Self as num_traits::FromPrimitive>::from_u8(b).ok_or(ParseError::InvalidMessageType(b))
}
}
/// A DHCPv6 status code as defined in [RFC 8415, Section 21.13].
///
/// [RFC 8415, Section 21.13]: https://tools.ietf.org/html/rfc8415#section-21.13
#[allow(missing_docs)]
#[derive(Debug, PartialEq, Copy, Clone)]
pub enum StatusCode {
Success,
Failure(ErrorStatusCode),
}
impl From<StatusCode> for u16 {
fn from(t: StatusCode) -> u16 {
match t {
StatusCode::Success => 0,
StatusCode::Failure(error_status) => error_status.into(),
}
}
}
impl TryFrom<u16> for StatusCode {
type Error = ParseError;
fn try_from(b: u16) -> Result<StatusCode, ParseError> {
match b {
0 => Ok(Self::Success),
b => ErrorStatusCode::try_from(b).map(Self::Failure).map_err(|e| match e {
ParseError::InvalidErrorStatusCode(b) => ParseError::InvalidStatusCode(b),
e => unreachable!("unexpected error parsing u16 as ErrorStatusCode: {}", e),
}),
}
}
}
impl StatusCode {
/// Converts into either `Ok(())` if the status code is Success or an error
/// containing the failure status code.
pub fn into_result(self) -> Result<(), ErrorStatusCode> {
match self {
Self::Success => Ok(()),
Self::Failure(error_status) => Err(error_status),
}
}
}
/// A DHCPv6 error status code as defined in [RFC 8415, Section 21.13].
///
/// [RFC 8415, Section 21.13]: https://tools.ietf.org/html/rfc8415#section-21.13
#[allow(missing_docs)]
#[derive(thiserror::Error, Debug, PartialEq, FromPrimitive, AsBytes, NoCell, Copy, Clone)]
#[repr(u16)]
pub enum ErrorStatusCode {
#[error("unspecified failure")]
UnspecFail = 1,
#[error("no addresses available")]
NoAddrsAvail = 2,
#[error("no binding")]
NoBinding = 3,
#[error("not on-link")]
NotOnLink = 4,
#[error("use multicast")]
UseMulticast = 5,
#[error("no prefixes available")]
NoPrefixAvail = 6,
}
impl From<ErrorStatusCode> for u16 {
fn from(code: ErrorStatusCode) -> u16 {
code as u16
}
}
impl From<ErrorStatusCode> for StatusCode {
fn from(code: ErrorStatusCode) -> Self {
Self::Failure(code)
}
}
impl TryFrom<u16> for ErrorStatusCode {
type Error = ParseError;
fn try_from(b: u16) -> Result<Self, ParseError> {
<Self as num_traits::FromPrimitive>::from_u16(b)
.ok_or(ParseError::InvalidErrorStatusCode(b))
}
}
/// A DHCPv6 option code that identifies a corresponding option.
///
/// Options that are not found in this type are currently not supported. An exhaustive list of
/// option codes can be found [here][option-codes].
///
/// [option-codes]: https://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xhtml#dhcpv6-parameters-2
#[allow(missing_docs)]
#[derive(Debug, PartialEq, FromPrimitive, Clone, Copy)]
#[repr(u8)]
pub enum OptionCode {
ClientId = 1,
ServerId = 2,
Iana = 3,
IaAddr = 5,
Oro = 6,
Preference = 7,
ElapsedTime = 8,
StatusCode = 13,
DnsServers = 23,
DomainList = 24,
IaPd = 25,
IaPrefix = 26,
InformationRefreshTime = 32,
SolMaxRt = 82,
}
impl From<OptionCode> for u16 {
fn from(code: OptionCode) -> u16 {
code as u16
}
}
impl TryFrom<u16> for OptionCode {
type Error = ParseError;
fn try_from(n: u16) -> Result<OptionCode, ParseError> {
<Self as num_traits::FromPrimitive>::from_u16(n).ok_or(ParseError::InvalidOpCode(n))
}
}
/// A parsed DHCPv6 options.
///
/// Options that are not found in this type are currently not supported. An exhaustive list of
/// options can be found [here][options].
///
/// [options]: https://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xhtml#dhcpv6-parameters-2
// TODO(https://fxbug.dev/42155425): replace `ParsedDhcpOption` and `DhcpOption` with a single type.
#[allow(missing_docs)]
#[derive(Debug, PartialEq)]
pub enum ParsedDhcpOption<'a> {
// https://tools.ietf.org/html/rfc8415#section-21.2
ClientId(&'a Duid),
// https://tools.ietf.org/html/rfc8415#section-21.3
ServerId(&'a Duid),
// https://tools.ietf.org/html/rfc8415#section-21.4
// TODO(https://fxbug.dev/42154013): add validation; not all option codes can
// be present in an IA_NA option.
Iana(IanaData<&'a [u8]>),
// https://tools.ietf.org/html/rfc8415#section-21.6
// TODO(https://fxbug.dev/42154013): add validation; not all option codes can
// be present in an IA Address option.
IaAddr(IaAddrData<&'a [u8]>),
// https://tools.ietf.org/html/rfc8415#section-21.7
// TODO(https://fxbug.dev/42154013): add validation; not all option codes can
// be present in an ORO option.
// See https://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xhtml#dhcpv6-parameters-2
Oro(Vec<OptionCode>),
// https://tools.ietf.org/html/rfc8415#section-21.8
Preference(u8),
// https://tools.ietf.org/html/rfc8415#section-21.9
ElapsedTime(u16),
// https://tools.ietf.org/html/rfc8415#section-21.13
StatusCode(U16, &'a str),
// https://tools.ietf.org/html/rfc8415#section-21.21
// TODO(https://fxbug.dev/42154013): add validation; not all option codes can
// be present in an IA_PD option.
IaPd(IaPdData<&'a [u8]>),
// ttps://tools.ietf.org/html/rfc8415#section-21.22
// TODO(https://fxbug.dev/42154013): add validation; not all option codes can
// be present in an IA Prefix option.
IaPrefix(IaPrefixData<&'a [u8]>),
// https://tools.ietf.org/html/rfc8415#section-21.23
InformationRefreshTime(u32),
// https://tools.ietf.org/html/rfc8415#section-21.24
SolMaxRt(U32),
// https://tools.ietf.org/html/rfc3646#section-3
DnsServers(Vec<Ipv6Addr>),
// https://tools.ietf.org/html/rfc3646#section-4
DomainList(Vec<checked::Domain>),
}
/// An overlay representation of an IA_NA option.
#[derive(Debug, PartialEq)]
pub struct IanaData<B: ByteSlice> {
header: Ref<B, IanaHeader>,
options: Records<B, ParsedDhcpOptionImpl>,
}
mod private {
/// A `u32` value that is guaranteed to be greater than 0 and less than `u32::MAX`.
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct NonZeroOrMaxU32(u32);
impl NonZeroOrMaxU32 {
/// Constructs a `NonZeroOrMaxU32`.
///
/// Returns `None` if `t` is 0 or `u32::MAX`.
pub const fn new(t: u32) -> Option<NonZeroOrMaxU32> {
if t == 0 || t == u32::MAX {
return None;
}
Some(NonZeroOrMaxU32(t))
}
/// Returns the value.
pub fn get(self) -> u32 {
let NonZeroOrMaxU32(t) = self;
t
}
}
}
pub use private::*;
/// A representation of time values for lifetimes to relay the fact that zero is
/// not a valid time value, and that `Infinity` has special significance, as
/// described in RFC 8415, [section
/// 14.2] and [section 7.7].
///
/// [section 14.2]: https://datatracker.ietf.org/doc/html/rfc8415#section-14.2
/// [section 7.7]: https://datatracker.ietf.org/doc/html/rfc8415#section-7.7
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum NonZeroTimeValue {
/// The value is set to a value greater than 0 and less than `Infinity`.
Finite(NonZeroOrMaxU32),
/// `u32::MAX` representing `Infinity`, as described in
/// [RFC 8415, section 7.7].
///
/// [RFC 8415, section 7.7]: https://datatracker.ietf.org/doc/html/rfc8415#section-7.7
Infinity,
}
impl From<NonZeroTimeValue> for TimeValue {
fn from(v: NonZeroTimeValue) -> TimeValue {
TimeValue::NonZero(v)
}
}
/// A representation of time values for lifetimes to relay the fact that certain
/// values have special significance as described in RFC 8415, [section 14.2]
/// and [section 7.7].
///
/// [section 14.2]: https://datatracker.ietf.org/doc/html/rfc8415#section-14.2
/// [section 7.7]: https://datatracker.ietf.org/doc/html/rfc8415#section-7.7
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum TimeValue {
/// The value is zero.
Zero,
/// The value is non-zero.
NonZero(NonZeroTimeValue),
}
impl TimeValue {
/// Constructs a new `TimeValue`.
pub const fn new(t: u32) -> TimeValue {
match t {
0 => TimeValue::Zero,
u32::MAX => TimeValue::NonZero(NonZeroTimeValue::Infinity),
t => TimeValue::NonZero(NonZeroTimeValue::Finite(
// should succeed for non zero or u32::MAX values
const_unwrap::const_unwrap_option(NonZeroOrMaxU32::new(t)),
)),
}
}
}
impl<'a, B: ByteSlice> IanaData<B> {
/// Constructs a new `IanaData` from a `ByteSlice`.
fn new(buf: B) -> Result<Self, ParseError> {
let buf_len = buf.len();
let (header, options) = Ref::new_unaligned_from_prefix(buf)
.ok_or(ParseError::InvalidOpLen(OptionCode::Iana, buf_len))?;
let options = Records::<B, ParsedDhcpOptionImpl>::parse_with_context(options, ())?;
Ok(IanaData { header, options })
}
/// Returns the IAID.
pub fn iaid(&self) -> u32 {
self.header.iaid.get()
}
/// Returns the T1 as `TimeValue` to relay the fact that certain values have
/// special significance as described in RFC 8415, [section 14.2] and
/// [section 7.7].
///
/// [section 14.2]: https://datatracker.ietf.org/doc/html/rfc8415#section-14.2
/// [section 7.7]: https://datatracker.ietf.org/doc/html/rfc8415#section-7.7
pub fn t1(&self) -> TimeValue {
TimeValue::new(self.header.t1.get())
}
/// Returns the T2 as `TimeValue` to relay the fact that certain values have
/// special significance as described in RFC 8415, [section 14.2] and
/// [section 7.7].
///
/// [section 14.2]: https://datatracker.ietf.org/doc/html/rfc8415#section-14.2
/// [section 7.7]: https://datatracker.ietf.org/doc/html/rfc8415#section-7.7
pub fn t2(&self) -> TimeValue {
TimeValue::new(self.header.t2.get())
}
/// Returns an iterator over the options.
pub fn iter_options(&'a self) -> impl 'a + Iterator<Item = ParsedDhcpOption<'a>> {
self.options.iter()
}
}
/// An overlay for the fixed fields of an IA_NA option.
#[derive(FromZeros, FromBytes, AsBytes, NoCell, Unaligned, Debug, PartialEq, Copy, Clone)]
#[repr(C)]
struct IanaHeader {
iaid: U32,
t1: U32,
t2: U32,
}
/// An overlay representation of an IA Address option.
#[derive(Debug, PartialEq)]
pub struct IaAddrData<B: ByteSlice> {
header: Ref<B, IaAddrHeader>,
options: Records<B, ParsedDhcpOptionImpl>,
}
impl<'a, B: ByteSlice> IaAddrData<B> {
/// Constructs a new `IaAddrData` from a `ByteSlice`.
pub fn new(buf: B) -> Result<Self, ParseError> {
let buf_len = buf.len();
let (header, options) = Ref::new_unaligned_from_prefix(buf)
.ok_or(ParseError::InvalidOpLen(OptionCode::IaAddr, buf_len))?;
let options = Records::<B, ParsedDhcpOptionImpl>::parse_with_context(options, ())?;
Ok(IaAddrData { header, options })
}
/// Returns the address.
pub fn addr(&self) -> Ipv6Addr {
self.header.addr
}
/// Returns the preferred lifetime as `TimeValue` to relay the fact that
/// certain values have special significance as described in
/// [RFC 8415, section 7.7].
///
/// [section 14.2]: https://datatracker.ietf.org/doc/html/rfc8415#section-14.2
/// [section 7.7]: https://datatracker.ietf.org/doc/html/rfc8415#section-7.7
pub fn preferred_lifetime(&self) -> TimeValue {
TimeValue::new(self.header.preferred_lifetime.get())
}
/// Returns the valid lifetime as `TimeValue` to relay the fact that certain
/// values have special significance as described in
/// [RFC 8415, section 7.7].
///
/// [section 14.2]: https://datatracker.ietf.org/doc/html/rfc8415#section-14.2
/// [section 7.7]: https://datatracker.ietf.org/doc/html/rfc8415#section-7.7
pub fn valid_lifetime(&self) -> TimeValue {
TimeValue::new(self.header.valid_lifetime.get())
}
/// Returns an iterator over the options.
pub fn iter_options(&'a self) -> impl 'a + Iterator<Item = ParsedDhcpOption<'a>> {
self.options.iter()
}
}
/// An overlay for the fixed fields of an IA Address option.
#[derive(FromZeros, FromBytes, AsBytes, NoCell, Unaligned, Debug, PartialEq, Copy, Clone)]
#[repr(C)]
struct IaAddrHeader {
addr: Ipv6Addr,
preferred_lifetime: U32,
valid_lifetime: U32,
}
/// An overlay for the fixed fields of an IA_PD option.
#[derive(FromZeros, FromBytes, AsBytes, NoCell, Unaligned, Debug, PartialEq, Copy, Clone)]
#[repr(C)]
struct IaPdHeader {
iaid: U32,
t1: U32,
t2: U32,
}
/// An overlay representation of an IA_PD option as per [RFC 8415 section 21.21].
///
/// [RFC 8415 section 21.21]: https://datatracker.ietf.org/doc/html/rfc8415#section-21.21
#[derive(Debug, PartialEq)]
pub struct IaPdData<B: ByteSlice> {
header: Ref<B, IaPdHeader>,
options: Records<B, ParsedDhcpOptionImpl>,
}
impl<'a, B: ByteSlice> IaPdData<B> {
/// Constructs a new `IaPdData` from a `ByteSlice`.
fn new(buf: B) -> Result<Self, ParseError> {
let buf_len = buf.len();
let (header, options) = Ref::new_unaligned_from_prefix(buf)
.ok_or(ParseError::InvalidOpLen(OptionCode::IaPd, buf_len))?;
let options = Records::<B, ParsedDhcpOptionImpl>::parse_with_context(options, ())?;
Ok(IaPdData { header, options })
}
/// Returns the IAID.
pub fn iaid(&self) -> u32 {
self.header.iaid.get()
}
/// Returns the T1 as `TimeValue` to relay the fact that certain values have
/// special significance as described in RFC 8415, [section 14.2] and
/// [section 7.7].
///
/// [section 14.2]: https://datatracker.ietf.org/doc/html/rfc8415#section-14.2
/// [section 7.7]: https://datatracker.ietf.org/doc/html/rfc8415#section-7.7
pub fn t1(&self) -> TimeValue {
TimeValue::new(self.header.t1.get())
}
/// Returns the T2 as `TimeValue` to relay the fact that certain values have
/// special significance as described in RFC 8415, [section 14.2] and
/// [section 7.7].
///
/// [section 14.2]: https://datatracker.ietf.org/doc/html/rfc8415#section-14.2
/// [section 7.7]: https://datatracker.ietf.org/doc/html/rfc8415#section-7.7
pub fn t2(&self) -> TimeValue {
TimeValue::new(self.header.t2.get())
}
/// Returns an iterator over the options.
pub fn iter_options(&'a self) -> impl 'a + Iterator<Item = ParsedDhcpOption<'a>> {
self.options.iter()
}
}
/// An overlay for the fixed fields of an IA Prefix option.
#[derive(FromZeros, FromBytes, AsBytes, NoCell, Unaligned, Debug, PartialEq, Copy, Clone)]
#[repr(C)]
struct IaPrefixHeader {
preferred_lifetime_secs: U32,
valid_lifetime_secs: U32,
prefix_length: u8,
prefix: Ipv6Addr,
}
/// An overlay representation of an IA Address option, as per RFC 8415 section 21.22.
///
/// [RFC 8415 section 21.22]: https://datatracker.ietf.org/doc/html/rfc8415#section-21.22
#[derive(Debug, PartialEq)]
pub struct IaPrefixData<B: ByteSlice> {
header: Ref<B, IaPrefixHeader>,
options: Records<B, ParsedDhcpOptionImpl>,
}
impl<'a, B: ByteSlice> IaPrefixData<B> {
/// Constructs a new `IaPrefixData` from a `ByteSlice`.
pub fn new(buf: B) -> Result<Self, ParseError> {
let buf_len = buf.len();
let (header, options) = Ref::new_unaligned_from_prefix(buf)
.ok_or(ParseError::InvalidOpLen(OptionCode::IaPrefix, buf_len))?;
let options = Records::<B, ParsedDhcpOptionImpl>::parse_with_context(options, ())?;
Ok(IaPrefixData { header, options })
}
/// Returns the prefix.
pub fn prefix(&self) -> Result<Subnet<Ipv6Addr>, PrefixTooLongError> {
Subnet::from_host(self.header.prefix, self.header.prefix_length)
}
/// Returns the preferred lifetime as `TimeValue` to relay the fact that
/// certain values have special significance as described in
/// [RFC 8415, section 7.7].
///
/// [section 14.2]: https://datatracker.ietf.org/doc/html/rfc8415#section-14.2
/// [section 7.7]: https://datatracker.ietf.org/doc/html/rfc8415#section-7.7
pub fn preferred_lifetime(&self) -> TimeValue {
TimeValue::new(self.header.preferred_lifetime_secs.get())
}
/// Returns the valid lifetime as `TimeValue` to relay the fact that certain
/// values have special significance as described in
/// [RFC 8415, section 7.7].
///
/// [section 14.2]: https://datatracker.ietf.org/doc/html/rfc8415#section-14.2
/// [section 7.7]: https://datatracker.ietf.org/doc/html/rfc8415#section-7.7
pub fn valid_lifetime(&self) -> TimeValue {
TimeValue::new(self.header.valid_lifetime_secs.get())
}
/// Returns an iterator over the options.
pub fn iter_options(&'a self) -> impl 'a + Iterator<Item = ParsedDhcpOption<'a>> {
self.options.iter()
}
}
mod checked {
use std::str::FromStr;
use mdns::protocol::{DomainBuilder, EmbeddedPacketBuilder};
use packet::BufferViewMut;
use zerocopy::ByteSliceMut;
use super::ParseError;
/// A checked domain that can only be created through the provided constructor.
#[derive(Debug, PartialEq)]
pub struct Domain {
domain: String,
builder: DomainBuilder,
}
impl FromStr for Domain {
type Err = ParseError;
/// Constructs a `Domain` from a string.
///
/// See `<Domain as TryFrom<String>>::try_from`.
fn from_str(s: &str) -> Result<Self, ParseError> {
Self::try_from(s.to_string())
}
}
impl TryFrom<String> for Domain {
type Error = ParseError;
/// Constructs a `Domain` from a string.
///
/// # Errors
///
/// If the string is not a valid domain following the definition in [RFC 1035].
///
/// [RFC 1035]: https://tools.ietf.org/html/rfc1035
fn try_from(domain: String) -> Result<Self, ParseError> {
let builder = DomainBuilder::from_str(&domain).map_err(ParseError::DomainParseError)?;
Ok(Domain { domain, builder })
}
}
impl Domain {
pub(crate) fn bytes_len(&self) -> usize {
self.builder.bytes_len()
}
pub(crate) fn serialize<B: ByteSliceMut, BV: BufferViewMut<B>>(&self, bv: &mut BV) {
let () = self.builder.serialize(bv);
}
}
}
macro_rules! option_to_code {
($option:ident, $($option_name:ident::$variant:tt($($v:tt)*)),*) => {
match $option {
$($option_name::$variant($($v)*)=>OptionCode::$variant,)*
}
}
}
impl ParsedDhcpOption<'_> {
/// Returns the corresponding option code for the calling option.
pub fn code(&self) -> OptionCode {
option_to_code!(
self,
ParsedDhcpOption::ClientId(_),
ParsedDhcpOption::ServerId(_),
ParsedDhcpOption::Iana(_),
ParsedDhcpOption::IaAddr(_),
ParsedDhcpOption::Oro(_),
ParsedDhcpOption::Preference(_),
ParsedDhcpOption::ElapsedTime(_),
ParsedDhcpOption::StatusCode(_, _),
ParsedDhcpOption::IaPd(_),
ParsedDhcpOption::IaPrefix(_),
ParsedDhcpOption::InformationRefreshTime(_),
ParsedDhcpOption::SolMaxRt(_),
ParsedDhcpOption::DnsServers(_),
ParsedDhcpOption::DomainList(_)
)
}
}
/// An ID that uniquely identifies a DHCPv6 client or server, defined in [RFC8415, Section 11].
///
/// [RFC8415, Section 11]: https://tools.ietf.org/html/rfc8415#section-11
type Duid = [u8];
/// An implementation of `RecordsImpl` for `ParsedDhcpOption`.
///
/// Options in DHCPv6 messages are sequential, so they are parsed through the
/// APIs provided in [packet::records].
///
/// [packet::records]: https://fuchsia-docs.firebaseapp.com/rust/packet/records/index.html
#[derive(Debug, PartialEq)]
enum ParsedDhcpOptionImpl {}
impl RecordsImplLayout for ParsedDhcpOptionImpl {
type Context = ();
type Error = ParseError;
}
impl<'a> RecordsImpl<'a> for ParsedDhcpOptionImpl {
type Record = ParsedDhcpOption<'a>;
/// Tries to parse an option from the beginning of the input buffer. Returns the parsed
/// `ParsedDhcpOption` and the remaining buffer. If the buffer is malformed, returns a
/// `ParseError`. Option format as defined in [RFC 8415, Section 21.1]:
///
/// [RFC 8415, Section 21.1]: https://tools.ietf.org/html/rfc8415#section-21.1
fn parse_with_context<BV: BufferView<&'a [u8]>>(
data: &mut BV,
_context: &mut Self::Context,
) -> RecordParseResult<Self::Record, Self::Error> {
if data.len() == 0 {
return Ok(ParsedRecord::Done);
}
let opt_code = data.take_obj_front::<U16>().ok_or(ParseError::BufferExhausted)?;
let opt_len = data.take_obj_front::<U16>().ok_or(ParseError::BufferExhausted)?;
let opt_len = usize::from(opt_len.get());
let mut opt_val = data.take_front(opt_len).ok_or(ParseError::BufferExhausted)?;
let opt_code = match OptionCode::try_from(opt_code.get()) {
Ok(opt_code) => opt_code,
// TODO(https://fxbug.dev/42134994): surface skipped codes so we know which ones are not
// supported.
Err(ParseError::InvalidOpCode(_)) => {
// Skip unknown option codes to keep useful information.
//
// https://tools.ietf.org/html/rfc8415#section-16
return Ok(ParsedRecord::Skipped);
}
Err(e) => unreachable!("unexpected error from op code conversion: {}", e),
};
let opt = match opt_code {
OptionCode::ClientId => Ok(ParsedDhcpOption::ClientId(opt_val)),
OptionCode::ServerId => Ok(ParsedDhcpOption::ServerId(opt_val)),
OptionCode::Iana => IanaData::new(opt_val).map(ParsedDhcpOption::Iana),
OptionCode::IaAddr => IaAddrData::new(opt_val).map(ParsedDhcpOption::IaAddr),
OptionCode::Oro => {
let options = opt_val
// TODO(https://github.com/rust-lang/rust/issues/74985): use slice::as_chunks.
.chunks(2)
.map(|opt| {
let opt: [u8; 2] = opt.try_into().map_err(
|std::array::TryFromSliceError { .. }| {
ParseError::InvalidOpLen(OptionCode::Oro, opt_val.len())
},
)?;
OptionCode::try_from(u16::from_be_bytes(opt))
})
.collect::<Result<_, ParseError>>()?;
Ok(ParsedDhcpOption::Oro(options))
}
OptionCode::Preference => match opt_val {
&[b] => Ok(ParsedDhcpOption::Preference(b)),
opt_val => Err(ParseError::InvalidOpLen(OptionCode::Preference, opt_val.len())),
},
OptionCode::ElapsedTime => match opt_val {
&[b0, b1] => Ok(ParsedDhcpOption::ElapsedTime(u16::from_be_bytes([b0, b1]))),
opt_val => Err(ParseError::InvalidOpLen(OptionCode::ElapsedTime, opt_val.len())),
},
OptionCode::StatusCode => {
let mut opt_val = &mut opt_val;
let code = (&mut opt_val)
.take_obj_front::<U16>()
.ok_or(ParseError::InvalidOpLen(OptionCode::StatusCode, opt_val.len()))?;
let message = str::from_utf8(opt_val)?;
Ok(ParsedDhcpOption::StatusCode(*code, message))
}
OptionCode::IaPd => IaPdData::new(opt_val).map(ParsedDhcpOption::IaPd),
OptionCode::IaPrefix => IaPrefixData::new(opt_val).map(ParsedDhcpOption::IaPrefix),
OptionCode::InformationRefreshTime => match opt_val {
&[b0, b1, b2, b3] => {
Ok(ParsedDhcpOption::InformationRefreshTime(u32::from_be_bytes([
b0, b1, b2, b3,
])))
}
opt_val => {
Err(ParseError::InvalidOpLen(OptionCode::InformationRefreshTime, opt_val.len()))
}
},
OptionCode::SolMaxRt => {
let mut opt_val = &mut opt_val;
let sol_max_rt = (&mut opt_val)
.take_obj_front::<U32>()
.ok_or(ParseError::InvalidOpLen(OptionCode::SolMaxRt, opt_val.len()))?;
Ok(ParsedDhcpOption::SolMaxRt(*sol_max_rt))
}
OptionCode::DnsServers => {
let addresses = opt_val
// TODO(https://github.com/rust-lang/rust/issues/74985): use slice::as_chunks.
.chunks(16)
.map(|opt| {
let opt: [u8; 16] = opt.try_into().map_err(
|std::array::TryFromSliceError { .. }| {
ParseError::InvalidOpLen(OptionCode::DnsServers, opt_val.len())
},
)?;
Ok(Ipv6Addr::from(opt))
})
.collect::<Result<_, ParseError>>()?;
Ok(ParsedDhcpOption::DnsServers(addresses))
}
OptionCode::DomainList => {
let mut opt_val = &mut opt_val;
let mut domains = Vec::new();
while opt_val.len() > 0 {
domains.push(checked::Domain::try_from(
Domain::parse(
&mut opt_val,
// Per RFC 8415 Section 10:
// A domain name, or list of domain names, in DHCP
// MUST NOT be stored in compressed form
//
// Pass None to indicate this.
None,
)
.map_err(ParseError::DomainParseError)?
.to_string(),
)?);
}
Ok(ParsedDhcpOption::DomainList(domains))
}
}?;
Ok(ParsedRecord::Parsed(opt))
}
}
/// Generates a random DUID UUID based on the format defined in [RFC 8415, Section 11.5].
///
/// [RFC 8415, Section 11.5]: https://tools.ietf.org/html/rfc8415#section-11.5
pub fn duid_uuid() -> [u8; 18] {
let mut duid = [0u8; 18];
duid[1] = 4;
let uuid = Uuid::new_v4();
let uuid = uuid.as_bytes();
for i in 0..16 {
duid[2 + i] = uuid[i];
}
duid
}
/// A serializable DHCPv6 option.
///
/// Options that are not found in this type are currently not supported. An exhaustive list of
/// options can be found [here][options].
///
/// [options]: https://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xhtml#dhcpv6-parameters-2
// TODO(https://fxbug.dev/42155425): replace `DhcpOption` and `ParsedDhcpOption` with a single type.
#[allow(missing_docs)]
#[derive(Debug)]
pub enum DhcpOption<'a> {
// https://tools.ietf.org/html/rfc8415#section-21.2
ClientId(&'a Duid),
// https://tools.ietf.org/html/rfc8415#section-21.3
ServerId(&'a Duid),
// https://tools.ietf.org/html/rfc8415#section-21.4
// TODO(https://fxbug.dev/42154013): add validation; not all option codes can
// be present in an IA_NA option.
Iana(IanaSerializer<'a>),
// https://tools.ietf.org/html/rfc8415#section-21.6
// TODO(https://fxbug.dev/42154013): add validation; not all option codes can
// be present in an IA Address option.
IaAddr(IaAddrSerializer<'a>),
// https://tools.ietf.org/html/rfc8415#section-21.7
// TODO(https://fxbug.dev/42154013): add validation; not all option codes can
// be present in an ORO option.
// See https://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xhtml#dhcpv6-parameters-2
Oro(&'a [OptionCode]),
// https://tools.ietf.org/html/rfc8415#section-21.8
Preference(u8),
// https://tools.ietf.org/html/rfc8415#section-21.9
ElapsedTime(u16),
// https://tools.ietf.org/html/rfc8415#section-21.13
StatusCode(u16, &'a str),
// https://tools.ietf.org/html/rfc8415#section-21.21
IaPd(IaPdSerializer<'a>),
// https://tools.ietf.org/html/rfc8415#section-21.22
IaPrefix(IaPrefixSerializer<'a>),
// https://tools.ietf.org/html/rfc8415#section-21.23
InformationRefreshTime(u32),
// https://tools.ietf.org/html/rfc8415#section-21.24
SolMaxRt(u32),
// https://tools.ietf.org/html/rfc3646#section-3
DnsServers(&'a [Ipv6Addr]),
// https://tools.ietf.org/html/rfc3646#section-4
DomainList(&'a [checked::Domain]),
}
/// Identity Association identifier, as defined in [RFC 8415, Section 4.2].
///
/// [RFC 8415, Section 4.2]: https://datatracker.ietf.org/doc/html/rfc8415#section-4.2
#[derive(Debug, Copy, Clone, Hash, Eq, PartialEq)]
pub struct IAID(u32);
impl IAID {
/// Constructs an `IAID`.
pub const fn new(iaid: u32) -> Self {
Self(iaid)
}
/// Returns the `u32` value inside `self`.
pub fn get(&self) -> u32 {
let IAID(iaid) = self;
*iaid
}
}
/// A serializer for the IA_NA DHCPv6 option.
#[derive(Debug)]
pub struct IanaSerializer<'a> {
header: IanaHeader,
options: RecordSequenceBuilder<DhcpOption<'a>, Iter<'a, DhcpOption<'a>>>,
}
impl<'a> IanaSerializer<'a> {
/// Constructs a new `IanaSerializer`.
pub fn new(iaid: IAID, t1: u32, t2: u32, options: &'a [DhcpOption<'a>]) -> IanaSerializer<'a> {
IanaSerializer {
header: IanaHeader { iaid: U32::new(iaid.get()), t1: U32::new(t1), t2: U32::new(t2) },
options: RecordSequenceBuilder::new(options.iter()),
}
}
}
/// A serializer for the IA Address DHCPv6 option.
#[derive(Debug)]
pub struct IaAddrSerializer<'a> {
header: IaAddrHeader,
options: RecordSequenceBuilder<DhcpOption<'a>, Iter<'a, DhcpOption<'a>>>,
}
impl<'a> IaAddrSerializer<'a> {
/// Constructs a new `IaAddrSerializer`.
pub fn new(
addr: Ipv6Addr,
preferred_lifetime: u32,
valid_lifetime: u32,
options: &'a [DhcpOption<'a>],
) -> IaAddrSerializer<'a> {
IaAddrSerializer {
header: IaAddrHeader {
addr,
preferred_lifetime: U32::new(preferred_lifetime),
valid_lifetime: U32::new(valid_lifetime),
},
options: RecordSequenceBuilder::new(options.iter()),
}
}
}
/// A serializer for the IA_PD DHCPv6 option.
#[derive(Debug)]
pub struct IaPdSerializer<'a> {
header: IaPdHeader,
options: RecordSequenceBuilder<DhcpOption<'a>, Iter<'a, DhcpOption<'a>>>,
}
impl<'a> IaPdSerializer<'a> {
/// Constructs a new `IaPdSerializer`.
pub fn new(iaid: IAID, t1: u32, t2: u32, options: &'a [DhcpOption<'a>]) -> IaPdSerializer<'a> {
IaPdSerializer {
header: IaPdHeader { iaid: U32::new(iaid.get()), t1: U32::new(t1), t2: U32::new(t2) },
options: RecordSequenceBuilder::new(options.iter()),
}
}
}
/// A serializer for the IA Prefix DHCPv6 option.
#[derive(Debug)]
pub struct IaPrefixSerializer<'a> {
header: IaPrefixHeader,
options: RecordSequenceBuilder<DhcpOption<'a>, Iter<'a, DhcpOption<'a>>>,
}
impl<'a> IaPrefixSerializer<'a> {
/// Constructs a new `IaPrefixSerializer`.
pub fn new(
preferred_lifetime_secs: u32,
valid_lifetime_secs: u32,
prefix: Subnet<Ipv6Addr>,
options: &'a [DhcpOption<'a>],
) -> IaPrefixSerializer<'a> {
IaPrefixSerializer {
header: IaPrefixHeader {
preferred_lifetime_secs: U32::new(preferred_lifetime_secs),
valid_lifetime_secs: U32::new(valid_lifetime_secs),
prefix_length: prefix.prefix(),
prefix: prefix.network(),
},
options: RecordSequenceBuilder::new(options.iter()),
}
}
}
impl DhcpOption<'_> {
/// Returns the corresponding option code for the calling option.
pub fn code(&self) -> OptionCode {
option_to_code!(
self,
DhcpOption::ClientId(_),
DhcpOption::ServerId(_),
DhcpOption::Iana(_),
DhcpOption::IaAddr(_),
DhcpOption::Oro(_),
DhcpOption::Preference(_),
DhcpOption::ElapsedTime(_),
DhcpOption::StatusCode(_, _),
DhcpOption::IaPd(_),
DhcpOption::IaPrefix(_),
DhcpOption::InformationRefreshTime(_),
DhcpOption::SolMaxRt(_),
DhcpOption::DnsServers(_),
DhcpOption::DomainList(_)
)
}
}
impl<'a> RecordBuilder for DhcpOption<'a> {
/// Calculates the serialized length of the option based on option format
/// defined in [RFC 8415, Section 21.1].
///
/// For variable length options that exceeds the size limit (`u16::MAX`),
/// fallback to a default value.
///
/// [RFC 8415, Section 21.1]: https://tools.ietf.org/html/rfc8415#section-21.1
fn serialized_len(&self) -> usize {
4 + match self {
DhcpOption::ClientId(duid) | DhcpOption::ServerId(duid) => {
u16::try_from(duid.len()).unwrap_or(18).into()
}
DhcpOption::Iana(IanaSerializer { header, options }) => {
u16::try_from(header.as_bytes().len() + options.serialized_len())
.expect("overflows")
.into()
}
DhcpOption::IaAddr(IaAddrSerializer { header, options }) => {
u16::try_from(header.as_bytes().len() + options.serialized_len())
.expect("overflows")
.into()
}
DhcpOption::Oro(opts) => u16::try_from(2 * opts.len()).unwrap_or(0).into(),
DhcpOption::Preference(v) => std::mem::size_of_val(v),
DhcpOption::ElapsedTime(v) => std::mem::size_of_val(v),
DhcpOption::StatusCode(v, message) => std::mem::size_of_val(v) + message.len(),
DhcpOption::IaPd(IaPdSerializer { header, options }) => {
u16::try_from(header.as_bytes().len() + options.serialized_len())
.expect("overflows")
.into()
}
DhcpOption::IaPrefix(IaPrefixSerializer { header, options }) => {
u16::try_from(header.as_bytes().len() + options.serialized_len())
.expect("overflows")
.into()
}
DhcpOption::InformationRefreshTime(v) => std::mem::size_of_val(v),
DhcpOption::SolMaxRt(v) => std::mem::size_of_val(v),
DhcpOption::DnsServers(recursive_name_servers) => {
u16::try_from(16 * recursive_name_servers.len()).unwrap_or(0).into()
}
DhcpOption::DomainList(domains) => {
u16::try_from(domains.iter().fold(0, |tot, domain| tot + domain.bytes_len()))
.unwrap_or(0)
.into()
}
}
}
/// Serializes an option and appends to input buffer based on option format
/// defined in [RFC 8415, Section 21.1].
///
/// For variable length options that exceeds the size limit (`u16::MAX`),
/// fallback to use a default value instead, so it is impossible for future
/// changes to introduce DoS vulnerabilities even if they accidentally allow
/// such options to be injected.
///
/// # Panics
///
/// `serialize_into` panics if `buf` is too small to hold the serialized
/// form of `self`.
///
/// [RFC 8415, Section 21.1]: https://tools.ietf.org/html/rfc8415#section-21.1
fn serialize_into(&self, mut buf: &mut [u8]) {
// Implements BufferViewMut, giving us write_obj_front.
let mut buf = &mut buf;
let () = buf.write_obj_front(&U16::new(self.code().into())).expect("buffer is too small");
match self {
DhcpOption::ClientId(duid) | DhcpOption::ServerId(duid) => {
match u16::try_from(duid.len()) {
Ok(len) => {
let () = buf.write_obj_front(&U16::new(len)).expect("buffer is too small");
let () = buf.write_obj_front(*duid).expect("buffer is too small");
}
Err(std::num::TryFromIntError { .. }) => {
// Do not panic, so DUIDs with length exceeding u16 won't introduce DoS
// vulnerability.
let duid = duid_uuid();
let len = u16::try_from(duid.len()).expect("uuid length is too long");
let () = buf.write_obj_front(&U16::new(len)).expect("buffer is too small");
let () = buf.write_obj_front(&duid).expect("buffer is too small");
}
}
}
DhcpOption::Iana(IanaSerializer { header, options }) => {
let len = u16::try_from(header.as_bytes().len() + options.serialized_len())
.expect("overflows");
let () = buf.write_obj_front(&U16::new(len)).expect("buffer is too small");
let () = buf.write_obj_front(header).expect("buffer is too small");
let () = options.serialize_into(buf);
}
DhcpOption::IaAddr(IaAddrSerializer { header, options }) => {
let len = u16::try_from(header.as_bytes().len() + options.serialized_len())
.expect("overflows");
let () = buf.write_obj_front(&U16::new(len)).expect("buffer is too small");
let () = buf.write_obj_front(header).expect("buffer is too small");
let () = options.serialize_into(buf);
}
DhcpOption::Oro(requested_opts) => {
let (requested_opts, len) = u16::try_from(2 * requested_opts.len()).map_or_else(
|std::num::TryFromIntError { .. }| {
// Do not panic, so OROs with size exceeding u16 won't introduce DoS
// vulnerability.
(&[][..], 0)
},
|len| (*requested_opts, len),
);
let () = buf.write_obj_front(&U16::new(len)).expect("buffer is too small");
for opt_code in requested_opts.into_iter() {
let () = buf
.write_obj_front(&u16::from(*opt_code).to_be_bytes())
.expect("buffer is too small");
}
}
DhcpOption::Preference(pref_val) => {
let () = buf.write_obj_front(&U16::new(1)).expect("buffer is too small");
let () = buf.write_obj_front(pref_val).expect("buffer is too small");
}
DhcpOption::ElapsedTime(elapsed_time) => {
let () = buf
.write_obj_front(&U16::new(
mem::size_of_val(elapsed_time).try_into().expect("overflows"),
))
.expect("buffer is too small");
let () =
buf.write_obj_front(&U16::new(*elapsed_time)).expect("buffer is too small");
}
DhcpOption::StatusCode(code, message) => {
let opt_len = u16::try_from(2 + message.len()).expect("overflows");
let () = buf.write_obj_front(&U16::new(opt_len)).expect("buffer is too small");
let () = buf.write_obj_front(&U16::new(*code)).expect("buffer is too small");
let () = buf.write_obj_front(message.as_bytes()).expect("buffer is too small");
}
DhcpOption::IaPd(IaPdSerializer { header, options }) => {
let len = u16::try_from(header.as_bytes().len() + options.serialized_len())
.expect("overflows");
let () = buf.write_obj_front(&U16::new(len)).expect("buffer is too small");
buf.write_obj_front(header).expect("buffer is too small");
let () = options.serialize_into(buf);
}
DhcpOption::IaPrefix(IaPrefixSerializer { header, options }) => {
let len = u16::try_from(header.as_bytes().len() + options.serialized_len())
.expect("overflows");
let () = buf.write_obj_front(&U16::new(len)).expect("buffer is too small");
buf.write_obj_front(header).expect("buffer is too small");
let () = options.serialize_into(buf);
}
DhcpOption::InformationRefreshTime(information_refresh_time) => {
let () = buf
.write_obj_front(&U16::new(
mem::size_of_val(information_refresh_time).try_into().expect("overflows"),
))
.expect("buffer is too small");
let () = buf
.write_obj_front(&U32::new(*information_refresh_time))
.expect("buffer is too small");
}
DhcpOption::SolMaxRt(sol_max_rt) => {
let () = buf
.write_obj_front(&U16::new(
mem::size_of_val(sol_max_rt).try_into().expect("overflows"),
))
.expect("buffer is too small");
let () = buf.write_obj_front(&U32::new(*sol_max_rt)).expect("buffer is too small");
}
DhcpOption::DnsServers(recursive_name_servers) => {
let (recursive_name_servers, len) =
u16::try_from(16 * recursive_name_servers.len()).map_or_else(
|std::num::TryFromIntError { .. }| {
// Do not panic, so DnsServers with size exceeding `u16` won't introduce
// DoS vulnerability.
(&[][..], 0)
},
|len| (*recursive_name_servers, len),
);
let () = buf.write_obj_front(&U16::new(len)).expect("buffer is too small");
recursive_name_servers.iter().for_each(|server_addr| {
let () = buf.write_obj_front(server_addr.bytes()).expect("buffer is too small");
})
}
DhcpOption::DomainList(domains) => {
let (domains, len) =
u16::try_from(domains.iter().map(|domain| domain.bytes_len()).sum::<usize>())
.map_or_else(
|std::num::TryFromIntError { .. }| {
// Do not panic, so DomainList with size exceeding `u16` won't
// introduce DoS vulnerability.
(&[][..], 0)
},
|len| (*domains, len),
);
let () = buf.write_obj_front(&U16::new(len)).expect("buffer is too small");
domains.iter().for_each(|domain| {
domain.serialize(&mut buf);
})
}
}
}
}
/// A transaction ID defined in [RFC 8415, Section 8].
///
/// [RFC 8415, Section 8]: https://tools.ietf.org/html/rfc8415#section-8
type TransactionId = [u8; 3];
/// A DHCPv6 message as defined in [RFC 8415, Section 8].
///
/// [RFC 8415, Section 8]: https://tools.ietf.org/html/rfc8415#section-8
#[derive(Debug)]
pub struct Message<'a, B> {
msg_type: MessageType,
transaction_id: &'a TransactionId,
options: Records<B, ParsedDhcpOptionImpl>,
}
impl<'a, B: ByteSlice> Message<'a, B> {
/// Returns the message type.
pub fn msg_type(&self) -> MessageType {
self.msg_type
}
/// Returns the transaction ID.
pub fn transaction_id(&self) -> &TransactionId {
&self.transaction_id
}
/// Returns an iterator over the options.
pub fn options<'b: 'a>(&'b self) -> impl 'b + Iterator<Item = ParsedDhcpOption<'a>> {
self.options.iter()
}
}
impl<'a, B: 'a + ByteSlice> ParsablePacket<B, ()> for Message<'a, B> {
type Error = ParseError;
fn parse_metadata(&self) -> ParseMetadata {
let Self { msg_type, transaction_id, options } = self;
ParseMetadata::from_packet(
0,
mem::size_of_val(msg_type) + mem::size_of_val(transaction_id) + options.bytes().len(),
0,
)
}
fn parse<BV: BufferView<B>>(mut buf: BV, _args: ()) -> Result<Self, ParseError> {
let msg_type =
MessageType::try_from(buf.take_byte_front().ok_or(ParseError::BufferExhausted)?)?;
let transaction_id =
buf.take_obj_front::<TransactionId>().ok_or(ParseError::BufferExhausted)?.into_ref();
let options = Records::<_, ParsedDhcpOptionImpl>::parse(buf.take_rest_front())?;
Ok(Message { msg_type, transaction_id, options })
}
}
/// A `DHCPv6Message` builder.
///
/// DHCPv6 messages are serialized through [packet::serialize::InnerPacketBuilder] because it won't
/// encapsulate any other packets.
///
/// [packet::serialize::InnerPacketBuilder]: https://fuchsia-docs.firebaseapp.com/rust/packet/serialize/trait.InnerPacketBuilder.html
#[derive(Debug)]
pub struct MessageBuilder<'a> {
msg_type: MessageType,
transaction_id: TransactionId,
options: RecordSequenceBuilder<DhcpOption<'a>, Iter<'a, DhcpOption<'a>>>,
}
impl<'a> MessageBuilder<'a> {
/// Constructs a new `MessageBuilder`.
pub fn new(
msg_type: MessageType,
transaction_id: TransactionId,
options: &'a [DhcpOption<'a>],
) -> MessageBuilder<'a> {
MessageBuilder {
msg_type,
transaction_id,
options: RecordSequenceBuilder::new(options.iter()),
}
}
}
impl InnerPacketBuilder for MessageBuilder<'_> {
/// Calculates the serialized length of the DHCPv6 message based on format defined in
/// [RFC 8415, Section 8].
///
/// [RFC 8415, Section 8]: https://tools.ietf.org/html/rfc8415#section-8
fn bytes_len(&self) -> usize {
let Self { msg_type, transaction_id, options } = self;
mem::size_of_val(msg_type) + mem::size_of_val(transaction_id) + options.serialized_len()
}
/// Serializes DHCPv6 message based on format defined in [RFC 8415, Section 8].
///
/// # Panics
///
/// If buffer is too small. This means `record_length` is not correctly implemented.
///
/// [RFC 8415, Section 8]: https://tools.ietf.org/html/rfc8415#section-8
fn serialize(&self, mut buffer: &mut [u8]) {
let Self { msg_type, transaction_id, options } = self;
// Implements BufferViewMut, giving us write_obj_front.
let mut buffer = &mut buffer;
let () = buffer.write_obj_front(msg_type).expect("buffer is too small");
let () = buffer.write_obj_front(transaction_id).expect("buffer is too small");
let () = options.serialize_into(buffer);
}
}
#[cfg(test)]
mod tests {
use {
super::*,
assert_matches::assert_matches,
net_declare::{net_ip_v6, net_subnet_v6},
std::str::FromStr,
test_case::test_case,
};
fn test_buf_with_no_options() -> Vec<u8> {
let builder = MessageBuilder::new(MessageType::Solicit, [1, 2, 3], &[]);
let mut buf = vec![0; builder.bytes_len()];
let () = builder.serialize(&mut buf);
buf
}
#[test]
fn test_message_serialization() {
let iaaddr_options = [DhcpOption::StatusCode(0, "Success.")];
let iana_options = [
DhcpOption::Preference(42),
DhcpOption::IaAddr(IaAddrSerializer::new(
Ipv6Addr::from([0, 1, 2, 3, 4, 5, 6, 107, 108, 109, 110, 111, 212, 213, 214, 215]),
3600,
7200,
&iaaddr_options,
)),
];
let iaprefix_options = [DhcpOption::StatusCode(0, "Success.")];
let iapd_options = [DhcpOption::IaPrefix(IaPrefixSerializer::new(
9999,
6666,
net_subnet_v6!("abcd:1234::/56"),
&iaprefix_options,
))];
let dns_servers = [
Ipv6Addr::from([0, 1, 2, 3, 4, 5, 6, 107, 108, 109, 110, 111, 212, 213, 214, 215]),
Ipv6Addr::from([10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25]),
];
let domains = [
checked::Domain::from_str("fuchsia.dev").expect("failed to construct test domain"),
checked::Domain::from_str("www.google.com").expect("failed to construct test domain"),
];
let options = [
DhcpOption::ClientId(&[4, 5, 6]),
DhcpOption::ServerId(&[8]),
DhcpOption::Iana(IanaSerializer::new(IAID::new(42), 3000, 6500, &iana_options)),
DhcpOption::Oro(&[OptionCode::ClientId, OptionCode::ServerId]),
DhcpOption::Preference(42),
DhcpOption::ElapsedTime(3600),
DhcpOption::StatusCode(0, "Success."),
DhcpOption::IaPd(IaPdSerializer::new(IAID::new(44), 5000, 7000, &iapd_options)),
DhcpOption::InformationRefreshTime(86400),
DhcpOption::SolMaxRt(86400),
DhcpOption::DnsServers(&dns_servers),
DhcpOption::DomainList(&domains),
];
let builder = MessageBuilder::new(MessageType::Solicit, [1, 2, 3], &options);
assert_eq!(builder.bytes_len(), 256);
let mut buf = vec![0; builder.bytes_len()];
let () = builder.serialize(&mut buf);
#[rustfmt::skip]
assert_eq!(
buf[..],
[
1, // message type
1, 2, 3, // transaction id
0, 1, 0, 3, 4, 5, 6, // option - client ID
0, 2, 0, 1, 8, // option - server ID
// option - IA_NA
0, 3, 0, 59, 0, 0, 0, 42, 0, 0, 11, 184, 0, 0, 25, 100, 0, 7, 0, 1, 42, 0, 5, 0, 38, 0, 1, 2, 3, 4, 5, 6, 107, 108, 109, 110, 111, 212, 213, 214, 215, 0, 0, 14, 16, 0, 0, 28, 32, 0, 13, 0, 10, 0, 0, 83, 117, 99, 99, 101, 115, 115, 46,
0, 6, 0, 4, 0, 1, 0, 2, // option - ORO
0, 7, 0, 1, 42, // option - preference
0, 8, 0, 2, 14, 16, // option - elapsed time
// option - status code
0, 13, 0, 10, 0, 0, 83, 117, 99, 99, 101, 115, 115, 46,
// option - IA_PD
0, 25, 0, 55,
// IA_PD - IAID
0, 0, 0, 44,
// IA_PD - T1
0, 0, 19, 136,
// IA_PD - T2
0, 0, 27, 88,
// IA_PD - Options
// IA Prefix
0, 26, 0, 39,
// IA Prefix - Preferred lifetime
0, 0, 39, 15,
// IA Prefix - Valid lifetime
0, 0, 26, 10,
// IA Prefix - Prefix Length
56,
// IA Prefix - IPv6 Prefix
0xab, 0xcd, 0x12, 0x34, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
// IA Prefix - Options
// Status Code
0, 13, 0, 10, 0, 0, 83, 117, 99, 99, 101, 115, 115, 46,
0, 32, 0, 4, 0, 1, 81, 128, // option - information refresh time
0, 82, 0, 4, 0, 1, 81, 128, // option - SOL_MAX_RT
// option - Dns servers
0, 23, 0, 32,
0, 1, 2, 3, 4, 5, 6, 107, 108, 109, 110, 111, 212, 213, 214, 215,
10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25,
// option - Dns domains
0, 24, 0, 29,
7, 102, 117, 99, 104, 115, 105, 97, 3, 100, 101, 118, 0,
3, 119, 119, 119, 6, 103, 111, 111, 103, 108, 101, 3, 99, 111, 109, 0
],
);
}
#[test]
fn test_message_serialization_parsing_roundtrip() {
let iaaddr_suboptions = [DhcpOption::StatusCode(0, "Success.")];
let iana_suboptions = [
DhcpOption::Preference(42),
DhcpOption::IaAddr(IaAddrSerializer::new(
Ipv6Addr::from([0, 1, 2, 3, 4, 5, 6, 107, 108, 109, 110, 111, 212, 213, 214, 215]),
7200,
9000,
&iaaddr_suboptions,
)),
];
let iaprefix_options = [DhcpOption::StatusCode(0, "Success.")];
let iapd_options = [DhcpOption::IaPrefix(IaPrefixSerializer::new(
89658902,
82346231,
net_subnet_v6!("1234:5678:1231::/48"),
&iaprefix_options,
))];
let dns_servers = [net_ip_v6!("::")];
let domains = [
checked::Domain::from_str("fuchsia.dev").expect("failed to construct test domain"),
checked::Domain::from_str("www.google.com").expect("failed to construct test domain"),
];
let options = [
DhcpOption::ClientId(&[4, 5, 6]),
DhcpOption::ServerId(&[8]),
DhcpOption::Iana(IanaSerializer::new(IAID::new(1234), 7000, 8800, &iana_suboptions)),
DhcpOption::Oro(&[OptionCode::ClientId, OptionCode::ServerId]),
DhcpOption::Preference(42),
DhcpOption::ElapsedTime(3600),
DhcpOption::StatusCode(0, "Success."),
DhcpOption::IaPd(IaPdSerializer::new(IAID::new(1412), 6513, 9876, &iapd_options)),
DhcpOption::InformationRefreshTime(86400),
DhcpOption::SolMaxRt(86400),
DhcpOption::DnsServers(&dns_servers),
DhcpOption::DomainList(&domains),
];
let builder = MessageBuilder::new(MessageType::Solicit, [1, 2, 3], &options);
let mut buf = vec![0; builder.bytes_len()];
let () = builder.serialize(&mut buf);
let mut buf = &buf[..];
let msg = Message::parse(&mut buf, ()).expect("parse should succeed");
assert_eq!(msg.msg_type, MessageType::Solicit);
assert_eq!(msg.transaction_id, &[1, 2, 3]);
let got_options: Vec<_> = msg.options.iter().collect();
let iana_buf = [
0, 0, 4, 210, 0, 0, 27, 88, 0, 0, 34, 96, 0, 7, 0, 1, 42, 0, 5, 0, 38, 0, 1, 2, 3, 4,
5, 6, 107, 108, 109, 110, 111, 212, 213, 214, 215, 0, 0, 28, 32, 0, 0, 35, 40, 0, 13,
0, 10, 0, 0, 83, 117, 99, 99, 101, 115, 115, 46,
];
let iapd_buf = [
// IA_PD - IAID
0, 0, 5, 132, // IA_PD - T1
0, 0, 25, 113, // IA_PD - T2
0, 0, 38, 148, // IA_PD - Options
// IA Prefix
0, 26, 0, 39, // IA Prefix - Preferred lifetime
5, 88, 22, 22, // IA Prefix - Valid lifetime
4, 232, 128, 247, // IA Prefix - Prefix Length
48, // IA Prefix - IPv6 Prefix
0x12, 0x34, 0x56, 0x78, 0x12, 0x31, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, // IA Prefix - Options
0, 13, 0, 10, 0, 0, 83, 117, 99, 99, 101, 115, 115, 46,
];
let options = [
ParsedDhcpOption::ClientId(&[4, 5, 6]),
ParsedDhcpOption::ServerId(&[8]),
ParsedDhcpOption::Iana(IanaData::new(&iana_buf[..]).expect("construction failed")),
ParsedDhcpOption::Oro(vec![OptionCode::ClientId, OptionCode::ServerId]),
ParsedDhcpOption::Preference(42),
ParsedDhcpOption::ElapsedTime(3600),
ParsedDhcpOption::StatusCode(U16::new(0), "Success."),
ParsedDhcpOption::IaPd(
IaPdData::new(&iapd_buf[..]).expect("IA_PD construction failed"),
),
ParsedDhcpOption::InformationRefreshTime(86400),
ParsedDhcpOption::SolMaxRt(U32::new(86400)),
ParsedDhcpOption::DnsServers(vec![Ipv6Addr::from([0; 16])]),
ParsedDhcpOption::DomainList(vec![
checked::Domain::from_str("fuchsia.dev").expect("failed to construct test domain"),
checked::Domain::from_str("www.google.com")
.expect("failed to construct test domain"),
]),
];
assert_eq!(got_options, options);
}
// We're forced into an `as` cast because From::from is not a const fn.
const OVERFLOW_LENGTH: usize = u16::MAX as usize + 1;
#[test]
fn test_message_serialization_duid_too_long() {
let options = [DhcpOption::ClientId(&[0u8; OVERFLOW_LENGTH])];
let builder = MessageBuilder::new(MessageType::Solicit, [1, 2, 3], &options);
let mut buf = vec![0; builder.bytes_len()];
let () = builder.serialize(&mut buf);
assert_eq!(buf.len(), 26);
assert_eq!(
buf[..8],
[
1, // message type
1, 2, 3, // transaction id
0, 1, 0, 18, // option - client ID (code and len only)
],
);
// Make sure the buffer is still parsable.
let mut buf = &buf[..];
let _: Message<'_, _> = Message::parse(&mut buf, ()).expect("parse should succeed");
}
#[test]
fn test_message_serialization_oro_too_long() {
let options = [DhcpOption::Oro(&[OptionCode::Preference; OVERFLOW_LENGTH][..])];
let builder = MessageBuilder::new(MessageType::Solicit, [1, 2, 3], &options);
let mut buf = vec![0; builder.bytes_len()];
let () = builder.serialize(&mut buf);
assert_eq!(
buf[..],
[
1, // message type
1, 2, 3, // transaction id
0, 6, 0, 0, // option - ORO
],
);
// Make sure the buffer is still parsable.
let mut buf = &buf[..];
let _: Message<'_, _> = Message::parse(&mut buf, ()).expect("parse should succeed");
}
#[test]
fn test_option_serialization_parsing_roundtrip() {
let mut buf = [0u8; 6];
let option = DhcpOption::ElapsedTime(42);
option.serialize_into(&mut buf);
assert_eq!(buf, [0, 8, 0, 2, 0, 42]);
let options = Records::<_, ParsedDhcpOptionImpl>::parse_with_context(&buf[..], ())
.expect("parse should succeed");
let options: Vec<ParsedDhcpOption<'_>> = options.iter().collect();
assert_eq!(options[..], [ParsedDhcpOption::ElapsedTime(42)]);
}
#[test]
fn test_buffer_too_short() {
let buf = [];
assert_matches!(Message::parse(&mut &buf[..], ()), Err(ParseError::BufferExhausted));
let buf = [
1, // valid message type
0, // transaction id is too short
];
assert_matches!(Message::parse(&mut &buf[..], ()), Err(ParseError::BufferExhausted));
let buf = [
1, // valid message type
1, 2, 3, // valid transaction id
0, // option code is too short
];
assert_matches!(Message::parse(&mut &buf[..], ()), Err(ParseError::BufferExhausted));
let buf = [
1, // valid message type
1, 2, 3, // valida transaction id
0, 1, // valid option code
0, // option length is too short
];
assert_matches!(Message::parse(&mut &buf[..], ()), Err(ParseError::BufferExhausted));
// option value too short
let buf = [
1, // valid message type
1, 2, 3, // valid transaction id
0, 1, // valid option code
0, 100, // valid option length
1, 2, // option value is too short
];
assert_matches!(Message::parse(&mut &buf[..], ()), Err(ParseError::BufferExhausted));
}
#[test]
fn test_invalid_message_type() {
let mut buf = test_buf_with_no_options();
// 0 is an invalid message type.
buf[0] = 0;
assert_matches!(Message::parse(&mut &buf[..], ()), Err(ParseError::InvalidMessageType(0)));
}
#[test]
fn test_skip_invalid_op_code() {
let mut buf = test_buf_with_no_options();
buf.extend_from_slice(&[
0, 0, // opt code = 0, invalid op code
0, 1, // valid opt length
0, // valid opt value
0, 1, 0, 3, 4, 5, 6, // option - client ID
]);
let mut buf = &buf[..];
let msg = Message::parse(&mut buf, ()).expect("parse should succeed");
let got_options: Vec<_> = msg.options.iter().collect();
assert_eq!(got_options, [ParsedDhcpOption::ClientId(&[4, 5, 6])]);
}
#[test]
fn test_iana_no_suboptions_serialization_parsing_roundtrip() {
let mut buf = [0u8; 16];
let option = DhcpOption::Iana(IanaSerializer::new(IAID::new(3456), 1024, 54321, &[]));
option.serialize_into(&mut buf);
assert_eq!(buf, [0, 3, 0, 12, 0, 0, 13, 128, 0, 0, 4, 0, 0, 0, 212, 49]);
let options = Records::<_, ParsedDhcpOptionImpl>::parse_with_context(&buf[..], ())
.expect("parse should succeed");
let options: Vec<ParsedDhcpOption<'_>> = options.iter().collect();
let iana_buf = [0, 0, 13, 128, 0, 0, 4, 0, 0, 0, 212, 49];
assert_eq!(
options[..],
[ParsedDhcpOption::Iana(IanaData::new(&iana_buf[..]).expect("construction failed"))]
);
}
// IA_NA must have option length >= 12, according to [RFC 8145, Section 21.4].
//
// [RFC 8145, Section 21.4]: https://tools.ietf.org/html/rfc8415#section-21.4
#[test]
fn test_iana_invalid_opt_len() {
let mut buf = test_buf_with_no_options();
buf.extend_from_slice(&[
0, 3, // opt code = 3, IA_NA
0, 8, // invalid opt length, must be >= 12
0, 0, 0, 0, 0, 0, 0, 0,
]);
assert_matches!(
Message::parse(&mut &buf[..], ()),
Err(ParseError::InvalidOpLen(OptionCode::Iana, 8))
);
}
#[test]
fn test_iaaddr_no_suboptions_serialization_parsing_roundtrip() {
let mut buf = [0u8; 28];
let option = DhcpOption::IaAddr(IaAddrSerializer::new(
Ipv6Addr::from([10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25]),
0,
0,
&[],
));
option.serialize_into(&mut buf);
assert_eq!(
buf,
[
0, 5, 0, 24, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 0, 0,
0, 0, 0, 0, 0, 0
]
);
let options = Records::<_, ParsedDhcpOptionImpl>::parse_with_context(&buf[..], ())
.expect("parse should succeed");
let options: Vec<ParsedDhcpOption<'_>> = options.iter().collect();
let iaaddr_buf = [
10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 0, 0, 0, 0, 0, 0, 0, 0,
];
assert_eq!(
options[..],
[ParsedDhcpOption::IaAddr(
IaAddrData::new(&iaaddr_buf[..]).expect("construction failed")
)]
);
}
// IA Address must have option length >= 24, according to [RFC 8145, Section 21.6].
//
// [RFC 8145, Section 21.6]: https://tools.ietf.org/html/rfc8415#section-21.6
#[test]
fn test_iaaddr_invalid_opt_len() {
let mut buf = test_buf_with_no_options();
buf.extend_from_slice(&[
0, 5, // opt code = 5, IA Address
0, 8, // invalid opt length, must be >= 24
0, 0, 0, 0, 0, 0, 0, 0,
]);
assert_matches!(
Message::parse(&mut &buf[..], ()),
Err(ParseError::InvalidOpLen(OptionCode::IaAddr, 8))
);
}
// Oro must have a even option length, according to [RFC 8415, Section 21.7].
//
// [RFC 8415, Section 21.7]: https://tools.ietf.org/html/rfc8415#section-21.7
#[test]
fn test_invalid_oro_opt_len() {
let mut buf = test_buf_with_no_options();
buf.extend_from_slice(&[
0, 6, // opt code = 6, ORO
0, 1, // invalid opt length, must be even
0,
]);
assert_matches!(
Message::parse(&mut &buf[..], ()),
Err(ParseError::InvalidOpLen(OptionCode::Oro, 1))
);
}
// Preference must have option length 1, according to [RFC8415, Section 21.8].
//
// [RFC8415, Section 21.8]: https://tools.ietf.org/html/rfc8415#section-21.8
#[test]
fn test_invalid_preference_opt_len() {
let mut buf = test_buf_with_no_options();
buf.extend_from_slice(&[
0, 7, // opt code = 7, preference
0, 2, // invalid opt length, must be even
0, 0,
]);
assert_matches!(
Message::parse(&mut &buf[..], ()),
Err(ParseError::InvalidOpLen(OptionCode::Preference, 2))
);
}
// Elapsed time must have option length 2, according to [RFC 8145, Section 21.9].
//
// [RFC 8145, Section 21.9]: https://tools.ietf.org/html/rfc8415#section-21.9
#[test]
fn test_elapsed_time_invalid_opt_len() {
let mut buf = test_buf_with_no_options();
buf.extend_from_slice(&[
0, 8, // opt code = 8, elapsed time
0, 3, // invalid opt length, must be even
0, 0, 0,
]);
assert_matches!(
Message::parse(&mut &buf[..], ()),
Err(ParseError::InvalidOpLen(OptionCode::ElapsedTime, 3))
);
}
// Status code must have option length >= 2, according to [RFC 8145, Section 21.13].
//
// [RFC 8145, Section 21.13]: https://tools.ietf.org/html/rfc8415#section-21.13
#[test]
fn test_status_code_invalid_opt_len() {
let mut buf = test_buf_with_no_options();
buf.extend_from_slice(&[
0, 13, // opt code = 13, status code
0, 1, // invalid opt length, must be >= 2
0, 0, 0,
]);
assert_matches!(
Message::parse(&mut &buf[..], ()),
Err(ParseError::InvalidOpLen(OptionCode::StatusCode, 1))
);
}
// Information refresh time must have option length 4, according to [RFC 8145, Section 21.23].
//
// [RFC 8145, Section 21.23]: https://tools.ietf.org/html/rfc8415#section-21.23
#[test]
fn test_information_refresh_time_invalid_opt_len() {
let mut buf = test_buf_with_no_options();
buf.extend_from_slice(&[
0, 32, // opt code = 32, information refresh time
0, 3, // invalid opt length, must be 4
0, 0, 0,
]);
assert_matches!(
Message::parse(&mut &buf[..], ()),
Err(ParseError::InvalidOpLen(OptionCode::InformationRefreshTime, 3))
);
}
// SOL_MAX_RT must have option length 4, according to [RFC 8145, Section 21.24].
//
// [RFC 8145, Section 21.24]: https://tools.ietf.org/html/rfc8415#section-21.24
#[test]
fn test_sol_max_rt_invalid_opt_len() {
let mut buf = test_buf_with_no_options();
buf.extend_from_slice(&[
0, 82, // opt code = 82, SOL_MAX_RT
0, 3, // invalid opt length, must be 4
0, 0, 0,
]);
assert_matches!(
Message::parse(&mut &buf[..], ()),
Err(ParseError::InvalidOpLen(OptionCode::SolMaxRt, 3))
);
}
// Option length of Dns servers must be multiples of 16, according to [RFC 3646, Section 3].
//
// [RFC 3646, Section 3]: https://tools.ietf.org/html/rfc3646#section-3
#[test]
fn test_dns_servers_invalid_opt_len() {
let mut buf = test_buf_with_no_options();
buf.extend_from_slice(&[
0, 23, // opt code = 23, dns servers
0, 17, // invalid opt length, must be multiple of 16
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16,
]);
assert_matches!(
Message::parse(&mut &buf[..], ()),
Err(ParseError::InvalidOpLen(OptionCode::DnsServers, 17))
);
}
#[test_case(TimeValue::new(0), TimeValue::Zero)]
#[test_case(TimeValue::new(5), TimeValue::NonZero(NonZeroTimeValue::Finite(NonZeroOrMaxU32::new(5).expect("should succeed for non zero or u32::MAX values"))))]
#[test_case(TimeValue::new(u32::MAX), TimeValue::NonZero(NonZeroTimeValue::Infinity))]
fn test_time_value_new(time_value: TimeValue, expected_variant: TimeValue) {
assert_eq!(time_value, expected_variant);
}
#[test_case(
NonZeroTimeValue::Finite(
NonZeroOrMaxU32::new(1)
.expect("should succeed for non zero or u32::MAX values")
))]
#[test_case(NonZeroTimeValue::Infinity)]
fn test_time_value_ord(non_zero_tv: NonZeroTimeValue) {
assert!(TimeValue::Zero < TimeValue::NonZero(non_zero_tv));
}
#[test]
fn test_non_zero_time_value_ord() {
assert!(
NonZeroTimeValue::Finite(
NonZeroOrMaxU32::new(u32::MAX - 1)
.expect("should succeed for non zero or u32::MAX values")
) < NonZeroTimeValue::Infinity
);
}
#[test_case(0, None)]
#[test_case(60, Some(NonZeroOrMaxU32::new(60).unwrap()))]
#[test_case(u32::MAX, None)]
fn test_non_zero_or_max_u32_new(t: u32, expected: Option<NonZeroOrMaxU32>) {
assert_eq!(NonZeroOrMaxU32::new(t), expected);
}
#[test_case(1)]
#[test_case(4321)]
#[test_case(u32::MAX - 1)]
fn test_non_zero_or_max_u32_get(t: u32) {
assert_eq!(
NonZeroOrMaxU32::new(t).expect("should succeed for non-zero or u32::MAX values").get(),
t
);
}
}