#! /usr/libexec/atf-sh
#
# SPDX-License-Identifier: BSD-2-Clause
#
# Copyright (c) 2017 Kristof Provost <kp@FreeBSD.org>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.

. $(atf_get_srcdir)/utils.subr

common_dir=$(atf_get_srcdir)/../common

atf_test_case "v4" "cleanup"
v4_head()
{
	atf_set descr 'Basic forwarding test'
	atf_set require.user root

	# We need scapy to be installed for out test scripts to work
	atf_set require.progs python3 scapy
}

v4_body()
{
	pft_init

	epair_send=$(vnet_mkepair)
	ifconfig ${epair_send}a 192.0.2.1/24 up

	epair_recv=$(vnet_mkepair)
	ifconfig ${epair_recv}a up

	vnet_mkjail alcatraz ${epair_send}b ${epair_recv}b
	jexec alcatraz ifconfig ${epair_send}b 192.0.2.2/24 up
	jexec alcatraz ifconfig ${epair_recv}b 198.51.100.2/24 up
	jexec alcatraz sysctl net.inet.ip.forwarding=1
	jexec alcatraz arp -s 198.51.100.3 00:01:02:03:04:05
	route add -net 198.51.100.0/24 192.0.2.2

	# Sanity check, can we forward ICMP echo requests without pf?
	atf_check -s exit:0 ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 198.51.100.3 \
		--recvif ${epair_recv}a

	jexec alcatraz pfctl -e

	# Forward with pf enabled
	pft_set_rules alcatraz "block in"
	atf_check -s exit:1 ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 198.51.100.3 \
		--recvif ${epair_recv}a

	pft_set_rules alcatraz "block out"
	atf_check -s exit:1 ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 198.51.100.3 \
		--recv ${epair_recv}a

	# Allow ICMP
	pft_set_rules alcatraz "block in" "pass in proto icmp"
	atf_check -s exit:0 ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 198.51.100.3 \
		--recvif ${epair_recv}a
}

v4_cleanup()
{
	pft_cleanup
}

atf_test_case "v6" "cleanup"
v6_head()
{
	atf_set descr 'Basic IPv6 forwarding test'
	atf_set require.user root
	atf_set require.progs python3 scapy
}

v6_body()
{
	pft_init

	epair_send=$(vnet_mkepair)
	epair_recv=$(vnet_mkepair)

	ifconfig ${epair_send}a inet6 2001:db8:42::1/64 up no_dad -ifdisabled
	ifconfig ${epair_recv}a up

	vnet_mkjail alcatraz ${epair_send}b ${epair_recv}b

	jexec alcatraz ifconfig ${epair_send}b inet6 2001:db8:42::2/64 up no_dad
	jexec alcatraz ifconfig ${epair_recv}b inet6 2001:db8:43::2/64 up no_dad
	jexec alcatraz sysctl net.inet6.ip6.forwarding=1
	jexec alcatraz ndp -s 2001:db8:43::3 00:01:02:03:04:05
	route add -6 2001:db8:43::/64 2001:db8:42::2

	# Sanity check, can we forward ICMP echo requests without pf?
	atf_check -s exit:0 ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 2001:db8:43::3 \
		--recvif ${epair_recv}a

	jexec alcatraz pfctl -e

	# Block incoming echo request packets
	pft_set_rules alcatraz \
		"block in inet6 proto icmp6 icmp6-type echoreq"
	atf_check -s exit:1 ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 2001:db8:43::3 \
		--recvif ${epair_recv}a

	# Block outgoing echo request packets
	pft_set_rules alcatraz \
		"block out inet6 proto icmp6 icmp6-type echoreq"
	atf_check -s exit:1 -e ignore ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 2001:db8:43::3 \
		--recvif ${epair_recv}a

	# Allow ICMPv6 but nothing else
	pft_set_rules alcatraz \
		"block out" \
		"pass out inet6 proto icmp6"
	atf_check -s exit:0 ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 2001:db8:43::3 \
		--recvif ${epair_recv}a

	# Allowing ICMPv4 does not allow ICMPv6
	pft_set_rules alcatraz \
		"block out inet6 proto icmp6 icmp6-type echoreq" \
		"pass in proto icmp"
	atf_check -s exit:1 ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 2001:db8:43::3 \
		--recvif ${epair_recv}a
}

