Linux Manual Pages

Free Software * Books

Source Code

Free Media

Linux

shorewall(8)

NAME

   shorewall - Administration tool for Shoreline Firewall (Shorewall)

SYNOPSIS

   shorewall [trace|debug [nolock]] [-options] add {
             interface[:host-list]... zone | zone host-list }

   shorewall [trace|debug [nolock]] [-options] allow address

   shorewall [trace|debug [nolock]] [-options] blacklist
             address [option ...]

   shorewall [trace|debug [nolock]] [-options] call
             function [parameter ...]

   shorewall [trace|debug] [-options] [check | ck ]  [-e] [-d] [-p] [-r]
             [-T] [-i] [directory]

   shorewall [trace|debug [nolock]] [-options] clear [-f]

   shorewall [trace|debug [nolock]] [-options]
             close { open-number | sourcedest [protocol [ port ]]}

   shorewall [trace|debug] [-options] [compile | co ]  [-e] [-c] [-d] [-p]
             [-T] [-i] [directory] [pathname]

   shorewall [trace|debug [nolock]] [-options] delete {
             interface[:host-list]... zone | zone host-list }

   shorewall [trace|debug [nolock]] [-options] disable
             { interface | provider }

   shorewall [trace|debug [nolock]] [-options] drop address

   shorewall [trace|debug] [-options] dump [-x] [-l] [-m] [-c]

   shorewall [trace|debug [nolock]] [-options] enable
             { interface | provider }

   shorewall [trace|debug [nolock]] [-options] export [directory1]
             [user@]system[:directory2]

   shorewall [trace|debug [nolock]] [-options] forget [filename]

   shorewall [trace|debug] [-options] help

   shorewall [trace|debug] [-options] hits [-t]

   shorewall [trace|debug] [-options] ipcalc {address mask | address/vlsm}

   shorewall [trace|debug] [-options] iprange address1-address2

   shorewall [trace|debug] [-options] iptrace iptables match expression

   shorewall [trace|debug [nolock]] [-options] logdrop address

   shorewall [trace|debug] [-options] logwatch [-m] [refresh-interval]

   shorewall [trace|debug [nolock]] [-options] logreject address

   shorewall [trace|debug] [-options] noiptrace iptables match expression

   shorewall [-options] open source dest [ protocol [ port ] ]

   shorewall [trace|debug [nolock]] [-options] reenable
             { interface | provider }

   shorewall [trace|debug [nolock]] [-options]
             refresh [-n] [-d] [-T] [-i] [-D directory ] [chain...]

   shorewall [trace|debug [nolock]] [-options] reject address

   shorewall [trace|debug] [-options] remote-start [-s] [-c]
             [-r root-user-name] [-T] [-i] [[-D]directory] [system]

   shorewall [trace|debug] [-options] remote-reload [-s] [-c]
             [-r root-user-name] [-T] [-i] [[-D]directory] [system]

   shorewall [trace|debug] [-options] remote-restart [-s] [-c]
             [-r root-user-name] [-T] [-i] [[-D]directory] [system]

   shorewall [trace|debug [nolock]] [-options] reset [chain ...]

   shorewall [trace|debug [nolock]] [-options] restart [-n] [-p [-d]] [-f]
             [-c] [-T] [-i] [-C] [directory]

   shorewall [trace|debug [nolock]] [-options] restore [-n] [-p] [-C]
             [filename]

   shorewall [trace|debug [nolock]] [-options] run command [parameter ...]

   shorewall [trace|debug [nolock]] [-options] safe-restart [-d] [-p]
             [-t timeout] [directory]

   shorewall [trace|debug] [-options] safe-start [-d] [-p] [-t timeout]
             [directory]

   shorewall [trace|debug [nolock]] [-options] save [-C]  [filename]

   shorewall [trace|debug [nolock]] [-options] savesets

   shorewall [trace|debug] [-options] {show | list | ls } [-x]
             {bl|blacklists}

   shorewall [trace|debug] [-options] {show | list | ls } [-b] [-x] [-l]
             [-t {filter|mangle|nat|raw|rawpost}] [chain...]

   shorewall [trace|debug] [-options] {show | list | ls } [-f]
             capabilities

   shorewall [trace|debug] [-options] {show | list | ls }
             {actions|classifiers|connections|config|events|filters|ip|ipa|macros|zones|policies|marks}

   shorewall [trace|debug] [-options] {show | list | ls } event event

   shorewall [trace|debug] [-options] {show | list | ls } [-c] routing

   shorewall [trace|debug] [-options] {show | list | ls } macro macro

   shorewall [trace|debug] [-options] {show | list | ls } [-x]
             {mangle|nat|raw|rawpost}

   shorewall [trace|debug] [-options] {show | list | ls } tc

   shorewall [trace|debug] [-options] {show | list | ls } [-m] log

   shorewall [trace|debug [nolock]] [-options] start [-n] [-f] [-p] [-c]
             [-T [-i]] [-C] [directory]

   shorewall [trace|debug [nolock]] [-options] stop [-f]

   shorewall [trace|debug] [-options] status [-i]

   shorewall [trace|debug [nolock]] [-options] try directory [timeout]

   shorewall [trace|debug] [-options] update [-b] [-d] [-r] [-T] [-a] [-i]
             [-A] [directory]

   shorewall [trace|debug] [-options] version [-a]

