Scapy: the Python-based interactive packet manipulation program & library. Supports Python 2 & Python 3.
Branch: master
Clone or download
Latest commit 53dd5dd Feb 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.appveyor Winpcap legacy test + fixes + appveyor enhancements Feb 6, 2019
.github Corrected pip download command Nov 6, 2018
.travis Load Windows Interfaces/routes using C calls. Jan 19, 2019
bin fix windows batches errors that causes the wrong python to be run or … Mar 27, 2018
doc Typo in advanced_usage.rst Feb 17, 2019
scapy Support __version__ Feb 19, 2019
test Support __version__ Feb 19, 2019
.appveyor.yml Winpcap legacy test + fixes + appveyor enhancements Feb 6, 2019
.codecov.yml Add a codecov configuration file Jan 2, 2017
.coveragerc Exclude external Python modules Jan 31, 2018
.coveragerc.tox Test TLS automta with tox Apr 24, 2018
.gitattributes Add .gitattributes encoding May 31, 2017
.gitignore Revert "Export-subst util: change format" Aug 16, 2018
.travis.yml BSD support added Feb 5, 2019
CONTRIBUTING.md Clarify layers/contribs in CONTRIBUTING.md Oct 26, 2018
LICENSE Add license file May 14, 2015
MANIFEST.in LICENSE file added to pip package Jan 11, 2019
README enhance version management Sep 5, 2016
README.md Use an absolute HTTP link Jan 14, 2019
run_scapy making scapy runnable module Mar 27, 2018
run_scapy.bat New .bat's + disable __pycache__ Oct 8, 2017
run_scapy_py2 Use '.' instead of 'source' Nov 17, 2017
run_scapy_py2.bat making scapy runnable module Mar 27, 2018
run_scapy_py3 Use '.' instead of 'source' Nov 17, 2017
run_scapy_py3.bat making scapy runnable module Mar 27, 2018
setup.cfg fix: Fix failing to build wheel Jan 17, 2019
setup.py Added automotive protocol OBD (#1787) Feb 6, 2019
tox.ini Restore osx->bsd Feb 8, 2019

README.md

Scapy

Travis Build Status AppVeyor Build Status Codecov Status Codacy Badge PyPI Version Python Versions License: GPL v2 Join the chat at https://gitter.im/secdev/scapy

Scapy is a powerful Python-based interactive packet manipulation program and library.

It is able to forge or decode packets of a wide number of protocols, send them on the wire, capture them, store or read them using pcap files, match requests and replies, and much more. It is designed to allow fast packet prototyping by using default values that work.

It can easily handle most classical tasks like scanning, tracerouting, probing, unit tests, attacks or network discovery (it can replace hping, 85% of nmap, arpspoof, arp-sk, arping, tcpdump, wireshark, p0f, etc.). It also performs very well at a lot of other specific tasks that most other tools can't handle, like sending invalid frames, injecting your own 802.11 frames, combining techniques (VLAN hopping+ARP cache poisoning, VoIP decoding on WEP protected channel, ...), etc.

Scapy supports Python 2.7 and Python 3 (3.4 to 3.7). It's intended to be cross platform, and runs on many different platforms (Linux, OSX, *BSD, and Windows).

Hands-on

Interactive shell

Scapy can easily be used as an interactive shell to interact with the network. The following example shows how to send an ICMP Echo Request message to github.com, then display the reply source IP address:

sudo ./run_scapy 
Welcome to Scapy
>>> p = IP(dst="github.com")/ICMP()
>>> r = sr1(p)
Begin emission:
.Finished to send 1 packets.
*
Received 2 packets, got 1 answers, remaining 0 packets
>>> r[IP].src
'192.30.253.113'

Python module

It is straightforward to use Scapy as a regular Python module, for example to check if a TCP port is opened. First, save the following code in a file names e.g. send_tcp_syn.py

from scapy.all import *
conf.verb = 0
p = IP(dst="github.com")/TCP()
r = sr1(p)
print(r.summary())

Then, launch the script with:

sudo python send_tcp_syn.py
IP / TCP 192.30.253.113:http > 192.168.46.10:ftp_data SA / Padding

Resources

To begin with Scapy, you should check the notebook hands-on and the interactive tutorial. If you want to learn more, see the quick demo: an interactive session (some examples may be outdated), or play with the HTTP/2 and TLS notebooks.

The documentation contains more advanced use cases, and examples.

Installation

Scapy works without any external Python modules on Linux and BSD like operating systems. On Windows, you need to install some mandatory dependencies as described in the documentation.

On most systems, using Scapy is as simple as running the following commands:

git clone https://github.com/secdev/scapy
cd scapy
./run_scapy

To benefit from all Scapy features, such as plotting, you might want to install Python modules, such as matplotlib or cryptography. See the documentation and follow the instructions to install them.

Contributing

Want to contribute? Great! Please take a few minutes to read this!