pypcapkit 1.3.5.post6__pp310-none-any.whl

pcapkit/const/ipv4/tos_rel.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""ToS (DS Field) Reliability
+================================
+
+.. module:: pcapkit.const.ipv4.tos_rel
+
+This module contains the constant enumeration for **ToS (DS Field) Reliability**,
+which is automatically generated from :class:`pcapkit.vendor.ipv4.tos_rel.ToSReliability`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['ToSReliability']
+
+
+class ToSReliability(IntEnum):
+    """[ToSReliability] ToS (DS Field) Reliability"""
+
+    NORMAL = 0
+
+    HIGH = 1
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'ToSReliability':
+        """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 ToSReliability(key)
+        if key not in ToSReliability._member_map_:  # pylint: disable=no-member
+            return extend_enum(ToSReliability, key, default)
+        return ToSReliability[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'ToSReliability':
+        """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/ipv4/tos_thr.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""ToS (DS Field) Throughput
+===============================
+
+.. module:: pcapkit.const.ipv4.tos_thr
+
+This module contains the constant enumeration for **ToS (DS Field) Throughput**,
+which is automatically generated from :class:`pcapkit.vendor.ipv4.tos_thr.ToSThroughput`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['ToSThroughput']
+
+
+class ToSThroughput(IntEnum):
+    """[ToSThroughput] ToS (DS Field) Throughput"""
+
+    NORMAL = 0
+
+    HIGH = 1
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'ToSThroughput':
+        """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 ToSThroughput(key)
+        if key not in ToSThroughput._member_map_:  # pylint: disable=no-member
+            return extend_enum(ToSThroughput, key, default)
+        return ToSThroughput[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'ToSThroughput':
+        """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/ipv4/ts_flag.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""TS Flag
+=============
+
+.. module:: pcapkit.const.ipv4.ts_flag
+
+This module contains the constant enumeration for **TS Flag**,
+which is automatically generated from :class:`pcapkit.vendor.ipv4.ts_flag.TSFlag`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['TSFlag']
+
+
+class TSFlag(IntEnum):
+    """[TSFlag] TS Flag"""
+
+    Timestamp_Only = 0
+
+    IP_with_Timestamp = 1
+
+    Prespecified_IP_with_Timestamp = 3
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'TSFlag':
+        """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 TSFlag(key)
+        if key not in TSFlag._member_map_:  # pylint: disable=no-member
+            return extend_enum(TSFlag, key, default)
+        return TSFlag[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'TSFlag':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0b0000 <= value <= 0b1111):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return extend_enum(cls, 'Unassigned_%d' % value, value)

pcapkit/const/ipv6/__init__.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.internet.ipv6.IPv6` Constant Enumerations
+===========================================================================
+
+.. module:: pcapkit.const.ipv6
+
+This module contains all constant enumerations of
+:class:`~pcapkit.protocols.internet.ipv6.IPv6` implementations. Available
+enumerations include:
+
+.. list-table::
+
+   * - :class:`IPv6_Extension_Header <pcapkit.const.ipv6.extension_header.ExtensionHeader>`
+     - IPv6 Extension Header Types [*]_
+   * - :class:`IPv6_Option <pcapkit.const.ipv6.option.Option>`
+     - Destination Options and Hop-by-Hop Options [*]_
+   * - :class:`IPv6_OptionAction <pcapkit.const.ipv6.option_action.OptionAction>`
+     - Option Actions [*]_
+   * - :class:`IPv6_QSFunction <pcapkit.const.ipv6.qs_function.QSFunction>`
+     - IPv6 QS Functions
+   * - :class:`IPv6_RouterAlert <pcapkit.const.ipv6.router_alert.RouterAlert>`
+     - IPv6 Router Alert Option Values [*]_
+   * - :class:`IPv6_Routing <pcapkit.const.ipv6.routing.Routing>`
+     - Routing Types [*]_
+   * - :class:`IPv6_SeedID <pcapkit.const.ipv6.seed_id.SeedID>`
+     - Seed-ID Types
+   * - :class:`IPv6_SMFDPDMode <pcapkit.const.ipv6.smf_dpd_mode.SMFDPDMode>`
+     - Simplified Multicast Forwarding Duplicate Packet Detection (``SMF_DPD``) Options
+   * - :class:`IPv6_TaggerID <pcapkit.const.ipv6.tagger_id.TaggerID>`
+     - Tagger-ID Types [*]_
+
+.. [*] https://www.iana.org/assignments/ipv6-parameters/ipv6-parameters.xhtml#extension-header
+.. [*] https://www.iana.org/assignments/ipv6-parameters/ipv6-parameters.xhtml#ipv6-parameters-2
+.. [*] https://www.rfc-editor.org/rfc/rfc8200#section-4.2
+.. [*] https://www.iana.org/assignments/ipv6-routeralert-values/ipv6-routeralert-values.xhtml#ipv6-routeralert-values-1
+.. [*] https://www.iana.org/assignments/ipv6-parameters/ipv6-parameters.xhtml#ipv6-parameters-3
+.. [*] https://www.iana.org/assignments/ipv6-parameters/ipv6-parameters.xhtml#taggerId-types
+
+"""
+
+from pcapkit.const.ipv6.extension_header import ExtensionHeader as IPv6_ExtensionHeader
+from pcapkit.const.ipv6.option import Option as IPv6_Option
+from pcapkit.const.ipv6.option_action import OptionAction as IPv6_OptionAction
+from pcapkit.const.ipv6.qs_function import QSFunction as IPv6_QSFunction
+from pcapkit.const.ipv6.router_alert import RouterAlert as IPv6_RouterAlert
+from pcapkit.const.ipv6.routing import Routing as IPv6_Routing
+from pcapkit.const.ipv6.seed_id import SeedID as IPv6_SeedID
+from pcapkit.const.ipv6.smf_dpd_mode import SMFDPDMode as IPv6_SMFDPDMode
+from pcapkit.const.ipv6.tagger_id import TaggerID as IPv6_TaggerID
+
+__all__ = ['IPv6_ExtensionHeader', 'IPv6_Option', 'IPv6_QSFunction', 'IPv6_RouterAlert', 'IPv6_Routing',
+           'IPv6_SeedID', 'IPv6_SMFDPDMode', 'IPv6_TaggerID', 'IPv6_OptionAction']

