pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/const/mh/binding_update_flag.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Binding Update Flags
+==========================
+
+.. module:: pcapkit.const.mh.binding_update_flag
+
+This module contains the constant enumeration for **Binding Update Flags**,
+which is automatically generated from :class:`pcapkit.vendor.mh.binding_update_flag.BindingUpdateFlag`.
+
+"""
+
+from aenum import IntFlag
+
+__all__ = ['BindingUpdateFlag']
+
+
+class BindingUpdateFlag(IntFlag):
+    """[BindingUpdateFlag] Binding Update Flags"""
+
+    #: A [:rfc:`6275`]
+    A = 0x8000
+
+    #: H [:rfc:`6275`]
+    H = 0x4000
+
+    #: L [:rfc:`6275`]
+    L = 0x2000
+
+    #: K [:rfc:`6275`]
+    K = 0x1000
+
+    #: M [:rfc:`4140`]
+    M = 0x0800
+
+    #: R [:rfc:`3963`]
+    R = 0x0400
+
+    #: P [:rfc:`5213`]
+    P = 0x0200
+
+    #: F [:rfc:`5555`]
+    F = 0x0100
+
+    #: T [:rfc:`5845`]
+    T = 0x0080
+
+    #: B [:rfc:`6602`]
+    B = 0x0040
+
+    #: S [:rfc:`7161`]
+    S = 0x0020
+
+    #: D [:rfc:`8885`]
+    D = 0x0010
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'BindingUpdateFlag':
+        """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 BindingUpdateFlag(key)
+        return BindingUpdateFlag[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'BindingUpdateFlag':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 0xFFFF):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return cls(value)

pcapkit/const/mh/cga_extension.py

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""CGA Extension Type Values
+===============================
+
+.. module:: pcapkit.const.mh.cga_extension
+
+This module contains the constant enumeration for **CGA Extension Type Values**,
+which is automatically generated from :class:`pcapkit.vendor.mh.cga_extension.CGAExtension`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['CGAExtension']
+
+
+class CGAExtension(IntEnum):
+    """[CGAExtension] CGA Extension Type Values"""
+
+    #: Multi-Prefix [:rfc:`5535`]
+    Multi_Prefix = 0x0012
+
+    #: Exp_FFFD (experimental) [:rfc:`4581`]
+    Exp_FFFD = 0xFFFD
+
+    #: Exp_FFFE (experimental) [:rfc:`4581`]
+    Exp_FFFE = 0xFFFE
+
+    #: Exp_FFFF (experimental) [:rfc:`4581`]
+    Exp_FFFF = 0xFFFF
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'CGAExtension':
+        """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 CGAExtension(key)
+        if key not in CGAExtension._member_map_:  # pylint: disable=no-member
+            return extend_enum(CGAExtension, key, default)
+        return CGAExtension[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'CGAExtension':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 0xFFFF):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        if 0x0000 <= value <= 0x0011:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%04x' % value, value)
+        if 0x0013 <= value <= 0xFFFC:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%04x' % value, value)
+        #: Unspecified in the IANA registry
+        return extend_enum(cls, 'Unassigned_%04x' % value, value)

pcapkit/const/mh/cga_sec.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""CGA SEC
+=============
+
+.. module:: pcapkit.const.mh.cga_sec
+
+This module contains the constant enumeration for **CGA SEC**,
+which is automatically generated from :class:`pcapkit.vendor.mh.cga_sec.CGASec`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['CGASec']
+
+
+class CGASec(IntEnum):
+    """[CGASec] CGA SEC"""
+
+    #: SHA-1_0hash2bits [:rfc:`4982`]
+    SHA_1_0hash2bits = 0b000
+
+    #: SHA-1_16hash2bits [:rfc:`4982`]
+    SHA_1_16hash2bits = 0b001
+
+    #: SHA-1_32hash2bits [:rfc:`4982`]
+    SHA_1_32hash2bits = 0b010
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'CGASec':
+        """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 CGASec(key)
+        if key not in CGASec._member_map_:  # pylint: disable=no-member
+            return extend_enum(CGASec, key, default)
+        return CGASec[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'CGASec':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 0b111):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        #: Unspecified in the IANA registry
+        return extend_enum(cls, 'Unassigned_%s' % bin(value)[2:], value)

