pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/protocols/data/link/l2tp.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+"""data models for L2TP protocol"""
+
+from typing import TYPE_CHECKING
+
+from pcapkit.corekit.infoclass import info_final
+from pcapkit.protocols.data.data import Data
+from pcapkit.protocols.data.protocol import Protocol
+
+if TYPE_CHECKING:
+    from typing import Optional
+
+    from pcapkit.const.l2tp.type import Type
+
+__all__ = ['L2TP']
+
+
+@info_final
+class Flags(Data):
+    """Data model for L2TP flags and version info."""
+
+    #: Type.
+    type: 'Type'
+    #: Length.
+    len: 'bool'
+    #: Sequence.
+    seq: 'bool'
+    #: Offset.
+    offset: 'bool'
+    #: Priority.
+    prio: 'bool'
+
+    if TYPE_CHECKING:
+        def __init__(self, type: 'Type', len: 'bool', seq: 'bool', offset: 'bool', prio: 'bool') -> 'None': ...  # pylint: disable=unused-argument,super-init-not-called,redefined-builtin,multiple-statements
+
+
+@info_final
+class L2TP(Protocol):
+    """Data model for L2TP packet."""
+
+    #: Flags and version info.
+    flags: 'Flags'
+    #: Version.
+    version: 'int'
+    #: Length.
+    length: 'Optional[int]'
+    #: Tunnel ID.
+    tunnelid: 'int'
+    #: Session ID.
+    sessionid: 'int'
+    #: Sequence Number.
+    ns: 'Optional[int]'
+    #: Next Sequence Number.
+    nr: 'Optional[int]'
+    #: Offset Size.
+    offset: 'Optional[int]'
+
+    if TYPE_CHECKING:
+        #: Header length.
+        hdr_len: 'int'
+
+        def __init__(self, flags: 'Flags', version: 'int', length: 'Optional[int]', tunnelid: 'int', sessionid: 'int',
+                     ns: 'Optional[int]', nr: 'Optional[int]', offset: 'Optional[int]') -> 'None': ...  # pylint: disable=unused-argument,super-init-not-called,redefined-builtin,multiple-statements,line-too-long

pcapkit/protocols/data/link/ospf.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+"""data models for OSPF protocol"""
+
+from typing import TYPE_CHECKING
+
+from pcapkit.corekit.infoclass import info_final
+from pcapkit.protocols.data.data import Data
+from pcapkit.protocols.data.protocol import Protocol
+
+if TYPE_CHECKING:
+    from ipaddress import IPv4Address
+
+    from pcapkit.const.ospf.authentication import Authentication
+    from pcapkit.const.ospf.packet import Packet
+
+__all__ = ['OSPF', 'CrytographicAuthentication']
+
+
+@info_final
+class CrytographicAuthentication(Data):
+    """Data model for OSPF crytographic authentication."""
+
+    #: Key ID.
+    key_id: 'int'
+    #: Authentication data length.
+    len: 'int'
+    #: Cryptographic sequence number.
+    seq: 'int'
+
+    if TYPE_CHECKING:
+        def __init__(self, key_id: 'int', len: 'int', seq: 'int') -> 'None': ...  # pylint: disable=unused-argument,super-init-not-called,multiple-statements,redefined-builtin
+
+
+@info_final
+class OSPF(Protocol):
+    """Data model for OSPF packet."""
+
+    #: Version number.
+    version: 'int'
+    #: Type.
+    type: 'Packet'
+    #: Packet length (header included).
+    len: 'int'
+    #: Router ID.
+    router_id: 'IPv4Address'
+    #: Area ID.
+    area_id: 'IPv4Address'
+    #: Checksum.
+    chksum: 'bytes'
+    #: Authentication type.
+    autype: 'Authentication'
+
+    if TYPE_CHECKING:
+        #: Authentication.
+        auth: 'bytes | CrytographicAuthentication'
+
+        def __init__(self, version: 'int', type: 'Packet', len: 'int', router_id: 'IPv4Address',
+                     area_id: 'IPv4Address', chksum: 'bytes', autype: 'Authentication') -> 'None': ...  # pylint: disable=super-init-not-called,unused-argument,line-too-long,multiple-statements,redefined-builtin

