2016-01-12 10:36:39 +00:00
# Scapy #
2016-12-15 08:55:58 +00:00
[](https://travis-ci.org/secdev/scapy)
2017-03-15 16:11:30 +00:00
[](https://ci.appveyor.com/project/secdev/scapy)
2017-01-08 12:25:53 +00:00
[](https://codecov.io/gh/secdev/scapy)
2016-06-11 09:16:51 +00:00
2016-01-12 10:36:39 +00:00
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, match requests and replies, and
much more.
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, tethereal, 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 technics (VLAN hopping+ARP
cache poisoning, VOIP decoding on WEP encrypted channel, ...),
etc.
2017-01-08 11:52:30 +00:00
# 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.
2017-01-08 12:04:39 +00:00
To benefit from all Scapy features, you might want to install Python modules, such as matplotlib or cryptography.
2017-01-08 11:52:30 +00:00
See the [tutorial ](http://scapy.readthedocs.io/en/latest/installation.html ) and follow the instructions to install scapy.
## Tutorial ##
To begin with scapy, see the
2016-07-08 06:48:44 +00:00
[interactive tutorial ](http://scapy.readthedocs.io/en/latest/usage.html#interactive-tutorial )
2016-01-12 10:36:39 +00:00
and
2016-07-08 06:48:44 +00:00
[the quick demo: an interactive session ](http://scapy.readthedocs.io/en/latest/introduction.html#quick-demo )
2016-01-12 10:36:39 +00:00
(some examples may be outdated).
2016-02-09 12:38:04 +00:00
# Contributing #
Want to contribute? Great! Please take a few minutes to
[read this ](CONTRIBUTING.md )!
2016-01-12 10:36:39 +00:00
# License #
Scapy is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation, version 2.
Scapy is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
[along with Scapy ](LICENSE ). If not, see
[the gnu.org web site ](http://www.gnu.org/licenses/ ).
