#! /usr/bin/atf-sh
#	$NetBSD: net_common.sh,v 1.44 2022/11/02 09:35:12 ozaki-r Exp $
#
# Copyright (c) 2016 Internet Initiative Japan Inc.
# 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
#

#
# Common utility functions for tests/net
#

export PATH="/sbin:/usr/sbin:/bin:/usr/bin"

HIJACKING="env LD_PRELOAD=/usr/lib/librumphijack.so \
    RUMPHIJACK=path=/rump,socket=all:nolocal,sysctl=yes"
ONEDAYISH="(23h5[0-9]m|1d0h0m)[0-9]+s ?"

extract_new_packets()
{
	local bus=$1
	local old=./.__old

	if [ ! -f $old ]; then
		old=/dev/null
	fi

	shmif_dumpbus -p - $bus 2>/dev/null |
	    tcpdump -n -e -r - 2>/dev/null > ./.__new
	diff -u $old ./.__new | grep '^+' | cut -d '+' -f 2   > ./.__diff
	mv -f ./.__new ./.__old
	cat ./.__diff
}

check_route()
{
	local target=$1
	local gw=$2
	local flags=${3:-\.\+}
	local ifname=${4:-\.\+}

	target=$(echo $target | sed 's/\./\\./g')
	if [ "$gw" = "" ]; then
		gw=".+"
	else
		gw=$(echo $gw | sed 's/\./\\./g')
	fi

	atf_check -s exit:0 -e ignore \
	    -o match:"^$target +$gw +$flags +- +- +.+ +$ifname" \
	    rump.netstat -rn
}

check_route_flags()
{

	check_route "$1" "" "$2" ""
}

check_route_gw()
{

	check_route "$1" "$2" "" ""
}

check_route_no_entry()
{
	local target=$(echo "$1" | sed 's/\./\\./g')

	atf_check -s exit:0 -e ignore -o not-match:"^$target" rump.netstat -rn
}

get_linklocal_addr()
{

	RUMP_SERVER=${1} rump.ifconfig ${2} inet6 |
	    awk "/fe80/ {sub(/%$2/, \"\"); sub(/\\/[0-9]*/, \"\"); print \$2;}"

	return 0
}

get_macaddr()
{

	RUMP_SERVER=${1} rump.ifconfig ${2} | awk '/address/ {print $2;}'
}

HTTPD_PID=./.__httpd.pid
start_httpd()
{
	local sock=$1
	local ip=$2
	local backup=$RUMP_SERVER

	export RUMP_SERVER=$sock

	# start httpd in daemon mode
	atf_check -s exit:0 env LD_PRELOAD=/usr/lib/librumphijack.so \
	    /usr/libexec/httpd -P $HTTPD_PID -i $ip -b -s $(pwd)

	export RUMP_SERVER=$backup

	sleep 3
}

stop_httpd()
{

	if [ -f $HTTPD_PID ]; then
		kill -9 $(cat $HTTPD_PID)
		rm -f $HTTPD_PID
		sleep 1
	fi
}

NC_PID=./.__nc.pid
start_nc_server()
{
	local sock=$1
	local port=$2
	local outfile=$3
	local proto=${4:-ipv4}
	local extra_opts="$5"
	local backup=$RUMP_SERVER
	local opts=

	export RUMP_SERVER=$sock

	if [ $proto = ipv4 ]; then
		opts="-l -4"
	else
		opts="-l -6"
	fi
	opts="$opts $extra_opts"

	env LD_PRELOAD=/usr/lib/librumphijack.so nc $opts $port > $outfile &
	echo $! > $NC_PID

	if [ $proto = ipv4 ]; then
		$DEBUG && rump.netstat -a -f inet
	else
		$DEBUG && rump.netstat -a -f inet6
	fi

	export RUMP_SERVER=$backup

	sleep 1
}

stop_nc_server()
{

	if [ -f $NC_PID ]; then
		kill -9 $(cat $NC_PID)
		rm -f $NC_PID
		sleep 1
	fi
}