DESCRIPTION

   The shorewall utility is used to control the Shoreline Firewall
   (Shorewall).

OPTIONS

   The trace and debug options are used for debugging. See
   http://www.shorewall.net/starting_and_stopping_shorewall.htm#Trace[1].

   The nolock option prevents the command from attempting to acquire the
   Shorewall lockfile. It is useful if you need to include shorewall
   commands in /etc/shorewall/started.

   The options control the amount of output that the command produces.
   They consist of a sequence of the letters v and q. If the options are
   omitted, the amount of output is determined by the setting of the
   VERBOSITY parameter in shorewall.conf[2](5). Each v adds one to the
   effective verbosity and each q subtracts one from the effective
   VERBOSITY. Alternatively, v may be followed immediately with one of
   -1,0,1,2 to specify a specify VERBOSITY. There may be no white-space
   between v and the VERBOSITY.

   The options may also include the letter t which causes all progress
   messages to be timestamped.

COMMANDS

The available commands are listed below.

add { interface[:host-list]... zone | zone host-list }
Adds a list of hosts or subnets to a dynamic zone usually used with
VPN's.

The interface argument names an interface defined in the
shorewall-interfaces[3](5) file. A host-list is comma-separated
list whose elements are host or network addresses..if n .sp
Caution
The add command is not very robust. If there are errors in the
host-list, you may see a large number of error messages yet a
subsequent shorewall show zones command will indicate that all
hosts were added. If this happens, replace add by delete and
run the same command again. Then enter the correct command.

Beginning with Shorewall 4.5.9, the dynamic_shared zone option
(shorewall-zones[4](5)) allows a single ipset to handle entries for
multiple interfaces. When that option is specified for a zone, the
add command has the alternative syntax in which the zone name
precedes the host-list.

allow address
Re-enables receipt of packets from hosts previously blacklisted by
a drop, logdrop, reject, or logreject command. Beginning with
Shorewall 5.0.10, this command can also re-enable addresses
blacklisted using the blacklist command.

blacklist address [ option ... ]
Added in Shorewall 5.0.8 and requires DYNAMIC_BLACKLIST=ipset.. in
shorewall.conf[2](5). Causes packets from the given host or network
address to be dropped, based on the setting of BLACKLIST in
shorewall.conf[2](5). The address along with any options are passed
to the ipset add command.

If the disconnect option is specified in the DYNAMIC_BLACKLISTING
setting, then the effective VERBOSITY determines the amount of
information displayed:

* If the effective verbosity is > 0, then a message giving the
number of conntrack flows deleted by the command is displayed.

* If the effective verbosity is > 1, then the conntrack table
entries deleted by the command are also displayed.

call function [ parameter ... ]
Added in Shorewall 4.6.10. Allows you to call a function in one of
the Shorewall libraries or in your compiled script. function must
name the shell function to be called. The listed parameters are
passed to the function.

The function is first searched for in lib.base, lib.common, lib.cli
and lib.cli-std. If it is not found, the call command is passed to
the generated script to be executed.

check [-e] [-d] [-p] [-r] [-T] [-i] [directory]
Compiles the configuration in the specified directory and discards
the compiled output script. If no directory is given, then
/etc/shorewall is assumed.

The -e option causes the compiler to look for a file named
capabilities. This file is produced using the command
shorewall-lite show -f capabilities > capabilities on a system with
Shorewall Lite installed.

The -d option causes the compiler to be run under control of the
Perl debugger.

The -p option causes the compiler to be profiled via the Perl
-wd:DProf command-line option.

The -r option was added in Shorewall 4.5.2 and causes the compiler
to print the generated ruleset to standard out.

The -T option was added in Shorewall 4.4.20 and causes a Perl stack
trace to be included with each compiler-generated error and warning
message.

The -i option was added in Shorewall 4.6.0 and causes a warning
message to be issued if the current line contains alternative input
specifications following a semicolon (";"). Such lines will be
handled incorrectly if INLINE_MATCHES is set to Yes in
shorewall.conf[2](5).

clear [-f]
Clear will remove all rules and chains installed by Shorewall. The
firewall is then wide open and unprotected. Existing connections
are untouched. Clear is often used to see if the firewall is
causing connection problems.

If -f is given, the command will be processed by the compiled
script that executed the last successful start, restart or refresh
command if that script exists.

close { open-number | source dest [ protocol [ port ] ] }
Added in Shorewall 4.5.8. This command closes a temporary open
created by the open command. In the first form, an open-number
specifies the open to be closed. Open numbers are displayed in the
num column of the output of the shorewall show opens command.

When the second form of the command is used, the parameters must
match those given in the earlier open command.

