# Actions

Tom
Eastep
2005
2007
2008
2009
2010
Thomas M. Eastep

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover, and with no Back-Cover Texts. A copy of the license is included in the section entitled GNU Free Documentation License.

This article applies to Shorewall 4.3 and later. If you are running a version of Shorewall earlier than Shorewall 4.3.5 then please see the documentation for that release.

## What are Shorewall Actions?

Shorewall actions allow a symbolic name to be associated with a series of one or more iptables rules. The symbolic name may appear in the ACTION column of an `/etc/shorewall/rules` file entry, in which case the traffic matching that rules file entry will be passed to the series of iptables rules named by the action.

Actions can be thought of as templates. When an action is invoked in an `/etc/shorewall/rules` entry, it may be qualified by a logging specification (log level and optionally a log tag). The presence of the log level/tag causes a modified series of rules to be generated in which each packet/rule match within the action causes a log message to be generated.

For readers familiar with iptables, actions are the way in which you can create your own filter-table chains.

There are three types of Shorewall actions:

1. Built-in Actions. These actions are known by the Shorewall code itself. They are listed in the comments at the top of the file `/usr/share/shorewall/actions.std`.

2. Standard Actions. These actions are released as part of Shorewall. They are listed in the file `/usr/share/shorewall/actions.std` and are defined in the corresponding action.* files in `/usr/share/shorewall`. Each `action.*` file has a comment at the beginning of the file that describes what the action does. As an example, here is the definition of the AllowSMB standard action from Shorewall version 2.2.

       #
       # Shorewall 2.2 /usr/share/shorewall/action.AllowSMB
       #
       #       Allow Microsoft SMB traffic. You need to invoke this action in
       #       both directions.
       #
       ######################################################################################
       #TARGET  SOURCE         DEST            PROTO   DEST    SOURCE          RATE    USER/
       #                                               PORT    PORT(S)         LIMIT   GROUP
       ACCEPT   -              -               udp     135,445
       ACCEPT   -              -               udp     137:139
       ACCEPT   -              -               udp     1024:   137
       ACCEPT   -              -               tcp     135,139,445
       #LAST LINE -- ADD YOUR ENTRIES BEFORE THIS ONE -- DO NOT REMOVE

   If you wish to modify one of the standard actions, do not modify the definition in `/usr/share/shorewall`. Rather, copy the file to `/etc/shorewall` (or somewhere else on your CONFIG_PATH) and modify the copy.

   Standard Actions have been largely replaced by macros .

3. User-defined Actions. These actions are created by end-users. They are listed in the file `/etc/shorewall/actions` and are defined in `action.*` files in `/etc/shorewall` or in another directory listed in your CONFIG_PATH (defined in `/etc/shorewall/shorewall.conf`).

## Default Actions (Formerly Common Actions)

Shorewall allows the association of a default action with policies. A separate default action may be associated with ACCEPT, DROP, REJECT, QUEUE and NFQUEUE policies. Default actions provide a way to invoke a set of common rules just before the policy is enforced. Default actions accomplish two goals:

1. Relieve log congestion. Default actions typically include rules to silently drop or reject traffic that would otherwise be logged when the policy is enforced.

2. Ensure correct operation. Default actions can also avoid common pitfalls like dropping connection requests on port TCP port 113. If these connections are dropped (rather than rejected) then you may encounter problems connecting to Internet services that utilize the AUTH protocol of client authentication AUTH is actually pretty silly on today's Internet but it's amazing how many servers still employ it. .

Shorewall supports default actions for the ACCEPT, REJECT, DROP, QUEUE and NFQUEUE policies. These default actions are specified in the `/etc/shorewall/shorewall.conf` file using the ACCEPT_DEFAULT, REJECT_DEFAULT, DROP_DEFAULT, QUEUE_DEFAULT and NFQUEUE_DEFAULT options respectively. Policies whose default is set to a value of none have no default action.

In addition, the default specified in `/etc/shorewall/shorewall.conf` may be overridden by specifying a different action in the POLICY column of `/etc/shorewall/policy`.

Entries in the DROP and REJECT default actions ARE NOT THE CAUSE OF CONNECTION PROBLEMS. Remember — default actions are only invoked immediately before the packet is going to be dropped or rejected anyway!!!

## Defining your own Actions

Before defining a new action, you should evaluate whether your goal can be best accomplished using an action or a macro. See this article for details.

To define a new action:

1. Add a line to `/etc/shorewall/actions` that names your new action. Action names must be valid shell variable names (must begin with a letter and be composed of letters, digits and underscore characters) as well as valid Netfilter chain names. If you intend to log from the action, the name must have a maximum of 11 characters. It is recommended that the name you select for a new action begins with a capital letter; that way, the name won't conflict with a Shorewall-defined chain name.

   Shorewall includes pre-defined actions for DROP and REJECT -- see above.