BASIC_LIBS="-lrumpnet -lrumpnet_net -lrumpnet_netinet -lrumpnet_shmif"
FS_LIBS="$BASIC_LIBS -lrumpdev -lrumpvfs -lrumpfs_ffs"
CRYPTO_LIBS="$BASIC_LIBS -lrumpdev -lrumpdev_opencrypto \
    -lrumpkern_z -lrumpkern_crypto"
NPF_LIBS="$BASIC_LIBS -lrumpdev -lrumpvfs -lrumpdev_bpf -lrumpnet_npf"
CRYPTO_NPF_LIBS="$CRYPTO_LIBS -lrumpvfs -lrumpdev_bpf -lrumpnet_npf"
BPF_LIBS="$BASIC_LIBS -lrumpdev -lrumpvfs -lrumpdev_bpf"

# We cannot keep variables between test phases, so need to store in files
_rump_server_socks=./.__socks
_rump_server_ifaces=./.__ifaces
_rump_server_buses=./.__buses
_rump_server_macaddrs=./.__macaddrs

DEBUG_SYSCTL_ENTRIES="net.inet.arp.debug net.inet6.icmp6.nd6_debug \
    net.inet.ipsec.debug"

IPSEC_KEY_DEBUG=${IPSEC_KEY_DEBUG:-false}

_rump_server_start_common()
{
	local sock=$1
	local backup=$RUMP_SERVER

	shift 1

	atf_check -s exit:0 rump_server "$@" "$sock"

	if $DEBUG; then
		# Enable debugging features in the kernel
		export RUMP_SERVER=$sock
		for ent in $DEBUG_SYSCTL_ENTRIES; do
			if rump.sysctl -q $ent; then
				atf_check -s exit:0 rump.sysctl -q -w $ent=1
			fi
		done
		export RUMP_SERVER=$backup
	fi
	if $IPSEC_KEY_DEBUG; then
		# Enable debugging features in the kernel
		export RUMP_SERVER=$sock
		if rump.sysctl -q net.key.debug; then
			atf_check -s exit:0 \
			    rump.sysctl -q -w net.key.debug=0xffff
		fi
		export RUMP_SERVER=$backup
	fi

	echo $sock >> $_rump_server_socks
	$DEBUG && cat $_rump_server_socks
}

rump_server_start()
{
	local sock=$1
	local lib=
	local libs="$BASIC_LIBS"

	shift 1

	for lib
	do
		libs="$libs -lrumpnet_$lib"
	done

	_rump_server_start_common $sock $libs

	return 0
}

rump_server_fs_start()
{
	local sock=$1
	local lib=
	local libs="$FS_LIBS"

	shift 1

	for lib
	do
		libs="$libs -lrumpnet_$lib"
	done

	_rump_server_start_common $sock $libs

	return 0
}

rump_server_crypto_start()
{
	local sock=$1
	local lib=
	local libs="$CRYPTO_LIBS"

	shift 1

	for lib
	do
		libs="$libs -lrumpnet_$lib"
	done

	_rump_server_start_common $sock $libs

	return 0
}

rump_server_npf_start()
{
	local sock=$1
	local lib=
	local libs="$NPF_LIBS"

	shift 1

	for lib
	do
		libs="$libs -lrumpnet_$lib"
	done

	_rump_server_start_common $sock $libs

	return 0
}

rump_server_crypto_npf_start()
{
	local sock=$1
	local lib=
	local libs="$CRYPTO_NPF_LIBS"

	shift 1

	for lib
	do
		libs="$libs -lrumpnet_$lib"
	done

	_rump_server_start_common $sock $libs

	return 0
}

rump_server_bpf_start()
{
	local sock=$1
	local lib=
	local libs="$BPF_LIBS"

	shift 1

	for lib
	do
		libs="$libs -lrumpnet_$lib"
	done

	_rump_server_start_common $sock $libs

	return 0
}

