MH - Mobility Header

pcapkit.protocols.internet.mh contains MH only, which implements extractor for Mobility Header (MH) [*], whose structure is described as below:

Octets	Bits	Name	Description
0	0	mh.next	Next Header
1	8	mh.length	Header Length
2	16	mh.type	Mobility Header Type
3	24		Reserved
4	32	mh.chksum	Checksum
6	48	mh.data	Message Data

Todo

Implements extractor for message data of all MH types.

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

Bases: Internet[MH, MH]

This class implements Mobility Header.

This class currently supports parsing og the following MH message types, which are resgitered in the self.__message__ attribute:

Message Type	Message Parser	Message Constructor
Binding_Refresh_Request	_read_msg_brr()	_make_msg_brr()
Home_Test_Init	_read_msg_hoti()	_make_msg_hoti()
Care_of_Test_Init	_read_msg_coti()	_make_msg_coti()
Home_Test	_read_msg_hot()	_make_msg_hot()
Care_of_Test	_read_msg_cot()	_make_msg_cot()
Binding_Update	_read_msg_bu()	_make_msg_bu()
Binding_Acknowledgement	_read_msg_ba()	_make_msg_ba()
Binding_Error	_read_msg_be()	_make_msg_be()

This class currently supports parsing the following MH 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()
Binding_Refresh_Advice	_read_opt_bra()	_make_opt_bra()
Alternate_Care_of_Address	_read_opt_aca()	_make_opt_aca()
Nonce_Indices	_read_opt_ni()	_make_opt_ni()
Authorization_Data	_read_opt_bad()	_make_opt_bad()
Mobile_Network_Prefix_Option	_read_opt_mnp()	_make_opt_mnp()
Mobility_Header_Link_Layer_Address_option	_read_opt_lla()	_make_opt_lla()
MN_ID_OPTION_TYPE	_read_opt_mn_id()	_make_opt_mn_id()
AUTH_OPTION_TYPE	_read_opt_auth()	_make_opt_auth()
MESG_ID_OPTION_TYPE	_read_opt_mesg_id()	_make_opt_mesg_id()
CGA_Parameters_Request	_read_opt_cga_pr()	_make_opt_cga_pr()
CGA_Parameters	_read_opt_cga_param()	_make_opt_cga_param()
Signature	_read_opt_signature()	_make_opt_signature()
Permanent_Home_Keygen_Token	_read_opt_phkt()	_make_opt_phkt()
Care_of_Test_Init	_read_opt_ct_init()	_make_opt_ct_init()
Care_of_Test	_read_opt_ct()	_make_opt_ct()

This class currently supports parsing of the following MH CGA extensions, which are registered in the self.__extension__ attribute:

CGA Extension Code	CGA Extension Parser	CGA Extension Constructor
Multi_Prefix	_read_ext_multiprefix()	_make_ext_multiprefix()

property name: Literal['Mobility Header']

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

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_message(code, meth)

Register a message parser.

Parameters:

• code (Packet) – MH message type code.

• meth (str | tuple[Callable[[Packet, MH], MH], Callable[[MH | None, Any], Packet]]) – Method name or callable to parse and/or construct the message.

Return type:

None

classmethod register_option(code, meth)

Register an option parser.

Parameters:

• code (Option) – MH option code.

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

Return type:

None

classmethod register_extension(code, meth)

Register a CGA extension parser.

Parameters:

• code (CGAExtension) – CGA extension code.

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

Return type:

None

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

Read Mobility Header.

Structure of MH header [RFC 6275]:

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Payload Proto |  Header Len   |   MH Type     |   Reserved    |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|           Checksum            |                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               |
|                                                               |
.                                                               .
.                       Message Data                            .
.                                                               .
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• length (int | None) – Length of packet data.

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

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

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

Return type:

MH

Returns:

Parsed packet data.

make(next=<TransType.UDP: 17>, next_default=None, next_namespace=None, next_reversed=False, type=<Packet.Binding_Refresh_Request: 0>, type_default=None, type_namespace=None, type_reversed=False, chksum=b'', data=b'\\x00\\x00', payload=b'', **kwargs)

Make (construct) packet data.

Parameters:

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

• next_default (int | None) – Default value for next header type field.

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

• next_reversed (bool) – Whether the bits of next header type field is reversed.

• type (Packet | IntEnum | IntEnum | str | int) – Mobility Header type.

• type_default (int | None) – Default value for Mobility Header type field.

• type_namespace (dict[str, int] | dict[int, str] | Type[IntEnum] | Type[IntEnum] | None) – Namespace of Mobility Header type field.

• type_reversed (bool) – Whether the bits of Mobility Header type field is reversed.

• chksum (bytes) – Checksum.

• data (bytes | MH | Packet | dict[str, Any]) – Message data.

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

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

Return type:

MH

Returns:

Constructed packet data.

classmethod _make_data(data)

Create key-value pairs from data for protocol construction.

Parameters:

data (MH) – protocol data

Return type:

dict[str, Any]

Returns:

Key-value pairs for protocol construction.

_read_msg_unknown(schema, *, header)

Read unknown MH message type.

Parameters:

• schema (UnknownMessage) – Parsed message type schema.

• header (MH) – Parsed MH header schema.

Return type:

UnknownMessage

Returns:

Parsed message type data.

_read_msg_brr(schema, *, header)

Read MH binding refresh request (BRR) message type.

Structure of MH Binding Refresh Request Message [RFC 6275]:

                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |          Reserved             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
.                                                               .
.                        Mobility Options                       .
.                                                               .
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (BindingRefreshRequestMessage) – Parsed message type schema.

• header (MH) – Parsed MH header schema.

Return type:

BindingRefreshRequestMessage

Returns:

Parsed message type data.

_read_msg_hoti(schema, *, header)

Read MH home test initiation (HoTI) message type.

Structure of MH Home Test Initiation Message [RFC 6275]:

                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |           Reserved            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                       Home Init Cookie                        +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
.                                                               .
.                       Mobility Options                        .
.                                                               .
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (HomeTestInitMessage) – Parsed message type schema.

• header (MH) – Parsed MH header schema.

Return type:

HomeTestInitMessage

Returns:

Parsed message type data.

_read_msg_coti(schema, *, header)

Read MH care-of test initiation (CoTI) message type.

Structure of MH Care-of Test Initiation Message [RFC 6275]:

                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |           Reserved            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                      Care-of Init Cookie                      +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
.                                                               .
.                        Mobility Options                       .
.                                                               .
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (CareofTestInitMessage) – Parsed message type schema.

