HOPOPT - IPv6 Hop-by-Hop Options

pcapkit.protocols.internet.hopopt contains HOPOPT only, which implements extractor for IPv6 Hop-by-Hop Options header (HOPOPT) [*], whose structure is described as below:

Octets	Bits	Name	Description
0	0	hopopt.next	Next Header
1	8	hopopt.length	Header Extensive Length
2	16	hopopt.options	Options

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

Bases: Internet[HOPOPT, HOPOPT]

This class implements IPv6 Hop-by-Hop Options.

This class currently supports parsing of the following IPv6 Hop-by-Hop options, which are registered in the self.__option__ attribute:

Option Code	Option Parser	Option Constructor
Pad1	_read_opt_pad()	_make_opt_pad()
PadN	_read_opt_pad()	_make_opt_pad()
Tunnel_Encapsulation_Limit	_read_opt_tun()	_make_opt_tun()
Router_Alert	_read_opt_ra()	_make_opt_ra()
CALIPSO	_read_opt_calipso()	_make_opt_calipso()
SMF_DPD	_read_opt_smf_dpd()	_make_opt_smf_dpd()
PDM	_read_opt_pdm()	_make_opt_pdm()
Quick_Start	_read_opt_qs()	_make_opt_qs()
RPL_Option_0x63	_read_opt_rpl()	_make_opt_rpl()
MPL_Option	_read_opt_mpl()	_make_opt_mpl()
ILNP_Nonce	_read_opt_ilnp()	_make_opt_ilnp()
Line_Identification_Option	_read_opt_lio()	_make_opt_lio()
Jumbo_Payload	_read_opt_jumbo()	_make_opt_jumbo()
Home_Address	_read_opt_home()	_make_opt_home()
IP_DFF	_read_opt_ip_dff()	_make_opt_ip_dff()

property name: Literal['IPv6 Hop-by-Hop Options']

Name of current protocol.

property length: int

Header length of current protocol.

property payload: ProtocolBase | NoReturn

Payload of current instance.

Raises:

UnsupportedCall – if the protocol is used as an IPv6 extension header

Return type:

pcapkit.protocols.protocol.Protocol

property protocol: str | None | NoReturn

Name of next layer protocol (if any).

Raises:

UnsupportedCall – if the protocol is used as an IPv6 extension header

property protochain: ProtoChain | NoReturn

Protocol chain of current instance.

Raises:

UnsupportedCall – if the protocol is used as an IPv6 extension header

classmethod register_option(code, meth)

Register an option parser.

Parameters:

• code (Option) – HOPOPT option code.

• meth (str | tuple[Callable[[Option, OrderedMultiDict[Option, Option]], Option], Callable[[Option, Optional[Option], Any], Option]]) – Method name or callable to parse and/or construct the option.

Return type:

None

read(length=None, *, extension=False, **kwargs)

Read IPv6 Hop-by-Hop Options.

Structure of HOPOPT header [RFC 8200]:

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|  Next Header  |  Hdr Ext Len  |                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
|                                                               |
.                                                               .
.                            Options                            .
.                                                               .
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• length (Optional[int]) – Length of packet data.

• extension (bool) – If the packet is used as an IPv6 extension header.

• **kwargs (Any) – Arbitrary keyword arguments.

Return type:

HOPOPT

Returns:

Parsed packet data.

make(next=<TransType.UDP: 17>, next_default=None, next_namespace=None, next_reversed=False, options=None, payload=b'', **kwargs)

Make (construct) packet data.

Parameters:

• next (TransType | IntEnum | IntEnum | str | int) – Next header type.

• next_default (Optional[int]) – Default value of next header type.

• next_namespace (Union[dict[str, int], dict[int, str], Type[IntEnum], Type[IntEnum], None]) – Namespace of next header type.

• next_reversed (bool) – If the namespace of next header type is reversed.

• option – Hop-by-Hop Options.

• payload (bytes | ProtocolBase | Schema) – Payload of current protocol.

• **kwargs (Any) – Arbitrary keyword arguments.

Return type:

HOPOPT

Returns:

Constructed packet data.

classmethod _make_data(data)

Create key-value pairs from data for protocol construction.

Parameters:

data (HOPOPT) – protocol data

Return type:

dict[str, Any]

Returns:

Key-value pairs for protocol construction.

_read_hopopt_options(length)

Read HOPOPT options.

Positional arguments:

length: length of options

Return type:

OrderedMultiDict[Option, Option]

Returns:

Extracted HOPOPT options

Raises:

ProtocolError – If the threshold is NOT matching.

_read_opt_none(schema, option)

Read HOPOPT unassigned options.

Structure of HOPOPT unassigned options [RFC 8200]:

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+- - - - - - - - -
|  Option Type  |  Opt Data Len |  Option Data
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+- - - - - - - - -

Parameters:

