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
|
# Copyright(C) 2022 FreeBSD Foundation
#
# Author: Mina Galić <me+FreeBSD@igalic.co>
#
# This file is part of cloud-init. See LICENSE file for license information.
import copy
import re
from functools import lru_cache
from ipaddress import IPv4Address, IPv4Interface, IPv6Interface
from typing import Dict, Optional, Tuple
from cloudinit import log as logging
LOG = logging.getLogger(__name__)
MAC_RE = r"""([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}"""
class Ifstate:
"""
This class holds the parsed state of a BSD network interface.
It is itself side-effect free.
All methods with side-effects should be implemented on one of the
``BSDNetworking`` classes.
"""
def __init__(self, name):
self.name = name
self.index: int = 0
self.inet = {}
self.inet6 = {}
self.up = False
self.options = []
self.nd6 = []
self.flags = []
self.mtu: int = 0
self.metric: int = 0
self.groups = []
self.description: Optional[str] = None
self.media: Optional[str] = None
self.status: Optional[str] = None
self.mac: Optional[str] = None
self.macs = []
self.vlan = {}
self.members = []
@property
def is_loopback(self) -> bool:
return "loopback" in self.flags or "lo" in self.groups
@property
def is_physical(self) -> bool:
# OpenBSD makes this very easy:
if "egress" in self.groups:
return True
if self.groups == [] and self.media and "Ethernet" in self.media:
return True
return False
@property
def is_bridge(self) -> bool:
return "bridge" in self.groups
@property
def is_bond(self) -> bool:
return "lagg" in self.groups
@property
def is_vlan(self) -> bool:
return ("vlan" in self.groups) or (self.vlan != {})
@property
def is_wlan(self) -> bool:
return "wlan" in self.groups
class Ifconfig:
"""
A parser for BSD style ``ifconfig(8)`` output.
For documentation here:
- https://man.freebsd.org/ifconfig(8)
- https://man.netbsd.org/ifconfig.8
- https://man.openbsd.org/ifconfig.8
All output is considered equally, and then massaged into a singular form:
an ``Ifstate`` object.
"""
def __init__(self):
self._ifs = {}
@lru_cache()
def parse(self, text: str) -> Dict[str, Ifstate]:
"""
Parse the ``ifconfig -a`` output ``text``, into a dict of ``Ifstate``
objects, referenced by ``name`` *and* by ``mac`` address.
This dict will always be the same, given the same input, so we can
``@lru_cache()`` it. n.b.: ``@lru_cache()`` takes only the
``__hash__()`` of the input (``text``), so it should be fairly quick,
despite our giant inputs.
@param text: The output of ``ifconfig -a``
@returns: A dict of ``Ifstate``s, referenced by ``name`` and ``mac``
"""
ifindex = 0
for line in text.splitlines():
if len(line) == 0:
continue
if line[0] not in ("\t", " "):
# We hit the start of a device block in the ifconfig output
# These start with devN: flags=NNNN<flags> and then continue
# *indented* for the rest of the config.
# Here our loop resets ``curif`` & ``dev`` to this new device
ifindex += 1
curif = line.split()[0]
# current ifconfig pops a ':' on the end of the device
if curif.endswith(":"):
curif = curif[:-1]
dev = Ifstate(curif)
dev.index = ifindex
self._ifs[curif] = dev
toks = line.lower().strip().split()
if len(toks) > 1 and toks[1].startswith("flags="):
flags = self._parse_flags(toks)
if flags != {}:
dev.flags = copy.deepcopy(flags["flags"])
dev.up = flags["up"]
if "mtu" in flags:
dev.mtu = flags["mtu"]
if "metric" in flags:
dev.metric = flags["metric"]
if toks[0].startswith("capabilities="):
caps = re.split(r"<|>", toks[0])
dev.flags.append(caps)
if toks[0] == "index":
# We have found a real index! override our fake one
dev.index = int(toks[1])
if toks[0] == "description:":
dev.description = line[line.index(":") + 2 :]
if (
toks[0].startswith("options=")
or toks[0].startswith("ec_capabilities")
or toks[0].startswith("ec_enabled")
):
options = re.split(r"<|>", toks[0])
if len(options) > 1:
dev.options += options[1].split(",")
# We also store the Ifstate reference under all mac addresses
# so we can easier reverse-find it.
if toks[0] == "ether":
dev.mac = toks[1]
dev.macs.append(toks[1])
self._ifs[toks[1]] = dev
if toks[0] == "hwaddr":
dev.macs.append(toks[1])
self._ifs[toks[1]] = dev
if toks[0] == "groups:":
dev.groups += toks[1:]
if toks[0] == "media:":
dev.media = line[line.index(": ") + 2 :]
if toks[0] == "nd6":
nd6_opts = re.split(r"<|>", toks[0])
if len(nd6_opts) > 1:
dev.nd6 = nd6_opts[1].split(",")
if toks[0] == "status":
dev.status = toks[1]
if toks[0] == "inet":
ip = self._parse_inet(toks)
dev.inet[ip[0]] = copy.deepcopy(ip[1])
if toks[0] == "inet6":
ip = self._parse_inet6(toks)
dev.inet6[ip[0]] = copy.deepcopy(ip[1])
# bridges and ports are kind of the same thing, right?
if toks[0] == "member:" or toks[0] == "laggport:":
dev.members += toks[1]
if toks[0] == "vlan:":
dev.vlan = {}
dev.vlan["id"] = toks[1]
for i in range(2, len(toks)):
if toks[i] == "interface:":
dev.vlan["link"] = toks[i + 1]
return self._ifs
def ifs_by_name(self):
return {
k: v for (k, v) in self._ifs.items() if not re.fullmatch(MAC_RE, k)
}
def ifs_by_mac(self):
return {
k: v for (k, v) in self._ifs.items() if re.fullmatch(MAC_RE, k)
}
def _parse_inet(self, toks: list) -> Tuple[str, dict]:
broadcast = None
if "/" in toks[1]:
ip = IPv4Interface(toks[1])
netmask = str(ip.netmask)
if "broadcast" in toks:
broadcast = toks[toks.index("broadcast") + 1]
else:
netmask = str(IPv4Address(int(toks[3], 0)))
if "broadcast" in toks:
broadcast = toks[toks.index("broadcast") + 1]
ip = IPv4Interface("%s/%s" % (toks[1], netmask))
prefixlen = ip.with_prefixlen.split("/")[1]
return (
str(ip.ip),
{
"netmask": netmask,
"broadcast": broadcast,
"prefixlen": prefixlen,
},
)
def _get_prefixlen(self, toks):
for i in range(2, len(toks)):
if toks[i] == "prefixlen":
return toks[i + 1]
def _parse_inet6(self, toks: list) -> Tuple[str, dict]:
scope = None
# workaround https://github.com/python/cpython/issues/78969
if "%" in toks[1]:
scope = "link-local"
ip6, rest = toks[1].split("%")
if "/" in rest:
prefixlen = rest.split("/")[1]
else:
prefixlen = self._get_prefixlen(toks)
ip = IPv6Interface("%s/%s" % (ip6, prefixlen))
elif "/" in toks[1]:
ip = IPv6Interface(toks[1])
prefixlen = toks[1].split("/")[1]
else:
prefixlen = self._get_prefixlen(toks)
ip = IPv6Interface("%s/%s" % (toks[1], prefixlen))
if not scope and ip.is_link_local:
scope = "link-local"
elif not scope and ip.is_site_local:
scope = "site-local"
return (str(ip.ip), {"prefixlen": prefixlen, "scope": scope})
def _parse_flags(self, toks: list) -> dict:
flags = re.split(r"<|>", toks[1])
ret = {}
if len(flags) > 1:
ret["flags"] = flags[1].split(",")
if "up" in ret["flags"]:
ret["up"] = True
else:
ret["up"] = False
for t in range(2, len(toks)):
if toks[t] == "metric":
ret["metric"] = int(toks[t + 1])
elif toks[t] == "mtu":
ret["mtu"] = int(toks[t + 1])
return ret
|