compile [-e] [-c] [-d] [-p] [-T] [-i] [ directory ] [ pathname ]
Compiles the current configuration into the executable file
pathname. If a directory is supplied, Shorewall will look in that
directory first for configuration files. If the pathname is
omitted, the file firewall in the VARDIR (normally
/var/lib/shorewall/) is assumed. A pathname of '-' causes the
compiler to send the generated script to it's standard output file.
Note that '-v-1' is usually specified in this case (e.g., shorewall
-v-1 compile -- -) to suppress the 'Compiling...' message normally
generated by /sbin/shorewall.

When -e is specified, the compilation is being performed on a
system other than where the compiled script will run. This option
disables certain configuration options that require the script to
be compiled where it is to be run. The use of -e requires the
presence of a configuration file named capabilities which may be
produced using the command shorewall-lite show -f capabilities >
capabilities on a system with Shorewall Lite installed

The -c option was added in Shorewall 4.5.17 and causes conditional
compilation of a script. The script specified by pathname (or
implied if pathname is omitted) is compiled if it doesn't exist or
if there is any file in the directory or in a directory on the
CONFIG_PATH that has a modification time later than the file to be
compiled. When no compilation is needed, a message is issued and an
exit status of zero is returned.

The -d option causes the compiler to be run under control of the
Perl debugger.

The -p option causes the compiler to be profiled via the Perl
-wd:DProf command-line option.

The -T option was added in Shorewall 4.4.20 and causes a Perl stack
trace to be included with each compiler-generated error and warning
message.

delete { interface[:host-list]... zone | zone host-list }
The delete command reverses the effect of an earlier add command.

The interface argument names an interface defined in the
shorewall-interfaces[3](5) file. A host-list is comma-separated
list whose elements are a host or network address.

Beginning with Shorewall 4.5.9, the dynamic_shared zone option
(shorewall-zones[4](5)) allows a single ipset to handle entries for
multiple interfaces. When that option is specified for a zone, the
delete command has the alternative syntax in which the zone name
precedes the host-list.

disable { interface | provider }
Added in Shorewall 4.4.26. Disables the optional provider
associated with the specified interface or provider. Where more
than one provider share a single network interface, a provider name
must be given.

Beginning with Shorewall 4.5.10, this command may be used with any
optional network interface. interface may be either the logical or
physical name of the interface. The command removes any routes
added from shorewall-routes[5](5) and any traffic shaping
configuration for the interface.

drop address
Causes traffic from the listed addresses to be silently dropped.

dump [-x] [-l] [-m] [-c]
Produces a verbose report about the firewall configuration for the
purpose of problem analysis.

The -x option causes actual packet and byte counts to be displayed.
Without that option, these counts are abbreviated.

The -m option causes any MAC addresses included in Shorewall log
messages to be displayed.

The -l option causes the rule number for each Netfilter rule to be
displayed.

The -c option causes the route cache to be dumped in addition to
the other routing information.

enable { interface | provider }
Added in Shorewall 4.4.26. Enables the optional provider associated
with the specified interface or provider. Where more than one
provider share a single network interface, a provider name must be
given.

Beginning with Shorewall 4.5.10, this command may be used with any
optional network interface. interface may be either the logical or
physical name of the interface. The command sets /proc entries for
the interface, adds any route specified in shorewall-routes[5](5)
and installs the interface's traffic shaping configuration, if any.

export [ directory1 ] [ user@]system[:directory2 ]
If directory1 is omitted, the current working directory is assumed.

Allows a non-root user to compile a shorewall script and stage it
on a system (provided that the user has access to the system via
ssh). The command is equivalent to:

/sbin/shorewall compile -e directory1 directory1/firewall &&\
scp directory1/firewall directory1/firewall.conf [user@]system:[directory2]

In other words, the configuration in the specified (or defaulted)
directory is compiled to a file called firewall in that directory.
If compilation succeeds, then firewall and firewall.conf are copied
to system using scp.

forget [ filename ]
Deletes /var/lib/shorewall/filename and /var/lib/shorewall/save. If
no filename is given then the file specified by RESTOREFILE in
shorewall.conf[2](5) is assumed.

help
Displays a syntax summary.

hits [-t]
Generates several reports from Shorewall log messages in the
current log file. If the -t option is included, the reports are
restricted to log messages generated today.

ipcalc { address mask | address/vlsm }
Ipcalc displays the network address, broadcast address, network in
CIDR notation and netmask corresponding to the input[s].

iprange address1-address2
Iprange decomposes the specified range of IP addresses into the
equivalent list of network/host addresses.

iptrace iptables match expression
This is a low-level debugging command that causes iptables TRACE
log records to be created. See iptables(8) for details.

The iptables match expression must be one or more matches that may
appear in both the raw table OUTPUT and raw table PREROUTING
chains.

The log message destination is determined by the currently-selected
IPv4 logging backend[6].

list
list is a synonym for show -- please see below.

