pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/vendor/mh/revocation_status_code.py

@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+"""Binding Revocation Acknowledgement Status Codes
+=====================================================
+
+.. module:: pcapkit.vendor.mh.revocation_status_code
+
+This module contains the vendor crawler for **Binding Revocation Acknowledgement Status Codes**,
+which is automatically generating :class:`pcapkit.const.mh.revocation_status_code.RevocationStatusCode`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['RevocationStatusCode']
+
+
+class RevocationStatusCode(Vendor):
+    """Binding Revocation Acknowledgement Status Codes"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/binding-revocation-status-codes.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:
+            long = 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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            split = long.split(' (', 1)
+            if len(split) == 2:
+                name = split[0]
+                cmmt = f" ({split[1]}"
+            else:
+                name, cmmt = long, ''
+            desc = self.wrap_comment(f'{name}{cmmt}{tmp1}')
+
+            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, '{self.safe_name(name)}_%d' % value, value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(RevocationStatusCode())  # type: ignore[arg-type]

pcapkit/vendor/mh/revocation_trigger.py

@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+"""Revocation Trigger Values
+===============================
+
+.. module:: pcapkit.vendor.mh.revocation_trigger
+
+This module contains the vendor crawler for **Revocation Trigger Values**,
+which is automatically generating :class:`pcapkit.const.mh.revocation_trigger.RevocationTrigger`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['RevocationTrigger']
+
+
+class RevocationTrigger(Vendor):
+    """Revocation Trigger Values"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/revocation-trigger-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:
+            long = 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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            split = long.split(' (', 1)
+            if len(split) == 2:
+                name = split[0]
+                cmmt = f" ({split[1]}"
+            else:
+                name, cmmt = long, ''
+            desc = self.wrap_comment(f'{name}{cmmt}{tmp1}')
+
+            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, '{self.safe_name(name)}_%d' % value, value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(RevocationTrigger())  # type: ignore[arg-type]

