pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/vendor/ipv4/__init__.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.internet.ipv4.IPv4` Vendor Crawlers
+====================================================================
+
+.. module:: pcapkit.vendor.ipv4
+
+This module contains all vendor crawlers of
+:class:`~pcapkit.protocols.internet.ipv4.IPv4` implementations. Available
+crawlers include:
+
+.. list-table::
+
+   * - :class:`IPv4_ClassificationLevel <pcapkit.vendor.ipv4.classification_level.ClassificationLevel>`
+     - Classification Level Encodings
+   * - :class:`IPv4_OptionClass <pcapkit.vendor.ipv4.option_class.OptionClass>`
+     - Option Classes
+   * - :class:`IPv4_OptionNumber <pcapkit.vendor.ipv4.option_number.OptionNumber>`
+     - IP Option Numbers [*]_
+   * - :class:`IPv4_ProtectionAuthority <pcapkit.vendor.ipv4.protection_authority.ProtectionAuthority>`
+     - Protection Authority Bit Assignments
+   * - :class:`IPv4_QSFunction <pcapkit.vendor.ipv4.qs_function.QSFunction>`
+     - QS Functions
+   * - :class:`IPv4_RouterAlert <pcapkit.vendor.ipv4.router_alert.RouterAlert>`
+     - IPv4 Router Alert Option Values [*]_
+   * - :class:`IPv4_ToSDelay <pcapkit.vendor.ipv4.tos_del.ToSDelay>`
+     - ToS (DS Field) Delay
+   * - :class:`IPv4_ToSECN <pcapkit.vendor.ipv4.tos_ecn.ToSECN>`
+     - ToS ECN Field
+   * - :class:`IPv4_ToSPrecedence <pcapkit.vendor.ipv4.tos_pre.TOSPrecedence>`
+     - ToS (DS Field) Precedence
+   * - :class:`IPv4_ToSReliability <pcapkit.vendor.ipv4.tos_rel.TOSReliability>`
+     - ToS (DS Field) Reliability
+   * - :class:`IPv4_ToSThroughput <pcapkit.vendor.ipv4.tos_thr.TOSThroughput>`
+     - ToS (DS Field) Throughput
+
+.. [*] 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.vendor.ipv4.classification_level import ClassificationLevel as IPv4_ClassificationLevel
+from pcapkit.vendor.ipv4.option_class import OptionClass as IPv4_OptionClass
+from pcapkit.vendor.ipv4.option_number import OptionNumber as IPv4_OptionNumber
+from pcapkit.vendor.ipv4.protection_authority import ProtectionAuthority as IPv4_ProtectionAuthority
+from pcapkit.vendor.ipv4.qs_function import QSFunction as IPv4_QSFunction
+from pcapkit.vendor.ipv4.router_alert import RouterAlert as IPv4_RouterAlert
+from pcapkit.vendor.ipv4.tos_del import ToSDelay as IPv4_ToSDelay
+from pcapkit.vendor.ipv4.tos_ecn import ToSECN as IPv4_ToSECN
+from pcapkit.vendor.ipv4.tos_pre import ToSPrecedence as IPv4_ToSPrecedence
+from pcapkit.vendor.ipv4.tos_rel import ToSReliability as IPv4_ToSReliability
+from pcapkit.vendor.ipv4.tos_thr import ToSThroughput as IPv4_ToSThroughput
+from pcapkit.vendor.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/vendor/ipv4/classification_level.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+"""Classification Level Encodings
+====================================
+
+.. module:: pcapkit.vendor.ipv4.classification_level
+
+This module contains the vendor crawler for **Classification Level Encodings**,
+which is automatically generating :class:`pcapkit.const.ipv4.classification_level.ClassificationLevel`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['ClassificationLevel']
+
+#: Encoding registry.
+DATA = {
+    0b0000_0001: 'Reserved [4]',
+    0b0011_1101: 'Top Secret',
+    0b0101_1010: 'Secret',
+    0b1001_0110: 'Confidential',
+    0b0110_0110: 'Reserved [3]',
+    0b1100_1100: 'Reserved [2]',
+    0b1010_1011: 'Unclassified',
+    0b1111_0001: 'Reserved [1]',
+}  # type: dict[int, str]
+
+
+def binary(code: 'int') -> 'str':
+    """Convert code to binary form."""
+    return f'0b{bin(code)[2:].upper().zfill(8)}'
+
+
+class ClassificationLevel(Vendor):
+    """Classification Level Encodings"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0b00000000 <= value <= 0b11111111'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv4.classification_level.DATA`).
+
+        """
+        return DATA
+
+    def count(self, data: 'dict[int, str]') -> 'Counter[str]':  # type: ignore[override]
+        """Count field records.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Field recordings.
+
+        """
+        return collections.Counter(map(self.safe_name, data.values()))
+
+    def process(self, data: 'dict[int, str]') -> 'tuple[list[str], list[str]]':  # type: ignore[override]
+        """Process registry data.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        enum = []  # type: list[str]
+        miss = [
+            'temp = bin(value)[2:].upper().zfill(8)',
+            "return extend_enum(cls, 'Unassigned_0b%s' % (temp[:4]+'_'+temp[4:]), value)",
+        ]
+        for code, name in data.items():
+            bncd = binary(code)
+            renm = self.rename(name, bncd)
+            enum.append(f"{renm} = {bncd}".ljust(76))
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(ClassificationLevel())  # type: ignore[arg-type]

