pypcapkit 1.3.5.post6__pp310-none-any.whl

pcapkit/protocols/link/ospf.py

@@ -0,0 +1,342 @@
+# -*- coding: utf-8 -*-
+"""OSPF - Open Shortest Path First
+=====================================
+
+.. module:: pcapkit.protocols.link.ospf
+
+:mod:`pcapkit.protocols.link.ospf` contains
+:class:`~pcapkit.protocols.link.ospf.OSPF` only,
+which implements extractor for Open Shortest Path
+First (OSPF) [*]_, whose structure is described
+as below:
+
+.. table::
+
+   ====== ===== ================== ===============================
+   Octets Bits  Name               Description
+   ====== ===== ================== ===============================
+   0          0 ``ospf.version``   Version Number
+   ------ ----- ------------------ -------------------------------
+   0          0 ``ospf.type``      Type
+   ------ ----- ------------------ -------------------------------
+   0          1 ``ospf.len``       Packet Length (header included)
+   ------ ----- ------------------ -------------------------------
+   0          2 ``ospf.router_id`` Router ID
+   ------ ----- ------------------ -------------------------------
+   0          4 ``ospf.area_id``   Area ID
+   ------ ----- ------------------ -------------------------------
+   0          6 ``ospf.chksum``    Checksum
+   ------ ----- ------------------ -------------------------------
+   0          7 ``ospf.autype``    Authentication Type
+   ------ ----- ------------------ -------------------------------
+   1          8 ``ospf.auth``      Authentication
+   ====== ===== ================== ===============================
+
+.. [*] https://en.wikipedia.org/wiki/Open_Shortest_Path_First
+
+"""
+import ipaddress
+import re
+from typing import TYPE_CHECKING, cast
+
+from pcapkit.const.ospf.authentication import Authentication as Enum_Authentication
+from pcapkit.const.ospf.packet import Packet as Enum_Packet
+from pcapkit.protocols.data.link.ospf import OSPF as Data_OSPF
+from pcapkit.protocols.data.link.ospf import \
+    CrytographicAuthentication as Data_CrytographicAuthentication
+from pcapkit.protocols.link.link import Link
+from pcapkit.protocols.schema.link.ospf import OSPF as Schema_OSPF
+from pcapkit.protocols.schema.link.ospf import \
+    CrytographicAuthentication as Schema_CrytographicAuthentication
+from pcapkit.utilities.exceptions import ProtocolError, UnsupportedCall
+
+if TYPE_CHECKING:
+    from enum import IntEnum as StdlibEnum
+    from ipaddress import IPv4Address
+    from typing import Any, NoReturn, Optional, Type
+
+    from aenum import IntEnum as AenumEnum
+    from typing_extensions import Literal
+
+    from pcapkit.protocols.protocol import ProtocolBase as Protocol
+    from pcapkit.protocols.schema.schema import Schema
+
+__all__ = ['OSPF']
+
+# Ethernet address pattern
+PAT_MAC_ADDR = re.compile(rb'(?i)(?:[0-9a-f]{2}[:-]){5}[0-9a-f]{2}')
+
+
+class OSPF(Link[Data_OSPF, Schema_OSPF],
+           schema=Schema_OSPF, data=Data_OSPF):
+    """This class implements Open Shortest Path First."""
+
+    ##########################################################################
+    # Properties.
+    ##########################################################################
+
+    @property
+    def name(self) -> 'str':
+        """Name of current protocol."""
+        return f'Open Shortest Path First version {self._info.version}'
+
+    @property
+    def alias(self) -> 'str':
+        """Acronym of current protocol."""
+        return f'OSPFv{self._info.version}'
+
+    @property
+    def length(self) -> 'Literal[24]':
+        """Header length of current protocol."""
+        return 24
+
+    @property
+    def type(self) -> 'Enum_Packet':
+        """OSPF packet type."""
+        return self._info.type
+
+    ##########################################################################
+    # Methods.
+    ##########################################################################
+
+    def read(self, length: 'Optional[int]' = None, **kwargs: 'Any') -> 'Data_OSPF':
+        """Read Open Shortest Path First.
+
+        Structure of OSPF header [:rfc:`2328`]:
+
+        .. code-block:: text
+
+            0                   1                   2                   3
+            0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+           +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+           |   Version #   |     Type      |         Packet length         |
+           +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+           |                          Router ID                            |
+           +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+           |                           Area ID                             |
+           +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+           |           Checksum            |             AuType            |
+           +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+           |                       Authentication                          |
+           +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+           |                       Authentication                          |
+           +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+        Args:
+            length: Length of packet data.
+            **kwargs: Arbitrary keyword arguments.
+
+        Returns:
+            Parsed packet data.
+
+        """
+        schema = self.__schema__
+
+        ospf = Data_OSPF(
+            version=schema.version,
+            type=schema.type,
+            len=schema.length,
+            router_id=schema.router_id,
+            area_id=schema.area_id,
+            chksum=schema.checksum,
+            autype=schema.auth_type,
+        )
+        length = schema.length if schema.length else (length or len(self))
+
+        if ospf.autype == Enum_Authentication.Cryptographic_authentication:
+            ospf.__update__([
+                ('auth', self._read_encrypt_auth(
+                    cast('Schema_CrytographicAuthentication', schema.auth_data),
+                )),
+            ])
+        else:
+            ospf.__update__([
+                ('auth', cast('bytes', schema.auth_data)),
+            ])
+        return self._decode_next_layer(ospf, length - self.length)
+
+    def make(self,
+             version: 'int' = 2,
+             type: 'Enum_Packet | StdlibEnum | AenumEnum | str | int' = Enum_Packet.Hello,
+             type_default: 'Optional[int]' = None,
+             type_namespace: 'Optional[dict[str, int] | dict[int, str] | Type[StdlibEnum] | Type[AenumEnum]]' = None,  # pylint: disable=line-too-long
+             type_reversed: 'bool' = False,
+             router_id: 'IPv4Address | str | bytes | bytearray' = '0.0.0.0',  # nosec: B104
+             area_id: 'IPv4Address | str | bytes | bytearray' = '0.0.0.0',  # nosec: B104
+             checksum: 'bytes' = b'\x00\x00',
+             auth_type: 'Enum_Authentication | StdlibEnum | AenumEnum | str | int' = Enum_Authentication.No_Authentication,
+             auth_type_default: 'Optional[int]' = None,
+             auth_type_namespace: 'Optional[dict[str, int] | dict[int, str] | Type[StdlibEnum] | Type[AenumEnum]]' = None,  # pylint: disable=line-too-long
+             auth_type_reversed: 'bool' = False,
+             auth_data: 'bytes | Schema_CrytographicAuthentication | Data_CrytographicAuthentication' = b'\x00\x00\x00\x00\x00\x00\x00\x00',
+             payload: 'bytes | Protocol | Schema' = b'',
+             **kwargs: 'Any') -> 'Schema_OSPF':
+        """Make (construct) packet data.
+
+        Args:
+            version: OSPF version number.
+            type: OSPF packet type.
+            type_default: Default value for ``type`` if not specified.
+            type_namespace: Namespace for ``type``.
+            type_reversed: Reverse namespace for ``type``.
+            router_id: Router ID.
+            area_id: Area ID.
+            checksum: Checksum.
+            auth_type: Authentication type.
+            auth_type_default: Default value for ``auth_type`` if not specified.
+            auth_type_namespace: Namespace for ``auth_type``.
+            auth_type_reversed: Reverse namespace for ``auth_type``.
+            auth_data: Authentication data.
+            payload: Payload data.
+            **kwargs: Arbitrary keyword arguments.
+
+        Returns:
+            Constructed packet data.
+
+        """
+        type_ = self._make_index(type, type_default, namespace=type_namespace,
+                                 reversed=type_reversed, pack=False)
+        auth_type_ = self._make_index(auth_type, auth_type_default, namespace=auth_type_namespace,
+                                      reversed=auth_type_reversed, pack=False)
+
+        if auth_type_ == Enum_Authentication.Cryptographic_authentication:
+            data = self._make_encrypt_auth(auth_data)
+        else:
+            if not isinstance(auth_data, bytes):
+                raise ProtocolError(f'OSPF: invalid type for authentication data: {auth_data!r}')
+            data = auth_data
+
+        return Schema_OSPF(
+            version=version,
+            type=type_,  # type: ignore[arg-type]
+            length=24 + len(payload),
+            router_id=router_id,
+            area_id=area_id,
+            checksum=checksum,
+            auth_type=auth_type_,  # type: ignore[arg-type]
+            auth_data=data,
+            payload=payload,
+        )
+
+    ##########################################################################
+    # Data models.
+    ##########################################################################
+
+    def __length_hint__(self) -> 'Literal[24]':
+        """Return an estimated length for the object."""
+        return 24
+
+    @classmethod
+    def __index__(cls) -> 'NoReturn':  # pylint: disable=invalid-index-returned
+        """Numeral registry index of the protocol.
+
+        Raises:
+            UnsupportedCall: This protocol has no registry entry.
+
+        """
+        raise UnsupportedCall(f'{cls.__name__!r} object cannot be interpreted as an integer')
+
+    ##########################################################################
+    # Utilities.
+    ##########################################################################
+
+    @classmethod
+    def _make_data(cls, data: 'Data_OSPF') -> 'dict[str, Any]':  # type: ignore[override]
+        """Create key-value pairs from ``data`` for protocol construction.
+
+        Args:
+            data: protocol data
+
+        Returns:
+            Key-value pairs for protocol construction.
+
+        """
+        return {
+            'version': data.version,
+            'type': data.type,
+            'router_id': data.router_id,
+            'area_id': data.area_id,
+            'checksum': data.chksum,
+            'auth_type': data.autype,
+            'auth_data': data.auth,
+            'payload': cls._make_payload(data)
+        }
+
+    def _read_id_numbers(self, id: 'bytes') -> 'IPv4Address':
+        """Read router and area IDs.
+
+        Args:
+            id: ID bytes.
+
+        Returns:
+            Parsed IDs as an IPv4 address.
+
+        """
+        #_byte = self._read_fileng(4)
+        #_addr = '.'.join(str(_) for _ in _byte)
+        return ipaddress.ip_address(id)  # type: ignore[return-value]
+
+    def _make_id_numbers(self, id: 'IPv4Address | str | bytes | bytearray') -> 'bytes':
+        """Make router and area IDs.
+
+        Args:
+            id: ID.
+
+        Returns:
+            ID bytes.
+
+        """
+        return ipaddress.ip_address(id).packed
+
+    def _read_encrypt_auth(self, schema: 'Schema_CrytographicAuthentication') -> 'Data_CrytographicAuthentication':
+        """Read Authentication field when Cryptographic Authentication is employed,
+        i.e. :attr:`~OSPF.autype` is ``2``.
+
+        Structure of Cryptographic Authentication [:rfc:`2328`]:
+
+        .. code-block:: text
+
+            0                   1                   2                   3
+            0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+           +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+           |              0                |    Key ID     | Auth Data Len |
+           +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+           |                 Cryptographic sequence number                 |
+           +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+        Args:
+            schema: parsed authentication data
+
+        Returns:
+            Parsed packet data.
+
+        """
+        auth = Data_CrytographicAuthentication(
+            key_id=schema.key_id,
+            len=schema.len,
+            seq=schema.seq,
+        )
+        return auth
+
+    def _make_encrypt_auth(self,
+                           auth_data: 'bytes | Schema_CrytographicAuthentication | Data_CrytographicAuthentication'  # pylint: disable=line-too-long
+                           ) -> 'bytes | Schema_CrytographicAuthentication':
+        """Make Authentication field when Cryptographic Authentication is employed.
+
+        Args:
+            auth_type: Authentication type.
+            auth_data: Authentication data.
+
+        Returns:
+            Authentication bytes.
+
+        """
+        if isinstance(auth_data, (Schema_CrytographicAuthentication, bytes)):
+            return auth_data
+        if isinstance(auth_data, Data_CrytographicAuthentication):
+            return Schema_CrytographicAuthentication(
+                key_id=auth_data.key_id,
+                len=auth_data.len,
+                seq=auth_data.seq,
+            )
+        raise ProtocolError(f'OSPF: invalid type for auth_data: {auth_data!r}')