rump_server_add_iface()
{
	local sock=$1
	local ifname=$2
	local bus=$3
	local backup=$RUMP_SERVER
	local macaddr=

	export RUMP_SERVER=$sock
	atf_check -s exit:0 rump.ifconfig $ifname create
	if [ -n "$bus" ]; then
		atf_check -s exit:0 rump.ifconfig $ifname linkstr $bus
	fi

	macaddr=$(get_macaddr $sock $ifname)
	if [ -n "$macaddr" ]; then
		if [ -f $_rump_server_macaddrs ]; then
			atf_check -s not-exit:0 \
			    grep -q $macaddr $_rump_server_macaddrs
		fi
		echo $macaddr >> $_rump_server_macaddrs
	fi

	export RUMP_SERVER=$backup

	echo $sock $ifname >> $_rump_server_ifaces
	$DEBUG && cat $_rump_server_ifaces

	echo $bus >> $_rump_server_buses
	cat $_rump_server_buses |sort -u >./.__tmp
	mv -f ./.__tmp $_rump_server_buses
	$DEBUG && cat $_rump_server_buses

	return 0
}

rump_server_check_poolleaks()
{
	local target=$1

	# XXX rumphijack doesn't work with a binary with suid/sgid bits like
	# vmstat.  Use a copied one to drop sgid bit as a workaround until
	# vmstat stops using kvm(3) for /dev/kmem and the sgid bit.
	cp /usr/bin/vmstat ./vmstat
	reqs=$($HIJACKING ./vmstat -mv | awk "/$target/ {print \$3;}")
	rels=$($HIJACKING ./vmstat -mv | awk "/$target/ {print \$5;}")
	rm -f ./vmstat
	atf_check_equal '$target$reqs' '$target$rels'
}

#
# rump_server_check_memleaks detects memory leaks.  It can detect leaks of pool
# objects that are guaranteed to be all deallocated at this point, i.e., all
# created interfaces are destroyed.  Currently only llentpl satisfies this
# constraint.  This mechanism can't be applied to objects allocated through
# pool_cache(9) because it doesn't track released objects explicitly.
#
rump_server_check_memleaks()
{

	rump_server_check_poolleaks llentrypl
	# This doesn't work for objects allocated through pool_cache
	#rump_server_check_poolleaks mbpl
	#rump_server_check_poolleaks mclpl
	#rump_server_check_poolleaks socket
}

rump_server_destroy_ifaces()
{
	local backup=$RUMP_SERVER
	local output=ignore
	local reqs= rels=

	$DEBUG && cat $_rump_server_ifaces

	# Try to dump states before destroying interfaces
	for sock in $(cat $_rump_server_socks); do
		export RUMP_SERVER=$sock
		if $DEBUG; then
			output=save:/dev/stdout
		fi
		atf_check -s exit:0 -o $output rump.ifconfig
		atf_check -s exit:0 -o $output rump.netstat -nr
		# XXX still need hijacking
		atf_check -s exit:0 -o $output $HIJACKING rump.netstat -nai
		atf_check -s exit:0 -o $output rump.arp -na
		atf_check -s exit:0 -o $output rump.ndp -na
		atf_check -s exit:0 -o $output $HIJACKING ifmcstat
	done

	# XXX using pipe doesn't work. See PR bin/51667
	#cat $_rump_server_ifaces | while read sock ifname; do
	# Destroy interfaces in the reverse order
	tac $_rump_server_ifaces > __ifaces
	while read sock ifname; do
		export RUMP_SERVER=$sock
		if rump.ifconfig -l |grep -q $ifname; then
			if $DEBUG; then
				rump.ifconfig -v $ifname
			fi
			atf_check -s exit:0 rump.ifconfig $ifname destroy
		fi
		atf_check -s exit:0 -o ignore rump.ifconfig
	done < __ifaces
	rm -f __ifaces

	for sock in $(cat $_rump_server_socks); do
		export RUMP_SERVER=$sock
		rump_server_check_memleaks
	done

	export RUMP_SERVER=$backup

	return 0
}

