pypcapkit 1.3.5.post6__cp312-none-any.whl

pcapkit/const/mh/status_code.py

@@ -0,0 +1,232 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Status Codes
+==================
+
+.. module:: pcapkit.const.mh.status_code
+
+This module contains the constant enumeration for **Status Codes**,
+which is automatically generated from :class:`pcapkit.vendor.mh.status_code.StatusCode`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['StatusCode']
+
+
+class StatusCode(IntEnum):
+    """[StatusCode] Status Codes"""
+
+    #: Binding Update accepted/Proxy Binding Update accepted
+    #: [:rfc:`6275`][:rfc:`5213`]
+    Binding_Update_accepted_Proxy_Binding_Update_accepted = 0
+
+    #: Accepted but prefix discovery necessary [:rfc:`6275`]
+    Accepted_but_prefix_discovery_necessary = 1
+
+    #: GRE_KEY_OPTION_NOT_REQUIRED [:rfc:`5845`]
+    GRE_KEY_OPTION_NOT_REQUIRED = 2
+
+    #: GRE_TUNNELING_BUT_TLV_HEADER_NOT_SUPPORTED [:rfc:`5845`]
+    GRE_TUNNELING_BUT_TLV_HEADER_NOT_SUPPORTED = 3
+
+    #: MCOA NOTCOMPLETE [:rfc:`5648`]
+    MCOA_NOTCOMPLETE = 4
+
+    #: MCOA RETURNHOME WO/NDP [:rfc:`5648`]
+    MCOA_RETURNHOME_WO_NDP = 5
+
+    #: PBU_ACCEPTED_TB_IGNORED_SETTINGSMISMATCH [:rfc:`6058`]
+    PBU_ACCEPTED_TB_IGNORED_SETTINGSMISMATCH = 6
+
+    #: Reason unspecified [:rfc:`6275`]
+    Reason_unspecified = 128
+
+    #: Administratively prohibited [:rfc:`6275`]
+    Administratively_prohibited = 129
+
+    #: Insufficient resources [:rfc:`6275`]
+    Insufficient_resources = 130
+
+    #: Home registration not supported [:rfc:`6275`]
+    Home_registration_not_supported = 131
+
+    #: Not home subnet [:rfc:`6275`]
+    Not_home_subnet = 132
+
+    #: Not home agent for this mobile node [:rfc:`6275`]
+    Not_home_agent_for_this_mobile_node = 133
+
+    #: Duplicate Address Detection failed [:rfc:`6275`]
+    Duplicate_Address_Detection_failed = 134
+
+    #: Sequence number out of window [:rfc:`6275`]
+    Sequence_number_out_of_window = 135
+
+    #: Expired home nonce index [:rfc:`6275`]
+    Expired_home_nonce_index = 136
+
+    #: Expired care-of nonce index [:rfc:`6275`]
+    Expired_care_of_nonce_index = 137
+
+    #: Expired nonces [:rfc:`6275`]
+    Expired_nonces = 138
+
+    #: Registration type change disallowed [:rfc:`6275`]
+    Registration_type_change_disallowed = 139
+
+    #: Mobile Router Operation not permitted [:rfc:`3963`]
+    Mobile_Router_Operation_not_permitted = 140
+
+    #: Invalid Prefix [:rfc:`3963`]
+    Invalid_Prefix = 141
+
+    #: Not Authorized for Prefix [:rfc:`3963`]
+    Not_Authorized_for_Prefix = 142
+
+    #: Forwarding Setup failed [:rfc:`3963`]
+    Forwarding_Setup_failed = 143
+
+    #: MIPV6-ID-MISMATCH [:rfc:`4285`]
+    MIPV6_ID_MISMATCH = 144
+
+    #: MIPV6-MESG-ID-REQD [:rfc:`4285`]
+    MIPV6_MESG_ID_REQD = 145
+
+    #: MIPV6-AUTH-FAIL [:rfc:`4285`][RFC Errata 3463]
+    MIPV6_AUTH_FAIL = 146
+
+    #: Permanent home keygen token unavailable [:rfc:`4866`]
+    Permanent_home_keygen_token_unavailable = 147
+
+    #: CGA and signature verification failed [:rfc:`4866`]
+    CGA_and_signature_verification_failed = 148
+
+    #: Permanent home keygen token exists [:rfc:`4866`]
+    Permanent_home_keygen_token_exists = 149
+
+    #: Non-null home nonce index expected [:rfc:`4866`]
+    Non_null_home_nonce_index_expected = 150
+
+    #: SERVICE_AUTHORIZATION_FAILED [:rfc:`5149`]
+    SERVICE_AUTHORIZATION_FAILED = 151
+
+    #: PROXY_REG_NOT_ENABLED [:rfc:`5213`]
+    PROXY_REG_NOT_ENABLED = 152
+
+    #: NOT_LMA_FOR_THIS_MOBILE_NODE [:rfc:`5213`]
+    NOT_LMA_FOR_THIS_MOBILE_NODE = 153
+
+    #: MAG_NOT_AUTHORIZED_FOR_PROXY_REG [:rfc:`5213`]
+    MAG_NOT_AUTHORIZED_FOR_PROXY_REG = 154
+
+    #: NOT_AUTHORIZED_FOR_HOME_NETWORK_PREFIX [:rfc:`5213`]
+    NOT_AUTHORIZED_FOR_HOME_NETWORK_PREFIX = 155
+
+    #: TIMESTAMP_MISMATCH [:rfc:`5213`]
+    TIMESTAMP_MISMATCH = 156
+
+    #: TIMESTAMP_LOWER_THAN_PREV_ACCEPTED [:rfc:`5213`]
+    TIMESTAMP_LOWER_THAN_PREV_ACCEPTED = 157
+
+    #: MISSING_HOME_NETWORK_PREFIX_OPTION [:rfc:`5213`]
+    MISSING_HOME_NETWORK_PREFIX_OPTION = 158
+
+    #: BCE_PBU_PREFIX_SET_DO_NOT_MATCH [:rfc:`5213`]
+    BCE_PBU_PREFIX_SET_DO_NOT_MATCH = 159
+
+    #: MISSING_MN_IDENTIFIER_OPTION [:rfc:`5213`]
+    MISSING_MN_IDENTIFIER_OPTION = 160
+
+    #: MISSING_HANDOFF_INDICATOR_OPTION [:rfc:`5213`]
+    MISSING_HANDOFF_INDICATOR_OPTION = 161
+
+    #: MISSING_ACCESS_TECH_TYPE_OPTION [:rfc:`5213`]
+    MISSING_ACCESS_TECH_TYPE_OPTION = 162
+
+    #: GRE_KEY_OPTION_REQUIRED [:rfc:`5845`]
+    GRE_KEY_OPTION_REQUIRED = 163
+
+    #: MCOA MALFORMED [:rfc:`5648`]
+    MCOA_MALFORMED = 164
+
+    #: MCOA NON-MCOA BINDING EXISTS [:rfc:`5648`]
+    MCOA_NON_MCOA_BINDING_EXISTS = 165
+
+    #: MCOA PROHIBITED [:rfc:`5648`]
+    MCOA_PROHIBITED = 166
+
+    #: MCOA UNKNOWN COA [:rfc:`5648`]
+    MCOA_UNKNOWN_COA = 167
+
+    #: MCOA BULK REGISTRATION PROHIBITED [:rfc:`5648`]
+    MCOA_BULK_REGISTRATION_PROHIBITED = 168
+
+    #: MCOA SIMULTANEOUS HOME AND FOREIGN PROHIBITED [:rfc:`5648`]
+    MCOA_SIMULTANEOUS_HOME_AND_FOREIGN_PROHIBITED = 169
+
+    #: NOT_AUTHORIZED_FOR_IPV4_MOBILITY_SERVICE [:rfc:`5844`]
+    NOT_AUTHORIZED_FOR_IPV4_MOBILITY_SERVICE = 170
+
+    #: NOT_AUTHORIZED_FOR_IPV4_HOME_ADDRESS [:rfc:`5844`]
+    NOT_AUTHORIZED_FOR_IPV4_HOME_ADDRESS = 171
+
+    #: NOT_AUTHORIZED_FOR_IPV6_MOBILITY_SERVICE [:rfc:`5844`]
+    NOT_AUTHORIZED_FOR_IPV6_MOBILITY_SERVICE = 172
+
+    #: MULTIPLE_IPV4_HOME_ADDRESS_ASSIGNMENT_NOT_SUPPORTED [:rfc:`5844`]
+    MULTIPLE_IPV4_HOME_ADDRESS_ASSIGNMENT_NOT_SUPPORTED = 173
+
+    #: Invalid Care-of Address [:rfc:`6275`]
+    Invalid_Care_of_Address = 174
+
+    #: INVALID_MOBILE_NODE_GROUP_IDENTIFIER [:rfc:`6602`]
+    INVALID_MOBILE_NODE_GROUP_IDENTIFIER = 175
+
+    #: REINIT_SA_WITH_HAC [:rfc:`6618`]
+    REINIT_SA_WITH_HAC = 176
+
+    #: NOT_AUTHORIZED_FOR_DELEGATED_MNP [:rfc:`7148`]
+    NOT_AUTHORIZED_FOR_DELEGATED_MNP = 177
+
+    #: REQUESTED_DMNP_IN_USE [:rfc:`7148`]
+    REQUESTED_DMNP_IN_USE = 178
+
+    #: CANNOT_MEET_QOS_SERVICE_REQUEST [:rfc:`7222`]
+    CANNOT_MEET_QOS_SERVICE_REQUEST = 179
+
+    #: CANNOT_SUPPORT_MULTIPATH_BINDING [:rfc:`8278`]
+    CANNOT_SUPPORT_MULTIPATH_BINDING = 180
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'StatusCode':
+        """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 StatusCode(key)
+        if key not in StatusCode._member_map_:  # pylint: disable=no-member
+            return extend_enum(StatusCode, key, default)
+        return StatusCode[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'StatusCode':
+        """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 <= 127:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        #: Unspecified in the IANA registry
+        return extend_enum(cls, 'Unassigned_%d' % value, value)