2. Once you have defined your new action name (ActionName), then copy `/usr/share/shorewall/action.template` to `/etc/shorewall/action.ActionName` (for example, if your new action name is Foo then copy `/usr/share/shorewall/action.template` to `/etc/shorewall/action.Foo`).

3. Now modify the new file to define the new action.

Columns in the `action.template` file are as follows:

- TARGET - Must be ACCEPT, DROP, REJECT, LOG, CONTINUE, QUEUE or an <action> where <action> is a previously-defined action (that is, it must precede the action being defined in this file in your `/etc/shorewall/actions` file). These actions have the same meaning as they do in the `/etc/shorewall/rules` file (CONTINUE terminates processing of the current action and returns to the point where that action was invoked). The TARGET may optionally be followed by a colon (:) and a syslog log level (e.g, REJECT:info or ACCEPT:debugging). This causes the packet to be logged at the specified level. You may also specify ULOG (must be in upper case) as a log level. This will log to the ULOG target for routing to a separate log through use of ulogd (http://www.netfilter.org/projects/ulogd/index.html).

  You may also use a macro in your action provided that the macro's expansion only results in the ACTIONs ACCEPT, DROP, REJECT, LOG, CONTINUE, or QUEUE. See `/usr/share/shorewall/action.Drop` for an example of an action that users macros extensively.

- SOURCE - Source hosts to which the rule applies. A comma-separated list of subnets and/or hosts. Hosts may be specified by IP or MAC address; MAC addresses must begin with ~ and must use - as a separator.

  Alternatively, clients may be specified by interface name. For example, eth1 specifies a client that communicates with the firewall system through eth1. This may be optionally followed by another colon (:) and an IP/MAC/subnet address as described above (e.g., eth1:192.168.1.5).

- DEST - Location of Server. Same as above with the exception that MAC addresses are not allowed.

- PROTO - Protocol - Must be tcp, udp, icmp, a protocol number, or all.

- DEST PORT(S) - Destination Ports. A comma-separated list of Port names (from `/etc/services`), port numbers or port ranges; if the protocol is icmp, this column is interpreted as the destination icmp-type(s).

  A port range is expressed as <low port>:<high port>.

  This column is ignored if PROTO = all, but must be entered if any of the following fields are supplied. In that case, it is suggested that this field contain -.

- SOURCE PORT(S) - Port(s) used by the client. If omitted, any source port is acceptable. Specified as a comma-separated list of port names, port numbers or port ranges.

  If you don't want to restrict client ports but need to specify any of the subsequent fields, then place - in this column.

- RATE LIMIT - You may rate-limit the rule by placing a value in this column:

           <rate>/<interval>[:<burst>]

  where <rate> is the number of connections per <interval> (sec or min) and <burst> is the largest burst permitted. If no <burst> is given, a value of 5 is assumed. There may be no whitespace embedded in the specification.

           Example: 10/sec:20

- USER/GROUP - For output rules (those with the firewall as their source), you may control connections based on the effective UID and/or GID of the process requesting the connection. This column can contain any of the following:

  - [!]<user number>[:]
  - [!]<user name>[:]
  - [!]:<group number>
  - [!]:<group name>
  - [!]<user number>:<group number>
  - [!]<user name>:<group number>
  - [!]<user inumber>:<group name>
  - [!]<user name>:<group name>
  - [!]+<program name> (Note: support for this form was removed from Netfilter in kernel version 2.6.14).

- MARK

  - [!]<value>[/<mask>][:C]

  Defines a test on the existing packet or connection mark. The rule will match only if the test returns true.

  If you don’t want to define a test but need to specify anything in the subsequent columns, place a - in this field.

  - ! — Inverts the test (not equal)
  - <value> — Value of the packet or connection mark.
  - <mask> —A mask to be applied to the mark before testing.
  - :C — Designates a connection mark. If omitted, the packet mark’s value is tested. This option is only supported by Shorewall-perl

Omitted column entries should be entered using a dash (-).

Example:

`/etc/shorewall/actions`:

         #ACTION             COMMENT (place '# ' below the 'C' in comment followed by
         #                   v        a comment describing the action)
         LogAndAccept        # LOG and ACCEPT a connection

Note: If your `/etc/shorewall/actions` file doesn't have an indication where to place the comment, put the # in column 21.

`/etc/shorewall/action.LogAndAccept`

         LOG:info
         ACCEPT

Placing a comment on the line causes the comment to appear in the output of the `shorewall show actions` command.

To use your action, in `/etc/shorewall/rules` you might do something like:

    #ACTION      SOURCE      DEST        PROTO    DEST PORT(S)
    LogAndAccept loc         $FW         tcp      22

## Actions and Logging

Specifying a log level in a rule that specifies a user-defined or Shorewall-defined action will cause each rule in the action to be logged with the specified level (and tag).

The extent to which logging of action rules occur is governed by the following:

1. When you invoke an action and specify a log level, only those rules in the action that have no log level will be changed to log at the level specified at the action invocation.

   Example:

   /etc/shorewall/action.foo

       #TARGET      SOURCE     DEST     PROTO    DEST PORT(S)
       ACCEPT       -          -        tcp      22
       bar:info

   /etc/shorewall/rules:

       #ACTION      SOURCE     DEST     PROTO    DEST PORT(S)
       foo:debug    $FW         net

   Logging in the invoke foo action will be as if foo had been defined as:

       #TARGET      SOURCE     DEST     PROTO    DEST PORT(S)
       ACCEPT:debug -          -        tcp      22
       bar:info

2. If you follow the log level with ! then logging will be set at that level for all rules recursively invoked by the action.

   Example:

   /etc/shorewall/action.foo

       #TARGET      SOURCE     DEST     PROTO    DEST PORT(S)
       ACCEPT       -          -        tcp      22
       bar:info

   /etc/shorewall/rules:

       #ACTION      SOURCE     DEST     PROTO    DEST PORT(S)
       foo:debug!   $FW        net

   Logging in the invoke foo action will be as if foo had been defined as:

       #TARGET      SOURCE     DEST     PROTO    DEST PORT(S)
       ACCEPT:debug -          -        tcp      22
       bar:debug

## Creating an Action using an Extension Script

There may be cases where you wish to create a chain with rules that can't be constructed using the tools defined in the `action.template`. In that case, you can use an extension script.

If you actually need an action to drop broadcast packets, use the `dropBcast` standard action rather than create one like this.

### An action to drop all broadcast packets

If you define an action acton and you have an `/etc/shorewall/acton` script, the rules compiler sets lexical variables as follows:

- $chainref is a reference to the chain-table entry for the chain where your rules are to be placed.

- $level is the log level. If false, no logging was specified.

- $tag is the log tag.

Example:

/etc/shorewall/actions

    DropBcasts

/etc/shorewall/action.DropBcasts

    # This file is empty

/etc/shorewall/DropBcasts

    use Shorewall::Chains;

    if ( $level ne '' ) {
        log_rule_limit $level, $chainref, 'dropBcast' , 'DROP', '', $tag, 'add', ' -m addrtype --dst-type BROADCAST ';
        log_rule_limit $level, $chainref, 'dropBcast' , 'DROP', '', $tag, 'add', ' -d 224.0.0.0/4 ';
    }

    add_rule $chainref, '-m addrtype --dst-type BROADCAST -j DROP';
    add_rule $chainref, '-d 224.0.0.0/4 -j DROP';

    1;

For a richer example, see the next section.

## Limiting Per-IP Connection Rate using the Limit Action

Shorewall supports a Limit built-in action. Limit is invoked with a comma-separated list in place of a logging tag. The list has three elements:

1. The name of a recent list. You select the list name which must conform to the rules for a valid chain name. Different rules that specify the same list name will use the same set of counters.

2. The number of connections permitted in a specified time period.

3. The time period, expressed in seconds.

Connections that exceed the specified rate are dropped.

For example, to use a recent list name of SSHA, and to limit SSH connections to 3 per minute, use this entry in `/etc/shorewall/rules`:

    #ACTION                SOURCE            DEST           PROTO       DEST PORT(S)
    Limit:none:SSHA,3,60   net               $FW            tcp         22

If you want dropped connections to be logged at the info level, use this rule instead:

    #ACTION                SOURCE            DEST           PROTO       DEST PORT(S)
    Limit:info:SSHA,3,60   net               $FW            tcp         22

To summarize, you pass four pieces of information to the Limit action:

- The log level. If you don't want to log, specify none.

- The name of the recent list that you want to use (SSHA in this example).

- The maximum number of connections to accept (3 in this example).

- The number of seconds over which you are willing to accept that many connections (60 in this example).

### How Limit is Implemented

For those who are curious, the Limit action is implemented as follows:

    use Shorewall::Chains;

    my @tag = split /,/, $tag;

    fatal_error 'Limit rules must include <list name>,<max connections>,<interval> as the log tag (' . join( ':', 'Limit', $level eq '' ? 'none' : $level , $tag ) . ')'
        unless @tag == 3;

    my $list = $tag[0];

    for ( @tag[1,2] ) {
        fatal_error 'Max connections and interval in Limit rules must be numeric (' . join( ':', 'Limit', $level eq '' ? 'none' : $level, $tag ) . ')' unless /^\d+$/
    }

    my $count = $tag[1] + 1;

    add_rule $chainref, "-m recent --name $list --set";

    if ( $level ) {
        my $xchainref = new_chain 'filter' , "$chainref->{name}%";
        log_rule_limit $level, $xchainref, $tag[0], 'DROP', '', '', 'add', '';
        add_rule $xchainref, '-j DROP';
        add_rule $chainref,  "-m recent --name $list --update --seconds $tag[2] --hitcount $count -j $xchainref->{name}";
    } else {
        add_rule $chainref, "-m recent --update --name $list --seconds $tag[2] --hitcount $count -j DROP";
    }

    add_rule $chainref, '-j ACCEPT';

    1;