scapy README

The project's README from github.com/secdev/scapy. As one markdown file: README.md.

Scapy   Scapy

Scapy unit tests Codecov Status Codacy Badge PyPI Version 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 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.

Packaging status

Packaging status

License

Scapy's code, tests and tools are licensed under GPL v2. The documentation (everything unless marked otherwise in doc/, and except the logo) is licensed under CC BY-NC-SA 2.5.

Contributing

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

scapy (secdev/scapy)

network-analysis
Searching Database…

12.6K ·GitHub
Scapy
What is this?Scapy is a Python-based interactive packet manipulation program and library that lets you forge, decode, send, capture, and analyze network packets.
Is it a command-line shell or a Python library?Both - Scapy runs as an interactive shell for live packet work on the wire, and the same code can be imported as a library inside your own Python scripts.
How do I start using it?Install it and launch the Scapy shell directly, or import scapy into your own Python scripts; the documentation's 'Getting started' page and 'Scapy in 20 minutes' tutorial cover the basics.
Do I need extra Python packages for everything to work?Core packet crafting and sniffing work with zero external modules on Linux and BSD, but optional features like plotting need extra libraries such as matplotlib or cryptography.
Is it ready to use out of the box on Windows?Not immediately - on Windows you first need to install several mandatory dependencies described in the documentation before Scapy works.
Which operating systems does it run on?Scapy is cross-platform and runs on Linux, macOS, BSD, and Windows, supporting Python 3.7 and up.
What existing tools can Scapy replace?It can stand in for hping, a large chunk of nmap's features, arpspoof, arp-sk, arping, tcpdump, wireshark, and p0f for many classic networking tasks.
What kind of tasks is it good for beyond basic sniffing?Scanning, traceroute, probing, unit testing, custom attacks, and network discovery, plus advanced tricks like sending invalid frames, injecting raw 802.11 frames, or combining VLAN hopping with ARP cache poisoning.
Where can I find hands-on examples to learn it?The docs include a 'Getting started' guide, the 'Scapy in 20 minutes' interactive tutorial, a quick interactive demo session, and dedicated notebooks for HTTP/2 and TLS.
What are similar projects?sniffnet, brook, masscan, ecapture, thc-hydra, fq, impacket, netshoot
Which topics is it in?packet-capture, network-analysis, network, network-security, penetration-testing, cybersecurity, bsd, security-tools, hacktoberfest, networking, security, tool
Creator
secdev
Size
85.6 MB
Stars
12.6K
Updated
CommitOct 19Releasev2.8.0Oct 02
Age
11y
Commits · 90 Days