src/network/networkd-network.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include "sd-bus.h"
   5 #include "sd-device.h"
   6
   7 #include "condition.h"
   8 #include "conf-parser.h"
   9 #include "dhcp-identifier.h"
  10 #include "hashmap.h"
  11 #include "netdev/bridge.h"
  12 #include "netdev/netdev.h"
  13 #include "networkd-address-label.h"
  14 #include "networkd-address.h"
  15 #include "networkd-brvlan.h"
  16 #include "networkd-fdb.h"
  17 #include "networkd-ipv6-proxy-ndp.h"
  18 #include "networkd-lldp-rx.h"
  19 #include "networkd-lldp-tx.h"
  20 #include "networkd-neighbor.h"
  21 #include "networkd-radv.h"
  22 #include "networkd-route.h"
  23 #include "networkd-routing-policy-rule.h"
  24 #include "networkd-util.h"
  25 #include "ordered-set.h"
  26 #include "resolve-util.h"
  27
  28 #define DHCP_ROUTE_METRIC 1024
  29 #define IPV4LL_ROUTE_METRIC 2048
  30
  31 #define BRIDGE_VLAN_BITMAP_MAX 4096
  32 #define BRIDGE_VLAN_BITMAP_LEN (BRIDGE_VLAN_BITMAP_MAX / 32)
  33
  34 typedef enum DHCPClientIdentifier {
  35         DHCP_CLIENT_ID_MAC,
  36         DHCP_CLIENT_ID_DUID,
  37         /* The following option may not be good for RFC regarding DHCP (3315 and 4361).
  38          * But some setups require this. E.g., Sky Broadband, the second largest provider in the UK
  39          * requires the client id to be set to a custom string, reported at
  40          * https://github.com/systemd/systemd/issues/7828 */
  41         DHCP_CLIENT_ID_DUID_ONLY,
  42         _DHCP_CLIENT_ID_MAX,
  43         _DHCP_CLIENT_ID_INVALID = -1,
  44 } DHCPClientIdentifier;
  45
  46 typedef enum IPv6PrivacyExtensions {
  47         /* The values map to the kernel's /proc/sys/net/ipv6/conf/xxx/use_tempaddr values */
  48         IPV6_PRIVACY_EXTENSIONS_NO,
  49         IPV6_PRIVACY_EXTENSIONS_PREFER_PUBLIC,
  50         IPV6_PRIVACY_EXTENSIONS_YES, /* aka prefer-temporary */
  51         _IPV6_PRIVACY_EXTENSIONS_MAX,
  52         _IPV6_PRIVACY_EXTENSIONS_INVALID = -1,
  53 } IPv6PrivacyExtensions;
  54
  55 typedef enum DHCPUseDomains {
  56         DHCP_USE_DOMAINS_NO,
  57         DHCP_USE_DOMAINS_YES,
  58         DHCP_USE_DOMAINS_ROUTE,
  59         _DHCP_USE_DOMAINS_MAX,
  60         _DHCP_USE_DOMAINS_INVALID = -1,
  61 } DHCPUseDomains;
  62
  63 typedef struct DUID {
  64         /* Value of Type in [DHCP] section */
  65         DUIDType type;
  66
  67         uint8_t raw_data_len;
  68         uint8_t raw_data[MAX_DUID_LEN];
  69         usec_t llt_time;
  70 } DUID;
  71
  72 typedef enum RADVPrefixDelegation {
  73         RADV_PREFIX_DELEGATION_NONE,
  74         RADV_PREFIX_DELEGATION_STATIC,
  75         RADV_PREFIX_DELEGATION_DHCP6,
  76         RADV_PREFIX_DELEGATION_BOTH,
  77         _RADV_PREFIX_DELEGATION_MAX,
  78         _RADV_PREFIX_DELEGATION_INVALID = -1,
  79 } RADVPrefixDelegation;
  80
  81 typedef struct Manager Manager;
  82
  83 struct Network {
  84         Manager *manager;
  85
  86         char *filename;
  87         char *name;
  88
  89         unsigned n_ref;
  90
  91         Set *match_mac;
  92         char **match_path;
  93         char **match_driver;
  94         char **match_type;
  95         char **match_name;
  96         LIST_HEAD(Condition, conditions);
  97
  98         char *description;
  99
 100         NetDev *bridge;
 101         NetDev *bond;
 102         NetDev *vrf;
 103         Hashmap *stacked_netdevs;
 104         char *bridge_name;
 105         char *bond_name;
 106         char *vrf_name;
 107         Hashmap *stacked_netdev_names;
 108
 109         /* DHCP Client Support */
 110         AddressFamilyBoolean dhcp;
 111         DHCPClientIdentifier dhcp_client_identifier;
 112         char *dhcp_vendor_class_identifier;
 113         char **dhcp_user_class;
 114         char *dhcp_hostname;
 115         uint64_t dhcp_max_attempts;
 116         unsigned dhcp_route_metric;
 117         uint32_t dhcp_route_table;
 118         uint16_t dhcp_client_port;
 119         bool dhcp_anonymize;
 120         bool dhcp_send_hostname;
 121         bool dhcp_broadcast;
 122         bool dhcp_critical;
 123         bool dhcp_use_dns;
 124         bool dhcp_use_ntp;
 125         bool dhcp_use_mtu;
 126         bool dhcp_use_routes;
 127         bool dhcp_use_timezone;
 128         bool rapid_commit;
 129         bool dhcp_use_hostname;
 130         bool dhcp_route_table_set;
 131         DHCPUseDomains dhcp_use_domains;
 132         Set *dhcp_black_listed_ip;
 133
 134         /* DHCP Server Support */
 135         bool dhcp_server;
 136         bool dhcp_server_emit_dns;
 137         struct in_addr *dhcp_server_dns;
 138         unsigned n_dhcp_server_dns;
 139         bool dhcp_server_emit_ntp;
 140         struct in_addr *dhcp_server_ntp;
 141         unsigned n_dhcp_server_ntp;
 142         bool dhcp_server_emit_router;
 143         bool dhcp_server_emit_timezone;
 144         char *dhcp_server_timezone;
 145         usec_t dhcp_server_default_lease_time_usec, dhcp_server_max_lease_time_usec;
 146         uint32_t dhcp_server_pool_offset;
 147         uint32_t dhcp_server_pool_size;
 148
 149         /* IPV4LL Support */
 150         AddressFamilyBoolean link_local;
 151         bool ipv4ll_route;
 152
 153         /* IPv6 prefix delegation support */
 154         RADVPrefixDelegation router_prefix_delegation;
 155         usec_t router_lifetime_usec;
 156         uint8_t router_preference;
 157         bool router_managed;
 158         bool router_other_information;
 159         bool router_emit_dns;
 160         bool router_emit_domains;
 161         usec_t router_dns_lifetime_usec;
 162         struct in6_addr *router_dns;
 163         unsigned n_router_dns;
 164         OrderedSet *router_search_domains;
 165         bool dhcp6_force_pd_other_information; /* Start DHCPv6 PD also when 'O'
 166                                                   RA flag is set, see RFC 7084,
 167                                                   WPD-4 */
 168
 169         /* Bridge Support */
 170         int use_bpdu;
 171         int hairpin;
 172         int fast_leave;
 173         int allow_port_to_be_root;
 174         int unicast_flood;
 175         int multicast_flood;
 176         int multicast_to_unicast;
 177         int neighbor_suppression;
 178         int learning;
 179         int bridge_proxy_arp;
 180         int bridge_proxy_arp_wifi;
 181         uint32_t cost;
 182         uint16_t priority;
 183         MulticastRouter multicast_router;
 184
 185         bool use_br_vlan;
 186         uint16_t pvid;
 187         uint32_t br_vid_bitmap[BRIDGE_VLAN_BITMAP_LEN];
 188         uint32_t br_untagged_bitmap[BRIDGE_VLAN_BITMAP_LEN];
 189
 190         /* CAN support */
 191         size_t can_bitrate;
 192         unsigned can_sample_point;
 193         usec_t can_restart_us;
 194         int can_triple_sampling;
 195
 196         AddressFamilyBoolean ip_forward;
 197         bool ip_masquerade;
 198
 199         int ipv6_accept_ra;
 200         int ipv6_dad_transmits;
 201         int ipv6_hop_limit;
 202         int ipv6_proxy_ndp;
 203         int proxy_arp;
 204         uint32_t ipv6_mtu;
 205
 206         bool ipv6_accept_ra_use_dns;
 207         bool ipv6_accept_ra_use_autonomous_prefix;
 208         bool ipv6_accept_ra_use_onlink_prefix;
 209         bool active_slave;
 210         bool primary_slave;
 211         DHCPUseDomains ipv6_accept_ra_use_domains;
 212         uint32_t ipv6_accept_ra_route_table;
 213         bool ipv6_accept_ra_route_table_set;
 214
 215         union in_addr_union ipv6_token;
 216         IPv6PrivacyExtensions ipv6_privacy_extensions;
 217
 218         struct ether_addr *mac;
 219         uint32_t mtu;
 220         bool mtu_is_set; /* Indicate MTUBytes= is specified. */
 221         int arp;
 222         int multicast;
 223         int allmulticast;
 224         bool unmanaged;
 225         bool configure_without_carrier;
 226         bool ignore_carrier_loss;
 227         uint32_t iaid;
 228         DUID duid;
 229
 230         bool iaid_set;
 231
 232         bool required_for_online; /* Is this network required to be considered online? */
 233         LinkOperationalState required_operstate_for_online;
 234
 235         LLDPMode lldp_mode; /* LLDP reception */
 236         LLDPEmit lldp_emit; /* LLDP transmission */
 237
 238         LIST_HEAD(Address, static_addresses);
 239         LIST_HEAD(Route, static_routes);
 240         LIST_HEAD(FdbEntry, static_fdb_entries);
 241         LIST_HEAD(IPv6ProxyNDPAddress, ipv6_proxy_ndp_addresses);
 242         LIST_HEAD(Neighbor, neighbors);
 243         LIST_HEAD(AddressLabel, address_labels);
 244         LIST_HEAD(Prefix, static_prefixes);
 245         LIST_HEAD(RoutingPolicyRule, rules);
 246
 247         unsigned n_static_addresses;
 248         unsigned n_static_routes;
 249         unsigned n_static_fdb_entries;
 250         unsigned n_ipv6_proxy_ndp_addresses;
 251         unsigned n_neighbors;
 252         unsigned n_address_labels;
 253         unsigned n_static_prefixes;
 254         unsigned n_rules;
 255
 256         Hashmap *addresses_by_section;
 257         Hashmap *routes_by_section;
 258         Hashmap *fdb_entries_by_section;
 259         Hashmap *neighbors_by_section;
 260         Hashmap *address_labels_by_section;
 261         Hashmap *prefixes_by_section;
 262         Hashmap *rules_by_section;
 263
 264         /* All kinds of DNS configuration */
 265         struct in_addr_data *dns;
 266         unsigned n_dns;
 267         OrderedSet *search_domains, *route_domains;
 268
 269         int dns_default_route;
 270         ResolveSupport llmnr;
 271         ResolveSupport mdns;
 272         DnssecMode dnssec_mode;
 273         DnsOverTlsMode dns_over_tls_mode;
 274         Set *dnssec_negative_trust_anchors;
 275
 276         char **ntp;
 277         char **bind_carrier;
 278 };
 279
 280 Network *network_ref(Network *network);
 281 Network *network_unref(Network *network);
 282 DEFINE_TRIVIAL_CLEANUP_FUNC(Network*, network_unref);
 283
 284 int network_load(Manager *manager);
 285 int network_load_one(Manager *manager, const char *filename);
 286 int network_verify(Network *network);
 287
 288 int network_get_by_name(Manager *manager, const char *name, Network **ret);
 289 int network_get(Manager *manager, sd_device *device, const char *ifname, const struct ether_addr *mac, Network **ret);
 290 int network_apply(Network *network, Link *link);
 291 void network_apply_anonymize_if_set(Network *network);
 292
 293 bool network_has_static_ipv6_addresses(Network *network);
 294
 295 CONFIG_PARSER_PROTOTYPE(config_parse_stacked_netdev);
 296 CONFIG_PARSER_PROTOTYPE(config_parse_domains);
 297 CONFIG_PARSER_PROTOTYPE(config_parse_tunnel);
 298 CONFIG_PARSER_PROTOTYPE(config_parse_dhcp);
 299 CONFIG_PARSER_PROTOTYPE(config_parse_dns);
 300 CONFIG_PARSER_PROTOTYPE(config_parse_dhcp_client_identifier);
 301 CONFIG_PARSER_PROTOTYPE(config_parse_ipv6token);
 302 CONFIG_PARSER_PROTOTYPE(config_parse_ipv6_privacy_extensions);
 303 CONFIG_PARSER_PROTOTYPE(config_parse_hostname);
 304 CONFIG_PARSER_PROTOTYPE(config_parse_timezone);
 305 CONFIG_PARSER_PROTOTYPE(config_parse_dhcp_server_dns);
 306 CONFIG_PARSER_PROTOTYPE(config_parse_dhcp_black_listed_ip_address);
 307 CONFIG_PARSER_PROTOTYPE(config_parse_radv_dns);
 308 CONFIG_PARSER_PROTOTYPE(config_parse_radv_search_domains);
 309 CONFIG_PARSER_PROTOTYPE(config_parse_dhcp_server_ntp);
 310 CONFIG_PARSER_PROTOTYPE(config_parse_dnssec_negative_trust_anchors);
 311 CONFIG_PARSER_PROTOTYPE(config_parse_dhcp_use_domains);
 312 CONFIG_PARSER_PROTOTYPE(config_parse_section_route_table);
 313 CONFIG_PARSER_PROTOTYPE(config_parse_dhcp_user_class);
 314 CONFIG_PARSER_PROTOTYPE(config_parse_ntp);
 315 CONFIG_PARSER_PROTOTYPE(config_parse_iaid);
 316 CONFIG_PARSER_PROTOTYPE(config_parse_required_for_online);
 317 CONFIG_PARSER_PROTOTYPE(config_parse_dhcp_max_attempts);
 318 /* Legacy IPv4LL support */
 319 CONFIG_PARSER_PROTOTYPE(config_parse_ipv4ll);
 320
 321 const struct ConfigPerfItem* network_network_gperf_lookup(const char *key, GPERF_LEN_TYPE length);
 322
 323 extern const sd_bus_vtable network_vtable[];
 324
 325 int network_node_enumerator(sd_bus *bus, const char *path, void *userdata, char ***nodes, sd_bus_error *error);
 326 int network_object_find(sd_bus *bus, const char *path, const char *interface, void *userdata, void **found, sd_bus_error *error);
 327
 328 const char* ipv6_privacy_extensions_to_string(IPv6PrivacyExtensions i) _const_;
 329 IPv6PrivacyExtensions ipv6_privacy_extensions_from_string(const char *s) _pure_;
 330
 331 const char* dhcp_use_domains_to_string(DHCPUseDomains p) _const_;
 332 DHCPUseDomains dhcp_use_domains_from_string(const char *s) _pure_;
 333
 334 const char* radv_prefix_delegation_to_string(RADVPrefixDelegation i) _const_;
 335 RADVPrefixDelegation radv_prefix_delegation_from_string(const char *s) _pure_;