3 ### Utility functions for firewall scripts
5 ### (c) 2008 Mark Wooding
8 ###----- Licensing notice ---------------------------------------------------
10 ### This program is free software; you can redistribute it and/or modify
11 ### it under the terms of the GNU General Public License as published by
12 ### the Free Software Foundation; either version 2 of the License, or
13 ### (at your option) any later version.
15 ### This program is distributed in the hope that it will be useful,
16 ### but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ### GNU General Public License for more details.
20 ### You should have received a copy of the GNU General Public License
21 ### along with this program; if not, write to the Free Software Foundation,
22 ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 ###--------------------------------------------------------------------------
26 ### Utility functions.
28 ## doit COMMAND ARGS...
30 ## If debugging, print the COMMAND and ARGS. If serious, execute them.
33 if [ "$FW_DEBUG" ]; then echo "* $*"; fi
34 if ! [ "$FW_NOACT" ]; then "$@"; fi
39 ## If debugging, print the MESSAGE.
42 if [ "$FW_DEBUG" ]; then echo "$*"; fi
45 ## defport NAME NUMBER
47 ## Define $port_NAME to be NUMBER.
50 eval port_$name=$number
53 ## defproto NAME NUMBER
55 ## Define $proto_NAME to be NUMBER.
58 eval proto_$name=$number
63 ## Adds WORD to the value of the shell variable VAR, if it's not there
64 ## already. Words are separated by a single space; no leading or trailing
65 ## spaces are introduced.
71 *) eval "$var=\${$var:+\$val }\$word" ;;
76 ###--------------------------------------------------------------------------
77 ### Utility chains (used by function definitions).
80 ###--------------------------------------------------------------------------
81 ### Basic chain constructions.
83 ## ip46tables ARGS ...
85 ## Do the same thing for `iptables' and `ip6tables'.
92 ## clearchain CHAIN CHAIN ...
94 ## Ensure that the named chains exist and are empty.
99 *:*) table=${chain%:*} chain=${chain#*:} ;;
102 run ip46tables -t $table -N $chain 2>/dev/null || :
106 ## makeset SET TYPE [PARAMS]
108 ## Ensure that the named ipset exists. Don't clear it.
112 if ipset -nL | grep -q "^Name: $name$"; then
115 ipset -N "$name" "$@"
119 ## errorchain CHAIN ACTION ARGS ...
121 ## Make a chain which logs a message and then invokes some other action,
122 ## typically REJECT. Log messages are prefixed by `fw: CHAIN'.
127 *:*) table=${chain%:*} chain=${chain#*:} ;;
130 clearchain $table:$chain
131 run ip46tables -t $table -A $chain -j LOG \
132 -m limit --limit 3/minute --limit-burst 10 \
133 --log-prefix "fw: $chain " --log-level notice
134 run ip46tables -t $table -A $chain -j "$@" \
135 -m limit --limit 20/second --limit-burst 100
136 run ip46tables -t $table -A $chain -j DROP
140 ###--------------------------------------------------------------------------
141 ### Basic option setting.
143 ## setopt OPTION VALUE
150 for ver in ipv4 ipv6; do
151 if [ -f /proc/sys/net/$ver/$opt ]; then
152 run sysctl -q net/$ver/$opt="$val"
157 nil) echo >&2 "$0: unknown IP option $opt"; exit 1 ;;
161 ## setdevopt OPTION VALUE [INTERFACES ...]
163 ## Set an IP interface-level sysctl.
166 opt=$1 val=$2; shift 2
171 for ver in ipv4 ipv6; do
172 cd /proc/sys/net/$ver/conf
174 [ -f $i/$opt ] || continue
175 case "$seen" in (*:$i:*) continue ;; esac
183 for ver in ipv4 ipv6; do
184 if [ -f /proc/sys/net/$ver/conf/$i/$opt ]; then
186 run sysctl -q net/ipv4/conf/$i/$opt="$val"
190 nil) echo >&2 "$0: unknown device option $opt"; exit 1 ;;
196 ###--------------------------------------------------------------------------
197 ### Packet filter construction.
201 ## Add connection tracking to CHAIN, and allow obvious stuff.
205 run ip46tables -A $chain -p tcp -m state \
206 --state ESTABLISHED,RELATED -j ACCEPT
207 run ip46tables -A $chain -p tcp ! --syn -g bad-tcp
212 ## Add standard IP filtering rules to the CHAIN.
217 ## Pass fragments through, assuming that the eventual destination will sort
218 ## things out properly. Except for TCP, that is, which should never be
219 ## fragmented. This is an extra pain for ip6tables, which doesn't provide
220 ## a pleasant way to detect non-initial fragments.
221 run iptables -A $chain -p tcp -f -g tcp-fragment
222 run iptables -A $chain -f -j ACCEPT
223 run ip6tables -A $chain -p tcp -g tcp-fragment \
224 -m ipv6header --soft --header frag
225 run ip6tables -A $chain -j accept-non-init-frag
229 ## Accept a non-initial fragment. This is only needed by IPv6, to work
230 ## around a deficiency in the option parser.
231 run ip6tables -N accept-non-init-frag
232 run ip6tables -A accept-non-init-frag -j RETURN \
234 run ip6tables -A accept-non-init-frag -j ACCEPT
237 ## allowservices CHAIN PROTO SERVICE ...
239 ## Add rules to allow the SERVICES on the CHAIN.
242 chain=$1 proto=$2; shift 2
249 left=${svc%:*} right=${svc#*:}
250 case $left in *[!0-9]*) eval left=\$port_$left ;; esac
251 case $right in *[!0-9]*) eval right=\$port_$right ;; esac
256 case $svc in *[!0-9]*) eval svc=\$port_$svc ;; esac
260 *: | :* | "" | *[!0-9:]*)
261 echo >&2 "Bad service name"
265 count=$(( $count + $n ))
266 if [ $count -gt 15 ]; then
267 run ip46tables -A $chain -p $proto -m multiport -j ACCEPT \
268 --destination-ports ${list#,}
277 run ip46tables -A $chain -p $proto -m multiport -j ACCEPT \
278 --destination-ports ${list#,}
281 run ip46tables -A $chain -p $proto -j ACCEPT \
282 --destination-port ${list#,}
287 ## ntpclient CHAIN NTPSERVER ...
289 ## Add rules to CHAIN to allow NTP with NTPSERVERs.
294 clearchain ntp-servers
295 for ntp; do run iptables -A ntp-servers -j ACCEPT -s $ntp; done
296 run iptables -A $ntpchain -j ntp-servers \
297 -p udp --source-port 123 --destination-port 123
302 ## Add rules to allow CHAIN to be a DNS resolver.
307 run ip46tables -A $chain -j ACCEPT \
308 -m state --state ESTABLISHED \
309 -p $p --source-port 53
313 ## openports CHAIN [MIN MAX]
315 ## Add rules to CHAIN to allow the open ports.
319 [ $# -eq 0 ] && set -- $open_port_min $open_port_max
320 run ip46tables -A $chain -p tcp -g interesting --destination-port $1:$2
321 run ip46tables -A $chain -p udp -g interesting --destination-port $1:$2
325 ###--------------------------------------------------------------------------
326 ### Packet classification.
328 ### See `classify.m4' for an explanation of how the firewall machinery for
329 ### packet classification works.
331 ### A list of all network names is kept in `allnets'. For each network NET,
332 ### shell variables are defined describing their properties.
334 ### net_class_NET The class of the network, as defined by
336 ### net_inet_NET List of IPv4 address ranges in the network.
337 ### net_inet6_NET List of IPv6 address ranges in the network.
338 ### net_fwd_NET List of other networks that this one forwards to.
339 ### net_hosts_NET List of hosts known to be in the network.
340 ### host_inet_HOST IPv4 address of the named HOST.
341 ### host_inet6_HOST IPv6 address of the named HOST.
343 ### Similarly, a list of hosts is kept in `allhosts', and for each host HOST,
344 ### a shell variables are defined:
346 ### host_ifaces_HOST List of interfaces for this host and the networks
347 ### they attach to, in the form IFACE=NET.
349 ## defbitfield NAME WIDTH
351 ## Defines MASK_NAME and BIT_NAME symbolic constants for dealing with
352 ## bitfields: x << BIT_NAME yields the value x in the correct position, and
353 ## ff & MASK_NAME extracts the corresponding value.
357 eval MASK_$name=$(( (1 << $width) - 1 << $bitindex ))
358 eval BIT_$name=$bitindex
359 bitindex=$(( $bitindex + $width ))
362 ## Define the layout of the bitfield.
368 ## defnetclass NAME FORWARD-TO...
370 ## Defines a netclass called NAME, which is allowed to forward to the
371 ## FORWARD-TO netclasses.
373 ## For each netclass, constants from_NAME and to_NAME are defined as the
374 ## appropriate values in the FROM and TO fields (i.e., not including any mask
377 ## This function also establishes mangle chains mark-from-NAME and
378 ## mark-to-NAME for applying the appropriate mark bits to the packet.
380 ## Because it needs to resolve forward references, netclasses must be defined
381 ## in a two-pass manner, using a loop of the form
383 ## for pass in 1 2; do netclassindex=0; ...; done
391 ## Pass 1. Establish the from_NAME and to_NAME constants, and the
392 ## netclass's mask bit.
393 trace "netclass $name = $netclassindex"
394 eval from_$name=$(( $netclassindex << $BIT_FROM ))
395 eval to_$name=$(( $netclassindex << $BIT_TO ))
396 eval fwd_$name=$(( 1 << ($netclassindex + $BIT_MASK) ))
401 ## Pass 2. Compute the actual from and to values. This is fiddly:
402 ## we want to preserve the other flags.
403 from=$(( ($netclassindex << $BIT_FROM) ))
404 frommask=$(( $MASK_FROM | $MASK_MASK ))
407 from=$(( $from + $bit ))
409 to=$(( ($netclassindex << $BIT_TO) ))
410 tomask=$(( $MASK_MASK ^ (1 << ($netclassindex + $BIT_MASK)) ))
411 trace "from $name --> set $(printf %08x/%08x $from $frommask)"
412 trace " to $name --> and $(printf %08x/%08x $to $tomask)"
414 ## Now establish the mark-from-NAME and mark-to-NAME chains.
415 clearchain mangle:mark-from-$name mangle:mark-to-$name
416 run ip46tables -t mangle -A mark-from-$name -j MARK \
417 --set-xmark $from/$frommask
418 run ip46tables -t mangle -A mark-to-$name -j MARK \
419 --set-xmark $to/$tomask
422 netclassindex=$(( $netclassindex + 1 ))
427 ## Define a network. Follow by calls to `addr', `forwards', etc. to define
428 ## properties of the network. Networks are processed in order, so if their
429 ## addresses overlap then the more specific addresses should be defined
434 eval net_class_$1=\$class
437 ## addr ADDRESS/LEN ...
439 ## Define addresses for the network being defined. ADDRESSes are in
440 ## colon-separated IPv6 or dotted-quad IPv4 form.
444 *:*) addword net_inet6_$net $i ;;
445 *) addword net_inet_$net $i ;;
452 ## Declare that packets from this network are forwarded to the other NETs.
454 eval "net_fwd_$net=\"$*\""
459 ## Declare that packets from this network must not be forwarded to the other
462 eval "net_noxit_$net=\"$*\""
465 ## host HOST ADDR ...
467 ## Define the address of an individual host on the current network. The
468 ## ADDRs may be full IPv4 or IPv6 addresses, or offsets from the containing
469 ## network address, which is a simple number for IPv4, or a suffix beginning
470 ## with `::' for IPv6. If an IPv6 base address is provided for the network
471 ## but not for the host then the host's IPv4 address is used as a suffix.
475 ## Work out which addresses we've actually been given.
478 case "$i" in ::*) a6=$i ;; *) a=$i ;; esac
482 *) echo >&2 "$0: no address for $name"; exit 1 ;;
484 case "${a6+t}" in t) ;; *) a6=::$a ;; esac
486 ## Work out the IPv4 address.
487 eval nn=\$net_inet_$net
492 case $a in *.*) aa=$a ;; *) aa=$base.$(( $offset + $a )) ;; esac
493 eval host_inet_$name=$aa
496 ## Work out the IPv6 address.
497 eval nn=\$net_inet6_$net
501 case $a6 in ::*) aa=$base$a6 ;; *) aa=$a6 ;; esac
502 eval host_inet6_$name=$aa
505 ## Remember the host in the list.
506 addword net_hosts_$net $name
511 ## Define a new host. Follow by calls to `iface' to define the host's
515 addword allhosts $host
516 eval host_type_$host=endsys
521 ## Declare the host to be a router, so it should forward packets and so on.
523 eval host_type_$host=router
526 ## iface IFACE NET ...
528 ## Define a host's interfaces. Specifically, declares that the host has an
529 ## interface IFACE attached to the listed NETs.
533 addword host_ifaces_$host $name=$net
537 ## Build rules which match a particular collection of networks.
538 ## Specifically, use the address-comparison operator OPT (typically `-s' or
539 ## `-d') to match the addresses of NOT, writing the rules to the chain
540 ## BASESUFFIX. If we find a match, dispatch to WIN-CLASS, where CLASS is
541 ## the class of the matching network. In order to deal with networks
542 ## containing negative address ranges, more chains may need to be
543 ## constructed; they will be named BASE#Q for sequence numbers Q starting
544 ## with NEXT. All of this happens on the `mangle' table, and there isn't
545 ## (currently) a way to tweak this.
547 ## The FLAGS gather additional interesting information about the job,
548 ## separated by colons. The only flag currently is :default: which means
549 ## that the default network was listed.
551 ## Finally, there is a hook PREPARE which is called just in advance of
552 ## processing the final network, passing it the argument FLAGS. (The PREPARE
553 ## string will be subjected to shell word-splitting, so it can provide some
554 ## arguments of its own if it wants.) It should set `mode' to indicate how
555 ## the chain should be finished.
557 ## goto If no networks matched, then issue a final `goto' to the
558 ## chain named by the variable `fail'.
560 ## call Run `$finish CHAIN' to write final rules to the named CHAIN
561 ## (which may be suffixed from the original BASE argument if
562 ## this was necessary). This function will arrange to call
563 ## these rules if no networks match.
565 ## ret If no network matches then return (maybe by falling off the
566 ## end of the chain).
568 local opt win flags prepare base suffix next net lose splitp
569 opt=$1 win=$2 flags=$3 prepare=$4 base=$5 suffix=$6 next=$7 net=$8
572 ## If this is the default network, then set the flag.
573 case "$net" in default) flags=${flags}default: ;; esac
575 ## Do an initial pass over the addresses to see whether there are any
576 ## negative ranges. If so, we'll need to split. See also the standard
579 eval "addrs=\"\$net_inet_$net \$net_inet6_$net\""
580 for a in $addrs; do case $a in !*) splitp=t; break ;; esac; done
582 trace "MATCHNETS [splitp $splitp] $opt $win $flags [$prepare] $base $suffix $next : $net $*"
584 ## Work out how to handle matches against negative address ranges. If this
585 ## is the last network, invoke the PREPARE hook to find out. Otherwise, if
586 ## we have to split the chain, recursively build the target here.
590 case $splitp,$mode in
598 clearchain mangle:$base#$next
599 lose="-g $base#$next"
606 clearchain mangle:$base#$next
607 matchnets $opt $win $flags "$prepare" \
608 $base \#$next $(( $next + 1 )) "$@"
609 lose="-g $base#$next" mode=goto
616 ## Populate the chain with rules to match the necessary networks.
617 eval addr=\$net_inet_$net addr6=\$net_inet6_$net class=\$net_class_$net
620 !*) run iptables -t mangle -A $base$suffix $lose $opt ${a#!} ;;
621 *) run iptables -t mangle -A $base$suffix -g $win-$class $opt $a ;;
626 !*) run ip6tables -t mangle -A $base$suffix $lose $opt ${a#!} ;;
627 *) run ip6tables -t mangle -A $base$suffix -g $win-$class $opt $a ;;
631 ## Wrap up the chain appropriately. If we didn't split and there are more
632 ## networks to handle then append the necessary rules now. (If we did
633 ## split, then we already wrote the rules for them above.) If there are no
634 ## more networks then consult the `mode' setting to find out what to do.
635 case $splitp,$#,$mode in
637 *,*,goto) run ip46tables -t mangle -A $base$suffix $lose ;;
638 t,0,call) $finish $base#$next ;;
639 nil,0,call) $finish $base$suffix ;;
641 matchnets $opt $win $flags "$prepare" $base "$suffix" $next "$@"
646 ## net_interfaces HOST NET
648 ## Determine the interfaces on which packets may plausibly arrive from the
649 ## named NET. Returns `-' if no such interface exists.
651 ## This algorithm is not very clever. It's just about barely good enough to
652 ## deduce transitivity through a simple routed network; with complicated
653 ## networks, it will undoubtedly give wrong answers. Check the results
654 ## carefully, and, if necessary, list the connectivity explicitly; use the
655 ## special interface `-' for networks you know shouldn't send packets to a
660 ## Determine the locally attached networks.
662 eval ii=\$host_ifaces_$host
663 for i in $ii; do targets=$targets$i:; done
665 ## Determine the transitivity.
670 ## First pass. Determine whether any of the networks we're considering
671 ## are in the target set. If they are, then return the corresponding
680 n=${tg%=$net:*}; tg=${n%:*}:; n=${n##*:}
685 case $any in nil) break ;; esac
688 case "$found" in ?*) echo $found; return ;; esac
690 ## No joy. Determine the set of networks which (a) these ones can
691 ## forward to, and (b) that we've not considered already. These are the
692 ## nets we'll consider next time around.
696 eval fwd=\$net_fwd_$net
698 case $seen in *":$n:"*) continue ;; esac
700 eval noxit=\$net_noxit_$n
701 case " $noxit " in *" $startnet "*) continue ;; esac
702 case " $nextnets " in
704 *) addword nextnets $n; any=t ;;
709 ## If we've run out of networks then there's no reachability. Return a
711 case $any in nil) echo -; return ;; esac
717 ###----- That's all, folks --------------------------------------------------