scapy.pipetool
- class scapy.pipetool.CLIFeeder(name: str | None = None)[source]
Bases:
AutoSource
Send messages from python command line:
+--------+ >>-| |->> | send() | >-| `----|-> +--------+
- class scapy.pipetool.CLIHighFeeder(name: str | None = None)[source]
Bases:
CLIFeeder
Send messages from python command line to high output:
+--------+ >>-| .----|->> | send() | >-| |-> +--------+
- class scapy.pipetool.ConsoleSink(name: str | None = None)[source]
Bases:
Sink
Print messages on low and high entries to
stdout
+-------+ >>-|--. |->> | print | >-|--' |-> +-------+
- class scapy.pipetool.DownDrain(name: str | None = None)[source]
Bases:
Drain
Repeat messages from high entry to low exit:
+-------+ >>-|--. |->> | \ | >-| `--|-> +-------+
- class scapy.pipetool.Drain(name: str | None = None)[source]
Bases:
Pipe
Repeat messages from low/high entries to (resp.) low/high exits
+-------+ >>-|-------|->> | | >-|-------|-> +-------+
- class scapy.pipetool.PeriodicSource(msg: Iterable[Any] | Any, period: int, period2: int = 0, name: str | None = None)[source]
Bases:
ThreadGenSource
Generage messages periodically on low exit:
+-------+ >>-| |->> | msg,T | >-| `----|-> +-------+
- class scapy.pipetool.PipeEngine(*pipes: Pipe)[source]
Bases:
ObjectPipe
[str
]- pipes: Dict[str, Type[Pipe]] = {'AutoSource': <class 'scapy.pipetool.AutoSource'>, 'CLIFeeder': <class 'scapy.pipetool.CLIFeeder'>, 'CLIHighFeeder': <class 'scapy.pipetool.CLIHighFeeder'>, 'ConsoleSink': <class 'scapy.pipetool.ConsoleSink'>, 'DownDrain': <class 'scapy.pipetool.DownDrain'>, 'Drain': <class 'scapy.pipetool.Drain'>, 'FDSourceSink': <class 'scapy.scapypipes.FDSourceSink'>, 'Inject3Sink': <class 'scapy.scapypipes.Inject3Sink'>, 'InjectSink': <class 'scapy.scapypipes.InjectSink'>, 'PeriodicSource': <class 'scapy.pipetool.PeriodicSource'>, 'Pipe': <class 'scapy.pipetool.Pipe'>, 'QueueSink': <class 'scapy.pipetool.QueueSink'>, 'RawConsoleSink': <class 'scapy.pipetool.RawConsoleSink'>, 'RdpcapSource': <class 'scapy.scapypipes.RdpcapSource'>, 'Sink': <class 'scapy.pipetool.Sink'>, 'SniffSource': <class 'scapy.scapypipes.SniffSource'>, 'Source': <class 'scapy.pipetool.Source'>, 'TCPConnectPipe': <class 'scapy.scapypipes.TCPConnectPipe'>, 'TCPListenPipe': <class 'scapy.scapypipes.TCPListenPipe'>, 'TermSink': <class 'scapy.pipetool.TermSink'>, 'ThreadGenSource': <class 'scapy.pipetool.ThreadGenSource'>, 'TransformDrain': <class 'scapy.pipetool.TransformDrain'>, 'TriggerDrain': <class 'scapy.scapypipes.TriggerDrain'>, 'TriggerSink': <class 'scapy.pipetool.TriggerSink'>, 'TriggeredMessage': <class 'scapy.scapypipes.TriggeredMessage'>, 'TriggeredQueueingValve': <class 'scapy.scapypipes.TriggeredQueueingValve'>, 'TriggeredSwitch': <class 'scapy.scapypipes.TriggeredSwitch'>, 'TriggeredValve': <class 'scapy.scapypipes.TriggeredValve'>, 'UDPClientPipe': <class 'scapy.scapypipes.UDPClientPipe'>, 'UDPDrain': <class 'scapy.scapypipes.UDPDrain'>, 'UDPServerPipe': <class 'scapy.scapypipes.UDPServerPipe'>, 'UpDrain': <class 'scapy.pipetool.UpDrain'>, 'WiresharkSink': <class 'scapy.scapypipes.WiresharkSink'>, 'WrpcapSink': <class 'scapy.scapypipes.WrpcapSink'>}
- class scapy.pipetool.QueueSink(name: str | None = None)[source]
Bases:
Sink
Collects messages on the low and high entries into a
Queue
. Messages are dequeued withrecv()
. Both high and low entries share the sameQueue
.+-------+ >>-|--. |->> | queue | >-|--' |-> +-------+
- recv(block: bool = True, timeout: int | None = None) Any | None [source]
Reads the next message from the queue.
If no message is available in the queue, returns None.
- Parameters:
block (bool) – Blocks execution until a packet is available in the queue. Defaults to True.
timeout (None, int or float) – Controls how long to wait if
block=True
. If None (the default), this method will wait forever. If a non-negative number, this is a number of seconds to wait before giving up (and returning None).
- class scapy.pipetool.RawConsoleSink(name: str | None = None, newlines: bool = True)[source]
Bases:
Sink
Print messages on low and high entries, using os.write
+-------+ >>-|--. |->> | write | >-|--' |-> +-------+
- Parameters:
newlines (bool) – Include a new-line character after printing each packet. Defaults to True.
- class scapy.pipetool.Sink(name: str | None = None)[source]
Bases:
Pipe
Does nothing; interface to extend for custom sinks.
All sinks have the following constructor parameters:
- Parameters:
name (str) – a human-readable name for the element
- high_push(msg: Any) None [source]
Called by
PipeEngine
when there is a new message for the high entry.- Parameters:
msg – The message data
- Returns:
None
- Return type:
None
- push(msg: Any) None [source]
Called by
PipeEngine
when there is a new message for the low entry.- Parameters:
msg – The message data
- Returns:
None
- Return type:
None
- class scapy.pipetool.Source(name: str | None = None)[source]
Bases:
Pipe
,ObjectPipe
[Any
]
- class scapy.pipetool.TermSink(name: str | None = None, keepterm: bool = True, newlines: bool = True, openearly: bool = True)[source]
Bases:
Sink
Prints messages on the low and high entries, on a separate terminal (xterm or cmd).
+-------+ >>-|--. |->> | print | >-|--' |-> +-------+
- Parameters:
keepterm (bool) – Leave the terminal window open after
stop()
is called. Defaults to True.newlines (bool) – Include a new-line character after printing each packet. Defaults to True.
openearly (bool) – Automatically starts the terminal when the constructor is called, rather than waiting for
start()
. Defaults to True.
- class scapy.pipetool.ThreadGenSource(name: str | None = None)[source]
Bases:
AutoSource
- class scapy.pipetool.TransformDrain(f: Callable[[Any], None], name: str | None = None)[source]
Bases:
Drain
Apply a function to messages on low and high entry:
+-------+ >>-|--[f]--|->> | | >-|--[f]--|-> +-------+