rump_server_halt_servers()
{
	local backup=$RUMP_SERVER

	$DEBUG && cat $_rump_server_socks
	for sock in $(cat $_rump_server_socks); do
		env RUMP_SERVER=$sock rump.halt
	done
	export RUMP_SERVER=$backup

	return 0
}

extract_rump_server_core()
{

	if [ -f rump_server.core ]; then
		gdb -ex bt /usr/bin/rump_server rump_server.core
		# Extract kernel logs including a panic message
		strings rump_server.core |grep -E '^\[.+\] '
	fi
}

dump_kernel_stats()
{
	local sock=$1

	echo "### Dumping $sock"
	export RUMP_SERVER=$sock
	rump.ifconfig -av
	rump.netstat -nr
	# XXX still need hijacking
	$HIJACKING rump.netstat -nai
	# XXX workaround for vmstat with the sgid bit
	cp /usr/bin/vmstat ./vmstat
	$HIJACKING ./vmstat -m
	rm -f ./vmstat
	rump.arp -na
	rump.ndp -na
	$HIJACKING ifmcstat
	$HIJACKING dmesg
}

rump_server_dump_servers()
{
	local backup=$RUMP_SERVER

	$DEBUG && cat $_rump_server_socks
	for sock in $(cat $_rump_server_socks); do
		dump_kernel_stats $sock
	done
	export RUMP_SERVER=$backup

	extract_rump_server_core
	return 0
}

rump_server_dump_buses()
{

	if [ ! -f $_rump_server_buses ]; then
		return 0
	fi

	$DEBUG && cat $_rump_server_buses
	for bus in $(cat $_rump_server_buses); do
		echo "### Dumping $bus"
		shmif_dumpbus -p - $bus 2>/dev/null| tcpdump -n -e -r -
	done
	return 0
}

cleanup()
{

	rump_server_halt_servers
}

dump()
{

	rump_server_dump_servers
	rump_server_dump_buses
}

skip_if_qemu()
{
	if drvctl -l qemufwcfg0 >/dev/null 2>&1
	then
	    atf_skip "unreliable under qemu, skip until PR kern/43997 fixed"
	fi
}

test_create_destroy_common()
{
	local sock=$1
	local ifname=$2
	local test_address=${3:-false}
	local ipv4="10.0.0.1/24"
	local ipv6="fc00::1"

	export RUMP_SERVER=$sock

	atf_check -s exit:0 rump.ifconfig $ifname create
	atf_check -s exit:0 rump.ifconfig $ifname destroy

	atf_check -s exit:0 rump.ifconfig $ifname create
	atf_check -s exit:0 rump.ifconfig $ifname up
	atf_check -s exit:0 rump.ifconfig $ifname down
	atf_check -s exit:0 rump.ifconfig $ifname destroy

	# Destroy while UP
	atf_check -s exit:0 rump.ifconfig $ifname create
	atf_check -s exit:0 rump.ifconfig $ifname up
	atf_check -s exit:0 rump.ifconfig $ifname destroy

	if ! $test_address; then
		return
	fi

	# With an IPv4 address
	atf_check -s exit:0 rump.ifconfig $ifname create
	atf_check -s exit:0 rump.ifconfig $ifname inet $ipv4
	atf_check -s exit:0 rump.ifconfig $ifname up
	atf_check -s exit:0 rump.ifconfig $ifname destroy

	# With an IPv6 address
	atf_check -s exit:0 rump.ifconfig $ifname create
	atf_check -s exit:0 rump.ifconfig $ifname inet6 $ipv6
	atf_check -s exit:0 rump.ifconfig $ifname up
	atf_check -s exit:0 rump.ifconfig $ifname destroy

	unset RUMP_SERVER
}
#	$NetBSD: common.sh,v 1.1 2020/08/26 16:03:42 riastradh Exp $
#
# Copyright (c) 2018 Ryota Ozaki <ozaki.ryota@gmail.com>
# 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
#

