pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/const/ipv6/routing.py

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""IPv6 Routing Types
+========================
+
+.. module:: pcapkit.const.ipv6.routing
+
+This module contains the constant enumeration for **IPv6 Routing Types**,
+which is automatically generated from :class:`pcapkit.vendor.ipv6.routing.Routing`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['Routing']
+
+
+class Routing(IntEnum):
+    """[Routing] IPv6 Routing Types"""
+
+    #: Source Route (DEPRECATED) [:rfc:`2460`][:rfc:`5095`]
+    Source_Route = 0
+
+    #: Nimrod (DEPRECATED 2009-05-06)
+    Nimrod = 1
+
+    #: Type 2 Routing Header [:rfc:`6275`]
+    Type_2_Routing_Header = 2
+
+    #: RPL Source Route Header [:rfc:`6554`]
+    RPL_Source_Route_Header = 3
+
+    #: Segment Routing Header (SRH) [:rfc:`8754`]
+    Segment_Routing_Header = 4
+
+    #: CRH-16 [:rfc:`9631`]
+    CRH_16 = 5
+
+    #: CRH-32 [:rfc:`9631`]
+    CRH_32 = 6
+
+    #: RFC3692-style Experiment 1 [:rfc:`4727`]
+    RFC3692_style_Experiment_1 = 253
+
+    #: RFC3692-style Experiment 2 [:rfc:`4727`]
+    RFC3692_style_Experiment_2 = 254
+
+    #: Reserved
+    Reserved_255 = 255
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'Routing':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return Routing(key)
+        if key not in Routing._member_map_:  # pylint: disable=no-member
+            return extend_enum(Routing, key, default)
+        return Routing[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'Routing':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 255):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        if 7 <= value <= 252:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/ipv6/seed_id.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Seed-ID Types
+===================
+
+.. module:: pcapkit.const.ipv6.seed_id
+
+This module contains the constant enumeration for **Seed-ID Types**,
+which is automatically generated from :class:`pcapkit.vendor.ipv6.seed_id.SeedID`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['SeedID']
+
+
+class SeedID(IntEnum):
+    """[SeedID] Seed-ID Types"""
+
+    IPV6_SOURCE_ADDRESS = 0b00
+
+    SEEDID_16_BIT_UNSIGNED_INTEGER = 0b01
+
+    SEEDID_64_BIT_UNSIGNED_INTEGER = 0b10
+
+    SEEDID_128_BIT_UNSIGNED_INTEGER = 0b11
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'SeedID':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return SeedID(key)
+        if key not in SeedID._member_map_:  # pylint: disable=no-member
+            return extend_enum(SeedID, key, default)
+        return SeedID[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'SeedID':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0b00 <= value <= 0b11):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return extend_enum(cls, 'Unassigned_0b%s' % bin(value)[2:].zfill(2), value)

pcapkit/const/ipv6/smf_dpd_mode.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Simplified Multicast Forwarding Duplicate Packet Detection (``SMF_DPD``) Options
+======================================================================================
+
+.. module:: pcapkit.const.ipv6.smf_dpd_mode
+
+This module contains the constant enumeration for **Simplified Multicast Forwarding Duplicate Packet Detection (``SMF_DPD``) Options**,
+which is automatically generated from :class:`pcapkit.vendor.ipv6.smf_dpd_mode.SMFDPDMode`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['SMFDPDMode']
+
+
+class SMFDPDMode(IntEnum):
+    """[SMFDPDMode] Simplified Multicast Forwarding Duplicate Packet Detection (``SMF_DPD``) Options"""
+
+    I_DPD = 0
+
+    H_DPD = 1
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'SMFDPDMode':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return SMFDPDMode(key)
+        if key not in SMFDPDMode._member_map_:  # pylint: disable=no-member
+            return extend_enum(SMFDPDMode, key, default)
+        return SMFDPDMode[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'SMFDPDMode':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 1):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return extend_enum(cls, 'Unassigned_%d' % value, value)

