xref: /freebsd/tests/sys/netpfil/common/sniffer.py (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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
31
32class Sniffer(threading.Thread):
33	def __init__(self, args, check_function, recvif=None):
34		threading.Thread.__init__(self)
35
36		self._args = args
37		if recvif is not None:
38			self._recvif = recvif
39		else:
40			self._recvif = args.recvif[0]
41		self._check_function = check_function
42		self.foundCorrectPacket = False
43
44		self.start()
45
46	def _checkPacket(self, packet):
47		ret = self._check_function(self._args, packet)
48		if ret:
49			self.foundCorrectPacket = True
50		return ret
51
52	def run(self):
53		self.packets = sp.sniff(iface=self._recvif,
54				stop_filter=self._checkPacket, timeout=3)
55