pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/const/mh/home_address_reply.py

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

pcapkit/const/mh/lla_code.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Link-Layer Address (LLA) Option Code
+==========================================
+
+.. module:: pcapkit.const.mh.lla_code
+
+This module contains the constant enumeration for **Link-Layer Address (LLA) Option Code**,
+which is automatically generated from :class:`pcapkit.vendor.mh.lla_code.LLACode`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['LLACode']
+
+
+class LLACode(IntEnum):
+    """[LLACode] Link-Layer Address (LLA) Option Code"""
+
+    Wilcard = 0
+
+    New_Access_Point = 1
+
+    MH = 2
+
+    NAR = 3
+
+    RtSolPr_or_PrRtAdv = 4
+
+    access_point = 5
+
+    no_prefix_information = 6
+
+    no_fast_handover_support = 7
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'LLACode':
+        """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 LLACode(key)
+        if key not in LLACode._member_map_:  # pylint: disable=no-member
+            return extend_enum(LLACode, key, default)
+        return LLACode[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'LLACode':
+        """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/lma_mag_suboption.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""LMA-Controlled MAG Parameters Sub-Option Type Values
+==========================================================
+
+.. module:: pcapkit.const.mh.lma_mag_suboption
+
+This module contains the constant enumeration for **LMA-Controlled MAG Parameters Sub-Option Type Values**,
+which is automatically generated from :class:`pcapkit.vendor.mh.lma_mag_suboption.LMAControlledMAGSuboption`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['LMAControlledMAGSuboption']
+
+
+class LMAControlledMAGSuboption(IntEnum):
+    """[LMAControlledMAGSuboption] LMA-Controlled MAG Parameters Sub-Option Type Values"""
+
+    #: Reserved [:rfc:`8127`]
+    Reserved_0 = 0
+
+    #: Binding Re-registration Control Sub-Option [:rfc:`8127`]
+    Binding_Re_registration_Control = 1
+
+    #: Heartbeat Control Sub-Option [:rfc:`8127`]
+    Heartbeat_Control = 2
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'LMAControlledMAGSuboption':
+        """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 LMAControlledMAGSuboption(key)
+        if key not in LMAControlledMAGSuboption._member_map_:  # pylint: disable=no-member
+            return extend_enum(LMAControlledMAGSuboption, key, default)
+        return LMAControlledMAGSuboption[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'LMAControlledMAGSuboption':
+        """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 3 <= value <= 255:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/mn_group_id.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Mobile Node Group Identifier Type Registry
+================================================
+
+.. module:: pcapkit.const.mh.mn_group_id
+
+This module contains the constant enumeration for **Mobile Node Group Identifier Type Registry**,
+which is automatically generated from :class:`pcapkit.vendor.mh.mn_group_id.MNGroupID`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['MNGroupID']
+
+
+class MNGroupID(IntEnum):
+    """[MNGroupID] Mobile Node Group Identifier Type Registry"""
+
+    #: Reserved [:rfc:`6602`]
+    Reserved_0 = 0
+
+    #: Bulk Binding Update Group [:rfc:`6602`]
+    Bulk_Binding_Update_Group = 1
+
+    #: Reserved [:rfc:`6602`]
+    Reserved_255 = 255
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'MNGroupID':
+        """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 MNGroupID(key)
+        if key not in MNGroupID._member_map_:  # pylint: disable=no-member
+            return extend_enum(MNGroupID, key, default)
+        return MNGroupID[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'MNGroupID':
+        """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 2 <= value <= 254:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/mn_id_subtype.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Mobile Node Identifier Option Subtypes
+============================================
+
+.. module:: pcapkit.const.mh.mn_id_subtype
+
+This module contains the constant enumeration for **Mobile Node Identifier Option Subtypes**,
+which is automatically generated from :class:`pcapkit.vendor.mh.mn_id_subtype.MNIDSubtype`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['MNIDSubtype']
+
+
+class MNIDSubtype(IntEnum):
+    """[MNIDSubtype] Mobile Node Identifier Option Subtypes"""
+
+    #: NAI [:rfc:`4283`]
+    NAI = 1
+
+    #: IPv6 Address [:rfc:`8371`]
+    IPv6_Address = 2
+
+    #: IMSI [:rfc:`8371`]
+    IMSI = 3
+
+    #: P-TMSI [:rfc:`8371`]
+    P_TMSI = 4
+
+    #: EUI-48 address [:rfc:`8371`]
+    EUI_48_address = 5
+
+    #: EUI-64 address [:rfc:`8371`]
+    EUI_64_address = 6
+
+    #: GUTI [:rfc:`8371`]
+    GUTI = 7
+
+    #: DUID [:rfc:`8371`]
+    DUID = 8
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'MNIDSubtype':
+        """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 MNIDSubtype(key)
+        if key not in MNIDSubtype._member_map_:  # pylint: disable=no-member
+            return extend_enum(MNIDSubtype, key, default)
+        return MNIDSubtype[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'MNIDSubtype':
+        """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 9 <= value <= 15:
+            #: Reserved [:rfc:`8371`]
+            return extend_enum(cls, 'Reserved_%d' % value, value)
+        if 16 <= value <= 255:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/operator_id.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Operator-Identifier Type Registry
+=======================================
+
+.. module:: pcapkit.const.mh.operator_id
+
+This module contains the constant enumeration for **Operator-Identifier Type Registry**,
+which is automatically generated from :class:`pcapkit.vendor.mh.operator_id.OperatorID`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['OperatorID']
+
+
+class OperatorID(IntEnum):
+    """[OperatorID] Operator-Identifier Type Registry"""
+
+    #: Reserved [:rfc:`6757`]
+    Reserved_0 = 0
+
+    #: Operator-Identifier as a variable-length Private Enterprise Number (PEN)
+    #: [:rfc:`6757`]
+    Operator_Identifier_as_a_variable_length_Private_Enterprise_Number = 1
+
+    #: Realm of the Operator [:rfc:`6757`]
+    Realm_of_the_Operator = 2
+
+    #: Reserved [:rfc:`6757`]
+    Reserved_255 = 255
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'OperatorID':
+        """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 OperatorID(key)
+        if key not in OperatorID._member_map_:  # pylint: disable=no-member
+            return extend_enum(OperatorID, key, default)
+        return OperatorID[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'OperatorID':
+        """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 3 <= value <= 254:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/option.py

