#
# SPDX-License-Identifier: BSD-2-Clause
#
# Copyright (C) 2019 Jan Sucan <jansucan@FreeBSD.org>
# All rights reserved.
#
# 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.
#

require_ipv4()
{
	if ! getaddrinfo -f inet localhost 1>/dev/null 2>&1; then
		atf_skip "IPv4 is not configured"
	fi
}
require_ipv6()
{
	if ! getaddrinfo -f inet6 localhost 1>/dev/null 2>&1; then
		atf_skip "IPv6 is not configured"
	fi
}

atf_test_case ping_c1_s56_t1
ping_c1_s56_t1_head()
{
	atf_set "descr" "Stop after receiving 1 ECHO_RESPONSE packet"
}
ping_c1_s56_t1_body()
{
	require_ipv4
	atf_check -s exit:0 -o save:std.out -e empty \
	    ping -4 -c 1 -s 56 -t 1 localhost
	check_ping_statistics std.out $(atf_get_srcdir)/ping_c1_s56_t1.out
}

atf_test_case ping_c1_s56_t1_S127
ping_c1_s56_t1_S127_head()
{
	atf_set "descr" "Check that ping -S 127.0.0.1 localhost succeeds"
}
ping_c1_s56_t1_S127_body()
{
	require_ipv4
	require_ipv6
	atf_check -s exit:0 -o save:std.out -e empty \
	    ping -c 1 -s 56 -t 1 -S 127.0.0.1 localhost
	check_ping_statistics std.out $(atf_get_srcdir)/ping_c1_s56_t1_S127.out
}

atf_test_case ping_6_c1_s8_t1
ping_6_c1_s8_t1_head()
{
	atf_set "descr" "Stop after receiving 1 ECHO_RESPONSE packet"
}
ping_6_c1_s8_t1_body()
{
	require_ipv6
	atf_check -s exit:0 -o save:std.out -e empty \
	    ping -6 -c 1 -s 8 -t 1 localhost
	check_ping_statistics std.out $(atf_get_srcdir)/ping_6_c1_s8_t1.out
}

atf_test_case ping_c1_s8_t1_S1
ping_c1_s8_t1_S1_head()
{
	atf_set "descr" "Check that ping -S ::1 localhost succeeds"
}
ping_c1_s8_t1_S1_body()
{
	require_ipv4
	require_ipv6
	atf_check -s exit:0 -o save:std.out -e empty \
	    ping -c 1 -s 8 -t 1 -S ::1 localhost
	check_ping_statistics std.out $(atf_get_srcdir)/ping_c1_s8_t1_S1.out
}

atf_test_case ping6_c1_s8_t1
ping6_c1_s8_t1_head()
{
	atf_set "descr" "Use IPv6 when invoked as ping6"
}
ping6_c1_s8_t1_body()
{
	require_ipv6
	atf_check -s exit:0 -o save:std.out -e empty \
	    ping6 -c 1 -s 8 -t 1 localhost
	check_ping_statistics std.out $(atf_get_srcdir)/ping_6_c1_s8_t1.out
}

atf_test_case ping_c1t6
ping_c1t6_head()
{
	atf_set "descr" "-t6 is not interpreted as -t -6 by ping"
}
ping_c1t6_body()
{
	require_ipv4
	atf_check -s exit:0 -o ignore -e empty ping -c1 -t6 127.0.0.1
}

atf_test_case ping_c1t4
ping6_c1t4_head()
{
	atf_set "descr" "-t4 is not interpreted as -t -4 by ping6"
}
ping6_c1t4_body()
{
	require_ipv6
	atf_check -s exit:0 -o ignore -e empty ping6 -c1 -t4 ::1
}

atf_test_case ping_46
ping_46_head()
{
	atf_set "descr" "-4 and -6 cannot be used simultaneously"
}
ping_46_body()
{
	require_ipv4
	require_ipv6
	atf_check -s exit:1 \
	    -e match:"illegal option -- 6" \
	    ping -4 -6 localhost
}

atf_test_case ping_64
ping_64_head()
{
	atf_set "descr" "-4 and -6 cannot be used simultaneously"
}
ping_64_body()
{
	require_ipv4
	require_ipv6
	atf_check -s exit:1 \
	    -e match:"illegal option -- 4" \
	    ping -6 -4 localhost
}

atf_test_case ping6_4
ping6_4_head()
{
	atf_set "descr" "ping6 does not accept -4"
}
ping6_4_body()
{
	require_ipv4
	require_ipv6
	atf_check -s exit:1 \
	    -e match:"illegal option -- 4" \
	    ping6 -4 localhost
}

atf_test_case ping_nohost
ping_nohost_head()
{
	atf_set "descr" "ping a nonexistent host"
}
ping_nohost_body()
{
	atf_check -s exit:68 -e match:"cannot resolve" \
	    ping nonexistent.in-addr.arpa.
}

atf_test_case ping4_nohost
ping4_nohost_head()
{
	atf_set "descr" "ping -4 a nonexistent host"
}
ping4_nohost_body()
{
	atf_check -s exit:68 -e match:"cannot resolve" \
	    ping -4 nonexistent.in-addr.arpa.
}

