Internet Layer Protocols

pcapkit.protocols.internet is collection of all protocols in internet layer, with detailed implementation and methods.

• AH - Authentication Header
  • Data Structure
• HIP - Host Identity Protocol
  • Data Structure
    • HIP Unassigned Parameters
    • HIP ESP_INFO Parameter
    • HIP R1_COUNTER Parameter
    • HIP LOCATOR_SET Parameter
    • HIP PUZZLE Parameter
    • HIP SOLUTION Parameter
    • HIP SEQ Parameter
    • HIP ACK Parameter
    • HIP DH_GROUP_LIST Parameter
    • HIP DEFFIE_HELLMAN Parameter
    • HIP HIP_TRANSFORM Parameter
    • HIP HIP_CIPHER Parameter
    • HIP NAT_TRAVERSAL_MODE Parameter
    • HIP TRANSACTION_PACING Parameter
    • HIP ENCRYPTED Parameter
    • HIP HOST_ID Parameter
    • HIP HIT_SUITE_LIST Parameter
    • HIP CERT Parameter
    • HIP NOTIFICATION Parameter
    • HIP ECHO_REQUEST_SIGNED Parameter
    • HIP REG_INFO Parameter
    • HIP REG_REQUEST Parameter
    • HIP REG_RESPONSE Parameter
    • HIP REG_FAILED Parameter
    • HIP REG_FROM Parameter
    • HIP ECHO_RESPONSE_SIGNED Parameter
    • HIP TRANSPORT_FORMAT_LIST Parameter
    • HIP ESP_TRANSFORM Parameter
    • HIP SEQ_DATA Parameter
    • HIP ACK_DATA Parameter
    • HIP PAYLOAD_MIC Parameter
    • HIP TRANSACTION_ID Parameter
    • HIP OVERLAY_ID Parameter
    • HIP ROUTE_DST Parameter
    • HIP HIP_TRANSPORT_MODE Parameter
    • HIP HIP_MAC Parameter
    • HIP HIP_MAC_2 Parameter
    • HIP HIP_SIGNATURE_2 Parameter
    • HIP HIP_SIGNATURE Parameter
    • HIP ECHO_REQUEST_UNSIGNED Parameter
    • HIP ECHO_RESPONSE_UNSIGNED Parameter
    • HIP RELAY_FROM Parameter
    • HIP RELAY_TO Parameter
    • HIP OVERLAY_TTL Parameter
    • HIP ROUTE_VIA Parameter
    • HIP FROM Parameter
    • HIP RVS_HMAC Parameter
    • HIP VIA_RVS Parameter
    • HIP RELAY_HMAC Parameter
• HOPOPT - IPv6 Hop-by-Hop Options
  • Data Structure
    • HOPOPT Option Type
    • HOPOPT Unassigned Options
    • HOPOPT Padding Options
      • Pad1 Option
      • PadN Option
    • HOPOPT Tunnel Encapsulation Limit Option
    • HOPOPT Router Alert Option
    • HOPOPT CALIPSO Option
    • HOPOPT SMF_DPD Option
      • I-DPD Mode
      • H-DPD Mode
    • HOPOPT PDM Option
    • HOPOPT Quick Start Option
    • HOPOPT RPL Option
    • HOPOPT MPL Option
    • HOPOPT ILNP Nounce Option
    • HOPOPT Line-Identification Option
    • HOPOPT Jumbo Payload Option
    • HOPOPT Home Address Option
    • HOPOPT IP_DFF Option
• IP - Internet Protocol
• IPsec - Internet Protocol Security
• IPv4 - Internet Protocol version 4
  • Data Structure
    • IPv4 Option Type
    • IPv4 Miscellaneous Options
      • 1-Byte Options
      • Permission Options
      • No Process Options
      • Unpack Process Options
    • IPv4 Options with Route Data
    • IPv4 Quick Start Options
    • IPv4 Time Stamp Option
    • IPv4 Traceroute Option
    • IPv4 Options with Security Info
    • IPv4 Traceroute Option
• IPv6-Frag - Fragment Header for IPv6
  • Data Structure
• IPv6-Opts - Destination Options for IPv6
  • Data Structure
    • IPv6-Opts Option Type
    • IPv6-Opts Unassigned Options
    • IPv6-Opts Padding Options
      • Pad1 Option
      • PadN Option
    • IPv6-Opts Tunnel Encapsulation Limit Option
    • IPv6-Opts Router Alert Option
    • IPv6-Opts CALIPSO Option
    • IPv6-Opts SMF_DPD Option
      • I-DPD Mode
      • H-DPD Mode
    • IPv6-Opts PDM Option
    • IPv6-Opts Quick Start Option
    • IPv6-Opts RPL Option
    • IPv6-Opts MPL Option
    • IPv6-Opts ILNP Nounce Option
    • IPv6-Opts Line-Identification Option
    • IPv6-Opts Jumbo Payload Option
    • IPv6-Opts Home Address Option
    • IPv6-Opts IP_DFF Option
• IPv6-Route - Routing Header for IPv6
  • Data Structure
    • IPv6-Route Unknown Type
    • IPv6-Route Source Route
    • IPv6-Route Type 2
    • IPv6-Route RPL Source
• IPv6 - Internet Protocol version 6
  • Data Structure
• IPX - Internetwork Packet Exchange
  • Data Structure
• MH - Mobility Header
  • Data Structure

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: pcapkit.protocols.protocol.Protocol

Abstract base class for internet layer protocol family.

__layer__ = 'Internet'

Layer of protocol.

__proto__: DefaultDict[int, Tuple[str, str]]

Protocol index mapping for decoding next layer, c.f. self._decode_next_layer & self._import_next_layer. The values should be a tuple representing the module name and class name.

Code	Module	Class
0	pcapkit.protocols.internet.hopopt	HOPOPT
4	pcapkit.protocols.internet.ipv4	IPv4
6	pcapkit.protocols.transport.tcp	TCP
17	pcapkit.protocols.transport.udp	UDP
41	pcapkit.protocols.internet.ipv6	IPv6
43	pcapkit.protocols.internet.ipv6_route	IPv6_Route
44	pcapkit.protocols.internet.ipv6_frag	IPv6_Frag
51	pcapkit.protocols.internet.ah	AH
60	pcapkit.protocols.internet.ipv6_opts	IPv6_Opts
111	pcapkit.protocols.internet.ipx	IPX
135	pcapkit.protocols.internet.mh	MH
139	pcapkit.protocols.internet.hip	HIP

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

Decode next layer extractor.

Parameters

• dict (dict) – info buffer

• proto (int) – next layer protocol index

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

Keyword Arguments

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

• ipv6_exthdr (pcapkit.corekit.protochain.ProtoChain) – protocol chain of IPv6 extension headers

Returns

current protocol with next layer extracted

Return type

dict

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

Import next layer extractor.

This method currently supports following protocols as registered in TransType:

proto	Class
0	HOPOPT
4	IPv4
6	TCP
17	UDP
41	IPv6
43	IPv6_Route
44	IPv6_Frag
51	AH
60	IPv6_Opts
111	IPX
135	MH
139	HIP

Parameters

• proto (int) – next layer protocol index

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

Keyword Arguments

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

• extension (bool) – if is extension header

Returns

instance of next layer

Return type

pcapkit.protocols.protocol.Protocol

_read_protos(size)

Read next layer protocol type.

Parameters

size (int) – buffer size

Returns

next layer’s protocol enumeration

Return type

pcapkit.const.reg.transtype.TransType

property layer

Protocol layer.

Return type

Literal[‘Internet’]