pcapkit/const/mh/cga_type.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""CGA Extension Type Tags
+=============================
+
+.. module:: pcapkit.const.mh.cga_type
+
+This module contains the constant enumeration for **CGA Extension Type Tags**,
+which is automatically generated from :class:`pcapkit.vendor.mh.cga_type.CGAType`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['CGAType']
+
+
+class CGAType(IntEnum):
+    """[CGAType] CGA Extension Type Tags"""
+
+    #: 0x086F CA5E 10B2 00C9 9C8C E001 6427 7C08 [:rfc:`3971`]
+    Tag_086F_CA5E_10B2_00C9_9C8C_E001_6427_7C08 = 0x086F_CA5E_10B2_00C9_9C8C_E001_6427_7C08
+
+    #: 0x5F27 0586 8D6C 4C56 A246 9EBB 9B2A 2E13 [:rfc:`4866`]
+    Tag_5F27_0586_8D6C_4C56_A246_9EBB_9B2A_2E13 = 0x5F27_0586_8D6C_4C56_A246_9EBB_9B2A_2E13
+
+    #: 0xF0EF F02F BFF4 3D0F E793 0C3C 6E61 74EA [:rfc:`7401`]
+    Tag_F0EF_F02F_BFF4_3D0F_E793_0C3C_6E61_74EA = 0xF0EF_F02F_BFF4_3D0F_E793_0C3C_6E61_74EA
+
+    #: 0x4A30 5662 4858 574B 3655 416F 506A 6D48 [:rfc:`5533`]
+    Tag_4A30_5662_4858_574B_3655_416F_506A_6D48 = 0x4A30_5662_4858_574B_3655_416F_506A_6D48
+
+    #: 0x09F5 2BE5 3B62 4C76 CB96 4E7F CDC9 2804 [:rfc:`6496`]
+    Tag_09F5_2BE5_3B62_4C76_CB96_4E7F_CDC9_2804 = 0x09F5_2BE5_3B62_4C76_CB96_4E7F_CDC9_2804
+
+    #: 0x8701 55C8 0CCA DD32 6AB7 E415 F148 84D0 [:rfc:`8928`]
+    Tag_8701_55C8_0CCA_DD32_6AB7_E415_F148_84D0 = 0x8701_55C8_0CCA_DD32_6AB7_E415_F148_84D0
+
+    #: 0x00B5 A69C 795D F5D5 F008 7F56 843F 2C40 [:rfc:`9374`]
+    Tag_00B5_A69C_795D_F5D5_F008_7F56_843F_2C40 = 0x00B5_A69C_795D_F5D5_F008_7F56_843F_2C40
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'CGAType':
+        """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 CGAType(key)
+        if key not in CGAType._member_map_:  # pylint: disable=no-member
+            return extend_enum(CGAType, key, default)
+        return CGAType[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'CGAType':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 0xFFFF_FFFF_FFFF_FFFF_FFFF_FFFF_FFFF_FFFF):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return extend_enum(cls, 'Tag_%s' % ('_'.join(__import__('textwrap').wrap('%032x' % value, 4))), value)

pcapkit/const/mh/dhcp_support_mode.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""IPv4 DHCP Support Mode Flags
+==================================
+
+.. module:: pcapkit.const.mh.dhcp_support_mode
+
+This module contains the constant enumeration for **IPv4 DHCP Support Mode Flags**,
+which is automatically generated from :class:`pcapkit.vendor.mh.dhcp_support_mode.DHCPSupportMode`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['DHCPSupportMode']
+
+
+class DHCPSupportMode(IntEnum):
+    """[DHCPSupportMode] IPv4 DHCP Support Mode Flags"""
+
+    #: Unassigned
+    Unassigned_0x0 = 0x0
+
+    #: (S) flag [:rfc:`5844`]
+    S_flag = 0x1
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'DHCPSupportMode':
+        """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 DHCPSupportMode(key)
+        if key not in DHCPSupportMode._member_map_:  # pylint: disable=no-member
+            return extend_enum(DHCPSupportMode, key, default)
+        return DHCPSupportMode[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'DHCPSupportMode':
+        """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/mh/dns_status_code.py

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Status Codes (DNS Update Mobility Option)
+===============================================
+
+.. module:: pcapkit.const.mh.dns_status_code
+
+This module contains the constant enumeration for **Status Codes (DNS Update Mobility Option)**,
+which is automatically generated from :class:`pcapkit.vendor.mh.dns_status_code.DNSStatusCode`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['DNSStatusCode']
+
+
+class DNSStatusCode(IntEnum):
+    """[DNSStatusCode] Status Codes (DNS Update Mobility Option)"""
+
+    #: DNS update performed [:rfc:`5026`]
+    DNS_update_performed = 0
+
+    #: Reason unspecified [:rfc:`5026`]
+    Reason_unspecified = 128
+
+    #: Administratively prohibited [:rfc:`5026`]
+    Administratively_prohibited = 129
+
+    #: DNS Update Failed [:rfc:`5026`]
+    DNS_Update_Failed = 130
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'DNSStatusCode':
+        """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 DNSStatusCode(key)
+        if key not in DNSStatusCode._member_map_:  # pylint: disable=no-member
+            return extend_enum(DNSStatusCode, key, default)
+        return DNSStatusCode[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'DNSStatusCode':
+        """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 1 <= value <= 127:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 131 <= value <= 255:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/dsmip6_tls_packet.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""DSMIP6-TLS Packet Types Registry
+======================================
+
+.. module:: pcapkit.const.mh.dsmip6_tls_packet
+
+This module contains the constant enumeration for **DSMIP6-TLS Packet Types Registry**,
+which is automatically generated from :class:`pcapkit.vendor.mh.dsmip6_tls_packet.DSMIP6TLSPacket`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['DSMIP6TLSPacket']
+
+
+class DSMIP6TLSPacket(IntEnum):
+    """[DSMIP6TLSPacket] DSMIP6-TLS Packet Types Registry"""
+
+    #: non-encrypted IP packet [:rfc:`6618`]
+    non_encrypted_IP_packet = 0
+
+    #: encrypted IP packet [:rfc:`6618`]
+    encrypted_IP_packet = 1
+
+    #: mobility header [:rfc:`6618`]
+    mobility_header = 8
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'DSMIP6TLSPacket':
+        """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 DSMIP6TLSPacket(key)
+        if key not in DSMIP6TLSPacket._member_map_:  # pylint: disable=no-member
+            return extend_enum(DSMIP6TLSPacket, key, default)
+        return DSMIP6TLSPacket[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'DSMIP6TLSPacket':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 15):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        if 2 <= value <= 7:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 9 <= value <= 15:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/dsmipv6_home_address.py

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Dual Stack MIPv6 (DSMIPv6) IPv4 Home Address Option Status Codes
+======================================================================
+
+.. module:: pcapkit.const.mh.dsmipv6_home_address
+
+This module contains the constant enumeration for **Dual Stack MIPv6 (DSMIPv6) IPv4 Home Address Option Status Codes**,
+which is automatically generated from :class:`pcapkit.vendor.mh.dsmipv6_home_address.DSMIPv6HomeAddress`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['DSMIPv6HomeAddress']
+
+
+class DSMIPv6HomeAddress(IntEnum):
+    """[DSMIPv6HomeAddress] Dual Stack MIPv6 (DSMIPv6) IPv4 Home Address Option Status Codes"""
+
+    #: Success [:rfc:`5555`]
+    Success = 0
+
+    #: Failure, reason unspecified [:rfc:`5555`]
+    Failure_reason_unspecified = 128
+
+    #: Administratively prohibited [:rfc:`5555`]
+    Administratively_prohibited = 129
+
+    #: Incorrect IPv4 home address [:rfc:`5555`]
+    Incorrect_IPv4_home_address = 130
+
+    #: Invalid IPv4 address [:rfc:`5555`]
+    Invalid_IPv4_address = 131
+
+    #: Dynamic IPv4 home address assignment not available [:rfc:`5555`]
+    Dynamic_IPv4_home_address_assignment_not_available = 132
+
+    #: Prefix allocation unauthorized [:rfc:`5555`]
+    Prefix_allocation_unauthorized = 133
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'DSMIPv6HomeAddress':
+        """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 DSMIPv6HomeAddress(key)
+        if key not in DSMIPv6HomeAddress._member_map_:  # pylint: disable=no-member
+            return extend_enum(DSMIPv6HomeAddress, key, default)
+        return DSMIPv6HomeAddress[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'DSMIPv6HomeAddress':
+        """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 1 <= value <= 127:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 134 <= value <= 255:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/enumerating_algorithm.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Enumerating Algorithms
+============================
+
+.. module:: pcapkit.const.mh.enumerating_algorithm
+
+This module contains the constant enumeration for **Enumerating Algorithms**,
+which is automatically generated from :class:`pcapkit.vendor.mh.enumerating_algorithm.EnumeratingAlgorithm`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['EnumeratingAlgorithm']
+
+
+class EnumeratingAlgorithm(IntEnum):
+    """[EnumeratingAlgorithm] Enumerating Algorithms"""
+
+    #: Reserved (not available for assignment) [:rfc:`4285`]
+    Reserved_0 = 0
+
+    #: HMAC_SHA1_SPI [:rfc:`4285`]
+    HMAC_SHA1_SPI = 3
+
+    #: Reserved for use by 3GPP2 [:rfc:`4285`]
+    Reserved_for_use_by_3GPP2 = 5
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'EnumeratingAlgorithm':
+        """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 EnumeratingAlgorithm(key)
+        if key not in EnumeratingAlgorithm._member_map_:  # pylint: disable=no-member
+            return extend_enum(EnumeratingAlgorithm, key, default)
+        return EnumeratingAlgorithm[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'EnumeratingAlgorithm':
+        """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/mh/fb_ack_status.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Flow Binding Acknowledgement Status Codes
+===============================================
+
+.. module:: pcapkit.const.mh.fb_ack_status
+
+This module contains the constant enumeration for **Flow Binding Acknowledgement Status Codes**,
+which is automatically generated from :class:`pcapkit.vendor.mh.fb_ack_status.FlowBindingACKStatus`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['FlowBindingACKStatus']
+
+
+class FlowBindingACKStatus(IntEnum):
+    """[FlowBindingACKStatus] Flow Binding Acknowledgement Status Codes"""
+
+    #: Success [:rfc:`7109`]
+    Success = 0
+
+    #: Binding (target CoA) Does NOT Exist [:rfc:`7109`]
+    Binding = 128
+
+    #: Action NOT Authorized [:rfc:`7109`]
+    Action_NOT_Authorized = 129
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'FlowBindingACKStatus':
+        """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 FlowBindingACKStatus(key)
+        if key not in FlowBindingACKStatus._member_map_:  # pylint: disable=no-member
+            return extend_enum(FlowBindingACKStatus, key, default)
+        return FlowBindingACKStatus[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'FlowBindingACKStatus':
+        """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 1 <= value <= 127:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 130 <= value <= 255:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)