#
# SPDX-License-Identifier: BSD-2-Clause
#
# Copyright (c) 2023 Igor Ostapenko <pm@igoro.pro>
#
# 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.

#
# pf divert-to action test cases
#
#  -----------|           |--     |----|     ----|            |-----------
# ( ) inbound |pf_check_in|  ) -> |host| -> ( )  |pf_check_out| outbound  )
#  -----------|     |     |--     |----|     ----|     |      |-----------
#                   |                                  |
#                  \|/                                \|/
#                |------|                           |------|
#                |divapp|                           |divapp|
#                |------|                           |------|
#
# The basic cases:
#   - inbound > diverted               | divapp terminated
#   - inbound > diverted > inbound     | host terminated
#   - inbound > diverted > outbound    | network terminated
#   - outbound > diverted              | divapp terminated
#   - outbound > diverted > outbound   | network terminated
#   - outbound > diverted > inbound    | e.g. host terminated
#
# When a packet is diverted, forwarded, and possibly diverted again:
#   - inbound > diverted > inbound > forwarded
#         > outbound                       | network terminated
#   - inbound > diverted > inbound > forwarded
#         > outbound > diverted > outbound | network terminated
#
# Test case naming legend:
# ipfwon - with ipfw enabled
# ipfwoff - with ipfw disabled
# in - inbound
# div - diverted
# out - outbound
# fwd - forwarded
# dn - delayed by dummynet
#

. $(atf_get_srcdir)/utils.subr

divert_init()
{
	if ! kldstat -q -m ipdivert; then
		atf_skip "This test requires ipdivert"
	fi
}

dummynet_init()
{
	if ! kldstat -q -m dummynet; then
		atf_skip "This test requires dummynet"
	fi
}

ipfw_init()
{
	if ! kldstat -q -m ipfw; then
		atf_skip "This test requires ipfw"
	fi
}

assert_ipfw_is_off()
{
	if kldstat -q -m ipfw; then
		atf_skip "This test is for the case when ipfw is not loaded"
	fi
}

atf_test_case "ipfwoff_in_div" "cleanup"
ipfwoff_in_div_head()
{
	atf_set descr 'Test inbound > diverted | divapp terminated'
	atf_set require.user root
}
ipfwoff_in_div_body()
{
	local ipfwon

	pft_init
	divert_init
	test "$1" == "ipfwon" && ipfwon="yes"
	test $ipfwon && ipfw_init || assert_ipfw_is_off

	epair=$(vnet_mkepair)
	vnet_mkjail div ${epair}b
	ifconfig ${epair}a 192.0.2.1/24 up
	jexec div ifconfig ${epair}b 192.0.2.2/24 up
	test $ipfwon && jexec div ipfw add 65534 allow all from any to any

	# Sanity check
	atf_check -s exit:0 -o ignore ping -c3 192.0.2.2

	jexec div pfctl -e
	pft_set_rules div \
		"pass all" \
		"pass in inet proto icmp icmp-type echoreq divert-to 127.0.0.1 port 2000"

	jexec div $(atf_get_srcdir)/divapp 2000 &
	divapp_pid=$!
	# Wait for the divapp to be ready
	sleep 1

	# divapp is expected to "eat" the packet
	atf_check -s not-exit:0 -o ignore ping -c1 192.0.2.2

	wait $divapp_pid
}
ipfwoff_in_div_cleanup()
{
	pft_cleanup
}

atf_test_case "ipfwon_in_div" "cleanup"
ipfwon_in_div_head()
{
	atf_set descr 'Test inbound > diverted | divapp terminated, with ipfw enabled'
	atf_set require.user root
}
ipfwon_in_div_body()
{
	ipfwoff_in_div_body "ipfwon"
}
ipfwon_in_div_cleanup()
{
	pft_cleanup
}