pcapkit/protocols/data/link/vlan.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+"""data models for 802.1Q customer VLAN tag type"""
+
+from typing import TYPE_CHECKING
+
+from pcapkit.corekit.infoclass import info_final
+from pcapkit.protocols.data.data import Data
+from pcapkit.protocols.data.protocol import Protocol
+
+if TYPE_CHECKING:
+    from pcapkit.const.reg.ethertype import EtherType
+    from pcapkit.const.vlan.priority_level import PriorityLevel
+
+__all__ = ['VLAN', 'TCI']
+
+
+@info_final
+class TCI(Data):
+    """Data model for tag control information."""
+
+    #: Priority code point.
+    pcp: 'PriorityLevel'
+    #: Drop eligible indicator.
+    dei: 'bool'
+    #: VLAN identifier.
+    vid: 'int'
+
+    if TYPE_CHECKING:
+        def __init__(self, pcp: 'PriorityLevel', dei: 'bool', vid: 'int') -> 'None': ...  # pylint: disable=unused-argument,super-init-not-called,multiple-statements
+
+
+@info_final
+class VLAN(Protocol):
+    """Data model for 802.1Q customer VLAN tag type."""
+
+    #: Tag control information.
+    tci: 'TCI'
+    #: Protocol (Internet Layer).
+    type: 'EtherType'
+
+    if TYPE_CHECKING:
+        def __init__(self, tci: 'TCI', type: 'EtherType') -> 'None': ...  # pylint: disable=unused-argument,super-init-not-called,multiple-statements,redefined-builtin

pcapkit/protocols/data/misc/__init__.py

