pypcapkit 1.3.5.post6__cp313-none-any.whl

pcapkit/const/http/setting.py

@@ -0,0 +1,96 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""HTTP/2 Settings
+=====================
+
+.. module:: pcapkit.const.http.setting
+
+This module contains the constant enumeration for **HTTP/2 Settings**,
+which is automatically generated from :class:`pcapkit.vendor.http.setting.Setting`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['Setting']
+
+
+class Setting(IntEnum):
+    """[Setting] HTTP/2 Settings"""
+
+    #: ``Reserved`` [:rfc:`9113`]
+    Reserved_0x0000 = 0x0000
+
+    #: ``HEADER_TABLE_SIZE`` [:rfc:`9113#section-6.5.2`] (Initial Value: 4096)
+    HEADER_TABLE_SIZE = 0x0001
+
+    #: ``ENABLE_PUSH`` [:rfc:`9113#section-6.5.2`] (Initial Value: 1)
+    ENABLE_PUSH = 0x0002
+
+    #: ``MAX_CONCURRENT_STREAMS`` [:rfc:`9113#section-6.5.2`] (Initial Value:
+    #: infinite)
+    MAX_CONCURRENT_STREAMS = 0x0003
+
+    #: ``INITIAL_WINDOW_SIZE`` [:rfc:`9113#section-6.5.2`] (Initial Value: 65535)
+    INITIAL_WINDOW_SIZE = 0x0004
+
+    #: ``MAX_FRAME_SIZE`` [:rfc:`9113#section-6.5.2`] (Initial Value: 16384)
+    MAX_FRAME_SIZE = 0x0005
+
+    #: ``MAX_HEADER_LIST_SIZE`` [:rfc:`9113#section-6.5.2`] (Initial Value:
+    #: infinite)
+    MAX_HEADER_LIST_SIZE = 0x0006
+
+    #: ``Unassigned``
+    Unassigned_0x0007 = 0x0007
+
+    #: ``SETTINGS_ENABLE_CONNECT_PROTOCOL`` [:rfc:`8441`] (Initial Value: 0)
+    SETTINGS_ENABLE_CONNECT_PROTOCOL = 0x0008
+
+    #: ``SETTINGS_NO_RFC7540_PRIORITIES`` [:rfc:`9218`] (Initial Value: 0)
+    SETTINGS_NO_RFC7540_PRIORITIES = 0x0009
+
+    #: ``TLS_RENEG_PERMITTED`` [MS-HTTP2E][Gabriel Montenegro] (Initial Value:
+    #: 0x00)
+    TLS_RENEG_PERMITTED = 0x0010
+
+    #: ``SETTINGS_ENABLE_METADATA`` [draft-beky-httpbis-metadata-02] (Initial
+    #: Value: 0)
+    SETTINGS_ENABLE_METADATA = 0x4D44
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'Setting':
+        """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 Setting(key)
+        if key not in Setting._member_map_:  # pylint: disable=no-member
+            return extend_enum(Setting, key, default)
+        return Setting[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'Setting':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0x0000 <= value <= 0xFFFF):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        if 0x000A <= value <= 0x000F:
+            #: ``Unassigned``
+            return extend_enum(cls, 'Unassigned_0x%s' % hex(value)[2:].upper().zfill(4), value)
+        if 0x0011 <= value <= 0x4D43:
+            #: ``Unassigned``
+            return extend_enum(cls, 'Unassigned_0x%s' % hex(value)[2:].upper().zfill(4), value)
+        if 0x4D45 <= value <= 0xFFFF:
+            #: ``Unassigned``
+            return extend_enum(cls, 'Unassigned_0x%s' % hex(value)[2:].upper().zfill(4), value)
+        return super()._missing_(value)

pcapkit/const/http/status_code.py

@@ -0,0 +1,298 @@
+# -*- coding: utf-8 -*-
+# mypy: disable-error-code=assignment
+# pylint: disable=line-too-long,consider-using-f-string
+"""HTTP Status Code
+======================
+
+.. module:: pcapkit.const.http.status_code
+
+This module contains the constant enumeration for **HTTP Status Code**,
+which is automatically generated from :class:`pcapkit.vendor.http.status_code.StatusCode`.
+
+"""
+
+from typing import TYPE_CHECKING
+
+from aenum import IntEnum, extend_enum
+
+if TYPE_CHECKING:
+    from typing import Type
+
+__all__ = ['StatusCode']
+
+
+class StatusCode(IntEnum):
+    """[StatusCode] HTTP Status Code"""
+
+    if TYPE_CHECKING:
+        #: Status message.
+        message: 'str'
+
+    def __new__(cls, value: 'int', message: 'str' = '(Unknown)') -> 'Type[StatusCode]':
+        obj = int.__new__(cls, value)
+        obj._value_ = value
+
+        obj.message = message
+
+        return obj
+
+    def __repr__(self) -> 'str':
+        return "<%s [%s]>" % (self.__class__.__name__, self._value_)
+
+    def __str__(self) -> 'str':
+        return "[%s] %s" % (self._value_, self.message)
+
+    #: Continue [:rfc:`9110#section-15.2.1`]
+    CODE_100 = 100, 'Continue'
+
+    #: Switching Protocols [:rfc:`9110#section-15.2.2`]
+    CODE_101 = 101, 'Switching Protocols'
+
+    #: Processing [:rfc:`2518`]
+    CODE_102 = 102, 'Processing'
+
+    #: Early Hints [:rfc:`8297`]
+    CODE_103 = 103, 'Early Hints'
+
+    #: Upload Resumption Supported (TEMPORARY - registered 2024-11-13, expires
+    #: 2025-11-13) [draft-ietf-httpbis-resumable-upload-05]
+    CODE_104 = 104, 'Upload Resumption Supported'
+
+    #: OK [:rfc:`9110#section-15.3.1`]
+    CODE_200 = 200, 'OK'
+
+    #: Created [:rfc:`9110#section-15.3.2`]
+    CODE_201 = 201, 'Created'
+
+    #: Accepted [:rfc:`9110#section-15.3.3`]
+    CODE_202 = 202, 'Accepted'
+
+    #: Non-Authoritative Information [:rfc:`9110#section-15.3.4`]
+    CODE_203 = 203, 'Non-Authoritative Information'
+
+    #: No Content [:rfc:`9110#section-15.3.5`]
+    CODE_204 = 204, 'No Content'
+
+    #: Reset Content [:rfc:`9110#section-15.3.6`]
+    CODE_205 = 205, 'Reset Content'
+
+    #: Partial Content [:rfc:`9110#section-15.3.7`]
+    CODE_206 = 206, 'Partial Content'
+
+    #: Multi-Status [:rfc:`4918`]
+    CODE_207 = 207, 'Multi-Status'
+
+    #: Already Reported [:rfc:`5842`]
+    CODE_208 = 208, 'Already Reported'
+
+    #: IM Used [:rfc:`3229`]
+    CODE_226 = 226, 'IM Used'
+
+    #: Multiple Choices [:rfc:`9110#section-15.4.1`]
+    CODE_300 = 300, 'Multiple Choices'
+
+    #: Moved Permanently [:rfc:`9110#section-15.4.2`]
+    CODE_301 = 301, 'Moved Permanently'
+
+    #: Found [:rfc:`9110#section-15.4.3`]
+    CODE_302 = 302, 'Found'
+
+    #: See Other [:rfc:`9110#section-15.4.4`]
+    CODE_303 = 303, 'See Other'
+
+    #: Not Modified [:rfc:`9110#section-15.4.5`]
+    CODE_304 = 304, 'Not Modified'
+
+    #: Use Proxy [:rfc:`9110#section-15.4.6`]
+    CODE_305 = 305, 'Use Proxy'
+
+    #: (Unused) [:rfc:`9110#section-15.4.7`]
+    CODE_306 = 306, '(Unused)'
+
+    #: Temporary Redirect [:rfc:`9110#section-15.4.8`]
+    CODE_307 = 307, 'Temporary Redirect'
+
+    #: Permanent Redirect [:rfc:`9110#section-15.4.9`]
+    CODE_308 = 308, 'Permanent Redirect'
+
+    #: Bad Request [:rfc:`9110#section-15.5.1`]
+    CODE_400 = 400, 'Bad Request'
+
+    #: Unauthorized [:rfc:`9110#section-15.5.2`]
+    CODE_401 = 401, 'Unauthorized'
+
+    #: Payment Required [:rfc:`9110#section-15.5.3`]
+    CODE_402 = 402, 'Payment Required'
+
+    #: Forbidden [:rfc:`9110#section-15.5.4`]
+    CODE_403 = 403, 'Forbidden'
+
+    #: Not Found [:rfc:`9110#section-15.5.5`]
+    CODE_404 = 404, 'Not Found'
+
+    #: Method Not Allowed [:rfc:`9110#section-15.5.6`]
+    CODE_405 = 405, 'Method Not Allowed'
+
+    #: Not Acceptable [:rfc:`9110#section-15.5.7`]
+    CODE_406 = 406, 'Not Acceptable'
+
+    #: Proxy Authentication Required [:rfc:`9110#section-15.5.8`]
+    CODE_407 = 407, 'Proxy Authentication Required'
+
+    #: Request Timeout [:rfc:`9110#section-15.5.9`]
+    CODE_408 = 408, 'Request Timeout'
+
+    #: Conflict [:rfc:`9110#section-15.5.10`]
+    CODE_409 = 409, 'Conflict'
+
+    #: Gone [:rfc:`9110#section-15.5.11`]
+    CODE_410 = 410, 'Gone'
+
+    #: Length Required [:rfc:`9110#section-15.5.12`]
+    CODE_411 = 411, 'Length Required'
+
+    #: Precondition Failed [:rfc:`9110#section-15.5.13`]
+    CODE_412 = 412, 'Precondition Failed'
+
+    #: Content Too Large [:rfc:`9110#section-15.5.14`]
+    CODE_413 = 413, 'Content Too Large'
+
+    #: URI Too Long [:rfc:`9110#section-15.5.15`]
+    CODE_414 = 414, 'URI Too Long'
+
+    #: Unsupported Media Type [:rfc:`9110#section-15.5.16`]
+    CODE_415 = 415, 'Unsupported Media Type'
+
+    #: Range Not Satisfiable [:rfc:`9110#section-15.5.17`]
+    CODE_416 = 416, 'Range Not Satisfiable'
+
+    #: Expectation Failed [:rfc:`9110#section-15.5.18`]
+    CODE_417 = 417, 'Expectation Failed'
+
+    #: (Unused) [:rfc:`9110#section-15.5.19`]
+    CODE_418 = 418, '(Unused)'
+
+    #: Misdirected Request [:rfc:`9110#section-15.5.20`]
+    CODE_421 = 421, 'Misdirected Request'
+
+    #: Unprocessable Content [:rfc:`9110#section-15.5.21`]
+    CODE_422 = 422, 'Unprocessable Content'
+
+    #: Locked [:rfc:`4918`]
+    CODE_423 = 423, 'Locked'
+
+    #: Failed Dependency [:rfc:`4918`]
+    CODE_424 = 424, 'Failed Dependency'
+
+    #: Too Early [:rfc:`8470`]
+    CODE_425 = 425, 'Too Early'
+
+    #: Upgrade Required [:rfc:`9110#section-15.5.22`]
+    CODE_426 = 426, 'Upgrade Required'
+
+    #: Unassigned
+    CODE_427 = 427, 'Unassigned'
+
+    #: Precondition Required [:rfc:`6585`]
+    CODE_428 = 428, 'Precondition Required'
+
+    #: Too Many Requests [:rfc:`6585`]
+    CODE_429 = 429, 'Too Many Requests'
+
+    #: Unassigned
+    CODE_430 = 430, 'Unassigned'
+
+    #: Request Header Fields Too Large [:rfc:`6585`]
+    CODE_431 = 431, 'Request Header Fields Too Large'
+
+    #: Unavailable For Legal Reasons [:rfc:`7725`]
+    CODE_451 = 451, 'Unavailable For Legal Reasons'
+
+    #: Internal Server Error [:rfc:`9110#section-15.6.1`]
+    CODE_500 = 500, 'Internal Server Error'
+
+    #: Not Implemented [:rfc:`9110#section-15.6.2`]
+    CODE_501 = 501, 'Not Implemented'
+
+    #: Bad Gateway [:rfc:`9110#section-15.6.3`]
+    CODE_502 = 502, 'Bad Gateway'
+
+    #: Service Unavailable [:rfc:`9110#section-15.6.4`]
+    CODE_503 = 503, 'Service Unavailable'
+
+    #: Gateway Timeout [:rfc:`9110#section-15.6.5`]
+    CODE_504 = 504, 'Gateway Timeout'
+
+    #: HTTP Version Not Supported [:rfc:`9110#section-15.6.6`]
+    CODE_505 = 505, 'HTTP Version Not Supported'
+
+    #: Variant Also Negotiates [:rfc:`2295`]
+    CODE_506 = 506, 'Variant Also Negotiates'
+
+    #: Insufficient Storage [:rfc:`4918`]
+    CODE_507 = 507, 'Insufficient Storage'
+
+    #: Loop Detected [:rfc:`5842`]
+    CODE_508 = 508, 'Loop Detected'
+
+    #: Unassigned
+    CODE_509 = 509, 'Unassigned'
+
+    #: Not Extended (OBSOLETED) [:rfc:`2774`][Status change of HTTP experiments to
+    #: Historic]
+    CODE_510 = 510, 'Not Extended'
+
+    #: Network Authentication Required [:rfc:`6585`]
+    CODE_511 = 511, 'Network Authentication Required'
+
+    @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
+            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 100 <= value <= 599):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        if 105 <= value <= 199:
+            #: Unassigned
+            return extend_enum(cls, 'CODE_%d' % value, value, 'Unassigned')
+        if 209 <= value <= 225:
+            #: Unassigned
+            return extend_enum(cls, 'CODE_%d' % value, value, 'Unassigned')
+        if 227 <= value <= 299:
+            #: Unassigned
+            return extend_enum(cls, 'CODE_%d' % value, value, 'Unassigned')
+        if 309 <= value <= 399:
+            #: Unassigned
+            return extend_enum(cls, 'CODE_%d' % value, value, 'Unassigned')
+        if 419 <= value <= 420:
+            #: Unassigned
+            return extend_enum(cls, 'CODE_%d' % value, value, 'Unassigned')
+        if 432 <= value <= 450:
+            #: Unassigned
+            return extend_enum(cls, 'CODE_%d' % value, value, 'Unassigned')
+        if 452 <= value <= 499:
+            #: Unassigned
+            return extend_enum(cls, 'CODE_%d' % value, value, 'Unassigned')
+        if 512 <= value <= 599:
+            #: Unassigned
+            return extend_enum(cls, 'CODE_%d' % value, value, 'Unassigned')
+        return super()._missing_(value)

pcapkit/const/ipv4/__init__.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.internet.ipv4.IPv4` Constant Enumerations
+==========================================================================
+
+This module contains all constant enumerations of
+:class:`~pcapkit.protocols.internet.ipv4.IPv4` implementations. Available
+enumerations include:
+
+.. list-table::
+
+   * - :class:`IPv4_ClassificationLevel <pcapkit.const.ipv4.classification_level.ClassificationLevel>`
+     - Classification Level Encodings
+   * - :class:`IPv4_OptionClass <pcapkit.const.ipv4.option_class.OptionClass>`
+     - Option Classes
+   * - :class:`IPv4_OptionNumber <pcapkit.const.ipv4.option_number.OptionNumber>`
+     - IP Option Numbers [*]_
+   * - :class:`IPv4_ProtectionAuthority <pcapkit.const.ipv4.protection_authority.ProtectionAuthority>`
+     - Protection Authority Bit Assignments
+   * - :class:`IPv4_QSFunction <pcapkit.const.ipv4.qs_function.QSFunction>`
+     - QS Functions
+   * - :class:`IPv4_RouterAlert <pcapkit.const.ipv4.router_alert.RouterAlert>`
+     - IPv4 Router Alert Option Values [*]_
+   * - :class:`IPv4_ToSDelay <pcapkit.const.ipv4.tos_del.ToSDelay>`
+     - ToS (DS Field) Delay
+   * - :class:`IPv4_ToSECN <pcapkit.const.ipv4.tos_ecn.ToSECN>`
+     - ToS ECN Field
+   * - :class:`IPv4_ToSPrecedence <pcapkit.const.ipv4.tos_pre.TOSPrecedence>`
+     - ToS (DS Field) Precedence
+   * - :class:`IPv4_ToSReliability <pcapkit.const.ipv4.tos_rel.TOSReliability>`
+     - ToS (DS Field) Reliability
+   * - :class:`IPv4_ToSThroughput <pcapkit.const.ipv4.tos_thr.TOSThroughput>`
+     - ToS (DS Field) Throughput
+   * - :class:`IPv4_TSFlag <pcapkit.const.ipv4.ts_flag.TSFlag>`
+     - TS Flag
+
+.. [*] https://www.iana.org/assignments/ip-parameters/ip-parameters.xhtml#ip-parameters-1
+.. [*] https://www.iana.org/assignments/ip-parameters/ip-parameters.xhtml#ipv4-router-alert-option-values
+
+"""
+
+from pcapkit.const.ipv4.classification_level import ClassificationLevel as IPv4_ClassificationLevel
+from pcapkit.const.ipv4.option_class import OptionClass as IPv4_OptionClass
+from pcapkit.const.ipv4.option_number import OptionNumber as IPv4_OptionNumber
+from pcapkit.const.ipv4.protection_authority import ProtectionAuthority as IPv4_ProtectionAuthority
+from pcapkit.const.ipv4.qs_function import QSFunction as IPv4_QSFunction
+from pcapkit.const.ipv4.router_alert import RouterAlert as IPv4_RouterAlert
+from pcapkit.const.ipv4.tos_del import ToSDelay as IPv4_ToSDelay
+from pcapkit.const.ipv4.tos_ecn import ToSECN as IPv4_ToSECN
+from pcapkit.const.ipv4.tos_pre import ToSPrecedence as IPv4_ToSPrecedence
+from pcapkit.const.ipv4.tos_rel import ToSReliability as IPv4_ToSReliability
+from pcapkit.const.ipv4.tos_thr import ToSThroughput as IPv4_ToSThroughput
+from pcapkit.const.ipv4.ts_flag import TSFlag as IPv4_TSFlag
+
+__all__ = ['IPv4_ClassificationLevel', 'IPv4_OptionClass', 'IPv4_OptionNumber', 'IPv4_ProtectionAuthority',
+           'IPv4_QSFunction', 'IPv4_RouterAlert', 'IPv4_ToSDelay', 'IPv4_ToSECN', 'IPv4_ToSPrecedence',
+           'IPv4_ToSReliability', 'IPv4_ToSThroughput', 'IPv4_TSFlag']