@@ -0,0 +1,260 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Mobility Options
+======================
+
+.. module:: pcapkit.const.mh.option
+
+This module contains the constant enumeration for **Mobility Options**,
+which is automatically generated from :class:`pcapkit.vendor.mh.option.Option`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['Option']
+
+
+class Option(IntEnum):
+    """[Option] Mobility Options"""
+
+    #: Pad1 [:rfc:`6275`]
+    Pad1 = 0
+
+    #: PadN [:rfc:`6275`]
+    PadN = 1
+
+    #: Binding Refresh Advice [:rfc:`6275`]
+    Binding_Refresh_Advice = 2
+
+    #: Alternate Care-of Address [:rfc:`6275`]
+    Alternate_Care_of_Address = 3
+
+    #: Nonce Indices [:rfc:`6275`]
+    Nonce_Indices = 4
+
+    #: Authorization Data [:rfc:`6275`]
+    Authorization_Data = 5
+
+    #: Mobile Network Prefix Option [:rfc:`3963`]
+    Mobile_Network_Prefix_Option = 6
+
+    #: Mobility Header Link-Layer Address option [:rfc:`5568`]
+    Mobility_Header_Link_Layer_Address_option = 7
+
+    #: MN-ID-OPTION-TYPE [:rfc:`4283`]
+    MN_ID_OPTION_TYPE = 8
+
+    #: AUTH-OPTION-TYPE [:rfc:`4285`]
+    AUTH_OPTION_TYPE = 9
+
+    #: MESG-ID-OPTION-TYPE [:rfc:`4285`]
+    MESG_ID_OPTION_TYPE = 10
+
+    #: CGA Parameters Request [:rfc:`4866`]
+    CGA_Parameters_Request = 11
+
+    #: CGA Parameters [:rfc:`4866`]
+    CGA_Parameters = 12
+
+    #: Signature [:rfc:`4866`]
+    Signature = 13
+
+    #: Permanent Home Keygen Token [:rfc:`4866`]
+    Permanent_Home_Keygen_Token = 14
+
+    #: Care-of Test Init [:rfc:`4866`]
+    Care_of_Test_Init = 15
+
+    #: Care-of Test [:rfc:`4866`]
+    Care_of_Test = 16
+
+    #: DNS-UPDATE-TYPE [:rfc:`5026`]
+    DNS_UPDATE_TYPE = 17
+
+    #: Experimental Mobility Option [:rfc:`5096`]
+    Experimental_Mobility_Option = 18
+
+    #: Vendor Specific Mobility Option [:rfc:`5094`]
+    Vendor_Specific_Mobility_Option = 19
+
+    #: Service Selection Mobility Option [:rfc:`5149`]
+    Service_Selection_Mobility_Option = 20
+
+    #: Binding Authorization Data for FMIPv6 (BADF) [:rfc:`5568`]
+    Binding_Authorization_Data_for_FMIPv6 = 21
+
+    #: Home Network Prefix Option [:rfc:`5213`]
+    Home_Network_Prefix_Option = 22
+
+    #: Handoff Indicator Option [:rfc:`5213`]
+    Handoff_Indicator_Option = 23
+
+    #: Access Technology Type Option [:rfc:`5213`]
+    Access_Technology_Type_Option = 24
+
+    #: Mobile Node Link-layer Identifier Option [:rfc:`5213`]
+    Mobile_Node_Link_layer_Identifier_Option = 25
+
+    #: Link-local Address Option [:rfc:`5213`]
+    Link_local_Address_Option = 26
+
+    #: Timestamp Option [:rfc:`5213`]
+    Timestamp_Option = 27
+
+    #: Restart Counter [:rfc:`5847`]
+    Restart_Counter = 28
+
+    #: IPv4 Home Address [:rfc:`5555`]
+    IPv4_Home_Address = 29
+
+    #: IPv4 Address Acknowledgement [:rfc:`5555`]
+    IPv4_Address_Acknowledgement = 30
+
+    #: NAT Detection [:rfc:`5555`]
+    NAT_Detection = 31
+
+    #: IPv4 Care-of Address [:rfc:`5555`]
+    IPv4_Care_of_Address = 32
+
+    #: GRE Key Option [:rfc:`5845`]
+    GRE_Key_Option = 33
+
+    #: Mobility Header IPv6 Address/Prefix [:rfc:`5568`]
+    Mobility_Header_IPv6_Address_Prefix = 34
+
+    #: Binding Identifier [:rfc:`5648`]
+    Binding_Identifier = 35
+
+    #: IPv4 Home Address Request [:rfc:`5844`]
+    IPv4_Home_Address_Request = 36
+
+    #: IPv4 Home Address Reply [:rfc:`5844`]
+    IPv4_Home_Address_Reply = 37
+
+    #: IPv4 Default-Router Address [:rfc:`5844`]
+    IPv4_Default_Router_Address = 38
+
+    #: IPv4 DHCP Support Mode [:rfc:`5844`]
+    IPv4_DHCP_Support_Mode = 39
+
+    #: Context Request Option [:rfc:`5949`]
+    Context_Request_Option = 40
+
+    #: Local Mobility Anchor Address Option [:rfc:`5949`]
+    Local_Mobility_Anchor_Address_Option = 41
+
+    #: Mobile Node Link-local Address Interface Identifier Option [:rfc:`5949`]
+    Mobile_Node_Link_local_Address_Interface_Identifier_Option = 42
+
+    #: Transient Binding [:rfc:`6058`]
+    Transient_Binding = 43
+
+    #: Flow Summary Mobility Option [:rfc:`6089`]
+    Flow_Summary_Mobility_Option = 44
+
+    #: Flow Identification Mobility Option [:rfc:`6089`]
+    Flow_Identification_Mobility_Option = 45
+
+    #: Redirect-Capability Mobility Option [:rfc:`6463`]
+    Redirect_Capability_Mobility_Option = 46
+
+    #: Redirect Mobility Option [:rfc:`6463`]
+    Redirect_Mobility_Option = 47
+
+    #: Load Information Mobility Option [:rfc:`6463`]
+    Load_Information_Mobility_Option = 48
+
+    #: Alternate IPv4 Care-of Address [:rfc:`6463`]
+    Alternate_IPv4_Care_of_Address = 49
+
+    #: Mobile Node Group Identifier [:rfc:`6602`]
+    Mobile_Node_Group_Identifier = 50
+
+    #: MAG IPv6 Address [:rfc:`6705`]
+    MAG_IPv6_Address = 51
+
+    #: Access Network Identifier [:rfc:`6757`]
+    Access_Network_Identifier = 52
+
+    #: IPv4 Traffic Offload Selector [:rfc:`6909`]
+    IPv4_Traffic_Offload_Selector = 53
+
+    #: Dynamic IP Multicast Selector [:rfc:`7028`]
+    Dynamic_IP_Multicast_Selector = 54
+
+    #: Delegated Mobile Network Prefix [:rfc:`7148`]
+    Delegated_Mobile_Network_Prefix = 55
+
+    #: Active Multicast Subscription IPv4 [:rfc:`7161`]
+    Active_Multicast_Subscription_IPv4 = 56
+
+    #: Active Multicast Subscription IPv6 [:rfc:`7161`]
+    Active_Multicast_Subscription_IPv6 = 57
+
+    #: Quality-of-Service [:rfc:`7222`]
+    Quality_of_Service = 58
+
+    #: LMA User-Plane Address [:rfc:`7389`]
+    LMA_User_Plane_Address = 59
+
+    #: Multicast Mobility Option [:rfc:`7411`]
+    Multicast_Mobility_Option = 60
+
+    #: Multicast Acknowledgement Option [:rfc:`7411`]
+    Multicast_Acknowledgement_Option = 61
+
+    #: LMA-Controlled MAG Parameters [:rfc:`8127`]
+    LMA_Controlled_MAG_Parameters = 62
+
+    #: MAG Multipath-Binding [:rfc:`8278`]
+    MAG_Multipath_Binding = 63
+
+    #: MAG Identifier [:rfc:`8278`]
+    MAG_Identifier = 64
+
+    #: Anchored Prefix [:rfc:`8885`]
+    Anchored_Prefix = 65
+
+    #: Local Prefix [:rfc:`8885`]
+    Local_Prefix = 66
+
+    #: Previous MAAR [:rfc:`8885`]
+    Previous_MAAR = 67
+
+    #: Serving MAAR [:rfc:`8885`]
+    Serving_MAAR = 68
+
+    #: DLIF Link-Local Address [:rfc:`8885`]
+    DLIF_Link_Local_Address = 69
+
+    #: DLIF Link-Layer Address [:rfc:`8885`]
+    DLIF_Link_Layer_Address = 70
+
+    @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 0 <= value <= 255):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return extend_enum(cls, 'Unassigned_%d' % value, value)