Merge branch 'pickle_fix2'

Author: Nils Weiss

scapy/packet.py

@@ -269,7 +269,7 @@ def __reduce__(self):
             if hasattr(self, attr):
                 extra_slots[attr] = getattr(self, attr)
         if extra_slots:
-            state["extra_slots"] = extra_slots
+            state["extra_slots"] = extra_slots  # type: ignore
         return (type(self)._rebuild_pkt, (self.build(),), state)
 
     def __setstate__(self, state):

test/regression.uts

@@ -616,6 +616,71 @@ c = pickle.loads(b)
 assert c[IP].dst == "192.168.0.1"
 assert raw(c) == raw(a)
 
+= Pickle preserves field values, payload and metadata
+
+import pickle
+
+p = IP(src='1.2.3.4', dst='5.6.7.8')/TCP(sport=1234, dport=80, flags='S')
+p.time = 12345.0
+p.sent_time = 12346.0
+p.direction = 1
+p.sniffed_on = 'eth0'
+p.wirelen = 100
+p.comment = b'test comment'
+p2 = pickle.loads(pickle.dumps(p))
+assert p2[IP].src == '1.2.3.4'
+assert p2[IP].dst == '5.6.7.8'
+assert p2[TCP].sport == 1234
+assert p2[TCP].dport == 80
+assert p2[TCP].flags == 'S'
+assert p2.time == 12345.0
+assert p2.sent_time == 12346.0
+assert p2.direction == 1
+assert p2.sniffed_on == 'eth0'
+assert p2.wirelen == 100
+assert p2.comment == b'test comment'
+assert raw(p2) == raw(p)
+
+= Pickle a bare packet without payload
+
+import pickle
+
+p = IP(src='10.0.0.1')
+p2 = pickle.loads(pickle.dumps(p))
+assert p2.src == '10.0.0.1'
+assert raw(p2) == raw(p)
+
+= Pickle preserves custom __slots__ from subclasses
+
+import pickle
+import scapy.packet as _pkt_mod
+
+class _PickleTestPacket(Packet):
+    __slots__ = ["custom_id", "custom_tag"]
+    name = "PickleTestPacket"
+    fields_desc = [ByteField("val", 0)]
+
+# Make the class discoverable by pickle
+_pkt_mod._PickleTestPacket = _PickleTestPacket
+_PickleTestPacket.__module__ = 'scapy.packet'
+
+p = _PickleTestPacket(val=42)
+p.custom_id = 0x123
+p.custom_tag = "hello"
+p2 = pickle.loads(pickle.dumps(p))
+assert p2.val == 42
+assert p2.custom_id == 0x123
+assert p2.custom_tag == "hello"
+
+# Slots not explicitly set are not serialized
+p3 = _PickleTestPacket(val=7)
+assert not hasattr(p3, 'custom_id')
+p4 = pickle.loads(pickle.dumps(p3))
+assert p4.val == 7
+assert not hasattr(p4, 'custom_id')
+
+del _pkt_mod._PickleTestPacket
+
 = Usage test
 
 from scapy.main import _usage
@@ -948,7 +1013,7 @@ assert corrupt_bits("ABCDE") in [b"EBCDE", b"ABCDG"]
 assert sane(corrupt_bits("ABCDE", n=3)) in ["AF.EE", "QB.TE"]
 
 = Test whois function
-~ netaccess disabled
+~ netaccess
 
 if not WINDOWS:
     result = whois("193.0.6.139")
@@ -1782,15 +1847,15 @@ def _test():
 retry_test(_test)
 
 = Whois request
-~ netaccess IP as_resolvers disabled
+~ netaccess IP as_resolvers
 * This test retries on failure because it often fails
 def _test():
     IP(src="8.8.8.8").whois()
 
 retry_test(_test)
 
 = AS resolvers
-~ netaccess IP as_resolvers disabled
+~ netaccess IP as_resolvers
 * This test retries on failure because it often fails
 
 def _test():
@@ -1826,7 +1891,7 @@ assert len(tmp) == 3
 assert [l[1] for l in tmp] == ['AS24776', 'AS36459', 'AS26496']
 
 = AS resolver - IPv6
-~ netaccess IP as_resolvers disabled
+~ netaccess IP as_resolvers
 * This test retries on failure because it often fails
 
 def _test():