pcapkit/vendor/mh/status_code.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+"""Status Codes
+==================
+
+.. module:: pcapkit.vendor.mh.status_code
+
+This module contains the vendor crawler for **Status Codes**,
+which is automatically generating :class:`pcapkit.const.mh.dns_status_code.StatusCode`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['StatusCode']
+
+
+class StatusCode(Vendor):
+    """Status Codes"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/mobility-parameters-6.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:
+            long = 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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            split = long.split(' (', 1)
+            if len(split) == 2:
+                name = split[0]
+                cmmt = f" ({split[1]}"
+            else:
+                name, cmmt = long, ''
+            desc = self.wrap_comment(f'{name}{cmmt}{tmp1}')
+
+            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, '{self.safe_name(name)}_%d' % value, value)")
+
+        # TODO: figure out how to handle this programmatically
+        miss.append('#: Unspecified in the IANA registry')
+        miss.append("return extend_enum(cls, 'Unassigned_%d' % value, value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(StatusCode())  # type: ignore[arg-type]

pcapkit/vendor/mh/traffic_selector.py

@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+"""Traffic Selector Format
+=============================
+
+.. module:: pcapkit.vendor.mh.traffic_selector
+
+This module contains the vendor crawler for **Traffic Selector Format**,
+which is automatically generating :class:`pcapkit.const.mh.traffic_selector.TrafficSelector`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['TrafficSelector']
+
+
+class TrafficSelector(Vendor):
+    """Traffic Selector Format"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/traffic-selector.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:
+            long = 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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            split = long.split(' (', 1)
+            if len(split) == 2:
+                name = split[0]
+                cmmt = f" ({split[1]}"
+            else:
+                name, cmmt = long, ''
+            desc = self.wrap_comment(f'{name}{cmmt}{tmp1}')
+
+            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, '{self.safe_name(name)}_%d' % value, value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(TrafficSelector())  # type: ignore[arg-type]

pcapkit/vendor/mh/upa_status.py

@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+"""Update Notification Acknowledgement Status Registry
+=========================================================
+
+.. module:: pcapkit.vendor.mh.upa_status
+
+This module contains the vendor crawler for **Update Notification Acknowledgement Status Registry**,
+which is automatically generating :class:`pcapkit.const.mh.upa_status.UpdateNotificationACKStatus`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['UpdateNotificationACKStatus']
+
+
+class UpdateNotificationACKStatus(Vendor):
+    """Update Notification Acknowledgement Status Registry"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/upa-status.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:
+            long = 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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            split = long.split(' (', 1)
+            if len(split) == 2:
+                name = split[0]
+                cmmt = f" ({split[1]}"
+            else:
+                name, cmmt = long, ''
+            desc = self.wrap_comment(f'{name}{cmmt}{tmp1}')
+
+            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, '{self.safe_name(name)}_%d' % value, value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(UpdateNotificationACKStatus())  # type: ignore[arg-type]

pcapkit/vendor/mh/upn_reason.py

@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+"""Update Notification Reasons Registry
+==========================================
+
+.. module:: pcapkit.vendor.mh.upn_reason
+
+This module contains the vendor crawler for **Update Notification Reasons Registry**,
+which is automatically generating :class:`pcapkit.const.mh.upn_reason.UpdateNotificationReason`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['UpdateNotificationReason']
+
+
+class UpdateNotificationReason(Vendor):
+    """Update Notification Reasons Registry"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/upn-reasons.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:
+            long = 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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            split = long.split(' (', 1)
+            if len(split) == 2:
+                name = split[0]
+                cmmt = f" ({split[1]}"
+            else:
+                name, cmmt = long, ''
+            desc = self.wrap_comment(f'{name}{cmmt}{tmp1}')
+
+            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, '{self.safe_name(name)}_%d' % value, value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(UpdateNotificationReason())  # type: ignore[arg-type]

pcapkit/vendor/ospf/__init__.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.link.ospf.OSPF` Vendor Crawlers
+================================================================
+
+.. module:: pcapkit.vendor.ospf
+
+This module contains all vendor crawlers of
+:class:`~pcapkit.protocols.link.ospf.OSPF` implementations. Available
+enumerations include:
+
+.. list-table::
+
+   * - :class:`OSPF_Authentication <pcapkit.vendor.ospf.authentication.Authentication>`
+     - Authentication Codes [*]_
+   * - :class:`OSPF_Packet <pcapkit.vendor.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.vendor.ospf.authentication import Authentication as OSPF_Authentication
+from pcapkit.vendor.ospf.packet import Packet as OSPF_Packet
+
+__all__ = ['OSPF_Authentication', 'OSPF_Packet']

pcapkit/vendor/ospf/authentication.py

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+"""Authentication Types
+==========================
+
+.. module:: pcapkit.vendor.ospf.authentication
+
+This module contains the vendor crawler for **Authentication Types**,
+which is automatically generating :class:`pcapkit.const.ospf.authentication.Authentication`.
+
+"""
+
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['Authentication']
+
+
+class Authentication(Vendor):
+    """Authentication Types"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 65535'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/ospf-authentication-codes/authentication-codes.csv'
+
+
+if __name__ == '__main__':
+    sys.exit(Authentication())  # type: ignore[arg-type]

pcapkit/vendor/ospf/packet.py

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+"""OSPF Packet Types
+=======================
+
+.. module:: pcapkit.vendor.ospf.packet
+
+This module contains the vendor crawler for **OSPF Packet Types**,
+which is automatically generating :class:`pcapkit.const.ospf.packet.Packet`.
+
+"""
+
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['Packet']
+
+
+class Packet(Vendor):
+    """OSPF Packet Types"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 65535'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/ospfv2-parameters/ospfv2-parameters-3.csv'
+
+
+if __name__ == '__main__':
+    sys.exit(Packet())  # type: ignore[arg-type]

pcapkit/vendor/pcapng/__init__.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.misc.pcapng.PCAPNG` Vendor Crawler
+===================================================================
+
+.. module:: pcapkit.vendor.pcapng
+
+This module contains all vendor crawlers of
+:class:`~pcapkit.protocols.misc.pcapng.PCAPNG` implementations. Available
+crawlers include:
+
+.. list-table::
+
+   * - :class:`PCAPNG_BlockType <pcapkit.vendor.pcapng.block_type.BlockType>`
+     - Block Types [*]_
+   * - :class:`PCAPNG_OptionType <pcapkit.vendor.pcapng.option_type.OptionType>`
+     - Option Types [*]_
+   * - :class:`PCAPNG_HashAlgorithm <pcapkit.vendor.pcapng.hash_algorithm.HashAlgorithm>`
+     - Hash Algorithms [*]_
+   * - :class:`PCAPNG_VerdictType <pcapkit.vendor.pcapng.verdict_type.VerdictType>`
+     - Verdict Types [*]_
+   * - :class:`PCAPNG_RecordType <pcapkit.vendor.pcapng.record_type.RecordType>`
+     - Record Types [*]_
+   * - :class:`PCAPNG_SecretsType <pcapkit.vendor.pcapng.secrets_type.SecretsType>`
+     - Secrets Types [*]_
+   * - :class:`PCAPNG_FilterType <pcapkit.vendor.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.vendor.pcapng.block_type import BlockType as PCAPNG_BlockType
+from pcapkit.vendor.pcapng.filter_type import FilterType as PCAPNG_FilterType
+from pcapkit.vendor.pcapng.hash_algorithm import HashAlgorithm as PCAPNG_HashAlgorithm
+from pcapkit.vendor.pcapng.option_type import OptionType as PCAPNG_OptionType
+from pcapkit.vendor.pcapng.record_type import RecordType as PCAPNG_RecordType
+from pcapkit.vendor.pcapng.secrets_type import SecretsType as PCAPNG_SecretsType
+from pcapkit.vendor.pcapng.verdict_type import VerdictType as PCAPNG_VerdictType
+
+__all__ = [
+    'PCAPNG_BlockType', 'PCAPNG_OptionType', 'PCAPNG_HashAlgorithm',
+    'PCAPNG_VerdictType', 'PCAPNG_RecordType', 'PCAPNG_SecretsType',
+    'PCAPNG_FilterType',
+]