pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/__init__.py

@@ -0,0 +1,126 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=wrong-import-position,unused-import,unused-wildcard-import
+"""Stream PCAP File Extractor
+================================
+
+.. module:: pcapkit
+
+:mod:`pcapkit` is an independent open source library, using only
+`DictDumper`_ as its formatted output dumper.
+
+.. _DictDumper: https://dictdumper.jarryshaw.me
+
+Unlike popular PCAP file extractors, such as `Scapy`_,
+`DPKT`_, `PyShark`_, and etc, :mod:`pcapkit` uses streaming
+strategy to read input files. That is to read frame by
+frame, decrease occupation on memory, as well as enhance
+efficiency in some way.
+
+.. _Scapy: https://scapy.net
+.. _DPKT: https://dpkt.readthedocs.io
+.. _PyShark: https://kiminewt.github.io/pyshark
+
+In :mod:`pcapkit`, all files can be described as following eight
+different components.
+
+- Interface (:mod:`pcapkit.interface`)
+
+  User interface for the :mod:`pcapkit` library, which
+  standardises and simplifies the usage of this library.
+
+- Foundation (:mod:`pcapkit.foundation`)
+
+  Synthesises file I/O and protocol analysis, coordinates
+  information exchange in all network layers, as well as
+  provides the foundamental functions for :mod:`pcapkit`.
+
+- Protocols (:mod:`pcapkit.protocols`)
+
+  Collection of all protocol family, with detailed
+  implementation and methods.
+
+- Utilities (:mod:`pcapkit.utilities`)
+
+  Auxiliary functions and tools for :mod:`pcapkit`.
+
+- CoreKit (:mod:`pcapkit.corekit`)
+
+  Core utilities for :mod:`pcapkit` implementation, mainly
+  for internal data structure and processing.
+
+- ToolKit (:mod:`pcapkit.toolkit`)
+
+  Auxiliary tools for :mod:`pcapkit` to support the multiple
+  extraction engines with a unified interface.
+
+- DumpKit (:mod:`pcapkit.dumpkit`)
+
+  File output formatters for :mod:`pcapkit`.
+
+- Constants (:mod:`pcapkit.const`)
+
+  Constant enumerations used in :mod:`pcapkit` for protocol
+  family extraction and representation.
+
+"""
+###############################################################################
+# conda ``_extern`` module support
+
+import os
+import sys
+
+_extern = os.path.join(os.path.dirname(os.path.realpath(__file__)), '_extern')
+if os.path.exists(_extern):
+    sys.path.append(_extern)
+
+###############################################################################
+
+import warnings
+
+import tbtrim
+
+from pcapkit.utilities.exceptions import BaseError
+from pcapkit.utilities.logging import DEVMODE
+from pcapkit.utilities.warnings import DevModeWarning
+
+# set up sys.excepthook
+if DEVMODE:
+    warnings.showwarning('development mode enabled', DevModeWarning,
+                         filename=__file__, lineno=0,
+                         line=f"PCAPKIT_DEVMODE={os.environ.get('PCAPKIT_DEVMODE', '1')}")
+else:
+    ROOT = os.path.dirname(os.path.realpath(__file__))
+    tbtrim.set_trim_rule(lambda filename: ROOT in os.path.realpath(filename),
+                         exception=BaseError, strict=False)
+
+from pcapkit.foundation.registry import *
+from pcapkit.interface import *
+from pcapkit.protocols import *
+from pcapkit.toolkit import *
+
+__all__ = [
+    'extract', 'reassemble', 'trace',                       # Interface Functions
+
+    'TREE', 'JSON', 'PLIST', 'PCAP',                        # Format Macros
+    'LINK', 'INET', 'TRANS', 'APP', 'RAW',                  # Layer Macros
+    'DPKT', 'Scapy', 'PyShark', 'PCAPKit',                  # Engine Macros
+
+    'LINKTYPE', 'ETHERTYPE', 'TRANSTYPE', 'APPTYPE',        # Protocol Numbers
+
+    'NoPayload',                                            # No Payload
+    'Raw',                                                  # Raw Packet
+
+    'ARP', 'Ethernet', 'L2TP', 'OSPF', 'RARP', 'VLAN',      # Link Layer
+
+    'AH', 'IP', 'IPsec', 'IPv4', 'IPv6', 'IPX',             # Internet Layer
+    'HIP', 'HOPOPT', 'IPv6_Frag', 'IPv6_Opts', 'IPv6_Route', 'MH',
+                                                            # IPv6 Extension Header
+
+    'TCP', 'UDP',                                           # Transport Layer
+
+    'FTP', 'FTP_DATA',                                      # Application Layer
+    'HTTP',
+]
+
+#: version number
+__version__ = '1.3.3.post1'

