pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/const/tcp/mp_tcp_option.py

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Multipath TCP options
+===========================
+
+.. module:: pcapkit.const.tcp.mp_tcp_option
+
+This module contains the constant enumeration for **Multipath TCP options**,
+which is automatically generated from :class:`pcapkit.vendor.tcp.mp_tcp_option.MPTCPOption`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['MPTCPOption']
+
+
+class MPTCPOption(IntEnum):
+    """[MPTCPOption] Multipath TCP options [:rfc:`6824`]"""
+
+    #: Multipath Capable [:rfc:`8684#3.1`]
+    MP_CAPABLE = 0x0
+
+    #: Join Connection [:rfc:`8684#3.2`]
+    MP_JOIN = 0x1
+
+    #: Data Sequence Signal (Data ACK and Data Sequence Mapping) [:rfc:`8684#3.3`]
+    DSS = 0x2
+
+    #: Add Address [:rfc:`8684#3.4.1`]
+    ADD_ADDR = 0x3
+
+    #: Remove Address [:rfc:`8684#3.4.2`]
+    REMOVE_ADDR = 0x4
+
+    #: Change Subflow Priority [:rfc:`8684#3.3.8`]
+    MP_PRIO = 0x5
+
+    #: Fallback [:rfc:`8684#3.7`]
+    MP_FAIL = 0x6
+
+    #: Fast Close [:rfc:`8684#3.5`]
+    MP_FASTCLOSE = 0x7
+
+    #: Subflow Reset [:rfc:`8684#3.6`]
+    MP_TCPRST = 0x8
+
+    #: [:rfc:`8684`]
+    Reserved_for_Private_Use = 0xf
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'MPTCPOption':
+        """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 MPTCPOption(key)
+        if key not in MPTCPOption._member_map_:  # pylint: disable=no-member
+            return extend_enum(MPTCPOption, key, default)
+        return MPTCPOption[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'MPTCPOption':
+        """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 0x9 <= value <= 0xe:
+            #:
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/tcp/option.py