• schema (UnassignedOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

UnassignedOption

Returns:

Parsed option data.

_read_opt_pad(schema, option)

Read HOPOPT padding options.

Structure of HOPOPT padding options [RFC 8200]:

• Pad1 option:

  +-+-+-+-+-+-+-+-+
  |       0       |
  +-+-+-+-+-+-+-+-+
  

• PadN option:

  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+- - - - - - - - -
  |       1       |  Opt Data Len |  Option Data
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+- - - - - - - - -
  

Parameters:

• schema (PadOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

PadOption

Returns:

Parsed option data.

Raises:

ProtocolError – If code is NOT 0 or 1.

_read_opt_tun(schema, option)

Read HOPOPT Tunnel Encapsulation Limit option.

Structure of HOPOPT Tunnel Encapsulation Limit option [RFC 2473]:

   Option Type     Opt Data Len   Opt Data Len
 0 1 2 3 4 5 6 7
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|0 0 0 0 0 1 0 0|       1       | Tun Encap Lim |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (TunnelEncapsulationLimitOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

TunnelEncapsulationLimitOption

Returns:

Parsed option data.

Raises:

ProtocolError – If hopopt.tun.length is NOT 1.

_read_opt_ra(schema, option)

Read HOPOPT Router Alert option.

Structure of HOPOPT Router Alert option [RFC 2711]:

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|0 0 0|0 0 1 0 1|0 0 0 0 0 0 1 0|        Value (2 octets)       |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (RouterAlertOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

RouterAlertOption

Returns:

Parsed option data.

Raises:

ProtocolError – If hopopt.tun.length is NOT 2.

_read_opt_calipso(schema, option)

Read HOPOPT Common Architecture Label IPv6 Security Option (CALIPSO) option.

Structure of HOPOPT CALIPSO option [RFC 5570]:

------------------------------------------------------------
| Next Header | Hdr Ext Len   | Option Type | Option Length|
+-------------+---------------+-------------+--------------+
|             CALIPSO Domain of Interpretation             |
+-------------+---------------+-------------+--------------+
| Cmpt Length |  Sens Level   |     Checksum (CRC-16)      |
+-------------+---------------+-------------+--------------+
|      Compartment Bitmap (Optional; variable length)      |
+-------------+---------------+-------------+--------------+

Parameters:

• schema (CALIPSOOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

CALIPSOOption

Returns:

Parsed option data.

Raises:

ProtocolError – If the option is malformed.

_read_opt_smf_dpd(schema, option)

Read HOPOPT Simplified Multicast Forwarding Duplicate Packet Detection (SMF_DPD) option.

Structure of HOPOPT SMF_DPD option [RFC 6621]:

• IPv6 SMF_DPD option header in I-DPD (Identification-Based DPD) mode

   0                   1                   2                   3
   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                 ...              |0|0|0|  01000  | Opt. Data Len |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |0|TidTy| TidLen|             TaggerID (optional) ...           |
  +-+-+-+-+-+-+-+-+               +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |                               |            Identifier  ...
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  

• IPv6 SMF_DPD option header in H-DPD (Hash-Based) mode

   0                   1                   2                   3
   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                 ...              |0|0|0| OptType | Opt. Data Len |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |1|    Hash Assist Value (HAV) ...
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  

Parameters:

• schema (SMFDPDOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

SMFDPDOption

Returns:

Parsed option data.

Raises:

ProtocolError – If the option is malformed.

_read_opt_pdm(schema, option)

Read HOPOPT Performance and Diagnostic Metrics (PDM) option.

Structure of HOPOPT PDM option [RFC 8250]:

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|  Option Type  | Option Length |    ScaleDTLR  |     ScaleDTLS |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|   PSN This Packet             |  PSN Last Received            |
|-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|   Delta Time Last Received    |  Delta Time Last Sent         |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (PDMOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

PDMOption

Returns:

Parsed option data.

Raises:

ProtocolError – If hopopt.pdm.length is NOT 10.

_read_opt_qs(schema, option)

Read HOPOPT Quick Start option.

Structure of HOPOPT Quick-Start option [RFC 4782]:

• A Quick-Start Request:

   0                   1                   2                   3
   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |   Option      |  Length=6     | Func. | Rate  |   QS TTL      |
  |               |               | 0000  |Request|               |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |                        QS Nonce                           | R |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  

• Report of Approved Rate:

   0                   1                   2                   3
   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |   Option      |  Length=6     | Func. | Rate  |   Not Used    |
  |               |               | 1000  | Report|               |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |                        QS Nonce                           | R |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  

Parameters:

• schema (QuickStartOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

QuickStartOption

Returns:

Parsed option data.

Raises:

ProtocolError – If the option is malformed.

_read_opt_rpl(schema, option)

Read HOPOPT Routing Protocol for Low-Power and Lossy Networks (RPL) option.

Structure of HOPOPT RPL option [RFC 6553]:

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |  Option Type  |  Opt Data Len |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|O|R|F|0|0|0|0|0| RPLInstanceID |          SenderRank           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                         (sub-TLVs)                            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (RPLOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

RPLOption

Returns:

Parsed option data.

Raises:

ProtocolError – If hopopt.rpl.length is NOT 4.

_read_opt_mpl(schema, option)

Read HOPOPT Multicast Protocol for Low-Power and Lossy Networks (MPL) option.

Structure of HOPOPT MPL option [RFC 7731]:

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |  Option Type  |  Opt Data Len |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| S |M|V|  rsv  |   sequence    |      seed-id (optional)       |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (MPLOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

MPLOption

Returns:

Parsed option data.

Raises:

ProtocolError – If the option is malformed.

_read_opt_ilnp(schema, option)

Read HOPOPT Identifier-Locator Network Protocol (ILNP) Nonce option.

Structure of HOPOPT ILNP Nonce option [RFC 6744]:

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Next Header   | Hdr Ext Len   |  Option Type  | Option Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/                         Nonce Value                           /
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (ILNPOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

ILNPOption

Returns:

Parsed option data.

_read_opt_lio(schema, option)

Read HOPOPT Line-Identification option.

Structure of HOPOPT Line-Identification option [RFC 6788]:

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |  Option Type  | Option Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| LineIDLen     |     Line ID...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (LineIdentificationOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

LineIdentificationOption

Returns:

Parsed option data.

_read_opt_jumbo(schema, option)

Read HOPOPT Jumbo Payload option.

Structure of HOPOPT Jumbo Payload option [RFC 2675]:

                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |  Option Type  |  Opt Data Len |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                     Jumbo Payload Length                      |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (JumboPayloadOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

JumboPayloadOption

Returns:

Parsed option data.

Raises:

ProtocolError – If hopopt.jumbo.length is NOT 4.

_read_opt_home(schema, option)

Read HOPOPT Home Address option.

Structure of HOPOPT Home Address option [RFC 6275]:

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |  Option Type  | Option Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                                                               +
|                                                               |
+                          Home Address                         +
|                                                               |
+                                                               +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (HomeAddressOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

HomeAddressOption

Returns:

Parsed option data.

Raises:

ProtocolError – If hopopt.jumbo.length is NOT 16.

_read_opt_ip_dff(schema, option)

Read HOPOPT Depth-First Forwarding (IP_DFF) option.

Structure of HOPOPT IP_DFF option [RFC 6971]:

                     1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|  Next Header  |  Hdr Ext Len  |  OptTypeDFF   | OptDataLenDFF |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|VER|D|R|0|0|0|0|        Sequence Number        |      Pad1     |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (IPDFFOption) – parsed parameter schema

• option (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

IPDFFOption

Returns:

Parsed option data.

Raises:

ProtocolError – If hopopt.ip_dff.length is NOT 2.

_make_hopopt_options(options)

Make options for HOPOPT.

Parameters:

option – HOPOPT options

Return type:

tuple[list[Option | bytes], int]

Returns:

Tuple of options and total length of options.

_make_opt_none(code, opt=None, *, data=b'', **kwargs)

Make HOPOPT unassigned option.

Parameters:

• code (Option) – option type value

• opt (Optional[UnassignedOption]) – option data

• data (bytes) – option payload in bytes

• **kwargs (Any) – arbitrary keyword arguments

Return type:

UnassignedOption

Returns:

Constructured option schema.

_make_opt_pad(code, opt=None, *, length=0, **kwargs)

Make HOPOPT pad option.

Parameters:

• code (Option) – option type value

• opt (Optional[PadOption]) – option data

• length (int) – padding length

• **kwargs (Any) – arbitrary keyword arguments

Return type:

PadOption

Returns:

Constructured option schema.

_make_opt_tun(code, opt=None, *, limit=0, **kwargs)

Make HOPOPT tunnel encapsulation limit option.

Parameters:

• code (Option) – option type value

• opt (Optional[TunnelEncapsulationLimitOption]) – option data

• limit (int) – tunnel encapsulation limit

• **kwargs (Any) – arbitrary keyword arguments

Return type:

TunnelEncapsulationLimitOption

Returns:

Constructured option schema.

_make_opt_ra(code, opt=None, *, alert=<RouterAlert.Datagram_contains_a_Multicast_Listener_Discovery_message: 0>, alert_default=None, alert_namespace=None, alert_reversed=False, **kwargs)

Make HOPOPT router alert option.

Parameters:

• code (Option) – option type value

• opt (Optional[RouterAlertOption]) – option data

• alert (RouterAlert | IntEnum | IntEnum | str | int) – router alert value

• alert_default (Optional[int]) – default value of router alert

• alert_namespace (Union[dict[str, int], dict[int, str], Type[IntEnum], Type[IntEnum], None]) – namespace of router alert

• alert_reversed (bool) – reversed flag of router alert

• **kwargs (Any) – arbitrary keyword arguments

Return type:

RouterAlertOption

Returns:

Constructured option schema.

_make_opt_calipso(code, opt=None, *, domain=0, level=0, checksum=b'\\x00\\x00', bitmap=None, **kwargs)

Make HOPOPT calipso option.

Parameters:

• code (Option) – option type value

• opt (Optional[CALIPSOOption]) – option data

• domain (int) – CALIPSO domain of interpretation

• level (int) – sensitivity level

• checksum (bytes) – checksum of the option

• bitmap (Optional[bytes]) – compartment bitmap

• **kwargs (Any) – arbitrary keyword arguments

Return type:

CALIPSOOption

Returns:

Constructured option schema.

_make_opt_smf_dpd(code, opt=None, *, mode=<SMFDPDMode.I_DPD: 0>, mode_default=None, mode_namespace=None, mode_reversed=False, tid=None, id=b'', hav=b'', **kwargs)

Make HOPOPT SMF DPD option.

Parameters:

• code (Option) – option type value

• opt (Union[SMFIdentificationBasedDPDOption, SMFHashBasedDPDOption, None]) – option data

• mode (SMFDPDMode | IntEnum | IntEnum | str | int) – DPD mode

• mode_default (Optional[int]) – default value of DPD mode

• mode_namespace (Union[dict[str, int], dict[int, str], Type[IntEnum], Type[IntEnum], None]) – namespace of DPD mode

• mode_reversed (bool) – reversed flag of DPD mode

• tid (Union[bytes, IPv4Address, IPv6Address, None]) – Tagger ID

• id (bytes) – identifier

• hav (bytes) – hash assist value (HAV)

• **kwargs (Any) – arbitrary keyword arguments

Return type:

SMFDPDOption

Returns:

Constructured option schema.

_make_opt_pdm(code, opt=None, *, psntp=0, psnlr=0, deltatlr=0, deltatls=0, **kwargs)

Make HOPOPT PDM option.

Parameters:

• code (Option) – option type value

• opt (Optional[PDMOption]) – option data

• psntp (int) – packet sequence number (PSN) this packet

• psnlr (int) – packet sequence number (PSN) last received

• deltatlr (int) – delta time last received (in attoseconds)

• deltatls (int) – delta time last sent (in attoseconds)

• **kwargs (Any) – arbitrary keyword arguments

Return type:

PDMOption

Returns:

Constructured option schema.

_make_opt_qs(code, opt=None, *, func=<QSFunction.Quick_Start_Request: 0>, func_default=None, func_namespace=None, func_reversed=False, rate=0, ttl=0, nonce=0, **kwargs)

Make HOPOPT QS option.

Parameters:

• code (Option) – option type value

• opt (Optional[QuickStartOption]) – option data

• func (QSFunction | IntEnum | IntEnum | str | int) – QS function type

• func_default (Optional[int]) – default value for QS function type

• func_namespace (Union[dict[str, int], dict[int, str], Type[IntEnum], Type[IntEnum], None]) – namespace for QS function type

• func_reversed (bool) – reversed flag for QS function type

• rate (int) – rate (in kbps)

• ttl (timedelta | int) – time to live (in seconds)

• nonce (int) – nonce value

• **kwargs (Any) – arbitrary keyword arguments

Return type:

QuickStartOption

Returns:

Constructured option schema.

_make_opt_rpl(code, opt=None, *, down=False, rank_err=False, fwd_err=False, id=0, rank=0, **kwargs)

Make HOPOPT RPL option.

Parameters:

• code (Option) – option type value

• opt (Optional[RPLOption]) – option data

• down (bool) – down flag

• rank_err (bool) – rank error flag

• fwd_err (bool) – forwarding error flag

• id (int) – RPL instance ID

• rank (int) – sender rank

• **kwargs (Any) – arbitrary keyword arguments

Return type:

RPLOption

Returns:

Constructured option schema.

_make_opt_mpl(code, opt=None, *, max=False, drop=False, seq=0, seed=None, **kwargs)

Make HOPOPT MPL option.

Parameters:

• code (Option) – option type value

• opt (Optional[MPLOption]) – option data

• max (bool) – maximum sequence number flag

• drop (bool) – drop packet flag

• seq (int) – MPL sequence number

• seed (Optional[int]) – MPL seed ID

• **kwargs (Any) – arbitrary keyword arguments

Return type:

MPLOption

Returns:

Constructured option schema.

_make_opt_ilnp(code, opt=None, *, nonce=0, **kwargs)

Make HOPOPT ILNP option.

Parameters:

• code (Option) – option type value

• opt (Optional[ILNPOption]) – option data

• nonce (int) – ILNP nonce value

• **kwargs (Any) – arbitrary keyword arguments

Return type:

ILNPOption

Returns:

Constructured option schema.

_make_opt_lio(code, opt=None, *, id=b'', **kwargs)

Make HOPOPT LIO option.

Parameters:

• code (Option) – option type value

• opt (Optional[LineIdentificationOption]) – option data

• id (bytes) – line ID value

• **kwargs (Any) – arbitrary keyword arguments

Return type:

LineIdentificationOption

Returns:

Constructured option schema.

_make_opt_jumbo(code, opt=None, *, len=0, **kwargs)

Make HOPOPT Jumbo Payload option.

Parameters:

• code (Option) – option type value

• opt (Optional[JumboPayloadOption]) – option data

• len (int) – jumbo payload length

• **kwargs (Any) – arbitrary keyword arguments

Return type:

JumboPayloadOption

Returns:

Constructured option schema.

_make_opt_home(code, opt=None, *, addr='::', **kwargs)

Make HOPOPT Home Address option.

Parameters:

• code (Option) – option type value

• opt (Optional[HomeAddressOption]) – option data

• addr (IPv6Address | str | bytes | int) – home address value

• **kwargs (Any) – arbitrary keyword arguments

Return type:

HomeAddressOption

Returns:

Constructured option schema.

_make_opt_ip_dff(code, opt=None, *, version=0, dup=False, ret=False, seq=0, **kwargs)

Make HOPOPT IP DFF option.

Parameters:

• code (Option) – option type value

• opt (Optional[IPDFFOption]) – option data

• version (int) – DFF version

• dup (bool) – duplicate packet flag

• ret (bool) – return packet flag

• seq (int) – DFF sequence number

• **kwargs (Any) – arbitrary keyword arguments

Return type:

IPDFFOption

Returns:

Constructured option schema.

__option__: DefaultDict[Enum_Option | int, str | tuple[OptionParser, OptionConstructor]]

Option code to method mapping, c.f. _read_hopopt_options() and/or _make_hopopt_options(). Method names are expected to be referred to the class by _read_opt_${name} and/or _make_opt_${name}, and if such name not found, the value should then be a method that can parse the option by itself.

Type:

DefaultDict[Enum_Option, str | tuple[OptionParser, OptionConstructor]]

__post_init__(file=None, length=None, *, extension=False, **kwargs)

Post initialisation hook.

Parameters:

• file (Union[IO[bytes], bytes, None]) – Source packet stream.

• length (Optional[int]) – Length of packet data.

• extension (bool) – If the protocol is used as an IPv6 extension header.

• **kwargs (Any) – Arbitrary keyword arguments.

Return type:

None

See also

For construction argument, please refer to make().

classmethod __index__()

Numeral registry index of the protocol.

Return type:

TransType

Returns:

Numeral registry index of the protocol in IANA.

Header Schemas

class pcapkit.protocols.schema.internet.hopopt.HOPOPT(dict_=None, **kwargs)

Bases: Schema

Header schema for HOPOPT packet.

next: Enum_TransType = <EnumField next>

Next header.

len: int = <UInt8Field len>

Header length.

options: list[Option] = <OptionField options>

Options.

payload: bytes = <PayloadField payload>

Payload.

class pcapkit.protocols.schema.internet.hopopt.Option(dict_=None, **kwargs)

Bases: EnumSchema[Option]

Header schema for HOPOPT options.

type: Enum_Option = <EnumField type>

Option type.

len: int = <ConditionalField len>

Option length (conditional in case of Pad1 option).

post_process(packet)

Revise schema data after unpacking process.

Parameters:

packet (dict[str, Any]) – Unpacked data.

Return type:

Schema

Returns:

Revised schema.

class pcapkit.protocols.schema.internet.hopopt.UnassignedOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT unassigned options.

data: bytes = <BytesField data>

Option data.

class pcapkit.protocols.schema.internet.hopopt.PadOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT padding options.

pad: bytes = <PaddingField pad>

Padding.

class pcapkit.protocols.schema.internet.hopopt.TunnelEncapsulationLimitOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT tunnel encapsulation limit options.

limit: int = <UInt8Field limit>

Tunnel encapsulation limit.

class pcapkit.protocols.schema.internet.hopopt.RouterAlertOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT router alert options.

alert: Enum_RouterAlert = <EnumField alert>

Router alert.

class pcapkit.protocols.schema.internet.hopopt.CALIPSOOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT common architecture label IPv6 security options.

domain: int = <UInt32Field domain>

CALIPSO domain of interpretation.

cmpt_len: int = <UInt8Field cmpt_len>

Compartment length.

level: int = <UInt8Field level>

Sens level.

checksum: bytes = <BytesField checksum>

Checksum (CRC-16).

bitmap: bytes = <ConditionalField bitmap>

Compartment bitmap.

pad: bytes = <PaddingField pad>

Padding.

class pcapkit.protocols.schema.internet.hopopt.SMFDPDOption(dict_=None, **kwargs)

Bases: Option, EnumSchema[SMFDPDMode]

Header schema for HOPOPT simplified multicast forwarding duplicate packet detection (SMF_DPD) options.

class pcapkit.protocols.schema.internet.hopopt.SMFIdentificationBasedDPDOption(dict_=None, **kwargs)

Bases: SMFDPDOption

Header schema for HOPOPT SMF identification-based DPD options.

info: TaggerIDInfo = <BitField info>

TaggerID information.

tid: bytes | IPv4Address | IPv6Address = <ConditionalField tid>

TaggerID.

id: bytes = <BytesField id>

Identifier.

post_process(packet)

Revise schema data after unpacking process.

Parameters:

packet (dict[str, Any]) – Unpacked data.

Return type:

SMFIdentificationBasedDPDOption

Returns:

Revised schema.

class pcapkit.protocols.schema.internet.hopopt.SMFHashBasedDPDOption(dict_=None, **kwargs)

Bases: SMFDPDOption

Header schema for HOPOPT SMF hash-based DPD options.

hav: bytes = <BytesField hav>

Hash assist value (HAV).

post_process(packet)

Revise schema data after unpacking process.

Parameters:

packet (dict[str, Any]) – Unpacked data.

Return type:

SMFIdentificationBasedDPDOption

Returns:

Revised schema.

class pcapkit.protocols.schema.internet.hopopt.PDMOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT performance and diagnostic metrics (PDM) options.

scaledtlr: int = <UInt8Field scaledtlr>

Scale delta time last received (DTLR).

scaledtls: int = <UInt8Field scaledtls>

Scale delta time last sent (DTLS).

psntp: int = <UInt16Field psntp>

Packet sequence number (PSN) this packet.

psnlr: int = <UInt16Field psnlr>

Packet sequence number (PSN) last received.

deltatlr: int = <UInt16Field deltatlr>

Delta time last received (DTLR).

deltatls: int = <UInt16Field deltatls>

Delta time last sent (DTLS).

class pcapkit.protocols.schema.internet.hopopt._QuickStartOption(dict_=None, **kwargs)

Bases: Schema

Header schema for HOPOPT quick start options in generic representation.

flags: QSTestFlags = <ForwardMatchField flags>

Flags.

data: QuickStartRequestOption | QuickStartReportOption = <SwitchField data>

QS data.

post_process(packet)

Revise schema data after unpacking process.

Parameters:

packet (dict[str, Any]) – Unpacked data.

Return type:

QuickStartOption

Returns:

Revised schema.

class pcapkit.protocols.schema.internet.hopopt.QuickStartOption(dict_=None, **kwargs)

Bases: Option, EnumSchema[QSFunction]

Header schema for HOPOPT quick start options.

flags: QuickStartFlags = <BitField flags>

Flags.

class pcapkit.protocols.schema.internet.hopopt.QuickStartRequestOption(dict_=None, **kwargs)

Bases: QuickStartOption

Header schema for HOPOPT quick start request options.

ttl: int = <UInt8Field ttl>

QS time-to-live (TTL).

nonce: QSNonce = <BitField nonce>

QS nonce.

class pcapkit.protocols.schema.internet.hopopt.QuickStartReportOption(dict_=None, **kwargs)

Bases: QuickStartOption

Header schema for HOPOPT quick start report of approved rate options.

reserved: bytes = <PaddingField reserved>

Reserved.

nonce: QSNonce = <BitField nonce>

QS nonce.

class pcapkit.protocols.schema.internet.hopopt.RPLOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT routing protocol for low-power and lossy networks (RPL) options.

flags: RPLFlags = <BitField flags>

Flags.

id: int = <UInt8Field id>

RPL instance ID.

rank: int = <UInt16Field rank>

Sender rank.

class pcapkit.protocols.schema.internet.hopopt.RPLFlags

Bases: TypedDict

RPL flags.

down: int

Down flag.

rank_err: int

Rank error flag.

fwd_err: int

Forwarding error flag.

class pcapkit.protocols.schema.internet.hopopt.MPLOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT multicast protocol for low-power and lossy networks (MPL) options.

flags: MPLFlags = <BitField flags>

Flags.

seq: int = <UInt8Field seq>

MPL sequence number.

seed: int = <ConditionalField seed>

MPL Seed-ID.

pad: bytes = <PaddingField pad>

Reserved data (padding).

post_process(packet)

Revise schema data after unpacking process.

Parameters:

packet (dict[str, Any]) – Unpacked data.

Return type:

Schema

Returns:

Revised schema.

class pcapkit.protocols.schema.internet.hopopt.MPLFlags

Bases: TypedDict

MPL flags.

type: int

Seed-ID type. Identifies the length of the Seed-ID.

max: int

Max flag. 1 indicates that the value in the sequence field is known to be the largest sequence number that was received from the MPL Seed.

drop: int

Verification flag. 0 indicates that the MPL Option conforms to this specification.

class pcapkit.protocols.schema.internet.hopopt.ILNPOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT identifier-locator network protocol (ILNP) options.

nonce: int = <NumberField nonce>

Nonce value.

class pcapkit.protocols.schema.internet.hopopt.LineIdentificationOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT line-identification options.

id_len: int = <UInt8Field id_len>

Line ID length.

id: bytes = <BytesField id>

Line ID.

class pcapkit.protocols.schema.internet.hopopt.JumboPayloadOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT jumbo payload options.

jumbo_len: int = <UInt32Field jumbo_len>

Jumbo payload length.

class pcapkit.protocols.schema.internet.hopopt.HomeAddressOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT home address options.

addr: IPv6Address = <IPv6AddressField addr>

Home address.

class pcapkit.protocols.schema.internet.hopopt.IPDFFOption(dict_=None, **kwargs)

Bases: Option

Header schema for HOPOPT depth-first forwarding (IP_DFF) options.

flags: DFFFlags = <BitField flags>

Flags.

seq: int = <UInt16Field seq>

Sequence number.

class pcapkit.protocols.schema.internet.hopopt.DFFFlags

Bases: TypedDict

IP_DFF flags.

ver: int

Version.

dup: int

Duplicate flag.

ret: int

Retune flag.

Type Stubs

class pcapkit.protocols.schema.internet.hopopt.TaggerIDInfo

Bases: TypedDict

TaggerID information.

mode: int

SMF mode.

type: int

TaggerID type.

len: int

TaggerID length.

class pcapkit.protocols.schema.internet.hopopt.QuickStartFlags

Bases: TypedDict

Quick-Start flags.

func: int

QS function.

rate: int

Rate request/report.

class pcapkit.protocols.schema.internet.hopopt.RPLFlags

Bases: TypedDict

RPL flags.

down: int

Down flag.

rank_err: int

Rank error flag.

fwd_err: int

Forwarding error flag.

class pcapkit.protocols.schema.internet.hopopt.MPLFlags

Bases: TypedDict

MPL flags.

type: int

Seed-ID type. Identifies the length of the Seed-ID.

max: int

Max flag. 1 indicates that the value in the sequence field is known to be the largest sequence number that was received from the MPL Seed.

drop: int

Verification flag. 0 indicates that the MPL Option conforms to this specification.

class pcapkit.protocols.schema.internet.hopopt.DFFFlags

Bases: TypedDict

IP_DFF flags.

ver: int

Version.

dup: int

Duplicate flag.

ret: int

Retune flag.

class pcapkit.protocols.schema.internet.hopopt.SMFDPDTestFlag

Bases: TypedDict

SMF_DPD test flag.

len: int

Length.

mode: int

DPD mode.

class pcapkit.protocols.schema.internet.hopopt.QSTestFlags

Bases: TypedDict

Quick start test flag.

func: int

QS function.

class pcapkit.protocols.schema.internet.hopopt.QSNonce

Bases: TypedDict

Quick start nonce.

nonce: int

Nonce.

Auxiliary Functions

pcapkit.protocols.schema.internet.hopopt.mpl_opt_seed_id_len(pkt)

Return MPL Seed-ID length.

Parameters:

pkt (dict[str, Any]) – MPL option unpacked schema.

Return type:

int

Returns:

MPL Seed-ID length.

pcapkit.protocols.schema.internet.hopopt.smf_dpd_data_selector(pkt)

Selector function for _SMFDPDOption.data field.

Parameters:

pkt (dict[str, Any]) – Packet data.

Return type:

FieldBase

Returns:

• If mode is 0, returns a SchemaField wrapped SMFIdentificationBasedDPDOption instance.

• If mode is 1, returns a SchemaField wrapped SMFHashBasedDPDOption instance.

pcapkit.protocols.schema.internet.hopopt.smf_i_dpd_tid_selector(pkt)

Selector function for SMFIdentificationBasedDPDOption.tid field.

Parameters:

pkt (dict[str, Any]) – Packet data.

Return type:

FieldBase

Returns:

• If tid_type is 0, returns a NoValueField instance.

• If tid_type is 1, returns a IPv4AddressField instance.

• If tid_type is 2, returns a IPv6AddressField instance.

• Otherwise, returns a BytesField instance.

pcapkit.protocols.schema.internet.hopopt.quick_start_data_selector(pkt)

Selector function for _QuickStartOption.data field.

Parameters:

pkt (dict[str, Any]) – Packet data.

Return type:

FieldBase

Returns:

• If func is 0, returns a SchemaField wrapped QuickStartRequestOption instance.

• If func is 8, returns a SchemaField wrapped QuickStartReportOption instance.

Data Models

class pcapkit.protocols.data.internet.hopopt.HOPOPT(*args: VT, **kwargs: VT)

Bases: Protocol

Data model for HOPOPT protocol.

next: TransType

Next header.

length: int

Header extension length.

options: OrderedMultiDict[Enum_Option, Option]

HOPOPT options.

class pcapkit.protocols.data.internet.hopopt.Option(dict_=None, **kwargs)

Bases: Data

Data model for HOPOPT option data.

type: Enum_Option

Option type.

action: OptionAction

Unknown option cation.

change: bool

Change flag.

length: int

Content length.

class pcapkit.protocols.data.internet.hopopt.UnassignedOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for HOPOPT unassigned option.

data: bytes

Option data.

class pcapkit.protocols.data.internet.hopopt.PadOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for HOPOPT padding options.

class pcapkit.protocols.data.internet.hopopt.TunnelEncapsulationLimitOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for HOPOPT tunnel encapsulation limit option.

limit: int

Tunnel encapsulation limit.

class pcapkit.protocols.data.internet.hopopt.RouterAlertOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for HOPOPT router alter option.

value: RouterAlert

Router alter value.

class pcapkit.protocols.data.internet.hopopt.CALIPSOOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for HOPOPT Common Architecture Label IPv6 Security Option (CALIPSO) option.

domain: int

CALIPSO domain of interpretation.

cmpt_len: int

Compartment length.

level: int

Sensitivity level.

checksum: bytes

Checksum.

cmpt_bitmap: bytes

Compartment bitmap.

class pcapkit.protocols.data.internet.hopopt.SMFDPDOption(dict_=None, **kwargs)

Bases: Option

Data model for HOPOPT Simplified Multicast Forwarding Duplicate Packet Detection (SMF_DPD) option.

dpd_type: SMFDPDMode

DPD type.

class pcapkit.protocols.data.internet.hopopt.SMFIdentificationBasedDPDOption(*args: VT, **kwargs: VT)

Bases: SMFDPDOption

Data model for HOPOPT I-DPD (Identification-Based DPD) option.

tid_type: TaggerID

TaggerID type.

tid_len: int

TaggerID length.

tid: Optional[bytes | IPv4Address | IPv6Address]

TaggerID.

id: bytes

Identifier.

class pcapkit.protocols.data.internet.hopopt.SMFHashBasedDPDOption(*args: VT, **kwargs: VT)

Bases: SMFDPDOption

Data model for HOPOPT H-DPD (Hash-Based DPD) option.

hav: bytes

Hash assist value.

class pcapkit.protocols.data.internet.hopopt.PDMOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for HOPOPT Performance Diagnostic Metrics (PDM) option.

scaledtlr: int

Scale delta time last received.

scaledtls: int

Scale delta time last sent.

psntp: int

Packet sequence number this packet.

psnlr: int

Packet sequence number last received.

deltatlr: int

Delta time last received (in attoseconds).

deltatls: int

Delta time last sent (in attoseconds).

class pcapkit.protocols.data.internet.hopopt.QuickStartOption(dict_=None, **kwargs)

Bases: Option

Data model for HOPOPT Quick Start option.

func: QSFunction

QS function.

rate: int

Rate request/report.

class pcapkit.protocols.data.internet.hopopt.RPLOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for HOPOPT Routing Protocol for Low-Power and Lossy Networks (RPL) option.

flags: RPLFlags

Flags.

id: int

RPL instance ID.

rank:

int

Sender rank.

class pcapkit.protocols.data.internet.hopopt.RPLFlags(*args: VT, **kwargs: VT)

Bases: Data

Data model for HOPOPT RPL option flags fields.

down: bool

Down flag.

rank_err: bool

Rank error flag.

fwd_err: bool

Forwarding error flag.

class pcapkit.protocols.data.internet.hopopt.MPLOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for HOPOPT Multicast Protocol for Low-Power and Lossy Networks (MPL) option.

seed_type: SeedID

Seed length.

flags: MPLFlags

Flags.

seq: int

Sequence number.

seed_id: Optional[int]

Seed ID.

class pcapkit.protocols.data.internet.hopopt.MPLFlags(*args: VT, **kwargs: VT)

Bases: Data

Data model for HOPOPT MPL option flags fields.

max: bool

Max flag.

drop: bool

Non-conformation flag.

class pcapkit.protocols.data.internet.hopopt.ILNPOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for HOPOPT Identifier-Locator Network Protocol (ILNP) Nonce option.

nonce: int

Nonce value.

class pcapkit.protocols.data.internet.hopopt.LineIdentificationOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for HOPOPT Line-Identification option.

line_id_len: int

Line ID length.

line_id: bytes

Line ID.

class pcapkit.protocols.data.internet.hopopt.JumboPayloadOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for Jumbo Payload option.

jumbo_len: int

Jumbo payload length.

class pcapkit.protocols.data.internet.hopopt.HomeAddressOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for HOPOPT Home Address option.

address: IPv6Address

Home address.

class pcapkit.protocols.data.internet.hopopt.IPDFFOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for HOPOPT Depth-First Forwarding (IP_DFF) option.

version: int

Version.

flags: DFFFlags

Flags.

seq: int

Sequence number.

class pcapkit.protocols.data.internet.hopopt.DFFFlags(*args: VT, **kwargs: VT)

Bases: Data

Data model for HOPOPT IP_DFF option flags.

dup: bool

Duplicate flag.

ret: bool

Return flag.

Footnotes

[*]

https://en.wikipedia.org/wiki/IPv6_packet#Hop-by-hop_options_and_destination_options