v6_cleanup()
{
	pft_cleanup
}

atf_test_case "v6_hlim" "cleanup"
v6_hlim_head()
{
	atf_set descr 'Test that packets pf blocks get no time exceeded error'
	atf_set require.user root
}

v6_hlim_body()
{
	pft_init

	epair_send=$(vnet_mkepair)
	epair_recv=$(vnet_mkepair)

	ifconfig ${epair_send}a inet6 2001:db8:42::1/64 up no_dad -ifdisabled
	ifconfig ${epair_recv}a up

	vnet_mkjail alcatraz ${epair_send}b ${epair_recv}b

	jexec alcatraz ifconfig ${epair_send}b inet6 2001:db8:42::2/64 up no_dad
	jexec alcatraz ifconfig ${epair_recv}b inet6 2001:db8:43::2/64 up no_dad
	jexec alcatraz sysctl net.inet6.ip6.forwarding=1
	jexec alcatraz ndp -s 2001:db8:43::3 00:01:02:03:04:05
	route add -6 2001:db8:43::/64 2001:db8:42::2

	jexec alcatraz pfctl -e
	pft_set_rules alcatraz \
		"block in inet6 proto icmp6 icmp6-type echoreq"

	for redirect in 0 1; do
		jexec alcatraz sysctl net.inet6.ip6.redirect=${redirect}
		atf_check -s exit:2 -o ignore \
		    ping -6 -c 1 -m 1 -W 1 2001:db8:43::3
		atf_check -o match:"[[:space:]]0 time exceed transit" \
		    jexec alcatraz netstat -s -p icmp6
	done

	pft_set_rules alcatraz "pass"
	atf_check -s exit:2 -o ignore ping -6 -c 1 -m 1 -W 1 2001:db8:43::3
	atf_check -o match:"[[:space:]]1 time exceed transit" \
	    jexec alcatraz netstat -s -p icmp6
}

v6_hlim_cleanup()
{
	pft_cleanup
}

atf_test_case "v6_hlim_decrement" "cleanup"
v6_hlim_decrement_head()
{
	atf_set descr 'Test that forwarded packets leave with the hop limit decremented once'
	atf_set require.user root
	atf_set require.progs python3 scapy
}

v6_hlim_decrement_body()
{
	pft_init

	epair_send=$(vnet_mkepair)
	epair_recv=$(vnet_mkepair)
	epair_route=$(vnet_mkepair)

	ifconfig ${epair_send}a inet6 2001:db8:42::1/64 up no_dad -ifdisabled
	ifconfig ${epair_recv}a up
	ifconfig ${epair_route}a up

	vnet_mkjail alcatraz ${epair_send}b ${epair_recv}b ${epair_route}b

	jexec alcatraz ifconfig ${epair_send}b inet6 2001:db8:42::2/64 up no_dad
	jexec alcatraz ifconfig ${epair_recv}b inet6 2001:db8:43::2/64 up no_dad
	jexec alcatraz ifconfig ${epair_route}b inet6 2001:db8:44::2/64 up no_dad
	jexec alcatraz sysctl net.inet6.ip6.forwarding=1
	jexec alcatraz ndp -s 2001:db8:43::3 00:01:02:03:04:05
	jexec alcatraz ndp -s 2001:db8:44::3 00:01:02:03:04:06
	jexec alcatraz route add -6 2001:db8:666::/64 2001:db8:43::3
	route add -6 2001:db8:43::/64 2001:db8:42::2
	route add -6 2001:db8:666::/64 2001:db8:42::2

	jexec alcatraz pfctl -e

	# Forwarded by the stack, with and without the fast path.
	pft_set_rules alcatraz "pass"
	for redirect in 0 1; do
		jexec alcatraz sysctl net.inet6.ip6.redirect=${redirect}
		atf_check -s exit:0 ${common_dir}/pft_ping.py \
		    --sendif ${epair_send}a \
		    --to 2001:db8:43::3 \
		    --recvif ${epair_recv}a \
		    --send-hlim 5 \
		    --expect-hlim 4
	done

	# Transmitted by pf's outbound pass (route-to), same expectation.
	pft_set_rules alcatraz \
		"pass in" \
		"pass out route-to (${epair_route}b 2001:db8:44::3) inet6 to 2001:db8:666::1"
	for redirect in 0 1; do
		jexec alcatraz sysctl net.inet6.ip6.redirect=${redirect}
		atf_check -s exit:0 ${common_dir}/pft_ping.py \
		    --sendif ${epair_send}a \
		    --to 2001:db8:666::1 \
		    --recvif ${epair_route}a \
		    --send-hlim 5 \
		    --expect-hlim 4
	done
}