logdrop address
Causes traffic from the listed addresses to be logged then
discarded. Logging occurs at the log level specified by the
BLACKLIST_LOGLEVEL setting in shorewall.conf[2] (5).

logwatch [-m] [ refresh-interval ]
Monitors the log file specified by the LOGFILE option in
shorewall.conf[2](5) and produces an audible alarm when new
Shorewall messages are logged. The -m option causes the MAC address
of each packet source to be displayed if that information is
available. The refresh-interval specifies the time in seconds
between screen refreshes. You can enter a negative number by
preceding the number with "--" (e.g., shorewall logwatch -- -30).
In this case, when a packet count changes, you will be prompted to
hit any key to resume screen refreshes.

logreject address
Causes traffic from the listed addresses to be logged then
rejected. Logging occurs at the log level specified by the
BLACKLIST_LOGLEVEL setting in shorewall.conf[2] (5).

ls
ls is a synonym for show -- please see below.

noiptrace iptables match expression
This is a low-level debugging command that cancels a trace started
by a preceding iptrace command.

The iptables match expression must be one given in the iptrace
command being canceled.

open source dest [ protocol [ port ] ]
Added in Shorewall 4.6.8. This command requires that the firewall
be in the started state and that DYNAMIC_BLACKLIST=Yes in
shorewall.conf (5)[2]. The effect of the command is to temporarily
open the firewall for connections matching the parameters.

The source and dest parameters may each be specified as all if you
don't wish to restrict the connection source or destination
respectively. Otherwise, each must contain a host or network
address or a valid DNS name.

The protocol may be specified either as a number or as a name
listed in /etc/protocols. The port may be specified numerically or
as a name listed in /etc/services.

To reverse the effect of a successful open command, use the close
command with the same parameters or simply restart the firewall.

Example: To open the firewall for SSH connections to address
192.168.1.1, the command would be:

shorewall open all 192.168.1.1 tcp 22

To reverse that command, use:

shorewall close all 192.168.1.1 tcp 22

reenable{ interface | provider }
Added in Shorewall 4.6.9. This is equivalent to a disable command
followed by an enable command on the specified interface or
provider.

refresh [-n] [-d] [-T] [-i] [-D directory ] [ chain... ]
All steps performed by restart are performed by refresh with the
exception that refresh only recreates the chains specified in the
command while restart recreates the entire Netfilter ruleset. If no
chain is given, the static blacklisting chain blacklst is assumed.

The listed chains are assumed to be in the filter table. You can
refresh chains in other tables by prefixing the chain name with the
table name followed by ":" (e.g., nat:net_dnat). Chain names which
follow are assumed to be in that table until the end of the list or
until an entry in the list names another table. Built-in chains
such as FORWARD may not be refreshed.

The -n option was added in Shorewall 4.5.3 causes Shorewall to
avoid updating the routing table(s).

The -d option was added in Shorewall 4.5.3 causes the compiler to
run under the Perl debugger.

The -T option was added in Shorewall 4.5.3 and causes a Perl stack
trace to be included with each compiler-generated error and warning
message.

The -D option was added in Shorewall 4.5.3 and causes Shorewall to
look in the given directory first for configuration files.

Example:

shorewall refresh net2fw nat:net_dnat #Refresh the 'net2loc' chain in the filter table and the 'net_dnat' chain in the nat table

The refresh command has slightly different behavior. When no chain
name is given to the refresh command, the mangle table is refreshed
along with the blacklist chain (if any). This allows you to modify
/etc/shorewall/tcrulesand install the changes using refresh.

reject address
Causes traffic from the listed addresses to be silently rejected.

reload [-n] [-p] [-d] [-f] [-c] [-T] [-i] [-C] [ directory ]
This command was re-implemented in Shorewall 5.0.0. The pre-5.0.0
reload command is now called remote-restart (see below).

Reload is similar to shorewall start except that it assumes that
the firewall is already started. Existing connections are
maintained. If a directory is included in the command, Shorewall
will look in that directory first for configuration files.

The -n option causes Shorewall to avoid updating the routing
table(s).

The -p option causes the connection tracking table to be flushed;
the conntrack utility must be installed to use this option.

The -d option causes the compiler to run under the Perl debugger.

The -f option suppresses the compilation step and simply reused the
compiled script which last started/restarted Shorewall, provided
that /etc/shorewall and its contents have not been modified since
the last start/restart.

The -c option was added in Shorewall 4.4.20 and performs the
compilation step unconditionally, overriding the AUTOMAKE setting
in shorewall.conf[2](5). When both -f and -c are present, the
result is determined by the option that appears last.

The -T option was added in Shorewall 4.5.3 and causes a Perl stack
trace to be included with each compiler-generated error and warning
message.

The -C option was added in Shorewall 4.6.5 and is only meaningful
when AUTOMAKE=Yes in shorewall.conf[2](5). If an existing firewall
script is used and if that script was the one that generated the
current running configuration, then the running netfilter
configuration will be reloaded as is so as to preserve the iptables
packet and byte counters.