escape_key()
{

	echo $1 | sed 's/\+/\\+/g' | sed 's|\/|\\/|g'
}

setup_servers()
{

	rump_server_crypto_start $SOCK_LOCAL netinet6 wg
	rump_server_add_iface $SOCK_LOCAL shmif0 $BUS

	rump_server_crypto_start $SOCK_PEER netinet6 wg
	rump_server_add_iface $SOCK_PEER shmif0 $BUS
}

check_conf_port()
{
	local ifname=$1
	local port=$2

	atf_check -s exit:0 -o match:"listen-port: $port" \
	    $HIJACKING wgconfig $ifname
}

check_conf_privkey()
{
	local ifname=$1
	local key_priv="$2"

	atf_check -s exit:0 -o match:"private-key: $(escape_key $key_priv)" \
	    $HIJACKING wgconfig $ifname show private-key
}

setup_common()
{
	local ifconfig="atf_check -s exit:0 rump.ifconfig"
	local ifname=$1
	local proto=$2
	local ip=$3
	local prefix=$4

	$ifconfig $ifname $proto $ip/$prefix
}

setup_wg_common()
{
	local ifconfig="atf_check -s exit:0 rump.ifconfig"
	local wgconfig="atf_check -s exit:0 $HIJACKING wgconfig"
	local ifname=$1
	local proto=$2
	local ip=$3
	local prefix=$4
	local port=$5
	local key_priv="$6"
	local tun=$7
	local privfile=./tmp

	$ifconfig $ifname create
	if [ -n "$tun" ]; then
		$ifconfig $ifname linkstr $tun
	fi
	$ifconfig $ifname $proto $ip/$prefix
	$DEBUG && rump.netstat -nr
	echo $key_priv > $privfile
	$wgconfig $ifname set private-key $privfile
	$wgconfig $ifname set listen-port $port
	rm -f $privfile
	$ifconfig $ifname up
	$DEBUG && rump.ifconfig $ifname

	check_conf_port $ifname $port
	check_conf_privkey $ifname "$key_priv"
}

check_ping()
{
	local proto=$1
	local ip=$2
	local ping=

	if [ $proto = inet ]; then
		ping="atf_check -s exit:0 -o ignore rump.ping -n -i 0.1 -c 3 -w 1"
	else
		ping="atf_check -s exit:0 -o ignore rump.ping6 -n -i 0.1 -c 3 -X 1"
	fi

	$ping $ip
}

check_ping_fail()
{
	local proto=$1
	local ip=$2
	local ping=

	if [ $proto = inet ]; then
		ping="atf_check -s not-exit:0 -o ignore rump.ping -n -c 1 -w 1"
	else
		ping="atf_check -s not-exit:0 -o ignore rump.ping6 -n -c 1 -X 1"
	fi

	$ping $ip
}

destroy_wg_interfaces()
{
	local ifconfig="atf_check -s exit:0 rump.ifconfig"

	export RUMP_SERVER=$SOCK_LOCAL
	$ifconfig wg0 destroy
	export RUMP_SERVER=$SOCK_PEER
	$ifconfig wg0 destroy
}

add_peer()
{
	local wgconfig="atf_check -s exit:0 $HIJACKING wgconfig"
	local ifname=$1
	local peername=$2
	local key=$3
	local endpoint=$4
	local allowedips=$5
	local pskfile=$6
	local key_psk="$7"
	local pskopt=
	local endpoint_opts=

	if [ -n "$pskfile" ]; then
		pskopt="--preshared-key=$pskfile"
	fi

	if [ -n "$endpoint" ]; then
		endpoint_opts="--endpoint=$endpoint"
	fi

	$wgconfig $ifname add peer $peername $key $endpoint_opts \
	    --allowed-ips=$allowedips $pskopt
	atf_check -s exit:0 -o match:"allowed-ips: $allowedips" \
	    $HIJACKING wgconfig $ifname show peer $peername
	if [ -n "$key_psk" ]; then
		atf_check -s exit:0 \
		    -o match:"preshared-key: $(escape_key $key_psk)" \
		    $HIJACKING wgconfig $ifname show peer $peername \
		    --show-preshared-key
	else
		atf_check -s exit:0 -o match:"preshared-key: \(none\)" \
		    $HIJACKING wgconfig $ifname show peer $peername \
		    --show-preshared-key
	fi
}

