table of contents
SHOREWALL6-LITE(8) | Administrative Commands | SHOREWALL6-LITE(8) |
NAME¶
shorewall6-lite - Administration tool for Shoreline 6 Firewall Lite (Shorewall6 Lite)SYNOPSIS¶
shorewall6-lite [trace|debug [nolock]] [-options] add interface[:host-list]... zone
shorewall6-lite [trace|debug [nolock]] [-options] allow address
shorewall6-lite [trace|debug [nolock]] [-options] blacklist address
shorewall6-lite [trace|debug [nolock]] [-options] call function [parameter ...]
shorewall6-lite [trace|debug [nolock]] [-options] clear [-f]
shorewall6-lite [trace|debug [nolock]] [-options] close { open-number | sourcedest [protocol [ port ]]}
shorewall6-lite [trace|debug [nolock]] [-options] close source dest [ protocol [ port ] ]
shorewall6-lite [trace|debug [nolock]] [-options] delete interface[:host-list]... zone
shorewall6-lite [trace|debug [nolock]] [-options] disable { interface | provider }
shorewall6-lite [trace|debug [nolock]] [-options] drop address
shorewall6-lite [trace|debug] [-options] dump [-x] [-l] [-m] [-c]
shorewall6-lite [trace|debug [nolock]] [-options] enable { interface | provider }
shorewall6-lite [trace|debug [nolock]] [-options] forget [filename]
shorewall6-lite [trace|debug] [-options] help
shorewall6-lite [trace|debug] [-options] hits [-t]
shorewall6-lite [trace|debug] [-options] iptrace iptables match expression
shorewall6-lite [trace|debug [nolock]] [-options] logdrop address
shorewall6-lite [trace|debug] [-options] logwatch [-m] [refresh-interval]
shorewall6-lite [trace|debug [nolock]] [-options] logreject address
shorewall6-lite [trace|debug] [-options] noiptrace iptables match expression
shorewall6-lite [trace|debug [nolock]] [-options] open source dest [ protocol [ port ] ]
shorewall6-lite [trace|debug [nolock]] [-options] reenable { interface | provider }
shorewall6-lite [trace|debug [nolock]] [-options] reject address
shorewall6-lite [trace|debug [nolock]] [-options] reset
shorewall6-lite [trace|debug [nolock]] [-options] restart [-n] [-p] [-C]
shorewall6-lite [trace|debug [nolock]] [-options] restore [-C] [filename]
shorewall6-lite [trace|debug [nolock]] [-options] run command [parameter ...]
shorewall6-lite [trace|debug [nolock]] [-options] save [-C] [filename]
shorewall6-lite [trace|debug [nolock]] [-options] savesets
shorewall6-lite [trace|debug] [-options] {show | list | ls } [-b] [-x] [-l] [-t {filter|mangle|nat|raw|rawpost}] [[chain] chain...]
shorewall6-lite [trace|debug] [-options] {show | list | ls } [-f] capabilities
shorewall6-lite [trace|debug] [-options] {show | list | ls } [-x] {bl|blacklists}
shorewall6-lite [trace|debug] [-options] {show | list | ls } {classifiers|connections|config|events|filters|ip|ipa|zones|policies|marks}
shorewall6-lite [trace|debug] [-options] {show | list | ls } event event
shorewall6-lite [trace|debug] [-options] {show | list | ls } [-c] routing
shorewall6-lite [trace|debug] [-options] {show | list | ls } [-x] {mangle|nat|raw|rawpost}
shorewall6-lite [trace|debug] [-options] {show | list | ls } tc
shorewall6-lite [trace|debug] [-options] {show | list | ls } [-m] log
shorewall6-lite [trace|debug [nolock]] [-options] start [-n] [-p] [-f] [-C]
shorewall6-lite [trace|debug [nolock]] [-options] stop
shorewall6-lite [trace|debug] [-options] status [-i]
shorewall6-lite [trace|debug] [-options] version [-a]
DESCRIPTION¶
The shorewall6-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 shorewall6-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 shorewall6.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 }
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 shorewall6-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
blacklist address [ option ... ]
If the disconnect option is specified in the DYNAMIC_BLACKLISTING setting, then the effective VERBOSITY determines the amount of information displayed:
call function [ parameter ... ]
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]
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 ] ] }
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 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 }
drop address
dump [-x] [-l] [-m] [-c]
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 shorewall6-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 }
forget [ filename ]
help
hits
iptrace ip6tables match expression
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, ...) -- shorewall6-lite has no control over where the messages go; consult your logging daemon's documentation.
list
logdrop address
logwatch [-m] [refresh-interval]
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., shorewall6-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
ls
noiptrace ip6tables match expression
The ip6tables match expression must be one given in the iptrace command being canceled.
open source dest [ protocol [ port ] ]
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 2001:470:b:227::1, the command would be:
shorewall6-lite open all 2001:470:b:227::1 tcp 22
To reverse that command, use:
shorewall6-lite close all 2001:470:b:227::1 tcp 22
reenable{ interface | provider }
reject address
reload [-n] [-p] [-C]
The -n option causes shorewall6-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, ...]
restart [-n] [-p] [-C]
The -n option causes shorewall6-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 ]
Caution
If your ip6tables 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.
run command [ parameter ... ]
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 -C option, added in Shorewall 4.6.5, causes the ip6tables packet and byte counters to be saved along with the chains and rules.
savesets
show
[-x] bl|blacklists
[-f] capabilities
[-b] [-x] [-l] [-t {filter|mangle|nat|raw|rawpost}][ chain... ]
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
config
connections [filter_parameter ...]
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
events
ip
ipa
[-m] log
The -m option causes the MAC address of each packet source to be displayed if that information is available.
[-x] mangle
marks
opens
[-x] nat
policies
[-x] raw
[-c] routing
tc
zones
start [-p] [-n] [-f] [-C]
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 [-f]
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
The -i option was added in Shorewall 4.6.2 and causes the status of each optional or provider interface to be displayed.
version [-a]
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 Shorewall6-lite:SHOREWALL_INIT_SCRIPT
SW_LOGGERTAG
SEE ALSO¶
http://www.shorewall.net/starting_and_stopping_shorewall.htmshorewall6-accounting(5), shorewall6-actions(5), shorewall6-blacklist(5), shorewall6-hosts(5), shorewall_interfaces(5), shorewall6-ipsets(5), shorewall6-maclist(5), shorewall6-masq(5), shorewall6-netmap(5), shorewall6-params(5), shorewall6-policy(5), shorewall6-providers(5), shorewall6-proxyarp(5), shorewall6-rtrules(5), shorewall6-routestopped(5), shorewall6-rules(5), shorewall6.conf(5), shorewall6-secmarks(5), shorewall6-tcclasses(5), shorewall6-tcdevices(5), shorewall6-tcrules(5), shorewall6-tos(5), shorewall6-tunnels(5), shorewall6-zones(5)
NOTES¶
- 1.
- extension script
- 2.
- shorewall6.conf
- 3.
- shorewall-interfaces
- 4.
- shorewall6.conf
- 5.
- shorewall-accounting
- 6.
- shorewall-routestopped
03/16/2017 | Administrative Commands |