pcapkit/const/ipv6/tagger_id.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""TaggerID Types
+====================
+
+.. module:: pcapkit.const.ipv6.tagger_id
+
+This module contains the constant enumeration for **TaggerID Types**,
+which is automatically generated from :class:`pcapkit.vendor.ipv6.tagger_id.TaggerID`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['TaggerID']
+
+
+class TaggerID(IntEnum):
+    """[TaggerID] TaggerID Types"""
+
+    #: NULL [:rfc:`6621`]
+    NULL = 0
+
+    #: DEFAULT [:rfc:`6621`]
+    DEFAULT = 1
+
+    #: IPv4 [:rfc:`6621`]
+    IPv4 = 2
+
+    #: IPv6 [:rfc:`6621`]
+    IPv6 = 3
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'TaggerID':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return TaggerID(key)
+        if key not in TaggerID._member_map_:  # pylint: disable=no-member
+            return extend_enum(TaggerID, key, default)
+        return TaggerID[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'TaggerID':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 7):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        if 4 <= value <= 7:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/ipx/__init__.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.internet.ipx.IPX` Constant Enumerations
+========================================================================
+
+.. module:: pcapkit.const.ipx
+
+This module contains all constant enumerations of
+:class:`~pcapkit.protocols.internet.ipx.IPX` implementations. Available
+enumerations include:
+
+.. list-table::
+
+   * - :class:`IPX_Packet <pcapkit.const.ipx.packet.Packet>`
+     - IPX Packet Types [*]_
+   * - :class:`IPX_Socket <pcapkit.const.ipx.socket.Socket>`
+     - IPX Socket Types [*]_
+
+.. [*] https://en.wikipedia.org/wiki/Internetwork_Packet_Exchange#IPX_packet_structure
+.. [*] https://en.wikipedia.org/wiki/Internetwork_Packet_Exchange#Socket_number
+
+"""
+
+from pcapkit.const.ipx.packet import Packet as IPX_Packet
+from pcapkit.const.ipx.socket import Socket as IPX_Socket
+
+__all__ = ['IPX_Packet', 'IPX_Socket']

pcapkit/const/ipx/packet.py

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""IPX Packet Types
+======================
+
+.. module:: pcapkit.const.ipx.packet
+
+This module contains the constant enumeration for **IPX Packet Types**,
+which is automatically generated from :class:`pcapkit.vendor.ipx.packet.Packet`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['Packet']
+
+
+class Packet(IntEnum):
+    """[Packet] IPX Packet Types"""
+
+    #: Unknown
+    Unknown = 0
+
+    #: ``RIP``, Routing Information Protocol ([:rfc:`1582`], [:rfc:`2091`])
+    RIP = 1
+
+    #: Echo Packet
+    Echo_Packet = 2
+
+    #: Error Packet
+    Error_Packet = 3
+
+    #: ``PEP``, Packet Exchange Protocol, used for SAP (Service Advertising
+    #: Protocol)
+    PEP = 4
+
+    #: ``SPX``, Sequenced Packet Exchange
+    SPX = 5
+
+    #: ``NCP``, NetWare Core Protocol
+    NCP = 17
+
+    #: Broadcast[4]
+    Broadcast_4 = 20
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'Packet':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return Packet(key)
+        if key not in Packet._member_map_:  # pylint: disable=no-member
+            return extend_enum(Packet, key, default)
+        return Packet[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'Packet':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 255):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return extend_enum(cls, 'Unassigned_%d' % value, value)

pcapkit/const/ipx/socket.py

@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Socket Types
+==================
+
+.. module:: pcapkit.const.ipx.socket
+
+This module contains the constant enumeration for **Socket Types**,
+which is automatically generated from :class:`pcapkit.vendor.ipx.socket.Socket`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['Socket']
+
+
+class Socket(IntEnum):
+    """[Socket] Socket Types"""
+
+    #: Routing Information Packet
+    Routing_Information_Packet = 0x0001
+
+    #: Echo Protocol Packet
+    Echo_Protocol_Packet = 0x0002
+
+    #: Error Handling Packet
+    Error_Handling_Packet = 0x0003
+
+    #: NetWare Core Protocol, NCP – used by Novell NetWare servers
+    NetWare_Core_Protocol = 0x0451
+
+    #: Service Advertising Protocol, SAP
+    Service_Advertising_Protocol = 0x0452
+
+    #: Routing Information Protocol, RIP
+    Routing_Information_Protocol = 0x0453
+
+    #: NetBIOS
+    NetBIOS = 0x0455
+
+    #: Diagnostic Packet
+    Diagnostic_Packet = 0x0456
+
+    #: Serialization Packet, used for NCP as well
+    Serialization_Packet = 0x0457
+
+    #: Used by Novell NetWare Client
+    Used_by_Novell_NetWare_Client = 0x4003
+
+    #: LLC [ 4 ]
+    LLC_4 = 0x8060
+
+    #: TCP over IPXF
+    TCP_over_IPXF = 0x9091
+
+    #: UDP over IPXF
+    UDP_over_IPXF = 0x9092
+
+    #: IPXF, IPX Fragmentation Protocol
+    IPXF = 0x9093
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'Socket':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return Socket(key)
+        if key not in Socket._member_map_:  # pylint: disable=no-member
+            return extend_enum(Socket, key, default)
+        return Socket[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'Socket':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0x0000 <= value <= 0xFFFF):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        if 0x0001 <= value <= 0x0BB8:
+            #: Registered by Xerox
+            return extend_enum(cls, 'Registered by Xerox_0x%s' % hex(value)[2:].upper().zfill(4), value)
+        if 0x0020 <= value <= 0x003F:
+            #: Experimental
+            return extend_enum(cls, 'Experimental_0x%s' % hex(value)[2:].upper().zfill(4), value)
+        if 0x0BB9 <= value <= 0xFFFF:
+            #: Dynamically Assigned
+            return extend_enum(cls, 'Dynamically Assigned_0x%s' % hex(value)[2:].upper().zfill(4), value)
+        if 0x4000 <= value <= 0x4FFF:
+            #: Dynamically Assigned Socket Numbers
+            return extend_enum(cls, 'Dynamically Assigned Socket Numbers_0x%s' % hex(value)[2:].upper().zfill(4), value)
+        if 0x8000 <= value <= 0xFFFF:
+            #: Statically Assigned Socket Numbers
+            return extend_enum(cls, 'Statically Assigned Socket Numbers_0x%s' % hex(value)[2:].upper().zfill(4), value)
+        return super()._missing_(value)

pcapkit/const/l2tp/__init__.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.link.l2tp.L2TP` Constant Enumerations
+======================================================================
+
+.. module:: pcapkit.const.l2tp
+
+This module contains all constant enumerations of
+:class:`~pcapkit.protocols.link.l2tp.L2TP` implementations. Available
+enumerations include:
+
+.. list-table::
+
+   * - :class:`L2TP_Type <pcapkit.const.l2tp.type.Type>`
+     - L2TP Types
+
+"""
+
+from pcapkit.const.l2tp.type import Type as L2TP_Type
+
+__all__ = ['L2TP_Type']

pcapkit/const/l2tp/type.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""L2TP Type
+===============
+
+.. module:: pcapkit.const.l2tp.type
+
+This module contains the constant enumeration for **L2TP Type**,
+which is automatically generated from :class:`pcapkit.vendor.l2tp.type.Type`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['Type']
+
+
+class Type(IntEnum):
+    """[Type] L2TP Type"""
+
+    Control = 0
+
+    Data = 1
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'Type':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return Type(key)
+        if key not in Type._member_map_:  # pylint: disable=no-member
+            return extend_enum(Type, key, default)
+        return Type[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'Type':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 1):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return extend_enum(cls, 'Unassigned_%d' % value, value)