delete_peer()
{
	local wgconfig="atf_check -s exit:0 $HIJACKING wgconfig"
	local ifname=$1
	local peername=$2

	$wgconfig $ifname delete peer $peername
	atf_check -s exit:0 -o not-match:"peer: $peername" \
	    $HIJACKING wgconfig $ifname
}

generate_keys()
{

	key_priv_local=$(wg-keygen)
	key_pub_local=$(echo $key_priv_local| wg-keygen --pub)
	key_priv_peer=$(wg-keygen)
	key_pub_peer=$(echo $key_priv_peer| wg-keygen --pub)

	export key_priv_local key_pub_local key_priv_peer key_pub_peer
}
#	$NetBSD: t_interoperability.sh,v 1.1 2020/08/26 16:03:42 riastradh Exp $
#
# Copyright (c) 2018 Ryota Ozaki <ozaki.ryota@gmail.com>
# 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
#

BUS=bus
SOCK_LOCAL=unix://wg_local
SOCK_PEER=unix://wg_peer


atf_test_case wg_interoperability_basic cleanup
wg_interoperability_basic_head()
{

	atf_set "descr" "tests of interoperability with the WireGuard protocol"
	atf_set "require.progs" "rump_server" "wgconfig" "wg-keygen"
}

#
# Set ATF_NET_IF_WG_INTEROPERABILITY=yes to run the test.
# Also to run the test, the following setups are required on the host and a peer.
#
# [Host]
#   ifconfig bridge0 create
#   ifconfig tap0 create
#   brconfig bridge0 add tap0
#   brconfig bridge0 add <external-interface>
#   ifconfig tap0 up
#   ifconfig bridge0 up
#
# [Peer]
#   ip addr add 10.0.0.2/24 dev <external-interface>
#   ip link add wg0 type wireguard
#   ip addr add 10.0.1.2/24 dev wg0
#   privkey="EF9D8AOkmxjlkiRFqBnfJS+RJJHbUy02u+VkGlBr9Eo="
#   ip link set wg0 up
#   echo $privkey > /tmp/private-key
#   wg set wg0 listen-port 52428
#   wg set wg0 private-key /tmp/private-key
#   pubkey="2iWFzywbDvYu2gQW5Q7/z/g5/Cv4bDDd6L3OKXLOwxs="
#   wg set wg0 peer $pubkey endpoint 10.0.0.3:52428 allowed-ips 10.0.1.1/32
#
wg_interoperability_basic_body()
{
	local ifconfig="atf_check -s exit:0 rump.ifconfig"
	local ping="atf_check -s exit:0 -o ignore rump.ping -n -c 3 -w 3"
	local ping_fail="atf_check -s not-exit:0 -o ignore rump.ping -n -c 1 -w 3"
	local key_priv_local=
	local key_pub_local=
	local key_priv_peer=
	local key_pub_peer=
	local ip_local=10.0.0.3
	local ip_peer=10.0.0.2
	local ip_wg_local=10.0.1.1
	local ip_wg_peer=10.0.1.2
	local port=52428
	local outfile=./out

	if [ "$ATF_NET_IF_WG_INTEROPERABILITY" != yes ]; then
		atf_skip "set ATF_NET_IF_WG_INTEROPERABILITY=yes to run the test"
	fi

	export RUMP_SERVER=$SOCK_LOCAL
	rump_server_crypto_start $SOCK_LOCAL virtif wg netinet6
	atf_check -s exit:0 rump.sysctl -q -w net.inet.ip.dad_count=0
	atf_check -s exit:0 rump.ifconfig virt0 create
	atf_check -s exit:0 rump.ifconfig virt0 $ip_local/24
	atf_check -s exit:0 rump.ifconfig virt0 up

	$ping $ip_peer

	key_priv_local="aK3TbzUNDO4aeDRX54x8bOG+NaKuqXKt7Hwq0Uz69Wo="
	key_pub_local="2iWFzywbDvYu2gQW5Q7/z/g5/Cv4bDDd6L3OKXLOwxs="
	key_priv_peer="EF9D8AOkmxjlkiRFqBnfJS+RJJHbUy02u+VkGlBr9Eo="
	key_pub_peer="2ZM9RvDmMZS/Nuh8OaVaJrwFbO57/WJgeU+JoQ//nko="

	setup_wg_common wg0 inet $ip_wg_local 24 $port "$key_priv_local"
	add_peer wg0 peer0 $key_pub_peer $ip_peer:$port $ip_wg_peer/32

	$ping $ip_wg_peer

	export RUMP_SERVER=$SOCK_LOCAL
	$ifconfig wg0 destroy
}

