MessageICMPv6

Summary

Represents an ICMPv6 message object.

See also

Message

IMessageBase

Methods: MessageICMPv6.capture()

MessageICMPv6.capture_list()

MessageICMPv6.close_writer()

MessageICMPv6.create_response()

MessageICMPv6.get_all_bytes()

MessageICMPv6.get_bytes()

MessageICMPv6.get_hex_bytes()

MessageICMPv6.hex_view()

MessageICMPv6.open_writer()

MessageICMPv6.ping()

MessageICMPv6.receive()

MessageICMPv6.receive_list()

MessageICMPv6.send()

MessageICMPv6.send_receive()

MessageICMPv6.send_receive_list()

MessageICMPv6.set_all_bytes()

MessageICMPv6.set_bytes()

MessageICMPv6.solicit()

MessageICMPv6.start_capture()

MessageICMPv6.start_responding_machine()

MessageICMPv6.stop_capture()

MessageICMPv6.stop_responding_machine()

MessageICMPv6.store()

MessageICMPv6.tree_view()
Properties: MessageICMPv6.capture_info

MessageICMPv6.checksum

MessageICMPv6.code

MessageICMPv6.data_base

MessageICMPv6.ethernet_header

MessageICMPv6.frame_number

MessageICMPv6.identifier

MessageICMPv6.ip_header

MessageICMPv6.ipv6_header

MessageICMPv6.payload

MessageICMPv6.sequence

MessageICMPv6.target_address

MessageICMPv6.timestamp

MessageICMPv6.type

MessageICMPv6.vlan_tag
Events: MessageICMPv6.on_capture_start()

MessageICMPv6.on_capture_stop()

MessageICMPv6.on_message_received()

Structure

class MessageICMPv6

capture(filter: Filter = None) → MessageICMPv6

Matches any message with the same protocol.

Parameters: filter (Filter) – Filter to use to narrow down packets to capture
Returns: Listens to the bus until a message is received and returns this first message
Return type: MessageICMPv6

capture(timeout: int32, filter: Filter = None) → MessageICMPv6

Waits for the first message having the same protocol that the sent message without verify the IP address and the port between send and respond message and return it. A timeout is specified to guarantee that the script can continue if no message is captured in a certain time interval.

Parameters

timeout (int32) – Max time in milliseconds to wait for the response.
filter (Filter) – Filter to use to narrow down packets to capture

Returns

First message captured from the bus or None in case no message is received.

Return type

MessageICMPv6

capture_list(timeout: int32, filter: Filter = None) → IReadOnlyList[MessageICMPv6]

Waits for any response having the same protocol that the sent message without verify the IP address and the port between send and respond message and return them all as a list. A timeout is specified to guarantee that the script can continue if no message is received in a certain time interval.

Parameters

timeout (int32) – Max time in milliseconds to wait for the response.
filter (Filter) – Filter to use to narrow down packets to capture

Returns

List of messages captured from the bus during a given period of time.

Return type

IReadOnlyList[MessageICMPv6]

close_writer(): Closes the file previously created with open_writer(file).

create_response() → MessageICMPv6

Creates neighbor advertisement message.

Returns: Neighbor advertisement message
Return type: MessageICMPv6

get_all_bytes() → Array[uint8]

Gets the content of the whole message from Ethernet layer.

Returns: Array of bytes representing the message from Ethernet layer.
Return type: Array[uint8]

get_bytes() → Array[uint8]

Gets the content of the payload.

Returns: Array of bytes representing the payload of the message.
Return type: Array[uint8]

get_hex_bytes() → str

Converts the payload of the message from decimal to hex and outputs it to a string of bytes.

Returns: Payload of message in hex bytes.
Return type: str

hex_view() → str

Allows to visualize messages in hexadecimal format.

Returns: Hexadecimal representation of the whole message.
Return type: str

hex_view(nb_bytes_per_line: int32) → str

Allows to visualize messages in hexadecimal format.

Parameters: nb_bytes_per_line (int32) – (optional) number of bytes per line.
Returns: Hexadecimal representation of the whole message.
Return type: str

open_writer(file: str, fileFormat: FILEFORMAT or None = None)

Creates a PCAP or PCAPNG file for writing the received messages. If the file already exists, it will be overwritten (old file data will be lost). Use the store() method to record received messages into the file.

Parameters

file (str) – Absolute path of the file where the messages will be stored
fileFormat (FILEFORMAT or None) – Obsolete, you don't need to specify this argument anymore

ping(ip_address: str) → IMessageBase

Creates an ICMP ping request message and waits for a response. for the response. Return value: ICMP ping request message received as response, if any.

Parameters: ip_address (str) – IP address of the target device.
Returns: ICMP message got as a response to the ping sent, if there is any.
Return type: IMessageBase

ping(ip_address: str, timeout: int32) → IMessageBase

Creates an ICMP ping request message and waits for a response. A timeout is specified to guarantee that the script can continue if no message is captured in a certain time interval.

Parameters

ip_address (str) – IP address of the target device.
timeout (int32) – (optional) Max time in milliseconds to wait for the response.

Returns

ICMP message got as a response to the ping sent, if there is any.

Return type

IMessageBase

receive() → MessageICMPv6

Matches a response for the used message.

Returns: Listens to the bus until a message is received and returns this first message
Return type: MessageICMPv6

