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)[source]¶

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

Abstract base class for internet layer protocol family.

This class currently supports parsing of 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`
`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`

property layer: Literal['Internet']¶: Protocol layer.

classmethod register(code, protocol)[source]¶

Notes

The full qualified class name of the new protocol class should be as {protocol.module}.{protocol.name}.

Parameters:

code (TransType) – protocol code as in TransType
protocol (Union[ModuleDescriptor[ProtocolBase], Type[ProtocolBase]]) – module descriptor or a Protocol subclass

Return type:

None

_decode_next_layer(dict_, proto=None, length=None, *, packet=None, version=4, ipv6_exthdr=None, payload=None)[source]¶

Decode next layer extractor.

Parameters:

dict_ (TypeVar(_PT, bound= Data)) – info buffer
proto (Optional[int]) – next layer protocol index
length (Optional[int]) – valid (non-padding) length
packet (Optional[dict[str, Any]]) – packet info (passed from self.unpack)
version (Literal[4, 6]) – IP version
ipv6_exthdr (Optional[ProtoChain]) – protocol chain of IPv6 extension headers
payload (Optional[bytes]) – 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

We added a new key __next_type__ to dict_ to store the next layer protocol type, and a new key __next_name__ to store the next layer protocol name. These two keys will NOT be included when Info.to_dict is called.

_import_next_layer(proto, length=None, *, packet=None, version=4, extension=False, payload=None)[source]¶

Import next layer extractor.

Parameters:

proto (int) – next layer protocol index
length (Optional[int]) – valid (non-padding) length
packet (Optional[dict[str, Any]]) – packet info (passed from self.unpack)
version (Literal[4, 6]) – IP protocol version
extension (bool) – if is extension header
payload (Optional[bytes]) – payload from packet. If not provided, will extract from self.__header__.get_payload

Return type:

ProtocolBase

Returns:

Instance of next layer.

__layer__: Optional[Literal["Link", "Internet", "Transport", "Application"]]¶: 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[Protocol] | Type[Protocol]]