pypcapkit 1.3.5.post6__cp313-none-any.whl

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)

pcapkit/const/mh/packet.py

@@ -0,0 +1,119 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Mobility Header Types - for the MH Type field in the Mobility Header
+==========================================================================
+
+.. module:: pcapkit.const.mh.packet
+
+This module contains the constant enumeration for **Mobility Header Types - for the MH Type field in the Mobility Header**,
+which is automatically generated from :class:`pcapkit.vendor.mh.packet.Packet`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['Packet']
+
+
+class Packet(IntEnum):
+    """[Packet] Mobility Header Types - for the MH Type field in the Mobility Header"""
+
+    #: Binding Refresh Request [:rfc:`6275`]
+    Binding_Refresh_Request = 0
+
+    #: Home Test Init [:rfc:`6275`]
+    Home_Test_Init = 1
+
+    #: Care-of Test Init [:rfc:`6275`]
+    Care_of_Test_Init = 2
+
+    #: Home Test [:rfc:`6275`]
+    Home_Test = 3
+
+    #: Care-of Test [:rfc:`6275`]
+    Care_of_Test = 4
+
+    #: Binding Update [:rfc:`6275`]
+    Binding_Update = 5
+
+    #: Binding Acknowledgement [:rfc:`6275`]
+    Binding_Acknowledgement = 6
+
+    #: Binding Error [:rfc:`6275`]
+    Binding_Error = 7
+
+    #: Fast Binding Update [:rfc:`5568`]
+    Fast_Binding_Update = 8
+
+    #: Fast Binding Acknowledgment [:rfc:`5568`]
+    Fast_Binding_Acknowledgment = 9
+
+    #: Fast Neighbor Advertisement (Deprecated) [:rfc:`5568`]
+    Fast_Neighbor_Advertisement = 10
+
+    #: Experimental Mobility Header [:rfc:`5096`]
+    Experimental_Mobility_Header = 11
+
+    #: Home Agent Switch Message [:rfc:`5142`]
+    Home_Agent_Switch_Message = 12
+
+    #: Heartbeat Message [:rfc:`5847`]
+    Heartbeat_Message = 13
+
+    #: Handover Initiate Message [:rfc:`5568`]
+    Handover_Initiate_Message = 14
+
+    #: Handover Acknowledge Message [:rfc:`5568`]
+    Handover_Acknowledge_Message = 15
+
+    #: Binding Revocation Message [:rfc:`5846`]
+    Binding_Revocation_Message = 16
+
+    #: Localized Routing Initiation [:rfc:`6705`]
+    Localized_Routing_Initiation = 17
+
+    #: Localized Routing Acknowledgment [:rfc:`6705`]
+    Localized_Routing_Acknowledgment = 18
+
+    #: Update Notification [:rfc:`7077`]
+    Update_Notification = 19
+
+    #: Update Notification Acknowledgement [:rfc:`7077`]
+    Update_Notification_Acknowledgement = 20
+
+    #: Flow Binding Message [:rfc:`7109`]
+    Flow_Binding_Message = 21
+
+    #: Subscription Query [:rfc:`7161`]
+    Subscription_Query = 22
+
+    #: Subscription Response [:rfc:`7161`]
+    Subscription_Response = 23
+
+    @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/mh/qos_attribute.py

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Quality-of-Service Attribute Registry
+===========================================
+
+.. module:: pcapkit.const.mh.qos_attribute
+
+This module contains the constant enumeration for **Quality-of-Service Attribute Registry**,
+which is automatically generated from :class:`pcapkit.vendor.mh.qos_attribute.QoSAttribute`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['QoSAttribute']
+
+
+class QoSAttribute(IntEnum):
+    """[QoSAttribute] Quality-of-Service Attribute Registry"""
+
+    #: Reserved [:rfc:`7222`]
+    Reserved_0 = 0
+
+    #: Per-MN-Agg-Max-DL-Bit-Rate [:rfc:`7222`]
+    Per_MN_Agg_Max_DL_Bit_Rate = 1
+
+    #: Per-MN-Agg-Max-UL-Bit-Rate [:rfc:`7222`]
+    Per_MN_Agg_Max_UL_Bit_Rate = 2
+
+    #: Per-Session-Agg-Max-DL-Bit-Rate [:rfc:`7222`]
+    Per_Session_Agg_Max_DL_Bit_Rate = 3
+
+    #: Per-Session-Agg-Max-UL-Bit-Rate [:rfc:`7222`]
+    Per_Session_Agg_Max_UL_Bit_Rate = 4
+
+    #: Allocation-Retention-Priority [:rfc:`7222`]
+    Allocation_Retention_Priority = 5
+
+    #: Aggregate-Max-DL-Bit-Rate [:rfc:`7222`]
+    Aggregate_Max_DL_Bit_Rate = 6
+
+    #: Aggregate-Max-UL-Bit-Rate [:rfc:`7222`]
+    Aggregate_Max_UL_Bit_Rate = 7
+
+    #: Guaranteed-DL-Bit-Rate [:rfc:`7222`]
+    Guaranteed_DL_Bit_Rate = 8
+
+    #: Guaranteed-UL-Bit-Rate [:rfc:`7222`]
+    Guaranteed_UL_Bit_Rate = 9
+
+    #: QoS-Traffic-Selector [:rfc:`7222`]
+    QoS_Traffic_Selector = 10
+
+    #: QoS-Vendor-Specific-Attribute [:rfc:`7222`]
+    QoS_Vendor_Specific_Attribute = 11
+
+    #: Reserved [:rfc:`7222`]
+    Reserved_255 = 255
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'QoSAttribute':
+        """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 QoSAttribute(key)
+        if key not in QoSAttribute._member_map_:  # pylint: disable=no-member
+            return extend_enum(QoSAttribute, key, default)
+        return QoSAttribute[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'QoSAttribute':
+        """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 12 <= value <= 254:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/revocation_status_code.py

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Binding Revocation Acknowledgement Status Codes
+=====================================================
+
+.. module:: pcapkit.const.mh.revocation_status_code
+
+This module contains the constant enumeration for **Binding Revocation Acknowledgement Status Codes**,
+which is automatically generated from :class:`pcapkit.vendor.mh.revocation_status_code.RevocationStatusCode`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['RevocationStatusCode']
+
+
+class RevocationStatusCode(IntEnum):
+    """[RevocationStatusCode] Binding Revocation Acknowledgement Status Codes"""
+
+    #: success [:rfc:`5846`]
+    success = 0
+
+    #: partial success [:rfc:`5846`]
+    partial_success = 1
+
+    #: Binding Does NOT Exist [:rfc:`5846`]
+    Binding_Does_NOT_Exist = 128
+
+    #: IPv4 Home Address Option Required [:rfc:`5846`]
+    IPv4_Home_Address_Option_Required = 129
+
+    #: Global Revocation NOT Authorized [:rfc:`5846`]
+    Global_Revocation_NOT_Authorized = 130
+
+    #: Revoked Mobile Nodes Identity Required [:rfc:`5846`]
+    Revoked_Mobile_Nodes_Identity_Required = 131
+
+    #: Revocation Failed - MN is Attached [:rfc:`5846`]
+    Revocation_Failed_MN_is_Attached = 132
+
+    #: Revocation Trigger NOT Supported [:rfc:`5846`]
+    Revocation_Trigger_NOT_Supported = 133
+
+    #: Revocation Function NOT Supported [:rfc:`5846`]
+    Revocation_Function_NOT_Supported = 134
+
+    #: Proxy Binding Revocation NOT Supported [:rfc:`5846`]
+    Proxy_Binding_Revocation_NOT_Supported = 135
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'RevocationStatusCode':
+        """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 RevocationStatusCode(key)
+        if key not in RevocationStatusCode._member_map_:  # pylint: disable=no-member
+            return extend_enum(RevocationStatusCode, key, default)
+        return RevocationStatusCode[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'RevocationStatusCode':
+        """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 <= 127:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 136 <= value <= 255:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/revocation_trigger.py