wg_interoperability_basic_cleanup()
{

	$DEBUG && dump
	cleanup
}

atf_test_case wg_interoperability_cookie cleanup
wg_interoperability_cookie_head()
{

	atf_set "descr" "tests of interoperability with the WireGuard protocol"
	atf_set "require.progs" "rump_server" "wgconfig" "wg-keygen"
}

wg_interoperability_cookie_body()
{
	local ifconfig="atf_check -s exit:0 rump.ifconfig"
	local ping="atf_check -s exit:0 -o ignore rump.ping -n -c 3 -w 3"
	local ping_fail="atf_check -s not-exit:0 -o ignore rump.ping -n -c 1 -w 3"
	local key_priv_local=
	local key_pub_local=
	local key_priv_peer=
	local key_pub_peer=
	local ip_local=10.0.0.3
	local ip_peer=10.0.0.2
	local ip_wg_local=10.0.1.1
	local ip_wg_peer=10.0.1.2
	local port=52428
	local outfile=./out
	local rekey_timeout=5 # default

	if [ "$ATF_NET_IF_WG_INTEROPERABILITY" != yes ]; then
		atf_skip "set ATF_NET_IF_WG_INTEROPERABILITY=yes to run the test"
	fi

	export RUMP_SERVER=$SOCK_LOCAL
	rump_server_crypto_start $SOCK_LOCAL virtif wg netinet6
	atf_check -s exit:0 rump.sysctl -q -w net.inet.ip.dad_count=0
	atf_check -s exit:0 rump.ifconfig virt0 create
	atf_check -s exit:0 rump.ifconfig virt0 $ip_local/24
	atf_check -s exit:0 rump.ifconfig virt0 up

	$ping $ip_peer

	key_priv_local="aK3TbzUNDO4aeDRX54x8bOG+NaKuqXKt7Hwq0Uz69Wo="
	key_pub_local="2iWFzywbDvYu2gQW5Q7/z/g5/Cv4bDDd6L3OKXLOwxs="
	key_priv_peer="EF9D8AOkmxjlkiRFqBnfJS+RJJHbUy02u+VkGlBr9Eo="
	key_pub_peer="2ZM9RvDmMZS/Nuh8OaVaJrwFbO57/WJgeU+JoQ//nko="

	setup_wg_common wg0 inet $ip_wg_local 24 $port "$key_priv_local"

	# Emulate load to send back a cookie on receiving a response message
	atf_check -s exit:0 -o ignore \
	    rump.sysctl -w net.wg.force_underload=1

	add_peer wg0 peer0 $key_pub_peer $ip_peer:$port $ip_wg_peer/32

	# ping fails because we don't accept a response message and send a cookie
	$ping_fail $ip_wg_peer

	# Wait for retrying an initialization that works because the peer
	# send a response message with the cookie we sent
	atf_check -s exit:0 sleep $rekey_timeout

	# So ping works
	$ping $ip_wg_peer

	export RUMP_SERVER=$SOCK_LOCAL
	$ifconfig wg0 destroy
}