pcapkit/__main__.py

@@ -0,0 +1,138 @@
+# -*- coding: utf-8 -*-
+"""Command Line Tool
+=======================
+
+.. module:: pcapkit.__main__
+
+.. important::
+
+   This module requires ``emoji`` package to be installed.
+
+:mod:`pcapkit.__main__` was originally the module file of
+|jspcapy|_, which is now deprecated and merged with :mod:`pcapkit`.
+
+.. |jspcapy| replace:: ``jspcapy``
+.. _jspcapy: https://github.com/JarryShaw/jspcapy
+
+"""
+import argparse
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit import __version__
+from pcapkit.foundation.extraction import Extractor
+from pcapkit.interface import JSON, PLIST, TREE
+from pcapkit.utilities.compat import ModuleNotFoundError  # pylint: disable=redefined-builtin
+from pcapkit.utilities.exceptions import stacklevel
+from pcapkit.utilities.warnings import EmojiWarning, warn
+
+try:
+    import emoji
+except ModuleNotFoundError:
+    warn("dependency package 'emoji' not found",
+         EmojiWarning, stacklevel=stacklevel())
+
+__all__ = ['main']
+
+if TYPE_CHECKING:
+    from argparse import ArgumentParser
+
+
+def get_parser() -> 'ArgumentParser':
+    """CLI argument parser."""
+    parser = argparse.ArgumentParser(prog='pcapkit-cli',
+                                     description='PCAP file extractor and formatted dumper')
+    parser.add_argument('-V', '--version', action='version', version=__version__)
+    parser.add_argument('fin', metavar='input-file-name',
+                        help=('The name of input pcap file. If ".pcap" omits, '
+                              'it will be automatically appended. Use "-" to indicate '
+                              'reading from `stdin\'.'))
+    parser.add_argument('-o', '--output', action='store', metavar='file-name', dest='fout',
+                        help=('The name of input pcap file. If format extension '
+                              'omits, it will be automatically appended.'))
+    parser.add_argument('-f', '--format', action='store', metavar='format', dest='format',
+                        help=('Print a extraction report in the specified output '
+                              'format. Available are all formats supported by '
+                              'dictdumper, e.g.: json, plist, and tree.'))
+    parser.add_argument('-j', '--json', action='store_true', default=False,
+                        help=('Display extraction report as json. This will yield '
+                              '"raw" output that may be used by external tools. '
+                              'This option overrides all other options.'))
+    parser.add_argument('-p', '--plist', action='store_true', default=False,
+                        help=('Display extraction report as macOS Property List '
+                              '(plist). This will yield "raw" output that may be '
+                              'used by external tools. This option overrides all '
+                              'other options.'))
+    parser.add_argument('-t', '--tree', action='store_true', default=False,
+                        help=('Display extraction report as tree view text. This '
+                              'will yield "raw" output that may be used by external '
+                              'tools. This option overrides all other options.'))
+    parser.add_argument('-a', '--auto-extension', action='store_true', default=False,
+                        help='If output file extension omits, append automatically.')
+    parser.add_argument('-v', '--verbose', action='store_true', default=False,
+                        help='Show more information.')
+    parser.add_argument('-F', '--files', action='store_true', default=False,
+                        help='Split each frame into different files.')
+    parser.add_argument('-E', '--engine', action='store', dest='engine', default='default', metavar='PKG',
+                        help=('Indicate extraction engine. Note that except '
+                              'default or pcapkit engine, all other engines '
+                              'need support of corresponding packages.'))
+    parser.add_argument('-P', '--protocol', action='store', dest='protocol', default='null', metavar='PROTOCOL',
+                        help='Indicate extraction stops after which protocol.')
+    parser.add_argument('-L', '--layer', action='store', dest='layer', default='None', metavar='LAYER',
+                        help='Indicate extract frames until which layer.')
+    parser.add_argument('-B', '--buffer-save', action='store_true', default=False,
+                        help='Indicate if store buffer to file when reading from stdin.')
+    parser.add_argument('-O', '--buffer-path', action='store', metavar='file-name', dest='buffer_path',
+                        help=('The name of buffer storage file. If `--buffer-save` is set and this '
+                              'omits, it will be automatically assigned.'))
+    return parser
+
+
+def main() -> 'int':
+    """Entrypoint."""
+    parser = get_parser()
+    args = parser.parse_args()
+
+    if args.format:
+        fmt = args.format
+    elif args.json:
+        fmt = JSON
+    elif args.plist:
+        fmt = PLIST
+    elif args.tree:
+        fmt = TREE
+    else:
+        fmt = None
+
+    no_eof = args.fin == '-'
+    if args.fin == '-':
+        args.fin = sys.stdin.buffer
+
+    extractor = Extractor(store=False, auto=not args.verbose,
+                          fin=args.fin, fout=args.fout,
+                          files=args.files, format=fmt,
+                          layer=args.layer, protocol=args.protocol,
+                          engine=args.engine, extension=args.auto_extension,
+                          verbose=args.verbose, buffer_save=args.buffer_save,
+                          no_eof=no_eof, buffer_path=args.buffer_path)  # type: ignore[var-annotated]
+
+    if args.verbose:
+        try:
+            print(emoji.emojize(f":police_car_light: Loading file {extractor.input!r}"))
+        except (UnicodeEncodeError, NameError):  # may trigger if emoji not installed
+            print(f"[*] Loading file {extractor.input!r}")
+
+        for _ in extractor:
+            pass
+
+        try:
+            print(emoji.emojize(f":beer_mug: Report file{'s' if args.files else ''} stored in {extractor.output!r}"))
+        except (UnicodeEncodeError, NameError):  # may trigger if emoji not installed
+            print(f"[*] Report file{'s' if args.files else ''} stored in {extractor.output!r}")
+
+    return 0
+
+
+if __name__ == '__main__':
+    sys.exit(main())