@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Revocation Trigger Values
+===============================
+
+.. module:: pcapkit.const.mh.revocation_trigger
+
+This module contains the constant enumeration for **Revocation Trigger Values**,
+which is automatically generated from :class:`pcapkit.vendor.mh.revocation_trigger.RevocationTrigger`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['RevocationTrigger']
+
+
+class RevocationTrigger(IntEnum):
+    """[RevocationTrigger] Revocation Trigger Values"""
+
+    #: Unspecified [:rfc:`5846`]
+    Unspecified = 0
+
+    #: Administrative Reason [:rfc:`5846`]
+    Administrative_Reason = 1
+
+    #: Inter-MAG Handover - same Access Type [:rfc:`5846`]
+    Inter_MAG_Handover_same_Access_Type = 2
+
+    #: Inter-MAG Handover - different Access Type [:rfc:`5846`]
+    Inter_MAG_Handover_different_Access_Type = 3
+
+    #: Inter-MAG Handover - Unknown [:rfc:`5846`]
+    Inter_MAG_Handover_Unknown = 4
+
+    #: User Initiated Session(s) Termination [:rfc:`5846`]
+    User_Initiated_Session_Termination = 5
+
+    #: Access Network Session(s) Termination [:rfc:`5846`]
+    Access_Network_Session_Termination = 6
+
+    #: Possible Out-of Sync BCE State [:rfc:`5846`]
+    Possible_Out_of_Sync_BCE_State = 7
+
+    #: Per-Peer Policy [:rfc:`5846`]
+    Per_Peer_Policy = 128
+
+    #: Revoking Mobility Node Local Policy [:rfc:`5846`]
+    Revoking_Mobility_Node_Local_Policy = 129
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'RevocationTrigger':
+        """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 RevocationTrigger(key)
+        if key not in RevocationTrigger._member_map_:  # pylint: disable=no-member
+            return extend_enum(RevocationTrigger, key, default)
+        return RevocationTrigger[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'RevocationTrigger':
+        """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 8 <= value <= 127:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 130 <= value <= 249:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 250 <= value <= 255:
+            #: Reserved for Testing Purposes Only [:rfc:`5846`]
+            return extend_enum(cls, 'Reserved_for_Testing_Purposes_Only_%d' % value, value)
+        return super()._missing_(value)