New explore() function with prompt_toolkit 2.0 integration

scapy/asn1packet.py

@@ -4,6 +4,8 @@
 # This program is published under a GPLv2 license
 
 """
+ASN.1 Packet
+
 Packet holding data in Abstract Syntax Notation (ASN.1).
 """
 

scapy/base_classes.py

@@ -229,8 +229,9 @@ def __new__(cls, name, bases, dct):
         for f in newcls.fields_desc:
             if hasattr(f, "register_owner"):
                 f.register_owner(newcls)
-        from scapy import config
-        config.conf.layers.register(newcls)
+        if newcls.__name__[0] != "_":
+            from scapy import config
+            config.conf.layers.register(newcls)
         return newcls
 
     def __getattr__(self, attr):

scapy/config.py

@@ -168,11 +168,28 @@ def __repr__(self):
 
 class LayersList(list):
 
+    def __init__(self):
+        list.__init__(self)
+        self.ldict = {}
+
     def __repr__(self):
         return "\n".join("%-20s: %s" % (l.__name__, l.name) for l in self)
 
     def register(self, layer):
         self.append(layer)
+        if layer.__module__ not in self.ldict:
+            self.ldict[layer.__module__] = []
+        self.ldict[layer.__module__].append(layer)
+
+    def layers(self):
+        layers = self.ldict.keys()
+        result = []
+        # This import may feel useless, but it is required for the eval below
+        import scapy  # noqa: F401
+        for lay in layers:
+            doc = eval(lay).__doc__
+            result.append((lay, doc.strip().split("\n")[0] if doc else lay))
+        return result
 
 
 class CommandsList(list):

scapy/contrib/bier.py

@@ -12,7 +12,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = BIER
+# scapy.contrib.description = Bit Index Explicit Replication (BIER)
 # scapy.contrib.status = loads
 
 from scapy.packet import Packet, bind_layers

scapy/contrib/cansocket.py

@@ -3,6 +3,8 @@
 # Copyright (C) Nils Weiss <nils@we155.de>
 # This program is published under a GPLv2 license
 
+# scapy.contrib.description = CANSocket Utils
+# scapy.contrib.status = loads
 
 """
 CANSocket.

scapy/contrib/cansocket_native.py

@@ -3,6 +3,8 @@
 # Copyright (C) Nils Weiss <nils@we155.de>
 # This program is published under a GPLv2 license
 
+# scapy.contrib.description = Native CANSocket
+# scapy.contrib.status = loads
 
 """
 Native CANSocket.

scapy/contrib/cansocket_python_can.py

@@ -3,6 +3,8 @@
 # Copyright (C) Nils Weiss <nils@we155.de>
 # This program is published under a GPLv2 license
 
+# scapy.contrib.description = Python-Can CANSocket
+# scapy.contrib.status = loads
 
 """
 Python-CAN CANSocket Wrapper.

scapy/contrib/carp.py

@@ -12,7 +12,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = CARP
+# scapy.contrib.description = Common Address Redundancy Protocol (CARP)
 # scapy.contrib.status = loads
 
 import struct

scapy/contrib/cdp.py

@@ -1,6 +1,6 @@
 #! /usr/bin/env python
 
-# scapy.contrib.description = Cisco Discovery Protocol
+# scapy.contrib.description = Cisco Discovery Protocol (CDP)
 # scapy.contrib.status = loads
 
 #############################################################################

scapy/contrib/dtp.py

@@ -14,7 +14,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = DTP
+# scapy.contrib.description = Dynamic Trunking Protocol (DTP)
 # scapy.contrib.status = loads
 
 """

scapy/contrib/eigrp.py

@@ -14,7 +14,9 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = EIGRP
+# flake8: noqa: E501
+
+# scapy.contrib.description = Enhanced Interior Gateway Routing Protocol (EIGRP)
 # scapy.contrib.status = loads
 
 """
@@ -38,7 +40,7 @@
 
     :Thanks:
 
-    - TLV code derived from the CDP implementation of scapy. (Thanks to Nicolas Bareil and Arnaud Ebalard)  # noqa: E501
+    - TLV code derived from the CDP implementation of scapy. (Thanks to Nicolas Bareil and Arnaud Ebalard)
         http://trac.secdev.org/scapy/ticket/18
     - IOS / EIGRP Version Representation FIX by Dirk Loss
 """