pcapkit/const/ipv6/extension_header.py

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""IPv6 Extension Header Types
+=================================
+
+.. module:: pcapkit.const.ipv6.extension_header
+
+This module contains the constant enumeration for **IPv6 Extension Header Types**,
+which is automatically generated from :class:`pcapkit.vendor.ipv6.extension_header.ExtensionHeader`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['ExtensionHeader']
+
+
+class ExtensionHeader(IntEnum):
+    """[ExtensionHeader] IPv6 Extension Header Types"""
+
+    #: HOPOPT, IPv6 Hop-by-Hop Option [:rfc:`8200`]
+    HOPOPT = 0
+
+    #: IPv6-Route, Routing Header for IPv6 [Steve Deering]
+    IPv6_Route = 43
+
+    #: IPv6-Frag, Fragment Header for IPv6 [Steve Deering]
+    IPv6_Frag = 44
+
+    #: ESP, Encap Security Payload [:rfc:`4303`]
+    ESP = 50
+
+    #: AH, Authentication Header [:rfc:`4302`]
+    AH = 51
+
+    #: IPv6-Opts, Destination Options for IPv6 [:rfc:`8200`]
+    IPv6_Opts = 60
+
+    #: Mobility Header [:rfc:`6275`]
+    Mobility_Header = 135
+
+    #: HIP, Host Identity Protocol [:rfc:`7401`]
+    HIP = 139
+
+    #: Shim6, Shim6 Protocol [:rfc:`5533`]
+    Shim6 = 140
+
+    #: BIT-EMU, Bit-stream Emulation [RFC-ietf-pals-ple-14]
+    BIT_EMU = 147
+
+    #: Use for experimentation and testing [:rfc:`3692`]
+    Use_for_experimentation_and_testing_253 = 253
+
+    #: Use for experimentation and testing [:rfc:`3692`]
+    Use_for_experimentation_and_testing_254 = 254
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'ExtensionHeader':
+        """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 ExtensionHeader(key)
+        return ExtensionHeader[key]  # type: ignore[misc]

pcapkit/const/ipv6/option.py

@@ -0,0 +1,137 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Destination Options and Hop-by-Hop Options
+================================================
+
+.. module:: pcapkit.const.ipv6.option
+
+This module contains the constant enumeration for **Destination Options and Hop-by-Hop Options**,
+which is automatically generated from :class:`pcapkit.vendor.ipv6.option.Option`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['Option']
+
+
+class Option(IntEnum):
+    """[Option] Destination Options and Hop-by-Hop Options"""
+
+    #: Pad1 [:rfc:`2460`]
+    Pad1 = 0x00
+
+    #: PadN [:rfc:`2460`]
+    PadN = 0x01
+
+    #: Jumbo Payload [:rfc:`2675`]
+    Jumbo_Payload = 0xC2
+
+    #: RPL Option [:rfc:`9008`]
+    RPL_Option_0x23 = 0x23
+
+    #: RPL Option (DEPRECATED) [:rfc:`6553`][:rfc:`9008`]
+    RPL_Option_0x63 = 0x63
+
+    #: Tunnel Encapsulation Limit [:rfc:`2473`]
+    Tunnel_Encapsulation_Limit = 0x04
+
+    #: Router Alert [:rfc:`2711`]
+    Router_Alert = 0x05
+
+    #: Quick-Start [:rfc:`4782`][RFC Errata 2034]
+    Quick_Start = 0x26
+
+    #: CALIPSO [:rfc:`5570`]
+    CALIPSO = 0x07
+
+    #: SMF_DPD [:rfc:`6621`]
+    SMF_DPD = 0x08
+
+    #: Home Address [:rfc:`6275`]
+    Home_Address = 0xC9
+
+    #: Endpoint Identification (DEPRECATED) [CHARLES LYNN]
+    Endpoint_Identification = 0x8A
+
+    #: ILNP Nonce [:rfc:`6744`]
+    ILNP_Nonce = 0x8B
+
+    #: Line-Identification Option [:rfc:`6788`]
+    Line_Identification_Option = 0x8C
+
+    #: Deprecated [:rfc:`7731`]
+    Deprecated = 0x4D
+
+    #: MPL Option [:rfc:`7731`]
+    MPL_Option = 0x6D
+
+    #: IP_DFF [:rfc:`6971`]
+    IP_DFF = 0xEE
+
+    #: Performance and Diagnostic Metrics (PDM) [:rfc:`8250`]
+    PDM = 0x0F
+
+    #: Minimum Path MTU Hop-by-Hop Option [:rfc:`9268`]
+    Minimum_Path_MTU_Hop_by_Hop_Option = 0x30
+
+    #: IOAM Destination Option and IOAM Hop-by-Hop Option [:rfc:`9486`]
+    IOAM_Destination_Option_and_IOAM_Hop_by_Hop_Option_0x11 = 0x11
+
+    #: IOAM Destination Option and IOAM Hop-by-Hop Option [:rfc:`9486`]
+    IOAM_Destination_Option_and_IOAM_Hop_by_Hop_Option_0x31 = 0x31
+
+    #: AltMark [:rfc:`9343`]
+    AltMark = 0x12
+
+    #: RFC3692-style Experiment [:rfc:`4727`]
+    RFC3692_style_Experiment_0x1E = 0x1E
+
+    #: RFC3692-style Experiment [:rfc:`4727`]
+    RFC3692_style_Experiment_0x3E = 0x3E
+
+    #: RFC3692-style Experiment [:rfc:`4727`]
+    RFC3692_style_Experiment_0x5E = 0x5E
+
+    #: RFC3692-style Experiment [:rfc:`4727`]
+    RFC3692_style_Experiment_0x7E = 0x7E
+
+    #: RFC3692-style Experiment [:rfc:`4727`]
+    RFC3692_style_Experiment_0x9E = 0x9E
+
+    #: RFC3692-style Experiment [:rfc:`4727`]
+    RFC3692_style_Experiment_0xBE = 0xBE
+
+    #: RFC3692-style Experiment [:rfc:`4727`]
+    RFC3692_style_Experiment_0xDE = 0xDE
+
+    #: RFC3692-style Experiment [:rfc:`4727`]
+    RFC3692_style_Experiment_0xFE = 0xFE
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'Option':
+        """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 Option(key)
+        if key not in Option._member_map_:  # pylint: disable=no-member
+            return extend_enum(Option, key, default)
+        return Option[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'Option':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0x00 <= value <= 0xFF):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return extend_enum(cls, 'Unassigned_0x%s' % hex(value)[2:].upper().zfill(2), value)

pcapkit/const/ipv6/option_action.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Option Actions
+====================
+
+.. module:: pcapkit.const.ipv6.option_action
+
+This module contains the constant enumeration for **Option Actions**,
+which is automatically generated from :class:`pcapkit.vendor.ipv6.option_action.OptionAction`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['OptionAction']
+
+
+class OptionAction(IntEnum):
+    """[OptionAction] Option Actions"""
+
+    skip = 0
+
+    discard = 1
+
+    discard_icmp_any = 2
+
+    discard_icmp_unicast = 3
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'OptionAction':
+        """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 OptionAction(key)
+        if key not in OptionAction._member_map_:  # pylint: disable=no-member
+            return extend_enum(OptionAction, key, default)
+        return OptionAction[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'OptionAction':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 3):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return extend_enum(cls, 'Unassigned_%d' % value, value)

pcapkit/const/ipv6/qs_function.py

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