remote-start [-s] [-c] [-r root-user-name] [-T] [-i] [ [ -D ] directory
] [ system ]
This command was renamed from load in Shorewall 5.0.0.

If directory is omitted, the current working directory is assumed.
Allows a non-root user to compile a shorewall script and install it
on a system (provided that the user has root access to the system
via ssh). The command is equivalent to:

/sbin/shorewall compile -e directory directory/firewall &&\
scp directory/firewall directory/firewall.conf root@system:/var/lib/shorewall-lite/ &&\
ssh root@system '/sbin/shorewall-lite start'

In other words, the configuration in the specified (or defaulted)
directory is compiled to a file called firewall in that directory.
If compilation succeeds, then firewall is copied to system using
scp. If the copy succeeds, Shorewall Lite on system is started via
ssh. Beginning with Shorewall 5.0.13, if system is omitted, then
the FIREWALL option setting in shorewall6.conf(5)[7] is assumed. In
that case, if you want to specify a directory, then the -D option
must be given.

If -s is specified and the start command succeeds, then the remote
Shorewall-lite configuration is saved by executing shorewall-lite
save via ssh.

if -c is included, the command shorewall-lite show capabilities -f
> /var/lib/shorewall-lite/capabilities is executed via ssh then the
generated file is copied to directory using scp. This step is
performed before the configuration is compiled.

If -r is included, it specifies that the root user on system is
named root-user-name rather than "root".

The -T option was added in Shorewall 4.5.3 and causes a Perl stack
trace to be included with each compiler-generated error and warning
message.

remote-reload [-s] [-c] [-r root-user-name] [-T] [-i] [ [ -D ]
directory ] [ system ]
This command was added in Shorewall 5.0.0.

/sbin/shorewall compile -e directory directory/firewall &&\
scp directory/firewall directory/firewall.conf root@system:/var/lib/shorewall-lite/ &&\
ssh root@system '/sbin/shorewall-lite reload'

In other words, the configuration in the specified (or defaulted)
directory is compiled to a file called firewall in that directory.
If compilation succeeds, then firewall is copied to system using
scp. If the copy succeeds, Shorewall Lite on system is restarted
via ssh. Beginning with Shorewall 5.0.13, if system is omitted,
then the FIREWALL option setting in shorewall6.conf(5)[7] is
assumed. In that case, if you want to specify a directory, then the
-D option must be given.

If -s is specified and the restart command succeeds, then the
remote Shorewall-lite configuration is saved by executing
shorewall-lite save via ssh.

If -r is included, it specifies that the root user on system is
named root-user-name rather than "root".

The -T option was added in Shorewall 4.5.3 and causes a Perl stack
trace to be included with each compiler-generated error and warning
message.

remote-restart [-s] [-c] [-r root-user-name] [-T] [-i] [ [ -D ]
directory ] [ system ]
This command was renamed from reload in Shorewall 5.0.0.

/sbin/shorewall compile -e directory directory/firewall &&\
scp directory/firewall directory/firewall.conf root@system:/var/lib/shorewall-lite/ &&\
ssh root@system '/sbin/shorewall-lite restart'

In other words, the configuration in the specified (or defaulted)
directory is compiled to a file called firewall in that directory.
If compilation succeeds, then firewall is copied to system using
scp. If the copy succeeds, Shorewall Lite on system is restarted
via ssh. Beginning with Shorewall 5.0.13, if system is omitted,
then the FIREWALL option setting in shorewall6.conf(5)[7] is
assumed. In that case, if you want to specify a directory, then the
-D option must be given.

If -s is specified and the restart command succeeds, then the
remote Shorewall-lite configuration is saved by executing
shorewall-lite save via ssh.

If -r is included, it specifies that the root user on system is
named root-user-name rather than "root".

The -T option was added in Shorewall 4.5.3 and causes a Perl stack
trace to be included with each compiler-generated error and warning
message.

reset [chain, ...]
Resets the packet and byte counters in the specified chain(s). If
no chain is specified, all the packet and byte counters in the
firewall are reset.

Beginning with Shorewall 5.0.0, chain may be composed of both a
table name and a chain name separated by a colon (e.g.,
mangle:PREROUTING). Chain names following that don't include a
table name are assumed to be in that same table. If no table name
is given in the command, the filter table is assumed.

restart [-n] [-p] [-d] [-f] [-c] [-T] [-i] [-C] [ directory ]
Beginning with Shorewall 5.0.0, this command performs a true
restart. The firewall is completely stopped as if a stop command
had been issued then it is started again.

If a directory is included in the command, Shorewall will look in
that directory first for configuration files.

The -n option causes Shorewall to avoid updating the routing
table(s).

The -p option causes the connection tracking table to be flushed;
the conntrack utility must be installed to use this option.

The -d option causes the compiler to run under the Perl debugger.

The -T option was added in Shorewall 4.5.3 and causes a Perl stack
trace to be included with each compiler-generated error and warning
message.

