This is the documentation for Wazuh 3.2. Check out the docs for the latest version of Wazuh!

command

XML section name

<command>
</command>

In the command configuration section, a command is defined that will be used by one or more active responses. There is no limit on the number of commands that may be used by an active response, however, each one must be in its own separate <command> section.

Options

name

Specifies the name of the command which is called in the active-response section.

Default value n/a
Allowed values Any name
use Required

executable

Names an executable file to run from the /var/ossec/active-response/bin directory. It is not necessary to provide the path.

Default value n/a
Allowed values Any file name
use Required

expect

Specifies the lists of extracted fields that are to be passed as parameters to the command. If any of the listed fields were not extracted in a certain instance, those field values would be passed as a dash (-) instead of as no value at all.

A good example is the firewall-block command which expects the srcip field in order to knows which IP address to block. Multiple expected field names are comma separated.

Default value n/a
Allowed values Names of extracted fields, like srcip or username, separated by commas if there is more than one.
use Required

Note

If you do not want to specifiy fields, you can leave the option like this: <expect></expect>. This is the valid setting when no field information needs to be passed to the active-response command.

timeout_allowed

Specifies whether the command is stateful or stateless. If yes, the command is stateful, meaning it will undo its original action after the period of time specified in the active response.

Default value yes
Allowed values yes, no

Sample configuration

<!-- For Unix systems -->
<command>
  <name>host-deny</name>
  <executable>host-deny.sh</executable>
  <expect>srcip</expect>
  <timeout_allowed>yes</timeout_allowed>
</command>

<!-- For Windows systems -->
<command>
  <name>win_route-null</name>
  <executable>route-null.cmd</executable>
  <expect>srcip</expect>
  <timeout_allowed>yes</timeout_allowed>
</command>