Scapy: the Python-based interactive packet manipulation program & library. Supports Python 2 & Python 3.
Go to file
Gabriel Potter f781d11ce9
Merge pull request #1653 from guedou/Fix_Issue#1623
Don't put the interface in promiscuous mode while getting the BPF filter
2018-10-19 17:51:35 +02:00
.appveyor Tox on Windows 2018-06-19 14:57:15 +02:00
.github Fix PULL_REQUEST_TEMPLATE checklist format 2018-06-05 17:59:04 +02:00
.travis Spelling errors fixed 2018-10-03 21:40:35 +02:00
bin fix windows batches errors that causes the wrong python to be run or not to be run at all 2018-03-27 12:39:53 +02:00
doc Spelling errors fixed 2018-10-03 21:40:35 +02:00
scapy Don't put the interface in promiscuous mode while getting the BPF filter 2018-10-19 16:47:17 +02:00
test Merge pull request #1641 from polybassa/rdcandump 2018-10-18 02:03:54 +02:00
.appveyor.yml Tox on Windows 2018-06-19 14:57:15 +02:00
.codecov.yml Add a codecov configuration file 2017-01-02 18:21:29 +01:00
.coveragerc Exclude external Python modules 2018-01-31 21:42:47 +01:00
.coveragerc.tox Test TLS automta with tox 2018-04-24 15:27:08 +02:00
.gitattributes Add .gitattributes encoding 2017-05-31 17:04:19 +02:00
.gitignore Revert "Export-subst util: change format" 2018-08-16 18:16:13 +02:00
.travis.yml Disable PCAPDNET tests for OSX 2018-10-12 17:39:21 +02:00
CONTRIBUTING.md A few more notices in CONTRIBUTING.md 2018-09-15 19:58:10 +02:00
LICENSE Add license file 2015-05-13 18:31:50 -07:00
MANIFEST.in enhance version management 2016-09-05 13:38:41 +02:00
README enhance version management 2016-09-05 13:38:41 +02:00
README.md Add PyPi description 2018-05-15 18:53:36 +02:00
run_scapy making scapy runnable module 2018-03-27 12:41:09 +02:00
run_scapy.bat New .bat's + disable __pycache__ 2017-10-08 20:51:32 +02:00
run_scapy_py2 Use '.' instead of 'source' 2017-11-17 14:11:06 +01:00
run_scapy_py2.bat making scapy runnable module 2018-03-27 12:41:09 +02:00
run_scapy_py3 Use '.' instead of 'source' 2017-11-17 14:11:06 +01:00
run_scapy_py3.bat making scapy runnable module 2018-03-27 12:41:09 +02:00
setup.cfg Specify the license file in setup.cfg 2018-06-12 03:50:11 +02:00
setup.py Implementation of GMLAN Protocol for Scapy 2018-06-24 20:37:09 +02:00
tox.ini Enforce all PEP08 checks 2018-10-04 13:05:29 +02:00

README.md

Scapy

Travis Build Status AppVeyor Build Status Codecov Status 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.6). 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 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!