@@ -0,0 +1,109 @@
+# -*- coding: utf-8 -*-
+"""data models for utility protocols"""
+
+# PCAP file headers
+from pcapkit.protocols.data.misc.pcap import *
+
+# PCAP-NG file format
+from pcapkit.protocols.data.misc.pcapng import UnknownSecrets as PCAPNG_UnknownSecrets
+from pcapkit.protocols.data.misc.pcapng import PCAPNG
+from pcapkit.protocols.data.misc.pcapng import CommentOption as PCAPNG_CommentOption
+from pcapkit.protocols.data.misc.pcapng import CustomBlock as PCAPNG_CustomBlock
+from pcapkit.protocols.data.misc.pcapng import CustomOption as PCAPNG_CustomOption
+from pcapkit.protocols.data.misc.pcapng import \
+    DecryptionSecretsBlock as PCAPNG_DecryptionSecretsBlock
+from pcapkit.protocols.data.misc.pcapng import DSBSecrets as PCAPNG_DSBSecrets
+from pcapkit.protocols.data.misc.pcapng import EndOfOption as PCAPNG_EndOfOption
+from pcapkit.protocols.data.misc.pcapng import EndRecord as PCAPNG_EndRecord
+from pcapkit.protocols.data.misc.pcapng import EnhancedPacketBlock as PCAPNG_EnhancedPacketBlock
+from pcapkit.protocols.data.misc.pcapng import EPB_DropCountOption as PCAPNG_EPB_DropCountOption
+from pcapkit.protocols.data.misc.pcapng import EPB_FlagsOption as PCAPNG_EPB_FlagsOption
+from pcapkit.protocols.data.misc.pcapng import EPB_HashOption as PCAPNG_EPB_HashOption
+from pcapkit.protocols.data.misc.pcapng import EPB_PacketIDOption as PCAPNG_EPB_PacketIDOption
+from pcapkit.protocols.data.misc.pcapng import EPB_QueueOption as PCAPNG_EPB_QueueOption
+from pcapkit.protocols.data.misc.pcapng import EPB_VerdictOption as PCAPNG_EPB_VerdictOption
+from pcapkit.protocols.data.misc.pcapng import IF_DescriptionOption as PCAPNG_IF_DescriptionOption
+from pcapkit.protocols.data.misc.pcapng import IF_EUIAddrOption as PCAPNG_IF_EUIAddrOption
+from pcapkit.protocols.data.misc.pcapng import IF_FCSLenOption as PCAPNG_IF_FCSLenOption
+from pcapkit.protocols.data.misc.pcapng import IF_FilterOption as PCAPNG_IF_FilterOption
+from pcapkit.protocols.data.misc.pcapng import IF_HardwareOption as PCAPNG_IF_HardwareOption
+from pcapkit.protocols.data.misc.pcapng import IF_IPv4AddrOption as PCAPNG_IF_IPv4AddrOption
+from pcapkit.protocols.data.misc.pcapng import IF_IPv6AddrOption as PCAPNG_IF_IPv6AddrOption
+from pcapkit.protocols.data.misc.pcapng import IF_MACAddrOption as PCAPNG_IF_MACAddrOption
+from pcapkit.protocols.data.misc.pcapng import IF_NameOption as PCAPNG_IF_NameOption
+from pcapkit.protocols.data.misc.pcapng import IF_OSOption as PCAPNG_IF_OSOption
+from pcapkit.protocols.data.misc.pcapng import IF_RxSpeedOption as PCAPNG_IF_RxSpeedOption
+from pcapkit.protocols.data.misc.pcapng import IF_SpeedOption as PCAPNG_IF_SpeedOption
+from pcapkit.protocols.data.misc.pcapng import IF_TSOffsetOption as PCAPNG_IF_TSOffsetOption
+from pcapkit.protocols.data.misc.pcapng import IF_TSResolOption as PCAPNG_IF_TSResolOption
+from pcapkit.protocols.data.misc.pcapng import IF_TxSpeedOption as PCAPNG_IF_TxSpeedOption
+from pcapkit.protocols.data.misc.pcapng import IF_TZoneOption as PCAPNG_IF_TZoneOption
+from pcapkit.protocols.data.misc.pcapng import \
+    InterfaceDescriptionBlock as PCAPNG_InterfaceDescriptionBlock
+from pcapkit.protocols.data.misc.pcapng import \
+    InterfaceStatisticsBlock as PCAPNG_InterfaceStatisticsBlock
+from pcapkit.protocols.data.misc.pcapng import IPv4Record as PCAPNG_IPv4Record
+from pcapkit.protocols.data.misc.pcapng import IPv6Record as PCAPNG_IPv6Record
+from pcapkit.protocols.data.misc.pcapng import ISB_EndTimeOption as PCAPNG_ISB_EndTimeOption
+from pcapkit.protocols.data.misc.pcapng import \
+    ISB_FilterAcceptOption as PCAPNG_ISB_FilterAcceptOption
+from pcapkit.protocols.data.misc.pcapng import ISB_IFDropOption as PCAPNG_ISB_IFDropOption
+from pcapkit.protocols.data.misc.pcapng import ISB_IFRecvOption as PCAPNG_ISB_IFRecvOption
+from pcapkit.protocols.data.misc.pcapng import ISB_OSDropOption as PCAPNG_ISB_OSDropOption
+from pcapkit.protocols.data.misc.pcapng import ISB_StartTimeOption as PCAPNG_ISB_StartTimeOption
+from pcapkit.protocols.data.misc.pcapng import ISB_UsrDelivOption as PCAPNG_ISB_UsrDelivOption
+from pcapkit.protocols.data.misc.pcapng import NameResolutionBlock as PCAPNG_NameResolutionBlock
+from pcapkit.protocols.data.misc.pcapng import NameResolutionRecord as PCAPNG_NameResolutionRecord
+from pcapkit.protocols.data.misc.pcapng import NS_DNSIP4AddrOption as PCAPNG_NS_DNSIP4AddrOption
+from pcapkit.protocols.data.misc.pcapng import NS_DNSIP6AddrOption as PCAPNG_NS_DNSIP6AddrOption
+from pcapkit.protocols.data.misc.pcapng import NS_DNSNameOption as PCAPNG_NS_DNSNameOption
+from pcapkit.protocols.data.misc.pcapng import Option as PCAPNG_Option
+from pcapkit.protocols.data.misc.pcapng import SectionHeaderBlock as PCAPNG_SectionHeaderBlock
+from pcapkit.protocols.data.misc.pcapng import SimplePacketBlock as PCAPNG_SimplePacketBlock
+from pcapkit.protocols.data.misc.pcapng import \
+    SystemdJournalExportBlock as PCAPNG_SystemdJournalExportBlock
+from pcapkit.protocols.data.misc.pcapng import TLSKeyLog as PCAPNG_TLSKeyLog
+from pcapkit.protocols.data.misc.pcapng import UnknownBlock as PCAPNG_UnknownBlock
+from pcapkit.protocols.data.misc.pcapng import UnknownOption as PCAPNG_UnknownOption
+from pcapkit.protocols.data.misc.pcapng import UnknownRecord as PCAPNG_UnknownRecord
+from pcapkit.protocols.data.misc.pcapng import UnknownSecrets as PCAPNG_UnknownSecrets
+from pcapkit.protocols.data.misc.pcapng import WireGuardKeyLog as PCAPNG_WireGuardKeyLog
+from pcapkit.protocols.data.misc.pcapng import ZigBeeAPSKey as PCAPNG_ZigBeeAPSKey
+from pcapkit.protocols.data.misc.pcapng import ZigBeeNWKKey as PCAPNG_ZigBeeNWKKey
+
+# misc protocols
+from pcapkit.protocols.data.misc.raw import Raw
+from pcapkit.protocols.data.misc.null import NoPayload
+
+__all__ = [
+    # PCAP file headers
+    'PCAP_Header', 'PCAP_MagicNumber',
+    'PCAP_Frame', 'PCAP_FrameInfo',
+
+    # PCAP-NG file format
+    'PCAPNG',
+    'PCAPNG_Option', 'PCAPNG_UnknownOption',
+    'PCAPNG_EndOfOption', 'PCAPNG_CommentOption', 'PCAPNG_CustomOption',
+    'PCAPNG_IF_NameOption', 'PCAPNG_IF_DescriptionOption', 'PCAPNG_IF_IPv4AddrOption', 'PCAPNG_IF_IPv6AddrOption',
+    'PCAPNG_IF_MACAddrOption', 'PCAPNG_IF_EUIAddrOption', 'PCAPNG_IF_SpeedOption', 'PCAPNG_IF_TSResolOption',
+    'PCAPNG_IF_TZoneOption', 'PCAPNG_IF_FilterOption', 'PCAPNG_IF_OSOption', 'PCAPNG_IF_FCSLenOption',
+    'PCAPNG_IF_TSOffsetOption', 'PCAPNG_IF_HardwareOption', 'PCAPNG_IF_TxSpeedOption', 'PCAPNG_IF_RxSpeedOption',
+    'PCAPNG_EPB_FlagsOption', 'PCAPNG_EPB_HashOption', 'PCAPNG_EPB_DropCountOption', 'PCAPNG_EPB_PacketIDOption',
+    'PCAPNG_EPB_QueueOption', 'PCAPNG_EPB_VerdictOption',
+    'PCAPNG_NS_DNSNameOption', 'PCAPNG_NS_DNSIP4AddrOption', 'PCAPNG_NS_DNSIP6AddrOption',
+    'PCAPNG_ISB_StartTimeOption', 'PCAPNG_ISB_EndTimeOption', 'PCAPNG_ISB_IFRecvOption', 'PCAPNG_ISB_IFDropOption',
+    'PCAPNG_ISB_FilterAcceptOption', 'PCAPNG_ISB_OSDropOption', 'PCAPNG_ISB_UsrDelivOption',
+    'PCAPNG_NameResolutionRecord', 'PCAPNG_UnknownRecord', 'PCAPNG_EndRecord', 'PCAPNG_IPv4Record', 'PCAPNG_IPv6Record',
+    'PCAPNG_DSBSecrets', 'PCAPNG_UnknownSecrets', 'PCAPNG_TLSKeyLog', 'PCAPNG_WireGuardKeyLog', 'PCAPNG_ZigBeeNWKKey',
+    'PCAPNG_ZigBeeAPSKey',
+    'PCAPNG_UnknownBlock', 'PCAPNG_SectionHeaderBlock', 'PCAPNG_InterfaceDescriptionBlock',
+    'PCAPNG_EnhancedPacketBlock', 'PCAPNG_SimplePacketBlock', 'PCAPNG_NameResolutionBlock',
+    'PCAPNG_InterfaceStatisticsBlock', 'PCAPNG_SystemdJournalExportBlock', 'PCAPNG_DecryptionSecretsBlock',
+    'PCAPNG_CustomBlock',
+
+    # No Payload
+    'NoPayload',
+
+    # Raw Packet
+    'Raw',
+]