atf_test_case "ipfwoff_in_div_in" "cleanup"
ipfwoff_in_div_in_head()
{
	atf_set descr 'Test inbound > diverted > inbound | host terminated'
	atf_set require.user root
}
ipfwoff_in_div_in_body()
{
	local ipfwon

	pft_init
	divert_init
	test "$1" == "ipfwon" && ipfwon="yes"
	test $ipfwon && ipfw_init || assert_ipfw_is_off

	epair=$(vnet_mkepair)
	vnet_mkjail div ${epair}b
	ifconfig ${epair}a 192.0.2.1/24 up
	jexec div ifconfig ${epair}b 192.0.2.2/24 up
	test $ipfwon && jexec div ipfw add 65534 allow all from any to any

	# Sanity check
	atf_check -s exit:0 -o ignore ping -c3 192.0.2.2

	jexec div pfctl -e
	pft_set_rules div \
		"pass all" \
		"pass in inet proto icmp icmp-type echoreq divert-to 127.0.0.1 port 2000 no state"

	jexec div $(atf_get_srcdir)/divapp 2000 divert-back &
	divapp_pid=$!
	# Wait for the divapp to be ready
	sleep 1

	# divapp is NOT expected to "eat" the packet
	atf_check -s exit:0 -o ignore ping -c1 192.0.2.2

	wait $divapp_pid
}
ipfwoff_in_div_in_cleanup()
{
	pft_cleanup
}

atf_test_case "ipfwon_in_div_in" "cleanup"
ipfwon_in_div_in_head()
{
	atf_set descr 'Test inbound > diverted > inbound | host terminated, with ipfw enabled'
	atf_set require.user root
}
ipfwon_in_div_in_body()
{
	ipfwoff_in_div_in_body "ipfwon"
}
ipfwon_in_div_in_cleanup()
{
	pft_cleanup
}

atf_test_case "ipfwoff_out_div" "cleanup"
ipfwoff_out_div_head()
{
	atf_set descr 'Test outbound > diverted | divapp terminated'
	atf_set require.user root
}
ipfwoff_out_div_body()
{
	local ipfwon

	pft_init
	divert_init
	test "$1" == "ipfwon" && ipfwon="yes"
	test $ipfwon && ipfw_init || assert_ipfw_is_off

	epair=$(vnet_mkepair)
	vnet_mkjail div ${epair}b
	ifconfig ${epair}a 192.0.2.1/24 up
	jexec div ifconfig ${epair}b 192.0.2.2/24 up
	test $ipfwon && jexec div ipfw add 65534 allow all from any to any

	# Sanity check
	atf_check -s exit:0 -o ignore ping -c3 192.0.2.2

	jexec div pfctl -e
	pft_set_rules div \
		"pass all" \
		"pass in inet proto icmp icmp-type echoreq no state" \
		"pass out inet proto icmp icmp-type echorep divert-to 127.0.0.1 port 2000 no state"

	jexec div $(atf_get_srcdir)/divapp 2000 &
	divapp_pid=$!
	# Wait for the divapp to be ready
	sleep 1

	# divapp is expected to "eat" the packet
	atf_check -s not-exit:0 -o ignore ping -c1 192.0.2.2

	wait $divapp_pid
}
ipfwoff_out_div_cleanup()
{
	pft_cleanup
}

atf_test_case "ipfwon_out_div" "cleanup"
ipfwon_out_div_head()
{
	atf_set descr 'Test outbound > diverted | divapp terminated, with ipfw enabled'
	atf_set require.user root
}
ipfwon_out_div_body()
{
	ipfwoff_out_div_body "ipfwon"
}
ipfwon_out_div_cleanup()
{
	pft_cleanup
}

atf_test_case "ipfwoff_out_div_out" "cleanup"
ipfwoff_out_div_out_head()
{
	atf_set descr 'Test outbound > diverted > outbound | network terminated'
	atf_set require.user root
}
ipfwoff_out_div_out_body()
{
	local ipfwon

	pft_init
	divert_init
	test "$1" == "ipfwon" && ipfwon="yes"
	test $ipfwon && ipfw_init || assert_ipfw_is_off

	epair=$(vnet_mkepair)
	vnet_mkjail div ${epair}b
	ifconfig ${epair}a 192.0.2.1/24 up
	jexec div ifconfig ${epair}b 192.0.2.2/24 up
	test $ipfwon && jexec div ipfw add 65534 allow all from any to any

	# Sanity check
	atf_check -s exit:0 -o ignore ping -c3 192.0.2.2

	jexec div pfctl -e
	pft_set_rules div \
		"pass all" \
		"pass in inet proto icmp icmp-type echoreq no state" \
		"pass out inet proto icmp icmp-type echorep divert-to 127.0.0.1 port 2000 no state"

	jexec div $(atf_get_srcdir)/divapp 2000 divert-back &
	divapp_pid=$!
	# Wait for the divapp to be ready
	sleep 1

	# divapp is NOT expected to "eat" the packet
	atf_check -s exit:0 -o ignore ping -c1 192.0.2.2

	wait $divapp_pid
}
ipfwoff_out_div_out_cleanup()
{
	pft_cleanup
}

