MessageTFTP

Summary

Represents a TFTP (Trivial File Transfer Protocol) message object.

See also

Message

IMessageInternetApplication

Methods: MessageTFTP.capture()

MessageTFTP.capture_list()

MessageTFTP.close_writer()

MessageTFTP.do_ack()

MessageTFTP.do_error()

MessageTFTP.do_write_data()

MessageTFTP.do_write_request()

MessageTFTP.get_all_bytes()

MessageTFTP.get_bytes()

MessageTFTP.get_file_bytes()

MessageTFTP.get_hex_bytes()

MessageTFTP.hex_view()

MessageTFTP.is_segmented()

MessageTFTP.open_writer()

MessageTFTP.receive()

MessageTFTP.receive_list()

MessageTFTP.send()

MessageTFTP.set_all_bytes()

MessageTFTP.set_bytes()

MessageTFTP.start_capture()

MessageTFTP.start_responding_machine()

MessageTFTP.stop_capture()

MessageTFTP.stop_responding_machine()

MessageTFTP.store()

MessageTFTP.tree_view()

MessageTFTP.write_bytes_to_file()
Properties: MessageTFTP.block

MessageTFTP.capture_info

MessageTFTP.data_base

MessageTFTP.error_code

MessageTFTP.error_string

MessageTFTP.ethernet_header

MessageTFTP.file_data

MessageTFTP.file_name

MessageTFTP.frame_number

MessageTFTP.ip_header

MessageTFTP.ipv4_header

MessageTFTP.ipv6_header

MessageTFTP.mode

MessageTFTP.network_protocol

MessageTFTP.op_codes

MessageTFTP.payload

MessageTFTP.timestamp

MessageTFTP.transport_header

MessageTFTP.transport_protocol

MessageTFTP.udp_header

MessageTFTP.vlan_tag
Events: MessageTFTP.on_capture_start()

MessageTFTP.on_capture_stop()

MessageTFTP.on_message_received()

Structure

class MessageTFTP

capture(filter: Filter = None) → MessageTFTP

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: MessageTFTP

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

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

MessageTFTP

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

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[MessageTFTP]

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

do_ack(block: uint16)

Sends an acknowledgment packet to inform the other side that the last packet(s) has (have) been correctly received.

Parameters: block (uint16) – The packet's content.

do_error(error: str, errcode: ErrorCodes)

Sends an error packet to inform the other side that the last packet(s) has (have) been lost.

Parameters

error (str) – Error name.
errcode (ErrorCodes) – Error code.

do_write_data(files_bytes: object)

Writes the data included in the file specified as parameter.

Parameters: files_bytes (object) – Writes the data included in the file specified as parameter.

do_write_request(file_names: str, is_octet_mode: bool)

Sends a request to write a particular file to the other side .

Parameters

file_names (str) – The name of the file.
is_octet_mode (bool) – True if the operation was in octet mode, False otherwise.

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_file_bytes(path: str) → Array[uint8]

Gets the bytes included in the file specified as parameter.

Parameters: path (str) – Path of the file where the messages will be stored.
Returns: Bytes included in the file.
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

is_segmented() → bool

Checks if the message is segmented.

Returns: True if the message is segmented. False if not
Return type: bool

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

receive() → MessageTFTP

Matches a response for the used message.

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

receive(timeout: int32) → MessageTFTP

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: MessageTFTP

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

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[MessageTFTP]

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

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.

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

write_bytes_to_file(path: str, b: object) → bool

Writes the received bytes in the file specified as parameter.

Parameters

path (str) – Path of the file where the messages will be stored.
b (object) – Bytes to write.

Returns

True if the operation was successful, False otherwise.

Return type

bool

@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: MessageTFTP)

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

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

block

Block number of data.

Type: uint16

capture_info

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

Type: CaptureInfo

data_base

Takes the database object.

Type: Database

error_code

TFTP error code which can be of value not defined, File not found, Access violation, Disk full, Illegal TFTP operation, Unknown port, File already exists or No such user.

Type: ErrorCodes

error_string

Defines more description of the error.

Type: str

ethernet_header

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

Type: HeaderEthernet

file_data

Each data packet contains 512 bytes of data, except the final one that must contain less than a full-sized block of data to signal that it is the last. If the size of the transferred file is a exact multiple of the block-size, the source sends a final DATA packet containing 0 bytes of data.

Type: Array[uint8]

file_name

The file name.

Type: str

frame_number

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

Type: int64

ip_header

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

Type: HeaderIP

ipv4_header

Object containing all the information from the IPV4 header.

Type: HeaderIPv4

ipv6_header

Object containing all the information from the IPV6 header.

Type: HeaderIPv6

mode

The transfer modes are either NETASCII for transferring text files or OCTET for transferring binary files.

Type: Modes

network_protocol

Network Protocol of the message.

Type: NetworkProtocols

op_codes

The first 2 bytes of the TFTP message are an opcode. For a read request (RRQ) and write request (WRQ) the filename specifies the file on the server that the client wants to read from or write to. OPCODE takes one of the value, RRQ = Read Request, WRQ = Write Request, DATA = Data, ACK = Acknowledgement, Error = Error or OACK = Option Acknowledgement.