HOPOPT - IPv6 Hop-by-Hop Options¶

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

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

class pcapkit.protocols.internet.hopopt.protocol.HOPOPT(file=None, length=None, **kwargs)[source]¶

Bases: IPv6_Ext[HOPOPT, HOPOPT]

This class implements IPv6 Hop-by-Hop Options.

This class parses 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_0x23`	`_read_opt_rpl()`	`_make_opt_rpl()`
`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()`

Changed in version 1.5.0:

The ILNP nonce is sized with a ceiling rather than a floor (#601).
The RPL option keeps its reserved flag bits on rebuild and accepts RFC 6553 sub-TLVs (#1199).
A rebuild reproduces the option area byte for byte: its padding, a PadN with no data, the SMF_DPD, CALIPSO, PDM and ILNP Nonce options, and unassigned Quick-Start function codes (#1200, #1228, #1229, #1232 to #1234, #1237); a CALIPSO option keeps its trailing pad and its length (#1403).
The MPL, IP_DFF and Quick-Start options keep their reserved bits on rebuild, and IP_DFF takes the Opt Data Len of 3 that RFC 6971 Errata ID 3937 gives, where it took 2 (#1235).
A PadN option’s data and the “Not Used” octet of a Quick-Start report are kept as captured rather than zeroed (#1223).

Changed in version 1.6.0:

A Quick-Start rate the four-bit rate code cannot carry, or a TTL, nonce or reserved value outside its field, raises ProtocolError, rather than a bare ValueError, an OverflowError or a FieldValueError, or a different value written in its place (#2617).
The Quick-Start maker builds an unassigned function code as an unassigned option, the form the reader keeps one in (#2617).
An option maker given a value its fixed-width field cannot carry – negative, too wide, or a bool for a field wider than one bit – raises ProtocolError, rather than writing a different value or raising another exception; so does make() for options too long for the Hdr Ext Len (#2614).
A PDM scale, given or derived from its delta, that does not fit its octet raises ProtocolError, where it warned and was written wrapped (#2614).
Each enumeration field of make() and of the option makers, including the type of each option given to make(), takes a member or an int code, resolved with the enumeration’s get; a name, a bool for a field wider than one bit, or a code the field cannot carry raises ProtocolError, rather than resolving against an enumeration inferred from the caller’s frame, writing a different value or raising another exception (#2594).
The CALIPSO option’s checksum and the “Not Used” octet of a Quick-Start report, given the wrong number of octets, raise ProtocolError, rather than being padded or cut to their field (#2676).
An option given to make() as empty raw octets, which hold no type octet, raises ProtocolError rather than an IndexError (#2723).

Removed in version 1.6.0: The *_default, *_namespace and *_reversed arguments that went with each enumeration field of make() and of the option makers – next, alert, mode, tid_type, func and seed_type; resolve a name with resolve_index() first (#2594).

__option__: DefaultDict[Option | int, str | tuple[Callable[[Option, OrderedMultiDict[Option, Option]], Option], Callable[[Option, Option | None, Any], Option]]]¶: Option code to method mapping, see _read_hopopt_options() and/or _make_hopopt_options(). A str value names the methods _read_opt_${name} and _make_opt_${name}, falling back to _read_opt_none / _make_opt_none when they do not exist; any other value is a (parser, constructor) pair of callables.

property name: Literal['IPv6 Hop-by-Hop Options']¶: Name of current protocol.

property alias: Literal['HOPOPT']¶

Acronym of corresponding protocol.

Spelled out rather than left to Protocol.alias’s class-name default, because IPv6_Ext sits between this class and that default in the MRO and carries its own 'IPv6-Ext' (#917). Inheriting it would rename this header in every ProtoChain string and in IPv6._decode_next_layer’s packet dict key.

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

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

read(length=None, *, extension=False, **kwargs)[source]¶

Read IPv6 Hop-by-Hop Options.

Structure of HOPOPT header [RFC 8200]:

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

Parameters:

length (int | None) – 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, options=None, payload=b'', *, len=None, **kwargs)[source]¶

Make (construct) packet data.

Parameters:

next (TransType | int) – Next header type.
options (list[Option | tuple[Option | int, dict[str, Any]] | bytes] | OrderedMultiDict[Option, Option] | None) – Hop-by-Hop Options.
payload (bytes | ProtocolBase | Schema) – Payload of current protocol.
len (int | None) – Hdr Ext Len to declare, rather than the one the options fill. A header the capture cut short declares one its parsed options do not fill, which from_data() passes on, so that the rebuild declares it too (#2694). Options that fill less than it declares are not padded out to it, so the header then declares more octets than it packs, as a cut one does.
**kwargs (Any) – Arbitrary keyword arguments.

Return type:

HOPOPT

Returns:

Constructed packet data.

Raises:

ProtocolError – If next, or the type of an option, is a name, a bool, or a member or code that does not fit in one octet; or if the options make a header too long for its one-octet Hdr Ext Len, or longer than len declares.

Changed in version 1.6.0: Takes len, the Hdr Ext Len of a header the capture cut short (#2694).

classmethod register_option(code, meth)[source]¶

Parameters:

code (Option) – HOPOPT option code.
meth (str | tuple[Callable[[Option, OrderedMultiDict[Option, Option]], Option], Callable[[Option, Option | None, Any], Option]]) – Name X of the _read_opt_X and _make_opt_X methods, or a (parser, constructor) pair of callables, see __option__.

Warns:

RegistryWarning – If a different entry is already registered for code; it is overwritten. Handing back the entry already stored, or one equal to it, is a silent no-op. The entry code shipped with is accepted like any other, so an override can be undone (#1362, #1363).

classmethod id()[source]¶

Index ID of the protocol.

Return type:: tuple[Literal['HOPOPT']]
Returns:: Index ID of the protocol.

__post_init__(file=None, length=None, *, extension=False, **kwargs)[source]¶

Post initialisation hook.

Overloads:

file (IO[bytes] | bytes), length (int | None) = ..., *, extension (bool) = ..., **kwargs (Any) → None
**kwargs (Any) → None

Parameters:

file (IO[bytes] | bytes | None) – Source packet stream.
length (int | None) – Length of packet data.
extension (bool) – If the protocol is used as an IPv6 extension header.
**kwargs (Any) – Arbitrary keyword arguments.

See also

For construction arguments, please refer to make().

classmethod __index__()[source]¶

Numeral registry index of the protocol.

Return type:: TransType
Returns:: Numeral registry index of the protocol in IANA.

classmethod _make_data(data)[source]¶

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

Read HOPOPT options.

Parameters:: length (int) – Length of the options area, in octets.
Return type:: OrderedMultiDict[Option, Option]
Returns:: Extracted HOPOPT options
Raises:: ProtocolError – If the parsed options do not total exactly length octets, unless the capture cut the header short, as its short read records. Or if the capture cut an option short and its parser refuses the zeros it lacks, or its maker does not write the octets captured back.

Changed in version 1.6.0: A header the capture cut short reads as the short read it is, and an option it cuts as its parser reads the zeros it lacks, rather than being refused (#2694).

_make_hopopt_options(options)[source]¶

Make options for HOPOPT.

Parameters:: options (list[Option | tuple[Option | int, dict[str, Any]] | bytes] | OrderedMultiDict[Option, Option]) – HOPOPT options
Return type:: tuple[list[Option | bytes], int]
Returns:: Tuple of options and total length of options.
Raises:: ProtocolError – If the type of an option, given in a (type, kwargs) pair or as the key of a container, is a name, a bool or a code its field cannot carry, or if an option given as raw octets is empty (#2723).

Note

Options given as a list are fresh input: padding options in it are dropped, and padding is inserted after each option to align the header. Options given as a mapping, such as the OrderedMultiInfo of parsed data, are emitted in order with their own padding options kept, and padding is added only at the end if the header is not aligned.

The returned length is that of the options area alone, the value make() derives the Hdr Ext Len field from. Since the two octets of the fixed header precede it, an options area is well formed only when it is 2 octets short of a multiple of 8 – including when it holds no real options at all, in which case it is 6 octets of pure padding rather than empty.

_read_opt_none(schema, *, options)[source]¶

Read HOPOPT unassigned options.

Structure of HOPOPT unassigned options [RFC 8200]:

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

Parameters:

schema (UnassignedOption) – parsed parameter schema
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

UnassignedOption

Returns:

Parsed option data.

_read_opt_pad(schema, *, options)[source]¶

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
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

PadOption

Returns:

Parsed option data.

Raises:

ProtocolError – If code is NOT 0 or 1.

Note

A Pad1 option occupies a single octet and carries no Opt Data Len field, so its length is 1 rather than len + 2. That one-octet wire shape is enforced by PadOption itself, which sizes both the length octet and the padding data from the option type; clen is therefore always 0 here for a parsed Pad1, and the length check this method makes only guards a schema built by hand. A PadN whose Opt Data Len is 0 is a valid two-octet padding option [RFC 8200 Section 4.2].

_read_opt_tun(schema, *, options)[source]¶

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
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

TunnelEncapsulationLimitOption

Returns:

Parsed option data.

Raises:

ProtocolError – If schema.len is NOT 1.

_read_opt_ra(schema, *, options)[source]¶

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
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

RouterAlertOption

Returns:

Parsed option data.

Raises:

ProtocolError – If schema.len is NOT 2.

_read_opt_calipso(schema, *, options)[source]¶

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
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

CALIPSOOption

Returns:

Parsed option data.

Note

Cmpt Length counts 32-bit words and may be odd [RFC 5570 Section 5.2]; it only has to fit inside Opt Data Len, which calipso_pad_len() has already checked while the option was unpacked.

_read_opt_smf_dpd(schema, *, options)[source]¶

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
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

SMFDPDOption

Returns:

Parsed option data.

Raises:

ProtocolError – If the option is malformed.

_read_opt_pdm(schema, *, options)[source]¶

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
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

PDMOption

Returns:

Parsed option data.

Raises:

ProtocolError – If schema.len is NOT 10.

_read_opt_rpl(schema, *, options)[source]¶

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)                            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

The sub-TLVs, which RFC 6553 Section 3 says MUST be skipped when unrecognised, are kept as raw octets in sub_tlvs.

Parameters:

schema (RPLOption) – parsed parameter schema
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

RPLOption

Returns:

Parsed option data.

Raises:

ProtocolError – If schema.len is less than 4.

_read_opt_qs(schema, *, options)[source]¶

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
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

QuickStartOption

Returns:

Parsed option data.

Raises:

ProtocolError – If the option is malformed.

Note

An option whose QS function is neither of the two above has no defined layout, so the schema keeps it as an unassigned option and it is parsed as one, see _read_opt_none(). That dispatch is by the schema’s own class, decided from the octets a file read hands it; a QuickStartRequestOption or QuickStartReportOption built directly with an unassigned func reaches this method regardless, which is why it still raises below rather than returning early.

_read_opt_mpl(schema, *, options)[source]¶

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
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

MPLOption

Returns:

Parsed option data.

Raises:

ProtocolError – If the option is malformed.

_read_opt_ilnp(schema, *, options)[source]¶

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
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

ILNPOption

Returns:

Parsed option data.

_read_opt_lio(schema, *, options)[source]¶

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
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

LineIdentificationOption

Returns:

Parsed option data.

_read_opt_jumbo(schema, *, options)[source]¶

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
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

JumboPayloadOption

Returns:

Parsed option data.

Raises:

ProtocolError – If schema.len is NOT 4.

_read_opt_home(schema, *, options)[source]¶

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
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

HomeAddressOption

Returns:

Parsed option data.

Raises:

ProtocolError – If schema.len is NOT 16.

_read_opt_ip_dff(schema, *, options)[source]¶

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     |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

OptDataLenDFF is 3, the flags octet and the sequence number, as corrected by RFC 6971 Errata ID 3937; the RFC text says 2.

Parameters:

schema (IPDFFOption) – parsed parameter schema
options (OrderedMultiDict[Option, Option]) – extracted HOPOPT options

Return type:

IPDFFOption

Returns:

Parsed option data.

Raises:

ProtocolError – If schema.len is NOT 3.

_make_opt_none(code, opt=None, *, data=b'', **kwargs)[source]¶

Make HOPOPT unassigned option.

Parameters:

code (Option) – option type value
opt (UnassignedOption | None) – option data
data (bytes) – option payload in bytes
**kwargs (Any) – arbitrary keyword arguments

Return type:

UnassignedOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If data is too long for the one-octet Opt Data Len.

_make_opt_pad(code, opt=None, *, length=0, pad=b'', **kwargs)[source]¶

Make HOPOPT pad option.

Parameters:

code (Option) – option type value
opt (PadOption | None) – option data
length (int) – value of the Opt Data Len field, i.e. the number of padding octets after the two octets of the option header
pad (bytes) – the PadN option data, truncated or zero-filled to length octets
**kwargs (Any) – arbitrary keyword arguments

Return type:

PadOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If length does not fit the one-octet Opt Data Len.

Warns:

ProtocolWarning – If code is Pad1 but length is not 0; a PadN option is made instead.

Note

Data_PadOption.length counts the whole option, whereas Schema_PadOption.len is the Opt Data Len field: two octets fewer, and absent altogether for a Pad1. opt is honoured so that re-making a parsed padding option keeps its type and size. A PadN with length 0 is a valid two-octet option [RFC 8200 Section 4.2] and is kept.

_make_opt_tun(code, opt=None, *, limit=0, **kwargs)[source]¶

Make HOPOPT tunnel encapsulation limit option.

Parameters:

code (Option) – option type value
opt (TunnelEncapsulationLimitOption | None) – option data
limit (int) – tunnel encapsulation limit
**kwargs (Any) – arbitrary keyword arguments

Return type:

TunnelEncapsulationLimitOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If limit does not fit in one octet.

_make_opt_ra(code, opt=None, *, alert=RouterAlert.Datagram_contains_a_Multicast_Listener_Discovery_message, **kwargs)[source]¶

Make HOPOPT router alert option.

Parameters:

code (Option) – option type value
opt (RouterAlertOption | None) – option data
alert (RouterAlert | int) – router alert value
**kwargs (Any) – arbitrary keyword arguments

Return type:

RouterAlertOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If the router alert value is a name, a bool, or a member or code that does not fit in two octets.

_make_opt_calipso(code, opt=None, *, domain=0, level=0, checksum=b'\x00\x00', bitmap=None, pad=b'', **kwargs)[source]¶

Make HOPOPT calipso option.

Parameters:

code (Option) – option type value
opt (CALIPSOOption | None) – option data
domain (int) – CALIPSO domain of interpretation
level (int) – sensitivity level
checksum (bytes) – checksum of the option
bitmap (bytes | tuple[int, ...] | None) – compartment bitmap, as a bytes-like object or as an iterable of octets, such as the tuple the reader stores; its length must be a multiple of 4 octets
pad (bytes) – octets after the compartment bitmap, counted in Opt Data Len
**kwargs (Any) – arbitrary keyword arguments

Return type:

CALIPSOOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If domain or level does not fit its field, if checksum is not two octets, if the bitmap is not bytes-like or an iterable of octets, or is not a whole number of 32-bit words, if pad is not bytes, or if the option data would exceed the 255 octets Opt Data Len can count.

Note

Cmpt Length on the wire counts 32-bit words [RFC 5570 Section 5.1], whereas the bitmap here is sized in octets.

_make_opt_smf_dpd(code, opt=None, *, mode=SMFDPDMode.I_DPD, tid_type=None, tid=None, id=b'', hav=b'', **kwargs)[source]¶

Make HOPOPT SMF DPD option.

Parameters:

code (Option) – option type value
opt (SMFIdentificationBasedDPDOption | SMFHashBasedDPDOption | None) – option data
mode (SMFDPDMode | int) – DPD mode
tid_type (TaggerID | int | None) – TaggerID type (TidTy field); inferred from the length of tid if not given
tid (bytes | IPv4Address | IPv6Address | None) – Tagger ID
id (bytes) – identifier
hav (bytes) – hash assist value (HAV)
**kwargs (Any) – arbitrary keyword arguments

Return type:

SMFDPDOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If the DPD mode is a name, or a member or code that does not fit in one bit; if the TaggerID type is a name, a bool, or a member or code that does not fit in three bits; if the Tagger ID does not fit the TaggerID type, the H-DPD Hash Assist Value is empty, or the option data is too long for its one-octet Opt Data Len.

_make_opt_pdm(code, opt=None, *, psntp=0, psnlr=0, deltatlr=0, deltatls=0, scaledtlr=None, scaledtls=None, **kwargs)[source]¶

Make HOPOPT PDM option.

Parameters:

code (Option) – option type value
opt (PDMOption | None) – 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)
scaledtlr (int | None) – scale of delta time last received; derived from deltatlr if not given
scaledtls (int | None) – scale of delta time last sent; derived from deltatls if not given
**kwargs (Any) – arbitrary keyword arguments

Return type:

PDMOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If psntp or psnlr does not fit in two octets, a scale does not fit in one octet, or a delta is negative or, at the scale given for it, does not fit two octets.

_make_opt_rpl(code, opt=None, *, down=False, rank_err=False, fwd_err=False, id=0, rank=0, reserved=0, sub_tlvs=b'', **kwargs)[source]¶

Make HOPOPT RPL option.

Parameters:

code (Option) – option type value
opt (RPLOption | None) – 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
reserved (int) – reserved flag bits, i.e. the low five bits of the flags octet
sub_tlvs (bytes) – sub-TLVs, as raw octets
**kwargs (Any) – arbitrary keyword arguments

Return type:

RPLOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If reserved, id or rank does not fit its field, or sub_tlvs does not fit in the option.

_make_opt_qs(code, opt=None, *, func=QSFunction.Quick_Start_Request, rate=0, ttl=0, nonce=0, reserved=0, unused=b'\x00', **kwargs)[source]¶

Make HOPOPT QS option.

Parameters:

code (Option) – option type value
opt (QuickStartOption | UnassignedOption | None) – option data
func (QSFunction | int) – QS function type
rate (int) – rate (in kbps), rounded down to the nearest rate the four-bit rate code carries (RFC 4782 Section 3.1)
ttl (timedelta | int) – time to live (in seconds)
nonce (int) – nonce value
reserved (int) – reserved bits (R) after the nonce
unused (bytes) – the “Not Used” octet of a report of approved rate
**kwargs (Any) – arbitrary keyword arguments

Return type:

QuickStartOption | UnassignedOption

Returns:

Constructed option schema. An unassigned option schema if opt is a Quick-Start option parsed as unassigned, see _read_opt_qs(), or if func is neither of the assigned functions, in which case the option data takes the layout of a Quick-Start Request.

Raises:

ProtocolError – If func is a name, a bool, or a member or code that does not fit in four bits, the rate code cannot carry rate, ttl, nonce or reserved does not fit its field, or unused is not one octet.

_make_opt_mpl(code, opt=None, *, seed_type=None, max=False, drop=False, reserved=0, seq=0, seed=None, **kwargs)[source]¶

Make HOPOPT MPL option.

Parameters:

code (Option) – option type value
opt (MPLOption | None) – option data
seed_type (SeedID | int | None) – seed-id type (S field); inferred from seed if not given
max (bool) – maximum sequence number flag
drop (bool) – drop packet flag
reserved (int) – reserved bits (rsv), i.e. the low four bits of the flags octet
seq (int) – MPL sequence number
seed (int | IPv6Address | None) – MPL seed ID, ignored when the seed-id type is IPV6_SOURCE_ADDRESS, as the seed is then the IPv6 source address
**kwargs (Any) – arbitrary keyword arguments

Return type:

MPLOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If the seed-id type is a name, a bool, or a member or code that does not fit in two bits; if the seed ID is missing or does not fit the seed-id type, or reserved or seq does not fit its field.

_make_opt_ilnp(code, opt=None, *, nonce=0, **kwargs)[source]¶

Make HOPOPT ILNP option.

Parameters:

code (Option) – option type value
opt (ILNPOption | None) – option data
nonce (int) – ILNP nonce value
**kwargs (Any) – arbitrary keyword arguments

Return type:

ILNPOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If nonce is negative, or needs more octets than Opt Data Len can count.

_make_opt_lio(code, opt=None, *, id=b'', **kwargs)[source]¶

Make HOPOPT LIO option.

Parameters:

code (Option) – option type value
opt (LineIdentificationOption | None) – option data
id (bytes) – line ID value
**kwargs (Any) – arbitrary keyword arguments

Return type:

LineIdentificationOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If id is too long for the one-octet Opt Data Len.

_make_opt_jumbo(code, opt=None, *, len=0, **kwargs)[source]¶

Make HOPOPT Jumbo Payload option.

Parameters:

code (Option) – option type value
opt (JumboPayloadOption | None) – option data
len (int) – jumbo payload length
**kwargs (Any) – arbitrary keyword arguments

Return type:

JumboPayloadOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If len does not fit in four octets.

_make_opt_home(code, opt=None, *, addr='::', **kwargs)[source]¶

Make HOPOPT Home Address option.

Parameters:

code (Option) – option type value
opt (HomeAddressOption | None) – option data
addr (IPv6Address | str | bytes | int) – home address value
**kwargs (Any) – arbitrary keyword arguments

Return type:

HomeAddressOption

Returns:

Constructed option schema.

_make_opt_ip_dff(code, opt=None, *, version=0, dup=False, ret=False, reserved=0, seq=0, **kwargs)[source]¶

Make HOPOPT IP DFF option.

Parameters:

code (Option) – option type value
opt (IPDFFOption | None) – option data
version (int) – DFF version
dup (bool) – duplicate packet flag
ret (bool) – return packet flag
reserved (int) – reserved bits, i.e. the low four bits of the flags octet
seq (int) – DFF sequence number
**kwargs (Any) – arbitrary keyword arguments

Return type:

IPDFFOption

Returns:

Constructed option schema.

Raises:

ProtocolError – If version, reserved or seq does not fit its field.

Header Schemas¶

Removed in version 1.6.0: pcapkit.protocols.schema.internet.hopopt, with no alias: the module moved here (#2534).

class pcapkit.protocols.internet.hopopt.schema.HOPOPT(next=NO_VALUE, len=NO_VALUE, options=NO_VALUE, payload=NO_VALUE, *, __packet__=None, **kwargs)[source]¶

Bases: Schema

Header schema for HOPOPT packet.

next: 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.internet.hopopt.schema.Option(*args, **kwargs)[source]¶

Bases: EnumSchema[Option]

Header schema for HOPOPT options.

type: Option = <EnumField type>¶: Option type.

len: int = <ConditionalField len>¶: Option length (conditional in case of Pad1 option).

post_process(packet)[source]¶

Revise schema data after unpacking process.

Parameters:: packet (dict[str, Any]) – Unpacked data.
Return type:: Schema
Returns:: Revised schema.

class pcapkit.protocols.internet.hopopt.schema.UnassignedOption(type=NO_VALUE, len=NO_VALUE, data=NO_VALUE, *, __packet__=None, **kwargs)[source]¶

HOPOPT - IPv6 Hop-by-Hop Options¶

Header Schemas¶

Type Stubs¶

Auxiliary Functions¶

Data Models¶