@@ -0,0 +1,198 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""TCP Option Kind Numbers
+=============================
+
+.. module:: pcapkit.const.tcp.option
+
+This module contains the constant enumeration for **TCP Option Kind Numbers**,
+which is automatically generated from :class:`pcapkit.vendor.tcp.option.Option`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['Option']
+
+
+class Option(IntEnum):
+    """[Option] TCP Option Kind Numbers"""
+
+    #: End of Option List [:rfc:`9293`]
+    End_of_Option_List = 0
+
+    #: No-Operation [:rfc:`9293`]
+    No_Operation = 1
+
+    #: Maximum Segment Size [:rfc:`9293`]
+    Maximum_Segment_Size = 2
+
+    #: Window Scale [:rfc:`7323`]
+    Window_Scale = 3
+
+    #: SACK Permitted [:rfc:`2018`]
+    SACK_Permitted = 4
+
+    #: SACK [:rfc:`2018`]
+    SACK = 5
+
+    #: Echo (obsoleted by option 8) [:rfc:`1072`][:rfc:`6247`]
+    Echo = 6
+
+    #: Echo Reply (obsoleted by option 8) [:rfc:`1072`][:rfc:`6247`]
+    Echo_Reply = 7
+
+    #: Timestamps [:rfc:`7323`]
+    Timestamps = 8
+
+    #: Partial Order Connection Permitted (obsolete) [:rfc:`1693`][:rfc:`6247`]
+    Partial_Order_Connection_Permitted = 9
+
+    #: Partial Order Service Profile (obsolete) [:rfc:`1693`][:rfc:`6247`]
+    Partial_Order_Service_Profile = 10
+
+    #: CC (obsolete) [:rfc:`1644`][:rfc:`6247`]
+    CC = 11
+
+    #: CC.NEW (obsolete) [:rfc:`1644`][:rfc:`6247`]
+    CC_NEW = 12
+
+    #: CC.ECHO (obsolete) [:rfc:`1644`][:rfc:`6247`]
+    CC_ECHO = 13
+
+    #: TCP Alternate Checksum Request (obsolete) [:rfc:`1146`][:rfc:`6247`]
+    TCP_Alternate_Checksum_Request = 14
+
+    #: TCP Alternate Checksum Data (obsolete) [:rfc:`1146`][:rfc:`6247`]
+    TCP_Alternate_Checksum_Data = 15
+
+    #: Skeeter [Stev Knowles]
+    Skeeter = 16
+
+    #: Bubba [Stev Knowles]
+    Bubba = 17
+
+    #: Trailer Checksum Option [Subbu Subramaniam][Monroe Bridges]
+    Trailer_Checksum_Option = 18
+
+    #: MD5 Signature Option (obsoleted by option 29) [:rfc:`2385`]
+    MD5_Signature_Option = 19
+
+    #: SCPS Capabilities [Keith Scott]
+    SCPS_Capabilities = 20
+
+    #: Selective Negative Acknowledgements [Keith Scott]
+    Selective_Negative_Acknowledgements = 21
+
+    #: Record Boundaries [Keith Scott]
+    Record_Boundaries = 22
+
+    #: Corruption experienced [Keith Scott]
+    Corruption_experienced = 23
+
+    #: SNAP [Vladimir Sukonnik]
+    SNAP = 24
+
+    #: Unassigned (released 2000-12-18)
+    Unassigned_25 = 25
+
+    #: TCP Compression Filter [Steve Bellovin]
+    TCP_Compression_Filter = 26
+
+    #: Quick-Start Response [:rfc:`4782`]
+    Quick_Start_Response = 27
+
+    #: User Timeout Option (also, other known unauthorized use)  [:rfc:`5482`]
+    User_Timeout_Option = 28
+
+    #: TCP Authentication Option (TCP-AO) [:rfc:`5925`]
+    TCP_Authentication_Option = 29
+
+    #: Multipath TCP (MPTCP) [:rfc:`8684`]
+    Multipath_TCP = 30
+
+    #: Reserved (known unauthorized use without proper IANA assignment)
+    Reserved_31 = 31
+
+    #: Reserved (known unauthorized use without proper IANA assignment)
+    Reserved_32 = 32
+
+    #: Reserved (known unauthorized use without proper IANA assignment)
+    Reserved_33 = 33
+
+    #: TCP Fast Open Cookie [:rfc:`7413`]
+    TCP_Fast_Open_Cookie = 34
+
+    #: Encryption Negotiation (TCP-ENO) [:rfc:`8547`]
+    Encryption_Negotiation = 69
+
+    #: Reserved (known unauthorized use without proper IANA assignment)
+    Reserved_70 = 70
+
+    #: Reserved (known unauthorized use without proper IANA assignment)
+    Reserved_76 = 76
+
+    #: Reserved (known unauthorized use without proper IANA assignment)
+    Reserved_77 = 77
+
+    #: Reserved (known unauthorized use without proper IANA assignment)
+    Reserved_78 = 78
+
+    #: Accurate ECN Order 0 (AccECN0) (TEMPORARY - registered 2022-08-03, extension
+    #: registered 2024-07-11, expires 2025-08-03) [draft-ietf-tcpm-accurate-ecn-20]
+    Accurate_ECN_Order_0 = 172
+
+    #: Reserved
+    Reserved_173 = 173
+
+    #: Accurate ECN Order 1 (AccECN1) (TEMPORARY - registered 2022-08-03, extension
+    #: registered 2024-07-11, expires 2025-08-03) [draft-ietf-tcpm-accurate-ecn-20]
+    Accurate_ECN_Order_1 = 174
+
+    #: RFC3692-style Experiment 1 (also improperly used for shipping
+    #: products)  [:rfc:`4727`]
+    RFC3692_style_Experiment_1 = 253
+
+    #: RFC3692-style Experiment 2 (also improperly used for shipping
+    #: products)  [:rfc:`4727`]
+    RFC3692_style_Experiment_2 = 254
+
+    @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__))
+        if 35 <= value <= 68:
+            #: Reserved
+            return extend_enum(cls, 'Reserved_%d' % value, value)
+        if 71 <= value <= 75:
+            #: Reserved
+            return extend_enum(cls, 'Reserved_%d' % value, value)
+        if 79 <= value <= 171:
+            #: Reserved
+            return extend_enum(cls, 'Reserved_%d' % value, value)
+        if 175 <= value <= 252:
+            #: Reserved
+            return extend_enum(cls, 'Reserved_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/vlan/__init__.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.link.vlan.VLAN` Constant Enumerations
+======================================================================
+
+.. module:: pcapkit.const.vlan
+
+This module contains all constant enumerations of
+:class:`~pcapkit.protocols.link.vlan.VLAN` implementations. Available
+enumerations include:
+
+.. list-table::
+
+   * - :const:`VLAN_PriorityLevel <pcapkit.const.vlan.priority_level.PriorityLevel>`
+     - Priority Levels [*]_
+
+.. [*] https://en.wikipedia.org/wiki/IEEE_P802.1p#Priority_levels
+
+"""
+
+from pcapkit.const.vlan.priority_level import PriorityLevel as VLAN_PriorityLevel
+
+__all__ = ['VLAN_PriorityLevel']

pcapkit/const/vlan/priority_level.py

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Priority levels defined in IEEE 802.1p
+============================================
+
+.. module:: pcapkit.const.vlan.priority_level
+
+This module contains the constant enumeration for **Priority levels defined in IEEE 802.1p**,
+which is automatically generated from :class:`pcapkit.vendor.vlan.priority_level.PriorityLevel`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['PriorityLevel']
+
+
+class PriorityLevel(IntEnum):
+    """[PriorityLevel] Priority levels defined in IEEE 802.1p"""
+
+    #: Background (lowest)
+    BK = 0b001
+
+    #: Best effort (default)
+    BE = 0b000
+
+    #: Excellent effort
+    EE = 0b010
+
+    #: Critical applications
+    CA = 0b011
+
+    #: Video, < 100 ms latency and jitter
+    VI = 0b100
+
+    #: Voice, < 10 ms latency and jitter
+    VO = 0b101
+
+    #: Internetwork control
+    IC = 0b110
+
+    #: Network control (highest)
+    NC = 0b111
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'PriorityLevel':
+        """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 PriorityLevel(key)
+        if key not in PriorityLevel._member_map_:  # pylint: disable=no-member
+            return extend_enum(PriorityLevel, key, default)
+        return PriorityLevel[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'PriorityLevel':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0b000 <= value <= 0b111):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return extend_enum(cls, 'Unassigned [0b%s]' % bin(value)[2:].zfill(3), value)

pcapkit/corekit/__init__.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import,unused-wildcard-import
+"""Core Utilities
+====================
+
+.. module:: pcapkit.corekit
+
+:mod:`pcapkit.corekit` is the collection of core utilities
+for :mod:`pcapkit` implementation, including :obj:`dict` like
+class :class:`~pcapkit.corekit.infoclass.Info`,
+:obj:`tuple` like class :class:`~pcapkit.corekit.version.VersionInfo`,
+protocol collection class :class:`~pcapkit.corekit.protochain.ProtoChain`,
+and :class:`~pcapkit.corekit.multidict.MultiDict` family inspired from
+:mod:`Werkzeug` for multientry :obj:`dict` data mapping, the
+:class:`~pcapkit.corekit.fields.field.Field` family for data parsing,
+etc.
+
+"""
+from pcapkit.corekit.io import SeekableReader
+from pcapkit.corekit.fields import *
+from pcapkit.corekit.infoclass import Info, info_final
+from pcapkit.corekit.module import ModuleDescriptor
+from pcapkit.corekit.multidict import MultiDict, OrderedMultiDict
+from pcapkit.corekit.protochain import ProtoChain
+from pcapkit.corekit.version import VersionInfo
+
+__all__ = [
+    'Info', 'info_final',
+
+    'ProtoChain',
+
+    'VersionInfo',
+
+    'MultiDict', 'OrderedMultiDict',
+
+    'NumberField',
+    'Int32Field', 'UInt32Field',
+    'Int16Field', 'UInt16Field',
+    'Int64Field', 'UInt64Field',
+    'Int8Field', 'UInt8Field',
+    'EnumField',
+
+    'BytesField',
+    'StringField',
+    'BitField',
+    'PaddingField',
+
+    'ConditionalField', 'PayloadField', 'SchemaField',
+    'ForwardMatchField', 'NoValueField',
+
+    'ListField', 'OptionField',
+
+    'IPv4AddressField', 'IPv6AddressField',
+    'IPv4InterfaceField', 'IPv6InterfaceField',
+
+    'SeekableReader',
+
+    'ModuleDescriptor',
+]

pcapkit/corekit/fields/__init__.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import,unused-wildcard-import,fixme
+"""Protocol Fields
+=====================
+
+.. module:: pcapkit.corekit.fields
+
+:mod:`pcapkit.corekit.fields` is collection of protocol fields,
+descriptive of the structure of protocol headers.
+
+"""
+
+from pcapkit.corekit.fields.field import Field
+
+from pcapkit.corekit.fields.collections import ListField, OptionField
+from pcapkit.corekit.fields.ipaddress import (IPv4AddressField, IPv4InterfaceField,
+                                              IPv6AddressField, IPv6InterfaceField)
+from pcapkit.corekit.fields.misc import (ConditionalField, ForwardMatchField, NoValueField,
+                                         PayloadField, SchemaField)
+from pcapkit.corekit.fields.numbers import (EnumField, Int8Field, Int16Field, Int32Field,
+                                            Int64Field, NumberField, UInt8Field, UInt16Field,
+                                            UInt32Field, UInt64Field)
+from pcapkit.corekit.fields.strings import BitField, BytesField, PaddingField, StringField
+
+__all__ = [
+    'NumberField',
+    'Int32Field', 'UInt32Field',
+    'Int16Field', 'UInt16Field',
+    'Int64Field', 'UInt64Field',
+    'Int8Field', 'UInt8Field',
+    'EnumField',
+
+    'BytesField',
+    'StringField',
+    'BitField',
+    'PaddingField',
+
+    'ConditionalField', 'PayloadField', 'SchemaField',
+    'ForwardMatchField', 'NoValueField',
+
+    'ListField', 'OptionField',
+
+    'IPv4AddressField', 'IPv6AddressField',
+    'IPv4InterfaceField', 'IPv6InterfaceField',
+]