add optional description to network-interfaces

Author: superstes

src/firewall_test/plugins/translate/abstract.py

@@ -161,7 +161,7 @@ class NetworkInterface(TranslateOutput):
     def __init__(
             self,
             name: str, up: bool, ip4: list[str], ip6: list[str],
-            net4: list[str], net6: list[str], mac: str = None,
+            net4: list[str], net6: list[str], mac: str = None, desc: str = None,
     ):
         self.name = name
         self.up = up
@@ -170,9 +170,11 @@ def __init__(
         self.net4 = net4
         self.net6 = net6
         self.mac = mac
+        self.desc = desc
 
     def __repr__(self) -> str:
-        return f'NETWORK-INTERFACE: {self.name} with IPv4 {self.ip4} and IPv6 {self.ip6}'
+        desc = '' if self.desc is None else f' description {self.desc}'
+        return f'NETWORK-INTERFACE: {self.name} with IPv4 {self.ip4} and IPv6 {self.ip6}{desc}'
 
     def dump(self) -> dict:
         ip4, ip6, net4, net6 = [], [], [], []
@@ -196,6 +198,7 @@ def dump(self) -> dict:
             'net4': net4,
             'net6': net6,
             'mac': self.mac,
+            'desc': self.desc,
         }
 
     def validate(self):

src/firewall_test/plugins/translate/opnsense/interfaces.py

@@ -28,6 +28,7 @@ def _parse_ni(raw: dict) -> dict:
             'net4': [],
             'net6': [],
             'up': raw['status'] == 'up',
+            'desc': raw.get('description', None),
         }
 
         ips = raw.get('ipv4', [])

src/firewall_test/simulator/main.py

@@ -39,7 +39,7 @@ def __init__(self, packet: PACKET_KINDS, simulator):
         self.route_src = self._s.router.get_src_route(self.packet)
         self._update_packet_ni_in()
         if packet.ni_in is not None:
-            log_info('Router', f'Packet inbound-interface: {packet.ni_in}')
+            self._log_ni(in_out='in', name=packet.ni_in)
 
         if self.route_src is None:
             log_error('Router', 'No Source-Route found', final=True)
@@ -72,7 +72,7 @@ def __init__(self, packet: PACKET_KINDS, simulator):
         self.route_dst = self._s.router.get_route(self.packet)
         self._update_packet_ni_out()
         if packet.ni_out is not None:
-            log_info('Router', f'Packet outbound-interface: {packet.ni_out}')
+            self._log_ni(in_out='out', name=packet.ni_out)
 
         if self.flow_type != FlowInput:
             if self.route_dst is None:
@@ -244,6 +244,17 @@ def _log_route(self, out: bool, route: StaticRoute):
 
         log_info('Router', msg)
 
+    def _log_ni(self, in_out: str, name: str):
+        desc = ''
+        for ni in self._s.nis:
+            if ni.name == name:
+                if ni.desc is not None:
+                    desc = f' ({ni.desc})'
+
+                break
+
+        log_info('Router', f'Packet {in_out}bound-interface: {name}{desc}')
+
     @staticmethod
     def _log_block(rule: (Rule, None)):
         if rule is None: