Base Protocol

pcapkit.protocols.internet.internet contains Internet, which is a base class for internet layer protocols, eg. AH, IPsec, IPv4, IPv6, IPX, and etc.

class pcapkit.protocols.internet.internet.Internet(file=None, length=None, **kwargs)

Bases: ProtocolBase[_PT, _ST], Generic[_PT, _ST]

Abstract base class for internet layer protocol family.

This class parses the following protocols, which are registered in the self.__proto__ attribute:

Index	Protocol
HOPOPT	pcapkit.protocols.internet.hopopt.HOPOPT
IPv4	pcapkit.protocols.internet.ipv4.IPv4
TCP	pcapkit.protocols.transport.tcp.TCP
UDP	pcapkit.protocols.transport.udp.UDP
IPv6	pcapkit.protocols.internet.ipv6.IPv6
IPv6_Route	pcapkit.protocols.internet.ipv6_route.IPv6_Route
IPv6_Frag	pcapkit.protocols.internet.ipv6_frag.IPv6_Frag
ESP	pcapkit.protocols.internet.esp.ESP
AH	pcapkit.protocols.internet.ah.AH
IPv6_NoNxt	pcapkit.protocols.misc.raw.Raw
IPv6_Opts	pcapkit.protocols.internet.ipv6_opts.IPv6_Opts
IPX_in_IP	pcapkit.protocols.internet.ipx.IPX
Mobility_Header	pcapkit.protocols.internet.mh.MH
HIP	pcapkit.protocols.internet.hip.HIP
SCTP	pcapkit.protocols.transport.sctp.SCTP
OSPFIGP	pcapkit.protocols.application.ospf.OSPF

property layer: Literal['Internet']

Protocol layer.

classmethod register(code, protocol)

Register a new protocol class.

Notes

The fully qualified class name should be {protocol.module}.{protocol.name}.

Parameters:

• code (TransType) – protocol code as in TransType

• protocol (ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]) – module descriptor or a Protocol subclass

Raises:

pcapkit.utilities.exceptions.RegistryError – If protocol is not a class, or not a Protocol subclass.

Warns:

pcapkit.utilities.warnings.RegistryWarning – If this protocol number is already registered, naming the displaced entry and its replacement so a caller can tell what was lost. Fires only when the incumbent differs from the replacement; see ProtocolBase.register for the guard this shares with register_protocol.

_decode_next_layer(dict_, proto=None, length=None, *, packet=None, version=4, ipv6_exthdr=None, payload=None)

Decode next layer extractor.

Parameters:

• dict_ (TypeVar(_PT, bound= Data)) – info buffer

• proto (int | None) – next layer protocol index

• length (int | None) – valid (non-padding) length

• packet (dict[str, Any] | None) – packet info (passed from self.unpack)

• version (Literal[4, 6]) – IP version

• ipv6_exthdr (ProtoChain | None) – protocol chain of IPv6 extension headers

• payload (bytes | None) – payload from packet. If not provided, will extract from self.__header__.get_payload

Return type:

TypeVar(_PT, bound= Data)

Returns:

Current protocol with next layer extracted.

Notes

dict_ gains the key __next_type__ (next layer protocol type) and __next_name__ (next layer protocol name). Neither is included when Info.to_dict is called.

_import_next_layer(proto, length=None, *, packet=None, version=4, extension=False, payload=None)

Import next layer extractor.

Parameters:

• proto (int) – next layer protocol index

• length (int | None) – valid (non-padding) length

• packet (dict[str, Any] | None) – packet info (passed from self.unpack)

• version (Literal[4, 6]) – IP protocol version

• extension (bool) – if is extension header

• payload (bytes | None) – payload from packet. If not provided, will extract from self.__header__.get_payload

Return type:

ProtocolBase

Returns:

Instance of next layer.

__layer__: Literal['Internet']

Layer of protocol.

__proto__: DefaultDict[int, ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]]

Protocol index mapping for decoding next layer, c.f. self._decode_next_layer & self._import_next_layer.

Type:

DefaultDict[int, ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]]