pcapkit/protocols/link/rarp.py

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+"""RARP/DRARP - (Dynamic) Reverse Address Resolution Protocol
+================================================================
+
+.. module:: pcapkit.protocols.link.rarp
+
+:mod:`pcapkit.protocols.link.rarp` contains
+:class:`~pcapkit.protocols.link.rarp.RARP` only,
+which implements extractor for (Dynamic) Reverse
+Address Resolution Protocol (RARP/DRARP) [*]_,
+whose structure is described as below:
+
+====== ========= ========================= =========================
+Octets      Bits        Name                    Description
+====== ========= ========================= =========================
+  0           0   ``rarp.htype``            Hardware Type
+  2          16   ``rarp.ptype``            Protocol Type
+  4          32   ``rarp.hlen``             Hardware Address Length
+  5          40   ``rarp.plen``             Protocol Address Length
+  6          48   ``rarp.oper``             Operation
+  8          64   ``rarp.sha``              Sender Hardware Address
+  14        112   ``rarp.spa``              Sender Protocol Address
+  18        144   ``rarp.tha``              Target Hardware Address
+  24        192   ``rarp.tpa``              Target Protocol Address
+====== ========= ========================= =========================
+
+.. [*] http://en.wikipedia.org/wiki/Address_Resolution_Protocol
+
+"""
+from typing import TYPE_CHECKING
+
+from pcapkit.const.reg.ethertype import EtherType as Enum_EtherType
+from pcapkit.protocols.data.link.arp import ARP as Data_ARP
+from pcapkit.protocols.link.arp import ARP
+from pcapkit.protocols.schema.link.arp import ARP as Schema_ARP
+
+if TYPE_CHECKING:
+    from typing_extensions import Literal
+
+__all__ = ['RARP', 'DRARP']
+
+
+class RARP(ARP, schema=Schema_ARP, data=Data_ARP):  # pylint: disable=abstract-method
+    """This class implements Reverse Address Resolution Protocol."""
+
+    ##########################################################################
+    # Methods.
+    ##########################################################################
+
+    @classmethod
+    def id(cls) -> 'tuple[Literal["RARP"], Literal["DRARP"]]':  # type: ignore[override]
+        """Index ID of the protocol."""
+        return ('RARP', 'DRARP')
+
+    ##########################################################################
+    # Data models.
+    ##########################################################################
+
+    @classmethod
+    def __index__(cls) -> 'Enum_EtherType':  # pylint: disable=invalid-index-returned
+        """Numeral registry index of the protocol.
+
+        Returns:
+            Numeral registry index of the protocol in `IANA`_.
+
+        .. _IANA: https://www.iana.org/assignments/ieee-802-numbers/ieee-802-numbers.xhtml
+
+        """
+        return Enum_EtherType.Reverse_Address_Resolution_Protocol  # type: ignore[return-value]
+
+
+class DRARP(RARP):
+    """This class implements Dynamic Reverse Address Resolution Protocol."""
+
+    ##########################################################################
+    # Methods.
+    ##########################################################################
+
+    @classmethod
+    def id(cls) -> 'tuple[Literal["DRARP"]]':  # type: ignore[override]
+        """Index ID of the protocol."""
+        return ('DRARP',)

pcapkit/protocols/link/vlan.py

@@ -0,0 +1,225 @@
+# -*- coding: utf-8 -*-
+"""VLAN - 802.1Q Customer VLAN Tag Type
+==========================================
+
+.. module:: pcapkit.protocols.link.vlan
+
+:mod:`pcapkit.protocols.link.vlan` contains
+:class:`~pcapkit.protocols.link.vlan.VLAN`
+only, which implements extractor for 802.1Q
+Customer VLAN Tag Type [*]_, whose structure is
+described as below:
+
+======= ========= ====================== =============================
+Octets      Bits        Name                    Description
+======= ========= ====================== =============================
+  1           0   ``vlan.tci``              Tag Control Information
+  1           0   ``vlan.tci.pcp``          Priority Code Point
+  1           3   ``vlan.tci.dei``          Drop Eligible Indicator
+  1           4   ``vlan.tci.vid``          VLAN Identifier
+  3          24   ``vlan.type``             Protocol (Internet Layer)
+======= ========= ====================== =============================
+
+.. [*] https://en.wikipedia.org/wiki/IEEE_802.1Q
+
+"""
+from typing import TYPE_CHECKING
+
+from pcapkit.const.reg.ethertype import EtherType as Enum_EtherType
+from pcapkit.const.vlan.priority_level import PriorityLevel as Enum_PriorityLevel
+from pcapkit.protocols.data.link.vlan import TCI as Data_TCI
+from pcapkit.protocols.data.link.vlan import VLAN as Data_VLAN
+from pcapkit.protocols.link.link import Link
+from pcapkit.protocols.schema.link.vlan import TCI as Schema_TCI
+from pcapkit.protocols.schema.link.vlan import VLAN as Schema_VLAN
+from pcapkit.utilities.exceptions import UnsupportedCall
+
+if TYPE_CHECKING:
+    from enum import IntEnum as StdlibEnum
+    from typing import Any, NoReturn, Optional, Type
+
+    from aenum import IntEnum as AenumEnum
+    from typing_extensions import Literal
+
+    from pcapkit.protocols.protocol import ProtocolBase as Protocol
+    from pcapkit.protocols.schema.link.vlan import TCIType
+    from pcapkit.protocols.schema.schema import Schema
+
+__all__ = ['VLAN']
+
+
+class VLAN(Link[Data_VLAN, Schema_VLAN],
+           schema=Schema_VLAN, data=Data_VLAN):
+    """This class implements 802.1Q Customer VLAN Tag Type."""
+
+    ##########################################################################
+    # Properties.
+    ##########################################################################
+
+    @property
+    def name(self) -> 'Literal["802.1Q Customer VLAN Tag Type"]':
+        """Name of current protocol."""
+        return '802.1Q Customer VLAN Tag Type'
+
+    @property
+    def alias(self) -> 'Literal["802.1Q"]':
+        """Acronym of corresponding protocol."""
+        return '802.1Q'
+
+    @property
+    def info_name(self) -> 'Literal["c_tag"]':
+        """Key name of the :attr:`info` dict."""
+        return 'c_tag'
+
+    @property
+    def length(self) -> 'Literal[4]':
+        """Header length of current protocol."""
+        return 4
+
+    @property
+    def protocol(self) -> 'Enum_EtherType':
+        """Name of next layer protocol."""
+        return self._info.type
+
+    ##########################################################################
+    # Methods.
+    ##########################################################################
+
+    def read(self, length: 'Optional[int]' = None, **kwargs: 'Any') -> 'Data_VLAN':  # pylint: disable=unused-argument
+        """Read 802.1Q Customer VLAN Tag Type.
+
+        Structure of 802.1Q Customer VLAN Tag Type [`IEEE 802.1Q <https://standards.ieee.org/ieee/802.1Q/6844/>`__]:
+
+        .. code-block:: text
+
+            0                   1                   2                   3
+            0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+           +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+           |              TCI              |                               |
+           |-------------------------------|                               |
+           |  P  |D|                       |             Type              |
+           |  C  |E|          VID          |                               |
+           |  P  |I|                       |                               |
+           +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+        Args:
+            length: Length of packet data.
+            **kwargs: Arbitrary keyword arguments.
+
+        Returns:
+            Parsed packet data.
+
+        """
+        if length is None:
+            length = len(self)
+        schema = self.__header__
+
+        tci = schema.tci
+        vlan = Data_VLAN(
+            tci=Data_TCI(
+                pcp=Enum_PriorityLevel.get(tci['pcp']),
+                dei=bool(tci['pcp']),
+                vid=int(tci['vid']),
+            ),
+            type=schema.type,
+        )
+        return self._decode_next_layer(vlan, schema.type, length - self.length)
+
+    def make(self,
+             tci: 'Optional[Schema_TCI | TCIType]' = None,
+             pcp: 'Enum_PriorityLevel | StdlibEnum | AenumEnum | str | int' = Enum_PriorityLevel.BE,
+             pcp_default: 'Optional[int]' = None,
+             pcp_namespace: 'Optional[dict[str, int] | dict[int, str] | Type[StdlibEnum] | Type[AenumEnum]]' = None,  # pylint: disable=line-too-long
+             pcp_reversed: 'bool' = False,
+             dei: 'bool' = False,
+             vid: 'int' = 0,
+             type: 'Enum_EtherType | StdlibEnum | AenumEnum | str | int' = Enum_EtherType.Internet_Protocol_version_4,
+             type_default: 'Optional[int]' = None,
+             type_namespace: 'Optional[dict[str, int] | dict[int, str] | Type[StdlibEnum] | Type[AenumEnum]]' = None,  # pylint: disable=line-too-long
+             type_reversed: 'bool' = False,
+             payload: 'bytes | Protocol | Schema' = b'',
+             **kwargs: 'Any') -> 'Schema_VLAN':
+        """Make (construct) packet data.
+
+        Args:
+            tci: TCI field.
+            pcp: Priority Code Point (PCP) field.
+            pcp_default: Default value of PCP field.
+            pcp_namespace: Namespace of PCP field.
+            pcp_reversed: Reversed flag of PCP field.
+            dei: Drop Eligible Indicator (DEI) field.
+            vid: VLAN Identifier (VID) field.
+            type: EtherType field.
+            type_default: Default value of EtherType field.
+            type_namespace: Namespace of EtherType field.
+            type_reversed: Reversed flag of EtherType field.
+            payload: Payload field.
+            **kwargs: Arbitrary keyword arguments.
+
+        Returns:
+            Constructed packet data.
+
+        """
+        if tci is not None:
+            pcp_value = tci['pcp']
+            dei = tci['dei']  # type: ignore[assignment]
+            vid = tci['vid']
+        else:
+            pcp_value = self._make_index(pcp, pcp_default, namespace=pcp_namespace,
+                                         reversed=pcp_reversed, pack=False)
+
+        type_value = self._make_index(type, type_default, namespace=type_namespace,
+                                      reversed=type_reversed, pack=False)
+
+        return Schema_VLAN(
+            tci={
+                'pcp': pcp_value,
+                'dei': dei,
+                'vid': vid,
+            },
+            type=type_value,  # type: ignore[arg-type]
+            payload=payload,
+        )
+
+    ##########################################################################
+    # Data models.
+    ##########################################################################
+
+    def __length_hint__(self) -> 'Literal[4]':
+        """Return an estimated length for the object."""
+        return 4
+
+    @classmethod
+    def __index__(cls) -> 'NoReturn':  # pylint: disable=invalid-index-returned
+        """Numeral registry index of the protocol.
+
+        Raises:
+            UnsupportedCall: This protocol has no registry entry.
+
+        """
+        raise UnsupportedCall(f'{cls.__name__!r} object cannot be interpreted as an integer')
+
+    ##########################################################################
+    # Utilities.
+    ##########################################################################
+
+    @classmethod
+    def _make_data(cls, data: 'Data_VLAN') -> 'dict[str, Any]':  # type: ignore[override]
+        """Create key-value pairs from ``data`` for protocol construction.
+
+        Args:
+            data: protocol data
+
+        Returns:
+            Key-value pairs for protocol construction.
+
+        """
+        return {
+            'tci': {
+                'pcp': data.tci.pcp,
+                'dei': data.tci.dei,
+                'vid': data.tci.vid,
+            },
+            'type': data.type,
+            'payload': cls._make_payload(data),
+        }

pcapkit/protocols/misc/__init__.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-wildcard-import
+"""Auxiliary Protocols
+=========================
+
+.. module:: pcapkit.protocols.misc
+
+:mod:`pcapkit.protocols.misc` contains the auxiliary protocol implementations.
+Such includes the :class:`~pcapkit.protocols.misc.raw.Raw` class for not-supported
+protocols, the :class:`~pcapkit.protocols.misc.null.NoPayload` class for
+indication of empty payload, and PCAP header classes.
+
+"""
+
+# PCAP Headers
+from pcapkit.protocols.misc.pcap import *
+
+# PCAPNG Format
+from pcapkit.protocols.misc.pcapng import *
+
+# Miscellaneous Classes for Protocols
+from pcapkit.protocols.misc.raw import Raw
+from pcapkit.protocols.misc.null import NoPayload
+
+__all__ = [
+    # PCAP Headers
+    'Header', 'Frame',
+
+    # PCAPNG Format
+    'PCAPNG',
+
+    # No Payload
+    'NoPayload',
+
+    # Raw Packet
+    'Raw',
+]