The Wayback Machine - https://web.archive.org/web/20191207111055/https://github.com/secdev/scapy
Skip to content
Scapy: the Python-based interactive packet manipulation program & library. Supports Python 2 & Python 3.
Python Other
  1. Python 99.8%
  2. Other 0.2%
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.config Cleanup `vcan_socket` tag on all unit tests (#2362) Dec 5, 2019
.github Add sponsors badge to Scapy Oct 27, 2019
doc Merge pull request #2305 from x746e/patch-3 Oct 24, 2019
scapy CDP IP Prefix support Dec 4, 2019
test Cleanup `vcan_socket` tag on all unit tests (#2362) Dec 5, 2019
.appveyor.yml Mypy testing suite & various fixes Aug 27, 2019
.codecov.yml Add a codecov configuration file Jan 2, 2017
.coveragerc Removing useless .coveragerc file (#2070) Jun 11, 2019
.gitattributes Add .gitattributes encoding May 31, 2017
.gitignore RegenerRegenerate API tree Oct 23, 2019
.readthedocs.yml Remove htmlzip from RTD build Oct 23, 2019
.travis.yml Cleanup unit tests which use vcan_socket. Add tests with python-can Nov 28, 2019
CONTRIBUTING.md Linting .md files May 31, 2019
LICENSE Add license file May 14, 2015
MANIFEST.in Remove 'recursive-include bin *' Apr 14, 2019
README enhance version management Sep 5, 2016
README.md Filter out some badges from PyPI description Oct 22, 2019
run_scapy Refactor .bat files + default to Python 3 Feb 24, 2019
run_scapy.bat Refactor .bat files + default to Python 3 Feb 24, 2019
run_scapy_py2 Use '.' instead of 'source' Nov 17, 2017
run_scapy_py2.bat Refactor .bat files + default to Python 3 Feb 24, 2019
run_scapy_py3 Use '.' instead of 'source' Nov 17, 2017
run_scapy_py3.bat Refactor .bat files + default to Python 3 Feb 24, 2019
setup.cfg fix: Fix failing to build wheel Jan 17, 2019
setup.py Readthedocs config Oct 23, 2019
tox.ini Cleanup unit tests which use vcan_socket. Add tests with python-can Nov 28, 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).

Getting started

Scapy is usable either as a shell or as a library. For further details, please head over to Getting started with Scapy, which is part of the documentation.

Shell demo

Scapy install demo

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'

Resources

The documentation contains more advanced use cases, and examples.

Other useful resources:

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!

You can’t perform that action at this time.