|
| 1 | +"""Regression tests for :func:`pcapkit.toolkit.scapy.packet2dict` (#1259, #1260).""" |
| 2 | + |
| 3 | +from __future__ import annotations |
| 4 | + |
| 5 | +import importlib.util |
| 6 | +import unittest |
| 7 | + |
| 8 | +from tests._support import reimport_once_per_class |
| 9 | + |
| 10 | +HAS_SCAPY = importlib.util.find_spec('scapy') is not None |
| 11 | +RUNTIME_DEPS = ('tbtrim', 'aenum', 'chardet', 'dictdumper') |
| 12 | +HAS_RUNTIME = all(importlib.util.find_spec(name) is not None for name in RUNTIME_DEPS) |
| 13 | + |
| 14 | + |
| 15 | +@unittest.skipUnless(HAS_RUNTIME and HAS_SCAPY, 'runtime dependencies not installed') |
| 16 | +class ScapyPacket2DictTests(unittest.TestCase): |
| 17 | + def setUp(self) -> None: |
| 18 | + reimport_once_per_class(self) |
| 19 | + |
| 20 | + def _walk(self, value): |
| 21 | + """Yield every value nested in ``value``.""" |
| 22 | + yield value |
| 23 | + if isinstance(value, dict): |
| 24 | + for item in value.values(): |
| 25 | + yield from self._walk(item) |
| 26 | + elif isinstance(value, (list, tuple)): |
| 27 | + for item in value: |
| 28 | + yield from self._walk(item) |
| 29 | + |
| 30 | + def assertNoPacketObjects(self, converted) -> None: |
| 31 | + from scapy.packet import Packet |
| 32 | + |
| 33 | + leftover = [type(v).__name__ for v in self._walk(converted) if isinstance(v, Packet)] |
| 34 | + self.assertEqual(leftover, []) |
| 35 | + |
| 36 | + def test_ip_options_list_is_converted(self) -> None: |
| 37 | + from scapy.layers.inet import IP, IPOption_NOP, IPOption_RR |
| 38 | + from scapy.layers.l2 import Ether |
| 39 | + |
| 40 | + from pcapkit.toolkit.scapy import packet2dict |
| 41 | + |
| 42 | + built = Ether() / IP(options=[IPOption_NOP(), IPOption_RR(routers=['192.0.2.1'])]) |
| 43 | + packet = Ether(bytes(built)) |
| 44 | + converted = packet2dict(packet) |
| 45 | + |
| 46 | + self.assertNoPacketObjects(converted) |
| 47 | + options = converted['Ethernet']['IP']['options'] |
| 48 | + self.assertEqual(options[0]['option'], 1) |
| 49 | + self.assertEqual(options[1]['routers'], ['192.0.2.1']) |
| 50 | + |
| 51 | + def test_hand_built_nested_packet_carries_only_its_set_fields(self) -> None: |
| 52 | + from scapy.layers.inet import IP, IPOption_NOP, IPOption_RR |
| 53 | + from scapy.layers.l2 import Ether |
| 54 | + |
| 55 | + from pcapkit.toolkit.scapy import packet2dict |
| 56 | + |
| 57 | + converted = packet2dict(Ether() / IP(options=[IPOption_NOP(), IPOption_RR(routers=['192.0.2.1'])])) |
| 58 | + self.assertNoPacketObjects(converted) |
| 59 | + self.assertEqual(converted['Ethernet']['IP']['options'], |
| 60 | + [{}, {'routers': ['192.0.2.1']}]) |
| 61 | + |
| 62 | + def _assert_layer_keys_match_fields(self, packet) -> None: |
| 63 | + from pcapkit.toolkit.scapy import packet2dict |
| 64 | + |
| 65 | + converted = packet2dict(packet) |
| 66 | + node = converted[packet.name] |
| 67 | + for layer in packet.iterpayloads(): |
| 68 | + with self.subTest(layer=layer.name): |
| 69 | + payload = layer.payload |
| 70 | + extra = {payload.name} if payload else set() |
| 71 | + self.assertEqual(set(node), set(layer.fields) | extra) |
| 72 | + if payload: |
| 73 | + node = node[payload.name] |
| 74 | + |
| 75 | + def test_dissected_icmp_echo_has_only_wire_fields(self) -> None: |
| 76 | + from scapy.layers.inet import ICMP, IP |
| 77 | + from scapy.layers.l2 import Ether |
| 78 | + from scapy.packet import Raw |
| 79 | + |
| 80 | + built = Ether() / IP() / ICMP(type=8, id=1, seq=2) / Raw(b'ping') |
| 81 | + self._assert_layer_keys_match_fields(Ether(bytes(built))) |
| 82 | + |
| 83 | + def test_fixture_icmp_echo_has_only_wire_fields(self) -> None: |
| 84 | + from scapy.layers.inet import ICMP |
| 85 | + from scapy.utils import rdpcap |
| 86 | + |
| 87 | + from tests._support import sample_path |
| 88 | + |
| 89 | + try: |
| 90 | + path = sample_path('little_endian.pcap') |
| 91 | + except FileNotFoundError as exc: |
| 92 | + self.skipTest(str(exc)) |
| 93 | + echoes = [p for p in rdpcap(path) if ICMP in p and p[ICMP].type in (0, 8)] |
| 94 | + self.assertTrue(echoes) |
| 95 | + self._assert_layer_keys_match_fields(echoes[0]) |
| 96 | + |
| 97 | + def test_dns_records_are_converted(self) -> None: |
| 98 | + from scapy.layers.dns import DNS, DNSQR, DNSRR |
| 99 | + from scapy.layers.inet import IP, UDP |
| 100 | + from scapy.layers.l2 import Ether |
| 101 | + |
| 102 | + from pcapkit.toolkit.scapy import packet2dict |
| 103 | + |
| 104 | + built = (Ether() / IP() / UDP(sport=53, dport=53) / |
| 105 | + DNS(qd=DNSQR(qname='example.com'), an=DNSRR(rrname='example.com', rdata='192.0.2.1'))) |
| 106 | + converted = packet2dict(Ether(bytes(built))) |
| 107 | + |
| 108 | + self.assertNoPacketObjects(converted) |
| 109 | + dns = converted['Ethernet']['IP']['UDP']['DNS'] |
| 110 | + self.assertEqual(dns['qd'][0]['qname'], b'example.com.') |
| 111 | + self.assertEqual(dns['an'][0]['rdata'], '192.0.2.1') |
| 112 | + |
| 113 | + def test_packet_inside_a_tuple_is_converted(self) -> None: |
| 114 | + from scapy.layers.inet import IP, TCP, TCPAOValue |
| 115 | + from scapy.layers.l2 import Ether |
| 116 | + |
| 117 | + from pcapkit.toolkit.scapy import packet2dict |
| 118 | + |
| 119 | + built = Ether() / IP() / TCP(options=[('AO', TCPAOValue(keyid=1, rnextkeyid=2, mac=b'\x01\x02\x03\x04'))]) |
| 120 | + converted = packet2dict(Ether(bytes(built))) |
| 121 | + |
| 122 | + self.assertNoPacketObjects(converted) |
| 123 | + name, value = converted['Ethernet']['IP']['TCP']['options'][0] |
| 124 | + self.assertEqual(name, 'AO') |
| 125 | + self.assertEqual(value['keyid'], 1) |
| 126 | + self.assertEqual(value['mac'], b'\x01\x02\x03\x04') |
| 127 | + |
| 128 | + def test_input_packet_is_not_mutated(self) -> None: |
| 129 | + from scapy.layers.inet import IP |
| 130 | + from scapy.layers.l2 import Ether |
| 131 | + from scapy.packet import Raw |
| 132 | + |
| 133 | + from pcapkit.toolkit.scapy import packet2dict |
| 134 | + |
| 135 | + for packet in (Ether() / IP() / Raw(b'x'), |
| 136 | + Ether(bytes(Ether(dst='bb:bb:bb:bb:bb:bb') / IP() / Raw(b'x')))): |
| 137 | + with self.subTest(packet=packet.summary()): |
| 138 | + before = {layer.name: dict(layer.fields) for layer in packet.iterpayloads()} |
| 139 | + converted = packet2dict(packet) |
| 140 | + after = {layer.name: dict(layer.fields) for layer in packet.iterpayloads()} |
| 141 | + |
| 142 | + self.assertEqual(after, before) |
| 143 | + self.assertIn('Raw', converted['Ethernet']['IP']) |
| 144 | + self.assertEqual(bytes(packet.copy()), bytes(packet)) |
| 145 | + |
| 146 | + |
| 147 | +if __name__ == '__main__': |
| 148 | + unittest.main() |
0 commit comments