pcapkit/const/ipv4/classification_level.py

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Classification Level Encodings
+====================================
+
+.. module:: pcapkit.const.ipv4.classification_level
+
+This module contains the constant enumeration for **Classification Level Encodings**,
+which is automatically generated from :class:`pcapkit.vendor.ipv4.classification_level.ClassificationLevel`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['ClassificationLevel']
+
+
+class ClassificationLevel(IntEnum):
+    """[ClassificationLevel] Classification Level Encodings"""
+
+    Reserved_4 = 0b00000001
+
+    Top_Secret = 0b00111101
+
+    Secret = 0b01011010
+
+    Confidential = 0b10010110
+
+    Reserved_3 = 0b01100110
+
+    Reserved_2 = 0b11001100
+
+    Unclassified = 0b10101011
+
+    Reserved_1 = 0b11110001
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'ClassificationLevel':
+        """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 ClassificationLevel(key)
+        if key not in ClassificationLevel._member_map_:  # pylint: disable=no-member
+            return extend_enum(ClassificationLevel, key, default)
+        return ClassificationLevel[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'ClassificationLevel':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0b00000000 <= value <= 0b11111111):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        temp = bin(value)[2:].upper().zfill(8)
+        return extend_enum(cls, 'Unassigned_0b%s' % (temp[:4]+'_'+temp[4:]), value)

pcapkit/const/ipv4/option_class.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Option Classes
+====================
+
+.. module:: pcapkit.const.ipv4.option_class
+
+This module contains the constant enumeration for **Option Classes**,
+which is automatically generated from :class:`pcapkit.vendor.ipv4.option_class.OptionClass`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['OptionClass']
+
+
+class OptionClass(IntEnum):
+    """[OptionClass] Option Classes"""
+
+    control = 0
+
+    reserved_for_future_use_1 = 1
+
+    debugging_and_measurement = 2
+
+    reserved_for_future_use_3 = 3
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'OptionClass':
+        """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 OptionClass(key)
+        if key not in OptionClass._member_map_:  # pylint: disable=no-member
+            return extend_enum(OptionClass, key, default)
+        return OptionClass[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'OptionClass':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 3):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return extend_enum(cls, 'Unassigned_%d' % value, value)