pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/vendor/reg/transtype.py

@@ -0,0 +1,111 @@
+# -*- coding: utf-8 -*-
+"""Transport Layer Protocol Numbers
+======================================
+
+.. module:: pcapkit.vendor.reg.transtype
+
+This module contains the vendor crawler for **Transport Layer Protocol Numbers**,
+which is automatically generating :class:`pcapkit.const.reg.transtype.TransType`.
+
+"""
+
+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__ = ['TransType']
+
+
+class TransType(Vendor):
+    """Transport Layer Protocol Numbers"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/protocol-numbers/protocol-numbers-1.csv'
+
+    def count(self, data: 'list[str]') -> 'Counter[str]':
+        """Count field records.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Field recordings.
+
+        """
+        reader = csv.reader(data)
+        next(reader)  # header
+        return collections.Counter(map(lambda item: self.safe_name(item[1] or item[2]),
+                                       filter(lambda item: len(item[0].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 = []  # type: list[str]
+        for item in reader:
+            long = item[1]
+            rfcs = item[4]
+
+            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('_', ' '))
+            lrfc = re.sub(r'( )( )*', ' ', f" {''.join(temp)}".replace('\n', ' ')) if rfcs else ''
+
+            subd = re.sub(r'( )( )*', ' ', item[2].replace('\n', ' '))
+            tmp1 = subd if item[2] else ''
+
+            split = long.split(' (', 1)
+            if len(split) == 2:
+                name, cmmt = split[0], f" ({split[1]})"
+            else:
+                name, cmmt = long, ''
+            if not name:
+                name, desc = item[2], ''
+            desc = self.wrap_comment(f'{tmp1}{cmmt}{lrfc}')
+
+            try:
+                code, _ = item[0], int(item[0])
+                renm = self.rename(name, code, original=long)
+
+                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 = item[0].split('-')
+
+                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(TransType())  # type: ignore[arg-type]

pcapkit/vendor/tcp/__init__.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.transport.tcp.TCP` Vendor Crawlers
+===================================================================
+
+.. module:: pcapkit.vendor.tcp
+
+This module contains all vendor crawlers of
+:class:`~pcapkit.protocols.transport.tcp.TCP` implementations. Available
+enumerations include:
+
+.. list-table::
+
+   * - :class:`TCP_Checksum <pcapkit.vendor.tcp.checksum.Checksum>`
+     - TCP Checksum [*]_
+   * - :class:`TCP_MPTCPOption <pcapkit.vendor.tcp.mp_tcp_option.MPTCPOption>`
+     - Multipath TCP options [*]_
+   * - :class:`TCP_Option <pcapkit.vendor.tcp.option.Option>`
+     - TCP Option Kind Numbers [*]_
+   * - :class:`TCP_Flags <pcapkit.vendor.tcp.flags.Flags>`
+     - TCP Header Flags [*]_
+
+.. [*] https://www.iana.org/assignments/tcp-parameters/tcp-parameters.xhtml#tcp-parameters-2
+.. [*] https://www.iana.org/assignments/tcp-parameters/tcp-parameters.xhtml#mptcp-option-subtypes
+.. [*] https://www.iana.org/assignments/tcp-parameters/tcp-parameters.xhtml#tcp-parameters-1
+.. [*] https://www.iana.org/assignments/tcp-parameters/tcp-parameters.xhtml#tcp-header-flags
+
+"""
+
+from pcapkit.vendor.tcp.checksum import Checksum as TCP_Checksum
+from pcapkit.vendor.tcp.flags import Flags as TCP_Flags
+from pcapkit.vendor.tcp.mp_tcp_option import MPTCPOption as TCP_MPTCPOption
+from pcapkit.vendor.tcp.option import Option as TCP_Option
+
+__all__ = ['TCP_Checksum', 'TCP_Option', 'TCP_MPTCPOption', 'TCP_Flags']

pcapkit/vendor/tcp/checksum.py

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+"""TCP Checksum
+==================
+
+.. module:: pcapkit.vendor.tcp.checksum
+
+This module contains the vendor crawler for **TCP Checksum**,
+which is automatically generating :class:`pcapkit.const.tcp.checksum.Checksum`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['Checksum']
+
+#: TCP checksum options.
+DATA = {
+    0:  'TCP checksum',
+    1:  "8-bit Fletcher's algorithm",
+    2:  "16-bit Fletcher's algorithm",
+    3:  'Redundant Checksum Avoidance',
+}  # type: dict[int, str]
+
+
+class Checksum(Vendor):
+    """TCP Checksum [:rfc:`1146`]"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            TCP checksum options, i.e. :data:`~pcapkit.vendor.tcp.checksum.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 CSV 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(Checksum())  # type: ignore[arg-type]