restore [-n] [-p] [-C] [ filename ]
Restore Shorewall to a state saved using the shorewall save
command. Existing connections are maintained. The filename names a
restore file in /var/lib/shorewall created using shorewall save; if
no filename is given then Shorewall will be restored from the file
specified by the RESTOREFILE option in shorewall.conf[2](5).

Caution
If your iptables ruleset depends on variables that are detected
at run-time, either in your params file or by
Shorewall-generated code, restore will use the values that were
current when the ruleset was saved, which may be different from
the current values.
The -n option causes Shorewall to avoid updating the routing
table(s).

The -p option, added in Shorewall 4.6.5, causes the connection
tracking table to be flushed; the conntrack utility must be
installed to use this option.

The -C option was added in Shorewall 4.6.5. If the -C option was
specified during shorewall save, then the counters saved by that
operation will be restored.

run command [ parameter ... ]
Added in Shorewall 4.6.3. Executes command in the context of the
generated script passing the supplied parameters. Normally, the
command will be a function declared in lib.private.

Before executing the command, the script will detect the
configuration, setting all SW_* variables and will run your init
extension script with $COMMAND = 'run'.

If there are files in the CONFIG_PATH that were modified after the
current firewall script was generated, the following warning
message is issued:
WARNING: /var/lib/shorewall/firewall is not up to
date

safe-reload [-d] [-p] [-t timeout ] [ directory ]
Added in Shorewall 5.0.0, this command performs the same function
as did safe_restart in earlier releases.

Only allowed if Shorewall is running. The current configuration is
saved in /var/lib/shorewall/safe-reload (see the save command
below) then a shorewall reload is done. You will then be prompted
asking if you want to accept the new configuration or not. If you
answer "n" or if you fail to answer within 60 seconds (such as when
your new configuration has disabled communication with your
terminal), the configuration is restored from the saved
configuration. If a directory is given, then Shorewall will look in
that directory first when opening configuration files.

Beginning with Shorewall 4.5.0, you may specify a different timeout
value using the -t option. The numeric timeout may optionally be
followed by an s, m or h suffix (e.g., 5m) to specify seconds,
minutes or hours respectively. If the suffix is omitted, seconds is
assumed.

safe-restart [-d] [-p] [-t timeout ] [ directory ]
Only allowed if Shorewall is running. The current configuration is
saved in /var/lib/shorewall/safe-restart (see the save command
below) then a shorewall restart is done. You will then be prompted
asking if you want to accept the new configuration or not. If you
answer "n" or if you fail to answer within 60 seconds (such as when
your new configuration has disabled communication with your
terminal), the configuration is restored from the saved
configuration. If a directory is given, then Shorewall will look in
that directory first when opening configuration files.

safe-start [-d] [-p] [-ttimeout ] [ directory ]
Shorewall is started normally. You will then be prompted asking if
everything went all right. If you answer "n" or if you fail to
answer within 60 seconds (such as when your new configuration has
disabled communication with your terminal), a shorewall clear is
performed for you. If a directory is given, then Shorewall will
look in that directory first when opening configuration files.

save [-C] [ filename ]
The dynamic blacklist is stored in /var/lib/shorewall/save. The
state of the firewall is stored in /var/lib/shorewall/filename for
use by the shorewall restore and shorewall -f start commands. If
filename is not given then the state is saved in the file specified
by the RESTOREFILE option in shorewall.conf[2](5).

The -C option, added in Shorewall 4.6.5, causes the iptables packet
and byte counters to be saved along with the chains and rules.

savesets
Added in shorewall 4.6.8. Performs the same action as the stop
command with respect to saving ipsets (see the SAVE_IPSETS option
in shorewall.conf[2] (5)). This command may be used to proactively
save your ipset contents in the event that a system failure occurs
prior to issuing a stop command.

show
The show command can have a number of different arguments:

actions
Produces a report about the available actions (built-in,
standard and user-defined).

bl|blacklists [-x]
Added in Shorewall 4.6.2. Displays the dynamic chain along with
any chains produced by entries in shorewall-blrules(5). The -x
option is passed directly through to iptables and causes actual
packet and byte counts to be displayed. Without this option,
those counts are abbreviated.

[-f] capabilities
Displays your kernel/iptables capabilities. The -f option
causes the display to be formatted as a capabilities file for
use with compile -e.

[-b] [-x] [-l] [-t {filter|mangle|nat|raw|rawpost}] [ chain... ]
The rules in each chain are displayed using the iptables
-Lchain-n -v command. If no chain is given, all of the chains
in the filter table are displayed. The -x option is passed
directly through to iptables and causes actual packet and byte
counts to be displayed. Without this option, those counts are
abbreviated. The -t option specifies the Netfilter table to
display. The default is filter.

The -b ('brief') option causes rules which have not been used
(i.e. which have zero packet and byte counts) to be omitted
from the output. Chains with no rules displayed are also
omitted from the output.

The -l option causes the rule number for each Netfilter rule to
be displayed.

If the -t option and the chain keyword are both omitted and any
of the listed chains do not exist, a usage message is
displayed.