@@ -63,10 +65,10 @@
 
 class EigrpIPField(StrField, IPField):
     """
-    This is a special field type for handling ip addresses of destination networks in internal and  # noqa: E501
+    This is a special field type for handling ip addresses of destination networks in internal and
     external route updates.
 
-    EIGRP removes zeros from the host portion of the ip address if the netmask is 8, 16 or 24 bits.  # noqa: E501
+    EIGRP removes zeros from the host portion of the ip address if the netmask is 8, 16 or 24 bits.
     """
 
     __slots__ = ["length_from"]
@@ -133,7 +135,7 @@ def randval(self):
 
 class EigrpIP6Field(StrField, IP6Field):
     """
-    This is a special field type for handling ip addresses of destination networks in internal and  # noqa: E501
+    This is a special field type for handling ip addresses of destination networks in internal and
     external route updates.
 
     """
@@ -281,7 +283,7 @@ def i2repr(self, pkt, x):
 
     def h2i(self, pkt, x):
         """The field accepts string values like v12.1, v1.1 or integer values.
-           String values have to start with a "v" folled by a floating point number.  # noqa: E501
+           String values have to start with a "v" folled by a floating point number.
            Valid numbers are between 0 and 255.
         """
 

scapy/contrib/geneve.py

@@ -14,7 +14,9 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = GENEVE
+# flake8: noqa: E501
+
+# scapy.contrib.description = Generic Network Virtualization Encapsulation (GENEVE)
 # scapy.contrib.status = loads
 
 """

scapy/contrib/gtp.py

@@ -8,7 +8,7 @@
 ##
 # This program is published under a GPLv2 license
 
-# scapy.contrib.description = GTP
+# scapy.contrib.description = GPRS Tunneling Protocol (GTP)
 # scapy.contrib.status = loads
 
 from __future__ import absolute_import

scapy/contrib/gtp_v2.py

@@ -17,7 +17,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = GTPv2
+# scapy.contrib.description = GPRS Tunneling Protocol v2 (GTPv2)
 # scapy.contrib.status = loads
 
 import struct

scapy/contrib/igmp.py

@@ -14,7 +14,9 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = IGMP/IGMPv2
+# flake8: noqa: E501
+
+# scapy.contrib.description = Internet Group Management Protocol v1/v2 (IGMP/IGMPv2)
 # scapy.contrib.status = loads
 
 from __future__ import print_function
@@ -67,7 +69,7 @@ class IGMP(Packet):
                    IPField("gaddr", "0.0.0.0")]
 
     def post_build(self, p, pay):
-        """Called implicitly before a packet is sent to compute and place IGMP checksum.  # noqa: E501
+        """Called implicitly before a packet is sent to compute and place IGMP checksum.
 
         Parameters:
           self    The instantiation of an IGMP class
@@ -95,14 +97,14 @@ def igmpize(self):
 
         The rules are:
         General:
-            1.  the Max Response time is meaningful only in Membership Queries and should be zero  # noqa: E501
+            1.  the Max Response time is meaningful only in Membership Queries and should be zero
         IP:
             1. Send General Group Query to 224.0.0.1 (all systems)
             2. Send Leave Group to 224.0.0.2 (all routers)
             3a.Otherwise send the packet to the group address
             3b.Send reports/joins to the group address
             4. ttl = 1 (RFC 2236, section 2)
-            5. send the packet with the router alert IP option (RFC 2236, section 2)  # noqa: E501
+            5. send the packet with the router alert IP option (RFC 2236, section 2)
         Ether:
             1. Recalculate destination
 
@@ -113,8 +115,8 @@ def igmpize(self):
                     were adjusted.
 
         The function will examine the IGMP message to assure proper format.
-        Corrections will be attempted if possible. The IP header is then properly  # noqa: E501
-        adjusted to ensure correct formatting and assignment. The Ethernet header  # noqa: E501
+        Corrections will be attempted if possible. The IP header is then properly
+        adjusted to ensure correct formatting and assignment. The Ethernet header
         is then adjusted to the proper IGMP packet format.
         """
         gaddr = self.gaddr if hasattr(self, "gaddr") and self.gaddr else "0.0.0.0"  # noqa: E501

scapy/contrib/igmpv3.py

@@ -14,7 +14,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = IGMPv3
+# scapy.contrib.description = Internet Group Management Protocol v3 (IGMPv3)
 # scapy.contrib.status = loads
 
 from __future__ import print_function

scapy/contrib/ikev2.py

@@ -14,7 +14,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = IKEv2
+# scapy.contrib.description = Internet Key Exchange v2 (IKEv2)
 # scapy.contrib.status = loads
 
 import logging

scapy/contrib/isis.py