atf_test_case "ipfwon_out_div_out" "cleanup"
ipfwon_out_div_out_head()
{
	atf_set descr 'Test outbound > diverted > outbound | network terminated, with ipfw enabled'
	atf_set require.user root
}
ipfwon_out_div_out_body()
{
	ipfwoff_out_div_out_body "ipfwon"
}
ipfwon_out_div_out_cleanup()
{
	pft_cleanup
}

atf_test_case "ipfwoff_in_div_in_fwd_out_div_out" "cleanup"
ipfwoff_in_div_in_fwd_out_div_out_head()
{
	atf_set descr 'Test inbound > diverted > inbound > forwarded > outbound > diverted > outbound | network terminated'
	atf_set require.user root
}
ipfwoff_in_div_in_fwd_out_div_out_body()
{
	local ipfwon

	pft_init
	divert_init
	test "$1" == "ipfwon" && ipfwon="yes"
	test $ipfwon && ipfw_init || assert_ipfw_is_off

	# host <a--epair0--b> router <a--epair1--b> site
	epair0=$(vnet_mkepair)
	epair1=$(vnet_mkepair)

	vnet_mkjail router ${epair0}b ${epair1}a
	ifconfig ${epair0}a 192.0.2.1/24 up
	jexec router sysctl net.inet.ip.forwarding=1
	jexec router ifconfig ${epair0}b 192.0.2.2/24 up
	jexec router ifconfig ${epair1}a 198.51.100.1/24 up
	test $ipfwon && jexec router ipfw add 65534 allow all from any to any

	vnet_mkjail site ${epair1}b
	jexec site ifconfig ${epair1}b 198.51.100.2/24 up
	jexec site route add default 198.51.100.1
	test $ipfwon && jexec site ipfw add 65534 allow all from any to any

	route add -net 198.51.100.0/24 192.0.2.2

	# Sanity check
	atf_check -s exit:0 -o ignore ping -c3 192.0.2.2

	# Should be routed without pf
	atf_check -s exit:0 -o ignore ping -c3 198.51.100.2

	jexec router pfctl -e
	pft_set_rules router \
		"pass all" \
		"pass in inet proto icmp icmp-type echoreq divert-to 127.0.0.1 port 2001 no state" \
		"pass out inet proto icmp icmp-type echoreq divert-to 127.0.0.1 port 2002 no state"

	jexec router $(atf_get_srcdir)/divapp 2001 divert-back &
	indivapp_pid=$!
	jexec router $(atf_get_srcdir)/divapp 2002 divert-back &
	outdivapp_pid=$!
	# Wait for the divappS to be ready
	sleep 1

	# Both divappS are NOT expected to "eat" the packet
	atf_check -s exit:0 -o ignore ping -c1 198.51.100.2

	wait $indivapp_pid && wait $outdivapp_pid
}
ipfwoff_in_div_in_fwd_out_div_out_cleanup()
{
	pft_cleanup
}

atf_test_case "ipfwon_in_div_in_fwd_out_div_out" "cleanup"
ipfwon_in_div_in_fwd_out_div_out_head()
{
	atf_set descr 'Test inbound > diverted > inbound > forwarded > outbound > diverted > outbound | network terminated, with ipfw enabled'
	atf_set require.user root
}
ipfwon_in_div_in_fwd_out_div_out_body()
{
	ipfwoff_in_div_in_fwd_out_div_out_body "ipfwon"
}
ipfwon_in_div_in_fwd_out_div_out_cleanup()
{
	pft_cleanup
}