pcapkit/all.py

@@ -0,0 +1,136 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import,unused-wildcard-import,wildcard-import
+"""Library Index
+===================
+
+.. module:: pcapkit.all
+
+:mod:`pcapkit` has defined various and numerous functions
+and classes, which have different features and purposes.
+To make a simple index for this library, :mod:`pcapkit.all`
+contains all things from :mod:`pcapkit`.
+
+"""
+from pcapkit import const
+from pcapkit.corekit import *
+from pcapkit.dumpkit import *
+from pcapkit.foundation import *
+from pcapkit.interface import *
+from pcapkit.protocols import *
+from pcapkit.toolkit import *
+from pcapkit.utilities import *  # pylint: disable=redefined-builtin
+
+#from pcapkit import vendor
+
+# tools for Scapy engine
+from pcapkit.toolkit.scapy import packet2chain as scapy_packet2chain  # isort: skip
+from pcapkit.toolkit.scapy import packet2dict as scapy_packet2dict  # isort: skip
+from pcapkit.toolkit.scapy import ipv4_reassembly as scapy_ipv4_reassembly  # isort: skip
+from pcapkit.toolkit.scapy import ipv6_reassembly as scapy_ipv6_reassembly  # isort: skip
+from pcapkit.toolkit.scapy import tcp_reassembly as scapy_tcp_reassembly  # isort: skip
+from pcapkit.toolkit.scapy import tcp_traceflow as scapy_tcp_traceflow  # isort: skip
+
+# tools for DPKT engine
+from pcapkit.toolkit.dpkt import ipv6_hdr_len as dpkt_ipv6_hdr_len  # isort: skip
+from pcapkit.toolkit.dpkt import packet2chain as dpkt_packet2chain  # isort: skip
+from pcapkit.toolkit.dpkt import packet2dict as dpkt_packet2dict  # isort: skip
+from pcapkit.toolkit.dpkt import ipv4_reassembly as dpkt_ipv4_reassembly  # isort: skip
+from pcapkit.toolkit.dpkt import ipv6_reassembly as dpkt_ipv6_reassembly  # isort: skip
+from pcapkit.toolkit.dpkt import tcp_reassembly as dpkt_tcp_reassembly  # isort: skip
+from pcapkit.toolkit.dpkt import tcp_traceflow as dpkt_tcp_traceflow  # isort: skip
+
+# tools for PyShark engine
+from pcapkit.toolkit.pyshark import packet2dict as pyshark_packet2dict  # isort: skip
+from pcapkit.toolkit.pyshark import tcp_traceflow as pyshark_tcp_traceflow  # isort: skip
+
+__all__ = [
+    # pcapkit.const
+    'const',
+
+    # # pcapkit.vendor
+    # 'vendor',
+
+    # pcapkit.corekit
+    'Info',                                                 # Info Class
+    'ProtoChain',                                           # ProtoChain
+    'VersionInfo',                                          # Version
+    'NumberField', 'Int32Field', 'UInt32Field',             # numeric protocol fields
+    'Int16Field', 'UInt16Field', 'Int64Field', 'UInt64Field',
+    'Int8Field', 'UInt8Field', 'EnumField',
+    'BytesField', 'StringField', 'BitField',                # text protocol fields
+    'PaddingField',
+    'ConditionalField', 'PayloadField', 'SchemaField',      # misc protocol fields
+    'ForwardMatchField', 'NoValueField',
+    'IPv4AddressField', 'IPv6AddressField',                 # IP address protocol fields
+    'IPv4InterfaceField', 'IPv6InterfaceField',
+    'ListField', 'OptionField',                             # container protocol fields
+    'SeekableReader',                                       # Seekable Reader
+
+    # pcapkit.dumpkit
+    'PCAPIO',                                               # PCAP Dumper
+    'NotImplementedIO',                                     # Simulated I/O
+
+    # pcapkit.foundation
+    'Extractor',                                            # Extraction
+    'TCP_TraceFlow',                                        # Trace Flow
+
+    # pcapkit.foundation.reassembly
+    'IPv4_Reassembly', 'IPv6_Reassembly',                   # IP Reassembly
+    'TCP_Reassembly',                                       # TCP Reassembly
+
+    # pcapkit.foundation.registry
+    'register_protocol',
+    'register_linktype',
+    'register_pcap', 'register_pcapng',
+    'register_ethertype',
+    'register_transtype',
+    'register_ipv4_option', 'register_hip_parameter', 'register_hopopt_option',
+    'register_ipv6_opts_option', 'register_ipv6_route_routing',
+    'register_mh_message', 'register_mh_option', 'register_mh_extension',
+    'register_apptype',
+    'register_tcp', 'register_udp',
+    'register_tcp_option', 'register_tcp_mp_option',
+    'register_http_frame',
+    'register_pcapng_block', 'register_pcapng_option', 'register_pcapng_secrets',
+    'register_pcapng_record',
+    'register_extractor_engine',
+    'register_dumper',
+    'register_extractor_dumper', 'register_traceflow_dumper',
+
+    # pcapkit.interface
+    'extract', 'reassemble', 'trace',                       # Interface Functions
+    'TREE', 'JSON', 'PLIST', 'PCAP',                        # Format Macros
+    'LINK', 'INET', 'TRANS', 'APP', 'RAW',                  # Layer Macros
+    'DPKT', 'Scapy', 'PyShark', 'PCAPKit',                  # Engine Macros
+
+    # pcapkit.protocols
+    'LINKTYPE', 'ETHERTYPE', 'TRANSTYPE', 'APPTYPE',        # Protocol Numbers
+    'Header', 'Frame',                                      # PCAP Headers
+    'NoPayload',                                            # No Payload
+    'Raw',                                                  # Raw Packet
+    'ARP', 'DRARP', 'Ethernet', 'InARP', 'L2TP', 'OSPF', 'RARP', 'VLAN',
+                                                            # Link Layer
+    'AH', 'IP', 'IPsec', 'IPv4', 'IPv6', 'IPX',             # Internet Layer
+    'HIP', 'HOPOPT', 'IPv6_Frag', 'IPv6_Opts', 'IPv6_Route', 'MH',
+                                                            # IPv6 Extension Header
+    'TCP', 'UDP',                                           # Transport Layer
+    'FTP', 'FTP_DATA',                                      # Application Layer
+    'HTTP',
+    'Schema', 'schema',                                     # Protocol Schema
+    'Data', 'data',                                         # Protocol Data
+
+    # pcapkit.toolkit
+    'ipv4_reassembly', 'ipv6_reassembly', 'tcp_reassembly', 'tcp_traceflow',
+    'pcapng_ipv4_reassembly', 'pcapng_ipv6_reassembly', 'pcapng_tcp_reassembly', 'pcapng_tcp_traceflow',
+    'pcapng_block2frame',                                   # default engine
+    'dpkt_ipv6_hdr_len', 'dpkt_packet2chain', 'dpkt_packet2dict',
+    'dpkt_ipv4_reassembly', 'dpkt_ipv6_reassembly', 'dpkt_tcp_reassembly', 'dpkt_tcp_traceflow',
+                                                            # DPKT engine
+    'pyshark_packet2dict', 'pyshark_tcp_traceflow',         # PyShark engine
+    'scapy_packet2chain', 'scapy_packet2dict',
+    'scapy_ipv4_reassembly', 'scapy_ipv6_reassembly', 'scapy_tcp_reassembly', 'scapy_tcp_traceflow',
+                                                            # Scapy engine
+
+    # pcapkit.utilities
+    #'beholder_ng', 'seekset_ng',                            # Decorators
+]

