Makefile revision 1.10 
1#	$OpenBSD: Makefile,v 1.10 2021/09/30 17:57:44 anton Exp $
2
3# Copyright (c) 2017-2020 Alexander Bluhm <bluhm@openbsd.org>
4#
5# Permission to use, copy, modify, and distribute this software for any
6# purpose with or without fee is hereby granted, provided that the above
7# copyright notice and this permission notice appear in all copies.
8#
9# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16
17# The following ports must be installed:
18#
19# scapy               powerful interactive packet manipulation in python
20
21.include <bsd.own.mk>
22
23.if ! (make(clean) || make(cleandir) || make(obj))
24
25.if ! exists(/usr/local/bin/scapy)
26regress:
27	@echo Install scapy package to run this regress.
28	@echo SKIPPED
29.endif
30
31# PERL_REQUIRE set in ../Makefile.inc
32.if ! empty (PERL_REQUIRE)
33regress:
34	@echo perl require: "${PERL_REQUIRE}"
35	@echo Install these Perl modules for additional tests.
36	@echo SKIPPED
37.endif
38
39PF_STATUS !=	${SUDO} pfctl -si | sed -n 's/^Status: \([^ ]*\) .*/\1/p'
40PF_ANCHOR !=	${SUDO} pfctl -sr | sed -n 's/^anchor "\([^"]*\)" all$$/\1/p'
41.if ! empty(PF_STATUS:MEnabled) && empty(PF_ANCHOR:Mregress)
42regress:
43	@echo pf status: "${PF_STATUS}"
44	@echo pf anchor: "${PF_ANCHOR}"
45	@echo This regress cannot run with pf filtering packets on localhost.
46	@echo Either disable pf or add a line 'anchor "regress"' to pf.conf.
47	@echo There the test will add a stateless rule that passes all packets.
48	@echo SKIPPED
49.endif
50
51.endif
52
53# This test needs a manual setup of two machines
54# Set up machines: LOCAL REMOTE
55# LOCAL is the machine where this makefile is running.
56# REMOTE is running OpenBSD with echo server to test PMTU
57# FAKE is an non existing machine in a non existing network.
58# REMOTE_SSH is the hostname to log in on the REMOTE machine.
59
60# Configure Addresses on the machines.
61# Adapt interface and addresse variables to your local setup.
62#
63LOCAL_IF ?=
64REMOTE_SSH ?=
65
66LOCAL_ADDR ?=
67REMOTE_ADDR ?=
68FAKE_NET ?=
69FAKE_NET_ADDR ?=
70
71.if empty (LOCAL_IF) || empty (REMOTE_SSH) || \
72    empty (LOCAL_ADDR) || \
73    empty (REMOTE_ADDR) || \
74    empty (FAKE_NET) || \
75    empty (FAKE_NET_ADDR)
76.BEGIN:
77	@true
78regress:
79	@echo This tests needs a remote machine to operate on
80	@echo LOCAL_IF REMOTE_SSH LOCAL_ADDR REMOTE_ADDR FAKE_NET FAKE_NET_ADDR
81	@echo are empty.  Fill out these variables for additional tests.
82	@echo SKIPPED
83.endif
84
85.MAIN: all
86
87.if make (regress) || make (all)
88.BEGIN:
89	${SUDO} true
90	ssh -t ${REMOTE_SSH} true
91	@echo
92.endif
93
94# Create python include file containing the addresses.
95addr.py: Makefile
96	rm -f $@ $@.tmp
97	echo 'LOCAL_IF = "${LOCAL_IF}"' >>$@.tmp
98.for var in LOCAL REMOTE FAKE_NET
99	echo '${var}_ADDR = "${${var}_ADDR}"' >>$@.tmp
100.endfor
101	echo 'FAKE_NET = "${FAKE_NET}"' >>$@.tmp
102	mv $@.tmp $@
103
104# load the pf rules into the kernel of the REMOTE and LOCAL machine
105REGRESS_SETUP +=	stamp-pfctl
106stamp-pfctl:
107.if ! empty(PF_ANCHOR:Mregress)
108	echo 'pass on ${LOCAL_IF} no state' | ${SUDO} pfctl -a regress -f -
109.endif
110	@date >$@
111
112SCAPYS !=		cd ${.CURDIR} && ls scapy-*.py
113TARGETS =
114
115# Set variables so that make runs with and without obj directory.
116# Only do that if necessary to keep visible output short.
117.if ${.CURDIR} == ${.OBJDIR}
118PYTHON =	python3 -u
119SCAPYPATH =
120.else
121PYTHON =	PYTHONPATH=${.OBJDIR} python3 -u
122SCAPYPATH =	${.CURDIR}/
123.endif
124
125.for s in ${SCAPYS}
126REGRESS_TARGETS +=	run-$s
127run-$s: $s addr.py
128	time SUDO="${SUDO}" PYTHON="${PYTHON}" perl ${PERLINC} ${PERLPATH}scapy.pl splice ${FAKE_NET_ADDR} ${REMOTE_ADDR} ${REMOTE_SSH} ${SCAPYPATH}$s
129.endfor
130
131.if ! empty(PF_ANCHOR:Mregress)
132REGRESS_CLEANUP +=	cleanup
133cleanup:
134	${SUDO} pfctl -a regress -Fr
135	rm -f stamp-pfctl
136.endif
137
138CLEANFILES +=		addr.py *.pyc *.log stamp-*
139
140.PHONY: check-setup check-setup-local check-setup-remote
141
142# Check wether the address, route and remote setup is correct
143check-setup: check-setup-local check-setup-remote
144
145check-setup-local:
146	@echo '\n======== $@ ========'
147	ping -n -c 1 ${LOCAL_ADDR}  # LOCAL_ADDR
148	route -n get -inet ${LOCAL_ADDR} | grep -q 'flags: .*LOCAL'  # LOCAL_ADDR
149	ping -n -c 1 ${REMOTE_ADDR}  # REMOTE_ADDR
150	route -n get -inet ${REMOTE_ADDR} | fgrep -q 'interface: ${LOCAL_IF}'  # REMOTE_ADDR LOCAL_IF
151	! ping -n -c 1 -w 1 ${FAKE_NET_ADDR}  # FAKE_NET_ADDR
152.for ip in FAKE_NET FAKE_NET_ADDR
153	route -n get -inet ${${ip}} | grep -q 'flags: .*BLACKHOLE'  # ${ip}
154.endfor
155
156check-setup-remote:
157	@echo '\n======== $@ ========'
158	ssh ${REMOTE_SSH} ping -n -c 1 ${REMOTE_ADDR}  # REMOTE_ADDR
159	ssh ${REMOTE_SSH} route -n get -inet ${REMOTE_ADDR} | grep -q 'flags: .*LOCAL'  # REMOTE_ADDR
160	ssh ${REMOTE_SSH} ping -n -c 1 ${LOCAL_ADDR}  # LOCAL_ADDR
161.for ip in FAKE_NET FAKE_NET_ADDR
162	ssh ${REMOTE_SSH} route -n get -inet ${${ip}} | fgrep -q 'gateway: ${LOCAL_ADDR}'  # ${ip} LOCAL_ADDR
163.endfor
164
165.include <bsd.regress.mk>
166