Skip to content

/AWS1/CL_NWFSTATEFULRULE

A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_action TYPE /AWS1/NWFSTATEFULACTION /AWS1/NWFSTATEFULACTION

Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.

The actions for a stateful rule are defined as follows:

  • PASS - Permits the packets to go to the intended destination.

  • DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

  • ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

    You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.

  • REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.

io_header TYPE REF TO /AWS1/CL_NWFHEADER /AWS1/CL_NWFHEADER

The stateful inspection criteria for this rule, used to inspect traffic flows.

it_ruleoptions TYPE /AWS1/CL_NWFRULEOPTION=>TT_RULEOPTIONS TT_RULEOPTIONS

Additional options for the rule. These are the Suricata RuleOptions settings.

Queryable Attributes

Action

Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.

The actions for a stateful rule are defined as follows:

  • PASS - Permits the packets to go to the intended destination.

  • DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

  • ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

    You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.

  • REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.

Accessible with the following methods

Method Description
GET_ACTION() Getter for ACTION, with configurable default
ASK_ACTION() Getter for ACTION w/ exceptions if field has no value
HAS_ACTION() Determine if ACTION has a value

The stateful inspection criteria for this rule, used to inspect traffic flows.

Accessible with the following methods

Method Description
GET_HEADER() Getter for HEADER

RuleOptions

Additional options for the rule. These are the Suricata RuleOptions settings.

Accessible with the following methods

Method Description
GET_RULEOPTIONS() Getter for RULEOPTIONS, with configurable default
ASK_RULEOPTIONS() Getter for RULEOPTIONS w/ exceptions if field has no value
HAS_RULEOPTIONS() Determine if RULEOPTIONS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_STATEFULRULES

TYPES TT_STATEFULRULES TYPE STANDARD TABLE OF REF TO /AWS1/CL_NWFSTATEFULRULE WITH DEFAULT KEY
.