pcapkit/const/__init__.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import, unused-wildcard-import
+"""Constant Enumerations
+===========================
+
+This module contains all constant enumerations of :mod:`pcapkit`, which are
+automatically generated from the :mod:`pcapkit.vendor` module.
+
+"""
+
+# IANA registration
+from pcapkit.const.reg import *
+
+# Miscellanous
+from pcapkit.const.pcapng import *
+
+# per protocol
+from pcapkit.const.arp import *
+from pcapkit.const.ftp import *
+from pcapkit.const.hip import *
+from pcapkit.const.http import *
+from pcapkit.const.ipv4 import *
+from pcapkit.const.ipv6 import *
+from pcapkit.const.ipx import *
+from pcapkit.const.l2tp import *
+from pcapkit.const.mh import *
+from pcapkit.const.ospf import *
+from pcapkit.const.tcp import *
+from pcapkit.const.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_Status',
+    # 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/const/arp/__init__.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.link.arp.ARP` Constant Enumerations
+=====================================================================
+
+This module contains all constant enumerations of :class:`~pcapkit.protocols.link.arp.ARP`
+and :class:`~pcapkit.protocols.link.rarp.RARP` implementations. Available
+enumerations include:
+
+.. list-table::
+
+   * - :class:`ARP_Hardware <pcapkit.const.arp.hardware.Hardware>`
+     - ARP Hardware Types [*]_
+   * - :class:`ARP_Operation <pcapkit.const.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.const.arp.hardware import Hardware as ARP_Hardware
+from pcapkit.const.arp.operation import Operation as ARP_Operation
+
+__all__ = ['ARP_Hardware', 'ARP_Operation']

pcapkit/const/arp/hardware.py

@@ -0,0 +1,181 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Hardware Types
+====================
+
+.. module:: pcapkit.const.arp.hardware
+
+This module contains the constant enumeration for **Hardware Types**,
+which is automatically generated from :class:`pcapkit.vendor.arp.hardware.Hardware`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['Hardware']
+
+
+class Hardware(IntEnum):
+    """[Hardware] Hardware Types [:rfc:`826`][:rfc:`5494`]"""
+
+    #: Reserved [:rfc:`5494`]
+    Reserved_0 = 0
+
+    #: Ethernet (10Mb) [Jon Postel]
+    Ethernet = 1
+
+    #: Experimental Ethernet (3Mb) [Jon Postel]
+    Experimental_Ethernet = 2
+
+    #: Amateur Radio AX.25 [Philip Koch]
+    Amateur_Radio_AX_25 = 3
+
+    #: Proteon ProNET Token Ring [Avri Doria]
+    Proteon_ProNET_Token_Ring = 4
+
+    #: Chaos [Gill Pratt]
+    Chaos = 5
+
+    #: IEEE 802 Networks [Jon Postel]
+    IEEE_802_Networks = 6
+
+    #: ARCNET [:rfc:`1201`]
+    ARCNET = 7
+
+    #: Hyperchannel [Jon Postel]
+    Hyperchannel = 8
+
+    #: Lanstar [Tom Unger]
+    Lanstar = 9
+
+    #: Autonet Short Address [Mike Burrows]
+    Autonet_Short_Address = 10
+
+    #: LocalTalk [Joyce K Reynolds]
+    LocalTalk = 11
+
+    #: LocalNet (IBM PCNet or SYTEK LocalNET) [Joseph Murdock]
+    LocalNet = 12
+
+    #: Ultra link [Rajiv Dhingra]
+    Ultra_link = 13
+
+    #: SMDS [George Clapp]
+    SMDS = 14
+
+    #: Frame Relay [Andy Malis]
+    Frame_Relay = 15
+
+    #: Asynchronous Transmission Mode (ATM) [JXB2]
+    Asynchronous_Transmission_Mode_16 = 16
+
+    #: HDLC [Jon Postel]
+    HDLC = 17
+
+    #: Fibre Channel [:rfc:`4338`]
+    Fibre_Channel = 18
+
+    #: Asynchronous Transmission Mode (ATM) [:rfc:`2225`]
+    Asynchronous_Transmission_Mode_19 = 19
+
+    #: Serial Line [Jon Postel]
+    Serial_Line = 20
+
+    #: Asynchronous Transmission Mode (ATM) [Mike Burrows]
+    Asynchronous_Transmission_Mode_21 = 21
+
+    #: MIL-STD-188-220 [Herb Jensen]
+    MIL_STD_188_220 = 22
+
+    #: Metricom [Jonathan Stone]
+    Metricom = 23
+
+    #: IEEE 1394.1995 [Myron Hattig]
+    IEEE_1394_1995 = 24
+
+    #: MAPOS [Mitsuru Maruyama][:rfc:`2176`]
+    MAPOS = 25
+
+    #: Twinaxial [Marion Pitts]
+    Twinaxial = 26
+
+    #: EUI-64 [Kenji Fujisawa]
+    EUI_64 = 27
+
+    #: HIPARP [Jean Michel Pittet]
+    HIPARP = 28
+
+    #: IP and ARP over ISO 7816-3 [Scott Guthery]
+    IP_and_ARP_over_ISO_7816_3 = 29
+
+    #: ARPSec [Jerome Etienne]
+    ARPSec = 30
+
+    #: IPsec tunnel [:rfc:`3456`]
+    IPsec_tunnel = 31
+
+    #: InfiniBand (TM) [:rfc:`4391`]
+    InfiniBand = 32
+
+    #: TIA-102 Project 25 Common Air Interface (CAI) [Jeff Anderson,
+    #: Telecommunications Industry of America (TIA) TR-8.5 Formulating Group,
+    #: <cja015&motorola.com>, June 2004]
+    TIA_102_Project_25_Common_Air_Interface = 33
+
+    #: Wiegand Interface [Scott Guthery 2]
+    Wiegand_Interface = 34
+
+    #: Pure IP [Inaky Perez-Gonzalez]
+    Pure_IP = 35
+
+    #: HW_EXP1 [:rfc:`5494`]
+    HW_EXP1 = 36
+
+    #: HFI [Tseng-Hui Lin]
+    HFI = 37
+
+    #: Unified Bus (UB) [Wei Pan]
+    Unified_Bus = 38
+
+    #: HW_EXP2 [:rfc:`5494`]
+    HW_EXP2 = 256
+
+    #: AEthernet [Geoffroy Gramaize]
+    AEthernet = 257
+
+    #: Reserved [:rfc:`5494`]
+    Reserved_65535 = 65535
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'Hardware':
+        """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 Hardware(key)
+        if key not in Hardware._member_map_:  # pylint: disable=no-member
+            return extend_enum(Hardware, key, default)
+        return Hardware[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'Hardware':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 65535):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        if 39 <= value <= 255:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 258 <= value <= 65534:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)