• header (MH) – Parsed MH header schema.

Return type:

CareofTestInitMessage

Returns:

Parsed message type data.

_read_msg_hot(schema, *, header)

Read MH home test (HoT) message type.

Structure of MH Home Test Message [RFC 6275]:

                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |       Home Nonce Index        |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                        Home Init Cookie                       +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                       Home Keygen Token                       +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
.                                                               .
.                        Mobility Options                       .
.                                                               .
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (HomeTestMessage) – Parsed message type schema.

• header (MH) – Parsed MH header schema.

Return type:

HomeTestMessage

Returns:

Parsed message type data.

_read_msg_cot(schema, *, header)

Read MH care-of test (CoT) message type.

Structure of MH Care-of Test Message [RFC 6275]:

                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |      Care-of Nonce Index      |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                      Care-of Init Cookie                      +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                     Care-of Keygen Token                      +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
.                                                               .
.                        Mobility Options                       .
.                                                               .
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (CareofTestMessage) – Parsed message type schema.

• header (MH) – Parsed MH header schema.

Return type:

CareofTestMessage

Returns:

Parsed message type data.

_read_msg_bu(schema, *, header)

Read MH binding update (BU) message type.

Structure of MH Binding Update Message [RFC 6275]:

                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |          Sequence #           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|A|H|L|K|        Reserved       |           Lifetime            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
.                                                               .
.                        Mobility Options                       .
.                                                               .
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (BindingUpdateMessage) – Parsed message type schema.

• header (MH) – Parsed MH header schema.

Return type:

BindingUpdateMessage

Returns:

Parsed message type data.

_read_msg_ba(schema, *, header)

Read MH binding acknowledgement (BA) message type.

Structure of MH Binding Acknowledgement Message [RFC 6275]:

                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |    Status     |K|  Reserved   |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|           Sequence #          |           Lifetime            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
.                                                               .
.                        Mobility Options                       .
.                                                               .
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (BindingAcknowledgementMessage) – Parsed message type schema.

• header (MH) – Parsed MH header schema.

Return type:

BindingAcknowledgementMessage

Returns:

Parsed message type data.

_read_msg_be(schema, *, header)

Read MH binding error (BE) message type.

Structure of MH Binding Error Message [RFC 6275]:

                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |     Status    |   Reserved    |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                                                               +
|                                                               |
+                          Home Address                         +
|                                                               |
+                                                               +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
.                                                               .
.                        Mobility Options                       .
.                                                               .
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (BindingErrorMessage) – Parsed message type schema.

• header (MH) – Parsed MH header schema.

Return type:

BindingErrorMessage

Returns:

Parsed message type data.

_make_msg_unknown(message, *, data=b'', **kwargs)

Make MH unknown message type.

Parameters:

• message (UnknownMessage | None) – Message data model.

• data (bytes) – Raw message data.

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

Return type:

UnknownMessage

Returns:

Constructed message type.

_make_msg_brr(message, *, options=None, **kwargs)

Make MH binding refresh request (BRR) message type.

Parameters:

• message (BindingRefreshRequestMessage | None) – Message data model.

• options (OrderedMultiDict[Option, Option] | list[Option | tuple[Option, dict[str, Any]] | bytes] | None) – Mobility options.

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

Return type:

BindingRefreshRequestMessage

Returns:

Constructed message type.