atf_test_case "ipfwoff_in_dn_in_div_in_out_dn_out_div_out" "cleanup"
ipfwoff_in_dn_in_div_in_out_dn_out_div_out_head()
{
	atf_set descr 'Test inbound > delayed+diverted > outbound > delayed+diverted > outbound | network terminated'
	atf_set require.user root
}
ipfwoff_in_dn_in_div_in_out_dn_out_div_out_body()
{
	local ipfwon

	pft_init
	divert_init
	dummynet_init
	test "$1" == "ipfwon" && ipfwon="yes"
	test $ipfwon && ipfw_init || assert_ipfw_is_off

	epair=$(vnet_mkepair)
	vnet_mkjail alcatraz ${epair}b
	ifconfig ${epair}a 192.0.2.1/24 up
	ifconfig ${epair}a ether 02:00:00:00:00:01
	jexec alcatraz ifconfig ${epair}b 192.0.2.2/24 up
	test $ipfwon && jexec alcatraz ipfw add 65534 allow all from any to any

	# Sanity check
	atf_check -s exit:0 -o ignore ping -c3 192.0.2.2

	# a) ping should time out due to very narrow dummynet pipes {

	jexec alcatraz dnctl pipe 1001 config bw 1Byte/s
	jexec alcatraz dnctl pipe 1002 config bw 1Byte/s

	jexec alcatraz pfctl -e
	pft_set_rules alcatraz \
		"ether pass in from 02:00:00:00:00:01 l3 all dnpipe 1001" \
		"ether pass out to 02:00:00:00:00:01 l3 all dnpipe 1002 " \
		"pass all" \
		"pass in inet proto icmp icmp-type echoreq divert-to 127.0.0.1 port 1001 no state" \
		"pass out inet proto icmp icmp-type echorep divert-to 127.0.0.1 port 1002 no state"

	jexec alcatraz $(atf_get_srcdir)/divapp 1001 divert-back &
	indivapp_pid=$!
	jexec alcatraz $(atf_get_srcdir)/divapp 1002 divert-back &
	outdivapp_pid=$!
	# Wait for the divappS to be ready
	sleep 1

	atf_check -s not-exit:0 -o ignore ping -c1 -s56 -t1 192.0.2.2

	wait $indivapp_pid
	atf_check_not_equal 0 $?
	wait $outdivapp_pid
	atf_check_not_equal 0 $?

	# }

	# b) ping should NOT time out due to wide enough dummynet pipes {

	jexec alcatraz dnctl pipe 2001 config bw 100KByte/s
	jexec alcatraz dnctl pipe 2002 config bw 100KByte/s

	jexec alcatraz pfctl -e
	pft_set_rules alcatraz \
		"ether pass in from 02:00:00:00:00:01 l3 all dnpipe 2001" \
		"ether pass out to 02:00:00:00:00:01 l3 all dnpipe 2002 " \
		"pass all" \
		"pass in inet proto icmp icmp-type echoreq divert-to 127.0.0.1 port 2001 no state" \
		"pass out inet proto icmp icmp-type echorep divert-to 127.0.0.1 port 2002 no state"

	jexec alcatraz $(atf_get_srcdir)/divapp 2001 divert-back &
	indivapp_pid=$!
	jexec alcatraz $(atf_get_srcdir)/divapp 2002 divert-back &
	outdivapp_pid=$!
	# Wait for the divappS to be ready
	sleep 1

	atf_check -s exit:0 -o ignore ping -c1 -s56 -t1 192.0.2.2

	wait $indivapp_pid
	atf_check_equal 0 $?
	wait $outdivapp_pid
	atf_check_equal 0 $?

	# }
}
ipfwoff_in_dn_in_div_in_out_dn_out_div_out_cleanup()
{
	pft_cleanup
}

atf_test_case "ipfwon_in_dn_in_div_in_out_dn_out_div_out" "cleanup"
ipfwon_in_dn_in_div_in_out_dn_out_div_out_head()
{
	atf_set descr 'Test inbound > delayed+diverted > outbound > delayed+diverted > outbound | network terminated, with ipfw enabled'
	atf_set require.user root
}
ipfwon_in_dn_in_div_in_out_dn_out_div_out_body()
{
	ipfwoff_in_dn_in_div_in_out_dn_out_div_out_body "ipfwon"
}
ipfwon_in_dn_in_div_in_out_dn_out_div_out_cleanup()
{
	pft_cleanup
}

atf_init_test_cases()
{
	atf_add_test_case "ipfwoff_in_div"
	atf_add_test_case "ipfwoff_in_div_in"
	atf_add_test_case "ipfwon_in_div"
	atf_add_test_case "ipfwon_in_div_in"

	atf_add_test_case "ipfwoff_out_div"
	atf_add_test_case "ipfwoff_out_div_out"
	atf_add_test_case "ipfwon_out_div"
	atf_add_test_case "ipfwon_out_div_out"

	atf_add_test_case "ipfwoff_in_div_in_fwd_out_div_out"
	atf_add_test_case "ipfwon_in_div_in_fwd_out_div_out"

	atf_add_test_case "ipfwoff_in_dn_in_div_in_out_dn_out_div_out"
	atf_add_test_case "ipfwon_in_dn_in_div_in_out_dn_out_div_out"
}