Provided by: shorewall-lite_5.0.4-1_all 
NAME
shorewall-lite - Administration tool for Shoreline Firewall Lite (Shorewall Lite)
SYNOPSIS
shorewall-lite [trace|debug [nolock]] [-options] add interface[:host-list]... zone
shorewall-lite [trace|debug [nolock]] [-options] allow address
shorewall-lite [trace|debug [nolock]] [-options] allow address
shorewall-lite [trace|debug [nolock]] [-options] clear [-f]
shorewall-lite [trace|debug [nolock]] [-options]
close { open-number | sourcedest [protocol [ port ]]}
shorewall-lite [trace|debug [nolock]] [-options] delete interface[:host-list]... zone
shorewall-lite [trace|debug [nolock]] [-options] disable { interface | provider }
shorewall-lite [trace|debug [nolock]] [-options] drop address
shorewall-lite [trace|debug] [-options] dump [-x] [-l] [-m] [-c]
shorewall-lite [trace|debug [nolock]] [-options] enable { interface | provider }
shorewall-lite [trace|debug [nolock]] [-options] forget [filename]
shorewall-lite [trace|debug] [-options] help
shorewall-lite [trace|debug] [-options] hits [-t]
shorewall-lite [trace|debug] [-options] ipcalc {address mask | address/vlsm}
shorewall-lite [trace|debug] [-options] iprange address1-address2
shorewall-lite [trace|debug] [-options] iptrace iptables match expression
shorewall-lite [trace|debug [nolock]] [-options] logdrop address
shorewall-lite [trace|debug] [-options] logwatch [-m] [refresh-interval]
shorewall-lite [trace|debug [nolock]] [-options] logreject address
shorewall-lite [trace|debug] [-options] noiptrace iptables match expression
shorewall-lite open source dest [ protocol [ port ] ]
shorewall-lite [trace|debug [nolock]] [-options] reenable { interface | provider }
shorewall-lite [trace|debug [nolock]] [-options] reject address
shorewall-lite [trace|debug [nolock]] [-options] reload [-n] [-p [-C]]
shorewall-lite [trace|debug [nolock]] [-options] reset
shorewall-lite [trace|debug [nolock]] [-options] restart [-n] [-p [-C]]
shorewall-lite [trace|debug [nolock]] [-options] restore [-C] [filename]
shorewall-lite [trace|debug [nolock]] [-options] run function [parameter ...]
shorewall-lite [trace|debug [nolock]] [-options] save [-C] [filename]
shorewall-lite [trace|debug [nolock]] [-options] savesets
shorewall-lite [trace|debug] [-options] {show | list | ls } [-b] [-x] [-l]
[-t {filter|mangle|nat|raw|rawpost}] [[chain] chain...]
shorewall-lite [trace|debug] [-options] {show | list | ls } [-x] {bl|blacklists}
shorewall-lite [trace|debug] [-options] {show | list | ls } [-f] capabilities
shorewall-lite [trace|debug] [-options] {show | list | ls }
{classifiers|connections|config|events|filters|ip|ipa|zones|policies|marks}
shorewall-lite [trace|debug] [-options] {show | list | ls } event event
shorewall-lite [trace|debug] [-options] {show | list | ls } [-c] routing
shorewall-lite [trace|debug] [-options] {show | list | ls } [-x] {mangle|nat|raw|rawpost}
shorewall-lite [trace|debug] [-options] {show | list | ls } tc
shorewall-lite [trace|debug] [-options] {show | list | ls } [-m] log
shorewall-lite [trace|debug [nolock]] [-options] start [-n] [-p] [-f] [-C]
shorewall-lite [trace|debug [nolock]] [-options] stop
shorewall-lite [trace|debug] [-options] status [-i]
shorewall-lite [trace|debug] [-options] version [-a]
DESCRIPTION
The shorewall-lite utility is used to control the Shoreline Firewall Lite (Shorewall
Lite).
OPTIONS
The trace and debug options are used for debugging. See
http://www.shorewall.net/starting_and_stopping_shorewall.htm#Trace.
The nolock option prevents the command from attempting to acquire the Shorewall-lite
lockfile. It is useful if you need to include shorewall commands in the startedextension
script[1].
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.
Alternately, v may be followed immediately with one of -1,0,1,2 to 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.
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-lite 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.
allow address
Re-enables receipt of packets from hosts previously blacklisted by a drop, logdrop,
reject, or logreject command.
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 and lib.cli. If it is not
found, the call command is passed to the generated script to be executed.
clear [-f]
Clear will remove all rules and chains installed by Shorewall-lite. 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, reload, 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-lite show opens
command.
When the second form of the command is used, the parameters must match those given in
the earlier open command.
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.
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.
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-lite 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.
forget [ filename ]
Deletes /var/lib/shorewall-lite/filename and /var/lib/shorewall-lite/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-lite 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 trace records are written to the kernel's log buffer with facility = kernel and
priority = warning, and they are routed from there by your logging daemon (syslogd,
rsyslog, syslog-ng, ...) -- Shorewall-lite has no control over where the messages go;
consult your logging daemon's documentation.
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-lite 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-lite 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)[4]. 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-lite open all 192.168.1.1 tcp 22
To reverse that command, use:
shorewall-lite 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.
reject address
Causes traffic from the listed addresses to be silently rejected.
reload [-n] [-p] [-C]
Added in Shorewall 5.0.0, reload is similar to shorewall-lite start except that it
assumes that the firewall is already started. Existing connections are maintained.
The -n option causes Shorewall-lite 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.6.5. If the specified (or implicit) firewall
script is 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.
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.
restart [-n] [-p] [-C]
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.
The -n option causes Shorewall-lite 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.6.5. If the specified (or implicit) firewall
script is 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.
restore [-n] [-p] [-C] [ filename ]
Restore Shorewall-lite to a state saved using the shorewall-lite save command.
Existing connections are maintained. The filename names a restore file in
/var/lib/shorewall-lite created using shorewall-lite save; if no filename is given
then Shorewall-lite 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'.
save [-C] [ filename ]
The dynamic blacklist is stored in /var/lib/shorewall-lite/save. The state of the
firewall is stored in /var/lib/shorewall-lite/filename for use by the shorewall-lite
restore. 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[4] (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:
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[5] (5)).
[-m] log
Displays the last 20 Shorewall-lite 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.
[-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).
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.
routing
Displays the system's IPv4 routing configuration. The -c option causes the route
cache to be displayed in addition to the other routing information.
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 [-p] [-n] [-f] [-C]
Start Shorewall Lite. Existing connections through shorewall-lite managed interfaces
are untouched. New connections will be allowed only if they are allowed by the
firewall rules or policies.
The -p option causes the connection tracking table to be flushed; the conntrack
utility must be installed to use this option.
The -n option prevents the firewall script from modifying the current routing
configuration.
The -f option was added in Shorewall 4.6.5. If the RESTOREFILE named in
shorewall.conf[2](5) exists, is executable and is not older than the current filewall
script, then that saved configuration is restored.
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
Stops the firewall. All existing connections, except those listed in
shorewall-routestopped[6](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[6](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
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.
version
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.
FILES
/etc/shorewall-lite/
SEE ALSO
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-ipsets(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-rtrules(5),
shorewall-routestopped(5), shorewall-rules(5), shorewall.conf(5), shorewall-secmarks(5),
shorewall-tcclasses(5), shorewall-tcdevices(5), shorewall-tcrules(5), shorewall-tos(5),
shorewall-tunnels(5), shorewall-zones(5)
NOTES
1. extension script
http://www.shorewall.net../shorewall_extension_scripts.html
2. shorewall.conf
http://www.shorewall.netshorewall.conf.html
3. shorewall-interfaces
http://www.shorewall.netshorewall-interfaces.html
4. shorewall.conf (5)
http://www.shorewall.net/manpages/shorewall.conf.html
5. shorewall-accounting
http://www.shorewall.netmanpages/shorewall-accounting.html
6. shorewall-routestopped
http://www.shorewall.netshorewall-routestopped.html