pcapkit/vendor/ipv4/option_class.py

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+"""Option Classes
+====================
+
+.. module:: pcapkit.vendor.ipv4.option_class
+
+This module contains the vendor crawler for **Option Classes**,
+which is automatically generating :class:`pcapkit.const.ipv4.option_class.OptionClass`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['OptionClass']
+
+#: Option class registry.
+DATA = {
+    0: 'control',
+    1: 'reserved for future use',
+    2: 'debugging and measurement',
+    3: 'reserved for future use',
+}  # type: dict[int, str]
+
+
+class OptionClass(Vendor):
+    """Option Classes"""
+
+    #: Value limit checker.s
+    FLAG = 'isinstance(value, int) and 0 <= value <= 3'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv4.option_class.DATA`).
+
+        """
+        return DATA
+
+    def count(self, data: 'dict[int, str]') -> 'Counter[str]':  # type: ignore[override]
+        """Count field records.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Field recordings.
+
+        """
+        return collections.Counter(map(self.safe_name, data.values()))
+
+    def process(self, data: 'dict[int, str]') -> 'tuple[list[str], list[str]]':  # type: ignore[override]
+        """Process registry data.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        enum = []  # type: list[str]
+        miss = [
+            "return extend_enum(cls, 'Unassigned_%d' % value, value)",
+        ]
+        for code, name in data.items():
+            renm = self.rename(name, code)  # type: ignore[arg-type]
+            enum.append(f"{renm} = {code}".ljust(76))
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(OptionClass())  # type: ignore[arg-type]

pcapkit/vendor/ipv4/option_number.py

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+"""IP Option Numbers
+=======================
+
+.. module:: pcapkit.vendor.ipv4.option_number
+
+This module contains the vendor crawler for **IP Option Numbers**,
+which is automatically generating :class:`pcapkit.const.ipv4.option_number.OptionNumber`.
+
+"""
+
+import collections
+import csv
+import re
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['OptionNumber']
+
+
+class OptionNumber(Vendor):
+    """IP Option Numbers"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/ip-parameters/ip-parameters-1.csv'
+
+    def count(self, data: 'list[str]') -> 'Counter[str]':
+        """Count field records.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Field recordings.
+
+        """
+        reader = csv.reader(data)
+        next(reader)  # header
+        return collections.Counter(map(lambda item: self.safe_name(item[4]),
+                                       filter(lambda item: len(item[3].split('-')) != 2, reader)))
+
+    def process(self, data: 'list[str]') -> 'tuple[list[str], list[str]]':
+        """Process CSV data.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        reader = csv.reader(data)
+        next(reader)  # header
+
+        enum = []  # type: list[str]
+        miss = [
+            "return extend_enum(cls, 'Unassigned_%d' % value, value)",
+        ]
+        for item in reader:
+            code = item[3]
+            dscp = item[4]
+            rfcs = item[5]
+
+            temp = []  # type: list[str]
+            for rfc in filter(None, re.split(r'\[|\]', rfcs)):
+                if re.match(r'\d+', rfc):
+                    continue
+                if 'RFC' in rfc and re.match(r'\d+', rfc[3:]):
+                    #temp.append(f'[{rfc[:3]} {rfc[3:]}]')
+                    temp.append(f'[:rfc:`{rfc[3:]}`]')
+                else:
+                    temp.append(f'[{rfc}]'.replace('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            abbr, name = [s.strip() for s in dscp.split('- ')]
+            tmp2 = re.sub(r'\[\d+\]', '', name).strip()
+
+            if abbr:
+                name = f', {tmp2}' if tmp2 else ''
+                desc = self.wrap_comment(f'``{abbr}``{name}{tmp1}')
+            else:
+                name = tmp2 or ''
+                desc = self.wrap_comment(f'{name}{tmp1}')
+
+            renm = self.rename(abbr or 'Unassigned', code, original=dscp)
+            pres = f"{renm} = {code}"
+            sufs = f'#: {desc}'
+
+            #if len(pres) > 74:
+            #    sufs = f"\n{' '*80}{sufs}"
+
+            #enum.append(f'{pres.ljust(76)}{sufs}')
+            enum.append(f'{sufs}\n    {pres}')
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(OptionNumber())  # type: ignore[arg-type]

pcapkit/vendor/ipv4/protection_authority.py

@@ -0,0 +1,84 @@
+# -*- coding: utf-8 -*-
+"""Protection Authority Bit Assignments
+==========================================
+
+.. module:: pcapkit.vendor.ipv4.protection_authority
+
+This module contains the vendor crawler for **Protection Authority Bit Assignments**,
+which is automatically generating :class:`pcapkit.const.ipv4.protection_authority.ProtectionAuthority`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['ProtectionAuthority']
+
+#: Protection authority registry.
+DATA = {
+    0: 'GENSER',
+    1: 'SIOP-ESI',
+    2: 'SCI',
+    3: 'NSA',
+    4: 'DOE',
+    5: 'Unassigned',
+    6: 'Unassigned',
+    7: 'Field Termination Indicator',
+}  # type: dict[int, str]
+
+
+class ProtectionAuthority(Vendor):
+    """Protection Authority Bit Assignments"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and value >= 0'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv4.protection_authority.DATA`).
+
+        """
+        return DATA
+
+    def count(self, data: 'dict[int, str]') -> 'Counter[str]':  # type: ignore[override]
+        """Count field records.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Field recordings.
+
+        """
+        return collections.Counter(map(self.safe_name, data.values()))
+
+    def process(self, data: 'dict[int, str]') -> 'tuple[list[str], list[str]]':  # type: ignore[override]
+        """Process registry data.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        enum = []  # type: list[str]
+        miss = [
+            "return extend_enum(cls, 'Unassigned_%d' % value, value)",
+        ]
+        for code, name in data.items():
+            renm = self.rename(name, code)  # type: ignore[arg-type]
+            enum.append(f"{renm} = {code}".ljust(76))
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(ProtectionAuthority())  # type: ignore[arg-type]

pcapkit/vendor/ipv4/qs_function.py

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+"""QS Functions
+==================
+
+.. module:: pcapkit.vendor.ipv4.qs_function
+
+This module contains the vendor crawler for **QS Functions**,
+which is automatically generating :class:`pcapkit.const.ipv4.qs_function.QSFunction`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['QSFunction']
+
+#: QS function registry.
+DATA = {
+    0: 'Quick-Start Request',
+    8: 'Report of Approved Rate',
+}  # type: dict[int, str]
+
+
+class QSFunction(Vendor):
+    """QS Functions"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 8'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv4.qs_function.DATA`).
+
+        """
+        return DATA
+
+    def count(self, data: 'dict[int, str]') -> 'Counter[str]':  # type: ignore[override]
+        """Count field records.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Field recordings.
+
+        """
+        return collections.Counter(map(self.safe_name, data.values()))
+
+    def process(self, data: 'dict[int, str]') -> 'tuple[list[str], list[str]]':  # type: ignore[override]
+        """Process registry data.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        enum = []  # type: list[str]
+        miss = [
+            "return extend_enum(cls, 'Unassigned_%d' % value, value)",
+        ]
+        for code, name in DATA.items():
+            renm = self.rename(name, code)  # type: ignore[arg-type]
+            enum.append(f"{renm} = {code}".ljust(76))
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(QSFunction())  # type: ignore[arg-type]

pcapkit/vendor/ipv4/router_alert.py

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+"""IPv4 Router Alert Option Values
+=====================================
+
+.. module:: pcapkit.vendor.ipv4.router_alert
+
+This module contains the vendor crawler for **IPv4 Router Alert Option Values**,
+which is automatically generating :class:`pcapkit.const.ipv4.router_alert.RouterAlert`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['RouterAlert']
+
+
+class RouterAlert(Vendor):
+    """IPv4 Router Alert Option Values"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 65535'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/ip-parameters/ipv4-router-alert-option-values.csv'
+
+    def process(self, data: 'list[str]') -> 'tuple[list[str], list[str]]':
+        """Process CSV data.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        reader = csv.reader(data)
+        next(reader)  # header
+
+        enum = []  # type: list[str]
+        miss = []  # type: list[str]
+        for item in reader:
+            name = item[1]
+            rfcs = item[2]
+
+            temp = []  # type: list[str]
+            for rfc in filter(None, re.split(r'\[|\]', rfcs)):
+                if 'RFC' in rfc and re.match(r'\d+', rfc[3:]):
+                    #temp.append(f'[{rfc[:3]} {rfc[3:]}]')
+                    temp.append(f'[:rfc:`{rfc[3:]}`]')
+                else:
+                    temp.append(f'[{rfc}]'.replace('_', ' '))
+            desc = self.wrap_comment(re.sub(r'\r*\n', ' ', '%s %s' % (  # pylint: disable=consider-using-f-string
+                name, ''.join(temp) if rfcs else '',
+            ), re.MULTILINE))
+
+            try:
+                code, _ = item[0], int(item[0])
+                renm = self.rename(name, code)
+
+                pres = f"{renm} = {code}"
+                sufs = f'#: {desc}'
+
+                #if len(pres) > 74:
+                #    sufs = f"\n{' '*80}{sufs}"
+
+                #enum.append(f'{pres.ljust(76)}{sufs}')
+                enum.append(f'{sufs}\n    {pres}')
+            except ValueError:
+                start, stop = map(int, item[0].split('-'))
+
+                if 'Level' in name:
+                    base = name.rstrip('s 0-31')
+                    for tmp_code in range(start, stop+1):
+                        renm = self.safe_name(f'{base}_{tmp_code-start}')
+                        pres = f"{renm} = {tmp_code}"
+
+                        #if len(pres) > 74:
+                        #    sufs = f"\n{' '*80}{sufs}"
+
+                        #enum.append(f'{pres.ljust(76)}{sufs}')
+                        enum.append(f'#: {desc}\n    {pres}')
+                else:
+                    miss.append(f'if {start} <= value <= {stop}:')
+                    miss.append(f'    #: {desc}')
+                    miss.append(f"    return extend_enum(cls, '{name}_%d' % value, value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(RouterAlert())  # type: ignore[arg-type]

pcapkit/vendor/ipv4/tos_del.py

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+"""ToS (DS Field) Delay
+==========================
+
+.. module:: pcapkit.vendor.ipv4.tos_del
+
+This module contains the vendor crawler for **ToS (DS Field) Delay**,
+which is automatically generating :class:`pcapkit.const.ipv4.tos_del.ToSDelay`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['ToSDelay']
+
+#: ToS registry.
+DATA = {
+    0: 'Normal',
+    1: 'Low',
+}  # type: dict[int, str]
+
+
+class ToSDelay(Vendor):
+    """ToS (DS Field) Delay"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 1'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv4.tos_del.DATA`).
+
+        """
+        return DATA
+
+    def count(self, data: 'dict[int, str]') -> 'Counter[str]':  # type: ignore[override]
+        """Count field records.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Field recordings.
+
+        """
+        return collections.Counter(map(self.safe_name, data.values()))
+
+    def process(self, data: 'dict[int, str]') -> 'tuple[list[str], list[str]]':  # type: ignore[override]
+        """Process registry data.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        enum = []  # type: list[str]
+        miss = [
+            "return extend_enum(cls, 'Unassigned_%d' % value, value)",
+        ]
+        for code, name in DATA.items():
+            renm = self.rename(name, code).upper()  # type: ignore[arg-type]
+            enum.append(f"{renm} = {code}".ljust(76))
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(ToSDelay())  # type: ignore[arg-type]