xref: /freebsd/tests/sys/netpfil/common/sniffer.py (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1#
2# SPDX-License-Identifier: BSD-2-Clause
3#
4# Copyright (c) 2017 Kristof Provost <kp@FreeBSD.org>
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
28import threading
29import scapy.all as sp
30import sys
31
32class Sniffer(threading.Thread):
33	def __init__(self, args, check_function, recvif, timeout=3):
34		threading.Thread.__init__(self)
35
36		self._sem = threading.Semaphore(0)
37		self._args = args
38		self._timeout = timeout
39		self._recvif = recvif
40		self._check_function = check_function
41		self.correctPackets = 0
42
43		self.start()
44		if not self._sem.acquire(timeout=30):
45			raise Exception("Failed to start sniffer")
46
47	def _checkPacket(self, packet):
48		ret = self._check_function(self._args, packet)
49		if ret:
50			self.correctPackets += 1
51		return ret
52
53	def _startedCb(self):
54		self._sem.release()
55
56	def run(self):
57		self.packets = []
58		self.packets = sp.sniff(iface=self._recvif,
59			stop_filter=self._checkPacket, timeout=self._timeout,
60			started_callback=self._startedCb)
61