shorewall — Administration tool for Shoreline Firewall (Shorewall)
shorewall
[trace
|debug
[nolock
]] [-options
] add
interface
[:host-list
]... zone
shorewall
[trace
|debug
[nolock
]] [-options
] allow
address
shorewall
[trace
|debug
] [-options
] check
[-e
] [-d
] [-p
] [-r
] [directory
]
shorewall
[trace
|debug
[nolock
]] [-options
] clear
[-f
]
shorewall
[trace
|debug
] [-options
] compile
[-e
] [-d
] [-p
] [directory
] [pathname
]
shorewall
[trace
|debug
[nolock
]] [-options
] delete
interface
[:host-list
]... zone
shorewall
[trace
|debug
[nolock
]] [-options
] drop
address
shorewall
[trace
|debug
] [-options
] dump
[-x
] [-l
] [-m
]
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
] [-options
] load
[-s
] [-c
] [-r
root-user-name
] [directory
] system
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
[trace
|debug
[nolock
]] [-options
] refresh
[chain
...]
shorewall
[trace
|debug
[nolock
]] [-options
] reject
address
shorewall
[trace
|debug
] [-options
] reload
[-s
] [-c
] [-r
root-user-name
] [directory
] system
shorewall
[trace
|debug
[nolock
]] [-options
] reset
shorewall
[trace
|debug
[nolock
]] [-options
] restart
[-n
] [-p
] [-f
] [directory
]
shorewall
[trace
|debug
[nolock
]] [-options
] restore
[filename
]
shorewall
[trace
|debug
[nolock
]] [-options
] safe-restart
[-d
] [-p
] [directory
]
shorewall
[trace
|debug
] [-options
] safe-start
[-d
] [-p
] [directory
]
shorewall
[trace
|debug
[nolock
]] [-options
] save
[filename
]
shorewall
[trace
|debug
] [-options
] show
[-x
] [-l
] [-t
{filter
|mangle
|nat
|raw
}] [[chain
] chain
... ]
shorewall
[trace
|debug
] [-options
] show
[-f
] capabilities
shorewall
[trace
|debug
] [-options
] show
{actions|classifiers|connections|config|filters|macros|zones
}
shorewall
[trace
|debug
] [-options
] show
macro
macro
shorewall
[trace
|debug
] [-options
] show
[-x
] {mangle|nat|raw
}
shorewall
[trace
|debug
] [-options
] show
policies
shorewall
[trace
|debug
] [-options
] show
tc
[device
]
shorewall
[trace
|debug
] [-options
] show
[-m
] log
shorewall
[trace
|debug
[nolock
]] [-options
] start
[-n
] [-f
] [-p
] [directory
]
shorewall
[trace
|debug
[nolock
]] [-options
] stop
[-f
]
shorewall
[trace
|debug
] [-options
] status
shorewall
[trace
|debug
[nolock
]] [-options
] try
directory
[timeout
]
shorewall
[trace
|debug
] [-options
] version
[-a
]
The trace
and debug
options are
used for debugging. See http://www.shorewall.net/starting_and_stopping.htm#Trace.
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(5). Each v adds one to the effective verbosity and each q subtracts one from the effective VERBOSITY. Anternately, 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.
The available commands are listed below.
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(5) file. A host-list is comma-separated list whose elements are host or network addresses.
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.
Re-enables receipt of packets from hosts previously blacklisted by a drop, logdrop, reject, or logreject command.
Compiles the configuraton 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.
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.
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 presense
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 -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 delete command reverses the effect of an earlier add command.
The interface argument names an interface defined in the shorewall-interfaces(5) file. A host-list is comma-separated list whose elements are a host or network address.
Causes traffic from the listed addresses to be silently dropped.
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.
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.
Deletes /var/lib/shorewall/filename and /var/lib/shorewall/save. If no filename is given then the file specified by RESTOREFILE in shorewall.conf(5) is assumed.
Displays a syntax summary.
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 displays the network address, broadcast address, network in CIDR notation and netmask corresponding to the input[s].
Iprange decomposes the specified range of IP addresses into the equivalent list of network/host addresses.
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 trace records are written to the kernel's log buffer with faciility = kernel and priority = warning, and they are routed from there by your logging daemon (syslogd, rsyslog, syslog-ng, ...) -- Shorewall has no control over where the messages go; consult your logging daemon's documentation.
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 -edirectory
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.
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".
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 (5).
Monitors the log file specified by the LOGFILE option in
shorewall.conf(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.
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 (5).
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
cancelled.
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.
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/tcrules
and
install the changes using refresh.
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 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.
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 -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".
All the packet and byte counters in the firewall are reset.
Restart 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 -f
option suppresses the compilation step
and simply reused the compiled script which last started/restarted
Shorewall.
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(5).
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.
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.
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(5).
The show command can have a number of different arguments:
Produces a report about the available actions (built-in, standard and user-defined).
Displays your kernel/iptables capabilities. The -f option causes the display to be formatted as a capabilities file for use with compile -e.
chain
] chain...
]The rules in each chain are displayed using the iptables -L chain -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 -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 chain
s do not exist, a usage
message is displayed.
Displays information about the packet classifiers defined on the system as a result of traffic shaping configuration.
Dispays distribution-specific defaults.
Displays the IP connections currently being tracked by the firewall.
Displays the last 20 Shorewall messages from the log file specified by the LOGFILE option in shorewall.conf(5). The -m option causes the MAC address of each packet source to be displayed if that information is available.
Displays information about each macro defined on the firewall system.
Added in Shorewall 4.4.6. Displays the file that
implements the specified macro
-
usually
/usr/share/shorewall/macro
.macro.
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.
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.
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
.
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.
Displays information about queuing disciplines, classes
and filters. With Shorewall 4.5.1 and later, the display can
be restricted to a specified
device
.
Displays the current composition of the Shorewall zones on the system.
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(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.
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.
Stops the firewall. All existing connections, except those listed in shorewall-routestopped(5) or permitted by the ADMINISABSENTMINDED option in shorewall.conf(5), are taken down. The only new traffic permitted through the firewall is from systems listed in shorewall-routestopped(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.
Produces a short report about the state of the Shorewall-configured firewall.
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; otherwise, a start command is performed. if an error
occurs during the compliation 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.
Displays Shorewall's version. The -a
option
is included for compatibility with earlier Shorewall releases and is
ignored.
http://www.shorewall.net/starting_and_stopping_shorewall.htm
shorewall-accounting(5), shorewall-actions(5), shorewall-blacklist(5), shorewall-hosts(5), shorewall-interfaces(5), shorewall-ipsec(5), shorewall-maclist(5), shorewall-masq(5), shorewall-nat(5), shorewall-netmap(5), shorewall-params(5), shorewall-policy(5), shorewall-providers(5), shorewall-proxyarp(5), shorewall-route_rules(5), shorewall-routestopped(5), shorewall-rules(5), shorewall.conf(5), shorewall-tcclasses(5), shorewall-tcdevices(5), shorewall-tcrules(5), shorewall-tos(5), shorewall-tunnels(5), shorewall-zones(5)