git: 14d0a20fede4 - stable/12 - pf tests: more thorough pfsync defer test

From: Kristof Provost <kp_at_FreeBSD.org>
Date: Mon, 13 Dec 2021 13:50:40 UTC
The branch stable/12 has been updated by kp:

URL: https://cgit.FreeBSD.org/src/commit/?id=14d0a20fede42786663ef5b306be2c27dd6c1a84

commit 14d0a20fede42786663ef5b306be2c27dd6c1a84
Author:     Kristof Provost <kp@FreeBSD.org>
AuthorDate: 2021-12-02 17:47:40 +0000
Commit:     Kristof Provost <kp@FreeBSD.org>
CommitDate: 2021-12-13 08:54:16 +0000

    pf tests: more thorough pfsync defer test
    
    Add a somewhat more extensive pfsync defer mode test. Ensure that pfsync
    actually delays the state creating packet until after it has sent the
    pfsync update and given the peer time to create the state.
    
    Ideally the test should validate the pfsync state update and generate an
    ack message, but to keep the test simple we rely on the timeout of the
    deferred packet instead.
    
    MFC after:      1 week
    Sponsored by:   Rubicon Communications, LLC ("Netgate")
    Differential Revision:  https://reviews.freebsd.org/D33245
    
    (cherry picked from commit 60a3a371afa73ddbc085a7af044a4a860a998c57)
---
 tests/sys/netpfil/pf/Makefile        |   4 +-
 tests/sys/netpfil/pf/pfsync.sh       |  71 ++++++++++++++++++-
 tests/sys/netpfil/pf/pfsync_defer.py | 131 +++++++++++++++++++++++++++++++++++
 3 files changed, 204 insertions(+), 2 deletions(-)

diff --git a/tests/sys/netpfil/pf/Makefile b/tests/sys/netpfil/pf/Makefile
index ebeec7f85650..599ff7c75378 100644
--- a/tests/sys/netpfil/pf/Makefile
+++ b/tests/sys/netpfil/pf/Makefile
@@ -39,7 +39,8 @@ ${PACKAGE}FILES+=	utils.subr \
 			fragcommon.py \
 			frag-overindex.py \
 			frag-overlimit.py \
-			frag-overreplace.py
+			frag-overreplace.py \
+			pfsync_defer.py
 
 ${PACKAGE}FILESMODE_CVE-2019-5597.py=	0555
 ${PACKAGE}FILESMODE_CVE-2019-5598.py=	0555
@@ -47,5 +48,6 @@ ${PACKAGE}FILESMODE_fragcommon.py=	0555
 ${PACKAGE}FILESMODE_frag-overindex.py=	0555
 ${PACKAGE}FILESMODE_frag-overlimit.py=	0555
 ${PACKAGE}FILESMODE_frag-overreplace.py=	0555
+${PACKAGE}FILESMODE_pfsync_defer.py=	0555
 
 .include <bsd.test.mk>
diff --git a/tests/sys/netpfil/pf/pfsync.sh b/tests/sys/netpfil/pf/pfsync.sh
index a6fc7ec9f7e9..1422c0b47c49 100755
--- a/tests/sys/netpfil/pf/pfsync.sh
+++ b/tests/sys/netpfil/pf/pfsync.sh
@@ -27,6 +27,8 @@
 
 . $(atf_get_srcdir)/utils.subr
 
+common_dir=$(atf_get_srcdir)/../common
+
 atf_test_case "basic" "cleanup"
 basic_head()
 {
@@ -95,6 +97,23 @@ basic_cleanup()
 	pfsynct_cleanup
 }
 
