pypcapkit 1.3.5.post6__cp313-none-any.whl

pcapkit/const/ipv6/router_alert.py

@@ -0,0 +1,266 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""IPv6 Router Alert Option Values
+=====================================
+
+.. module:: pcapkit.const.ipv6.router_alert
+
+This module contains the constant enumeration for **IPv6 Router Alert Option Values**,
+which is automatically generated from :class:`pcapkit.vendor.ipv6.router_alert.RouterAlert`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['RouterAlert']
+
+
+class RouterAlert(IntEnum):
+    """[RouterAlert] IPv6 Router Alert Option Values"""
+
+    #: Datagram contains a Multicast Listener Discovery message [:rfc:`2710`]
+    Datagram_contains_a_Multicast_Listener_Discovery_message = 0
+
+    #: Datagram contains RSVP message [:rfc:`2711`]
+    Datagram_contains_RSVP_message = 1
+
+    #: Datagram contains an Active Networks message [:rfc:`2711`]
+    Datagram_contains_an_Active_Networks_message = 2
+
+    #: Reserved [:rfc:`5350`]
+    Reserved_3 = 3
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_0 = 4
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_1 = 5
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_2 = 6
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_3 = 7
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_4 = 8
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_5 = 9
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_6 = 10
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_7 = 11
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_8 = 12
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_9 = 13
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_10 = 14
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_11 = 15
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_12 = 16
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_13 = 17
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_14 = 18
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_15 = 19
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_16 = 20
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_17 = 21
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_18 = 22
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_19 = 23
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_20 = 24
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_21 = 25
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_22 = 26
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_23 = 27
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_24 = 28
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_25 = 29
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_26 = 30
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_27 = 31
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_28 = 32
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_29 = 33
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_30 = 34
+
+    #: Aggregated Reservation Nesting Level [:rfc:`3175`]
+    Aggregated_Reservation_Nesting_Level_31 = 35
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_0 = 36
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_1 = 37
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_2 = 38
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_3 = 39
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_4 = 40
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_5 = 41
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_6 = 42
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_7 = 43
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_8 = 44
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_9 = 45
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_10 = 46
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_11 = 47
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_12 = 48
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_13 = 49
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_14 = 50
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_15 = 51
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_16 = 52
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_17 = 53
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_18 = 54
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_19 = 55
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_20 = 56
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_21 = 57
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_22 = 58
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_23 = 59
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_24 = 60
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_25 = 61
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_26 = 62
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_27 = 63
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_28 = 64
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_29 = 65
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_30 = 66
+
+    #: QoS NSLP Aggregation Levels 0-31 [:rfc:`5974`]
+    QoS_NSLP_Aggregation_Level_31 = 67
+
+    #: NSIS NATFW NSLP [:rfc:`5973`]
+    NSIS_NATFW_NSLP = 68
+
+    #: MPLS OAM (DEPRECATED) [:rfc:`7506`][:rfc:`9570`]
+    MPLS_OAM = 69
+
+    #: Reserved [The Internet Assigned Numbers Authority]
+    Reserved_65535 = 65535
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'RouterAlert':
+        """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 RouterAlert(key)
+        if key not in RouterAlert._member_map_:  # pylint: disable=no-member
+            return extend_enum(RouterAlert, key, default)
+        return RouterAlert[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'RouterAlert':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 65535):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        if 70 <= value <= 65502:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 65503 <= value <= 65534:
+            #: Reserved for experimental use [:rfc:`5350`]
+            return extend_enum(cls, 'Reserved for experimental use_%d' % value, value)
+        return super()._missing_(value)

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)