xref: /freebsd/tests/sys/netpfil/common/sniffer.py (revision c7a063741720ef81d4caa4613242579d12f1d605)
1# $FreeBSD$
2#
3# SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4#
5# Copyright (c) 2017 Kristof Provost <kp@FreeBSD.org>
6#
7# Redistribution and use in source and binary forms, with or without
8# modification, are permitted provided that the following conditions
9# are met:
10# 1. Redistributions of source code must retain the above copyright
11#    notice, this list of conditions and the following disclaimer.
12# 2. Redistributions in binary form must reproduce the above copyright
13#    notice, this list of conditions and the following disclaimer in the
14#    documentation and/or other materials provided with the distribution.
15#
16# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26# SUCH DAMAGE.
27#
28
29import threading
30import scapy.all as sp
31import sys
32
33class Sniffer(threading.Thread):
34	def __init__(self, args, check_function, recvif=None, timeout=3):
35		threading.Thread.__init__(self)
36
37		self._sem = threading.Semaphore(0)
38		self._args = args
39		self._timeout = timeout
40		if recvif is not None:
41			self._recvif = recvif
42		else:
43			self._recvif = args.recvif[0]
44		self._check_function = check_function
45		self.foundCorrectPacket = False
46
47		self.start()
48		if not self._sem.acquire(timeout=30):
49			raise Exception("Failed to start sniffer")
50
51	def _checkPacket(self, packet):
52		ret = self._check_function(self._args, packet)
53		if ret:
54			self.foundCorrectPacket = True
55		return ret
56
57	def _startedCb(self):
58		self._sem.release()
59
60	def run(self):
61		self.packets = []
62		try:
63			self.packets = sp.sniff(iface=self._recvif,
64					stop_filter=self._checkPacket, timeout=self._timeout,
65					started_callback=self._startedCb)
66		except Exception as e:
67			print(e, file=sys.stderr)
68