classifiers|filters
Displays information about the packet classifiers defined on
the system as a result of traffic shaping configuration.

config
Displays distribution-specific defaults.

connections [filter_parameter ...]
Displays the IP connections currently being tracked by the
firewall.

If the conntrack utility is installed, beginning with Shorewall
4.6.11 the set of connections displayed can be limited by
including conntrack filter parameters (-p , -s, --dport, etc).
See conntrack(8) for details.

event event
Added in Shorewall 4.5.19. Displays the named event.

events
Added in Shorewall 4.5.19. Displays all events.

ip
Displays the system's IPv4 configuration.

ipa
Added in Shorewall 4.4.17. Displays the per-IP accounting
counters (shorewall-accounting[8] (5)).

[-m] log
Displays the last 20 Shorewall messages from the log file
specified by the LOGFILE option in shorewall.conf[2](5). The -m
option causes the MAC address of each packet source to be
displayed if that information is available.

macros
Displays information about each macro defined on the firewall
system.

macro macro
Added in Shorewall 4.4.6. Displays the file that implements the
specified macro (usually /usr/share/shorewall/macro.macro).

[-x] mangle
Displays the Netfilter mangle table using the command iptables
-t mangle -L -n -v. The -x option is passed directly through to
iptables and causes actual packet and byte counts to be
displayed. Without this option, those counts are abbreviated.

marks
Added in Shorewall 4.4.26. Displays the various fields in
packet marks giving the min and max value (in both decimal and
hex) and the applicable mask (in hex).

[-x] nat
Displays the Netfilter nat table using the command iptables -t
nat -L -n -v. The -x option is passed directly through to
iptables and causes actual packet and byte counts to be
displayed. Without this option, those counts are abbreviated.

opens
Added in Shorewall 4.5.8. Displays the iptables rules in the
'dynamic' chain created through use of the open command..

policies
Added in Shorewall 4.4.4. Displays the applicable policy
between each pair of zones. Note that implicit intrazone ACCEPT
policies are not displayed for zones associated with a single
network where that network doesn't specify routeback.

[-c] routing
Displays the system's IPv4 routing configuration. The -c option
causes the route cache to be displayed along with the other
routing information.

[-x] raw
Displays the Netfilter raw table using the command iptables -t
raw -L -n -v. The -x option is passed directly through to
iptables and causes actual packet and byte counts to be
displayed. Without this option, those counts are abbreviated.

tc
Displays information about queuing disciplines, classes and
filters.

zones
Displays the current composition of the Shorewall zones on the
system.

start [-n] [-p] [-d] [-f] [-c] [-T] [-i] [-C] [ directory ]
Start shorewall. Existing connections through shorewall managed
interfaces are untouched. New connections will be allowed only if
they are allowed by the firewall rules or policies. If a directory
is included in the command, Shorewall will look in that directory
first for configuration files. If -f is specified, the saved
configuration specified by the RESTOREFILE option in
shorewall.conf[2](5) will be restored if that saved configuration
exists and has been modified more recently than the files in
/etc/shorewall. When -f is given, a directory may not be specified.

Update: In Shorewall 4.4.20, a new LEGACY_FASTSTART option was
added to shorewall.conf[2](5). When LEGACY_FASTSTART=No, the
modification times of files in /etc/shorewall are compared with
that of /var/lib/shorewall/firewall (the compiled script that last
started/restarted the firewall).

The -n option causes Shorewall to avoid updating the routing
table(s).

The -p option causes the connection tracking table to be flushed;
the conntrack utility must be installed to use this option.

The -c option was added in Shorewall 4.4.20 and performs the
compilation step unconditionally, overriding the AUTOMAKE setting
in shorewall.conf[2](5). When both -f and -care present, the result
is determined by the option that appears last.

The -T option was added in Shorewall 4.5.3 and causes a Perl stack
trace to be included with each compiler-generated error and warning
message.

The -C option was added in Shorewall 4.6.5 and is only meaningful
when the -f option is also specified. If the previously-saved
configuration is restored, and if the -C option was also specified
in the save command, then the packet and byte counters will be
restored.

stop [-f]
Stops the firewall. All existing connections, except those listed
in shorewall-routestopped[9](5) or permitted by the
ADMINISABSENTMINDED option in shorewall.conf[2](5), are taken down.
The only new traffic permitted through the firewall is from systems
listed in shorewall-routestopped[9](5) or by ADMINISABSENTMINDED.

If -f is given, the command will be processed by the compiled
script that executed the last successful start, restart or refresh
command if that script exists.

status [-i]
Produces a short report about the state of the Shorewall-configured
firewall.

The -i option was added in Shorewall 4.6.2 and causes the status of
each optional or provider interface to be displayed.

try directory [ timeout ]
If Shorewall is started then the firewall state is saved to a
temporary saved configuration (/var/lib/shorewall/.try). Next, if
Shorewall is currently started then a restart command is issued
using the specified configuration directory; otherwise, a start
command is performed using the specified configuration directory.
if an error occurs during the compilation phase of the restart or
start, the command terminates without changing the Shorewall state.
If an error occurs during the restart phase, then a shorewall
restore is performed using the saved configuration. If an error
occurs during the start phase, then Shorewall is cleared. If the
start/restart succeeds and a timeout is specified then a clear or
restore is performed after timeout seconds.