+atf_test_case "basic_defer" "cleanup"
+basic_defer_head()
+{
+	atf_set descr 'Basic defer mode pfsync test'
+	atf_set require.user root
+}
+
+basic_defer_body()
+{
+	common_body defer
+}
+
+basic_defer_cleanup()
+{
+	pfsynct_cleanup
+}
+
 atf_test_case "defer" "cleanup"
 defer_head()
 {
@@ -104,7 +123,56 @@ defer_head()
 
 defer_body()
 {
-	common_body defer
+	pfsynct_init
+
+	epair_sync=$(vnet_mkepair)
+	epair_in=$(vnet_mkepair)
+	epair_out=$(vnet_mkepair)
+
+	vnet_mkjail alcatraz ${epair_sync}a ${epair_in}a ${epair_out}a
+
+	jexec alcatraz ifconfig ${epair_sync}a 192.0.2.1/24 up
+	jexec alcatraz ifconfig ${epair_out}a 198.51.100.1/24 up
+	jexec alcatraz ifconfig ${epair_in}a 203.0.113.1/24 up
+	jexec alcatraz arp -s 203.0.113.2 00:01:02:03:04:05
+	jexec alcatraz sysctl net.inet.ip.forwarding=1
+
+	jexec alcatraz ifconfig pfsync0 \
+		syncdev ${epair_sync}a \
+		maxupd 1 \
+		defer \
+		up
+
+	ifconfig ${epair_sync}b 192.0.2.2/24 up
+	ifconfig ${epair_out}b 198.51.100.2/24 up
+	ifconfig ${epair_in}b up
+	route add -net 203.0.113.0/24 198.51.100.1
+
+	# Enable pf
+	jexec alcatraz pfctl -e
+	pft_set_rules alcatraz \
+		"set skip on ${epair_sync}a" \
+		"pass keep state"
+
+	atf_check -s exit:0 env PYTHONPATH=${common_dir} \
+		$(atf_get_srcdir)/pfsync_defer.py \
+		--syncdev ${epair_sync}b \
+		--indev ${epair_in}b \
+		--outdev ${epair_out}b
+
+	# Now disable defer mode and expect failure.
+	jexec alcatraz ifconfig pfsync0 -defer
+
+	# Flush state
+	pft_set_rules alcatraz \
+		"set skip on ${epair_sync}a" \
+		"pass keep state"
+
+	atf_check -s exit:1 env PYTHONPATH=${common_dir} \
+		$(atf_get_srcdir)/pfsync_defer.py \
+		--syncdev ${epair_sync}b \
+		--indev ${epair_in}b \
+		--outdev ${epair_out}b
 }
 
 defer_cleanup()
@@ -182,6 +250,7 @@ bulk_cleanup()
 atf_init_test_cases()
 {
 	atf_add_test_case "basic"
+	atf_add_test_case "basic_defer"
 	atf_add_test_case "defer"
 	atf_add_test_case "bulk"
 }
diff --git a/tests/sys/netpfil/pf/pfsync_defer.py b/tests/sys/netpfil/pf/pfsync_defer.py
new file mode 100644
index 000000000000..4a691240b466
--- /dev/null
+++ b/tests/sys/netpfil/pf/pfsync_defer.py
@@ -0,0 +1,131 @@
+#!/usr/bin/env python3
+#
+# SPDX-License-Identifier: BSD-2-Clause
+#
+# Copyright (c) 2021 Rubicon Communications, LLC (Netgate)
+#
+# 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.
+#
+
+import argparse
+import logging
+logging.getLogger("scapy").setLevel(logging.CRITICAL)
+import scapy.all as sp
+import socket
+import sys
+import time
+from sniffer import Sniffer
+
+got_pfsync = False
+got_ping = False
+sent_ping = False
+
+def check_pfsync(args, packet):
+    global got_pfsync
+    global got_ping
+
+    ip = packet.getlayer(sp.IP)
+    if not ip:
+        return False
+
+    if ip.proto != 240:
+        return False
+
+    # Only look at the first packet
+    if got_pfsync:
+        return False
+
+    got_pfsync = time.time()
+
+    return False
+
+def check_reply(args, packet):
+    global got_pfsync
+    global got_ping
+
+    if not packet.getlayer(sp.ICMP):
+        return False
+
+    # Only look at the first packet
+    if got_ping:
+        return False
+
+    got_ping = time.time()
+
+    return False
+
+def ping(intf):
+    global sent_ping
+
+    ether = sp.Ether()
+    ip = sp.IP(dst="203.0.113.2", src="198.51.100.2")
+    icmp = sp.ICMP(type='echo-request')
+    raw = sp.raw(bytes.fromhex('00010203'))
+
+    req = ether / ip / icmp / raw
+    sp.sendp(req, iface=intf, verbose=False)
+    sent_ping = time.time()
+
+def main():
+    global got_pfsync
+    global got_ping
+    global sent_ping
+
+    parser = argparse.ArgumentParser("pfsync_defer.py",
+        description="pfsync defer mode test")
+    parser.add_argument('--syncdev', nargs=1,
+        required=True,
+        help='The pfsync interface')
+    parser.add_argument('--outdev', nargs=1,
+        required=True,
+        help='The interface we will send packets on')
+    parser.add_argument('--indev', nargs=1,
+        required=True,
+        help='The interface we will receive packets on')
+
+    args = parser.parse_args()
+
+    syncmon = Sniffer(args, check_pfsync, args.syncdev[0])
+    datamon = Sniffer(args, check_reply, args.indev[0])
+
+    # Send traffic on datadev, which should create state and produce a pfsync message
+    ping(args.outdev[0])
+
+    syncmon.join()
+    datamon.join()
+
+    if not got_pfsync:
+        sys.exit(1)
+
+    if not got_ping:
+        sys.exit(1)
+
+    if got_pfsync > got_ping:
+        sys.exit(1)
+
+    # Deferred packets are delayed up to 20ms (unless the pfsync peer, which we
+    # don't have here, acks their state update earlier)
+    if (sent_ping + 0.020) > got_ping:
+        sys.exit(1)
+
+if __name__ == '__main__':
+    main()