#
# SPDX-License-Identifier: BSD-2-Clause
#
# Copyright (c) 2017 Kristof Provost <kp@FreeBSD.org>
#
# Copyright (c) 2021 Samuel Robinette
#
# 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 'set-tos 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

	jexec alcatraz pfctl -e

	# No change is done if not requested
	pft_set_rules alcatraz "scrub out proto icmp"
	atf_check -s exit:1 -o ignore ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 198.51.100.3 \
		--recvif ${epair_recv}a \
		--expect-tc 42

	# The requested ToS is set
	pft_set_rules alcatraz "scrub out proto icmp set-tos 42"
	atf_check -s exit:0 ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 198.51.100.3 \
		--recvif ${epair_recv}a \
		--expect-tc 42

	# ToS is not changed if the scrub rule does not match
	pft_set_rules alcatraz "scrub out proto tcp set-tos 42"
	atf_check -s exit:1 -o ignore ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 198.51.100.3 \
		--recvif ${epair_recv}a \
		--expect-tc 42

	# Multiple scrub rules match as expected
	pft_set_rules alcatraz "scrub out proto tcp set-tos 13" \
		"scrub out proto icmp set-tos 14"
	atf_check -s exit:0 ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 198.51.100.3 \
		--recvif ${epair_recv}a \
		--expect-tc 14

	# And this works even if the packet already has ToS values set
	atf_check -s exit:0 ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 198.51.100.3 \
		--recvif ${epair_recv}a \
		--send-tc 42 \
		--expect-tc 14

	# ToS values are unmolested if the packets do not match a scrub rule
	pft_set_rules alcatraz "scrub out proto tcp set-tos 13"
	atf_check -s exit:0 ${common_dir}/pft_ping.py \
		--sendif ${epair_send}a \
		--to 198.51.100.3 \
		--recvif ${epair_recv}a \
		--send-tc 42 \
		--expect-tc 42
}

v4_cleanup()
{
	pft_cleanup
}

atf_test_case "v6" "cleanup"
v6_head()
{
	atf_set descr 'set-tos6 test'
	atf_set require.user root

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

v6_body()
{
	pft_init

	epair=$(vnet_mkepair)
	ifconfig ${epair}a inet6 add 2001:db8:192::1
	vnet_mkjail alcatraz ${epair}b
	jexec alcatraz ifconfig ${epair}b inet6 add 2001:db8:192::2

	route -6 add 2001:db8:192::2 2001:db8:192::1
	jexec alcatraz route -6 add 2001:db8:192::1 2001:db8:192::2

	jexec alcatraz pfctl -e

	# No change is done if not requested
	pft_set_rules alcatraz "scrub out proto ipv6-icmp"
	atf_check -s exit:1 -o ignore -e ignore ${common_dir}/pft_ping.py \
		--sendif ${epair}a \
		--to 2001:db8:192::2 \
		--replyif ${epair}a \
		--expect-tc 42

	# The requested ToS is set
	pft_set_rules alcatraz "scrub out proto ipv6-icmp set-tos 42"
	atf_check -s exit:0 -o ignore -e ignore ${common_dir}/pft_ping.py \
		--sendif ${epair}a \
		--to 2001:db8:192::2 \
		--replyif ${epair}a \
		--expect-tc 42

	# ToS is not changed if the scrub rule does not match
	pft_set_rules alcatraz "scrub out from 2001:db8:192::3 set-tos 42"
	atf_check -s exit:1 -o ignore -e ignore ${common_dir}/pft_ping.py \
		--sendif ${epair}a \
		--to 2001:db8:192::2 \
		--replyif ${epair}a \
		--expect-tc 42

	# Multiple scrub rules match as expected
	pft_set_rules alcatraz "scrub out from 2001:db8:192::3 set-tos 13" \
		"scrub out proto ipv6-icmp set-tos 14"
	atf_check -s exit:0 -o ignore -e ignore ${common_dir}/pft_ping.py \
		--sendif ${epair}a \
		--to 2001:db8:192::2 \
		--replyif ${epair}a \
		--expect-tc 14

	# And this works even if the packet already has ToS values set
	atf_check -s exit:0 -o ignore -e ignore ${common_dir}/pft_ping.py \
		--sendif ${epair}a \
		--to 2001:db8:192::2 \
		--replyif ${epair}a \
		--send-tc 42 \
		--expect-tc 14

	# ToS values are unmolested if the packets do not match a scrub rule
	pft_set_rules alcatraz "scrub out from 2001:db8:192::3 set-tos 13"
	atf_check -s exit:0 -o ignore -e ignore ${common_dir}/pft_ping.py \
		--sendif ${epair}a \
		--to 2001:db8:192::2 \
		--replyif ${epair}a \
		--expect-tc 0

	# We can set tos on pass rules
	pft_set_rules alcatraz "pass out set tos 13"
	atf_check -s exit:0 -o ignore -e ignore ${common_dir}/pft_ping.py \
		--sendif ${epair}a \
		--to 2001:db8:192::2 \
		--replyif ${epair}a \
		--expect-tc 13

	# And that still works with 'scrub' options too
	pft_set_rules alcatraz "pass out set tos 14 scrub (min-ttl 64)"
	atf_check -s exit:0 -o ignore -e ignore ${common_dir}/pft_ping.py \
		--sendif ${epair}a \
		--to 2001:db8:192::2 \
		--replyif ${epair}a \
		--expect-tc 14
}

v6_cleanup()
{
	pft_cleanup
}

atf_init_test_cases()
{
	atf_add_test_case "v4"
	atf_add_test_case "v6"
}