Beginning with Shorewall 4.5.0, the numeric timeout may optionally
be followed by an s, m or h suffix (e.g., 5m) to specify seconds,
minutes or hours respectively. If the suffix is omitted, seconds is
assumed.

update [-d] [-r] [-T] [-a] [-i] [-A] [ directory ]
Added in Shorewall 4.4.21 and causes the compiler to update
/etc/shorewall/shorewall.conf then validate the configuration. The
update will add options not present in the old file with their
default values, and will move deprecated options with non-defaults
to a deprecated options section at the bottom of the file. Your
existing shorewall.conf file is renamed shorewall.conf.bak.

The command was extended over the years with a set of options that
caused additional configuration updates.

* Convert an existing blacklist file into an equivalent blrules
file.

* Convert an existing routestopped file into an equivalent
stoppedrules file.

* Convert existing tcrules and tos files into an equivalent
mangle file.

* Convert an existing notrack file into an equivalent conntrack
file.

* Convert FORMAT, SECTION and COMMENT entries into ?FORMAT,
?SECTION and ?COMMENT directives.

In each case, the old file is renamed with a .bak suffix.

In Shorewall 5.0.0, the options were eliminated and the update
command performs all of the updates described above.

Important
There are some notable restrictions with the update command:

1. Converted rules will be appended to the existing file; if
there is no existing file in the CONFIG_PATH, one will be
created in the directory specified in the command or in the
first entry in the CONFIG_PATH (normally /etc/shorewall)
otherwise.

2. Existing comments in the file being converted will not be
transferred to the output file.

3. With the exception of the notrack->conntrack conversion,
INCLUDEd files will be expanded inline in the output file.

4. Columns in the output file will be separated by a single
tab character; there is no attempt made to otherwise align
the columns.

5. Prior to Shorewall 5.0.15, shell variables will be expanded
in the output file.

6. Prior to Shorewall 5.0.15, lines omitted by compiler
directives (?if ...., etc.) will not appear in the output
file.

Important
Because the translation of the 'blacklist' and
'routestopped' files is not 1:1, omitted lines and
compiler directives are not transferred to the
converted files. If either are present, the compiler
issues a warning:

WARNING: "Omitted rules and compiler directives were not translated
The -a option causes the updated shorewall.conf file to be
annotated with documentation.

The -A option is included for compatibility with Shorewall 4.6 and
is equivalent to specifying the -i option.

For a description of the other options, see the check command
above.

version [-a]
Displays Shorewall's version. The -a option is included for
compatibility with earlier Shorewall releases and is ignored.

EXIT STATUS

   In general, when a command succeeds, status 0 is returned; when the
   command fails, a non-zero status is returned.

   The status command returns exit status as follows:

   0 - Firewall is started.

   3 - Firewall is stopped or cleared

   4 - Unknown state; usually means that the firewall has never been
   started.

ENVIRONMENT

   Two environmental variables are recognized by Shorewall:

   SHOREWALL_INIT_SCRIPT
       When set to 1, causes Std out to be redirected to the file
       specified in the STARTUP_LOG option in shorewall.conf(5)[10].

   SW_LOGGERTAG
       Added in Shorewall 5.0.8. When set to a non-empty value, that value
       is passed to the logger utility in its -t (--tag) option.

FILES

   /etc/shorewall/

NOTES

    1. http://www.shorewall.net/starting_and_stopping_shorewall.htm#Trace
       http://www.shorewall.net/starting_and_stopping_shorewall.htm#Trace

    2. shorewall.conf
       http://www.shorewall.net/manpages/shorewall.conf.html

    3. shorewall-interfaces
       http://www.shorewall.net/manpages/shorewall-interfaces.html

    4. shorewall-zones
       http://www.shorewall.net/manpages/shorewall-zones.html

    5. shorewall-routes
       http://www.shorewall.net/manpages/shorewall-routes.html

    6. logging backend
       http://www.shorewall.net/shorewall_logging.html#Backends

    7. shorewall6.conf(5)
       http://www.shorewall.netshorewall6.conf.html

    8. shorewall-accounting
       http://www.shorewall.net/manpages/shorewall-accounting.html

    9. shorewall-routestopped
       http://www.shorewall.net/manpages/shorewall-routestopped.html

   10. shorewall.conf(5)
       http://www.shorewall.netshorewall.conf.html

   11. http://www.shorewall.net/starting_and_stopping_shorewall.htm
       http://www.shorewall.net/starting_and_stopping_shorewall.htm

Opportunity

Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.

Education

Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.

shorewall(8)

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

COMMANDS

EXIT STATUS

ENVIRONMENT

FILES

SEE ALSO

NOTES

Opportunity

Free Software

Free Books

Education