pcapkit/protocols/data/misc/null.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+"""data models for no-payload packet"""
+
+from pcapkit.corekit.infoclass import info_final
+from pcapkit.protocols.data.protocol import Protocol
+
+__all__ = ['NoPayload']
+
+
+@info_final
+class NoPayload(Protocol):
+    """No-payload packet is an empty packet."""
+
+    # NOTE: We add this method for both type annotation and to mark that this
+    # class accepts no arguments at runtime, since :class:`Info` explicitly
+    # skipped those whose :attr:`__annotations__` is empty :obj:`dict`.
+    def __init__(self) -> 'None':  # pylint: disable=super-init-not-called
+        pass

pcapkit/protocols/data/misc/pcap/__init__.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+"""data models for PCAP file headers"""
+
+# Global header
+from pcapkit.protocols.data.misc.pcap.header import Header as PCAP_Header
+from pcapkit.protocols.data.misc.pcap.header import MagicNumber as PCAP_MagicNumber
+
+# Frame header
+from pcapkit.protocols.data.misc.pcap.frame import Frame as PCAP_Frame
+from pcapkit.protocols.data.misc.pcap.frame import FrameInfo as PCAP_FrameInfo
+
+__all__ = [
+    # Global header
+    'PCAP_Header', 'PCAP_MagicNumber',
+
+    # Frame header
+    'PCAP_Frame', 'PCAP_FrameInfo',
+]

