nopasaran.primitives.action_primitives.tcp_primitives.TCPPrimitives

class nopasaran.primitives.action_primitives.tcp_primitives.TCPPrimitives

Bases: object

Class containing TCP action primitives for the state machine.

__init__()

Methods

__init__()
create_TCP_packet(inputs, outputs, state_machine)	Create a TCP packet and store it in an output variable in the machine's state.
get_TCP_ack(inputs, outputs, state_machine)	Get the acknowledgment number from a TCP packet in the machine's state.
get_TCP_dport(inputs, outputs, state_machine)	Get the destination port from a TCP packet in the machine's state.
get_TCP_fields(inputs, outputs, state_machine)	Get all fields from the TCP layer of a packet.
get_TCP_flags(inputs, outputs, state_machine)	Get the TCP flags from a TCP packet in the machine's state.
get_TCP_seq(inputs, outputs, state_machine)	Get the sequence number from a TCP packet in the machine's state.
get_TCP_sport(inputs, outputs, state_machine)	Get the source port from a TCP packet in the machine's state.
remove_TCP_payload(inputs, outputs, ...)	Remove the payload from a TCP packet in the machine's state.
set_TCP_ack(inputs, outputs, state_machine)	Set the acknowledgment number of a TCP packet in the machine's state.
set_TCP_automatic_packet_ack(inputs, ...)	Set the acknowledgment number of a TCP packet in the machine's state to an automatically generated value.
set_TCP_automatic_packet_seq(inputs, ...)	Set the sequence number of a TCP packet in the machine's state to an automatically generated value.
set_TCP_dport(inputs, outputs, state_machine)	Set the destination port of a TCP packet in the machine's state.
set_TCP_flags(inputs, outputs, state_machine)	Set the TCP flags of a TCP packet in the machine's state.
set_TCP_payload(inputs, outputs, state_machine)	Set the payload of a TCP packet in the machine's state.
set_TCP_seq(inputs, outputs, state_machine)	Set the sequence number of a TCP packet in the machine's state.
set_TCP_sport(inputs, outputs, state_machine)	Set the source port of a TCP packet in the machine's state.

static create_TCP_packet(inputs, outputs, state_machine)

Create a TCP packet and store it in an output variable in the machine’s state.

Number of input arguments: 0

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable to store the created TCP packet.

state_machine: The state machine object.

Returns:

None

static get_TCP_ack(inputs, outputs, state_machine)

Get the acknowledgment number from a TCP packet in the machine’s state.

Number of input arguments: 1

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains one mandatory input argument, which is the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable to store the acknowledgment number.

state_machine: The state machine object.

Returns:

None

static get_TCP_dport(inputs, outputs, state_machine)

Get the destination port from a TCP packet in the machine’s state.

Number of input arguments: 1

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains one mandatory input argument, which is the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable to store the destination port.

state_machine: The state machine object.

Returns:

None

static get_TCP_fields(inputs, outputs, state_machine)

Get all fields from the TCP layer of a packet.

Number of input arguments: 1

Number of output arguments: 1

Args:

inputs (List[str]): The list of input variable names. It contains one mandatory input argument:

• The name of the variable containing the TCP packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument,

which is the name of the variable to store the dictionary of TCP fields.

state_machine: The state machine object.

Returns:

None

static get_TCP_flags(inputs, outputs, state_machine)

Get the TCP flags from a TCP packet in the machine’s state.

Number of input arguments: 1

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains one mandatory input argument, which is the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable to store the TCP flags.

state_machine: The state machine object.

Returns:

None

static get_TCP_seq(inputs, outputs, state_machine)

Get the sequence number from a TCP packet in the machine’s state.

Number of input arguments: 1

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains one mandatory input argument, which is the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable to store the sequence number.

state_machine: The state machine object.

Returns:

None

static get_TCP_sport(inputs, outputs, state_machine)

Get the source port from a TCP packet in the machine’s state.

Number of input arguments: 1

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains one mandatory input argument, which is the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable to store the source port.

state_machine: The state machine object.

Returns:

None

static remove_TCP_payload(inputs, outputs, state_machine)

Remove the payload from a TCP packet in the machine’s state.

Number of input arguments: 1

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains one mandatory input argument, which is the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable with the payload removed.

state_machine: The state machine object.

Returns:

None

static set_TCP_ack(inputs, outputs, state_machine)

Set the acknowledgment number of a TCP packet in the machine’s state.

Number of input arguments: 2

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains two mandatory input arguments, which are the new acknowledgment number value and the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable with the modified acknowledgment number.

state_machine: The state machine object.

Returns:

None

static set_TCP_automatic_packet_ack(inputs, outputs, state_machine)

Set the acknowledgment number of a TCP packet in the machine’s state to an automatically generated value.

Number of input arguments: 2

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains two mandatory input arguments, which are the new acknowledgment number value, the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable with the automatically generated acknowledgment number.

state_machine: The state machine object.

Returns:

None

static set_TCP_automatic_packet_seq(inputs, outputs, state_machine)

Set the sequence number of a TCP packet in the machine’s state to an automatically generated value.

Number of input arguments: 1

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains one mandatory input argument, which is the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable with the automatically generated sequence number.

state_machine: The state machine object.

Returns:

None

static set_TCP_dport(inputs, outputs, state_machine)

Set the destination port of a TCP packet in the machine’s state.

Number of input arguments: 2

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains two mandatory input arguments, which are the new destination port value and the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable with the modified packet.

state_machine: The state machine object.

Returns:

None

static set_TCP_flags(inputs, outputs, state_machine)

Set the TCP flags of a TCP packet in the machine’s state.

Number of input arguments: 2

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains two mandatory input arguments, which are the new TCP flags value and the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable with the modified TCP flags.

state_machine: The state machine object.

Returns:

None

static set_TCP_payload(inputs, outputs, state_machine)

Set the payload of a TCP packet in the machine’s state.

Number of input arguments: 2

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains two mandatory input arguments, which are the new payload value and the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable with the modified payload.

state_machine: The state machine object.

Returns:

None

static set_TCP_seq(inputs, outputs, state_machine)

Set the sequence number of a TCP packet in the machine’s state.

Number of input arguments: 2

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains two mandatory input arguments, which are the new sequence number value and the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable with the modified packet.

state_machine: The state machine object.

Returns:

None

static set_TCP_sport(inputs, outputs, state_machine)

Set the source port of a TCP packet in the machine’s state.

Number of input arguments: 2

Number of output arguments: 1

Optional input arguments: No

Optional output arguments: No

Args:

inputs (List[str]): The list of input variable names. It contains two mandatory input arguments, which are the new source port value and the name of a variable representing the packet.

outputs (List[str]): The list of output variable names. It contains one mandatory output argument, which is the name of the variable with the modified packet.

state_machine: The state machine object.

Returns:

None