atf_test_case ping6_nohost
ping6_nohost_head()
{
	atf_set "descr" "ping -6 a nonexistent host"
}
ping6_nohost_body()
{
	atf_check -s exit:68 -e match:"cannot resolve" \
	    ping -6 nonexistent.in-addr.arpa.
}

atf_test_case "inject_opts" "cleanup"
inject_opts_head()
{
	atf_set "descr" "Inject an ECHO REPLY with IP options"
	atf_set "require.user" "root"
	atf_set "require.progs" "python3" "scapy"
}
inject_opts_body()
{
	atf_check -s exit:0 -o match:"wrong total length" -o match:"NOP" python3 $(atf_get_srcdir)/injection.py opts
}
inject_opts_cleanup()
{
	ifconfig `cat tun.txt` destroy
}

atf_test_case "inject_pip" "cleanup"
inject_pip_head()
{
	atf_set "descr" "Inject an ICMP error with a quoted packet with IP options"
	atf_set "require.user" "root"
	atf_set "require.progs" "python3" "scapy"
}
inject_pip_body()
{
	atf_check -s exit:2 -o match:"Destination Host Unreachable" -o match:"(01){40}" python3 $(atf_get_srcdir)/injection.py pip
}
inject_pip_cleanup()
{
	ifconfig `cat tun.txt` destroy
}

# This is redundant with the ping_ tests, but it serves to ensure that scapy.py
# is working correctly.
atf_test_case "inject_reply" "cleanup"
inject_reply_head()
{
	atf_set "descr" "Basic ping test with packet injection"
	atf_set "require.user" "root"
	atf_set "require.progs" "python3" "scapy"
}
inject_reply_body()
{
	atf_check -s exit:0 -o match:"1 packets transmitted, 1 packets received" python3 $(atf_get_srcdir)/injection.py reply
}
inject_reply_cleanup()
{
	ifconfig `cat tun.txt` destroy
}

atf_test_case timestamp_origin cleanup
timestamp_origin_head()
{
	atf_set "descr" "ICMP Originate Timestamp"
	atf_set "require.user" "root"
	atf_set "require.config" "allow_sysctl_side_effects"
}
timestamp_origin_body()
{
	require_ipv4
	# The kernel only replies to ICMP timestamp requests when
	# net.inet.icmp.tstamprepl is enabled.  Save the current value
	# so the cleanup hook can restore it, then enable replies.
	sysctl -n net.inet.icmp.tstamprepl > tstamprepl.txt
	sysctl net.inet.icmp.tstamprepl=1

	# Run ping timestamp
	out=$(ping -Mt -c1 127.0.0.1)

	# Extract tso and tsr
	tso=$(echo "$out" | sed -n 's/.*tso=\([0-9:]*\).*/\1/p')
	tsr=$(echo "$out" | sed -n 's/.*tsr=\([0-9:]*\).*/\1/p')

	atf_check test -n "$tso"
	atf_check test -n "$tsr"

	# Convert tso and tsr from HH:MM:SS to seconds
	tso_s=`date -jf %H:%M:%S $tso +%s`
	tsr_s=`date -jf %H:%M:%S $tsr +%s`

	diff=$((tso_s - tsr_s))
	# Tolerate negative time difference between the sender and receiver
	if [ $diff -lt 0 ]; then
		diff=$(( -diff ))
	fi

	# Tolerate 2 seconds difference
	if [ $diff -gt 2 ]; then
		atf_fail "tso ($tso) differs from tsr ($tsr) by $diff seconds"
	fi
}
timestamp_origin_cleanup()
{
	if [ -f tstamprepl.txt ]; then
		sysctl net.inet.icmp.tstamprepl=`cat tstamprepl.txt`
	fi
}

atf_init_test_cases()
{
	atf_add_test_case ping_c1_s56_t1
	atf_add_test_case ping_c1_s56_t1_S127
	atf_add_test_case ping_6_c1_s8_t1
	atf_add_test_case ping_c1_s8_t1_S1
	atf_add_test_case ping6_c1_s8_t1
	atf_add_test_case ping_c1t6
	atf_add_test_case ping6_c1t4
	atf_add_test_case ping_46
	atf_add_test_case ping_64
	atf_add_test_case ping6_4
	atf_add_test_case ping_nohost
	atf_add_test_case ping4_nohost
	atf_add_test_case ping6_nohost
	atf_add_test_case inject_opts
	atf_add_test_case inject_pip
	atf_add_test_case inject_reply
	atf_add_test_case timestamp_origin
}

check_ping_statistics()
{
	sed -e 's/0.[0-9]\{3\}//g' \
	    -e 's/[1-9][0-9]*.[0-9]\{3\}//g' \
	    -e 's/localhost ([0-9]\{1,3\}\(\.[0-9]\{1,3\}\)\{1,3\})/localhost/' \
	    -e 's/from [0-9]\{1,3\}\(\.[0-9]\{1,3\}\)\{1,3\}/from/' \
	    -e 's/ttl=[0-9][0-9]*/ttl=/' \
	    -e 's/hlim=[0-9][0-9]*/hlim=/' \
	    "$1" >"$1".filtered
	atf_check -s exit:0 diff -u "$1".filtered "$2"
}