pcapkit/vendor/tcp/flags.py

@@ -0,0 +1,149 @@
+# -*- coding: utf-8 -*-
+"""TCP Header Flags
+======================
+
+.. module:: pcapkit.vendor.tcp.flags
+
+This module contains the vendor crawler for **TCP Header Flags**,
+which is automatically generating :class:`pcapkit.const.tcp.flags.Flags`.
+
+"""
+
+import csv
+import re
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from typing import Callable
+
+__all__ = ['Flags']
+
+#: TCP header flags' abbreviation.
+DATA = {
+    15: 'FIN',
+    14: 'SYN',
+    13: 'RST',
+    12: 'PSH',
+    11: 'ACK',
+    10: 'URG',
+    9: 'ECE',
+    8: 'CWR',
+}
+
+#: Default constant template of enumerate registry from IANA CSV.
+LINE = lambda NAME, DOCS, ENUM, MODL: f'''\
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""{(name := DOCS.split(' [', maxsplit=1)[0])}
+{'=' * (len(name) + 6)}
+
+.. module:: {MODL.replace('vendor', 'const')}
+
+This module contains the constant enumeration for **{name}**,
+which is automatically generated from :class:`{MODL}.{NAME}`.
+
+"""
+
+from typing import TYPE_CHECKING
+
+from aenum import IntFlag
+
+if TYPE_CHECKING:
+    from typing import Optional
+
+__all__ = ['{NAME}']
+
+class {NAME}(IntFlag):
+    """[{NAME}] {DOCS}"""
+
+    {ENUM}
+
+    @staticmethod
+    def get(key: 'int | str', default: 'Optional[int]' = -1) -> '{NAME}':
+        """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 Flags(key)
+        return {NAME}[key]  # type: ignore[misc]
+'''.strip()  # type: Callable[[str, str, str, str], str]
+
+
+class Flags(Vendor):
+    """TCP Header Flags"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 4 <= value <= 15'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/tcp-parameters/tcp-header-flags.csv'
+
+    def process(self, data: 'list[str]') -> 'list[str]':  # type: ignore[override]
+        """Process CSV data.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Enumeration fields.
+
+        """
+        reader = csv.reader(data)
+        next(reader)  # header
+
+        enum = []  # type: list[str]
+        for item in reader:
+            dscp = item[1]
+            rfcs = item[2]
+
+            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 ''
+            desc = self.wrap_comment(re.sub(r'\r*\n', ' ', f'{dscp}{tmp1}', re.MULTILINE))
+
+            code = item[0]
+            name = DATA.get(int(code), dscp.split(' (')[0]).replace('Reserved for future use', 'Reserved')
+            renm = self.rename(name or 'Unassigned', code, original=dscp)
+
+            pres = f"{renm} = 1 << {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
+
+    def context(self, data: 'list[str]') -> 'str':
+        """Generate constant context.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Constant context.
+
+        """
+        enum = self.process(data)
+        ENUM = '\n\n    '.join(map(lambda s: s.rstrip(), enum)).strip()
+
+        return LINE(self.NAME, self.DOCS, ENUM, self.__module__)
+
+
+if __name__ == '__main__':
+    sys.exit(Flags())  # type: ignore[arg-type]

pcapkit/vendor/tcp/mp_tcp_option.py

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+"""Multipath TCP options
+===========================
+
+.. module:: pcapkit.vendor.tcp.mp_tcp_option
+
+This module contains the vendor crawler for **Multipath TCP options**,
+which is automatically generating :class:`pcapkit.const.tcp.mp_tcp_option.MPTCPOption`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['MPTCPOption']
+
+
+class MPTCPOption(Vendor):
+    """Multipath TCP options [:rfc:`6824`]"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/tcp-parameters/mptcp-option-subtypes.csv'
+
+    def process(self, data: 'list[str]') -> 'tuple[list[str], list[str]]':
+        """Process CSV data.
+
+        Args:
+            data: Registry 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:
+            dscp = item[2]
+            rfcs = item[3]
+
+            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:]}]')
+                    match = re.fullmatch(r'RFC(?P<rfc>\d+)(, Section (?P<sec>.*?))?', rfc)
+                    if match is None:
+                        temp.append(f'[{rfc}]')
+                    else:
+                        if match.group('sec') is not None:
+                            temp.append(f'[:rfc:`{match.group("rfc")}#{match.group("sec")}`]')
+                        else:
+                            temp.append(f'[:rfc:`{match.group("rfc")}`]')
+                else:
+                    temp.append(f'[{rfc}]'.replace('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+            desc = self.wrap_comment(re.sub(r'\r*\n', ' ', f'{dscp}{tmp1}', re.MULTILINE))
+
+            name = item[1]
+            try:
+                code, _ = item[0], int(item[0], base=16)
+                renm = self.rename(name 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}')
+            except ValueError:
+                start, stop = item[0].split('-')
+
+                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(MPTCPOption())  # type: ignore[arg-type]

pcapkit/vendor/tcp/option.py

@@ -0,0 +1,103 @@
+# -*- coding: utf-8 -*-
+"""TCP Option Kind Numbers
+=============================
+
+.. module:: pcapkit.vendor.tcp.option
+
+This module contains the vendor crawler for **TCP Option Kind Numbers**,
+which is automatically generating :class:`pcapkit.const.tcp.option.Option`.
+
+"""
+
+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__ = ['Option']
+
+
+class Option(Vendor):
+    """TCP Option Kind Numbers"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/tcp-parameters/tcp-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[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 = []  # type: list[str]
+        for item in reader:
+            dscp = item[2]
+            rfcs = item[3]
+
+            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 ''
+            desc = self.wrap_comment(re.sub(r'(\[(\*+)\])|(\[(\d+)\])', r'',
+                                            re.sub(r'\r*\n', ' ', f'{dscp}{tmp1}', re.MULTILINE)))
+
+            name = dscp.split(' (')[0]
+            try:
+                code, _ = item[0], int(item[0])
+                renm = self.rename(name 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}')
+            except ValueError:
+                start, stop = item[0].split('-')
+
+                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(Option())  # type: ignore[arg-type]

pcapkit/vendor/vlan/__init__.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.link.vlan.VLAN` Vendor Crawlers
+================================================================
+
+.. module:: pcapkit.vendor.vlan
+
+This module contains all vendor crawlers 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.vendor.vlan.priority_level import PriorityLevel as VLAN_PriorityLevel
+
+__all__ = ['VLAN_PriorityLevel']

pcapkit/vendor/vlan/priority_level.py

@@ -0,0 +1,97 @@
+# -*- coding: utf-8 -*-
+"""Priority levels defined in IEEE 802.1p
+============================================
+
+.. module:: pcapkit.vendor.vlan.priority_level
+
+This module contains the vendor crawler for **Priority levels defined in IEEE 802.1p**,
+which is automatically generating :class:`pcapkit.const.vlan.priority_level.PriorityLevel`.
+
+"""
+
+import collections
+import re
+import sys
+from typing import TYPE_CHECKING
+
+import bs4
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+    from bs4 import BeautifulSoup
+
+__all__ = ['PriorityLevel']
+
+
+class PriorityLevel(Vendor):
+    """Priority levels defined in IEEE 802.1p"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0b000 <= value <= 0b111'
+    #: Link to registry.
+    LINK = 'https://en.wikipedia.org/wiki/IEEE_P802.1p#Priority_levels'
+
+    def request(self, text: 'str') -> 'BeautifulSoup':  # type: ignore[override] # pylint: disable=signature-differs,arguments-renamed
+        """Fetch registry table.
+
+        Args:
+            text: Context from :attr:`~LinkType.LINK`.
+
+        Returns:
+            Parsed HTML source.
+
+        """
+        return bs4.BeautifulSoup(text, 'html5lib')
+
+    def count(self, soup: 'BeautifulSoup') -> 'Counter[str]':  # pylint: disable=signature-differs,arguments-renamed,unused-argument
+        """Count field records."""
+        return collections.Counter()
+
+    def process(self, soup: 'BeautifulSoup') -> 'tuple[list[str], list[str]]':  # pylint: disable=arguments-differ,arguments-renamed,unused-argument
+        """Process HTML data.
+
+        Args:
+            data: Parsed HTML source.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        table = soup.find_all('table', class_='wikitable')[0]
+        content = filter(lambda item: isinstance(item, bs4.element.Tag), table.tbody)
+        next(content)  # header
+
+        enum = []  # type: list[str]
+        miss = [
+            "return extend_enum(cls, 'Unassigned [0b%s]' % bin(value)[2:].zfill(3), value)",
+        ]
+        for item in content:
+            line = item.find_all('td')
+
+            pval = ' '.join(line[0].stripped_strings)
+            prio = ' '.join(line[1].stripped_strings)
+            abbr = ' '.join(line[2].stripped_strings)
+            desc = ' '.join(line[3].stripped_strings)
+
+            match = re.match(r'(\d) *(\(.*\))*', prio)
+            group = match.groups()  # type: ignore[union-attr]
+
+            code = f'0b{bin(int(pval))[2:].zfill(3)}'
+            tmp1 = self.wrap_comment(f"{desc} {group[1] or ''}")
+
+            pres = f"{abbr} = {code}"
+            sufs = f"#: {tmp1}"
+
+            # 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(PriorityLevel())  # type: ignore[arg-type]