shorewall
Administration tool for Shoreline Firewall (Shorewall)
- Provided by: shorewall (Version: 4.5.21.6-1)
- Report a bug
Administration tool for Shoreline Firewall (Shorewall)
shorewall [trace|debug [nolock]] [-options] add { interface[:host-list]... zone | zone host-list }
shorewall [trace|debug [nolock]] [-options] allow address
shorewall [trace|debug] [-options] [check | ck ] [-e] [-d] [-p] [-r] [-T] [directory]
shorewall [trace|debug [nolock]] [-options] clear [-f]
shorewall [trace|debug] [-options] [compile | co ] [-e] [-c] [-d] [-p] [-T] [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]
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] [-options] load [-s] [-c] [-r root-user-name] [-T] [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 [-n] [-d] [-T] [-D directory ] [chain...]
shorewall [trace|debug [nolock]] [-options] reject address
shorewall [trace|debug] [-options] reload [-s] [-c] [-r root-user-name] [-T] [directory] system
shorewall [trace|debug [nolock]] [-options] reset
shorewall [trace|debug [nolock]] [-options] restart [-n] [-p [-d]] [-f] [-c] [-T] [directory]
shorewall [trace|debug [nolock]] [-options] restore [filename]
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 [filename]
shorewall [trace|debug] [-options] [show | list | ls ] [-b] [-x] [-l] [-t {filter|mangle|nat|raw|rawpost}] [[chain] 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 ] macro macro
shorewall [trace|debug] [-options] [show | list | ls ] [-x] {mangle|nat|routing|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] [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] update [-b] [-d] [-r] [-T] [-a] [-D] [directory]
shorewall [trace|debug] [-options] version [-a]
The shorewall utility is used to control the Shoreline Firewall (Shorewall).
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 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[1](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.
The available commands are listed below.
add
The interface argument names an interface defined in the shorewall-interfaces[2](5) file. A host-list is comma-separated list whose elements are host or network addresses..if n .sp
Beginning with Shorewall 4.5.9, the dynamic_shared zone option (shorewall-zones[3](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
check
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.
clear
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.
compile
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
The interface argument names an interface defined in the shorewall-interfaces[2](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[3](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
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[4](5) and any traffic shaping configuration for the interface.
drop
dump
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.
enable
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[4](5) and installs the interface's traffic shaping configuration, if any.
export
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
help
hits
ipcalc
iprange
iptrace
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 has no control over where the messages go; consult your logging daemon's documentation.
load
/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.
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.
logdrop
logwatch
logreject
noiptrace
The iptables match expression must be one given in the iptrace command being canceled.
refresh
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.
reload
/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".
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
restart
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[1](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.
restore
safe-restart
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-start
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.
save
show
actions
capabilities
[ [ chain ] chain... ]
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
config
connections
event event
events
ip
ipa
log
macros
macro
marks
nat
policies
routing
raw
tc
zones
start
Update: In Shorewall 4.4.20, a new LEGACY_FASTSTART option was added to shorewall.conf[1](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[1](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.
stop
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
try
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
The -a option causes the updated shorewall.conf file to be annotated with documentation.
The -b option was added in Shorewall 4.4.26 and causes legacy blacklisting rules (shorewall-blacklist[7] (5) ) to be converted to entries in the blrules file (shorewall-blrules[8] (5) ). The blacklist keyword is removed from shorewall-zones[3] (5), shorewall-interfaces[2] (5) and shorewall-hosts[9] (5). The unmodified files are saved with a .bak suffix.
The -D option was added in Shorewall 4.5.11. When this option is specified, the compiler will walk through the directories in the CONFIG_PATH replacing FORMAT and COMMENT entries to compiler directives (e.g., ?FORMAT and ?COMMENT. When a file is updated, the original is saved in a .bak file in the same directory.
For a description of the other options, see the check command above.
version
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.
/etc/shorewall/
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)