Skip to content

Clean asynchronous stop_callback implementation #1523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Clean asynchronous stop_callback implementation #1523

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions scapy/sendrecv.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -819,8 +819,13 @@ def sniff(count=0, store=True, offline=None, prn=None, lfilter=None,
iface: interface or list of interfaces (default: None for sniffing
on all interfaces).
monitor: use monitor mode. May not be available on all OS
started_callback: called as soon as the sniffer starts sniffing
started_callback: called as soon as the sniffer starts sniffing.
(default: None).
must accept one argument: stop_callback.
=> stop_callback usage is optional
=> stop_callback is a function provided by sniff
that once called, will stop sniff. May be used
asynchronously.

The iface, offline and opened_socket parameters can be either an
element, a list of elements, or a dict object mapping an element to a
Expand Down Expand Up @@ -887,6 +892,7 @@ def sniff(count=0, store=True, offline=None, prn=None, lfilter=None,
remain = None
read_allowed_exceptions = ()
is_python_can_socket = getattr(opened_socket, "is_python_can_socket", lambda: False) # noqa: E501
from scapy.automaton import ObjectPipe, select_objects
if conf.use_bpf:
from scapy.arch.bpf.supersocket import bpf_select

Expand All @@ -897,7 +903,7 @@ def _select(sockets):
read_allowed_exceptions = (PcapTimeoutElapsed,)

def _select(sockets):
return sockets
return select_objects(sockets, remain=0)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: separate

  • WINDOWS and started_callback ==> use select_objects
  • WINDOWS and not started_callback ==> previous behavior: dont use select_objects

elif is_python_can_socket():
from scapy.contrib.cansocket_python_can import CANSocketTimeoutElapsed
read_allowed_exceptions = (CANSocketTimeoutElapsed,)
Expand All @@ -914,15 +920,23 @@ def _select(sockets):
return []
raise
try:
objpipe = None
if started_callback:
started_callback()
objpipe = ObjectPipe()
sniff_sockets[objpipe] = "control_socket"
def stop_callback():
objpipe.send(None)
started_callback(stop_callback)
while sniff_sockets:
if timeout is not None:
remain = stoptime - time.time()
if remain <= 0:
break
ins = _select(sniff_sockets)
for s in ins:
if s is objpipe:
sniff_sockets = []
break
try:
p = s.recv()
except read_allowed_exceptions:
Expand All @@ -945,10 +959,8 @@ def _select(sockets):
r = prn(p)
if r is not None:
print(r)
if stop_filter and stop_filter(p):
sniff_sockets = []
break
if 0 < count <= c:
if stop_filter and stop_filter(p) \
or 0 < count <= c:
sniff_sockets = []
break
except KeyboardInterrupt:
Expand Down