_make_msg_hoti(message, *, cookie=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', options=None, **kwargs)

Make MH home test init (HoTI) message type.

Parameters:

• message (HomeTestInitMessage | None) – Message data model.

• cookie (bytes) – Home test cookie.

• options (OrderedMultiDict[Option, Option] | list[Option | tuple[Option, dict[str, Any]] | bytes] | None) – Mobility options.

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

Return type:

HomeTestInitMessage

Returns:

Constructed message type.

_make_msg_coti(message, *, cookie=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', options=None, **kwargs)

Make MH care-of test init (CoTI) message type.

Parameters:

• message (CareofTestInitMessage | None) – Message data model.

• cookie (bytes) – Care-of test cookie.

• options (OrderedMultiDict[Option, Option] | list[Option | tuple[Option, dict[str, Any]] | bytes] | None) – Mobility options.

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

Return type:

CareofTestInitMessage

Returns:

Constructed message type.

_make_msg_hot(message, *, nonce_index=0, cookie=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', token=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', options=None, **kwargs)

Make MH home test (HoT) message type.

Parameters:

• message (HomeTestMessage | None) – Message data model.

• nonce_index (int) – Home nonce index.

• cookie (bytes) – Home test cookie.

• token (bytes) – Home test token.

• options (OrderedMultiDict[Option, Option] | list[Option | tuple[Option, dict[str, Any]] | bytes] | None) – Mobility options.

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

Return type:

HomeTestMessage

Returns:

Constructed message type.

_make_msg_cot(message, *, nonce_index=0, cookie=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', token=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', options=None, **kwargs)

Make MH care-of test (CoT) message type.

Parameters:

• message (CareofTestMessage | None) – Message data model.

• nonce_index (int) – Care-of nonce index.

• cookie (bytes) – Care-of test cookie.

• token (bytes) – Care-of test token.

• options (OrderedMultiDict[Option, Option] | list[Option | tuple[Option, dict[str, Any]] | bytes] | None) – Mobility options.

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

Return type:

CareofTestMessage

Returns:

Constructed message type.

_make_msg_bu(message, *, seq=0, ack=False, home=False, lla_compat=False, key_mngt=False, lifetime=4, options=None, **kwargs)

Make MH binding update (BU) message type.

Parameters:

• message (BindingUpdateMessage | None) – Message data model.

• seq (int) – Sequence number.

• ack (bool) – Acknowledgement flag.

• home (bool) – Home registration flag.

• lla_compat (bool) – LLA compatibility flag.

• key_mngt (bool) – Key management mobility option flag.

• lifetime (int | timedelta) – Lifetime in seconds or timedelta.

• options (OrderedMultiDict[Option, Option] | list[Option | tuple[Option, dict[str, Any]] | bytes] | None) – Mobility options.

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

Return type:

BindingUpdateMessage

Returns:

Constructed message type.

_make_msg_ba(message, *, status=<StatusCode.Binding_Update_accepted_Proxy_Binding_Update_accepted: 0>, status_default=None, status_namespace=None, status_reversed=False, key_mngt=False, seq=0, lifetime=4, options=None, **kwargs)

Make MH binding acknowledge (BA) message type.

Parameters:

• message (BindingAcknowledgementMessage | None) – Message data model.

• status (StatusCode | IntEnum | IntEnum | str | int) – Status code.

• status_default (int | None) – Default status code.

• status_namespace (dict[str, int] | dict[int, str] | Type[IntEnum] | Type[IntEnum] | None) – Status code namespace.

• status_reversed (bool) – Reverse status code namespace.

• key_mngt (bool) – Key management mobility option flag.

• seq (int) – Sequence number.

• lifetime (int | timedelta) – Lifetime in seconds or timedelta.

• options (OrderedMultiDict[Option, Option] | list[Option | tuple[Option, dict[str, Any]] | bytes] | None) – Mobility options.

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

Return type:

BindingAcknowledgementMessage

Returns:

Constructed message type.

_make_msg_be(message, *, status=<StatusCode.Binding_Update_accepted_Proxy_Binding_Update_accepted: 0>, status_default=None, status_namespace=None, status_reversed=False, home='::', options=None, **kwargs)

Make MH binding error (BE) message type.

Parameters:

• message (BindingErrorMessage | None) – Message data model.

• status (StatusCode | IntEnum | IntEnum | str | int) – Status code.

• status_default (int | None) – Default status code.

• status_namespace (dict[str, int] | dict[int, str] | Type[IntEnum] | Type[IntEnum] | None) – Status code namespace.

• status_reversed (bool) – Reverse status code namespace.

• home (IPv6Address | int | str | bytes) – Home address.

• options (OrderedMultiDict[Option, Option] | list[Option | tuple[Option, dict[str, Any]] | bytes] | None) – Mobility options.

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

Return type:

BindingErrorMessage

Returns:

Constructed message type.

_read_mh_options(options_schema)

Read MH options.

Structure of MH 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 |   Option Data...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

options_schema (list[Option]) – Parsed MH options.

Return type:

OrderedMultiDict[Option, Option]

Returns:

Parsed MH options data.

_read_opt_none(schema, *options)

Read MH unassigned option.

Parameters:

• schema (UnassignedOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

UnassignedOption

Returns:

Constructed option data.

_read_opt_pad(schema, *, options)

Read MH padding option.

Structure of MH padding option [RFC 6275]:

• Pad1 option:

   0
   0 1 2 3 4 5 6 7
  +-+-+-+-+-+-+-+-+
  |   Type = 0    |
  +-+-+-+-+-+-+-+-+
  

• PadN option:

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

Parameters:

• schema (PadOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

PadOption

Returns:

Constructed option data.

_read_opt_pad(schema, *, options)

Read MH padding option.

Structure of MH padding option [RFC 6275]:

• Pad1 option:

   0
   0 1 2 3 4 5 6 7
  +-+-+-+-+-+-+-+-+
  |   Type = 0    |
  +-+-+-+-+-+-+-+-+
  

• PadN option:

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

Parameters:

• schema (PadOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

PadOption

Returns:

Constructed option data.

_read_opt_bra(schema, *, options)

Read MH binding refresh advice option.

Structure of MH Binding Refresh Advice 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
                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |   Type = 2    |   Length = 2  |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|       Refresh Interval        |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (BindingRefreshAdviceOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

BindingRefreshAdviceOption

Returns:

Constructed option data.

_read_opt_aca(schema, *, options)

Read MH alternate care-of address option.

Structure of MH Alternate Care-of 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
                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |   Type = 3    |  Length = 16  |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                                                               +
|                                                               |
+                   Alternate Care-of Address                   +
|                                                               |
+                                                               +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (AlternateCareofAddressOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

AlternateCareofAddressOption

Returns:

Constructed option data.

_read_opt_ni(schema, *, options)

Read MH nonce indices option.

Structure of MH Nonce Indices 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
                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |   Type = 4    |   Length = 4  |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|         Home Nonce Index      |     Care-of Nonce Index       |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (NonceIndicesOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

NonceIndicesOption

Returns:

Constructed option data.

_read_opt_bad(schema, *, options)

Read MH binding authorization data option.

Structure of MH Binding Authorization Data 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
                                +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                                |   Type = 5    | Option Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                                                               +
|                         Authenticator                         |
+                                                               +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (AuthorizationDataOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

AuthorizationDataOption

Returns:

Constructed option data.

_read_opt_mnp(schema, *, options)

Read MH mobile network prefix option.

Structure of MH Mobile Network Prefix option [RFC 3963]:

 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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|      Type     |   Length      |   Reserved    | Prefix Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                                                               +
|                                                               |
+                   Mobile Network Prefix                       +
|                                                               |
+                                                               +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (MobileNetworkPrefixOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

MobileNetworkPrefixOption

Returns:

Constructed option data.

_read_opt_lla(schema, *, options)

Read MH link-layer address (MH-LLA) option.

Structure of MH Link-Layer Address option [RFC 5568]:

 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
                              +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
                              |     Type      |     Length    |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Option-Code   |                  LLA                     ....
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (LinkLayerAddressOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

LinkLayerAddressOption

Returns:

Constructed option data.

_read_opt_mn_id(schema, *, options)

Read MH mobile node identifier option.

Structure of MH Mobile Node Identifier option [RFC 4283]:

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 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|  Subtype      |          Identifier ...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (MNIDOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

MNIDOption

Returns:

Constructed option data.

_read_opt_auth(schema, *, options)

Read MH mobility message authentication option.

Structure of MH Mobility Message Authentication option [RFC 4285]:

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 |  Subtype      |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                  Mobility SPI                                 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                  Authentication Data ....
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (AuthOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

AuthOption

Returns:

Constructed option data.

_read_opt_mesg_id(schema, *, options)

Read MH mobility message replay protection option.

Structure of MH Mobility Message Replay Protection option [RFC 4285]:

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

Parameters:

• schema (MesgIDOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

MesgIDOption

Returns:

Constructed option data.

_read_opt_cga_pr(schema, *, options)

Read MH CGA parameters request option.

Structure of MH CGA Parameters Request option [RFC 4866]:

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

Parameters:

• schema (CGAParametersRequestOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

CGAParametersRequestOption

Returns:

Constructed option data.

_read_opt_cga_param(schema, *, options)

Read MH CGA parameters option.

Structure of MH CGA Parameters option [RFC 4866]:

 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 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
:                                                               :
:                          CGA Parameters                       :
:                                                               :
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (CGAParametersOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

CGAParametersOption

Returns:

Constructed option data.

_read_opt_signature(schema, *, options)

Read MH signature option.

Structure of MH Signature option [RFC 4866]:

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

Parameters:

• schema (SignatureOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

SignatureOption

Returns:

Constructed option data.

_read_opt_phkt(schema, *, options)

Read MH permanent home keygen token option.

Structure of MH Permanent Home Keygen Token option [RFC 4866]:

 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 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
:                                                               :
:                  Permanent Home Keygen Token                  :
:                                                               :
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (PermanentHomeKeygenTokenOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

PermanentHomeKeygenTokenOption

Returns:

Constructed option data.

_read_opt_ct_init(schema, *, options)

Read MH Care-of Test Init option.

Structure of MH Care-of Test Init option [RFC 4866]:

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

Parameters:

• schema (CareofTestInitOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

CareofTestInitOption

Returns:

Constructed option data.

_read_opt_ct(schema, *, options)

Read MH Care-of Test option.

Structure of MH Care-of Test option [RFC 4866]:

 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 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                     Care-of Keygen Token                      +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (CareofTestOption) – Parsed option schema.

• options (OrderedMultiDict[Option, Option]) – Parsed MH options.

Return type:

CareofTestOption

Returns:

Constructed option data.

_make_mh_options(options)

Make options for MH.

Parameters:

options (OrderedMultiDict[Option, Option] | list[Option | tuple[Option, dict[str, Any]] | bytes]) – MH options.

Return type:

list[Option | bytes]

Returns:

Mobility options list.

_make_opt_none(type, option=None, *, data=b'', **kwargs)

Make MH unassigned option.

Parameters:

• type (Option) – Option type.

• option (UnassignedOption | None) – Option data model.

• data (bytes) – Option data.

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

Return type:

UnassignedOption

Returns:

Constructed option schema.

_make_opt_pad(type, option=None, *, length=0, **kwargs)

Make MH pad option.

Parameters:

• type (Option) – Option type.

• option (PadOption | None) – Option data model.

• length (int) – Padding length.

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

Return type:

PadOption

Returns:

Constructed option schema.

_make_opt_pad(type, option=None, *, length=0, **kwargs)

Make MH pad option.

Parameters:

• type (Option) – Option type.

• option (PadOption | None) – Option data model.

• length (int) – Padding length.

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

Return type:

PadOption

Returns:

Constructed option schema.

_make_opt_bra(type, option=None, *, interval=0, **kwargs)

Make MH binding refresh advice option.

Parameters:

• type (Option) – Option type.

• option (BindingRefreshAdviceOption | None) – Option data model.

• interval (int) – Refresh interval.

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

Return type:

BindingRefreshAdviceOption

Returns:

Constructed option schema.

_make_opt_aca(type, option=None, *, address='::', **kwargs)

Make MH alternate care-of address option.

Parameters:

• type (Option) – Option type.

• option (AlternateCareofAddressOption | None) – Option data model.

• address (bytes | str | int | IPv6Address) – Alternate care-of address.

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

Return type:

AlternateCareofAddressOption

Returns:

Constructed option schema.

_make_opt_ni(type, option=None, *, home=0, careof=0, **kwargs)

Make MH nonce indices option.

Parameters:

• type (Option) – Option type.

• option (NonceIndicesOption | None) – Option data model.

• home (int) – Home nonce index.

• careof (int) – Care-of nonce index.

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

Return type:

NonceIndicesOption

Returns:

Constructed option schema.

_make_opt_bad(type, option=None, *, data=b'', **kwargs)

Make MH binding authorization data option.

Parameters:

• type (Option) – Option type.

• option (AuthorizationDataOption | None) – Option data model.

• data (bytes) – Authenticator.

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

Return type:

AuthorizationDataOption

Returns:

Constructed option schema.

_make_opt_mnp(type, option=None, *, prefix='::/0', **kwargs)

Make MH mobile network prefix option.

Parameters:

• type (Option) – Option type.

• option (MobileNetworkPrefixOption | None) – Option data model.

• prefix (bytes | str | IPv6Network) – Mobile network prefix.

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

Return type:

MobileNetworkPrefixOption

Returns:

Constructed option schema.

_make_opt_lla(type, option=None, *, address=b'', **kwargs)

Make MH link-layer address option.

Parameters:

• type (Option) – Option type.

• option (LinkLayerAddressOption | None) – Option data model.

• address (bytes) – Link-layer address.

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

Return type:

LinkLayerAddressOption

Returns:

Constructed option schema.

_make_opt_mn_id(type, option=None, *, subtype=<MNIDSubtype.IPv6_Address: 2>, subtype_default=None, subtype_namespace=None, subtype_reversed=False, identifier='::', **kwargs)

Make MH mobile node identifier option.

Parameters:

• type (Option) – Option type.

• option (MNIDOption | None) – Option data model.

• subtype (MNIDSubtype | IntEnum | IntEnum | str | int) – MN-ID subtype.

• subtype_default (int | None) – MN-ID subtype default value.

• subtype_namespace (dict[str, int] | dict[int, str] | Type[IntEnum] | Type[IntEnum] | None) – MN-ID subtype namespace.

• subtype_reversed (bool) – MN-ID subtype reversed flag.

• identifier (bytes | str | IPv6Address | int) – Identifier.

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

Return type:

MNIDOption

Returns:

Constructed option schema.

_make_opt_auth(type, option=None, *, subtype=<AuthSubtype.MN_HA: 1>, subtype_default=None, subtype_namespace=None, subtype_reversed=False, spi=0, data=b'', **kwargs)

Make MH authentication option.

Parameters:

• type (Option) – Option type.

• option (AuthOption | None) – Option data model.

• subtype (AuthSubtype | IntEnum | IntEnum | str | int) – Authentication subtype.

• subtype_default (int | None) – Authentication subtype default value.

• subtype_namespace (dict[str, int] | dict[int, str] | Type[IntEnum] | Type[IntEnum] | None) – Authentication subtype namespace.

• subtype_reversed (bool) – Authentication subtype reversed flag.

• spi (int) – Security parameter index.

• data (bytes) – Authentication data.

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

Return type:

AuthOption

Returns:

Constructed option schema.

_make_opt_mesg_id(type, option=None, *, timestamp=None, interval=None, **kwargs)

Make MH mobility message replay protection option.

Parameters:

• type (Option) – Option type.

• option (MesgIDOption | None) – Option data model.

• timestamp (NTPTimestamp | None) – NTP timestamp, c.f., RFC 1305.

• interval (datetime | None) – Timestamp interval (since UNIX-epoch).

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

Return type:

MesgIDOption

Returns:

Constructed option schema.

_make_opt_cga_pr(type, option=None, **kwargs)

Make MH CGA parameters request option.

Parameters:

• type (Option) – Option type.

• option (CGAParametersRequestOption | None) – Option data model.

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

Return type:

CGAParametersRequestOption

Returns:

Constructed option schema.

_make_opt_cga_param(type, option=None, *, parameters=None, **kwargs)

Make MH CGA paramters option.

Parameters:

• type (Option) – Option type.

• option (CGAParametersOption | None) – Option data model.

• parameters (list[CGAParameter | CGAParameter | dict[str, Any] | bytes] | None) – CGA parameters.

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

Return type:

CGAParametersOption

Returns:

Constructed option schema.

_make_opt_signature(type, option=None, *, signature=b'', **kwargs)

Make MH signature option.

Parameters:

• type (Option) – Option type.

• option (SignatureOption | None) – Option data model.

• signature (bytes) – Signature data.

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

Return type:

SignatureOption

Returns:

Constructed option schema.

_make_opt_phkt(type, option=None, *, token=b'', **kwargs)

Make MH permanent home keygen token option.

Parameters:

• type (Option) – Option type.

• option (PermanentHomeKeygenTokenOption | None) – Option data model.

• token (bytes) – Token data.

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

Return type:

PermanentHomeKeygenTokenOption

Returns:

Constructed option schema.

_make_opt_ct_init(type, option=None, **kwargs)

Make MH Care-of Test Init option.

Parameters:

• type (Option) – Option type.

• option (CareofTestInitOption | None) – Option data model.

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

Return type:

CareofTestInitOption

Returns:

Constructed option schema.

_make_opt_ct(type, option=None, token=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', **kwargs)

Make MH Care-of Test option.

Parameters:

• type (Option) – Option type.

• option (CareofTestOption | None) – Option data model.

• token (bytes) – Care-of keygen token.

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

Return type:

CareofTestOption

Returns:

Constructed option schema.

_read_cga_extensions(extensions_schema)

Read CGA extensions.

Structure of CGA extensions [RFC 4581]:

 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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|         Extension Type        |   Extension Data Length       |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
~                       Extension Data                          ~
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

extensions_schema (list[CGAExtension]) – Parsed CGA extensions.

Return type:

OrderedMultiDict[CGAExtension, CGAExtension]

Returns:

Parsed CGA extensions data.

_read_ext_none(schema, *, extensions)

Read unknown CGA extension.

Parameters:

• schema (UnknownExtension) – Parsed extension schema.

• extensions (OrderedMultiDict[CGAExtension, CGAExtension]) – Parsed MH CGA extensions.

Return type:

UnknownExtension

Returns:

Constructed extension data.

_read_ext_multiprefix(schema, *, extensions)

Read multi-prefix CGA extension.

Structure of Multi-Prefix CGA extension [RFC 5535]:

 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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|         Extension Type        |   Extension Data Length       |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|P|                         Reserved                            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                           Prefix[1]                           +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                           Prefix[2]                           +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
.                               .                               .
.                               .                               .
.                               .                               .
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                           Prefix[n]                           +
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Parameters:

• schema (MultiPrefixExtension) – Parsed extension schema.

• extensions (OrderedMultiDict[CGAExtension, CGAExtension]) – Parsed MH CGA extensions.

Return type:

MultiPrefixExtension

Returns:

Constructed extension data.

_make_cga_extensions(extensions)

Make CGA extensions for MH.

Parameters:

extensions (OrderedMultiDict[CGAExtension, CGAExtension] | list[CGAExtension | tuple[CGAExtension, dict[str, Any]] | bytes]) – CGA extensions.

Return type:

tuple[list[CGAExtension | bytes], int]

Returns:

Tuple of extensions and total length of extensions.

_make_ext_none(type, option=None, *, data=b'', **kwargs)

Make CGA extension.

Parameters:

• type (CGAExtension) – Extension type.

• option (UnknownExtension | None) – Extension data model.

• data (bytes) – Extension data.

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

Return type:

UnknownExtension

Returns:

Constructed extension schema.

_make_ext_multiprefix(type, option=None, *, flag=False, prefixes=None, **kwargs)

Make CGA multi-prefix extension.

Parameters:

• type (CGAExtension) – Extension type.

• option (MultiPrefixExtension | None) – Extension data model.

• flag (bool) – Public key flag.

• prefixes (list[int] | None) – Prefixes.

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

Return type:

MultiPrefixExtension

Returns:

Constructed extension schema.

__message__: DefaultDict[Packet | int, str | tuple[Callable[[Packet, MH], MH], Callable[[MH | None, Any], Packet]]]

DefaultDict[Enum_Packet, str | tuple[PacketParser, PacketConstructor]]: Message type to method mapping. Method names are expected to be referred to the class by _read_msg_${name} and/or _make_msg_${name}, and if such name not found, the value should then be a method that can parse the message type by itself.

__option__: DefaultDict[Option | int, str | tuple[Callable[[Option, OrderedMultiDict[Option, Option]], Option], Callable[[Option, Option | None, Any], Option]]]

DefaultDict[Enum_Option, str | tuple[OptionParser, OptionConstructor]]: Option type to method mapping. Method names are expected to be referred to the class by _read_option_${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.

__extension__: DefaultDict[CGAExtension | int, str | tuple[Callable[[CGAExtension, OrderedMultiDict[CGAExtension, CGAExtension]], CGAExtension], Callable[[CGAExtension, CGAExtension | None, Any], CGAExtension]]]

DefaultDict[Enum_CGAExtension, str | tuple[ExtensionParser, ExtensionConstructor]]: CGA extension type to method mapping. Method names are expected to be referred to the class by _read_extension_${name} and/or _make_ext_${name}, and if such name not found, the value should then be a method that can parse the CGA extension by itself.

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

Post initialisation hook.

Overloads:

• self, file (IO[bytes] | bytes), length (Optional[int]), extension (bool), kwargs (Any) → None

• self, 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 argument, please refer to self.make.

classmethod __index__()

Numeral registry index of the protocol.

Return type:

TransType

Returns:

Numeral registry index of the protocol in IANA.

Auxiliary Data

class pcapkit.protocols.internet.mh.NTPTimestamp(seconds, fraction)

Bases: NTPTimestamp

NTP timestamp format, c.f., RFC 1305.

seconds: int

Seconds since 1 January 1900.

fraction: int

Fraction of a second.

Header Schemas

class pcapkit.protocols.schema.internet.mh.MH(dict_=None, **kwargs)

Bases: Schema

Header schema for MH packets.

next: TransType = <EnumField next>

Next header.

length: int = <UInt8Field length>

Header length.

type: Packet = <EnumField type>

MH type.

reserved: bytes = <PaddingField reserved>

Reserved.

chksum: bytes = <BytesField chksum>

Checksum.

data: Packet = <SwitchField data>

Message data.

payload: bytes = <PayloadField payload>

Payload.

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

Bases: EnumSchema[Option]

Header schema for MH options.

type: Option = <EnumField type>

Option type.

length: int = <ConditionalField length>

Option length (excl. type and length fields), conditional in case of Pad1 option.

post_process(packet)

Revise schema data after unpacking process.

Parameters:

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

Return type:

Option

Returns:

Revised schema.

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

Bases: Option

Header schema for unassigned MH options.

data: bytes = <BytesField data>

Option data.

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

Bases: Option

Header schema for MH padding options.

data: bytes = <PaddingField data>

Option data.

class pcapkit.protocols.schema.internet.mh.BindingRefreshAdviceOption(dict_=None, **kwargs)

Bases: Option

Header schema for MH binding refresh advice options.

interval: int = <UInt16Field interval>

Refresh interval.

class pcapkit.protocols.schema.internet.mh.AlternateCareofAddressOption(dict_=None, **kwargs)

Bases: Option

Header schema for MH alternate care-of address options.

address: IPv6Address = <IPv6AddressField address>

Alternate care-of address.

class pcapkit.protocols.schema.internet.mh.NonceIndicesOption(dict_=None, **kwargs)

Bases: Option

Header schema for MH nonce indices options.

home: int = <UInt16Field home>

Home nonce index.

careof: int = <UInt16Field careof>

Care-of nonce index.

class pcapkit.protocols.schema.internet.mh.AuthorizationDataOption(dict_=None, **kwargs)

Bases: Option

Header schema for MH binding authorization data options.

data: bytes = <BytesField data>

Authenticator.

class pcapkit.protocols.schema.internet.mh.MobileNetworkPrefixOption(dict_=None, **kwargs)

Bases: Option

Header schema for MH mobile network prefix options.

reserved: bytes = <PaddingField reserved>

Reserved.

prefix_length: int = <UInt8Field prefix_length>

Prefix length.

prefix: IPv6Address = <IPv6AddressField prefix>

Mobile network prefix.

class pcapkit.protocols.schema.internet.mh.LinkLayerAddressOption(dict_=None, **kwargs)

Bases: Option

Header schema for MH link-layer address (MH-LLA) options.

code: LLACode = <EnumField code>

Option code.

lla: bytes = <BytesField lla>

Link-layer address (LAA).

class pcapkit.protocols.schema.internet.mh.MNIDOption(dict_=None, **kwargs)

Bases: Option

Header schema for MH mobile node identifier (MNID) options.

subtype: MNIDSubtype = <EnumField subtype>

Subtype.

identifier: bytes | str | IPv6Address = <SwitchField identifier>

Identifier.

class pcapkit.protocols.schema.internet.mh.AuthOption(dict_=None, **kwargs)

Bases: Option

Header schema for Mobility Message Authentication options.

subtype: AuthSubtype = <EnumField subtype>

Subtype.

spi: int = <UInt32Field spi>

Mobility SPI.

data: bytes = <BytesField data>

Authentication data.

class pcapkit.protocols.schema.internet.mh.MesgIDOption(dict_=None, **kwargs)

Bases: Option

Header schema for Mobility Message Replay Protection options.

seconds: int = <UInt32Field seconds>

Timestamp (seconds since January 1st, 1970, c.f., RFC 1305).

fraction: int = <UInt32Field fraction>

Timestamp fractions (1/2**32 seconds per unit, c.f., RFC 1305).

post_process(packet)

Revise schema data after unpacking process.

Parameters:

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

Return type:

MesgIDOption

Returns:

Revised schema.

timestamp: datetime

Timestamp interval (since UNIX-epoch).

class pcapkit.protocols.schema.internet.mh.CGAParametersRequestOption(dict_=None, **kwargs)

Bases: Option

Header schema for CGA Parameters Request options.

class pcapkit.protocols.schema.internet.mh.CGAExtension(dict_=None, **kwargs)

Bases: EnumSchema[CGAExtension]

Header schema for CGA extensions.

type: CGAExtension = <EnumField type>

Extension type.

length: int = <UInt16Field length>

Extension data length.

class pcapkit.protocols.schema.internet.mh.CGAParameter(dict_=None, **kwargs)

Bases: Schema

Header schema for CGA Parameters.

modifier: CGAType = <EnumField modifier>

Modifier.

prefix: int = <UInt64Field prefix>

Subnet prefix.

collision_count: int = <UInt8Field collision_count>

Collision count.

public_key_test: ANSIKeyLengthTest = <ForwardMatchField public_key_test>

Public key length test.

public_key: bytes = <BytesField public_key>

Public key (ASN.1 encoded).

extensions: list[CGAExtension] = <OptionField extensions>

Extension fields.

class pcapkit.protocols.schema.internet.mh.CGAParametersOption(dict_=None, **kwargs)

Bases: Option

Header schema for CGA Parameters options.

parameters: list[CGAParameter] = <ListField parameters>

CGA parameters, c.f., RFC 3972.

class pcapkit.protocols.schema.internet.mh.UnknownExtension(dict_=None, **kwargs)

Bases: CGAExtension

Header schema for unknown CGA extensions.

data: bytes = <BytesField data>

Extension data.

class pcapkit.protocols.schema.internet.mh.MultiPrefixExtension(dict_=None, **kwargs)

Bases: CGAExtension

Header schema for Multi-Prefix CGA extensions.

flags: MultiPrefixExtensionFlags = <BitField flags>

Flags.

prefixes: list[int] = <ListField prefixes>

Prefixes.

class pcapkit.protocols.schema.internet.mh.Packet(dict_=None, **kwargs)

Bases: EnumSchema[Packet]

Header schema for MH packet data.

class pcapkit.protocols.schema.internet.mh.SignatureOption(dict_=None, **kwargs)

Bases: Option

Header schema for MH Signature options.

signature: bytes = <BytesField signature>

Signature.

class pcapkit.protocols.schema.internet.mh.PermanentHomeKeygenTokenOption(dict_=None, **kwargs)

Bases: Option

Header schema for Permanent Home Keygen Token options.

token: bytes = <BytesField token>

Permanent home keygen token.

class pcapkit.protocols.schema.internet.mh.CareofTestInitOption(dict_=None, **kwargs)

Bases: Option

Header schema for MH Care-of Test Init options.

class pcapkit.protocols.schema.internet.mh.CareofTestOption(dict_=None, **kwargs)

Bases: Option

Header schema for MH Care-of Test options.

token: bytes = <BytesField token>

Care-of keygen token.

class pcapkit.protocols.schema.internet.mh.UnknownMessage(dict_=None, **kwargs)

Bases: Packet

Header schema for MH unknown message type.

data: bytes = <BytesField data>

Message data.

class pcapkit.protocols.schema.internet.mh.BindingRefreshRequestMessage(dict_=None, **kwargs)

Bases: Packet

Header schema for MH Binding Refresh Request (BRR) message.

reserved: bytes = <PaddingField reserved>

Reserved.

options: list[Option] = <OptionField options>

Mobility options.

class pcapkit.protocols.schema.internet.mh.HomeTestInitMessage(dict_=None, **kwargs)

Bases: Packet

Header schema for MH Home Test Init (HoTI) message.

reserved: bytes = <PaddingField reserved>

Reserved.

cookie: bytes = <BytesField cookie>

Home init cookie.

options: list[Option] = <OptionField options>

Mobility options.

class pcapkit.protocols.schema.internet.mh.CareofTestInitMessage(dict_=None, **kwargs)

Bases: Packet

Header schema for MH Care-of Test Init (CoTI) messages.

reserved: bytes = <PaddingField reserved>

Reserved.

cookie: bytes = <BytesField cookie>

Care-of init cookie.

options: list[Option] = <OptionField options>

Mobility options.

class pcapkit.protocols.schema.internet.mh.HomeTestMessage(dict_=None, **kwargs)

Bases: Packet

Header schema for MH Home Test (HoT) message.

nonce_index: int = <UInt16Field nonce_index>

Home nonce index.

cookie: bytes = <BytesField cookie>

Home init cookie.

token: bytes = <BytesField token>

Home keygen token.

options: list[Option] = <OptionField options>

Mobility options.

class pcapkit.protocols.schema.internet.mh.CareofTestMessage(dict_=None, **kwargs)

Bases: Packet

Header schema for MH Care-of Test (CoT) message.

nonce_index: int = <UInt16Field nonce_index>

Care-of nonce index.

cookie: bytes = <BytesField cookie>

Care-of init cookie.

token: bytes = <BytesField token>

Care-of keygen token.

options: list[Option] = <OptionField options>

Mobility options.

class pcapkit.protocols.schema.internet.mh.BindingUpdateMessage(dict_=None, **kwargs)

Bases: Packet

Header schema for MH Binding Update (BU) messages.

seq: int = <UInt16Field seq>

Sequence number.

flags: BindingUpdateMessageFlags = <BitField flags>

Flags.

lifetime: int = <UInt16Field lifetime>

Lifetime. One time unit is 4 seconds.

options: list[Option] = <OptionField options>

Mobility options.

class pcapkit.protocols.schema.internet.mh.BindingAcknowledgementMessage(dict_=None, **kwargs)

Bases: Packet

Header schema for MH Binding Acknowledgement (BA) messages.

status: StatusCode = <EnumField status>

Status.

flags: BindingAcknowledgementMessageFlags = <BitField flags>

Flags.

seq: int = <UInt16Field seq>

Sequence number.

lifetime: int = <UInt16Field lifetime>

Lifetime. One time unit is 4 seconds.

options: list[Option] = <OptionField options>

Mobility options.

class pcapkit.protocols.schema.internet.mh.BindingErrorMessage(dict_=None, **kwargs)

Bases: Packet

Header schema for MH Binding Error (BE) messages.

status: BindingError = <EnumField status>

Status.

reserved: bytes = <PaddingField reserved>

Reserved.

home: IPv6Address = <IPv6AddressField home>

Home address.

options: list[Option] = <OptionField options>

Mobility options.

Type Stubs

class pcapkit.protocols.schema.internet.mh.ANSIKeyLengthTest

Bases: TypedDict

Length test for ANSI.1 encoded data, c.f., CGAParameter.public_key_test.

len: int

class pcapkit.protocols.schema.internet.mh.MultiPrefixExtensionFlags

Bases: TypedDict

Flags for MultiPrefixExtension.flags.

P: int

class pcapkit.protocols.schema.internet.mh.BindingUpdateMessageFlags

Bases: TypedDict

Flags for BindingUpdateMessage.flags.

A: int

H: int

L: int

K: int

class pcapkit.protocols.schema.internet.mh.BindingAcknowledgementMessageFlags

Bases: TypedDict

Flags for BindingAcknowledgementMessage.flags.

K: int

Auxiliary Functions

pcapkit.protocols.schema.internet.mh.mh_data_selector(pkt)

Selector function for MH.data field.

Parameters:

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

Return type:

FieldBase

Returns:

Returns a SchemaField wrapped Packet subclass instance.

pcapkit.protocols.schema.internet.mh.mn_id_selector(pkt)

Selector function for MNIDOption.identifier field.

Parameters:

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

Return type:

FieldBase

Returns:

Returns a Field instance corresponding to the subtype.

Data Models

class pcapkit.protocols.data.internet.mh.MH(dict_=None, **kwargs)

Bases: Protocol

Data model for MH protocol.

next: TransType

Next header.

length: int

Header length.

type: Packet

Mobility header type.

chksum: bytes

Checksum.

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

Bases: Data

Data model for MH options.

type: Enum_Option

Option type.

length: int

Option length (incl. type and length fields).

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

Bases: Option

Data model for unassigned MH options.

data: bytes

Option data.

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

Bases: Option

Data model for Pad option.

class pcapkit.protocols.data.internet.mh.BindingRefreshAdviceOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for Binding Refresh Advice option.

interval: int

Refresh interval.

class pcapkit.protocols.data.internet.mh.AlternateCareofAddressOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for Alternate Care-of Address option.

address: IPv6Address

Alternate care-of address.

class pcapkit.protocols.data.internet.mh.NonceIndicesOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for Nonce Indices option.

home: int

Home nonce index.

careof: int

Care-of nonce index.

class pcapkit.protocols.data.internet.mh.AuthorizationDataOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for Binding Authorization Data option.

data: bytes

Authenticator.

class pcapkit.protocols.data.internet.mh.MobileNetworkPrefixOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for Mobile Network Prefix option.

prefix: IPv6Network

Mobile Network Prefix.

class pcapkit.protocols.data.internet.mh.LinkLayerAddressOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for MH Link-Layer Address (MH-LLA) option.

code: Enum_LLACode

Option code.

lla: bytes

Link-layer address (LLA).

class pcapkit.protocols.data.internet.mh.MNIDOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for MN-ID option.

subtype: Enum_MNIDSubtype

Subtype.

identifier: bytes | str | IPv6Address

Identifier.

class pcapkit.protocols.data.internet.mh.AuthOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for Mobility Message Authentication option.

subtype: Enum_AuthSubtype

Subtype.

spi: int

Mobility SPI.

data: bytes

Authentication data.

class pcapkit.protocols.data.internet.mh.MesgIDOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for Mobility Message Replay Protection option.

timestamp: dt_type

Timestamp.

ntp_timestamp: NTPTimestamp

NTP timestamp, c.f., RFC 1305.

class pcapkit.protocols.data.internet.mh.CGAParametersRequestOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for CGA Parameters Request option.

class pcapkit.protocols.data.internet.mh.CGAExtension(dict_=None, **kwargs)

Bases: Data

Data model for CGA extension.

type: Enum_CGAExtension

Extension type.

length: int

Extension length.

class pcapkit.protocols.data.internet.mh.CGAParameter(*args: VT, **kwargs: VT)

Bases: Data

Data model for CGA parameter.

modifier: Enum_CGAType

Modifier.

prefix: int

Subnet prefix.

collision_count: int

Collision count.

public_key: bytes

Publick key (ASN.1 encoded).

extensions: OrderedMultiDict[Enum_CGAExtension, CGAExtension]

Extension fields.

class pcapkit.protocols.data.internet.mh.CGAParametersOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for CGA Parameters option.

parameters: tuple[CGAParameter, ...]

CGA parameters, c.f., RFC 3972.

class pcapkit.protocols.data.internet.mh.UnknownExtension(*args: VT, **kwargs: VT)

Bases: CGAExtension

Data model for unknown CGA extensions.

data: bytes

Extension data.

class pcapkit.protocols.data.internet.mh.MultiPrefixExtension(*args: VT, **kwargs: VT)

Bases: CGAExtension

Data model for Multi-Prefix CGA extension.

flag: bool

P flag. Set if a public key is included in the Public Key field of the CGA Parameter Data Structure, reset otherwise.

prefixes: tuple[int, ...]

Prefixes.

class pcapkit.protocols.data.internet.mh.SignatureOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for MH Signature option.

signature: bytes

Signature.

class pcapkit.protocols.data.internet.mh.PermanentHomeKeygenTokenOption(*args: VT, **kwargs: VT)

Bases: Option

Data model for Permanent Home Keygen Token option.

token: bytes

Permanent home keygen token.

class pcapkit.protocols.data.internet.mh.CareofTestInitOption(*args: VT, **kwargs: VT)

Bases: Option

Header schema for MH Care-of Test Init options.

class pcapkit.protocols.data.internet.mh.CareofTestOption(*args: VT, **kwargs: VT)

Bases: Option

Header schema for MH Care-of Test options.

token: bytes

Care-of keygen token.

class pcapkit.protocols.data.internet.mh.UnknownMessage(*args: VT, **kwargs: VT)

Bases: MH

Data model for MH unknown message type.

data: bytes

Message data.

class pcapkit.protocols.data.internet.mh.BindingRefreshRequestMessage(*args: VT, **kwargs: VT)

Bases: MH

Data model for MH Binding Refresh Request (BRR) message type.

options: OrderedMultiDict[Enum_Option, Option]

Mobility options.

class pcapkit.protocols.data.internet.mh.HomeTestInitMessage(*args: VT, **kwargs: VT)

Bases: MH

Data modelf for MH Home Test Init (HoTI) message type.

cookie: bytes

Home init cookie.

options: OrderedMultiDict[Enum_Option, Option]

Mobility options.

class pcapkit.protocols.data.internet.mh.CareofTestInitMessage(*args: VT, **kwargs: VT)

Bases: MH

Data model for MH Care-of Test Init (CoTI) message type.

cookie: bytes

Care-of init cookie.

options: OrderedMultiDict[Enum_Option, Option]

Mobility options.

class pcapkit.protocols.data.internet.mh.HomeTestMessage(*args: VT, **kwargs: VT)

Bases: MH

Data model for MH Home Test (HoT) message type.

nonce_index: int

Home nonce index.

cookie: bytes

Home init cookie.

token: bytes

Home keygen token.

options: OrderedMultiDict[Enum_Option, Option]

Mobility options.

class pcapkit.protocols.data.internet.mh.CareofTestMessage(*args: VT, **kwargs: VT)

Bases: MH

Data model for MH Care-of Test (CoT) message type.

nonce_index: int

Care-of nonce index.

cookie: bytes

Care-of init cookie.

token: bytes

Care-of keygen token.

options: OrderedMultiDict[Enum_Option, Option]

Mobility options.

class pcapkit.protocols.data.internet.mh.BindingUpdateMessage(*args: VT, **kwargs: VT)

Bases: MH

Data model for MH Binding Update message type.

seq: int

Sequence number.

ack: bool

Acknowledge flag.

home: bool

home registration flag.

lla_compat: bool

Link-local address compability flag.

key_mngt: bool

Key management mobility capability flag.

lifetime: timedelta

Lifetime.

options: OrderedMultiDict[Enum_Option, Option]

Mobility options.

class pcapkit.protocols.data.internet.mh.BindingAcknowledgementMessage(*args: VT, **kwargs: VT)

Bases: MH

Data model for MH Binding Acknowledge (BA) message type.

status: Enum_StatusCode

Status.

key_mngt: bool

Key management mobility capability flag.

seq: int

Sequence number.

lifetime: timedelta

Lifetime.

options: OrderedMultiDict[Enum_Option, Option]

Mobility options.

class pcapkit.protocols.data.internet.mh.BindingErrorMessage(*args: VT, **kwargs: VT)

Bases: MH

Data model for MH Binding Error (BE) message type.

status: Enum_BindingError

Status.

home: IPv6Address

Home address.

options: OrderedMultiDict[Enum_Option, Option]

Mobility options.

Footnotes

[*]

https://en.wikipedia.org/wiki/Mobile_IP#Changes_in_IPv6_for_Mobile_IPv6