pcapkit/protocols/data/misc/pcap/frame.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+"""data models for frame header of PCAP file"""
+
+from typing import TYPE_CHECKING
+
+from pcapkit.corekit.infoclass import info_final
+from pcapkit.protocols.data.data import Data
+from pcapkit.protocols.data.protocol import Protocol
+
+if TYPE_CHECKING:
+    from datetime import datetime
+    from decimal import Decimal
+
+__all__ = ['Frame', 'FrameInfo']
+
+
+@info_final
+class FrameInfo(Data):
+    """Frame metadata information."""
+
+    #: Timestamp seconds.
+    ts_sec: 'int'
+    #: Timestamp microseconds.
+    ts_usec: 'int'
+    #: Number of octets of packet saved in file.
+    incl_len: 'int'
+    #: Actual length of packet.
+    orig_len: 'int'
+
+    if TYPE_CHECKING:
+        def __init__(self, ts_sec: 'int', ts_usec: 'int', incl_len: 'int', orig_len: 'int') -> 'None': ...  # pylint: disable=unused-argument,multiple-statements,super-init-not-called
+
+
+@info_final
+class Frame(Protocol):
+    """Frame header of PCAP file."""
+
+    #: Metadata information.
+    frame_info: 'FrameInfo'
+    #: Timestamp instance.
+    time: 'datetime'
+    #: Frame index.
+    number: 'int'
+    #: UNIX timestamp.
+    time_epoch: 'Decimal'
+    #: Number of octets of packet saved in file.
+    len: 'int'
+    #: Actual length of packet.
+    cap_len: 'int'
+
+    if TYPE_CHECKING:
+        #: Protocol chain.
+        protocols: 'str'
+
+        def __init__(self, frame_info: 'FrameInfo', time: 'datetime', number: 'int', time_epoch: 'Decimal',
+                     len: 'int', cap_len: 'int') -> 'None': ...  # pylint: disable=unused-argument,multiple-statements,super-init-not-called,line-too-long,redefined-builtin

pcapkit/protocols/data/misc/pcap/header.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+"""data models for global header of PCAP file"""
+
+from typing import TYPE_CHECKING
+
+from pcapkit.corekit.infoclass import info_final
+from pcapkit.protocols.data.data import Data
+from pcapkit.protocols.data.protocol import Protocol
+
+if TYPE_CHECKING:
+    from typing_extensions import Literal
+
+    from pcapkit.const.reg.linktype import LinkType
+    from pcapkit.corekit.version import VersionInfo
+
+__all__ = ['Header', 'MagicNumber']
+
+
+@info_final
+class MagicNumber(Data):
+    """Magic number of PCAP file."""
+
+    #: Magic number sequence.
+    data: 'bytes'
+    #: Byte order.
+    byteorder: 'Literal["big", "little"]'
+    #: Nanosecond-timestamp resolution flag.
+    nanosecond: 'bool'
+
+    if TYPE_CHECKING:
+        def __init__(self, data: 'bytes', byteorder: 'Literal["big", "little"]', nanosecond: 'bool') -> 'None': ...  # pylint: disable=unused-argument,super-init-not-called,multiple-statements
+
+
+@info_final
+class Header(Protocol):
+    """Global header of PCAP file."""
+
+    #: Magic number.
+    magic_number: 'MagicNumber'
+    #: Version number.
+    version: 'VersionInfo'
+    #: GMT to local correction.
+    thiszone: 'int'
+    #: Accuracy of timestamps.
+    sigfigs: 'int'
+    #: Max length of captured packets, in octets.
+    snaplen: 'int'
+    #: Data link type.
+    network: 'LinkType'
+
+    if TYPE_CHECKING:
+        def __init__(self, magic_number: 'MagicNumber', version: 'VersionInfo',  # pylint: disable=unused-argument,super-init-not-called,multiple-statements
+                     thiszone: 'int', sigfigs: 'int', snaplen: 'int', network: 'LinkType') -> 'None': ...  # pylint: disable=unused-argument