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
// SPDX-License-Identifier: Apache-2.0
use std::fmt::Write;
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
use std::str::FromStr;
use serde::{Deserialize, Deserializer, Serialize};
use crate::{
BaseInterface, DnsClientState, ErrorKind, MergedInterface,
MptcpAddressFlag, NmstateError, RouteRuleEntry,
};
const AF_INET: u8 = 2;
const AF_INET6: u8 = 10;
const IPV4_ADDR_LEN: usize = 32;
const IPV6_ADDR_LEN: usize = 128;
const FOREVER: &str = "forever";
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
#[non_exhaustive]
#[serde(deny_unknown_fields)]
struct InterfaceIp {
#[serde(
skip_serializing_if = "Option::is_none",
default,
deserialize_with = "crate::deserializer::option_bool_or_string"
)]
pub enabled: Option<bool>,
#[serde(
skip_serializing_if = "Option::is_none",
default,
deserialize_with = "crate::deserializer::option_bool_or_string"
)]
pub dhcp: Option<bool>,
#[serde(
skip_serializing_if = "Option::is_none",
default,
deserialize_with = "crate::deserializer::option_bool_or_string"
)]
pub autoconf: Option<bool>,
#[serde(
skip_serializing_if = "Option::is_none",
rename = "dhcp-client-id"
)]
pub dhcp_client_id: Option<Dhcpv4ClientId>,
#[serde(skip_serializing_if = "Option::is_none", rename = "dhcp-duid")]
pub dhcp_duid: Option<Dhcpv6Duid>,
#[serde(skip_serializing_if = "Option::is_none", rename = "address")]
pub addresses: Option<Vec<InterfaceIpAddr>>,
#[serde(
skip_serializing_if = "Option::is_none",
rename = "auto-dns",
default,
deserialize_with = "crate::deserializer::option_bool_or_string"
)]
pub auto_dns: Option<bool>,
#[serde(
skip_serializing_if = "Option::is_none",
rename = "auto-gateway",
default,
deserialize_with = "crate::deserializer::option_bool_or_string"
)]
pub auto_gateway: Option<bool>,
#[serde(
skip_serializing_if = "Option::is_none",
rename = "auto-routes",
default,
deserialize_with = "crate::deserializer::option_bool_or_string"
)]
pub auto_routes: Option<bool>,
#[serde(
skip_serializing_if = "Option::is_none",
rename = "auto-route-table-id",
default,
deserialize_with = "crate::deserializer::option_u32_or_string"
)]
pub auto_table_id: Option<u32>,
#[serde(
skip_serializing_if = "Option::is_none",
rename = "auto-route-metric",
default,
deserialize_with = "crate::deserializer::option_u32_or_string"
)]
pub auto_route_metric: Option<u32>,
#[serde(skip_serializing_if = "Option::is_none", rename = "addr-gen-mode")]
pub addr_gen_mode: Option<Ipv6AddrGenMode>,
#[serde(
skip_serializing_if = "Option::is_none",
rename = "allow-extra-address"
)]
pub allow_extra_address: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub token: Option<String>,
#[serde(
skip_serializing_if = "Option::is_none",
rename = "dhcp-send-hostname"
)]
pub dhcp_send_hostname: Option<bool>,
#[serde(
skip_serializing_if = "Option::is_none",
rename = "dhcp-custom-hostname"
)]
pub dhcp_custom_hostname: Option<String>,
}
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize)]
#[serde(into = "InterfaceIp")]
#[non_exhaustive]
/// IPv4 configuration of interface.
/// Example YAML output of interface holding static IPv4:
/// ```yaml
/// ---
/// interfaces:
/// - name: eth1
/// state: up
/// mtu: 1500
/// ipv4:
/// address:
/// - ip: 192.0.2.252
/// prefix-length: 24
/// - ip: 192.0.2.251
/// prefix-length: 24
/// dhcp: false
/// enabled: true
/// ```
pub struct InterfaceIpv4 {
/// Whether IPv4 stack is enabled. When set to false, all IPv4 address will
/// be removed from this interface.
pub enabled: bool,
/// Indicate whether `enabled` is defined by user or learn from
/// default/current value.
pub(crate) enabled_defined: bool,
/// Whether DHCPv4 is enabled.
pub dhcp: Option<bool>,
/// DHCPv4 client ID.
/// Serialize and deserialize to/from `dhcp-client-id`.
pub dhcp_client_id: Option<Dhcpv4ClientId>,
/// IPv4 addresses.
/// When applying with `None`, current IP address will be preserved.
/// When applying with `Some(Vec::new())`, all IP address will be removed.
/// When switch from DHCP on to off with `addresses` set to None or all
/// `addresses` are dynamic, nmstate will convert current dynamic IP
/// address to static.
/// The IP addresses will apply to kernel with the same order specified
/// which result the IP addresses after first one holding the `secondary`
/// flag.
pub addresses: Option<Vec<InterfaceIpAddr>>,
/// Whether to apply DNS resolver information retrieved from DHCP server.
/// Serialize and deserialize to/from `auto-dns`.
/// If you want to append static DNS name server before DHCP provided
/// servers, please set `auto-dns: true` explicitly a along with static
/// DNS server.
pub auto_dns: Option<bool>,
/// Whether to set default gateway retrieved from DHCP server.
/// Serialize and deserialize to/from `auto-gateway`.
pub auto_gateway: Option<bool>,
/// Whether to set routes(including default gateway) retrieved from DHCP
/// server.
/// Serialize and deserialize to/from `auto-routes`.
pub auto_routes: Option<bool>,
/// The route table ID used to hold routes(including default gateway)
/// retrieved from DHCP server.
/// If not defined, the main(254) will be used.
/// Serialize and deserialize to/from `auto-table-id`.
pub auto_table_id: Option<u32>,
/// If not defined or set to true, nmstate verification process
/// allows extra IP address found as long as desired IP address matched.
/// When set to false, the verification process of nmstate do exact equal
/// check on IP address.
/// Serialize/deserialize to/from `allow-extra-address`
pub allow_extra_address: Option<bool>,
/// Metric for routes retrieved from DHCP server.
/// Only available for DHCPv4 enabled interface.
/// Deserialize from `auto-route-metric`
pub auto_route_metric: Option<u32>,
/// Whether to include hostname in DHCP request.
/// If the hostname is FQDN, the `Fully Qualified Domain Name (FQDN)`
/// option(81) defined in RFC 4702 will be used.
/// If the hostname is not FQDN, the `Host Name` option(12) defined in RFC
/// 2132 will be used.
/// If not defined, set to True when DHCPv4 enabled.
/// Deserialize from `dhcp-send-hostname`
pub dhcp_send_hostname: Option<bool>,
/// Custom string to override hostname used for DHCP request.
/// If the hostname is FQDN, the `Fully Qualified Domain Name (FQDN)`
/// option(81) defined in RFC 4702 will be used.
/// If the hostname is not FQDN, the `Host Name` option(12) defined in RFC
/// 2132 will be used.
/// If not defined, current non-dynamic hostname will be used.
/// Deserialize from `dhcp-custom-hostname`
pub dhcp_custom_hostname: Option<String>,
pub(crate) dns: Option<DnsClientState>,
pub(crate) rules: Option<Vec<RouteRuleEntry>>,
}
impl InterfaceIpv4 {
/// Create [InterfaceIpv4] with IP disabled.
pub fn new() -> Self {
Self::default()
}
pub(crate) fn is_auto(&self) -> bool {
self.enabled && self.dhcp == Some(true)
}
pub fn is_static(&self) -> bool {
self.enabled
&& !self.is_auto()
&& !self.addresses.as_deref().unwrap_or_default().is_empty()
}
pub(crate) fn merge_ip(&mut self, current: &Self) {
if !self.enabled_defined {
self.enabled = current.enabled;
}
if self.dhcp.is_none() && self.enabled {
self.dhcp = current.dhcp;
}
// Normally, we expect backend to preserve configuration which not
// mentioned in desire or all auto ip address, but when DHCP switch from
// ON to OFF, the design of nmstate is expecting dynamic IP address goes
// static. This should be done by top level code.
if current.is_auto()
&& current.addresses.is_some()
&& self.enabled
&& !self.is_auto()
&& is_ip_addrs_none_or_all_auto(self.addresses.as_deref())
{
self.addresses.clone_from(¤t.addresses);
if let Some(addrs) = self.addresses.as_mut() {
addrs.as_mut_slice().iter_mut().for_each(|a| {
a.valid_life_time = None;
a.preferred_life_time = None;
});
}
}
}
// Special action for generating merged state from desired and current.
pub(crate) fn special_merge(&mut self, desired: &Self, current: &Self) {
if !desired.enabled_defined {
self.enabled = current.enabled;
}
if desired.dhcp.is_none() && self.enabled {
self.dhcp = current.dhcp;
}
// Normally, we expect backend to preserve configuration which not
// mentioned in desire, but when DHCP switch from ON to OFF, the design
// of nmstate is expecting dynamic IP address goes static. This should
// be done by top level code.
if current.is_auto()
&& current.addresses.is_some()
&& self.enabled
&& !self.is_auto()
&& is_ip_addrs_none_or_all_auto(self.addresses.as_deref())
{
self.addresses.clone_from(¤t.addresses);
}
// The rules is `pub(crate)`, it will not merged by `merge_json_value()`
self.rules.clone_from(¤t.rules);
self.sanitize(false).ok();
}
// * Remove link-local address
// * Set auto_dns, auto_gateway and auto_routes to true if DHCP enabled and
// those options is None
// * Disable DHCP and remove address if enabled: false
// * Remove auto IP address.
// * Set DHCP options to None if DHCP is false
// * Remove mptcp_flags is they are for query only
pub(crate) fn sanitize(
&mut self,
is_desired: bool,
) -> Result<(), NmstateError> {
if self.is_auto() {
if self.auto_dns.is_none() {
self.auto_dns = Some(true);
}
if self.auto_routes.is_none() {
self.auto_routes = Some(true);
}
if self.auto_gateway.is_none() {
self.auto_gateway = Some(true);
}
if let Some(addrs) = self.addresses.as_ref() {
if is_desired {
for addr in addrs {
log::info!(
"Static addresses {} defined when dynamic \
IP is enabled",
addr
);
}
}
}
} else if self.addresses.as_ref().map_or(false, Vec::is_empty)
&& self.enabled
{
// Empty address should equal to disabled IPv4 stack
if is_desired {
log::info!("Empty IPv4 address is considered as IPv4 disabled");
}
self.enabled = false;
}
if let Some(addrs) = self.addresses.as_mut() {
if is_desired {
for addr in addrs.as_slice().iter().filter(|a| a.is_auto()) {
log::info!("Ignoring Auto IP address {}", addr);
}
if let Some(addr) =
addrs.as_slice().iter().find(|a| a.ip.is_ipv6())
{
return Err(NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Got IPv6 address {} in ipv4 config section",
addr
),
));
}
if let Some(addr) = addrs
.iter()
.find(|a| a.prefix_length as usize > IPV4_ADDR_LEN)
{
return Err(NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Invalid IPv4 network prefix length '{}', \
should be in the range of 0 to {IPV4_ADDR_LEN}",
addr.prefix_length
),
));
}
}
addrs.retain(|a| !a.is_auto());
addrs.iter_mut().for_each(|a| {
a.valid_life_time = None;
a.preferred_life_time = None
});
}
if !self.enabled {
self.dhcp = None;
self.addresses = None;
}
if self.dhcp != Some(true) {
self.auto_dns = None;
self.auto_gateway = None;
self.auto_routes = None;
self.auto_table_id = None;
self.auto_route_metric = None;
if is_desired && self.dhcp_client_id.is_some() {
log::warn!(
"Ignoring `dhcp-client-id` setting when DHCPv4 is \
disabled"
);
}
self.dhcp_client_id = None;
self.dhcp_send_hostname = None;
self.dhcp_custom_hostname = None;
}
if self.dhcp_send_hostname == Some(false) {
if is_desired {
if let Some(custom_hostname) =
self.dhcp_custom_hostname.as_deref()
{
if !custom_hostname.is_empty() {
log::warn!(
"Ignoring `dhcp-custom-hostname: \
{custom_hostname}` as `dhcp-send-hostname` is \
disabled"
);
}
}
}
self.dhcp_custom_hostname = None;
}
if let Some(addrs) = self.addresses.as_mut() {
for addr in addrs.iter_mut() {
addr.mptcp_flags = None;
}
}
Ok(())
}
}
impl<'de> Deserialize<'de> for InterfaceIpv4 {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
let v = serde_json::Value::deserialize(deserializer)?;
if let Some(v_map) = v.as_object() {
if v_map.contains_key("autoconf") {
return Err(serde::de::Error::custom(
"autoconf is not allowed for IPv4",
));
}
if v_map.contains_key("dhcp_duid") {
return Err(serde::de::Error::custom(
"dhcp-duid is not allowed for IPv4",
));
}
}
let ip: InterfaceIp = match serde_json::from_value(v) {
Ok(i) => i,
Err(e) => {
return Err(serde::de::Error::custom(format!("{e}")));
}
};
let ret = Self::from(ip);
Ok(ret)
}
}
impl From<InterfaceIp> for InterfaceIpv4 {
fn from(ip: InterfaceIp) -> Self {
Self {
enabled: ip.enabled.unwrap_or_default(),
enabled_defined: ip.enabled.is_some(),
dhcp: ip.dhcp,
addresses: ip.addresses,
dhcp_client_id: ip.dhcp_client_id,
auto_dns: ip.auto_dns,
auto_routes: ip.auto_routes,
auto_gateway: ip.auto_gateway,
auto_table_id: ip.auto_table_id,
allow_extra_address: ip.allow_extra_address,
auto_route_metric: ip.auto_route_metric,
dhcp_send_hostname: ip.dhcp_send_hostname,
dhcp_custom_hostname: ip.dhcp_custom_hostname,
..Default::default()
}
}
}
impl From<InterfaceIpv4> for InterfaceIp {
fn from(ip: InterfaceIpv4) -> Self {
let enabled = if ip.enabled_defined {
Some(ip.enabled)
} else {
None
};
Self {
enabled,
dhcp: ip.dhcp,
addresses: ip.addresses,
dhcp_client_id: ip.dhcp_client_id,
auto_dns: ip.auto_dns,
auto_routes: ip.auto_routes,
auto_gateway: ip.auto_gateway,
auto_table_id: ip.auto_table_id,
allow_extra_address: ip.allow_extra_address,
auto_route_metric: ip.auto_route_metric,
dhcp_send_hostname: ip.dhcp_send_hostname,
dhcp_custom_hostname: ip.dhcp_custom_hostname,
..Default::default()
}
}
}
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize)]
#[non_exhaustive]
#[serde(into = "InterfaceIp")]
/// IPv6 configurations of interface.
/// Example output of interface holding automatic IPv6 settings:
/// ```yaml
/// ---
/// interfaces:
/// - name: eth1
/// state: up
/// mtu: 1500
/// ipv4:
/// enabled: false
/// ipv6:
/// address:
/// - ip: 2001:db8:2::1
/// prefix-length: 64
/// - ip: 2001:db8:1::1
/// prefix-length: 64
/// - ip: fe80::1ec1:cff:fe32:3bd3
/// prefix-length: 64
/// autoconf: true
/// dhcp: true
/// enabled: true
/// ```
pub struct InterfaceIpv6 {
/// Whether IPv6 stack is enable. When set to false, the IPv6 stack is
/// disabled with IPv6 link-local address purged also.
pub enabled: bool,
pub(crate) enabled_defined: bool,
/// Whether DHCPv6 enabled.
pub dhcp: Option<bool>,
/// DHCPv6 Unique Identifier
/// Serialize and deserialize to/from `dhcp-duid`.
pub dhcp_duid: Option<Dhcpv6Duid>,
/// Whether autoconf via IPv6 router announcement enabled.
pub autoconf: Option<bool>,
/// IPv6 address generation mode.
/// Serialize and deserialize to/from `addr-gen-mode`.
pub addr_gen_mode: Option<Ipv6AddrGenMode>,
/// IPv6 addresses. Will be ignored when applying with
/// DHCPv6 or autoconf is enabled.
/// When applying with `None`, current IP address will be preserved.
/// When applying with `Some(Vec::new())`, all IP address will be removed.
/// The IP addresses will apply to kernel with the same order specified.
pub addresses: Option<Vec<InterfaceIpAddr>>,
/// Whether to apply DNS resolver information retrieved from DHCPv6 or
/// autoconf.
/// Serialize and deserialize to/from `auto-dns`.
/// If you want to append static DNS name server before DHCP/Autoconf
/// provided servers, please set `auto-dns: true` explicitly a along with
/// static DNS server.
pub auto_dns: Option<bool>,
/// Whether to set default gateway retrieved from autoconf.
/// Serialize and deserialize to/from `auto-gateway`.
pub auto_gateway: Option<bool>,
/// Whether to set routes(including default gateway) retrieved from
/// autoconf.
/// Serialize and deserialize to/from `auto-routes`.
pub auto_routes: Option<bool>,
/// The route table ID used to hold routes(including default gateway)
/// retrieved from autoconf.
/// If not defined, the main(254) will be used.
/// Serialize and deserialize to/from `auto-table-id`.
pub auto_table_id: Option<u32>,
/// By default(true), nmstate verification process allows extra IP address
/// found as long as desired IP address matched.
/// When set to false, the verification process of nmstate do exact equal
/// check on IP address.
/// Ignored when serializing.
/// Deserialize from `allow-extra-address`.
pub allow_extra_address: Option<bool>,
/// Metric for routes retrieved from DHCP server.
/// Only available for autoconf enabled interface.
/// Deserialize from `auto-route-metric`.
pub auto_route_metric: Option<u32>,
/// IETF draft(expired) Tokenised IPv6 Identifiers. Should be only
/// containing the tailing 64 bites for IPv6 address.
pub token: Option<String>,
/// Whether to include hostname in DHCP request in
/// `Fully Qualified Domain Name (FQDN)` option(39) defined in RFC 4704.
/// If not defined, set to True when DHCPv6 enabled.
/// Deserialize from `dhcp-send-hostname`
pub dhcp_send_hostname: Option<bool>,
/// Custom string to override hostname used for DHCP request in
/// `Fully Qualified Domain Name (FQDN)` option(29) defined in RFC 4704.
/// If not defined, current non-dynamic hostname will be used.
/// Deserialize from `dhcp-custom-hostname`
pub dhcp_custom_hostname: Option<String>,
pub(crate) dns: Option<DnsClientState>,
pub(crate) rules: Option<Vec<RouteRuleEntry>>,
}
impl InterfaceIpv6 {
/// New [InterfaceIpv6] with IP disabled.
pub fn new() -> Self {
Self::default()
}
pub(crate) fn is_auto(&self) -> bool {
self.enabled && (self.dhcp == Some(true) || self.autoconf == Some(true))
}
pub fn is_static(&self) -> bool {
self.enabled
&& !self.is_auto()
&& !self.addresses.as_deref().unwrap_or_default().is_empty()
}
// * Set auto_dns, auto_gateway and auto_routes to true if DHCP enabled and
// those options is None
// * Disable DHCP and remove address if enabled: false
// * Set DHCP options to None if DHCP is false
// * Remove `mptcp_flags` as they are for query only
pub(crate) fn sanitize(
&mut self,
is_desired: bool,
) -> Result<(), NmstateError> {
if let Some(addrs) = self.addresses.as_mut() {
if is_desired {
for addr in addrs.as_slice().iter().filter(|a| a.is_auto()) {
log::info!("Ignoring Auto IP address {}", addr);
}
if let Some(addr) = addrs.iter().find(|a| a.ip.is_ipv4()) {
return Err(NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Got IPv4 address {} in ipv6 config section",
addr
),
));
}
if let Some(addr) = addrs
.iter()
.find(|a| a.prefix_length as usize > IPV6_ADDR_LEN)
{
return Err(NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Invalid IPv6 network prefix length '{}', \
should be in the range of 0 to {IPV6_ADDR_LEN}",
addr.prefix_length
),
));
}
}
addrs.retain(|a| !a.is_auto());
addrs.iter_mut().for_each(|a| {
a.valid_life_time = None;
a.preferred_life_time = None
});
}
if self.is_auto() {
if self.auto_dns.is_none() {
self.auto_dns = Some(true);
}
if self.auto_routes.is_none() {
self.auto_routes = Some(true);
}
if self.auto_gateway.is_none() {
self.auto_gateway = Some(true);
}
if let Some(addrs) = self.addresses.as_ref() {
if is_desired {
for addr in addrs {
log::info!(
"Static addresses {} defined when dynamic \
IP is enabled",
addr
);
}
}
}
}
if let Some(addrs) = self.addresses.as_mut() {
addrs.retain(|addr| {
if let IpAddr::V6(ip_addr) = addr.ip {
if is_ipv6_unicast_link_local(&ip_addr) {
if is_desired {
log::warn!(
"Ignoring IPv6 link local address {}/{}",
&addr.ip,
addr.prefix_length
);
}
false
} else {
true
}
} else {
false
}
})
};
if !self.enabled {
self.dhcp = None;
self.autoconf = None;
self.addresses = None;
}
if !self.is_auto() {
self.auto_dns = None;
self.auto_gateway = None;
self.auto_routes = None;
self.auto_table_id = None;
self.auto_route_metric = None;
self.dhcp_send_hostname = None;
self.dhcp_custom_hostname = None;
}
if let Some(addrs) = self.addresses.as_mut() {
for addr in addrs.iter_mut() {
addr.mptcp_flags = None;
}
}
if let Some(token) = self.token.as_mut() {
if is_desired
&& self.autoconf == Some(false)
&& !(token.is_empty() || token == "::")
{
return Err(NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Desired IPv6 token '{token}' cannot \
be applied with IPv6 autoconf disabled, \
you may remove IPv6 token by setting as \
empty string or `::`"
),
));
}
sanitize_ipv6_token_to_string(token)?;
}
if self.dhcp_send_hostname == Some(false) {
if is_desired {
if let Some(custom_hostname) =
self.dhcp_custom_hostname.as_deref()
{
if !custom_hostname.is_empty() {
log::warn!(
"Ignoring `dhcp-custom-hostname: \
{custom_hostname}` as `dhcp-send-hostname` is \
disabled"
);
}
}
}
self.dhcp_custom_hostname = None;
}
Ok(())
}
// Special action for generating merged state from desired and current.
pub(crate) fn special_merge(&mut self, desired: &Self, current: &Self) {
if !desired.enabled_defined {
self.enabled = current.enabled;
}
if desired.dhcp.is_none() && self.enabled {
self.dhcp = current.dhcp;
}
if desired.autoconf.is_none() && self.enabled {
self.autoconf = current.autoconf;
}
// Normally, we expect backend to preserve configuration which not
// mentioned in desire, but when DHCP switch from ON to OFF, the design
// of nmstate is expecting dynamic IP address goes static. This should
// be done by top level code.
if current.is_auto()
&& current.addresses.is_some()
&& self.enabled
&& !self.is_auto()
&& is_ip_addrs_none_or_all_auto(desired.addresses.as_deref())
{
self.addresses.clone_from(¤t.addresses);
}
// The rules is `pub(crate)`, it will not merged by `merge_json_value()`
self.rules.clone_from(¤t.rules);
self.sanitize(false).ok();
}
pub(crate) fn merge_ip(&mut self, current: &Self) {
if !self.enabled_defined {
self.enabled = current.enabled;
}
if self.dhcp.is_none() && self.enabled {
self.dhcp = current.dhcp;
}
if self.autoconf.is_none() && self.enabled {
self.autoconf = current.autoconf;
}
// Normally, we expect backend to preserve configuration which not
// mentioned in desire, but when DHCP switch from ON to OFF, the design
// of nmstate is expecting dynamic IP address goes static. This should
// be done by top level code.
if current.is_auto()
&& current.addresses.is_some()
&& self.enabled
&& !self.is_auto()
&& is_ip_addrs_none_or_all_auto(self.addresses.as_deref())
{
self.addresses.clone_from(¤t.addresses);
if let Some(addrs) = self.addresses.as_mut() {
addrs.as_mut_slice().iter_mut().for_each(|a| {
a.valid_life_time = None;
a.preferred_life_time = None;
});
}
}
}
}
impl<'de> Deserialize<'de> for InterfaceIpv6 {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
let v = serde_json::Value::deserialize(deserializer)?;
if let Some(v_map) = v.as_object() {
if v_map.contains_key("dhcp_client_id") {
return Err(serde::de::Error::custom(
"dhcp-client-id is not allowed for IPv6",
));
}
}
let ip: InterfaceIp = match serde_json::from_value(v) {
Ok(i) => i,
Err(e) => {
return Err(serde::de::Error::custom(format!("{e}")));
}
};
let ret = Self::from(ip);
Ok(ret)
}
}
impl From<InterfaceIp> for InterfaceIpv6 {
fn from(ip: InterfaceIp) -> Self {
Self {
enabled: ip.enabled.unwrap_or_default(),
enabled_defined: ip.enabled.is_some(),
dhcp: ip.dhcp,
autoconf: ip.autoconf,
addresses: ip.addresses,
dhcp_duid: ip.dhcp_duid,
auto_dns: ip.auto_dns,
auto_routes: ip.auto_routes,
auto_gateway: ip.auto_gateway,
auto_table_id: ip.auto_table_id,
addr_gen_mode: ip.addr_gen_mode,
allow_extra_address: ip.allow_extra_address,
auto_route_metric: ip.auto_route_metric,
token: ip.token,
dhcp_send_hostname: ip.dhcp_send_hostname,
dhcp_custom_hostname: ip.dhcp_custom_hostname,
..Default::default()
}
}
}
impl From<InterfaceIpv6> for InterfaceIp {
fn from(ip: InterfaceIpv6) -> Self {
let enabled = if ip.enabled_defined {
Some(ip.enabled)
} else {
None
};
Self {
enabled,
dhcp: ip.dhcp,
autoconf: ip.autoconf,
addresses: ip.addresses,
dhcp_duid: ip.dhcp_duid,
auto_dns: ip.auto_dns,
auto_routes: ip.auto_routes,
auto_gateway: ip.auto_gateway,
auto_table_id: ip.auto_table_id,
addr_gen_mode: ip.addr_gen_mode,
allow_extra_address: ip.allow_extra_address,
auto_route_metric: ip.auto_route_metric,
token: ip.token,
dhcp_send_hostname: ip.dhcp_send_hostname,
dhcp_custom_hostname: ip.dhcp_custom_hostname,
..Default::default()
}
}
}
#[derive(
Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize,
)]
#[serde(rename_all = "kebab-case", deny_unknown_fields)]
#[non_exhaustive]
pub struct InterfaceIpAddr {
/// IP address.
pub ip: IpAddr,
#[serde(deserialize_with = "crate::deserializer::u8_or_string")]
/// Prefix length.
/// Serialize and deserialize to/from `prefix-length`.
pub prefix_length: u8,
#[serde(skip_serializing_if = "is_none_or_empty_mptcp_flags", default)]
/// MPTCP flag on this IP address.
/// Ignored when applying as nmstate does not support support IP address
/// specific MPTCP flags. You should apply MPTCP flags at interface level
/// via [BaseInterface.mptcp].
pub mptcp_flags: Option<Vec<MptcpAddressFlag>>,
/// Remaining time for IP address been valid. The output format is
/// "32sec" or "forever".
/// This property is query only, it will be ignored when applying.
/// Serialize to `valid-life-time`.
/// Deserialize from `valid-life-time` or `valid-left` or `valid-lft`.
#[serde(
skip_serializing_if = "Option::is_none",
alias = "valid-left",
alias = "valid-lft"
)]
pub valid_life_time: Option<String>,
/// Remaining time for IP address been preferred. The output format is
/// "32sec" or "forever".
/// This property is query only, it will be ignored when applying.
/// Serialize to `preferred-life-time`.
/// Deserialize from `preferred-life-time` or `preferred-left` or
/// `preferred-lft`.
#[serde(
skip_serializing_if = "Option::is_none",
alias = "preferred-left",
alias = "preferred-lft"
)]
pub preferred_life_time: Option<String>,
}
impl Default for InterfaceIpAddr {
fn default() -> Self {
Self {
ip: IpAddr::V6(std::net::Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)),
prefix_length: 128,
mptcp_flags: None,
valid_life_time: None,
preferred_life_time: None,
}
}
}
impl std::fmt::Display for InterfaceIpAddr {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
if self.is_auto() {
write!(
f,
"{}/{} valid_life_time {} preferred_lft {}",
self.ip,
self.prefix_length,
self.valid_life_time.as_deref().unwrap_or(FOREVER),
self.preferred_life_time.as_deref().unwrap_or(FOREVER)
)
} else {
write!(f, "{}/{}", self.ip, self.prefix_length)
}
}
}
impl InterfaceIpAddr {
pub(crate) fn is_auto(&self) -> bool {
self.valid_life_time.is_some()
&& self.valid_life_time.as_deref() != Some(FOREVER)
}
}
pub(crate) fn is_ipv6_addr(addr: &str) -> bool {
addr.contains(':')
}
// Copy from Rust official std::net::Ipv6Addr::is_unicast_link_local() which
// is experimental.
pub(crate) fn is_ipv6_unicast_link_local(ip: &Ipv6Addr) -> bool {
(ip.segments()[0] & 0xffc0) == 0xfe80
}
impl std::convert::TryFrom<&str> for InterfaceIpAddr {
type Error = NmstateError;
fn try_from(value: &str) -> Result<Self, Self::Error> {
let mut addr: Vec<&str> = value.split('/').collect();
addr.resize(2, "");
let ip = IpAddr::from_str(addr[0]).map_err(|e| {
let e = NmstateError::new(
ErrorKind::InvalidArgument,
format!("Invalid IP address {}: {e}", addr[0]),
);
log::error!("{}", e);
e
})?;
let prefix_length = if addr[1].is_empty() {
if ip.is_ipv6() {
128
} else {
32
}
} else {
addr[1].parse::<u8>().map_err(|parse_error| {
let e = NmstateError::new(
ErrorKind::InvalidArgument,
format!("Invalid IP address {value}: {parse_error}"),
);
log::error!("{}", e);
e
})?
};
Ok(Self {
ip,
prefix_length,
mptcp_flags: None,
valid_life_time: None,
preferred_life_time: None,
})
}
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
/// DHCPv4 client ID
pub enum Dhcpv4ClientId {
/// Use link layer address as DHCPv4 client ID.
/// Serialize and deserialize to/from `ll`.
#[serde(rename = "ll", alias = "LL")]
LinkLayerAddress,
/// RFC 4361 type 255, 32 bits IAID followed by DUID.
/// Serialize and deserialize to/from `iaid+duid`.
#[serde(rename = "iaid+duid", alias = "IAID+DUID")]
IaidPlusDuid,
/// hex string or backend specific client id type
#[serde(untagged)]
Other(String),
}
impl std::fmt::Display for Dhcpv4ClientId {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}",
match self {
Dhcpv4ClientId::LinkLayerAddress => "ll",
Dhcpv4ClientId::IaidPlusDuid => "iaid+duid",
Dhcpv4ClientId::Other(s) => s,
}
)
}
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "kebab-case")]
/// DHCPv6 Unique Identifier
pub enum Dhcpv6Duid {
/// DUID Based on Link-Layer Address Plus Time
/// Serialize and deserialize to/from `llt`.
#[serde(rename = "llt", alias = "LLT")]
LinkLayerAddressPlusTime,
/// DUID Assigned by Vendor Based on Enterprise Number
/// Serialize and deserialize to/from `en`.
#[serde(rename = "en", alias = "EN")]
EnterpriseNumber,
/// DUID Assigned by Vendor Based on Enterprise Number
/// Serialize and deserialize to/from `ll`.
#[serde(rename = "ll", alias = "LL")]
LinkLayerAddress,
/// DUID Based on Universally Unique Identifier
/// Serialize and deserialize to/from `uuid`.
#[serde(alias = "UUID")]
Uuid,
/// Backend specific
#[serde(untagged)]
Other(String),
}
impl std::fmt::Display for Dhcpv6Duid {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}",
match self {
Dhcpv6Duid::LinkLayerAddressPlusTime => "llt",
Dhcpv6Duid::EnterpriseNumber => "en",
Dhcpv6Duid::LinkLayerAddress => "ll",
Dhcpv6Duid::Uuid => "uuid",
Dhcpv6Duid::Other(s) => s,
}
)
}
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
/// IPv6 address generation mode
pub enum Ipv6AddrGenMode {
/// EUI-64 format defined by RFC 4862
/// Serialize and deserialize to/from `eui64`.
#[serde(rename = "eui64", alias = "EUI64")]
Eui64,
/// Semantically Opaque Interface Identifiers defined by RFC 7217
/// Serialize and deserialize to/from `stable-privacy`.
#[serde(rename = "stable-privacy", alias = "STABLE-PRIVACY")]
StablePrivacy,
/// Backend specific
#[serde(untagged)]
Other(String),
}
impl std::fmt::Display for Ipv6AddrGenMode {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}",
match self {
Ipv6AddrGenMode::Eui64 => "eui64",
Ipv6AddrGenMode::StablePrivacy => "stable-privacy",
Ipv6AddrGenMode::Other(s) => s,
}
)
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case", deny_unknown_fields)]
#[non_exhaustive]
/// Which IP stack should network backend wait before considering the interface
/// activation finished.
pub enum WaitIp {
/// The activation is considered done once IPv4 stack or IPv6 stack is
/// configure
/// Serialize and deserialize to/from `any`.
Any,
/// The activation is considered done once IPv4 stack is configured.
/// Serialize and deserialize to/from `ipv4`.
Ipv4,
/// The activation is considered done once IPv6 stack is configured.
/// Serialize and deserialize to/from `ipv6`.
Ipv6,
/// The activation is considered done once both IPv4 and IPv6 stack are
/// configured.
/// Serialize and deserialize to/from `ipv4+ipv6`.
#[serde(rename = "ipv4+ipv6")]
Ipv4AndIpv6,
}
impl std::fmt::Display for WaitIp {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}",
match self {
Self::Any => "any",
Self::Ipv4 => "ipv4",
Self::Ipv6 => "ipv6",
Self::Ipv4AndIpv6 => "ipv4+ipv6",
}
)
}
}
fn validate_wait_ip(base_iface: &BaseInterface) -> Result<(), NmstateError> {
if let Some(wait_ip) = base_iface.wait_ip.as_ref() {
if (wait_ip == &WaitIp::Ipv4 || wait_ip == &WaitIp::Ipv4AndIpv6)
&& !base_iface
.ipv4
.as_ref()
.map(|i| i.enabled)
.unwrap_or_default()
{
let e = NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Cannot set 'wait-ip: {}' with IPv4 disabled. \
Interface: {}({})",
wait_ip, &base_iface.name, &base_iface.iface_type
),
);
log::error!("{}", e);
return Err(e);
}
if (wait_ip == &WaitIp::Ipv6 || wait_ip == &WaitIp::Ipv4AndIpv6)
&& !base_iface
.ipv6
.as_ref()
.map(|i| i.enabled)
.unwrap_or_default()
{
let e = NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Cannot set 'wait-ip: {}' with IPv6 disabled. \
Interface: {}({})",
wait_ip, &base_iface.name, &base_iface.iface_type
),
);
log::error!("{}", e);
return Err(e);
}
}
Ok(())
}
pub(crate) fn sanitize_ip_network(
ip_net: &str,
) -> Result<String, NmstateError> {
let ip_nets: Vec<&str> = ip_net.split('/').collect();
match ip_nets.len() {
0 => Err(NmstateError::new(
ErrorKind::InvalidArgument,
"Invalid IP network string, got empty string".into(),
)),
1 => {
let ip = IpAddr::from_str(ip_nets[0]).map_err(|e| {
NmstateError::new(
ErrorKind::InvalidArgument,
format!("Invalid IP network '{ip_net}': {e}",),
)
})?;
Ok(if ip.is_ipv6() {
format!("{ip}/{IPV6_ADDR_LEN}")
} else {
format!("{ip}/{IPV4_ADDR_LEN}")
})
}
2 => {
let prefix_len = ip_nets[1].parse::<usize>().map_err(|e| {
NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Invalid IP network prefix length \
'{}' in '{ip_net}': {e}",
ip_nets[1]
),
)
})?;
let ip =
apply_ip_prefix_len(IpAddr::from_str(ip_nets[0])?, prefix_len);
if ip.is_ipv6() {
if prefix_len > IPV6_ADDR_LEN {
Err(NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Invalid IPv6 network prefix length '{}' \
in '{ip_net}', should be smaller than \
{IPV6_ADDR_LEN}'",
ip_nets[1],
),
))
} else {
Ok(format!("{ip}/{prefix_len}"))
}
} else if prefix_len > IPV4_ADDR_LEN {
Err(NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Invalid IPv4 network prefix length '{}' \
in '{ip_net}', should be smaller than \
{IPV4_ADDR_LEN}'",
ip_nets[1],
),
))
} else {
Ok(format!("{ip}/{prefix_len}"))
}
}
_ => Err(NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Invalid IP network string: '{ip_net}', expecting 'ip/prefix' \
or 'ip' format, for example: 192.0.2.0/24 or \
2001:db8:1::/64 or 192.0.2.1"
),
)),
}
}
fn is_none_or_empty_mptcp_flags(v: &Option<Vec<MptcpAddressFlag>>) -> bool {
if let Some(v) = v {
v.is_empty()
} else {
true
}
}
#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Clone, Copy)]
#[serde(rename_all = "lowercase")]
#[non_exhaustive]
pub enum AddressFamily {
IPv4,
IPv6,
Unknown,
}
impl From<u8> for AddressFamily {
fn from(d: u8) -> Self {
match d {
AF_INET => AddressFamily::IPv4,
AF_INET6 => AddressFamily::IPv6,
_ => AddressFamily::Unknown,
}
}
}
impl Default for AddressFamily {
fn default() -> Self {
Self::IPv4
}
}
impl std::fmt::Display for AddressFamily {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}",
match self {
Self::IPv4 => "ipv4",
Self::IPv6 => "ipv6",
Self::Unknown => "unknown",
}
)
}
}
impl MergedInterface {
// * Merge `enabled: true` from current if not mentioned in desired.
pub(crate) fn post_inter_ifaces_process_ip(
&mut self,
) -> Result<(), NmstateError> {
if let (Some(current), Some(apply_iface), Some(verify_iface)) = (
self.current.as_ref().map(|i| i.base_iface()),
self.for_apply.as_mut().map(|i| i.base_iface_mut()),
self.for_verify.as_mut().map(|i| i.base_iface_mut()),
) {
if let (Some(des_ipv4), Some(cur_ipv4)) =
(apply_iface.ipv4.as_mut(), current.ipv4.as_ref())
{
des_ipv4.merge_ip(cur_ipv4);
}
if let (Some(des_ipv6), Some(cur_ipv6)) =
(apply_iface.ipv6.as_mut(), current.ipv6.as_ref())
{
des_ipv6.merge_ip(cur_ipv6);
}
if let (Some(des_ipv4), Some(cur_ipv4)) =
(verify_iface.ipv4.as_mut(), current.ipv4.as_ref())
{
des_ipv4.merge_ip(cur_ipv4);
}
if let (Some(des_ipv6), Some(cur_ipv6)) =
(verify_iface.ipv6.as_mut(), current.ipv6.as_ref())
{
des_ipv6.merge_ip(cur_ipv6);
}
validate_wait_ip(apply_iface)?;
if !apply_iface.can_have_ip() {
apply_iface.wait_ip = None;
verify_iface.wait_ip = None;
}
}
Ok(())
}
}
// User might define IPv6 token in the format of `::0.0.250.193`, which should
// be sanitize to `::fac1`.
fn sanitize_ipv6_token_to_string(
token: &mut String,
) -> Result<(), NmstateError> {
// Empty token means reverting to default "::"
if token.is_empty() {
write!(token, "::").ok();
} else {
match Ipv6Addr::from_str(token.as_str()) {
Ok(ip) => {
if ip.octets()[..8] != [0; 8] {
return Err(NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Desired IPv6 token should be lead \
by 64 bits 0. But got {token}"
),
));
}
// The Ipv6Addr::to_string() will convert
// ::fac1 to ::0.0.250.193
// Which is no ideal in this case
// To workaround that, we set leading 64 bits to '2001:db8::',
// and then trip it out from string.
let mut segments = ip.segments();
segments[0] = 0x2001;
segments[1] = 0xdb8;
let new_ip = Ipv6Addr::from(segments);
token.clear();
write!(token, "{}", &new_ip.to_string()["2001:db8".len()..])
.ok();
}
Err(e) => {
return Err(NmstateError::new(
ErrorKind::InvalidArgument,
format!(
"Desired IPv6 token '{token}' is not a \
valid IPv6 address: {e}"
),
));
}
}
}
Ok(())
}
fn is_ip_addrs_none_or_all_auto(addrs: Option<&[InterfaceIpAddr]>) -> bool {
addrs.map_or(true, |addrs| {
addrs.iter().all(|a| {
if let IpAddr::V6(ip_addr) = a.ip {
is_ipv6_unicast_link_local(&ip_addr) || a.is_auto()
} else {
a.is_auto()
}
})
})
}
fn apply_ip_prefix_len(ip: IpAddr, prefix_length: usize) -> IpAddr {
if prefix_length == 0 {
return if ip.is_ipv6() {
IpAddr::V6(0.into())
} else {
IpAddr::V4(0.into())
};
}
if (ip.is_ipv6() && prefix_length >= IPV6_ADDR_LEN)
|| (ip.is_ipv4() && prefix_length >= IPV4_ADDR_LEN)
{
return ip;
}
match ip {
IpAddr::V6(i) => Ipv6Addr::from(
u128::from(i) & (u128::MAX << (IPV6_ADDR_LEN - prefix_length)),
)
.into(),
IpAddr::V4(i) => Ipv4Addr::from(
u32::from(i) & (u32::MAX << (IPV4_ADDR_LEN - prefix_length)),
)
.into(),
}
}