@@ -12,7 +12,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = ISIS
+# scapy.contrib.description = Intermediate System to Intermediate System (ISIS)
 # scapy.contrib.status = loads
 
 """

scapy/contrib/isotp.py

@@ -6,6 +6,14 @@
 # Copyright (C) Enrico Pozzobon <enricopozzobon@gmail.com>
 # This program is published under a GPLv2 license
 
+# scapy.contrib.description = ISO-TP (ISO 15765-2)
+# scapy.contrib.status = loads
+
+"""
+ISOTPSocket.
+"""
+
+
 import ctypes
 from ctypes.util import find_library
 import struct

scapy/contrib/lacp.py

@@ -12,7 +12,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = LACP
+# scapy.contrib.description = Link Aggregation Control Protocol (LACP)
 # scapy.contrib.status = loads
 
 from scapy.packet import Packet, bind_layers

scapy/contrib/lldp.py

@@ -1,6 +1,6 @@
 #! /usr/bin/env python
 #
-# scapy.contrib.description = LLDP
+# scapy.contrib.description = Link Layer Discovery Protocol (LLDP)
 # scapy.contrib.status = loads
 
 """

scapy/contrib/macsec.py

@@ -3,6 +3,9 @@
 # Copyright (C) Sabrina Dubroca <sd@queasysnail.net>
 # This program is published under a GPLv2 license
 
+# scapy.contrib.description = 802.1AE - IEEE MAC Security standard (MACsec)
+# scapy.contrib.status = loads
+
 """
 Classes and functions for MACsec.
 """

scapy/contrib/mpls.py

@@ -12,7 +12,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = MPLS
+# scapy.contrib.description = Multiprotocol Label Switching (MPLS)
 # scapy.contrib.status = loads
 
 from scapy.packet import Packet, bind_layers, Padding

scapy/contrib/mqtt.py

@@ -3,6 +3,8 @@
 # Copyright (C) Santiago Hernandez Ramos <shramos@protonmail.com>
 # This program is published under GPLv2 license
 
+# scapy.contrib.description = Message Queuing Telemetry Transport (MQTT)
+# scapy.contrib.status = loads
 
 from scapy.packet import Packet, bind_layers
 from scapy.fields import FieldLenField, BitEnumField, StrLenField, \

scapy/contrib/nsh.py

@@ -12,7 +12,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = NSH Protocol
+# scapy.contrib.description = Network Services Headers (NSH)
 # scapy.contrib.status = loads
 
 from scapy.all import bind_layers

scapy/contrib/ospf.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-# scapy.contrib.description = OSPF
+# scapy.contrib.description = Open Shortest Path First (OSPF)
 # scapy.contrib.status = loads
 
 # This file is part of Scapy

scapy/contrib/ppi_cace.py

@@ -14,7 +14,7 @@
 
 # author: <jellch@harris.com>
 
-# scapy.contrib.description = PPI CACE
+# scapy.contrib.description = Parallel Peripheral Interface CACE (PPI CACE)
 # scapy.contrib.status = loads
 
 """

scapy/contrib/ppi_geotag.py

@@ -14,7 +14,7 @@
 
 # author: <jellch@harris.com>
 
-# scapy.contrib.description = PPI GEOLOCATION
+# scapy.contrib.description = Parallel Peripheral Interface (PPI) Geolocation
 # scapy.contrib.status = loads
 
 

scapy/contrib/ripng.py

@@ -14,7 +14,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = RIPng
+# scapy.contrib.description = Routing Information Protocol next gen (RIPng)
 # scapy.contrib.status = loads
 
 from scapy.packet import Packet, bind_layers

scapy/contrib/rsvp.py

@@ -14,7 +14,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Scapy. If not, see <http://www.gnu.org/licenses/>.
 
-# scapy.contrib.description = RSVP
+# scapy.contrib.description = Resource Reservation Protocol (RSVP)
 # scapy.contrib.status = loads
 
 from scapy.compat import chb

scapy/contrib/spbm.py

@@ -17,7 +17,7 @@
 # https://en.wikipedia.org/wiki/IEEE_802.1aq
 # Modeled after the scapy VXLAN contribution
 
-# scapy.contrib.description = SBPM
+# scapy.contrib.description = Shorest Path Bridging Mac-in-mac (SBPM)
 # scapy.contrib.status = loads
 
 """

scapy/contrib/tacacs.py

@@ -16,7 +16,7 @@
 
 # Based on tacacs+ v6 draft https://tools.ietf.org/html/draft-ietf-opsawg-tacacs-06  # noqa: E501
 
-# scapy.contrib.description = TACACS+ Protocol
+# scapy.contrib.description = Terminal Access Controller Access-Control System+
 # scapy.contrib.status = loads
 
 import struct