pypcapkit 1.3.5.post6__pp310-none-any.whl

pcapkit/vendor/__init__.py

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import, unused-wildcard-import
+"""Vendor Crawlers
+=====================
+
+.. module:: pcapkit.vendor
+
+This module contains all web crawlers of :mod:`pcapkit`, which are
+automatically generating the :mod:`pcapkit.const` module's constant.
+enumerations.
+
+"""
+
+from pcapkit.utilities.compat import ModuleNotFoundError  # pylint: disable=redefined-builtin
+from pcapkit.utilities.exceptions import stacklevel
+from pcapkit.utilities.warnings import VendorWarning, warn
+
+try:
+    import requests
+    import socks
+except ModuleNotFoundError:
+    warn("dependency package 'requests[socks]' not found",
+         VendorWarning, stacklevel=stacklevel())
+
+try:
+    import bs4
+    import html5lib
+except ModuleNotFoundError:
+    warn("dependency package 'beautifulsoup4[html5lib]' not found",
+         VendorWarning, stacklevel=stacklevel())
+
+# base crawler
+from pcapkit.vendor.default import Vendor
+
+# IANA registration
+from pcapkit.vendor.reg import *
+
+# Miscellanous
+from pcapkit.vendor.pcapng import *
+
+# per protocol
+from pcapkit.vendor.arp import *
+from pcapkit.vendor.ftp import *
+from pcapkit.vendor.hip import *
+from pcapkit.vendor.http import *
+from pcapkit.vendor.ipv4 import *
+from pcapkit.vendor.ipv6 import *
+from pcapkit.vendor.ipx import *
+from pcapkit.vendor.l2tp import *
+from pcapkit.vendor.mh import *
+from pcapkit.vendor.ospf import *
+from pcapkit.vendor.tcp import *
+from pcapkit.vendor.vlan import *
+
+__all__ = [
+    # Protocol Registration
+    'EtherType', 'LinkType', 'TransType', 'AppType',
+    # ARP
+    'ARP_Hardware', 'ARP_Operation',
+    # FTP
+    'FTP_Command', 'FTP_ReturnCode',
+    # HIP
+    'HIP_Certificate', 'HIP_Cipher', 'HIP_DITypes', 'HIP_ECDSACurve', 'HIP_ECDSALowCurve',
+    'HIP_ESPTransformSuite', 'HIP_Group', 'HIP_HIAlgorithm', 'HIP_HITSuite', 'HIP_NATTraversal',
+    'HIP_NotifyMessage', 'HIP_Packet', 'HIP_Parameter', 'HIP_Registration', 'HIP_RegistrationFailure',
+    'HIP_Suite', 'HIP_Transport', 'HIP_EdDSACurve',
+    # HTTP
+    'HTTP_ErrorCode', 'HTTP_Frame', 'HTTP_Method', 'HTTP_Setting', 'HTTP_StatusCode',
+    # IPv4
+    'IPv4_ClassificationLevel', 'IPv4_OptionClass', 'IPv4_OptionNumber', 'IPv4_ProtectionAuthority',
+    'IPv4_QSFunction', 'IPv4_RouterAlert', 'IPv4_ToSDelay', 'IPv4_ToSECN', 'IPv4_ToSPrecedence',
+    'IPv4_ToSReliability', 'IPv4_ToSThroughput', 'IPv4_TSFlag',
+    # IPv6
+    'IPv6_ExtensionHeader', 'IPv6_Option', 'IPv6_QSFunction', 'IPv6_RouterAlert', 'IPv6_Routing',
+    'IPv6_SeedID', 'IPv6_SMFDPDMode', 'IPv6_TaggerID', 'IPv6_OptionAction',
+    # IPX
+    'IPX_Packet', 'IPX_Socket',
+    # L2TP
+    'L2TP_Type',
+    # MH
+    'MH_Packet', 'MH_Option', 'MH_DNSStatusCode', 'MH_ACKStatusCode',
+    'MH_MNIDSubtype', 'MH_StatusCode', 'MH_EnumeratingAlgorithm',
+    'MH_AuthSubtype', 'MH_HandoffType', 'MH_AccessType',
+    'MH_BindingUpdateFlag', 'MH_BindingACKFlag', 'MH_DSMIPv6HomeAddress',
+    'MH_BindingRevocation', 'MH_RevocationTrigger', 'MH_RevocationStatusCode',
+    'MH_HomeAddressReply', 'MH_DHCPSupportMode', 'MH_HandoverInitiateFlag',
+    'MH_HandoverACKFlag', 'MH_HandoverACKStatus', 'MH_HandoverACKStatus',
+    'MH_FlowIDStatus', 'MH_FlowIDSuboption', 'MH_TrafficSelector',
+    'MH_MNGroupID', 'MH_DSMIP6TLSPacket', 'MH_ANISuboption', 'MH_OperatorID',
+    'MH_UpdateNotificationReason', 'MH_UpdateNotificationACKStatus',
+    'MH_FlowBindingType', 'MH_FlowBindingIndicationTrigger',
+    'MH_FlowBindingACKStatus', 'MH_FlowBindingAction', 'MH_QoSAttribute',
+    'MH_LMAControlledMAGSuboption', 'MH_LLACode', 'MH_CGAType',
+    'MH_CGAExtension', 'MH_CGASec', 'MH_BindingError',
+    # OSPF
+    'OSPF_Authentication', 'OSPF_Packet',
+    # TCP
+    'TCP_Checksum', 'TCP_Option', 'TCP_MPTCPOption', 'TCP_Flags',
+    # VLAN
+    'VLAN_PriorityLevel',
+    # PCAPNG
+    'PCAPNG_BlockType', 'PCAPNG_OptionType', 'PCAPNG_HashAlgorithm',
+    'PCAPNG_VerdictType', 'PCAPNG_RecordType', 'PCAPNG_SecretsType',
+    'PCAPNG_FilterType',
+]