wg_interoperability_cookie_cleanup()
{

	$DEBUG && dump
	cleanup
}

atf_test_case wg_userspace_basic cleanup
wg_userspace_basic_head()
{

	atf_set "descr" "tests of userspace implementation of wg(4)"
	atf_set "require.progs" "rump_server" "wgconfig" "wg-keygen"
}

#
# Set ATF_NET_IF_WG_USERSPACE=yes to run the test.
# Also to run the test, the following setups are required on the host and a peer.
#
# [Host]
#   ifconfig bridge0 create
#   ifconfig tap0 create
#   brconfig bridge0 add tap0
#   brconfig bridge0 add <external-interface>
#   ifconfig tap0 up
#   ifconfig bridge0 up
#
# [Peer]
#   ip addr add 10.0.0.2/24 dev <external-interface>
#   ip link add wg0 type wireguard
#   ip addr add 10.0.4.2/24 dev wg0
#   privkey="EF9D8AOkmxjlkiRFqBnfJS+RJJHbUy02u+VkGlBr9Eo="
#   ip link set wg0 up
#   echo $privkey > /tmp/private-key
#   wg set wg0 listen-port 52428
#   wg set wg0 private-key /tmp/private-key
#   pubkey="6mQ4lUO3oq5O8FfGW52CFXNbmh5iFT1XMqPzpdrc0nE="
#   wg set wg0 peer $pubkey endpoint 10.0.0.3:52428 allowed-ips 10.0.4.1/32
#
wg_userspace_basic_body()
{
	local ifconfig="atf_check -s exit:0 rump.ifconfig"
	local ping="atf_check -s exit:0 -o ignore ping -n -c 3 -w 3"
	local ping_fail="atf_check -s not-exit:0 -o ignore ping -n -c 1 -w 3"
	local key_priv_local=
	local key_pub_local=
	local key_priv_peer=
	local key_pub_peer=
	local ip_local=10.0.0.3
	local ip_peer=10.0.0.2
	local ip_wg_local=10.0.4.1
	local ip_wg_peer=10.0.4.2
	local port_local=52429
	local port_peer=52428
	local outfile=./out

	if [ "$ATF_NET_IF_WG_USERSPACE" != yes ]; then
		atf_skip "set ATF_NET_IF_WG_USERSPACE=yes to run the test"
	fi

	export RUMP_SERVER=$SOCK_LOCAL
	rump_server_crypto_start $SOCK_LOCAL virtif wg netinet6
	atf_check -s exit:0 rump.sysctl -q -w net.inet.ip.dad_count=0

	$DEBUG && netstat -nr -f inet

	$ping $ip_peer

	key_priv_local="6B0dualfIAiEG7/jFGOIHrJMhuypq87xCER/0ieIpE4="
	key_pub_local="6mQ4lUO3oq5O8FfGW52CFXNbmh5iFT1XMqPzpdrc0nE="
	key_priv_peer="EF9D8AOkmxjlkiRFqBnfJS+RJJHbUy02u+VkGlBr9Eo="
	key_pub_peer="2ZM9RvDmMZS/Nuh8OaVaJrwFbO57/WJgeU+JoQ//nko="

	setup_wg_common wg0 inet $ip_wg_local 24 $port_local "$key_priv_local" tun0
	add_peer wg0 peer0 $key_pub_peer $ip_peer:$port_peer $ip_wg_peer/32

	$DEBUG && rump.ifconfig wg0
	$DEBUG && ifconfig tun0
	$DEBUG && netstat -nr -f inet

	$ping $ip_wg_peer

	export RUMP_SERVER=$SOCK_LOCAL
	$ifconfig wg0 destroy
}

wg_userspace_basic_cleanup()
{

	$DEBUG && dump
	cleanup
}

atf_init_test_cases()
{

	atf_add_test_case wg_interoperability_basic
	atf_add_test_case wg_interoperability_cookie
	atf_add_test_case wg_userspace_basic
}