pcapkit/const/mh/traffic_selector.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Traffic Selector Format
+=============================
+
+.. module:: pcapkit.const.mh.traffic_selector
+
+This module contains the constant enumeration for **Traffic Selector Format**,
+which is automatically generated from :class:`pcapkit.vendor.mh.traffic_selector.TrafficSelector`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['TrafficSelector']
+
+
+class TrafficSelector(IntEnum):
+    """[TrafficSelector] Traffic Selector Format"""
+
+    #: Reserved [:rfc:`6089`]
+    Reserved_0 = 0
+
+    #: IPv4 Binary Traffic Selector [:rfc:`6088`]
+    IPv4_Binary_Traffic_Selector = 1
+
+    #: IPv6 Binary Traffic Selector [:rfc:`6088`]
+    IPv6_Binary_Traffic_Selector = 2
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'TrafficSelector':
+        """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 TrafficSelector(key)
+        if key not in TrafficSelector._member_map_:  # pylint: disable=no-member
+            return extend_enum(TrafficSelector, key, default)
+        return TrafficSelector[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'TrafficSelector':
+        """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 <= 250:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 251 <= value <= 255:
+            #: Reserved for Experimental Use [:rfc:`6089`]
+            return extend_enum(cls, 'Reserved_for_Experimental_Use_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/upa_status.py

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Update Notification Acknowledgement Status Registry
+=========================================================
+
+.. module:: pcapkit.const.mh.upa_status
+
+This module contains the constant enumeration for **Update Notification Acknowledgement Status Registry**,
+which is automatically generated from :class:`pcapkit.vendor.mh.upa_status.UpdateNotificationACKStatus`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['UpdateNotificationACKStatus']
+
+
+class UpdateNotificationACKStatus(IntEnum):
+    """[UpdateNotificationACKStatus] Update Notification Acknowledgement Status Registry"""
+
+    #: SUCCESS [:rfc:`7077`]
+    SUCCESS = 0
+
+    #: FAILED-TO-UPDATE-SESSION-PARAMETERS [:rfc:`7077`]
+    FAILED_TO_UPDATE_SESSION_PARAMETERS = 128
+
+    #: MISSING-VENDOR-SPECIFIC-OPTION [:rfc:`7077`]
+    MISSING_VENDOR_SPECIFIC_OPTION = 129
+
+    #: CANNOT_MEET_QOS_SERVICE_REQUEST [:rfc:`7222`]
+    CANNOT_MEET_QOS_SERVICE_REQUEST = 130
+
+    #: Reason unspecified. [:rfc:`7864`]
+    Reason_unspecified = 131
+
+    #: MN not attached. [:rfc:`7864`]
+    MN_not_attached = 132
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'UpdateNotificationACKStatus':
+        """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 UpdateNotificationACKStatus(key)
+        if key not in UpdateNotificationACKStatus._member_map_:  # pylint: disable=no-member
+            return extend_enum(UpdateNotificationACKStatus, key, default)
+        return UpdateNotificationACKStatus[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'UpdateNotificationACKStatus':
+        """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/upn_reason.py

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Update Notification Reasons Registry
+==========================================
+
+.. module:: pcapkit.const.mh.upn_reason
+
+This module contains the constant enumeration for **Update Notification Reasons Registry**,
+which is automatically generated from :class:`pcapkit.vendor.mh.upn_reason.UpdateNotificationReason`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['UpdateNotificationReason']
+
+
+class UpdateNotificationReason(IntEnum):
+    """[UpdateNotificationReason] Update Notification Reasons Registry"""
+
+    #: Reserved [:rfc:`7077`]
+    Reserved_0 = 0
+
+    #: FORCE-REREGISTRATION [:rfc:`7077`]
+    FORCE_REREGISTRATION = 1
+
+    #: UPDATE-SESSION-PARAMETERS [:rfc:`7077`]
+    UPDATE_SESSION_PARAMETERS = 2
+
+    #: VENDOR-SPECIFIC-REASON [:rfc:`7077`]
+    VENDOR_SPECIFIC_REASON = 3
+
+    #: ANI-PARAMS-REQUESTED [:rfc:`7077`]
+    ANI_PARAMS_REQUESTED = 4
+
+    #: QOS_SERVICE_REQUEST [:rfc:`7222`]
+    QOS_SERVICE_REQUEST = 5
+
+    #: PGW-TRIGGERED-PCSCF-RESTORATION-PCO [3GPP TS 29.275][Kimmo Kymalainen]
+    PGW_TRIGGERED_PCSCF_RESTORATION_PCO = 6
+
+    #: PGW-TRIGGERED-PCSCF-RESTORATION-DHCP [3GPP TS 29.275][Kimmo Kymalainen]
+    PGW_TRIGGERED_PCSCF_RESTORATION_DHCP = 7
+
+    #: FLOW-MOBILITY [:rfc:`7864`]
+    FLOW_MOBILITY = 8
+
+    #: Reserved [:rfc:`7077`]
+    Reserved_255 = 255
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'UpdateNotificationReason':
+        """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 UpdateNotificationReason(key)
+        if key not in UpdateNotificationReason._member_map_:  # pylint: disable=no-member
+            return extend_enum(UpdateNotificationReason, key, default)
+        return UpdateNotificationReason[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'UpdateNotificationReason':
+        """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 <= 254:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/ospf/__init__.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.link.ospf.OSPF` Constant Enumerations
+======================================================================
+
+.. module:: pcapkit.const.ospf
+
+This module contains all constant enumerations of
+:class:`~pcapkit.protocols.link.ospf.OSPF` implementations. Available
+enumerations include:
+
+.. list-table::
+
+   * - :class:`OSPF_Authentication <pcapkit.const.ospf.authentication.Authentication>`
+     - Authentication Codes [*]_
+   * - :class:`OSPF_Packet <pcapkit.const.ospf.packet.Packet>`
+     - OSPF Packet Types [*]_
+
+.. [*] https://www.iana.org/assignments/ospf-authentication-codes/ospf-authentication-codes.xhtml#authentication-codes
+.. [*] https://www.iana.org/assignments/ospfv2-parameters/ospfv2-parameters.xhtml#ospfv2-parameters-3
+
+"""
+
+from pcapkit.const.ospf.authentication import Authentication as OSPF_Authentication
+from pcapkit.const.ospf.packet import Packet as OSPF_Packet
+
+__all__ = ['OSPF_Authentication', 'OSPF_Packet']

pcapkit/const/ospf/authentication.py

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Authentication Types
+==========================
+
+.. module:: pcapkit.const.ospf.authentication
+
+This module contains the constant enumeration for **Authentication Types**,
+which is automatically generated from :class:`pcapkit.vendor.ospf.authentication.Authentication`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['Authentication']
+
+
+class Authentication(IntEnum):
+    """[Authentication] Authentication Types"""
+
+    #: No Authentication [:rfc:`1583`]
+    No_Authentication = 0
+
+    #: Simple Password Authentication [:rfc:`1583`]
+    Simple_Password_Authentication = 1
+
+    #: Cryptographic authentication [:rfc:`2328`][:rfc:`5709`]
+    Cryptographic_authentication = 2
+
+    #: Cryptographic Authentication with Extended Sequence Numbers [:rfc:`7474`]
+    Cryptographic_Authentication_with_Extended_Sequence_Numbers = 3
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'Authentication':
+        """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 Authentication(key)
+        if key not in Authentication._member_map_:  # pylint: disable=no-member
+            return extend_enum(Authentication, key, default)
+        return Authentication[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'Authentication':
+        """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 4 <= value <= 255:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 256 <= value <= 65535:
+            #: Deprecated [:rfc:`6549`]
+            return extend_enum(cls, 'Deprecated_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/ospf/packet.py

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""OSPF Packet Types
+=======================
+
+.. module:: pcapkit.const.ospf.packet
+
+This module contains the constant enumeration for **OSPF Packet Types**,
+which is automatically generated from :class:`pcapkit.vendor.ospf.packet.Packet`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['Packet']
+
+
+class Packet(IntEnum):
+    """[Packet] OSPF Packet Types"""
+
+    #: Reserved
+    Reserved_0 = 0
+
+    #: Hello [:rfc:`2328`]
+    Hello = 1
+
+    #: Database Description [:rfc:`2328`]
+    Database_Description = 2
+
+    #: Link State Request [:rfc:`2328`]
+    Link_State_Request = 3
+
+    #: Link State Update [:rfc:`2328`]
+    Link_State_Update = 4
+
+    #: Link State Ack [:rfc:`2328`]
+    Link_State_Ack = 5
+
+    @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 <= 65535):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        if 6 <= value <= 127:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 128 <= value <= 255:
+            #: Reserved
+            return extend_enum(cls, 'Reserved_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/pcapng/__init__.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.misc.pcapng.PCAPNG` Constant Enumerations
+==========================================================================
+
+.. module:: pcapkit.const.pcapng
+
+This module contains all constant enumerations of
+:class:`~pcapkit.protocols.misc.pcapng.PCAPNG` implementations. Available
+enumerations include:
+
+.. list-table::
+
+   * - :class:`PCAPNG_BlockType <pcapkit.const.pcapng.block_type.BlockType>`
+     - Block Types [*]_
+   * - :class:`PCAPNG_OptionType <pcapkit.const.pcapng.option_type.OptionType>`
+     - Option Types [*]_
+   * - :class:`PCAPNG_HashAlgorithm <pcapkit.const.pcapng.hash_algorithm.HashAlgorithm>`
+     - Hash Algorithms [*]_
+   * - :class:`PCAPNG_VerdictType <pcapkit.const.pcapng.verdict_type.VerdictType>`
+     - Verdict Types [*]_
+   * - :class:`PCAPNG_RecordType <pcapkit.const.pcapng.record_type.RecordType>`
+     - Record Types [*]_
+   * - :class:`PCAPNG_SecretsType <pcapkit.const.pcapng.secrets_type.SecretsType>`
+     - Secrets Types [*]_
+   * - :class:`PCAPNG_FilterType <pcapkit.const.pcapng.filter_type.FilterType>`
+     - Filter Types [*]_
+
+.. [*] https://www.ietf.org/staging/draft-tuexen-opsawg-pcapng-02.html#name-standardized-block-type-cod
+.. [*] https://www.ietf.org/staging/draft-tuexen-opsawg-pcapng-02.html#name-options
+.. [*] https://www.ietf.org/staging/draft-tuexen-opsawg-pcapng-02.html#name-enhanced-packet-block-flags
+.. [*] https://www.ietf.org/staging/draft-tuexen-opsawg-pcapng-02.html#name-enhanced-packet-block
+.. [*] https://www.ietf.org/staging/draft-tuexen-opsawg-pcapng-02.html#name-name-resolution-block
+.. [*] https://www.ietf.org/staging/draft-tuexen-opsawg-pcapng-02.html#name-decryption-secrets-block
+.. [*] https://www.ietf.org/staging/draft-tuexen-opsawg-pcapng-02.html#name-interface-description-block
+
+"""
+
+from pcapkit.const.pcapng.block_type import BlockType as PCAPNG_BlockType
+from pcapkit.const.pcapng.filter_type import FilterType as PCAPNG_FilterType
+from pcapkit.const.pcapng.hash_algorithm import HashAlgorithm as PCAPNG_HashAlgorithm
+from pcapkit.const.pcapng.option_type import OptionType as PCAPNG_OptionType
+from pcapkit.const.pcapng.record_type import RecordType as PCAPNG_RecordType
+from pcapkit.const.pcapng.secrets_type import SecretsType as PCAPNG_SecretsType
+from pcapkit.const.pcapng.verdict_type import VerdictType as PCAPNG_VerdictType
+
+___all__ = [
+    'PCAPNG_BlockType', 'PCAPNG_OptionType', 'PCAPNG_HashAlgorithm',
+    'PCAPNG_VerdictType', 'PCAPNG_RecordType', 'PCAPNG_SecretsType',
+    'PCAPNG_FilterType',
+]