tests/sys/netinet/fibs_test.sh

   1 #
   2 #  Copyright (c) 2014 Spectra Logic Corporation
   3 #  All rights reserved.
   4 #
   5 #  Redistribution and use in source and binary forms, with or without
   6 #  modification, are permitted provided that the following conditions
   7 #  are met:
   8 #  1. Redistributions of source code must retain the above copyright
   9 #     notice, this list of conditions, and the following disclaimer,
  10 #     without modification.
  11 #  2. Redistributions in binary form must reproduce at minimum a disclaimer
  12 #     substantially similar to the "NO WARRANTY" disclaimer below
  13 #     ("Disclaimer") and any redistribution must be conditioned upon
  14 #     including a substantially similar Disclaimer requirement for further
  15 #     binary redistribution.
  16 #
  17 #  NO WARRANTY
  18 #  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 #  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 #  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  21 #  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 #  HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 #  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 #  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 #  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  26 #  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  27 #  IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 #  POSSIBILITY OF SUCH DAMAGES.
  29 #
  30 #  Authors: Alan Somers         (Spectra Logic Corporation)
  31 #
  32 # $FreeBSD$
  33
  34 # All of the tests in this file requires the test-suite config variable "fibs"
  35 # to be defined to a space-delimited list of FIBs that may be used for testing.
  36
  37 # arpresolve should check the interface fib for routes to a target when
  38 # creating an ARP table entry.  This is a regression for kern/167947, where
  39 # arpresolve only checked the default route.
  40 #
  41 # Outline:
  42 # Create two tap(4) interfaces
  43 # Simulate a crossover cable between them by using net/socat
  44 # Use nping (from security/nmap) to send an ICMP echo request from one
  45 # interface to the other, spoofing the source IP.  The source IP must be
  46 # spoofed, or else it will already have an entry in the arp table.
  47 # Check whether an arp entry exists for the spoofed IP
  48 atf_test_case arpresolve_checks_interface_fib cleanup
  49 arpresolve_checks_interface_fib_head()
  50 {
  51         atf_set "descr" "arpresolve should check the interface fib, not the default fib, for routes"
  52         atf_set "require.user" "root"
  53         atf_set "require.config" "fibs"
  54         atf_set "require.progs" "socat nping"
  55 }
  56 arpresolve_checks_interface_fib_body()
  57 {
  58         # Configure the TAP interfaces to use a RFC5737 nonrouteable addresses
  59         # and a non-default fib
  60         ADDR0="192.0.2.2"
  61         ADDR1="192.0.2.3"
  62         SUBNET="192.0.2.0"
  63         # Due to bug TBD (regressed by multiple_fibs_on_same_subnet) we need
  64         # diffferent subnet masks, or FIB1 won't have a subnet route.
  65         MASK0="24"
  66         MASK1="25"
  67         # Spoof a MAC that is reserved per RFC7042
  68         SPOOF_ADDR="192.0.2.4"
  69         SPOOF_MAC="00:00:5E:00:53:00"
  70
  71         # Check system configuration
  72         if [ 0 != `sysctl -n net.add_addr_allfibs` ]; then
  73                 atf_skip "This test requires net.add_addr_allfibs=0"
  74         fi
  75         get_fibs 2
  76
  77         # Configure TAP interfaces
  78         setup_tap "$FIB0" ${ADDR0} ${MASK0}
  79         TAP0=$TAP
  80         setup_tap "$FIB1" ${ADDR1} ${MASK1}
  81         TAP1=$TAP
  82
  83         # Simulate a crossover cable
  84         socat /dev/${TAP0} /dev/${TAP1} &
  85         SOCAT_PID=$!
  86         echo ${SOCAT_PID} >> "processes_to_kill"
  87
  88         # Send an ICMP echo request with a spoofed source IP
  89         setfib 2 nping -c 1 -e ${TAP0} -S ${SPOOF_ADDR} \
  90                 --source-mac ${SPOOF_MAC} --icmp --icmp-type "echo-request" \
  91                 --icmp-code 0 --icmp-id 0xdead --icmp-seq 1 --data 0xbeef \
  92                 ${ADDR1}
  93         # For informational and debugging purposes only, look for the
  94         # characteristic error message
  95         dmesg | grep "llinfo.*${SPOOF_ADDR}"
  96         # Check that the ARP entry exists
  97         atf_check -o match:"${SPOOF_ADDR}.*expires" setfib 3 arp ${SPOOF_ADDR}
  98 }
  99 arpresolve_checks_interface_fib_cleanup()
 100 {
 101         for PID in `cat "processes_to_kill"`; do
 102                 kill $PID
 103         done
 104         cleanup_tap
 105 }
 106
 107
 108 # Regression test for kern/187549
 109 atf_test_case loopback_and_network_routes_on_nondefault_fib cleanup
 110 loopback_and_network_routes_on_nondefault_fib_head()
 111 {
 112         atf_set "descr" "When creating and deleting loopback routes, use the interface's fib"
 113         atf_set "require.user" "root"
 114         atf_set "require.config" "fibs"
 115 }
 116
 117 loopback_and_network_routes_on_nondefault_fib_body()
 118 {
 119         # Configure the TAP interface to use an RFC5737 nonrouteable address
 120         # and a non-default fib
 121         ADDR="192.0.2.2"
 122         SUBNET="192.0.2.0"
 123         MASK="24"
 124
 125         # Check system configuration
 126         if [ 0 != `sysctl -n net.add_addr_allfibs` ]; then
 127                 atf_skip "This test requires net.add_addr_allfibs=0"
 128         fi
 129         get_fibs 1
 130
 131         # Configure a TAP interface
 132         setup_tap ${FIB0} ${ADDR} ${MASK}
 133
 134         # Check whether the host route exists in only the correct FIB
 135         setfib ${FIB0} netstat -rn -f inet | grep -q "^${ADDR}.*UHS.*lo0"
 136         if [ 0 -ne $? ]; then
 137                 setfib ${FIB0} netstat -rn -f inet
 138                 atf_fail "Host route did not appear in the correct FIB"
 139         fi
 140         setfib 0 netstat -rn -f inet | grep -q "^${ADDR}.*UHS.*lo0"
 141         if [ 0 -eq $? ]; then
 142                 setfib 0 netstat -rn -f inet
 143                 atf_fail "Host route appeared in the wrong FIB"
 144         fi
 145
 146         # Check whether the network route exists in only the correct FIB
 147         setfib ${FIB0} netstat -rn -f inet | \
 148                 grep -q "^${SUBNET}/${MASK}.*${TAPD}"
 149         if [ 0 -ne $? ]; then
 150                 setfib ${FIB0} netstat -rn -f inet
 151                 atf_fail "Network route did not appear in the correct FIB"
 152         fi
 153         setfib 0 netstat -rn -f inet | \
 154                 grep -q "^${SUBNET}/${MASK}.*${TAPD}"
 155         if [ 0 -eq $? ]; then
 156                 setfib ${FIB0} netstat -rn -f inet
 157                 atf_fail "Network route appeared in the wrong FIB"
 158         fi
 159 }
 160
 161 loopback_and_network_routes_on_nondefault_fib_cleanup()
 162 {
 163         cleanup_tap
 164 }
 165
 166
 167 # Regression test for kern/187552
 168 atf_test_case default_route_with_multiple_fibs_on_same_subnet cleanup
 169 default_route_with_multiple_fibs_on_same_subnet_head()
 170 {
 171         atf_set "descr" "Multiple interfaces on the same subnet but with different fibs can both have default routes"
 172         atf_set "require.user" "root"
 173         atf_set "require.config" "fibs"
 174 }
 175
 176 default_route_with_multiple_fibs_on_same_subnet_body()
 177 {
 178         # Configure the TAP interfaces to use a RFC5737 nonrouteable addresses
 179         # and a non-default fib
 180         ADDR0="192.0.2.2"
 181         ADDR1="192.0.2.3"
 182         GATEWAY="192.0.2.1"
 183         SUBNET="192.0.2.0"
 184         MASK="24"
 185
 186         # Check system configuration
 187         if [ 0 != `sysctl -n net.add_addr_allfibs` ]; then
 188                 atf_skip "This test requires net.add_addr_allfibs=0"
 189         fi
 190         get_fibs 2
 191
 192         # Configure TAP interfaces
 193         setup_tap "$FIB0" ${ADDR0} ${MASK}
 194         TAP0=$TAP
 195         setup_tap "$FIB1" ${ADDR1} ${MASK}
 196         TAP1=$TAP
 197
 198         # Attempt to add default routes
 199         setfib ${FIB0} route add default ${GATEWAY}
 200         setfib ${FIB1} route add default ${GATEWAY}
 201
 202         # Verify that the default route exists for both fibs, with their
 203         # respective interfaces.
 204         atf_check -o match:"^default.*${TAP0}$" \
 205                 setfib ${FIB0} netstat -rn -f inet
 206         atf_check -o match:"^default.*${TAP1}$" \
 207                 setfib ${FIB1} netstat -rn -f inet
 208 }
 209
 210 default_route_with_multiple_fibs_on_same_subnet_cleanup()
 211 {
 212         cleanup_tap
 213 }
 214
 215
 216 # Regression test for kern/187550
 217 atf_test_case subnet_route_with_multiple_fibs_on_same_subnet cleanup
 218 subnet_route_with_multiple_fibs_on_same_subnet_head()
 219 {
 220         atf_set "descr" "Multiple FIBs can have subnet routes for the same subnet"
 221         atf_set "require.user" "root"
 222         atf_set "require.config" "fibs"
 223 }
 224
 225 subnet_route_with_multiple_fibs_on_same_subnet_body()
 226 {
 227         # Configure the TAP interfaces to use a RFC5737 nonrouteable addresses
 228         # and a non-default fib
 229         ADDR0="192.0.2.2"
 230         ADDR1="192.0.2.3"
 231         SUBNET="192.0.2.0"
 232         MASK="24"
 233
 234         # Check system configuration
 235         if [ 0 != `sysctl -n net.add_addr_allfibs` ]; then
 236                 atf_skip "This test requires net.add_addr_allfibs=0"
 237         fi
 238         get_fibs 2
 239
 240         # Configure TAP interfaces
 241         setup_tap "$FIB0" ${ADDR0} ${MASK}
 242         setup_tap "$FIB1" ${ADDR1} ${MASK}
 243
 244         # Check that a subnet route exists on both fibs
 245         atf_check -o ignore setfib "$FIB0" route get $ADDR1
 246         atf_check -o ignore setfib "$FIB1" route get $ADDR0
 247 }
 248
 249 subnet_route_with_multiple_fibs_on_same_subnet_cleanup()
 250 {
 251         cleanup_tap
 252 }
 253
 254 # Test that source address selection works correctly for UDP packets with
 255 # SO_DONTROUTE set that are sent on non-default FIBs.
 256 # This bug was discovered with "setfib 1 netperf -t UDP_STREAM -H some_host"
 257 # Regression test for kern/187553
 258 #
 259 # The root cause was that ifa_ifwithnet() did not have a fib argument.  It
 260 # would return an address from an interface on any FIB that had a subnet route
 261 # for the destination.  If more than one were available, it would choose the
 262 # most specific.  This is most easily tested by creating a FIB without a
 263 # default route, then trying to send a UDP packet with SO_DONTROUTE set to an
 264 # address which is not routable on that FIB.  Absent the fix for this bug,
 265 # in_pcbladdr would choose an interface on any FIB with a default route.  With
 266 # the fix, you will get EUNREACH or ENETUNREACH.
 267 atf_test_case udp_dontroute cleanup
 268 udp_dontroute_head()
 269 {
 270         atf_set "descr" "Source address selection for UDP packets with SO_DONTROUTE on non-default FIBs works"
 271         atf_set "require.user" "root"
 272         atf_set "require.config" "fibs"
 273 }
 274
 275 udp_dontroute_body()
 276 {
 277         atf_expect_fail "kern/187553 Source address selection for UDP packets with SO_DONTROUTE uses the default FIB"
 278         # Configure the TAP interface to use an RFC5737 nonrouteable address
 279         # and a non-default fib
 280         ADDR0="192.0.2.2"
 281         ADDR1="192.0.2.3"
 282         SUBNET="192.0.2.0"
 283         MASK="24"
 284         # Use a different IP on the same subnet as the target
 285         TARGET="192.0.2.100"
 286         SRCDIR=`atf_get_srcdir`
 287
 288         # Check system configuration
 289         if [ 0 != `sysctl -n net.add_addr_allfibs` ]; then
 290                 atf_skip "This test requires net.add_addr_allfibs=0"
 291         fi
 292         get_fibs 2
 293
 294         # Configure the TAP interfaces
 295         setup_tap ${FIB0} ${ADDR0} ${MASK}
 296         TARGET_TAP=${TAP}
 297         setup_tap ${FIB1} ${ADDR1} ${MASK}
 298
 299         # Send a UDP packet with SO_DONTROUTE.  In the failure case, it will
 300         # return ENETUNREACH, or send the packet to the wrong tap
 301         atf_check -o ignore setfib ${FIB0} \
 302                 ${SRCDIR}/udp_dontroute ${TARGET} /dev/${TARGET_TAP}
 303         cleanup_tap
 304
 305         # Repeat, but this time target the other tap
 306         setup_tap ${FIB0} ${ADDR0} ${MASK}
 307         setup_tap ${FIB1} ${ADDR1} ${MASK}
 308         TARGET_TAP=${TAP}
 309
 310         atf_check -o ignore setfib ${FIB1} \
 311                 ${SRCDIR}/udp_dontroute ${TARGET} /dev/${TARGET_TAP}
 312 }
 313
 314 udp_dontroute_cleanup()
 315 {
 316         cleanup_tap
 317 }
 318
 319
 320 atf_init_test_cases()
 321 {
 322         atf_add_test_case arpresolve_checks_interface_fib
 323         atf_add_test_case loopback_and_network_routes_on_nondefault_fib
 324         atf_add_test_case default_route_with_multiple_fibs_on_same_subnet
 325         atf_add_test_case subnet_route_with_multiple_fibs_on_same_subnet
 326         atf_add_test_case udp_dontroute
 327 }
 328
 329 # Looks up one or more fibs from the configuration data and validates them.
 330 # Returns the results in the env varilables FIB0, FIB1, etc.
 331
 332 # parameter numfibs     The number of fibs to lookup
 333 get_fibs()
 334 {
 335         NUMFIBS=$1
 336         net_fibs=`sysctl -n net.fibs`
 337         i=0
 338         while [ $i -lt "$NUMFIBS" ]; do
 339                 fib=`atf_config_get "fibs" | \
 340                         awk -v i=$(( i + 1 )) '{print $i}'`
 341                 echo "fib is ${fib}"
 342                 eval FIB${i}=${fib}
 343                 if [ "$fib" -ge "$net_fibs" ]; then
 344                         atf_skip "The ${i}th configured fib is ${fib}, which is not less than net.fibs, which is ${net_fibs}"
 345                 fi
 346                 i=$(( $i + 1 ))
 347         done
 348 }
 349
 350 # Creates a new tap(4) interface, registers it for cleanup, and returns the
 351 # name via the environment variable TAP
 352 get_tap()
 353 {
 354         local TAPN=0
 355         while ! ifconfig tap${TAPN} create > /dev/null 2>&1; do
 356                 if [ "$TAPN" -ge 8 ]; then
 357                         atf_skip "Could not create a tap(4) interface"
 358                 else
 359                         TAPN=$(($TAPN + 1))
 360                 fi
 361         done
 362         local TAPD=tap${TAPN}
 363         # Record the TAP device so we can clean it up later
 364         echo ${TAPD} >> "tap_devices_to_cleanup"
 365         TAP=${TAPD}
 366 }
 367
 368 # Create a tap(4) interface, configure it, and register it for cleanup.
 369 # parameters:
 370 # fib
 371 # IP address
 372 # Netmask in number of bits (eg 24 or 8)
 373 # Return: the tap interface name as the env variable TAP
 374 setup_tap()
 375 {
 376         local FIB=$1
 377         local ADDR=$2
 378         local MASK=$3
 379         get_tap
 380         echo setfib ${FIB} ifconfig $TAP ${ADDR}/${MASK} fib $FIB
 381         setfib ${FIB} ifconfig $TAP ${ADDR}/${MASK} fib $FIB
 382 }
 383
 384 cleanup_tap()
 385 {
 386         for TAPD in `cat "tap_devices_to_cleanup"`; do
 387                 ifconfig ${TAPD} destroy
 388         done
 389         rm "tap_devices_to_cleanup"
 390 }