SHOREWALL-LITE(8)

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] clear [-f]

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]

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 [trace|debug [nolock]] [-options] reject address

shorewall-lite [trace|debug [nolock]] [-options] reset

shorewall-lite [trace|debug [nolock]] [-options] restart [-n] [-p] [directory]

shorewall-lite [trace|debug [nolock]] [-options] restore [filename]

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

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 ] [-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 ] [-x] {mangle|nat|routing|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]

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

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

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 /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. Alternately, 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
    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[2](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
    Re-enables receipt of packets from hosts previously blacklisted by a drop, logdrop, reject, or logreject command.

clear
    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, restart or refresh command if that script exists.

delete
    The delete command reverses the effect of an earlier add command.

    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.

disable
    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
    Causes traffic from the listed addresses to be silently dropped.

dump
    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.

enable
    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
    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[1](5) is assumed.

help
    Displays a syntax summary.

hits
    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
    Ipcalc displays the network address, broadcast address, network in CIDR notation and netmask corresponding to the input[s].

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

iptrace
    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.

logdrop
    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[1] (5).

logwatch
    Monitors the log file specified by the LOGFILE option in shorewall.conf[1](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
    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[1] (5).

noiptrace
    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.

reset
    All the packet and byte counters in the firewall are reset.

restart
    Restart 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.

restore
    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[1](5).

save
    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[1](5).

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

    capabilities
        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 -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
        Displays the IP connections currently being tracked by the firewall.

    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[3] (5)).

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

    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.

    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.

    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
    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.

stop
    Stops the firewall. All existing connections, except those listed in shorewall-routestopped[4](5) or permitted by the ADMINISABSENTMINDED option in shorewall.conf[1](5), are taken down. The only new traffic permitted through the firewall is from systems listed in shorewall-routestopped[4](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.

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.  shorewall.conf
    http://www.shorewall.netshorewall.conf.html

2.  shorewall-interfaces
    http://www.shorewall.netshorewall-interfaces.html

3.  shorewall-accounting
    http://www.shorewall.netmanpages/shorewall-accounting.html

4.  shorewall-routestopped
    http://www.shorewall.netshorewall-routestopped.html