xref: /freebsd/tests/sys/netpfil/pf/pflog.sh (revision 7309c551a56edeb2e3d35639ecb20b5a70885924)
1#
2# SPDX-License-Identifier: BSD-2-Clause
3#
4# Copyright (c) 2023 Rubicon Communications, LLC (Netgate)
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions
8# are met:
9# 1. Redistributions of source code must retain the above copyright
10#    notice, this list of conditions and the following disclaimer.
11# 2. Redistributions in binary form must reproduce the above copyright
12#    notice, this list of conditions and the following disclaimer in the
13#    documentation and/or other materials provided with the distribution.
14#
15# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25# SUCH DAMAGE.
26
27. $(atf_get_srcdir)/utils.subr
28
29common_dir=$(atf_get_srcdir)/../common
30
31atf_test_case "malformed" "cleanup"
32malformed_head()
33{
34	atf_set descr 'Test that we do not log malformed packets as passing'
35	atf_set require.user root
36	atf_set require.progs scapy
37}
38
39malformed_body()
40{
41	pflog_init
42
43	epair=$(vnet_mkepair)
44
45	vnet_mkjail srv ${epair}b
46	jexec srv ifconfig ${epair}b 192.0.2.1/24 up
47
48	vnet_mkjail cl ${epair}a
49	jexec cl ifconfig ${epair}a 192.0.2.2/24 up
50
51	jexec cl pfctl -e
52	jexec cl ifconfig pflog0 up
53	pft_set_rules cl \
54		"pass log keep state"
55
56	# Not required, but the 'pf: dropping packet with ip options' kernel log can
57	# help when debugging the test.
58	jexec cl pfctl -x loud
59
60	jexec cl tcpdump -n -e -ttt --immediate-mode -l -U -i pflog0 >> pflog.txt &
61	sleep 1 # Wait for tcpdump to start
62
63	# Sanity check
64	atf_check -s exit:0 -o ignore \
65	    jexec srv ping -c 1 192.0.2.2
66
67	jexec srv ${common_dir}/pft_ping.py  \
68	    --sendif ${epair}b \
69	    --to 192.0.2.2 \
70	    --send-nop \
71	    --recvif ${epair}b
72
73	atf_check -o match:".*rule 0/8\(ip-option\): block in on ${epair}a: 192.0.2.1 > 192.0.2.2: ICMP echo request.*" \
74	    cat pflog.txt
75}
76
77malformed_cleanup()
78{
79	pft_cleanup
80}
81
82atf_test_case "matches" "cleanup"
83matches_head()
84{
85	atf_set descr 'Test the pflog matches keyword'
86	atf_set require.user root
87}
88
89matches_body()
90{
91	pflog_init
92
93	epair=$(vnet_mkepair)
94
95	vnet_mkjail alcatraz ${epair}a
96	jexec alcatraz ifconfig ${epair}a 192.0.2.1/24 up
97
98	ifconfig ${epair}b 192.0.2.2/24 up
99
100	# Sanity check
101	atf_check -s exit:0 -o ignore \
102	    ping -c 1 192.0.2.1
103
104	jexec alcatraz pfctl -e
105	jexec alcatraz ifconfig pflog0 up
106	pft_set_rules alcatraz \
107		"match log(matches) inet proto icmp" \
108		"match log(matches) inet from 192.0.2.2" \
109		"pass"
110
111	jexec alcatraz tcpdump -n -e -ttt --immediate-mode -l -U -i pflog0 >> ${PWD}/pflog.txt &
112	sleep 1 # Wait for tcpdump to start
113
114	atf_check -s exit:0 -o ignore \
115	    ping -c 1 192.0.2.1
116
117	echo "Rules"
118	jexec alcatraz pfctl -sr -vv
119	echo "States"
120	jexec alcatraz pfctl -ss -vv
121	echo "Log"
122	cat ${PWD}/pflog.txt
123
124	atf_check -o match:".*rule 0/0\(match\): match in on ${epair}a: 192.0.2.2 > 192.0.2.1: ICMP echo request.*" \
125	    cat pflog.txt
126	atf_check -o match:".*rule 1/0\(match\): match in on ${epair}a: 192.0.2.2 > 192.0.2.1: ICMP echo request.*" \
127	    cat pflog.txt
128}
129
130matches_cleanup()
131{
132	pft_cleanup
133}
134
135atf_init_test_cases()
136{
137	atf_add_test_case "malformed"
138	atf_add_test_case "matches"
139}
140