v6_hlim_decrement_cleanup()
{
	pft_cleanup
}

atf_test_case "v6_route_to_discards" "cleanup"
v6_route_to_discards_head()
{
	atf_set descr 'Test that packets pf sends on with route-to are not counted as discarded'
	atf_set require.user root
}

v6_route_to_discards_body()
{
	pft_init

	epair_send=$(vnet_mkepair)
	epair_recv=$(vnet_mkepair)
	epair_route=$(vnet_mkepair)

	ifconfig ${epair_send}a inet6 2001:db8:42::1/64 up no_dad -ifdisabled
	ifconfig ${epair_recv}a up
	ifconfig ${epair_route}a up

	vnet_mkjail alcatraz ${epair_send}b ${epair_recv}b ${epair_route}b

	jexec alcatraz ifconfig ${epair_send}b inet6 2001:db8:42::2/64 up no_dad
	jexec alcatraz ifconfig ${epair_recv}b inet6 2001:db8:43::2/64 up no_dad
	jexec alcatraz ifconfig ${epair_route}b inet6 2001:db8:44::2/64 up no_dad
	jexec alcatraz sysctl net.inet6.ip6.forwarding=1
	# ip6_tryforward() only forwards while redirects are off.
	jexec alcatraz sysctl net.inet6.ip6.redirect=0
	jexec alcatraz ndp -s 2001:db8:43::3 00:01:02:03:04:05
	jexec alcatraz ndp -s 2001:db8:44::3 00:01:02:03:04:06
	jexec alcatraz route add -6 2001:db8:666::/64 2001:db8:43::3
	route add -6 2001:db8:666::/64 2001:db8:42::2

	jexec alcatraz pfctl -e

	# pf sends the packet on itself and tells ip6_tryforward() that it
	# consumed it: in the inbound hook for route-to on the inbound pass, in
	# the outbound hook, after the route lookup chose ${epair_recv}b, for
	# route-to on the outbound pass.  Neither is a discard.
	#
	# With state, the outbound pass that pf runs from the inbound hook
	# creates a state of its own and sends the packet; without, the inbound
	# pass does.
	#
	# The host's MLD reports are for a group alcatraz has not joined, and
	# ip6_input() would count them as discarded.  Block them.
	for dir in in out; do
		for state in "keep state" "no state"; do
			pft_set_rules alcatraz \
				"block in quick inet6 to ff02::16" \
				"pass ${state}" \
				"pass ${dir} quick route-to (${epair_route}b 2001:db8:44::3) inet6 to 2001:db8:666::1 ${state}"
			in_discards=$(jexec alcatraz netstat -s -p ip6 -I ${epair_send}b |
			    awk '/input datagrams? discarded/ { print $1 }')
			atf_check -s exit:2 -o ignore ping -6 -c 1 -W 1 2001:db8:666::1
			atf_check -o match:"[[:space:]]${in_discards} input datagrams? discarded" \
			    jexec alcatraz netstat -s -p ip6 -I ${epair_send}b
			atf_check -o match:"[[:space:]]0 total discarded output datagrams" \
			    jexec alcatraz netstat -s -p ip6 -I ${epair_recv}b
		done
	done
}

v6_route_to_discards_cleanup()
{
	pft_cleanup
}

atf_init_test_cases()
{
	atf_add_test_case "v4"
	atf_add_test_case "v6"
	atf_add_test_case "v6_hlim"
	atf_add_test_case "v6_hlim_decrement"
	atf_add_test_case "v6_route_to_discards"
}