pcapkit/vendor/__main__.py

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+"""Command Line Tool
+=======================
+
+.. module:: pcapkit.vendor.__main__
+
+:mod:`pcapkit.vendor.__main__` is a command line tool for updating
+constant enumerations.
+
+"""
+
+import argparse
+import importlib
+import sys
+import traceback
+import warnings
+from typing import TYPE_CHECKING
+
+from pcapkit import __version__
+from pcapkit import vendor as vendor_module
+from pcapkit.utilities.logging import VERBOSE, logger
+from pcapkit.utilities.warnings import InvalidVendorWarning, VendorRuntimeWarning, warn
+
+if TYPE_CHECKING:
+    from argparse import ArgumentParser
+    from typing import Type
+
+    from pcapkit.vendor.default import Vendor
+
+
+def get_parser() -> 'ArgumentParser':
+    """CLI argument parser."""
+    parser = argparse.ArgumentParser(prog='pcapkit-vendor',
+                                     description='update constant enumerations')
+    parser.add_argument('-V', '--version', action='version', version=__version__)
+    parser.add_argument('target', action='store', nargs=argparse.REMAINDER,
+                        help='update targets, supply none to update all')
+    return parser
+
+
+def run(vendor: 'Type[Vendor]') -> 'None':
+    """Script runner.
+
+    Args:
+        vendor: Subclass of :class:`~pcapkit.vendor.default.Vendor` from :mod:`pcapkit.vendor`.
+
+    Warns:
+        VendorRuntimeWarning: If failed to initiate the ``vendor`` class.
+
+    """
+    logger.info(f'{vendor.__module__}.{vendor.__name__}: {vendor.__doc__}')
+    try:
+        vendor()
+    except Exception as error:
+        if VERBOSE:
+            traceback.print_exc()
+        warn(f'{vendor.__module__}.{vendor.__name__} <{error!r}>', VendorRuntimeWarning, stacklevel=2)
+
+
+def main() -> 'int':
+    """Entrypoint.
+
+    Warns:
+        InvalidVendorWarning: If vendor target not found in :mod:`pcapkit.vendor` module.
+
+    """
+    parser = get_parser()
+    args = parser.parse_args()
+
+    target_list = []  # type: list[Type[Vendor]]
+    for target in args.target:
+        try:
+            module = importlib.import_module(f'pcapkit.vendor.{target}')
+            target_list.extend(getattr(module, name) for name in module.__all__)
+        except ImportError:
+            warnings.showwarning(f'invalid vendor updater: {target}', InvalidVendorWarning,
+                                 filename=__file__, lineno=0, line=' '.join(sys.argv))
+
+    if not target_list:
+        if args.target:
+            parser.error('missing valid targets')
+        target_list.extend(getattr(vendor_module, name) for name in vendor_module.__all__)
+
+    # with multiprocessing.Pool() as pool:
+    #     pool.map(run, target_list)
+    for vendor in target_list:
+        run(vendor)
+    return 0
+
+
+if __name__ == '__main__':
+    sys.exit(main())

pcapkit/vendor/arp/__init__.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.link.arp.ARP` Vendor Crawlers
+==============================================================
+
+.. module:: pcapkit.vendor.arp
+
+This module contains all vendor crawlers of :class:`~pcapkit.protocols.link.arp.ARP`
+and :class:`~pcapkit.protocols.link.rarp.RARP` implementations. Available
+vendor crawlers include:
+
+.. list-table::
+
+   * - :class:`ARP_Hardware <pcapkit.vendor.arp.hardware.Hardware>`
+     - ARP Hardware Types [*]_
+   * - :class:`ARP_Operation <pcapkit.vendor.arp.operation.Operation>`
+     - Operation Codes [*]_
+
+.. [*] https://www.iana.org/assignments/arp-parameters/arp-parameters.xhtml#arp-parameters-2
+.. [*] https://www.iana.org/assignments/arp-parameters/arp-parameters.xhtml#arp-parameters-1
+
+"""
+
+from pcapkit.vendor.arp.hardware import Hardware as ARP_Hardware
+from pcapkit.vendor.arp.operation import Operation as ARP_Operation
+
+__all__ = ['ARP_Hardware', 'ARP_Operation']

pcapkit/vendor/arp/hardware.py

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

pcapkit/vendor/arp/operation.py

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