receive(timeout: int32) → MessageICMPv6

Waits for the first response having the IP address destination equals to the IP address source of the sent message and return it. A timeout is specified to guarantee that the script can continue if no message is received in a certain time interval.

Parameters: timeout (int32) – Max time in milliseconds to wait for the response.
Returns: First message received from the bus or None in case no message is received.
Return type: MessageICMPv6

receive_list(timeout: int32) → IReadOnlyList[MessageICMPv6]

Waits for any response having the IP address destination equals to the IP address source of sent message and return them all as a list. A timeout is specified to guarantee that the script can continue if no message is received in a certain time interval.

Parameters: timeout (int32) – Max time in milliseconds to wait for the response.
Returns: List of messages received from the bus during a given period of time.
Return type: IReadOnlyList[MessageICMPv6]

send() → bool

Sends the message (the one used to call the method) through the Ethernet bus.

Returns: Returns True if the message is sent successfully. Otherwise, an exception will be thrown.
Return type: bool

send_receive(timeout: int32 = 1000) → MessageICMPv6

Sends the message (the one used to call the method) through the Ethernet bus and waits for a possible response, i.e. a message from the target address to our own address. It is possible to specify a timeout to guarantee that the script can continue if no response is detected in a certain time interval.

Parameters: timeout (int32) – (optional) Max time in milliseconds to wait for the response. Default 1 second
Returns: First message detected from the destination address to our address. This can be the response to the message sent but it is not 100% guaranteed; additional traffic can be captured before this expected response and thus returned.
Return type: MessageICMPv6

send_receive_list(timeout: int32) → IReadOnlyList[MessageICMPv6]

Sends the message through the Ethernet bus, listens for a while and returns a list with all the messages captured in that period. It is possible to specify a timeout to guarantee that the script can continue if no response is detected in a certain time interval.

Parameters: timeout (int32) – Max time in milliseconds to wait for the response.
Returns: List of messages detected from the destination address to our address. This can be the response to the message sent but it is not 100% guaranteed; additional traffic can be captured before this expected response and thus returned.
Return type: IReadOnlyList[MessageICMPv6]

set_all_bytes(all_packet: Array[uint8]) → bool

Sets the content of the whole message from Ethernet layer, byte per byte.

Parameters: all_packet (Array[uint8]) – All packet to set.
Returns: True if the operation was successful, False otherwise.
Return type: bool

set_bytes(payload: Array[uint8])

Sets the content of the payload, byte per byte.

Parameters: payload (Array[uint8]) – Array of bytes to set.

solicit(ip: str)

Makes current message a neighbor solicitation message

Parameters: ip (str) – ip address of the neighbor

start_capture(filter: Filter = None)

Used for online capture(capturing network traffic from an adapter). Used with callback function(on_message_received()) and stop_capture() method.

Parameters: filter (Filter) – Filter to use to narrow down packets to capture

start_capture(file: str, wait_eof: bool, filter: Filter = None)

Used for offline capture(reading packets from pcap or asc file). Used with callback function(on_message_received()) and stop_capture() method.

Parameters

file (str) – The trace file from where the messages will be read.
wait_eof (bool) – If True the function would block until all frames in the file are read. If False the function would read the frames in the background.
filter (Filter) – Filter to use to narrow down packets to capture

start_responding_machine(): With this function, it is possible to simulate an ECU. It captures packets and, for every received message, it calls is_request callback. If it returns True, then it calls the make_reply callback

stop_capture(): Stops capturing Ethernet messages, either directly from the bus or from a trace file (depending on the version used to start the capture).

stop_responding_machine(): Stops the responding machine activated with start_responding_machine.

store(file: str)

Writes the message into the trace file.

Parameters: file (str) – Path of the file where the messages will be stored.

store(): Writes the message into the trace file opened with open_writer(file).

tree_view() → str

Gives the tree view of the message.

Returns: Tree view representation of the message.
Return type: str

@on_capture_start: The event is triggered when the capture of Ethernet messages is started. See start_capture .

@on_capture_stop: The event is triggered when the capture of Ethernet messages is stopped. See stop_capture .

@on_message_received(message: MessageICMPv6)

Event is triggered every time a message is read from the Ethernet bus or a trace file. See start_capture.

Parameters: message (MessageICMPv6) – The message object being handled.

capture_info

General information about the context in which the message was captured from. None if the message was not captured

Type: CaptureInfo

checksum

The checksum value of the message.

Type: uint16 or None

code

Object containing the field code of the message.

Type: uint8

data_base

Takes the database object.

Type: Database

ethernet_header

Object containing all the information from the Ethernet header like the source and destination MAC addresses of the message.

Type: HeaderEthernet

frame_number

Number of the frame received, in the context of all the ethernet traffic captured.

Type: int64

identifier

Message identifier.

Type: uint16

ip_header

Object containing all the information from the IP header like the source and destination IP addresses of the message.

Type: HeaderIP

ipv6_header

Object containing all the information from the IPV6 header.

Type: HeaderIPv6

payload

Content, in bytes, of the payload of the message.

Type: Array[uint8]

sequence

Is the second 16bits of the Sequence Identifier field. This field is used to help match echo requests with the associated reply. It identifies the first byte of data that is stored in the data portion of the segment.